@breadstone/archipel-mcp 0.0.23 → 0.0.25

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

@@ -5,16 +5,16 @@ editUrl: false
 ---
 # ~~Class: MailVerificationService~~
 
-Defined in: [platform-mailing/src/services/MailVerificationService.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailVerificationService.ts#L20)
-
-Verifies SMTP server connectivity. Does **not** validate individual email
-addresses - only checks whether the configured SMTP transport is reachable.
+Defined in: [platform-mailing/src/services/MailVerificationService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailVerificationService.ts#L15)
 
 ## Deprecated
 
-Renamed to `SmtpConnectionVerifier` in a future release to better
-reflect its actual purpose. Prefer wrapping this in a health-check rather
-than calling it directly.
+Use [SmtpConnectionVerifier](Class.SmtpConnectionVerifier) instead. This class will be
+removed in a future major release.
+
+## Extends
+
+- [`SmtpConnectionVerifier`](Class.SmtpConnectionVerifier)
 
 ## Constructors
 
@@ -24,9 +24,9 @@ than calling it directly.
 new MailVerificationService(configService): MailVerificationService;
 ```
 
-Defined in: [platform-mailing/src/services/MailVerificationService.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailVerificationService.ts#L35)
+Defined in: [platform-mailing/src/services/SmtpConnectionVerifier.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/SmtpConnectionVerifier.ts#L32)
 
-Constructs a new instance of the `MailVerificationService` class.
+Constructs a new instance of the [SmtpConnectionVerifier](Class.SmtpConnectionVerifier) class.
 
 #### Parameters
 
@@ -38,6 +38,10 @@ Constructs a new instance of the `MailVerificationService` class.
 
 `MailVerificationService`
 
+#### Inherited from
+
+[`SmtpConnectionVerifier`](Class.SmtpConnectionVerifier).[`constructor`](Class.SmtpConnectionVerifier#constructor)
+
 ## Methods
 
 ### ~~sendTestEmail()~~
@@ -50,9 +54,9 @@ sendTestEmail(
 text): Promise<void>;
 ```
 
-Defined in: [platform-mailing/src/services/MailVerificationService.ts:76](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailVerificationService.ts#L76)
+Defined in: [platform-mailing/src/services/SmtpConnectionVerifier.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/SmtpConnectionVerifier.ts#L74)
 
-Send an email for testing purposes or verification
+Send an email for testing purposes.
 
 #### Parameters
 
@@ -67,26 +71,55 @@ Send an email for testing purposes or verification
 
 `Promise`\<`void`\>
 
+#### Inherited from
+
+[`SmtpConnectionVerifier`](Class.SmtpConnectionVerifier).[`sendTestEmail`](Class.SmtpConnectionVerifier#sendtestemail)
+
+***
+
+### ~~verifyConnection()~~
+
+```ts
+verifyConnection(): Promise<boolean>;
+```
+
+Defined in: [platform-mailing/src/services/SmtpConnectionVerifier.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/SmtpConnectionVerifier.ts#L54)
+
+Verifies that the configured SMTP server is reachable.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the SMTP server is reachable, `false` otherwise.
+
+#### Inherited from
+
+[`SmtpConnectionVerifier`](Class.SmtpConnectionVerifier).[`verifyConnection`](Class.SmtpConnectionVerifier#verifyconnection)
+
 ***
 
 ### ~~verifyEmail()~~
 
 ```ts
-verifyEmail(email): Promise<boolean>;
+verifyEmail(_email): Promise<boolean>;
 ```
 
-Defined in: [platform-mailing/src/services/MailVerificationService.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailVerificationService.ts#L54)
+Defined in: [platform-mailing/src/services/MailVerificationService.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/MailVerificationService.ts#L27)
 
-Verifies if the email address is valid and reachable.
+Verifies SMTP server connectivity.
 
 #### Parameters
 
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
-| `email` | `string` | The email address to verify |
+| `_email` | `string` | Unused. Kept for backward compatibility. |
 
 #### Returns
 
 `Promise`\<`boolean`\>
 
-Promise\<boolean\> - Resolves true if email exists, false otherwise
+#### Deprecated
+
+Use [SmtpConnectionVerifier.verifyConnection](Class.SmtpConnectionVerifier#verifyconnection) instead.
+The `email` parameter was never used.

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

@@ -0,0 +1,84 @@
+---
+title: 'Class: SmtpConnectionVerifier'
+generated: true
+editUrl: false
+---
+# Class: SmtpConnectionVerifier
+
+Defined in: [platform-mailing/src/services/SmtpConnectionVerifier.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/SmtpConnectionVerifier.ts#L17)
+
+Verifies SMTP server connectivity. Does **not** validate individual email
+addresses — only checks whether the configured SMTP transport is reachable.
+
+## Extended by
+
+- [`MailVerificationService`](Class.MailVerificationService)
+
+## Constructors
+
+### Constructor
+
+```ts
+new SmtpConnectionVerifier(configService): SmtpConnectionVerifier;
+```
+
+Defined in: [platform-mailing/src/services/SmtpConnectionVerifier.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/SmtpConnectionVerifier.ts#L32)
+
+Constructs a new instance of the SmtpConnectionVerifier class.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`SmtpConnectionVerifier`
+
+## Methods
+
+### sendTestEmail()
+
+```ts
+sendTestEmail(
+   from, 
+   to, 
+   subject, 
+text): Promise<void>;
+```
+
+Defined in: [platform-mailing/src/services/SmtpConnectionVerifier.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/SmtpConnectionVerifier.ts#L74)
+
+Send an email for testing purposes.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `from` | `string` |
+| `to` | `string` |
+| `subject` | `string` |
+| `text` | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### verifyConnection()
+
+```ts
+verifyConnection(): Promise<boolean>;
+```
+
+Defined in: [platform-mailing/src/services/SmtpConnectionVerifier.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/SmtpConnectionVerifier.ts#L54)
+
+Verifies that the configured SMTP server is reachable.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the SMTP server is reachable, `false` otherwise.

package/data/packages/platform-mailing/api/Interface.IMailModuleOptions.md

@@ -0,0 +1,36 @@
+---
+title: 'Interface: IMailModuleOptions'
+generated: true
+editUrl: false
+---
+# Interface: IMailModuleOptions
+
+Defined in: [platform-mailing/src/tokens/MailModule.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailModule.ts#L23)
+
+Options for configuring the [MailModule](Class.MailModule).
+
+## Properties
+
+### configEntries?
+
+```ts
+readonly optional configEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
+```
+
+Defined in: [platform-mailing/src/tokens/MailModule.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailModule.ts#L34)
+
+Additional or overriding configuration entries.
+Merged with the platform default entries.
+
+***
+
+### isGlobal?
+
+```ts
+readonly optional isGlobal?: boolean;
+```
+
+Defined in: [platform-mailing/src/tokens/MailModule.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailModule.ts#L28)
+
+Whether to register the module globally.
+Defaults to `true`.

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

@@ -16,10 +16,11 @@ editUrl: false
 | [MailModule](Class.MailModule) | Represents the mail module. |
 | [MailService](Class.MailService) | Represents the `MailService` class. |
 | [MailTemplateEngine](Class.MailTemplateEngine) | The `MailTemplateEngine` class. |
-| [~~MailVerificationService~~](Class.MailVerificationService) | Verifies SMTP server connectivity. Does **not** validate individual email addresses - only checks whether the configured SMTP transport is reachable. |
+| [~~MailVerificationService~~](Class.MailVerificationService) | - |
 | [PostmarkDeliveryStrategy](Class.PostmarkDeliveryStrategy) | The `PostmarkDeliveryStrategy` class. |
 | [ResendDeliveryStrategy](Class.ResendDeliveryStrategy) | Delivers emails via the Resend API. |
 | [SendGridDeliveryStrategy](Class.SendGridDeliveryStrategy) | Delivers emails via the SendGrid API. |
+| [SmtpConnectionVerifier](Class.SmtpConnectionVerifier) | Verifies SMTP server connectivity. Does **not** validate individual email addresses — only checks whether the configured SMTP transport is reachable. |
 | [SmtpDeliveryStrategy](Class.SmtpDeliveryStrategy) | The `SmtpDeliveryStrategy` class. |
 | [TemplateFetchStrategyBase](Class.TemplateFetchStrategyBase) | Represents the base class for template fetch strategies. |
 
@@ -29,6 +30,7 @@ editUrl: false
 | ------ | ------ |
 | [IMailAttachment](Interface.IMailAttachment) | Represents an email attachment. |
 | [IMailEvents](Interface.IMailEvents) | Represents the contract of events emitted by the mail domain. |
+| [IMailModuleOptions](Interface.IMailModuleOptions) | Options for configuring the [MailModule](Class.MailModule). |
 | [IMailTemplateVariants](Interface.IMailTemplateVariants) | Represents the in-memory structure for a single template (multiple formats). |
 
 ## Type Aliases

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

@@ -2,7 +2,7 @@
 title: platform-mailing
 description: Multi-strategy email delivery with support for SMTP, Postmark, Resend, SendGrid, and Mailgun.
 order: 7
-tags: [mailing, email, smtp, postmark, resend, sendgrid, mailgun, templates, verification, strategy-pattern]
+tags: [mailing, email, smtp, postmark, resend, sendgrid, mailgun, templates, verification, strategy-pattern, health]
 package: '@breadstone/archipel-platform-mailing'
 ---
 
@@ -285,9 +285,32 @@ Load templates from blob storage (e.g., Vercel Blob):
 
 ---
 
-## MailVerificationService
+## SmtpConnectionVerifier
 
-Email address verification flow:
+Verifies SMTP server connectivity. Replaces the deprecated `MailVerificationService`.
+
+```typescript
+import { SmtpConnectionVerifier } from '@breadstone/archipel-platform-mailing';
+
+@Injectable()
+export class HealthCheckService {
+  constructor(private readonly _smtpVerifier: SmtpConnectionVerifier) {}
+
+  public async checkSmtp(): Promise<boolean> {
+    return this._smtpVerifier.verifyConnection();
+  }
+
+  public async sendTestEmail(to: string): Promise<boolean> {
+    return this._smtpVerifier.sendTestEmail(to);
+  }
+}
+```
+
+## MailVerificationService (Deprecated)
+
+::: warning Deprecated
+`MailVerificationService` is deprecated. Use `SmtpConnectionVerifier` instead — it provides `verifyConnection()` for SMTP connectivity checks and `sendTestEmail()` for sending test messages.
+:::
 
 ```typescript
 import { MailVerificationService } from '@breadstone/archipel-platform-mailing';
@@ -304,15 +327,47 @@ export class RegistrationService {
 
 ---
 
+## MailModule.register()
+
+The `MailModule` supports a `register()` static method for explicit module configuration:
+
+```typescript
+import { MailModule } from '@breadstone/archipel-platform-mailing';
+
+@Module({
+  imports: [
+    MailModule.register({
+      configEntries: MY_CUSTOM_CONFIG_ENTRIES, // optional
+      isGlobal: true,                          // optional, default: false
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+---
+
 ## Health Check
 
+The `MailHealthIndicator` validates that the required mail configuration values (`MAIL_HOST`, `MAIL_USER`, `MAIL_PORT`) are present and non-empty. Import it from the `/health` subpath:
+
 ```typescript
-import { MailHealthIndicator } from '@breadstone/archipel-platform-mailing';
+import { MailHealthIndicator } from '@breadstone/archipel-platform-mailing/health';
+import { HealthModule } from '@breadstone/archipel-platform-health';
 
-// Registered with HealthOrchestrator automatically
-// Checks mail delivery readiness
+@Module({
+  imports: [
+    MailModule.register({ /* ... */ }),
+    HealthModule.withIndicators([MailHealthIndicator]),
+  ],
+})
+export class AppModule {}
 ```
 
+| Key | Check | Dependencies |
+| --- | ----- | ------------ |
+| `mail` | Validates mail host, user, and port config | `ConfigService` |
+
 ---
 
 ## Real-World Example: Transactional Email Pipeline
@@ -389,7 +444,8 @@ try {
 | --------------------------- | -------------- | ------------------------------- |
 | `MailModule`                | NestJS Module  | Global mail module              |
 | `MailService`               | Service        | Send emails (plain + templated) |
-| `MailVerificationService`   | Service        | Email verification              |
+| `SmtpConnectionVerifier`    | Service        | SMTP connectivity verification  |
+| `MailVerificationService`   | Service        | ~~Email verification~~ (deprecated — use `SmtpConnectionVerifier`) |
 | `MailTemplateEngine`        | Service        | Template variable substitution  |
 | `DeliveryStrategyBase`      | Abstract class | Base for delivery strategies    |
 | `SmtpDeliveryStrategy`      | Strategy       | SMTP transport (built-in)       |
@@ -399,7 +455,7 @@ try {
 | `MailgunDeliveryStrategy`   | Strategy       | Mailgun API                     |
 | `FileTemplateFetchStrategy` | Strategy       | File-based templates            |
 | `BlobTemplateFetchStrategy` | Strategy       | Blob-stored templates           |
-| `MailHealthIndicator`       | Health         | Mail readiness check            |
+| `MailHealthIndicator`       | Health         | Mail readiness check (`/health` subpath) |
 | `MailDeliveryError`         | Error class    | Domain error for delivery failures |
 
 ### Provider subpaths

package/data/packages/platform-mapping/api/Class.MappingBuilder.md

@@ -0,0 +1,110 @@
+---
+title: 'Class: MappingBuilder'
+generated: true
+editUrl: false
+---
+# Class: MappingBuilder
+
+Defined in: [builder/MappingBuilder.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/builder/MappingBuilder.ts#L15)
+
+A mapping builder that uses the mapping service to register maps.
+
+## Implements
+
+- [`IMappingBuilder`](Interface.IMappingBuilder)
+
+## Constructors
+
+### Constructor
+
+```ts
+new MappingBuilder(service): MappingBuilder;
+```
+
+Defined in: [builder/MappingBuilder.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/builder/MappingBuilder.ts#L29)
+
+Constructs a new instance of the `MappingBuilder` class.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `service` | [`MappingService`](Class.MappingService) |
+
+#### Returns
+
+`MappingBuilder`
+
+## Methods
+
+### createKeyedMap()
+
+```ts
+createKeyedMap<TInput, TOutput>(key, fn): this;
+```
+
+Defined in: [builder/MappingBuilder.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/builder/MappingBuilder.ts#L64)
+
+Creates a keyed mapping between two types with full type safety.
+The mapping key encodes both input and output types at compile time.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TInput` |
+| `TOutput` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | [`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\> | The type-safe mapping key. |
+| `fn` | (`source`) => `TOutput` | The mapping function. |
+
+#### Returns
+
+`this`
+
+#### Implementation of
+
+[`IMappingBuilder`](Interface.IMappingBuilder).[`createKeyedMap`](Interface.IMappingBuilder#createkeyedmap)
+
+***
+
+### createMap()
+
+```ts
+createMap<TSource, TDestination>(
+   source, 
+   destination, 
+   fn): this;
+```
+
+Defined in: [builder/MappingBuilder.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/builder/MappingBuilder.ts#L46)
+
+Creates a mapping between two types.
+Enforces compile-time type compatibility check.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TSource` |
+| `TDestination` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `source` | [`Constructor`](TypeAlias.Constructor)\<`TSource`\> | The source type. |
+| `destination` | [`Constructor`](TypeAlias.Constructor)\<`TDestination`\> | The destination type. |
+| `fn` | (`source`) => `TDestination` | The mapping function. |
+
+#### Returns
+
+`this`
+
+#### Implementation of
+
+[`IMappingBuilder`](Interface.IMappingBuilder).[`createMap`](Interface.IMappingBuilder#createmap)

package/data/packages/platform-mapping/api/Class.MappingError.md

@@ -0,0 +1,56 @@
+---
+title: 'Abstract Class: MappingError'
+generated: true
+editUrl: false
+---
+# Abstract Class: MappingError
+
+Defined in: [errors/MappingError.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/errors/MappingError.ts#L7)
+
+Base class for mapping related domain errors.
+
+## Extends
+
+- `Error`
+
+## Extended by
+
+- [`MappingNotRegisteredError`](Class.MappingNotRegisteredError)
+- [`TypeMappingNotRegisteredError`](Class.TypeMappingNotRegisteredError)
+
+## Constructors
+
+### Constructor
+
+```ts
+protected new MappingError(message, code): MappingError;
+```
+
+Defined in: [errors/MappingError.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/errors/MappingError.ts#L16)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+| `code` | `string` |
+
+#### Returns
+
+`MappingError`
+
+#### Overrides
+
+```ts
+Error.constructor
+```
+
+## Properties
+
+### code
+
+```ts
+readonly code: string;
+```
+
+Defined in: [errors/MappingError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/errors/MappingError.ts#L10)

package/data/packages/platform-mapping/api/Class.MappingModule.md

@@ -0,0 +1,46 @@
+---
+title: 'Class: MappingModule'
+generated: true
+editUrl: false
+---
+# Class: MappingModule
+
+Defined in: [MappingModule.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingModule.ts#L19)
+
+Module that provides mapping services and allows registration of mapping profiles.
+
+## Constructors
+
+### Constructor
+
+```ts
+new MappingModule(): MappingModule;
+```
+
+#### Returns
+
+`MappingModule`
+
+## Methods
+
+### withProfiles()
+
+```ts
+static withProfiles(profiles): DynamicModule;
+```
+
+Defined in: [MappingModule.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingModule.ts#L27)
+
+Configures the module with the given mapping profiles.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `profiles` | `Type`\<[`IMappingProfile`](Interface.IMappingProfile)\>[] | An array of mapping profile types to register. |
+
+#### Returns
+
+`DynamicModule`
+
+A dynamic module with the specified profiles registered.

package/data/packages/platform-mapping/api/Class.MappingNotRegisteredError.md

@@ -0,0 +1,52 @@
+---
+title: 'Class: MappingNotRegisteredError'
+generated: true
+editUrl: false
+---
+# Class: MappingNotRegisteredError
+
+Defined in: [errors/MappingNotRegisteredError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/errors/MappingNotRegisteredError.ts#L12)
+
+Thrown when a keyed mapping is requested but not registered.
+
+## Extends
+
+- [`MappingError`](Class.MappingError)
+
+## Constructors
+
+### Constructor
+
+```ts
+new MappingNotRegisteredError(key): MappingNotRegisteredError;
+```
+
+Defined in: [errors/MappingNotRegisteredError.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/errors/MappingNotRegisteredError.ts#L15)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+`MappingNotRegisteredError`
+
+#### Overrides
+
+[`MappingError`](Class.MappingError).[`constructor`](Class.MappingError#constructor)
+
+## Properties
+
+### code
+
+```ts
+readonly code: string;
+```
+
+Defined in: [errors/MappingError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/errors/MappingError.ts#L10)
+
+#### Inherited from
+
+[`MappingError`](Class.MappingError).[`code`](Class.MappingError#code)

package/data/packages/platform-mapping/api/Class.MappingProfileBase.md

@@ -0,0 +1,52 @@
+---
+title: 'Abstract Class: MappingProfileBase'
+generated: true
+editUrl: false
+---
+# Abstract Class: MappingProfileBase
+
+Defined in: [profile/MappingProfileBase.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/profile/MappingProfileBase.ts#L13)
+
+Base class for mapping profiles to simplify implementation.
+
+## Implements
+
+- [`IMappingProfile`](Interface.IMappingProfile)
+
+## Constructors
+
+### Constructor
+
+```ts
+new MappingProfileBase(): MappingProfileBase;
+```
+
+#### Returns
+
+`MappingProfileBase`
+
+## Methods
+
+### configure()
+
+```ts
+abstract configure(builder): void;
+```
+
+Defined in: [profile/MappingProfileBase.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/profile/MappingProfileBase.ts#L23)
+
+Configures the mapping profile.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `builder` | [`IMappingBuilder`](Interface.IMappingBuilder) | The mapping builder. |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`IMappingProfile`](Interface.IMappingProfile).[`configure`](Interface.IMappingProfile#configure)