@moreapp/common-nodejs 0.13.1 → 0.13.2

package/dist/MailService.d.ts

@@ -0,0 +1,23 @@
+export interface Recipient {
+    email: string;
+    name?: string;
+    type: "to" | "cc" | "bcc";
+}
+export interface Attachment {
+    name: string;
+    type: string;
+    data: string;
+    inline: boolean;
+}
+type MailSendResponse = {
+    id: string;
+};
+export declare class MailService {
+    readonly service: string;
+    readonly baseUrl: string;
+    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>;
+}
+export {};

package/dist/MailService.js

@@ -0,0 +1,69 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MailService = void 0;
+const axios_1 = __importDefault(require("axios"));
+const logger_1 = require("./logger");
+class MailService {
+    service;
+    baseUrl;
+    username;
+    password;
+    constructor(service, baseUrl, username, password) {
+        this.service = service;
+        this.baseUrl = baseUrl;
+        this.username = username;
+        this.password = password;
+        this.service = service;
+        this.baseUrl = baseUrl;
+        this.username = username;
+        this.password = password;
+    }
+    async send(customerId, recipients, subject, body, attachments, fromName, replyTo, meta) {
+        if (recipients.length === 0) {
+            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,
+                },
+                meta: {
+                    ...meta,
+                    service: this.service,
+                },
+            }, {
+                auth: {
+                    username: this.username,
+                    password: this.password,
+                },
+            });
+            return response.data;
+        }
+        catch (e) {
+            if (axios_1.default.isAxiosError(e) && e.response) {
+                if (e.code === "ECONNRESET") {
+                    logger_1.logger.warn("socket hang up error detected, setting hook for retry");
+                    throw e;
+                }
+                const { status, data } = e.response;
+                logger_1.logger.error("Failed to send email", { response: { status, data } });
+                throw new Error(`Failed to send email. ${data.message}`);
+            }
+            const error = e;
+            logger_1.logger.error("Failed to send email", { code: error.code, message: error.message });
+            throw new Error("Failed to send email");
+        }
+    }
+}
+exports.MailService = MailService;

package/dist/__tests__/MailService.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/MailService.test.js

@@ -0,0 +1,125 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const axios_1 = __importStar(require("axios"));
+const nock_1 = __importDefault(require("nock"));
+const MailService_1 = require("../MailService");
+const logger_1 = require("../logger");
+const baseUrl = "http://notifications.test";
+const username = "user";
+const password = "pass";
+const recipients = [{ email: "someone@example.com", name: "Someone", type: "to" }];
+const attachments = [
+    { name: "file.pdf", type: "application/pdf", data: "base64", inline: false },
+];
+const newService = () => new MailService_1.MailService("some-service-name", baseUrl, username, password);
+(0, vitest_1.describe)("MailService", () => {
+    (0, vitest_1.afterEach)(() => {
+        nock_1.default.cleanAll();
+        vitest_1.vi.restoreAllMocks();
+    });
+    (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);
+        (0, vitest_1.expect)(result).toBeUndefined();
+        (0, vitest_1.expect)(postSpy).not.toHaveBeenCalled();
+        (0, vitest_1.expect)(infoSpy).toHaveBeenCalledWith("No recipients, not sending mail");
+    });
+    (0, vitest_1.test)("sends mail 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-123" });
+        const result = await newService().send(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,
+            fromName: "MoreApp",
+            replyTo: "reply@example.com",
+            recipients,
+            content: {
+                type: "html",
+                html: "<p>Body</p>",
+                subject: "Hello",
+                attachments,
+            },
+            meta: {
+                correlationId: "abc",
+                service: "some-service-name",
+            },
+        });
+        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");
+        apiMock.done();
+    });
+    (0, vitest_1.test)("rethrows the original error on ECONNRESET so the caller can retry", async () => {
+        vitest_1.vi.spyOn(logger_1.logger, "warn").mockImplementation(() => logger_1.logger);
+        const econnreset = new axios_1.AxiosError("socket hang up", "ECONNRESET");
+        econnreset.response = {
+            status: 500,
+            data: {},
+            statusText: "",
+            headers: {},
+            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);
+    });
+    (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");
+    });
+    (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");
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moreapp/common-nodejs",
-  "version": "0.13.1",
+  "version": "0.13.2",
   "license": "UNLICENSED",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",