@neondatabase/functions 0.0.0

package/README.md

@@ -0,0 +1,28 @@
+# @neondatabase/functions
+
+Runtime helpers for [Neon Functions](https://neon.com). Currently provides a `waitUntil` primitive for deferring background work past a response.
+
+## Install
+
+```bash
+npm install @neondatabase/functions
+```
+
+## Usage
+
+```ts
+import { waitUntil } from "@neondatabase/functions/v1";
+
+export default {
+	async fetch(req: Request): Promise<Response> {
+		const defer = waitUntil();
+		// Fire-and-forget background work that should outlive the response.
+		defer(logRequest(req));
+		return new Response("ok");
+	},
+};
+```
+
+> **Status: not implemented yet.** `waitUntil()` currently returns a no-op function — the
+> promise you pass is accepted and ignored. Once the Neon Functions runtime ships, it will
+> register the promise with the host so the invocation stays alive until it settles.

package/package.json

@@ -0,0 +1,22 @@
+{
+	"name": "@neondatabase/functions",
+	"version": "0.0.0",
+	"description": "Runtime helpers for Neon Functions. Currently provides a `waitUntil` primitive for deferring async work past a response.",
+	"keywords": [
+		"neon",
+		"database",
+		"postgres",
+		"functions",
+		"serverless",
+		"platform"
+	],
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/neondatabase/neon-pkgs.git"
+	},
+	"license": "Apache-2.0",
+	"author": {
+		"name": "Neon",
+		"url": "https://neon.com"
+	}
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+/**
+ * The default entry point re-exports the latest stable version. New consumers should import
+ * directly from `@neondatabase/functions/v1` to opt in to a specific major.
+ */
+export * from "./v1.js";

package/src/lib/wait-until.ts

@@ -0,0 +1,21 @@
+/**
+ * `waitUntil` extends the lifetime of a Neon Function invocation so background work
+ * (logging, cache writes, analytics, …) can finish after the response has been sent.
+ *
+ * It mirrors the platform primitive exposed by Cloudflare Workers / Vercel
+ * (`ctx.waitUntil(promise)`).
+ */
+export type WaitUntil = (promise: Promise<unknown>) => void;
+
+/**
+ * Returns a `waitUntil` function for the current invocation.
+ *
+ * NOT IMPLEMENTED YET: this is a no-op placeholder. The returned function accepts a
+ * promise and ignores it. Once the Neon Functions runtime ships, this will register the
+ * promise with the host so the invocation stays alive until it settles.
+ */
+export function waitUntil(): WaitUntil {
+	return (_promise: Promise<unknown>): void => {
+		// no-op: the runtime integration is not implemented yet.
+	};
+}

package/src/v1.ts

@@ -0,0 +1,9 @@
+/**
+ * `@neondatabase/functions/v1` — runtime helpers for Neon Functions.
+ *
+ * - `waitUntil()` — returns a function that defers async work past the response.
+ *   Currently a no-op placeholder; the runtime integration is not implemented yet.
+ */
+
+export type { WaitUntil } from "./lib/wait-until.js";
+export { waitUntil } from "./lib/wait-until.js";

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+	"extends": "../../tsconfig.base.json",
+	"include": ["src", "vitest.config.ts", "tsdown.config.ts"]
+}

package/tsdown.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from "tsdown";
+
+export default defineConfig({
+	name: "@neondatabase/functions",
+	bundle: false,
+	clean: true,
+	dts: true,
+	entry: ["src/index.ts", "src/v1.ts", "src/lib/**/*.ts", "!src/**/*.test.*"],
+	format: "esm",
+	outDir: "dist",
+	treeshake: true,
+});

package/vitest.config.ts

@@ -0,0 +1,17 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+	test: {
+		clearMocks: true,
+		mockReset: true,
+		unstubEnvs: true,
+		coverage: {
+			all: true,
+			include: ["src"],
+			exclude: ["src/**/*.test.ts"],
+			reporter: ["html", "lcov"],
+		},
+		exclude: ["lib", "node_modules", "dist"],
+		setupFiles: ["console-fail-test/setup"],
+	},
+});