Compare commits
24 Commits
Author | SHA1 | Date | |
---|---|---|---|
a21131eaf6 | |||
c4b214a308 | |||
6db03eee83 | |||
efc5b54d2e | |||
9860e43398 | |||
234117c8dd | |||
371c6553cd | |||
b6b738916f | |||
fad7e0bc6b | |||
fc4fb911ef | |||
7e0dad1c10 | |||
0fb50714b9 | |||
7e1821f37d | |||
592228fc51 | |||
431089e23f | |||
5b64733d91 | |||
2da2a43a09 | |||
f7887a6663 | |||
be505ee915 | |||
9584f403b1 | |||
993a100eae | |||
29f0307ef8 | |||
9413c5bcdc | |||
1d5fb320f4 |
@ -12,30 +12,38 @@ stages:
|
||||
- release
|
||||
- metadata
|
||||
|
||||
before_script:
|
||||
- pnpm install -g pnpm
|
||||
- pnpm install -g @shipzone/npmci
|
||||
- npmci npm prepare
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
audit:
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
auditProductionDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command pnpm audit --audit-level=high --prod
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
allow_failure: true
|
||||
|
||||
auditDevDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command pnpm audit --audit-level=high --dev
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
@ -44,28 +52,22 @@ audit:
|
||||
testStable:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run build
|
||||
- npmci npm build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
release:
|
||||
stage: release
|
||||
@ -85,11 +87,12 @@ release:
|
||||
codequality:
|
||||
stage: metadata
|
||||
allow_failure: true
|
||||
only:
|
||||
- tags
|
||||
script:
|
||||
- npmci command npm install -g tslint typescript
|
||||
- npmci command npm install -g typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
@ -109,11 +112,9 @@ trigger:
|
||||
pages:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci node install lts
|
||||
- npmci command npm install -g @gitzone/tsdoc
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
- npmci command npm run buildDocs
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
|
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@ -2,28 +2,10 @@
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "current file",
|
||||
"type": "node",
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"${relativeFile}"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
},
|
||||
{
|
||||
"name": "test.ts",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"test/test.ts"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
"type": "node-terminal"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
2
.vscode/settings.json
vendored
2
.vscode/settings.json
vendored
@ -15,7 +15,7 @@
|
||||
"properties": {
|
||||
"projectType": {
|
||||
"type": "string",
|
||||
"enum": ["website", "element", "service", "npm"]
|
||||
"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
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
@ -9,7 +9,7 @@
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"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",
|
||||
"license": "MIT"
|
||||
}
|
||||
|
3408
package-lock.json
generated
3408
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
32
package.json
32
package.json
@ -1,31 +1,32 @@
|
||||
{
|
||||
"name": "@pushrocks/smartstate",
|
||||
"version": "1.0.18",
|
||||
"version": "2.0.6",
|
||||
"private": false,
|
||||
"description": "a package that handles state in a good way",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"author": "Lossless GmbH",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"test": "(tstest test/)",
|
||||
"build": "(tsbuild && tsbundle npm)",
|
||||
"format": "(gitzone format)"
|
||||
"build": "(tsbuild --web --allowimplicitany && tsbundle npm)",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.24",
|
||||
"@gitzone/tsbundle": "^1.0.69",
|
||||
"@gitzone/tstest": "^1.0.28",
|
||||
"@pushrocks/tapbundle": "^3.2.1",
|
||||
"@types/node": "^14.0.5",
|
||||
"tslint": "^6.1.2",
|
||||
"tslint-config-prettier": "^1.18.0"
|
||||
"@gitzone/tsbuild": "^2.1.65",
|
||||
"@gitzone/tsbundle": "^2.0.7",
|
||||
"@gitzone/tsrun": "^1.2.39",
|
||||
"@gitzone/tstest": "^1.0.74",
|
||||
"@pushrocks/tapbundle": "^5.0.4",
|
||||
"@types/node": "^18.15.11"
|
||||
},
|
||||
"dependencies": {
|
||||
"@pushrocks/lik": "^4.0.12",
|
||||
"@pushrocks/smartpromise": "^3.0.6",
|
||||
"@pushrocks/smartrx": "^2.0.15",
|
||||
"rxjs": "^6.5.5"
|
||||
"@pushrocks/isohash": "^2.0.0",
|
||||
"@pushrocks/lik": "^6.0.2",
|
||||
"@pushrocks/smartjson": "^5.0.5",
|
||||
"@pushrocks/smartpromise": "^4.0.0",
|
||||
"@pushrocks/smartrx": "^3.0.0"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
@ -38,5 +39,8 @@
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
]
|
||||
}
|
||||
|
4410
pnpm-lock.yaml
generated
Normal file
4410
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
25
readme.md
25
readme.md
@ -8,13 +8,19 @@ a package that handles state in a good way
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartstate/)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/smartstate/commits/master)
|
||||
[](https://gitlab.com/pushrocks/smartstate/commits/master)
|
||||
[](https://www.npmjs.com/package/@pushrocks/smartstate)
|
||||
[](https://snyk.io/test/npm/@pushrocks/smartstate)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://prettier.io/)
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
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
|
||||
|
||||
@ -26,7 +32,6 @@ We are always happy for code contributions. If you are not the code contributing
|
||||
|
||||
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)
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
|
@ -1,58 +1,58 @@
|
||||
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.hi)
|
||||
.subscribe(substate => {
|
||||
expect(substate).to.equal(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).to.include('my favourite things');
|
||||
await done.promise;
|
||||
});
|
||||
|
||||
tap.start();
|
||||
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();
|
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.6',
|
||||
description: 'a package that handles state in a good way'
|
||||
}
|
@ -1,5 +1,3 @@
|
||||
export * from './smartstate.classes.smartstate';
|
||||
export * from './smartstate.classes.statepart';
|
||||
export * from './smartstate.classes.statecollection';
|
||||
export * from './smartstate.classes.stateaction';
|
||||
export * from './smartstate.classes.stateobservable';
|
||||
export * from './smartstate.classes.smartstate.js';
|
||||
export * from './smartstate.classes.statepart.js';
|
||||
export * from './smartstate.classes.stateaction.js';
|
||||
|
@ -1,47 +1,57 @@
|
||||
import * as plugins from './smartstate.plugins';
|
||||
import { StatePart } from './smartstate.classes.statepart';
|
||||
|
||||
/**
|
||||
* Smartstate takes care of providing state
|
||||
*/
|
||||
export class Smartstate<StatePartNameType> {
|
||||
public statePartMap: { [key: string]: StatePart<StatePartNameType, unknown> } = {};
|
||||
|
||||
constructor() {}
|
||||
|
||||
public getStatePart<PayloadType>(
|
||||
statePartNameArg: string & StatePartNameType,
|
||||
initialArg?: PayloadType
|
||||
): StatePart<StatePartNameType, PayloadType> {
|
||||
if (this.statePartMap[statePartNameArg as any]) {
|
||||
if (initialArg && Object.keys(initialArg).length > 0) {
|
||||
throw new Error(
|
||||
`${statePartNameArg} already exists, yet you try to set an initial state again`
|
||||
);
|
||||
}
|
||||
return this.statePartMap[statePartNameArg] as StatePart<StatePartNameType, PayloadType>;
|
||||
} else {
|
||||
if (!initialArg) {
|
||||
throw new Error(
|
||||
`${statePartNameArg} does not yet exist, yet you don't provide an initial state`
|
||||
);
|
||||
}
|
||||
return this.createStatePart<PayloadType>(statePartNameArg, initialArg);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* creates a statepart
|
||||
* @param statePartName
|
||||
* @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;
|
||||
}
|
||||
}
|
||||
import * as plugins from './smartstate.plugins.js';
|
||||
import { StatePart } from './smartstate.classes.statepart.js';
|
||||
|
||||
/**
|
||||
* Smartstate takes care of providing state
|
||||
*/
|
||||
export class Smartstate<StatePartNameType> {
|
||||
public statePartMap: { [key: string]: StatePart<StatePartNameType, any> } = {};
|
||||
|
||||
constructor() {}
|
||||
|
||||
/**
|
||||
* Allows getting and initializing a new statepart
|
||||
* initMode === 'soft' it will allow existing stateparts
|
||||
* initMode === 'mandatory' will fail if there is an exiting statepart
|
||||
* initMode === 'force' will overwrite any existing statepart
|
||||
* @param statePartNameArg
|
||||
* @param initialArg
|
||||
* @param initMode
|
||||
*/
|
||||
public getStatePart<PayloadType>(
|
||||
statePartNameArg: string & StatePartNameType,
|
||||
initialArg?: PayloadType,
|
||||
initMode?: 'soft' | 'mandatory' | 'force'
|
||||
): StatePart<StatePartNameType, PayloadType> {
|
||||
if (this.statePartMap[statePartNameArg as any]) {
|
||||
if (initialArg && (!initMode || initMode !== 'soft')) {
|
||||
throw new Error(
|
||||
`${statePartNameArg} already exists, yet you try to set an initial state again`
|
||||
);
|
||||
}
|
||||
return this.statePartMap[statePartNameArg] as StatePart<StatePartNameType, PayloadType>;
|
||||
} else {
|
||||
if (!initialArg) {
|
||||
throw new Error(
|
||||
`${statePartNameArg} does not yet exist, yet you don't provide an initial state`
|
||||
);
|
||||
}
|
||||
return this.createStatePart<PayloadType>(statePartNameArg, initialArg);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* creates a statepart
|
||||
* @param statePartName
|
||||
* @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,20 +1,20 @@
|
||||
import * as plugins from './smartstate.plugins';
|
||||
import { StatePart } from './smartstate.classes.statepart';
|
||||
|
||||
export interface IActionDef<TStateType, TActionPayloadType> {
|
||||
(stateArg: StatePart<any, TStateType>, actionPayload: TActionPayloadType): Promise<TStateType>;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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);
|
||||
}
|
||||
}
|
||||
import * as plugins from './smartstate.plugins.js';
|
||||
import { StatePart } from './smartstate.classes.statepart.js';
|
||||
|
||||
export interface IActionDef<TStateType, TActionPayloadType> {
|
||||
(stateArg: StatePart<any, TStateType>, actionPayload: TActionPayloadType): Promise<TStateType>;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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,95 +1,127 @@
|
||||
import * as plugins from './smartstate.plugins';
|
||||
import { StateAction, IActionDef } from './smartstate.classes.stateaction';
|
||||
|
||||
export class StatePart<TStatePartName, TStatePayload> {
|
||||
public name: TStatePartName;
|
||||
public state = new plugins.smartrx.rxjs.Subject<TStatePayload>();
|
||||
public stateStore: TStatePayload;
|
||||
|
||||
constructor(nameArg: TStatePartName) {
|
||||
this.name = nameArg;
|
||||
}
|
||||
|
||||
/**
|
||||
* gets the state from the state store
|
||||
*/
|
||||
public getState(): TStatePayload {
|
||||
return this.stateStore;
|
||||
}
|
||||
|
||||
/**
|
||||
* sets the stateStore to the new state
|
||||
* @param newStateArg
|
||||
*/
|
||||
public setState(newStateArg: TStatePayload) {
|
||||
this.stateStore = newStateArg;
|
||||
this.notifyChange();
|
||||
}
|
||||
|
||||
/**
|
||||
* notifies of a change on the state
|
||||
*/
|
||||
public notifyChange() {
|
||||
this.state.next(this.stateStore);
|
||||
}
|
||||
|
||||
/**
|
||||
* 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) {
|
||||
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;
|
||||
}
|
||||
}
|
||||
import * as plugins from './smartstate.plugins.js';
|
||||
import { StateAction, IActionDef } from './smartstate.classes.stateaction.js';
|
||||
|
||||
export class StatePart<TStatePartName, TStatePayload> {
|
||||
public name: TStatePartName;
|
||||
public state = new plugins.smartrx.rxjs.Subject<TStatePayload>();
|
||||
public stateStore: TStatePayload;
|
||||
private cumulativeDeferred = plugins.smartpromise.cumulativeDefer();
|
||||
|
||||
constructor(nameArg: TStatePartName) {
|
||||
this.name = nameArg;
|
||||
}
|
||||
|
||||
/**
|
||||
* gets the state from the state store
|
||||
*/
|
||||
public getState(): TStatePayload {
|
||||
return this.stateStore;
|
||||
}
|
||||
|
||||
/**
|
||||
* sets the stateStore to the new state
|
||||
* @param newStateArg
|
||||
*/
|
||||
public setState(newStateArg: TStatePayload) {
|
||||
this.stateStore = newStateArg;
|
||||
this.notifyChange();
|
||||
}
|
||||
|
||||
/**
|
||||
* notifies of a change on the state
|
||||
*/
|
||||
public notifyChange() {
|
||||
const createStateHash = (stateArg: any) => {
|
||||
return plugins.isohash.sha256FromString(plugins.smartjson.stringify(stateArg));
|
||||
};
|
||||
if (
|
||||
this.stateStore &&
|
||||
this.lastStateNotificationPayloadHash &&
|
||||
createStateHash(this.stateStore) === this.lastStateNotificationPayloadHash
|
||||
) {
|
||||
return;
|
||||
} 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) {
|
||||
await this.cumulativeDeferred.promise;
|
||||
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;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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,4 +1,6 @@
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as smartrx from '@pushrocks/smartrx';
|
||||
|
||||
export { smartpromise, smartrx };
|
||||
import * as isohash from '@pushrocks/isohash';
|
||||
import * as smartjson from '@pushrocks/smartjson';
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as smartrx from '@pushrocks/smartrx';
|
||||
|
||||
export { isohash, smartjson, smartpromise, smartrx };
|
||||
|
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