@breadstone/archipel-mcp 0.0.9 → 0.0.10

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

@@ -3,7 +3,6 @@ title: 'Class: TotpMfaChannel'
 generated: true
 editUrl: false
 ---
-
 # Class: TotpMfaChannel
 
 Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts#L16)
@@ -18,9 +17,9 @@ Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:16]
 
 ```ts
 new TotpMfaChannel(
-   mfaSubject,
-   configService,
-   encryptionService,
+   mfaSubject, 
+   configService, 
+   encryptionService, 
    otpService): TotpMfaChannel;
 ```
 
@@ -28,12 +27,12 @@ Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:31]
 
 #### Parameters
 
-| Parameter           | Type                                     |
-| ------------------- | ---------------------------------------- |
-| `mfaSubject`        | [`MfaSubjectPort`](Class.MfaSubjectPort) |
-| `configService`     | `ConfigService`                          |
-| `encryptionService` | `MfaEncryptionService`                   |
-| `otpService`        | `IOtpService`                            |
+| Parameter | Type |
+| ------ | ------ |
+| `mfaSubject` | [`MfaSubjectPort`](Class.MfaSubjectPort) |
+| `configService` | `ConfigService` |
+| `encryptionService` | `MfaEncryptionService` |
+| `otpService` | `IOtpService` |
 
 #### Returns
 
@@ -54,7 +53,7 @@ Unique identifier of the MFA method (e.g., `totp`, `sms`, `email`).
 #### Implementation of
 
 ```ts
-IMfaChannel.method;
+IMfaChannel.method
 ```
 
 ## Methods
@@ -71,10 +70,10 @@ Initializes the setup flow for the channel and persists any channel-specific boo
 
 #### Parameters
 
-| Parameter   | Type               | Description                            |
-| ----------- | ------------------ | -------------------------------------- |
-| `userId`    | `string`           | Identifier of the user starting setup. |
-| `_context?` | `IMfaSetupContext` | -                                      |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `userId` | `string` | Identifier of the user starting setup. |
+| `_context?` | `IMfaSetupContext` | - |
 
 #### Returns
 
@@ -83,10 +82,10 @@ Initializes the setup flow for the channel and persists any channel-specific boo
 #### Implementation of
 
 ```ts
-IMfaChannel.initSetup;
+IMfaChannel.initSetup
 ```
 
----
+***
 
 ### verifyChallenge()
 
@@ -100,10 +99,10 @@ Verifies a challenge code during login.
 
 #### Parameters
 
-| Parameter | Type     | Description                        |
-| --------- | -------- | ---------------------------------- |
-| `userId`  | `string` | Identifier of the challenged user. |
-| `code`    | `string` | User supplied challenge code.      |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `userId` | `string` | Identifier of the challenged user. |
+| `code` | `string` | User supplied challenge code. |
 
 #### Returns
 
@@ -112,10 +111,10 @@ Verifies a challenge code during login.
 #### Implementation of
 
 ```ts
-IMfaChannel.verifyChallenge;
+IMfaChannel.verifyChallenge
 ```
 
----
+***
 
 ### verifySetup()
 
@@ -129,10 +128,10 @@ Verifies the first setup code and marks the channel as ready for challenges.
 
 #### Parameters
 
-| Parameter | Type     | Description                             |
-| --------- | -------- | --------------------------------------- |
-| `userId`  | `string` | Identifier of the user finishing setup. |
-| `code`    | `string` | User supplied setup code.               |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `userId` | `string` | Identifier of the user finishing setup. |
+| `code` | `string` | User supplied setup code. |
 
 #### Returns
 
@@ -141,5 +140,5 @@ Verifies the first setup code and marks the channel as ready for challenges.
 #### Implementation of
 
 ```ts
-IMfaChannel.verifySetup;
+IMfaChannel.verifySetup
 ```

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

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

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

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

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

@@ -3,7 +3,6 @@ title: 'Function: socialAuthGuardFactory()'
 generated: true
 editUrl: false
 ---
-
 # Function: socialAuthGuardFactory()
 
 ```ts
@@ -14,8 +13,8 @@ Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:43](http
 
 ## Parameters
 
-| Parameter    | Type     |
-| ------------ | -------- |
+| Parameter | Type |
+| ------ | ------ |
 | `routeParam` | `string` |
 
 ## Returns

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

@@ -3,10 +3,9 @@ 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)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L56)
 
 Options for configuring the `AuthModule`.
 
@@ -18,13 +17,13 @@ Options for configuring the `AuthModule`.
 optional additionalConfigEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:99](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L99)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L96)
 
 Optional additional configuration entries to register (e.g. provider-specific OAuth keys).
 Import them from the provider-specific sub-paths
 (e.g. `APPLE_AUTH_CONFIG_ENTRIES` from `@breadstone/archipel-platform-authentication/connectors/apple`).
 
----
+***
 
 ### additionalProviders?
 
@@ -32,13 +31,13 @@ Import them from the provider-specific sub-paths
 optional additionalProviders?: Provider[];
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:121](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L121)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:118](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L118)
 
 Optional additional providers required by optional features (e.g. TOTP MFA).
 Import them from the provider-specific sub-paths
 (e.g. `TOTP_MFA_PROVIDERS` from `@breadstone/archipel-platform-authentication/mfa/totp`).
 
----
+***
 
 ### authSubject
 
@@ -46,11 +45,11 @@ Import them from the provider-specific sub-paths
 authSubject: Type<AuthSubjectPort>;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L63)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L60)
 
 Implementation of the auth subject port (user lookup for JWT/Local/Anonymous connectors).
 
----
+***
 
 ### mfaChannels?
 
@@ -58,7 +57,7 @@ Implementation of the auth subject port (user lookup for JWT/Local/Anonymous con
 optional mfaChannels?: Type<any>[];
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:114](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L114)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:111](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L111)
 
 Optional array of additional MFA channel types to register (e.g. `TotpMfaChannel`).
 Import them from the provider-specific sub-paths
@@ -66,7 +65,7 @@ Import them from the provider-specific sub-paths
 
 Built-in channels (SMS, Email, Push) are always registered.
 
----
+***
 
 ### mfaSubject
 
@@ -74,11 +73,11 @@ Built-in channels (SMS, Email, Push) are always registered.
 mfaSubject: Type<MfaSubjectPort>;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L68)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L65)
 
 Implementation of the MFA subject port (MFA state persistence).
 
----
+***
 
 ### sessionPersistence
 
@@ -86,11 +85,11 @@ Implementation of the MFA subject port (MFA state persistence).
 sessionPersistence: Type<SessionPersistencePort>;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L73)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L70)
 
 Implementation of the session persistence port.
 
----
+***
 
 ### socialAuth?
 
@@ -98,12 +97,12 @@ Implementation of the session persistence port.
 optional socialAuth?: Type<SocialAuthPort>;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L84)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L81)
 
 Optional implementation of the social auth port (OAuth connectors).
 When provided together with `socialConnectors`, the social auth flow is enabled.
 
----
+***
 
 ### socialConnectors?
 
@@ -111,14 +110,14 @@ When provided together with `socialConnectors`, the social auth flow is enabled.
 optional socialConnectors?: Type<any>[];
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:92](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L92)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:89](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L89)
 
 Optional array of social connector types to register (e.g. `AppleConnector`, `GithubConnector`).
 Import them from the provider-specific sub-paths
 (e.g. `@breadstone/archipel-platform-authentication/connectors/apple`).
 Requires `socialAuth` to be set.
 
----
+***
 
 ### tokenEnricher?
 
@@ -126,12 +125,12 @@ Requires `socialAuth` to be set.
 optional tokenEnricher?: Type<TokenEnricherPort>;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L105)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:102](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L102)
 
 Optional implementation of the token enricher port.
 When provided, additional claims are added to JWT tokens.
 
----
+***
 
 ### verificationSubject
 
@@ -139,6 +138,6 @@ When provided, additional claims are added to JWT tokens.
 verificationSubject: Type<VerificationSubjectPort>;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L78)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L75)
 
 Implementation of the verification subject port (email/pin verification).

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

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

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

@@ -3,7 +3,6 @@ title: 'Interface: IMfaChallengePayload'
 generated: true
 editUrl: false
 ---
-
 # Interface: IMfaChallengePayload
 
 Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaChallengePayload.ts#L6)
@@ -22,7 +21,7 @@ Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:38]
 
 Optional client name associated with the login attempt.
 
----
+***
 
 ### ipAddress
 
@@ -34,7 +33,7 @@ Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:23]
 
 Captures the originating IP address for the challenge.
 
----
+***
 
 ### location?
 
@@ -46,7 +45,7 @@ Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:33]
 
 Optional location associated with the login attempt.
 
----
+***
 
 ### type
 
@@ -58,7 +57,7 @@ Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:13]
 
 Defines the token discriminator used to validate challenge tokens.
 
----
+***
 
 ### userAgent?
 
@@ -70,7 +69,7 @@ Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:28]
 
 Captures the originating user agent for the challenge.
 
----
+***
 
 ### userId