@breadstone/archipel-mcp 0.0.2 → 0.0.4

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

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

@@ -3,9 +3,10 @@ title: 'Class: GithubStrategy'
 generated: true
 editUrl: false
 ---
+
 # Class: GithubStrategy
 
-Defined in: [libs/platform-authentication/src/strategies/GithubStrategy.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GithubStrategy.ts#L18)
+Defined in: [libs/platform-authentication/src/strategies/GithubStrategy.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GithubStrategy.ts#L13)
 
 ## Extends
 
@@ -19,16 +20,16 @@ Defined in: [libs/platform-authentication/src/strategies/GithubStrategy.ts:18](h
 new GithubStrategy(socialAuth, configService): GithubStrategy;
 ```
 
-Defined in: [libs/platform-authentication/src/strategies/GithubStrategy.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GithubStrategy.ts#L35)
+Defined in: [libs/platform-authentication/src/strategies/GithubStrategy.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GithubStrategy.ts#L29)
 
 Constructs a new instance of the `GithubStrategy` 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
 
@@ -37,7 +38,7 @@ Constructs a new instance of the `GithubStrategy` class.
 #### Overrides
 
 ```ts
-PassportStrategy(Strategy, 'github').constructor
+PassportStrategy(Strategy, 'github').constructor;
 ```
 
 ## Methods
@@ -46,20 +47,20 @@ PassportStrategy(Strategy, 'github').constructor
 
 ```ts
 validate(
-   _accessToken, 
-   _refreshToken, 
+   _accessToken,
+   _refreshToken,
 profile): Promise<IAuthSubject>;
 ```
 
-Defined in: [libs/platform-authentication/src/strategies/GithubStrategy.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GithubStrategy.ts#L55)
+Defined in: [libs/platform-authentication/src/strategies/GithubStrategy.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GithubStrategy.ts#L46)
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `_accessToken` | `string` |
-| `_refreshToken` | `string` |
-| `profile` | `Profile` |
+| Parameter       | Type      |
+| --------------- | --------- |
+| `_accessToken`  | `string`  |
+| `_refreshToken` | `string`  |
+| `profile`       | `Profile` |
 
 #### Returns
 
@@ -68,5 +69,5 @@ Defined in: [libs/platform-authentication/src/strategies/GithubStrategy.ts:55](h
 #### Overrides
 
 ```ts
-PassportStrategy(Strategy, 'github').validate
+PassportStrategy(Strategy, 'github').validate;
 ```

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

@@ -3,6 +3,7 @@ title: 'Class: GoogleStrategy'
 generated: true
 editUrl: false
 ---
+
 # Class: GoogleStrategy
 
 Defined in: [libs/platform-authentication/src/strategies/GoogleStrategy.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GoogleStrategy.ts#L18)
@@ -27,10 +28,10 @@ Initializes a new instance of the `GoogleStrategy` 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
 
@@ -39,7 +40,7 @@ Initializes a new instance of the `GoogleStrategy` class.
 #### Overrides
 
 ```ts
-PassportStrategy(Strategy, 'google').constructor
+PassportStrategy(Strategy, 'google').constructor;
 ```
 
 ## Methods
@@ -48,8 +49,8 @@ PassportStrategy(Strategy, 'google').constructor
 
 ```ts
 validate(
-   accessToken, 
-   refreshToken, 
+   accessToken,
+   refreshToken,
 profile): Promise<IAuthSubject>;
 ```
 
@@ -59,11 +60,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
 
@@ -74,5 +75,5 @@ The authenticated user.
 #### Overrides
 
 ```ts
-PassportStrategy(Strategy, 'google').validate
+PassportStrategy(Strategy, 'google').validate;
 ```

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

@@ -3,6 +3,7 @@ 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)
@@ -21,12 +22,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
@@ -36,5 +37,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,6 +3,7 @@ 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)
@@ -17,8 +18,8 @@ Used as both a serialization contract and NestJS injection token.
 
 ```ts
 protected new JwtPayloadBase(
-   id, 
-   email, 
+   id,
+   email,
    roles): JwtPayloadBase;
 ```
 
@@ -26,11 +27,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
 
@@ -48,7 +49,7 @@ Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:19](https
 
 Email address.
 
-***
+---
 
 ### exp?
 
@@ -60,7 +61,7 @@ Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:34](https
 
 Expiration timestamp (set by JWT library).
 
-***
+---
 
 ### iat?
 
@@ -72,7 +73,7 @@ Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:29](https
 
 Issued-at timestamp (set by JWT library).
 
-***
+---
 
 ### id
 
@@ -84,7 +85,7 @@ Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:14](https
 
 Subject identifier.
 
-***
+---
 
 ### roles
 
@@ -111,15 +112,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()
 

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

@@ -3,6 +3,7 @@ title: 'Class: LastActiveMiddleware'
 generated: true
 editUrl: false
 ---
+
 # Class: LastActiveMiddleware
 
 Defined in: [libs/platform-authentication/src/middlewares/LastActiveMiddleware.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/middlewares/LastActiveMiddleware.ts#L16)
@@ -28,8 +29,8 @@ Constructs a new instance of the `LastActiveMiddleware` class.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
+| Parameter        | Type                                     | Description              |
+| ---------------- | ---------------------------------------- | ------------------------ |
 | `sessionService` | [`SessionService`](Class.SessionService) | Session service instance |
 
 #### Returns
@@ -42,8 +43,8 @@ Constructs a new instance of the `LastActiveMiddleware` class.
 
 ```ts
 use(
-   req, 
-   _res, 
+   req,
+   _res,
    next): void;
 ```
 
@@ -54,11 +55,11 @@ Extracts token from Authorization header and updates lastActive timestamp asynch
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `req` | `Request` | Express request object |
-| `_res` | `Response` | Express response object (unused) |
-| `next` | `NextFunction` | Next middleware function |
+| Parameter | Type           | Description                      |
+| --------- | -------------- | -------------------------------- |
+| `req`     | `Request`      | Express request object           |
+| `_res`    | `Response`     | Express response object (unused) |
+| `next`    | `NextFunction` | Next middleware function         |
 
 #### Returns
 
@@ -67,5 +68,5 @@ Extracts token from Authorization header and updates lastActive timestamp asynch
 #### Implementation of
 
 ```ts
-NestMiddleware.use
+NestMiddleware.use;
 ```

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

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