neonctl 2.28.0 → 2.29.1

package/dist/commands/schema_diff.js

@@ -1,11 +1,11 @@
-import { createPatch } from 'diff';
-import chalk from 'chalk';
-import { writer } from '../writer.js';
-import { branchIdFromProps } from '../utils/enrichers.js';
-import { parsePointInTime, } from '../utils/point_in_time.js';
-import { isNeonApiError, messageFromBody } from '../api.js';
-import { sendError } from '../analytics.js';
-import { log } from '../log.js';
+import chalk from "chalk";
+import { createPatch } from "diff";
+import { sendError } from "../analytics.js";
+import { isNeonApiError, messageFromBody } from "../api.js";
+import { log } from "../log.js";
+import { branchIdFromProps } from "../utils/enrichers.js";
+import { parsePointInTime, } from "../utils/point_in_time.js";
+import { writer } from "../writer.js";
 const COLORS = {
     added: chalk.green,
     removed: chalk.red,
@@ -22,10 +22,10 @@ export const schemaDiff = async (props) => {
         api: props.apiClient,
     });
     // Swap base and compare points if comparing with parent branch
-    const comparingWithParent = props.compareSource.startsWith('^parent');
+    const comparingWithParent = props.compareSource.startsWith("^parent");
     let baseBranchPoint = {
         branchId: baseBranch,
-        tag: 'head',
+        tag: "head",
     };
     [baseBranchPoint, pointInTime] = comparingWithParent
         ? [pointInTime, baseBranchPoint]
@@ -65,11 +65,11 @@ const fetchSchema = async (pointInTime, database, props) => {
             db_name: database.name,
             ...pointInTimeParams(pointInTime),
         });
-        return response.data.sql ?? '';
+        return response.data.sql ?? "";
     }
     catch (error) {
         if (isNeonApiError(error)) {
-            sendError(error, 'API_ERROR');
+            sendError(error, "API_ERROR");
             throw new Error(messageFromBody(error.data) ??
                 `Error while fetching schema for branch ${pointInTime.branchId}`);
         }
@@ -78,10 +78,10 @@ const fetchSchema = async (pointInTime, database, props) => {
 };
 const colorize = (patch) => {
     return patch
-        .replace(/^([^\n]+)\n([^\n]+)\n/m, '') // Remove first two lines
-        .replace(/^-.*/gm, colorizer('removed'))
-        .replace(/^\+.*/gm, colorizer('added'))
-        .replace(/^@@.+@@.*/gm, colorizer('section'));
+        .replace(/^([^\n]+)\n([^\n]+)\n/m, "") // Remove first two lines
+        .replace(/^-.*/gm, colorizer("removed"))
+        .replace(/^\+.*/gm, colorizer("added"))
+        .replace(/^@@.+@@.*/gm, colorizer("section"));
 };
 const colorizer = (colorId) => {
     const color = COLORS[colorId];
@@ -89,11 +89,11 @@ const colorizer = (colorId) => {
 };
 const pointInTimeParams = (pointInTime) => {
     switch (pointInTime.tag) {
-        case 'timestamp':
+        case "timestamp":
             return {
                 timestamp: pointInTime.timestamp,
             };
-        case 'lsn':
+        case "lsn":
             return {
                 lsn: pointInTime.lsn ?? undefined,
             };
@@ -104,9 +104,9 @@ const pointInTimeParams = (pointInTime) => {
 const generateHeader = (pointInTime) => {
     const header = `(Branch: ${pointInTime.branchId}`;
     switch (pointInTime.tag) {
-        case 'timestamp':
+        case "timestamp":
             return `${header} at ${pointInTime.timestamp})`;
-        case 'lsn':
+        case "lsn":
             return `${header} at ${pointInTime.lsn})`;
         default:
             return `${header})`;
@@ -133,7 +133,7 @@ export const parseSchemaDiffParams = async (props) => {
                 throw new Error(`No branch specified. Your context branch (${props.branch}) has no parent, so no comparison is possible.`);
             }
             log.info(`No branches specified. Comparing your context branch '${props.branch}' with its parent`);
-            props.compareSource = '^parent';
+            props.compareSource = "^parent";
         }
         else {
             const { data } = await props.apiClient.listProjectBranches({
@@ -141,10 +141,10 @@ export const parseSchemaDiffParams = async (props) => {
             });
             const defaultBranch = data.branches.find((b) => b.default);
             if (defaultBranch?.parent_id == undefined) {
-                throw new Error('No branch specified. Include a base branch or add a set-context branch to continue. Your default branch has no parent, so no comparison is possible.');
+                throw new Error("No branch specified. Include a base branch or add a set-context branch to continue. Your default branch has no parent, so no comparison is possible.");
             }
             log.info(`No branches specified. Comparing default branch with its parent`);
-            props.compareSource = '^parent';
+            props.compareSource = "^parent";
         }
     }
     return props;

package/dist/commands/set_context.js

@@ -1,25 +1,25 @@
-import { applyContext } from '../context.js';
-import { log } from '../log.js';
-export const command = 'set-context';
-export const describe = 'Deprecated: use `neonctl link`. Set the .neon context (raw write).';
-export const builder = (argv) => argv.usage('$0 set-context [options]').options({
-    'project-id': {
-        describe: 'Project ID',
-        type: 'string',
+import { applyContext } from "../context.js";
+import { log } from "../log.js";
+export const command = "set-context";
+export const describe = "Deprecated: use `neonctl link`. Set the .neon context (raw write).";
+export const builder = (argv) => argv.usage("$0 set-context [options]").options({
+    "project-id": {
+        describe: "Project ID",
+        type: "string",
     },
-    'org-id': {
-        describe: 'Organization ID',
-        type: 'string',
+    "org-id": {
+        describe: "Organization ID",
+        type: "string",
     },
-    'branch-id': {
-        describe: 'Branch ID',
-        type: 'string',
+    "branch-id": {
+        describe: "Branch ID",
+        type: "string",
     },
 });
 export const handler = (props) => {
-    log.warning('`neonctl set-context` is deprecated and will be removed in a future release. ' +
-        'Use `neonctl link` instead — it verifies inputs and infers the org for you ' +
-        '(or `neonctl link --no-checks` for the same write-without-checks behavior).');
+    log.warning("`neonctl set-context` is deprecated and will be removed in a future release. " +
+        "Use `neonctl link` instead — it verifies inputs and infers the org for you " +
+        "(or `neonctl link --no-checks` for the same write-without-checks behavior).");
     const context = {
         projectId: props.projectId,
         orgId: props.orgId,

package/dist/commands/status.js

@@ -1,5 +1,5 @@
-import { fillSingleProject } from '../utils/enrichers.js';
-import { status } from './config.js';
+import { fillSingleProject } from "../utils/enrichers.js";
+import { status } from "./config.js";
 /**
  * `neon status` is a top-level alias for `neon config status` — the most-reached-for
  * config subcommand. It mirrors that command's options (including `--current-branch`,
@@ -9,30 +9,30 @@ import { status } from './config.js';
  * `NO_SUBCOMMANDS_VERBS` (see index.ts) so the help-fallback middleware doesn't
  * intercept a bare `neon status`.
  */
-export const command = 'status';
+export const command = "status";
 export const describe = "Show the branch's live Neon state (alias of `config status`)";
 export const builder = (argv) => argv
-    .usage('$0 status [options]')
+    .usage("$0 status [options]")
     .options({
-    'project-id': {
-        describe: 'Project ID',
-        type: 'string',
+    "project-id": {
+        describe: "Project ID",
+        type: "string",
     },
     branch: {
-        describe: 'Branch ID or name',
-        type: 'string',
+        describe: "Branch ID or name",
+        type: "string",
     },
-    'config-json': {
+    "config-json": {
         describe: "Print only the branch's live config as neon.ts-shaped JSON " +
-            '(services + branch tuning + preview), to stdout. Useful for ' +
-            'scripting or copying into a neon.ts.',
-        type: 'boolean',
+            "(services + branch tuning + preview), to stdout. Useful for " +
+            "scripting or copying into a neon.ts.",
+        type: "boolean",
         default: false,
     },
-    'current-branch': {
-        describe: 'Print only the linked branch name from the local .neon file ' +
-            '(no network). Exits non-zero when no branch is pinned.',
-        type: 'boolean',
+    "current-branch": {
+        describe: "Print only the linked branch name from the local .neon file " +
+            "(no network). Exits non-zero when no branch is pinned.",
+        type: "boolean",
         default: false,
     },
 })

package/dist/commands/user.js

@@ -1,7 +1,7 @@
-import { writer } from '../writer.js';
-export const command = 'me';
-export const describe = 'Show current user';
-export const builder = (yargs) => yargs.option('context-file', {
+import { writer } from "../writer.js";
+export const command = "me";
+export const describe = "Show current user";
+export const builder = (yargs) => yargs.option("context-file", {
     hidden: true,
 });
 export const handler = async (args) => {
@@ -10,6 +10,6 @@ export const handler = async (args) => {
 const me = async (props) => {
     const { data } = await props.apiClient.getCurrentUserInfo();
     writer(props).end(data, {
-        fields: ['login', 'email', 'name', 'projects_limit'],
+        fields: ["login", "email", "name", "projects_limit"],
     });
 };

package/dist/commands/vpc_endpoints.js

@@ -1,92 +1,92 @@
-import { writer } from '../writer.js';
-import { fillSingleProject, fillSingleOrg } from '../utils/enrichers.js';
-import { REGIONS } from './projects.js';
-import { log } from '../log.js';
-const VPC_ENDPOINT_FIELDS = ['vpc_endpoint_id', 'label'];
+import { log } from "../log.js";
+import { fillSingleOrg, fillSingleProject } from "../utils/enrichers.js";
+import { writer } from "../writer.js";
+import { REGIONS } from "./projects.js";
+const VPC_ENDPOINT_FIELDS = ["vpc_endpoint_id", "label"];
 const VPC_ENDPOINT_DETAILS_FIELDS = [
-    'vpc_endpoint_id',
-    'label',
-    'state',
-    'num_restricted_projects',
-    'example_restricted_projects',
+    "vpc_endpoint_id",
+    "label",
+    "state",
+    "num_restricted_projects",
+    "example_restricted_projects",
 ];
-export const command = 'vpc';
-export const describe = 'Manage VPC endpoints and project VPC restrictions';
+export const command = "vpc";
+export const describe = "Manage VPC endpoints and project VPC restrictions";
 export const builder = (argv) => {
     return argv
-        .usage('$0 vpc <sub-command> [options]')
-        .command('endpoint', 'Manage VPC endpoints.\n' +
-        'See: https://neon.tech/docs/guides/neon-private-networking\n' +
-        'After adding an endpoint to an organization, client connections will be accepted\n' +
-        'from the corresponding VPC for all projects in the organization, unless overridden\n' +
-        'by a project-level VPC endpoint restriction.', (yargs) => {
+        .usage("$0 vpc <sub-command> [options]")
+        .command("endpoint", "Manage VPC endpoints.\n" +
+        "See: https://neon.tech/docs/guides/neon-private-networking\n" +
+        "After adding an endpoint to an organization, client connections will be accepted\n" +
+        "from the corresponding VPC for all projects in the organization, unless overridden\n" +
+        "by a project-level VPC endpoint restriction.", (yargs) => {
         return yargs
             .options({
-            'org-id': {
-                describe: 'Organization ID',
-                type: 'string',
+            "org-id": {
+                describe: "Organization ID",
+                type: "string",
             },
-            'region-id': {
-                describe: `The region ID. Possible values: ${REGIONS.join(', ')}`,
-                type: 'string',
+            "region-id": {
+                describe: `The region ID. Possible values: ${REGIONS.join(", ")}`,
+                type: "string",
                 demandOption: true,
             },
         })
             .middleware(fillSingleOrg)
-            .command('list', 'List configured VPC endpoints for this organization.', (yargs) => yargs, async (args) => {
+            .command("list", "List configured VPC endpoints for this organization.", (yargs) => yargs, async (args) => {
             await listOrg(args);
         })
             .command({
-            command: 'assign <id>',
-            aliases: ['update <id>', 'add <id>'],
-            describe: 'Add or update a VPC endpoint for this organization.\n' +
-                'Note: Azure regions are not yet supported.',
+            command: "assign <id>",
+            aliases: ["update <id>", "add <id>"],
+            describe: "Add or update a VPC endpoint for this organization.\n" +
+                "Note: Azure regions are not yet supported.",
             builder: (yargs) => yargs.options({
                 label: {
-                    describe: 'An optional descriptive label for the VPC endpoint',
-                    type: 'string',
+                    describe: "An optional descriptive label for the VPC endpoint",
+                    type: "string",
                 },
             }),
             handler: async (args) => {
                 await assignOrg(args);
             },
         })
-            .command('remove <id>', 'Remove a VPC endpoint from this organization.', (yargs) => yargs, async (args) => {
+            .command("remove <id>", "Remove a VPC endpoint from this organization.", (yargs) => yargs, async (args) => {
             await removeOrg(args);
         })
-            .command('status <id>', 'Get the status of a VPC endpoint for this organization.', (yargs) => yargs, async (args) => {
+            .command("status <id>", "Get the status of a VPC endpoint for this organization.", (yargs) => yargs, async (args) => {
             await statusOrg(args);
         });
     })
-        .command('project', 'Manage project-level VPC endpoint restrictions.\n' +
-        'By default, connections are accepted from any VPC configured at the organization level.\n' +
-        'A project-level VPC endpoint restriction can be used to restrict connections to a specific VPC.', (yargs) => {
+        .command("project", "Manage project-level VPC endpoint restrictions.\n" +
+        "By default, connections are accepted from any VPC configured at the organization level.\n" +
+        "A project-level VPC endpoint restriction can be used to restrict connections to a specific VPC.", (yargs) => {
         return yargs
             .options({
-            'project-id': {
-                describe: 'Project ID',
-                type: 'string',
+            "project-id": {
+                describe: "Project ID",
+                type: "string",
             },
         })
             .middleware(fillSingleProject)
-            .command('list', 'List VPC endpoint restrictions for this project.', (yargs) => yargs, async (args) => {
+            .command("list", "List VPC endpoint restrictions for this project.", (yargs) => yargs, async (args) => {
             await listProject(args);
         })
             .command({
-            command: 'restrict <id>',
-            aliases: ['update <id>'],
-            describe: 'Configure or update a VPC endpoint restriction for this project.',
+            command: "restrict <id>",
+            aliases: ["update <id>"],
+            describe: "Configure or update a VPC endpoint restriction for this project.",
             builder: (yargs) => yargs.options({
                 label: {
-                    describe: 'An optional descriptive label for the VPC endpoint restriction',
-                    type: 'string',
+                    describe: "An optional descriptive label for the VPC endpoint restriction",
+                    type: "string",
                 },
             }),
             handler: async (args) => {
                 await assignProject(args);
             },
         })
-            .command('remove <id>', 'Remove a VPC endpoint restriction from this project.', (yargs) => yargs, async (args) => {
+            .command("remove <id>", "Remove a VPC endpoint restriction from this project.", (yargs) => yargs, async (args) => {
             await removeProject(args);
         });
     });
@@ -99,12 +99,12 @@ const listOrg = async (props) => {
 };
 const assignOrg = async (props) => {
     const vpcEndpointAssignment = {
-        label: props.label || '',
+        label: props.label || "",
     };
     const { data } = await props.apiClient.assignOrganizationVpcEndpoint(props.orgId, props.regionId, props.id, vpcEndpointAssignment);
     writer(props).end(data, { fields: [] });
-    if (props.regionId.startsWith('azure')) {
-        log.info('VPC endpoint configuration is not supported for Azure regions');
+    if (props.regionId.startsWith("azure")) {
+        log.info("VPC endpoint configuration is not supported for Azure regions");
     }
 };
 const removeOrg = async (props) => {
@@ -123,7 +123,7 @@ const listProject = async (props) => {
 };
 const assignProject = async (props) => {
     const vpcEndpointAssignment = {
-        label: props.label || '',
+        label: props.label || "",
     };
     const { data } = await props.apiClient.assignProjectVpcEndpoint(props.projectId, props.id, vpcEndpointAssignment);
     writer(props).end(data, { fields: [] });

package/dist/config.js

@@ -1,10 +1,10 @@
-import { join } from 'node:path';
-import { homedir } from 'node:os';
-import { existsSync, mkdirSync } from 'node:fs';
-import { isCi } from './env.js';
-export const CREDENTIALS_FILE = 'credentials.json';
-export const defaultDir = join(process.env.XDG_CONFIG_HOME || join(homedir(), '.config'), 'neonctl');
-export const ensureConfigDir = ({ 'config-dir': configDir, 'force-auth': forceAuth, }) => {
+import { existsSync, mkdirSync } from "node:fs";
+import { homedir } from "node:os";
+import { join } from "node:path";
+import { isCi } from "./env.js";
+export const CREDENTIALS_FILE = "credentials.json";
+export const defaultDir = join(process.env.XDG_CONFIG_HOME || join(homedir(), ".config"), "neonctl");
+export const ensureConfigDir = ({ "config-dir": configDir, "force-auth": forceAuth, }) => {
     if (!existsSync(configDir) && (!isCi() || forceAuth)) {
         mkdirSync(configDir, { recursive: true });
     }

package/dist/config_format.js

@@ -1,15 +1,15 @@
 /**
  * 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 formatter `@neon/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],
+        ["w", 7 * 24 * 60 * 60],
+        ["d", 24 * 60 * 60],
+        ["h", 60 * 60],
+        ["m", 60],
     ];
     for (const [unit, perUnit] of units) {
         if (totalSeconds % perUnit === 0)

package/dist/context.js

@@ -1,7 +1,7 @@
-import { accessSync, existsSync, readFileSync, writeFileSync } from 'node:fs';
-import { homedir } from 'node:os';
-import { dirname, normalize, resolve } from 'node:path';
-import { log } from './log.js';
+import { accessSync, existsSync, readFileSync, writeFileSync } from "node:fs";
+import { homedir } from "node:os";
+import { dirname, normalize, resolve } from "node:path";
+import { log } from "./log.js";
 /**
  * The branch pinned in a context, reading the current `branch` field and
  * falling back to the legacy `branchId` so pre-migration `.neon` files keep
@@ -22,10 +22,17 @@ export const contextBranch = (context) => context.branch ?? context.branchId;
  * `config status` (`_ = ['config', 'status']`).
  */
 export const isCurrentBranchProbe = (args) => args.currentBranch === true &&
-    (args._[0] === 'status' ||
-        (args._[0] === 'config' && args._[1] === 'status'));
-const CONTEXT_FILE = '.neon';
-const GITIGNORE_FILE = '.gitignore';
+    (args._[0] === "status" ||
+        (args._[0] === "config" && args._[1] === "status"));
+/**
+ * `config init` only scaffolds a local `neon.ts` and installs npm packages — it
+ * never calls the Neon API. Gated on the exact command path so the global auth
+ * middleware and the single-project resolver can skip it (it runs with no API
+ * client), mirroring {@link isCurrentBranchProbe}.
+ */
+export const isConfigInit = (args) => args._[0] === "config" && args._[1] === "init";
+const CONTEXT_FILE = ".neon";
+const GITIGNORE_FILE = ".gitignore";
 const wrapWithContextFile = (dir) => resolve(dir, CONTEXT_FILE);
 /**
  * Resolve the default `.neon` path for the current working directory.
@@ -47,7 +54,7 @@ const wrapWithContextFile = (dir) => resolve(dir, CONTEXT_FILE);
  */
 export const currentContextFile = (cwd = process.cwd()) => {
     let currentDir = cwd;
-    const root = normalize('/');
+    const root = normalize("/");
     const home = homedir();
     while (currentDir !== root && currentDir !== home) {
         try {
@@ -57,13 +64,13 @@ export const currentContextFile = (cwd = process.cwd()) => {
         catch {
             // ignore
         }
-        currentDir = resolve(currentDir, '..');
+        currentDir = resolve(currentDir, "..");
     }
     return wrapWithContextFile(cwd);
 };
 export const readContextFile = (file) => {
     try {
-        return JSON.parse(readFileSync(file, 'utf-8'));
+        return JSON.parse(readFileSync(file, "utf-8"));
     }
     catch {
         return {};
@@ -73,7 +80,7 @@ export const enrichFromContext = (args) => {
     // `link` and the deprecated `set-context` manage the context file themselves
     // and must see the raw flags rather than values pre-filled from an existing
     // `.neon`, so skip enrichment for both.
-    if (args._[0] === 'link' || args._[0] === 'set-context') {
+    if (args._[0] === "link" || args._[0] === "set-context") {
         return;
     }
     const context = readContextFile(args.contextFile);
@@ -148,17 +155,17 @@ export const ensureGitignored = (file) => {
             writeFileSync(gitignorePath, `${entry}\n`);
             return;
         }
-        const current = readFileSync(gitignorePath, 'utf-8');
+        const current = readFileSync(gitignorePath, "utf-8");
         if (hasGitignoreEntry(current, entry)) {
             return;
         }
-        const needsLeadingNewline = current.length > 0 && !current.endsWith('\n');
-        const addition = `${needsLeadingNewline ? '\n' : ''}${entry}\n`;
+        const needsLeadingNewline = current.length > 0 && !current.endsWith("\n");
+        const addition = `${needsLeadingNewline ? "\n" : ""}${entry}\n`;
         writeFileSync(gitignorePath, current + addition);
     }
     catch (err) {
         const message = err instanceof Error ? err.message : String(err);
-        log.debug('Failed to update .gitignore next to %s: %s', file, message);
+        log.debug("Failed to update .gitignore next to %s: %s", file, message);
     }
 };
 const basenameOf = (file) => {

package/dist/current_branch_fast_path.js

@@ -1,5 +1,5 @@
-import { contextBranch, currentContextFile, readContextFile } from './context.js';
-import { log } from './log.js';
+import { contextBranch, currentContextFile, readContextFile, } from "./context.js";
+import { log } from "./log.js";
 /**
  * Offline fast path for `(config) status --current-branch` (used by shell prompts).
  *
@@ -35,7 +35,7 @@ cwd = process.cwd()) => {
         process.stdout.write(`${branch}\n`);
     }
     else {
-        log.info('No branch pinned. Run `neonctl checkout <branch>` to pin a branch and pull its env vars.');
+        log.info("No branch pinned. Run `neonctl checkout <branch>` to pin a branch and pull its env vars.");
         process.exitCode = 1;
     }
     return true;
@@ -46,10 +46,10 @@ cwd = process.cwd()) => {
  * positional args) makes this false so the full CLI handles it.
  */
 const isExactCurrentBranchInvocation = (args) => {
-    const rest = args[0] === 'status'
+    const rest = args[0] === "status"
         ? args.slice(1)
-        : args[0] === 'config' && args[1] === 'status'
+        : args[0] === "config" && args[1] === "status"
             ? args.slice(2)
             : null;
-    return rest !== null && rest.length === 1 && rest[0] === '--current-branch';
+    return rest !== null && rest.length === 1 && rest[0] === "--current-branch";
 };