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

package/docs/api/foundation-auth.defaultmessagemapper.set.md

@@ -1,70 +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; [DefaultMessageMapper](./foundation-auth.defaultmessagemapper.md) &gt; [set](./foundation-auth.defaultmessagemapper.set.md)
-
-## DefaultMessageMapper.set() method
-
-Set a mapper by message type.
-
-**Signature:**
-
-```typescript
-set(key: K, mapper: TLookup[K]): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-key
-
-
-</td><td>
-
-K
-
-
-</td><td>
-
-The message type as key.
-
-
-</td></tr>
-<tr><td>
-
-mapper
-
-
-</td><td>
-
-TLookup\[K\]
-
-
-</td><td>
-
-The mapper.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/foundation-auth.defaultmessagemapper.size.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; [DefaultMessageMapper](./foundation-auth.defaultmessagemapper.md) &gt; [size](./foundation-auth.defaultmessagemapper.size.md)
-
-## DefaultMessageMapper.size property
-
-The size of the mapper map.
-
-**Signature:**
-
-```typescript
-get size(): number;
-```

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

@@ -1,78 +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; [DefaultPasswordManagementMapper](./foundation-auth.defaultpasswordmanagementmapper.md)
-
-## DefaultPasswordManagementMapper class
-
-Default PasswordManagementMapper.
-
-**Signature:**
-
-```typescript
-export declare class DefaultPasswordManagementMapper implements PasswordManagementMapper 
-```
-**Implements:** [PasswordManagementMapper](./foundation-auth.passwordmanagementmapper.md)
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[toDTO](./foundation-auth.defaultpasswordmanagementmapper.todto.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(entity: [PasswordManagementEntity](./foundation-auth.passwordmanagemententity.md)<!-- -->) =&gt; [PasswordManagementDTO](./foundation-auth.passwordmanagementdto.md)
-
-
-</td><td>
-
-Converts an entity to a DTO.
-
-
-</td></tr>
-<tr><td>
-
-[uuid](./foundation-auth.defaultpasswordmanagementmapper.uuid.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-UUID
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-auth.defaultpasswordmanagementmapper.todto.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; [DefaultPasswordManagementMapper](./foundation-auth.defaultpasswordmanagementmapper.md) &gt; [toDTO](./foundation-auth.defaultpasswordmanagementmapper.todto.md)
-
-## DefaultPasswordManagementMapper.toDTO property
-
-Converts an entity to a DTO.
-
-**Signature:**
-
-```typescript
-toDTO: (entity: PasswordManagementEntity) => PasswordManagementDTO;
-```

package/docs/api/foundation-auth.defaultpasswordmanagementmapper.uuid.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; [DefaultPasswordManagementMapper](./foundation-auth.defaultpasswordmanagementmapper.md) &gt; [uuid](./foundation-auth.defaultpasswordmanagementmapper.uuid.md)
-
-## DefaultPasswordManagementMapper.uuid property
-
-**Signature:**
-
-```typescript
-protected uuid: UUID;
-```

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

@@ -1,18 +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; [Details](./foundation-auth.details.md)
-
-## Details interface
-
-> Warning: This API is now obsolete.
-> 
-> - Use @<!-- -->genesislcap/foundation-user\#UserDetailsProperty instead.
-> 
-
-**Signature:**
-
-```typescript
-export interface Details extends UserDetailsProperty 
-```
-**Extends:** UserDetailsProperty
-

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

package/docs/api/foundation-auth.event_change_user_password.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\_CHANGE\_USER\_PASSWORD](./foundation-auth.event_change_user_password.md)
-
-## EVENT\_CHANGE\_USER\_PASSWORD interface
-
-
-**Signature:**
-
-```typescript
-export interface EVENT_CHANGE_USER_PASSWORD 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_change_user_password.details.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ readonly OLD\_PASSWORD: string; readonly NEW\_PASSWORD: string; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[USER\_NAME](./foundation-auth.event_change_user_password.user_name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-auth.event_change_user_password.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\_CHANGE\_USER\_PASSWORD](./foundation-auth.event_change_user_password.md) &gt; [USER\_NAME](./foundation-auth.event_change_user_password.user_name.md)
-
-## EVENT\_CHANGE\_USER\_PASSWORD.USER\_NAME property
-
-**Signature:**
-
-```typescript
-readonly USER_NAME: string;
-```

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

@@ -1,24 +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](./foundation-auth.event_login_auth.md) &gt; [DETAILS](./foundation-auth.event_login_auth.details.md)
-
-## EVENT\_LOGIN\_AUTH.DETAILS property
-
-**Signature:**
-
-```typescript
-readonly DETAILS: {
-        readonly USER_NAME: string;
-        readonly PASSWORD: string;
-    } | {
-        readonly USER_NAME: string;
-        readonly REFRESH_AUTH_TOKEN: string;
-    } | {
-        readonly SSO_TOKEN: string;
-    } | {
-        readonly JWT: string;
-        readonly DOMAIN: string;
-    } | {
-        readonly MFA_CODE: string;
-    };
-```

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

@@ -1,58 +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](./foundation-auth.event_login_auth.md)
-
-## EVENT\_LOGIN\_AUTH interface
-
-
-**Signature:**
-
-```typescript
-export interface EVENT_LOGIN_AUTH 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_login_auth.details.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ readonly USER\_NAME: string; readonly PASSWORD: string; } \| { readonly USER\_NAME: string; readonly REFRESH\_AUTH\_TOKEN: string; } \| { readonly SSO\_TOKEN: string; } \| { readonly JWT: string; readonly DOMAIN: string; } \| { readonly MFA\_CODE: string; }
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-auth.event_login_auth_ack.details.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; [DETAILS](./foundation-auth.event_login_auth_ack.details.md)
-
-## EVENT\_LOGIN\_AUTH\_ACK.DETAILS property
-
-**Signature:**
-
-```typescript
-readonly DETAILS: Details;
-```

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

@@ -1,269 +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)
-
-## EVENT\_LOGIN\_AUTH\_ACK interface
-
-
-**Signature:**
-
-```typescript
-export interface EVENT_LOGIN_AUTH_ACK extends ACK 
-```
-**Extends:** ACK
-
-## 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_login_auth_ack.details.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-Details
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[PERMISSION](./foundation-auth.event_login_auth_ack.permission.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[PROFILE](./foundation-auth.event_login_auth_ack.profile.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[REFRESH\_AUTH\_TOKEN](./foundation-auth.event_login_auth_ack.refresh_auth_token.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[SESSION\_AUTH\_TOKEN](./foundation-auth.event_login_auth_ack.session_auth_token.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Keeping these 3 here for now as I'm assuming these DTOs will be autogenerated at some point and will contain these.
-
-
-</td></tr>
-<tr><td>
-
-[SESSION\_ID](./foundation-auth.event_login_auth_ack.session_id.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[UPDATE\_QUEUE](./foundation-auth.event_login_auth_ack.update_queue.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[USER\_NAME](./foundation-auth.event_login_auth_ack.user_name.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[USER](./foundation-auth.event_login_auth_ack.user.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-{ \[key: string\]: any; }
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[ZERO\_MQ\_PROXY\_INBOUND\_PORT](./foundation-auth.event_login_auth_ack.zero_mq_proxy_inbound_port.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[ZERO\_MQ\_PROXY\_MODE\_ENABLED](./foundation-auth.event_login_auth_ack.zero_mq_proxy_mode_enabled.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[ZERO\_MQ\_PROXY\_OUTBOUND\_PORT](./foundation-auth.event_login_auth_ack.zero_mq_proxy_outbound_port.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-auth.event_login_auth_ack.permission.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; [PERMISSION](./foundation-auth.event_login_auth_ack.permission.md)
-
-## EVENT\_LOGIN\_AUTH\_ACK.PERMISSION property
-
-**Signature:**
-
-```typescript
-readonly PERMISSION: string[];
-```

package/docs/api/foundation-auth.event_login_auth_ack.profile.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; [PROFILE](./foundation-auth.event_login_auth_ack.profile.md)
-
-## EVENT\_LOGIN\_AUTH\_ACK.PROFILE property
-
-**Signature:**
-
-```typescript
-readonly PROFILE: string[];
-```