Compare commits
28 Commits
Author | SHA1 | Date | |
---|---|---|---|
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 |
4
.gitignore
vendored
4
.gitignore
vendored
@ -15,8 +15,6 @@ node_modules/
|
|||||||
|
|
||||||
# builds
|
# builds
|
||||||
dist/
|
dist/
|
||||||
dist_web/
|
dist_*/
|
||||||
dist_serve/
|
|
||||||
dist_ts_web/
|
|
||||||
|
|
||||||
# custom
|
# custom
|
107
.gitlab-ci.yml
107
.gitlab-ci.yml
@ -3,36 +3,47 @@ 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:
|
||||||
|
- pnpm install -g pnpm
|
||||||
|
- pnpm install -g @shipzone/npmci
|
||||||
|
- npmci npm prepare
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# security stage
|
# security stage
|
||||||
# ====================
|
# ====================
|
||||||
mirror:
|
# ====================
|
||||||
|
# security stage
|
||||||
|
# ====================
|
||||||
|
auditProductionDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci git mirror
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
- npmci command pnpm audit --audit-level=high --prod
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- notpriv
|
- docker
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
snyk:
|
auditDevDependencies:
|
||||||
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
- npmci command npm install -g snyk
|
- npmci command pnpm audit --audit-level=high --dev
|
||||||
- npmci command npm install --ignore-scripts
|
|
||||||
- npmci command snyk test
|
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- lossless
|
||||||
- notpriv
|
- docker
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
# ====================
|
# ====================
|
||||||
# test stage
|
# test stage
|
||||||
@ -41,37 +52,34 @@ snyk:
|
|||||||
testStable:
|
testStable:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci node install stable
|
||||||
- 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
|
||||||
- priv
|
|
||||||
|
|
||||||
testBuild:
|
testBuild:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci npm prepare
|
- npmci node install stable
|
||||||
- npmci node install stable
|
- npmci npm install
|
||||||
- npmci npm install
|
- npmci npm build
|
||||||
- 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
|
||||||
@ -79,35 +87,36 @@ release:
|
|||||||
codequality:
|
codequality:
|
||||||
stage: metadata
|
stage: metadata
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
script:
|
script:
|
||||||
- npmci command npm install -g tslint typescript
|
- npmci command npm install -g typescript
|
||||||
|
- npmci npm prepare
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
|
||||||
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-dbase:npmci
|
|
||||||
services:
|
|
||||||
- docker:stable-dind
|
|
||||||
stage: metadata
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
- npmci command npm install -g @gitzone/tsdoc
|
- npmci node install stable
|
||||||
- npmci npm prepare
|
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command tsdoc
|
- npmci command npm run buildDocs
|
||||||
tags:
|
tags:
|
||||||
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
- notpriv
|
- notpriv
|
||||||
only:
|
only:
|
||||||
@ -115,5 +124,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"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
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,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"
|
||||||
}
|
}
|
||||||
|
1739
package-lock.json
generated
1739
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
47
package.json
47
package.json
@ -1,39 +1,46 @@
|
|||||||
{
|
{
|
||||||
"name": "@pushrocks/smartstate",
|
"name": "@pushrocks/smartstate",
|
||||||
"version": "1.0.13",
|
"version": "2.0.3",
|
||||||
"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.17",
|
"@gitzone/tsbuild": "^2.1.61",
|
||||||
"@gitzone/tstest": "^1.0.24",
|
"@gitzone/tsbundle": "^2.0.7",
|
||||||
"@pushrocks/tapbundle": "^3.0.13",
|
"@gitzone/tsrun": "^1.2.39",
|
||||||
"@types/node": "^12.7.7",
|
"@gitzone/tstest": "^1.0.70",
|
||||||
"tslint": "^5.20.0",
|
"@pushrocks/tapbundle": "^5.0.3",
|
||||||
"tslint-config-prettier": "^1.18.0"
|
"@types/node": "^18.15.11"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@pushrocks/lik": "^3.0.11",
|
"@pushrocks/isohash": "^2.0.0",
|
||||||
"@pushrocks/smartpromise": "^3.0.5",
|
"@pushrocks/lik": "^6.0.2",
|
||||||
"rxjs": "^6.5.3"
|
"@pushrocks/smartjson": "^5.0.5",
|
||||||
|
"@pushrocks/smartpromise": "^4.0.0",
|
||||||
|
"@pushrocks/smartrx": "^3.0.0"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"ts/*",
|
"ts/**/*",
|
||||||
"ts_web/*",
|
"ts_web/**/*",
|
||||||
"dist/*",
|
"dist/**/*",
|
||||||
"dist_web/*",
|
"dist_*/**/*",
|
||||||
"dist_ts_web/*",
|
"dist_ts/**/*",
|
||||||
"assets/*",
|
"dist_ts_web/**/*",
|
||||||
|
"assets/**/*",
|
||||||
"cli.js",
|
"cli.js",
|
||||||
"npmextra.json",
|
"npmextra.json",
|
||||||
"readme.md"
|
"readme.md"
|
||||||
|
],
|
||||||
|
"browserslist": [
|
||||||
|
"last 1 chrome versions"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
3948
pnpm-lock.yaml
generated
Normal file
3948
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
31
readme.md
31
readme.md
@ -8,19 +8,30 @@ 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)
|
||||||
|
|
||||||
## 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
|
||||||
|
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
||||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
| 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 '@pushrocks/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: '@pushrocks/smartstate',
|
||||||
|
version: '2.0.3',
|
||||||
|
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() {}
|
||||||
|
|
||||||
public 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>;
|
||||||
/**
|
} 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
|
||||||
public dispatch() {}
|
): StatePart<StatePartNameType, PayloadType> {
|
||||||
}
|
const newState = new StatePart<StatePartNameType, PayloadType>(statePartName);
|
||||||
|
newState.setState(initialPayloadArg);
|
||||||
|
this.statePartMap[statePartName as any] = newState;
|
||||||
|
return newState;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@ -1,17 +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 statePartRef: StatePart<any, any>, public actionDef: IActionDef<TStateType, TActionPayloadType>) {}
|
constructor(
|
||||||
|
public statePartRef: StatePart<any, any>,
|
||||||
public trigger(payload: TActionPayloadType) {
|
public actionDef: IActionDef<TStateType, TActionPayloadType>
|
||||||
this.statePartRef.dispatchAction(this, payload);
|
) {}
|
||||||
}
|
|
||||||
}
|
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,94 +1,119 @@
|
|||||||
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, 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();
|
||||||
public name: TStatePartName;
|
|
||||||
public state = new Subject<TStatePayload>();
|
constructor(nameArg: TStatePartName) {
|
||||||
public stateStore: TStatePayload;
|
this.name = nameArg;
|
||||||
|
}
|
||||||
constructor(nameArg: TStatePartName) {
|
|
||||||
this.name = nameArg;
|
/**
|
||||||
}
|
* gets the state from the state store
|
||||||
|
*/
|
||||||
/**
|
public getState(): TStatePayload {
|
||||||
* gets the state from the state store
|
return this.stateStore;
|
||||||
*/
|
}
|
||||||
public getState(): TStatePayload {
|
|
||||||
return this.stateStore;
|
/**
|
||||||
}
|
* sets the stateStore to the new state
|
||||||
|
* @param newStateArg
|
||||||
/**
|
*/
|
||||||
* sets the stateStore to the new state
|
public setState(newStateArg: TStatePayload) {
|
||||||
* @param newStateArg
|
this.stateStore = newStateArg;
|
||||||
*/
|
this.notifyChange();
|
||||||
public setState(newStateArg: TStatePayload) {
|
}
|
||||||
this.stateStore = newStateArg;
|
|
||||||
this.notifyChange();
|
/**
|
||||||
}
|
* notifies of a change on the state
|
||||||
|
*/
|
||||||
/**
|
public notifyChange() {
|
||||||
* notifies of a change on the state
|
const createStateHash = (stateArg: any) => {
|
||||||
*/
|
return plugins.isohash.sha256FromString(plugins.smartjson.stringify(stateArg));
|
||||||
public notifyChange() {
|
};
|
||||||
this.state.next(this.stateStore);
|
if (
|
||||||
}
|
this.stateStore &&
|
||||||
|
this.lastStateNotificationPayloadHash &&
|
||||||
/**
|
createStateHash(this.stateStore) === createStateHash(this.lastStateNotificationPayloadHash)
|
||||||
* selects a state or a substate
|
) {
|
||||||
*/
|
return;
|
||||||
public select<T = TStatePayload>(selectorFn?: (state: TStatePayload) => T): Observable<T> {
|
} else {
|
||||||
if (!selectorFn) {
|
this.lastStateNotificationPayloadHash = this.stateStore;
|
||||||
selectorFn = (state: TStatePayload) => <T>(<any>state);
|
}
|
||||||
}
|
this.state.next(this.stateStore);
|
||||||
|
}
|
||||||
const mapped = this.state.pipe(
|
private lastStateNotificationPayloadHash: any;
|
||||||
startWith(this.getState()),
|
|
||||||
map((stateArg) => {
|
/**
|
||||||
try {
|
* selects a state or a substate
|
||||||
return selectorFn(stateArg);
|
*/
|
||||||
} catch (e) {
|
public select<T = TStatePayload>(
|
||||||
// Nothing here
|
selectorFn?: (state: TStatePayload) => T
|
||||||
}
|
): 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()),
|
||||||
/**
|
plugins.smartrx.rxjs.ops.map((stateArg) => {
|
||||||
* creates an action capable of modifying the state
|
try {
|
||||||
*/
|
return selectorFn(stateArg);
|
||||||
public createAction<TActionPayload>(
|
} catch (e) {
|
||||||
actionDef: IActionDef<TStatePayload, TActionPayload>
|
// Nothing here
|
||||||
): StateAction<TStatePayload, TActionPayload> {
|
}
|
||||||
return new StateAction(this, actionDef);
|
})
|
||||||
}
|
);
|
||||||
|
|
||||||
/**
|
return mapped;
|
||||||
* dispatches an action on the statepart level
|
}
|
||||||
*/
|
|
||||||
public async dispatchAction<T>(stateAction: StateAction<TStatePayload, T>, actionPayload: T) {
|
/**
|
||||||
const newState = await stateAction.actionDef(this, actionPayload);
|
* creates an action capable of modifying the state
|
||||||
this.setState(newState);
|
*/
|
||||||
}
|
public createAction<TActionPayload>(
|
||||||
|
actionDef: IActionDef<TStatePayload, TActionPayload>
|
||||||
/**
|
): StateAction<TStatePayload, TActionPayload> {
|
||||||
* waits until a certain part of the state becomes available
|
return new StateAction(this, actionDef);
|
||||||
* @param selectorFn
|
}
|
||||||
*/
|
|
||||||
public async waitUntilPresent<T = TStatePayload>(selectorFn?: (state: TStatePayload) => T): Promise<T> {
|
/**
|
||||||
const done = plugins.smartpromise.defer<T>();
|
* dispatches an action on the statepart level
|
||||||
const selectedObservable = this.select(selectorFn);
|
*/
|
||||||
const subscription = selectedObservable.subscribe(value => {
|
public async dispatchAction<T>(stateAction: StateAction<TStatePayload, T>, actionPayload: T) {
|
||||||
if (value) {
|
await this.cumulativeDeferred.promise;
|
||||||
subscription.unsubscribe();
|
const newState = await stateAction.actionDef(this, actionPayload);
|
||||||
done.resolve(value);
|
this.setState(newState);
|
||||||
}
|
}
|
||||||
});
|
|
||||||
return await done.promise;
|
/**
|
||||||
}
|
* 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 stateSetup(
|
||||||
|
funcArg: (statePartArg?: StatePart<any, TStatePayload>) => Promise<TStatePayload | void>
|
||||||
|
) {
|
||||||
|
this.cumulativeDeferred.addPromise(funcArg(this));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@ -1,13 +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 };
|
|
||||||
|
|
||||||
import * as smartpromise from '@pushrocks/smartpromise';
|
|
||||||
|
|
||||||
export {
|
|
||||||
smartpromise
|
|
||||||
};
|
|
||||||
|
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