@breadstone/archipel-mcp 0.0.1 → 0.0.2

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

@@ -3,11 +3,6 @@ title: 'Abstract Class: JwtPayloadBase'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # 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)
@@ -16,6 +11,31 @@ Abstract base class for JWT payloads.
 Products extend this to add their own claims (e.g. `profileId`, `isPro`).
 Used as both a serialization contract and NestJS injection token.
 
+## Constructors
+
+### Constructor
+
+```ts
+protected new JwtPayloadBase(
+   id, 
+   email, 
+   roles): JwtPayloadBase;
+```
+
+Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/JwtPayloadBase.ts#L40)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `id` | `string` |
+| `email` | `string` \| `null` |
+| `roles` | readonly `string`[] |
+
+#### Returns
+
+`JwtPayloadBase`
+
 ## Properties
 
 ### email
@@ -28,7 +48,7 @@ Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:19](https
 
 Email address.
 
----
+***
 
 ### exp?
 
@@ -40,7 +60,7 @@ Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:34](https
 
 Expiration timestamp (set by JWT library).
 
----
+***
 
 ### iat?
 
@@ -52,7 +72,7 @@ Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:29](https
 
 Issued-at timestamp (set by JWT library).
 
----
+***
 
 ### id
 
@@ -64,7 +84,7 @@ Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:14](https
 
 Subject identifier.
 
----
+***
 
 ### roles
 
@@ -91,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()
 

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

@@ -3,11 +3,6 @@ title: 'Class: LastActiveMiddleware'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # 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)
@@ -33,8 +28,8 @@ Constructs a new instance of the `LastActiveMiddleware` class.
 
 #### Parameters
 
-| Parameter        | Type                                     | Description              |
-| ---------------- | ---------------------------------------- | ------------------------ |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `sessionService` | [`SessionService`](Class.SessionService) | Session service instance |
 
 #### Returns
@@ -47,8 +42,8 @@ Constructs a new instance of the `LastActiveMiddleware` class.
 
 ```ts
 use(
-   req,
-   _res,
+   req, 
+   _res, 
    next): void;
 ```
 
@@ -59,11 +54,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
 
@@ -72,5 +67,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,11 +3,6 @@ title: 'Class: LocalAuthGuard'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # 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)
@@ -26,12 +21,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
@@ -41,5 +36,5 @@ Defined in: node_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
 #### Inherited from
 
 ```ts
-AuthGuard('local').constructor;
+AuthGuard('local').constructor
 ```

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

@@ -3,11 +3,6 @@ title: 'Class: MfaService'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # Class: MfaService
 
 Defined in: [libs/platform-authentication/src/services/MfaService.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L22)
@@ -20,9 +15,9 @@ Orchestrates MFA channels, backup codes, and user preferences.
 
 ```ts
 new MfaService(
-   bcryptService,
-   mfaSubject,
-   encryptionService,
+   bcryptService, 
+   mfaSubject, 
+   encryptionService, 
    channels): MfaService;
 ```
 
@@ -30,12 +25,12 @@ Defined in: [libs/platform-authentication/src/services/MfaService.ts:35](https:/
 
 #### Parameters
 
-| Parameter           | Type                                     |
-| ------------------- | ---------------------------------------- |
-| `bcryptService`     | `BcryptService`                          |
-| `mfaSubject`        | [`MfaSubjectPort`](Class.MfaSubjectPort) |
-| `encryptionService` | `MfaEncryptionService`                   |
-| `channels`          | `IMfaChannel`[]                          |
+| Parameter | Type |
+| ------ | ------ |
+| `bcryptService` | `BcryptService` |
+| `mfaSubject` | [`MfaSubjectPort`](Class.MfaSubjectPort) |
+| `encryptionService` | `MfaEncryptionService` |
+| `channels` | `IMfaChannel`[] |
 
 #### Returns
 
@@ -71,15 +66,15 @@ Disables MFA for a user and clears channel secrets.
 
 #### Parameters
 
-| Parameter | Type     |
-| --------- | -------- |
-| `userId`  | `string` |
+| Parameter | Type |
+| ------ | ------ |
+| `userId` | `string` |
 
 #### Returns
 
 `Promise`\<`void`\>
 
----
+***
 
 ### getEnabledMethods()
 
@@ -96,25 +91,25 @@ Returns enabled methods and preferred method for a user.
 
 #### Parameters
 
-| Parameter | Type     |
-| --------- | -------- |
-| `userId`  | `string` |
+| Parameter | Type |
+| ------ | ------ |
+| `userId` | `string` |
 
 #### Returns
 
 `Promise`\<\{
-`methods`: `string`[];
-`preferredMethod?`: `string`;
+  `methods`: `string`[];
+  `preferredMethod?`: `string`;
 \}\>
 
----
+***
 
 ### initSetup()
 
 ```ts
 initSetup(
-   userId,
-   method,
+   userId, 
+   method, 
 context?): Promise<IMfaSetup>;
 ```
 
@@ -124,17 +119,17 @@ Initializes setup for a specific MFA method.
 
 #### Parameters
 
-| Parameter  | Type               |
-| ---------- | ------------------ |
-| `userId`   | `string`           |
-| `method`   | `string`           |
+| Parameter | Type |
+| ------ | ------ |
+| `userId` | `string` |
+| `method` | `string` |
 | `context?` | `IMfaSetupContext` |
 
 #### Returns
 
 `Promise`\<[`IMfaSetup`](Interface.IMfaSetup)\>
 
----
+***
 
 ### issueChallenges()
 
@@ -148,16 +143,16 @@ Issues out-of-band challenge codes for login flows for applicable channels.
 
 #### Parameters
 
-| Parameter | Type                |
-| --------- | ------------------- |
-| `userId`  | `string`            |
+| Parameter | Type |
+| ------ | ------ |
+| `userId` | `string` |
 | `methods` | readonly `string`[] |
 
 #### Returns
 
 `Promise`\<`void`\>
 
----
+***
 
 ### regenerateBackupCodes()
 
@@ -171,15 +166,15 @@ Regenerates backup codes.
 
 #### Parameters
 
-| Parameter | Type     |
-| --------- | -------- |
-| `userId`  | `string` |
+| Parameter | Type |
+| ------ | ------ |
+| `userId` | `string` |
 
 #### Returns
 
 `Promise`\<readonly `string`[]\>
 
----
+***
 
 ### setPreferredMethod()
 
@@ -193,23 +188,23 @@ Updates the preferred MFA method.
 
 #### Parameters
 
-| Parameter | Type     |
-| --------- | -------- |
-| `userId`  | `string` |
-| `method`  | `string` |
+| Parameter | Type |
+| ------ | ------ |
+| `userId` | `string` |
+| `method` | `string` |
 
 #### Returns
 
 `Promise`\<`void`\>
 
----
+***
 
 ### verifyChallenge()
 
 ```ts
 verifyChallenge(
-   userId,
-   method,
+   userId, 
+   method, 
 code): Promise<boolean>;
 ```
 
@@ -219,24 +214,24 @@ Verifies a login challenge using the selected method or backup code.
 
 #### Parameters
 
-| Parameter | Type     |
-| --------- | -------- |
-| `userId`  | `string` |
-| `method`  | `string` |
-| `code`    | `string` |
+| Parameter | Type |
+| ------ | ------ |
+| `userId` | `string` |
+| `method` | `string` |
+| `code` | `string` |
 
 #### Returns
 
 `Promise`\<`boolean`\>
 
----
+***
 
 ### verifySetup()
 
 ```ts
 verifySetup(
-   userId,
-   method,
+   userId, 
+   method, 
 code): Promise<IMfaConfirmation>;
 ```
 
@@ -246,11 +241,11 @@ Verifies the initial code for a method and issues backup codes.
 
 #### Parameters
 
-| Parameter | Type     |
-| --------- | -------- |
-| `userId`  | `string` |
-| `method`  | `string` |
-| `code`    | `string` |
+| Parameter | Type |
+| ------ | ------ |
+| `userId` | `string` |
+| `method` | `string` |
+| `code` | `string` |
 
 #### Returns
 

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

@@ -3,11 +3,6 @@ title: 'Abstract Class: MfaSubjectPort'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # Abstract Class: MfaSubjectPort
 
 Defined in: [libs/platform-authentication/src/contracts/MfaSubjectPort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/MfaSubjectPort.ts#L14)
@@ -41,9 +36,9 @@ Find an MFA subject by its unique identifier.
 
 #### Parameters
 
-| Parameter | Type     | Description             |
-| --------- | -------- | ----------------------- |
-| `id`      | `string` | The subject identifier. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The subject identifier. |
 
 #### Returns
 
@@ -51,7 +46,7 @@ Find an MFA subject by its unique identifier.
 
 The MFA subject or `null`.
 
----
+***
 
 ### updateMfaState()
 
@@ -65,10 +60,10 @@ Update MFA-related fields on the subject.
 
 #### Parameters
 
-| Parameter | Type                                               | Description                 |
-| --------- | -------------------------------------------------- | --------------------------- |
-| `id`      | `string`                                           | The subject identifier.     |
-| `data`    | [`IMfaSubjectUpdate`](Interface.IMfaSubjectUpdate) | The partial update payload. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The subject identifier. |
+| `data` | [`IMfaSubjectUpdate`](Interface.IMfaSubjectUpdate) | The partial update payload. |
 
 #### Returns
 

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

@@ -0,0 +1,78 @@
+---
+title: 'Class: MicrosoftStrategy'
+generated: true
+editUrl: false
+---
+# Class: MicrosoftStrategy
+
+Defined in: [libs/platform-authentication/src/strategies/MicrosoftStrategy.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/MicrosoftStrategy.ts#L19)
+
+The `MicrosoftStrategy` integrates Microsoft OAuth authentication.
+
+## Extends
+
+- `Strategy`\<`this`\> & `PassportStrategyMixin`\<`unknown`, `this`\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new MicrosoftStrategy(socialAuth, configService): MicrosoftStrategy;
+```
+
+Defined in: [libs/platform-authentication/src/strategies/MicrosoftStrategy.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/MicrosoftStrategy.ts#L35)
+
+Initializes a new instance of the `MicrosoftStrategy` class.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `socialAuth` | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance. |
+| `configService` | `ConfigService` | Configuration service instance. |
+
+#### Returns
+
+`MicrosoftStrategy`
+
+#### Overrides
+
+```ts
+PassportStrategy(Strategy, 'microsoft').constructor
+```
+
+## Methods
+
+### validate()
+
+```ts
+validate(
+   accessToken, 
+   refreshToken, 
+profile): Promise<IAuthSubject>;
+```
+
+Defined in: [libs/platform-authentication/src/strategies/MicrosoftStrategy.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/MicrosoftStrategy.ts#L61)
+
+Validates the Microsoft authentication payload.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `accessToken` | `string` | OAuth access token. |
+| `refreshToken` | `string` | OAuth refresh token. |
+| `profile` | `Profile` | Microsoft profile data. |
+
+#### Returns
+
+`Promise`\<[`IAuthSubject`](Interface.IAuthSubject)\>
+
+The authenticated user.
+
+#### Overrides
+
+```ts
+PassportStrategy(Strategy, 'microsoft').validate
+```

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

@@ -3,11 +3,6 @@ title: 'Class: RolesGuard'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # Class: RolesGuard
 
 Defined in: [libs/platform-authentication/src/guards/RolesGuard.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/RolesGuard.ts#L13)
@@ -30,8 +25,8 @@ Constructs a new instance of the `RolesGuard` class.
 
 #### Parameters
 
-| Parameter   | Type        |
-| ----------- | ----------- |
+| Parameter | Type |
+| ------ | ------ |
 | `reflector` | `Reflector` |
 
 #### Returns
@@ -50,8 +45,8 @@ Defined in: [libs/platform-authentication/src/guards/RolesGuard.ts:38](https://g
 
 #### Parameters
 
-| Parameter | Type               |
-| --------- | ------------------ |
+| Parameter | Type |
+| ------ | ------ |
 | `context` | `ExecutionContext` |
 
 #### Returns
@@ -61,5 +56,5 @@ Defined in: [libs/platform-authentication/src/guards/RolesGuard.ts:38](https://g
 #### Implementation of
 
 ```ts
-CanActivate.canActivate;
+CanActivate.canActivate
 ```

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

@@ -3,11 +3,6 @@ title: 'Class: SessionMappingProfile'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # Class: SessionMappingProfile
 
 Defined in: [libs/platform-authentication/src/mappers/SessionMappingProfile.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mappers/SessionMappingProfile.ts#L39)
@@ -33,7 +28,7 @@ new SessionMappingProfile(): SessionMappingProfile;
 #### Inherited from
 
 ```ts
-MappingProfileBase.constructor;
+MappingProfileBase.constructor
 ```
 
 ## Methods
@@ -50,8 +45,8 @@ Configure mappings for Session entity.
 
 #### Parameters
 
-| Parameter | Type              | Description         |
-| --------- | ----------------- | ------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `builder` | `IMappingBuilder` | The mapping builder |
 
 #### Returns
@@ -61,5 +56,5 @@ Configure mappings for Session entity.
 #### Overrides
 
 ```ts
-MappingProfileBase.configure;
+MappingProfileBase.configure
 ```