@unlayer/types 1.386.0

package/dist/editor/audit.d.ts

@@ -0,0 +1,31 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { Location } from './types';
+
+export type AuditTool = {
+    type: string;
+    name?: string;
+    slug?: string;
+    labelPath?: Rule['labelPath'];
+};
+
+export type Rule = {
+    id: string;
+    icon: string | string[] | undefined;
+    title: string;
+    description: string;
+    severity: 'ERROR' | 'WARNING';
+    dismissable?: boolean;
+    labelPath?: string | string[] | null;
+};
+
+export type Audit = {
+    location?: Location;
+    tool?: AuditTool;
+} & Rule;
+
+export type Validator = (info: {
+    [id: string]: unknown;
+    html?: string;
+    defaultErrors?: Audit[];
+}) => Audit[] | Promise<Audit[]>;

package/dist/editor/config.d.ts

@@ -0,0 +1,41 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+export interface EditorSettings {
+    minHeaders?: number;
+    maxHeaders?: number;
+    minFooters?: number;
+    maxFooters?: number;
+    minRows?: number;
+    maxRows?: number;
+    contentType?: 'page' | 'block';
+    autoSelectOnDrop: boolean;
+    columns?: boolean;
+    confirmOnDelete?: boolean;
+    title?: string;
+}
+
+// ───────────────────────────────────────────────────────────────────────────
+// Core Types
+// ───────────────────────────────────────────────────────────────────────────
+
+export interface SafeHtmlOptions {
+    domPurifyOptions?: Record<string, any>;
+}
+
+export type Tabs = {
+    [tabName: string]: {
+        enabled?: boolean;
+        type?: string;
+        position?: number;
+        icon?: string;
+        active?: boolean;
+    };
+};
+
+export type User = {
+    id?: string | number;
+    name?: string | null | undefined;
+    avatar?: string | null | undefined;
+    email?: string;
+    signature?: string;
+};

package/dist/editor/design.d.ts

@@ -0,0 +1,16 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+
+export type { DesignBody, DesignColumn, DesignContentItem, DesignContentType, DesignRow, JSONTemplate } from '../design';
+
+export type DesignMode = 'live' | 'edit';
+
+export type DesignTag = string;
+
+export interface DesignTags {
+    [name: string]: DesignTag;
+}
+
+export interface DesignTagsConfig {
+    delimiter: [string, string];
+}

package/dist/editor/display-conditions.d.ts

@@ -0,0 +1,5 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+export type DisplayCondition = Record<string, any>;
+
+export type DisplayConditions = DisplayCondition[];

package/dist/editor/editor.d.ts

@@ -0,0 +1,467 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { Audit, Validator } from './audit';
+import type { EditorSettings, SafeHtmlOptions, Tabs, User } from './config';
+import type { DesignMode, DesignTags, DesignTagsConfig, JSONTemplate } from './design';
+import type { DisplayConditions } from './display-conditions';
+import type { ExportFromApiResult, ExportHtmlOptions, ExportHtmlResult, ExportImageFromApiOptions, ExportLiveHtmlOptions, ExportLiveHtmlResult, ExportPdfFromApiOptions, ExportPlainTextOptions, ExportPlainTextResult, ExportZipFromApiOptions, SaveDesignOptions } from './export';
+import type { ColorPicker, Features } from './features';
+import type { Fonts } from './font';
+import type { Language, Locale, TextDirection, Translations } from './intl';
+import type { LinkTypes, LinkTypesSharedConfig, SpecialLink, SpecialLinks } from './link-types';
+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 { DeepPartial, LanguagesValue } from './utils';
+import type { BodyValues } from '../containers/body';
+import type { ColumnValues } from '../containers/column';
+import type { RowValues } from '../containers/row';
+
+export type Container = 'body' | 'row' | 'column' | 'content';
+
+export interface ToolConfig {
+    enabled?: boolean | undefined;
+    position?: number | undefined;
+    properties?: object | undefined;
+    sections?: object | undefined;
+    validator?: Validator;
+}
+
+export interface ToolsConfig {
+    [key: string]: ToolConfig;
+}
+
+export type BodyContainerExporter = (innerHTML: string, bodyValues: Record<string, any>, // @deprecated use last param instead
+meta: {
+    bodyValues: BodyValues;
+    type: string;
+    variant: Variant;
+}) => string;
+
+export type RowContainerExporter = (innerHTML: string, rowValues: RowValues, // @deprecated use last param instead
+bodyValues: BodyValues, // @deprecated use last param instead
+meta: {
+    rowIndex: number;
+    rowCells: number[];
+    rowValues: RowValues;
+    bodyValues: BodyValues;
+    variant: Variant | undefined;
+    language: string | undefined;
+    collection: Collection;
+}) => string;
+
+export type ColumnContainerExporter = (innerHTML: string, columnValues: Record<string, any>, // @deprecated use last param instead
+columnIndex: number, // @deprecated use last param instead
+rowCells: number[], // @deprecated use last param instead
+bodyValues: BodyValues, // @deprecated use last param instead
+rowValues: RowValues, // @deprecated use last param instead
+meta: {
+    columnIndex: number;
+    columnValues: ColumnValues;
+    rowIndex: number;
+    rowCells: number[];
+    rowValues: RowValues;
+    bodyValues: BodyValues;
+    variant: Variant;
+    language: string;
+}) => string;
+
+export type ContentContainerExporter = (innerHTML: string, contentValues: Record<string, any>, // @deprecated use last param instead
+bodyValues: BodyValues, // @deprecated use last param instead
+meta: {
+    index: number;
+    columnIndex: number;
+    columnValues: ColumnValues;
+    rowIndex: number;
+    rowCells: number[];
+    rowValues: RowValues;
+    bodyValues: BodyValues;
+    variant: Variant | undefined;
+    language: string | undefined;
+    embeddedValues: Record<string, unknown>;
+    mergeTagState: {
+        mergeTagGroup: string;
+        mergeTagRule: string;
+        mergeTags: MergeTagsValues;
+    };
+}) => string;
+
+export type ItemExporter<TValues extends Record<string, unknown>> = (renderValues: TValues, index: number, // @deprecated use last param instead
+columnIndex: number, // @deprecated use last param instead
+rowCells: number[], // @deprecated use last param instead
+bodyValues: BodyValues, // @deprecated use last param instead
+rowValues: RowValues, // @deprecated use last param instead
+embeddedValues: Record<string, unknown>, // @deprecated use last param instead
+meta: {
+    index: number;
+    columnIndex: number;
+    columnValues: ColumnValues;
+    rowIndex: number;
+    rowCells: number[];
+    rowValues: RowValues;
+    bodyValues: BodyValues;
+    embeddedValues: Record<string, unknown>;
+    mergeTagState: {
+        mergeTagGroup: string;
+        mergeTagRule: string;
+        mergeTags: MergeTagsValues;
+    };
+}) => string;
+
+// ───────────────────────────────────────────────────────────────────────────
+// Theme & Appearance
+// ───────────────────────────────────────────────────────────────────────────
+
+interface Config {
+    id?: string;
+    className?: string;
+    version?: string;
+    source?: {
+        name: string;
+        version: string;
+    };
+    offline?: boolean;
+    render?: boolean;
+    amp?: boolean;
+    defaultDevice?: Device;
+    devices?: Device[];
+    designId?: string;
+    designMode?: string;
+    displayMode?: DisplayMode;
+    env?: Record<'API_V1_BASE_URL' | 'API_V2_BASE_URL' | 'API_V3_BASE_URL' | 'EVENTS_API_BASE_URL' | 'TOOLS_API_V1_BASE_URL' | 'TOOLS_CDN_BASE_URL' | 'CONSOLE_BASE_URL', string | undefined>;
+    projectId?: number | null;
+    user?: User;
+    templateId?: number;
+    stockTemplateId?: string;
+    loadTimeout?: number;
+    safeHtml?: boolean | SafeHtmlOptions;
+    /** @deprecated use safeHtml instead */
+    safeHTML?: boolean | SafeHtmlOptions;
+    options?: object;
+    tools?: ToolsConfig;
+    excludeTools?: string[];
+    blocks?: object[];
+    editor?: Partial<EditorSettings>;
+    fonts?: Fonts;
+    linkTypes?: LinkTypes;
+    linkTypesSharedConfig?: LinkTypesSharedConfig;
+    mergeTags?: MergeTags;
+    displayConditions?: DisplayConditions;
+    specialLinks?: SpecialLinks;
+    designTags?: DesignTags;
+    customCSS?: string | string[];
+    customJS?: string | string[];
+    locale?: string;
+    textDirection?: TextDirection;
+    translations?: Record<string, Record<string, string>>;
+    appearance?: DeepPartial<AppearanceConfig>;
+    features?: Features;
+    designTagsConfig?: DesignTagsConfig;
+    mergeTagsConfig?: MergeTagsConfig;
+    validator?: (info: {
+        html: ExportHtmlResult;
+        design: JSONTemplate;
+        defaultErrors: Audit[];
+    }) => Audit[] | Promise<Audit[]>;
+    tabs?: Tabs;
+}
+
+type Message = object;
+
+interface MessageData {
+    action: string;
+    callbackId: number;
+    doneId: number;
+    result: unknown | undefined;
+    resultArgs: unknown[] | undefined;
+}
+
+declare class Frame {
+    id: number;
+    ready: boolean;
+    iframe: HTMLIFrameElement | undefined;
+    messages: any[];
+    callbackId: number;
+    callbacks: {
+        [key: number]: ((...args: any[]) => any) | undefined;
+    };
+    constructor(src: string);
+    createIframe(src: string): HTMLIFrameElement;
+    destroy: () => void;
+    appendTo(el: Element): void;
+    onWindowMessage: (event: MessageEvent<any>) => void;
+    postMessage(action: string, message: Message): void;
+    withMessage(action: string, message: Message | undefined, callback?: (...args: any[]) => any): void;
+    _preprocessMessageFunctions(message: Message): Message;
+    preprocessMessage(message: Message): Message;
+    scheduleMessage(message: Message): void;
+    flushMessages(): void;
+    handleMessage({ action, callbackId, doneId, result: _result, resultArgs: _resultArgs, }: MessageData): void;
+    receiveMessage(event: any): void;
+}
+
+declare class EditorClass {
+    frame: Frame | null;
+    constructor(config?: Config);
+    init(config?: Config): void;
+    destroy(): void;
+    versions: {
+        current: string | undefined;
+        latest: string;
+        stable: string;
+    };
+    get version(): string;
+    loadEditor(config: Config): void;
+    renderEditor(config: Config): void;
+    initEditor(config: Config): void;
+    registerColumns(cells: number[]): void;
+    registerCallback(type: string, callback: (...args: any[]) => void): void;
+    unregisterCallback(type: string): void;
+    registerProvider(type: string, callback: (...args: any[]) => any): void;
+    unregisterProvider(type: string): void;
+    reloadProvider(type: string): void;
+    addEventListener(type: string, callback: (...args: any[]) => void): void;
+    removeEventListener(type: string): void;
+    setDesignId(id: string | null): void;
+    setDesignMode(designMode: DesignMode | null): void;
+    setDisplayMode(displayMode: DisplayMode): void;
+    loadProject(projectId: number): void;
+    loadUser(user: User): void;
+    loadTemplate(templateId: number): void;
+    loadStockTemplate(stockTemplateId: string): void;
+    setLinkTypes(linkTypes: LinkTypes): void;
+    setLinkTypesSharedConfig(linkTypesSharedConfig: LinkTypesSharedConfig | null): void;
+    setMergeTags(mergeTags: MergeTags): void;
+    setSpecialLinks(specialLinks: SpecialLink[]): void;
+    setDisplayConditions(displayConditions: DisplayConditions): void;
+    setLocale(locale: Locale | null): void;
+    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;
+    setAppearance(appearance: DeepPartial<AppearanceConfig>): void;
+    setTheme(theme: AppearanceConfig['theme']): void;
+    setBodyValues(bodyValues: Partial<BodyValues>, bodyId?: number): void;
+    setStyleGuide(styleGuide: StyleGuideConfig): void;
+    setDesignTagsConfig(designTagsConfig: DesignTagsConfig): void;
+    setMergeTagsConfig(mergeTagsConfig: MergeTagsConfig): void;
+    showPreview(payload: {
+        device?: Device;
+        resolution?: number;
+    }): void;
+    hidePreview(): void;
+    canUndo(callback: (result: boolean) => void): void;
+    canRedo(callback: (result: boolean) => void): void;
+    undo(): void;
+    redo(): void;
+    audit(callback: (data: {
+        status: 'FAIL' | 'PASS';
+        errors: Audit[];
+    }) => void): void;
+    setValidator(validator: Validator | null): void;
+    setToolValidator(tool: string, validator: Validator | null): void;
+    updateTabs(tabs: Tabs): void;
+    clearValidators(): void;
+    setCurrentLanguage(language: string): void;
+    setLanguages(languages: Language[]): void;
+    setColorPickerConfig(colorPickerConfig: ColorPicker): void;
+    registerContainerExporter(name: Container, exporter: BodyContainerExporter | RowContainerExporter | ColumnContainerExporter | ContentContainerExporter | null | undefined): void;
+    registerItemExporter(name: string, exporter: ItemExporter<Record<string, unknown>> | null | undefined): void;
+    registerTool(config: ToolConfigDefinition): void;
+    registerPropertyEditor(config: PropertyEditorConfig): void;
+    registerTab(config: TabConfig): void;
+    createPanel(config: PanelConfig): void;
+    createViewer(config: ViewerConfig): void;
+    createWidget(config: WidgetConfig): void;
+}
+
+declare class Embed extends EditorClass {
+    createEditor(config: Config): EditorClass;
+}
+
+declare const _default: Embed;
+
+// ───────────────────────────────────────────────────────────────────────────
+// Other
+// ───────────────────────────────────────────────────────────────────────────
+
+export interface PropertyEditorConfig {
+    id?: string;
+    name: string;
+    Widget: any;
+    description?: string;
+    layout?: 'right' | 'bottom';
+    styleGuideLock?: boolean;
+    renderValue?: (value: any) => any;
+    deviceStyles?: (value: any, extra: {
+        collection: Collection;
+        device: Device;
+        displayMode: DisplayMode;
+        getDefaultSelectorForCSSProperty: (cssProperty: string | undefined) => string | undefined;
+        htmlID: string;
+        optionName: string;
+        bodyValues: {
+            [name: string]: any;
+        };
+        rootValue: any;
+    }) => {
+        _css?: string;
+        [key: string]: string | undefined;
+    };
+}
+
+export type OptionConfigMap<Values extends ValueMap = ValueMap> = {
+    [K in keyof Values]: any;
+};
+
+export type OptionGroupEmbeddedConfig<Values extends ValueMap = ValueMap> = {
+    collection: Collection;
+    type: string;
+    source: string;
+    tabLabel: string;
+    insertCount?: number;
+    optionGroups?: Record<string, {
+        optionsOverride?: OptionConfigMap<Partial<Values>>;
+    }>;
+};
+
+export type OptionGroupConfig<Values extends ValueMap = ValueMap> = {
+    rightLabel?: string;
+    title: string | null;
+    icon?: string | string[];
+    position?: number;
+    supportedDesignModes?: DesignMode[];
+    supportedByAI?: boolean;
+    enabled?: boolean;
+    hideOnOfflineMode?: boolean;
+    noContentPadding?: boolean;
+    ai?: boolean;
+    widgetParams?: {
+        [id: string]: unknown;
+    };
+} & {
+    embedded?: OptionGroupEmbeddedConfig<Values>;
+    options?: OptionConfigMap<Partial<Values>>;
+};
+
+export type OptionGroupConfigMap<Values extends ValueMap = ValueMap> = {
+    [id: string]: OptionGroupConfig<Values>;
+};
+
+export type ValueMap = {
+    [id: string]: unknown;
+} & LanguagesValue;
+
+export interface ToolConfigDefinition<Values extends ValueMap = ValueMap, T = Validator> {
+    id?: string;
+    name?: string;
+    type?: string;
+    slug?: string;
+    label?: string;
+    icon?: string | string[];
+    classicIcon?: string | string[];
+    category?: Collection;
+    cells?: number[];
+    options: OptionGroupConfigMap;
+    data?: Partial<Values>;
+    values?: Partial<Values>;
+    css?: string;
+    renderer?: object | ((...args: any[]) => any);
+    supportedByAI?: boolean;
+    supportedDisplayModes?: DisplayMode[];
+    supportedVariants?: Variant[];
+    usageLimit?: number;
+    transformer?: (values: Partial<Values>, source: {
+        name: string;
+        value: unknown;
+    }) => Partial<Values>;
+    hasDeprecatedFontControls?: boolean;
+    syncMetadata?: {
+        id: string | number;
+        lastUpdatedAt: string | number;
+        enabled?: boolean;
+    };
+    applyDesignTags?: (values: Values, designTags: DesignTags, template: (template: string, view: Record<string, any>) => string) => Values;
+    propertyStates?: (values: Partial<Values>, context: {
+        type: string;
+        hasDeprecatedFontControls?: boolean;
+    }) => Record<string, object> | undefined;
+    isSupported?: (context: {
+        displayMode: DisplayMode;
+        variant: string | null;
+    }) => boolean;
+    premium?: boolean;
+    editable?: boolean;
+    classic?: boolean;
+    enabled?: boolean;
+    position?: number;
+    location?: Location;
+    validator?: T;
+    hidden?: boolean;
+}
+
+export interface TabConfig<Values extends ValueMap = ValueMap> {
+    id?: string;
+    name: string;
+    type?: string;
+    slug?: string;
+    label?: string;
+    icon?: string | string[];
+    renderer?: {
+        Panel: any;
+    };
+    supportedDisplayModes?: DisplayMode[];
+    supportedVariants?: Variant[];
+    classic?: boolean;
+    enabled?: boolean;
+    position?: number;
+    location?: Location;
+}
+
+export type PanelMountFn = (node: { current: HTMLDivElement | null } | null) => void;
+
+export type PanelRenderFn = () => string;
+
+export interface PanelConfig {
+    mount: PanelMountFn;
+    render: PanelRenderFn;
+}
+
+export type ViewerMountFn = (node: HTMLDivElement | null, values: unknown) => void;
+
+export type ViewerRenderFn = (values: object, bodyValues: object, info: {
+    columnIndex: number;
+    rowCells: number[];
+}) => string;
+
+export interface ViewerConfig {
+    mount: ViewerMountFn;
+    render: ViewerRenderFn;
+}
+
+export type WidgetMountFn = (node: HTMLDivElement | null, value: unknown, updateValue: unknown, data: unknown) => void;
+
+export type WidgetRenderFn = (value: unknown, updateValue: unknown, data: unknown) => string;
+
+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/export.d.ts

@@ -0,0 +1,104 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { JSONTemplate } from './design';
+import type { FontList } from './font';
+import type { TextDirection } from './intl';
+import type { MergeTagsValues } from './merge-tags';
+import type { DisplayMode } from './types';
+
+export interface SaveDesignOptions {
+}
+
+export interface ExportHtmlOptions {
+    amp?: boolean;
+    cleanup?: boolean;
+    inlineStyles?: boolean;
+    textDirection?: TextDirection;
+    isPreview?: boolean;
+    language?: string;
+    live?: boolean;
+    mergeTags?: MergeTagsValues;
+    minify?: boolean;
+    popupId?: string;
+    title?: string;
+    validateAmp?: boolean;
+    onlyHeader?: boolean;
+    onlyFooter?: boolean;
+}
+
+export interface ExportHtmlResult<TDisplayMode extends DisplayMode | undefined = undefined> {
+    html: string;
+    amp: {
+        enabled: boolean;
+        format: 'AMP' | 'AMP4EMAIL';
+        html: string | undefined;
+        validation: {
+        status: 'UNKNOWN' | 'PASS' | 'FAIL';
+        errors: Array<{
+            severity: 'UNKNOWN_SEVERITY' | 'ERROR' | 'WARNING';
+            line: number;
+            col: number;
+            message: string;
+            specUrl: string | null;
+            code: string;
+            params: string[];
+        }>;
+    };
+    };
+    chunks: ExportChunksResult;
+    design: JSONTemplate<TDisplayMode>;
+}
+
+export interface ExportLiveHtmlOptions extends Omit<ExportHtmlOptions, 'live'> {
+}
+
+export interface ExportLiveHtmlResult<TDisplayMode extends DisplayMode | undefined = undefined> extends ExportHtmlResult<TDisplayMode> {
+}
+
+export interface ExportPlainTextOptions {
+    ignoreLinks?: boolean;
+    ignoreImages?: boolean;
+    ignorePreheader?: boolean;
+    mergeTags?: Record<string, string>;
+}
+
+export interface ExportPlainTextResult<TDisplayMode extends DisplayMode | undefined = undefined> {
+    text: string;
+    design: JSONTemplate<TDisplayMode>;
+}
+
+export interface ExportChunksResult {
+    css: string;
+    js: string;
+    tags: string[];
+    fonts: FontList;
+    body: any;
+}
+
+export interface ExportFromApiResult<TDisplayMode extends DisplayMode | undefined = undefined> {
+    design: JSONTemplate<TDisplayMode>;
+    url: string | null;
+    error?: string;
+}
+
+interface BaseExportFromApiOptions {
+    mergeTags?: Record<string, string>;
+    language?: string;
+}
+
+export interface ExportImageFromApiOptions extends BaseExportFromApiOptions {
+    width?: number;
+    height?: number;
+    fullPage?: boolean;
+    deviceScaleFactor?: number;
+}
+
+export interface ExportPdfFromApiOptions extends BaseExportFromApiOptions {
+}
+
+export interface ExportZipFromApiOptions extends BaseExportFromApiOptions {
+}
+
+// ───────────────────────────────────────────────────────────────────────────
+// Editor
+// ───────────────────────────────────────────────────────────────────────────