@anov/cic-standard-sdk 0.0.18 → 0.0.20

package/dist/types/cic.manifest.d.ts

@@ -0,0 +1,367 @@
+/**
+ * =========================================================
+ * CIC Manifest 是 CIC 内容包的"运行时装配说明书"
+ *
+ *
+ * 与 CIC Config 的区别：
+ * ┌─────────────────┬──────────────────┐
+ * │ CIC Config      │ CIC Manifest     │
+ * ├─────────────────┼──────────────────┤
+ * │ 描述"是什么"    │ 描述"怎么运行"   │
+ * │ 组件、数据、结构│ 加载、解析、执行 │
+ * │ 平台无关        │ 平台相关         │
+ * │ 可序列化数据    │ 运行时配置       │
+ * └─────────────────┴──────────────────┘
+ *
+ *
+ * 核心职责：
+ * - 声明运行时环境要求
+ * - 定义模块解析规则（公共依赖：importmap / global / cdn）
+ * - 配置组件加载与注册策略（install / init / 自定义调用）
+ * - 声明导出策略（公共依赖排除列表）、平台能力要求
+ * =========================================================
+ */
+/**
+ * CIC Manifest 主接口
+ */
+export interface CICManifest {
+    /**
+     * Manifest 版本
+     * @example "1.0.0"
+     */
+    version: string;
+    /**
+     * 运行时引擎
+     * 声明此 CIC 需要的运行环境
+     */
+    engine: RuntimeEngine;
+    /**
+     * 模块解析
+     * 定义如何解析和加载模块（公共依赖）
+     */
+    modules: ModuleResolution;
+    /**
+     * 组件配置（可选）
+     * 定义组件加载和注册规则
+     */
+    components?: ComponentConfig;
+    /**
+     * 导出策略（可选）
+     *
+     * 场景：不同平台导出 CIC Config 时，需要排除公共依赖（宿主统一注入）。
+     */
+    export?: ManifestExportConfig;
+    /**
+     * 扩展配置（可选）
+     * 平台特定或自定义配置
+     */
+    extensions?: Record<string, any>;
+}
+/**
+ * 运行时引擎
+ */
+export interface RuntimeEngine {
+    /**
+     * 平台类型
+     * @example "web" | "node" | "mini-program" | "desktop"
+     */
+    platform: string;
+    /**
+     * 运行时类型
+     * @example "vue3" | "vue2" | "react" | "angular" | "vanilla"
+     */
+    runtime: string;
+    /**
+     * 运行时版本约束（可选）
+     * @example "^3.0.0"
+     */
+    version?: string;
+}
+/**
+ * 模块解析配置
+ */
+export interface ModuleResolution {
+    /**
+     * 解析策略
+     * - importmap: 使用 Import Maps（推荐）
+     * - global: 使用全局变量
+     * - hybrid: 混合模式（优先 importmap，失败降级 global/cdn）
+     */
+    strategy: 'importmap' | 'global' | 'hybrid';
+    /**
+     * Import Map（strategy 为 importmap 或 hybrid 时可用）
+     *
+     * importMap 与 importMapFile 二选一即可。
+     */
+    importMap?: ImportMap;
+    /**
+     * Import Map 文件路径（可选）
+     * 如果提供此字段，运行时将尝试从指定路径加载 Import Map 配置
+     * @example "./importmap.json"
+     */
+    importMapFile?: string;
+    /**
+     * 外部依赖（可选）
+     * 声明由宿主环境提供的依赖
+     *
+     * 约束建议：
+     * - 同一个 id 不要写两条 externals（避免歧义）
+     * - 需要“importmap + global”时，用 strategy=hybrid + fallback 表达“主 + 兜底”
+     */
+    externals?: ExternalDep[];
+    /**
+     * 基础路径（可选）
+     * 影响 importMapFile、相对 URL 等解析
+     * @example "./" | "/static/cic/" | "https://cdn.example.com/cic/"
+     */
+    baseURL?: string;
+    /**
+     * 预加载模块（可选）
+     * @example ["vue","vue-router"]
+     */
+    preload?: string[];
+    /**
+     * 模块别名（可选）
+     * @example { "@/": "./src/", "@components/": "./src/components/" }
+     */
+    alias?: Record<string, string>;
+    /**
+     * 降级策略（可选）
+     *
+     * 当 strategy=hybrid 且 importmap 解析/加载失败时的兜底方案。
+     * @example { "strategy": "global", "mapping": { "vue": "window.Vue" } }
+     */
+    fallback?: ModuleFallback;
+}
+/**
+ * Import Map 配置
+ */
+export interface ImportMap {
+    /**
+     * 模块映射
+     */
+    imports: Record<string, string>;
+    /**
+     * 作用域映射（可选）
+     */
+    scopes?: Record<string, Record<string, string>>;
+}
+/**
+ * 外部依赖声明
+ */
+export interface ExternalDep {
+    /**
+     * 模块 ID
+     * @example "vue" | "@arco-design/web-vue"
+     */
+    id: string;
+    /**
+     * 提供方式
+     * - global: 全局变量
+     * - import: 通过 importmap
+     * - cdn: CDN 加载
+     */
+    provide: 'global' | 'import' | 'cdn';
+    /**
+     * 全局变量路径（provide 为 global 时）
+     * @example "window.Vue" | "wx" | "globalThis.echarts"
+     */
+    global?: string;
+    /**
+     * CDN URL（provide 为 cdn 时）
+     * @example "https://cdn.jsdelivr.net/npm/echarts@5/dist/echarts.min.js"
+     */
+    url?: string;
+    /**
+     * 版本约束（可选）
+     * @example "^3.0.0"
+     */
+    version?: string;
+    /**
+     * 是否必需（可选）
+     * @default true
+     */
+    required?: boolean;
+    /**
+     * 可用性校验（可选）
+     * 用于判断 global/cdn 是否已就绪
+     * @example "typeof window.Vue !== 'undefined'"
+     */
+    checkScript?: string;
+    /**
+     * 依赖项（可选）
+     *
+     * 说明：这里用于表达“加载顺序/前置条件”，不是 CICConfig.deps 的替代品。
+     * @example ["vue"]
+     */
+    dependencies?: string[];
+}
+/**
+ * 模块降级配置
+ */
+export interface ModuleFallback {
+    /**
+     * 兜底策略
+     * - global: 从全局变量读取
+     * - cdn: 走备用 CDN
+     */
+    strategy: 'global' | 'cdn';
+    /**
+     * 映射：模块 id -> 全局路径或 CDN 相对路径
+     * @example { "vue": "window.Vue" }
+     */
+    mapping?: Record<string, string>;
+    /**
+     * CDN 基础路径（strategy=cdn 时可用）
+     * @example "https://backup-cdn.example.com/libs/"
+     */
+    cdnBase?: string;
+}
+/**
+ * 组件配置
+ */
+export interface ComponentConfig {
+    /**
+     * 默认策略（可选）
+     * - global: 全局注册
+     * - local: 局部注册
+     * - lazy: 懒加载
+     * @default "global"
+     */
+    strategy?: 'global' | 'local' | 'lazy';
+    /**
+     * 组件适配器
+     * 为特定组件定义加载规则
+     */
+    adapters?: ComponentAdapter[];
+    /**
+     * 全局注册前缀（可选）
+     * @example "Cic"
+     */
+    prefix?: string;
+    /**
+     * 命名规则（可选）
+     * @example "kebab-case" | "PascalCase" | "camelCase"
+     */
+    naming?: 'kebab-case' | 'PascalCase' | 'camelCase' | string;
+    /**
+     * 简易注册表（可选）
+     *
+     * 组件名 -> 模块 id/路径
+     * @example { "ECharts": "@anov/charts", "DataTable": "@anov/components" }
+     */
+    registry?: Record<string, string>;
+}
+/**
+ * 组件适配器
+ */
+export interface ComponentAdapter {
+    /**
+     * 匹配模式
+     * 支持通配符
+     * @example "echarts" | "@arco-design/*" | "*"
+     */
+    match: string;
+    /**
+     * 适配器类型
+     * - plugin: Vue/React 插件（install/use）
+     * - component: 单个组件
+     * - module: 需要初始化的模块（init 等）
+     * - global: 全局对象（window.echarts 等）
+     */
+    kind: 'plugin' | 'component' | 'module' | 'global';
+    /**
+     * 注册配置（可选）
+     *
+     * 用于解决不同组件库/组件需要不同调用方式的问题：
+     * - install/use：插件注册
+     * - init：模块初始化
+     * - register：自定义注册
+     */
+    register?: {
+        /**
+         * 注册方法
+         * @example "install" | "use" | "init" | "register"
+         */
+        method?: string;
+        /**
+         * 注册目标
+         * @example "app" | "Vue" | "window"
+         */
+        target?: string;
+        /**
+         * 初始化参数
+         */
+        options?: Record<string, any>;
+    };
+    /**
+     * 是否必需（可选）
+     * @default true
+     */
+    required?: boolean;
+    /**
+     * 依赖项（可选）
+     *
+     * 说明：这里的 dependencies 仅用于表达“组件注册/初始化”的前置依赖（顺序/就绪条件），
+     * 不是 CICConfig.deps 的替代品。
+     * @example ["vue"]
+     */
+    dependencies?: string[];
+    /**
+     * 是否异步（可选）
+     * @default false
+     */
+    async?: boolean;
+    /**
+     * 组件实例初始化（可选）
+     *
+     * 场景：某些组件在渲染后默认隐藏，需要对组件“实例”主动调用 init 才会显示/运行。
+     *
+     * 前提（以 Vue3 为例）：组件需要通过 expose 暴露出 init 方法，运行时装配器通过 ref/proxy
+     * 拿到实例后执行调用。
+     */
+    instanceInit?: {
+        /**
+         * 触发时机
+         * - mounted: 组件挂载完成后
+         * - ready: 运行时认为实例可用时（框架自定义时机）
+         * @default "mounted"
+         */
+        when?: 'mounted' | 'ready';
+        /**
+         * 要调用的实例方法名
+         * @example "init"
+         */
+        method: string;
+        /**
+         * 初始化参数（可选）
+         */
+        options?: Record<string, any>;
+        /**
+         * 调用前的就绪判断（可选）
+         * @example "typeof instance.init === 'function'"
+         */
+        guard?: string;
+    };
+    /**
+     * 全局对象名称（kind=global 时可用）
+     * @example "echarts"
+     */
+    globalName?: string;
+}
+export interface ManifestExportConfig {
+    /**
+     * 导出 CIC Config 时，从 config.deps 中排除这些依赖 id
+     * @example ["vue","vue-router","pinia"]
+     */
+    excludeDeps?: string[];
+    /**
+     * 说明原因（可选）
+     * @example "由宿主统一注入"
+     */
+    reason?: string;
+}
+export declare const CICManifestExample: CICManifest;
+export declare const CICManifestMinimal: CICManifest;
+export declare const CICManifestReact: CICManifest;
+export declare const CICManifestMiniProgram: CICManifest;

package/dist/types/components.d.ts

@@ -1,17 +1,19 @@
 import { CICEventMap } from './events';
 import { Data } from './data';
+import { JSFormat } from './deps';
 /** 通用表达式（用于条件、模板等） */
 export type Expr = string;
 /** 样式值可以是静态或表达式 */
 export type StyleValue = string | number | Expr;
 /** component 引用：字符串或 object 描述 */
 export type ComponentRef = string | {
-    type: "id";
+    type: 'id';
     value: string;
 };
 export type LogicRef = string | {
-    type: "url" | "code";
+    type: 'url' | 'code';
     value: string;
+    format?: JSFormat;
 };
 /**
  * 组件的语义分类（view/container/logic）

package/dist/types/data.d.ts

@@ -18,6 +18,7 @@ export interface IMapping {
 export interface IConverse {
     use: boolean;
     data: Array<{
+        name?: string;
         /** 转换代码 */
         code: string;
         /** 依赖变量列表（用于响应式重执行） */

package/dist/types/dataSources.d.ts

@@ -5,18 +5,19 @@ export interface DataSourceBase {
     order?: number;
     pollInterval?: Milliseconds;
     transform?: string | ((res: any) => any);
+    extensions?: Record<string, any>;
 }
 export interface DataSourceRest extends DataSourceBase {
-    type: "rest";
+    type: 'rest';
     url: string;
-    method: "GET" | "POST" | "PUT" | "DELETE";
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
     headers?: Record<string, string>;
     params?: Record<string, any>;
     body?: any;
     timeout?: Milliseconds;
 }
 export interface DataSourceWebSocket extends DataSourceBase {
-    type: "websocket";
+    type: 'websocket';
     url: string;
     protocols?: string | string[];
     subscribeMessage?: any;
@@ -26,11 +27,11 @@ export interface DataSourceWebSocket extends DataSourceBase {
     };
 }
 export interface DataSourceStatic extends DataSourceBase {
-    type: "static";
+    type: 'static';
     value: any;
 }
 export interface DataSourceFunction extends DataSourceBase {
-    type: "function";
+    type: 'function';
     code: string;
     timeout?: Milliseconds;
 }

package/dist/types/deps.d.ts

@@ -12,7 +12,7 @@ export interface BaseDependency {
     name?: string;
     /** 版本号（语义化版本 / 字体权重皆可） */
     version?: string;
-    /** 资源 URL，可以是绝对地址或相对地址 */
+    /** 资源 URL，服务器或CDN地址 */
     url?: string;
     /** 本地路径（构建后使用） */
     localPath?: string;
@@ -28,6 +28,7 @@ export interface BaseDependency {
         /** 仅在某些条件下加载（如主题） */
         when?: string;
     };
+    extensions?: Record<string, any>;
 }
 /** JS 资源 */
 export interface JSDependency extends BaseDependency {

package/dist/types/index.d.ts

@@ -1,4 +1,6 @@
 /** AUTO-GENERATED BY generate-types.ts — DO NOT EDIT MANUALLY */
+export * from './adapter';
+export * from './cic.manifest';
 export * from './cic';
 export * from './components';
 export * from './data';
@@ -8,4 +10,5 @@ export * from './events';
 export * from './meta';
 export * from './page';
 export * from './registry';
+export * from './runtime.manifest';
 export * from './variables';