@tryghost/kg-mobiledoc-html-renderer 5.2.0 → 5.3.3

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2013-2021 Ghost Foundation
+Copyright (c) 2013-2022 Ghost Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -36,4 +36,4 @@ Follow the instructions for the top-level repo.
 
 # Copyright & License
 
-Copyright (c) 2013-2021 Ghost Foundation - Released under the [MIT license](LICENSE).
+Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE).

package/lib/mobiledoc-html-renderer.js

@@ -1,6 +1,6 @@
 const SimpleDom = require('simple-dom');
-const semver = require('semver');
 const Renderer = require('mobiledoc-dom-renderer').default;
+const {slugify} = require('@tryghost/kg-utils');
 
 const walkDom = function (node, func) {
     func(node);
@@ -24,29 +24,6 @@ const nodeTextContent = function (node) {
     return textContent;
 };
 
-const slugify = function (inputString, {ghostVersion = '4.0'} = {}) {
-    const version = semver.coerce(ghostVersion);
-
-    if (semver.satisfies(version, '<4.x')) {
-        // backwards compatible slugs used in Ghost 2.x to 3.x mobiledoc
-        return inputString.replace(/[<>&"?]/g, '')
-            .trim()
-            .replace(/[^\w]/g, '-')
-            .replace(/-{2,}/g, '-')
-            .toLowerCase();
-    } else {
-        // news slugs introduced in 4.0
-        // allows all chars except symbols but will urlEncode everything
-        // produces %-encoded chars in src but browsers show real chars in status bar and url bar
-        return encodeURIComponent(inputString.trim()
-            .toLowerCase()
-            .replace(/[\][!"#$%&'()*+,./:;<=>?@\\^_{|}~]/g, '')
-            .replace(/\s+/g, '-')
-            .replace(/^-|-{2,}|-$/g, '')
-        );
-    }
-};
-
 // used to walk the rendered SimpleDOM output and modify elements before
 // serializing to HTML. Saves having a large HTML parsing dependency such as
 // jsdom that may break on malformed HTML in MD or HTML cards
@@ -74,6 +51,19 @@ class DomModifier {
         node.setAttribute('id', id);
     }
 
+    wrapBlockquoteContentInP(node) {
+        if (node.firstChild && node.firstChild.tagName === 'P') {
+            return;
+        }
+
+        const p = this.options.dom.createElement('p');
+        while (node.firstChild) {
+            p.appendChild(node.firstChild);
+        }
+
+        node.appendChild(p);
+    }
+
     modifyChildren(node) {
         walkDom(node, this.modify.bind(this));
     }
@@ -83,6 +73,11 @@ class DomModifier {
         if (node.nodeType === 1 && node.nodeName.match(/^h\d$/i)) {
             this.addHeadingId(node);
         }
+
+        // wrap blockquote content in P tag for emails
+        if (this.options.target === 'email' && node.nodeType === 1 && node.nodeName === 'BLOCKQUOTE') {
+            this.wrapBlockquoteContentInP(node);
+        }
     }
 }
 
@@ -98,12 +93,25 @@ class MobiledocHtmlRenderer {
 
     render(mobiledoc, _cardOptions = {}) {
         const ghostVersion = mobiledoc.ghostVersion || '4.0';
+
         const defaultCardOptions = {
             ghostVersion,
             target: 'html'
         };
         const cardOptions = Object.assign({}, defaultCardOptions, _cardOptions);
-        const rendererOptions = Object.assign({}, this.options, {cardOptions});
+
+        const sectionElementRenderer = {
+            ASIDE: function (tagName, dom) {
+                // we use ASIDE sections in Koenig as a workaround for applying
+                // a different blockquote style because mobiledoc doesn't support
+                // storing arbitrary attributes with sections
+                const blockquote = dom.createElement('blockquote');
+                blockquote.setAttribute('class', 'kg-blockquote-alt');
+                return blockquote;
+            }
+        };
+
+        const rendererOptions = Object.assign({}, this.options, {cardOptions, sectionElementRenderer});
         const renderer = new Renderer(rendererOptions);
         const rendered = renderer.render(mobiledoc);
         const serializer = new SimpleDom.HTMLSerializer(SimpleDom.voidMap);
@@ -119,7 +127,7 @@ class MobiledocHtmlRenderer {
 
         // Walk the DOM output and modify nodes as needed
         // eg. to add ID attributes to heading elements
-        const modifier = new DomModifier({ghostVersion});
+        const modifier = new DomModifier(Object.assign({}, cardOptions, {dom: this.options.dom}));
         modifier.modifyChildren(rendered.result);
 
         const output = serializer.serializeChildren(rendered.result);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/kg-mobiledoc-html-renderer",
-  "version": "5.2.0",
+  "version": "5.3.3",
   "repository": "https://github.com/TryGhost/Koenig/tree/master/packages/kg-mobiledoc-html-renderer",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -22,12 +22,12 @@
     "access": "public"
   },
   "dependencies": {
+    "@tryghost/kg-utils": "^1.0.0",
     "mobiledoc-dom-renderer": "^0.7.0",
-    "semver": "^7.3.4",
     "simple-dom": "^1.4.0"
   },
   "devDependencies": {
-    "c8": "7.10.0"
+    "c8": "7.11.0"
   },
-  "gitHead": "5fbc876127879babe588a577bc810038c98df5ef"
+  "gitHead": "615a20445876522e113a8770ada332e8c00d939b"
 }