3.0.7

.gitignore

@@ -1,5 +1,22 @@
-coverage/
+.nogit/
-pages/
-node_modules/
-public/
 
+# 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,59 +1,119 @@
-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:
+- security
 - test
 - release
-- trigger
+- metadata
-- pages
 
-testLEGACY:
+# ====================
-  stage: test
+# security stage
+# ====================
+mirror:
+  stage: security
   script:
-    - npmci test legacy
+  - npmci git mirror
   tags:
   - docker
-  allow_failure: true
+  - notpriv
 
-testLTS:
+snyk:
-  stage: test
+  stage: security
   script:
-    - npmci test lts
+    - npmci npm prepare
+    - npmci command npm install -g snyk
+    - npmci command npm install --ignore-scripts
+    - npmci command snyk test
   tags:
   - docker
+  - notpriv
 
-testSTABLE:
+# ====================
+# test stage
+# ====================
+
+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
+  - 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:
   stage: release
   script:
-    - npmci publish
+  - npmci node install stable
+  - npmci npm publish
   only:
   - tags
   tags:
   - docker
+  - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  script:
+    - npmci command npm install -g tslint typescript
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
+  tags:
+  - docker
+  - priv
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
   - npmci trigger
   only:
   - tags
   tags:
   - docker
+  - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmpage
+  image: hosttoday/ht-docker-dbase:npmci
-  stage: pages
+  services:
+   - docker:stable-dind
+  stage: metadata
   script:
-    - npmci command npmpage --host gitlab
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
+  tags:
+    - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     paths:
     - public
+  allow_failure: true

README.md

@@ -1,24 +1,90 @@
-# smartq
+# @pushrocks/smartpromise
-dropin replacement for q
 
-## Availabililty
+simple promises and Deferred constructs
-[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartq)
+
-[![git](https://push.rocks/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartq)
+## Availabililty and Links
-[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartq)
+
-[![docs](https://push.rocks/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)
+[![build status](https://gitlab.com/pushrocks/smartpromise/badges/master/build.svg)](https://gitlab.com/pushrocks/smartpromise/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartq.svg)](https://www.npmjs.com/package/smartq)
+[![coverage report](https://gitlab.com/pushrocks/smartpromise/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartpromise/commits/master)
-[![Dependency Status](https://david-dm.org/pushrocks/smartq.svg)](https://david-dm.org/pushrocks/smartq)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartpromise.svg)](https://www.npmjs.com/package/@pushrocks/smartpromise)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartq/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartq/master/dependencies/npm)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartpromise/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartpromise)
-[![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->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![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->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.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-prettier-ff69b4.svg)](https://prettier.io/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
 
 ## Usage
+
 Use TypeScript for best in class instellisense.
 
-[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)
+> Note: smartq uses native ES6 promises
+> smartq does not repeat any native functions, so for things like .all() simply use Promise.all()
+
+```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);
+
+  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 () => {
+    let aString = await myAsyncFunction()
+    console.log(aString) // will log 'hi' to console
+}
+
+myAsyncFunction2();
+
+
+// Resolved and Rejected promises
+// ------------------------------------------------
+q.resolvedPromise(`I'll get logged to console soon`)
+    .then(x => {
+        console.log(x)
+    })
+
+q.rejectedPromise(`what a lovely error message`)
+    .then(() => {
+        console.log('This never makes it to console')
+    }/*, alternatively put a reject function here */)
+    .catch(err => {
+        console.log(err)
+    })
+
+// Promisify (typed)
+// ------------------------------------------------
+
+let myCallbackedFunction = (someString: string, someNumber: number, cb) => {
+    cb(null, someString)
+}
+
+let myPromisedFunction = q.promisify(myCallbackFunction)
+myPromisedFunction('helloThere', 2).then(x => {
+    console.log(x) // will log 'helloThere' to console
+})
+```
+
+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://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

dist/index.d.ts

@@ -1,15 +0,0 @@
-import 'typings-global';
-export interface IResolve<T> {
-    (value?: T | Promise<T>): void;
-}
-export interface IReject {
-    (reason?: any): void;
-}
-export declare class Deferred<T> {
-    promise: Promise<T>;
-    resolve: IResolve<T>;
-    reject: IReject;
-    constructor();
-}
-export declare let defer: <T>() => Deferred<T>;
-export declare let all: () => void;

dist/index.js

@@ -1,17 +0,0 @@
-"use strict";
-require("typings-global");
-class Deferred {
-    constructor() {
-        this.promise = new Promise((resolve, reject) => {
-            this.resolve = resolve;
-            this.reject = reject;
-        });
-    }
-}
-exports.Deferred = Deferred;
-exports.defer = () => {
-    return new Deferred();
-};
-exports.all = () => {
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBVXZCO0lBSUk7UUFDSSxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksT0FBTyxDQUFJLENBQUMsT0FBTyxFQUFFLE1BQU07WUFDMUMsSUFBSSxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUE7WUFDdEIsSUFBSSxDQUFDLE1BQU0sR0FBRyxNQUFNLENBQUE7UUFDeEIsQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDO0NBQ0o7QUFWRCw0QkFVQztBQUVVLFFBQUEsS0FBSyxHQUFHO0lBQ2YsTUFBTSxDQUFDLElBQUksUUFBUSxFQUFLLENBQUE7QUFDNUIsQ0FBQyxDQUFBO0FBR1UsUUFBQSxHQUFHLEdBQUc7QUFFakIsQ0FBQyxDQUFBIn0=

npmextra.json

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

package.json

@@ -1,11 +1,13 @@
 {
-  "name": "smartq",
+  "name": "@pushrocks/smartpromise",
-  "version": "1.0.2",
+  "private": false,
-  "description": "dropin replacement for q",
+  "version": "3.0.7",
+  "description": "simple promises and Deferred constructs",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -17,12 +19,24 @@
     "url": "https://gitlab.com/pushrocks/smartq/issues"
   },
   "homepage": "https://gitlab.com/pushrocks/smartq#README",
-  "dependencies": {
+  "dependencies": {},
-    "typings-global": "^1.0.14"
-  },
   "devDependencies": {
-    "@types/should": "^8.1.30",
+    "@gitzone/tsbuild": "^2.1.17",
-    "should": "^11.1.2",
+    "@gitzone/tstest": "^1.0.24",
-    "typings-test": "^1.0.3"
+    "@pushrocks/tapbundle": "^3.0.13",
-  }
+    "@types/node": "^12.7.5",
+    "tslint": "^5.20.0",
+    "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.d.ts

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

test/test.js

@@ -1,23 +0,0 @@
-"use strict";
-require("typings-test");
-const should = require("should");
-const q = require("../dist/index");
-describe('smartq', function () {
-    it('should return a Deferred for .defer()', function (done) {
-        let myDeferred = q.defer();
-        myDeferred.promise.then(() => {
-            done();
-        });
-        myDeferred.resolve();
-    });
-    it('should let types flow through the Promise', function (done) {
-        let myString = 'someString';
-        let myDeferred = q.defer();
-        myDeferred.promise.then(x => {
-            should(x).equal('someString');
-            done();
-        });
-        myDeferred.resolve(myString);
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUVyQixpQ0FBZ0M7QUFDaEMsbUNBQWtDO0FBRWxDLFFBQVEsQ0FBQyxRQUFRLEVBQUU7SUFDZixFQUFFLENBQUMsdUNBQXVDLEVBQUUsVUFBUyxJQUFJO1FBQ3JELElBQUksVUFBVSxHQUFHLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtRQUMxQixVQUFVLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQztZQUNwQixJQUFJLEVBQUUsQ0FBQTtRQUNWLENBQUMsQ0FBQyxDQUFBO1FBQ0YsVUFBVSxDQUFDLE9BQU8sRUFBRSxDQUFBO0lBQ3hCLENBQUMsQ0FBQyxDQUFBO0lBRUYsRUFBRSxDQUFDLDJDQUEyQyxFQUFFLFVBQVMsSUFBSTtRQUN6RCxJQUFJLFFBQVEsR0FBRyxZQUFZLENBQUE7UUFDM0IsSUFBSSxVQUFVLEdBQUcsQ0FBQyxDQUFDLEtBQUssRUFBVSxDQUFBO1FBQ2xDLFVBQVUsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDckIsTUFBTSxDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxZQUFZLENBQUMsQ0FBQTtZQUM3QixJQUFJLEVBQUUsQ0FBQTtRQUNWLENBQUMsQ0FBQyxDQUFBO1FBQ0YsVUFBVSxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQTtJQUNoQyxDQUFDLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFBIn0=

test/test.ts

@@ -1,24 +1,30 @@
-import 'typings-test'
+import { expect, tap } from '@pushrocks/tapbundle';
+import * as smartpromise from '../ts/index';
 
-import * as should from 'should'
+tap.test('should return a Deferred for .defer()', async () => {
-import * as q from '../dist/index'
+  const myDeferred = smartpromise.defer();
+  const expectPromise = expect(myDeferred.promise).to.eventually.be.fulfilled;
+  myDeferred.resolve();
+  return expectPromise;
+});
 
-describe('smartq', function() {
+tap.test('should let types flow through the Promise', async () => {
-    it('should return a Deferred for .defer()', function(done) {
+  const myString = 'someString';
-        let myDeferred = q.defer()
+  const myDeferred = smartpromise.defer<string>();
-        myDeferred.promise.then(() => {
+  const expectPromise = expect(myDeferred.promise).to.eventually.equal('someString');
-            done()
+  myDeferred.resolve(myString);
-        })
+  return expectPromise;
-        myDeferred.resolve()
+});
-    })
 
-    it('should let types flow through the Promise', function(done) {
+tap.test('should map callbacks', async () => {
-        let myString = 'someString'
+  const inputArray = ['hi', 'awesome'];
-        let myDeferred = q.defer<string>()
+  const myPromisified = async myInput => {
-        myDeferred.promise.then(x => {
+    return myInput;
-            should(x).equal('someString')
+  };
-            done()
+  const expectPromise = expect(smartpromise.map(inputArray, myPromisified)).to.eventually.deep.equal(
-        })
+    inputArray
-        myDeferred.resolve(myString)
+  );
-    })
+  return expectPromise;
-})
+});
+
+tap.start();

ts/index.ts

@@ -1,30 +1,94 @@
-import 'typings-global'
-
 export interface IResolve<T> {
-    (value?: T | Promise<T>): void
+  (value?: T | PromiseLike<T>): void;
 }
 
 export interface IReject {
-    (reason?: any): void
+  (reason?: any): void;
 }
 
+export type TDeferredStatus = 'pending' | 'fulfilled' | 'rejected';
+
 export class Deferred<T> {
-    promise: Promise<T>
+  public promise: Promise<T>;
-    resolve: IResolve<T>
+  public resolve: IResolve<T>;
-    reject: IReject
+  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.resolve = (valueArg: T | PromiseLike<T>) => {
-            this.reject = reject
+        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>()
+  return new Deferred<T>();
+};
+
+/**
+ * Creates a new resolved promise for the provided value.
+ */
+export const resolvedPromise = <T>(value?: T): Promise<T> => {
+  return Promise.resolve(value);
+};
+
+/**
+ * Creates a new rejected promise for the provided reason.
+ */
+export const rejectedPromise = (err) => {
+  return Promise.reject(err);
+};
+
+interface IAsyncFunction<T> {
+  (someArg: T): Promise<T>;
 }
 
+/**
+ * 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) => {
+      resultArray.push(x);
+    });
+  }
+  await Promise.all(promiseArray);
+  return resultArray;
+};
 
-export let all = () => {
+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"
 }