@tryghost/url-utils 4.3.1 → 4.4.0

package/lib/utils/_lexical-transform.js

@@ -1,3 +1,13 @@
+const _ = require('lodash');
+
+// options.transformMap = {
+//     relativeToAbsolute: {
+//         url: (url, siteUrl, itemPath, options) => 'transformedUrl',
+//         html: (html, siteUrl, itemPath, options) => 'transformedHtml',
+//     }
+// }
+// options.transformType = 'relativeToAbsolute'
+
 function lexicalTransform(serializedLexical, siteUrl, transformFunction, itemPath, _options = {}) {
     const defaultOptions = {assetsOnly: false, secure: false, nodes: [], transformMap: {}};
     const options = Object.assign({}, defaultOptions, _options, {siteUrl, itemPath});
@@ -14,21 +24,42 @@ function lexicalTransform(serializedLexical, siteUrl, transformFunction, itemPat
         return serializedLexical;
     }
 
+    // create a map of node types to urlTransformMap objects
+    // e.g. {'image': {src: 'url', caption: 'html'}
     const nodeMap = new Map();
     options.nodes.forEach(node => node.urlTransformMap && nodeMap.set(node.getType(), node.urlTransformMap));
 
+    const transformProperty = function (obj, propertyPath, transform) {
+        const propertyValue = _.get(obj, propertyPath);
+
+        if (Array.isArray(propertyValue)) {
+            propertyValue.forEach((item) => {
+                // arrays of objects need to be defined as a nested object in the urlTransformMap
+                // so the `transform` value is that nested object
+                Object.entries(transform).forEach(([itemPropertyPath, itemTransform]) => {
+                    transformProperty(item, itemPropertyPath, itemTransform);
+                });
+            });
+
+            return;
+        }
+
+        if (propertyValue) {
+            _.set(obj, propertyPath, options.transformMap[options.transformType][transform](propertyValue));
+        }
+    };
+
+    // recursively walk the Lexical node tree transforming any card data properties and links
     const transformChildren = function (children) {
         for (const child of children) {
-            // cards (nodes) have a `type` attribute in their node data
-            if (child.type && nodeMap.has(child.type)) {
-                Object.entries(nodeMap.get(child.type)).forEach(([property, transform]) => {
-                    if (child[property]) {
-                        child[property] = options.transformMap[options.transformType][transform](child[property]);
-                    }
+            const isCard = child.type && nodeMap.has(child.type);
+            const isLink = !!child.url;
+
+            if (isCard) {
+                Object.entries(nodeMap.get(child.type)).forEach(([propertyPath, transform]) => {
+                    transformProperty(child, propertyPath, transform);
                 });
-            } else if (child.url) {
-                // any lexical links will be a child object with a `url` attribute,
-                // recursively walk the tree transforming any `.url`s
+            } else if (isLink) {
                 child.url = transformFunction(child.url, siteUrl, itemPath, options);
             }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/url-utils",
-  "version": "4.3.1",
+  "version": "4.4.0",
   "repository": "https://github.com/TryGhost/SDK/tree/master/packages/url-utils",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -19,12 +19,12 @@
     "access": "public"
   },
   "devDependencies": {
-    "@tryghost/config-url-helpers": "^1.0.5",
+    "@tryghost/config-url-helpers": "^1.0.6",
     "c8": "7.13.0",
     "mocha": "10.2.0",
     "rewire": "6.0.0",
     "should": "13.2.3",
-    "sinon": "15.0.1"
+    "sinon": "15.0.2"
   },
   "dependencies": {
     "cheerio": "^0.22.0",
@@ -34,5 +34,5 @@
     "remark-footnotes": "^1.0.0",
     "unist-util-visit": "^2.0.0"
   },
-  "gitHead": "1046738d867fc64428bbd3a80a340d89b7ccbea2"
+  "gitHead": "75e59f16ab0206aac74eed1daac91c2d54f3c695"
 }