@adobe/helix-html-pipeline 6.12.10 → 6.14.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [6.14.0](https://github.com/adobe/helix-html-pipeline/compare/v6.13.0...v6.14.0) (2024-08-01)
+
+
+### Features
+
+* make json-ld metadata more robust ([#658](https://github.com/adobe/helix-html-pipeline/issues/658)) ([3d3e5dc](https://github.com/adobe/helix-html-pipeline/commit/3d3e5dc5e39a601a5f9b225d6409f2cfbdefc138))
+
+# [6.13.0](https://github.com/adobe/helix-html-pipeline/compare/v6.12.10...v6.13.0) (2024-07-30)
+
+
+### Features
+
+* include json-ld from metadata ([f1c9f3f](https://github.com/adobe/helix-html-pipeline/commit/f1c9f3f5b1980dec8dc257c4f1f36f75fb0a0a69)), closes [#648](https://github.com/adobe/helix-html-pipeline/issues/648)
+
 ## [6.12.10](https://github.com/adobe/helix-html-pipeline/compare/v6.12.9...v6.12.10) (2024-07-07)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "6.12.10",
+  "version": "6.14.0",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -80,13 +80,13 @@
     "eslint-import-resolver-exports": "1.0.0-beta.5",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.29.1",
-    "esmock": "2.6.6",
-    "husky": "9.0.11",
+    "esmock": "2.6.7",
+    "husky": "9.1.3",
     "js-yaml": "4.1.0",
-    "jsdom": "24.1.0",
-    "junit-report-builder": "3.2.1",
+    "jsdom": "24.1.1",
+    "junit-report-builder": "4.0.0",
     "lint-staged": "15.2.7",
-    "mocha": "10.6.0",
+    "mocha": "10.7.0",
     "mocha-multi-reporters": "1.5.1",
     "mocha-suppress-logs": "0.5.1",
     "semantic-release": "24.0.0"

package/src/steps/extract-metadata.js

@@ -43,6 +43,12 @@ function readBlockConfig($block) {
       const [$name, $value] = $row.children;
       const name = toMetaName(toString($name));
       if (name) {
+        // special case for json-ld. don't apply any special formatting
+        if (name.toLowerCase() === 'json-ld') {
+          config[name] = toString($value).trim();
+          return;
+        }
+
         let value;
         const $firstChild = childNodes($value)[0];
         if ($firstChild) {

package/src/steps/render.js

@@ -14,6 +14,7 @@
 import { h } from 'hastscript';
 import { unified } from 'unified';
 import rehypeParse from 'rehype-parse';
+import { cleanupHeaderValue } from '@adobe/helix-shared-utils';
 
 function appendElement($parent, $el) {
   if ($el) {
@@ -34,6 +35,13 @@ function createElement(name, ...attrs) {
   return h(name, properties);
 }
 
+function sanitizeJsonLd(jsonLd) {
+  if (jsonLd.toLowerCase().indexOf('</script>') >= 0) {
+    throw new Error('script tag not allowed');
+  }
+  return JSON.stringify(JSON.parse(jsonLd.trim()));
+}
+
 /**
  * @type PipelineStep
  * @param {PipelineState} state
@@ -59,7 +67,13 @@ export default async function render(state, req, res) {
     appendElement($head, createElement('link', 'rel', 'canonical', 'href', meta.canonical));
   }
 
+  let jsonLd;
   for (const [name, value] of Object.entries(meta.page)) {
+    if (name.toLowerCase() === 'json-ld') {
+      jsonLd = value;
+      // eslint-disable-next-line no-continue
+      continue;
+    }
     const attr = name.includes(':') && !name.startsWith('twitter:') ? 'property' : 'name';
     if (Array.isArray(value)) {
       for (const v of value) {
@@ -71,6 +85,19 @@ export default async function render(state, req, res) {
   }
   appendElement($head, createElement('link', 'rel', 'alternate', 'type', 'application/xml+atom', 'href', meta.feed, 'title', `${meta.title} feed`));
 
+  // inject json ld if valid
+  if (jsonLd) {
+    const props = { type: 'application/ld+json' };
+    try {
+      jsonLd = sanitizeJsonLd(jsonLd);
+    } catch (e) {
+      jsonLd = '';
+      props['data-error'] = `error in json-ld: ${cleanupHeaderValue(e.message)}`;
+    }
+    const script = h('script', props, jsonLd);
+    $head.children.push(script);
+  }
+
   // inject head.html
   const headHtml = state.config?.head?.html;
   if (headHtml) {