@breadstone/archipel-mcp 0.0.9 → 0.0.11

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

@@ -3,16 +3,15 @@ title: 'Class: AppleConnector'
 generated: true
 editUrl: false
 ---
-
 # Class: AppleConnector
 
-Defined in: [libs/platform-authentication/src/connectors/AppleConnector.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/AppleConnector.ts#L22)
+Defined in: [libs/platform-authentication/src/connectors/AppleConnector.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/AppleConnector.ts#L29)
 
 The `AppleConnector` integrates Apple Sign In authentication.
 
 ## Extends
 
-- `_ConnectorBase`\<_typeof_ `AppleStrategy`, `this`\>
+- `_ConnectorBase`\<*typeof* `AppleStrategy`, `this`\>
 
 ## Indexable
 
@@ -28,16 +27,16 @@ The `AppleConnector` integrates Apple Sign In authentication.
 new AppleConnector(socialAuth, configService): AppleConnector;
 ```
 
-Defined in: [libs/platform-authentication/src/connectors/AppleConnector.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/AppleConnector.ts#L38)
+Defined in: [libs/platform-authentication/src/connectors/AppleConnector.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/AppleConnector.ts#L45)
 
 Initializes a new instance of the `AppleConnector` class.
 
 #### Parameters
 
-| Parameter       | Type                                     | Description                     |
-| --------------- | ---------------------------------------- | ------------------------------- |
-| `socialAuth`    | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance.      |
-| `configService` | `ConfigService`                          | Configuration service instance. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `socialAuth` | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance. |
+| `configService` | `ConfigService` | Configuration service instance. |
 
 #### Returns
 
@@ -46,7 +45,7 @@ Initializes a new instance of the `AppleConnector` class.
 #### Overrides
 
 ```ts
-ConnectorBase(Strategy, 'apple').constructor;
+ConnectorBase(Strategy, 'apple').constructor
 ```
 
 ## Methods
@@ -55,24 +54,24 @@ ConnectorBase(Strategy, 'apple').constructor;
 
 ```ts
 validate(
-   accessToken,
-   refreshToken,
-   idToken,
+   accessToken, 
+   refreshToken, 
+   idToken, 
 profile): Promise<IAuthSubject>;
 ```
 
-Defined in: [libs/platform-authentication/src/connectors/AppleConnector.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/AppleConnector.ts#L74)
+Defined in: [libs/platform-authentication/src/connectors/AppleConnector.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/AppleConnector.ts#L81)
 
 Validates the Apple authentication payload.
 
 #### Parameters
 
-| Parameter      | Type            | Description           |
-| -------------- | --------------- | --------------------- |
-| `accessToken`  | `string`        | OAuth access token.   |
-| `refreshToken` | `string`        | OAuth refresh token.  |
-| `idToken`      | `string`        | Apple identity token. |
-| `profile`      | `IAppleProfile` | Apple profile data.   |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `accessToken` | `string` | OAuth access token. |
+| `refreshToken` | `string` | OAuth refresh token. |
+| `idToken` | `string` | Apple identity token. |
+| `profile` | `IAppleProfile` | Apple profile data. |
 
 #### Returns
 
@@ -83,5 +82,5 @@ The authenticated user.
 #### Overrides
 
 ```ts
-ConnectorBase(Strategy, 'apple').validate;
+ConnectorBase(Strategy, 'apple').validate
 ```

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

@@ -3,10 +3,9 @@ title: 'Class: AuthModule'
 generated: true
 editUrl: false
 ---
-
 # Class: AuthModule
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:132](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L132)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:129](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L129)
 
 The `AuthModule` handles JWT-based authentication,
 including token creation and validation.
@@ -31,19 +30,19 @@ new AuthModule(): AuthModule;
 configure(consumer): void;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:235](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L235)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:232](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L232)
 
 #### Parameters
 
-| Parameter  | Type                 |
-| ---------- | -------------------- |
+| Parameter | Type |
+| ------ | ------ |
 | `consumer` | `MiddlewareConsumer` |
 
 #### Returns
 
 `void`
 
----
+***
 
 ### register()
 
@@ -51,14 +50,14 @@ Defined in: [libs/platform-authentication/src/AuthModule.ts:235](https://github.
 static register(options): DynamicModule;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:142](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L142)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:139](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L139)
 
 Registers the auth module with the provided port implementations.
 
 #### Parameters
 
-| Parameter | Type                                                 | Description                               |
-| --------- | ---------------------------------------------------- | ----------------------------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `options` | [`IAuthModuleOptions`](Interface.IAuthModuleOptions) | Port implementations for the auth module. |
 
 #### Returns

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

@@ -3,7 +3,6 @@ title: 'Abstract Class: AuthSubjectPort'
 generated: true
 editUrl: false
 ---
-
 # Abstract Class: AuthSubjectPort
 
 Defined in: [libs/platform-authentication/src/contracts/AuthSubjectPort.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/AuthSubjectPort.ts#L13)
@@ -37,8 +36,8 @@ Find the anonymous / seed subject by user name.
 
 #### Parameters
 
-| Parameter  | Type     | Description              |
-| ---------- | -------- | ------------------------ |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `userName` | `string` | The anonymous user name. |
 
 #### Returns
@@ -47,7 +46,7 @@ Find the anonymous / seed subject by user name.
 
 The subject or `null`.
 
----
+***
 
 ### findById()
 
@@ -61,9 +60,9 @@ Find a subject by its unique identifier.
 
 #### Parameters
 
-| Parameter | Type     | Description             |
-| --------- | -------- | ----------------------- |
-| `id`      | `string` | The subject identifier. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The subject identifier. |
 
 #### Returns
 
@@ -71,7 +70,7 @@ Find a subject by its unique identifier.
 
 The subject or `null`.
 
----
+***
 
 ### findByLogin()
 
@@ -85,9 +84,9 @@ Find a subject by its login name (user name or email).
 
 #### Parameters
 
-| Parameter | Type     | Description           |
-| --------- | -------- | --------------------- |
-| `login`   | `string` | The login identifier. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `login` | `string` | The login identifier. |
 
 #### Returns
 

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

@@ -3,7 +3,6 @@ title: 'Class: AuthTokenService'
 generated: true
 editUrl: false
 ---
-
 # Class: AuthTokenService
 
 Defined in: [libs/platform-authentication/src/services/AuthTokenService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/AuthTokenService.ts#L18)
@@ -26,9 +25,9 @@ Constructs a new instance of the `AuthTokenService` class.
 
 #### Parameters
 
-| Parameter       | Type                                                     | Description                   |
-| --------------- | -------------------------------------------------------- | ----------------------------- |
-| `jwtService`    | `JwtService`                                             | The NestJS JWT service.       |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `jwtService` | `JwtService` | The NestJS JWT service. |
 | `tokenEnricher` | [`TokenEnricherPort`](Class.TokenEnricherPort) \| `null` | Optional token enricher port. |
 
 #### Returns
@@ -49,8 +48,8 @@ Creates a signed JWT for the given subject.
 
 #### Parameters
 
-| Parameter | Type                                     | Description                |
-| --------- | ---------------------------------------- | -------------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `subject` | [`IAuthSubject`](Interface.IAuthSubject) | The authenticated subject. |
 
 #### Returns

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

@@ -3,7 +3,6 @@ title: 'Class: ChallengeService'
 generated: true
 editUrl: false
 ---
-
 # Class: ChallengeService
 
 Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L30)
@@ -22,8 +21,8 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:41](h
 
 #### Parameters
 
-| Parameter       | Type            |
-| --------------- | --------------- |
+| Parameter | Type |
+| ------ | ------ |
 | `configService` | `ConfigService` |
 
 #### Returns
@@ -36,12 +35,12 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:41](h
 
 ```ts
 create(
-   userId,
-   methods,
-   preferredMethod?,
-   ipAddress?,
-   userAgent?,
-   location?,
+   userId, 
+   methods, 
+   preferredMethod?, 
+   ipAddress?, 
+   userAgent?, 
+   location?, 
 clientName?): Promise<IMfaChallengeState>;
 ```
 
@@ -51,21 +50,21 @@ Issues a new MFA challenge for a user.
 
 #### Parameters
 
-| Parameter          | Type       |
-| ------------------ | ---------- |
-| `userId`           | `string`   |
-| `methods`          | `string`[] |
-| `preferredMethod?` | `string`   |
-| `ipAddress?`       | `string`   |
-| `userAgent?`       | `string`   |
-| `location?`        | `string`   |
-| `clientName?`      | `string`   |
+| Parameter | Type |
+| ------ | ------ |
+| `userId` | `string` |
+| `methods` | `string`[] |
+| `preferredMethod?` | `string` |
+| `ipAddress?` | `string` |
+| `userAgent?` | `string` |
+| `location?` | `string` |
+| `clientName?` | `string` |
 
 #### Returns
 
 `Promise`\<[`IMfaChallengeState`](Interface.IMfaChallengeState)\>
 
----
+***
 
 ### get()
 
@@ -79,15 +78,15 @@ Retrieves an active challenge, throwing if invalid or expired.
 
 #### Parameters
 
-| Parameter     | Type     |
-| ------------- | -------- |
+| Parameter | Type |
+| ------ | ------ |
 | `challengeId` | `string` |
 
 #### Returns
 
 `Promise`\<[`IMfaChallengeState`](Interface.IMfaChallengeState)\>
 
----
+***
 
 ### incrementAttempts()
 
@@ -101,15 +100,15 @@ Increments failed attempts and optionally invalidates the challenge.
 
 #### Parameters
 
-| Parameter     | Type     |
-| ------------- | -------- |
+| Parameter | Type |
+| ------ | ------ |
 | `challengeId` | `string` |
 
 #### Returns
 
 `Promise`\<[`IMfaChallengeState`](Interface.IMfaChallengeState)\>
 
----
+***
 
 ### invalidate()
 
@@ -123,8 +122,8 @@ Invalidates a challenge after successful verification.
 
 #### Parameters
 
-| Parameter     | Type     |
-| ------------- | -------- |
+| Parameter | Type |
+| ------ | ------ |
 | `challengeId` | `string` |
 
 #### Returns

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

@@ -3,7 +3,6 @@ title: 'Class: GithubAuthGuard'
 generated: true
 editUrl: false
 ---
-
 # Class: GithubAuthGuard
 
 Defined in: [libs/platform-authentication/src/guards/GithubAuthGuard.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/GithubAuthGuard.ts#L14)
@@ -22,12 +21,12 @@ The `GithubAuthGuard` protects routes using GitHub authentication.
 new GithubAuthGuard(...args): GithubAuthGuard;
 ```
 
-Defined in: node_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
+Defined in: node\_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
 
 #### Parameters
 
-| Parameter | Type    |
-| --------- | ------- |
+| Parameter | Type |
+| ------ | ------ |
 | ...`args` | `any`[] |
 
 #### Returns
@@ -37,5 +36,5 @@ Defined in: node_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
 #### Inherited from
 
 ```ts
-AuthGuard('github').constructor;
+AuthGuard('github').constructor
 ```

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

@@ -3,14 +3,13 @@ title: 'Class: GithubConnector'
 generated: true
 editUrl: false
 ---
-
 # Class: GithubConnector
 
 Defined in: [libs/platform-authentication/src/connectors/GithubConnector.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/GithubConnector.ts#L14)
 
 ## Extends
 
-- `_ConnectorBase`\<_typeof_ `Strategy`, `this`\>
+- `_ConnectorBase`\<*typeof* `Strategy`, `this`\>
 
 ## Indexable
 
@@ -32,10 +31,10 @@ Constructs a new instance of the `GithubConnector` class.
 
 #### Parameters
 
-| Parameter       | Type                                     | Description                     |
-| --------------- | ---------------------------------------- | ------------------------------- |
-| `socialAuth`    | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance.      |
-| `configService` | `ConfigService`                          | Configuration service instance. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `socialAuth` | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance. |
+| `configService` | `ConfigService` | Configuration service instance. |
 
 #### Returns
 
@@ -44,7 +43,7 @@ Constructs a new instance of the `GithubConnector` class.
 #### Overrides
 
 ```ts
-ConnectorBase(Strategy, 'github').constructor;
+ConnectorBase(Strategy, 'github').constructor
 ```
 
 ## Methods
@@ -53,8 +52,8 @@ ConnectorBase(Strategy, 'github').constructor;
 
 ```ts
 validate(
-   _accessToken,
-   _refreshToken,
+   _accessToken, 
+   _refreshToken, 
 profile): Promise<IAuthSubject>;
 ```
 
@@ -62,11 +61,11 @@ Defined in: [libs/platform-authentication/src/connectors/GithubConnector.ts:54](
 
 #### Parameters
 
-| Parameter       | Type      |
-| --------------- | --------- |
-| `_accessToken`  | `string`  |
-| `_refreshToken` | `string`  |
-| `profile`       | `Profile` |
+| Parameter | Type |
+| ------ | ------ |
+| `_accessToken` | `string` |
+| `_refreshToken` | `string` |
+| `profile` | `Profile` |
 
 #### Returns
 
@@ -75,5 +74,5 @@ Defined in: [libs/platform-authentication/src/connectors/GithubConnector.ts:54](
 #### Overrides
 
 ```ts
-ConnectorBase(Strategy, 'github').validate;
+ConnectorBase(Strategy, 'github').validate
 ```

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

@@ -3,7 +3,6 @@ title: 'Class: GoogleConnector'
 generated: true
 editUrl: false
 ---
-
 # Class: GoogleConnector
 
 Defined in: [libs/platform-authentication/src/connectors/GoogleConnector.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/GoogleConnector.ts#L19)
@@ -12,7 +11,7 @@ The `GoogleConnector` integrates Google OAuth authentication.
 
 ## Extends
 
-- `_ConnectorBase`\<_typeof_ `Strategy`, `this`\>
+- `_ConnectorBase`\<*typeof* `Strategy`, `this`\>
 
 ## Indexable
 
@@ -34,10 +33,10 @@ Initializes a new instance of the `GoogleConnector` class.
 
 #### Parameters
 
-| Parameter       | Type                                     | Description                     |
-| --------------- | ---------------------------------------- | ------------------------------- |
-| `socialAuth`    | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance.      |
-| `configService` | `ConfigService`                          | Configuration service instance. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `socialAuth` | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance. |
+| `configService` | `ConfigService` | Configuration service instance. |
 
 #### Returns
 
@@ -46,7 +45,7 @@ Initializes a new instance of the `GoogleConnector` class.
 #### Overrides
 
 ```ts
-ConnectorBase(Strategy, 'google').constructor;
+ConnectorBase(Strategy, 'google').constructor
 ```
 
 ## Methods
@@ -55,8 +54,8 @@ ConnectorBase(Strategy, 'google').constructor;
 
 ```ts
 validate(
-   accessToken,
-   refreshToken,
+   accessToken, 
+   refreshToken, 
 profile): Promise<IAuthSubject>;
 ```
 
@@ -66,11 +65,11 @@ Validates the Google authentication payload.
 
 #### Parameters
 
-| Parameter      | Type      | Description          |
-| -------------- | --------- | -------------------- |
-| `accessToken`  | `string`  | OAuth access token.  |
-| `refreshToken` | `string`  | OAuth refresh token. |
-| `profile`      | `Profile` | Google profile data. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `accessToken` | `string` | OAuth access token. |
+| `refreshToken` | `string` | OAuth refresh token. |
+| `profile` | `Profile` | Google profile data. |
 
 #### Returns
 
@@ -81,5 +80,5 @@ The authenticated user.
 #### Overrides
 
 ```ts
-ConnectorBase(Strategy, 'google').validate;
+ConnectorBase(Strategy, 'google').validate
 ```

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

@@ -3,7 +3,6 @@ title: 'Class: JwtAuthGuard'
 generated: true
 editUrl: false
 ---
-
 # Class: JwtAuthGuard
 
 Defined in: [libs/platform-authentication/src/guards/JwtAuthGuard.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/JwtAuthGuard.ts#L14)
@@ -22,12 +21,12 @@ The `JwtAuthGuard` protects routes using JWT-based authentication.
 new JwtAuthGuard(...args): JwtAuthGuard;
 ```
 
-Defined in: node_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
+Defined in: node\_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
 
 #### Parameters
 
-| Parameter | Type    |
-| --------- | ------- |
+| Parameter | Type |
+| ------ | ------ |
 | ...`args` | `any`[] |
 
 #### Returns
@@ -37,5 +36,5 @@ Defined in: node_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
 #### Inherited from
 
 ```ts
-AuthGuard('jwt').constructor;
+AuthGuard('jwt').constructor
 ```

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

@@ -3,7 +3,6 @@ title: 'Abstract Class: JwtPayloadBase'
 generated: true
 editUrl: false
 ---
-
 # Abstract Class: JwtPayloadBase
 
 Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/JwtPayloadBase.ts#L8)
@@ -18,8 +17,8 @@ Used as both a serialization contract and NestJS injection token.
 
 ```ts
 protected new JwtPayloadBase(
-   id,
-   email,
+   id, 
+   email, 
    roles): JwtPayloadBase;
 ```
 
@@ -27,11 +26,11 @@ Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:40](https
 
 #### Parameters
 
-| Parameter | Type                |
-| --------- | ------------------- |
-| `id`      | `string`            |
-| `email`   | `string` \| `null`  |
-| `roles`   | readonly `string`[] |
+| Parameter | Type |
+| ------ | ------ |
+| `id` | `string` |
+| `email` | `string` \| `null` |
+| `roles` | readonly `string`[] |
 
 #### Returns
 
@@ -49,7 +48,7 @@ Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:19](https
 
 Email address.
 
----
+***
 
 ### exp?
 
@@ -61,7 +60,7 @@ Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:34](https
 
 Expiration timestamp (set by JWT library).
 
----
+***
 
 ### iat?
 
@@ -73,7 +72,7 @@ Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:29](https
 
 Issued-at timestamp (set by JWT library).
 
----
+***
 
 ### id
 
@@ -85,7 +84,7 @@ Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:14](https
 
 Subject identifier.
 
----
+***
 
 ### roles
 
@@ -112,15 +111,15 @@ Subclasses **must** override this static-like factory on a per-product basis.
 
 #### Parameters
 
-| Parameter | Type                            | Description                  |
-| --------- | ------------------------------- | ---------------------------- |
-| `raw`     | `Record`\<`string`, `unknown`\> | The raw decoded JWT payload. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `raw` | `Record`\<`string`, `unknown`\> | The raw decoded JWT payload. |
 
 #### Returns
 
 `JwtPayloadBase`
 
----
+***
 
 ### toJSON()