@breadstone/archipel-mcp 0.0.32 → 0.0.33

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/data/packages/platform-mailing/api/Class.DatabaseTemplateFetchStrategy.md +65 -0
  2. package/data/packages/platform-mailing/api/Class.MailModule.md +2 -2
  3. package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +4 -0
  4. package/data/packages/platform-mailing/api/Interface.IMailModuleOptions.md +26 -3
  5. package/data/packages/platform-mailing/api/Interface.IMailTemplate.md +96 -0
  6. package/data/packages/platform-mailing/api/Interface.IMailTemplateRepository.md +103 -0
  7. package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +3 -3
  8. package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +1 -1
  9. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_REPOSITORY_TOKEN.md +12 -0
  10. package/data/packages/platform-mailing/api/index.md +4 -0
  11. package/package.json +1 -1
package/data/packages/platform-mailing/api/Class.DatabaseTemplateFetchStrategy.md ADDED
@@ -0,0 +1,65 @@
1
+ ---
2
+ title: 'Class: DatabaseTemplateFetchStrategy'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: DatabaseTemplateFetchStrategy
7
+
8
+ Defined in: [platform-mailing/src/templating/strategies/DatabaseTemplateFetchStrategy.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/strategies/DatabaseTemplateFetchStrategy.ts#L22)
9
+
10
+ Template fetch strategy that loads templates from a database via the
11
+ [IMailTemplateRepository](Interface.IMailTemplateRepository) port.
12
+
13
+ Applications provide the concrete repository implementation at module
14
+ registration time. This strategy loads all templates on module init
15
+ and caches them in-memory.
16
+
17
+ ## Extends
18
+
19
+ - [`TemplateFetchStrategyBase`](Class.TemplateFetchStrategyBase)
20
+
21
+ ## Constructors
22
+
23
+ ### Constructor
24
+
25
+ ```ts
26
+ new DatabaseTemplateFetchStrategy(repository): DatabaseTemplateFetchStrategy;
27
+ ```
28
+
29
+ Defined in: [platform-mailing/src/templating/strategies/DatabaseTemplateFetchStrategy.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/strategies/DatabaseTemplateFetchStrategy.ts#L32)
30
+
31
+ #### Parameters
32
+
33
+ | Parameter | Type |
34
+ | ------ | ------ |
35
+ | `repository` | [`IMailTemplateRepository`](Interface.IMailTemplateRepository) |
36
+
37
+ #### Returns
38
+
39
+ `DatabaseTemplateFetchStrategy`
40
+
41
+ #### Overrides
42
+
43
+ [`TemplateFetchStrategyBase`](Class.TemplateFetchStrategyBase).[`constructor`](Class.TemplateFetchStrategyBase#constructor)
44
+
45
+ ## Methods
46
+
47
+ ### load()
48
+
49
+ ```ts
50
+ load(): Promise<Record<string, IMailTemplateVariants>>;
51
+ ```
52
+
53
+ Defined in: [platform-mailing/src/templating/strategies/DatabaseTemplateFetchStrategy.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/strategies/DatabaseTemplateFetchStrategy.ts#L48)
54
+
55
+ Loads all templates from the database and returns them grouped by key.
56
+ Only the default locale (no locale or first match) is loaded into the
57
+ in-memory cache used by `MailTemplateEngine`.
58
+
59
+ #### Returns
60
+
61
+ `Promise`\<`Record`\<`string`, [`IMailTemplateVariants`](Interface.IMailTemplateVariants)\>\>
62
+
63
+ #### Overrides
64
+
65
+ [`TemplateFetchStrategyBase`](Class.TemplateFetchStrategyBase).[`load`](Class.TemplateFetchStrategyBase#load)
package/data/packages/platform-mailing/api/Class.MailModule.md CHANGED
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: MailModule
7
7
 
8
- Defined in: [platform-mailing/src/tokens/MailModule.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailModule.ts#L46)
8
+ Defined in: [platform-mailing/src/tokens/MailModule.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailModule.ts#L67)
9
9
 
10
10
  Represents the mail module.
11
11
 
@@ -32,7 +32,7 @@ new MailModule(): MailModule;
32
32
  static register(options?): DynamicModule;
33
33
  ```
34
34
 
35
- Defined in: [platform-mailing/src/tokens/MailModule.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailModule.ts#L55)
35
+ Defined in: [platform-mailing/src/tokens/MailModule.ts:76](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailModule.ts#L76)
36
36
 
37
37
  Registers the mail module with optional configuration.
38
38
 
package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md CHANGED
@@ -9,6 +9,10 @@ Defined in: [platform-mailing/src/templating/strategies/abstracts/TemplateFetchS
9
9
 
10
10
  Represents the base class for template fetch strategies.
11
11
 
12
+ ## Extended by
13
+
14
+ - [`DatabaseTemplateFetchStrategy`](Class.DatabaseTemplateFetchStrategy)
15
+
12
16
  ## Constructors
13
17
 
14
18
  ### Constructor
package/data/packages/platform-mailing/api/Interface.IMailModuleOptions.md CHANGED
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IMailModuleOptions
7
7
 
8
- Defined in: [platform-mailing/src/tokens/MailModule.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailModule.ts#L23)
8
+ Defined in: [platform-mailing/src/tokens/MailModule.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailModule.ts#L28)
9
9
 
10
10
  Options for configuring the [MailModule](Class.MailModule).
11
11
 
@@ -17,7 +17,7 @@ Options for configuring the [MailModule](Class.MailModule).
17
17
  readonly optional configEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
18
18
  ```
19
19
 
20
- Defined in: [platform-mailing/src/tokens/MailModule.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailModule.ts#L34)
20
+ Defined in: [platform-mailing/src/tokens/MailModule.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailModule.ts#L39)
21
21
 
22
22
  Additional or overriding configuration entries.
23
23
  Merged with the platform default entries.
@@ -30,7 +30,30 @@ Merged with the platform default entries.
30
30
  readonly optional isGlobal?: boolean;
31
31
  ```
32
32
 
33
- Defined in: [platform-mailing/src/tokens/MailModule.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailModule.ts#L28)
33
+ Defined in: [platform-mailing/src/tokens/MailModule.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailModule.ts#L33)
34
34
 
35
35
  Whether to register the module globally.
36
36
  Defaults to `true`.
37
+
38
+ ***
39
+
40
+ ### templateRepositoryProvider?
41
+
42
+ ```ts
43
+ readonly optional templateRepositoryProvider?: Provider<IMailTemplateRepository>;
44
+ ```
45
+
46
+ Defined in: [platform-mailing/src/tokens/MailModule.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailModule.ts#L55)
47
+
48
+ Provider for the `IMailTemplateRepository` port.
49
+ Required when `MAIL_TEMPLATE_STRATEGY` is set to `'database'`.
50
+
51
+ Example:
52
+ ```typescript
53
+ MailModule.register({
54
+ templateRepositoryProvider: {
55
+ provide: MAIL_TEMPLATE_REPOSITORY_TOKEN,
56
+ useClass: PrismaMailTemplateRepository,
57
+ }
58
+ })
59
+ ```
package/data/packages/platform-mailing/api/Interface.IMailTemplate.md ADDED
@@ -0,0 +1,96 @@
1
+ ---
2
+ title: 'Interface: IMailTemplate'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IMailTemplate
7
+
8
+ Defined in: [platform-mailing/src/models/IMailTemplate.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailTemplate.ts#L6)
9
+
10
+ Represents a single mail template record stored in a persistent store.
11
+
12
+ ## Properties
13
+
14
+ ### description?
15
+
16
+ ```ts
17
+ readonly optional description?: string;
18
+ ```
19
+
20
+ Defined in: [platform-mailing/src/models/IMailTemplate.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailTemplate.ts#L37)
21
+
22
+ Human-readable description of this template's purpose.
23
+
24
+ ***
25
+
26
+ ### htmlBody?
27
+
28
+ ```ts
29
+ readonly optional htmlBody?: string;
30
+ ```
31
+
32
+ Defined in: [platform-mailing/src/models/IMailTemplate.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailTemplate.ts#L27)
33
+
34
+ HTML body of the template. Contains Handlebars-style placeholders.
35
+
36
+ ***
37
+
38
+ ### key
39
+
40
+ ```ts
41
+ readonly key: string;
42
+ ```
43
+
44
+ Defined in: [platform-mailing/src/models/IMailTemplate.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailTemplate.ts#L10)
45
+
46
+ Unique template key used to identify this template (e.g. `AuthRegister`, `AppointmentInvitation`).
47
+
48
+ ***
49
+
50
+ ### locale?
51
+
52
+ ```ts
53
+ readonly optional locale?: string;
54
+ ```
55
+
56
+ Defined in: [platform-mailing/src/models/IMailTemplate.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailTemplate.ts#L16)
57
+
58
+ Locale identifier (e.g. `de`, `en`). Used for multi-language support.
59
+ When `undefined`, it is the default/fallback template.
60
+
61
+ ***
62
+
63
+ ### placeholders?
64
+
65
+ ```ts
66
+ readonly optional placeholders?: readonly string[];
67
+ ```
68
+
69
+ Defined in: [platform-mailing/src/models/IMailTemplate.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailTemplate.ts#L42)
70
+
71
+ List of placeholder names expected by this template (for documentation/validation).
72
+
73
+ ***
74
+
75
+ ### subject
76
+
77
+ ```ts
78
+ readonly subject: string;
79
+ ```
80
+
81
+ Defined in: [platform-mailing/src/models/IMailTemplate.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailTemplate.ts#L22)
82
+
83
+ Default subject line for this template.
84
+ Can contain placeholders (e.g. `{{appName}}`).
85
+
86
+ ***
87
+
88
+ ### txtBody?
89
+
90
+ ```ts
91
+ readonly optional txtBody?: string;
92
+ ```
93
+
94
+ Defined in: [platform-mailing/src/models/IMailTemplate.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/models/IMailTemplate.ts#L32)
95
+
96
+ Plain-text body of the template. Contains Handlebars-style placeholders.
package/data/packages/platform-mailing/api/Interface.IMailTemplateRepository.md ADDED
@@ -0,0 +1,103 @@
1
+ ---
2
+ title: 'Interface: IMailTemplateRepository'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IMailTemplateRepository
7
+
8
+ Defined in: [platform-mailing/src/ports/IMailTemplateRepository.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/ports/IMailTemplateRepository.ts#L11)
9
+
10
+ Port interface for mail template persistence.
11
+
12
+ Applications must implement this interface and register the implementation
13
+ via the `MAIL_TEMPLATE_REPOSITORY_TOKEN` when using the `database` template strategy.
14
+
15
+ ## Methods
16
+
17
+ ### delete()
18
+
19
+ ```ts
20
+ delete(key, locale?): Promise<void>;
21
+ ```
22
+
23
+ Defined in: [platform-mailing/src/ports/IMailTemplateRepository.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/ports/IMailTemplateRepository.ts#L42)
24
+
25
+ Deletes a template by key and locale.
26
+
27
+ #### Parameters
28
+
29
+ | Parameter | Type | Description |
30
+ | ------ | ------ | ------ |
31
+ | `key` | `string` | The template key. |
32
+ | `locale?` | `string` | Optional locale. When omitted, deletes the default template. |
33
+
34
+ #### Returns
35
+
36
+ `Promise`\<`void`\>
37
+
38
+ ***
39
+
40
+ ### findAll()
41
+
42
+ ```ts
43
+ findAll(): Promise<IMailTemplate[]>;
44
+ ```
45
+
46
+ Defined in: [platform-mailing/src/ports/IMailTemplateRepository.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/ports/IMailTemplateRepository.ts#L25)
47
+
48
+ Returns all templates available in the store.
49
+
50
+ #### Returns
51
+
52
+ `Promise`\<[`IMailTemplate`](Interface.IMailTemplate)[]\>
53
+
54
+ ***
55
+
56
+ ### findByKey()
57
+
58
+ ```ts
59
+ findByKey(key, locale?): Promise<IMailTemplate | undefined>;
60
+ ```
61
+
62
+ Defined in: [platform-mailing/src/ports/IMailTemplateRepository.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/ports/IMailTemplateRepository.ts#L20)
63
+
64
+ Finds a template by its unique key and optional locale.
65
+ When no locale is provided, returns the default (locale-agnostic) template.
66
+
67
+ #### Parameters
68
+
69
+ | Parameter | Type | Description |
70
+ | ------ | ------ | ------ |
71
+ | `key` | `string` | The template key (e.g. `AuthRegister`). |
72
+ | `locale?` | `string` | Optional locale identifier (e.g. `de`, `en`). |
73
+
74
+ #### Returns
75
+
76
+ `Promise`\<[`IMailTemplate`](Interface.IMailTemplate) \| `undefined`\>
77
+
78
+ The matching template, or `undefined` if not found.
79
+
80
+ ***
81
+
82
+ ### upsert()
83
+
84
+ ```ts
85
+ upsert(template): Promise<IMailTemplate>;
86
+ ```
87
+
88
+ Defined in: [platform-mailing/src/ports/IMailTemplateRepository.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/ports/IMailTemplateRepository.ts#L34)
89
+
90
+ Creates or updates a template. Upsert semantics: if a template with the
91
+ same `key` and `locale` exists, it is overwritten.
92
+
93
+ #### Parameters
94
+
95
+ | Parameter | Type | Description |
96
+ | ------ | ------ | ------ |
97
+ | `template` | [`IMailTemplate`](Interface.IMailTemplate) | The template to persist. |
98
+
99
+ #### Returns
100
+
101
+ `Promise`\<[`IMailTemplate`](Interface.IMailTemplate)\>
102
+
103
+ The persisted template.
package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md CHANGED
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IMailTemplateVariants
7
7
 
8
- Defined in: [platform-mailing/src/MailTokens.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L21)
8
+ Defined in: [platform-mailing/src/MailTokens.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L23)
9
9
 
10
10
  Represents the in-memory structure for a single template (multiple formats).
11
11
 
@@ -17,7 +17,7 @@ Represents the in-memory structure for a single template (multiple formats).
17
17
  optional html?: string;
18
18
  ```
19
19
 
20
- Defined in: [platform-mailing/src/MailTokens.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L22)
20
+ Defined in: [platform-mailing/src/MailTokens.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L24)
21
21
 
22
22
  ***
23
23
 
@@ -27,4 +27,4 @@ Defined in: [platform-mailing/src/MailTokens.ts:22](https://github.com/RueDeRenn
27
27
  optional txt?: string;
28
28
  ```
29
29
 
30
- Defined in: [platform-mailing/src/MailTokens.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L23)
30
+ 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 CHANGED
@@ -9,6 +9,6 @@ editUrl: false
9
9
  type MailTemplateFormat = "html" | "txt";
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/MailTokens.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L16)
12
+ Defined in: [platform-mailing/src/MailTokens.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L18)
13
13
 
14
14
  Union type of all supported template formats.
package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_REPOSITORY_TOKEN.md ADDED
@@ -0,0 +1,12 @@
1
+ ---
2
+ title: 'Variable: MAIL\_TEMPLATE\_REPOSITORY\_TOKEN'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: MAIL\_TEMPLATE\_REPOSITORY\_TOKEN
7
+
8
+ ```ts
9
+ const MAIL_TEMPLATE_REPOSITORY_TOKEN: typeof MAIL_TEMPLATE_REPOSITORY_TOKEN;
10
+ ```
11
+
12
+ 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 CHANGED
@@ -9,6 +9,7 @@ editUrl: false
9
9
 
10
10
  | Class | Description |
11
11
  | ------ | ------ |
12
+ | [DatabaseTemplateFetchStrategy](Class.DatabaseTemplateFetchStrategy) | Template fetch strategy that loads templates from a database via the [IMailTemplateRepository](Interface.IMailTemplateRepository) port. |
12
13
  | [DeliveryStrategyBase](Class.DeliveryStrategyBase) | Represents the base class for all email delivery strategies. |
13
14
  | [MailDeliveryError](Class.MailDeliveryError) | Domain error thrown when email delivery fails. |
14
15
  | [MailgunDeliveryStrategy](Class.MailgunDeliveryStrategy) | Delivers emails via the Mailgun API. |
@@ -31,6 +32,8 @@ editUrl: false
31
32
  | [IMailAttachment](Interface.IMailAttachment) | Represents an email attachment. |
32
33
  | [IMailEvents](Interface.IMailEvents) | Represents the contract of events emitted by the mail domain. |
33
34
  | [IMailModuleOptions](Interface.IMailModuleOptions) | Options for configuring the [MailModule](Class.MailModule). |
35
+ | [IMailTemplate](Interface.IMailTemplate) | Represents a single mail template record stored in a persistent store. |
36
+ | [IMailTemplateRepository](Interface.IMailTemplateRepository) | Port interface for mail template persistence. |
34
37
  | [IMailTemplateVariants](Interface.IMailTemplateVariants) | Represents the in-memory structure for a single template (multiple formats). |
35
38
 
36
39
  ## Type Aliases
@@ -61,6 +64,7 @@ editUrl: false
61
64
  | [MAIL\_SMTP\_USER](Variable.MAIL_SMTP_USER) | SMTP authentication username. |
62
65
  | [MAIL\_TEMPLATE\_ENGINE\_FORMAT](Variable.MAIL_TEMPLATE_ENGINE_FORMAT) | Template engine format identifier (e.g. `handlebars`). |
63
66
  | [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. |
67
+ | [MAIL\_TEMPLATE\_REPOSITORY\_TOKEN](Variable.MAIL_TEMPLATE_REPOSITORY_TOKEN) | - |
64
68
  | [MAIL\_TEMPLATE\_STRATEGY](Variable.MAIL_TEMPLATE_STRATEGY) | Which template-fetch strategy to use (e.g. `file`, `blob`). |
65
69
  | [MAIL\_USER](Variable.MAIL_USER) | Mail user checked by the health indicator. |
66
70
  | [MAILGUN\_API\_KEY](Variable.MAILGUN_API_KEY) | API key for the Mailgun delivery service. |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@breadstone/archipel-mcp",
3
- "version": "0.0.32",
3
+ "version": "0.0.33",
4
4
  "description": "MCP server providing Archipel platform knowledge - documentation, query patterns, and coding conventions - to AI development tools.",
5
5
  "type": "commonjs",
6
6
  "main": "./src/main.js",