@marlinjai/email-editor-core 0.2.0 → 0.4.0

package/dist/{TemplateModel-v__r5Nvi.d.ts → TemplateModel-PcCoyBdo.d.mts}

@@ -1,437 +1,6 @@
 import * as mobx_state_tree from 'mobx-state-tree';
 import { Instance, SnapshotIn, SnapshotOut, IType } from 'mobx-state-tree';
-
-interface GradientStop {
-    color: string;
-    position: number;
-}
-interface BackgroundGradient {
-    type: 'linear' | 'radial';
-    angle: number;
-    stops: GradientStop[];
-}
-/**
- * Converts a BackgroundGradient to a CSS background-image value.
- * Returns undefined when stops array is empty.
- *
- * Examples:
- *   buildGradientCSS({ type: 'linear', angle: 90, stops: [{color:'#f00',position:0},{color:'#00f',position:100}] })
- *   // => "linear-gradient(90deg, #f00 0%, #00f 100%)"
- *
- *   buildGradientCSS({ type: 'radial', angle: 0, stops: [{color:'#f00',position:0},{color:'#00f',position:100}] })
- *   // => "radial-gradient(circle, #f00 0%, #00f 100%)"
- */
-declare function buildGradientCSS(gradient: BackgroundGradient): string | undefined;
-
-/**
- * Spacing configuration for padding/margin
- */
-interface Spacing {
-    top?: string;
-    right?: string;
-    bottom?: string;
-    left?: string;
-}
-/**
- * Custom font definition
- */
-interface FontDefinition {
-    name: string;
-    href: string;
-}
-/**
- * Theme color for reusable brand colors
- */
-interface ThemeColor {
-    name: string;
-    value: string;
-}
-/**
- * MJML attributes the editor has no control for, kept as found (values as they
- * stood in the source, XML entities included) and emitted again by the
- * compiler after the attributes the editor sets. Written by the MJML import,
- * so an imported document compiles the way its source did: a `css-class` the
- * author's `mj-style` rules target, an `mj-class`, a button's `font-weight`.
- */
-type ExtraAttributes = Record<string, string>;
-/**
- * What an imported document's `<mj-head>` and `<mj-body>` carried beyond the
- * fields the editor has (title, preview, fonts, breakpoint, styles). When
- * present, the compiler emits `attributes` instead of its own default
- * `<mj-attributes>` (so the source's `mj-all`, per-component defaults and
- * `mj-class` definitions apply as they did), `bodyAttributes` on `<mj-body>`,
- * and `headRaw` (for example `mj-html-attributes`) verbatim inside `<mj-head>`.
- */
-interface MjmlHead {
-    /** The inner markup of `<mj-attributes>`, verbatim. An empty string means "no defaults at all". */
-    attributes?: string;
-    /** Attributes of `<mj-body>`, e.g. `background-color`, `width`. */
-    bodyAttributes?: ExtraAttributes;
-    /** Other head elements, verbatim, in source order. */
-    headRaw?: string;
-}
-/**
- * Email template metadata
- */
-interface TemplateMetadata {
-    subject?: string;
-    previewText?: string;
-    title?: string;
-    /** Epoch milliseconds (what the editor emits) or an ISO 8601 string */
-    createdAt?: string | number;
-    /** Epoch milliseconds (what the editor emits) or an ISO 8601 string */
-    updatedAt?: string | number;
-    fonts?: FontDefinition[];
-    themeColors?: ThemeColor[];
-    breakpoint?: string;
-    customCSS?: string;
-    inlineCSS?: string;
-    /** Set by the MJML import; see {@link MjmlHead}. */
-    mjmlHead?: MjmlHead;
-}
-/**
- * Base block interface - all blocks extend this
- */
-interface BaseBlock {
-    id: string;
-    type: string;
-    hidden?: boolean;
-    /** See {@link ExtraAttributes}. */
-    extraAttributes?: ExtraAttributes;
-}
-/**
- * Text block with rich content
- */
-interface TextBlock extends BaseBlock {
-    type: 'text';
-    content: string;
-    align?: 'left' | 'center' | 'right' | 'justify';
-    color?: string;
-    fontSize?: string;
-    fontFamily?: string;
-    padding?: Spacing;
-    lineHeight?: string;
-}
-/**
- * Image block
- */
-interface ImageBlock extends BaseBlock {
-    type: 'image';
-    src: string;
-    alt?: string;
-    width?: string;
-    height?: string;
-    align?: 'left' | 'center' | 'right';
-    href?: string;
-    padding?: Spacing;
-    borderRadius?: string;
-}
-/**
- * Button block
- */
-interface ButtonBlock extends BaseBlock {
-    type: 'button';
-    label: string;
-    href: string;
-    align?: 'left' | 'center' | 'right';
-    backgroundColor?: string;
-    color?: string;
-    borderRadius?: string;
-    border?: string;
-    padding?: Spacing;
-    innerPadding?: string;
-}
-/**
- * Divider block
- */
-interface DividerBlock extends BaseBlock {
-    type: 'divider';
-    borderColor?: string;
-    borderWidth?: string;
-    borderStyle?: 'solid' | 'dashed' | 'dotted';
-    width?: string;
-    padding?: Spacing;
-}
-/**
- * Spacer block for vertical spacing
- */
-interface SpacerBlock extends BaseBlock {
-    type: 'spacer';
-    height: string;
-}
-/**
- * Custom branded header block (locked)
- */
-interface HeaderBlock extends BaseBlock {
-    type: 'header';
-    locked: true;
-}
-/**
- * Custom branded footer block (locked)
- */
-interface FooterBlock extends BaseBlock {
-    type: 'footer';
-    locked: true;
-}
-/**
- * Social link definition
- */
-interface SocialLink {
-    platform: string;
-    url: string;
-    color?: string;
-}
-/**
- * Social block for social media icons
- */
-interface SocialBlock extends BaseBlock {
-    type: 'social';
-    links: SocialLink[];
-    iconSize?: string;
-    iconPadding?: string;
-    borderRadius?: string;
-    align?: 'left' | 'center' | 'right';
-    mode?: 'horizontal' | 'vertical';
-}
-/**
- * Hero block with background image
- */
-interface HeroBlock extends BaseBlock {
-    type: 'hero';
-    backgroundImage: string;
-    backgroundHeight?: string;
-    backgroundWidth?: string;
-    backgroundColor?: string;
-    verticalAlign?: 'top' | 'middle' | 'bottom';
-    mode?: 'fixed-height' | 'fluid-height';
-}
-/**
- * Accordion item
- */
-interface AccordionItem {
-    title: string;
-    content: string;
-}
-/**
- * Accordion block for collapsible content
- */
-interface AccordionBlock extends BaseBlock {
-    type: 'accordion';
-    items: AccordionItem[];
-    iconPosition?: 'left' | 'right';
-    borderColor?: string;
-    fontFamily?: string;
-}
-/**
- * Raw HTML block
- */
-interface RawBlock extends BaseBlock {
-    type: 'raw';
-    html: string;
-}
-/**
- * Navbar link definition
- */
-interface NavbarLink {
-    href: string;
-    label: string;
-    color?: string;
-}
-/**
- * Navbar block for navigation
- */
-interface NavbarBlock extends BaseBlock {
-    type: 'navbar';
-    links: NavbarLink[];
-    hamburger?: boolean;
-    baseUrl?: string;
-    align?: 'left' | 'center' | 'right';
-    icoColor?: string;
-    padding?: Spacing;
-}
-/**
- * Carousel image definition
- */
-interface CarouselImage {
-    src: string;
-    alt?: string;
-    href?: string;
-    thumbnailSrc?: string;
-}
-/**
- * Carousel block for image slideshows
- */
-interface CarouselBlock extends BaseBlock {
-    type: 'carousel';
-    images: CarouselImage[];
-    thumbnails?: 'visible' | 'hidden';
-    borderRadius?: string;
-    iconWidth?: string;
-    tbBorderRadius?: string;
-    padding?: Spacing;
-}
-/**
- * Table block for tabular data
- */
-interface TableBlock extends BaseBlock {
-    type: 'table';
-    headers: string[];
-    rows: string[][];
-    align?: 'left' | 'center' | 'right';
-    color?: string;
-    fontFamily?: string;
-    fontSize?: string;
-    cellpadding?: string;
-    cellspacing?: string;
-    border?: string;
-    padding?: Spacing;
-}
-/**
- * Union type of all possible blocks
- */
-type Block = TextBlock | ImageBlock | ButtonBlock | DividerBlock | SpacerBlock | HeaderBlock | FooterBlock | SocialBlock | HeroBlock | AccordionBlock | RawBlock | NavbarBlock | CarouselBlock | TableBlock;
-/**
- * Column within a section
- */
-interface Column {
-    id: string;
-    width?: number;
-    blocks: Block[];
-    hidden?: boolean;
-    backgroundColor?: string;
-    backgroundGradient?: BackgroundGradient;
-    verticalAlign?: 'top' | 'middle' | 'bottom';
-    padding?: Spacing;
-    /**
-     * Optional sub-columns. When non-empty, `blocks` MUST be empty
-     * (a column is either a leaf with blocks, or a group with sub-columns).
-     * See `docs/superpowers/specs/2026-04-26-nested-columns-design.md`.
-     */
-    subColumns?: SubColumn[];
-    /** See {@link ExtraAttributes}. */
-    extraAttributes?: ExtraAttributes;
-}
-/**
- * Sub-column inside a "group"-kind Column. Holds only leaf blocks
- * (text, image, button, divider, spacer, social). Cannot itself contain
- * sub-columns (no nesting beyond depth 2).
- */
-interface SubColumn {
-    id: string;
-    width: number;
-    blocks: Block[];
-    backgroundColor?: string;
-    verticalAlign?: 'top' | 'middle' | 'bottom';
-    paddingTop?: string;
-    paddingRight?: string;
-    paddingBottom?: string;
-    paddingLeft?: string;
-}
-/**
- * Section containing columns
- */
-interface Section {
-    id: string;
-    type: 'section';
-    backgroundColor?: string;
-    backgroundImage?: string;
-    backgroundGradient?: BackgroundGradient;
-    backgroundPosition?: string;
-    backgroundRepeat?: 'repeat' | 'no-repeat';
-    backgroundSize?: string;
-    /**
-     * Full width (`full-width` in MJML). Inside a full-width {@link Wrapper},
-     * MJML renders the section at standard width whatever this says.
-     */
-    fullWidth?: boolean;
-    noStack?: boolean;
-    hidden?: boolean;
-    padding?: Spacing;
-    columns: Column[];
-    /**
-     * Emit the section's raw blocks straight into the parent (`<mj-body>`, or
-     * the `<mj-wrapper>` the section sits in) instead of inside an
-     * `<mj-section>`: markup that sat there in an imported document. Ignored as
-     * soon as the section holds any block that is not raw.
-     */
-    bodyRaw?: boolean;
-    /** See {@link ExtraAttributes}. */
-    extraAttributes?: ExtraAttributes;
-}
-/**
- * A container around several sections (`<mj-wrapper>`): one background,
- * border, radius and padding shared by the sections inside, with an optional
- * vertical `gap` between them. Sits at the top level of a document, next to
- * sections; it never holds another wrapper and never sits inside a section.
- * It may be empty (it keeps its styling, and sections can be moved back in).
- * Added in schema version 1.1.
- */
-interface Wrapper {
-    id: string;
-    type: 'wrapper';
-    hidden?: boolean;
-    backgroundColor?: string;
-    /** `background-url` in MJML. */
-    backgroundImage?: string;
-    backgroundGradient?: BackgroundGradient;
-    backgroundPosition?: string;
-    backgroundRepeat?: 'repeat' | 'no-repeat';
-    backgroundSize?: string;
-    /** CSS border shorthand for all four sides, e.g. `1px solid #dddddd`. */
-    border?: string;
-    borderTop?: string;
-    borderRight?: string;
-    borderBottom?: string;
-    borderLeft?: string;
-    borderRadius?: string;
-    /** MJML's default when unset is `20px 0`. */
-    padding?: Spacing;
-    /** Full width (`full-width`): the background spans the whole mail width; the sections inside stay at standard width. */
-    fullWidth?: boolean;
-    /** Class names for `css-class`, space separated, for the document's own `mj-style` rules. */
-    cssClass?: string;
-    /** Vertical space between the sections inside, in px (`gap`, MJML 4.15 and later). */
-    gap?: string;
-    textAlign?: 'left' | 'center' | 'right';
-    /** See {@link ExtraAttributes}. */
-    extraAttributes?: ExtraAttributes;
-    sections: Section[];
-}
-/** What the top level of a document holds, in order: sections and wrappers. */
-type TopLevelItem = Section | Wrapper;
-/** The document schema versions: 1.1 added {@link Wrapper}. */
-type TemplateVersion = '1.0' | '1.1';
-/**
- * Complete email template structure
- */
-interface EmailTemplate {
-    /**
-     * The document's id. Optional: a document without one is valid, and the
-     * editor store assigns one when it opens it (see `TemplateModel`).
-     * `migrateTemplate` never adds or changes it.
-     */
-    id?: string;
-    /**
-     * The schema version. `migrateTemplate` brings every document it accepts to
-     * the current one (1.1); a 1.0 document cannot hold a wrapper.
-     */
-    version: TemplateVersion;
-    metadata: TemplateMetadata;
-    /** The document's top level, in order: sections and wrappers (see {@link TopLevelItem}). */
-    sections: TopLevelItem[];
-}
-/** Whether a top-level item is a {@link Wrapper}. */
-declare function isWrapper(item: TopLevelItem): item is Wrapper;
-/** Every section of a document in order, the ones inside wrappers included. */
-declare function allSections(items: readonly TopLevelItem[]): Section[];
-/**
- * Result of MJML compilation
- */
-interface CompileResult {
-    mjml: string;
-    html: string;
-    errors?: string[];
-}
+import { d as BackgroundGradient, e as MjmlHead } from './MjmlBuilder-DsiOyhiL.mjs';
 
 /**
  * The store's models give most fields a default (`hidden: false`, a column
@@ -8783,4 +8352,4 @@ declare function createTemplateWithDefaultSection(options?: {
     title?: string;
 }): TemplateSnapshotIn;
 
-export { type SpacerBlock as $, type AccordionBlock as A, type Block as B, type CSSProperties as C, type DividerBlock as D, type EmailTemplate as E, type Filled as F, type FontDefinition as G, FontDefinitionModel as H, type FooterBlock as I, type GradientStop as J, type HeaderBlock as K, type HeroBlock as L, type MjmlHead as M, type ImageBlock as N, MJML_WRAPPER_DEFAULT_PADDING as O, type NavbarBlock as P, type NavbarLink as Q, NavbarLinkModel as R, type Section as S, type TemplateSnapshotIn as T, type RawBlock as U, SectionModel as V, type WrapperProperties as W, type SectionSnapshotOut as X, type SocialBlock as Y, type SocialLink as Z, SocialLinkModel as _, BlockType as a, type Spacing as a0, SpacingModel as a1, type SubColumn as a2, type TableBlock as a3, type TemplateInstance as a4, type TemplateMetadata as a5, type TemplateMetadataInstance as a6, TemplateMetadataModel as a7, type TemplateSnapshotOut as a8, type TemplateVersion as a9, type TextBlock as aa, type ThemeColor as ab, ThemeColorModel as ac, type TopLevelItem as ad, TopLevelItemModel as ae, type Wrapper as af, WrapperModel as ag, type WrapperSnapshotOut as ah, allSections as ai, buildGradientCSS as aj, cloneSectionSnapshot as ak, createColumn as al, createSection as am, createTemplate as an, createTemplateWithDefaultSection as ao, createWrapper as ap, isWrapper as aq, isWrapperInstance as ar, type BackgroundGradient as b, type BlockSnapshotIn as c, type BlockInstance as d, TemplateModel as e, type ColumnSnapshotIn as f, type ColumnInstance as g, type SectionInstance as h, type WrapperInstance as i, type SectionSnapshotIn as j, type WrapperSnapshotIn as k, type TopLevelItemInstance as l, type AccordionItem as m, AccordionItemModel as n, type BaseBlock as o, BlockModel as p, type BlockSnapshotOut as q, type ButtonBlock as r, type CarouselBlock as s, type CarouselImage as t, CarouselImageModel as u, type Column as v, ColumnModel as w, type ColumnSnapshotOut as x, type CompileResult as y, type ExtraAttributes as z };
+export { AccordionItemModel as A, BlockType as B, type CSSProperties as C, type WrapperSnapshotOut as D, cloneSectionSnapshot as E, type Filled as F, createColumn as G, createSection as H, createTemplate as I, createTemplateWithDefaultSection as J, createWrapper as K, isWrapperInstance as L, MJML_WRAPPER_DEFAULT_PADDING as M, NavbarLinkModel as N, type SectionInstance as S, type TemplateSnapshotIn as T, type WrapperProperties as W, type BlockSnapshotIn as a, type BlockInstance as b, TemplateModel as c, type ColumnSnapshotIn as d, type ColumnInstance as e, type WrapperInstance as f, type SectionSnapshotIn as g, type WrapperSnapshotIn as h, type TopLevelItemInstance as i, BlockModel as j, type BlockSnapshotOut as k, CarouselImageModel as l, ColumnModel as m, type ColumnSnapshotOut as n, FontDefinitionModel as o, SectionModel as p, type SectionSnapshotOut as q, SocialLinkModel as r, SpacingModel as s, type TemplateInstance as t, type TemplateMetadataInstance as u, TemplateMetadataModel as v, type TemplateSnapshotOut as w, ThemeColorModel as x, TopLevelItemModel as y, WrapperModel as z };

package/dist/browser.d.mts

@@ -0,0 +1,13 @@
+import { C as CompileOptions, B as BuildOptions, E as EmailTemplate, a as CompileResult } from './MjmlBuilder-DsiOyhiL.mjs';
+export { b as EDITOR_MARKER, M as MjmlBuilder, m as mjmlOptions, s as stripEditorMarkup } from './MjmlBuilder-DsiOyhiL.mjs';
+
+/** Options of {@link compileInBrowser}: the shared mjml options plus the editor's affordances. */
+type BrowserCompileOptions = CompileOptions & BuildOptions;
+/**
+ * Compile a document to HTML in the browser. Same result shape as the server
+ * compiler's `compile`; `editor: true` adds the fenced affordances the canvas
+ * needs (see `BuildOptions`), which the server never emits.
+ */
+declare function compileInBrowser(template: EmailTemplate, options?: BrowserCompileOptions): Promise<CompileResult>;
+
+export { type BrowserCompileOptions, BuildOptions, CompileOptions, compileInBrowser };

package/dist/browser.d.ts

@@ -0,0 +1,13 @@
+import { C as CompileOptions, B as BuildOptions, E as EmailTemplate, a as CompileResult } from './MjmlBuilder-DsiOyhiL.js';
+export { b as EDITOR_MARKER, M as MjmlBuilder, m as mjmlOptions, s as stripEditorMarkup } from './MjmlBuilder-DsiOyhiL.js';
+
+/** Options of {@link compileInBrowser}: the shared mjml options plus the editor's affordances. */
+type BrowserCompileOptions = CompileOptions & BuildOptions;
+/**
+ * Compile a document to HTML in the browser. Same result shape as the server
+ * compiler's `compile`; `editor: true` adds the fenced affordances the canvas
+ * needs (see `BuildOptions`), which the server never emits.
+ */
+declare function compileInBrowser(template: EmailTemplate, options?: BrowserCompileOptions): Promise<CompileResult>;
+
+export { type BrowserCompileOptions, BuildOptions, CompileOptions, compileInBrowser };