@genesislcap/foundation-auth 14.71.1-auth-mf.3 → 14.71.1-auth-mf.4

package/dist/foundation-auth.d.ts

@@ -17,6 +17,7 @@ import { EmitReturn } from '@genesislcap/foundation-events';
 import type { ErrorEvent as ErrorEvent_2 } from 'xstate';
 import { FASTElement } from '@microsoft/fast-element';
 import { FetchMachine } from '@genesislcap/foundation-state-machine';
+import { FetchMachineEvent } from '@genesislcap/foundation-state-machine';
 import { FoundationAnalytics } from '@genesislcap/foundation-comms';
 import { GenesisServerError } from '@genesislcap/foundation-state-machine';
 import { InterfaceSymbol } from '@microsoft/fast-foundation';
@@ -28,6 +29,7 @@ import { Machine } from '@genesislcap/foundation-state-machine';
 import type { MachineContext } from '@genesislcap/foundation-state-machine';
 import { Message as Message_2 } from '@genesislcap/foundation-comms';
 import { MessageBuilder } from '@genesislcap/foundation-comms';
+import { NavigationPhase } from '@microsoft/fast-router';
 import { PartialFASTElementDefinition } from '@microsoft/fast-element';
 import { RouterConfiguration } from '@microsoft/fast-router';
 import { Session } from '@genesislcap/foundation-comms';
@@ -55,7 +57,14 @@ declare interface Ack extends Message {
  * @public
  */
 export declare class Auth extends Auth_base {
+    /**
+     * @internal
+     */
     store: AuthStore;
+    /**
+     * @internal
+     */
+    cm: CredentialManager;
     /**
      * Configuration for the routes and their associated settings.
      * The client would override this in their app with their own settings to set
@@ -92,7 +101,7 @@ export declare class Auth extends Auth_base {
      */
     disconnectedCallback(): void;
     /**
-     * Used to forward the user onto a logged-in session during an SSO journey
+     * Used to forward the user onto a logged-in session during an SSO and MFA journeys
      *
      * @remarks
      *
@@ -113,7 +122,7 @@ export declare class Auth extends Auth_base {
      *
      * @internal
      */
-    checkForSSOToken(): void;
+    actionQueryParams(): void;
     /**
      * Called from the connectedCallback
      * @internal
@@ -135,10 +144,13 @@ export declare class Auth extends Auth_base {
      * @internal
      */
     protected readyStore(): void;
+    loginWithCredentials(credentials: AuthInfo): void;
+    loginWithCookies(): void;
+    logout(): void;
 }
 
 declare const Auth_base: abstract new (...args: any[]) => {
-    $emit<K extends "store-connected" | "store-disconnected" | "store-ready" | "auth-machine-event" | "auth-login" | "auth-login-refresh" | "auth-login-details" | "auth-logout">(...args: AuthEventMap[K] extends void ? [type: K, options?: EmitOptions] : [type: K, detail: AuthEventMap[K], options?: EmitOptions]): EmitReturn;
+    $emit<K extends "store-connected" | "store-disconnected" | "store-ready" | "auth-machine-event" | "auth-login" | "auth-login-details" | "auth-logout">(...args: AuthEventMap[K] extends void ? [type: K, options?: EmitOptions] : [type: K, detail: AuthEventMap[K], options?: EmitOptions]): EmitReturn;
     accessKey: string;
     readonly accessKeyLabel: string;
     autocapitalize: string;
@@ -613,7 +625,6 @@ export declare class AuthError extends GenesisServerError {
  */
 export declare type AuthEventMap = StoreRootEventDetailMap & AuthMachineEventMap & {
     'auth-login': AuthInfo;
-    'auth-login-refresh': void;
     'auth-login-details': void;
     'auth-logout': void;
 };
@@ -622,6 +633,7 @@ export declare type AuthEventMap = StoreRootEventDetailMap & AuthMachineEventMap
  * @public
  */
 export declare type AuthFormEntryEventMap = {
+    'auth-autofill-form': void;
     'auth-organisation-changed': string;
     'auth-username-changed': string;
     'auth-email-changed': string;
@@ -658,6 +670,7 @@ export declare interface AuthFormEntryStore extends Store {
     onPasswordChanged(event: CustomEvent<string>): void;
     onPassword2Changed(event: CustomEvent<string>): void;
     onShowPasswordsChanged(event: CustomEvent<boolean>): void;
+    onAutofillForm(event: CustomEvent<void>): void;
 }
 
 /**
@@ -699,15 +712,15 @@ export declare interface AuthMachineContext extends MachineContext {
     /**
      * The authentication credentials.
      * @remarks
-     * These are optional as it may be possible to reauthenticate using a refresh token.
+     * Optional as it's possible to reauthenticate silently.
      */
     credentials?: AuthInfo;
     /**
-     * The login/login/refresh DTO from the fetch machine.
+     * The login/login DTO from the fetch machine.
      */
     authDTO: AuthDTO;
     /**
-     * The login/login/refresh Entity mapped from the DTO.
+     * The login/login Entity mapped from the DTO.
      */
     authEntity: AuthEntity;
     /**
@@ -731,8 +744,6 @@ export declare type AuthMachineEvent = {
     params: {
         credentials?: AuthInfo;
     };
-} | {
-    type: 'refresh';
 } | {
     type: 'logout';
 } | {
@@ -771,6 +782,7 @@ export declare interface AuthStore extends StoreRoot {
      */
     onMachineEvent(event: CustomEvent<AuthEventMap['auth-machine-event']>): void;
     onLogin(event: CustomEvent<AuthInfo>): void;
+    onLoginDetails(event: CustomEvent<void>): void;
     onLogout(event: CustomEvent<void>): void;
 }
 
@@ -816,7 +828,9 @@ export declare class BaseRoute extends ConfigHostElement {
     message: string;
     hasErrors: boolean;
     isSubmitting: boolean;
+    protected navigationPhase: NavigationPhase<Settings>;
     connectedCallback(): void;
+    enter(phase: NavigationPhase<Settings>): void;
     onSubmit(): Promise<void>;
     ensureConnection(): Promise<boolean>;
     setError(message: string): void;
@@ -850,7 +864,7 @@ export declare class ConfigHostElement extends ConfigHostElement_base implements
 }
 
 declare const ConfigHostElement_base: abstract new (...args: any[]) => {
-    $emit<K extends "auth-organisation-changed" | "auth-username-changed" | "auth-email-changed" | "auth-password-changed" | "auth-password2-changed" | "auth-showPasswords-changed" | "store-connected" | "store-disconnected" | "store-ready" | "auth-machine-event" | "auth-login" | "auth-login-refresh" | "auth-login-details" | "auth-logout">(...args: EventMap[K] extends void ? [type: K, options?: EmitOptions] : [type: K, detail: EventMap[K], options?: EmitOptions]): EmitReturn;
+    $emit<K extends "auth-autofill-form" | "auth-organisation-changed" | "auth-username-changed" | "auth-email-changed" | "auth-password-changed" | "auth-password2-changed" | "auth-showPasswords-changed" | "store-connected" | "store-disconnected" | "store-ready" | "auth-machine-event" | "auth-login" | "auth-login-details" | "auth-logout">(...args: EventMap[K] extends void ? [type: K, options?: EmitOptions] : [type: K, detail: EventMap[K], options?: EmitOptions]): EmitReturn;
     accessKey: string;
     readonly accessKeyLabel: string;
     autocapitalize: string;
@@ -935,13 +949,7 @@ declare const ConfigHostElement_base: abstract new (...args: any[]) => {
     scrollBy(options?: ScrollToOptions): void;
     scrollBy(x: number, y: number): void;
     scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
-    /**
-     * @internal
-     */
     scrollTo(options?: ScrollToOptions): void;
-    /**
-     * @internal
-     */
     scrollTo(x: number, y: number): void;
     setAttribute(qualifiedName: string, value: string): void;
     setAttributeNS(namespace: string, qualifiedName: string, value: string): void;
@@ -1171,14 +1179,6 @@ declare const ConfigHostElement_base: abstract new (...args: any[]) => {
     attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
 };
 
-/**
- * @internal
- * @privateRemarks
- * Potential optimisation ahead of workflow / statemachine based smart forms integration, but needs tagFor.
- * Feels a bit at odds with the declarative nature we're aiming for, but will await review.
- */
-export declare const configurableTextField: <T extends ConfigHost>(name: keyof FieldConfigMap | [name: keyof FieldConfigMap, valueKey: string], type: string, autofocus?: boolean, autocomplete?: string, className?: string, labelOverride?: string, testIdOverride?: string, required?: boolean) => ViewTemplate<T, any>;
-
 /**
  * Configure the auth micro frontend settings.
  *
@@ -1268,6 +1268,7 @@ export declare class DefaultAuthFormEntryStore extends AbstractStore<AuthFormEnt
     onPasswordChanged: EventListener;
     onPassword2Changed: EventListener;
     onShowPasswordsChanged: EventListener;
+    onAutofillForm: EventListener;
 }
 
 /**
@@ -1290,6 +1291,16 @@ export declare class DefaultAuthMachine extends AbstractMachine<AuthMachineConte
      * AuthMachine is a singleton.
      */
     getFromContainer(): this;
+    createFetchMachineEvent(url: string, msg?: Message_2): FetchMachineEvent;
+    addLoginEvents(): {
+        login: {
+            actions: string[];
+            target: string;
+        };
+        "login-details": {
+            target: string;
+        };
+    };
 }
 
 /**
@@ -1310,6 +1321,7 @@ export declare class DefaultAuthStore extends AbstractStoreRoot<AuthStore, AuthE
     get isPending(): boolean;
     onMachineEvent: EventListener;
     onLogin: EventListener;
+    onLoginDetails: EventListener;
     onLogout: EventListener;
 }
 
@@ -1517,6 +1529,12 @@ export declare interface EVENT_LOGIN_AUTH_ACK extends ACK {
 export declare interface EVENT_LOGIN_AUTH_NACK extends NACK {
 }
 
+/**
+ * @public
+ */
+export declare interface EVENT_LOGIN_DETAILS_ACK extends EVENT_LOGIN_AUTH_ACK {
+}
+
 /**
  * @public
  */
@@ -1673,6 +1691,20 @@ export declare function isLoginAckDTO(dto: LoginDTO): dto is EVENT_LOGIN_AUTH_AC
  */
 export declare function isLoginAckEntity(entity: LoginEntity): entity is LoginAck;
 
+/**
+ * isLoginDetailsAckDTO.
+ * @param dto - Potential DTO.
+ * @public
+ */
+export declare function isLoginDetailsAckDTO(dto: LoginDTO): dto is EVENT_LOGIN_DETAILS_ACK;
+
+/**
+ * isLoginDetailsAckEntity.
+ * @param entity - Potential entity.
+ * @public
+ */
+export declare function isLoginDetailsAckEntity(entity: LoginEntity): entity is LoginDetailsAck;
+
 /**
  * isLoginNackDTO.
  * @param dto - Potential DTO.
@@ -1766,17 +1798,23 @@ export declare interface LoginAck extends Ack {
     readonly profile: string[];
 }
 
+/**
+ * @public
+ */
+export declare interface LoginDetailsAck extends LoginAck {
+}
+
 /**
  * LoginDTO type.
  * @public
  */
-export declare type LoginDTO = EVENT_LOGIN_AUTH_ACK | EVENT_LOGIN_AUTH_NACK;
+export declare type LoginDTO = EVENT_LOGIN_AUTH_ACK | EVENT_LOGIN_DETAILS_ACK | EVENT_LOGIN_AUTH_NACK;
 
 /**
  * LoginEntity type.
  * @public
  */
-export declare type LoginEntity = LoginAck | LoginNack;
+export declare type LoginEntity = LoginAck | LoginDetailsAck | LoginNack;
 
 /**
  * LoginMapper interface.

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

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [Auth](./foundation-auth.auth.md) &gt; [loginWithCookies](./foundation-auth.auth.loginwithcookies.md)
+
+## Auth.loginWithCookies() method
+
+**Signature:**
+
+```typescript
+loginWithCookies(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [Auth](./foundation-auth.auth.md) &gt; [loginWithCredentials](./foundation-auth.auth.loginwithcredentials.md)
+
+## Auth.loginWithCredentials() method
+
+**Signature:**
+
+```typescript
+loginWithCredentials(credentials: AuthInfo): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  credentials | AuthInfo |  |
+
+**Returns:**
+
+void
+

package/docs/api/{foundation-auth.auth.store.md → foundation-auth.auth.logout.md}

@@ -1,11 +1,15 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [Auth](./foundation-auth.auth.md) &gt; [store](./foundation-auth.auth.store.md)
+[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [Auth](./foundation-auth.auth.md) &gt; [logout](./foundation-auth.auth.logout.md)
 
-## Auth.store property
+## Auth.logout() method
 
 **Signature:**
 
 ```typescript
-store: AuthStore;
+logout(): void;
 ```
+**Returns:**
+
+void
+

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

@@ -12,9 +12,11 @@ export declare class Auth extends Auth_base
 ```
 **Extends:** Auth\_base
 
-## Properties
+## Methods
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [store](./foundation-auth.auth.store.md) |  | [AuthStore](./foundation-auth.authstore.md) |  |
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [loginWithCookies()](./foundation-auth.auth.loginwithcookies.md) |  |  |
+|  [loginWithCredentials(credentials)](./foundation-auth.auth.loginwithcredentials.md) |  |  |
+|  [logout()](./foundation-auth.auth.logout.md) |  |  |
 

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

@@ -10,7 +10,6 @@
 ```typescript
 export type AuthEventMap = StoreRootEventDetailMap & AuthMachineEventMap & {
     'auth-login': AuthInfo;
-    'auth-login-refresh': void;
     'auth-login-details': void;
     'auth-logout': void;
 };

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

@@ -9,6 +9,7 @@
 
 ```typescript
 export type AuthFormEntryEventMap = {
+    'auth-autofill-form': void;
     'auth-organisation-changed': string;
     'auth-username-changed': string;
     'auth-email-changed': string;

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

@@ -39,6 +39,7 @@ export interface AuthFormEntryStore extends Store
 
 |  Method | Description |
 |  --- | --- |
+|  [onAutofillForm(event)](./foundation-auth.authformentrystore.onautofillform.md) |  |
 |  [onEmailChanged(event)](./foundation-auth.authformentrystore.onemailchanged.md) |  |
 |  [onOrganisationChanged(event)](./foundation-auth.authformentrystore.onorganisationchanged.md) |  |
 |  [onPassword2Changed(event)](./foundation-auth.authformentrystore.onpassword2changed.md) |  |

package/docs/api/foundation-auth.authformentrystore.onautofillform.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthFormEntryStore](./foundation-auth.authformentrystore.md) &gt; [onAutofillForm](./foundation-auth.authformentrystore.onautofillform.md)
+
+## AuthFormEntryStore.onAutofillForm() method
+
+**Signature:**
+
+```typescript
+onAutofillForm(event: CustomEvent<void>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  event | CustomEvent&lt;void&gt; |  |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-auth.authmachinecontext.authdto.md

@@ -4,7 +4,7 @@
 
 ## AuthMachineContext.authDTO property
 
-The login/login/refresh DTO from the fetch machine.
+The login/login DTO from the fetch machine.
 
 **Signature:**
 

package/docs/api/foundation-auth.authmachinecontext.authentity.md

@@ -4,7 +4,7 @@
 
 ## AuthMachineContext.authEntity property
 
-The login/login/refresh Entity mapped from the DTO.
+The login/login Entity mapped from the DTO.
 
 **Signature:**
 

package/docs/api/foundation-auth.authmachinecontext.credentials.md

@@ -14,5 +14,5 @@ credentials?: AuthInfo;
 
 ## Remarks
 
-These are optional as it may be possible to reauthenticate using a refresh token.
+Optional as it's possible to reauthenticate silently.
 

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

@@ -21,8 +21,8 @@ Transient state during the machine's execution.
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [authDTO](./foundation-auth.authmachinecontext.authdto.md) |  | [AuthDTO](./foundation-auth.authdto.md) | The login/login/refresh DTO from the fetch machine. |
-|  [authEntity](./foundation-auth.authmachinecontext.authentity.md) |  | [AuthEntity](./foundation-auth.authentity.md) | The login/login/refresh Entity mapped from the DTO. |
+|  [authDTO](./foundation-auth.authmachinecontext.authdto.md) |  | [AuthDTO](./foundation-auth.authdto.md) | The login/login DTO from the fetch machine. |
+|  [authEntity](./foundation-auth.authmachinecontext.authentity.md) |  | [AuthEntity](./foundation-auth.authentity.md) | The login/login Entity mapped from the DTO. |
 |  [credentials?](./foundation-auth.authmachinecontext.credentials.md) |  | AuthInfo | _(Optional)_ The authentication credentials. |
 |  [mapper](./foundation-auth.authmachinecontext.mapper.md) |  | [Mapper](./foundation-auth.mapper.md)<!-- -->&lt;[AuthDTO](./foundation-auth.authdto.md)<!-- -->, [AuthEntity](./foundation-auth.authentity.md)<!-- -->&gt; | The mapper for the action being taken. |
 |  [user](./foundation-auth.authmachinecontext.user.md) |  | [User](./foundation-auth.user.md) | The user, either authenticated or anonymous. |

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

@@ -14,8 +14,6 @@ export type AuthMachineEvent = {
     params: {
         credentials?: AuthInfo;
     };
-} | {
-    type: 'refresh';
 } | {
     type: 'logout';
 } | {

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

@@ -30,6 +30,7 @@ This is the root store for the foundation-auth package.
 |  Method | Description |
 |  --- | --- |
 |  [onLogin(event)](./foundation-auth.authstore.onlogin.md) |  |
+|  [onLoginDetails(event)](./foundation-auth.authstore.onlogindetails.md) |  |
 |  [onLogout(event)](./foundation-auth.authstore.onlogout.md) |  |
 |  [onMachineEvent(event)](./foundation-auth.authstore.onmachineevent.md) |  |
 

package/docs/api/foundation-auth.authstore.onlogindetails.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [AuthStore](./foundation-auth.authstore.md) &gt; [onLoginDetails](./foundation-auth.authstore.onlogindetails.md)
+
+## AuthStore.onLoginDetails() method
+
+**Signature:**
+
+```typescript
+onLoginDetails(event: CustomEvent<void>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  event | CustomEvent&lt;void&gt; |  |
+
+**Returns:**
+
+void
+

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

@@ -34,6 +34,7 @@ export declare class DefaultAuthFormEntryStore extends AbstractStore<AuthFormEnt
 |  [idps](./foundation-auth.defaultauthformentrystore.idps.md) |  | [IDP](./foundation-auth.idp.md)<!-- -->\[\] |  |
 |  [message](./foundation-auth.defaultauthformentrystore.message.md) |  | string |  |
 |  [mfaCode](./foundation-auth.defaultauthformentrystore.mfacode.md) |  | string |  |
+|  [onAutofillForm](./foundation-auth.defaultauthformentrystore.onautofillform.md) |  | EventListener |  |
 |  [onEmailChanged](./foundation-auth.defaultauthformentrystore.onemailchanged.md) |  | EventListener |  |
 |  [onOrganisationChanged](./foundation-auth.defaultauthformentrystore.onorganisationchanged.md) |  | EventListener |  |
 |  [onPassword2Changed](./foundation-auth.defaultauthformentrystore.onpassword2changed.md) |  | EventListener |  |

package/docs/api/foundation-auth.defaultauthformentrystore.onautofillform.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultAuthFormEntryStore](./foundation-auth.defaultauthformentrystore.md) &gt; [onAutofillForm](./foundation-auth.defaultauthformentrystore.onautofillform.md)
+
+## DefaultAuthFormEntryStore.onAutofillForm property
+
+**Signature:**
+
+```typescript
+onAutofillForm: EventListener;
+```

package/docs/api/foundation-auth.defaultauthmachine.addloginevents.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultAuthMachine](./foundation-auth.defaultauthmachine.md) &gt; [addLoginEvents](./foundation-auth.defaultauthmachine.addloginevents.md)
+
+## DefaultAuthMachine.addLoginEvents() method
+
+**Signature:**
+
+```typescript
+addLoginEvents(): {
+        login: {
+            actions: string[];
+            target: string;
+        };
+        "login-details": {
+            target: string;
+        };
+    };
+```
+**Returns:**
+
+{ login: { actions: string\[\]; target: string; }; "login-details": { target: string; }; }
+

package/docs/api/foundation-auth.defaultauthmachine.createfetchmachineevent.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultAuthMachine](./foundation-auth.defaultauthmachine.md) &gt; [createFetchMachineEvent](./foundation-auth.defaultauthmachine.createfetchmachineevent.md)
+
+## DefaultAuthMachine.createFetchMachineEvent() method
+
+**Signature:**
+
+```typescript
+createFetchMachineEvent(url: string, msg?: Message): FetchMachineEvent;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  url | string |  |
+|  msg | Message | _(Optional)_ |
+
+**Returns:**
+
+FetchMachineEvent
+

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

@@ -25,6 +25,8 @@ export declare class DefaultAuthMachine extends AbstractMachine<AuthMachineConte
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
+|  [addLoginEvents()](./foundation-auth.defaultauthmachine.addloginevents.md) |  |  |
+|  [createFetchMachineEvent(url, msg)](./foundation-auth.defaultauthmachine.createfetchmachineevent.md) |  |  |
 |  [getFromContainer()](./foundation-auth.defaultauthmachine.getfromcontainer.md) |  | AuthMachine is a singleton. |
 |  [start(options)](./foundation-auth.defaultauthmachine.start.md) |  |  |
 

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

@@ -30,6 +30,7 @@ export declare class DefaultAuthStore extends AbstractStoreRoot<AuthStore, AuthE
 |  [formEntry](./foundation-auth.defaultauthstore.formentry.md) | <code>readonly</code> | [AuthFormEntryStore](./foundation-auth.authformentrystore.md) |  |
 |  [isPending](./foundation-auth.defaultauthstore.ispending.md) | <code>readonly</code> | boolean |  |
 |  [onLogin](./foundation-auth.defaultauthstore.onlogin.md) |  | EventListener |  |
+|  [onLoginDetails](./foundation-auth.defaultauthstore.onlogindetails.md) |  | EventListener |  |
 |  [onLogout](./foundation-auth.defaultauthstore.onlogout.md) |  | EventListener |  |
 |  [onMachineEvent](./foundation-auth.defaultauthstore.onmachineevent.md) |  | EventListener |  |
 

package/docs/api/foundation-auth.defaultauthstore.onlogindetails.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultAuthStore](./foundation-auth.defaultauthstore.md) &gt; [onLoginDetails](./foundation-auth.defaultauthstore.onlogindetails.md)
+
+## DefaultAuthStore.onLoginDetails property
+
+**Signature:**
+
+```typescript
+onLoginDetails: EventListener;
+```

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

@@ -0,0 +1,14 @@
+<!-- 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.islogindetailsackdto.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [isLoginDetailsAckDTO](./foundation-auth.islogindetailsackdto.md)
+
+## isLoginDetailsAckDTO() function
+
+isLoginDetailsAckDTO.
+
+**Signature:**
+
+```typescript
+export declare function isLoginDetailsAckDTO(dto: LoginDTO): dto is EVENT_LOGIN_DETAILS_ACK;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  dto | [LoginDTO](./foundation-auth.logindto.md) | Potential DTO. |
+
+**Returns:**
+
+dto is [EVENT\_LOGIN\_DETAILS\_ACK](./foundation-auth.event_login_details_ack.md)
+

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

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [isLoginDetailsAckEntity](./foundation-auth.islogindetailsackentity.md)
+
+## isLoginDetailsAckEntity() function
+
+isLoginDetailsAckEntity.
+
+**Signature:**
+
+```typescript
+export declare function isLoginDetailsAckEntity(entity: LoginEntity): entity is LoginDetailsAck;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  entity | [LoginEntity](./foundation-auth.loginentity.md) | Potential entity. |
+
+**Returns:**
+
+entity is [LoginDetailsAck](./foundation-auth.logindetailsack.md)
+

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

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [LoginDetailsAck](./foundation-auth.logindetailsack.md)
+
+## LoginDetailsAck interface
+
+
+**Signature:**
+
+```typescript
+export interface LoginDetailsAck extends LoginAck 
+```
+**Extends:** [LoginAck](./foundation-auth.loginack.md)
+