@breadstone/archipel-mcp 0.0.8 → 0.0.10

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

@@ -3,10 +3,9 @@ title: 'Class: MfaService'
 generated: true
 editUrl: false
 ---
-
 # 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)
+Defined in: [libs/platform-authentication/src/mfa/MfaService.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/MfaService.ts#L22)
 
 Orchestrates MFA channels, backup codes, and user preferences.
 
@@ -16,22 +15,22 @@ Orchestrates MFA channels, backup codes, and user preferences.
 
 ```ts
 new MfaService(
-   bcryptService,
-   mfaSubject,
-   encryptionService,
+   bcryptService, 
+   mfaSubject, 
+   encryptionService, 
    channels): MfaService;
 ```
 
-Defined in: [libs/platform-authentication/src/services/MfaService.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L35)
+Defined in: [libs/platform-authentication/src/mfa/MfaService.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/MfaService.ts#L35)
 
 #### 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
 
@@ -47,7 +46,7 @@ Defined in: [libs/platform-authentication/src/services/MfaService.ts:35](https:/
 get registeredMethods(): string[];
 ```
 
-Defined in: [libs/platform-authentication/src/services/MfaService.ts:249](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L249)
+Defined in: [libs/platform-authentication/src/mfa/MfaService.ts:249](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/MfaService.ts#L249)
 
 ##### Returns
 
@@ -61,21 +60,21 @@ Defined in: [libs/platform-authentication/src/services/MfaService.ts:249](https:
 disable(userId): Promise<void>;
 ```
 
-Defined in: [libs/platform-authentication/src/services/MfaService.ts:237](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L237)
+Defined in: [libs/platform-authentication/src/mfa/MfaService.ts:237](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/MfaService.ts#L237)
 
 Disables MFA for a user and clears channel secrets.
 
 #### Parameters
 
-| Parameter | Type     |
-| --------- | -------- |
-| `userId`  | `string` |
+| Parameter | Type |
+| ------ | ------ |
+| `userId` | `string` |
 
 #### Returns
 
 `Promise`\<`void`\>
 
----
+***
 
 ### getEnabledMethods()
 
@@ -86,51 +85,51 @@ getEnabledMethods(userId): Promise<{
 }>;
 ```
 
-Defined in: [libs/platform-authentication/src/services/MfaService.ts:146](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L146)
+Defined in: [libs/platform-authentication/src/mfa/MfaService.ts:146](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/MfaService.ts#L146)
 
 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>;
 ```
 
-Defined in: [libs/platform-authentication/src/services/MfaService.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L55)
+Defined in: [libs/platform-authentication/src/mfa/MfaService.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/MfaService.ts#L55)
 
 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()
 
@@ -138,22 +137,22 @@ Initializes setup for a specific MFA method.
 issueChallenges(userId, methods): Promise<void>;
 ```
 
-Defined in: [libs/platform-authentication/src/services/MfaService.ts:183](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L183)
+Defined in: [libs/platform-authentication/src/mfa/MfaService.ts:183](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/MfaService.ts#L183)
 
 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()
 
@@ -161,21 +160,21 @@ Issues out-of-band challenge codes for login flows for applicable channels.
 regenerateBackupCodes(userId): Promise<readonly string[]>;
 ```
 
-Defined in: [libs/platform-authentication/src/services/MfaService.ts:219](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L219)
+Defined in: [libs/platform-authentication/src/mfa/MfaService.ts:219](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/MfaService.ts#L219)
 
 Regenerates backup codes.
 
 #### Parameters
 
-| Parameter | Type     |
-| --------- | -------- |
-| `userId`  | `string` |
+| Parameter | Type |
+| ------ | ------ |
+| `userId` | `string` |
 
 #### Returns
 
 `Promise`\<readonly `string`[]\>
 
----
+***
 
 ### setPreferredMethod()
 
@@ -183,70 +182,70 @@ Regenerates backup codes.
 setPreferredMethod(userId, method): Promise<void>;
 ```
 
-Defined in: [libs/platform-authentication/src/services/MfaService.ts:199](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L199)
+Defined in: [libs/platform-authentication/src/mfa/MfaService.ts:199](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/MfaService.ts#L199)
 
 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>;
 ```
 
-Defined in: [libs/platform-authentication/src/services/MfaService.ts:103](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L103)
+Defined in: [libs/platform-authentication/src/mfa/MfaService.ts:103](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/MfaService.ts#L103)
 
 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>;
 ```
 
-Defined in: [libs/platform-authentication/src/services/MfaService.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L73)
+Defined in: [libs/platform-authentication/src/mfa/MfaService.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/MfaService.ts#L73)
 
 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,7 +3,6 @@ title: 'Abstract Class: MfaSubjectPort'
 generated: true
 editUrl: false
 ---
-
 # 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)
@@ -37,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
 
@@ -47,7 +46,7 @@ Find an MFA subject by its unique identifier.
 
 The MFA subject or `null`.
 
----
+***
 
 ### updateMfaState()
 
@@ -61,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.MicrosoftConnector.md

@@ -0,0 +1,84 @@
+---
+title: 'Class: MicrosoftConnector'
+generated: true
+editUrl: false
+---
+# Class: MicrosoftConnector
+
+Defined in: [libs/platform-authentication/src/connectors/MicrosoftConnector.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/MicrosoftConnector.ts#L26)
+
+The `MicrosoftConnector` integrates Microsoft OAuth authentication.
+
+## Extends
+
+- `_ConnectorBase`\<*typeof* `Strategy`, `this`\>
+
+## Indexable
+
+```ts
+[key: string]: any
+```
+
+## Constructors
+
+### Constructor
+
+```ts
+new MicrosoftConnector(socialAuth, configService): MicrosoftConnector;
+```
+
+Defined in: [libs/platform-authentication/src/connectors/MicrosoftConnector.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/MicrosoftConnector.ts#L42)
+
+Initializes a new instance of the `MicrosoftConnector` class.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `socialAuth` | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance. |
+| `configService` | `ConfigService` | Configuration service instance. |
+
+#### Returns
+
+`MicrosoftConnector`
+
+#### Overrides
+
+```ts
+ConnectorBase(Strategy, 'microsoft').constructor
+```
+
+## Methods
+
+### validate()
+
+```ts
+validate(
+   accessToken, 
+   refreshToken, 
+profile): Promise<IAuthSubject>;
+```
+
+Defined in: [libs/platform-authentication/src/connectors/MicrosoftConnector.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/MicrosoftConnector.ts#L74)
+
+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
+ConnectorBase(Strategy, 'microsoft').validate
+```

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

@@ -3,7 +3,6 @@ title: 'Class: RolesGuard'
 generated: true
 editUrl: false
 ---
-
 # 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)
@@ -26,8 +25,8 @@ Constructs a new instance of the `RolesGuard` class.
 
 #### Parameters
 
-| Parameter   | Type        |
-| ----------- | ----------- |
+| Parameter | Type |
+| ------ | ------ |
 | `reflector` | `Reflector` |
 
 #### Returns
@@ -46,8 +45,8 @@ Defined in: [libs/platform-authentication/src/guards/RolesGuard.ts:38](https://g
 
 #### Parameters
 
-| Parameter | Type               |
-| --------- | ------------------ |
+| Parameter | Type |
+| ------ | ------ |
 | `context` | `ExecutionContext` |
 
 #### Returns
@@ -57,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,7 +3,6 @@ title: 'Class: SessionMappingProfile'
 generated: true
 editUrl: false
 ---
-
 # 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)
@@ -29,7 +28,7 @@ new SessionMappingProfile(): SessionMappingProfile;
 #### Inherited from
 
 ```ts
-MappingProfileBase.constructor;
+MappingProfileBase.constructor
 ```
 
 ## Methods
@@ -46,8 +45,8 @@ Configure mappings for Session entity.
 
 #### Parameters
 
-| Parameter | Type              | Description         |
-| --------- | ----------------- | ------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `builder` | `IMappingBuilder` | The mapping builder |
 
 #### Returns
@@ -57,5 +56,5 @@ Configure mappings for Session entity.
 #### Overrides
 
 ```ts
-MappingProfileBase.configure;
+MappingProfileBase.configure
 ```

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

@@ -3,7 +3,6 @@ title: 'Abstract Class: SessionPersistencePort'
 generated: true
 editUrl: false
 ---
-
 # Abstract Class: SessionPersistencePort
 
 Defined in: [libs/platform-authentication/src/contracts/SessionPersistencePort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/SessionPersistencePort.ts#L14)
@@ -37,9 +36,9 @@ Find all sessions for a given user.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `userId`  | `string` | The user identifier. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `userId` | `string` | The user identifier. |
 
 #### Returns
 
@@ -47,7 +46,7 @@ Find all sessions for a given user.
 
 Sessions ordered by last activity descending.
 
----
+***
 
 ### findByToken()
 
@@ -61,9 +60,9 @@ Find a session by its token.
 
 #### Parameters
 
-| Parameter | Type     | Description        |
-| --------- | -------- | ------------------ |
-| `token`   | `string` | The session token. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `token` | `string` | The session token. |
 
 #### Returns
 
@@ -71,7 +70,7 @@ Find a session by its token.
 
 The session record or `null`.
 
----
+***
 
 ### invalidate()
 
@@ -85,9 +84,9 @@ Invalidate (delete) a session by its token.
 
 #### Parameters
 
-| Parameter | Type     | Description        |
-| --------- | -------- | ------------------ |
-| `token`   | `string` | The session token. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `token` | `string` | The session token. |
 
 #### Returns
 
@@ -95,7 +94,7 @@ Invalidate (delete) a session by its token.
 
 `true` if a session was invalidated.
 
----
+***
 
 ### invalidateById()
 
@@ -109,10 +108,10 @@ Invalidate (delete) a session by its record id and owning user id.
 
 #### Parameters
 
-| Parameter | Type     | Description                    |
-| --------- | -------- | ------------------------------ |
-| `id`      | `string` | The session record identifier. |
-| `userId`  | `string` | The owning user identifier.    |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The session record identifier. |
+| `userId` | `string` | The owning user identifier. |
 
 #### Returns
 
@@ -120,7 +119,7 @@ Invalidate (delete) a session by its record id and owning user id.
 
 `true` if a session was invalidated.
 
----
+***
 
 ### store()
 
@@ -134,15 +133,15 @@ Store or update a session.
 
 #### Parameters
 
-| Parameter | Type                                               | Description                |
-| --------- | -------------------------------------------------- | -------------------------- |
-| `args`    | [`IStoreSessionArgs`](Interface.IStoreSessionArgs) | The session data to store. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | [`IStoreSessionArgs`](Interface.IStoreSessionArgs) | The session data to store. |
 
 #### Returns
 
 `Promise`\<`void`\>
 
----
+***
 
 ### updateLastActive()
 
@@ -156,10 +155,10 @@ Update the last-active timestamp for a session.
 
 #### Parameters
 
-| Parameter | Type     | Description               |
-| --------- | -------- | ------------------------- |
-| `token`   | `string` | The session token.        |
-| `date`    | `Date`   | The new last-active date. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `token` | `string` | The session token. |
+| `date` | `Date` | The new last-active date. |
 
 #### Returns