unlayer-types 1.46.0 → 1.52.0

package/embed.d.ts

@@ -1,6 +1,90 @@
+/// <reference types="dompurify" />
+/// <reference types="lodash" />
 /// <reference types="react" />
 /// <reference types="react-modal" />
-/// <reference types="lodash" />
+declare module "engine/config/editorSettings" {
+    export interface EditorSettings {
+        minHeaders?: number;
+        maxHeaders?: number;
+        minFooters?: number;
+        maxFooters?: number;
+        minRows?: number;
+        maxRows?: number;
+        contentType?: 'page' | 'block';
+        autoSelectOnDrop: boolean;
+        columns?: boolean;
+        confirmOnDelete?: boolean;
+    }
+    export function overrideEditorSettings(editorSettingsOverrides: EditorSettings): void;
+    export function getEditorSettings(): EditorSettings;
+}
+declare module "engine/config/features" {
+    export interface TextEditorCustomButton {
+        name: string;
+        icon: string;
+        text: string;
+        onSetup?: () => void;
+        onAction: (data: {
+            text: string;
+        }, callback: (text: string) => void) => void;
+    }
+    export interface Features {
+        audit?: boolean;
+        blocks?: boolean;
+        collaboration?: boolean;
+        preview?: boolean;
+        imageEditor?: {
+            enabled: boolean;
+            tools?: {
+                resize?: boolean;
+            };
+        } | boolean;
+        preheaderText?: boolean;
+        stockImages?: {
+            enabled: true;
+            safeSearch: true;
+            defaultSearchTerm: string;
+        } | boolean;
+        userUploads?: boolean | {
+            enabled: boolean;
+            search?: boolean;
+        };
+        undoRedo?: boolean;
+        textEditor?: {
+            spellChecker?: boolean;
+            tables?: boolean;
+            cleanPaste?: boolean | 'basic' | 'confirm';
+            emojis?: boolean;
+            textDirection?: boolean | null;
+            inlineFontControls?: boolean;
+            defaultFontSize?: string;
+            customButtons?: TextEditorCustomButton[];
+        };
+        colorPicker?: {
+            presets?: string[];
+        };
+        legacy?: {
+            disableHoverButtonColors?: boolean;
+        };
+        inboxPreviews?: boolean;
+        pageAnchors?: boolean;
+        svgImageUpload?: boolean;
+        smartMergeTags?: boolean;
+        ai?: boolean | {
+            smartHeadings?: boolean;
+            smartButtons?: boolean;
+            magicImage?: boolean;
+            smartText?: boolean;
+        };
+        sendTestEmail?: boolean;
+    }
+    export function setFeatures(newFeatures: Features): void;
+    export function setOverrideFeatures(overrideFeatures: Features): void;
+    export function overrideFeatures(newOverrideFeatures: Features): void;
+    export function getFeatures(): Features;
+    export function getFeature(path: string | string[]): any;
+    export function hasFeature(path: string | string[]): boolean;
+}
 declare module "engine/config/offline" {
     export function enableOffline(): void;
     export function isOffline(): boolean;
@@ -61,6 +145,26 @@ declare module "engine/config/fonts" {
     export function getCustomFontsCount(): number;
     export const defaultFontWeights: number[];
 }
+declare module "engine/config/safeHtml" {
+    import { Config } from 'dompurify';
+    export interface SafeHtmlOptions {
+        domPurifyOptions?: Config;
+    }
+    export function isSafeHtmlEnabled(): boolean;
+    export function enableSafeHtml(): void;
+    export function setSafeHtmlOptions(options?: SafeHtmlOptions): void;
+    function _toSafeHtmlInternal(html: string, { allowOnClick, force }?: {
+        allowOnClick?: boolean;
+        force?: boolean;
+    }): string;
+    export const toSafeHtmlInternal: typeof _toSafeHtmlInternal & import("lodash").MemoizedFunction;
+    function _toSafeHtml(html: string, { allowOnClick, force, domPurifyOptions, }?: {
+        allowOnClick?: boolean;
+        force?: boolean;
+        domPurifyOptions?: SafeHtmlOptions['domPurifyOptions'];
+    }): any;
+    export const toSafeHtml: typeof _toSafeHtml & import("lodash").MemoizedFunction;
+}
 declare module "engine/translations/types" {
     import stockTranslations from '.';
     export type StockLocale = keyof typeof stockTranslations;
@@ -1405,9 +1509,8 @@ declare module "state/types/types" {
         actionBar?: {
             placement?: 'top' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | undefined;
         };
-        features?: {
-            preview?: boolean;
-        };
+        /** @deprecated Use unlayer.init({ features: { ... }}) instead */
+        features?: object;
         loader?: {
             url?: string | undefined;
             html?: string | undefined;
@@ -1445,9 +1548,12 @@ declare module "state/types/types" {
 }
 declare module "embed/Config" {
     import { ValidationResult } from 'amphtml-validator';
+    import { EditorSettings } from "engine/config/editorSettings";
+    import { Features } from "engine/config/features";
     import { FontList } from "engine/config/fonts";
+    import { SafeHtmlOptions } from "engine/config/safeHtml";
     import { TextDirection } from "engine/config/intl";
-    import { AppearanceConfig, Audit, Device, DisplayConditions, DisplayMode, Fonts, JSONTemplate, LinkTypes, LinkTypesSharedConfig, MergeTags, MergeTagsConfig, MergeTagsValues, SpecialLinks, Tabs, ToolsConfig, User } from "state/types/types";
+    import { AppearanceConfig, Audit, DesignTags, DesignTagsConfig, Device, DisplayConditions, DisplayMode, Fonts, JSONTemplate, LinkTypes, LinkTypesSharedConfig, MergeTags, MergeTagsConfig, MergeTagsValues, SpecialLinks, Tabs, ToolsConfig, User } from "state/types/types";
     import { DeepPartial } from "editor/components/editors/types";
     export interface Config {
         id?: string;
@@ -1471,28 +1577,29 @@ declare module "embed/Config" {
         templateId?: number;
         stockTemplateId?: string;
         loadTimeout?: number;
-        safeHtml?: boolean | object;
-        safeHTML?: boolean | object;
+        safeHtml?: boolean | SafeHtmlOptions;
+        /** @deprecated use safeHtml instead */
+        safeHTML?: boolean | SafeHtmlOptions;
         options?: object;
         tools?: ToolsConfig;
         excludeTools?: string[];
         blocks?: object[];
-        editor?: object;
+        editor?: Partial<EditorSettings>;
         fonts?: Fonts;
         linkTypes?: LinkTypes;
         linkTypesSharedConfig?: LinkTypesSharedConfig;
         mergeTags?: MergeTags;
         displayConditions?: DisplayConditions;
         specialLinks?: SpecialLinks;
-        designTags?: object;
+        designTags?: DesignTags;
         customCSS?: string | string[];
         customJS?: string | string[];
         locale?: string;
         textDirection?: TextDirection;
-        translations?: object;
+        translations?: Record<string, Record<string, string>>;
         appearance?: DeepPartial<AppearanceConfig>;
-        features?: object;
-        designTagsConfig?: object;
+        features?: Features;
+        designTagsConfig?: DesignTagsConfig;
         mergeTagsConfig?: MergeTagsConfig;
         validator?: (info: {
             html: ExportHtmlResult;
@@ -1712,20 +1819,21 @@ declare module "editor/hooks/useDynamicRef" {
 declare module "editor/design-system/components/Input" {
     import React from 'react';
     import * as Ariakit from '@ariakit/react';
-    export interface InputProps extends Omit<Ariakit.FormInputProps, 'as'> {
+    export interface InputProps extends Omit<Ariakit.FormInputProps, 'as' | 'onSubmit' | 'onSubmitCapture'> {
         formStore?: Ariakit.FormStore<{
             value: string;
         }>;
         label?: React.ReactNode;
         labelPosition?: 'top' | 'left' | 'right';
         name: string;
+        onSubmit?: (value: string | number) => void;
         placeholder?: string;
         required?: boolean;
         type?: Ariakit.FormInputProps['type'] | 'textarea';
         validationDOMTarget?: HTMLDivElement | null;
         validationMessage?: string;
         validationStatus?: 'error' | 'warn' | 'success';
-        value: Ariakit.FormInputProps['value'];
+        value: string | number;
     }
     export const Input: React.ForwardRefExoticComponent<Pick<InputProps, keyof InputProps> & React.RefAttributes<HTMLInputElement>>;
     export const S: {
@@ -2509,6 +2617,7 @@ declare module "embed/Editor" {
     import { DeepPartial } from "editor/components/editors/types";
     export const LATEST_VERSION: string;
     export const STABLE_VERSION: string;
+    export const DEFAULT_VERSION: string;
     export class Editor {
         frame: Frame | null;
         constructor(config?: Config);

package/package.json

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