Compare commits

..

95 Commits

Author SHA1 Message Date
2f0b39ae41 v2.1.0
Some checks failed
Default (tags) / security (push) Successful in 34s
Default (tags) / test (push) Failing after 1m20s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-02-27 11:40:07 +00:00
575477df09 feat(smartstate): Add middleware, computed, batching, selector memoization, AbortSignal support, and Web Component Context Protocol provider 2026-02-27 11:40:07 +00:00
39aa63bdb3 v2.0.31
Some checks failed
Default (tags) / security (push) Successful in 33s
Default (tags) / test (push) Failing after 1m21s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-02-27 10:18:18 +00:00
c1aa4eae5e fix(deps): bump devDependencies and fix README license path 2026-02-27 10:18:18 +00:00
d8decdb3e5 v2.0.30
Some checks failed
Default (tags) / security (push) Successful in 24s
Default (tags) / test (push) Failing after 39s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-02-02 01:07:38 +00:00
03cfee2003 fix(config): update npmextra configuration and improve README: rename package keys, add release registry config, clarify waitUntilPresent timeout and notification/persistence behavior 2026-02-02 01:07:38 +00:00
f6a3e71f0a v2.0.29
Some checks failed
Default (tags) / security (push) Successful in 29s
Default (tags) / test (push) Failing after 41s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-02-02 01:05:57 +00:00
6436370abc fix(smartstate): prevent duplicate statepart creation and fix persistence/notification race conditions 2026-02-02 01:05:57 +00:00
eb1c48bee4 v2.0.28
Some checks failed
Default (tags) / security (push) Successful in 29s
Default (tags) / test (push) Failing after 41s
Default (tags) / release (push) Has been skipped
Default (tags) / metadata (push) Has been skipped
2026-02-02 00:52:23 +00:00
05417ed4c3 fix(deps): bump devDependencies and dependencies, add tsbundle build config, update docs, and reorganize tests 2026-02-02 00:52:23 +00:00
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
df2924577b 2.0.10 2023-10-03 07:53:29 +02:00
4abaea84f8 fix(core): update 2023-10-03 07:53:28 +02:00
de454b4c8d 2.0.9 2023-09-11 18:39:53 +02:00
961685b5bd fix(core): update 2023-09-11 18:39:52 +02:00
c622396d50 2.0.8 2023-07-27 15:20:48 +02:00
d130c1c6fd fix(core): update 2023-07-27 15:20:47 +02:00
f8a967aeac 2.0.7 2023-07-27 15:20:25 +02:00
abee699af8 fix(core): update 2023-07-27 15:20:24 +02:00
a21131eaf6 2.0.6 2023-04-13 14:22:32 +02:00
c4b214a308 fix(core): update 2023-04-13 14:22:31 +02:00
6db03eee83 2.0.5 2023-04-12 20:34:34 +02:00
efc5b54d2e fix(core): update 2023-04-12 20:34:34 +02:00
9860e43398 2.0.4 2023-04-04 21:52:27 +02:00
234117c8dd fix(core): update 2023-04-04 21:52:27 +02:00
371c6553cd 2.0.3 2023-04-04 21:44:17 +02:00
b6b738916f fix(core): update 2023-04-04 21:44:16 +02:00
fad7e0bc6b 2.0.2 2023-04-04 20:59:46 +02:00
fc4fb911ef fix(core): update 2023-04-04 20:59:45 +02:00
7e0dad1c10 2.0.1 2023-03-15 17:04:29 +01:00
0fb50714b9 fix(core): update 2023-03-15 17:04:29 +01:00
7e1821f37d 2.0.0 2022-03-25 13:31:21 +01:00
592228fc51 BREAKING CHANGE(core): switch to esm 2022-03-25 13:31:21 +01:00
431089e23f 1.0.23 2022-01-24 06:42:45 +01:00
5b64733d91 fix(core): update 2022-01-24 06:42:43 +01:00
2da2a43a09 1.0.22 2022-01-24 06:39:37 +01:00
f7887a6663 fix(core): update 2022-01-24 06:39:36 +01:00
be505ee915 1.0.21 2020-11-29 23:51:06 +00:00
9584f403b1 fix(core): update 2020-11-29 23:51:05 +00:00
993a100eae 1.0.20 2020-11-29 23:33:56 +00:00
29f0307ef8 fix(core): update 2020-11-29 23:33:55 +00:00
9413c5bcdc 1.0.19 2020-11-29 23:31:32 +00:00
1d5fb320f4 fix(core): update 2020-11-29 23:31:31 +00:00
69e905ad76 1.0.18 2020-11-29 23:28:45 +00:00
7b9ed9ee78 fix(core): update 2020-11-29 23:28:44 +00:00
f884807f33 1.0.17 2020-07-27 18:17:53 +00:00
f167800113 fix(core): update 2020-07-27 18:17:52 +00:00
c549d06a6b 1.0.16 2020-05-27 20:47:16 +00:00
23061c86eb fix(core): update 2020-05-27 20:47:15 +00:00
4d0567a95d 1.0.15 2020-05-18 04:10:37 +00:00
8524c95440 fix(core): update 2020-05-18 04:10:36 +00:00
b1fc60fc2e 1.0.14 2019-09-25 17:09:36 +02:00
8d296cf08d fix(core): update 2019-09-25 17:09:35 +02:00
b8d0ec55ad 1.0.13 2019-09-25 15:28:39 +02:00
1cf78441e2 fix(core): update 2019-09-25 15:28:39 +02:00
0f34c5de55 1.0.12 2019-04-30 10:46:29 +02:00
1bd8f8371b fix(core): update 2019-04-30 10:46:28 +02:00
ef263a85b4 1.0.11 2019-04-30 10:17:29 +02:00
315156aac5 fix(core): update 2019-04-30 10:17:29 +02:00
28 changed files with 28756 additions and 1987 deletions

View File

@@ -0,0 +1,66 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
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}}
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 @ship.zone/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

View File

@@ -0,0 +1,124 @@
name: Default (tags)
on:
push:
tags:
- '*'
env:
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}}
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 @ship.zone/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 @ship.zone/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 @ship.zone/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 @ship.zone/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

16
.gitignore vendored
View File

@@ -1,6 +1,20 @@
.nogit/ .nogit/
node_modules/
# artifacts
coverage/ coverage/
public/ public/
pages/ pages/
# installs
node_modules/
# caches
.yarn/ .yarn/
.cache/
.rpt2_cache
# builds
dist/
dist_*/
# custom

View File

@@ -1,125 +0,0 @@
# gitzone standard
image: 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
tags:
- docker
- notpriv
snyk:
stage: security
script:
- npmci npm prepare
- npmci command npm install -g snyk
- npmci command npm install --ignore-scripts
- npmci command snyk test
tags:
- docker
- notpriv
# ====================
# test stage
# ====================
testLTS:
stage: test
script:
- npmci npm prepare
- npmci node install lts
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
- notpriv
testSTABLE:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
- notpriv
release:
stage: release
script:
- npmci node install stable
- npmci npm publish
only:
- tags
tags:
- docker
- notpriv
# ====================
# metadata stage
# ====================
codequality:
stage: metadata
image: docker:stable
allow_failure: true
services:
- docker:stable-dind
script:
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
- docker run
--env SOURCE_CODE="$PWD"
--volume "$PWD":/code
--volume /var/run/docker.sock:/var/run/docker.sock
"registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
artifacts:
paths: [codeclimate.json]
tags:
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- docker
- notpriv
pages:
image: hosttoday/ht-docker-node:npmci
stage: metadata
script:
- npmci command npm install -g typedoc typescript
- npmci npm prepare
- npmci npm install
- npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
tags:
- docker
- notpriv
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true

11
.vscode/launch.json vendored Normal file
View File

@@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "npm test",
"name": "Run npm test",
"request": "launch",
"type": "node-terminal"
}
]
}

26
.vscode/settings.json vendored Normal file
View File

@@ -0,0 +1,26 @@
{
"json.schemas": [
{
"fileMatch": ["/npmextra.json"],
"schema": {
"type": "object",
"properties": {
"npmci": {
"type": "object",
"description": "settings for npmci"
},
"gitzone": {
"type": "object",
"description": "settings for gitzone",
"properties": {
"projectType": {
"type": "string",
"enum": ["website", "element", "service", "npm", "wcc"]
}
}
}
}
}
}
]
}

262
changelog.md Normal file
View File

@@ -0,0 +1,262 @@
# Changelog
## 2026-02-27 - 2.1.0 - feat(smartstate)
Add middleware, computed, batching, selector memoization, AbortSignal support, and Web Component Context Protocol provider
- Introduce StatePart middleware API (addMiddleware) — middleware runs sequentially before validation/persistence and can transform or reject a state change.
- Add computed derived observables: standalone computed(sources, fn) and Smartstate.computed to derive values from multiple state parts (lazy subscription).
- Add batching support via Smartstate.batch(fn), isBatching flag, and deferred notifications to batch multiple updates and flush only at the outermost level.
- Enhance select() with selector memoization (WeakMap cache and shareReplay) and optional AbortSignal support (auto-unsubscribe).
- Extend waitUntilPresent() to accept timeout and AbortSignal options and maintain backward-compatible numeric timeout argument.
- Add attachContextProvider(element, options) to bridge state parts to Web Component Context Protocol (context-request events) with subscribe/unsubscribe handling.
- Update StatePart.setState to run middleware, persist processed state atomically, and defer notifications to batching when applicable.
- Tests and README updated to document new features, behaviors, and examples.
## 2026-02-27 - 2.0.31 - fix(deps)
bump devDependencies and fix README license path
- Bump @git.zone/tsbundle from ^2.8.3 to ^2.9.0
- Bump @types/node from ^25.2.0 to ^25.3.2
- Update documented dependency set/version to v2.0.30 in readme.hints.md
- Fix README license file path from LICENSE to license in readme.md
## 2026-02-02 - 2.0.30 - fix(config)
update npmextra configuration and improve README: rename package keys, add release registry config, clarify waitUntilPresent timeout and notification/persistence behavior
- Renamed npmextra keys: 'gitzone' → '@git.zone/cli' and 'tsdoc' → '@git.zone/tsdoc'
- Added release configuration for @git.zone/cli including registries (verdaccio and npm) and accessLevel
- Removed top-level 'npmci' section
- Added new '@ship.zone/szci' entry with npmGlobalTools
- README: added waitUntilPresent timeout example with error handling
- README: clarified notifyChangeCumulative is debounced and documented persistence behavior (merge with defaults, atomic writes)
- README: documented concurrency/race-condition safety and timeout support for waitUntilPresent
## 2026-02-02 - 2.0.29 - fix(smartstate)
prevent duplicate statepart creation and fix persistence/notification race conditions
- Add pendingStatePartCreation map to deduplicate concurrent createStatePart calls
- Adjust init handling so 'force' falls through to creation and concurrent creations are serialized
- Merge persisted state with initial payload in 'persistent' initMode, with persisted values taking precedence
- Persist to WebStore before updating in-memory state to ensure atomicity
- Debounce cumulative notifications via pendingCumulativeNotification to avoid duplicate notifications
- Log selector errors instead of silently swallowing exceptions
- Add optional timeout to waitUntilPresent and ensure subscriptions and timeouts are cleaned up to avoid indefinite waits
- Await setState when performing chained state updates to ensure ordering and avoid race conditions
## 2026-02-02 - 2.0.28 - fix(deps)
bump devDependencies and dependencies, add tsbundle build config, update docs, and reorganize tests
- Bumped @git.zone/tsbuild to ^4.1.2, @git.zone/tsbundle to ^2.8.3, @git.zone/tsrun to ^2.0.1, @git.zone/tstest to ^3.1.8, and @types/node to ^25.2.0
- Upgraded @push.rocks/smartjson to ^6.0.0
- Added @git.zone/tsbundle bundle configuration to npmextra.json for building a dist bundle
- Removed pnpm-workspace.yaml entries (cleaned workspace constraints)
- Updated readme and readme.hints (docs formatting, version bumped to v2.0.28, issue reporting/security section and dependency list)
- Reorganized tests: removed *.both.ts variants and added consolidated test files under test/ (test.ts, test.initialization.ts)
## 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

@@ -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 Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

View File

@@ -1,16 +1,55 @@
{ {
"npmci": { "@git.zone/tsbundle": {
"npmGlobalTools": [], "bundles": [
"npmAccessLevel": "public" {
"from": "./ts/index.ts",
"to": "./dist_bundle/bundle.js",
"outputMode": "bundle",
"bundler": "esbuild",
"production": true
}
]
}, },
"gitzone": { "@git.zone/cli": {
"projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "code.foss.global",
"gitscope": "pushrocks", "gitscope": "push.rocks",
"gitrepo": "smartstate", "gitrepo": "smartstate",
"shortDescription": "a package that handles state in a good way", "description": "A TypeScript-first reactive state management library with middleware, computed state, batching, persistence, and Web Component Context Protocol support.",
"npmPackagename": "@pushrocks/smartstate", "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",
"middleware",
"computed state",
"batch updates",
"context protocol",
"web components",
"AbortSignal"
]
},
"release": {
"registries": [
"https://verdaccio.lossless.digital",
"https://registry.npmjs.org"
],
"accessLevel": "public"
} }
},
"@git.zone/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"
},
"@ship.zone/szci": {
"npmGlobalTools": []
} }
} }

17898
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,27 +1,70 @@
{ {
"name": "@pushrocks/smartstate", "name": "@push.rocks/smartstate",
"version": "1.0.10", "version": "2.1.0",
"private": false, "private": false,
"description": "a package that handles state in a good way", "description": "A TypeScript-first reactive state management library with middleware, computed state, batching, persistence, and Web Component Context Protocol support.",
"main": "dist/index.js", "main": "dist_ts/index.js",
"typings": "dist/index.d.ts", "typings": "dist_ts/index.d.ts",
"type": "module",
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"test": "(tstest test/)", "test": "(tstest test/ --verbose)",
"build": "(tsbuild)", "build": "(tsbuild tsfolders --allowimplicitany && tsbundle npm)",
"format": "(gitzone format)" "buildDocs": "tsdoc"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.8", "@git.zone/tsbuild": "^4.1.2",
"@gitzone/tstest": "^1.0.15", "@git.zone/tsbundle": "^2.9.0",
"@pushrocks/tapbundle": "^3.0.7", "@git.zone/tsrun": "^2.0.1",
"@types/node": "^11.9.4", "@git.zone/tstest": "^3.1.8",
"tslint": "^5.12.1", "@push.rocks/tapbundle": "^6.0.3",
"tslint-config-prettier": "^1.18.0" "@types/node": "^25.3.2"
}, },
"dependencies": { "dependencies": {
"@pushrocks/lik": "^3.0.4", "@push.rocks/smarthash": "^3.2.6",
"rxjs": "^6.4.0" "@push.rocks/smartjson": "^6.0.0",
} "@push.rocks/smartpromise": "^4.2.3",
"@push.rocks/smartrx": "^3.0.10",
"@push.rocks/webstore": "^2.0.20"
},
"files": [
"ts/**/*",
"ts_web/**/*",
"dist/**/*",
"dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js",
"npmextra.json",
"readme.md"
],
"browserslist": [
"last 1 chrome versions"
],
"keywords": [
"state management",
"reactive programming",
"TypeScript",
"observables",
"web storage",
"state action",
"state selection",
"state notification",
"asynchronous state",
"cumulative notification",
"middleware",
"computed state",
"batch updates",
"context protocol",
"web components",
"AbortSignal"
],
"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"
} }

9915
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

77
readme.hints.md Normal file
View File

@@ -0,0 +1,77 @@
# Smartstate Implementation Notes
## Current API (as of v2.0.31)
### 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
- State merge order fixed: initial state takes precedence over stored state
### Actions
- Actions are created with `createAction()` method
- Two ways to dispatch: `stateAction.trigger(payload)` or `statePart.dispatchAction(stateAction, payload)`
- Both return Promise<TStatePayload>
### State Management Methods
- `select(fn?, { signal? })` - returns Observable, memoized by selector fn ref, supports AbortSignal
- `waitUntilPresent(fn?, number | { timeoutMs?, signal? })` - waits for state condition, backward compat with number arg
- `stateSetup()` - async state initialization with cumulative defer
- `notifyChangeCumulative()` - defers notification to end of call stack
- `getState()` - returns current state or undefined
- `setState()` - runs middleware, validates, persists, notifies
- `addMiddleware(fn)` - intercepts setState, returns removal function
### Middleware
- Type: `(newState, oldState) => newState | Promise<newState>`
- Runs sequentially in insertion order before validation/persistence
- Throw to reject state changes (atomic — state unchanged on error)
- Does NOT run during initial createStatePart() hydration
### Selector Memoization
- Uses WeakMap<Function, Observable> for fn-keyed cache
- `defaultSelectObservable` for no-arg select()
- Wrapped in `shareReplay({ bufferSize: 1, refCount: true })`
- NOT cached when AbortSignal is provided
### Batch Updates
- `smartstate.batch(async () => {...})` — defers notifications until batch completes
- Supports nesting — only flushes at outermost level
- StatePart has `smartstateRef` set by `createStatePart()` for batch awareness
- State parts created via `new StatePart()` directly work without batching
### Computed State
- `computed(sources, fn)` — standalone function using `combineLatest` + `map`
- Also available as `smartstate.computed(sources, fn)`
- Lazy — only subscribes when subscribed to
### Context Protocol Bridge
- `attachContextProvider(element, { context, statePart, selectorFn? })` — returns cleanup fn
- Listens for `context-request` CustomEvent on element
- Supports one-shot and subscription modes
- Works with Lit @consume(), FAST, or any Context Protocol consumer
### State Hash Detection
- Uses SHA256 hash to detect actual state changes
- Hash comparison properly awaits async hash calculation
- Prevents duplicate notifications for identical state values
### State Validation
- Basic validation ensures state is not null/undefined
- `validateState()` can be overridden in subclasses
### Key Notes
- `smartstateRef` creates circular ref between StatePart and Smartstate
- Use `===` not deep equality for StatePart comparison in tests
- Direct rxjs imports used for: Observable, shareReplay, takeUntil, combineLatest, map
## Dependency Versions (v2.0.31)
- @git.zone/tsbuild: ^4.1.2
- @git.zone/tsbundle: ^2.9.0
- @git.zone/tsrun: ^2.0.1
- @git.zone/tstest: ^3.1.8
- @push.rocks/smartjson: ^6.0.0
- @types/node: ^25.3.2

348
readme.md
View File

@@ -1,26 +1,336 @@
# @pushrocks/smartstate # @push.rocks/smartstate
a package that handles state in a good way
## Availabililty and Links A TypeScript-first reactive state management library with middleware, computed state, batching, persistence, and Web Component Context Protocol support 🚀
* [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/)
## Status for master ## Issue Reporting and Security
[![build status](https://gitlab.com/pushrocks/smartstate/badges/master/build.svg)](https://gitlab.com/pushrocks/smartstate/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartstate/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartstate/commits/master) For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartstate.svg)](https://www.npmjs.com/package/@pushrocks/smartstate)
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartstate/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartstate) ## Install
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) ```bash
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/) pnpm install @push.rocks/smartstate --save
```
Or with npm:
```bash
npm install @push.rocks/smartstate --save
```
## Usage ## Usage
For further information read the linked docs at the top of this readme. ### Quick Start
> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh) ```typescript
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html) import { Smartstate } from '@push.rocks/smartstate';
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com) // 1. Define your state part names
type AppParts = 'user' | 'settings';
// 2. Create the root instance
const state = new Smartstate<AppParts>();
// 3. Create state parts with initial values
const userState = await state.getStatePart<{ name: string; loggedIn: boolean }>('user', {
name: '',
loggedIn: false,
});
// 4. Subscribe to changes
userState.select((s) => s.name).subscribe((name) => {
console.log('Name changed:', name);
});
// 5. Update state
await userState.setState({ name: 'Alice', loggedIn: true });
```
### State Parts & Init Modes
State parts are isolated, typed units of state. Create them with `getStatePart()`:
```typescript
const part = await state.getStatePart<IMyState>(name, initialState, initMode);
```
| Init Mode | Behavior |
|-----------|----------|
| `'soft'` (default) | Returns existing if found, creates new otherwise |
| `'mandatory'` | Throws if state part already exists |
| `'force'` | Always creates new, overwrites existing |
| `'persistent'` | Like `'soft'` but persists to IndexedDB via WebStore |
#### Persistent State
```typescript
const settings = await state.getStatePart('settings', { theme: 'dark' }, 'persistent');
// Automatically saved to IndexedDB. On next app load, persisted values override defaults.
```
### Selecting State
`select()` returns an RxJS Observable that emits the current value immediately and on every change:
```typescript
// Full state
userState.select().subscribe((state) => console.log(state));
// Derived value via selector
userState.select((s) => s.name).subscribe((name) => console.log(name));
```
Selectors are **memoized** — calling `select(fn)` with the same function reference returns the same cached Observable, shared across all subscribers.
#### AbortSignal Support
Clean up subscriptions without manual `unsubscribe()`:
```typescript
const controller = new AbortController();
userState.select((s) => s.name, { signal: controller.signal }).subscribe((name) => {
console.log(name); // stops receiving when aborted
});
// Later: clean up
controller.abort();
```
### Actions
Actions provide controlled, named state mutations:
```typescript
const login = userState.createAction<{ name: string }>(async (statePart, payload) => {
return { ...statePart.getState(), name: payload.name, loggedIn: true };
});
// Two equivalent ways to dispatch:
await login.trigger({ name: 'Alice' });
await userState.dispatchAction(login, { name: 'Alice' });
```
### Middleware
Intercept every `setState()` call to transform, validate, or reject state changes:
```typescript
// Logging middleware
userState.addMiddleware((newState, oldState) => {
console.log('State changing from', oldState, 'to', newState);
return newState;
});
// Validation middleware — throw to reject the change
userState.addMiddleware((newState) => {
if (!newState.name) throw new Error('Name is required');
return newState;
});
// Transform middleware
userState.addMiddleware((newState) => {
return { ...newState, name: newState.name.trim() };
});
// Removal — addMiddleware returns a dispose function
const remove = userState.addMiddleware(myMiddleware);
remove(); // middleware no longer runs
```
Middleware runs sequentially in insertion order. If any middleware throws, the state is unchanged (atomic).
### Computed / Derived State
Derive reactive values from one or more state parts:
```typescript
import { computed } from '@push.rocks/smartstate';
const userState = await state.getStatePart('user', { firstName: 'Jane', lastName: 'Doe' });
const settingsState = await state.getStatePart('settings', { locale: 'en' });
// Standalone function
const greeting$ = computed(
[userState, settingsState],
(user, settings) => `Hello, ${user.firstName} (${settings.locale})`,
);
greeting$.subscribe((msg) => console.log(msg));
// => "Hello, Jane (en)"
// Also available as a method on Smartstate:
const greeting2$ = state.computed([userState, settingsState], (user, settings) => /* ... */);
```
Computed observables are **lazy** — they only subscribe to sources when someone subscribes to them.
### Batch Updates
Update multiple state parts without intermediate notifications:
```typescript
const partA = await state.getStatePart('a', { value: 1 });
const partB = await state.getStatePart('b', { value: 2 });
// Subscribers see no updates during the batch — only after it completes
await state.batch(async () => {
await partA.setState({ value: 10 });
await partB.setState({ value: 20 });
// Notifications are deferred here
});
// Both subscribers now fire with their new values
// Nested batches are supported — flush happens at the outermost level
await state.batch(async () => {
await partA.setState({ value: 100 });
await state.batch(async () => {
await partB.setState({ value: 200 });
});
// Still deferred
});
// Now both fire
```
### Waiting for State
Wait for a specific state condition to be met:
```typescript
// Wait for any truthy state
const currentState = await userState.waitUntilPresent();
// Wait for a specific condition
const name = await userState.waitUntilPresent((s) => s.name || undefined);
// With timeout (backward compatible)
const name = await userState.waitUntilPresent((s) => s.name || undefined, 5000);
// With AbortSignal
const controller = new AbortController();
try {
const name = await userState.waitUntilPresent(
(s) => s.name || undefined,
{ timeoutMs: 5000, signal: controller.signal },
);
} catch (e) {
// 'Aborted' or timeout error
}
```
### Context Protocol Bridge (Web Components)
Expose state parts to web components via the [W3C Context Protocol](https://github.com/webcomponents-cg/community-protocols/blob/main/proposals/context.md):
```typescript
import { attachContextProvider } from '@push.rocks/smartstate';
// Define a context key
const themeContext = Symbol('theme');
// Attach a provider to a DOM element
const cleanup = attachContextProvider(myElement, {
context: themeContext,
statePart: settingsState,
selectorFn: (s) => s.theme, // optional: provide derived value
});
// Any descendant can request this context:
myElement.dispatchEvent(
new CustomEvent('context-request', {
bubbles: true,
composed: true,
detail: {
context: themeContext,
callback: (theme) => console.log('Theme:', theme),
subscribe: true, // receive updates on state changes
},
}),
);
// Cleanup when done
cleanup();
```
This works with Lit's `@consume()` decorator, FAST, or any framework implementing the Context Protocol.
### State Validation
Built-in null/undefined validation. Extend for custom rules:
```typescript
class ValidatedPart<T> extends StatePart<string, T> {
protected validateState(stateArg: any): stateArg is T {
return super.validateState(stateArg) && typeof stateArg.name === 'string';
}
}
```
### Performance Features
- **SHA256 Change Detection** — identical state values don't trigger notifications, even with different object references
- **Selector Memoization** — `select(fn)` caches observables by function reference, sharing one upstream subscription across all subscribers
- **Cumulative Notifications** — `notifyChangeCumulative()` debounces rapid changes into a single notification
- **Concurrent Safety** — simultaneous `getStatePart()` calls for the same name return the same promise, preventing duplicate creation
- **Atomic Persistence** — WebStore writes complete before in-memory state updates, ensuring consistency
- **Batch Deferred Notifications** — `batch()` suppresses all notifications until the batch completes
## API Reference
### `Smartstate<T>`
| Method | Description |
|--------|-------------|
| `getStatePart(name, initial?, initMode?)` | Get or create a state part |
| `batch(fn)` | Batch updates, defer notifications |
| `computed(sources, fn)` | Create computed observable |
| `isBatching` | Whether a batch is active |
### `StatePart<TName, TPayload>`
| Method | Description |
|--------|-------------|
| `getState()` | Get current state (or undefined) |
| `setState(newState)` | Set state (runs middleware, validates, persists, notifies) |
| `select(selectorFn?, options?)` | Subscribe to state changes |
| `createAction(actionDef)` | Create a named action |
| `dispatchAction(action, payload)` | Dispatch an action |
| `addMiddleware(fn)` | Add middleware, returns removal function |
| `waitUntilPresent(selectorFn?, options?)` | Wait for state condition |
| `notifyChange()` | Manually trigger notification |
| `notifyChangeCumulative()` | Debounced notification |
| `stateSetup(fn)` | Async state initialization |
### `StateAction<TState, TPayload>`
| Method | Description |
|--------|-------------|
| `trigger(payload)` | Dispatch the action |
### Standalone Functions
| Function | Description |
|----------|-------------|
| `computed(sources, fn)` | Create computed observable from state parts |
| `attachContextProvider(element, options)` | Bridge state to Context Protocol |
## License and Legal Information
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](./license) file.
**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 or third parties, 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 or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
### Company Information
Task Venture Capital GmbH
Registered at District Court Bremen HRB 35230 HB, Germany
For any legal inquiries or 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.

632
test/test.initialization.ts Normal file
View File

@@ -0,0 +1,632 @@
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;
};
}
// ============================
// Init mode tests
// ============================
tap.test('should handle soft init mode (default)', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
const statePart1 = await state.getStatePart<ITestState>('initTest', {
value: 1,
nested: { data: 'initial' }
});
expect(statePart1.getState()).toEqual({
value: 1,
nested: { data: 'initial' }
});
const statePart2 = await state.getStatePart<ITestState>('initTest');
expect(statePart1 === statePart2).toBeTrue();
});
tap.test('should handle mandatory init mode', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
const statePart1 = await state.getStatePart<ITestState>('initTest', {
value: 1,
nested: { data: 'initial' }
}, 'mandatory');
expect(statePart1).toBeInstanceOf(smartstate.StatePart);
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>();
const statePart1 = await state.getStatePart<ITestState>('forceTest', {
value: 1,
nested: { data: 'initial' }
});
expect(statePart1.getState()?.value).toEqual(1);
const statePart2 = await state.getStatePart<ITestState>('forceTest', {
value: 2,
nested: { data: 'forced' }
}, 'force');
expect(statePart2.getState()?.value).toEqual(2);
expect(statePart1 === statePart2).toBeFalse();
});
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' }
});
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');
const values: (ITestState | undefined)[] = [];
statePart.select().subscribe(val => values.push(val));
expect(values).toHaveLength(0);
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;
statePart.select().subscribe(() => notificationCount++);
expect(notificationCount).toEqual(1);
await statePart.setState({ value: 1, nested: { data: 'initial' } });
await statePart.setState({ value: 1, nested: { data: 'initial' } });
await statePart.setState({ value: 1, nested: { data: 'initial' } });
expect(notificationCount).toEqual(1);
await statePart.setState({ value: 2, nested: { data: 'changed' } });
expect(notificationCount).toEqual(2);
});
// ============================
// AbortSignal tests
// ============================
tap.test('select should complete when AbortSignal fires', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
const statePart = await state.getStatePart<ITestState>('initTest', {
value: 1,
nested: { data: 'initial' }
});
const controller = new AbortController();
const values: any[] = [];
let completed = false;
statePart.select(undefined, { signal: controller.signal }).subscribe({
next: (v) => values.push(v),
complete: () => { completed = true; },
});
expect(values.length).toBeGreaterThanOrEqual(1);
controller.abort();
// Give microtask time
await new Promise<void>((r) => setTimeout(r, 10));
expect(completed).toBeTrue();
});
tap.test('select with pre-aborted signal should complete immediately', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
const statePart = await state.getStatePart<ITestState>('initTest', {
value: 1,
nested: { data: 'initial' }
});
const controller = new AbortController();
controller.abort();
let completed = false;
statePart.select(undefined, { signal: controller.signal }).subscribe({
complete: () => { completed = true; },
});
await new Promise<void>((r) => setTimeout(r, 10));
expect(completed).toBeTrue();
});
tap.test('waitUntilPresent should reject when AbortSignal fires', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
const statePart = await state.getStatePart<ITestState>('initTest', {
value: 0,
nested: { data: '' }
}, 'force');
const controller = new AbortController();
const promise = statePart.waitUntilPresent(
(s) => s.value > 100 ? s : undefined as any,
{ signal: controller.signal }
);
// Abort before the condition can be met
setTimeout(() => controller.abort(), 20);
let error: Error | null = null;
try {
await promise;
} catch (e) {
error = e as Error;
}
expect(error).not.toBeNull();
expect(error?.message).toEqual('Aborted');
});
tap.test('waitUntilPresent should still work with numeric timeout (backward compat)', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
const statePart = await state.getStatePart<ITestState>('initTest', {
value: 42,
nested: { data: 'present' }
}, 'force');
const result = await statePart.waitUntilPresent(undefined, 5000);
expect(result.value).toEqual(42);
});
// ============================
// Middleware tests
// ============================
tap.test('middleware should transform state', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
const statePart = await state.getStatePart<ITestState>('initTest', {
value: 1,
nested: { data: 'initial' }
}, 'force');
statePart.addMiddleware((newState, oldState) => {
return { ...newState, nested: { data: newState.nested.data.toUpperCase() } };
});
await statePart.setState({ value: 2, nested: { data: 'hello' } });
expect(statePart.getState().nested.data).toEqual('HELLO');
});
tap.test('middleware should reject state changes on throw', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
const statePart = await state.getStatePart<ITestState>('initTest', {
value: 1,
nested: { data: 'initial' }
}, 'force');
statePart.addMiddleware((newState) => {
if (newState.value < 0) {
throw new Error('Value must be non-negative');
}
return newState;
});
let error: Error | null = null;
try {
await statePart.setState({ value: -1, nested: { data: 'bad' } });
} catch (e) {
error = e as Error;
}
expect(error).not.toBeNull();
expect(error?.message).toEqual('Value must be non-negative');
// State should be unchanged
expect(statePart.getState().value).toEqual(1);
});
tap.test('multiple middlewares should run in order', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
const statePart = await state.getStatePart<ITestState>('initTest', {
value: 1,
nested: { data: 'initial' }
}, 'force');
const order: number[] = [];
statePart.addMiddleware((newState) => {
order.push(1);
return { ...newState, value: newState.value + 10 };
});
statePart.addMiddleware((newState) => {
order.push(2);
return { ...newState, value: newState.value * 2 };
});
await statePart.setState({ value: 5, nested: { data: 'test' } });
expect(order).toEqual([1, 2]);
// (5 + 10) * 2 = 30
expect(statePart.getState().value).toEqual(30);
});
tap.test('middleware removal should work', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
const statePart = await state.getStatePart<ITestState>('initTest', {
value: 1,
nested: { data: 'initial' }
}, 'force');
const remove = statePart.addMiddleware((newState) => {
return { ...newState, value: newState.value * 100 };
});
await statePart.setState({ value: 2, nested: { data: 'test' } });
expect(statePart.getState().value).toEqual(200);
remove();
await statePart.setState({ value: 3, nested: { data: 'test' } });
expect(statePart.getState().value).toEqual(3);
});
// ============================
// Selector memoization tests
// ============================
tap.test('select with same selector fn should return cached observable', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
const statePart = await state.getStatePart<ITestState>('initTest', {
value: 1,
nested: { data: 'initial' }
}, 'force');
const selector = (s: ITestState) => s.value;
const obs1 = statePart.select(selector);
const obs2 = statePart.select(selector);
expect(obs1).toEqual(obs2);
});
tap.test('select with no args should return cached observable', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
const statePart = await state.getStatePart<ITestState>('initTest', {
value: 1,
nested: { data: 'initial' }
}, 'force');
const obs1 = statePart.select();
const obs2 = statePart.select();
expect(obs1).toEqual(obs2);
});
tap.test('select with different selectors should return different observables', async () => {
const state = new smartstate.Smartstate<TTestStateParts>();
const statePart = await state.getStatePart<ITestState>('initTest', {
value: 1,
nested: { data: 'initial' }
}, 'force');
const obs1 = statePart.select((s) => s.value);
const obs2 = statePart.select((s) => s.nested);
expect(obs1).not.toEqual(obs2);
});
// ============================
// Batch update tests
// ============================
tap.test('batch should defer notifications until complete', async () => {
type TBatchParts = 'partA' | 'partB';
const state = new smartstate.Smartstate<TBatchParts>();
const partA = await state.getStatePart<ITestState>('partA', {
value: 1,
nested: { data: 'a' }
});
const partB = await state.getStatePart<ITestState>('partB', {
value: 2,
nested: { data: 'b' }
});
const notificationsA: number[] = [];
const notificationsB: number[] = [];
partA.select((s) => s.value).subscribe((v) => notificationsA.push(v));
partB.select((s) => s.value).subscribe((v) => notificationsB.push(v));
// Reset after initial notifications
notificationsA.length = 0;
notificationsB.length = 0;
await state.batch(async () => {
await partA.setState({ value: 10, nested: { data: 'aa' } });
await partB.setState({ value: 20, nested: { data: 'bb' } });
// During batch, no notifications yet
expect(notificationsA).toHaveLength(0);
expect(notificationsB).toHaveLength(0);
});
// After batch, both should have notified
expect(notificationsA).toContain(10);
expect(notificationsB).toContain(20);
});
tap.test('nested batches should only flush at outermost level', async () => {
type TBatchParts = 'nested';
const state = new smartstate.Smartstate<TBatchParts>();
const part = await state.getStatePart<ITestState>('nested', {
value: 0,
nested: { data: 'start' }
});
const values: number[] = [];
part.select((s) => s.value).subscribe((v) => values.push(v));
values.length = 0;
await state.batch(async () => {
await part.setState({ value: 1, nested: { data: 'a' } });
await state.batch(async () => {
await part.setState({ value: 2, nested: { data: 'b' } });
// Still inside outer batch
expect(values).toHaveLength(0);
});
// Inner batch ended but outer batch still active
expect(values).toHaveLength(0);
});
// Now outer batch is done — should see final notification
expect(values.length).toBeGreaterThanOrEqual(1);
expect(values[values.length - 1]).toEqual(2);
});
// ============================
// Computed state tests
// ============================
tap.test('computed should derive from multiple state parts', async () => {
type TComputedParts = 'first' | 'second';
const state = new smartstate.Smartstate<TComputedParts>();
const first = await state.getStatePart<{ count: number }>('first', { count: 5 });
const second = await state.getStatePart<{ count: number }>('second', { count: 10 });
const derived$ = state.computed(
[first, second],
(a, b) => a.count + b.count,
);
const values: number[] = [];
derived$.subscribe((v) => values.push(v));
expect(values).toContain(15);
});
tap.test('computed should update when a source changes', async () => {
type TComputedParts = 'x' | 'y';
const state = new smartstate.Smartstate<TComputedParts>();
const x = await state.getStatePart<{ n: number }>('x', { n: 1 });
const y = await state.getStatePart<{ n: number }>('y', { n: 2 });
const derived$ = state.computed(
[x, y],
(xState, yState) => xState.n * yState.n,
);
const values: number[] = [];
derived$.subscribe((v) => values.push(v));
// Initial: 1 * 2 = 2
expect(values[0]).toEqual(2);
await x.setState({ n: 5 });
// After update: 5 * 2 = 10
expect(values[values.length - 1]).toEqual(10);
});
tap.test('standalone computed function should work', async () => {
type TParts = 'a' | 'b';
const state = new smartstate.Smartstate<TParts>();
const a = await state.getStatePart<{ val: string }>('a', { val: 'hello' });
const b = await state.getStatePart<{ val: string }>('b', { val: 'world' });
const derived$ = smartstate.computed(
[a, b],
(aState, bState) => `${aState.val} ${bState.val}`,
);
const values: string[] = [];
derived$.subscribe((v) => values.push(v));
expect(values[0]).toEqual('hello world');
await a.setState({ val: 'hi' });
expect(values[values.length - 1]).toEqual('hi world');
});
// ============================
// Context Protocol tests
// ============================
tap.test('attachContextProvider should respond to context-request events', async () => {
// EventTarget and CustomEvent are available in Node 18+
if (typeof EventTarget === 'undefined') {
console.log('Skipping context test — EventTarget not available');
return;
}
type TParts = 'ctx';
const state = new smartstate.Smartstate<TParts>();
const statePart = await state.getStatePart<{ theme: string }>('ctx', { theme: 'dark' });
const myContext = Symbol('test-context');
// Use an EventTarget as a mock element
const element = new EventTarget() as any as HTMLElement;
const cleanup = smartstate.attachContextProvider(element, {
context: myContext,
statePart,
});
let receivedValue: any = null;
// Dispatch a context-request event
const event = new CustomEvent('context-request', {
detail: {
context: myContext,
callback: (value: any) => { receivedValue = value; },
subscribe: false,
},
bubbles: true,
composed: true,
});
(element as any).dispatchEvent(event);
expect(receivedValue).toEqual({ theme: 'dark' });
cleanup();
});
tap.test('attachContextProvider should support subscriptions', async () => {
if (typeof EventTarget === 'undefined') {
console.log('Skipping context subscription test — EventTarget not available');
return;
}
type TParts = 'ctxSub';
const state = new smartstate.Smartstate<TParts>();
const statePart = await state.getStatePart<{ count: number }>('ctxSub', { count: 0 });
const myContext = Symbol('sub-context');
const element = new EventTarget() as any as HTMLElement;
const cleanup = smartstate.attachContextProvider(element, {
context: myContext,
statePart,
});
const receivedValues: any[] = [];
let unsubFn: (() => void) | undefined;
const event = new CustomEvent('context-request', {
detail: {
context: myContext,
callback: (value: any, unsub?: () => void) => {
receivedValues.push(value);
if (unsub) unsubFn = unsub;
},
subscribe: true,
},
bubbles: true,
composed: true,
});
(element as any).dispatchEvent(event);
expect(receivedValues).toHaveLength(1);
expect(receivedValues[0]).toEqual({ count: 0 });
// Update state — should trigger subscription callback
await statePart.setState({ count: 42 });
// Give a tick for the subscription to fire
await new Promise<void>((r) => setTimeout(r, 10));
expect(receivedValues.length).toBeGreaterThanOrEqual(2);
expect(receivedValues[receivedValues.length - 1]).toEqual({ count: 42 });
// Unsubscribe
expect(unsubFn).toBeDefined();
unsubFn!();
cleanup();
});
tap.test('attachContextProvider should ignore non-matching contexts', async () => {
if (typeof EventTarget === 'undefined') {
console.log('Skipping context mismatch test — EventTarget not available');
return;
}
type TParts = 'ctxMismatch';
const state = new smartstate.Smartstate<TParts>();
const statePart = await state.getStatePart<{ v: number }>('ctxMismatch', { v: 1 });
const myContext = Symbol('my-context');
const otherContext = Symbol('other-context');
const element = new EventTarget() as any as HTMLElement;
const cleanup = smartstate.attachContextProvider(element, {
context: myContext,
statePart,
});
let called = false;
const event = new CustomEvent('context-request', {
detail: {
context: otherContext,
callback: () => { called = true; },
subscribe: false,
},
bubbles: true,
composed: true,
});
(element as any).dispatchEvent(event);
expect(called).toBeFalse();
cleanup();
});
export default tap.start();

View File

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

8
ts/00_commitinfo_data.ts Normal file
View File

@@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @push.rocks/commitinfo
*/
export const commitinfo = {
name: '@push.rocks/smartstate',
version: '2.1.0',
description: 'A TypeScript-first reactive state management library with middleware, computed state, batching, persistence, and Web Component Context Protocol support.'
}

View File

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

View File

@@ -0,0 +1,16 @@
import * as plugins from './smartstate.plugins.js';
import { combineLatest, map } from 'rxjs';
import type { StatePart } from './smartstate.classes.statepart.js';
/**
* creates a computed observable derived from multiple state parts.
* the observable is lazy — it only subscribes to sources when subscribed to.
*/
export function computed<TResult>(
sources: StatePart<any, any>[],
computeFn: (...states: any[]) => TResult,
): plugins.smartrx.rxjs.Observable<TResult> {
return combineLatest(sources.map((sp) => sp.select())).pipe(
map((states) => computeFn(...states)),
) as plugins.smartrx.rxjs.Observable<TResult>;
}

View File

@@ -1,47 +1,145 @@
import * as plugins from './smartstate.plugins'; import * as plugins from './smartstate.plugins.js';
import { StatePart } from './smartstate.classes.statepart'; import { StatePart } from './smartstate.classes.statepart.js';
import { computed } from './smartstate.classes.computed.js';
export type TInitMode = 'soft' | 'mandatory' | 'force' | 'persistent';
/** /**
* Smartstate takes care of providing state * Smartstate takes care of providing state
*/ */
export class Smartstate<StatePartNameType> { export class Smartstate<StatePartNameType extends string> {
statePartMap: { [key: string]: StatePart<StatePartNameType, any> } = {}; public statePartMap: { [key in StatePartNameType]?: StatePart<StatePartNameType, any> } = {};
private pendingStatePartCreation: Map<string, Promise<StatePart<StatePartNameType, any>>> = new Map();
// Batch support
private batchDepth = 0;
private pendingNotifications = new Set<StatePart<any, any>>();
constructor() {} constructor() {}
getStatePart<PayloadType>( /**
statePartNameArg: StatePartNameType, * whether state changes are currently being batched
initialArg?: PayloadType */
): StatePart<StatePartNameType, PayloadType> { public get isBatching(): boolean {
if (this.statePartMap[statePartNameArg as any]) { return this.batchDepth > 0;
if (initialArg) {
throw new Error(
`${statePartNameArg} already exists, yet you try to set an initial state again`
);
}
return this.statePartMap[statePartNameArg as any];
} else {
if (!initialArg) {
throw new Error(
`${statePartNameArg} does not yet exist, yet you don't provide an initial state`
);
}
return this.createStatePart<PayloadType>(statePartNameArg, initialArg);
}
}
private 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;
return newState;
} }
/** /**
* dispatches an action on the main level * registers a state part for deferred notification during a batch
*/ */
dispatch() {} public registerPendingNotification(statePart: StatePart<any, any>): void {
this.pendingNotifications.add(statePart);
}
/**
* batches multiple state updates so subscribers are only notified once all updates complete
*/
public async batch(updateFn: () => Promise<void> | void): Promise<void> {
this.batchDepth++;
try {
await updateFn();
} finally {
this.batchDepth--;
if (this.batchDepth === 0) {
const pending = [...this.pendingNotifications];
this.pendingNotifications.clear();
for (const sp of pending) {
await sp.notifyChange();
}
}
}
}
/**
* creates a computed observable derived from multiple state parts
*/
public computed<TResult>(
sources: StatePart<StatePartNameType, any>[],
computeFn: (...states: any[]) => TResult,
): plugins.smartrx.rxjs.Observable<TResult> {
return computed(sources, computeFn);
}
/**
* Allows getting and initializing a new statepart
*/
public async getStatePart<PayloadType>(
statePartNameArg: StatePartNameType,
initialArg?: PayloadType,
initMode: TInitMode = 'soft'
): Promise<StatePart<StatePartNameType, PayloadType>> {
// Return pending creation if one exists to prevent duplicate state parts
const pending = this.pendingStatePartCreation.get(statePartNameArg);
if (pending) {
return pending as Promise<StatePart<StatePartNameType, PayloadType>>;
}
const existingStatePart = this.statePartMap[statePartNameArg];
if (existingStatePart) {
switch (initMode) {
case 'mandatory':
throw new Error(
`State part '${statePartNameArg}' already exists, but initMode is 'mandatory'`
);
case 'force':
break;
case 'soft':
case 'persistent':
default:
return existingStatePart as StatePart<StatePartNameType, PayloadType>;
}
} else {
if (!initialArg) {
throw new Error(
`State part '${statePartNameArg}' does not exist and no initial state provided`
);
}
}
const creationPromise = this.createStatePart<PayloadType>(statePartNameArg, initialArg, initMode);
this.pendingStatePartCreation.set(statePartNameArg, creationPromise);
try {
const result = await creationPromise;
return result;
} finally {
this.pendingStatePartCreation.delete(statePartNameArg);
}
}
/**
* Creates a statepart
*/
private async createStatePart<PayloadType>(
statePartName: StatePartNameType,
initialPayloadArg: PayloadType,
initMode: TInitMode = 'soft'
): Promise<StatePart<StatePartNameType, PayloadType>> {
const newState = new StatePart<StatePartNameType, PayloadType>(
statePartName,
initMode === 'persistent'
? {
dbName: 'smartstate',
storeName: statePartName,
}
: null
);
newState.smartstateRef = this;
await newState.init();
const currentState = newState.getState();
if (initMode === 'persistent' && currentState !== undefined) {
await newState.setState({
...initialPayloadArg,
...currentState,
});
} else {
await newState.setState(initialPayloadArg);
}
this.statePartMap[statePartName] = newState;
return newState;
}
} }

View File

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

View File

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

View File

@@ -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() {}
}

View File

@@ -1,72 +1,328 @@
import * as plugins from './smartstate.plugins'; import * as plugins from './smartstate.plugins.js';
import { Observable, shareReplay, takeUntil } from 'rxjs';
import { StateAction, type IActionDef } from './smartstate.classes.stateaction.js';
import type { Smartstate } from './smartstate.classes.smartstate.js';
import { Observable, Subject } from 'rxjs'; export type TMiddleware<TPayload> = (
import { startWith, takeUntil, map } from 'rxjs/operators'; newState: TPayload,
oldState: TPayload | undefined,
) => TPayload | Promise<TPayload>;
import { StateAction, IActionDef } from './smartstate.classes.stateaction'; /**
* creates an Observable that emits once when the given AbortSignal fires
*/
function fromAbortSignal(signal: AbortSignal): Observable<void> {
return new Observable<void>((subscriber) => {
if (signal.aborted) {
subscriber.next();
subscriber.complete();
return;
}
const handler = () => {
subscriber.next();
subscriber.complete();
};
signal.addEventListener('abort', handler);
return () => signal.removeEventListener('abort', handler);
});
}
export class StatePart<TStatePartName, TStatePayload> { export class StatePart<TStatePartName, TStatePayload> {
name: TStatePartName; public name: TStatePartName;
state = new Subject<TStatePayload>(); public state = new plugins.smartrx.rxjs.Subject<TStatePayload>();
stateStore: TStatePayload; public stateStore: TStatePayload | undefined;
public smartstateRef?: Smartstate<any>;
private cumulativeDeferred = plugins.smartpromise.cumulativeDefer();
constructor(nameArg: TStatePartName) { private pendingCumulativeNotification: ReturnType<typeof setTimeout> | null = null;
private pendingBatchNotification = false;
private webStoreOptions: plugins.webstore.IWebStoreOptions;
private webStore: plugins.webstore.WebStore<TStatePayload> | null = null;
private middlewares: TMiddleware<TStatePayload>[] = [];
// Selector memoization
private selectorCache = new WeakMap<Function, plugins.smartrx.rxjs.Observable<any>>();
private defaultSelectObservable: plugins.smartrx.rxjs.Observable<TStatePayload> | null = null;
constructor(nameArg: TStatePartName, webStoreOptionsArg?: plugins.webstore.IWebStoreOptions) {
this.name = nameArg; this.name = nameArg;
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.validateState(storedState)) {
this.stateStore = storedState;
await this.notifyChange();
}
}
} }
/** /**
* gets the state from the state store * gets the state from the state store
*/ */
getState(): TStatePayload { public getState(): TStatePayload | undefined {
return this.stateStore; return this.stateStore;
} }
/** /**
* sets the stateStore to the new state * adds a middleware that intercepts setState calls.
* @param newStateArg * middleware can transform the state or throw to reject it.
* returns a removal function.
*/ */
setState(newStateArg: TStatePayload) { public addMiddleware(middleware: TMiddleware<TStatePayload>): () => void {
this.stateStore = newStateArg; this.middlewares.push(middleware);
this.notifyChange(); return () => {
const idx = this.middlewares.indexOf(middleware);
if (idx !== -1) {
this.middlewares.splice(idx, 1);
}
};
}
/**
* sets the stateStore to the new state
*/
public async setState(newStateArg: TStatePayload) {
// Run middleware chain
let processedState = newStateArg;
for (const mw of this.middlewares) {
processedState = await mw(processedState, this.stateStore);
}
// Validate state structure
if (!this.validateState(processedState)) {
throw new Error(`Invalid state structure for state part '${this.name}'`);
}
// Save to WebStore first to ensure atomicity
if (this.webStore) {
await this.webStore.set(String(this.name), processedState);
}
// Update in-memory state after successful persistence
this.stateStore = processedState;
await this.notifyChange();
return this.stateStore;
}
/**
* Validates state structure - can be overridden for custom validation
*/
protected validateState(stateArg: any): stateArg is TStatePayload {
return stateArg !== null && stateArg !== undefined;
} }
/** /**
* notifies of a change on the state * notifies of a change on the state
*/ */
notifyChange() { public async notifyChange() {
if (!this.stateStore) {
return;
}
// If inside a batch, defer the notification
if (this.smartstateRef?.isBatching) {
this.pendingBatchNotification = true;
this.smartstateRef.registerPendingNotification(this);
return;
}
const createStateHash = async (stateArg: any) => {
return await plugins.smarthashWeb.sha256FromString(plugins.smartjson.stableOneWayStringify(stateArg));
};
const currentHash = await createStateHash(this.stateStore);
if (
this.lastStateNotificationPayloadHash &&
currentHash === this.lastStateNotificationPayloadHash
) {
return;
} else {
this.lastStateNotificationPayloadHash = currentHash;
}
this.state.next(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() {
if (this.pendingCumulativeNotification) {
clearTimeout(this.pendingCumulativeNotification);
}
this.pendingCumulativeNotification = setTimeout(async () => {
this.pendingCumulativeNotification = null;
if (this.stateStore) {
await this.notifyChange();
}
}, 0);
}
/** /**
* selects a state or a substate * selects a state or a substate.
* supports an optional AbortSignal for automatic unsubscription.
* memoizes observables by selector function reference.
*/ */
select<T = TStatePayload>(selectorFn?: (state: TStatePayload) => T): Observable<T> { public select<T = TStatePayload>(
if (!selectorFn) { selectorFn?: (state: TStatePayload) => T,
selectorFn = (state: TStatePayload) => <T>(<any>state); options?: { signal?: AbortSignal }
): plugins.smartrx.rxjs.Observable<T> {
const hasSignal = options?.signal != null;
// Check memoization cache (only for non-signal selects)
if (!hasSignal) {
if (!selectorFn) {
if (this.defaultSelectObservable) {
return this.defaultSelectObservable as unknown as plugins.smartrx.rxjs.Observable<T>;
}
} else if (this.selectorCache.has(selectorFn)) {
return this.selectorCache.get(selectorFn)!;
}
} }
const mapped = this.state.pipe( const effectiveSelectorFn = selectorFn || ((state: TStatePayload) => <T>(<any>state));
startWith(this.getState()),
map(selectorFn) let 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 effectiveSelectorFn(stateArg);
} catch (e) {
console.error(`Selector error in state part '${this.name}':`, e);
return undefined;
}
})
); );
return mapped; if (hasSignal) {
mapped = mapped.pipe(takeUntil(fromAbortSignal(options.signal)));
return mapped;
}
// Apply shareReplay for caching and store in memo cache
const shared = mapped.pipe(shareReplay({ bufferSize: 1, refCount: true }));
if (!selectorFn) {
this.defaultSelectObservable = shared as unknown as plugins.smartrx.rxjs.Observable<TStatePayload>;
} else {
this.selectorCache.set(selectorFn, shared);
}
return shared;
} }
/** /**
* creates an action capable of modifying the state * creates an action capable of modifying the state
*/ */
createAction<TActionPayload>( public createAction<TActionPayload>(
actionDef: IActionDef<TStatePayload, TActionPayload> actionDef: IActionDef<TStatePayload, TActionPayload>
): StateAction<TStatePayload, TActionPayload> { ): StateAction<TStatePayload, TActionPayload> {
return new StateAction(actionDef); return new StateAction(this, actionDef);
} }
/** /**
* dispatches an action on the statepart level * dispatches an action on the statepart level
*/ */
async dispatchAction<T>(stateAction: StateAction<TStatePayload, T>, actionPayload: T) { public async dispatchAction<T>(stateAction: StateAction<TStatePayload, T>, actionPayload: T): Promise<TStatePayload> {
await this.cumulativeDeferred.promise;
const newState = await stateAction.actionDef(this, actionPayload); const newState = await stateAction.actionDef(this, actionPayload);
this.setState(newState); await this.setState(newState);
return this.getState();
}
/**
* waits until a certain part of the state becomes available.
* supports optional timeout and AbortSignal.
*/
public async waitUntilPresent<T = TStatePayload>(
selectorFn?: (state: TStatePayload) => T,
optionsOrTimeout?: number | { timeoutMs?: number; signal?: AbortSignal }
): Promise<T> {
// Parse backward-compatible args
let timeoutMs: number | undefined;
let signal: AbortSignal | undefined;
if (typeof optionsOrTimeout === 'number') {
timeoutMs = optionsOrTimeout;
} else if (optionsOrTimeout) {
timeoutMs = optionsOrTimeout.timeoutMs;
signal = optionsOrTimeout.signal;
}
const done = plugins.smartpromise.defer<T>();
const selectedObservable = this.select(selectorFn);
let resolved = false;
// Check if already aborted
if (signal?.aborted) {
throw new Error('Aborted');
}
const subscription = selectedObservable.subscribe((value) => {
if (value && !resolved) {
resolved = true;
done.resolve(value);
}
});
let timeoutId: ReturnType<typeof setTimeout> | undefined;
if (timeoutMs) {
timeoutId = setTimeout(() => {
if (!resolved) {
resolved = true;
subscription.unsubscribe();
done.reject(new Error(`waitUntilPresent timed out after ${timeoutMs}ms`));
}
}, timeoutMs);
}
// Handle abort signal
const abortHandler = signal ? () => {
if (!resolved) {
resolved = true;
subscription.unsubscribe();
if (timeoutId) clearTimeout(timeoutId);
done.reject(new Error('Aborted'));
}
} : undefined;
if (signal && abortHandler) {
signal.addEventListener('abort', abortHandler);
}
try {
const result = await done.promise;
return result;
} finally {
subscription.unsubscribe();
if (timeoutId) clearTimeout(timeoutId);
if (signal && abortHandler) {
signal.removeEventListener('abort', abortHandler);
}
}
}
/**
* is executed
*/
public async stateSetup(
funcArg: (statePartArg?: StatePart<any, TStatePayload>) => Promise<TStatePayload>
) {
const resultPromise = funcArg(this);
this.cumulativeDeferred.addPromise(resultPromise);
await this.setState(await resultPromise);
} }
} }

View File

@@ -0,0 +1,61 @@
import type { StatePart } from './smartstate.classes.statepart.js';
export interface IContextProviderOptions<TPayload> {
/** the context key (compared by strict equality) */
context: unknown;
/** the state part to provide */
statePart: StatePart<any, TPayload>;
/** optional selector to provide a derived value instead of the full state */
selectorFn?: (state: TPayload) => any;
}
/**
* attaches a Context Protocol provider to an HTML element.
* listens for `context-request` events and responds with the state part's value.
* if subscribe=true, retains the callback and invokes it on every state change.
* returns a cleanup function that removes the listener and unsubscribes.
*/
export function attachContextProvider<TPayload>(
element: HTMLElement,
options: IContextProviderOptions<TPayload>,
): () => void {
const { context, statePart, selectorFn } = options;
const subscribers = new Set<(value: any, unsubscribe?: () => void) => void>();
const subscription = statePart.select(selectorFn).subscribe((value) => {
for (const cb of subscribers) {
cb(value);
}
});
const getValue = (): any => {
const state = statePart.getState();
if (state === undefined) return undefined;
return selectorFn ? selectorFn(state) : state;
};
const handler = (event: Event) => {
const e = event as CustomEvent;
const detail = e.detail;
if (!detail || detail.context !== context) return;
e.stopPropagation();
if (detail.subscribe) {
const cb = detail.callback;
subscribers.add(cb);
const unsubscribe = () => subscribers.delete(cb);
cb(getValue(), unsubscribe);
} else {
detail.callback(getValue());
}
};
element.addEventListener('context-request', handler);
return () => {
element.removeEventListener('context-request', handler);
subscription.unsubscribe();
subscribers.clear();
};
}

View File

@@ -1,7 +1,7 @@
import { Observable } from 'rxjs'; 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';
const rxjsPart = { export { smarthashWeb, smartjson, smartpromise, smartrx, webstore };
Observable
};
export { rxjsPart };

14
tsconfig.json Normal file
View File

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

View File

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