@unlayer/types 1.386.0

package/dist/containers/body.d.ts

@@ -0,0 +1,162 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+type BodyValuesBase = {
+  _styleGuide: string;
+  contentWidth: number | `${number}px` | `${number}%` | "auto";
+  fontFamily: {
+    label: string;
+    value: string;
+    defaultFont?: boolean;
+    type?: string;
+    url?: string;
+    weights?: (number | {
+      value: number;
+      label?: string;
+    })[];
+  };
+  textColor: string;
+  language: any;
+  linkStyle: {
+    body?: boolean;
+    inherit?: boolean;
+    linkColor?: string;
+    linkHoverColor?: string;
+    linkUnderline?: boolean;
+    linkHoverUnderline?: boolean;
+  };
+  _meta: {
+    htmlID?: string;
+    htmlClassNames?: string;
+    labels?: string[];
+    description?: string;
+  };
+};
+
+type BodyValuesForEmail = BodyValuesBase & {
+  backgroundColor: string;
+  contentAlign: "left" | "center" | "right" | "justify";
+  fontWeight: number | {
+    value: number;
+    label?: string;
+  };
+  preheaderText: string | number;
+  accessibilityTitle: string | number;
+};
+
+type BodyValuesForWeb = BodyValuesBase & {
+  backgroundColor: string;
+  contentAlign: "left" | "center" | "right" | "justify";
+  fontWeight: number | {
+    value: number;
+    label?: string;
+  };
+  backgroundImage: {
+    [x: string]: unknown;
+    url: string;
+    width?: number;
+    height?: number;
+    fullWidth?: boolean;
+    size?: "custom" | "contain" | "cover";
+    customSize?: [string?, string?, ...unknown[]];
+    repeat?: "repeat" | "no-repeat" | "repeat-x" | "repeat-y";
+    position?: "custom" | "center" | "top-left" | "top-center" | "top-right" | "center-left" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right";
+    customPosition?: [string?, string?, ...unknown[]];
+  };
+  accessibilityTitle: string | number;
+};
+
+type BodyValuesForPopup = BodyValuesBase & {
+  popupPosition: "custom" | "center" | "top-left" | "top-center" | "top-right" | "center-left" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right";
+  popupDisplayDelay: number | `${number}px` | `${number}%` | "auto";
+  popupWidth: number | `${number}px` | `${number}%` | "auto";
+  popupHeight: number | `${number}px` | `${number}%` | "auto";
+  borderRadius: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  contentAlign: "left" | "center" | "right";
+  contentVerticalAlign: "top" | "middle" | "bottom";
+  fontWeight: number | {
+    value: number;
+    label?: string;
+  };
+  popupBackgroundColor: string;
+  popupBackgroundImage: {
+    [x: string]: unknown;
+    url: string;
+    width?: number;
+    height?: number;
+    fullWidth?: boolean;
+    size?: "custom" | "contain" | "cover";
+    customSize?: [string?, string?, ...unknown[]];
+    repeat?: "repeat" | "no-repeat" | "repeat-x" | "repeat-y";
+    position?: "custom" | "center" | "top-left" | "top-center" | "top-right" | "center-left" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right";
+    customPosition?: [string?, string?, ...unknown[]];
+  };
+  popupOverlay_backgroundColor: string;
+  popupCloseButton_position: "custom" | "center" | "top-left" | "top-center" | "top-right" | "center-left" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right";
+  popupCloseButton_backgroundColor: string;
+  popupCloseButton_iconColor: string;
+  popupCloseButton_borderRadius: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  popupCloseButton_margin: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  popupCloseButton_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;
+    }[]>;
+  };
+};
+
+type BodyValuesForDocument = BodyValuesBase & {
+  backgroundColor: string;
+  contentAlign: "left" | "center" | "right" | "justify";
+  backgroundImage: {
+    [x: string]: unknown;
+    url: string;
+    width?: number;
+    height?: number;
+    fullWidth?: boolean;
+    size?: "custom" | "contain" | "cover";
+    customSize?: [string?, string?, ...unknown[]];
+    repeat?: "repeat" | "no-repeat" | "repeat-x" | "repeat-y";
+    position?: "custom" | "center" | "top-left" | "top-center" | "top-right" | "center-left" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right";
+    customPosition?: [string?, string?, ...unknown[]];
+  };
+};
+
+export type BodyValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> =
+  TDisplayMode extends undefined
+    ? BodyValuesForEmail & BodyValuesForWeb & BodyValuesForPopup & BodyValuesForDocument
+    : TDisplayMode extends 'email'
+      ? BodyValuesForEmail
+    : TDisplayMode extends 'web'
+      ? BodyValuesForWeb
+    : TDisplayMode extends 'popup'
+      ? BodyValuesForPopup
+    : TDisplayMode extends 'document'
+      ? BodyValuesForDocument
+      : never;
+
+import type { Variant } from '../editor/types';
+
+type BodyExporter = (
+  innerHTML: string,
+  bodyValues: Record<string, any>, // @deprecated use last param instead
+  meta: {
+    bodyValues: BodyValues;
+    type: string;
+    variant: Variant;
+  },
+) => string;
+
+export type BodyExporters = Partial<Record<ExporterName, BodyExporter>>;

package/dist/containers/column.d.ts

@@ -0,0 +1,85 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+type ColumnValuesBase = {
+  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`;
+  };
+  backgroundColor: string;
+  padding: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  _meta: {
+    htmlID?: string;
+    htmlClassNames?: string;
+    labels?: string[];
+    description?: string;
+  };
+  deletable: boolean;
+  locked: boolean;
+};
+
+type ColumnValuesForEmail = ColumnValuesBase;
+
+type ColumnValuesForWeb = ColumnValuesBase & {
+  borderRadius: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+};
+
+type ColumnValuesForPopup = ColumnValuesBase & {
+  borderRadius: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+};
+
+type ColumnValuesForDocument = ColumnValuesBase & {
+  borderRadius: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+};
+
+export type ColumnValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> =
+  TDisplayMode extends undefined
+    ? ColumnValuesForEmail & ColumnValuesForWeb & ColumnValuesForPopup & ColumnValuesForDocument
+    : TDisplayMode extends 'email'
+      ? ColumnValuesForEmail
+    : TDisplayMode extends 'web'
+      ? ColumnValuesForWeb
+    : TDisplayMode extends 'popup'
+      ? ColumnValuesForPopup
+    : TDisplayMode extends 'document'
+      ? ColumnValuesForDocument
+      : never;
+
+import type { BodyValues } from '../containers/body';
+import type { RowValues } from '../containers/row';
+import type { Variant } from '../editor/types';
+
+type ColumnExporter = (
+  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: BodyValues, // @deprecated use last param instead
+  rowValues: RowValues, // @deprecated use last param instead
+  meta: {
+    columnIndex: number;
+    columnValues: ColumnValues;
+    rowIndex: number;
+    rowCells: number[];
+    rowValues: RowValues;
+    bodyValues: BodyValues;
+
+    variant: Variant;
+    language: string;
+  },
+) => string;
+
+export type ColumnExporters = Partial<Record<ExporterName, ColumnExporter>>;

package/dist/containers/content.d.ts

@@ -0,0 +1,62 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+export type ContentValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  displayCondition: {
+    label: string;
+    description: string;
+    type: string;
+    before?: string;
+    after?: string;
+  };
+  _styleGuide: string;
+  anchor: string;
+  containerPadding: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  _meta: {
+    htmlID?: string;
+    htmlClassNames?: string;
+    labels?: string[];
+    description?: string;
+  };
+  deletable: boolean;
+  locked: boolean;
+  selectable: boolean;
+  draggable: boolean;
+  duplicatable: boolean;
+  hideable: boolean;
+};
+
+import type { BodyValues } from '../containers/body';
+import type { ColumnValues } from '../containers/column';
+import type { RowValues } from '../containers/row';
+import type { MergeTagsValues } from '../editor/merge-tags';
+import type { Variant } from '../editor/types';
+
+type ContentExporter = (
+  innerHTML: string,
+  contentValues: Record<string, any>, // @deprecated use last param instead
+  bodyValues: BodyValues, // @deprecated use last param instead
+  meta: {
+    index: number;
+    columnIndex: number;
+    columnValues: ColumnValues;
+    rowIndex: number;
+    rowCells: number[];
+    rowValues: RowValues;
+    bodyValues: BodyValues;
+
+    variant: Variant | undefined;
+    language: string | undefined;
+    embeddedValues: Record<string, unknown>;
+    mergeTagState: {
+      mergeTagGroup: string;
+      mergeTagRule: string;
+      mergeTags: MergeTagsValues;
+    };
+  },
+) => string;
+
+export type ContentExporters = Partial<Record<ExporterName, ContentExporter>>;

package/dist/containers/footer.d.ts

@@ -0,0 +1,79 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode } from '../editor/types';
+
+type FooterValuesBase = {
+  [x: string]: unknown;
+  sync: {
+    id: string;
+    dirty: boolean;
+    updatedAt?: string;
+  };
+  displayCondition: {
+    label: string;
+    description: string;
+    type: string;
+    before?: string;
+    after?: string;
+  };
+  columns: any;
+  _styleGuide: string;
+  anchor: string;
+  backgroundColor: string;
+  padding: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  backgroundImage: {
+    [x: string]: unknown;
+    url: string;
+    width?: number;
+    height?: number;
+    fullWidth?: boolean;
+    size?: "custom" | "contain" | "cover";
+    customSize?: [string?, string?, ...unknown[]];
+    repeat?: "repeat" | "no-repeat" | "repeat-x" | "repeat-y";
+    position?: "custom" | "center" | "top-left" | "top-center" | "top-right" | "center-left" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right";
+    customPosition?: [string?, string?, ...unknown[]];
+  };
+  columnsBackgroundColor: string;
+  noStackMobile: boolean;
+  _meta: {
+    htmlID?: string;
+    htmlClassNames?: string;
+    labels?: string[];
+    description?: string;
+  };
+  deletable: boolean;
+  locked: boolean;
+  selectable: boolean;
+  draggable: boolean;
+  duplicatable: boolean;
+  hideable: boolean;
+};
+
+type FooterValuesForEmail = FooterValuesBase;
+
+type FooterValuesForWeb = FooterValuesBase & {
+  alignItems: "center" | "flex-start" | "flex-end";
+};
+
+type FooterValuesForPopup = FooterValuesBase & {
+  alignItems: "center" | "flex-start" | "flex-end";
+};
+
+type FooterValuesForDocument = FooterValuesBase & {
+  alignItems: "center" | "flex-start" | "flex-end";
+};
+
+export type FooterValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> =
+  TDisplayMode extends undefined
+    ? FooterValuesForEmail & FooterValuesForWeb & FooterValuesForPopup & FooterValuesForDocument
+    : TDisplayMode extends 'email'
+      ? FooterValuesForEmail
+    : TDisplayMode extends 'web'
+      ? FooterValuesForWeb
+    : TDisplayMode extends 'popup'
+      ? FooterValuesForPopup
+    : TDisplayMode extends 'document'
+      ? FooterValuesForDocument
+      : never;

package/dist/containers/header.d.ts

@@ -0,0 +1,79 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode } from '../editor/types';
+
+type HeaderValuesBase = {
+  [x: string]: unknown;
+  sync: {
+    id: string;
+    dirty: boolean;
+    updatedAt?: string;
+  };
+  displayCondition: {
+    label: string;
+    description: string;
+    type: string;
+    before?: string;
+    after?: string;
+  };
+  columns: any;
+  _styleGuide: string;
+  anchor: string;
+  backgroundColor: string;
+  padding: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  backgroundImage: {
+    [x: string]: unknown;
+    url: string;
+    width?: number;
+    height?: number;
+    fullWidth?: boolean;
+    size?: "custom" | "contain" | "cover";
+    customSize?: [string?, string?, ...unknown[]];
+    repeat?: "repeat" | "no-repeat" | "repeat-x" | "repeat-y";
+    position?: "custom" | "center" | "top-left" | "top-center" | "top-right" | "center-left" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right";
+    customPosition?: [string?, string?, ...unknown[]];
+  };
+  columnsBackgroundColor: string;
+  noStackMobile: boolean;
+  _meta: {
+    htmlID?: string;
+    htmlClassNames?: string;
+    labels?: string[];
+    description?: string;
+  };
+  deletable: boolean;
+  locked: boolean;
+  selectable: boolean;
+  draggable: boolean;
+  duplicatable: boolean;
+  hideable: boolean;
+};
+
+type HeaderValuesForEmail = HeaderValuesBase;
+
+type HeaderValuesForWeb = HeaderValuesBase & {
+  alignItems: "center" | "flex-start" | "flex-end";
+};
+
+type HeaderValuesForPopup = HeaderValuesBase & {
+  alignItems: "center" | "flex-start" | "flex-end";
+};
+
+type HeaderValuesForDocument = HeaderValuesBase & {
+  alignItems: "center" | "flex-start" | "flex-end";
+};
+
+export type HeaderValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> =
+  TDisplayMode extends undefined
+    ? HeaderValuesForEmail & HeaderValuesForWeb & HeaderValuesForPopup & HeaderValuesForDocument
+    : TDisplayMode extends 'email'
+      ? HeaderValuesForEmail
+    : TDisplayMode extends 'web'
+      ? HeaderValuesForWeb
+    : TDisplayMode extends 'popup'
+      ? HeaderValuesForPopup
+    : TDisplayMode extends 'document'
+      ? HeaderValuesForDocument
+      : never;

package/dist/containers/index.d.ts

@@ -0,0 +1,6 @@
+export type { BodyValues, BodyExporters } from './body';
+export type { ColumnValues, ColumnExporters } from './column';
+export type { ContentValues, ContentExporters } from './content';
+export type { FooterValues } from './footer';
+export type { HeaderValues } from './header';
+export type { RowValues, RowExporters } from './row';

package/dist/containers/row.d.ts

@@ -0,0 +1,100 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+type RowValuesBase = {
+  [x: string]: unknown;
+  sync: {
+    id: string;
+    dirty: boolean;
+    updatedAt?: string;
+  };
+  displayCondition: {
+    label: string;
+    description: string;
+    type: string;
+    before?: string;
+    after?: string;
+  };
+  columns: any;
+  _styleGuide: string;
+  anchor: string;
+  backgroundColor: string;
+  padding: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  backgroundImage: {
+    [x: string]: unknown;
+    url: string;
+    width?: number;
+    height?: number;
+    fullWidth?: boolean;
+    size?: "custom" | "contain" | "cover";
+    customSize?: [string?, string?, ...unknown[]];
+    repeat?: "repeat" | "no-repeat" | "repeat-x" | "repeat-y";
+    position?: "custom" | "center" | "top-left" | "top-center" | "top-right" | "center-left" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right";
+    customPosition?: [string?, string?, ...unknown[]];
+  };
+  columnsBackgroundColor: string;
+  noStackMobile: boolean;
+  _meta: {
+    htmlID?: string;
+    htmlClassNames?: string;
+    labels?: string[];
+    description?: string;
+  };
+  deletable: boolean;
+  locked: boolean;
+  selectable: boolean;
+  draggable: boolean;
+  duplicatable: boolean;
+  hideable: boolean;
+};
+
+type RowValuesForEmail = RowValuesBase;
+
+type RowValuesForWeb = RowValuesBase & {
+  alignItems: "center" | "flex-start" | "flex-end";
+};
+
+type RowValuesForPopup = RowValuesBase & {
+  alignItems: "center" | "flex-start" | "flex-end";
+};
+
+type RowValuesForDocument = RowValuesBase & {
+  alignItems: "center" | "flex-start" | "flex-end";
+};
+
+export type RowValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> =
+  TDisplayMode extends undefined
+    ? RowValuesForEmail & RowValuesForWeb & RowValuesForPopup & RowValuesForDocument
+    : TDisplayMode extends 'email'
+      ? RowValuesForEmail
+    : TDisplayMode extends 'web'
+      ? RowValuesForWeb
+    : TDisplayMode extends 'popup'
+      ? RowValuesForPopup
+    : TDisplayMode extends 'document'
+      ? RowValuesForDocument
+      : never;
+
+import type { BodyValues } from '../containers/body';
+import type { Collection, Variant } from '../editor/types';
+
+type RowExporter = (
+  innerHTML: string,
+  rowValues: RowValues, // @deprecated use last param instead
+  bodyValues: BodyValues, // @deprecated use last param instead
+  meta: {
+    rowIndex: number;
+    rowCells: number[];
+    rowValues: RowValues;
+    bodyValues: BodyValues;
+
+    variant: Variant | undefined;
+    language: string | undefined;
+    collection: Collection;
+  },
+) => string;
+
+export type RowExporters = Partial<Record<ExporterName, RowExporter>>;

package/dist/design.d.ts

@@ -0,0 +1,102 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+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 { ButtonValues } from './tools/button';
+import type { CarouselValues } from './tools/carousel';
+import type { DividerValues } from './tools/divider';
+import type { FormValues } from './tools/form';
+import type { HeadingValues } from './tools/heading';
+import type { HtmlValues } from './tools/html';
+import type { ImageValues } from './tools/image';
+import type { MenuValues } from './tools/menu';
+import type { PageBreakValues } from './tools/page-break';
+import type { ParagraphValues } from './tools/paragraph';
+import type { SocialValues } from './tools/social';
+import type { TableValues } from './tools/table';
+import type { TextValues } from './tools/text';
+import type { TimerValues } from './tools/timer';
+import type { VideoValues } from './tools/video';
+
+interface ContentToolValuesMap<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> {
+  button: ButtonValues<TDisplayMode>;
+  carousel: CarouselValues<TDisplayMode>;
+  divider: DividerValues<TDisplayMode>;
+  form: FormValues<TDisplayMode>;
+  heading: HeadingValues<TDisplayMode>;
+  html: HtmlValues<TDisplayMode>;
+  image: ImageValues<TDisplayMode>;
+  menu: MenuValues<TDisplayMode>;
+  page_break: PageBreakValues<TDisplayMode>;
+  paragraph: ParagraphValues<TDisplayMode>;
+  social: SocialValues<TDisplayMode>;
+  table: TableValues<TDisplayMode>;
+  text: TextValues<TDisplayMode>;
+  timer: TimerValues<TDisplayMode>;
+  video: VideoValues<TDisplayMode>;
+}
+import type { DisplayMode } from './editor/types';
+
+export type { DisplayMode };
+
+type DesignContentItemOf<
+  TType extends string,
+  TValues,
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  id?: string;
+  type: TType;
+  values: TValues & ContentValues<TDisplayMode>;
+};
+
+export type DesignContentType = keyof ContentToolValuesMap | (string & {});
+
+export type DesignContentItem<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  [K in keyof ContentToolValuesMap<TDisplayMode>]: DesignContentItemOf<
+    K,
+    ContentToolValuesMap<TDisplayMode>[K],
+    TDisplayMode
+  >;
+}[keyof ContentToolValuesMap<TDisplayMode>];
+
+export type DesignColumn<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  id?: string;
+  contents: DesignContentItem<TDisplayMode>[];
+  values: ColumnValues<TDisplayMode>;
+};
+
+export type DesignRow<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  id?: string;
+  cells: number[];
+  columns: DesignColumn<TDisplayMode>[];
+  values: RowValues<TDisplayMode>;
+};
+
+export type DesignBody<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  id?: string;
+  rows: DesignRow<TDisplayMode>[];
+  values: BodyValues<TDisplayMode>;
+};
+
+export type JSONTemplate<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  counters: Record<string, number>;
+  body: DesignBody<TDisplayMode> & {
+    headers?: DesignRow<TDisplayMode>[];
+    footers?: DesignRow<TDisplayMode>[];
+  };
+  schemaVersion?: number;
+};