@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.
- package/.medusa/server/medusa-config.d.ts +2 -0
- package/.medusa/server/medusa-config.js +57 -0
- package/.medusa/server/src/admin/_chunks/__admin-extensions__-B-Rs6wVu +1412 -0
- package/.medusa/server/src/admin/_chunks/__admin-extensions__-Cu08yi-Z +1413 -0
- package/.medusa/server/src/admin/_chunks/email-template-editor-JGYZjesE +820 -0
- package/.medusa/server/src/admin/_chunks/email-template-editor-_uBb7FNZ +820 -0
- package/.medusa/server/src/admin/_chunks/subject-editor-DsSopX-7 +115 -0
- package/.medusa/server/src/admin/_chunks/subject-editor-ykrWWMtp +115 -0
- package/.medusa/server/src/admin/_chunks/variable-node-BO5f9lJL +353 -0
- package/.medusa/server/src/admin/_chunks/variable-node-D2KY7H-p +352 -0
- package/.medusa/server/src/admin/index.js +3 -0
- package/.medusa/server/src/admin/index.mjs +4 -0
- package/.medusa/server/src/admin/tailwind-safelist.js +204 -0
- package/.medusa/server/src/api/admin/email/error-response.d.ts +2 -0
- package/.medusa/server/src/api/admin/email/error-response.js +26 -0
- package/.medusa/server/src/api/admin/email/middlewares.d.ts +2 -0
- package/.medusa/server/src/api/admin/email/middlewares.js +34 -0
- package/.medusa/server/src/api/admin/email/provider/route.d.ts +4 -0
- package/.medusa/server/src/api/admin/email/provider/route.js +36 -0
- package/.medusa/server/src/api/admin/email/provider/send-test/route.d.ts +3 -0
- package/.medusa/server/src/api/admin/email/provider/send-test/route.js +23 -0
- package/.medusa/server/src/api/admin/email/provider/validators.d.ts +25 -0
- package/.medusa/server/src/api/admin/email/provider/validators.js +27 -0
- package/.medusa/server/src/api/admin/email/templates/[id]/preview/route.d.ts +3 -0
- package/.medusa/server/src/api/admin/email/templates/[id]/preview/route.js +16 -0
- package/.medusa/server/src/api/admin/email/templates/[id]/route.d.ts +5 -0
- package/.medusa/server/src/api/admin/email/templates/[id]/route.js +45 -0
- package/.medusa/server/src/api/admin/email/templates/[id]/send-test/route.d.ts +3 -0
- package/.medusa/server/src/api/admin/email/templates/[id]/send-test/route.js +25 -0
- package/.medusa/server/src/api/admin/email/templates/route.d.ts +2 -0
- package/.medusa/server/src/api/admin/email/templates/route.js +12 -0
- package/.medusa/server/src/api/admin/email/templates/validators.d.ts +28 -0
- package/.medusa/server/src/api/admin/email/templates/validators.js +30 -0
- package/.medusa/server/src/api/admin/plugin/route.d.ts +2 -0
- package/.medusa/server/src/api/admin/plugin/route.js +7 -0
- package/.medusa/server/src/api/middlewares.d.ts +2 -0
- package/.medusa/server/src/api/middlewares.js +8 -0
- package/.medusa/server/src/api/store/plugin/route.d.ts +2 -0
- package/.medusa/server/src/api/store/plugin/route.js +7 -0
- package/.medusa/server/src/lib/container.d.ts +8 -0
- package/.medusa/server/src/lib/container.js +23 -0
- package/.medusa/server/src/lib/content.d.ts +4 -0
- package/.medusa/server/src/lib/content.js +9 -0
- package/.medusa/server/src/lib/credentials/mask.d.ts +10 -0
- package/.medusa/server/src/lib/credentials/mask.js +55 -0
- package/.medusa/server/src/lib/credentials/resolve-credential.d.ts +11 -0
- package/.medusa/server/src/lib/credentials/resolve-credential.js +34 -0
- package/.medusa/server/src/lib/crypto/credential-cipher.d.ts +7 -0
- package/.medusa/server/src/lib/crypto/credential-cipher.js +65 -0
- package/.medusa/server/src/lib/crypto/encryption-key.d.ts +9 -0
- package/.medusa/server/src/lib/crypto/encryption-key.js +45 -0
- package/.medusa/server/src/lib/errors.d.ts +18 -0
- package/.medusa/server/src/lib/errors.js +40 -0
- package/.medusa/server/src/lib/events/built-in/default-templates/account.d.ts +6 -0
- package/.medusa/server/src/lib/events/built-in/default-templates/account.js +48 -0
- package/.medusa/server/src/lib/events/built-in/default-templates/design.d.ts +67 -0
- package/.medusa/server/src/lib/events/built-in/default-templates/design.js +94 -0
- package/.medusa/server/src/lib/events/built-in/default-templates/order-placed.d.ts +5 -0
- package/.medusa/server/src/lib/events/built-in/default-templates/order-placed.js +59 -0
- package/.medusa/server/src/lib/events/built-in/default-templates/repeat.d.ts +3 -0
- package/.medusa/server/src/lib/events/built-in/default-templates/repeat.js +23 -0
- package/.medusa/server/src/lib/events/built-in/email-verification.d.ts +13 -0
- package/.medusa/server/src/lib/events/built-in/email-verification.js +53 -0
- package/.medusa/server/src/lib/events/built-in/invite.d.ts +5 -0
- package/.medusa/server/src/lib/events/built-in/invite.js +91 -0
- package/.medusa/server/src/lib/events/built-in/order-placed.d.ts +4 -0
- package/.medusa/server/src/lib/events/built-in/order-placed.js +234 -0
- package/.medusa/server/src/lib/events/built-in/password-reset.d.ts +12 -0
- package/.medusa/server/src/lib/events/built-in/password-reset.js +83 -0
- package/.medusa/server/src/lib/events/built-in/store.d.ts +3 -0
- package/.medusa/server/src/lib/events/built-in/store.js +12 -0
- package/.medusa/server/src/lib/events/define-email-event.d.ts +6 -0
- package/.medusa/server/src/lib/events/define-email-event.js +11 -0
- package/.medusa/server/src/lib/events/index.d.ts +8 -0
- package/.medusa/server/src/lib/events/index.js +21 -0
- package/.medusa/server/src/lib/events/registry.d.ts +9 -0
- package/.medusa/server/src/lib/events/registry.js +55 -0
- package/.medusa/server/src/lib/events/types.d.ts +82 -0
- package/.medusa/server/src/lib/events/types.js +3 -0
- package/.medusa/server/src/lib/events/urls.d.ts +23 -0
- package/.medusa/server/src/lib/events/urls.js +79 -0
- package/.medusa/server/src/lib/provider-configuration.d.ts +51 -0
- package/.medusa/server/src/lib/provider-configuration.js +114 -0
- package/.medusa/server/src/lib/redact.d.ts +1 -0
- package/.medusa/server/src/lib/redact.js +12 -0
- package/.medusa/server/src/lib/rendering/format-value.d.ts +21 -0
- package/.medusa/server/src/lib/rendering/format-value.js +55 -0
- package/.medusa/server/src/lib/rendering/liquid.d.ts +5 -0
- package/.medusa/server/src/lib/rendering/liquid.js +52 -0
- package/.medusa/server/src/lib/rendering/render-template.d.ts +12 -0
- package/.medusa/server/src/lib/rendering/render-template.js +46 -0
- package/.medusa/server/src/lib/rendering/sanitize-context.d.ts +1 -0
- package/.medusa/server/src/lib/rendering/sanitize-context.js +14 -0
- package/.medusa/server/src/lib/rendering/variable-format.d.ts +43 -0
- package/.medusa/server/src/lib/rendering/variable-format.js +103 -0
- package/.medusa/server/src/lib/resolve-email-content.d.ts +9 -0
- package/.medusa/server/src/lib/resolve-email-content.js +35 -0
- package/.medusa/server/src/lib/templates.d.ts +55 -0
- package/.medusa/server/src/lib/templates.js +161 -0
- package/.medusa/server/src/lib/test-email.d.ts +7 -0
- package/.medusa/server/src/lib/test-email.js +21 -0
- package/.medusa/server/src/lib/transports/address.d.ts +3 -0
- package/.medusa/server/src/lib/transports/address.js +16 -0
- package/.medusa/server/src/lib/transports/cloud-config.d.ts +13 -0
- package/.medusa/server/src/lib/transports/cloud-config.js +30 -0
- package/.medusa/server/src/lib/transports/mailgun.d.ts +15 -0
- package/.medusa/server/src/lib/transports/mailgun.js +116 -0
- package/.medusa/server/src/lib/transports/medusa-cloud.d.ts +15 -0
- package/.medusa/server/src/lib/transports/medusa-cloud.js +81 -0
- package/.medusa/server/src/lib/transports/registry.d.ts +4 -0
- package/.medusa/server/src/lib/transports/registry.js +24 -0
- package/.medusa/server/src/lib/transports/resend.d.ts +11 -0
- package/.medusa/server/src/lib/transports/resend.js +93 -0
- package/.medusa/server/src/lib/transports/types.d.ts +46 -0
- package/.medusa/server/src/lib/transports/types.js +10 -0
- package/.medusa/server/src/modules/email-templates/index.d.ts +49 -0
- package/.medusa/server/src/modules/email-templates/index.js +13 -0
- package/.medusa/server/src/modules/email-templates/migrations/Migration20260915141601.d.ts +5 -0
- package/.medusa/server/src/modules/email-templates/migrations/Migration20260915141601.js +27 -0
- package/.medusa/server/src/modules/email-templates/migrations/Migration20260916090537.d.ts +5 -0
- package/.medusa/server/src/modules/email-templates/migrations/Migration20260916090537.js +18 -0
- package/.medusa/server/src/modules/email-templates/models/email-provider-configuration.d.ts +24 -0
- package/.medusa/server/src/modules/email-templates/models/email-provider-configuration.js +32 -0
- package/.medusa/server/src/modules/email-templates/models/email-provider-credential.d.ts +21 -0
- package/.medusa/server/src/modules/email-templates/models/email-provider-credential.js +32 -0
- package/.medusa/server/src/modules/email-templates/models/email-template.d.ts +11 -0
- package/.medusa/server/src/modules/email-templates/models/email-template.js +25 -0
- package/.medusa/server/src/modules/email-templates/service.d.ts +70 -0
- package/.medusa/server/src/modules/email-templates/service.js +24 -0
- package/.medusa/server/src/providers/email/index.d.ts +2 -0
- package/.medusa/server/src/providers/email/index.js +11 -0
- package/.medusa/server/src/providers/email/service.d.ts +17 -0
- package/.medusa/server/src/providers/email/service.js +57 -0
- package/.medusa/server/src/registry.d.ts +34 -0
- package/.medusa/server/src/registry.js +49 -0
- package/.medusa/server/src/subscribers/email-account-events.d.ts +3 -0
- package/.medusa/server/src/subscribers/email-account-events.js +31 -0
- package/.medusa/server/src/subscribers/email-order-placed.d.ts +5 -0
- package/.medusa/server/src/subscribers/email-order-placed.js +26 -0
- package/.medusa/server/src/workflows/index.d.ts +6 -0
- package/.medusa/server/src/workflows/index.js +23 -0
- package/.medusa/server/src/workflows/preview-email-template.d.ts +3 -0
- package/.medusa/server/src/workflows/preview-email-template.js +11 -0
- package/.medusa/server/src/workflows/reset-email-template.d.ts +6 -0
- package/.medusa/server/src/workflows/reset-email-template.js +11 -0
- package/.medusa/server/src/workflows/save-email-provider-configuration.d.ts +6 -0
- package/.medusa/server/src/workflows/save-email-provider-configuration.js +28 -0
- package/.medusa/server/src/workflows/send-email-event.d.ts +3 -0
- package/.medusa/server/src/workflows/send-email-event.js +13 -0
- package/.medusa/server/src/workflows/send-provider-test-email.d.ts +7 -0
- package/.medusa/server/src/workflows/send-provider-test-email.js +11 -0
- package/.medusa/server/src/workflows/send-template-test-email.d.ts +12 -0
- package/.medusa/server/src/workflows/send-template-test-email.js +30 -0
- package/.medusa/server/src/workflows/steps/assert-email-provider-ready.d.ts +5 -0
- package/.medusa/server/src/workflows/steps/assert-email-provider-ready.js +21 -0
- package/.medusa/server/src/workflows/steps/render-email-template.d.ts +8 -0
- package/.medusa/server/src/workflows/steps/render-email-template.js +22 -0
- package/.medusa/server/src/workflows/steps/reset-email-template.d.ts +14 -0
- package/.medusa/server/src/workflows/steps/reset-email-template.js +69 -0
- package/.medusa/server/src/workflows/steps/resolve-email-event.d.ts +20 -0
- package/.medusa/server/src/workflows/steps/resolve-email-event.js +56 -0
- package/.medusa/server/src/workflows/steps/select-email-provider-configuration.d.ts +27 -0
- package/.medusa/server/src/workflows/steps/select-email-provider-configuration.js +62 -0
- package/.medusa/server/src/workflows/steps/send-email-event-notification.d.ts +9 -0
- package/.medusa/server/src/workflows/steps/send-email-event-notification.js +70 -0
- package/.medusa/server/src/workflows/steps/send-test-email.d.ts +15 -0
- package/.medusa/server/src/workflows/steps/send-test-email.js +31 -0
- package/.medusa/server/src/workflows/steps/send-transport-test-email.d.ts +16 -0
- package/.medusa/server/src/workflows/steps/send-transport-test-email.js +49 -0
- package/.medusa/server/src/workflows/steps/upsert-email-provider-credential.d.ts +10 -0
- package/.medusa/server/src/workflows/steps/upsert-email-provider-credential.js +84 -0
- package/.medusa/server/src/workflows/steps/upsert-email-template.d.ts +22 -0
- package/.medusa/server/src/workflows/steps/upsert-email-template.js +94 -0
- package/.medusa/server/src/workflows/steps/validate-email-provider-configuration.d.ts +20 -0
- package/.medusa/server/src/workflows/steps/validate-email-provider-configuration.js +58 -0
- package/.medusa/server/src/workflows/upsert-email-template.d.ts +15 -0
- package/.medusa/server/src/workflows/upsert-email-template.js +11 -0
- package/LICENSE +21 -0
- package/README.md +169 -2
- package/package.json +130 -4
|
@@ -0,0 +1,234 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.orderPlacedEmailEvent = void 0;
|
|
4
|
+
const utils_1 = require("@medusajs/framework/utils");
|
|
5
|
+
const define_email_event_1 = require("../define-email-event");
|
|
6
|
+
const urls_1 = require("../urls");
|
|
7
|
+
const order_placed_1 = require("./default-templates/order-placed");
|
|
8
|
+
const store_1 = require("./store");
|
|
9
|
+
const ORDER_FIELDS = [
|
|
10
|
+
'id',
|
|
11
|
+
'display_id',
|
|
12
|
+
'email',
|
|
13
|
+
'currency_code',
|
|
14
|
+
'created_at',
|
|
15
|
+
'total',
|
|
16
|
+
'subtotal',
|
|
17
|
+
'shipping_total',
|
|
18
|
+
'tax_total',
|
|
19
|
+
'discount_total',
|
|
20
|
+
'items.id',
|
|
21
|
+
'items.title',
|
|
22
|
+
'items.variant_title',
|
|
23
|
+
'items.quantity',
|
|
24
|
+
'items.unit_price',
|
|
25
|
+
'items.total',
|
|
26
|
+
'shipping_address.*',
|
|
27
|
+
'customer.first_name',
|
|
28
|
+
'customer.last_name',
|
|
29
|
+
];
|
|
30
|
+
const retrieveOrder = async (id, container) => {
|
|
31
|
+
const query = container.resolve(utils_1.ContainerRegistrationKeys.QUERY);
|
|
32
|
+
const { data } = await query.graph({
|
|
33
|
+
entity: 'order',
|
|
34
|
+
fields: ORDER_FIELDS,
|
|
35
|
+
filters: { id },
|
|
36
|
+
});
|
|
37
|
+
return data[0] ?? null;
|
|
38
|
+
};
|
|
39
|
+
const customerName = (order) => [order.customer?.first_name, order.customer?.last_name]
|
|
40
|
+
.filter((part) => Boolean(part))
|
|
41
|
+
.join(' ')
|
|
42
|
+
.trim() || 'there';
|
|
43
|
+
exports.orderPlacedEmailEvent = (0, define_email_event_1.defineEmailEvent)({
|
|
44
|
+
event: 'order.placed',
|
|
45
|
+
templateKey: 'order-placed',
|
|
46
|
+
label: 'Order placed',
|
|
47
|
+
description: 'Sent to the customer when an order is placed.',
|
|
48
|
+
defaultTemplate: order_placed_1.orderPlacedDefaultTemplate,
|
|
49
|
+
snippets: [
|
|
50
|
+
{
|
|
51
|
+
key: 'order-totals',
|
|
52
|
+
label: 'Order totals',
|
|
53
|
+
description: 'Subtotal, discount, shipping, tax and total',
|
|
54
|
+
html: order_placed_1.ORDER_TOTALS,
|
|
55
|
+
},
|
|
56
|
+
],
|
|
57
|
+
getIdempotencyKey: (data) => `order.placed:${data.id}`,
|
|
58
|
+
getResource: (data) => ({ resource_id: data.id, resource_type: 'order' }),
|
|
59
|
+
async getRecipient(data, container) {
|
|
60
|
+
const order = await retrieveOrder(data.id, container);
|
|
61
|
+
return order?.email ?? null;
|
|
62
|
+
},
|
|
63
|
+
async getContext(data, container) {
|
|
64
|
+
const order = await retrieveOrder(data.id, container);
|
|
65
|
+
if (!order) {
|
|
66
|
+
throw new Error(`Order "${data.id}" was not found.`);
|
|
67
|
+
}
|
|
68
|
+
return {
|
|
69
|
+
order: {
|
|
70
|
+
id: order.id,
|
|
71
|
+
display_id: order.display_id,
|
|
72
|
+
email: order.email,
|
|
73
|
+
currency_code: order.currency_code,
|
|
74
|
+
created_at: order.created_at,
|
|
75
|
+
customer_name: customerName(order),
|
|
76
|
+
subtotal: order.subtotal,
|
|
77
|
+
shipping_total: order.shipping_total,
|
|
78
|
+
tax_total: order.tax_total,
|
|
79
|
+
discount_total: order.discount_total,
|
|
80
|
+
total: order.total,
|
|
81
|
+
items: (order.items ?? []).map((item) => ({
|
|
82
|
+
id: item.id,
|
|
83
|
+
title: item.title,
|
|
84
|
+
variant_title: item.variant_title,
|
|
85
|
+
quantity: item.quantity,
|
|
86
|
+
unit_price: item.unit_price,
|
|
87
|
+
total: item.total,
|
|
88
|
+
})),
|
|
89
|
+
shipping_address: order.shipping_address ?? null,
|
|
90
|
+
},
|
|
91
|
+
order_url: (0, urls_1.getOrderUrl)(container, order.id),
|
|
92
|
+
store: { name: await (0, store_1.retrieveStoreName)(container) },
|
|
93
|
+
};
|
|
94
|
+
},
|
|
95
|
+
variables: [
|
|
96
|
+
{
|
|
97
|
+
key: 'order.display_id',
|
|
98
|
+
label: 'Order number',
|
|
99
|
+
example: 1001,
|
|
100
|
+
group: 'Order',
|
|
101
|
+
},
|
|
102
|
+
{
|
|
103
|
+
key: 'order.customer_name',
|
|
104
|
+
label: 'Customer name',
|
|
105
|
+
example: 'Jane Doe',
|
|
106
|
+
group: 'Order',
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
key: 'order.email',
|
|
110
|
+
label: 'Email',
|
|
111
|
+
example: 'jane@example.com',
|
|
112
|
+
group: 'Order',
|
|
113
|
+
},
|
|
114
|
+
{
|
|
115
|
+
key: 'order.currency_code',
|
|
116
|
+
label: 'Currency',
|
|
117
|
+
example: 'eur',
|
|
118
|
+
group: 'Order',
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
key: 'order.created_at',
|
|
122
|
+
label: 'Order date',
|
|
123
|
+
example: '2026-10-01T10:00:00.000Z',
|
|
124
|
+
type: 'date',
|
|
125
|
+
group: 'Order',
|
|
126
|
+
},
|
|
127
|
+
{
|
|
128
|
+
key: 'order.items',
|
|
129
|
+
label: 'Order items',
|
|
130
|
+
type: 'list',
|
|
131
|
+
group: 'Order',
|
|
132
|
+
example: [
|
|
133
|
+
{
|
|
134
|
+
title: 'Medusa T-Shirt',
|
|
135
|
+
variant_title: 'M / Black',
|
|
136
|
+
quantity: 2,
|
|
137
|
+
unit_price: 15,
|
|
138
|
+
total: 30,
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
title: 'Medusa Hoodie',
|
|
142
|
+
variant_title: 'L',
|
|
143
|
+
quantity: 1,
|
|
144
|
+
unit_price: 10,
|
|
145
|
+
total: 10,
|
|
146
|
+
},
|
|
147
|
+
],
|
|
148
|
+
itemTemplate: order_placed_1.ORDER_ITEM_ROW,
|
|
149
|
+
fields: [
|
|
150
|
+
{ key: 'title', label: 'Product', example: 'Medusa T-Shirt' },
|
|
151
|
+
{ key: 'variant_title', label: 'Variant', example: 'M / Black' },
|
|
152
|
+
{ key: 'quantity', label: 'Quantity', example: 2, type: 'number' },
|
|
153
|
+
{
|
|
154
|
+
key: 'unit_price',
|
|
155
|
+
label: 'Unit price',
|
|
156
|
+
example: 15,
|
|
157
|
+
type: 'money',
|
|
158
|
+
currencyKey: 'order.currency_code',
|
|
159
|
+
},
|
|
160
|
+
{
|
|
161
|
+
key: 'total',
|
|
162
|
+
label: 'Line total',
|
|
163
|
+
example: 30,
|
|
164
|
+
type: 'money',
|
|
165
|
+
currencyKey: 'order.currency_code',
|
|
166
|
+
},
|
|
167
|
+
],
|
|
168
|
+
},
|
|
169
|
+
{
|
|
170
|
+
key: 'order.subtotal',
|
|
171
|
+
label: 'Subtotal',
|
|
172
|
+
example: 40,
|
|
173
|
+
type: 'money',
|
|
174
|
+
currencyKey: 'order.currency_code',
|
|
175
|
+
group: 'Totals',
|
|
176
|
+
},
|
|
177
|
+
{
|
|
178
|
+
key: 'order.shipping_total',
|
|
179
|
+
label: 'Shipping total',
|
|
180
|
+
example: 10,
|
|
181
|
+
type: 'money',
|
|
182
|
+
currencyKey: 'order.currency_code',
|
|
183
|
+
group: 'Totals',
|
|
184
|
+
},
|
|
185
|
+
{
|
|
186
|
+
key: 'order.tax_total',
|
|
187
|
+
label: 'Tax total',
|
|
188
|
+
example: 5,
|
|
189
|
+
type: 'money',
|
|
190
|
+
currencyKey: 'order.currency_code',
|
|
191
|
+
group: 'Totals',
|
|
192
|
+
},
|
|
193
|
+
{
|
|
194
|
+
key: 'order.discount_total',
|
|
195
|
+
label: 'Discount total',
|
|
196
|
+
example: 0,
|
|
197
|
+
type: 'money',
|
|
198
|
+
currencyKey: 'order.currency_code',
|
|
199
|
+
group: 'Totals',
|
|
200
|
+
},
|
|
201
|
+
{
|
|
202
|
+
key: 'order.total',
|
|
203
|
+
label: 'Total',
|
|
204
|
+
example: 55,
|
|
205
|
+
type: 'money',
|
|
206
|
+
currencyKey: 'order.currency_code',
|
|
207
|
+
group: 'Totals',
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
key: 'order_url',
|
|
211
|
+
label: 'Order link',
|
|
212
|
+
description: 'Link to this order on the storefront. Needs storefront_url to be configured.',
|
|
213
|
+
example: 'https://shop.example.com/orders/order_01J8Z',
|
|
214
|
+
type: 'url',
|
|
215
|
+
group: 'Order',
|
|
216
|
+
},
|
|
217
|
+
{
|
|
218
|
+
key: 'store.name',
|
|
219
|
+
label: 'Store name',
|
|
220
|
+
example: 'Medusa Store',
|
|
221
|
+
group: 'Store',
|
|
222
|
+
},
|
|
223
|
+
],
|
|
224
|
+
getWarnings: (container) => {
|
|
225
|
+
try {
|
|
226
|
+
(0, urls_1.getStorefrontUrl)(container);
|
|
227
|
+
return [];
|
|
228
|
+
}
|
|
229
|
+
catch {
|
|
230
|
+
return ['order_link_unavailable'];
|
|
231
|
+
}
|
|
232
|
+
},
|
|
233
|
+
});
|
|
234
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3JkZXItcGxhY2VkLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vLi4vc3JjL2xpYi9ldmVudHMvYnVpbHQtaW4vb3JkZXItcGxhY2VkLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUNBLHFEQUFzRTtBQUV0RSw4REFBeUQ7QUFDekQsa0NBQXdEO0FBQ3hELG1FQUkwQztBQUMxQyxtQ0FBNEM7QUEyQjVDLE1BQU0sWUFBWSxHQUFHO0lBQ25CLElBQUk7SUFDSixZQUFZO0lBQ1osT0FBTztJQUNQLGVBQWU7SUFDZixZQUFZO0lBQ1osT0FBTztJQUNQLFVBQVU7SUFDVixnQkFBZ0I7SUFDaEIsV0FBVztJQUNYLGdCQUFnQjtJQUNoQixVQUFVO0lBQ1YsYUFBYTtJQUNiLHFCQUFxQjtJQUNyQixnQkFBZ0I7SUFDaEIsa0JBQWtCO0lBQ2xCLGFBQWE7SUFDYixvQkFBb0I7SUFDcEIscUJBQXFCO0lBQ3JCLG9CQUFvQjtDQUNyQixDQUFDO0FBRUYsTUFBTSxhQUFhLEdBQUcsS0FBSyxFQUN6QixFQUFVLEVBQ1YsU0FBMEIsRUFDRyxFQUFFO0lBQy9CLE1BQU0sS0FBSyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUMsaUNBQXlCLENBQUMsS0FBSyxDQUFDLENBQUM7SUFDakUsTUFBTSxFQUFFLElBQUksRUFBRSxHQUFHLE1BQU0sS0FBSyxDQUFDLEtBQUssQ0FBQztRQUNqQyxNQUFNLEVBQUUsT0FBTztRQUNmLE1BQU0sRUFBRSxZQUFZO1FBQ3BCLE9BQU8sRUFBRSxFQUFFLEVBQUUsRUFBRTtLQUNoQixDQUFDLENBQUM7SUFFSCxPQUFRLElBQUksQ0FBQyxDQUFDLENBQTZCLElBQUksSUFBSSxDQUFDO0FBQ3RELENBQUMsQ0FBQztBQUVGLE1BQU0sWUFBWSxHQUFHLENBQUMsS0FBa0IsRUFBVSxFQUFFLENBQ2xELENBQUMsS0FBSyxDQUFDLFFBQVEsRUFBRSxVQUFVLEVBQUUsS0FBSyxDQUFDLFFBQVEsRUFBRSxTQUFTLENBQUM7S0FDcEQsTUFBTSxDQUFDLENBQUMsSUFBSSxFQUFrQixFQUFFLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO0tBQy9DLElBQUksQ0FBQyxHQUFHLENBQUM7S0FDVCxJQUFJLEVBQUUsSUFBSSxPQUFPLENBQUM7QUFFVixRQUFBLHFCQUFxQixHQUFHLElBQUEscUNBQWdCLEVBQXVCO0lBQzFFLEtBQUssRUFBRSxjQUFjO0lBQ3JCLFdBQVcsRUFBRSxjQUFjO0lBQzNCLEtBQUssRUFBRSxjQUFjO0lBQ3JCLFdBQVcsRUFBRSwrQ0FBK0M7SUFDNUQsZUFBZSxFQUFFLHlDQUEwQjtJQUMzQyxRQUFRLEVBQUU7UUFDUjtZQUNFLEdBQUcsRUFBRSxjQUFjO1lBQ25CLEtBQUssRUFBRSxjQUFjO1lBQ3JCLFdBQVcsRUFBRSw2Q0FBNkM7WUFDMUQsSUFBSSxFQUFFLDJCQUFZO1NBQ25CO0tBQ0Y7SUFDRCxpQkFBaUIsRUFBRSxDQUFDLElBQUksRUFBRSxFQUFFLENBQUMsZ0JBQWdCLElBQUksQ0FBQyxFQUFFLEVBQUU7SUFDdEQsV0FBVyxFQUFFLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxDQUFDLEVBQUUsV0FBVyxFQUFFLElBQUksQ0FBQyxFQUFFLEVBQUUsYUFBYSxFQUFFLE9BQU8sRUFBRSxDQUFDO0lBRXpFLEtBQUssQ0FBQyxZQUFZLENBQUMsSUFBSSxFQUFFLFNBQVM7UUFDaEMsTUFBTSxLQUFLLEdBQUcsTUFBTSxhQUFhLENBQUMsSUFBSSxDQUFDLEVBQUUsRUFBRSxTQUFTLENBQUMsQ0FBQztRQUV0RCxPQUFPLEtBQUssRUFBRSxLQUFLLElBQUksSUFBSSxDQUFDO0lBQzlCLENBQUM7SUFFRCxLQUFLLENBQUMsVUFBVSxDQUFDLElBQUksRUFBRSxTQUFTO1FBQzlCLE1BQU0sS0FBSyxHQUFHLE1BQU0sYUFBYSxDQUFDLElBQUksQ0FBQyxFQUFFLEVBQUUsU0FBUyxDQUFDLENBQUM7UUFFdEQsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDO1lBQ1gsTUFBTSxJQUFJLEtBQUssQ0FBQyxVQUFVLElBQUksQ0FBQyxFQUFFLGtCQUFrQixDQUFDLENBQUM7UUFDdkQsQ0FBQztRQUVELE9BQU87WUFDTCxLQUFLLEVBQUU7Z0JBQ0wsRUFBRSxFQUFFLEtBQUssQ0FBQyxFQUFFO2dCQUNaLFVBQVUsRUFBRSxLQUFLLENBQUMsVUFBVTtnQkFDNUIsS0FBSyxFQUFFLEtBQUssQ0FBQyxLQUFLO2dCQUNsQixhQUFhLEVBQUUsS0FBSyxDQUFDLGFBQWE7Z0JBQ2xDLFVBQVUsRUFBRSxLQUFLLENBQUMsVUFBVTtnQkFDNUIsYUFBYSxFQUFFLFlBQVksQ0FBQyxLQUFLLENBQUM7Z0JBQ2xDLFFBQVEsRUFBRSxLQUFLLENBQUMsUUFBUTtnQkFDeEIsY0FBYyxFQUFFLEtBQUssQ0FBQyxjQUFjO2dCQUNwQyxTQUFTLEVBQUUsS0FBSyxDQUFDLFNBQVM7Z0JBQzFCLGNBQWMsRUFBRSxLQUFLLENBQUMsY0FBYztnQkFDcEMsS0FBSyxFQUFFLEtBQUssQ0FBQyxLQUFLO2dCQUNsQixLQUFLLEVBQUUsQ0FBQyxLQUFLLENBQUMsS0FBSyxJQUFJLEVBQUUsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksRUFBRSxFQUFFLENBQUMsQ0FBQztvQkFDeEMsRUFBRSxFQUFFLElBQUksQ0FBQyxFQUFFO29CQUNYLEtBQUssRUFBRSxJQUFJLENBQUMsS0FBSztvQkFDakIsYUFBYSxFQUFFLElBQUksQ0FBQyxhQUFhO29CQUNqQyxRQUFRLEVBQUUsSUFBSSxDQUFDLFFBQVE7b0JBQ3ZCLFVBQVUsRUFBRSxJQUFJLENBQUMsVUFBVTtvQkFDM0IsS0FBSyxFQUFFLElBQUksQ0FBQyxLQUFLO2lCQUNsQixDQUFDLENBQUM7Z0JBQ0gsZ0JBQWdCLEVBQUUsS0FBSyxDQUFDLGdCQUFnQixJQUFJLElBQUk7YUFDakQ7WUFDRCxTQUFTLEVBQUUsSUFBQSxrQkFBVyxFQUFDLFNBQVMsRUFBRSxLQUFLLENBQUMsRUFBRSxDQUFDO1lBQzNDLEtBQUssRUFBRSxFQUFFLElBQUksRUFBRSxNQUFNLElBQUEseUJBQWlCLEVBQUMsU0FBUyxDQUFDLEVBQUU7U0FDcEQsQ0FBQztJQUNKLENBQUM7SUFFRCxTQUFTLEVBQUU7UUFDVDtZQUNFLEdBQUcsRUFBRSxrQkFBa0I7WUFDdkIsS0FBSyxFQUFFLGNBQWM7WUFDckIsT0FBTyxFQUFFLElBQUk7WUFDYixLQUFLLEVBQUUsT0FBTztTQUNmO1FBQ0Q7WUFDRSxHQUFHLEVBQUUscUJBQXFCO1lBQzFCLEtBQUssRUFBRSxlQUFlO1lBQ3RCLE9BQU8sRUFBRSxVQUFVO1lBQ25CLEtBQUssRUFBRSxPQUFPO1NBQ2Y7UUFDRDtZQUNFLEdBQUcsRUFBRSxhQUFhO1lBQ2xCLEtBQUssRUFBRSxPQUFPO1lBQ2QsT0FBTyxFQUFFLGtCQUFrQjtZQUMzQixLQUFLLEVBQUUsT0FBTztTQUNmO1FBQ0Q7WUFDRSxHQUFHLEVBQUUscUJBQXFCO1lBQzFCLEtBQUssRUFBRSxVQUFVO1lBQ2pCLE9BQU8sRUFBRSxLQUFLO1lBQ2QsS0FBSyxFQUFFLE9BQU87U0FDZjtRQUNEO1lBQ0UsR0FBRyxFQUFFLGtCQUFrQjtZQUN2QixLQUFLLEVBQUUsWUFBWTtZQUNuQixPQUFPLEVBQUUsMEJBQTBCO1lBQ25DLElBQUksRUFBRSxNQUFNO1lBQ1osS0FBSyxFQUFFLE9BQU87U0FDZjtRQUNEO1lBQ0UsR0FBRyxFQUFFLGFBQWE7WUFDbEIsS0FBSyxFQUFFLGFBQWE7WUFDcEIsSUFBSSxFQUFFLE1BQU07WUFDWixLQUFLLEVBQUUsT0FBTztZQUNkLE9BQU8sRUFBRTtnQkFDUDtvQkFDRSxLQUFLLEVBQUUsZ0JBQWdCO29CQUN2QixhQUFhLEVBQUUsV0FBVztvQkFDMUIsUUFBUSxFQUFFLENBQUM7b0JBQ1gsVUFBVSxFQUFFLEVBQUU7b0JBQ2QsS0FBSyxFQUFFLEVBQUU7aUJBQ1Y7Z0JBQ0Q7b0JBQ0UsS0FBSyxFQUFFLGVBQWU7b0JBQ3RCLGFBQWEsRUFBRSxHQUFHO29CQUNsQixRQUFRLEVBQUUsQ0FBQztvQkFDWCxVQUFVLEVBQUUsRUFBRTtvQkFDZCxLQUFLLEVBQUUsRUFBRTtpQkFDVjthQUNGO1lBQ0QsWUFBWSxFQUFFLDZCQUFjO1lBQzVCLE1BQU0sRUFBRTtnQkFDTixFQUFFLEdBQUcsRUFBRSxPQUFPLEVBQUUsS0FBSyxFQUFFLFNBQVMsRUFBRSxPQUFPLEVBQUUsZ0JBQWdCLEVBQUU7Z0JBQzdELEVBQUUsR0FBRyxFQUFFLGVBQWUsRUFBRSxLQUFLLEVBQUUsU0FBUyxFQUFFLE9BQU8sRUFBRSxXQUFXLEVBQUU7Z0JBQ2hFLEVBQUUsR0FBRyxFQUFFLFVBQVUsRUFBRSxLQUFLLEVBQUUsVUFBVSxFQUFFLE9BQU8sRUFBRSxDQUFDLEVBQUUsSUFBSSxFQUFFLFFBQVEsRUFBRTtnQkFDbEU7b0JBQ0UsR0FBRyxFQUFFLFlBQVk7b0JBQ2pCLEtBQUssRUFBRSxZQUFZO29CQUNuQixPQUFPLEVBQUUsRUFBRTtvQkFDWCxJQUFJLEVBQUUsT0FBTztvQkFDYixXQUFXLEVBQUUscUJBQXFCO2lCQUNuQztnQkFDRDtvQkFDRSxHQUFHLEVBQUUsT0FBTztvQkFDWixLQUFLLEVBQUUsWUFBWTtvQkFDbkIsT0FBTyxFQUFFLEVBQUU7b0JBQ1gsSUFBSSxFQUFFLE9BQU87b0JBQ2IsV0FBVyxFQUFFLHFCQUFxQjtpQkFDbkM7YUFDRjtTQUNGO1FBQ0Q7WUFDRSxHQUFHLEVBQUUsZ0JBQWdCO1lBQ3JCLEtBQUssRUFBRSxVQUFVO1lBQ2pCLE9BQU8sRUFBRSxFQUFFO1lBQ1gsSUFBSSxFQUFFLE9BQU87WUFDYixXQUFXLEVBQUUscUJBQXFCO1lBQ2xDLEtBQUssRUFBRSxRQUFRO1NBQ2hCO1FBQ0Q7WUFDRSxHQUFHLEVBQUUsc0JBQXNCO1lBQzNCLEtBQUssRUFBRSxnQkFBZ0I7WUFDdkIsT0FBTyxFQUFFLEVBQUU7WUFDWCxJQUFJLEVBQUUsT0FBTztZQUNiLFdBQVcsRUFBRSxxQkFBcUI7WUFDbEMsS0FBSyxFQUFFLFFBQVE7U0FDaEI7UUFDRDtZQUNFLEdBQUcsRUFBRSxpQkFBaUI7WUFDdEIsS0FBSyxFQUFFLFdBQVc7WUFDbEIsT0FBTyxFQUFFLENBQUM7WUFDVixJQUFJLEVBQUUsT0FBTztZQUNiLFdBQVcsRUFBRSxxQkFBcUI7WUFDbEMsS0FBSyxFQUFFLFFBQVE7U0FDaEI7UUFDRDtZQUNFLEdBQUcsRUFBRSxzQkFBc0I7WUFDM0IsS0FBSyxFQUFFLGdCQUFnQjtZQUN2QixPQUFPLEVBQUUsQ0FBQztZQUNWLElBQUksRUFBRSxPQUFPO1lBQ2IsV0FBVyxFQUFFLHFCQUFxQjtZQUNsQyxLQUFLLEVBQUUsUUFBUTtTQUNoQjtRQUNEO1lBQ0UsR0FBRyxFQUFFLGFBQWE7WUFDbEIsS0FBSyxFQUFFLE9BQU87WUFDZCxPQUFPLEVBQUUsRUFBRTtZQUNYLElBQUksRUFBRSxPQUFPO1lBQ2IsV0FBVyxFQUFFLHFCQUFxQjtZQUNsQyxLQUFLLEVBQUUsUUFBUTtTQUNoQjtRQUNEO1lBQ0UsR0FBRyxFQUFFLFdBQVc7WUFDaEIsS0FBSyxFQUFFLFlBQVk7WUFDbkIsV0FBVyxFQUNULDhFQUE4RTtZQUNoRixPQUFPLEVBQUUsNkNBQTZDO1lBQ3RELElBQUksRUFBRSxLQUFLO1lBQ1gsS0FBSyxFQUFFLE9BQU87U0FDZjtRQUNEO1lBQ0UsR0FBRyxFQUFFLFlBQVk7WUFDakIsS0FBSyxFQUFFLFlBQVk7WUFDbkIsT0FBTyxFQUFFLGNBQWM7WUFDdkIsS0FBSyxFQUFFLE9BQU87U0FDZjtLQUNGO0lBRUQsV0FBVyxFQUFFLENBQUMsU0FBUyxFQUFFLEVBQUU7UUFDekIsSUFBSSxDQUFDO1lBQ0gsSUFBQSx1QkFBZ0IsRUFBQyxTQUFTLENBQUMsQ0FBQztZQUM1QixPQUFPLEVBQUUsQ0FBQztRQUNaLENBQUM7UUFBQyxNQUFNLENBQUM7WUFDUCxPQUFPLENBQUMsd0JBQXdCLENBQUMsQ0FBQztRQUNwQyxDQUFDO0lBQ0gsQ0FBQztDQUNGLENBQUMsQ0FBQyJ9
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Medusa emits one `auth.password_reset` event for every actor, so the two
|
|
3
|
+
* definitions below are told apart by `actor_type`.
|
|
4
|
+
*/
|
|
5
|
+
export type PasswordResetEventData = {
|
|
6
|
+
entity_id: string;
|
|
7
|
+
actor_type: string;
|
|
8
|
+
token: string;
|
|
9
|
+
metadata?: Record<string, unknown>;
|
|
10
|
+
};
|
|
11
|
+
export declare const passwordResetUserEmailEvent: import("../types").EmailEventDefinition<PasswordResetEventData>;
|
|
12
|
+
export declare const passwordResetCustomerEmailEvent: import("../types").EmailEventDefinition<PasswordResetEventData>;
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.passwordResetCustomerEmailEvent = exports.passwordResetUserEmailEvent = void 0;
|
|
4
|
+
const define_email_event_1 = require("../define-email-event");
|
|
5
|
+
const urls_1 = require("../urls");
|
|
6
|
+
const account_1 = require("./default-templates/account");
|
|
7
|
+
const store_1 = require("./store");
|
|
8
|
+
const EMAIL_PATTERN = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
|
|
9
|
+
// `entity_id` is whatever identifies the actor; for the emailpass provider
|
|
10
|
+
// that is the email address.
|
|
11
|
+
const recipientFromEntityId = async (data) => EMAIL_PATTERN.test(data.entity_id) ? data.entity_id : null;
|
|
12
|
+
const variables = (resetLabel) => [
|
|
13
|
+
{
|
|
14
|
+
key: 'email',
|
|
15
|
+
label: 'Email',
|
|
16
|
+
example: 'jane@example.com',
|
|
17
|
+
group: 'Account',
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
key: 'reset_url',
|
|
21
|
+
label: 'Reset link',
|
|
22
|
+
description: resetLabel,
|
|
23
|
+
example: 'https://example.com/reset-password?token=abc&email=jane%40example.com',
|
|
24
|
+
type: 'url',
|
|
25
|
+
group: 'Account',
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
key: 'store.name',
|
|
29
|
+
label: 'Store name',
|
|
30
|
+
example: 'Medusa Store',
|
|
31
|
+
group: 'Store',
|
|
32
|
+
},
|
|
33
|
+
];
|
|
34
|
+
exports.passwordResetUserEmailEvent = (0, define_email_event_1.defineEmailEvent)({
|
|
35
|
+
event: 'auth.password_reset',
|
|
36
|
+
templateKey: 'password-reset-user',
|
|
37
|
+
label: 'Password reset (admin user)',
|
|
38
|
+
description: 'Sent when an admin user requests a password reset.',
|
|
39
|
+
defaultTemplate: account_1.passwordResetUserDefaultTemplate,
|
|
40
|
+
matches: (data) => data.actor_type === 'user',
|
|
41
|
+
getRecipient: recipientFromEntityId,
|
|
42
|
+
async getContext(data, container) {
|
|
43
|
+
const query = (0, urls_1.buildQuery)({ token: data.token, email: data.entity_id });
|
|
44
|
+
return {
|
|
45
|
+
email: data.entity_id,
|
|
46
|
+
actor_type: data.actor_type,
|
|
47
|
+
reset_url: `${(0, urls_1.getAdminUrl)(container)}/reset-password?${query}`,
|
|
48
|
+
store: { name: await (0, store_1.retrieveStoreName)(container) },
|
|
49
|
+
};
|
|
50
|
+
},
|
|
51
|
+
variables: variables('Link to Medusa Admin that sets a new password.'),
|
|
52
|
+
});
|
|
53
|
+
exports.passwordResetCustomerEmailEvent = (0, define_email_event_1.defineEmailEvent)({
|
|
54
|
+
event: 'auth.password_reset',
|
|
55
|
+
templateKey: 'password-reset-customer',
|
|
56
|
+
label: 'Password reset (customer)',
|
|
57
|
+
description: 'Sent when a customer requests a password reset. Needs storefront_url in the plugin options.',
|
|
58
|
+
defaultTemplate: account_1.passwordResetCustomerDefaultTemplate,
|
|
59
|
+
matches: (data) => data.actor_type === 'customer',
|
|
60
|
+
getRecipient: recipientFromEntityId,
|
|
61
|
+
async getContext(data, container) {
|
|
62
|
+
const storefrontUrl = (0, urls_1.getStorefrontUrl)(container);
|
|
63
|
+
const path = (0, urls_1.getStorefrontResetPasswordPath)(container);
|
|
64
|
+
const query = (0, urls_1.buildQuery)({ token: data.token, email: data.entity_id });
|
|
65
|
+
return {
|
|
66
|
+
email: data.entity_id,
|
|
67
|
+
actor_type: data.actor_type,
|
|
68
|
+
reset_url: `${storefrontUrl}${path}?${query}`,
|
|
69
|
+
store: { name: await (0, store_1.retrieveStoreName)(container) },
|
|
70
|
+
};
|
|
71
|
+
},
|
|
72
|
+
variables: variables('Link to your storefront that sets a new password.'),
|
|
73
|
+
getWarnings: (container) => {
|
|
74
|
+
try {
|
|
75
|
+
(0, urls_1.getStorefrontUrl)(container);
|
|
76
|
+
return [];
|
|
77
|
+
}
|
|
78
|
+
catch {
|
|
79
|
+
return ['storefront_url_not_configured'];
|
|
80
|
+
}
|
|
81
|
+
},
|
|
82
|
+
});
|
|
83
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGFzc3dvcmQtcmVzZXQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi8uLi9zcmMvbGliL2V2ZW50cy9idWlsdC1pbi9wYXNzd29yZC1yZXNldC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFFQSw4REFBeUQ7QUFFekQsa0NBS2lCO0FBQ2pCLHlEQUdxQztBQUNyQyxtQ0FBNEM7QUFhNUMsTUFBTSxhQUFhLEdBQUcsNEJBQTRCLENBQUM7QUFFbkQsMkVBQTJFO0FBQzNFLDZCQUE2QjtBQUM3QixNQUFNLHFCQUFxQixHQUFHLEtBQUssRUFDakMsSUFBNEIsRUFDSixFQUFFLENBQzFCLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUM7QUFFN0QsTUFBTSxTQUFTLEdBQUcsQ0FBQyxVQUFrQixFQUEyQixFQUFFLENBQUM7SUFDakU7UUFDRSxHQUFHLEVBQUUsT0FBTztRQUNaLEtBQUssRUFBRSxPQUFPO1FBQ2QsT0FBTyxFQUFFLGtCQUFrQjtRQUMzQixLQUFLLEVBQUUsU0FBUztLQUNqQjtJQUNEO1FBQ0UsR0FBRyxFQUFFLFdBQVc7UUFDaEIsS0FBSyxFQUFFLFlBQVk7UUFDbkIsV0FBVyxFQUFFLFVBQVU7UUFDdkIsT0FBTyxFQUNMLHVFQUF1RTtRQUN6RSxJQUFJLEVBQUUsS0FBSztRQUNYLEtBQUssRUFBRSxTQUFTO0tBQ2pCO0lBQ0Q7UUFDRSxHQUFHLEVBQUUsWUFBWTtRQUNqQixLQUFLLEVBQUUsWUFBWTtRQUNuQixPQUFPLEVBQUUsY0FBYztRQUN2QixLQUFLLEVBQUUsT0FBTztLQUNmO0NBQ0YsQ0FBQztBQUVXLFFBQUEsMkJBQTJCLEdBQ3RDLElBQUEscUNBQWdCLEVBQXlCO0lBQ3ZDLEtBQUssRUFBRSxxQkFBcUI7SUFDNUIsV0FBVyxFQUFFLHFCQUFxQjtJQUNsQyxLQUFLLEVBQUUsNkJBQTZCO0lBQ3BDLFdBQVcsRUFBRSxvREFBb0Q7SUFDakUsZUFBZSxFQUFFLDBDQUFnQztJQUNqRCxPQUFPLEVBQUUsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxVQUFVLEtBQUssTUFBTTtJQUM3QyxZQUFZLEVBQUUscUJBQXFCO0lBRW5DLEtBQUssQ0FBQyxVQUFVLENBQUMsSUFBSSxFQUFFLFNBQTBCO1FBQy9DLE1BQU0sS0FBSyxHQUFHLElBQUEsaUJBQVUsRUFBQyxFQUFFLEtBQUssRUFBRSxJQUFJLENBQUMsS0FBSyxFQUFFLEtBQUssRUFBRSxJQUFJLENBQUMsU0FBUyxFQUFFLENBQUMsQ0FBQztRQUV2RSxPQUFPO1lBQ0wsS0FBSyxFQUFFLElBQUksQ0FBQyxTQUFTO1lBQ3JCLFVBQVUsRUFBRSxJQUFJLENBQUMsVUFBVTtZQUMzQixTQUFTLEVBQUUsR0FBRyxJQUFBLGtCQUFXLEVBQUMsU0FBUyxDQUFDLG1CQUFtQixLQUFLLEVBQUU7WUFDOUQsS0FBSyxFQUFFLEVBQUUsSUFBSSxFQUFFLE1BQU0sSUFBQSx5QkFBaUIsRUFBQyxTQUFTLENBQUMsRUFBRTtTQUNwRCxDQUFDO0lBQ0osQ0FBQztJQUVELFNBQVMsRUFBRSxTQUFTLENBQUMsZ0RBQWdELENBQUM7Q0FDdkUsQ0FBQyxDQUFDO0FBRVEsUUFBQSwrQkFBK0IsR0FDMUMsSUFBQSxxQ0FBZ0IsRUFBeUI7SUFDdkMsS0FBSyxFQUFFLHFCQUFxQjtJQUM1QixXQUFXLEVBQUUseUJBQXlCO0lBQ3RDLEtBQUssRUFBRSwyQkFBMkI7SUFDbEMsV0FBVyxFQUNULDZGQUE2RjtJQUMvRixlQUFlLEVBQUUsOENBQW9DO0lBQ3JELE9BQU8sRUFBRSxDQUFDLElBQUksRUFBRSxFQUFFLENBQUMsSUFBSSxDQUFDLFVBQVUsS0FBSyxVQUFVO0lBQ2pELFlBQVksRUFBRSxxQkFBcUI7SUFFbkMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxJQUFJLEVBQUUsU0FBMEI7UUFDL0MsTUFBTSxhQUFhLEdBQUcsSUFBQSx1QkFBZ0IsRUFBQyxTQUFTLENBQUMsQ0FBQztRQUNsRCxNQUFNLElBQUksR0FBRyxJQUFBLHFDQUE4QixFQUFDLFNBQVMsQ0FBQyxDQUFDO1FBQ3ZELE1BQU0sS0FBSyxHQUFHLElBQUEsaUJBQVUsRUFBQyxFQUFFLEtBQUssRUFBRSxJQUFJLENBQUMsS0FBSyxFQUFFLEtBQUssRUFBRSxJQUFJLENBQUMsU0FBUyxFQUFFLENBQUMsQ0FBQztRQUV2RSxPQUFPO1lBQ0wsS0FBSyxFQUFFLElBQUksQ0FBQyxTQUFTO1lBQ3JCLFVBQVUsRUFBRSxJQUFJLENBQUMsVUFBVTtZQUMzQixTQUFTLEVBQUUsR0FBRyxhQUFhLEdBQUcsSUFBSSxJQUFJLEtBQUssRUFBRTtZQUM3QyxLQUFLLEVBQUUsRUFBRSxJQUFJLEVBQUUsTUFBTSxJQUFBLHlCQUFpQixFQUFDLFNBQVMsQ0FBQyxFQUFFO1NBQ3BELENBQUM7SUFDSixDQUFDO0lBRUQsU0FBUyxFQUFFLFNBQVMsQ0FBQyxtREFBbUQsQ0FBQztJQUV6RSxXQUFXLEVBQUUsQ0FBQyxTQUFTLEVBQUUsRUFBRTtRQUN6QixJQUFJLENBQUM7WUFDSCxJQUFBLHVCQUFnQixFQUFDLFNBQVMsQ0FBQyxDQUFDO1lBQzVCLE9BQU8sRUFBRSxDQUFDO1FBQ1osQ0FBQztRQUFDLE1BQU0sQ0FBQztZQUNQLE9BQU8sQ0FBQywrQkFBK0IsQ0FBQyxDQUFDO1FBQzNDLENBQUM7SUFDSCxDQUFDO0NBQ0YsQ0FBQyxDQUFDIn0=
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.retrieveStoreName = exports.DEFAULT_STORE_NAME = void 0;
|
|
4
|
+
const utils_1 = require("@medusajs/framework/utils");
|
|
5
|
+
exports.DEFAULT_STORE_NAME = 'Medusa Store';
|
|
6
|
+
const retrieveStoreName = async (container) => {
|
|
7
|
+
const query = container.resolve(utils_1.ContainerRegistrationKeys.QUERY);
|
|
8
|
+
const { data } = await query.graph({ entity: 'store', fields: ['name'] });
|
|
9
|
+
return data[0]?.name ?? exports.DEFAULT_STORE_NAME;
|
|
10
|
+
};
|
|
11
|
+
exports.retrieveStoreName = retrieveStoreName;
|
|
12
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RvcmUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi8uLi9zcmMvbGliL2V2ZW50cy9idWlsdC1pbi9zdG9yZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFDQSxxREFBc0U7QUFFekQsUUFBQSxrQkFBa0IsR0FBRyxjQUFjLENBQUM7QUFFMUMsTUFBTSxpQkFBaUIsR0FBRyxLQUFLLEVBQ3BDLFNBQTBCLEVBQ1QsRUFBRTtJQUNuQixNQUFNLEtBQUssR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDLGlDQUF5QixDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQ2pFLE1BQU0sRUFBRSxJQUFJLEVBQUUsR0FBRyxNQUFNLEtBQUssQ0FBQyxLQUFLLENBQUMsRUFBRSxNQUFNLEVBQUUsT0FBTyxFQUFFLE1BQU0sRUFBRSxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUUxRSxPQUFRLElBQUksQ0FBQyxDQUFDLENBQUMsRUFBRSxJQUEyQixJQUFJLDBCQUFrQixDQUFDO0FBQ3JFLENBQUMsQ0FBQztBQVBXLFFBQUEsaUJBQWlCLHFCQU81QiJ9
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { EmailEventDefinition } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Registers an email event definition and returns it. Host applications call
|
|
4
|
+
* this from a subscriber file, which Medusa loads at startup.
|
|
5
|
+
*/
|
|
6
|
+
export declare const defineEmailEvent: <TData>(definition: EmailEventDefinition<TData>) => EmailEventDefinition<TData>;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.defineEmailEvent = void 0;
|
|
4
|
+
const registry_1 = require("./registry");
|
|
5
|
+
/**
|
|
6
|
+
* Registers an email event definition and returns it. Host applications call
|
|
7
|
+
* this from a subscriber file, which Medusa loads at startup.
|
|
8
|
+
*/
|
|
9
|
+
const defineEmailEvent = (definition) => (0, registry_1.registerEmailEvent)(definition);
|
|
10
|
+
exports.defineEmailEvent = defineEmailEvent;
|
|
11
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVmaW5lLWVtYWlsLWV2ZW50LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vc3JjL2xpYi9ldmVudHMvZGVmaW5lLWVtYWlsLWV2ZW50LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLHlDQUFnRDtBQUdoRDs7O0dBR0c7QUFDSSxNQUFNLGdCQUFnQixHQUFHLENBQzlCLFVBQXVDLEVBQ1YsRUFBRSxDQUFDLElBQUEsNkJBQWtCLEVBQUMsVUFBVSxDQUFDLENBQUM7QUFGcEQsUUFBQSxnQkFBZ0Isb0JBRW9DIn0=
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import './built-in/order-placed';
|
|
2
|
+
import './built-in/invite';
|
|
3
|
+
import './built-in/password-reset';
|
|
4
|
+
import './built-in/email-verification';
|
|
5
|
+
export { defineEmailEvent } from './define-email-event';
|
|
6
|
+
export { getEmailEventDefinitionByTemplateKey, getEmailEventDefinitionForPayload, listEmailEventDefinitions, registerEmailEvent, } from './registry';
|
|
7
|
+
export type { EmailEventDefaultTemplate, EmailEventDefinition, EmailTemplateSnippet, EmailTemplateVariable, } from './types';
|
|
8
|
+
export { DEFAULT_STOREFRONT_RESET_PATH, StorefrontUrlNotConfiguredError, } from './urls';
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.StorefrontUrlNotConfiguredError = exports.DEFAULT_STOREFRONT_RESET_PATH = exports.registerEmailEvent = exports.listEmailEventDefinitions = exports.getEmailEventDefinitionForPayload = exports.getEmailEventDefinitionByTemplateKey = exports.defineEmailEvent = void 0;
|
|
4
|
+
// Importing this module registers the built-in email events. Entry points
|
|
5
|
+
// (provider, subscribers, API routes) import from here, never from
|
|
6
|
+
// ./registry directly, so the built-ins are always present.
|
|
7
|
+
require("./built-in/order-placed");
|
|
8
|
+
require("./built-in/invite");
|
|
9
|
+
require("./built-in/password-reset");
|
|
10
|
+
require("./built-in/email-verification");
|
|
11
|
+
var define_email_event_1 = require("./define-email-event");
|
|
12
|
+
Object.defineProperty(exports, "defineEmailEvent", { enumerable: true, get: function () { return define_email_event_1.defineEmailEvent; } });
|
|
13
|
+
var registry_1 = require("./registry");
|
|
14
|
+
Object.defineProperty(exports, "getEmailEventDefinitionByTemplateKey", { enumerable: true, get: function () { return registry_1.getEmailEventDefinitionByTemplateKey; } });
|
|
15
|
+
Object.defineProperty(exports, "getEmailEventDefinitionForPayload", { enumerable: true, get: function () { return registry_1.getEmailEventDefinitionForPayload; } });
|
|
16
|
+
Object.defineProperty(exports, "listEmailEventDefinitions", { enumerable: true, get: function () { return registry_1.listEmailEventDefinitions; } });
|
|
17
|
+
Object.defineProperty(exports, "registerEmailEvent", { enumerable: true, get: function () { return registry_1.registerEmailEvent; } });
|
|
18
|
+
var urls_1 = require("./urls");
|
|
19
|
+
Object.defineProperty(exports, "DEFAULT_STOREFRONT_RESET_PATH", { enumerable: true, get: function () { return urls_1.DEFAULT_STOREFRONT_RESET_PATH; } });
|
|
20
|
+
Object.defineProperty(exports, "StorefrontUrlNotConfiguredError", { enumerable: true, get: function () { return urls_1.StorefrontUrlNotConfiguredError; } });
|
|
21
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9zcmMvbGliL2V2ZW50cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwwRUFBMEU7QUFDMUUsbUVBQW1FO0FBQ25FLDREQUE0RDtBQUM1RCxtQ0FBaUM7QUFDakMsNkJBQTJCO0FBQzNCLHFDQUFtQztBQUNuQyx5Q0FBdUM7QUFFdkMsMkRBQXdEO0FBQS9DLHNIQUFBLGdCQUFnQixPQUFBO0FBQ3pCLHVDQUtvQjtBQUpsQixnSUFBQSxvQ0FBb0MsT0FBQTtBQUNwQyw2SEFBQSxpQ0FBaUMsT0FBQTtBQUNqQyxxSEFBQSx5QkFBeUIsT0FBQTtBQUN6Qiw4R0FBQSxrQkFBa0IsT0FBQTtBQVFwQiwrQkFHZ0I7QUFGZCxxSEFBQSw2QkFBNkIsT0FBQTtBQUM3Qix1SEFBQSwrQkFBK0IsT0FBQSJ9
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { EmailEventDefinition } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Registers an email event definition. Template keys must be unique; an event
|
|
4
|
+
* may have several definitions only if each has a `matches` predicate.
|
|
5
|
+
*/
|
|
6
|
+
export declare const registerEmailEvent: <TData>(definition: EmailEventDefinition<TData>) => EmailEventDefinition<TData>;
|
|
7
|
+
export declare const listEmailEventDefinitions: () => EmailEventDefinition<never>[];
|
|
8
|
+
export declare const getEmailEventDefinitionByTemplateKey: (templateKey: string) => EmailEventDefinition<never> | undefined;
|
|
9
|
+
export declare const getEmailEventDefinitionForPayload: <TData>(event: string, data: TData) => EmailEventDefinition<never> | undefined;
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getEmailEventDefinitionForPayload = exports.getEmailEventDefinitionByTemplateKey = exports.listEmailEventDefinitions = exports.registerEmailEvent = void 0;
|
|
4
|
+
const variable_format_1 = require("../rendering/variable-format");
|
|
5
|
+
const definitions = [];
|
|
6
|
+
const declaredKeys = (variables, prefix = '') => variables.flatMap((variable) => [
|
|
7
|
+
{ key: variable.key, field: `${prefix}key` },
|
|
8
|
+
...(variable.currencyKey !== undefined
|
|
9
|
+
? [{ key: variable.currencyKey, field: `${prefix}currencyKey` }]
|
|
10
|
+
: []),
|
|
11
|
+
...declaredKeys(variable.fields ?? [], `${variable.key} fields › `),
|
|
12
|
+
]);
|
|
13
|
+
/**
|
|
14
|
+
* Rejects keys the editor can't emit, at startup rather than when an admin
|
|
15
|
+
* uses them. `toLiquidExpression` accepts only lowercase dotted identifiers
|
|
16
|
+
* (keeping quotes out of templates), so a key like `order.displayId` or
|
|
17
|
+
* `customer-name` would otherwise appear in pickers and then fail.
|
|
18
|
+
*/
|
|
19
|
+
const assertEditableKeys = (definition) => {
|
|
20
|
+
const invalid = declaredKeys(definition.variables).filter(({ key }) => !variable_format_1.VARIABLE_KEY_PATTERN.test(key));
|
|
21
|
+
if (invalid.length) {
|
|
22
|
+
throw new Error(`Email template "${definition.templateKey}" declares ${invalid.length === 1 ? 'a variable key' : 'variable keys'} the editor cannot use: ${invalid
|
|
23
|
+
.map(({ key, field }) => `${JSON.stringify(key)} (${field})`)
|
|
24
|
+
.join(', ')}. Keys must be lowercase letters, digits and underscores, separated by dots — for example "order.display_id".`);
|
|
25
|
+
}
|
|
26
|
+
};
|
|
27
|
+
const asInternal = (definition) => definition;
|
|
28
|
+
/**
|
|
29
|
+
* Registers an email event definition. Template keys must be unique; an event
|
|
30
|
+
* may have several definitions only if each has a `matches` predicate.
|
|
31
|
+
*/
|
|
32
|
+
const registerEmailEvent = (definition) => {
|
|
33
|
+
if (definitions.some((it) => it.templateKey === definition.templateKey)) {
|
|
34
|
+
throw new Error(`An email template with key "${definition.templateKey}" is already registered.`);
|
|
35
|
+
}
|
|
36
|
+
assertEditableKeys(asInternal(definition));
|
|
37
|
+
const sameEvent = definitions.filter((it) => it.event === definition.event);
|
|
38
|
+
if (sameEvent.length &&
|
|
39
|
+
(!definition.matches || sameEvent.some((it) => !it.matches))) {
|
|
40
|
+
throw new Error(`Event "${definition.event}" already has an email template. Give every definition for this event a "matches" predicate.`);
|
|
41
|
+
}
|
|
42
|
+
definitions.push(asInternal(definition));
|
|
43
|
+
return definition;
|
|
44
|
+
};
|
|
45
|
+
exports.registerEmailEvent = registerEmailEvent;
|
|
46
|
+
const listEmailEventDefinitions = () => [
|
|
47
|
+
...definitions,
|
|
48
|
+
];
|
|
49
|
+
exports.listEmailEventDefinitions = listEmailEventDefinitions;
|
|
50
|
+
const getEmailEventDefinitionByTemplateKey = (templateKey) => definitions.find((definition) => definition.templateKey === templateKey);
|
|
51
|
+
exports.getEmailEventDefinitionByTemplateKey = getEmailEventDefinitionByTemplateKey;
|
|
52
|
+
const getEmailEventDefinitionForPayload = (event, data) => definitions.find((definition) => definition.event === event &&
|
|
53
|
+
(!definition.matches || definition.matches(data)));
|
|
54
|
+
exports.getEmailEventDefinitionForPayload = getEmailEventDefinitionForPayload;
|
|
55
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVnaXN0cnkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9zcmMvbGliL2V2ZW50cy9yZWdpc3RyeS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSxrRUFBb0U7QUFHcEUsTUFBTSxXQUFXLEdBQWtDLEVBQUUsQ0FBQztBQUV0RCxNQUFNLFlBQVksR0FBRyxDQUNuQixTQUFrQyxFQUNsQyxNQUFNLEdBQUcsRUFBRSxFQUN1QixFQUFFLENBQ3BDLFNBQVMsQ0FBQyxPQUFPLENBQUMsQ0FBQyxRQUFRLEVBQUUsRUFBRSxDQUFDO0lBQzlCLEVBQUUsR0FBRyxFQUFFLFFBQVEsQ0FBQyxHQUFHLEVBQUUsS0FBSyxFQUFFLEdBQUcsTUFBTSxLQUFLLEVBQUU7SUFDNUMsR0FBRyxDQUFDLFFBQVEsQ0FBQyxXQUFXLEtBQUssU0FBUztRQUNwQyxDQUFDLENBQUMsQ0FBQyxFQUFFLEdBQUcsRUFBRSxRQUFRLENBQUMsV0FBVyxFQUFFLEtBQUssRUFBRSxHQUFHLE1BQU0sYUFBYSxFQUFFLENBQUM7UUFDaEUsQ0FBQyxDQUFDLEVBQUUsQ0FBQztJQUNQLEdBQUcsWUFBWSxDQUFDLFFBQVEsQ0FBQyxNQUFNLElBQUksRUFBRSxFQUFFLEdBQUcsUUFBUSxDQUFDLEdBQUcsWUFBWSxDQUFDO0NBQ3BFLENBQUMsQ0FBQztBQUVMOzs7OztHQUtHO0FBQ0gsTUFBTSxrQkFBa0IsR0FBRyxDQUFDLFVBQXVDLEVBQVEsRUFBRTtJQUMzRSxNQUFNLE9BQU8sR0FBRyxZQUFZLENBQUMsVUFBVSxDQUFDLFNBQVMsQ0FBQyxDQUFDLE1BQU0sQ0FDdkQsQ0FBQyxFQUFFLEdBQUcsRUFBRSxFQUFFLEVBQUUsQ0FBQyxDQUFDLHNDQUFvQixDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FDN0MsQ0FBQztJQUVGLElBQUksT0FBTyxDQUFDLE1BQU0sRUFBRSxDQUFDO1FBQ25CLE1BQU0sSUFBSSxLQUFLLENBQ2IsbUJBQW1CLFVBQVUsQ0FBQyxXQUFXLGNBQ3ZDLE9BQU8sQ0FBQyxNQUFNLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDLENBQUMsZUFDNUMsMkJBQTJCLE9BQU87YUFDL0IsR0FBRyxDQUFDLENBQUMsRUFBRSxHQUFHLEVBQUUsS0FBSyxFQUFFLEVBQUUsRUFBRSxDQUFDLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsS0FBSyxLQUFLLEdBQUcsQ0FBQzthQUM1RCxJQUFJLENBQ0gsSUFBSSxDQUNMLCtHQUErRyxDQUNuSCxDQUFDO0lBQ0osQ0FBQztBQUNILENBQUMsQ0FBQztBQUVGLE1BQU0sVUFBVSxHQUFHLENBQVEsVUFBdUMsRUFBRSxFQUFFLENBQ3BFLFVBQW9ELENBQUM7QUFFdkQ7OztHQUdHO0FBQ0ksTUFBTSxrQkFBa0IsR0FBRyxDQUNoQyxVQUF1QyxFQUNWLEVBQUU7SUFDL0IsSUFBSSxXQUFXLENBQUMsSUFBSSxDQUFDLENBQUMsRUFBRSxFQUFFLEVBQUUsQ0FBQyxFQUFFLENBQUMsV0FBVyxLQUFLLFVBQVUsQ0FBQyxXQUFXLENBQUMsRUFBRSxDQUFDO1FBQ3hFLE1BQU0sSUFBSSxLQUFLLENBQ2IsK0JBQStCLFVBQVUsQ0FBQyxXQUFXLDBCQUEwQixDQUNoRixDQUFDO0lBQ0osQ0FBQztJQUVELGtCQUFrQixDQUFDLFVBQVUsQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDO0lBRTNDLE1BQU0sU0FBUyxHQUFHLFdBQVcsQ0FBQyxNQUFNLENBQUMsQ0FBQyxFQUFFLEVBQUUsRUFBRSxDQUFDLEVBQUUsQ0FBQyxLQUFLLEtBQUssVUFBVSxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBRTVFLElBQ0UsU0FBUyxDQUFDLE1BQU07UUFDaEIsQ0FBQyxDQUFDLFVBQVUsQ0FBQyxPQUFPLElBQUksU0FBUyxDQUFDLElBQUksQ0FBQyxDQUFDLEVBQUUsRUFBRSxFQUFFLENBQUMsQ0FBQyxFQUFFLENBQUMsT0FBTyxDQUFDLENBQUMsRUFDNUQsQ0FBQztRQUNELE1BQU0sSUFBSSxLQUFLLENBQ2IsVUFBVSxVQUFVLENBQUMsS0FBSyw4RkFBOEYsQ0FDekgsQ0FBQztJQUNKLENBQUM7SUFFRCxXQUFXLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDO0lBRXpDLE9BQU8sVUFBVSxDQUFDO0FBQ3BCLENBQUMsQ0FBQztBQXpCVyxRQUFBLGtCQUFrQixzQkF5QjdCO0FBRUssTUFBTSx5QkFBeUIsR0FBRyxHQUFrQyxFQUFFLENBQUM7SUFDNUUsR0FBRyxXQUFXO0NBQ2YsQ0FBQztBQUZXLFFBQUEseUJBQXlCLDZCQUVwQztBQUVLLE1BQU0sb0NBQW9DLEdBQUcsQ0FDbEQsV0FBbUIsRUFDc0IsRUFBRSxDQUMzQyxXQUFXLENBQUMsSUFBSSxDQUFDLENBQUMsVUFBVSxFQUFFLEVBQUUsQ0FBQyxVQUFVLENBQUMsV0FBVyxLQUFLLFdBQVcsQ0FBQyxDQUFDO0FBSDlELFFBQUEsb0NBQW9DLHdDQUcwQjtBQUVwRSxNQUFNLGlDQUFpQyxHQUFHLENBQy9DLEtBQWEsRUFDYixJQUFXLEVBQzhCLEVBQUUsQ0FDM0MsV0FBVyxDQUFDLElBQUksQ0FDZCxDQUFDLFVBQVUsRUFBRSxFQUFFLENBQ2IsVUFBVSxDQUFDLEtBQUssS0FBSyxLQUFLO0lBQzFCLENBQUMsQ0FBQyxVQUFVLENBQUMsT0FBTyxJQUFJLFVBQVUsQ0FBQyxPQUFPLENBQUMsSUFBd0IsQ0FBQyxDQUFDLENBQ3hFLENBQUM7QUFSUyxRQUFBLGlDQUFpQyxxQ0FRMUMifQ==
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import type { MedusaContainer } from '@medusajs/framework/types';
|
|
2
|
+
export interface EmailTemplateVariable {
|
|
3
|
+
key: string;
|
|
4
|
+
label: string;
|
|
5
|
+
description?: string;
|
|
6
|
+
example: unknown;
|
|
7
|
+
group?: string;
|
|
8
|
+
/**
|
|
9
|
+
* What the value holds; omitted means plain text.
|
|
10
|
+
*
|
|
11
|
+
* - `money` / `date`: unlock those display formats. Don't mark other values
|
|
12
|
+
* this way — a wrong format renders an empty string.
|
|
13
|
+
* - `url`: the only variables the link picker offers for hrefs. Still usable
|
|
14
|
+
* as ordinary text elsewhere.
|
|
15
|
+
* - `list`: an array to repeat content over. Offered as a Repeat block
|
|
16
|
+
* source, never as a pill; its `fields` become `item.*` inside the block.
|
|
17
|
+
*/
|
|
18
|
+
type?: 'text' | 'number' | 'money' | 'date' | 'url' | 'list';
|
|
19
|
+
/**
|
|
20
|
+
* For `money`, the key holding its currency code. Must be a bare identifier
|
|
21
|
+
* path (it becomes a Liquid filter argument; quotes would be corrupted).
|
|
22
|
+
* On a list field keep it absolute (`order.currency_code`) — loops can read
|
|
23
|
+
* the outer scope.
|
|
24
|
+
*/
|
|
25
|
+
currencyKey?: string;
|
|
26
|
+
/**
|
|
27
|
+
* For `list`, the fields of one entry, keyed relative to it (`title` is
|
|
28
|
+
* offered as `item.title` inside the block).
|
|
29
|
+
*/
|
|
30
|
+
fields?: EmailTemplateVariable[];
|
|
31
|
+
/**
|
|
32
|
+
* For `list`, one entry's HTML using `{{ item.* }}` expressions: the
|
|
33
|
+
* starting content of a newly inserted block. Reuse it in the default
|
|
34
|
+
* template so the two match.
|
|
35
|
+
*/
|
|
36
|
+
itemTemplate?: string;
|
|
37
|
+
}
|
|
38
|
+
export interface EmailTemplateSnippet {
|
|
39
|
+
key: string;
|
|
40
|
+
label: string;
|
|
41
|
+
description?: string;
|
|
42
|
+
/**
|
|
43
|
+
* HTML to insert; its `{{ … }}` expressions become pills. Use `columns()`
|
|
44
|
+
* for side-by-side cells so they stay reshapeable.
|
|
45
|
+
*/
|
|
46
|
+
html: string;
|
|
47
|
+
}
|
|
48
|
+
export interface EmailEventDefaultTemplate {
|
|
49
|
+
subject: string;
|
|
50
|
+
html: string;
|
|
51
|
+
text?: string;
|
|
52
|
+
}
|
|
53
|
+
export interface EmailEventDefinition<TData = unknown> {
|
|
54
|
+
event: string;
|
|
55
|
+
templateKey: string;
|
|
56
|
+
label: string;
|
|
57
|
+
description?: string;
|
|
58
|
+
/**
|
|
59
|
+
* Picks between definitions sharing an event (e.g. admin vs customer
|
|
60
|
+
* password resets). Required when an event has several definitions.
|
|
61
|
+
*/
|
|
62
|
+
matches?: (data: TData) => boolean;
|
|
63
|
+
/** Returns null to skip sending, for example when there is no email. */
|
|
64
|
+
getRecipient: (data: TData, container: MedusaContainer) => Promise<string | null>;
|
|
65
|
+
getContext: (data: TData, container: MedusaContainer) => Promise<Record<string, unknown>>;
|
|
66
|
+
variables: EmailTemplateVariable[];
|
|
67
|
+
snippets?: EmailTemplateSnippet[];
|
|
68
|
+
defaultTemplate: EmailEventDefaultTemplate;
|
|
69
|
+
getIdempotencyKey?: (data: TData) => string | undefined;
|
|
70
|
+
getResource?: (data: TData) => {
|
|
71
|
+
resource_id?: string;
|
|
72
|
+
resource_type?: string;
|
|
73
|
+
};
|
|
74
|
+
/**
|
|
75
|
+
* Configuration problems shown in the admin, as codes the dashboard turns
|
|
76
|
+
* into text (e.g. a customer link without a storefront URL).
|
|
77
|
+
*
|
|
78
|
+
* Not only send-blocking ones: a password reset can't send without its link,
|
|
79
|
+
* but an order confirmation still sends and merely loses `order_url`.
|
|
80
|
+
*/
|
|
81
|
+
getWarnings?: (container: MedusaContainer) => string[];
|
|
82
|
+
}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9zcmMvbGliL2V2ZW50cy90eXBlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { MedusaContainer } from '@medusajs/framework/types';
|
|
2
|
+
export declare const DEFAULT_STOREFRONT_RESET_PATH = "/reset-password";
|
|
3
|
+
/**
|
|
4
|
+
* Storefronts differ here (the Next.js starter has moved it), so this is a
|
|
5
|
+
* plain default that the option can override.
|
|
6
|
+
*/
|
|
7
|
+
export declare const DEFAULT_STOREFRONT_ORDER_PATH = "/orders";
|
|
8
|
+
export declare class StorefrontUrlNotConfiguredError extends Error {
|
|
9
|
+
constructor();
|
|
10
|
+
}
|
|
11
|
+
export declare const getAdminUrl: (container: MedusaContainer) => string;
|
|
12
|
+
export declare const getStorefrontUrl: (container: MedusaContainer) => string;
|
|
13
|
+
export declare const getStorefrontResetPasswordPath: (container: MedusaContainer) => string;
|
|
14
|
+
export declare const getStorefrontOrderPath: (container: MedusaContainer) => string;
|
|
15
|
+
/**
|
|
16
|
+
* A link to an order on the storefront, or null without a storefront.
|
|
17
|
+
*
|
|
18
|
+
* Null, not a throw: unlike a password reset (which is useless without its
|
|
19
|
+
* link, so it skips), an order confirmation is complete without it. The
|
|
20
|
+
* variable goes unresolved and `getWarnings` explains why.
|
|
21
|
+
*/
|
|
22
|
+
export declare const getOrderUrl: (container: MedusaContainer, orderId: string) => string | null;
|
|
23
|
+
export declare const buildQuery: (params: Record<string, string | undefined>) => string;
|