@breadstone/archipel-mcp 0.0.31 → 0.0.33

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

@@ -0,0 +1,96 @@
+---
+title: 'Interface: IMailTemplate'
+generated: true
+editUrl: false
+---
+# Interface: IMailTemplate
+
+Defined in: [platform-mailing/src/models/IMailTemplate.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailTemplate.ts#L6)
+
+Represents a single mail template record stored in a persistent store.
+
+## Properties
+
+### description?
+
+```ts
+readonly optional description?: string;
+```
+
+Defined in: [platform-mailing/src/models/IMailTemplate.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailTemplate.ts#L37)
+
+Human-readable description of this template's purpose.
+
+***
+
+### htmlBody?
+
+```ts
+readonly optional htmlBody?: string;
+```
+
+Defined in: [platform-mailing/src/models/IMailTemplate.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailTemplate.ts#L27)
+
+HTML body of the template. Contains Handlebars-style placeholders.
+
+***
+
+### key
+
+```ts
+readonly key: string;
+```
+
+Defined in: [platform-mailing/src/models/IMailTemplate.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailTemplate.ts#L10)
+
+Unique template key used to identify this template (e.g. `AuthRegister`, `AppointmentInvitation`).
+
+***
+
+### locale?
+
+```ts
+readonly optional locale?: string;
+```
+
+Defined in: [platform-mailing/src/models/IMailTemplate.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailTemplate.ts#L16)
+
+Locale identifier (e.g. `de`, `en`). Used for multi-language support.
+When `undefined`, it is the default/fallback template.
+
+***
+
+### placeholders?
+
+```ts
+readonly optional placeholders?: readonly string[];
+```
+
+Defined in: [platform-mailing/src/models/IMailTemplate.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailTemplate.ts#L42)
+
+List of placeholder names expected by this template (for documentation/validation).
+
+***
+
+### subject
+
+```ts
+readonly subject: string;
+```
+
+Defined in: [platform-mailing/src/models/IMailTemplate.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailTemplate.ts#L22)
+
+Default subject line for this template.
+Can contain placeholders (e.g. `{{appName}}`).
+
+***
+
+### txtBody?
+
+```ts
+readonly optional txtBody?: string;
+```
+
+Defined in: [platform-mailing/src/models/IMailTemplate.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailTemplate.ts#L32)
+
+Plain-text body of the template. Contains Handlebars-style placeholders.

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

@@ -0,0 +1,103 @@
+---
+title: 'Interface: IMailTemplateRepository'
+generated: true
+editUrl: false
+---
+# Interface: IMailTemplateRepository
+
+Defined in: [platform-mailing/src/ports/IMailTemplateRepository.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/ports/IMailTemplateRepository.ts#L11)
+
+Port interface for mail template persistence.
+
+Applications must implement this interface and register the implementation
+via the `MAIL_TEMPLATE_REPOSITORY_TOKEN` when using the `database` template strategy.
+
+## Methods
+
+### delete()
+
+```ts
+delete(key, locale?): Promise<void>;
+```
+
+Defined in: [platform-mailing/src/ports/IMailTemplateRepository.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/ports/IMailTemplateRepository.ts#L42)
+
+Deletes a template by key and locale.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The template key. |
+| `locale?` | `string` | Optional locale. When omitted, deletes the default template. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### findAll()
+
+```ts
+findAll(): Promise<IMailTemplate[]>;
+```
+
+Defined in: [platform-mailing/src/ports/IMailTemplateRepository.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/ports/IMailTemplateRepository.ts#L25)
+
+Returns all templates available in the store.
+
+#### Returns
+
+`Promise`\<[`IMailTemplate`](Interface.IMailTemplate)[]\>
+
+***
+
+### findByKey()
+
+```ts
+findByKey(key, locale?): Promise<IMailTemplate | undefined>;
+```
+
+Defined in: [platform-mailing/src/ports/IMailTemplateRepository.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/ports/IMailTemplateRepository.ts#L20)
+
+Finds a template by its unique key and optional locale.
+When no locale is provided, returns the default (locale-agnostic) template.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The template key (e.g. `AuthRegister`). |
+| `locale?` | `string` | Optional locale identifier (e.g. `de`, `en`). |
+
+#### Returns
+
+`Promise`\<[`IMailTemplate`](Interface.IMailTemplate) \| `undefined`\>
+
+The matching template, or `undefined` if not found.
+
+***
+
+### upsert()
+
+```ts
+upsert(template): Promise<IMailTemplate>;
+```
+
+Defined in: [platform-mailing/src/ports/IMailTemplateRepository.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/ports/IMailTemplateRepository.ts#L34)
+
+Creates or updates a template. Upsert semantics: if a template with the
+same `key` and `locale` exists, it is overwritten.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `template` | [`IMailTemplate`](Interface.IMailTemplate) | The template to persist. |
+
+#### Returns
+
+`Promise`\<[`IMailTemplate`](Interface.IMailTemplate)\>
+
+The persisted template.

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

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Interface: IMailTemplateVariants
 
-Defined in: [platform-mailing/src/MailTokens.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L21)
+Defined in: [platform-mailing/src/MailTokens.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L23)
 
 Represents the in-memory structure for a single template (multiple formats).
 
@@ -17,7 +17,7 @@ Represents the in-memory structure for a single template (multiple formats).
 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)
+Defined in: [platform-mailing/src/MailTokens.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L24)
 
 ***
 
@@ -27,4 +27,4 @@ Defined in: [platform-mailing/src/MailTokens.ts:22](https://github.com/RueDeRenn
 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)
+Defined in: [platform-mailing/src/MailTokens.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L25)

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

@@ -9,6 +9,6 @@ editUrl: false
 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)
+Defined in: [platform-mailing/src/MailTokens.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L18)
 
 Union type of all supported template formats.

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

@@ -0,0 +1,12 @@
+---
+title: 'Variable: MAIL\_TEMPLATE\_REPOSITORY\_TOKEN'
+generated: true
+editUrl: false
+---
+# Variable: MAIL\_TEMPLATE\_REPOSITORY\_TOKEN
+
+```ts
+const MAIL_TEMPLATE_REPOSITORY_TOKEN: typeof MAIL_TEMPLATE_REPOSITORY_TOKEN;
+```
+
+Defined in: [platform-mailing/src/MailTokens.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L13)

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

@@ -9,6 +9,7 @@ editUrl: false
 
 | Class | Description |
 | ------ | ------ |
+| [DatabaseTemplateFetchStrategy](Class.DatabaseTemplateFetchStrategy) | Template fetch strategy that loads templates from a database via the [IMailTemplateRepository](Interface.IMailTemplateRepository) port. |
 | [DeliveryStrategyBase](Class.DeliveryStrategyBase) | Represents the base class for all email delivery strategies. |
 | [MailDeliveryError](Class.MailDeliveryError) | Domain error thrown when email delivery fails. |
 | [MailgunDeliveryStrategy](Class.MailgunDeliveryStrategy) | Delivers emails via the Mailgun API. |
@@ -31,6 +32,8 @@ 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). |
+| [IMailTemplate](Interface.IMailTemplate) | Represents a single mail template record stored in a persistent store. |
+| [IMailTemplateRepository](Interface.IMailTemplateRepository) | Port interface for mail template persistence. |
 | [IMailTemplateVariants](Interface.IMailTemplateVariants) | Represents the in-memory structure for a single template (multiple formats). |
 
 ## Type Aliases
@@ -61,6 +64,7 @@ editUrl: false
 | [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\_REPOSITORY\_TOKEN](Variable.MAIL_TEMPLATE_REPOSITORY_TOKEN) | - |
 | [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. |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breadstone/archipel-mcp",
-  "version": "0.0.31",
+  "version": "0.0.33",
   "description": "MCP server providing Archipel platform knowledge - documentation, query patterns, and coding conventions - to AI development tools.",
   "type": "commonjs",
   "main": "./src/main.js",