@templatical/import-mjml 0.31.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026-present Templatical
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,36 @@
+# @templatical/import-mjml
+
+Convert MJML email templates to Templatical format.
+
+Parses `<mjml>` source — hand-written or exported from another tool — into a Templatical `TemplateContent` tree. Structural tags (`mj-section`, `mj-column`, `mj-wrapper`) become `SectionBlock`s and content tags (`mj-text`, `mj-image`, `mj-button`, etc.) map to their Templatical block equivalents. Tags with no Templatical equivalent are preserved verbatim as `HtmlBlock` fallbacks.
+
+## Install
+
+```sh
+npm install @templatical/import-mjml
+```
+
+## Usage
+
+```ts
+import { convertMjmlTemplate } from '@templatical/import-mjml';
+
+const mjml = await fetch('/path/to/template.mjml').then((r) => r.text());
+const { content, report } = convertMjmlTemplate(mjml);
+
+console.log(report.summary);
+console.log(report.warnings);
+```
+
+Each entry in `report.entries` carries a `status`:
+
+- `converted` — mapped to a Templatical block with no loss of fidelity.
+- `approximated` — mapped to a Templatical block, but something had to be resolved or clamped (e.g. a heading level beyond h4, a column-width split with no exact Templatical layout, or a multi-section `mj-wrapper`).
+- `html-fallback` — no Templatical block exists for this tag; the original MJML markup is preserved inside an `HtmlBlock`.
+- `skipped` — produced no block at all (e.g. an `<mj-include>`, which the importer can't resolve without filesystem access).
+
+See [Migrating from hand-written MJML](https://docs.templatical.com/guide/migration-from-mjml) for the full tag-mapping table.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,63 @@
+//#region src/types.d.ts
+/**
+ * Type definitions for the MJML email importer.
+ *
+ * These four types are structurally identical to the ones every other
+ * `@templatical/import-*` package exports, so a caller can treat all importers
+ * uniformly. Changing a shape here without changing the others breaks that.
+ */
+/**
+ * Conversion status for each MJML element processed in the import report.
+ */
+type ConversionStatus = "converted" | "approximated" | "html-fallback" | "skipped";
+/**
+ * A single entry in the import report.
+ */
+interface ImportReportEntry {
+  /** The source MJML tag name (e.g. "mj-section", "mj-image", "mj-hero"). */
+  sourceTag: string;
+  /** The Templatical block type produced, or null if skipped. */
+  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 an MJML import operation.
+ */
+interface ImportResult {
+  content: import("@templatical/types").TemplateContent;
+  report: ImportReport;
+}
+//#endregion
+//#region src/converter.d.ts
+/**
+ * Convert an MJML document into a Templatical template.
+ *
+ * @example
+ * ```ts
+ * const { content, report } = convertMjmlTemplate(mjmlSource);
+ *
+ * const editor = init({ container: '#editor', content });
+ *
+ * console.log(report.summary);
+ * console.log(report.warnings);
+ * ```
+ */
+declare function convertMjmlTemplate(mjml: string): ImportResult;
+//#endregion
+export { type ConversionStatus, type ImportReport, type ImportReportEntry, type ImportResult, convertMjmlTemplate };
+//# sourceMappingURL=index.d.ts.map