@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,159 @@
+---
+title: 'Class: VerificationService'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Class: VerificationService
+
+Defined in: [libs/platform-authentication/src/services/VerificationService.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L17)
+
+Manages email / PIN verification tokens via the [VerificationSubjectPort](Class.VerificationSubjectPort).
+
+## Constructors
+
+### Constructor
+
+```ts
+new VerificationService(
+   jwtService,
+   hostService,
+   verificationSubject,
+   configService): VerificationService;
+```
+
+Defined in: [libs/platform-authentication/src/services/VerificationService.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L38)
+
+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. |
+
+#### Returns
+
+`VerificationService`
+
+## Methods
+
+### buildVerificationLink()
+
+```ts
+buildVerificationLink(token): string;
+```
+
+Defined in: [libs/platform-authentication/src/services/VerificationService.ts:148](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L148)
+
+Constructs the verification link.
+
+#### Parameters
+
+| Parameter | Type     | Description             |
+| --------- | -------- | ----------------------- |
+| `token`   | `string` | The verification token. |
+
+#### Returns
+
+`string`
+
+The URL to verify the email.
+
+---
+
+### exhibitToken()
+
+```ts
+exhibitToken(data): Promise<string>;
+```
+
+Defined in: [libs/platform-authentication/src/services/VerificationService.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L61)
+
+Exhibits a new verification token.
+
+#### Parameters
+
+| Parameter | Type                           | Description          |
+| --------- | ------------------------------ | -------------------- |
+| `data`    | `Record`\<`string`, `string`\> | The data to exhibit. |
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The verification token.
+
+---
+
+### redeemToken()
+
+```ts
+redeemToken(token): Promise<Record<string, string>>;
+```
+
+Defined in: [libs/platform-authentication/src/services/VerificationService.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L74)
+
+Redeems the user's token.
+
+#### Parameters
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `token`   | `string` | The token to redeem. |
+
+#### Returns
+
+`Promise`\<`Record`\<`string`, `string`\>\>
+
+The token data.
+
+---
+
+### verifyPin()
+
+```ts
+verifyPin(pin, login): Promise<boolean>;
+```
+
+Defined in: [libs/platform-authentication/src/services/VerificationService.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L105)
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `pin`     | `string` |
+| `login`   | `string` |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+---
+
+### verifyToken()
+
+```ts
+verifyToken(token): Promise<boolean>;
+```
+
+Defined in: [libs/platform-authentication/src/services/VerificationService.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L84)
+
+Verifies the user's token.
+
+#### Parameters
+
+| Parameter | Type     | Description             |
+| --------- | -------- | ----------------------- |
+| `token`   | `string` | The verification token. |
+
+#### Returns
+
+`Promise`\<`boolean`\>

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

@@ -0,0 +1,121 @@
+---
+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)
+
+Abstract port for verifiable subject persistence.
+Used by the VerificationService to manage email/PIN verification.
+
+## Constructors
+
+### Constructor
+
+```ts
+new VerificationSubjectPort(): VerificationSubjectPort;
+```
+
+#### Returns
+
+`VerificationSubjectPort`
+
+## Methods
+
+### findByLogin()
+
+```ts
+abstract findByLogin(login): Promise<IVerifiableSubject | null>;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/VerificationSubjectPort.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/VerificationSubjectPort.ts#L23)
+
+Find a subject by login (user name or email).
+
+#### Parameters
+
+| Parameter | Type     | Description           |
+| --------- | -------- | --------------------- |
+| `login`   | `string` | The login identifier. |
+
+#### Returns
+
+`Promise`\<[`IVerifiableSubject`](Interface.IVerifiableSubject) \| `null`\>
+
+The verifiable subject or `null`.
+
+---
+
+### findByVerificationToken()
+
+```ts
+abstract findByVerificationToken(token): Promise<IVerifiableSubject | null>;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/VerificationSubjectPort.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/VerificationSubjectPort.ts#L32)
+
+Find a subject by its current verification token.
+
+#### Parameters
+
+| Parameter | Type     | Description                    |
+| --------- | -------- | ------------------------------ |
+| `token`   | `string` | The verification token string. |
+
+#### Returns
+
+`Promise`\<[`IVerifiableSubject`](Interface.IVerifiableSubject) \| `null`\>
+
+The subject or `null`.
+
+---
+
+### markVerified()
+
+```ts
+abstract markVerified(id): Promise<void>;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/VerificationSubjectPort.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/VerificationSubjectPort.ts#L49)
+
+Mark the subject as verified and clear the token.
+
+#### Parameters
+
+| Parameter | Type     | Description             |
+| --------- | -------- | ----------------------- |
+| `id`      | `string` | The subject identifier. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+---
+
+### setVerificationToken()
+
+```ts
+abstract setVerificationToken(id, token): Promise<void>;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/VerificationSubjectPort.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/VerificationSubjectPort.ts#L41)
+
+Store a verification token on the subject.
+
+#### Parameters
+
+| Parameter | Type               | Description                      |
+| --------- | ------------------ | -------------------------------- |
+| `id`      | `string`           | The subject identifier.          |
+| `token`   | `string` \| `null` | The verification token to store. |
+
+#### Returns
+
+`Promise`\<`void`\>

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

@@ -0,0 +1,89 @@
+---
+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)
+
+Options for configuring the `AuthModule`.
+
+## Properties
+
+### 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)
+
+Implementation of the auth subject port (user lookup for JWT/Local/Anonymous strategies).
+
+---
+
+### mfaSubject
+
+```ts
+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)
+
+Implementation of the MFA subject port (MFA state persistence).
+
+---
+
+### sessionPersistence
+
+```ts
+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)
+
+Implementation of the session persistence port.
+
+---
+
+### socialAuth?
+
+```ts
+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)
+
+Optional implementation of the social auth port (OAuth strategies).
+When provided, social strategies (GitHub, Google, Microsoft, Apple) are registered.
+
+---
+
+### tokenEnricher?
+
+```ts
+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)
+
+Optional implementation of the token enricher port.
+When provided, additional claims are added to JWT tokens.
+
+---
+
+### verificationSubject
+
+```ts
+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)
+
+Implementation of the verification subject port (email/pin verification).

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

@@ -0,0 +1,112 @@
+---
+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)
+
+Generic authentication subject returned by the [AuthSubjectPort](Class.AuthSubjectPort).
+Represents any entity that can authenticate (user, service account, etc.).
+
+## Properties
+
+### email
+
+```ts
+readonly email: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L23)
+
+Email address.
+
+---
+
+### id
+
+```ts
+readonly id: string;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L13)
+
+Unique identifier.
+
+---
+
+### isAnonymous
+
+```ts
+readonly isAnonymous: boolean;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L38)
+
+Whether the account is anonymous.
+
+---
+
+### isVerified
+
+```ts
+readonly isVerified: boolean;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L33)
+
+Whether the account has been verified (e.g. email confirmation).
+
+---
+
+### mfaEnabled
+
+```ts
+readonly mfaEnabled: boolean;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L48)
+
+Whether MFA is enabled for this subject.
+
+---
+
+### password
+
+```ts
+readonly password: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L28)
+
+Hashed password. `null` for social-only accounts.
+
+---
+
+### roles
+
+```ts
+readonly roles: readonly string[];
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L43)
+
+Assigned role strings (e.g. `['user', 'admin']`).
+
+---
+
+### userName
+
+```ts
+readonly userName: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L18)
+
+Login name (user name, email alias, etc.).

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

@@ -0,0 +1,87 @@
+---
+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)
+
+Represents the MFA challenge payload encoded in a challenge token.
+
+## Properties
+
+### clientName?
+
+```ts
+readonly optional clientName?: string;
+```
+
+Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaChallengePayload.ts#L38)
+
+Optional client name associated with the login attempt.
+
+---
+
+### ipAddress
+
+```ts
+readonly ipAddress: string;
+```
+
+Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaChallengePayload.ts#L23)
+
+Captures the originating IP address for the challenge.
+
+---
+
+### location?
+
+```ts
+readonly optional location?: string;
+```
+
+Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaChallengePayload.ts#L33)
+
+Optional location associated with the login attempt.
+
+---
+
+### type
+
+```ts
+readonly type: "mfa";
+```
+
+Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaChallengePayload.ts#L13)
+
+Defines the token discriminator used to validate challenge tokens.
+
+---
+
+### userAgent?
+
+```ts
+readonly optional userAgent?: string;
+```
+
+Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaChallengePayload.ts#L28)
+
+Captures the originating user agent for the challenge.
+
+---
+
+### userId
+
+```ts
+readonly userId: string;
+```
+
+Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaChallengePayload.ts#L18)
+
+Identifies the authenticated user.

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

@@ -0,0 +1,123 @@
+---
+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)
+
+## Properties
+
+### allowedMethods
+
+```ts
+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
+
+```ts
+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?
+
+```ts
+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
+
+```ts
+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
+
+```ts
+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
+
+```ts
+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?
+
+```ts
+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?
+
+```ts
+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?
+
+```ts
+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?
+
+```ts
+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
+
+```ts
+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)