@breadstone/archipel-mcp 0.0.2 → 0.0.3

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

@@ -3,6 +3,7 @@ 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)
@@ -23,10 +24,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
 
@@ -46,9 +47,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
 
@@ -56,7 +57,7 @@ Invalidates a session by its token.
 
 `true` if a session was invalidated.
 
-***
+---
 
 ### invalidateById()
 
@@ -70,10 +71,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
 
@@ -81,7 +82,7 @@ Invalidates a session by its record id.
 
 `true` if a session was invalidated.
 
-***
+---
 
 ### listSessions()
 
@@ -95,10 +96,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
 
@@ -106,17 +107,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>;
 ```
 
@@ -126,20 +127,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()
 
@@ -153,9 +154,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,6 +3,7 @@ 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)
@@ -16,16 +17,16 @@ Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:10](http
 ### Constructor
 
 ```ts
-new SocialAuthGuard(_provider): SocialAuthGuard;
+new SocialAuthGuard(routeParam): SocialAuthGuard;
 ```
 
-Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L21)
+Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L20)
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `_provider` | `string` |
+| Parameter    | Type     |
+| ------------ | -------- |
+| `routeParam` | `string` |
 
 #### Returns
 
@@ -39,12 +40,12 @@ Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:21](http
 canActivate(context): boolean | Promise<boolean> | Observable<boolean>;
 ```
 
-Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L29)
+Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L28)
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
+| Parameter | Type               | Description                                                                               |
+| --------- | ------------------ | ----------------------------------------------------------------------------------------- |
 | `context` | `ExecutionContext` | Current execution context. Provides access to details about the current request pipeline. |
 
 #### Returns
@@ -57,5 +58,5 @@ proceed.
 #### Implementation of
 
 ```ts
-CanActivate.canActivate
+CanActivate.canActivate;
 ```

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

@@ -3,6 +3,7 @@ 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)
@@ -37,8 +38,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,6 +3,7 @@ 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)
@@ -36,8 +37,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.VerificationService.md

@@ -3,6 +3,7 @@ title: 'Class: VerificationService'
 generated: true
 editUrl: false
 ---
+
 # Class: VerificationService
 
 Defined in: [libs/platform-authentication/src/services/VerificationService.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L17)
@@ -15,9 +16,9 @@ Manages email / PIN verification tokens via the [VerificationSubjectPort](Class.
 
 ```ts
 new VerificationService(
-   jwtService, 
-   hostService, 
-   verificationSubject, 
+   jwtService,
+   hostService,
+   verificationSubject,
    configService): VerificationService;
 ```
 
@@ -27,12 +28,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
 
@@ -52,9 +53,9 @@ Constructs the verification link.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `token` | `string` | The verification token. |
+| Parameter | Type     | Description             |
+| --------- | -------- | ----------------------- |
+| `token`   | `string` | The verification token. |
 
 #### Returns
 
@@ -62,7 +63,7 @@ Constructs the verification link.
 
 The URL to verify the email.
 
-***
+---
 
 ### exhibitToken()
 
@@ -76,9 +77,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
 
@@ -86,7 +87,7 @@ Exhibits a new verification token.
 
 The verification token.
 
-***
+---
 
 ### redeemToken()
 
@@ -100,9 +101,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
 
@@ -110,7 +111,7 @@ Redeems the user's token.
 
 The token data.
 
-***
+---
 
 ### verifyPin()
 
@@ -122,16 +123,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()
 
@@ -145,9 +146,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,6 +3,7 @@ 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)
@@ -36,9 +37,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
 
@@ -46,7 +47,7 @@ Find a subject by login (user name or email).
 
 The verifiable subject or `null`.
 
-***
+---
 
 ### findByVerificationToken()
 
@@ -60,9 +61,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
 
@@ -70,7 +71,7 @@ Find a subject by its current verification token.
 
 The subject or `null`.
 
-***
+---
 
 ### markVerified()
 
@@ -84,15 +85,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()
 
@@ -106,10 +107,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
 

package/data/packages/platform-authentication/api/Function.Token.md

@@ -3,6 +3,7 @@ title: 'Function: Token()'
 generated: true
 editUrl: false
 ---
+
 # Function: Token()
 
 ```ts

package/data/packages/platform-authentication/api/Function.UseRoles.md

@@ -3,6 +3,7 @@ title: 'Function: UseRoles()'
 generated: true
 editUrl: false
 ---
+
 # Function: UseRoles()
 
 ```ts
@@ -15,8 +16,8 @@ Represents the `UseRoles` decorator.
 
 ## Parameters
 
-| Parameter | Type |
-| ------ | ------ |
+| Parameter  | Type       |
+| ---------- | ---------- |
 | ...`roles` | `string`[] |
 
 ## Returns

package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md

@@ -3,19 +3,20 @@ title: 'Function: socialAuthGuardFactory()'
 generated: true
 editUrl: false
 ---
+
 # Function: socialAuthGuardFactory()
 
 ```ts
-function socialAuthGuardFactory(provider): SocialAuthGuard;
+function socialAuthGuardFactory(routeParam): SocialAuthGuard;
 ```
 
-Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L42)
+Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L43)
 
 ## Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `provider` | `string` |
+| Parameter    | Type     |
+| ------------ | -------- |
+| `routeParam` | `string` |
 
 ## Returns
 

package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md

@@ -3,6 +3,7 @@ title: 'Interface: IAuthModuleOptions'
 generated: true
 editUrl: false
 ---
+
 # Interface: IAuthModuleOptions
 
 Defined in: [libs/platform-authentication/src/AuthModule.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L59)
@@ -23,7 +24,7 @@ Optional additional configuration entries to register (e.g. provider-specific OA
 Import them from the provider-specific sub-paths
 (e.g. `APPLE_AUTH_CONFIG_ENTRIES` from `@breadstone/archipel-platform-authentication/apple`).
 
-***
+---
 
 ### authSubject
 
@@ -35,7 +36,7 @@ Defined in: [libs/platform-authentication/src/AuthModule.ts:63](https://github.c
 
 Implementation of the auth subject port (user lookup for JWT/Local/Anonymous strategies).
 
-***
+---
 
 ### mfaSubject
 
@@ -47,7 +48,7 @@ Defined in: [libs/platform-authentication/src/AuthModule.ts:68](https://github.c
 
 Implementation of the MFA subject port (MFA state persistence).
 
-***
+---
 
 ### sessionPersistence
 
@@ -59,7 +60,7 @@ Defined in: [libs/platform-authentication/src/AuthModule.ts:73](https://github.c
 
 Implementation of the session persistence port.
 
-***
+---
 
 ### socialAuth?
 
@@ -72,7 +73,7 @@ Defined in: [libs/platform-authentication/src/AuthModule.ts:84](https://github.c
 Optional implementation of the social auth port (OAuth strategies).
 When provided together with `socialStrategies`, the social auth flow is enabled.
 
-***
+---
 
 ### socialStrategies?
 
@@ -87,7 +88,7 @@ Import them from the provider-specific sub-paths
 (e.g. `@breadstone/archipel-platform-authentication/apple`).
 Requires `socialAuth` to be set.
 
-***
+---
 
 ### tokenEnricher?
 
@@ -100,7 +101,7 @@ Defined in: [libs/platform-authentication/src/AuthModule.ts:105](https://github.
 Optional implementation of the token enricher port.
 When provided, additional claims are added to JWT tokens.
 
-***
+---
 
 ### verificationSubject
 

package/data/packages/platform-authentication/api/Interface.IAuthSubject.md

@@ -3,6 +3,7 @@ title: 'Interface: IAuthSubject'
 generated: true
 editUrl: false
 ---
+
 # Interface: IAuthSubject
 
 Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L7)
@@ -22,7 +23,7 @@ Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:23](http
 
 Email address.
 
-***
+---
 
 ### id
 
@@ -34,7 +35,7 @@ Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:13](http
 
 Unique identifier.
 
-***
+---
 
 ### isAnonymous
 
@@ -46,7 +47,7 @@ Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:38](http
 
 Whether the account is anonymous.
 
-***
+---
 
 ### isVerified
 
@@ -58,7 +59,7 @@ Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:33](http
 
 Whether the account has been verified (e.g. email confirmation).
 
-***
+---
 
 ### mfaEnabled
 
@@ -70,7 +71,7 @@ Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:48](http
 
 Whether MFA is enabled for this subject.
 
-***
+---
 
 ### password
 
@@ -82,7 +83,7 @@ Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:28](http
 
 Hashed password. `null` for social-only accounts.
 
-***
+---
 
 ### roles
 
@@ -94,7 +95,7 @@ Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:43](http
 
 Assigned role strings (e.g. `['user', 'admin']`).
 
-***
+---
 
 ### userName