@anov/cic-standard-sdk 0.0.1 → 0.0.3

package/README.md

@@ -30,16 +30,9 @@ CIC-Standard-1.0/
 └── vite.config.ts      # Vite 构建配置
 ```
 
-## 1. 协议核心概念
+## 1. 简介
 
-CIC 协议通过 JSON 描述一个完整的应用页面结构与行为：
-
-- **Config**: 全局配置根节点，包含页面列表、全局变量、资源依赖等。
-- **Page**: 页面定义，包含布局配置、组件树、页面级数据源。
-- **Component**: 组件实例，分为 View (视图)、Container (容器)、Logic (逻辑) 三类。
-- **Event**: 强大的事件 DSL，支持变量操作、页面跳转、组件控制、自定义脚本等，支持条件执行与调度（Order/Delay）。
-- **Variable**: 多级作用域（Global > Page > Component）的变量管理，支持 string/number/object/array/function。
-- **DataSource**: 统一的数据源定义（REST, WebSocket, Static），支持轮询与依赖。
+提供 CIC 标准的 TypeScript 类型与 SDK，支持 JSON Schema 校验、页面/组件/数据源等核心能力，适用于发布后的使用者。
 
 ## 2. SDK 使用指南
 
@@ -50,12 +43,12 @@ SDK 提供了操作 CIC 标准的常用工具方法，现已重构为面向对
 推荐使用 `pnpm` 安装依赖：
 
 ```bash
-pnpm install cic-standard-sdk
+pnpm add @anov/cic-standard-sdk
 ```
 
 ```typescript
-import { CICSDK } from 'cic-standard-sdk';
-import { CICConfig } from 'cic-standard-sdk/types';
+import { CICSDK } from '@anov/cic-standard-sdk'
+import  type { CICConfig, ComponentInstance, DataSourceItem, CICPage, Meta, Layout, Registry, Variables, Dependency, ICICSDK } from '@anov/cic-standard-sdk';
 
 const config: CICConfig = { ... };
 const sdk = new CICSDK(config); // 实例化时自动执行 Schema 校验
@@ -63,7 +56,7 @@ const sdk = new CICSDK(config); // 实例化时自动执行 Schema 校验
 
 ### 常用 API
 
-**1. 验证配置**（`sdk/CICSDK.ts:174`）
+**1. 验证配置**
 
 SDK 集成了完整的 JSON Schema (Draft-07)，可验证字段类型、必填项、枚举值等。
 
@@ -83,7 +76,7 @@ try {
 }
 ```
 
-**2. 查找组件**（`sdk/CICSDK.ts:47`、`sdk/CICSDK.ts:62`）
+**2. 查找组件**
 
 ```typescript
 // 按 ID 查找（支持跨页面）
@@ -97,7 +90,7 @@ const page = sdk.findPageByComponent('comp_btn_01')
 console.log('所在页面:', page?.id)
 ```
 
-**3. 获取变量值（自动处理作用域）**（`sdk/CICSDK.ts:80`、`sdk/CICSDK.ts:109`）
+**3. 获取变量值（自动处理作用域）**
 
 ```typescript
 // 优先查找组件级 -> 页面级 -> 全局
@@ -107,7 +100,7 @@ const val = sdk.getVariable({ pageId: 'p1', componentId: 'c1' }, 'theme')
 const val2 = sdk.getVariableByRef('global.theme')
 ```
 
-**4. 遍历组件树**（`sdk/CICSDK.ts:125`、`sdk/CICSDK.ts:220`）
+**4. 遍历组件树**
 
 ```typescript
 // 遍历整个配置的所有组件
@@ -118,7 +111,7 @@ sdk.walkComponents((comp, page, parent) => {
 })
 ```
 
-**5. 静态工具**（`sdk/CICSDK.ts:199`、`sdk/CICSDK.ts:220`）
+**5. 静态工具**
 
 ### 生成器 API（严格校验 + 规范化）
 
@@ -143,30 +136,22 @@ CICSDK.traverseTree(someComponent, c => {
 })
 ```
 
-## 3. 开发与测试
-
-本项目使用 Vite 进行构建，Vitest 进行单元测试，推荐使用 `pnpm` 管理依赖。
-
-### 命令脚本
-
-- `pnpm install`: 安装依赖
-- `pnpm run dev`: 启动开发模式
-- `pnpm run build`: 构建 SDK（输出 `dist/`）
-- `pnpm test`: 运行单元测试
+## 3. 构建与类型
 
 ### 构建产物
 
-- `dist/cic-sdk.es.js`: ESM 格式，适用于现代前端项目（Vite/Webpack）。
-- `dist/cic-sdk.cjs.js`: CJS 格式，适用于 Node.js `require`。
-- `dist/cic-sdk.umd.js`: UMD 格式，适用于 `<script>` 引入。
+- `dist/cic-sdk.es.js`（ESM）
+- `dist/cic-sdk.cjs.js`（CJS）
+- `dist/cic-sdk.umd.js`（UMD）
+- 类型声明：`dist/sdk/CICSDK.d.ts`
 
-在 `package.json` 中已配置 `exports` 字段与 `sideEffects: false`，支持 Tree‑shaking 与正确的导入解析。
+`package.json` 设置了 `sideEffects: false` 并使用 `exports` 指定导入/require 入口，方便 Tree‑shaking。
 
 ## 4. JSON Schema 校验
 
 `schema/cic.schema.json` 提供了完整的协议约束。
 
-### 在 VS Code 中启用智能提示
+### VS Code 智能提示
 
 在你的 JSON 配置文件头部添加 `$schema` 字段：
 
@@ -184,7 +169,7 @@ CICSDK.traverseTree(someComponent, c => {
 - 枚举值提示（如 `type`: `view` | `container`）
 - 结构校验（必填字段检查）
 
-### 常见报错与排查
+### 报错与排查
 
 - Ajv 错误输出包含 `instancePath`：根据路径定位到具体字段（如 `/pages/0/components/1/role must be equal to constant`）。
 - 组件判别联合：`view` 必须提供 `component`；`container` 必须提供 `children`；`logic` 必须提供 `component`（`LogicRef`）。
@@ -196,34 +181,9 @@ CICSDK.traverseTree(someComponent, c => {
 - 按需引入：仅从 `CICSDK` 静态导出使用所需生成器函数，减少打包体积。
 - ID 规范：通过生成器的 `generateId` 自动生成 `uuid`，避免冲突。
 
-## 5. Schema 与 Mock 脚本
-
-### Schema 生成脚本（`scripts/generate-schema.ts`）
-
-- 通过配置项裁剪复杂度、保留必要字段，输出更简洁可用的 JSON Schema。
-
-### Mock 生成与清洗（`scripts/generate-mock.ts`）
-
-- 基于 Schema 随机生成后，使用 `deepClean` 进行规范化：
-  - 修正非法数组项、补齐 `id`（uuid）、规范 `url`/`ws` 链接。
-  - 为 `code` 字段提供可执行的默认实现。
-
-示例输出能直接通过 Ajv 校验并用于演示与测试。
-
-## 5. 示例说明
-
-请查看 `examples/full-demo.json`，它展示了：
-
-- 如何定义全局主题变量。
-- 如何引入外部 ECharts 库与字体资源。
-- 如何配置 REST 数据源。
-- 如何构建包含图表与按钮的组件树。
-- 如何通过点击事件触发变量更新与自定义逻辑。
-
-## 安全声明
+## 5. 许可与版本
 
-CIC 允许执行动态代码（Custom Events, Logic Components）。在生产环境中渲染不可信的 CIC 配置时，请务必：
+- 语义化版本（SemVer）发布
+- 请在 issue 中反馈使用问题与建议
 
-1. 使用 iframe 或 Web Worker 隔离渲染环境。
-2. 限制代码执行的上下文访问权限。
-3. 对 `CustomRemoteEvent` 加载的外部脚本进行域名白名单控制。
+（本 README 为发布版自述，专注使用信息；开发演示与内部脚本说明已省略。）