unlayer-types 1.455.0 → 1.456.0

package/embed.d.ts

@@ -21,7 +21,7 @@ declare module "libs/utils/src/pruneObj" {
     }): Partial<T>;
 }
 declare module "packages/editor/src/editor/components/editors/types" {
-    import { IconDefinition } from '@fortawesome/pro-regular-svg-icons';
+    import type { IconDefinition } from '@fortawesome/pro-regular-svg-icons';
     import { AppearanceConfig, Device, DisplayMode, Location, UndoRedoBehavior, Variant } from "packages/editor/src/state/types/types";
     /**
      * Server-safe configuration for head CSS/JS generation.
@@ -2255,15 +2255,205 @@ declare module "packages/editor/src/engine/config/features" {
     export const getBetaFeatures: () => "assistant"[];
     export function isOnLatestVersion(): boolean;
     export function setFeatures(newFeatures: Features): void;
-    export function getFeatureOverrides(): Features;
+    export function getFeatureOverrides(): {
+        audit?: boolean;
+        beta?: boolean | {
+            enabled?: boolean;
+            feedback?: boolean;
+        };
+        blocks?: boolean;
+        collaboration?: boolean;
+        preview?: boolean | {
+            enabled?: boolean;
+            cleanup?: boolean;
+            deviceResolutions?: {
+                showDefaultResolutions?: boolean;
+                customResolutions?: {
+                    desktop?: Resolution[];
+                    tablet?: Resolution[];
+                    mobile?: Resolution[];
+                };
+            };
+        };
+        imageEditor?: {
+            enabled?: boolean;
+            /**
+             * Pin a specific published image-editor bundle version. By default the
+             * editor loads the latest image-editor, so fixes ship without an editor
+             * release; set this to load an exact version (e.g. to reproduce a bug
+             * or stage a risky change). Unknown versions fall forward to the latest.
+             */
+            version?: string;
+            /**
+             * Side the tool tabs (and their properties panel) dock to. Defaults
+             * to `'right'`.
+             */
+            dock?: "left" | "right";
+            tools?: {
+                crop?: ImageEditorToolConfig;
+                /** Rounded-corners control (lives inside the Crop tool). */
+                corners?: ImageEditorToolConfig;
+                resize?: ImageEditorToolConfig;
+                filter?: ImageEditorToolConfig;
+                draw?: ImageEditorToolConfig;
+                text?: ImageEditorToolConfig;
+                shapes?: ImageEditorToolConfig;
+                stickers?: ImageEditorToolConfig;
+                frame?: ImageEditorToolConfig;
+            };
+        } | boolean;
+        preheaderText?: boolean;
+        headersAndFooters?: boolean;
+        stockImages?: {
+            enabled: true;
+            safeSearch: true;
+            defaultSearchTerm: string;
+        } | boolean;
+        userUploads?: boolean | {
+            enabled: boolean;
+            search?: boolean;
+        };
+        devTab?: boolean;
+        undoRedo?: boolean | {
+            enabled: boolean;
+            autoSelect?: boolean;
+            autoFocus?: boolean;
+        };
+        textEditor?: {
+            spellChecker?: boolean;
+            tables?: boolean;
+            cleanPaste?: boolean | "basic" | "confirm";
+            emojis?: boolean;
+            textDirection?: boolean | null;
+            inlineColorGroups?: string[];
+            inlineFontControls?: boolean;
+            defaultFontSize?: string;
+            fontSizes?: string[];
+            customButtons?: TextEditorCustomButton[];
+        };
+        colorPicker?: ColorPicker;
+        legacy?: {
+            disableHoverButtonColors?: boolean;
+        };
+        inboxPreviews?: boolean;
+        pageAnchors?: boolean;
+        svgImageUpload?: boolean;
+        smartMergeTags?: boolean;
+        multiLanguage?: boolean | {
+            enabled: boolean;
+            languages?: Language[];
+        };
+        styleGuide?: boolean;
+        ai?: boolean | {
+            enabled?: boolean;
+            assistant?: boolean;
+            /** @deprecated Use assistant instead. */
+            copilot?: boolean;
+            models?: boolean;
+            /**
+             * Preferred AI model for the assistant. Accepts:
+             *
+             * - a `"<provider>/<modelId>"` pair (e.g. `"openai/gpt-5.5"`,
+             *   `"anthropic/claude-opus-4-7"`) — pins both provider and model,
+             *   unambiguous;
+             * - a bare model id (e.g. `"gpt-5.5"`);
+             * - a provider name (e.g. `"openai"`, `"anthropic"`) — selects the
+             *   vendor and lets Unlayer pick that provider's default model.
+             *
+             * Forwarded to the v3 stream endpoint as the `model` body field.
+             * Overridden when the user picks a model from the picker
+             * (`models: true`). If unset, the server picks via its routing
+             * policy. If the preferred model has a transient provider outage,
+             * the server tries fallback models only when `fallbackModels` is
+             * `true` or an explicit array.
+             */
+            model?: AICopilotModel;
+            /**
+             * Transient-outage fallback controls for assistant text/design calls.
+             *
+             * - unset: use Unlayer's default picks only when `model` is unset;
+             * - `true`: use Unlayer's default fallback picks even for a pinned
+             *   `model`;
+             * - `false`: disable the default outage fallback tail;
+             * - array: ordered fallback model list, replacing Unlayer defaults.
+             *
+             * The `model` field remains the first choice. Fallbacks are not used
+             * for invalid requests, invalid API keys, credit exhaustion, or any
+             * other error that requires user/input/configuration changes.
+             */
+            fallbackModels?: AIFallbackModels;
+            /**
+             * Disable full-template, page, and body generation in the AI
+             * Assistant when set to `false` — usually for cost or latency
+             * control. Per-row, per-content, and per-text edits stay
+             * available. Defaults to `true` (enabled) when the AI Assistant
+             * is enabled, and is also gated by the
+             * `aiAssistant.fullTemplateGeneration` server-side entitlement.
+             */
+            fullTemplateGeneration?: boolean;
+            magicImage?: boolean;
+            image?: {
+                /**
+                 * Preferred AI image model for Magic Image and image editing.
+                 * Accepts the same shapes as `features.ai.model`, but for image
+                 * providers:
+                 *
+                 * - a `"<provider>/<modelId>"` pair (e.g. `"openai/gpt-image-2"`)
+                 *   — pins both provider and model, unambiguous;
+                 * - a bare model id (e.g. `"gpt-image-2"`);
+                 * - a provider name (e.g. `"openai"`, `"google"`) — selects the
+                 *   vendor and lets Unlayer pick that provider's default image
+                 *   model.
+                 *
+                 * Forwarded to the image endpoints as the `model` body field.
+                 * If unset, the server picks via its image routing policy. If the
+                 * preferred image model has a transient provider outage, the
+                 * server tries fallback models only when `fallbackModels` is
+                 * `true` or an explicit array.
+                 */
+                model?: AIImageModel;
+                /**
+                 * Transient-outage fallback controls for Magic Image and image
+                 * editing.
+                 *
+                 * - unset: use Unlayer's default picks only when `model` is unset;
+                 * - `true`: use Unlayer's default fallback picks even for a pinned
+                 *   `model`;
+                 * - `false`: disable the default outage fallback tail;
+                 * - array: ordered fallback model list, replacing Unlayer defaults.
+                 *
+                 * The `model` field remains the first choice. Fallbacks are not
+                 * used for invalid prompts, unsupported model IDs, invalid API
+                 * keys, credit exhaustion, or any other error that requires
+                 * user/input/configuration changes.
+                 */
+                fallbackModels?: AIImageFallbackModels;
+                /**
+                 * Quality tier, uniform across providers. Higher tiers cost
+                 * more. Mapped internally per provider — OpenAI gpt-image-2 to
+                 * its `quality` field, Gemini to image resolution
+                 * (`low`→1K, `medium`→2K, `high`→4K). Defaults to `'medium'`.
+                 */
+                quality?: "low" | "medium" | "high";
+            };
+            smartButtons?: boolean;
+            smartHeadings?: boolean;
+            smartImageAltText?: boolean;
+            smartText?: boolean;
+            smartParagraph?: boolean;
+        };
+        sendTestEmail?: boolean;
+        syncedBlocks?: boolean;
+        normalizeEmailLineHeights?: boolean;
+    };
     export function setOverrideFeatures(newOverrideFeatures: Features, options?: {
         deepmerge?: boolean;
     }): void;
     export function getFeatures(): Features;
-    export function getFeature<Path extends keyof Features | [keyof Features, ...string[]]>(path: Path): Path extends keyof Features ? Features[Path] : any;
+    export function getFeature<Path extends keyof Features | [keyof Features, ...string[]] | (string & {})>(path: Path): Path extends keyof Features ? Features[Path] : any;
     export function normalizeFeatureAsObject<Object extends Record<string, any>, Feature extends boolean | Object>(feature: Feature | undefined): Partial<Feature & object>;
-    export function getFeatureAsObject<Path extends keyof Features | [keyof Features, ...string[]]>(path: Path): Partial<(Path extends keyof Features ? Features[Path] : any) & object>;
-    export function hasFeature<Path extends keyof Features | [keyof Features, ...string[]]>(path: Path, checkEntitlement?: boolean | string): boolean;
+    export function getFeatureAsObject<Path extends keyof Features | [keyof Features, ...string[]] | (string & {})>(path: Path): Partial<(Path extends keyof Features ? Features[Path] : any) & object>;
+    export function hasFeature<Path extends keyof Features | [keyof Features, ...string[]] | (string & {})>(path: Path, checkEntitlement?: boolean | string): boolean;
 }
 declare module "packages/editor/src/engine/config/offline" {
     export function enableOffline(): void;
@@ -2281,6 +2471,10 @@ declare module "packages/editor/src/engine/config/callbacks" {
     export function registerCallback(type: string, callback: CallbackFn | null | undefined): void;
     export function unregisterCallback(type: string): void;
     export function triggerCallback(type: string, ...args: [...any[], CallbackDoneFn | undefined]): void;
+    export function triggerTextEditorReady(): void;
+    export function onTextEditorReady(handler: () => void): {
+        remove: () => void;
+    };
     export function onRegisterCallback(handler: Handler<{
         type: string;
         callback: CallbackFn;
@@ -2372,7 +2566,7 @@ declare module "packages/editor/src/embed/Config" {
     import type { SafeHtmlOptions } from "packages/editor/src/engine/config/safeHtml";
     import type { TextDirection } from "packages/editor/src/engine/config/intl";
     import type { UnlayerLocale, UnlayerTranslations } from "packages/editor/src/engine/translations/types";
-    import type { AppearanceConfig, Audit, DesignTags, DesignTagsConfig, Device, DisplayConditions, DisplayMode, Fonts, JSONTemplate, LinkTypes, LinkTypesSharedConfig, MergeTags, MergeTagsConfig, MergeTagsValues, SpecialLinks, Tabs, ToolsConfig, User } from "packages/editor/src/state/types/types";
+    import type { AppearanceConfig, Audit, DesignTags, DesignTagsConfig, Device, DisplayConditions, DisplayMode, Fonts, JSONTemplate, Language, LinkTypes, LinkTypesSharedConfig, MergeTags, MergeTagsConfig, MergeTagsValues, SpecialLinks, Tabs, ToolsConfig, User } from "packages/editor/src/state/types/types";
     import type { DeepPartial } from "packages/editor/src/editor/components/editors/types";
     export interface Config {
         id?: string;
@@ -2408,6 +2602,8 @@ declare module "packages/editor/src/embed/Config" {
         linkTypes?: LinkTypes;
         linkTypesSharedConfig?: LinkTypesSharedConfig;
         mergeTags?: MergeTags;
+        multiLanguage?: boolean;
+        languages?: Language[];
         displayConditions?: DisplayConditions;
         specialLinks?: SpecialLinks;
         designTags?: DesignTags;
@@ -2511,13 +2707,32 @@ declare module "libs/utils/src/findDeep" {
     }): string[][];
 }
 declare module "packages/editor/src/embed/Frame" {
-    export type Message = object;
+    export type Message = Record<string, any>;
     export interface MessageData {
         action: string;
         callbackId: number;
         doneId: number;
-        result: unknown | undefined;
-        resultArgs: unknown[] | undefined;
+        result: any;
+        resultArgs: any[] | undefined;
+    }
+    export interface FrameOptions {
+        /**
+         * Background color painted on the iframe element + injected into the
+         * iframe document's `<html>` / `<body>` / `#editor` via an inline
+         * `<style>` tag before editor.js runs. Lets the embedder avoid the
+         * white flash that otherwise spans editor.js download + parse +
+         * React mount when a dark theme is configured.
+         */
+        iframeBackgroundColor?: string;
+        /**
+         * Foreground / icon color applied to the iframe element via
+         * `iframe.style.color`. Read back inside the iframe (via
+         * `window.frameElement.style.color`) to seed the
+         * `--unlayer-iframe-color` CSS variable that the boot Loader
+         * spinner uses, so the icon contrasts with the boot background
+         * for the embedder's theme.
+         */
+        iframeTextColor?: string;
     }
     export class Frame {
         id: number;
@@ -2528,8 +2743,8 @@ declare module "packages/editor/src/embed/Frame" {
         callbacks: {
             [key: number]: ((...args: any[]) => any) | undefined;
         };
-        constructor(src: string);
-        createIframe(src: string): HTMLIFrameElement;
+        constructor(src: string, options?: FrameOptions);
+        createIframe(src: string, { iframeBackgroundColor, iframeTextColor }?: FrameOptions): HTMLIFrameElement;
         destroy: () => void;
         appendTo(el: Element): void;
         onWindowMessage: (event: MessageEvent<any>) => void;
@@ -2609,6 +2824,22 @@ declare module "packages/editor/src/editor/helpers/sortArrayByPosition" {
         position?: number;
     }>(arr: T[]): T[];
 }
+declare module "packages/editor/src/engine/config/propertyEditorRenderIsolation" {
+    type PropertyEditorRegistration = {
+        schemas?: unknown;
+        zodSchemas?: unknown;
+    };
+    /**
+     * Privately identifies the editor's own property-editor registrations.
+     *
+     * Public `registerPropertyEditor` callers keep the legacy full-props render
+     * behavior, including callers that replace a built-in id. The schema identity
+     * check recognizes the first-party module registration without adding an
+     * internal performance option to the public PropertyEditorConfig contract.
+     */
+    export function markFirstPartyPropertyEditor(registration: object & PropertyEditorRegistration, existingRegistration: object | undefined, builtInSchema: PropertyEditorRegistration | undefined): void;
+    export function isFirstPartyPropertyEditor(registration: object | undefined): boolean;
+}
 declare module "packages/editor/src/engine/config/tools" {
     import type { JSONSchema } from "packages/editor/src/state/types/types";
     import Mustache from 'mustache';
@@ -2920,8 +3151,8 @@ declare module "packages/editor/src/engine/config/tools" {
     export function hasAISchemas(tool: ToolConfig, { displayMode }?: {
         displayMode?: DisplayMode;
     }): boolean;
-    export function getAllTools(): any;
-    export function getTools(collection?: Collection): any;
+    export function getAllTools(): ToolConfig<ValueMap, Validator>[];
+    export function getTools(collection?: Collection): ToolConfig<ValueMap, Validator>[];
     export function getCustomToolsCount(): number;
     /**
      * Returns the set of custom-tool ids that fall within the project's
@@ -3082,9 +3313,9 @@ declare module "packages/editor/src/engine/config/tools" {
         displayMode: DisplayMode;
         entitlements: Entitlements;
     }): {
-        availableTools: any;
-        availableToolsWithDefaultRow: any[];
-        classicTools: any;
+        availableTools: ToolConfig<ValueMap, Validator>[];
+        availableToolsWithDefaultRow: ToolConfig<ValueMap, Validator>[];
+        classicTools: ToolConfig<ValueMap, Validator>[];
     };
 }
 declare module "packages/editor/src/engine/config/tabs" {
@@ -3595,6 +3826,11 @@ declare module "packages/editor/src/state/types/callbacks" {
         }) => void;
     }
 }
+declare module "packages/editor/src/embed/iframeBackground" {
+    export function rememberTheme(theme: unknown): void;
+    export const getIframeBackgroundColor: (theme: unknown) => string | undefined;
+    export const getIframeTextColor: (theme: unknown) => string | undefined;
+}
 declare module "packages/editor/src/embed/Editor" {
     import { Frame } from "packages/editor/src/embed/Frame";
     import type { Config, ExportFromApiResult, ExportHtmlOptions, ExportHtmlResult, ExportPlainTextResult, ExportImageFromApiOptions, ExportLiveHtmlOptions, ExportPdfFromApiOptions, ExportPlainTextOptions, ExportZipFromApiOptions, SaveDesignOptions, ExportLiveHtmlResult } from "packages/editor/src/embed/Config";
@@ -3617,6 +3853,7 @@ declare module "packages/editor/src/embed/Editor" {
         frame: Frame | null;
         constructor(config?: Config);
         init(config?: Config): void;
+        private captureTargetElement;
         destroy(): void;
         versions: {
             current: string | undefined;
@@ -3626,6 +3863,10 @@ declare module "packages/editor/src/embed/Editor" {
         get version(): string;
         loadEditor(config: Config): void;
         renderEditor(config: Config): void;
+        private targetElement;
+        private lastResolvedBackground;
+        private lastResolvedTextColor;
+        private applyTargetBackground;
         initEditor(config: Config): void;
         registerColumns(cells: number[]): void;
         registerCallback<T extends keyof CallbackTypeMap<TClassDisplayMode>>(type: T, callback: CallbackTypeMap<TClassDisplayMode>[T]): void;
@@ -3665,6 +3906,9 @@ declare module "packages/editor/src/embed/Editor" {
         exportZip<TDisplayMode extends DisplayMode | undefined = TClassDisplayMode>(callback: (data: ExportFromApiResult<TDisplayMode>) => void, options?: ExportZipFromApiOptions): void;
         setAppearance(appearance: DeepPartial<AppearanceConfig>): void;
         setTheme(theme: AppearanceConfig['theme']): void;
+        private applyIframeBackgroundFromTheme;
+        private applyIframeTextColorFromTheme;
+        private postToIframeWithRetry;
         setBodyValues(bodyValues: Partial<BodyValues>, bodyId?: number): void;
         setStyleGuide(styleGuide: StyleGuideConfig): void;
         setDesignTagsConfig(designTagsConfig: DesignTagsConfig): void;

package/package.json

@@ -1,5 +1,5 @@
 {
   "name": "unlayer-types",
-  "version": "1.455.0",
+  "version": "1.456.0",
   "license": "MIT"
 }