simple-smtp-server 0.2.0

package/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Dan Lynch <pyramation@gmail.com>
+Copyright (c) 2025 Constructive <developers@constructive.io>
+Copyright (c) 2020-present, Interweb, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,167 @@
+# simple-smtp-server
+
+SMTP-based email sender for Constructive services. This package exposes a `send` helper with the same call shape used by `@launchql/postmaster` (e.g. `{ to, subject, html, text }`).
+
+Configuration is managed through the centralized `@pgpmjs/env` system, which merges defaults, config files, environment variables, and runtime overrides.
+
+## Install
+
+```bash
+pnpm add simple-smtp-server
+```
+
+## Usage
+
+```ts
+import { send } from 'simple-smtp-server';
+
+await send({
+  to: 'user@example.com',
+  subject: 'Welcome',
+  html: '<p>Hello from SMTP</p>'
+});
+```
+
+### Programmatic overrides
+
+You can pass SMTP configuration overrides as a second argument to `send()`:
+
+```ts
+import { send } from 'simple-smtp-server';
+
+await send(
+  {
+    to: 'user@example.com',
+    subject: 'Welcome',
+    html: '<p>Hello from SMTP</p>'
+  },
+  {
+    host: 'smtp.example.com',
+    port: 587,
+    secure: false,
+    user: 'myuser',
+    pass: 'mypassword',
+    from: 'no-reply@example.com'
+  }
+);
+```
+
+### Resetting the transport
+
+If you need to reset the cached SMTP transport (e.g., in tests), use `resetTransport()`:
+
+```ts
+import { resetTransport } from 'simple-smtp-server';
+
+resetTransport();
+```
+
+## Environment variables
+
+Required (unless noted):
+
+- `SMTP_HOST` (required)
+- `SMTP_PORT` (optional, default: `587`)
+- `SMTP_SECURE` (`true`/`false`; default: `false`, set `true` for port `465`)
+- `SMTP_USER` (optional if the server allows anonymous auth)
+- `SMTP_PASS` (required when `SMTP_USER` is set and auth is required)
+- `SMTP_FROM` (default sender address if `from` is not passed to `send`)
+
+Optional:
+
+- `SMTP_REPLY_TO` (default reply-to address when not provided per message)
+- `SMTP_REQUIRE_TLS` (`true`/`false`)
+- `SMTP_TLS_REJECT_UNAUTHORIZED` (`true`/`false`, default: `true`)
+- `SMTP_POOL` (`true`/`false`)
+- `SMTP_MAX_CONNECTIONS` (number)
+- `SMTP_MAX_MESSAGES` (number)
+- `SMTP_NAME` (client hostname)
+- `SMTP_LOGGER` (`true`/`false`, nodemailer transport logging)
+- `SMTP_DEBUG` (`true`/`false`, nodemailer debug output)
+
+## Test / debug
+
+This package ships a small test runner you can use to validate your SMTP settings.
+
+```bash
+SMTP_HOST=smtp.example.com \
+SMTP_PORT=587 \
+SMTP_USER=example \
+SMTP_PASS=secret \
+SMTP_FROM="no-reply@example.com" \
+SMTP_TEST_TO="you@example.com" \
+pnpm --filter "simple-smtp-server" test:send
+```
+
+To use the built-in local SMTP catcher instead of a real SMTP server:
+
+```bash
+SMTP_TEST_USE_CATCHER=true \
+pnpm --filter "simple-smtp-server" test:send
+```
+
+Optional test overrides:
+
+- `SMTP_TEST_FROM`
+- `SMTP_TEST_SUBJECT`
+- `SMTP_TEST_TEXT`
+- `SMTP_TEST_HTML`
+- `SMTP_TEST_USE_CATCHER`
+
+---
+
+## Education and Tutorials
+
+ 1. 🚀 [Quickstart: Getting Up and Running](https://constructive.io/learn/quickstart)
+Get started with modular databases in minutes. Install prerequisites and deploy your first module.
+
+ 2. 📦 [Modular PostgreSQL Development with Database Packages](https://constructive.io/learn/modular-postgres)
+Learn to organize PostgreSQL projects with pgpm workspaces and reusable database modules.
+
+ 3. ✏️ [Authoring Database Changes](https://constructive.io/learn/authoring-database-changes)
+Master the workflow for adding, organizing, and managing database changes with pgpm.
+
+ 4. 🧪 [End-to-End PostgreSQL Testing with TypeScript](https://constructive.io/learn/e2e-postgres-testing)
+Master end-to-end PostgreSQL testing with ephemeral databases, RLS testing, and CI/CD automation.
+
+ 5. ⚡ [Supabase Testing](https://constructive.io/learn/supabase)
+Use TypeScript-first tools to test Supabase projects with realistic RLS, policies, and auth contexts.
+
+ 6. 💧 [Drizzle ORM Testing](https://constructive.io/learn/drizzle-testing)
+Run full-stack tests with Drizzle ORM, including database setup, teardown, and RLS enforcement.
+
+ 7. 🔧 [Troubleshooting](https://constructive.io/learn/troubleshooting)
+Common issues and solutions for pgpm, PostgreSQL, and testing.
+
+## Related Constructive Tooling
+
+### 📦 Package Management
+
+* [pgpm](https://github.com/constructive-io/constructive/tree/main/pgpm/pgpm): **🖥️ PostgreSQL Package Manager** for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.
+
+### 🧪 Testing
+
+* [pgsql-test](https://github.com/constructive-io/constructive/tree/main/postgres/pgsql-test): **📊 Isolated testing environments** with per-test transaction rollbacks—ideal for integration tests, complex migrations, and RLS simulation.
+* [pgsql-seed](https://github.com/constructive-io/constructive/tree/main/postgres/pgsql-seed): **🌱 PostgreSQL seeding utilities** for CSV, JSON, SQL data loading, and pgpm deployment.
+* [supabase-test](https://github.com/constructive-io/constructive/tree/main/postgres/supabase-test): **🧪 Supabase-native test harness** preconfigured for the local Supabase stack—per-test rollbacks, JWT/role context helpers, and CI/GitHub Actions ready.
+* [graphile-test](https://github.com/constructive-io/constructive/tree/main/graphile/graphile-test): **🔐 Authentication mocking** for Graphile-focused test helpers and emulating row-level security contexts.
+* [pg-query-context](https://github.com/constructive-io/constructive/tree/main/postgres/pg-query-context): **🔒 Session context injection** to add session-local context (e.g., `SET LOCAL`) into queries—ideal for setting `role`, `jwt.claims`, and other session settings.
+
+### 🧠 Parsing & AST
+
+* [pgsql-parser](https://www.npmjs.com/package/pgsql-parser): **🔄 SQL conversion engine** that interprets and converts PostgreSQL syntax.
+* [libpg-query-node](https://www.npmjs.com/package/libpg-query): **🌉 Node.js bindings** for `libpg_query`, converting SQL into parse trees.
+* [pg-proto-parser](https://www.npmjs.com/package/pg-proto-parser): **📦 Protobuf parser** for parsing PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
+* [@pgsql/enums](https://www.npmjs.com/package/@pgsql/enums): **🏷️ TypeScript enums** for PostgreSQL AST for safe and ergonomic parsing logic.
+* [@pgsql/types](https://www.npmjs.com/package/@pgsql/types): **📝 Type definitions** for PostgreSQL AST nodes in TypeScript.
+* [@pgsql/utils](https://www.npmjs.com/package/@pgsql/utils): **🛠️ AST utilities** for constructing and transforming PostgreSQL syntax trees.
+
+## Credits
+
+**🛠 Built by the [Constructive](https://constructive.io) team — creators of modular Postgres tooling for secure, composable backends. If you like our work, contribute on [GitHub](https://github.com/constructive-io).**
+
+## Disclaimer
+
+AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
+
+No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.

package/esm/index.js

@@ -0,0 +1,98 @@
+import nodemailer from 'nodemailer';
+import { getEnvOptions } from '@pgpmjs/env';
+const buildTransportOptions = (smtpOpts) => {
+    const { host, port, secure, user, pass, requireTLS, tlsRejectUnauthorized, pool, maxConnections, maxMessages, name, logger, debug } = smtpOpts;
+    if (!host) {
+        throw new Error('Missing SMTP_HOST');
+    }
+    const resolvedPort = port ?? (secure ? 465 : 587);
+    const resolvedSecure = secure ?? resolvedPort === 465;
+    const auth = user
+        ? {
+            user,
+            pass: pass ?? ''
+        }
+        : undefined;
+    const options = {
+        host,
+        port: resolvedPort,
+        secure: resolvedSecure
+    };
+    if (auth) {
+        options.auth = auth;
+    }
+    if (requireTLS !== undefined) {
+        options.requireTLS = requireTLS;
+    }
+    if (tlsRejectUnauthorized !== undefined) {
+        options.tls = {
+            rejectUnauthorized: tlsRejectUnauthorized
+        };
+    }
+    if (pool !== undefined) {
+        options.pool = pool;
+    }
+    if (maxConnections !== undefined) {
+        options.maxConnections = maxConnections;
+    }
+    if (maxMessages !== undefined) {
+        options.maxMessages = maxMessages;
+    }
+    if (name) {
+        options.name = name;
+    }
+    if (logger !== undefined) {
+        options.logger = logger;
+    }
+    if (debug !== undefined) {
+        options.debug = debug;
+    }
+    return options;
+};
+let transport;
+let cachedSmtpOpts;
+const getTransport = (overrides) => {
+    const opts = getEnvOptions({ smtp: overrides });
+    const smtpOpts = opts.smtp ?? {};
+    if (!transport || overrides) {
+        transport = nodemailer.createTransport(buildTransportOptions(smtpOpts));
+        cachedSmtpOpts = smtpOpts;
+    }
+    return { transport, smtpOpts: cachedSmtpOpts ?? smtpOpts };
+};
+const resolveFrom = (from, smtpOpts) => {
+    const resolved = from ?? smtpOpts.from;
+    if (!resolved) {
+        throw new Error('Missing from address. Set SMTP_FROM or pass from in send().');
+    }
+    return resolved;
+};
+export const send = async (options, smtpOverrides) => {
+    if (!options.to) {
+        throw new Error('Missing "to"');
+    }
+    if (!options.subject) {
+        throw new Error('Missing "subject"');
+    }
+    if (!options.html && !options.text) {
+        throw new Error('Missing "html" or "text"');
+    }
+    const { transport: mailer, smtpOpts } = getTransport(smtpOverrides);
+    const mailOptions = {
+        to: options.to,
+        subject: options.subject,
+        html: options.html,
+        text: options.text,
+        from: resolveFrom(options.from, smtpOpts),
+        cc: options.cc,
+        bcc: options.bcc,
+        replyTo: options.replyTo ?? smtpOpts.replyTo,
+        headers: options.headers,
+        attachments: options.attachments
+    };
+    return mailer.sendMail(mailOptions);
+};
+export const resetTransport = () => {
+    transport = undefined;
+    cachedSmtpOpts = undefined;
+};

package/index.d.ts

@@ -0,0 +1,18 @@
+import { SendMailOptions } from 'nodemailer';
+import SMTPTransport from 'nodemailer/lib/smtp-transport';
+import { SmtpOptions } from '@pgpmjs/types';
+type SendInput = {
+    to: string | string[];
+    subject: string;
+    html?: string;
+    text?: string;
+    from?: string;
+    cc?: string | string[];
+    bcc?: string | string[];
+    replyTo?: string;
+    headers?: Record<string, string>;
+    attachments?: SendMailOptions['attachments'];
+};
+export declare const send: (options: SendInput, smtpOverrides?: SmtpOptions) => Promise<SMTPTransport.SentMessageInfo>;
+export declare const resetTransport: () => void;
+export type { SendInput as SendOptions };

package/index.js

@@ -0,0 +1,106 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resetTransport = exports.send = void 0;
+const nodemailer_1 = __importDefault(require("nodemailer"));
+const env_1 = require("@pgpmjs/env");
+const buildTransportOptions = (smtpOpts) => {
+    const { host, port, secure, user, pass, requireTLS, tlsRejectUnauthorized, pool, maxConnections, maxMessages, name, logger, debug } = smtpOpts;
+    if (!host) {
+        throw new Error('Missing SMTP_HOST');
+    }
+    const resolvedPort = port ?? (secure ? 465 : 587);
+    const resolvedSecure = secure ?? resolvedPort === 465;
+    const auth = user
+        ? {
+            user,
+            pass: pass ?? ''
+        }
+        : undefined;
+    const options = {
+        host,
+        port: resolvedPort,
+        secure: resolvedSecure
+    };
+    if (auth) {
+        options.auth = auth;
+    }
+    if (requireTLS !== undefined) {
+        options.requireTLS = requireTLS;
+    }
+    if (tlsRejectUnauthorized !== undefined) {
+        options.tls = {
+            rejectUnauthorized: tlsRejectUnauthorized
+        };
+    }
+    if (pool !== undefined) {
+        options.pool = pool;
+    }
+    if (maxConnections !== undefined) {
+        options.maxConnections = maxConnections;
+    }
+    if (maxMessages !== undefined) {
+        options.maxMessages = maxMessages;
+    }
+    if (name) {
+        options.name = name;
+    }
+    if (logger !== undefined) {
+        options.logger = logger;
+    }
+    if (debug !== undefined) {
+        options.debug = debug;
+    }
+    return options;
+};
+let transport;
+let cachedSmtpOpts;
+const getTransport = (overrides) => {
+    const opts = (0, env_1.getEnvOptions)({ smtp: overrides });
+    const smtpOpts = opts.smtp ?? {};
+    if (!transport || overrides) {
+        transport = nodemailer_1.default.createTransport(buildTransportOptions(smtpOpts));
+        cachedSmtpOpts = smtpOpts;
+    }
+    return { transport, smtpOpts: cachedSmtpOpts ?? smtpOpts };
+};
+const resolveFrom = (from, smtpOpts) => {
+    const resolved = from ?? smtpOpts.from;
+    if (!resolved) {
+        throw new Error('Missing from address. Set SMTP_FROM or pass from in send().');
+    }
+    return resolved;
+};
+const send = async (options, smtpOverrides) => {
+    if (!options.to) {
+        throw new Error('Missing "to"');
+    }
+    if (!options.subject) {
+        throw new Error('Missing "subject"');
+    }
+    if (!options.html && !options.text) {
+        throw new Error('Missing "html" or "text"');
+    }
+    const { transport: mailer, smtpOpts } = getTransport(smtpOverrides);
+    const mailOptions = {
+        to: options.to,
+        subject: options.subject,
+        html: options.html,
+        text: options.text,
+        from: resolveFrom(options.from, smtpOpts),
+        cc: options.cc,
+        bcc: options.bcc,
+        replyTo: options.replyTo ?? smtpOpts.replyTo,
+        headers: options.headers,
+        attachments: options.attachments
+    };
+    return mailer.sendMail(mailOptions);
+};
+exports.send = send;
+const resetTransport = () => {
+    transport = undefined;
+    cachedSmtpOpts = undefined;
+};
+exports.resetTransport = resetTransport;

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "simple-smtp-server",
+  "version": "0.2.0",
+  "author": "Constructive <developers@constructive.io>",
+  "description": "SMTP email sender for Constructive",
+  "main": "index.js",
+  "module": "esm/index.js",
+  "types": "index.d.ts",
+  "homepage": "https://github.com/constructive-io/constructive",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/constructive-io/constructive"
+  },
+  "bugs": {
+    "url": "https://github.com/constructive-io/constructive/issues"
+  },
+  "scripts": {
+    "clean": "makage clean",
+    "prepack": "npm run build",
+    "build": "makage build",
+    "build:dev": "makage build --dev",
+    "lint": "eslint . --fix",
+    "test": "jest --passWithNoTests",
+    "test:watch": "jest --watch",
+    "test:send": "ts-node __tests__/test-send.ts",
+    "test:send:dev": "ts-node __tests__/test-send.ts"
+  },
+  "dependencies": {
+    "@pgpmjs/env": "^2.10.0",
+    "@pgpmjs/types": "^2.15.0",
+    "nodemailer": "^6.9.13"
+  },
+  "devDependencies": {
+    "@types/nodemailer": "^7.0.5",
+    "@types/smtp-server": "^3.5.12",
+    "makage": "^0.1.10",
+    "smtp-server": "^3.14.0",
+    "ts-node": "^10.9.2"
+  },
+  "keywords": [
+    "smtp",
+    "email",
+    "nodemailer",
+    "postmaster"
+  ],
+  "gitHead": "481b3a50b4eec2da6b376c4cd1868065e1e28edb"
+}