@deenruv/email-plugin 1.0.0

package/lib/src/handler/event-handler.d.ts

@@ -0,0 +1,276 @@
+import { LanguageCode } from "@deenruv/common/lib/generated-types";
+import { Type } from "@deenruv/common/lib/shared-types";
+import { Injector } from "@deenruv/core";
+import { EmailEventListener } from "../event-listener";
+import { EmailTemplateConfig, EventWithAsyncData, EventWithContext, IntermediateEmailDetails, LoadDataFn, SetAttachmentsFn, SetOptionalAddressFieldsFn, SetSubjectFn, SetTemplateVarsFn } from "../types";
+/**
+ * @description
+ * The EmailEventHandler defines how the EmailPlugin will respond to a given event.
+ *
+ * A handler is created by creating a new {@link EmailEventListener} and calling the `.on()` method
+ * to specify which event to respond to.
+ *
+ * @example
+ * ```ts
+ * const confirmationHandler = new EmailEventListener('order-confirmation')
+ *   .on(OrderStateTransitionEvent)
+ *   .filter(event => event.toState === 'PaymentSettled')
+ *   .setRecipient(event => event.order.customer.emailAddress)
+ *   .setFrom('{{ fromAddress }}')
+ *   .setSubject(`Order confirmation for #{{ order.code }}`)
+ *   .setTemplateVars(event => ({ order: event.order }));
+ * ```
+ *
+ * This example creates a handler which listens for the `OrderStateTransitionEvent` and if the Order has
+ * transitioned to the `'PaymentSettled'` state, it will generate and send an email.
+ *
+ * The string argument passed into the `EmailEventListener` constructor is used to identify the handler, and
+ * also to locate the directory of the email template files. So in the example above, there should be a directory
+ * `<app root>/static/email/templates/order-confirmation` which contains a Handlebars template named `body.hbs`.
+ *
+ * ## Handling other languages
+ *
+ * By default, the handler will respond to all events on all channels and use the same subject ("Order confirmation for #12345" above)
+ * and body template. Where the server is intended to support multiple languages, the `.addTemplate()` method may be used
+ * to define the subject and body template for specific language and channel combinations.
+ *
+ * The language is determined by looking at the `languageCode` property of the event's `ctx` ({@link RequestContext}) object.
+ *
+ * @example
+ * ```ts
+ * const extendedConfirmationHandler = confirmationHandler
+ *   .addTemplate({
+ *     channelCode: 'default',
+ *     languageCode: LanguageCode.de,
+ *     templateFile: 'body.de.hbs',
+ *     subject: 'Bestellbestätigung für #{{ order.code }}',
+ *   })
+ * ```
+ *
+ * ## Defining a custom handler
+ *
+ * Let's say you have a plugin which defines a new event type, `QuoteRequestedEvent`. In your plugin you have defined a mutation
+ * which is executed when the customer requests a quote in your storefront, and in your resolver, you use the {@link EventBus} to publish a
+ * new `QuoteRequestedEvent`.
+ *
+ * You now want to email the customer with their quote. Here are the steps you would take to set this up:
+ *
+ * ### 1. Create a new handler
+ *
+ * ```ts
+ * import { EmailEventListener } from `\@deenruv/email-plugin`;
+ * import { QuoteRequestedEvent } from `./events`;
+ *
+ * const quoteRequestedHandler = new EmailEventListener('quote-requested')
+ *   .on(QuoteRequestedEvent)
+ *   .setRecipient(event => event.customer.emailAddress)
+ *   .setSubject(`Here's the quote you requested`)
+ *   .setFrom('{{ fromAddress }}')
+ *   .setTemplateVars(event => ({ details: event.details }));
+ * ```
+ *
+ * ### 2. Create the email template
+ *
+ * Next you need to make sure there is a template defined at `<app root>/static/email/templates/quote-requested/body.hbs`. The path
+ * segment `quote-requested` must match the string passed to the `EmailEventListener` constructor.
+ *
+ * The template would look something like this:
+ *
+ * ```handlebars
+ * {{> header title="Here's the quote you requested" }}
+ *
+ * <mj-section background-color="#fafafa">
+ *     <mj-column>
+ *         <mj-text color="#525252">
+ *             Thank you for your interest in our products! Here's the details
+ *             of the quote you recently requested:
+ *         </mj-text>
+ *
+ *         <--! your custom email layout goes here -->
+ *     </mj-column>
+ * </mj-section>
+ *
+ *
+ * {{> footer }}
+ * ```
+ *
+ * You can find pre-made templates on the [MJML website](https://mjml.io/templates/).
+ *
+ * ### 3. Register the handler
+ *
+ * Finally, you need to register the handler with the EmailPlugin:
+ *
+ * ```ts {hl_lines=[8]}
+ * import { defaultEmailHandlers, EmailPlugin } from '\@deenruv/email-plugin';
+ * import { quoteRequestedHandler } from './plugins/quote-plugin';
+ *
+ * const config: DeenruvConfig = {
+ *   // Add an instance of the plugin to the plugins array
+ *   plugins: [
+ *     EmailPlugin.init({
+ *       handler: [...defaultEmailHandlers, quoteRequestedHandler],
+ *       templatePath: path.join(__dirname, 'deenruv/email/templates'),
+ *       // ... etc
+ *     }),
+ *   ],
+ * };
+ * ```
+ *
+ * @docsCategory core plugins/EmailPlugin
+ */
+export declare class EmailEventHandler<T extends string = string, Event extends EventWithContext = EventWithContext> {
+    listener: EmailEventListener<T>;
+    event: Type<Event>;
+    private setRecipientFn;
+    private setLanguageCodeFn;
+    private setSubjectFn?;
+    private setTemplateVarsFn;
+    private setAttachmentsFn?;
+    private setOptionalAddressFieldsFn?;
+    private filterFns;
+    private configurations;
+    private defaultSubject;
+    private from;
+    private optionalAddressFields;
+    private _mockEvent;
+    constructor(listener: EmailEventListener<T>, event: Type<Event>);
+    /** @internal */
+    get type(): T;
+    /** @internal */
+    get mockEvent(): Omit<Event, "ctx" | "data"> | undefined;
+    /**
+     * @description
+     * Defines a predicate function which is used to determine whether the event will trigger an email.
+     * Multiple filter functions may be defined.
+     */
+    filter(filterFn: (event: Event) => boolean): EmailEventHandler<T, Event>;
+    /**
+     * @description
+     * A function which defines how the recipient email address should be extracted from the incoming event.
+     *
+     * The recipient can be a plain email address: `'foobar@example.com'`
+     * Or with a formatted name (includes unicode support): `'Ноде Майлер <foobar@example.com>'`
+     * Or a comma-separated list of addresses: `'foobar@example.com, "Ноде Майлер" <bar@example.com>'`
+     */
+    setRecipient(setRecipientFn: (event: Event) => string): EmailEventHandler<T, Event>;
+    /**
+     * @description
+     * A function which allows to override the language of the email. If not defined, the language from the context will be used.
+     *
+     * @since 1.8.0
+     */
+    setLanguageCode(setLanguageCodeFn: (event: Event) => LanguageCode | undefined): EmailEventHandler<T, Event>;
+    /**
+     * @description
+     * A function which returns an object hash of variables which will be made available to the Handlebars template
+     * and subject line for interpolation.
+     */
+    setTemplateVars(templateVarsFn: SetTemplateVarsFn<Event>): EmailEventHandler<T, Event>;
+    /**
+     * @description
+     * Sets the default subject of the email. The subject string may use Handlebars variables defined by the
+     * setTemplateVars() method.
+     */
+    setSubject(defaultSubject: string | SetSubjectFn<Event>): EmailEventHandler<T, Event>;
+    /**
+     * @description
+     * Sets the default from field of the email. The from string may use Handlebars variables defined by the
+     * setTemplateVars() method.
+     */
+    setFrom(from: string): EmailEventHandler<T, Event>;
+    /**
+     * @description
+     * A function which allows {@link OptionalAddressFields} to be specified such as "cc" and "bcc".
+     *
+     * @since 1.1.0
+     */
+    setOptionalAddressFields(optionalAddressFieldsFn: SetOptionalAddressFieldsFn<Event>): this;
+    /**
+     * @description
+     * Defines one or more files to be attached to the email. An attachment can be specified
+     * as either a `path` (to a file or URL) or as `content` which can be a string, Buffer or Stream.
+     *
+     * **Note:** When using the `content` to pass a Buffer or Stream, the raw data will get serialized
+     * into the job queue. For this reason the total size of all attachments passed as `content` should kept to
+     * **less than ~50k**. If the attachments are greater than that limit, a warning will be logged and
+     * errors may result if using the DefaultJobQueuePlugin with certain DBs such as MySQL/MariaDB.
+     *
+     * @example
+     * ```ts
+     * const testAttachmentHandler = new EmailEventListener('activate-voucher')
+     *   .on(ActivateVoucherEvent)
+     *   // ... omitted some steps for brevity
+     *   .setAttachments(async (event) => {
+     *     const { imageUrl, voucherCode } = await getVoucherDataForUser(event.user.id);
+     *     return [
+     *       {
+     *         filename: `voucher-${voucherCode}.jpg`,
+     *         path: imageUrl,
+     *       },
+     *     ];
+     *   });
+     * ```
+     */
+    setAttachments(setAttachmentsFn: SetAttachmentsFn<Event>): this;
+    /**
+     * @description
+     * Add configuration for another template other than the default `"body.hbs"`. Use this method to define specific
+     * templates for channels or languageCodes other than the default.
+     *
+     * @deprecated Define a custom TemplateLoader on plugin initalization to define templates based on the RequestContext.
+     * E.g. `EmailPlugin.init({ templateLoader: new CustomTemplateLoader() })`
+     */
+    addTemplate(config: EmailTemplateConfig): EmailEventHandler<T, Event>;
+    /**
+     * @description
+     * Allows data to be loaded asynchronously which can then be used as template variables.
+     * The `loadDataFn` has access to the event, the TypeORM `Connection` object, and an
+     * `inject()` function which can be used to inject any of the providers exported
+     * by the {@link PluginCommonModule}. The return value of the `loadDataFn` will be
+     * added to the `event` as the `data` property.
+     *
+     * @example
+     * ```ts
+     * new EmailEventListener('order-confirmation')
+     *   .on(OrderStateTransitionEvent)
+     *   .filter(event => event.toState === 'PaymentSettled' && !!event.order.customer)
+     *   .loadData(({ event, injector }) => {
+     *     const orderService = injector.get(OrderService);
+     *     return orderService.getOrderPayments(event.order.id);
+     *   })
+     *   .setTemplateVars(event => ({
+     *     order: event.order,
+     *     payments: event.data,
+     *   }))
+     *   // ...
+     * ```
+     */
+    loadData<R>(loadDataFn: LoadDataFn<Event, R>): EmailEventHandlerWithAsyncData<R, T, Event, EventWithAsyncData<Event, R>>;
+    /**
+     * @description
+     * Used internally by the EmailPlugin to handle incoming events.
+     *
+     * @internal
+     */
+    handle(event: Event, globals: {
+        [key: string]: any;
+    } | undefined, injector: Injector): Promise<IntermediateEmailDetails | undefined>;
+    /**
+     * @description
+     * Optionally define a mock Event which is used by the dev mode mailbox app for generating mock emails
+     * from this handler, which is useful when developing the email templates.
+     */
+    setMockEvent(event: Omit<Event, "ctx" | "data">): EmailEventHandler<T, Event>;
+    private getBestConfiguration;
+}
+/**
+ * @description
+ * Identical to the {@link EmailEventHandler} but with a `data` property added to the `event` based on the result
+ * of the `.loadData()` function.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ */
+export declare class EmailEventHandlerWithAsyncData<Data, T extends string = string, InputEvent extends EventWithContext = EventWithContext, Event extends EventWithAsyncData<InputEvent, Data> = EventWithAsyncData<InputEvent, Data>> extends EmailEventHandler<T, Event> {
+    _loadDataFn: LoadDataFn<InputEvent, Data>;
+    constructor(_loadDataFn: LoadDataFn<InputEvent, Data>, listener: EmailEventListener<T>, event: Type<InputEvent>);
+}

package/lib/src/handler/event-handler.js

@@ -0,0 +1,396 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailEventHandlerWithAsyncData = exports.EmailEventHandler = void 0;
+const core_1 = require("@deenruv/core");
+const attachment_utils_1 = require("../attachment-utils");
+const constants_1 = require("../constants");
+/**
+ * @description
+ * The EmailEventHandler defines how the EmailPlugin will respond to a given event.
+ *
+ * A handler is created by creating a new {@link EmailEventListener} and calling the `.on()` method
+ * to specify which event to respond to.
+ *
+ * @example
+ * ```ts
+ * const confirmationHandler = new EmailEventListener('order-confirmation')
+ *   .on(OrderStateTransitionEvent)
+ *   .filter(event => event.toState === 'PaymentSettled')
+ *   .setRecipient(event => event.order.customer.emailAddress)
+ *   .setFrom('{{ fromAddress }}')
+ *   .setSubject(`Order confirmation for #{{ order.code }}`)
+ *   .setTemplateVars(event => ({ order: event.order }));
+ * ```
+ *
+ * This example creates a handler which listens for the `OrderStateTransitionEvent` and if the Order has
+ * transitioned to the `'PaymentSettled'` state, it will generate and send an email.
+ *
+ * The string argument passed into the `EmailEventListener` constructor is used to identify the handler, and
+ * also to locate the directory of the email template files. So in the example above, there should be a directory
+ * `<app root>/static/email/templates/order-confirmation` which contains a Handlebars template named `body.hbs`.
+ *
+ * ## Handling other languages
+ *
+ * By default, the handler will respond to all events on all channels and use the same subject ("Order confirmation for #12345" above)
+ * and body template. Where the server is intended to support multiple languages, the `.addTemplate()` method may be used
+ * to define the subject and body template for specific language and channel combinations.
+ *
+ * The language is determined by looking at the `languageCode` property of the event's `ctx` ({@link RequestContext}) object.
+ *
+ * @example
+ * ```ts
+ * const extendedConfirmationHandler = confirmationHandler
+ *   .addTemplate({
+ *     channelCode: 'default',
+ *     languageCode: LanguageCode.de,
+ *     templateFile: 'body.de.hbs',
+ *     subject: 'Bestellbestätigung für #{{ order.code }}',
+ *   })
+ * ```
+ *
+ * ## Defining a custom handler
+ *
+ * Let's say you have a plugin which defines a new event type, `QuoteRequestedEvent`. In your plugin you have defined a mutation
+ * which is executed when the customer requests a quote in your storefront, and in your resolver, you use the {@link EventBus} to publish a
+ * new `QuoteRequestedEvent`.
+ *
+ * You now want to email the customer with their quote. Here are the steps you would take to set this up:
+ *
+ * ### 1. Create a new handler
+ *
+ * ```ts
+ * import { EmailEventListener } from `\@deenruv/email-plugin`;
+ * import { QuoteRequestedEvent } from `./events`;
+ *
+ * const quoteRequestedHandler = new EmailEventListener('quote-requested')
+ *   .on(QuoteRequestedEvent)
+ *   .setRecipient(event => event.customer.emailAddress)
+ *   .setSubject(`Here's the quote you requested`)
+ *   .setFrom('{{ fromAddress }}')
+ *   .setTemplateVars(event => ({ details: event.details }));
+ * ```
+ *
+ * ### 2. Create the email template
+ *
+ * Next you need to make sure there is a template defined at `<app root>/static/email/templates/quote-requested/body.hbs`. The path
+ * segment `quote-requested` must match the string passed to the `EmailEventListener` constructor.
+ *
+ * The template would look something like this:
+ *
+ * ```handlebars
+ * {{> header title="Here's the quote you requested" }}
+ *
+ * <mj-section background-color="#fafafa">
+ *     <mj-column>
+ *         <mj-text color="#525252">
+ *             Thank you for your interest in our products! Here's the details
+ *             of the quote you recently requested:
+ *         </mj-text>
+ *
+ *         <--! your custom email layout goes here -->
+ *     </mj-column>
+ * </mj-section>
+ *
+ *
+ * {{> footer }}
+ * ```
+ *
+ * You can find pre-made templates on the [MJML website](https://mjml.io/templates/).
+ *
+ * ### 3. Register the handler
+ *
+ * Finally, you need to register the handler with the EmailPlugin:
+ *
+ * ```ts {hl_lines=[8]}
+ * import { defaultEmailHandlers, EmailPlugin } from '\@deenruv/email-plugin';
+ * import { quoteRequestedHandler } from './plugins/quote-plugin';
+ *
+ * const config: DeenruvConfig = {
+ *   // Add an instance of the plugin to the plugins array
+ *   plugins: [
+ *     EmailPlugin.init({
+ *       handler: [...defaultEmailHandlers, quoteRequestedHandler],
+ *       templatePath: path.join(__dirname, 'deenruv/email/templates'),
+ *       // ... etc
+ *     }),
+ *   ],
+ * };
+ * ```
+ *
+ * @docsCategory core plugins/EmailPlugin
+ */
+class EmailEventHandler {
+    constructor(listener, event) {
+        this.listener = listener;
+        this.event = event;
+        this.filterFns = [];
+        this.configurations = [];
+    }
+    /** @internal */
+    get type() {
+        return this.listener.type;
+    }
+    /** @internal */
+    get mockEvent() {
+        return this._mockEvent;
+    }
+    /**
+     * @description
+     * Defines a predicate function which is used to determine whether the event will trigger an email.
+     * Multiple filter functions may be defined.
+     */
+    filter(filterFn) {
+        this.filterFns.push(filterFn);
+        return this;
+    }
+    /**
+     * @description
+     * A function which defines how the recipient email address should be extracted from the incoming event.
+     *
+     * The recipient can be a plain email address: `'foobar@example.com'`
+     * Or with a formatted name (includes unicode support): `'Ноде Майлер <foobar@example.com>'`
+     * Or a comma-separated list of addresses: `'foobar@example.com, "Ноде Майлер" <bar@example.com>'`
+     */
+    setRecipient(setRecipientFn) {
+        this.setRecipientFn = setRecipientFn;
+        return this;
+    }
+    /**
+     * @description
+     * A function which allows to override the language of the email. If not defined, the language from the context will be used.
+     *
+     * @since 1.8.0
+     */
+    setLanguageCode(setLanguageCodeFn) {
+        this.setLanguageCodeFn = setLanguageCodeFn;
+        return this;
+    }
+    /**
+     * @description
+     * A function which returns an object hash of variables which will be made available to the Handlebars template
+     * and subject line for interpolation.
+     */
+    setTemplateVars(templateVarsFn) {
+        this.setTemplateVarsFn = templateVarsFn;
+        return this;
+    }
+    /**
+     * @description
+     * Sets the default subject of the email. The subject string may use Handlebars variables defined by the
+     * setTemplateVars() method.
+     */
+    setSubject(defaultSubject) {
+        if (typeof defaultSubject === "string") {
+            this.defaultSubject = defaultSubject;
+        }
+        else {
+            this.setSubjectFn = defaultSubject;
+        }
+        return this;
+    }
+    /**
+     * @description
+     * Sets the default from field of the email. The from string may use Handlebars variables defined by the
+     * setTemplateVars() method.
+     */
+    setFrom(from) {
+        this.from = from;
+        return this;
+    }
+    /**
+     * @description
+     * A function which allows {@link OptionalAddressFields} to be specified such as "cc" and "bcc".
+     *
+     * @since 1.1.0
+     */
+    setOptionalAddressFields(optionalAddressFieldsFn) {
+        this.setOptionalAddressFieldsFn = optionalAddressFieldsFn;
+        return this;
+    }
+    /**
+     * @description
+     * Defines one or more files to be attached to the email. An attachment can be specified
+     * as either a `path` (to a file or URL) or as `content` which can be a string, Buffer or Stream.
+     *
+     * **Note:** When using the `content` to pass a Buffer or Stream, the raw data will get serialized
+     * into the job queue. For this reason the total size of all attachments passed as `content` should kept to
+     * **less than ~50k**. If the attachments are greater than that limit, a warning will be logged and
+     * errors may result if using the DefaultJobQueuePlugin with certain DBs such as MySQL/MariaDB.
+     *
+     * @example
+     * ```ts
+     * const testAttachmentHandler = new EmailEventListener('activate-voucher')
+     *   .on(ActivateVoucherEvent)
+     *   // ... omitted some steps for brevity
+     *   .setAttachments(async (event) => {
+     *     const { imageUrl, voucherCode } = await getVoucherDataForUser(event.user.id);
+     *     return [
+     *       {
+     *         filename: `voucher-${voucherCode}.jpg`,
+     *         path: imageUrl,
+     *       },
+     *     ];
+     *   });
+     * ```
+     */
+    setAttachments(setAttachmentsFn) {
+        this.setAttachmentsFn = setAttachmentsFn;
+        return this;
+    }
+    /**
+     * @description
+     * Add configuration for another template other than the default `"body.hbs"`. Use this method to define specific
+     * templates for channels or languageCodes other than the default.
+     *
+     * @deprecated Define a custom TemplateLoader on plugin initalization to define templates based on the RequestContext.
+     * E.g. `EmailPlugin.init({ templateLoader: new CustomTemplateLoader() })`
+     */
+    addTemplate(config) {
+        this.configurations.push(config);
+        return this;
+    }
+    /**
+     * @description
+     * Allows data to be loaded asynchronously which can then be used as template variables.
+     * The `loadDataFn` has access to the event, the TypeORM `Connection` object, and an
+     * `inject()` function which can be used to inject any of the providers exported
+     * by the {@link PluginCommonModule}. The return value of the `loadDataFn` will be
+     * added to the `event` as the `data` property.
+     *
+     * @example
+     * ```ts
+     * new EmailEventListener('order-confirmation')
+     *   .on(OrderStateTransitionEvent)
+     *   .filter(event => event.toState === 'PaymentSettled' && !!event.order.customer)
+     *   .loadData(({ event, injector }) => {
+     *     const orderService = injector.get(OrderService);
+     *     return orderService.getOrderPayments(event.order.id);
+     *   })
+     *   .setTemplateVars(event => ({
+     *     order: event.order,
+     *     payments: event.data,
+     *   }))
+     *   // ...
+     * ```
+     */
+    loadData(loadDataFn) {
+        const asyncHandler = new EmailEventHandlerWithAsyncData(loadDataFn, this.listener, this.event);
+        asyncHandler.setRecipientFn = this.setRecipientFn;
+        asyncHandler.setTemplateVarsFn = this.setTemplateVarsFn;
+        asyncHandler.setAttachmentsFn = this.setAttachmentsFn;
+        asyncHandler.setOptionalAddressFieldsFn = this.setOptionalAddressFieldsFn;
+        asyncHandler.filterFns = this.filterFns;
+        asyncHandler.configurations = this.configurations;
+        asyncHandler.defaultSubject = this.defaultSubject;
+        asyncHandler.from = this.from;
+        asyncHandler._mockEvent = this._mockEvent;
+        return asyncHandler;
+    }
+    /**
+     * @description
+     * Used internally by the EmailPlugin to handle incoming events.
+     *
+     * @internal
+     */
+    async handle(event, globals = {}, injector) {
+        var _a, _b, _c, _d, _e;
+        for (const filterFn of this.filterFns) {
+            if (!filterFn(event)) {
+                return;
+            }
+        }
+        if (this instanceof EmailEventHandlerWithAsyncData) {
+            try {
+                event.data = await this._loadDataFn({
+                    event,
+                    injector,
+                });
+            }
+            catch (err) {
+                if (err instanceof Error) {
+                    core_1.Logger.error(err.message, constants_1.loggerCtx, err.stack);
+                }
+                else {
+                    core_1.Logger.error(String(err), constants_1.loggerCtx);
+                }
+                return;
+            }
+        }
+        if (!this.setRecipientFn) {
+            throw new Error(`No setRecipientFn has been defined. ` +
+                `Remember to call ".setRecipient()" when setting up the EmailEventHandler for ${this.type}`);
+        }
+        if (this.from === undefined) {
+            throw new Error(`No from field has been defined. ` +
+                `Remember to call ".setFrom()" when setting up the EmailEventHandler for ${this.type}`);
+        }
+        const { ctx } = event;
+        const languageCode = ((_a = this.setLanguageCodeFn) === null || _a === void 0 ? void 0 : _a.call(this, event)) || ctx.languageCode;
+        const configuration = this.getBestConfiguration(ctx.channel.code, languageCode);
+        const subject = configuration
+            ? configuration.subject
+            : this.setSubjectFn
+                ? await this.setSubjectFn(event, ctx, injector)
+                : this.defaultSubject;
+        if (subject == null) {
+            throw new Error(`No subject field has been defined. ` +
+                `Remember to call ".setSubject()" when setting up the EmailEventHandler for ${this.type}`);
+        }
+        const recipient = this.setRecipientFn(event);
+        const templateVars = this.setTemplateVarsFn
+            ? this.setTemplateVarsFn(event, globals)
+            : {};
+        let attachmentsArray = [];
+        try {
+            attachmentsArray = (_c = (await ((_b = this.setAttachmentsFn) === null || _b === void 0 ? void 0 : _b.call(this, event)))) !== null && _c !== void 0 ? _c : [];
+        }
+        catch (e) {
+            core_1.Logger.error(e, constants_1.loggerCtx, e.stack);
+        }
+        const attachments = await (0, attachment_utils_1.serializeAttachments)(attachmentsArray);
+        const optionalAddressFields = (_e = (await ((_d = this.setOptionalAddressFieldsFn) === null || _d === void 0 ? void 0 : _d.call(this, event)))) !== null && _e !== void 0 ? _e : {};
+        return Object.assign({ ctx: event.ctx.serialize(), type: this.type, recipient, from: this.from, templateVars: Object.assign(Object.assign({}, globals), templateVars), subject, templateFile: configuration ? configuration.templateFile : "body.hbs", attachments }, optionalAddressFields);
+    }
+    /**
+     * @description
+     * Optionally define a mock Event which is used by the dev mode mailbox app for generating mock emails
+     * from this handler, which is useful when developing the email templates.
+     */
+    setMockEvent(event) {
+        this._mockEvent = event;
+        return this;
+    }
+    getBestConfiguration(channelCode, languageCode) {
+        if (this.configurations.length === 0) {
+            return;
+        }
+        const exactMatch = this.configurations.find((c) => {
+            return ((c.channelCode === channelCode || c.channelCode === "default") &&
+                c.languageCode === languageCode);
+        });
+        if (exactMatch) {
+            return exactMatch;
+        }
+        const channelMatch = this.configurations.find((c) => c.channelCode === channelCode && c.languageCode === "default");
+        if (channelMatch) {
+            return channelMatch;
+        }
+        return;
+    }
+}
+exports.EmailEventHandler = EmailEventHandler;
+/**
+ * @description
+ * Identical to the {@link EmailEventHandler} but with a `data` property added to the `event` based on the result
+ * of the `.loadData()` function.
+ *
+ * @docsCategory core plugins/EmailPlugin
+ */
+class EmailEventHandlerWithAsyncData extends EmailEventHandler {
+    constructor(_loadDataFn, listener, event) {
+        super(listener, event);
+        this._loadDataFn = _loadDataFn;
+    }
+}
+exports.EmailEventHandlerWithAsyncData = EmailEventHandlerWithAsyncData;
+//# sourceMappingURL=event-handler.js.map

package/lib/src/handler/event-handler.js.map

@@ -0,0 +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;IAoB5B,YACS,QAA+B,EAC/B,KAAkB;QADlB,aAAQ,GAAR,QAAQ,CAAuB;QAC/B,UAAK,GAAL,KAAK,CAAa;QAZnB,cAAS,GAAqC,EAAE,CAAC;QACjD,mBAAc,GAA0B,EAAE,CAAC;IAYhD,CAAC;IAEJ,gBAAgB;IAChB,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC5B,CAAC;IAED,gBAAgB;IAChB,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAmC;QACxC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CACV,cAAwC;QAExC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,eAAe,CACb,iBAA6D;QAE7D,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,eAAe,CACb,cAAwC;QAExC,IAAI,CAAC,iBAAiB,GAAG,cAAc,CAAC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,UAAU,CACR,cAA4C;QAE5C,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YACvC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACvC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,YAAY,GAAG,cAAc,CAAC;QACrC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,IAAY;QAClB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,wBAAwB,CACtB,uBAA0D;QAE1D,IAAI,CAAC,0BAA0B,GAAG,uBAAuB,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,cAAc,CAAC,gBAAyC;QACtD,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,MAA2B;QACrC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,CACN,UAAgC;QAEhC,MAAM,YAAY,GAAG,IAAI,8BAA8B,CACrD,UAAU,EACV,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,KAAK,CACX,CAAC;QACF,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;IACtB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,KAAY,EACZ,UAAkC,EAAE,EACpC,QAAkB;;QAElB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACtC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrB,OAAO;YACT,CAAC;QACH,CAAC;QACD,IAAI,IAAI,YAAY,8BAA8B,EAAE,CAAC;YACnD,IAAI,CAAC;gBACF,KAAwC,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CACrE;oBACE,KAAK;oBACL,QAAQ;iBACT,CACF,CAAC;YACJ,CAAC;YAAC,OAAO,GAAY,EAAE,CAAC;gBACtB,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;oBACzB,aAAM,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,qBAAS,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;gBAClD,CAAC;qBAAM,CAAC;oBACN,aAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,qBAAS,CAAC,CAAC;gBACvC,CAAC;gBACD,OAAO;YACT,CAAC;QACH,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CACb,sCAAsC;gBACpC,gFAAgF,IAAI,CAAC,IAAI,EAAE,CAC9F,CAAC;QACJ,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CACb,kCAAkC;gBAChC,2EAA2E,IAAI,CAAC,IAAI,EAAE,CACzF,CAAC;QACJ,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,CAC7C,GAAG,CAAC,OAAO,CAAC,IAAI,EAChB,YAAY,CACb,CAAC;QACF,MAAM,OAAO,GAAG,aAAa;YAC3B,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;QAC1B,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CACb,qCAAqC;gBACnC,8EAA8E,IAAI,CAAC,IAAI,EAAE,CAC5F,CAAC;QACJ,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC7C,MAAM,YAAY,GAAG,IAAI,CAAC,iBAAiB;YACzC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC;YACxC,CAAC,CAAC,EAAE,CAAC;QACP,IAAI,gBAAgB,GAAsB,EAAE,CAAC;QAC7C,IAAI,CAAC;YACH,gBAAgB,GAAG,MAAA,CAAC,MAAM,CAAA,MAAA,IAAI,CAAC,gBAAgB,qDAAG,KAAK,CAAC,CAAA,CAAC,mCAAI,EAAE,CAAC;QAClE,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,aAAM,CAAC,KAAK,CAAC,CAAC,EAAE,qBAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;QACtC,CAAC;QACD,MAAM,WAAW,GAAG,MAAM,IAAA,uCAAoB,EAAC,gBAAgB,CAAC,CAAC;QACjE,MAAM,qBAAqB,GACzB,MAAA,CAAC,MAAM,CAAA,MAAA,IAAI,CAAC,0BAA0B,qDAAG,KAAK,CAAC,CAAA,CAAC,mCAAI,EAAE,CAAC;QACzD,uBACE,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,EACxB;IACJ,CAAC;IAED;;;;OAIG;IACH,YAAY,CACV,KAAkC;QAElC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,oBAAoB,CAC1B,WAAmB,EACnB,YAA0B;QAE1B,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrC,OAAO;QACT,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;YAChD,OAAO,CACL,CAAC,CAAC,CAAC,WAAW,KAAK,WAAW,IAAI,CAAC,CAAC,WAAW,KAAK,SAAS,CAAC;gBAC9D,CAAC,CAAC,YAAY,KAAK,YAAY,CAChC,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAC3C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,KAAK,WAAW,IAAI,CAAC,CAAC,YAAY,KAAK,SAAS,CACrE,CAAC;QACF,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO,YAAY,CAAC;QACtB,CAAC;QACD,OAAO;IACT,CAAC;CACF;AAhVD,8CAgVC;AAED;;;;;;GAMG;AACH,MAAa,8BAQX,SAAQ,iBAA2B;IACnC,YACS,WAAyC,EAChD,QAA+B,EAC/B,KAAuB;QAEvB,KAAK,CAAC,QAAQ,EAAE,KAAY,CAAC,CAAC;QAJvB,gBAAW,GAAX,WAAW,CAA8B;IAKlD,CAAC;CACF;AAhBD,wEAgBC"}

package/lib/src/handler/mock-events.d.ts

@@ -0,0 +1,5 @@
+import { AccountRegistrationEvent, IdentifierChangeRequestEvent, OrderStateTransitionEvent, PasswordResetEvent } from "@deenruv/core";
+export declare const mockOrderStateTransitionEvent: OrderStateTransitionEvent;
+export declare const mockAccountRegistrationEvent: AccountRegistrationEvent;
+export declare const mockPasswordResetEvent: PasswordResetEvent;
+export declare const mockEmailAddressChangeEvent: IdentifierChangeRequestEvent;