@adobe/helix-html-pipeline 1.7.1 → 1.8.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.8.0](https://github.com/adobe/helix-html-pipeline/compare/v1.7.1...v1.8.0) (2022-09-21)
+
+
+### Features
+
+* respect folder mapping also for json ([52b6ca0](https://github.com/adobe/helix-html-pipeline/commit/52b6ca0cf801d5211fb19aff5cd343c8746c5ac1)), closes [#140](https://github.com/adobe/helix-html-pipeline/issues/140)
+
 ## [1.7.1](https://github.com/adobe/helix-html-pipeline/compare/v1.7.0...v1.7.1) (2022-09-13)
 
 

package/README.md

@@ -19,11 +19,6 @@ This package contains the common code for `helix-pipeline-service` and `helix-cl
 ```bash
 $ npm install @adobe/helix-html-pipeline
 ```
-
-## Usage
-
-See the [API documentation](docs/API.md).
-
 ## Development
 
 ### Build

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -8,7 +8,6 @@
   "scripts": {
     "test": " c8 mocha",
     "lint": "eslint .",
-    "docs": "npx jsdoc2md -c .jsdoc.json --files 'src/*.js'  > docs/API.md",
     "semantic-release": "semantic-release",
     "prepare": "husky install"
   },
@@ -40,9 +39,9 @@
     "hastscript": "7.0.2",
     "mdast-util-gfm-footnote": "1.0.1",
     "mdast-util-gfm-strikethrough": "1.0.1",
-    "mdast-util-gfm-table": "1.0.4",
+    "mdast-util-gfm-table": "1.0.6",
     "mdast-util-gfm-task-list-item": "1.0.1",
-    "mdast-util-to-hast": "12.2.1",
+    "mdast-util-to-hast": "12.2.2",
     "mdast-util-to-string": "3.1.0",
     "micromark-extension-gfm-footnote": "1.0.4",
     "micromark-extension-gfm-strikethrough": "1.0.4",
@@ -70,14 +69,13 @@
     "@semantic-release/git": "10.0.1",
     "@semantic-release/npm": "9.0.1",
     "c8": "7.12.0",
-    "eslint": "8.23.0",
+    "eslint": "8.23.1",
     "eslint-import-resolver-exports": "1.0.0-beta.3",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.26.0",
-    "esmock": "2.0.0",
+    "esmock": "2.0.1",
     "husky": "8.0.1",
     "js-yaml": "4.1.0",
-    "jsdoc-to-markdown": "7.1.1",
     "jsdom": "20.0.0",
     "junit-report-builder": "3.0.1",
     "lint-staged": "13.0.3",

package/src/html-pipe.js

@@ -67,7 +67,7 @@ export async function htmlPipe(state, req) {
     await fetchConfig(state, req, res);
 
     // ...and apply the folder mapping
-    await folderMapping(state, req, res);
+    await folderMapping(state);
 
     // load metadata and content in parallel
     state.timer?.update('content-fetch');

package/src/json-pipe.js

@@ -14,6 +14,30 @@ import setCustomResponseHeaders from './steps/set-custom-response-headers.js';
 import { PipelineResponse } from './PipelineResponse.js';
 import jsonFilter from './utils/json-filter.js';
 import { extractLastModified, updateLastModified } from './utils/last-modified.js';
+import fetchConfig from './steps/fetch-config.js';
+import { getPathInfo } from './utils/path.js';
+
+/**
+ * Checks the fstab for folder mapping entries and then re-adjusts the path infos if needed.
+ * Note that json can only be mapped using direct documents mapping.
+ *
+ * @type PipelineStep
+ * @param {PipelineState} state
+ */
+export default function folderMapping(state) {
+  const folders = state.helixConfig?.fstab?.data.folders;
+  if (!folders) {
+    return;
+  }
+  const { path } = state.info;
+  const mapped = folders[path];
+  if (mapped) {
+    state.info = getPathInfo(mapped);
+    state.info.unmappedPath = path;
+    state.info.resourcePath = mapped;
+    state.log.info(`mapped ${path} to ${state.info.resourcePath} (${state.content.sourceBus}-bus)`);
+  }
+}
 
 /**
  * Runs the default pipeline and returns the response.
@@ -27,7 +51,7 @@ export async function jsonPipe(state, req) {
   const {
     owner, repo, ref, contentBusId, partition, s3Loader,
   } = state;
-  const { path } = state.info;
+  const { extension } = state.info;
   const { searchParams } = req.url;
   const params = Object.fromEntries(searchParams.entries());
   if (params.sheet) {
@@ -39,7 +63,7 @@ export async function jsonPipe(state, req) {
     sheet,
   } = params;
 
-  if (!path.endsWith('.json')) {
+  if (extension !== '.json') {
     log.error('only json resources supported.');
     return new PipelineResponse('', {
       status: 400,
@@ -49,7 +73,12 @@ export async function jsonPipe(state, req) {
     });
   }
 
+  // fetch config and apply the folder mapping
+  await fetchConfig(state, req);
+  await folderMapping(state);
+
   // fetch data from content bus
+  const { path } = state.info;
   state.timer?.update('json-fetch');
   let dataResponse = await s3Loader.getObject('helix-content-bus', `${contentBusId}/${partition}${path}`);
 

package/src/steps/fetch-config.js

@@ -17,7 +17,7 @@ import { PipelineStatusError } from '../PipelineStatusError.js';
  * @type PipelineStep
  * @param {PipelineState} state
  * @param {PipelineRequest} req
- * @param {PipelineResponse} res
+ * @param {PipelineResponse} [res]
  * @returns {Promise<void>}
  */
 export default async function fetchConfig(state, req, res) {
@@ -47,15 +47,17 @@ export default async function fetchConfig(state, req, res) {
     });
   }
 
-  // also update last-modified
-  const configLastModified = extractLastModified(ret.headers);
+  if (res) {
+    // also update last-modified
+    const configLastModified = extractLastModified(ret.headers);
 
-  // update last modified of fstab
-  updateLastModified(state, res, config.fstab?.lastModified || configLastModified);
+    // update last modified of fstab
+    updateLastModified(state, res, config.fstab?.lastModified || configLastModified);
 
-  // for html requests, also consider the HEAD config
-  if (state.type === 'html' && state.info.selector !== 'plain' && config.head?.lastModified) {
-    updateLastModified(state, res, config.head.lastModified);
+    // for html requests, also consider the HEAD config
+    if (state.type === 'html' && state.info.selector !== 'plain' && config.head?.lastModified) {
+      updateLastModified(state, res, config.head.lastModified);
+    }
   }
 
   state.helixConfig = config;

package/docs/API.md

@@ -1,251 +0,0 @@
-## Classes
-
-<dl>
-<dt><a href="#PipelineState">PipelineState</a></dt>
-<dd></dd>
-<dt><a href="#PipelineRequest">PipelineRequest</a></dt>
-<dd></dd>
-<dt><a href="#PipelineResponse">PipelineResponse</a></dt>
-<dd></dd>
-<dt><a href="#PipelineState">PipelineState</a></dt>
-<dd></dd>
-</dl>
-
-## Functions
-
-<dl>
-<dt><a href="#searchParamsToObject">searchParamsToObject(searchParams)</a> ⇒ <code>Object</code></dt>
-<dd><p>Converts URLSearchParams to an object</p>
-</dd>
-<dt><a href="#extractBodyData">extractBodyData(request)</a> ⇒ <code>Object</code></dt>
-<dd><p>Extracts and parses the body data from the request</p>
-</dd>
-<dt><a href="#formsPipe">formsPipe(state, request)</a> ⇒ <code><a href="#PipelineResponse">Promise.&lt;PipelineResponse&gt;</a></code></dt>
-<dd><p>Handle a pipeline POST request.
-At this point POST&#39;s only apply to json files that are backed by a workbook.</p>
-</dd>
-<dt><a href="#htmlPipe">htmlPipe(state, req)</a> ⇒ <code><a href="#PipelineResponse">PipelineResponse</a></code></dt>
-<dd><p>Runs the default pipeline and returns the response.</p>
-</dd>
-<dt><a href="#jsonPipe">jsonPipe(state, req)</a> ⇒ <code><a href="#PipelineResponse">PipelineResponse</a></code></dt>
-<dd><p>Runs the default pipeline and returns the response.</p>
-</dd>
-<dt><a href="#optionsPipe">optionsPipe(state, request)</a> ⇒ <code>Response</code></dt>
-<dd><p>Handles options requests</p>
-</dd>
-</dl>
-
-<a name="PipelineState"></a>
-
-## PipelineState
-**Kind**: global class  
-
-* [PipelineState](#PipelineState)
-    * [new PipelineState()](#new_PipelineState_new)
-    * [new PipelineState()](#new_PipelineState_new)
-    * [.PipelineState](#PipelineState+PipelineState)
-        * [new exports.PipelineState(opts)](#new_PipelineState+PipelineState_new)
-
-<a name="new_PipelineState_new"></a>
-
-### new PipelineState()
-State of the pipeline
-
-<a name="new_PipelineState_new"></a>
-
-### new PipelineState()
-State of the pipeline
-
-<a name="PipelineState+PipelineState"></a>
-
-### pipelineState.PipelineState
-**Kind**: instance class of [<code>PipelineState</code>](#PipelineState)  
-<a name="new_PipelineState+PipelineState_new"></a>
-
-#### new exports.PipelineState(opts)
-Creates the pipeline state
-
-
-| Param | Type |
-| --- | --- |
-| opts | <code>PipelineOptions</code> | 
-
-<a name="PipelineRequest"></a>
-
-## PipelineRequest
-**Kind**: global class  
-
-* [PipelineRequest](#PipelineRequest)
-    * [new PipelineRequest()](#new_PipelineRequest_new)
-    * [.PipelineRequest](#PipelineRequest+PipelineRequest)
-        * [new exports.PipelineRequest(url, [init])](#new_PipelineRequest+PipelineRequest_new)
-
-<a name="new_PipelineRequest_new"></a>
-
-### new PipelineRequest()
-Request of a pipeline
-
-<a name="PipelineRequest+PipelineRequest"></a>
-
-### pipelineRequest.PipelineRequest
-**Kind**: instance class of [<code>PipelineRequest</code>](#PipelineRequest)  
-<a name="new_PipelineRequest+PipelineRequest_new"></a>
-
-#### new exports.PipelineRequest(url, [init])
-Creates the pipeline request
-
-
-| Param | Type |
-| --- | --- |
-| url | <code>URL</code> \| <code>string</code> | 
-| [init] | <code>PipelineRequestInit</code> | 
-
-<a name="PipelineResponse"></a>
-
-## PipelineResponse
-**Kind**: global class  
-
-* [PipelineResponse](#PipelineResponse)
-    * [new PipelineResponse()](#new_PipelineResponse_new)
-    * [.PipelineResponse](#PipelineResponse+PipelineResponse)
-        * [new exports.PipelineResponse()](#new_PipelineResponse+PipelineResponse_new)
-    * [.json()](#PipelineResponse+json) ⇒ <code>object</code>
-
-<a name="new_PipelineResponse_new"></a>
-
-### new PipelineResponse()
-Response of a pipeline
-
-<a name="PipelineResponse+PipelineResponse"></a>
-
-### pipelineResponse.PipelineResponse
-**Kind**: instance class of [<code>PipelineResponse</code>](#PipelineResponse)  
-<a name="new_PipelineResponse+PipelineResponse_new"></a>
-
-#### new exports.PipelineResponse()
-Creates the pipeline response
-
-<a name="PipelineResponse+json"></a>
-
-### pipelineResponse.json() ⇒ <code>object</code>
-Returns the json parsed object of `this.body`.
-
-**Kind**: instance method of [<code>PipelineResponse</code>](#PipelineResponse)  
-<a name="PipelineState"></a>
-
-## PipelineState
-**Kind**: global class  
-
-* [PipelineState](#PipelineState)
-    * [new PipelineState()](#new_PipelineState_new)
-    * [new PipelineState()](#new_PipelineState_new)
-    * [.PipelineState](#PipelineState+PipelineState)
-        * [new exports.PipelineState(opts)](#new_PipelineState+PipelineState_new)
-
-<a name="new_PipelineState_new"></a>
-
-### new PipelineState()
-State of the pipeline
-
-<a name="new_PipelineState_new"></a>
-
-### new PipelineState()
-State of the pipeline
-
-<a name="PipelineState+PipelineState"></a>
-
-### pipelineState.PipelineState
-**Kind**: instance class of [<code>PipelineState</code>](#PipelineState)  
-<a name="new_PipelineState+PipelineState_new"></a>
-
-#### new exports.PipelineState(opts)
-Creates the pipeline state
-
-
-| Param | Type |
-| --- | --- |
-| opts | <code>PipelineOptions</code> | 
-
-<a name="searchParamsToObject"></a>
-
-## searchParamsToObject(searchParams) ⇒ <code>Object</code>
-Converts URLSearchParams to an object
-
-**Kind**: global function  
-**Returns**: <code>Object</code> - The converted object  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| searchParams | <code>URLSearchParams</code> | the search params object |
-
-<a name="extractBodyData"></a>
-
-## extractBodyData(request) ⇒ <code>Object</code>
-Extracts and parses the body data from the request
-
-**Kind**: global function  
-**Returns**: <code>Object</code> - The body data  
-**Throws**:
-
-- <code>Error</code> If an error occurs parsing the body
-
-
-| Param | Type | Description |
-| --- | --- | --- |
-| request | [<code>PipelineRequest</code>](#PipelineRequest) | the request object (see fetch api) |
-
-<a name="formsPipe"></a>
-
-## formsPipe(state, request) ⇒ [<code>Promise.&lt;PipelineResponse&gt;</code>](#PipelineResponse)
-Handle a pipeline POST request.
-At this point POST's only apply to json files that are backed by a workbook.
-
-**Kind**: global function  
-**Returns**: [<code>Promise.&lt;PipelineResponse&gt;</code>](#PipelineResponse) - a response  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| state | [<code>PipelineState</code>](#PipelineState) | pipeline options |
-| request | [<code>PipelineRequest</code>](#PipelineRequest) |  |
-
-<a name="htmlPipe"></a>
-
-## htmlPipe(state, req) ⇒ [<code>PipelineResponse</code>](#PipelineResponse)
-Runs the default pipeline and returns the response.
-
-**Kind**: global function  
-
-| Param | Type |
-| --- | --- |
-| state | [<code>PipelineState</code>](#PipelineState) | 
-| req | [<code>PipelineRequest</code>](#PipelineRequest) | 
-
-<a name="htmlPipe..res"></a>
-
-### htmlPipe~res : [<code>PipelineResponse</code>](#PipelineResponse)
-**Kind**: inner constant of [<code>htmlPipe</code>](#htmlPipe)  
-<a name="jsonPipe"></a>
-
-## jsonPipe(state, req) ⇒ [<code>PipelineResponse</code>](#PipelineResponse)
-Runs the default pipeline and returns the response.
-
-**Kind**: global function  
-
-| Param | Type |
-| --- | --- |
-| state | [<code>PipelineState</code>](#PipelineState) | 
-| req | [<code>PipelineRequest</code>](#PipelineRequest) | 
-
-<a name="optionsPipe"></a>
-
-## optionsPipe(state, request) ⇒ <code>Response</code>
-Handles options requests
-
-**Kind**: global function  
-**Returns**: <code>Response</code> - a response  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| state | [<code>PipelineState</code>](#PipelineState) | pipeline options |
-| request | [<code>PipelineRequest</code>](#PipelineRequest) |  |
-