@emailmaker/extensions-app 0.9.0-dev.1

package/types.d.ts

@@ -0,0 +1,542 @@
+import { IPluginConstructor, Instance, PluginRegistry } from '@emailmaker/emailmaker';
+
+interface IDisposable {
+  dispose(): void;
+}
+/**
+ * Unique identifier for a UI component.
+ * @template P The type of the component's props
+ */
+type ComponentId$1<P = void> = string & {
+  propsType?: P;
+};
+/**
+ * Represents a component type with its props.
+ */
+type ComponentType$1<Props> = {
+  type: ComponentId$1<Props>;
+  props: Props;
+};
+/**
+ * Extensible registry of component inputs accepted by core extension APIs.
+ * React-specific variants are added by the React adapter package.
+ */
+interface ComponentInputRegistry$1<Props = unknown> {
+  componentType: ComponentType$1<Props>;
+  componentId: ComponentId$1<Props>;
+}
+/**
+ * Supported component input accepted by core extension APIs.
+ * Registered React component values live in the React adapter package.
+ */
+type ComponentInput$1<Props = unknown> = ComponentInputRegistry$1<Props>[keyof ComponentInputRegistry$1<Props>];
+/**
+ * UI element that can be a primitive or a registered component descriptor.
+ */
+type UIElement = string | number | boolean | null | undefined | ComponentInput$1<any>;
+/**
+ * Identifier type for message service.
+ */
+type Identifier$1<Type0 = any, Type1 = any, Type2 = any> = {
+  type0?: Type0;
+  type1: Type1;
+  type2: Type2;
+} & string;
+/**
+ * Type that can be a Promise or a value.
+ */
+type MayBePromise$1<Value> = Promise<Value> | Value;
+/**
+ * Information about an element.
+ */
+interface ElementInfo {
+  html: string;
+  name: string;
+}
+/**
+ * Represents an element that can be used for building UI.
+ */
+interface Element {
+  title?: UIElement;
+  fallbackTooltip?: UIElement;
+  icon?: UIElement;
+  html: string;
+  className?: string;
+  name: string;
+}
+/**
+ * API for managing elements in the editor.
+ */
+interface IElementsApi {
+  /**
+   * Retrieves a list of all elements.
+   */
+  getNames(): Promise<ElementInfo[]>;
+  /**
+   * Updates an existing element.
+   */
+  update(name: string, element: Element): IDisposable;
+  /**
+   * Deletes an element by its name.
+   */
+  delete(name: string): void;
+  /**
+   * Inserts a new element at a specified position.
+   */
+  insert(element: Element, position?: number): IDisposable;
+  /**
+   * Fires when elements are injected to HTML.
+   */
+  handleInject(listener: (elementInfo: {
+    name: string;
+    className: string;
+    html: string;
+  }) => void, priority?: number, thisArg?: any): IDisposable;
+}
+/**
+ * API for interacting with the MessageService.
+ * Provides methods to send and receive messages, as well as manage event listeners.
+ */
+interface IMessageServiceApi {
+  /**
+   * Sends a message through MessageService.
+   */
+  send<Type>(messageTypeId: Identifier$1<Type>, data: Type, queued?: boolean): void;
+  send(data: any, queued?: boolean): void;
+  /**
+   * Sends an asynchronous message and waits for a response.
+   */
+  sendAsync<Type, Result>(messageTypeId: Identifier$1<Type, Result>, data: Type, queued?: boolean): Promise<Result | void>;
+  /**
+   * Adds a global event listener for message events.
+   */
+  addListener(listener: (e: MessageEvent) => void): IDisposable;
+  /**
+   * Adds a listener for a specific message type.
+   */
+  addListener<Type = any>(messageTypeId: Identifier$1<Type>, listener: (value: Type) => void, priority?: number): IDisposable;
+  /**
+   * Adds an asynchronous listener for a specific message type.
+   */
+  addListenerAsync<Type = any, Result = any>(messageTypeId: Identifier$1<Type, Result>, listener: (value: Type) => MayBePromise$1<Result>, priority?: number): IDisposable;
+  /**
+   * Adds a listener for the initialization event.
+   */
+  onInit(listener: (target: Window) => void, immediately?: boolean, priority?: number): IDisposable;
+  /**
+   * Checks whether initialization has been completed.
+   */
+  isInited(): boolean;
+}
+/**
+ * Mouse position type.
+ */
+type MousePosition = {
+  x: number;
+  y: number;
+} | null;
+/**
+ * Modal props interface.
+ */
+interface ModalProps {
+  open?: boolean;
+  confirmLoading?: boolean;
+  closable?: boolean;
+  onOk?: (e: MouseEvent) => void;
+  onCancel?: (e: MouseEvent) => void;
+  afterClose?: () => void;
+  afterOpenChange?: (open: boolean) => void;
+  centered?: boolean;
+  width?: string | number;
+  footer?: UIElement;
+  okText?: UIElement;
+  okType?: 'default' | 'primary' | 'dashed' | 'link' | 'text' | 'danger';
+  cancelText?: UIElement;
+  maskClosable?: boolean;
+  forceRender?: boolean;
+  destroyOnClose?: boolean;
+  style?: any;
+  wrapClassName?: string;
+  maskTransitionName?: string;
+  transitionName?: string;
+  className?: string;
+  rootClassName?: string;
+  getContainer?: string | HTMLElement | (() => HTMLElement) | false;
+  zIndex?: number;
+  mask?: boolean;
+  keyboard?: boolean;
+  wrapProps?: any;
+  prefixCls?: string;
+  closeIcon?: UIElement;
+  focusTriggerAfterClose?: boolean;
+  mousePosition?: MousePosition;
+}
+/**
+ * Configuration interface for modal windows.
+ */
+interface ModalConfig<Props = unknown> {
+  type?: 'confirm' | 'info' | 'success' | 'error' | 'warning';
+  title?: UIElement;
+  content: ComponentInput$1<Props>;
+  width?: number | string;
+  closable?: boolean;
+  onOk?: () => void | Promise<void>;
+  onClose?: () => void;
+  modalProps?: ModalProps;
+}
+/**
+ * ModalApi interface for managing modal windows in plugins.
+ */
+interface IModalApi {
+  /**
+   * Opens a modal window.
+   * @returns A unique identifier for the modal window.
+   */
+  show<P>(config: ModalConfig<P>): string;
+  /**
+   * Closes a modal window by its identifier.
+   */
+  close(id: string): void;
+  /**
+   * Closes all open modal windows.
+   */
+  closeAll(): void;
+  /**
+   * Updates the parameters of an already open modal window.
+   */
+  update<P>(id: string, config: Partial<ModalConfig<P>>): void;
+}
+/**
+ * API for managing styles and scripts in a sandboxed environment (e.g., an iframe).
+ */
+interface ISandboxScriptApi {
+  /**
+   * Registers an external CSS file inside the sandboxed environment.
+   */
+  registerSandboxCSS(url: string): IDisposable;
+  /**
+   * Registers a block of CSS code inside the sandboxed environment.
+   */
+  registerSandboxCSSCode(key: string, code: string): IDisposable;
+  /**
+   * Registers an external JavaScript file inside the sandboxed environment.
+   */
+  registerSandboxScript(url: string): IDisposable;
+  /**
+   * Registers a block of JavaScript code inside the sandboxed environment.
+   */
+  registerSandboxScriptCode(key: string, code: string): IDisposable;
+}
+/**
+ * Options for adding extra tabs in the interface.
+ */
+interface ExtraTabOptions<Props = unknown> {
+  content: ComponentInput$1<Props>;
+  label?: string;
+  key: string;
+  className?: string;
+}
+/**
+ * Options for the settings panel.
+ */
+interface SettingsPanelOptions<Props = unknown> {
+  content: ComponentInput$1<Props>;
+  caption?: string;
+  deletable?: boolean;
+  parent?: boolean;
+  advancedTabs?: ExtraTabOptions[];
+}
+/**
+ * API for managing the settings panel.
+ */
+interface ISettingsPanelApi {
+  /**
+   * Opens the settings panel and displays the provided component.
+   */
+  showSettingsPanel<Props = unknown>(options: SettingsPanelOptions<Props>): void;
+  /**
+   * Closes the settings panel.
+   */
+  closeSettingsPanel(): void;
+}
+/**
+ * Unique identifier for a UI component.
+ * @template P The component's props type.
+ */
+type ComponentId<P = void> = string & {
+  propsType?: P;
+};
+/**
+ * Represents a component type with its props.
+ */
+type ComponentType<Props> = {
+  type: ComponentId<Props>;
+  props: Props;
+};
+/**
+ * Creates a unique identifier for a UI component.
+ * @template Props The component's props type.
+ * @param {string} [name] Optional identifier name.
+ * @returns {ComponentId<Props>} A unique component identifier.
+ */
+declare function createComponentIdentifier<Props>(name?: string): ComponentId<Props>;
+/**
+ * Extensible registry of component inputs accepted by core extension APIs.
+ * React-specific variants are added by @emailmaker/extensions-react.
+ */
+interface ComponentInputRegistry<Props = unknown> {
+  componentType: ComponentType<Props>;
+  componentId: ComponentId<Props>;
+}
+/**
+ * Supported component input accepted by core extension APIs.
+ * React-specific component values are provided by @emailmaker/extensions-react.
+ */
+type ComponentInput<Props = unknown> = ComponentInputRegistry<Props>[keyof ComponentInputRegistry<Props>];
+/**
+ * Identifier type for message service.
+ */
+type Identifier<Type0 = any, Type1 = any, Type2 = any> = {
+  type0?: Type0;
+  type1: Type1;
+  type2: Type2;
+} & string;
+/**
+ * Type that can be a Promise or a value.
+ */
+type MayBePromise<Value> = Promise<Value> | Value;
+/**
+ * This interface defines a "DOM component" which represents a component that directly manipulates the DOM.
+ */
+interface IDomComponent<P> {
+  node: Node;
+  update?(props: P, children?: Node[]): IDomComponent<P> | void;
+  dispose?(): void;
+}
+/**
+ * Factory function for creating DOM components.
+ */
+interface IDomComponentFactory<P> {
+  (props: P, children?: Node[]): IDomComponent<P>;
+}
+/**
+ * This interface defines a registry for DOM components.
+ */
+interface IDomComponentRegistry {
+  add<Props>(componentId: ComponentId<Props>, domComponentFactory: IDomComponentFactory<Props>): IDisposable;
+}
+/**
+ * Global DomComponentRegistry singleton.
+ */
+declare const DomComponentRegistry: IDomComponentRegistry;
+// ============================================
+// EmailSettingsApi
+// ============================================
+/**
+ * API for working with email settings.
+ */
+interface EmailSettingsApi {
+  getEmailLayoutSettings(): Promise<EmailLayoutSettings>;
+  setEmailLayoutSettings(settings: Partial<EmailLayoutSettings>): Promise<void>;
+  getEmailContentStyles(): Promise<EmailContentStyles>;
+  setEmailContentStyles(contentStyles: Partial<EmailContentStyles>): Promise<void>;
+}
+/**
+ * Email layout settings.
+ */
+interface EmailLayoutSettings {
+  backgroundColor: string;
+  backgroundImage: Array<{
+    type: 'url';
+    value: string;
+  }>;
+  backgroundPositionX: string;
+  backgroundPositionY: string;
+  backgroundRepeat: string;
+  backgroundSize?: string;
+  backgroundColorContent?: string;
+  textStrong: boolean;
+  textItalic: boolean;
+  textUnderline: boolean;
+  width?: {
+    value?: number;
+    dim?: string;
+  };
+  responsive?: {
+    shutdown?: boolean;
+    styles?: boolean;
+  };
+}
+/**
+ * Email content styles.
+ */
+interface EmailContentStyles {
+  text?: {
+    fontFamily?: string[] | string;
+    fontSize?: number;
+    fontSizeDim?: string;
+    lineHeight?: number;
+    lineHeightDim?: string;
+    color?: string;
+    contrastColor?: string;
+    textAlign?: string;
+    paddingBottom?: number;
+    paddingBottomDim?: string;
+  };
+  headings?: {
+    fontFamily?: string[] | string;
+    fontSize?: number;
+    fontSizeDim?: string;
+    lineHeight?: number;
+    lineHeightDim?: string;
+    color?: string;
+    contrastColor?: string;
+    textAlign?: string;
+    paddingTop?: number;
+    paddingTopDim?: string;
+    paddingBottom?: number;
+    paddingBottomDim?: string;
+    letterSpacing?: number;
+    letterSpacingDim?: string;
+    bold?: boolean;
+    italic?: boolean;
+  };
+  links?: {
+    color?: string;
+    contrastColor?: string;
+    underline?: boolean;
+  };
+  buttons?: {
+    fontFamily?: string[] | string;
+    fontSize?: number;
+    fontSizeDim?: string;
+    letterSpacing?: number;
+    letterSpacingDim?: string;
+    color?: string;
+    contrastColor?: string;
+    bold?: boolean;
+    italic?: boolean;
+    backgroundColor?: string;
+    contrastBackgroundColor?: string;
+    marginTop?: number;
+    marginTopDim?: string;
+    marginBottom?: number;
+    marginBottomDim?: string;
+    border?: {
+      all?: number | null;
+      top?: number | null;
+      right?: number | null;
+      bottom?: number | null;
+      left?: number | null;
+    };
+    borderRadius?: {
+      all?: number | null;
+      topLeft?: number | null;
+      topRight?: number | null;
+      bottomRight?: number | null;
+      bottomLeft?: number | null;
+    };
+    textAlign?: string;
+    padding?: {
+      all?: number | null;
+      top?: number | null;
+      right?: number | null;
+      bottom?: number | null;
+      left?: number | null;
+    };
+  };
+  block?: {
+    backgroundColor?: string;
+    contrastBackgroundColor?: string;
+    padding?: {
+      all?: number | null;
+      top?: number | null;
+      right?: number | null;
+      bottom?: number | null;
+      left?: number | null;
+    };
+  };
+  cards?: {
+    contrastBackgroundColor?: string;
+    contrastTextColor?: string;
+    baseBackgroundColor?: string;
+    baseTextColor?: string;
+    border?: {
+      all?: number | null;
+      top?: number | null;
+      right?: number | null;
+      bottom?: number | null;
+      left?: number | null;
+    };
+    borderRadius?: {
+      all?: number | null;
+      topLeft?: number | null;
+      topRight?: number | null;
+      bottomRight?: number | null;
+      bottomLeft?: number | null;
+    };
+  };
+}
+// ============================================
+// Deprecated facade classes
+// ============================================
+/**
+ * @deprecated Use `editor.use('SandboxScriptApi')` to access built-in platform APIs.
+ * This compatibility facade will be removed in a future plugin-system package release.
+ */
+declare class SandboxScriptApi {
+  constructor(editor: Instance);
+}
+interface SandboxScriptApi extends ISandboxScriptApi {}
+/**
+ * @deprecated Use `editor.use('ElementsApi')` to access built-in platform APIs.
+ * This compatibility facade will be removed in a future plugin-system package release.
+ */
+declare class ElementsApi {
+  constructor(editor: Instance);
+}
+interface ElementsApi extends IElementsApi {}
+/**
+ * @deprecated Use `editor.use('MessageService')` to access built-in platform APIs.
+ * This compatibility facade will be removed in a future plugin-system package release.
+ */
+declare class MessageService {
+  constructor(editor: Instance);
+}
+interface MessageService extends IMessageServiceApi {}
+/**
+ * @deprecated Use `editor.use('SettingsPanelApi')` to access built-in platform APIs.
+ * This compatibility facade will be removed in a future plugin-system package release.
+ */
+declare class SettingsPanelApi {
+  constructor(editor: Instance);
+}
+interface SettingsPanelApi extends ISettingsPanelApi {}
+/**
+ * @deprecated Use `editor.use('ModalApi')` to access built-in platform APIs.
+ * This compatibility facade will be removed in a future plugin-system package release.
+ */
+declare class ModalApi {
+  constructor(editor: Instance);
+}
+interface ModalApi extends IModalApi {}
+/**
+ * @deprecated Use `editor.use('EmailSettingsApi')` to access built-in platform APIs.
+ * This compatibility facade will be removed in a future plugin-system package release.
+ */
+declare class EmailSettingsApi {
+  constructor(editor: Instance);
+}
+declare module '@emailmaker/emailmaker' {
+  interface PluginTypeMap {
+    SandboxScriptApi: IPluginConstructor<ISandboxScriptApi>;
+    ElementsApi: IPluginConstructor<IElementsApi>;
+    MessageService: IPluginConstructor<IMessageServiceApi>;
+    SettingsPanelApi: IPluginConstructor<ISettingsPanelApi>;
+    ModalApi: IPluginConstructor<IModalApi>;
+    EmailSettingsApi: IPluginConstructor<EmailSettingsApi>;
+  }
+}
+declare const pluginRegistry: PluginRegistry;
+declare const version: string;
+export { ComponentId, ComponentInput, ComponentInputRegistry, ComponentType, DomComponentRegistry, ElementsApi, EmailContentStyles, EmailLayoutSettings, EmailSettingsApi, type IDisposable, IDomComponent, IDomComponentFactory, IDomComponentRegistry, Identifier, MayBePromise, MessageService, ModalApi, SandboxScriptApi, SettingsPanelApi, createComponentIdentifier, pluginRegistry, version };