@breadstone/archipel-mcp 0.0.14 → 0.0.16

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

@@ -0,0 +1,144 @@
+---
+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)
+
+## Implements
+
+- `IMfaChannel`
+
+## Constructors
+
+### Constructor
+
+```ts
+new TotpMfaChannel(
+   mfaSubject, 
+   configService, 
+   encryptionService, 
+   otpService): TotpMfaChannel;
+```
+
+Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts#L31)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `mfaSubject` | [`MfaSubjectPort`](Class.MfaSubjectPort) |
+| `configService` | `ConfigService` |
+| `encryptionService` | `MfaEncryptionService` |
+| `otpService` | `IOtpService` |
+
+#### Returns
+
+`TotpMfaChannel`
+
+## Properties
+
+### method
+
+```ts
+readonly method: "totp" = 'totp';
+```
+
+Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts#L19)
+
+Unique identifier of the MFA method (e.g., `totp`, `sms`, `email`).
+
+#### Implementation of
+
+```ts
+IMfaChannel.method
+```
+
+## Methods
+
+### initSetup()
+
+```ts
+initSetup(userId, _context?): Promise<IMfaSetup>;
+```
+
+Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts#L48)
+
+Initializes the setup flow for the channel and persists any channel-specific bootstrap state.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `userId` | `string` | Identifier of the user starting setup. |
+| `_context?` | `IMfaSetupContext` | - |
+
+#### Returns
+
+`Promise`\<[`IMfaSetup`](Interface.IMfaSetup)\>
+
+#### Implementation of
+
+```ts
+IMfaChannel.initSetup
+```
+
+***
+
+### verifyChallenge()
+
+```ts
+verifyChallenge(userId, code): Promise<boolean>;
+```
+
+Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts#L107)
+
+Verifies a challenge code during login.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `userId` | `string` | Identifier of the challenged user. |
+| `code` | `string` | User supplied challenge code. |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+#### Implementation of
+
+```ts
+IMfaChannel.verifyChallenge
+```
+
+***
+
+### verifySetup()
+
+```ts
+verifySetup(userId, code): Promise<boolean>;
+```
+
+Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts#L82)
+
+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. |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+#### Implementation of
+
+```ts
+IMfaChannel.verifySetup
+```

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

@@ -0,0 +1,154 @@
+---
+title: 'Class: VerificationService'
+generated: true
+editUrl: false
+---
+# Class: VerificationService
+
+Defined in: [libs/platform-authentication/src/services/VerificationService.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L20)
+
+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:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L41)
+
+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:156](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L156)
+
+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:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L64)
+
+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:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L77)
+
+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:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L112)
+
+#### 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:87](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L87)
+
+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,116 @@
+---
+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)
+
+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/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(routeParam): SocialAuthGuard;
+```
+
+Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L43)
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `routeParam` | `string` |
+
+## Returns
+
+[`SocialAuthGuard`](Class.SocialAuthGuard)

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

@@ -0,0 +1,157 @@
+---
+title: 'Interface: IAuthModuleOptions'
+generated: true
+editUrl: false
+---
+# Interface: IAuthModuleOptions
+
+Defined in: [libs/platform-authentication/src/AuthModule.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L57)
+
+Options for configuring the `AuthModule`.
+
+## Properties
+
+### additionalConfigEntries?
+
+```ts
+optional additionalConfigEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
+```
+
+Defined in: [libs/platform-authentication/src/AuthModule.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L97)
+
+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?
+
+```ts
+optional additionalProviders?: Provider[];
+```
+
+Defined in: [libs/platform-authentication/src/AuthModule.ts:119](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L119)
+
+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
+
+```ts
+authSubject: Type<AuthSubjectPort>;
+```
+
+Defined in: [libs/platform-authentication/src/AuthModule.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L61)
+
+Implementation of the auth subject port (user lookup for JWT/Local/Anonymous connectors).
+
+***
+
+### challengeStore?
+
+```ts
+optional challengeStore?: Type<ChallengeStorePort>;
+```
+
+Defined in: [libs/platform-authentication/src/AuthModule.ts:126](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L126)
+
+Optional implementation of the challenge store port.
+Defaults to an in-memory store suitable for single-instance deployments.
+For multi-instance deployments, provide a Redis-backed implementation.
+
+***
+
+### mfaChannels?
+
+```ts
+optional mfaChannels?: Type<any>[];
+```
+
+Defined in: [libs/platform-authentication/src/AuthModule.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L112)
+
+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
+
+```ts
+mfaSubject: Type<MfaSubjectPort>;
+```
+
+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 MFA subject port (MFA state persistence).
+
+***
+
+### sessionPersistence
+
+```ts
+sessionPersistence: Type<SessionPersistencePort>;
+```
+
+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 session persistence port.
+
+***
+
+### socialAuth?
+
+```ts
+optional socialAuth?: Type<SocialAuthPort>;
+```
+
+Defined in: [libs/platform-authentication/src/AuthModule.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L82)
+
+Optional implementation of the social auth port (OAuth connectors).
+When provided together with `socialConnectors`, the social auth flow is enabled.
+
+***
+
+### socialConnectors?
+
+```ts
+optional socialConnectors?: Type<any>[];
+```
+
+Defined in: [libs/platform-authentication/src/AuthModule.ts:90](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L90)
+
+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?
+
+```ts
+optional tokenEnricher?: Type<TokenEnricherPort>;
+```
+
+Defined in: [libs/platform-authentication/src/AuthModule.ts:103](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L103)
+
+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:76](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L76)
+
+Implementation of the verification subject port (email/pin verification).