1.0.22

.gitignore

@@ -1,6 +1,20 @@
 .nogit/
-node_modules/
+
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
 .yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,10 +1,10 @@
-# 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"
+  key: '$CI_BUILD_STAGE'
 
 stages:
   - security
@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -19,38 +22,42 @@ 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
+  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 --only=dev
+  tags:
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+testStable:
   stage: test
   script:
     - npmci npm prepare
@@ -60,7 +67,17 @@ testSTABLE:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
-  - notpriv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
 
 release:
   stage: release
@@ -70,6 +87,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -78,20 +96,16 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
+  only:
+    - tags
   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:
+    - lossless
     - docker
     - priv
 
@@ -102,18 +116,20 @@ trigger:
   only:
     - tags
   tags:
+    - 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:

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

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

npmextra.json

@@ -4,11 +4,12 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "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,27 +1,46 @@
 {
   "name": "@pushrocks/smartstate",
-  "version": "1.0.10",
+  "version": "1.0.22",
   "private": false,
   "description": "a package that handles state in a good way",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)",
-    "format": "(gitzone format)"
+    "build": "(tsbuild --web && tsbundle npm)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.8",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^11.9.4",
-    "tslint": "^5.12.1",
+    "@gitzone/tsbuild": "^2.1.29",
+    "@gitzone/tsbundle": "^1.0.89",
+    "@gitzone/tstest": "^1.0.60",
+    "@pushrocks/tapbundle": "^3.2.9",
+    "@types/node": "^17.0.10",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/lik": "^3.0.4",
-    "rxjs": "^6.4.0"
-  }
+    "@pushrocks/isohash": "^1.0.2",
+    "@pushrocks/lik": "^5.0.1",
+    "@pushrocks/smartjson": "^4.0.6",
+    "@pushrocks/smartobject": "^1.0.6",
+    "@pushrocks/smartpromise": "^3.1.6",
+    "@pushrocks/smartrx": "^2.0.20"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

readme.md

@@ -8,19 +8,32 @@ a package that handles state in a good way
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartstate/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/smartstate/badges/master/build.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)
-[![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)
-[![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/)
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartstate/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartstate/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartstate)](https://lossless.cloud)
+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). :)
+
 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.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,20 +30,29 @@ tap.test('should create a new StatePart', async () => {
 
 tap.test('should select something', async () => {
   testStatePart
-    .select(state => state.deep.hi)
-    .subscribe(substate => {
+    .select((state) => state.deep.hi)
+    .subscribe((substate) => {
       expect(substate).to.equal(2);
     });
 });
 
-tap.test('should dispatch a state action', async () => {
+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();
     currentState.currentFavorites.push(payload);
     return currentState;
   });
+  testStatePart
+    .waitUntilPresent((state) => {
+      return state.currentFavorites[0];
+    })
+    .then(() => {
+      done.resolve();
+    });
   await testStatePart.dispatchAction(addFavourite, 'my favourite things');
   expect(testStatePart.getState().currentFavorites).to.include('my favourite things');
+  await done.promise;
 });
 
 tap.start();

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

@@ -5,21 +5,31 @@ import { StatePart } from './smartstate.classes.statepart';
  * Smartstate takes care of providing state
  */
 export class Smartstate<StatePartNameType> {
-  statePartMap: { [key: string]: StatePart<StatePartNameType, any> } = {};
+  public statePartMap: { [key: string]: StatePart<StatePartNameType, any> } = {};
 
   constructor() {}
 
-  getStatePart<PayloadType>(
-    statePartNameArg: StatePartNameType,
-    initialArg?: PayloadType
+  /**
+   * 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: string & StatePartNameType,
+    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(
@@ -30,6 +40,11 @@ export class Smartstate<StatePartNameType> {
     }
   }
 
+  /**
+   * creates a statepart
+   * @param statePartName
+   * @param initialPayloadArg
+   */
   private createStatePart<PayloadType>(
     statePartName: StatePartNameType,
     initialPayloadArg: PayloadType
@@ -39,9 +54,4 @@ export class Smartstate<StatePartNameType> {
     this.statePartMap[statePartName as any] = newState;
     return newState;
   }
-
-  /**
-   * dispatches an action on the main level
-   */
-  dispatch() {}
 }

ts/smartstate.classes.stateaction.ts

@@ -9,5 +9,12 @@ export interface IActionDef<TStateType, TActionPayloadType> {
  * an actionmodifier for the state
  */
 export class StateAction<TStateType, TActionPayloadType> {
-  constructor(public actionDef: IActionDef<TStateType, TActionPayloadType>) {}
+  constructor(
+    public statePartRef: StatePart<any, any>,
+    public actionDef: IActionDef<TStateType, TActionPayloadType>
+  ) {}
+
+  public trigger(payload: TActionPayloadType) {
+    this.statePartRef.dispatchAction(this, payload);
+  }
 }

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,14 +1,10 @@
 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> {
-  name: TStatePartName;
-  state = new Subject<TStatePayload>();
-  stateStore: TStatePayload;
+  public name: TStatePartName;
+  public state = new plugins.smartrx.rxjs.Subject<TStatePayload>();
+  public stateStore: TStatePayload;
 
   constructor(nameArg: TStatePartName) {
     this.name = nameArg;
@@ -17,7 +13,7 @@ export class StatePart<TStatePartName, TStatePayload> {
   /**
    * gets the state from the state store
    */
-  getState(): TStatePayload {
+  public getState(): TStatePayload {
     return this.stateStore;
   }
 
@@ -25,7 +21,7 @@ export class StatePart<TStatePartName, TStatePayload> {
    * sets the stateStore to the new state
    * @param newStateArg
    */
-  setState(newStateArg: TStatePayload) {
+  public setState(newStateArg: TStatePayload) {
     this.stateStore = newStateArg;
     this.notifyChange();
   }
@@ -33,21 +29,38 @@ export class StatePart<TStatePartName, TStatePayload> {
   /**
    * notifies of a change on the state
    */
-  notifyChange() {
+  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
    */
-  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()),
-      map(selectorFn)
+      plugins.smartrx.rxjs.ops.startWith(this.getState()),
+      plugins.smartrx.rxjs.ops.map((stateArg) => {
+        try {
+          return selectorFn(stateArg);
+        } catch (e) {
+          // Nothing here
+        }
+      })
     );
 
     return mapped;
@@ -56,17 +69,36 @@ export class StatePart<TStatePartName, TStatePayload> {
   /**
    * creates an action capable of modifying the state
    */
-  createAction<TActionPayload>(
+  public createAction<TActionPayload>(
     actionDef: IActionDef<TStatePayload, TActionPayload>
   ): StateAction<TStatePayload, TActionPayload> {
-    return new StateAction(actionDef);
+    return new StateAction(this, actionDef);
   }
 
   /**
    * dispatches an action on the statepart level
    */
-  async dispatchAction<T>(stateAction: StateAction<TStatePayload, T>, actionPayload: T) {
+  public async dispatchAction<T>(stateAction: StateAction<TStatePayload, T>, actionPayload: T) {
     const newState = await stateAction.actionDef(this, actionPayload);
     this.setState(newState);
   }
+
+  /**
+   * waits until a certain part of the state becomes available
+   * @param selectorFn
+   */
+  public async waitUntilPresent<T = TStatePayload>(
+    selectorFn?: (state: TStatePayload) => T
+  ): Promise<T> {
+    const done = plugins.smartpromise.defer<T>();
+    const selectedObservable = this.select(selectorFn);
+    const subscription = selectedObservable.subscribe(async (value) => {
+      if (value) {
+        done.resolve(value);
+      }
+    });
+    const result = await done.promise;
+    subscription.unsubscribe();
+    return result;
+  }
 }

ts/smartstate.plugins.ts

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