@breadstone/archipel-mcp 0.0.9 → 0.0.11

package/data/packages/platform-authentication/api/Class.SessionResponse.md

@@ -3,7 +3,6 @@ title: 'Class: SessionResponse'
 generated: true
 editUrl: false
 ---
-
 # Class: SessionResponse
 
 Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L14)
@@ -32,7 +31,7 @@ browserName: string | null;
 
 Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L55)
 
----
+***
 
 ### browserVersion
 
@@ -42,7 +41,7 @@ browserVersion: string | null;
 
 Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L65)
 
----
+***
 
 ### clientName
 
@@ -52,7 +51,7 @@ clientName: string | null;
 
 Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L105)
 
----
+***
 
 ### createdAt
 
@@ -62,7 +61,7 @@ createdAt: Date;
 
 Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:129](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L129)
 
----
+***
 
 ### deviceName
 
@@ -72,7 +71,7 @@ deviceName: string | null;
 
 Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L45)
 
----
+***
 
 ### deviceType
 
@@ -82,7 +81,7 @@ deviceType: string | null;
 
 Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L35)
 
----
+***
 
 ### id
 
@@ -92,7 +91,7 @@ id: string;
 
 Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L25)
 
----
+***
 
 ### ipAddress
 
@@ -102,7 +101,7 @@ ipAddress: string;
 
 Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:113](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L113)
 
----
+***
 
 ### isCurrent
 
@@ -112,7 +111,7 @@ isCurrent: boolean;
 
 Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:137](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L137)
 
----
+***
 
 ### lastActive
 
@@ -122,7 +121,7 @@ lastActive: Date;
 
 Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:121](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L121)
 
----
+***
 
 ### location
 
@@ -132,7 +131,7 @@ location: string | null;
 
 Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:95](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L95)
 
----
+***
 
 ### osName
 
@@ -142,7 +141,7 @@ osName: string | null;
 
 Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L75)
 
----
+***
 
 ### osVersion
 

package/data/packages/platform-authentication/api/Class.SessionService.md

@@ -3,7 +3,6 @@ title: 'Class: SessionService'
 generated: true
 editUrl: false
 ---
-
 # Class: SessionService
 
 Defined in: [libs/platform-authentication/src/services/SessionService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/SessionService.ts#L18)
@@ -24,10 +23,10 @@ Constructs a new instance of the `SessionService` class.
 
 #### Parameters
 
-| Parameter            | Type                                                     | Description                   |
-| -------------------- | -------------------------------------------------------- | ----------------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `sessionPersistence` | [`SessionPersistencePort`](Class.SessionPersistencePort) | The session persistence port. |
-| `mappingService`     | `MappingService`                                         | The mapping service.          |
+| `mappingService` | `MappingService` | The mapping service. |
 
 #### Returns
 
@@ -47,9 +46,9 @@ Invalidates a session by its token.
 
 #### Parameters
 
-| Parameter | Type     | Description        |
-| --------- | -------- | ------------------ |
-| `token`   | `string` | The session token. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `token` | `string` | The session token. |
 
 #### Returns
 
@@ -57,7 +56,7 @@ Invalidates a session by its token.
 
 `true` if a session was invalidated.
 
----
+***
 
 ### invalidateById()
 
@@ -71,10 +70,10 @@ Invalidates a session by its record id.
 
 #### Parameters
 
-| Parameter   | Type     | Description                    |
-| ----------- | -------- | ------------------------------ |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `sessionId` | `string` | The session record identifier. |
-| `userId`    | `string` | The owning user identifier.    |
+| `userId` | `string` | The owning user identifier. |
 
 #### Returns
 
@@ -82,7 +81,7 @@ Invalidates a session by its record id.
 
 `true` if a session was invalidated.
 
----
+***
 
 ### listSessions()
 
@@ -96,10 +95,10 @@ Lists all sessions for a user, marking the current one.
 
 #### Parameters
 
-| Parameter | Type     | Description                |
-| --------- | -------- | -------------------------- |
-| `userId`  | `string` | The user identifier.       |
-| `token`   | `string` | The current session token. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `userId` | `string` | The user identifier. |
+| `token` | `string` | The current session token. |
 
 #### Returns
 
@@ -107,17 +106,17 @@ Lists all sessions for a user, marking the current one.
 
 Array of session responses.
 
----
+***
 
 ### store()
 
 ```ts
 store(
-   token,
-   userId,
-   ipAddress,
-   deviceInfo?,
-   location?,
+   token, 
+   userId, 
+   ipAddress, 
+   deviceInfo?, 
+   location?, 
 clientName?): Promise<void>;
 ```
 
@@ -127,20 +126,20 @@ Stores or updates a session.
 
 #### Parameters
 
-| Parameter     | Type          | Description                       |
-| ------------- | ------------- | --------------------------------- |
-| `token`       | `string`      | The session token.                |
-| `userId`      | `string`      | The user identifier.              |
-| `ipAddress`   | `string`      | The client IP address.            |
-| `deviceInfo?` | `IDeviceInfo` | Optional device information.      |
-| `location?`   | `string`      | Optional geolocation string.      |
-| `clientName?` | `string`      | Optional client application name. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `token` | `string` | The session token. |
+| `userId` | `string` | The user identifier. |
+| `ipAddress` | `string` | The client IP address. |
+| `deviceInfo?` | `IDeviceInfo` | Optional device information. |
+| `location?` | `string` | Optional geolocation string. |
+| `clientName?` | `string` | Optional client application name. |
 
 #### Returns
 
 `Promise`\<`void`\>
 
----
+***
 
 ### updateLastActive()
 
@@ -154,9 +153,9 @@ Updates the last-active timestamp for a session.
 
 #### Parameters
 
-| Parameter | Type     | Description        |
-| --------- | -------- | ------------------ |
-| `token`   | `string` | The session token. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `token` | `string` | The session token. |
 
 #### Returns
 

package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md

@@ -3,7 +3,6 @@ title: 'Class: SocialAuthGuard'
 generated: true
 editUrl: false
 ---
-
 # Class: SocialAuthGuard
 
 Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L10)
@@ -24,8 +23,8 @@ Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:20](http
 
 #### Parameters
 
-| Parameter    | Type     |
-| ------------ | -------- |
+| Parameter | Type |
+| ------ | ------ |
 | `routeParam` | `string` |
 
 #### Returns
@@ -44,8 +43,8 @@ Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:28](http
 
 #### Parameters
 
-| Parameter | Type               | Description                                                                               |
-| --------- | ------------------ | ----------------------------------------------------------------------------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `context` | `ExecutionContext` | Current execution context. Provides access to details about the current request pipeline. |
 
 #### Returns
@@ -58,5 +57,5 @@ proceed.
 #### Implementation of
 
 ```ts
-CanActivate.canActivate;
+CanActivate.canActivate
 ```

package/data/packages/platform-authentication/api/Class.SocialAuthPort.md

@@ -3,7 +3,6 @@ title: 'Abstract Class: SocialAuthPort'
 generated: true
 editUrl: false
 ---
-
 # Abstract Class: SocialAuthPort
 
 Defined in: [libs/platform-authentication/src/contracts/SocialAuthPort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/SocialAuthPort.ts#L14)
@@ -38,8 +37,8 @@ or create a new one if none exists.
 
 #### Parameters
 
-| Parameter | Type                                         | Description                    |
-| --------- | -------------------------------------------- | ------------------------------ |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `profile` | [`ISocialProfile`](Interface.ISocialProfile) | The normalized social profile. |
 
 #### Returns

package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md

@@ -3,7 +3,6 @@ title: 'Abstract Class: TokenEnricherPort'
 generated: true
 editUrl: false
 ---
-
 # Abstract Class: TokenEnricherPort
 
 Defined in: [libs/platform-authentication/src/contracts/TokenEnricherPort.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/TokenEnricherPort.ts#L13)
@@ -37,8 +36,8 @@ Return additional claims to merge into the JWT payload.
 
 #### Parameters
 
-| Parameter | Type                                     | Description                |
-| --------- | ---------------------------------------- | -------------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `subject` | [`IAuthSubject`](Interface.IAuthSubject) | The authenticated subject. |
 
 #### Returns

package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md

@@ -3,7 +3,6 @@ title: 'Class: TotpMfaChannel'
 generated: true
 editUrl: false
 ---
-
 # Class: TotpMfaChannel
 
 Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts#L16)
@@ -18,9 +17,9 @@ Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:16]
 
 ```ts
 new TotpMfaChannel(
-   mfaSubject,
-   configService,
-   encryptionService,
+   mfaSubject, 
+   configService, 
+   encryptionService, 
    otpService): TotpMfaChannel;
 ```
 
@@ -28,12 +27,12 @@ Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:31]
 
 #### Parameters
 
-| Parameter           | Type                                     |
-| ------------------- | ---------------------------------------- |
-| `mfaSubject`        | [`MfaSubjectPort`](Class.MfaSubjectPort) |
-| `configService`     | `ConfigService`                          |
-| `encryptionService` | `MfaEncryptionService`                   |
-| `otpService`        | `IOtpService`                            |
+| Parameter | Type |
+| ------ | ------ |
+| `mfaSubject` | [`MfaSubjectPort`](Class.MfaSubjectPort) |
+| `configService` | `ConfigService` |
+| `encryptionService` | `MfaEncryptionService` |
+| `otpService` | `IOtpService` |
 
 #### Returns
 
@@ -54,7 +53,7 @@ Unique identifier of the MFA method (e.g., `totp`, `sms`, `email`).
 #### Implementation of
 
 ```ts
-IMfaChannel.method;
+IMfaChannel.method
 ```
 
 ## Methods
@@ -71,10 +70,10 @@ Initializes the setup flow for the channel and persists any channel-specific boo
 
 #### Parameters
 
-| Parameter   | Type               | Description                            |
-| ----------- | ------------------ | -------------------------------------- |
-| `userId`    | `string`           | Identifier of the user starting setup. |
-| `_context?` | `IMfaSetupContext` | -                                      |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `userId` | `string` | Identifier of the user starting setup. |
+| `_context?` | `IMfaSetupContext` | - |
 
 #### Returns
 
@@ -83,10 +82,10 @@ Initializes the setup flow for the channel and persists any channel-specific boo
 #### Implementation of
 
 ```ts
-IMfaChannel.initSetup;
+IMfaChannel.initSetup
 ```
 
----
+***
 
 ### verifyChallenge()
 
@@ -100,10 +99,10 @@ Verifies a challenge code during login.
 
 #### Parameters
 
-| Parameter | Type     | Description                        |
-| --------- | -------- | ---------------------------------- |
-| `userId`  | `string` | Identifier of the challenged user. |
-| `code`    | `string` | User supplied challenge code.      |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `userId` | `string` | Identifier of the challenged user. |
+| `code` | `string` | User supplied challenge code. |
 
 #### Returns
 
@@ -112,10 +111,10 @@ Verifies a challenge code during login.
 #### Implementation of
 
 ```ts
-IMfaChannel.verifyChallenge;
+IMfaChannel.verifyChallenge
 ```
 
----
+***
 
 ### verifySetup()
 
@@ -129,10 +128,10 @@ Verifies the first setup code and marks the channel as ready for challenges.
 
 #### Parameters
 
-| Parameter | Type     | Description                             |
-| --------- | -------- | --------------------------------------- |
-| `userId`  | `string` | Identifier of the user finishing setup. |
-| `code`    | `string` | User supplied setup code.               |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `userId` | `string` | Identifier of the user finishing setup. |
+| `code` | `string` | User supplied setup code. |
 
 #### Returns
 
@@ -141,5 +140,5 @@ Verifies the first setup code and marks the channel as ready for challenges.
 #### Implementation of
 
 ```ts
-IMfaChannel.verifySetup;
+IMfaChannel.verifySetup
 ```

package/data/packages/platform-authentication/api/Class.VerificationService.md

@@ -3,7 +3,6 @@ title: 'Class: VerificationService'
 generated: true
 editUrl: false
 ---
-
 # Class: VerificationService
 
 Defined in: [libs/platform-authentication/src/services/VerificationService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L18)
@@ -16,9 +15,9 @@ Manages email / PIN verification tokens via the [VerificationSubjectPort](Class.
 
 ```ts
 new VerificationService(
-   jwtService,
-   hostService,
-   verificationSubject,
+   jwtService, 
+   hostService, 
+   verificationSubject, 
    configService): VerificationService;
 ```
 
@@ -28,12 +27,12 @@ Constructs a new instance of the `VerificationService` class.
 
 #### Parameters
 
-| Parameter             | Type                                                       | Description                     |
-| --------------------- | ---------------------------------------------------------- | ------------------------------- |
-| `jwtService`          | `JwtService`                                               | JWT service instance.           |
-| `hostService`         | `HostService`                                              | Host service instance.          |
-| `verificationSubject` | [`VerificationSubjectPort`](Class.VerificationSubjectPort) | Verification subject port.      |
-| `configService`       | `ConfigService`                                            | Configuration service instance. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `jwtService` | `JwtService` | JWT service instance. |
+| `hostService` | `HostService` | Host service instance. |
+| `verificationSubject` | [`VerificationSubjectPort`](Class.VerificationSubjectPort) | Verification subject port. |
+| `configService` | `ConfigService` | Configuration service instance. |
 
 #### Returns
 
@@ -53,9 +52,9 @@ Constructs the verification link.
 
 #### Parameters
 
-| Parameter | Type     | Description             |
-| --------- | -------- | ----------------------- |
-| `token`   | `string` | The verification token. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `token` | `string` | The verification token. |
 
 #### Returns
 
@@ -63,7 +62,7 @@ Constructs the verification link.
 
 The URL to verify the email.
 
----
+***
 
 ### exhibitToken()
 
@@ -77,9 +76,9 @@ Exhibits a new verification token.
 
 #### Parameters
 
-| Parameter | Type                           | Description          |
-| --------- | ------------------------------ | -------------------- |
-| `data`    | `Record`\<`string`, `string`\> | The data to exhibit. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `data` | `Record`\<`string`, `string`\> | The data to exhibit. |
 
 #### Returns
 
@@ -87,7 +86,7 @@ Exhibits a new verification token.
 
 The verification token.
 
----
+***
 
 ### redeemToken()
 
@@ -101,9 +100,9 @@ Redeems the user's token.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `token`   | `string` | The token to redeem. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `token` | `string` | The token to redeem. |
 
 #### Returns
 
@@ -111,7 +110,7 @@ Redeems the user's token.
 
 The token data.
 
----
+***
 
 ### verifyPin()
 
@@ -123,16 +122,16 @@ Defined in: [libs/platform-authentication/src/services/VerificationService.ts:10
 
 #### Parameters
 
-| Parameter | Type     |
-| --------- | -------- |
-| `pin`     | `string` |
-| `login`   | `string` |
+| Parameter | Type |
+| ------ | ------ |
+| `pin` | `string` |
+| `login` | `string` |
 
 #### Returns
 
 `Promise`\<`boolean`\>
 
----
+***
 
 ### verifyToken()
 
@@ -146,9 +145,9 @@ Verifies the user's token.
 
 #### Parameters
 
-| Parameter | Type     | Description             |
-| --------- | -------- | ----------------------- |
-| `token`   | `string` | The verification token. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `token` | `string` | The verification token. |
 
 #### Returns
 

package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md

@@ -3,7 +3,6 @@ title: 'Abstract Class: VerificationSubjectPort'
 generated: true
 editUrl: false
 ---
-
 # Abstract Class: VerificationSubjectPort
 
 Defined in: [libs/platform-authentication/src/contracts/VerificationSubjectPort.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/VerificationSubjectPort.ts#L13)
@@ -37,9 +36,9 @@ Find a subject by login (user name or email).
 
 #### Parameters
 
-| Parameter | Type     | Description           |
-| --------- | -------- | --------------------- |
-| `login`   | `string` | The login identifier. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `login` | `string` | The login identifier. |
 
 #### Returns
 
@@ -47,7 +46,7 @@ Find a subject by login (user name or email).
 
 The verifiable subject or `null`.
 
----
+***
 
 ### findByVerificationToken()
 
@@ -61,9 +60,9 @@ Find a subject by its current verification token.
 
 #### Parameters
 
-| Parameter | Type     | Description                    |
-| --------- | -------- | ------------------------------ |
-| `token`   | `string` | The verification token string. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `token` | `string` | The verification token string. |
 
 #### Returns
 
@@ -71,7 +70,7 @@ Find a subject by its current verification token.
 
 The subject or `null`.
 
----
+***
 
 ### markVerified()
 
@@ -85,15 +84,15 @@ Mark the subject as verified and clear the token.
 
 #### Parameters
 
-| Parameter | Type     | Description             |
-| --------- | -------- | ----------------------- |
-| `id`      | `string` | The subject identifier. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The subject identifier. |
 
 #### Returns
 
 `Promise`\<`void`\>
 
----
+***
 
 ### setVerificationToken()
 
@@ -107,10 +106,10 @@ Store a verification token on the subject.
 
 #### Parameters
 
-| Parameter | Type               | Description                      |
-| --------- | ------------------ | -------------------------------- |
-| `id`      | `string`           | The subject identifier.          |
-| `token`   | `string` \| `null` | The verification token to store. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The subject identifier. |
+| `token` | `string` \| `null` | The verification token to store. |
 
 #### Returns