content-entry-transform 1.4.29 → 1.4.31

package/LICENSE

@@ -1,23 +1,12 @@
-Copyright (c) 2022-2023 by arlac77
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Copyright (C) 2022-2025 by arlac77
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,6 +1,6 @@
 [![npm](https://img.shields.io/npm/v/content-entry-transform.svg)](https://www.npmjs.com/package/content-entry-transform)
-[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
-[![Open Bundle](https://bundlejs.com/badge-light.svg)](https://bundlejs.com/?q=content-entry-transform)
+[![License](https://img.shields.io/badge/License-0BSD-blue.svg)](https://spdx.org/licenses/0BSD.html)
+[![bundlejs](https://deno.bundlejs.com/?q=content-entry-transform\&badge=detailed)](https://bundlejs.com/?q=content-entry-transform)
 [![downloads](http://img.shields.io/npm/dm/content-entry-transform.svg?style=flat-square)](https://npmjs.org/package/content-entry-transform)
 [![GitHub Issues](https://img.shields.io/github/issues/arlac77/content-entry-transform.svg?style=flat-square)](https://github.com/arlac77/content-entry-transform/issues)
 [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Fcontent-entry-transform%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/arlac77/content-entry-transform/goto)
@@ -19,10 +19,22 @@ transform content entries
 
 ### Table of Contents
 
-*   [createPropertiesTransformer](#createpropertiestransformer)
+*   [createExpressionTransformer](#createexpressiontransformer)
     *   [Parameters](#parameters)
-*   [transform](#transform)
+*   [createPropertiesTransformer](#createpropertiestransformer)
     *   [Parameters](#parameters-1)
+*   [transform](#transform)
+    *   [Parameters](#parameters-2)
+
+## createExpressionTransformer
+
+Transformer expanding '{{}}' expressions
+
+### Parameters
+
+*   `match` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+*   `properties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**  (optional, default `"expression"`)
 
 ## createPropertiesTransformer
 
@@ -33,7 +45,7 @@ On match the entry will be assigned new properties as given by propertyDefinitio
 
 *   `match`  
 *   `propertyDefinitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
-*   `name`   (optional, default `"property"`)
+*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**  (optional, default `"property"`)
 *   `matcher` **Matcher** 
 
 Returns **Transformer** 
@@ -44,9 +56,9 @@ Apply transformers.
 
 ### Parameters
 
-*   `source` **AsyncIterator\<ContentEntry>**&#x20;
+*   `source` **AsyncIterable\<ContentEntry>**&#x20;
 *   `transformers` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Transformer>**  (optional, default `[]`)
-*   `onlyMatching` &#x20;
+*   `onlyMatching` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** filter out all none matching entries
 
 # install
 

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "content-entry-transform",
-  "version": "1.4.29",
+  "version": "1.4.31",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "exports": {
     ".": "./src/transform.mjs"
@@ -14,30 +15,30 @@
       "email": "markus.felten@gmx.de"
     }
   ],
-  "license": "BSD-2-Clause",
+  "license": "0BSD",
   "scripts": {
-    "test": "npm run test:browser-ava && npm run test:ava",
-    "test:ava": "ava --timeout 2m tests/*-ava.mjs tests/*-ava-node.mjs",
+    "test": "node --run test:browser-ava && node --run test:ava",
+    "test:ava": "ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs",
     "test:browser-ava": "browser-ava --headless --no-keep-open tests/*-ava.mjs tests/*-ava-browser.mjs",
-    "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 2m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
-    "docs": "documentation readme --section=API ./src/**/*.mjs",
-    "lint": "npm run lint:docs",
-    "lint:docs": "documentation lint ./src/**/*.mjs"
+    "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
+    "docs": "documentation readme --section=API ./src**/*.mjs",
+    "lint": "node --run lint:docs",
+    "lint:docs": "documentation lint ./src**/*.mjs"
   },
   "dependencies": {
-    "content-entry": "^6.0.0",
-    "iterable-string-interceptor": "^2.2.3"
+    "content-entry": "^13.0.6",
+    "iterable-string-interceptor": "^3.0.0"
   },
   "devDependencies": {
-    "ava": "^5.2.0",
-    "browser-ava": "^1.3.32",
-    "c8": "^7.13.0",
-    "documentation": "^14.0.1",
-    "semantic-release": "^21.0.0"
+    "ava": "^6.3.0",
+    "browser-ava": "^2.3.24",
+    "c8": "^10.1.3",
+    "documentation": "^14.0.3",
+    "semantic-release": "^24.2.3"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/arlac77/content-entry-transform"
+    "url": "git+https://github.com/arlac77/content-entry-transform.git"
   },
   "bugs": {
     "url": "https://github.com/arlac77/content-entry-transform/issues"
@@ -47,7 +48,7 @@
     "inheritFrom": [
       "arlac77/template-arlac77-github",
       "arlac77/template-browser-ava",
-      "arlac77/template-esm-only"
+      "arlac77/template-javascript-component"
     ]
   }
 }

package/src/expression-transformer.mjs

@@ -36,33 +36,51 @@ export function createPropertiesInterceptor(properties) {
         }
         return value;
       }
-      return "";
+      else {
+        return leadIn + e + leadOut;
+      }
+   //   return "";
     }
 
     yield ev(expression, 0);
   };
 }
 
+/**
+ * Transformer expanding '{{}}' expressions
+ * @param {string} match 
+ * @param {Object} properties 
+ * @param {string} name 
+ * @returns 
+ */
 export function createExpressionTransformer(
   match,
   properties,
   name = "expression"
 ) {
+
+  const decoder = new TextDecoder();
+
+  async function * streamToText(stream)
+  {
+    for await (const chunk of stream) {
+      yield decoder.decode(chunk);
+    }
+  }
+
   return {
     name,
     match,
     transform: async entry => {
-      //console.log("TRANSFORM",entry.name);
       const ne = new ReadableStreamContentEntry(
         entry.name,
         iterableStringInterceptor(
-          await entry.getReadStream(utf8StreamOptions),
+          streamToText(await entry.getReadStream()),
           createPropertiesInterceptor(properties)
         )
       );
       ne.destination = entry.destination; // TODO all the other attributes ?
       return ne;
-      //return Object.assign(entry,ne);
     }
   };
 }

package/src/properties-transformer.mjs

@@ -3,6 +3,7 @@
  * On match the entry will be assigned new properties as given by propertyDefinitions.
  * @param {Object} propertyDefinitions
  * @param {Matcher} matcher
+ * @param {string} name
  * @return {Transformer}
  */
 export function createPropertiesTransformer(

package/src/transform.mjs

@@ -2,11 +2,13 @@ export * from "./properties-transformer.mjs";
 export * from "./expression-transformer.mjs";
 export * from "./matcher.mjs";
 
+import { ContentEntry } from "content-entry";
+
 /**
  * Apply transformers.
- * @param {AsyncIterator<ContentEntry>} source
+ * @param {AsyncIterable<ContentEntry>} source
  * @param {Transformer[]} transformers
- * @param {Boolean]} onlyMatching filter out all none matching entries
+ * @param {boolean} onlyMatching filter out all none matching entries
  */
 export async function* transform(source, transformers = [], onlyMatching) {
   const usedTransformers = new Set();