@genesislcap/foundation-login 14.303.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 +15 -15
  2. package/docs/api-report.md +0 -446
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-login",
3
3
  "description": "Genesis Foundation Login",
4
- "version": "14.303.0",
4
+ "version": "14.303.1",
5
5
  "license": "SEE LICENSE IN license.txt",
6
6
  "main": "dist/esm/index.js",
7
7
  "types": "dist/foundation-login.d.ts",
@@ -67,21 +67,21 @@
67
67
  }
68
68
  },
69
69
  "devDependencies": {
70
- "@genesislcap/foundation-testing": "14.303.0",
71
- "@genesislcap/genx": "14.303.0",
72
- "@genesislcap/rollup-builder": "14.303.0",
73
- "@genesislcap/ts-builder": "14.303.0",
74
- "@genesislcap/uvu-playwright-builder": "14.303.0",
75
- "@genesislcap/vite-builder": "14.303.0",
76
- "@genesislcap/webpack-builder": "14.303.0"
70
+ "@genesislcap/foundation-testing": "14.303.1",
71
+ "@genesislcap/genx": "14.303.1",
72
+ "@genesislcap/rollup-builder": "14.303.1",
73
+ "@genesislcap/ts-builder": "14.303.1",
74
+ "@genesislcap/uvu-playwright-builder": "14.303.1",
75
+ "@genesislcap/vite-builder": "14.303.1",
76
+ "@genesislcap/webpack-builder": "14.303.1"
77
77
  },
78
78
  "dependencies": {
79
- "@genesislcap/foundation-comms": "14.303.0",
80
- "@genesislcap/foundation-i18n": "14.303.0",
81
- "@genesislcap/foundation-logger": "14.303.0",
82
- "@genesislcap/foundation-ui": "14.303.0",
83
- "@genesislcap/foundation-utils": "14.303.0",
84
- "@genesislcap/foundation-zero": "14.303.0",
79
+ "@genesislcap/foundation-comms": "14.303.1",
80
+ "@genesislcap/foundation-i18n": "14.303.1",
81
+ "@genesislcap/foundation-logger": "14.303.1",
82
+ "@genesislcap/foundation-ui": "14.303.1",
83
+ "@genesislcap/foundation-utils": "14.303.1",
84
+ "@genesislcap/foundation-zero": "14.303.1",
85
85
  "@microsoft/fast-components": "2.30.6",
86
86
  "@microsoft/fast-element": "1.14.0",
87
87
  "@microsoft/fast-foundation": "2.49.6",
@@ -98,5 +98,5 @@
98
98
  "access": "public"
99
99
  },
100
100
  "customElements": "dist/custom-elements.json",
101
- "gitHead": "1495670cf431019b7a29589f6ab7b80c0ec31945"
101
+ "gitHead": "f1685d21651cfe332605360143595a9bb603b129"
102
102
  }
@@ -1,446 +0,0 @@
1
- ## API Report File for "@genesislcap/foundation-login"
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 { Auth } from '@genesislcap/foundation-comms';
8
- import { Binding } from '@microsoft/fast-element';
9
- import { Connect } from '@genesislcap/foundation-comms';
10
- import { Container } from '@microsoft/fast-foundation';
11
- import { CredentialManager } from '@genesislcap/foundation-comms';
12
- import { DefineFunction } from '@genesislcap/foundation-ui';
13
- import { ElementStyles } from '@microsoft/fast-element';
14
- import { FASTElement } from '@microsoft/fast-element';
15
- import { FoundationRouterConfiguration } from '@genesislcap/foundation-ui';
16
- import { I18next } from '@genesislcap/foundation-i18n';
17
- import { I18nextConfig } from '@genesislcap/foundation-i18n';
18
- import { InterfaceSymbol } from '@microsoft/fast-foundation';
19
- import { Message } from '@genesislcap/foundation-comms';
20
- import { MessageBuilder } from '@genesislcap/foundation-comms';
21
- import { PartialFASTElementDefinition } from '@microsoft/fast-element';
22
- import { Session } from '@genesislcap/foundation-comms';
23
- import { SyntheticViewTemplate } from '@microsoft/fast-element';
24
- import { TemplateElementDependency } from '@genesislcap/foundation-ui';
25
- import { ViewTemplate } from '@microsoft/fast-element';
26
- import { ZeroButtonAppearance } from '@genesislcap/foundation-zero';
27
-
28
- // Warning: (ae-internal-missing-underscore) The name "backButton" should be prefixed with an underscore because the declaration is marked as @internal
29
- //
30
- // @internal (undocumented)
31
- export const backButton: <T extends ConfigHost>(binding: Binding, label: string) => ViewTemplate<T, any>;
32
-
33
- // Warning: (ae-internal-missing-underscore) The name "BackgroundElement" should be prefixed with an underscore because the declaration is marked as @internal
34
- //
35
- // @internal (undocumented)
36
- export class BackgroundElement extends ConfigHostElement {
37
- // (undocumented)
38
- connectedCallback(): void;
39
- }
40
-
41
- // Warning: (ae-internal-missing-underscore) The name "BaseRoute" should be prefixed with an underscore because the declaration is marked as @internal
42
- //
43
- // @internal (undocumented)
44
- export class BaseRoute extends ConfigHostElement {
45
- // (undocumented)
46
- auth: Auth;
47
- // (undocumented)
48
- autofill(): Promise<boolean>;
49
- // (undocumented)
50
- clearError(): void;
51
- // (undocumented)
52
- connect: Connect;
53
- // (undocumented)
54
- connectedCallback(): void;
55
- // (undocumented)
56
- credentialManager: CredentialManager;
57
- // (undocumented)
58
- email: string;
59
- // (undocumented)
60
- ensureConnection(): Promise<boolean>;
61
- // (undocumented)
62
- hasErrors: boolean;
63
- // (undocumented)
64
- host: string;
65
- // (undocumented)
66
- isSubmitting: boolean;
67
- // (undocumented)
68
- message: string;
69
- // (undocumented)
70
- messageBuilder: MessageBuilder;
71
- // (undocumented)
72
- onBack: () => void;
73
- // (undocumented)
74
- onNavigate: (routeName: Routes, params?: Object, trigger?: boolean) => void;
75
- // (undocumented)
76
- onSubmit(): Promise<void>;
77
- // (undocumented)
78
- organisation: string;
79
- // (undocumented)
80
- get orgUsername(): string;
81
- // (undocumented)
82
- password: string;
83
- // (undocumented)
84
- password2: string;
85
- // (undocumented)
86
- queueOnBack(delay?: number): void;
87
- // (undocumented)
88
- sendMessage<T = any>(message: Message<T>, successFeedback?: string, successCallback?: (result: any) => void, delayBack?: number): Promise<void>;
89
- // (undocumented)
90
- session: Session;
91
- // (undocumented)
92
- setError(message: string): void;
93
- // (undocumented)
94
- showPassword: boolean;
95
- // (undocumented)
96
- storeCredentials(password?: string): void;
97
- // (undocumented)
98
- toLocalisedText(text: string): string;
99
- // (undocumented)
100
- username: string;
101
- }
102
-
103
- // Warning: (ae-internal-missing-underscore) The name "ConfigHost" should be prefixed with an underscore because the declaration is marked as @internal
104
- //
105
- // @internal (undocumented)
106
- export type ConfigHost = {
107
- config: LoginConfig;
108
- };
109
-
110
- // Warning: (ae-internal-missing-underscore) The name "ConfigHostElement" should be prefixed with an underscore because the declaration is marked as @internal
111
- //
112
- // @internal (undocumented)
113
- export class ConfigHostElement extends FASTElement implements ConfigHost {
114
- // (undocumented)
115
- config: LoginConfig;
116
- // (undocumented)
117
- connectedCallback(): void;
118
- // (undocumented)
119
- container: Container;
120
- i18next: I18next;
121
- }
122
-
123
- // Warning: (ae-internal-missing-underscore) The name "configurableTextField" should be prefixed with an underscore because the declaration is marked as @internal
124
- //
125
- // @internal (undocumented)
126
- export const configurableTextField: <T extends ConfigHost>(name: keyof FieldConfigMap | [name: keyof FieldConfigMap, valueKey: string], type: string, autofocus?: boolean, autocomplete?: string, className?: string, labelOverride?: string, testIdOverride?: string, required?: boolean) => ViewTemplate<T, any>;
127
-
128
- // @public @deprecated
129
- export function configure(container: Container, config: Partial<LoginConfig>): void;
130
-
131
- // @public (undocumented)
132
- export const defaultApiHost: string;
133
-
134
- // @public
135
- export const defaultLoginConfig: LoginConfig;
136
-
137
- // @public
138
- export class DefaultLoginRouting implements LoginRouting {
139
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "LoginRouting" has more than one declaration; you need to add a TSDoc member reference selector
140
- //
141
- // (undocumented)
142
- getRoutePath(route: string): string;
143
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "LoginRouting" has more than one declaration; you need to add a TSDoc member reference selector
144
- //
145
- // (undocumented)
146
- navigateTo(route: string): void;
147
- }
148
-
149
- // Warning: (ae-internal-missing-underscore) The name "defaultOnBackMS" should be prefixed with an underscore because the declaration is marked as @internal
150
- //
151
- // @internal (undocumented)
152
- export const defaultOnBackMS = 3000;
153
-
154
- // @public (undocumented)
155
- export const defaultOrganisation: string;
156
-
157
- // @public (undocumented)
158
- export const defaultPassword: string;
159
-
160
- // @public (undocumented)
161
- export const defaultSocketExt: string;
162
-
163
- // @beta
164
- export const defaultTemplateOptions: TemplateOptions;
165
-
166
- // @public (undocumented)
167
- export const defaultUser: string;
168
-
169
- // @beta
170
- export const define: DefineFunction<typeof Login>;
171
-
172
- // @beta (undocumented)
173
- export const definition: PartialFASTElementDefinition;
174
-
175
- // Warning: (ae-internal-missing-underscore) The name "emailField" should be prefixed with an underscore because the declaration is marked as @internal
176
- //
177
- // @internal (undocumented)
178
- export const emailField: <T extends BaseRoute>() => ViewTemplate<T, any>;
179
-
180
- // @public
181
- export const fetchIDPs: (path?: string, host?: string) => Promise<IDP[]>;
182
-
183
- // @public
184
- export type FieldConfig = {
185
- label: string;
186
- value?: any;
187
- required?: boolean;
188
- pattern?: string;
189
- title?: string;
190
- };
191
-
192
- // @public (undocumented)
193
- export type FieldConfigMap = {
194
- organisation: FieldConfig | null;
195
- username: FieldConfig;
196
- email: FieldConfig;
197
- password: FieldConfig;
198
- };
199
-
200
- // @public
201
- export function getLoginRouting(): LoginRouting;
202
-
203
- // @public
204
- export const getSSOLoginURL: (idp: any, path?: string, host?: string) => string;
205
-
206
- // @public (undocumented)
207
- export const hostEnv: string;
208
-
209
- // @public (undocumented)
210
- export const hostUrl: string;
211
-
212
- // @public (undocumented)
213
- export interface IDP {
214
- // (undocumented)
215
- id: string;
216
- // (undocumented)
217
- type: string;
218
- }
219
-
220
- // @public (undocumented)
221
- export interface IDPResponse {
222
- // (undocumented)
223
- ID: string;
224
- // (undocumented)
225
- TYPE: string;
226
- }
227
-
228
- // @public
229
- export function isMFRoute(pathname?: string): boolean;
230
-
231
- // @public @deprecated
232
- export class Login extends FASTElement {
233
- // @internal
234
- checkForSSOToken(): void;
235
- // @internal
236
- config: MainRouterConfig;
237
- // @internal (undocumented)
238
- connectedCallback(): Promise<void>;
239
- // @internal
240
- container: Container;
241
- // @internal
242
- i18next: I18next;
243
- // @internal
244
- provider: FASTElement;
245
- // @internal
246
- ready: boolean;
247
- // @internal
248
- registerCommonComponents(): Promise<void>;
249
- // @internal (undocumented)
250
- protected registerDIDependencies(): void;
251
- // @internal
252
- session: Session;
253
- }
254
-
255
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "LoginConfig" because one of its declarations is marked as @internal
256
- //
257
- // @public
258
- export interface LoginConfig {
259
- autoAuth: boolean;
260
- autoConnect: boolean;
261
- background: ElementStyles;
262
- defaultRedirectUrl: string;
263
- fields: FieldConfigMap;
264
- hostPath: string;
265
- localizationResources?: I18nextConfig['resources'];
266
- logo: ElementStyles | null;
267
- logoAltText: string;
268
- messageDelays?: MessageDelays;
269
- omitRedirectUrls: string[];
270
- omitRoutes: Exclude<Routes, 'login' | 'not-found'>[];
271
- redirectHandler?: (url: string) => void;
272
- showConnectionIndicator: boolean;
273
- showEnvironmentIndicator?: boolean;
274
- sso: SSOConfig | null;
275
- submitButtonAppearance?: ZeroButtonAppearance;
276
- versionInformation?: string;
277
- }
278
-
279
- // @internal
280
- export const LoginConfig: InterfaceSymbol<LoginConfig>;
281
-
282
- // @beta @deprecated (undocumented)
283
- export class LoginHosted extends Login {
284
- // (undocumented)
285
- registerCommonComponents(): Promise<void>;
286
- }
287
-
288
- // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "LoginRouting" because one of its declarations is marked as @internal
289
- //
290
- // @public
291
- export interface LoginRouting {
292
- // Warning: (ae-forgotten-export) The symbol "getRoutePath" needs to be exported by the entry point index.d.ts
293
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The package "@genesislcap/foundation-login" does not have an export "getRoutePath"
294
- //
295
- // (undocumented)
296
- getRoutePath: typeof getRoutePath;
297
- // Warning: (ae-forgotten-export) The symbol "navigateTo" needs to be exported by the entry point index.d.ts
298
- // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The package "@genesislcap/foundation-login" does not have an export "navigateTo"
299
- //
300
- // (undocumented)
301
- navigateTo: typeof navigateTo;
302
- }
303
-
304
- // @internal
305
- export const LoginRouting: InterfaceSymbol<LoginRouting>;
306
-
307
- // Warning: (ae-internal-missing-underscore) The name "LogoElement" should be prefixed with an underscore because the declaration is marked as @internal
308
- //
309
- // @internal (undocumented)
310
- export class LogoElement extends ConfigHostElement {
311
- }
312
-
313
- // Warning: (ae-internal-missing-underscore) The name "MainRouterConfig" should be prefixed with an underscore because the declaration is marked as @internal
314
- //
315
- // @internal
316
- export class MainRouterConfig extends FoundationRouterConfiguration<Settings> {
317
- constructor(auth: Auth, loginConfig?: LoginConfig);
318
- // (undocumented)
319
- configure(): void;
320
- }
321
-
322
- // @public (undocumented)
323
- export type MessageDelayKey = 'forgotPassword' | 'resetPassword' | 'base';
324
-
325
- // @public (undocumented)
326
- export type MessageDelays = Partial<Record<MessageDelayKey, number>>;
327
-
328
- // Warning: (ae-internal-missing-underscore) The name "MessageElement" should be prefixed with an underscore because the declaration is marked as @internal
329
- //
330
- // @internal (undocumented)
331
- export class MessageElement extends FASTElement {
332
- // (undocumented)
333
- classNames: string;
334
- // (undocumented)
335
- message: string;
336
- // (undocumented)
337
- nonError: boolean;
338
- // (undocumented)
339
- nonErrorChanged(): void;
340
- }
341
-
342
- // Warning: (ae-internal-missing-underscore) The name "organisationField" should be prefixed with an underscore because the declaration is marked as @internal
343
- //
344
- // @internal (undocumented)
345
- export const organisationField: <T extends BaseRoute>() => ViewTemplate<T, any>;
346
-
347
- // Warning: (ae-internal-missing-underscore) The name "password2Field" should be prefixed with an underscore because the declaration is marked as @internal
348
- //
349
- // @internal (undocumented)
350
- export const password2Field: <T extends BaseRoute>(type: 'new' | 'confirmation') => ViewTemplate<T, any>;
351
-
352
- // Warning: (ae-internal-missing-underscore) The name "passwordField" should be prefixed with an underscore because the declaration is marked as @internal
353
- //
354
- // @internal (undocumented)
355
- export const passwordField: <T extends BaseRoute>(label?: string) => ViewTemplate<T, any>;
356
-
357
- // @public (undocumented)
358
- export const Routes: {
359
- readonly login: "login";
360
- readonly 'request-account': "request-account";
361
- readonly 'reset-password': "reset-password";
362
- readonly 'forgot-password': "forgot-password";
363
- readonly verify: "verify";
364
- readonly 'mfa-mail-sent': "mfa-mail-sent";
365
- readonly protected: "protected";
366
- readonly 'not-found': "not-found";
367
- };
368
-
369
- // @public (undocumented)
370
- export type Routes = (typeof Routes)[keyof typeof Routes];
371
-
372
- // @public
373
- export type Settings = {
374
- public?: boolean;
375
- };
376
-
377
- // Warning: (ae-internal-missing-underscore) The name "showEnvironmentIndicator" should be prefixed with an underscore because the declaration is marked as @internal
378
- //
379
- // @internal (undocumented)
380
- export const showEnvironmentIndicator: <T extends BaseRoute>() => ViewTemplate<T, any>;
381
-
382
- // Warning: (ae-internal-missing-underscore) The name "showPasswordCheckbox" should be prefixed with an underscore because the declaration is marked as @internal
383
- //
384
- // @internal (undocumented)
385
- export const showPasswordCheckbox: <T extends BaseRoute>() => ViewTemplate<T, any>;
386
-
387
- // @public
388
- export type SSOConfig = {
389
- toggled?: boolean;
390
- identityProvidersPath: string;
391
- };
392
-
393
- // Warning: (ae-internal-missing-underscore) The name "standaloneDefinition" should be prefixed with an underscore because the declaration is marked as @internal
394
- //
395
- // @internal (undocumented)
396
- export const standaloneDefinition: PartialFASTElementDefinition;
397
-
398
- // Warning: (ae-incompatible-release-tags) The symbol "styles" is marked as @public, but its signature references "TemplateOptions" which is marked as @beta
399
- //
400
- // @public (undocumented)
401
- export const styles: (options: TemplateOptions) => ElementStyles;
402
-
403
- // Warning: (ae-internal-missing-underscore) The name "submitButton" should be prefixed with an underscore because the declaration is marked as @internal
404
- //
405
- // @internal (undocumented)
406
- export const submitButton: <T extends ConfigHost>(label: string, dataTestId?: string, disabled?: boolean) => ViewTemplate<T, any>;
407
-
408
- // Warning: (ae-internal-missing-underscore) The name "SubmittingIndicator" should be prefixed with an underscore because the declaration is marked as @internal
409
- //
410
- // @internal (undocumented)
411
- export class SubmittingIndicator extends FASTElement {
412
- // (undocumented)
413
- isSubmitting: boolean;
414
- }
415
-
416
- // Warning: (ae-incompatible-release-tags) The symbol "template" is marked as @public, but its signature references "TemplateOptions" which is marked as @beta
417
- //
418
- // @public (undocumented)
419
- export const template: (options: TemplateOptions) => ViewTemplate<Login, any>;
420
-
421
- // @beta (undocumented)
422
- export type TemplateComponents = {
423
- anchor: TemplateElementDependency;
424
- button: TemplateElementDependency;
425
- card: TemplateElementDependency;
426
- checkbox: TemplateElementDependency;
427
- listboxOption: TemplateElementDependency;
428
- provider: TemplateElementDependency;
429
- router: TemplateElementDependency;
430
- select: TemplateElementDependency;
431
- textField: TemplateElementDependency;
432
- };
433
-
434
- // @beta (undocumented)
435
- export type TemplateOptions = TemplateComponents & {
436
- somePartial?: string | SyntheticViewTemplate;
437
- };
438
-
439
- // Warning: (ae-internal-missing-underscore) The name "usernameField" should be prefixed with an underscore because the declaration is marked as @internal
440
- //
441
- // @internal (undocumented)
442
- export const usernameField: <T extends BaseRoute>() => ViewTemplate<T, any>;
443
-
444
- // (No @packageDocumentation comment for this package)
445
-
446
- ```