@adobe/helix-html-pipeline 1.4.0 → 1.5.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [1.5.0](https://github.com/adobe/helix-html-pipeline/compare/v1.4.2...v1.5.0) (2022-05-04)
+
+
+### Features
+
+* always add twitter:card ([4b14e31](https://github.com/adobe/helix-html-pipeline/commit/4b14e3144625d9b457079ae7fc654621e3271e14)), closes [#46](https://github.com/adobe/helix-html-pipeline/issues/46)
+
+## [1.4.2](https://github.com/adobe/helix-html-pipeline/compare/v1.4.1...v1.4.2) (2022-05-03)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-shared-utils to v2.0.9 ([2aee8a3](https://github.com/adobe/helix-html-pipeline/commit/2aee8a3c70388a220bacdef1671e6c899b02736f))
+
+## [1.4.1](https://github.com/adobe/helix-html-pipeline/compare/v1.4.0...v1.4.1) (2022-04-16)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-shared-utils to v2.0.8 ([9c7e30d](https://github.com/adobe/helix-html-pipeline/commit/9c7e30daccfab99e0dc5861f7105c0eee6c88ca5))
+
 # [1.4.0](https://github.com/adobe/helix-html-pipeline/compare/v1.3.4...v1.4.0) (2022-04-12)
 
 

package/README.md

@@ -1,6 +1,6 @@
 # Helix HTML Pipeline
 
-This package contains the common code for `helix-pipeline-service` and `helix-cloudflare-pipeline` for rendering the html response for helix3. it has the following design goals:
+This package contains the common code for `helix-pipeline-service` and `helix-cloudflare-page` for rendering the html response for helix3. it has the following design goals:
 
 - be platform neutral, i.e. not using node or browser specific modules or dependencies.
 - +/-0 runtime dependencies (eg. node [crypto](https://nodejs.org/api/crypto.html))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -33,7 +33,7 @@
   },
   "dependencies": {
     "@adobe/helix-markdown-support": "3.1.2",
-    "@adobe/helix-shared-utils": "2.0.7",
+    "@adobe/helix-shared-utils": "2.0.9",
     "github-slugger": "1.4.0",
     "hast-util-raw": "7.2.1",
     "hast-util-select": "5.0.1",
@@ -67,16 +67,16 @@
   },
   "devDependencies": {
     "@adobe/eslint-config-helix": "1.3.2",
-    "@markedjs/html-differ": "4.0.1",
+    "@markedjs/html-differ": "4.0.2",
     "@semantic-release/changelog": "6.0.1",
     "@semantic-release/git": "10.0.1",
     "@semantic-release/npm": "9.0.1",
-    "c8": "7.11.0",
+    "c8": "7.11.2",
     "chalk-template": "0.4.0",
     "codecov": "3.8.3",
     "commitizen": "4.2.4",
     "cz-conventional-changelog": "3.3.0",
-    "eslint": "8.13.0",
+    "eslint": "8.14.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.26.0",
     "esmock": "1.7.5",
@@ -85,8 +85,8 @@
     "jsdoc-to-markdown": "7.1.1",
     "jsdom": "19.0.0",
     "junit-report-builder": "3.0.0",
-    "lint-staged": "12.3.7",
-    "mocha": "9.2.2",
+    "lint-staged": "12.4.1",
+    "mocha": "10.0.0",
     "mocha-multi-reporters": "1.5.1",
     "remark-gfm": "3.0.1",
     "semantic-release": "19.0.2"

package/src/steps/extract-metadata.js

@@ -161,6 +161,8 @@ export default function extractMetaData(state, req) {
     getLocalMetadata(hast),
   );
 
+  const IGNORED_CUSTOM_META = [...ALLOWED_RESPONSE_HEADERS, 'twitter:card'];
+
   // first process supported metadata properties
   [
     'title',
@@ -180,7 +182,7 @@ export default function extractMetaData(state, req) {
   if (Object.keys(metaConfig).length > 0) {
     // add rest to meta.custom
     meta.custom = Object.entries(metaConfig)
-      .filter(([name]) => !ALLOWED_RESPONSE_HEADERS.includes(name))
+      .filter(([name]) => !IGNORED_CUSTOM_META.includes(name))
       .map(([name, value]) => ({
         name,
         value,
@@ -188,6 +190,9 @@ export default function extractMetaData(state, req) {
       }));
   }
 
+  // default value for twitter:card (mandatory for rendering URLs as cards in tweets)
+  meta['twitter:card'] = metaConfig['twitter:card'] || 'summary_large_image';
+
   if (meta.keywords) {
     meta.keywords = toList(meta.keywords).join(', ');
   }

package/src/steps/render.js

@@ -71,6 +71,7 @@ export default async function render(state, req, res) {
   appendElement($head, createElement('meta', 'property', 'article:section', 'content', content.meta.section));
   appendElement($head, createElement('meta', 'property', 'article:published_time', 'content', content.meta.published_time));
   appendElement($head, createElement('meta', 'property', 'article:modified_time', 'content', content.meta.modified_time));
+  appendElement($head, createElement('meta', 'name', 'twitter:card', 'content', content.meta['twitter:card']));
   appendElement($head, createElement('meta', 'name', 'twitter:title', 'content', content.meta.title));
   appendElement($head, createElement('meta', 'name', 'twitter:description', 'content', content.meta.description));
   appendElement($head, createElement('meta', 'name', 'twitter:image', 'content', content.meta.image));