1.0.22

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -19,23 +22,36 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+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
+  allow_failure: true
+
+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 +66,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +77,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +97,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.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

@@ -9,7 +9,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartstate",
-      "shortDescription": "a package that handles state in a good way",
+      "description": "a package that handles state in a good way",
       "npmPackagename": "@pushrocks/smartstate",
       "license": "MIT"
     }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartstate",
-  "version": "1.0.15",
+  "version": "1.0.22",
   "private": false,
   "description": "a package that handles state in a good way",
   "main": "dist_ts/index.js",
@@ -9,21 +9,24 @@
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)",
+    "build": "(tsbuild --web && tsbundle npm)"
-    "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tsbuild": "^2.1.29",
-    "@gitzone/tstest": "^1.0.28",
+    "@gitzone/tsbundle": "^1.0.89",
-    "@pushrocks/tapbundle": "^3.2.1",
+    "@gitzone/tstest": "^1.0.60",
-    "@types/node": "^14.0.1",
+    "@pushrocks/tapbundle": "^3.2.9",
-    "tslint": "^6.1.2",
+    "@types/node": "^17.0.10",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/lik": "^4.0.0",
+    "@pushrocks/isohash": "^1.0.2",
-    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/lik": "^5.0.1",
-    "rxjs": "^6.5.5"
+    "@pushrocks/smartjson": "^4.0.6",
+    "@pushrocks/smartobject": "^1.0.6",
+    "@pushrocks/smartpromise": "^3.1.6",
+    "@pushrocks/smartrx": "^2.0.20"
   },
   "files": [
     "ts/**/*",
@@ -36,5 +39,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,19 +8,25 @@ a package that handles state in a good way
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartstate/)
 
 ## Status for master
-[![pipeline status](https://gitlab.com/pushrocks/smartstate/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smartstate/commits/master)
+
-[![coverage report](https://gitlab.com/pushrocks/smartstate/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartstate/commits/master)
+Status Category | Status Badge
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartstate.svg)](https://www.npmjs.com/package/@pushrocks/smartstate)
+-- | --
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartstate/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartstate)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartstate/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/smartstate/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/smartstate)](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/smartstate)](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/smartstate)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartstate)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartstate)](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 intellisense.
 
-
 ## 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.node.ts

@@ -21,8 +21,8 @@ tap.test('should create a new StatePart', async () => {
   testStatePart = testState.getStatePart<TStatePartPayload>('testStatePart', {
     currentFavorites: [],
     deep: {
-      hi: 2
+      hi: 2,
-    }
+    },
   });
   expect(testStatePart).to.be.instanceOf(smartstate.StatePart);
   console.log(testStatePart);
@@ -30,13 +30,13 @@ tap.test('should create a new StatePart', async () => {
 
 tap.test('should select something', async () => {
   testStatePart
-    .select(state => state.deep.hi)
+    .select((state) => state.deep.hi)
-    .subscribe(substate => {
+    .subscribe((substate) => {
       expect(substate).to.equal(2);
     });
 });
 
-tap.test('should dispatch a state action', async tools => {
+tap.test('should dispatch a state action', async (tools) => {
   const done = tools.defer();
   const addFavourite = testStatePart.createAction<string>(async (statePart, payload) => {
     const currentState = statePart.getState();
@@ -44,7 +44,7 @@ tap.test('should dispatch a state action', async tools => {
     return currentState;
   });
   testStatePart
-    .waitUntilPresent(state => {
+    .waitUntilPresent((state) => {
       return state.currentFavorites[0];
     })
     .then(() => {

ts/index.ts

@@ -1,5 +1,3 @@
 export * from './smartstate.classes.smartstate';
 export * from './smartstate.classes.statepart';
-export * from './smartstate.classes.statecollection';
 export * from './smartstate.classes.stateaction';
-export * from './smartstate.classes.stateobservable';

ts/smartstate.classes.smartstate.ts

@@ -9,17 +9,27 @@ export class Smartstate<StatePartNameType> {
 
   constructor() {}
 
+  /**
+   * Allows getting and initializing a new statepart
+   * initMode === 'soft' it will allow existing stateparts
+   * initMode === 'mandatory' will fail if there is an exiting statepart
+   * initMode === 'force' will overwrite any existing statepart
+   * @param statePartNameArg
+   * @param initialArg
+   * @param initMode
+   */
   public getStatePart<PayloadType>(
-    statePartNameArg: StatePartNameType,
+    statePartNameArg: string & StatePartNameType,
-    initialArg?: PayloadType
+    initialArg?: PayloadType,
+    initMode?: 'soft' | 'mandatory' | 'force'
   ): StatePart<StatePartNameType, PayloadType> {
     if (this.statePartMap[statePartNameArg as any]) {
-      if (initialArg) {
+      if (initialArg && (!initMode || initMode !== 'soft')) {
         throw new Error(
           `${statePartNameArg} already exists, yet you try to set an initial state again`
         );
       }
-      return this.statePartMap[statePartNameArg as any];
+      return this.statePartMap[statePartNameArg] as StatePart<StatePartNameType, PayloadType>;
     } else {
       if (!initialArg) {
         throw new Error(
@@ -44,9 +54,4 @@ export class Smartstate<StatePartNameType> {
     this.statePartMap[statePartName as any] = newState;
     return newState;
   }
-
-  /**
-   * dispatches an action on the main level
-   */
-  public dispatch() {}
 }

ts/smartstate.classes.statecollection.ts

@@ -1,12 +0,0 @@
-import * as plugins from './smartstate.plugins';
-import { StatePart } from './smartstate.classes.statepart';
-
-/**
- * A StatePartCollection is a collection of StateParts.
- * It can be used for expressing interest in a certain set of StateParts.
- */
-export class StatePartCollection<StatePartNameType, T> extends StatePart<StatePartNameType, T> {
-  constructor(nameArg: StatePartNameType) {
-    super(nameArg);
-  }
-}

ts/smartstate.classes.stateobservable.ts

@@ -1,13 +0,0 @@
-import * as plugins from './smartstate.plugins';
-
-/**
- * State observable observes a StatePart and notifies everyone interested
- */
-export class StateObservable {
-  /**
-   * creates an observable from a StateCollection
-   */
-  public static fromStatePartCollection(filterArg?: () => any) {}
-
-  constructor() {}
-}

ts/smartstate.classes.statepart.ts

@@ -1,13 +1,9 @@
 import * as plugins from './smartstate.plugins';
-
-import { Observable, Subject } from 'rxjs';
-import { startWith, takeUntil, map } from 'rxjs/operators';
-
 import { StateAction, IActionDef } from './smartstate.classes.stateaction';
 
 export class StatePart<TStatePartName, TStatePayload> {
   public name: TStatePartName;
-  public state = new Subject<TStatePayload>();
+  public state = new plugins.smartrx.rxjs.Subject<TStatePayload>();
   public stateStore: TStatePayload;
 
   constructor(nameArg: TStatePartName) {
@@ -34,20 +30,31 @@ export class StatePart<TStatePartName, TStatePayload> {
    * notifies of a change on the state
    */
   public notifyChange() {
+    const createStateHash = (stateArg: any) => {
+      return plugins.isohash.sha256FromString(plugins.smartjson.stringify(stateArg));
+    };
+    if (this.stateStore && this.lastStateNotificationPayloadHash && createStateHash(this.stateStore) === createStateHash(this.lastStateNotificationPayloadHash)) {
+      return;
+    } else {
+      this.lastStateNotificationPayloadHash = this.stateStore;
+    }
     this.state.next(this.stateStore);
   }
+  private lastStateNotificationPayloadHash: any;
 
   /**
    * selects a state or a substate
    */
-  public select<T = TStatePayload>(selectorFn?: (state: TStatePayload) => T): Observable<T> {
+  public select<T = TStatePayload>(
+    selectorFn?: (state: TStatePayload) => T
+  ): plugins.smartrx.rxjs.Observable<T> {
     if (!selectorFn) {
       selectorFn = (state: TStatePayload) => <T>(<any>state);
     }
 
     const mapped = this.state.pipe(
-      startWith(this.getState()),
+      plugins.smartrx.rxjs.ops.startWith(this.getState()),
-      map(stateArg => {
+      plugins.smartrx.rxjs.ops.map((stateArg) => {
         try {
           return selectorFn(stateArg);
         } catch (e) {
@@ -85,7 +92,7 @@ export class StatePart<TStatePartName, TStatePayload> {
   ): Promise<T> {
     const done = plugins.smartpromise.defer<T>();
     const selectedObservable = this.select(selectorFn);
-    const subscription = selectedObservable.subscribe(async value => {
+    const subscription = selectedObservable.subscribe(async (value) => {
       if (value) {
         done.resolve(value);
       }

ts/smartstate.plugins.ts

@@ -1,11 +1,7 @@
-import { Observable } from 'rxjs';
+import * as isohash from '@pushrocks/isohash';
-
+import * as smartjson from '@pushrocks/smartjson';
-const rxjsPart = {
+import * as smartobject from '@pushrocks/smartobject';
-  Observable
-};
-
-export { rxjsPart };
-
 import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartrx from '@pushrocks/smartrx';
 
-export { smartpromise };
+export { isohash, smartjson, smartobject, smartpromise, smartrx };