@breadstone/archipel-mcp 0.0.7 → 0.0.9

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

@@ -0,0 +1,70 @@
+---
+title: '@breadstone/archipel-platform-intelligence'
+generated: true
+editUrl: false
+---
+
+# @breadstone/archipel-platform-intelligence
+
+## Classes
+
+| Class                                                                            | Description                                                                                                                                                                          |
+| -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [IntelligenceCapabilityRegistrarBase](Class.IntelligenceCapabilityRegistrarBase) | Provides a reusable registration flow that allows feature modules to contribute capabilities to the global intelligence registry while keeping their implementation details private. |
+| [IntelligenceCapabilityRegistry](Class.IntelligenceCapabilityRegistry)           | Central registry responsible for resolving intelligence capabilities based on intent metadata.                                                                                       |
+| [IntelligenceModule](Class.IntelligenceModule)                                   | Core module exposing the shared intelligence infrastructure to feature modules.                                                                                                      |
+| [IntelligenceTextGenerator](Class.IntelligenceTextGenerator)                     | Executes text completions using the configured intelligence provider.                                                                                                                |
+
+## Interfaces
+
+| Interface                                                                                      | Description                                                                           |
+| ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
+| [IIntelligenceArtifact](Interface.IIntelligenceArtifact)                                       | Represents a structured artifact returned by a capability.                            |
+| [IIntelligenceCapability](Interface.IIntelligenceCapability)                                   | Abstraction implemented by all capability providers.                                  |
+| [IIntelligenceCapabilityMetadata](Interface.IIntelligenceCapabilityMetadata)                   | Metadata describing a capability for orchestration and analytics purposes.            |
+| [IIntelligenceCapabilityPayload](Interface.IIntelligenceCapabilityPayload)                     | Payload forwarded to capabilities for execution.                                      |
+| [IIntelligenceCapabilityRegistry](Interface.IIntelligenceCapabilityRegistry)                   | Registry abstraction responsible for resolving capabilities.                          |
+| [IIntelligenceCapabilityResult](Interface.IIntelligenceCapabilityResult)                       | Represents the outcome produced by a capability execution.                            |
+| [IIntelligenceCompletionUsage](Interface.IIntelligenceCompletionUsage)                         | Captures usage telemetry returned by the intelligence provider.                       |
+| [IIntelligenceContext](Interface.IIntelligenceContext)                                         | Describes the context aggregated before routing a request to a capability.            |
+| [IIntelligenceContextBuilder](Interface.IIntelligenceContextBuilder)                           | Responsible for composing the context supplied to capabilities.                       |
+| [IIntelligenceConversationMessageSnapshot](Interface.IIntelligenceConversationMessageSnapshot) | Represents a single message returned within a conversation snapshot.                  |
+| [IIntelligenceConversationSnapshot](Interface.IIntelligenceConversationSnapshot)               | Represents a lightweight snapshot of a conversation used for context building.        |
+| [IIntelligenceFollowUpQuestion](Interface.IIntelligenceFollowUpQuestion)                       | Represents a follow-up question suggested to keep the dialogue active.                |
+| [IIntelligenceIntent](Interface.IIntelligenceIntent)                                           | Represents the structured intent resolved from a user message.                        |
+| [IIntelligenceIntentEntity](Interface.IIntelligenceIntentEntity)                               | Represents an entity extracted from a resolved intelligence intent.                   |
+| [IIntelligenceMessageModel](Interface.IIntelligenceMessageModel)                               | Represents a normalized message stored in persistence.                                |
+| [IIntelligenceMessagePayload](Interface.IIntelligenceMessagePayload)                           | Carries the payload submitted when messaging the intelligence entrypoint.             |
+| [IIntelligencePrompt](Interface.IIntelligencePrompt)                                           | Represents the input supplied to the intelligence text generator.                     |
+| [IIntelligencePromptMessage](Interface.IIntelligencePromptMessage)                             | Describes a normalized message used for text generation prompts.                      |
+| [IIntelligenceProviderConfiguration](Interface.IIntelligenceProviderConfiguration)             | Describes the resolved configuration for the intelligence provider.                   |
+| [IIntelligenceResponseMessage](Interface.IIntelligenceResponseMessage)                         | Represents a single assistant message returned by a capability.                       |
+| [IIntelligenceTextCompletion](Interface.IIntelligenceTextCompletion)                           | Represents the normalized completion result produced by the intelligence provider.    |
+| [IIntelligenceTextGenerationOptions](Interface.IIntelligenceTextGenerationOptions)             | Options that can be supplied when generating text with the intelligence provider.     |
+| [IIntelligenceTextGenerator](Interface.IIntelligenceTextGenerator)                             | Abstraction responsible for executing text completions using the configured provider. |
+
+## Type Aliases
+
+| Type Alias                                                                           | Description                                                                          |
+| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
+| [IntelligenceConversationMessageRole](TypeAlias.IntelligenceConversationMessageRole) | Represents the union of supported conversation message roles.                        |
+| [IntelligenceLanguageModelLoader](TypeAlias.IntelligenceLanguageModelLoader)         | Represents a factory responsible for resolving a configured language model instance. |
+| [IntelligenceProviderName](TypeAlias.IntelligenceProviderName)                       | Represents the union of supported intelligence provider identifiers.                 |
+
+## Variables
+
+| Variable                                                                              | Description                                                                   |
+| ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
+| [IntelligenceConversationMessageRoles](Variable.IntelligenceConversationMessageRoles) | Enumerates the conversation roles used for contextual snapshots and messages. |
+| [IntelligenceProviderNames](Variable.IntelligenceProviderNames)                       | Enumerates the supported model providers powering the intelligence pipeline.  |
+
+## Functions
+
+| Function                                                          | Description                                                                               |
+| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
+| [createProviderOptions](Function.createProviderOptions)           | Creates the provider options object consumed by the AI SDK model factories.               |
+| [loadAnthropicLanguageModel](Function.loadAnthropicLanguageModel) | Loads the Anthropic language model based on the resolved provider configuration.          |
+| [loadGoogleLanguageModel](Function.loadGoogleLanguageModel)       | Loads the Google (Gemini) language model based on the resolved provider configuration.    |
+| [loadGrokLanguageModel](Function.loadGrokLanguageModel)           | Loads the Grok (xAI) language model based on the resolved provider configuration.         |
+| [loadOpenAILanguageModel](Function.loadOpenAILanguageModel)       | Loads the OpenAI compatible language model based on the resolved provider configuration.  |
+| [loadProviderFactory](Function.loadProviderFactory)               | Dynamically loads an AI SDK provider factory and returns the exported function reference. |

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

@@ -0,0 +1,131 @@
+---
+title: platform-intelligence
+description: Multi-provider AI text generation with capability registry and intent-based orchestration.
+order: 16
+tags: [intelligence, ai, openai, anthropic, google, grok, text-generation, capability-registry]
+package: '@breadstone/archipel-platform-intelligence'
+---
+
+# platform-intelligence
+
+Multi-provider AI text generation library supporting OpenAI, Anthropic, Google Generative AI, and Grok. Features a capability registry that maps business intents to provider-specific configurations, enabling intent-based orchestration without coupling consumers to a specific LLM.
+
+**Package:** `@breadstone/archipel-platform-intelligence`
+
+## Quick Start
+
+```typescript
+import { Module } from '@nestjs/common';
+import { IntelligenceModule } from '@breadstone/archipel-platform-intelligence';
+
+@Module({
+  imports: [IntelligenceModule],
+})
+export class AppModule {}
+```
+
+---
+
+## Provider Packages
+
+Install only the providers you need:
+
+| Provider  | Package                                                |
+| --------- | ------------------------------------------------------ |
+| OpenAI    | `@breadstone/archipel-platform-intelligence/openai`    |
+| Anthropic | `@breadstone/archipel-platform-intelligence/anthropic` |
+| Google    | `@breadstone/archipel-platform-intelligence/google`    |
+| Grok      | `@breadstone/archipel-platform-intelligence/grok`      |
+
+---
+
+## Text Generation
+
+Inject `IntelligenceTextGenerator` and call `generateText()`:
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { IntelligenceTextGenerator, IIntelligencePrompt } from '@breadstone/archipel-platform-intelligence';
+
+@Injectable()
+export class SummaryService {
+  constructor(private readonly _textGenerator: IntelligenceTextGenerator) {}
+
+  async summarize(content: string): Promise<string> {
+    const prompt: IIntelligencePrompt = {
+      system: 'You are a concise summarizer.',
+      messages: [{ role: 'user', content }],
+    };
+
+    const result = await this._textGenerator.generateText(prompt, {
+      provider: 'openai',
+      model: 'gpt-4o',
+      temperature: 0.3,
+    });
+
+    return result.text;
+  }
+}
+```
+
+---
+
+## Capability Registry
+
+The capability registry decouples consumers from specific providers and models by mapping business intents to configurations.
+
+### Defining Capabilities
+
+```typescript
+import { IIntelligenceCapability } from '@breadstone/archipel-platform-intelligence';
+
+const SUMMARIZE_CAPABILITY: IIntelligenceCapability = {
+  intent: 'summarize',
+  provider: 'openai',
+  model: 'gpt-4o',
+  temperature: 0.3,
+  maxTokens: 1024,
+};
+```
+
+### Registering via IntelligenceCapabilityRegistrarBase
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import {
+  IntelligenceCapabilityRegistrarBase,
+  IIntelligenceCapabilityRegistry,
+} from '@breadstone/archipel-platform-intelligence';
+
+@Injectable()
+export class AppCapabilityRegistrar extends IntelligenceCapabilityRegistrarBase {
+  protected registerCapabilities(registry: IIntelligenceCapabilityRegistry): void {
+    registry.register(SUMMARIZE_CAPABILITY);
+    registry.register(TRANSLATE_CAPABILITY);
+  }
+}
+```
+
+### Resolving at Runtime
+
+```typescript
+const capability = this._registry.resolve('summarize');
+const result = await this._textGenerator.generateText(prompt, capability);
+```
+
+---
+
+## Environment Variables
+
+| Variable                         | Description                  | Required           |
+| -------------------------------- | ---------------------------- | ------------------ |
+| `INTELLIGENCE_OPENAI_API_KEY`    | OpenAI API key               | If using OpenAI    |
+| `INTELLIGENCE_ANTHROPIC_API_KEY` | Anthropic API key            | If using Anthropic |
+| `INTELLIGENCE_GOOGLE_API_KEY`    | Google Generative AI API key | If using Google    |
+| `INTELLIGENCE_GROK_API_KEY`      | Grok / xAI API key           | If using Grok      |
+
+---
+
+## API Reference
+
+See the full [API documentation](./api/) for all exported types, interfaces, and classes.

package/data/packages/platform-mailing/api/Class.MailService.md

@@ -6,7 +6,7 @@ editUrl: false
 
 # Class: MailService
 
-Defined in: [platform-mailing/src/services/MailService.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailService.ts#L17)
+Defined in: [platform-mailing/src/services/MailService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailService.ts#L18)
 
 Represents the `MailService` class.
 
@@ -21,7 +21,7 @@ new MailService(
    deliveryStrategy): MailService;
 ```
 
-Defined in: [platform-mailing/src/services/MailService.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailService.ts#L34)
+Defined in: [platform-mailing/src/services/MailService.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailService.ts#L35)
 
 Constructs a new instance of the `MailService` class.
 
@@ -48,7 +48,7 @@ send(
 isHtml): Promise<void>;
 ```
 
-Defined in: [platform-mailing/src/services/MailService.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailService.ts#L64)
+Defined in: [platform-mailing/src/services/MailService.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailService.ts#L65)
 
 Sends an email with either plain text or HTML content.
 
@@ -75,7 +75,7 @@ Sends an email with either plain text or HTML content.
 sendTemplate(mailOptions, templateOptions): Promise<void>;
 ```
 
-Defined in: [platform-mailing/src/services/MailService.ts:93](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailService.ts#L93)
+Defined in: [platform-mailing/src/services/MailService.ts:94](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailService.ts#L94)
 
 Sends an email using a predefined template (HTML or text).
 Automatically uses the template format (either 'html' or 'txt') based on the environment variable.

package/data/packages/platform-mailing/api/Class.MailVerificationService.md

@@ -6,7 +6,7 @@ editUrl: false
 
 # Class: MailVerificationService
 
-Defined in: [platform-mailing/src/services/MailVerificationService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailVerificationService.ts#L15)
+Defined in: [platform-mailing/src/services/MailVerificationService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailVerificationService.ts#L16)
 
 Represents the `MailVerificationService` class.
 
@@ -18,7 +18,7 @@ Represents the `MailVerificationService` class.
 new MailVerificationService(configService): MailVerificationService;
 ```
 
-Defined in: [platform-mailing/src/services/MailVerificationService.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailVerificationService.ts#L29)
+Defined in: [platform-mailing/src/services/MailVerificationService.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailVerificationService.ts#L30)
 
 Constructs a new instance of the `MailVerificationService` class.
 
@@ -44,7 +44,7 @@ sendTestEmail(
 text): Promise<void>;
 ```
 
-Defined in: [platform-mailing/src/services/MailVerificationService.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailVerificationService.ts#L70)
+Defined in: [platform-mailing/src/services/MailVerificationService.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailVerificationService.ts#L71)
 
 Send an email for testing purposes or verification
 
@@ -69,7 +69,7 @@ Send an email for testing purposes or verification
 verifyEmail(email): Promise<boolean>;
 ```
 
-Defined in: [platform-mailing/src/services/MailVerificationService.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailVerificationService.ts#L48)
+Defined in: [platform-mailing/src/services/MailVerificationService.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailVerificationService.ts#L49)
 
 Verifies if the email address is valid and reachable.
 

package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md

@@ -6,7 +6,7 @@ editUrl: false
 
 # Class: MailgunDeliveryStrategy
 
-Defined in: [platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts#L17)
+Defined in: [platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts#L18)
 
 Delivers emails via the Mailgun API.
 
@@ -22,7 +22,7 @@ Delivers emails via the Mailgun API.
 new MailgunDeliveryStrategy(configService): MailgunDeliveryStrategy;
 ```
 
-Defined in: [platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts#L33)
+Defined in: [platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts#L34)
 
 Constructs a new instance of the `MailgunDeliveryStrategy` class.
 
@@ -53,7 +53,7 @@ send(
 isHtml): Promise<void>;
 ```
 
-Defined in: [platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts#L58)
+Defined in: [platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/MailgunDeliveryStrategy.ts#L59)
 
 Sends an email using the Mailgun transport.
 

package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md

@@ -6,7 +6,7 @@ editUrl: false
 
 # Class: PostmarkDeliveryStrategy
 
-Defined in: [platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts#L15)
+Defined in: [platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts#L16)
 
 The `PostmarkDeliveryStrategy` class.
 
@@ -22,7 +22,7 @@ The `PostmarkDeliveryStrategy` class.
 new PostmarkDeliveryStrategy(configService): PostmarkDeliveryStrategy;
 ```
 
-Defined in: [platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts#L30)
+Defined in: [platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts#L31)
 
 Constructs a new instance of the `PostmarkDeliveryStrategy` class.
 
@@ -53,7 +53,7 @@ send(
 isHtml): Promise<void>;
 ```
 
-Defined in: [platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts#L50)
+Defined in: [platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/PostmarkDeliveryStrategy.ts#L51)
 
 Sends an email using the Postmark transport.
 

package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md

@@ -6,7 +6,7 @@ editUrl: false
 
 # Class: ResendDeliveryStrategy
 
-Defined in: [platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts#L15)
+Defined in: [platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts#L16)
 
 Delivers emails via the Resend API.
 
@@ -22,7 +22,7 @@ Delivers emails via the Resend API.
 new ResendDeliveryStrategy(configService): ResendDeliveryStrategy;
 ```
 
-Defined in: [platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts#L30)
+Defined in: [platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts#L31)
 
 Constructs a new instance of the `ResendDeliveryStrategy` class.
 
@@ -53,7 +53,7 @@ send(
 isHtml): Promise<void>;
 ```
 
-Defined in: [platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts#L50)
+Defined in: [platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/ResendDeliveryStrategy.ts#L51)
 
 Sends an email using the Resend transport.
 

package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md

@@ -6,7 +6,7 @@ editUrl: false
 
 # Class: SendGridDeliveryStrategy
 
-Defined in: [platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts#L15)
+Defined in: [platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts#L16)
 
 Delivers emails via the SendGrid API.
 
@@ -22,7 +22,7 @@ Delivers emails via the SendGrid API.
 new SendGridDeliveryStrategy(configService): SendGridDeliveryStrategy;
 ```
 
-Defined in: [platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts#L29)
+Defined in: [platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts#L30)
 
 Constructs a new instance of the `SendGridDeliveryStrategy` class.
 
@@ -53,7 +53,7 @@ send(
 isHtml): Promise<void>;
 ```
 
-Defined in: [platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts#L49)
+Defined in: [platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SendGridDeliveryStrategy.ts#L50)
 
 Sends an email using the SendGrid transport.
 

package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md

@@ -6,7 +6,7 @@ editUrl: false
 
 # Class: SmtpDeliveryStrategy
 
-Defined in: [platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts#L15)
+Defined in: [platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts#L16)
 
 The `SmtpDeliveryStrategy` class.
 
@@ -22,7 +22,7 @@ The `SmtpDeliveryStrategy` class.
 new SmtpDeliveryStrategy(configService): SmtpDeliveryStrategy;
 ```
 
-Defined in: [platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts#L30)
+Defined in: [platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts#L31)
 
 Constructs a new instance of the `LogDelivery` class.
 
@@ -53,7 +53,7 @@ send(
 isHtml): Promise<void>;
 ```
 
-Defined in: [platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts#L60)
+Defined in: [platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/SmtpDeliveryStrategy.ts#L61)
 
 Sends an email using the SMTP transport.
 

package/data/packages/platform-openapi/api/Function.SwaggerFeature.md

@@ -30,7 +30,7 @@ This allows the SwaggerMultiDocumentService to automatically discover and create
 ```typescript
 @SwaggerFeature({
   name: 'tip',
-  title: 'Strivio API - Tips',
+  title: 'My App API - Tips',
   description: 'API endpoints for tip management',
   tag: 'Tip',
 })

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

@@ -6,7 +6,7 @@ editUrl: false
 
 # Class: LemonSqueezyClient
 
-Defined in: [lemonsqueezy/LemonSqueezyClient.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L29)
+Defined in: [lemonsqueezy/LemonSqueezyClient.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L30)
 
 LemonSqueezy implementation of the [PaymentClientPort](Class.PaymentClientPort).
 Uses the official `@lemonsqueezy/lemonsqueezy.js` SDK.
@@ -23,7 +23,7 @@ Uses the official `@lemonsqueezy/lemonsqueezy.js` SDK.
 new LemonSqueezyClient(configService): LemonSqueezyClient;
 ```
 
-Defined in: [lemonsqueezy/LemonSqueezyClient.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L39)
+Defined in: [lemonsqueezy/LemonSqueezyClient.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L40)
 
 #### Parameters
 
@@ -47,7 +47,7 @@ Defined in: [lemonsqueezy/LemonSqueezyClient.ts:39](https://github.com/RueDeRenn
 constructWebhookEvent(payload, signature): INormalizedWebhookEvent;
 ```
 
-Defined in: [lemonsqueezy/LemonSqueezyClient.ts:142](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L142)
+Defined in: [lemonsqueezy/LemonSqueezyClient.ts:143](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L143)
 
 Construct and normalize a webhook event from raw payload.
 
@@ -80,7 +80,7 @@ createCheckoutSession(
 userId?): Promise<INormalizedCheckoutSession>;
 ```
 
-Defined in: [lemonsqueezy/LemonSqueezyClient.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L77)
+Defined in: [lemonsqueezy/LemonSqueezyClient.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L78)
 
 Create a checkout session.
 
@@ -111,7 +111,7 @@ Normalized checkout session.
 fetchPrices(productId): Promise<INormalizedPrice[]>;
 ```
 
-Defined in: [lemonsqueezy/LemonSqueezyClient.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L55)
+Defined in: [lemonsqueezy/LemonSqueezyClient.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L56)
 
 Fetch all active prices for a product.
 
@@ -141,7 +141,7 @@ fetchSubscription(subscriptionId): Promise<
 | null>;
 ```
 
-Defined in: [lemonsqueezy/LemonSqueezyClient.ts:123](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L123)
+Defined in: [lemonsqueezy/LemonSqueezyClient.ts:124](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L124)
 
 Retrieve subscription details.
 

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

@@ -6,7 +6,7 @@ editUrl: false
 
 # Class: MollieClient
 
-Defined in: [mollie/MollieClient.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L23)
+Defined in: [mollie/MollieClient.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L24)
 
 Mollie implementation of the [PaymentClientPort](Class.PaymentClientPort).
 Uses the official `@mollie/api-client` to interact with the Mollie API.
@@ -23,7 +23,7 @@ Uses the official `@mollie/api-client` to interact with the Mollie API.
 new MollieClient(configService): MollieClient;
 ```
 
-Defined in: [mollie/MollieClient.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L34)
+Defined in: [mollie/MollieClient.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L35)
 
 #### Parameters
 
@@ -47,7 +47,7 @@ Defined in: [mollie/MollieClient.ts:34](https://github.com/RueDeRennes/archipel/
 constructWebhookEvent(payload, signature): INormalizedWebhookEvent;
 ```
 
-Defined in: [mollie/MollieClient.ts:122](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L122)
+Defined in: [mollie/MollieClient.ts:123](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L123)
 
 Construct and normalize a webhook event from raw payload.
 
@@ -80,7 +80,7 @@ createCheckoutSession(
 userId?): Promise<INormalizedCheckoutSession>;
 ```
 
-Defined in: [mollie/MollieClient.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L59)
+Defined in: [mollie/MollieClient.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L60)
 
 Create a checkout session.
 
@@ -111,7 +111,7 @@ Normalized checkout session.
 fetchPrices(_productId): Promise<INormalizedPrice[]>;
 ```
 
-Defined in: [mollie/MollieClient.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L48)
+Defined in: [mollie/MollieClient.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L49)
 
 Fetch all active prices for a product.
 
@@ -141,7 +141,7 @@ fetchSubscription(subscriptionId): Promise<
 | null>;
 ```
 
-Defined in: [mollie/MollieClient.ts:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L96)
+Defined in: [mollie/MollieClient.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/MollieClient.ts#L97)
 
 Retrieve subscription details.
 

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

@@ -6,7 +6,7 @@ editUrl: false
 
 # Class: PaddleClient
 
-Defined in: [paddle/PaddleClient.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L23)
+Defined in: [paddle/PaddleClient.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L24)
 
 Paddle implementation of the [PaymentClientPort](Class.PaymentClientPort).
 Uses the official `@paddle/paddle-node-sdk` to interact with the Paddle Billing API.
@@ -23,7 +23,7 @@ Uses the official `@paddle/paddle-node-sdk` to interact with the Paddle Billing
 new PaddleClient(configService): PaddleClient;
 ```
 
-Defined in: [paddle/PaddleClient.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L34)
+Defined in: [paddle/PaddleClient.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L35)
 
 #### Parameters
 
@@ -47,7 +47,7 @@ Defined in: [paddle/PaddleClient.ts:34](https://github.com/RueDeRennes/archipel/
 constructWebhookEvent(payload, signature): Promise<INormalizedWebhookEvent>;
 ```
 
-Defined in: [paddle/PaddleClient.ts:120](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L120)
+Defined in: [paddle/PaddleClient.ts:121](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L121)
 
 Construct and normalize a webhook event from raw payload.
 
@@ -80,7 +80,7 @@ createCheckoutSession(
 userId?): Promise<INormalizedCheckoutSession>;
 ```
 
-Defined in: [paddle/PaddleClient.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L71)
+Defined in: [paddle/PaddleClient.ts:72](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L72)
 
 Create a checkout session.
 
@@ -111,7 +111,7 @@ Normalized checkout session.
 fetchPrices(productId): Promise<INormalizedPrice[]>;
 ```
 
-Defined in: [paddle/PaddleClient.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L51)
+Defined in: [paddle/PaddleClient.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L52)
 
 Fetch all active prices for a product.
 
@@ -141,7 +141,7 @@ fetchSubscription(subscriptionId): Promise<
 | null>;
 ```
 
-Defined in: [paddle/PaddleClient.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L105)
+Defined in: [paddle/PaddleClient.ts:106](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/PaddleClient.ts#L106)
 
 Retrieve subscription details.