Compare commits

...

37 Commits

Author SHA1 Message Date
1d74a7f465 2.0.27
Some checks failed
Default (tags) / security (push) Successful in 44s
Default (tags) / test (push) Successful in 1m13s
Default (tags) / release (push) Failing after 59s
Default (tags) / metadata (push) Successful in 1m15s
2025-09-12 22:08:35 +00:00
81ca32cdef fix(StatePart): Use stable JSON stringify for state hashing; update dependencies and tooling 2025-09-12 22:08:35 +00:00
07bfbfd393 2.0.26
Some checks failed
Default (tags) / security (push) Successful in 40s
Default (tags) / test (push) Successful in 1m6s
Default (tags) / release (push) Failing after 58s
Default (tags) / metadata (push) Successful in 1m15s
2025-08-16 13:09:13 +00:00
aa411072f2 fix(ci): checksum 2025-08-16 13:09:13 +00:00
02575e8baf fix(core): Fix state initialization, hash detection, and validation - v2.0.25
Some checks failed
Default (tags) / security (push) Successful in 42s
Default (tags) / test (push) Successful in 1m8s
Default (tags) / release (push) Failing after 59s
Default (tags) / metadata (push) Successful in 1m8s
2025-07-29 19:26:03 +00:00
09fc53aaff fix(core): Multiple fixes and improvements for version 2.0.24
Some checks failed
Default (tags) / security (push) Successful in 43s
Default (tags) / test (push) Successful in 1m1s
Default (tags) / release (push) Failing after 58s
Default (tags) / metadata (push) Successful in 1m9s
2025-07-19 08:19:59 +00:00
bcb58dd012 chore(workspace): Add pnpm workspace configuration for built-only dependencies 2025-07-19 08:16:36 +00:00
f0064bd94b 2.0.23
Some checks failed
Default (tags) / security (push) Successful in 46s
Default (tags) / test (push) Successful in 51s
Default (tags) / release (push) Failing after 45s
Default (tags) / metadata (push) Successful in 55s
2025-07-19 07:30:55 +00:00
e9c527a9dc fix(ci): Update CI workflows to use new container registry and npmci package name 2025-07-19 07:30:55 +00:00
a47d8bb3c7 fix(smartstate): Fix StateAction trigger method to properly return Promise
Some checks failed
Default (tags) / security (push) Failing after 27s
Default (tags) / test (push) Failing after 13s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2025-07-19 07:18:53 +00:00
aa6766ef36 2.0.21 2025-07-01 06:50:35 +00:00
b0442e1227 update readme 2025-07-01 06:50:15 +00:00
0f1eb6eb27 2.0.20 2025-06-19 23:57:56 +00:00
dd18ef94bd fix(smartstate): Update build scripts and dependency versions; replace isohash with smarthashWeb for state hash generation 2025-06-19 23:57:56 +00:00
a0189921a5 2.0.19 2024-10-02 17:49:56 +02:00
b409f1aa55 fix(dependencies): Update dependencies to latest versions 2024-10-02 17:49:56 +02:00
57553aa7c8 2.0.18 2024-10-02 15:59:41 +02:00
c302cbdae4 fix(core): Fix type errors and typos in Smartstate class 2024-10-02 15:59:41 +02:00
fd6e3ba8b1 update description 2024-05-29 14:16:33 +02:00
8c3a7aa637 update tsconfig 2024-04-14 18:24:08 +02:00
8c0125a8c0 update tsconfig 2024-04-01 21:41:21 +02:00
40f3ffbdfb update npmextra.json: githost 2024-04-01 19:59:48 +02:00
d4e01a73d3 update npmextra.json: githost 2024-03-30 21:48:48 +01:00
641e77892a 2.0.17 2023-10-07 12:23:03 +02:00
0c1211778b fix(core): update 2023-10-07 12:23:03 +02:00
024f7f4f8f 2.0.16 2023-10-04 07:59:13 +02:00
8f1cba5078 fix(core): update 2023-10-04 07:59:12 +02:00
188f8057bf 2.0.15 2023-10-03 19:19:54 +02:00
99cb86258e fix(core): update 2023-10-03 19:19:54 +02:00
83976fa3f4 2.0.14 2023-10-03 16:20:35 +02:00
fe81307ca6 fix(core): update 2023-10-03 16:20:34 +02:00
3a119b50a2 2.0.13 2023-10-03 13:19:39 +02:00
d3332ccb3f fix(core): update 2023-10-03 13:19:38 +02:00
776eba09e9 2.0.12 2023-10-03 12:47:38 +02:00
b41ff5d495 fix(core): update 2023-10-03 12:47:38 +02:00
5f5f9db884 2.0.11 2023-10-03 12:47:13 +02:00
876042b446 fix(core): update 2023-10-03 12:47:12 +02:00
16 changed files with 11310 additions and 4253 deletions

View File

@@ -6,8 +6,8 @@ on:
- '**'
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
IMAGE: code.foss.global/host.today/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@code.foss.global/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
@@ -26,7 +26,7 @@ jobs:
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
pnpm install -g @ship.zone/npmci
- name: Run npm prepare
run: npmci npm prepare

View File

@@ -6,8 +6,8 @@ on:
- '*'
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
IMAGE: code.foss.global/host.today/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@code.foss.global/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
@@ -26,7 +26,7 @@ jobs:
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Audit production dependencies
@@ -54,7 +54,7 @@ jobs:
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Test stable
@@ -82,7 +82,7 @@ jobs:
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Release
@@ -104,7 +104,7 @@ jobs:
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Code quality

209
changelog.md Normal file
View File

@@ -0,0 +1,209 @@
# Changelog
## 2025-09-12 - 2.0.27 - fix(StatePart)
Use stable JSON stringify for state hashing; update dependencies and tooling
- Replace smartjson.stringify with smartjson.stableOneWayStringify when creating SHA256 state hashes to ensure deterministic hashing and avoid duplicate notifications for semantically identical states.
- Bump runtime dependencies: @push.rocks/smarthash -> ^3.2.6, @push.rocks/smartjson -> ^5.2.0.
- Bump dev tooling versions: @git.zone/tsbuild -> ^2.6.8, @git.zone/tsbundle -> ^2.5.1, @git.zone/tstest -> ^2.3.8.
- Add local .claude/settings.local.json configuration for allowed permissions (local tooling/settings file).
## 2025-08-16 - 2.0.26 - fix(ci)
Add local Claude settings file to allow helper permissions for common local commands
- Added .claude/settings.local.json to grant local helper permissions for tooling
- Allowed commands: Bash(tsx:*), Bash(tstest test:*), Bash(git add:*), Bash(git tag:*)
- No changes to source code or runtime behavior; tooling/config only
## 2025-07-29 - 2.0.25 - fix(core)
Major state initialization and validation improvements
- Fixed state hash bug: Now properly compares hash values instead of storing state objects
- Fixed state initialization merge order: Initial state now correctly takes precedence over stored state
- Improved type safety: stateStore properly typed as potentially undefined
- Simplified init mode logic with clear behavior for 'soft', 'mandatory', 'force', and 'persistent'
- Added state validation with extensible validateState() method
- Made notifyChange() async to support proper hash comparison
- Enhanced select() to filter undefined states automatically
- Added comprehensive test suite for state initialization scenarios
- Updated documentation with clearer examples and improved readme
## 2025-07-19 - 2.0.24 - fix(core)
Multiple fixes and improvements
- Fixed StateAction trigger method to properly return Promise<TStateType>
- Updated CI workflows to use new container registry and npmci package name
- Added pnpm workspace configuration for built-only dependencies
## 2025-07-19 - 2.0.23 - fix(ci)
Update CI workflows to use new container registry and npmci package name
- Changed CI image from 'registry.gitlab.com/hosttoday/ht-docker-node:npmci' to 'code.foss.global/host.today/ht-docker-node:npmci'
- Replaced npmci installation command from '@shipzone/npmci' to '@ship.zone/npmci' in workflow configurations
## 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

View File

@@ -6,12 +6,27 @@
"gitzone": {
"projectType": "npm",
"module": {
"githost": "gitlab.com",
"githost": "code.foss.global",
"gitscope": "push.rocks",
"gitrepo": "smartstate",
"description": "a package that handles state in a good way",
"description": "A package for handling and managing state in applications.",
"npmPackagename": "@push.rocks/smartstate",
"license": "MIT"
"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"
}
}

View File

@@ -1,33 +1,33 @@
{
"name": "@push.rocks/smartstate",
"version": "2.0.10",
"version": "2.0.27",
"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 --allowimplicitany && tsbundle npm)",
"test": "(tstest test/ --verbose)",
"build": "(tsbuild tsfolders --allowimplicitany && tsbundle npm)",
"buildDocs": "tsdoc"
},
"devDependencies": {
"@git.zone/tsbuild": "^2.1.70",
"@git.zone/tsbundle": "^2.0.8",
"@git.zone/tsrun": "^1.2.46",
"@git.zone/tstest": "^1.0.81",
"@push.rocks/tapbundle": "^5.0.15",
"@types/node": "^20.8.0"
"@git.zone/tsbuild": "^2.6.8",
"@git.zone/tsbundle": "^2.5.1",
"@git.zone/tsrun": "^1.3.3",
"@git.zone/tstest": "^2.3.8",
"@push.rocks/tapbundle": "^6.0.3",
"@types/node": "^22.7.4"
},
"dependencies": {
"@push.rocks/isohash": "^2.0.1",
"@push.rocks/lik": "^6.0.5",
"@push.rocks/smartjson": "^5.0.10",
"@push.rocks/smartpromise": "^4.0.3",
"@push.rocks/smartrx": "^3.0.6",
"@push.rocks/webstore": "^2.0.13"
"@push.rocks/lik": "^6.2.2",
"@push.rocks/smarthash": "^3.2.6",
"@push.rocks/smartjson": "^5.2.0",
"@push.rocks/smartpromise": "^4.2.3",
"@push.rocks/smartrx": "^3.0.10",
"@push.rocks/webstore": "^2.0.20"
},
"files": [
"ts/**/*",
@@ -43,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"
}

14542
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

4
pnpm-workspace.yaml Normal file
View File

@@ -0,0 +1,4 @@
onlyBuiltDependencies:
- esbuild
- mongodb-memory-server
- puppeteer

52
readme.hints.md Normal file
View File

@@ -0,0 +1,52 @@
# Smartstate Implementation Notes
## Current API (as of v2.0.24+)
### State Part Initialization
- State parts can be created with different init modes: 'soft' (default), 'mandatory', 'force', 'persistent'
- 'soft' - returns existing state part if exists, creates new if not
- 'mandatory' - requires state part to not exist, fails if it does
- 'force' - always creates new state part, overwriting any existing
- 'persistent' - like 'soft' but with WebStore persistence (IndexedDB)
- Persistent mode automatically calls init() internally - no need to call it manually
- State merge order fixed: initial state takes precedence over stored state
### 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 return the same Promise, providing flexibility in usage
### State Management Methods
- `select()` - returns Observable with startWith current state, filters undefined states
- `waitUntilPresent()` - waits for specific state condition
- `stateSetup()` - async state initialization with cumulative defer
- `notifyChangeCumulative()` - defers notification to end of call stack
- `getState()` - returns current state or undefined
- `setState()` - validates state before setting, notifies only on actual changes
### State Hash Detection
- Uses SHA256 hash to detect actual state changes
- Fixed: Hash comparison now properly awaits async hash calculation
- Prevents duplicate notifications for identical state values
- `notifyChange()` is now async to support proper hash comparison
### State Validation
- Basic validation ensures state is not null/undefined
- `validateState()` method can be overridden in subclasses for custom validation
- Validation runs on both setState() and when loading from persistent storage
### Type System
- Can use either enums or string literal types for state part names
- Test uses simple string types: `type TMyStateParts = 'testStatePart'`
- State can be undefined initially, handled properly in select() and other methods
## Recent Fixes (v2.0.24+)
1. Fixed state hash bug - now properly compares hash values instead of promises
2. Fixed state initialization merge order - initial state now takes precedence
3. Ensured stateStore is properly typed as potentially undefined
4. Simplified init mode logic with clear behavior for each mode
5. Added state validation with extensible validateState() method
6. Made notifyChange() async to support proper hash comparison
7. Updated select() to filter undefined states

341
readme.md
View File

@@ -1,37 +1,326 @@
# @push.rocks/smartstate
a package that handles state in a good way
A powerful TypeScript library for elegant state management using RxJS and reactive programming patterns
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartstate)
* [gitlab.com (source)](https://gitlab.com/push.rocks/smartstate)
* [github.com (source mirror)](https://github.com/push.rocks/smartstate)
* [docs (typedoc)](https://push.rocks.gitlab.io/smartstate/)
## Install
## Status for master
To install `@push.rocks/smartstate`, you can use pnpm, npm, or yarn:
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/smartstate/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/smartstate/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartstate)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/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/@push.rocks/smartstate)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartstate)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartstate)](https://lossless.cloud)
```bash
# Using pnpm (recommended)
pnpm install @push.rocks/smartstate --save
# Using npm
npm install @push.rocks/smartstate --save
# Using yarn
yarn add @push.rocks/smartstate
```
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';
```
## Legal
> MIT licensed | **&copy;** [Task Venture Capital GmbH](https://task.vc)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
### Creating a SmartState Instance
`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'`** (default) - Returns existing state part if it exists, creates new if not
- **`'mandatory'`** - Requires state part to not exist, fails if it does
- **`'force'`** - Always creates new state part, overwriting any existing one
- **`'persistent'`** - Like 'soft' but with 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
// The select() method automatically filters out undefined states
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
// Get current state (may be undefined initially)
const currentState = userStatePart.getState();
if (currentState) {
console.log('Current user:', currentState.username);
}
// 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
### State Validation
`Smartstate` includes built-in state validation to ensure data integrity:
```typescript
// Basic validation (built-in)
// Ensures state is not null or undefined
await userStatePart.setState(null); // Throws error: Invalid state structure
// Custom validation by extending StatePart
class ValidatedStatePart<T> extends StatePart<string, T> {
protected validateState(stateArg: any): stateArg is T {
// Add your custom validation logic
return super.validateState(stateArg) && /* your validation */;
}
}
```
### Performance Optimization
`Smartstate` includes advanced performance optimizations:
- **Async State Hash Detection**: Uses SHA256 hashing to detect actual state changes, preventing unnecessary notifications when state values haven't truly changed
- **Duplicate Prevention**: Identical state updates are automatically filtered out
- **Cumulative Notifications**: Batch multiple state changes into a single notification using `notifyChangeCumulative()`
- **Selective Subscriptions**: Use selectors to subscribe only to specific state properties
- **Undefined State Filtering**: The `select()` method automatically filters out undefined states
### 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);
});
```
### Complete Example
Here's a comprehensive example showcasing the power of `@push.rocks/smartstate`:
```typescript
import { Smartstate, StatePart, StateAction } from '@push.rocks/smartstate';
// Define your state structure
type AppStateParts = 'user' | 'settings' | 'cart';
interface IUserState {
isLoggedIn: boolean;
username?: string;
email?: string;
}
interface ICartState {
items: Array<{ id: string; quantity: number }>;
total: number;
}
// Create the smartstate instance
const appState = new Smartstate<AppStateParts>();
// Initialize state parts
const userState = await appState.getStatePart<IUserState>('user', {
isLoggedIn: false
});
const cartState = await appState.getStatePart<ICartState>('cart', {
items: [],
total: 0
}, 'persistent'); // Persists across sessions
// Create actions
const loginAction = userState.createAction<{ username: string; email: string }>(
async (statePart, payload) => {
// Simulate API call
await new Promise(resolve => setTimeout(resolve, 1000));
return {
isLoggedIn: true,
username: payload.username,
email: payload.email
};
}
);
// Subscribe to changes
userState.select(state => state.isLoggedIn).subscribe(isLoggedIn => {
console.log('Login status changed:', isLoggedIn);
});
// Dispatch actions
await loginAction.trigger({ username: 'john', email: 'john@example.com' });
```
### Key Features
`@push.rocks/smartstate` provides a robust foundation for state management:
- **🎯 Type-safe** - Full TypeScript support with intelligent type inference
- **⚡ Performance optimized** - Async state hash detection prevents unnecessary re-renders
- **💾 Persistent state** - Built-in IndexedDB support for state persistence
- **🔄 Reactive** - Powered by RxJS for elegant async handling
- **🧩 Modular** - Organize state into logical, reusable parts
- **✅ Validated** - Built-in state validation with extensible validation logic
- **🎭 Flexible init modes** - Choose how state parts are initialized
- **📦 Zero config** - Works out of the box with sensible defaults
## 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.

View File

@@ -18,7 +18,7 @@ tap.test('should create a new SmartState', async () => {
});
tap.test('should create a new StatePart', async () => {
testStatePart = testState.getStatePart<TStatePartPayload>('testStatePart', {
testStatePart = await testState.getStatePart<TStatePartPayload>('testStatePart', {
currentFavorites: [],
deep: {
hi: 2,
@@ -55,4 +55,4 @@ tap.test('should dispatch a state action', async (tools) => {
await done.promise;
});
tap.start();
export default tap.start();

View File

@@ -0,0 +1,157 @@
import { expect, tap } from '@push.rocks/tapbundle';
import * as smartstate from '../ts/index.js';
type TTestStateParts = 'initTest' | 'persistTest' | 'forceTest';
interface ITestState {
value: number;
nested: {
data: string;
};
}
tap.test('should handle soft init mode (default)', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
// First creation
const statePart1 = await state.getStatePart<ITestState>('initTest', {
value: 1,
nested: { data: 'initial' }
});
expect(statePart1.getState()).toEqual({
value: 1,
nested: { data: 'initial' }
});
// Second call should return existing
const statePart2 = await state.getStatePart<ITestState>('initTest');
expect(statePart1).toEqual(statePart2);
});
tap.test('should handle mandatory init mode', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
// First creation should succeed
const statePart1 = await state.getStatePart<ITestState>('initTest', {
value: 1,
nested: { data: 'initial' }
}, 'mandatory');
expect(statePart1).toBeInstanceOf(smartstate.StatePart);
// Second call with mandatory should fail
let error: Error | null = null;
try {
await state.getStatePart<ITestState>('initTest', {
value: 2,
nested: { data: 'second' }
}, 'mandatory');
} catch (e) {
error = e as Error;
}
expect(error).not.toBeNull();
expect(error?.message).toMatch(/already exists.*mandatory/);
});
tap.test('should handle force init mode', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
// First creation
const statePart1 = await state.getStatePart<ITestState>('forceTest', {
value: 1,
nested: { data: 'initial' }
});
expect(statePart1.getState()?.value).toEqual(1);
// Force should create new state part
const statePart2 = await state.getStatePart<ITestState>('forceTest', {
value: 2,
nested: { data: 'forced' }
}, 'force');
expect(statePart2.getState()?.value).toEqual(2);
expect(statePart1).not.toEqual(statePart2);
});
tap.test('should handle missing initial state error', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
let error: Error | null = null;
try {
await state.getStatePart<ITestState>('initTest');
} catch (e) {
error = e as Error;
}
expect(error).not.toBeNull();
expect(error?.message).toMatch(/does not exist.*no initial state/);
});
tap.test('should handle state validation', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
const statePart = await state.getStatePart<ITestState>('initTest', {
value: 1,
nested: { data: 'initial' }
});
// Setting null should fail validation
let error: Error | null = null;
try {
await statePart.setState(null as any);
} catch (e) {
error = e as Error;
}
expect(error).not.toBeNull();
expect(error?.message).toMatch(/Invalid state structure/);
});
tap.test('should handle undefined state in select', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
const statePart = new smartstate.StatePart<TTestStateParts, ITestState>('initTest');
// Select should filter out undefined states
const values: (ITestState | undefined)[] = [];
statePart.select().subscribe(val => values.push(val));
// Initially undefined, should not emit
expect(values).toHaveLength(0);
// After setting state, should emit
await statePart.setState({
value: 1,
nested: { data: 'test' }
});
expect(values).toHaveLength(1);
expect(values[0]).toEqual({
value: 1,
nested: { data: 'test' }
});
});
tap.test('should not notify on duplicate state', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
const statePart = await state.getStatePart<ITestState>('initTest', {
value: 1,
nested: { data: 'initial' }
});
let notificationCount = 0;
// Use select() to get initial value + changes
statePart.select().subscribe(() => notificationCount++);
// Should have received initial state
expect(notificationCount).toEqual(1);
// Set same state multiple times
await statePart.setState({ value: 1, nested: { data: 'initial' } });
await statePart.setState({ value: 1, nested: { data: 'initial' } });
await statePart.setState({ value: 1, nested: { data: 'initial' } });
// Should still be 1 (no new notifications for duplicate state)
expect(notificationCount).toEqual(1);
// Change state should notify
await statePart.setState({ value: 2, nested: { data: 'changed' } });
expect(notificationCount).toEqual(2);
});
export default tap.start();

View File

@@ -1,8 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
* autocreated commitinfo by @push.rocks/commitinfo
*/
export const commitinfo = {
name: '@push.rocks/smartstate',
version: '2.0.10',
description: 'a package that handles state in a good way'
version: '2.0.27',
description: 'A package for handling and managing state in applications.'
}

View File

@@ -1,57 +1,86 @@
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, any> } = {};
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 === 'force' will overwrite any existing statepart
* initMode === 'soft' (default) - returns existing statepart if exists, creates new if not
* initMode === 'mandatory' - requires statepart to not exist, fails if it does
* initMode === 'force' - always creates new statepart, overwriting any existing
* initMode === 'persistent' - like 'soft' but with webstore persistence
* @param statePartNameArg
* @param initialArg
* @param initMode
*/
public getStatePart<PayloadType>(
statePartNameArg: string & StatePartNameType,
public async getStatePart<PayloadType>(
statePartNameArg: StatePartNameType,
initialArg?: PayloadType,
initMode?: 'soft' | 'mandatory' | 'force' | 'persistent'
): StatePart<StatePartNameType, PayloadType> {
if (this.statePartMap[statePartNameArg as any]) {
if (initialArg && (!initMode || initMode !== 'soft')) {
initMode: TInitMode = 'soft'
): Promise<StatePart<StatePartNameType, PayloadType>> {
const existingStatePart = this.statePartMap[statePartNameArg];
if (existingStatePart) {
switch (initMode) {
case 'mandatory':
throw new Error(
`${statePartNameArg} already exists, yet you try to set an initial state again`
`State part '${statePartNameArg}' already exists, but initMode is 'mandatory'`
);
case 'force':
// Force mode: create new state part
return this.createStatePart<PayloadType>(statePartNameArg, initialArg, initMode);
case 'soft':
case 'persistent':
default:
// Return existing state part
return existingStatePart as StatePart<StatePartNameType, PayloadType>;
}
return this.statePartMap[statePartNameArg] as StatePart<StatePartNameType, PayloadType>;
} else {
// State part doesn't exist
if (!initialArg) {
throw new Error(
`${statePartNameArg} does not yet exist, yet you don't provide an initial state`
`State part '${statePartNameArg}' does not exist and no initial state provided`
);
}
return this.createStatePart<PayloadType>(statePartNameArg, initialArg);
return this.createStatePart<PayloadType>(statePartNameArg, initialArg, initMode);
}
}
/**
* creates a statepart
* Creates a statepart
* @param statePartName
* @param initialPayloadArg
* @param initMode
*/
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 = 'soft'
): 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({
...currentState,
...initialPayloadArg,
});
this.statePartMap[statePartName] = newState;
return newState;
}
}

View File

@@ -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);
}
}

View File

@@ -4,31 +4,32 @@ import { StateAction, type IActionDef } from './smartstate.classes.stateaction.j
export class StatePart<TStatePartName, TStatePayload> {
public name: TStatePartName;
public state = new plugins.smartrx.rxjs.Subject<TStatePayload>();
public stateStore: TStatePayload;
public stateStore: TStatePayload | undefined;
private cumulativeDeferred = plugins.smartpromise.cumulativeDefer();
private webStoreOptions: plugins.webstore.IWebStoreOptions;
private webStore: plugins.webstore.WebStore<TStatePayload> | null = null; // Add WebStore instance
constructor(nameArg: TStatePartName, webStoreOptions?: plugins.webstore.IWebStoreOptions) {
constructor(nameArg: TStatePartName, webStoreOptionsArg?: plugins.webstore.IWebStoreOptions) {
this.name = nameArg;
// Initialize WebStore if webStoreOptions are provided
if (webStoreOptions) {
this.webStore = new plugins.webstore.WebStore<TStatePayload>(webStoreOptions);
this.initWebStore();
if (webStoreOptionsArg) {
this.webStoreOptions = webStoreOptionsArg;
}
}
/**
* initializes the webstore
*/
private async initWebStore() {
if (this.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) {
if (storedState && this.validateState(storedState)) {
this.stateStore = storedState;
this.notifyChange();
await this.notifyChange();
}
}
}
@@ -36,7 +37,7 @@ export class StatePart<TStatePartName, TStatePayload> {
/**
* gets the state from the state store
*/
public getState(): TStatePayload {
public getState(): TStatePayload | undefined {
return this.stateStore;
}
@@ -45,30 +46,49 @@ export class StatePart<TStatePartName, TStatePayload> {
* @param newStateArg
*/
public async setState(newStateArg: TStatePayload) {
// Validate state structure
if (!this.validateState(newStateArg)) {
throw new Error(`Invalid state structure for state part '${this.name}'`);
}
this.stateStore = newStateArg;
this.notifyChange();
await this.notifyChange();
// Save state to WebStore if initialized
if (this.webStore) {
await this.webStore.set(String(this.name), newStateArg);
}
return this.stateStore;
}
/**
* Validates state structure - can be overridden for custom validation
* @param stateArg
*/
protected validateState(stateArg: any): stateArg is TStatePayload {
// Basic validation - ensure state is not null/undefined
// Subclasses can override for more specific validation
return stateArg !== null && stateArg !== undefined;
}
/**
* notifies of a change on the state
*/
public notifyChange() {
const createStateHash = (stateArg: any) => {
return plugins.isohash.sha256FromString(plugins.smartjson.stringify(stateArg));
public async notifyChange() {
if (!this.stateStore) {
return;
}
const createStateHash = async (stateArg: any) => {
return await plugins.smarthashWeb.sha256FromString(plugins.smartjson.stableOneWayStringify(stateArg));
};
const currentHash = await createStateHash(this.stateStore);
if (
this.stateStore &&
this.lastStateNotificationPayloadHash &&
createStateHash(this.stateStore) === this.lastStateNotificationPayloadHash
currentHash === this.lastStateNotificationPayloadHash
) {
return;
} else {
this.lastStateNotificationPayloadHash = this.stateStore;
this.lastStateNotificationPayloadHash = currentHash;
}
this.state.next(this.stateStore);
}
@@ -79,7 +99,11 @@ export class StatePart<TStatePartName, TStatePayload> {
*/
public notifyChangeCumulative() {
// TODO: check viability
setTimeout(() => this.state.next(this.stateStore), 0);
setTimeout(async () => {
if (this.stateStore) {
await this.notifyChange();
}
}, 0);
}
/**
@@ -93,6 +117,7 @@ export class StatePart<TStatePartName, TStatePayload> {
}
const mapped = this.state.pipe(
plugins.smartrx.rxjs.ops.startWith(this.getState()),
plugins.smartrx.rxjs.ops.filter((stateArg): stateArg is TStatePayload => stateArg !== undefined),
plugins.smartrx.rxjs.ops.map((stateArg) => {
try {
return selectorFn(stateArg);
@@ -116,10 +141,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();
}
/**

View File

@@ -1,7 +1,7 @@
import * as isohash from '@push.rocks/isohash';
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 { isohash, smartjson, smartpromise, smartrx, webstore };
export { smarthashWeb, smartjson, smartpromise, smartrx, webstore };