3.0.0

.gitignore

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

.gitlab-ci.yml

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

.vscode/launch.json

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

.vscode/settings.json

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

README.md

@@ -1,37 +0,0 @@
-# smartstream
-simplifies access to node streams, TypeScript ready!
-
-## Availabililty
-[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartstream)
-[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartstream)
-[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartstream)
-[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartstream/gitbook)
-
-## Status for master
-[![build status](https://gitlab.com/pushrocks/smartstream/badges/master/build.svg)](https://gitlab.com/pushrocks/smartstream/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartstream/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartstream/commits/master)
-[![Dependency Status](https://david-dm.org/pushrocks/smartstream.svg)](https://david-dm.org/pushrocks/smartstream)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartstream/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartstream/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartstream/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartstream)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
-
-## 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 */})
-```
-

dist/index.d.ts

@@ -1,42 +0,0 @@
-/// <reference types="q" />
-import * as plugins from './smartstream.plugins';
-export interface IErrorFunction {
-    (err: any): any;
-}
-export interface ICustomEventFunction {
-    (): any;
-}
-export interface ICustomEventObject {
-    eventName: string;
-    eventFunction: ICustomEventFunction;
-}
-/**
- * class Smartstream handles
- */
-export declare class Smartstream {
-    private streamArray;
-    private errorFunction;
-    private customEventObjectArray;
-    private streamStartedDeferred;
-    /**
-     * constructor
-     */
-    constructor(streamArrayArg: any[]);
-    /**
-     * attach an error handler to the stream to prevent throwing
-     */
-    onError(errorFunctionArg: IErrorFunction): void;
-    /**
-     * make something with the stream itself
-     */
-    streamStarted(): plugins.q.Promise<any>;
-    /**
-     * attach listener to custom event
-     */
-    onCustomEvent(eventNameArg: string, eventFunctionArg: ICustomEventFunction): void;
-    /**
-     * run the stream
-     * @returns Promise
-     */
-    run(): plugins.q.Promise<void>;
-}

dist/index.js

@@ -1,81 +0,0 @@
-"use strict";
-const plugins = require("./smartstream.plugins");
-/**
- * class Smartstream handles
- */
-class Smartstream {
-    /**
-     * constructor
-     */
-    constructor(streamArrayArg) {
-        this.streamArray = [];
-        this.errorFunction = null;
-        this.customEventObjectArray = [];
-        this.streamStartedDeferred = plugins.q.defer();
-        this.streamArray = streamArrayArg;
-    }
-    /**
-     * attach an error handler to the stream to prevent throwing
-     */
-    onError(errorFunctionArg) {
-        this.errorFunction = errorFunctionArg;
-    }
-    /**
-     * make something with the stream itself
-     */
-    streamStarted() {
-        return this.streamStartedDeferred.promise;
-    }
-    /**
-     * attach listener to custom event
-     */
-    onCustomEvent(eventNameArg, eventFunctionArg) {
-        this.customEventObjectArray.push({
-            eventName: eventNameArg,
-            eventFunction: eventFunctionArg
-        });
-    }
-    /**
-     * run the stream
-     * @returns Promise
-     */
-    run() {
-        let done = plugins.q.defer();
-        // clone Array
-        let streamExecutionArray = [];
-        for (let streamItem of this.streamArray) {
-            streamExecutionArray.push(streamItem);
-        }
-        // combine the stream
-        let finalStream = null;
-        let firstIteration = true;
-        for (let stream of streamExecutionArray) {
-            if (firstIteration === true) {
-                finalStream = stream;
-            }
-            if (this.errorFunction !== null) {
-                stream.on('error', this.errorFunction);
-            }
-            for (let customEventObject of this.customEventObjectArray) {
-                stream.on(customEventObject.eventName, customEventObject.eventFunction);
-            }
-            if (!firstIteration) {
-                finalStream = finalStream.pipe(stream);
-            }
-            firstIteration = false;
-        }
-        this.streamStartedDeferred.resolve();
-        finalStream.on('end', function () {
-            done.resolve();
-        });
-        finalStream.on('close', function () {
-            done.resolve();
-        });
-        finalStream.on('finish', function () {
-            done.resolve();
-        });
-        return done.promise;
-    }
-}
-exports.Smartstream = Smartstream;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsaURBQWdEO0FBZWhEOztHQUVHO0FBQ0g7SUFNSTs7T0FFRztJQUNILFlBQVksY0FBcUI7UUFSekIsZ0JBQVcsR0FBRyxFQUFFLENBQUE7UUFDaEIsa0JBQWEsR0FBbUIsSUFBSSxDQUFBO1FBQ3BDLDJCQUFzQixHQUF5QixFQUFFLENBQUE7UUFDakQsMEJBQXFCLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtRQU03QyxJQUFJLENBQUMsV0FBVyxHQUFHLGNBQWMsQ0FBQTtJQUNyQyxDQUFDO0lBRUQ7O09BRUc7SUFDSCxPQUFPLENBQUMsZ0JBQWdDO1FBQ3BDLElBQUksQ0FBQyxhQUFhLEdBQUcsZ0JBQWdCLENBQUE7SUFDekMsQ0FBQztJQUVEOztPQUVHO0lBQ0gsYUFBYTtRQUNULE1BQU0sQ0FBQyxJQUFJLENBQUMscUJBQXFCLENBQUMsT0FBTyxDQUFBO0lBQzdDLENBQUM7SUFFRDs7T0FFRztJQUNILGFBQWEsQ0FBQyxZQUFvQixFQUFFLGdCQUFzQztRQUN0RSxJQUFJLENBQUMsc0JBQXNCLENBQUMsSUFBSSxDQUFDO1lBQzdCLFNBQVMsRUFBRSxZQUFZO1lBQ3ZCLGFBQWEsRUFBRSxnQkFBZ0I7U0FDbEMsQ0FBQyxDQUFBO0lBQ04sQ0FBQztJQUVEOzs7T0FHRztJQUNILEdBQUc7UUFDQyxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBUSxDQUFBO1FBRWxDLGNBQWM7UUFDZCxJQUFJLG9CQUFvQixHQUFHLEVBQUUsQ0FBQTtRQUM3QixHQUFHLENBQUMsQ0FBQyxJQUFJLFVBQVUsSUFBSSxJQUFJLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQztZQUFDLG9CQUFvQixDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQTtRQUFDLENBQUM7UUFFbEYscUJBQXFCO1FBQ3JCLElBQUksV0FBVyxHQUFHLElBQUksQ0FBQTtRQUN0QixJQUFJLGNBQWMsR0FBWSxJQUFJLENBQUE7UUFDbEMsR0FBRyxDQUFDLENBQUMsSUFBSSxNQUFNLElBQUksb0JBQW9CLENBQUMsQ0FBQyxDQUFDO1lBQ3RDLEVBQUUsQ0FBQyxDQUFDLGNBQWMsS0FBSyxJQUFJLENBQUMsQ0FBQyxDQUFDO2dCQUMxQixXQUFXLEdBQUcsTUFBTSxDQUFBO1lBQ3hCLENBQUM7WUFDRCxFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsYUFBYSxLQUFLLElBQUksQ0FBQyxDQUFDLENBQUM7Z0JBQzlCLE1BQU0sQ0FBQyxFQUFFLENBQUMsT0FBTyxFQUFFLElBQUksQ0FBQyxhQUFhLENBQUMsQ0FBQTtZQUMxQyxDQUFDO1lBQ0QsR0FBRyxDQUFDLENBQUMsSUFBSSxpQkFBaUIsSUFBSSxJQUFJLENBQUMsc0JBQXNCLENBQUMsQ0FBQyxDQUFDO2dCQUN4RCxNQUFNLENBQUMsRUFBRSxDQUFDLGlCQUFpQixDQUFDLFNBQVMsRUFBRSxpQkFBaUIsQ0FBQyxhQUFhLENBQUMsQ0FBQTtZQUMzRSxDQUFDO1lBQ0QsRUFBRSxDQUFDLENBQUMsQ0FBQyxjQUFjLENBQUMsQ0FBQyxDQUFDO2dCQUNsQixXQUFXLEdBQUcsV0FBVyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQTtZQUMxQyxDQUFDO1lBQ0QsY0FBYyxHQUFHLEtBQUssQ0FBQTtRQUMxQixDQUFDO1FBRUQsSUFBSSxDQUFDLHFCQUFxQixDQUFDLE9BQU8sRUFBRSxDQUFBO1FBRXBDLFdBQVcsQ0FBQyxFQUFFLENBQUMsS0FBSyxFQUFDO1lBQ2pCLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQTtRQUNsQixDQUFDLENBQUMsQ0FBQTtRQUNGLFdBQVcsQ0FBQyxFQUFFLENBQUMsT0FBTyxFQUFDO1lBQ25CLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQTtRQUNsQixDQUFDLENBQUMsQ0FBQTtRQUNGLFdBQVcsQ0FBQyxFQUFFLENBQUMsUUFBUSxFQUFDO1lBQ3BCLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQTtRQUNsQixDQUFDLENBQUMsQ0FBQTtRQUNGLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFBO0lBQ3ZCLENBQUM7Q0FDSjtBQWhGRCxrQ0FnRkMifQ==

dist/smartstream.plugins.d.ts

@@ -1,2 +0,0 @@
-import 'typings-global';
-export import q = require('q');

dist/smartstream.plugins.js

@@ -1,4 +0,0 @@
-"use strict";
-require("typings-global");
-exports.q = require("q");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRzdHJlYW0ucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0c3RyZWFtLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF1QjtBQUN2Qix5QkFBOEIifQ==

npmextra.json

@@ -1 +1,17 @@
-{}
+{
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "push.rocks",
+      "gitrepo": "smartstream",
+      "description": "simplifies access to node streams",
+      "npmPackagename": "@push.rocks/smartstream",
+      "license": "MIT"
+    }
+  }
+}

package.json

@@ -1,11 +1,14 @@
 {
-  "name": "smartstream",
-  "version": "1.0.4",
-  "description": "simplifies access to node streams, TypeScript ready!",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "name": "@push.rocks/smartstream",
+  "version": "3.0.0",
+  "private": false,
+  "description": "simplifies access to node streams",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -18,14 +21,33 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartstream#README",
   "devDependencies": {
-    "@types/should": "^8.1.30",
-    "npmts-g": "^5.2.8",
-    "should": "^11.1.0",
-    "typings-test": "^1.0.3"
+    "@git.zone/tsbuild": "^2.1.66",
+    "@git.zone/tsrun": "^1.2.44",
+    "@git.zone/tstest": "^1.0.77",
+    "@push.rocks/smartfile": "^10.0.33",
+    "@push.rocks/tapbundle": "^5.0.15"
   },
   "dependencies": {
-    "@types/q": "0.x.x",
-    "q": "^1.4.1",
-    "typings-global": "^1.0.14"
-  }
+    "@push.rocks/smartpromise": "^4.0.3",
+    "@push.rocks/smartrx": "^3.0.7",
+    "@types/from2": "^2.3.4",
+    "@types/through2": "^2.0.40",
+    "from2": "^2.3.0",
+    "through2": "^4.0.2"
+  },
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -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 | [![pipeline status](https://gitlab.com/pushrocks/smartstream/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartstream/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartstream)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartstream)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartstream)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartstream)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartstream)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](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)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/assets/writabletext.txt

@@ -0,0 +1,51 @@
+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
+noice

test/test.d.ts

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

test/test.js

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

test/test.smartstream.ts

@@ -0,0 +1,44 @@
+import { expect, tap } from '@push.rocks/tapbundle';
+import { SmartStream } from '../ts/smartstream.classes.smartstream.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 = SmartStream.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 = SmartStream.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();

test/test.streamfunction.ts

@@ -0,0 +1,66 @@
+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 testSmartstream = new smartstream.StreamWrapper([
+    smartfile.fsStream.createReadStream('./test/assets/readabletext.txt'),
+    smartstream.createDuplexStream<Buffer, Buffer>(
+      async (chunkStringArg: Buffer, streamTools) => {
+        // do something with the stream here
+        const result = chunkStringArg.toString().substr(0, 100);
+        streamTools.pipeMore('wow =========== \n');
+        return Buffer.from(result);
+      },
+      async (tools) => {
+        // tools.pipeMore('hey, this is the end')
+        return Buffer.from('this is the end');
+      },
+      { objectMode: false }
+    ),
+    smartstream.createDuplexStream<Buffer, string>(async (chunkStringArg) => {
+      console.log(chunkStringArg.toString());
+      return null;
+    }),
+    smartstream.cleanPipe(),
+  ]);
+  await testSmartstream.run();
+});
+
+tap.test('should create a valid Intake', async (tools) => {
+  testIntake = new smartstream.StreamIntake<string>();
+  testIntake.pipe(
+      smartstream.createDuplexStream<string, string>(
+        async (chunkString) => {
+          await tools.delayFor(100);
+          console.log(chunkString);
+          return chunkString;
+        },
+        async () => {
+          return 'noice';
+        }
+      )
+    )
+    .pipe(smartfile.fsStream.createWriteStream('./test/assets/writabletext.txt'));
+  const testFinished = tools.defer();
+  let counter = 0;
+  testIntake.pushNextObservable.subscribe(() => {
+    if (counter < 50) {
+      counter++;
+      testIntake.pushData('hi');
+      testIntake.pushData('+wow');
+      testIntake.pushData('\n');
+    } else {
+      testIntake.signalEnd();
+      testFinished.resolve();
+    }
+  });
+  await testFinished.promise;
+  testIntake.signalEnd();
+});
+
+tap.start();

test/test.ts

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

ts/00_commitinfo_data.ts

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

ts/index.ts

@@ -1,99 +1,5 @@
-import * as plugins from './smartstream.plugins'
-
-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 errorFunction: IErrorFunction = null
-    private customEventObjectArray: ICustomEventObject[] = []
-    private streamStartedDeferred = plugins.q.defer()
-
-    /**
-     * constructor
-     */
-    constructor(streamArrayArg: any[]) {
-        this.streamArray = streamArrayArg
-    }
-
-    /**
-     * attach an error handler to the stream to prevent throwing
-     */
-    onError(errorFunctionArg: IErrorFunction) {
-        this.errorFunction = errorFunctionArg
-    }
-
-    /**
-     * make something with the stream itself
-     */
-    streamStarted(): plugins.q.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(): plugins.q.Promise<void> {
-        let done = plugins.q.defer<void>()
-
-        // clone Array
-        let streamExecutionArray = []
-        for (let streamItem of this.streamArray) { streamExecutionArray.push(streamItem) }
-
-        // combine the stream
-        let finalStream = null
-        let firstIteration: boolean = true
-        for (let stream of streamExecutionArray) {
-            if (firstIteration === true) {
-                finalStream = stream
-            }
-            if (this.errorFunction !== null) {
-                stream.on('error', this.errorFunction)
-            }
-            for (let customEventObject of this.customEventObjectArray) {
-                stream.on(customEventObject.eventName, customEventObject.eventFunction)
-            }
-            if (!firstIteration) {
-                finalStream = finalStream.pipe(stream)
-            }
-            firstIteration = false
-        }
-    
-        this.streamStartedDeferred.resolve()
-
-        finalStream.on('end',function(){
-            done.resolve()
-        })
-        finalStream.on('close',function(){
-            done.resolve()
-        })
-        finalStream.on('finish',function(){
-            done.resolve()
-        })
-        return done.promise
-    }
-}
+export * from './smartstream.classes.passthrough.js';
+export * from './smartstream.classes.smartstream.js';
+export * from './smartstream.classes.streamwrapper.js';
+export * from './smartstream.classes.streamintake.js';
+export * from './smartstream.duplex.js';

ts/smartstream.classes.passthrough.ts

@@ -0,0 +1,19 @@
+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);
+    }
+  }
+}

ts/smartstream.classes.smartstream.ts

@@ -0,0 +1,112 @@
+import * as plugins from './smartstream.plugins.js';
+import { Duplex, type DuplexOptions } from 'stream';
+export interface SmartStreamOptions<TInput, TOutput> extends DuplexOptions {
+  // You can add more custom options relevant to TInput and TOutput if necessary
+}
+
+export class SmartStream<TInput = any, TOutput = any> extends Duplex {
+  private observableSubscription?: plugins.smartrx.rxjs.Subscription;
+  private asyncChunkModifier?: (chunk: TInput) => Promise<TOutput>;
+
+  constructor(options?: SmartStreamOptions<TInput, TOutput>, asyncChunkModifierArg?: (chunk: TInput) => Promise<TOutput>) {
+    super(options);
+    this.asyncChunkModifier = asyncChunkModifierArg;
+  }
+
+  // Ensure the _write method types the chunk as TInput and encodes TOutput
+  public async _write(chunk: TInput, encoding: string, callback: (error?: Error | null) => void) {
+    try {
+      if (this.asyncChunkModifier) {
+        const modifiedChunk = await this.asyncChunkModifier(chunk);
+        if (!this.push(modifiedChunk)) {
+          // Handle backpressure here if necessary
+        }
+      } else {
+        if (!this.push(chunk as unknown as TOutput)) {
+          // Handle backpressure here if necessary
+        }
+      }
+      callback();
+    } catch (err) {
+      callback(err);
+    }
+  }
+
+  static fromBuffer(buffer: Buffer, options?: DuplexOptions): SmartStream {
+    const smartStream = new SmartStream(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): SmartStream {
+    const smartStream = new SmartStream(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): SmartStream {
+    const smartStream = new SmartStream(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;
+  }
+}

ts/smartstream.classes.streamintake.ts

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

ts/smartstream.classes.streamwrapper.ts

@@ -0,0 +1,107 @@
+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;
+  }
+}
+
+export let cleanPipe = () => {
+  return plugins.through2.obj(
+    (file, enc, cb) => {
+      cb();
+    },
+    (cb) => {
+      cb();
+    }
+  );
+};

ts/smartstream.duplex.ts

@@ -0,0 +1,83 @@
+import * as plugins from './smartstream.plugins.js';
+
+export interface ITruncateFunc {
+  (): void;
+}
+
+export interface IPipeMoreFunc {
+  (pipeObject: any): void;
+}
+
+export interface IStreamTools {
+  truncate: ITruncateFunc;
+  pipeMore: IPipeMoreFunc;
+}
+
+export interface IStreamFunction<T, rT> {
+  (chunkArg: T, toolsArg: IStreamTools): Promise<rT>;
+}
+
+export interface IStreamEndFunction<rT> {
+  (toolsArg: IStreamTools): Promise<rT>;
+}
+
+export interface IStreamOptions {
+  objectMode?: boolean;
+  readableObjectMode?: boolean;
+  writableObjectMode?: boolean;
+}
+
+export let createDuplexStream = <T, rT>(
+  funcArg: IStreamFunction<T, rT>,
+  endFuncArg?: IStreamEndFunction<rT>,
+  optionsArg: IStreamOptions = {
+    objectMode: false,
+    readableObjectMode: true,
+    writableObjectMode: true,
+  }
+) => {
+  return plugins.through2(
+    optionsArg,
+    function (chunk, enc, cb) {
+      let truncated = false;
+      const tools: IStreamTools = {
+        truncate: () => {
+          truncated = true;
+          cb(null, null);
+        },
+        pipeMore: (pipeObject) => {
+          this.push(pipeObject);
+        },
+      };
+      const asyncWrapper = async () => {
+        const resultChunk: rT = await funcArg(chunk, tools);
+        if (!truncated) {
+          cb(null, resultChunk);
+        }
+      };
+      asyncWrapper().catch((err) => {
+        console.log(err);
+      });
+    },
+    function (cb) {
+      const tools: IStreamTools = {
+        truncate: () => {
+          cb();
+        },
+        pipeMore: (pushArg) => {
+          this.push(pushArg);
+        },
+      };
+      const asyncWrapper = async () => {
+        if (endFuncArg) {
+          const result = await endFuncArg(tools);
+          this.push(result);
+        }
+        cb();
+      };
+      asyncWrapper().catch((err) => {
+        console.log(err);
+      });
+    }
+  );
+};

ts/smartstream.plugins.ts

@@ -1,2 +1,16 @@
-import 'typings-global'
-export import q = require('q')
+// node native
+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 };
+
+// thirdparty
+import from2 from 'from2';
+import through2 from 'through2';
+
+export { from2, through2 };

tsconfig.json

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

tslint.json

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