Compare commits
53 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 1262c48fe9 | |||
| 9b9b1be62b | |||
| 3d13cb76f6 | |||
| 9e3fd28c4a | |||
| 673f5c86fb | |||
| a225188e24 | |||
| 4fc82d0dc6 | |||
| 3d58a01b29 | |||
| f7e9636bf6 | |||
| f211cc8ddd | |||
| 60c8824f33 | |||
| 40e8e06ff1 | |||
| 30f2facd59 | |||
| ddb7d4af03 | |||
| 22d93b4c07 | |||
| e138bca39d | |||
| 6a2ef1b152 | |||
| 7b1d2199e9 | |||
| 04c22f73df | |||
| c8dc791c83 | |||
| 9c30e5bab1 | |||
| 5f2c5f9380 | |||
| f9b8bf33b0 | |||
| a55b2548d7 | |||
| c8465b82be | |||
| b593e3a32c | |||
| a490f521ab | |||
| 59027782dc | |||
| 8c7dd7970c | |||
| 22d18dc21f | |||
| 1cb6f727af | |||
| 824c44d165 | |||
| 3e062103f8 | |||
| 6451e93c12 | |||
| 70cf93595c | |||
| 17e03e9790 | |||
| e52ce7af61 | |||
| f548f4b6cb | |||
| 23a7a77a73 | |||
| 13d2fc78b8 | |||
| 898cc0407d | |||
| 8a3f43a11a | |||
| da2191bb96 | |||
| f13db1e422 | |||
| 42a90e804a | |||
| 413e2af717 | |||
| 267a76af13 | |||
| 7834b7e6d2 | |||
| ae643708e7 | |||
| d9d96b8bb7 | |||
| a961eea431 | |||
| edb58ade28 | |||
| 753a481765 |
140
.gitlab-ci.yml
140
.gitlab-ci.yml
@@ -1,140 +0,0 @@
|
||||
# gitzone ci_default
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
|
||||
cache:
|
||||
paths:
|
||||
- .npmci_cache/
|
||||
key: '$CI_BUILD_STAGE'
|
||||
|
||||
stages:
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- metadata
|
||||
|
||||
before_script:
|
||||
- npm install -g @shipzone/npmci
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
auditProductionDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- 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
|
||||
allow_failure: true
|
||||
104
changelog.md
Normal file
104
changelog.md
Normal file
@@ -0,0 +1,104 @@
|
||||
# Changelog
|
||||
|
||||
## 2026-02-28 - 3.3.0 - feat(smartstream)
|
||||
bump dependencies, update build/publish config, refactor tests, and overhaul documentation
|
||||
|
||||
- Upgrade devDependencies (e.g. @git.zone/tsbuild -> ^4.1.2, @git.zone/tsrun -> ^2.0.1, @git.zone/tstest -> ^3.1.8, @types/node -> ^25.3.2) and runtime deps (e.g. @push.rocks/lik -> ^6.2.2, @push.rocks/smartenv -> ^6.0.0, @push.rocks/smartpromise -> ^4.2.3, @push.rocks/smartrx -> ^3.0.10).
|
||||
- Refactor tests to use Node's native fs streams instead of @push.rocks/smartfile.fsStream and export default tap.start() to support ESM test runner patterns.
|
||||
- Adjust build/publish: remove --web flag from build script, add pnpm override for agentkeepalive, add tspublish.json files for publish order, and add release registries/access in npmextra.json (verdaccio + npm).
|
||||
- Rework project metadata in npmextra.json (namespaced @git.zone keys, tsdoc entry changes) and minor TypeScript/web fix: cast stream/web constructors to any in ts_web/plugins.ts.
|
||||
- Large README rewrite: improved installation (pnpm), clearer Node vs Web entrypoints, expanded examples, and updated legal/license wording.
|
||||
|
||||
## 2024-11-19 - 3.2.5 - fix(nodewebhelpers)
|
||||
Fix import and use correct module structure for Node.js streams in smartstream.nodewebhelpers.ts
|
||||
|
||||
- Corrected the import statement for the fs module.
|
||||
- Updated the use of the fs.createReadStream method.
|
||||
|
||||
## 2024-10-16 - 3.2.4 - fix(SmartDuplex)
|
||||
Fix stream termination when reading from a web readable stream
|
||||
|
||||
- Resolved an issue in SmartDuplex where the stream did not properly terminate after reaching the end of a web readable stream.
|
||||
|
||||
## 2024-10-16 - 3.2.3 - fix(smartduplex)
|
||||
Enhance documentation for read function in SmartDuplex
|
||||
|
||||
- Added inline comments to clarify the behavior and importance of unlocking the reader in the readFunction of SmartDuplex.fromWebReadableStream.
|
||||
|
||||
## 2024-10-16 - 3.2.2 - fix(SmartDuplex)
|
||||
Fix issue with SmartDuplex fromWebReadableStream method
|
||||
|
||||
- Resolved a potential unhandled promise rejection in fromWebReadableStream method
|
||||
- Ensured proper release of stream reader lock in case of read completion
|
||||
|
||||
## 2024-10-16 - 3.2.1 - fix(core)
|
||||
Fix the order of operations in SmartDuplex _read method to ensure proper waiting for items.
|
||||
|
||||
- Adjusted the order of reading function execution and waiting for items in the SmartDuplex _read method.
|
||||
- Fixed potential issues with stream data processing timing.
|
||||
|
||||
## 2024-10-16 - 3.2.0 - feat(SmartDuplex)
|
||||
Added method to create SmartDuplex from a WebReadableStream.
|
||||
|
||||
- Implemented a static method in SmartDuplex to allow creating an instance from a WebReadableStream.
|
||||
- This addition enhances the capability of SmartDuplex to integrate with web streams, facilitating seamless stream manipulation across environments.
|
||||
|
||||
## 2024-10-14 - 3.1.2 - fix(WebDuplexStream)
|
||||
Fix variable naming inconsistency in WebDuplexStream test
|
||||
|
||||
- Changed variable names from 'transformStream' to 'webDuplexStream' for consistency.
|
||||
- Renamed 'writableStream' and 'readableStream' to 'writer' and 'reader' respectively.
|
||||
|
||||
## 2024-10-13 - 3.1.1 - fix(WebDuplexStream)
|
||||
Improved read/write interface and error handling in WebDuplexStream
|
||||
|
||||
- Enhanced the IStreamToolsRead and IStreamToolsWrite interfaces for better Promise handling
|
||||
- Refined readFunction and writeFunction handling to accommodate asynchronous data processing and error propagation
|
||||
- Added internal _startReading method to facilitate initial data handling if readFunction is present
|
||||
- Maintained backward compatibility while ensuring data continuity when no writeFunction is specified
|
||||
|
||||
## 2024-10-13 - 3.1.0 - feat(core)
|
||||
Add support for creating Web ReadableStream from a file
|
||||
|
||||
- Introduced a new helper function `createWebReadableStreamFromFile` that allows for creating a Web ReadableStream from a file path.
|
||||
- Updated exports in `ts/index.ts` to include `nodewebhelpers` which provides the new web stream feature.
|
||||
|
||||
## 2024-10-13 - 3.0.46 - fix(WebDuplexStream)
|
||||
Fix errors in WebDuplexStream transformation and test logic
|
||||
|
||||
- Corrected async handling in WebDuplexStream write function
|
||||
- Fixed `WebDuplexStream` tests to properly handle asynchronous reading and writing
|
||||
|
||||
## 2024-10-13 - 3.0.45 - fix(ts)
|
||||
Fixed formatting issues in SmartDuplex class
|
||||
|
||||
- Resolved inconsistent spacing in SmartDuplex class methods and constructor.
|
||||
- Ensured consistent formatting in the getWebStreams method.
|
||||
|
||||
## 2024-06-02 - 3.0.39 - smartduplex
|
||||
Add .getWebStreams method
|
||||
|
||||
- Introduced a new `.getWebStreams` method in the smartduplex module, providing compatibility with the web streams API.
|
||||
|
||||
## 2024-03-16 - 3.0.34 - configuration
|
||||
Update project configuration files
|
||||
|
||||
- Updated `tsconfig` for optimization.
|
||||
- Modified `npmextra.json` to set the `githost` attribute.
|
||||
|
||||
## 2023-11-03 - 3.0.0 to 3.0.8 - core
|
||||
Transition to major version 3.x
|
||||
|
||||
- Implemented breaking changes in the core system for better performance and feature set.
|
||||
- Continuous core updates to improve stability and performance across minor version increments.
|
||||
|
||||
## 2023-11-02 - 2.0.4 to 2.0.8 - core
|
||||
Core updates and a major fix
|
||||
|
||||
- Implemented core updates addressing minor bugs and enhancements.
|
||||
- A significant breaking change update transitioning from 2.0.x to 3.0.0.
|
||||
|
||||
## 2022-03-31 - 2.0.0 - core
|
||||
Major esm transition
|
||||
|
||||
- Implemented a breaking change by switching the core to ESM (ECMAScript Module) format for modernized module handling.
|
||||
@@ -1,17 +1,45 @@
|
||||
{
|
||||
"npmci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
},
|
||||
"gitzone": {
|
||||
"@git.zone/cli": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"githost": "code.foss.global",
|
||||
"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": "@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"
|
||||
]
|
||||
},
|
||||
"release": {
|
||||
"registries": [
|
||||
"https://verdaccio.lossless.digital",
|
||||
"https://registry.npmjs.org"
|
||||
],
|
||||
"accessLevel": "public"
|
||||
}
|
||||
},
|
||||
"@git.zone/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"
|
||||
},
|
||||
"@ship.zone/szci": {
|
||||
"npmGlobalTools": []
|
||||
}
|
||||
}
|
||||
59
package.json
59
package.json
@@ -1,38 +1,39 @@
|
||||
{
|
||||
"name": "@push.rocks/smartstream",
|
||||
"version": "3.0.32",
|
||||
"version": "3.3.0",
|
||||
"private": false,
|
||||
"description": "simplifies access to node streams",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"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.",
|
||||
"type": "module",
|
||||
"exports": {
|
||||
".": "./dist_ts/index.js",
|
||||
"./web": "./dist_ts_web/index.js"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "(tstest test/)",
|
||||
"build": "(tsbuild)",
|
||||
"buildDocs": "tsdoc"
|
||||
"build": "(tsbuild tsfolders --allowimplicitany)"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://gitlab.com/push.rocks/smartstream.git"
|
||||
"url": "https://code.foss.global/push.rocks/smartstream.git"
|
||||
},
|
||||
"author": "Lossless GmbH",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://gitlab.com/push.rocks/smartstream/issues"
|
||||
},
|
||||
"homepage": "https://gitlab.com/push.rocks/smartstream#readme",
|
||||
"homepage": "https://code.foss.global/push.rocks/smartstream",
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.1.72",
|
||||
"@git.zone/tsrun": "^1.2.44",
|
||||
"@git.zone/tstest": "^1.0.86",
|
||||
"@push.rocks/smartfile": "^11.0.4",
|
||||
"@push.rocks/tapbundle": "^5.0.15",
|
||||
"@types/node": "^20.11.20"
|
||||
"@git.zone/tsbuild": "^4.1.2",
|
||||
"@git.zone/tsrun": "^2.0.1",
|
||||
"@git.zone/tstest": "^3.1.8",
|
||||
"@push.rocks/tapbundle": "^6.0.3",
|
||||
"@types/node": "^25.3.2"
|
||||
},
|
||||
"dependencies": {
|
||||
"@push.rocks/lik": "^6.0.14",
|
||||
"@push.rocks/smartpromise": "^4.0.3",
|
||||
"@push.rocks/smartrx": "^3.0.7"
|
||||
"@push.rocks/lik": "^6.2.2",
|
||||
"@push.rocks/smartenv": "^6.0.0",
|
||||
"@push.rocks/smartpromise": "^4.2.3",
|
||||
"@push.rocks/smartrx": "^3.0.10"
|
||||
},
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
@@ -48,5 +49,29 @@
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"pnpm": {
|
||||
"overrides": {
|
||||
"agentkeepalive": "^4.6.0"
|
||||
}
|
||||
},
|
||||
"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"
|
||||
]
|
||||
}
|
||||
|
||||
13010
pnpm-lock.yaml
generated
13010
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@@ -0,0 +1 @@
|
||||
- make sure to respect backpressure handling.
|
||||
496
readme.md
496
readme.md
@@ -1,54 +1,472 @@
|
||||
# @pushrocks/smartstream
|
||||
simplifies access to node streams
|
||||
# @push.rocks/smartstream
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartstream)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartstream)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/smartstream)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartstream/)
|
||||
A TypeScript-first library for creating and manipulating Node.js and Web streams with built-in backpressure handling, async transformations, and seamless Node.js ↔ Web stream interoperability.
|
||||
|
||||
## Status for master
|
||||
## Issue Reporting and Security
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
pnpm install @push.rocks/smartstream
|
||||
```
|
||||
|
||||
The package ships with two entry points:
|
||||
|
||||
| Entry Point | Import Path | Environment |
|
||||
|---|---|---|
|
||||
| **Node.js** (default) | `@push.rocks/smartstream` | Node.js — full stream utilities, duplex, intake, wrappers, and Node↔Web helpers |
|
||||
| **Web** | `@push.rocks/smartstream/web` | Browser & Node.js — pure Web Streams API (`WebDuplexStream`) |
|
||||
|
||||
## Usage
|
||||
|
||||
Use TypeScript for best in class instellisense.
|
||||
All examples use ESM / TypeScript syntax.
|
||||
|
||||
### 📦 Importing
|
||||
|
||||
```typescript
|
||||
import { Smartstream } from 'smartstream'
|
||||
import * as gUglify from 'gulp-uglify'
|
||||
// Node.js — full API
|
||||
import {
|
||||
SmartDuplex,
|
||||
StreamWrapper,
|
||||
StreamIntake,
|
||||
createTransformFunction,
|
||||
createPassThrough,
|
||||
nodewebhelpers,
|
||||
} from '@push.rocks/smartstream';
|
||||
|
||||
let mySmartstream = new Smartstream([
|
||||
gulp.src(['./file1.js','./file2.js']),
|
||||
gUglify(),
|
||||
gulp.dest('./some/output/path')
|
||||
])
|
||||
|
||||
mySmartstream.onError((err) => { /* handle error */ }) // handles all errors in stream
|
||||
myStream.onCustomEvent('myeventname', (args...) => { /* Do something */ }) // emit an custom event anywhere in your stream
|
||||
mySmartstream.run().then(() => {/* do something when stream is finished */})
|
||||
// Web — browser-safe, zero Node.js dependencies
|
||||
import { WebDuplexStream } from '@push.rocks/smartstream/web';
|
||||
```
|
||||
|
||||
## Contribution
|
||||
---
|
||||
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||
### 🔄 SmartDuplex — The Core Stream Primitive
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
`SmartDuplex` extends Node.js `Duplex` with first-class async support, built-in backpressure management, and a clean functional API. Instead of overriding `_transform` or `_write` manually, you pass a `writeFunction` that receives each chunk along with a `tools` object.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
#### Basic Transform
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
```typescript
|
||||
import { SmartDuplex } from '@push.rocks/smartstream';
|
||||
|
||||
const upperCaser = new SmartDuplex<Buffer, Buffer>({
|
||||
writeFunction: async (chunk, tools) => {
|
||||
// Return a value to push it downstream
|
||||
return Buffer.from(chunk.toString().toUpperCase());
|
||||
},
|
||||
});
|
||||
|
||||
readableStream.pipe(upperCaser).pipe(writableStream);
|
||||
```
|
||||
|
||||
#### Using `tools.push()` for Multiple Outputs
|
||||
|
||||
The `writeFunction` can emit multiple chunks per input via `tools.push()`:
|
||||
|
||||
```typescript
|
||||
const splitter = new SmartDuplex<string, string>({
|
||||
objectMode: true,
|
||||
writeFunction: async (chunk, tools) => {
|
||||
const words = chunk.split(' ');
|
||||
for (const word of words) {
|
||||
await tools.push(word);
|
||||
}
|
||||
// Returning nothing — output was already pushed
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
#### Final Function
|
||||
|
||||
Run cleanup or emit final data when the writable side ends:
|
||||
|
||||
```typescript
|
||||
const aggregator = new SmartDuplex<number, number>({
|
||||
objectMode: true,
|
||||
writeFunction: async (chunk, tools) => {
|
||||
runningTotal += chunk;
|
||||
// Don't emit anything per-chunk
|
||||
},
|
||||
finalFunction: async (tools) => {
|
||||
return runningTotal; // Emitted as the last chunk
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
#### Truncating a Stream Early
|
||||
|
||||
Call `tools.truncate()` inside `writeFunction` to signal that no more data should be read:
|
||||
|
||||
```typescript
|
||||
const limiter = new SmartDuplex<string, string>({
|
||||
objectMode: true,
|
||||
writeFunction: async (chunk, tools) => {
|
||||
if (chunk === 'STOP') {
|
||||
tools.truncate();
|
||||
return;
|
||||
}
|
||||
return chunk;
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
#### Creating from a Buffer
|
||||
|
||||
```typescript
|
||||
const stream = SmartDuplex.fromBuffer(Buffer.from('hello world'));
|
||||
stream.on('data', (chunk) => console.log(chunk.toString())); // "hello world"
|
||||
```
|
||||
|
||||
#### Creating from a Web ReadableStream
|
||||
|
||||
Bridge the Web Streams API into a Node.js Duplex:
|
||||
|
||||
```typescript
|
||||
const response = await fetch('https://example.com/data');
|
||||
const nodeDuplex = SmartDuplex.fromWebReadableStream(response.body);
|
||||
|
||||
nodeDuplex.pipe(processTransform).pipe(outputStream);
|
||||
```
|
||||
|
||||
#### Getting Web Streams from SmartDuplex
|
||||
|
||||
Convert a `SmartDuplex` into Web `ReadableStream` + `WritableStream` pair:
|
||||
|
||||
```typescript
|
||||
const duplex = new SmartDuplex({
|
||||
writeFunction: async (chunk, tools) => {
|
||||
return transform(chunk);
|
||||
},
|
||||
});
|
||||
|
||||
const { readable, writable } = await duplex.getWebStreams();
|
||||
```
|
||||
|
||||
#### Debug Mode
|
||||
|
||||
Pass `debug: true` and `name` to get detailed internal logs:
|
||||
|
||||
```typescript
|
||||
const stream = new SmartDuplex({
|
||||
name: 'MyStream',
|
||||
debug: true,
|
||||
writeFunction: async (chunk, tools) => chunk,
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 🧩 StreamWrapper — Pipeline Composition
|
||||
|
||||
`StreamWrapper` takes an array of streams, pipes them together, attaches error listeners on all of them, and returns a `Promise` that resolves when the pipeline finishes:
|
||||
|
||||
```typescript
|
||||
import { StreamWrapper } from '@push.rocks/smartstream';
|
||||
import fs from 'fs';
|
||||
|
||||
const pipeline = new StreamWrapper([
|
||||
fs.createReadStream('./input.txt'),
|
||||
new SmartDuplex({
|
||||
writeFunction: async (chunk) => Buffer.from(chunk.toString().toUpperCase()),
|
||||
}),
|
||||
fs.createWriteStream('./output.txt'),
|
||||
]);
|
||||
|
||||
await pipeline.run();
|
||||
console.log('Pipeline complete!');
|
||||
```
|
||||
|
||||
Error handling is automatic — if any stream in the array errors, the returned promise rejects:
|
||||
|
||||
```typescript
|
||||
pipeline.run()
|
||||
.then(() => console.log('Done'))
|
||||
.catch((err) => console.error('Pipeline failed:', err));
|
||||
```
|
||||
|
||||
You can also listen for custom events across all streams:
|
||||
|
||||
```typescript
|
||||
pipeline.onCustomEvent('progress', () => {
|
||||
console.log('Progress event fired');
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 📥 StreamIntake — Dynamic Data Injection
|
||||
|
||||
`StreamIntake` is a `Readable` stream that lets you programmatically push data into a pipeline. It operates in object mode by default and provides a reactive observable (`pushNextObservable`) for demand-driven data production.
|
||||
|
||||
```typescript
|
||||
import { StreamIntake, SmartDuplex } from '@push.rocks/smartstream';
|
||||
|
||||
const intake = new StreamIntake<string>();
|
||||
|
||||
// Pipe through a transform
|
||||
intake
|
||||
.pipe(new SmartDuplex({
|
||||
objectMode: true,
|
||||
writeFunction: async (chunk) => {
|
||||
console.log('Processing:', chunk);
|
||||
return chunk;
|
||||
},
|
||||
}))
|
||||
.on('data', (data) => console.log('Output:', data));
|
||||
|
||||
// Push data whenever it's ready
|
||||
intake.pushData('Hello');
|
||||
intake.pushData('World');
|
||||
intake.signalEnd(); // Signal end-of-stream
|
||||
```
|
||||
|
||||
#### Demand-driven Production with Observable
|
||||
|
||||
`pushNextObservable` emits whenever the stream is ready for more data — perfect for throttled or event-driven producers:
|
||||
|
||||
```typescript
|
||||
const intake = new StreamIntake<number>();
|
||||
|
||||
let counter = 0;
|
||||
intake.pushNextObservable.subscribe(() => {
|
||||
if (counter < 100) {
|
||||
intake.pushData(counter++);
|
||||
} else {
|
||||
intake.signalEnd();
|
||||
}
|
||||
});
|
||||
|
||||
intake.pipe(consumer);
|
||||
```
|
||||
|
||||
#### Creating from Existing Streams
|
||||
|
||||
Wrap a Node.js `Readable` or a Web `ReadableStream`:
|
||||
|
||||
```typescript
|
||||
// From Node.js Readable
|
||||
const intake = await StreamIntake.fromStream<Buffer>(fs.createReadStream('./data.bin'));
|
||||
|
||||
// From Web ReadableStream
|
||||
const response = await fetch('https://example.com/stream');
|
||||
const intake = await StreamIntake.fromStream<Uint8Array>(response.body);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### ⚡ Utility Functions
|
||||
|
||||
#### `createTransformFunction`
|
||||
|
||||
Quickly create a `SmartDuplex` from a simple async mapping function:
|
||||
|
||||
```typescript
|
||||
import { createTransformFunction } from '@push.rocks/smartstream';
|
||||
|
||||
const doubler = createTransformFunction<number, number>(async (n) => n * 2);
|
||||
|
||||
intakeStream.pipe(doubler).pipe(outputStream);
|
||||
```
|
||||
|
||||
#### `createPassThrough`
|
||||
|
||||
Create an object-mode passthrough stream (useful as an intermediary or tee point):
|
||||
|
||||
```typescript
|
||||
import { createPassThrough } from '@push.rocks/smartstream';
|
||||
|
||||
const passThrough = createPassThrough();
|
||||
source.pipe(passThrough).pipe(destination);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 🌐 WebDuplexStream — Pure Web Streams API
|
||||
|
||||
`WebDuplexStream` extends `TransformStream` and works in both browsers and Node.js. Import it from the `/web` subpath for zero Node.js dependencies.
|
||||
|
||||
```typescript
|
||||
import { WebDuplexStream } from '@push.rocks/smartstream/web';
|
||||
|
||||
const stream = new WebDuplexStream<number, number>({
|
||||
writeFunction: async (chunk, { push }) => {
|
||||
push(chunk * 2); // Push transformed data
|
||||
},
|
||||
});
|
||||
|
||||
const writer = stream.writable.getWriter();
|
||||
const reader = stream.readable.getReader();
|
||||
|
||||
// Write
|
||||
await writer.write(5);
|
||||
await writer.write(10);
|
||||
await writer.close();
|
||||
|
||||
// Read
|
||||
const { value } = await reader.read(); // 10
|
||||
const { value: v2 } = await reader.read(); // 20
|
||||
```
|
||||
|
||||
#### From a Uint8Array
|
||||
|
||||
```typescript
|
||||
const stream = WebDuplexStream.fromUInt8Array(new Uint8Array([1, 2, 3]));
|
||||
const reader = stream.readable.getReader();
|
||||
const { value } = await reader.read(); // Uint8Array [1, 2, 3]
|
||||
```
|
||||
|
||||
#### Data Production with `readFunction`
|
||||
|
||||
Supply data into the stream from any async source:
|
||||
|
||||
```typescript
|
||||
const stream = new WebDuplexStream<string, string>({
|
||||
readFunction: async (tools) => {
|
||||
await tools.write('chunk 1');
|
||||
await tools.write('chunk 2');
|
||||
tools.done(); // Signal end
|
||||
},
|
||||
writeFunction: async (chunk, { push }) => {
|
||||
push(chunk.toUpperCase());
|
||||
},
|
||||
});
|
||||
|
||||
const reader = stream.readable.getReader();
|
||||
// reads "CHUNK 1", "CHUNK 2"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 🔀 Node ↔ Web Stream Converters
|
||||
|
||||
The `nodewebhelpers` namespace provides bidirectional converters between Node.js and Web Streams:
|
||||
|
||||
```typescript
|
||||
import { nodewebhelpers } from '@push.rocks/smartstream';
|
||||
```
|
||||
|
||||
| Function | From | To |
|
||||
|---|---|---|
|
||||
| `createWebReadableStreamFromFile(path)` | File path | Web `ReadableStream<Uint8Array>` |
|
||||
| `convertWebReadableToNodeReadable(webStream)` | Web `ReadableStream` | Node.js `Readable` |
|
||||
| `convertNodeReadableToWebReadable(nodeStream)` | Node.js `Readable` | Web `ReadableStream` |
|
||||
| `convertWebWritableToNodeWritable(webWritable)` | Web `WritableStream` | Node.js `Writable` |
|
||||
| `convertNodeWritableToWebWritable(nodeWritable)` | Node.js `Writable` | Web `WritableStream` |
|
||||
|
||||
#### Example: Serve a File as a Web ReadableStream
|
||||
|
||||
```typescript
|
||||
const webStream = nodewebhelpers.createWebReadableStreamFromFile('./video.mp4');
|
||||
|
||||
// Use with fetch Response, service workers, etc.
|
||||
return new Response(webStream, {
|
||||
headers: { 'Content-Type': 'video/mp4' },
|
||||
});
|
||||
```
|
||||
|
||||
#### Example: Convert Between Stream Types
|
||||
|
||||
```typescript
|
||||
import fs from 'fs';
|
||||
import { nodewebhelpers } from '@push.rocks/smartstream';
|
||||
|
||||
// Node → Web
|
||||
const nodeReadable = fs.createReadStream('./data.bin');
|
||||
const webReadable = nodewebhelpers.convertNodeReadableToWebReadable(nodeReadable);
|
||||
|
||||
// Web → Node
|
||||
const nodeReadable2 = nodewebhelpers.convertWebReadableToNodeReadable(webReadable);
|
||||
nodeReadable2.pipe(fs.createWriteStream('./copy.bin'));
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 🏗️ Backpressure Handling
|
||||
|
||||
`SmartDuplex` uses a `BackpressuredArray` internally, bounded by `highWaterMark` (default: 1). When the downstream consumer is slow, the stream automatically pauses the upstream producer until space is available — no manual bookkeeping required.
|
||||
|
||||
```typescript
|
||||
const slow = new SmartDuplex({
|
||||
name: 'SlowConsumer',
|
||||
objectMode: true,
|
||||
highWaterMark: 1,
|
||||
writeFunction: async (chunk, tools) => {
|
||||
await new Promise((resolve) => setTimeout(resolve, 200));
|
||||
return chunk;
|
||||
},
|
||||
});
|
||||
|
||||
const fast = new SmartDuplex({
|
||||
name: 'FastProducer',
|
||||
objectMode: true,
|
||||
writeFunction: async (chunk, tools) => {
|
||||
return chunk; // Instant processing
|
||||
},
|
||||
});
|
||||
|
||||
// Backpressure is handled automatically between fast → slow
|
||||
fast.pipe(slow).on('data', (d) => console.log(d));
|
||||
|
||||
for (let i = 0; i < 100; i++) {
|
||||
fast.write(`chunk-${i}`);
|
||||
}
|
||||
fast.end();
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 🎯 Real-World Example: Processing Pipeline
|
||||
|
||||
```typescript
|
||||
import fs from 'fs';
|
||||
import { SmartDuplex, StreamWrapper } from '@push.rocks/smartstream';
|
||||
|
||||
// Read → Transform → Filter → Write
|
||||
const pipeline = new StreamWrapper([
|
||||
fs.createReadStream('./access.log'),
|
||||
new SmartDuplex({
|
||||
writeFunction: async (chunk) => {
|
||||
// Parse each line
|
||||
return chunk.toString().split('\n');
|
||||
},
|
||||
}),
|
||||
new SmartDuplex({
|
||||
objectMode: true,
|
||||
writeFunction: async (lines: string[], tools) => {
|
||||
// Filter and push matching lines
|
||||
for (const line of lines) {
|
||||
if (line.includes('ERROR')) {
|
||||
await tools.push(line + '\n');
|
||||
}
|
||||
}
|
||||
},
|
||||
}),
|
||||
fs.createWriteStream('./errors.log'),
|
||||
]);
|
||||
|
||||
await pipeline.run();
|
||||
console.log('Error extraction complete');
|
||||
```
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
|
||||
|
||||
**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 or third parties, 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 or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District Court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or 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.
|
||||
|
||||
@@ -65,4 +65,4 @@ tap.test('should run backpressure test', async (toolsArg) => {
|
||||
await done.promise;
|
||||
});
|
||||
|
||||
await tap.start();
|
||||
export default tap.start();
|
||||
@@ -21,4 +21,4 @@ tap.test('should create a SmartStream from a Buffer', async () => {
|
||||
});
|
||||
});
|
||||
|
||||
tap.start();
|
||||
export default tap.start();
|
||||
@@ -1,5 +1,5 @@
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import * as smartfile from '@push.rocks/smartfile';
|
||||
import * as fs from 'fs';
|
||||
|
||||
import * as smartstream from '../ts/index.js';
|
||||
|
||||
@@ -8,7 +8,7 @@ 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'),
|
||||
fs.createReadStream('./test/assets/readabletext.txt'),
|
||||
new smartstream.SmartDuplex({
|
||||
writeFunction: async (chunkStringArg: Buffer, streamTools) => {
|
||||
// do something with the stream here
|
||||
@@ -44,7 +44,7 @@ tap.test('should create a valid Intake', async (tools) => {
|
||||
}
|
||||
})
|
||||
)
|
||||
.pipe(smartfile.fsStream.createWriteStream('./test/assets/writabletext.txt'));
|
||||
.pipe(fs.createWriteStream('./test/assets/writabletext.txt'));
|
||||
const testFinished = tools.defer();
|
||||
let counter = 0;
|
||||
testIntake.pushNextObservable.subscribe(() => {
|
||||
@@ -62,4 +62,4 @@ tap.test('should create a valid Intake', async (tools) => {
|
||||
testIntake.signalEnd();
|
||||
});
|
||||
|
||||
tap.start();
|
||||
export default tap.start();
|
||||
@@ -1,4 +1,4 @@
|
||||
import * as smartfile from '@push.rocks/smartfile';
|
||||
import * as fs from 'fs';
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
|
||||
import * as smartstream from '../ts/smartstream.classes.streamwrapper.js';
|
||||
@@ -6,10 +6,10 @@ import * as smartstream from '../ts/smartstream.classes.streamwrapper.js';
|
||||
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'),
|
||||
fs.createReadStream('./test/assets/test.md'),
|
||||
fs.createWriteStream('./test/assets/testCopy.md'),
|
||||
]);
|
||||
await testSmartstream.run();
|
||||
});
|
||||
|
||||
tap.start();
|
||||
export default tap.start();
|
||||
67
test/test.ts_web.both.ts
Normal file
67
test/test.ts_web.both.ts
Normal file
@@ -0,0 +1,67 @@
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import * as webstream from '../ts_web/index.js';
|
||||
|
||||
tap.test('WebDuplexStream fromUInt8Array should read back the same Uint8Array', async () => {
|
||||
const inputUint8Array = new Uint8Array([1, 2, 3, 4, 5]);
|
||||
const stream = webstream.WebDuplexStream.fromUInt8Array(inputUint8Array);
|
||||
|
||||
const reader = stream.readable.getReader();
|
||||
let readUint8Array = new Uint8Array();
|
||||
|
||||
// Read from the stream
|
||||
while (true) {
|
||||
const { value, done } = await reader.read();
|
||||
if (done) break;
|
||||
if (value) {
|
||||
// Concatenate value to readUint8Array
|
||||
const tempArray = new Uint8Array(readUint8Array.length + value.length);
|
||||
tempArray.set(readUint8Array, 0);
|
||||
tempArray.set(value, readUint8Array.length);
|
||||
readUint8Array = tempArray;
|
||||
}
|
||||
}
|
||||
|
||||
expect(readUint8Array).toEqual(inputUint8Array);
|
||||
});
|
||||
|
||||
tap.test('WebDuplexStream should handle transform with a write function', async () => {
|
||||
const input = [1, 2, 3, 4, 5];
|
||||
const expectedOutput = [2, 4, 6, 8, 10];
|
||||
|
||||
const webDuplexStream = new webstream.WebDuplexStream<number, number>({
|
||||
writeFunction: async (chunk, { push }) => {
|
||||
// Push the doubled number into the stream
|
||||
push(chunk * 2);
|
||||
},
|
||||
});
|
||||
|
||||
const writer = webDuplexStream.writable.getWriter();
|
||||
const reader = webDuplexStream.readable.getReader();
|
||||
|
||||
const output: number[] = [];
|
||||
|
||||
// Read from the stream asynchronously
|
||||
const readPromise = (async () => {
|
||||
while (true) {
|
||||
const { value, done } = await reader.read();
|
||||
if (done) break;
|
||||
if (value !== undefined) {
|
||||
output.push(value);
|
||||
}
|
||||
}
|
||||
})();
|
||||
|
||||
// Write to the stream
|
||||
for (const num of input) {
|
||||
await writer.write(num);
|
||||
}
|
||||
await writer.close();
|
||||
|
||||
// Wait for the reading to complete
|
||||
await readPromise;
|
||||
|
||||
// Assert that the output matches the expected transformed data
|
||||
expect(output).toEqual(expectedOutput);
|
||||
});
|
||||
|
||||
export default tap.start();
|
||||
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartstream',
|
||||
version: '3.0.32',
|
||||
description: 'simplifies access to node streams'
|
||||
version: '3.3.0',
|
||||
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.'
|
||||
}
|
||||
|
||||
14
ts/index.ts
14
ts/index.ts
@@ -1,5 +1,17 @@
|
||||
import { stream } from './smartstream.plugins.js';
|
||||
export {
|
||||
stream,
|
||||
}
|
||||
|
||||
export * from './smartstream.classes.smartduplex.js';
|
||||
export * from './smartstream.classes.streamwrapper.js';
|
||||
export * from './smartstream.classes.streamintake.js';
|
||||
|
||||
export * from './smartstream.functions.js'
|
||||
export * from './smartstream.functions.js';
|
||||
|
||||
import * as plugins from './smartstream.plugins.js';
|
||||
export const webstream = plugins.webstream;
|
||||
import * as nodewebhelpers from './smartstream.nodewebhelpers.js';
|
||||
export {
|
||||
nodewebhelpers,
|
||||
}
|
||||
|
||||
@@ -3,7 +3,7 @@ import { Duplex, type DuplexOptions } from 'stream';
|
||||
|
||||
export interface IStreamTools {
|
||||
truncate: () => void;
|
||||
push: (pipeObject: any) => Promise<void>;
|
||||
push: (pipeObject: any) => Promise<boolean>;
|
||||
}
|
||||
|
||||
export interface IStreamWriteFunction<T, rT> {
|
||||
@@ -34,11 +34,11 @@ export interface ISmartDuplexOptions<TInput, TOutput> extends DuplexOptions {
|
||||
* 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 being sent to the end of the stream
|
||||
* a final function that is run at the end of the stream
|
||||
*/
|
||||
finalFunction?: IStreamFinalFunction<TOutput>;
|
||||
// Add other custom options if necessary
|
||||
}
|
||||
|
||||
export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
|
||||
@@ -52,46 +52,78 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
|
||||
return smartDuplex;
|
||||
}
|
||||
|
||||
public static fromWebReadableStream<T = any>(
|
||||
readableStream: ReadableStream<T>
|
||||
): SmartDuplex<T, T> {
|
||||
const smartDuplex = new SmartDuplex<T, T>({
|
||||
/**
|
||||
* this function is called whenever the stream is being read from and at the same time if nothing is enqueued
|
||||
* therefor it is important to always unlock the reader after reading
|
||||
*/
|
||||
readFunction: async () => {
|
||||
const reader = readableStream.getReader();
|
||||
const { value, done } = await reader.read();
|
||||
if (value !== undefined) {
|
||||
smartDuplex.push(value);
|
||||
}
|
||||
reader.releaseLock();
|
||||
if (done) {
|
||||
smartDuplex.push(null);
|
||||
}
|
||||
},
|
||||
});
|
||||
return smartDuplex;
|
||||
}
|
||||
|
||||
// INSTANCE
|
||||
private backpressuredArray: plugins.lik.BackpressuredArray<TOutput>;
|
||||
private backpressuredArray: plugins.lik.BackpressuredArray<TOutput>; // an array that only takes a defined amount of items
|
||||
public options: ISmartDuplexOptions<TInput, TOutput>;
|
||||
private observableSubscription?: plugins.smartrx.rxjs.Subscription;
|
||||
private debugLog(messageArg: string) {
|
||||
// optional debug log
|
||||
if (this.options.debug) {
|
||||
console.log(messageArg);
|
||||
}
|
||||
}
|
||||
|
||||
constructor(optionsArg?: ISmartDuplexOptions<TInput, TOutput>) {
|
||||
super(Object.assign({
|
||||
highWaterMark: 1,
|
||||
}, optionsArg));
|
||||
super(
|
||||
Object.assign(
|
||||
{
|
||||
highWaterMark: 1,
|
||||
},
|
||||
optionsArg
|
||||
)
|
||||
);
|
||||
this.options = optionsArg;
|
||||
this.backpressuredArray = new plugins.lik.BackpressuredArray<TOutput>(this.options.highWaterMark || 1)
|
||||
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();
|
||||
}
|
||||
await this.backpressuredArray.waitForItems();
|
||||
this.debugLog(`${this.options.name}: successfully waited for items.`);
|
||||
let canPushMore = true;
|
||||
while(this.backpressuredArray.data.length > 0 && canPushMore) {
|
||||
while (this.backpressuredArray.data.length > 0 && canPushMore) {
|
||||
const nextChunk = this.backpressuredArray.shift();
|
||||
canPushMore = this.push(nextChunk);
|
||||
}
|
||||
}
|
||||
|
||||
public async backpressuredPush (pushArg: TOutput) {
|
||||
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
|
||||
@@ -108,8 +140,8 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
|
||||
callback();
|
||||
},
|
||||
push: async (pushArg: TOutput) => {
|
||||
await this.backpressuredPush(pushArg);
|
||||
}
|
||||
return await this.backpressuredPush(pushArg);
|
||||
},
|
||||
};
|
||||
|
||||
try {
|
||||
@@ -138,7 +170,7 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
|
||||
const tools: IStreamTools = {
|
||||
truncate: () => callback(),
|
||||
push: async (pipeObject) => {
|
||||
this.backpressuredArray.push(pipeObject);
|
||||
return this.backpressuredArray.push(pipeObject);
|
||||
},
|
||||
};
|
||||
|
||||
@@ -156,4 +188,53 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
|
||||
this.backpressuredArray.push(null);
|
||||
callback();
|
||||
}
|
||||
|
||||
public async getWebStreams(): Promise<{ readable: ReadableStream; writable: WritableStream }> {
|
||||
const duplex = this;
|
||||
const readable = new ReadableStream({
|
||||
start(controller) {
|
||||
duplex.on('readable', () => {
|
||||
let chunk;
|
||||
while (null !== (chunk = duplex.read())) {
|
||||
controller.enqueue(chunk);
|
||||
}
|
||||
});
|
||||
|
||||
duplex.on('end', () => {
|
||||
controller.close();
|
||||
});
|
||||
},
|
||||
cancel(reason) {
|
||||
duplex.destroy(new Error(reason));
|
||||
},
|
||||
});
|
||||
|
||||
const writable = new WritableStream({
|
||||
write(chunk) {
|
||||
return new Promise<void>((resolve, reject) => {
|
||||
const isBackpressured = !duplex.write(chunk, (error) => {
|
||||
if (error) {
|
||||
reject(error);
|
||||
} else {
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
|
||||
if (isBackpressured) {
|
||||
duplex.once('drain', resolve);
|
||||
}
|
||||
});
|
||||
},
|
||||
close() {
|
||||
return new Promise<void>((resolve, reject) => {
|
||||
duplex.end(resolve);
|
||||
});
|
||||
},
|
||||
abort(reason) {
|
||||
duplex.destroy(new Error(reason));
|
||||
},
|
||||
});
|
||||
|
||||
return { readable, writable };
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,45 @@
|
||||
import * as plugins from './smartstream.plugins.js';
|
||||
|
||||
export class StreamIntake<T> extends plugins.stream.Readable {
|
||||
// STATIC
|
||||
public static async fromStream<U>(inputStream: plugins.stream.Readable | ReadableStream, options?: plugins.stream.ReadableOptions): Promise<StreamIntake<U>> {
|
||||
const intakeStream = new StreamIntake<U>(options);
|
||||
|
||||
if (inputStream instanceof plugins.stream.Readable) {
|
||||
inputStream.on('data', (chunk: U) => {
|
||||
intakeStream.pushData(chunk);
|
||||
});
|
||||
|
||||
inputStream.on('end', () => {
|
||||
intakeStream.signalEnd();
|
||||
});
|
||||
|
||||
inputStream.on('error', (err: Error) => {
|
||||
intakeStream.destroy(err);
|
||||
});
|
||||
} else {
|
||||
const reader = (inputStream as ReadableStream).getReader();
|
||||
|
||||
const readChunk = () => {
|
||||
reader.read().then(({ done, value }) => {
|
||||
if (done) {
|
||||
intakeStream.signalEnd();
|
||||
} else {
|
||||
intakeStream.pushData(value);
|
||||
readChunk();
|
||||
}
|
||||
}).catch((err) => {
|
||||
intakeStream.destroy(err);
|
||||
});
|
||||
};
|
||||
|
||||
readChunk();
|
||||
}
|
||||
|
||||
return intakeStream;
|
||||
}
|
||||
|
||||
// INSTANCE
|
||||
private signalEndBoolean = false;
|
||||
private chunkStore: T[] = [];
|
||||
public pushNextObservable = new plugins.smartrx.ObservableIntake<any>();
|
||||
@@ -14,7 +53,7 @@ export class StreamIntake<T> extends plugins.stream.Readable {
|
||||
_read(size: number): void {
|
||||
// console.log('get next');
|
||||
const pushChunk = (): void => {
|
||||
if (this.chunkStore.length > 0) {
|
||||
while (this.chunkStore.length > 0) {
|
||||
// If push returns false, then we should stop reading
|
||||
if (!this.push(this.chunkStore.shift())) {
|
||||
return;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { Transform, type TransformCallback, type TransformOptions } from 'stream';
|
||||
import { type TransformOptions } from 'stream';
|
||||
import { SmartDuplex } from './smartstream.classes.smartduplex.js';
|
||||
|
||||
export interface AsyncTransformFunction<TInput, TOutput> {
|
||||
|
||||
151
ts/smartstream.nodewebhelpers.ts
Normal file
151
ts/smartstream.nodewebhelpers.ts
Normal file
@@ -0,0 +1,151 @@
|
||||
import * as plugins from './smartstream.plugins.js';
|
||||
|
||||
/**
|
||||
* Creates a Web ReadableStream from a file.
|
||||
*
|
||||
* @param filePath - The path to the file to be read
|
||||
* @returns A Web ReadableStream that reads the file in chunks
|
||||
*/
|
||||
export function createWebReadableStreamFromFile(filePath: string): ReadableStream<Uint8Array> {
|
||||
const fileStream = plugins.fs.createReadStream(filePath);
|
||||
|
||||
return new ReadableStream({
|
||||
start(controller) {
|
||||
// When data is available, enqueue it into the Web ReadableStream
|
||||
fileStream.on('data', (chunk) => {
|
||||
controller.enqueue(chunk as Uint8Array);
|
||||
});
|
||||
|
||||
// When the file stream ends, close the Web ReadableStream
|
||||
fileStream.on('end', () => {
|
||||
controller.close();
|
||||
});
|
||||
|
||||
// If there's an error, error the Web ReadableStream
|
||||
fileStream.on('error', (err) => {
|
||||
controller.error(err);
|
||||
});
|
||||
},
|
||||
cancel() {
|
||||
// If the Web ReadableStream is canceled, destroy the file stream
|
||||
fileStream.destroy();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a Web ReadableStream to a Node.js Readable stream.
|
||||
*
|
||||
* @param webStream - The Web ReadableStream to convert
|
||||
* @returns A Node.js Readable stream that reads data from the Web ReadableStream
|
||||
*/
|
||||
export function convertWebReadableToNodeReadable(webStream: ReadableStream<Uint8Array>): plugins.stream.Readable {
|
||||
const reader = webStream.getReader();
|
||||
|
||||
return new plugins.stream.Readable({
|
||||
async read() {
|
||||
try {
|
||||
const { value, done } = await reader.read();
|
||||
if (done) {
|
||||
this.push(null); // Signal end of stream
|
||||
} else {
|
||||
this.push(Buffer.from(value)); // Convert Uint8Array to Buffer for Node.js Readable
|
||||
}
|
||||
} catch (err) {
|
||||
this.destroy(err); // Handle errors by destroying the stream
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a Node.js Readable stream to a Web ReadableStream.
|
||||
*
|
||||
* @param nodeStream - The Node.js Readable stream to convert
|
||||
* @returns A Web ReadableStream that reads data from the Node.js Readable stream
|
||||
*/
|
||||
export function convertNodeReadableToWebReadable(nodeStream: plugins.stream.Readable): ReadableStream<Uint8Array> {
|
||||
return new ReadableStream({
|
||||
start(controller) {
|
||||
nodeStream.on('data', (chunk) => {
|
||||
controller.enqueue(new Uint8Array(chunk));
|
||||
});
|
||||
|
||||
nodeStream.on('end', () => {
|
||||
controller.close();
|
||||
});
|
||||
|
||||
nodeStream.on('error', (err) => {
|
||||
controller.error(err);
|
||||
});
|
||||
},
|
||||
cancel() {
|
||||
nodeStream.destroy();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a Web WritableStream to a Node.js Writable stream.
|
||||
*
|
||||
* @param webWritable - The Web WritableStream to convert
|
||||
* @returns A Node.js Writable stream that writes data to the Web WritableStream
|
||||
*/
|
||||
export function convertWebWritableToNodeWritable(webWritable: WritableStream<Uint8Array>): plugins.stream.Writable {
|
||||
const writer = webWritable.getWriter();
|
||||
|
||||
return new plugins.stream.Writable({
|
||||
async write(chunk, encoding, callback) {
|
||||
try {
|
||||
await writer.write(new Uint8Array(chunk));
|
||||
callback();
|
||||
} catch (err) {
|
||||
callback(err);
|
||||
}
|
||||
},
|
||||
final(callback) {
|
||||
writer.close().then(() => callback()).catch(callback);
|
||||
},
|
||||
destroy(err, callback) {
|
||||
writer.abort(err).then(() => callback(err)).catch(callback);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts a Node.js Writable stream to a Web WritableStream.
|
||||
*
|
||||
* @param nodeWritable - The Node.js Writable stream to convert
|
||||
* @returns A Web WritableStream that writes data to the Node.js Writable stream
|
||||
*/
|
||||
export function convertNodeWritableToWebWritable(nodeWritable: plugins.stream.Writable): WritableStream<Uint8Array> {
|
||||
return new WritableStream({
|
||||
write(chunk) {
|
||||
return new Promise((resolve, reject) => {
|
||||
nodeWritable.write(Buffer.from(chunk), (err) => {
|
||||
if (err) {
|
||||
reject(err);
|
||||
} else {
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
});
|
||||
},
|
||||
close() {
|
||||
return new Promise((resolve, reject) => {
|
||||
nodeWritable.end((err) => {
|
||||
if (err) {
|
||||
reject(err);
|
||||
} else {
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
});
|
||||
},
|
||||
abort(reason) {
|
||||
return new Promise((resolve, reject) => {
|
||||
nodeWritable.destroy(reason);
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
@@ -1,12 +1,14 @@
|
||||
// node native
|
||||
import * as fs from 'fs';
|
||||
import * as stream from 'stream';
|
||||
|
||||
export { stream };
|
||||
export { fs, 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 '../dist_ts_web/index.js';
|
||||
|
||||
export { lik, smartpromise, smartrx };
|
||||
export { lik, smartpromise, smartrx, webstream };
|
||||
|
||||
|
||||
3
ts/tspublish.json
Normal file
3
ts/tspublish.json
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"order": 1
|
||||
}
|
||||
8
ts_web/00_commitinfo_data.ts
Normal file
8
ts_web/00_commitinfo_data.ts
Normal file
@@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartstream',
|
||||
version: '3.3.0',
|
||||
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.'
|
||||
}
|
||||
135
ts_web/classes.webduplexstream.ts
Normal file
135
ts_web/classes.webduplexstream.ts
Normal file
@@ -0,0 +1,135 @@
|
||||
import * as plugins from './plugins.js';
|
||||
|
||||
// ========================================
|
||||
// Interfaces for Read functionality
|
||||
// ========================================
|
||||
export interface IStreamToolsRead<TInput, TOutput> {
|
||||
done: () => void;
|
||||
write: (writeArg: TInput) => Promise<void>;
|
||||
}
|
||||
|
||||
/**
|
||||
* The read function is called when data needs to be read into the stream.
|
||||
*/
|
||||
export interface IStreamReadFunction<TInput, TOutput> {
|
||||
(toolsArg: IStreamToolsRead<TInput, TOutput>): Promise<void>;
|
||||
}
|
||||
|
||||
// ========================================
|
||||
// Interfaces for Write functionality
|
||||
// ========================================
|
||||
export interface IStreamToolsWrite<TInput, TOutput> {
|
||||
truncate: () => void;
|
||||
push: (pushArg: TOutput) => void;
|
||||
}
|
||||
|
||||
/**
|
||||
* The write function is called whenever a chunk is written to the stream.
|
||||
*/
|
||||
export interface IStreamWriteFunction<TInput, TOutput> {
|
||||
(chunkArg: TInput, toolsArg: IStreamToolsWrite<TInput, TOutput>): Promise<any>;
|
||||
}
|
||||
|
||||
export interface IStreamFinalFunction<TInput, TOutput> {
|
||||
(toolsArg: IStreamToolsWrite<TInput, TOutput>): Promise<TOutput | void>;
|
||||
}
|
||||
|
||||
export interface WebDuplexStreamOptions<TInput, TOutput> {
|
||||
readFunction?: IStreamReadFunction<TInput, TOutput>;
|
||||
writeFunction?: IStreamWriteFunction<TInput, TOutput>;
|
||||
finalFunction?: IStreamFinalFunction<TInput, TOutput>;
|
||||
}
|
||||
|
||||
export class WebDuplexStream<TInput = any, TOutput = any> extends TransformStream<TInput, TOutput> {
|
||||
// INSTANCE
|
||||
options: WebDuplexStreamOptions<TInput, TOutput>;
|
||||
|
||||
constructor(optionsArg: WebDuplexStreamOptions<TInput, TOutput>) {
|
||||
super({
|
||||
async start(controller) {
|
||||
// Optionally initialize any state here
|
||||
},
|
||||
async transform(chunk, controller) {
|
||||
if (optionsArg?.writeFunction) {
|
||||
const tools: IStreamToolsWrite<TInput, TOutput> = {
|
||||
truncate: () => controller.terminate(),
|
||||
push: (pushArg: TOutput) => controller.enqueue(pushArg),
|
||||
};
|
||||
|
||||
try {
|
||||
const writeReturnChunk = await optionsArg.writeFunction(chunk, tools);
|
||||
if (writeReturnChunk !== undefined && writeReturnChunk !== null) {
|
||||
controller.enqueue(writeReturnChunk);
|
||||
}
|
||||
} catch (err) {
|
||||
controller.error(err);
|
||||
}
|
||||
} else {
|
||||
// If no writeFunction is provided, pass the chunk through
|
||||
controller.enqueue(chunk as unknown as TOutput);
|
||||
}
|
||||
},
|
||||
async flush(controller) {
|
||||
if (optionsArg?.finalFunction) {
|
||||
const tools: IStreamToolsWrite<TInput, TOutput> = {
|
||||
truncate: () => controller.terminate(),
|
||||
push: (pushArg) => controller.enqueue(pushArg),
|
||||
};
|
||||
|
||||
try {
|
||||
const finalChunk = await optionsArg.finalFunction(tools);
|
||||
if (finalChunk) {
|
||||
controller.enqueue(finalChunk);
|
||||
}
|
||||
} catch (err) {
|
||||
controller.error(err);
|
||||
} finally {
|
||||
controller.terminate();
|
||||
}
|
||||
} else {
|
||||
controller.terminate();
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
this.options = optionsArg;
|
||||
|
||||
// Start producing data if readFunction is provided
|
||||
if (this.options.readFunction) {
|
||||
this._startReading();
|
||||
}
|
||||
}
|
||||
|
||||
private async _startReading() {
|
||||
const writable = this.writable;
|
||||
const writer = writable.getWriter();
|
||||
|
||||
const tools: IStreamToolsRead<TInput, TOutput> = {
|
||||
done: () => writer.close(),
|
||||
write: async (writeArg) => await writer.write(writeArg),
|
||||
};
|
||||
|
||||
try {
|
||||
await this.options.readFunction(tools);
|
||||
} catch (err) {
|
||||
writer.abort(err);
|
||||
} finally {
|
||||
writer.releaseLock();
|
||||
}
|
||||
}
|
||||
|
||||
// Static method example (adjust as needed)
|
||||
static fromUInt8Array(uint8Array: Uint8Array): WebDuplexStream<Uint8Array, Uint8Array> {
|
||||
const stream = new WebDuplexStream<Uint8Array, Uint8Array>({
|
||||
writeFunction: async (chunk, { push }) => {
|
||||
push(chunk); // Directly push the chunk as is
|
||||
return null;
|
||||
},
|
||||
});
|
||||
|
||||
const writer = stream.writable.getWriter();
|
||||
writer.write(uint8Array).then(() => writer.close());
|
||||
|
||||
return stream;
|
||||
}
|
||||
}
|
||||
2
ts_web/index.ts
Normal file
2
ts_web/index.ts
Normal file
@@ -0,0 +1,2 @@
|
||||
import './plugins.js';
|
||||
export * from './classes.webduplexstream.js';
|
||||
15
ts_web/plugins.ts
Normal file
15
ts_web/plugins.ts
Normal file
@@ -0,0 +1,15 @@
|
||||
// @push.rocks scope
|
||||
import * as smartenv from '@push.rocks/smartenv';
|
||||
|
||||
export {
|
||||
smartenv,
|
||||
}
|
||||
|
||||
// lets setup dependencies
|
||||
const smartenvInstance = new smartenv.Smartenv();
|
||||
|
||||
await smartenvInstance.getSafeNodeModule<typeof import('stream/web')>('stream/web', async (moduleArg) => {
|
||||
globalThis.ReadableStream = moduleArg.ReadableStream as any;
|
||||
globalThis.WritableStream = moduleArg.WritableStream as any;
|
||||
globalThis.TransformStream = moduleArg.TransformStream as any;
|
||||
})
|
||||
3
ts_web/tspublish.json
Normal file
3
ts_web/tspublish.json
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"order": 0
|
||||
}
|
||||
Reference in New Issue
Block a user