ngxs-synchronizers 4.0.0 → 4.0.1
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.
- package/fesm2022/ngxs-synchronizers.mjs +7 -7
- package/index.d.ts +169 -9
- package/package.json +1 -1
- package/decorators/sync-class.d.ts +0 -28
- package/decorators/sync-state.d.ts +0 -19
- package/module.d.ts +0 -6
- package/state-selector.d.ts +0 -39
- package/sync-store.d.ts +0 -25
- package/synchronizer/collection-synchronizer.d.ts +0 -10
- package/synchronizer/property-synchronizer.d.ts +0 -10
- package/synchronizer/state-synchronizer.d.ts +0 -13
- package/synchronizer/synchronizer-dictionary.d.ts +0 -13
- package/synchronizer/synchronizer.d.ts +0 -20
|
@@ -400,21 +400,21 @@ class SyncStore {
|
|
|
400
400
|
reset(state) {
|
|
401
401
|
return this.store.reset(state);
|
|
402
402
|
}
|
|
403
|
-
static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "
|
|
404
|
-
static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "
|
|
403
|
+
static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.0.6", ngImport: i0, type: SyncStore, deps: [{ token: i0.Injector }, { token: i1.Store }], target: i0.ɵɵFactoryTarget.Injectable });
|
|
404
|
+
static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.0.6", ngImport: i0, type: SyncStore });
|
|
405
405
|
}
|
|
406
|
-
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "
|
|
406
|
+
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.0.6", ngImport: i0, type: SyncStore, decorators: [{
|
|
407
407
|
type: Injectable
|
|
408
408
|
}], ctorParameters: () => [{ type: i0.Injector }, { type: i1.Store }] });
|
|
409
409
|
|
|
410
410
|
class NgxsSyncModule {
|
|
411
|
-
static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "
|
|
412
|
-
static ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "
|
|
413
|
-
static ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "
|
|
411
|
+
static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.0.6", ngImport: i0, type: NgxsSyncModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
|
|
412
|
+
static ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "20.0.6", ngImport: i0, type: NgxsSyncModule });
|
|
413
|
+
static ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "20.0.6", ngImport: i0, type: NgxsSyncModule, providers: [
|
|
414
414
|
SyncStore
|
|
415
415
|
] });
|
|
416
416
|
}
|
|
417
|
-
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "
|
|
417
|
+
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.0.6", ngImport: i0, type: NgxsSyncModule, decorators: [{
|
|
418
418
|
type: NgModule,
|
|
419
419
|
args: [{
|
|
420
420
|
providers: [
|
package/index.d.ts
CHANGED
|
@@ -1,9 +1,169 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
1
|
+
import * as i0 from '@angular/core';
|
|
2
|
+
import { Type, Injector, Signal } from '@angular/core';
|
|
3
|
+
import { Observable, Subscription } from 'rxjs';
|
|
4
|
+
import { Store, TypedSelector } from '@ngxs/store';
|
|
5
|
+
|
|
6
|
+
declare class NgxsSyncModule {
|
|
7
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<NgxsSyncModule, never>;
|
|
8
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<NgxsSyncModule, never, never, never>;
|
|
9
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<NgxsSyncModule>;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
interface Synchronizer<T, PropKey extends keyof T, ReadParamsT, WriteParamsT> {
|
|
13
|
+
requiredProperties?: Array<keyof T>;
|
|
14
|
+
proxy?: boolean;
|
|
15
|
+
read(requiredDetails: Partial<T>, options: Synchronizer.BaseOptions<T, PropKey, ReadParamsT> & Synchronizer.ReadOptions<ReadParamsT>): Observable<T[PropKey]>;
|
|
16
|
+
write?(value: T[PropKey], options: Synchronizer.BaseOptions<T, PropKey, WriteParamsT> & Synchronizer.WriteOptions<WriteParamsT>): Observable<any>;
|
|
17
|
+
}
|
|
18
|
+
declare namespace Synchronizer {
|
|
19
|
+
interface BaseOptions<T, PropKey extends keyof T, ParamsT> {
|
|
20
|
+
propertyName: PropKey;
|
|
21
|
+
requestParams?: ParamsT;
|
|
22
|
+
}
|
|
23
|
+
interface ReadOptions<ParamsT> {
|
|
24
|
+
clearStore?: boolean;
|
|
25
|
+
requestParams?: ParamsT;
|
|
26
|
+
}
|
|
27
|
+
interface WriteOptions<ParamsT> {
|
|
28
|
+
requestParams?: ParamsT;
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
interface CollectionSynchronizer<T, ReadParamsT = never, WriteParamsT = never> extends Synchronizer<T, keyof T, ReadParamsT, WriteParamsT> {
|
|
33
|
+
read(requiredDetails: Partial<T>, options: CollectionSynchronizer.ReadOptions<T, ReadParamsT>): Observable<T[keyof T]>;
|
|
34
|
+
write?(value: T[keyof T], options: CollectionSynchronizer.WriteOptions<T, WriteParamsT>): Observable<any>;
|
|
35
|
+
}
|
|
36
|
+
declare namespace CollectionSynchronizer {
|
|
37
|
+
type ReadOptions<T, ParamsT = never> = Synchronizer.BaseOptions<T, keyof T, ParamsT> & Synchronizer.ReadOptions<ParamsT>;
|
|
38
|
+
type WriteOptions<T, ParamsT = never> = Synchronizer.BaseOptions<T, keyof T, ParamsT> & Synchronizer.WriteOptions<ParamsT>;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
interface PropertySynchronizer<T, PropKey extends keyof T, ReadParamsT = never, WriteParamsT = never> extends Synchronizer<T, PropKey, ReadParamsT, WriteParamsT> {
|
|
42
|
+
read(requiredDetails: Partial<T>, options: PropertySynchronizer.ReadOptions<T, PropKey, ReadParamsT>): Observable<T[PropKey]>;
|
|
43
|
+
write?(value: T[PropKey], options: PropertySynchronizer.WriteOptions<T, PropKey, WriteParamsT>): Observable<any>;
|
|
44
|
+
}
|
|
45
|
+
declare namespace PropertySynchronizer {
|
|
46
|
+
type ReadOptions<T, PropKey extends keyof T = keyof T, ParamsT = never> = Synchronizer.BaseOptions<T, PropKey, ParamsT> & Synchronizer.ReadOptions<ParamsT>;
|
|
47
|
+
type WriteOptions<T, PropKey extends keyof T = keyof T, ParamsT = never> = Synchronizer.BaseOptions<T, PropKey, ParamsT> & Synchronizer.WriteOptions<ParamsT>;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
type SynchronizerDictionary<T> = {
|
|
51
|
+
[P in keyof T]?: Type<PropertySynchronizer<T, P>>;
|
|
52
|
+
} | Type<CollectionSynchronizer<T>>;
|
|
53
|
+
declare namespace SynchronizerDictionary {
|
|
54
|
+
function keys<T>(dict: SynchronizerDictionary<T>): Array<keyof T>;
|
|
55
|
+
function isCollectionSynchronizer<T>(dict: SynchronizerDictionary<T>): dict is Type<CollectionSynchronizer<T>>;
|
|
56
|
+
function resolveSynchronizer<T>(dict: SynchronizerDictionary<T>, propKey: keyof T): Type<Synchronizer<T, keyof T, unknown, unknown>> | undefined;
|
|
57
|
+
function resolveSynchronizerInstance<T>(injector: Injector, dict: SynchronizerDictionary<T>, propKey: keyof T): Synchronizer<T, keyof T, unknown, unknown>;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
declare const NGXS_SYNCHRONIZERS_METADATA_KEY: unique symbol;
|
|
61
|
+
declare const PARENT_REF_KEY: unique symbol;
|
|
62
|
+
declare const SYNC_STORE_OPTIONS_KEY: unique symbol;
|
|
63
|
+
interface StoreOptions<T> {
|
|
64
|
+
name: string;
|
|
65
|
+
defaults?: T;
|
|
66
|
+
children?: any[];
|
|
67
|
+
}
|
|
68
|
+
interface Metadata<T> {
|
|
69
|
+
[SYNC_STORE_OPTIONS_KEY]: SyncStoreOptions<T>;
|
|
70
|
+
[PARENT_REF_KEY]?: any;
|
|
71
|
+
}
|
|
72
|
+
interface SyncStoreOptions<T> extends StoreOptions<T> {
|
|
73
|
+
synchronizers?: SynchronizerDictionary<T>;
|
|
74
|
+
}
|
|
75
|
+
interface SyncClass<T> extends Type<any> {
|
|
76
|
+
[NGXS_SYNCHRONIZERS_METADATA_KEY]?: Metadata<T>;
|
|
77
|
+
}
|
|
78
|
+
declare namespace SyncClass {
|
|
79
|
+
function getStoreOptions<T>($class: SyncClass<T>): SyncStoreOptions<T>;
|
|
80
|
+
function setStoreOptions<T>($class: SyncClass<T>, options: SyncStoreOptions<T>): void;
|
|
81
|
+
function resolveParent<T>($class: SyncClass<T>): SyncClass<unknown>;
|
|
82
|
+
function resolveParents<T>($class: SyncClass<T>): SyncClass<unknown>[];
|
|
83
|
+
function setParent<T>($childClass: SyncClass<unknown>, $parentClass: SyncClass<T>): void;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
type ActionOrArrayOfActions<T> = T extends (infer U)[] ? NonNullable<U>[] : NonNullable<T>;
|
|
87
|
+
declare class SyncStore {
|
|
88
|
+
readonly injector: Injector;
|
|
89
|
+
private readonly store;
|
|
90
|
+
private readonly _selectorMap;
|
|
91
|
+
constructor(injector: Injector, store: Store);
|
|
92
|
+
state<T>(syncState: SyncClass<T>): StateSelector<T>;
|
|
93
|
+
dispatch<T>(actionOrActions: ActionOrArrayOfActions<T>): Observable<void>;
|
|
94
|
+
select<T>(selector: TypedSelector<T>): Observable<T>;
|
|
95
|
+
selectOnce<T>(selector: TypedSelector<T>): Observable<T>;
|
|
96
|
+
selectSnapshot<T>(selector: TypedSelector<T>): T;
|
|
97
|
+
selectSignal<T>(selector: TypedSelector<T>): Signal<T>;
|
|
98
|
+
subscribe(fn?: (value: any) => void): Subscription;
|
|
99
|
+
snapshot(): any;
|
|
100
|
+
reset(state: any): void;
|
|
101
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SyncStore, never>;
|
|
102
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SyncStore>;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
declare class StateSelector<T> {
|
|
106
|
+
private store;
|
|
107
|
+
private stateClass;
|
|
108
|
+
private state$;
|
|
109
|
+
readonly synchronizers?: SynchronizerDictionary<T>;
|
|
110
|
+
private readonly injector;
|
|
111
|
+
private readonly pendingRequests$;
|
|
112
|
+
constructor(store: SyncStore, stateClass: SyncClass<T>, state$: Observable<T | undefined>);
|
|
113
|
+
dispatch<PropT extends keyof T>(propertyName: PropT, value: T[PropT]): Observable<T>;
|
|
114
|
+
property<PropT extends keyof T>(propertyName: PropT): Observable<T[PropT] | undefined>;
|
|
115
|
+
properties(): Observable<T | undefined>;
|
|
116
|
+
definedProperty<PropT extends keyof T>(propertyName: PropT): Observable<T[PropT]>;
|
|
117
|
+
isSyncingProperty(propertyName: keyof T): Observable<boolean>;
|
|
118
|
+
onPropertySyncing<PropT extends keyof T>(propertyName: PropT): Observable<PropT>;
|
|
119
|
+
onPropertySynced<PropT extends keyof T>(propertyName: PropT): Observable<PropT>;
|
|
120
|
+
onEveryPropertySyncing(...propertyNames: Array<keyof T>): Observable<Array<keyof T>>;
|
|
121
|
+
onEveryPropertySynced(...propertyNames: Array<keyof T>): Observable<Array<keyof T>>;
|
|
122
|
+
onSomePropertySyncing(...propertyNames: Array<keyof T>): Observable<keyof T>;
|
|
123
|
+
onSomePropertySynced(...propertyNames: Array<keyof T>): Observable<keyof T>;
|
|
124
|
+
require<RequestParamsT = never>(propertyNames: keyof T | Array<keyof T>, options?: Synchronizer.ReadOptions<RequestParamsT>): Observable<T>;
|
|
125
|
+
requireProperty<PropT extends keyof T, RequestParamsT = never>(propertyName: PropT, options?: Synchronizer.ReadOptions<RequestParamsT>): Observable<T[PropT]>;
|
|
126
|
+
sync<RequestParamsT = never>(propertyNames: keyof T | Array<keyof T>, options?: Synchronizer.ReadOptions<RequestParamsT>): Observable<T>;
|
|
127
|
+
syncProperty<PropT extends keyof T, RequestParamsT = never>(propertyName: PropT, options?: Synchronizer.ReadOptions<RequestParamsT>): Observable<T[PropT]>;
|
|
128
|
+
export<RequestParamsT = never>(propertyNames: keyof T | Array<keyof T>, options?: Synchronizer.WriteOptions<RequestParamsT>): Observable<any>;
|
|
129
|
+
private requireOne;
|
|
130
|
+
private requireAll;
|
|
131
|
+
private syncOne;
|
|
132
|
+
private syncAll;
|
|
133
|
+
private exportOne;
|
|
134
|
+
private exportAll;
|
|
135
|
+
private getPropertyUpdater;
|
|
136
|
+
private clearPropertyUpdater;
|
|
137
|
+
private resolveSynchronizer;
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
declare abstract class StateSynchronizer<T, PropKey extends keyof T, ReadParamsT = never, WriteParamsT = never> implements PropertySynchronizer<T, PropKey, ReadParamsT, WriteParamsT> {
|
|
141
|
+
private readonly injector;
|
|
142
|
+
private readonly propertyState;
|
|
143
|
+
constructor(injector: Injector, propertyState: SyncClass<T[PropKey]>);
|
|
144
|
+
read(_requiredDetails: Partial<T>, _options: PropertySynchronizer.ReadOptions<T, PropKey, ReadParamsT>): Observable<T[PropKey]>;
|
|
145
|
+
protected readSubset(properties: Array<keyof T[PropKey]>): Observable<T[PropKey]>;
|
|
146
|
+
private readProperties;
|
|
147
|
+
private readProperty;
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
declare function SyncState<T>(options: SyncStoreOptions<T>): ClassDecorator;
|
|
151
|
+
declare namespace SyncState {
|
|
152
|
+
class UpdateAction<StateT, PropertyT extends keyof StateT> {
|
|
153
|
+
readonly property: PropertyT;
|
|
154
|
+
readonly payload: StateT[PropertyT];
|
|
155
|
+
static readonly type: string;
|
|
156
|
+
constructor(property: PropertyT, payload: StateT[PropertyT]);
|
|
157
|
+
}
|
|
158
|
+
namespace UpdateAction {
|
|
159
|
+
interface Type<StateT, PropertyT extends keyof StateT> {
|
|
160
|
+
type: string;
|
|
161
|
+
new (property: PropertyT, payload: StateT[PropertyT]): UpdateAction<StateT, PropertyT>;
|
|
162
|
+
}
|
|
163
|
+
export function bootstrapClass<StateT>($class: SyncClass<StateT>): void;
|
|
164
|
+
export function Type<StateT, PropertyT extends keyof StateT = keyof StateT>($class: SyncClass<StateT>): Type<StateT, PropertyT>;
|
|
165
|
+
export {};
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
export { CollectionSynchronizer, NgxsSyncModule, PropertySynchronizer, StateSelector, StateSynchronizer, SyncState, SyncStore, Synchronizer, SynchronizerDictionary };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ngxs-synchronizers",
|
|
3
|
-
"version": "4.0.
|
|
3
|
+
"version": "4.0.1",
|
|
4
4
|
"description": "Easily keep your app's local state synchronized with your backend, databases and more! ngxs-synchronizers simplifies synchronizing your NGXS-based application state with external data sources.",
|
|
5
5
|
"author": "Mychal Thompson <mychal.r.thompson@gmail.com>",
|
|
6
6
|
"license": "MIT",
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
import { Type as ClassType } from "@angular/core";
|
|
2
|
-
import { SynchronizerDictionary } from "../synchronizer/synchronizer-dictionary";
|
|
3
|
-
declare const NGXS_SYNCHRONIZERS_METADATA_KEY: unique symbol;
|
|
4
|
-
declare const PARENT_REF_KEY: unique symbol;
|
|
5
|
-
declare const SYNC_STORE_OPTIONS_KEY: unique symbol;
|
|
6
|
-
interface StoreOptions<T> {
|
|
7
|
-
name: string;
|
|
8
|
-
defaults?: T;
|
|
9
|
-
children?: any[];
|
|
10
|
-
}
|
|
11
|
-
interface Metadata<T> {
|
|
12
|
-
[SYNC_STORE_OPTIONS_KEY]: SyncStoreOptions<T>;
|
|
13
|
-
[PARENT_REF_KEY]?: any;
|
|
14
|
-
}
|
|
15
|
-
export interface SyncStoreOptions<T> extends StoreOptions<T> {
|
|
16
|
-
synchronizers?: SynchronizerDictionary<T>;
|
|
17
|
-
}
|
|
18
|
-
export interface SyncClass<T> extends ClassType<any> {
|
|
19
|
-
[NGXS_SYNCHRONIZERS_METADATA_KEY]?: Metadata<T>;
|
|
20
|
-
}
|
|
21
|
-
export declare namespace SyncClass {
|
|
22
|
-
function getStoreOptions<T>($class: SyncClass<T>): SyncStoreOptions<T>;
|
|
23
|
-
function setStoreOptions<T>($class: SyncClass<T>, options: SyncStoreOptions<T>): void;
|
|
24
|
-
function resolveParent<T>($class: SyncClass<T>): SyncClass<unknown>;
|
|
25
|
-
function resolveParents<T>($class: SyncClass<T>): SyncClass<unknown>[];
|
|
26
|
-
function setParent<T>($childClass: SyncClass<unknown>, $parentClass: SyncClass<T>): void;
|
|
27
|
-
}
|
|
28
|
-
export {};
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
import { SyncClass, SyncStoreOptions } from "./sync-class";
|
|
2
|
-
export declare function SyncState<T>(options: SyncStoreOptions<T>): ClassDecorator;
|
|
3
|
-
export declare namespace SyncState {
|
|
4
|
-
class UpdateAction<StateT, PropertyT extends keyof StateT> {
|
|
5
|
-
readonly property: PropertyT;
|
|
6
|
-
readonly payload: StateT[PropertyT];
|
|
7
|
-
static readonly type: string;
|
|
8
|
-
constructor(property: PropertyT, payload: StateT[PropertyT]);
|
|
9
|
-
}
|
|
10
|
-
namespace UpdateAction {
|
|
11
|
-
interface Type<StateT, PropertyT extends keyof StateT> {
|
|
12
|
-
type: string;
|
|
13
|
-
new (property: PropertyT, payload: StateT[PropertyT]): UpdateAction<StateT, PropertyT>;
|
|
14
|
-
}
|
|
15
|
-
export function bootstrapClass<StateT>($class: SyncClass<StateT>): void;
|
|
16
|
-
export function Type<StateT, PropertyT extends keyof StateT = keyof StateT>($class: SyncClass<StateT>): Type<StateT, PropertyT>;
|
|
17
|
-
export {};
|
|
18
|
-
}
|
|
19
|
-
}
|
package/module.d.ts
DELETED
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import * as i0 from "@angular/core";
|
|
2
|
-
export declare class NgxsSyncModule {
|
|
3
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<NgxsSyncModule, never>;
|
|
4
|
-
static ɵmod: i0.ɵɵNgModuleDeclaration<NgxsSyncModule, never, never, never>;
|
|
5
|
-
static ɵinj: i0.ɵɵInjectorDeclaration<NgxsSyncModule>;
|
|
6
|
-
}
|
package/state-selector.d.ts
DELETED
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
import { Observable } from "rxjs";
|
|
2
|
-
import { SyncClass } from "./decorators/sync-class";
|
|
3
|
-
import { SyncStore } from "./sync-store";
|
|
4
|
-
import { Synchronizer } from "./synchronizer/synchronizer";
|
|
5
|
-
import { SynchronizerDictionary } from "./synchronizer/synchronizer-dictionary";
|
|
6
|
-
export declare class StateSelector<T> {
|
|
7
|
-
private store;
|
|
8
|
-
private stateClass;
|
|
9
|
-
private state$;
|
|
10
|
-
readonly synchronizers?: SynchronizerDictionary<T>;
|
|
11
|
-
private readonly injector;
|
|
12
|
-
private readonly pendingRequests$;
|
|
13
|
-
constructor(store: SyncStore, stateClass: SyncClass<T>, state$: Observable<T | undefined>);
|
|
14
|
-
dispatch<PropT extends keyof T>(propertyName: PropT, value: T[PropT]): Observable<T>;
|
|
15
|
-
property<PropT extends keyof T>(propertyName: PropT): Observable<T[PropT] | undefined>;
|
|
16
|
-
properties(): Observable<T | undefined>;
|
|
17
|
-
definedProperty<PropT extends keyof T>(propertyName: PropT): Observable<T[PropT]>;
|
|
18
|
-
isSyncingProperty(propertyName: keyof T): Observable<boolean>;
|
|
19
|
-
onPropertySyncing<PropT extends keyof T>(propertyName: PropT): Observable<PropT>;
|
|
20
|
-
onPropertySynced<PropT extends keyof T>(propertyName: PropT): Observable<PropT>;
|
|
21
|
-
onEveryPropertySyncing(...propertyNames: Array<keyof T>): Observable<Array<keyof T>>;
|
|
22
|
-
onEveryPropertySynced(...propertyNames: Array<keyof T>): Observable<Array<keyof T>>;
|
|
23
|
-
onSomePropertySyncing(...propertyNames: Array<keyof T>): Observable<keyof T>;
|
|
24
|
-
onSomePropertySynced(...propertyNames: Array<keyof T>): Observable<keyof T>;
|
|
25
|
-
require<RequestParamsT = never>(propertyNames: keyof T | Array<keyof T>, options?: Synchronizer.ReadOptions<RequestParamsT>): Observable<T>;
|
|
26
|
-
requireProperty<PropT extends keyof T, RequestParamsT = never>(propertyName: PropT, options?: Synchronizer.ReadOptions<RequestParamsT>): Observable<T[PropT]>;
|
|
27
|
-
sync<RequestParamsT = never>(propertyNames: keyof T | Array<keyof T>, options?: Synchronizer.ReadOptions<RequestParamsT>): Observable<T>;
|
|
28
|
-
syncProperty<PropT extends keyof T, RequestParamsT = never>(propertyName: PropT, options?: Synchronizer.ReadOptions<RequestParamsT>): Observable<T[PropT]>;
|
|
29
|
-
export<RequestParamsT = never>(propertyNames: keyof T | Array<keyof T>, options?: Synchronizer.WriteOptions<RequestParamsT>): Observable<any>;
|
|
30
|
-
private requireOne;
|
|
31
|
-
private requireAll;
|
|
32
|
-
private syncOne;
|
|
33
|
-
private syncAll;
|
|
34
|
-
private exportOne;
|
|
35
|
-
private exportAll;
|
|
36
|
-
private getPropertyUpdater;
|
|
37
|
-
private clearPropertyUpdater;
|
|
38
|
-
private resolveSynchronizer;
|
|
39
|
-
}
|
package/sync-store.d.ts
DELETED
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
import { Injector, Signal } from "@angular/core";
|
|
2
|
-
import { Store, TypedSelector } from "@ngxs/store";
|
|
3
|
-
import { SyncClass } from "./decorators/sync-class";
|
|
4
|
-
import { StateSelector } from "./state-selector";
|
|
5
|
-
import { Observable, Subscription } from "rxjs";
|
|
6
|
-
import * as i0 from "@angular/core";
|
|
7
|
-
type ActionOrArrayOfActions<T> = T extends (infer U)[] ? NonNullable<U>[] : NonNullable<T>;
|
|
8
|
-
export declare class SyncStore {
|
|
9
|
-
readonly injector: Injector;
|
|
10
|
-
private readonly store;
|
|
11
|
-
private readonly _selectorMap;
|
|
12
|
-
constructor(injector: Injector, store: Store);
|
|
13
|
-
state<T>(syncState: SyncClass<T>): StateSelector<T>;
|
|
14
|
-
dispatch<T>(actionOrActions: ActionOrArrayOfActions<T>): Observable<void>;
|
|
15
|
-
select<T>(selector: TypedSelector<T>): Observable<T>;
|
|
16
|
-
selectOnce<T>(selector: TypedSelector<T>): Observable<T>;
|
|
17
|
-
selectSnapshot<T>(selector: TypedSelector<T>): T;
|
|
18
|
-
selectSignal<T>(selector: TypedSelector<T>): Signal<T>;
|
|
19
|
-
subscribe(fn?: (value: any) => void): Subscription;
|
|
20
|
-
snapshot(): any;
|
|
21
|
-
reset(state: any): void;
|
|
22
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SyncStore, never>;
|
|
23
|
-
static ɵprov: i0.ɵɵInjectableDeclaration<SyncStore>;
|
|
24
|
-
}
|
|
25
|
-
export {};
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { Observable } from "rxjs";
|
|
2
|
-
import { Synchronizer } from "./synchronizer";
|
|
3
|
-
export interface CollectionSynchronizer<T, ReadParamsT = never, WriteParamsT = never> extends Synchronizer<T, keyof T, ReadParamsT, WriteParamsT> {
|
|
4
|
-
read(requiredDetails: Partial<T>, options: CollectionSynchronizer.ReadOptions<T, ReadParamsT>): Observable<T[keyof T]>;
|
|
5
|
-
write?(value: T[keyof T], options: CollectionSynchronizer.WriteOptions<T, WriteParamsT>): Observable<any>;
|
|
6
|
-
}
|
|
7
|
-
export declare namespace CollectionSynchronizer {
|
|
8
|
-
type ReadOptions<T, ParamsT = never> = Synchronizer.BaseOptions<T, keyof T, ParamsT> & Synchronizer.ReadOptions<ParamsT>;
|
|
9
|
-
type WriteOptions<T, ParamsT = never> = Synchronizer.BaseOptions<T, keyof T, ParamsT> & Synchronizer.WriteOptions<ParamsT>;
|
|
10
|
-
}
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { Observable } from "rxjs";
|
|
2
|
-
import { Synchronizer } from "./synchronizer";
|
|
3
|
-
export interface PropertySynchronizer<T, PropKey extends keyof T, ReadParamsT = never, WriteParamsT = never> extends Synchronizer<T, PropKey, ReadParamsT, WriteParamsT> {
|
|
4
|
-
read(requiredDetails: Partial<T>, options: PropertySynchronizer.ReadOptions<T, PropKey, ReadParamsT>): Observable<T[PropKey]>;
|
|
5
|
-
write?(value: T[PropKey], options: PropertySynchronizer.WriteOptions<T, PropKey, WriteParamsT>): Observable<any>;
|
|
6
|
-
}
|
|
7
|
-
export declare namespace PropertySynchronizer {
|
|
8
|
-
type ReadOptions<T, PropKey extends keyof T = keyof T, ParamsT = never> = Synchronizer.BaseOptions<T, PropKey, ParamsT> & Synchronizer.ReadOptions<ParamsT>;
|
|
9
|
-
type WriteOptions<T, PropKey extends keyof T = keyof T, ParamsT = never> = Synchronizer.BaseOptions<T, PropKey, ParamsT> & Synchronizer.WriteOptions<ParamsT>;
|
|
10
|
-
}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import { Injector } from "@angular/core";
|
|
2
|
-
import { Observable } from "rxjs";
|
|
3
|
-
import { SyncClass } from "../decorators/sync-class";
|
|
4
|
-
import { PropertySynchronizer } from "./property-synchronizer";
|
|
5
|
-
export declare abstract class StateSynchronizer<T, PropKey extends keyof T, ReadParamsT = never, WriteParamsT = never> implements PropertySynchronizer<T, PropKey, ReadParamsT, WriteParamsT> {
|
|
6
|
-
private readonly injector;
|
|
7
|
-
private readonly propertyState;
|
|
8
|
-
constructor(injector: Injector, propertyState: SyncClass<T[PropKey]>);
|
|
9
|
-
read(_requiredDetails: Partial<T>, _options: PropertySynchronizer.ReadOptions<T, PropKey, ReadParamsT>): Observable<T[PropKey]>;
|
|
10
|
-
protected readSubset(properties: Array<keyof T[PropKey]>): Observable<T[PropKey]>;
|
|
11
|
-
private readProperties;
|
|
12
|
-
private readProperty;
|
|
13
|
-
}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import { Injector, Type } from "@angular/core";
|
|
2
|
-
import { CollectionSynchronizer } from "./collection-synchronizer";
|
|
3
|
-
import { PropertySynchronizer } from "./property-synchronizer";
|
|
4
|
-
import { Synchronizer } from "./synchronizer";
|
|
5
|
-
export type SynchronizerDictionary<T> = {
|
|
6
|
-
[P in keyof T]?: Type<PropertySynchronizer<T, P>>;
|
|
7
|
-
} | Type<CollectionSynchronizer<T>>;
|
|
8
|
-
export declare namespace SynchronizerDictionary {
|
|
9
|
-
function keys<T>(dict: SynchronizerDictionary<T>): Array<keyof T>;
|
|
10
|
-
function isCollectionSynchronizer<T>(dict: SynchronizerDictionary<T>): dict is Type<CollectionSynchronizer<T>>;
|
|
11
|
-
function resolveSynchronizer<T>(dict: SynchronizerDictionary<T>, propKey: keyof T): Type<Synchronizer<T, keyof T, unknown, unknown>> | undefined;
|
|
12
|
-
function resolveSynchronizerInstance<T>(injector: Injector, dict: SynchronizerDictionary<T>, propKey: keyof T): Synchronizer<T, keyof T, unknown, unknown>;
|
|
13
|
-
}
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
import { Observable } from "rxjs";
|
|
2
|
-
export interface Synchronizer<T, PropKey extends keyof T, ReadParamsT, WriteParamsT> {
|
|
3
|
-
requiredProperties?: Array<keyof T>;
|
|
4
|
-
proxy?: boolean;
|
|
5
|
-
read(requiredDetails: Partial<T>, options: Synchronizer.BaseOptions<T, PropKey, ReadParamsT> & Synchronizer.ReadOptions<ReadParamsT>): Observable<T[PropKey]>;
|
|
6
|
-
write?(value: T[PropKey], options: Synchronizer.BaseOptions<T, PropKey, WriteParamsT> & Synchronizer.WriteOptions<WriteParamsT>): Observable<any>;
|
|
7
|
-
}
|
|
8
|
-
export declare namespace Synchronizer {
|
|
9
|
-
interface BaseOptions<T, PropKey extends keyof T, ParamsT> {
|
|
10
|
-
propertyName: PropKey;
|
|
11
|
-
requestParams?: ParamsT;
|
|
12
|
-
}
|
|
13
|
-
interface ReadOptions<ParamsT> {
|
|
14
|
-
clearStore?: boolean;
|
|
15
|
-
requestParams?: ParamsT;
|
|
16
|
-
}
|
|
17
|
-
interface WriteOptions<ParamsT> {
|
|
18
|
-
requestParams?: ParamsT;
|
|
19
|
-
}
|
|
20
|
-
}
|