@breadstone/archipel-mcp 0.0.33 → 0.0.35

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 (88) hide show
  1. package/data/guides/email-delivery.md +68 -24
  2. package/data/guides/email-templates.md +80 -38
  3. package/data/packages/platform-feature-flags/api/Class.AzureFeatureFlagReader.md +9 -9
  4. package/data/packages/platform-feature-flags/api/Class.AzureFeatureFlagWriter.md +9 -9
  5. package/data/packages/platform-feature-flags/api/Class.FeatureFlagError.md +4 -4
  6. package/data/packages/platform-feature-flags/api/Class.FeatureFlagGuard.md +3 -3
  7. package/data/packages/platform-feature-flags/api/Class.FeatureFlagModule.md +2 -2
  8. package/data/packages/platform-feature-flags/api/Class.FeatureFlagReaderPort.md +6 -6
  9. package/data/packages/platform-feature-flags/api/Class.FeatureFlagWriterPort.md +7 -7
  10. package/data/packages/platform-feature-flags/api/Class.VercelFeatureFlagReader.md +8 -8
  11. package/data/packages/platform-feature-flags/api/Class.VercelFeatureFlagWriter.md +9 -9
  12. package/data/packages/platform-feature-flags/api/Function.FeatureFlag.md +1 -1
  13. package/data/packages/platform-feature-flags/api/Interface.IFeatureFlagContext.md +4 -4
  14. package/data/packages/platform-feature-flags/api/Interface.IFeatureFlagDefinition.md +6 -6
  15. package/data/packages/platform-feature-flags/api/Interface.IFeatureFlagEvaluation.md +4 -4
  16. package/data/packages/platform-feature-flags/api/Interface.IFeatureFlagModuleOptions.md +5 -5
  17. package/data/packages/platform-feature-flags/api/Variable.AZURE_APPCONFIG_CONNECTION_STRING.md +1 -1
  18. package/data/packages/platform-feature-flags/api/Variable.AZURE_APPCONFIG_ENDPOINT.md +1 -1
  19. package/data/packages/platform-feature-flags/api/Variable.AZURE_FEATURE_FLAG_CONFIG_ENTRIES.md +1 -1
  20. package/data/packages/platform-feature-flags/api/Variable.AZURE_FEATURE_FLAG_KEY_FILTER.md +1 -1
  21. package/data/packages/platform-feature-flags/api/Variable.AZURE_FEATURE_FLAG_REFRESH_INTERVAL.md +1 -1
  22. package/data/packages/platform-feature-flags/api/Variable.FEATURE_FLAG_KEY_METADATA.md +1 -1
  23. package/data/packages/platform-feature-flags/api/Variable.PLATFORM_FEATURE_FLAGS_CONFIG_ENTRIES.md +1 -1
  24. package/data/packages/platform-feature-flags/api/Variable.VERCEL_API_TOKEN.md +1 -1
  25. package/data/packages/platform-feature-flags/api/Variable.VERCEL_EDGE_CONFIG.md +1 -1
  26. package/data/packages/platform-feature-flags/api/Variable.VERCEL_EDGE_CONFIG_ID.md +1 -1
  27. package/data/packages/platform-feature-flags/api/Variable.VERCEL_EDGE_CONFIG_TOKEN.md +1 -1
  28. package/data/packages/platform-feature-flags/api/Variable.VERCEL_FEATURE_FLAG_CONFIG_ENTRIES.md +1 -1
  29. package/data/packages/platform-feature-flags/api/Variable.VERCEL_FEATURE_FLAG_PREFIX.md +1 -1
  30. package/data/packages/platform-feature-flags/api/Variable.VERCEL_FEATURE_FLAG_WRITER_CONFIG_ENTRIES.md +1 -1
  31. package/data/packages/platform-feature-flags/api/Variable.VERCEL_TEAM_ID.md +1 -1
  32. package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +60 -0
  33. package/data/packages/platform-mailing/api/Class.DatabaseTemplateFetchStrategy.md +3 -3
  34. package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +4 -3
  35. package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +62 -0
  36. package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +71 -0
  37. package/data/packages/platform-mailing/api/Class.MailModule.md +7 -7
  38. package/data/packages/platform-mailing/api/Class.MailService.md +11 -7
  39. package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +29 -4
  40. package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +3 -3
  41. package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +3 -3
  42. package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +3 -3
  43. package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +3 -3
  44. package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +3 -3
  45. package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +7 -11
  46. package/data/packages/platform-mailing/api/Interface.IMailEvents.md +28 -5
  47. package/data/packages/platform-mailing/api/Interface.IMailModuleOptions.md +50 -7
  48. package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +13 -3
  49. package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +1 -1
  50. package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +1 -1
  51. package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +1 -1
  52. package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +1 -1
  53. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +1 -1
  54. package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +1 -1
  55. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +1 -1
  56. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +1 -1
  57. package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +1 -1
  58. package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +1 -1
  59. package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +1 -1
  60. package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +1 -1
  61. package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +1 -1
  62. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +1 -1
  63. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +1 -1
  64. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +1 -1
  65. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +1 -1
  66. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +1 -1
  67. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +1 -1
  68. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +1 -1
  69. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_NAMES_TOKEN.md +12 -0
  70. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_REPOSITORY_TOKEN.md +1 -1
  71. package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +1 -1
  72. package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +1 -1
  73. package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +1 -1
  74. package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +1 -1
  75. package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +1 -1
  76. package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +1 -1
  77. package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +1 -1
  78. package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +1 -1
  79. package/data/packages/platform-mailing/api/Variable.SMTP_CONFIG_ENTRIES.md +1 -1
  80. package/data/packages/platform-mailing/api/Variable.SMTP_HOST.md +1 -1
  81. package/data/packages/platform-mailing/api/Variable.SMTP_PASSWORD.md +1 -1
  82. package/data/packages/platform-mailing/api/Variable.SMTP_PORT.md +1 -1
  83. package/data/packages/platform-mailing/api/Variable.SMTP_SECURE.md +1 -1
  84. package/data/packages/platform-mailing/api/Variable.SMTP_USER.md +1 -1
  85. package/data/packages/platform-mailing/api/index.md +4 -2
  86. package/package.json +1 -1
  87. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +0 -14
  88. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +0 -14
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IMailModuleOptions
7
7
 
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)
8
+ Defined in: [platform-mailing/src/MailModule.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailModule.ts#L30)
9
9
 
10
10
  Options for configuring the [MailModule](Class.MailModule).
11
11
 
@@ -17,10 +17,22 @@ 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:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailModule.ts#L39)
20
+ Defined in: [platform-mailing/src/MailModule.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailModule.ts#L52)
21
21
 
22
- Additional or overriding configuration entries.
23
- Merged with the platform default entries.
22
+ Provider-specific configuration entries to register with the config module.
23
+
24
+ ***
25
+
26
+ ### deliveryStrategy
27
+
28
+ ```ts
29
+ readonly deliveryStrategy: Type<DeliveryStrategyBase>;
30
+ ```
31
+
32
+ Defined in: [platform-mailing/src/MailModule.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailModule.ts#L35)
33
+
34
+ Concrete implementation of the [DeliveryStrategyBase](Class.DeliveryStrategyBase) port.
35
+ For example, `SmtpDeliveryStrategy`, `PostmarkDeliveryStrategy`, or `LogDeliveryStrategy`.
24
36
 
25
37
  ***
26
38
 
@@ -30,27 +42,58 @@ Merged with the platform default entries.
30
42
  readonly optional isGlobal?: boolean;
31
43
  ```
32
44
 
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)
45
+ Defined in: [platform-mailing/src/MailModule.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailModule.ts#L47)
34
46
 
35
47
  Whether to register the module globally.
36
48
  Defaults to `true`.
37
49
 
38
50
  ***
39
51
 
52
+ ### templateFetchStrategy
53
+
54
+ ```ts
55
+ readonly templateFetchStrategy: Type<TemplateFetchStrategyBase>;
56
+ ```
57
+
58
+ Defined in: [platform-mailing/src/MailModule.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailModule.ts#L41)
59
+
60
+ Concrete implementation of the [TemplateFetchStrategyBase](Class.TemplateFetchStrategyBase) port.
61
+ For example, `FileTemplateFetchStrategy`, `BlobTemplateFetchStrategy`, or `DatabaseTemplateFetchStrategy`.
62
+
63
+ ***
64
+
65
+ ### templateNames?
66
+
67
+ ```ts
68
+ readonly optional templateNames?: readonly string[];
69
+ ```
70
+
71
+ Defined in: [platform-mailing/src/MailModule.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailModule.ts#L61)
72
+
73
+ Template names to load when using the `FileTemplateFetchStrategy`.
74
+ Each name corresponds to a resource file (e.g. `'AuthRegister'` loads
75
+ `AuthRegister.html` and `AuthRegister.txt`).
76
+
77
+ Defaults to an empty array (no templates loaded).
78
+
79
+ ***
80
+
40
81
  ### templateRepositoryProvider?
41
82
 
42
83
  ```ts
43
84
  readonly optional templateRepositoryProvider?: Provider<IMailTemplateRepository>;
44
85
  ```
45
86
 
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)
87
+ Defined in: [platform-mailing/src/MailModule.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailModule.ts#L79)
47
88
 
48
89
  Provider for the `IMailTemplateRepository` port.
49
- Required when `MAIL_TEMPLATE_STRATEGY` is set to `'database'`.
90
+ Required when using `DatabaseTemplateFetchStrategy`.
50
91
 
51
92
  Example:
52
93
  ```typescript
53
94
  MailModule.register({
95
+ deliveryStrategy: SmtpDeliveryStrategy,
96
+ templateFetchStrategy: DatabaseTemplateFetchStrategy,
54
97
  templateRepositoryProvider: {
55
98
  provide: MAIL_TEMPLATE_REPOSITORY_TOKEN,
56
99
  useClass: PrismaMailTemplateRepository,
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IMailTemplateVariants
7
7
 
8
- Defined in: [platform-mailing/src/MailTokens.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L23)
8
+ Defined in: platform-mailing/src/models/IMailTemplateVariants.ts:6
9
9
 
10
10
  Represents the in-memory structure for a single template (multiple formats).
11
11
 
@@ -17,7 +17,17 @@ 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:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L24)
20
+ Defined in: platform-mailing/src/models/IMailTemplateVariants.ts:8
21
+
22
+ ***
23
+
24
+ ### subject?
25
+
26
+ ```ts
27
+ optional subject?: string;
28
+ ```
29
+
30
+ Defined in: platform-mailing/src/models/IMailTemplateVariants.ts:7
21
31
 
22
32
  ***
23
33
 
@@ -27,4 +37,4 @@ Defined in: [platform-mailing/src/MailTokens.ts:24](https://github.com/RueDeRenn
27
37
  optional txt?: string;
28
38
  ```
29
39
 
30
- Defined in: [platform-mailing/src/MailTokens.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L25)
40
+ Defined in: platform-mailing/src/models/IMailTemplateVariants.ts:9
@@ -9,6 +9,6 @@ editUrl: false
9
9
  type MailTemplateFormat = "html" | "txt";
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/MailTokens.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L18)
12
+ Defined in: platform-mailing/src/models/MailTemplateFormat.ts:6
13
13
 
14
14
  Union type of all supported template formats.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAILGUN_API_KEY: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/mailgun/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/mailgun/env.ts#L12)
12
+ Defined in: [platform-mailing/src/delivering/strategies/mailgun/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/mailgun/env.ts#L12)
13
13
 
14
14
  API key for the Mailgun delivery service.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAILGUN_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/mailgun/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/mailgun/env.ts#L22)
12
+ Defined in: [platform-mailing/src/delivering/strategies/mailgun/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/mailgun/env.ts#L22)
13
13
 
14
14
  Configuration entries required by the Mailgun delivery provider.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAILGUN_DOMAIN: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/mailgun/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/mailgun/env.ts#L15)
12
+ Defined in: [platform-mailing/src/delivering/strategies/mailgun/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/mailgun/env.ts#L15)
13
13
 
14
14
  Mailgun domain (e.g. `mg.example.com`).
@@ -9,4 +9,4 @@ editUrl: false
9
9
  const MAIL_DELIVERY_STRATEGY_TOKEN: typeof MAIL_DELIVERY_STRATEGY_TOKEN;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/MailTokens.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L11)
12
+ Defined in: [platform-mailing/src/tokens/MailTokens.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailTokens.ts#L11)
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAIL_HOST: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/env.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L78)
12
+ Defined in: [platform-mailing/src/env.ts:72](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L72)
13
13
 
14
14
  Mail host checked by the health indicator.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAIL_MAILGUN_API_KEY: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/env.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L49)
12
+ Defined in: [platform-mailing/src/env.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L43)
13
13
 
14
14
  API key for the Mailgun delivery service.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAIL_MAILGUN_DOMAIN: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/env.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L52)
12
+ Defined in: [platform-mailing/src/env.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L46)
13
13
 
14
14
  Mailgun domain (e.g. `mg.example.com`).
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAIL_PORT: IConfigKey<number>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/env.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L84)
12
+ Defined in: [platform-mailing/src/env.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L78)
13
13
 
14
14
  Mail port checked by the health indicator.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAIL_POSTMARK_API_KEY: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/env.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L28)
12
+ Defined in: [platform-mailing/src/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L22)
13
13
 
14
14
  API key for the Postmark delivery service.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAIL_RESEND_API_KEY: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/env.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L35)
12
+ Defined in: [platform-mailing/src/env.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L29)
13
13
 
14
14
  API key for the Resend delivery service.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAIL_SENDER_EMAIL: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L18)
12
+ Defined in: [platform-mailing/src/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L12)
13
13
 
14
14
  Sender e-mail address shown in the `From` header.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAIL_SENDGRID_API_KEY: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/env.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L42)
12
+ Defined in: [platform-mailing/src/env.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L36)
13
13
 
14
14
  API key for the SendGrid delivery service.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAIL_SMTP_HOST: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/env.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L59)
12
+ Defined in: [platform-mailing/src/env.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L53)
13
13
 
14
14
  SMTP server host.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAIL_SMTP_PASSWORD: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/env.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L71)
12
+ Defined in: [platform-mailing/src/env.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L65)
13
13
 
14
14
  SMTP authentication password.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAIL_SMTP_PORT: IConfigKey<number>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/env.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L62)
12
+ Defined in: [platform-mailing/src/env.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L56)
13
13
 
14
14
  SMTP server port.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAIL_SMTP_SECURE: IConfigKey<boolean>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/env.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L65)
12
+ Defined in: [platform-mailing/src/env.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L59)
13
13
 
14
14
  Whether the SMTP connection uses TLS.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAIL_SMTP_USER: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/env.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L68)
12
+ Defined in: [platform-mailing/src/env.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L62)
13
13
 
14
14
  SMTP authentication username.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAIL_TEMPLATE_ENGINE_FORMAT: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/env.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L21)
12
+ Defined in: [platform-mailing/src/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L15)
13
13
 
14
14
  Template engine format identifier (e.g. `handlebars`).
@@ -9,7 +9,7 @@ editUrl: false
9
9
  const MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN: typeof MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/MailTokens.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L9)
12
+ Defined in: [platform-mailing/src/tokens/MailTokens.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailTokens.ts#L9)
13
13
 
14
14
  Central definition of injection tokens used by the mail module.
15
15
  Using constants instead of raw string literals prevents accidental typos
@@ -0,0 +1,12 @@
1
+ ---
2
+ title: 'Variable: MAIL\_TEMPLATE\_NAMES\_TOKEN'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: MAIL\_TEMPLATE\_NAMES\_TOKEN
7
+
8
+ ```ts
9
+ const MAIL_TEMPLATE_NAMES_TOKEN: typeof MAIL_TEMPLATE_NAMES_TOKEN;
10
+ ```
11
+
12
+ Defined in: [platform-mailing/src/tokens/MailTokens.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailTokens.ts#L15)
@@ -9,4 +9,4 @@ editUrl: false
9
9
  const MAIL_TEMPLATE_REPOSITORY_TOKEN: typeof MAIL_TEMPLATE_REPOSITORY_TOKEN;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/MailTokens.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L13)
12
+ Defined in: [platform-mailing/src/tokens/MailTokens.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/tokens/MailTokens.ts#L13)
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const MAIL_USER: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/env.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L81)
12
+ Defined in: [platform-mailing/src/env.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L75)
13
13
 
14
14
  Mail user checked by the health indicator.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const PLATFORM_MAILING_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/env.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L91)
12
+ Defined in: [platform-mailing/src/env.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L85)
13
13
 
14
14
  All configuration entries required by `platform-mailing`.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const POSTMARK_API_KEY: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/postmark/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/postmark/env.ts#L12)
12
+ Defined in: [platform-mailing/src/delivering/strategies/postmark/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/postmark/env.ts#L12)
13
13
 
14
14
  API key for the Postmark delivery service.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const POSTMARK_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/postmark/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/postmark/env.ts#L19)
12
+ Defined in: [platform-mailing/src/delivering/strategies/postmark/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/postmark/env.ts#L19)
13
13
 
14
14
  Configuration entries required by the Postmark delivery provider.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const RESEND_API_KEY: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/resend/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/resend/env.ts#L12)
12
+ Defined in: [platform-mailing/src/delivering/strategies/resend/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/resend/env.ts#L12)
13
13
 
14
14
  API key for the Resend delivery service.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const RESEND_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/resend/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/resend/env.ts#L19)
12
+ Defined in: [platform-mailing/src/delivering/strategies/resend/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/resend/env.ts#L19)
13
13
 
14
14
  Configuration entries required by the Resend delivery provider.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const SENDGRID_API_KEY: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/sendgrid/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/sendgrid/env.ts#L12)
12
+ Defined in: [platform-mailing/src/delivering/strategies/sendgrid/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/sendgrid/env.ts#L12)
13
13
 
14
14
  API key for the SendGrid delivery service.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const SENDGRID_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/sendgrid/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/sendgrid/env.ts#L19)
12
+ Defined in: [platform-mailing/src/delivering/strategies/sendgrid/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/sendgrid/env.ts#L19)
13
13
 
14
14
  Configuration entries required by the SendGrid delivery provider.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const SMTP_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/smtp/env.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/smtp/env.ts#L31)
12
+ Defined in: [platform-mailing/src/delivering/strategies/smtp/env.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/smtp/env.ts#L31)
13
13
 
14
14
  Configuration entries required by the SMTP delivery provider.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const SMTP_HOST: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/smtp/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/smtp/env.ts#L12)
12
+ Defined in: [platform-mailing/src/delivering/strategies/smtp/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/smtp/env.ts#L12)
13
13
 
14
14
  SMTP server host.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const SMTP_PASSWORD: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/smtp/env.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/smtp/env.ts#L24)
12
+ Defined in: [platform-mailing/src/delivering/strategies/smtp/env.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/smtp/env.ts#L24)
13
13
 
14
14
  SMTP authentication password.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const SMTP_PORT: IConfigKey<number>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/smtp/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/smtp/env.ts#L15)
12
+ Defined in: [platform-mailing/src/delivering/strategies/smtp/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/smtp/env.ts#L15)
13
13
 
14
14
  SMTP server port.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const SMTP_SECURE: IConfigKey<boolean>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/smtp/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/smtp/env.ts#L18)
12
+ Defined in: [platform-mailing/src/delivering/strategies/smtp/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/smtp/env.ts#L18)
13
13
 
14
14
  Whether the SMTP connection uses TLS.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const SMTP_USER: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [platform-mailing/src/smtp/env.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/smtp/env.ts#L21)
12
+ Defined in: [platform-mailing/src/delivering/strategies/smtp/env.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/smtp/env.ts#L21)
13
13
 
14
14
  SMTP authentication username.
@@ -9,8 +9,11 @@ editUrl: false
9
9
 
10
10
  | Class | Description |
11
11
  | ------ | ------ |
12
+ | [BlobTemplateFetchStrategy](Class.BlobTemplateFetchStrategy) | The `BlobTemplateFetchStrategy` class. |
12
13
  | [DatabaseTemplateFetchStrategy](Class.DatabaseTemplateFetchStrategy) | Template fetch strategy that loads templates from a database via the [IMailTemplateRepository](Interface.IMailTemplateRepository) port. |
13
14
  | [DeliveryStrategyBase](Class.DeliveryStrategyBase) | Represents the base class for all email delivery strategies. |
15
+ | [FileTemplateFetchStrategy](Class.FileTemplateFetchStrategy) | The `FileTemplateFetchStrategy` class. |
16
+ | [LogDeliveryStrategy](Class.LogDeliveryStrategy) | The `LogDeliveryStrategy` class. |
14
17
  | [MailDeliveryError](Class.MailDeliveryError) | Domain error thrown when email delivery fails. |
15
18
  | [MailgunDeliveryStrategy](Class.MailgunDeliveryStrategy) | Delivers emails via the Mailgun API. |
16
19
  | [MailHealthIndicator](Class.MailHealthIndicator) | Health indicator for mail service. |
@@ -47,7 +50,6 @@ editUrl: false
47
50
  | Variable | Description |
48
51
  | ------ | ------ |
49
52
  | [ALLOWED\_ATTACHMENT\_MIME\_TYPES](Variable.ALLOWED_ATTACHMENT_MIME_TYPES) | Allowed MIME types for email attachments. |
50
- | [MAIL\_DELIVERY\_STRATEGY](Variable.MAIL_DELIVERY_STRATEGY) | Which delivery strategy to use (e.g. `smtp`, `postmark`, `resend`, `sendgrid`, `mailgun`, `log`). |
51
53
  | [MAIL\_DELIVERY\_STRATEGY\_TOKEN](Variable.MAIL_DELIVERY_STRATEGY_TOKEN) | - |
52
54
  | [MAIL\_HOST](Variable.MAIL_HOST) | Mail host checked by the health indicator. |
53
55
  | [MAIL\_MAILGUN\_API\_KEY](Variable.MAIL_MAILGUN_API_KEY) | API key for the Mailgun delivery service. |
@@ -64,8 +66,8 @@ editUrl: false
64
66
  | [MAIL\_SMTP\_USER](Variable.MAIL_SMTP_USER) | SMTP authentication username. |
65
67
  | [MAIL\_TEMPLATE\_ENGINE\_FORMAT](Variable.MAIL_TEMPLATE_ENGINE_FORMAT) | Template engine format identifier (e.g. `handlebars`). |
66
68
  | [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. |
69
+ | [MAIL\_TEMPLATE\_NAMES\_TOKEN](Variable.MAIL_TEMPLATE_NAMES_TOKEN) | - |
67
70
  | [MAIL\_TEMPLATE\_REPOSITORY\_TOKEN](Variable.MAIL_TEMPLATE_REPOSITORY_TOKEN) | - |
68
- | [MAIL\_TEMPLATE\_STRATEGY](Variable.MAIL_TEMPLATE_STRATEGY) | Which template-fetch strategy to use (e.g. `file`, `blob`). |
69
71
  | [MAIL\_USER](Variable.MAIL_USER) | Mail user checked by the health indicator. |
70
72
  | [MAILGUN\_API\_KEY](Variable.MAILGUN_API_KEY) | API key for the Mailgun delivery service. |
71
73
  | [MAILGUN\_CONFIG\_ENTRIES](Variable.MAILGUN_CONFIG_ENTRIES) | Configuration entries required by the Mailgun delivery provider. |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@breadstone/archipel-mcp",
3
- "version": "0.0.33",
3
+ "version": "0.0.35",
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",
@@ -1,14 +0,0 @@
1
- ---
2
- title: 'Variable: MAIL\_DELIVERY\_STRATEGY'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Variable: MAIL\_DELIVERY\_STRATEGY
7
-
8
- ```ts
9
- const MAIL_DELIVERY_STRATEGY: IConfigKey<string>;
10
- ```
11
-
12
- Defined in: [platform-mailing/src/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L15)
13
-
14
- Which delivery strategy to use (e.g. `smtp`, `postmark`, `resend`, `sendgrid`, `mailgun`, `log`).
@@ -1,14 +0,0 @@
1
- ---
2
- title: 'Variable: MAIL\_TEMPLATE\_STRATEGY'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Variable: MAIL\_TEMPLATE\_STRATEGY
7
-
8
- ```ts
9
- const MAIL_TEMPLATE_STRATEGY: IConfigKey<string>;
10
- ```
11
-
12
- Defined in: [platform-mailing/src/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L12)
13
-
14
- Which template-fetch strategy to use (e.g. `file`, `blob`).