@application-kit/mailer 0.0.0-stage → 0.1.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 (177) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +21 -0
  3. package/README.md +74 -2
  4. package/dist/cjs/application/errors/index.d.ts +1 -0
  5. package/dist/cjs/application/errors/index.js +17 -0
  6. package/dist/cjs/application/errors/send-email.error.d.ts +8 -0
  7. package/dist/cjs/application/errors/send-email.error.js +12 -0
  8. package/dist/cjs/application/index.d.ts +3 -0
  9. package/dist/cjs/application/index.js +19 -0
  10. package/dist/cjs/application/ports/email-sender.interface.d.ts +14 -0
  11. package/dist/cjs/application/ports/email-sender.interface.js +2 -0
  12. package/dist/cjs/application/ports/email-subscriptions.interface.d.ts +10 -0
  13. package/dist/cjs/application/ports/email-subscriptions.interface.js +2 -0
  14. package/dist/cjs/application/ports/email-template-catalog.interface.d.ts +8 -0
  15. package/dist/cjs/application/ports/email-template-catalog.interface.js +2 -0
  16. package/dist/cjs/application/ports/email-template-renderer.interface.d.ts +9 -0
  17. package/dist/cjs/application/ports/email-template-renderer.interface.js +2 -0
  18. package/dist/cjs/application/ports/index.d.ts +7 -0
  19. package/dist/cjs/application/ports/index.js +23 -0
  20. package/dist/cjs/application/ports/mailer-logger.interface.d.ts +5 -0
  21. package/dist/cjs/application/ports/mailer-logger.interface.js +2 -0
  22. package/dist/cjs/application/ports/mailer.interface.d.ts +9 -0
  23. package/dist/cjs/application/ports/mailer.interface.js +2 -0
  24. package/dist/cjs/application/ports/sent-email-log.interface.d.ts +4 -0
  25. package/dist/cjs/application/ports/sent-email-log.interface.js +2 -0
  26. package/dist/cjs/application/services/email-dispatcher.service.d.ts +12 -0
  27. package/dist/cjs/application/services/email-dispatcher.service.js +56 -0
  28. package/dist/cjs/application/services/email-idempotency-key.service.d.ts +4 -0
  29. package/dist/cjs/application/services/email-idempotency-key.service.js +24 -0
  30. package/dist/cjs/application/services/email-sender.service.d.ts +17 -0
  31. package/dist/cjs/application/services/email-sender.service.js +69 -0
  32. package/dist/cjs/application/services/index.d.ts +3 -0
  33. package/dist/cjs/application/services/index.js +19 -0
  34. package/dist/cjs/configs/envs/index.d.ts +1 -0
  35. package/dist/cjs/configs/envs/index.js +17 -0
  36. package/dist/cjs/configs/envs/mailer.environment.d.ts +7 -0
  37. package/dist/cjs/configs/envs/mailer.environment.js +48 -0
  38. package/dist/cjs/configs/index.d.ts +2 -0
  39. package/dist/cjs/configs/index.js +18 -0
  40. package/dist/cjs/configs/mailer.config.d.ts +15 -0
  41. package/dist/cjs/configs/mailer.config.js +41 -0
  42. package/dist/cjs/constants.d.ts +7 -0
  43. package/dist/cjs/constants.js +10 -0
  44. package/dist/cjs/index.d.ts +6 -0
  45. package/dist/cjs/index.js +22 -0
  46. package/dist/cjs/infrastructure/adapters/index.d.ts +3 -0
  47. package/dist/cjs/infrastructure/adapters/index.js +19 -0
  48. package/dist/cjs/infrastructure/adapters/interpolating-email-template-renderer.d.ts +7 -0
  49. package/dist/cjs/infrastructure/adapters/interpolating-email-template-renderer.js +52 -0
  50. package/dist/cjs/infrastructure/adapters/json-mailer.adapter.d.ts +7 -0
  51. package/dist/cjs/infrastructure/adapters/json-mailer.adapter.js +28 -0
  52. package/dist/cjs/infrastructure/adapters/smtp-mailer.adapter.d.ts +8 -0
  53. package/dist/cjs/infrastructure/adapters/smtp-mailer.adapter.js +44 -0
  54. package/dist/cjs/infrastructure/database/index.d.ts +1 -0
  55. package/dist/cjs/infrastructure/database/index.js +17 -0
  56. package/dist/cjs/infrastructure/database/typeorm/entities/index.d.ts +1 -0
  57. package/dist/cjs/infrastructure/database/typeorm/entities/index.js +17 -0
  58. package/dist/cjs/infrastructure/database/typeorm/entities/sent-email.entity.d.ts +4 -0
  59. package/dist/cjs/infrastructure/database/typeorm/entities/sent-email.entity.js +30 -0
  60. package/dist/cjs/infrastructure/database/typeorm/index.d.ts +3 -0
  61. package/dist/cjs/infrastructure/database/typeorm/index.js +19 -0
  62. package/dist/cjs/infrastructure/database/typeorm/migrations/add-sent-emails.migration.d.ts +6 -0
  63. package/dist/cjs/infrastructure/database/typeorm/migrations/add-sent-emails.migration.js +13 -0
  64. package/dist/cjs/infrastructure/database/typeorm/migrations/index.d.ts +1 -0
  65. package/dist/cjs/infrastructure/database/typeorm/migrations/index.js +17 -0
  66. package/dist/cjs/infrastructure/database/typeorm/repositories/index.d.ts +1 -0
  67. package/dist/cjs/infrastructure/database/typeorm/repositories/index.js +17 -0
  68. package/dist/cjs/infrastructure/database/typeorm/repositories/sent-email-log.repository.d.ts +9 -0
  69. package/dist/cjs/infrastructure/database/typeorm/repositories/sent-email-log.repository.js +44 -0
  70. package/dist/cjs/infrastructure/index.d.ts +2 -0
  71. package/dist/cjs/infrastructure/index.js +18 -0
  72. package/dist/cjs/mailer-logger.d.ts +5 -0
  73. package/dist/cjs/mailer-logger.js +59 -0
  74. package/dist/cjs/mailer.module.d.ts +9 -0
  75. package/dist/cjs/mailer.module.js +55 -0
  76. package/dist/cjs/package.json +3 -0
  77. package/dist/cjs/testing/email-sender.fake.d.ts +7 -0
  78. package/dist/cjs/testing/email-sender.fake.js +15 -0
  79. package/dist/cjs/testing/email-subscriptions.fake.d.ts +6 -0
  80. package/dist/cjs/testing/email-subscriptions.fake.js +15 -0
  81. package/dist/cjs/testing/email-template-catalog.fake.d.ts +11 -0
  82. package/dist/cjs/testing/email-template-catalog.fake.js +15 -0
  83. package/dist/cjs/testing/email-template-renderer.fake.d.ts +12 -0
  84. package/dist/cjs/testing/email-template-renderer.fake.js +19 -0
  85. package/dist/cjs/testing/index.d.ts +6 -0
  86. package/dist/cjs/testing/index.js +22 -0
  87. package/dist/cjs/testing/mailer.fake.d.ts +8 -0
  88. package/dist/cjs/testing/mailer.fake.js +21 -0
  89. package/dist/cjs/testing/sent-email-log.fake.d.ts +8 -0
  90. package/dist/cjs/testing/sent-email-log.fake.js +26 -0
  91. package/dist/esm/application/errors/index.d.ts +1 -0
  92. package/dist/esm/application/errors/index.js +1 -0
  93. package/dist/esm/application/errors/send-email.error.d.ts +8 -0
  94. package/dist/esm/application/errors/send-email.error.js +8 -0
  95. package/dist/esm/application/index.d.ts +3 -0
  96. package/dist/esm/application/index.js +3 -0
  97. package/dist/esm/application/ports/email-sender.interface.d.ts +14 -0
  98. package/dist/esm/application/ports/email-sender.interface.js +1 -0
  99. package/dist/esm/application/ports/email-subscriptions.interface.d.ts +10 -0
  100. package/dist/esm/application/ports/email-subscriptions.interface.js +1 -0
  101. package/dist/esm/application/ports/email-template-catalog.interface.d.ts +8 -0
  102. package/dist/esm/application/ports/email-template-catalog.interface.js +1 -0
  103. package/dist/esm/application/ports/email-template-renderer.interface.d.ts +9 -0
  104. package/dist/esm/application/ports/email-template-renderer.interface.js +1 -0
  105. package/dist/esm/application/ports/index.d.ts +7 -0
  106. package/dist/esm/application/ports/index.js +7 -0
  107. package/dist/esm/application/ports/mailer-logger.interface.d.ts +5 -0
  108. package/dist/esm/application/ports/mailer-logger.interface.js +1 -0
  109. package/dist/esm/application/ports/mailer.interface.d.ts +9 -0
  110. package/dist/esm/application/ports/mailer.interface.js +1 -0
  111. package/dist/esm/application/ports/sent-email-log.interface.d.ts +4 -0
  112. package/dist/esm/application/ports/sent-email-log.interface.js +1 -0
  113. package/dist/esm/application/services/email-dispatcher.service.d.ts +12 -0
  114. package/dist/esm/application/services/email-dispatcher.service.js +53 -0
  115. package/dist/esm/application/services/email-idempotency-key.service.d.ts +4 -0
  116. package/dist/esm/application/services/email-idempotency-key.service.js +21 -0
  117. package/dist/esm/application/services/email-sender.service.d.ts +17 -0
  118. package/dist/esm/application/services/email-sender.service.js +66 -0
  119. package/dist/esm/application/services/index.d.ts +3 -0
  120. package/dist/esm/application/services/index.js +3 -0
  121. package/dist/esm/configs/envs/index.d.ts +1 -0
  122. package/dist/esm/configs/envs/index.js +1 -0
  123. package/dist/esm/configs/envs/mailer.environment.d.ts +7 -0
  124. package/dist/esm/configs/envs/mailer.environment.js +44 -0
  125. package/dist/esm/configs/index.d.ts +2 -0
  126. package/dist/esm/configs/index.js +2 -0
  127. package/dist/esm/configs/mailer.config.d.ts +15 -0
  128. package/dist/esm/configs/mailer.config.js +38 -0
  129. package/dist/esm/constants.d.ts +7 -0
  130. package/dist/esm/constants.js +7 -0
  131. package/dist/esm/index.d.ts +6 -0
  132. package/dist/esm/index.js +6 -0
  133. package/dist/esm/infrastructure/adapters/index.d.ts +3 -0
  134. package/dist/esm/infrastructure/adapters/index.js +3 -0
  135. package/dist/esm/infrastructure/adapters/interpolating-email-template-renderer.d.ts +7 -0
  136. package/dist/esm/infrastructure/adapters/interpolating-email-template-renderer.js +49 -0
  137. package/dist/esm/infrastructure/adapters/json-mailer.adapter.d.ts +7 -0
  138. package/dist/esm/infrastructure/adapters/json-mailer.adapter.js +25 -0
  139. package/dist/esm/infrastructure/adapters/smtp-mailer.adapter.d.ts +8 -0
  140. package/dist/esm/infrastructure/adapters/smtp-mailer.adapter.js +41 -0
  141. package/dist/esm/infrastructure/database/index.d.ts +1 -0
  142. package/dist/esm/infrastructure/database/index.js +1 -0
  143. package/dist/esm/infrastructure/database/typeorm/entities/index.d.ts +1 -0
  144. package/dist/esm/infrastructure/database/typeorm/entities/index.js +1 -0
  145. package/dist/esm/infrastructure/database/typeorm/entities/sent-email.entity.d.ts +4 -0
  146. package/dist/esm/infrastructure/database/typeorm/entities/sent-email.entity.js +27 -0
  147. package/dist/esm/infrastructure/database/typeorm/index.d.ts +3 -0
  148. package/dist/esm/infrastructure/database/typeorm/index.js +3 -0
  149. package/dist/esm/infrastructure/database/typeorm/migrations/add-sent-emails.migration.d.ts +6 -0
  150. package/dist/esm/infrastructure/database/typeorm/migrations/add-sent-emails.migration.js +9 -0
  151. package/dist/esm/infrastructure/database/typeorm/migrations/index.d.ts +1 -0
  152. package/dist/esm/infrastructure/database/typeorm/migrations/index.js +1 -0
  153. package/dist/esm/infrastructure/database/typeorm/repositories/index.d.ts +1 -0
  154. package/dist/esm/infrastructure/database/typeorm/repositories/index.js +1 -0
  155. package/dist/esm/infrastructure/database/typeorm/repositories/sent-email-log.repository.d.ts +9 -0
  156. package/dist/esm/infrastructure/database/typeorm/repositories/sent-email-log.repository.js +41 -0
  157. package/dist/esm/infrastructure/index.d.ts +2 -0
  158. package/dist/esm/infrastructure/index.js +2 -0
  159. package/dist/esm/mailer-logger.d.ts +5 -0
  160. package/dist/esm/mailer-logger.js +23 -0
  161. package/dist/esm/mailer.module.d.ts +9 -0
  162. package/dist/esm/mailer.module.js +52 -0
  163. package/dist/esm/testing/email-sender.fake.d.ts +7 -0
  164. package/dist/esm/testing/email-sender.fake.js +11 -0
  165. package/dist/esm/testing/email-subscriptions.fake.d.ts +6 -0
  166. package/dist/esm/testing/email-subscriptions.fake.js +11 -0
  167. package/dist/esm/testing/email-template-catalog.fake.d.ts +11 -0
  168. package/dist/esm/testing/email-template-catalog.fake.js +11 -0
  169. package/dist/esm/testing/email-template-renderer.fake.d.ts +12 -0
  170. package/dist/esm/testing/email-template-renderer.fake.js +15 -0
  171. package/dist/esm/testing/index.d.ts +6 -0
  172. package/dist/esm/testing/index.js +6 -0
  173. package/dist/esm/testing/mailer.fake.d.ts +8 -0
  174. package/dist/esm/testing/mailer.fake.js +17 -0
  175. package/dist/esm/testing/sent-email-log.fake.d.ts +8 -0
  176. package/dist/esm/testing/sent-email-log.fake.js +22 -0
  177. package/package.json +96 -3
@@ -0,0 +1,15 @@
1
+ export class FakeEmailTemplateRenderer {
2
+ requests = [];
3
+ rendered = {
4
+ html: '<p>rendered html</p>',
5
+ subject: 'rendered subject',
6
+ text: 'rendered text',
7
+ };
8
+ render(name, locale, parameters) {
9
+ this.requests.push({ locale, name, parameters });
10
+ return this.rendered;
11
+ }
12
+ returns(rendered) {
13
+ this.rendered = rendered;
14
+ }
15
+ }
@@ -0,0 +1,6 @@
1
+ export * from './email-sender.fake.js';
2
+ export * from './email-subscriptions.fake.js';
3
+ export * from './email-template-catalog.fake.js';
4
+ export * from './email-template-renderer.fake.js';
5
+ export * from './mailer.fake.js';
6
+ export * from './sent-email-log.fake.js';
@@ -0,0 +1,6 @@
1
+ export * from './email-sender.fake.js';
2
+ export * from './email-subscriptions.fake.js';
3
+ export * from './email-template-catalog.fake.js';
4
+ export * from './email-template-renderer.fake.js';
5
+ export * from './mailer.fake.js';
6
+ export * from './sent-email-log.fake.js';
@@ -0,0 +1,8 @@
1
+ import type { MailerInterface, MailerMessageInterface } from '../application/ports/mailer.interface.js';
2
+ export declare class FakeMailer implements MailerInterface {
3
+ readonly sent: MailerMessageInterface[];
4
+ private failure;
5
+ failWith(error: Error): void;
6
+ recover(): void;
7
+ send(message: MailerMessageInterface): Promise<void>;
8
+ }
@@ -0,0 +1,17 @@
1
+ export class FakeMailer {
2
+ sent = [];
3
+ failure = undefined;
4
+ failWith(error) {
5
+ this.failure = error;
6
+ }
7
+ recover() {
8
+ this.failure = undefined;
9
+ }
10
+ async send(message) {
11
+ await Promise.resolve();
12
+ if (this.failure !== undefined) {
13
+ throw this.failure;
14
+ }
15
+ this.sent.push(message);
16
+ }
17
+ }
@@ -0,0 +1,8 @@
1
+ import type { SentEmailLogInterface } from '../application/ports/sent-email-log.interface.js';
2
+ export declare class FakeSentEmailLog implements SentEmailLogInterface {
3
+ readonly claimed: Set<string>;
4
+ private failure;
5
+ claim(key: string): Promise<boolean>;
6
+ failWith(error: Error): void;
7
+ release(key: string): Promise<void>;
8
+ }
@@ -0,0 +1,22 @@
1
+ export class FakeSentEmailLog {
2
+ claimed = new Set();
3
+ failure = undefined;
4
+ async claim(key) {
5
+ await Promise.resolve();
6
+ if (this.failure !== undefined) {
7
+ throw this.failure;
8
+ }
9
+ if (this.claimed.has(key)) {
10
+ return false;
11
+ }
12
+ this.claimed.add(key);
13
+ return true;
14
+ }
15
+ failWith(error) {
16
+ this.failure = error;
17
+ }
18
+ async release(key) {
19
+ await Promise.resolve();
20
+ this.claimed.delete(key);
21
+ }
22
+ }
package/package.json CHANGED
@@ -1,6 +1,99 @@
1
1
  {
2
2
  "name": "@application-kit/mailer",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
3
+ "version": "0.1.0",
4
+ "description": "Отправка писем по шаблонам для NestJS: SMTP или дамп в лог, идемпотентность по журналу отправленного, гейт подписок; шаблоны и тексты приносит приложение",
5
+ "keywords": [
6
+ "email",
7
+ "mailer",
8
+ "nestjs",
9
+ "nodemailer"
10
+ ],
11
+ "homepage": "https://gitlab.com/application-kit/application-kit/-/tree/main/packages/mailer",
12
+ "bugs": "https://gitlab.com/application-kit/application-kit/-/issues",
13
+ "repository": {
14
+ "type": "git",
15
+ "url": "https://gitlab.com/application-kit/application-kit.git",
16
+ "directory": "packages/mailer"
17
+ },
18
+ "license": "MIT",
19
+ "author": {
20
+ "name": "application-kit"
21
+ },
22
+ "sideEffects": false,
23
+ "type": "module",
24
+ "exports": {
25
+ ".": {
26
+ "import": {
27
+ "types": "./dist/esm/index.d.ts",
28
+ "default": "./dist/esm/index.js"
29
+ },
30
+ "require": {
31
+ "types": "./dist/cjs/index.d.ts",
32
+ "default": "./dist/cjs/index.js"
33
+ }
34
+ },
35
+ "./package.json": "./package.json",
36
+ "./testing": {
37
+ "import": {
38
+ "types": "./dist/esm/testing/index.d.ts",
39
+ "default": "./dist/esm/testing/index.js"
40
+ },
41
+ "require": {
42
+ "types": "./dist/cjs/testing/index.d.ts",
43
+ "default": "./dist/cjs/testing/index.js"
44
+ }
45
+ }
46
+ },
47
+ "main": "./dist/cjs/index.js",
48
+ "module": "./dist/esm/index.js",
49
+ "types": "./dist/cjs/index.d.ts",
50
+ "files": [
51
+ "dist"
52
+ ],
53
+ "scripts": {
54
+ "build": "rm -rf ./dist && node ../../scripts/barrels.mjs create ./src --entry-only=testing && tsc --project tsconfig.build.json && tsc --project tsconfig.build.cjs.json && node ../../scripts/barrels.mjs clean ./src && node ../../scripts/mark-cjs.mjs ./dist/cjs",
55
+ "lint:tsc": "tsc --noEmit --pretty --project .",
56
+ "test:mutation": "stryker run",
57
+ "test:unit": "vitest run"
58
+ },
59
+ "dependencies": {
60
+ "nodemailer": "^10.0.2"
61
+ },
62
+ "devDependencies": {
63
+ "@libs-for-dev/nestjs-config-module": "3.0.0",
64
+ "@nestjs/common": "^11.2.7",
65
+ "@nestjs/core": "^11.2.7",
66
+ "@nestjs/testing": "^11.2.7",
67
+ "@nestjs/typeorm": "^11.0.3",
68
+ "@stryker-mutator/core": "^10.0.0",
69
+ "@stryker-mutator/vitest-runner": "^10.0.0",
70
+ "@types/node": "^26.2.0",
71
+ "class-transformer": "^0.5.1",
72
+ "class-validator": "^0.15.1",
73
+ "nestjs-pino": "^4.6.1",
74
+ "oxide.ts": "^1.1.0",
75
+ "pino": "^10.3.1",
76
+ "pino-http": "^11.0.0",
77
+ "reflect-metadata": "^0.2.2",
78
+ "rxjs": "^7.8.2",
79
+ "typeorm": "^1.1.0",
80
+ "typescript": "^6.0.3",
81
+ "vitest": "^4.1.11"
82
+ },
83
+ "peerDependencies": {
84
+ "@libs-for-dev/nestjs-config-module": "^3.0.0",
85
+ "@nestjs/common": "^11.0.0",
86
+ "@nestjs/typeorm": "^11.0.3",
87
+ "class-transformer": "^0.5.1",
88
+ "class-validator": "^0.15.1",
89
+ "nestjs-pino": "^4.6.1",
90
+ "oxide.ts": "^1.1.0",
91
+ "typeorm": "^1.0.0"
92
+ },
93
+ "engines": {
94
+ "node": ">=24"
95
+ },
96
+ "publishConfig": {
97
+ "access": "public"
98
+ }
6
99
  }