@templatical/import-beefree 0.52.1 → 0.54.0

package/dist/index.d.ts

@@ -1,18 +1,37 @@
+type BeeFreeTranslations = Record<string, Record<string, unknown>>;
 /**
  * BeeFree JSON type definitions.
  * Based on the BeeFree export format used by the BEE Plugin / BEE Pro editor.
  */
 interface BeeFreeTemplate {
+  head?: {
+    meta?: {
+      preheader?: string;
+      translations?: BeeFreeTranslations;
+    };
+  };
+  language?: {
+    label?: string;
+    value: string;
+  };
   page: BeeFreeePage;
   comments?: Record<string, unknown>;
 }
 interface BeeFreeePage {
+  language?: {
+    label?: string;
+    value: string;
+  };
   title?: string;
   description?: string;
   rows: BeeFreeeRow[];
   body?: BeeFreeeBody;
 }
 interface BeeFreeeBody {
+  language?: {
+    label?: string;
+    value: string;
+  };
   type?: string;
   webFonts?: BeeFreeeWebFont[];
   content?: {
@@ -50,6 +69,7 @@ interface BeeFreeeColumn {
   modules: BeeFreeeModule[];
 }
 interface BeeFreeeModule {
+  translations?: BeeFreeTranslations;
   type: string;
   locked?: boolean;
   uuid?: string;
@@ -57,7 +77,12 @@ interface BeeFreeeModule {
 }
 interface BeeFreeeModuleDescriptor {
   style?: Record<string, string>;
-  computedStyle?: Record<string, string | boolean>;
+  /**
+   * Values BeeFree computed for the module. Numbers appear in older exports
+   * (`width: 187.5`), and the Icons module nests objects (`iconSpacing`), so
+   * every reader checks the type it needs.
+   */
+  computedStyle?: Record<string, unknown>;
   text?: BeeFreeeTextContent;
   paragraph?: BeeFreeeTextContent;
   heading?: BeeFreeeHeadingContent;
@@ -67,24 +92,33 @@ interface BeeFreeeModuleDescriptor {
   divider?: BeeFreeeeDividerContent;
   spacer?: BeeFreeeSpacerContent;
   html?: BeeFreeeHtmlContent;
-  iconsList?: BeeFreeeSocialContent;
+  /** Social icons for the Social module, icon items for the Icons module. */
+  iconsList?: BeeFreeeSocialContent | BeeFreeeIconsContent;
   video?: BeeFreeeVideoContent;
   menu?: BeeFreeeMenuContent;
   table?: BeeFreeeTableContent;
 }
 interface BeeFreeeTextContent {
+  translations?: BeeFreeTranslations;
   style?: Record<string, string>;
   computedStyle?: Record<string, string>;
   html: string;
 }
 interface BeeFreeeHeadingContent {
+  translations?: BeeFreeTranslations;
   title?: string;
   text?: string;
   style?: Record<string, string>;
 }
 interface BeeFreeeImageContent {
+  translations?: BeeFreeTranslations;
   src: string;
   href?: string;
+  /**
+   * Written by the GIPHY addon: the GIF's page on giphy.com, not a link the
+   * author set. The importer links an image from `href` only.
+   */
+  url?: string;
   alt?: string;
   width?: string;
   height?: string;
@@ -92,6 +126,7 @@ interface BeeFreeeImageContent {
   style?: Record<string, string>;
 }
 interface BeeFreeeButtonContent {
+  translations?: BeeFreeTranslations;
   label: string;
   href?: string;
   style?: Record<string, string>;
@@ -108,6 +143,23 @@ interface BeeFreeeHtmlContent {
 interface BeeFreeeSocialContent {
   icons: BeeFreeeSocialIcon[];
 }
+interface BeeFreeeIconsContent {
+  icons: BeeFreeeIconItem[];
+}
+/** An item of the Icons module (`mailup-bee-newsletter-modules-icons`). */
+interface BeeFreeeIconItem {
+  /** The icon's image URL. */
+  image?: string;
+  alt?: string;
+  title?: string;
+  href?: string;
+  target?: string;
+  text?: string;
+  textPosition?: string;
+  /** The image file's own size, e.g. `"48px"`. */
+  width?: string;
+  height?: string;
+}
 interface BeeFreeeSocialIcon {
   image?: {
     title?: string;
@@ -121,12 +173,15 @@ interface BeeFreeeSocialIcon {
   id?: string;
 }
 interface BeeFreeeVideoContent {
+  thumbAlt?: string;
+  translations?: BeeFreeTranslations;
   src: string;
   thumbnail?: string;
   alt?: string;
   style?: Record<string, string>;
 }
 interface BeeFreeeMenuContent {
+  translations?: BeeFreeTranslations;
   items: BeeFreeeMenuItem[];
   separator?: string;
   separatorColor?: string;
@@ -186,6 +241,10 @@ interface ImportResult {
   content: import("@templatical/types").TemplateContent;
   report: ImportReport;
 }
+interface ConvertBeeFreeOptions {
+  /** Used when the source declares no default language. */
+  defaultLocale?: string;
+}
 /**
  * Converts a BeeFree template JSON to Templatical TemplateContent.
  *
@@ -207,6 +266,6 @@ interface ImportResult {
  * console.log(report.warnings);
  * ```
  */
-export declare function convertBeeFreeTemplate(template: BeeFreeTemplate): ImportResult;
-export type { BeeFreeTemplate, ConversionStatus, ImportReport, ImportReportEntry, ImportResult };
+export declare function convertBeeFreeTemplate(template: BeeFreeTemplate, options?: ConvertBeeFreeOptions): ImportResult;
+export type { BeeFreeTemplate, ConversionStatus, ConvertBeeFreeOptions, ImportReport, ImportReportEntry, ImportResult };
 //# sourceMappingURL=index.d.ts.map