@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,55 @@
+---
+title: 'Abstract Class: DeliveryStrategyBase'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# Abstract Class: DeliveryStrategyBase
+
+Defined in: [platform-mailing/src/services/strategies/abstracts/DeliveryStrategyBase.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/abstracts/DeliveryStrategyBase.ts#L7)
+
+Represents the base class for all email delivery strategies.
+
+## Extended by
+
+- [`LogDeliveryStrategy`](Class.LogDeliveryStrategy)
+- [`MailgunDeliveryStrategy`](Class.MailgunDeliveryStrategy)
+- [`ResendDeliveryStrategy`](Class.ResendDeliveryStrategy)
+- [`SendGridDeliveryStrategy`](Class.SendGridDeliveryStrategy)
+- [`SmtpDeliveryStrategy`](Class.SmtpDeliveryStrategy)
+- [`PostmarkDeliveryStrategy`](Class.PostmarkDeliveryStrategy)
+
+## Methods
+
+### send()
+
+```ts
+abstract send(
+   from,
+   to,
+   subject,
+   content,
+isHtml): Promise<void>;
+```
+
+Defined in: [platform-mailing/src/services/strategies/abstracts/DeliveryStrategyBase.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/abstracts/DeliveryStrategyBase.ts#L35)
+
+Sends an email with either plain text or HTML content.
+
+#### Parameters
+
+| Parameter | Type      | Description                                                             |
+| --------- | --------- | ----------------------------------------------------------------------- |
+| `from`    | `string`  | Sender's email address (optional, defaults to config)                   |
+| `to`      | `string`  | Recipient's email address                                               |
+| `subject` | `string`  | Subject of the email                                                    |
+| `content` | `string`  | Email body content (plain text or HTML)                                 |
+| `isHtml`  | `boolean` | Flag to indicate whether the email is HTML (true) or plain text (false) |
+
+#### Returns
+
+`Promise`\<`void`\>

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

@@ -0,0 +1,65 @@
+---
+title: 'Class: FileTemplateFetchStrategy'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# Class: FileTemplateFetchStrategy
+
+Defined in: [platform-mailing/src/templating/strategies/FileTemplateFetchStrategy.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/strategies/FileTemplateFetchStrategy.ts#L16)
+
+The `FileTemplateFetchStrategy` class.
+
+## Extends
+
+- [`TemplateFetchStrategyBase`](Class.TemplateFetchStrategyBase)
+
+## Constructors
+
+### Constructor
+
+```ts
+new FileTemplateFetchStrategy(resourceManager): FileTemplateFetchStrategy;
+```
+
+Defined in: [platform-mailing/src/templating/strategies/FileTemplateFetchStrategy.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/strategies/FileTemplateFetchStrategy.ts#L26)
+
+#### Parameters
+
+| Parameter         | Type              |
+| ----------------- | ----------------- |
+| `resourceManager` | `ResourceManager` |
+
+#### Returns
+
+`FileTemplateFetchStrategy`
+
+#### Overrides
+
+```ts
+TemplateFetchStrategyBase.constructor;
+```
+
+## Methods
+
+### load()
+
+```ts
+load(): Promise<Record<string, IMailTemplateVariants>>;
+```
+
+Defined in: [platform-mailing/src/templating/strategies/FileTemplateFetchStrategy.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/strategies/FileTemplateFetchStrategy.ts#L40)
+
+Loads mail templates from the file system.
+
+#### Returns
+
+`Promise`\<`Record`\<`string`, [`IMailTemplateVariants`](Interface.IMailTemplateVariants)\>\>
+
+#### Overrides
+
+[`TemplateFetchStrategyBase`](Class.TemplateFetchStrategyBase).[`load`](Class.TemplateFetchStrategyBase#load)

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

@@ -0,0 +1,82 @@
+---
+title: 'Class: LogDeliveryStrategy'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# Class: LogDeliveryStrategy
+
+Defined in: [platform-mailing/src/services/strategies/LogDeliveryStrategy.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/LogDeliveryStrategy.ts#L14)
+
+The `LogDeliveryStrategy` class.
+
+## Extends
+
+- [`DeliveryStrategyBase`](Class.DeliveryStrategyBase)
+
+## Constructors
+
+### Constructor
+
+```ts
+new LogDeliveryStrategy(configService): LogDeliveryStrategy;
+```
+
+Defined in: [platform-mailing/src/services/strategies/LogDeliveryStrategy.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/LogDeliveryStrategy.ts#L29)
+
+Constructs a new instance of the `LogDelivery` class.
+
+#### Parameters
+
+| Parameter       | Type            |
+| --------------- | --------------- |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`LogDeliveryStrategy`
+
+#### Overrides
+
+```ts
+DeliveryStrategyBase.constructor;
+```
+
+## Methods
+
+### send()
+
+```ts
+abstract send(
+   from,
+   to,
+   subject,
+   content,
+isHtml): Promise<void>;
+```
+
+Defined in: [platform-mailing/src/services/strategies/LogDeliveryStrategy.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/services/strategies/LogDeliveryStrategy.ts#L37)
+
+Sends an email with either plain text or HTML content.
+
+#### Parameters
+
+| Parameter | Type      | Description                                                             |
+| --------- | --------- | ----------------------------------------------------------------------- |
+| `from`    | `string`  | Sender's email address (optional, defaults to config)                   |
+| `to`      | `string`  | Recipient's email address                                               |
+| `subject` | `string`  | Subject of the email                                                    |
+| `content` | `string`  | Email body content (plain text or HTML)                                 |
+| `isHtml`  | `boolean` | Flag to indicate whether the email is HTML (true) or plain text (false) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Overrides
+
+[`DeliveryStrategyBase`](Class.DeliveryStrategyBase).[`send`](Class.DeliveryStrategyBase#send)

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

@@ -0,0 +1,83 @@
+---
+title: 'Class: MailHealthIndicator'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# Class: MailHealthIndicator
+
+Defined in: [platform-mailing/src/terminus/MailHealthIndicator.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/terminus/MailHealthIndicator.ts#L16)
+
+Health indicator for mail service.
+
+## Implements
+
+- `IHealthIndicator`
+
+## Constructors
+
+### Constructor
+
+```ts
+new MailHealthIndicator(configService): MailHealthIndicator;
+```
+
+Defined in: [platform-mailing/src/terminus/MailHealthIndicator.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/terminus/MailHealthIndicator.ts#L30)
+
+Constructs a new instance of the `MailHealthIndicator` class.
+
+#### Parameters
+
+| Parameter       | Type            |
+| --------------- | --------------- |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`MailHealthIndicator`
+
+## Properties
+
+### key
+
+```ts
+readonly key: "mail" = 'mail';
+```
+
+Defined in: [platform-mailing/src/terminus/MailHealthIndicator.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/terminus/MailHealthIndicator.ts#L38)
+
+Unique key identifying the indicator
+
+#### Implementation of
+
+```ts
+IHealthIndicator.key;
+```
+
+## Methods
+
+### check()
+
+```ts
+check(): HealthIndicatorResult<"mail">;
+```
+
+Defined in: [platform-mailing/src/terminus/MailHealthIndicator.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/terminus/MailHealthIndicator.ts#L50)
+
+Checks if the mail configuration is valid.
+
+#### Returns
+
+`HealthIndicatorResult`\<`"mail"`\>
+
+The health indicator result.
+
+#### Implementation of
+
+```ts
+IHealthIndicator.check;
+```

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

@@ -0,0 +1,27 @@
+---
+title: 'Class: MailModule'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# Class: MailModule
+
+Defined in: [platform-mailing/src/MailModule.ts:113](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailModule.ts#L113)
+
+Represents the mail module.
+
+## Constructors
+
+### Constructor
+
+```ts
+new MailModule(): MailModule;
+```
+
+#### Returns
+
+`MailModule`

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

@@ -0,0 +1,101 @@
+---
+title: 'Class: MailService'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# 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)
+
+Represents the `MailService` class.
+
+## Constructors
+
+### Constructor
+
+```ts
+new MailService(
+   configService,
+   mailTemplateEngine,
+   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)
+
+Constructs a new instance of the `MailService` class.
+
+#### Parameters
+
+| Parameter            | Type                                                 |
+| -------------------- | ---------------------------------------------------- |
+| `configService`      | `ConfigService`                                      |
+| `mailTemplateEngine` | [`MailTemplateEngine`](Class.MailTemplateEngine)     |
+| `deliveryStrategy`   | [`DeliveryStrategyBase`](Class.DeliveryStrategyBase) |
+
+#### Returns
+
+`MailService`
+
+## Methods
+
+### send()
+
+```ts
+send(
+   mailOptions,
+   content,
+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)
+
+Sends an email with either plain text or HTML content.
+
+#### Parameters
+
+| Parameter             | Type                                                          | Description                                                             |
+| --------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------- |
+| `mailOptions`         | \{ `from?`: `string`; `subject`: `string`; `to`: `string`; \} | -                                                                       |
+| `mailOptions.from?`   | `string`                                                      | Sender's email address (optional, defaults to config)                   |
+| `mailOptions.subject` | `string`                                                      | Subject of the email                                                    |
+| `mailOptions.to`      | `string`                                                      | Recipient's email address                                               |
+| `content`             | `string`                                                      | Email body content (plain text or HTML)                                 |
+| `isHtml`              | `boolean`                                                     | Flag to indicate whether the email is HTML (true) or plain text (false) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+---
+
+### sendTemplate()
+
+```ts
+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)
+
+Sends an email using a predefined template (HTML or text).
+Automatically uses the template format (either 'html' or 'txt') based on the environment variable.
+
+#### Parameters
+
+| Parameter                        | Type                                                                                                                                          | Description                                           |
+| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
+| `mailOptions`                    | \{ `from?`: `string`; `subject`: `string`; `to`: `string`; \}                                                                                 | -                                                     |
+| `mailOptions.from?`              | `string`                                                                                                                                      | Sender's email address (optional, defaults to config) |
+| `mailOptions.subject`            | `string`                                                                                                                                      | Subject of the email                                  |
+| `mailOptions.to`                 | `string`                                                                                                                                      | Recipient's email address                             |
+| `templateOptions`                | \{ `templateName`: `string`; `templateParams`: `Record`\<`string`, `string` \| `number` \| `boolean` \| `Date` \| `undefined` \| `null`\>; \} | -                                                     |
+| `templateOptions.templateName`   | `string`                                                                                                                                      | Name of the template to be used                       |
+| `templateOptions.templateParams` | `Record`\<`string`, `string` \| `number` \| `boolean` \| `Date` \| `undefined` \| `null`\>                                                    | -                                                     |
+
+#### Returns
+
+`Promise`\<`void`\>

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

@@ -0,0 +1,98 @@
+---
+title: 'Class: MailTemplateEngine'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# Class: MailTemplateEngine
+
+Defined in: [platform-mailing/src/templating/MailTemplateEngine.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/MailTemplateEngine.ts#L16)
+
+The `MailTemplateEngine` class.
+
+## Implements
+
+- `OnModuleInit`
+
+## Constructors
+
+### Constructor
+
+```ts
+new MailTemplateEngine(templateFetchStrategy, contentTemplateEngine): MailTemplateEngine;
+```
+
+Defined in: [platform-mailing/src/templating/MailTemplateEngine.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/MailTemplateEngine.ts#L32)
+
+Constructs a new instance of the `MailTemplateEngine` class.
+
+#### Parameters
+
+| Parameter               | Type                                                           |
+| ----------------------- | -------------------------------------------------------------- |
+| `templateFetchStrategy` | [`TemplateFetchStrategyBase`](Class.TemplateFetchStrategyBase) |
+| `contentTemplateEngine` | `ContentTemplateEngine`                                        |
+
+#### Returns
+
+`MailTemplateEngine`
+
+## Methods
+
+### compileTemplate()
+
+```ts
+compileTemplate(
+   templateKey,
+   params,
+   format): string;
+```
+
+Defined in: [platform-mailing/src/templating/MailTemplateEngine.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/MailTemplateEngine.ts#L65)
+
+Compiles a template by replacing placeholders with the provided parameters.
+
+#### Parameters
+
+| Parameter     | Type                                                 | Description                                   |
+| ------------- | ---------------------------------------------------- | --------------------------------------------- |
+| `templateKey` | `string`                                             | The key of the template to compile.           |
+| `params`      | `Record`\<`string`, `unknown`\>                      | The parameters to insert into the template.   |
+| `format`      | [`MailTemplateFormat`](TypeAlias.MailTemplateFormat) | The format of the template ('html' or 'txt'). |
+
+#### Returns
+
+`string`
+
+The compiled template as a string.
+
+#### Throws
+
+Error if the template or format is not found.
+
+---
+
+### onModuleInit()
+
+```ts
+onModuleInit(): Promise<void>;
+```
+
+Defined in: [platform-mailing/src/templating/MailTemplateEngine.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/MailTemplateEngine.ts#L51)
+
+Lifecycle hook that runs after the module initialization.
+Loads all templates from the disk and caches them in memory.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+```ts
+OnModuleInit.onModuleInit;
+```

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

@@ -0,0 +1,90 @@
+---
+title: 'Class: MailVerificationService'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# 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)
+
+Represents the `MailVerificationService` class.
+
+## Constructors
+
+### Constructor
+
+```ts
+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)
+
+Constructs a new instance of the `MailVerificationService` class.
+
+#### Parameters
+
+| Parameter       | Type            |
+| --------------- | --------------- |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`MailVerificationService`
+
+## Methods
+
+### sendTestEmail()
+
+```ts
+sendTestEmail(
+   from,
+   to,
+   subject,
+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)
+
+Send an email for testing purposes or verification
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `from`    | `string` |
+| `to`      | `string` |
+| `subject` | `string` |
+| `text`    | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+---
+
+### verifyEmail()
+
+```ts
+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)
+
+Verifies if the email address is valid and reachable.
+
+#### Parameters
+
+| Parameter | Type     | Description                 |
+| --------- | -------- | --------------------------- |
+| `email`   | `string` | The email address to verify |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Promise\<boolean\> - Resolves true if email exists, false otherwise

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

@@ -0,0 +1,82 @@
+---
+title: 'Class: MailgunDeliveryStrategy'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# 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)
+
+Delivers emails via the Mailgun API.
+
+## Extends
+
+- [`DeliveryStrategyBase`](Class.DeliveryStrategyBase)
+
+## Constructors
+
+### Constructor
+
+```ts
+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)
+
+Constructs a new instance of the `MailgunDeliveryStrategy` class.
+
+#### Parameters
+
+| Parameter       | Type            |
+| --------------- | --------------- |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`MailgunDeliveryStrategy`
+
+#### Overrides
+
+```ts
+DeliveryStrategyBase.constructor;
+```
+
+## Methods
+
+### send()
+
+```ts
+send(
+   from,
+   to,
+   subject,
+   content,
+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)
+
+Sends an email using the Mailgun transport.
+
+#### Parameters
+
+| Parameter | Type      | Description                                                             |
+| --------- | --------- | ----------------------------------------------------------------------- |
+| `from`    | `string`  | Sender's email address                                                  |
+| `to`      | `string`  | Recipient's email address                                               |
+| `subject` | `string`  | Subject of the email                                                    |
+| `content` | `string`  | Email body content (plain text or HTML)                                 |
+| `isHtml`  | `boolean` | Flag to indicate whether the email is HTML (true) or plain text (false) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Overrides
+
+[`DeliveryStrategyBase`](Class.DeliveryStrategyBase).[`send`](Class.DeliveryStrategyBase#send)