@vendure/email-plugin 2.2.6 → 2.3.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/lib/src/handler/event-handler.d.ts +3 -2
- package/lib/src/handler/event-handler.js +11 -2
- package/lib/src/handler/event-handler.js.map +1 -1
- package/lib/src/plugin.d.ts +32 -0
- package/lib/src/plugin.js +37 -1
- package/lib/src/plugin.js.map +1 -1
- package/lib/src/types.d.ts +46 -4
- package/package.json +4 -4
|
@@ -2,7 +2,7 @@ import { LanguageCode } from '@vendure/common/lib/generated-types';
|
|
|
2
2
|
import { Type } from '@vendure/common/lib/shared-types';
|
|
3
3
|
import { Injector } from '@vendure/core';
|
|
4
4
|
import { EmailEventListener } from '../event-listener';
|
|
5
|
-
import { EmailTemplateConfig, EventWithAsyncData, EventWithContext, IntermediateEmailDetails, LoadDataFn, SetAttachmentsFn, SetOptionalAddressFieldsFn, SetTemplateVarsFn } from '../types';
|
|
5
|
+
import { EmailTemplateConfig, EventWithAsyncData, EventWithContext, IntermediateEmailDetails, LoadDataFn, SetAttachmentsFn, SetOptionalAddressFieldsFn, SetSubjectFn, SetTemplateVarsFn } from '../types';
|
|
6
6
|
/**
|
|
7
7
|
* @description
|
|
8
8
|
* The EmailEventHandler defines how the EmailPlugin will respond to a given event.
|
|
@@ -123,6 +123,7 @@ export declare class EmailEventHandler<T extends string = string, Event extends
|
|
|
123
123
|
event: Type<Event>;
|
|
124
124
|
private setRecipientFn;
|
|
125
125
|
private setLanguageCodeFn;
|
|
126
|
+
private setSubjectFn?;
|
|
126
127
|
private setTemplateVarsFn;
|
|
127
128
|
private setAttachmentsFn?;
|
|
128
129
|
private setOptionalAddressFieldsFn?;
|
|
@@ -170,7 +171,7 @@ export declare class EmailEventHandler<T extends string = string, Event extends
|
|
|
170
171
|
* Sets the default subject of the email. The subject string may use Handlebars variables defined by the
|
|
171
172
|
* setTemplateVars() method.
|
|
172
173
|
*/
|
|
173
|
-
setSubject(defaultSubject: string): EmailEventHandler<T, Event>;
|
|
174
|
+
setSubject(defaultSubject: string | SetSubjectFn<Event>): EmailEventHandler<T, Event>;
|
|
174
175
|
/**
|
|
175
176
|
* @description
|
|
176
177
|
* Sets the default from field of the email. The from string may use Handlebars variables defined by the
|
|
@@ -180,7 +180,12 @@ class EmailEventHandler {
|
|
|
180
180
|
* setTemplateVars() method.
|
|
181
181
|
*/
|
|
182
182
|
setSubject(defaultSubject) {
|
|
183
|
-
|
|
183
|
+
if (typeof defaultSubject === 'string') {
|
|
184
|
+
this.defaultSubject = defaultSubject;
|
|
185
|
+
}
|
|
186
|
+
else {
|
|
187
|
+
this.setSubjectFn = defaultSubject;
|
|
188
|
+
}
|
|
184
189
|
return this;
|
|
185
190
|
}
|
|
186
191
|
/**
|
|
@@ -322,7 +327,11 @@ class EmailEventHandler {
|
|
|
322
327
|
const { ctx } = event;
|
|
323
328
|
const languageCode = ((_a = this.setLanguageCodeFn) === null || _a === void 0 ? void 0 : _a.call(this, event)) || ctx.languageCode;
|
|
324
329
|
const configuration = this.getBestConfiguration(ctx.channel.code, languageCode);
|
|
325
|
-
const subject = configuration
|
|
330
|
+
const subject = configuration
|
|
331
|
+
? configuration.subject
|
|
332
|
+
: this.setSubjectFn
|
|
333
|
+
? await this.setSubjectFn(event, ctx, injector)
|
|
334
|
+
: this.defaultSubject;
|
|
326
335
|
if (subject == null) {
|
|
327
336
|
throw new Error(`No subject field has been defined. ` +
|
|
328
337
|
`Remember to call ".setSubject()" when setting up the EmailEventHandler for ${this.type}`);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"event-handler.js","sourceRoot":"","sources":["../../../src/handler/event-handler.ts"],"names":[],"mappings":";;;AAEA,wCAAiD;AAEjD,0DAA2D;AAC3D,4CAAyC;
|
|
1
|
+
{"version":3,"file":"event-handler.js","sourceRoot":"","sources":["../../../src/handler/event-handler.ts"],"names":[],"mappings":";;;AAEA,wCAAiD;AAEjD,0DAA2D;AAC3D,4CAAyC;AAezC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkHG;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
|
@@ -94,6 +94,38 @@ import { EmailPluginDevModeOptions, EmailPluginOptions, InitializedEmailPluginOp
|
|
|
94
94
|
* </mj-table>
|
|
95
95
|
* ```
|
|
96
96
|
*
|
|
97
|
+
* ### Setting global variables using `globalTemplateVars`
|
|
98
|
+
*
|
|
99
|
+
* `globalTemplateVars` is an object that can be passed to the configuration of the Email Plugin with static object variables.
|
|
100
|
+
* You can also pass an async function that will be called with the `RequestContext` and the `Injector` so you can access services
|
|
101
|
+
* and e.g. load channel specific theme configurations.
|
|
102
|
+
*
|
|
103
|
+
* @example
|
|
104
|
+
* ```ts
|
|
105
|
+
* EmailPlugin.init({
|
|
106
|
+
* globalTemplateVars: {
|
|
107
|
+
* primaryColor: '#FF0000',
|
|
108
|
+
* fromAddress: 'no-reply@ourstore.com'
|
|
109
|
+
* }
|
|
110
|
+
* })
|
|
111
|
+
* ```
|
|
112
|
+
* or
|
|
113
|
+
* ```ts
|
|
114
|
+
* EmailPlugin.init({
|
|
115
|
+
* globalTemplateVars: async (ctx, injector) => {
|
|
116
|
+
* const myAsyncService = injector.get(MyAsyncService);
|
|
117
|
+
* const asyncValue = await myAsyncService.get(ctx);
|
|
118
|
+
* const channel = ctx.channel;
|
|
119
|
+
* const { primaryColor } = channel.customFields.theme;
|
|
120
|
+
* const theme = {
|
|
121
|
+
* primaryColor,
|
|
122
|
+
* asyncValue,
|
|
123
|
+
* };
|
|
124
|
+
* return theme;
|
|
125
|
+
* }
|
|
126
|
+
* })
|
|
127
|
+
* ```
|
|
128
|
+
*
|
|
97
129
|
* ### Handlebars helpers
|
|
98
130
|
*
|
|
99
131
|
* The following helper functions are available for use in email templates:
|
package/lib/src/plugin.js
CHANGED
|
@@ -113,6 +113,38 @@ const file_based_template_loader_1 = require("./template-loader/file-based-templ
|
|
|
113
113
|
* </mj-table>
|
|
114
114
|
* ```
|
|
115
115
|
*
|
|
116
|
+
* ### Setting global variables using `globalTemplateVars`
|
|
117
|
+
*
|
|
118
|
+
* `globalTemplateVars` is an object that can be passed to the configuration of the Email Plugin with static object variables.
|
|
119
|
+
* You can also pass an async function that will be called with the `RequestContext` and the `Injector` so you can access services
|
|
120
|
+
* and e.g. load channel specific theme configurations.
|
|
121
|
+
*
|
|
122
|
+
* @example
|
|
123
|
+
* ```ts
|
|
124
|
+
* EmailPlugin.init({
|
|
125
|
+
* globalTemplateVars: {
|
|
126
|
+
* primaryColor: '#FF0000',
|
|
127
|
+
* fromAddress: 'no-reply@ourstore.com'
|
|
128
|
+
* }
|
|
129
|
+
* })
|
|
130
|
+
* ```
|
|
131
|
+
* or
|
|
132
|
+
* ```ts
|
|
133
|
+
* EmailPlugin.init({
|
|
134
|
+
* globalTemplateVars: async (ctx, injector) => {
|
|
135
|
+
* const myAsyncService = injector.get(MyAsyncService);
|
|
136
|
+
* const asyncValue = await myAsyncService.get(ctx);
|
|
137
|
+
* const channel = ctx.channel;
|
|
138
|
+
* const { primaryColor } = channel.customFields.theme;
|
|
139
|
+
* const theme = {
|
|
140
|
+
* primaryColor,
|
|
141
|
+
* asyncValue,
|
|
142
|
+
* };
|
|
143
|
+
* return theme;
|
|
144
|
+
* }
|
|
145
|
+
* })
|
|
146
|
+
* ```
|
|
147
|
+
*
|
|
116
148
|
* ### Handlebars helpers
|
|
117
149
|
*
|
|
118
150
|
* The following helper functions are available for use in email templates:
|
|
@@ -351,7 +383,11 @@ let EmailPlugin = EmailPlugin_1 = class EmailPlugin {
|
|
|
351
383
|
const { type } = handler;
|
|
352
384
|
try {
|
|
353
385
|
const injector = new core_2.Injector(this.moduleRef);
|
|
354
|
-
|
|
386
|
+
let globalTemplateVars = this.options.globalTemplateVars;
|
|
387
|
+
if (typeof globalTemplateVars === 'function') {
|
|
388
|
+
globalTemplateVars = await globalTemplateVars(event.ctx, injector);
|
|
389
|
+
}
|
|
390
|
+
const result = await handler.handle(event, globalTemplateVars, injector);
|
|
355
391
|
if (!result) {
|
|
356
392
|
return;
|
|
357
393
|
}
|
package/lib/src/plugin.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/plugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAMwB;AACxB,uCAAyC;AACzC,wCAWuB;AAEvB,qCAAsE;AACtE,2CAA8D;AAC9D,+CAA2C;AAC3C,uDAAmD;AAEnD,6FAAuF;AASvF
|
|
1
|
+
{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/plugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAMwB;AACxB,uCAAyC;AACzC,wCAWuB;AAEvB,qCAAsE;AACtE,2CAA8D;AAC9D,+CAA2C;AAC3C,uDAAmD;AAEnD,6FAAuF;AASvF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2QG;AAMI,IAAM,WAAW,mBAAjB,MAAM,WAAW;IAMpB,gBAAgB;IAChB,YACY,QAAkB,EAClB,SAAoB,EACpB,cAA8B,EAC9B,eAAgC,EAChC,cAA8B,EACA,OAAsC;QALpE,aAAQ,GAAR,QAAQ,CAAU;QAClB,cAAS,GAAT,SAAS,CAAW;QACpB,mBAAc,GAAd,cAAc,CAAgB;QAC9B,oBAAe,GAAf,eAAe,CAAiB;QAChC,mBAAc,GAAd,cAAc,CAAgB;QACA,YAAO,GAAP,OAAO,CAA+B;IAC7E,CAAC;IAEJ;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,OAAuD;QAC/D,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YACzB,4EAA4E;YAC5E,aAAM,CAAC,IAAI,CAAC,iCAAiC,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,CAAC;QAC7F,CAAC;aAAM,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;YACzD,6EAA6E;YAC7E,kGAAkG;YAClG,OAAO,CAAC,cAAc,GAAG,IAAI,oDAAuB,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAC/E,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAC;QAChG,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,OAAwC,CAAC;QACxD,OAAO,aAAW,CAAC;IACvB,CAAC;IAED,gBAAgB;IAChB,KAAK,CAAC,sBAAsB;QACxB,MAAM,IAAI,CAAC,wBAAwB,EAAE,CAAC;QACtC,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACnC,MAAM,SAAS,GAAG,MAAM,IAAA,iCAAwB,EAAC,IAAI,CAAC,OAAO,EAAE,IAAI,eAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QAC7F,IAAI,CAAC,IAAA,yBAAgB,EAAC,IAAI,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAClE,uEAAuE;YACvE,oDAAoD;YACpD,IAAI,CAAC,gBAAgB,GAAG,IAAI,gCAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxF,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC;QACvC,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;YACjC,IAAI,CAAC,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC;gBACnD,IAAI,EAAE,YAAY;gBAClB,OAAO,EAAE,GAAG,CAAC,EAAE;oBACX,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACjD,CAAC;aACJ,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAED,KAAK,CAAC,qBAAqB;QACvB,MAAM,IAAI,CAAC,2BAA2B,EAAE,CAAC;IAC7C,CAAC;IAED,SAAS,CAAC,QAA4B;QAClC,IAAI,IAAA,yBAAgB,EAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;YACjE,aAAM,CAAC,IAAI,CAAC,iCAAiC,EAAE,qBAAS,CAAC,CAAC;YAC1D,IAAI,CAAC,UAAU,GAAG,IAAI,wBAAU,EAAE,CAAC;YACnC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAClF,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;YACtF,IAAA,mCAA4B,EAAC,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACpE,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,wBAAwB;;QAClC,MAAM,QAAQ,GAAG,IAAI,eAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,OAAO,CAAA,MAAA,IAAI,CAAC,OAAO,CAAC,cAAc,0CAAE,IAAI,CAAA,KAAK,UAAU,EAAE,CAAC;YAC1D,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrD,CAAC;QACD,IAAI,OAAO,CAAA,MAAA,IAAI,CAAC,OAAO,CAAC,WAAW,0CAAE,IAAI,CAAA,KAAK,UAAU,EAAE,CAAC;YACvD,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClD,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,2BAA2B;;QACrC,IAAI,OAAO,CAAA,MAAA,IAAI,CAAC,OAAO,CAAC,cAAc,0CAAE,OAAO,CAAA,KAAK,UAAU,EAAE,CAAC;YAC7D,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;QAChD,CAAC;QACD,IAAI,OAAO,CAAA,MAAA,IAAI,CAAC,OAAO,CAAC,WAAW,0CAAE,OAAO,CAAA,KAAK,UAAU,EAAE,CAAC;YAC1D,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;QAC7C,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,qBAAqB;QAC/B,KAAK,MAAM,OAAO,IAAI,aAAW,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YACjD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;gBAClD,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,WAAW,CACrB,OAAgE,EAChE,KAAuB;QAEvB,aAAM,CAAC,KAAK,CAAC,mBAAmB,OAAO,CAAC,IAAI,GAAG,EAAE,qBAAS,CAAC,CAAC;QAC5D,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;QACzB,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,IAAI,eAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC9C,IAAI,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACzD,IAAI,OAAO,kBAAkB,KAAK,UAAU,EAAE,CAAC;gBAC3C,kBAAkB,GAAG,MAAM,kBAAkB,CAAC,KAAK,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YACvE,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,MAAM,CAC/B,KAAY,EACZ,kBAA4C,EAC5C,QAAQ,CACX,CAAC;YACF,IAAI,CAAC,MAAM,EAAE,CAAC;gBACV,OAAO;YACX,CAAC;YACD,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAChB,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;YACpD,CAAC;iBAAM,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBAC/B,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAChD,CAAC;QACL,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACd,aAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,qBAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;QAChD,CAAC;IACL,CAAC;CACJ,CAAA;AA7HY,kCAAW;sBAAX,WAAW;IALvB,IAAA,oBAAa,EAAC;QACX,OAAO,EAAE,CAAC,yBAAkB,CAAC;QAC7B,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,gCAAoB,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,gCAAc,CAAC;QACrG,aAAa,EAAE,QAAQ;KAC1B,CAAC;IAcO,WAAA,IAAA,eAAM,EAAC,gCAAoB,CAAC,CAAA;qCALX,eAAQ;QACP,gBAAS;QACJ,gCAAc;QACb,sBAAe;QAChB,qBAAc;GAZjC,WAAW,CA6HvB"}
|
package/lib/src/types.d.ts
CHANGED
|
@@ -4,8 +4,8 @@ import { Injector, RequestContext, SerializedRequestContext, VendureEvent } from
|
|
|
4
4
|
import { Attachment } from 'nodemailer/lib/mailer';
|
|
5
5
|
import SESTransport from 'nodemailer/lib/ses-transport';
|
|
6
6
|
import SMTPTransport from 'nodemailer/lib/smtp-transport';
|
|
7
|
-
import { EmailEventHandler } from './handler/event-handler';
|
|
8
7
|
import { EmailGenerator } from './generator/email-generator';
|
|
8
|
+
import { EmailEventHandler } from './handler/event-handler';
|
|
9
9
|
import { EmailSender } from './sender/email-sender';
|
|
10
10
|
import { TemplateLoader } from './template-loader/template-loader';
|
|
11
11
|
/**
|
|
@@ -31,12 +31,46 @@ export type EventWithContext = VendureEvent & {
|
|
|
31
31
|
export type EventWithAsyncData<Event extends EventWithContext, R> = Event & {
|
|
32
32
|
data: R;
|
|
33
33
|
};
|
|
34
|
+
/**
|
|
35
|
+
* @description
|
|
36
|
+
* Allows you to dynamically load the "globalTemplateVars" key async and access Vendure services
|
|
37
|
+
* to create the object. This is not a requirement. You can also specify a simple static object if your
|
|
38
|
+
* projects doesn't need to access async or dynamic values.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
*
|
|
43
|
+
* EmailPlugin.init({
|
|
44
|
+
* globalTemplateVars: async (ctx, injector) => {
|
|
45
|
+
* const myAsyncService = injector.get(MyAsyncService);
|
|
46
|
+
* const asyncValue = await myAsyncService.get(ctx);
|
|
47
|
+
* const channel = ctx.channel;
|
|
48
|
+
* const { primaryColor } = channel.customFields.theme;
|
|
49
|
+
* const theme = {
|
|
50
|
+
* primaryColor,
|
|
51
|
+
* asyncValue,
|
|
52
|
+
* };
|
|
53
|
+
* return theme;
|
|
54
|
+
* }
|
|
55
|
+
* [...]
|
|
56
|
+
* })
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @docsCategory core plugins/EmailPlugin
|
|
61
|
+
* @docsPage EmailPluginOptions
|
|
62
|
+
* @since 2.3.0
|
|
63
|
+
*/
|
|
64
|
+
export type GlobalTemplateVarsFn = (ctx: RequestContext, injector: Injector) => Promise<{
|
|
65
|
+
[key: string]: any;
|
|
66
|
+
}>;
|
|
34
67
|
/**
|
|
35
68
|
* @description
|
|
36
69
|
* Configuration for the EmailPlugin.
|
|
37
70
|
*
|
|
38
71
|
* @docsCategory core plugins/EmailPlugin
|
|
39
72
|
* @docsPage EmailPluginOptions
|
|
73
|
+
* @docsWeight 0
|
|
40
74
|
* */
|
|
41
75
|
export interface EmailPluginOptions {
|
|
42
76
|
/**
|
|
@@ -70,11 +104,12 @@ export interface EmailPluginOptions {
|
|
|
70
104
|
* @description
|
|
71
105
|
* An object containing variables which are made available to all templates. For example,
|
|
72
106
|
* the storefront URL could be defined here and then used in the "email address verification"
|
|
73
|
-
* email.
|
|
107
|
+
* email. Use the GlobalTemplateVarsFn if you need to retrieve variables from Vendure or
|
|
108
|
+
* plugin services.
|
|
74
109
|
*/
|
|
75
110
|
globalTemplateVars?: {
|
|
76
111
|
[key: string]: any;
|
|
77
|
-
};
|
|
112
|
+
} | GlobalTemplateVarsFn;
|
|
78
113
|
/**
|
|
79
114
|
* @description
|
|
80
115
|
* An optional allowed EmailSender, used to allow custom implementations of the send functionality
|
|
@@ -93,7 +128,7 @@ export interface EmailPluginOptions {
|
|
|
93
128
|
emailGenerator?: EmailGenerator;
|
|
94
129
|
}
|
|
95
130
|
/**
|
|
96
|
-
* EmailPLuginOptions type after initialization, where templateLoader
|
|
131
|
+
* EmailPLuginOptions type after initialization, where templateLoader and themeInjector are no longer optional
|
|
97
132
|
*/
|
|
98
133
|
export type InitializedEmailPluginOptions = EmailPluginOptions & {
|
|
99
134
|
templateLoader: TemplateLoader;
|
|
@@ -362,6 +397,13 @@ export type SetTemplateVarsFn<Event> = (event: Event, globals: {
|
|
|
362
397
|
* @docsPage Email Plugin Types
|
|
363
398
|
*/
|
|
364
399
|
export type SetAttachmentsFn<Event> = (event: Event) => EmailAttachment[] | Promise<EmailAttachment[]>;
|
|
400
|
+
/**
|
|
401
|
+
* @description
|
|
402
|
+
* A function used to define the subject to be sent with the email.
|
|
403
|
+
* @docsCategory core plugins/EmailPlugin
|
|
404
|
+
* @docsPage Email Plugin Types
|
|
405
|
+
*/
|
|
406
|
+
export type SetSubjectFn<Event> = (event: Event, ctx: RequestContext, injector: Injector) => string | Promise<string>;
|
|
365
407
|
/**
|
|
366
408
|
* @description
|
|
367
409
|
* Optional address-related fields for sending the email.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vendure/email-plugin",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.3.0",
|
|
4
4
|
"license": "MIT",
|
|
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": "^2.
|
|
38
|
-
"@vendure/core": "^2.
|
|
37
|
+
"@vendure/common": "^2.3.0",
|
|
38
|
+
"@vendure/core": "^2.3.0",
|
|
39
39
|
"rimraf": "^5.0.5",
|
|
40
40
|
"typescript": "5.3.3"
|
|
41
41
|
},
|
|
42
|
-
"gitHead": "
|
|
42
|
+
"gitHead": "41727f7f099582981422a174e165d79a9f21ff1e"
|
|
43
43
|
}
|