@marlinjai/email-editor-core 0.2.0

package/dist/server.d.mts

@@ -0,0 +1,341 @@
+import { E as EmailTemplate, y as CompileResult, a4 as TemplateInstance } from './TemplateModel-v__r5Nvi.mjs';
+import 'mobx-state-tree';
+
+/** The `<mj-attributes>` a document gets unless it brings its own (`metadata.mjmlHead.attributes`). */
+declare const DEFAULT_MJML_ATTRIBUTES = "\n        <mj-all font-family=\"Georgia, serif\" />\n        <mj-text font-size=\"14px\" line-height=\"1.6\" />\n      ";
+/** Marks the editor's own raw markup so the MJML import can read the block back exactly. */
+declare const EDITOR_DATA_ATTRIBUTE: {
+    readonly social: "data-ee-social";
+    readonly subColumns: "data-ee-subcols";
+};
+/** A block's (or sub-columns') JSON, base64-encoded, for an {@link EDITOR_DATA_ATTRIBUTE}. */
+declare function encodeEditorData(value: unknown): string;
+/** Options for one {@link MJMLCompiler.compile} call. */
+interface CompileOptions {
+    /**
+     * MJML adds a Google Fonts `<link>` and `@import` on its own whenever a font
+     * family it knows (Open Sans, Droid Sans, Lato, Roboto, Ubuntu) appears in
+     * the document. `false` leaves them out, so the font falls back to the rest
+     * of its stack and the mail loads nothing from Google. Fonts the document
+     * declares itself (`metadata.fonts`) are always emitted. Default `true`.
+     */
+    webFonts?: boolean;
+}
+/**
+ * MJML Compiler class
+ * Converts EmailTemplate to MJML markup and compiles to HTML
+ */
+declare class MJMLCompiler {
+    /**
+     * Set true while emitting a column with sub-columns. Causes generateHead
+     * to inject the responsive media query exactly once per template.
+     */
+    private needsSubColumnStyles;
+    /**
+     * Compile email template to MJML and HTML
+     */
+    compile(template: EmailTemplate, options?: CompileOptions): CompileResult;
+    /**
+     * The MJML markup for a document, without compiling it to HTML.
+     */
+    toMJML(template: EmailTemplate): string;
+    /**
+     * Convert template to MJML markup
+     */
+    private templateToMJML;
+    /**
+     * Generate MJML head section with all head components
+     * Supports: mj-title, mj-preview, mj-font, mj-breakpoint, mj-style
+     */
+    private generateHead;
+    /**
+     * Collect background-image CSS rules for all wrappers, sections and columns that have gradients.
+     * Returns a string of CSS rules to inject as a single mj-style block.
+     */
+    private collectGradientStyles;
+    /**
+     * Convert a wrapper to an `<mj-wrapper>` around its sections. The wrapper's
+     * attributes are MJML's own for `mj-wrapper`; the sections inside follow
+     * MJML's rules there (a full-width section inside a full-width wrapper
+     * renders at standard width, which the inspector explains).
+     */
+    private wrapperToMJML;
+    /** Background attributes shared by sections and wrappers: a gradient (with its Outlook fallback colour), or colour and image. */
+    private pushBackground;
+    /**
+     * Convert section to MJML
+     * Supports background images, full-width, and mj-group for non-stacking columns
+     */
+    private sectionToMJML;
+    /**
+     * Convert column to MJML
+     */
+    private columnToMJML;
+    /**
+     * Emit a group column as an mj-column wrapping a hand-built nested
+     * table inside an mj-raw island. The parent mj-section structure
+     * stays standard MJML; only the nested area escapes MJML's parser.
+     *
+     * The responsive media query (table.ee-sub-cols td.ee-sub-col) is
+     * injected once at document head via generateHead when the
+     * needsSubColumnStyles flag is set.
+     */
+    private subColumnsToMJML;
+    /**
+     * Convert block to MJML based on type
+     */
+    private blockToMJML;
+    /**
+     * Convert text block to MJML
+     *
+     * Note: MJML applies styles to the container <td>, but TipTap content
+     * (wrapped in <p> tags) doesn't inherit these styles. We solve this by
+     * wrapping the content in a <div> with explicit inline styles.
+     */
+    private textBlockToMJML;
+    /**
+     * Convert image block to MJML
+     */
+    private imageBlockToMJML;
+    /**
+     * Convert button block to MJML
+     */
+    private buttonBlockToMJML;
+    /**
+     * Convert divider block to MJML
+     */
+    private dividerBlockToMJML;
+    /**
+     * Convert spacer block to MJML
+     */
+    private spacerBlockToMJML;
+    /**
+     * Platform brand colors for social icons
+     */
+    private readonly SOCIAL_COLORS;
+    /**
+     * Get white SVG icon as data URI for a platform
+     * Uses clean, minimal SVGs optimized for email
+     */
+    private getSocialIconDataUri;
+    /**
+     * Convert social block to MJML using raw HTML table for reliable horizontal layout
+     * Uses styled anchor tags with background colors for full width control
+     */
+    private socialBlockToMJML;
+    /**
+     * Convert hero block to MJML
+     */
+    private heroBlockToMJML;
+    /**
+     * Convert accordion block to MJML
+     */
+    private accordionBlockToMJML;
+    /**
+     * Convert raw HTML block to MJML
+     */
+    private rawBlockToMJML;
+    /**
+     * Convert navbar block to MJML
+     */
+    private navbarBlockToMJML;
+    /**
+     * Convert carousel block to MJML
+     */
+    private carouselBlockToMJML;
+    /**
+     * Convert table block to MJML
+     */
+    private tableBlockToMJML;
+    /**
+     * Generate the locked header block.
+     *
+     * It used to render one client's company name and a logo from an image host;
+     * both are gone. What is left is a placeholder image slot. Keep this in step
+     * with `headerBlockDefinition` in `packages/blocks/src/branded/index.ts`:
+     * which of the two runs depends on how the registry is configured.
+     *
+     * The placeholder is a `data:` URI rather than an address on an image host,
+     * so a workspace whose `asset_policy` is `service_only` can still send a mail
+     * that contains this block.
+     */
+    private headerBlockToMJML;
+    /**
+     * Generate the locked footer block: the unsubscribe link and nothing else.
+     *
+     * It used to carry a copyright line naming one client's company. A locked
+     * block carries no props, so whoever sends the mail cannot correct a name
+     * that is not theirs; the line is gone rather than replaced with a fake one.
+     * Keep this in step with `footerBlockDefinition` in
+     * `packages/blocks/src/branded/index.ts`.
+     */
+    private footerBlockToMJML;
+}
+/**
+ * Create a new MJML compiler instance
+ */
+declare function createMJMLCompiler(): MJMLCompiler;
+
+/**
+ * MJML Exporter - Converts a live MST template to MJML/HTML
+ *
+ * This exporter is called ONLY when the user clicks Export/Send,
+ * NOT during editing. This separation is key to achieving instant
+ * visual feedback during editing.
+ *
+ * It compiles the store's snapshot with `MJMLCompiler`, the one compiler the
+ * editor has, so an export from the store and a compile of the saved document
+ * give the same mail (wrappers, sub-columns, kept attributes and all).
+ *
+ * IMPORTANT: This file should only be imported on the server side
+ * as it uses the mjml package which is not browser-safe.
+ */
+
+/**
+ * Result of MJML export
+ */
+interface ExportResult {
+    /** Raw MJML markup */
+    mjml: string;
+    /** Compiled HTML */
+    html: string;
+    /** Any compilation errors */
+    errors?: string[];
+}
+/**
+ * Export options
+ */
+interface ExportOptions {
+    /** MJML validation level */
+    validationLevel?: 'strict' | 'soft' | 'skip';
+    /** Minify output HTML */
+    minify?: boolean;
+    /** Add beautiful comments for debugging */
+    beautify?: boolean;
+}
+/**
+ * MJMLExporter - Exports MST template to MJML and HTML
+ */
+declare class MJMLExporter {
+    private options;
+    private compiler;
+    constructor(options?: ExportOptions);
+    /**
+     * Export template to MJML + HTML
+     */
+    export(template: TemplateInstance): ExportResult;
+    /**
+     * Export only MJML (without HTML compilation)
+     */
+    exportMJML(template: TemplateInstance): string;
+}
+/**
+ * Create a new MJML exporter with default options
+ */
+declare function createMJMLExporter(options?: ExportOptions): MJMLExporter;
+/**
+ * Quick export function for simple use cases
+ */
+declare function exportTemplate(template: TemplateInstance, options?: ExportOptions): ExportResult;
+
+/** The largest MJML source `importMjml` reads, in UTF-8 bytes. */
+declare const MAX_MJML_BYTES: number;
+/** The deepest nesting of MJML elements it reads (`<mjml>` is depth 1). */
+declare const MAX_MJML_DEPTH = 32;
+/** The most MJML elements (outside content such as an `mj-text`'s HTML) it reads. */
+declare const MAX_MJML_ELEMENTS = 5000;
+type MjmlImportWarningSeverity = 'info' | 'warning';
+/**
+ * Something the import could not carry over exactly, or wants the author to
+ * know. Nothing is dropped silently: every change from the source is one of
+ * these, with where it happened.
+ *
+ * - `info`: the compiled mail is unchanged, but the editor shows or edits it
+ *   differently (a document-wide default the canvas does not render, a
+ *   comment left out of the structure).
+ * - `warning`: the construct is kept so the compiled mail stays faithful, but
+ *   not as an editable block (compiled to a Raw HTML block), or something the
+ *   source asked for could not be honoured at all (an unknown component).
+ */
+interface MjmlImportWarning {
+    severity: MjmlImportWarningSeverity;
+    /** A stable identifier of the kind of warning, e.g. `kept_as_html`. */
+    code: MjmlImportWarningCode;
+    /** Where in the source, e.g. `mj-body > mj-section[2] > mj-column[1] > mj-social[1]`. */
+    path: string;
+    /** 1-based line of the element in the source, when known. */
+    line?: number;
+    message: string;
+    /** The MJML the warning is about, shortened to at most 2000 characters. */
+    fragment?: string;
+}
+type MjmlImportWarningCode = 
+/** Kept as compiled HTML in a Raw block: renders as before, not editable as a block. */
+'kept_as_html'
+/** A component MJML itself does not know: it renders nothing, its source is kept in a Raw block. */
+ | 'unknown_component'
+/** Document-wide defaults (`mj-attributes`, `mj-class`) apply to the mail but not to the editor canvas. */
+ | 'document_defaults'
+/** An attribute the editor has no control for, kept and emitted again. */
+ | 'attribute_kept'
+/** An attribute name MJML does not accept either; left out (MJML ignored it too). */
+ | 'attribute_dropped'
+/** A comment between columns, left out (comments render nothing). */
+ | 'comment_dropped'
+/** Text outside any content element, which MJML ignores. */
+ | 'stray_text'
+/** A head element the editor has no field for, kept verbatim. */
+ | 'head_element_kept'
+/** A column width in pixels: kept, but the editor's width controls work in percent. */
+ | 'column_width_px';
+interface MjmlImportResult {
+    /** A valid document at the current schema version (it passed `migrateTemplate`). */
+    document: EmailTemplate;
+    warnings: MjmlImportWarning[];
+}
+type MjmlImportErrorCode = 
+/** Not well-formed: an unclosed or mismatched tag, a malformed attribute, stray markup. */
+'invalid_xml'
+/** Well-formed, but not an MJML document (no `<mjml>` root, no `<mj-body>`). */
+ | 'not_mjml'
+/** `mj-include` needs files next to the source; an import has none. */
+ | 'include_not_supported'
+/** Larger than {@link MAX_MJML_BYTES}. */
+ | 'too_large'
+/** Nested deeper than {@link MAX_MJML_DEPTH}. */
+ | 'too_deep'
+/** More than {@link MAX_MJML_ELEMENTS} elements. */
+ | 'too_many_elements'
+/** The mapped document failed the schema (a bug in the import, reported rather than hidden). */
+ | 'invalid_document';
+/** Why an MJML source cannot be imported at all, with where, when it is one place. */
+declare class MjmlImportError extends Error {
+    readonly code: MjmlImportErrorCode;
+    readonly line: number | undefined;
+    readonly column: number | undefined;
+    constructor(code: MjmlImportErrorCode, message: string, position?: {
+        line?: number;
+        column?: number;
+    });
+    /** A plain object that survives a worker thread boundary. */
+    toJSON(): {
+        code: MjmlImportErrorCode;
+        message: string;
+        line?: number;
+        column?: number;
+    };
+}
+declare function isMjmlImportError(error: unknown): error is MjmlImportError;
+
+/**
+ * Reads an MJML document into the editor's document model.
+ *
+ * Throws {@link MjmlImportError} when the source cannot be read at all (not
+ * well-formed, not MJML, an `mj-include`, over a limit). Everything else
+ * imports: what the editor cannot hold as a block is kept as compiled HTML,
+ * and every such change is in `warnings`. The document has passed
+ * `migrateTemplate`. Server only: it compiles fallbacks with mjml.
+ */
+declare function importMjml(source: string): MjmlImportResult;
+
+export { type CompileOptions, DEFAULT_MJML_ATTRIBUTES, EDITOR_DATA_ATTRIBUTE, type ExportOptions, type ExportResult, MAX_MJML_BYTES, MAX_MJML_DEPTH, MAX_MJML_ELEMENTS, MJMLCompiler, MJMLExporter, MjmlImportError, type MjmlImportErrorCode, type MjmlImportResult, type MjmlImportWarning, type MjmlImportWarningCode, type MjmlImportWarningSeverity, createMJMLCompiler, createMJMLExporter, encodeEditorData, exportTemplate, importMjml, isMjmlImportError };

package/dist/server.d.ts

@@ -0,0 +1,341 @@
+import { E as EmailTemplate, y as CompileResult, a4 as TemplateInstance } from './TemplateModel-v__r5Nvi.js';
+import 'mobx-state-tree';
+
+/** The `<mj-attributes>` a document gets unless it brings its own (`metadata.mjmlHead.attributes`). */
+declare const DEFAULT_MJML_ATTRIBUTES = "\n        <mj-all font-family=\"Georgia, serif\" />\n        <mj-text font-size=\"14px\" line-height=\"1.6\" />\n      ";
+/** Marks the editor's own raw markup so the MJML import can read the block back exactly. */
+declare const EDITOR_DATA_ATTRIBUTE: {
+    readonly social: "data-ee-social";
+    readonly subColumns: "data-ee-subcols";
+};
+/** A block's (or sub-columns') JSON, base64-encoded, for an {@link EDITOR_DATA_ATTRIBUTE}. */
+declare function encodeEditorData(value: unknown): string;
+/** Options for one {@link MJMLCompiler.compile} call. */
+interface CompileOptions {
+    /**
+     * MJML adds a Google Fonts `<link>` and `@import` on its own whenever a font
+     * family it knows (Open Sans, Droid Sans, Lato, Roboto, Ubuntu) appears in
+     * the document. `false` leaves them out, so the font falls back to the rest
+     * of its stack and the mail loads nothing from Google. Fonts the document
+     * declares itself (`metadata.fonts`) are always emitted. Default `true`.
+     */
+    webFonts?: boolean;
+}
+/**
+ * MJML Compiler class
+ * Converts EmailTemplate to MJML markup and compiles to HTML
+ */
+declare class MJMLCompiler {
+    /**
+     * Set true while emitting a column with sub-columns. Causes generateHead
+     * to inject the responsive media query exactly once per template.
+     */
+    private needsSubColumnStyles;
+    /**
+     * Compile email template to MJML and HTML
+     */
+    compile(template: EmailTemplate, options?: CompileOptions): CompileResult;
+    /**
+     * The MJML markup for a document, without compiling it to HTML.
+     */
+    toMJML(template: EmailTemplate): string;
+    /**
+     * Convert template to MJML markup
+     */
+    private templateToMJML;
+    /**
+     * Generate MJML head section with all head components
+     * Supports: mj-title, mj-preview, mj-font, mj-breakpoint, mj-style
+     */
+    private generateHead;
+    /**
+     * Collect background-image CSS rules for all wrappers, sections and columns that have gradients.
+     * Returns a string of CSS rules to inject as a single mj-style block.
+     */
+    private collectGradientStyles;
+    /**
+     * Convert a wrapper to an `<mj-wrapper>` around its sections. The wrapper's
+     * attributes are MJML's own for `mj-wrapper`; the sections inside follow
+     * MJML's rules there (a full-width section inside a full-width wrapper
+     * renders at standard width, which the inspector explains).
+     */
+    private wrapperToMJML;
+    /** Background attributes shared by sections and wrappers: a gradient (with its Outlook fallback colour), or colour and image. */
+    private pushBackground;
+    /**
+     * Convert section to MJML
+     * Supports background images, full-width, and mj-group for non-stacking columns
+     */
+    private sectionToMJML;
+    /**
+     * Convert column to MJML
+     */
+    private columnToMJML;
+    /**
+     * Emit a group column as an mj-column wrapping a hand-built nested
+     * table inside an mj-raw island. The parent mj-section structure
+     * stays standard MJML; only the nested area escapes MJML's parser.
+     *
+     * The responsive media query (table.ee-sub-cols td.ee-sub-col) is
+     * injected once at document head via generateHead when the
+     * needsSubColumnStyles flag is set.
+     */
+    private subColumnsToMJML;
+    /**
+     * Convert block to MJML based on type
+     */
+    private blockToMJML;
+    /**
+     * Convert text block to MJML
+     *
+     * Note: MJML applies styles to the container <td>, but TipTap content
+     * (wrapped in <p> tags) doesn't inherit these styles. We solve this by
+     * wrapping the content in a <div> with explicit inline styles.
+     */
+    private textBlockToMJML;
+    /**
+     * Convert image block to MJML
+     */
+    private imageBlockToMJML;
+    /**
+     * Convert button block to MJML
+     */
+    private buttonBlockToMJML;
+    /**
+     * Convert divider block to MJML
+     */
+    private dividerBlockToMJML;
+    /**
+     * Convert spacer block to MJML
+     */
+    private spacerBlockToMJML;
+    /**
+     * Platform brand colors for social icons
+     */
+    private readonly SOCIAL_COLORS;
+    /**
+     * Get white SVG icon as data URI for a platform
+     * Uses clean, minimal SVGs optimized for email
+     */
+    private getSocialIconDataUri;
+    /**
+     * Convert social block to MJML using raw HTML table for reliable horizontal layout
+     * Uses styled anchor tags with background colors for full width control
+     */
+    private socialBlockToMJML;
+    /**
+     * Convert hero block to MJML
+     */
+    private heroBlockToMJML;
+    /**
+     * Convert accordion block to MJML
+     */
+    private accordionBlockToMJML;
+    /**
+     * Convert raw HTML block to MJML
+     */
+    private rawBlockToMJML;
+    /**
+     * Convert navbar block to MJML
+     */
+    private navbarBlockToMJML;
+    /**
+     * Convert carousel block to MJML
+     */
+    private carouselBlockToMJML;
+    /**
+     * Convert table block to MJML
+     */
+    private tableBlockToMJML;
+    /**
+     * Generate the locked header block.
+     *
+     * It used to render one client's company name and a logo from an image host;
+     * both are gone. What is left is a placeholder image slot. Keep this in step
+     * with `headerBlockDefinition` in `packages/blocks/src/branded/index.ts`:
+     * which of the two runs depends on how the registry is configured.
+     *
+     * The placeholder is a `data:` URI rather than an address on an image host,
+     * so a workspace whose `asset_policy` is `service_only` can still send a mail
+     * that contains this block.
+     */
+    private headerBlockToMJML;
+    /**
+     * Generate the locked footer block: the unsubscribe link and nothing else.
+     *
+     * It used to carry a copyright line naming one client's company. A locked
+     * block carries no props, so whoever sends the mail cannot correct a name
+     * that is not theirs; the line is gone rather than replaced with a fake one.
+     * Keep this in step with `footerBlockDefinition` in
+     * `packages/blocks/src/branded/index.ts`.
+     */
+    private footerBlockToMJML;
+}
+/**
+ * Create a new MJML compiler instance
+ */
+declare function createMJMLCompiler(): MJMLCompiler;
+
+/**
+ * MJML Exporter - Converts a live MST template to MJML/HTML
+ *
+ * This exporter is called ONLY when the user clicks Export/Send,
+ * NOT during editing. This separation is key to achieving instant
+ * visual feedback during editing.
+ *
+ * It compiles the store's snapshot with `MJMLCompiler`, the one compiler the
+ * editor has, so an export from the store and a compile of the saved document
+ * give the same mail (wrappers, sub-columns, kept attributes and all).
+ *
+ * IMPORTANT: This file should only be imported on the server side
+ * as it uses the mjml package which is not browser-safe.
+ */
+
+/**
+ * Result of MJML export
+ */
+interface ExportResult {
+    /** Raw MJML markup */
+    mjml: string;
+    /** Compiled HTML */
+    html: string;
+    /** Any compilation errors */
+    errors?: string[];
+}
+/**
+ * Export options
+ */
+interface ExportOptions {
+    /** MJML validation level */
+    validationLevel?: 'strict' | 'soft' | 'skip';
+    /** Minify output HTML */
+    minify?: boolean;
+    /** Add beautiful comments for debugging */
+    beautify?: boolean;
+}
+/**
+ * MJMLExporter - Exports MST template to MJML and HTML
+ */
+declare class MJMLExporter {
+    private options;
+    private compiler;
+    constructor(options?: ExportOptions);
+    /**
+     * Export template to MJML + HTML
+     */
+    export(template: TemplateInstance): ExportResult;
+    /**
+     * Export only MJML (without HTML compilation)
+     */
+    exportMJML(template: TemplateInstance): string;
+}
+/**
+ * Create a new MJML exporter with default options
+ */
+declare function createMJMLExporter(options?: ExportOptions): MJMLExporter;
+/**
+ * Quick export function for simple use cases
+ */
+declare function exportTemplate(template: TemplateInstance, options?: ExportOptions): ExportResult;
+
+/** The largest MJML source `importMjml` reads, in UTF-8 bytes. */
+declare const MAX_MJML_BYTES: number;
+/** The deepest nesting of MJML elements it reads (`<mjml>` is depth 1). */
+declare const MAX_MJML_DEPTH = 32;
+/** The most MJML elements (outside content such as an `mj-text`'s HTML) it reads. */
+declare const MAX_MJML_ELEMENTS = 5000;
+type MjmlImportWarningSeverity = 'info' | 'warning';
+/**
+ * Something the import could not carry over exactly, or wants the author to
+ * know. Nothing is dropped silently: every change from the source is one of
+ * these, with where it happened.
+ *
+ * - `info`: the compiled mail is unchanged, but the editor shows or edits it
+ *   differently (a document-wide default the canvas does not render, a
+ *   comment left out of the structure).
+ * - `warning`: the construct is kept so the compiled mail stays faithful, but
+ *   not as an editable block (compiled to a Raw HTML block), or something the
+ *   source asked for could not be honoured at all (an unknown component).
+ */
+interface MjmlImportWarning {
+    severity: MjmlImportWarningSeverity;
+    /** A stable identifier of the kind of warning, e.g. `kept_as_html`. */
+    code: MjmlImportWarningCode;
+    /** Where in the source, e.g. `mj-body > mj-section[2] > mj-column[1] > mj-social[1]`. */
+    path: string;
+    /** 1-based line of the element in the source, when known. */
+    line?: number;
+    message: string;
+    /** The MJML the warning is about, shortened to at most 2000 characters. */
+    fragment?: string;
+}
+type MjmlImportWarningCode = 
+/** Kept as compiled HTML in a Raw block: renders as before, not editable as a block. */
+'kept_as_html'
+/** A component MJML itself does not know: it renders nothing, its source is kept in a Raw block. */
+ | 'unknown_component'
+/** Document-wide defaults (`mj-attributes`, `mj-class`) apply to the mail but not to the editor canvas. */
+ | 'document_defaults'
+/** An attribute the editor has no control for, kept and emitted again. */
+ | 'attribute_kept'
+/** An attribute name MJML does not accept either; left out (MJML ignored it too). */
+ | 'attribute_dropped'
+/** A comment between columns, left out (comments render nothing). */
+ | 'comment_dropped'
+/** Text outside any content element, which MJML ignores. */
+ | 'stray_text'
+/** A head element the editor has no field for, kept verbatim. */
+ | 'head_element_kept'
+/** A column width in pixels: kept, but the editor's width controls work in percent. */
+ | 'column_width_px';
+interface MjmlImportResult {
+    /** A valid document at the current schema version (it passed `migrateTemplate`). */
+    document: EmailTemplate;
+    warnings: MjmlImportWarning[];
+}
+type MjmlImportErrorCode = 
+/** Not well-formed: an unclosed or mismatched tag, a malformed attribute, stray markup. */
+'invalid_xml'
+/** Well-formed, but not an MJML document (no `<mjml>` root, no `<mj-body>`). */
+ | 'not_mjml'
+/** `mj-include` needs files next to the source; an import has none. */
+ | 'include_not_supported'
+/** Larger than {@link MAX_MJML_BYTES}. */
+ | 'too_large'
+/** Nested deeper than {@link MAX_MJML_DEPTH}. */
+ | 'too_deep'
+/** More than {@link MAX_MJML_ELEMENTS} elements. */
+ | 'too_many_elements'
+/** The mapped document failed the schema (a bug in the import, reported rather than hidden). */
+ | 'invalid_document';
+/** Why an MJML source cannot be imported at all, with where, when it is one place. */
+declare class MjmlImportError extends Error {
+    readonly code: MjmlImportErrorCode;
+    readonly line: number | undefined;
+    readonly column: number | undefined;
+    constructor(code: MjmlImportErrorCode, message: string, position?: {
+        line?: number;
+        column?: number;
+    });
+    /** A plain object that survives a worker thread boundary. */
+    toJSON(): {
+        code: MjmlImportErrorCode;
+        message: string;
+        line?: number;
+        column?: number;
+    };
+}
+declare function isMjmlImportError(error: unknown): error is MjmlImportError;
+
+/**
+ * Reads an MJML document into the editor's document model.
+ *
+ * Throws {@link MjmlImportError} when the source cannot be read at all (not
+ * well-formed, not MJML, an `mj-include`, over a limit). Everything else
+ * imports: what the editor cannot hold as a block is kept as compiled HTML,
+ * and every such change is in `warnings`. The document has passed
+ * `migrateTemplate`. Server only: it compiles fallbacks with mjml.
+ */
+declare function importMjml(source: string): MjmlImportResult;
+
+export { type CompileOptions, DEFAULT_MJML_ATTRIBUTES, EDITOR_DATA_ATTRIBUTE, type ExportOptions, type ExportResult, MAX_MJML_BYTES, MAX_MJML_DEPTH, MAX_MJML_ELEMENTS, MJMLCompiler, MJMLExporter, MjmlImportError, type MjmlImportErrorCode, type MjmlImportResult, type MjmlImportWarning, type MjmlImportWarningCode, type MjmlImportWarningSeverity, createMJMLCompiler, createMJMLExporter, encodeEditorData, exportTemplate, importMjml, isMjmlImportError };