@templatical/import-beefree 0.0.1

package/dist/index.d.cts

@@ -0,0 +1,215 @@
+import * as _templatical_types from '@templatical/types';
+
+/**
+ * BeeFree JSON type definitions.
+ * Based on the BeeFree export format used by the BEE Plugin / BEE Pro editor.
+ */
+interface BeeFreeTemplate {
+    page: BeeFreeePage;
+    comments?: Record<string, unknown>;
+}
+interface BeeFreeePage {
+    title?: string;
+    description?: string;
+    rows: BeeFreeeRow[];
+    body?: BeeFreeeBody;
+}
+interface BeeFreeeBody {
+    type?: string;
+    webFonts?: BeeFreeeWebFont[];
+    content?: {
+        style?: Record<string, string>;
+        computedStyle?: Record<string, string>;
+    };
+    container?: {
+        style?: Record<string, string>;
+    };
+}
+interface BeeFreeeWebFont {
+    name: string;
+    fontFamily?: string;
+    url?: string;
+}
+interface BeeFreeeRow {
+    uuid?: string;
+    type?: string;
+    locked?: boolean;
+    synced?: boolean;
+    empty?: boolean;
+    columns: BeeFreeeColumn[];
+    container?: {
+        style?: Record<string, string>;
+    };
+    content?: {
+        style?: Record<string, string>;
+        computedStyle?: Record<string, string | boolean>;
+    };
+}
+interface BeeFreeeColumn {
+    uuid?: string;
+    "grid-columns"?: number;
+    style?: Record<string, string>;
+    modules: BeeFreeeModule[];
+}
+interface BeeFreeeModule {
+    type: string;
+    locked?: boolean;
+    uuid?: string;
+    descriptor: BeeFreeeModuleDescriptor;
+}
+interface BeeFreeeModuleDescriptor {
+    style?: Record<string, string>;
+    computedStyle?: Record<string, string | boolean>;
+    text?: BeeFreeeTextContent;
+    paragraph?: BeeFreeeTextContent;
+    heading?: BeeFreeeHeadingContent;
+    list?: BeeFreeeTextContent;
+    image?: BeeFreeeImageContent;
+    button?: BeeFreeeButtonContent;
+    divider?: BeeFreeeeDividerContent;
+    spacer?: BeeFreeeSpacerContent;
+    html?: BeeFreeeHtmlContent;
+    iconsList?: BeeFreeeSocialContent;
+    video?: BeeFreeeVideoContent;
+    menu?: BeeFreeeMenuContent;
+    table?: BeeFreeeTableContent;
+}
+interface BeeFreeeTextContent {
+    style?: Record<string, string>;
+    computedStyle?: Record<string, string>;
+    html: string;
+}
+interface BeeFreeeHeadingContent {
+    title?: string;
+    text?: string;
+    style?: Record<string, string>;
+}
+interface BeeFreeeImageContent {
+    src: string;
+    href?: string;
+    alt?: string;
+    width?: string;
+    height?: string;
+    prefix?: string;
+    style?: Record<string, string>;
+}
+interface BeeFreeeButtonContent {
+    label: string;
+    href?: string;
+    style?: Record<string, string>;
+}
+interface BeeFreeeeDividerContent {
+    style?: Record<string, string>;
+}
+interface BeeFreeeSpacerContent {
+    style?: Record<string, string>;
+}
+interface BeeFreeeHtmlContent {
+    html: string;
+}
+interface BeeFreeeSocialContent {
+    icons: BeeFreeeSocialIcon[];
+}
+interface BeeFreeeSocialIcon {
+    image?: {
+        title?: string;
+        src?: string;
+        href?: string;
+        alt?: string;
+    };
+    name?: string;
+    text?: string;
+    type?: string;
+    id?: string;
+}
+interface BeeFreeeVideoContent {
+    src: string;
+    thumbnail?: string;
+    alt?: string;
+    style?: Record<string, string>;
+}
+interface BeeFreeeMenuContent {
+    items: BeeFreeeMenuItem[];
+    separator?: string;
+    separatorColor?: string;
+    style?: Record<string, string>;
+}
+interface BeeFreeeMenuItem {
+    text: string;
+    link?: string;
+    href?: string;
+    target?: string;
+}
+interface BeeFreeeTableContent {
+    rows: BeeFreeeTableRow[];
+    hasHeaderRow?: boolean;
+    headerBackgroundColor?: string;
+    cellPadding?: number | string;
+    style?: Record<string, string>;
+}
+interface BeeFreeeTableRow {
+    cells: BeeFreeeTableCell[];
+}
+interface BeeFreeeTableCell {
+    content?: string;
+    html?: string;
+}
+/**
+ * Conversion status for each module in the import report.
+ */
+type ConversionStatus = "converted" | "approximated" | "html-fallback" | "skipped";
+/**
+ * A single entry in the import report.
+ */
+interface ImportReportEntry {
+    beeFreeModuleType: string;
+    templaticalBlockType: string | null;
+    status: ConversionStatus;
+    note?: string;
+}
+/**
+ * The full import report returned alongside the converted template.
+ */
+interface ImportReport {
+    entries: ImportReportEntry[];
+    warnings: string[];
+    summary: {
+        total: number;
+        converted: number;
+        approximated: number;
+        htmlFallback: number;
+        skipped: number;
+    };
+}
+/**
+ * The result of a BeeFree import operation.
+ */
+interface ImportResult {
+    content: _templatical_types.TemplateContent;
+    report: ImportReport;
+}
+
+/**
+ * Converts a BeeFree template JSON to Templatical TemplateContent.
+ *
+ * @param template - The parsed BeeFree JSON object
+ * @returns An ImportResult with the converted content and a detailed report
+ *
+ * @example
+ * ```ts
+ * import { convertBeeFreeTemplate } from '@templatical/import-beefree';
+ *
+ * const beeFreeJson = JSON.parse(fileContent);
+ * const { content, report } = convertBeeFreeTemplate(beeFreeJson);
+ *
+ * // Use the content with the editor
+ * const editor = init({ container: '#editor', content });
+ *
+ * // Check the report for any issues
+ * console.log(report.summary);
+ * console.log(report.warnings);
+ * ```
+ */
+declare function convertBeeFreeTemplate(template: BeeFreeTemplate): ImportResult;
+
+export { type BeeFreeTemplate, type ConversionStatus, type ImportReport, type ImportReportEntry, type ImportResult, convertBeeFreeTemplate };

package/dist/index.d.ts

@@ -0,0 +1,215 @@
+import * as _templatical_types from '@templatical/types';
+
+/**
+ * BeeFree JSON type definitions.
+ * Based on the BeeFree export format used by the BEE Plugin / BEE Pro editor.
+ */
+interface BeeFreeTemplate {
+    page: BeeFreeePage;
+    comments?: Record<string, unknown>;
+}
+interface BeeFreeePage {
+    title?: string;
+    description?: string;
+    rows: BeeFreeeRow[];
+    body?: BeeFreeeBody;
+}
+interface BeeFreeeBody {
+    type?: string;
+    webFonts?: BeeFreeeWebFont[];
+    content?: {
+        style?: Record<string, string>;
+        computedStyle?: Record<string, string>;
+    };
+    container?: {
+        style?: Record<string, string>;
+    };
+}
+interface BeeFreeeWebFont {
+    name: string;
+    fontFamily?: string;
+    url?: string;
+}
+interface BeeFreeeRow {
+    uuid?: string;
+    type?: string;
+    locked?: boolean;
+    synced?: boolean;
+    empty?: boolean;
+    columns: BeeFreeeColumn[];
+    container?: {
+        style?: Record<string, string>;
+    };
+    content?: {
+        style?: Record<string, string>;
+        computedStyle?: Record<string, string | boolean>;
+    };
+}
+interface BeeFreeeColumn {
+    uuid?: string;
+    "grid-columns"?: number;
+    style?: Record<string, string>;
+    modules: BeeFreeeModule[];
+}
+interface BeeFreeeModule {
+    type: string;
+    locked?: boolean;
+    uuid?: string;
+    descriptor: BeeFreeeModuleDescriptor;
+}
+interface BeeFreeeModuleDescriptor {
+    style?: Record<string, string>;
+    computedStyle?: Record<string, string | boolean>;
+    text?: BeeFreeeTextContent;
+    paragraph?: BeeFreeeTextContent;
+    heading?: BeeFreeeHeadingContent;
+    list?: BeeFreeeTextContent;
+    image?: BeeFreeeImageContent;
+    button?: BeeFreeeButtonContent;
+    divider?: BeeFreeeeDividerContent;
+    spacer?: BeeFreeeSpacerContent;
+    html?: BeeFreeeHtmlContent;
+    iconsList?: BeeFreeeSocialContent;
+    video?: BeeFreeeVideoContent;
+    menu?: BeeFreeeMenuContent;
+    table?: BeeFreeeTableContent;
+}
+interface BeeFreeeTextContent {
+    style?: Record<string, string>;
+    computedStyle?: Record<string, string>;
+    html: string;
+}
+interface BeeFreeeHeadingContent {
+    title?: string;
+    text?: string;
+    style?: Record<string, string>;
+}
+interface BeeFreeeImageContent {
+    src: string;
+    href?: string;
+    alt?: string;
+    width?: string;
+    height?: string;
+    prefix?: string;
+    style?: Record<string, string>;
+}
+interface BeeFreeeButtonContent {
+    label: string;
+    href?: string;
+    style?: Record<string, string>;
+}
+interface BeeFreeeeDividerContent {
+    style?: Record<string, string>;
+}
+interface BeeFreeeSpacerContent {
+    style?: Record<string, string>;
+}
+interface BeeFreeeHtmlContent {
+    html: string;
+}
+interface BeeFreeeSocialContent {
+    icons: BeeFreeeSocialIcon[];
+}
+interface BeeFreeeSocialIcon {
+    image?: {
+        title?: string;
+        src?: string;
+        href?: string;
+        alt?: string;
+    };
+    name?: string;
+    text?: string;
+    type?: string;
+    id?: string;
+}
+interface BeeFreeeVideoContent {
+    src: string;
+    thumbnail?: string;
+    alt?: string;
+    style?: Record<string, string>;
+}
+interface BeeFreeeMenuContent {
+    items: BeeFreeeMenuItem[];
+    separator?: string;
+    separatorColor?: string;
+    style?: Record<string, string>;
+}
+interface BeeFreeeMenuItem {
+    text: string;
+    link?: string;
+    href?: string;
+    target?: string;
+}
+interface BeeFreeeTableContent {
+    rows: BeeFreeeTableRow[];
+    hasHeaderRow?: boolean;
+    headerBackgroundColor?: string;
+    cellPadding?: number | string;
+    style?: Record<string, string>;
+}
+interface BeeFreeeTableRow {
+    cells: BeeFreeeTableCell[];
+}
+interface BeeFreeeTableCell {
+    content?: string;
+    html?: string;
+}
+/**
+ * Conversion status for each module in the import report.
+ */
+type ConversionStatus = "converted" | "approximated" | "html-fallback" | "skipped";
+/**
+ * A single entry in the import report.
+ */
+interface ImportReportEntry {
+    beeFreeModuleType: string;
+    templaticalBlockType: string | null;
+    status: ConversionStatus;
+    note?: string;
+}
+/**
+ * The full import report returned alongside the converted template.
+ */
+interface ImportReport {
+    entries: ImportReportEntry[];
+    warnings: string[];
+    summary: {
+        total: number;
+        converted: number;
+        approximated: number;
+        htmlFallback: number;
+        skipped: number;
+    };
+}
+/**
+ * The result of a BeeFree import operation.
+ */
+interface ImportResult {
+    content: _templatical_types.TemplateContent;
+    report: ImportReport;
+}
+
+/**
+ * Converts a BeeFree template JSON to Templatical TemplateContent.
+ *
+ * @param template - The parsed BeeFree JSON object
+ * @returns An ImportResult with the converted content and a detailed report
+ *
+ * @example
+ * ```ts
+ * import { convertBeeFreeTemplate } from '@templatical/import-beefree';
+ *
+ * const beeFreeJson = JSON.parse(fileContent);
+ * const { content, report } = convertBeeFreeTemplate(beeFreeJson);
+ *
+ * // Use the content with the editor
+ * const editor = init({ container: '#editor', content });
+ *
+ * // Check the report for any issues
+ * console.log(report.summary);
+ * console.log(report.warnings);
+ * ```
+ */
+declare function convertBeeFreeTemplate(template: BeeFreeTemplate): ImportResult;
+
+export { type BeeFreeTemplate, type ConversionStatus, type ImportReport, type ImportReportEntry, type ImportResult, convertBeeFreeTemplate };