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

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

@@ -1,40 +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; [MessageMapper](./foundation-auth.messagemapper.md)
-
-## MessageMapper interface
-
-
-**Signature:**
-
-```typescript
-export interface MessageMapper<TLookup extends MessageMapperLookup, K extends keyof TLookup = keyof TLookup> extends Pick<Map<K, TLookup[K]>, 'get' | 'has' | 'delete' | 'clear' | 'size'> 
-```
-**Extends:** Pick&lt;Map&lt;K, TLookup\[K\]&gt;, 'get' \| 'has' \| 'delete' \| 'clear' \| 'size'&gt;
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[set(key, mapper)](./foundation-auth.messagemapper.set.md)
-
-
-</td><td>
-
-Set a mapper by message type.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-auth.messagemapper.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; [MessageMapper](./foundation-auth.messagemapper.md) &gt; [set](./foundation-auth.messagemapper.set.md)
-
-## MessageMapper.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.messagemapperlookup.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; [MessageMapperLookup](./foundation-auth.messagemapperlookup.md)
-
-## MessageMapperLookup type
-
-
-**Signature:**
-
-```typescript
-export type MessageMapperLookup = Record<string, Mapper<unknown, unknown>>;
-```
-**References:** [Mapper](./foundation-auth.mapper.md)
-

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

@@ -1,20 +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; [MFACredentials](./foundation-auth.mfacredentials.md)
-
-## MFACredentials type
-
-**Signature:**
-
-```typescript
-export type MFACredentials = {
-    type: CredentialType & CredentialType.MFA;
-    mfaToken: string;
-};
-```
-**References:** [CredentialType](./foundation-auth.credentialtype_2.md)<!-- -->, [CredentialType.MFA](./foundation-auth.credentialtype_2.md)
-
-## Remarks
-
-Will be sourced from MFA\_CODE in url params.
-

package/docs/api/foundation-auth.passwordmanagementdto.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; [PasswordManagementDTO](./foundation-auth.passwordmanagementdto.md)
-
-## PasswordManagementDTO type
-
-PasswordManagementDTO type.
-
-**Signature:**
-
-```typescript
-export type PasswordManagementDTO = EVENT_SELF_SERVICE_PASSWORD_RESET | EVENT_CHANGE_USER_PASSWORD | EVENT_PASSWORD_RESET_ACTION;
-```
-**References:** [EVENT\_SELF\_SERVICE\_PASSWORD\_RESET](./foundation-auth.event_self_service_password_reset.md)<!-- -->, [EVENT\_CHANGE\_USER\_PASSWORD](./foundation-auth.event_change_user_password.md)<!-- -->, [EVENT\_PASSWORD\_RESET\_ACTION](./foundation-auth.event_password_reset_action.md)
-

package/docs/api/foundation-auth.passwordmanagemententity.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; [PasswordManagementEntity](./foundation-auth.passwordmanagemententity.md)
-
-## PasswordManagementEntity type
-
-PasswordManagementEntity type.
-
-**Signature:**
-
-```typescript
-export type PasswordManagementEntity = ForgotPasswordParams | ChangePasswordParams | ResetPasswordParams;
-```
-**References:** [ForgotPasswordParams](./foundation-auth.forgotpasswordparams.md)<!-- -->, [ChangePasswordParams](./foundation-auth.changepasswordparams.md)<!-- -->, [ResetPasswordParams](./foundation-auth.resetpasswordparams.md)
-

package/docs/api/foundation-auth.passwordmanagementmapper.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; [PasswordManagementMapper](./foundation-auth.passwordmanagementmapper.md)
-
-## PasswordManagementMapper interface
-
-PasswordManagementMapper interface.
-
-**Signature:**
-
-```typescript
-export interface PasswordManagementMapper extends Mapper<PasswordManagementDTO, PasswordManagementEntity> 
-```
-**Extends:** [Mapper](./foundation-auth.mapper.md)<!-- -->&lt;[PasswordManagementDTO](./foundation-auth.passwordmanagementdto.md)<!-- -->, [PasswordManagementEntity](./foundation-auth.passwordmanagemententity.md)<!-- -->&gt;
-
-## Remarks
-
-A mapper for the self-service password management flows.
-

package/docs/api/foundation-auth.product.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; [Product](./foundation-auth.product.md)
-
-## Product interface
-
-> Warning: This API is now obsolete.
-> 
-> - Use @<!-- -->genesislcap/foundation-user\#UserDetailsProductProperty instead.
-> 
-
-**Signature:**
-
-```typescript
-export interface Product extends UserDetailsProductProperty 
-```
-**Extends:** UserDetailsProductProperty
-

package/docs/api/foundation-auth.queryparams.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; [QueryParams](./foundation-auth.queryparams.md)
-
-## QueryParams type
-
-
-**Signature:**
-
-```typescript
-export type QueryParams = {
-    SSO_TOKEN?: string;
-    MFA_CODE?: string;
-};
-```

package/docs/api/foundation-auth.refreshcredentials.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; [RefreshCredentials](./foundation-auth.refreshcredentials.md)
-
-## RefreshCredentials type
-
-
-**Signature:**
-
-```typescript
-export type RefreshCredentials = {
-    type: CredentialType & CredentialType.REFRESH;
-    username?: string;
-    refreshToken?: string;
-};
-```
-**References:** [CredentialType](./foundation-auth.credentialtype_2.md)<!-- -->, [CredentialType.REFRESH](./foundation-auth.credentialtype_2.md)
-

package/docs/api/foundation-auth.resetpasswordparams.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; [ResetPasswordParams](./foundation-auth.resetpasswordparams.md)
-
-## ResetPasswordParams type
-
-
-**Signature:**
-
-```typescript
-export type ResetPasswordParams = {
-    username: string;
-    resetToken: string;
-    newPassword: string;
-    requester?: string;
-};
-```

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

@@ -1,25 +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; [setError](./foundation-auth.seterror.md)
-
-## setError variable
-
-Set error action.
-
-**Signature:**
-
-```typescript
-setError: {
-    (_: import("xstate").ActionArgs<import("xstate").MachineContext, import("xstate").EventObject, import("xstate").ParameterizedObject>): void;
-    type: string;
-    assignment: import("xstate").Assigner<import("xstate").MachineContext, import("xstate").EventObject> | import("xstate").PropertyAssigner<import("xstate").MachineContext, import("xstate").EventObject>;
-    resolve: (actorContext: import("xstate").AnyActorContext, state: import("xstate").AnyState, actionArgs: import("xstate").ActionArgs<any, any>, { assignment }: {
-        assignment: import("xstate").Assigner<any, any> | import("xstate").PropertyAssigner<any, any>;
-    }) => import("xstate").AnyState[];
-}
-```
-
-## Remarks
-
-Used to set a top level error on the machine. This may equal to @<!-- -->genesislcap/foundation-utils\#ErrorMap `lastError` in the `errors` property.
-

package/docs/api/foundation-auth.settings.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; [Settings](./foundation-auth.settings.md)
-
-## Settings type
-
-Defines the parameters you may set on the routes.
-
-**Signature:**
-
-```typescript
-export type Settings = {
-    public?: boolean;
-};
-```

package/docs/api/foundation-auth.ssoconfig.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; [SSOConfig](./foundation-auth.ssoconfig.md)
-
-## SSOConfig type
-
-
-**Signature:**
-
-```typescript
-export type SSOConfig = {
-    toggled?: boolean;
-};
-```

package/docs/api/foundation-auth.ssocredentials.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; [SSOCredentials](./foundation-auth.ssocredentials.md)
-
-## SSOCredentials type
-
-
-**Signature:**
-
-```typescript
-export type SSOCredentials = {
-    type: CredentialType & CredentialType.SSO;
-    ssoToken: string;
-};
-```
-**References:** [CredentialType](./foundation-auth.credentialtype_2.md)<!-- -->, [CredentialType.SSO](./foundation-auth.credentialtype_2.md)
-

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

@@ -1,12 +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; [styles](./foundation-auth.styles.md)
-
-## styles variable
-
-
-**Signature:**
-
-```typescript
-styles: import("@microsoft/fast-element").ElementStyles
-```

package/docs/api/foundation-auth.system.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; [System](./foundation-auth.system.md)
-
-## System interface
-
-> Warning: This API is now obsolete.
-> 
-> - Use @<!-- -->genesislcap/foundation-user\#UserDetailsSystemProperty instead.
-> 
-
-**Signature:**
-
-```typescript
-export interface System extends UserDetailsSystemProperty 
-```
-**Extends:** UserDetailsSystemProperty
-

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

@@ -1,12 +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; [template](./foundation-auth.template.md)
-
-## template variable
-
-
-**Signature:**
-
-```typescript
-template: import("@microsoft/fast-element").ViewTemplate<FoundationAuth, any>
-```

package/docs/api/foundation-auth.termsconditionsparams.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; [TermsConditionsParams](./foundation-auth.termsconditionsparams.md)
-
-## TermsConditionsParams type
-
-
-**Signature:**
-
-```typescript
-export type TermsConditionsParams = {
-    username: string;
-    termsAgreed: boolean;
-    version: string;
-};
-```

package/docs/api/index.md

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md)
-
-## API Reference
-
-## Packages
-
-<table><thead><tr><th>
-
-Package
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[@genesislcap/foundation-auth](./foundation-auth.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-