fix(smartstate): Fix StateAction trigger method to properly return Promise

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @git.zone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitlab-ci.yml

@@ -1,137 +0,0 @@
-# gitzone ci_default
-image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-
-cache:
-  paths:
-    - .npmci_cache/
-  key: '$CI_BUILD_STAGE'
-
-stages:
-  - security
-  - test
-  - release
-  - metadata
-
-# ====================
-# security stage
-# ====================
-mirror:
-  stage: security
-  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 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 --only=dev
-  tags:
-    - docker
-  allow_failure: true
-
-# ====================
-# test stage
-# ====================
-
-testStable:
-  stage: test
-  script:
-    - npmci npm prepare
-    - npmci node install stable
-    - npmci npm install
-    - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - docker
-
-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
-  script:
-    - npmci node install stable
-    - npmci npm publish
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-# ====================
-# metadata stage
-# ====================
-codequality:
-  stage: metadata
-  allow_failure: true
-  only:
-    - tags
-  script:
-    - 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
-
-trigger:
-  stage: metadata
-  script:
-    - npmci trigger
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-pages:
-  stage: metadata
-  script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command tsdoc
-  tags:
-    - lossless
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-      - public
-  allow_failure: true

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "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"
+      "type": "node-terminal"
     }
   ]
 }

changelog.md

@@ -0,0 +1,168 @@
+# Changelog
+
+## 2025-07-19 - 2.0.22 - fix(smartstate)
+Fix StateAction trigger method to properly return Promise
+
+- Fixed StateAction.trigger() to return Promise<TStateType> as expected
+- Updated readme with improved documentation and examples
+- Replaced outdated legal information with Task Venture Capital GmbH details
+- Added implementation notes in readme.hints.md
+
+## 2025-06-19 - 2.0.21 - maintenance
+General updates and improvements
+
+## 2025-06-19 - 2.0.20 - fix(smartstate)
+Update build scripts and dependency versions; replace isohash with smarthashWeb for state hash generation
+
+- Adjusted package.json scripts to include verbose testing and modified build command
+- Bumped development dependencies (tsbuild, tsbundle, tsrun, tstest, tapbundle) to newer versions
+- Updated production dependencies (lik, smarthash, smartpromise, smartrx) with minor version bumps
+- Replaced import of isohash with smarthashWeb in state hash generation, ensuring consistency across modules
+
+## 2024-10-02 - 2.0.19 - fix(dependencies)
+Update dependencies to latest versions
+
+- Updated @git.zone/tsbuild to version ^2.1.84
+- Updated @git.zone/tsbundle to version ^2.0.15
+- Updated @git.zone/tsrun to version ^1.2.49
+- Updated @git.zone/tstest to version ^1.0.90
+- Updated @push.rocks/tapbundle to version ^5.3.0
+- Updated @types/node to version ^22.7.4
+- Updated @push.rocks/lik to version ^6.0.15
+- Updated @push.rocks/smartjson to version ^5.0.20
+- Updated @push.rocks/smartpromise to version ^4.0.4
+- Updated @push.rocks/smartrx to version ^3.0.7
+- Updated @push.rocks/webstore to version ^2.0.20
+
+## 2024-10-02 - 2.0.18 - fix(core)
+Fix type errors and typos in Smartstate class
+
+- Updated type annotation in Smartstate class to ensure StatePartNameType extends string.
+- Fixed a typo in the JSDoc comment: 'existing' instead of 'exiting'.
+- Corrected improper type casting in the Smartstate class.
+
+## 2024-05-29 - 2.0.17 - Maintenance
+General updates and improvements.
+
+- Updated project description
+- Multiple updates to `tsconfig`
+- Updated `npmextra.json` to include `githost`
+
+## 2023-10-07 - 2.0.16 - Maintenance
+General updates and improvements.
+
+- Core update
+
+## 2023-10-04 - 2.0.15 - Maintenance
+General updates and improvements.
+
+- Core update
+
+## 2023-10-03 - 2.0.14 to 2.0.10 - Maintenance
+General updates and improvements.
+
+- Core updates
+
+## 2023-09-11 - 2.0.9 - Maintenance
+General updates and improvements.
+
+- Core update
+
+## 2023-09-11 - 2.0.8 - Maintenance
+General updates and improvements.
+
+- Core update
+
+## 2023-07-27 - 2.0.7 - Maintenance
+General updates and improvements.
+
+- Core update
+
+## 2023-07-27 - 2.0.6 - Maintenance
+General updates and improvements.
+
+- Core update
+
+## 2023-04-13 - 2.0.5 - Maintenance
+General updates and improvements.
+
+- Core update
+
+## 2023-04-12 - 2.0.4 - Maintenance
+General updates and improvements.
+
+- Core update
+
+## 2023-04-04 - 2.0.3 to 2.0.1 - Maintenance
+General updates and improvements.
+
+- Core updates
+
+## 2023-03-15 - 2.0.0 - Major Update
+Core update with significant changes.
+
+## 2022-03-25 - 1.0.23 - Major Update
+Breaking changes and major updates.
+
+- SWITCH TO ESM
+
+## 2022-01-24 - 1.0.22 - Maintenance
+General updates and improvements.
+
+- Core updates
+
+## 2020-11-30 - 1.0.21 to 1.0.20 - Maintenance
+General updates and improvements.
+
+- Core updates
+
+## 2020-11-30 - 1.0.19 to 1.0.18 - Maintenance
+General updates and improvements.
+
+- Core updates
+
+## 2020-07-27 - 1.0.17 to 1.0.16 - Maintenance
+General updates and improvements.
+
+- Core updates
+
+## 2020-05-27 - 1.0.15 - Maintenance
+General updates and improvements.
+
+- Core update
+
+## 2020-05-27 - 1.0.14 - Maintenance
+General updates and improvements.
+
+- Core update
+
+## 2019-09-25 - 1.0.13 - Maintenance
+General updates and improvements.
+
+- Core update
+
+## 2019-09-25 - 1.0.12 - Maintenance
+General updates and improvements.
+
+- Core updates
+
+## 2019-04-30 - 1.0.11 to 1.0.10 - Maintenance
+General updates and improvements.
+
+- Core updates
+
+## 2019-03-22 - 1.0.9 - Maintenance
+General updates and improvements.
+
+- Core update
+
+## 2019-02-27 - 1.0.8 - Minor Update
+Minor updates and improvements.
+
+- Updated action generation
+- Core update
+
+## 2019-02-21 - 1.0.7 - Initial Release
+Initial release of the project.
+
+- Initial core implementation

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

npmextra.json

@@ -6,12 +6,27 @@
   "gitzone": {
     "projectType": "npm",
     "module": {
-      "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "githost": "code.foss.global",
+      "gitscope": "push.rocks",
       "gitrepo": "smartstate",
-      "shortDescription": "a package that handles state in a good way",
-      "npmPackagename": "@pushrocks/smartstate",
-      "license": "MIT"
+      "description": "A package for handling and managing state in applications.",
+      "npmPackagename": "@push.rocks/smartstate",
+      "license": "MIT",
+      "keywords": [
+        "state management",
+        "reactive programming",
+        "TypeScript",
+        "observables",
+        "web storage",
+        "state action",
+        "state selection",
+        "state notification",
+        "asynchronous state",
+        "cumulative notification"
+      ]
     }
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
   }
 }

package.json

@@ -1,30 +1,33 @@
 {
-  "name": "@pushrocks/smartstate",
-  "version": "1.0.21",
+  "name": "@push.rocks/smartstate",
+  "version": "2.0.22",
   "private": false,
-  "description": "a package that handles state in a good way",
+  "description": "A package for handling and managing state in applications.",
   "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)"
+    "test": "(tstest test/ --verbose)",
+    "build": "(tsbuild tsfolders --allowimplicitany && tsbundle npm)",
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsbundle": "^1.0.78",
-    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/tapbundle": "^3.2.9",
-    "@types/node": "^14.14.10",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0"
+    "@git.zone/tsbuild": "^2.6.4",
+    "@git.zone/tsbundle": "^2.4.0",
+    "@git.zone/tsrun": "^1.3.3",
+    "@git.zone/tstest": "^2.3.1",
+    "@push.rocks/tapbundle": "^6.0.3",
+    "@types/node": "^22.7.4"
   },
   "dependencies": {
-    "@pushrocks/lik": "^4.0.20",
-    "@pushrocks/smartpromise": "^3.1.3",
-    "@pushrocks/smartrx": "^2.0.19",
-    "rxjs": "^6.6.3"
+    "@push.rocks/lik": "^6.2.2",
+    "@push.rocks/smarthash": "^3.2.0",
+    "@push.rocks/smartjson": "^5.0.20",
+    "@push.rocks/smartpromise": "^4.2.3",
+    "@push.rocks/smartrx": "^3.0.10",
+    "@push.rocks/webstore": "^2.0.20"
   },
   "files": [
     "ts/**/*",
@@ -40,5 +43,23 @@
   ],
   "browserslist": [
     "last 1 chrome versions"
-  ]
+  ],
+  "keywords": [
+    "state management",
+    "reactive programming",
+    "TypeScript",
+    "observables",
+    "web storage",
+    "state action",
+    "state selection",
+    "state notification",
+    "asynchronous state",
+    "cumulative notification"
+  ],
+  "homepage": "https://code.foss.global/push.rocks/smartstate",
+  "repository": {
+    "type": "git",
+    "url": "https://code.foss.global/push.rocks/smartstate.git"
+  },
+  "packageManager": "pnpm@10.11.0+sha512.6540583f41cc5f628eb3d9773ecee802f4f9ef9923cc45b69890fb47991d4b092964694ec3a4f738a420c918a333062c8b925d312f42e4f0c263eb603551f977"
 }

readme.hints.md

@@ -0,0 +1,39 @@
+# Smartstate Implementation Notes
+
+## Current API (as of analysis)
+
+### State Part Initialization
+- State parts can be created with different init modes: 'soft', 'mandatory', 'force', 'persistent'
+- Persistent mode automatically calls init() internally - no need to call it manually
+- WebStore integration for persistent state uses IndexedDB
+
+### Actions
+- Actions are created with `createAction()` method
+- Two ways to dispatch actions:
+  1. `stateAction.trigger(payload)` - returns Promise<TStatePayload>
+  2. `await statePart.dispatchAction(stateAction, payload)` - returns Promise<TStatePayload>
+- Both methods now return the same Promise, providing flexibility in usage
+
+### State Management Methods
+- `select()` - returns Observable with startWith current state
+- `waitUntilPresent()` - waits for specific state condition
+- `stateSetup()` - async state initialization with cumulative defer
+- `notifyChangeCumulative()` - defers notification to end of call stack (no callback parameter)
+
+### State Hash Detection
+- Uses SHA256 hash to detect actual state changes
+- Bug: Currently stores the state object itself as hash instead of the actual hash
+- This prevents proper duplicate notification prevention
+
+### Type System
+- Can use either enums or string literal types for state part names
+- Test uses simple string types: `type TMyStateParts = 'testStatePart'`
+
+## Fixed Issues in Documentation
+1. Updated trigger() to return Promise (API enhancement)
+2. Added dispatchAction as alternative method
+3. Corrected notifyChangeCumulative usage
+4. Clarified persistent mode auto-init
+5. Added stateSetup documentation
+6. Fixed state hash detection description
+7. Both trigger() and dispatchAction() now return Promise for consistency

readme.md

@@ -1,39 +1,236 @@
-# @pushrocks/smartstate
-a package that handles state in a good way
+# @push.rocks/smartstate
+A package for handling and managing state in applications
 
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartstate)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartstate)
-* [github.com (source mirror)](https://github.com/pushrocks/smartstate)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartstate/)
+## Install
 
-## Status for master
+To install `@push.rocks/smartstate`, you can use pnpm (Performant Node Package Manager). Run the following command in your terminal:
 
-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)
+```bash
+pnpm install @push.rocks/smartstate --save
+```
+
+This will add `@push.rocks/smartstate` to your project's dependencies.
 
 ## Usage
 
-Use TypeScript for best in class intellisense.
+The `@push.rocks/smartstate` library provides an elegant way to handle state within your JavaScript or TypeScript projects, leveraging the power of Reactive Extensions (RxJS) and a structured state management strategy. In the following sections, we will explore the comprehensive capabilities of this package and how to effectively use them in various scenarios, ensuring a robust state management pattern in your applications.
 
-## Contribution
+### Getting Started
 
-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). :)
+First, let's import the necessary components from the library:
 
-For further information read the linked docs at the top of this readme.
+```typescript
+import { Smartstate, StatePart, StateAction } from '@push.rocks/smartstate';
+```
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+### Creating a SmartState Instance
 
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
+`Smartstate` acts as the container for your state parts. You can consider it as the root of your state management structure.
+
+```typescript
+const myAppSmartState = new Smartstate<YourStatePartNamesEnum>();
+```
+
+### Understanding Init Modes
+
+When creating state parts, you can specify different initialization modes:
+
+- **`'soft'`** - Allows existing state parts to remain (default behavior)
+- **`'mandatory'`** - Fails if there's an existing state part with the same name
+- **`'force'`** - Overwrites any existing state part
+- **`'persistent'`** - Enables WebStore persistence using IndexedDB
+
+### Defining State Parts
+
+State parts represent separable sections of your state, making it easier to manage and modularize. For example, you may have a state part for user data and another for application settings. 
+
+Define state part names using either enums or string literal types:
+
+```typescript
+// Option 1: Using enums
+enum AppStateParts {
+  UserState = 'UserState',
+  SettingsState = 'SettingsState'
+}
+
+// Option 2: Using string literal types (simpler approach)
+type AppStateParts = 'UserState' | 'SettingsState';
+```
+
+Now, let's create a state part within our `myAppSmartState` instance:
+
+```typescript
+interface IUserState {
+  isLoggedIn: boolean;
+  username?: string;
+}
+
+const userStatePart = await myAppSmartState.getStatePart<IUserState>(
+  AppStateParts.UserState,
+  { isLoggedIn: false }, // Initial state
+  'soft' // Init mode (optional, defaults to 'soft')
+);
+
+// Note: Persistent state parts are automatically initialized internally
+```
+
+### Subscribing to State Changes
+
+You can subscribe to changes in a state part to perform actions accordingly:
+
+```typescript
+userStatePart.select().subscribe((currentState) => {
+  console.log(`User Logged In: ${currentState.isLoggedIn}`);
+});
+```
+
+If you need to select a specific part of your state, you can pass a selector function:
+
+```typescript
+userStatePart.select(state => state.username).subscribe((username) => {
+  if (username) {
+    console.log(`Current user: ${username}`);
+  }
+});
+```
+
+### Modifying State with Actions
+
+Create actions to modify the state in a controlled manner:
+
+```typescript
+interface ILoginPayload {
+  username: string;
+}
+
+const loginUserAction = userStatePart.createAction<ILoginPayload>(async (statePart, payload) => {
+  return { ...statePart.getState(), isLoggedIn: true, username: payload.username };
+});
+
+// Dispatch the action to update the state
+loginUserAction.trigger({ username: 'johnDoe' });
+// or await the result
+const newState = await loginUserAction.trigger({ username: 'johnDoe' });
+```
+
+### Dispatching Actions
+
+There are two ways to dispatch actions:
+
+```typescript
+// Method 1: Using trigger on the action (returns promise)
+const newState = await loginUserAction.trigger({ username: 'johnDoe' });
+// or fire and forget
+loginUserAction.trigger({ username: 'johnDoe' });
+
+// Method 2: Using dispatchAction on the state part (returns promise)
+const newState = await userStatePart.dispatchAction(loginUserAction, { username: 'johnDoe' });
+```
+
+Both methods return a Promise with the new state, giving you flexibility in how you handle the result.
+
+### Additional State Methods
+
+`StatePart` provides several useful methods for state management:
+
+```typescript
+// Wait for a specific state condition
+await userStatePart.waitUntilPresent();
+
+// Wait for a specific property to be present
+await userStatePart.waitUntilPresent(state => state.username);
+
+// Setup initial state with async operations
+await userStatePart.stateSetup(async (statePart) => {
+  // Perform async initialization
+  const userData = await fetchUserData();
+  return { ...statePart.getState(), ...userData };
+});
+
+// Defer notification to end of call stack
+userStatePart.notifyChangeCumulative();
+```
+
+### Persistent State with WebStore
+
+`Smartstate` supports persistent states using WebStore (IndexedDB-based storage), allowing you to maintain state across sessions:
+
+```typescript
+const settingsStatePart = await myAppSmartState.getStatePart<ISettingsState>(
+  AppStateParts.SettingsState,
+  { theme: 'light' }, // Initial state
+  'persistent' // Mode
+);
+
+// Note: init() is called automatically for persistent mode
+```
+
+Persistent state automatically:
+- Saves state changes to IndexedDB
+- Restores state on application restart
+- Manages storage with configurable database and store names
+
+### Performance Optimization
+
+`Smartstate` includes built-in performance optimizations:
+
+- **State Change Detection**: Detects actual state changes to prevent unnecessary notifications when state values haven't truly changed
+- **Cumulative Notifications**: Batch multiple state changes into a single notification using `notifyChangeCumulative()`
+- **Selective Subscriptions**: Use selectors to subscribe only to specific state properties
+
+### RxJS Integration
+
+`Smartstate` leverages RxJS for reactive state management:
+
+```typescript
+// State is exposed as an RxJS Subject
+const stateObservable = userStatePart.select();
+
+// Automatically starts with current state value
+stateObservable.subscribe((state) => {
+  console.log('Current state:', state);
+});
+
+// Use selectors for specific properties
+userStatePart.select(state => state.username)
+  .pipe(
+    distinctUntilChanged(),
+    filter(username => username !== undefined)
+  )
+  .subscribe(username => {
+    console.log('Username changed:', username);
+  });
+```
+
+### Comprehensive Usage
+
+Putting it all together, `@push.rocks/smartstate` offers a flexible and powerful pattern for managing application state. By modularizing state parts, subscribing to state changes, and controlling state modifications through actions, developers can maintain a clean and scalable architecture. Combining these strategies with persistent states unlocks the full potential for creating dynamic and user-friendly applications.
+
+Key features:
+- **Type-safe state management** with full TypeScript support
+- **Reactive state updates** using RxJS observables
+- **Persistent state** with IndexedDB storage
+- **Performance optimized** with state hash detection
+- **Modular architecture** with separate state parts
+- **Action-based updates** for predictable state modifications
+
+For more complex scenarios, consider combining multiple state parts, creating hierarchical state structures, and integrating with other state management solutions as needed. With `@push.rocks/smartstate`, the possibilities are vast, empowering you to tailor the state management approach to fit the unique requirements of your project.
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

test/test.both.ts

@@ -1,5 +1,5 @@
-import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartstate from '../ts/index';
+import { expect, tap } from '@push.rocks/tapbundle';
+import * as smartstate from '../ts/index.js';
 
 type TMyStateParts = 'testStatePart';
 interface TStatePartPayload {
@@ -14,17 +14,17 @@ 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 () => {
-  testStatePart = testState.getStatePart<TStatePartPayload>('testStatePart', {
+  testStatePart = await testState.getStatePart<TStatePartPayload>('testStatePart', {
     currentFavorites: [],
     deep: {
       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 @push.rocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smartstate',
+  version: '2.0.20',
+  description: 'A package for handling and managing state in applications.'
+}

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';
+export * from './smartstate.classes.smartstate.js';
+export * from './smartstate.classes.statepart.js';
+export * from './smartstate.classes.stateaction.js';

ts/smartstate.classes.smartstate.ts

@@ -1,29 +1,31 @@
-import * as plugins from './smartstate.plugins';
-import { StatePart } from './smartstate.classes.statepart';
+import * as plugins from './smartstate.plugins.js';
+import { StatePart } from './smartstate.classes.statepart.js';
+
+export type TInitMode = 'soft' | 'mandatory' | 'force' | 'persistent';
 
 /**
  * Smartstate takes care of providing state
  */
-export class Smartstate<StatePartNameType> {
-  public statePartMap: { [key: string]: StatePart<StatePartNameType, unknown> } = {};
+export class Smartstate<StatePartNameType extends string> {
+  public statePartMap: { [key in StatePartNameType]?: StatePart<StatePartNameType, any> } = {};
 
   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 === 'mandatory' will fail if there is an existing statepart
    * initMode === 'force' will overwrite any existing statepart
    * @param statePartNameArg
    * @param initialArg
    * @param initMode
    */
-  public getStatePart<PayloadType>(
-    statePartNameArg: string & StatePartNameType,
+  public async getStatePart<PayloadType>(
+    statePartNameArg: StatePartNameType,
     initialArg?: PayloadType,
-    initMode?: 'soft' | 'mandatory' | 'force'
-  ): StatePart<StatePartNameType, PayloadType> {
-    if (this.statePartMap[statePartNameArg as any]) {
+    initMode?: TInitMode
+  ): Promise<StatePart<StatePartNameType, PayloadType>> {
+    if (this.statePartMap[statePartNameArg]) {
       if (initialArg && (!initMode || initMode !== 'soft')) {
         throw new Error(
           `${statePartNameArg} already exists, yet you try to set an initial state again`
@@ -36,22 +38,36 @@ export class Smartstate<StatePartNameType> {
           `${statePartNameArg} does not yet exist, yet you don't provide an initial state`
         );
       }
-      return this.createStatePart<PayloadType>(statePartNameArg, initialArg);
+      return this.createStatePart<PayloadType>(statePartNameArg, initialArg, initMode);
     }
   }
 
   /**
-   * creates a statepart
+   * Creates a statepart
    * @param statePartName
    * @param initialPayloadArg
    */
-  private createStatePart<PayloadType>(
+  private async createStatePart<PayloadType>(
     statePartName: StatePartNameType,
-    initialPayloadArg: PayloadType
-  ): StatePart<StatePartNameType, PayloadType> {
-    const newState = new StatePart<StatePartNameType, PayloadType>(statePartName);
-    newState.setState(initialPayloadArg);
-    this.statePartMap[statePartName as any] = newState;
+    initialPayloadArg: PayloadType,
+    initMode?: TInitMode
+  ): Promise<StatePart<StatePartNameType, PayloadType>> {
+    const newState = new StatePart<StatePartNameType, PayloadType>(
+      statePartName,
+      initMode === 'persistent'
+        ? {
+            dbName: 'smartstate',
+            storeName: statePartName,
+          }
+        : null
+    );
+    await newState.init();
+    const currentState = newState.getState();
+    await newState.setState({
+      ...initialPayloadArg,
+      ...currentState,
+    });
+    this.statePartMap[statePartName] = newState;
     return newState;
   }
 }

ts/smartstate.classes.stateaction.ts

@@ -1,5 +1,5 @@
-import * as plugins from './smartstate.plugins';
-import { StatePart } from './smartstate.classes.statepart';
+import * as plugins from './smartstate.plugins.js';
+import { StatePart } from './smartstate.classes.statepart.js';
 
 export interface IActionDef<TStateType, TActionPayloadType> {
   (stateArg: StatePart<any, TStateType>, actionPayload: TActionPayloadType): Promise<TStateType>;
@@ -14,7 +14,7 @@ export class StateAction<TStateType, TActionPayloadType> {
     public actionDef: IActionDef<TStateType, TActionPayloadType>
   ) {}
 
-  public trigger(payload: TActionPayloadType) {
-    this.statePartRef.dispatchAction(this, payload);
+  public trigger(payload: TActionPayloadType): Promise<TStateType> {
+    return 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,13 +1,37 @@
-import * as plugins from './smartstate.plugins';
-import { StateAction, IActionDef } from './smartstate.classes.stateaction';
+import * as plugins from './smartstate.plugins.js';
+import { StateAction, type 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) {
+  private webStoreOptions: plugins.webstore.IWebStoreOptions;
+  private webStore: plugins.webstore.WebStore<TStatePayload> | null = null; // Add WebStore instance
+
+  constructor(nameArg: TStatePartName, webStoreOptionsArg?: plugins.webstore.IWebStoreOptions) {
     this.name = nameArg;
+
+    // Initialize WebStore if webStoreOptions are provided
+    if (webStoreOptionsArg) {
+      this.webStoreOptions = webStoreOptionsArg;
+    }
+  }
+
+  /**
+   * initializes the webstore
+   */
+  public async init() {
+    if (this.webStoreOptions) {
+      this.webStore = new plugins.webstore.WebStore<TStatePayload>(this.webStoreOptions);
+      await this.webStore.init();
+      const storedState = await this.webStore.get(String(this.name));
+      if (storedState) {
+        this.stateStore = storedState;
+        this.notifyChange();
+      }
+    }
   }
 
   /**
@@ -21,17 +45,44 @@ export class StatePart<TStatePartName, TStatePayload> {
    * sets the stateStore to the new state
    * @param newStateArg
    */
-  public setState(newStateArg: TStatePayload) {
+  public async setState(newStateArg: TStatePayload) {
     this.stateStore = newStateArg;
     this.notifyChange();
+    
+    // Save state to WebStore if initialized
+    if (this.webStore) {
+      await this.webStore.set(String(this.name), newStateArg);
+    }
+    return this.stateStore;
   }
 
   /**
    * notifies of a change on the state
    */
   public notifyChange() {
+    const createStateHash = (stateArg: any) => {
+      return plugins.smarthashWeb.sha256FromString(plugins.smartjson.stringify(stateArg));
+    };
+    if (
+      this.stateStore &&
+      this.lastStateNotificationPayloadHash &&
+      createStateHash(this.stateStore) === this.lastStateNotificationPayloadHash
+    ) {
+      return;
+    } else {
+      this.lastStateNotificationPayloadHash = this.stateStore;
+    }
     this.state.next(this.stateStore);
   }
+  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
@@ -42,7 +93,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) => {
@@ -53,7 +103,6 @@ export class StatePart<TStatePartName, TStatePayload> {
         }
       })
     );
-
     return mapped;
   }
 
@@ -69,9 +118,11 @@ export class StatePart<TStatePartName, TStatePayload> {
   /**
    * dispatches an action on the statepart level
    */
-  public async dispatchAction<T>(stateAction: StateAction<TStatePayload, T>, actionPayload: T) {
+  public async dispatchAction<T>(stateAction: StateAction<TStatePayload, T>, actionPayload: T): Promise<TStatePayload> {
+    await this.cumulativeDeferred.promise;
     const newState = await stateAction.actionDef(this, actionPayload);
-    this.setState(newState);
+    await this.setState(newState);
+    return this.getState();
   }
 
   /**
@@ -92,4 +143,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,4 +1,7 @@
-import * as smartpromise from '@pushrocks/smartpromise';
-import * as smartrx from '@pushrocks/smartrx';
+import * as smarthashWeb from '@push.rocks/smarthash/web';
+import * as smartjson from '@push.rocks/smartjson';
+import * as smartpromise from '@push.rocks/smartpromise';
+import * as smartrx from '@push.rocks/smartrx';
+import * as webstore from '@push.rocks/webstore';
 
-export { smartpromise, smartrx };
+export { smarthashWeb, smartjson, smartpromise, smartrx, webstore };

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}

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