content-entry-transform 1.0.0

package/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2022 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.

package/README.md

@@ -0,0 +1,12 @@
+[![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)
+[![minified size](https://badgen.net/bundlephobia/min/content-entry-transform)](https://bundlephobia.com/result?p=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)
+[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+[![Known Vulnerabilities](https://snyk.io/test/github/arlac77/content-entry-transform/badge.svg)](https://snyk.io/test/github/arlac77/content-entry-transform)
+[![Coverage Status](https://coveralls.io/repos/arlac77/content-entry-transform/badge.svg)](https://coveralls.io/github/arlac77/content-entry-transform)
+# content-entry-transform
+transform content entries

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "content-entry-transform",
+  "version": "1.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "exports": {
+    ".": "./src/transform.mjs"
+  },
+  "description": "transform content entries",
+  "contributors": [
+    {
+      "name": "Markus Felten",
+      "email": "markus.felten@gmx.de"
+    }
+  ],
+  "license": "BSD-2-Clause",
+  "scripts": {
+    "test": "npm run test:ava",
+    "test:ava": "ava --timeout 2m tests/*.mjs",
+    "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 2m tests/*.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"
+  },
+  "dependencies": {
+    "content-entry": "^4.0.0"
+  },
+  "devDependencies": {
+    "ava": "^4.0.1",
+    "c8": "^7.11.0",
+    "documentation": "^13.2.5",
+    "semantic-release": "^18.0.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/arlac77/content-entry-transform.git"
+  },
+  "bugs": {
+    "url": "https://github.com/arlac77/content-entry-transform/issues"
+  },
+  "homepage": "https://github.com/arlac77/content-entry-transform#readme",
+  "template": {
+    "inheritFrom": [
+      "arlac77/template-arlac77-github",
+      "arlac77/template-esm-only"
+    ]
+  }
+}

package/src/expression-transformer.mjs

@@ -0,0 +1,30 @@
+export function createPropertiesInterceptor(properties) {
+  return async function* transformer(expression, remainder, source, cb) {
+    const value = properties[expression];
+    yield value === undefined ? "" : value;
+  };
+}
+
+export function createExpressionTransformer(
+  properties,
+  match = entry =>
+    entry.name.match(/\.(conf|json|html|txt|service|socket)$/) ? true : false
+) {
+  return {
+    name: "expression",
+    match,
+    transform: async entry => {
+      //console.log("TRANSFORM",entry.name);
+      const ne = new ReadableStreamContentEntry(
+        entry.name,
+        iterableStringInterceptor(
+          await entry.getReadStream(utf8StreamOptions),
+          createPropertiesInterceptor(properties)
+        )
+      );
+      ne.destination = entry.destination; // TODO all the other attributes ?
+      return ne;
+      //return Object.assign(entry,ne);
+    }
+  };
+}

package/src/properties-transformer.mjs

@@ -0,0 +1,7 @@
+export function createPropertiesTransformer(propertyDefinitions, match) {
+  return {
+    name: "property",
+    match,
+    transform: async entry => Object.create(entry, propertyDefinitions)
+  };
+}

package/src/transform.mjs

@@ -0,0 +1,33 @@
+export * from "./properties-transformer.mjs";
+
+/**
+ * Apply transformers.
+ * @param {AsyncIterator<ContentEntry>} source
+ * @param {Transformer[]} transformers
+ * @param {Boolean]} onlyMatching filter out all none matching entries
+ */
+export async function* transform(source, transformers = [], onlyMatching) {
+  const usedTransformers = new Set();
+
+  for await (let entry of source) {
+    let didMatch = false;
+    for (const t of transformers) {
+      //console.log(t.name,entry.name,t.match(entry));
+      if (t.match(entry)) {
+        didMatch = true;
+        entry = await t.transform(entry);
+        usedTransformers.add(t);
+      }
+    }
+
+    if ((onlyMatching && didMatch) || !onlyMatching) {
+      yield entry;
+    }
+  }
+
+  for (const t of transformers) {
+    if (!usedTransformers.has(t) && t.createEntryWhenMissing !== undefined) {
+      yield t.transform(await t.createEntryWhenMissing());
+    }
+  }
+}