@genesislcap/foundation-auth 14.71.1-auth-mf.21 → 14.103.0-auth-mf.23

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

@@ -4,7 +4,7 @@
 
 ## isNackDTO() function
 
-isDTONack.
+isNackDTO.
 
 **Signature:**
 

package/docs/api/foundation-auth.isnackentity.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; [isNackEntity](./foundation-auth.isnackentity.md)
+
+## isNackEntity() function
+
+isNackEntity.
+
+**Signature:**
+
+```typescript
+export declare function isNackEntity(entity: unknown): entity is Nack;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  entity | unknown | Potential Nack. |
+
+**Returns:**
+
+entity is Nack
+

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

@@ -8,5 +8,5 @@
 **Signature:**
 
 ```typescript
-logger: import("@genesislcap/foundation-utils").Logger
+logger: import("@genesislcap/foundation-logger").Logger
 ```

package/docs/api/foundation-auth.loginnack.hasincorrectcredentials.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; [LoginNack](./foundation-auth.loginnack.md) &gt; [hasIncorrectCredentials](./foundation-auth.loginnack.hasincorrectcredentials.md)
+
+## LoginNack.hasIncorrectCredentials property
+
+**Signature:**
+
+```typescript
+readonly hasIncorrectCredentials: boolean;
+```

package/docs/api/foundation-auth.loginnack.maxtriesreached.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; [LoginNack](./foundation-auth.loginnack.md) &gt; [maxTriesReached](./foundation-auth.loginnack.maxtriesreached.md)
+
+## LoginNack.maxTriesReached property
+
+**Signature:**
+
+```typescript
+readonly maxTriesReached: boolean;
+```

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

@@ -16,7 +16,9 @@ export interface LoginNack extends Nack
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
+|  [hasIncorrectCredentials](./foundation-auth.loginnack.hasincorrectcredentials.md) | <code>readonly</code> | boolean |  |
 |  [hasPasswordExpired](./foundation-auth.loginnack.haspasswordexpired.md) | <code>readonly</code> | boolean |  |
 |  [isMFARequired](./foundation-auth.loginnack.ismfarequired.md) | <code>readonly</code> | boolean |  |
+|  [maxTriesReached](./foundation-auth.loginnack.maxtriesreached.md) | <code>readonly</code> | boolean |  |
 |  [refreshAuthToken](./foundation-auth.loginnack.refreshauthtoken.md) | <code>readonly</code> | string |  |
 

package/docs/api/foundation-auth.md

@@ -8,11 +8,10 @@
 
 |  Class | Description |
 |  --- | --- |
-|  [DefaultAuthFormEntryStore](./foundation-auth.defaultauthformentrystore.md) | Default implementation of the store. |
+|  [DefaultAuthFormEntryStore](./foundation-auth.defaultauthformentrystore.md) | Default AuthFormEntryStore. |
 |  [DefaultAuthMachine](./foundation-auth.defaultauthmachine.md) | Default AuthMachine. |
 |  [DefaultAuthMessageMapper](./foundation-auth.defaultauthmessagemapper.md) | Default AuthMessageMapper. |
-|  [DefaultAuthRouting](./foundation-auth.defaultauthrouting.md) | Default AuthRouting. |
-|  [DefaultAuthStore](./foundation-auth.defaultauthstore.md) | Default implementation of the store. |
+|  [DefaultAuthStore](./foundation-auth.defaultauthstore.md) | Default AuthStore. |
 |  [DefaultCredentialManager](./foundation-auth.defaultcredentialmanager.md) | Default CredentialManager. |
 |  [DefaultLoginMapper](./foundation-auth.defaultloginmapper.md) | Default LoginMapper. |
 |  [DefaultLogoutMapper](./foundation-auth.defaultlogoutmapper.md) | Default LogoutMapper. |
@@ -35,7 +34,6 @@
 |  --- | --- |
 |  [configure(config)](./foundation-auth.configure.md) | configure. |
 |  [createHTTPHeadersFromDTO(dto, contentType)](./foundation-auth.createhttpheadersfromdto.md) | createHTTPHeadersFromDTO. |
-|  [getAuthRouting()](./foundation-auth.getauthrouting.md) | Gets AuthRouting from the DI container. |
 |  [getRoutePath(route, hostPath)](./foundation-auth.getroutepath.md) | A utility to get a sub route path taking the host path into account. |
 |  [getUser()](./foundation-auth.getuser.md) | Gets User from the DI container. |
 |  [isChangePasswordParams(params)](./foundation-auth.ischangepasswordparams.md) | isChangePasswordParams. |
@@ -52,7 +50,8 @@
 |  [isLogoutNackDTO(dto)](./foundation-auth.islogoutnackdto.md) | isLogoutNackDTO. |
 |  [isLogoutNackEntity(entity)](./foundation-auth.islogoutnackentity.md) | isLogoutNackEntity. |
 |  [isMFRoute(pathname)](./foundation-auth.ismfroute.md) | A utility to check if a pathname is a route of this micro frontend. |
-|  [isNackDTO(dto)](./foundation-auth.isnackdto.md) | isDTONack. |
+|  [isNackDTO(dto)](./foundation-auth.isnackdto.md) | isNackDTO. |
+|  [isNackEntity(entity)](./foundation-auth.isnackentity.md) | isNackEntity. |
 |  [isQueryParams(params)](./foundation-auth.isqueryparams.md) | isQueryParams. |
 |  [isResetPasswordParams(params)](./foundation-auth.isresetpasswordparams.md) | isResetPasswordParams. |
 
@@ -65,7 +64,6 @@
 |  [AuthMachine](./foundation-auth.authmachine.md) | AuthMachine interface. |
 |  [AuthMachineContext](./foundation-auth.authmachinecontext.md) | AuthMachineContext interface. |
 |  [AuthMessageMapper](./foundation-auth.authmessagemapper.md) | AuthMessageMapper interface. |
-|  [AuthRouting](./foundation-auth.authrouting.md) | AuthRouting interface. |
 |  [AuthStore](./foundation-auth.authstore.md) | AuthStore interface. |
 |  [CredentialManager](./foundation-auth.credentialmanager.md) | CredentialManager interface. |
 |  [CredentialManagerConfig](./foundation-auth.credentialmanagerconfig.md) | The configuration for the CredentialManager |
@@ -79,8 +77,8 @@
 |  [EVENT\_LOGOUT\_NACK](./foundation-auth.event_logout_nack.md) |  |
 |  [EVENT\_PASSWORD\_RESET\_ACTION](./foundation-auth.event_password_reset_action.md) |  |
 |  [EVENT\_SELF\_SERVICE\_PASSWORD\_RESET](./foundation-auth.event_self_service_password_reset.md) |  |
+|  [Idp](./foundation-auth.idp.md) |  |
 |  [IDP](./foundation-auth.idp.md) |  |
-|  [IDPResponse](./foundation-auth.idpresponse.md) |  |
 |  [LoginAck](./foundation-auth.loginack.md) |  |
 |  [LoginDetailsAck](./foundation-auth.logindetailsack.md) |  |
 |  [LoginMapper](./foundation-auth.loginmapper.md) | LoginMapper interface. |
@@ -112,15 +110,13 @@
 |  [defaultCredentialManagerConfig](./foundation-auth.defaultcredentialmanagerconfig.md) | The default configuration for the CredentialManager service. |
 |  [defaultCredentialRequestOptions](./foundation-auth.defaultcredentialrequestoptions.md) | The default request options for the CredentialManager service. |
 |  [defaultUserConfig](./foundation-auth.defaultuserconfig.md) | Default UserConfig DI implementation. |
-|  [fetchIDPs](./foundation-auth.fetchidps.md) | Request SSO identity provider list |
 |  [FORGOT\_PASSWORD\_URL](./foundation-auth.forgot_password_url.md) |  |
 |  [fromDTOAck](./foundation-auth.fromdtoack.md) | fromDTOAck |
 |  [fromDTONack](./foundation-auth.fromdtonack.md) | fromDTONack |
-|  [fromDTONackErrorWarningArray](./foundation-auth.fromdtonackerrorwarningarray.md) |  |
 |  [fromDTOStringArray](./foundation-auth.fromdtostringarray.md) |  |
-|  [getSSOLoginURL](./foundation-auth.getssologinurl.md) | Get SSO identity provider login URL |
+|  [fromIDPDTO](./foundation-auth.fromidpdto.md) | fromIDPDTO |
 |  [hasDTOErrorWarningCode](./foundation-auth.hasdtoerrorwarningcode.md) | hasDTOErrorWarningCode |
-|  [includesErrorWarningCode](./foundation-auth.includeserrorwarningcode.md) | includesErrorWarningCode |
+|  [is200Nack](./foundation-auth.is200nack.md) | is200Nack. |
 |  [isMappingError](./foundation-auth.ismappingerror.md) |  |
 |  [logger](./foundation-auth.logger.md) |  |
 |  [LOGIN\_DETAILS\_URL](./foundation-auth.login_details_url.md) |  |
@@ -128,7 +124,10 @@
 |  [LOGIN\_URL](./foundation-auth.login_url.md) |  |
 |  [LOGOUT\_URL](./foundation-auth.logout_url.md) |  |
 |  [RESET\_PASSWORD\_URL](./foundation-auth.reset_password_url.md) |  |
+|  [setError](./foundation-auth.seterror.md) | Set error action. |
 |  [SOCKET\_URL](./foundation-auth.socket_url.md) |  |
+|  [SSO\_LIST\_URL](./foundation-auth.sso_list_url.md) |  |
+|  [SSO\_LOGIN\_URL](./foundation-auth.sso_login_url.md) |  |
 |  [styles](./foundation-auth.styles.md) |  |
 |  [template](./foundation-auth.template.md) |  |
 |  [UserAuthenticationChangeType](./foundation-auth.userauthenticationchangetype.md) | UserAuthenticationChangeType. |

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

@@ -0,0 +1,25 @@
+<!-- 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, import("xstate").ParameterizedObject>, { 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  `lastError` in the `errors` property.
+

package/docs/api/{foundation-auth.idpresponse.type.md → foundation-auth.sso_list_url.md}

@@ -1,11 +1,12 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [IDPResponse](./foundation-auth.idpresponse.md) &gt; [TYPE](./foundation-auth.idpresponse.type.md)
+[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [SSO\_LIST\_URL](./foundation-auth.sso_list_url.md)
+
+## SSO\_LIST\_URL variable
 
-## IDPResponse.TYPE property
 
 **Signature:**
 
 ```typescript
-TYPE: string;
+SSO_LIST_URL: string
 ```

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

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [SSO\_LOGIN\_URL](./foundation-auth.sso_login_url.md)
+
+## SSO\_LOGIN\_URL variable
+
+
+**Signature:**
+
+```typescript
+SSO_LOGIN_URL: string
+```

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

@@ -10,6 +10,5 @@
 ```typescript
 export type SSOConfig = {
     toggled?: boolean;
-    identityProvidersPath: string;
 };
 ```

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

@@ -7,7 +7,7 @@
 **Signature:**
 
 ```typescript
-addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent>): void;
+addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent>): () => void;
 ```
 
 ## Parameters
@@ -18,7 +18,7 @@ addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent
 
 **Returns:**
 
-void
+() =&gt; void
 
 ## Example
 
@@ -26,7 +26,7 @@ void
 ```ts
 import type { UserAuthenticationChangeEvent } from '@genesislcap/foundation-auth/user';
 ...
-this.user.addAuthenticationChangeListener((event: UserAuthenticationChangeEvent) => {
+const unsubscribe = this.user.addAuthenticationChangeListener((event: UserAuthenticationChangeEvent) => {
   console.log('User authenticated?', event.detail);
 });
 ```