@vendure/email-plugin 3.0.0 → 3.0.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/LICENSE.md
CHANGED
|
@@ -31,6 +31,7 @@ Commercial Distributions - must be used in accordance with the terms and conditi
|
|
|
31
31
|
contained in a separate written agreement between you and Vendure GmbH.
|
|
32
32
|
For more information about the Vendure Commercial License (VCL) please contact contact@vendure.io.
|
|
33
33
|
|
|
34
|
-
Please see also
|
|
35
|
-
|
|
36
|
-
[
|
|
34
|
+
Please see also:
|
|
35
|
+
|
|
36
|
+
- [Licensing FAQ - license-faq.md](license/license-faq.md)
|
|
37
|
+
- [GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 - gpl-3.0.txt](license/gpl-3.0.txt)
|
|
@@ -109,7 +109,6 @@ import { EmailTemplateConfig, EventWithAsyncData, EventWithContext, Intermediate
|
|
|
109
109
|
* plugins: [
|
|
110
110
|
* EmailPlugin.init({
|
|
111
111
|
* handler: [...defaultEmailHandlers, quoteRequestedHandler],
|
|
112
|
-
* templatePath: path.join(__dirname, 'vendure/email/templates'),
|
|
113
112
|
* // ... etc
|
|
114
113
|
* }),
|
|
115
114
|
* ],
|
|
@@ -110,7 +110,6 @@ const constants_1 = require("../constants");
|
|
|
110
110
|
* plugins: [
|
|
111
111
|
* EmailPlugin.init({
|
|
112
112
|
* handler: [...defaultEmailHandlers, quoteRequestedHandler],
|
|
113
|
-
* templatePath: path.join(__dirname, 'vendure/email/templates'),
|
|
114
113
|
* // ... etc
|
|
115
114
|
* }),
|
|
116
115
|
* ],
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"event-handler.js","sourceRoot":"","sources":["../../../src/handler/event-handler.ts"],"names":[],"mappings":";;;AAEA,wCAAiD;AAEjD,0DAA2D;AAC3D,4CAAyC;AAezC
|
|
1
|
+
{"version":3,"file":"event-handler.js","sourceRoot":"","sources":["../../../src/handler/event-handler.ts"],"names":[],"mappings":";;;AAEA,wCAAiD;AAEjD,0DAA2D;AAC3D,4CAAyC;AAezC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiHG;AACH,MAAa,iBAAiB;IAiB1B,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,cAA4C;QACnD,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YACrC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACzC,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,YAAY,GAAG,cAAc,CAAC;QACvC,CAAC;QACD,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;YACzB,CAAC,CAAC,aAAa,CAAC,OAAO;YACvB,CAAC,CAAC,IAAI,CAAC,YAAY;gBACjB,CAAC,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,CAAC;gBAC/C,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC;QAC5B,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;AAvTD,8CAuTC;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/lib/src/plugin.d.ts
CHANGED
|
@@ -30,14 +30,14 @@ import { EmailPluginDevModeOptions, EmailPluginOptions, InitializedEmailPluginOp
|
|
|
30
30
|
*
|
|
31
31
|
* @example
|
|
32
32
|
* ```ts
|
|
33
|
-
* import { defaultEmailHandlers, EmailPlugin } from '\@vendure/email-plugin';
|
|
33
|
+
* import { defaultEmailHandlers, EmailPlugin, FileBasedTemplateLoader } from '\@vendure/email-plugin';
|
|
34
34
|
*
|
|
35
35
|
* const config: VendureConfig = {
|
|
36
36
|
* // Add an instance of the plugin to the plugins array
|
|
37
37
|
* plugins: [
|
|
38
38
|
* EmailPlugin.init({
|
|
39
39
|
* handler: defaultEmailHandlers,
|
|
40
|
-
*
|
|
40
|
+
* templateLoader: new FileBasedTemplateLoader(path.join(__dirname, '../static/email/templates')),
|
|
41
41
|
* transport: {
|
|
42
42
|
* type: 'smtp',
|
|
43
43
|
* host: 'smtp.example.com',
|
|
@@ -196,13 +196,13 @@ import { EmailPluginDevModeOptions, EmailPluginOptions, InitializedEmailPluginOp
|
|
|
196
196
|
*
|
|
197
197
|
* @example
|
|
198
198
|
* ```ts
|
|
199
|
-
* import { defaultEmailHandlers, EmailPlugin } from '\@vendure/email-plugin';
|
|
199
|
+
* import { defaultEmailHandlers, EmailPlugin, FileBasedTemplateLoader } from '\@vendure/email-plugin';
|
|
200
200
|
* import { MyTransportService } from './transport.services.ts';
|
|
201
201
|
* const config: VendureConfig = {
|
|
202
202
|
* plugins: [
|
|
203
203
|
* EmailPlugin.init({
|
|
204
204
|
* handler: defaultEmailHandlers,
|
|
205
|
-
*
|
|
205
|
+
* templateLoader: new FileBasedTemplateLoader(path.join(__dirname, '../static/email/templates')),
|
|
206
206
|
* transport: (injector, ctx) => {
|
|
207
207
|
* if (ctx) {
|
|
208
208
|
* return injector.get(MyTransportService).getSettings(ctx);
|
|
@@ -230,7 +230,7 @@ import { EmailPluginDevModeOptions, EmailPluginOptions, InitializedEmailPluginOp
|
|
|
230
230
|
* devMode: true,
|
|
231
231
|
* route: 'mailbox',
|
|
232
232
|
* handler: defaultEmailHandlers,
|
|
233
|
-
*
|
|
233
|
+
* templateLoader: new FileBasedTemplateLoader(path.join(__dirname, '../static/email/templates')),
|
|
234
234
|
* outputPath: path.join(__dirname, 'test-emails'),
|
|
235
235
|
* })
|
|
236
236
|
* ```
|
package/lib/src/plugin.js
CHANGED
|
@@ -49,14 +49,14 @@ const file_based_template_loader_1 = require("./template-loader/file-based-templ
|
|
|
49
49
|
*
|
|
50
50
|
* @example
|
|
51
51
|
* ```ts
|
|
52
|
-
* import { defaultEmailHandlers, EmailPlugin } from '\@vendure/email-plugin';
|
|
52
|
+
* import { defaultEmailHandlers, EmailPlugin, FileBasedTemplateLoader } from '\@vendure/email-plugin';
|
|
53
53
|
*
|
|
54
54
|
* const config: VendureConfig = {
|
|
55
55
|
* // Add an instance of the plugin to the plugins array
|
|
56
56
|
* plugins: [
|
|
57
57
|
* EmailPlugin.init({
|
|
58
58
|
* handler: defaultEmailHandlers,
|
|
59
|
-
*
|
|
59
|
+
* templateLoader: new FileBasedTemplateLoader(path.join(__dirname, '../static/email/templates')),
|
|
60
60
|
* transport: {
|
|
61
61
|
* type: 'smtp',
|
|
62
62
|
* host: 'smtp.example.com',
|
|
@@ -215,13 +215,13 @@ const file_based_template_loader_1 = require("./template-loader/file-based-templ
|
|
|
215
215
|
*
|
|
216
216
|
* @example
|
|
217
217
|
* ```ts
|
|
218
|
-
* import { defaultEmailHandlers, EmailPlugin } from '\@vendure/email-plugin';
|
|
218
|
+
* import { defaultEmailHandlers, EmailPlugin, FileBasedTemplateLoader } from '\@vendure/email-plugin';
|
|
219
219
|
* import { MyTransportService } from './transport.services.ts';
|
|
220
220
|
* const config: VendureConfig = {
|
|
221
221
|
* plugins: [
|
|
222
222
|
* EmailPlugin.init({
|
|
223
223
|
* handler: defaultEmailHandlers,
|
|
224
|
-
*
|
|
224
|
+
* templateLoader: new FileBasedTemplateLoader(path.join(__dirname, '../static/email/templates')),
|
|
225
225
|
* transport: (injector, ctx) => {
|
|
226
226
|
* if (ctx) {
|
|
227
227
|
* return injector.get(MyTransportService).getSettings(ctx);
|
|
@@ -249,7 +249,7 @@ const file_based_template_loader_1 = require("./template-loader/file-based-templ
|
|
|
249
249
|
* devMode: true,
|
|
250
250
|
* route: 'mailbox',
|
|
251
251
|
* handler: defaultEmailHandlers,
|
|
252
|
-
*
|
|
252
|
+
* templateLoader: new FileBasedTemplateLoader(path.join(__dirname, '../static/email/templates')),
|
|
253
253
|
* outputPath: path.join(__dirname, 'test-emails'),
|
|
254
254
|
* })
|
|
255
255
|
* ```
|
package/lib/src/types.d.ts
CHANGED
|
@@ -203,7 +203,7 @@ export interface SMTPTransportOptions extends SMTPTransport.Options {
|
|
|
203
203
|
* plugins: [
|
|
204
204
|
* EmailPlugin.init({
|
|
205
205
|
* handler: defaultEmailHandlers,
|
|
206
|
-
*
|
|
206
|
+
* templateLoader: new FileBasedTemplateLoader(path.join(__dirname, '../static/email/templates')),
|
|
207
207
|
* transport: {
|
|
208
208
|
* type: 'ses',
|
|
209
209
|
* SES: { ses, aws: { SendRawEmailCommand } },
|
|
@@ -365,9 +365,30 @@ export interface EmailTemplateConfig {
|
|
|
365
365
|
*/
|
|
366
366
|
subject: string;
|
|
367
367
|
}
|
|
368
|
+
/**
|
|
369
|
+
* @description
|
|
370
|
+
* The object passed to the {@link TemplateLoader} `loadTemplate()` method.
|
|
371
|
+
*
|
|
372
|
+
* @docsCategory core plugins/EmailPlugin
|
|
373
|
+
* @docsPage Email Plugin Types
|
|
374
|
+
*/
|
|
368
375
|
export interface LoadTemplateInput {
|
|
376
|
+
/**
|
|
377
|
+
* @description
|
|
378
|
+
* The type corresponds to the string passed to the EmailEventListener constructor.
|
|
379
|
+
*/
|
|
369
380
|
type: string;
|
|
381
|
+
/**
|
|
382
|
+
* @description
|
|
383
|
+
* The template name is specified by the EmailEventHander's call to
|
|
384
|
+
* the `addTemplate()` method, and will default to `body.hbs`
|
|
385
|
+
*/
|
|
370
386
|
templateName: string;
|
|
387
|
+
/**
|
|
388
|
+
* @description
|
|
389
|
+
* The variables defined by the globalTemplateVars as well as any variables defined in the
|
|
390
|
+
* EmailEventHandler's `setTemplateVars()` method.
|
|
391
|
+
*/
|
|
371
392
|
templateVars: any;
|
|
372
393
|
}
|
|
373
394
|
export interface Partial {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vendure/email-plugin",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.2",
|
|
4
4
|
"license": "GPL-3.0-or-later",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"types": "lib/index.d.ts",
|
|
@@ -34,10 +34,10 @@
|
|
|
34
34
|
"@types/express": "^4.17.21",
|
|
35
35
|
"@types/fs-extra": "^11.0.4",
|
|
36
36
|
"@types/mjml": "^4.7.4",
|
|
37
|
-
"@vendure/common": "^3.0.
|
|
38
|
-
"@vendure/core": "^3.0.
|
|
37
|
+
"@vendure/common": "^3.0.2",
|
|
38
|
+
"@vendure/core": "^3.0.2",
|
|
39
39
|
"rimraf": "^5.0.5",
|
|
40
40
|
"typescript": "5.3.3"
|
|
41
41
|
},
|
|
42
|
-
"gitHead": "
|
|
42
|
+
"gitHead": "589d54de0acc76bba717aff66ee64638e4106dbb"
|
|
43
43
|
}
|