@rudderjs/mail 1.0.4 → 1.1.0

package/dist/doctor.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=doctor.d.ts.map

package/dist/doctor.d.ts.map

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

package/dist/doctor.js

@@ -0,0 +1,85 @@
+// Doctor checks contributed by @rudderjs/mail.
+import fs from 'node:fs';
+import net from 'node:net';
+import path from 'node:path';
+import { registerDoctorCheck } from '@rudderjs/console';
+function readFileSafe(rel) {
+    try {
+        return fs.readFileSync(path.join(process.cwd(), rel), 'utf-8');
+    }
+    catch {
+        return null;
+    }
+}
+// Pull SMTP host/port from .env hints or config/mail.ts. We deliberately
+// don't import the user's config — the doctor fast-path stays boot-free
+// and the user's config might pull peer modules that aren't installed.
+function inferSmtp() {
+    const envHost = process.env['MAIL_HOST'] ?? process.env['SMTP_HOST'];
+    const envPort = process.env['MAIL_PORT'] ?? process.env['SMTP_PORT'];
+    if (envHost) {
+        const out = { host: envHost };
+        if (envPort) {
+            const p = Number(envPort);
+            if (!Number.isNaN(p))
+                out.port = p;
+        }
+        return out;
+    }
+    const text = readFileSafe('config/mail.ts') ?? readFileSafe('config/mail.js') ?? '';
+    const hostLit = /MAIL_HOST['"]?\s*,\s*['"]([^'"]+)['"]/.exec(text)?.[1]
+        ?? /host\s*:\s*['"]([^'"]+)['"]/.exec(text)?.[1];
+    const portLit = /MAIL_PORT['"]?\s*,\s*['"]?(\d+)/.exec(text)?.[1]
+        ?? /port\s*:\s*(\d+)/.exec(text)?.[1];
+    if (!hostLit)
+        return null;
+    const out = { host: hostLit };
+    if (portLit)
+        out.port = Number(portLit);
+    return out;
+}
+registerDoctorCheck({
+    id: 'mail:smtp-connect',
+    category: 'runtime',
+    title: 'Mail SMTP host',
+    needsBoot: true,
+    run() {
+        const hint = inferSmtp();
+        if (!hint || !hint.host) {
+            return Promise.resolve({ status: 'ok', message: 'no SMTP host configured — skip' });
+        }
+        // Skip the local sink that nodemailer uses for tests / preview mode
+        if (/^(127\.0\.0\.1|localhost|0\.0\.0\.0)$/.test(hint.host) && (hint.port ?? 587) > 1024 && (hint.port ?? 587) < 2000) {
+            // Likely a local mailpit / mailhog / preview — still try, just don't be loud
+        }
+        const host = hint.host;
+        const port = hint.port ?? 587;
+        return new Promise((resolve) => {
+            const t0 = performance.now();
+            const socket = new net.Socket();
+            socket.setTimeout(2000);
+            socket.once('connect', () => {
+                const ms = Math.round(performance.now() - t0);
+                socket.destroy();
+                resolve({ status: 'ok', message: `${host}:${port} reachable in ${ms}ms` });
+            });
+            socket.once('timeout', () => {
+                socket.destroy();
+                resolve({
+                    status: 'warn',
+                    message: `${host}:${port} timed out after 2s`,
+                    fix: `Verify the SMTP host is reachable from this machine (firewall, VPN, or wrong credentials)`,
+                });
+            });
+            socket.once('error', (err) => {
+                resolve({
+                    status: 'error',
+                    message: `${host}:${port} ${err.code ?? err.message}`,
+                    fix: `Verify MAIL_HOST/MAIL_PORT in .env. ${err.code === 'ENOTFOUND' ? 'DNS lookup failed.' : err.code === 'ECONNREFUSED' ? 'Nothing listening on that port.' : ''}`,
+                });
+            });
+            socket.connect(port, host);
+        });
+    },
+});
+//# sourceMappingURL=doctor.js.map

package/dist/doctor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doctor.js","sourceRoot":"","sources":["../src/doctor.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAE/C,OAAO,EAAE,MAAM,SAAS,CAAA;AACxB,OAAO,GAAG,MAAM,UAAU,CAAA;AAC1B,OAAO,IAAI,MAAM,WAAW,CAAA;AAC5B,OAAO,EAAE,mBAAmB,EAAqB,MAAM,mBAAmB,CAAA;AAE1E,SAAS,YAAY,CAAC,GAAW;IAC/B,IAAI,CAAC;QAAC,OAAO,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,CAAA;IAAC,CAAC;IAAC,MAAM,CAAC;QAAC,OAAO,IAAI,CAAA;IAAC,CAAC;AAC9F,CAAC;AAOD,yEAAyE;AACzE,wEAAwE;AACxE,uEAAuE;AACvE,SAAS,SAAS;IAChB,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,IAAQ,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IACxE,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,IAAQ,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IACxE,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,GAAG,GAAa,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;QACvC,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,CAAA;YACzB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;gBAAE,GAAG,CAAC,IAAI,GAAG,CAAC,CAAA;QACpC,CAAC;QACD,OAAO,GAAG,CAAA;IACZ,CAAC;IACD,MAAM,IAAI,GAAG,YAAY,CAAC,gBAAgB,CAAC,IAAI,YAAY,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAA;IACnF,MAAM,OAAO,GAAG,uCAAuC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;WACtD,6BAA6B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAC9D,MAAM,OAAO,GAAG,iCAAiC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;WAChD,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACnD,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAA;IACzB,MAAM,GAAG,GAAa,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;IACvC,IAAI,OAAO;QAAE,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,CAAA;IACvC,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,mBAAmB,CAAC;IAClB,EAAE,EAAS,mBAAmB;IAC9B,QAAQ,EAAG,SAAS;IACpB,KAAK,EAAM,gBAAgB;IAC3B,SAAS,EAAE,IAAI;IACf,GAAG;QACD,MAAM,IAAI,GAAG,SAAS,EAAE,CAAA;QACxB,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACxB,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,gCAAgC,EAAE,CAAC,CAAA;QACrF,CAAC;QACD,oEAAoE;QACpE,IAAI,uCAAuC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC;YACtH,6EAA6E;QAC/E,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACtB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,GAAG,CAAA;QAC7B,OAAO,IAAI,OAAO,CAAe,CAAC,OAAO,EAAE,EAAE;YAC3C,MAAM,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,CAAA;YAC5B,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,EAAE,CAAA;YAC/B,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;YACvB,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;gBAC1B,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAA;gBAC7C,MAAM,CAAC,OAAO,EAAE,CAAA;gBAChB,OAAO,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,IAAI,IAAI,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAA;YAC5E,CAAC,CAAC,CAAA;YACF,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE;gBAC1B,MAAM,CAAC,OAAO,EAAE,CAAA;gBAChB,OAAO,CAAC;oBACN,MAAM,EAAG,MAAM;oBACf,OAAO,EAAE,GAAG,IAAI,IAAI,IAAI,qBAAqB;oBAC7C,GAAG,EAAM,2FAA2F;iBACrG,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;YACF,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAA0B,EAAE,EAAE;gBAClD,OAAO,CAAC;oBACN,MAAM,EAAG,OAAO;oBAChB,OAAO,EAAE,GAAG,IAAI,IAAI,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,EAAE;oBACrD,GAAG,EAAM,uCAAuC,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC,CAAC,iCAAiC,CAAC,CAAC,CAAC,EAAE,EAAE;iBACzK,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;YACF,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAC5B,CAAC,CAAC,CAAA;IACJ,CAAC;CACF,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rudderjs/mail",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "rudderjs": {
     "provider": "MailProvider",
     "stage": "feature"
@@ -25,10 +25,15 @@
     ".": {
       "import": "./dist/index.js",
       "types": "./dist/index.d.ts"
+    },
+    "./doctor": {
+      "import": "./dist/doctor.js",
+      "types": "./dist/doctor.d.ts"
     }
   },
   "dependencies": {
-    "@rudderjs/core": "^1.1.6"
+    "@rudderjs/console": "^1.1.0",
+    "@rudderjs/core": "^1.1.7"
   },
   "optionalDependencies": {
     "nodemailer": "^6.9.0"
@@ -36,7 +41,7 @@
   "devDependencies": {
     "@types/node": "^20.0.0",
     "typescript": "^5.4.0",
-    "@rudderjs/queue": "4.1.4"
+    "@rudderjs/queue": "4.1.5"
   },
   "author": "Suleiman Shahbari",
   "scripts": {
@@ -44,7 +49,7 @@
     "dev": "tsc -p tsconfig.build.json --watch",
     "typecheck": "tsc --noEmit",
     "lint": "eslint src",
-    "test": "tsc -p tsconfig.test.json && node --experimental-test-module-mocks --test 'dist-test/**/*.test.js'; EXIT=$?; rm -rf dist-test; exit $EXIT",
+    "test": "tsc -p tsconfig.test.json && cd dist-test && node --experimental-test-module-mocks --test",
     "clean": "rm -rf dist"
   }
 }