@codaco/protocol认证
这个 npm 软件包执行方法, 以验证 Network Canvas 协议文件, 对抗合适的 JSON schema .
它输出三种主要的协议验证方法:
- 验证Schema - 验证针对 JSON schema 的方案
const { hasErrors, errors } = validateSchema(schemaJson);
- 校验Logic - 校验协议的逻辑以确保没有不一致之处. 这包括JSON计划内无法执行的验证.
const { hasErrors, errors } = validateLogic(protocolJson);
- 校验协议 - 校验协议的设置和逻辑.
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);
}
它还会输出几种管理协议验证的实用方法.
- 迁移协议 - 将协议从一个版本迁移到另一个版本
const migratedProtocol = migrateProtocol(8, protocolJson);
- can Update - 如果协议可以从一个chema版本升级到另一个版本,则检查
const canProtocolUpgrade = canUpgrade(7, 8);
- getMigration Notes - 返回关于源计划版本与目标计划版本之间变化的迁移注释.
const migrationNotes = getMigrationNotes(7, 8);
- 从外部网络数据源返回可变名称
const variableNames = getVariableNamesFromNetwork(network);
- 验证名称 - 验证可变名称,以确保它们只包含字母,数字,以及符号. -:
const validationResult = validateNames(variableNamesArray);