@agilo/medusa-email-templates-plugin 0.0.0-stage → 1.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 (180) hide show
  1. package/.medusa/server/medusa-config.d.ts +2 -0
  2. package/.medusa/server/medusa-config.js +57 -0
  3. package/.medusa/server/src/admin/_chunks/__admin-extensions__-B-Rs6wVu +1412 -0
  4. package/.medusa/server/src/admin/_chunks/__admin-extensions__-Cu08yi-Z +1413 -0
  5. package/.medusa/server/src/admin/_chunks/email-template-editor-JGYZjesE +820 -0
  6. package/.medusa/server/src/admin/_chunks/email-template-editor-_uBb7FNZ +820 -0
  7. package/.medusa/server/src/admin/_chunks/subject-editor-DsSopX-7 +115 -0
  8. package/.medusa/server/src/admin/_chunks/subject-editor-ykrWWMtp +115 -0
  9. package/.medusa/server/src/admin/_chunks/variable-node-BO5f9lJL +353 -0
  10. package/.medusa/server/src/admin/_chunks/variable-node-D2KY7H-p +352 -0
  11. package/.medusa/server/src/admin/index.js +3 -0
  12. package/.medusa/server/src/admin/index.mjs +4 -0
  13. package/.medusa/server/src/admin/tailwind-safelist.js +204 -0
  14. package/.medusa/server/src/api/admin/email/error-response.d.ts +2 -0
  15. package/.medusa/server/src/api/admin/email/error-response.js +26 -0
  16. package/.medusa/server/src/api/admin/email/middlewares.d.ts +2 -0
  17. package/.medusa/server/src/api/admin/email/middlewares.js +34 -0
  18. package/.medusa/server/src/api/admin/email/provider/route.d.ts +4 -0
  19. package/.medusa/server/src/api/admin/email/provider/route.js +36 -0
  20. package/.medusa/server/src/api/admin/email/provider/send-test/route.d.ts +3 -0
  21. package/.medusa/server/src/api/admin/email/provider/send-test/route.js +23 -0
  22. package/.medusa/server/src/api/admin/email/provider/validators.d.ts +25 -0
  23. package/.medusa/server/src/api/admin/email/provider/validators.js +27 -0
  24. package/.medusa/server/src/api/admin/email/templates/[id]/preview/route.d.ts +3 -0
  25. package/.medusa/server/src/api/admin/email/templates/[id]/preview/route.js +16 -0
  26. package/.medusa/server/src/api/admin/email/templates/[id]/route.d.ts +5 -0
  27. package/.medusa/server/src/api/admin/email/templates/[id]/route.js +45 -0
  28. package/.medusa/server/src/api/admin/email/templates/[id]/send-test/route.d.ts +3 -0
  29. package/.medusa/server/src/api/admin/email/templates/[id]/send-test/route.js +25 -0
  30. package/.medusa/server/src/api/admin/email/templates/route.d.ts +2 -0
  31. package/.medusa/server/src/api/admin/email/templates/route.js +12 -0
  32. package/.medusa/server/src/api/admin/email/templates/validators.d.ts +28 -0
  33. package/.medusa/server/src/api/admin/email/templates/validators.js +30 -0
  34. package/.medusa/server/src/api/admin/plugin/route.d.ts +2 -0
  35. package/.medusa/server/src/api/admin/plugin/route.js +7 -0
  36. package/.medusa/server/src/api/middlewares.d.ts +2 -0
  37. package/.medusa/server/src/api/middlewares.js +8 -0
  38. package/.medusa/server/src/api/store/plugin/route.d.ts +2 -0
  39. package/.medusa/server/src/api/store/plugin/route.js +7 -0
  40. package/.medusa/server/src/lib/container.d.ts +8 -0
  41. package/.medusa/server/src/lib/container.js +23 -0
  42. package/.medusa/server/src/lib/content.d.ts +4 -0
  43. package/.medusa/server/src/lib/content.js +9 -0
  44. package/.medusa/server/src/lib/credentials/mask.d.ts +10 -0
  45. package/.medusa/server/src/lib/credentials/mask.js +55 -0
  46. package/.medusa/server/src/lib/credentials/resolve-credential.d.ts +11 -0
  47. package/.medusa/server/src/lib/credentials/resolve-credential.js +34 -0
  48. package/.medusa/server/src/lib/crypto/credential-cipher.d.ts +7 -0
  49. package/.medusa/server/src/lib/crypto/credential-cipher.js +65 -0
  50. package/.medusa/server/src/lib/crypto/encryption-key.d.ts +9 -0
  51. package/.medusa/server/src/lib/crypto/encryption-key.js +45 -0
  52. package/.medusa/server/src/lib/errors.d.ts +18 -0
  53. package/.medusa/server/src/lib/errors.js +40 -0
  54. package/.medusa/server/src/lib/events/built-in/default-templates/account.d.ts +6 -0
  55. package/.medusa/server/src/lib/events/built-in/default-templates/account.js +48 -0
  56. package/.medusa/server/src/lib/events/built-in/default-templates/design.d.ts +67 -0
  57. package/.medusa/server/src/lib/events/built-in/default-templates/design.js +94 -0
  58. package/.medusa/server/src/lib/events/built-in/default-templates/order-placed.d.ts +5 -0
  59. package/.medusa/server/src/lib/events/built-in/default-templates/order-placed.js +59 -0
  60. package/.medusa/server/src/lib/events/built-in/default-templates/repeat.d.ts +3 -0
  61. package/.medusa/server/src/lib/events/built-in/default-templates/repeat.js +23 -0
  62. package/.medusa/server/src/lib/events/built-in/email-verification.d.ts +13 -0
  63. package/.medusa/server/src/lib/events/built-in/email-verification.js +53 -0
  64. package/.medusa/server/src/lib/events/built-in/invite.d.ts +5 -0
  65. package/.medusa/server/src/lib/events/built-in/invite.js +91 -0
  66. package/.medusa/server/src/lib/events/built-in/order-placed.d.ts +4 -0
  67. package/.medusa/server/src/lib/events/built-in/order-placed.js +234 -0
  68. package/.medusa/server/src/lib/events/built-in/password-reset.d.ts +12 -0
  69. package/.medusa/server/src/lib/events/built-in/password-reset.js +83 -0
  70. package/.medusa/server/src/lib/events/built-in/store.d.ts +3 -0
  71. package/.medusa/server/src/lib/events/built-in/store.js +12 -0
  72. package/.medusa/server/src/lib/events/define-email-event.d.ts +6 -0
  73. package/.medusa/server/src/lib/events/define-email-event.js +11 -0
  74. package/.medusa/server/src/lib/events/index.d.ts +8 -0
  75. package/.medusa/server/src/lib/events/index.js +21 -0
  76. package/.medusa/server/src/lib/events/registry.d.ts +9 -0
  77. package/.medusa/server/src/lib/events/registry.js +55 -0
  78. package/.medusa/server/src/lib/events/types.d.ts +82 -0
  79. package/.medusa/server/src/lib/events/types.js +3 -0
  80. package/.medusa/server/src/lib/events/urls.d.ts +23 -0
  81. package/.medusa/server/src/lib/events/urls.js +79 -0
  82. package/.medusa/server/src/lib/provider-configuration.d.ts +51 -0
  83. package/.medusa/server/src/lib/provider-configuration.js +114 -0
  84. package/.medusa/server/src/lib/redact.d.ts +1 -0
  85. package/.medusa/server/src/lib/redact.js +12 -0
  86. package/.medusa/server/src/lib/rendering/format-value.d.ts +21 -0
  87. package/.medusa/server/src/lib/rendering/format-value.js +55 -0
  88. package/.medusa/server/src/lib/rendering/liquid.d.ts +5 -0
  89. package/.medusa/server/src/lib/rendering/liquid.js +52 -0
  90. package/.medusa/server/src/lib/rendering/render-template.d.ts +12 -0
  91. package/.medusa/server/src/lib/rendering/render-template.js +46 -0
  92. package/.medusa/server/src/lib/rendering/sanitize-context.d.ts +1 -0
  93. package/.medusa/server/src/lib/rendering/sanitize-context.js +14 -0
  94. package/.medusa/server/src/lib/rendering/variable-format.d.ts +43 -0
  95. package/.medusa/server/src/lib/rendering/variable-format.js +103 -0
  96. package/.medusa/server/src/lib/resolve-email-content.d.ts +9 -0
  97. package/.medusa/server/src/lib/resolve-email-content.js +35 -0
  98. package/.medusa/server/src/lib/templates.d.ts +55 -0
  99. package/.medusa/server/src/lib/templates.js +161 -0
  100. package/.medusa/server/src/lib/test-email.d.ts +7 -0
  101. package/.medusa/server/src/lib/test-email.js +21 -0
  102. package/.medusa/server/src/lib/transports/address.d.ts +3 -0
  103. package/.medusa/server/src/lib/transports/address.js +16 -0
  104. package/.medusa/server/src/lib/transports/cloud-config.d.ts +13 -0
  105. package/.medusa/server/src/lib/transports/cloud-config.js +30 -0
  106. package/.medusa/server/src/lib/transports/mailgun.d.ts +15 -0
  107. package/.medusa/server/src/lib/transports/mailgun.js +116 -0
  108. package/.medusa/server/src/lib/transports/medusa-cloud.d.ts +15 -0
  109. package/.medusa/server/src/lib/transports/medusa-cloud.js +81 -0
  110. package/.medusa/server/src/lib/transports/registry.d.ts +4 -0
  111. package/.medusa/server/src/lib/transports/registry.js +24 -0
  112. package/.medusa/server/src/lib/transports/resend.d.ts +11 -0
  113. package/.medusa/server/src/lib/transports/resend.js +93 -0
  114. package/.medusa/server/src/lib/transports/types.d.ts +46 -0
  115. package/.medusa/server/src/lib/transports/types.js +10 -0
  116. package/.medusa/server/src/modules/email-templates/index.d.ts +49 -0
  117. package/.medusa/server/src/modules/email-templates/index.js +13 -0
  118. package/.medusa/server/src/modules/email-templates/migrations/Migration20260915141601.d.ts +5 -0
  119. package/.medusa/server/src/modules/email-templates/migrations/Migration20260915141601.js +27 -0
  120. package/.medusa/server/src/modules/email-templates/migrations/Migration20260916090537.d.ts +5 -0
  121. package/.medusa/server/src/modules/email-templates/migrations/Migration20260916090537.js +18 -0
  122. package/.medusa/server/src/modules/email-templates/models/email-provider-configuration.d.ts +24 -0
  123. package/.medusa/server/src/modules/email-templates/models/email-provider-configuration.js +32 -0
  124. package/.medusa/server/src/modules/email-templates/models/email-provider-credential.d.ts +21 -0
  125. package/.medusa/server/src/modules/email-templates/models/email-provider-credential.js +32 -0
  126. package/.medusa/server/src/modules/email-templates/models/email-template.d.ts +11 -0
  127. package/.medusa/server/src/modules/email-templates/models/email-template.js +25 -0
  128. package/.medusa/server/src/modules/email-templates/service.d.ts +70 -0
  129. package/.medusa/server/src/modules/email-templates/service.js +24 -0
  130. package/.medusa/server/src/providers/email/index.d.ts +2 -0
  131. package/.medusa/server/src/providers/email/index.js +11 -0
  132. package/.medusa/server/src/providers/email/service.d.ts +17 -0
  133. package/.medusa/server/src/providers/email/service.js +57 -0
  134. package/.medusa/server/src/registry.d.ts +34 -0
  135. package/.medusa/server/src/registry.js +49 -0
  136. package/.medusa/server/src/subscribers/email-account-events.d.ts +3 -0
  137. package/.medusa/server/src/subscribers/email-account-events.js +31 -0
  138. package/.medusa/server/src/subscribers/email-order-placed.d.ts +5 -0
  139. package/.medusa/server/src/subscribers/email-order-placed.js +26 -0
  140. package/.medusa/server/src/workflows/index.d.ts +6 -0
  141. package/.medusa/server/src/workflows/index.js +23 -0
  142. package/.medusa/server/src/workflows/preview-email-template.d.ts +3 -0
  143. package/.medusa/server/src/workflows/preview-email-template.js +11 -0
  144. package/.medusa/server/src/workflows/reset-email-template.d.ts +6 -0
  145. package/.medusa/server/src/workflows/reset-email-template.js +11 -0
  146. package/.medusa/server/src/workflows/save-email-provider-configuration.d.ts +6 -0
  147. package/.medusa/server/src/workflows/save-email-provider-configuration.js +28 -0
  148. package/.medusa/server/src/workflows/send-email-event.d.ts +3 -0
  149. package/.medusa/server/src/workflows/send-email-event.js +13 -0
  150. package/.medusa/server/src/workflows/send-provider-test-email.d.ts +7 -0
  151. package/.medusa/server/src/workflows/send-provider-test-email.js +11 -0
  152. package/.medusa/server/src/workflows/send-template-test-email.d.ts +12 -0
  153. package/.medusa/server/src/workflows/send-template-test-email.js +30 -0
  154. package/.medusa/server/src/workflows/steps/assert-email-provider-ready.d.ts +5 -0
  155. package/.medusa/server/src/workflows/steps/assert-email-provider-ready.js +21 -0
  156. package/.medusa/server/src/workflows/steps/render-email-template.d.ts +8 -0
  157. package/.medusa/server/src/workflows/steps/render-email-template.js +22 -0
  158. package/.medusa/server/src/workflows/steps/reset-email-template.d.ts +14 -0
  159. package/.medusa/server/src/workflows/steps/reset-email-template.js +69 -0
  160. package/.medusa/server/src/workflows/steps/resolve-email-event.d.ts +20 -0
  161. package/.medusa/server/src/workflows/steps/resolve-email-event.js +56 -0
  162. package/.medusa/server/src/workflows/steps/select-email-provider-configuration.d.ts +27 -0
  163. package/.medusa/server/src/workflows/steps/select-email-provider-configuration.js +62 -0
  164. package/.medusa/server/src/workflows/steps/send-email-event-notification.d.ts +9 -0
  165. package/.medusa/server/src/workflows/steps/send-email-event-notification.js +70 -0
  166. package/.medusa/server/src/workflows/steps/send-test-email.d.ts +15 -0
  167. package/.medusa/server/src/workflows/steps/send-test-email.js +31 -0
  168. package/.medusa/server/src/workflows/steps/send-transport-test-email.d.ts +16 -0
  169. package/.medusa/server/src/workflows/steps/send-transport-test-email.js +49 -0
  170. package/.medusa/server/src/workflows/steps/upsert-email-provider-credential.d.ts +10 -0
  171. package/.medusa/server/src/workflows/steps/upsert-email-provider-credential.js +84 -0
  172. package/.medusa/server/src/workflows/steps/upsert-email-template.d.ts +22 -0
  173. package/.medusa/server/src/workflows/steps/upsert-email-template.js +94 -0
  174. package/.medusa/server/src/workflows/steps/validate-email-provider-configuration.d.ts +20 -0
  175. package/.medusa/server/src/workflows/steps/validate-email-provider-configuration.js +58 -0
  176. package/.medusa/server/src/workflows/upsert-email-template.d.ts +15 -0
  177. package/.medusa/server/src/workflows/upsert-email-template.js +11 -0
  178. package/LICENSE +21 -0
  179. package/README.md +169 -2
  180. package/package.json +130 -4
@@ -0,0 +1,94 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.upsertEmailTemplateStep = exports.upsertEmailTemplateStepId = void 0;
4
+ const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
5
+ const errors_1 = require("../../lib/errors");
6
+ const events_1 = require("../../lib/events");
7
+ const liquid_1 = require("../../lib/rendering/liquid");
8
+ const templates_1 = require("../../lib/templates");
9
+ const email_templates_1 = require("../../modules/email-templates");
10
+ const liquid = (0, liquid_1.createEmailLiquid)();
11
+ const assertParses = (template, field) => {
12
+ if (!template) {
13
+ return;
14
+ }
15
+ try {
16
+ liquid.parse(template);
17
+ }
18
+ catch (error) {
19
+ const message = error instanceof Error ? error.message : String(error);
20
+ throw (0, errors_1.invalidDataError)(`Invalid Liquid in the ${field}: ${message}`);
21
+ }
22
+ };
23
+ exports.upsertEmailTemplateStepId = 'upsert-email-template-record';
24
+ exports.upsertEmailTemplateStep = (0, workflows_sdk_1.createStep)(exports.upsertEmailTemplateStepId, async (input, { container }) => {
25
+ const definition = (0, events_1.getEmailEventDefinitionByTemplateKey)(input.template_key);
26
+ if (!definition) {
27
+ throw (0, errors_1.invalidDataError)(`No managed email template "${input.template_key}".`);
28
+ }
29
+ assertParses(input.subject_template, 'subject');
30
+ assertParses(input.html_template, 'HTML body');
31
+ assertParses(input.text_template, 'text body');
32
+ const service = container.resolve(email_templates_1.EMAIL_TEMPLATES_MODULE);
33
+ const existing = await (0, templates_1.findEmailTemplate)(service, input.template_key);
34
+ const subject = input.subject_template ??
35
+ existing?.subject_template ??
36
+ definition.defaultTemplate.subject;
37
+ if (!subject) {
38
+ throw (0, errors_1.invalidDataError)('A subject is required to save a template.');
39
+ }
40
+ const keep = (next, current, fallback) => next !== undefined ? next : existing ? current : fallback;
41
+ /*
42
+ * New HTML without new editor content clears the stored editor content.
43
+ * It is the editor's source for the HTML; kept, the editor would reopen
44
+ * the old email and could save it back over the new one. Only affects API
45
+ * callers — the page always sends both.
46
+ */
47
+ const editorContent = input.html_template !== undefined && input.editor_content === undefined
48
+ ? null
49
+ : keep(input.editor_content, existing?.editor_content ?? null, null);
50
+ const data = {
51
+ event: definition.event,
52
+ template_key: input.template_key,
53
+ enabled: input.enabled ?? existing?.enabled ?? false,
54
+ subject_template: subject,
55
+ editor_content: editorContent,
56
+ html_template: keep(input.html_template, existing?.html_template ?? null, null),
57
+ text_template: keep(input.text_template, existing?.text_template ?? null, null),
58
+ };
59
+ if (existing) {
60
+ const updated = await service.updateEmailTemplates({
61
+ id: existing.id,
62
+ ...data,
63
+ });
64
+ return new workflows_sdk_1.StepResponse(updated, {
65
+ created_id: null,
66
+ previous: {
67
+ id: existing.id,
68
+ enabled: existing.enabled,
69
+ subject_template: existing.subject_template,
70
+ editor_content: existing.editor_content,
71
+ html_template: existing.html_template,
72
+ text_template: existing.text_template,
73
+ },
74
+ });
75
+ }
76
+ const created = await service.createEmailTemplates(data);
77
+ return new workflows_sdk_1.StepResponse(created, {
78
+ created_id: created.id,
79
+ previous: null,
80
+ });
81
+ }, async (compensation, { container }) => {
82
+ if (!compensation) {
83
+ return;
84
+ }
85
+ const service = container.resolve(email_templates_1.EMAIL_TEMPLATES_MODULE);
86
+ if (compensation.created_id) {
87
+ await service.deleteEmailTemplates(compensation.created_id);
88
+ return;
89
+ }
90
+ if (compensation.previous) {
91
+ await service.updateEmailTemplates(compensation.previous);
92
+ }
93
+ });
94
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXBzZXJ0LWVtYWlsLXRlbXBsYXRlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vc3JjL3dvcmtmbG93cy9zdGVwcy91cHNlcnQtZW1haWwtdGVtcGxhdGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEscUVBQTZFO0FBRTdFLDZDQUFvRDtBQUNwRCw2Q0FBd0U7QUFDeEUsdURBQStEO0FBQy9ELG1EQUF3RDtBQUN4RCxtRUFBdUU7QUEwQnZFLE1BQU0sTUFBTSxHQUFHLElBQUEsMEJBQWlCLEdBQUUsQ0FBQztBQUVuQyxNQUFNLFlBQVksR0FBRyxDQUNuQixRQUFtQyxFQUNuQyxLQUFhLEVBQ1AsRUFBRTtJQUNSLElBQUksQ0FBQyxRQUFRLEVBQUUsQ0FBQztRQUNkLE9BQU87SUFDVCxDQUFDO0lBRUQsSUFBSSxDQUFDO1FBQ0gsTUFBTSxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUN6QixDQUFDO0lBQUMsT0FBTyxLQUFLLEVBQUUsQ0FBQztRQUNmLE1BQU0sT0FBTyxHQUFHLEtBQUssWUFBWSxLQUFLLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQztRQUV2RSxNQUFNLElBQUEseUJBQWdCLEVBQUMseUJBQXlCLEtBQUssS0FBSyxPQUFPLEVBQUUsQ0FBQyxDQUFDO0lBQ3ZFLENBQUM7QUFDSCxDQUFDLENBQUM7QUFFVyxRQUFBLHlCQUF5QixHQUFHLDhCQUE4QixDQUFDO0FBRTNELFFBQUEsdUJBQXVCLEdBQUcsSUFBQSwwQkFBVSxFQUMvQyxpQ0FBeUIsRUFDekIsS0FBSyxFQUFFLEtBQStCLEVBQUUsRUFBRSxTQUFTLEVBQUUsRUFBRSxFQUFFO0lBQ3ZELE1BQU0sVUFBVSxHQUFHLElBQUEsNkNBQW9DLEVBQUMsS0FBSyxDQUFDLFlBQVksQ0FBQyxDQUFDO0lBRTVFLElBQUksQ0FBQyxVQUFVLEVBQUUsQ0FBQztRQUNoQixNQUFNLElBQUEseUJBQWdCLEVBQ3BCLDhCQUE4QixLQUFLLENBQUMsWUFBWSxJQUFJLENBQ3JELENBQUM7SUFDSixDQUFDO0lBRUQsWUFBWSxDQUFDLEtBQUssQ0FBQyxnQkFBZ0IsRUFBRSxTQUFTLENBQUMsQ0FBQztJQUNoRCxZQUFZLENBQUMsS0FBSyxDQUFDLGFBQWEsRUFBRSxXQUFXLENBQUMsQ0FBQztJQUMvQyxZQUFZLENBQUMsS0FBSyxDQUFDLGFBQWEsRUFBRSxXQUFXLENBQUMsQ0FBQztJQUUvQyxNQUFNLE9BQU8sR0FBRyxTQUFTLENBQUMsT0FBTyxDQUMvQix3Q0FBc0IsQ0FDdkIsQ0FBQztJQUNGLE1BQU0sUUFBUSxHQUFHLE1BQU0sSUFBQSw2QkFBaUIsRUFBQyxPQUFPLEVBQUUsS0FBSyxDQUFDLFlBQVksQ0FBQyxDQUFDO0lBRXRFLE1BQU0sT0FBTyxHQUNYLEtBQUssQ0FBQyxnQkFBZ0I7UUFDdEIsUUFBUSxFQUFFLGdCQUFnQjtRQUMxQixVQUFVLENBQUMsZUFBZSxDQUFDLE9BQU8sQ0FBQztJQUVyQyxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7UUFDYixNQUFNLElBQUEseUJBQWdCLEVBQUMsMkNBQTJDLENBQUMsQ0FBQztJQUN0RSxDQUFDO0lBRUQsTUFBTSxJQUFJLEdBQUcsQ0FBSSxJQUFtQixFQUFFLE9BQVUsRUFBRSxRQUFXLEVBQUssRUFBRSxDQUNsRSxJQUFJLEtBQUssU0FBUyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxRQUFRLENBQUM7SUFFNUQ7Ozs7O09BS0c7SUFDSCxNQUFNLGFBQWEsR0FDakIsS0FBSyxDQUFDLGFBQWEsS0FBSyxTQUFTLElBQUksS0FBSyxDQUFDLGNBQWMsS0FBSyxTQUFTO1FBQ3JFLENBQUMsQ0FBQyxJQUFJO1FBQ04sQ0FBQyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsY0FBYyxFQUFFLFFBQVEsRUFBRSxjQUFjLElBQUksSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFDO0lBRXpFLE1BQU0sSUFBSSxHQUFHO1FBQ1gsS0FBSyxFQUFFLFVBQVUsQ0FBQyxLQUFLO1FBQ3ZCLFlBQVksRUFBRSxLQUFLLENBQUMsWUFBWTtRQUNoQyxPQUFPLEVBQUUsS0FBSyxDQUFDLE9BQU8sSUFBSSxRQUFRLEVBQUUsT0FBTyxJQUFJLEtBQUs7UUFDcEQsZ0JBQWdCLEVBQUUsT0FBTztRQUN6QixjQUFjLEVBQUUsYUFBYTtRQUM3QixhQUFhLEVBQUUsSUFBSSxDQUNqQixLQUFLLENBQUMsYUFBYSxFQUNuQixRQUFRLEVBQUUsYUFBYSxJQUFJLElBQUksRUFDL0IsSUFBSSxDQUNMO1FBQ0QsYUFBYSxFQUFFLElBQUksQ0FDakIsS0FBSyxDQUFDLGFBQWEsRUFDbkIsUUFBUSxFQUFFLGFBQWEsSUFBSSxJQUFJLEVBQy9CLElBQUksQ0FDTDtLQUNGLENBQUM7SUFFRixJQUFJLFFBQVEsRUFBRSxDQUFDO1FBQ2IsTUFBTSxPQUFPLEdBQUcsTUFBTSxPQUFPLENBQUMsb0JBQW9CLENBQUM7WUFDakQsRUFBRSxFQUFFLFFBQVEsQ0FBQyxFQUFFO1lBQ2YsR0FBRyxJQUFJO1NBQ1IsQ0FBQyxDQUFDO1FBRUgsT0FBTyxJQUFJLDRCQUFZLENBQUMsT0FBTyxFQUFFO1lBQy9CLFVBQVUsRUFBRSxJQUFJO1lBQ2hCLFFBQVEsRUFBRTtnQkFDUixFQUFFLEVBQUUsUUFBUSxDQUFDLEVBQUU7Z0JBQ2YsT0FBTyxFQUFFLFFBQVEsQ0FBQyxPQUFPO2dCQUN6QixnQkFBZ0IsRUFBRSxRQUFRLENBQUMsZ0JBQWdCO2dCQUMzQyxjQUFjLEVBQUUsUUFBUSxDQUFDLGNBQWM7Z0JBQ3ZDLGFBQWEsRUFBRSxRQUFRLENBQUMsYUFBYTtnQkFDckMsYUFBYSxFQUFFLFFBQVEsQ0FBQyxhQUFhO2FBQ3RDO1NBQ2MsQ0FBQyxDQUFDO0lBQ3JCLENBQUM7SUFFRCxNQUFNLE9BQU8sR0FBRyxNQUFNLE9BQU8sQ0FBQyxvQkFBb0IsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUV6RCxPQUFPLElBQUksNEJBQVksQ0FBQyxPQUFPLEVBQUU7UUFDL0IsVUFBVSxFQUFFLE9BQU8sQ0FBQyxFQUFFO1FBQ3RCLFFBQVEsRUFBRSxJQUFJO0tBQ0MsQ0FBQyxDQUFDO0FBQ3JCLENBQUMsRUFDRCxLQUFLLEVBQUUsWUFBc0MsRUFBRSxFQUFFLFNBQVMsRUFBRSxFQUFFLEVBQUU7SUFDOUQsSUFBSSxDQUFDLFlBQVksRUFBRSxDQUFDO1FBQ2xCLE9BQU87SUFDVCxDQUFDO0lBRUQsTUFBTSxPQUFPLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FDL0Isd0NBQXNCLENBQ3ZCLENBQUM7SUFFRixJQUFJLFlBQVksQ0FBQyxVQUFVLEVBQUUsQ0FBQztRQUM1QixNQUFNLE9BQU8sQ0FBQyxvQkFBb0IsQ0FBQyxZQUFZLENBQUMsVUFBVSxDQUFDLENBQUM7UUFDNUQsT0FBTztJQUNULENBQUM7SUFFRCxJQUFJLFlBQVksQ0FBQyxRQUFRLEVBQUUsQ0FBQztRQUMxQixNQUFNLE9BQU8sQ0FBQyxvQkFBb0IsQ0FBQyxZQUFZLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDNUQsQ0FBQztBQUNILENBQUMsQ0FDRixDQUFDIn0=
@@ -0,0 +1,20 @@
1
+ export type EmailProviderCredentialInput = {
2
+ source: 'environment';
3
+ env_var_name: string;
4
+ } | {
5
+ source: 'encrypted_database';
6
+ api_key?: string;
7
+ };
8
+ export type SaveEmailProviderConfigurationInput = {
9
+ transport_id: string;
10
+ config?: Record<string, unknown>;
11
+ credential?: EmailProviderCredentialInput;
12
+ };
13
+ export type NormalizedEmailProviderCredential = EmailProviderCredentialInput;
14
+ export type ValidatedEmailProviderConfiguration = {
15
+ transport_id: string;
16
+ config: Record<string, unknown>;
17
+ credential: NormalizedEmailProviderCredential | null;
18
+ };
19
+ export declare const validateEmailProviderConfigurationStepId = "validate-email-provider-configuration";
20
+ export declare const validateEmailProviderConfigurationStep: import("@medusajs/framework/workflows-sdk").StepFunction<SaveEmailProviderConfigurationInput, ValidatedEmailProviderConfiguration>;
@@ -0,0 +1,58 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateEmailProviderConfigurationStep = exports.validateEmailProviderConfigurationStepId = void 0;
4
+ const utils_1 = require("@medusajs/framework/utils");
5
+ const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
6
+ const encryption_key_1 = require("../../lib/crypto/encryption-key");
7
+ const errors_1 = require("../../lib/errors");
8
+ const provider_configuration_1 = require("../../lib/provider-configuration");
9
+ const cloud_config_1 = require("../../lib/transports/cloud-config");
10
+ const registry_1 = require("../../lib/transports/registry");
11
+ const email_templates_1 = require("../../modules/email-templates");
12
+ exports.validateEmailProviderConfigurationStepId = 'validate-email-provider-configuration';
13
+ exports.validateEmailProviderConfigurationStep = (0, workflows_sdk_1.createStep)(exports.validateEmailProviderConfigurationStepId, async (input, { container }) => {
14
+ const transport = (0, registry_1.getEmailTransport)(input.transport_id);
15
+ if (!transport) {
16
+ throw (0, errors_1.invalidDataError)(`Unknown email transport "${input.transport_id}".`);
17
+ }
18
+ const config = await transport.validateConfiguration(input.config ?? {});
19
+ const isManaged = transport.credentialSources.includes('managed');
20
+ let credential = null;
21
+ if (input.credential) {
22
+ if (!transport.credentialSources.includes(input.credential.source)) {
23
+ throw (0, errors_1.invalidDataError)(`${transport.label} does not support the "${input.credential.source}" credential source.`);
24
+ }
25
+ if (input.credential.source === 'encrypted_database') {
26
+ if (input.credential.api_key && !(0, encryption_key_1.readEncryptionKey)()) {
27
+ throw (0, errors_1.invalidDataError)(`${encryption_key_1.ENCRYPTION_KEY_ENV} is not configured, so API keys cannot be stored. Set it, or use an environment variable credential instead.`);
28
+ }
29
+ }
30
+ credential = input.credential;
31
+ }
32
+ else if (!isManaged) {
33
+ const service = container.resolve(email_templates_1.EMAIL_TEMPLATES_MODULE);
34
+ const [stored] = await (0, provider_configuration_1.listEmailProviderConfigurations)(service, {
35
+ transport_id: transport.id,
36
+ });
37
+ if (!stored?.credential) {
38
+ throw (0, errors_1.invalidDataError)(`${transport.label} requires a credential.`);
39
+ }
40
+ }
41
+ if (isManaged) {
42
+ const configModule = container.resolve(utils_1.ContainerRegistrationKeys.CONFIG_MODULE);
43
+ const available = await transport.isAvailable({
44
+ config,
45
+ credential: null,
46
+ cloud: (0, cloud_config_1.readCloudEmailConfig)(configModule),
47
+ });
48
+ if (!available) {
49
+ throw (0, errors_1.providerNotReadyError)(`${transport.label} is not available in this environment.`);
50
+ }
51
+ }
52
+ return new workflows_sdk_1.StepResponse({
53
+ transport_id: transport.id,
54
+ config,
55
+ credential,
56
+ });
57
+ });
58
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdGUtZW1haWwtcHJvdmlkZXItY29uZmlndXJhdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3NyYy93b3JrZmxvd3Mvc3RlcHMvdmFsaWRhdGUtZW1haWwtcHJvdmlkZXItY29uZmlndXJhdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFDQSxxREFBc0U7QUFDdEUscUVBQTZFO0FBRTdFLG9FQUd5QztBQUN6Qyw2Q0FBMkU7QUFDM0UsNkVBQW1GO0FBQ25GLG9FQUF5RTtBQUN6RSw0REFBa0U7QUFDbEUsbUVBQXVFO0FBcUIxRCxRQUFBLHdDQUF3QyxHQUNuRCx1Q0FBdUMsQ0FBQztBQUU3QixRQUFBLHNDQUFzQyxHQUFHLElBQUEsMEJBQVUsRUFDOUQsZ0RBQXdDLEVBQ3hDLEtBQUssRUFBRSxLQUEwQyxFQUFFLEVBQUUsU0FBUyxFQUFFLEVBQUUsRUFBRTtJQUNsRSxNQUFNLFNBQVMsR0FBRyxJQUFBLDRCQUFpQixFQUFDLEtBQUssQ0FBQyxZQUFZLENBQUMsQ0FBQztJQUV4RCxJQUFJLENBQUMsU0FBUyxFQUFFLENBQUM7UUFDZixNQUFNLElBQUEseUJBQWdCLEVBQ3BCLDRCQUE0QixLQUFLLENBQUMsWUFBWSxJQUFJLENBQ25ELENBQUM7SUFDSixDQUFDO0lBRUQsTUFBTSxNQUFNLEdBQUcsTUFBTSxTQUFTLENBQUMscUJBQXFCLENBQUMsS0FBSyxDQUFDLE1BQU0sSUFBSSxFQUFFLENBQUMsQ0FBQztJQUN6RSxNQUFNLFNBQVMsR0FBRyxTQUFTLENBQUMsaUJBQWlCLENBQUMsUUFBUSxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQ2xFLElBQUksVUFBVSxHQUE2QyxJQUFJLENBQUM7SUFFaEUsSUFBSSxLQUFLLENBQUMsVUFBVSxFQUFFLENBQUM7UUFDckIsSUFBSSxDQUFDLFNBQVMsQ0FBQyxpQkFBaUIsQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDO1lBQ25FLE1BQU0sSUFBQSx5QkFBZ0IsRUFDcEIsR0FBRyxTQUFTLENBQUMsS0FBSywwQkFBMEIsS0FBSyxDQUFDLFVBQVUsQ0FBQyxNQUFNLHNCQUFzQixDQUMxRixDQUFDO1FBQ0osQ0FBQztRQUVELElBQUksS0FBSyxDQUFDLFVBQVUsQ0FBQyxNQUFNLEtBQUssb0JBQW9CLEVBQUUsQ0FBQztZQUNyRCxJQUFJLEtBQUssQ0FBQyxVQUFVLENBQUMsT0FBTyxJQUFJLENBQUMsSUFBQSxrQ0FBaUIsR0FBRSxFQUFFLENBQUM7Z0JBQ3JELE1BQU0sSUFBQSx5QkFBZ0IsRUFDcEIsR0FBRyxtQ0FBa0IsOEdBQThHLENBQ3BJLENBQUM7WUFDSixDQUFDO1FBQ0gsQ0FBQztRQUVELFVBQVUsR0FBRyxLQUFLLENBQUMsVUFBVSxDQUFDO0lBQ2hDLENBQUM7U0FBTSxJQUFJLENBQUMsU0FBUyxFQUFFLENBQUM7UUFDdEIsTUFBTSxPQUFPLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FDL0Isd0NBQXNCLENBQ3ZCLENBQUM7UUFDRixNQUFNLENBQUMsTUFBTSxDQUFDLEdBQUcsTUFBTSxJQUFBLHdEQUErQixFQUFDLE9BQU8sRUFBRTtZQUM5RCxZQUFZLEVBQUUsU0FBUyxDQUFDLEVBQUU7U0FDM0IsQ0FBQyxDQUFDO1FBRUgsSUFBSSxDQUFDLE1BQU0sRUFBRSxVQUFVLEVBQUUsQ0FBQztZQUN4QixNQUFNLElBQUEseUJBQWdCLEVBQUMsR0FBRyxTQUFTLENBQUMsS0FBSyx5QkFBeUIsQ0FBQyxDQUFDO1FBQ3RFLENBQUM7SUFDSCxDQUFDO0lBRUQsSUFBSSxTQUFTLEVBQUUsQ0FBQztRQUNkLE1BQU0sWUFBWSxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQ3BDLGlDQUF5QixDQUFDLGFBQWEsQ0FDeEMsQ0FBQztRQUNGLE1BQU0sU0FBUyxHQUFHLE1BQU0sU0FBUyxDQUFDLFdBQVcsQ0FBQztZQUM1QyxNQUFNO1lBQ04sVUFBVSxFQUFFLElBQUk7WUFDaEIsS0FBSyxFQUFFLElBQUEsbUNBQW9CLEVBQUMsWUFBWSxDQUFDO1NBQzFDLENBQUMsQ0FBQztRQUVILElBQUksQ0FBQyxTQUFTLEVBQUUsQ0FBQztZQUNmLE1BQU0sSUFBQSw4QkFBcUIsRUFDekIsR0FBRyxTQUFTLENBQUMsS0FBSyx3Q0FBd0MsQ0FDM0QsQ0FBQztRQUNKLENBQUM7SUFDSCxDQUFDO0lBRUQsT0FBTyxJQUFJLDRCQUFZLENBQXNDO1FBQzNELFlBQVksRUFBRSxTQUFTLENBQUMsRUFBRTtRQUMxQixNQUFNO1FBQ04sVUFBVTtLQUNYLENBQUMsQ0FBQztBQUNMLENBQUMsQ0FDRixDQUFDIn0=
@@ -0,0 +1,15 @@
1
+ import { type UpsertEmailTemplateInput } from './steps/upsert-email-template';
2
+ export declare const upsertEmailTemplateWorkflowId = "upsert-email-template";
3
+ export declare const upsertEmailTemplateWorkflow: import("@medusajs/framework/workflows-sdk").ReturnWorkflow<UpsertEmailTemplateInput, {
4
+ id: string;
5
+ event: string;
6
+ template_key: string;
7
+ enabled: boolean;
8
+ subject_template: string;
9
+ editor_content: NoInfer<Record<string, unknown>> | null;
10
+ html_template: string | null;
11
+ text_template: string | null;
12
+ created_at: Date;
13
+ updated_at: Date;
14
+ deleted_at: Date | null;
15
+ }, []>;
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.upsertEmailTemplateWorkflow = exports.upsertEmailTemplateWorkflowId = void 0;
4
+ const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
5
+ const upsert_email_template_1 = require("./steps/upsert-email-template");
6
+ exports.upsertEmailTemplateWorkflowId = 'upsert-email-template';
7
+ exports.upsertEmailTemplateWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.upsertEmailTemplateWorkflowId, function (input) {
8
+ const template = (0, upsert_email_template_1.upsertEmailTemplateStep)(input);
9
+ return new workflows_sdk_1.WorkflowResponse(template);
10
+ });
11
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXBzZXJ0LWVtYWlsLXRlbXBsYXRlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL3dvcmtmbG93cy91cHNlcnQtZW1haWwtdGVtcGxhdGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEscUVBRzJDO0FBRTNDLHlFQUd1QztBQUUxQixRQUFBLDZCQUE2QixHQUFHLHVCQUF1QixDQUFDO0FBRXhELFFBQUEsMkJBQTJCLEdBQUcsSUFBQSw4QkFBYyxFQUN2RCxxQ0FBNkIsRUFDN0IsVUFBVSxLQUErQjtJQUN2QyxNQUFNLFFBQVEsR0FBRyxJQUFBLCtDQUF1QixFQUFDLEtBQUssQ0FBQyxDQUFDO0lBRWhELE9BQU8sSUFBSSxnQ0FBZ0IsQ0FBQyxRQUFRLENBQUMsQ0FBQztBQUN4QyxDQUFDLENBQ0YsQ0FBQyJ9
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Agilo
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,170 @@
1
- # Temporary Holding Version
1
+ # Medusa Email Templates Plugin
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
+ [![npm version](https://img.shields.io/npm/v/@agilo/medusa-email-templates-plugin/latest?label=npm%20latest)](https://www.npmjs.com/package/@agilo/medusa-email-templates-plugin)
4
+ [![npm license](https://img.shields.io/npm/l/@agilo/medusa-email-templates-plugin)](https://github.com/Agilo/medusa-email-templates-plugin/blob/master/LICENSE)
5
+ [![Node.js](https://img.shields.io/badge/Node.js-24%2B-339933?logo=nodedotjs&logoColor=white)](https://nodejs.org/)
6
+
7
+ Edit transactional emails and manage delivery from Medusa Admin. The plugin includes a visual editor, ready-to-edit emails, and three built-in providers: Medusa Cloud, Resend, and Mailgun. Switch providers in Admin without redeploying your store.
8
+
9
+ ![Order confirmation email delivered to Gmail](https://raw.githubusercontent.com/Agilo/medusa-email-templates-plugin/master/assets/screenshots/email-in-gmail-padded.png)
10
+
11
+ [Providers](#choose-a-provider) · [Template editor](#visual-editing) · [Built-in emails](#built-in-emails) · [Install](#install) · [Credentials](#security-and-credentials) · [Plugin options](#plugin-options) · [Custom extensions](#custom-extensions)
12
+
13
+ ## Choose a provider
14
+
15
+ Medusa Cloud, Resend, and Mailgun are included in the plugin. One provider sends each email; the others keep their settings. Switch the active provider from Admin without changing your deployment or templates.
16
+
17
+ | Provider | Setup in Admin | Availability |
18
+ | ------------ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
19
+ | Medusa Cloud | Choose **Use**. Credentials are managed by your Medusa Cloud project. | Requires an application running on Medusa Cloud with its email configuration injected. Unavailable in local development. |
20
+ | Resend | Enter a sender address, an optional reply-to address, and an API credential. | Requires a Resend account and a key with sending access. |
21
+ | Mailgun | Enter a sending domain, its US or EU region, a sender address, an optional reply-to address, and an API credential. | Requires a Mailgun account. A Domain Sending Key is sufficient; the plugin only calls the send endpoint. |
22
+
23
+ ![Provider and template settings in Medusa Admin](https://raw.githubusercontent.com/Agilo/medusa-email-templates-plugin/master/assets/screenshots/email-settings-padded.png)
24
+
25
+ To start sending:
26
+
27
+ 1. Open the provider's row menu and choose **Configure**. For Resend or Mailgun, fill in the sender and credential fields, then choose **Save & activate**.
28
+ 2. Use **Send test** from the row menu to check delivery to your own inbox.
29
+ 3. To switch to an available provider later, choose **Use** from its row menu.
30
+
31
+ Medusa Cloud needs no API key entered in Admin. Because the plugin owns the email channel, its built-in Cloud integration handles delivery in place of Medusa's automatically registered Cloud provider.
32
+
33
+ Switching providers uses credentials already available to the application. Adding server environment variables still requires updating your deployment environment; the [stored API key option](#security-and-credentials) lets you manage provider keys in Admin once encryption is configured.
34
+
35
+ ## Visual editing
36
+
37
+ ![Editing an order confirmation email](https://raw.githubusercontent.com/Agilo/medusa-email-templates-plugin/master/assets/screenshots/template-editor-padded.png)
38
+
39
+ Open a template from **Settings → Email** to edit its subject and body. The editor uses [React Email Editor](https://react.email/editor) and provides:
40
+
41
+ - Rich text and email layouts, including columns and repeating blocks for lists such as order items.
42
+ - Template variables in the subject and body, with display formatting for money and dates.
43
+ - A link picker for URL variables, including configured storefront links.
44
+ - Preview and test send with example data, including unsaved edits.
45
+
46
+ Save your changes, check a test email in your inbox, then enable the template. Test sends work while a template is disabled, so you can review it before it handles live events.
47
+
48
+ Templates use [Liquid](https://liquidjs.com) for dynamic content. The plugin validates syntax when saving and generates a plain-text body from the rendered HTML when no separate text template is set.
49
+
50
+ ## Built-in emails
51
+
52
+ Each email has its own editable template and enable switch.
53
+
54
+ | Email | Trigger | Template key |
55
+ | ----------------------------------------- | ----------------------------------------------------------------- | ------------------------- |
56
+ | Order confirmation, with items and totals | `order.placed` | `order-placed` |
57
+ | Admin invitation | `invite.created` | `invite-created` |
58
+ | Resent admin invitation | `invite.resent` | `invite-resent` |
59
+ | Admin password reset | `auth.password_reset` for an admin user | `password-reset-user` |
60
+ | Customer password reset | `auth.password_reset` for a customer | `password-reset-customer` |
61
+ | Email verification code | `auth.verification_requested` when the entity is an email address | `email-verification` |
62
+
63
+ The verification template handles an existing verification request event; your application still owns the flow that requests and checks verification codes.
64
+
65
+ If your application already has subscribers sending the same emails, adjust them before enabling these templates to avoid duplicate messages. Notifications that already include rendered content pass through the plugin's provider unchanged.
66
+
67
+ ## Install
68
+
69
+ Install the package in your Medusa application:
70
+
71
+ ```bash
72
+ npm install @agilo/medusa-email-templates-plugin@latest
73
+ ```
74
+
75
+ Add the plugin and its notification provider to your existing `medusa-config.ts`:
76
+
77
+ ```typescript
78
+ modules: [
79
+ {
80
+ resolve: '@medusajs/medusa/notification',
81
+ options: {
82
+ providers: [
83
+ {
84
+ resolve: '@agilo/medusa-email-templates-plugin/providers/email',
85
+ id: 'email-templates',
86
+ options: { channels: ['email'] },
87
+ },
88
+ ],
89
+ },
90
+ },
91
+ ],
92
+ plugins: [
93
+ {
94
+ resolve: '@agilo/medusa-email-templates-plugin',
95
+ options: {
96
+ storefront_url: 'https://shop.example.com',
97
+ },
98
+ },
99
+ ],
100
+ ```
101
+
102
+ Keep your other modules, plugins, and notification providers. Medusa allows one notification provider per channel, so replace any existing `email` provider with this one. If your application uses Medusa's local `feed` provider, retain it in the `providers` array too. The plugin registers its own modules automatically.
103
+
104
+ Run migrations, then restart your application:
105
+
106
+ ```bash
107
+ npx medusa db:migrate
108
+ ```
109
+
110
+ Open **Settings → Email** in Medusa Admin to configure delivery. Templates start disabled; enable each email when it is ready to send.
111
+
112
+ ## Security and credentials
113
+
114
+ Resend and Mailgun support two credential sources. Choose one in the provider configuration drawer:
115
+
116
+ | Source | How it works |
117
+ | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
118
+ | Environment variable | Enter the variable name, such as `RESEND_API_KEY`. The plugin stores that name and reads the key from the server environment when sending. |
119
+ | Stored API key | Enter the key in Admin. The plugin encrypts it with AES-256-GCM before storing it in the database. |
120
+
121
+ ![Configuring provider credentials](https://raw.githubusercontent.com/Agilo/medusa-email-templates-plugin/master/assets/screenshots/provider-credentials-padded.png)
122
+
123
+ Stored keys require `MEDUSA_EMAIL_ENCRYPTION_KEY` on the server: 32 random bytes encoded as base64 or hex. For example, generate a base64 value with `openssl rand -base64 32`, then set it through your deployment's secret configuration. Without this encryption key, environment credentials remain available and stored API keys are disabled.
124
+
125
+ Keep the encryption key stable. If it changes, existing stored credentials become unusable and must be entered again. The Admin API returns credential status and the environment variable name where applicable; it never returns API keys or ciphertext.
126
+
127
+ Template rendering escapes values in HTML output. Liquid templates cannot read files or execute JavaScript, and parsing and rendering have resource limits.
128
+
129
+ ## Plugin options
130
+
131
+ Set these options in the plugin entry in `medusa-config.ts` to match your storefront and Admin routes:
132
+
133
+ | Option | Purpose | Default |
134
+ | -------------------------------- | ---------------------------------------------------------------- | -------------------------------------------- |
135
+ | `storefront_url` | Base URL for customer links, such as `https://shop.example.com`. | Unset |
136
+ | `storefront_reset_password_path` | Customer password reset page. | `/reset-password` |
137
+ | `storefront_order_path` | Order details path; the order ID is appended. | `/orders` |
138
+ | `admin_url` | Base Admin URL for invitations and admin password resets. | The application's backend URL and Admin path |
139
+
140
+ For example, a storefront with account pages can use:
141
+
142
+ ```typescript
143
+ options: {
144
+ storefront_url: 'https://shop.example.com',
145
+ storefront_reset_password_path: '/account/new-password',
146
+ storefront_order_path: '/account/orders',
147
+ admin_url: 'https://admin.example.com/app',
148
+ },
149
+ ```
150
+
151
+ Without `storefront_url`, customer password reset emails are skipped. Order confirmations still send, but their order link is unavailable. Admin shows a warning when the storefront URL is missing.
152
+
153
+ ## Custom extensions
154
+
155
+ Developers can add application-specific email events and delivery providers through `@agilo/medusa-email-templates-plugin/registry`.
156
+
157
+ Use `defineEmailEvent` to register an event's template, recipient, context, and editor variables. Your Medusa subscriber calls `sendEmailEventWorkflow` when the event occurs. The registered template then appears alongside the built-in emails in Admin.
158
+
159
+ Event definitions can include snippets for the editor's slash menu. Typed variables support money and date formatting, URL selection, and lists with repeating content. The registry also exports `repeat()` and `columns()` helpers for default template layouts.
160
+
161
+ Use `registerEmailTransport` with an implementation of `EmailTransport` to add another delivery provider while keeping existing templates and event definitions.
162
+
163
+ ## Compatibility
164
+
165
+ - Medusa `^2.22.7`.
166
+ - Node.js `>=24.0.0`.
167
+
168
+ ## License
169
+
170
+ MIT. See [LICENSE](https://github.com/Agilo/medusa-email-templates-plugin/blob/master/LICENSE).
package/package.json CHANGED
@@ -1,6 +1,132 @@
1
1
  {
2
2
  "name": "@agilo/medusa-email-templates-plugin",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "1.0.0",
4
+ "description": "Manage transactional email templates from Medusa Admin and send them through Medusa Cloud, Resend or Mailgun.",
5
+ "author": "Agilo (https://agilo.com)",
6
+ "license": "MIT",
7
+ "homepage": "https://github.com/Agilo/medusa-email-templates-plugin#readme",
8
+ "repository": {
9
+ "type": "git",
10
+ "url": "git+https://github.com/Agilo/medusa-email-templates-plugin.git",
11
+ "directory": "packages/medusa-email-templates-plugin"
12
+ },
13
+ "bugs": {
14
+ "url": "https://github.com/Agilo/medusa-email-templates-plugin/issues"
15
+ },
16
+ "files": [
17
+ ".medusa/server"
18
+ ],
19
+ "publishConfig": {
20
+ "access": "public",
21
+ "tag": "latest"
22
+ },
23
+ "exports": {
24
+ ".": "./.medusa/server/src/registry.js",
25
+ "./package.json": "./package.json",
26
+ "./workflows": "./.medusa/server/src/workflows/index.js",
27
+ "./.medusa/server/src/modules/*": "./.medusa/server/src/modules/*/index.js",
28
+ "./modules/*": "./.medusa/server/src/modules/*/index.js",
29
+ "./providers/*": "./.medusa/server/src/providers/*/index.js",
30
+ "./*": "./.medusa/server/src/*.js",
31
+ "./admin": {
32
+ "import": "./.medusa/server/src/admin/index.mjs",
33
+ "require": "./.medusa/server/src/admin/index.js",
34
+ "default": "./.medusa/server/src/admin/index.js"
35
+ }
36
+ },
37
+ "keywords": [
38
+ "medusa",
39
+ "plugin",
40
+ "medusa-plugin-other",
41
+ "medusa-plugin",
42
+ "medusa-v2",
43
+ "medusa-plugin-notification",
44
+ "email",
45
+ "email-templates",
46
+ "notification",
47
+ "resend",
48
+ "mailgun"
49
+ ],
50
+ "scripts": {
51
+ "build": "yarn plugin:build",
52
+ "format": "prettier . --write --ignore-unknown",
53
+ "format:check": "prettier . --check --ignore-unknown",
54
+ "lint": "eslint .",
55
+ "lint:fix": "eslint . --fix",
56
+ "patch:dev": "node ../../scripts/apply-dev-patches.cjs",
57
+ "plugin:build": "medusa plugin:build && node ./scripts/write-admin-safelist.mjs",
58
+ "plugin:dev:medusa": "medusa plugin:develop",
59
+ "plugin:publish:local": "medusa plugin:publish",
60
+ "prepublishOnly": "medusa plugin:build && node ./scripts/write-admin-safelist.mjs",
61
+ "test": "yarn test:unit && yarn test:backend && yarn test:admin",
62
+ "test:admin": "yarn patch:dev && vitest run --passWithNoTests",
63
+ "test:unit": "yarn patch:dev && vitest run --config vitest.config.unit.ts --passWithNoTests",
64
+ "test:backend": "sh -c 'if test \"$DEVCONTAINER\" = \"true\"; then DB_HOST=postgres_test DB_PORT=5432 DB_USERNAME=postgres DB_PASSWORD=postgres DATABASE_URL=postgres://postgres:postgres@postgres_test:5432/postgres?sslmode=disable REDIS_URL=redis://redis_test:6379 yarn test:integration:module && DB_HOST=postgres_test DB_PORT=5432 DB_USERNAME=postgres DB_PASSWORD=postgres DATABASE_URL=postgres://postgres:postgres@postgres_test:5432/postgres?sslmode=disable REDIS_URL=redis://redis_test:6379 yarn test:integration:http; else yarn test:integration:module && yarn test:integration:http; fi'",
65
+ "test:integration:http": "yarn patch:dev && TEST_TYPE=integration:http NODE_OPTIONS=--experimental-vm-modules jest --silent=false --forceExit --maxWorkers=4",
66
+ "test:integration:module": "yarn patch:dev && TEST_TYPE=integration:module NODE_OPTIONS=--experimental-vm-modules jest --silent=false --runInBand --forceExit --passWithNoTests",
67
+ "typecheck": "tsc --noEmit -p tsconfig.json && tsc --noEmit -p tsconfig.test.json && tsc --noEmit -p src/admin/tsconfig.json"
68
+ },
69
+ "devDependencies": {
70
+ "@medusajs/admin-sdk": "2.22.7",
71
+ "@medusajs/cli": "2.22.7",
72
+ "@medusajs/framework": "2.22.7",
73
+ "@medusajs/icons": "2.22.7",
74
+ "@medusajs/js-sdk": "2.22.7",
75
+ "@medusajs/medusa": "2.22.7",
76
+ "@medusajs/test-utils": "2.22.7",
77
+ "@medusajs/ui": "4.2.14",
78
+ "@swc/core": "^1.16.2",
79
+ "@swc/jest": "^0.2.39",
80
+ "@testing-library/dom": "^10.4.2",
81
+ "@testing-library/jest-dom": "^7.0.1",
82
+ "@testing-library/react": "^16.3.3",
83
+ "@testing-library/user-event": "^14.6.7",
84
+ "@tiptap/core": "3.31.3",
85
+ "@types/html-to-text": "^9.0.4",
86
+ "@types/jest": "^30.0.0",
87
+ "@types/jsonwebtoken": "^9.0.10",
88
+ "@types/node": "^24.13.4",
89
+ "@types/react": "^18.3.31",
90
+ "@types/react-dom": "^18.3.7",
91
+ "ajv": "^8.20.0",
92
+ "dotenv": "^17.4.2",
93
+ "eslint": "^10.10.0",
94
+ "eslint-plugin-react-hooks": "^7.1.1",
95
+ "globals": "^17.12.0",
96
+ "jest": "^30.5.1",
97
+ "jsdom": "^30.0.1",
98
+ "jsonwebtoken": "^9.0.3",
99
+ "neostandard": "^0.14.1",
100
+ "patch-package": "^8.0.1",
101
+ "pg-god": "^1.0.12",
102
+ "prettier": "^3.9.6",
103
+ "prop-types": "^15.8.1",
104
+ "react": "^18.3.1",
105
+ "react-dom": "^18.3.1",
106
+ "ts-node": "^10.9.2",
107
+ "typescript": "~5.9.3",
108
+ "vite": "^7.3.7",
109
+ "vitest": "^5.0.0",
110
+ "yalc": "^1.0.0-pre.53"
111
+ },
112
+ "peerDependencies": {
113
+ "@medusajs/admin-sdk": "^2.22.7",
114
+ "@medusajs/framework": "^2.22.7",
115
+ "@medusajs/icons": "^2.22.7",
116
+ "@medusajs/js-sdk": "^2.22.7",
117
+ "@medusajs/medusa": "^2.22.7",
118
+ "@medusajs/ui": "^4.2.14"
119
+ },
120
+ "engines": {
121
+ "node": ">=24.0.0"
122
+ },
123
+ "packageManager": "yarn@4.18.0+sha512.fcb8716fe7cd0eece141ffc18b92193a9df9204c1ba83189c288835223fc0bbe64af473bab0d5e9927a7daeb5caf2bb07eb2787cc9338ca040ea125f2a1f2f7e",
124
+ "dependencies": {
125
+ "@react-email/editor": "1.7.7",
126
+ "@tiptap/pm": "^3.17.1",
127
+ "@tiptap/react": "^3.17.1",
128
+ "html-to-text": "^9.0.5",
129
+ "liquidjs": "^10.29.0",
130
+ "resend": "6.28.0"
131
+ }
132
+ }