unlayer-types 1.329.0 → 1.331.0

package/embed.d.ts

@@ -83,6 +83,12 @@ declare module "editor/components/editors/types" {
         Record<string, any>,
         Record<string, any>,
         {
+            rowIndex: number | undefined;
+            rowCells: number[] | undefined;
+            rowValues: Record<string, any> | undefined;
+            columnIndex: number | undefined;
+            columnValues: Record<string, any> | undefined;
+            bodyValues: Record<string, any> | undefined;
             displayMode: DisplayMode;
             embeddedValues: Record<string, any>;
             isViewer: boolean;
@@ -1717,6 +1723,84 @@ declare module "state/types/types" {
             }[];
         }[];
     };
+    export type ExporterName = DisplayMode | 'ampWeb' | 'ampEmail' | 'classic';
+    export type BodyContainerExporter = (innerHTML: string, bodyValues: Record<string, any>, // @deprecated use last param instead
+    meta: {
+        bodyValues: RootState['design']['bodies'][string]['values'];
+        type: string;
+        variant: Variant;
+    }) => string;
+    export type BodyContainerExporters = Partial<Record<ExporterName, BodyContainerExporter>>;
+    export type RowContainerExporter = (innerHTML: string, rowValues: RootState['design']['rows'][string]['values'], // @deprecated use last param instead
+    bodyValues: RootState['design']['bodies'][string]['values'], // @deprecated use last param instead
+    meta: {
+        rowIndex: number;
+        rowCells: number[];
+        rowValues: RootState['design']['rows'][string]['values'];
+        bodyValues: RootState['design']['bodies'][string]['values'];
+        variant: Variant | undefined;
+        language: string | undefined;
+        collection: Collection;
+    }) => string;
+    export type RowContainerExporters = Partial<Record<ExporterName, RowContainerExporter>>;
+    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: RootState['design']['bodies'][string]['values'], // @deprecated use last param instead
+    rowValues: RootState['design']['rows'][string]['values'], // @deprecated use last param instead
+    meta: {
+        columnIndex: number;
+        columnValues: RootState['design']['columns'][string]['values'];
+        rowIndex: number;
+        rowCells: number[];
+        rowValues: RootState['design']['rows'][string]['values'];
+        bodyValues: RootState['design']['bodies'][string]['values'];
+        variant: Variant;
+        language: string;
+    }) => string;
+    export type ColumnContainerExporters = Partial<Record<ExporterName, ColumnContainerExporter>>;
+    export type ContentContainerExporter = (innerHTML: string, contentValues: Record<string, any>, // @deprecated use last param instead
+    bodyValues: RootState['design']['bodies'][string]['values'], // @deprecated use last param instead
+    meta: {
+        index: number;
+        columnIndex: number;
+        columnValues: RootState['design']['columns'][string]['values'];
+        rowIndex: number;
+        rowCells: number[];
+        rowValues: RootState['design']['rows'][string]['values'];
+        bodyValues: RootState['design']['bodies'][string]['values'];
+        variant: Variant | undefined;
+        language: string | undefined;
+        embeddedValues: Record<string, unknown>;
+        mergeTagState: {
+            mergeTagGroup: string;
+            mergeTagRule: string;
+            mergeTags: MergeTagsValues;
+        };
+    }) => string;
+    export type ContentContainerExporters = Partial<Record<ExporterName, ContentContainerExporter>>;
+    export type ItemExporter = (renderValues: Record<string, unknown>, index: number, // @deprecated use last param instead
+    columnIndex: number, // @deprecated use last param instead
+    rowCells: number[], // @deprecated use last param instead
+    bodyValues: RootState['design']['bodies'][string]['values'], // @deprecated use last param instead
+    rowValues: RootState['design']['rows'][string]['values'], // @deprecated use last param instead
+    embeddedValues: Record<string, unknown>, // @deprecated use last param instead
+    meta: {
+        index: number;
+        columnIndex: number;
+        columnValues: RootState['design']['columns'][string]['values'];
+        rowIndex: number;
+        rowCells: number[];
+        rowValues: RootState['design']['rows'][string]['values'];
+        bodyValues: RootState['design']['bodies'][string]['values'];
+        embeddedValues: Record<string, unknown>;
+        mergeTagState: {
+            mergeTagGroup: string;
+            mergeTagRule: string;
+            mergeTags: MergeTagsValues;
+        };
+    }) => string;
+    export type ItemExporters = Partial<Record<ExporterName, ItemExporter>>;
 }
 declare module "engine/utils/pruneObj" {
     export function pruneObj<T extends Record<string, any>>(obj: T, options?: {
@@ -1764,6 +1848,7 @@ declare module "engine/config/features" {
         collaboration?: boolean;
         preview?: boolean | {
             enabled?: boolean;
+            cleanup?: boolean;
             deviceResolutions?: {
                 showDefaultResolutions?: boolean;
                 customResolutions?: {
@@ -2360,6 +2445,7 @@ declare module "editor/design-system/components/Dropdown" {
         icon?: IconDefinition;
         label: string;
         value: any;
+        key?: string;
         tooltip?: string;
         tooltipPlacement?: TooltipProps['placement'];
         meta?: Record<string, unknown>;
@@ -2875,6 +2961,111 @@ declare module "editor/helpers/placeholders" {
     type ToolType = 'image' | 'carousel';
     export function getPlaceholderUrl(type: ToolType): string;
 }
+declare module "engine/utils/explodeBorder" {
+    export function explodeBorder(value: number | string | {
+        borderTopWidth?: string;
+        borderTopStyle?: string;
+        borderTopColor?: string;
+        borderLeftWidth?: string;
+        borderLeftStyle?: string;
+        borderLeftColor?: string;
+        borderRightWidth?: string;
+        borderRightStyle?: string;
+        borderRightColor?: string;
+        borderBottomWidth?: string;
+        borderBottomStyle?: string;
+        borderBottomColor?: string;
+    } | undefined): {
+        top: number | undefined;
+        right: number | undefined;
+        bottom: number | undefined;
+        left: number | undefined;
+    };
+}
+declare module "engine/utils/imageRendering" {
+    import { explodePaddingsOrMargins } from "engine/utils/explodePaddingsOrMargins";
+    import { explodeBorder } from "engine/utils/explodeBorder";
+    export function isFixedContentWidth(bodyValues?: {
+        contentWidth: number | string;
+    }): boolean;
+    export function getBodyAvailableWidth({ body, fallbackBodyContentWidth, }: {
+        body: {
+            values: {
+                contentWidth: number | string;
+                padding?: Parameters<typeof explodePaddingsOrMargins>[0];
+                border?: Parameters<typeof explodeBorder>[0];
+            };
+        };
+        fallbackBodyContentWidth?: number;
+    }): number;
+    export function getRowAvailableWidth({ body, row, }: {
+        body: Parameters<typeof getBodyAvailableWidth>[0]['body'];
+        row: {
+            values: {
+                padding: Parameters<typeof explodePaddingsOrMargins>[0];
+                border?: Parameters<typeof explodeBorder>[0];
+            };
+        };
+    }): number;
+    export function getColumnAvailableWidth({ body, row, column, }: {
+        body: Parameters<typeof getRowAvailableWidth>[0]['body'];
+        row: Parameters<typeof getRowAvailableWidth>[0]['row'] & {
+            cells: number[];
+        };
+        column: {
+            index: number;
+            values: {
+                padding: Parameters<typeof explodePaddingsOrMargins>[0];
+                border: Parameters<typeof explodeBorder>[0];
+            };
+        };
+    }): number;
+    export function getContentAvailableWidth({ body, row, column, item, }: {
+        body: Parameters<typeof getColumnAvailableWidth>[0]['body'];
+        row: Parameters<typeof getColumnAvailableWidth>[0]['row'];
+        column: Parameters<typeof getColumnAvailableWidth>[0]['column'];
+        item: {
+            values: {
+                containerPadding?: Parameters<typeof explodePaddingsOrMargins>[0];
+                border?: Parameters<typeof explodeBorder>[0];
+            };
+        };
+    }): number;
+    export function getAvailableWidth({ values, columnIndex, columnValues, rowCells, rowValues, bodyValues, }: {
+        values: Parameters<typeof getContentAvailableWidth>[0]['item']['values'];
+        columnIndex: Parameters<typeof getContentAvailableWidth>[0]['column']['index'];
+        columnValues: Parameters<typeof getContentAvailableWidth>[0]['column']['values'];
+        rowCells: Parameters<typeof getContentAvailableWidth>[0]['row']['cells'];
+        rowValues: Parameters<typeof getContentAvailableWidth>[0]['row']['values'];
+        bodyValues: Parameters<typeof getContentAvailableWidth>[0]['body']['values'];
+    }): number;
+    export function getImageWidthAndMaxWidth(widthValue: {
+        autoWidth?: boolean;
+        maxWidth?: number | string;
+        width?: number;
+    }, availableWidth?: number): {
+        width: string;
+        maxWidth: string;
+    };
+    export function getImageProperties(widthValue: {
+        autoWidth?: boolean;
+        maxWidth?: number | string;
+        width?: number;
+    }, availableWidth?: number, optionName?: string): {
+        imageCSSClassName: string;
+        imageStyleObj: {
+            width: string;
+            maxWidth: string;
+        };
+        imageCSSStyle: string;
+    };
+    export function getDynamicImageUrl(src: string | undefined, params: {
+        allowUpscale?: boolean;
+        dynamic?: boolean;
+        resizeWidth: number | string | undefined;
+        originalWidth: number | string | undefined;
+    }): string;
+}
 declare module "editor/components/editors/pixie/pixie.umd" {
     const _exports: {
         new (t: any): {

package/package.json

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