3.0.17

.gitignore

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

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -18,127 +18,103 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 snyk:
+  image: registry.gitlab.com/hosttoday/ht-docker-node: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
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+    - lossless
+    - docker
+    - priv
+
+testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 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 prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -146,5 +122,5 @@ pages:
   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

@@ -1,3 +1,26 @@
 {
-  "workbench.colorCustomizations": {}
-}
+  "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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/lik",
-  "version": "3.0.6",
+  "version": "3.0.17",
   "private": false,
   "description": "light little helpers for node",
   "main": "dist/index.js",
@@ -20,21 +20,33 @@
   },
   "homepage": "https://gitlab.com/pushrocks/lik#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.3",
-    "@gitzone/tsrun": "^1.1.17",
-    "@gitzone/tstest": "^1.0.18",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.12.12",
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.17.0"
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.28",
+    "@pushrocks/tapbundle": "^3.2.0",
+    "@types/node": "^13.7.0",
+    "tslint": "^6.0.0",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartdelay": "^2.0.2",
-    "@pushrocks/smartpromise": "^2.0.5",
-    "@pushrocks/smartrx": "^2.0.3",
-    "@pushrocks/smarttime": "^3.0.5",
+    "@pushrocks/smartdelay": "^2.0.6",
+    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartrx": "^2.0.5",
+    "@pushrocks/smarttime": "^3.0.12",
+    "@pushrocks/smartunique": "^3.0.1",
     "@types/minimatch": "^3.0.3",
     "minimatch": "^3.0.4",
-    "symbol-tree": "^3.2.2"
-  }
+    "symbol-tree": "^3.2.4"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -8,7 +8,7 @@ light little helpers for node
 * [docs (typedoc)](https://pushrocks.gitlab.io/lik/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/lik/badges/master/build.svg)](https://gitlab.com/pushrocks/lik/commits/master)
+[![pipeline status](https://gitlab.com/pushrocks/lik/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/lik/commits/master)
 [![coverage report](https://gitlab.com/pushrocks/lik/badges/master/coverage.svg)](https://gitlab.com/pushrocks/lik/commits/master)
 [![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/lik.svg)](https://www.npmjs.com/package/@pushrocks/lik)
 [![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/lik/badge.svg)](https://snyk.io/test/npm/@pushrocks/lik)
@@ -35,9 +35,14 @@ like when a certain string is removed or added to the map
 Sometimes you need to keep track of objects, but implementing logic for removing, finding or updating is tedious.
 Objectmap takes care of keeping track of objects for you.
 
+
+## 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 | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| 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://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.timedaggregator.ts

@@ -8,10 +8,10 @@ import * as lik from '../ts/index';
 
 let testTimedAggregator: lik.TimedAggregtor<string>;
 
-tap.test('should create a timed aggregaotor', async (tools) => {
+tap.test('should create a timed aggregaotor', async tools => {
   testTimedAggregator = new lik.TimedAggregtor<string>({
     aggregationIntervalInMillis: 1000,
-    functionForAggregation: (aggregation) => {
+    functionForAggregation: aggregation => {
       console.log(aggregation);
     }
   });

ts/lik.fastmap.ts

@@ -0,0 +1,41 @@
+import * as plugins from './lik.plugins';
+
+/**
+ * fast map allows for very quick lookups of objects with a unique key
+ */
+export class FastMap<T> {
+  private mapObject: { [key: string]: T } = {};
+
+  public isUniqueKey(keyArg: string): boolean {
+    return this.mapObject[keyArg] ? false : true;
+  }
+
+  public addToMap(keyArg: string, objectArg: T): boolean {
+    if (this.isUniqueKey(keyArg)) {
+      this.mapObject[keyArg] = objectArg;
+      return true;
+    } else {
+      return false;
+    }
+  }
+
+  public getByKey(keyArg: string) {
+    return this.mapObject[keyArg];
+  }
+
+  public removeFromMap(keyArg): T {
+    const removedItem = this.getByKey(keyArg);
+    delete this.mapObject[keyArg];
+    return removedItem;
+  }
+
+  public getKeys() {
+    const keys: string[] = [];
+    for (const keyArg in this.mapObject) {
+       if (this.mapObject[keyArg]) {
+         keys.push(keyArg);
+       }
+    }
+    return keys;
+  }
+}

ts/lik.looptracker.ts

@@ -12,7 +12,12 @@ export class LoopTracker<T> {
    * checks and tracks an object
    * @param objectArg
    */
-  checkAndTrack(objectArg: T) {
-    return this.referenceObjectMap.add(objectArg);
+  checkAndTrack(objectArg: T): boolean {
+    if (!this.referenceObjectMap.checkForObject(objectArg)) {
+      this.referenceObjectMap.add(objectArg);
+      return true;
+    } else {
+      return false;
+    }
   }
 }

ts/lik.objectmap.ts

@@ -1,4 +1,5 @@
 import * as plugins from './lik.plugins';
+import { FastMap } from './lik.fastmap';
 
 export interface IObjectmapForEachFunction<T> {
   (itemArg: T): void;
@@ -12,7 +13,10 @@ export interface IObjectmapFindFunction<T> {
  * allows keeping track of objects
  */
 export class Objectmap<T> {
-  private objectArray: T[] = [];
+  private fastMap = new FastMap<T>();
+
+  // events
+  public eventSubject = new plugins.smartrx.rxjs.Subject<any>();
 
   /**
    * returns a new instance
@@ -21,27 +25,55 @@ export class Objectmap<T> {
     // nothing here
   }
 
+  /**
+   * adds an object mapped to a string
+   * the string must be unique
+   */
+  addMappedUnique(uniqueKeyArg: string, objectArg: T) {
+    this.fastMap.addToMap(uniqueKeyArg, objectArg);
+  }
+
+  /**
+   * fastest way to get an object from the map
+   * @param uniqueKey
+   */
+  public getMappedUnique(uniqueKeyArg: string) {
+    return this.fastMap.getByKey(uniqueKeyArg);
+  }
+
+  /**
+   * remove key
+   * @param functionArg
+   */
+  public removeMappedUnique(uniqueKey: string) {
+    const object = this.getMappedUnique(uniqueKey);
+  }
+
   /**
    * add object to Objectmap
    * returns false if the object is already in the map
    * returns true if the object was added successfully
    */
-  public add(objectArg: T): boolean {
-    if (this.checkForObject(objectArg)) {
-      // the object is already in the objectmap
-      return false;
-    } else {
-      // the object is not yet in the objectmap
-      this.objectArray.push(objectArg);
-      return true;
+  public add(objectArg: T): string {
+    // lets search for an existing unique key
+    for (const keyArg of this.fastMap.getKeys()) {
+      const object = this.fastMap.getByKey(keyArg);
+      if (object === objectArg) {
+        return keyArg;
+      }
     }
+
+    // otherwise lets create it
+    const uniqueKey = plugins.smartunique.shortId();
+    this.addMappedUnique(uniqueKey, objectArg);
+    return uniqueKey;
   }
 
   /**
    * like .add but adds an whole array of objects
    */
   public addArray(objectArrayArg: T[]) {
-    for (let item of objectArrayArg) {
+    for (const item of objectArrayArg) {
       this.add(item);
     }
   }
@@ -49,19 +81,34 @@ export class Objectmap<T> {
   /**
    * check if object is in Objectmap
    */
-  public checkForObject(objectArg: T) {
-    return this.objectArray.indexOf(objectArg) !== -1;
+  public checkForObject(objectArg: T): boolean {
+    return !!this.getKeyForObject(objectArg);
+  }
+
+  /**
+   * get key for object
+   * @param findFunction
+   */
+  public getKeyForObject(objectArg: T) {
+    let foundKey: string = null;
+    for (const keyArg of this.fastMap.getKeys()) {
+      if (!foundKey && this.fastMap.getByKey(keyArg) === objectArg) {
+        foundKey = keyArg;
+      } else {
+        continue;
+      }
+    }
+    return foundKey;
   }
 
   /**
    * find object
    */
-  public find(findFunction: IObjectmapFindFunction<T>) {
-    const resultArray = this.objectArray.filter(findFunction);
-    if (resultArray.length > 0) {
-      return resultArray[0];
-    } else {
-      return null;
+  public find(findFunction: IObjectmapFindFunction<T>): T {
+    for (const keyArg of this.fastMap.getKeys()) {
+      if (findFunction(this.fastMap.getByKey(keyArg))) {
+        return this.getMappedUnique(keyArg);
+      }
     }
   }
 
@@ -80,8 +127,8 @@ export class Objectmap<T> {
    * run function for each item in Objectmap
    */
   public async forEach(functionArg: IObjectmapForEachFunction<T>) {
-    for (let object of this.objectArray) {
-      await functionArg(object);
+    for (const keyArg of this.fastMap.getKeys()) {
+      await functionArg(this.fastMap.getByKey(keyArg));
     }
   }
 
@@ -89,7 +136,15 @@ export class Objectmap<T> {
    * gets an object in the Observablemap and removes it, so it can't be retrieved again
    */
   public getOneAndRemove(): T {
-    return this.objectArray.shift();
+    const keys = this.fastMap.getKeys();
+    if (keys.length === 0) {
+      return null;
+    } else {
+      const keyToUse = keys[0];
+      const removedItem = this.fastMap.removeFromMap(keyToUse);
+      this.eventSubject.next('remove');
+      return removedItem;
+    }
   }
 
   /**
@@ -97,8 +152,8 @@ export class Objectmap<T> {
    */
   public getArray(): T[] {
     const returnArray: any[] = [];
-    for (const objectItem of this.objectArray) {
-      returnArray.push(objectItem);
+    for (const keyArg of this.fastMap.getKeys()) {
+      returnArray.push(this.fastMap.getByKey(keyArg));
     }
     return returnArray;
   }
@@ -107,30 +162,28 @@ export class Objectmap<T> {
    * check if Objectmap ist empty
    */
   public isEmpty(): boolean {
-    if (this.objectArray.length === 0) {
-      return true;
-    } else {
-      return false;
-    }
+    return this.fastMap.getKeys().length === 0;
   }
 
   /**
    * remove object from Objectmap
    */
-  public remove(objectArg: T) {
-    let replacementArray = [];
-    for (let item of this.objectArray) {
-      if (item !== objectArg) {
-        replacementArray.push(item);
-      }
+  public remove(objectArg: T): T {
+    if (this.checkForObject(objectArg)) {
+      const keyArg = this.getKeyForObject(objectArg);
+      const removedObject = this.fastMap.removeFromMap(keyArg);
+      this.eventSubject.next('remove');
+      return removedObject;
     }
-    this.objectArray = replacementArray;
+    return null;
   }
 
   /**
    * wipe Objectmap
    */
   public wipe() {
-    this.objectArray = [];
+    for (const keyArg of this.fastMap.getKeys()) {
+      this.fastMap.removeFromMap(keyArg);
+    }
   }
 }

ts/lik.plugins.ts

@@ -13,8 +13,9 @@ import * as smartdelay from '@pushrocks/smartdelay';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartrx from '@pushrocks/smartrx';
 import * as smarttime from '@pushrocks/smarttime';
+import * as smartunique from '@pushrocks/smartunique';
 
-export { smartdelay, smartpromise, smartrx, smarttime };
+export { smartdelay, smartpromise, smartrx, smarttime, smartunique };
 
 // ==============
 // third party

ts/lik.stringmap.ts

@@ -24,7 +24,7 @@ export class Stringmap {
    * like addString, but accepts an array of strings
    */
   addStringArray(stringArrayArg: string[]) {
-    for (let stringItem of stringArrayArg) {
+    for (const stringItem of stringArrayArg) {
       this.addString(stringItem);
     }
   }
@@ -33,7 +33,7 @@ export class Stringmap {
    * removes a string from Stringmap
    */
   removeString(stringArg: string) {
-    for (let keyArg in this._stringArray) {
+    for (const keyArg in this._stringArray) {
       if (this._stringArray[keyArg] === stringArg) {
         this._stringArray.splice(parseInt(keyArg), 1);
       }
@@ -61,7 +61,7 @@ export class Stringmap {
    */
   public checkMinimatch(miniMatchStringArg: string): boolean {
     let foundMatch: boolean = false;
-    for (let stringItem of this._stringArray) {
+    for (const stringItem of this._stringArray) {
       if (plugins.minimatch(stringItem, miniMatchStringArg)) {
         foundMatch = true;
       }
@@ -94,7 +94,7 @@ export class Stringmap {
    */
   public registerUntilTrue(functionArg: ITriggerFunction, doFunctionArg) {
     this._triggerUntilTrueFunctionArray.push(() => {
-      let result = functionArg();
+      const result = functionArg();
       if (result === true) {
         doFunctionArg();
       }
@@ -107,7 +107,7 @@ export class Stringmap {
    * notifies triggers
    */
   private notifyTrigger() {
-    let filteredArray = this._triggerUntilTrueFunctionArray.filter(functionArg => {
+    const filteredArray = this._triggerUntilTrueFunctionArray.filter(functionArg => {
       return !functionArg();
     });
     this._triggerUntilTrueFunctionArray = filteredArray;

ts/lik.timedaggregator.ts

@@ -11,11 +11,10 @@ export class TimedAggregtor<T> {
 
   constructor(optionsArg: ITimedAggregatorOptions<T>) {
     this.options = optionsArg;
-
   }
 
   private aggregationTimer: plugins.smarttime.Timer;
-  private checkAggregationStatus () {
+  private checkAggregationStatus() {
     const addAggregationTimer = () => {
       this.aggregationTimer = new plugins.smarttime.Timer(this.options.aggregationIntervalInMillis);
       this.aggregationTimer.completed.then(() => {
@@ -39,4 +38,4 @@ export class TimedAggregtor<T> {
     this.storageArray.push(aggregationArg);
     this.checkAggregationStatus();
   }
-};
+}