@breadstone/archipel-mcp 0.0.8 → 0.0.10

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:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L45)
+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,27 @@ Options for configuring the `AuthModule`.
 optional additionalConfigEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L85)
+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/apple`).
+(e.g. `APPLE_AUTH_CONFIG_ENTRIES` from `@breadstone/archipel-platform-authentication/connectors/apple`).
 
----
+***
+
+### additionalProviders?
+
+```ts
+optional additionalProviders?: Provider[];
+```
+
+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
 
@@ -32,11 +45,27 @@ Import them from the provider-specific sub-paths
 authSubject: Type<AuthSubjectPort>;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L49)
+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 strategies).
+Implementation of the auth subject port (user lookup for JWT/Local/Anonymous connectors).
 
----
+***
+
+### mfaChannels?
+
+```ts
+optional mfaChannels?: Type<any>[];
+```
+
+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
+(e.g. `@breadstone/archipel-platform-authentication/mfa/totp`).
+
+Built-in channels (SMS, Email, Push) are always registered.
+
+***
 
 ### mfaSubject
 
@@ -44,11 +73,11 @@ Implementation of the auth subject port (user lookup for JWT/Local/Anonymous str
 mfaSubject: Type<MfaSubjectPort>;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L54)
+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
 
@@ -56,11 +85,11 @@ Implementation of the MFA subject port (MFA state persistence).
 sessionPersistence: Type<SessionPersistencePort>;
 ```
 
-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:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L70)
 
 Implementation of the session persistence port.
 
----
+***
 
 ### socialAuth?
 
@@ -68,27 +97,27 @@ Implementation of the session persistence port.
 optional socialAuth?: Type<SocialAuthPort>;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L70)
+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 strategies).
-When provided together with `socialStrategies`, the social auth flow is enabled.
+Optional implementation of the social auth port (OAuth connectors).
+When provided together with `socialConnectors`, the social auth flow is enabled.
 
----
+***
 
-### socialStrategies?
+### socialConnectors?
 
 ```ts
-optional socialStrategies?: Type<any>[];
+optional socialConnectors?: Type<any>[];
 ```
 
-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:89](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L89)
 
-Optional array of social strategy types to register (e.g. `AppleStrategy`, `GithubStrategy`).
+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/apple`).
+(e.g. `@breadstone/archipel-platform-authentication/connectors/apple`).
 Requires `socialAuth` to be set.
 
----
+***
 
 ### tokenEnricher?
 
@@ -96,12 +125,12 @@ Requires `socialAuth` to be set.
 optional tokenEnricher?: Type<TokenEnricherPort>;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L91)
+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
 
@@ -109,6 +138,6 @@ When provided, additional claims are added to JWT tokens.
 verificationSubject: Type<VerificationSubjectPort>;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L64)
+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
 

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

@@ -3,10 +3,9 @@ title: 'Interface: IMfaChallengeState'
 generated: true
 editUrl: false
 ---
-
 # Interface: IMfaChallengeState
 
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L9)
+Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L10)
 
 ## Properties
 
@@ -16,9 +15,9 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:9](ht
 allowedMethods: string[];
 ```
 
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L12)
+Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L13)
 
----
+***
 
 ### attempts
 
@@ -26,9 +25,9 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:12](h
 attempts: number;
 ```
 
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L20)
+Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L21)
 
----
+***
 
 ### clientName?
 
@@ -36,9 +35,9 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:20](h
 optional clientName?: string;
 ```
 
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L17)
+Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L18)
 
----
+***
 
 ### createdAt
 
@@ -46,9 +45,9 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:17](h
 createdAt: Date;
 ```
 
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L18)
+Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L19)
 
----
+***
 
 ### expiresAt
 
@@ -56,9 +55,9 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:18](h
 expiresAt: Date;
 ```
 
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L19)
+Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L20)
 
----
+***
 
 ### id
 
@@ -66,9 +65,9 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:19](h
 id: string;
 ```
 
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L10)
+Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L11)
 
----
+***
 
 ### ipAddress?
 
@@ -76,9 +75,9 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:10](h
 optional ipAddress?: string;
 ```
 
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L14)
+Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L15)
 
----
+***
 
 ### location?
 
@@ -86,9 +85,9 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:14](h
 optional location?: string;
 ```
 
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L16)
+Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L17)
 
----
+***
 
 ### preferredMethod?
 
@@ -96,9 +95,9 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:16](h
 optional preferredMethod?: string;
 ```
 
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L13)
+Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L14)
 
----
+***
 
 ### userAgent?
 
@@ -106,9 +105,9 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:13](h
 optional userAgent?: string;
 ```
 
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L15)
+Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L16)
 
----
+***
 
 ### userId
 
@@ -116,4 +115,4 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:15](h
 userId: string;
 ```
 
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L11)
+Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L12)

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

@@ -3,7 +3,6 @@ title: 'Interface: IMfaConfirmation'
 generated: true
 editUrl: false
 ---
-
 # Interface: IMfaConfirmation
 
 Defined in: [libs/platform-authentication/src/models/IMfaConfirmation.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaConfirmation.ts#L6)

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

@@ -3,7 +3,6 @@ title: 'Interface: IMfaSetup'
 generated: true
 editUrl: false
 ---
-
 # Interface: IMfaSetup
 
 Defined in: [libs/platform-authentication/src/models/IMfaSetup.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaSetup.ts#L6)
@@ -22,7 +21,7 @@ Defined in: [libs/platform-authentication/src/models/IMfaSetup.ts:18](https://gi
 
 Identifies the MFA method being provisioned.
 
----
+***
 
 ### otpauthUrl?
 
@@ -34,7 +33,7 @@ Defined in: [libs/platform-authentication/src/models/IMfaSetup.ts:23](https://gi
 
 Contains the provisioning URI compatible with authenticator applications.
 
----
+***
 
 ### quickResponseCodeDataUrl?
 
@@ -46,7 +45,7 @@ Defined in: [libs/platform-authentication/src/models/IMfaSetup.ts:28](https://gi
 
 Provides a pre-rendered QR code in data URL form.
 
----
+***
 
 ### secret?