Compare commits
50 Commits
Author | SHA1 | Date | |
---|---|---|---|
776eba09e9 | |||
b41ff5d495 | |||
5f5f9db884 | |||
876042b446 | |||
df2924577b | |||
4abaea84f8 | |||
de454b4c8d | |||
961685b5bd | |||
c622396d50 | |||
d130c1c6fd | |||
f8a967aeac | |||
abee699af8 | |||
a21131eaf6 | |||
c4b214a308 | |||
6db03eee83 | |||
efc5b54d2e | |||
9860e43398 | |||
234117c8dd | |||
371c6553cd | |||
b6b738916f | |||
fad7e0bc6b | |||
fc4fb911ef | |||
7e0dad1c10 | |||
0fb50714b9 | |||
7e1821f37d | |||
592228fc51 | |||
431089e23f | |||
5b64733d91 | |||
2da2a43a09 | |||
f7887a6663 | |||
be505ee915 | |||
9584f403b1 | |||
993a100eae | |||
29f0307ef8 | |||
9413c5bcdc | |||
1d5fb320f4 | |||
69e905ad76 | |||
7b9ed9ee78 | |||
f884807f33 | |||
f167800113 | |||
c549d06a6b | |||
23061c86eb | |||
4d0567a95d | |||
8524c95440 | |||
b1fc60fc2e | |||
8d296cf08d | |||
b8d0ec55ad | |||
1cf78441e2 | |||
0f34c5de55 | |||
1bd8f8371b |
66
.gitea/workflows/default_nottags.yaml
Normal file
66
.gitea/workflows/default_nottags.yaml
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
name: Default (not tags)
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags-ignore:
|
||||||
|
- '**'
|
||||||
|
|
||||||
|
env:
|
||||||
|
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||||
|
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||||
|
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||||
|
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||||
|
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
security:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: true
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Install pnpm and npmci
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
|
||||||
|
- name: Run npm prepare
|
||||||
|
run: npmci npm prepare
|
||||||
|
|
||||||
|
- name: Audit production dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --prod
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Audit development dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --dev
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
test:
|
||||||
|
if: ${{ always() }}
|
||||||
|
needs: security
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Test stable
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm test
|
||||||
|
|
||||||
|
- name: Test build
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm build
|
124
.gitea/workflows/default_tags.yaml
Normal file
124
.gitea/workflows/default_tags.yaml
Normal file
@ -0,0 +1,124 @@
|
|||||||
|
name: Default (tags)
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- '*'
|
||||||
|
|
||||||
|
env:
|
||||||
|
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||||
|
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||||
|
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||||
|
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||||
|
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
security:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: true
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Audit production dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --prod
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Audit development dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --dev
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
test:
|
||||||
|
if: ${{ always() }}
|
||||||
|
needs: security
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Test stable
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm test
|
||||||
|
|
||||||
|
- name: Test build
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm build
|
||||||
|
|
||||||
|
release:
|
||||||
|
needs: test
|
||||||
|
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Release
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm publish
|
||||||
|
|
||||||
|
metadata:
|
||||||
|
needs: test
|
||||||
|
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Code quality
|
||||||
|
run: |
|
||||||
|
npmci command npm install -g typescript
|
||||||
|
npmci npm install
|
||||||
|
|
||||||
|
- name: Trigger
|
||||||
|
run: npmci trigger
|
||||||
|
|
||||||
|
- name: Build docs and upload artifacts
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
pnpm install -g @git.zone/tsdoc
|
||||||
|
npmci command tsdoc
|
||||||
|
continue-on-error: true
|
26
.gitignore
vendored
26
.gitignore
vendored
@ -1,6 +1,20 @@
|
|||||||
.nogit/
|
.nogit/
|
||||||
node_modules/
|
|
||||||
coverage/
|
# artifacts
|
||||||
public/
|
coverage/
|
||||||
pages/
|
public/
|
||||||
.yarn/
|
pages/
|
||||||
|
|
||||||
|
# installs
|
||||||
|
node_modules/
|
||||||
|
|
||||||
|
# caches
|
||||||
|
.yarn/
|
||||||
|
.cache/
|
||||||
|
.rpt2_cache
|
||||||
|
|
||||||
|
# builds
|
||||||
|
dist/
|
||||||
|
dist_*/
|
||||||
|
|
||||||
|
# custom
|
125
.gitlab-ci.yml
125
.gitlab-ci.yml
@ -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
11
.vscode/launch.json
vendored
Normal 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
26
.vscode/settings.json
vendored
Normal 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"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
2
license
2
license
@ -1,4 +1,4 @@
|
|||||||
Copyright (c) 2019 Lossless GmbH (hello@lossless.com)
|
Copyright (c) 2019 Task Venture Capital GmbH (hello@task.vc)
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
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
|
||||||
|
@ -4,12 +4,13 @@
|
|||||||
"npmAccessLevel": "public"
|
"npmAccessLevel": "public"
|
||||||
},
|
},
|
||||||
"gitzone": {
|
"gitzone": {
|
||||||
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "pushrocks",
|
"gitscope": "push.rocks",
|
||||||
"gitrepo": "smartstate",
|
"gitrepo": "smartstate",
|
||||||
"shortDescription": "a package that handles state in a good way",
|
"description": "a package that handles state in a good way",
|
||||||
"npmPackagename": "@pushrocks/smartstate",
|
"npmPackagename": "@push.rocks/smartstate",
|
||||||
"license": "MIT"
|
"license": "MIT"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
1575
package-lock.json
generated
1575
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
50
package.json
50
package.json
@ -1,27 +1,47 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/smartstate",
|
"name": "@push.rocks/smartstate",
|
||||||
"version": "1.0.11",
|
"version": "2.0.12",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "a package that handles state in a good way",
|
"description": "a package that handles state in a good way",
|
||||||
"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/)",
|
||||||
"build": "(tsbuild)",
|
"build": "(tsbuild --web --allowimplicitany && tsbundle npm)",
|
||||||
"format": "(gitzone format)"
|
"buildDocs": "tsdoc"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.8",
|
"@git.zone/tsbuild": "^2.1.70",
|
||||||
"@gitzone/tstest": "^1.0.15",
|
"@git.zone/tsbundle": "^2.0.8",
|
||||||
"@pushrocks/tapbundle": "^3.0.7",
|
"@git.zone/tsrun": "^1.2.46",
|
||||||
"@types/node": "^11.9.4",
|
"@git.zone/tstest": "^1.0.81",
|
||||||
"tslint": "^5.12.1",
|
"@push.rocks/tapbundle": "^5.0.15",
|
||||||
"tslint-config-prettier": "^1.18.0"
|
"@types/node": "^20.8.0"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/lik": "^3.0.4",
|
"@push.rocks/isohash": "^2.0.1",
|
||||||
"rxjs": "^6.4.0"
|
"@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"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"ts/**/*",
|
||||||
|
"ts_web/**/*",
|
||||||
|
"dist/**/*",
|
||||||
|
"dist_*/**/*",
|
||||||
|
"dist_ts/**/*",
|
||||||
|
"dist_ts_web/**/*",
|
||||||
|
"assets/**/*",
|
||||||
|
"cli.js",
|
||||||
|
"npmextra.json",
|
||||||
|
"readme.md"
|
||||||
|
],
|
||||||
|
"browserslist": [
|
||||||
|
"last 1 chrome versions"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
5551
pnpm-lock.yaml
generated
Normal file
5551
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
43
readme.md
43
readme.md
@ -1,26 +1,37 @@
|
|||||||
# @pushrocks/smartstate
|
# @push.rocks/smartstate
|
||||||
a package that handles state in a good way
|
a package that handles state in a good way
|
||||||
|
|
||||||
## Availabililty and Links
|
## Availabililty and Links
|
||||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartstate)
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartstate)
|
||||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartstate)
|
* [gitlab.com (source)](https://gitlab.com/push.rocks/smartstate)
|
||||||
* [github.com (source mirror)](https://github.com/pushrocks/smartstate)
|
* [github.com (source mirror)](https://github.com/push.rocks/smartstate)
|
||||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartstate/)
|
* [docs (typedoc)](https://push.rocks.gitlab.io/smartstate/)
|
||||||
|
|
||||||
## Status for master
|
## Status for master
|
||||||
[](https://gitlab.com/pushrocks/smartstate/commits/master)
|
|
||||||
[](https://gitlab.com/pushrocks/smartstate/commits/master)
|
Status Category | Status Badge
|
||||||
[](https://www.npmjs.com/package/@pushrocks/smartstate)
|
-- | --
|
||||||
[](https://snyk.io/test/npm/@pushrocks/smartstate)
|
GitLab Pipelines | [](https://lossless.cloud)
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
npm | [](https://lossless.cloud)
|
||||||
[](https://prettier.io/)
|
Snyk | [](https://lossless.cloud)
|
||||||
|
TypeScript Support | [](https://lossless.cloud)
|
||||||
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
Code Style | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||||
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
Use TypeScript for best in class intellisense.
|
||||||
|
|
||||||
|
## Contribution
|
||||||
|
|
||||||
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||||
|
|
||||||
For further information read the linked docs at the top of this readme.
|
For further information read the linked docs at the top of this readme.
|
||||||
|
|
||||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
## Legal
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
||||||
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||||
[](https://maintainedby.lossless.com)
|
|
||||||
|
@ -1,49 +1,58 @@
|
|||||||
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 {
|
||||||
currentFavorites: string[];
|
currentFavorites: string[];
|
||||||
deep: {
|
deep: {
|
||||||
hi: number;
|
hi: number;
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
let testState: smartstate.Smartstate<TMyStateParts>;
|
let testState: smartstate.Smartstate<TMyStateParts>;
|
||||||
let testStatePart: smartstate.StatePart<TMyStateParts, TStatePartPayload>;
|
let testStatePart: smartstate.StatePart<TMyStateParts, TStatePartPayload>;
|
||||||
|
|
||||||
tap.test('should create a new SmartState', async () => {
|
tap.test('should create a new SmartState', async () => {
|
||||||
testState = new smartstate.Smartstate<TMyStateParts>();
|
testState = new smartstate.Smartstate<TMyStateParts>();
|
||||||
expect(testState).to.be.instanceOf(smartstate.Smartstate);
|
expect(testState).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 = 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 addFavourite = testStatePart.createAction<string>(async (statePart, payload) => {
|
const done = tools.defer();
|
||||||
const currentState = statePart.getState();
|
const addFavourite = testStatePart.createAction<string>(async (statePart, payload) => {
|
||||||
currentState.currentFavorites.push(payload);
|
const currentState = statePart.getState();
|
||||||
return currentState;
|
currentState.currentFavorites.push(payload);
|
||||||
});
|
return currentState;
|
||||||
await testStatePart.dispatchAction(addFavourite, 'my favourite things');
|
});
|
||||||
expect(testStatePart.getState().currentFavorites).to.include('my favourite things');
|
testStatePart
|
||||||
});
|
.waitUntilPresent((state) => {
|
||||||
|
return state.currentFavorites[0];
|
||||||
tap.start();
|
})
|
||||||
|
.then(() => {
|
||||||
|
done.resolve();
|
||||||
|
});
|
||||||
|
await testStatePart.dispatchAction(addFavourite, 'my favourite things');
|
||||||
|
expect(testStatePart.getState().currentFavorites).toContain('my favourite things');
|
||||||
|
await done.promise;
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* autocreated commitinfo by @pushrocks/commitinfo
|
||||||
|
*/
|
||||||
|
export const commitinfo = {
|
||||||
|
name: '@push.rocks/smartstate',
|
||||||
|
version: '2.0.12',
|
||||||
|
description: 'a package that handles state in a good way'
|
||||||
|
}
|
@ -1,5 +1,3 @@
|
|||||||
export * from './smartstate.classes.smartstate';
|
export * from './smartstate.classes.smartstate.js';
|
||||||
export * from './smartstate.classes.statepart';
|
export * from './smartstate.classes.statepart.js';
|
||||||
export * from './smartstate.classes.statecollection';
|
export * from './smartstate.classes.stateaction.js';
|
||||||
export * from './smartstate.classes.stateaction';
|
|
||||||
export * from './smartstate.classes.stateobservable';
|
|
||||||
|
@ -1,52 +1,57 @@
|
|||||||
import * as plugins from './smartstate.plugins';
|
import * as plugins from './smartstate.plugins.js';
|
||||||
import { StatePart } from './smartstate.classes.statepart';
|
import { StatePart } from './smartstate.classes.statepart.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Smartstate takes care of providing state
|
* Smartstate takes care of providing state
|
||||||
*/
|
*/
|
||||||
export class Smartstate<StatePartNameType> {
|
export class Smartstate<StatePartNameType> {
|
||||||
public statePartMap: { [key: string]: StatePart<StatePartNameType, any> } = {};
|
public statePartMap: { [key: string]: StatePart<StatePartNameType, any> } = {};
|
||||||
|
|
||||||
constructor() {}
|
constructor() {}
|
||||||
|
|
||||||
getStatePart<PayloadType>(
|
/**
|
||||||
statePartNameArg: StatePartNameType,
|
* Allows getting and initializing a new statepart
|
||||||
initialArg?: PayloadType
|
* initMode === 'soft' it will allow existing stateparts
|
||||||
): StatePart<StatePartNameType, PayloadType> {
|
* initMode === 'mandatory' will fail if there is an exiting statepart
|
||||||
if (this.statePartMap[statePartNameArg as any]) {
|
* initMode === 'force' will overwrite any existing statepart
|
||||||
if (initialArg) {
|
* @param statePartNameArg
|
||||||
throw new Error(
|
* @param initialArg
|
||||||
`${statePartNameArg} already exists, yet you try to set an initial state again`
|
* @param initMode
|
||||||
);
|
*/
|
||||||
}
|
public getStatePart<PayloadType>(
|
||||||
return this.statePartMap[statePartNameArg as any];
|
statePartNameArg: string & StatePartNameType,
|
||||||
} else {
|
initialArg?: PayloadType,
|
||||||
if (!initialArg) {
|
initMode?: 'soft' | 'mandatory' | 'force' | 'persistent'
|
||||||
throw new Error(
|
): StatePart<StatePartNameType, PayloadType> {
|
||||||
`${statePartNameArg} does not yet exist, yet you don't provide an initial state`
|
if (this.statePartMap[statePartNameArg as any]) {
|
||||||
);
|
if (initialArg && (!initMode || initMode !== 'soft')) {
|
||||||
}
|
throw new Error(
|
||||||
return this.createStatePart<PayloadType>(statePartNameArg, initialArg);
|
`${statePartNameArg} already exists, yet you try to set an initial state again`
|
||||||
}
|
);
|
||||||
}
|
}
|
||||||
|
return this.statePartMap[statePartNameArg] as StatePart<StatePartNameType, PayloadType>;
|
||||||
/**
|
} else {
|
||||||
* creates a statepart
|
if (!initialArg) {
|
||||||
* @param statePartName
|
throw new Error(
|
||||||
* @param initialPayloadArg
|
`${statePartNameArg} does not yet exist, yet you don't provide an initial state`
|
||||||
*/
|
);
|
||||||
private createStatePart<PayloadType>(
|
}
|
||||||
statePartName: StatePartNameType,
|
return this.createStatePart<PayloadType>(statePartNameArg, initialArg);
|
||||||
initialPayloadArg: PayloadType
|
}
|
||||||
): StatePart<StatePartNameType, PayloadType> {
|
}
|
||||||
const newState = new StatePart<StatePartNameType, PayloadType>(statePartName);
|
|
||||||
newState.setState(initialPayloadArg);
|
/**
|
||||||
this.statePartMap[statePartName as any] = newState;
|
* creates a statepart
|
||||||
return newState;
|
* @param statePartName
|
||||||
}
|
* @param initialPayloadArg
|
||||||
|
*/
|
||||||
/**
|
private createStatePart<PayloadType>(
|
||||||
* dispatches an action on the main level
|
statePartName: StatePartNameType,
|
||||||
*/
|
initialPayloadArg: PayloadType
|
||||||
dispatch() {}
|
): StatePart<StatePartNameType, PayloadType> {
|
||||||
}
|
const newState = new StatePart<StatePartNameType, PayloadType>(statePartName);
|
||||||
|
newState.setState(initialPayloadArg);
|
||||||
|
this.statePartMap[statePartName as any] = newState;
|
||||||
|
return newState;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@ -1,13 +1,20 @@
|
|||||||
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>;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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) {
|
||||||
|
this.statePartRef.dispatchAction(this, payload);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@ -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);
|
|
||||||
}
|
|
||||||
}
|
|
@ -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() {}
|
|
||||||
}
|
|
@ -1,72 +1,155 @@
|
|||||||
import * as plugins from './smartstate.plugins';
|
import * as plugins from './smartstate.plugins.js';
|
||||||
|
import { StateAction, type IActionDef } from './smartstate.classes.stateaction.js';
|
||||||
import { Observable, Subject } from 'rxjs';
|
|
||||||
import { startWith, takeUntil, map } from 'rxjs/operators';
|
export class StatePart<TStatePartName, TStatePayload> {
|
||||||
|
public name: TStatePartName;
|
||||||
import { StateAction, IActionDef } from './smartstate.classes.stateaction';
|
public state = new plugins.smartrx.rxjs.Subject<TStatePayload>();
|
||||||
|
public stateStore: TStatePayload;
|
||||||
export class StatePart<TStatePartName, TStatePayload> {
|
private cumulativeDeferred = plugins.smartpromise.cumulativeDefer();
|
||||||
name: TStatePartName;
|
|
||||||
state = new Subject<TStatePayload>();
|
private webStore: plugins.webstore.WebStore<TStatePayload> | null = null; // Add WebStore instance
|
||||||
stateStore: TStatePayload;
|
|
||||||
|
constructor(nameArg: TStatePartName, webStoreOptions?: plugins.webstore.IWebStoreOptions) {
|
||||||
constructor(nameArg: TStatePartName) {
|
this.name = nameArg;
|
||||||
this.name = nameArg;
|
|
||||||
}
|
// Initialize WebStore if webStoreOptions are provided
|
||||||
|
if (webStoreOptions) {
|
||||||
/**
|
this.webStore = new plugins.webstore.WebStore<TStatePayload>(webStoreOptions);
|
||||||
* gets the state from the state store
|
this.initWebStore();
|
||||||
*/
|
}
|
||||||
getState(): TStatePayload {
|
}
|
||||||
return this.stateStore;
|
|
||||||
}
|
/**
|
||||||
|
* initializes the webstore
|
||||||
/**
|
*/
|
||||||
* sets the stateStore to the new state
|
private async initWebStore() {
|
||||||
* @param newStateArg
|
if (this.webStore) {
|
||||||
*/
|
await this.webStore.init();
|
||||||
setState(newStateArg: TStatePayload) {
|
const storedState = await this.webStore.get(String(this.name));
|
||||||
this.stateStore = newStateArg;
|
if (storedState) {
|
||||||
this.notifyChange();
|
this.stateStore = storedState;
|
||||||
}
|
this.notifyChange();
|
||||||
|
}
|
||||||
/**
|
}
|
||||||
* notifies of a change on the state
|
}
|
||||||
*/
|
|
||||||
notifyChange() {
|
/**
|
||||||
this.state.next(this.stateStore);
|
* gets the state from the state store
|
||||||
}
|
*/
|
||||||
|
public getState(): TStatePayload {
|
||||||
/**
|
return this.stateStore;
|
||||||
* selects a state or a substate
|
}
|
||||||
*/
|
|
||||||
select<T = TStatePayload>(selectorFn?: (state: TStatePayload) => T): Observable<T> {
|
/**
|
||||||
if (!selectorFn) {
|
* sets the stateStore to the new state
|
||||||
selectorFn = (state: TStatePayload) => <T>(<any>state);
|
* @param newStateArg
|
||||||
}
|
*/
|
||||||
|
public async setState(newStateArg: TStatePayload) {
|
||||||
const mapped = this.state.pipe(
|
this.stateStore = newStateArg;
|
||||||
startWith(this.getState()),
|
this.notifyChange();
|
||||||
map(selectorFn)
|
|
||||||
);
|
// Save state to WebStore if initialized
|
||||||
|
if (this.webStore) {
|
||||||
return mapped;
|
await this.webStore.set(String(this.name), newStateArg);
|
||||||
}
|
}
|
||||||
|
}
|
||||||
/**
|
|
||||||
* creates an action capable of modifying the state
|
/**
|
||||||
*/
|
* notifies of a change on the state
|
||||||
createAction<TActionPayload>(
|
*/
|
||||||
actionDef: IActionDef<TStatePayload, TActionPayload>
|
public notifyChange() {
|
||||||
): StateAction<TStatePayload, TActionPayload> {
|
const createStateHash = (stateArg: any) => {
|
||||||
return new StateAction(actionDef);
|
return plugins.isohash.sha256FromString(plugins.smartjson.stringify(stateArg));
|
||||||
}
|
};
|
||||||
|
if (
|
||||||
/**
|
this.stateStore &&
|
||||||
* dispatches an action on the statepart level
|
this.lastStateNotificationPayloadHash &&
|
||||||
*/
|
createStateHash(this.stateStore) === this.lastStateNotificationPayloadHash
|
||||||
async dispatchAction<T>(stateAction: StateAction<TStatePayload, T>, actionPayload: T) {
|
) {
|
||||||
const newState = await stateAction.actionDef(this, actionPayload);
|
return;
|
||||||
this.setState(newState);
|
} else {
|
||||||
}
|
this.lastStateNotificationPayloadHash = this.stateStore;
|
||||||
}
|
}
|
||||||
|
this.state.next(this.stateStore);
|
||||||
|
}
|
||||||
|
private lastStateNotificationPayloadHash: any;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* creates a cumulative notification by adding a change notification at the end of the call stack;
|
||||||
|
*/
|
||||||
|
public notifyChangeCumulative() {
|
||||||
|
// TODO: check viability
|
||||||
|
setTimeout(() => this.state.next(this.stateStore), 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* selects a state or a substate
|
||||||
|
*/
|
||||||
|
public select<T = TStatePayload>(
|
||||||
|
selectorFn?: (state: TStatePayload) => T
|
||||||
|
): plugins.smartrx.rxjs.Observable<T> {
|
||||||
|
if (!selectorFn) {
|
||||||
|
selectorFn = (state: TStatePayload) => <T>(<any>state);
|
||||||
|
}
|
||||||
|
const mapped = this.state.pipe(
|
||||||
|
plugins.smartrx.rxjs.ops.startWith(this.getState()),
|
||||||
|
plugins.smartrx.rxjs.ops.map((stateArg) => {
|
||||||
|
try {
|
||||||
|
return selectorFn(stateArg);
|
||||||
|
} catch (e) {
|
||||||
|
// Nothing here
|
||||||
|
}
|
||||||
|
})
|
||||||
|
);
|
||||||
|
return mapped;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* creates an action capable of modifying the state
|
||||||
|
*/
|
||||||
|
public createAction<TActionPayload>(
|
||||||
|
actionDef: IActionDef<TStatePayload, TActionPayload>
|
||||||
|
): StateAction<TStatePayload, TActionPayload> {
|
||||||
|
return new StateAction(this, actionDef);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* dispatches an action on the statepart level
|
||||||
|
*/
|
||||||
|
public async dispatchAction<T>(stateAction: StateAction<TStatePayload, T>, actionPayload: T): Promise<TStatePayload> {
|
||||||
|
await this.cumulativeDeferred.promise;
|
||||||
|
const newState = await stateAction.actionDef(this, actionPayload);
|
||||||
|
await this.setState(newState);
|
||||||
|
return this.getState();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* waits until a certain part of the state becomes available
|
||||||
|
* @param selectorFn
|
||||||
|
*/
|
||||||
|
public async waitUntilPresent<T = TStatePayload>(
|
||||||
|
selectorFn?: (state: TStatePayload) => T
|
||||||
|
): Promise<T> {
|
||||||
|
const done = plugins.smartpromise.defer<T>();
|
||||||
|
const selectedObservable = this.select(selectorFn);
|
||||||
|
const subscription = selectedObservable.subscribe(async (value) => {
|
||||||
|
if (value) {
|
||||||
|
done.resolve(value);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
const result = await done.promise;
|
||||||
|
subscription.unsubscribe();
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* is executed
|
||||||
|
*/
|
||||||
|
public async stateSetup(
|
||||||
|
funcArg: (statePartArg?: StatePart<any, TStatePayload>) => Promise<TStatePayload>
|
||||||
|
) {
|
||||||
|
const resultPromise = funcArg(this);
|
||||||
|
this.cumulativeDeferred.addPromise(resultPromise);
|
||||||
|
this.setState(await resultPromise);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
import { Observable } from 'rxjs';
|
import * as isohash from '@push.rocks/isohash';
|
||||||
|
import * as smartjson from '@push.rocks/smartjson';
|
||||||
const rxjsPart = {
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
Observable
|
import * as smartrx from '@push.rocks/smartrx';
|
||||||
};
|
import * as webstore from '@push.rocks/webstore';
|
||||||
|
|
||||||
export { rxjsPart };
|
export { isohash, smartjson, smartpromise, smartrx, webstore };
|
||||||
|
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"experimentalDecorators": true,
|
||||||
|
"useDefineForClassFields": false,
|
||||||
|
"target": "ES2022",
|
||||||
|
"module": "NodeNext",
|
||||||
|
"moduleResolution": "NodeNext",
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"verbatimModuleSyntax": true
|
||||||
|
},
|
||||||
|
"exclude": [
|
||||||
|
"dist_*/**/*.d.ts"
|
||||||
|
]
|
||||||
|
}
|
17
tslint.json
17
tslint.json
@ -1,17 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
|
||||||
"rules": {
|
|
||||||
"semicolon": [true, "always"],
|
|
||||||
"no-console": false,
|
|
||||||
"ordered-imports": false,
|
|
||||||
"object-literal-sort-keys": false,
|
|
||||||
"member-ordering": {
|
|
||||||
"options":{
|
|
||||||
"order": [
|
|
||||||
"static-method"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"defaultSeverity": "warning"
|
|
||||||
}
|
|
Reference in New Issue
Block a user