@genesislcap/foundation-login 14.62.0 → 14.62.2-alpha-39ca39f.0

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

@@ -0,0 +1,31 @@
+<!-- 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
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [autoAuth](./foundation-login.loginconfig.autoauth.md) |  | boolean | Login automatically or require user to click a login button after a connection is established. |
+|  [autoConnect](./foundation-login.loginconfig.autoconnect.md) |  | boolean | Connect automatically or require user to click a connect button. |
+|  [background](./foundation-login.loginconfig.background.md) |  | ElementStyles | Background styles. |
+|  [defaultRedirectUrl](./foundation-login.loginconfig.defaultredirecturl.md) |  | string | The default URL to route the user to after a successful login. |
+|  [fields](./foundation-login.loginconfig.fields.md) |  | [FieldConfigMap](./foundation-login.fieldconfigmap.md) | Map of configuration for each of the primary form fields. |
+|  [hostPath](./foundation-login.loginconfig.hostpath.md) |  | string | The <code>path</code> of the micro frontend as defined in the parent / host route. |
+|  [logo](./foundation-login.loginconfig.logo.md) |  | ElementStyles \| null | Logo styles. |
+|  [omitRedirectUrls](./foundation-login.loginconfig.omitredirecturls.md) |  | string\[\] | Omit certain return urls which the session service may have captured. |
+|  [omitRoutes](./foundation-login.loginconfig.omitroutes.md) |  | Exclude&lt;[Routes](./foundation-login.routes.md)<!-- -->, 'login' \| 'not-found'&gt;\[\] | Omit any of the internal routes except 'login' and 'not-found'. |
+|  [showConnectionIndicator](./foundation-login.loginconfig.showconnectionindicator.md) |  | boolean | Show or hide the connection status indicator. |
+|  [sso](./foundation-login.loginconfig.sso.md) |  | [SSOConfig](./foundation-login.ssoconfig.md) \| null | SSO configuration. |
+|  [versionInformation?](./foundation-login.loginconfig.versioninformation.md) |  | string | _(Optional)_ Display arbitrary version information. |
+

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

@@ -0,0 +1,21 @@
+<!-- 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

@@ -0,0 +1,25 @@
+<!-- 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.showconnectionindicator.md

@@ -0,0 +1,13 @@
+<!-- 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.sso.md

@@ -0,0 +1,18 @@
+<!-- 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.versioninformation.md

@@ -0,0 +1,25 @@
+<!-- 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',
+```
+

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

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [LoginHosted](./foundation-login.loginhosted.md)
+
+## LoginHosted class
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+
+**Signature:**
+
+```typescript
+export declare class LoginHosted extends Login 
+```
+**Extends:** [Login](./foundation-login.login.md)
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [registerCommonComponents()](./foundation-login.loginhosted.registercommoncomponents.md) |  | **_(BETA)_** |
+

package/docs/api/foundation-login.loginhosted.registercommoncomponents.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [LoginHosted](./foundation-login.loginhosted.md) &gt; [registerCommonComponents](./foundation-login.loginhosted.registercommoncomponents.md)
+
+## LoginHosted.registerCommonComponents() method
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+registerCommonComponents(): Promise<void>;
+```
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api/foundation-login.md

@@ -0,0 +1,59 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md)
+
+## foundation-login package
+
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [Login](./foundation-login.login.md) | Defines the login class which handles account authentication from the front-end |
+|  [LoginHosted](./foundation-login.loginhosted.md) | **_(BETA)_** |
+
+## Functions
+
+|  Function | Description |
+|  --- | --- |
+|  [configure(container, config)](./foundation-login.configure.md) | Configure the login micro frontend settings. |
+|  [isMFRoute(pathname)](./foundation-login.ismfroute.md) | A utility to check if a pathname is a route of this micro frontend. |
+
+## Interfaces
+
+|  Interface | Description |
+|  --- | --- |
+|  [IDP](./foundation-login.idp.md) |  |
+|  [IDPResponse](./foundation-login.idpresponse.md) |  |
+|  [LoginConfig](./foundation-login.loginconfig.md) | LoginConfig DI interface. |
+
+## Variables
+
+|  Variable | Description |
+|  --- | --- |
+|  [defaultApiHost](./foundation-login.defaultapihost.md) |  |
+|  [defaultLoginConfig](./foundation-login.defaultloginconfig.md) | Default LoginConfig DI implementation. |
+|  [defaultOrganisation](./foundation-login.defaultorganisation.md) |  |
+|  [defaultPassword](./foundation-login.defaultpassword.md) |  |
+|  [defaultSocketExt](./foundation-login.defaultsocketext.md) |  |
+|  [defaultTemplateOptions](./foundation-login.defaulttemplateoptions.md) | **_(BETA)_** The default template options this MF has been created with. |
+|  [defaultUser](./foundation-login.defaultuser.md) |  |
+|  [define](./foundation-login.define.md) | **_(BETA)_** Re-define the login micro frontend. |
+|  [definition](./foundation-login.definition.md) | **_(BETA)_** |
+|  [hostEnv](./foundation-login.hostenv.md) |  |
+|  [hostUrl](./foundation-login.hosturl.md) |  |
+|  [Routes](./foundation-login.routes.md) |  |
+|  [styles](./foundation-login.styles.md) |  |
+|  [template](./foundation-login.template.md) |  |
+
+## Type Aliases
+
+|  Type Alias | Description |
+|  --- | --- |
+|  [FieldConfig](./foundation-login.fieldconfig.md) | Could be expanded to allow field ViewTemplates. |
+|  [FieldConfigMap](./foundation-login.fieldconfigmap.md) |  |
+|  [Routes](./foundation-login.routes.md) |  |
+|  [Settings](./foundation-login.settings.md) | Defines the parameters you may set on the routes. |
+|  [SSOConfig](./foundation-login.ssoconfig.md) |  |
+|  [TemplateComponents](./foundation-login.templatecomponents.md) | **_(BETA)_** |
+|  [TemplateOptions](./foundation-login.templateoptions.md) | **_(BETA)_** |
+

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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [Routes](./foundation-login.routes.md)
+
+## Routes variable
+
+
+**Signature:**
+
+```typescript
+Routes: {
+    readonly login: "login";
+    readonly 'request-account': "request-account";
+    readonly 'reset-password': "reset-password";
+    readonly 'forgot-password': "forgot-password";
+    readonly verify: "verify";
+    readonly protected: "protected";
+    readonly 'not-found': "not-found";
+}
+```

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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [Settings](./foundation-login.settings.md)
+
+## Settings type
+
+Defines the parameters you may set on the routes.
+
+**Signature:**
+
+```typescript
+export type Settings = {
+    public?: boolean;
+};
+```
+
+## Remarks
+
+See the example in the [Login](./foundation-login.login.md) class in the router's `configure` method for usage. All parameters are Optional.
+

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

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [SSOConfig](./foundation-login.ssoconfig.md)
+
+## SSOConfig type
+
+
+**Signature:**
+
+```typescript
+export type SSOConfig = {
+    toggled?: boolean;
+    identityProvidersPath: string;
+};
+```

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

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [styles](./foundation-login.styles.md)
+
+## styles variable
+
+**Signature:**
+
+```typescript
+styles: (options: TemplateOptions) => import("@microsoft/fast-element").ElementStyles
+```
+
+## Example
+
+unknown target
+
+```
+const buttonTag = tagFor(options.button);
+...
+${buttonTag} {
+  width: 200px;
+}
+```
+

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

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [template](./foundation-login.template.md)
+
+## template variable
+
+
+**Signature:**
+
+```typescript
+template: (options: TemplateOptions) => import("@microsoft/fast-element").ViewTemplate<Login, any>
+```

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

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [TemplateComponents](./foundation-login.templatecomponents.md)
+
+## TemplateComponents type
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+
+**Signature:**
+
+```typescript
+export type TemplateComponents = {
+    anchor: TemplateElementDependency;
+    button: TemplateElementDependency;
+    card: TemplateElementDependency;
+    checkbox: TemplateElementDependency;
+    listboxOption: TemplateElementDependency;
+    provider: TemplateElementDependency;
+    router: TemplateElementDependency;
+    select: TemplateElementDependency;
+    textField: TemplateElementDependency;
+};
+```

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

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [TemplateOptions](./foundation-login.templateoptions.md)
+
+## TemplateOptions type
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+
+**Signature:**
+
+```typescript
+export type TemplateOptions = TemplateComponents & {
+    somePartial?: string | SyntheticViewTemplate;
+};
+```
+**References:** [TemplateComponents](./foundation-login.templatecomponents.md)
+

package/docs/api/index.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [@genesislcap/foundation-login](./foundation-login.md) |  |
+