@genesislcap/foundation-login 14.408.0 → 14.409.0

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

@@ -1,70 +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; [fetchIDPs](./foundation-login.fetchidps.md)
-
-## fetchIDPs() function
-
-Request SSO identity provider list
-
-**Signature:**
-
-```typescript
-fetchIDPs: (path?: string, host?: string) => Promise<IDP[]>
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-path
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-host
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;[IDP](./foundation-login.idp.md)<!-- -->\[\]&gt;
-

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

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

@@ -1,32 +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; [getLoginRouting](./foundation-login.getloginrouting.md)
-
-## getLoginRouting() function
-
-Gets LoginRouting from the DI container.
-
-**Signature:**
-
-```typescript
-export declare function getLoginRouting(): LoginRouting;
-```
-**Returns:**
-
-[LoginRouting](./foundation-login.loginrouting.md)
-
-## Remarks
-
-A utility method for host applications that are not using decorators or the DI container.
-
-## Example
-
-
-```ts
-import { getloginRouting } from '@genesislcap/foundation-login';
-...
-private loginRouting = getLoginRouting();
-...
-this.loginRouting.navigateTo('logout');
-```
-

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

@@ -1,84 +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; [getSSOLoginURL](./foundation-login.getssologinurl.md)
-
-## getSSOLoginURL() function
-
-Get SSO identity provider login URL
-
-**Signature:**
-
-```typescript
-getSSOLoginURL: (idp: any, path?: string, host?: string) => string
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-idp
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-path
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-host
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-string
-

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,72 +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
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[id](./foundation-login.idp.id.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[type](./foundation-login.idp.type.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

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,72 +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
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[ID](./foundation-login.idpresponse.id.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[TYPE](./foundation-login.idpresponse.type.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

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,54 +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
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-pathname
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ A pathname string to check, typically location.pathname, which is used when a value is omitted.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-

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

@@ -1,113 +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
-
-> Warning: This API is now obsolete.
-> 
-> - Use '<!-- -->@<!-- -->genesislcap/pbc-auth' instead. 'https://www.npmjs.com/package/<!-- -->@<!-- -->genesislcap/pbc-auth'
-> 
-
-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();
-          FoundationRouteNav.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.
-