3.0.8

.gitignore

@@ -1,5 +1,22 @@
-coverage/
-pages/
-node_modules/
-public/
+.nogit/
 
+# artifacts
+coverage/
+public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,5 +1,5 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
@@ -26,6 +26,7 @@ mirror:
 snyk:
   stage: security
   script:
+    - npmci npm prepare
     - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
@@ -36,38 +37,29 @@ snyk:
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
-testLTS:
-  stage: test
-  script:
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+testStable:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - priv
+
+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
   - notpriv
 
 release:
@@ -86,19 +78,11 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - 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]
+    - npmci command npm install -g tslint typescript
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
   - docker
   - priv
@@ -114,11 +98,15 @@ trigger:
   - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:stable-dind
   stage: metadata
   script:
-    - npmci command npm install -g npmpage
-    - npmci command npmpage
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
   tags:
     - docker
     - notpriv
@@ -129,13 +117,3 @@ pages:
     paths:
     - public
   allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
-  allow_failure: true

README.md

@@ -1,25 +1,23 @@
-# smartpromise
+# @pushrocks/smartpromise
 
-dropin replacement for q
+simple promises and Deferred constructs
 
-## Availabililty
+## Availabililty and Links
 
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartq)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartq)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartq)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartq/)
+- [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartpromise)
+- [gitlab.com (source)](https://gitlab.com/pushrocks/smartpromise)
+- [github.com (source mirror)](https://github.com/pushrocks/smartpromise)
+- [docs (typedoc)](https://pushrocks.gitlab.io/smartpromise/)
 
 ## Status for master
 
-[![build status](https://GitLab.com/pushrocks/smartq/badges/master/build.svg)](https://GitLab.com/pushrocks/smartq/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/smartq/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartq/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartq.svg)](https://www.npmjs.com/package/smartq)
-[![Dependency Status](https://david-dm.org/pushrocks/smartq.svg)](https://david-dm.org/pushrocks/smartq)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartq/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartq/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartq/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartq)
-[![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->=%208.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/)
+[![build status](https://gitlab.com/pushrocks/smartpromise/badges/master/build.svg)](https://gitlab.com/pushrocks/smartpromise/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartpromise/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartpromise/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartpromise.svg)](https://www.npmjs.com/package/@pushrocks/smartpromise)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartpromise/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartpromise)
+[![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-prettier-ff69b4.svg)](https://prettier.io/)
 
 ## Usage
 
@@ -28,17 +26,24 @@ Use TypeScript for best in class instellisense.
 > Note: smartq uses native ES6 promises
 > smartq does not repeat any native functions, so for things like .all() simply use Promise.all()
 
-```javascript
-import * as q from 'smartq'
+```typescript
+import * as q from '@pushrocks/smartpromise'
 
 // Deferred
 // -----------------------------------------------
 let myAsyncFunction = (): Promise<string> => {
-    let done = q.defer<string>() // returns your typical Deferred object
-    setTimeout(() => {
-        done.resolve('hi') // will throw type error for other types than string as argument ;)
-    },6000)
-    return done.promise
+  let done = q.defer<string>() // returns your typical Deferred object
+  setTimeout(() => {
+      done.resolve('hi') // will throw type error for other types than string as argument ;)
+  },6000);
+
+  console.log(done.status) // logs "pending";
+  done.promise.then(() => {
+    console.log(done.status) // logs "fullfilled"
+    console.log(done.duration) // logs the milliseconds between instantiation and fullfillment
+  })
+
+  return done.promise
 }
 
 let myAsyncFunction2 = async () => {
@@ -77,8 +82,9 @@ myPromisedFunction('helloThere', 2).then(x => {
 })
 ```
 
-For further information read the linked docs at the top of this README.
+For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
+> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

npmextra.json

@@ -1,8 +1,17 @@
 {
   "npmci": {
-    "npmGlobalTools": [
-      "npmts"
-    ],
+    "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartpromise",
+      "shortDescription": "simple promises and Deferred constructs",
+      "npmPackagename": "@pushrocks/smartpromise",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pushrocks/smartpromise",
   "private": false,
-  "version": "2.0.3",
-  "description": "dropin replacement for q",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "version": "3.0.8",
+  "description": "simple promises and Deferred constructs",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(tsrun test/test.ts)",
-    "build": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -21,8 +21,22 @@
   "homepage": "https://gitlab.com/pushrocks/smartq#README",
   "dependencies": {},
   "devDependencies": {
-    "@gitzone/tsrun": "^1.0.18",
-    "@types/node": "^10.5.1",
-    "tapbundle": "^2.0.0"
-  }
+    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tstest": "^1.0.52",
+    "@pushrocks/tapbundle": "^3.2.9",
+    "@types/node": "^14.11.8",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "dist_ts_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

test/test.ts

@@ -1,35 +1,29 @@
-import { expect, tap } from 'tapbundle';
-import * as q from '../ts/index';
-
-let myCallback = (someValue1: string, cb?) => {
-  cb(null, someValue1);
-};
+import { expect, tap } from '@pushrocks/tapbundle';
+import * as smartpromise from '../ts/index';
 
 tap.test('should return a Deferred for .defer()', async () => {
-  let myDeferred = q.defer();
-  let expectPromise = expect(myDeferred.promise).to.eventually.be.fulfilled;
+  const myDeferred = smartpromise.defer();
+  const expectPromise = expect(myDeferred.promise).to.eventually.be.fulfilled;
   myDeferred.resolve();
   return expectPromise;
 });
 
 tap.test('should let types flow through the Promise', async () => {
-  let myString = 'someString';
-  let myDeferred = q.defer<string>();
-  let expectPromise = expect(myDeferred.promise).to.eventually.equal('someString');
+  const myString = 'someString';
+  const myDeferred = smartpromise.defer<string>();
+  const expectPromise = expect(myDeferred.promise).to.eventually.equal('someString');
   myDeferred.resolve(myString);
   return expectPromise;
 });
 
-tap.test('should promisify a callback', async () => {
-  let myPromisified = q.promisify(myCallback);
-  let expectPromise = expect(myPromisified('hi')).to.eventually.equal('hi');
-  return await expectPromise;
-});
-
 tap.test('should map callbacks', async () => {
-  let inputArray = ['hi', 'awesome'];
-  let myPromisified = q.promisify(myCallback);
-  let expectPromise = expect(q.map(inputArray, myPromisified)).to.eventually.deep.equal(inputArray);
+  const inputArray = ['hi', 'awesome'];
+  const myPromisified = async myInput => {
+    return myInput;
+  };
+  const expectPromise = expect(smartpromise.map(inputArray, myPromisified)).to.eventually.deep.equal(
+    inputArray
+  );
   return expectPromise;
 });
 

ts/index.ts

@@ -1,7 +1,5 @@
-import * as util from 'util';
-
 export interface IResolve<T> {
-  (value?: T | Promise<T>): void;
+  (value?: T | PromiseLike<T>): void;
 }
 
 export interface IReject {
@@ -11,50 +9,86 @@ export interface IReject {
 export type TDeferredStatus = 'pending' | 'fulfilled' | 'rejected';
 
 export class Deferred<T> {
-  promise: Promise<T>;
-  resolve: IResolve<T>;
-  reject: IReject;
-  status: TDeferredStatus;
+  public promise: Promise<T>;
+  public resolve: IResolve<T>;
+  public reject: IReject;
+  public status: TDeferredStatus;
+
+  public startedAt: number;
+  public stoppedAt: number;
+  public get duration(): number {
+    if (this.stoppedAt) {
+      return this.stoppedAt - this.startedAt;
+    } else {
+      return Date.now() - this.startedAt;
+    }
+  }
+
   constructor() {
     this.promise = new Promise<T>((resolve, reject) => {
-      this.resolve = resolve;
-      this.reject = reject;
+      this.resolve = (valueArg: T | PromiseLike<T>) => {
+        this.status = 'fulfilled';
+        this.stoppedAt = Date.now();
+        resolve(valueArg);
+      };
+      this.reject = (reason: any) => {
+        this.status = 'rejected';
+        this.stoppedAt = Date.now();
+        reject(reason);
+      };
+      this.startedAt = Date.now();
       this.status = 'pending';
     });
   }
 }
 
-export let defer = <T>() => {
+export const defer = <T>() => {
   return new Deferred<T>();
 };
 
 /**
  * Creates a new resolved promise for the provided value.
  */
-export let resolvedPromise = <T>(value?: T): Promise<T> => {
+export const resolvedPromise = <T>(value?: T): Promise<T> => {
   return Promise.resolve(value);
 };
 
 /**
  * Creates a new rejected promise for the provided reason.
  */
-export let rejectedPromise = err => {
+export const rejectedPromise = (err) => {
   return Promise.reject(err);
 };
 
-export let promisify = util.promisify;
+interface IAsyncFunction<T> {
+  (someArg: T): Promise<T>;
+}
 
-export let map = async <T>(inputArg: T[], functionArg) => {
-  let promisifedFunction = promisify(functionArg);
-  let promiseArray: Promise<any>[] = [];
-  let resultArray = [];
-  for (let item of inputArg) {
-    let promise: Promise<any> = promisifedFunction(item);
+/**
+ * accepts an array of inputs and a function that accepts the input.
+ * runs all items with the function and returns the result array when all items have run
+ * @param inputArg
+ * @param functionArg
+ */
+export const map = async <T>(inputArg: T[], functionArg: IAsyncFunction<T>) => {
+  const promiseArray: Promise<any>[] = [];
+  const resultArray = [];
+  for (const item of inputArg) {
+    const promise: Promise<any> = functionArg(item);
     promiseArray.push(promise);
-    promise.then(x => {
+    promise.then((x) => {
       resultArray.push(x);
     });
   }
   await Promise.all(promiseArray);
   return resultArray;
 };
+
+export const timeoutWrap = (ms, promise) => {
+  return new Promise((resolve, reject) => {
+    setTimeout(() => {
+      reject(new Error('timeout'));
+    }, ms);
+    promise.then(resolve, reject);
+  });
+};

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"
 }