@genesislcap/foundation-login 10.3.1 → 11.3.1

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

@@ -1,19 +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; [FieldConfigMap](./foundation-login.fieldconfigmap.md)
-
-## FieldConfigMap type
-
-
-**Signature:**
-
-```typescript
-export type FieldConfigMap = {
-    organisation: FieldConfig | null;
-    username: FieldConfig;
-    email: FieldConfig;
-    password: FieldConfig;
-};
-```
-**References:** [FieldConfig](./foundation-login.fieldconfig.md)
-

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

@@ -1,12 +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; [hostEnv](./foundation-login.hostenv.md)
-
-## hostEnv variable
-
-
-**Signature:**
-
-```typescript
-hostEnv: string
-```

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

@@ -1,12 +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; [hostUrl](./foundation-login.hosturl.md)
-
-## hostUrl variable
-
-
-**Signature:**
-
-```typescript
-hostUrl: string
-```

package/docs/api/foundation-login.idp.id.md

@@ -1,11 +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; [IDP](./foundation-login.idp.md) &gt; [id](./foundation-login.idp.id.md)
-
-## IDP.id property
-
-**Signature:**
-
-```typescript
-id: string;
-```

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

@@ -1,20 +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; [IDP](./foundation-login.idp.md)
-
-## IDP interface
-
-
-**Signature:**
-
-```typescript
-export interface IDP 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [id](./foundation-login.idp.id.md) |  | string |  |
-|  [type](./foundation-login.idp.type.md) |  | string |  |
-

package/docs/api/foundation-login.idp.type.md

@@ -1,11 +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; [IDP](./foundation-login.idp.md) &gt; [type](./foundation-login.idp.type.md)
-
-## IDP.type property
-
-**Signature:**
-
-```typescript
-type: string;
-```

package/docs/api/foundation-login.idpresponse.id.md

@@ -1,11 +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; [IDPResponse](./foundation-login.idpresponse.md) &gt; [ID](./foundation-login.idpresponse.id.md)
-
-## IDPResponse.ID property
-
-**Signature:**
-
-```typescript
-ID: string;
-```

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

@@ -1,20 +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; [IDPResponse](./foundation-login.idpresponse.md)
-
-## IDPResponse interface
-
-
-**Signature:**
-
-```typescript
-export interface IDPResponse 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [ID](./foundation-login.idpresponse.id.md) |  | string |  |
-|  [TYPE](./foundation-login.idpresponse.type.md) |  | string |  |
-

package/docs/api/foundation-login.idpresponse.type.md

@@ -1,11 +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; [IDPResponse](./foundation-login.idpresponse.md) &gt; [TYPE](./foundation-login.idpresponse.type.md)
-
-## IDPResponse.TYPE property
-
-**Signature:**
-
-```typescript
-TYPE: string;
-```

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

@@ -1,24 +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; [isMFRoute](./foundation-login.ismfroute.md)
-
-## isMFRoute() function
-
-A utility to check if a pathname is a route of this micro frontend.
-
-**Signature:**
-
-```typescript
-export declare function isMFRoute(pathname?: string): boolean;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  pathname | string | _(Optional)_ A pathname string to check, typically location.pathname, which is used when a value is omitted. |
-
-**Returns:**
-
-boolean
-

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

@@ -1,108 +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; [Login](./foundation-login.login.md)
-
-## Login class
-
-Defines the login class which handles account authentication from the front-end
-
-**Signature:**
-
-```typescript
-export declare class Login extends FASTElement 
-```
-**Extends:** FASTElement
-
-## Remarks
-
-Add the Login class as a router element, and it will handle the account authentication for you. Requires use of `@genesislcap/foundation-comms` for the  and  classes.
-
-There are a lot of configuration options available, and different authentication types (such as login via SSO). Use the modules exported `configure` and `define` functions for more power.
-
-## Example
-
-The following is an example of using it in your app, setting it up in the router configuration. This isn't a complete routes confutation, but it contains all required configuration in regard to adding Login functionality.
-
-```ts
-// Import required dependencies from the foundation-login package
-import { Login } from '@genesislcap/foundation-login';
-// Import required dependencies from the foundation-comms package
-// You could also import analytics events and set them up in the NavigationContributor
-import { Auth, Session } from '@genesislcap/foundation-comms';
-
-type RouterSettings = {
-  public?: boolean;
-  autoAuth?: boolean;
-}
-
-// Define your router config
-export class MainRouterConfig extends RouterConfiguration<RouterSettings> {
-  // Ensure you inject in required dependencies
-  constructor(
-    @Auth private auth: Auth,
-    @Session private session: Session
-  ) {
-    super();
-  }
-
-  // Add Login as a route
-  public configure() {
-    ...
-    this.routes.map(
-      { path: '', redirect: 'login' },
-      {
-        path: 'login',
-        element: Login,
-        title: 'Login',
-        name: 'login',
-        layout: loginLayout,
-        settings: { public: true },
-        childRouters: true,
-      },
-      ... // Other routes config here
-    );
-
-    const session = this.session;
-    const auth = this.auth;
-
-    // Example of a FallbackRouteDefinition
-    this.routes.fallback(() =>
-      auth.isLoggedIn ? { redirect: 'not-found' } : { redirect: 'login' }
-    );
-
-     // Example of a NavigationContributor
-    this.contributors.push({
-      navigate: async (phase) => {
-        const settings = phase.route.settings;
-
-        // Could add in processes such as analytics here
-
-        // If public route don't block
-        if (settings && settings.public) {
-          return;
-        }
-
-        // If logged in don't block
-        if (auth.isLoggedIn) {
-          return;
-        }
-
-        // If autoAuth and session is valid try to connect+auto-login
-        if (settings && settings.autoAuth && (await auth.reAuthFromSession())) {
-          return;
-        }
-
-        // Otherwise route them to login
-        phase.cancel(() => {
-          session.captureReturnUrl();
-          Route.name.replace(phase.router, 'login');
-        });
-      },
-    });
-  }
-
-  ... // Other configuration/methods
-
-}
-```
-

package/docs/api/foundation-login.loginconfig.autoauth.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; [autoAuth](./foundation-login.loginconfig.autoauth.md)
-
-## LoginConfig.autoAuth property
-
-Login automatically or require user to click a login button after a connection is established.
-
-**Signature:**
-
-```typescript
-autoAuth: boolean;
-```
-
-## Remarks
-
-Needs to manually be enabled in the NavigationContributor (see \[2\] in the example in the [Login](./foundation-login.login.md) class).
-

package/docs/api/foundation-login.loginconfig.autoconnect.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; [autoConnect](./foundation-login.loginconfig.autoconnect.md)
-
-## LoginConfig.autoConnect property
-
-Connect automatically or require user to click a connect button.
-
-**Signature:**
-
-```typescript
-autoConnect: boolean;
-```

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

@@ -1,30 +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; [background](./foundation-login.loginconfig.background.md)
-
-## LoginConfig.background property
-
-Background styles.
-
-**Signature:**
-
-```typescript
-background: ElementStyles;
-```
-
-## Remarks
-
-See [https://developer.mozilla.org/en-US/docs/Web/CSS/background](https://developer.mozilla.org/en-US/docs/Web/CSS/background) for more information.
-
-## Example
-
-Setting a custom background image
-
-```ts
-background: css`
-    :host {
-        background-image: url(${customBGImport});
-    }
-`,
-```
-

package/docs/api/foundation-login.loginconfig.defaultredirecturl.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; [defaultRedirectUrl](./foundation-login.loginconfig.defaultredirecturl.md)
-
-## LoginConfig.defaultRedirectUrl property
-
-The default URL to route the user to after a successful login.
-
-**Signature:**
-
-```typescript
-defaultRedirectUrl: string;
-```
-
-## Remarks
-
-Session.returnUrl set via Session.captureReturnUrl() trumps this value.
-

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.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.md

@@ -1,30 +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
-
-|  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. |
-|  [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

@@ -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.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.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.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',
-```
-

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

@@ -1,23 +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; [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

@@ -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; [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

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

@@ -1,20 +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; [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";
-}
-```