@vendure/email-plugin 2.2.3 → 2.2.5
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.
|
@@ -16,6 +16,7 @@ import { EmailTemplateConfig, EventWithAsyncData, EventWithContext, Intermediate
|
|
|
16
16
|
* .on(OrderStateTransitionEvent)
|
|
17
17
|
* .filter(event => event.toState === 'PaymentSettled')
|
|
18
18
|
* .setRecipient(event => event.order.customer.emailAddress)
|
|
19
|
+
* .setFrom('{{ fromAddress }}')
|
|
19
20
|
* .setSubject(`Order confirmation for #{{ order.code }}`)
|
|
20
21
|
* .setTemplateVars(event => ({ order: event.order }));
|
|
21
22
|
* ```
|
|
@@ -64,13 +65,16 @@ import { EmailTemplateConfig, EventWithAsyncData, EventWithContext, Intermediate
|
|
|
64
65
|
* .on(QuoteRequestedEvent)
|
|
65
66
|
* .setRecipient(event => event.customer.emailAddress)
|
|
66
67
|
* .setSubject(`Here's the quote you requested`)
|
|
68
|
+
* .setFrom('{{ fromAddress }}')
|
|
67
69
|
* .setTemplateVars(event => ({ details: event.details }));
|
|
68
70
|
* ```
|
|
69
71
|
*
|
|
70
72
|
* ### 2. Create the email template
|
|
71
73
|
*
|
|
72
|
-
* Next you need to make sure there is a template defined at `<app root>/static/email/templates/quote-requested/body.hbs`. The
|
|
73
|
-
*
|
|
74
|
+
* Next you need to make sure there is a template defined at `<app root>/static/email/templates/quote-requested/body.hbs`. The path
|
|
75
|
+
* segment `quote-requested` must match the string passed to the `EmailEventListener` constructor.
|
|
76
|
+
*
|
|
77
|
+
* The template would look something like this:
|
|
74
78
|
*
|
|
75
79
|
* ```handlebars
|
|
76
80
|
* {{> header title="Here's the quote you requested" }}
|
|
@@ -236,7 +240,8 @@ export declare class EmailEventHandler<T extends string = string, Event extends
|
|
|
236
240
|
* .setTemplateVars(event => ({
|
|
237
241
|
* order: event.order,
|
|
238
242
|
* payments: event.data,
|
|
239
|
-
* }))
|
|
243
|
+
* }))
|
|
244
|
+
* // ...
|
|
240
245
|
* ```
|
|
241
246
|
*/
|
|
242
247
|
loadData<R>(loadDataFn: LoadDataFn<Event, R>): EmailEventHandlerWithAsyncData<R, T, Event, EventWithAsyncData<Event, R>>;
|
|
@@ -17,6 +17,7 @@ const constants_1 = require("../constants");
|
|
|
17
17
|
* .on(OrderStateTransitionEvent)
|
|
18
18
|
* .filter(event => event.toState === 'PaymentSettled')
|
|
19
19
|
* .setRecipient(event => event.order.customer.emailAddress)
|
|
20
|
+
* .setFrom('{{ fromAddress }}')
|
|
20
21
|
* .setSubject(`Order confirmation for #{{ order.code }}`)
|
|
21
22
|
* .setTemplateVars(event => ({ order: event.order }));
|
|
22
23
|
* ```
|
|
@@ -65,13 +66,16 @@ const constants_1 = require("../constants");
|
|
|
65
66
|
* .on(QuoteRequestedEvent)
|
|
66
67
|
* .setRecipient(event => event.customer.emailAddress)
|
|
67
68
|
* .setSubject(`Here's the quote you requested`)
|
|
69
|
+
* .setFrom('{{ fromAddress }}')
|
|
68
70
|
* .setTemplateVars(event => ({ details: event.details }));
|
|
69
71
|
* ```
|
|
70
72
|
*
|
|
71
73
|
* ### 2. Create the email template
|
|
72
74
|
*
|
|
73
|
-
* Next you need to make sure there is a template defined at `<app root>/static/email/templates/quote-requested/body.hbs`. The
|
|
74
|
-
*
|
|
75
|
+
* Next you need to make sure there is a template defined at `<app root>/static/email/templates/quote-requested/body.hbs`. The path
|
|
76
|
+
* segment `quote-requested` must match the string passed to the `EmailEventListener` constructor.
|
|
77
|
+
*
|
|
78
|
+
* The template would look something like this:
|
|
75
79
|
*
|
|
76
80
|
* ```handlebars
|
|
77
81
|
* {{> header title="Here's the quote you requested" }}
|
|
@@ -260,7 +264,8 @@ class EmailEventHandler {
|
|
|
260
264
|
* .setTemplateVars(event => ({
|
|
261
265
|
* order: event.order,
|
|
262
266
|
* payments: event.data,
|
|
263
|
-
* }))
|
|
267
|
+
* }))
|
|
268
|
+
* // ...
|
|
264
269
|
* ```
|
|
265
270
|
*/
|
|
266
271
|
loadData(loadDataFn) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"event-handler.js","sourceRoot":"","sources":["../../../src/handler/event-handler.ts"],"names":[],"mappings":";;;AAEA,wCAAiD;AAEjD,0DAA2D;AAC3D,4CAAyC;AAczC
|
|
1
|
+
{"version":3,"file":"event-handler.js","sourceRoot":"","sources":["../../../src/handler/event-handler.ts"],"names":[],"mappings":";;;AAEA,wCAAiD;AAEjD,0DAA2D;AAC3D,4CAAyC;AAczC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkHG;AACH,MAAa,iBAAiB;IAgB1B,YACW,QAA+B,EAC/B,KAAkB;QADlB,aAAQ,GAAR,QAAQ,CAAuB;QAC/B,UAAK,GAAL,KAAK,CAAa;QAZrB,cAAS,GAAqC,EAAE,CAAC;QACjD,mBAAc,GAA0B,EAAE,CAAC;IAYhD,CAAC;IAEJ,gBAAgB;IAChB,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC9B,CAAC;IAED,gBAAgB;IAChB,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAmC;QACtC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CAAC,cAAwC;QACjD,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,eAAe,CACX,iBAA6D;QAE7D,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,cAAwC;QACpD,IAAI,CAAC,iBAAiB,GAAG,cAAc,CAAC;QACxC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,cAAsB;QAC7B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,IAAY;QAChB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,wBAAwB,CAAC,uBAA0D;QAC/E,IAAI,CAAC,0BAA0B,GAAG,uBAAuB,CAAC;QAC1D,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,cAAc,CAAC,gBAAyC;QACpD,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,MAA2B;QACnC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,CACJ,UAAgC;QAEhC,MAAM,YAAY,GAAG,IAAI,8BAA8B,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/F,YAAY,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAClD,YAAY,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACxD,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACtD,YAAY,CAAC,0BAA0B,GAAG,IAAI,CAAC,0BAA0B,CAAC;QAC1E,YAAY,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACxC,YAAY,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAClD,YAAY,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAClD,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAC9B,YAAY,CAAC,UAAU,GAAG,IAAI,CAAC,UAAiB,CAAC;QACjD,OAAO,YAAY,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACR,KAAY,EACZ,UAAkC,EAAE,EACpC,QAAkB;;QAElB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACnB,OAAO;YACX,CAAC;QACL,CAAC;QACD,IAAI,IAAI,YAAY,8BAA8B,EAAE,CAAC;YACjD,IAAI,CAAC;gBACA,KAAwC,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;oBACpE,KAAK;oBACL,QAAQ;iBACX,CAAC,CAAC;YACP,CAAC;YAAC,OAAO,GAAY,EAAE,CAAC;gBACpB,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;oBACvB,aAAM,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,qBAAS,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;gBACpD,CAAC;qBAAM,CAAC;oBACJ,aAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,qBAAS,CAAC,CAAC;gBACzC,CAAC;gBACD,OAAO;YACX,CAAC;QACL,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CACX,sCAAsC;gBAClC,gFAAgF,IAAI,CAAC,IAAI,EAAE,CAClG,CAAC;QACN,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACX,kCAAkC;gBAC9B,2EAA2E,IAAI,CAAC,IAAI,EAAE,CAC7F,CAAC;QACN,CAAC;QACD,MAAM,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;QACtB,MAAM,YAAY,GAAG,CAAA,MAAA,IAAI,CAAC,iBAAiB,qDAAG,KAAK,CAAC,KAAI,GAAG,CAAC,YAAY,CAAC;QACzE,MAAM,aAAa,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QAChF,MAAM,OAAO,GAAG,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC;QAC5E,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CACX,qCAAqC;gBACjC,8EAA8E,IAAI,CAAC,IAAI,EAAE,CAChG,CAAC;QACN,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC7C,MAAM,YAAY,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1F,IAAI,gBAAgB,GAAsB,EAAE,CAAC;QAC7C,IAAI,CAAC;YACD,gBAAgB,GAAG,MAAA,CAAC,MAAM,CAAA,MAAA,IAAI,CAAC,gBAAgB,qDAAG,KAAK,CAAC,CAAA,CAAC,mCAAI,EAAE,CAAC;QACpE,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACd,aAAM,CAAC,KAAK,CAAC,CAAC,EAAE,qBAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;QACxC,CAAC;QACD,MAAM,WAAW,GAAG,MAAM,IAAA,uCAAoB,EAAC,gBAAgB,CAAC,CAAC;QACjE,MAAM,qBAAqB,GAAG,MAAA,CAAC,MAAM,CAAA,MAAA,IAAI,CAAC,0BAA0B,qDAAG,KAAK,CAAC,CAAA,CAAC,mCAAI,EAAE,CAAC;QACrF,uBACI,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,EAC1B,IAAI,EAAE,IAAI,CAAC,IAAI,EACf,SAAS,EACT,IAAI,EAAE,IAAI,CAAC,IAAI,EACf,YAAY,kCAAO,OAAO,GAAK,YAAY,GAC3C,OAAO,EACP,YAAY,EAAE,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,UAAU,EACrE,WAAW,IACR,qBAAqB,EAC1B;IACN,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,KAAkC;QAC3C,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,OAAO,IAAI,CAAC;IAChB,CAAC;IAEO,oBAAoB,CACxB,WAAmB,EACnB,YAA0B;QAE1B,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACnC,OAAO;QACX,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;YAC5C,OAAO,CACH,CAAC,CAAC,CAAC,WAAW,KAAK,WAAW,IAAI,CAAC,CAAC,WAAW,KAAK,SAAS,CAAC;gBAC9D,CAAC,CAAC,YAAY,KAAK,YAAY,CAClC,CAAC;QACN,CAAC,CAAC,CAAC;QACH,IAAI,UAAU,EAAE,CAAC;YACb,OAAO,UAAU,CAAC;QACtB,CAAC;QACD,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CACzC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,KAAK,WAAW,IAAI,CAAC,CAAC,YAAY,KAAK,SAAS,CACrE,CAAC;QACF,IAAI,YAAY,EAAE,CAAC;YACf,OAAO,YAAY,CAAC;QACxB,CAAC;QACD,OAAO;IACX,CAAC;CACJ;AA9SD,8CA8SC;AAED;;;;;;GAMG;AACH,MAAa,8BAKX,SAAQ,iBAA2B;IACjC,YACW,WAAyC,EAChD,QAA+B,EAC/B,KAAuB;QAEvB,KAAK,CAAC,QAAQ,EAAE,KAAY,CAAC,CAAC;QAJvB,gBAAW,GAAX,WAAW,CAA8B;IAKpD,CAAC;CACJ;AAbD,wEAaC"}
|
package/package.json
CHANGED
|
@@ -1,43 +1,42 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@vendure/email-plugin",
|
|
3
|
-
"version": "2.2.
|
|
4
|
-
"license": "MIT",
|
|
5
|
-
"main": "lib/index.js",
|
|
6
|
-
"types": "lib/index.d.ts",
|
|
7
|
-
"files": [
|
|
8
|
-
"lib/**/*",
|
|
9
|
-
"templates/**/*",
|
|
10
|
-
"dev-mailbox.html"
|
|
11
|
-
],
|
|
12
|
-
"scripts": {
|
|
13
|
-
"watch": "tsc -p ./tsconfig.build.json --watch",
|
|
14
|
-
"build": "rimraf lib && tsc -p ./tsconfig.build.json",
|
|
15
|
-
"lint": "eslint --fix .",
|
|
16
|
-
"test": "vitest --config vitest.config.mts --run"
|
|
17
|
-
},
|
|
18
|
-
"homepage": "https://www.vendure.io/",
|
|
19
|
-
"funding": "https://github.com/sponsors/michaelbromley",
|
|
20
|
-
"publishConfig": {
|
|
21
|
-
"access": "public"
|
|
22
|
-
},
|
|
23
|
-
"dependencies": {
|
|
24
|
-
"@types/nodemailer": "^6.4.9",
|
|
25
|
-
"dateformat": "^3.0.3",
|
|
26
|
-
"express": "^4.18.2",
|
|
27
|
-
"fs-extra": "^11.2.0",
|
|
28
|
-
"handlebars": "^4.7.8",
|
|
29
|
-
"mjml": "^4.14.1",
|
|
30
|
-
"nodemailer": "^6.9.4"
|
|
31
|
-
},
|
|
32
|
-
"devDependencies": {
|
|
33
|
-
"@types/dateformat": "^3.0.1",
|
|
34
|
-
"@types/express": "^4.17.21",
|
|
35
|
-
"@types/fs-extra": "^11.0.4",
|
|
36
|
-
"@types/mjml": "^4.7.4",
|
|
37
|
-
"@vendure/common": "^2.2.
|
|
38
|
-
"@vendure/core": "^2.2.
|
|
39
|
-
"rimraf": "^5.0.5",
|
|
40
|
-
"typescript": "5.3.3"
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@vendure/email-plugin",
|
|
3
|
+
"version": "2.2.5",
|
|
4
|
+
"license": "MIT",
|
|
5
|
+
"main": "lib/index.js",
|
|
6
|
+
"types": "lib/index.d.ts",
|
|
7
|
+
"files": [
|
|
8
|
+
"lib/**/*",
|
|
9
|
+
"templates/**/*",
|
|
10
|
+
"dev-mailbox.html"
|
|
11
|
+
],
|
|
12
|
+
"scripts": {
|
|
13
|
+
"watch": "tsc -p ./tsconfig.build.json --watch",
|
|
14
|
+
"build": "rimraf lib && tsc -p ./tsconfig.build.json",
|
|
15
|
+
"lint": "eslint --fix .",
|
|
16
|
+
"test": "vitest --config vitest.config.mts --run"
|
|
17
|
+
},
|
|
18
|
+
"homepage": "https://www.vendure.io/",
|
|
19
|
+
"funding": "https://github.com/sponsors/michaelbromley",
|
|
20
|
+
"publishConfig": {
|
|
21
|
+
"access": "public"
|
|
22
|
+
},
|
|
23
|
+
"dependencies": {
|
|
24
|
+
"@types/nodemailer": "^6.4.9",
|
|
25
|
+
"dateformat": "^3.0.3",
|
|
26
|
+
"express": "^4.18.2",
|
|
27
|
+
"fs-extra": "^11.2.0",
|
|
28
|
+
"handlebars": "^4.7.8",
|
|
29
|
+
"mjml": "^4.14.1",
|
|
30
|
+
"nodemailer": "^6.9.4"
|
|
31
|
+
},
|
|
32
|
+
"devDependencies": {
|
|
33
|
+
"@types/dateformat": "^3.0.1",
|
|
34
|
+
"@types/express": "^4.17.21",
|
|
35
|
+
"@types/fs-extra": "^11.0.4",
|
|
36
|
+
"@types/mjml": "^4.7.4",
|
|
37
|
+
"@vendure/common": "^2.2.5",
|
|
38
|
+
"@vendure/core": "^2.2.5",
|
|
39
|
+
"rimraf": "^5.0.5",
|
|
40
|
+
"typescript": "5.3.3"
|
|
41
|
+
}
|
|
42
|
+
}
|
package/LICENSE
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
The MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2018 Michael Bromley
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
6
|
-
|
|
7
|
-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
8
|
-
|
|
9
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|