@schema-element-editor/host-sdk 2.1.1 → 2.2.0

package/dist/react.cjs

@@ -292,7 +292,7 @@ function createSchemaElementEditorBridge(config) {
   const implementedMethods = [];
   if (typeof getSchema === "function") implementedMethods.push(METHOD_NAMES.GET_SCHEMA);
   if (typeof updateSchema === "function") implementedMethods.push(METHOD_NAMES.UPDATE_SCHEMA);
-  if (typeof renderPreview === "function") {
+  if (renderPreview !== void 0) {
     implementedMethods.push(
       METHOD_NAMES.CHECK_PREVIEW,
       METHOD_NAMES.RENDER_PREVIEW,
@@ -397,7 +397,8 @@ function createSchemaElementEditorBridge(config) {
         break;
       }
       case mergedMessageTypes.checkPreview: {
-        result = { exists: typeof renderPreview2 === "function" };
+        const exists = typeof renderPreview2 === "function";
+        result = { exists };
         break;
       }
       case mergedMessageTypes.renderPreview: {
@@ -505,7 +506,11 @@ function useSchemaElementEditor(config) {
       // 内层使用可选链安全访问，配合类型断言确保类型正确
       getSchema: configRef.current.getSchema ? (params) => configRef.current.getSchema?.(params) : void 0,
       updateSchema: configRef.current.updateSchema ? (schema, params) => configRef.current.updateSchema?.(schema, params) : void 0,
-      renderPreview: configRef.current.renderPreview ? (schema, containerId) => configRef.current.renderPreview?.(schema, containerId) : void 0,
+      // renderPreview 需要特殊处理：
+      // - undefined: 不传递（不参与竞争）
+      // - null: 传递 null（参与竞争但阻止预览）
+      // - function: 创建代理函数
+      renderPreview: configRef.current.renderPreview === null ? null : configRef.current.renderPreview ? (schema, containerId) => configRef.current.renderPreview?.(schema, containerId) : void 0,
       sourceConfig,
       messageTypes,
       sdkId,

package/dist/react.d.cts

@@ -1,4 +1,4 @@
-import { b as SchemaElementEditorConfig, d as SchemaElementEditorRecording } from './types-D2ZJx8T_.cjs';
+import { b as SchemaElementEditorConfig, S as SchemaValue, d as SchemaElementEditorRecording } from './types-BSn4QaId.cjs';
 
 /**
  * Schema Element Editor Host SDK - React
@@ -6,7 +6,16 @@ import { b as SchemaElementEditorConfig, d as SchemaElementEditorRecording } fro
  */
 
 /** React 版本的 Schema Element Editor 配置 */
-interface ReactSchemaElementEditorConfig extends SchemaElementEditorConfig {
+interface ReactSchemaElementEditorConfig extends Omit<SchemaElementEditorConfig, 'renderPreview'> {
+    /**
+     * 渲染预览（可选）
+     *
+     * 特殊值说明：
+     * - undefined（默认）：不关心预览功能，不参与优先级竞争
+     * - null：明确阻止预览功能，参与优先级竞争但告诉插件不支持预览（触发内置预览器）
+     * - function：提供预览功能，参与优先级竞争并正常渲染
+     */
+    renderPreview?: ((schema: SchemaValue, containerId: string) => (() => void) | void) | null;
     /**
      * 是否启用桥接（默认 true）
      * 设为 false 时不创建桥接器，不监听消息

package/dist/react.d.ts

@@ -1,4 +1,4 @@
-import { b as SchemaElementEditorConfig, d as SchemaElementEditorRecording } from './types-D2ZJx8T_.js';
+import { b as SchemaElementEditorConfig, S as SchemaValue, d as SchemaElementEditorRecording } from './types-BSn4QaId.js';
 
 /**
  * Schema Element Editor Host SDK - React
@@ -6,7 +6,16 @@ import { b as SchemaElementEditorConfig, d as SchemaElementEditorRecording } fro
  */
 
 /** React 版本的 Schema Element Editor 配置 */
-interface ReactSchemaElementEditorConfig extends SchemaElementEditorConfig {
+interface ReactSchemaElementEditorConfig extends Omit<SchemaElementEditorConfig, 'renderPreview'> {
+    /**
+     * 渲染预览（可选）
+     *
+     * 特殊值说明：
+     * - undefined（默认）：不关心预览功能，不参与优先级竞争
+     * - null：明确阻止预览功能，参与优先级竞争但告诉插件不支持预览（触发内置预览器）
+     * - function：提供预览功能，参与优先级竞争并正常渲染
+     */
+    renderPreview?: ((schema: SchemaValue, containerId: string) => (() => void) | void) | null;
     /**
      * 是否启用桥接（默认 true）
      * 设为 false 时不创建桥接器，不监听消息

package/dist/react.js

@@ -1,7 +1,7 @@
 import {
   useSchemaElementEditor
-} from "./chunk-MK3EDWC5.js";
-import "./chunk-DLMX4NDA.js";
+} from "./chunk-X4JAISLV.js";
+import "./chunk-H36IVM7V.js";
 export {
   useSchemaElementEditor
 };

package/dist/types-BSn4QaId.d.cts

@@ -0,0 +1,108 @@
+/**
+ * Schema Element Editor Host SDK - Types
+ * 类型定义
+ */
+/**
+ * Schema 数据类型
+ * 支持所有 JSON.parse 可返回的类型
+ */
+type SchemaValue = Record<string, unknown> | unknown[] | string | number | boolean | null;
+/** postMessage 消息标识配置 */
+interface PostMessageSourceConfig {
+    /** 插件端发送消息的 source 标识 */
+    contentSource: string;
+    /** 宿主端响应消息的 source 标识 */
+    hostSource: string;
+}
+/** postMessage 消息类型配置 */
+interface PostMessageTypeConfig {
+    getSchema: string;
+    updateSchema: string;
+    checkPreview: string;
+    renderPreview: string;
+    cleanupPreview: string;
+    startRecording: string;
+    stopRecording: string;
+    schemaPush: string;
+}
+/** SDK 方法级别配置 */
+interface MethodLevelConfig {
+    getSchema?: number;
+    updateSchema?: number;
+    checkPreview?: number;
+    renderPreview?: number;
+    cleanupPreview?: number;
+    startRecording?: number;
+    stopRecording?: number;
+}
+/**
+ * Schema Element Editor 配置接口
+ */
+interface SchemaElementEditorConfig {
+    /**
+     * 获取 Schema 数据（可选）
+     * @param params - 元素参数（通常是 data-id 的值）
+     * @returns Schema 数据（支持所有 JSON 类型）
+     */
+    getSchema?: (params: string) => SchemaValue;
+    /**
+     * 更新 Schema 数据（可选）
+     * @param schema - 新的 Schema 数据（支持所有 JSON 类型）
+     * @param params - 元素参数
+     * @returns 是否更新成功
+     */
+    updateSchema?: (schema: SchemaValue, params: string) => boolean;
+    /**
+     * 渲染预览（可选）
+     * @param schema - Schema 数据（支持所有 JSON 类型）
+     * @param containerId - 预览容器 ID
+     * @returns 清理函数（可选）
+     *
+     * 特殊值说明：
+     * - undefined（默认）：不关心预览功能，不参与优先级竞争
+     * - null：明确阻止预览功能，参与优先级竞争但告诉插件不支持预览（触发内置预览器）
+     * - function：提供预览功能，参与优先级竞争并正常渲染
+     */
+    renderPreview?: ((schema: SchemaValue, containerId: string) => (() => void) | void) | null;
+    /** 消息标识配置（可选，有默认值） */
+    sourceConfig?: Partial<PostMessageSourceConfig>;
+    /** 消息类型配置（可选，有默认值） */
+    messageTypes?: Partial<PostMessageTypeConfig>;
+    /**
+     * SDK 实例唯一标识（可选，自动生成）
+     * 用于多 SDK 实例协调
+     */
+    sdkId?: string;
+    /**
+     * SDK 优先级（可选，默认 0）
+     * 数值越大优先级越高，当多个 SDK 实例共存时，优先级高的响应请求
+     */
+    level?: number;
+    /**
+     * 方法级别优先级配置（可选）
+     * 可以为每个方法单独配置优先级，未配置的方法使用 level 作为优先级
+     */
+    methodLevels?: MethodLevelConfig;
+}
+/**
+ * 录制相关方法
+ */
+interface SchemaElementEditorRecording {
+    /**
+     * 推送 Schema 数据（SDK 内部判断是否在录制，未录制时静默忽略）
+     * @param params - 元素参数（data-id 的值）
+     * @param data - Schema 数据
+     */
+    push: (params: string, data: SchemaValue) => void;
+}
+/**
+ * Schema Element Editor 桥接器返回值
+ */
+interface SchemaElementEditorBridge {
+    /** 清理桥接器，移除事件监听 */
+    cleanup: () => void;
+    /** 录制相关方法 */
+    recording: SchemaElementEditorRecording;
+}
+
+export type { MethodLevelConfig as M, PostMessageSourceConfig as P, SchemaValue as S, PostMessageTypeConfig as a, SchemaElementEditorConfig as b, SchemaElementEditorBridge as c, SchemaElementEditorRecording as d };

package/dist/types-BSn4QaId.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Schema Element Editor Host SDK - Types
+ * 类型定义
+ */
+/**
+ * Schema 数据类型
+ * 支持所有 JSON.parse 可返回的类型
+ */
+type SchemaValue = Record<string, unknown> | unknown[] | string | number | boolean | null;
+/** postMessage 消息标识配置 */
+interface PostMessageSourceConfig {
+    /** 插件端发送消息的 source 标识 */
+    contentSource: string;
+    /** 宿主端响应消息的 source 标识 */
+    hostSource: string;
+}
+/** postMessage 消息类型配置 */
+interface PostMessageTypeConfig {
+    getSchema: string;
+    updateSchema: string;
+    checkPreview: string;
+    renderPreview: string;
+    cleanupPreview: string;
+    startRecording: string;
+    stopRecording: string;
+    schemaPush: string;
+}
+/** SDK 方法级别配置 */
+interface MethodLevelConfig {
+    getSchema?: number;
+    updateSchema?: number;
+    checkPreview?: number;
+    renderPreview?: number;
+    cleanupPreview?: number;
+    startRecording?: number;
+    stopRecording?: number;
+}
+/**
+ * Schema Element Editor 配置接口
+ */
+interface SchemaElementEditorConfig {
+    /**
+     * 获取 Schema 数据（可选）
+     * @param params - 元素参数（通常是 data-id 的值）
+     * @returns Schema 数据（支持所有 JSON 类型）
+     */
+    getSchema?: (params: string) => SchemaValue;
+    /**
+     * 更新 Schema 数据（可选）
+     * @param schema - 新的 Schema 数据（支持所有 JSON 类型）
+     * @param params - 元素参数
+     * @returns 是否更新成功
+     */
+    updateSchema?: (schema: SchemaValue, params: string) => boolean;
+    /**
+     * 渲染预览（可选）
+     * @param schema - Schema 数据（支持所有 JSON 类型）
+     * @param containerId - 预览容器 ID
+     * @returns 清理函数（可选）
+     *
+     * 特殊值说明：
+     * - undefined（默认）：不关心预览功能，不参与优先级竞争
+     * - null：明确阻止预览功能，参与优先级竞争但告诉插件不支持预览（触发内置预览器）
+     * - function：提供预览功能，参与优先级竞争并正常渲染
+     */
+    renderPreview?: ((schema: SchemaValue, containerId: string) => (() => void) | void) | null;
+    /** 消息标识配置（可选，有默认值） */
+    sourceConfig?: Partial<PostMessageSourceConfig>;
+    /** 消息类型配置（可选，有默认值） */
+    messageTypes?: Partial<PostMessageTypeConfig>;
+    /**
+     * SDK 实例唯一标识（可选，自动生成）
+     * 用于多 SDK 实例协调
+     */
+    sdkId?: string;
+    /**
+     * SDK 优先级（可选，默认 0）
+     * 数值越大优先级越高，当多个 SDK 实例共存时，优先级高的响应请求
+     */
+    level?: number;
+    /**
+     * 方法级别优先级配置（可选）
+     * 可以为每个方法单独配置优先级，未配置的方法使用 level 作为优先级
+     */
+    methodLevels?: MethodLevelConfig;
+}
+/**
+ * 录制相关方法
+ */
+interface SchemaElementEditorRecording {
+    /**
+     * 推送 Schema 数据（SDK 内部判断是否在录制，未录制时静默忽略）
+     * @param params - 元素参数（data-id 的值）
+     * @param data - Schema 数据
+     */
+    push: (params: string, data: SchemaValue) => void;
+}
+/**
+ * Schema Element Editor 桥接器返回值
+ */
+interface SchemaElementEditorBridge {
+    /** 清理桥接器，移除事件监听 */
+    cleanup: () => void;
+    /** 录制相关方法 */
+    recording: SchemaElementEditorRecording;
+}
+
+export type { MethodLevelConfig as M, PostMessageSourceConfig as P, SchemaValue as S, PostMessageTypeConfig as a, SchemaElementEditorConfig as b, SchemaElementEditorBridge as c, SchemaElementEditorRecording as d };

package/dist/vue.cjs

@@ -292,7 +292,7 @@ function createSchemaElementEditorBridge(config) {
   const implementedMethods = [];
   if (typeof getSchema === "function") implementedMethods.push(METHOD_NAMES.GET_SCHEMA);
   if (typeof updateSchema === "function") implementedMethods.push(METHOD_NAMES.UPDATE_SCHEMA);
-  if (typeof renderPreview === "function") {
+  if (renderPreview !== void 0) {
     implementedMethods.push(
       METHOD_NAMES.CHECK_PREVIEW,
       METHOD_NAMES.RENDER_PREVIEW,
@@ -397,7 +397,8 @@ function createSchemaElementEditorBridge(config) {
         break;
       }
       case mergedMessageTypes.checkPreview: {
-        result = { exists: typeof renderPreview2 === "function" };
+        const exists = typeof renderPreview2 === "function";
+        result = { exists };
         break;
       }
       case mergedMessageTypes.renderPreview: {

package/dist/vue.d.cts

@@ -1,5 +1,5 @@
 import { MaybeRefOrGetter } from 'vue';
-import { S as SchemaValue, P as PostMessageSourceConfig, a as PostMessageTypeConfig, M as MethodLevelConfig, d as SchemaElementEditorRecording } from './types-D2ZJx8T_.cjs';
+import { S as SchemaValue, P as PostMessageSourceConfig, a as PostMessageTypeConfig, M as MethodLevelConfig, d as SchemaElementEditorRecording } from './types-BSn4QaId.cjs';
 
 /**
  * Schema Element Editor Host SDK - Vue
@@ -21,8 +21,13 @@ interface VueSchemaElementEditorConfig {
     updateSchema: MaybeRefOrGetter<(schema: SchemaValue, params: string) => boolean>;
     /**
      * 渲染预览（可选）
+     *
+     * 特殊值说明：
+     * - undefined（默认）：不关心预览功能，不参与优先级竞争
+     * - null：明确阻止预览功能，参与优先级竞争但告诉插件不支持预览（触发内置预览器）
+     * - function：提供预览功能，参与优先级竞争并正常渲染
      */
-    renderPreview?: MaybeRefOrGetter<((schema: SchemaValue, containerId: string) => (() => void) | void) | undefined>;
+    renderPreview?: MaybeRefOrGetter<((schema: SchemaValue, containerId: string) => (() => void) | void) | null | undefined>;
     /**
      * 是否启用桥接（默认 true）
      * 设为 false 时不创建桥接器，不监听消息

package/dist/vue.d.ts

@@ -1,5 +1,5 @@
 import { MaybeRefOrGetter } from 'vue';
-import { S as SchemaValue, P as PostMessageSourceConfig, a as PostMessageTypeConfig, M as MethodLevelConfig, d as SchemaElementEditorRecording } from './types-D2ZJx8T_.js';
+import { S as SchemaValue, P as PostMessageSourceConfig, a as PostMessageTypeConfig, M as MethodLevelConfig, d as SchemaElementEditorRecording } from './types-BSn4QaId.js';
 
 /**
  * Schema Element Editor Host SDK - Vue
@@ -21,8 +21,13 @@ interface VueSchemaElementEditorConfig {
     updateSchema: MaybeRefOrGetter<(schema: SchemaValue, params: string) => boolean>;
     /**
      * 渲染预览（可选）
+     *
+     * 特殊值说明：
+     * - undefined（默认）：不关心预览功能，不参与优先级竞争
+     * - null：明确阻止预览功能，参与优先级竞争但告诉插件不支持预览（触发内置预览器）
+     * - function：提供预览功能，参与优先级竞争并正常渲染
      */
-    renderPreview?: MaybeRefOrGetter<((schema: SchemaValue, containerId: string) => (() => void) | void) | undefined>;
+    renderPreview?: MaybeRefOrGetter<((schema: SchemaValue, containerId: string) => (() => void) | void) | null | undefined>;
     /**
      * 是否启用桥接（默认 true）
      * 设为 false 时不创建桥接器，不监听消息

package/dist/vue.js

@@ -1,6 +1,6 @@
 import {
   createSchemaElementEditorBridge
-} from "./chunk-DLMX4NDA.js";
+} from "./chunk-H36IVM7V.js";
 
 // src/vue.ts
 import { onMounted, onUnmounted, watch, toValue } from "vue";

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@schema-element-editor/host-sdk",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "Schema Element Editor (SEE) 插件宿主接入 SDK，支持 React/Vue/纯 JS",
   "type": "module",
+  "packageManager": "bun@1.3.5",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -31,6 +32,10 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "build": "tsup src/index.ts src/core.ts src/react.ts src/vue.ts --format esm,cjs --dts --out-dir dist --external react --external vue",
+    "prepublishOnly": "bun run build"
+  },
   "peerDependencies": {
     "react": ">=17.0.0",
     "vue": ">=3.0.0"
@@ -61,8 +66,5 @@
     "type": "git",
     "url": "https://github.com/hei-f/schema-element-editor.git",
     "directory": "packages/schema-element-editor-sdk"
-  },
-  "scripts": {
-    "build": "tsup src/index.ts src/core.ts src/react.ts src/vue.ts --format esm,cjs --dts --out-dir dist --external react --external vue"
   }
-}
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 hei-f
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.