3.0.0

.gitlab-ci.yml

@@ -12,30 +12,35 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
-mirror:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci git mirror
+    - 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:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
-audit:
+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
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +55,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +66,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,11 +86,12 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker
@@ -109,11 +111,10 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
+    - npmci node install stable 
-    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
+      "command": "npm test",
-      "type": "node",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
+      "type": "node-terminal"
-        "${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

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

npmextra.json

@@ -12,7 +12,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartrx",
-      "shortDescription": "smart wrapper for rxjs",
+      "description": "smart wrapper for rxjs",
       "npmPackagename": "@pushrocks/smartrx",
       "license": "MIT"
     }

package.json

@@ -1,30 +1,31 @@
 {
   "name": "@pushrocks/smartrx",
-  "version": "2.0.8",
+  "version": "3.0.0",
   "private": false,
   "description": "smart wrapper for rxjs",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild && tsbundle npm)"
+    "build": "(tsbuild --web && tsbundle npm)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tsbuild": "^2.1.65",
-    "@gitzone/tsbundle": "^1.0.69",
+    "@gitzone/tsbundle": "^2.0.7",
-    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tsrun": "^1.2.37",
-    "@gitzone/tstest": "^1.0.28",
+    "@gitzone/tstest": "^1.0.73",
-    "@pushrocks/tapbundle": "^3.2.1",
+    "@pushrocks/tapbundle": "^5.0.4",
-    "@types/node": "^14.0.5",
+    "@types/node": "^18.6.4",
-    "tslint": "^6.1.2",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/lik": "^4.0.6",
+    "@pushrocks/smartpromise": "^3.1.7",
-    "@pushrocks/smartpromise": "^3.0.6",
+    "rxjs": "^7.5.6"
-    "rxjs": "^6.5.5"
   },
   "files": [
     "ts/**/*",
@@ -37,5 +38,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,25 +8,25 @@ smart wrapper for rxjs
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartrx/)
 
 ## Status for master
-[![pipeline status](https://gitlab.com/pushrocks/smartrx/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smartrx/commits/master)
+
-[![coverage report](https://gitlab.com/pushrocks/smartrx/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartrx/commits/master)
+Status Category | Status Badge
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartrx.svg)](https://www.npmjs.com/package/@pushrocks/smartrx)
+-- | --
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartrx/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartrx)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartrx/badges/master/pipeline.svg)](https://lossless.cloud)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartrx/badges/master/coverage.svg)](https://lossless.cloud)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartrx)](https://lossless.cloud)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartrx)](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/smartrx)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartrx)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartrx)](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.
 
-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)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
-
 ## 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). :)

test/test.observableintake.both.ts

@@ -1,15 +1,15 @@
 import { tap, expect } from '@pushrocks/tapbundle';
 
-import * as smartrx from '../ts/index';
+import * as smartrx from '../ts/index.js';
 
 tap.test('should create a valid instance of observableinstake', async () => {
   const testObservableIntake = new smartrx.ObservableIntake();
-  expect(testObservableIntake).to.be.instanceOf(smartrx.ObservableIntake);
+  expect(testObservableIntake).toBeInstanceOf(smartrx.ObservableIntake);
 });
 
-tap.test('expect testObserservableIntake to push things', async tools => {
+tap.test('expect testObserservableIntake to push things', async (tools) => {
   const testObserservableIntake = new smartrx.ObservableIntake();
-  testObserservableIntake.subscribe(value => {
+  testObserservableIntake.subscribe((value: any) => {
     console.log(value);
   });
 
@@ -19,13 +19,13 @@ tap.test('expect testObserservableIntake to push things', async tools => {
   await testObserservableIntake.completed;
 });
 
-tap.test('expect testObserservableIntake to push things', async tools => {
+tap.test('expect testObserservableIntake to push things', async (tools) => {
   const testObserservableIntake = new smartrx.ObservableIntake();
   testObserservableIntake.push('hi');
   testObserservableIntake.push('wow');
   testObserservableIntake.makeBuffered();
   testObserservableIntake.push('jo');
-  testObserservableIntake.subscribe(value => {
+  testObserservableIntake.subscribe((value: any) => {
     console.log(value);
     testObserservableIntake.signalComplete();
   });

test/test.observablemap.node.ts

@@ -5,7 +5,7 @@ import * as rx from 'rxjs';
 import * as smartpromise from '@pushrocks/smartpromise';
 
 // import the module
-import * as smartrx from '../ts/index';
+import * as smartrx from '../ts/index.js';
 
 let testObservablemap: smartrx.Observablemap;
 let testObservable1: rx.Observable<any>;
@@ -15,20 +15,20 @@ let testEmitter: events.EventEmitter;
 
 tap.test('should create an instance', async () => {
   testObservablemap = new smartrx.Observablemap();
-  expect(testObservablemap).be.instanceof(smartrx.Observablemap);
+  expect(testObservablemap).toBeInstanceOf(smartrx.Observablemap);
 });
 
 tap.test('should accept a new emitter', async () => {
   let done = smartpromise.defer();
   testEmitter = new events.EventEmitter();
-  testObservable1 = testObservablemap.getObservableForEmitterEvent(testEmitter, 'event1');
+  testObservable1 = testObservablemap.getSubjectForEmitterEvent(testEmitter, 'event1');
-  testObservable1.subscribe(x => {
+  testObservable1.subscribe((x) => {
     done.resolve();
   });
-  testObservable2 = testObservablemap.getObservableForEmitterEvent(testEmitter, 'event1');
+  testObservable2 = testObservablemap.getSubjectForEmitterEvent(testEmitter, 'event1');
-  testObservable3 = testObservablemap.getObservableForEmitterEvent(testEmitter, 'event2');
+  testObservable3 = testObservablemap.getSubjectForEmitterEvent(testEmitter, 'event2');
-  expect(testObservable1 === testObservable2).to.be.true;
+  expect(testObservable1 === testObservable2).toBeTrue();
-  expect(testObservable1 === testObservable3).to.be.false;
+  expect(testObservable1 === testObservable3).toBeFalse();
   testEmitter.emit('event1');
   await done.promise;
 });

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartrx',
+  version: '3.0.0',
+  description: 'smart wrapper for rxjs'
+}

ts/index.ts

@@ -1,7 +1,5 @@
-import * as plugins from './smartrx.plugins';
+import * as plugins from './smartrx.plugins.js';
-export * from './smartrx.classes.observablemap';
+export * from './smartrx.classes.observablemap.js';
-export * from './smartrx.classes.observableintake';
+export * from './smartrx.classes.observableintake.js';
-
+import * as rxjs from './smartrx.plugins.rxjs.js';
-import * as rxjs from 'rxjs';
-
 export { rxjs };

ts/smartrx.classes.observableintake.ts

@@ -1,40 +1,42 @@
-import * as plugins from './smartrx.plugins';
+import * as plugins from './smartrx.plugins.js';
+
+import * as rxjs from './smartrx.plugins.rxjs.js';
 
 /**
  * ObservableIntake
  */
 export class ObservableIntake<T> {
-  public observable: plugins.rxjs.Observable<T>;
+  public observable: rxjs.Observable<T>;
   public completed: Promise<void>;
   private completedDeffered: plugins.smartpromise.Deferred<void>;
   private observableFunctions: any = {
-    next: payloadArg => {
+    next: (payloadArg: T) => {
       // nothing
     },
-    complete: payloadArg => {
+    complete: (payloadArg: T) => {
       // nothing
-    }
+    },
   };
-  private generator = null;
+  private generator: Generator<T> = null;
   private buffered = false;
-  private payloadBuffer = [];
+  private payloadBuffer: any[] = [];
 
   constructor() {
-    this.observable = plugins.rxjs.Observable.create(observerArg => {
+    this.observable = new rxjs.Observable((observerArg: rxjs.Observer<any>) => {
-      this.observableFunctions.next = (...args) => {
+      this.observableFunctions.next = (...args: any) => {
-        return observerArg.next(...args);
+        return observerArg.next(args);
       };
-      this.observableFunctions.complete = (...args) => {
+      this.observableFunctions.complete = () => {
         this.completedDeffered.resolve();
-        return observerArg.complete(...args);
+        return observerArg.complete();
       };
     });
     this.completedDeffered = plugins.smartpromise.defer();
     this.completed = this.completedDeffered.promise;
   }
 
-  public setObservable(observableFunc) {
+  public setObservable(observableFunc: rxjs.Observable<any>) {
-    this.observable = observableFunc();
+    this.observable = observableFunc;
   }
 
   public push(payloadArg: T) {
@@ -59,7 +61,7 @@ export class ObservableIntake<T> {
    * sets a generator to query the next pushed value
    * @param generatorArg
    */
-  public setGenerator(generatorArg) {
+  public setGenerator(generatorArg: Generator<T>) {
     this.generator = generatorArg;
   }
 
@@ -67,7 +69,7 @@ export class ObservableIntake<T> {
     this.buffered = true;
   }
 
-  public subscribe(...args) {
+  public subscribe(...args: any) {
     return this.observable.subscribe(...args);
   }
 
@@ -83,8 +85,8 @@ export class ObservableIntake<T> {
         if (this.payloadBuffer.length > 0) {
           this.internalPush(this.payloadBuffer.shift());
         } else {
-          const nextPayload = this.generator();
+          const nextPayload = this.generator.next();
-          this.internalPush(nextPayload);
+          this.internalPush(nextPayload.value);
         }
       }
     }
@@ -97,7 +99,7 @@ export class ObservableIntake<T> {
     this.observableFunctions.complete();
   }
 
-  private internalPush(payloadArg) {
+  private internalPush(payloadArg: T) {
     this.observableFunctions.next(payloadArg);
   }
 }

ts/smartrx.classes.observablemap.ts

@@ -1,12 +1,16 @@
-import * as plugins from './smartrx.plugins';
+import * as plugins from './smartrx.plugins.js';
-import { EventEmitter } from '@pushrocks/smartevent';
+import * as rxjs from './smartrx.plugins.rxjs.js';
+
+export interface IEventEmitter<T = any> {
+  on: (eventNameArg: string, eventHandlerArg: (eventPayload: T) => any) => void;
+}
 
 /**
  * bundles an observable with an emitter
  */
-export interface IObservableEmitterBundle {
+export interface IObservableEventBundle<T> {
-  observable: plugins.rxjs.Observable<any>;
+  subject: rxjs.Subject<any>;
-  emitter: EventEmitter;
+  eventRef: T;
   event: string;
 }
 
@@ -14,26 +18,56 @@ export interface IObservableEmitterBundle {
  * manages observables by making sure that only one observable is regsitered per event
  */
 export class Observablemap {
-  public observableEmitterBundleObjectmap = new plugins.lik.ObjectMap<IObservableEmitterBundle>();
+  public observableEventEmitterBundleArray = new Array<
+    IObservableEventBundle<IEventEmitter<unknown>>
+  >();
+  public observableEventTargetBundleArray = new Array<IObservableEventBundle<EventTarget>>();
 
   /**
-   * creates a new observable if not yet registered for the same event.
+   * creates a hot subject if not yet registered for the event.
    * In case event has been registered before the same observable is returned.
    */
-  public getObservableForEmitterEvent(emitterArg: EventEmitter, eventArg: string) {
+  public getSubjectForEmitterEvent<T>(
-    const existingBundle = this.observableEmitterBundleObjectmap.find(bundleArg => {
+    emitterArg: IEventEmitter<T>,
-      return bundleArg.emitter === emitterArg && bundleArg.event === eventArg;
+    eventArg: string
+  ): rxjs.Subject<T> {
+    const existingBundle = this.observableEventEmitterBundleArray.find((bundleArg) => {
+      return bundleArg.eventRef === emitterArg && bundleArg.event === eventArg;
     });
     if (existingBundle) {
-      return existingBundle.observable;
+      return existingBundle.subject;
     } else {
-      const emitterObservable = plugins.rxjs.fromEvent(emitterArg, eventArg);
+      const emitterObservable = rxjs.fromEvent<T>(emitterArg as any, eventArg);
-      this.observableEmitterBundleObjectmap.add({
+      const emitterSubject = new rxjs.Subject();
-        observable: emitterObservable,
+      emitterObservable.subscribe(emitterSubject);
-        emitter: emitterArg,
+      const newBundle: IObservableEventBundle<IEventEmitter> = {
-        event: eventArg
+        subject: emitterSubject,
+        eventRef: emitterArg,
+        event: eventArg,
+      };
+      this.observableEventEmitterBundleArray.push(newBundle);
+      return newBundle.subject;
+    }
+  }
+
+  public getSubjectForEventTarget<T>(
+    eventTargetArg: EventTarget,
+    eventNameArg: string
+  ): rxjs.Subject<T> {
+    const existingBundle = this.observableEventTargetBundleArray.find((bundleArg) => {
+      return bundleArg.eventRef === eventTargetArg && bundleArg.event === eventNameArg;
     });
-      return emitterObservable;
+    if (existingBundle) {
+      return existingBundle.subject;
+    } else {
+      const emitterSubject = new rxjs.Subject();
+      const newBundle: IObservableEventBundle<EventTarget> = {
+        subject: emitterSubject,
+        eventRef: eventTargetArg,
+        event: eventNameArg,
+      };
+      this.observableEventTargetBundleArray.push(newBundle);
+      return newBundle.subject;
     }
   }
 }

ts/smartrx.plugins.rxjs.ts

@@ -0,0 +1,15 @@
+// this file is intended to keep the bundle size down
+
+export { Observable, Subject, fromEvent, ReplaySubject, Subscription } from 'rxjs';
+
+export type { Observer } from 'rxjs';
+
+import { startWith, takeUntil, map, debounce, debounceTime } from 'rxjs/operators';
+
+export const ops = {
+  debounce,
+  debounceTime,
+  map,
+  startWith,
+  takeUntil,
+};

ts/smartrx.plugins.ts

@@ -1,5 +1,3 @@
-import * as lik from '@pushrocks/lik';
-import * as rxjs from 'rxjs';
 import * as smartpromise from '@pushrocks/smartpromise';
 
-export { lik, rxjs, smartpromise };
+export { smartpromise };

tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext"
+  }
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "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"
-}