3.0.38

.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

.gitlab-ci.yml

@@ -123,7 +123,7 @@ pages:
   stage: metadata
   script:
     - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
+    - npmci command npm install -g @git.zone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc

assets/denoentry.ts

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

npmextra.json

@@ -6,12 +6,34 @@
   "gitzone": {
     "projectType": "npm",
     "module": {
-      "githost": "gitlab.com",
+      "githost": "code.foss.global",
-      "gitscope": "pushrocks",
+      "gitscope": "push.rocks",
       "gitrepo": "smartstream",
-      "description": "simplifies access to node streams",
+      "description": "A library to simplify the creation and manipulation of Node.js streams, providing utilities for handling transform, duplex, and readable/writable streams effectively in TypeScript.",
-      "npmPackagename": "@pushrocks/smartstream",
+      "npmPackagename": "@push.rocks/smartstream",
-      "license": "MIT"
+      "license": "MIT",
+      "keywords": [
+        "stream",
+        "node.js",
+        "typescript",
+        "stream manipulation",
+        "data processing",
+        "pipeline",
+        "async transformation",
+        "event handling",
+        "backpressure",
+        "readable stream",
+        "writable stream",
+        "duplex stream",
+        "transform stream",
+        "file streaming",
+        "buffer",
+        "stream utilities",
+        "esm"
+      ]
     }
+  },
+  "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,36 +1,39 @@
 {
-  "name": "@pushrocks/smartstream",
+  "name": "@push.rocks/smartstream",
-  "version": "2.0.0",
+  "version": "3.0.38",
   "private": false,
-  "description": "simplifies access to node streams",
+  "description": "A library to simplify the creation and manipulation of Node.js streams, providing utilities for handling transform, duplex, and readable/writable streams effectively in TypeScript.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "type": "module",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "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": {
-    "@gitzone/tsbuild": "^2.1.61",
+    "@git.zone/tsbuild": "^2.1.80",
-    "@gitzone/tstest": "^1.0.70",
+    "@git.zone/tsrun": "^1.2.44",
-    "@pushrocks/tapbundle": "^5.0.3",
+    "@git.zone/tstest": "^1.0.90",
-    "tslint": "^6.1.3",
+    "@push.rocks/smartfile": "^11.0.15",
-    "tslint-config-prettier": "^1.18.0"
+    "@push.rocks/tapbundle": "^5.0.23",
+    "@types/node": "^20.12.12"
   },
   "dependencies": {
-    "@pushrocks/smartpromise": "^3.1.7",
+    "@push.rocks/lik": "^6.0.15",
-    "@types/through2": "^2.0.36",
+    "@push.rocks/smartpromise": "^4.0.3",
-    "through2": "^4.0.2"
+    "@push.rocks/smartrx": "^3.0.7",
+    "@push.rocks/webstream": "^1.0.8"
   },
   "browserslist": [
     "last 1 chrome versions"
@@ -46,5 +49,24 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "keywords": [
+    "stream",
+    "node.js",
+    "typescript",
+    "stream manipulation",
+    "data processing",
+    "pipeline",
+    "async transformation",
+    "event handling",
+    "backpressure",
+    "readable stream",
+    "writable stream",
+    "duplex stream",
+    "transform stream",
+    "file streaming",
+    "buffer",
+    "stream utilities",
+    "esm"
   ]
 }

readme.hints.md

@@ -0,0 +1 @@
+ - make sure to respect backpressure handling.

readme.md

@@ -0,0 +1,375 @@
+```markdown
+# @push.rocks/smartstream
+A TypeScript library to simplify the creation and manipulation of Node.js streams, providing utilities for transform, duplex, and readable/writable stream handling while managing backpressure effectively.
+
+## 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 extensive 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';
+```
+
+For a more specific import, you may do the following:
+
+```typescript
+import { SmartDuplex, StreamWrapper, StreamIntake, createTransformFunction, createPassThrough } 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);
+```
+
+### Combining Multiple Streams
+
+`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';
+
+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.
+
+### Advanced Use Case: Backpressure Handling
+
+Effective backpressure handling is crucial when working with streams to avoid overwhelming the downstream consumers. Here’s a comprehensive example that demonstrates handling backpressure in a pipeline with multiple `SmartDuplex` instances:
+
+```typescript
+import { SmartDuplex } from '@push.rocks/smartstream';
+
+// Define the first SmartDuplex, which writes data slowly to simulate backpressure
+const slowProcessingStream = new SmartDuplex({
+  name: 'SlowProcessor',
+  objectMode: true,
+  writeFunction: async (chunk, { push }) => {
+    await new Promise(resolve => setTimeout(resolve, 100)); // Simulated delay
+    console.log('Processed chunk:', chunk);
+    push(chunk);
+  }
+});
+
+// Define the second SmartDuplex as a fast processor
+const fastProcessingStream = new SmartDuplex({
+  name: 'FastProcessor',
+  objectMode: true,
+  writeFunction: async (chunk, { push }) => {
+    console.log('Fast processing chunk:', chunk);
+    push(chunk);
+  }
+});
+
+// Create a StreamIntake to dynamically handle incoming data
+const streamIntake = new StreamIntake<string>();
+
+// Chain the streams together and handle the backpressure scenario
+streamIntake
+  .pipe(fastProcessingStream)
+  .pipe(slowProcessingStream)
+  .pipe(createPassThrough()) // Use Pass-Through to provide intermediary handling
+  .on('data', data => console.log('Final output:', data))
+  .on('error', error => console.error('Stream encountered an error:', error));
+
+// Simulate data pushing with intervals to observe backpressure handling
+let counter = 0;
+const interval = setInterval(() => {
+  if (counter >= 10) {
+    streamIntake.signalEnd();
+    clearInterval(interval);
+  } else {
+    streamIntake.pushData(`Chunk ${counter}`);
+    counter++;
+  }
+}, 50);
+```
+
+In this advanced use case, a `SlowProcessor` and `FastProcessor` are created using `SmartDuplex`, simulating a situation where one stream is slower than another. The `StreamIntake` dynamically handles incoming chunks of data and the intermediary Pass-Through handles any potential interruptions.
+
+### Transform Streams in Parallel
+
+For scenarios where you need to process data in parallel:
+
+```typescript
+import { SmartDuplex, createTransformFunction } from '@push.rocks/smartstream';
+
+const parallelTransform = createTransformFunction<any, any>(async (chunk) => {
+  // Parallel Processing
+  const results = await Promise.all(chunk.map(async item => await processItem(item)));
+  return results;
+});
+
+const streamIntake = new StreamIntake<any[]>();
+
+streamIntake
+  .pipe(parallelTransform)
+  .pipe(new SmartDuplex({
+    async writeFunction(chunk, { push }) {
+      console.log('Processed parallel chunk:', chunk);
+      push(chunk);
+    }
+  }))
+  .on('finish', () => console.log('Parallel processing completed.'));
+
+// Simulate data pushing
+streamIntake.pushData([1, 2, 3, 4]);
+streamIntake.pushData([5, 6, 7, 8]);
+streamIntake.signalEnd();
+```
+
+### Error Handling in Stream Pipelines
+
+Error handling is an essential part of working with streams. The `StreamWrapper` assists in combining multiple streams while managing errors seamlessly:
+
+```typescript
+import { StreamWrapper } from '@push.rocks/smartstream';
+
+const faultyStream = new SmartDuplex({
+  async writeFunction(chunk, { push }) {
+    if (chunk === 'bad data') {
+      throw new Error('Faulty data encountered');
+    }
+    push(chunk);
+  }
+});
+
+const readStream = new StreamIntake<string>();
+const writeStream = new SmartDuplex({
+  async writeFunction(chunk) {
+    console.log('Written chunk:', chunk);
+  }
+});
+
+const combinedStream = new StreamWrapper([readStream, faultyStream, writeStream]);
+
+combinedStream.run()
+  .then(() => console.log('Stream processing completed.'))
+  .catch(err => console.error('Stream error:', err.message));
+
+// Push Data
+readStream.pushData('good data');
+readStream.pushData('bad data');  // This will throw an error
+readStream.pushData('more good data');
+readStream.signalEnd();
+```
+
+### Testing Streams
+
+Here's an example test case using the `tap` testing framework to verify the integrity of the `SmartDuplex` from a buffer:
+
+```typescript
+import { expect, tap } from '@push.rocks/tapbundle';
+import { SmartDuplex } from '@push.rocks/smartstream';
+
+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();
+```
+
+### Working with Files and Buffers
+
+You can easily stream files and buffers with `smartstream`. Here’s a test illustrating reading and writing with file streams using `smartfile` combined with `smartstream` utilities:
+
+```typescript
+import { tap } from '@push.rocks/tapbundle';
+import * as smartfile from '@push.rocks/smartfile';
+import { SmartDuplex, StreamWrapper } from '@push.rocks/smartstream';
+
+tap.test('should handle file read and write streams', async () => {
+  const readStream = smartfile.fsStream.createReadStream('./test/assets/readabletext.txt');
+  const writeStream = smartfile.fsStream.createWriteStream('./test/assets/writabletext.txt');
+
+  const transformStream = new SmartDuplex({
+    async writeFunction(chunk, { push }) {
+      const transformedChunk = chunk.toString().toUpperCase();
+      push(transformedChunk);
+    }
+  });
+
+  const streamWrapper = new StreamWrapper([readStream, transformStream, writeStream]);
+
+  await streamWrapper.run();
+
+  const outputContent = await smartfile.fs.promises.readFile('./test/assets/writabletext.txt', 'utf-8');
+  console.log('Output Content:', outputContent);
+});
+
+tap.start();
+```
+
+### Modular and Scoped Transformations
+
+Creating modular and scoped transformations is straightforward with `SmartDuplex`:
+
+```typescript
+import { SmartDuplex } from '@push.rocks/smartstream';
+
+type DataChunk = {
+  id: number;
+  data: string;
+};
+
+const transformationStream1 = new SmartDuplex<DataChunk, DataChunk>({
+  async writeFunction(chunk, { push }) {
+    chunk.data = chunk.data.toUpperCase();
+    push(chunk);
+  }
+})
+
+const transformationStream2 = new SmartDuplex<DataChunk, DataChunk>({
+  async writeFunction(chunk, { push }) {
+    chunk.data = `${chunk.data} processed with transformation 2`;
+    push(chunk);
+  }
+});
+
+const initialData: DataChunk[] = [
+  { id: 1, data: 'first' },
+  { id: 2, data: 'second' }
+];
+
+const intakeStream = new StreamIntake<DataChunk>();
+
+intakeStream
+  .pipe(transformationStream1)
+  .pipe(transformationStream2)
+  .on('data', data => console.log('Transformed Data:', data));
+
+initialData.forEach(item => intakeStream.pushData(item));
+intakeStream.signalEnd();
+```
+
+By leveraging `SmartDuplex`, `StreamWrapper`, and `StreamIntake`, you can streamline and enhance your data transformation pipelines in Node.js with a clear, efficient, and backpressure-friendly approach.
+```
+
+
+## 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.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,13 +1,13 @@
-import fs from 'fs';
+import * as smartfile from '@push.rocks/smartfile';
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, tap } from '@push.rocks/tapbundle';
 
-import * as smartstream from '../ts/index.js';
+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.Smartstream([
+  testSmartstream = new smartstream.StreamWrapper([
-    fs.createReadStream('./test/assets/test.md'),
+    smartfile.fsStream.createReadStream('./test/assets/test.md'),
-    fs.createWriteStream('./test/assets/testCopy.md'),
+    smartfile.fsStream.createWriteStream('./test/assets/testCopy.md'),
   ]);
   await 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.38',
+  description: 'A library to simplify the creation and manipulation of Node.js streams, providing utilities for handling transform, duplex, and readable/writable streams effectively in TypeScript.'
+}

ts/index.ts

@@ -1,107 +1,8 @@
+export * from './smartstream.classes.smartduplex.js';
+export * from './smartstream.classes.streamwrapper.js';
+export * from './smartstream.classes.streamintake.js';
+
+export * from './smartstream.functions.js';
+
 import * as plugins from './smartstream.plugins.js';
-
+export const webstream = plugins.webstream;
-// 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 Smartstream {
-  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;
-  }
-}
-
-export let cleanPipe = () => {
-  return plugins.through2.obj(
-    (file, enc, cb) => {
-      cb();
-    },
-    (cb) => {
-      cb();
-    }
-  );
-};

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 => {
+      while (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,12 +1,13 @@
+// node native
 import * as stream from 'stream';
 
 export { stream };
 
 // pushrocks scope
-import * as smartpromise from '@pushrocks/smartpromise';
+import * as lik from '@push.rocks/lik';
-export { smartpromise };
+import * as smartpromise from '@push.rocks/smartpromise';
+import * as smartrx from '@push.rocks/smartrx';
+import * as webstream from '@push.rocks/webstream';
 
-// thirdparty
+export { lik, smartpromise, smartrx, webstream };
-import * as through2 from 'through2';
 
-export { through2 };

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"
+  ]
+}