@schema-element-editor/host-sdk 2.0.0

package/dist/react.d.ts

@@ -0,0 +1,54 @@
+import { SchemaElementEditorConfig, SchemaElementEditorRecording } from './core.js';
+export { PostMessageSourceConfig, PostMessageTypeConfig, SchemaElementEditorBridge, SchemaValue } from './core.js';
+
+/**
+ * Schema Element Editor Host SDK - React
+ * React hooks 包装
+ */
+
+/** React 版本的 Schema Element Editor 配置 */
+interface ReactSchemaElementEditorConfig extends SchemaElementEditorConfig {
+    /**
+     * 是否启用桥接（默认 true）
+     * 设为 false 时不创建桥接器，不监听消息
+     */
+    enabled?: boolean;
+}
+/** React hooks 返回值 */
+interface UseSchemaElementEditorReturn {
+    /** 录制相关方法 */
+    recording: SchemaElementEditorRecording;
+}
+/**
+ * Schema Element Editor 插件接入 hooks（React）
+ * 用于在宿主页面接入 Schema Element Editor 插件，通过 postMessage 接收插件请求并返回响应
+ *
+ * @param config - Schema Element Editor 配置
+ * @returns 桥接器方法，包含 recording
+ *
+ * @example
+ * ```tsx
+ * import { useSchemaElementEditor } from '@schema-element-editor/host-sdk'
+ *
+ * function App() {
+ *   const { recording } = useSchemaElementEditor({
+ *     getSchema: (params) => dataStore[params],
+ *     updateSchema: (schema, params) => {
+ *       dataStore[params] = schema
+ *       return true
+ *     },
+ *   })
+ *
+ *   // 数据变化时推送数据（SDK 内部管理录制状态，未录制时静默忽略）
+ *   sseHandler.onData = (params, data) => recording.push(params, data)
+ *
+ *   // 检查是否正在录制
+ *   if (recording.isActive('chat-1')) { ... }
+ *
+ *   return <div>...</div>
+ * }
+ * ```
+ */
+declare function useSchemaElementEditor(config: ReactSchemaElementEditorConfig): UseSchemaElementEditorReturn;
+
+export { type ReactSchemaElementEditorConfig, SchemaElementEditorConfig, SchemaElementEditorRecording, type UseSchemaElementEditorReturn, useSchemaElementEditor };

package/dist/react.js

@@ -0,0 +1,7 @@
+import {
+  useSchemaElementEditor
+} from "./chunk-MU6HL5E3.js";
+import "./chunk-KMNKOOWF.js";
+export {
+  useSchemaElementEditor
+};

package/dist/vue.cjs

@@ -0,0 +1,257 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/vue.ts
+var vue_exports = {};
+__export(vue_exports, {
+  useSchemaElementEditor: () => useSchemaElementEditor
+});
+module.exports = __toCommonJS(vue_exports);
+var import_vue = require("vue");
+
+// src/core.ts
+var DEFAULT_SOURCE_CONFIG = {
+  contentSource: "schema-element-editor-content",
+  hostSource: "schema-element-editor-host"
+};
+var DEFAULT_MESSAGE_TYPES = {
+  getSchema: "GET_SCHEMA",
+  updateSchema: "UPDATE_SCHEMA",
+  checkPreview: "CHECK_PREVIEW",
+  renderPreview: "RENDER_PREVIEW",
+  cleanupPreview: "CLEANUP_PREVIEW",
+  // 录制模式相关
+  startRecording: "START_RECORDING",
+  stopRecording: "STOP_RECORDING",
+  schemaPush: "SCHEMA_PUSH"
+};
+function createSchemaElementEditorBridge(config) {
+  const { getSchema, updateSchema, renderPreview, sourceConfig, messageTypes } = config;
+  const mergedSourceConfig = {
+    ...DEFAULT_SOURCE_CONFIG,
+    ...sourceConfig
+  };
+  const mergedMessageTypes = {
+    ...DEFAULT_MESSAGE_TYPES,
+    ...messageTypes
+  };
+  let previewCleanupFn = null;
+  const recordingParams = /* @__PURE__ */ new Set();
+  const currentConfig = { getSchema, updateSchema, renderPreview };
+  const sendResponse = (requestId, result) => {
+    const message = {
+      source: mergedSourceConfig.hostSource,
+      requestId,
+      ...result
+    };
+    const isInIframe = window !== window.top;
+    const targetWindow = isInIframe ? window.parent : window;
+    targetWindow.postMessage(message, "*");
+  };
+  const pushSchema = (params, data) => {
+    if (!recordingParams.has(params)) {
+      return;
+    }
+    const message = {
+      source: mergedSourceConfig.hostSource,
+      type: mergedMessageTypes.schemaPush,
+      payload: {
+        success: true,
+        data,
+        params
+      }
+    };
+    const isInIframe = window !== window.top;
+    const targetWindow = isInIframe ? window.parent : window;
+    targetWindow.postMessage(message, "*");
+  };
+  const handleMessage = (event) => {
+    const isFromSelf = event.source === window;
+    const isFromParent = window !== window.top && event.source === window.parent;
+    if (!isFromSelf && !isFromParent) return;
+    if (!event.data || event.data.source !== mergedSourceConfig.contentSource) return;
+    const { type, payload, requestId } = event.data;
+    if (!requestId) return;
+    const { getSchema: getSchema2, updateSchema: updateSchema2, renderPreview: renderPreview2 } = currentConfig;
+    let result;
+    switch (type) {
+      case mergedMessageTypes.getSchema: {
+        const params = String(payload?.params ?? "");
+        try {
+          const data = getSchema2(params);
+          result = { success: true, data };
+        } catch (error) {
+          result = {
+            success: false,
+            error: error instanceof Error ? error.message : "\u83B7\u53D6 Schema \u5931\u8D25"
+          };
+        }
+        break;
+      }
+      case mergedMessageTypes.updateSchema: {
+        const schema = payload?.schema;
+        const params = String(payload?.params ?? "");
+        try {
+          const success = updateSchema2(schema, params);
+          result = { success };
+        } catch (error) {
+          result = {
+            success: false,
+            error: error instanceof Error ? error.message : "\u66F4\u65B0 Schema \u5931\u8D25"
+          };
+        }
+        break;
+      }
+      case mergedMessageTypes.checkPreview: {
+        result = { exists: typeof renderPreview2 === "function" };
+        break;
+      }
+      case mergedMessageTypes.renderPreview: {
+        if (typeof renderPreview2 !== "function") {
+          result = { success: false, error: "\u9884\u89C8\u529F\u80FD\u672A\u914D\u7F6E" };
+          break;
+        }
+        const schema = payload?.schema;
+        const containerId = String(payload?.containerId ?? "");
+        try {
+          if (previewCleanupFn) {
+            previewCleanupFn();
+            previewCleanupFn = null;
+          }
+          const cleanup = renderPreview2(schema, containerId);
+          if (typeof cleanup === "function") {
+            previewCleanupFn = cleanup;
+          }
+          result = { success: true };
+        } catch (error) {
+          result = {
+            success: false,
+            error: error instanceof Error ? error.message : "\u6E32\u67D3\u9884\u89C8\u5931\u8D25"
+          };
+        }
+        break;
+      }
+      case mergedMessageTypes.cleanupPreview: {
+        try {
+          if (previewCleanupFn) {
+            previewCleanupFn();
+            previewCleanupFn = null;
+          }
+          result = { success: true };
+        } catch (error) {
+          result = {
+            success: false,
+            error: error instanceof Error ? error.message : "\u6E05\u7406\u9884\u89C8\u5931\u8D25"
+          };
+        }
+        break;
+      }
+      case mergedMessageTypes.startRecording: {
+        const params = String(payload?.params ?? "");
+        recordingParams.add(params);
+        result = { success: true };
+        break;
+      }
+      case mergedMessageTypes.stopRecording: {
+        const params = String(payload?.params ?? "");
+        recordingParams.delete(params);
+        result = { success: true };
+        break;
+      }
+      default:
+        return;
+    }
+    sendResponse(requestId, result);
+  };
+  window.addEventListener("message", handleMessage);
+  return {
+    cleanup: () => {
+      window.removeEventListener("message", handleMessage);
+      if (previewCleanupFn) {
+        previewCleanupFn();
+        previewCleanupFn = null;
+      }
+      recordingParams.clear();
+    },
+    recording: {
+      push: pushSchema
+    }
+  };
+}
+
+// src/vue.ts
+function useSchemaElementEditor(config) {
+  const { getSchema, updateSchema, renderPreview, sourceConfig, messageTypes, enabled } = config;
+  let bridge = null;
+  const destroyBridge = () => {
+    if (bridge) {
+      bridge.cleanup();
+      bridge = null;
+    }
+  };
+  const createBridgeInstance = () => {
+    destroyBridge();
+    if ((0, import_vue.toValue)(enabled) === false) {
+      return;
+    }
+    const proxyConfig = {
+      getSchema: (params) => (0, import_vue.toValue)(getSchema)(params),
+      updateSchema: (schema, params) => (0, import_vue.toValue)(updateSchema)(schema, params),
+      renderPreview: (0, import_vue.toValue)(renderPreview) ? (schema, containerId) => (0, import_vue.toValue)(renderPreview)?.(schema, containerId) : void 0,
+      sourceConfig,
+      messageTypes
+    };
+    bridge = createSchemaElementEditorBridge(proxyConfig);
+  };
+  (0, import_vue.onMounted)(() => {
+    createBridgeInstance();
+  });
+  (0, import_vue.onUnmounted)(() => {
+    destroyBridge();
+  });
+  (0, import_vue.watch)(
+    () => [
+      (0, import_vue.toValue)(enabled),
+      sourceConfig?.contentSource,
+      sourceConfig?.hostSource,
+      messageTypes?.getSchema,
+      messageTypes?.updateSchema,
+      messageTypes?.checkPreview,
+      messageTypes?.renderPreview,
+      messageTypes?.cleanupPreview,
+      messageTypes?.startRecording,
+      messageTypes?.stopRecording,
+      messageTypes?.schemaPush
+    ],
+    () => {
+      createBridgeInstance();
+    },
+    { deep: true }
+  );
+  const recording = {
+    push: (params, data) => {
+      bridge?.recording.push(params, data);
+    }
+  };
+  return { recording };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  useSchemaElementEditor
+});

package/dist/vue.d.cts

@@ -0,0 +1,73 @@
+import { MaybeRefOrGetter } from 'vue';
+import { SchemaValue, PostMessageSourceConfig, PostMessageTypeConfig, SchemaElementEditorRecording } from './core.cjs';
+export { SchemaElementEditorBridge, SchemaElementEditorConfig } from './core.cjs';
+
+/**
+ * Schema Element Editor Host SDK - Vue
+ * Vue 3 Composition API 包装
+ */
+
+/**
+ * Vue 版本的 Schema Element Editor 配置
+ * 支持响应式值（ref/reactive/getter）
+ */
+interface VueSchemaElementEditorConfig {
+    /**
+     * 获取 Schema 数据
+     */
+    getSchema: MaybeRefOrGetter<(params: string) => SchemaValue>;
+    /**
+     * 更新 Schema 数据
+     */
+    updateSchema: MaybeRefOrGetter<(schema: SchemaValue, params: string) => boolean>;
+    /**
+     * 渲染预览（可选）
+     */
+    renderPreview?: MaybeRefOrGetter<((schema: SchemaValue, containerId: string) => (() => void) | void) | undefined>;
+    /**
+     * 是否启用桥接（默认 true）
+     * 设为 false 时不创建桥接器，不监听消息
+     * 支持响应式值
+     */
+    enabled?: MaybeRefOrGetter<boolean>;
+    /** 消息标识配置（可选，有默认值） */
+    sourceConfig?: Partial<PostMessageSourceConfig>;
+    /** 消息类型配置（可选，有默认值） */
+    messageTypes?: Partial<PostMessageTypeConfig>;
+}
+/** Vue composable 返回值 */
+interface UseSchemaElementEditorReturn {
+    /** 录制相关方法 */
+    recording: SchemaElementEditorRecording;
+}
+/**
+ * Schema Element Editor 插件接入 composable（Vue 3）
+ * 用于在宿主页面接入 Schema Element Editor 插件，通过 postMessage 接收插件请求并返回响应
+ *
+ * @param config - Schema Element Editor 配置（支持响应式值）
+ * @returns 桥接器方法，包含 pushSchema
+ *
+ * @example
+ * ```vue
+ * <script setup>
+ * import { useSchemaElementEditor } from '@schema-element-editor/host-sdk/vue'
+ * import { ref } from 'vue'
+ *
+ * const dataStore = ref({})
+ *
+ * const { pushSchema } = useSchemaElementEditor({
+ *   getSchema: (params) => dataStore.value[params],
+ *   updateSchema: (schema, params) => {
+ *     dataStore.value[params] = schema
+ *     return true
+ *   },
+ * })
+ *
+ * // 数据变化时调用 pushSchema 推送数据（录制功能自动可用）
+ * sseHandler.onData = (params, data) => pushSchema(params, data)
+ * </script>
+ * ```
+ */
+declare function useSchemaElementEditor(config: VueSchemaElementEditorConfig): UseSchemaElementEditorReturn;
+
+export { PostMessageSourceConfig, PostMessageTypeConfig, SchemaElementEditorRecording, SchemaValue, type UseSchemaElementEditorReturn, type VueSchemaElementEditorConfig, useSchemaElementEditor };

package/dist/vue.d.ts

@@ -0,0 +1,73 @@
+import { MaybeRefOrGetter } from 'vue';
+import { SchemaValue, PostMessageSourceConfig, PostMessageTypeConfig, SchemaElementEditorRecording } from './core.js';
+export { SchemaElementEditorBridge, SchemaElementEditorConfig } from './core.js';
+
+/**
+ * Schema Element Editor Host SDK - Vue
+ * Vue 3 Composition API 包装
+ */
+
+/**
+ * Vue 版本的 Schema Element Editor 配置
+ * 支持响应式值（ref/reactive/getter）
+ */
+interface VueSchemaElementEditorConfig {
+    /**
+     * 获取 Schema 数据
+     */
+    getSchema: MaybeRefOrGetter<(params: string) => SchemaValue>;
+    /**
+     * 更新 Schema 数据
+     */
+    updateSchema: MaybeRefOrGetter<(schema: SchemaValue, params: string) => boolean>;
+    /**
+     * 渲染预览（可选）
+     */
+    renderPreview?: MaybeRefOrGetter<((schema: SchemaValue, containerId: string) => (() => void) | void) | undefined>;
+    /**
+     * 是否启用桥接（默认 true）
+     * 设为 false 时不创建桥接器，不监听消息
+     * 支持响应式值
+     */
+    enabled?: MaybeRefOrGetter<boolean>;
+    /** 消息标识配置（可选，有默认值） */
+    sourceConfig?: Partial<PostMessageSourceConfig>;
+    /** 消息类型配置（可选，有默认值） */
+    messageTypes?: Partial<PostMessageTypeConfig>;
+}
+/** Vue composable 返回值 */
+interface UseSchemaElementEditorReturn {
+    /** 录制相关方法 */
+    recording: SchemaElementEditorRecording;
+}
+/**
+ * Schema Element Editor 插件接入 composable（Vue 3）
+ * 用于在宿主页面接入 Schema Element Editor 插件，通过 postMessage 接收插件请求并返回响应
+ *
+ * @param config - Schema Element Editor 配置（支持响应式值）
+ * @returns 桥接器方法，包含 pushSchema
+ *
+ * @example
+ * ```vue
+ * <script setup>
+ * import { useSchemaElementEditor } from '@schema-element-editor/host-sdk/vue'
+ * import { ref } from 'vue'
+ *
+ * const dataStore = ref({})
+ *
+ * const { pushSchema } = useSchemaElementEditor({
+ *   getSchema: (params) => dataStore.value[params],
+ *   updateSchema: (schema, params) => {
+ *     dataStore.value[params] = schema
+ *     return true
+ *   },
+ * })
+ *
+ * // 数据变化时调用 pushSchema 推送数据（录制功能自动可用）
+ * sseHandler.onData = (params, data) => pushSchema(params, data)
+ * </script>
+ * ```
+ */
+declare function useSchemaElementEditor(config: VueSchemaElementEditorConfig): UseSchemaElementEditorReturn;
+
+export { PostMessageSourceConfig, PostMessageTypeConfig, SchemaElementEditorRecording, SchemaValue, type UseSchemaElementEditorReturn, type VueSchemaElementEditorConfig, useSchemaElementEditor };

package/dist/vue.js

@@ -0,0 +1,64 @@
+import {
+  createSchemaElementEditorBridge
+} from "./chunk-KMNKOOWF.js";
+
+// src/vue.ts
+import { onMounted, onUnmounted, watch, toValue } from "vue";
+function useSchemaElementEditor(config) {
+  const { getSchema, updateSchema, renderPreview, sourceConfig, messageTypes, enabled } = config;
+  let bridge = null;
+  const destroyBridge = () => {
+    if (bridge) {
+      bridge.cleanup();
+      bridge = null;
+    }
+  };
+  const createBridgeInstance = () => {
+    destroyBridge();
+    if (toValue(enabled) === false) {
+      return;
+    }
+    const proxyConfig = {
+      getSchema: (params) => toValue(getSchema)(params),
+      updateSchema: (schema, params) => toValue(updateSchema)(schema, params),
+      renderPreview: toValue(renderPreview) ? (schema, containerId) => toValue(renderPreview)?.(schema, containerId) : void 0,
+      sourceConfig,
+      messageTypes
+    };
+    bridge = createSchemaElementEditorBridge(proxyConfig);
+  };
+  onMounted(() => {
+    createBridgeInstance();
+  });
+  onUnmounted(() => {
+    destroyBridge();
+  });
+  watch(
+    () => [
+      toValue(enabled),
+      sourceConfig?.contentSource,
+      sourceConfig?.hostSource,
+      messageTypes?.getSchema,
+      messageTypes?.updateSchema,
+      messageTypes?.checkPreview,
+      messageTypes?.renderPreview,
+      messageTypes?.cleanupPreview,
+      messageTypes?.startRecording,
+      messageTypes?.stopRecording,
+      messageTypes?.schemaPush
+    ],
+    () => {
+      createBridgeInstance();
+    },
+    { deep: true }
+  );
+  const recording = {
+    push: (params, data) => {
+      bridge?.recording.push(params, data);
+    }
+  };
+  return { recording };
+}
+export {
+  useSchemaElementEditor
+};

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@schema-element-editor/host-sdk",
+  "version": "2.0.0",
+  "description": "Schema Element Editor (SEE) 插件宿主接入 SDK，支持 React/Vue/纯 JS",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./core": {
+      "types": "./dist/core.d.ts",
+      "import": "./dist/core.js",
+      "require": "./dist/core.cjs"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "import": "./dist/react.js",
+      "require": "./dist/react.cjs"
+    },
+    "./vue": {
+      "types": "./dist/vue.d.ts",
+      "import": "./dist/vue.js",
+      "require": "./dist/vue.cjs"
+    }
+  },
+  "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": "npm run build"
+  },
+  "peerDependencies": {
+    "react": ">=17.0.0",
+    "vue": ">=3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "vue": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0",
+    "vue": "^3.4.0"
+  },
+  "keywords": [
+    "schema-element-editor",
+    "react",
+    "vue",
+    "hooks",
+    "composable",
+    "postMessage"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hei-f/schema-element-editor.git",
+    "directory": "packages/schema-element-editor-sdk"
+  }
+}