@adobe/helix-html-pipeline 1.0.2 → 1.0.5

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [1.0.5](https://github.com/adobe/helix-html-pipeline/compare/v1.0.4...v1.0.5) (2022-03-08)
+
+
+### Bug Fixes
+
+* re-add lost image unwrapper ([#10](https://github.com/adobe/helix-html-pipeline/issues/10)) ([0f2b66e](https://github.com/adobe/helix-html-pipeline/commit/0f2b66eed2157717d0edc321fbd3430d4ce4b42c))
+
+## [1.0.4](https://github.com/adobe/helix-html-pipeline/compare/v1.0.3...v1.0.4) (2022-03-08)
+
+
+### Bug Fixes
+
+* no special headers init for PipelineResponse ([#9](https://github.com/adobe/helix-html-pipeline/issues/9)) ([7288677](https://github.com/adobe/helix-html-pipeline/commit/72886779f6ba0f8d07ea14757a8097034262e215))
+
+## [1.0.3](https://github.com/adobe/helix-html-pipeline/compare/v1.0.2...v1.0.3) (2022-03-08)
+
+
+### Bug Fixes
+
+* fix canonical url and 404.html response, clean up meta ([5f3e999](https://github.com/adobe/helix-html-pipeline/commit/5f3e999a6e305fb6ecf7d2fefe3a38274a135433))
+
 ## [1.0.2](https://github.com/adobe/helix-html-pipeline/compare/v1.0.1...v1.0.2) (2022-03-08)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "1.0.2",
+  "version": "1.0.5",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/PipelineResponse.js

@@ -19,7 +19,7 @@ export class PipelineResponse {
    * Creates the pipeline response
    */
   constructor(body = undefined, init = {}) {
-    let headers = init.headers ?? new Map([['content-type', 'text/html; charset=utf-8']]);
+    let headers = init.headers ?? new Map();
     if (typeof headers.get !== 'function') {
       headers = new Map(Object.entries(init.headers));
     }

package/src/html-pipe.js

@@ -30,6 +30,7 @@ import rewriteIcons from './steps/rewrite-icons.js';
 import setXSurrogateKeyHeader from './steps/set-x-surrogate-key-header.js';
 import setCustomResponseHeaders from './steps/set-custom-response-headers.js';
 import splitSections from './steps/split-sections.js';
+import unwrapSoleImages from './steps/unwrap-sole-images.js';
 import tohtml from './steps/stringify-response.js';
 import { PipelineStatusError } from './PipelineStatusError.js';
 import { PipelineResponse } from './PipelineResponse.js';
@@ -54,7 +55,11 @@ export async function htmlPipe(state, req) {
   }
 
   /** @type PipelineResponse */
-  const res = new PipelineResponse();
+  const res = new PipelineResponse('', {
+    headers: {
+      'content-type': 'text/html; charset=utf-8',
+    },
+  });
 
   try { // fetch config first, since we need to compute the content-bus-id from the fstab ...
     await fetchConfig(state, req, res);
@@ -80,6 +85,7 @@ export async function htmlPipe(state, req) {
       await parseMarkdown(state);
       await splitSections(state);
       await getMetadata(state); // this one extracts the metadata from the mdast
+      await unwrapSoleImages(state);
       await html(state);
       await rewriteBlobImages(state);
       await rewriteIcons(state);

package/src/index.js

@@ -16,3 +16,8 @@ export * from './PipelineRequest.js';
 export * from './PipelineResponse.js';
 export * from './PipelineState.js';
 export * from './PipelineStatusError.js';
+
+export { default as fetchMetadata } from './steps/fetch-metadata.js';
+export { default as fetchConfig } from './steps/fetch-config.js';
+export { default as setCustomResponseHeaders } from './steps/set-custom-response-headers.js';
+export { getOriginalHost } from './steps/utils.js';

package/src/steps/extract-metadata.js

@@ -11,17 +11,7 @@
  */
 import { resolve } from 'url';
 import { getAbsoluteUrl, makeCanonicalHtmlUrl, optimizeImageURL } from './utils.js';
-
-/**
- * Converts all non-valid characters to `-`.
- * @param {string} text input text
- * @returns {string} the meta name
- */
-function toMetaName(text) {
-  return text
-    .toLowerCase()
-    .replace(/[^0-9a-z:_]/gi, '-');
-}
+import { filterGlobalMetadata, toMetaName, ALLOWED_RESPONSE_HEADERS } from '../utils/metadata.js';
 
 /**
  * Cleans up comma-separated string lists and returns an array.
@@ -98,40 +88,6 @@ function readBlockConfig($block) {
   return config;
 }
 
-function applyMetaRule(target, obj) {
-  Object.keys(obj).forEach((key) => {
-    const metaKey = toMetaName(key);
-    if (metaKey !== 'url' && obj[key]) {
-      target[metaKey] = obj[key];
-    }
-  });
-}
-
-function globToRegExp(glob) {
-  const reString = glob
-    .replace(/\*\*/g, '_')
-    .replace(/\*/g, '[0-9a-z-.]*')
-    .replace(/_/g, '.*');
-  return new RegExp(`^${reString}$`);
-}
-
-export function filterGlobalMetadata(metaRules, path) {
-  const metaConfig = {};
-  metaRules.forEach((rule) => {
-    const glob = rule.url || rule.URL || rule.Url;
-    if (glob && typeof glob === 'string' && /[0-9a-z-/*]/.test(glob)) {
-      if (glob.indexOf('*') >= 0) {
-        if (globToRegExp(glob).test(path)) {
-          applyMetaRule(metaConfig, rule);
-        }
-      } else if (glob === path) {
-        applyMetaRule(metaConfig, rule);
-      }
-    }
-  });
-  return metaConfig;
-}
-
 /**
  * Looks for metadata in the document.
  * @param {HTMLDocument} document The document
@@ -196,11 +152,13 @@ export default function extractMetaData(state, req) {
   });
   if (Object.keys(metaConfig).length > 0) {
     // add rest to meta.custom
-    meta.custom = Object.keys(metaConfig).map((name) => ({
-      name,
-      value: metaConfig[name],
-      property: name.includes(':'),
-    }));
+    meta.custom = Object.entries(metaConfig)
+      .filter(([name]) => !ALLOWED_RESPONSE_HEADERS.includes(name))
+      .map(([name, value]) => ({
+        name,
+        value,
+        property: name.includes(':'),
+      }));
   }
 
   if (meta.keywords) {

package/src/steps/set-custom-response-headers.js

@@ -10,18 +10,7 @@
  * governing permissions and limitations under the License.
  */
 import { cleanupHeaderValue } from '@adobe/helix-shared-utils';
-import { filterGlobalMetadata } from './extract-metadata.js';
-
-/**
- * Array of headers allowed in the metadata.json file.
- */
-const allowList = [
-  'content-security-policy',
-  'content-security-policy-report-only',
-  'access-control-allow-origin',
-  'access-control-allow-methods',
-  'link',
-];
+import { filterGlobalMetadata, ALLOWED_RESPONSE_HEADERS } from '../utils/metadata.js';
 
 /**
  * Decorates the pipeline response object with the headers defined in metadata.json.
@@ -34,7 +23,7 @@ const allowList = [
 export default function setCustomResponseHeaders(state, req, res) {
   const meta = filterGlobalMetadata(state.metadata, state.info.path);
   Object.entries(meta).forEach(([name, value]) => {
-    if (allowList.includes(name)) {
+    if (ALLOWED_RESPONSE_HEADERS.includes(name)) {
       res.headers.set(name, cleanupHeaderValue(value));
     }
   });

package/src/steps/unwrap-sole-images.js

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2019 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import { map } from 'unist-util-map';
+
+/**
+ * Unwraps hero images to avoid the unnecessary paragraph.
+ *
+ * @param {object} request The content request
+ */
+export default function unwrap({ content }) {
+  let sections = content.mdast.children.filter((node) => node.type === 'section');
+  if (!sections.length) {
+    sections = [content.mdast];
+  }
+  sections.forEach((section) => {
+    map(section, (node, index, parent) => {
+      if (node.type === 'paragraph' // If we have a paragraph
+        && (parent.type === 'root' // … in the document root
+          || parent.type === 'section') // … or in a section
+        && parent.meta.types.includes('has-only-image') // … that only has images
+        && parent.meta.types.includes('nb-image-1')) { // … and actually only 1 of them
+        // … then consider it a hero image, and unwrap from the paragraph
+        const position = parent.children.indexOf(node);
+        const [img] = parent.children[position].children;
+        parent.children[position] = img;
+      }
+    });
+  });
+}

package/src/utils/metadata.js

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2022 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+/**
+ * Converts all non-valid characters to `-`.
+ * @param {string} text input text
+ * @returns {string} the meta name
+ */
+export function toMetaName(text) {
+  return text
+    .toLowerCase()
+    .replace(/[^0-9a-z:_]/gi, '-');
+}
+
+function applyMetaRule(target, obj) {
+  Object.keys(obj).forEach((key) => {
+    const metaKey = toMetaName(key);
+    if (metaKey !== 'url' && obj[key]) {
+      target[metaKey] = obj[key];
+    }
+  });
+}
+
+function globToRegExp(glob) {
+  const reString = glob
+    .replace(/\*\*/g, '_')
+    .replace(/\*/g, '[0-9a-z-.]*')
+    .replace(/_/g, '.*');
+  return new RegExp(`^${reString}$`);
+}
+
+export function filterGlobalMetadata(metaRules, path) {
+  const metaConfig = {};
+  metaRules.forEach((rule) => {
+    const glob = rule.url || rule.URL || rule.Url;
+    if (glob && typeof glob === 'string' && /[0-9a-z-/*]/.test(glob)) {
+      if (glob.indexOf('*') >= 0) {
+        if (globToRegExp(glob).test(path)) {
+          applyMetaRule(metaConfig, rule);
+        }
+      } else if (glob === path) {
+        applyMetaRule(metaConfig, rule);
+      }
+    }
+  });
+  return metaConfig;
+}
+
+/**
+ * Array of headers allowed in the metadata.json file.
+ */
+export const ALLOWED_RESPONSE_HEADERS = [
+  'content-security-policy',
+  'content-security-policy-report-only',
+  'access-control-allow-origin',
+  'access-control-allow-methods',
+  'link',
+];