1.0.14

.gitlab-ci.yml

@@ -1,42 +1,150 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone standard
+image: hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+  - .npmci_cache/
+  key: "$CI_BUILD_STAGE"
+
 stages:
+- security
 - test
 - release
-- page
-testLEGACY:
-  stage: test
+- metadata
+
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
   script:
-    - npmci test legacy
+  - npmci git mirror
   tags:
   - docker
+  - notpriv
+
+snyk:
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install -g snyk
+    - npmci command npm install --ignore-scripts
+    - npmci command snyk test
+  tags:
+  - docker
+  - notpriv
+
+sast:
+  stage: security
+  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
+  variables:
+    DOCKER_DRIVER: overlay2
+  allow_failure: true
+  services:
+    - docker:stable-dind
+  script:
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command npm run build
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - 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:
+  - docker
+  - priv
+
+# ====================
+# test stage
+# ====================
+
 testLTS:
   stage: test
   script:
-    - npmci test lts
+  - npmci npm prepare
+  - npmci node install lts
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - notpriv
+    
 testSTABLE:
   stage: test
   script:
-    - npmci test stable
+  - npmci npm prepare
+  - npmci node install stable
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - notpriv
+
 release:
   stage: release
   script:
-    - npmci publish
+  - npmci node install stable
+  - npmci npm publish
   only:
   - tags
   tags:
   - docker
-pages:
-  image: hosttoday/ht-docker-node:npmpage
-  stage: page
+  - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  image: docker:stable
+  allow_failure: true
+  services:
+    - docker:stable-dind
   script:
-    - npmci command npmpage --host gitlab
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - docker run
+        --env SOURCE_CODE="$PWD"
+        --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:
+  - docker
+  - priv
+
+trigger:
+  stage: metadata
+  script:
+  - npmci trigger
+  only:
+  - tags
+  tags:
+  - docker
+  - notpriv
+
+pages:
+  image: hosttoday/ht-docker-node:npmci
+  stage: metadata
+  script:
+    - npmci command npm install -g typedoc typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+  tags:
+    - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     paths:
     - public
+  allow_failure: true

README.md

@@ -1,9 +1,43 @@
-# smartstream
-simplifies access to node streams, TypeScript ready!
+# @pushrocks/smartstream
+simplifies access to node streams
 
-## Status
+## 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
 [![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)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartstream.svg)](https://www.npmjs.com/package/@pushrocks/smartstream)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartstream/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartstream)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.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.
 
+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)
+
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

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==

npmextra.json

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

package.json

@@ -1,11 +1,13 @@
 {
-  "name": "smartstream",
-  "version": "1.0.2",
-  "description": "simplifies access to node streams, TypeScript ready!",
+  "name": "@pushrocks/smartstream",
+  "version": "1.0.14",
+  "private": false,
+  "description": "simplifies access to node streams",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -18,15 +20,15 @@
   },
   "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"
+    "@gitzone/tsbuild": "^2.1.8",
+    "@gitzone/tstest": "^1.0.18",
+    "@pushrocks/tapbundle": "^3.0.7",
+    "tslint": "^5.12.1",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@types/q": "0.x.x",
-    "q": "^1.4.1",
-    "stream-combiner2": "^1.1.1",
-    "typings-global": "^1.0.14"
+    "@pushrocks/smartpromise": "^2.0.5",
+    "@types/through2": "^2.0.34",
+    "through2": "^3.0.0"
   }
 }

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 = require('fs')
-import * as should from 'should'
+import fs = require('fs');
+import { expect, tap } from '@pushrocks/tapbundle';
 
-import * as smartstream from '../dist/index'
+import * as smartstream from '../ts/index';
 
-let testSmartstream: smartstream.Smartstream
-
-describe('smartstream', function() {
-    it('should combine a stream', function(){
+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')
-        ])
-        testSmartstream.run()
-    })
-})
+  ]);
+  await testSmartstream.run();
+});
+
+tap.start();

ts/index.ts

@@ -1,23 +1,107 @@
-import * as plugins from './smartstream.plugins'
+import * as plugins from './smartstream.plugins';
+
+// interfaces
+import { Transform } from 'stream';
 
 export interface IErrorFunction {
-    (err): number
+  (err): any;
 }
 
+export interface ICustomEventFunction {
+  (): any;
+}
+
+export interface ICustomEventObject {
+  eventName: string;
+  eventFunction: ICustomEventFunction;
+}
+
+/**
+ * class Smartstream handles
+ */
 export class Smartstream {
-    streamArray = []
-    errorFunction: IErrorFunction = null
-    constructor(streamArrayArg: any[]){
-        this.streamArray = streamArrayArg
+  private streamArray = [];
+  private customEventObjectArray: ICustomEventObject[] = [];
+  private streamStartedDeferred = plugins.smartpromise.defer();
+
+  /**
+   * constructor
+   */
+  constructor(streamArrayArg: any[]) {
+    this.streamArray = streamArrayArg;
   }
-    onError(errorFunctionArg: IErrorFunction) {
-        this.errorFunction = errorFunctionArg
+
+  /**
+   * make something with the stream itself
+   */
+  streamStarted(): Promise<any> {
+    return this.streamStartedDeferred.promise;
   }
-    run() {
-        let combinedStream = plugins.streamCombiner2.obj(this.streamArray)
-        if (this.errorFunction !== null) {
-            combinedStream.on('error', this.errorFunction)
+
+  /**
+   * attach listener to custom event
+   */
+  onCustomEvent(eventNameArg: string, eventFunctionArg: ICustomEventFunction) {
+    this.customEventObjectArray.push({
+      eventName: eventNameArg,
+      eventFunction: eventFunctionArg
+    });
   }
-        return combinedStream
+
+  /**
+   * 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();
+    }
+  );
+};

ts/smartstream.plugins.ts

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

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "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"
 }