@anov/cic-standard-sdk 0.0.20 → 0.0.21

package/dist/types/adapter.d.ts

@@ -1,385 +0,0 @@
-/**
- * Adapter（生产层）接口
- *
- * 职责边界：
- * - Adapter：只负责“用什么渲染 & 怎么执行渲染动作”（创建上下文、注册、挂载、卸载、可选实例方法调用）
- * - 协调层（CICSDK/运行时）：负责解析 CICConfig + Manifest，产出 ResolvedComponent、并决定调用顺序
- */
-import type { CICConfig } from './cic';
-import type { CICManifest } from './cic.manifest';
-export type EngineConfig = CICManifest['engine'];
-/**
- * 创建上下文选项
- */
-export interface CreateContextOptions<TContainer = any> {
-    /**
-     * CIC 配置
-     */
-    config: CICConfig;
-    /**
-     * Manifest 配置
-     */
-    manifest: CICManifest;
-    /**
-     * 容器元素
-     */
-    container?: TContainer;
-    /**
-     * 已解析的组件列表
-     */
-    resolvedComponents?: ResolvedComponent[];
-    /**
-     * 已加载的模块
-     */
-    loadedModules?: Map<string, any>;
-    /**
-     * 其他选项
-     */
-    [key: string]: any;
-}
-/**
- * 已解析的组件
- */
-export interface ResolvedComponent {
-    /**
-     * 组件 ID
-     */
-    id: string;
-    /**
-     * 组件类型
-     */
-    kind: 'component' | 'plugin' | 'module' | 'directive' | 'filter' | 'global';
-    /**
-     * 组件值（实际的组件/插件/模块）
-     */
-    value: any;
-    /**
-     * 注册配置
-     */
-    register?: {
-        /**
-         * 注册方法名（如 'install', 'init'）
-         */
-        method?: string;
-        /**
-         * 注册选项
-         */
-        options?: any;
-    };
-    /**
-     * 是否必需
-     */
-    required?: boolean;
-    /**
-     * 依赖项
-     */
-    dependencies?: string[];
-    /**
-     * 是否异步
-     */
-    async?: boolean;
-}
-/**
- * Adapter 上下文
- */
-export interface AdapterContext<TContainer = any, TApp = any> {
-    /**
-     * 应用实例（如 Vue app、React root）
-     */
-    app: TApp;
-    /**
-     * 容器元素
-     */
-    container: TContainer;
-    /**
-     * 引擎配置
-     */
-    runtime: EngineConfig;
-    /**
-     * CIC 配置
-     */
-    config: CICConfig;
-    /**
-     * Manifest 配置
-     */
-    manifest: CICManifest;
-    /**
-     * 已解析的组件
-     */
-    resolvedComponents: ResolvedComponent[];
-    /**
-     * 已加载的模块
-     */
-    loadedModules?: Map<string, any>;
-    /**
-     * 扩展数据
-     */
-    [key: string]: any;
-}
-/**
- * Adapter 接口（优化版）
- *
- * 完整生命周期：
- * 1. supports(engine)              - 检查是否支持
- * 2. createContext(options)        - 创建上下文
- * 3. prepare(context)              - 准备阶段（可选）
- * 4. register(context)             - 注册阶段
- * 5. mount(context)                - 挂载阶段
- * 6. update(context, config)       - 更新阶段（可选）
- * 7. unmount(context)              - 卸载阶段
- *
- * @template TContainer 容器类型（如 HTMLElement）
- * @template TApp 应用实例类型（如 Vue App、React Root）
- * @template TMountedInstance 挂载后的实例类型
- * @template TContext 上下文类型
- */
-export interface Adapter<TContainer = any, TApp = any, TMountedInstance = any, TContext extends AdapterContext<TContainer, TApp> = AdapterContext<TContainer, TApp>> {
-    /**
-     * Adapter 唯一标识
-     *
-     * 命名规范：{platform}/{runtime}
-     *
-     * @example
-     * "web/vue3"
-     * "web/react"
-     * "mobile/react-native"
-     * "desktop/electron-vue"
-     */
-    id: string;
-    /**
-     * Adapter 版本（可选）
-     */
-    version?: string;
-    /**
-     * 描述（可选）
-     */
-    description?: string;
-    /**
-     * 1️⃣ 检查是否支持
-     *
-     * 在选择 Adapter 时调用，用于判断当前 Adapter 是否支持目标引擎
-     *
-     * @param engine 引擎配置
-     * @returns 是否支持
-     *
-     * @example
-     * supports: (engine) => {
-     *   return engine.platform === 'web' && engine.runtime === 'vue3';
-     * }
-     */
-    supports: (engine: EngineConfig) => boolean;
-    /**
-     * 2️⃣ 创建上下文
-     *
-     * 在开始渲染前调用，创建必要的运行时环境
-     *
-     * 职责：
-     * - 创建应用实例（如 createApp、createRoot）
-     * - 初始化基础配置
-     * - 准备上下文对象
-     *
-     * @param options 创建选项
-     * @returns 上下文对象
-     *
-     * @example
-     * createContext: async (options) => {
-     *   const app = createApp({
-     *     template: '<div id="cic-root"><router-view /></div>'
-     *   });
-     *
-     *   return {
-     *     app,
-     *     container: options.container,
-     *     runtime: options.manifest.engine,
-     *     config: options.config,
-     *     manifest: options.manifest,
-     *     resolvedComponents: options.resolvedComponents || []
-     *   };
-     * }
-     */
-    createContext: (options: CreateContextOptions<TContainer>) => Promise<TContext>;
-    /**
-     * 3️⃣ 准备阶段（可选）
-     *
-     * 在注册组件之前执行，用于安装插件和配置核心功能
-     *
-     * 职责：
-     * - 安装框架插件（Vue Router、React Router）
-     * - 配置状态管理（Pinia、Redux）
-     * - 全局配置（errorHandler、warnHandler）
-     * - 加载主题、国际化等全局资源
-     *
-     * @param context 上下文
-     *
-     * @example
-     * prepare: async (context) => {
-     *   const { app, loadedModules } = context;
-     *
-     *   // 安装路由
-     *   const router = loadedModules?.get('vue-router');
-     *   if (router) {
-     *     app.use(router);
-     *   }
-     *
-     *   // 安装状态管理
-     *   const pinia = loadedModules?.get('pinia');
-     *   if (pinia) {
-     *     app.use(pinia);
-     *   }
-     *
-     *   // 全局配置
-     *   app.config.errorHandler = (err) => {
-     *     console.error('Global error:', err);
-     *   };
-     * }
-     */
-    prepare?: (context: TContext, config: CICConfig, manifest: CICManifest) => Promise<void>;
-    /**
-     * 4️⃣ 注册阶段
-     *
-     * 注册组件、指令、过滤器等
-     *
-     * 职责：
-     * - 注册全局组件
-     * - 注册指令
-     * - 注册过滤器（Vue2）
-     * - 注册公共组件（从 ComponentRegistry）
-     *
-     * @param context 上下文
-     * @param config CIC 配置
-     * @param manifest Manifest 配置
-     *
-     * @example
-     * register: async (context, config, manifest) => {
-     *   const { app, resolvedComponents } = context;
-     *
-     *   for (const comp of resolvedComponents) {
-     *     switch (comp.kind) {
-     *       case 'plugin':
-     *         app.use(comp.value, comp.register?.options);
-     *         break;
-     *
-     *       case 'component':
-     *         const name = comp.register?.options?.name || comp.id;
-     *         app.component(name, comp.value);
-     *         break;
-     *
-     *       case 'directive':
-     *         const directiveName = comp.register?.options?.name || comp.id;
-     *         app.directive(directiveName, comp.value);
-     *         break;
-     *     }
-     *   }
-     * }
-     */
-    register: (context: TContext, config: CICConfig, manifest: CICManifest) => Promise<void>;
-    /**
-     * 5️⃣ 挂载阶段
-     *
-     * 将应用挂载到容器
-     *
-     * 职责：
-     * - 执行挂载操作
-     * - 返回挂载后的实例
-     *
-     * @param context 上下文
-     * @returns 挂载后的实例
-     *
-     * @example
-     * mount: async (context) => {
-     *   const { app, container } = context;
-     *   const instance = app.mount(container);
-     *   return instance;
-     * }
-     */
-    mount: (context: TContext) => Promise<TMountedInstance>;
-    /**
-     * 6️⃣ 更新阶段（可选）
-     *
-     * 动态更新配置，支持热更新
-     *
-     * 职责：
-     * - 更新组件配置
-     * - 触发重新渲染
-     *
-     * @param context 上下文
-     * @param newConfig 新配置（部分）
-     *
-     * @example
-     * update: async (context, newConfig) => {
-     *   // 更新配置并重新渲染
-     *   Object.assign(context.config, newConfig);
-     *   // 触发更新逻辑...
-     * }
-     */
-    update?: (context: TContext, newConfig: Partial<CICConfig>) => Promise<void>;
-    /**
-     * 7️⃣ 卸载阶段
-     *
-     * 清理资源，卸载应用
-     *
-     * 职责：
-     * - 卸载应用
-     * - 清理事件监听
-     * - 释放内存
-     *
-     * @param context 上下文
-     *
-     * @example
-     * unmount: async (context) => {
-     *   const { app } = context;
-     *   app.unmount();
-     * }
-     */
-    unmount: (context: TContext) => Promise<void>;
-    /**
-     * 调用组件方法（可选）
-     *
-     * 用于调用已挂载组件的实例方法
-     *
-     * @param context 上下文
-     * @param componentId 组件 ID
-     * @param methodName 方法名
-     * @param args 参数
-     * @returns 方法返回值
-     *
-     * @example
-     * callMethod: async (context, 'my-chart', 'updateData', [newData]) => {
-     *   const instance = findComponentInstance(context, 'my-chart');
-     *   return instance?.[methodName]?.(...args);
-     * }
-     */
-    callMethod?: (context: TContext, componentId: string, methodName: string, args?: any[]) => Promise<any>;
-    /**
-     * 获取组件实例（可选）
-     *
-     * 用于获取已挂载组件的实例
-     *
-     * @param context 上下文
-     * @param componentId 组件 ID
-     * @returns 组件实例
-     */
-    getComponentInstance?: (context: TContext, componentId: string) => any;
-    /**
-     * 验证配置（可选）
-     *
-     * 在创建上下文前验证配置是否合法
-     *
-     * @param config CIC 配置
-     * @param manifest Manifest 配置
-     * @returns 验证结果
-     */
-    validate?: (config: CICConfig, manifest: CICManifest) => {
-        valid: boolean;
-        errors?: string[];
-    };
-    /**
-     * 渲染阶段
-     *
-     * 渲染应用到容器
-     *
-     * @param config CIC 配置
-     * @param manifest Manifest 配置
-     */
-    render: (context: TContext, config: CICConfig, manifest: CICManifest) => Promise<void>;
-}