@unlayer/types 1.386.0

package/dist/editor/types.d.ts

@@ -0,0 +1,23 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+export type Device = 'desktop' | 'mobile' | 'tablet';
+
+export type Resolution = {
+    value: number;
+    name: string;
+};
+
+export type DisplayMode = 'email' | 'web' | 'popup' | 'document';
+
+export type Variant = 'amp' | null;
+
+export type UndoRedoBehavior = 'save' | 'replace' | 'skip';
+
+export type Collection = 'pages' | 'bodies' | 'rows' | 'headers' | 'footers' | 'columns' | 'contents';
+
+export interface Location {
+    collection: Collection;
+    id: number | string;
+}
+
+export type ExporterName = "email" | "web" | "popup" | "document" | "classic" | "ampWeb" | "ampEmail";

package/dist/editor/utils.d.ts

@@ -0,0 +1,88 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { AppearanceConfig } from './theme';
+import type { Device, DisplayMode, Location, UndoRedoBehavior } from './types';
+
+export interface EditorProps<Value, WidgetParams = object> {
+    value: Value | undefined;
+    defaultValue: Value | undefined;
+    updateValue: (newValue: Value | undefined, data?: object, options?: {
+        deviceOverride?: Device;
+        undoRedoBehavior?: UndoRedoBehavior;
+    }) => void;
+    name: string;
+    /** @deprecated Use widgetParams instead */
+    data?: WidgetParams;
+    disabled?: boolean;
+    isLocked?: boolean;
+    lockReason?: 'styleguide' | 'admin' | undefined;
+    widgetParams?: WidgetParams;
+    deviceName: Device;
+    displayMode: DisplayMode;
+    label?: string;
+    location: Location;
+    values: {
+        [key: string]: unknown;
+        containerPadding?: string;
+    };
+    rootValues: {
+        [key: string]: any;
+        _override?: {
+            [key: string]: any;
+        };
+    };
+    appearance: AppearanceConfig;
+    entitlements: {
+        audit?: boolean;
+        allowedDomains?: number;
+        branding?: boolean;
+        collaboration?: boolean;
+        displayConditions?: boolean;
+        customBlocks?: number;
+        customCSS?: boolean;
+        customFonts?: boolean;
+        customJS?: boolean;
+        customTools?: number;
+        customTabs?: number;
+        customThemes?: boolean;
+        imageEditor?: boolean;
+        selectImage?: boolean;
+        stockImages?: boolean;
+        userUploads?: boolean;
+        uploadMaxSize?: number;
+    };
+    item: {
+        id: string;
+        type?: string;
+        slug?: string;
+        location?: Location;
+        values?: Record<string, any>;
+    };
+    project: object;
+    onImageClick?: (url: string) => void;
+}
+
+export type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
+
+export type LanguageOverride = {
+    [language: string]: {
+        [propertyName: string]: string;
+    };
+};
+
+export type LanguagesValue = {
+    _languages?: LanguageOverride;
+};
+
+// ───────────────────────────────────────────────────────────────────────────
+// Editor Settings
+// ───────────────────────────────────────────────────────────────────────────
+
+export interface OptionGroup<T> {
+    label: string;
+    options: OptionItem<T>[];
+}
+
+export type OptionItem<T> = T | OptionGroup<T>;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './editor/index';
+export * from './containers/index';
+export * from './tools/index';

package/dist/tools/button.d.ts

@@ -0,0 +1,111 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+export type ButtonValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  text?: string;
+  textJson?: string;
+  synced: {
+    id: string;
+    dirty: boolean;
+    updatedAt?: string;
+  };
+  suggestions: never;
+  href: {
+    name: string;
+    attrs?: {
+      [x: string]: unknown;
+      href?: string;
+      target?: string;
+      onClick?: unknown;
+      class?: string;
+      download?: boolean;
+    };
+    values?: Record<string, string | number | {
+      label?: string;
+      value?: string | number;
+    }[]>;
+  };
+  size: {
+    autoWidth?: boolean;
+    width?: number | `${number}px` | `${number}%`;
+  };
+  fontFamily: {
+    label: string;
+    value: string;
+    defaultFont?: boolean;
+    type?: string;
+    url?: string;
+    weights?: (number | {
+      value: number;
+      label?: string;
+    })[];
+  };
+  fontWeight: number | {
+    value: number;
+    label?: string;
+  };
+  buttonColors: {
+    [x: string]: unknown;
+    color?: string;
+    backgroundColor?: string;
+    hoverColor?: string;
+    hoverBackgroundColor?: string;
+  };
+  fontSize: number | `${number}px`;
+  lineHeight: string;
+  letterSpacing: number | `${number}px`;
+  border: {
+    borderBottomColor?: string;
+    borderBottomStyle?: string;
+    borderBottomWidth?: `${number}px`;
+    borderLeftColor?: string;
+    borderLeftStyle?: string;
+    borderLeftWidth?: `${number}px`;
+    borderRightColor?: string;
+    borderRightStyle?: string;
+    borderRightWidth?: `${number}px`;
+    borderTopColor?: string;
+    borderTopStyle?: string;
+    borderTopWidth?: `${number}px`;
+  };
+  padding: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  textAlign: "left" | "center" | "right" | "justify";
+  borderRadius: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+};
+
+import type { BodyValues } from '../containers/body';
+import type { ColumnValues } from '../containers/column';
+import type { ContentValues } from '../containers/content';
+import type { RowValues } from '../containers/row';
+import type { MergeTagsValues } from '../editor/merge-tags';
+
+type ButtonExporter = (
+  renderValues: ContentValues & ButtonValues,
+  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;
+
+export type ButtonExporters = Partial<Record<ExporterName, ButtonExporter>>;

package/dist/tools/carousel.d.ts

@@ -0,0 +1,52 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+export type CarouselValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  [x: string]: unknown;
+  synced: {
+    id: string;
+    dirty: boolean;
+    updatedAt?: string;
+  };
+  showPreviews: boolean;
+  previewWidth: number | `${number}px` | `${number}%` | "auto";
+  autoplay: boolean;
+  loop: boolean;
+};
+
+import type { BodyValues } from '../containers/body';
+import type { ColumnValues } from '../containers/column';
+import type { ContentValues } from '../containers/content';
+import type { RowValues } from '../containers/row';
+import type { MergeTagsValues } from '../editor/merge-tags';
+
+type CarouselExporter = (
+  renderValues: ContentValues & CarouselValues,
+  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;
+
+export type CarouselExporters = Partial<Record<ExporterName, CarouselExporter>>;

package/dist/tools/divider.d.ts

@@ -0,0 +1,54 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+export type DividerValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  synced: {
+    id: string;
+    dirty: boolean;
+    updatedAt?: string;
+  };
+  width: number | `${number}px` | `${number}%`;
+  border: {
+    borderTopColor: string;
+    borderTopStyle: "solid" | "dotted" | "dashed";
+    borderTopWidth: `${number}px`;
+  };
+  textAlign: "left" | "center" | "right" | "justify";
+};
+
+import type { BodyValues } from '../containers/body';
+import type { ColumnValues } from '../containers/column';
+import type { ContentValues } from '../containers/content';
+import type { RowValues } from '../containers/row';
+import type { MergeTagsValues } from '../editor/merge-tags';
+
+type DividerExporter = (
+  renderValues: ContentValues & DividerValues,
+  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;
+
+export type DividerExporters = Partial<Record<ExporterName, DividerExporter>>;

package/dist/tools/form.d.ts

@@ -0,0 +1,159 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+export type FormValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  fieldWidth: string;
+  synced: {
+    id: string;
+    dirty: boolean;
+    updatedAt?: string;
+  };
+  fields: {
+    type?: string;
+    name?: string;
+    label?: string;
+    options?: string[];
+    placeholder_text?: string;
+    show_label?: boolean;
+    required?: boolean;
+    meta_data?: {
+      [x: string]: unknown;
+    };
+  }[];
+  action: {
+    method?: "GET" | "POST";
+    target?: string;
+    url?: string;
+  };
+  fieldBorder: {
+    borderBottomColor?: string;
+    borderBottomStyle?: string;
+    borderBottomWidth?: `${number}px`;
+    borderLeftColor?: string;
+    borderLeftStyle?: string;
+    borderLeftWidth?: `${number}px`;
+    borderRightColor?: string;
+    borderRightStyle?: string;
+    borderRightWidth?: `${number}px`;
+    borderTopColor?: string;
+    borderTopStyle?: string;
+    borderTopWidth?: `${number}px`;
+  };
+  fieldBorderRadius: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  fieldPadding: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  fieldBackgroundColor: string;
+  fieldColor: string;
+  fieldFontFamily: {
+    label: string;
+    value: string;
+    defaultFont?: boolean;
+    type?: string;
+    url?: string;
+    weights?: (number | {
+      value: number;
+      label?: string;
+    })[];
+  };
+  fieldFontSize: number | `${number}px`;
+  formWidth: {
+    autoWidth?: boolean;
+    width?: number | `${number}px` | `${number}%`;
+  };
+  formAlign: "left" | "center" | "right" | "justify";
+  fieldDistance: `${number}px`;
+  placeholderAlign: "left" | "center" | "right" | "justify";
+  labelColor: string;
+  labelFontSize: number | `${number}px`;
+  labelFontFamily: {
+    label: string;
+    value: string;
+    defaultFont?: boolean;
+    type?: string;
+    url?: string;
+    weights?: (number | {
+      value: number;
+      label?: string;
+    })[];
+  };
+  labelAlign: "left" | "center" | "right" | "justify";
+  labelPadding: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  buttonColors: {
+    [x: string]: unknown;
+    color?: string;
+    backgroundColor?: string;
+    hoverColor?: string;
+    hoverBackgroundColor?: string;
+  };
+  buttonText: string | number;
+  buttonAlign: "left" | "center" | "right" | "justify";
+  buttonWidth: {
+    autoWidth?: boolean;
+    width?: number | `${number}px` | `${number}%`;
+  };
+  buttonFontFamily: {
+    label: string;
+    value: string;
+    defaultFont?: boolean;
+    type?: string;
+    url?: string;
+    weights?: (number | {
+      value: number;
+      label?: string;
+    })[];
+  };
+  buttonFontSize: number | `${number}px`;
+  buttonBorder: {
+    borderBottomColor?: string;
+    borderBottomStyle?: string;
+    borderBottomWidth?: `${number}px`;
+    borderLeftColor?: string;
+    borderLeftStyle?: string;
+    borderLeftWidth?: `${number}px`;
+    borderRightColor?: string;
+    borderRightStyle?: string;
+    borderRightWidth?: `${number}px`;
+    borderTopColor?: string;
+    borderTopStyle?: string;
+    borderTopWidth?: `${number}px`;
+  };
+  buttonBorderRadius: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  buttonPadding: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  buttonMargin: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+};
+
+import type { BodyValues } from '../containers/body';
+import type { ColumnValues } from '../containers/column';
+import type { ContentValues } from '../containers/content';
+import type { RowValues } from '../containers/row';
+import type { MergeTagsValues } from '../editor/merge-tags';
+
+type FormExporter = (
+  renderValues: ContentValues & FormValues,
+  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;
+
+export type FormExporters = Partial<Record<ExporterName, FormExporter>>;

package/dist/tools/heading.d.ts

@@ -0,0 +1,79 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+export type HeadingValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  text?: string;
+  textJson?: string;
+  synced: {
+    id: string;
+    dirty: boolean;
+    updatedAt?: string;
+  };
+  suggestions: never;
+  color: string;
+  textAlign: "left" | "center" | "right" | "justify";
+  fontFamily: {
+    label: string;
+    value: string;
+    defaultFont?: boolean;
+    type?: string;
+    url?: string;
+    weights?: (number | {
+      value: number;
+      label?: string;
+    })[];
+  };
+  fontWeight: number | {
+    value: number;
+    label?: string;
+  };
+  fontSize: number | `${number}px`;
+  lineHeight: string;
+  letterSpacing: number | `${number}px`;
+  headingType: "h1" | "h2" | "h3" | "h4";
+  linkStyle: {
+    body?: boolean;
+    inherit?: boolean;
+    linkColor?: string;
+    linkHoverColor?: string;
+    linkUnderline?: boolean;
+    linkHoverUnderline?: boolean;
+  };
+};
+
+import type { BodyValues } from '../containers/body';
+import type { ColumnValues } from '../containers/column';
+import type { ContentValues } from '../containers/content';
+import type { RowValues } from '../containers/row';
+import type { MergeTagsValues } from '../editor/merge-tags';
+
+type HeadingExporter = (
+  renderValues: ContentValues & HeadingValues,
+  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;
+
+export type HeadingExporters = Partial<Record<ExporterName, HeadingExporter>>;

package/dist/tools/html.d.ts

@@ -0,0 +1,48 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+export type HtmlValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  synced: {
+    id: string;
+    dirty: boolean;
+    updatedAt?: string;
+  };
+  html: string;
+};
+
+import type { BodyValues } from '../containers/body';
+import type { ColumnValues } from '../containers/column';
+import type { ContentValues } from '../containers/content';
+import type { RowValues } from '../containers/row';
+import type { MergeTagsValues } from '../editor/merge-tags';
+
+type HtmlExporter = (
+  renderValues: ContentValues & HtmlValues,
+  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;
+
+export type HtmlExporters = Partial<Record<ExporterName, HtmlExporter>>;

package/dist/tools/image.d.ts

@@ -0,0 +1,75 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+export type ImageValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  synced: {
+    id: string;
+    dirty: boolean;
+    updatedAt?: string;
+  };
+  suggestions: never;
+  textAlign: "left" | "center" | "right" | "justify";
+  src: {
+    [x: string]: unknown;
+    url: string;
+    width?: number;
+    height?: number;
+    autoWidth?: boolean;
+    maxWidth?: `${number}%`;
+    optimistic?: boolean;
+    dynamic?: boolean;
+  };
+  altText: string | number;
+  action: {
+    name: string;
+    attrs?: {
+      [x: string]: unknown;
+      href?: string;
+      target?: string;
+      onClick?: unknown;
+      class?: string;
+      download?: boolean;
+    };
+    values?: Record<string, string | number | {
+      label?: string;
+      value?: string | number;
+    }[]>;
+  };
+};
+
+import type { BodyValues } from '../containers/body';
+import type { ColumnValues } from '../containers/column';
+import type { ContentValues } from '../containers/content';
+import type { RowValues } from '../containers/row';
+import type { MergeTagsValues } from '../editor/merge-tags';
+
+type ImageExporter = (
+  renderValues: ContentValues & ImageValues,
+  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;
+
+export type ImageExporters = Partial<Record<ExporterName, ImageExporter>>;