@genesislcap/foundation-auth 14.408.0 → 14.409.0

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

@@ -1,106 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [configure](./foundation-auth.configure.md)
-
-## configure() function
-
-configure.
-
-**Signature:**
-
-```typescript
-export declare function configure(config: Partial<AuthConfig>): Promise<typeof import("../main").FoundationAuth>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-config
-
-
-</td><td>
-
-Partial&lt;[AuthConfig](./foundation-auth.authconfig.md)<!-- -->&gt;
-
-
-</td><td>
-
-A partial AuthConfig.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;typeof import("../main").[FoundationAuth](./foundation-auth.foundationauth.md)<!-- -->&gt;
-
-## Remarks
-
-Configure the auth micro frontend for host app integration.
-
-## Example 1
-
-General foundation-auth configuration when the route is visited, ie. lazy loading.
-
-```ts
-title: 'Authenticate',
-name: 'auth',
-path: 'auth',
-element: async () => {
-  const { configure } = await import('@genesislcap/foundation-auth/config'); // < import from the subpath
-  return configure({
-    hostPath: 'auth',
-    omitRoutes: ['request-account'],
-    logo: myCompanyLogo,
-    background: myAuthBG,
-    postLoginRedirect: () => {
-      // You could inspect the user here and route them based on various conditions.
-      Route.path.push('dashboard');
-    },
-  });
-},
-layout: authLayout,
-settings: { public: true },
-childRouters: true,
-```
-
-## Example 2
-
-Providing template options align to your host application.
-
-```ts
-title: 'Authenticate',
-name: 'auth',
-path: 'auth',
-element: async () => {
-  const { configure } = await import('@genesislcap/foundation-auth/config'); // < import from the subpath
-  return configure({
-    name: `nexus-app-auth`,
-    // These will be merged with the packages `defaultTemplateOptions`. You will need to have these components registered in your application.
-    templateOptions: {
-      button: 'nexus-button',
-      checkbox: 'nexus-checkbox-next',
-      provider: 'template',
-    },
-  });
-},
-```
-

package/docs/api/foundation-auth.createhttpheadersfromdto.md

@@ -1,73 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [createHTTPHeadersFromDTO](./foundation-auth.createhttpheadersfromdto.md)
-
-## createHTTPHeadersFromDTO() function
-
-createHTTPHeadersFromDTO.
-
-**Signature:**
-
-```typescript
-export declare function createHTTPHeadersFromDTO(dto: {
-    SOURCE_REF?: string;
-    USER_NAME?: string;
-}, contentType?: string): HeadersInit;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-dto
-
-
-</td><td>
-
-{ SOURCE\_REF?: string; USER\_NAME?: string; }
-
-
-</td><td>
-
-DTO being sent to the server.
-
-
-</td></tr>
-<tr><td>
-
-contentType
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Optional content-type, defaults to `application/json; charset=UTF-8`<!-- -->.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-HeadersInit
-

package/docs/api/foundation-auth.createmessagemapper.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [createMessageMapper](./foundation-auth.createmessagemapper.md)
-
-## createMessageMapper() function
-
-A factory to create a MessageMapper.
-
-**Signature:**
-
-```typescript
-createMessageMapper: <TLookup extends MessageMapperLookup, K extends keyof TLookup = keyof TLookup>() => MessageMapper<TLookup, K>
-```
-**Returns:**
-
-[MessageMapper](./foundation-auth.messagemapper.md)<!-- -->&lt;TLookup, K&gt;
-
-A MessageMapper instance.
-

package/docs/api/foundation-auth.credentialdata_2.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [CredentialData\_2](./foundation-auth.credentialdata_2.md)
-
-## CredentialData\_2 type
-
-Represents user credentials.
-
-**Signature:**
-
-```typescript
-export type CredentialData = PasswordCredentialData & {
-    password?: string;
-};
-```

package/docs/api/foundation-auth.credentialmanager.getcredentials.md

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [CredentialManager](./foundation-auth.credentialmanager.md) &gt; [getCredentials](./foundation-auth.credentialmanager.getcredentials.md)
-
-## CredentialManager.getCredentials() method
-
-Retrieves stored credentials.
-
-**Signature:**
-
-```typescript
-getCredentials(options?: GetCredentialOptions): Promise<CredentialData | undefined>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-options
-
-
-</td><td>
-
-[GetCredentialOptions](./foundation-auth.getcredentialoptions.md)
-
-
-</td><td>
-
-_(Optional)_ An object containing options for retrieving credentials.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;[CredentialData](./foundation-auth.credentialdata_2.md) \| undefined&gt;
-
-A Promise that resolves to a CredentialData object if the credentials are found, or undefined otherwise.
-

package/docs/api/foundation-auth.credentialmanager.getcredentialsfromcontainer.md

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [CredentialManager](./foundation-auth.credentialmanager.md) &gt; [getCredentialsFromContainer](./foundation-auth.credentialmanager.getcredentialsfromcontainer.md)
-
-## CredentialManager.getCredentialsFromContainer() method
-
-Retrieves credential data from the browser's credential manager.
-
-**Signature:**
-
-```typescript
-getCredentialsFromContainer(options?: GetCredentialOptions): Promise<CredentialData | null>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-options
-
-
-</td><td>
-
-[GetCredentialOptions](./foundation-auth.getcredentialoptions.md)
-
-
-</td><td>
-
-_(Optional)_ Options for filtering the retrieved credentials, if any.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;[CredentialData](./foundation-auth.credentialdata_2.md) \| null&gt;
-
-A Promise that resolves to the retrieved credential data, or `null` if no matching credentials were found.
-

package/docs/api/foundation-auth.credentialmanager.getcredentialsfromcookie.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [CredentialManager](./foundation-auth.credentialmanager.md) &gt; [getCredentialsFromCookie](./foundation-auth.credentialmanager.getcredentialsfromcookie.md)
-
-## CredentialManager.getCredentialsFromCookie() method
-
-Retrieves credential data from a browser cookie.
-
-**Signature:**
-
-```typescript
-getCredentialsFromCookie(): CredentialData | undefined;
-```
-**Returns:**
-
-[CredentialData](./foundation-auth.credentialdata_2.md) \| undefined
-
-The retrieved credential data, or `undefined` if no matching data was found.
-

package/docs/api/foundation-auth.credentialmanager.md

@@ -1,187 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [CredentialManager](./foundation-auth.credentialmanager.md)
-
-## CredentialManager interface
-
-CredentialManager interface.
-
-**Signature:**
-
-```typescript
-export interface CredentialManager 
-```
-
-## Remarks
-
-A system for managing user credentials.
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[getCredentials(options)](./foundation-auth.credentialmanager.getcredentials.md)
-
-
-</td><td>
-
-Retrieves stored credentials.
-
-
-</td></tr>
-<tr><td>
-
-[getCredentialsFromContainer(options)](./foundation-auth.credentialmanager.getcredentialsfromcontainer.md)
-
-
-</td><td>
-
-Retrieves credential data from the browser's credential manager.
-
-
-</td></tr>
-<tr><td>
-
-[getCredentialsFromCookie()](./foundation-auth.credentialmanager.getcredentialsfromcookie.md)
-
-
-</td><td>
-
-Retrieves credential data from a browser cookie.
-
-
-</td></tr>
-<tr><td>
-
-[normaliseLegacyCredentialData(data, cookie)](./foundation-auth.credentialmanager.normaliselegacycredentialdata.md)
-
-
-</td><td>
-
-Normalise legacy credential data.
-
-
-</td></tr>
-<tr><td>
-
-[preventSilentAccess()](./foundation-auth.credentialmanager.preventsilentaccess.md)
-
-
-</td><td>
-
-Prevents silent access by requiring the user to authenticate before making API requests.
-
-
-</td></tr>
-<tr><td>
-
-[removeCookie()](./foundation-auth.credentialmanager.removecookie.md)
-
-
-</td><td>
-
-Removes the user's credential cookie.
-
-
-</td></tr>
-<tr><td>
-
-[storeCredentials(data)](./foundation-auth.credentialmanager.storecredentials.md)
-
-
-</td><td>
-
-Stores user credentials securely.
-
-
-</td></tr>
-<tr><td>
-
-[storeCredentialsInContainer(data)](./foundation-auth.credentialmanager.storecredentialsincontainer.md)
-
-
-</td><td>
-
-Stores the specified credential data in the browser's credential manager.
-
-
-</td></tr>
-<tr><td>
-
-[storeCredentialsInCookie(data)](./foundation-auth.credentialmanager.storecredentialsincookie.md)
-
-
-</td><td>
-
-Stores the specified credential data in a browser cookie.
-
-
-</td></tr>
-<tr><td>
-
-[validateBasicCredentials(credentials)](./foundation-auth.credentialmanager.validatebasiccredentials.md)
-
-
-</td><td>
-
-Validates basic credentials (username and password).
-
-
-</td></tr>
-<tr><td>
-
-[validateMFACredentials(credentials)](./foundation-auth.credentialmanager.validatemfacredentials.md)
-
-
-</td><td>
-
-Validates MFA credentials.
-
-
-</td></tr>
-<tr><td>
-
-[validateRefreshCredentials(credentials)](./foundation-auth.credentialmanager.validaterefreshcredentials.md)
-
-
-</td><td>
-
-Validates refresh credentials.
-
-
-</td></tr>
-<tr><td>
-
-[validateSSOCredentials(credentials)](./foundation-auth.credentialmanager.validatessocredentials.md)
-
-
-</td><td>
-
-Validates SSO credentials.
-
-
-</td></tr>
-<tr><td>
-
-[validateUserCredentialData(data, ensurePassword)](./foundation-auth.credentialmanager.validateusercredentialdata.md)
-
-
-</td><td>
-
-Validate user credential data returned from the container or a cookie.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-auth.credentialmanager.normaliselegacycredentialdata.md

@@ -1,76 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [CredentialManager](./foundation-auth.credentialmanager.md) &gt; [normaliseLegacyCredentialData](./foundation-auth.credentialmanager.normaliselegacycredentialdata.md)
-
-## CredentialManager.normaliseLegacyCredentialData() method
-
-Normalise legacy credential data.
-
-**Signature:**
-
-```typescript
-normaliseLegacyCredentialData(data?: CredentialData, cookie?: CredentialData): [CredentialData | undefined, boolean];
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-data
-
-
-</td><td>
-
-[CredentialData](./foundation-auth.credentialdata_2.md)
-
-
-</td><td>
-
-_(Optional)_ The credential data to normalise.
-
-
-</td></tr>
-<tr><td>
-
-cookie
-
-
-</td><td>
-
-[CredentialData](./foundation-auth.credentialdata_2.md)
-
-
-</td><td>
-
-_(Optional)_ The unknown cookie data to normalise.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-\[[CredentialData](./foundation-auth.credentialdata_2.md) \| undefined, boolean\]
-
-A tuple of the best effort normalisation of the inputs to the CredentialData format, and a boolean to indicate if we can remove the cookie.
-
-## Remarks
-
-Older applications may have legacy credential data that needs migrating to the latest format the manager expects. If the input CredentialData is already formatted as such, it will be returned as is. Otherwise, we check if any cookie input is already formatted as such, and if so return it as CredentialData. If neither inputs are valid, we will attempt a best effort normalisation to create valid CredentialData, or abort and return undefined.
-

package/docs/api/foundation-auth.credentialmanager.preventsilentaccess.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [CredentialManager](./foundation-auth.credentialmanager.md) &gt; [preventSilentAccess](./foundation-auth.credentialmanager.preventsilentaccess.md)
-
-## CredentialManager.preventSilentAccess() method
-
-Prevents silent access by requiring the user to authenticate before making API requests.
-
-**Signature:**
-
-```typescript
-preventSilentAccess(): Promise<void>;
-```
-**Returns:**
-
-Promise&lt;void&gt;
-

package/docs/api/foundation-auth.credentialmanager.removecookie.md

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [CredentialManager](./foundation-auth.credentialmanager.md) &gt; [removeCookie](./foundation-auth.credentialmanager.removecookie.md)
-
-## CredentialManager.removeCookie() method
-
-Removes the user's credential cookie.
-
-**Signature:**
-
-```typescript
-removeCookie(): void;
-```
-**Returns:**
-
-void
-
-## Remarks
-
-This is generally called when migrating a user's saved credentials from a cookie to the secure container.
-

package/docs/api/foundation-auth.credentialmanager.storecredentials.md

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [CredentialManager](./foundation-auth.credentialmanager.md) &gt; [storeCredentials](./foundation-auth.credentialmanager.storecredentials.md)
-
-## CredentialManager.storeCredentials() method
-
-Stores user credentials securely.
-
-**Signature:**
-
-```typescript
-storeCredentials(data: CredentialData): Promise<boolean>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-data
-
-
-</td><td>
-
-[CredentialData](./foundation-auth.credentialdata_2.md)
-
-
-</td><td>
-
-The credential data to be stored.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;boolean&gt;
-
-A Promise that resolves to a boolean indicating if the credentials were stored successfully.
-