@ai-admin-platform/sdk
v0.2.0
Published
AI-Admin Platform 插件运行期共享 SDK:httpClient、zustand stores、A2UI 消息协议、通用 UI 组件与类型契约
Maintainers
Readme
@ai-admin-platform/sdk
AI-Admin Platform 插件前端的运行期共享 SDK。
主前端(宿主)把本包打进自己的 bundle 并在运行期提供实现;插件前端在构建期以裸包名
@ai-admin-platform/sdk 引用并被 externalize,运行期由宿主注入。因此宿主与全部插件必须使用
API 兼容的同一版本,破坏性变更必须升 major。
安装
npm i @ai-admin-platform/sdk仓库内开发无需安装:本包是 ai-admin-frontend 的 npm workspace 成员,
npm install 后 node_modules/@ai-admin-platform/sdk 会软链到 packages/sdk 源码目录。
导出内容
| 分类 | 导出 |
|---|---|
| HTTP | httpClient(axios 实例,统一 baseURL / 鉴权头 / 错误封装) |
| 状态 | useAuthStore、useChatStore、useLeftPanelStore、useSidePanelStore(zustand) |
| A2UI | a2ui 消息协议(宿主 ↔ 插件的跨界面通信) |
| UI | PageContainer、SectionCard、StatusTag |
| 类型 | 插件契约、Surface 契约等 TypeScript 类型声明 |
以根入口统一导入:
import { httpClient, useAuthStore, PageContainer } from '@ai-admin-platform/sdk';构建
npm run build # vite build(ESM 产物)+ tsc -p tsconfig.build.json(.d.ts)
npm run dev # watch 模式
npm run typecheck # 仅类型检查产物固定为 dist/index.mjs + dist/index.d.ts;react / react-dom / axios / zustand /
antd / @ant-design/icons 均为 external,不打进产物。
发布
npm version <patch|minor|major>
npm publish # prepublishOnly 自动执行 build;registry 取 publishConfig发布后必须同批次把主前端与 8 个插件前端的依赖 range 升到同一版本, CI 的 sdk 单版本断言会拦截版本分叉。
