@vendure/email-plugin 1.4.7 → 1.5.2
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/lib/src/default-email-handlers.d.ts +16 -0
- package/lib/src/default-email-handlers.js +30 -1
- package/lib/src/default-email-handlers.js.map +1 -1
- package/lib/src/mock-events.js +1 -0
- package/lib/src/mock-events.js.map +1 -1
- package/package.json +4 -4
- package/templates/order-confirmation/body.hbs +1 -1
|
@@ -7,4 +7,20 @@ export declare const emailVerificationHandler: EmailEventHandler<"email-verifica
|
|
|
7
7
|
export declare const passwordResetHandler: EmailEventHandler<"password-reset", PasswordResetEvent>;
|
|
8
8
|
export declare const emailAddressChangeHandler: EmailEventHandler<"email-address-change", IdentifierChangeRequestEvent>;
|
|
9
9
|
export declare const defaultEmailHandlers: Array<EmailEventHandler<any, any>>;
|
|
10
|
+
/**
|
|
11
|
+
* @description
|
|
12
|
+
* Applies the configured `AssetStorageStrategy.toAbsoluteUrl()` function to each of the
|
|
13
|
+
* OrderLine's `featuredAsset.preview` properties, so that they can be correctly displayed
|
|
14
|
+
* in the email template.
|
|
15
|
+
* This is required since that step usually happens at the API in middleware, which is not
|
|
16
|
+
* applicable in this context. So we need to do it manually.
|
|
17
|
+
*
|
|
18
|
+
* **Note: Mutates the Order object**
|
|
19
|
+
*/
|
|
20
|
+
export declare function transformOrderLineAssetUrls(ctx: RequestContext, order: Order, injector: Injector): Order;
|
|
21
|
+
/**
|
|
22
|
+
* @description
|
|
23
|
+
* Ensures that the ShippingLines are hydrated so that we can use the
|
|
24
|
+
* `shippingMethod.name` property in the email template.
|
|
25
|
+
*/
|
|
10
26
|
export declare function hydrateShippingLines(ctx: RequestContext, order: Order, injector: Injector): Promise<ShippingLine[]>;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.hydrateShippingLines = exports.defaultEmailHandlers = exports.emailAddressChangeHandler = exports.passwordResetHandler = exports.emailVerificationHandler = exports.orderConfirmationHandler = void 0;
|
|
3
|
+
exports.hydrateShippingLines = exports.transformOrderLineAssetUrls = exports.defaultEmailHandlers = exports.emailAddressChangeHandler = exports.passwordResetHandler = exports.emailVerificationHandler = exports.orderConfirmationHandler = void 0;
|
|
4
4
|
/* tslint:disable:no-non-null-assertion */
|
|
5
5
|
const core_1 = require("@vendure/core");
|
|
6
6
|
const event_listener_1 = require("./event-listener");
|
|
@@ -9,6 +9,7 @@ exports.orderConfirmationHandler = new event_listener_1.EmailEventListener('orde
|
|
|
9
9
|
.on(core_1.OrderStateTransitionEvent)
|
|
10
10
|
.filter(event => event.toState === 'PaymentSettled' && event.fromState !== 'Modifying' && !!event.order.customer)
|
|
11
11
|
.loadData(async ({ event, injector }) => {
|
|
12
|
+
transformOrderLineAssetUrls(event.ctx, event.order, injector);
|
|
12
13
|
const shippingLines = await hydrateShippingLines(event.ctx, event.order, injector);
|
|
13
14
|
return { shippingLines };
|
|
14
15
|
})
|
|
@@ -55,6 +56,34 @@ exports.defaultEmailHandlers = [
|
|
|
55
56
|
exports.passwordResetHandler,
|
|
56
57
|
exports.emailAddressChangeHandler,
|
|
57
58
|
];
|
|
59
|
+
/**
|
|
60
|
+
* @description
|
|
61
|
+
* Applies the configured `AssetStorageStrategy.toAbsoluteUrl()` function to each of the
|
|
62
|
+
* OrderLine's `featuredAsset.preview` properties, so that they can be correctly displayed
|
|
63
|
+
* in the email template.
|
|
64
|
+
* This is required since that step usually happens at the API in middleware, which is not
|
|
65
|
+
* applicable in this context. So we need to do it manually.
|
|
66
|
+
*
|
|
67
|
+
* **Note: Mutates the Order object**
|
|
68
|
+
*/
|
|
69
|
+
function transformOrderLineAssetUrls(ctx, order, injector) {
|
|
70
|
+
const { assetStorageStrategy } = injector.get(core_1.ConfigService).assetOptions;
|
|
71
|
+
if (assetStorageStrategy.toAbsoluteUrl) {
|
|
72
|
+
const toAbsoluteUrl = assetStorageStrategy.toAbsoluteUrl.bind(assetStorageStrategy);
|
|
73
|
+
for (const line of order.lines) {
|
|
74
|
+
if (line.featuredAsset) {
|
|
75
|
+
line.featuredAsset.preview = toAbsoluteUrl(ctx.req, line.featuredAsset.preview);
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
return order;
|
|
80
|
+
}
|
|
81
|
+
exports.transformOrderLineAssetUrls = transformOrderLineAssetUrls;
|
|
82
|
+
/**
|
|
83
|
+
* @description
|
|
84
|
+
* Ensures that the ShippingLines are hydrated so that we can use the
|
|
85
|
+
* `shippingMethod.name` property in the email template.
|
|
86
|
+
*/
|
|
58
87
|
async function hydrateShippingLines(ctx, order, injector) {
|
|
59
88
|
const shippingLines = [];
|
|
60
89
|
const entityHydrator = injector.get(core_1.EntityHydrator);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"default-email-handlers.js","sourceRoot":"","sources":["../../src/default-email-handlers.ts"],"names":[],"mappings":";;;AAAA,0CAA0C;AAC1C,
|
|
1
|
+
{"version":3,"file":"default-email-handlers.js","sourceRoot":"","sources":["../../src/default-email-handlers.ts"],"names":[],"mappings":";;;AAAA,0CAA0C;AAC1C,wCAauB;AAIvB,qDAAsD;AACtD,+CAKuB;AAEV,QAAA,wBAAwB,GAAG,IAAI,mCAAkB,CAAC,oBAAoB,CAAC;KAC/E,EAAE,CAAC,gCAAyB,CAAC;KAC7B,MAAM,CACH,KAAK,CAAC,EAAE,CACJ,KAAK,CAAC,OAAO,KAAK,gBAAgB,IAAI,KAAK,CAAC,SAAS,KAAK,WAAW,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CACtG;KACA,QAAQ,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE;IACpC,2BAA2B,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9D,MAAM,aAAa,GAAG,MAAM,oBAAoB,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnF,OAAO,EAAE,aAAa,EAAE,CAAC;AAC7B,CAAC,CAAC;KACD,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,QAAS,CAAC,YAAY,CAAC;KACzD,OAAO,CAAC,mBAAmB,CAAC;KAC5B,UAAU,CAAC,0CAA0C,CAAC;KACtD,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,aAAa,EAAE,KAAK,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;KAC3F,YAAY,CAAC,2CAA6B,CAAC,CAAC;AAEpC,QAAA,wBAAwB,GAAG,IAAI,mCAAkB,CAAC,oBAAoB,CAAC;KAC/E,EAAE,CAAC,+BAAwB,CAAC;KAC5B,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,6BAA6B,EAAE,CAAC,UAAU,CAAC;KACxE,MAAM,CAAC,KAAK,CAAC,EAAE;IACZ,MAAM,gBAAgB,GAAG,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAC1D,CAAC,CAAC,EAAE,CAAC,CAAC,YAAY,iCAA0B,CACL,CAAC;IAC5C,OAAO,CAAC,gBAAgB,IAAI,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC;AACxE,CAAC,CAAC;KACD,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;KAC5C,OAAO,CAAC,mBAAmB,CAAC;KAC5B,UAAU,CAAC,kCAAkC,CAAC;KAC9C,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACvB,iBAAiB,EAAE,KAAK,CAAC,IAAI,CAAC,6BAA6B,EAAE,CAAC,iBAAiB;CAClF,CAAC,CAAC;KACF,YAAY,CAAC,0CAA4B,CAAC,CAAC;AAEnC,QAAA,oBAAoB,GAAG,IAAI,mCAAkB,CAAC,gBAAgB,CAAC;KACvE,EAAE,CAAC,yBAAkB,CAAC;KACtB,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;KAC5C,OAAO,CAAC,mBAAmB,CAAC;KAC5B,UAAU,CAAC,0BAA0B,CAAC;KACtC,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACvB,kBAAkB,EAAE,KAAK,CAAC,IAAI,CAAC,6BAA6B,EAAE,CAAC,kBAAkB;CACpF,CAAC,CAAC;KACF,YAAY,CAAC,oCAAsB,CAAC,CAAC;AAE7B,QAAA,yBAAyB,GAAG,IAAI,mCAAkB,CAAC,sBAAsB,CAAC;KAClF,EAAE,CAAC,mCAA4B,CAAC;KAChC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,6BAA6B,EAAE,CAAC,iBAAkB,CAAC;KACpF,OAAO,CAAC,mBAAmB,CAAC;KAC5B,UAAU,CAAC,4CAA4C,CAAC;KACxD,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACvB,qBAAqB,EAAE,KAAK,CAAC,IAAI,CAAC,6BAA6B,EAAE,CAAC,qBAAqB;CAC1F,CAAC,CAAC;KACF,YAAY,CAAC,yCAA2B,CAAC,CAAC;AAElC,QAAA,oBAAoB,GAAuC;IACpE,gCAAwB;IACxB,gCAAwB;IACxB,4BAAoB;IACpB,iCAAyB;CAC5B,CAAC;AAEF;;;;;;;;;GASG;AACH,SAAgB,2BAA2B,CAAC,GAAmB,EAAE,KAAY,EAAE,QAAkB;IAC7F,MAAM,EAAE,oBAAoB,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,oBAAa,CAAC,CAAC,YAAY,CAAC;IAC1E,IAAI,oBAAoB,CAAC,aAAa,EAAE;QACpC,MAAM,aAAa,GAAG,oBAAoB,CAAC,aAAa,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACpF,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE;YAC5B,IAAI,IAAI,CAAC,aAAa,EAAE;gBACpB,IAAI,CAAC,aAAa,CAAC,OAAO,GAAG,aAAa,CAAC,GAAG,CAAC,GAAc,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;aAC9F;SACJ;KACJ;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAXD,kEAWC;AAED;;;;GAIG;AACI,KAAK,UAAU,oBAAoB,CACtC,GAAmB,EACnB,KAAY,EACZ,QAAkB;IAElB,MAAM,aAAa,GAAmB,EAAE,CAAC;IACzC,MAAM,cAAc,GAAG,QAAQ,CAAC,GAAG,CAAC,qBAAc,CAAC,CAAC;IAEpD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,aAAa,IAAI,EAAE,EAAE;QAC1C,MAAM,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE;YACpC,SAAS,EAAE,CAAC,gBAAgB,CAAC;SAChC,CAAC,CAAC;QACH,IAAI,IAAI,CAAC,cAAc,EAAE;YACrB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC5B;KACJ;IACD,OAAO,aAAa,CAAC;AACzB,CAAC;AAjBD,oDAiBC"}
|
package/lib/src/mock-events.js
CHANGED
|
@@ -6,6 +6,7 @@ const core_1 = require("@vendure/core");
|
|
|
6
6
|
const shipping_line_entity_1 = require("@vendure/core/dist/entity/shipping-line/shipping-line.entity");
|
|
7
7
|
exports.mockOrderStateTransitionEvent = new core_1.OrderStateTransitionEvent('ArrangingPayment', 'PaymentSettled', {}, new core_1.Order({
|
|
8
8
|
id: '6',
|
|
9
|
+
currencyCode: core_1.CurrencyCode.USD,
|
|
9
10
|
createdAt: '2018-10-31T11:18:29.261Z',
|
|
10
11
|
updatedAt: '2018-10-31T15:24:17.000Z',
|
|
11
12
|
orderPlacedAt: '2018-10-31T13:54:17.000Z',
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"mock-events.js","sourceRoot":"","sources":["../../src/mock-events.ts"],"names":[],"mappings":";;;AAAA,mFAA0E;AAC1E,
|
|
1
|
+
{"version":3,"file":"mock-events.js","sourceRoot":"","sources":["../../src/mock-events.ts"],"names":[],"mappings":";;;AAAA,mFAA0E;AAC1E,wCAauB;AACvB,uGAA4F;AAE/E,QAAA,6BAA6B,GAAG,IAAI,gCAAyB,CACtE,kBAAkB,EAClB,gBAAgB,EAChB,EAAS,EACT,IAAI,YAAK,CAAC;IACN,EAAE,EAAE,GAAG;IACP,YAAY,EAAE,mBAAY,CAAC,GAAG;IAC9B,SAAS,EAAE,0BAA0B;IACrC,SAAS,EAAE,0BAA0B;IACrC,aAAa,EAAE,0BAA0B;IACzC,IAAI,EAAE,kBAAkB;IACxB,KAAK,EAAE,kBAAkB;IACzB,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,IAAI,eAAQ,CAAC;QACnB,EAAE,EAAE,GAAG;QACP,SAAS,EAAE,MAAM;QACjB,QAAQ,EAAE,UAAU;QACpB,YAAY,EAAE,eAAe;KAChC,CAAC;IACF,KAAK,EAAE;QACH,IAAI,gBAAS,CAAC;YACV,EAAE,EAAE,GAAG;YACP,aAAa,EAAE;gBACX,OAAO,EAAE,4BAA4B;aACxC;YACD,cAAc,EAAE,IAAI,qBAAc,CAAC;gBAC/B,EAAE,EAAE,GAAG;gBACP,IAAI,EAAE,uBAAuB;gBAC7B,GAAG,EAAE,SAAS;aACjB,CAAC;YACF,KAAK,EAAE;gBACH,IAAI,gBAAS,CAAC;oBACV,EAAE,EAAE,GAAG;oBACP,SAAS,EAAE,KAAK;oBAChB,oBAAoB,EAAE,IAAI;oBAC1B,WAAW,EAAE;wBACT;4BACI,gBAAgB,EAAE,aAAa;4BAC/B,IAAI,EAAE,qCAAc,CAAC,SAAS;4BAC9B,MAAM,EAAE,CAAC,IAAI;4BACb,WAAW,EAAE,4BAA4B;yBAC5C;qBACJ;oBACD,QAAQ,EAAE,EAAE;iBACf,CAAC;aACL;SACJ,CAAC;QACF,IAAI,gBAAS,CAAC;YACV,EAAE,EAAE,GAAG;YACP,aAAa,EAAE;gBACX,OAAO,EAAE,4BAA4B;aACxC;YACD,cAAc,EAAE,IAAI,qBAAc,CAAC;gBAC/B,EAAE,EAAE,GAAG;gBACP,IAAI,EAAE,gBAAgB;gBACtB,GAAG,EAAE,UAAU;aAClB,CAAC;YACF,KAAK,EAAE;gBACH,IAAI,gBAAS,CAAC;oBACV,EAAE,EAAE,GAAG;oBACP,SAAS,EAAE,IAAI;oBACf,oBAAoB,EAAE,IAAI;oBAC1B,WAAW,EAAE,EAAE;oBACf,QAAQ,EAAE,EAAE;iBACf,CAAC;aACL;SACJ,CAAC;KACL;IACD,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,KAAK;IACtB,QAAQ,EAAE,IAAI;IACd,aAAa,EAAE;QACX,IAAI,mCAAY,CAAC;YACb,SAAS,EAAE,IAAI;YACf,oBAAoB,EAAE,IAAI;YAC1B,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC;YACxD,cAAc,EAAE;gBACZ,IAAI,EAAE,mBAAmB;gBACzB,IAAI,EAAE,kBAAkB;gBACxB,WAAW,EAAE,kBAAkB;gBAC/B,EAAE,EAAE,GAAG;aACV;SACJ,CAAC;KACL;IACD,UAAU,EAAE,EAAE;IACd,eAAe,EAAE;QACb,QAAQ,EAAE,eAAe;QACzB,OAAO,EAAE,EAAE;QACX,WAAW,EAAE,iBAAiB;QAC9B,WAAW,EAAE,EAAE;QACf,IAAI,EAAE,cAAc;QACpB,QAAQ,EAAE,MAAM;QAChB,UAAU,EAAE,UAAU;QACtB,OAAO,EAAE,YAAY;QACrB,WAAW,EAAE,EAAE;KAClB;IACD,QAAQ,EAAE,EAAE;CACf,CAAC,CACL,CAAC;AAEW,QAAA,4BAA4B,GAAG,IAAI,+BAAwB,CACpE,EAAS,EACT,IAAI,WAAI,CAAC;IACL,QAAQ,EAAE,KAAK;IACf,qBAAqB,EAAE;QACnB,IAAI,iCAA0B,CAAC;YAC3B,UAAU,EAAE,eAAe;YAC3B,iBAAiB,EAAE,mDAAmD;SACzE,CAAC;KACL;IACD,UAAU,EAAE,eAAe;CAC9B,CAAC,CACL,CAAC;AAEW,QAAA,sBAAsB,GAAG,IAAI,yBAAkB,CACxD,EAAS,EACT,IAAI,WAAI,CAAC;IACL,UAAU,EAAE,eAAe;IAC3B,qBAAqB,EAAE;QACnB,IAAI,iCAA0B,CAAC;YAC3B,kBAAkB,EAAE,mDAAmD;SAC1E,CAAC;KACL;CACJ,CAAC,CACL,CAAC;AAEW,QAAA,2BAA2B,GAAG,IAAI,mCAA4B,CACvE,EAAS,EACT,IAAI,WAAI,CAAC;IACL,UAAU,EAAE,sBAAsB;IAClC,qBAAqB,EAAE;QACnB,IAAI,iCAA0B,CAAC;YAC3B,iBAAiB,EAAE,sBAAsB;YACzC,qBAAqB,EAAE,mDAAmD;SAC7E,CAAC;KACL;CACJ,CAAC,CACL,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vendure/email-plugin",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.5.2",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"types": "lib/index.d.ts",
|
|
@@ -35,10 +35,10 @@
|
|
|
35
35
|
"@types/fs-extra": "^9.0.1",
|
|
36
36
|
"@types/handlebars": "^4.1.0",
|
|
37
37
|
"@types/mjml": "^4.0.4",
|
|
38
|
-
"@vendure/common": "^1.
|
|
39
|
-
"@vendure/core": "^1.
|
|
38
|
+
"@vendure/common": "^1.5.2",
|
|
39
|
+
"@vendure/core": "^1.5.2",
|
|
40
40
|
"rimraf": "^3.0.2",
|
|
41
41
|
"typescript": "4.3.5"
|
|
42
42
|
},
|
|
43
|
-
"gitHead": "
|
|
43
|
+
"gitHead": "8b72fb60f2c190d42c727eb522941259d8e1a92f"
|
|
44
44
|
}
|
|
@@ -97,7 +97,7 @@
|
|
|
97
97
|
<td>
|
|
98
98
|
<img alt="{{ productVariant.name }}"
|
|
99
99
|
style="width: 50px; height: 50px;"
|
|
100
|
-
src="
|
|
100
|
+
src="{{ featuredAsset.preview }}?w=50&h=50" />
|
|
101
101
|
</td>
|
|
102
102
|
<td>{{ quantity }} x {{ productVariant.name }}</td>
|
|
103
103
|
<td>{{ productVariant.quantity }}</td>
|