@application-kit/mailer 0.0.0-stage → 0.0.0

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 (176) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +74 -2
  3. package/dist/cjs/application/errors/index.d.ts +1 -0
  4. package/dist/cjs/application/errors/index.js +17 -0
  5. package/dist/cjs/application/errors/send-email.error.d.ts +8 -0
  6. package/dist/cjs/application/errors/send-email.error.js +12 -0
  7. package/dist/cjs/application/index.d.ts +3 -0
  8. package/dist/cjs/application/index.js +19 -0
  9. package/dist/cjs/application/ports/email-sender.interface.d.ts +14 -0
  10. package/dist/cjs/application/ports/email-sender.interface.js +2 -0
  11. package/dist/cjs/application/ports/email-subscriptions.interface.d.ts +10 -0
  12. package/dist/cjs/application/ports/email-subscriptions.interface.js +2 -0
  13. package/dist/cjs/application/ports/email-template-catalog.interface.d.ts +8 -0
  14. package/dist/cjs/application/ports/email-template-catalog.interface.js +2 -0
  15. package/dist/cjs/application/ports/email-template-renderer.interface.d.ts +9 -0
  16. package/dist/cjs/application/ports/email-template-renderer.interface.js +2 -0
  17. package/dist/cjs/application/ports/index.d.ts +7 -0
  18. package/dist/cjs/application/ports/index.js +23 -0
  19. package/dist/cjs/application/ports/mailer-logger.interface.d.ts +5 -0
  20. package/dist/cjs/application/ports/mailer-logger.interface.js +2 -0
  21. package/dist/cjs/application/ports/mailer.interface.d.ts +9 -0
  22. package/dist/cjs/application/ports/mailer.interface.js +2 -0
  23. package/dist/cjs/application/ports/sent-email-log.interface.d.ts +4 -0
  24. package/dist/cjs/application/ports/sent-email-log.interface.js +2 -0
  25. package/dist/cjs/application/services/email-dispatcher.service.d.ts +12 -0
  26. package/dist/cjs/application/services/email-dispatcher.service.js +56 -0
  27. package/dist/cjs/application/services/email-idempotency-key.service.d.ts +4 -0
  28. package/dist/cjs/application/services/email-idempotency-key.service.js +24 -0
  29. package/dist/cjs/application/services/email-sender.service.d.ts +17 -0
  30. package/dist/cjs/application/services/email-sender.service.js +69 -0
  31. package/dist/cjs/application/services/index.d.ts +3 -0
  32. package/dist/cjs/application/services/index.js +19 -0
  33. package/dist/cjs/configs/envs/index.d.ts +1 -0
  34. package/dist/cjs/configs/envs/index.js +17 -0
  35. package/dist/cjs/configs/envs/mailer.environment.d.ts +7 -0
  36. package/dist/cjs/configs/envs/mailer.environment.js +48 -0
  37. package/dist/cjs/configs/index.d.ts +2 -0
  38. package/dist/cjs/configs/index.js +18 -0
  39. package/dist/cjs/configs/mailer.config.d.ts +15 -0
  40. package/dist/cjs/configs/mailer.config.js +41 -0
  41. package/dist/cjs/constants.d.ts +7 -0
  42. package/dist/cjs/constants.js +10 -0
  43. package/dist/cjs/index.d.ts +6 -0
  44. package/dist/cjs/index.js +22 -0
  45. package/dist/cjs/infrastructure/adapters/index.d.ts +3 -0
  46. package/dist/cjs/infrastructure/adapters/index.js +19 -0
  47. package/dist/cjs/infrastructure/adapters/interpolating-email-template-renderer.d.ts +7 -0
  48. package/dist/cjs/infrastructure/adapters/interpolating-email-template-renderer.js +52 -0
  49. package/dist/cjs/infrastructure/adapters/json-mailer.adapter.d.ts +7 -0
  50. package/dist/cjs/infrastructure/adapters/json-mailer.adapter.js +28 -0
  51. package/dist/cjs/infrastructure/adapters/smtp-mailer.adapter.d.ts +8 -0
  52. package/dist/cjs/infrastructure/adapters/smtp-mailer.adapter.js +44 -0
  53. package/dist/cjs/infrastructure/database/index.d.ts +1 -0
  54. package/dist/cjs/infrastructure/database/index.js +17 -0
  55. package/dist/cjs/infrastructure/database/typeorm/entities/index.d.ts +1 -0
  56. package/dist/cjs/infrastructure/database/typeorm/entities/index.js +17 -0
  57. package/dist/cjs/infrastructure/database/typeorm/entities/sent-email.entity.d.ts +4 -0
  58. package/dist/cjs/infrastructure/database/typeorm/entities/sent-email.entity.js +30 -0
  59. package/dist/cjs/infrastructure/database/typeorm/index.d.ts +3 -0
  60. package/dist/cjs/infrastructure/database/typeorm/index.js +19 -0
  61. package/dist/cjs/infrastructure/database/typeorm/migrations/add-sent-emails.migration.d.ts +6 -0
  62. package/dist/cjs/infrastructure/database/typeorm/migrations/add-sent-emails.migration.js +13 -0
  63. package/dist/cjs/infrastructure/database/typeorm/migrations/index.d.ts +1 -0
  64. package/dist/cjs/infrastructure/database/typeorm/migrations/index.js +17 -0
  65. package/dist/cjs/infrastructure/database/typeorm/repositories/index.d.ts +1 -0
  66. package/dist/cjs/infrastructure/database/typeorm/repositories/index.js +17 -0
  67. package/dist/cjs/infrastructure/database/typeorm/repositories/sent-email-log.repository.d.ts +9 -0
  68. package/dist/cjs/infrastructure/database/typeorm/repositories/sent-email-log.repository.js +44 -0
  69. package/dist/cjs/infrastructure/index.d.ts +2 -0
  70. package/dist/cjs/infrastructure/index.js +18 -0
  71. package/dist/cjs/mailer-logger.d.ts +5 -0
  72. package/dist/cjs/mailer-logger.js +59 -0
  73. package/dist/cjs/mailer.module.d.ts +9 -0
  74. package/dist/cjs/mailer.module.js +55 -0
  75. package/dist/cjs/package.json +3 -0
  76. package/dist/cjs/testing/email-sender.fake.d.ts +7 -0
  77. package/dist/cjs/testing/email-sender.fake.js +15 -0
  78. package/dist/cjs/testing/email-subscriptions.fake.d.ts +6 -0
  79. package/dist/cjs/testing/email-subscriptions.fake.js +15 -0
  80. package/dist/cjs/testing/email-template-catalog.fake.d.ts +11 -0
  81. package/dist/cjs/testing/email-template-catalog.fake.js +15 -0
  82. package/dist/cjs/testing/email-template-renderer.fake.d.ts +12 -0
  83. package/dist/cjs/testing/email-template-renderer.fake.js +19 -0
  84. package/dist/cjs/testing/index.d.ts +6 -0
  85. package/dist/cjs/testing/index.js +22 -0
  86. package/dist/cjs/testing/mailer.fake.d.ts +8 -0
  87. package/dist/cjs/testing/mailer.fake.js +21 -0
  88. package/dist/cjs/testing/sent-email-log.fake.d.ts +8 -0
  89. package/dist/cjs/testing/sent-email-log.fake.js +26 -0
  90. package/dist/esm/application/errors/index.d.ts +1 -0
  91. package/dist/esm/application/errors/index.js +1 -0
  92. package/dist/esm/application/errors/send-email.error.d.ts +8 -0
  93. package/dist/esm/application/errors/send-email.error.js +8 -0
  94. package/dist/esm/application/index.d.ts +3 -0
  95. package/dist/esm/application/index.js +3 -0
  96. package/dist/esm/application/ports/email-sender.interface.d.ts +14 -0
  97. package/dist/esm/application/ports/email-sender.interface.js +1 -0
  98. package/dist/esm/application/ports/email-subscriptions.interface.d.ts +10 -0
  99. package/dist/esm/application/ports/email-subscriptions.interface.js +1 -0
  100. package/dist/esm/application/ports/email-template-catalog.interface.d.ts +8 -0
  101. package/dist/esm/application/ports/email-template-catalog.interface.js +1 -0
  102. package/dist/esm/application/ports/email-template-renderer.interface.d.ts +9 -0
  103. package/dist/esm/application/ports/email-template-renderer.interface.js +1 -0
  104. package/dist/esm/application/ports/index.d.ts +7 -0
  105. package/dist/esm/application/ports/index.js +7 -0
  106. package/dist/esm/application/ports/mailer-logger.interface.d.ts +5 -0
  107. package/dist/esm/application/ports/mailer-logger.interface.js +1 -0
  108. package/dist/esm/application/ports/mailer.interface.d.ts +9 -0
  109. package/dist/esm/application/ports/mailer.interface.js +1 -0
  110. package/dist/esm/application/ports/sent-email-log.interface.d.ts +4 -0
  111. package/dist/esm/application/ports/sent-email-log.interface.js +1 -0
  112. package/dist/esm/application/services/email-dispatcher.service.d.ts +12 -0
  113. package/dist/esm/application/services/email-dispatcher.service.js +53 -0
  114. package/dist/esm/application/services/email-idempotency-key.service.d.ts +4 -0
  115. package/dist/esm/application/services/email-idempotency-key.service.js +21 -0
  116. package/dist/esm/application/services/email-sender.service.d.ts +17 -0
  117. package/dist/esm/application/services/email-sender.service.js +66 -0
  118. package/dist/esm/application/services/index.d.ts +3 -0
  119. package/dist/esm/application/services/index.js +3 -0
  120. package/dist/esm/configs/envs/index.d.ts +1 -0
  121. package/dist/esm/configs/envs/index.js +1 -0
  122. package/dist/esm/configs/envs/mailer.environment.d.ts +7 -0
  123. package/dist/esm/configs/envs/mailer.environment.js +44 -0
  124. package/dist/esm/configs/index.d.ts +2 -0
  125. package/dist/esm/configs/index.js +2 -0
  126. package/dist/esm/configs/mailer.config.d.ts +15 -0
  127. package/dist/esm/configs/mailer.config.js +38 -0
  128. package/dist/esm/constants.d.ts +7 -0
  129. package/dist/esm/constants.js +7 -0
  130. package/dist/esm/index.d.ts +6 -0
  131. package/dist/esm/index.js +6 -0
  132. package/dist/esm/infrastructure/adapters/index.d.ts +3 -0
  133. package/dist/esm/infrastructure/adapters/index.js +3 -0
  134. package/dist/esm/infrastructure/adapters/interpolating-email-template-renderer.d.ts +7 -0
  135. package/dist/esm/infrastructure/adapters/interpolating-email-template-renderer.js +49 -0
  136. package/dist/esm/infrastructure/adapters/json-mailer.adapter.d.ts +7 -0
  137. package/dist/esm/infrastructure/adapters/json-mailer.adapter.js +25 -0
  138. package/dist/esm/infrastructure/adapters/smtp-mailer.adapter.d.ts +8 -0
  139. package/dist/esm/infrastructure/adapters/smtp-mailer.adapter.js +41 -0
  140. package/dist/esm/infrastructure/database/index.d.ts +1 -0
  141. package/dist/esm/infrastructure/database/index.js +1 -0
  142. package/dist/esm/infrastructure/database/typeorm/entities/index.d.ts +1 -0
  143. package/dist/esm/infrastructure/database/typeorm/entities/index.js +1 -0
  144. package/dist/esm/infrastructure/database/typeorm/entities/sent-email.entity.d.ts +4 -0
  145. package/dist/esm/infrastructure/database/typeorm/entities/sent-email.entity.js +27 -0
  146. package/dist/esm/infrastructure/database/typeorm/index.d.ts +3 -0
  147. package/dist/esm/infrastructure/database/typeorm/index.js +3 -0
  148. package/dist/esm/infrastructure/database/typeorm/migrations/add-sent-emails.migration.d.ts +6 -0
  149. package/dist/esm/infrastructure/database/typeorm/migrations/add-sent-emails.migration.js +9 -0
  150. package/dist/esm/infrastructure/database/typeorm/migrations/index.d.ts +1 -0
  151. package/dist/esm/infrastructure/database/typeorm/migrations/index.js +1 -0
  152. package/dist/esm/infrastructure/database/typeorm/repositories/index.d.ts +1 -0
  153. package/dist/esm/infrastructure/database/typeorm/repositories/index.js +1 -0
  154. package/dist/esm/infrastructure/database/typeorm/repositories/sent-email-log.repository.d.ts +9 -0
  155. package/dist/esm/infrastructure/database/typeorm/repositories/sent-email-log.repository.js +41 -0
  156. package/dist/esm/infrastructure/index.d.ts +2 -0
  157. package/dist/esm/infrastructure/index.js +2 -0
  158. package/dist/esm/mailer-logger.d.ts +5 -0
  159. package/dist/esm/mailer-logger.js +23 -0
  160. package/dist/esm/mailer.module.d.ts +9 -0
  161. package/dist/esm/mailer.module.js +52 -0
  162. package/dist/esm/testing/email-sender.fake.d.ts +7 -0
  163. package/dist/esm/testing/email-sender.fake.js +11 -0
  164. package/dist/esm/testing/email-subscriptions.fake.d.ts +6 -0
  165. package/dist/esm/testing/email-subscriptions.fake.js +11 -0
  166. package/dist/esm/testing/email-template-catalog.fake.d.ts +11 -0
  167. package/dist/esm/testing/email-template-catalog.fake.js +11 -0
  168. package/dist/esm/testing/email-template-renderer.fake.d.ts +12 -0
  169. package/dist/esm/testing/email-template-renderer.fake.js +15 -0
  170. package/dist/esm/testing/index.d.ts +6 -0
  171. package/dist/esm/testing/index.js +6 -0
  172. package/dist/esm/testing/mailer.fake.d.ts +8 -0
  173. package/dist/esm/testing/mailer.fake.js +17 -0
  174. package/dist/esm/testing/sent-email-log.fake.d.ts +8 -0
  175. package/dist/esm/testing/sent-email-log.fake.js +22 -0
  176. package/package.json +96 -3
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 application-kit
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,75 @@
1
- # Temporary Holding Version
1
+ # @application-kit/mailer
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Отправка писем по шаблонам для NestJS: рендер с подстановкой параметров, SMTP через `nodemailer` или дамп письма в
4
+ лог, идемпотентность по журналу отправленных писем (таблица `sent_emails`) и гейт подписок получателя. Какие письма
5
+ бывают, их тексты, языки и категории подписок пакет не знает — их приносит приложение.
6
+
7
+ ## Установка
8
+
9
+ ```sh
10
+ yarn add @application-kit/mailer
11
+ ```
12
+
13
+ Peer-зависимости: `@libs-for-dev/nestjs-config-module`, `@nestjs/common`, `@nestjs/typeorm`, `class-transformer`,
14
+ `class-validator`, `nestjs-pino`, `oxide.ts`, `typeorm`.
15
+
16
+ ## Подключение
17
+
18
+ ```ts
19
+ import { MailerModule } from '@application-kit/mailer'
20
+
21
+ @Module({
22
+ imports: [MailerModule.register({ subscriptions: NotificationPreferencesModule, templates: EmailTemplateCatalog })],
23
+ providers: [AccountEmailsService],
24
+ })
25
+ class AccountConsumersModule {}
26
+ ```
27
+
28
+ - `templates` — класс каталога (`EmailTemplateCatalogInterface`): по имени письма и локали отдаёт тему и обе половины
29
+ тела с плейсхолдерами `{параметр}`. Имя и локаль для пакета — строки; набор имён и языков держит тип каталога.
30
+ - `subscriptions` — модуль владельца настроек, экспортирующий `EMAIL_SUBSCRIPTIONS_PORT`
31
+ (`EmailSubscriptionsInterface`).
32
+ - `MAILER_LOGGER` приложение приносит глобально, например из корневого модуля:
33
+ `{ provide: MAILER_LOGGER, useClass: MailerLogger }` (`MailerLogger` — реализация на `nestjs-pino`, нужен глобальный
34
+ `LoggerModule`).
35
+
36
+ Наружу модуль отдаёт `EmailDispatcherService` с политикой отказа на выбор письма: `sendOrRethrow` (отказ пробрасывается —
37
+ обработчик события уйдёт в retry), `sendOrLog` (отказ только в лог) и `sendIfSubscribed` (письмо необязательной
38
+ категории уходит, только если получатель от неё не отписался).
39
+
40
+ Категории подписок объявляются module augmentation:
41
+
42
+ ```ts
43
+ declare module '@application-kit/mailer' {
44
+ interface EmailCategoryRegistryInterface { NEWSLETTER: true }
45
+ }
46
+ ```
47
+
48
+ ## Окружение
49
+
50
+ | Переменная | По умолчанию | Смысл |
51
+ |---|---|---|
52
+ | `MAIL_FROM` | `no-reply@localhost` | адрес в поле `From` |
53
+ | `MAIL_SMTP_HOST` | пусто | SMTP-релей; пусто — режим без сети, письмо целиком уходит warning'ом в лог |
54
+ | `MAIL_SMTP_PORT` | `587` | на `465` — неявный TLS, на остальных обязателен STARTTLS |
55
+ | `MAIL_SMTP_USER`, `MAIL_SMTP_PASSWORD` | пусто | учётка релея; пустой пользователь — без аутентификации |
56
+
57
+ Окружение валидируется в `MailerModule.register`, то есть при сборке графа процесса, а не на импорте пакета.
58
+
59
+ ## Миграция и сущность
60
+
61
+ Таблицу журнала создаёт миграция пакета. Приложение подключает её и сущность классами — так один путь работает и в dev,
62
+ и в собранном образе, а `migration:generate` не предлагает удалить таблицу:
63
+
64
+ ```ts
65
+ import { AddSentEmails1790231050588, SentEmailEntity } from '@application-kit/mailer'
66
+
67
+ new DataSource({ entities: [..., SentEmailEntity], migrations: [..., AddSentEmails1790231050588] })
68
+ ```
69
+
70
+ Имя класса миграции записано в таблице `migrations` уже мигрированных баз и не меняется.
71
+
72
+ ## Тесты потребителя
73
+
74
+ Вход `@application-kit/mailer/testing` — фейки портов: `FakeEmailSender`, `FakeEmailSubscriptions`,
75
+ `FakeEmailTemplateCatalog`, `FakeEmailTemplateRenderer`, `FakeMailer`, `FakeSentEmailLog`.
@@ -0,0 +1 @@
1
+ export * from './send-email.error.js';
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./send-email.error.js"), exports);
@@ -0,0 +1,8 @@
1
+ export interface SendEmailErrorContextInterface {
2
+ locale: string;
3
+ template: string;
4
+ }
5
+ export declare class SendEmailError extends Error {
6
+ readonly context: SendEmailErrorContextInterface;
7
+ constructor(context: SendEmailErrorContextInterface, options?: ErrorOptions);
8
+ }
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SendEmailError = void 0;
4
+ class SendEmailError extends Error {
5
+ context;
6
+ constructor(context, options) {
7
+ super(`Email delivery failed for template "${context.template}"`, options);
8
+ this.name = 'SendEmailError';
9
+ this.context = context;
10
+ }
11
+ }
12
+ exports.SendEmailError = SendEmailError;
@@ -0,0 +1,3 @@
1
+ export * from './errors/index.js';
2
+ export * from './ports/index.js';
3
+ export * from './services/index.js';
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./errors/index.js"), exports);
18
+ __exportStar(require("./ports/index.js"), exports);
19
+ __exportStar(require("./services/index.js"), exports);
@@ -0,0 +1,14 @@
1
+ import type { Result } from 'oxide.ts';
2
+ import type { SendEmailError } from '../errors/send-email.error.js';
3
+ import type { EmailTemplateParameters } from './email-template-renderer.interface.js';
4
+ export interface EmailSenderInterface {
5
+ send(request: SendEmailRequestInterface): Promise<SendEmailResult>;
6
+ }
7
+ export interface SendEmailRequestInterface {
8
+ readonly idempotencyMaterial: readonly string[];
9
+ readonly locale: string;
10
+ readonly parameters: EmailTemplateParameters;
11
+ readonly template: string;
12
+ readonly to: string;
13
+ }
14
+ export type SendEmailResult = Result<true, SendEmailError>;
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,10 @@
1
+ export type EmailCategory = keyof EmailCategoryRegistryInterface;
2
+ export interface EmailCategoryRegistryInterface {
3
+ }
4
+ export interface EmailSubscriptionInterface {
5
+ readonly accountId: string;
6
+ readonly category: EmailCategory;
7
+ }
8
+ export interface EmailSubscriptionsInterface {
9
+ isSubscribed(subscription: EmailSubscriptionInterface): Promise<boolean>;
10
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,8 @@
1
+ export interface EmailTemplateCatalogInterface {
2
+ get(name: string, locale: string): EmailTemplateInterface;
3
+ }
4
+ export interface EmailTemplateInterface {
5
+ readonly html: string;
6
+ readonly subject: string;
7
+ readonly text: string;
8
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ export type EmailTemplateParameters = Readonly<Record<string, string>>;
2
+ export interface EmailTemplateRendererInterface {
3
+ render(name: string, locale: string, parameters: EmailTemplateParameters): RenderedEmailInterface;
4
+ }
5
+ export interface RenderedEmailInterface {
6
+ readonly html: string;
7
+ readonly subject: string;
8
+ readonly text: string;
9
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,7 @@
1
+ export * from './email-sender.interface.js';
2
+ export * from './email-subscriptions.interface.js';
3
+ export * from './email-template-catalog.interface.js';
4
+ export * from './email-template-renderer.interface.js';
5
+ export * from './mailer-logger.interface.js';
6
+ export * from './mailer.interface.js';
7
+ export * from './sent-email-log.interface.js';
@@ -0,0 +1,23 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./email-sender.interface.js"), exports);
18
+ __exportStar(require("./email-subscriptions.interface.js"), exports);
19
+ __exportStar(require("./email-template-catalog.interface.js"), exports);
20
+ __exportStar(require("./email-template-renderer.interface.js"), exports);
21
+ __exportStar(require("./mailer-logger.interface.js"), exports);
22
+ __exportStar(require("./mailer.interface.js"), exports);
23
+ __exportStar(require("./sent-email-log.interface.js"), exports);
@@ -0,0 +1,5 @@
1
+ export interface MailerLoggerInterface {
2
+ error(context: unknown, message: string): void;
3
+ info(context: unknown, message: string): void;
4
+ warn(context: unknown, message: string): void;
5
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ export interface MailerInterface {
2
+ send(message: MailerMessageInterface): Promise<void>;
3
+ }
4
+ export interface MailerMessageInterface {
5
+ readonly html: string;
6
+ readonly subject: string;
7
+ readonly text: string;
8
+ readonly to: string;
9
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,4 @@
1
+ export interface SentEmailLogInterface {
2
+ claim(key: string): Promise<boolean>;
3
+ release(key: string): Promise<void>;
4
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,12 @@
1
+ import type { EmailSenderInterface, SendEmailRequestInterface } from '../ports/email-sender.interface.js';
2
+ import type { EmailSubscriptionInterface, EmailSubscriptionsInterface } from '../ports/email-subscriptions.interface.js';
3
+ import type { MailerLoggerInterface } from '../ports/mailer-logger.interface.js';
4
+ export declare class EmailDispatcherService {
5
+ private readonly emails;
6
+ private readonly logger;
7
+ private readonly subscriptions;
8
+ constructor(emails: EmailSenderInterface, logger: MailerLoggerInterface, subscriptions: EmailSubscriptionsInterface);
9
+ sendIfSubscribed(subscription: EmailSubscriptionInterface, request: SendEmailRequestInterface, failureMessage: string): Promise<void>;
10
+ sendOrLog(request: SendEmailRequestInterface, failureMessage: string): Promise<void>;
11
+ sendOrRethrow(request: SendEmailRequestInterface, failureMessage: string): Promise<void>;
12
+ }
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ var __param = (this && this.__param) || function (paramIndex, decorator) {
12
+ return function (target, key) { decorator(target, key, paramIndex); }
13
+ };
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.EmailDispatcherService = void 0;
16
+ const common_1 = require("@nestjs/common");
17
+ const constants_js_1 = require("../../constants.js");
18
+ let EmailDispatcherService = class EmailDispatcherService {
19
+ emails;
20
+ logger;
21
+ subscriptions;
22
+ constructor(emails, logger, subscriptions) {
23
+ this.emails = emails;
24
+ this.logger = logger;
25
+ this.subscriptions = subscriptions;
26
+ }
27
+ async sendIfSubscribed(subscription, request, failureMessage) {
28
+ if (!await this.subscriptions.isSubscribed(subscription)) {
29
+ return;
30
+ }
31
+ await this.sendOrLog(request, failureMessage);
32
+ }
33
+ async sendOrLog(request, failureMessage) {
34
+ const result = await this.emails.send(request);
35
+ if (result.isErr()) {
36
+ this.logger.error({ err: result.unwrapErr() }, failureMessage);
37
+ }
38
+ }
39
+ async sendOrRethrow(request, failureMessage) {
40
+ const result = await this.emails.send(request);
41
+ if (result.isOk()) {
42
+ return;
43
+ }
44
+ const error = result.unwrapErr();
45
+ this.logger.error({ err: error }, failureMessage);
46
+ throw error;
47
+ }
48
+ };
49
+ exports.EmailDispatcherService = EmailDispatcherService;
50
+ exports.EmailDispatcherService = EmailDispatcherService = __decorate([
51
+ (0, common_1.Injectable)(),
52
+ __param(0, (0, common_1.Inject)(constants_js_1.EMAIL_SENDER_PORT)),
53
+ __param(1, (0, common_1.Inject)(constants_js_1.MAILER_LOGGER)),
54
+ __param(2, (0, common_1.Inject)(constants_js_1.EMAIL_SUBSCRIPTIONS_PORT)),
55
+ __metadata("design:paramtypes", [Object, Object, Object])
56
+ ], EmailDispatcherService);
@@ -0,0 +1,4 @@
1
+ export declare const EMAIL_IDEMPOTENCY_KEY_MAX_LENGTH = 128;
2
+ export declare class EmailIdempotencyKeyService {
3
+ build(template: string, ...material: string[]): string;
4
+ }
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ exports.EmailIdempotencyKeyService = exports.EMAIL_IDEMPOTENCY_KEY_MAX_LENGTH = void 0;
10
+ const common_1 = require("@nestjs/common");
11
+ const node_crypto_1 = require("node:crypto");
12
+ exports.EMAIL_IDEMPOTENCY_KEY_MAX_LENGTH = 128;
13
+ const MATERIAL_SEPARATOR = String.fromCodePoint(0);
14
+ let EmailIdempotencyKeyService = class EmailIdempotencyKeyService {
15
+ build(template, ...material) {
16
+ const digest = (0, node_crypto_1.createHash)('sha256').update(material.join(MATERIAL_SEPARATOR))
17
+ .digest('hex');
18
+ return `${template}:${digest}`;
19
+ }
20
+ };
21
+ exports.EmailIdempotencyKeyService = EmailIdempotencyKeyService;
22
+ exports.EmailIdempotencyKeyService = EmailIdempotencyKeyService = __decorate([
23
+ (0, common_1.Injectable)()
24
+ ], EmailIdempotencyKeyService);
@@ -0,0 +1,17 @@
1
+ import type { EmailSenderInterface, SendEmailRequestInterface, SendEmailResult } from '../ports/email-sender.interface.js';
2
+ import type { EmailTemplateRendererInterface } from '../ports/email-template-renderer.interface.js';
3
+ import type { MailerLoggerInterface } from '../ports/mailer-logger.interface.js';
4
+ import type { MailerInterface } from '../ports/mailer.interface.js';
5
+ import type { SentEmailLogInterface } from '../ports/sent-email-log.interface.js';
6
+ import { EmailIdempotencyKeyService } from './email-idempotency-key.service.js';
7
+ export declare class EmailSenderService implements EmailSenderInterface {
8
+ private readonly mailer;
9
+ private readonly renderer;
10
+ private readonly sentEmails;
11
+ private readonly keys;
12
+ private readonly logger;
13
+ constructor(mailer: MailerInterface, renderer: EmailTemplateRendererInterface, sentEmails: SentEmailLogInterface, keys: EmailIdempotencyKeyService, logger: MailerLoggerInterface);
14
+ send(request: SendEmailRequestInterface): Promise<SendEmailResult>;
15
+ private failAndRelease;
16
+ private skipRepeat;
17
+ }
@@ -0,0 +1,69 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ var __param = (this && this.__param) || function (paramIndex, decorator) {
12
+ return function (target, key) { decorator(target, key, paramIndex); }
13
+ };
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.EmailSenderService = void 0;
16
+ const common_1 = require("@nestjs/common");
17
+ const oxide_ts_1 = require("oxide.ts");
18
+ const constants_js_1 = require("../../constants.js");
19
+ const send_email_error_js_1 = require("../errors/send-email.error.js");
20
+ const email_idempotency_key_service_js_1 = require("./email-idempotency-key.service.js");
21
+ let EmailSenderService = class EmailSenderService {
22
+ mailer;
23
+ renderer;
24
+ sentEmails;
25
+ keys;
26
+ logger;
27
+ constructor(mailer, renderer, sentEmails, keys, logger) {
28
+ this.mailer = mailer;
29
+ this.renderer = renderer;
30
+ this.sentEmails = sentEmails;
31
+ this.keys = keys;
32
+ this.logger = logger;
33
+ }
34
+ async send(request) {
35
+ const idempotencyKey = this.keys.build(request.template, ...request.idempotencyMaterial);
36
+ const isClaimed = await this.sentEmails.claim(idempotencyKey);
37
+ if (!isClaimed) {
38
+ return this.skipRepeat(idempotencyKey);
39
+ }
40
+ const rendered = this.renderer.render(request.template, request.locale, request.parameters);
41
+ try {
42
+ await this.mailer.send({ ...rendered, to: request.to });
43
+ }
44
+ catch (error) {
45
+ return this.failAndRelease(request, idempotencyKey, error);
46
+ }
47
+ this.logger.info({ locale: request.locale, template: request.template, to: request.to }, 'Email handed to the transport');
48
+ return (0, oxide_ts_1.Ok)(true);
49
+ }
50
+ async failAndRelease(request, idempotencyKey, error) {
51
+ await this.sentEmails.release(idempotencyKey);
52
+ const failure = new send_email_error_js_1.SendEmailError({ locale: request.locale, template: request.template }, { cause: error });
53
+ this.logger.error(failure.context, failure.message);
54
+ return (0, oxide_ts_1.Err)(failure);
55
+ }
56
+ skipRepeat(idempotencyKey) {
57
+ this.logger.info({ idempotencyKey }, 'Email already sent for this idempotency key, skipping');
58
+ return (0, oxide_ts_1.Ok)(true);
59
+ }
60
+ };
61
+ exports.EmailSenderService = EmailSenderService;
62
+ exports.EmailSenderService = EmailSenderService = __decorate([
63
+ (0, common_1.Injectable)(),
64
+ __param(0, (0, common_1.Inject)(constants_js_1.MAILER_PORT)),
65
+ __param(1, (0, common_1.Inject)(constants_js_1.EMAIL_TEMPLATE_RENDERER_PORT)),
66
+ __param(2, (0, common_1.Inject)(constants_js_1.SENT_EMAIL_LOG_PORT)),
67
+ __param(4, (0, common_1.Inject)(constants_js_1.MAILER_LOGGER)),
68
+ __metadata("design:paramtypes", [Object, Object, Object, email_idempotency_key_service_js_1.EmailIdempotencyKeyService, Object])
69
+ ], EmailSenderService);
@@ -0,0 +1,3 @@
1
+ export * from './email-dispatcher.service.js';
2
+ export * from './email-idempotency-key.service.js';
3
+ export * from './email-sender.service.js';
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./email-dispatcher.service.js"), exports);
18
+ __exportStar(require("./email-idempotency-key.service.js"), exports);
19
+ __exportStar(require("./email-sender.service.js"), exports);
@@ -0,0 +1 @@
1
+ export * from './mailer.environment.js';
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./mailer.environment.js"), exports);
@@ -0,0 +1,7 @@
1
+ export declare class MailerEnvironment {
2
+ MAIL_FROM: string;
3
+ MAIL_SMTP_HOST: string;
4
+ MAIL_SMTP_PASSWORD: string;
5
+ MAIL_SMTP_PORT: number;
6
+ MAIL_SMTP_USER: string;
7
+ }
@@ -0,0 +1,48 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.MailerEnvironment = void 0;
13
+ const class_transformer_1 = require("class-transformer");
14
+ const class_validator_1 = require("class-validator");
15
+ class MailerEnvironment {
16
+ MAIL_FROM = 'no-reply@localhost';
17
+ MAIL_SMTP_HOST = '';
18
+ MAIL_SMTP_PASSWORD = '';
19
+ MAIL_SMTP_PORT = 587;
20
+ MAIL_SMTP_USER = '';
21
+ }
22
+ exports.MailerEnvironment = MailerEnvironment;
23
+ __decorate([
24
+ (0, class_transformer_1.Expose)(),
25
+ (0, class_validator_1.IsString)(),
26
+ __metadata("design:type", Object)
27
+ ], MailerEnvironment.prototype, "MAIL_FROM", void 0);
28
+ __decorate([
29
+ (0, class_transformer_1.Expose)(),
30
+ (0, class_validator_1.IsString)(),
31
+ __metadata("design:type", Object)
32
+ ], MailerEnvironment.prototype, "MAIL_SMTP_HOST", void 0);
33
+ __decorate([
34
+ (0, class_transformer_1.Expose)(),
35
+ (0, class_validator_1.IsString)(),
36
+ __metadata("design:type", Object)
37
+ ], MailerEnvironment.prototype, "MAIL_SMTP_PASSWORD", void 0);
38
+ __decorate([
39
+ (0, class_transformer_1.Expose)(),
40
+ (0, class_validator_1.IsNumber)(),
41
+ (0, class_transformer_1.Type)(() => Number),
42
+ __metadata("design:type", Object)
43
+ ], MailerEnvironment.prototype, "MAIL_SMTP_PORT", void 0);
44
+ __decorate([
45
+ (0, class_transformer_1.Expose)(),
46
+ (0, class_validator_1.IsString)(),
47
+ __metadata("design:type", Object)
48
+ ], MailerEnvironment.prototype, "MAIL_SMTP_USER", void 0);
@@ -0,0 +1,2 @@
1
+ export * from './envs/index.js';
2
+ export * from './mailer.config.js';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./envs/index.js"), exports);
18
+ __exportStar(require("./mailer.config.js"), exports);