@schema-element-editor/host-sdk 2.0.2 → 2.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+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.

package/dist/chunk-3OZ7E3LK.js

@@ -0,0 +1,391 @@
+// src/constants.ts
+var DEFAULT_SOURCE_CONFIG = {
+  contentSource: "schema-element-editor-content",
+  hostSource: "schema-element-editor-host"
+};
+var SDK_COORDINATOR_SOURCE = "schema-element-editor-sdk-coordinator";
+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"
+};
+var SDK_COORDINATION_MESSAGE_TYPES = {
+  register: "SDK_REGISTER",
+  unregister: "SDK_UNREGISTER",
+  query: "SDK_QUERY"
+};
+
+// src/coordinator.ts
+var SdkCoordinator = class {
+  constructor(config) {
+    /**
+     * SDK 销毁标志
+     *
+     * 作用：防止在 cleanup() 执行期间，监听器移除前仍然响应请求
+     *
+     * 场景：cleanup() 中先调用 destroy()（设置 isDestroyed = true），
+     * 然后才移除 handleMessage 监听器。在这个微小的时间窗口内，
+     * 如果插件请求到达，没有 isDestroyed 检查会导致已销毁的 SDK 仍然响应。
+     */
+    this.isDestroyed = false;
+    /**
+     * 存储比当前 SDK 优先级更高的其他 SDK ID
+     * 按方法分类：如果某个方法的集合不为空，说明有更高优先级的 SDK 应该处理该方法
+     *
+     * 优化：只为当前 SDK 实现了的方法维护优先级集合
+     */
+    this.higherLevelSdks = {};
+    /**
+     * 处理 SDK 协调消息
+     */
+    this.handleCoordinationMessage = (event) => {
+      const isFromSelf = event.source === window;
+      const isFromParent = window !== window.top && event.source === window.parent;
+      if (!isFromSelf && !isFromParent) return;
+      const data = event.data;
+      if (!data || data.source !== SDK_COORDINATOR_SOURCE) return;
+      switch (data.type) {
+        case SDK_COORDINATION_MESSAGE_TYPES.query:
+          this.sendRegister();
+          break;
+        case SDK_COORDINATION_MESSAGE_TYPES.register:
+          this.handleSdkRegister(data.payload);
+          break;
+        case SDK_COORDINATION_MESSAGE_TYPES.unregister:
+          this.handleSdkUnregister(data.payload.sdkId);
+          break;
+      }
+    };
+    this.sdkId = config.sdkId || `sdk-${Date.now()}-${Math.random().toString(36).slice(2, 11)}`;
+    this.messageSource = config.messageSource;
+    this.level = config.level ?? 0;
+    this.methodLevels = config.methodLevels ?? {};
+    this.implementedMethods = config.implementedMethods;
+    this.implementedMethods.forEach((method) => {
+      this.higherLevelSdks[method] = /* @__PURE__ */ new Set();
+    });
+  }
+  /**
+   * 初始化协调器
+   */
+  init() {
+    window.addEventListener("message", this.handleCoordinationMessage);
+    this.sendQuery();
+    this.sendRegister();
+  }
+  /**
+   * 销毁协调器
+   */
+  destroy() {
+    this.isDestroyed = true;
+    this.sendUnregister();
+    window.removeEventListener("message", this.handleCoordinationMessage);
+    Object.values(this.higherLevelSdks).forEach((set) => set.clear());
+  }
+  /**
+   * 判断是否应该响应某个方法的请求
+   * @param method - 方法名
+   * @returns 是否应该响应
+   */
+  shouldRespond(method) {
+    if (this.isDestroyed) return false;
+    if (!this.implementedMethods.includes(method)) {
+      return false;
+    }
+    const higherSdks = this.higherLevelSdks[method];
+    return !higherSdks || higherSdks.size === 0;
+  }
+  /**
+   * 获取方法的优先级
+   */
+  getMethodLevel(method) {
+    return this.methodLevels[method] ?? this.level;
+  }
+  /**
+   * 处理其他 SDK 的注册
+   */
+  handleSdkRegister(info) {
+    if (info.sdkId === this.sdkId) return;
+    if (info.messageSource !== this.messageSource) return;
+    this.implementedMethods.forEach((method) => {
+      if (!info.implementedMethods.includes(method)) {
+        return;
+      }
+      const myLevel = this.getMethodLevel(method);
+      const otherLevel = info.methodLevels[method] ?? info.level;
+      if (otherLevel > myLevel) {
+        this.higherLevelSdks[method].add(info.sdkId);
+      } else {
+        this.higherLevelSdks[method].delete(info.sdkId);
+      }
+    });
+  }
+  /**
+   * 处理其他 SDK 的注销
+   */
+  handleSdkUnregister(sdkId) {
+    Object.values(this.higherLevelSdks).forEach((set) => {
+      set.delete(sdkId);
+    });
+  }
+  /**
+   * 发送查询消息
+   */
+  sendQuery() {
+    const message = {
+      source: SDK_COORDINATOR_SOURCE,
+      type: SDK_COORDINATION_MESSAGE_TYPES.query,
+      payload: { sdkId: this.sdkId }
+    };
+    this.postCoordinationMessage(message);
+  }
+  /**
+   * 发送注册消息
+   */
+  sendRegister() {
+    const message = {
+      source: SDK_COORDINATOR_SOURCE,
+      type: SDK_COORDINATION_MESSAGE_TYPES.register,
+      payload: {
+        sdkId: this.sdkId,
+        messageSource: this.messageSource,
+        level: this.level,
+        methodLevels: this.methodLevels,
+        implementedMethods: this.implementedMethods
+      }
+    };
+    this.postCoordinationMessage(message);
+  }
+  /**
+   * 发送注销消息
+   */
+  sendUnregister() {
+    const message = {
+      source: SDK_COORDINATOR_SOURCE,
+      type: SDK_COORDINATION_MESSAGE_TYPES.unregister,
+      payload: { sdkId: this.sdkId }
+    };
+    this.postCoordinationMessage(message);
+  }
+  /**
+   * 发送协调消息
+   */
+  postCoordinationMessage(message) {
+    window.postMessage(message, "*");
+    if (window.top && window.top !== window) {
+      window.top.postMessage(message, "*");
+    }
+  }
+};
+
+// src/core.ts
+function createSchemaElementEditorBridge(config) {
+  const {
+    getSchema,
+    updateSchema,
+    renderPreview,
+    sourceConfig,
+    messageTypes,
+    sdkId,
+    level,
+    methodLevels
+  } = config;
+  const mergedSourceConfig = {
+    ...DEFAULT_SOURCE_CONFIG,
+    ...sourceConfig
+  };
+  const mergedMessageTypes = {
+    ...DEFAULT_MESSAGE_TYPES,
+    ...messageTypes
+  };
+  const implementedMethods = [];
+  if (typeof getSchema === "function") implementedMethods.push("getSchema");
+  if (typeof updateSchema === "function") implementedMethods.push("updateSchema");
+  if (typeof renderPreview === "function") {
+    implementedMethods.push("checkPreview", "renderPreview", "cleanupPreview");
+  }
+  implementedMethods.push("startRecording", "stopRecording");
+  const coordinator = new SdkCoordinator({
+    sdkId,
+    messageSource: mergedSourceConfig.contentSource,
+    level,
+    methodLevels,
+    implementedMethods
+  });
+  coordinator.init();
+  let previewCleanupFn = null;
+  const recordingParams = /* @__PURE__ */ new Set();
+  const currentConfig = { getSchema, updateSchema, renderPreview };
+  const createMethodTypeMap = () => ({
+    [mergedMessageTypes.getSchema]: "getSchema",
+    [mergedMessageTypes.updateSchema]: "updateSchema",
+    [mergedMessageTypes.checkPreview]: "checkPreview",
+    [mergedMessageTypes.renderPreview]: "renderPreview",
+    [mergedMessageTypes.cleanupPreview]: "cleanupPreview",
+    [mergedMessageTypes.startRecording]: "startRecording",
+    [mergedMessageTypes.stopRecording]: "stopRecording"
+  });
+  const methodTypeToName = createMethodTypeMap();
+  const getMethodNameByType = (type) => {
+    return methodTypeToName[type] ?? null;
+  };
+  const sendResponse = (requestId, result) => {
+    const message = {
+      source: mergedSourceConfig.hostSource,
+      requestId,
+      ...result
+    };
+    const targetWindow = window.top ?? 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 targetWindow = window.top ?? 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 methodName = getMethodNameByType(type);
+    if (!methodName) return;
+    if (!coordinator.shouldRespond(methodName)) {
+      return;
+    }
+    const { getSchema: getSchema2, updateSchema: updateSchema2, renderPreview: renderPreview2 } = currentConfig;
+    let result;
+    switch (type) {
+      case mergedMessageTypes.getSchema: {
+        if (typeof getSchema2 !== "function") {
+          return;
+        }
+        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: {
+        if (typeof updateSchema2 !== "function") {
+          return;
+        }
+        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: () => {
+      coordinator.destroy();
+      window.removeEventListener("message", handleMessage);
+      if (previewCleanupFn) {
+        previewCleanupFn();
+        previewCleanupFn = null;
+      }
+      recordingParams.clear();
+    },
+    recording: {
+      push: pushSchema
+    }
+  };
+}
+
+export {
+  createSchemaElementEditorBridge
+};