@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,82 @@
+---
+title: 'Class: PostmarkDeliveryStrategy'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# 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)
+
+The `PostmarkDeliveryStrategy` class.
+
+## Extends
+
+- [`DeliveryStrategyBase`](Class.DeliveryStrategyBase)
+
+## Constructors
+
+### Constructor
+
+```ts
+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)
+
+Constructs a new instance of the `PostmarkDeliveryStrategy` class.
+
+#### Parameters
+
+| Parameter       | Type            |
+| --------------- | --------------- |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`PostmarkDeliveryStrategy`
+
+#### Overrides
+
+```ts
+DeliveryStrategyBase.constructor;
+```
+
+## Methods
+
+### send()
+
+```ts
+send(
+   from,
+   to,
+   subject,
+   content,
+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)
+
+Sends an email using the Postmark 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)

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

@@ -0,0 +1,82 @@
+---
+title: 'Class: ResendDeliveryStrategy'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# 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)
+
+Delivers emails via the Resend API.
+
+## Extends
+
+- [`DeliveryStrategyBase`](Class.DeliveryStrategyBase)
+
+## Constructors
+
+### Constructor
+
+```ts
+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)
+
+Constructs a new instance of the `ResendDeliveryStrategy` class.
+
+#### Parameters
+
+| Parameter       | Type            |
+| --------------- | --------------- |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`ResendDeliveryStrategy`
+
+#### Overrides
+
+```ts
+DeliveryStrategyBase.constructor;
+```
+
+## Methods
+
+### send()
+
+```ts
+send(
+   from,
+   to,
+   subject,
+   content,
+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)
+
+Sends an email using the Resend 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)

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

@@ -0,0 +1,82 @@
+---
+title: 'Class: SendGridDeliveryStrategy'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# 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)
+
+Delivers emails via the SendGrid API.
+
+## Extends
+
+- [`DeliveryStrategyBase`](Class.DeliveryStrategyBase)
+
+## Constructors
+
+### Constructor
+
+```ts
+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)
+
+Constructs a new instance of the `SendGridDeliveryStrategy` class.
+
+#### Parameters
+
+| Parameter       | Type            |
+| --------------- | --------------- |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`SendGridDeliveryStrategy`
+
+#### Overrides
+
+```ts
+DeliveryStrategyBase.constructor;
+```
+
+## Methods
+
+### send()
+
+```ts
+send(
+   from,
+   to,
+   subject,
+   content,
+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)
+
+Sends an email using the SendGrid 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)

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

@@ -0,0 +1,82 @@
+---
+title: 'Class: SmtpDeliveryStrategy'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# 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)
+
+The `SmtpDeliveryStrategy` class.
+
+## Extends
+
+- [`DeliveryStrategyBase`](Class.DeliveryStrategyBase)
+
+## Constructors
+
+### Constructor
+
+```ts
+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)
+
+Constructs a new instance of the `LogDelivery` class.
+
+#### Parameters
+
+| Parameter       | Type            |
+| --------------- | --------------- |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`SmtpDeliveryStrategy`
+
+#### Overrides
+
+```ts
+DeliveryStrategyBase.constructor;
+```
+
+## Methods
+
+### send()
+
+```ts
+send(
+   from,
+   to,
+   subject,
+   content,
+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)
+
+Sends an email using the SMTP 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)

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

@@ -0,0 +1,42 @@
+---
+title: 'Abstract Class: TemplateFetchStrategyBase'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# Abstract Class: TemplateFetchStrategyBase
+
+Defined in: [platform-mailing/src/templating/strategies/abstracts/TemplateFetchStrategyBase.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/strategies/abstracts/TemplateFetchStrategyBase.ts#L7)
+
+Represents the base class for template fetch strategies.
+
+## Extended by
+
+- [`BlobTemplateFetchStrategy`](Class.BlobTemplateFetchStrategy)
+- [`FileTemplateFetchStrategy`](Class.FileTemplateFetchStrategy)
+
+## Methods
+
+### load()
+
+```ts
+abstract load(): Promise<Record<string, {
+  html?: string;
+  txt?: string;
+}>>;
+```
+
+Defined in: [platform-mailing/src/templating/strategies/abstracts/TemplateFetchStrategyBase.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/strategies/abstracts/TemplateFetchStrategyBase.ts#L30)
+
+Loads the templates.
+
+#### Returns
+
+`Promise`\<`Record`\<`string`, \{
+`html?`: `string`;
+`txt?`: `string`;
+\}\>\>

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

@@ -0,0 +1,71 @@
+---
+title: 'Interface: IMailEvents'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# Interface: IMailEvents
+
+Defined in: [platform-mailing/src/events/IMailEvents.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/events/IMailEvents.ts#L12)
+
+Represents the contract of events emitted by the mail domain.
+
+## Extends
+
+- `IEventMap`
+
+## Indexable
+
+```ts
+[eventName: string]: unknown
+```
+
+## Properties
+
+### sendMail
+
+```ts
+sendMail: {
+  recipientEmail: string;
+  senderEmail?: string;
+  subject: string;
+  templateName: string;
+  templateParams: Record<string, string | number | boolean | Date | undefined | null>;
+};
+```
+
+Defined in: [platform-mailing/src/events/IMailEvents.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/events/IMailEvents.ts#L13)
+
+#### recipientEmail
+
+```ts
+recipientEmail: string;
+```
+
+#### senderEmail?
+
+```ts
+optional senderEmail?: string;
+```
+
+#### subject
+
+```ts
+subject: string;
+```
+
+#### templateName
+
+```ts
+templateName: string;
+```
+
+#### templateParams
+
+```ts
+templateParams: Record<string, string | number | boolean | Date | undefined | null>;
+```

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

@@ -0,0 +1,35 @@
+---
+title: 'Interface: IMailTemplateVariants'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# Interface: IMailTemplateVariants
+
+Defined in: [platform-mailing/src/MailTokens.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L21)
+
+Represents the in-memory structure for a single template (multiple formats).
+
+## Properties
+
+### html?
+
+```ts
+optional html?: string;
+```
+
+Defined in: [platform-mailing/src/MailTokens.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L22)
+
+---
+
+### txt?
+
+```ts
+optional txt?: string;
+```
+
+Defined in: [platform-mailing/src/MailTokens.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L23)

package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md

@@ -0,0 +1,19 @@
+---
+title: 'Type Alias: MailTemplateFormat'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# Type Alias: MailTemplateFormat
+
+```ts
+type MailTemplateFormat = 'html' | 'txt';
+```
+
+Defined in: [platform-mailing/src/MailTokens.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L16)
+
+Union type of all supported template formats.