@timshel_npm/maildev 3.1.1

package/dist/lib/web.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Web = void 0;
+const routes_1 = require("./routes");
+const express = require("express");
+const cors = require("cors");
+const fs = require("fs");
+const http = require("http");
+const https = require("https");
+const socketio = require("socket.io");
+const auth = require("./auth");
+const logger = require("./logger");
+const path = require("path");
+class Web {
+    constructor(mailserver, options) {
+        var _a, _b, _c, _d, _e;
+        /**
+         * Keep record of all connections to close them on shutdown
+         */
+        this.connections = {};
+        const app = express();
+        this.protocol = (options === null || options === void 0 ? void 0 : options.ssl) ? "https" : "http";
+        this.port = (_a = options === null || options === void 0 ? void 0 : options.port) !== null && _a !== void 0 ? _a : 1080;
+        this.host = (_b = options === null || options === void 0 ? void 0 : options.host) !== null && _b !== void 0 ? _b : "0.0.0.0";
+        this.basePathname = (_c = options === null || options === void 0 ? void 0 : options.basePathname) !== null && _c !== void 0 ? _c : "/";
+        this.server = (options === null || options === void 0 ? void 0 : options.ssl)
+            ? https.createServer({
+                key: fs.readFileSync(options === null || options === void 0 ? void 0 : options.ssl.key),
+                cert: fs.readFileSync(options === null || options === void 0 ? void 0 : options.ssl.cert),
+            }, app)
+            : http.createServer(app);
+        if (options === null || options === void 0 ? void 0 : options.auth) {
+            app.use(auth((_d = options === null || options === void 0 ? void 0 : options.auth) === null || _d === void 0 ? void 0 : _d.user, (_e = options === null || options === void 0 ? void 0 : options.auth) === null || _e === void 0 ? void 0 : _e.pass));
+        }
+        this.io = socketio({ path: path.posix.join(this.basePathname, "/socket.io") });
+        app.use(this.basePathname, express.static(path.join(__dirname, "../app")));
+        app.use(cors());
+        (0, routes_1.routes)(app, mailserver, this.basePathname);
+        this.io.attach(this.server);
+        this.io.on("connection", webSocketConnection(mailserver));
+    }
+    listen() {
+        const self = this;
+        this.server.on("connection", (socket) => {
+            const key = `${socket.remoteAddress}:${socket.remotePort}`;
+            self.connections[key] = socket;
+            socket.on("close", function () {
+                delete self.connections[key];
+            });
+        });
+        return new Promise((resolve, reject) => {
+            self.server.listen(self.port, self.host, () => {
+                logger.info(`MailDev webapp running at ${self.protocol}://${self.host}:${self.port}${self.basePathname}`);
+                resolve();
+            });
+        });
+    }
+    close() {
+        const self = this;
+        closeConnections(this.connections);
+        return new Promise((resolve, reject) => {
+            self.io.close(resolve);
+        });
+    }
+}
+exports.Web = Web;
+function closeConnections(connections) {
+    for (const key in connections) {
+        connections[key].destroy();
+    }
+}
+/**
+ * WebSockets
+ */
+function webSocketConnection(mailserver) {
+    return function onConnection(socket) {
+        const newHandler = (mail) => {
+            socket.emit("newMail", mail);
+        };
+        const deleteHandler = (mail) => {
+            socket.emit("deleteMail", mail);
+        };
+        mailserver.on("new", newHandler);
+        mailserver.on("delete", deleteHandler);
+        socket.on("disconnect", () => {
+            mailserver.removeListener("new", newHandler);
+            mailserver.removeListener("delete", deleteHandler);
+        });
+    };
+}

package/package.json

@@ -0,0 +1,109 @@
+{
+  "name": "@timshel_npm/maildev",
+  "description": "SMTP Server and Web Interface for reading and testing emails during development",
+  "version": "3.1.1",
+  "keywords": [
+    "email",
+    "e-mail",
+    "mail",
+    "maildev",
+    "mailcatcher",
+    "testing",
+    "development",
+    "smtp"
+  ],
+  "author": "Timshel",
+  "homepage": "https://github.com/timshel/maildev",
+  "maintainers": [
+    {
+      "name": "Timshel",
+      "email": "timshel@users.noreply.github.com"
+    }
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/timshel/maildev.git"
+  },
+  "scripts": {
+    "clean": "rm -rf dist coverage tsconfig.tsbuildinfo",
+    "build": "tsc --build && npm run copy-app && npm run css",
+    "copy-app": "mkdir -p dist && cp -r ./src/app ./dist/ && rm -rf ./dist/app/styles",
+    "start": "npm run build && node ./bin/maildev",
+    "test": "prettier . -c && npm run build && nyc _mocha --exit --timeout 5000",
+    "test:debug": "npm run build && nyc _mocha --exit --timeout 5000",
+    "lint": "prettier . -c",
+    "lint:fix": "prettier . -w",
+    "dev": "node ./scripts/dev.js && npm run css-watch",
+    "css": "sass --style=compressed --no-source-map src/app/styles/style.scss:dist/app/styles/style.css",
+    "css-watch": "sass --watch --style=compressed --no-source-map src/app/styles/style.scss:dist/app/styles/style.css",
+    "docker-build": "./src/scripts/dockerBuild.sh",
+    "docker-run": "docker run --rm -p 1080:1080 -p 1025:1025 maildev/maildev:$npm_package_version",
+    "docker-push": "./src/scripts/dockerPush.sh",
+    "update-readme": "node ./src/scripts/updateUsageREADME.js",
+    "prepare": "npm run build"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "bin": {
+    "maildev": "./bin/maildev"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@types/mailparser": "^3.4.6",
+    "addressparser": "1.0.1",
+    "async": "^3.2.6",
+    "commander": "^12.1.0",
+    "compression": "^1.8.0",
+    "cors": "^2.8.5",
+    "dompurify": "^3.2.6",
+    "express": "^4.21.2",
+    "jsdom": "^24.1.3",
+    "mailparser": "^3.7.3",
+    "mime": "1.6.0",
+    "nodemailer": "^6.10.1",
+    "smtp-server": "^3.13.8",
+    "socket.io": "^4.8.1",
+    "wildstring": "1.0.9"
+  },
+  "overrides": {
+    "socket.io-adapter": "2.5.5"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.23",
+    "@types/node": "^18.19.111",
+    "expect": "^29.7.0",
+    "http-proxy-middleware": "^3.0.5",
+    "jest": "^29.7.0",
+    "jest-mock": "^29.7.0",
+    "mocha": "^10.8.2",
+    "nodemon": "^3.1.10",
+    "nyc": "^17.1.0",
+    "prettier": "^3.5.3",
+    "sass": "^1.89.1",
+    "ts-node": "^10.9.2",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.8.3"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "nyc": {
+    "exclude": [
+      "test/**/*",
+      "src/lib/helpers/strtotime.js"
+    ],
+    "ignore-class-method": "methodToIgnore",
+    "reporter": [
+      "json",
+      "lcov",
+      "text-summary"
+    ]
+  },
+  "prettier": {
+    "printWidth": 100
+  }
+}