2.0.6

.gitlab-ci.yml

@@ -13,31 +13,24 @@ stages:
   - metadata
 
 before_script:
-  - npm install -g @shipzone/npmci
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
 
 # ====================
 # security stage
 # ====================
-mirror:
+# ====================
-  stage: security
+# security stage
-  script:
+# ====================
-    - npmci git mirror
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
 auditProductionDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci npm prepare
+     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm install --production --ignore-scripts
+     - npmci command pnpm audit --audit-level=high --prod
-    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
+    - lossless
     - docker
   allow_failure: true
 
@@ -45,11 +38,10 @@ 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
+    - npmci command pnpm audit --audit-level=high --dev
   tags:
+    - lossless
     - docker
   allow_failure: true
 
@@ -60,7 +52,6 @@ auditDevDependencies:
 testStable:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci npm test
@@ -71,10 +62,9 @@ testStable:
 testBuild:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
-    - npmci command npm run build
+    - npmci npm build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
@@ -100,10 +90,9 @@ codequality:
   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
@@ -123,11 +112,9 @@ 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

license

@@ -1,4 +1,4 @@
-Copyright (c) 2019 Lossless GmbH (hello@lossless.com)
+Copyright (c) 2019 Task Venture Capital GmbH (hello@task.vc)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package.json

@@ -1,32 +1,32 @@
 {
   "name": "@pushrocks/smartstate",
-  "version": "1.0.22",
+  "version": "2.0.6",
   "private": false,
   "description": "a package that handles state in a good way",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild --web && tsbundle npm)"
+    "build": "(tsbuild --web --allowimplicitany && tsbundle npm)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.29",
+    "@gitzone/tsbuild": "^2.1.65",
-    "@gitzone/tsbundle": "^1.0.89",
+    "@gitzone/tsbundle": "^2.0.7",
-    "@gitzone/tstest": "^1.0.60",
+    "@gitzone/tsrun": "^1.2.39",
-    "@pushrocks/tapbundle": "^3.2.9",
+    "@gitzone/tstest": "^1.0.74",
-    "@types/node": "^17.0.10",
+    "@pushrocks/tapbundle": "^5.0.4",
-    "tslint": "^6.1.3",
+    "@types/node": "^18.15.11"
-    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/isohash": "^1.0.2",
+    "@pushrocks/isohash": "^2.0.0",
-    "@pushrocks/lik": "^5.0.1",
+    "@pushrocks/lik": "^6.0.2",
-    "@pushrocks/smartjson": "^4.0.6",
+    "@pushrocks/smartjson": "^5.0.5",
-    "@pushrocks/smartobject": "^1.0.6",
+    "@pushrocks/smartpromise": "^4.0.0",
-    "@pushrocks/smartpromise": "^3.1.6",
+    "@pushrocks/smartrx": "^3.0.0"
-    "@pushrocks/smartrx": "^2.0.20"
   },
   "files": [
     "ts/**/*",

readme.md

@@ -21,7 +21,6 @@ Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](htt
 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
 
@@ -33,7 +32,6 @@ We are always happy for code contributions. If you are not the code contributing
 
 For further information read the linked docs at the top of this readme.
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
 | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
-
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.node.ts

@@ -1,5 +1,5 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartstate from '../ts/index';
+import * as smartstate from '../ts/index.js';
 
 type TMyStateParts = 'testStatePart';
 interface TStatePartPayload {
@@ -14,7 +14,7 @@ let testStatePart: smartstate.StatePart<TMyStateParts, TStatePartPayload>;
 
 tap.test('should create a new SmartState', async () => {
   testState = new smartstate.Smartstate<TMyStateParts>();
-  expect(testState).to.be.instanceOf(smartstate.Smartstate);
+  expect(testState).toBeInstanceOf(smartstate.Smartstate);
 });
 
 tap.test('should create a new StatePart', async () => {
@@ -24,7 +24,7 @@ tap.test('should create a new StatePart', async () => {
       hi: 2,
     },
   });
-  expect(testStatePart).to.be.instanceOf(smartstate.StatePart);
+  expect(testStatePart).toBeInstanceOf(smartstate.StatePart);
   console.log(testStatePart);
 });
 
@@ -32,7 +32,7 @@ tap.test('should select something', async () => {
   testStatePart
     .select((state) => state.deep.hi)
     .subscribe((substate) => {
-      expect(substate).to.equal(2);
+      expect(substate).toEqual(2);
     });
 });
 
@@ -51,7 +51,7 @@ tap.test('should dispatch a state action', async (tools) => {
       done.resolve();
     });
   await testStatePart.dispatchAction(addFavourite, 'my favourite things');
-  expect(testStatePart.getState().currentFavorites).to.include('my favourite things');
+  expect(testStatePart.getState().currentFavorites).toContain('my favourite things');
   await done.promise;
 });
 

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartstate',
+  version: '2.0.6',
+  description: 'a package that handles state in a good way'
+}

ts/index.ts

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

ts/smartstate.classes.smartstate.ts

@@ -1,5 +1,5 @@
-import * as plugins from './smartstate.plugins';
+import * as plugins from './smartstate.plugins.js';
-import { StatePart } from './smartstate.classes.statepart';
+import { StatePart } from './smartstate.classes.statepart.js';
 
 /**
  * Smartstate takes care of providing state

ts/smartstate.classes.stateaction.ts

@@ -1,5 +1,5 @@
-import * as plugins from './smartstate.plugins';
+import * as plugins from './smartstate.plugins.js';
-import { StatePart } from './smartstate.classes.statepart';
+import { StatePart } from './smartstate.classes.statepart.js';
 
 export interface IActionDef<TStateType, TActionPayloadType> {
   (stateArg: StatePart<any, TStateType>, actionPayload: TActionPayloadType): Promise<TStateType>;

ts/smartstate.classes.statepart.ts

@@ -1,10 +1,11 @@
-import * as plugins from './smartstate.plugins';
+import * as plugins from './smartstate.plugins.js';
-import { StateAction, IActionDef } from './smartstate.classes.stateaction';
+import { StateAction, IActionDef } from './smartstate.classes.stateaction.js';
 
 export class StatePart<TStatePartName, TStatePayload> {
   public name: TStatePartName;
   public state = new plugins.smartrx.rxjs.Subject<TStatePayload>();
   public stateStore: TStatePayload;
+  private cumulativeDeferred = plugins.smartpromise.cumulativeDefer();
 
   constructor(nameArg: TStatePartName) {
     this.name = nameArg;
@@ -33,7 +34,11 @@ export class StatePart<TStatePartName, TStatePayload> {
     const createStateHash = (stateArg: any) => {
       return plugins.isohash.sha256FromString(plugins.smartjson.stringify(stateArg));
     };
-    if (this.stateStore && this.lastStateNotificationPayloadHash && createStateHash(this.stateStore) === createStateHash(this.lastStateNotificationPayloadHash)) {
+    if (
+      this.stateStore &&
+      this.lastStateNotificationPayloadHash &&
+      createStateHash(this.stateStore) === this.lastStateNotificationPayloadHash
+    ) {
       return;
     } else {
       this.lastStateNotificationPayloadHash = this.stateStore;
@@ -42,6 +47,14 @@ export class StatePart<TStatePartName, TStatePayload> {
   }
   private lastStateNotificationPayloadHash: any;
 
+  /**
+   * creates a cumulative notification by adding a change notification at the end of the call stack;
+   */
+  public notifyChangeCumulative() {
+    // TODO: check viability
+    setTimeout(() => this.state.next(this.stateStore), 0);
+  }
+
   /**
    * selects a state or a substate
    */
@@ -51,7 +64,6 @@ export class StatePart<TStatePartName, TStatePayload> {
     if (!selectorFn) {
       selectorFn = (state: TStatePayload) => <T>(<any>state);
     }
-
     const mapped = this.state.pipe(
       plugins.smartrx.rxjs.ops.startWith(this.getState()),
       plugins.smartrx.rxjs.ops.map((stateArg) => {
@@ -62,7 +74,6 @@ export class StatePart<TStatePartName, TStatePayload> {
         }
       })
     );
-
     return mapped;
   }
 
@@ -79,6 +90,7 @@ export class StatePart<TStatePartName, TStatePayload> {
    * dispatches an action on the statepart level
    */
   public async dispatchAction<T>(stateAction: StateAction<TStatePayload, T>, actionPayload: T) {
+    await this.cumulativeDeferred.promise;
     const newState = await stateAction.actionDef(this, actionPayload);
     this.setState(newState);
   }
@@ -101,4 +113,15 @@ export class StatePart<TStatePartName, TStatePayload> {
     subscription.unsubscribe();
     return result;
   }
+
+  /**
+   * is executed
+   */
+  public async stateSetup(
+    funcArg: (statePartArg?: StatePart<any, TStatePayload>) => Promise<TStatePayload>
+  ) {
+    const resultPromise = funcArg(this);
+    this.cumulativeDeferred.addPromise(resultPromise);
+    this.setState(await resultPromise);
+  }
 }

ts/smartstate.plugins.ts

@@ -1,7 +1,6 @@
 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';
 
-export { isohash, smartjson, smartobject, smartpromise, smartrx };
+export { isohash, smartjson, smartpromise, smartrx };

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"
-}