@breadstone/archipel-mcp 0.0.1 → 0.0.2

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

@@ -3,11 +3,6 @@ title: 'Abstract Class: VerificationSubjectPort'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # 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)
@@ -41,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
 
@@ -51,7 +46,7 @@ Find a subject by login (user name or email).
 
 The verifiable subject or `null`.
 
----
+***
 
 ### findByVerificationToken()
 
@@ -65,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
 
@@ -75,7 +70,7 @@ Find a subject by its current verification token.
 
 The subject or `null`.
 
----
+***
 
 ### markVerified()
 
@@ -89,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()
 
@@ -111,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

@@ -0,0 +1,18 @@
+---
+title: 'Function: Token()'
+generated: true
+editUrl: false
+---
+# Function: Token()
+
+```ts
+function Token(): Function;
+```
+
+Defined in: [libs/platform-authentication/src/decorators/TokenDecorator.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/decorators/TokenDecorator.ts#L14)
+
+Represents the `Token` decorator.
+
+## Returns
+
+`Function`

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

@@ -0,0 +1,24 @@
+---
+title: 'Function: UseRoles()'
+generated: true
+editUrl: false
+---
+# Function: UseRoles()
+
+```ts
+function UseRoles(...roles): Function;
+```
+
+Defined in: [libs/platform-authentication/src/decorators/RolesDecorator.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/decorators/RolesDecorator.ts#L20)
+
+Represents the `UseRoles` decorator.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`roles` | `string`[] |
+
+## Returns
+
+`Function`

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

@@ -0,0 +1,22 @@
+---
+title: 'Function: socialAuthGuardFactory()'
+generated: true
+editUrl: false
+---
+# Function: socialAuthGuardFactory()
+
+```ts
+function socialAuthGuardFactory(provider): SocialAuthGuard;
+```
+
+Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L42)
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `provider` | `string` |
+
+## Returns
+
+[`SocialAuthGuard`](Class.SocialAuthGuard)

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

@@ -3,30 +3,39 @@ title: 'Interface: IAuthModuleOptions'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # Interface: IAuthModuleOptions
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L62)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L59)
 
 Options for configuring the `AuthModule`.
 
 ## Properties
 
+### additionalConfigEntries?
+
+```ts
+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)
+
+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`).
+
+***
+
 ### authSubject
 
 ```ts
 authSubject: Type<AuthSubjectPort>;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L66)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L63)
 
 Implementation of the auth subject port (user lookup for JWT/Local/Anonymous strategies).
 
----
+***
 
 ### mfaSubject
 
@@ -34,11 +43,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:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L71)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L68)
 
 Implementation of the MFA subject port (MFA state persistence).
 
----
+***
 
 ### sessionPersistence
 
@@ -46,11 +55,11 @@ Implementation of the MFA subject port (MFA state persistence).
 sessionPersistence: Type<SessionPersistencePort>;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:76](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L76)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L73)
 
 Implementation of the session persistence port.
 
----
+***
 
 ### socialAuth?
 
@@ -58,12 +67,27 @@ Implementation of the session persistence port.
 optional socialAuth?: Type<SocialAuthPort>;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:87](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L87)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L84)
 
 Optional implementation of the social auth port (OAuth strategies).
-When provided, social strategies (GitHub, Google, Microsoft, Apple) are registered.
+When provided together with `socialStrategies`, the social auth flow is enabled.
 
----
+***
+
+### socialStrategies?
+
+```ts
+optional socialStrategies?: 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)
+
+Optional array of social strategy types to register (e.g. `AppleStrategy`, `GithubStrategy`).
+Import them from the provider-specific sub-paths
+(e.g. `@breadstone/archipel-platform-authentication/apple`).
+Requires `socialAuth` to be set.
+
+***
 
 ### tokenEnricher?
 
@@ -71,12 +95,12 @@ When provided, social strategies (GitHub, Google, Microsoft, Apple) are register
 optional tokenEnricher?: Type<TokenEnricherPort>;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:93](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L93)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L105)
 
 Optional implementation of the token enricher port.
 When provided, additional claims are added to JWT tokens.
 
----
+***
 
 ### verificationSubject
 
@@ -84,6 +108,6 @@ When provided, additional claims are added to JWT tokens.
 verificationSubject: Type<VerificationSubjectPort>;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L81)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L78)
 
 Implementation of the verification subject port (email/pin verification).

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

@@ -3,11 +3,6 @@ title: 'Interface: IAuthSubject'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # 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)
@@ -27,7 +22,7 @@ Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:23](http
 
 Email address.
 
----
+***
 
 ### id
 
@@ -39,7 +34,7 @@ Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:13](http
 
 Unique identifier.
 
----
+***
 
 ### isAnonymous
 
@@ -51,7 +46,7 @@ Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:38](http
 
 Whether the account is anonymous.
 
----
+***
 
 ### isVerified
 
@@ -63,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
 
@@ -75,7 +70,7 @@ Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:48](http
 
 Whether MFA is enabled for this subject.
 
----
+***
 
 ### password
 
@@ -87,7 +82,7 @@ Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:28](http
 
 Hashed password. `null` for social-only accounts.
 
----
+***
 
 ### roles
 
@@ -99,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,11 +3,6 @@ title: 'Interface: IMfaChallengePayload'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # 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)
@@ -26,7 +21,7 @@ Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:38]
 
 Optional client name associated with the login attempt.
 
----
+***
 
 ### ipAddress
 
@@ -38,7 +33,7 @@ Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:23]
 
 Captures the originating IP address for the challenge.
 
----
+***
 
 ### location?
 
@@ -50,7 +45,7 @@ Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:33]
 
 Optional location associated with the login attempt.
 
----
+***
 
 ### type
 
@@ -62,7 +57,7 @@ Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:13]
 
 Defines the token discriminator used to validate challenge tokens.
 
----
+***
 
 ### userAgent?
 
@@ -74,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,11 +3,6 @@ title: 'Interface: IMfaChallengeState'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # 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)
@@ -22,7 +17,7 @@ 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)
 
----
+***
 
 ### attempts
 
@@ -32,7 +27,7 @@ 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)
 
----
+***
 
 ### clientName?
 
@@ -42,7 +37,7 @@ 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)
 
----
+***
 
 ### createdAt
 
@@ -52,7 +47,7 @@ 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)
 
----
+***
 
 ### expiresAt
 
@@ -62,7 +57,7 @@ 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)
 
----
+***
 
 ### id
 
@@ -72,7 +67,7 @@ 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)
 
----
+***
 
 ### ipAddress?
 
@@ -82,7 +77,7 @@ 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)
 
----
+***
 
 ### location?
 
@@ -92,7 +87,7 @@ 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)
 
----
+***
 
 ### preferredMethod?
 
@@ -102,7 +97,7 @@ 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)
 
----
+***
 
 ### userAgent?
 
@@ -112,7 +107,7 @@ 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)
 
----
+***
 
 ### userId
 

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

@@ -3,11 +3,6 @@ title: 'Interface: IMfaConfirmation'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # 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,11 +3,6 @@ title: 'Interface: IMfaSetup'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # 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)
@@ -26,7 +21,7 @@ Defined in: [libs/platform-authentication/src/models/IMfaSetup.ts:18](https://gi
 
 Identifies the MFA method being provisioned.
 
----
+***
 
 ### otpauthUrl?
 
@@ -38,7 +33,7 @@ Defined in: [libs/platform-authentication/src/models/IMfaSetup.ts:23](https://gi
 
 Contains the provisioning URI compatible with authenticator applications.
 
----
+***
 
 ### quickResponseCodeDataUrl?
 
@@ -50,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?
 

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

@@ -3,11 +3,6 @@ title: 'Interface: IMfaSubject'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # Interface: IMfaSubject
 
 Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubject.ts#L7)
@@ -27,7 +22,7 @@ Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:18](https
 
 Email address, used by the email OTP channel.
 
----
+***
 
 ### id
 
@@ -39,7 +34,7 @@ Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:13](https
 
 Unique identifier.
 
----
+***
 
 ### mfaBackupCodes
 
@@ -51,7 +46,7 @@ Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:38](https
 
 Hashed backup codes.
 
----
+***
 
 ### mfaChannels
 
@@ -63,7 +58,7 @@ Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:53](https
 
 Serialized per-channel MFA state (JSON object).
 
----
+***
 
 ### mfaEnabled
 
@@ -75,7 +70,7 @@ Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:28](https
 
 Whether MFA is currently enabled.
 
----
+***
 
 ### mfaPreferredMethod
 
@@ -87,7 +82,7 @@ Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:43](https
 
 Preferred MFA method.
 
----
+***
 
 ### mfaSecret
 
@@ -99,7 +94,7 @@ Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:33](https
 
 Legacy TOTP secret (plain text). Used for migration to channel-based state.
 
----
+***
 
 ### mfaVerifiedAt
 
@@ -111,7 +106,7 @@ Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:48](https
 
 Last time MFA was verified.
 
----
+***
 
 ### phoneNumber
 
@@ -123,7 +118,7 @@ Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:58](https
 
 Phone number, used by the SMS channel.
 
----
+***
 
 ### userName