neonctl 2.23.0 → 2.24.0

package/commands/env.js

@@ -0,0 +1,67 @@
+import { NEON_ENV_VAR_KEYS } from '@neondatabase/env';
+import { log } from '../log.js';
+import { resolveNeonEnvVars } from '../dev/env.js';
+import { mergeEnvFile, resolveEnvFilePath } from '../env_file.js';
+import { branchIdFromProps, fillSingleProject } from '../utils/enrichers.js';
+export const command = 'env';
+export const describe = "Manage a branch's Neon env variables locally";
+export const builder = (argv) => argv
+    .usage('$0 env <sub-command> [options]')
+    .options({
+    'project-id': { describe: 'Project ID', type: 'string' },
+    branch: { describe: 'Branch ID or name', type: 'string' },
+})
+    .middleware(fillSingleProject)
+    .command('pull', "Write the branch's Neon env variables to a local .env file", (yargs) => yargs
+    .usage('$0 env pull [options]')
+    .options({
+    file: {
+        describe: 'Target .env file to write. Defaults to an existing .env, ' +
+            'otherwise .env.local. Only Neon variables are updated; other ' +
+            'lines are preserved.',
+        type: 'string',
+    },
+})
+    .example('$0 env pull', "Write the linked branch's Neon vars into .env.local (or .env if present)")
+    .example('$0 env pull --branch preview --file .env.preview', 'Pull a specific branch into a specific file'), (args) => pull(args))
+    .demandCommand(1);
+export const handler = (args) => args;
+/** Every OS-level env var name `@neondatabase/env` can emit, used only for reporting. */
+const NEON_VAR_NAMES = Object.values(NEON_ENV_VAR_KEYS).flatMap((group) => Object.values(group));
+export const pull = async (props) => {
+    const cwd = props.cwd ?? process.cwd();
+    const branchId = await branchIdFromProps(props);
+    // Reuse `neon dev`'s tiered resolver (neon.ts policy -> plan gate -> fetchEnv, else
+    // pullConfig -> fetchEnv). Unlike dev, an unresolved context or failure is surfaced —
+    // `env pull` is an explicit action, so it should error rather than write nothing.
+    const vars = await resolveNeonEnvVars({
+        cwd,
+        projectId: props.projectId,
+        branchId,
+        ...(props.apiKey ? { apiKey: props.apiKey } : {}),
+        ...(props.runtimeApi ? { api: props.runtimeApi } : {}),
+    });
+    const neonVars = pickNeonVars(vars);
+    if (Object.keys(neonVars).length === 0) {
+        log.info('No Neon env variables to pull for this branch (no DATABASE_URL or ' +
+            'enabled Auth / Data API).');
+        return;
+    }
+    const targetPath = resolveEnvFilePath(cwd, props.file);
+    const { written } = mergeEnvFile(targetPath, neonVars);
+    log.info('Pulled %d Neon variable%s into %s: %s', written.length, written.length === 1 ? '' : 's', targetPath, written.join(', '));
+};
+/**
+ * Keep only the recognized Neon variables from the resolved set, so a stray inherited
+ * value never lands in the user's `.env` file. (Today `resolveNeonEnvVars` only emits Neon
+ * vars, but filtering keeps the contract explicit and future-proof.)
+ */
+const pickNeonVars = (vars) => {
+    const out = {};
+    for (const name of NEON_VAR_NAMES) {
+        const value = vars[name];
+        if (value !== undefined)
+            out[name] = value;
+    }
+    return out;
+};

package/commands/functions.js

@@ -21,9 +21,8 @@ const DEPLOYMENT_FIELDS = [
     'memory_mib',
     'created_at',
 ];
-const SLUG_PATTERN = /^[a-z0-9]([a-z0-9-]{0,38}[a-z0-9])?$/;
-const SLUG_HELP = 'Use 1-40 lowercase letters, digits, and hyphens; it must start and end with a letter or digit.';
-const MEMORY_CHOICES = [256, 512, 1024, 2048, 4096, 8192];
+const SLUG_PATTERN = /^[a-z0-9]{1,20}$/;
+const SLUG_HELP = 'Use 1-20 lowercase letters and digits (no hyphens or other characters).';
 // Overridable so tests can poll fast; defaults to 2s in real use.
 const POLL_INTERVAL_MS = Number(process.env.NEON_FUNCTIONS_POLL_INTERVAL_MS) || 2000;
 // Upper bound on --wait polling so the CLI never hangs (e.g. if our deployment
@@ -48,7 +47,7 @@ export const builder = (argv) => argv
     .middleware(fillSingleProject)
     .command('deploy <slug>', 'Deploy a function from a local directory', (yargs) => yargs
     .positional('slug', {
-    describe: 'Function slug (lowercase DNS label)',
+    describe: 'Function slug (1-20 lowercase letters and digits)',
     type: 'string',
     demandOption: true,
 })
@@ -61,11 +60,6 @@ export const builder = (argv) => argv
         describe: 'Entry file to bundle, relative to --path',
         type: 'string',
     },
-    'memory-mib': {
-        describe: 'Memory in MiB',
-        type: 'number',
-        choices: MEMORY_CHOICES,
-    },
     runtime: {
         describe: 'Function runtime',
         type: 'string',
@@ -122,7 +116,6 @@ const deploy = async (props) => {
     const hasOption = props.path !== undefined ||
         props.entry !== undefined ||
         props.env !== undefined ||
-        props.memoryMib !== undefined ||
         props.runtime !== undefined;
     if (!hasOption) {
         throw new Error('Provide at least one option to deploy, e.g. --path, --entry, or --env. ' +
@@ -134,7 +127,6 @@ const deploy = async (props) => {
     }
     const path = props.path ?? '.';
     const entry = props.entry ?? 'index.ts';
-    const memoryMib = props.memoryMib ?? 256;
     const runtime = props.runtime ?? 'nodejs24';
     const environment = parseEnv(props.env);
     const source = join(path, entry);
@@ -157,7 +149,6 @@ const deploy = async (props) => {
     }
     await retryOnLock(() => createDeployment(props.apiClient, props.projectId, branchId, props.slug, {
         zip,
-        memoryMib,
         runtime,
         environment,
     }));

package/commands/index.js

@@ -17,6 +17,10 @@ import * as init from './init.js';
 import * as dataApi from './data_api.js';
 import * as neonAuth from './neon_auth.js';
 import * as functions from './functions.js';
+import * as dev from './dev.js';
+import * as config from './config.js';
+import * as deploy from './deploy.js';
+import * as env from './env.js';
 export default [
     auth,
     users,
@@ -37,4 +41,8 @@ export default [
     init,
     dataApi,
     functions,
+    dev,
+    config,
+    deploy,
+    env,
 ];

package/commands/link.js

@@ -303,19 +303,21 @@ const promptOrgFromList = async (orgs) => {
 };
 const promptProjectChoice = async (projects, suggestedName) => {
     const choices = [
+        { title: '＋ Create new project…', value: CREATE_NEW_SENTINEL },
         ...projects.map((project) => ({
             title: `${project.name} (${project.id})`,
             value: project.id,
         })),
-        { title: '+ Create new project', value: CREATE_NEW_SENTINEL },
     ];
+    // Create sits at the top, so default to the first existing project (index 1) when there
+    // is one; with no projects to show, the create option (index 0) is the only choice.
     const { selection } = await prompts({
         onState: onPromptState,
         type: 'select',
         name: 'selection',
         message: 'Which project would you like to link?',
         choices,
-        initial: choices.length === 1 ? 0 : 0,
+        initial: projects.length > 0 ? 1 : 0,
     });
     if (selection === CREATE_NEW_SENTINEL) {
         return { type: 'create', suggestedName };

package/config_format.js

@@ -0,0 +1,66 @@
+/**
+ * Render a TTL in whole seconds back to the canonical `neon.ts` duration string (e.g.
+ * `604800` -> `"7d"`), falling back to seconds when no clean unit boundary matches. Mirrors
+ * the formatter `@neondatabase/config` uses when it emits a TTL, so `config status` shows
+ * the same value a user would write in `neon.ts`.
+ */
+export const formatDurationSeconds = (totalSeconds) => {
+    const units = [
+        ['w', 7 * 24 * 60 * 60],
+        ['d', 24 * 60 * 60],
+        ['h', 60 * 60],
+        ['m', 60],
+    ];
+    for (const [unit, perUnit] of units) {
+        if (totalSeconds % perUnit === 0)
+            return `${totalSeconds / perUnit}${unit}`;
+    }
+    return `${totalSeconds}s`;
+};
+/**
+ * Project a resolved branch config (plus the separately-pulled preview state, since
+ * functions/buckets don't live on the closure) into a {@link NeonConfigView}.
+ *
+ * - Service toggles are surfaced as `true` only when enabled (disabled is the absence of
+ *   the key, exactly as in `neon.ts`).
+ * - `ttlSeconds` is rendered back to a duration string (`7d`).
+ * - The `branch` section is the JSON-able part of what would otherwise be the `branch`
+ *   closure: `parent` / `ttl` / `protected` / `postgres.computeSettings`.
+ * - `branch` and `preview` are omitted entirely when they would be empty.
+ */
+export const toNeonConfigView = (resolved, preview) => {
+    const view = {};
+    if (resolved.authEnabled)
+        view.auth = true;
+    if (resolved.dataApiEnabled)
+        view.dataApi = true;
+    const previewView = toPreviewView(preview);
+    if (previewView)
+        view.preview = previewView;
+    const branch = {};
+    if (resolved.parent !== undefined)
+        branch.parent = resolved.parent;
+    if (resolved.ttlSeconds !== undefined)
+        branch.ttl = formatDurationSeconds(resolved.ttlSeconds);
+    if (resolved.protected !== undefined)
+        branch.protected = resolved.protected;
+    if (resolved.postgres?.computeSettings)
+        branch.postgres = resolved.postgres;
+    if (Object.keys(branch).length > 0)
+        view.branch = branch;
+    return view;
+};
+const toPreviewView = (preview) => {
+    if (!preview)
+        return undefined;
+    const out = {};
+    if (preview.aiGatewayEnabled)
+        out.aiGateway = true;
+    if (preview.functions.length > 0) {
+        out.functions = Object.fromEntries(preview.functions.map((fn) => [fn.slug, { name: fn.name }]));
+    }
+    if (preview.buckets.length > 0) {
+        out.buckets = Object.fromEntries(preview.buckets.map((b) => [b.name, { access: b.access }]));
+    }
+    return Object.keys(out).length > 0 ? out : undefined;
+};

package/dev/env.js

@@ -0,0 +1,183 @@
+import { loadConfigFromFile, } from '@neondatabase/config';
+import { plan, pullConfig, } from '@neondatabase/config-runtime';
+import { fetchEnv, toEntries } from '@neondatabase/env';
+import { log } from '../log.js';
+/**
+ * Thrown when a `neon.ts` policy declares a branch-level resource (Neon Auth,
+ * Data API, a bucket, the AI Gateway) that the linked remote branch does not
+ * have yet. Unlike every other failure in {@link resolveDevEnv} — which degrades
+ * to "run without injection" — this is a hard stop: the user's intent (a policy)
+ * cannot be honored, and silently dropping the secret would be more confusing
+ * than refusing to start. The fix is to provision the resource first.
+ */
+export class DevEnvMismatchError extends Error {
+    constructor() {
+        super(...arguments);
+        this.name = 'DevEnvMismatchError';
+    }
+}
+/**
+ * Signals that no project/branch context could be resolved, so there is nothing to
+ * resolve env from. `resolveDevEnv` degrades on this (dev runs without injection);
+ * `env pull` surfaces it (an explicit pull needs a branch).
+ */
+export class MissingBranchContextError extends Error {
+    constructor() {
+        super(...arguments);
+        this.name = 'MissingBranchContextError';
+    }
+}
+/**
+ * Resolve the branch's Neon env vars (pooled / direct `DATABASE_URL`, plus Auth /
+ * Data API when enabled) into a `{ KEY: value }` map. Shared by `neon dev` (which
+ * injects them) and `neon env pull` (which writes them to a `.env` file).
+ *
+ * Tiered:
+ *
+ *   1. a `neon.ts` policy is found -> the policy is the source of truth. We first
+ *      check it against the branch's live state (`plan`); if it declares a resource
+ *      the branch is missing, we stop with a {@link DevEnvMismatchError} pointing at
+ *      `neonctl deploy`. Otherwise `fetchEnv` evaluates the policy.
+ *   2. no `neon.ts`, but a project + branch are known -> `pullConfig` reads the
+ *      branch's live state (incl. Auth / Data API enablement) into a config, then
+ *      `fetchEnv` resolves what is actually enabled.
+ *   3. otherwise -> throw {@link MissingBranchContextError}.
+ *
+ * Unlike {@link resolveDevEnv}, this never swallows errors — callers decide how to
+ * handle them.
+ */
+export const resolveNeonEnvVars = async (ctx) => {
+    const config = await loadNeonConfig(ctx.cwd);
+    if (config) {
+        if (!ctx.projectId || !ctx.branchId) {
+            throw new MissingBranchContextError('Found a neon.ts but could not resolve the project/branch. ' +
+                'Run `neonctl link` and `neonctl checkout <branch>`, or pass ' +
+                '--project-id / --branch.');
+        }
+        // Resolve env from the policy with its `preview.functions` removed. Functions carry no
+        // branch-level secrets — their env comes from the local `neon.ts` `functions.<slug>.env`,
+        // layered per-function by the dev server — so env resolution never needs the functions
+        // API. Probing it (via `plan`/`fetchEnv`) only adds a failure mode: an undeployed
+        // function, or a project where the Functions Preview isn't enabled, would error and sink
+        // ALL injection (including DATABASE_URL). Stripping functions keeps env resolution honest
+        // while leaving buckets / AI Gateway / Auth / Data API fully checked — those DO carry
+        // secrets, so a declared-but-missing one still hard-stops (see assertPolicyMatchesBranch).
+        const envConfig = withoutPreviewFunctions(config);
+        await assertPolicyMatchesBranch(envConfig, ctx);
+        return await fetchAndProject(envConfig, ctx);
+    }
+    if (ctx.projectId && ctx.branchId) {
+        const pulled = await pullConfig({
+            projectId: ctx.projectId,
+            branchId: ctx.branchId,
+            ...(ctx.apiKey ? { apiKey: ctx.apiKey } : {}),
+            ...(ctx.api ? { api: ctx.api } : {}),
+        });
+        // `pulled.config` is already a `Config` (static auth/dataApi toggles + a branch
+        // tuning closure), so it feeds straight into fetchEnv — no wrapping needed.
+        return await fetchAndProject(pulled.config, ctx);
+    }
+    throw new MissingBranchContextError('No project/branch context found. Link a branch (`neonctl link` / ' +
+        '`neonctl checkout`) or pass --project-id and --branch.');
+};
+/**
+ * `neon dev`'s env resolver: {@link resolveNeonEnvVars} with graceful degradation.
+ * A missing branch context or any failure (no Neon account, no `.neon`, no network)
+ * logs a warning and returns `{}` so the function still runs locally; only a
+ * {@link DevEnvMismatchError} (policy declares a resource the branch lacks) is
+ * re-thrown for the caller to surface.
+ */
+export const resolveDevEnv = async (ctx) => {
+    try {
+        return await resolveNeonEnvVars(ctx);
+    }
+    catch (err) {
+        if (err instanceof DevEnvMismatchError)
+            throw err;
+        if (err instanceof MissingBranchContextError) {
+            log.debug('dev: %s; skipping env injection', err.message);
+            return {};
+        }
+        log.warning('Could not inject Neon env vars; the function will run without them: %s', err instanceof Error ? err.message : String(err));
+        return {};
+    }
+};
+/**
+ * Return the policy with its `preview.functions` removed, so the env path never enumerates
+ * functions against the Neon API. Functions are local-source-bundled and produce no
+ * branch-level secrets, so they are irrelevant to env resolution; probing them only risks
+ * failing the whole resolve (undeployed function, or Functions Preview disabled on the
+ * project). Buckets / AI Gateway and the top-level Auth / Data API toggles are preserved —
+ * they DO carry env, so they must still be checked and resolved. Returns the config
+ * unchanged when it declares no functions.
+ */
+const withoutPreviewFunctions = (config) => {
+    const preview = config.preview;
+    if (!preview?.functions)
+        return config;
+    const previewWithoutFunctions = { ...preview };
+    delete previewWithoutFunctions.functions;
+    return { ...config, preview: previewWithoutFunctions };
+};
+/**
+ * Tier-1 guard. Dry-run the policy against the branch's live state and stop if
+ * it declares a branch-level resource the branch is missing. Built on `plan` so
+ * it covers every present and future provisionable resource for free: any
+ * `create` action is a resource `neonctl deploy` would provision.
+ *
+ * Called with functions already stripped (see {@link withoutPreviewFunctions}), so the
+ * `plan` probe never enumerates the functions API — an undeployed function, or a project
+ * without the Functions Preview, must never block local dev or sink env injection.
+ */
+const assertPolicyMatchesBranch = async (config, ctx) => {
+    const result = await plan(config, {
+        projectId: ctx.projectId,
+        branchId: ctx.branchId,
+        ...(ctx.apiKey ? { apiKey: ctx.apiKey } : {}),
+        ...(ctx.api ? { api: ctx.api } : {}),
+    });
+    const missing = result.applied.filter(isMissingResource);
+    if (missing.length === 0)
+        return;
+    const names = missing.map((change) => change.identifier).join(', ');
+    throw new DevEnvMismatchError(`Your neon.ts declares ${names} for branch ${ctx.branchId}, but the branch ` +
+        'does not have it yet, so the matching env vars cannot be injected. ' +
+        'Provision it first with `neonctl deploy` (or `neonctl config apply`), ' +
+        'then re-run `neonctl dev`.');
+};
+/**
+ * A planned change that provisions a branch-level resource the branch lacks: a
+ * `create` on a service (Neon Auth, Data API, a bucket, the AI Gateway). Branch
+ * setting drift (`update`) and `noop`s are ignored — they don't block local dev
+ * — and functions are excluded (see {@link assertPolicyMatchesBranch}).
+ */
+const isMissingResource = (change) => change.kind === 'service' &&
+    change.action === 'create' &&
+    !change.identifier.startsWith('function:');
+const fetchAndProject = async (config, ctx) => {
+    const env = await fetchEnv(config, {
+        projectId: ctx.projectId,
+        branchId: ctx.branchId,
+        ...(ctx.apiKey ? { apiKey: ctx.apiKey } : {}),
+        ...(ctx.api ? { api: ctx.api } : {}),
+    });
+    return toEntries(env);
+};
+/**
+ * Load a `neon.ts` policy if one exists on the path from `cwd` up to the repo
+ * root. Returns `null` when there is none (the common "no config" case), and
+ * surfaces real load errors (e.g. a syntax error in an existing file).
+ */
+const loadNeonConfig = async (cwd) => {
+    try {
+        const { config } = await loadConfigFromFile({ cwd });
+        return config;
+    }
+    catch (err) {
+        const message = err instanceof Error ? err.message : String(err);
+        if (/Could not find a Neon config file/i.test(message)) {
+            return null;
+        }
+        throw err;
+    }
+};

package/dev/functions.js

@@ -0,0 +1,72 @@
+import { dirname, isAbsolute, resolve } from 'node:path';
+import { existsSync } from 'node:fs';
+import { loadConfigFromFile, resolveConfig, } from '@neondatabase/config';
+/**
+ * Load `neon.ts` (if any) and resolve the list of functions it declares into
+ * {@link PlannedFunction}s for `neon dev` to serve. Returns `null` when there is no
+ * `neon.ts` on the path from `cwd` up to the repo root — the caller turns that into a
+ * "no --source and no neon.ts" error.
+ *
+ * `branchName` is used only to evaluate a policy that switches on `branch.name`; the
+ * function list is otherwise branch-independent, so a placeholder is fine when unknown.
+ */
+export const resolveFunctionsFromConfig = async (cwd, branchName) => {
+    const loaded = await loadNeonConfig(cwd);
+    if (!loaded)
+        return null;
+    const { config, configDir, configPath } = loaded;
+    const resolved = resolveConfig(config, {
+        name: branchName ?? 'local',
+        exists: branchName !== undefined,
+    });
+    const functions = resolved.preview?.functions ?? [];
+    const planned = functions.map((fn) => {
+        const source = isAbsolute(fn.source)
+            ? fn.source
+            : resolve(configDir, fn.source);
+        if (!existsSync(source)) {
+            throw new Error(`Function "${fn.slug}" points at a source that does not exist: ${source} ` +
+                `(from neon.ts "${fn.source}"). Fix the source path and re-run.`);
+        }
+        return {
+            slug: fn.slug,
+            name: fn.name,
+            source,
+            portless: fn.dev?.portless === true,
+            ...(devPort(fn.dev) !== undefined
+                ? { port: devPort(fn.dev) }
+                : {}),
+            env: { ...fn.env },
+        };
+    });
+    return { configPath, functions: planned };
+};
+/**
+ * Read the `port` off a {@link FunctionDevConfig}. The discriminated union guarantees a
+ * `port` is present whenever `portless` is true, so this is `undefined` only for the
+ * non-portless, port-omitted case (the supervisor then searches for a free port).
+ */
+const devPort = (dev) => dev?.port;
+/**
+ * Load a `neon.ts` policy if one exists, returning the loaded config, the resolved path to
+ * the config file (used by the dev server to watch it), and the directory it lives in (used
+ * to resolve each function's relative `source`). Returns `null` when no config file is
+ * found; surfaces real load errors (e.g. a syntax error).
+ */
+const loadNeonConfig = async (cwd) => {
+    try {
+        const { config, resolvedPath } = await loadConfigFromFile({ cwd });
+        return {
+            config,
+            configDir: dirname(resolvedPath),
+            configPath: resolvedPath,
+        };
+    }
+    catch (err) {
+        const message = err instanceof Error ? err.message : String(err);
+        if (/Could not find a Neon config file/i.test(message)) {
+            return null;
+        }
+        throw err;
+    }
+};

package/dev/inputs.js

@@ -0,0 +1,63 @@
+import { resolve } from 'node:path';
+const defaultDeps = {
+    isPackaged: () => process.pkg !== undefined,
+    loadEsbuild: (name) => import(name),
+};
+/**
+ * Resolve the exact set of files esbuild reads to produce the bundle for
+ * `source` — the entry plus every local module it imports (npm deps are left
+ * external, so they never appear). These are the files the dev watcher should
+ * watch, so a single edit triggers exactly one rebuild.
+ *
+ * Returns absolute paths, or `null` when the precise set cannot be computed —
+ * either inside the packaged binary (which cannot import esbuild as a module;
+ * it shells out to a binary that has no JSON-metafile equivalent here) or on a
+ * platform where the esbuild module won't load. Callers fall back to a coarser
+ * watch in that case.
+ *
+ * This performs a metafile-only pass (`write:false`, `metafile:true`) so it
+ * never emits output; the actual bundle bytes still come from `bundleEntry`.
+ */
+export const resolveWatchInputs = async (source, deps = defaultDeps) => {
+    if (deps.isPackaged())
+        return null;
+    // esbuild is resolved by a COMPUTED specifier, never the literal string
+    // 'esbuild', for the same reason as src/utils/esbuild.ts: rollup and
+    // @yao-pkg/pkg statically scan for literal import()/require() and would pull
+    // esbuild's native Go binary into the bundle/snapshot. Keep it invisible.
+    const name = ['es', 'build'].join('');
+    let esbuild;
+    try {
+        esbuild = await deps.loadEsbuild(name);
+    }
+    catch {
+        return null;
+    }
+    let metafile;
+    try {
+        // Mirrors bundleEntry's flags so the resolved input graph matches the real
+        // bundle. metafile:true + write:false makes this a pure analysis pass.
+        const result = await esbuild.build({
+            entryPoints: [source],
+            bundle: true,
+            write: false,
+            metafile: true,
+            format: 'esm',
+            platform: 'node',
+            packages: 'external',
+            logLevel: 'silent',
+        });
+        metafile = result.metafile;
+    }
+    catch {
+        // A bundle error here is non-fatal for watching: bundleEntry surfaces the
+        // real diagnostic. Fall back to the coarser watch so edits still rebuild.
+        return null;
+    }
+    const inputs = metafile?.inputs;
+    if (!inputs)
+        return null;
+    // metafile input keys are paths relative to esbuild's cwd; resolve to absolute
+    // so they compare cleanly against chokidar's watched paths.
+    return Object.keys(inputs).map((p) => resolve(process.cwd(), p));
+};