unlayer-types 1.206.0 → 1.208.0

package/embed.d.ts

@@ -28,7 +28,8 @@ declare module "editor/components/editors/types" {
             skipFromUndoRedo?: boolean;
         }) => void;
         name: string;
-        data?: object;
+        /** @deprecated Use widgetParams instead */
+        data?: WidgetParams;
         disabled?: boolean;
         isLockedByStyleGuide?: boolean;
         widgetParams?: WidgetParams;
@@ -1180,12 +1181,31 @@ declare module "editor/themes/types" {
         };
     };
 }
+declare module "engine/constants" {
+    export const collections: readonly ["bodies", "columns", "contents", "footers", "headers", "pages", "rows"];
+    export const HTMLInputTypeAttributes: readonly ["button", "checkbox", "color", "date", "datetime-local", "email", "file", "hidden", "image", "month", "number", "password", "radio", "range", "reset", "search", "submit", "tel", "text", "time", "url", "week"];
+}
+declare module "engine/utils/zod/schemas" {
+    export const DisplayConditionZodSchema: any;
+    export const FontWeightZodSchema: any;
+    export const FontZodSchema: any;
+    export const HintZodSchema: any;
+    export const PercentageZodSchema: any;
+    export const SinglePxZodSchema: any;
+    export const DoublePxZodSchema: any;
+    export const TriplePxZodSchema: any;
+    export const QuadruplePxZodSchema: any;
+    export const MultiplePxZodSchema: any;
+}
 declare module "state/types/types" {
     import * as Ariakit from '@ariakit/react';
     import { MutableRefObject, ReactInstance } from 'react';
+    import { z } from 'zod';
     import { State as Design } from '../reducer/design';
     import { CollaborationThread } from "editor/components/editors/types";
     import { Theme } from "editor/themes/types";
+    import { collections } from "engine/constants";
+    import { DisplayConditionZodSchema } from "engine/utils/zod/schemas";
     export type DesignMode = 'live' | 'edit';
     export type Device = 'desktop' | 'mobile' | 'tablet';
     export type DisplayMode = 'web' | 'email' | 'popup' | 'document';
@@ -1214,13 +1234,7 @@ declare module "state/types/types" {
         autocompleteTriggerChar?: string;
         sort?: boolean;
     }
-    export interface DisplayCondition {
-        type: string;
-        label: string;
-        description: string;
-        before?: string;
-        after?: string;
-    }
+    export type DisplayCondition = z.infer<typeof DisplayConditionZodSchema>;
     export type DisplayConditions = DisplayCondition[];
     export type SpecialLink = {
         name: string;
@@ -1307,7 +1321,7 @@ declare module "state/types/types" {
     export interface Translations {
         [name: string]: object;
     }
-    export type Collection = 'bodies' | 'columns' | 'contents' | 'pages' | 'rows' | 'headers' | 'footers';
+    export type Collection = ArrayItem<typeof collections>;
     export type Container = 'body' | 'row' | 'column' | 'content';
     export interface Location {
         collection: Collection;
@@ -1336,7 +1350,7 @@ declare module "state/types/types" {
     export interface Tool {
         active: boolean;
         type: string | null;
-        slug: string | null;
+        slug?: string | null;
     }
     export interface Usage {
         brandStyleGuide?: boolean;
@@ -1446,18 +1460,6 @@ declare module "state/types/types" {
             active?: boolean;
         };
     };
-    export type SocialIcon = {
-        name: string;
-        url: string;
-        imgUrl?: string;
-    };
-    export type SocialCustomIcon = {
-        name: string;
-        url: string;
-        icons: {
-            [key: string]: string;
-        }[];
-    };
     export type AppearanceConfig = {
         actionBar?: {
             placement?: 'top' | 'bottom' | 'top_left' | 'top_right' | 'bottom_left' | 'bottom_right' | undefined;
@@ -1520,6 +1522,8 @@ declare module "state/types/types" {
             [toolId: string]: StyleGuideToolConfig | undefined;
         };
     }
+    export interface JSONSchema {
+    }
 }
 declare module "engine/utils/pruneObj" {
     export function pruneObj<T extends Record<string, any>>(obj: T, options?: {
@@ -1656,17 +1660,9 @@ declare module "engine/config/callbacks" {
     };
 }
 declare module "engine/config/fonts" {
-    export interface Font {
-        defaultFont?: boolean;
-        type?: 'google' | string;
-        label: string;
-        value: string;
-        url?: string;
-        weights?: number[] | Array<{
-            label: string;
-            value: number;
-        } | number>;
-    }
+    import { z } from 'zod';
+    import { FontZodSchema } from "engine/utils/zod/schemas";
+    export type Font = z.infer<typeof FontZodSchema>;
     export type FontList = Font[];
     export interface FontConfig {
         showDefaultFonts?: boolean;
@@ -1961,9 +1957,10 @@ declare module "editor/hooks/useConfig" {
     export function withConfig<C extends React.ComponentType>(Component: C): React.MemoExoticComponent<React.ForwardRefExoticComponent<React.RefAttributes<unknown>>>;
 }
 declare module "engine/utils/position" {
-    import { DisplayMode } from "state/types/types";
+    import { ArrayItem, DisplayMode } from "state/types/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 const positions: readonly ["top-left", "top-center", "top-right", "center-left", "center", "center-right", "bottom-left", "bottom-center", "bottom-right"];
+    export type Position = ArrayItem<typeof positions>;
     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: {
@@ -1975,14 +1972,32 @@ declare module "engine/utils/position" {
     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 "engine/utils/zod/zodSchemasToJsonSchemas" {
+    import { ZodSchema } from 'zod';
+    import { JSONSchema } from "state/types/types";
+    export function zodSchemasToJsonSchemas<K extends string>(zodSchemas: Record<K, ZodSchema>): Record<K, JSONSchema>;
+}
+declare module "engine/utils/zod/propertyEditorSchemas" {
+    import { PropertyEditorZodSchemas } from '../../config';
+    export function propertyEditorZodSchemas<T extends PropertyEditorZodSchemas>(zodSchemas: T): {
+        zodSchemas: T;
+        schemas: Record<string, import("state/types/types").JSONSchema>;
+    };
+}
+declare module "engine/utils/zod/types" {
+    import { z } from 'zod';
+    import { EditorProps } from "editor/components/editors/types";
+    import { PropertyEditorZodSchemas } from '../../config';
+    export type EditorPropsFromZodSchemas<T extends PropertyEditorZodSchemas> = EditorProps<z.infer<T['value']>, z.infer<T['widgetParams']>>;
+}
 declare module "editor/components/editors/PositionEditor" {
     import React from 'react';
-    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[];
-    }>;
+    import { EditorPropsFromZodSchemas } from "engine/utils/zod/types";
+    export const schemas: Record<string, import("state/types/types").JSONSchema>, zodSchemas: {
+        value: any;
+        widgetParams: any;
+    };
+    export type PositionEditorProps = EditorPropsFromZodSchemas<typeof zodSchemas>;
     export function PositionEditor(props: PositionEditorProps): React.JSX.Element;
     export function PositionEditorBase(props: Pick<PositionEditorProps, 'updateValue' | 'value' | 'widgetParams'> & {
         className?: string;
@@ -2550,27 +2565,20 @@ declare module "editor/design-system/components/ToggleSwitch" {
 }
 declare module "editor/components/editors/AutoWidthEditor" {
     import * as React from 'react';
-    import { EditorProps } from "editor/components/editors/types";
     import { WidgetLabelProps } from "editor/components/editors/common/WidgetLabel";
     import { Device } from "state/types/types";
-    export interface AutoWidthEditorValue {
-        autoWidth?: boolean;
-        width?: number | string;
-    }
-    export type AutoWidthEditorProps = EditorProps<AutoWidthEditorValue> & {
-        widgetParams?: {
-            hint?: string | {
-                id: string;
-                defaultValue: string;
-            };
-        };
+    import { EditorPropsFromZodSchemas } from "engine/utils/zod/types";
+    export const schemas: Record<string, import("state/types/types").JSONSchema>, zodSchemas: {
+        value: any;
+        widgetParams: any;
     };
+    export type AutoWidthEditorProps = EditorPropsFromZodSchemas<typeof zodSchemas>;
     export interface AutoWidthEditorBaseProps extends Pick<AutoWidthEditorProps, 'value' | 'defaultValue' | 'disabled' | 'isLockedByStyleGuide'> {
         defaultWidthIsCalculated?: boolean;
         deviceName?: Device;
         widgetLabelProps: Omit<WidgetLabelProps, 'defaultValue' | 'onReset'>;
         handlers: {
-            onToggleAutoWidth: (autoWidth: AutoWidthEditorValue['autoWidth']) => void;
+            onToggleAutoWidth: (autoWidth: NonNullable<AutoWidthEditorProps['value']>['autoWidth']) => void;
             onChangeWidth: (width: number) => void;
             onReset: NonNullable<WidgetLabelProps['onReset']>;
         };
@@ -2768,35 +2776,12 @@ declare module "editor/components/editors/pixie/PixieImageEditor" {
     export default PixieImageEditor;
 }
 declare module "editor/components/editors/ImageEditor" {
-    import { EditorProps } from "editor/components/editors/types";
-    export type ImageEditorValue = {
-        url: string;
-        width?: number;
-        height?: number;
-        autoWidth?: boolean;
-        maxWidth?: string;
-        optimistic?: boolean;
-    };
-    export type ImageEditorProps = EditorProps<ImageEditorValue> & {
-        widgetParams?: {
-            shouldRender?: {
-                dropzone?: boolean;
-                editImageButton?: boolean;
-                /** @deprecated Use editImageButton instead */
-                effects?: boolean;
-                moreImages?: boolean;
-                stockImages?: boolean;
-                uploadButton?: boolean;
-                url?: boolean;
-                userUploads?: boolean;
-                width?: boolean;
-            } | false;
-            hint?: string | {
-                id: string;
-                defaultValue: string;
-            };
-        };
+    import { EditorPropsFromZodSchemas } from "engine/utils/zod/types";
+    export const schemas: Record<string, import("state/types/types").JSONSchema>, zodSchemas: {
+        value: any;
+        widgetParams: any;
     };
+    export type ImageEditorProps = EditorPropsFromZodSchemas<typeof zodSchemas>;
     export function isDefaultImage(imageUrl: string | undefined): boolean;
 }
 declare module "editor/components/common/Dropzone" {
@@ -2883,44 +2868,18 @@ declare module "editor/components/editors/ImageUploader" {
     export const ImageUploader: ({ disabled, shouldRender: _shouldRender, label, optionName, location, maxSize, intl, onDropAccepted, onDropRejected, isUploading, uploadProgress, imageUrl, imageWidth, imageHeight, imageSize, togglePixieModal, imageExists, error, onImageSelect, onImageUpload, onUploadProgressChange, onUploadStatusChange, onErrorChange, imageUploadButtonRef, showError, ...restProps }: ImageUploaderProps) => React.JSX.Element;
 }
 declare module "editor/components/editors/BackgroundImageEditor" {
-    import { EditorProps } from "editor/components/editors/types";
-    import { Position } from "engine/utils/position";
-    export type BackgroundImageEditorValue = {
-        url: string | undefined;
-        width: number | undefined;
-        height: number | undefined;
-        fullWidth: boolean | undefined;
-        size: 'contain' | 'cover' | 'custom' | undefined;
-        customSize: [string, string];
-        repeat: 'no-repeat' | 'repeat-x' | 'repeat-y' | 'repeat' | undefined;
-        position: Position | 'custom' | undefined;
-        customPosition: [string, string];
+    import { EditorPropsFromZodSchemas } from "engine/utils/zod/types";
+    export const schemas: Record<string, import("state/types/types").JSONSchema>, zodSchemas: {
+        value: any;
+        widgetParams: any;
     };
-    export type BackgroundImageEditorProps = EditorProps<BackgroundImageEditorValue, {
-        shouldRender?: false | {
-            dropzone?: boolean;
-            editImageButton?: boolean;
-            /** @deprecated Use editImageButton instead */
-            effects?: boolean;
-            moreImages?: boolean;
-            stockImages?: boolean;
-            uploadButton?: boolean;
-            url?: boolean;
-            userUploads?: boolean;
-            options?: false | {
-                containerWidth?: boolean;
-                size?: boolean;
-                repeat?: boolean;
-                position?: boolean;
-            };
-        };
-    }>;
+    export type BackgroundImageEditorProps = EditorPropsFromZodSchemas<typeof zodSchemas>;
 }
 declare module "engine/options/bodies" {
-    import { BackgroundImageEditorValue } from "editor/components/editors/BackgroundImageEditor";
+    import { BackgroundImageEditorProps } from "editor/components/editors/BackgroundImageEditor";
     export type BodyValues = {
         backgroundColor: string;
-        backgroundImage: BackgroundImageEditorValue;
+        backgroundImage: BackgroundImageEditorProps['value'];
         contentWidth: string;
         fontFamily: {
             label: string;

package/package.json

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