@genesislcap/foundation-auth 14.408.0 → 14.409.0-FUI-2495.2

package/docs/api/foundation-auth.event_login_auth_ack.refresh_auth_token.md

@@ -1,11 +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; [EVENT\_LOGIN\_AUTH\_ACK](./foundation-auth.event_login_auth_ack.md) &gt; [REFRESH\_AUTH\_TOKEN](./foundation-auth.event_login_auth_ack.refresh_auth_token.md)
-
-## EVENT\_LOGIN\_AUTH\_ACK.REFRESH\_AUTH\_TOKEN property
-
-**Signature:**
-
-```typescript
-readonly REFRESH_AUTH_TOKEN: string;
-```

package/docs/api/foundation-auth.event_login_auth_ack.session_auth_token.md

@@ -1,13 +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; [EVENT\_LOGIN\_AUTH\_ACK](./foundation-auth.event_login_auth_ack.md) &gt; [SESSION\_AUTH\_TOKEN](./foundation-auth.event_login_auth_ack.session_auth_token.md)
-
-## EVENT\_LOGIN\_AUTH\_ACK.SESSION\_AUTH\_TOKEN property
-
-Keeping these 3 here for now as I'm assuming these DTOs will be autogenerated at some point and will contain these.
-
-**Signature:**
-
-```typescript
-readonly SESSION_AUTH_TOKEN: string;
-```

package/docs/api/foundation-auth.event_login_auth_ack.session_id.md

@@ -1,11 +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; [EVENT\_LOGIN\_AUTH\_ACK](./foundation-auth.event_login_auth_ack.md) &gt; [SESSION\_ID](./foundation-auth.event_login_auth_ack.session_id.md)
-
-## EVENT\_LOGIN\_AUTH\_ACK.SESSION\_ID property
-
-**Signature:**
-
-```typescript
-readonly SESSION_ID: string;
-```

package/docs/api/foundation-auth.event_login_auth_ack.update_queue.md

@@ -1,11 +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; [EVENT\_LOGIN\_AUTH\_ACK](./foundation-auth.event_login_auth_ack.md) &gt; [UPDATE\_QUEUE](./foundation-auth.event_login_auth_ack.update_queue.md)
-
-## EVENT\_LOGIN\_AUTH\_ACK.UPDATE\_QUEUE property
-
-**Signature:**
-
-```typescript
-readonly UPDATE_QUEUE: string;
-```

package/docs/api/foundation-auth.event_login_auth_ack.user.md

@@ -1,26 +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; [EVENT\_LOGIN\_AUTH\_ACK](./foundation-auth.event_login_auth_ack.md) &gt; [USER](./foundation-auth.event_login_auth_ack.user.md)
-
-## EVENT\_LOGIN\_AUTH\_ACK.USER property
-
-**Signature:**
-
-```typescript
-readonly USER: {
-        [key: string]: any;
-    };
-```
-
-## Example
-
-
-```json
-"USER" : {
-  "USER_TYPE" : "USER",
-  "USER_ACCESS_TYPE" : "ALL",
-  "ADDRESS_LINE1" : "JohnDoe Street",
-  "TEST_CONFIGURATION" : "TEST"
-}
-```
-

package/docs/api/foundation-auth.event_login_auth_ack.user_name.md

@@ -1,11 +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; [EVENT\_LOGIN\_AUTH\_ACK](./foundation-auth.event_login_auth_ack.md) &gt; [USER\_NAME](./foundation-auth.event_login_auth_ack.user_name.md)
-
-## EVENT\_LOGIN\_AUTH\_ACK.USER\_NAME property
-
-**Signature:**
-
-```typescript
-readonly USER_NAME: string;
-```

package/docs/api/foundation-auth.event_login_auth_ack.zero_mq_proxy_inbound_port.md

@@ -1,11 +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; [EVENT\_LOGIN\_AUTH\_ACK](./foundation-auth.event_login_auth_ack.md) &gt; [ZERO\_MQ\_PROXY\_INBOUND\_PORT](./foundation-auth.event_login_auth_ack.zero_mq_proxy_inbound_port.md)
-
-## EVENT\_LOGIN\_AUTH\_ACK.ZERO\_MQ\_PROXY\_INBOUND\_PORT property
-
-**Signature:**
-
-```typescript
-readonly ZERO_MQ_PROXY_INBOUND_PORT: number;
-```

package/docs/api/foundation-auth.event_login_auth_ack.zero_mq_proxy_mode_enabled.md

@@ -1,11 +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; [EVENT\_LOGIN\_AUTH\_ACK](./foundation-auth.event_login_auth_ack.md) &gt; [ZERO\_MQ\_PROXY\_MODE\_ENABLED](./foundation-auth.event_login_auth_ack.zero_mq_proxy_mode_enabled.md)
-
-## EVENT\_LOGIN\_AUTH\_ACK.ZERO\_MQ\_PROXY\_MODE\_ENABLED property
-
-**Signature:**
-
-```typescript
-readonly ZERO_MQ_PROXY_MODE_ENABLED: boolean;
-```

package/docs/api/foundation-auth.event_login_auth_ack.zero_mq_proxy_outbound_port.md

@@ -1,11 +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; [EVENT\_LOGIN\_AUTH\_ACK](./foundation-auth.event_login_auth_ack.md) &gt; [ZERO\_MQ\_PROXY\_OUTBOUND\_PORT](./foundation-auth.event_login_auth_ack.zero_mq_proxy_outbound_port.md)
-
-## EVENT\_LOGIN\_AUTH\_ACK.ZERO\_MQ\_PROXY\_OUTBOUND\_PORT property
-
-**Signature:**
-
-```typescript
-readonly ZERO_MQ_PROXY_OUTBOUND_PORT: number;
-```

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

@@ -1,79 +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; [EVENT\_LOGIN\_AUTH\_NACK](./foundation-auth.event_login_auth_nack.md)
-
-## EVENT\_LOGIN\_AUTH\_NACK interface
-
-
-**Signature:**
-
-```typescript
-export interface EVENT_LOGIN_AUTH_NACK extends NACK 
-```
-**Extends:** NACK
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[REFRESH\_AUTH\_TOKEN](./foundation-auth.event_login_auth_nack.refresh_auth_token.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-A refresh token may be returned in a NACK on MFA\_REQUIRED or similar.
-
-
-</td></tr>
-<tr><td>
-
-[REFRESH\_TOKEN\_EXPIRATION\_MINS](./foundation-auth.event_login_auth_nack.refresh_token_expiration_mins.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-auth.event_login_auth_nack.refresh_auth_token.md

@@ -1,13 +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; [EVENT\_LOGIN\_AUTH\_NACK](./foundation-auth.event_login_auth_nack.md) &gt; [REFRESH\_AUTH\_TOKEN](./foundation-auth.event_login_auth_nack.refresh_auth_token.md)
-
-## EVENT\_LOGIN\_AUTH\_NACK.REFRESH\_AUTH\_TOKEN property
-
-A refresh token may be returned in a NACK on MFA\_REQUIRED or similar.
-
-**Signature:**
-
-```typescript
-readonly REFRESH_AUTH_TOKEN: string;
-```

package/docs/api/foundation-auth.event_login_auth_nack.refresh_token_expiration_mins.md

@@ -1,11 +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; [EVENT\_LOGIN\_AUTH\_NACK](./foundation-auth.event_login_auth_nack.md) &gt; [REFRESH\_TOKEN\_EXPIRATION\_MINS](./foundation-auth.event_login_auth_nack.refresh_token_expiration_mins.md)
-
-## EVENT\_LOGIN\_AUTH\_NACK.REFRESH\_TOKEN\_EXPIRATION\_MINS property
-
-**Signature:**
-
-```typescript
-readonly REFRESH_TOKEN_EXPIRATION_MINS: number;
-```

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

@@ -1,14 +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; [EVENT\_LOGIN\_DETAILS\_ACK](./foundation-auth.event_login_details_ack.md)
-
-## EVENT\_LOGIN\_DETAILS\_ACK interface
-
-
-**Signature:**
-
-```typescript
-export interface EVENT_LOGIN_DETAILS_ACK extends EVENT_LOGIN_AUTH_ACK 
-```
-**Extends:** [EVENT\_LOGIN\_AUTH\_ACK](./foundation-auth.event_login_auth_ack.md)
-

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

@@ -1,14 +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; [EVENT\_LOGOUT\_NACK](./foundation-auth.event_logout_nack.md)
-
-## EVENT\_LOGOUT\_NACK interface
-
-
-**Signature:**
-
-```typescript
-export interface EVENT_LOGOUT_NACK extends NACK 
-```
-**Extends:** NACK
-

package/docs/api/foundation-auth.event_password_reset_action.details.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; [EVENT\_PASSWORD\_RESET\_ACTION](./foundation-auth.event_password_reset_action.md) &gt; [DETAILS](./foundation-auth.event_password_reset_action.details.md)
-
-## EVENT\_PASSWORD\_RESET\_ACTION.DETAILS property
-
-**Signature:**
-
-```typescript
-readonly DETAILS: {
-        readonly USER_NAME: string;
-        readonly RESET_TOKEN: string;
-        readonly NEW_PASSWORD: string;
-    };
-```

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

@@ -1,77 +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; [EVENT\_PASSWORD\_RESET\_ACTION](./foundation-auth.event_password_reset_action.md)
-
-## EVENT\_PASSWORD\_RESET\_ACTION interface
-
-
-**Signature:**
-
-```typescript
-export interface EVENT_PASSWORD_RESET_ACTION extends MESSAGE 
-```
-**Extends:** MESSAGE
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[DETAILS](./foundation-auth.event_password_reset_action.details.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ readonly USER\_NAME: string; readonly RESET\_TOKEN: string; readonly NEW\_PASSWORD: string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[USER\_NAME](./foundation-auth.event_password_reset_action.user_name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-auth.event_password_reset_action.user_name.md

@@ -1,11 +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; [EVENT\_PASSWORD\_RESET\_ACTION](./foundation-auth.event_password_reset_action.md) &gt; [USER\_NAME](./foundation-auth.event_password_reset_action.user_name.md)
-
-## EVENT\_PASSWORD\_RESET\_ACTION.USER\_NAME property
-
-**Signature:**
-
-```typescript
-readonly USER_NAME: string;
-```

package/docs/api/foundation-auth.event_self_service_password_reset.details.md

@@ -1,14 +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; [EVENT\_SELF\_SERVICE\_PASSWORD\_RESET](./foundation-auth.event_self_service_password_reset.md) &gt; [DETAILS](./foundation-auth.event_self_service_password_reset.details.md)
-
-## EVENT\_SELF\_SERVICE\_PASSWORD\_RESET.DETAILS property
-
-**Signature:**
-
-```typescript
-readonly DETAILS: {
-        readonly USER_NAME: string;
-        readonly RETURN_URL: string;
-    };
-```

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

@@ -1,77 +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; [EVENT\_SELF\_SERVICE\_PASSWORD\_RESET](./foundation-auth.event_self_service_password_reset.md)
-
-## EVENT\_SELF\_SERVICE\_PASSWORD\_RESET interface
-
-
-**Signature:**
-
-```typescript
-export interface EVENT_SELF_SERVICE_PASSWORD_RESET extends MESSAGE 
-```
-**Extends:** MESSAGE
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[DETAILS](./foundation-auth.event_self_service_password_reset.details.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ readonly USER\_NAME: string; readonly RETURN\_URL: string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[USER\_NAME](./foundation-auth.event_self_service_password_reset.user_name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-auth.event_self_service_password_reset.user_name.md

@@ -1,11 +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; [EVENT\_SELF\_SERVICE\_PASSWORD\_RESET](./foundation-auth.event_self_service_password_reset.md) &gt; [USER\_NAME](./foundation-auth.event_self_service_password_reset.user_name.md)
-
-## EVENT\_SELF\_SERVICE\_PASSWORD\_RESET.USER\_NAME property
-
-**Signature:**
-
-```typescript
-readonly USER_NAME: string;
-```

package/docs/api/foundation-auth.fieldconfig.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; [FieldConfig](./foundation-auth.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-auth.fieldconfigmap.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; [FieldConfigMap](./foundation-auth.fieldconfigmap.md)
-
-## FieldConfigMap type
-
-
-**Signature:**
-
-```typescript
-export type FieldConfigMap = {
-    organisation: FieldConfig | null;
-    username: FieldConfig;
-    email: FieldConfig;
-    password: FieldConfig;
-};
-```
-**References:** [FieldConfig](./foundation-auth.fieldconfig.md)
-

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

@@ -1,16 +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; [ForgotPasswordParams](./foundation-auth.forgotpasswordparams.md)
-
-## ForgotPasswordParams type
-
-
-**Signature:**
-
-```typescript
-export type ForgotPasswordParams = {
-    username: string;
-    returnUrl: string;
-    requester?: string;
-};
-```

package/docs/api/foundation-auth.foundationauth.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; [FoundationAuth](./foundation-auth.foundationauth.md)
-
-## FoundationAuth class
-
-FoundationAuth.
-
-**Signature:**
-
-```typescript
-export declare class FoundationAuth extends FoundationAuth_base 
-```
-**Extends:** FoundationAuth\_base
-
-## Remarks
-
-Base MF export used by host application `configure` calls. It does not set up a design system or components. Both are expected to be registered in the host application, which should provide the details of which to the MF via TemplateOptions.
-
-See the [configure()](./foundation-auth.configure.md) hook for more information on how to set up and use this micro frontend in your application.
-

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

@@ -1,54 +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; [fromDTOAck](./foundation-auth.fromdtoack.md)
-
-## fromDTOAck() function
-
-fromDTOAck
-
-**Signature:**
-
-```typescript
-fromDTOAck: (dto: ACK) => Ack
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-dto
-
-
-</td><td>
-
-ACK
-
-
-</td><td>
-
-ACK.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Ack
-

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

@@ -1,54 +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; [fromDTONack](./foundation-auth.fromdtonack.md)
-
-## fromDTONack() function
-
-fromDTONack
-
-**Signature:**
-
-```typescript
-fromDTONack: (dto: NACK) => Nack
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-dto
-
-
-</td><td>
-
-NACK
-
-
-</td><td>
-
-NACK.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Nack
-