@chatbi-v/core 2.0.0 → 2.0.2

package/dist/ports/plugin-port.d.ts

@@ -157,9 +157,9 @@ export interface PluginContext {
 export interface Plugin extends PluginLifecycle {
     /**
      * 插件 ID
-     * @description 必须与 metadata.id 一致，方便快速访问
+     * @description 必须与 metadata.id 一致，且定义为只读（通常通过 getter 实现）
      */
-    id: string;
+    readonly id: string;
     metadata: PluginMetadata;
     /** 插件提供的组件（可选） */
     components?: Record<string, React.ComponentType<any>>;
@@ -168,6 +168,30 @@ export interface Plugin extends PluginLifecycle {
     /** 默认配置（可选） */
     defaultConfig?: Record<string, any>;
 }
+/**
+ * 插件基础类
+ * @deprecated 建议统一使用工厂模式 definePlugin() 定义插件，以消除类与对象定义的歧义。
+ * @description 解决插件定义时 id 与 metadata.id 重复定义的问题，并提供基础生命周期管理
+ */
+export declare abstract class BasePlugin implements Plugin {
+    abstract metadata: PluginMetadata;
+    /**
+     * 插件 ID
+     * @description 自动从 metadata.id 获取
+     */
+    get id(): string;
+    onLoad?(context: PluginContext): void | Promise<void>;
+    onMount?(context: PluginContext): void;
+    onUnmount?(context: PluginContext): void;
+    onConfigChange?(newConfig: any, oldConfig: any): void;
+}
+/**
+ * 辅助函数：定义插件并自动从 metadata.id 注入顶级 id
+ * @description 解决插件定义时 id 与 metadata.id 重复定义的问题，提高代码优雅度
+ * @param plugin 插件定义（不包含顶级 id）
+ * @returns 完整的插件对象
+ */
+export declare function definePlugin(plugin: Omit<Plugin, 'id'>): Plugin;
 export interface PluginMetadata {
     id: string;
     name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chatbi-v/core",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "main": "dist/index.cjs",
   "files": [
     "dist"
@@ -24,13 +24,13 @@
   },
   "peerDependencies": {
     "react": ">=18.0.0",
-    "react-dom": ">=18.0.0",
-    "@chatbi-v/cli": "1.0.9"
+    "react-dom": ">=18.0.0"
   },
   "devDependencies": {
     "tsup": "^8.5.1",
     "vite": "^5.4.21",
-    "@chatbi-v/tsconfig": "1.0.2"
+    "@chatbi-v/cli": "2.0.2",
+    "@chatbi-v/tsconfig": "2.0.2"
   },
   "scripts": {
     "build": "chatbi-cli build",