@breadstone/archipel-mcp 0.0.15 → 0.0.16

package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAIL\_HOST'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_HOST
+
+```ts
+const MAIL_HOST: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L78)
+
+Mail host checked by the health indicator.

package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAIL\_MAILGUN\_API\_KEY'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_MAILGUN\_API\_KEY
+
+```ts
+const MAIL_MAILGUN_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L49)
+
+API key for the Mailgun delivery service.

package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAIL\_MAILGUN\_DOMAIN'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_MAILGUN\_DOMAIN
+
+```ts
+const MAIL_MAILGUN_DOMAIN: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L52)
+
+Mailgun domain (e.g. `mg.example.com`).

package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAIL\_PORT'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_PORT
+
+```ts
+const MAIL_PORT: IConfigKey<number>;
+```
+
+Defined in: [platform-mailing/src/env.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L84)
+
+Mail port checked by the health indicator.

package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAIL\_POSTMARK\_API\_KEY'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_POSTMARK\_API\_KEY
+
+```ts
+const MAIL_POSTMARK_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L28)
+
+API key for the Postmark delivery service.

package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAIL\_RESEND\_API\_KEY'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_RESEND\_API\_KEY
+
+```ts
+const MAIL_RESEND_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L35)
+
+API key for the Resend delivery service.

package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAIL\_SENDER\_EMAIL'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_SENDER\_EMAIL
+
+```ts
+const MAIL_SENDER_EMAIL: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L18)
+
+Sender e-mail address shown in the `From` header.

package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAIL\_SENDGRID\_API\_KEY'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_SENDGRID\_API\_KEY
+
+```ts
+const MAIL_SENDGRID_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L42)
+
+API key for the SendGrid delivery service.

package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAIL\_SMTP\_HOST'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_SMTP\_HOST
+
+```ts
+const MAIL_SMTP_HOST: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L59)
+
+SMTP server host.

package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAIL\_SMTP\_PASSWORD'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_SMTP\_PASSWORD
+
+```ts
+const MAIL_SMTP_PASSWORD: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L71)
+
+SMTP authentication password.

package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAIL\_SMTP\_PORT'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_SMTP\_PORT
+
+```ts
+const MAIL_SMTP_PORT: IConfigKey<number>;
+```
+
+Defined in: [platform-mailing/src/env.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L62)
+
+SMTP server port.

package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAIL\_SMTP\_SECURE'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_SMTP\_SECURE
+
+```ts
+const MAIL_SMTP_SECURE: IConfigKey<boolean>;
+```
+
+Defined in: [platform-mailing/src/env.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L65)
+
+Whether the SMTP connection uses TLS.

package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAIL\_SMTP\_USER'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_SMTP\_USER
+
+```ts
+const MAIL_SMTP_USER: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L68)
+
+SMTP authentication username.

package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAIL\_TEMPLATE\_ENGINE\_FORMAT'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_TEMPLATE\_ENGINE\_FORMAT
+
+```ts
+const MAIL_TEMPLATE_ENGINE_FORMAT: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L21)
+
+Template engine format identifier (e.g. `handlebars`).

package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md

@@ -0,0 +1,16 @@
+---
+title: 'Variable: MAIL\_TEMPLATE\_FETCH\_STRATEGY\_TOKEN'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_TEMPLATE\_FETCH\_STRATEGY\_TOKEN
+
+```ts
+const MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN: typeof MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN;
+```
+
+Defined in: [platform-mailing/src/MailTokens.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L9)
+
+Central definition of injection tokens used by the mail module.
+Using constants instead of raw string literals prevents accidental typos
+and enables refactors with compile time safety.

package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAIL\_TEMPLATE\_STRATEGY'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_TEMPLATE\_STRATEGY
+
+```ts
+const MAIL_TEMPLATE_STRATEGY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L12)
+
+Which template-fetch strategy to use (e.g. `file`, `blob`).

package/data/packages/platform-mailing/api/Variable.MAIL_USER.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAIL\_USER'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_USER
+
+```ts
+const MAIL_USER: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/env.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L81)
+
+Mail user checked by the health indicator.

package/data/packages/platform-mailing/api/Variable.MAX_ATTACHMENT_SIZE_BYTES.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: MAX\_ATTACHMENT\_SIZE\_BYTES'
+generated: true
+editUrl: false
+---
+# Variable: MAX\_ATTACHMENT\_SIZE\_BYTES
+
+```ts
+const MAX_ATTACHMENT_SIZE_BYTES: number;
+```
+
+Defined in: [platform-mailing/src/models/IMailAttachment.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailAttachment.ts#L26)
+
+Maximum attachment size in bytes (25 MB).

package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: PLATFORM\_MAILING\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: PLATFORM\_MAILING\_CONFIG\_ENTRIES
+
+```ts
+const PLATFORM_MAILING_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: [platform-mailing/src/env.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L91)
+
+All configuration entries required by `platform-mailing`.

package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: POSTMARK\_API\_KEY'
+generated: true
+editUrl: false
+---
+# Variable: POSTMARK\_API\_KEY
+
+```ts
+const POSTMARK_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/postmark/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/postmark/env.ts#L12)
+
+API key for the Postmark delivery service.

package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: POSTMARK\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: POSTMARK\_CONFIG\_ENTRIES
+
+```ts
+const POSTMARK_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: [platform-mailing/src/postmark/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/postmark/env.ts#L19)
+
+Configuration entries required by the Postmark delivery provider.

package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: RESEND\_API\_KEY'
+generated: true
+editUrl: false
+---
+# Variable: RESEND\_API\_KEY
+
+```ts
+const RESEND_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/resend/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/resend/env.ts#L12)
+
+API key for the Resend delivery service.

package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: RESEND\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: RESEND\_CONFIG\_ENTRIES
+
+```ts
+const RESEND_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: [platform-mailing/src/resend/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/resend/env.ts#L19)
+
+Configuration entries required by the Resend delivery provider.

package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: SENDGRID\_API\_KEY'
+generated: true
+editUrl: false
+---
+# Variable: SENDGRID\_API\_KEY
+
+```ts
+const SENDGRID_API_KEY: IConfigKey<string>;
+```
+
+Defined in: [platform-mailing/src/sendgrid/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/sendgrid/env.ts#L12)
+
+API key for the SendGrid delivery service.

package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: SENDGRID\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: SENDGRID\_CONFIG\_ENTRIES
+
+```ts
+const SENDGRID_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: [platform-mailing/src/sendgrid/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/sendgrid/env.ts#L19)
+
+Configuration entries required by the SendGrid delivery provider.

package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: SEND\_MAIL\_EVENT\_KEY'
+generated: true
+editUrl: false
+---
+# Variable: SEND\_MAIL\_EVENT\_KEY
+
+```ts
+const SEND_MAIL_EVENT_KEY: IEventKey<IMailEvents, "sendMail">;
+```
+
+Defined in: [platform-mailing/src/events/MailEventKeys.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/events/MailEventKeys.ts#L13)
+
+Event key registry for the mail domain events.

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

@@ -0,0 +1,77 @@
+---
+title: '@breadstone/archipel-platform-mailing'
+generated: true
+editUrl: false
+---
+# @breadstone/archipel-platform-mailing
+
+## Classes
+
+| Class | Description |
+| ------ | ------ |
+| [BlobTemplateFetchStrategy](Class.BlobTemplateFetchStrategy) | The `BlobTemplateFetchStrategy` class. |
+| [DeliveryStrategyBase](Class.DeliveryStrategyBase) | Represents the base class for all email delivery strategies. |
+| [FileTemplateFetchStrategy](Class.FileTemplateFetchStrategy) | The `FileTemplateFetchStrategy` class. |
+| [LogDeliveryStrategy](Class.LogDeliveryStrategy) | The `LogDeliveryStrategy` class. |
+| [MailgunDeliveryStrategy](Class.MailgunDeliveryStrategy) | Delivers emails via the Mailgun API. |
+| [MailHealthIndicator](Class.MailHealthIndicator) | Health indicator for mail service. |
+| [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. |
+| [PostmarkDeliveryStrategy](Class.PostmarkDeliveryStrategy) | The `PostmarkDeliveryStrategy` class. |
+| [ResendDeliveryStrategy](Class.ResendDeliveryStrategy) | Delivers emails via the Resend API. |
+| [SendGridDeliveryStrategy](Class.SendGridDeliveryStrategy) | Delivers emails via the SendGrid API. |
+| [SmtpDeliveryStrategy](Class.SmtpDeliveryStrategy) | The `SmtpDeliveryStrategy` class. |
+| [TemplateFetchStrategyBase](Class.TemplateFetchStrategyBase) | Represents the base class for template fetch strategies. |
+
+## Interfaces
+
+| Interface | Description |
+| ------ | ------ |
+| [IMailAttachment](Interface.IMailAttachment) | Represents an email attachment. |
+| [IMailEvents](Interface.IMailEvents) | Represents the contract of events emitted by the mail domain. |
+| [IMailTemplateVariants](Interface.IMailTemplateVariants) | Represents the in-memory structure for a single template (multiple formats). |
+
+## Type Aliases
+
+| Type Alias | Description |
+| ------ | ------ |
+| [MailTemplateFormat](TypeAlias.MailTemplateFormat) | Union type of all supported template formats. |
+
+## Variables
+
+| Variable | Description |
+| ------ | ------ |
+| [ALLOWED\_ATTACHMENT\_MIME\_TYPES](Variable.ALLOWED_ATTACHMENT_MIME_TYPES) | Allowed MIME types for email attachments. |
+| [MAIL\_DELIVERY\_STRATEGY](Variable.MAIL_DELIVERY_STRATEGY) | Which delivery strategy to use (e.g. `smtp`, `postmark`, `resend`, `sendgrid`, `mailgun`, `log`). |
+| [MAIL\_DELIVERY\_STRATEGY\_TOKEN](Variable.MAIL_DELIVERY_STRATEGY_TOKEN) | - |
+| [MAIL\_HOST](Variable.MAIL_HOST) | Mail host checked by the health indicator. |
+| [MAIL\_MAILGUN\_API\_KEY](Variable.MAIL_MAILGUN_API_KEY) | API key for the Mailgun delivery service. |
+| [MAIL\_MAILGUN\_DOMAIN](Variable.MAIL_MAILGUN_DOMAIN) | Mailgun domain (e.g. `mg.example.com`). |
+| [MAIL\_PORT](Variable.MAIL_PORT) | Mail port checked by the health indicator. |
+| [MAIL\_POSTMARK\_API\_KEY](Variable.MAIL_POSTMARK_API_KEY) | API key for the Postmark delivery service. |
+| [MAIL\_RESEND\_API\_KEY](Variable.MAIL_RESEND_API_KEY) | API key for the Resend delivery service. |
+| [MAIL\_SENDER\_EMAIL](Variable.MAIL_SENDER_EMAIL) | Sender e-mail address shown in the `From` header. |
+| [MAIL\_SENDGRID\_API\_KEY](Variable.MAIL_SENDGRID_API_KEY) | API key for the SendGrid delivery service. |
+| [MAIL\_SMTP\_HOST](Variable.MAIL_SMTP_HOST) | SMTP server host. |
+| [MAIL\_SMTP\_PASSWORD](Variable.MAIL_SMTP_PASSWORD) | SMTP authentication password. |
+| [MAIL\_SMTP\_PORT](Variable.MAIL_SMTP_PORT) | SMTP server port. |
+| [MAIL\_SMTP\_SECURE](Variable.MAIL_SMTP_SECURE) | Whether the SMTP connection uses TLS. |
+| [MAIL\_SMTP\_USER](Variable.MAIL_SMTP_USER) | SMTP authentication username. |
+| [MAIL\_TEMPLATE\_ENGINE\_FORMAT](Variable.MAIL_TEMPLATE_ENGINE_FORMAT) | Template engine format identifier (e.g. `handlebars`). |
+| [MAIL\_TEMPLATE\_FETCH\_STRATEGY\_TOKEN](Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN) | Central definition of injection tokens used by the mail module. Using constants instead of raw string literals prevents accidental typos and enables refactors with compile time safety. |
+| [MAIL\_TEMPLATE\_STRATEGY](Variable.MAIL_TEMPLATE_STRATEGY) | Which template-fetch strategy to use (e.g. `file`, `blob`). |
+| [MAIL\_USER](Variable.MAIL_USER) | Mail user checked by the health indicator. |
+| [MAILGUN\_API\_KEY](Variable.MAILGUN_API_KEY) | API key for the Mailgun delivery service. |
+| [MAILGUN\_CONFIG\_ENTRIES](Variable.MAILGUN_CONFIG_ENTRIES) | Configuration entries required by the Mailgun delivery provider. |
+| [MAILGUN\_DOMAIN](Variable.MAILGUN_DOMAIN) | Mailgun domain (e.g. `mg.example.com`). |
+| [MAX\_ATTACHMENT\_SIZE\_BYTES](Variable.MAX_ATTACHMENT_SIZE_BYTES) | Maximum attachment size in bytes (25 MB). |
+| [PLATFORM\_MAILING\_CONFIG\_ENTRIES](Variable.PLATFORM_MAILING_CONFIG_ENTRIES) | All configuration entries required by `platform-mailing`. |
+| [POSTMARK\_API\_KEY](Variable.POSTMARK_API_KEY) | API key for the Postmark delivery service. |
+| [POSTMARK\_CONFIG\_ENTRIES](Variable.POSTMARK_CONFIG_ENTRIES) | Configuration entries required by the Postmark delivery provider. |
+| [RESEND\_API\_KEY](Variable.RESEND_API_KEY) | API key for the Resend delivery service. |
+| [RESEND\_CONFIG\_ENTRIES](Variable.RESEND_CONFIG_ENTRIES) | Configuration entries required by the Resend delivery provider. |
+| [SEND\_MAIL\_EVENT\_KEY](Variable.SEND_MAIL_EVENT_KEY) | Event key registry for the mail domain events. |
+| [SENDGRID\_API\_KEY](Variable.SENDGRID_API_KEY) | API key for the SendGrid delivery service. |
+| [SENDGRID\_CONFIG\_ENTRIES](Variable.SENDGRID_CONFIG_ENTRIES) | Configuration entries required by the SendGrid delivery provider. |