# @appthreat/cdx-proto 中文文档

规范地址：https://npmcn.com/package/%40appthreat/cdx-proto/

版本：2\.0\.1
npm 元数据更新时间：2026-05-14T14:34:55.645Z
中文译文更新时间：2026-11-06T12:39:43.290Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40appthreat/cdx-proto
原文对照：https://npmcn.com/package/%40appthreat/cdx-proto/?lang=original
项目主页：https://github.com/AppThreat/cdx-proto#readme
源码仓库：https://github.com/AppThreat/cdx-proto

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2 MB，38 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- 首次发布：2023-12-24T12:27:52.043Z
- 最新版本发布：2026-05-14T14:34:55.197Z
- 近 30 天下载量：694758（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 5 个）

## 中文简介

带有协议缓冲器的 CirmDX BOM 序列化/去序列化库

## 安装

```sh
npm install @appthreat/cdx-proto
```

也可以使用：`pnpm add @appthreat/cdx-proto`、`yarn add @appthreat/cdx-proto`、`bun add @appthreat/cdx-proto`

## README

# cdx- proto (英语)

以协议缓冲器来串行化/去串行化 CyproneDX BOM 的运行时库. 该项目是利用 [原生基因( 原生基因)](https://github.com/bufbuild/protobuf-es) 从官方 [原型](https://github.com/CycloneDX/specification/blob/master/schema/bom-1.5.proto) 规格.

## 2.0.0 要点

-   版本特定子路径导出 : `@appthreat/cdx-proto/v1.5`, (中文(简体) ), `v1.6`,以及 `v1.7`
-   用于计划选择和BOM编码/解码工作流程的助手 API
-   已生成的更精简 npm 包内容 `docs/`

## 样本使用情况

```js
import {
  createBom,
  decodeBomBinary,
  encodeBomBinary,
  encodeBomJson,
  getBomSchema,
  parseBomJson,
} from "@appthreat/cdx-proto";
import { BomSchema as BomSchema16 } from "@appthreat/cdx-proto/v1.6";
import { fromJson } from "@bufbuild/protobuf";

// Use version-specific entrypoints when you only need one schema version.
const bom16 = fromJson(BomSchema16, {
  specVersion: "1.6",
  version: 1,
});

// Or use the helper API to auto-select schemas and encode/decode BOMs.
const bom = createBom("1.7", {
  version: 1,
  serialNumber: "urn:uuid:11111111-1111-1111-1111-111111111111",
});

const binary = encodeBomBinary(bom, {
  writeUnknownFields: true,
});

const decoded = decodeBomBinary("1.7", binary, {
  readUnknownFields: true,
});

const json = encodeBomJson(decoded, {
  alwaysEmitImplicit: true,
});

const parsed = parseBomJson({
  specVersion: "1.6",
  version: 1,
});

const schema = getBomSchema(parsed.specVersion);
```

### 帮助 API

-   `getBomSchema(specVersion)` 返回匹配 `BomSchema` 用于气旋DX `1.5`, (中文(简体) ), `1.6`,或 `1.7`。 。 。 .
-   `createBom(specVersion, init)` 创建 BOM 信件并自动设定 `specVersion`。 。 。 .
-   `parseBomJson(json)` 财务报告和审定财务报表 `parseBomJsonString(json)` 自动从 `specVersion` 编号 : `spec_version`。 。 。 .
-   `decodeBomBinary(specVersion, bytes)` 当已知 schema 版本时解码出一个 protobuf BOM.
-   `encodeBomBinary(bom)`, (中文(简体) ), `encodeBomJson(bom)`,以及 `encodeBomJsonString(bom)` 从BOM中选择正确的方案.

### JSON担保

助推层被设计为与犬科气旋DX JSON相配合,而不是与原生出活泼的JSON相配合.

-   `parseBomJson()` 财务报告和审定财务报表 `decodeBomJson()` 接受冠状气旋DX输入,例如:
    -   根字段类 `bomFormat` 财务报告和审定财务报表 `specVersion`
    -   破碎的别名, 如 `bom-ref`, (中文(简体) ), `mime-type`,以及 `x-trust-boundary`
    -   犬科散列内容字段 `hashes[].content`
    -   犬类标准/声明对象,而不是原生取材清单包装
-   未定义的对象属性和未定义的数组条目在原地取出解析之前进行静态化,这样调用者就可以通过普通的JavaScript对象而无需手动取出 `undefined` 数值第一.
-   `encodeBomJson()` 财务报告和审定财务报表 `encodeBomJsonString()` 在输出时恢复犬形气旋DX JSON,包括:
    -   `bomFormat: "CycloneDX"`
    -   管理局 `specVersion`
    -   粗体铝值而不是原生的铝名称,例如 `CLASSIFICATION_*`, (中文(简体) ), `HASH_ALG_*`,或 `EXTERNAL_REFERENCE_TYPE_*`
    -   犬形对象形状 `definitions` 财务报告和审定财务报表 `declarations`
-   `parseBomBinary()` 自动检测嵌入式支持的计划版本(`1.5`, (中文(简体) ), `1.6`,或 `1.7`)和可以配对 `encodeBomJson()` 读取原生的 BOMs 回作为犬科气旋DX JSON.

简言之:如果向帮助者API提供犬形气旋DX JSON,在二进制后或消息回转后,应当得到犬形气旋DX JSON.

### 特定版本进口

使用子路径导出来避免装入您不需要的计划版本 :

```js
import { BomSchema as BomSchema15 } from "@appthreat/cdx-proto/v1.5";
import { BomSchema as BomSchema16 } from "@appthreat/cdx-proto/v1.6";
import { BomSchema as BomSchema17 } from "@appthreat/cdx-proto/v1.7";
```

## 许可证

阿帕奇 - 2.0

## 常见问题

### @appthreat/cdx-proto 是什么？

带有协议缓冲器的 CirmDX BOM 序列化/去序列化库

### 如何安装 @appthreat/cdx-proto？

在项目目录运行 npm install @appthreat/cdx-proto，或使用 pnpm add / yarn add / bun add。

### @appthreat/cdx-proto 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @appthreat/cdx-proto 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @appthreat/cdx-proto 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @appthreat/cdx-proto 可以商用吗？

@appthreat/cdx-proto 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @appthreat/cdx-proto 的下载量有多少？

根据 npm 官方下载统计，@appthreat/cdx-proto 在 2026/10/07 – 2026/11/05 这 30 天内被下载 694,758 次，日均约 23,159 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @appthreat/cdx-proto 还在维护吗？

最新版本 2\.0\.1 发布于 2026/05/14（5 个月前）；至今共发布 15 个版本，其中过去 12 个月发布了 5 个；首次发布于 2023/12/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。