3.0.35

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @git.zone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitignore

@@ -1,4 +1,20 @@
-node_modules/
+.nogit/
+
+# artifacts
+coverage/
 public/
 pages/
-coverage/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,42 +1,140 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
+
 stages:
-- test
+  - security
-- release
+  - test
-- page
+  - release
-testLEGACY:
+  - metadata
-  stage: test
+
+before_script:
+  - npm install -g @shipzone/npmci
+
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
   script:
-    - npmci test legacy
+    - npmci git mirror
-  tags:
-    - docker
-testLTS:
-  stage: test
-  script:
-    - npmci test lts
-  tags:
-    - docker
-testSTABLE:
-  stage: test
-  script:
-    - npmci test stable
-  tags:
-    - docker
-release:
-  stage: release
-  script:
-    - npmci publish
   only:
     - tags
   tags:
+    - lossless
     - docker
-pages:
+    - notpriv
-  image: hosttoday/ht-docker-node:npmpage
+
-  stage: page
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
   script:
-    - npmci command npmpage --host gitlab
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
+  tags:
+    - docker
+  allow_failure: true
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
+  tags:
+    - docker
+  allow_failure: true
+
+# ====================
+# test stage
+# ====================
+
+testStable:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
+
+release:
+  stage: release
+  script:
+    - npmci node install stable
+    - npmci npm publish
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  only:
+    - tags
+  script:
+    - npmci command npm install -g typescript
+    - npmci npm prepare
+    - npmci npm install
+  tags:
+    - lossless
+    - docker
+    - priv
+
+trigger:
+  stage: metadata
+  script:
+    - npmci trigger
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+pages:
+  stage: metadata
+  script:
+    - npmci node install lts
+    - npmci command npm install -g @git.zone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
+  tags:
+    - lossless
+    - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
+  allow_failure: true

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,9 +0,0 @@
-# smartstream
-simplifies access to node streams, TypeScript ready!
-
-## Status
-[![build status](https://gitlab.com/pushrocks/smartstream/badges/master/build.svg)](https://gitlab.com/pushrocks/smartstream/commits/master)
-
-## Usage
-We recommend the use of TypeScript for best in class intellisense support.
-

assets/denoentry.ts

@@ -0,0 +1 @@
+console.log('Hello from deno');

dist/index.d.ts

@@ -1,10 +0,0 @@
-export interface IErrorFunction {
-    (err: any): number;
-}
-export declare class Smartstream {
-    streamArray: any[];
-    errorFunction: IErrorFunction;
-    constructor(streamArrayArg: any[]);
-    onError(errorFunctionArg: IErrorFunction): void;
-    run(): any;
-}

dist/index.js

@@ -1,21 +0,0 @@
-"use strict";
-const plugins = require("./smartstream.plugins");
-class Smartstream {
-    constructor(streamArrayArg) {
-        this.streamArray = [];
-        this.errorFunction = null;
-        this.streamArray = streamArrayArg;
-    }
-    onError(errorFunctionArg) {
-        this.errorFunction = errorFunctionArg;
-    }
-    run() {
-        let combinedStream = plugins.streamCombiner2.obj(this.streamArray);
-        if (this.errorFunction !== null) {
-            combinedStream.on('error', this.errorFunction);
-        }
-        return combinedStream;
-    }
-}
-exports.Smartstream = Smartstream;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsaURBQWdEO0FBTWhEO0lBR0ksWUFBWSxjQUFxQjtRQUZqQyxnQkFBVyxHQUFHLEVBQUUsQ0FBQTtRQUNoQixrQkFBYSxHQUFtQixJQUFJLENBQUE7UUFFaEMsSUFBSSxDQUFDLFdBQVcsR0FBRyxjQUFjLENBQUE7SUFDckMsQ0FBQztJQUNELE9BQU8sQ0FBQyxnQkFBZ0M7UUFDcEMsSUFBSSxDQUFDLGFBQWEsR0FBRyxnQkFBZ0IsQ0FBQTtJQUN6QyxDQUFDO0lBQ0QsR0FBRztRQUNDLElBQUksY0FBYyxHQUFHLE9BQU8sQ0FBQyxlQUFlLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQTtRQUNsRSxFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsYUFBYSxLQUFLLElBQUksQ0FBQyxDQUFDLENBQUM7WUFDOUIsY0FBYyxDQUFDLEVBQUUsQ0FBQyxPQUFPLEVBQUUsSUFBSSxDQUFDLGFBQWEsQ0FBQyxDQUFBO1FBQ2xELENBQUM7UUFDRCxNQUFNLENBQUMsY0FBYyxDQUFBO0lBQ3pCLENBQUM7Q0FDSjtBQWhCRCxrQ0FnQkMifQ==

dist/smartstream.plugins.d.ts

@@ -1,3 +0,0 @@
-import 'typings-global';
-export import q = require('q');
-export declare let streamCombiner2: any;

dist/smartstream.plugins.js

@@ -1,5 +0,0 @@
-"use strict";
-require("typings-global");
-exports.q = require("q");
-exports.streamCombiner2 = require('stream-combiner2');
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzdHJlYW0ucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c3RyZWFtLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF1QjtBQUN2Qix5QkFBOEI7QUFDbkIsUUFBQSxlQUFlLEdBQUcsT0FBTyxDQUFDLGtCQUFrQixDQUFDLENBQUEifQ==

npmextra.json

@@ -1 +1,39 @@
-{}
+{
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "code.foss.global",
+      "gitscope": "push.rocks",
+      "gitrepo": "smartstream",
+      "description": "simplifies access to node streams",
+      "npmPackagename": "@push.rocks/smartstream",
+      "license": "MIT",
+      "keywords": [
+        "node.js",
+        "streams",
+        "stream manipulation",
+        "pipeline",
+        "data processing",
+        "async transformation",
+        "event handling",
+        "backpressure management",
+        "readable streams",
+        "writable streams",
+        "duplex streams",
+        "transform streams",
+        "file streaming",
+        "buffer streams",
+        "stream utilities",
+        "stream intake",
+        "stream output"
+      ]
+    }
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
+  }
+}

package.json

@@ -1,32 +1,72 @@
 {
-  "name": "smartstream",
+  "name": "@push.rocks/smartstream",
-  "version": "1.0.2",
+  "version": "3.0.35",
-  "description": "simplifies access to node streams, TypeScript ready!",
+  "private": false,
-  "main": "dist/index.js",
+  "description": "simplifies access to node streams",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@gitlab.com/pushrocks/smartstream.git"
+    "url": "git+https://gitlab.com/push.rocks/smartstream.git"
   },
   "author": "Lossless GmbH",
   "license": "MIT",
   "bugs": {
-    "url": "https://gitlab.com/pushrocks/smartstream/issues"
+    "url": "https://gitlab.com/push.rocks/smartstream/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/smartstream#README",
+  "homepage": "https://gitlab.com/push.rocks/smartstream#readme",
   "devDependencies": {
-    "@types/should": "^8.1.30",
+    "@git.zone/tsbuild": "^2.1.72",
-    "npmts-g": "^5.2.8",
+    "@git.zone/tsrun": "^1.2.44",
-    "should": "^11.1.0",
+    "@git.zone/tstest": "^1.0.88",
-    "typings-test": "^1.0.3"
+    "@push.rocks/smartfile": "^11.0.4",
+    "@push.rocks/tapbundle": "^5.0.17",
+    "@types/node": "^20.11.28"
   },
   "dependencies": {
-    "@types/q": "0.x.x",
+    "@push.rocks/lik": "^6.0.14",
-    "q": "^1.4.1",
+    "@push.rocks/smartpromise": "^4.0.3",
-    "stream-combiner2": "^1.1.1",
+    "@push.rocks/smartrx": "^3.0.7",
-    "typings-global": "^1.0.14"
+    "@push.rocks/webstream": "^1.0.8"
-  }
+  },
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "keywords": [
+    "node.js",
+    "streams",
+    "stream manipulation",
+    "pipeline",
+    "data processing",
+    "async transformation",
+    "event handling",
+    "backpressure management",
+    "readable streams",
+    "writable streams",
+    "duplex streams",
+    "transform streams",
+    "file streaming",
+    "buffer streams",
+    "stream utilities",
+    "stream intake",
+    "stream output"
+  ]
 }

readme.hints.md

@@ -0,0 +1 @@
+ 

readme.md

@@ -0,0 +1,147 @@
+# @push.rocks/smartstream
+simplifies access to node streams
+
+## Install
+To install `@push.rocks/smartstream`, you can use npm or yarn as follows:
+
+```bash
+npm install @push.rocks/smartstream --save
+# OR
+yarn add @push.rocks/smartstream
+```
+
+This will add `@push.rocks/smartstream` to your project's dependencies.
+
+## Usage
+
+The `@push.rocks/smartstream` module is designed to simplify working with Node.js streams by providing a set of utilities for creating and manipulating streams. This module makes heavy use of TypeScript for improved code quality, readability, and maintenance. ESM syntax is utilized throughout the examples.
+
+### Importing the Module
+
+Start by importing the module into your TypeScript file:
+
+```typescript
+import * as smartstream from '@push.rocks/smartstream';
+```
+
+### Creating Basic Transform Streams
+
+The module provides utilities for creating transform streams. For example, to create a transform stream that modifies chunks of data, you can use the `createTransformFunction` utility:
+
+```typescript
+import { createTransformFunction } from '@push.rocks/smartstream';
+
+const upperCaseTransform = createTransformFunction<string, string>(async (chunk) => {
+  return chunk.toUpperCase();
+});
+
+// Usage with pipe
+readableStream
+  .pipe(upperCaseTransform)
+  .pipe(writableStream);
+```
+
+### Handling Backpressure with SmartDuplex
+
+`SmartDuplex` is a powerful part of the `smartstream` module designed to handle backpressure effectively. Here's an example of how to create a `SmartDuplex` stream that processes data and respects the consumer's pace:
+
+```typescript
+import { SmartDuplex } from '@push.rocks/smartstream';
+
+const processDataDuplex = new SmartDuplex({
+  async writeFunction(chunk, { push }) {
+    const processedChunk = await processChunk(chunk); // Assume this is a defined asynchronous function
+    push(processedChunk);
+  }
+});
+
+sourceStream.pipe(processDataDuplex).pipe(destinationStream);
+```
+
+### Stream Combiners
+
+`Smartstream` facilitates easy combining of multiple streams into a single pipeline, handling errors and cleanup automatically. Here's how you can combine multiple streams:
+
+```typescript
+import { StreamWrapper } from '@push.rocks/smartstream';
+
+const combinedStream = new StreamWrapper([
+  readStream,       // Source stream
+  transformStream1, // Transformation
+  transformStream2, // Another transformation
+  writeStream       // Destination stream
+]);
+
+combinedStream.run()
+  .then(() => console.log('Processing completed.'))
+  .catch(err => console.error('An error occurred:', err));
+```
+
+### Working with StreamIntake
+
+`StreamIntake` allows for more dynamic control of the reading process, facilitating scenarios where data is not continuously available:
+
+```typescript
+import { StreamIntake } from '@push.rocks/smartstream';
+
+const streamIntake = new StreamIntake<string>();
+
+// Dynamically push data into the intake
+streamIntake.pushData('Hello, World!');
+streamIntake.pushData('Another message');
+
+// Signal end when no more data is to be pushed
+streamIntake.signalEnd();
+```
+
+### Real-world Scenario: Processing Large Files
+
+Consider a scenario where you need to process a large CSV file, transform the data row-by-row, and then write the results to a database or another file. With `smartstream`, you could create a pipe that reads the CSV, processes each row, and handles backpressure, ensuring efficient use of resources.
+
+```typescript
+import { SmartDuplex, createTransformFunction } from '@push.rocks/smartstream';
+import fs from 'fs';
+import csvParser from 'csv-parser'; // Assume this is a CSV parsing library
+
+const csvReadTransform = createTransformFunction<any, any>(async (row) => {
+  // Process row
+  return processedRow;
+});
+
+fs.createReadStream('path/to/largeFile.csv')
+  .pipe(csvParser())
+  .pipe(csvReadTransform)
+  .pipe(new SmartDuplex({
+    async writeFunction(chunk, { push }) {
+      await writeToDatabase(chunk); // Assume this writes to a database
+    }
+  }))
+  .on('finish', () => console.log('File processed successfully.'));
+```
+
+This example demonstrates reading a large CSV file, transforming each row with `createTransformFunction`, and using a `SmartDuplex` to manage the processed data flow efficiently, ensuring no data is lost due to backpressure issues.
+
+### Conclusion
+
+`@push.rocks/smartstream` offers a robust set of tools for working with Node.js streams, providing a more intuitive and reliable way to create, manipulate, and combine streams. By leveraging TypeScript and ESM syntax, `smartstream` enables developers to build more maintainable and type-safe stream-based solutions.
+
+For more detailed examples and documentation, visit the [GitLab Repository](https://gitlab.com/push.rocks/smartstream) or the [GitHub Mirror](https://github.com/pushrocks/smartstream).
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

test/assets/writabletext.txt

@@ -0,0 +1,50 @@
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow
+hi+wow

test/test.backpressure.ts

@@ -0,0 +1,68 @@
+import { tap, expect } from '@push.rocks/tapbundle';
+import { SmartDuplex, type ISmartDuplexOptions, StreamWrapper } from '../ts/index.js';
+
+tap.test('should run backpressure test', async (toolsArg) => {
+  const done = toolsArg.defer();
+  async function testBackpressure() {
+    const stream1 = new SmartDuplex({
+      name: 'stream1',
+      objectMode: true,
+      writeFunction: async (chunk, tools) => {
+        await new Promise((resolve) => setTimeout(resolve, 10)); // Slow processing
+        console.log(`processed chunk ${chunk} in stream 1`);
+        return chunk; // Fast processing
+      },
+    });
+    const stream2 = new SmartDuplex({
+      name: 'stream2',
+      objectMode: true,
+      writeFunction: async (chunk, tools) => {
+        await new Promise((resolve) => setTimeout(resolve, 20)); // Slow processing
+        console.log(`processed chunk ${chunk} in stream 2`);
+        await tools.push(chunk);
+        // return chunk, optionally return ;
+      },
+    }); // This stream processes data more slowly
+    const stream3 = new SmartDuplex({
+      objectMode: true,
+      name: 'stream3',
+      writeFunction: async (chunk, tools) => {
+        await new Promise((resolve) => setTimeout(resolve, 200)); // Slow processing
+        console.log(`processed chunk ${chunk} in stream 3`);
+      },
+    });
+
+    stream1.pipe(stream2).pipe(stream3);
+
+    let backpressured = false;
+    for (let i = 0; i < 200; i++) {
+      const canContinue = stream1.write(`Chunk ${i}`, 'utf8');
+      if (!canContinue) {
+        backpressured = true;
+        console.log(`Backpressure at chunk ${i}`);
+      }
+    }
+
+    stream1.end();
+
+    stream1.on('finish', () => {
+      console.log('Stream 1 finished processing.');
+    });
+    stream2.on('finish', () => {
+      console.log('Stream 2 finished processing.');
+    });
+    stream3.on('finish', () => {
+      console.log('Stream 3 finished processing.');
+      if (!backpressured) {
+        throw new Error('No backpressure was observed.');
+      } else {
+        done.resolve();
+      }
+    });
+  }
+
+  testBackpressure();
+  await done.promise;
+});
+
+await tap.start();

test/test.d.ts

@@ -1 +0,0 @@
-import 'typings-test';

test/test.js

@@ -1,15 +0,0 @@
-"use strict";
-require("typings-test");
-const fs = require("fs");
-const smartstream = require("../dist/index");
-let testSmartstream;
-describe('smartstream', function () {
-    it('should combine a stream', function () {
-        testSmartstream = new smartstream.Smartstream([
-            fs.createReadStream('./test/assets/test.md'),
-            fs.createWriteStream('./test/assets/testCopy.md')
-        ]);
-        testSmartstream.run();
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUNyQix5QkFBeUI7QUFHekIsNkNBQTRDO0FBRTVDLElBQUksZUFBd0MsQ0FBQTtBQUU1QyxRQUFRLENBQUMsYUFBYSxFQUFFO0lBQ3BCLEVBQUUsQ0FBQyx5QkFBeUIsRUFBRTtRQUMxQixlQUFlLEdBQUcsSUFBSSxXQUFXLENBQUMsV0FBVyxDQUFDO1lBQzFDLEVBQUUsQ0FBQyxnQkFBZ0IsQ0FBQyx1QkFBdUIsQ0FBQztZQUM1QyxFQUFFLENBQUMsaUJBQWlCLENBQUMsMkJBQTJCLENBQUM7U0FDcEQsQ0FBQyxDQUFBO1FBQ0YsZUFBZSxDQUFDLEdBQUcsRUFBRSxDQUFBO0lBQ3pCLENBQUMsQ0FBQyxDQUFBO0FBQ04sQ0FBQyxDQUFDLENBQUEifQ==

test/test.smartstream.ts

@@ -0,0 +1,24 @@
+import { expect, tap } from '@push.rocks/tapbundle';
+import { SmartDuplex } from '../ts/smartstream.classes.smartduplex.js'; // Adjust the import to your file structure
+import * as smartrx from '@push.rocks/smartrx';
+import * as fs from 'fs';
+
+tap.test('should create a SmartStream from a Buffer', async () => {
+  const bufferData = Buffer.from('This is a test buffer');
+  const smartStream = SmartDuplex.fromBuffer(bufferData, {});
+  
+  let receivedData = Buffer.alloc(0);
+  
+  return new Promise<void>((resolve) => {
+    smartStream.on('data', (chunk: Buffer) => {
+      receivedData = Buffer.concat([receivedData, chunk]);
+    });
+
+    smartStream.on('end', () => {
+      expect(receivedData.toString()).toEqual(bufferData.toString());
+      resolve();
+    });
+  });
+});
+
+tap.start();

test/test.streamfunction.ts

@@ -0,0 +1,65 @@
+import { expect, tap } from '@push.rocks/tapbundle';
+import * as smartfile from '@push.rocks/smartfile';
+
+import * as smartstream from '../ts/index.js';
+
+let testIntake: smartstream.StreamIntake<string>;
+
+tap.test('should handle a read stream', async (tools) => {
+  const counter = 0;
+  const streamWrapper = new smartstream.StreamWrapper([
+    smartfile.fsStream.createReadStream('./test/assets/readabletext.txt'),
+    new smartstream.SmartDuplex({
+      writeFunction: async (chunkStringArg: Buffer, streamTools) => {
+        // do something with the stream here
+        const result = chunkStringArg.toString().substr(0, 100);
+        streamTools.push('wow =========== \n');
+        return Buffer.from(result);
+      },
+      finalFunction: async (tools) => {
+        return Buffer.from('this is the end');
+      },
+    }),
+    new smartstream.SmartDuplex({
+      writeFunction: async (chunkStringArg) => {
+        console.log(chunkStringArg.toString());
+      },
+      finalFunction: async (tools) => {
+        tools.push(null);
+      },
+    })
+  ]);
+  await streamWrapper.run();
+});
+
+tap.test('should create a valid Intake', async (tools) => {
+  testIntake = new smartstream.StreamIntake<string>();
+  testIntake.pipe(
+      new smartstream.SmartDuplex({
+        objectMode: true,
+        writeFunction: async (chunkStringArg: string, streamTools) => {
+          await tools.delayFor(100);
+          console.log(chunkStringArg);
+          return chunkStringArg;
+        }
+      })
+    )
+    .pipe(smartfile.fsStream.createWriteStream('./test/assets/writabletext.txt'));
+  const testFinished = tools.defer();
+  let counter = 0;
+  testIntake.pushNextObservable.subscribe(() => {
+    if (counter < 50) {
+      counter++;
+      testIntake.pushData('hi');
+      testIntake.pushData('+wow');
+      testIntake.pushData('\n');
+    } else {
+      testIntake.signalEnd();
+      testFinished.resolve();
+    }
+  });
+  await testFinished.promise;
+  testIntake.signalEnd();
+});
+
+tap.start();

test/test.ts

@@ -1,17 +1,15 @@
-import 'typings-test'
+import * as smartfile from '@push.rocks/smartfile';
-import fs = require('fs')
+import { expect, tap } from '@push.rocks/tapbundle';
-import * as should from 'should'
 
-import * as smartstream from '../dist/index'
+import * as smartstream from '../ts/smartstream.classes.streamwrapper.js';
 
-let testSmartstream: smartstream.Smartstream
+let testSmartstream: smartstream.StreamWrapper;
+tap.test('should combine a stream', async () => {
+  testSmartstream = new smartstream.StreamWrapper([
+    smartfile.fsStream.createReadStream('./test/assets/test.md'),
+    smartfile.fsStream.createWriteStream('./test/assets/testCopy.md'),
+  ]);
+  await testSmartstream.run();
+});
 
-describe('smartstream', function() {
+tap.start();
-    it('should combine a stream', function(){
-        testSmartstream = new smartstream.Smartstream([
-            fs.createReadStream('./test/assets/test.md'),
-            fs.createWriteStream('./test/assets/testCopy.md')
-        ])
-        testSmartstream.run()
-    })
-})

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smartstream',
+  version: '3.0.35',
+  description: 'simplifies access to node streams'
+}

ts/index.ts

@@ -1,23 +1,8 @@
-import * as plugins from './smartstream.plugins'
+export * from './smartstream.classes.smartduplex.js';
+export * from './smartstream.classes.streamwrapper.js';
+export * from './smartstream.classes.streamintake.js';
 
-export interface IErrorFunction {
+export * from './smartstream.functions.js';
-    (err): number
-}
 
-export class Smartstream {
+import * as plugins from './smartstream.plugins.js';
-    streamArray = []
+export const webstream = plugins.webstream;
-    errorFunction: IErrorFunction = null
-    constructor(streamArrayArg: any[]){
-        this.streamArray = streamArrayArg
-    }
-    onError(errorFunctionArg: IErrorFunction) {
-        this.errorFunction = errorFunctionArg
-    }
-    run() {
-        let combinedStream = plugins.streamCombiner2.obj(this.streamArray)
-        if (this.errorFunction !== null) {
-            combinedStream.on('error', this.errorFunction)
-        }
-        return combinedStream
-    }
-}

ts/smartstream.classes.smartduplex.ts

@@ -0,0 +1,160 @@
+import * as plugins from './smartstream.plugins.js';
+import { Duplex, type DuplexOptions } from 'stream';
+
+export interface IStreamTools {
+  truncate: () => void;
+  push: (pipeObject: any) => Promise<boolean>;
+}
+
+export interface IStreamWriteFunction<T, rT> {
+  (chunkArg: T, toolsArg: IStreamTools): Promise<rT>;
+}
+
+export interface IStreamFinalFunction<rT> {
+  (toolsArg: IStreamTools): Promise<rT>;
+}
+
+export interface ISmartDuplexOptions<TInput, TOutput> extends DuplexOptions {
+  /**
+   * wether to print debug logs
+   */
+  debug?: boolean;
+  /**
+   * the name of the stream
+   */
+  name?: string;
+  /**
+   * a function that is being called to read more stuff from whereever to be processed by the stream
+   * @returns
+   */
+  readFunction?: () => Promise<void>;
+
+  /**
+   * the write function is called for every chunk that is being written to the stream
+   * it can push or return chunks (but does not have to) to be written to the readable side of the stream
+   */
+  writeFunction?: IStreamWriteFunction<TInput, TOutput>;
+  
+  /**
+   * a final function that is run at the end of the stream 
+   */
+  finalFunction?: IStreamFinalFunction<TOutput>;
+}
+
+export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
+  // STATIC
+  static fromBuffer(buffer: Buffer, options?: ISmartDuplexOptions<any, any>): SmartDuplex {
+    const smartDuplex = new SmartDuplex(options);
+    process.nextTick(() => {
+      smartDuplex.push(buffer);
+      smartDuplex.push(null); // Signal the end of the data
+    });
+    return smartDuplex;
+  }
+
+  // INSTANCE
+  private backpressuredArray: plugins.lik.BackpressuredArray<TOutput>;
+  public options: ISmartDuplexOptions<TInput, TOutput>;
+  private observableSubscription?: plugins.smartrx.rxjs.Subscription;
+  private debugLog(messageArg: string) {
+    if (this.options.debug) {
+      console.log(messageArg);
+    }
+  }
+
+  constructor(optionsArg?: ISmartDuplexOptions<TInput, TOutput>) {
+    super(Object.assign({
+      highWaterMark: 1,
+    }, optionsArg));
+    this.options = optionsArg;
+    this.backpressuredArray = new plugins.lik.BackpressuredArray<TOutput>(this.options.highWaterMark || 1)
+  }
+
+  public async _read(size: number): Promise<void> {
+    this.debugLog(`${this.options.name}: read was called`);
+    await this.backpressuredArray.waitForItems();
+    this.debugLog(`${this.options.name}: successfully waited for items.`);
+    if (this.options.readFunction) {
+      await this.options.readFunction();
+    }
+    let canPushMore = true; 
+    while(this.backpressuredArray.data.length > 0 && canPushMore) {
+      const nextChunk = this.backpressuredArray.shift();
+      canPushMore = this.push(nextChunk);
+    }
+  }
+
+  public async backpressuredPush (pushArg: TOutput) {
+    const canPushMore = this.backpressuredArray.push(pushArg);
+    if (!canPushMore) {
+      this.debugLog(`${this.options.name}: cannot push more`);
+      await this.backpressuredArray.waitForSpace();
+      this.debugLog(`${this.options.name}: can push more again`);
+    }
+    return canPushMore;
+  };
+
+  private asyncWritePromiseObjectmap = new plugins.lik.ObjectMap<Promise<any>>();
+  // Ensure the _write method types the chunk as TInput and encodes TOutput
+  public async _write(chunk: TInput, encoding: string, callback: (error?: Error | null) => void) {
+    if (!this.options.writeFunction) {
+      return callback(new Error('No stream function provided'));
+    }
+
+    let isTruncated = false;
+    const tools: IStreamTools = {
+      truncate: () => {
+        this.push(null);
+        isTruncated = true;
+        callback();
+      },
+      push: async (pushArg: TOutput) => {
+        return await this.backpressuredPush(pushArg);
+      }
+    };
+
+    try {
+      const writeDeferred = plugins.smartpromise.defer();
+      this.asyncWritePromiseObjectmap.add(writeDeferred.promise);
+      const modifiedChunk = await this.options.writeFunction(chunk, tools);
+      if (isTruncated) {
+        return;
+      }
+      if (modifiedChunk) {
+        await tools.push(modifiedChunk);
+      }
+      callback();
+      writeDeferred.resolve();
+      writeDeferred.promise.then(() => {
+        this.asyncWritePromiseObjectmap.remove(writeDeferred.promise);
+      });
+    } catch (err) {
+      callback(err);
+    }
+  }
+
+  public async _final(callback: (error?: Error | null) => void) {
+    await Promise.all(this.asyncWritePromiseObjectmap.getArray());
+    if (this.options.finalFunction) {
+      const tools: IStreamTools = {
+        truncate: () => callback(),
+        push: async (pipeObject) => {
+          return this.backpressuredArray.push(pipeObject);
+        },
+      };
+
+      try {
+        const finalChunk = await this.options.finalFunction(tools);
+        if (finalChunk) {
+          this.backpressuredArray.push(finalChunk);
+        }
+      } catch (err) {
+        this.backpressuredArray.push(null);
+        callback(err);
+        return;
+      }
+    }
+    this.backpressuredArray.push(null);
+    callback();
+  }
+}

ts/smartstream.classes.streamintake.ts

@@ -0,0 +1,52 @@
+import * as plugins from './smartstream.plugins.js';
+
+export class StreamIntake<T> extends plugins.stream.Readable {
+  private signalEndBoolean = false;
+  private chunkStore: T[] = [];
+  public pushNextObservable = new plugins.smartrx.ObservableIntake<any>();
+  private pushedNextDeferred = plugins.smartpromise.defer();
+
+  constructor(options?: plugins.stream.ReadableOptions) {
+    super({ ...options, objectMode: true }); // Ensure that we are in object mode.
+    this.pushNextObservable.push('please push next');
+  }
+
+  _read(size: number): void {
+    // console.log('get next');
+    const pushChunk = (): void => {
+      if (this.chunkStore.length > 0) {
+        // If push returns false, then we should stop reading
+        if (!this.push(this.chunkStore.shift())) {
+          return;
+        }
+      }
+
+      if (this.chunkStore.length === 0) {
+        if (this.signalEndBoolean) {
+          // If we're done, push null to signal the end of the stream
+          this.push(null);
+        } else {
+          // Ask for more data and wait
+          this.pushNextObservable.push('please push next');
+          this.pushedNextDeferred.promise.then(() => {
+            this.pushedNextDeferred = plugins.smartpromise.defer(); // Reset the deferred
+            pushChunk(); // Try pushing the next chunk
+          });
+        }
+      }
+    };
+
+    pushChunk();
+  }
+
+  public pushData(chunkData: T) {
+    this.chunkStore.push(chunkData);
+    this.pushedNextDeferred.resolve();
+  }
+
+  public signalEnd() {
+    this.signalEndBoolean = true;
+    this.pushedNextDeferred.resolve();
+    this.pushNextObservable.signalComplete();
+  }
+}

ts/smartstream.classes.streamwrapper.ts

@@ -0,0 +1,96 @@
+import * as plugins from './smartstream.plugins.js';
+
+// interfaces
+import { Transform } from 'stream';
+
+export interface IErrorFunction {
+  (err: Error): any;
+}
+
+export interface ICustomEventFunction {
+  (): any;
+}
+
+export interface ICustomEventObject {
+  eventName: string;
+  eventFunction: ICustomEventFunction;
+}
+
+/**
+ * class Smartstream handles
+ */
+export class StreamWrapper {
+  private streamArray: Array<plugins.stream.Duplex> = [];
+  private customEventObjectArray: ICustomEventObject[] = [];
+  private streamStartedDeferred = plugins.smartpromise.defer();
+
+  /**
+   * constructor
+   */
+  constructor(streamArrayArg: any[]) {
+    this.streamArray = streamArrayArg;
+  }
+
+  /**
+   * make something with the stream itself
+   */
+  streamStarted(): Promise<any> {
+    return this.streamStartedDeferred.promise;
+  }
+
+  /**
+   * attach listener to custom event
+   */
+  onCustomEvent(eventNameArg: string, eventFunctionArg: ICustomEventFunction) {
+    this.customEventObjectArray.push({
+      eventName: eventNameArg,
+      eventFunction: eventFunctionArg,
+    });
+  }
+
+  /**
+   * run the stream
+   * @returns Promise
+   */
+  run(): Promise<void> {
+    const done = plugins.smartpromise.defer<void>();
+
+    // clone Array
+    const streamExecutionArray: Array<plugins.stream.Duplex> = [];
+    for (const streamItem of this.streamArray) {
+      streamExecutionArray.push(streamItem);
+    }
+
+    // combine the stream
+    let finalStream = null;
+    let firstIteration: boolean = true;
+    for (const stream of streamExecutionArray) {
+      if (firstIteration === true) {
+        finalStream = stream;
+      }
+      stream.on('error', (err) => {
+        done.reject(err);
+      });
+      for (const customEventObject of this.customEventObjectArray) {
+        stream.on(customEventObject.eventName, customEventObject.eventFunction);
+      }
+      if (!firstIteration) {
+        finalStream = finalStream.pipe(stream);
+      }
+      firstIteration = false;
+    }
+
+    this.streamStartedDeferred.resolve();
+
+    finalStream.on('end', () => {
+      done.resolve();
+    });
+    finalStream.on('close', () => {
+      done.resolve();
+    });
+    finalStream.on('finish', () => {
+      done.resolve();
+    });
+    return done.promise;
+  }
+}

ts/smartstream.functions.ts

@@ -0,0 +1,30 @@
+import { Transform, type TransformCallback, type TransformOptions } from 'stream';
+import { SmartDuplex } from './smartstream.classes.smartduplex.js';
+
+export interface AsyncTransformFunction<TInput, TOutput> {
+  (chunkArg: TInput): Promise<TOutput>;
+}
+
+export function createTransformFunction<TInput, TOutput>(
+  asyncFunction: AsyncTransformFunction<TInput, TOutput>,
+  options?: TransformOptions
+): SmartDuplex {
+  const smartDuplexStream = new SmartDuplex({
+    ...options,
+    writeFunction: async (chunkArg, toolsArg) => {
+      const result = await asyncFunction(chunkArg);
+      return result;
+    }
+  });
+
+  return smartDuplexStream;
+}
+
+export const createPassThrough = () => {
+  return new SmartDuplex({
+    objectMode: true,
+    writeFunction: async (chunkArg, toolsArg) => {
+      return chunkArg;
+    }
+  })
+}

ts/smartstream.plugins.ts

@@ -1,3 +1,13 @@
-import 'typings-global'
+// node native
-export import q = require('q')
+import * as stream from 'stream';
-export let streamCombiner2 = require('stream-combiner2')
+
+export { stream };
+
+// pushrocks scope
+import * as lik from '@push.rocks/lik';
+import * as smartpromise from '@push.rocks/smartpromise';
+import * as smartrx from '@push.rocks/smartrx';
+import * as webstream from '@push.rocks/webstream';
+
+export { lik, smartpromise, smartrx, webstream };
+

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}

tslint.json

@@ -1,3 +0,0 @@
-{
-    "extends": "tslint-config-standard"
-}