@unlayer/types 1.386.0

package/dist/tools/index.d.ts

@@ -0,0 +1,17 @@
+export type { ToolConfig, ToolsConfig } from '../editor/editor';
+
+export type { ButtonValues, ButtonExporters } from './button';
+export type { CarouselValues, CarouselExporters } from './carousel';
+export type { DividerValues, DividerExporters } from './divider';
+export type { FormValues, FormExporters } from './form';
+export type { HeadingValues, HeadingExporters } from './heading';
+export type { HtmlValues, HtmlExporters } from './html';
+export type { ImageValues, ImageExporters } from './image';
+export type { MenuValues, MenuExporters } from './menu';
+export type { PageBreakValues, PageBreakExporters } from './page-break';
+export type { ParagraphValues, ParagraphExporters } from './paragraph';
+export type { SocialValues, SocialExporters } from './social';
+export type { TableValues, TableExporters } from './table';
+export type { TextValues, TextExporters } from './text';
+export type { TimerValues, TimerExporters } from './timer';
+export type { VideoValues, VideoExporters } from './video';

package/dist/tools/menu.d.ts

@@ -0,0 +1,91 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+export type MenuValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  synced: {
+    id: string;
+    dirty: boolean;
+    updatedAt?: string;
+  };
+  menu: {
+    items?: {
+      key: string;
+      text: string;
+      link?: {
+        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;
+        }[]>;
+      };
+    }[];
+  };
+  linkColor: string;
+  padding: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  fontFamily: {
+    label: string;
+    value: string;
+    defaultFont?: boolean;
+    type?: string;
+    url?: string;
+    weights?: (number | {
+      value: number;
+      label?: string;
+    })[];
+  };
+  fontWeight: number | {
+    value: number;
+    label?: string;
+  };
+  textColor: string;
+  fontSize: number | `${number}px`;
+  letterSpacing: number | `${number}px`;
+  layout: "horizontal" | "vertical";
+  align: "left" | "center" | "right" | "justify";
+  separator: 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 MenuExporter = (
+  renderValues: ContentValues & MenuValues,
+  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 MenuExporters = Partial<Record<ExporterName, MenuExporter>>;

package/dist/tools/page-break.d.ts

@@ -0,0 +1,57 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+export type PageBreakValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  synced: {
+    id: string;
+    dirty: boolean;
+    updatedAt?: string;
+  };
+  displayCondition: {
+    label: string;
+    description: string;
+    type: string;
+    before?: string;
+    after?: string;
+  };
+  color: string;
+  anchor: string;
+  containerPadding: `${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 PageBreakExporter = (
+  renderValues: ContentValues & PageBreakValues,
+  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 PageBreakExporters = Partial<Record<ExporterName, PageBreakExporter>>;

package/dist/tools/paragraph.d.ts

@@ -0,0 +1,76 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+export type ParagraphValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  textJson: string;
+  synced: {
+    id: string;
+    dirty: boolean;
+    updatedAt?: string;
+  };
+  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`;
+  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 ParagraphExporter = (
+  renderValues: ContentValues & ParagraphValues,
+  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 ParagraphExporters = Partial<Record<ExporterName, ParagraphExporter>>;

package/dist/tools/social.d.ts

@@ -0,0 +1,58 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+export type SocialValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  synced: {
+    id: string;
+    dirty: boolean;
+    updatedAt?: string;
+  };
+  icons: {
+    iconType: string;
+    icons: {
+      name: string;
+      url: string;
+      imgUrl?: string;
+    }[];
+  };
+  spacing: number | `${number}px` | `${number}%` | "auto";
+  align: "left" | "center" | "right" | "justify";
+  iconSize: number | `${number}px` | `${number}%` | "auto";
+};
+
+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 SocialExporter = (
+  renderValues: ContentValues & SocialValues,
+  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 SocialExporters = Partial<Record<ExporterName, SocialExporter>>;

package/dist/tools/table.d.ts

@@ -0,0 +1,178 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+export type TableValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  table: {
+    headers: {
+      cells: {
+        text: string;
+        width: number;
+      }[];
+      height: number;
+    }[];
+    rows: {
+      cells: {
+        text: string;
+        width: number;
+      }[];
+      height: number;
+    }[];
+    footers: {
+      cells: {
+        text: string;
+        width: number;
+      }[];
+      height: number;
+    }[];
+  };
+  cellBackgroundColor: {
+    property: "color" | "backgroundColor" | "padding" | "textAlign" | "verticalAlign";
+    selectedCellId?: string;
+  };
+  cellColor: {
+    property: "color" | "backgroundColor" | "padding" | "textAlign" | "verticalAlign";
+    selectedCellId?: string;
+  };
+  cellTextAlign: {
+    property: "color" | "backgroundColor" | "padding" | "textAlign" | "verticalAlign";
+    selectedCellId?: string;
+  };
+  cellVerticalAlign: {
+    property: "color" | "backgroundColor" | "padding" | "textAlign" | "verticalAlign";
+    selectedCellId?: string;
+  };
+  cellPadding: {
+    property: "color" | "backgroundColor" | "padding" | "textAlign" | "verticalAlign";
+    selectedCellId?: string;
+  };
+  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`;
+  };
+  columns: number | `${number}px` | `${number}%` | "auto";
+  rows: number | `${number}px` | `${number}%` | "auto";
+  stripedRows: boolean;
+  stripedRowsBackgroundColor: string;
+  enableHeader: boolean;
+  headerFontFamily: {
+    label: string;
+    value: string;
+    defaultFont?: boolean;
+    type?: string;
+    url?: string;
+    weights?: (number | {
+      value: number;
+      label?: string;
+    })[];
+  };
+  headerBackgroundColor: string;
+  headerFontWeight: number | {
+    value: number;
+    label?: string;
+  };
+  headerFontSize: number | `${number}px`;
+  headerColor: string;
+  headerTextAlign: "left" | "center" | "right" | "justify";
+  headerVerticalAlign: "top" | "middle" | "bottom";
+  headerPadding: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  contentVerticalAlign: "top" | "middle" | "bottom";
+  contentFontFamily: {
+    label: string;
+    value: string;
+    defaultFont?: boolean;
+    type?: string;
+    url?: string;
+    weights?: (number | {
+      value: number;
+      label?: string;
+    })[];
+  };
+  contentBackgroundColor: string;
+  contentFontWeight: number | {
+    value: number;
+    label?: string;
+  };
+  contentFontSize: number | `${number}px`;
+  contentColor: string;
+  contentTextAlign: "left" | "center" | "right" | "justify";
+  contentLineHeight: string;
+  contentLetterSpacing: number | `${number}px`;
+  contentPadding: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  enableFooter: boolean;
+  footerFontFamily: {
+    label: string;
+    value: string;
+    defaultFont?: boolean;
+    type?: string;
+    url?: string;
+    weights?: (number | {
+      value: number;
+      label?: string;
+    })[];
+  };
+  footerBackgroundColor: string;
+  footerFontWeight: number | {
+    value: number;
+    label?: string;
+  };
+  footerFontSize: number | `${number}px`;
+  footerColor: string;
+  footerTextAlign: "left" | "center" | "right" | "justify";
+  footerVerticalAlign: "top" | "middle" | "bottom";
+  footerPadding: `${number}px` | `${number}px ${number}px` | `${number}px ${number}px ${number}px` | `${number}px ${number}px ${number}px ${number}px`;
+  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 TableExporter = (
+  renderValues: ContentValues & TableValues,
+  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 TableExporters = Partial<Record<ExporterName, TableExporter>>;

package/dist/tools/text.d.ts

@@ -0,0 +1,76 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+export type TextValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  text: string;
+  synced: {
+    id: string;
+    dirty: boolean;
+    updatedAt?: string;
+  };
+  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`;
+  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 TextExporter = (
+  renderValues: ContentValues & TextValues,
+  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 TextExporters = Partial<Record<ExporterName, TextExporter>>;

package/dist/tools/timer.d.ts

@@ -0,0 +1,87 @@
+// Auto-generated by build-values-types.js. Do not edit manually.
+
+import type { DisplayMode, ExporterName } from '../editor/types';
+
+export type TimerValues<
+  TDisplayMode extends DisplayMode | undefined = undefined,
+> = {
+  synced: {
+    id: string;
+    dirty: boolean;
+    updatedAt?: string;
+  };
+  countdown: {
+    endTime: string;
+    backgroundColor: string;
+    digitColor: string;
+    labelColor: string;
+    labelFontSize: number;
+    digitFontSize: number;
+    labelFontFamily: string;
+    digitFontFamily: string;
+    timezone: string;
+    showLabels: boolean;
+    id?: string;
+    locale?: string;
+    countdownUrl?: string;
+    width?: number;
+    height?: number;
+    refreshedAt?: number;
+    loading?: boolean;
+  };
+  width: {
+    autoWidth?: boolean;
+    width?: number | `${number}px` | `${number}%`;
+  };
+  textAlign: "left" | "center" | "right" | "justify";
+  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 TimerExporter = (
+  renderValues: ContentValues & TimerValues,
+  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 TimerExporters = Partial<Record<ExporterName, TimerExporter>>;