@constructive-io/postmaster 1.0.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,130 @@
+# @constructive-io/postmaster
+
+<p align="center" width="100%">
+  <img height="250" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
+</p>
+
+<p align="center" width="100%">
+  <a href="https://github.com/constructive-io/constructive/actions/workflows/run-tests.yaml">
+    <img height="20" src="https://github.com/constructive-io/constructive/actions/workflows/run-tests.yaml/badge.svg" />
+  </a>
+  <a href="https://github.com/constructive-io/constructive/blob/main/LICENSE">
+    <img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/>
+  </a>
+  <a href="https://www.npmjs.com/package/@constructive-io/postmaster">
+    <img height="20" src="https://img.shields.io/github/package-json/v/constructive-io/constructive?filename=packages%2Fpostmaster%2Fpackage.json"/>
+  </a>
+</p>
+
+> Mailgun email sender for Constructive services
+
+This package exposes a `send` helper with the same call shape used by `simple-smtp-server` (e.g. `{ to, subject, html, text }`).
+
+## Installation
+
+```bash
+npm install @constructive-io/postmaster
+```
+
+## Usage
+
+```typescript
+import { send } from '@constructive-io/postmaster';
+
+await send({
+  to: 'user@example.com',
+  subject: 'Hello',
+  html: '<p>Hello World</p>'
+});
+```
+
+## Environment Variables
+
+| Variable | Description | Required |
+|----------|-------------|----------|
+| `MAILGUN_KEY` | Mailgun API key | Yes |
+| `MAILGUN_DOMAIN` | Mailgun domain (e.g., `mg.example.com`) | Yes |
+| `MAILGUN_FROM` | Default sender email address | No |
+| `MAILGUN_REPLY` | Default reply-to email address | No |
+| `MAILGUN_DEV_EMAIL` | Development email redirect (all emails sent to this address with original recipient encoded) | No |
+
+## Development Email Redirect
+
+When `MAILGUN_DEV_EMAIL` is set, all emails are redirected to that address with the original recipient encoded in the local part. For example, if `MAILGUN_DEV_EMAIL=dev@example.com` and you send to `user@domain.com`, the email will be sent to `dev+user_at_domain.com@example.com`.
+
+## API
+
+### `send(options, mailgunOverrides?)`
+
+Send an email via Mailgun.
+
+**Parameters:**
+- `options.to` - Recipient email address(es)
+- `options.subject` - Email subject
+- `options.html` - HTML body (required if no text)
+- `options.text` - Plain text body (required if no html)
+- `options.from` - Sender email (defaults to `MAILGUN_FROM`)
+- `options.replyTo` - Reply-to address (defaults to `MAILGUN_REPLY`)
+- `mailgunOverrides` - Optional overrides for Mailgun configuration
+
+### `resetClient()`
+
+Reset the cached Mailgun client. Useful for testing or when configuration changes.
+
+---
+
+## 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.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Mailgun configuration options
+ */
+export interface MailgunOptions {
+    /** Mailgun API key */
+    key?: string;
+    /** Mailgun domain (e.g., 'mg.example.com') */
+    domain?: string;
+    /** Default sender email address */
+    from?: string;
+    /** Default reply-to email address */
+    replyTo?: string;
+    /** Development email address - when set, all emails are redirected to this address */
+    devEmail?: string;
+}
+type SendInput = {
+    to: string | string[];
+    subject: string;
+    html?: string;
+    text?: string;
+    from?: string;
+    replyTo?: string;
+};
+export declare const send: (options: SendInput, mailgunOverrides?: MailgunOptions) => Promise<void>;
+export declare const resetClient: () => void;
+export type { SendInput as SendOptions };

package/esm/index.js

@@ -0,0 +1,101 @@
+import Mailgun from 'mailgun.js';
+import FormData from 'form-data';
+import { str, email, host, env } from '12factor-env';
+let cachedEnvConfig;
+const getEnvConfig = () => {
+    if (cachedEnvConfig) {
+        return cachedEnvConfig;
+    }
+    cachedEnvConfig = env(process.env, {
+        MAILGUN_KEY: str()
+    }, {
+        MAILGUN_DOMAIN: host(),
+        MAILGUN_FROM: email(),
+        MAILGUN_REPLY: email()
+    });
+    return cachedEnvConfig;
+};
+// MAILGUN_DEV_EMAIL is read directly from process.env (not validated by 12factor-env)
+// to match the original behavior where it was accessed but not in the env validation
+const getEnvOptions = () => {
+    const envConfig = getEnvConfig();
+    return {
+        key: envConfig.MAILGUN_KEY,
+        domain: envConfig.MAILGUN_DOMAIN,
+        from: envConfig.MAILGUN_FROM,
+        replyTo: envConfig.MAILGUN_REPLY,
+        devEmail: process.env.MAILGUN_DEV_EMAIL
+    };
+};
+let client;
+let cachedMailgunOpts;
+const getClient = (overrides) => {
+    const envOpts = getEnvOptions();
+    const mailgunOpts = {
+        ...envOpts,
+        ...overrides
+    };
+    if (!client || overrides) {
+        if (!mailgunOpts.key) {
+            throw new Error('Missing MAILGUN_KEY');
+        }
+        if (!mailgunOpts.domain) {
+            throw new Error('Missing MAILGUN_DOMAIN');
+        }
+        const mailgun = new Mailgun(FormData);
+        client = mailgun.client({
+            username: 'api',
+            key: mailgunOpts.key
+        });
+        cachedMailgunOpts = mailgunOpts;
+    }
+    return { client, mailgunOpts: cachedMailgunOpts ?? mailgunOpts };
+};
+const resolveFrom = (from, mailgunOpts) => {
+    const resolved = from ?? mailgunOpts.from;
+    if (!resolved) {
+        throw new Error('Missing from address. Set MAILGUN_FROM or pass from in send().');
+    }
+    return resolved;
+};
+const resolveRecipient = (to, mailgunOpts) => {
+    const devEmail = mailgunOpts.devEmail;
+    if (!devEmail) {
+        return to;
+    }
+    const [localPart, domainPart] = devEmail.split('@');
+    const recipients = Array.isArray(to) ? to : [to];
+    return recipients.map(recipient => {
+        const encodedRecipient = recipient.replace('@', '_at_');
+        return `${localPart}+${encodedRecipient}@${domainPart}`;
+    });
+};
+export const send = async (options, mailgunOverrides) => {
+    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 { client: mailgunClient, mailgunOpts } = getClient(mailgunOverrides);
+    const to = resolveRecipient(options.to, mailgunOpts);
+    const from = resolveFrom(options.from, mailgunOpts);
+    const replyTo = options.replyTo ?? mailgunOpts.replyTo;
+    const messageData = {
+        to: Array.isArray(to) ? to.join(',') : to,
+        from,
+        subject: options.subject,
+        ...(options.html && { html: options.html }),
+        ...(options.text && { text: options.text }),
+        ...(replyTo && { 'h:Reply-To': replyTo })
+    };
+    await mailgunClient.messages.create(mailgunOpts.domain, messageData);
+};
+export const resetClient = () => {
+    client = undefined;
+    cachedMailgunOpts = undefined;
+    cachedEnvConfig = undefined;
+};

package/index.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Mailgun configuration options
+ */
+export interface MailgunOptions {
+    /** Mailgun API key */
+    key?: string;
+    /** Mailgun domain (e.g., 'mg.example.com') */
+    domain?: string;
+    /** Default sender email address */
+    from?: string;
+    /** Default reply-to email address */
+    replyTo?: string;
+    /** Development email address - when set, all emails are redirected to this address */
+    devEmail?: string;
+}
+type SendInput = {
+    to: string | string[];
+    subject: string;
+    html?: string;
+    text?: string;
+    from?: string;
+    replyTo?: string;
+};
+export declare const send: (options: SendInput, mailgunOverrides?: MailgunOptions) => Promise<void>;
+export declare const resetClient: () => void;
+export type { SendInput as SendOptions };

package/index.js

@@ -0,0 +1,109 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resetClient = exports.send = void 0;
+const mailgun_js_1 = __importDefault(require("mailgun.js"));
+const form_data_1 = __importDefault(require("form-data"));
+const _12factor_env_1 = require("12factor-env");
+let cachedEnvConfig;
+const getEnvConfig = () => {
+    if (cachedEnvConfig) {
+        return cachedEnvConfig;
+    }
+    cachedEnvConfig = (0, _12factor_env_1.env)(process.env, {
+        MAILGUN_KEY: (0, _12factor_env_1.str)()
+    }, {
+        MAILGUN_DOMAIN: (0, _12factor_env_1.host)(),
+        MAILGUN_FROM: (0, _12factor_env_1.email)(),
+        MAILGUN_REPLY: (0, _12factor_env_1.email)()
+    });
+    return cachedEnvConfig;
+};
+// MAILGUN_DEV_EMAIL is read directly from process.env (not validated by 12factor-env)
+// to match the original behavior where it was accessed but not in the env validation
+const getEnvOptions = () => {
+    const envConfig = getEnvConfig();
+    return {
+        key: envConfig.MAILGUN_KEY,
+        domain: envConfig.MAILGUN_DOMAIN,
+        from: envConfig.MAILGUN_FROM,
+        replyTo: envConfig.MAILGUN_REPLY,
+        devEmail: process.env.MAILGUN_DEV_EMAIL
+    };
+};
+let client;
+let cachedMailgunOpts;
+const getClient = (overrides) => {
+    const envOpts = getEnvOptions();
+    const mailgunOpts = {
+        ...envOpts,
+        ...overrides
+    };
+    if (!client || overrides) {
+        if (!mailgunOpts.key) {
+            throw new Error('Missing MAILGUN_KEY');
+        }
+        if (!mailgunOpts.domain) {
+            throw new Error('Missing MAILGUN_DOMAIN');
+        }
+        const mailgun = new mailgun_js_1.default(form_data_1.default);
+        client = mailgun.client({
+            username: 'api',
+            key: mailgunOpts.key
+        });
+        cachedMailgunOpts = mailgunOpts;
+    }
+    return { client, mailgunOpts: cachedMailgunOpts ?? mailgunOpts };
+};
+const resolveFrom = (from, mailgunOpts) => {
+    const resolved = from ?? mailgunOpts.from;
+    if (!resolved) {
+        throw new Error('Missing from address. Set MAILGUN_FROM or pass from in send().');
+    }
+    return resolved;
+};
+const resolveRecipient = (to, mailgunOpts) => {
+    const devEmail = mailgunOpts.devEmail;
+    if (!devEmail) {
+        return to;
+    }
+    const [localPart, domainPart] = devEmail.split('@');
+    const recipients = Array.isArray(to) ? to : [to];
+    return recipients.map(recipient => {
+        const encodedRecipient = recipient.replace('@', '_at_');
+        return `${localPart}+${encodedRecipient}@${domainPart}`;
+    });
+};
+const send = async (options, mailgunOverrides) => {
+    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 { client: mailgunClient, mailgunOpts } = getClient(mailgunOverrides);
+    const to = resolveRecipient(options.to, mailgunOpts);
+    const from = resolveFrom(options.from, mailgunOpts);
+    const replyTo = options.replyTo ?? mailgunOpts.replyTo;
+    const messageData = {
+        to: Array.isArray(to) ? to.join(',') : to,
+        from,
+        subject: options.subject,
+        ...(options.html && { html: options.html }),
+        ...(options.text && { text: options.text }),
+        ...(replyTo && { 'h:Reply-To': replyTo })
+    };
+    await mailgunClient.messages.create(mailgunOpts.domain, messageData);
+};
+exports.send = send;
+const resetClient = () => {
+    client = undefined;
+    cachedMailgunOpts = undefined;
+    cachedEnvConfig = undefined;
+};
+exports.resetClient = resetClient;

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@constructive-io/postmaster",
+  "version": "1.0.0",
+  "author": "Constructive <developers@constructive.io>",
+  "description": "Mailgun 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"
+  },
+  "dependencies": {
+    "12factor-env": "^1.0.0",
+    "form-data": "^4.0.0",
+    "mailgun.js": "^10.2.3"
+  },
+  "devDependencies": {
+    "makage": "^0.1.10"
+  },
+  "keywords": [
+    "mailgun",
+    "email",
+    "postmaster"
+  ],
+  "gitHead": "390f4dd57fc158554518ec454bf2a4856d550552"
+}