@anov/cic-standard-sdk 0.0.8 → 0.0.10

package/README.md

@@ -33,11 +33,11 @@ const sdk = new CICSDK(config); // 实例化时自动执行 Schema 校验
 SDK 集成了完整的 JSON Schema (Draft-07)，可验证字段类型、必填项、枚举值等。
 
 ```typescript
-// 静态方法校验
-const result = CICSDK.validateConfig(myConfig)
-if (!result.valid) {
-  console.error('配置校验失败:', result.error)
-  // 输出示例: "/meta/layout/type must be string; /version must have required property 'version'"
+// 静态方法校验（返回中文化错误数组）
+const res = CICSDK.validateCIC(myConfig)
+if (!res.ok) {
+  console.error('配置校验失败:', res.errors)
+  // 示例: [{ path: '/version', message: '缺少必填字段：version' }]
 }
 
 // 实例化时自动校验，失败抛出异常
@@ -48,6 +48,31 @@ try {
 }
 ```
 
+**2. 导入/导出配置**
+
+```typescript
+// 从 JSON 字符串导入为 CICConfig 对象
+const rImport = CICSDK.importCIC(JSON.stringify(myConfig))
+if (rImport.ok) {
+  const cfg = rImport.value
+}
+
+// 从路径或 URL 导入（异步，兼容浏览器）
+// - 支持相对路径（同源）：'./examples/full-demo.json'、'/examples/full-demo.json'
+// - 支持 http(s) URL：'https://host/examples/full-demo.json'
+// - 不支持 file://（请使用同源路径或 http(s)）
+const rImportPath = await CICSDK.importCICAsync('/examples/full-demo.json')
+if (rImportPath.ok) {
+  const cfg2 = rImportPath.value
+}
+
+// 将 CICConfig 导出为稳定字段顺序的 JSON 字符串
+const rExport = CICSDK.exportCIC(myConfig)
+if (rExport.ok) {
+  console.log(rExport.value) // string
+}
+```
+
 **2. 查找组件**
 
 ```typescript
@@ -123,24 +148,6 @@ CICSDK.traverseTree(someComponent, c => {
 
 `schema/cic.schema.json` 提供了完整的协议约束。
 
-### VS Code 智能提示
-
-在你的 JSON 配置文件头部添加 `$schema` 字段：
-
-```json
-{
-  "$schema": "./schema/cic.schema.json",
-  "version": "1.0.0",
-  "meta": { ... }
-}
-```
-
-这将启用：
-
-- 字段自动补全
-- 枚举值提示（如 `type`: `view` | `container`）
-- 结构校验（必填字段检查）
-
 ### 报错与排查
 
 - Ajv 错误输出包含 `instancePath`：根据路径定位到具体字段（如 `/pages/0/components/1/role must be equal to constant`）。
@@ -157,5 +164,3 @@ CICSDK.traverseTree(someComponent, c => {
 
 - 语义化版本（SemVer）发布
 - 请在 issue 中反馈使用问题与建议
-
-（本 README 为发布版自述，专注使用信息；开发演示与内部脚本说明已省略。）