@genesislcap/foundation-login 14.61.2 → 14.62.1

package/docs/.gitattributes

@@ -0,0 +1,2 @@
+*.md -diff
+*.md linguist-generated

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

@@ -0,0 +1,63 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [configure](./foundation-login.configure.md)
+
+## configure() function
+
+Configure the login micro frontend settings.
+
+**Signature:**
+
+```typescript
+export declare function configure(container: Container, config: Partial<LoginConfig>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  container | Container | DI container. |
+|  config | Partial&lt;[LoginConfig](./foundation-login.loginconfig.md)<!-- -->&gt; | A partial LoginConfig. |
+
+**Returns:**
+
+void
+
+## Remarks
+
+This is primarily for general settings, rather than re-defining the element, static templating / style changes.
+
+## Example
+
+Configuring login on lazy load
+
+```ts
+name: 'login',
+path: 'login',
+title: 'Login',
+element: async () => {
+  const { configure, define, defaultLoginConfig } = await import('@genesislcap/foundation-login');
+  configure(this.container, {
+    autoConnect: true,
+    omitRoutes: ['request-account'],
+    fields: {
+      ...defaultLoginConfig.fields,
+      organisation: {
+        label: 'CompID',
+      },
+    },
+    hostPath: 'login',
+    defaultRedirectUrl: 'dashboard',
+    logo: loginLogo,
+    background: loginBG,
+  });
+  // You can import and return `Login` directly here or re-define it completely via `define`.
+  return define({
+    name: `nexus-login`,
+  });
+},
+layout: loginLayout,
+settings: { public: true },
+childRouters: true,
+```
+

package/docs/api/foundation-login.defaultapihost.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; [defaultApiHost](./foundation-login.defaultapihost.md)
+
+## defaultApiHost variable
+
+
+**Signature:**
+
+```typescript
+defaultApiHost: string
+```

package/docs/api/foundation-login.defaultloginconfig.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; [defaultLoginConfig](./foundation-login.defaultloginconfig.md)
+
+## defaultLoginConfig variable
+
+Default LoginConfig DI implementation.
+
+**Signature:**
+
+```typescript
+defaultLoginConfig: LoginConfig
+```

package/docs/api/foundation-login.defaultorganisation.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; [defaultOrganisation](./foundation-login.defaultorganisation.md)
+
+## defaultOrganisation variable
+
+
+**Signature:**
+
+```typescript
+defaultOrganisation: string
+```

package/docs/api/foundation-login.defaultpassword.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; [defaultPassword](./foundation-login.defaultpassword.md)
+
+## defaultPassword variable
+
+
+**Signature:**
+
+```typescript
+defaultPassword: string
+```

package/docs/api/foundation-login.defaultsocketext.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; [defaultSocketExt](./foundation-login.defaultsocketext.md)
+
+## defaultSocketExt variable
+
+
+**Signature:**
+
+```typescript
+defaultSocketExt: string
+```

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

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [defaultTemplateOptions](./foundation-login.defaulttemplateoptions.md)
+
+## defaultTemplateOptions variable
+
+> 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.
+> 
+
+The default template options this MF has been created with.
+
+**Signature:**
+
+```typescript
+defaultTemplateOptions: TemplateOptions
+```

package/docs/api/foundation-login.defaultuser.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; [defaultUser](./foundation-login.defaultuser.md)
+
+## defaultUser variable
+
+
+**Signature:**
+
+```typescript
+defaultUser: string
+```

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

@@ -0,0 +1,38 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-login](./foundation-login.md) &gt; [define](./foundation-login.define.md)
+
+## define variable
+
+> 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.
+> 
+
+Re-define the login micro frontend.
+
+**Signature:**
+
+```typescript
+define: import("@genesislcap/foundation-ui").DefineFunction<typeof Login>
+```
+
+## Example
+
+
+```ts
+import { define, styles, template, defaultTemplateOptions } from '@genesislcap/foundation-login';
+const customTemplateOptions = {
+  ...defaultTemplateOptions,
+  ...customOptions,
+}
+export const AppLogin = define({
+  name: `nexus-login`,
+  template: template(customTemplateOptions),
+  styles: css`
+    ${styles(customTemplateOptions)}
+    some-element {
+      background-color: #ff00b4;
+    }
+ `,
+});
+```
+

package/docs/api/foundation-login.definition.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; [definition](./foundation-login.definition.md)
+
+## definition variable
+
+> 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
+definition: PartialFASTElementDefinition
+```
+
+## Remarks
+
+This is the main definition of this micro frontend which is exposed for user reconfiguration.
+

package/docs/api/foundation-login.fieldconfig.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; [FieldConfig](./foundation-login.fieldconfig.md)
+
+## FieldConfig type
+
+Could be expanded to allow field ViewTemplates.
+
+**Signature:**
+
+```typescript
+export type FieldConfig = {
+    label: string;
+    value?: any;
+    required?: boolean;
+    pattern?: string;
+    title?: string;
+};
+```

package/docs/api/foundation-login.fieldconfigmap.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; [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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -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; [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.logo.md

@@ -0,0 +1,28 @@
+<!-- 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});
+`,
+```
+