@deenruv/email-plugin 1.0.0

package/lib/src/sender/nodemailer-email-sender.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodemailer-email-sender.js","sourceRoot":"","sources":["../../../src/sender/nodemailer-email-sender.ts"],"names":[],"mappings":";;;;;;AAAA,2EAAuE;AACvE,mEAA+D;AAC/D,wCAAuC;AACvC,wDAA0B;AAC1B,2CAA6C;AAG7C,gDAAwB;AAExB,+BAA8B;AAE9B,4CAAyC;AAoBzC;;;;;;GAMG;AACH,MAAa,qBAAqB;IAKhC,KAAK,CAAC,IAAI,CAAC,KAAmB,EAAE,OAA8B;QAC5D,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,MAAM;gBACT,OAAO;gBACP,MAAM;YACR,KAAK,MAAM;gBACT,MAAM,QAAQ,GAAG,IAAA,kCAAe,EAC9B,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,OAAO,EAAE,EACjE,GAAG,CACJ,CAAC;gBACF,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;gBACzD,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;oBAChB,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;gBAC1C,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;gBAC3C,CAAC;gBACD,MAAM;YACR,KAAK,UAAU;gBACb,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC/D,MAAM;YACR,KAAK,KAAK;gBACR,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC1D,MAAM;YACR,KAAK,MAAM;gBACT,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;gBAC3D,MAAM;YACR,KAAK,SAAS;gBACZ,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACtB,MAAM;YACR;gBACE,OAAO,IAAA,0BAAW,EAAC,OAAO,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAEO,gBAAgB,CAAC,OAA6B;QACpD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,OAAe,CAAC,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;YACxE,IAAI,CAAC,cAAc,GAAG,IAAA,4BAAe,EAAC,OAAO,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAEO,eAAe,CAAC,OAA4B;QAClD,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACxB,IAAI,CAAC,aAAa,GAAG,IAAA,4BAAe,EAAC,OAAO,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEO,oBAAoB,CAAC,OAAiC;QAC5D,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,IAAI,CAAC,kBAAkB,GAAG,IAAA,4BAAe,kBAAG,QAAQ,EAAE,IAAI,IAAK,OAAO,EAAG,CAAC;QAC5E,CAAC;QACD,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACjC,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,KAAmB,EAAE,WAAiB;QAC3D,OAAO,WAAW,CAAC,QAAQ,CAAC;YAC1B,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,EAAE,EAAE,KAAK,CAAC,SAAS;YACnB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,GAAG,EAAE,KAAK,CAAC,GAAG;YACd,OAAO,EAAE,KAAK,CAAC,OAAO;SACvB,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,KAAmB,EAAE,cAAsB;QACpE,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE;YACjC,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,GAAG,EAAE,KAAK,CAAC,GAAG;YACd,OAAO,EAAE,KAAK,CAAC,OAAO;SACvB,CAAC;QACF,MAAM,kBAAE,CAAC,SAAS,CAChB,cAAc,GAAG,OAAO,EACxB,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAChC,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,KAAmB,EAAE,cAAsB;QACnE,MAAM,WAAW,GAAG,IAAA,4BAAe,EAAC;YAClC,eAAe,EAAE,IAAI;YACrB,MAAM,EAAE,IAAI;SACb,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QACvD,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,GAAG,MAAM,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAC7B,QAAgB,EAChB,IAAyB;QAEzB,MAAM,WAAW,GAAG,kBAAE,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACnD,OAAO,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC7C,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;gBAC1B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAC/B,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACjD,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAClC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACK,YAAY;QAClB,SAAS,WAAW,CAAC,IAAmC;YACtD,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC;YACvC,OAAO,IAAA,aAAM,EAAC,OAAO,EAAE,GAAG,MAAM,CAAC,CAAC;QACpC,CAAC;QACD,OAAO;YACL,KAAK,CAAC,KAAkB;gBACtB,UAAU;YACZ,CAAC;YACD,KAAK,CAAC,GAAG,MAAW;gBAClB,aAAM,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,qBAAS,CAAC,CAAC;YAC/C,CAAC;YACD,KAAK,CAAC,GAAG,MAAW;gBAClB,aAAM,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,qBAAS,CAAC,CAAC;YACjD,CAAC;YACD,IAAI,CAAC,GAAG,MAAW;gBACjB,aAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,qBAAS,CAAC,CAAC;YAC9C,CAAC;YACD,IAAI,CAAC,GAAG,MAAW;gBACjB,aAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,qBAAS,CAAC,CAAC;YAC9C,CAAC;YACD,KAAK,CAAC,GAAG,MAAW;gBAClB,aAAM,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,qBAAS,CAAC,CAAC;YAC/C,CAAC;YACD,KAAK,CAAC,GAAG,MAAW;gBAClB,aAAM,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,qBAAS,CAAC,CAAC;YAC/C,CAAC;SACF,CAAC;IACJ,CAAC;CACF;AAnJD,sDAmJC"}

package/lib/src/template-loader/file-based-template-loader.d.ts

@@ -0,0 +1,17 @@
+import { Injector, RequestContext } from "@deenruv/core";
+import { LoadTemplateInput, Partial } from "../types";
+import { TemplateLoader } from "./template-loader";
+/**
+ * @description
+ * Loads email templates from the local file system. This is the default
+ * loader used by the EmailPlugin.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage TemplateLoader
+ */
+export declare class FileBasedTemplateLoader implements TemplateLoader {
+    private templatePath;
+    constructor(templatePath: string);
+    loadTemplate(_injector: Injector, _ctx: RequestContext, { type, templateName }: LoadTemplateInput): Promise<string>;
+    loadPartials(): Promise<Partial[]>;
+}

package/lib/src/template-loader/file-based-template-loader.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileBasedTemplateLoader = void 0;
+const promises_1 = __importDefault(require("fs/promises"));
+const path_1 = __importDefault(require("path"));
+/**
+ * @description
+ * Loads email templates from the local file system. This is the default
+ * loader used by the EmailPlugin.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage TemplateLoader
+ */
+class FileBasedTemplateLoader {
+    constructor(templatePath) {
+        this.templatePath = templatePath;
+    }
+    async loadTemplate(_injector, _ctx, { type, templateName }) {
+        const templatePath = path_1.default.join(this.templatePath, type, templateName);
+        return promises_1.default.readFile(templatePath, "utf-8");
+    }
+    async loadPartials() {
+        const partialsPath = path_1.default.join(this.templatePath, "partials");
+        const partialsFiles = await promises_1.default.readdir(partialsPath);
+        return Promise.all(partialsFiles.map(async (file) => {
+            return {
+                name: path_1.default.basename(file, ".hbs"),
+                content: await promises_1.default.readFile(path_1.default.join(partialsPath, file), "utf-8"),
+            };
+        }));
+    }
+}
+exports.FileBasedTemplateLoader = FileBasedTemplateLoader;
+//# sourceMappingURL=file-based-template-loader.js.map

package/lib/src/template-loader/file-based-template-loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-based-template-loader.js","sourceRoot":"","sources":["../../../src/template-loader/file-based-template-loader.ts"],"names":[],"mappings":";;;;;;AACA,2DAA6B;AAC7B,gDAAwB;AAMxB;;;;;;;GAOG;AACH,MAAa,uBAAuB;IAClC,YAAoB,YAAoB;QAApB,iBAAY,GAAZ,YAAY,CAAQ;IAAG,CAAC;IAE5C,KAAK,CAAC,YAAY,CAChB,SAAmB,EACnB,IAAoB,EACpB,EAAE,IAAI,EAAE,YAAY,EAAqB;QAEzC,MAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;QACtE,OAAO,kBAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,MAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QAC9D,MAAM,aAAa,GAAG,MAAM,kBAAE,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACrD,OAAO,OAAO,CAAC,GAAG,CAChB,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YAC/B,OAAO;gBACL,IAAI,EAAE,cAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBACjC,OAAO,EAAE,MAAM,kBAAE,CAAC,QAAQ,CAAC,cAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC;aACnE,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;CACF;AAxBD,0DAwBC"}

package/lib/src/template-loader/react-email-template-loader.d.ts

@@ -0,0 +1,6 @@
+import { Injector, RequestContext } from "@deenruv/core";
+import { TemplateLoader } from "./template-loader.js";
+import { LoadTemplateInput } from "../types.js";
+export declare class ReactComponentLoader implements TemplateLoader {
+    loadTemplate(_1: Injector, ctx: RequestContext, { type }: LoadTemplateInput): Promise<string>;
+}

package/lib/src/template-loader/react-email-template-loader.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReactComponentLoader = void 0;
+class ReactComponentLoader {
+    async loadTemplate(_1, ctx, { type }) {
+        const template = {
+            type,
+            ctx: ctx.serialize(),
+        };
+        return JSON.stringify(template);
+    }
+}
+exports.ReactComponentLoader = ReactComponentLoader;
+//# sourceMappingURL=react-email-template-loader.js.map

package/lib/src/template-loader/react-email-template-loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"react-email-template-loader.js","sourceRoot":"","sources":["../../../src/template-loader/react-email-template-loader.ts"],"names":[],"mappings":";;;AAKA,MAAa,oBAAoB;IAC/B,KAAK,CAAC,YAAY,CAChB,EAAY,EACZ,GAAmB,EACnB,EAAE,IAAI,EAAqB;QAE3B,MAAM,QAAQ,GAAe;YAC3B,IAAI;YACJ,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE;SACrB,CAAC;QACF,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;CACF;AAZD,oDAYC"}

package/lib/src/template-loader/template-loader.d.ts

@@ -0,0 +1,42 @@
+import { Injector, RequestContext } from "@deenruv/core";
+import { LoadTemplateInput, Partial } from "../types";
+/**
+ * @description
+ * Loads email templates based on the given request context, type and template name
+ * and return the template as a string.
+ *
+ * @example
+ * ```ts
+ * import { EmailPlugin, TemplateLoader } from '\@deenruv/email-plugin';
+ *
+ * class MyTemplateLoader implements TemplateLoader {
+ *      loadTemplate(injector, ctx, { type, templateName }){
+ *          return myCustomTemplateFunction(ctx);
+ *      }
+ * }
+ *
+ * // In deenruv-config.ts:
+ * ...
+ * EmailPlugin.init({
+ *     templateLoader: new MyTemplateLoader()
+ *     ...
+ * })
+ * ```
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage TemplateLoader
+ * @docsWeight 0
+ */
+export interface TemplateLoader {
+    /**
+     * @description
+     * Load template and return it's content as a string
+     */
+    loadTemplate(injector: Injector, ctx: RequestContext, input: LoadTemplateInput): Promise<string>;
+    /**
+     * @description
+     * Load partials and return their contents.
+     * This method is only called during initialization, i.e. during server startup.
+     */
+    loadPartials?(): Promise<Partial[]>;
+}

package/lib/src/template-loader/template-loader.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=template-loader.js.map

package/lib/src/template-loader/template-loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-loader.js","sourceRoot":"","sources":["../../../src/template-loader/template-loader.ts"],"names":[],"mappings":""}

package/lib/src/types.d.ts

@@ -0,0 +1,453 @@
+import { LanguageCode } from "@deenruv/common/lib/generated-types";
+import { Omit } from "@deenruv/common/lib/omit";
+import { Injector, RequestContext, SerializedRequestContext, DeenruvEvent } from "@deenruv/core";
+import { Attachment } from "nodemailer/lib/mailer";
+import SESTransport from "nodemailer/lib/ses-transport";
+import SMTPTransport from "nodemailer/lib/smtp-transport";
+import { EmailGenerator } from "./generator/email-generator";
+import { EmailEventHandler } from "./handler/event-handler";
+import { EmailSender } from "./sender/email-sender";
+import { TemplateLoader } from "./template-loader/template-loader";
+import type { FC } from "react";
+/**
+ * @description
+ * A DeenruvEvent which also includes a `ctx` property containing the current
+ * {@link RequestContext}, which is used to determine the channel and language
+ * to use when generating the email.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Email Plugin Types
+ */
+export type EventWithContext = DeenruvEvent & {
+    ctx: RequestContext;
+};
+/**
+ * @description
+ * A DeenruvEvent with a {@link RequestContext} and a `data` property which contains the
+ * value resolved from the {@link EmailEventHandler}`.loadData()` callback.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Email Plugin Types
+ */
+export type EventWithAsyncData<Event extends EventWithContext, R> = Event & {
+    data: R;
+};
+/**
+ * @description
+ * Allows you to dynamically load the "globalTemplateVars" key async and access Deenruv services
+ * to create the object. This is not a requirement. You can also specify a simple static object if your
+ * projects doesn't need to access async or dynamic values.
+ *
+ * @example
+ * ```ts
+ *
+ * EmailPlugin.init({
+ *    globalTemplateVars: async (ctx, injector) => {
+ *          const myAsyncService = injector.get(MyAsyncService);
+ *          const asyncValue = await myAsyncService.get(ctx);
+ *          const channel = ctx.channel;
+ *          const { primaryColor } = channel.customFields.theme;
+ *          const theme = {
+ *              primaryColor,
+ *              asyncValue,
+ *          };
+ *          return theme;
+ *      }
+ *   [...]
+ * })
+ *
+ * ```
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage EmailPluginOptions
+ * @since 2.3.0
+ */
+export type GlobalTemplateVarsFn = (ctx: RequestContext, injector: Injector) => Promise<{
+    [key: string]: any;
+}>;
+/**
+ * @description
+ * Configuration for the EmailPlugin.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage EmailPluginOptions
+ * @docsWeight 0
+ * */
+export interface EmailPluginOptions {
+    /**
+     * @description
+     * Boolean flag to indicate whether the email templates are written in react-email, and should be handled by it .
+     */
+    useReactEmail?: boolean;
+    /**
+     * @description
+     * The path to the location of the email templates. In a default Deenruv installation,
+     * the templates are installed to `<project root>/deenruv/email/templates`.
+     *
+     * @deprecated Use `templateLoader` to define a template path: `templateLoader: new FileBasedTemplateLoader('../your-path/templates')`
+     */
+    templatePath?: string;
+    /**
+     * @description
+     * An optional TemplateLoader which can be used to load templates from a custom location or async service.
+     * The default uses the FileBasedTemplateLoader which loads templates from `<project root>/deenruv/email/templates`
+     *
+     * @since 2.0.0
+     */
+    templateLoader?: TemplateLoader;
+    /**
+     * @description
+     * Configures how the emails are sent.
+     */
+    transport: EmailTransportOptions | ((injector?: Injector, ctx?: RequestContext) => EmailTransportOptions | Promise<EmailTransportOptions>);
+    /**
+     * @description
+     * An array of {@link EmailEventHandler}s which define which Deenruv events will trigger
+     * emails, and how those emails are generated.
+     */
+    handlers: Array<EmailEventHandler<string, any>>;
+    /**
+     * @description
+     * An object containing variables which are made available to all templates. For example,
+     * the storefront URL could be defined here and then used in the "email address verification"
+     * email. Use the GlobalTemplateVarsFn if you need to retrieve variables from Deenruv or
+     * plugin services.
+     */
+    globalTemplateVars?: {
+        [key: string]: any;
+    } | GlobalTemplateVarsFn;
+    /**
+     * @description
+     * An optional allowed EmailSender, used to allow custom implementations of the send functionality
+     * while still utilizing the existing emailPlugin functionality.
+     *
+     * @default NodemailerEmailSender
+     */
+    emailSender?: EmailSender;
+    /**
+     * @description
+     * An optional allowed EmailGenerator, used to allow custom email generation functionality to
+     * better match with custom email sending functionality.
+     *
+     * @default HandlebarsMjmlGenerator
+     */
+    emailGenerator?: EmailGenerator;
+}
+/**
+ * EmailPLuginOptions type after initialization, where templateLoader and themeInjector are no longer optional
+ */
+export type InitializedEmailPluginOptions = EmailPluginOptions & {
+    templateLoader: TemplateLoader;
+};
+/**
+ * @description
+ * Configuration for running the EmailPlugin in development mode.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage EmailPluginOptions
+ */
+export interface EmailPluginDevModeOptions extends Omit<EmailPluginOptions, "transport"> {
+    devMode: true;
+    /**
+     * @description
+     * The path to which html email files will be saved rather than being sent.
+     */
+    outputPath: string;
+    /**
+     * @description
+     * The route to the dev mailbox server.
+     */
+    route: string;
+}
+/**
+ * @description
+ * A union of all the possible transport options for sending emails.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Transport Options
+ */
+export type EmailTransportOptions = SMTPTransportOptions | SendmailTransportOptions | FileTransportOptions | NoopTransportOptions | SESTransportOptions | TestingTransportOptions;
+/**
+ * @description
+ * The SMTP transport options of [Nodemailer](https://nodemailer.com/smtp/)
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Transport Options
+ */
+export interface SMTPTransportOptions extends SMTPTransport.Options {
+    type: "smtp";
+    /**
+     * @description
+     * If true, uses the configured {@link DeenruvLogger} to log messages from Nodemailer as it interacts with
+     * the SMTP server.
+     *
+     * @default false
+     */
+    logging?: boolean;
+}
+/**
+ * @description
+ * The SES transport options of [Nodemailer](https://nodemailer.com/transports/ses//)
+ *
+ * See [Nodemailers's SES docs](https://nodemailer.com/transports/ses/) for more details
+ *
+ * @example
+ * ```ts
+ *  import { SES, SendRawEmailCommand } from '\@aws-sdk/client-ses'
+ *
+ *  const ses = new SES({
+ *     apiVersion: '2010-12-01',
+ *     region: 'eu-central-1',
+ *     credentials: {
+ *         accessKeyId: process.env.SES_ACCESS_KEY || '',
+ *         secretAccessKey: process.env.SES_SECRET_KEY || '',
+ *     },
+ *  })
+ *
+ *  const config: DeenruvConfig = {
+ *   // Add an instance of the plugin to the plugins array
+ *   plugins: [
+ *     EmailPlugin.init({
+ *       handler: defaultEmailHandlers,
+ *       templatePath: path.join(__dirname, 'static/email/templates'),
+ *       transport: {
+ *         type: 'ses',
+ *         SES: { ses, aws: { SendRawEmailCommand } },
+ *         sendingRate: 10, // optional messages per second sending rate
+ *       },
+ *     }),
+ *   ],
+ * };
+ *  ```
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Transport Options
+ */
+export interface SESTransportOptions extends SESTransport.Options {
+    type: "ses";
+}
+/**
+ * @description
+ * Uses the local Sendmail program to send the email.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Transport Options
+ */
+export interface SendmailTransportOptions {
+    type: "sendmail";
+    /** path to the sendmail command (defaults to ‘sendmail’) */
+    path?: string;
+    /** either ‘windows’ or ‘unix’ (default). Forces all newlines in the output to either use Windows syntax <CR><LF> or Unix syntax <LF> */
+    newline?: string;
+}
+/**
+ * @description
+ * Outputs the email as an HTML file for development purposes.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Transport Options
+ */
+export interface FileTransportOptions {
+    type: "file";
+    /** The directory in which the emails will be saved */
+    outputPath: string;
+    /** When set to true, a raw text file will be output rather than an HTML file */
+    raw?: boolean;
+}
+/**
+ * @description
+ * Does nothing with the generated email. Intended for use in testing where we don't care about the email transport,
+ * or when using a custom {@link EmailSender} which does not require transport options.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Transport Options
+ */
+export interface NoopTransportOptions {
+    type: "none";
+}
+/**
+ * @description
+ * The final, generated email details to be sent.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Email Plugin Types
+ */
+export interface EmailDetails<Type extends "serialized" | "unserialized" = "unserialized"> {
+    from: string;
+    recipient: string;
+    subject: string;
+    body: string;
+    attachments: Array<Type extends "serialized" ? SerializedAttachment : Attachment>;
+    cc?: string;
+    bcc?: string;
+    replyTo?: string;
+}
+/**
+ * @description
+ * Forwards the raw GeneratedEmailContext object to a provided callback, for use in testing.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Transport Options
+ */
+export interface TestingTransportOptions {
+    type: "testing";
+    /**
+     * @description
+     * Callback to be invoked when an email would be sent.
+     */
+    onSend: (details: EmailDetails) => void;
+}
+/**
+ * @description
+ * A function used to load async data for use by an {@link EmailEventHandler}.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Email Plugin Types
+ */
+export type LoadDataFn<Event extends EventWithContext, R> = (context: {
+    event: Event;
+    injector: Injector;
+}) => Promise<R>;
+export type OptionalToNullable<O> = {
+    [K in keyof O]-?: undefined extends O[K] ? NonNullable<O[K]> | null : O[K];
+};
+/**
+ * @description
+ * An object defining a file attachment for an email. Based on the object described
+ * [here in the Nodemailer docs](https://nodemailer.com/message/attachments/), but
+ * only uses the `path` property to define a filesystem path or a URL pointing to
+ * the attachment file.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Email Plugin Types
+ */
+export type EmailAttachment = Omit<Attachment, "raw"> & {
+    path?: string;
+};
+export type SerializedAttachment = OptionalToNullable<Omit<EmailAttachment, "content"> & {
+    content: string | null;
+}>;
+export type IntermediateEmailDetails = {
+    ctx: SerializedRequestContext;
+    type: string;
+    from: string;
+    recipient: string;
+    templateVars: any;
+    subject: string;
+    templateFile: string;
+    attachments: SerializedAttachment[];
+    cc?: string;
+    bcc?: string;
+    replyTo?: string;
+};
+/**
+ * @description
+ * Configures the {@link EmailEventHandler} to handle a particular channel & languageCode
+ * combination.
+ *
+ * @deprecated Use a custom {@link TemplateLoader} instead.
+ */
+export interface EmailTemplateConfig {
+    /**
+     * @description
+     * Specifies the channel to which this configuration will apply. If set to `'default'`, it will be applied to all
+     * channels.
+     */
+    channelCode: string | "default";
+    /**
+     * @description
+     * Specifies the languageCode to which this configuration will apply. If set to `'default'`, it will be applied to all
+     * languages.
+     */
+    languageCode: LanguageCode | "default";
+    /**
+     * @description
+     * Defines the file name of the Handlebars template file to be used to when generating this email.
+     */
+    templateFile: string;
+    /**
+     * @description
+     * A string defining the email subject line. Handlebars variables defined in the `templateVars` object may
+     * be used inside the subject.
+     */
+    subject: string;
+}
+export interface LoadTemplateInput {
+    type: string;
+    templateName: string;
+    templateVars: any;
+}
+export interface Partial {
+    name: string;
+    content: string;
+}
+/**
+ * @description
+ * A function used to define template variables available to email templates.
+ * See {@link EmailEventHandler}.setTemplateVars().
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Email Plugin Types
+ */
+export type SetTemplateVarsFn<Event> = (event: Event, globals: {
+    [key: string]: any;
+}) => {
+    [key: string]: any;
+};
+/**
+ * @description
+ * A function used to define attachments to be sent with the email.
+ * See https://nodemailer.com/message/attachments/ for more information about
+ * how attachments work in Nodemailer.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Email Plugin Types
+ */
+export type SetAttachmentsFn<Event> = (event: Event) => EmailAttachment[] | Promise<EmailAttachment[]>;
+/**
+ * @description
+ * A function used to define the subject to be sent with the email.
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Email Plugin Types
+ */
+export type SetSubjectFn<Event> = (event: Event, ctx: RequestContext, injector: Injector) => string | Promise<string>;
+/**
+ * @description
+ * Optional address-related fields for sending the email.
+ *
+ * @since 1.1.0
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Email Plugin Types
+ */
+export interface OptionalAddressFields {
+    /**
+     * @description
+     * Comma separated list of recipients email addresses that will appear on the _Cc:_ field
+     */
+    cc?: string;
+    /**
+     * @description
+     * Comma separated list of recipients email addresses that will appear on the _Bcc:_ field
+     */
+    bcc?: string;
+    /**
+     * @description
+     * An email address that will appear on the _Reply-To:_ field
+     */
+    replyTo?: string;
+}
+/**
+ * @description
+ * A function used to set the {@link OptionalAddressFields}.
+ *
+ * @since 1.1.0
+ * @docsCategory core plugins/EmailPlugin
+ * @docsPage Email Plugin Types
+ */
+export type SetOptionalAddressFieldsFn<Event> = (event: Event) => OptionalAddressFields | Promise<OptionalAddressFields>;
+export interface LoaderBody {
+    type: string;
+    ctx: SerializedRequestContext;
+}
+export interface ReactEmailSenderPluginOptions {
+    templates: Record<string, (ctx: RequestContext) => FC<any>>;
+}

package/lib/src/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@deenruv/email-plugin",
+  "version": "1.0.0",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/**/*",
+    "templates/**/*",
+    "dev-mailbox.html"
+  ],
+  "homepage": "https://deenruv.com/",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@nestjs/common": "^10.3.10",
+    "@types/nodemailer": "^6.4.9",
+    "dateformat": "^3.0.3",
+    "express": "^4.18.2",
+    "fs-extra": "^11.2.0",
+    "handlebars": "^4.7.8",
+    "mjml": "^4.14.1",
+    "nodemailer": "^6.9.4",
+    "react-email": "4.0.3",
+    "@react-email/components": "^0.0.35",
+    "@react-email/render": "1.0.5",
+    "@deenruv/common": "^1.0.0"
+  },
+  "peerDependencies": {
+    "@deenruv/core": "^0.1.0",
+    "@nestjs/core": "^10.3.10"
+  },
+  "devDependencies": {
+    "@types/dateformat": "^3.0.1",
+    "@types/express": "^4.17.21",
+    "@types/fs-extra": "^11.0.4",
+    "@types/mjml": "^4.7.4",
+    "rimraf": "^5.0.5",
+    "typescript": "5.3.3",
+    "@types/react": "^18.2.0",
+    "@deenruv/core": "^1.0.0"
+  },
+  "scripts": {
+    "watch": "tsc -p ./tsconfig.build.json --watch",
+    "build": "rimraf lib && tsc -p ./tsconfig.build.json",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "test": "vitest --config vitest.config.mts --run"
+  }
+}

package/templates/email-address-change/body.hbs

@@ -0,0 +1,20 @@
+{{> header title="Verify Your New Email Address" }}
+
+<mj-section background-color="#fafafa">
+    <mj-column>
+        <mj-text color="#525252">
+            We received a request to change your registered email address to this one.
+            Click the button below to verify this address and complete the process:
+        </mj-text>
+
+        <mj-button font-family="Helvetica"
+                   background-color="#f45e43"
+                   color="white"
+                   href="{{ changeEmailAddressUrl }}?token={{ identifierChangeToken }}">
+            Verify Me!
+        </mj-button>
+    </mj-column>
+</mj-section>
+
+
+{{> footer }}