Compare commits
33 Commits
Author | SHA1 | Date | |
---|---|---|---|
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 | |||
ef263a85b4 | |||
315156aac5 | |||
f90a61b38b | |||
71af6f08f3 | |||
01e938274d | |||
c5a3eb63ad | |||
a4d43456d7 |
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
|
149
.gitlab-ci.yml
149
.gitlab-ci.yml
@ -1,16 +1,19 @@
|
|||||||
# gitzone standard
|
# gitzone ci_default
|
||||||
image: hosttoday/ht-docker-node:npmci
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
|
||||||
cache:
|
cache:
|
||||||
paths:
|
paths:
|
||||||
- .npmci_cache/
|
- .npmci_cache/
|
||||||
key: "$CI_BUILD_STAGE"
|
key: '$CI_BUILD_STAGE'
|
||||||
|
|
||||||
stages:
|
stages:
|
||||||
- security
|
- security
|
||||||
- test
|
- test
|
||||||
- release
|
- release
|
||||||
- metadata
|
- metadata
|
||||||
|
|
||||||
|
before_script:
|
||||||
|
- npm install -g @shipzone/npmci
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# security stage
|
# security stage
|
||||||
@ -18,127 +21,115 @@ stages:
|
|||||||
mirror:
|
mirror:
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci git mirror
|
- npmci git mirror
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- notpriv
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
snyk:
|
auditProductionDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci command npm install -g snyk
|
- npmci command npm install --production --ignore-scripts
|
||||||
- npmci command npm install --ignore-scripts
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
- npmci command snyk test
|
- npmci command npm audit --audit-level=high --only=prod --production
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
|
||||||
sast:
|
|
||||||
stage: security
|
|
||||||
image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
|
|
||||||
variables:
|
|
||||||
DOCKER_DRIVER: overlay2
|
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
services:
|
|
||||||
- docker:stable-dind
|
auditDevDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci npm install
|
- npmci command npm install --ignore-scripts
|
||||||
- npmci command npm run build
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
|
- npmci command npm audit --audit-level=high --only=dev
|
||||||
- docker run
|
|
||||||
--env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
|
|
||||||
--volume "$PWD:/code"
|
|
||||||
--volume /var/run/docker.sock:/var/run/docker.sock
|
|
||||||
"registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
|
|
||||||
artifacts:
|
|
||||||
reports:
|
|
||||||
sast: gl-sast-report.json
|
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
- priv
|
allow_failure: true
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# test stage
|
# test stage
|
||||||
# ====================
|
# ====================
|
||||||
|
|
||||||
testLTS:
|
testStable:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci node install lts
|
- npmci node install stable
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci npm test
|
- npmci npm test
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
testBuild:
|
||||||
testSTABLE:
|
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci node install stable
|
- npmci node install stable
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci npm test
|
- npmci command npm run build
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
|
||||||
|
|
||||||
release:
|
release:
|
||||||
stage: release
|
stage: release
|
||||||
script:
|
script:
|
||||||
- npmci node install stable
|
- npmci node install stable
|
||||||
- npmci npm publish
|
- npmci npm publish
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- notpriv
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# metadata stage
|
# metadata stage
|
||||||
# ====================
|
# ====================
|
||||||
codequality:
|
codequality:
|
||||||
stage: metadata
|
stage: metadata
|
||||||
image: docker:stable
|
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
services:
|
only:
|
||||||
- docker:stable-dind
|
- tags
|
||||||
script:
|
script:
|
||||||
- export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
|
- npmci command npm install -g tslint typescript
|
||||||
- docker run
|
- npmci npm prepare
|
||||||
--env SOURCE_CODE="$PWD"
|
- npmci npm install
|
||||||
--volume "$PWD":/code
|
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||||
--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:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- priv
|
- docker
|
||||||
|
- priv
|
||||||
|
|
||||||
trigger:
|
trigger:
|
||||||
stage: metadata
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
- npmci trigger
|
- npmci trigger
|
||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- notpriv
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
pages:
|
pages:
|
||||||
image: hosttoday/ht-docker-node:npmci
|
|
||||||
stage: metadata
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
- npmci command npm install -g typedoc typescript
|
- npmci node install lts
|
||||||
|
- npmci command npm install -g @gitzone/tsdoc
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
|
- npmci command tsdoc
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
only:
|
only:
|
||||||
@ -146,5 +137,5 @@ pages:
|
|||||||
artifacts:
|
artifacts:
|
||||||
expire_in: 1 week
|
expire_in: 1 week
|
||||||
paths:
|
paths:
|
||||||
- public
|
- public
|
||||||
allow_failure: true
|
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"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
@ -4,11 +4,12 @@
|
|||||||
"npmAccessLevel": "public"
|
"npmAccessLevel": "public"
|
||||||
},
|
},
|
||||||
"gitzone": {
|
"gitzone": {
|
||||||
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "pushrocks",
|
"gitscope": "pushrocks",
|
||||||
"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": "@pushrocks/smartstate",
|
||||||
"license": "MIT"
|
"license": "MIT"
|
||||||
}
|
}
|
||||||
|
19554
package-lock.json
generated
19554
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
45
package.json
45
package.json
@ -1,27 +1,44 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/smartstate",
|
"name": "@pushrocks/smartstate",
|
||||||
"version": "1.0.8",
|
"version": "2.0.0",
|
||||||
"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)"
|
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.8",
|
"@gitzone/tsbuild": "^2.1.61",
|
||||||
"@gitzone/tstest": "^1.0.15",
|
"@gitzone/tsbundle": "^1.0.101",
|
||||||
"@pushrocks/tapbundle": "^3.0.7",
|
"@gitzone/tstest": "^1.0.70",
|
||||||
"@types/node": "^11.9.4",
|
"@pushrocks/tapbundle": "^5.0.3",
|
||||||
"tslint": "^5.12.1",
|
"@types/node": "^17.0.23"
|
||||||
"tslint-config-prettier": "^1.18.0"
|
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/lik": "^3.0.4",
|
"@pushrocks/isohash": "^2.0.0",
|
||||||
"rxjs": "^6.4.0"
|
"@pushrocks/lik": "^5.0.4",
|
||||||
}
|
"@pushrocks/smartjson": "^4.0.6",
|
||||||
|
"@pushrocks/smartpromise": "^3.1.7",
|
||||||
|
"@pushrocks/smartrx": "^2.0.25"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"ts/**/*",
|
||||||
|
"ts_web/**/*",
|
||||||
|
"dist/**/*",
|
||||||
|
"dist_*/**/*",
|
||||||
|
"dist_ts/**/*",
|
||||||
|
"dist_ts_web/**/*",
|
||||||
|
"assets/**/*",
|
||||||
|
"cli.js",
|
||||||
|
"npmextra.json",
|
||||||
|
"readme.md"
|
||||||
|
],
|
||||||
|
"browserslist": [
|
||||||
|
"last 1 chrome versions"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
31
readme.md
31
readme.md
@ -8,19 +8,32 @@ a package that handles state in a good way
|
|||||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartstate/)
|
* [docs (typedoc)](https://pushrocks.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)
|
||||||
|
Platform support | [](https://lossless.cloud) [](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)
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||||
|
|
||||||
[](https://maintainedby.lossless.com)
|
[](https://maintainedby.lossless.com)
|
||||||
|
58
test/test.node.ts
Normal file
58
test/test.node.ts
Normal file
@ -0,0 +1,58 @@
|
|||||||
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
|
import * as smartstate from '../ts/index.js';
|
||||||
|
|
||||||
|
type TMyStateParts = 'testStatePart';
|
||||||
|
interface TStatePartPayload {
|
||||||
|
currentFavorites: string[];
|
||||||
|
deep: {
|
||||||
|
hi: number;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
let testState: smartstate.Smartstate<TMyStateParts>;
|
||||||
|
let testStatePart: smartstate.StatePart<TMyStateParts, TStatePartPayload>;
|
||||||
|
|
||||||
|
tap.test('should create a new SmartState', async () => {
|
||||||
|
testState = new smartstate.Smartstate<TMyStateParts>();
|
||||||
|
expect(testState).toBeInstanceOf(smartstate.Smartstate);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should create a new StatePart', async () => {
|
||||||
|
testStatePart = testState.getStatePart<TStatePartPayload>('testStatePart', {
|
||||||
|
currentFavorites: [],
|
||||||
|
deep: {
|
||||||
|
hi: 2,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
expect(testStatePart).toBeInstanceOf(smartstate.StatePart);
|
||||||
|
console.log(testStatePart);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should select something', async () => {
|
||||||
|
testStatePart
|
||||||
|
.select((state) => state.deep.hi)
|
||||||
|
.subscribe((substate) => {
|
||||||
|
expect(substate).toEqual(2);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should dispatch a state action', async (tools) => {
|
||||||
|
const done = tools.defer();
|
||||||
|
const addFavourite = testStatePart.createAction<string>(async (statePart, payload) => {
|
||||||
|
const currentState = statePart.getState();
|
||||||
|
currentState.currentFavorites.push(payload);
|
||||||
|
return currentState;
|
||||||
|
});
|
||||||
|
testStatePart
|
||||||
|
.waitUntilPresent((state) => {
|
||||||
|
return state.currentFavorites[0];
|
||||||
|
})
|
||||||
|
.then(() => {
|
||||||
|
done.resolve();
|
||||||
|
});
|
||||||
|
await testStatePart.dispatchAction(addFavourite, 'my favourite things');
|
||||||
|
expect(testStatePart.getState().currentFavorites).toContain('my favourite things');
|
||||||
|
await done.promise;
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
41
test/test.ts
41
test/test.ts
@ -1,41 +0,0 @@
|
|||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
|
||||||
import * as smartstate from '../ts/index';
|
|
||||||
|
|
||||||
type TMyStateParts = 'testStatePart';
|
|
||||||
interface TStatePartPayload {
|
|
||||||
currentFavorites: string[];
|
|
||||||
deep: {
|
|
||||||
hi: number;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
let testState: smartstate.Smartstate<TMyStateParts>;
|
|
||||||
let testStatePart: smartstate.StatePart<TMyStateParts, TStatePartPayload>;
|
|
||||||
|
|
||||||
tap.test('should create a new SmartState', async () => {
|
|
||||||
testState = new smartstate.Smartstate<TMyStateParts>();
|
|
||||||
expect(testState).to.be.instanceOf(smartstate.Smartstate);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('should create a new StatePart', async () => {
|
|
||||||
testStatePart = testState.getStatePart<TStatePartPayload>('testStatePart', {
|
|
||||||
currentFavorites: [],
|
|
||||||
deep: {
|
|
||||||
hi: 2
|
|
||||||
}
|
|
||||||
});
|
|
||||||
expect(testStatePart).to.be.instanceOf(smartstate.StatePart);
|
|
||||||
console.log(testStatePart);
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('should select something', async () => {
|
|
||||||
testStatePart
|
|
||||||
.select(state => state.deep)
|
|
||||||
.subscribe(substate => {
|
|
||||||
console.log(substate);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
tap.test('should dispatch a state action', async () => {});
|
|
||||||
|
|
||||||
tap.start();
|
|
@ -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,47 +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> {
|
||||||
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'
|
||||||
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>;
|
||||||
private createStatePart<PayloadType>(
|
} else {
|
||||||
statePartName: StatePartNameType,
|
if (!initialArg) {
|
||||||
initialPayloadArg: PayloadType
|
throw new Error(
|
||||||
): StatePart<StatePartNameType, PayloadType> {
|
`${statePartNameArg} does not yet exist, yet you don't provide an initial state`
|
||||||
const newState = new StatePart<StatePartNameType, PayloadType>(statePartName);
|
);
|
||||||
newState.setState(initialPayloadArg);
|
}
|
||||||
this.statePartMap[statePartName as any] = newState;
|
return this.createStatePart<PayloadType>(statePartNameArg, initialArg);
|
||||||
return newState;
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* dispatches an action on the main level
|
* creates a statepart
|
||||||
*/
|
* @param statePartName
|
||||||
dispatch() {}
|
* @param initialPayloadArg
|
||||||
}
|
*/
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@ -1,8 +1,20 @@
|
|||||||
import * as plugins from './smartstate.plugins';
|
import * as plugins from './smartstate.plugins.js';
|
||||||
|
import { StatePart } from './smartstate.classes.statepart.js';
|
||||||
/**
|
|
||||||
* an actionmodifier for the state
|
export interface IActionDef<TStateType, TActionPayloadType> {
|
||||||
*/
|
(stateArg: StatePart<any, TStateType>, actionPayload: TActionPayloadType): Promise<TStateType>;
|
||||||
export class StateAction<StatePayload> {
|
}
|
||||||
constructor(public actionDef: (stateArg: StatePayload) => StatePayload) {}
|
|
||||||
}
|
/**
|
||||||
|
* an actionmodifier for the state
|
||||||
|
*/
|
||||||
|
export class StateAction<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,63 +1,104 @@
|
|||||||
import * as plugins from './smartstate.plugins';
|
import * as plugins from './smartstate.plugins.js';
|
||||||
|
import { StateAction, 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 } from './smartstate.classes.stateaction';
|
public state = new plugins.smartrx.rxjs.Subject<TStatePayload>();
|
||||||
|
public stateStore: TStatePayload;
|
||||||
export class StatePart<StatePartNameType, PayloadType> {
|
|
||||||
name: StatePartNameType;
|
constructor(nameArg: TStatePartName) {
|
||||||
state = new Subject<PayloadType>();
|
this.name = nameArg;
|
||||||
stateStore: PayloadType;
|
}
|
||||||
|
|
||||||
constructor(nameArg: StatePartNameType) {
|
/**
|
||||||
this.name = nameArg;
|
* gets the state from the state store
|
||||||
}
|
*/
|
||||||
|
public getState(): TStatePayload {
|
||||||
/**
|
return this.stateStore;
|
||||||
* gets the state from the state store
|
}
|
||||||
*/
|
|
||||||
getState(): PayloadType {
|
/**
|
||||||
return this.stateStore;
|
* sets the stateStore to the new state
|
||||||
}
|
* @param newStateArg
|
||||||
|
*/
|
||||||
/**
|
public setState(newStateArg: TStatePayload) {
|
||||||
* sets the stateStore to the new state
|
this.stateStore = newStateArg;
|
||||||
* @param newStateArg
|
this.notifyChange();
|
||||||
*/
|
}
|
||||||
setState(newStateArg: PayloadType) {
|
|
||||||
this.stateStore = newStateArg;
|
/**
|
||||||
this.notifyChange();
|
* notifies of a change on the state
|
||||||
}
|
*/
|
||||||
|
public notifyChange() {
|
||||||
/**
|
const createStateHash = (stateArg: any) => {
|
||||||
* notifies of a change on the state
|
return plugins.isohash.sha256FromString(plugins.smartjson.stringify(stateArg));
|
||||||
*/
|
};
|
||||||
notifyChange() {
|
if (this.stateStore && this.lastStateNotificationPayloadHash && createStateHash(this.stateStore) === createStateHash(this.lastStateNotificationPayloadHash)) {
|
||||||
this.state.next(this.stateStore);
|
return;
|
||||||
}
|
} else {
|
||||||
|
this.lastStateNotificationPayloadHash = this.stateStore;
|
||||||
/**
|
}
|
||||||
* selects a state or a substate
|
this.state.next(this.stateStore);
|
||||||
*/
|
}
|
||||||
select<T = PayloadType>(selectorFn?: (state: PayloadType) => T): Observable<T> {
|
private lastStateNotificationPayloadHash: any;
|
||||||
if (!selectorFn) {
|
|
||||||
selectorFn = (state: PayloadType) => <T>(<any>state);
|
/**
|
||||||
}
|
* selects a state or a substate
|
||||||
|
*/
|
||||||
const mapped = this.state.pipe(
|
public select<T = TStatePayload>(
|
||||||
startWith(this.getState()),
|
selectorFn?: (state: TStatePayload) => T
|
||||||
map(selectorFn)
|
): plugins.smartrx.rxjs.Observable<T> {
|
||||||
);
|
if (!selectorFn) {
|
||||||
|
selectorFn = (state: TStatePayload) => <T>(<any>state);
|
||||||
return mapped;
|
}
|
||||||
}
|
|
||||||
|
const mapped = this.state.pipe(
|
||||||
/**
|
plugins.smartrx.rxjs.ops.startWith(this.getState()),
|
||||||
* dispatches an action on the statepart level
|
plugins.smartrx.rxjs.ops.map((stateArg) => {
|
||||||
*/
|
try {
|
||||||
async dispatch(stateAction: StateAction<PayloadType>) {
|
return selectorFn(stateArg);
|
||||||
const newState = stateAction.actionDef(this.getState());
|
} catch (e) {
|
||||||
this.setState(newState);
|
// 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) {
|
||||||
|
const newState = await stateAction.actionDef(this, actionPayload);
|
||||||
|
this.setState(newState);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@ -1,7 +1,6 @@
|
|||||||
import { Observable } from 'rxjs';
|
import * as isohash from '@pushrocks/isohash';
|
||||||
|
import * as smartjson from '@pushrocks/smartjson';
|
||||||
const rxjsPart = {
|
import * as smartpromise from '@pushrocks/smartpromise';
|
||||||
Observable
|
import * as smartrx from '@pushrocks/smartrx';
|
||||||
};
|
|
||||||
|
export { isohash, smartjson, smartpromise, smartrx };
|
||||||
export { rxjsPart };
|
|
||||||
|
9
tsconfig.json
Normal file
9
tsconfig.json
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"experimentalDecorators": true,
|
||||||
|
"useDefineForClassFields": false,
|
||||||
|
"target": "ES2022",
|
||||||
|
"module": "ES2022",
|
||||||
|
"moduleResolution": "nodenext"
|
||||||
|
}
|
||||||
|
}
|
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