@adobe/helix-html-pipeline 5.11.13 → 5.12.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [5.12.1](https://github.com/adobe/helix-html-pipeline/compare/v5.12.0...v5.12.1) (2024-08-12)
+
+
+### Bug Fixes
+
+* escape HTML characters in JSON LD ([#666](https://github.com/adobe/helix-html-pipeline/issues/666)) ([e669242](https://github.com/adobe/helix-html-pipeline/commit/e669242845a990dc8ffa8342b3eb09833db5d55b))
+
+# [5.12.0](https://github.com/adobe/helix-html-pipeline/compare/v5.11.13...v5.12.0) (2024-07-31)
+
+
+### Features
+
+* include json-ld from metadata ([#657](https://github.com/adobe/helix-html-pipeline/issues/657)) ([56c7d37](https://github.com/adobe/helix-html-pipeline/commit/56c7d376014583e8d6664886902ebc2400874bb2)), closes [#648](https://github.com/adobe/helix-html-pipeline/issues/648)
+
 ## [5.11.13](https://github.com/adobe/helix-html-pipeline/compare/v5.11.12...v5.11.13) (2024-07-15)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "5.11.13",
+  "version": "5.12.1",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -82,13 +82,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.4",
     "js-yaml": "4.1.0",
-    "jsdom": "24.1.0",
-    "junit-report-builder": "3.2.1",
-    "lint-staged": "15.2.7",
-    "mocha": "10.6.0",
+    "jsdom": "24.1.1",
+    "junit-report-builder": "5.0.0",
+    "lint-staged": "15.2.8",
+    "mocha": "10.7.3",
     "mocha-multi-reporters": "1.5.1",
     "mocha-suppress-logs": "0.5.1",
     "semantic-release": "24.0.0"

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,11 @@ function createElement(name, ...attrs) {
   return h(name, properties);
 }
 
+function sanitizeJsonLd(jsonLd) {
+  const sanitizedJsonLd = jsonLd.replaceAll('<', '&#x3c;').replaceAll('>', '&#x3e;');
+  return JSON.stringify(JSON.parse(sanitizedJsonLd.trim()));
+}
+
 /**
  * @type PipelineStep
  * @param {PipelineState} state
@@ -59,7 +65,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 +83,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.helixConfig?.head?.data.html;
   if (headHtml) {