@moreapp/common-nodejs 0.13.2 → 0.13.4

package/dist/MailService.d.ts

@@ -18,6 +18,8 @@ export declare class MailService {
     readonly username: string;
     readonly password: string;
     constructor(service: string, baseUrl: string, username: string, password: string);
-    send(customerId: number, recipients: Recipient[], subject: string, body: string, attachments: Attachment[], fromName?: string, replyTo?: string, meta?: Record<string, unknown>): Promise<MailSendResponse | undefined>;
+    sendTemplatedMail(emailAddress: string, template: string, language: string, customerId?: number, variables?: Record<string, unknown>): Promise<MailSendResponse | undefined>;
+    sendRawMail(customerId: number, recipients: Recipient[], subject: string, body: string, attachments: Attachment[], fromName?: string, replyTo?: string, meta?: Record<string, unknown>): Promise<MailSendResponse | undefined>;
+    private sendMail;
 }
 export {};

package/dist/MailService.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MailService = void 0;
 const axios_1 = __importDefault(require("axios"));
 const logger_1 = require("./logger");
+const lodash_1 = require("lodash");
 class MailService {
     service;
     baseUrl;
@@ -21,25 +22,48 @@ class MailService {
         this.username = username;
         this.password = password;
     }
-    async send(customerId, recipients, subject, body, attachments, fromName, replyTo, meta) {
-        if (recipients.length === 0) {
+    async sendTemplatedMail(emailAddress, template, language, customerId, variables) {
+        const recipient = {
+            type: "to",
+            email: emailAddress,
+        };
+        return this.sendMail({
+            recipients: [recipient],
+            customerId,
+            content: {
+                type: "template",
+                template,
+                variables: variables ?? {},
+                language,
+                attachments: [],
+            },
+        });
+    }
+    async sendRawMail(customerId, recipients, subject, body, attachments, fromName, replyTo, meta) {
+        return this.sendMail({
+            recipients,
+            customerId,
+            content: {
+                type: "html",
+                subject,
+                html: body,
+                attachments,
+            },
+            fromName,
+            replyTo,
+            meta,
+        });
+    }
+    async sendMail(mailRequest) {
+        if ((0, lodash_1.isEmpty)(mailRequest.recipients)) {
             logger_1.logger.info("No recipients, not sending mail");
             return;
         }
         try {
             const response = await axios_1.default.post(`${this.baseUrl}/api/mail`, {
-                customerId,
-                fromName,
-                replyTo,
-                recipients,
-                content: {
-                    type: "html",
-                    html: body,
-                    subject,
-                    attachments,
-                },
+                ...mailRequest,
                 meta: {
-                    ...meta,
+                    ...mailRequest.meta,
                     service: this.service,
                 },
             }, {

package/dist/__tests__/MailService.test.js

@@ -57,7 +57,7 @@ const newService = () => new MailService_1.MailService("some-service-name", base
     (0, vitest_1.test)("does not send when there are no recipients", async () => {
         const infoSpy = vitest_1.vi.spyOn(logger_1.logger, "info").mockImplementation(() => logger_1.logger);
         const postSpy = vitest_1.vi.spyOn(axios_1.default, "post");
-        const result = await newService().send(1, [], "Subject", "<p>Body</p>", attachments);
+        const result = await newService().sendRawMail(1, [], "Subject", "<p>Body</p>", attachments);
         (0, vitest_1.expect)(result).toBeUndefined();
         (0, vitest_1.expect)(postSpy).not.toHaveBeenCalled();
         (0, vitest_1.expect)(infoSpy).toHaveBeenCalledWith("No recipients, not sending mail");
@@ -71,7 +71,7 @@ const newService = () => new MailService_1.MailService("some-service-name", base
         })
             .basicAuth({ user: username, pass: password })
             .reply(200, { id: "mail-123" });
-        const result = await newService().send(42, recipients, "Hello", "<p>Body</p>", attachments, "MoreApp", "reply@example.com", { correlationId: "abc" });
+        const result = await newService().sendRawMail(42, recipients, "Hello", "<p>Body</p>", attachments, "MoreApp", "reply@example.com", { correlationId: "abc" });
         (0, vitest_1.expect)(result).toEqual({ id: "mail-123" });
         (0, vitest_1.expect)(requestBody).toEqual({
             customerId: 42,
@@ -91,10 +91,62 @@ const newService = () => new MailService_1.MailService("some-service-name", base
         });
         apiMock.done();
     });
+    (0, vitest_1.test)("sends a templated mail to a single recipient and returns the response data", async () => {
+        let requestBody;
+        const apiMock = (0, nock_1.default)(baseUrl)
+            .post("/api/mail", (body) => {
+            requestBody = body;
+            return true;
+        })
+            .basicAuth({ user: username, pass: password })
+            .reply(200, { id: "mail-789" });
+        const result = await newService().sendTemplatedMail("someone@example.com", "welcome", "en", 42, {
+            firstName: "Someone",
+        });
+        (0, vitest_1.expect)(result).toEqual({ id: "mail-789" });
+        (0, vitest_1.expect)(requestBody).toEqual({
+            customerId: 42,
+            recipients: [{ type: "to", email: "someone@example.com" }],
+            content: {
+                type: "template",
+                template: "welcome",
+                language: "en",
+                variables: { firstName: "Someone" },
+                attachments: [],
+            },
+            meta: {
+                service: "some-service-name",
+            },
+        });
+        apiMock.done();
+    });
+    (0, vitest_1.test)("defaults templated mail variables to an empty object when omitted", async () => {
+        let requestBody;
+        const apiMock = (0, nock_1.default)(baseUrl)
+            .post("/api/mail", (body) => {
+            requestBody = body;
+            return true;
+        })
+            .reply(200, { id: "mail-000" });
+        const result = await newService().sendTemplatedMail("someone@example.com", "welcome", "en");
+        (0, vitest_1.expect)(result).toEqual({ id: "mail-000" });
+        (0, vitest_1.expect)(requestBody).toMatchObject({
+            content: {
+                type: "template",
+                template: "welcome",
+                language: "en",
+                variables: {},
+                attachments: [],
+            },
+            meta: { service: "some-service-name" },
+        });
+        (0, vitest_1.expect)(requestBody).not.toHaveProperty("customerId");
+        apiMock.done();
+    });
     (0, vitest_1.test)("throws with the server message on an error response", async () => {
         vitest_1.vi.spyOn(logger_1.logger, "error").mockImplementation(() => logger_1.logger);
         const apiMock = (0, nock_1.default)(baseUrl).post("/api/mail").reply(400, { message: "Invalid recipient" });
-        await (0, vitest_1.expect)(newService().send(1, recipients, "Subject", "<p>Body</p>", attachments)).rejects.toThrow("Failed to send email. Invalid recipient");
+        await (0, vitest_1.expect)(newService().sendRawMail(1, recipients, "Subject", "<p>Body</p>", attachments)).rejects.toThrow("Failed to send email. Invalid recipient");
         apiMock.done();
     });
     (0, vitest_1.test)("rethrows the original error on ECONNRESET so the caller can retry", async () => {
@@ -108,18 +160,18 @@ const newService = () => new MailService_1.MailService("some-service-name", base
             config: {},
         };
         vitest_1.vi.spyOn(axios_1.default, "post").mockRejectedValue(econnreset);
-        await (0, vitest_1.expect)(newService().send(1, recipients, "Subject", "<p>Body</p>", attachments)).rejects.toBe(econnreset);
+        await (0, vitest_1.expect)(newService().sendRawMail(1, recipients, "Subject", "<p>Body</p>", attachments)).rejects.toBe(econnreset);
     });
     (0, vitest_1.test)("throws a generic error for non-axios failures", async () => {
         vitest_1.vi.spyOn(logger_1.logger, "error").mockImplementation(() => logger_1.logger);
         vitest_1.vi.spyOn(axios_1.default, "post").mockRejectedValue(new Error("boom"));
-        await (0, vitest_1.expect)(newService().send(1, recipients, "Subject", "<p>Body</p>", attachments)).rejects.toThrow("Failed to send email");
+        await (0, vitest_1.expect)(newService().sendRawMail(1, recipients, "Subject", "<p>Body</p>", attachments)).rejects.toThrow("Failed to send email");
     });
     (0, vitest_1.test)("throws a generic error for an axios error without a response", async () => {
         vitest_1.vi.spyOn(logger_1.logger, "error").mockImplementation(() => logger_1.logger);
         // An axios error with no `response` (e.g. a timeout / connection failure)
         // should fall through to the generic error path.
         vitest_1.vi.spyOn(axios_1.default, "post").mockRejectedValue(new axios_1.AxiosError("timeout", "ETIMEDOUT"));
-        await (0, vitest_1.expect)(newService().send(1, recipients, "Subject", "<p>Body</p>", attachments)).rejects.toThrow("Failed to send email");
+        await (0, vitest_1.expect)(newService().sendRawMail(1, recipients, "Subject", "<p>Body</p>", attachments)).rejects.toThrow("Failed to send email");
     });
 });

package/dist/index.d.ts

@@ -7,5 +7,6 @@ export * from "./utils";
 export * from "./utils/environmentVariable";
 export * from "./observability";
 export * from "./observability/tracer";
+export * from "./MailService";
 export { BinaryFile } from "./MoreAppClient";
 export { MoreAppClient };

package/dist/index.js

@@ -28,3 +28,4 @@ __exportStar(require("./utils"), exports);
 __exportStar(require("./utils/environmentVariable"), exports);
 __exportStar(require("./observability"), exports);
 __exportStar(require("./observability/tracer"), exports);
+__exportStar(require("./MailService"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moreapp/common-nodejs",
-  "version": "0.13.2",
+  "version": "0.13.4",
   "license": "UNLICENSED",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -57,8 +57,8 @@
     "@types/node": "24.13.3",
     "@typescript-eslint/eslint-plugin": "8.67.0",
     "@typescript-eslint/parser": "8.67.0",
-    "@vitest/coverage-v8": "4.1.10",
-    "@vitest/ui": "4.1.10",
+    "@vitest/coverage-v8": "4.1.11",
+    "@vitest/ui": "4.1.11",
     "eslint": "9.39.5",
     "eslint-config-prettier": "10.1.8",
     "eslint-plugin-prettier": "5.5.6",
@@ -69,7 +69,7 @@
     "ts-node": "10.9.2",
     "typescript": "6.0.3",
     "typescript-eslint": "8.67.0",
-    "vitest": "4.1.10",
+    "vitest": "4.1.11",
     "vitest-mock-extended": "5.1.1"
   },
   "prettier": {