@unlayer/types 1.386.2 → 1.386.4

package/README.md

@@ -33,13 +33,20 @@ type PopupDesign = JSONTemplate<'popup'>; // body.values has popupPosition
 type EmailBody = BodyValues<'email'>; // has preheaderText, lacks popupPosition
 type PopupBody = BodyValues<'popup'>; // has popupPosition, lacks preheaderText
 
-// Export methods accept a display mode generic that narrows the design types:
-declare const unlayer: UnlayerEditor;
-unlayer.exportHtml<'email'>((result) => {
+// The Unlayer instance propagates its display mode to method typings:
+declare const unlayer: UnlayerEditor<'email'>;
+unlayer.exportHtml((result) => {
   const html = result.html;
   const preheaderText = result.design.body.values.preheaderText; // typed, email-only field
 });
 
+// Alternatively, you can use the display mode generic on the method:
+unlayer.exportHtml<'popup'>((result) => {
+  const popupBackgroundColor = result.design.body.values.popupBackgroundColor; // available on popup mode
+  // @ts-expect-error
+  const preheaderText = result.design.body.values.preheaderText; // not available on popup mode
+});
+
 // Example of fully typed json manipulation
 function handleDesign(design: JSONTemplate) {
   for (const row of design.body.rows) {

package/dist/editor/editor.d.ts

@@ -12,7 +12,7 @@ import type { LinkTypes, LinkTypesSharedConfig, SpecialLink, SpecialLinks } from
 import type { MergeTags, MergeTagsConfig, MergeTagsValues } from './merge-tags';
 import type { StyleGuideConfig } from './style-guide';
 import type { AppearanceConfig, Theme } from './theme';
-import type { Collection, Device, DisplayMode, Location, Variant } from './types';
+import type { CallbackTypeMap, Collection, Device, DisplayMode, Location, Variant } from './types';
 import type { DeepPartial, LanguagesValue } from './utils';
 import type { BodyValues } from '../containers/body';
 import type { ColumnValues } from '../containers/column';
@@ -201,7 +201,7 @@ declare class Frame {
     receiveMessage(event: any): void;
 }
 
-declare class EditorClass {
+declare class EditorClass<TClassDisplayMode extends DisplayMode | undefined = undefined> {
     frame: Frame | null;
     constructor(config?: Config);
     init(config?: Config): void;
@@ -216,12 +216,16 @@ declare class EditorClass {
     renderEditor(config: Config): void;
     initEditor(config: Config): void;
     registerColumns(cells: number[]): void;
+    registerCallback<T extends keyof CallbackTypeMap<TClassDisplayMode>>(type: T, callback: CallbackTypeMap<TClassDisplayMode>[T]): void;
     registerCallback(type: string, callback: (...args: any[]) => void): void;
+    unregisterCallback<T extends keyof CallbackTypeMap<TClassDisplayMode>>(type: T): void;
     unregisterCallback(type: string): void;
     registerProvider(type: string, callback: (...args: any[]) => any): void;
     unregisterProvider(type: string): void;
     reloadProvider(type: string): void;
+    addEventListener<T extends keyof CallbackTypeMap<TClassDisplayMode>>(type: T, callback: CallbackTypeMap<TClassDisplayMode>[T]): void;
     addEventListener(type: string, callback: (...args: any[]) => void): void;
+    removeEventListener<T extends keyof CallbackTypeMap<TClassDisplayMode>>(type: T): void;
     removeEventListener(type: string): void;
     setDesignId(id: string | null): void;
     setDesignMode(designMode: DesignMode | null): void;
@@ -239,14 +243,14 @@ declare class EditorClass {
     setTextDirection(textDirection: TextDirection | null): void;
     setTranslations(translations: Translations): void;
     loadBlank(bodyValues?: object): void;
-    loadDesign<TDisplayMode extends DisplayMode | undefined = undefined>(design: JSONTemplate<TDisplayMode>): void;
-    saveDesign<TDisplayMode extends DisplayMode | undefined = undefined>(callback: (data: JSONTemplate<TDisplayMode>) => void, options?: SaveDesignOptions): void;
-    exportHtml<TDisplayMode extends DisplayMode | undefined = undefined>(callback: (data: ExportHtmlResult<TDisplayMode>) => void, options?: ExportHtmlOptions): void;
-    exportLiveHtml<TDisplayMode extends DisplayMode | undefined = undefined>(callback: (data: ExportLiveHtmlResult<TDisplayMode>) => void, options?: ExportLiveHtmlOptions): void;
-    exportPlainText<TDisplayMode extends DisplayMode | undefined = undefined>(callback: (data: ExportPlainTextResult<TDisplayMode>) => void, options?: ExportPlainTextOptions): void;
-    exportImage<TDisplayMode extends DisplayMode | undefined = undefined>(callback: (data: ExportFromApiResult<TDisplayMode>) => void, options?: ExportImageFromApiOptions): void;
-    exportPdf<TDisplayMode extends DisplayMode | undefined = undefined>(callback: (data: ExportFromApiResult<TDisplayMode>) => void, options?: ExportPdfFromApiOptions): void;
-    exportZip<TDisplayMode extends DisplayMode | undefined = undefined>(callback: (data: ExportFromApiResult<TDisplayMode>) => void, options?: ExportZipFromApiOptions): void;
+    loadDesign<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(design: JSONTemplate<TDisplayMode>): void;
+    saveDesign<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: JSONTemplate<TDisplayMode>) => void, options?: SaveDesignOptions): void;
+    exportHtml<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportHtmlResult<TDisplayMode>) => void, options?: ExportHtmlOptions): void;
+    exportLiveHtml<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportLiveHtmlResult<TDisplayMode>) => void, options?: ExportLiveHtmlOptions): void;
+    exportPlainText<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportPlainTextResult<TDisplayMode>) => void, options?: ExportPlainTextOptions): void;
+    exportImage<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportFromApiResult<TDisplayMode>) => void, options?: ExportImageFromApiOptions): void;
+    exportPdf<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportFromApiResult<TDisplayMode>) => void, options?: ExportPdfFromApiOptions): void;
+    exportZip<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportFromApiResult<TDisplayMode>) => void, options?: ExportZipFromApiOptions): void;
     setAppearance(appearance: DeepPartial<AppearanceConfig>): void;
     setTheme(theme: AppearanceConfig['theme']): void;
     setBodyValues(bodyValues: Partial<BodyValues>, bodyId?: number): void;
@@ -256,7 +260,7 @@ declare class EditorClass {
     showPreview(payload: {
         device?: Device;
         resolution?: number;
-    }): void;
+    } | Device): void;
     hidePreview(): void;
     canUndo(callback: (result: boolean) => void): void;
     canRedo(callback: (result: boolean) => void): void;
@@ -284,11 +288,19 @@ declare class EditorClass {
 }
 
 declare class Embed extends EditorClass {
-    createEditor(config: Config): EditorClass;
+    createEditor<TDisplayMode extends DisplayMode | undefined = undefined>(config: Config): EditorClass<TDisplayMode>;
 }
 
 declare const _default: Embed;
 
+export type UnlayerEditor<TDisplayMode extends DisplayMode | undefined = undefined> = EditorClass<TDisplayMode>;
+
+export type UnlayerEmbed<TDisplayMode extends DisplayMode | undefined = undefined> = Omit<Embed, keyof EditorClass> & EditorClass<TDisplayMode>;
+
+export type UnlayerOptions<TDisplayMode extends DisplayMode | undefined = undefined> = Omit<Config, 'displayMode'> & {
+    displayMode?: TDisplayMode extends undefined ? DisplayMode : TDisplayMode;
+};
+
 // ───────────────────────────────────────────────────────────────────────────
 // Other
 // ───────────────────────────────────────────────────────────────────────────
@@ -455,13 +467,3 @@ export interface WidgetConfig {
     mount: WidgetMountFn;
     render: WidgetRenderFn;
 }
-
-// ───────────────────────────────────────────────────────────────────────────
-// Main Exports
-// ───────────────────────────────────────────────────────────────────────────
-
-export type UnlayerEmbed = typeof _default;
-
-export type UnlayerOptions = Parameters<UnlayerEmbed['createEditor']>[0];
-
-export type UnlayerEditor = InstanceType<typeof EditorClass>;

package/dist/editor/types.d.ts

@@ -1,5 +1,8 @@
 // Auto-generated by build-values-types.js. Do not edit manually.
 
+import type { JSONTemplate } from './design';
+import type { MergeTags } from './merge-tags';
+
 export type Device = 'desktop' | 'mobile' | 'tablet';
 
 export type Resolution = {
@@ -20,4 +23,97 @@ export interface Location {
     id: number | string;
 }
 
+export interface CallbackTypeMap<TDisplayMode extends DisplayMode | undefined = undefined> {
+    'editor:ready': () => void;
+    'design:loaded': (data: {
+        design: JSONTemplate<TDisplayMode>;
+    }) => void;
+    'design:updated': (data: {
+        type: string;
+        item?: Record<string, any>;
+        changes?: Record<string, any>;
+    }) => void;
+    'image:uploaded': (data: {
+        image: {
+            url: string;
+            width?: number;
+            height?: number;
+        };
+    }) => void;
+    'item:selected': (data: {
+        item: Record<string, any>;
+        active: boolean;
+    }) => void;
+    'row:moved': (data: {
+        row: Record<string, any>;
+    }) => void;
+    'content:moved': (data: {
+        content: Record<string, any>;
+    }) => void;
+    image: (data: {
+        attachments: File[];
+    }, done: (result: {
+        progress?: number;
+        url?: string;
+    }) => void) => void;
+    selectImage: (data: Record<string, any>, done: (result: {
+        url: string;
+        width?: number;
+        height?: number;
+        size?: number;
+        id?: string | number;
+    }) => void) => void;
+    displayCondition: (data: Record<string, any>, done: (result: {
+        type: string;
+        label: string;
+        description: string;
+        before: string;
+        after: string;
+    } | null) => void) => void;
+    mergeTag: (data: {
+        mergeTags: MergeTags;
+        context: {
+            elementId: string;
+        };
+    }, done: (result: {
+        name?: string;
+        value: string;
+    }) => void) => void;
+    mergeTagRule: (data: {
+        mergeTags: MergeTags;
+        mergeTagGroup?: string;
+        mergeTagRule?: string;
+        context: {
+            elementId: string;
+        };
+    }, done: (result: {
+        mergeTagGroup: string | null;
+        mergeTagRule: string | null;
+    }) => void) => void;
+    previewHtml: (data: {
+        html: string;
+    }, done: (result: {
+        html: string;
+    }) => void) => void;
+    fetchImage: (data: {
+        url: string;
+    }, done: (result: {
+        blob: Blob;
+        url?: string;
+    }) => void) => void;
+    'image:removed': (params: Record<string, any>, done: (result: any) => void) => void;
+    itemAdded: (data: {
+        item: Record<string, any>;
+    }, done: (result: any) => void) => void;
+    itemRemoved: (data: {
+        item: Record<string, any>;
+    }, done: (result: boolean) => void) => void;
+    itemMoved: (data: {
+        item: Record<string, any>;
+    }, done: (result: any) => void) => void;
+    'block:added': (data: Record<string, any>, done: (result: any) => void) => void;
+    'block:modified': (data: Record<string, any>, done: (result: any) => void) => void;
+    'block:removed': (data: Record<string, any>, done: (result: any) => void) => void;
+}
+
 export type ExporterName = "email" | "web" | "popup" | "document" | "classic" | "ampWeb" | "ampEmail";

package/dist/tools/button.d.ts

@@ -48,7 +48,6 @@ export type ButtonValues<
     label?: string;
   };
   buttonColors: {
-    [x: string]: unknown;
     color?: string;
     backgroundColor?: string;
     hoverColor?: string;

package/dist/tools/form.d.ts

@@ -81,7 +81,6 @@ export type FormValues<
   labelAlign: "left" | "center" | "right" | "justify";
   labelPadding: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
   buttonColors: {
-    [x: string]: unknown;
     color?: string;
     backgroundColor?: string;
     hoverColor?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unlayer/types",
-  "version": "1.386.2",
+  "version": "1.386.4",
   "license": "MIT",
   "private": false,
   "types": "./dist/index.d.ts",