npm - @genesislcap/foundation-login - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/foundation-login 14.408.0 → 14.409.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (66) hide show

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

@@ -1,55 +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 beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-> Warning: This API is now obsolete.
->
-> - Please use foundation-auth instead.
->
-**Signature:**
-```typescript
-export declare class LoginHosted extends Login
-```
-**Extends:** [Login](./foundation-login.login.md)
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[registerCommonComponents()](./foundation-login.loginhosted.registercommoncomponents.md)
-</td><td>
-</td><td>
-**_(BETA)_**
-</td></tr>
-</tbody></table>

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

@@ -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 beta 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.loginrouting.getroutepath.md DELETED Viewed

@@ -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; [LoginRouting](./foundation-login.loginrouting.md) &gt; [getRoutePath](./foundation-login.loginrouting.getroutepath.md)
-## LoginRouting.getRoutePath property
-**Signature:**
-```typescript
-getRoutePath: typeof getRoutePath;
-```

package/docs/api/foundation-login.loginrouting.md DELETED Viewed

@@ -1,91 +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; [LoginRouting](./foundation-login.loginrouting.md)
-## LoginRouting interface
-LoginRouting interface.
-**Signature:**
-```typescript
-export interface LoginRouting
-```
-## Remarks
-A utility to navigate to a sub route of the login micro frontend without needing to know the full path in advance.
-## Example
-Import the utility into any component or logic you wish to invoke from.
-```ts
-import { LoginRouting } from '@genesislcap/foundation-login';
-...
-@LoginRouting private loginRouting: LoginRouting;
-...
-this.loginRouting.navigateTo('logout');
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[getRoutePath](./foundation-login.loginrouting.getroutepath.md)
-</td><td>
-</td><td>
-typeof getRoutePath
-</td><td>
-</td></tr>
-<tr><td>
-[navigateTo](./foundation-login.loginrouting.navigateto.md)
-</td><td>
-</td><td>
-typeof navigateTo
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-login.loginrouting.navigateto.md DELETED Viewed

@@ -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; [LoginRouting](./foundation-login.loginrouting.md) &gt; [navigateTo](./foundation-login.loginrouting.navigateto.md)
-## LoginRouting.navigateTo property
-**Signature:**
-```typescript
-navigateTo: typeof navigateTo;
-```

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

@@ -1,449 +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
-<table><thead><tr><th>
-Class
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[DefaultLoginRouting](./foundation-login.defaultloginrouting.md)
-</td><td>
-Default LoginRouting.
-</td></tr>
-<tr><td>
-[Login](./foundation-login.login.md)
-</td><td>
-Defines the login class which handles account authentication from the front-end
-</td></tr>
-<tr><td>
-[LoginHosted](./foundation-login.loginhosted.md)
-</td><td>
-**_(BETA)_**
-</td></tr>
-</tbody></table>
-## Functions
-<table><thead><tr><th>
-Function
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[configure(container, config)](./foundation-login.configure.md)
-</td><td>
-Configure the login micro frontend settings.
-</td></tr>
-<tr><td>
-[fetchIDPs(path, host)](./foundation-login.fetchidps.md)
-</td><td>
-Request SSO identity provider list
-</td></tr>
-<tr><td>
-[getLoginRouting()](./foundation-login.getloginrouting.md)
-</td><td>
-Gets LoginRouting from the DI container.
-</td></tr>
-<tr><td>
-[getSSOLoginURL(idp, path, host)](./foundation-login.getssologinurl.md)
-</td><td>
-Get SSO identity provider login URL
-</td></tr>
-<tr><td>
-[isMFRoute(pathname)](./foundation-login.ismfroute.md)
-</td><td>
-A utility to check if a pathname is a route of this micro frontend.
-</td></tr>
-<tr><td>
-[styles(options)](./foundation-login.styles.md)
-</td><td>
-</td></tr>
-<tr><td>
-[template(options)](./foundation-login.template.md)
-</td><td>
-</td></tr>
-</tbody></table>
-## Interfaces
-<table><thead><tr><th>
-Interface
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[IDP](./foundation-login.idp.md)
-</td><td>
-</td></tr>
-<tr><td>
-[IDPResponse](./foundation-login.idpresponse.md)
-</td><td>
-</td></tr>
-<tr><td>
-[LoginConfig](./foundation-login.loginconfig.md)
-</td><td>
-LoginConfig DI interface.
-</td></tr>
-<tr><td>
-[LoginRouting](./foundation-login.loginrouting.md)
-</td><td>
-LoginRouting interface.
-</td></tr>
-</tbody></table>
-## Variables
-<table><thead><tr><th>
-Variable
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[defaultApiHost](./foundation-login.defaultapihost.md)
-</td><td>
-</td></tr>
-<tr><td>
-[defaultLoginConfig](./foundation-login.defaultloginconfig.md)
-</td><td>
-Default LoginConfig DI implementation.
-</td></tr>
-<tr><td>
-[defaultOrganisation](./foundation-login.defaultorganisation.md)
-</td><td>
-</td></tr>
-<tr><td>
-[defaultPassword](./foundation-login.defaultpassword.md)
-</td><td>
-</td></tr>
-<tr><td>
-[defaultSocketExt](./foundation-login.defaultsocketext.md)
-</td><td>
-</td></tr>
-<tr><td>
-[defaultTemplateOptions](./foundation-login.defaulttemplateoptions.md)
-</td><td>
-**_(BETA)_** The default template options this MF has been created with.
-</td></tr>
-<tr><td>
-[defaultUser](./foundation-login.defaultuser.md)
-</td><td>
-</td></tr>
-<tr><td>
-[define](./foundation-login.define.md)
-</td><td>
-**_(BETA)_** Re-define the login micro frontend.
-</td></tr>
-<tr><td>
-[definition](./foundation-login.definition.md)
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[hostEnv](./foundation-login.hostenv.md)
-</td><td>
-</td></tr>
-<tr><td>
-[hostUrl](./foundation-login.hosturl.md)
-</td><td>
-</td></tr>
-<tr><td>
-[Routes](./foundation-login.routes.md)
-</td><td>
-</td></tr>
-</tbody></table>
-## Type Aliases
-<table><thead><tr><th>
-Type Alias
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[FieldConfig](./foundation-login.fieldconfig.md)
-</td><td>
-Could be expanded to allow field ViewTemplates.
-</td></tr>
-<tr><td>
-[FieldConfigMap](./foundation-login.fieldconfigmap.md)
-</td><td>
-</td></tr>
-<tr><td>
-[MessageDelayKey](./foundation-login.messagedelaykey.md)
-</td><td>
-</td></tr>
-<tr><td>
-[MessageDelays](./foundation-login.messagedelays.md)
-</td><td>
-</td></tr>
-<tr><td>
-[Routes](./foundation-login.routes.md)
-</td><td>
-</td></tr>
-<tr><td>
-[Settings](./foundation-login.settings.md)
-</td><td>
-Defines the parameters you may set on the routes.
-</td></tr>
-<tr><td>
-[SSOConfig](./foundation-login.ssoconfig.md)
-</td><td>
-If you don't provide SSOConfig on the login config then SSO is disabled completely.
-</td></tr>
-<tr><td>
-[TemplateComponents](./foundation-login.templatecomponents.md)
-</td><td>
-**_(BETA)_**
-</td></tr>
-<tr><td>
-[TemplateOptions](./foundation-login.templateoptions.md)
-</td><td>
-**_(BETA)_**
-</td></tr>
-</tbody></table>

package/docs/api/foundation-login.messagedelaykey.md DELETED Viewed

@@ -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; [MessageDelayKey](./foundation-login.messagedelaykey.md)
-## MessageDelayKey type
-**Signature:**
-```typescript
-export type MessageDelayKey = 'forgotPassword' | 'resetPassword' | 'base';
-```

package/docs/api/foundation-login.messagedelays.md DELETED Viewed

@@ -1,14 +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; [MessageDelays](./foundation-login.messagedelays.md)
-## MessageDelays type
-**Signature:**
-```typescript
-export type MessageDelays = Partial<Record<MessageDelayKey, number>>;
-```
-**References:** [MessageDelayKey](./foundation-login.messagedelaykey.md)

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

@@ -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; [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 'mfa-mail-sent': "mfa-mail-sent";
-    readonly protected: "protected";
-    readonly 'not-found': "not-found";
-}
-```

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

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