@genesislcap/foundation-auth 14.302.1-alpha-475e82d.0 → 14.303.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.
Files changed (2) hide show
  1. package/package.json +19 -19
  2. package/docs/api-report.md +0 -1371
@@ -1,1371 +0,0 @@
1
- ## API Report File for "@genesislcap/foundation-auth"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- /// <reference types="webappsec-credential-management" />
8
-
9
- import { AbstractMachine } from '@genesislcap/foundation-state-machine';
10
- import { AbstractStore } from '@genesislcap/foundation-store';
11
- import { AbstractStoreRoot } from '@genesislcap/foundation-store';
12
- import { ActionArgs } from 'xstate';
13
- import { AnyActorContext } from 'xstate';
14
- import { AnyState } from 'xstate';
15
- import { Assigner } from 'xstate';
16
- import { BindingObserver } from '@microsoft/fast-element';
17
- import { ComposableStyles } from '@microsoft/fast-element';
18
- import { Constructable } from '@microsoft/fast-element';
19
- import { Container } from '@microsoft/fast-foundation';
20
- import { Controller } from '@microsoft/fast-element';
21
- import { DefaultUser } from '@genesislcap/foundation-user';
22
- import { defaultUserConfig } from '@genesislcap/foundation-user';
23
- import { DoneInvokeEvent } from 'xstate';
24
- import { ElementStyles } from '@microsoft/fast-element';
25
- import { EmitOptions } from '@genesislcap/foundation-events';
26
- import { EmitReturn } from '@genesislcap/foundation-events';
27
- import type { ErrorEvent as ErrorEvent_2 } from 'xstate';
28
- import { EventObject } from 'xstate';
29
- import { FetchMachine } from '@genesislcap/foundation-state-machine';
30
- import { FetchMachineEvent } from '@genesislcap/foundation-state-machine';
31
- import { getUser } from '@genesislcap/foundation-user';
32
- import { I18nextConfig } from '@genesislcap/foundation-i18n';
33
- import { InterfaceSymbol } from '@microsoft/fast-foundation';
34
- import type { InterpreterOptions } from 'xstate';
35
- import { Logger } from '@genesislcap/foundation-logger';
36
- import { Machine } from '@genesislcap/foundation-state-machine';
37
- import type { MachineContext } from '@genesislcap/foundation-state-machine';
38
- import { MachineContext as MachineContext_2 } from 'xstate';
39
- import { ParameterizedObject } from 'xstate';
40
- import { PartialFASTElementDefinition } from '@microsoft/fast-element';
41
- import { PropertyAssigner } from 'xstate';
42
- import { RouterConfiguration } from '@microsoft/fast-router';
43
- import type { SetUserProperties } from '@genesislcap/foundation-user';
44
- import { Store } from '@genesislcap/foundation-store';
45
- import { StoreRoot } from '@genesislcap/foundation-store';
46
- import { StoreRootEventDetailMap } from '@genesislcap/foundation-store';
47
- import { SyntheticViewTemplate } from '@microsoft/fast-element';
48
- import { TemplateElementDependency } from '@genesislcap/foundation-ui';
49
- import { User } from '@genesislcap/foundation-user';
50
- import { UserActionHistory } from '@genesislcap/foundation-user';
51
- import { UserAuthenticationChangeEvent } from '@genesislcap/foundation-user';
52
- import { UserAuthenticationChangeType } from '@genesislcap/foundation-user';
53
- import { UserConfig } from '@genesislcap/foundation-user';
54
- import type { UserDetailsProductProperty } from '@genesislcap/foundation-user';
55
- import type { UserDetailsProperty } from '@genesislcap/foundation-user';
56
- import type { UserDetailsSystemProperty } from '@genesislcap/foundation-user';
57
- import { UserPathHistory } from '@genesislcap/foundation-user';
58
- import { UUID } from '@genesislcap/foundation-utils';
59
- import { ViewTemplate } from '@microsoft/fast-element';
60
-
61
- // Warning: (ae-internal-missing-underscore) The name "ACK" should be prefixed with an underscore because the declaration is marked as @internal
62
- //
63
- // @internal (undocumented)
64
- export interface ACK extends MESSAGE {
65
- }
66
-
67
- // Warning: (ae-internal-missing-underscore) The name "Ack" should be prefixed with an underscore because the declaration is marked as @internal
68
- //
69
- // @internal (undocumented)
70
- export interface Ack extends Message {
71
- }
72
-
73
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "AuthConfig" because one of its declarations is marked as @internal
74
- //
75
- // @public
76
- export interface AuthConfig extends PartialFASTElementDefinition {
77
- background: ComposableStyles | ComposableStyles[] | null;
78
- backgroundVideo: {
79
- src: string;
80
- type: 'video/ogg' | 'video/mp4' | 'video/webm';
81
- } | null;
82
- feedbackDelay?: number;
83
- fields: FieldConfigMap;
84
- hostPath: string;
85
- localizationResources?: I18nextConfig['resources'];
86
- logo: ComposableStyles | ComposableStyles[] | null;
87
- logoAltText: string;
88
- omitRedirectUrls: string[];
89
- omitRoutes: Exclude<AuthRoutes, 'login' | 'not-found'>[];
90
- // (undocumented)
91
- postLoginRedirect: () => void;
92
- // (undocumented)
93
- postLogoutRedirect: () => void;
94
- showEnvironmentIndicator?: boolean;
95
- sso: SSOConfig | null;
96
- // Warning: (ae-forgotten-export) The symbol "TemplateOptions" needs to be exported by the entry point index.d.ts
97
- templateOptions: TemplateOptions;
98
- versionInformation?: string;
99
- }
100
-
101
- // @internal
102
- export const AuthConfig: InterfaceSymbol<AuthConfig>;
103
-
104
- // @public (undocumented)
105
- export type AuthDTO = LoginDTO | LogoutDTO | PasswordManagementDTO;
106
-
107
- // @public (undocumented)
108
- export type AuthEntity = LoginEntity | LogoutEntity | PasswordManagementEntity;
109
-
110
- // @public (undocumented)
111
- export type AuthEventMap = StoreRootEventDetailMap & AuthMachineEventMap & {
112
- 'auth-store-connected': HTMLElement;
113
- 'auth-store-disconnected': void;
114
- 'auth-store-ready': boolean;
115
- 'auth-login': LoginParams;
116
- 'auth-logout': void;
117
- 'auth-change-password': ChangePasswordParams;
118
- 'auth-forgot-password': ForgotPasswordParams;
119
- 'auth-reset-password': ResetPasswordParams;
120
- };
121
-
122
- // @public (undocumented)
123
- export type AuthFormEntryEventMap = {
124
- 'auth-autofill-form': void;
125
- 'auth-organisation-changed': string;
126
- 'auth-username-changed': string;
127
- 'auth-email-changed': string;
128
- 'auth-password-changed': string;
129
- 'auth-password2-changed': string;
130
- 'auth-showPassword-changed': boolean;
131
- 'auth-selectedIdp-changed': string;
132
- 'auth-ssoToggled-changed': boolean;
133
- };
134
-
135
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "AuthFormEntryStore" because one of its declarations is marked as @internal
136
- //
137
- // @public
138
- export interface AuthFormEntryStore extends Store {
139
- // (undocumented)
140
- readonly autofilling: boolean;
141
- // (undocumented)
142
- readonly email: string;
143
- // (undocumented)
144
- readonly hasPasswordExpired: boolean;
145
- // (undocumented)
146
- readonly idps: IdentityProvider[];
147
- // (undocumented)
148
- readonly mfaCode: string;
149
- // (undocumented)
150
- onAutofillForm(event: CustomEvent<void>): void;
151
- // (undocumented)
152
- onEmailChanged(event: CustomEvent<string>): void;
153
- // (undocumented)
154
- onOrganisationChanged(event: CustomEvent<string>): void;
155
- // (undocumented)
156
- onPassword2Changed(event: CustomEvent<string>): void;
157
- // (undocumented)
158
- onPasswordChanged(event: CustomEvent<string>): void;
159
- // (undocumented)
160
- onSelectedIdpChanged(event: CustomEvent<string>): void;
161
- // (undocumented)
162
- onShowPasswordChanged(event: CustomEvent<boolean>): void;
163
- // (undocumented)
164
- onSSOToggleChanged(event: CustomEvent<boolean>): void;
165
- // (undocumented)
166
- onUsernameChanged(event: CustomEvent<string>): void;
167
- // (undocumented)
168
- readonly organisation: string;
169
- // (undocumented)
170
- readonly orgUsername: string;
171
- // (undocumented)
172
- readonly password: string;
173
- // (undocumented)
174
- readonly password2: string;
175
- // (undocumented)
176
- readonly passwordResetToken: string;
177
- // (undocumented)
178
- readonly selectedIdp: IdentityProvider;
179
- // (undocumented)
180
- readonly showPassword: boolean;
181
- // (undocumented)
182
- readonly ssoLoginUrl: string;
183
- // (undocumented)
184
- readonly ssoToggled: boolean;
185
- // (undocumented)
186
- readonly termsAgreed: boolean;
187
- // (undocumented)
188
- readonly username: string;
189
- }
190
-
191
- // @internal
192
- export const AuthFormEntryStore: InterfaceSymbol<AuthFormEntryStore>;
193
-
194
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "AuthMachine" because one of its declarations is marked as @internal
195
- //
196
- // @public
197
- export interface AuthMachine extends Machine<AuthMachineContext, AuthMachineEvent> {
198
- }
199
-
200
- // @internal
201
- export const AuthMachine: InterfaceSymbol<AuthMachine>;
202
-
203
- // @public
204
- export interface AuthMachineContext extends MachineContext {
205
- dto: AuthDTO;
206
- entity: AuthEntity;
207
- params?: AuthMachineEventParams;
208
- user: User;
209
- }
210
-
211
- // @public
212
- export type AuthMachineEvent = {
213
- type: 'login';
214
- params: LoginParams;
215
- } | {
216
- type: 'logout';
217
- } | {
218
- type: 'change-password';
219
- params: ChangePasswordParams;
220
- } | {
221
- type: 'forgot-password';
222
- params: ForgotPasswordParams;
223
- } | {
224
- type: 'reset-password';
225
- params: ResetPasswordParams;
226
- } | DoneInvokeEvent<unknown> | ErrorEvent_2<unknown>;
227
-
228
- // @public
229
- export type AuthMachineEventMap = {
230
- 'auth-machine-event': AuthMachineEvent;
231
- };
232
-
233
- // @public
234
- export type AuthMachineEventParams = LoginParams | ForgotPasswordParams | ChangePasswordParams | ResetPasswordParams | QueryParams;
235
-
236
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "AuthMessageMapper" because one of its declarations is marked as @internal
237
- //
238
- // @public
239
- export interface AuthMessageMapper extends MessageMapper<AuthMessageMapperLookup> {
240
- }
241
-
242
- // @internal
243
- export const AuthMessageMapper: InterfaceSymbol<AuthMessageMapper>;
244
-
245
- // @public (undocumented)
246
- export type AuthMessageMapperLookup = {
247
- [MESSAGE_TYPE.LOGIN]: LoginMapper;
248
- [MESSAGE_TYPE.LOGIN_ACK]: LoginMapper;
249
- [MESSAGE_TYPE.LOGIN_NACK]: LoginMapper;
250
- [MESSAGE_TYPE.LOGIN_DETAILS_ACK]: LoginMapper;
251
- [MESSAGE_TYPE.LOGIN_DETAILS_NACK]: LoginMapper;
252
- [MESSAGE_TYPE.LOGOUT_ACK]: LogoutMapper;
253
- [MESSAGE_TYPE.LOGOUT_NACK]: LogoutMapper;
254
- [MESSAGE_TYPE.FORGOT_PASSWORD]: PasswordManagementMapper;
255
- [MESSAGE_TYPE.CHANGE_PASSWORD]: PasswordManagementMapper;
256
- [MESSAGE_TYPE.RESET_PASSWORD]: PasswordManagementMapper;
257
- [MESSAGE_TYPE.EVENT_NACK]: LogoutMapper;
258
- [MESSAGE_TYPE.MSG_NACK]: LogoutMapper;
259
- };
260
-
261
- // Warning: (ae-internal-missing-underscore) The name "AuthRouterConfig" should be prefixed with an underscore because the declaration is marked as @internal
262
- //
263
- // @internal
264
- export class AuthRouterConfig extends RouterConfiguration<Settings> {
265
- // Warning: (ae-forgotten-export) The symbol "AuthRouting" needs to be exported by the entry point index.d.ts
266
- constructor(user: User, container: Container, authConfig: AuthConfig, authRouting: AuthRouting);
267
- // (undocumented)
268
- configure(): void;
269
- // (undocumented)
270
- construct<T>(Type: Constructable<T>): T;
271
- }
272
-
273
- // @public (undocumented)
274
- export const AuthRoutes: {
275
- readonly login: "login";
276
- readonly logout: "logout";
277
- readonly 'request-account': "request-account";
278
- readonly 'reset-password': "reset-password";
279
- readonly 'forgot-password': "forgot-password";
280
- readonly verify: "verify";
281
- readonly protected: "protected";
282
- readonly 'not-found': "not-found";
283
- };
284
-
285
- // @public (undocumented)
286
- export type AuthRoutes = (typeof AuthRoutes)[keyof typeof AuthRoutes];
287
-
288
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "AuthStore" because one of its declarations is marked as @internal
289
- //
290
- // @public
291
- export interface AuthStore extends StoreRoot {
292
- readonly authMachine: AuthMachine;
293
- // (undocumented)
294
- readonly errorMessages: string[];
295
- // (undocumented)
296
- readonly formEntry: AuthFormEntryStore;
297
- // (undocumented)
298
- readonly isPending: boolean;
299
- // (undocumented)
300
- readonly metaMessages: string[];
301
- // (undocumented)
302
- onChangePassword(event: CustomEvent<ChangePasswordParams>): void;
303
- // (undocumented)
304
- onForgotPassword(event: CustomEvent<ForgotPasswordParams>): void;
305
- // (undocumented)
306
- onLogin(event: CustomEvent<LoginParams>): void;
307
- // (undocumented)
308
- onLogout(event: CustomEvent<void>): void;
309
- // (undocumented)
310
- onMachineEvent(event: CustomEvent<AuthEventMap['auth-machine-event']>): void;
311
- // (undocumented)
312
- onResetPassword(event: CustomEvent<ResetPasswordParams>): void;
313
- }
314
-
315
- // @internal
316
- export const AuthStore: InterfaceSymbol<AuthStore>;
317
-
318
- // @public (undocumented)
319
- export type BasicCredentials = {
320
- type: CredentialType_2 & CredentialType_2.BASIC;
321
- username: string;
322
- password: string;
323
- };
324
-
325
- // @public (undocumented)
326
- export type ChangePasswordParams = {
327
- username: string;
328
- oldPassword: string;
329
- newPassword: string;
330
- requester?: string;
331
- };
332
-
333
- // @public
334
- export function configure(config: Partial<AuthConfig>): Promise<FoundationAuth>;
335
-
336
- // @public
337
- export function createHTTPHeadersFromDTO(dto: {
338
- SOURCE_REF?: string;
339
- USER_NAME?: string;
340
- }, contentType?: string): HeadersInit;
341
-
342
- // @public
343
- export const createMessageMapper: <TLookup extends MessageMapperLookup, K extends keyof TLookup = keyof TLookup>() => MessageMapper<TLookup, K>;
344
-
345
- // @public
346
- type CredentialData_2 = PasswordCredentialData & {
347
- password?: string;
348
- };
349
- export { CredentialData_2 as CredentialData }
350
-
351
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "CredentialManager" because one of its declarations is marked as @internal
352
- //
353
- // @public
354
- export interface CredentialManager {
355
- getCredentials(options?: GetCredentialOptions): Promise<CredentialData_2 | undefined>;
356
- getCredentialsFromContainer(options?: GetCredentialOptions): Promise<CredentialData_2 | null>;
357
- getCredentialsFromCookie(): CredentialData_2 | undefined;
358
- normaliseLegacyCredentialData(data?: CredentialData_2, cookie?: CredentialData_2): [CredentialData_2 | undefined, boolean];
359
- preventSilentAccess(): Promise<void>;
360
- removeCookie(): void;
361
- storeCredentials(data: CredentialData_2): Promise<boolean>;
362
- storeCredentialsInContainer(data: CredentialData_2): Promise<Credential | undefined>;
363
- storeCredentialsInCookie(data: CredentialData_2): boolean;
364
- validateBasicCredentials(credentials: BasicCredentials): boolean;
365
- validateMFACredentials(credentials: MFACredentials): boolean;
366
- validateRefreshCredentials(credentials: RefreshCredentials): boolean;
367
- validateSSOCredentials(credentials: SSOCredentials): boolean;
368
- validateUserCredentialData(data: CredentialData_2, ensurePassword?: boolean): boolean;
369
- }
370
-
371
- // @internal
372
- export const CredentialManager: InterfaceSymbol<CredentialManager>;
373
-
374
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "CredentialManagerConfig" because one of its declarations is marked as @internal
375
- //
376
- // @public
377
- export interface CredentialManagerConfig {
378
- // (undocumented)
379
- cookie: CredentialManagerCookieConfig;
380
- }
381
-
382
- // @internal
383
- export const CredentialManagerConfig: InterfaceSymbol<CredentialManagerConfig>;
384
-
385
- // @public
386
- export interface CredentialManagerCookieConfig {
387
- // (undocumented)
388
- expires: number | Date;
389
- // (undocumented)
390
- name: string;
391
- // (undocumented)
392
- path: string;
393
- // (undocumented)
394
- storePasswords?: boolean;
395
- }
396
-
397
- // @public
398
- export type Credentials = BasicCredentials | SSOCredentials | JWTCredentials | RefreshCredentials | MFACredentials;
399
-
400
- // @public
401
- export const credentialSeparator = ":";
402
-
403
- // @public
404
- enum CredentialType_2 {
405
- // (undocumented)
406
- BASIC = "BASIC",
407
- // (undocumented)
408
- JWT = "JWT",
409
- // (undocumented)
410
- MFA = "MFA",
411
- // (undocumented)
412
- REFRESH = "REFRESH",
413
- // (undocumented)
414
- SSO = "SSO"
415
- }
416
- export { CredentialType_2 as CredentialType }
417
-
418
- // @public
419
- export const defaultAuthConfig: AuthConfig;
420
-
421
- // Warning: (ae-forgotten-export) The symbol "InternalEventMap" needs to be exported by the entry point index.d.ts
422
- //
423
- // @public
424
- export class DefaultAuthFormEntryStore extends AbstractStore<AuthFormEntryStore, AuthFormEntryEventMap, InternalEventMap> implements AuthFormEntryStore {
425
- constructor();
426
- // @internal (undocumented)
427
- protected autofill(): Promise<boolean>;
428
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
429
- //
430
- // (undocumented)
431
- autofilling: boolean;
432
- // (undocumented)
433
- protected config: AuthConfig;
434
- // (undocumented)
435
- protected credentialManager: CredentialManager;
436
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
437
- //
438
- // (undocumented)
439
- email: string;
440
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
441
- //
442
- // (undocumented)
443
- hasPasswordExpired: boolean;
444
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
445
- //
446
- // (undocumented)
447
- idps: IdentityProvider[];
448
- // Warning: (ae-forgotten-export) The symbol "IDPService" needs to be exported by the entry point index.d.ts
449
- //
450
- // (undocumented)
451
- readonly idpService: IDPService;
452
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
453
- //
454
- // (undocumented)
455
- mfaCode: string;
456
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
457
- //
458
- // (undocumented)
459
- onAutofillForm: EventListener;
460
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
461
- //
462
- // (undocumented)
463
- onEmailChanged: EventListener;
464
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
465
- //
466
- // (undocumented)
467
- onOrganisationChanged: EventListener;
468
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
469
- //
470
- // (undocumented)
471
- onPassword2Changed: EventListener;
472
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
473
- //
474
- // (undocumented)
475
- onPasswordChanged: EventListener;
476
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
477
- //
478
- // (undocumented)
479
- onSelectedIdpChanged: EventListener;
480
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
481
- //
482
- // (undocumented)
483
- onShowPasswordChanged: EventListener;
484
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
485
- //
486
- // (undocumented)
487
- onSSOToggleChanged: EventListener;
488
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
489
- //
490
- // (undocumented)
491
- onUsernameChanged: EventListener;
492
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
493
- //
494
- // (undocumented)
495
- organisation: string;
496
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
497
- //
498
- // (undocumented)
499
- get orgUsername(): string;
500
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
501
- //
502
- // (undocumented)
503
- password: string;
504
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
505
- //
506
- // (undocumented)
507
- password2: string;
508
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
509
- //
510
- // (undocumented)
511
- passwordResetToken: string;
512
- // @internal (undocumented)
513
- protected resetIDPState(): void;
514
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
515
- //
516
- // (undocumented)
517
- selectedIdp: IdentityProvider;
518
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
519
- //
520
- // (undocumented)
521
- showPassword: boolean;
522
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
523
- //
524
- // (undocumented)
525
- get ssoLoginUrl(): string;
526
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
527
- //
528
- // (undocumented)
529
- ssoToggled: boolean;
530
- // @internal (undocumented)
531
- protected ssoToggledChanged: (prev: boolean, next: boolean) => Promise<void>;
532
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
533
- //
534
- // (undocumented)
535
- termsAgreed: boolean;
536
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthFormEntryStore" has more than one declaration; you need to add a TSDoc member reference selector
537
- //
538
- // (undocumented)
539
- username: string;
540
- }
541
-
542
- // @public
543
- export class DefaultAuthMachine extends AbstractMachine<AuthMachineContext, AuthMachineEvent> implements AuthMachine {
544
- constructor(user: User, fetchMachine: FetchMachine, cm: CredentialManager, uuid: UUID, messageMapper: AuthMessageMapper, config: AuthConfig, routing: AuthRouting);
545
- // (undocumented)
546
- protected captureAuthQueryParams(): QueryParams;
547
- // (undocumented)
548
- protected convertQueryParamsToLoginParams(params: QueryParams): LoginParams;
549
- // (undocumented)
550
- protected createFetchMachineEvent(url: string, msg?: {}): FetchMachineEvent;
551
- // (undocumented)
552
- protected dtoTransition: () => {
553
- actions: string[];
554
- target: string;
555
- };
556
- getFromContainer(): this;
557
- // (undocumented)
558
- protected onIdleEvents: () => {
559
- login: {
560
- actions: string[];
561
- target: string;
562
- };
563
- "forgot-password": {
564
- actions: string[];
565
- target: string;
566
- };
567
- "change-password": {
568
- actions: string[];
569
- target: string;
570
- };
571
- "reset-password": {
572
- actions: string[];
573
- target: string;
574
- };
575
- };
576
- // (undocumented)
577
- start(options?: InterpreterOptions<typeof DefaultAuthMachine.machine>): void;
578
- }
579
-
580
- // @public
581
- export const defaultAuthMachineContext: Partial<AuthMachineContext>;
582
-
583
- // @public
584
- export class DefaultAuthMessageMapper extends DefaultMessageMapper<AuthMessageMapperLookup> implements AuthMessageMapper {
585
- constructor(loginMapper: LoginMapper, logoutMapper: LogoutMapper, passwordMapper: PasswordManagementMapper);
586
- // (undocumented)
587
- protected loginMapper: LoginMapper;
588
- // (undocumented)
589
- protected logoutMapper: LogoutMapper;
590
- // (undocumented)
591
- protected passwordMapper: PasswordManagementMapper;
592
- }
593
-
594
- // Warning: (ae-forgotten-export) The symbol "InternalAuthEventMap" needs to be exported by the entry point index.d.ts
595
- //
596
- // @public
597
- export class DefaultAuthStore extends AbstractStoreRoot<AuthStore, AuthEventMap, InternalAuthEventMap> implements AuthStore {
598
- constructor(config: AuthConfig, authMachine: AuthMachine, formEntry: AuthFormEntryStore);
599
- // (undocumented)
600
- readonly authMachine: AuthMachine;
601
- // (undocumented)
602
- readonly config: AuthConfig;
603
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthStore" has more than one declaration; you need to add a TSDoc member reference selector
604
- //
605
- // (undocumented)
606
- get errorMessages(): string[];
607
- // (undocumented)
608
- readonly formEntry: AuthFormEntryStore;
609
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthStore" has more than one declaration; you need to add a TSDoc member reference selector
610
- //
611
- // (undocumented)
612
- get isPending(): boolean;
613
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthStore" has more than one declaration; you need to add a TSDoc member reference selector
614
- //
615
- // (undocumented)
616
- get metaMessages(): string[];
617
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthStore" has more than one declaration; you need to add a TSDoc member reference selector
618
- //
619
- // (undocumented)
620
- onChangePassword: EventListener;
621
- // (undocumented)
622
- onConnected: EventListener;
623
- // (undocumented)
624
- onDisconnected: EventListener;
625
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthStore" has more than one declaration; you need to add a TSDoc member reference selector
626
- //
627
- // (undocumented)
628
- onForgotPassword: EventListener;
629
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthStore" has more than one declaration; you need to add a TSDoc member reference selector
630
- //
631
- // (undocumented)
632
- onLogin: EventListener;
633
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthStore" has more than one declaration; you need to add a TSDoc member reference selector
634
- //
635
- // (undocumented)
636
- onLogout: EventListener;
637
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthStore" has more than one declaration; you need to add a TSDoc member reference selector
638
- //
639
- // (undocumented)
640
- onMachineEvent: EventListener;
641
- // (undocumented)
642
- onReady: EventListener;
643
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "AuthStore" has more than one declaration; you need to add a TSDoc member reference selector
644
- //
645
- // (undocumented)
646
- onResetPassword: EventListener;
647
- }
648
-
649
- // @public
650
- export class DefaultCredentialManager implements CredentialManager {
651
- constructor(config?: CredentialManagerConfig);
652
- // (undocumented)
653
- getCredentials(options?: GetCredentialOptions): Promise<CredentialData_2 | undefined>;
654
- // (undocumented)
655
- getCredentialsFromContainer(options?: CredentialRequestOptions): Promise<CredentialData_2 | null>;
656
- // (undocumented)
657
- getCredentialsFromCookie(): CredentialData_2 | undefined;
658
- // (undocumented)
659
- normaliseLegacyCredentialData(data?: CredentialData_2, cookie?: CredentialData_2): [CredentialData_2 | undefined, boolean];
660
- // (undocumented)
661
- preventSilentAccess(): Promise<void>;
662
- // (undocumented)
663
- removeCookie(): void;
664
- // (undocumented)
665
- storeCredentials(data: CredentialData_2): Promise<boolean>;
666
- // (undocumented)
667
- storeCredentialsInContainer(data: CredentialData_2): Promise<Credential | undefined>;
668
- // (undocumented)
669
- storeCredentialsInCookie(data: CredentialData_2): boolean;
670
- // (undocumented)
671
- validateBasicCredentials(credentials: BasicCredentials): boolean;
672
- // (undocumented)
673
- validateMFACredentials(credentials: MFACredentials): boolean;
674
- // (undocumented)
675
- validateRefreshCredentials(credentials: RefreshCredentials): boolean;
676
- // (undocumented)
677
- validateSSOCredentials(credentials: SSOCredentials): boolean;
678
- // (undocumented)
679
- validateUserCredentialData(data: CredentialData_2, ensurePassword?: boolean): boolean;
680
- }
681
-
682
- // @public
683
- export const defaultCredentialManagerConfig: CredentialManagerConfig;
684
-
685
- // @public
686
- export const defaultCredentialRequestOptions: GetCredentialOptions;
687
-
688
- // @public
689
- export class DefaultLoginMapper implements LoginMapper {
690
- // Warning: (ae-forgotten-export) The symbol "Product_2" needs to be exported by the entry point index.d.ts
691
- //
692
- // (undocumented)
693
- protected fromProductDTO: (products: Product_2[]) => Product[];
694
- // Warning: (ae-forgotten-export) The symbol "System_2" needs to be exported by the entry point index.d.ts
695
- //
696
- // (undocumented)
697
- protected fromSystemDTO: (system: System_2) => System;
698
- toDTO: (entity: LoginEntity) => LoginDTO;
699
- toEntity: (dto: LoginDTO) => LoginEntity;
700
- // (undocumented)
701
- protected uuid: UUID;
702
- }
703
-
704
- // @public
705
- export class DefaultLogoutMapper implements LogoutMapper {
706
- toEntity: (dto: LogoutDTO) => LogoutEntity;
707
- }
708
-
709
- // @public (undocumented)
710
- export class DefaultMessageMapper<TLookup extends MessageMapperLookup, K extends keyof TLookup = keyof TLookup> implements MessageMapper<TLookup, K> {
711
- clear(): void;
712
- delete(key: K): boolean;
713
- get(key: K): TLookup[K] | undefined;
714
- has(key: K): boolean;
715
- set(key: K, mapper: TLookup[K]): void;
716
- get size(): number;
717
- }
718
-
719
- // @public
720
- export class DefaultPasswordManagementMapper implements PasswordManagementMapper {
721
- toDTO: (entity: PasswordManagementEntity) => PasswordManagementDTO;
722
- // (undocumented)
723
- protected uuid: UUID;
724
- }
725
-
726
- export { DefaultUser }
727
-
728
- export { defaultUserConfig }
729
-
730
- // @public @deprecated (undocumented)
731
- export interface Details extends UserDetailsProperty {
732
- }
733
-
734
- // Warning: (ae-incompatible-release-tags) The symbol "EVENT_CHANGE_USER_PASSWORD" is marked as @public, but its signature references "MESSAGE" which is marked as @internal
735
- //
736
- // @public (undocumented)
737
- export interface EVENT_CHANGE_USER_PASSWORD extends MESSAGE {
738
- // (undocumented)
739
- readonly DETAILS: {
740
- readonly OLD_PASSWORD: string;
741
- readonly NEW_PASSWORD: string;
742
- };
743
- // (undocumented)
744
- readonly USER_NAME: string;
745
- }
746
-
747
- // Warning: (ae-incompatible-release-tags) The symbol "EVENT_LOGIN_AUTH" is marked as @public, but its signature references "MESSAGE" which is marked as @internal
748
- //
749
- // @public (undocumented)
750
- export interface EVENT_LOGIN_AUTH extends MESSAGE {
751
- // (undocumented)
752
- readonly DETAILS: {
753
- readonly USER_NAME: string;
754
- readonly PASSWORD: string;
755
- } | {
756
- readonly USER_NAME: string;
757
- readonly REFRESH_AUTH_TOKEN: string;
758
- } | {
759
- readonly SSO_TOKEN: string;
760
- } | {
761
- readonly JWT: string;
762
- readonly DOMAIN: string;
763
- } | {
764
- readonly MFA_CODE: string;
765
- };
766
- }
767
-
768
- // Warning: (ae-incompatible-release-tags) The symbol "EVENT_LOGIN_AUTH_ACK" is marked as @public, but its signature references "ACK" which is marked as @internal
769
- //
770
- // @public (undocumented)
771
- export interface EVENT_LOGIN_AUTH_ACK extends ACK {
772
- // Warning: (ae-forgotten-export) The symbol "Details_2" needs to be exported by the entry point index.d.ts
773
- //
774
- // (undocumented)
775
- readonly DETAILS: Details_2;
776
- // (undocumented)
777
- readonly PERMISSION: string[];
778
- // (undocumented)
779
- readonly PROFILE: string[];
780
- // (undocumented)
781
- readonly REFRESH_AUTH_TOKEN: string;
782
- readonly SESSION_AUTH_TOKEN: string;
783
- // (undocumented)
784
- readonly SESSION_ID: string;
785
- // (undocumented)
786
- readonly UPDATE_QUEUE: string;
787
- // (undocumented)
788
- readonly USER: {
789
- [key: string]: any;
790
- };
791
- // (undocumented)
792
- readonly USER_NAME: string;
793
- // (undocumented)
794
- readonly ZERO_MQ_PROXY_INBOUND_PORT: number;
795
- // (undocumented)
796
- readonly ZERO_MQ_PROXY_MODE_ENABLED: boolean;
797
- // (undocumented)
798
- readonly ZERO_MQ_PROXY_OUTBOUND_PORT: number;
799
- }
800
-
801
- // Warning: (ae-incompatible-release-tags) The symbol "EVENT_LOGIN_AUTH_NACK" is marked as @public, but its signature references "NACK" which is marked as @internal
802
- //
803
- // @public (undocumented)
804
- export interface EVENT_LOGIN_AUTH_NACK extends NACK {
805
- readonly REFRESH_AUTH_TOKEN: string;
806
- // (undocumented)
807
- readonly REFRESH_TOKEN_EXPIRATION_MINS: number;
808
- }
809
-
810
- // @public (undocumented)
811
- export interface EVENT_LOGIN_DETAILS_ACK extends EVENT_LOGIN_AUTH_ACK {
812
- }
813
-
814
- // Warning: (ae-incompatible-release-tags) The symbol "EVENT_LOGOUT_NACK" is marked as @public, but its signature references "NACK" which is marked as @internal
815
- //
816
- // @public (undocumented)
817
- export interface EVENT_LOGOUT_NACK extends NACK {
818
- }
819
-
820
- // Warning: (ae-incompatible-release-tags) The symbol "EVENT_PASSWORD_RESET_ACTION" is marked as @public, but its signature references "MESSAGE" which is marked as @internal
821
- //
822
- // @public (undocumented)
823
- export interface EVENT_PASSWORD_RESET_ACTION extends MESSAGE {
824
- // (undocumented)
825
- readonly DETAILS: {
826
- readonly USER_NAME: string;
827
- readonly RESET_TOKEN: string;
828
- readonly NEW_PASSWORD: string;
829
- };
830
- // (undocumented)
831
- readonly USER_NAME: string;
832
- }
833
-
834
- // Warning: (ae-incompatible-release-tags) The symbol "EVENT_SELF_SERVICE_PASSWORD_RESET" is marked as @public, but its signature references "MESSAGE" which is marked as @internal
835
- //
836
- // @public (undocumented)
837
- export interface EVENT_SELF_SERVICE_PASSWORD_RESET extends MESSAGE {
838
- // (undocumented)
839
- readonly DETAILS: {
840
- readonly USER_NAME: string;
841
- readonly RETURN_URL: string;
842
- };
843
- // (undocumented)
844
- readonly USER_NAME: string;
845
- }
846
-
847
- // @public
848
- export type FieldConfig = {
849
- label: string;
850
- value?: any;
851
- required?: boolean;
852
- pattern?: string;
853
- title?: string;
854
- };
855
-
856
- // @public (undocumented)
857
- export type FieldConfigMap = {
858
- organisation: FieldConfig | null;
859
- username: FieldConfig;
860
- email: FieldConfig;
861
- password: FieldConfig;
862
- };
863
-
864
- // @public (undocumented)
865
- export type ForgotPasswordParams = {
866
- username: string;
867
- returnUrl: string;
868
- requester?: string;
869
- };
870
-
871
- // Warning: (ae-forgotten-export) The symbol "FoundationAuth_base" needs to be exported by the entry point index.d.ts
872
- //
873
- // @public
874
- export class FoundationAuth extends FoundationAuth_base {
875
- // @internal (undocumented)
876
- protected addBindings(): void;
877
- // @internal (undocumented)
878
- protected addEventListeners(): void;
879
- // @internal (undocumented)
880
- attemptAutofill(): void;
881
- // @internal (undocumented)
882
- get classNames(): string;
883
- // @internal
884
- config: AuthRouterConfig;
885
- // @internal (undocumented)
886
- connectedCallback(): void;
887
- // @internal (undocumented)
888
- container: Container;
889
- // @internal (undocumented)
890
- disconnectedCallback(): void;
891
- // @internal (undocumented)
892
- protected disconnectStore(): void;
893
- // @internal (undocumented)
894
- get isReady(): boolean;
895
- // @internal (undocumented)
896
- protected machineBinding: BindingObserver;
897
- // @internal (undocumented)
898
- protected readyStore(): void;
899
- // @internal (undocumented)
900
- protected registerDIDependencies(): void;
901
- // @internal (undocumented)
902
- protected removeBindings(): void;
903
- // @internal (undocumented)
904
- protected removeEventListeners(): void;
905
- // @internal (undocumented)
906
- store: AuthStore;
907
- }
908
-
909
- // Warning: (ae-incompatible-release-tags) The symbol "fromDTOAck" is marked as @public, but its signature references "ACK" which is marked as @internal
910
- // Warning: (ae-incompatible-release-tags) The symbol "fromDTOAck" is marked as @public, but its signature references "Ack" which is marked as @internal
911
- //
912
- // @public
913
- export const fromDTOAck: (dto: ACK) => Ack;
914
-
915
- // Warning: (ae-incompatible-release-tags) The symbol "fromDTONack" is marked as @public, but its signature references "NACK" which is marked as @internal
916
- // Warning: (ae-incompatible-release-tags) The symbol "fromDTONack" is marked as @public, but its signature references "Nack" which is marked as @internal
917
- //
918
- // @public
919
- export const fromDTONack: (dto: NACK) => Nack;
920
-
921
- // @public (undocumented)
922
- export const fromDTOStringArray: (arr: string[]) => string[];
923
-
924
- // @public
925
- export const fromIDPDTO: (dto: IDENTITY_PROVIDER) => IdentityProvider;
926
-
927
- // @public
928
- export function getAuthMachine(): AuthMachine;
929
-
930
- // @public
931
- export function getAuthStore(): AuthStore;
932
-
933
- // @public
934
- export type GetCredentialOptions = CredentialRequestOptions & {};
935
-
936
- // Warning: (ae-internal-missing-underscore) The name "getNormalisedText" should be prefixed with an underscore because the declaration is marked as @internal
937
- //
938
- // @internal
939
- export const getNormalisedText: (arr: NackErrorWarning[]) => string;
940
-
941
- // @public
942
- export function getRoutePath(route: AuthRoutes | string, hostPath?: string): string;
943
-
944
- export { getUser }
945
-
946
- // Warning: (ae-incompatible-release-tags) The symbol "hasDTOErrorWarningCode" is marked as @public, but its signature references "NACK" which is marked as @internal
947
- //
948
- // @public
949
- export const hasDTOErrorWarningCode: (dto: NACK, code: string) => boolean;
950
-
951
- // @public (undocumented)
952
- export interface IDENTITY_PROVIDER {
953
- // (undocumented)
954
- readonly DESCRIPTION: string;
955
- // (undocumented)
956
- readonly ID: string;
957
- // (undocumented)
958
- readonly TYPE: string;
959
- }
960
-
961
- // @public (undocumented)
962
- export interface IdentityProvider {
963
- // (undocumented)
964
- readonly description: string;
965
- // (undocumented)
966
- readonly id: string;
967
- // (undocumented)
968
- readonly type: string;
969
- }
970
-
971
- // @public
972
- export const is200Nack: <TOutput = any>(event: EventObject | DoneInvokeEvent<TOutput>) => event is DoneInvokeEvent<TOutput>;
973
-
974
- // @public
975
- export function isChangePasswordParams(params: AuthMachineEventParams): params is ChangePasswordParams;
976
-
977
- // @public
978
- export function isForgotPasswordParams(params: AuthMachineEventParams): params is ForgotPasswordParams;
979
-
980
- // @public
981
- export function isLoginAckDTO(dto: LoginDTO): dto is EVENT_LOGIN_AUTH_ACK;
982
-
983
- // @public
984
- export function isLoginAckEntity(entity: LoginEntity): entity is LoginAck;
985
-
986
- // @public
987
- export function isLoginDetailsAckDTO(dto: LoginDTO): dto is EVENT_LOGIN_DETAILS_ACK;
988
-
989
- // @public
990
- export function isLoginDetailsAckEntity(entity: LoginEntity): entity is LoginDetailsAck;
991
-
992
- // @public
993
- export function isLoginNackDTO(dto: LoginDTO): dto is EVENT_LOGIN_AUTH_NACK;
994
-
995
- // @public
996
- export function isLoginNackEntity(entity: LoginEntity): entity is LoginNack;
997
-
998
- // @public
999
- export function isLoginParams(params: AuthMachineEventParams): params is LoginParams;
1000
-
1001
- // @public
1002
- export function isLogoutAckDTO(dto: LogoutDTO): dto is LOGOUT_ACK;
1003
-
1004
- // @public
1005
- export function isLogoutAckEntity(entity: LogoutEntity): entity is LogoutAck;
1006
-
1007
- // @public
1008
- export function isLogoutNackDTO(dto: LogoutDTO): dto is EVENT_LOGOUT_NACK;
1009
-
1010
- // @public
1011
- export function isLogoutNackEntity(entity: LogoutEntity): entity is LogoutNack;
1012
-
1013
- // @public (undocumented)
1014
- export const isMappingError: (error: unknown) => error is MappingError;
1015
-
1016
- // @public
1017
- export function isMFRoute(pathname?: string): boolean;
1018
-
1019
- // Warning: (ae-incompatible-release-tags) The symbol "isNackDTO" is marked as @public, but its signature references "NACK" which is marked as @internal
1020
- //
1021
- // @public
1022
- export function isNackDTO(dto: unknown): dto is NACK;
1023
-
1024
- // Warning: (ae-incompatible-release-tags) The symbol "isNackEntity" is marked as @public, but its signature references "Nack" which is marked as @internal
1025
- //
1026
- // @public
1027
- export function isNackEntity(entity: unknown): entity is Nack;
1028
-
1029
- // @public
1030
- export function isQueryParams(params: AuthMachineEventParams): params is QueryParams;
1031
-
1032
- // @public
1033
- export function isResetPasswordParams(params: AuthMachineEventParams): params is ResetPasswordParams;
1034
-
1035
- // @public (undocumented)
1036
- export type JWTCredentials = {
1037
- type: CredentialType_2 & CredentialType_2.JWT;
1038
- jwt: string;
1039
- domain: string;
1040
- };
1041
-
1042
- // @public (undocumented)
1043
- export const logger: Logger;
1044
-
1045
- // Warning: (ae-incompatible-release-tags) The symbol "LoginAck" is marked as @public, but its signature references "Ack" which is marked as @internal
1046
- //
1047
- // @public (undocumented)
1048
- export interface LoginAck extends SetUserProperties, Ack {
1049
- }
1050
-
1051
- // @public (undocumented)
1052
- export interface LoginDetailsAck extends LoginAck {
1053
- }
1054
-
1055
- // Warning: (ae-incompatible-release-tags) The symbol "LoginDTO" is marked as @public, but its signature references "MESSAGE" which is marked as @internal
1056
- //
1057
- // @public
1058
- export type LoginDTO = EVENT_LOGIN_AUTH | EVENT_LOGIN_AUTH_ACK | EVENT_LOGIN_AUTH_NACK | EVENT_LOGIN_DETAILS_ACK | MESSAGE;
1059
-
1060
- // @public
1061
- export type LoginEntity = Credentials | LoginAck | LoginDetailsAck | LoginNack;
1062
-
1063
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "LoginMapper" because one of its declarations is marked as @internal
1064
- //
1065
- // @public
1066
- export interface LoginMapper extends Mapper<LoginDTO, LoginEntity> {
1067
- }
1068
-
1069
- // @internal
1070
- export const LoginMapper: InterfaceSymbol<LoginMapper>;
1071
-
1072
- // Warning: (ae-incompatible-release-tags) The symbol "LoginNack" is marked as @public, but its signature references "Nack" which is marked as @internal
1073
- //
1074
- // @public (undocumented)
1075
- export interface LoginNack extends Nack {
1076
- // (undocumented)
1077
- readonly hasIncorrectCredentials: boolean;
1078
- // (undocumented)
1079
- readonly hasPasswordExpired: boolean;
1080
- // (undocumented)
1081
- readonly isMFARequired: boolean;
1082
- // (undocumented)
1083
- readonly maxTriesReached: boolean;
1084
- // (undocumented)
1085
- readonly refreshAuthToken: string;
1086
- // (undocumented)
1087
- readonly refreshTokenExpirationMins: number;
1088
- }
1089
-
1090
- // @public (undocumented)
1091
- export type LoginParams = Credentials;
1092
-
1093
- // Warning: (ae-incompatible-release-tags) The symbol "LOGOUT_ACK" is marked as @public, but its signature references "ACK" which is marked as @internal
1094
- //
1095
- // @public (undocumented)
1096
- export interface LOGOUT_ACK extends ACK {
1097
- // (undocumented)
1098
- readonly OIDC_LOGOUT_URL: string;
1099
- }
1100
-
1101
- // Warning: (ae-incompatible-release-tags) The symbol "LogoutAck" is marked as @public, but its signature references "Ack" which is marked as @internal
1102
- //
1103
- // @public (undocumented)
1104
- export interface LogoutAck extends Ack {
1105
- // (undocumented)
1106
- readonly oidcLogoutUrl: string;
1107
- }
1108
-
1109
- // Warning: (ae-incompatible-release-tags) The symbol "LogoutDTO" is marked as @public, but its signature references "MESSAGE" which is marked as @internal
1110
- //
1111
- // @public
1112
- export type LogoutDTO = LOGOUT_ACK | EVENT_LOGOUT_NACK | MESSAGE;
1113
-
1114
- // @public
1115
- export type LogoutEntity = LogoutAck | LogoutNack;
1116
-
1117
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "LogoutMapper" because one of its declarations is marked as @internal
1118
- //
1119
- // @public
1120
- export interface LogoutMapper extends Mapper<LogoutDTO, LogoutEntity> {
1121
- }
1122
-
1123
- // @internal
1124
- export const LogoutMapper: InterfaceSymbol<LogoutMapper>;
1125
-
1126
- // Warning: (ae-incompatible-release-tags) The symbol "LogoutNack" is marked as @public, but its signature references "Nack" which is marked as @internal
1127
- //
1128
- // @public (undocumented)
1129
- export interface LogoutNack extends Nack {
1130
- }
1131
-
1132
- // @public
1133
- export interface Mapper<TDTO, TEntity> {
1134
- toDTO?: (entity: Partial<TEntity>) => TDTO;
1135
- toEntity?: (dto: TDTO) => TEntity;
1136
- }
1137
-
1138
- // @public
1139
- export class MappingError extends Error {
1140
- constructor(data?: unknown, message?: string);
1141
- // (undocumented)
1142
- data?: unknown;
1143
- }
1144
-
1145
- // Warning: (ae-internal-missing-underscore) The name "MESSAGE" should be prefixed with an underscore because the declaration is marked as @internal
1146
- //
1147
- // @internal (undocumented)
1148
- export interface MESSAGE {
1149
- // (undocumented)
1150
- readonly MESSAGE_TYPE: `${MESSAGE_TYPE}`;
1151
- // (undocumented)
1152
- readonly SOURCE_REF: string;
1153
- }
1154
-
1155
- // Warning: (ae-internal-missing-underscore) The name "Message" should be prefixed with an underscore because the declaration is marked as @internal
1156
- //
1157
- // @internal (undocumented)
1158
- export interface Message {
1159
- // (undocumented)
1160
- readonly messageType: `${MESSAGE_TYPE}`;
1161
- // (undocumented)
1162
- readonly sourceRef: string;
1163
- }
1164
-
1165
- // Warning: (ae-internal-missing-underscore) The name "MESSAGE_TYPE" should be prefixed with an underscore because the declaration is marked as @internal
1166
- //
1167
- // @internal (undocumented)
1168
- export enum MESSAGE_TYPE {
1169
- // (undocumented)
1170
- CHANGE_PASSWORD = "EVENT_CHANGE_USER_PASSWORD",
1171
- EVENT_NACK = "EVENT_NACK",
1172
- FORGOT_PASSWORD = "EVENT_SELF_SERVICE_PASSWORD_RESET",
1173
- LOGIN = "EVENT_LOGIN_AUTH",
1174
- // (undocumented)
1175
- LOGIN_ACK = "EVENT_LOGIN_AUTH_ACK",
1176
- // (undocumented)
1177
- LOGIN_DETAILS_ACK = "EVENT_LOGIN_DETAILS_ACK",
1178
- // (undocumented)
1179
- LOGIN_DETAILS_NACK = "EVENT_LOGIN_DETAILS_NACK",
1180
- // (undocumented)
1181
- LOGIN_NACK = "EVENT_LOGIN_AUTH_NACK",
1182
- LOGOUT_ACK = "LOGOUT_ACK",
1183
- // (undocumented)
1184
- LOGOUT_NACK = "EVENT_LOGOUT_NACK",
1185
- // (undocumented)
1186
- MSG_NACK = "MSG_NACK",
1187
- // (undocumented)
1188
- RESET_PASSWORD = "EVENT_PASSWORD_RESET_ACTION"
1189
- }
1190
-
1191
- // @public (undocumented)
1192
- export interface MessageMapper<TLookup extends MessageMapperLookup, K extends keyof TLookup = keyof TLookup> extends Pick<Map<K, TLookup[K]>, 'get' | 'has' | 'delete' | 'clear' | 'size'> {
1193
- set(key: K, mapper: TLookup[K]): void;
1194
- }
1195
-
1196
- // @public (undocumented)
1197
- export type MessageMapperLookup = Record<string, Mapper<unknown, unknown>>;
1198
-
1199
- // @public (undocumented)
1200
- export type MFACredentials = {
1201
- type: CredentialType_2 & CredentialType_2.MFA;
1202
- mfaToken: string;
1203
- };
1204
-
1205
- // Warning: (ae-internal-missing-underscore) The name "NACK" should be prefixed with an underscore because the declaration is marked as @internal
1206
- //
1207
- // @internal (undocumented)
1208
- export interface NACK extends MESSAGE {
1209
- // (undocumented)
1210
- readonly ERROR: NACK_ERROR_WARNING[];
1211
- // (undocumented)
1212
- readonly WARNING: NACK_ERROR_WARNING[];
1213
- }
1214
-
1215
- // Warning: (ae-internal-missing-underscore) The name "Nack" should be prefixed with an underscore because the declaration is marked as @internal
1216
- //
1217
- // @internal (undocumented)
1218
- export interface Nack extends Message {
1219
- // (undocumented)
1220
- readonly error: NackErrorWarning[];
1221
- // (undocumented)
1222
- readonly normalisedErrorStatusCode: number;
1223
- // (undocumented)
1224
- readonly normalisedErrorText: string;
1225
- // (undocumented)
1226
- readonly normalisedWarningStatusCode: number;
1227
- // (undocumented)
1228
- readonly normalisedWarningText: string;
1229
- // (undocumented)
1230
- readonly warning: NackErrorWarning[];
1231
- }
1232
-
1233
- // Warning: (ae-internal-missing-underscore) The name "NACK_ERROR_WARNING" should be prefixed with an underscore because the declaration is marked as @internal
1234
- //
1235
- // @internal (undocumented)
1236
- export interface NACK_ERROR_WARNING {
1237
- // (undocumented)
1238
- readonly '@type': string;
1239
- // (undocumented)
1240
- readonly CODE: string;
1241
- // (undocumented)
1242
- readonly STATUS_CODE: string;
1243
- // (undocumented)
1244
- readonly TEXT: string;
1245
- }
1246
-
1247
- // Warning: (ae-internal-missing-underscore) The name "NackErrorWarning" should be prefixed with an underscore because the declaration is marked as @internal
1248
- //
1249
- // @internal (undocumented)
1250
- export interface NackErrorWarning {
1251
- // (undocumented)
1252
- readonly code: string;
1253
- // (undocumented)
1254
- readonly statusCode: string;
1255
- // (undocumented)
1256
- readonly text: string;
1257
- // (undocumented)
1258
- readonly type: string;
1259
- }
1260
-
1261
- // Warning: (ae-internal-missing-underscore) The name "navigateTo" should be prefixed with an underscore because the declaration is marked as @internal
1262
- //
1263
- // @internal (undocumented)
1264
- export function navigateTo(route: AuthRoutes | string): void;
1265
-
1266
- // @public
1267
- export type PasswordManagementDTO = EVENT_SELF_SERVICE_PASSWORD_RESET | EVENT_CHANGE_USER_PASSWORD | EVENT_PASSWORD_RESET_ACTION;
1268
-
1269
- // @public
1270
- export type PasswordManagementEntity = ForgotPasswordParams | ChangePasswordParams | ResetPasswordParams;
1271
-
1272
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "PasswordManagementMapper" because one of its declarations is marked as @internal
1273
- //
1274
- // @public
1275
- export interface PasswordManagementMapper extends Mapper<PasswordManagementDTO, PasswordManagementEntity> {
1276
- }
1277
-
1278
- // @internal
1279
- export const PasswordManagementMapper: InterfaceSymbol<PasswordManagementMapper>;
1280
-
1281
- // @public @deprecated (undocumented)
1282
- export interface Product extends UserDetailsProductProperty {
1283
- }
1284
-
1285
- // @public (undocumented)
1286
- export type QueryParams = {
1287
- SSO_TOKEN?: string;
1288
- MFA_CODE?: string;
1289
- };
1290
-
1291
- // @public (undocumented)
1292
- export type RefreshCredentials = {
1293
- type: CredentialType_2 & CredentialType_2.REFRESH;
1294
- username: string;
1295
- refreshToken: string;
1296
- };
1297
-
1298
- // @public (undocumented)
1299
- export type ResetPasswordParams = {
1300
- username: string;
1301
- resetToken: string;
1302
- newPassword: string;
1303
- requester?: string;
1304
- };
1305
-
1306
- // @public
1307
- export const setError: {
1308
- (_: ActionArgs<MachineContext_2, EventObject, ParameterizedObject>): void;
1309
- type: string;
1310
- assignment: Assigner<MachineContext_2, EventObject> | PropertyAssigner<MachineContext_2, EventObject>;
1311
- resolve: (actorContext: AnyActorContext, state: AnyState, actionArgs: ActionArgs<any, any, ParameterizedObject>, { assignment }: {
1312
- assignment: Assigner<any, any> | PropertyAssigner<any, any>;
1313
- }) => AnyState[];
1314
- };
1315
-
1316
- // @public
1317
- export type Settings = {
1318
- public?: boolean;
1319
- };
1320
-
1321
- // @public (undocumented)
1322
- export type SSOConfig = {
1323
- toggled?: boolean;
1324
- };
1325
-
1326
- // @public (undocumented)
1327
- export type SSOCredentials = {
1328
- type: CredentialType_2 & CredentialType_2.SSO;
1329
- ssoToken: string;
1330
- };
1331
-
1332
- // @public (undocumented)
1333
- export const styles: ElementStyles;
1334
-
1335
- // @public @deprecated (undocumented)
1336
- export interface System extends UserDetailsSystemProperty {
1337
- }
1338
-
1339
- // @public (undocumented)
1340
- export const template: ViewTemplate<FoundationAuth, any>;
1341
-
1342
- export { User }
1343
-
1344
- export { UserActionHistory }
1345
-
1346
- export { UserAuthenticationChangeEvent }
1347
-
1348
- export { UserAuthenticationChangeType }
1349
-
1350
- export { UserConfig }
1351
-
1352
- export { UserPathHistory }
1353
-
1354
- // Warnings were encountered during analysis:
1355
- //
1356
- // src/mapper/types.ts:50:3 - (ae-incompatible-release-tags) The symbol "EVENT_LOGIN_AUTH" is marked as @public, but its signature references "MESSAGE_TYPE" which is marked as @internal
1357
- // src/mapper/types.ts:51:3 - (ae-incompatible-release-tags) The symbol "EVENT_LOGIN_AUTH_ACK" is marked as @public, but its signature references "MESSAGE_TYPE" which is marked as @internal
1358
- // src/mapper/types.ts:52:3 - (ae-incompatible-release-tags) The symbol "EVENT_LOGIN_AUTH_NACK" is marked as @public, but its signature references "MESSAGE_TYPE" which is marked as @internal
1359
- // src/mapper/types.ts:53:3 - (ae-incompatible-release-tags) The symbol "EVENT_LOGIN_DETAILS_ACK" is marked as @public, but its signature references "MESSAGE_TYPE" which is marked as @internal
1360
- // src/mapper/types.ts:54:3 - (ae-incompatible-release-tags) The symbol "EVENT_LOGIN_DETAILS_NACK" is marked as @public, but its signature references "MESSAGE_TYPE" which is marked as @internal
1361
- // src/mapper/types.ts:58:3 - (ae-incompatible-release-tags) The symbol "LOGOUT_ACK" is marked as @public, but its signature references "MESSAGE_TYPE" which is marked as @internal
1362
- // src/mapper/types.ts:59:3 - (ae-incompatible-release-tags) The symbol "EVENT_LOGOUT_NACK" is marked as @public, but its signature references "MESSAGE_TYPE" which is marked as @internal
1363
- // src/mapper/types.ts:63:3 - (ae-incompatible-release-tags) The symbol "EVENT_SELF_SERVICE_PASSWORD_RESET" is marked as @public, but its signature references "MESSAGE_TYPE" which is marked as @internal
1364
- // src/mapper/types.ts:64:3 - (ae-incompatible-release-tags) The symbol "EVENT_CHANGE_USER_PASSWORD" is marked as @public, but its signature references "MESSAGE_TYPE" which is marked as @internal
1365
- // src/mapper/types.ts:65:3 - (ae-incompatible-release-tags) The symbol "EVENT_PASSWORD_RESET_ACTION" is marked as @public, but its signature references "MESSAGE_TYPE" which is marked as @internal
1366
- // src/mapper/types.ts:70:3 - (ae-incompatible-release-tags) The symbol "EVENT_NACK" is marked as @public, but its signature references "MESSAGE_TYPE" which is marked as @internal
1367
- // src/mapper/types.ts:71:3 - (ae-incompatible-release-tags) The symbol "MSG_NACK" is marked as @public, but its signature references "MESSAGE_TYPE" which is marked as @internal
1368
-
1369
- // (No @packageDocumentation comment for this package)
1370
-
1371
- ```