@breadstone/archipel-mcp 0.0.22 → 0.0.25

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)

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

@@ -0,0 +1,284 @@
+---
+title: 'Class: MappingService'
+generated: true
+editUrl: false
+---
+# Class: MappingService
+
+Defined in: [MappingService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L19)
+
+Central mapping registry supporting keyed & type-based mappings.
+
+## Constructors
+
+### Constructor
+
+```ts
+new MappingService(): MappingService;
+```
+
+Defined in: [MappingService.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L36)
+
+Constructs a new instance of the `MappingService` class.
+
+#### Returns
+
+`MappingService`
+
+## Methods
+
+### map()
+
+```ts
+map<TInput, TOutput>(key, source): TOutput;
+```
+
+Defined in: [MappingService.ts:99](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L99)
+
+Maps a source object to a destination type using a type-safe mapping key.
+The key encodes both input and output types, ensuring compile-time type safety.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TInput` |
+| `TOutput` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | [`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\> | The type-safe mapping key. |
+| `source` | `TInput` | The source object to map. |
+
+#### Returns
+
+`TOutput`
+
+The mapped destination object.
+
+#### Example
+
+```typescript
+const response = this._mappingService.map(PRODUCT_MAPPING_KEY, productInput);
+// response is automatically typed as ProductResponse
+```
+
+***
+
+### mapTypes()
+
+```ts
+mapTypes<TSource, TDestination>(source, destination): TDestination;
+```
+
+Defined in: [MappingService.ts:129](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L129)
+
+Maps a source object to a destination type using a registered mapping function.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TSource` |
+| `TDestination` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `source` | `TSource` | The source object to map. |
+| `destination` | [`Constructor`](TypeAlias.Constructor)\<`TDestination`\> | The constructor of the destination type. |
+
+#### Returns
+
+`TDestination`
+
+The mapped destination object.
+
+***
+
+### mapTypesArray()
+
+```ts
+mapTypesArray<TSource, TDestination>(sources, destination): TDestination[];
+```
+
+Defined in: [MappingService.ts:161](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L161)
+
+Maps an array of source objects to an array of destination types using a registered mapping function.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TSource` |
+| `TDestination` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `sources` | `TSource`[] | The array of source objects to map. |
+| `destination` | [`Constructor`](TypeAlias.Constructor)\<`TDestination`\> | The constructor of the destination type. |
+
+#### Returns
+
+`TDestination`[]
+
+The array of mapped destination objects.
+
+***
+
+### register()
+
+```ts
+register<TSource, TDestination>(key, fn): void;
+```
+
+Defined in: [MappingService.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L54)
+
+Registers a mapping function for a specific key.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TSource` |
+| `TDestination` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The unique key for the mapping. |
+| `fn` | (`source`) => `TDestination` | The mapping function. |
+
+#### Returns
+
+`void`
+
+void
+
+***
+
+### registerMap()
+
+```ts
+registerMap<TSource, TDestination>(
+   source, 
+   destination, 
+   fn): void;
+```
+
+Defined in: [MappingService.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L71)
+
+Registers a mapping function for a specific source and destination type.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TSource` |
+| `TDestination` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `source` | [`Constructor`](TypeAlias.Constructor)\<`TSource`\> | The constructor of the source type. |
+| `destination` | [`Constructor`](TypeAlias.Constructor)\<`TDestination`\> | The constructor of the destination type. |
+| `fn` | (`source`) => `TDestination` | The mapping function. |
+
+#### Returns
+
+`void`
+
+void
+
+***
+
+### registerProfile()
+
+```ts
+registerProfile(profile): void;
+```
+
+Defined in: [MappingService.ts:175](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L175)
+
+Registers a mapping profile containing multiple mappings.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `profile` | [`IMappingProfile`](Interface.IMappingProfile) | The mapping profile to register. |
+
+#### Returns
+
+`void`
+
+void
+
+***
+
+### tryMap()
+
+```ts
+tryMap<TInput, TOutput>(key, source): TOutput | undefined;
+```
+
+Defined in: [MappingService.ts:115](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L115)
+
+Attempts to map returning undefined instead of throwing when mapping is absent.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TInput` |
+| `TOutput` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | [`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\> | The type-safe mapping key. |
+| `source` | `TInput` | The source object to map. |
+
+#### Returns
+
+`TOutput` \| `undefined`
+
+The mapped destination object or undefined if no mapping exists.
+
+***
+
+### tryMapTypes()
+
+```ts
+tryMapTypes<TSource, TDestination>(source, destination): TDestination | undefined;
+```
+
+Defined in: [MappingService.ts:142](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L142)
+
+Safe variant of [mapTypes](#maptypes) that returns undefined if not registered.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TSource` |
+| `TDestination` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `source` | `TSource` |
+| `destination` | [`Constructor`](TypeAlias.Constructor)\<`TDestination`\> |
+
+#### Returns
+
+`TDestination` \| `undefined`