@adobe/helix-html-pipeline 1.5.4 → 1.5.7

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [1.5.7](https://github.com/adobe/helix-html-pipeline/compare/v1.5.6...v1.5.7) (2022-05-17)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-markdown-support to v3.1.5 ([10b3bb9](https://github.com/adobe/helix-html-pipeline/commit/10b3bb9175685b0367d1e834054974bc4da25b6e))
+
+## [1.5.6](https://github.com/adobe/helix-html-pipeline/compare/v1.5.5...v1.5.6) (2022-05-17)
+
+
+### Bug Fixes
+
+* avoid leading digits in heading ids ([#60](https://github.com/adobe/helix-html-pipeline/issues/60)) ([b2af7bf](https://github.com/adobe/helix-html-pipeline/commit/b2af7bf23f8479ba31c410d5b0a3316bbe071481)), closes [#59](https://github.com/adobe/helix-html-pipeline/issues/59)
+
+## [1.5.5](https://github.com/adobe/helix-html-pipeline/compare/v1.5.4...v1.5.5) (2022-05-16)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-shared-utils to v2.0.10 ([#58](https://github.com/adobe/helix-html-pipeline/issues/58)) ([2761635](https://github.com/adobe/helix-html-pipeline/commit/2761635b891e76a6f16f0bc817abc7f2b7c28979))
+
 ## [1.5.4](https://github.com/adobe/helix-html-pipeline/compare/v1.5.3...v1.5.4) (2022-05-10)
 
 

package/docs/API.md

@@ -1,12 +1,251 @@
-<a name="main"></a>
+## Classes
 
-## main(name) ⇒ <code>string</code>
-This is the main function
+<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>string</code> - a greeting  
+**Returns**: <code>Response</code> - a response  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| name | <code>string</code> | name of the person to greet |
+| state | [<code>PipelineState</code>](#PipelineState) | pipeline options |
+| request | [<code>PipelineRequest</code>](#PipelineRequest) |  |
 

package/package.json

@@ -1,17 +1,15 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "1.5.4",
+  "version": "1.5.7",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",
   "type": "module",
   "scripts": {
     "test": " c8 mocha",
-    "test-ci": "c8 mocha && codecov",
     "lint": "eslint .",
     "docs": "npx jsdoc2md -c .jsdoc.json --files 'src/*.js'  > docs/API.md",
     "semantic-release": "semantic-release",
-    "commit": "git-cz",
     "prepare": "husky install"
   },
   "repository": {
@@ -32,8 +30,8 @@
     "loader": "esmock"
   },
   "dependencies": {
-    "@adobe/helix-markdown-support": "3.1.4",
-    "@adobe/helix-shared-utils": "2.0.9",
+    "@adobe/helix-markdown-support": "3.1.5",
+    "@adobe/helix-shared-utils": "2.0.10",
     "github-slugger": "1.4.0",
     "hast-util-raw": "7.2.1",
     "hast-util-select": "5.0.1",
@@ -72,10 +70,6 @@
     "@semantic-release/git": "10.0.1",
     "@semantic-release/npm": "9.0.1",
     "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.15.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-import": "2.26.0",
@@ -94,10 +88,5 @@
   "lint-staged": {
     "*.js": "eslint",
     "*.cjs": "eslint"
-  },
-  "config": {
-    "commitizen": {
-      "path": "node_modules/cz-conventional-changelog"
-    }
   }
 }

package/src/PipelineContent.d.ts

@@ -10,8 +10,8 @@
  * governing permissions and limitations under the License.
  */
 import {Node} from "unist";
-import GithubSlugger from 'github-slugger';
 import { Root } from 'hast';
+import { IDSlugger } from './utils/id-slugger.js';
 
 declare enum SourceType {
   CONTENT = 'content',
@@ -58,7 +58,7 @@ declare class PipelineContent {
   /**
    * slugger to use for heading id calculations
    */
-  slugger: GithubSlugger;
+  slugger: IDSlugger;
 
   /**
    * document specific metadata

package/src/PipelineContent.js

@@ -9,7 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import GithubSlugger from 'github-slugger';
+import { IDSlugger } from './utils/id-slugger.js';
 
 /**
  * State of the pipeline
@@ -22,7 +22,7 @@ export class PipelineContent {
   constructor() {
     Object.assign(this, {
       sourceBus: 'content',
-      slugger: new GithubSlugger(),
+      slugger: new IDSlugger(),
     });
   }
 }

package/src/utils/id-slugger.js

@@ -0,0 +1,38 @@
+/*
+ * 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.
+ */
+import GithubSlugger from 'github-slugger';
+
+export class IDSlugger {
+  constructor() {
+    this.occurrences = {};
+  }
+
+  /**
+   * Generate a unique slug.
+   * @param  {string} value String of text to slugify
+   * @return {string}       A unique slug string
+   */
+  slug(value) {
+    let id = GithubSlugger.slug(value)
+      // remove leading numbers
+      .replace(/^\d+-+/, '');
+
+    // resolve collisions
+    const original = id;
+    while (id in this.occurrences) {
+      this.occurrences[original] += 1;
+      id = `${original}-${this.occurrences[original]}`;
+    }
+    this.occurrences[id] = 0;
+    return id;
+  }
+}