@genesislcap/foundation-store 14.303.0 → 14.303.2
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/package.json +12 -12
- package/docs/api-report.md +0 -183
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/foundation-store",
|
|
3
3
|
"description": "Genesis Foundation Store",
|
|
4
|
-
"version": "14.303.
|
|
4
|
+
"version": "14.303.2",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -36,18 +36,18 @@
|
|
|
36
36
|
}
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
|
-
"@genesislcap/foundation-testing": "14.303.
|
|
40
|
-
"@genesislcap/genx": "14.303.
|
|
41
|
-
"@genesislcap/rollup-builder": "14.303.
|
|
42
|
-
"@genesislcap/ts-builder": "14.303.
|
|
43
|
-
"@genesislcap/uvu-playwright-builder": "14.303.
|
|
44
|
-
"@genesislcap/vite-builder": "14.303.
|
|
45
|
-
"@genesislcap/webpack-builder": "14.303.
|
|
39
|
+
"@genesislcap/foundation-testing": "14.303.2",
|
|
40
|
+
"@genesislcap/genx": "14.303.2",
|
|
41
|
+
"@genesislcap/rollup-builder": "14.303.2",
|
|
42
|
+
"@genesislcap/ts-builder": "14.303.2",
|
|
43
|
+
"@genesislcap/uvu-playwright-builder": "14.303.2",
|
|
44
|
+
"@genesislcap/vite-builder": "14.303.2",
|
|
45
|
+
"@genesislcap/webpack-builder": "14.303.2"
|
|
46
46
|
},
|
|
47
47
|
"dependencies": {
|
|
48
|
-
"@genesislcap/foundation-events": "14.303.
|
|
49
|
-
"@genesislcap/foundation-logger": "14.303.
|
|
50
|
-
"@genesislcap/foundation-utils": "14.303.
|
|
48
|
+
"@genesislcap/foundation-events": "14.303.2",
|
|
49
|
+
"@genesislcap/foundation-logger": "14.303.2",
|
|
50
|
+
"@genesislcap/foundation-utils": "14.303.2",
|
|
51
51
|
"@microsoft/fast-element": "1.14.0",
|
|
52
52
|
"@microsoft/fast-foundation": "2.49.6",
|
|
53
53
|
"@microsoft/fast-web-utilities": "5.4.1",
|
|
@@ -62,5 +62,5 @@
|
|
|
62
62
|
"publishConfig": {
|
|
63
63
|
"access": "public"
|
|
64
64
|
},
|
|
65
|
-
"gitHead": "
|
|
65
|
+
"gitHead": "f556f123bafe956a7ba9328bb3f78f4d7d2495ba"
|
|
66
66
|
}
|
package/docs/api-report.md
DELETED
|
@@ -1,183 +0,0 @@
|
|
|
1
|
-
## API Report File for "@genesislcap/foundation-store"
|
|
2
|
-
|
|
3
|
-
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
-
|
|
5
|
-
```ts
|
|
6
|
-
|
|
7
|
-
import { BindingObserver } from '@microsoft/fast-element';
|
|
8
|
-
import { Constructable } from '@microsoft/fast-element';
|
|
9
|
-
import { ErrorMap as ErrorMap_2 } from '@genesislcap/foundation-utils';
|
|
10
|
-
import type { EventDetailMap } from '@genesislcap/foundation-events';
|
|
11
|
-
import { ExecutionContext } from '@microsoft/fast-element';
|
|
12
|
-
import { InterfaceSymbol } from '@microsoft/fast-foundation';
|
|
13
|
-
import { Key } from '@microsoft/fast-foundation';
|
|
14
|
-
import { Logger } from '@genesislcap/foundation-logger';
|
|
15
|
-
import { Observable } from 'rxjs';
|
|
16
|
-
|
|
17
|
-
// @public
|
|
18
|
-
export abstract class AbstractStore<TStore extends Store, TEventDetailMap extends EventDetailMap, TInternalEventDetailMap extends EventDetailMap = TEventDetailMap, TStoreRoot extends StoreRoot = StoreRoot> implements Store {
|
|
19
|
-
constructor(...storeFragments: Store[]);
|
|
20
|
-
// @internal
|
|
21
|
-
protected addEventListeners(element: HTMLElement): void;
|
|
22
|
-
addStoreFragments(...storeFragments: Store[]): void;
|
|
23
|
-
binding<TReturn = any, TParent = any>(token: ((store: this) => TReturn) | keyof this, subscriberChangeCallback?: SubscriberChangeCallback<TReturn> | undefined, isVolatileBinding?: boolean, context?: ExecutionContext): BindingObserver<this, TReturn, TParent>;
|
|
24
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "bindingAsRx" has more than one declaration; you need to add a TSDoc member reference selector
|
|
25
|
-
//
|
|
26
|
-
// (undocumented)
|
|
27
|
-
bindingAsRx(): Observable<this>;
|
|
28
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "bindingAsRx" has more than one declaration; you need to add a TSDoc member reference selector
|
|
29
|
-
//
|
|
30
|
-
// (undocumented)
|
|
31
|
-
bindingAsRx<TKey extends keyof this>(key: TKey): Observable<this[TKey]>;
|
|
32
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "bindingAsRx" has more than one declaration; you need to add a TSDoc member reference selector
|
|
33
|
-
//
|
|
34
|
-
// (undocumented)
|
|
35
|
-
bindingAsRx<TReturn>(getter: (store: this) => TReturn): Observable<TReturn>;
|
|
36
|
-
// @beta
|
|
37
|
-
protected readonly commit: this;
|
|
38
|
-
// @internal
|
|
39
|
-
protected readonly commitHandler: ProxyHandler<this>;
|
|
40
|
-
// @beta
|
|
41
|
-
protected commitValue<K extends keyof TStore>(key: K, value: TStore[K]): void;
|
|
42
|
-
connect(root: TStoreRoot): void;
|
|
43
|
-
// @internal
|
|
44
|
-
protected connectStoreFragments(root: TStoreRoot, storeFragments?: Store[]): void;
|
|
45
|
-
// Warning: (ae-incompatible-release-tags) The symbol "createAsyncListener" is marked as @public, but its signature references "KeyOrKeys" which is marked as @internal
|
|
46
|
-
protected createAsyncListener: <TDetail = void, TReturn = void>(keys: KeyOrKeys<TEventDetailMap & TInternalEventDetailMap>, token: (detail: TDetail, event?: CustomEvent<TDetail>) => Promise<TReturn>) => EventListener;
|
|
47
|
-
// Warning: (ae-incompatible-release-tags) The symbol "createErrorListener" is marked as @public, but its signature references "KeyOrKeys" which is marked as @internal
|
|
48
|
-
protected createErrorListener: <TDetail extends Error = Error>(keys: KeyOrKeys<TEventDetailMap & TInternalEventDetailMap>, token?: (detail: TDetail, event?: CustomEvent<TDetail>) => void) => EventListener;
|
|
49
|
-
// Warning: (ae-incompatible-release-tags) The symbol "createListener" is marked as @public, but its signature references "KeyOrKeys" which is marked as @internal
|
|
50
|
-
protected createListener: <TDetail = void>(keys: KeyOrKeys<TEventDetailMap & TInternalEventDetailMap>, token: (detail: TDetail, event?: CustomEvent<TDetail>) => void) => EventListener;
|
|
51
|
-
disconnect(root: TStoreRoot): void;
|
|
52
|
-
// @internal
|
|
53
|
-
protected disconnectStoreFragments(root: TStoreRoot, storeFragments?: Store[]): void;
|
|
54
|
-
protected emit<K extends keyof (TEventDetailMap & TInternalEventDetailMap) & string>(...args: (TEventDetailMap & TInternalEventDetailMap)[K] extends void ? [key: K] : [key: K, detail: (TEventDetailMap & TInternalEventDetailMap)[K]]): void;
|
|
55
|
-
errors: ErrorMap_2<TEventDetailMap & TInternalEventDetailMap>;
|
|
56
|
-
protected invokeAsyncAPI<TResult>(api: () => Promise<TResult>, error: keyof (TEventDetailMap & TInternalEventDetailMap), success?: keyof (TEventDetailMap & TInternalEventDetailMap)): Promise<void>;
|
|
57
|
-
get name(): string;
|
|
58
|
-
// @internal
|
|
59
|
-
protected removeEventListeners(element: HTMLElement): void;
|
|
60
|
-
removeStoreFragments(...storeFragments: Store[]): void;
|
|
61
|
-
protected root: TStoreRoot;
|
|
62
|
-
// @internal
|
|
63
|
-
protected storeFragments: Store[];
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
// @public
|
|
67
|
-
export abstract class AbstractStoreRoot<TStore extends StoreRoot, TEventDetailMap extends StoreRootEventDetailMap = StoreRootEventDetailMap, TInternalEventDetailMap extends EventDetailMap = TEventDetailMap> extends AbstractStore<TStore, TEventDetailMap, TInternalEventDetailMap> implements StoreRoot {
|
|
68
|
-
element: HTMLElement;
|
|
69
|
-
// (undocumented)
|
|
70
|
-
onConnected: EventListener;
|
|
71
|
-
// (undocumented)
|
|
72
|
-
onDisconnected: EventListener;
|
|
73
|
-
// (undocumented)
|
|
74
|
-
onReady: EventListener;
|
|
75
|
-
ready: boolean;
|
|
76
|
-
// (undocumented)
|
|
77
|
-
protected root: this;
|
|
78
|
-
}
|
|
79
|
-
|
|
80
|
-
// @public @deprecated
|
|
81
|
-
export const createErrorMap: <TErrorDetailMap extends ErrorDetailMap>(logger: ErrorMapLogger) => ErrorMap<TErrorDetailMap>;
|
|
82
|
-
|
|
83
|
-
// @public @deprecated (undocumented)
|
|
84
|
-
export type ErrorDetailMap = Record<string, unknown>;
|
|
85
|
-
|
|
86
|
-
// @public @deprecated (undocumented)
|
|
87
|
-
export interface ErrorMap<TErrorDetailMap extends ErrorDetailMap> extends Pick<Map<keyof TErrorDetailMap, Error>, 'get' | 'has' | 'delete' | 'clear' | 'size'> {
|
|
88
|
-
readonly messages: string;
|
|
89
|
-
set(key: keyof TErrorDetailMap, error: Error): void;
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
// @public @deprecated (undocumented)
|
|
93
|
-
export type ErrorMapLogger = (...args: any[]) => void;
|
|
94
|
-
|
|
95
|
-
// Warning: (ae-internal-missing-underscore) The name "EventListenerType" should be prefixed with an underscore because the declaration is marked as @internal
|
|
96
|
-
//
|
|
97
|
-
// @internal (undocumented)
|
|
98
|
-
export enum EventListenerType {
|
|
99
|
-
// (undocumented)
|
|
100
|
-
async = "async",
|
|
101
|
-
// (undocumented)
|
|
102
|
-
error = "error",
|
|
103
|
-
// (undocumented)
|
|
104
|
-
sync = "sync"
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
// Warning: (ae-internal-missing-underscore) The name "KeyOrKeys" should be prefixed with an underscore because the declaration is marked as @internal
|
|
108
|
-
//
|
|
109
|
-
// @internal (undocumented)
|
|
110
|
-
export type KeyOrKeys<TEventDetailMaps extends EventDetailMap> = keyof TEventDetailMaps | (keyof TEventDetailMaps)[];
|
|
111
|
-
|
|
112
|
-
// @public
|
|
113
|
-
export const logger: Logger;
|
|
114
|
-
|
|
115
|
-
// @public
|
|
116
|
-
export const registerStore: <K extends Key>(Base: Constructable<Store>, name?: string) => InterfaceSymbol<K>;
|
|
117
|
-
|
|
118
|
-
// @public
|
|
119
|
-
export interface Store {
|
|
120
|
-
addStoreFragments(...storeFragments: Store[]): void;
|
|
121
|
-
binding<TReturn = any, TParent = any>(token: ((store: this) => TReturn) | keyof this, subscriberChangeCallback?: SubscriberChangeCallback<TReturn> | undefined, isVolatileBinding?: boolean, context?: ExecutionContext): BindingObserver<this, TReturn, TParent>;
|
|
122
|
-
bindingAsRx(): Observable<this>;
|
|
123
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "bindingAsRx" has more than one declaration; you need to add a TSDoc member reference selector
|
|
124
|
-
//
|
|
125
|
-
// (undocumented)
|
|
126
|
-
bindingAsRx<TKey extends keyof this>(key: TKey): Observable<this[TKey]>;
|
|
127
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "bindingAsRx" has more than one declaration; you need to add a TSDoc member reference selector
|
|
128
|
-
//
|
|
129
|
-
// (undocumented)
|
|
130
|
-
bindingAsRx<TReturn>(getter: (store: this) => TReturn): Observable<TReturn>;
|
|
131
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "bindingAsRx" has more than one declaration; you need to add a TSDoc member reference selector
|
|
132
|
-
//
|
|
133
|
-
// (undocumented)
|
|
134
|
-
bindingAsRx<TReturn>(token?: ((store: this) => TReturn) | keyof this): Observable<TReturn | this>;
|
|
135
|
-
readonly errors: ErrorMap_2<EventDetailMap>;
|
|
136
|
-
// @virtual
|
|
137
|
-
readonly name?: string;
|
|
138
|
-
removeStoreFragments(...storeFragments: Store[]): void;
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
// @public (undocumented)
|
|
142
|
-
export type StoreBinding<TStore extends Store> = (store: TStore) => any;
|
|
143
|
-
|
|
144
|
-
// @public
|
|
145
|
-
export interface StoreConnectable<TStoreRoot extends StoreRoot> {
|
|
146
|
-
connect(root: TStoreRoot): void;
|
|
147
|
-
disconnect(root: TStoreRoot): void;
|
|
148
|
-
}
|
|
149
|
-
|
|
150
|
-
// @public
|
|
151
|
-
export interface StoreRoot extends Store {
|
|
152
|
-
readonly element: HTMLElement;
|
|
153
|
-
// (undocumented)
|
|
154
|
-
onConnected(event: CustomEvent<HTMLElement>): void;
|
|
155
|
-
// (undocumented)
|
|
156
|
-
onDisconnected(event: CustomEvent<void>): void;
|
|
157
|
-
// (undocumented)
|
|
158
|
-
onReady(event: CustomEvent<boolean>): void;
|
|
159
|
-
readonly ready: boolean;
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
// @public
|
|
163
|
-
export type StoreRootEventDetailMap = {
|
|
164
|
-
'store-connected': HTMLElement;
|
|
165
|
-
'store-disconnected': void;
|
|
166
|
-
'store-ready': boolean;
|
|
167
|
-
};
|
|
168
|
-
|
|
169
|
-
// @public (undocumented)
|
|
170
|
-
export interface StoreSubscriber<TStore extends Store, TReturn = any> {
|
|
171
|
-
// (undocumented)
|
|
172
|
-
handleChange: SubscriberChangeHandler<TStore, TReturn>;
|
|
173
|
-
}
|
|
174
|
-
|
|
175
|
-
// @public (undocumented)
|
|
176
|
-
export type SubscriberChangeCallback<TReturn = any> = (value: TReturn, args: BindingObserver) => void;
|
|
177
|
-
|
|
178
|
-
// @public (undocumented)
|
|
179
|
-
export type SubscriberChangeHandler<TStore extends Store, TReturn = any> = (binding: (x?: TStore, context?: ExecutionContext) => TReturn, args: BindingObserver) => void;
|
|
180
|
-
|
|
181
|
-
// (No @packageDocumentation comment for this package)
|
|
182
|
-
|
|
183
|
-
```
|