@genesislcap/foundation-auth 14.408.0 → 14.409.0

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

@@ -1,52 +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; [isMappingError](./foundation-auth.ismappingerror.md)
-
-## isMappingError() function
-
-**Signature:**
-
-```typescript
-isMappingError: (error: unknown) => error is MappingError
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-error
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-An error.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-error is [MappingError](./foundation-auth.mappingerror.md)
-

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

@@ -1,54 +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; [isMFRoute](./foundation-auth.ismfroute.md)
-
-## isMFRoute() function
-
-A utility to check if a pathname is a route of this micro frontend.
-
-**Signature:**
-
-```typescript
-export declare function isMFRoute(pathname?: string): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-pathname
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ A pathname string to check, typically location.pathname, which is used when a value is omitted.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-

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

@@ -1,54 +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; [isNackDTO](./foundation-auth.isnackdto.md)
-
-## isNackDTO() function
-
-isNackDTO.
-
-**Signature:**
-
-```typescript
-export declare function isNackDTO(dto: unknown): dto is NACK;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-dto
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-Potential NACK.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-dto is NACK
-

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

@@ -1,54 +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; [isNackEntity](./foundation-auth.isnackentity.md)
-
-## isNackEntity() function
-
-isNackEntity.
-
-**Signature:**
-
-```typescript
-export declare function isNackEntity(entity: unknown): entity is Nack;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-entity
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-Potential Nack.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-entity is Nack
-

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

@@ -1,54 +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; [isQueryParams](./foundation-auth.isqueryparams.md)
-
-## isQueryParams() function
-
-isQueryParams.
-
-**Signature:**
-
-```typescript
-export declare function isQueryParams(params: AuthMachineEventParams): params is QueryParams;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-params
-
-
-</td><td>
-
-[AuthMachineEventParams](./foundation-auth.authmachineeventparams.md)
-
-
-</td><td>
-
-Potential QueryParams.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-params is [QueryParams](./foundation-auth.queryparams.md)
-

package/docs/api/foundation-auth.isresetpasswordparams.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; [isResetPasswordParams](./foundation-auth.isresetpasswordparams.md)
-
-## isResetPasswordParams() function
-
-isResetPasswordParams.
-
-**Signature:**
-
-```typescript
-export declare function isResetPasswordParams(params: AuthMachineEventParams): params is ResetPasswordParams;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-params
-
-
-</td><td>
-
-[AuthMachineEventParams](./foundation-auth.authmachineeventparams.md)
-
-
-</td><td>
-
-Potential ResetPasswordParams.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-params is [ResetPasswordParams](./foundation-auth.resetpasswordparams.md)
-
-## Remarks
-
-ResetPasswordParams.requester is optional, so it is not part of the evaluation.
-

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

package/docs/api/foundation-auth.logger.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; [logger](./foundation-auth.logger.md)
-
-## logger variable
-
-
-**Signature:**
-
-```typescript
-logger: import("@genesislcap/foundation-logger").Logger
-```

package/docs/api/foundation-auth.loginack.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; [LoginAck](./foundation-auth.loginack.md)
-
-## LoginAck interface
-
-
-**Signature:**
-
-```typescript
-export interface LoginAck extends SetUserProperties, Ack 
-```
-**Extends:** SetUserProperties, Ack
-

package/docs/api/foundation-auth.logindetailsack.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; [LoginDetailsAck](./foundation-auth.logindetailsack.md)
-
-## LoginDetailsAck interface
-
-
-**Signature:**
-
-```typescript
-export interface LoginDetailsAck extends LoginAck 
-```
-**Extends:** [LoginAck](./foundation-auth.loginack.md)
-

package/docs/api/foundation-auth.logindto.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; [LoginDTO](./foundation-auth.logindto.md)
-
-## LoginDTO type
-
-LoginDTO type.
-
-**Signature:**
-
-```typescript
-export type LoginDTO = EVENT_LOGIN_AUTH | EVENT_LOGIN_AUTH_ACK | EVENT_LOGIN_AUTH_NACK | EVENT_LOGIN_DETAILS_ACK | MESSAGE;
-```
-**References:** [EVENT\_LOGIN\_AUTH](./foundation-auth.event_login_auth.md)<!-- -->, [EVENT\_LOGIN\_AUTH\_ACK](./foundation-auth.event_login_auth_ack.md)<!-- -->, [EVENT\_LOGIN\_AUTH\_NACK](./foundation-auth.event_login_auth_nack.md)<!-- -->, [EVENT\_LOGIN\_DETAILS\_ACK](./foundation-auth.event_login_details_ack.md)
-

package/docs/api/foundation-auth.loginentity.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; [LoginEntity](./foundation-auth.loginentity.md)
-
-## LoginEntity type
-
-LoginEntity type.
-
-**Signature:**
-
-```typescript
-export type LoginEntity = Credentials | LoginAck | LoginDetailsAck | LoginNack | Nack;
-```
-**References:** [Credentials](./foundation-auth.credentials.md)<!-- -->, [LoginAck](./foundation-auth.loginack.md)<!-- -->, [LoginDetailsAck](./foundation-auth.logindetailsack.md)<!-- -->, [LoginNack](./foundation-auth.loginnack.md)
-

package/docs/api/foundation-auth.loginmapper.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; [LoginMapper](./foundation-auth.loginmapper.md)
-
-## LoginMapper interface
-
-LoginMapper interface.
-
-**Signature:**
-
-```typescript
-export interface LoginMapper extends Mapper<LoginDTO, LoginEntity> 
-```
-**Extends:** [Mapper](./foundation-auth.mapper.md)<!-- -->&lt;[LoginDTO](./foundation-auth.logindto.md)<!-- -->, [LoginEntity](./foundation-auth.loginentity.md)<!-- -->&gt;
-
-## Remarks
-
-An extensible mapper for converting between login DTOs and Entities, where you can normalise data, implement derived fields, validation etc.
-
-## Example
-
-Overriding the default mapper for your application. Note the interface is the key.
-
-```ts
-import { DefaultLoginMapper, LoginMapper } from '@genesislcap/foundation-auth';
-import { Container, Registration } from '@microsoft/fast-foundation';
-
-class MyLoginMapper extends DefaultLoginMapper {
-    // modify logic
-}
-
-@customElement({...})
-export class MyApplication extends FASTElement {
-    @Container container!: Container;
-    connectedCallback() {
-        this.container.register(Registration.singleton(LoginMapper, MyLoginMapper));
-    }
-}
-```
-

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

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

package/docs/api/foundation-auth.loginnack.maxtriesreached.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; [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

@@ -1,172 +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; [LoginNack](./foundation-auth.loginnack.md)
-
-## LoginNack interface
-
-
-**Signature:**
-
-```typescript
-export interface LoginNack extends Nack 
-```
-**Extends:** Nack
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[hasIncorrectCredentials](./foundation-auth.loginnack.hasincorrectcredentials.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[hasPasswordExpired](./foundation-auth.loginnack.haspasswordexpired.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[isMFARequired](./foundation-auth.loginnack.ismfarequired.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[maxTriesReached](./foundation-auth.loginnack.maxtriesreached.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[refreshAuthToken](./foundation-auth.loginnack.refreshauthtoken.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[refreshTokenExpirationMins](./foundation-auth.loginnack.refreshtokenexpirationmins.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[requiresTermsAndConditions](./foundation-auth.loginnack.requirestermsandconditions.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

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