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

package/docs/api/foundation-auth.md

@@ -1,1374 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md)
-
-## foundation-auth package
-
-## Classes
-
-<table><thead><tr><th>
-
-Class
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[DefaultAuthFormEntryStore](./foundation-auth.defaultauthformentrystore.md)
-
-
-</td><td>
-
-Default AuthFormEntryStore.
-
-
-</td></tr>
-<tr><td>
-
-[DefaultAuthMachine](./foundation-auth.defaultauthmachine.md)
-
-
-</td><td>
-
-Default AuthMachine.
-
-
-</td></tr>
-<tr><td>
-
-[DefaultAuthMessageMapper](./foundation-auth.defaultauthmessagemapper.md)
-
-
-</td><td>
-
-Default AuthMessageMapper.
-
-
-</td></tr>
-<tr><td>
-
-[DefaultAuthStore](./foundation-auth.defaultauthstore.md)
-
-
-</td><td>
-
-Default AuthStore.
-
-
-</td></tr>
-<tr><td>
-
-[DefaultCredentialManager](./foundation-auth.defaultcredentialmanager.md)
-
-
-</td><td>
-
-Default CredentialManager.
-
-
-</td></tr>
-<tr><td>
-
-[DefaultLoginMapper](./foundation-auth.defaultloginmapper.md)
-
-
-</td><td>
-
-Default LoginMapper.
-
-
-</td></tr>
-<tr><td>
-
-[DefaultLogoutMapper](./foundation-auth.defaultlogoutmapper.md)
-
-
-</td><td>
-
-Default LogoutMapper.
-
-
-</td></tr>
-<tr><td>
-
-[DefaultMessageMapper](./foundation-auth.defaultmessagemapper.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[DefaultPasswordManagementMapper](./foundation-auth.defaultpasswordmanagementmapper.md)
-
-
-</td><td>
-
-Default PasswordManagementMapper.
-
-
-</td></tr>
-<tr><td>
-
-[FoundationAuth](./foundation-auth.foundationauth.md)
-
-
-</td><td>
-
-FoundationAuth.
-
-
-</td></tr>
-<tr><td>
-
-[MappingError](./foundation-auth.mappingerror.md)
-
-
-</td><td>
-
-MappingError.
-
-
-</td></tr>
-</tbody></table>
-
-## Enumerations
-
-<table><thead><tr><th>
-
-Enumeration
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[CredentialType\_2](./foundation-auth.credentialtype_2.md)
-
-
-</td><td>
-
-Types of credentials supported.
-
-
-</td></tr>
-</tbody></table>
-
-## Functions
-
-<table><thead><tr><th>
-
-Function
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[configure(config)](./foundation-auth.configure.md)
-
-
-</td><td>
-
-configure.
-
-
-</td></tr>
-<tr><td>
-
-[createHTTPHeadersFromDTO(dto, contentType)](./foundation-auth.createhttpheadersfromdto.md)
-
-
-</td><td>
-
-createHTTPHeadersFromDTO.
-
-
-</td></tr>
-<tr><td>
-
-[createMessageMapper()](./foundation-auth.createmessagemapper.md)
-
-
-</td><td>
-
-A factory to create a MessageMapper.
-
-
-</td></tr>
-<tr><td>
-
-[fromDTOAck(dto)](./foundation-auth.fromdtoack.md)
-
-
-</td><td>
-
-fromDTOAck
-
-
-</td></tr>
-<tr><td>
-
-[fromDTONack(dto)](./foundation-auth.fromdtonack.md)
-
-
-</td><td>
-
-fromDTONack
-
-
-</td></tr>
-<tr><td>
-
-[fromDTOStringArray(arr)](./foundation-auth.fromdtostringarray.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[fromIDPDTO(dto)](./foundation-auth.fromidpdto.md)
-
-
-</td><td>
-
-fromIDPDTO
-
-
-</td></tr>
-<tr><td>
-
-[getAuthMachine()](./foundation-auth.getauthmachine.md)
-
-
-</td><td>
-
-Get AuthMachine from the DI container.
-
-
-</td></tr>
-<tr><td>
-
-[getAuthStore()](./foundation-auth.getauthstore.md)
-
-
-</td><td>
-
-Get AuthStore from the DI container.
-
-
-</td></tr>
-<tr><td>
-
-[getRoutePath(route, hostPath)](./foundation-auth.getroutepath.md)
-
-
-</td><td>
-
-A utility to get a sub route path taking the host path into account.
-
-
-</td></tr>
-<tr><td>
-
-[hasDTOErrorWarningCode(dto, code)](./foundation-auth.hasdtoerrorwarningcode.md)
-
-
-</td><td>
-
-hasDTOErrorWarningCode
-
-
-</td></tr>
-<tr><td>
-
-[is200Nack(event)](./foundation-auth.is200nack.md)
-
-
-</td><td>
-
-is200Nack.
-
-
-</td></tr>
-<tr><td>
-
-[isChangePasswordParams(params)](./foundation-auth.ischangepasswordparams.md)
-
-
-</td><td>
-
-isChangePasswordParams.
-
-
-</td></tr>
-<tr><td>
-
-[isForgotPasswordParams(params)](./foundation-auth.isforgotpasswordparams.md)
-
-
-</td><td>
-
-isForgotPasswordParams.
-
-
-</td></tr>
-<tr><td>
-
-[isLoginAckDTO(dto)](./foundation-auth.isloginackdto.md)
-
-
-</td><td>
-
-isLoginAckDTO.
-
-
-</td></tr>
-<tr><td>
-
-[isLoginAckEntity(entity)](./foundation-auth.isloginackentity.md)
-
-
-</td><td>
-
-isLoginAckEntity.
-
-
-</td></tr>
-<tr><td>
-
-[isLoginDetailsAckDTO(dto)](./foundation-auth.islogindetailsackdto.md)
-
-
-</td><td>
-
-isLoginDetailsAckDTO.
-
-
-</td></tr>
-<tr><td>
-
-[isLoginDetailsAckEntity(entity)](./foundation-auth.islogindetailsackentity.md)
-
-
-</td><td>
-
-isLoginDetailsAckEntity.
-
-
-</td></tr>
-<tr><td>
-
-[isLoginNackDTO(dto)](./foundation-auth.isloginnackdto.md)
-
-
-</td><td>
-
-isLoginNackDTO.
-
-
-</td></tr>
-<tr><td>
-
-[isLoginNackEntity(entity)](./foundation-auth.isloginnackentity.md)
-
-
-</td><td>
-
-isLoginNackEntity.
-
-
-</td></tr>
-<tr><td>
-
-[isLoginParams(params)](./foundation-auth.isloginparams.md)
-
-
-</td><td>
-
-isLoginParams.
-
-
-</td></tr>
-<tr><td>
-
-[isLogoutAckDTO(dto)](./foundation-auth.islogoutackdto.md)
-
-
-</td><td>
-
-isLogoutAckDTO.
-
-
-</td></tr>
-<tr><td>
-
-[isLogoutAckEntity(entity)](./foundation-auth.islogoutackentity.md)
-
-
-</td><td>
-
-isLogoutAckEntity.
-
-
-</td></tr>
-<tr><td>
-
-[isLogoutNackDTO(dto)](./foundation-auth.islogoutnackdto.md)
-
-
-</td><td>
-
-isLogoutNackDTO.
-
-
-</td></tr>
-<tr><td>
-
-[isLogoutNackEntity(entity)](./foundation-auth.islogoutnackentity.md)
-
-
-</td><td>
-
-isLogoutNackEntity.
-
-
-</td></tr>
-<tr><td>
-
-[isMappingError(error)](./foundation-auth.ismappingerror.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[isMFRoute(pathname)](./foundation-auth.ismfroute.md)
-
-
-</td><td>
-
-A utility to check if a pathname is a route of this micro frontend.
-
-
-</td></tr>
-<tr><td>
-
-[isNackDTO(dto)](./foundation-auth.isnackdto.md)
-
-
-</td><td>
-
-isNackDTO.
-
-
-</td></tr>
-<tr><td>
-
-[isNackEntity(entity)](./foundation-auth.isnackentity.md)
-
-
-</td><td>
-
-isNackEntity.
-
-
-</td></tr>
-<tr><td>
-
-[isQueryParams(params)](./foundation-auth.isqueryparams.md)
-
-
-</td><td>
-
-isQueryParams.
-
-
-</td></tr>
-<tr><td>
-
-[isResetPasswordParams(params)](./foundation-auth.isresetpasswordparams.md)
-
-
-</td><td>
-
-isResetPasswordParams.
-
-
-</td></tr>
-</tbody></table>
-
-## Interfaces
-
-<table><thead><tr><th>
-
-Interface
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[AuthConfig](./foundation-auth.authconfig.md)
-
-
-</td><td>
-
-AuthConfig DI interface.
-
-
-</td></tr>
-<tr><td>
-
-[AuthFormEntryStore](./foundation-auth.authformentrystore.md)
-
-
-</td><td>
-
-AuthFormEntryStore interface.
-
-
-</td></tr>
-<tr><td>
-
-[AuthMachine](./foundation-auth.authmachine.md)
-
-
-</td><td>
-
-AuthMachine interface.
-
-
-</td></tr>
-<tr><td>
-
-[AuthMachineContext](./foundation-auth.authmachinecontext.md)
-
-
-</td><td>
-
-AuthMachineContext interface.
-
-
-</td></tr>
-<tr><td>
-
-[AuthMessageMapper](./foundation-auth.authmessagemapper.md)
-
-
-</td><td>
-
-AuthMessageMapper interface.
-
-
-</td></tr>
-<tr><td>
-
-[AuthStore](./foundation-auth.authstore.md)
-
-
-</td><td>
-
-AuthStore interface.
-
-
-</td></tr>
-<tr><td>
-
-[CredentialManager](./foundation-auth.credentialmanager.md)
-
-
-</td><td>
-
-CredentialManager interface.
-
-
-</td></tr>
-<tr><td>
-
-[CredentialManagerConfig](./foundation-auth.credentialmanagerconfig.md)
-
-
-</td><td>
-
-The configuration for the CredentialManager
-
-
-</td></tr>
-<tr><td>
-
-[CredentialManagerCookieConfig](./foundation-auth.credentialmanagercookieconfig.md)
-
-
-</td><td>
-
-The configuration options for the CredentialManager cookie
-
-
-</td></tr>
-<tr><td>
-
-[Details](./foundation-auth.details.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[EVENT\_CHANGE\_USER\_PASSWORD](./foundation-auth.event_change_user_password.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[EVENT\_LOGIN\_AUTH\_ACK](./foundation-auth.event_login_auth_ack.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[EVENT\_LOGIN\_AUTH\_NACK](./foundation-auth.event_login_auth_nack.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[EVENT\_LOGIN\_AUTH](./foundation-auth.event_login_auth.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[EVENT\_LOGIN\_DETAILS\_ACK](./foundation-auth.event_login_details_ack.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[EVENT\_LOGOUT\_NACK](./foundation-auth.event_logout_nack.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[EVENT\_PASSWORD\_RESET\_ACTION](./foundation-auth.event_password_reset_action.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[EVENT\_SELF\_SERVICE\_PASSWORD\_RESET](./foundation-auth.event_self_service_password_reset.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[IDENTITY\_PROVIDER](./foundation-auth.identity_provider.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[IdentityProvider](./foundation-auth.identityprovider.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[LoginAck](./foundation-auth.loginack.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[LoginDetailsAck](./foundation-auth.logindetailsack.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[LoginMapper](./foundation-auth.loginmapper.md)
-
-
-</td><td>
-
-LoginMapper interface.
-
-
-</td></tr>
-<tr><td>
-
-[LoginNack](./foundation-auth.loginnack.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[LOGOUT\_ACK](./foundation-auth.logout_ack.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[LogoutAck](./foundation-auth.logoutack.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[LogoutMapper](./foundation-auth.logoutmapper.md)
-
-
-</td><td>
-
-LogoutMapper interface.
-
-
-</td></tr>
-<tr><td>
-
-[LogoutNack](./foundation-auth.logoutnack.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[Mapper](./foundation-auth.mapper.md)
-
-
-</td><td>
-
-DTO mapper interface.
-
-
-</td></tr>
-<tr><td>
-
-[MessageMapper](./foundation-auth.messagemapper.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[PasswordManagementMapper](./foundation-auth.passwordmanagementmapper.md)
-
-
-</td><td>
-
-PasswordManagementMapper interface.
-
-
-</td></tr>
-<tr><td>
-
-[Product](./foundation-auth.product.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[System](./foundation-auth.system.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-## Variables
-
-<table><thead><tr><th>
-
-Variable
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[AuthRoutes](./foundation-auth.authroutes.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[credentialSeparator](./foundation-auth.credentialseparator.md)
-
-
-</td><td>
-
-The default separator used for splitting credential parts.
-
-
-</td></tr>
-<tr><td>
-
-[defaultAuthConfig](./foundation-auth.defaultauthconfig.md)
-
-
-</td><td>
-
-Default AuthConfig DI implementation.
-
-
-</td></tr>
-<tr><td>
-
-[defaultAuthMachineContext](./foundation-auth.defaultauthmachinecontext.md)
-
-
-</td><td>
-
-Default AuthMachineContext.
-
-
-</td></tr>
-<tr><td>
-
-[defaultCredentialManagerConfig](./foundation-auth.defaultcredentialmanagerconfig.md)
-
-
-</td><td>
-
-The default configuration for the CredentialManager service.
-
-
-</td></tr>
-<tr><td>
-
-[defaultCredentialRequestOptions](./foundation-auth.defaultcredentialrequestoptions.md)
-
-
-</td><td>
-
-The default request options for the CredentialManager service.
-
-
-</td></tr>
-<tr><td>
-
-[logger](./foundation-auth.logger.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[setError](./foundation-auth.seterror.md)
-
-
-</td><td>
-
-Set error action.
-
-
-</td></tr>
-<tr><td>
-
-[styles](./foundation-auth.styles.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[template](./foundation-auth.template.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-</tbody></table>
-
-## Type Aliases
-
-<table><thead><tr><th>
-
-Type Alias
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[AcceptTermsParams](./foundation-auth.accepttermsparams.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[AuthDTO](./foundation-auth.authdto.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[AuthEntity](./foundation-auth.authentity.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[AuthEventMap](./foundation-auth.autheventmap.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[AuthFormEntryEventMap](./foundation-auth.authformentryeventmap.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[AuthMachineEvent](./foundation-auth.authmachineevent.md)
-
-
-</td><td>
-
-AuthMachineEvent type.
-
-
-</td></tr>
-<tr><td>
-
-[AuthMachineEventMap](./foundation-auth.authmachineeventmap.md)
-
-
-</td><td>
-
-AuthMachineEventMap type.
-
-
-</td></tr>
-<tr><td>
-
-[AuthMachineEventParams](./foundation-auth.authmachineeventparams.md)
-
-
-</td><td>
-
-AuthMachineEventParams type.
-
-
-</td></tr>
-<tr><td>
-
-[AuthMessageMapperLookup](./foundation-auth.authmessagemapperlookup.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[AuthRoutes](./foundation-auth.authroutes.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[BasicCredentials](./foundation-auth.basiccredentials.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[ChangePasswordParams](./foundation-auth.changepasswordparams.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[CredentialData\_2](./foundation-auth.credentialdata_2.md)
-
-
-</td><td>
-
-Represents user credentials.
-
-
-</td></tr>
-<tr><td>
-
-[Credentials](./foundation-auth.credentials.md)
-
-
-</td><td>
-
-Union of all credential types.
-
-
-</td></tr>
-<tr><td>
-
-[FieldConfig](./foundation-auth.fieldconfig.md)
-
-
-</td><td>
-
-Could be expanded to allow field ViewTemplates.
-
-
-</td></tr>
-<tr><td>
-
-[FieldConfigMap](./foundation-auth.fieldconfigmap.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[ForgotPasswordParams](./foundation-auth.forgotpasswordparams.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[GetCredentialOptions](./foundation-auth.getcredentialoptions.md)
-
-
-</td><td>
-
-Represents options for retrieving credentials.
-
-
-</td></tr>
-<tr><td>
-
-[JWTCredentials](./foundation-auth.jwtcredentials.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[LoginDTO](./foundation-auth.logindto.md)
-
-
-</td><td>
-
-LoginDTO type.
-
-
-</td></tr>
-<tr><td>
-
-[LoginEntity](./foundation-auth.loginentity.md)
-
-
-</td><td>
-
-LoginEntity type.
-
-
-</td></tr>
-<tr><td>
-
-[LoginParams](./foundation-auth.loginparams.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[LogoutDTO](./foundation-auth.logoutdto.md)
-
-
-</td><td>
-
-LogoutDTO type.
-
-
-</td></tr>
-<tr><td>
-
-[LogoutEntity](./foundation-auth.logoutentity.md)
-
-
-</td><td>
-
-LogoutEntity type.
-
-
-</td></tr>
-<tr><td>
-
-[MessageMapperLookup](./foundation-auth.messagemapperlookup.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[MFACredentials](./foundation-auth.mfacredentials.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[PasswordManagementDTO](./foundation-auth.passwordmanagementdto.md)
-
-
-</td><td>
-
-PasswordManagementDTO type.
-
-
-</td></tr>
-<tr><td>
-
-[PasswordManagementEntity](./foundation-auth.passwordmanagemententity.md)
-
-
-</td><td>
-
-PasswordManagementEntity type.
-
-
-</td></tr>
-<tr><td>
-
-[QueryParams](./foundation-auth.queryparams.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[RefreshCredentials](./foundation-auth.refreshcredentials.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[ResetPasswordParams](./foundation-auth.resetpasswordparams.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[Settings](./foundation-auth.settings.md)
-
-
-</td><td>
-
-Defines the parameters you may set on the routes.
-
-
-</td></tr>
-<tr><td>
-
-[SSOConfig](./foundation-auth.ssoconfig.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[SSOCredentials](./foundation-auth.ssocredentials.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[TermsConditionsParams](./foundation-auth.termsconditionsparams.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-</tbody></table>
-