@herenit/hrd-toolkit-schema

@herenit/hrd-toolkit-schema 提供 heren-design 知识数据的 TypeScript 类型和运行时校验能力。适合在需要读取、校验或生成 heren-design 组件、Icon 等知识数据时使用。

安装

pnpm add @herenit/hrd-toolkit-schema

公开入口

从包根入口导入：

• MetadataStore、ComponentData、PropData、EventData、SlotData、ExposedData 等组件知识类型。
• IconKnowledgeStore、IconData 等 Icon 知识类型。
• validateMetadataStore(value)：校验组件知识数据根结构。
• validateIconKnowledgeStore(value)：校验 Icon 知识数据根结构。
• formatValidationIssues(issues)：格式化校验问题。

使用示例

import { formatValidationIssues, validateMetadataStore, type MetadataStore } from '@herenit/hrd-toolkit-schema';

const value: unknown = JSON.parse(jsonText);
const validation = validateMetadataStore(value);

if (!validation.valid) {
  throw new Error(formatValidationIssues(validation.issues).join('\n'));
}

const store = value as MetadataStore;
console.log(store.version, store.components.length);

适用场景

• 在自定义工具中校验 heren-design 组件知识 JSON。
• 复用 heren-design 知识数据类型，避免手写重复结构。
• 在生成知识数据前后输出稳定、可读的校验错误。