mikser-io-post-mjml 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Almero Digital Marketing
+
+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,59 @@
+# mikser-io-post-mjml
+
+[MJML](https://www.npmjs.com/package/mjml) postprocessor for [Mikser](https://github.com/almero-digital-marketing/mikser-io). Compiles a rendered MJML document into responsive email-safe HTML.
+
+## Install
+
+```bash
+npm install mikser-io-post-mjml
+```
+
+## Usage
+
+```js
+// mikser.config.js
+export default {
+  plugins: ['post-mjml'],
+  'post-mjml': {
+    options: { keepComments: false, minify: true }
+  }
+}
+```
+
+`'post-mjml'.options` is passed through to [`mjml2html`](https://www.npmjs.com/package/mjml). The plugin sets `validationLevel: 'soft'` by default.
+
+## Layout naming
+
+Mikser's convention for layouts that need a postprocessor is `<name>.<format>-<postprocessor>.<template>`. Use the `-mjml` suffix to opt in:
+
+| Layout file | Renderer output | Final output |
+|---|---|---|
+| `welcome.html-mjml.hbs` | MJML markup (rendered via HBS) | `welcome.html` |
+| `welcome.html-mjml.liquid` | MJML markup (rendered via Liquid) | `welcome.html` |
+
+The renderer's job is to produce **MJML markup**; the `format` segment (`html` above) is mostly a no-op for naming. The plugin reads the rendered file, compiles MJML → HTML, and writes the result to `<name>.html`.
+
+### Why not just `welcome.mjml.hbs`?
+
+Without the `-mjml` postprocessor suffix, Mikser treats the rendered output as the final file (`welcome.mjml`) — no compilation happens. The suffix is what hooks the postprocessor into the pipeline.
+
+## Example layout
+
+```hbs
+<mjml>
+  <mj-body>
+    <mj-section>
+      <mj-column>
+        <mj-text font-size="20px">{{document.meta.title}}</mj-text>
+        <mj-text>{{document.meta.body}}</mj-text>
+      </mj-column>
+    </mj-section>
+  </mj-body>
+</mjml>
+```
+
+MJML validation errors (if any) are surfaced via the Mikser logger as warnings.
+
+## License
+
+MIT

package/index.js

@@ -0,0 +1,33 @@
+import mjml2html from 'mjml'
+import { readFile } from 'node:fs/promises'
+import path from 'node:path'
+
+export async function postprocess({ entity, options, config, logger }) {
+    const sourcePath = path.join(options.outputFolder, entity.origin)
+    const source = await readFile(sourcePath, 'utf8')
+
+    const { html, errors } = await mjml2html(source, {
+        validationLevel: 'soft',
+        ...config?.options,
+    })
+
+    if (errors?.length) {
+        for (const err of errors) {
+            logger.warn('MJML %s:%d %s', entity.name || entity.id, err.line || 0, err.message || err.formattedMessage)
+        }
+    }
+
+    // The default postprocessor convention names the output extension after the
+    // postprocessor key (`.mjml` here). MJML actually produces HTML — rewrite
+    // the destination so the writer emits `*.html`.
+    if (entity.destination?.endsWith('.mjml')) {
+        const desired = entity.destination.slice(0, -'.mjml'.length) + '.html'
+        // Avoid the origin/destination collision (e.g. layout `name.html-mjml.hbs`
+        // gives origin=`name.html`, which is also the desired output path).
+        // Clearing origin prevents onComplete from unlinking our final file.
+        if (desired === entity.origin) entity.origin = undefined
+        entity.destination = desired
+    }
+
+    return html
+}

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "mikser-io-post-mjml",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {},
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/almero-digital-marketing/mikser-io-post-mjml.git"
+  },
+  "author": "",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/almero-digital-marketing/mikser-io-post-mjml/issues"
+  },
+  "homepage": "https://github.com/almero-digital-marketing/mikser-io-post-mjml#readme",
+  "peerDependencies": {
+    "mikser-io": "^6.0.0"
+  },
+  "dependencies": {
+    "mjml": "^5.2.1"
+  }
+}