@marlinjai/email-editor-core 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 marlinjai
+
+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,34 @@
+# @marlinjai/email-editor-core
+
+The framework-agnostic engine of [`@marlinjai/email-editor`](https://www.npmjs.com/package/@marlinjai/email-editor): the email document schema and its validation, `migrateTemplate` for stored documents, the block registry, the MobX State Tree store, and the MJML compiler.
+
+Most apps install it for two things on their server: validating stored documents and compiling them to HTML.
+
+```ts
+import { migrateTemplate, isTemplateMigrationError } from '@marlinjai/email-editor-core';
+import { createMJMLCompiler } from '@marlinjai/email-editor-core/server';
+
+const doc = migrateTemplate(storedJson); // throws TemplateMigrationError with a typed `code`
+const { html, mjml, errors } = createMJMLCompiler().compile(doc);
+```
+
+## Two entry points
+
+| Import | Where | Contains |
+|--------|-------|----------|
+| `@marlinjai/email-editor-core` | browser and server | schema, types, `validateTemplate`, `migrateTemplate`, registry, store |
+| `@marlinjai/email-editor-core/server` | server only | MJML compiler and exporter, and `importMjml` (MJML source to a document), all depending on `mjml`, a Node.js-only package |
+
+Never import `/server` from client code. In Next.js, list `mjml`, `mjml-core`, `mjml-parser-xml`, `mjml-preset-core` and `mjml-validator` in `serverExternalPackages`.
+
+## `migrateTemplate(doc)`
+
+Returns the document at the current schema version (`CURRENT_TEMPLATE_VERSION`, today `"1.1"`; 1.1 added wrappers, a container around sections). For a `1.1` document it is the identity: the same object, validated. A `1.0` document comes back as a new object with only the version changed, except that a 1.0 section flagged `isWrapper` becomes a wrapper around that section. Otherwise it throws a `TemplateMigrationError` whose `code` is `INVALID_INPUT`, `MISSING_VERSION`, `UNSUPPORTED_VERSION`, `NEWER_VERSION` (written by a newer editor) or `INVALID_DOCUMENT` (with the schema `issues`). See the [editor README](https://github.com/marlinjai/email-editor/tree/main/packages/editor#readme) for how to use it in an API route.
+
+## `importMjml(source)`
+
+Reads an MJML document into the editor's document model and returns `{ document, warnings }`; the document has passed `migrateTemplate`. An `mj-wrapper` becomes a wrapper holding its sections. What cannot become an editable block is kept as compiled HTML, so the mail does not change, and every such change is a warning with a path and the MJML it came from. Unreadable input throws an `MjmlImportError` with a `code` and, when it is one place, a `line` and `column`; `mj-include` is refused, never read from disk. See the [editor README](https://github.com/marlinjai/email-editor/tree/main/packages/editor#readme) for what maps.
+
+## License
+
+MIT