3.1.7

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -4,13 +4,13 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -19,20 +19,35 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - 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
-  - notpriv
+
+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
@@ -48,7 +63,6 @@ testStable:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
-  - priv
 
 testBuild:
   stage: test
@@ -60,7 +74,6 @@ testBuild:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
-  - notpriv
 
 release:
   stage: release
@@ -70,6 +83,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -79,11 +93,15 @@ release:
 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
 
@@ -94,20 +112,20 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:stable-dind
   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:

.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,90 +0,0 @@
-# @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
-
-[![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
-
-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
-})
-```
-
-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)

npmextra.json

@@ -4,6 +4,7 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pushrocks/smartpromise",
   "private": false,
-  "version": "3.0.6",
+  "version": "3.1.7",
   "description": "simple promises and Deferred constructs",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "test": "(tstest test/ --web)",
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
@@ -19,24 +19,27 @@
     "url": "https://gitlab.com/pushrocks/smartq/issues"
   },
   "homepage": "https://gitlab.com/pushrocks/smartq#README",
-  "dependencies": {},
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/node": "^12.7.5",
-    "tslint": "^5.20.0",
+    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tstest": "^1.0.54",
+    "@pushrocks/tapbundle": "^3.2.14",
+    "@types/node": "^15.6.1",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "dist_ts_web/*",
-    "assets/*",
+    "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,98 @@
+# @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

@@ -18,12 +18,12 @@ tap.test('should let types flow through the Promise', async () => {
 
 tap.test('should map callbacks', async () => {
   const inputArray = ['hi', 'awesome'];
-  const myPromisified = async myInput => {
+  const myPromisified = async (myInput) => {
     return myInput;
   };
-  const expectPromise = expect(smartpromise.map(inputArray, myPromisified)).to.eventually.deep.equal(
-    inputArray
-  );
+  const expectPromise = expect(
+    smartpromise.map(inputArray, myPromisified)
+  ).to.eventually.deep.equal(inputArray);
   return expectPromise;
 });
 

test/test.readme.node.ts

@@ -0,0 +1,54 @@
+import * as smartpromise from '../ts'; 
+
+// using Deferreds
+// simple deferred;
+const done = smartpromise.defer();
+done.promise.then((stringArg) => {
+  console.log(stringArg);
+});
+done.resolve('hello') // whenever you are ready
+
+
+// using deferreds in async functions to cater callback style apis
+const myAsyncFunction = async (): Promise<string> => {
+  const done = smartpromise.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";
+  await done.promise;
+  console.log(done.status); // logs "fullfilled"
+  console.log(done.duration); // outputs the duration in millisenconds
+
+  return done.promise;
+};
+
+let myAsyncFunction2 = async () => {
+  let aString = await myAsyncFunction();
+  console.log(aString); // will log 'hi' to console
+};
+
+myAsyncFunction2();
+
+// Resolved and Rejected promises
+// ------------------------------------------------
+smartpromise.resolvedPromise(`I'll get logged to console soon`).then((x) => {
+  console.log(x);
+});
+
+smartpromise
+  .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);
+  });
+
+import {tap, expect } from '@pushrocks/tapbundle';
+
+tap.test('runs through', async () => {})
+tap.start();

ts/index.ts

@@ -42,21 +42,21 @@ export class Deferred<T> {
   }
 }
 
-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);
 };
 
@@ -64,16 +64,54 @@ interface IAsyncFunction<T> {
   (someArg: T): Promise<T>;
 }
 
-export let map = async <T>(inputArg: T[], functionArg: IAsyncFunction<T>) => {
-  let promiseArray: Promise<any>[] = [];
-  let resultArray = [];
-  for (let item of inputArg) {
-    let promise: Promise<any> = functionArg(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 = async <T = any>(promiseArg: Promise<T>, timeoutInMsArg: number, rejectArg = true) => {
+  return new Promise<T>((resolve, reject) => {
+    setTimeout(() => {
+      if (rejectArg) {
+        reject(new Error('timeout'));
+      } else {
+        resolve(null);
+      }
+    }, timeoutInMsArg);
+    promiseArg.then(resolve, reject);
+  });
+};
+
+export const timeoutAndContinue = async <T = any>(promiseArg: Promise<T>, timeoutInMsArg = 60000) => {
+  return timeoutWrap(promiseArg, timeoutInMsArg, false);
+}
+
+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;
+};