1.0.18

.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,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,127 +18,104 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
-snyk:
+audit:
+  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 config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - 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
 
 # ====================
 # 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:
@@ -146,5 +123,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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

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

package.json

@@ -1,27 +1,42 @@
 {
   "name": "@pushrocks/smartstate",
-  "version": "1.0.9",
+  "version": "1.0.18",
   "private": false,
   "description": "a package that handles state in a good way",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)",
+    "build": "(tsbuild && tsbundle npm)",
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.8",
+    "@gitzone/tsbuild": "^2.1.24",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tsbundle": "^1.0.69",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@gitzone/tstest": "^1.0.28",
-    "@types/node": "^11.9.4",
+    "@pushrocks/tapbundle": "^3.2.1",
-    "tslint": "^5.12.1",
+    "@types/node": "^14.0.5",
+    "tslint": "^6.1.2",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/lik": "^3.0.4",
+    "@pushrocks/lik": "^4.0.12",
-    "rxjs": "^6.4.0"
+    "@pushrocks/smartpromise": "^3.0.6",
-  }
+    "@pushrocks/smartrx": "^2.0.15",
+    "rxjs": "^6.5.5"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -8,7 +8,7 @@ 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)
+[![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)
 [![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)
@@ -18,9 +18,15 @@ a package that handles state in a good way
 
 ## 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.ts

@@ -36,14 +36,23 @@ tap.test('should select something', async () => {
     });
 });
 
-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/smartstate.classes.smartstate.ts

@@ -5,21 +5,21 @@ 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, unknown> } = {};
 
   constructor() {}
 
-  getStatePart<PayloadType>(
+  public getStatePart<PayloadType>(
-    statePartNameArg: StatePartNameType,
+    statePartNameArg: string & StatePartNameType,
     initialArg?: PayloadType
   ): StatePart<StatePartNameType, PayloadType> {
     if (this.statePartMap[statePartNameArg as any]) {
-      if (initialArg) {
+      if (initialArg  && Object.keys(initialArg).length > 0) {
         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 +30,11 @@ export class Smartstate<StatePartNameType> {
     }
   }
 
+  /**
+   * creates a statepart
+   * @param statePartName
+   * @param initialPayloadArg
+   */
   private createStatePart<PayloadType>(
     statePartName: StatePartNameType,
     initialPayloadArg: PayloadType
@@ -39,9 +44,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.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;
+  public name: TStatePartName;
-  state = new Subject<TStatePayload>();
+  public state = new plugins.smartrx.rxjs.Subject<TStatePayload>();
-  stateStore: 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,29 @@ export class StatePart<TStatePartName, TStatePayload> {
   /**
    * notifies of a change on the state
    */
-  notifyChange() {
+  public notifyChange() {
     this.state.next(this.stateStore);
   }
 
   /**
    * 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()),
+      plugins.smartrx.rxjs.ops.startWith(this.getState()),
-      map(selectorFn)
+      plugins.smartrx.rxjs.ops.map(stateArg => {
+        try {
+          return selectorFn(stateArg);
+        } catch (e) {
+          // Nothing here
+        }
+      })
     );
 
     return mapped;
@@ -56,17 +60,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,4 @@
-import { Observable } from 'rxjs';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartrx from '@pushrocks/smartrx';
 
-const rxjsPart = {
+export { smartpromise, smartrx };
-  Observable
-};
-
-export { rxjsPart };