2.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

@@ -0,0 +1,140 @@
+# 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 @gitzone/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

.vscode/launch.json

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

.vscode/settings.json

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

README.md

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

dist/index.d.ts

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

dist/index.js

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

dist/smartstream.plugins.d.ts

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

dist/smartstream.plugins.js

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

gitlab-ci.yml

@@ -1,42 +0,0 @@
-image: hosttoday/ht-docker-node:npmts
-stages:
-- test
-- release
-- page
-testLEGACY:
-  stage: test
-  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
-  only:
-    - tags
-  tags:
-    - docker
-pages:
-  image: hosttoday/ht-docker-node:npmpage
-  stage: page
-  script:
-    - npmci command npmpage --host gitlab
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-    - public

npmextra.json

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

package.json

@@ -1,11 +1,14 @@
 {
-  "name": "smartstream",
+  "name": "@pushrocks/smartstream",
-  "version": "1.0.1",
+  "version": "2.0.0",
-  "description": "simplifies access to node streams, TypeScript ready!",
+  "private": false,
-  "main": "dist/index.js",
+  "description": "simplifies access to node streams",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -18,15 +21,30 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartstream#README",
   "devDependencies": {
-    "@types/should": "^8.1.30",
+    "@gitzone/tsbuild": "^2.1.61",
-    "npmts-g": "^5.2.8",
+    "@gitzone/tstest": "^1.0.70",
-    "should": "^11.1.0",
+    "@pushrocks/tapbundle": "^5.0.3",
-    "typings-test": "^1.0.3"
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@types/q": "0.x.x",
+    "@pushrocks/smartpromise": "^3.1.7",
-    "q": "^1.4.1",
+    "@types/through2": "^2.0.36",
-    "stream-combiner2": "^1.1.1",
+    "through2": "^4.0.2"
-    "typings-global": "^1.0.14"
+  },
-  }
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

test/test.d.ts

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

test/test.js

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

test/test.ts

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

ts/index.ts

@@ -1,23 +1,107 @@
-import * as plugins from './smartstream.plugins'
+import * as plugins from './smartstream.plugins.js';
+
+// interfaces
+import { Transform } from 'stream';
 
 export interface IErrorFunction {
-    (err): number
+  (err: Error): any;
 }
 
+export interface ICustomEventFunction {
+  (): any;
+}
+
+export interface ICustomEventObject {
+  eventName: string;
+  eventFunction: ICustomEventFunction;
+}
+
+/**
+ * class Smartstream handles
+ */
 export class Smartstream {
-    streamArray = []
+  private streamArray: Array<plugins.stream.Duplex> = [];
-    errorFunction: IErrorFunction = null
+  private customEventObjectArray: ICustomEventObject[] = [];
-    constructor(streamArrayArg: any[]){
+  private streamStartedDeferred = plugins.smartpromise.defer();
-        this.streamArray = streamArrayArg
+
+  /**
+   * 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);
     }
-    onError(errorFunctionArg: IErrorFunction) {
+
-        this.errorFunction = errorFunctionArg
+    // 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;
     }
-    run() {
+
-        let combinedStream = plugins.streamCombiner2.obj(this.streamArray)
+    this.streamStartedDeferred.resolve();
-        if (this.errorFunction !== null) {
+
-            combinedStream.on('error', this.errorFunction)
+    finalStream.on('end', () => {
-        }
+      done.resolve();
-        return combinedStream
+    });
+    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.plugins.ts

@@ -1,3 +1,12 @@
-import 'typings-global'
+import * as stream from 'stream';
-export import q = require('q')
+
-export let streamCombiner2 = require('stream-combiner2')
+export { stream };
+
+// pushrocks scope
+import * as smartpromise from '@pushrocks/smartpromise';
+export { smartpromise };
+
+// thirdparty
+import * as through2 from 'through2';
+
+export { through2 };

tslint.json

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