@breadstone/archipel-mcp 0.0.11 → 0.0.14

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

@@ -1,144 +0,0 @@
----
-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

@@ -1,154 +0,0 @@
----
-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)
-
-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:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L39)
-
-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:149](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L149)
-
-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:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L62)
-
-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:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L75)
-
-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:106](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L106)
-
-#### 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:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L85)
-
-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

@@ -1,116 +0,0 @@
----
-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

@@ -1,18 +0,0 @@
----
-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

@@ -1,24 +0,0 @@
----
-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

@@ -1,22 +0,0 @@
----
-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

@@ -1,143 +0,0 @@
----
-title: 'Interface: IAuthModuleOptions'
-generated: true
-editUrl: false
----
-# Interface: IAuthModuleOptions
-
-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`.
-
-## Properties
-
-### additionalConfigEntries?
-
-```ts
-optional additionalConfigEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
-```
-
-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?
-
-```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
-
-```ts
-authSubject: Type<AuthSubjectPort>;
-```
-
-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?
-
-```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
-
-```ts
-mfaSubject: Type<MfaSubjectPort>;
-```
-
-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
-
-```ts
-sessionPersistence: Type<SessionPersistencePort>;
-```
-
-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?
-
-```ts
-optional socialAuth?: Type<SocialAuthPort>;
-```
-
-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?
-
-```ts
-optional socialConnectors?: Type<any>[];
-```
-
-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?
-
-```ts
-optional tokenEnricher?: Type<TokenEnricherPort>;
-```
-
-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
-
-```ts
-verificationSubject: Type<VerificationSubjectPort>;
-```
-
-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).