@genesislcap/foundation-login 14.408.0 → 14.409.0

package/docs/api/foundation-login.loginconfig.fields.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [LoginConfig](./foundation-login.loginconfig.md) &gt; [fields](./foundation-login.loginconfig.fields.md)
-
-## LoginConfig.fields property
-
-Map of configuration for each of the primary form fields.
-
-**Signature:**
-
-```typescript
-fields: FieldConfigMap;
-```
-
-## Remarks
-
-Use to drive inclusion / exclusion, tailor labels etc.
-

package/docs/api/foundation-login.loginconfig.hostpath.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [LoginConfig](./foundation-login.loginconfig.md) &gt; [hostPath](./foundation-login.loginconfig.hostpath.md)
-
-## LoginConfig.hostPath property
-
-The `path` of the micro frontend as defined in the parent / host route.
-
-**Signature:**
-
-```typescript
-hostPath: string;
-```
-
-## Remarks
-
-Used to help resolve internal route links. Defaults to an empty string.
-

package/docs/api/foundation-login.loginconfig.localizationresources.md

@@ -1,36 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [LoginConfig](./foundation-login.loginconfig.md) &gt; [localizationResources](./foundation-login.loginconfig.localizationresources.md)
-
-## LoginConfig.localizationResources property
-
-I18n resources.
-
-**Signature:**
-
-```typescript
-localizationResources?: I18nextConfig['resources'];
-```
-
-## Remarks
-
-This property holds the localization resources needed for internationalization of the application. It should follow the structure defined by the I18nextConfig interface, which includes translations grouped by locale and namespace. Each locale can contain multiple namespaces, and each namespace includes key-value pairs for translation strings.
-
-## Example
-
-
-```ts
-resources: {
-  en: {
-    translation: {
-      key: 'Hello World'
-    }
-  },
-  es: {
-    translation: {
-      key: 'Hola Mundo'
-    }
-  }
-}
-```
-

package/docs/api/foundation-login.loginconfig.logo.md

@@ -1,28 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [LoginConfig](./foundation-login.loginconfig.md) &gt; [logo](./foundation-login.loginconfig.logo.md)
-
-## LoginConfig.logo property
-
-Logo styles.
-
-**Signature:**
-
-```typescript
-logo: ElementStyles | null;
-```
-
-## Remarks
-
-Providing `null` will hide the logo. Use content: url(...); to set source.
-
-## Example
-
-Setting a custom logo
-
-```ts
-logo: css`
-    content: url(${customLogoImport});
-`,
-```
-

package/docs/api/foundation-login.loginconfig.logoalttext.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [LoginConfig](./foundation-login.loginconfig.md) &gt; [logoAltText](./foundation-login.loginconfig.logoalttext.md)
-
-## LoginConfig.logoAltText property
-
-Logo alt text.
-
-**Signature:**
-
-```typescript
-logoAltText: string;
-```

package/docs/api/foundation-login.loginconfig.md

@@ -1,381 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [LoginConfig](./foundation-login.loginconfig.md)
-
-## LoginConfig interface
-
-LoginConfig DI interface.
-
-**Signature:**
-
-```typescript
-export interface LoginConfig 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[autoAuth](./foundation-login.loginconfig.autoauth.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Login automatically or require user to click a login button after a connection is established.
-
-
-</td></tr>
-<tr><td>
-
-[autoConnect](./foundation-login.loginconfig.autoconnect.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Connect automatically or require user to click a connect button.
-
-
-</td></tr>
-<tr><td>
-
-[background](./foundation-login.loginconfig.background.md)
-
-
-</td><td>
-
-
-</td><td>
-
-ElementStyles
-
-
-</td><td>
-
-Background styles.
-
-
-</td></tr>
-<tr><td>
-
-[defaultRedirectUrl](./foundation-login.loginconfig.defaultredirecturl.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The default URL to route the user to after a successful login.
-
-
-</td></tr>
-<tr><td>
-
-[fields](./foundation-login.loginconfig.fields.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[FieldConfigMap](./foundation-login.fieldconfigmap.md)
-
-
-</td><td>
-
-Map of configuration for each of the primary form fields.
-
-
-</td></tr>
-<tr><td>
-
-[hostPath](./foundation-login.loginconfig.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-login.loginconfig.localizationresources.md)
-
-
-</td><td>
-
-
-</td><td>
-
-I18nextConfig\['resources'\]
-
-
-</td><td>
-
-_(Optional)_ I18n resources.
-
-
-</td></tr>
-<tr><td>
-
-[logo](./foundation-login.loginconfig.logo.md)
-
-
-</td><td>
-
-
-</td><td>
-
-ElementStyles \| null
-
-
-</td><td>
-
-Logo styles.
-
-
-</td></tr>
-<tr><td>
-
-[logoAltText](./foundation-login.loginconfig.logoalttext.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Logo alt text.
-
-
-</td></tr>
-<tr><td>
-
-[messageDelays?](./foundation-login.loginconfig.messagedelays.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[MessageDelays](./foundation-login.messagedelays.md)
-
-
-</td><td>
-
-_(Optional)_ Delay configurations for various message-related actions.
-
-
-</td></tr>
-<tr><td>
-
-[omitRedirectUrls](./foundation-login.loginconfig.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-login.loginconfig.omitroutes.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Exclude&lt;[Routes](./foundation-login.routes.md)<!-- -->, 'login' \| 'not-found'&gt;\[\]
-
-
-</td><td>
-
-Omit any of the internal routes except 'login' and 'not-found'.
-
-
-</td></tr>
-<tr><td>
-
-[redirectHandler?](./foundation-login.loginconfig.redirecthandler.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(url: string) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ Handler that allows external apps own router to navigate after successful login
-
-
-</td></tr>
-<tr><td>
-
-[showConnectionIndicator](./foundation-login.loginconfig.showconnectionindicator.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Show or hide the connection status indicator.
-
-
-</td></tr>
-<tr><td>
-
-[showEnvironmentIndicator?](./foundation-login.loginconfig.showenvironmentindicator.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Show or hide the environment indicator.
-
-
-</td></tr>
-<tr><td>
-
-[sso](./foundation-login.loginconfig.sso.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[SSOConfig](./foundation-login.ssoconfig.md) \| null
-
-
-</td><td>
-
-SSO configuration.
-
-
-</td></tr>
-<tr><td>
-
-[submitButtonAppearance?](./foundation-login.loginconfig.submitbuttonappearance.md)
-
-
-</td><td>
-
-
-</td><td>
-
-ZeroButtonAppearance
-
-
-</td><td>
-
-_(Optional)_ Custom appearance for submit buttons in `foundation-login`<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-[versionInformation?](./foundation-login.loginconfig.versioninformation.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Display arbitrary version information.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-login.loginconfig.messagedelays.md

@@ -1,29 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [LoginConfig](./foundation-login.loginconfig.md) &gt; [messageDelays](./foundation-login.loginconfig.messagedelays.md)
-
-## LoginConfig.messageDelays property
-
-Delay configurations for various message-related actions.
-
-**Signature:**
-
-```typescript
-messageDelays?: MessageDelays;
-```
-
-## Remarks
-
-This property holds numeric values representing delays (in milliseconds) for specific message-related actions within the application. Each key in this object corresponds to a particular message action.
-
-## Example
-
-
-```ts
-messageDelays: {
-  forgotPassword: 1000, // Delay of 1000ms before processing forgot password action
-  resetPassword: 2000, // Delay of 2000ms for reset password action
-  base: 500 // Base delay used for generic message processing
-}
-```
-

package/docs/api/foundation-login.loginconfig.omitredirecturls.md

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [LoginConfig](./foundation-login.loginconfig.md) &gt; [omitRedirectUrls](./foundation-login.loginconfig.omitredirecturls.md)
-
-## LoginConfig.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-login.loginconfig.omitroutes.md

@@ -1,25 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [LoginConfig](./foundation-login.loginconfig.md) &gt; [omitRoutes](./foundation-login.loginconfig.omitroutes.md)
-
-## LoginConfig.omitRoutes property
-
-Omit any of the internal routes except 'login' and 'not-found'.
-
-**Signature:**
-
-```typescript
-omitRoutes: Exclude<Routes, '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-login.loginconfig.redirecthandler.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [LoginConfig](./foundation-login.loginconfig.md) &gt; [redirectHandler](./foundation-login.loginconfig.redirecthandler.md)
-
-## LoginConfig.redirectHandler property
-
-Handler that allows external apps own router to navigate after successful login
-
-**Signature:**
-
-```typescript
-redirectHandler?: (url: string) => void;
-```

package/docs/api/foundation-login.loginconfig.showconnectionindicator.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [LoginConfig](./foundation-login.loginconfig.md) &gt; [showConnectionIndicator](./foundation-login.loginconfig.showconnectionindicator.md)
-
-## LoginConfig.showConnectionIndicator property
-
-Show or hide the connection status indicator.
-
-**Signature:**
-
-```typescript
-showConnectionIndicator: boolean;
-```

package/docs/api/foundation-login.loginconfig.showenvironmentindicator.md

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

package/docs/api/foundation-login.loginconfig.sso.md

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

package/docs/api/foundation-login.loginconfig.submitbuttonappearance.md

@@ -1,25 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [LoginConfig](./foundation-login.loginconfig.md) &gt; [submitButtonAppearance](./foundation-login.loginconfig.submitbuttonappearance.md)
-
-## LoginConfig.submitButtonAppearance property
-
-Custom appearance for submit buttons in `foundation-login`<!-- -->.
-
-**Signature:**
-
-```typescript
-submitButtonAppearance?: ZeroButtonAppearance;
-```
-
-## Remarks
-
-This property holds a string representing the desired appearance for submit buttons in `foundation-login`<!-- -->. The value should be a valid `appearance` attribute of a Foundation button component.
-
-## Example
-
-
-```ts
-submitButtonAppearance: 'stealth'
-```
-

package/docs/api/foundation-login.loginconfig.versioninformation.md

@@ -1,25 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [LoginConfig](./foundation-login.loginconfig.md) &gt; [versionInformation](./foundation-login.loginconfig.versioninformation.md)
-
-## LoginConfig.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',
-```
-