3.0.15

.gitignore

@@ -1,5 +1,22 @@
-node_modules/
+.nogit/
-pages/
+
-public/
+# 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
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
+    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -18,102 +18,103 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - 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
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
-    
+    - priv
-testSTABLE:
+
+testBuild:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - 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/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
   tags:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - 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:
@@ -121,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

@@ -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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,47 +0,0 @@
-# lik
-
-light little helpers for node
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/lik)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/lik)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/lik)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](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)
-[![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/lik.svg)](https://www.npmjs.com/package/lik)
-[![Dependency Status](https://david-dm.org/pushrocks/lik.svg)](https://david-dm.org/pushrocks/lik)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/lik/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/lik/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/lik/badges/code.svg)](https://www.bithound.io/github/pushrocks/lik)
-[![Known Vulnerabilities](https://snyk.io/test/npm/lik/badge.svg)](https://snyk.io/test/npm/lik)
-[![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.
-
-```javascript
-// import any tool that you need from lik
-import { Stringmap, Objectmap, Observablemap } from 'lik';
-```
-
-### class Stringmap
-
-Stringmap allows you to keep track of strings. It allows you to register triggers for certain events
-like when a certain string is removed or added to the map
-
-### class Objectmap
-
-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.
-
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

npmextra.json

@@ -2,5 +2,16 @@
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "lik",
+      "shortDescription": "light little helpers for node",
+      "npmPackagename": "@pushrocks/lik",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/lik",
-  "version": "3.0.4",
+  "version": "3.0.15",
   "private": false,
   "description": "light little helpers for node",
   "main": "dist/index.js",
@@ -20,21 +20,32 @@
   },
   "homepage": "https://gitlab.com/pushrocks/lik#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.3",
+    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.1.17",
+    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.18",
+    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^3.2.0",
-    "@types/node": "^10.12.12",
+    "@types/node": "^13.7.0",
-    "tslint": "^5.11.0",
+    "tslint": "^6.0.0",
-    "tslint-config-prettier": "^1.17.0"
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartdelay": "^2.0.2",
+    "@pushrocks/smartdelay": "^2.0.6",
-    "@pushrocks/smartpromise": "^2.0.5",
+    "@pushrocks/smartpromise": "^3.0.6",
-    "@pushrocks/smartrx": "^2.0.3",
+    "@pushrocks/smartrx": "^2.0.5",
-    "@pushrocks/smarttime": "^3.0.5",
+    "@pushrocks/smarttime": "^3.0.12",
     "@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

@@ -0,0 +1,48 @@
+# @pushrocks/lik
+light little helpers for node
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/lik)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/lik)
+* [github.com (source mirror)](https://github.com/pushrocks/lik)
+* [docs (typedoc)](https://pushrocks.gitlab.io/lik/)
+
+## Status for 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)
+[![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.
+
+```javascript
+// import any tool that you need from lik
+import { Stringmap, Objectmap, Observablemap } from 'lik';
+```
+
+### class Stringmap
+
+Stringmap allows you to keep track of strings. It allows you to register triggers for certain events
+like when a certain string is removed or added to the map
+
+### class Objectmap
+
+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)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.timedaggregator.ts

@@ -0,0 +1,25 @@
+// import test framework
+import { expect, tap } from '@pushrocks/tapbundle';
+import * as events from 'events';
+import * as smartpromise from '@pushrocks/smartpromise';
+
+// import the module
+import * as lik from '../ts/index';
+
+let testTimedAggregator: lik.TimedAggregtor<string>;
+
+tap.test('should create a timed aggregaotor', async tools => {
+  testTimedAggregator = new lik.TimedAggregtor<string>({
+    aggregationIntervalInMillis: 1000,
+    functionForAggregation: aggregation => {
+      console.log(aggregation);
+    }
+  });
+  testTimedAggregator.add('This');
+  testTimedAggregator.add('is a whole sentence.');
+  await tools.delayFor(1001);
+  testTimedAggregator.add('This one is another.');
+  await tools.delayFor(2000);
+});
+
+tap.start();

ts/index.ts

@@ -7,4 +7,5 @@ export * from './lik.limitedarray';
 export * from './lik.looptracker';
 export * from './lik.objectmap';
 export * from './lik.stringmap';
+export * from './lik.timedaggregator';
 export * from './lik.tree';

ts/lik.fastmap.ts

@@ -0,0 +1,11 @@
+import * as plugins from './lik.plugins';
+
+export class FastMap<T> {
+  private mapObject: { [key: string]: T } = {};
+
+  public isUniqueKey() {}
+
+  public addToMap(identifier: string, objectArg: T) {
+    this.mapObject[identifier] = objectArg;
+  }
+}

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,8 +13,12 @@ export interface IObjectmapFindFunction<T> {
  * allows keeping track of objects
  */
 export class Objectmap<T> {
+  private fastMap = new FastMap<T>();
   private objectArray: T[] = [];
 
+  // events
+  public eventSubject = new plugins.smartrx.rxjs.Subject<any>();
+
   /**
    * returns a new instance
    */
@@ -21,6 +26,27 @@ export class Objectmap<T> {
     // nothing here
   }
 
+  /**
+   * adds an object mapped to a string
+   * the string must be unique
+   */
+  addMappedUnique(uniqueKey: string, objectArg: T) {
+    this.add(objectArg);
+    this.fastMap.addToMap(uniqueKey, objectArg);
+  }
+
+  /**
+   * fastest way to get an object from the map
+   * @param uniqueKey
+   */
+  public getMappedUnique(uniqueKey: string) {}
+
+  /**
+   * remove key
+   * @param functionArg
+   */
+  public removeMappedUnique() {}
+
   /**
    * add object to Objectmap
    * returns false if the object is already in the map
@@ -33,6 +59,7 @@ export class Objectmap<T> {
     } else {
       // the object is not yet in the objectmap
       this.objectArray.push(objectArg);
+      this.eventSubject.next('add');
       return true;
     }
   }
@@ -89,13 +116,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 removedItem = this.objectArray.shift();
+    this.eventSubject.next('remove');
+    return removedItem;
   }
 
   /**
    * returns a cloned array of all the objects currently in the Objectmap
    */
-  public getArray() {
+  public getArray(): T[] {
     const returnArray: any[] = [];
     for (const objectItem of this.objectArray) {
       returnArray.push(objectItem);
@@ -125,6 +154,7 @@ export class Objectmap<T> {
       }
     }
     this.objectArray = replacementArray;
+    this.eventSubject.next('remove');
   }
 
   /**
@@ -132,5 +162,6 @@ export class Objectmap<T> {
    */
   public wipe() {
     this.objectArray = [];
+    this.eventSubject.next('wiped');
   }
 }

ts/lik.plugins.ts

@@ -19,7 +19,7 @@ export { smartdelay, smartpromise, smartrx, smarttime };
 // ==============
 // third party
 // ==============
-import * as minimatch from 'minimatch';
+import minimatch from 'minimatch';
 const symbolTree = require('symbol-tree');
 
 export { minimatch, symbolTree };

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

@@ -0,0 +1,41 @@
+import * as plugins from './lik.plugins';
+
+export interface ITimedAggregatorOptions<T> {
+  aggregationIntervalInMillis: number;
+  functionForAggregation: (input: T[]) => void;
+}
+
+export class TimedAggregtor<T> {
+  public options: ITimedAggregatorOptions<T>;
+  private storageArray: T[] = [];
+
+  constructor(optionsArg: ITimedAggregatorOptions<T>) {
+    this.options = optionsArg;
+  }
+
+  private aggregationTimer: plugins.smarttime.Timer;
+  private checkAggregationStatus() {
+    const addAggregationTimer = () => {
+      this.aggregationTimer = new plugins.smarttime.Timer(this.options.aggregationIntervalInMillis);
+      this.aggregationTimer.completed.then(() => {
+        const aggregateForProcessing = this.storageArray;
+        if (aggregateForProcessing.length === 0) {
+          this.aggregationTimer = null;
+          return;
+        }
+        this.storageArray = [];
+        addAggregationTimer();
+        this.options.functionForAggregation(aggregateForProcessing);
+      });
+      this.aggregationTimer.start();
+    };
+    if (!this.aggregationTimer) {
+      addAggregationTimer();
+    }
+  }
+
+  public add(aggregationArg: T) {
+    this.storageArray.push(aggregationArg);
+    this.checkAggregationStatus();
+  }
+}