@genesislcap/foundation-user 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 -316
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/foundation-user",
|
|
3
3
|
"description": "Genesis User",
|
|
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",
|
|
@@ -35,18 +35,18 @@
|
|
|
35
35
|
}
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
|
-
"@genesislcap/foundation-testing": "14.303.
|
|
39
|
-
"@genesislcap/genx": "14.303.
|
|
40
|
-
"@genesislcap/rollup-builder": "14.303.
|
|
41
|
-
"@genesislcap/ts-builder": "14.303.
|
|
42
|
-
"@genesislcap/uvu-playwright-builder": "14.303.
|
|
43
|
-
"@genesislcap/vite-builder": "14.303.
|
|
44
|
-
"@genesislcap/webpack-builder": "14.303.
|
|
38
|
+
"@genesislcap/foundation-testing": "14.303.2",
|
|
39
|
+
"@genesislcap/genx": "14.303.2",
|
|
40
|
+
"@genesislcap/rollup-builder": "14.303.2",
|
|
41
|
+
"@genesislcap/ts-builder": "14.303.2",
|
|
42
|
+
"@genesislcap/uvu-playwright-builder": "14.303.2",
|
|
43
|
+
"@genesislcap/vite-builder": "14.303.2",
|
|
44
|
+
"@genesislcap/webpack-builder": "14.303.2"
|
|
45
45
|
},
|
|
46
46
|
"dependencies": {
|
|
47
|
-
"@genesislcap/foundation-broadcast-channel": "14.303.
|
|
48
|
-
"@genesislcap/foundation-logger": "14.303.
|
|
49
|
-
"@genesislcap/foundation-utils": "14.303.
|
|
47
|
+
"@genesislcap/foundation-broadcast-channel": "14.303.2",
|
|
48
|
+
"@genesislcap/foundation-logger": "14.303.2",
|
|
49
|
+
"@genesislcap/foundation-utils": "14.303.2",
|
|
50
50
|
"@microsoft/fast-element": "1.14.0",
|
|
51
51
|
"@microsoft/fast-foundation": "2.49.6"
|
|
52
52
|
},
|
|
@@ -58,5 +58,5 @@
|
|
|
58
58
|
"publishConfig": {
|
|
59
59
|
"access": "public"
|
|
60
60
|
},
|
|
61
|
-
"gitHead": "
|
|
61
|
+
"gitHead": "f556f123bafe956a7ba9328bb3f78f4d7d2495ba"
|
|
62
62
|
}
|
package/docs/api-report.md
DELETED
|
@@ -1,316 +0,0 @@
|
|
|
1
|
-
## API Report File for "@genesislcap/foundation-user"
|
|
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 { InterfaceSymbol } from '@microsoft/fast-foundation';
|
|
8
|
-
import { Listener } from '@genesislcap/foundation-utils';
|
|
9
|
-
import { Logger } from '@genesislcap/foundation-logger';
|
|
10
|
-
import { Observer } from '@genesislcap/foundation-utils';
|
|
11
|
-
import { TypedBroadcastChannel } from '@genesislcap/foundation-broadcast-channel';
|
|
12
|
-
|
|
13
|
-
// @public
|
|
14
|
-
export class DefaultUser implements User {
|
|
15
|
-
actionHistory: unknown[];
|
|
16
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
17
|
-
//
|
|
18
|
-
// (undocumented)
|
|
19
|
-
addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent>): () => void;
|
|
20
|
-
// @internal (undocumented)
|
|
21
|
-
protected authenticationChangeListeners: Observer<UserAuthenticationChangeEvent>;
|
|
22
|
-
clearActions(): void;
|
|
23
|
-
clearPaths(): void;
|
|
24
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
25
|
-
//
|
|
26
|
-
// (undocumented)
|
|
27
|
-
clearTrackingHistory(): void;
|
|
28
|
-
// @internal (undocumented)
|
|
29
|
-
protected config: UserConfig;
|
|
30
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
31
|
-
//
|
|
32
|
-
// (undocumented)
|
|
33
|
-
details: SetUserProperties['details'];
|
|
34
|
-
// (undocumented)
|
|
35
|
-
hasAdminProfile(): boolean;
|
|
36
|
-
// @internal (undocumented)
|
|
37
|
-
protected hasKey(keys: string[], key: string | string[]): boolean;
|
|
38
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
39
|
-
//
|
|
40
|
-
// (undocumented)
|
|
41
|
-
hasPermission(permission: string | string[]): boolean;
|
|
42
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
43
|
-
//
|
|
44
|
-
// (undocumented)
|
|
45
|
-
hasProfile(profile: string | string[]): boolean;
|
|
46
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
47
|
-
//
|
|
48
|
-
// (undocumented)
|
|
49
|
-
isAdmin(): boolean;
|
|
50
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
51
|
-
//
|
|
52
|
-
// (undocumented)
|
|
53
|
-
get isAnonymous(): boolean;
|
|
54
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
55
|
-
//
|
|
56
|
-
// (undocumented)
|
|
57
|
-
isAuthenticated: boolean;
|
|
58
|
-
// @internal (undocumented)
|
|
59
|
-
protected isAuthenticatedChanged(): void;
|
|
60
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
61
|
-
//
|
|
62
|
-
// (undocumented)
|
|
63
|
-
isBanned(): boolean;
|
|
64
|
-
// (undocumented)
|
|
65
|
-
lastAction(): unknown;
|
|
66
|
-
lastPath(): string;
|
|
67
|
-
pathHistory: string[];
|
|
68
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
69
|
-
//
|
|
70
|
-
// (undocumented)
|
|
71
|
-
permission: string[];
|
|
72
|
-
// @internal (undocumented)
|
|
73
|
-
protected permissionChanged(): void;
|
|
74
|
-
// (undocumented)
|
|
75
|
-
get permissions(): string[];
|
|
76
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
77
|
-
//
|
|
78
|
-
// (undocumented)
|
|
79
|
-
profile: string[];
|
|
80
|
-
// @internal (undocumented)
|
|
81
|
-
protected profileChanged(): void;
|
|
82
|
-
// (undocumented)
|
|
83
|
-
get profiles(): string[];
|
|
84
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
85
|
-
//
|
|
86
|
-
// (undocumented)
|
|
87
|
-
rawProperties: Partial<SetUserProperties>;
|
|
88
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
89
|
-
//
|
|
90
|
-
// (undocumented)
|
|
91
|
-
set(properties: Partial<SetUserProperties>): User;
|
|
92
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
93
|
-
//
|
|
94
|
-
// (undocumented)
|
|
95
|
-
sourceRef: string;
|
|
96
|
-
trackAction<TDetails = unknown>(details: TDetails): void;
|
|
97
|
-
trackPath(): string;
|
|
98
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
99
|
-
//
|
|
100
|
-
// (undocumented)
|
|
101
|
-
unset(): User;
|
|
102
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
103
|
-
//
|
|
104
|
-
// (undocumented)
|
|
105
|
-
userKVs: {
|
|
106
|
-
[key: string]: any;
|
|
107
|
-
};
|
|
108
|
-
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
|
|
109
|
-
//
|
|
110
|
-
// (undocumented)
|
|
111
|
-
userName: string;
|
|
112
|
-
// (undocumented)
|
|
113
|
-
get username(): string;
|
|
114
|
-
// @internal (undocumented)
|
|
115
|
-
protected userNameChanged(): void;
|
|
116
|
-
}
|
|
117
|
-
|
|
118
|
-
// @public
|
|
119
|
-
export const defaultUserConfig: UserConfig;
|
|
120
|
-
|
|
121
|
-
// @public
|
|
122
|
-
export function getUser(): User;
|
|
123
|
-
|
|
124
|
-
// @public
|
|
125
|
-
export function getUserChannel(): UserChannel;
|
|
126
|
-
|
|
127
|
-
// @public (undocumented)
|
|
128
|
-
export interface LegacyUserAPI {
|
|
129
|
-
// @deprecated (undocumented)
|
|
130
|
-
hasAdminProfile(): boolean;
|
|
131
|
-
// @deprecated (undocumented)
|
|
132
|
-
readonly permissions: string[];
|
|
133
|
-
// @deprecated (undocumented)
|
|
134
|
-
readonly profiles: string[];
|
|
135
|
-
// @deprecated (undocumented)
|
|
136
|
-
readonly username: string;
|
|
137
|
-
}
|
|
138
|
-
|
|
139
|
-
// @public (undocumented)
|
|
140
|
-
export const logger: Logger;
|
|
141
|
-
|
|
142
|
-
// @public
|
|
143
|
-
export interface SetUserProperties extends Partial<UserQueueProperties> {
|
|
144
|
-
// (undocumented)
|
|
145
|
-
readonly [key: string]: any;
|
|
146
|
-
// (undocumented)
|
|
147
|
-
readonly details: UserDetailsProperty;
|
|
148
|
-
// (undocumented)
|
|
149
|
-
readonly permission: string[];
|
|
150
|
-
// (undocumented)
|
|
151
|
-
readonly profile: string[];
|
|
152
|
-
// (undocumented)
|
|
153
|
-
readonly sourceRef: string;
|
|
154
|
-
// (undocumented)
|
|
155
|
-
readonly userKVs: UserKVsProperty;
|
|
156
|
-
// (undocumented)
|
|
157
|
-
readonly userName: string;
|
|
158
|
-
}
|
|
159
|
-
|
|
160
|
-
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "User" because one of its declarations is marked as @internal
|
|
161
|
-
//
|
|
162
|
-
// @public
|
|
163
|
-
export interface User extends UserPathHistory, UserActionHistory, LegacyUserAPI {
|
|
164
|
-
// (undocumented)
|
|
165
|
-
addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent>): () => void;
|
|
166
|
-
// (undocumented)
|
|
167
|
-
clearTrackingHistory(): void;
|
|
168
|
-
// (undocumented)
|
|
169
|
-
readonly details: SetUserProperties['details'];
|
|
170
|
-
// (undocumented)
|
|
171
|
-
hasPermission(permission: string | string[]): boolean;
|
|
172
|
-
// (undocumented)
|
|
173
|
-
hasProfile(profile: string | string[]): boolean;
|
|
174
|
-
// (undocumented)
|
|
175
|
-
isAdmin(): boolean;
|
|
176
|
-
// (undocumented)
|
|
177
|
-
readonly isAnonymous: boolean;
|
|
178
|
-
// (undocumented)
|
|
179
|
-
readonly isAuthenticated: boolean;
|
|
180
|
-
// (undocumented)
|
|
181
|
-
isBanned(): boolean;
|
|
182
|
-
// (undocumented)
|
|
183
|
-
readonly permission: string[];
|
|
184
|
-
// (undocumented)
|
|
185
|
-
readonly profile: string[];
|
|
186
|
-
readonly rawProperties: Partial<SetUserProperties>;
|
|
187
|
-
// (undocumented)
|
|
188
|
-
set(properties: Partial<SetUserProperties>): User;
|
|
189
|
-
// (undocumented)
|
|
190
|
-
readonly sourceRef: string;
|
|
191
|
-
// (undocumented)
|
|
192
|
-
unset(): User;
|
|
193
|
-
// (undocumented)
|
|
194
|
-
readonly userKVs: {
|
|
195
|
-
[key: string]: any;
|
|
196
|
-
};
|
|
197
|
-
// (undocumented)
|
|
198
|
-
readonly userName: string;
|
|
199
|
-
}
|
|
200
|
-
|
|
201
|
-
// @internal
|
|
202
|
-
export const User: InterfaceSymbol<User>;
|
|
203
|
-
|
|
204
|
-
// @public
|
|
205
|
-
export interface UserActionHistory {
|
|
206
|
-
readonly actionHistory: unknown[];
|
|
207
|
-
clearActions(): void;
|
|
208
|
-
// (undocumented)
|
|
209
|
-
lastAction(): unknown;
|
|
210
|
-
trackAction<TDetails = unknown>(details: TDetails): void;
|
|
211
|
-
}
|
|
212
|
-
|
|
213
|
-
// @public
|
|
214
|
-
export type UserAuthenticationChangeEvent = CustomEvent<boolean>;
|
|
215
|
-
|
|
216
|
-
// @public
|
|
217
|
-
export const UserAuthenticationChangeType = "user-authentication-change";
|
|
218
|
-
|
|
219
|
-
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "UserChannel" because one of its declarations is marked as @internal
|
|
220
|
-
//
|
|
221
|
-
// @public
|
|
222
|
-
export interface UserChannel extends TypedBroadcastChannel<UserChannelEvents> {
|
|
223
|
-
}
|
|
224
|
-
|
|
225
|
-
// @internal
|
|
226
|
-
export const UserChannel: InterfaceSymbol<TypedBroadcastChannel<UserChannelEvents>>;
|
|
227
|
-
|
|
228
|
-
// @public
|
|
229
|
-
export type UserChannelEvents = {
|
|
230
|
-
[UserAuthenticationChangeType]: boolean;
|
|
231
|
-
};
|
|
232
|
-
|
|
233
|
-
// @public
|
|
234
|
-
export const UserChannelId = "genesis-user";
|
|
235
|
-
|
|
236
|
-
// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "UserConfig" because one of its declarations is marked as @internal
|
|
237
|
-
//
|
|
238
|
-
// @public
|
|
239
|
-
export interface UserConfig {
|
|
240
|
-
// Warning: (ae-forgotten-export) The symbol "WriteableUser" needs to be exported by the entry point index.d.ts
|
|
241
|
-
setUser(user: WriteableUser, properties: Partial<SetUserProperties>): User;
|
|
242
|
-
trackActionExclusions: unknown[];
|
|
243
|
-
trackPathExclusions: string[];
|
|
244
|
-
unsetUser(user: WriteableUser): User;
|
|
245
|
-
}
|
|
246
|
-
|
|
247
|
-
// @internal
|
|
248
|
-
export const UserConfig: InterfaceSymbol<UserConfig>;
|
|
249
|
-
|
|
250
|
-
// @public (undocumented)
|
|
251
|
-
export interface UserDetailsProductProperty {
|
|
252
|
-
// (undocumented)
|
|
253
|
-
readonly [key: string]: any;
|
|
254
|
-
// (undocumented)
|
|
255
|
-
readonly name: string;
|
|
256
|
-
// (undocumented)
|
|
257
|
-
readonly version: string;
|
|
258
|
-
}
|
|
259
|
-
|
|
260
|
-
// @public (undocumented)
|
|
261
|
-
export interface UserDetailsProperty {
|
|
262
|
-
// (undocumented)
|
|
263
|
-
readonly [key: string]: any;
|
|
264
|
-
// (undocumented)
|
|
265
|
-
readonly daysToPasswordExpiry: number;
|
|
266
|
-
// (undocumented)
|
|
267
|
-
readonly failedLoginAttempts: number;
|
|
268
|
-
// (undocumented)
|
|
269
|
-
readonly heartbeatIntervalSecs: number;
|
|
270
|
-
// (undocumented)
|
|
271
|
-
readonly lastLoginDatetime: number;
|
|
272
|
-
// (undocumented)
|
|
273
|
-
readonly product: UserDetailsProductProperty[];
|
|
274
|
-
// (undocumented)
|
|
275
|
-
readonly rejectedLoginAttempts: number;
|
|
276
|
-
// (undocumented)
|
|
277
|
-
readonly system: UserDetailsSystemProperty;
|
|
278
|
-
}
|
|
279
|
-
|
|
280
|
-
// @public (undocumented)
|
|
281
|
-
export interface UserDetailsSystemProperty {
|
|
282
|
-
// (undocumented)
|
|
283
|
-
readonly [key: string]: any;
|
|
284
|
-
// (undocumented)
|
|
285
|
-
readonly date: string;
|
|
286
|
-
}
|
|
287
|
-
|
|
288
|
-
// @public (undocumented)
|
|
289
|
-
export interface UserKVsProperty {
|
|
290
|
-
// (undocumented)
|
|
291
|
-
readonly [key: string]: any;
|
|
292
|
-
}
|
|
293
|
-
|
|
294
|
-
// @public
|
|
295
|
-
export interface UserPathHistory {
|
|
296
|
-
clearPaths(): void;
|
|
297
|
-
lastPath(): string | undefined;
|
|
298
|
-
readonly pathHistory: string[];
|
|
299
|
-
trackPath(): string;
|
|
300
|
-
}
|
|
301
|
-
|
|
302
|
-
// @public (undocumented)
|
|
303
|
-
export interface UserQueueProperties {
|
|
304
|
-
// (undocumented)
|
|
305
|
-
readonly updateQueue: string;
|
|
306
|
-
// (undocumented)
|
|
307
|
-
readonly zeroMqProxyInboundPort: number;
|
|
308
|
-
// (undocumented)
|
|
309
|
-
readonly zeroMqProxyModeEnabled: boolean;
|
|
310
|
-
// (undocumented)
|
|
311
|
-
readonly zeroMqProxyOutboundPort: number;
|
|
312
|
-
}
|
|
313
|
-
|
|
314
|
-
// (No @packageDocumentation comment for this package)
|
|
315
|
-
|
|
316
|
-
```
|