@herenit/hrd-toolkit-core

@herenit/hrd-toolkit-core 提供协议无关的 heren-design 知识查询服务。你可以在 CLI、MCP Server、HTTP 服务或其他工具中复用同一套组件、文档、Demo、Icon 和模板查询能力。

安装

pnpm add @herenit/hrd-toolkit-core @herenit/hrd-toolkit-knowledge

公开入口

从包根入口导入：

• createKnowledgeService(options)：创建协议无关知识查询服务。
• HerenDesignKnowledgeService：服务接口。
• Result<T>、DomainError、QueryMeta：统一结果与错误结构。
• ListComponentsInput、GetComponentInfoInput、SearchIconsInput、GetTemplateInput 等查询输入类型。
• ComponentSummary、ComponentInfo、IconSummary、TemplateDetail 等查询输出类型。

使用示例

import { createKnowledgeService } from '@herenit/hrd-toolkit-core';
import { fileSystemKnowledgeRepository } from '@herenit/hrd-toolkit-knowledge';

const service = createKnowledgeService({
  repository: fileSystemKnowledgeRepository,
  defaultLocale: 'zh',
});

const result = await service.getComponentInfo({
  component: 'hr-button',
  version: '1.8.0',
});

if (!result.ok) {
  throw new Error(result.error.message);
}

console.log(result.meta.resolvedVersion);
console.log(result.data.props);

适用场景

• 在自定义接入层中查询 heren-design 组件信息。
• 为 AI 工具或内部平台提供稳定的知识查询 API。
• 需要统一处理分页、组件名称匹配、错误码和版本解析元信息。