@vendure/email-plugin 3.8.1-master-202610200212 → 3.8.1-master-202610230212
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/common.d.ts +10 -0
- package/lib/src/common.js +20 -0
- package/lib/src/common.js.map +1 -1
- package/lib/src/plugin.d.ts +4 -0
- package/lib/src/plugin.js +8 -0
- package/lib/src/plugin.js.map +1 -1
- package/package.json +3 -3
package/lib/src/common.d.ts
CHANGED
|
@@ -1,4 +1,14 @@
|
|
|
1
1
|
import { Injector, RequestContext } from '@vendure/core';
|
|
2
2
|
import { EmailPluginDevModeOptions, EmailPluginOptions, EmailTransportOptions } from './types';
|
|
3
3
|
export declare function isDevModeOptions(input: EmailPluginOptions | EmailPluginDevModeOptions): input is EmailPluginDevModeOptions;
|
|
4
|
+
/**
|
|
5
|
+
* @description
|
|
6
|
+
* Returns a warning message when `devMode` is enabled and `NODE_ENV` is `production`.
|
|
7
|
+
* Returns `undefined` otherwise.
|
|
8
|
+
*
|
|
9
|
+
* In dev mode the plugin mounts the dev mailbox, which has no authentication. It lists and serves
|
|
10
|
+
* every generated email, and its `/generate/:type/:languageCode` endpoint generates emails from mock
|
|
11
|
+
* events. Dev mode also uses the file transport, so no email is sent.
|
|
12
|
+
*/
|
|
13
|
+
export declare function getDevModeProductionWarning(pluginOptions: EmailPluginOptions | EmailPluginDevModeOptions): string | undefined;
|
|
4
14
|
export declare function resolveTransportSettings(options: EmailPluginOptions, injector: Injector, ctx?: RequestContext): Promise<EmailTransportOptions>;
|
package/lib/src/common.js
CHANGED
|
@@ -1,10 +1,30 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.isDevModeOptions = isDevModeOptions;
|
|
4
|
+
exports.getDevModeProductionWarning = getDevModeProductionWarning;
|
|
4
5
|
exports.resolveTransportSettings = resolveTransportSettings;
|
|
5
6
|
function isDevModeOptions(input) {
|
|
6
7
|
return input.devMode === true;
|
|
7
8
|
}
|
|
9
|
+
/**
|
|
10
|
+
* @description
|
|
11
|
+
* Returns a warning message when `devMode` is enabled and `NODE_ENV` is `production`.
|
|
12
|
+
* Returns `undefined` otherwise.
|
|
13
|
+
*
|
|
14
|
+
* In dev mode the plugin mounts the dev mailbox, which has no authentication. It lists and serves
|
|
15
|
+
* every generated email, and its `/generate/:type/:languageCode` endpoint generates emails from mock
|
|
16
|
+
* events. Dev mode also uses the file transport, so no email is sent.
|
|
17
|
+
*/
|
|
18
|
+
function getDevModeProductionWarning(pluginOptions) {
|
|
19
|
+
if (!isDevModeOptions(pluginOptions) || process.env.NODE_ENV !== 'production') {
|
|
20
|
+
return undefined;
|
|
21
|
+
}
|
|
22
|
+
return (`devMode is enabled while NODE_ENV is "production". The dev mailbox at route "${pluginOptions.route}" ` +
|
|
23
|
+
'has no authentication. It lists and serves every generated email, and its ' +
|
|
24
|
+
'`/generate/:type/:languageCode` endpoint generates emails from mock events. ' +
|
|
25
|
+
`Emails are written to "${pluginOptions.outputPath}" and are not sent. ` +
|
|
26
|
+
'Remove `devMode` and configure a `transport` for production.');
|
|
27
|
+
}
|
|
8
28
|
async function resolveTransportSettings(options, injector, ctx) {
|
|
9
29
|
if (typeof options.transport === 'function') {
|
|
10
30
|
return options.transport(injector, ctx);
|
package/lib/src/common.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/common.ts"],"names":[],"mappings":";;AAIA,4CAIC;AAED,4DAUC;
|
|
1
|
+
{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/common.ts"],"names":[],"mappings":";;AAIA,4CAIC;AAWD,kEAaC;AAED,4DAUC;AAxCD,SAAgB,gBAAgB,CAC5B,KAAqD;IAErD,OAAQ,KAAmC,CAAC,OAAO,KAAK,IAAI,CAAC;AACjE,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,2BAA2B,CACvC,aAA6D;IAE7D,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,EAAE,CAAC;QAC5E,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,OAAO,CACH,gFAAgF,aAAa,CAAC,KAAK,IAAI;QACvG,4EAA4E;QAC5E,8EAA8E;QAC9E,0BAA0B,aAAa,CAAC,UAAU,sBAAsB;QACxE,8DAA8D,CACjE,CAAC;AACN,CAAC;AAEM,KAAK,UAAU,wBAAwB,CAC1C,OAA2B,EAC3B,QAAkB,EAClB,GAAoB;IAEpB,IAAI,OAAO,OAAO,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;QAC1C,OAAO,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IAC5C,CAAC;SAAM,CAAC;QACJ,OAAO,OAAO,CAAC,SAAS,CAAC;IAC7B,CAAC;AACL,CAAC"}
|
package/lib/src/plugin.d.ts
CHANGED
|
@@ -240,6 +240,10 @@ import { EmailPluginDevModeOptions, EmailPluginOptions, InitializedEmailPluginOp
|
|
|
240
240
|
* In dev mode, a webmail-like interface available at the `/mailbox` path, e.g.
|
|
241
241
|
* http://localhost:3000/mailbox. This is a simple way to view the output of all emails generated by the EmailPlugin while in dev mode.
|
|
242
242
|
*
|
|
243
|
+
* The dev mailbox has no authentication, and no emails are sent in dev mode, so only enable `devMode`
|
|
244
|
+
* in local development. The plugin logs a warning at startup if `devMode` is enabled while
|
|
245
|
+
* `NODE_ENV` is `production`.
|
|
246
|
+
*
|
|
243
247
|
* ## Troubleshooting SMTP Connections
|
|
244
248
|
*
|
|
245
249
|
* If you are having trouble sending email over and SMTP connection, set the `logging` and `debug` options to `true`. This will
|
package/lib/src/plugin.js
CHANGED
|
@@ -259,6 +259,10 @@ const file_based_template_loader_1 = require("./template-loader/file-based-templ
|
|
|
259
259
|
* In dev mode, a webmail-like interface available at the `/mailbox` path, e.g.
|
|
260
260
|
* http://localhost:3000/mailbox. This is a simple way to view the output of all emails generated by the EmailPlugin while in dev mode.
|
|
261
261
|
*
|
|
262
|
+
* The dev mailbox has no authentication, and no emails are sent in dev mode, so only enable `devMode`
|
|
263
|
+
* in local development. The plugin logs a warning at startup if `devMode` is enabled while
|
|
264
|
+
* `NODE_ENV` is `production`.
|
|
265
|
+
*
|
|
262
266
|
* ## Troubleshooting SMTP Connections
|
|
263
267
|
*
|
|
264
268
|
* If you are having trouble sending email over and SMTP connection, set the `logging` and `debug` options to `true`. This will
|
|
@@ -345,6 +349,10 @@ let EmailPlugin = EmailPlugin_1 = class EmailPlugin {
|
|
|
345
349
|
}
|
|
346
350
|
configure(consumer) {
|
|
347
351
|
if ((0, common_2.isDevModeOptions)(this.options) && this.processContext.isServer) {
|
|
352
|
+
const productionWarning = (0, common_2.getDevModeProductionWarning)(this.options);
|
|
353
|
+
if (productionWarning) {
|
|
354
|
+
core_2.Logger.warn(productionWarning, constants_1.loggerCtx);
|
|
355
|
+
}
|
|
348
356
|
core_2.Logger.info('Creating dev mailbox middleware', constants_1.loggerCtx);
|
|
349
357
|
this.devMailbox = new dev_mailbox_1.DevMailbox();
|
|
350
358
|
consumer.apply(this.devMailbox.serve(this.options)).forRoutes(this.options.route);
|
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,
|
|
1
|
+
{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/plugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAMwB;AACxB,uCAAyC;AACzC,wCAWuB;AAEvB,qCAAmG;AACnG,2CAA8D;AAC9D,+CAA2C;AAC3C,uDAAmD;AAEnD,6FAAuF;AASvF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+QG;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,MAAM,iBAAiB,GAAG,IAAA,oCAA2B,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACpE,IAAI,iBAAiB,EAAE,CAAC;gBACpB,aAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE,qBAAS,CAAC,CAAC;YAC9C,CAAC;YACD,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,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;AAhIY,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,CAgIvB"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vendure/email-plugin",
|
|
3
|
-
"version": "3.8.1-master-
|
|
3
|
+
"version": "3.8.1-master-202610230212",
|
|
4
4
|
"license": "GPL-3.0-or-later",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"types": "lib/index.d.ts",
|
|
@@ -39,8 +39,8 @@
|
|
|
39
39
|
"@types/express": "^5.0.1",
|
|
40
40
|
"@types/fs-extra": "^11.0.4",
|
|
41
41
|
"@types/mjml": "^5.0.0",
|
|
42
|
-
"@vendure/common": "^3.8.1-master-
|
|
43
|
-
"@vendure/core": "^3.8.1-master-
|
|
42
|
+
"@vendure/common": "^3.8.1-master-202610230212",
|
|
43
|
+
"@vendure/core": "^3.8.1-master-202610230212",
|
|
44
44
|
"rimraf": "^5.0.5",
|
|
45
45
|
"typescript": "5.8.2"
|
|
46
46
|
}
|