# @codaco/protocol-validation 中文文档

规范地址：https://npmcn.com/package/%40codaco/protocol-validation/

版本：15\.0\.0
npm 元数据更新时间：2026-10-13T12:14:17.758Z
中文译文更新时间：2026-11-10T05:29:43.371Z
软件包许可：GPL-3\.0-or-later

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

原始 npm 页面：https://www.npmjs.com/package/%40codaco/protocol-validation
原文对照：https://npmcn.com/package/%40codaco/protocol-validation/?lang=original
源码仓库：https://github.com/complexdatacollective/network-canvas-monorepo

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

- 包体积（解压后）：1.9 MB，182 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：@codaco/app-i18n ^0\.3\.0
- 首次发布：2023-10-09T11:55:31.508Z
- 最新版本发布：2026-10-13T12:14:17.316Z
- 近 30 天下载量：16471（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：55（近 12 个月 33 个）

## 中文简介

用于验证和迁移网络 Canvas 协议文件的公用事业 .

## 安装

```sh
npm install @codaco/protocol-validation
```

也可以使用：`pnpm add @codaco/protocol-validation`、`yarn add @codaco/protocol-validation`、`bun add @codaco/protocol-validation`

## README

# @codaco/protocol认证

这个 npm 软件包执行方法, 以验证 Network Canvas 协议文件, 对抗合适的 JSON schema .

它输出三种主要的协议验证方法:

1.  验证Schema - 验证针对 JSON schema 的方案

```js
const { hasErrors, errors } = validateSchema(schemaJson);
```

2.  校验Logic - 校验协议的逻辑以确保没有不一致之处. 这包括JSON计划内无法执行的验证.

```js
const { hasErrors, errors } = validateLogic(protocolJson);
```

3.  校验协议 - 校验协议的设置和逻辑.

```js
const result = await validateProtocol(protocolJson);
if (result.success) {
  // protocol is valid, validated data available in result.data
} else {
  // protocol is invalid
  // result.error contains the Zod error
  console.error(result.error);
}
```

它还会输出几种管理协议验证的实用方法.

1.  迁移协议 - 将协议从一个版本迁移到另一个版本

```js
const migratedProtocol = migrateProtocol(8, protocolJson);
```

2.  can Update - 如果协议可以从一个chema版本升级到另一个版本,则检查

```js
const canProtocolUpgrade = canUpgrade(7, 8);
```

3.  getMigration Notes - 返回关于源计划版本与目标计划版本之间变化的迁移注释.

```js
const migrationNotes = getMigrationNotes(7, 8);
```

4.  从外部网络数据源返回可变名称

```js
const variableNames = getVariableNamesFromNetwork(network);
```

5.  验证名称 - 验证可变名称,以确保它们只包含字母,数字,以及符号. -:

```js
const validationResult = validateNames(variableNamesArray);
```

## 常见问题

### @codaco/protocol-validation 是什么？

用于验证和迁移网络 Canvas 协议文件的公用事业 \.

### 如何安装 @codaco/protocol-validation？

在项目目录运行 npm install @codaco/protocol-validation，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 @codaco/protocol-validation，可以用 npx @codaco/protocol-validation 直接运行。

### @codaco/protocol-validation 支持 TypeScript 吗？

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

### @codaco/protocol-validation 支持 ESM 还是 CommonJS？

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

### @codaco/protocol-validation 可以商用吗？

@codaco/protocol-validation 使用 GPL-3\.0-or-later 许可。强 Copyleft：分发包含该代码的软件时，整个作品需以 GPL-3\.0 兼容许可开源，并附带专利与反锁定条款。仅内部使用不触发此义务。以上为概括，不构成法律意见，请以许可原文为准。

### @codaco/protocol-validation 的下载量有多少？

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

### @codaco/protocol-validation 还在维护吗？

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