@emailmaker/extensions-app 1.0.111-dev.4 → 1.0.111-dev.6

package/index.js

@@ -107,7 +107,7 @@ var _ = g();
 			n.packages[e.id] = e, n.validateAll();
 		}, t.__compat.registerPackage({
 			id: "extensions-api",
-			version: "1.0.111-dev.4",
+			version: "1.0.111-dev.6",
 			requires: { host: "^1.0.105" }
 		});
 	}
@@ -162,24 +162,28 @@ var x = class {
 	}
 }, C = class {
 	constructor(e) {
-		y(this, e, "MessageService");
+		y(this, e, "BlocksApi");
 	}
 }, w = class {
 	constructor(e) {
-		y(this, e, "SettingsPanelApi");
+		y(this, e, "MessageService");
 	}
 }, T = class {
 	constructor(e) {
-		y(this, e, "ModalApi");
+		y(this, e, "SettingsPanelApi");
 	}
 }, E = class {
+	constructor(e) {
+		y(this, e, "ModalApi");
+	}
+}, D = class {
 	constructor(e) {
 		y(this, e, "EmailSettingsApi");
 	}
 };
-function D(e = b()) {
+function O(e = b()) {
 	return e;
 }
-var O = d(s.DependencyResolver), k = "1.0.111-dev.4";
+var k = d(s.DependencyResolver), A = "1.0.111-dev.6";
 //#endregion
-export { O as DomComponentRegistry, S as ElementsApi, E as EmailSettingsApi, C as MessageService, T as ModalApi, x as SandboxScriptApi, w as SettingsPanelApi, D as createComponentIdentifier, _ as pluginRegistry, k as version };
+export { C as BlocksApi, k as DomComponentRegistry, S as ElementsApi, D as EmailSettingsApi, w as MessageService, E as ModalApi, x as SandboxScriptApi, T as SettingsPanelApi, O as createComponentIdentifier, _ as pluginRegistry, A as version };

package/package.json

@@ -5,8 +5,8 @@
   "main": "index.js",
   "types": "types.d.ts",
   "name": "@emailmaker/extensions-app",
-  "version": "1.0.111-dev.4",
+  "version": "1.0.111-dev.6",
   "dependencies": {
-    "@emailmaker/emailmaker": "1.0.111-dev.4"
+    "@emailmaker/emailmaker": "1.0.111-dev.6"
   }
 }

package/types.d.ts

@@ -49,6 +49,81 @@ type MayBePromise$1<Value> = Promise<Value> | Value;
 interface IDisposable$1 {
   dispose(): void;
 }
+/**
+ * Payload for `BlocksApi.handleInject` when a block/structure was inserted in the sandbox
+ * (mirrors `application_block_inserted` message data).
+ */
+interface BlockInjectInfo {
+  type?: string;
+  name?: string;
+  blockId?: string;
+  project?: string;
+}
+/**
+ * Context passed to ElementsApi.handleBeforeInject before element (atom) HTML is sent to the iframe.
+ * Listeners may mutate fields in place and/or return a partial object to merge (SaveEmitter-style).
+ */
+interface ElementInsertContext extends Record<string, unknown> {
+  name: string;
+  className: string;
+  html: string;
+}
+/**
+ * Context passed to BlocksApi.handleBeforeInject before block HTML is sent to the iframe.
+ * `insertFrom` is the editor catalog route (e.g. project / template / common), not REST Block.type taxonomy.
+ */
+interface BlockInsertContext extends Record<string, unknown> {
+  html: string;
+  insertFrom?: string;
+  fragmentRole?: 'block' | 'structure';
+  /** REST / catalog taxonomy (e.g. block type from API), not the same as `insertFrom`. */
+  type?: string;
+  name?: string;
+  /** Current app project id (route / Redux), not necessarily `Block.project` from REST. */
+  project?: string | number;
+  id?: string;
+  title?: string | null;
+  tags?: string[];
+  slug?: string;
+  description?: string;
+  subject?: string;
+  blocktags?: number[];
+  modified?: string | null;
+  author?: string;
+  lock?: boolean;
+  excerpt?: string | null;
+  status?: string;
+  is_template?: boolean;
+  link?: string;
+  renderGuid?: string;
+  date?: string | null;
+  date_gmt?: string | null;
+  modified_gmt?: string | null;
+  comment_status?: string;
+  ping_status?: string;
+  template?: string;
+  related_email?: string;
+  project_title?: string;
+  project_author?: string;
+  isAmp?: boolean;
+  /** Remaining catalog/API fields not mapped above (shallow copy). */
+  catalogExtra?: Record<string, unknown>;
+}
+/**
+ * API for block insert lifecycle in the editor (before HTML is sent to the iframe, and after sandbox insert).
+ */
+interface IBlocksApi {
+  /**
+   * Runs before block HTML is posted to the iframe. Listeners receive a mutable context; they may
+   * mutate `html` and related fields or return a partial object to merge (SaveEmitter-style).
+   */
+  handleBeforeInject(listener: (ctx: BlockInsertContext) => MayBePromise$1<Partial<BlockInsertContext> | void>, priority?: number, thisArg?: unknown): IDisposable$1;
+  /**
+   * Fires after a block or structure was inserted in the sandbox (same channel as `application_block_inserted`).
+   * Does not allow changing markup; use {@link handleBeforeInject} to transform HTML before postMessage.
+   */
+  handleInject(listener: (info: BlockInjectInfo) => void, priority?: number, thisArg?: unknown): IDisposable$1;
+}
 /**
  * Information about an element.
  */
@@ -88,13 +163,19 @@ interface IElementsApi {
    */
   insert(element: Element, position?: number): IDisposable$1;
   /**
-   * Fires when elements are injected to HTML.
+   * Runs before atom HTML is posted to the iframe. Listeners receive a mutable context; they may
+   * mutate `html` / `name` / `className` or return a partial object to merge (SaveEmitter-style).
+   */
+  handleBeforeInject(listener: (ctx: ElementInsertContext) => MayBePromise$1<Partial<ElementInsertContext> | void>, priority?: number, thisArg?: unknown): IDisposable$1;
+  /**
+   * Fires after an atom is injected into the email HTML in the sandbox. Does not allow changing inserted markup.
+   * For transforming HTML before postMessage, use {@link handleBeforeInject}.
    */
   handleInject(listener: (elementInfo: {
     name: string;
     className: string;
     html: string;
-  }) => void, priority?: number, thisArg?: any): IDisposable$1;
+  }) => void, priority?: number, thisArg?: unknown): IDisposable$1;
 }
 /**
  * API for interacting with the MessageService.
@@ -212,6 +293,21 @@ interface IModalApi {
 /**
  * API for managing styles and scripts in a sandboxed environment (e.g., an iframe).
  */
+interface ISandboxScriptHandle extends IDisposable$1 {
+  /**
+   * Resolves when the corresponding sandbox `<script>` tag is loaded in iframe.
+   * Rejects if script loading fails or registration is disposed before load completes.
+   */
+  readonly loaded: Promise<void>;
+  /**
+   * Resolves when sandbox script is ready to receive messages.
+   * If script did not synchronously create sandbox plugins during evaluation,
+   * `ready` resolves together with `loaded`.
+   * If it did, `ready` waits until those synchronously created plugins finish
+   * lifecycle initialization (`afterInit`).
+   */
+  readonly ready: Promise<void>;
+}
 interface ISandboxScriptApi {
   /**
    * Registers an external CSS file inside the sandboxed environment.
@@ -224,11 +320,11 @@ interface ISandboxScriptApi {
   /**
    * Registers an external JavaScript file inside the sandboxed environment.
    */
-  registerSandboxScript(url: string): IDisposable$1;
+  registerSandboxScript(url: string): ISandboxScriptHandle;
   /**
    * Registers a block of JavaScript code inside the sandboxed environment.
    */
-  registerSandboxScriptCode(key: string, code: string): IDisposable$1;
+  registerSandboxScriptCode(key: string, code: string): ISandboxScriptHandle;
 }
 /**
  * Options for adding extra tabs in the interface.
@@ -335,14 +431,15 @@ 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>;
+  /** Fired after email layout settings change. */
+  onChangeEmailLayoutSettings(listener: (settings: EmailLayoutSettings) => void): IDisposable;
+  /** Fired after email content styles change. */
+  onChangeEmailContentStyles(listener: (contentStyles: EmailContentStyles) => void): IDisposable;
 }
 /**
  * Email layout settings.
@@ -499,6 +596,14 @@ declare class ElementsApi {
   constructor(editor: Instance);
 }
 interface ElementsApi extends IElementsApi {}
+/**
+ * @deprecated Use `editor.use('BlocksApi')` to access built-in platform APIs.
+ * This compatibility facade will be removed in a future plugin-system package release.
+ */
+declare class BlocksApi {
+  constructor(editor: Instance);
+}
+interface BlocksApi extends IBlocksApi {}
 /**
  * @deprecated Use `editor.use('MessageService')` to access built-in platform APIs.
  * This compatibility facade will be removed in a future plugin-system package release.
@@ -534,6 +639,7 @@ declare module '@emailmaker/emailmaker' {
   interface PluginTypeMap {
     SandboxScriptApi: IPluginConstructor<ISandboxScriptApi>;
     ElementsApi: IPluginConstructor<IElementsApi>;
+    BlocksApi: IPluginConstructor<IBlocksApi>;
     MessageService: IPluginConstructor<IMessageServiceApi>;
     SettingsPanelApi: IPluginConstructor<ISettingsPanelApi>;
     ModalApi: IPluginConstructor<IModalApi>;
@@ -542,4 +648,4 @@ declare module '@emailmaker/emailmaker' {
 }
 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 };
+export { BlocksApi, ComponentId, ComponentInput, ComponentInputRegistry, ComponentType, DomComponentRegistry, ElementsApi, EmailContentStyles, EmailLayoutSettings, EmailSettingsApi, type IDisposable, IDomComponent, IDomComponentFactory, IDomComponentRegistry, type ISandboxScriptHandle, Identifier, MayBePromise, MessageService, ModalApi, SandboxScriptApi, SettingsPanelApi, createComponentIdentifier, pluginRegistry, version };