3.1.5

Implementation

See merge request !1

.gitignore

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

.gitlab-ci.yml

@@ -1,59 +1,137 @@
-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
-- trigger
-- pages
+  - security
+  - test
+  - release
+  - metadata
 
-testLEGACY:
-  stage: test
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
   script:
-    - npmci test legacy
+    - 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
+
+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
 
-testLTS:
+# ====================
+# test stage
+# ====================
+
+testStable:
   stage: test
   script:
-    - npmci test lts
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
 
-testSTABLE:
+testBuild:
   stage: test
   script:
-    - npmci test stable
+    - 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 publish
+    - 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 tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
+  tags:
+    - lossless
+    - docker
+    - priv
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
     - npmci trigger
   only:
     - tags
   tags:
+    - lossless
     - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmpage
-  stage: pages
+  stage: metadata
   script:
-    - npmci command npmpage --host gitlab
+    - 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
+      - public
+  allow_failure: true

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.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,24 +0,0 @@
-# smartq
-dropin replacement for q
-
-## Availabililty
-[![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)
-[![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/)
-
-## 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->=%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
-Use TypeScript for best in class instellisense.
-
-[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

npmextra.json

@@ -0,0 +1,17 @@
+{
+  "npmci": {
+    "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,11 +1,13 @@
 {
-  "name": "smartq",
-  "version": "1.0.1",
-  "description": "dropin replacement for q",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "name": "@pushrocks/smartpromise",
+  "private": false,
+  "version": "3.1.5",
+  "description": "simple promises and Deferred constructs",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/ --web)",
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
@@ -16,5 +18,29 @@
   "bugs": {
     "url": "https://gitlab.com/pushrocks/smartq/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/smartq#README"
+  "homepage": "https://gitlab.com/pushrocks/smartq#README",
+  "dependencies": {},
+  "devDependencies": {
+    "@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_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

readme.md

@@ -0,0 +1,99 @@
+# @pushrocks/smartpromise
+simple promises and Deferred constructs
+
+## Availabililty and Links
+* [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
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartpromise/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartpromise/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartpromise)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartpromise)](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/smartpromise)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartpromise)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartpromise)](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.
+
+> 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
+});
+```
+
+
+## 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 | **&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)

test/test.both.ts

@@ -0,0 +1,30 @@
+import { expect, tap } from '@pushrocks/tapbundle';
+import * as smartpromise from '../ts/index';
+
+tap.test('should return a Deferred for .defer()', async () => {
+  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 () => {
+  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 map callbacks', async () => {
+  const inputArray = ['hi', 'awesome'];
+  const myPromisified = async (myInput) => {
+    return myInput;
+  };
+  const expectPromise = expect(
+    smartpromise.map(inputArray, myPromisified)
+  ).to.eventually.deep.equal(inputArray);
+  return expectPromise;
+});
+
+tap.start();

ts/index.ts

@@ -0,0 +1,109 @@
+export interface IResolve<T> {
+  (value?: T | PromiseLike<T>): void;
+}
+
+export interface IReject {
+  (reason?: any): void;
+}
+
+export type TDeferredStatus = 'pending' | 'fulfilled' | 'rejected';
+
+export class Deferred<T> {
+  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 = (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 const defer = <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 const timeoutWrap = <T = any>(promiseArg: Promise<T>, timeoutInMs: number) => {
+  return new Promise<T>((resolve, reject) => {
+    setTimeout(() => {
+      reject(new Error('timeout'));
+    }, timeoutInMs);
+    promiseArg.then(resolve, reject);
+  });
+};
+
+export const getFirstTrueOrFalse = async (promisesArg: Promise<boolean>[]) => {
+  const done = defer<boolean>();
+  for (const promiseArg of promisesArg) {
+    promiseArg.then((resultArg) => {
+      if (resultArg === true) {
+        done.resolve(true);
+      }
+    });
+  }
+  Promise.all(promisesArg).then(() => {
+    done.resolve(false);
+  });
+  return done.promise;
+};

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