@breadstone/archipel-mcp 0.0.20 → 0.0.22

package/data/packages/platform-mailing/api/Variable.SMTP_HOST.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: SMTP\_HOST'
+generated: true
+editUrl: false
+---
+# Variable: SMTP\_HOST
+
+```ts
+const SMTP_HOST: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/smtp/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/smtp/env.ts#L12)
+
+SMTP server host.

package/data/packages/platform-mailing/api/Variable.SMTP_PASSWORD.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: SMTP\_PASSWORD'
+generated: true
+editUrl: false
+---
+# Variable: SMTP\_PASSWORD
+
+```ts
+const SMTP_PASSWORD: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/smtp/env.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/smtp/env.ts#L24)
+
+SMTP authentication password.

package/data/packages/platform-mailing/api/Variable.SMTP_PORT.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: SMTP\_PORT'
+generated: true
+editUrl: false
+---
+# Variable: SMTP\_PORT
+
+```ts
+const SMTP_PORT: IConfigKey<number>;
+```
+
+Defined in: [platform-mailing/src/smtp/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/smtp/env.ts#L15)
+
+SMTP server port.

package/data/packages/platform-mailing/api/Variable.SMTP_SECURE.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: SMTP\_SECURE'
+generated: true
+editUrl: false
+---
+# Variable: SMTP\_SECURE
+
+```ts
+const SMTP_SECURE: IConfigKey<boolean>;
+```
+
+Defined in: [platform-mailing/src/smtp/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/smtp/env.ts#L18)
+
+Whether the SMTP connection uses TLS.

package/data/packages/platform-mailing/api/Variable.SMTP_USER.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: SMTP\_USER'
+generated: true
+editUrl: false
+---
+# Variable: SMTP\_USER
+
+```ts
+const SMTP_USER: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/smtp/env.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/smtp/env.ts#L21)
+
+SMTP authentication username.

package/data/packages/platform-mailing/api/index.md

@@ -9,10 +9,8 @@ editUrl: false
 
 | Class | Description |
 | ------ | ------ |
-| [BlobTemplateFetchStrategy](Class.BlobTemplateFetchStrategy) | The `BlobTemplateFetchStrategy` class. |
 | [DeliveryStrategyBase](Class.DeliveryStrategyBase) | Represents the base class for all email delivery strategies. |
-| [FileTemplateFetchStrategy](Class.FileTemplateFetchStrategy) | The `FileTemplateFetchStrategy` class. |
-| [LogDeliveryStrategy](Class.LogDeliveryStrategy) | The `LogDeliveryStrategy` class. |
+| [MailDeliveryError](Class.MailDeliveryError) | Domain error thrown when email delivery fails. |
 | [MailgunDeliveryStrategy](Class.MailgunDeliveryStrategy) | Delivers emails via the Mailgun API. |
 | [MailHealthIndicator](Class.MailHealthIndicator) | Health indicator for mail service. |
 | [MailModule](Class.MailModule) | Represents the mail module. |
@@ -75,3 +73,9 @@ editUrl: false
 | [SEND\_MAIL\_EVENT\_KEY](Variable.SEND_MAIL_EVENT_KEY) | Event key registry for the mail domain events. |
 | [SENDGRID\_API\_KEY](Variable.SENDGRID_API_KEY) | API key for the SendGrid delivery service. |
 | [SENDGRID\_CONFIG\_ENTRIES](Variable.SENDGRID_CONFIG_ENTRIES) | Configuration entries required by the SendGrid delivery provider. |
+| [SMTP\_CONFIG\_ENTRIES](Variable.SMTP_CONFIG_ENTRIES) | Configuration entries required by the SMTP delivery provider. |
+| [SMTP\_HOST](Variable.SMTP_HOST) | SMTP server host. |
+| [SMTP\_PASSWORD](Variable.SMTP_PASSWORD) | SMTP authentication password. |
+| [SMTP\_PORT](Variable.SMTP_PORT) | SMTP server port. |
+| [SMTP\_SECURE](Variable.SMTP_SECURE) | Whether the SMTP connection uses TLS. |
+| [SMTP\_USER](Variable.SMTP_USER) | SMTP authentication username. |

package/data/packages/platform-mailing/index.md

@@ -353,6 +353,34 @@ export class OrderEmailService {
 
 ---
 
+## Error Handling
+
+All delivery strategies throw a `MailDeliveryError` when email sending fails. This domain error class wraps the underlying provider SDK error and exposes structured metadata for error handling and observability.
+
+```typescript
+import { MailDeliveryError } from '@breadstone/archipel-platform-mailing';
+
+try {
+  await this._mail.send(options, content, true);
+} catch (error) {
+  if (error instanceof MailDeliveryError) {
+    logger.error('Mail delivery failed', {
+      provider: error.provider,  // 'postmark', 'resend', 'sendgrid', etc.
+      code: error.code,          // 'MAIL_DELIVERY'
+      cause: error.cause,        // Original provider SDK error
+    });
+  }
+}
+```
+
+| Property   | Type     | Description                                    |
+| ---------- | -------- | ---------------------------------------------- |
+| `code`     | `string` | Always `'MAIL_DELIVERY'`                       |
+| `provider` | `string` | Provider that failed (`smtp`, `postmark`, etc.) |
+| `cause`    | `unknown`| Original error from the provider SDK           |
+
+---
+
 ## Exports Summary
 
 ### Core (`@breadstone/archipel-platform-mailing`)
@@ -372,6 +400,7 @@ export class OrderEmailService {
 | `FileTemplateFetchStrategy` | Strategy       | File-based templates            |
 | `BlobTemplateFetchStrategy` | Strategy       | Blob-stored templates           |
 | `MailHealthIndicator`       | Health         | Mail readiness check            |
+| `MailDeliveryError`         | Error class    | Domain error for delivery failures |
 
 ### Provider subpaths
 

package/data/packages/platform-mapping/index.md

@@ -0,0 +1,121 @@
+---
+title: platform-mapping
+description: Type-safe object-to-object mapping framework with profile-based configuration.
+order: 2
+tags: [mapping, dto, profiles, type-safe]
+package: '@breadstone/archipel-platform-mapping'
+---
+
+# platform-mapping
+
+Type-safe object-to-object mapping framework for transforming domain entities into response DTOs. Extracted from `platform-core` to provide a focused, independently versionable mapping module.
+
+**Package:** `@breadstone/archipel-platform-mapping`
+
+## Installation
+
+```typescript
+import {
+  MappingModule,
+  MappingService,
+  MappingProfileBase,
+  MappingKey,
+  MappingError,
+  MappingNotRegisteredError,
+  TypeMappingNotRegisteredError,
+} from '@breadstone/archipel-platform-mapping';
+```
+
+---
+
+## Defining Mapping Keys
+
+Mapping keys are branded constants that provide compile-time safety for source → destination pairs:
+
+```typescript
+import { MappingKey } from '@breadstone/archipel-platform-mapping';
+import type { IUserEntity } from './entities';
+import type { UserResponse } from './responses';
+
+export const USER_TO_RESPONSE = new MappingKey<IUserEntity, UserResponse>('UserEntity→UserResponse');
+export const USER_TO_SUMMARY = new MappingKey<IUserEntity, UserSummary>('UserEntity→UserSummary');
+```
+
+## Creating a Mapping Profile
+
+Profiles group related mappings into cohesive, injectable classes:
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { MappingProfileBase, type IMappingBuilder } from '@breadstone/archipel-platform-mapping';
+import { USER_TO_RESPONSE, USER_TO_SUMMARY } from './mapping-keys';
+
+@Injectable()
+export class UserMappingProfile extends MappingProfileBase {
+  public override configure(builder: IMappingBuilder): void {
+    builder.createKeyedMap(USER_TO_RESPONSE, (source) => ({
+      id: source.id,
+      name: source.userName,
+      email: source.email,
+      verified: source.isVerified,
+      roles: [...source.roles],
+    }));
+
+    builder.createKeyedMap(USER_TO_SUMMARY, (source) => ({
+      id: source.id,
+      displayName: source.userName ?? source.email ?? 'Anonymous',
+    }));
+  }
+}
+```
+
+## Registering Profiles in a Module
+
+```typescript
+import { Module } from '@nestjs/common';
+import { MappingModule } from '@breadstone/archipel-platform-mapping';
+import { UserMappingProfile } from './mappers/UserMappingProfile';
+
+@Module({
+  imports: [MappingModule.withProfiles([UserMappingProfile])],
+})
+export class AppModule {}
+```
+
+## Using in a Controller
+
+```typescript
+import { Controller, Get, Param } from '@nestjs/common';
+import { MappingService } from '@breadstone/archipel-platform-mapping';
+import { USER_TO_RESPONSE } from './mapping-keys';
+
+@Controller('users')
+export class UserController {
+  constructor(
+    private readonly _userService: UserService,
+    private readonly _mappingService: MappingService,
+  ) {}
+
+  @Get(':id')
+  public async getUser(@Param('id') id: string): Promise<UserResponse> {
+    const entity = await this._userService.findById(id);
+    return this._mappingService.map(USER_TO_RESPONSE, entity);
+  }
+}
+```
+
+---
+
+## Error Classes
+
+| Error                          | Description                                     |
+| ------------------------------ | ----------------------------------------------- |
+| `MappingError`                 | Base error for all mapping failures              |
+| `MappingNotRegisteredError`    | Thrown when a mapping key has no registered map   |
+| `TypeMappingNotRegisteredError`| Thrown when a type-based mapping is not found     |
+
+---
+
+## API Reference
+
+See the auto-generated [API Reference](./api/) for full details on all exported classes, interfaces, and types.

package/data/packages/platform-mcp/api/Class.McpServerService.md

@@ -24,7 +24,7 @@ the registry, and provides methods to connect various transports.
 new McpServerService(_options, _registry): McpServerService;
 ```
 
-Defined in: [services/McpServerService.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L50)
+Defined in: [services/McpServerService.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L51)
 
 #### Parameters
 
@@ -47,7 +47,7 @@ Defined in: [services/McpServerService.ts:50](https://github.com/RueDeRennes/arc
 get server(): McpServer;
 ```
 
-Defined in: [services/McpServerService.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L64)
+Defined in: [services/McpServerService.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L65)
 
 Returns the underlying `McpServer` instance.
 
@@ -67,7 +67,7 @@ Error if the server has not been initialized yet.
 connectStdio(): Promise<StdioServerTransport>;
 ```
 
-Defined in: [services/McpServerService.ts:126](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L126)
+Defined in: [services/McpServerService.ts:129](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L129)
 
 Connects the server to a stdio transport.
 Suitable for local, process-spawned integrations.
@@ -84,7 +84,7 @@ Suitable for local, process-spawned integrations.
 connectTransport(transport): Promise<void>;
 ```
 
-Defined in: [services/McpServerService.ts:180](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L180)
+Defined in: [services/McpServerService.ts:183](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L183)
 
 Connects a custom transport to the MCP server.
 
@@ -106,7 +106,7 @@ Connects a custom transport to the MCP server.
 createSseTransport(options, response): Promise<SSEServerTransport>;
 ```
 
-Defined in: [services/McpServerService.ts:166](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L166)
+Defined in: [services/McpServerService.ts:169](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L169)
 
 Creates an SSE transport for legacy client support.
 The caller is responsible for wiring the returned transport to Express routes.
@@ -132,7 +132,7 @@ The configured SSE transport instance.
 createStreamableHttpTransport(options?): Promise<StreamableHTTPServerTransport>;
 ```
 
-Defined in: [services/McpServerService.ts:143](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L143)
+Defined in: [services/McpServerService.ts:146](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L146)
 
 Creates a Streamable HTTP transport for use with Express.
 The caller is responsible for wiring the transport's `handleRequest`
@@ -158,7 +158,7 @@ The configured transport instance.
 onModuleDestroy(): Promise<void>;
 ```
 
-Defined in: [services/McpServerService.ts:102](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L102)
+Defined in: [services/McpServerService.ts:103](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L103)
 
 Cleans up all active transports when the module is destroyed.
 
@@ -180,7 +180,7 @@ OnModuleDestroy.onModuleDestroy
 onModuleInit(): void;
 ```
 
-Defined in: [services/McpServerService.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L80)
+Defined in: [services/McpServerService.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L81)
 
 Initializes the MCP server and registers all tools, resources, and prompts
 from the registry.

package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md

@@ -9,6 +9,6 @@ editUrl: false
 const MCP_MODULE_OPTIONS: typeof MCP_MODULE_OPTIONS;
 ```
 
-Defined in: [constants/McpTokens.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/constants/McpTokens.ts#L4)
+Defined in: [tokens/McpTokens.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/tokens/McpTokens.ts#L4)
 
 Injection tokens used by the MCP module.

package/data/packages/platform-mcp/index.md

@@ -297,3 +297,14 @@ graph TD
 2. **McpDiscoveryService** runs `onModuleInit`, iterates all providers, reads decorator metadata, and populates the registry.
 3. **McpServerService** runs `onModuleInit`, creates the `McpServer` instance, and registers all handlers from the registry.
 4. The application connects a transport (stdio, HTTP, SSE, or custom) to start serving MCP requests.
+
+---
+
+## Resource Limits & Shutdown
+
+| Limit                | Value      | Description                                                              |
+| -------------------- | ---------- | ------------------------------------------------------------------------ |
+| **Max transports**   | 1,000      | `McpServerService` tracks up to 1,000 active transports                  |
+| **Shutdown timeout** | 5 seconds  | Each transport and the server are closed with a 5-second timeout guard   |
+
+When the module is destroyed, `McpServerService.onModuleDestroy()` iterates all active transports, closes each with a 5-second timeout, and then closes the MCP server itself.

package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Class: SwaggerMultiDocumentService
 
-Defined in: [services/SwaggerMultiDocumentService.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/services/SwaggerMultiDocumentService.ts#L14)
+Defined in: [services/SwaggerMultiDocumentService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/services/SwaggerMultiDocumentService.ts#L15)
 
 ## Constructors
 
@@ -21,7 +21,7 @@ new SwaggerMultiDocumentService(
    contentTemplateEngine): SwaggerMultiDocumentService;
 ```
 
-Defined in: [services/SwaggerMultiDocumentService.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/services/SwaggerMultiDocumentService.ts#L30)
+Defined in: [services/SwaggerMultiDocumentService.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/services/SwaggerMultiDocumentService.ts#L31)
 
 #### Parameters
 
@@ -49,7 +49,7 @@ generateOpenApiDocuments(): {
 }[];
 ```
 
-Defined in: [services/SwaggerMultiDocumentService.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/services/SwaggerMultiDocumentService.ts#L78)
+Defined in: [services/SwaggerMultiDocumentService.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/services/SwaggerMultiDocumentService.ts#L79)
 
 Generates OpenAPI documents for every registered feature without wiring HTTP routes.
 
@@ -68,7 +68,7 @@ Generates OpenAPI documents for every registered feature without wiring HTTP rou
 setupMultipleSwaggerDocuments(): Promise<void>;
 ```
 
-Defined in: [services/SwaggerMultiDocumentService.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/services/SwaggerMultiDocumentService.ts#L54)
+Defined in: [services/SwaggerMultiDocumentService.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/services/SwaggerMultiDocumentService.ts#L55)
 
 Setup multiple Swagger documents for different features
 

package/data/packages/platform-openapi/api/Class.SwaggerTheme.md

@@ -17,7 +17,7 @@ The swagger theme class
 new SwaggerTheme(resourceManager): SwaggerTheme;
 ```
 
-Defined in: [SwaggerTheme.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/SwaggerTheme.ts#L29)
+Defined in: [SwaggerTheme.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/SwaggerTheme.ts#L30)
 
 Constructs a new instance of the `SwaggerTheme` class.
 
@@ -39,7 +39,7 @@ Constructs a new instance of the `SwaggerTheme` class.
 getOptions(): Pick<SwaggerCustomOptions, "customCss" | "customJsStr">;
 ```
 
-Defined in: [SwaggerTheme.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/SwaggerTheme.ts#L37)
+Defined in: [SwaggerTheme.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/SwaggerTheme.ts#L38)
 
 #### Returns
 

package/data/packages/platform-openapi/index.md

@@ -201,5 +201,5 @@ const features = registry.getFeatures(); // sorted, read-only copy
 | `SwaggerFeatureDiscovery`     | Service   | Auto-discover features          |
 | `SwaggerFeatureRegistry`      | Service   | Manage feature configs          |
 | `SwaggerMultiDocumentService` | Service   | Generate per-feature specs      |
-| `SwaggerTheme`                | Utility   | Theme customization             |
+| `SwaggerTheme`                | Utility   | Theme customization (CSS/JS cached after first load) |
 | `IFeatureSwaggerConfig`       | Interface | Feature config shape            |

package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Class: LemonSqueezyClient
 
-Defined in: [lemonsqueezy/LemonSqueezyClient.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L30)
+Defined in: [lemonsqueezy/LemonSqueezyClient.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L31)
 
 LemonSqueezy implementation of the [PaymentClientPort](Class.PaymentClientPort).
 Uses the official `@lemonsqueezy/lemonsqueezy.js` SDK.
@@ -22,7 +22,7 @@ Uses the official `@lemonsqueezy/lemonsqueezy.js` SDK.
 new LemonSqueezyClient(configService): LemonSqueezyClient;
 ```
 
-Defined in: [lemonsqueezy/LemonSqueezyClient.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L40)
+Defined in: [lemonsqueezy/LemonSqueezyClient.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L41)
 
 #### Parameters
 
@@ -46,7 +46,7 @@ Defined in: [lemonsqueezy/LemonSqueezyClient.ts:40](https://github.com/RueDeRenn
 constructWebhookEvent(payload, signature): INormalizedWebhookEvent;
 ```
 
-Defined in: [lemonsqueezy/LemonSqueezyClient.ts:143](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L143)
+Defined in: [lemonsqueezy/LemonSqueezyClient.ts:144](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L144)
 
 Construct and normalize a webhook event from raw payload.
 
@@ -79,7 +79,7 @@ createCheckoutSession(
 userId?): Promise<INormalizedCheckoutSession>;
 ```
 
-Defined in: [lemonsqueezy/LemonSqueezyClient.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L78)
+Defined in: [lemonsqueezy/LemonSqueezyClient.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L79)
 
 Create a checkout session.
 
@@ -110,7 +110,7 @@ Normalized checkout session.
 fetchPrices(productId): Promise<INormalizedPrice[]>;
 ```
 
-Defined in: [lemonsqueezy/LemonSqueezyClient.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L56)
+Defined in: [lemonsqueezy/LemonSqueezyClient.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L57)
 
 Fetch all active prices for a product.
 
@@ -140,7 +140,7 @@ fetchSubscription(subscriptionId): Promise<
 | null>;
 ```
 
-Defined in: [lemonsqueezy/LemonSqueezyClient.ts:124](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L124)
+Defined in: [lemonsqueezy/LemonSqueezyClient.ts:125](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L125)
 
 Retrieve subscription details.
 

package/data/packages/platform-payments/api/Class.MollieClient.md

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Class: MollieClient
 
-Defined in: [mollie/MollieClient.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L24)
+Defined in: [mollie/MollieClient.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L25)
 
 Mollie implementation of the [PaymentClientPort](Class.PaymentClientPort).
 Uses the official `@mollie/api-client` to interact with the Mollie API.
@@ -22,7 +22,7 @@ Uses the official `@mollie/api-client` to interact with the Mollie API.
 new MollieClient(configService): MollieClient;
 ```
 
-Defined in: [mollie/MollieClient.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L35)
+Defined in: [mollie/MollieClient.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L36)
 
 #### Parameters
 
@@ -46,7 +46,7 @@ Defined in: [mollie/MollieClient.ts:35](https://github.com/RueDeRennes/archipel/
 constructWebhookEvent(payload, signature): INormalizedWebhookEvent;
 ```
 
-Defined in: [mollie/MollieClient.ts:132](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L132)
+Defined in: [mollie/MollieClient.ts:133](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L133)
 
 Construct and normalize a webhook event from raw payload.
 
@@ -79,7 +79,7 @@ createCheckoutSession(
 userId?): Promise<INormalizedCheckoutSession>;
 ```
 
-Defined in: [mollie/MollieClient.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L65)
+Defined in: [mollie/MollieClient.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L66)
 
 Creates a checkout session for Mollie.
 
@@ -113,7 +113,7 @@ formatted monetary amount (e.g. "10.00") for the payment creation.
 fetchPrices(_productId): Promise<INormalizedPrice[]>;
 ```
 
-Defined in: [mollie/MollieClient.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L49)
+Defined in: [mollie/MollieClient.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L50)
 
 Fetch all active prices for a product.
 
@@ -143,7 +143,7 @@ fetchSubscription(subscriptionId): Promise<
 | null>;
 ```
 
-Defined in: [mollie/MollieClient.ts:106](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L106)
+Defined in: [mollie/MollieClient.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L107)
 
 Retrieve subscription details.
 

package/data/packages/platform-payments/api/Class.PaddleClient.md

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Class: PaddleClient
 
-Defined in: [paddle/PaddleClient.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L24)
+Defined in: [paddle/PaddleClient.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L25)
 
 Paddle implementation of the [PaymentClientPort](Class.PaymentClientPort).
 Uses the official `@paddle/paddle-node-sdk` to interact with the Paddle Billing API.
@@ -22,7 +22,7 @@ Uses the official `@paddle/paddle-node-sdk` to interact with the Paddle Billing
 new PaddleClient(configService): PaddleClient;
 ```
 
-Defined in: [paddle/PaddleClient.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L35)
+Defined in: [paddle/PaddleClient.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L36)
 
 #### Parameters
 
@@ -46,7 +46,7 @@ Defined in: [paddle/PaddleClient.ts:35](https://github.com/RueDeRennes/archipel/
 constructWebhookEvent(payload, signature): Promise<INormalizedWebhookEvent>;
 ```
 
-Defined in: [paddle/PaddleClient.ts:121](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L121)
+Defined in: [paddle/PaddleClient.ts:122](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L122)
 
 Construct and normalize a webhook event from raw payload.
 
@@ -79,7 +79,7 @@ createCheckoutSession(
 userId?): Promise<INormalizedCheckoutSession>;
 ```
 
-Defined in: [paddle/PaddleClient.ts:72](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L72)
+Defined in: [paddle/PaddleClient.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L73)
 
 Create a checkout session.
 
@@ -110,7 +110,7 @@ Normalized checkout session.
 fetchPrices(productId): Promise<INormalizedPrice[]>;
 ```
 
-Defined in: [paddle/PaddleClient.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L52)
+Defined in: [paddle/PaddleClient.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L53)
 
 Fetch all active prices for a product.
 
@@ -140,7 +140,7 @@ fetchSubscription(subscriptionId): Promise<
 | null>;
 ```
 
-Defined in: [paddle/PaddleClient.ts:106](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L106)
+Defined in: [paddle/PaddleClient.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L107)
 
 Retrieve subscription details.
 

package/data/packages/platform-payments/api/Class.PaymentError.md

@@ -0,0 +1,65 @@
+---
+title: 'Class: PaymentError'
+generated: true
+editUrl: false
+---
+# Class: PaymentError
+
+Defined in: [errors/PaymentError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/errors/PaymentError.ts#L6)
+
+Domain error thrown when a payment operation fails.
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+```ts
+new PaymentError(
+   provider, 
+   message, 
+   cause?): PaymentError;
+```
+
+Defined in: [errors/PaymentError.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/errors/PaymentError.ts#L16)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `provider` | `string` |
+| `message` | `string` |
+| `cause?` | `unknown` |
+
+#### Returns
+
+`PaymentError`
+
+#### Overrides
+
+```ts
+Error.constructor
+```
+
+## Properties
+
+### code
+
+```ts
+readonly code: "PAYMENT" = 'PAYMENT';
+```
+
+Defined in: [errors/PaymentError.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/errors/PaymentError.ts#L9)
+
+***
+
+### provider
+
+```ts
+readonly provider: string;
+```
+
+Defined in: [errors/PaymentError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/errors/PaymentError.ts#L10)