@constructive-io/simple-email-fn 0.3.1

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,152 @@
+# @constructive-io/simple-email-fn
+
+Simple Knative-compatible email function used with the Constructive jobs system.
+
+This function is intentionally minimal: it reads an email payload from the job
+body and **logs it only** in dry‑run mode. When not in dry‑run, it sends via
+the configured email provider. This is useful while wiring up jobs and Knative
+without needing a real mail provider configured.
+
+## Expected job payload
+
+Jobs should use `task_identifier = 'simple-email'` (or whatever route you
+configure at your Knative gateway) and a JSON payload like:
+
+```json
+{
+  "to": "user@example.com",
+  "subject": "Welcome!",
+  "html": "<p>Welcome to our app</p>"
+}
+```
+
+Supported fields:
+
+- `to` (string, required)
+- `subject` (string, required)
+- `html` (string, optional)
+- `text` (string, optional)
+- `from` (string, optional)
+- `replyTo` (string, optional)
+
+At least one of `html` or `text` must be provided. If required fields are
+missing, the function throws and the error is propagated via the
+`@constructive-io/knative-job-fn` wrapper as a job error.
+
+## HTTP contract (with knative-job-worker)
+
+The function is wrapped by `@constructive-io/knative-job-fn`, so it expects:
+
+- HTTP method: `POST`
+- Body: JSON job payload (see above)
+- Headers (set by `@constructive-io/knative-job-worker`):
+  - `X-Worker-Id`
+  - `X-Job-Id`
+  - `X-Database-Id`
+  - `X-Callback-Url`
+
+The handler:
+
+1. Reads the email data directly from the request body.
+2. Logs the email metadata (to/subject/from, and whether html/text are present)
+   and the full payload.
+3. Responds with HTTP 200 and:
+
+```json
+{ "complete": true }
+```
+
+Errors bubble into the error middleware installed by
+`@constructive-io/knative-job-fn`, so they are translated into an `X-Job-Error`
+callback for the worker.
+
+## Environment variables
+
+Email provider configuration is only required when not running in dry‑run mode.
+
+Optional:
+
+- `SIMPLE_EMAIL_DRY_RUN` (`true`/`false`): log only, skip send.
+- `EMAIL_SEND_USE_SMTP` (`true`/`false`): use SMTP (`simple-smtp-server`).
+
+Mailgun (`@launchql/postmaster`) env vars when `EMAIL_SEND_USE_SMTP` is false:
+
+- `MAILGUN_API_KEY`
+- `MAILGUN_DOMAIN`
+- `MAILGUN_FROM`
+
+SMTP env vars when `EMAIL_SEND_USE_SMTP` is true:
+
+- `SMTP_HOST`
+- `SMTP_PORT`
+- `SMTP_USER`
+- `SMTP_PASS`
+- `SMTP_FROM`
+
+## Building locally
+
+From the repo root:
+
+```bash
+pnpm --filter="@constructive-io/simple-email-fn" build
+```
+
+This compiles TypeScript into `dist/`.
+
+---
+
+## 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/index.d.ts

@@ -0,0 +1,2 @@
+declare const app: any;
+export default app;

package/index.js

@@ -0,0 +1,76 @@
+import { createJobApp } from '@constructive-io/knative-job-fn';
+import { send as sendSmtp } from 'simple-smtp-server';
+import { send as sendPostmaster } from '@launchql/postmaster';
+import { parseEnvBoolean } from '@pgpmjs/env';
+import { createLogger } from '@pgpmjs/logger';
+const isNonEmptyString = (value) => typeof value === 'string' && value.trim().length > 0;
+const getRequiredField = (payload, field) => {
+    const value = payload[field];
+    if (!isNonEmptyString(value)) {
+        throw new Error(`Missing required field '${String(field)}'`);
+    }
+    return value;
+};
+const isDryRun = parseEnvBoolean(process.env.SIMPLE_EMAIL_DRY_RUN) ?? false;
+const useSmtp = parseEnvBoolean(process.env.EMAIL_SEND_USE_SMTP) ?? false;
+const logger = createLogger('simple-email');
+const app = createJobApp();
+app.post('/', async (req, res, next) => {
+    try {
+        const payload = (req.body || {});
+        const to = getRequiredField(payload, 'to');
+        const subject = getRequiredField(payload, 'subject');
+        const html = isNonEmptyString(payload.html) ? payload.html : undefined;
+        const text = isNonEmptyString(payload.text) ? payload.text : undefined;
+        if (!html && !text) {
+            throw new Error("Either 'html' or 'text' must be provided");
+        }
+        const fromEnv = useSmtp ? process.env.SMTP_FROM : process.env.MAILGUN_FROM;
+        const from = isNonEmptyString(payload.from)
+            ? payload.from
+            : isNonEmptyString(fromEnv)
+                ? fromEnv
+                : undefined;
+        const replyTo = isNonEmptyString(payload.replyTo)
+            ? payload.replyTo
+            : undefined;
+        const logContext = {
+            to,
+            subject,
+            from,
+            replyTo,
+            hasHtml: Boolean(html),
+            hasText: Boolean(text)
+        };
+        if (isDryRun) {
+            logger.info('DRY RUN email (no send)', logContext);
+        }
+        else {
+            // Send via the Postmaster package (Mailgun or configured provider)
+            const sendEmail = useSmtp ? sendSmtp : sendPostmaster;
+            await sendEmail({
+                to,
+                subject,
+                ...(html && { html }),
+                ...(text && { text }),
+                ...(from && { from }),
+                ...(replyTo && { replyTo })
+            });
+            logger.info('Sent email', logContext);
+        }
+        res.status(200).json({ complete: true });
+    }
+    catch (err) {
+        next(err);
+    }
+});
+export default app;
+// When executed directly (e.g. `node dist/index.js` in Knative),
+// start an HTTP server on the provided PORT (default 8080).
+if (require.main === module) {
+    const port = Number(process.env.PORT ?? 8080);
+    // @constructive-io/knative-job-fn exposes a .listen method that delegates to the underlying Express app
+    app.listen(port, () => {
+        logger.info(`listening on port ${port}`);
+    });
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@constructive-io/simple-email-fn",
+  "version": "0.3.1",
+  "description": "Simple Knative email function that sends emails directly from job payload",
+  "author": "Constructive <developers@constructive.io>",
+  "homepage": "https://github.com/constructive-io/constructive",
+  "license": "MIT",
+  "main": "index.js",
+  "module": "esm/index.js",
+  "types": "index.d.ts",
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/constructive-io/constructive"
+  },
+  "bugs": {
+    "url": "https://github.com/constructive-io/constructive/issues"
+  },
+  "directories": {
+    "lib": "src",
+    "test": "__tests__"
+  },
+  "scripts": {
+    "clean": "makage clean",
+    "prepack": "npm run build",
+    "build": "makage build",
+    "build:dev": "makage build --dev"
+  },
+  "devDependencies": {
+    "makage": "^0.1.10"
+  },
+  "dependencies": {
+    "@constructive-io/knative-job-fn": "^0.3.1",
+    "@launchql/postmaster": "0.1.4",
+    "@pgpmjs/env": "^2.10.0",
+    "@pgpmjs/logger": "^1.4.0",
+    "simple-smtp-server": "^0.2.0"
+  },
+  "gitHead": "3ffd5718e86ea5fa9ca6e0930aeb510cf392f343"
+}