@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,79 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.buildQuery = exports.getOrderUrl = exports.getStorefrontOrderPath = exports.getStorefrontResetPasswordPath = exports.getStorefrontUrl = exports.getAdminUrl = exports.StorefrontUrlNotConfiguredError = exports.DEFAULT_STOREFRONT_ORDER_PATH = exports.DEFAULT_STOREFRONT_RESET_PATH = void 0;
|
|
4
|
+
const utils_1 = require("@medusajs/framework/utils");
|
|
5
|
+
const email_templates_1 = require("../../modules/email-templates");
|
|
6
|
+
exports.DEFAULT_STOREFRONT_RESET_PATH = '/reset-password';
|
|
7
|
+
/**
|
|
8
|
+
* Storefronts differ here (the Next.js starter has moved it), so this is a
|
|
9
|
+
* plain default that the option can override.
|
|
10
|
+
*/
|
|
11
|
+
exports.DEFAULT_STOREFRONT_ORDER_PATH = '/orders';
|
|
12
|
+
class StorefrontUrlNotConfiguredError extends Error {
|
|
13
|
+
constructor() {
|
|
14
|
+
super('No storefront_url is configured for @agilo/medusa-email-templates-plugin, so customer links cannot be built.');
|
|
15
|
+
this.name = 'StorefrontUrlNotConfiguredError';
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
exports.StorefrontUrlNotConfiguredError = StorefrontUrlNotConfiguredError;
|
|
19
|
+
const readOptions = (container) => {
|
|
20
|
+
const service = container.resolve(email_templates_1.EMAIL_TEMPLATES_MODULE);
|
|
21
|
+
return service.getOptions?.() ?? {};
|
|
22
|
+
};
|
|
23
|
+
const trimTrailingSlash = (value) => value.endsWith('/') ? value.slice(0, -1) : value;
|
|
24
|
+
const withLeadingSlash = (value) => value.startsWith('/') ? value : `/${value}`;
|
|
25
|
+
const getAdminUrl = (container) => {
|
|
26
|
+
const { admin_url: adminUrl } = readOptions(container);
|
|
27
|
+
if (adminUrl) {
|
|
28
|
+
return trimTrailingSlash(adminUrl);
|
|
29
|
+
}
|
|
30
|
+
const configModule = container.resolve(utils_1.ContainerRegistrationKeys.CONFIG_MODULE);
|
|
31
|
+
const backendUrl = configModule?.admin?.backendUrl ?? 'http://localhost:9000';
|
|
32
|
+
const adminPath = configModule?.admin?.path ?? '/app';
|
|
33
|
+
return `${trimTrailingSlash(backendUrl)}${adminPath}`;
|
|
34
|
+
};
|
|
35
|
+
exports.getAdminUrl = getAdminUrl;
|
|
36
|
+
const getStorefrontUrl = (container) => {
|
|
37
|
+
const { storefront_url: storefrontUrl } = readOptions(container);
|
|
38
|
+
if (!storefrontUrl) {
|
|
39
|
+
throw new StorefrontUrlNotConfiguredError();
|
|
40
|
+
}
|
|
41
|
+
return trimTrailingSlash(storefrontUrl);
|
|
42
|
+
};
|
|
43
|
+
exports.getStorefrontUrl = getStorefrontUrl;
|
|
44
|
+
const getStorefrontResetPasswordPath = (container) => withLeadingSlash(readOptions(container).storefront_reset_password_path ??
|
|
45
|
+
exports.DEFAULT_STOREFRONT_RESET_PATH);
|
|
46
|
+
exports.getStorefrontResetPasswordPath = getStorefrontResetPasswordPath;
|
|
47
|
+
const getStorefrontOrderPath = (container) => withLeadingSlash(readOptions(container).storefront_order_path ??
|
|
48
|
+
exports.DEFAULT_STOREFRONT_ORDER_PATH);
|
|
49
|
+
exports.getStorefrontOrderPath = getStorefrontOrderPath;
|
|
50
|
+
/**
|
|
51
|
+
* A link to an order on the storefront, or null without a storefront.
|
|
52
|
+
*
|
|
53
|
+
* Null, not a throw: unlike a password reset (which is useless without its
|
|
54
|
+
* link, so it skips), an order confirmation is complete without it. The
|
|
55
|
+
* variable goes unresolved and `getWarnings` explains why.
|
|
56
|
+
*/
|
|
57
|
+
const getOrderUrl = (container, orderId) => {
|
|
58
|
+
try {
|
|
59
|
+
return `${(0, exports.getStorefrontUrl)(container)}${(0, exports.getStorefrontOrderPath)(container)}/${orderId}`;
|
|
60
|
+
}
|
|
61
|
+
catch (error) {
|
|
62
|
+
if (error instanceof StorefrontUrlNotConfiguredError) {
|
|
63
|
+
return null;
|
|
64
|
+
}
|
|
65
|
+
throw error;
|
|
66
|
+
}
|
|
67
|
+
};
|
|
68
|
+
exports.getOrderUrl = getOrderUrl;
|
|
69
|
+
const buildQuery = (params) => {
|
|
70
|
+
const search = new URLSearchParams();
|
|
71
|
+
Object.entries(params).forEach(([key, value]) => {
|
|
72
|
+
if (value) {
|
|
73
|
+
search.set(key, value);
|
|
74
|
+
}
|
|
75
|
+
});
|
|
76
|
+
return search.toString();
|
|
77
|
+
};
|
|
78
|
+
exports.buildQuery = buildQuery;
|
|
79
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXJscy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3NyYy9saWIvZXZlbnRzL3VybHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQ0EscURBQXNFO0FBRXRFLG1FQUF1RTtBQUkxRCxRQUFBLDZCQUE2QixHQUFHLGlCQUFpQixDQUFDO0FBRS9EOzs7R0FHRztBQUNVLFFBQUEsNkJBQTZCLEdBQUcsU0FBUyxDQUFDO0FBRXZELE1BQWEsK0JBQWdDLFNBQVEsS0FBSztJQUN4RDtRQUNFLEtBQUssQ0FDSCw4R0FBOEcsQ0FDL0csQ0FBQztRQUNGLElBQUksQ0FBQyxJQUFJLEdBQUcsaUNBQWlDLENBQUM7SUFDaEQsQ0FBQztDQUNGO0FBUEQsMEVBT0M7QUFFRCxNQUFNLFdBQVcsR0FBRyxDQUNsQixTQUEwQixFQUNHLEVBQUU7SUFDL0IsTUFBTSxPQUFPLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FDL0Isd0NBQXNCLENBQ3ZCLENBQUM7SUFFRixPQUFPLE9BQU8sQ0FBQyxVQUFVLEVBQUUsRUFBRSxJQUFJLEVBQUUsQ0FBQztBQUN0QyxDQUFDLENBQUM7QUFFRixNQUFNLGlCQUFpQixHQUFHLENBQUMsS0FBYSxFQUFVLEVBQUUsQ0FDbEQsS0FBSyxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLEtBQUssQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDO0FBRW5ELE1BQU0sZ0JBQWdCLEdBQUcsQ0FBQyxLQUFhLEVBQVUsRUFBRSxDQUNqRCxLQUFLLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLElBQUksS0FBSyxFQUFFLENBQUM7QUFFdkMsTUFBTSxXQUFXLEdBQUcsQ0FBQyxTQUEwQixFQUFVLEVBQUU7SUFDaEUsTUFBTSxFQUFFLFNBQVMsRUFBRSxRQUFRLEVBQUUsR0FBRyxXQUFXLENBQUMsU0FBUyxDQUFDLENBQUM7SUFFdkQsSUFBSSxRQUFRLEVBQUUsQ0FBQztRQUNiLE9BQU8saUJBQWlCLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDckMsQ0FBQztJQUVELE1BQU0sWUFBWSxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQ3BDLGlDQUF5QixDQUFDLGFBQWEsQ0FDeEMsQ0FBQztJQUNGLE1BQU0sVUFBVSxHQUFHLFlBQVksRUFBRSxLQUFLLEVBQUUsVUFBVSxJQUFJLHVCQUF1QixDQUFDO0lBQzlFLE1BQU0sU0FBUyxHQUFHLFlBQVksRUFBRSxLQUFLLEVBQUUsSUFBSSxJQUFJLE1BQU0sQ0FBQztJQUV0RCxPQUFPLEdBQUcsaUJBQWlCLENBQUMsVUFBVSxDQUFDLEdBQUcsU0FBUyxFQUFFLENBQUM7QUFDeEQsQ0FBQyxDQUFDO0FBZFcsUUFBQSxXQUFXLGVBY3RCO0FBRUssTUFBTSxnQkFBZ0IsR0FBRyxDQUFDLFNBQTBCLEVBQVUsRUFBRTtJQUNyRSxNQUFNLEVBQUUsY0FBYyxFQUFFLGFBQWEsRUFBRSxHQUFHLFdBQVcsQ0FBQyxTQUFTLENBQUMsQ0FBQztJQUVqRSxJQUFJLENBQUMsYUFBYSxFQUFFLENBQUM7UUFDbkIsTUFBTSxJQUFJLCtCQUErQixFQUFFLENBQUM7SUFDOUMsQ0FBQztJQUVELE9BQU8saUJBQWlCLENBQUMsYUFBYSxDQUFDLENBQUM7QUFDMUMsQ0FBQyxDQUFDO0FBUlcsUUFBQSxnQkFBZ0Isb0JBUTNCO0FBRUssTUFBTSw4QkFBOEIsR0FBRyxDQUM1QyxTQUEwQixFQUNsQixFQUFFLENBQ1YsZ0JBQWdCLENBQ2QsV0FBVyxDQUFDLFNBQVMsQ0FBQyxDQUFDLDhCQUE4QjtJQUNuRCxxQ0FBNkIsQ0FDaEMsQ0FBQztBQU5TLFFBQUEsOEJBQThCLGtDQU12QztBQUVHLE1BQU0sc0JBQXNCLEdBQUcsQ0FBQyxTQUEwQixFQUFVLEVBQUUsQ0FDM0UsZ0JBQWdCLENBQ2QsV0FBVyxDQUFDLFNBQVMsQ0FBQyxDQUFDLHFCQUFxQjtJQUMxQyxxQ0FBNkIsQ0FDaEMsQ0FBQztBQUpTLFFBQUEsc0JBQXNCLDBCQUkvQjtBQUVKOzs7Ozs7R0FNRztBQUNJLE1BQU0sV0FBVyxHQUFHLENBQ3pCLFNBQTBCLEVBQzFCLE9BQWUsRUFDQSxFQUFFO0lBQ2pCLElBQUksQ0FBQztRQUNILE9BQU8sR0FBRyxJQUFBLHdCQUFnQixFQUFDLFNBQVMsQ0FBQyxHQUFHLElBQUEsOEJBQXNCLEVBQUMsU0FBUyxDQUFDLElBQUksT0FBTyxFQUFFLENBQUM7SUFDekYsQ0FBQztJQUFDLE9BQU8sS0FBSyxFQUFFLENBQUM7UUFDZixJQUFJLEtBQUssWUFBWSwrQkFBK0IsRUFBRSxDQUFDO1lBQ3JELE9BQU8sSUFBSSxDQUFDO1FBQ2QsQ0FBQztRQUVELE1BQU0sS0FBSyxDQUFDO0lBQ2QsQ0FBQztBQUNILENBQUMsQ0FBQztBQWJXLFFBQUEsV0FBVyxlQWF0QjtBQUVLLE1BQU0sVUFBVSxHQUFHLENBQ3hCLE1BQTBDLEVBQ2xDLEVBQUU7SUFDVixNQUFNLE1BQU0sR0FBRyxJQUFJLGVBQWUsRUFBRSxDQUFDO0lBRXJDLE1BQU0sQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxHQUFHLEVBQUUsS0FBSyxDQUFDLEVBQUUsRUFBRTtRQUM5QyxJQUFJLEtBQUssRUFBRSxDQUFDO1lBQ1YsTUFBTSxDQUFDLEdBQUcsQ0FBQyxHQUFHLEVBQUUsS0FBSyxDQUFDLENBQUM7UUFDekIsQ0FBQztJQUNILENBQUMsQ0FBQyxDQUFDO0lBRUgsT0FBTyxNQUFNLENBQUMsUUFBUSxFQUFFLENBQUM7QUFDM0IsQ0FBQyxDQUFDO0FBWlcsUUFBQSxVQUFVLGNBWXJCIn0=
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import type { Logger } from '@medusajs/framework/types';
|
|
2
|
+
import { type MaskedCredential } from './credentials/mask';
|
|
3
|
+
import { type StoredCredential } from './credentials/resolve-credential';
|
|
4
|
+
import type { CloudEmailConfig, CredentialSource, EmailTransport, EmailTransportContext } from './transports/types';
|
|
5
|
+
export interface EmailProviderConfigurationRecord {
|
|
6
|
+
id: string;
|
|
7
|
+
transport_id: string;
|
|
8
|
+
is_selected: boolean;
|
|
9
|
+
config: Record<string, unknown> | null;
|
|
10
|
+
credential?: StoredCredential | null;
|
|
11
|
+
}
|
|
12
|
+
export interface EmailProviderTransportState {
|
|
13
|
+
id: string;
|
|
14
|
+
label: string;
|
|
15
|
+
selected: boolean;
|
|
16
|
+
available: boolean;
|
|
17
|
+
unavailable_reason?: string;
|
|
18
|
+
credential_sources: CredentialSource[];
|
|
19
|
+
config: Record<string, unknown>;
|
|
20
|
+
credential: MaskedCredential | null;
|
|
21
|
+
}
|
|
22
|
+
export interface EmailProviderState {
|
|
23
|
+
selected_transport_id: string | null;
|
|
24
|
+
encryption_available: boolean;
|
|
25
|
+
transports: EmailProviderTransportState[];
|
|
26
|
+
}
|
|
27
|
+
export type TransportContextOptions = {
|
|
28
|
+
logger?: Logger;
|
|
29
|
+
idempotencyKey?: string | null;
|
|
30
|
+
cloud?: CloudEmailConfig | null;
|
|
31
|
+
};
|
|
32
|
+
type ModuleServiceLike = {
|
|
33
|
+
listEmailProviderConfigurations: (filters: Record<string, unknown>, options: Record<string, unknown>) => Promise<unknown>;
|
|
34
|
+
};
|
|
35
|
+
export declare const listEmailProviderConfigurations: (service: ModuleServiceLike, filters?: {
|
|
36
|
+
is_selected?: boolean;
|
|
37
|
+
transport_id?: string;
|
|
38
|
+
}) => Promise<EmailProviderConfigurationRecord[]>;
|
|
39
|
+
export declare const buildTransportContext: (configuration: EmailProviderConfigurationRecord, options?: TransportContextOptions) => EmailTransportContext;
|
|
40
|
+
export declare const resolveSelectedTransport: (service: ModuleServiceLike, options?: TransportContextOptions) => Promise<{
|
|
41
|
+
configuration: EmailProviderConfigurationRecord;
|
|
42
|
+
transport: EmailTransport;
|
|
43
|
+
context: EmailTransportContext;
|
|
44
|
+
}>;
|
|
45
|
+
export declare const resolveTransportById: (service: ModuleServiceLike, transportId: string, options?: TransportContextOptions) => Promise<{
|
|
46
|
+
configuration: EmailProviderConfigurationRecord | null;
|
|
47
|
+
transport: EmailTransport;
|
|
48
|
+
context: EmailTransportContext;
|
|
49
|
+
}>;
|
|
50
|
+
export declare const getEmailProviderState: (service: ModuleServiceLike, options?: TransportContextOptions) => Promise<EmailProviderState>;
|
|
51
|
+
export {};
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.getEmailProviderState = exports.resolveTransportById = exports.resolveSelectedTransport = exports.buildTransportContext = exports.listEmailProviderConfigurations = void 0;
|
|
4
|
+
const mask_1 = require("./credentials/mask");
|
|
5
|
+
const resolve_credential_1 = require("./credentials/resolve-credential");
|
|
6
|
+
const encryption_key_1 = require("./crypto/encryption-key");
|
|
7
|
+
const errors_1 = require("./errors");
|
|
8
|
+
const registry_1 = require("./transports/registry");
|
|
9
|
+
const listEmailProviderConfigurations = async (service, filters = {}) => (await service.listEmailProviderConfigurations(filters, {
|
|
10
|
+
relations: ['credential'],
|
|
11
|
+
}));
|
|
12
|
+
exports.listEmailProviderConfigurations = listEmailProviderConfigurations;
|
|
13
|
+
const buildTransportContext = (configuration, options = {}) => ({
|
|
14
|
+
config: configuration.config ?? {},
|
|
15
|
+
credential: (0, resolve_credential_1.resolveCredential)(configuration.credential),
|
|
16
|
+
cloud: options.cloud ?? null,
|
|
17
|
+
idempotencyKey: options.idempotencyKey ?? null,
|
|
18
|
+
logger: options.logger,
|
|
19
|
+
});
|
|
20
|
+
exports.buildTransportContext = buildTransportContext;
|
|
21
|
+
const resolveSelectedTransport = async (service, options = {}) => {
|
|
22
|
+
const [configuration] = await (0, exports.listEmailProviderConfigurations)(service, {
|
|
23
|
+
is_selected: true,
|
|
24
|
+
});
|
|
25
|
+
if (!configuration) {
|
|
26
|
+
throw (0, errors_1.providerNotReadyError)('No email provider is selected. Choose one in Settings → Email → Provider.');
|
|
27
|
+
}
|
|
28
|
+
const transport = (0, registry_1.getEmailTransport)(configuration.transport_id);
|
|
29
|
+
if (!transport) {
|
|
30
|
+
throw (0, errors_1.providerNotReadyError)(`The selected email transport "${configuration.transport_id}" is not registered.`);
|
|
31
|
+
}
|
|
32
|
+
const context = (0, exports.buildTransportContext)(configuration, options);
|
|
33
|
+
if (!(await transport.isAvailable(context))) {
|
|
34
|
+
throw (0, errors_1.providerNotReadyError)(`${transport.label} is not available. Check its configuration and credentials.`);
|
|
35
|
+
}
|
|
36
|
+
return { configuration, transport, context };
|
|
37
|
+
};
|
|
38
|
+
exports.resolveSelectedTransport = resolveSelectedTransport;
|
|
39
|
+
const resolveTransportById = async (service, transportId, options = {}) => {
|
|
40
|
+
const transport = (0, registry_1.getEmailTransport)(transportId);
|
|
41
|
+
if (!transport) {
|
|
42
|
+
throw (0, errors_1.providerNotReadyError)(`The email transport "${transportId}" is not registered.`);
|
|
43
|
+
}
|
|
44
|
+
const [configuration] = await (0, exports.listEmailProviderConfigurations)(service, {
|
|
45
|
+
transport_id: transportId,
|
|
46
|
+
});
|
|
47
|
+
if (!configuration && !transport.credentialSources.includes('managed')) {
|
|
48
|
+
throw (0, errors_1.providerNotReadyError)(`${transport.label} is not configured yet.`);
|
|
49
|
+
}
|
|
50
|
+
const context = configuration
|
|
51
|
+
? (0, exports.buildTransportContext)(configuration, options)
|
|
52
|
+
: {
|
|
53
|
+
config: {},
|
|
54
|
+
credential: null,
|
|
55
|
+
cloud: options.cloud ?? null,
|
|
56
|
+
idempotencyKey: options.idempotencyKey ?? null,
|
|
57
|
+
logger: options.logger,
|
|
58
|
+
};
|
|
59
|
+
if (!(await transport.isAvailable(context))) {
|
|
60
|
+
throw (0, errors_1.providerNotReadyError)(`${transport.label} is not available. Check its configuration and credentials.`);
|
|
61
|
+
}
|
|
62
|
+
return { configuration: configuration ?? null, transport, context };
|
|
63
|
+
};
|
|
64
|
+
exports.resolveTransportById = resolveTransportById;
|
|
65
|
+
const getAvailability = async (transport, configuration, options) => {
|
|
66
|
+
const isManaged = transport.credentialSources.includes('managed');
|
|
67
|
+
if (!configuration && !isManaged) {
|
|
68
|
+
return { available: false, unavailable_reason: 'Not configured.' };
|
|
69
|
+
}
|
|
70
|
+
try {
|
|
71
|
+
const context = configuration
|
|
72
|
+
? (0, exports.buildTransportContext)(configuration, options)
|
|
73
|
+
: { config: {}, credential: null, cloud: options.cloud ?? null };
|
|
74
|
+
const available = await transport.isAvailable(context);
|
|
75
|
+
return available
|
|
76
|
+
? { available: true }
|
|
77
|
+
: {
|
|
78
|
+
available: false,
|
|
79
|
+
unavailable_reason: isManaged
|
|
80
|
+
? 'Not available in this environment.'
|
|
81
|
+
: 'Credentials are not configured.',
|
|
82
|
+
};
|
|
83
|
+
}
|
|
84
|
+
catch (error) {
|
|
85
|
+
return { available: false, unavailable_reason: (0, errors_1.getErrorMessage)(error) };
|
|
86
|
+
}
|
|
87
|
+
};
|
|
88
|
+
const getEmailProviderState = async (service, options = {}) => {
|
|
89
|
+
const configurations = await (0, exports.listEmailProviderConfigurations)(service);
|
|
90
|
+
const byTransport = new Map(configurations.map((configuration) => [
|
|
91
|
+
configuration.transport_id,
|
|
92
|
+
configuration,
|
|
93
|
+
]));
|
|
94
|
+
const transports = await Promise.all((0, registry_1.listEmailTransports)().map(async (transport) => {
|
|
95
|
+
const configuration = byTransport.get(transport.id);
|
|
96
|
+
return {
|
|
97
|
+
id: transport.id,
|
|
98
|
+
label: transport.label,
|
|
99
|
+
selected: Boolean(configuration?.is_selected),
|
|
100
|
+
...(await getAvailability(transport, configuration, options)),
|
|
101
|
+
credential_sources: transport.credentialSources,
|
|
102
|
+
config: configuration?.config ?? {},
|
|
103
|
+
credential: (0, mask_1.maskCredential)(configuration?.credential),
|
|
104
|
+
};
|
|
105
|
+
}));
|
|
106
|
+
return {
|
|
107
|
+
selected_transport_id: configurations.find((configuration) => configuration.is_selected)
|
|
108
|
+
?.transport_id ?? null,
|
|
109
|
+
encryption_available: (0, encryption_key_1.isEncryptionAvailable)(),
|
|
110
|
+
transports,
|
|
111
|
+
};
|
|
112
|
+
};
|
|
113
|
+
exports.getEmailProviderState = getEmailProviderState;
|
|
114
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvdmlkZXItY29uZmlndXJhdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvcHJvdmlkZXItY29uZmlndXJhdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFFQSw2Q0FBMkU7QUFDM0UseUVBRzBDO0FBQzFDLDREQUFnRTtBQUNoRSxxQ0FBa0U7QUFDbEUsb0RBQStFO0FBOEN4RSxNQUFNLCtCQUErQixHQUFHLEtBQUssRUFDbEQsT0FBMEIsRUFDMUIsVUFBNEQsRUFBRSxFQUNqQixFQUFFLENBQy9DLENBQUMsTUFBTSxPQUFPLENBQUMsK0JBQStCLENBQUMsT0FBTyxFQUFFO0lBQ3RELFNBQVMsRUFBRSxDQUFDLFlBQVksQ0FBQztDQUMxQixDQUFDLENBQXVDLENBQUM7QUFOL0IsUUFBQSwrQkFBK0IsbUNBTUE7QUFFckMsTUFBTSxxQkFBcUIsR0FBRyxDQUNuQyxhQUErQyxFQUMvQyxVQUFtQyxFQUFFLEVBQ2QsRUFBRSxDQUFDLENBQUM7SUFDM0IsTUFBTSxFQUFFLGFBQWEsQ0FBQyxNQUFNLElBQUksRUFBRTtJQUNsQyxVQUFVLEVBQUUsSUFBQSxzQ0FBaUIsRUFBQyxhQUFhLENBQUMsVUFBVSxDQUFDO0lBQ3ZELEtBQUssRUFBRSxPQUFPLENBQUMsS0FBSyxJQUFJLElBQUk7SUFDNUIsY0FBYyxFQUFFLE9BQU8sQ0FBQyxjQUFjLElBQUksSUFBSTtJQUM5QyxNQUFNLEVBQUUsT0FBTyxDQUFDLE1BQU07Q0FDdkIsQ0FBQyxDQUFDO0FBVFUsUUFBQSxxQkFBcUIseUJBUy9CO0FBRUksTUFBTSx3QkFBd0IsR0FBRyxLQUFLLEVBQzNDLE9BQTBCLEVBQzFCLFVBQW1DLEVBQUUsRUFLcEMsRUFBRTtJQUNILE1BQU0sQ0FBQyxhQUFhLENBQUMsR0FBRyxNQUFNLElBQUEsdUNBQStCLEVBQUMsT0FBTyxFQUFFO1FBQ3JFLFdBQVcsRUFBRSxJQUFJO0tBQ2xCLENBQUMsQ0FBQztJQUVILElBQUksQ0FBQyxhQUFhLEVBQUUsQ0FBQztRQUNuQixNQUFNLElBQUEsOEJBQXFCLEVBQ3pCLDJFQUEyRSxDQUM1RSxDQUFDO0lBQ0osQ0FBQztJQUVELE1BQU0sU0FBUyxHQUFHLElBQUEsNEJBQWlCLEVBQUMsYUFBYSxDQUFDLFlBQVksQ0FBQyxDQUFDO0lBRWhFLElBQUksQ0FBQyxTQUFTLEVBQUUsQ0FBQztRQUNmLE1BQU0sSUFBQSw4QkFBcUIsRUFDekIsaUNBQWlDLGFBQWEsQ0FBQyxZQUFZLHNCQUFzQixDQUNsRixDQUFDO0lBQ0osQ0FBQztJQUVELE1BQU0sT0FBTyxHQUFHLElBQUEsNkJBQXFCLEVBQUMsYUFBYSxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBRTlELElBQUksQ0FBQyxDQUFDLE1BQU0sU0FBUyxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsQ0FBQyxFQUFFLENBQUM7UUFDNUMsTUFBTSxJQUFBLDhCQUFxQixFQUN6QixHQUFHLFNBQVMsQ0FBQyxLQUFLLDZEQUE2RCxDQUNoRixDQUFDO0lBQ0osQ0FBQztJQUVELE9BQU8sRUFBRSxhQUFhLEVBQUUsU0FBUyxFQUFFLE9BQU8sRUFBRSxDQUFDO0FBQy9DLENBQUMsQ0FBQztBQW5DVyxRQUFBLHdCQUF3Qiw0QkFtQ25DO0FBRUssTUFBTSxvQkFBb0IsR0FBRyxLQUFLLEVBQ3ZDLE9BQTBCLEVBQzFCLFdBQW1CLEVBQ25CLFVBQW1DLEVBQUUsRUFLcEMsRUFBRTtJQUNILE1BQU0sU0FBUyxHQUFHLElBQUEsNEJBQWlCLEVBQUMsV0FBVyxDQUFDLENBQUM7SUFFakQsSUFBSSxDQUFDLFNBQVMsRUFBRSxDQUFDO1FBQ2YsTUFBTSxJQUFBLDhCQUFxQixFQUN6Qix3QkFBd0IsV0FBVyxzQkFBc0IsQ0FDMUQsQ0FBQztJQUNKLENBQUM7SUFFRCxNQUFNLENBQUMsYUFBYSxDQUFDLEdBQUcsTUFBTSxJQUFBLHVDQUErQixFQUFDLE9BQU8sRUFBRTtRQUNyRSxZQUFZLEVBQUUsV0FBVztLQUMxQixDQUFDLENBQUM7SUFFSCxJQUFJLENBQUMsYUFBYSxJQUFJLENBQUMsU0FBUyxDQUFDLGlCQUFpQixDQUFDLFFBQVEsQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDO1FBQ3ZFLE1BQU0sSUFBQSw4QkFBcUIsRUFBQyxHQUFHLFNBQVMsQ0FBQyxLQUFLLHlCQUF5QixDQUFDLENBQUM7SUFDM0UsQ0FBQztJQUVELE1BQU0sT0FBTyxHQUFHLGFBQWE7UUFDM0IsQ0FBQyxDQUFDLElBQUEsNkJBQXFCLEVBQUMsYUFBYSxFQUFFLE9BQU8sQ0FBQztRQUMvQyxDQUFDLENBQUM7WUFDRSxNQUFNLEVBQUUsRUFBRTtZQUNWLFVBQVUsRUFBRSxJQUFJO1lBQ2hCLEtBQUssRUFBRSxPQUFPLENBQUMsS0FBSyxJQUFJLElBQUk7WUFDNUIsY0FBYyxFQUFFLE9BQU8sQ0FBQyxjQUFjLElBQUksSUFBSTtZQUM5QyxNQUFNLEVBQUUsT0FBTyxDQUFDLE1BQU07U0FDdkIsQ0FBQztJQUVOLElBQUksQ0FBQyxDQUFDLE1BQU0sU0FBUyxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsQ0FBQyxFQUFFLENBQUM7UUFDNUMsTUFBTSxJQUFBLDhCQUFxQixFQUN6QixHQUFHLFNBQVMsQ0FBQyxLQUFLLDZEQUE2RCxDQUNoRixDQUFDO0lBQ0osQ0FBQztJQUVELE9BQU8sRUFBRSxhQUFhLEVBQUUsYUFBYSxJQUFJLElBQUksRUFBRSxTQUFTLEVBQUUsT0FBTyxFQUFFLENBQUM7QUFDdEUsQ0FBQyxDQUFDO0FBMUNXLFFBQUEsb0JBQW9CLHdCQTBDL0I7QUFFRixNQUFNLGVBQWUsR0FBRyxLQUFLLEVBQzNCLFNBQXlCLEVBQ3pCLGFBQTJELEVBQzNELE9BQWdDLEVBQzhCLEVBQUU7SUFDaEUsTUFBTSxTQUFTLEdBQUcsU0FBUyxDQUFDLGlCQUFpQixDQUFDLFFBQVEsQ0FBQyxTQUFTLENBQUMsQ0FBQztJQUVsRSxJQUFJLENBQUMsYUFBYSxJQUFJLENBQUMsU0FBUyxFQUFFLENBQUM7UUFDakMsT0FBTyxFQUFFLFNBQVMsRUFBRSxLQUFLLEVBQUUsa0JBQWtCLEVBQUUsaUJBQWlCLEVBQUUsQ0FBQztJQUNyRSxDQUFDO0lBRUQsSUFBSSxDQUFDO1FBQ0gsTUFBTSxPQUFPLEdBQUcsYUFBYTtZQUMzQixDQUFDLENBQUMsSUFBQSw2QkFBcUIsRUFBQyxhQUFhLEVBQUUsT0FBTyxDQUFDO1lBQy9DLENBQUMsQ0FBQyxFQUFFLE1BQU0sRUFBRSxFQUFFLEVBQUUsVUFBVSxFQUFFLElBQUksRUFBRSxLQUFLLEVBQUUsT0FBTyxDQUFDLEtBQUssSUFBSSxJQUFJLEVBQUUsQ0FBQztRQUVuRSxNQUFNLFNBQVMsR0FBRyxNQUFNLFNBQVMsQ0FBQyxXQUFXLENBQUMsT0FBTyxDQUFDLENBQUM7UUFFdkQsT0FBTyxTQUFTO1lBQ2QsQ0FBQyxDQUFDLEVBQUUsU0FBUyxFQUFFLElBQUksRUFBRTtZQUNyQixDQUFDLENBQUM7Z0JBQ0UsU0FBUyxFQUFFLEtBQUs7Z0JBQ2hCLGtCQUFrQixFQUFFLFNBQVM7b0JBQzNCLENBQUMsQ0FBQyxvQ0FBb0M7b0JBQ3RDLENBQUMsQ0FBQyxpQ0FBaUM7YUFDdEMsQ0FBQztJQUNSLENBQUM7SUFBQyxPQUFPLEtBQUssRUFBRSxDQUFDO1FBQ2YsT0FBTyxFQUFFLFNBQVMsRUFBRSxLQUFLLEVBQUUsa0JBQWtCLEVBQUUsSUFBQSx3QkFBZSxFQUFDLEtBQUssQ0FBQyxFQUFFLENBQUM7SUFDMUUsQ0FBQztBQUNILENBQUMsQ0FBQztBQUVLLE1BQU0scUJBQXFCLEdBQUcsS0FBSyxFQUN4QyxPQUEwQixFQUMxQixVQUFtQyxFQUFFLEVBQ1IsRUFBRTtJQUMvQixNQUFNLGNBQWMsR0FBRyxNQUFNLElBQUEsdUNBQStCLEVBQUMsT0FBTyxDQUFDLENBQUM7SUFDdEUsTUFBTSxXQUFXLEdBQUcsSUFBSSxHQUFHLENBQ3pCLGNBQWMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxhQUFhLEVBQUUsRUFBRSxDQUFDO1FBQ3BDLGFBQWEsQ0FBQyxZQUFZO1FBQzFCLGFBQWE7S0FDZCxDQUFDLENBQ0gsQ0FBQztJQUVGLE1BQU0sVUFBVSxHQUFHLE1BQU0sT0FBTyxDQUFDLEdBQUcsQ0FDbEMsSUFBQSw4QkFBbUIsR0FBRSxDQUFDLEdBQUcsQ0FBQyxLQUFLLEVBQUUsU0FBUyxFQUFFLEVBQUU7UUFDNUMsTUFBTSxhQUFhLEdBQUcsV0FBVyxDQUFDLEdBQUcsQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLENBQUM7UUFFcEQsT0FBTztZQUNMLEVBQUUsRUFBRSxTQUFTLENBQUMsRUFBRTtZQUNoQixLQUFLLEVBQUUsU0FBUyxDQUFDLEtBQUs7WUFDdEIsUUFBUSxFQUFFLE9BQU8sQ0FBQyxhQUFhLEVBQUUsV0FBVyxDQUFDO1lBQzdDLEdBQUcsQ0FBQyxNQUFNLGVBQWUsQ0FBQyxTQUFTLEVBQUUsYUFBYSxFQUFFLE9BQU8sQ0FBQyxDQUFDO1lBQzdELGtCQUFrQixFQUFFLFNBQVMsQ0FBQyxpQkFBaUI7WUFDL0MsTUFBTSxFQUFFLGFBQWEsRUFBRSxNQUFNLElBQUksRUFBRTtZQUNuQyxVQUFVLEVBQUUsSUFBQSxxQkFBYyxFQUFDLGFBQWEsRUFBRSxVQUFVLENBQUM7U0FDdEQsQ0FBQztJQUNKLENBQUMsQ0FBQyxDQUNILENBQUM7SUFFRixPQUFPO1FBQ0wscUJBQXFCLEVBQ25CLGNBQWMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxhQUFhLEVBQUUsRUFBRSxDQUFDLGFBQWEsQ0FBQyxXQUFXLENBQUM7WUFDL0QsRUFBRSxZQUFZLElBQUksSUFBSTtRQUMxQixvQkFBb0IsRUFBRSxJQUFBLHNDQUFxQixHQUFFO1FBQzdDLFVBQVU7S0FDWCxDQUFDO0FBQ0osQ0FBQyxDQUFDO0FBbkNXLFFBQUEscUJBQXFCLHlCQW1DaEMifQ==
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const redactSecrets: (message: string, secrets: ReadonlyArray<string | null | undefined>) => string;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.redactSecrets = void 0;
|
|
4
|
+
const MIN_SECRET_LENGTH = 4;
|
|
5
|
+
const redactSecrets = (message, secrets) => secrets.reduce((result, secret) => {
|
|
6
|
+
if (!secret || secret.length < MIN_SECRET_LENGTH) {
|
|
7
|
+
return result;
|
|
8
|
+
}
|
|
9
|
+
return result.split(secret).join('[redacted]');
|
|
10
|
+
}, message);
|
|
11
|
+
exports.redactSecrets = redactSecrets;
|
|
12
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVkYWN0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2xpYi9yZWRhY3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsTUFBTSxpQkFBaUIsR0FBRyxDQUFDLENBQUM7QUFFckIsTUFBTSxhQUFhLEdBQUcsQ0FDM0IsT0FBZSxFQUNmLE9BQWlELEVBQ3pDLEVBQUUsQ0FDVixPQUFPLENBQUMsTUFBTSxDQUFTLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxFQUFFO0lBQ3hDLElBQUksQ0FBQyxNQUFNLElBQUksTUFBTSxDQUFDLE1BQU0sR0FBRyxpQkFBaUIsRUFBRSxDQUFDO1FBQ2pELE9BQU8sTUFBTSxDQUFDO0lBQ2hCLENBQUM7SUFFRCxPQUFPLE1BQU0sQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxDQUFDO0FBQ2pELENBQUMsRUFBRSxPQUFPLENBQUMsQ0FBQztBQVZELFFBQUEsYUFBYSxpQkFVWiJ9
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { VariableFormat } from './variable-format';
|
|
2
|
+
/**
|
|
3
|
+
* Turns a value into the text a recipient sees.
|
|
4
|
+
*
|
|
5
|
+
* Shared by sends (registered as Liquid filters in `./liquid.ts`) and the
|
|
6
|
+
* editor's previews, so previews show exactly what sends.
|
|
7
|
+
*
|
|
8
|
+
* Bundled into the admin, so keep it dependency-free: no Node APIs,
|
|
9
|
+
* `liquidjs` or `@medusajs/framework`.
|
|
10
|
+
*/
|
|
11
|
+
export type DateFormat = Extract<VariableFormat, `date_${string}`>;
|
|
12
|
+
export declare const DATE_FORMAT_NAMES: DateFormat[];
|
|
13
|
+
export declare const formatMoney: (value: unknown, currencyCode?: unknown) => string;
|
|
14
|
+
/**
|
|
15
|
+
* Dates arrive as ISO strings (the context is round-tripped through JSON);
|
|
16
|
+
* numeric timestamps are accepted too.
|
|
17
|
+
*
|
|
18
|
+
* Pinned to UTC (same output on any server) and `en-US` (like `formatMoney`).
|
|
19
|
+
* Both are known limitations; locale support is a follow-up.
|
|
20
|
+
*/
|
|
21
|
+
export declare const formatDate: (value: unknown, format: DateFormat) => string;
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.formatDate = exports.formatMoney = exports.DATE_FORMAT_NAMES = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Keyed by the shared format union, so a new `date_*` format without options
|
|
6
|
+
* is a compile error, not a send-time `strictFilters` failure.
|
|
7
|
+
*/
|
|
8
|
+
const DATE_FORMATS = {
|
|
9
|
+
date_long: { day: 'numeric', month: 'long', year: 'numeric' },
|
|
10
|
+
date_short: { day: '2-digit', month: '2-digit', year: 'numeric' },
|
|
11
|
+
date_time: {
|
|
12
|
+
day: 'numeric',
|
|
13
|
+
month: 'long',
|
|
14
|
+
year: 'numeric',
|
|
15
|
+
hour: 'numeric',
|
|
16
|
+
minute: '2-digit',
|
|
17
|
+
},
|
|
18
|
+
};
|
|
19
|
+
exports.DATE_FORMAT_NAMES = Object.keys(DATE_FORMATS);
|
|
20
|
+
const formatMoney = (value, currencyCode) => {
|
|
21
|
+
const amount = typeof value === 'string' ? Number(value) : value;
|
|
22
|
+
if (typeof amount !== 'number' || !Number.isFinite(amount)) {
|
|
23
|
+
return '';
|
|
24
|
+
}
|
|
25
|
+
const currency = typeof currencyCode === 'string' && currencyCode.length === 3
|
|
26
|
+
? currencyCode.toUpperCase()
|
|
27
|
+
: undefined;
|
|
28
|
+
if (!currency) {
|
|
29
|
+
return amount.toFixed(2);
|
|
30
|
+
}
|
|
31
|
+
return new Intl.NumberFormat('en-US', { style: 'currency', currency }).format(amount);
|
|
32
|
+
};
|
|
33
|
+
exports.formatMoney = formatMoney;
|
|
34
|
+
/**
|
|
35
|
+
* Dates arrive as ISO strings (the context is round-tripped through JSON);
|
|
36
|
+
* numeric timestamps are accepted too.
|
|
37
|
+
*
|
|
38
|
+
* Pinned to UTC (same output on any server) and `en-US` (like `formatMoney`).
|
|
39
|
+
* Both are known limitations; locale support is a follow-up.
|
|
40
|
+
*/
|
|
41
|
+
const formatDate = (value, format) => {
|
|
42
|
+
if (typeof value !== 'string' && typeof value !== 'number') {
|
|
43
|
+
return '';
|
|
44
|
+
}
|
|
45
|
+
const date = new Date(value);
|
|
46
|
+
if (Number.isNaN(date.getTime())) {
|
|
47
|
+
return '';
|
|
48
|
+
}
|
|
49
|
+
return new Intl.DateTimeFormat('en-US', {
|
|
50
|
+
timeZone: 'UTC',
|
|
51
|
+
...DATE_FORMATS[format],
|
|
52
|
+
}).format(date);
|
|
53
|
+
};
|
|
54
|
+
exports.formatDate = formatDate;
|
|
55
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZm9ybWF0LXZhbHVlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vc3JjL2xpYi9yZW5kZXJpbmcvZm9ybWF0LXZhbHVlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQWNBOzs7R0FHRztBQUNILE1BQU0sWUFBWSxHQUFtRDtJQUNuRSxTQUFTLEVBQUUsRUFBRSxHQUFHLEVBQUUsU0FBUyxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsSUFBSSxFQUFFLFNBQVMsRUFBRTtJQUM3RCxVQUFVLEVBQUUsRUFBRSxHQUFHLEVBQUUsU0FBUyxFQUFFLEtBQUssRUFBRSxTQUFTLEVBQUUsSUFBSSxFQUFFLFNBQVMsRUFBRTtJQUNqRSxTQUFTLEVBQUU7UUFDVCxHQUFHLEVBQUUsU0FBUztRQUNkLEtBQUssRUFBRSxNQUFNO1FBQ2IsSUFBSSxFQUFFLFNBQVM7UUFDZixJQUFJLEVBQUUsU0FBUztRQUNmLE1BQU0sRUFBRSxTQUFTO0tBQ2xCO0NBQ0YsQ0FBQztBQUVXLFFBQUEsaUJBQWlCLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQyxZQUFZLENBQWlCLENBQUM7QUFFcEUsTUFBTSxXQUFXLEdBQUcsQ0FBQyxLQUFjLEVBQUUsWUFBc0IsRUFBVSxFQUFFO0lBQzVFLE1BQU0sTUFBTSxHQUFHLE9BQU8sS0FBSyxLQUFLLFFBQVEsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUM7SUFFakUsSUFBSSxPQUFPLE1BQU0sS0FBSyxRQUFRLElBQUksQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUM7UUFDM0QsT0FBTyxFQUFFLENBQUM7SUFDWixDQUFDO0lBRUQsTUFBTSxRQUFRLEdBQ1osT0FBTyxZQUFZLEtBQUssUUFBUSxJQUFJLFlBQVksQ0FBQyxNQUFNLEtBQUssQ0FBQztRQUMzRCxDQUFDLENBQUMsWUFBWSxDQUFDLFdBQVcsRUFBRTtRQUM1QixDQUFDLENBQUMsU0FBUyxDQUFDO0lBRWhCLElBQUksQ0FBQyxRQUFRLEVBQUUsQ0FBQztRQUNkLE9BQU8sTUFBTSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUMzQixDQUFDO0lBRUQsT0FBTyxJQUFJLElBQUksQ0FBQyxZQUFZLENBQUMsT0FBTyxFQUFFLEVBQUUsS0FBSyxFQUFFLFVBQVUsRUFBRSxRQUFRLEVBQUUsQ0FBQyxDQUFDLE1BQU0sQ0FDM0UsTUFBTSxDQUNQLENBQUM7QUFDSixDQUFDLENBQUM7QUFuQlcsUUFBQSxXQUFXLGVBbUJ0QjtBQUVGOzs7Ozs7R0FNRztBQUNJLE1BQU0sVUFBVSxHQUFHLENBQUMsS0FBYyxFQUFFLE1BQWtCLEVBQVUsRUFBRTtJQUN2RSxJQUFJLE9BQU8sS0FBSyxLQUFLLFFBQVEsSUFBSSxPQUFPLEtBQUssS0FBSyxRQUFRLEVBQUUsQ0FBQztRQUMzRCxPQUFPLEVBQUUsQ0FBQztJQUNaLENBQUM7SUFFRCxNQUFNLElBQUksR0FBRyxJQUFJLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQztJQUU3QixJQUFJLE1BQU0sQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFDLEVBQUUsQ0FBQztRQUNqQyxPQUFPLEVBQUUsQ0FBQztJQUNaLENBQUM7SUFFRCxPQUFPLElBQUksSUFBSSxDQUFDLGNBQWMsQ0FBQyxPQUFPLEVBQUU7UUFDdEMsUUFBUSxFQUFFLEtBQUs7UUFDZixHQUFHLFlBQVksQ0FBQyxNQUFNLENBQUM7S0FDeEIsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQztBQUNsQixDQUFDLENBQUM7QUFmVyxRQUFBLFVBQVUsY0FlckIifQ==
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.createEmailLiquid = void 0;
|
|
4
|
+
const liquidjs_1 = require("liquidjs");
|
|
5
|
+
const format_value_1 = require("./format-value");
|
|
6
|
+
/** Tags that read files from disk. Templates are admin-authored, not files. */
|
|
7
|
+
const BLOCKED_TAGS = ['include', 'render', 'layout', 'block'];
|
|
8
|
+
// Guards against runaway templates (liquidjs "DoS handling" options).
|
|
9
|
+
const PARSE_LIMIT = 1_000_000; // characters
|
|
10
|
+
const RENDER_LIMIT = 2_000; // ms
|
|
11
|
+
const MEMORY_LIMIT = 100_000_000;
|
|
12
|
+
const blockedTag = (name) => ({
|
|
13
|
+
parse() {
|
|
14
|
+
throw new Error(`The "${name}" tag is not allowed in email templates.`);
|
|
15
|
+
},
|
|
16
|
+
render() {
|
|
17
|
+
throw new Error(`The "${name}" tag is not allowed in email templates.`);
|
|
18
|
+
},
|
|
19
|
+
});
|
|
20
|
+
const throwOnFileAccess = () => {
|
|
21
|
+
throw new Error('Email templates cannot read files.');
|
|
22
|
+
};
|
|
23
|
+
const deniedFileSystem = {
|
|
24
|
+
readFile: async () => throwOnFileAccess(),
|
|
25
|
+
readFileSync: () => throwOnFileAccess(),
|
|
26
|
+
exists: async () => false,
|
|
27
|
+
existsSync: () => false,
|
|
28
|
+
contains: async () => false,
|
|
29
|
+
resolve: (_dir, file) => file,
|
|
30
|
+
dirname: (file) => file,
|
|
31
|
+
sep: '/',
|
|
32
|
+
};
|
|
33
|
+
const createEmailLiquid = ({ escapeOutput = false, } = {}) => {
|
|
34
|
+
const liquid = new liquidjs_1.Liquid({
|
|
35
|
+
strictFilters: true,
|
|
36
|
+
ownPropertyOnly: true,
|
|
37
|
+
relativeReference: false,
|
|
38
|
+
parseLimit: PARSE_LIMIT,
|
|
39
|
+
renderLimit: RENDER_LIMIT,
|
|
40
|
+
memoryLimit: MEMORY_LIMIT,
|
|
41
|
+
fs: deniedFileSystem,
|
|
42
|
+
...(escapeOutput ? { outputEscape: 'escape' } : {}),
|
|
43
|
+
});
|
|
44
|
+
BLOCKED_TAGS.forEach((name) => liquid.registerTag(name, blockedTag(name)));
|
|
45
|
+
liquid.registerFilter('money', format_value_1.formatMoney);
|
|
46
|
+
format_value_1.DATE_FORMAT_NAMES.forEach((name) => {
|
|
47
|
+
liquid.registerFilter(name, (value) => (0, format_value_1.formatDate)(value, name));
|
|
48
|
+
});
|
|
49
|
+
return liquid;
|
|
50
|
+
};
|
|
51
|
+
exports.createEmailLiquid = createEmailLiquid;
|
|
52
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibGlxdWlkLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vc3JjL2xpYi9yZW5kZXJpbmcvbGlxdWlkLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLHVDQUFrQztBQUVsQyxpREFBNEU7QUFFNUUsK0VBQStFO0FBQy9FLE1BQU0sWUFBWSxHQUFHLENBQUMsU0FBUyxFQUFFLFFBQVEsRUFBRSxRQUFRLEVBQUUsT0FBTyxDQUFDLENBQUM7QUFFOUQsc0VBQXNFO0FBQ3RFLE1BQU0sV0FBVyxHQUFHLFNBQVMsQ0FBQyxDQUFDLGFBQWE7QUFDNUMsTUFBTSxZQUFZLEdBQUcsS0FBSyxDQUFDLENBQUMsS0FBSztBQUNqQyxNQUFNLFlBQVksR0FBRyxXQUFXLENBQUM7QUFFakMsTUFBTSxVQUFVLEdBQUcsQ0FBQyxJQUFZLEVBQUUsRUFBRSxDQUFDLENBQUM7SUFDcEMsS0FBSztRQUNILE1BQU0sSUFBSSxLQUFLLENBQUMsUUFBUSxJQUFJLDBDQUEwQyxDQUFDLENBQUM7SUFDMUUsQ0FBQztJQUNELE1BQU07UUFDSixNQUFNLElBQUksS0FBSyxDQUFDLFFBQVEsSUFBSSwwQ0FBMEMsQ0FBQyxDQUFDO0lBQzFFLENBQUM7Q0FDRixDQUFDLENBQUM7QUFFSCxNQUFNLGlCQUFpQixHQUFHLEdBQUcsRUFBRTtJQUM3QixNQUFNLElBQUksS0FBSyxDQUFDLG9DQUFvQyxDQUFDLENBQUM7QUFDeEQsQ0FBQyxDQUFDO0FBRUYsTUFBTSxnQkFBZ0IsR0FBRztJQUN2QixRQUFRLEVBQUUsS0FBSyxJQUFJLEVBQUUsQ0FBQyxpQkFBaUIsRUFBRTtJQUN6QyxZQUFZLEVBQUUsR0FBRyxFQUFFLENBQUMsaUJBQWlCLEVBQUU7SUFDdkMsTUFBTSxFQUFFLEtBQUssSUFBSSxFQUFFLENBQUMsS0FBSztJQUN6QixVQUFVLEVBQUUsR0FBRyxFQUFFLENBQUMsS0FBSztJQUN2QixRQUFRLEVBQUUsS0FBSyxJQUFJLEVBQUUsQ0FBQyxLQUFLO0lBQzNCLE9BQU8sRUFBRSxDQUFDLElBQVksRUFBRSxJQUFZLEVBQUUsRUFBRSxDQUFDLElBQUk7SUFDN0MsT0FBTyxFQUFFLENBQUMsSUFBWSxFQUFFLEVBQUUsQ0FBQyxJQUFJO0lBQy9CLEdBQUcsRUFBRSxHQUFHO0NBQ1QsQ0FBQztBQU1LLE1BQU0saUJBQWlCLEdBQUcsQ0FBQyxFQUNoQyxZQUFZLEdBQUcsS0FBSyxNQUNRLEVBQUUsRUFBVSxFQUFFO0lBQzFDLE1BQU0sTUFBTSxHQUFHLElBQUksaUJBQU0sQ0FBQztRQUN4QixhQUFhLEVBQUUsSUFBSTtRQUNuQixlQUFlLEVBQUUsSUFBSTtRQUNyQixpQkFBaUIsRUFBRSxLQUFLO1FBQ3hCLFVBQVUsRUFBRSxXQUFXO1FBQ3ZCLFdBQVcsRUFBRSxZQUFZO1FBQ3pCLFdBQVcsRUFBRSxZQUFZO1FBQ3pCLEVBQUUsRUFBRSxnQkFBZ0I7UUFDcEIsR0FBRyxDQUFDLFlBQVksQ0FBQyxDQUFDLENBQUMsRUFBRSxZQUFZLEVBQUUsUUFBaUIsRUFBRSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUM7S0FDN0QsQ0FBQyxDQUFDO0lBRUgsWUFBWSxDQUFDLE9BQU8sQ0FBQyxDQUFDLElBQUksRUFBRSxFQUFFLENBQUMsTUFBTSxDQUFDLFdBQVcsQ0FBQyxJQUFJLEVBQUUsVUFBVSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUMzRSxNQUFNLENBQUMsY0FBYyxDQUFDLE9BQU8sRUFBRSwwQkFBVyxDQUFDLENBQUM7SUFFNUMsZ0NBQWlCLENBQUMsT0FBTyxDQUFDLENBQUMsSUFBSSxFQUFFLEVBQUU7UUFDakMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxLQUFjLEVBQUUsRUFBRSxDQUFDLElBQUEseUJBQVUsRUFBQyxLQUFLLEVBQUUsSUFBSSxDQUFDLENBQUMsQ0FBQztJQUMzRSxDQUFDLENBQUMsQ0FBQztJQUVILE9BQU8sTUFBTSxDQUFDO0FBQ2hCLENBQUMsQ0FBQztBQXRCVyxRQUFBLGlCQUFpQixxQkFzQjVCIn0=
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export type EmailTemplateSource = {
|
|
2
|
+
template_key: string;
|
|
3
|
+
subject_template: string;
|
|
4
|
+
html_template?: string | null;
|
|
5
|
+
text_template?: string | null;
|
|
6
|
+
};
|
|
7
|
+
export type RenderedEmailContent = {
|
|
8
|
+
subject: string;
|
|
9
|
+
html: string;
|
|
10
|
+
text: string;
|
|
11
|
+
};
|
|
12
|
+
export declare const renderEmailTemplate: (template: EmailTemplateSource, data: Record<string, unknown> | null | undefined) => Promise<RenderedEmailContent>;
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.renderEmailTemplate = void 0;
|
|
4
|
+
const html_to_text_1 = require("html-to-text");
|
|
5
|
+
const errors_1 = require("../errors");
|
|
6
|
+
const liquid_1 = require("./liquid");
|
|
7
|
+
const sanitize_context_1 = require("./sanitize-context");
|
|
8
|
+
const plainLiquid = (0, liquid_1.createEmailLiquid)();
|
|
9
|
+
const htmlLiquid = (0, liquid_1.createEmailLiquid)({ escapeOutput: true });
|
|
10
|
+
const TEXT_OPTIONS = {
|
|
11
|
+
wordwrap: 80,
|
|
12
|
+
selectors: [
|
|
13
|
+
{ selector: 'table', format: 'dataTable' },
|
|
14
|
+
{ selector: 'img', format: 'skip' },
|
|
15
|
+
],
|
|
16
|
+
};
|
|
17
|
+
const render = async (liquid, template, context, templateKey, field) => {
|
|
18
|
+
try {
|
|
19
|
+
return await liquid.parseAndRender(template, context);
|
|
20
|
+
}
|
|
21
|
+
catch (error) {
|
|
22
|
+
// Never include data values: the message may reach the admin UI.
|
|
23
|
+
throw (0, errors_1.invalidDataError)(`Failed to render the ${field} of email template "${templateKey}": ${(0, errors_1.getErrorMessage)(error)}`);
|
|
24
|
+
}
|
|
25
|
+
};
|
|
26
|
+
const renderEmailTemplate = async (template, data) => {
|
|
27
|
+
const context = (0, sanitize_context_1.sanitizeTemplateContext)(data);
|
|
28
|
+
const subject = (await render(plainLiquid, template.subject_template, context, template.template_key, 'subject'))
|
|
29
|
+
.replace(/\s+/g, ' ')
|
|
30
|
+
.trim();
|
|
31
|
+
if (!subject) {
|
|
32
|
+
throw (0, errors_1.invalidDataError)(`The subject of email template "${template.template_key}" rendered empty.`);
|
|
33
|
+
}
|
|
34
|
+
const html = template.html_template
|
|
35
|
+
? await render(htmlLiquid, template.html_template, context, template.template_key, 'HTML body')
|
|
36
|
+
: '';
|
|
37
|
+
const text = template.text_template
|
|
38
|
+
? await render(plainLiquid, template.text_template, context, template.template_key, 'text body')
|
|
39
|
+
: (0, html_to_text_1.convert)(html, TEXT_OPTIONS);
|
|
40
|
+
if (!html && !text.trim()) {
|
|
41
|
+
throw (0, errors_1.invalidDataError)(`Email template "${template.template_key}" has no body.`);
|
|
42
|
+
}
|
|
43
|
+
return { subject, html, text };
|
|
44
|
+
};
|
|
45
|
+
exports.renderEmailTemplate = renderEmailTemplate;
|
|
46
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVuZGVyLXRlbXBsYXRlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vc3JjL2xpYi9yZW5kZXJpbmcvcmVuZGVyLXRlbXBsYXRlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLCtDQUF1QztBQUV2QyxzQ0FBOEQ7QUFDOUQscUNBQTZDO0FBQzdDLHlEQUE2RDtBQWU3RCxNQUFNLFdBQVcsR0FBRyxJQUFBLDBCQUFpQixHQUFFLENBQUM7QUFDeEMsTUFBTSxVQUFVLEdBQUcsSUFBQSwwQkFBaUIsRUFBQyxFQUFFLFlBQVksRUFBRSxJQUFJLEVBQUUsQ0FBQyxDQUFDO0FBRTdELE1BQU0sWUFBWSxHQUFHO0lBQ25CLFFBQVEsRUFBRSxFQUFFO0lBQ1osU0FBUyxFQUFFO1FBQ1QsRUFBRSxRQUFRLEVBQUUsT0FBTyxFQUFFLE1BQU0sRUFBRSxXQUFXLEVBQUU7UUFDMUMsRUFBRSxRQUFRLEVBQUUsS0FBSyxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUU7S0FDcEM7Q0FDRixDQUFDO0FBRUYsTUFBTSxNQUFNLEdBQUcsS0FBSyxFQUNsQixNQUE0QyxFQUM1QyxRQUFnQixFQUNoQixPQUFnQyxFQUNoQyxXQUFtQixFQUNuQixLQUFhLEVBQ0ksRUFBRTtJQUNuQixJQUFJLENBQUM7UUFDSCxPQUFPLE1BQU0sTUFBTSxDQUFDLGNBQWMsQ0FBQyxRQUFRLEVBQUUsT0FBTyxDQUFDLENBQUM7SUFDeEQsQ0FBQztJQUFDLE9BQU8sS0FBSyxFQUFFLENBQUM7UUFDZixpRUFBaUU7UUFDakUsTUFBTSxJQUFBLHlCQUFnQixFQUNwQix3QkFBd0IsS0FBSyx1QkFBdUIsV0FBVyxNQUFNLElBQUEsd0JBQWUsRUFBQyxLQUFLLENBQUMsRUFBRSxDQUM5RixDQUFDO0lBQ0osQ0FBQztBQUNILENBQUMsQ0FBQztBQUVLLE1BQU0sbUJBQW1CLEdBQUcsS0FBSyxFQUN0QyxRQUE2QixFQUM3QixJQUFnRCxFQUNqQixFQUFFO0lBQ2pDLE1BQU0sT0FBTyxHQUFHLElBQUEsMENBQXVCLEVBQUMsSUFBSSxDQUFDLENBQUM7SUFFOUMsTUFBTSxPQUFPLEdBQUcsQ0FDZCxNQUFNLE1BQU0sQ0FDVixXQUFXLEVBQ1gsUUFBUSxDQUFDLGdCQUFnQixFQUN6QixPQUFPLEVBQ1AsUUFBUSxDQUFDLFlBQVksRUFDckIsU0FBUyxDQUNWLENBQ0Y7U0FDRSxPQUFPLENBQUMsTUFBTSxFQUFFLEdBQUcsQ0FBQztTQUNwQixJQUFJLEVBQUUsQ0FBQztJQUVWLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQztRQUNiLE1BQU0sSUFBQSx5QkFBZ0IsRUFDcEIsa0NBQWtDLFFBQVEsQ0FBQyxZQUFZLG1CQUFtQixDQUMzRSxDQUFDO0lBQ0osQ0FBQztJQUVELE1BQU0sSUFBSSxHQUFHLFFBQVEsQ0FBQyxhQUFhO1FBQ2pDLENBQUMsQ0FBQyxNQUFNLE1BQU0sQ0FDVixVQUFVLEVBQ1YsUUFBUSxDQUFDLGFBQWEsRUFDdEIsT0FBTyxFQUNQLFFBQVEsQ0FBQyxZQUFZLEVBQ3JCLFdBQVcsQ0FDWjtRQUNILENBQUMsQ0FBQyxFQUFFLENBQUM7SUFFUCxNQUFNLElBQUksR0FBRyxRQUFRLENBQUMsYUFBYTtRQUNqQyxDQUFDLENBQUMsTUFBTSxNQUFNLENBQ1YsV0FBVyxFQUNYLFFBQVEsQ0FBQyxhQUFhLEVBQ3RCLE9BQU8sRUFDUCxRQUFRLENBQUMsWUFBWSxFQUNyQixXQUFXLENBQ1o7UUFDSCxDQUFDLENBQUMsSUFBQSxzQkFBTyxFQUFDLElBQUksRUFBRSxZQUFZLENBQUMsQ0FBQztJQUVoQyxJQUFJLENBQUMsSUFBSSxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksRUFBRSxFQUFFLENBQUM7UUFDMUIsTUFBTSxJQUFBLHlCQUFnQixFQUNwQixtQkFBbUIsUUFBUSxDQUFDLFlBQVksZ0JBQWdCLENBQ3pELENBQUM7SUFDSixDQUFDO0lBRUQsT0FBTyxFQUFFLE9BQU8sRUFBRSxJQUFJLEVBQUUsSUFBSSxFQUFFLENBQUM7QUFDakMsQ0FBQyxDQUFDO0FBbkRXLFFBQUEsbUJBQW1CLHVCQW1EOUIifQ==
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const sanitizeTemplateContext: (data: Record<string, unknown> | null | undefined) => Record<string, unknown>;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.sanitizeTemplateContext = void 0;
|
|
4
|
+
const sanitizeTemplateContext = (data) => {
|
|
5
|
+
if (!data) {
|
|
6
|
+
return {};
|
|
7
|
+
}
|
|
8
|
+
const plain = JSON.parse(JSON.stringify(data, (_key, value) => typeof value === 'bigint' ? value.toString() : value));
|
|
9
|
+
return plain && typeof plain === 'object' && !Array.isArray(plain)
|
|
10
|
+
? plain
|
|
11
|
+
: {};
|
|
12
|
+
};
|
|
13
|
+
exports.sanitizeTemplateContext = sanitizeTemplateContext;
|
|
14
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2FuaXRpemUtY29udGV4dC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3NyYy9saWIvcmVuZGVyaW5nL3Nhbml0aXplLWNvbnRleHQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQU8sTUFBTSx1QkFBdUIsR0FBRyxDQUNyQyxJQUFnRCxFQUN2QixFQUFFO0lBQzNCLElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQztRQUNWLE9BQU8sRUFBRSxDQUFDO0lBQ1osQ0FBQztJQUVELE1BQU0sS0FBSyxHQUFZLElBQUksQ0FBQyxLQUFLLENBQy9CLElBQUksQ0FBQyxTQUFTLENBQUMsSUFBSSxFQUFFLENBQUMsSUFBSSxFQUFFLEtBQUssRUFBRSxFQUFFLENBQ25DLE9BQU8sS0FBSyxLQUFLLFFBQVEsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQ3JELENBQ0YsQ0FBQztJQUVGLE9BQU8sS0FBSyxJQUFJLE9BQU8sS0FBSyxLQUFLLFFBQVEsSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDO1FBQ2hFLENBQUMsQ0FBRSxLQUFpQztRQUNwQyxDQUFDLENBQUMsRUFBRSxDQUFDO0FBQ1QsQ0FBQyxDQUFDO0FBaEJXLFFBQUEsdUJBQXVCLDJCQWdCbEMifQ==
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Maps a variable's display format to the Liquid expression that produces it.
|
|
3
|
+
*
|
|
4
|
+
* Shared by the admin editor (which emits these on export) and the server
|
|
5
|
+
* (which registers the matching filters in `./liquid.ts`). It is bundled into
|
|
6
|
+
* the admin, so keep it dependency-free: no Node APIs, `liquidjs` or
|
|
7
|
+
* `@medusajs/framework`.
|
|
8
|
+
*
|
|
9
|
+
* Expressions are quote-free by construction: React entity-encodes quotes on
|
|
10
|
+
* export, which would corrupt string-literal filter arguments.
|
|
11
|
+
*/
|
|
12
|
+
declare const VARIABLE_FORMATS: readonly ["text", "money", "date_long", "date_short", "date_time"];
|
|
13
|
+
export type VariableFormat = (typeof VARIABLE_FORMATS)[number];
|
|
14
|
+
/** Dot-separated lowercase identifiers, so an expression never has a quote. */
|
|
15
|
+
export declare const VARIABLE_KEY_PATTERN: RegExp;
|
|
16
|
+
export declare const isVariableFormat: (value: unknown) => value is VariableFormat;
|
|
17
|
+
type ToLiquidExpressionOptions = {
|
|
18
|
+
/**
|
|
19
|
+
* Liquid path to the currency code for `money`. Emitted verbatim, so inside
|
|
20
|
+
* a loop it still refers to the outer scope (`order.currency_code`).
|
|
21
|
+
*/
|
|
22
|
+
currencySource?: string;
|
|
23
|
+
};
|
|
24
|
+
export declare const toLiquidExpression: (key: string, format?: VariableFormat, options?: ToLiquidExpressionOptions) => string;
|
|
25
|
+
/** The loop alias for each entry. Fixed, since Repeat blocks don't nest. */
|
|
26
|
+
export declare const LOOP_ITEM = "item";
|
|
27
|
+
export declare const toLiquidLoop: (source: string) => {
|
|
28
|
+
open: string;
|
|
29
|
+
close: string;
|
|
30
|
+
};
|
|
31
|
+
export type ParsedLiquidExpression = {
|
|
32
|
+
key: string;
|
|
33
|
+
format: VariableFormat;
|
|
34
|
+
currencySource?: string;
|
|
35
|
+
};
|
|
36
|
+
export type LiquidExpressionMatch = ParsedLiquidExpression & {
|
|
37
|
+
source: string;
|
|
38
|
+
start: number;
|
|
39
|
+
end: number;
|
|
40
|
+
};
|
|
41
|
+
export declare const fromLiquidExpression: (expression: string) => ParsedLiquidExpression | null;
|
|
42
|
+
export declare const findLiquidExpressions: (text: string) => LiquidExpressionMatch[];
|
|
43
|
+
export {};
|