@genesislcap/foundation-auth 14.408.0 → 14.409.0

package/docs/api/foundation-auth.authconfig.md

@@ -1,340 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthConfig](./foundation-auth.authconfig.md)
-
-## AuthConfig interface
-
-AuthConfig DI interface.
-
-**Signature:**
-
-```typescript
-export interface AuthConfig extends PartialFASTElementDefinition 
-```
-**Extends:** PartialFASTElementDefinition
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[background](./foundation-auth.authconfig.background.md)
-
-
-</td><td>
-
-
-</td><td>
-
-ComposableStyles \| ComposableStyles\[\] \| null
-
-
-</td><td>
-
-Background styles.
-
-
-</td></tr>
-<tr><td>
-
-[backgroundVideo](./foundation-auth.authconfig.backgroundvideo.md)
-
-
-</td><td>
-
-
-</td><td>
-
-{ src: string; type: 'video/ogg' \| 'video/mp4' \| 'video/webm'; } \| null
-
-
-</td><td>
-
-Background video.
-
-
-</td></tr>
-<tr><td>
-
-[feedbackDelay?](./foundation-auth.authconfig.feedbackdelay.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-_(Optional)_ Feedback delay.
-
-
-</td></tr>
-<tr><td>
-
-[fields](./foundation-auth.authconfig.fields.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[FieldConfigMap](./foundation-auth.fieldconfigmap.md)
-
-
-</td><td>
-
-Map of configuration for each of the primary form fields.
-
-
-</td></tr>
-<tr><td>
-
-[hostPath](./foundation-auth.authconfig.hostpath.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The `path` of the micro frontend as defined in the parent / host route.
-
-
-</td></tr>
-<tr><td>
-
-[localizationResources?](./foundation-auth.authconfig.localizationresources.md)
-
-
-</td><td>
-
-
-</td><td>
-
-I18nextConfig\['resources'\]
-
-
-</td><td>
-
-_(Optional)_ I18n resources.
-
-
-</td></tr>
-<tr><td>
-
-[logo](./foundation-auth.authconfig.logo.md)
-
-
-</td><td>
-
-
-</td><td>
-
-ComposableStyles \| ComposableStyles\[\] \| null
-
-
-</td><td>
-
-Logo styles.
-
-
-</td></tr>
-<tr><td>
-
-[logoAltText](./foundation-auth.authconfig.logoalttext.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Logo alt text.
-
-
-</td></tr>
-<tr><td>
-
-[omitRedirectUrls](./foundation-auth.authconfig.omitredirecturls.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-Omit certain return URLs which the session service may have captured.
-
-
-</td></tr>
-<tr><td>
-
-[omitRoutes](./foundation-auth.authconfig.omitroutes.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Exclude&lt;[AuthRoutes](./foundation-auth.authroutes.md)<!-- -->, 'login' \| 'not-found'&gt;\[\]
-
-
-</td><td>
-
-Omit any of the internal routes except 'login' and 'not-found'.
-
-
-</td></tr>
-<tr><td>
-
-[postLoginRedirect](./foundation-auth.authconfig.postloginredirect.md)
-
-
-</td><td>
-
-
-</td><td>
-
-() =&gt; void
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[postLogoutRedirect](./foundation-auth.authconfig.postlogoutredirect.md)
-
-
-</td><td>
-
-
-</td><td>
-
-() =&gt; void
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[showEnvironmentIndicator?](./foundation-auth.authconfig.showenvironmentindicator.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Show or hide the environment indicator.
-
-
-</td></tr>
-<tr><td>
-
-[sso](./foundation-auth.authconfig.sso.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[SSOConfig](./foundation-auth.ssoconfig.md) \| null
-
-
-</td><td>
-
-SSO configuration.
-
-
-</td></tr>
-<tr><td>
-
-[templateOptions](./foundation-auth.authconfig.templateoptions.md)
-
-
-</td><td>
-
-
-</td><td>
-
-TemplateOptions
-
-
-</td><td>
-
-Template options.
-
-
-</td></tr>
-<tr><td>
-
-[versionInformation?](./foundation-auth.authconfig.versioninformation.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Display arbitrary version information.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-auth.authconfig.omitredirecturls.md

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthConfig](./foundation-auth.authconfig.md) &gt; [omitRedirectUrls](./foundation-auth.authconfig.omitredirecturls.md)
-
-## AuthConfig.omitRedirectUrls property
-
-Omit certain return URLs which the session service may have captured.
-
-**Signature:**
-
-```typescript
-omitRedirectUrls: string[];
-```
-
-## Example
-
-
-```ts
-omitRedirectUrls: ['/not-found'],
-```
-

package/docs/api/foundation-auth.authconfig.omitroutes.md

@@ -1,25 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthConfig](./foundation-auth.authconfig.md) &gt; [omitRoutes](./foundation-auth.authconfig.omitroutes.md)
-
-## AuthConfig.omitRoutes property
-
-Omit any of the internal routes except 'login' and 'not-found'.
-
-**Signature:**
-
-```typescript
-omitRoutes: Exclude<AuthRoutes, 'login' | 'not-found'>[];
-```
-
-## Remarks
-
-Routes specified here will not be configured nor will any internal cross-links to them be displayed.
-
-## Example
-
-
-```ts
-omitRoutes: ['request-account'],
-```
-

package/docs/api/foundation-auth.authconfig.postloginredirect.md

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthConfig](./foundation-auth.authconfig.md) &gt; [postLoginRedirect](./foundation-auth.authconfig.postloginredirect.md)
-
-## AuthConfig.postLoginRedirect property
-
-**Signature:**
-
-```typescript
-postLoginRedirect: () => void;
-```
-
-## Remarks
-
-Called after a successful login and can be overridden by host. User.lastPath() can be used to trump static values when required. Routes to the user's last attempted navigation path or '/protected' by default.
-
-## Example
-
-
-```ts
-const { configure, defaultAuthConfig } = await import('@genesislcap/foundation-auth/config');
-return configure({
-  postLoginRedirect: async () => {
-    await this.connect.connect(GENESIS_SOCKET_URL);
-    defaultAuthConfig.postLoginRedirect();
-  }
-  ...
-});
-```
-

package/docs/api/foundation-auth.authconfig.postlogoutredirect.md

@@ -1,32 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthConfig](./foundation-auth.authconfig.md) &gt; [postLogoutRedirect](./foundation-auth.authconfig.postlogoutredirect.md)
-
-## AuthConfig.postLogoutRedirect property
-
-**Signature:**
-
-```typescript
-postLogoutRedirect: () => void;
-```
-
-## Remarks
-
-Called after a successful logout and can be overridden by host. Routes to the login form by default.
-
-## Example
-
-
-```ts
-const { configure, defaultAuthConfig } = await import('@genesislcap/foundation-auth/config');
-return configure({
-  postLogoutRedirect: () => {
-    if (this.connect.isConnected) {
-      this.connect.disconnect();
-    }
-    defaultAuthConfig.postLogoutRedirect();
-  }
-  ...
-});
-```
-

package/docs/api/foundation-auth.authconfig.showenvironmentindicator.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthConfig](./foundation-auth.authconfig.md) &gt; [showEnvironmentIndicator](./foundation-auth.authconfig.showenvironmentindicator.md)
-
-## AuthConfig.showEnvironmentIndicator property
-
-Show or hide the environment indicator.
-
-**Signature:**
-
-```typescript
-showEnvironmentIndicator?: boolean;
-```

package/docs/api/foundation-auth.authconfig.sso.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthConfig](./foundation-auth.authconfig.md) &gt; [sso](./foundation-auth.authconfig.sso.md)
-
-## AuthConfig.sso property
-
-SSO configuration.
-
-**Signature:**
-
-```typescript
-sso: SSOConfig | null;
-```
-
-## Remarks
-
-Providing `null` excludes the SSO journey option completely.
-

package/docs/api/foundation-auth.authconfig.templateoptions.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthConfig](./foundation-auth.authconfig.md) &gt; [templateOptions](./foundation-auth.authconfig.templateoptions.md)
-
-## AuthConfig.templateOptions property
-
-Template options.
-
-**Signature:**
-
-```typescript
-templateOptions: TemplateOptions;
-```
-
-## Remarks
-
-Used by host applications to assign MF template options and subcomponent tags to align with the host design system.
-

package/docs/api/foundation-auth.authconfig.versioninformation.md

@@ -1,25 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthConfig](./foundation-auth.authconfig.md) &gt; [versionInformation](./foundation-auth.authconfig.versioninformation.md)
-
-## AuthConfig.versionInformation property
-
-Display arbitrary version information.
-
-**Signature:**
-
-```typescript
-versionInformation?: string;
-```
-
-## Remarks
-
-Applications may choose to set this to display their Application release version on the login form.
-
-## Example
-
-
-```ts
-versionInformation: 'Version 3.0.0',
-```
-

package/docs/api/foundation-auth.authdto.md

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthDTO](./foundation-auth.authdto.md)
-
-## AuthDTO type
-
-
-**Signature:**
-
-```typescript
-export type AuthDTO = LoginDTO | LogoutDTO | PasswordManagementDTO;
-```
-**References:** [LoginDTO](./foundation-auth.logindto.md)<!-- -->, [LogoutDTO](./foundation-auth.logoutdto.md)<!-- -->, [PasswordManagementDTO](./foundation-auth.passwordmanagementdto.md)
-

package/docs/api/foundation-auth.authentity.md

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthEntity](./foundation-auth.authentity.md)
-
-## AuthEntity type
-
-
-**Signature:**
-
-```typescript
-export type AuthEntity = LoginEntity | LogoutEntity | PasswordManagementEntity;
-```
-**References:** [LoginEntity](./foundation-auth.loginentity.md)<!-- -->, [LogoutEntity](./foundation-auth.logoutentity.md)<!-- -->, [PasswordManagementEntity](./foundation-auth.passwordmanagemententity.md)
-

package/docs/api/foundation-auth.autheventmap.md

@@ -1,24 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthEventMap](./foundation-auth.autheventmap.md)
-
-## AuthEventMap type
-
-
-**Signature:**
-
-```typescript
-export type AuthEventMap = StoreRootEventDetailMap & AuthMachineEventMap & {
-    'auth-store-connected': HTMLElement;
-    'auth-store-disconnected': void;
-    'auth-store-ready': boolean;
-    'auth-login': LoginParams;
-    'auth-logout': void;
-    'auth-change-password': ChangePasswordParams;
-    'auth-forgot-password': ForgotPasswordParams;
-    'auth-reset-password': ResetPasswordParams;
-    'auth-terms-conditions': TermsConditionsParams;
-};
-```
-**References:** [AuthMachineEventMap](./foundation-auth.authmachineeventmap.md)<!-- -->, [LoginParams](./foundation-auth.loginparams.md)<!-- -->, [ChangePasswordParams](./foundation-auth.changepasswordparams.md)<!-- -->, [ForgotPasswordParams](./foundation-auth.forgotpasswordparams.md)<!-- -->, [ResetPasswordParams](./foundation-auth.resetpasswordparams.md)<!-- -->, [TermsConditionsParams](./foundation-auth.termsconditionsparams.md)
-

package/docs/api/foundation-auth.authformentryeventmap.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthFormEntryEventMap](./foundation-auth.authformentryeventmap.md)
-
-## AuthFormEntryEventMap type
-
-
-**Signature:**
-
-```typescript
-export type AuthFormEntryEventMap = {
-    'auth-autofill-form': void;
-    'auth-organisation-changed': string;
-    'auth-username-changed': string;
-    'auth-email-changed': string;
-    'auth-password-changed': string;
-    'auth-password2-changed': string;
-    'auth-showPassword-changed': boolean;
-    'auth-selectedIdp-changed': string;
-    'auth-ssoToggled-changed': boolean;
-};
-```

package/docs/api/foundation-auth.authformentrystore.autofilling.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthFormEntryStore](./foundation-auth.authformentrystore.md) &gt; [autofilling](./foundation-auth.authformentrystore.autofilling.md)
-
-## AuthFormEntryStore.autofilling property
-
-**Signature:**
-
-```typescript
-readonly autofilling: boolean;
-```

package/docs/api/foundation-auth.authformentrystore.email.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthFormEntryStore](./foundation-auth.authformentrystore.md) &gt; [email](./foundation-auth.authformentrystore.email.md)
-
-## AuthFormEntryStore.email property
-
-**Signature:**
-
-```typescript
-readonly email: string;
-```

package/docs/api/foundation-auth.authformentrystore.haspasswordexpired.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthFormEntryStore](./foundation-auth.authformentrystore.md) &gt; [hasPasswordExpired](./foundation-auth.authformentrystore.haspasswordexpired.md)
-
-## AuthFormEntryStore.hasPasswordExpired property
-
-**Signature:**
-
-```typescript
-readonly hasPasswordExpired: boolean;
-```

package/docs/api/foundation-auth.authformentrystore.idps.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthFormEntryStore](./foundation-auth.authformentrystore.md) &gt; [idps](./foundation-auth.authformentrystore.idps.md)
-
-## AuthFormEntryStore.idps property
-
-**Signature:**
-
-```typescript
-readonly idps: IdentityProvider[];
-```