1.0.21

.gitlab-ci.yml

@@ -19,23 +19,35 @@ 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
+
+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 +62,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +73,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +93,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.vscode/settings.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartstate",
-  "version": "1.0.15",
+  "version": "1.0.21",
   "private": false,
   "description": "a package that handles state in a good way",
   "main": "dist_ts/index.js",
@@ -9,21 +9,22 @@
   "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.25",
-    "@gitzone/tstest": "^1.0.28",
+    "@gitzone/tsbundle": "^1.0.78",
-    "@pushrocks/tapbundle": "^3.2.1",
+    "@gitzone/tstest": "^1.0.52",
-    "@types/node": "^14.0.1",
+    "@pushrocks/tapbundle": "^3.2.9",
-    "tslint": "^6.1.2",
+    "@types/node": "^14.14.10",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/lik": "^4.0.0",
+    "@pushrocks/lik": "^4.0.20",
-    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartpromise": "^3.1.3",
-    "rxjs": "^6.5.5"
+    "@pushrocks/smartrx": "^2.0.19",
+    "rxjs": "^6.6.3"
   },
   "files": [
     "ts/**/*",
@@ -36,5 +37,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.both.ts

@@ -1,58 +1,58 @@
-import { expect, tap } from '@pushrocks/tapbundle';
+import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartstate from '../ts/index';
+import * as smartstate from '../ts/index';
-
+
-type TMyStateParts = 'testStatePart';
+type TMyStateParts = 'testStatePart';
-interface TStatePartPayload {
+interface TStatePartPayload {
-  currentFavorites: string[];
+  currentFavorites: string[];
-  deep: {
+  deep: {
-    hi: number;
+    hi: number;
-  };
+  };
-}
+}
-
+
-let testState: smartstate.Smartstate<TMyStateParts>;
+let testState: smartstate.Smartstate<TMyStateParts>;
-let testStatePart: smartstate.StatePart<TMyStateParts, TStatePartPayload>;
+let testStatePart: smartstate.StatePart<TMyStateParts, TStatePartPayload>;
-
+
-tap.test('should create a new SmartState', async () => {
+tap.test('should create a new SmartState', async () => {
-  testState = new smartstate.Smartstate<TMyStateParts>();
+  testState = new smartstate.Smartstate<TMyStateParts>();
-  expect(testState).to.be.instanceOf(smartstate.Smartstate);
+  expect(testState).to.be.instanceOf(smartstate.Smartstate);
-});
+});
-
+
-tap.test('should create a new StatePart', async () => {
+tap.test('should create a new StatePart', async () => {
-  testStatePart = testState.getStatePart<TStatePartPayload>('testStatePart', {
+  testStatePart = testState.getStatePart<TStatePartPayload>('testStatePart', {
-    currentFavorites: [],
+    currentFavorites: [],
-    deep: {
+    deep: {
-      hi: 2
+      hi: 2,
-    }
+    },
-  });
+  });
-  expect(testStatePart).to.be.instanceOf(smartstate.StatePart);
+  expect(testStatePart).to.be.instanceOf(smartstate.StatePart);
-  console.log(testStatePart);
+  console.log(testStatePart);
-});
+});
-
+
-tap.test('should select something', async () => {
+tap.test('should select something', async () => {
-  testStatePart
+  testStatePart
-    .select(state => state.deep.hi)
+    .select((state) => state.deep.hi)
-    .subscribe(substate => {
+    .subscribe((substate) => {
-      expect(substate).to.equal(2);
+      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 done = tools.defer();
-  const addFavourite = testStatePart.createAction<string>(async (statePart, payload) => {
+  const addFavourite = testStatePart.createAction<string>(async (statePart, payload) => {
-    const currentState = statePart.getState();
+    const currentState = statePart.getState();
-    currentState.currentFavorites.push(payload);
+    currentState.currentFavorites.push(payload);
-    return currentState;
+    return currentState;
-  });
+  });
-  testStatePart
+  testStatePart
-    .waitUntilPresent(state => {
+    .waitUntilPresent((state) => {
-      return state.currentFavorites[0];
+      return state.currentFavorites[0];
-    })
+    })
-    .then(() => {
+    .then(() => {
-      done.resolve();
+      done.resolve();
-    });
+    });
-  await testStatePart.dispatchAction(addFavourite, 'my favourite things');
+  await testStatePart.dispatchAction(addFavourite, 'my favourite things');
-  expect(testStatePart.getState().currentFavorites).to.include('my favourite things');
+  expect(testStatePart.getState().currentFavorites).to.include('my favourite things');
-  await done.promise;
+  await done.promise;
-});
+});
-
+
-tap.start();
+tap.start();

ts/index.ts

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

ts/smartstate.classes.smartstate.ts

@@ -1,52 +1,57 @@
-import * as plugins from './smartstate.plugins';
+import * as plugins from './smartstate.plugins';
-import { StatePart } from './smartstate.classes.statepart';
+import { StatePart } from './smartstate.classes.statepart';
-
+
-/**
+/**
- * Smartstate takes care of providing state
+ * Smartstate takes care of providing state
- */
+ */
-export class Smartstate<StatePartNameType> {
+export class Smartstate<StatePartNameType> {
-  public statePartMap: { [key: string]: StatePart<StatePartNameType, any> } = {};
+  public statePartMap: { [key: string]: StatePart<StatePartNameType, unknown> } = {};
-
+
-  constructor() {}
+  constructor() {}
-
+
-  public getStatePart<PayloadType>(
+  /**
-    statePartNameArg: StatePartNameType,
+   * Allows getting and initializing a new statepart
-    initialArg?: PayloadType
+   * initMode === 'soft' it will allow existing stateparts
-  ): StatePart<StatePartNameType, PayloadType> {
+   * initMode === 'mandatory' will fail if there is an exiting statepart
-    if (this.statePartMap[statePartNameArg as any]) {
+   * initMode === 'force' will overwrite any existing statepart
-      if (initialArg) {
+   * @param statePartNameArg
-        throw new Error(
+   * @param initialArg
-          `${statePartNameArg} already exists, yet you try to set an initial state again`
+   * @param initMode
-        );
+   */
-      }
+  public getStatePart<PayloadType>(
-      return this.statePartMap[statePartNameArg as any];
+    statePartNameArg: string & StatePartNameType,
-    } else {
+    initialArg?: PayloadType,
-      if (!initialArg) {
+    initMode?: 'soft' | 'mandatory' | 'force'
-        throw new Error(
+  ): StatePart<StatePartNameType, PayloadType> {
-          `${statePartNameArg} does not yet exist, yet you don't provide an initial state`
+    if (this.statePartMap[statePartNameArg as any]) {
-        );
+      if (initialArg && (!initMode || initMode !== 'soft')) {
-      }
+        throw new Error(
-      return this.createStatePart<PayloadType>(statePartNameArg, initialArg);
+          `${statePartNameArg} already exists, yet you try to set an initial state again`
-    }
+        );
-  }
+      }
-
+      return this.statePartMap[statePartNameArg] as StatePart<StatePartNameType, PayloadType>;
-  /**
+    } else {
-   * creates a statepart
+      if (!initialArg) {
-   * @param statePartName
+        throw new Error(
-   * @param initialPayloadArg
+          `${statePartNameArg} does not yet exist, yet you don't provide an initial state`
-   */
+        );
-  private createStatePart<PayloadType>(
+      }
-    statePartName: StatePartNameType,
+      return this.createStatePart<PayloadType>(statePartNameArg, initialArg);
-    initialPayloadArg: PayloadType
+    }
-  ): StatePart<StatePartNameType, PayloadType> {
+  }
-    const newState = new StatePart<StatePartNameType, PayloadType>(statePartName);
+
-    newState.setState(initialPayloadArg);
+  /**
-    this.statePartMap[statePartName as any] = newState;
+   * creates a statepart
-    return newState;
+   * @param statePartName
-  }
+   * @param initialPayloadArg
-
+   */
-  /**
+  private createStatePart<PayloadType>(
-   * dispatches an action on the main level
+    statePartName: StatePartNameType,
-   */
+    initialPayloadArg: PayloadType
-  public dispatch() {}
+  ): StatePart<StatePartNameType, PayloadType> {
-}
+    const newState = new StatePart<StatePartNameType, PayloadType>(statePartName);
+    newState.setState(initialPayloadArg);
+    this.statePartMap[statePartName as any] = newState;
+    return newState;
+  }
+}

ts/smartstate.classes.stateaction.ts

@@ -1,20 +1,20 @@
-import * as plugins from './smartstate.plugins';
+import * as plugins from './smartstate.plugins';
-import { StatePart } from './smartstate.classes.statepart';
+import { StatePart } from './smartstate.classes.statepart';
-
+
-export interface IActionDef<TStateType, TActionPayloadType> {
+export interface IActionDef<TStateType, TActionPayloadType> {
-  (stateArg: StatePart<any, TStateType>, actionPayload: TActionPayloadType): Promise<TStateType>;
+  (stateArg: StatePart<any, TStateType>, actionPayload: TActionPayloadType): Promise<TStateType>;
-}
+}
-
+
-/**
+/**
- * an actionmodifier for the state
+ * an actionmodifier for the state
- */
+ */
-export class StateAction<TStateType, TActionPayloadType> {
+export class StateAction<TStateType, TActionPayloadType> {
-  constructor(
+  constructor(
-    public statePartRef: StatePart<any, any>,
+    public statePartRef: StatePart<any, any>,
-    public actionDef: IActionDef<TStateType, TActionPayloadType>
+    public actionDef: IActionDef<TStateType, TActionPayloadType>
-  ) {}
+  ) {}
-
+
-  public trigger(payload: TActionPayloadType) {
+  public trigger(payload: TActionPayloadType) {
-    this.statePartRef.dispatchAction(this, payload);
+    this.statePartRef.dispatchAction(this, payload);
-  }
+  }
-}
+}

ts/smartstate.classes.statecollection.ts

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

ts/smartstate.classes.stateobservable.ts

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

ts/smartstate.classes.statepart.ts

@@ -1,97 +1,95 @@
-import * as plugins from './smartstate.plugins';
+import * as plugins from './smartstate.plugins';
-
+import { StateAction, IActionDef } from './smartstate.classes.stateaction';
-import { Observable, Subject } from 'rxjs';
+
-import { startWith, takeUntil, map } from 'rxjs/operators';
+export class StatePart<TStatePartName, TStatePayload> {
-
+  public name: TStatePartName;
-import { StateAction, IActionDef } from './smartstate.classes.stateaction';
+  public state = new plugins.smartrx.rxjs.Subject<TStatePayload>();
-
+  public stateStore: TStatePayload;
-export class StatePart<TStatePartName, TStatePayload> {
+
-  public name: TStatePartName;
+  constructor(nameArg: TStatePartName) {
-  public state = new Subject<TStatePayload>();
+    this.name = nameArg;
-  public stateStore: TStatePayload;
+  }
-
+
-  constructor(nameArg: TStatePartName) {
+  /**
-    this.name = nameArg;
+   * gets the state from the state store
-  }
+   */
-
+  public getState(): TStatePayload {
-  /**
+    return this.stateStore;
-   * gets the state from the state store
+  }
-   */
+
-  public getState(): TStatePayload {
+  /**
-    return this.stateStore;
+   * sets the stateStore to the new state
-  }
+   * @param newStateArg
-
+   */
-  /**
+  public setState(newStateArg: TStatePayload) {
-   * sets the stateStore to the new state
+    this.stateStore = newStateArg;
-   * @param newStateArg
+    this.notifyChange();
-   */
+  }
-  public setState(newStateArg: TStatePayload) {
+
-    this.stateStore = newStateArg;
+  /**
-    this.notifyChange();
+   * notifies of a change on the state
-  }
+   */
-
+  public notifyChange() {
-  /**
+    this.state.next(this.stateStore);
-   * notifies of a change on the state
+  }
-   */
+
-  public notifyChange() {
+  /**
-    this.state.next(this.stateStore);
+   * selects a state or a substate
-  }
+   */
-
+  public select<T = TStatePayload>(
-  /**
+    selectorFn?: (state: TStatePayload) => T
-   * selects a state or a substate
+  ): plugins.smartrx.rxjs.Observable<T> {
-   */
+    if (!selectorFn) {
-  public select<T = TStatePayload>(selectorFn?: (state: TStatePayload) => T): Observable<T> {
+      selectorFn = (state: TStatePayload) => <T>(<any>state);
-    if (!selectorFn) {
+    }
-      selectorFn = (state: TStatePayload) => <T>(<any>state);
+
-    }
+    const mapped = this.state.pipe(
-
+      plugins.smartrx.rxjs.ops.startWith(this.getState()),
-    const mapped = this.state.pipe(
+      plugins.smartrx.rxjs.ops.map((stateArg) => {
-      startWith(this.getState()),
+        try {
-      map(stateArg => {
+          return selectorFn(stateArg);
-        try {
+        } catch (e) {
-          return selectorFn(stateArg);
+          // Nothing here
-        } catch (e) {
+        }
-          // Nothing here
+      })
-        }
+    );
-      })
+
-    );
+    return mapped;
-
+  }
-    return mapped;
+
-  }
+  /**
-
+   * creates an action capable of modifying the state
-  /**
+   */
-   * creates an action capable of modifying the state
+  public createAction<TActionPayload>(
-   */
+    actionDef: IActionDef<TStatePayload, TActionPayload>
-  public createAction<TActionPayload>(
+  ): StateAction<TStatePayload, TActionPayload> {
-    actionDef: IActionDef<TStatePayload, TActionPayload>
+    return new StateAction(this, actionDef);
-  ): StateAction<TStatePayload, TActionPayload> {
+  }
-    return new StateAction(this, actionDef);
+
-  }
+  /**
-
+   * dispatches an action on the statepart level
-  /**
+   */
-   * dispatches an action on the statepart level
+  public async dispatchAction<T>(stateAction: StateAction<TStatePayload, T>, actionPayload: T) {
-   */
+    const newState = await stateAction.actionDef(this, actionPayload);
-  public async dispatchAction<T>(stateAction: StateAction<TStatePayload, T>, actionPayload: T) {
+    this.setState(newState);
-    const newState = await stateAction.actionDef(this, actionPayload);
+  }
-    this.setState(newState);
+
-  }
+  /**
-
+   * waits until a certain part of the state becomes available
-  /**
+   * @param selectorFn
-   * waits until a certain part of the state becomes available
+   */
-   * @param selectorFn
+  public async waitUntilPresent<T = TStatePayload>(
-   */
+    selectorFn?: (state: TStatePayload) => T
-  public async waitUntilPresent<T = TStatePayload>(
+  ): Promise<T> {
-    selectorFn?: (state: TStatePayload) => T
+    const done = plugins.smartpromise.defer<T>();
-  ): Promise<T> {
+    const selectedObservable = this.select(selectorFn);
-    const done = plugins.smartpromise.defer<T>();
+    const subscription = selectedObservable.subscribe(async (value) => {
-    const selectedObservable = this.select(selectorFn);
+      if (value) {
-    const subscription = selectedObservable.subscribe(async value => {
+        done.resolve(value);
-      if (value) {
+      }
-        done.resolve(value);
+    });
-      }
+    const result = await done.promise;
-    });
+    subscription.unsubscribe();
-    const result = await done.promise;
+    return result;
-    subscription.unsubscribe();
+  }
-    return result;
+}
-  }
-}

ts/smartstate.plugins.ts

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