unlayer-types 1.5.46 → 1.5.48

package/embed.d.ts

@@ -305,6 +305,7 @@ declare module "state/types/index" {
         location: Location | null;
         parent: Location | null;
         threadId: CollaborationThread['id'] | null;
+        openedPanel?: 'images' | 'content' | 'uploads' | 'audit' | 'blocks';
     }
     export interface Placeholder {
         active: boolean;
@@ -677,14 +678,6 @@ declare module "editor/components/common/Loader" {
     }
     export function Loader(props: LoaderProps): JSX.Element;
 }
-declare module "editor/hooks/useDynamicRef" {
-    export function useDynamicRef<T>(value: T): import("react").MutableRefObject<T>;
-}
-declare module "state/types/RootState" {
-    import { StateType } from 'typesafe-actions';
-    import reducer from '../reducer';
-    export type RootState = StateType<typeof reducer>;
-}
 declare module "engine/config/env" {
     export const env: {
         API_V1_BASE_URL: string;
@@ -725,6 +718,172 @@ declare module "editor/helpers/image" {
     }>;
     export function imageHasTransparency(imageSrcOrBlob: string | Blob): Promise<boolean | null>;
 }
+declare module "engine/utils/withHook" {
+    import React from 'react';
+    export function withHook<P extends object, C extends React.ComponentType<P>, HookName extends string, HookFn extends (props: P) => any>(Component: C, hookName: HookName, useHook: HookFn): React.MemoExoticComponent<React.ForwardRefExoticComponent<React.PropsWithoutRef<P & Record<HookName, ReturnType<HookFn>>> & React.RefAttributes<unknown>>>;
+}
+declare module "editor/hooks/useForceRerender" {
+    export function useForceRerender({ debounce, throttle, }?: {
+        debounce?: boolean | number;
+        throttle?: boolean | number;
+    }): () => void;
+}
+declare module "editor/hooks/useConfig" {
+    import React from 'react';
+    export function useConfig(): any;
+    export function withConfig<C extends React.ComponentType>(Component: C): React.MemoExoticComponent<React.ForwardRefExoticComponent<object & Record<"config", any> & React.RefAttributes<unknown>>>;
+}
+declare module "engine/utils/position" {
+    import { DisplayMode } from '../../state/types';
+    export const ENABLE_BACKGROUND_POSITION_FOR_EMAILS = true;
+    export type Position = 'top-left' | 'top-center' | 'top-right' | 'center-left' | 'center' | 'center-right' | 'bottom-left' | 'bottom-center' | 'bottom-right';
+    export function positionToMarginArray(position: Position | undefined): string[] | readonly [0, "auto", "auto", 0] | readonly [0, "auto", "auto", "auto"] | readonly [0, 0, "auto", "auto"] | readonly ["auto", "auto", "auto", 0] | readonly ["auto"] | readonly ["auto", 0, "auto", "auto"] | readonly ["auto", "auto", 0, 0] | readonly ["auto", "auto", 0, "auto"] | readonly ["auto", 0, 0, "auto"];
+    export function positionToBackgroundPosition(position: Position | undefined): 'top left' | 'top center' | 'top right' | 'center left' | 'center center' | 'center right' | 'bottom left' | 'bottom center' | 'bottom right' | 'auto auto';
+    export function valuesToBackgroundPositionCSS(values: {
+        position: Position | 'custom' | undefined;
+        customPosition: [string, string] | undefined;
+    }, { displayMode }: {
+        displayMode: DisplayMode;
+    }): string;
+    export function positionToPercentages(position: Position | 'custom' | undefined): [x: string, y: string] | undefined;
+    export function normalizePosition(position: 'top' | 'top-left' | 'top-center' | 'top-right' | 'center' | 'center-left' | 'center-center' | 'center-right' | 'center-top' | 'center-bottom' | 'bottom' | 'bottom-left' | 'bottom-center' | 'bottom-right' | 'left' | 'left-top' | 'left-center' | 'left-bottom' | 'right' | 'right-top' | 'right-center' | 'right-bottom' | 'custom' | undefined): Position | undefined;
+}
+declare module "editor/components/editors/PositionEditor" {
+    import { EditorProps } from "editor/components/editors/types";
+    import { Position } from "engine/utils/position";
+    export type PositionEditorValue = Position | 'custom';
+    export type PositionEditorProps = EditorProps<PositionEditorValue, {
+        positions?: Position[];
+    }>;
+    export function PositionEditor(props: PositionEditorProps): JSX.Element;
+    export function PositionEditorBase(props: Pick<PositionEditorProps, 'updateValue' | 'value' | 'widgetParams'> & {
+        className?: string;
+        itemSize?: number;
+        spacing?: number;
+        valueLabelPosition?: 'left' | 'right' | 'none';
+    }): JSX.Element;
+}
+declare module "editor/hooks/useDynamicRef" {
+    export function useDynamicRef<T>(value: T): import("react").MutableRefObject<T>;
+}
+declare module "editor/components/editors/common/Counter" {
+    import React from 'react';
+    export interface CounterProps {
+        absoluteBaseValue?: number;
+        buttonSize?: 'lg' | 'md' | 'sm' | undefined;
+        children?: React.ReactNode;
+        defaultUnit?: string;
+        disabled?: boolean;
+        maxValue?: number | null;
+        minValue?: number | null;
+        onChange: (value: number | string) => void;
+        shouldRenderIncrementDecrementButtons?: boolean;
+        step?: number;
+        unitSupportedDisplayModes?: string[];
+        units?: string[];
+        value: number | string;
+    }
+    export default function Counter(props: CounterProps): JSX.Element;
+}
+declare module "engine/utils/sizeUtils" {
+    import { DisplayMode } from '../../state/types';
+    export const ENABLE_BACKGROUND_SIZE_FOR_EMAILS = false;
+    export function normalizeFloat(n: number | string | undefined, decimalsPlace?: number): number;
+    export function normalizeSize(size: number | string | undefined, { decimalsPlace }?: {
+        decimalsPlace?: number;
+    }): string;
+    export function calculateExactSize(size: number | string, maxSize: number | undefined, options?: {
+        decimalsPlace?: number;
+        ifNumberConsiderAsPercentage?: boolean;
+    }): number | undefined;
+    export function valuesToBackgroundSizeCSS(values: {
+        size: 'contain' | 'cover' | 'custom' | undefined;
+        customSize: [string, string];
+    }, { displayMode }: {
+        displayMode: DisplayMode;
+    }): string;
+}
+declare module "engine/config/mergeTags" {
+    import { MergeTags } from '../../state/types';
+    export function getMergeTags(): MergeTags;
+    export function getMergeTagsVersion(): number;
+    export function setMergeTags(_mergeTags: MergeTags): void;
+}
+declare module "engine/utils/htmlEntities" {
+    export function encodeHtmlEntities(str: string | undefined, { modes }?: {
+        modes?: Array<keyof typeof replacers>;
+    }): string;
+    const replacers: {
+        accents: (str: string | undefined) => string;
+        all: (str: string | undefined) => string;
+        others: (str: string | undefined) => string;
+        tags: (str: string | undefined) => string;
+    };
+}
+declare module "engine/utils/encodeMergeTag" {
+    export function encodeMergeTag(str: string | undefined): string;
+}
+declare module "engine/utils/escapeHtml" {
+    export function escapeHtml(str: string | undefined, { escapeAndOperator, // This was causing issues by changing & in links to &amp;
+    escapeLT, escapeGT, escapeDoubleQuotes, escapeSingleQuotes, }?: {
+        escapeAndOperator?: boolean;
+        escapeLT?: boolean;
+        escapeGT?: boolean;
+        escapeDoubleQuotes?: boolean;
+        escapeSingleQuotes?: boolean;
+    }): string;
+}
+declare module "engine/utils/escapeRegexString" {
+    export function escapeRegexString(str: string): string;
+}
+declare module "engine/utils/getNumberOrString" {
+    export function getNumberOrString(str: string | number): string | number;
+}
+declare module "engine/utils/flattenMergeTags" {
+    import { MergeTag, MergeTags, MergeTagsConfig } from '../../state/types';
+    export type MergeTagWithMeta = MergeTag & {
+        _meta: {
+            key: string;
+            tree: Array<Omit<MergeTag, 'mergeTags'> & {
+                _meta?: Omit<MergeTagWithMeta['_meta'], 'tree'>;
+            }>;
+        };
+    };
+    function _flattenMergeTags(mergeTags: Array<MergeTag | MergeTagWithMeta> | MergeTags, mergeTagsConfig?: Pick<MergeTagsConfig, 'sort'>, _internal?: Pick<MergeTagWithMeta['_meta'], 'tree'>): Array<MergeTagWithMeta>;
+    export const flattenMergeTags: typeof _flattenMergeTags & import("lodash").MemoizedFunction;
+    export function getMergeTagLabel(mergeTag: MergeTagWithMeta['_meta']['tree'][0] | undefined): string;
+    export function getMergeTagFlatLabel(mergeTag: MergeTagWithMeta | undefined): string;
+}
+declare module "engine/utils/testBrowserFeatures" {
+    export function supportsRegexLookAheadLookBehind(): boolean;
+    export function replaceWithLookBehind(str: string, lookbBehindStr: string, regex: RegExp, replacement: string): string;
+}
+declare module "engine/utils/applyMergeTagsToHtml" {
+    import { MergeTags, MergeTagsValues } from '../../state/types';
+    export function applyMergeTagsToHtml(html: string | undefined, { mergeTagsSchema, mergeTagsValues: _mergeTagsValues, _skipTags, _useRawValue, }: {
+        mergeTagsSchema: MergeTags | undefined;
+        mergeTagsValues: MergeTagsValues | undefined;
+        _skipTags?: boolean;
+        _useRawValue?: boolean;
+    }): string;
+}
+declare module "engine/utils/generateMergeTagHtml" {
+    import { Icon, MergeTag } from '../../state/types';
+    export function generateMergeTagHtml(mergeTag: Pick<MergeTag, 'name' | 'value' | 'sample'> & {
+        icon?: Icon | string;
+    }): string;
+}
+declare module "engine/utils/applyMergeTagPreviewHtmlToText" {
+    function _applyMergeTagPreviewHtmlToText(text: string | undefined, { type }?: {
+        type?: 'smart' | 'raw';
+    }): string;
+    export const applyMergeTagPreviewHtmlToText: typeof _applyMergeTagPreviewHtmlToText & import("lodash").MemoizedFunction;
+}
+declare module "state/types/RootState" {
+    import { StateType } from 'typesafe-actions';
+    import reducer from '../reducer';
+    export type RootState = StateType<typeof reducer>;
+}
 declare module "editor/hooks/useImageUploader" {
     import { useStore } from 'react-redux';
     import { ImageSource } from '../../state/types';
@@ -795,21 +954,6 @@ declare module "editor/hooks/useImageUploader" {
         }, message?: string, ...params: any[]);
     }
 }
-declare module "engine/utils/withHook" {
-    import React from 'react';
-    export function withHook<P extends object, C extends React.ComponentType<P>, HookName extends string, HookFn extends (props: P) => any>(Component: C, hookName: HookName, useHook: HookFn): React.MemoExoticComponent<React.ForwardRefExoticComponent<React.PropsWithoutRef<P & Record<HookName, ReturnType<HookFn>>> & React.RefAttributes<unknown>>>;
-}
-declare module "editor/hooks/useForceRerender" {
-    export function useForceRerender({ debounce, throttle, }?: {
-        debounce?: boolean | number;
-        throttle?: boolean | number;
-    }): () => void;
-}
-declare module "editor/hooks/useConfig" {
-    import React from 'react';
-    export function useConfig(): any;
-    export function withConfig<C extends React.ComponentType>(Component: C): React.MemoExoticComponent<React.ForwardRefExoticComponent<object & Record<"config", any> & React.RefAttributes<unknown>>>;
-}
 declare module "editor/components/common/ImageUploadButton" {
     import React from 'react';
     import { ButtonProps } from 'reactstrap';
@@ -845,82 +989,6 @@ declare module "editor/components/common/ImageUploadButton" {
 declare module "engine/tools/content/image" {
     export const DEFAULT_IMAGE_PLACEHOLDER = "https://cdn.tools.unlayer.com/image/placeholder.png";
 }
-declare module "engine/config/mergeTags" {
-    import { MergeTags } from '../../state/types';
-    export function getMergeTags(): MergeTags;
-    export function getMergeTagsVersion(): number;
-    export function setMergeTags(_mergeTags: MergeTags): void;
-}
-declare module "engine/utils/htmlEntities" {
-    export function encodeHtmlEntities(str: string | undefined, { modes }?: {
-        modes?: Array<keyof typeof replacers>;
-    }): string;
-    const replacers: {
-        accents: (str: string | undefined) => string;
-        all: (str: string | undefined) => string;
-        others: (str: string | undefined) => string;
-        tags: (str: string | undefined) => string;
-    };
-}
-declare module "engine/utils/encodeMergeTag" {
-    export function encodeMergeTag(str: string | undefined): string;
-}
-declare module "engine/utils/escapeHtml" {
-    export function escapeHtml(str: string | undefined, { escapeAndOperator, // This was causing issues by changing & in links to &amp;
-    escapeLT, escapeGT, escapeDoubleQuotes, escapeSingleQuotes, }?: {
-        escapeAndOperator?: boolean;
-        escapeLT?: boolean;
-        escapeGT?: boolean;
-        escapeDoubleQuotes?: boolean;
-        escapeSingleQuotes?: boolean;
-    }): string;
-}
-declare module "engine/utils/escapeRegexString" {
-    export function escapeRegexString(str: string): string;
-}
-declare module "engine/utils/getNumberOrString" {
-    export function getNumberOrString(str: string | number): string | number;
-}
-declare module "engine/utils/flattenMergeTags" {
-    import { MergeTag, MergeTags, MergeTagsConfig } from '../../state/types';
-    export type MergeTagWithMeta = MergeTag & {
-        _meta: {
-            key: string;
-            tree: Array<Omit<MergeTag, 'mergeTags'> & {
-                _meta?: Omit<MergeTagWithMeta['_meta'], 'tree'>;
-            }>;
-        };
-    };
-    function _flattenMergeTags(mergeTags: Array<MergeTag | MergeTagWithMeta> | MergeTags, mergeTagsConfig?: Pick<MergeTagsConfig, 'sort'>, _internal?: Pick<MergeTagWithMeta['_meta'], 'tree'>): Array<MergeTagWithMeta>;
-    export const flattenMergeTags: typeof _flattenMergeTags & import("lodash").MemoizedFunction;
-    export function getMergeTagLabel(mergeTag: MergeTagWithMeta['_meta']['tree'][0] | undefined): string;
-    export function getMergeTagFlatLabel(mergeTag: MergeTagWithMeta | undefined): string;
-}
-declare module "engine/utils/testBrowserFeatures" {
-    export function supportsRegexLookAheadLookBehind(): boolean;
-    export function replaceWithLookBehind(str: string, lookbBehindStr: string, regex: RegExp, replacement: string): string;
-}
-declare module "engine/utils/applyMergeTagsToHtml" {
-    import { MergeTags, MergeTagsValues } from '../../state/types';
-    export function applyMergeTagsToHtml(html: string | undefined, { mergeTagsSchema, mergeTagsValues: _mergeTagsValues, _skipTags, _useRawValue, }: {
-        mergeTagsSchema: MergeTags | undefined;
-        mergeTagsValues: MergeTagsValues | undefined;
-        _skipTags?: boolean;
-        _useRawValue?: boolean;
-    }): string;
-}
-declare module "engine/utils/generateMergeTagHtml" {
-    import { Icon, MergeTag } from '../../state/types';
-    export function generateMergeTagHtml(mergeTag: Pick<MergeTag, 'name' | 'value' | 'sample'> & {
-        icon?: Icon | string;
-    }): string;
-}
-declare module "engine/utils/applyMergeTagPreviewHtmlToText" {
-    function _applyMergeTagPreviewHtmlToText(text: string | undefined, { type }?: {
-        type?: 'smart' | 'raw';
-    }): string;
-    export const applyMergeTagPreviewHtmlToText: typeof _applyMergeTagPreviewHtmlToText & import("lodash").MemoizedFunction;
-}
 declare module "editor/components/common/Dropzone" {
     import React from 'react';
     import { DropzoneOptions } from 'react-dropzone';
@@ -953,72 +1021,38 @@ declare module "editor/components/common/ImageUploadErrorMessage" {
     }): any;
     export function ImageUploadErrorMessage(props: ImageUploadErrorMessageProps): JSX.Element;
 }
-declare module "engine/utils/position" {
-    import { DisplayMode } from '../../state/types';
-    export const ENABLE_BACKGROUND_POSITION_FOR_EMAILS = true;
-    export type Position = 'top-left' | 'top-center' | 'top-right' | 'center-left' | 'center' | 'center-right' | 'bottom-left' | 'bottom-center' | 'bottom-right';
-    export function positionToMarginArray(position: Position | undefined): string[] | readonly [0, "auto", "auto", 0] | readonly [0, "auto", "auto", "auto"] | readonly [0, 0, "auto", "auto"] | readonly ["auto", "auto", "auto", 0] | readonly ["auto"] | readonly ["auto", 0, "auto", "auto"] | readonly ["auto", "auto", 0, 0] | readonly ["auto", "auto", 0, "auto"] | readonly ["auto", 0, 0, "auto"];
-    export function positionToBackgroundPosition(position: Position | undefined): 'top left' | 'top center' | 'top right' | 'center left' | 'center center' | 'center right' | 'bottom left' | 'bottom center' | 'bottom right' | 'auto auto';
-    export function valuesToBackgroundPositionCSS(values: {
-        position: Position | 'custom' | undefined;
-        customPosition: [string, string] | undefined;
-    }, { displayMode }: {
-        displayMode: DisplayMode;
-    }): string;
-    export function positionToPercentages(position: Position | 'custom' | undefined): [x: string, y: string] | undefined;
-    export function normalizePosition(position: 'top' | 'top-left' | 'top-center' | 'top-right' | 'center' | 'center-left' | 'center-center' | 'center-right' | 'center-top' | 'center-bottom' | 'bottom' | 'bottom-left' | 'bottom-center' | 'bottom-right' | 'left' | 'left-top' | 'left-center' | 'left-bottom' | 'right' | 'right-top' | 'right-center' | 'right-bottom' | 'custom' | undefined): Position | undefined;
-}
-declare module "editor/components/editors/PositionEditor" {
-    import { EditorProps } from "editor/components/editors/types";
-    import { Position } from "engine/utils/position";
-    export type PositionEditorValue = Position | 'custom';
-    export type PositionEditorProps = EditorProps<PositionEditorValue, {
-        positions?: Position[];
-    }>;
-    export function PositionEditor(props: PositionEditorProps): JSX.Element;
-    export function PositionEditorBase(props: Pick<PositionEditorProps, 'updateValue' | 'value' | 'widgetParams'> & {
-        className?: string;
-        itemSize?: number;
-        spacing?: number;
-        valueLabelPosition?: 'left' | 'right' | 'none';
-    }): JSX.Element;
-}
-declare module "editor/components/editors/common/Counter" {
-    import React from 'react';
-    export interface CounterProps {
-        absoluteBaseValue?: number;
-        buttonSize?: 'lg' | 'md' | 'sm' | undefined;
-        children?: React.ReactNode;
-        defaultUnit?: string;
-        disabled?: boolean;
-        maxValue?: number | null;
-        minValue?: number | null;
-        onChange: (value: number | string) => void;
-        shouldRenderIncrementDecrementButtons?: boolean;
-        step?: number;
-        unitSupportedDisplayModes?: string[];
-        units?: string[];
-        value: number | string;
+declare module "editor/components/editors/ImageUploader" {
+    import { RefObject } from 'react';
+    import { ImageUploadButtonInstance } from "editor/components/common/ImageUploadButton";
+    import { DropEvent, FileRejection } from 'react-dropzone';
+    interface ImageUploaderProps {
+        shouldRender: {
+            uploadButton?: boolean;
+            dropzone?: boolean;
+            effects?: boolean;
+        };
+        label: string;
+        maxSize: number;
+        updateImage: (image: any) => void;
+        showImagesDropdown?: boolean;
+        showUploadsDropdown?: boolean;
+        intl: any;
+        onDropAccepted: (files: File[]) => void;
+        onDropRejected: (fileRejections: FileRejection[], event: DropEvent) => void;
+        isUploading?: boolean;
+        uploadProgress?: number;
+        postprocessedImageUrl?: string;
+        togglePixieModal: () => void;
+        imageExists?: boolean;
+        error: boolean | Error | null;
+        onImageSelect: (image: any) => void;
+        onImageUpload: (image: any) => void;
+        onUploadProgressChange: (image: any) => void;
+        onUploadStatusChange: (image: any) => void;
+        onErrorChange: (error: Error | null) => void;
+        imageUploadButtonRef: RefObject<ImageUploadButtonInstance>;
     }
-    export default function Counter(props: CounterProps): JSX.Element;
-}
-declare module "engine/utils/sizeUtils" {
-    import { DisplayMode } from '../../state/types';
-    export const ENABLE_BACKGROUND_SIZE_FOR_EMAILS = false;
-    export function normalizeFloat(n: number | string | undefined, decimalsPlace?: number): number;
-    export function normalizeSize(size: number | string | undefined, { decimalsPlace }?: {
-        decimalsPlace?: number;
-    }): string;
-    export function calculateExactSize(size: number | string, maxSize: number | undefined, options?: {
-        decimalsPlace?: number;
-        ifNumberConsiderAsPercentage?: boolean;
-    }): number | undefined;
-    export function valuesToBackgroundSizeCSS(values: {
-        size: 'contain' | 'cover' | 'custom' | undefined;
-        customSize: [string, string];
-    }, { displayMode }: {
-        displayMode: DisplayMode;
-    }): string;
+    export const ImageUploader: ({ shouldRender, label, maxSize, updateImage, showImagesDropdown, showUploadsDropdown, intl, onDropAccepted, onDropRejected, isUploading, uploadProgress, postprocessedImageUrl, togglePixieModal, imageExists, error, onImageSelect, onImageUpload, onUploadProgressChange, onUploadStatusChange, onErrorChange, imageUploadButtonRef, ...restProps }: ImageUploaderProps) => JSX.Element;
 }
 declare module "editor/components/editors/pixie/pixie.umd" {
     const _exports: {

package/package.json

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