@heartlandone/vega 2.89.0 → 2.90.0

package/dist/cjs/link-extension-dafeeed0.js

@@ -0,0 +1,583 @@
+'use strict';
+
+const codeBlock = require('./code-block-89850671.js');
+const contentState = require('./content-state-e1c3efe6.js');
+const typeGuard = require('./type-guard-9917b11f.js');
+require('./global-slimmer-registry-b3bce7e0.js');
+
+/**
+ * RTEDTORendererManager is a singleton class that manages the registration and retrieval of RTE DTO renderers.
+ */
+class RTEDTORendererManager {
+  constructor() {
+    // Register RTE DTO renderers, mapping type strings to their respective renderer instances.
+    this.RTE_DTO_RENDERER_MAP = new Map();
+    // Register RTE Toolbar Button Renderers, mapping type strings to their respective renderer instances.
+    this.RTE_TOOLBAR_BUTTON_RENDERER_MAP = new Map();
+    /**
+     * Per-host toolbar button renderer map.
+     * Stores a host-specific renderer map so that extensions that register during
+     * {@link VegaRTEExtension#prepareBeforeLoad} can provide isolated renderer instances
+     * for each {@link HTMLVegaRichTextEditorElement}.  At render time this map is checked
+     * first; the global singleton map is used as a fallback.
+     */
+    this.hostToolbarButtonRendererMap = new WeakMap();
+  }
+  /**
+   * Registers a new RTE DTO renderer.
+   *
+   * @param {string} type - The type identifier for the RTE DTO renderer.
+   * @param {VegaRTEBaseRenderer} RTEDTORenderer - The renderer instance for the RTE DTO.
+   */
+  registerRTEDTORenderer(type, RTEDTORenderer) {
+    const existRenderer = this.RTE_DTO_RENDERER_MAP.get(type);
+    if (RTEDTORenderer &&
+      existRenderer &&
+      existRenderer.constructor.name !== RTEDTORenderer.constructor.name) {
+      throw new Error(`Renderer for type ${type} is already registered with a different class(${existRenderer.constructor.name}).`);
+    }
+    this.RTE_DTO_RENDERER_MAP.set(type, RTEDTORenderer);
+  }
+  /**
+   * Registers a new RTE Toolbar Button Renderer.
+   *
+   * @param {string} type - The type identifier for the RTE Toolbar Button Renderer.
+   * @param {VegaRTEToolbarButtonRenderer} RTEToolbarButtonRenderer - The renderer instance for the RTE Toolbar Button.
+   */
+  registerRTEToolbarButtonRenderer(type, RTEToolbarButtonRenderer) {
+    this.RTE_TOOLBAR_BUTTON_RENDERER_MAP.set(type, RTEToolbarButtonRenderer);
+  }
+  /**
+   * Registers a host-specific toolbar button renderer.
+   * The per-host renderer takes precedence over the global singleton when the host
+   * element is passed to {@link getRTEToolbarButtonRenderer}.
+   *
+   * @typedef HTMLVegaRichTextEditorElement - The rich text editor host element type.
+   * @param {HTMLVegaRichTextEditorElement} host - The rich text editor host element.
+   * @param {string} type - The type identifier for the toolbar button renderer.
+   * @param {VegaRTEToolbarButtonRenderer} renderer - The renderer instance to register for this host.
+   */
+  registerRTEToolbarButtonRendererForHost(host, type, renderer) {
+    let hostMap = this.hostToolbarButtonRendererMap.get(host);
+    if (!hostMap) {
+      hostMap = new Map();
+      this.hostToolbarButtonRendererMap.set(host, hostMap);
+    }
+    hostMap.set(type, renderer);
+  }
+  /**
+   * Retrieves the RTE renderer for a given type.
+   *
+   * @param {string} type - The type identifier for the RTE block.
+   * @returns {Nullable<BaseRenderer>} - The renderer instance for the RTE block, or null if not found.
+   */
+  getRTERenderer(type) {
+    return this.RTE_DTO_RENDERER_MAP.get(type);
+  }
+  /**
+   * Retrieves the RTE Toolbar Button Renderer for a given type.
+   * When a host element is provided the per-host map registered via
+   * {@link registerRTEToolbarButtonRendererForHost} is checked first; the global
+   * singleton map is used as a fallback so that extensions that do not override
+   * {@link VegaRTEExtension#prepareBeforeLoad} continue to work unchanged.
+   *
+   * @typedef HTMLVegaRichTextEditorElement - The rich text editor host element type.
+   * @param {string} type - The type identifier for the RTE Toolbar Button Renderer.
+   * @param {HTMLVegaRichTextEditorElement} [host] - Optional host element for per-host lookup.
+   * @returns {Nullable<VegaRTEToolbarButtonRenderer>} - The renderer instance for the RTE Toolbar Button, or null if not found.
+   */
+  getRTEToolbarButtonRenderer(type, host) {
+    var _a, _b;
+    if (host) {
+      const hostRenderer = (_a = this.hostToolbarButtonRendererMap
+        .get(host)) === null || _a === void 0 ? void 0 : _a.get(type);
+      if (hostRenderer) {
+        return hostRenderer;
+      }
+    }
+    return (_b = this.RTE_TOOLBAR_BUTTON_RENDERER_MAP.get(type)) !== null && _b !== void 0 ? _b : null;
+  }
+}
+const RTEDTORendererManager$1 = new RTEDTORendererManager();
+
+/**
+ * Manager for storing and retrieving the extension context associated with each rich text editor host element.
+ *
+ * @todo Currently, there are three types of contexts in RTE: toolbar render context, extension context, and DTO render context. The second and third types are bound to the extension context via host props. We are considering optimizing these three types of contexts to make the program more flexible and easier to maintain.
+ */
+class RTEExtensionContextManager {
+  constructor() {
+    this.extensionContextMap = new WeakMap();
+  }
+  /**
+   * Store the extension context for the given rich text editor host element.
+   *
+   * @param {RTEExtensionContext} context - The extension context to store.
+   */
+  updateExtensionContext(context) {
+    if (context && context.host) {
+      let newContext = context;
+      const existingContext = this.extensionContextMap.get(context.host);
+      // If there is already an existing context for the host, merge the new context with the existing one to avoid overwriting any properties that are not included in the new context.
+      if (existingContext) {
+        newContext = Object.assign(Object.assign({}, existingContext), context);
+      }
+      this.extensionContextMap.set(context.host, newContext);
+    }
+  }
+  /**
+   * Get the extension context for the given rich text editor host element.
+   *
+   * @typedef HTMLVegaRichTextEditorElement - The type definition for the rich text editor host element.
+   * @param {Nullable<HTMLVegaRichTextEditorElement>} el - The host rich text editor element.
+   * @returns {Nullable<RTEExtensionContext>} - The extension context associated with the host.
+   */
+  getExtensionContext(el) {
+    return el ? this.extensionContextMap.get(el) : null;
+  }
+}
+const RTEExtensionContextManager$1 = new RTEExtensionContextManager();
+
+/**
+ * Base renderer class for the rich text editor.
+ */
+class VegaRTEBaseRenderer {
+}
+
+/**
+ * Base renderer for Vega Rich Text Editor.
+ */
+class VegaRTEExtensionRenderer extends VegaRTEBaseRenderer {
+  /**
+   * Returns the styles to be injected into the RTE scope.
+   * Override this method to provide custom styles for the custom blocks or nodes.
+   *
+   * @returns {string} - The styles as a string.
+   */
+  injectRTEScopeStyles() {
+    return '';
+  }
+  /**
+   * Renders the given data as a DOM element.
+   *
+   * @param {RTEBlock | RTENode} renderData - The data to render, which can be a block or a node.
+   * @param {RTERenderContext} rteContext - The rte editor context.
+   * @param {VegaRTECreateElementFunction} createElement - The function to create a DOM element.
+   * @returns {VegaRTERenderResult} - The rendered DOM element.
+   */
+  render(renderData, rteContext, createElement) {
+    var _a;
+    const element = this.doRender(createElement, renderData, rteContext);
+    this.fallbackRegisterRef(element, renderData);
+    this.appendChildren(((_a = element.childrenContainerGetter) === null || _a === void 0 ? void 0 : _a.call(element)) || element, renderData, rteContext, createElement);
+    return element;
+  }
+  /**
+   * Register the reference of the element in the rendering registry.
+   *
+   * @param {RTEBlock | RTENode} renderData - The data to register with the element.
+   * @returns {VegaRTEUseRef} - The function to register the element.
+   */
+  useRef(renderData) {
+    renderData[VegaRTEExtensionRenderer.REGISTER_REF_FLAG] = true;
+    return function (element) {
+      if (element) {
+        codeBlock.stateEntityRenderingRegistry.register(element, renderData);
+      }
+    };
+  }
+  /**
+   * Get a registered renderer by its key.
+   *
+   * @param {string} key - The key of the renderer.
+   * @returns {Nullable<BaseRenderer>} - The registered renderer or null if not found.
+   */
+  getDTORenderer(key) {
+    return RTEDTORendererManager$1.getRTERenderer(key);
+  }
+  /**
+   * Get the extension context for the given rich text editor host element.
+   *
+   * @typedef HTMLVegaRichTextEditorElement - The type definition for the rich text editor host element.
+   * @param {HTMLVegaRichTextEditorElement} el - The host rich text editor element.
+   * @returns {Nullable<RTEExtensionContext>} - The extension context associated with the host.
+   */
+  getExtensionContext(el) {
+    return RTEExtensionContextManager$1.getExtensionContext(el);
+  }
+  /**
+   * Auto render the block children if the block element is not exist
+   *
+   * @param {VegaRTERenderResult} parentElement - The parent element to append children to.
+   * @param {RTEBlock | RTENode} renderData - The data to render children for.
+   * @param {RTERenderContext} rteContext - The render context.
+   * @param {VegaRTECreateElementFunction} createElement - The function to create a DOM element.
+   */
+  appendChildren(parentElement, renderData, rteContext, createElement) {
+    if (Array.isArray(renderData['children']) &&
+      renderData['children'].length &&
+      !parentElement['$children$']) {
+      parentElement['$children$'] = renderData['children']
+        .map((child) => {
+        return this.renderChildren(child, rteContext, createElement);
+      })
+        .filter(typeGuard.isNonNullable);
+    }
+  }
+  /**
+   * Render the children node.
+   *
+   * @param {RTENode | RTEBlock} renderData - The node to render children for.
+   * @param {RTERenderContext} rteContext - The render context.
+   * @param {VegaRTECreateElementFunction} createElement - The function to create a DOM element.
+   * @returns {Nullable<VegaRTERenderResult>} - The rendered DOM element.
+   */
+  renderChildren(renderData, rteContext, createElement) {
+    const renderer = this.getDTORenderer(renderData.type);
+    if (renderer) {
+      return renderer.render(renderData, rteContext, createElement);
+    }
+  }
+  /**
+   * Fallback register reference for the element.
+   *
+   * @param {VegaRTERenderResult} element - The rendered DOM element.
+   * @param {RTEBlock | RTENode} renderData - The data to register with the element.
+   */
+  fallbackRegisterRef(element, renderData) {
+    if (!renderData[VegaRTEExtensionRenderer.REGISTER_REF_FLAG] &&
+      element['$attrs$'] &&
+      !element['$attrs$']['ref']) {
+      // eslint-disable-next-line jsdoc/require-jsdoc
+      element['$attrs$']['ref'] = this.useRef(renderData);
+    }
+  }
+}
+VegaRTEExtensionRenderer.REGISTER_REF_FLAG = '__registeredRef__';
+
+/**
+ * Generic per-host state store using WeakMap keyed by HTMLVegaRichTextEditorElement.
+ * Create via {@link VegaRTEExtension.createStateStore} and declare as `static readonly` on your extension class.
+ *
+ * @template T - The type of the state value to store per host.
+ */
+class RTEExtensionStateStore {
+  constructor() {
+    this.stateMap = new WeakMap();
+  }
+  /**
+   * Store a value for the given host.
+   *
+   * @param {HTMLElement} host - The editor host.
+   * @param {T} value - The value to store.
+   */
+  set(host, value) {
+    this.stateMap.set(host, value);
+  }
+  /**
+   * Retrieve the stored value for the given host.
+   *
+   * @param {Nullable<HTMLElement>} host - The editor host.
+   * @returns {Nullable<T>} The stored value, or null if not found.
+   */
+  get(host) {
+    return host ? this.stateMap.get(host) : null;
+  }
+  /**
+   * Remove the stored value for the given host.
+   *
+   * @param {HTMLElement} host - The editor host.
+   */
+  delete(host) {
+    this.stateMap.delete(host);
+  }
+}
+
+const patchedBlockClasses = new WeakSet();
+const annotationHandlersByClass = new WeakMap();
+/**
+ * Abstract class for Vega Rich Text Editor extensions.
+ */
+class VegaRTEExtension {
+  constructor() {
+    /**
+     * The context of the RTE extension, which may include references to the host editor and other relevant information.
+     */
+    this.extensionContext = null;
+    this.hasCustomStylesRenderers = new Set();
+  }
+  /**
+   * Registers an action handle strategy for a specific node or block class.
+   *
+   * @param {string} nodeOrBlockClassName - The name of the node or block class.
+   * @param {string} actionType - The type of the action.
+   * @param {ActionHandleStrategy<ModifyContentAction | AnnotationAction, RTENode | RTEBlock | VegaRTEContent>} strategy - The strategy to register.
+   */
+  static registerActionHandleStrategy(nodeOrBlockClassName, actionType, strategy) {
+    codeBlock.ActionHandleStrategyRegistry.register(actionType, nodeOrBlockClassName, strategy);
+  }
+  /**
+   * Registers an action handler interceptor for a specific node or block class.
+   *
+   * @param {string} nodeOrBlockClassName - The name of the node or block class.
+   * @param {string} actionType - The type of the action.
+   * @param {ActionHandlerInterceptor<ModifyContentAction, RTENode | RTEBlock | VegaRTEContent>} strategy - The interceptor to register.
+   */
+  static registerActionHandlerInterceptor(nodeOrBlockClassName, actionType, strategy) {
+    codeBlock.ActionHandlerInterceptorRegistry.register(actionType, nodeOrBlockClassName, strategy);
+  }
+  /**
+   * Registers a filter styles strategy for a specific block or node class.
+   *
+   * @param {string} blockOrNodeClassName - The name of the block or node class.
+   * @param {RTEFilterStylesStrategy} strategy - The filter styles strategy to register.
+   */
+  static registerFilterStylesStrategy(blockOrNodeClassName, strategy) {
+    codeBlock.RTEFilterStylesStrategyRegistry.register(blockOrNodeClassName, strategy);
+  }
+  /**
+   * Attach a custom JSON annotation handler to a block DTO class's static `from` flow.
+   *
+   * This is a reusable extension point: any extension can register a handler for an
+   * annotation key and transform the value into block annotations during JSON parsing.
+   *
+   * Safe to call multiple times per class/key/handler — duplicate registrations are no-ops.
+   *
+   * @param {BlockClassWithFrom} BlockClass - Block DTO class to patch.
+   * @param {string} annotationKey - JSON annotation key to read from `block.annotations`.
+   * @param {AnnotationFromJsonHandler} handler - Handler that applies annotation logic to the instance.
+   */
+  static attachAnnotationFromJson(BlockClass, annotationKey, handler) {
+    var _a, _b;
+    const handlerMap = (_a = annotationHandlersByClass.get(BlockClass)) !== null && _a !== void 0 ? _a : new Map();
+    const handlers = (_b = handlerMap.get(annotationKey)) !== null && _b !== void 0 ? _b : new Set();
+    handlers.add(handler);
+    handlerMap.set(annotationKey, handlers);
+    annotationHandlersByClass.set(BlockClass, handlerMap);
+    if (patchedBlockClasses.has(BlockClass)) {
+      return;
+    }
+    patchedBlockClasses.add(BlockClass);
+    const originalFrom = BlockClass.from.bind(BlockClass);
+    /**
+     * Wrapped static `from` that preserves original behavior and then applies
+     * all registered annotation-from-json handlers for this BlockClass.
+     *
+     * @param {VegaRTEBlockBase} block - Raw JSON block payload.
+     * @param {VegaRTETransformOptions} [options] - Optional transform options.
+     * @returns {RTEBlock} The transformed block instance.
+     */
+    BlockClass.from = function patchedFrom(block, options) {
+      const instance = originalFrom(block, options);
+      const annotations = block.annotations;
+      const currentHandlerMap = annotationHandlersByClass.get(BlockClass);
+      if (annotations && currentHandlerMap) {
+        currentHandlerMap.forEach((registeredHandlers, key) => {
+          const value = annotations[key];
+          registeredHandlers.forEach((registeredHandler) => {
+            registeredHandler(instance, value, block, options);
+          });
+        });
+      }
+      return instance;
+    };
+  }
+  /**
+   * Create a per-host state store for this extension.
+   * Declare as `static readonly` to share store across extension instances while isolating state per RTE host.
+   *
+   * @template T - The type of the state value to store per host.
+   * @returns {RTEExtensionStateStore<T>} A new state store instance.
+   */
+  static createStateStore() {
+    return new RTEExtensionStateStore();
+  }
+  /**
+   * Lifecycle hook called by the rich text editor before the first render
+   * (during `componentWillLoad`).  Override this method to perform per-host
+   * pre-render setup — for example, registering a host-specific toolbar button
+   * renderer via {@link registerToolbarButtonRenderer} so that each editor on
+   * the page gets its own isolated renderer instance.
+   *
+   * The default implementation is a no-op; subclasses may override selectively.
+   *
+   * @typedef HTMLVegaRichTextEditorElement - The type of the host rich text editor element.
+   * @param {HTMLVegaRichTextEditorElement} host - The host rich text editor element that is about to load.
+   */
+  prepareBeforeLoad(host) {
+  }
+  /**
+   * Initializes the RTE extension with the provided context.
+   *
+   * @param {RTEExtensionContext} context - The context of the RTE extension.
+   */
+  initialExtensionAfterLoad(context) {
+    this.extensionContext = context;
+    RTEExtensionContextManager$1.updateExtensionContext(context);
+  }
+  /**
+   * Callback method invoked when the extension is destroyed.
+   * Override this method to perform any necessary cleanup.
+   */
+  destroyExtension() {
+  }
+  /**
+   * Collect custom styles for the extension renderers.
+   * If custom nodes have special styles, override this method to provide the styles.
+   *
+   * @returns {string} - The custom styles as a string.
+   */
+  collectExtensionRendererStyles() {
+    let styles = '';
+    if (this.hasCustomStylesRenderers.size > 0) {
+      this.hasCustomStylesRenderers.forEach((renderer) => {
+        styles += `${renderer.injectRTEScopeStyles()}\n`;
+      });
+    }
+    return styles;
+  }
+  /**
+   * Register a node type with the extension.
+   *
+   * @param {string} type - The type of the node or block. The type should be a string that uniquely identifies the node or block.
+   * @param {ClassType<RTEBlock | RTENode>} DTOClass - The DTO class to register.
+   */
+  registerNode(type, DTOClass) {
+    codeBlock.RTEDTOClassManager.registerRTEDTOClass(type, DTOClass);
+  }
+  /**
+   * Register a renderer for a node type with the extension.
+   *
+   * @param {string} type - The type of the node or block. The type should be a string that uniquely identifies the node or block.
+   * @param {BaseRenderer} renderer - The renderer to register.
+   */
+  registerRenderer(type, renderer) {
+    RTEDTORendererManager$1.registerRTEDTORenderer(type, renderer);
+    if (renderer instanceof VegaRTEExtensionRenderer && renderer.injectRTEScopeStyles()) {
+      this.hasCustomStylesRenderers.add(renderer);
+    }
+  }
+  /**
+   * Register a toolbar button renderer for the extension.
+   * When a `host` element is provided the renderer is registered in the per-host map
+   * (via {@link RTEDTORendererManager#registerRTEToolbarButtonRendererForHost}), giving
+   * that host an isolated renderer instance that takes precedence over the global singleton.
+   * Omit `host` to fall back to the global registration (backwards-compatible default).
+   *
+   * @param {string} type - The type of the toolbar button.
+   * @param {VegaRTEToolbarButtonRenderer} renderer - The renderer to register.
+   * @param {HTMLVegaRichTextEditorElement} [host] - Optional host element for per-host isolation.
+   */
+  registerToolbarButtonRenderer(type, renderer, host) {
+    if (host) {
+      RTEDTORendererManager$1.registerRTEToolbarButtonRendererForHost(host, type, renderer);
+    }
+    else {
+      RTEDTORendererManager$1.registerRTEToolbarButtonRenderer(type, renderer);
+    }
+  }
+  /**
+   * This is a helper method that utilizes RTEUtils to register common strategies.
+   * Call the method with the class name of the block to make it support basic strategies like:
+   * - Delete children
+   * - Append the children
+   * - Delete the block children content
+   *
+   * @param {string} blockClassName - The class name of the block to register strategies for.
+   */
+  registerBlockBasicStrategies(blockClassName) {
+    contentState.RTEDTOActionStrategyManager.registerBlockBasicStrategies(blockClassName);
+  }
+  /**
+   * Unregister a strategy for a specific action type and block class if not need.
+   *
+   * @param {string} actionType - The special action type or the action class name.
+   * @param {string} blockClassName - The class name of the block to unregister the strategy for.
+   */
+  unRegisterStrategy(actionType, blockClassName) {
+    codeBlock.ActionHandleStrategyRegistry.unregister(actionType, blockClassName);
+  }
+  /**
+   * Unregister a strategy for a specific action type and block class if not need.
+   *
+   * @param {string} actionType - The special action type or the action class name.
+   * @param {string} blockClassName - The class name of the block to unregister the strategy for.
+   * @param {ActionHandlerInterceptor<ModifyContentAction, RTENode | RTEBlock | VegaRTEContent>} strategy - The interceptor to unregister.
+   */
+  unRegisterInterceptor(actionType, blockClassName, strategy) {
+    codeBlock.ActionHandlerInterceptorRegistry.unregister(actionType, blockClassName, strategy);
+  }
+  /**
+   * Register an element to block DTO class strategy.
+   *
+   * @param {ElementToDTOStrategy} strategy - The strategy to register.
+   */
+  registerElementToBlockDTOClassStrategy(strategy) {
+    contentState.ElementToDTOClassStrategyManager.registerElementToBlockStrategy(strategy);
+  }
+  /**
+   * Register an element to node DTO class strategy.
+   *
+   * @param {ElementToDTOStrategy} strategy - The strategy to register.
+   */
+  registerElementToNodeDTOClassStrategy(strategy) {
+    contentState.ElementToDTOClassStrategyManager.registerElementToNodeStrategy(strategy);
+  }
+  /**
+   * Get the registered element to node DTO class strategies.
+   *
+   * @returns {ElementToDTOStrategy[]} - The registered element to node DTO class strategies.
+   */
+  getElementToNodeDTOClassStrategies() {
+    return contentState.ElementToDTOClassStrategyManager.getElementToNodeStrategies();
+  }
+  /**
+   * Register a custom annotation handler for HTML to DTO conversion.
+   *
+   * @param {AnnotationGeneratorStrategyAbstract} handler - The annotation handler to register.
+   */
+  registerAnnotationHandler(handler) {
+    contentState.htmlElementToAnnotationGenerator.registerHandler(handler);
+  }
+}
+
+/**
+ * Rich Text Editor extension that configures built-in link behavior.
+ */
+class VegaRTELinkExtension extends VegaRTEExtension {
+  constructor(config = {}) {
+    super();
+    this.config = config;
+  }
+  /**
+   * Store config per host so both toolbar-link and inline-link editors
+   * can consistently read the extension settings.
+   *
+   * @param {HTMLElement} host - The host rich text editor element.
+   */
+  prepareBeforeLoad(host) {
+    VegaRTELinkExtension.configStore.set(host, this.config);
+  }
+  /**
+   * Remove config for the current host when the extension is destroyed.
+   */
+  destroyExtension() {
+    var _a;
+    if ((_a = this.extensionContext) === null || _a === void 0 ? void 0 : _a.host) {
+      VegaRTELinkExtension.configStore.delete(this.extensionContext.host);
+    }
+  }
+}
+/**
+ * Per-host config store. Declare as static readonly to isolate config per editor host.
+ *
+ * @type {RTEExtensionStateStore<VegaRTELinkExtensionConfig>}
+ */
+VegaRTELinkExtension.configStore = VegaRTELinkExtension.createStateStore();
+
+exports.RTEDTORendererManager = RTEDTORendererManager$1;
+exports.RTEExtensionContextManager = RTEExtensionContextManager$1;
+exports.VegaRTEBaseRenderer = VegaRTEBaseRenderer;
+exports.VegaRTEExtension = VegaRTEExtension;
+exports.VegaRTEExtensionRenderer = VegaRTEExtensionRenderer;
+exports.VegaRTELinkExtension = VegaRTELinkExtension;