neonctl 2.5.0 → 2.7.0

package/analytics.js

@@ -48,15 +48,7 @@ export const analyticsMiddleware = async (args) => {
     client.track({
         userId: userId ?? 'anonymous',
         event: 'CLI Started',
-        properties: {
-            version: pkg.version,
-            command: args._.join(' '),
-            flags: {
-                output: args.output,
-            },
-            ci: isCi(),
-            githubEnvVars: getGithubEnvVars(process.env),
-        },
+        properties: getAnalyticsEventProperties(args),
         context: {
             direct: true,
         },
@@ -97,3 +89,12 @@ export const trackEvent = (event, properties) => {
     });
     log.debug('Sent CLI event: %s', event);
 };
+export const getAnalyticsEventProperties = (args) => ({
+    version: pkg.version,
+    command: args._.join(' '),
+    flags: {
+        output: args.output,
+    },
+    ci: isCi(),
+    githubEnvVars: getGithubEnvVars(process.env),
+});

package/commands/branches.js

@@ -36,6 +36,10 @@ export const builder = (argv) => argv
     },
 })
     .middleware(fillSingleProject)
+    .middleware((args) => {
+    // Provide alias for analytics
+    args.branchId ?? (args.branchId = args.id);
+})
     .command('list', 'List branches', (yargs) => yargs, (args) => list(args))
     .command('create', 'Create a branch', (yargs) => yargs.options({
     name: branchCreateRequest['branch.name'],
@@ -76,6 +80,11 @@ export const builder = (argv) => argv
         hidden: true,
         default: '{}',
     },
+    'schema-only': {
+        describe: 'Create a schema-only branch. Requires exactly one read-write compute.',
+        type: 'boolean',
+        default: false,
+    },
 }), (args) => create(args))
     .command('reset <id|name>', 'Reset a branch', (yargs) => yargs.options({
     parent: {
@@ -94,6 +103,7 @@ export const builder = (argv) => argv
     .middleware((args) => {
     args.id = args.targetId;
     args.pointInTime = args['source@(timestamp'];
+    args.branchId = args.id; // for analytics
 })
     .usage('$0 branches restore <target-id|name> <source>[@(timestamp|lsn)]')
     .options({
@@ -213,10 +223,20 @@ const create = async (props) => {
         }
         return { parent_id: branch.id };
     })();
+    // Validate schema-only branch requirements
+    if (props.schemaOnly) {
+        if (!props.compute) {
+            throw new Error('Schema-only branches require a compute endpoint');
+        }
+        if (props.type !== EndpointType.ReadWrite) {
+            throw new Error('Schema-only branches require a read-write compute endpoint');
+        }
+    }
     const { data } = await retryOnLock(() => props.apiClient.createProjectBranch(props.projectId, {
         branch: {
             name: props.name,
             ...parentProps,
+            ...(props.schemaOnly ? { init_source: 'schema-only' } : {}),
         },
         endpoints: props.compute
             ? [

package/commands/branches.test.js

@@ -136,6 +136,50 @@ describe('branches', () => {
             '0.5-2',
         ]);
     });
+    test('create schema-only branch', async ({ testCliCommand }) => {
+        await testCliCommand([
+            'branches',
+            'create',
+            '--project-id',
+            'test',
+            '--name',
+            'test_branch',
+            '--schema-only',
+        ]);
+    });
+    test('create schema-only branch fails without compute', async ({ testCliCommand, }) => {
+        await testCliCommand([
+            'branches',
+            'create',
+            '--project-id',
+            'test',
+            '--name',
+            'test_branch',
+            '--schema-only',
+            '--no-compute',
+        ], {
+            mockDir: 'main',
+            code: 1,
+            stderr: 'ERROR: Schema-only branches require a compute endpoint',
+        });
+    });
+    test('create schema-only branch fails with read-only compute', async ({ testCliCommand, }) => {
+        await testCliCommand([
+            'branches',
+            'create',
+            '--project-id',
+            'test',
+            '--name',
+            'test_branch',
+            '--schema-only',
+            '--type',
+            'read_only',
+        ], {
+            mockDir: 'main',
+            code: 1,
+            stderr: 'ERROR: Schema-only branches require a read-write compute endpoint',
+        });
+    });
     /* delete */
     test('delete by id', async ({ testCliCommand }) => {
         await testCliCommand([

package/commands/projects.js

@@ -1,5 +1,5 @@
 import { log } from '../log.js';
-import { projectCreateRequest } from '../parameters.gen.js';
+import { projectCreateRequest, projectUpdateRequest, } from '../parameters.gen.js';
 import { writer } from '../writer.js';
 import { psql } from '../utils/psql.js';
 import { updateContextFile } from '../context.js';
@@ -26,6 +26,10 @@ export const aliases = ['project'];
 export const builder = (argv) => {
     return argv
         .usage('$0 projects <sub-command> [options]')
+        .middleware((args) => {
+        // Provide alias for analytics
+        args.projectId = args.id;
+    })
         .command('list', 'List projects', (yargs) => yargs.options({
         'org-id': {
             describe: 'List projects of a given organization',
@@ -73,14 +77,26 @@ export const builder = (argv) => {
         await create(args);
     })
         .command('update <id>', 'Update a project', (yargs) => yargs.options({
-        name: {
-            describe: projectCreateRequest['project.name'].description,
-            type: 'string',
+        'block-vpc-connections': {
+            describe: projectUpdateRequest['project.settings.block_vpc_connections']
+                .description +
+                ' Use --block-vpc-connections=false to set the value to false.',
+            type: 'boolean',
+        },
+        'block-public-connections': {
+            describe: projectUpdateRequest['project.settings.block_public_connections']
+                .description +
+                ' Use --block-public-connections=false to set the value to false.',
+            type: 'boolean',
         },
         cu: {
             describe: 'The number of Compute Units. Could be a fixed size (e.g. "2") or a range delimited by a dash (e.g. "0.5-3").',
             type: 'string',
         },
+        name: {
+            describe: projectUpdateRequest['project.name'].description,
+            type: 'string',
+        },
     }), async (args) => {
         await update(args);
     })
@@ -185,6 +201,18 @@ const deleteProject = async (props) => {
 };
 const update = async (props) => {
     const project = {};
+    if (props.blockPublicConnections !== undefined) {
+        if (!project.settings) {
+            project.settings = {};
+        }
+        project.settings.block_public_connections = props.blockPublicConnections;
+    }
+    if (props.blockVpcConnections !== undefined) {
+        if (!project.settings) {
+            project.settings = {};
+        }
+        project.settings.block_vpc_connections = props.blockVpcConnections;
+    }
     if (props.name) {
         project.name = props.name;
     }

package/commands/roles.js

@@ -25,6 +25,10 @@ export const builder = (argv) => argv
         type: 'string',
         demandOption: true,
     },
+    'no-login': {
+        describe: 'Create a passwordless role that cannot login',
+        boolean: true,
+    },
 }), (args) => create(args))
     .command('delete <role>', 'Delete a role', (yargs) => yargs, (args) => deleteRole(args));
 export const handler = (args) => {
@@ -42,6 +46,7 @@ export const create = async (props) => {
     const { data } = await retryOnLock(() => props.apiClient.createProjectBranchRole(props.projectId, branchId, {
         role: {
             name: props.name,
+            no_login: props['no-login'],
         },
     }));
     writer(props).end(data.role, {

package/index.js

@@ -20,7 +20,7 @@ import { defaultClientID } from './auth.js';
 import { fillInArgs } from './utils/middlewares.js';
 import pkg from './pkg.js';
 import commands from './commands/index.js';
-import { analyticsMiddleware, closeAnalytics, sendError } from './analytics.js';
+import { analyticsMiddleware, closeAnalytics, getAnalyticsEventProperties, sendError, trackEvent, } from './analytics.js';
 import { isAxiosError } from 'axios';
 import { matchErrorCode } from './errors.js';
 import { showHelp } from './help.js';
@@ -180,6 +180,11 @@ builder = builder
 void (async () => {
     try {
         const args = await builder.argv;
+        trackEvent('cli_command_success', {
+            ...getAnalyticsEventProperties(args),
+            projectId: args.projectId,
+            branchId: args.branchId,
+        });
         if (args._.length === 0 || args.help) {
             await showHelp(builder);
             process.exit(0);

package/package.json

@@ -5,7 +5,7 @@
     "url": "git+ssh://git@github.com/neondatabase/neonctl.git"
   },
   "type": "module",
-  "version": "2.5.0",
+  "version": "2.7.0",
   "description": "CLI tool for NeonDB Cloud management",
   "main": "index.js",
   "author": "NeonDB",
@@ -54,7 +54,7 @@
     "vitest": "^1.6.0"
   },
   "dependencies": {
-    "@neondatabase/api-client": "1.11.2",
+    "@neondatabase/api-client": "1.12.0",
     "@segment/analytics-node": "^1.0.0-beta.26",
     "axios": "^1.4.0",
     "axios-debug-log": "^1.0.0",

package/parameters.gen.js

@@ -97,7 +97,7 @@ export const projectCreateRequest = {
     },
     'project.default_endpoint_settings.suspend_timeout_seconds': {
         type: "number",
-        description: "Duration of inactivity in seconds after which the compute endpoint is\nautomatically suspended. The value `0` means use the global default.\nThe value `-1` means never suspend. The default value is `300` seconds (5 minutes).\nThe minimum value is `60` seconds (1 minute).\nThe maximum value is `604800` seconds (1 week). For more information, see\n[Auto-suspend configuration](https://neon.tech/docs/manage/endpoints#auto-suspend-configuration).\n",
+        description: "Duration of inactivity in seconds after which the compute endpoint is\nautomatically suspended. The value `0` means use the default value.\nThe value `-1` means never suspend. The default value is `300` seconds (5 minutes).\nThe minimum value is `60` seconds (1 minute).\nThe maximum value is `604800` seconds (1 week). For more information, see\n[Scale to zero configuration](https://neon.tech/docs/manage/endpoints#scale-to-zero-configuration).\n",
         demandOption: false,
     },
     'project.pg_version': {
@@ -194,7 +194,7 @@ export const projectUpdateRequest = {
     },
     'project.default_endpoint_settings.suspend_timeout_seconds': {
         type: "number",
-        description: "Duration of inactivity in seconds after which the compute endpoint is\nautomatically suspended. The value `0` means use the global default.\nThe value `-1` means never suspend. The default value is `300` seconds (5 minutes).\nThe minimum value is `60` seconds (1 minute).\nThe maximum value is `604800` seconds (1 week). For more information, see\n[Auto-suspend configuration](https://neon.tech/docs/manage/endpoints#auto-suspend-configuration).\n",
+        description: "Duration of inactivity in seconds after which the compute endpoint is\nautomatically suspended. The value `0` means use the default value.\nThe value `-1` means never suspend. The default value is `300` seconds (5 minutes).\nThe minimum value is `60` seconds (1 minute).\nThe maximum value is `604800` seconds (1 week). For more information, see\n[Scale to zero configuration](https://neon.tech/docs/manage/endpoints#scale-to-zero-configuration).\n",
         demandOption: false,
     },
     'project.history_retention_seconds': {
@@ -239,11 +239,10 @@ export const branchCreateRequest = {
         description: "Whether to create the branch as archived\n",
         demandOption: false,
     },
-    'branch.schema_initialization_type': {
+    'branch.init_source': {
         type: "string",
-        description: "The type of schema initialization. Defines how the schema is initialized, currently only empty is supported. This parameter is under\nactive development and may change its semantics in the future.\n",
+        description: "The initialization source type for the branch. Valid values are `schema-only` and `parent-data`.\nThis parameter is under active development and may change its semantics in the future.\n",
         demandOption: false,
-        choices: ["empty"],
     },
 };
 export const branchCreateRequestEndpointOptions = {
@@ -260,7 +259,7 @@ export const branchCreateRequestEndpointOptions = {
     },
     'suspend_timeout_seconds': {
         type: "number",
-        description: "Duration of inactivity in seconds after which the compute endpoint is\nautomatically suspended. The value `0` means use the global default.\nThe value `-1` means never suspend. The default value is `300` seconds (5 minutes).\nThe minimum value is `60` seconds (1 minute).\nThe maximum value is `604800` seconds (1 week). For more information, see\n[Auto-suspend configuration](https://neon.tech/docs/manage/endpoints#auto-suspend-configuration).\n",
+        description: "Duration of inactivity in seconds after which the compute endpoint is\nautomatically suspended. The value `0` means use the default value.\nThe value `-1` means never suspend. The default value is `300` seconds (5 minutes).\nThe minimum value is `60` seconds (1 minute).\nThe maximum value is `604800` seconds (1 week). For more information, see\n[Scale to zero configuration](https://neon.tech/docs/manage/endpoints#scale-to-zero-configuration).\n",
         demandOption: false,
     },
 };
@@ -321,14 +320,14 @@ export const endpointCreateRequest = {
     },
     'endpoint.suspend_timeout_seconds': {
         type: "number",
-        description: "Duration of inactivity in seconds after which the compute endpoint is\nautomatically suspended. The value `0` means use the global default.\nThe value `-1` means never suspend. The default value is `300` seconds (5 minutes).\nThe minimum value is `60` seconds (1 minute).\nThe maximum value is `604800` seconds (1 week). For more information, see\n[Auto-suspend configuration](https://neon.tech/docs/manage/endpoints#auto-suspend-configuration).\n",
+        description: "Duration of inactivity in seconds after which the compute endpoint is\nautomatically suspended. The value `0` means use the default value.\nThe value `-1` means never suspend. The default value is `300` seconds (5 minutes).\nThe minimum value is `60` seconds (1 minute).\nThe maximum value is `604800` seconds (1 week). For more information, see\n[Scale to zero configuration](https://neon.tech/docs/manage/endpoints#scale-to-zero-configuration).\n",
         demandOption: false,
     },
 };
 export const endpointUpdateRequest = {
     'endpoint.branch_id': {
         type: "string",
-        description: "DEPRECATED: This field will be removed in a future release.\nThe destination branch ID. The destination branch must not have an exsiting read-write endpoint.\n",
+        description: "DEPRECATED: This field will be removed in a future release.\nThe destination branch ID. The destination branch must not have an existing read-write endpoint.\n",
         demandOption: false,
     },
     'endpoint.provisioner': {
@@ -359,14 +358,14 @@ export const endpointUpdateRequest = {
     },
     'endpoint.suspend_timeout_seconds': {
         type: "number",
-        description: "Duration of inactivity in seconds after which the compute endpoint is\nautomatically suspended. The value `0` means use the global default.\nThe value `-1` means never suspend. The default value is `300` seconds (5 minutes).\nThe minimum value is `60` seconds (1 minute).\nThe maximum value is `604800` seconds (1 week). For more information, see\n[Auto-suspend configuration](https://neon.tech/docs/manage/endpoints#auto-suspend-configuration).\n",
+        description: "Duration of inactivity in seconds after which the compute endpoint is\nautomatically suspended. The value `0` means use the default value.\nThe value `-1` means never suspend. The default value is `300` seconds (5 minutes).\nThe minimum value is `60` seconds (1 minute).\nThe maximum value is `604800` seconds (1 week). For more information, see\n[Scale to zero configuration](https://neon.tech/docs/manage/endpoints#scale-to-zero-configuration).\n",
         demandOption: false,
     },
 };
 export const databaseCreateRequest = {
     'database.name': {
         type: "string",
-        description: "The name of the datbase\n",
+        description: "The name of the database\n",
         demandOption: true,
     },
     'database.owner_name': {
@@ -381,4 +380,9 @@ export const roleCreateRequest = {
         description: "The role name. Cannot exceed 63 bytes in length.\n",
         demandOption: true,
     },
+    'role.no_login': {
+        type: "boolean",
+        description: "Whether to create a role that cannot login.\n",
+        demandOption: false,
+    },
 };

package/utils/enrichers.js

@@ -15,7 +15,7 @@ export const branchIdResolve = async ({ branch, apiClient, projectId, }) => {
     }
     return branchData.id;
 };
-export const branchIdFromProps = async (props) => {
+const getBranchIdFromProps = async (props) => {
     const branch = 'branch' in props && typeof props.branch === 'string'
         ? props.branch
         : props.id;
@@ -35,11 +35,15 @@ export const branchIdFromProps = async (props) => {
     }
     throw new Error('No default branch found');
 };
+export const branchIdFromProps = async (props) => {
+    props.branchId = await getBranchIdFromProps(props);
+    return props.branchId;
+};
 export const fillSingleProject = async (props) => {
     if (props.projectId) {
         return props;
     }
-    const { data } = await props.apiClient.listProjects({});
+    const { data } = await props.apiClient.listProjects({ limit: 2 });
     if (data.projects.length === 0) {
         throw new Error('No projects found');
     }