npm - @genesislcap/foundation-auth - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/foundation-auth 14.408.0 → 14.409.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (328) hide show

package/docs/api/foundation-auth.loginnack.refreshtokenexpirationmins.md DELETED Viewed

@@ -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; [refreshTokenExpirationMins](./foundation-auth.loginnack.refreshtokenexpirationmins.md)
-## LoginNack.refreshTokenExpirationMins property
-**Signature:**
-```typescript
-readonly refreshTokenExpirationMins: number;
-```

package/docs/api/foundation-auth.loginnack.requirestermsandconditions.md DELETED Viewed

@@ -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; [requiresTermsAndConditions](./foundation-auth.loginnack.requirestermsandconditions.md)
-## LoginNack.requiresTermsAndConditions property
-**Signature:**
-```typescript
-readonly requiresTermsAndConditions: boolean;
-```

package/docs/api/foundation-auth.loginparams.md DELETED Viewed

@@ -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; [LoginParams](./foundation-auth.loginparams.md)
-## LoginParams type
-**Signature:**
-```typescript
-export type LoginParams = Credentials;
-```
-**References:** [Credentials](./foundation-auth.credentials.md)

package/docs/api/foundation-auth.logout_ack.md DELETED Viewed

@@ -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; [LOGOUT\_ACK](./foundation-auth.logout_ack.md)
-## LOGOUT\_ACK interface
-**Signature:**
-```typescript
-export interface LOGOUT_ACK extends ACK
-```
-**Extends:** ACK
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[OIDC\_LOGOUT\_URL](./foundation-auth.logout_ack.oidc_logout_url.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-auth.logout_ack.oidc_logout_url.md DELETED Viewed

@@ -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; [LOGOUT\_ACK](./foundation-auth.logout_ack.md) &gt; [OIDC\_LOGOUT\_URL](./foundation-auth.logout_ack.oidc_logout_url.md)
-## LOGOUT\_ACK.OIDC\_LOGOUT\_URL property
-**Signature:**
-```typescript
-readonly OIDC_LOGOUT_URL: string;
-```

package/docs/api/foundation-auth.logoutack.md DELETED Viewed

@@ -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; [LogoutAck](./foundation-auth.logoutack.md)
-## LogoutAck interface
-**Signature:**
-```typescript
-export interface LogoutAck extends Ack
-```
-**Extends:** Ack
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[oidcLogoutUrl](./foundation-auth.logoutack.oidclogouturl.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-auth.logoutack.oidclogouturl.md DELETED Viewed

@@ -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; [LogoutAck](./foundation-auth.logoutack.md) &gt; [oidcLogoutUrl](./foundation-auth.logoutack.oidclogouturl.md)
-## LogoutAck.oidcLogoutUrl property
-**Signature:**
-```typescript
-readonly oidcLogoutUrl: string;
-```

package/docs/api/foundation-auth.logoutdto.md DELETED Viewed

@@ -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; [LogoutDTO](./foundation-auth.logoutdto.md)
-## LogoutDTO type
-LogoutDTO type.
-**Signature:**
-```typescript
-export type LogoutDTO = LOGOUT_ACK | EVENT_LOGOUT_NACK | MESSAGE;
-```
-**References:** [LOGOUT\_ACK](./foundation-auth.logout_ack.md)<!-- -->, [EVENT\_LOGOUT\_NACK](./foundation-auth.event_logout_nack.md)

package/docs/api/foundation-auth.logoutentity.md DELETED Viewed

@@ -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; [LogoutEntity](./foundation-auth.logoutentity.md)
-## LogoutEntity type
-LogoutEntity type.
-**Signature:**
-```typescript
-export type LogoutEntity = LogoutAck | LogoutNack;
-```
-**References:** [LogoutAck](./foundation-auth.logoutack.md)<!-- -->, [LogoutNack](./foundation-auth.logoutnack.md)

package/docs/api/foundation-auth.logoutmapper.md DELETED Viewed

@@ -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; [LogoutMapper](./foundation-auth.logoutmapper.md)
-## LogoutMapper interface
-LogoutMapper interface.
-**Signature:**
-```typescript
-export interface LogoutMapper extends Mapper<LogoutDTO, LogoutEntity>
-```
-**Extends:** [Mapper](./foundation-auth.mapper.md)<!-- -->&lt;[LogoutDTO](./foundation-auth.logoutdto.md)<!-- -->, [LogoutEntity](./foundation-auth.logoutentity.md)<!-- -->&gt;
-## Remarks
-An extensible mapper for converting between logout DTOs and Entities, where you can normalise data, implement derived fields, validation etc.

package/docs/api/foundation-auth.logoutnack.md DELETED Viewed

@@ -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; [LogoutNack](./foundation-auth.logoutnack.md)
-## LogoutNack interface
-**Signature:**
-```typescript
-export interface LogoutNack extends Nack
-```
-**Extends:** Nack

package/docs/api/foundation-auth.mapper.md DELETED Viewed

@@ -1,81 +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; [Mapper](./foundation-auth.mapper.md)
-## Mapper interface
-DTO mapper interface.
-**Signature:**
-```typescript
-export interface Mapper<TDTO, TEntity>
-```
-## Remarks
-Both `toEntity` and `toDTO` APIs are optional by design as message direction flows are unknown.
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[toDTO?](./foundation-auth.mapper.todto.md)
-</td><td>
-</td><td>
-(entity: Partial&lt;TEntity&gt;) =&gt; TDTO
-</td><td>
-_(Optional)_ Converts an entity to a DTO.
-</td></tr>
-<tr><td>
-[toEntity?](./foundation-auth.mapper.toentity.md)
-</td><td>
-</td><td>
-(dto: TDTO) =&gt; TEntity
-</td><td>
-_(Optional)_ Converts a DTO to an entity.
-</td></tr>
-</tbody></table>

package/docs/api/foundation-auth.mapper.todto.md DELETED Viewed

@@ -1,13 +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; [Mapper](./foundation-auth.mapper.md) &gt; [toDTO](./foundation-auth.mapper.todto.md)
-## Mapper.toDTO property
-Converts an entity to a DTO.
-**Signature:**
-```typescript
-toDTO?: (entity: Partial<TEntity>) => TDTO;
-```

package/docs/api/foundation-auth.mapper.toentity.md DELETED Viewed

@@ -1,13 +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; [Mapper](./foundation-auth.mapper.md) &gt; [toEntity](./foundation-auth.mapper.toentity.md)
-## Mapper.toEntity property
-Converts a DTO to an entity.
-**Signature:**
-```typescript
-toEntity?: (dto: TDTO) => TEntity;
-```

package/docs/api/foundation-auth.mappingerror._constructor_.md DELETED Viewed

@@ -1,66 +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; [MappingError](./foundation-auth.mappingerror.md) &gt; [(constructor)](./foundation-auth.mappingerror._constructor_.md)
-## MappingError.(constructor)
-Constructs a new instance of the `MappingError` class
-**Signature:**
-```typescript
-constructor(data?: unknown, message?: string);
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-data
-</td><td>
-unknown
-</td><td>
-_(Optional)_
-</td></tr>
-<tr><td>
-message
-</td><td>
-string
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>

package/docs/api/foundation-auth.mappingerror.data.md DELETED Viewed

@@ -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; [MappingError](./foundation-auth.mappingerror.md) &gt; [data](./foundation-auth.mappingerror.data.md)
-## MappingError.data property
-**Signature:**
-```typescript
-data?: unknown;
-```

package/docs/api/foundation-auth.mappingerror.md DELETED Viewed

@@ -1,93 +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; [MappingError](./foundation-auth.mappingerror.md)
-## MappingError class
-MappingError.
-**Signature:**
-```typescript
-export declare class MappingError extends Error
-```
-**Extends:** Error
-## Constructors
-<table><thead><tr><th>
-Constructor
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[(constructor)(data, message)](./foundation-auth.mappingerror._constructor_.md)
-</td><td>
-</td><td>
-Constructs a new instance of the `MappingError` class
-</td></tr>
-</tbody></table>
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[data?](./foundation-auth.mappingerror.data.md)
-</td><td>
-</td><td>
-unknown
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>