ngssm-store 19.3.9 → 19.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1,8 +1,24 @@
|
|
|
1
1
|
import { Action } from 'ngssm-store';
|
|
2
|
-
import {
|
|
2
|
+
import { CachedItemStatus } from '../model';
|
|
3
|
+
/**
|
|
4
|
+
* Represents an action to set a cached item in the state. If key is already set in the state, the value is replaced by the new one.
|
|
5
|
+
*
|
|
6
|
+
* @template TData The type of the cached item's data.
|
|
7
|
+
* @implements {Action}
|
|
8
|
+
*
|
|
9
|
+
* @property {string} cachedItemKey - The unique key identifying the cached item.
|
|
10
|
+
* @property {TData} cachedItem - The data to be cached.
|
|
11
|
+
* @property {CachedItemStatus} [status=CachedItemStatus.set] - The status of the cached item operation.
|
|
12
|
+
* @property {string} [error] - An optional error message if the caching operation failed.
|
|
13
|
+
*
|
|
14
|
+
* @remarks
|
|
15
|
+
* This action is dispatched to update the cache with a new or modified item, along with its status and any error information.
|
|
16
|
+
*/
|
|
3
17
|
export declare class SetCachedItemAction<TData = never> implements Action {
|
|
4
18
|
readonly cachedItemKey: string;
|
|
5
|
-
readonly cachedItem:
|
|
19
|
+
readonly cachedItem: TData;
|
|
20
|
+
readonly status: CachedItemStatus;
|
|
21
|
+
readonly error?: string | undefined;
|
|
6
22
|
readonly type: string;
|
|
7
|
-
constructor(cachedItemKey: string, cachedItem:
|
|
23
|
+
constructor(cachedItemKey: string, cachedItem: TData, status?: CachedItemStatus, error?: string | undefined);
|
|
8
24
|
}
|
|
@@ -10,10 +10,34 @@ var NgssmCachingActionType;
|
|
|
10
10
|
NgssmCachingActionType["unsetCachedItem"] = "[NgssmCachingActionType] unsetCachedItem";
|
|
11
11
|
})(NgssmCachingActionType || (NgssmCachingActionType = {}));
|
|
12
12
|
|
|
13
|
+
var CachedItemStatus;
|
|
14
|
+
(function (CachedItemStatus) {
|
|
15
|
+
CachedItemStatus["notSet"] = "Not Set";
|
|
16
|
+
CachedItemStatus["loading"] = "Loading";
|
|
17
|
+
CachedItemStatus["set"] = "Set";
|
|
18
|
+
CachedItemStatus["error"] = "Error";
|
|
19
|
+
})(CachedItemStatus || (CachedItemStatus = {}));
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Represents an action to set a cached item in the state. If key is already set in the state, the value is replaced by the new one.
|
|
23
|
+
*
|
|
24
|
+
* @template TData The type of the cached item's data.
|
|
25
|
+
* @implements {Action}
|
|
26
|
+
*
|
|
27
|
+
* @property {string} cachedItemKey - The unique key identifying the cached item.
|
|
28
|
+
* @property {TData} cachedItem - The data to be cached.
|
|
29
|
+
* @property {CachedItemStatus} [status=CachedItemStatus.set] - The status of the cached item operation.
|
|
30
|
+
* @property {string} [error] - An optional error message if the caching operation failed.
|
|
31
|
+
*
|
|
32
|
+
* @remarks
|
|
33
|
+
* This action is dispatched to update the cache with a new or modified item, along with its status and any error information.
|
|
34
|
+
*/
|
|
13
35
|
class SetCachedItemAction {
|
|
14
|
-
constructor(cachedItemKey, cachedItem) {
|
|
36
|
+
constructor(cachedItemKey, cachedItem, status = CachedItemStatus.set, error) {
|
|
15
37
|
this.cachedItemKey = cachedItemKey;
|
|
16
38
|
this.cachedItem = cachedItem;
|
|
39
|
+
this.status = status;
|
|
40
|
+
this.error = error;
|
|
17
41
|
this.type = NgssmCachingActionType.setCachedItem;
|
|
18
42
|
}
|
|
19
43
|
}
|
|
@@ -44,14 +68,6 @@ NgssmCachingStateSpecification = __decorate([
|
|
|
44
68
|
|
|
45
69
|
const selectNgssmCachedItem = (state, key) => selectNgssmCachingState(state).caches[key];
|
|
46
70
|
|
|
47
|
-
var CachedItemStatus;
|
|
48
|
-
(function (CachedItemStatus) {
|
|
49
|
-
CachedItemStatus["notSet"] = "Not Set";
|
|
50
|
-
CachedItemStatus["loading"] = "Loading";
|
|
51
|
-
CachedItemStatus["set"] = "Set";
|
|
52
|
-
CachedItemStatus["error"] = "Error";
|
|
53
|
-
})(CachedItemStatus || (CachedItemStatus = {}));
|
|
54
|
-
|
|
55
71
|
class CachedItemReducer {
|
|
56
72
|
constructor() {
|
|
57
73
|
this.processedActions = [NgssmCachingActionType.setCachedItem, NgssmCachingActionType.unsetCachedItem];
|
|
@@ -60,20 +76,15 @@ class CachedItemReducer {
|
|
|
60
76
|
switch (action.type) {
|
|
61
77
|
case NgssmCachingActionType.setCachedItem: {
|
|
62
78
|
const setCachedItemAction = action;
|
|
63
|
-
if (selectNgssmCachedItem(state, setCachedItemAction.cachedItemKey) === undefined) {
|
|
64
|
-
const cachedItem = {
|
|
65
|
-
status: CachedItemStatus.notSet,
|
|
66
|
-
...setCachedItemAction.cachedItem
|
|
67
|
-
};
|
|
68
|
-
return updateNgssmCachingState(state, {
|
|
69
|
-
caches: {
|
|
70
|
-
[setCachedItemAction.cachedItemKey]: { $set: cachedItem }
|
|
71
|
-
}
|
|
72
|
-
});
|
|
73
|
-
}
|
|
74
79
|
return updateNgssmCachingState(state, {
|
|
75
80
|
caches: {
|
|
76
|
-
[setCachedItemAction.cachedItemKey]: {
|
|
81
|
+
[setCachedItemAction.cachedItemKey]: {
|
|
82
|
+
$set: {
|
|
83
|
+
status: setCachedItemAction.status,
|
|
84
|
+
error: setCachedItemAction.error,
|
|
85
|
+
item: setCachedItemAction.cachedItem
|
|
86
|
+
}
|
|
87
|
+
}
|
|
77
88
|
}
|
|
78
89
|
});
|
|
79
90
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ngssm-store-caching.mjs","sources":["../../../projects/ngssm-store/caching/src/actions/ngssm-caching-action-type.ts","../../../projects/ngssm-store/caching/src/
|
|
1
|
+
{"version":3,"file":"ngssm-store-caching.mjs","sources":["../../../projects/ngssm-store/caching/src/actions/ngssm-caching-action-type.ts","../../../projects/ngssm-store/caching/src/model/cached-item-status.ts","../../../projects/ngssm-store/caching/src/actions/set-cached-item.action.ts","../../../projects/ngssm-store/caching/src/actions/unset-cached-item.action.ts","../../../projects/ngssm-store/caching/src/state/ngssm-caching.state.ts","../../../projects/ngssm-store/caching/src/state/selectors.ts","../../../projects/ngssm-store/caching/src/reducers/cached-item.reducer.ts","../../../projects/ngssm-store/caching/src/provide-ngssm-caching.ts","../../../projects/ngssm-store/caching/ngssm-store-caching.ts"],"sourcesContent":["export enum NgssmCachingActionType {\n setCachedItem = '[NgssmCachingActionType] setCachedItem',\n unsetCachedItem = '[NgssmCachingActionType] unsetCachedItem'\n}\n","export enum CachedItemStatus {\n notSet = 'Not Set',\n loading = 'Loading',\n set = 'Set',\n error = 'Error'\n}\n","import { Action } from 'ngssm-store';\n\nimport { NgssmCachingActionType } from './ngssm-caching-action-type';\nimport { CachedItemStatus } from '../model';\n\n/**\n * Represents an action to set a cached item in the state. If key is already set in the state, the value is replaced by the new one.\n *\n * @template TData The type of the cached item's data.\n * @implements {Action}\n *\n * @property {string} cachedItemKey - The unique key identifying the cached item.\n * @property {TData} cachedItem - The data to be cached.\n * @property {CachedItemStatus} [status=CachedItemStatus.set] - The status of the cached item operation.\n * @property {string} [error] - An optional error message if the caching operation failed.\n *\n * @remarks\n * This action is dispatched to update the cache with a new or modified item, along with its status and any error information.\n */\nexport class SetCachedItemAction<TData = never> implements Action {\n public readonly type: string = NgssmCachingActionType.setCachedItem;\n\n constructor(\n public readonly cachedItemKey: string,\n public readonly cachedItem: TData,\n public readonly status = CachedItemStatus.set,\n public readonly error?: string\n ) {}\n}\n","import { Action } from 'ngssm-store';\nimport { NgssmCachingActionType } from './ngssm-caching-action-type';\n\nexport class UnsetCachedItemAction implements Action {\n public readonly type: string = NgssmCachingActionType.unsetCachedItem;\n\n constructor(public readonly cachedItemKey: string) {}\n}\n","import update, { CustomCommands, Spec } from 'immutability-helper';\n\nimport { NgSsmFeatureState, State } from 'ngssm-store';\nimport { CachedItem } from '../model';\n\nexport const selectNgssmCachingState = (state: State): NgssmCachingState =>\n state[NgssmCachingStateSpecification.featureStateKey] as NgssmCachingState;\n\nexport const updateNgssmCachingState = <T extends CustomCommands<object> = never>(state: State, command: Spec<NgssmCachingState, T>): State =>\n update(state, {\n [NgssmCachingStateSpecification.featureStateKey]: command\n });\n\nexport interface NgssmCachingState {\n caches: Record<string, CachedItem>;\n}\n\n@NgSsmFeatureState({\n featureStateKey: NgssmCachingStateSpecification.featureStateKey,\n initialState: NgssmCachingStateSpecification.initialState\n})\nexport class NgssmCachingStateSpecification {\n public static readonly featureStateKey = 'ngssm-caching-state';\n public static readonly initialState: NgssmCachingState = {\n caches: {}\n };\n}\n","import { State } from 'ngssm-store';\nimport { CachedItem } from '../model';\nimport { selectNgssmCachingState } from './ngssm-caching.state';\n\nexport const selectNgssmCachedItem = <T = unknown>(state: State, key: string): CachedItem<T> | undefined =>\n selectNgssmCachingState(state).caches[key] as CachedItem<T>;\n","import { Injectable } from '@angular/core';\n\nimport { Reducer, State, Action } from 'ngssm-store';\n\nimport { NgssmCachingActionType, SetCachedItemAction, UnsetCachedItemAction } from '../actions';\nimport { selectNgssmCachedItem, updateNgssmCachingState } from '../state';\n\n@Injectable()\nexport class CachedItemReducer implements Reducer {\n public readonly processedActions: string[] = [NgssmCachingActionType.setCachedItem, NgssmCachingActionType.unsetCachedItem];\n\n public updateState(state: State, action: Action): State {\n switch (action.type) {\n case NgssmCachingActionType.setCachedItem: {\n const setCachedItemAction = action as SetCachedItemAction;\n\n return updateNgssmCachingState(state, {\n caches: {\n [setCachedItemAction.cachedItemKey]: {\n $set: {\n status: setCachedItemAction.status,\n error: setCachedItemAction.error,\n item: setCachedItemAction.cachedItem\n }\n }\n }\n });\n }\n\n case NgssmCachingActionType.unsetCachedItem: {\n const unsetCachedItemAction = action as UnsetCachedItemAction;\n if (selectNgssmCachedItem(state, unsetCachedItemAction.cachedItemKey) === undefined) {\n return state;\n }\n\n return updateNgssmCachingState(state, {\n caches: { $unset: [unsetCachedItemAction.cachedItemKey] }\n });\n }\n }\n\n return state;\n }\n}\n","import { EnvironmentProviders, makeEnvironmentProviders } from '@angular/core';\nimport { provideReducers } from 'ngssm-store';\nimport { CachedItemReducer } from './reducers';\n\nexport const provideNgssmCaching = (): EnvironmentProviders => {\n return makeEnvironmentProviders([provideReducers(CachedItemReducer)]);\n};\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public_api';\n"],"names":[],"mappings":";;;;;;IAAY;AAAZ,CAAA,UAAY,sBAAsB,EAAA;AAChC,IAAA,sBAAA,CAAA,eAAA,CAAA,GAAA,wCAAwD;AACxD,IAAA,sBAAA,CAAA,iBAAA,CAAA,GAAA,0CAA4D;AAC9D,CAAC,EAHW,sBAAsB,KAAtB,sBAAsB,GAGjC,EAAA,CAAA,CAAA;;ICHW;AAAZ,CAAA,UAAY,gBAAgB,EAAA;AAC1B,IAAA,gBAAA,CAAA,QAAA,CAAA,GAAA,SAAkB;AAClB,IAAA,gBAAA,CAAA,SAAA,CAAA,GAAA,SAAmB;AACnB,IAAA,gBAAA,CAAA,KAAA,CAAA,GAAA,KAAW;AACX,IAAA,gBAAA,CAAA,OAAA,CAAA,GAAA,OAAe;AACjB,CAAC,EALW,gBAAgB,KAAhB,gBAAgB,GAK3B,EAAA,CAAA,CAAA;;ACAD;;;;;;;;;;;;;AAaG;MACU,mBAAmB,CAAA;IAG9B,WACkB,CAAA,aAAqB,EACrB,UAAiB,EACjB,SAAS,gBAAgB,CAAC,GAAG,EAC7B,KAAc,EAAA;QAHd,IAAa,CAAA,aAAA,GAAb,aAAa;QACb,IAAU,CAAA,UAAA,GAAV,UAAU;QACV,IAAM,CAAA,MAAA,GAAN,MAAM;QACN,IAAK,CAAA,KAAA,GAAL,KAAK;AANP,QAAA,IAAA,CAAA,IAAI,GAAW,sBAAsB,CAAC,aAAa;;AAQpE;;MCzBY,qBAAqB,CAAA;AAGhC,IAAA,WAAA,CAA4B,aAAqB,EAAA;QAArB,IAAa,CAAA,aAAA,GAAb,aAAa;AAFzB,QAAA,IAAA,CAAA,IAAI,GAAW,sBAAsB,CAAC,eAAe;;AAGtE;;ACFM,MAAM,uBAAuB,GAAG,CAAC,KAAY,KAClD,KAAK,CAAC,8BAA8B,CAAC,eAAe;AAE/C,MAAM,uBAAuB,GAAG,CAA2C,KAAY,EAAE,OAAmC,KACjI,MAAM,CAAC,KAAK,EAAE;AACZ,IAAA,CAAC,8BAA8B,CAAC,eAAe,GAAG;AACnD,CAAA;AAUU,IAAA,8BAA8B,GAApC,MAAM,8BAA8B,CAAA;aAClB,IAAe,CAAA,eAAA,GAAG,qBAAH,CAAyB;AACxC,IAAA,SAAA,IAAA,CAAA,YAAY,GAAsB;AACvD,QAAA,MAAM,EAAE;AACT,KAFkC,CAEjC;;AAJS,8BAA8B,GAAA,UAAA,CAAA;AAJ1C,IAAA,iBAAiB,CAAC;QACjB,eAAe,EAAE,8BAA8B,CAAC,eAAe;QAC/D,YAAY,EAAE,8BAA8B,CAAC;KAC9C;AACY,CAAA,EAAA,8BAA8B,CAK1C;;MCtBY,qBAAqB,GAAG,CAAc,KAAY,EAAE,GAAW,KAC1E,uBAAuB,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG;;MCG9B,iBAAiB,CAAA;AAD9B,IAAA,WAAA,GAAA;QAEkB,IAAgB,CAAA,gBAAA,GAAa,CAAC,sBAAsB,CAAC,aAAa,EAAE,sBAAsB,CAAC,eAAe,CAAC;AAkC5H;IAhCQ,WAAW,CAAC,KAAY,EAAE,MAAc,EAAA;AAC7C,QAAA,QAAQ,MAAM,CAAC,IAAI;AACjB,YAAA,KAAK,sBAAsB,CAAC,aAAa,EAAE;gBACzC,MAAM,mBAAmB,GAAG,MAA6B;gBAEzD,OAAO,uBAAuB,CAAC,KAAK,EAAE;AACpC,oBAAA,MAAM,EAAE;AACN,wBAAA,CAAC,mBAAmB,CAAC,aAAa,GAAG;AACnC,4BAAA,IAAI,EAAE;gCACJ,MAAM,EAAE,mBAAmB,CAAC,MAAM;gCAClC,KAAK,EAAE,mBAAmB,CAAC,KAAK;gCAChC,IAAI,EAAE,mBAAmB,CAAC;AAC3B;AACF;AACF;AACF,iBAAA,CAAC;;AAGJ,YAAA,KAAK,sBAAsB,CAAC,eAAe,EAAE;gBAC3C,MAAM,qBAAqB,GAAG,MAA+B;gBAC7D,IAAI,qBAAqB,CAAC,KAAK,EAAE,qBAAqB,CAAC,aAAa,CAAC,KAAK,SAAS,EAAE;AACnF,oBAAA,OAAO,KAAK;;gBAGd,OAAO,uBAAuB,CAAC,KAAK,EAAE;oBACpC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,qBAAqB,CAAC,aAAa,CAAC;AACxD,iBAAA,CAAC;;;AAIN,QAAA,OAAO,KAAK;;+GAjCH,iBAAiB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA,CAAA;mHAAjB,iBAAiB,EAAA,CAAA,CAAA;;4FAAjB,iBAAiB,EAAA,UAAA,EAAA,CAAA;kBAD7B;;;ACHM,MAAM,mBAAmB,GAAG,MAA2B;IAC5D,OAAO,wBAAwB,CAAC,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC,CAAC;AACvE;;ACNA;;AAEG;;;;"}
|