Compare commits
36 Commits
Author | SHA1 | Date | |
---|---|---|---|
2c1d9f05ce | |||
34cbf28972 | |||
1b6e38c040 | |||
b135e6023a | |||
91d01f3689 | |||
e8e067ea77 | |||
2cb490cd2a | |||
98397bb85e | |||
f52b0de21f | |||
1c0e5f264d | |||
8a3c653213 | |||
456ce78917 | |||
5277083097 | |||
8618ac55ef | |||
ea66d1b2fb | |||
c37f62abec | |||
2c904cc1ec | |||
d1561ad1b7 | |||
0ae3fee987 | |||
047c2bd402 | |||
9ed3de718f | |||
14530f393c | |||
15a226d30d | |||
16c5c89662 | |||
851a96c014 | |||
4ea42cb9fb | |||
41eed6423d | |||
0e067004a4 | |||
9fe222b500 | |||
05e9067a34 | |||
2aff46eb0e | |||
6aa4b86598 | |||
af30268551 | |||
e562e8f099 | |||
01f4a53b5b | |||
f42b77986f |
66
.gitea/workflows/default_nottags.yaml
Normal file
66
.gitea/workflows/default_nottags.yaml
Normal file
@ -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
|
124
.gitea/workflows/default_tags.yaml
Normal file
124
.gitea/workflows/default_tags.yaml
Normal file
@ -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
|
20
.gitignore
vendored
20
.gitignore
vendored
@ -1,4 +1,20 @@
|
|||||||
node_modules/
|
.nogit/
|
||||||
|
|
||||||
|
# artifacts
|
||||||
|
coverage/
|
||||||
public/
|
public/
|
||||||
pages/
|
pages/
|
||||||
coverage/
|
|
||||||
|
# installs
|
||||||
|
node_modules/
|
||||||
|
|
||||||
|
# caches
|
||||||
|
.yarn/
|
||||||
|
.cache/
|
||||||
|
.rpt2_cache
|
||||||
|
|
||||||
|
# builds
|
||||||
|
dist/
|
||||||
|
dist_*/
|
||||||
|
|
||||||
|
# custom
|
110
.gitlab-ci.yml
110
.gitlab-ci.yml
@ -1,16 +1,19 @@
|
|||||||
# gitzone standard
|
# gitzone ci_default
|
||||||
image: hosttoday/ht-docker-node:npmci
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
|
||||||
cache:
|
cache:
|
||||||
paths:
|
paths:
|
||||||
- .npmci_cache/
|
- .npmci_cache/
|
||||||
key: "$CI_BUILD_STAGE"
|
key: '$CI_BUILD_STAGE'
|
||||||
|
|
||||||
stages:
|
stages:
|
||||||
- security
|
- security
|
||||||
- test
|
- test
|
||||||
- release
|
- release
|
||||||
- metadata
|
- metadata
|
||||||
|
|
||||||
|
before_script:
|
||||||
|
- npm install -g @shipzone/npmci
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# security stage
|
# security stage
|
||||||
@ -19,63 +22,42 @@ mirror:
|
|||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci git mirror
|
- npmci git mirror
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
snyk:
|
auditProductionDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci command npm install -g snyk
|
- npmci command npm install --production --ignore-scripts
|
||||||
- npmci command npm install --ignore-scripts
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
- npmci command snyk test
|
- npmci command npm audit --audit-level=high --only=prod --production
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
|
||||||
sast:
|
|
||||||
stage: security
|
|
||||||
image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
|
|
||||||
variables:
|
|
||||||
DOCKER_DRIVER: overlay2
|
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
services:
|
|
||||||
- docker:stable-dind
|
auditDevDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci npm install
|
- npmci command npm install --ignore-scripts
|
||||||
- npmci command npm run build
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
|
- npmci command npm audit --audit-level=high --only=dev
|
||||||
- docker run
|
|
||||||
--env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
|
|
||||||
--volume "$PWD:/code"
|
|
||||||
--volume /var/run/docker.sock:/var/run/docker.sock
|
|
||||||
"registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
|
|
||||||
artifacts:
|
|
||||||
reports:
|
|
||||||
sast: gl-sast-report.json
|
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
- priv
|
allow_failure: true
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# test stage
|
# test stage
|
||||||
# ====================
|
# ====================
|
||||||
|
|
||||||
testLTS:
|
testStable:
|
||||||
stage: test
|
|
||||||
script:
|
|
||||||
- npmci npm prepare
|
|
||||||
- npmci node install lts
|
|
||||||
- npmci npm install
|
|
||||||
- npmci npm test
|
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
|
||||||
tags:
|
|
||||||
- docker
|
|
||||||
- notpriv
|
|
||||||
|
|
||||||
testSTABLE:
|
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
@ -85,7 +67,17 @@ testSTABLE:
|
|||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
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:
|
release:
|
||||||
stage: release
|
stage: release
|
||||||
@ -95,6 +87,7 @@ release:
|
|||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
@ -103,20 +96,15 @@ release:
|
|||||||
# ====================
|
# ====================
|
||||||
codequality:
|
codequality:
|
||||||
stage: metadata
|
stage: metadata
|
||||||
image: docker:stable
|
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
services:
|
only:
|
||||||
- docker:stable-dind
|
- tags
|
||||||
script:
|
script:
|
||||||
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
|
- npmci command npm install -g typescript
|
||||||
- docker run
|
- npmci npm prepare
|
||||||
--env SOURCE_CODE="$PWD"
|
- npmci npm install
|
||||||
--volume "$PWD":/code
|
|
||||||
--volume /var/run/docker.sock:/var/run/docker.sock
|
|
||||||
"registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
|
|
||||||
artifacts:
|
|
||||||
paths: [codeclimate.json]
|
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- priv
|
- priv
|
||||||
|
|
||||||
@ -127,18 +115,20 @@ trigger:
|
|||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
|
|
||||||
pages:
|
pages:
|
||||||
image: hosttoday/ht-docker-node:npmci
|
|
||||||
stage: metadata
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
- npmci command npm install -g typedoc typescript
|
- npmci node install lts
|
||||||
|
- npmci command npm install -g @git.zone/tsdoc
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
|
- npmci command tsdoc
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
only:
|
only:
|
||||||
|
11
.vscode/launch.json
vendored
Normal file
11
.vscode/launch.json
vendored
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"command": "npm test",
|
||||||
|
"name": "Run npm test",
|
||||||
|
"request": "launch",
|
||||||
|
"type": "node-terminal"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
"json.schemas": [
|
||||||
|
{
|
||||||
|
"fileMatch": ["/npmextra.json"],
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"npmci": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for npmci"
|
||||||
|
},
|
||||||
|
"gitzone": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for gitzone",
|
||||||
|
"properties": {
|
||||||
|
"projectType": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
43
README.md
43
README.md
@ -1,43 +0,0 @@
|
|||||||
# @pushrocks/smartstream
|
|
||||||
simplifies access to node streams
|
|
||||||
|
|
||||||
## 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/)
|
|
||||||
|
|
||||||
## Status for master
|
|
||||||
[](https://gitlab.com/pushrocks/smartstream/commits/master)
|
|
||||||
[](https://gitlab.com/pushrocks/smartstream/commits/master)
|
|
||||||
[](https://www.npmjs.com/package/@pushrocks/smartstream)
|
|
||||||
[](https://snyk.io/test/npm/@pushrocks/smartstream)
|
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
||||||
[](http://standardjs.com/)
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Use TypeScript for best in class instellisense.
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { Smartstream } from 'smartstream'
|
|
||||||
import * as gUglify from 'gulp-uglify'
|
|
||||||
|
|
||||||
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 */})
|
|
||||||
```
|
|
||||||
|
|
||||||
For further information read the linked docs at the top of this readme.
|
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
||||||
|
|
||||||
[](https://maintainedby.lossless.com)
|
|
@ -1,52 +0,0 @@
|
|||||||
# smartstream
|
|
||||||
|
|
||||||
simplifies access to node streams, TypeScript ready!
|
|
||||||
|
|
||||||
## Availabililty
|
|
||||||
|
|
||||||
[](https://www.npmjs.com/package/smartstream)
|
|
||||||
[](https://GitLab.com/pushrocks/smartstream)
|
|
||||||
[](https://github.com/pushrocks/smartstream)
|
|
||||||
[](https://pushrocks.gitlab.io/smartstream/)
|
|
||||||
|
|
||||||
## Status for master
|
|
||||||
|
|
||||||
[](https://GitLab.com/pushrocks/smartstream/commits/master)
|
|
||||||
[](https://GitLab.com/pushrocks/smartstream/commits/master)
|
|
||||||
[](https://www.npmjs.com/package/smartstream)
|
|
||||||
[](https://david-dm.org/pushrocks/smartstream)
|
|
||||||
[](https://www.bithound.io/github/pushrocks/smartstream/master/dependencies/npm)
|
|
||||||
[](https://www.bithound.io/github/pushrocks/smartstream)
|
|
||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
||||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
||||||
[](http://standardjs.com/)
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Use TypeScript for best in class instellisense.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
We recommend the use of TypeScript for best in class intellisense support.
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { Smartstream } from 'smartstream'
|
|
||||||
import * as gUglify from 'gulp-uglify'
|
|
||||||
|
|
||||||
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 */})
|
|
||||||
```
|
|
||||||
|
|
||||||
For further information read the linked docs at the top of this README.
|
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
||||||
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
||||||
|
|
||||||
[](https://lossless.com)
|
|
@ -4,12 +4,13 @@
|
|||||||
"npmAccessLevel": "public"
|
"npmAccessLevel": "public"
|
||||||
},
|
},
|
||||||
"gitzone": {
|
"gitzone": {
|
||||||
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "pushrocks",
|
"gitscope": "push.rocks",
|
||||||
"gitrepo": "smartstream",
|
"gitrepo": "smartstream",
|
||||||
"shortDescription": "simplifies access to node streams",
|
"description": "simplifies access to node streams",
|
||||||
"npmPackagename": "@pushrocks/smartstream",
|
"npmPackagename": "@push.rocks/smartstream",
|
||||||
"license": "MIT"
|
"license": "MIT"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
1663
package-lock.json
generated
1663
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
51
package.json
51
package.json
@ -1,34 +1,51 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/smartstream",
|
"name": "@push.rocks/smartstream",
|
||||||
"version": "1.0.13",
|
"version": "3.0.7",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "simplifies access to node streams",
|
"description": "simplifies access to node streams",
|
||||||
"main": "dist/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/)",
|
"test": "(tstest test/)",
|
||||||
"build": "(tsbuild)"
|
"build": "(tsbuild)",
|
||||||
|
"buildDocs": "tsdoc"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+ssh://git@gitlab.com/pushrocks/smartstream.git"
|
"url": "git+https://gitlab.com/push.rocks/smartstream.git"
|
||||||
},
|
},
|
||||||
"author": "Lossless GmbH",
|
"author": "Lossless GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"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": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.8",
|
"@git.zone/tsbuild": "^2.1.66",
|
||||||
"@gitzone/tstest": "^1.0.18",
|
"@git.zone/tsrun": "^1.2.44",
|
||||||
"@pushrocks/tapbundle": "^3.0.7",
|
"@git.zone/tstest": "^1.0.77",
|
||||||
"tslint": "^5.12.1",
|
"@push.rocks/smartfile": "^10.0.37",
|
||||||
"tslint-config-prettier": "^1.18.0"
|
"@push.rocks/tapbundle": "^5.0.15",
|
||||||
|
"@types/node": "^20.8.10"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/smartpromise": "^2.0.5",
|
"@push.rocks/smartpromise": "^4.0.3",
|
||||||
"@types/through2": "^2.0.34",
|
"@push.rocks/smartrx": "^3.0.7"
|
||||||
"through2": "^3.0.0"
|
},
|
||||||
}
|
"browserslist": [
|
||||||
|
"last 1 chrome versions"
|
||||||
|
],
|
||||||
|
"files": [
|
||||||
|
"ts/**/*",
|
||||||
|
"ts_web/**/*",
|
||||||
|
"dist/**/*",
|
||||||
|
"dist_*/**/*",
|
||||||
|
"dist_ts/**/*",
|
||||||
|
"dist_ts_web/**/*",
|
||||||
|
"assets/**/*",
|
||||||
|
"cli.js",
|
||||||
|
"npmextra.json",
|
||||||
|
"readme.md"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
5659
pnpm-lock.yaml
generated
Normal file
5659
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
54
readme.md
Normal file
54
readme.md
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
# @pushrocks/smartstream
|
||||||
|
simplifies access to node streams
|
||||||
|
|
||||||
|
## 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/)
|
||||||
|
|
||||||
|
## Status for master
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Use TypeScript for best in class instellisense.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Smartstream } from 'smartstream'
|
||||||
|
import * as gUglify from 'gulp-uglify'
|
||||||
|
|
||||||
|
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 */})
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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). :)
|
||||||
|
|
||||||
|
For further information read the linked docs at the top of this readme.
|
||||||
|
|
||||||
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||||
|
|
||||||
|
[](https://maintainedby.lossless.com)
|
6210
test/assets/readabletext.txt
Normal file
6210
test/assets/readabletext.txt
Normal file
File diff suppressed because it is too large
Load Diff
50
test/assets/writabletext.txt
Normal file
50
test/assets/writabletext.txt
Normal file
@ -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
|
44
test/test.smartstream.ts
Normal file
44
test/test.smartstream.ts
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
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.test('should create a SmartStream from an Observable', async () => {
|
||||||
|
const observableData = 'Observable test data';
|
||||||
|
const testObservable = smartrx.rxjs.of(Buffer.from(observableData));
|
||||||
|
|
||||||
|
const smartStream = SmartDuplex.fromObservable(testObservable);
|
||||||
|
|
||||||
|
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(observableData);
|
||||||
|
resolve();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
65
test/test.streamfunction.ts
Normal file
65
test/test.streamfunction.ts
Normal file
@ -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({
|
||||||
|
writeAndTransformFunction: 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({
|
||||||
|
writeAndTransformFunction: 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,
|
||||||
|
writeAndTransformFunction: 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();
|
14
test/test.ts
14
test/test.ts
@ -1,13 +1,13 @@
|
|||||||
import fs = require('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';
|
import * as smartstream from '../ts/smartstream.classes.streamwrapper.js';
|
||||||
|
|
||||||
let testSmartstream: smartstream.Smartstream;
|
let testSmartstream: smartstream.StreamWrapper;
|
||||||
tap.test('should combine a stream', async () => {
|
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();
|
await testSmartstream.run();
|
||||||
});
|
});
|
||||||
|
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* autocreated commitinfo by @pushrocks/commitinfo
|
||||||
|
*/
|
||||||
|
export const commitinfo = {
|
||||||
|
name: '@push.rocks/smartstream',
|
||||||
|
version: '3.0.7',
|
||||||
|
description: 'simplifies access to node streams'
|
||||||
|
}
|
111
ts/index.ts
111
ts/index.ts
@ -1,107 +1,6 @@
|
|||||||
import * as plugins from './smartstream.plugins';
|
export * from './smartstream.classes.passthrough.js';
|
||||||
|
export * from './smartstream.classes.smartduplex.js';
|
||||||
|
export * from './smartstream.classes.streamwrapper.js';
|
||||||
|
export * from './smartstream.classes.streamintake.js';
|
||||||
|
|
||||||
// interfaces
|
export * from './smartstream.functions.js'
|
||||||
import { Transform } from 'stream';
|
|
||||||
|
|
||||||
export interface IErrorFunction {
|
|
||||||
(err): any;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ICustomEventFunction {
|
|
||||||
(): any;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ICustomEventObject {
|
|
||||||
eventName: string;
|
|
||||||
eventFunction: ICustomEventFunction;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* class Smartstream handles
|
|
||||||
*/
|
|
||||||
export class Smartstream {
|
|
||||||
private streamArray = [];
|
|
||||||
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 = [];
|
|
||||||
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();
|
|
||||||
}
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
21
ts/smartstream.classes.passthrough.ts
Normal file
21
ts/smartstream.classes.passthrough.ts
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
import * as plugins from './smartstream.plugins.js';
|
||||||
|
|
||||||
|
export class PassThrough extends plugins.stream.Duplex {
|
||||||
|
constructor(options?: plugins.stream.DuplexOptions) {
|
||||||
|
super(options);
|
||||||
|
}
|
||||||
|
|
||||||
|
_read(size: number): void {
|
||||||
|
// No-op: Data written will be automatically available for reading.
|
||||||
|
}
|
||||||
|
|
||||||
|
_write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void {
|
||||||
|
if (this.push(chunk, encoding)) {
|
||||||
|
callback();
|
||||||
|
} else {
|
||||||
|
this.once('drain', () => {
|
||||||
|
callback();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
177
ts/smartstream.classes.smartduplex.ts
Normal file
177
ts/smartstream.classes.smartduplex.ts
Normal file
@ -0,0 +1,177 @@
|
|||||||
|
import * as plugins from './smartstream.plugins.js';
|
||||||
|
import { Duplex, type DuplexOptions } from 'stream';
|
||||||
|
|
||||||
|
export interface IStreamTools {
|
||||||
|
truncate: () => void;
|
||||||
|
push: (pipeObject: any) => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IWriteAndTransformFunction<T, rT> {
|
||||||
|
(chunkArg: T, toolsArg: IStreamTools): Promise<rT>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface IStreamEndFunction<rT> {
|
||||||
|
(toolsArg: IStreamTools): Promise<rT>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SmartStreamOptions<TInput, TOutput> extends DuplexOptions {
|
||||||
|
readFunction?: () => Promise<void>;
|
||||||
|
writeAndTransformFunction?: IWriteAndTransformFunction<TInput, TOutput>;
|
||||||
|
finalFunction?: IStreamEndFunction<TOutput>;
|
||||||
|
// Add other custom options if necessary
|
||||||
|
}
|
||||||
|
|
||||||
|
export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
|
||||||
|
// STATIC
|
||||||
|
static fromBuffer(buffer: Buffer, options?: DuplexOptions): SmartDuplex {
|
||||||
|
const smartStream = new SmartDuplex(options);
|
||||||
|
process.nextTick(() => {
|
||||||
|
smartStream.push(buffer);
|
||||||
|
smartStream.push(null); // Signal the end of the data
|
||||||
|
});
|
||||||
|
return smartStream;
|
||||||
|
}
|
||||||
|
|
||||||
|
static fromObservable(
|
||||||
|
observable: plugins.smartrx.rxjs.Observable<any>,
|
||||||
|
options?: DuplexOptions
|
||||||
|
): SmartDuplex {
|
||||||
|
const smartStream = new SmartDuplex(options);
|
||||||
|
smartStream.observableSubscription = observable.subscribe({
|
||||||
|
next: (data) => {
|
||||||
|
if (!smartStream.push(data)) {
|
||||||
|
// Pause the observable if the stream buffer is full
|
||||||
|
smartStream.observableSubscription?.unsubscribe();
|
||||||
|
smartStream.once('drain', () => {
|
||||||
|
// Resume the observable when the stream buffer is drained
|
||||||
|
smartStream.observableSubscription?.unsubscribe();
|
||||||
|
smartStream.observableSubscription = observable.subscribe((data) => {
|
||||||
|
smartStream.push(data);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
},
|
||||||
|
error: (err) => {
|
||||||
|
smartStream.emit('error', err);
|
||||||
|
},
|
||||||
|
complete: () => {
|
||||||
|
smartStream.push(null); // Signal the end of the data
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
return smartStream;
|
||||||
|
}
|
||||||
|
|
||||||
|
static fromReplaySubject(
|
||||||
|
replaySubject: plugins.smartrx.rxjs.ReplaySubject<any>,
|
||||||
|
options?: DuplexOptions
|
||||||
|
): SmartDuplex {
|
||||||
|
const smartStream = new SmartDuplex(options);
|
||||||
|
let isBackpressured = false;
|
||||||
|
|
||||||
|
// Subscribe to the ReplaySubject
|
||||||
|
const subscription = replaySubject.subscribe({
|
||||||
|
next: (data) => {
|
||||||
|
const canPush = smartStream.push(data);
|
||||||
|
if (!canPush) {
|
||||||
|
// If push returns false, pause the subscription because of backpressure
|
||||||
|
isBackpressured = true;
|
||||||
|
subscription.unsubscribe();
|
||||||
|
}
|
||||||
|
},
|
||||||
|
error: (err) => {
|
||||||
|
smartStream.emit('error', err);
|
||||||
|
},
|
||||||
|
complete: () => {
|
||||||
|
smartStream.push(null); // End the stream when the ReplaySubject completes
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
// Listen for 'drain' event to resume the subscription if it was paused
|
||||||
|
smartStream.on('drain', () => {
|
||||||
|
if (isBackpressured) {
|
||||||
|
isBackpressured = false;
|
||||||
|
// Resubscribe to the ReplaySubject since we previously paused
|
||||||
|
smartStream.observableSubscription = replaySubject.subscribe({
|
||||||
|
next: (data) => {
|
||||||
|
if (!smartStream.push(data)) {
|
||||||
|
smartStream.observableSubscription?.unsubscribe();
|
||||||
|
isBackpressured = true;
|
||||||
|
}
|
||||||
|
},
|
||||||
|
// No need to repeat error and complete handling here because it's already set up above
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return smartStream;
|
||||||
|
}
|
||||||
|
|
||||||
|
// INSTANCE
|
||||||
|
private readFunction?: () => Promise<void>;
|
||||||
|
private writeAndTransformFunction?: IWriteAndTransformFunction<TInput, TOutput>;
|
||||||
|
private streamEndFunction?: IStreamEndFunction<TOutput>;
|
||||||
|
private observableSubscription?: plugins.smartrx.rxjs.Subscription;
|
||||||
|
|
||||||
|
constructor(optionsArg?: SmartStreamOptions<TInput, TOutput>) {
|
||||||
|
super(optionsArg);
|
||||||
|
this.readFunction = optionsArg?.readFunction;
|
||||||
|
this.writeAndTransformFunction = optionsArg?.writeAndTransformFunction;
|
||||||
|
this.streamEndFunction = optionsArg?.finalFunction;
|
||||||
|
}
|
||||||
|
|
||||||
|
public async _read(size: number): Promise<void> {
|
||||||
|
if (this.readFunction) {
|
||||||
|
await this.readFunction();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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.writeAndTransformFunction) {
|
||||||
|
return callback(new Error('No stream function provided'));
|
||||||
|
}
|
||||||
|
|
||||||
|
const tools: IStreamTools = {
|
||||||
|
truncate: () => {
|
||||||
|
this.push(null);
|
||||||
|
callback();
|
||||||
|
},
|
||||||
|
push: (pushArg: TOutput) => this.push(pushArg),
|
||||||
|
};
|
||||||
|
|
||||||
|
try {
|
||||||
|
const modifiedChunk = await this.writeAndTransformFunction(chunk, tools);
|
||||||
|
if (modifiedChunk) {
|
||||||
|
if (!this.push(modifiedChunk)) {
|
||||||
|
// Handle backpressure if necessary
|
||||||
|
}
|
||||||
|
}
|
||||||
|
callback();
|
||||||
|
} catch (err) {
|
||||||
|
callback(err);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public async _final(callback: (error?: Error | null) => void) {
|
||||||
|
if (this.streamEndFunction) {
|
||||||
|
const tools: IStreamTools = {
|
||||||
|
truncate: () => callback(),
|
||||||
|
push: (pipeObject) => this.push(pipeObject),
|
||||||
|
};
|
||||||
|
|
||||||
|
try {
|
||||||
|
const finalChunk = await this.streamEndFunction(tools);
|
||||||
|
if (finalChunk) {
|
||||||
|
this.push(finalChunk);
|
||||||
|
}
|
||||||
|
callback();
|
||||||
|
} catch (err) {
|
||||||
|
callback(err);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
this.push(null),
|
||||||
|
callback();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
52
ts/smartstream.classes.streamintake.ts
Normal file
52
ts/smartstream.classes.streamintake.ts
Normal file
@ -0,0 +1,52 @@
|
|||||||
|
import * as plugins from './smartstream.plugins.js';
|
||||||
|
|
||||||
|
export class StreamIntake<T> extends plugins.stream.Readable {
|
||||||
|
private signalEndBoolean = false;
|
||||||
|
private chunkStore: T[] = [];
|
||||||
|
public pushNextObservable = new plugins.smartrx.ObservableIntake<any>();
|
||||||
|
private pushedNextDeferred = plugins.smartpromise.defer();
|
||||||
|
|
||||||
|
constructor(options?: plugins.stream.ReadableOptions) {
|
||||||
|
super({ ...options, objectMode: true }); // Ensure that we are in object mode.
|
||||||
|
this.pushNextObservable.push('please push next');
|
||||||
|
}
|
||||||
|
|
||||||
|
_read(size: number): void {
|
||||||
|
// console.log('get next');
|
||||||
|
const pushChunk = (): void => {
|
||||||
|
if (this.chunkStore.length > 0) {
|
||||||
|
// If push returns false, then we should stop reading
|
||||||
|
if (!this.push(this.chunkStore.shift())) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this.chunkStore.length === 0) {
|
||||||
|
if (this.signalEndBoolean) {
|
||||||
|
// If we're done, push null to signal the end of the stream
|
||||||
|
this.push(null);
|
||||||
|
} else {
|
||||||
|
// Ask for more data and wait
|
||||||
|
this.pushNextObservable.push('please push next');
|
||||||
|
this.pushedNextDeferred.promise.then(() => {
|
||||||
|
this.pushedNextDeferred = plugins.smartpromise.defer(); // Reset the deferred
|
||||||
|
pushChunk(); // Try pushing the next chunk
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
pushChunk();
|
||||||
|
}
|
||||||
|
|
||||||
|
public pushData(chunkData: T) {
|
||||||
|
this.chunkStore.push(chunkData);
|
||||||
|
this.pushedNextDeferred.resolve();
|
||||||
|
}
|
||||||
|
|
||||||
|
public signalEnd() {
|
||||||
|
this.signalEndBoolean = true;
|
||||||
|
this.pushedNextDeferred.resolve();
|
||||||
|
this.pushNextObservable.signalComplete();
|
||||||
|
}
|
||||||
|
}
|
96
ts/smartstream.classes.streamwrapper.ts
Normal file
96
ts/smartstream.classes.streamwrapper.ts
Normal file
@ -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;
|
||||||
|
}
|
||||||
|
}
|
26
ts/smartstream.functions.ts
Normal file
26
ts/smartstream.functions.ts
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
import { Transform, type TransformCallback, type TransformOptions } from 'stream';
|
||||||
|
|
||||||
|
export interface AsyncTransformFunction<TInput, TOutput> {
|
||||||
|
(chunkArg: TInput): Promise<TOutput>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function createTransformFunction<TInput, TOutput>(
|
||||||
|
asyncFunction: AsyncTransformFunction<TInput, TOutput>,
|
||||||
|
options?: TransformOptions
|
||||||
|
): Transform {
|
||||||
|
const transformStream = new Transform({
|
||||||
|
...options,
|
||||||
|
objectMode: true, // Ensure we operate in object mode
|
||||||
|
async transform(chunk: TInput, encoding: string, callback: TransformCallback) {
|
||||||
|
try {
|
||||||
|
const transformed = await asyncFunction(chunk);
|
||||||
|
this.push(transformed);
|
||||||
|
callback();
|
||||||
|
} catch (error) {
|
||||||
|
callback(error instanceof Error ? error : new Error(String(error)));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return transformStream;
|
||||||
|
}
|
@ -1,4 +1,11 @@
|
|||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
// node native
|
||||||
import * as through2 from 'through2';
|
import * as stream from 'stream';
|
||||||
|
|
||||||
|
export { stream };
|
||||||
|
|
||||||
|
// pushrocks scope
|
||||||
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
|
import * as smartrx from '@push.rocks/smartrx';
|
||||||
|
|
||||||
|
export { smartpromise, smartrx };
|
||||||
|
|
||||||
export { smartpromise, through2 };
|
|
||||||
|
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"experimentalDecorators": true,
|
||||||
|
"useDefineForClassFields": false,
|
||||||
|
"target": "ES2022",
|
||||||
|
"module": "NodeNext",
|
||||||
|
"moduleResolution": "NodeNext",
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"verbatimModuleSyntax": true
|
||||||
|
},
|
||||||
|
"exclude": [
|
||||||
|
"dist_*/**/*.d.ts"
|
||||||
|
]
|
||||||
|
}
|
17
tslint.json
17
tslint.json
@ -1,17 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
|
||||||
"rules": {
|
|
||||||
"semicolon": [true, "always"],
|
|
||||||
"no-console": false,
|
|
||||||
"ordered-imports": false,
|
|
||||||
"object-literal-sort-keys": false,
|
|
||||||
"member-ordering": {
|
|
||||||
"options":{
|
|
||||||
"order": [
|
|
||||||
"static-method"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"defaultSeverity": "warning"
|
|
||||||
}
|
|
Reference in New Issue
Block a user