neon 5.0.1 → 6.1.0

package/dist/update_notifier.js

@@ -0,0 +1,145 @@
+import { isCi } from "./env.js";
+import { log } from "./log.js";
+import { recommendedCliUpgradeCommand } from "./utils/package_manager.js";
+import { existsSync, readFileSync, renameSync, rmSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+import { fileURLToPath } from "node:url";
+import { spawn } from "node:child_process";
+import semver from "semver";
+//#region src/update_notifier.ts
+const CHECK_INTERVAL_MS = 864e5;
+const NOTIFY_INTERVAL_MS = 3 * CHECK_INTERVAL_MS;
+const CACHE_FILE = "update-check.json";
+const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+const parseUpdateCheckCache = (raw) => {
+	try {
+		const value = JSON.parse(raw);
+		if (!isRecord(value) || typeof value.checkedAt !== "number" || !Number.isFinite(value.checkedAt) || value.source !== "homebrew" && value.source !== "npm" || value.latestVersion !== void 0 && typeof value.latestVersion !== "string" || value.notifiedAt !== void 0 && (typeof value.notifiedAt !== "number" || !Number.isFinite(value.notifiedAt))) return;
+		return {
+			checkedAt: value.checkedAt,
+			source: value.source,
+			...value.latestVersion === void 0 ? {} : { latestVersion: value.latestVersion },
+			...value.notifiedAt === void 0 ? {} : { notifiedAt: value.notifiedAt }
+		};
+	} catch {
+		return;
+	}
+};
+const readUpdateCheckCache = (cachePath) => {
+	try {
+		return parseUpdateCheckCache(readFileSync(cachePath, "utf8"));
+	} catch {
+		return;
+	}
+};
+const writeUpdateCheckCache = (cachePath, cache) => {
+	const temporaryPath = `${cachePath}.${process.pid}.tmp`;
+	try {
+		writeFileSync(temporaryPath, `${JSON.stringify(cache)}\n`, { mode: 384 });
+		renameSync(temporaryPath, cachePath);
+		return true;
+	} catch (error) {
+		try {
+			rmSync(temporaryPath, { force: true });
+		} catch {}
+		log.debug("Could not write the CLI update cache: %s", error instanceof Error ? error.message : String(error));
+		return false;
+	}
+};
+const formatUpdateNotice = ({ currentVersion, latestVersion, upgradeCommand }) => {
+	if (semver.valid(currentVersion) === null || semver.valid(latestVersion) === null || !semver.gt(latestVersion, currentVersion)) return;
+	return `Neon CLI update available: ${currentVersion} → ${latestVersion}\n${upgradeCommand}`;
+};
+const shouldRefreshUpdateCheck = (cache, now) => cache === void 0 || now - cache.checkedAt >= CHECK_INTERVAL_MS;
+const cacheForUpdateSource = (cache, source) => cache?.source === source ? cache : void 0;
+const isCurrentBranchProbe = ({ commandPath, currentBranch }) => currentBranch && (commandPath[0] === "status" || commandPath[0] === "config" && commandPath[1] === "status");
+const updateSource = (command) => command.startsWith("brew ") ? "homebrew" : "npm";
+const spawnUpdateWorkerProcess = ({ cachePath, executablePath, source, workerPath }) => {
+	const child = spawn(executablePath, [
+		workerPath,
+		cachePath,
+		source
+	], {
+		detached: true,
+		stdio: "ignore",
+		windowsHide: true
+	});
+	child.on("error", (error) => {
+		log.debug("CLI update check failed to start: %s", error.message);
+	});
+	child.unref();
+	return child;
+};
+const spawnUpdateWorker = (cachePath, source) => {
+	const workerPath = fileURLToPath(new URL("./update_check_worker.js", import.meta.url));
+	if (!existsSync(workerPath)) return;
+	try {
+		spawnUpdateWorkerProcess({
+			cachePath,
+			executablePath: process.execPath,
+			source,
+			workerPath
+		});
+	} catch (error) {
+		log.debug("Could not start the CLI update check: %s", error instanceof Error ? error.message : String(error));
+	}
+};
+const isPackagedExecutable = () => "pkg" in process;
+const shouldRunUpdateNotifier = ({ commandPath, currentBranch, disabled, isCi: runningInCi, isPackaged, output, stderrIsTty, stdoutIsTty }) => !runningInCi && !disabled && !isPackaged && output === "table" && stdoutIsTty && stderrIsTty && commandPath.length > 0 && commandPath[0] !== "completion" && !isCurrentBranchProbe({
+	commandPath,
+	currentBranch
+});
+const notifyIfUpdateAvailable = ({ commandPath, configDir, currentBranch, currentVersion, output }) => {
+	if (!shouldRunUpdateNotifier({
+		commandPath,
+		currentBranch,
+		disabled: "NO_UPDATE_NOTIFIER" in process.env,
+		isCi: isCi(),
+		isPackaged: isPackagedExecutable(),
+		output,
+		stderrIsTty: process.stderr.isTTY === true,
+		stdoutIsTty: process.stdout.isTTY === true
+	})) return;
+	const command = recommendedCliUpgradeCommand(fileURLToPath(import.meta.url));
+	if (command === void 0) return;
+	const cachePath = join(configDir, CACHE_FILE);
+	const now = Date.now();
+	const source = updateSource(command);
+	const cache = cacheForUpdateSource(readUpdateCheckCache(cachePath), source);
+	let nextCache = cache;
+	if (cache?.latestVersion !== void 0 && (cache.notifiedAt === void 0 || now - cache.notifiedAt >= NOTIFY_INTERVAL_MS)) {
+		const notice = formatUpdateNotice({
+			currentVersion,
+			latestVersion: cache.latestVersion,
+			upgradeCommand: command
+		});
+		if (notice !== void 0) {
+			log.warning("%s", notice);
+			nextCache = {
+				...cache,
+				notifiedAt: now
+			};
+		}
+	}
+	if (!shouldRefreshUpdateCheck(cache, now)) {
+		if (nextCache !== cache && nextCache !== void 0) writeUpdateCheckCache(cachePath, nextCache);
+		return;
+	}
+	nextCache = {
+		...nextCache,
+		checkedAt: now,
+		source
+	};
+	if (writeUpdateCheckCache(cachePath, nextCache)) spawnUpdateWorker(cachePath, source);
+};
+const recordLatestVersion = (cachePath, source, latestVersion) => {
+	if (semver.valid(latestVersion) === null) return;
+	const cache = cacheForUpdateSource(readUpdateCheckCache(cachePath), source);
+	if (cache === void 0) return;
+	writeUpdateCheckCache(cachePath, {
+		...cache,
+		latestVersion
+	});
+};
+//#endregion
+export { cacheForUpdateSource, formatUpdateNotice, notifyIfUpdateAvailable, parseUpdateCheckCache, recordLatestVersion, shouldRefreshUpdateCheck, shouldRunUpdateNotifier, spawnUpdateWorkerProcess, writeUpdateCheckCache };

package/dist/utils/package_manager.js

@@ -159,6 +159,13 @@ const resolvePackageManager = (cwd) => inferPackageManager(cwd) ?? installedPack
 * as {@link resolvePackageManager} minus the lockfile walk.
 */
 const resolveInvokingPackageManager = () => detectInvokingPackageManager() ?? installedPackageManagers()[0] ?? "npm";
+const recommendedCliUpgradeCommand = (modulePath) => {
+	const path = modulePath.replace(/\\/g, "/").toLowerCase();
+	if (path.includes("/cellar/neonctl/")) return "brew upgrade neonctl";
+	if (path.includes("/.bun/install/global/node_modules/neon/")) return "bun i -g neon@latest";
+	if (path.includes("/pnpm/global/") && path.includes("/.pnpm/neon@") && path.includes("/node_modules/neon/")) return "pnpm i -g neon@latest";
+	if (path.includes("/lib/node_modules/neon/") || path.includes("/npm/node_modules/neon/")) return "npm i -g neon@latest";
+};
 /**
 * The argv for an install with `pm`: every dependency in the manifest when
 * `packages` is empty, otherwise those packages added to it. npm spells the add
@@ -326,4 +333,4 @@ const runCommand = (cmd, args, cwd, env) => new Promise((resolvePromise) => {
 	});
 });
 //#endregion
-export { DO_NOT_SUBSTITUTE_HINT, MISSING_BINARY_HINT, commandEnv, detectInvokingPackageManager, detectProjectPackageManager, formatExecCommand, formatInstallCommand, globalInstallCommand, inferPackageManager, installArgs, installedPackageManagers, resolveInvokingPackageManager, resolvePackageManager, runCommand };
+export { DO_NOT_SUBSTITUTE_HINT, MISSING_BINARY_HINT, commandEnv, detectInvokingPackageManager, detectProjectPackageManager, formatExecCommand, formatInstallCommand, globalInstallCommand, inferPackageManager, installArgs, installedPackageManagers, recommendedCliUpgradeCommand, resolveInvokingPackageManager, resolvePackageManager, runCommand };

package/dist/utils/service_picker.js

@@ -2,9 +2,30 @@ import { CONFIG_INIT_SERVICES } from "../config_template.js";
 import prompts from "prompts";
 //#region src/utils/service_picker.ts
 /**
-* The picker's rows, in {@link CONFIG_INIT_SERVICES} order. Titles use the product names from
-* the CLI's README ("Managed Better Auth", "Object Storage") rather than the `neon.ts` field
-* names, since this is the list a user reads before they've seen a policy.
+* Re-select Postgres after each render. `prompts` lets space unselect a selected
+* row even when `disabled` is set, and `disabled` also strikethroughs the title.
+*/
+const keepPostgresSelected = (prompt) => {
+	if (typeof prompt !== "object" || prompt === null || !("value" in prompt)) return;
+	const rows = prompt.value;
+	if (!Array.isArray(rows)) return;
+	for (const row of rows) {
+		if (!isChoiceRow(row) || row.value !== "postgres") continue;
+		row.selected = true;
+	}
+};
+const isChoiceRow = (row) => typeof row === "object" && row !== null && "value" in row && "selected" in row;
+const POSTGRES_SERVICE_CHOICE = {
+	value: "postgres",
+	title: "Postgres (always included)",
+	description: "Every Neon project includes a Postgres database.",
+	selected: true
+};
+/**
+* The picker's rows, in {@link CONFIG_INIT_SERVICES} order after the locked Postgres
+* row. Titles use the product names from the CLI's README ("Managed Better Auth",
+* "Object Storage") rather than the `neon.ts` field names, since this is the list a
+* user reads before they've seen a policy.
 */
 const CHOICES = [
 	{
@@ -41,7 +62,7 @@ const CHOICES = [
 * Callers guard the TTY themselves (see `initCmd`); this function assumes it may prompt.
 */
 const pickServicesInteractively = async () => {
-	const { services } = await prompts({
+	const question = {
 		onState: (state) => {
 			if (state.aborted) {
 				process.stdout.write("\x1B[?25h");
@@ -49,18 +70,23 @@ const pickServicesInteractively = async () => {
 				process.exit(1);
 			}
 		},
+		onRender() {
+			keepPostgresSelected(this);
+		},
 		type: "multiselect",
 		name: "services",
 		message: "Which Neon services should neon.ts declare? (space to toggle, enter to confirm)",
 		instructions: false,
-		choices: CHOICES.map((choice) => ({
+		cursor: 1,
+		choices: [POSTGRES_SERVICE_CHOICE, ...CHOICES.map((choice) => ({
 			value: choice.value,
 			title: choice.title,
 			description: choice.description
-		}))
-	});
+		}))]
+	};
+	const { services } = await prompts(question);
 	if (!Array.isArray(services)) throw new Error("Aborted: no services selected.");
 	return CONFIG_INIT_SERVICES.filter((service) => services.includes(service));
 };
 //#endregion
-export { pickServicesInteractively };
+export { POSTGRES_SERVICE_CHOICE, keepPostgresSelected, pickServicesInteractively };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neon",
-  "version": "5.0.1",
+  "version": "6.1.0",
   "description": "CLI tool for Neon, the cloud backend primitives built around Lakebase Postgres",
   "keywords": [
     "neon",
@@ -58,14 +58,15 @@
     "pg-protocol": "^1.14.0",
     "picocolors": "^1.1.1",
     "prompts": "2.4.2",
+    "semver": "7.7.2",
     "undici": "^7.28.0",
     "which": "3.0.1",
     "yaml": "^2.9.0",
     "yargs": "17.7.2",
     "yoctocolors": "^2.1.2",
-    "@neon/config": "1.7.2",
-    "@neon/sdk": "6.0.0",
-    "@neon/config-runtime": "1.6.2"
+    "@neon/config-runtime": "1.6.3",
+    "@neon/config": "1.7.3",
+    "@neon/sdk": "6.1.0"
   },
   "optionalDependencies": {
     "@napi-rs/keyring": "1.3.0",
@@ -82,6 +83,7 @@
     "@types/express": "4.17.21",
     "@types/node": "^20.19.0",
     "@types/prompts": "2.4.9",
+    "@types/semver": "7.7.1",
     "@types/which": "3.0.4",
     "@types/yargs": "^17.0.35",
     "@vitest/coverage-v8": "^3.0.9",
@@ -98,7 +100,7 @@
     "typescript": "^5.9.0",
     "vitest": "^3.0.9",
     "@neon-internals/cli-core": "0.0.0",
-    "@neon-internals/env-core": "0.0.21",
+    "@neon-internals/env-core": "0.0.22",
     "@neon/e2e-harness": "0.0.0",
     "@neon/functions": "0.11.0"
   },

package/dist/init/child.js

@@ -1,37 +0,0 @@
-import { spawn } from "node:child_process";
-//#region src/init/child.ts
-const AUTH_CHILD = /* @__PURE__ */ new Set([
-	"bootstrap",
-	"link",
-	"mcp",
-	"env"
-]);
-const initChildEnv = (command, overlay, base = process.env) => {
-	const child = { ...base };
-	if (command === void 0 || !AUTH_CHILD.has(command)) {
-		for (const key of Object.keys(child)) if (key.toUpperCase() === "NEON_API_KEY") delete child[key];
-	}
-	return overlay ? {
-		...child,
-		...overlay
-	} : child;
-};
-const spawnCliChild = async (argv, cwd, overlay) => {
-	const cli = process.argv[1];
-	if (!cli) throw new Error("Cannot re-exec the Neon CLI: process.argv[1] is missing.");
-	return new Promise((resolve) => {
-		const child = spawn(process.execPath, [cli, ...argv], {
-			cwd,
-			stdio: "inherit",
-			env: initChildEnv(argv[0], overlay)
-		});
-		child.on("error", () => {
-			resolve(false);
-		});
-		child.on("close", (code) => {
-			resolve(code === 0);
-		});
-	});
-};
-//#endregion
-export { AUTH_CHILD, initChildEnv, spawnCliChild };

package/dist/plugins/wizard.js

@@ -1,36 +0,0 @@
-import { getAgentDisplayName } from "../mcp/agents.js";
-import "../init/agents.js";
-import { canPickAgentsInteractively } from "../utils/agent_picker.js";
-import { NEON_PLUGIN_NAME } from "./run.js";
-import prompts from "prompts";
-//#region src/plugins/wizard.ts
-const restoreCursorOnAbort = (state) => {
-	if (state.aborted) {
-		process.stdout.write("\x1B[?25h");
-		process.stdout.write("\n");
-		process.exit(1);
-	}
-};
-const pluginsInstallSummary = (options) => {
-	const rows = [
-		["Scope", options.scope === "project" ? "project" : "user"],
-		["Agents", options.agents.map(getAgentDisplayName).join(", ")],
-		["Plugin", NEON_PLUGIN_NAME]
-	];
-	const labelWidth = Math.max(...rows.map(([label]) => label.length));
-	return rows.map(([label, value]) => `${label.padEnd(labelWidth)}  ${value}`).join("\n");
-};
-const confirmPluginsInstall = async (options) => {
-	if (!canPickAgentsInteractively()) return true;
-	process.stdout.write(`\n${pluginsInstallSummary(options)}\n\n`);
-	const { ok } = await prompts({
-		onState: restoreCursorOnAbort,
-		type: "confirm",
-		name: "ok",
-		message: "Install the Neon plugin into these agents?",
-		initial: true
-	});
-	return ok === true;
-};
-//#endregion
-export { confirmPluginsInstall, pluginsInstallSummary };