neonctl 1.30.0 → 1.31.1

package/README.md

@@ -70,7 +70,7 @@ The Neon CLI supports autocompletion, which you can configure in a few easy step
 | [projects](https://neon.tech/docs/reference/cli-projects)                   | `list`, `create`, `update`, `delete`, `get`                               | Manage projects              |
 | [ip-allow](https://neon.tech/docs/reference/cli-ip-allow)                   | `list`, `add`, `remove`, `reset`                                          | Manage IP Allow              |
 | [me](https://neon.tech/docs/reference/cli-me)                               |                                                                           | Show current user            |
-| [branches](https://neon.tech/docs/reference/cli-branches)                   | `list`, `create`, `rename`, `add-compute`, `set-primary`, `delete`, `get` | Manage branches              |
+| [branches](https://neon.tech/docs/reference/cli-branches)                   | `list`, `create`, `rename`, `add-compute`, `set-default`, `delete`, `get` | Manage branches              |
 | [databases](https://neon.tech/docs/reference/cli-databases)                 | `list`, `create`, `delete`                                                | Manage databases             |
 | [roles](https://neon.tech/docs/reference/cli-roles)                         | `list`, `create`, `delete`                                                | Manage roles                 |
 | [operations](https://neon.tech/docs/reference/cli-operations)               | `list`                                                                    | Manage operations            |

package/commands/branches.js

@@ -12,6 +12,7 @@ const BRANCH_FIELDS = [
     'id',
     'name',
     'primary',
+    'default',
     'created_at',
     'updated_at',
 ];
@@ -19,6 +20,7 @@ const BRANCH_FIELDS_RESET = [
     'id',
     'name',
     'primary',
+    'default',
     'created_at',
     'last_reset_at',
 ];
@@ -38,7 +40,7 @@ export const builder = (argv) => argv
     .command('create', 'Create a branch', (yargs) => yargs.options({
     name: branchCreateRequest['branch.name'],
     parent: {
-        describe: 'Parent branch name or id or timestamp or LSN. Defaults to the primary branch',
+        describe: 'Parent branch name or id or timestamp or LSN. Defaults to the default branch',
         type: 'string',
     },
     compute: {
@@ -108,7 +110,8 @@ export const builder = (argv) => argv
     ],
 ]), async (args) => await restore(args))
     .command('rename <id|name> <new-name>', 'Rename a branch', (yargs) => yargs, async (args) => await rename(args))
-    .command('set-primary <id|name>', 'Set a branch as primary', (yargs) => yargs, async (args) => await setPrimary(args))
+    .command('set-primary <id|name>', 'DEPRECATED: Use set-default. Set a branch as primary', (yargs) => yargs, async (args) => await setDefault(args))
+    .command('set-default <id|name>', 'Set a branch as default', (yargs) => yargs, async (args) => await setDefault(args))
     .command('add-compute <id|name>', 'Add a compute to a branch', (yargs) => yargs.options({
     type: {
         type: 'string',
@@ -153,7 +156,7 @@ export const builder = (argv) => argv
             ],
             [
                 '$0 branches schema-diff',
-                "If a branch is specified in 'set-context', compares this branch to its parent. Otherwise, compares the primary branch to its parent.",
+                "If a branch is specified in 'set-context', compares this branch to its parent. Otherwise, compares the default branch to its parent.",
             ],
         ]);
     },
@@ -174,9 +177,9 @@ const create = async (props) => {
             return props.apiClient
                 .listProjectBranches(props.projectId)
                 .then(({ data }) => {
-                const branch = data.branches.find((b) => b.primary);
+                const branch = data.branches.find((b) => b.default);
                 if (!branch) {
-                    throw new Error('No primary branch found');
+                    throw new Error('No default branch found');
                 }
                 return { parent_id: branch.id };
             });
@@ -252,9 +255,9 @@ const rename = async (props) => {
         fields: BRANCH_FIELDS,
     });
 };
-const setPrimary = async (props) => {
+const setDefault = async (props) => {
     const branchId = await branchIdFromProps(props);
-    const { data } = await retryOnLock(() => props.apiClient.setPrimaryProjectBranch(props.projectId, branchId));
+    const { data } = await retryOnLock(() => props.apiClient.setDefaultProjectBranch(props.projectId, branchId));
     writer(props).end(data.branch, {
         fields: BRANCH_FIELDS,
     });

package/commands/branches.test.js

@@ -195,6 +195,20 @@ describe('branches', () => {
             snapshot: true,
         },
     });
+    /* set default */
+    testCliCommand({
+        name: 'set default by id',
+        args: [
+            'branches',
+            'set-default',
+            'br-sunny-branch-123456',
+            '--project-id',
+            'test',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
     /* get */
     testCliCommand({
         name: 'get by id',

package/commands/connection_string.js

@@ -14,7 +14,7 @@ export const builder = (argv) => {
         .example('$0 cs main@2024-01-01T00:00:00Z', 'Get connection string for the main branch at a specific point in time')
         .example('$0 cs main@0/234235', 'Get connection string for the main branch at a specific LSN')
         .positional('branch', {
-        describe: `Branch name or id. Defaults to the primary branch if omitted. Can be written in the point-in-time format: "branch@timestamp" or "branch@lsn"`,
+        describe: `Branch name or id. Defaults to the default branch if omitted. Can be written in the point-in-time format: "branch@timestamp" or "branch@lsn"`,
         type: 'string',
     })
         .options({

package/commands/index.js

@@ -2,6 +2,7 @@ import * as auth from './auth.js';
 import * as projects from './projects.js';
 import * as ipAllow from './ip_allow.js';
 import * as users from './user.js';
+import * as orgs from './orgs.js';
 import * as branches from './branches.js';
 import * as databases from './databases.js';
 import * as roles from './roles.js';
@@ -11,6 +12,7 @@ import * as setContext from './set_context.js';
 export default [
     auth,
     users,
+    orgs,
     projects,
     ipAllow,
     branches,

package/commands/orgs.js

@@ -0,0 +1,23 @@
+import { writer } from '../writer.js';
+const ORG_FIELDS = ['id', 'name'];
+export const command = 'orgs';
+export const describe = 'Manage organizations';
+export const aliases = ['org'];
+export const builder = (argv) => {
+    return argv.usage('$0 orgs <sub-command> [options]').command('list', 'List organizations', (yargs) => yargs, async (args) => {
+        // @ts-expect-error: TODO - Assert `args` is `CommonProps`
+        await list(args);
+    });
+};
+export const handler = (args) => {
+    return args;
+};
+const list = async (props) => {
+    const out = writer(props);
+    const { data: { organizations }, } = await props.apiClient.getCurrentUserOrganizations();
+    out.write(organizations, {
+        fields: ORG_FIELDS,
+        title: 'Organizations',
+    });
+    out.end();
+};

package/commands/projects.js

@@ -136,7 +136,6 @@ const create = async (props) => {
     if (props.setContext) {
         updateContextFile(props.contextFile, {
             projectId: data.project.id,
-            branchId: data.branch.id,
         });
     }
     const out = writer(props);

package/commands/schema_diff.js

@@ -118,7 +118,7 @@ const generateHeader = (pointInTime) => {
 /*
   The command has two positional optional arguments - [base-branch] and [compare-source]
   If only one argument is specified, we should consider it as `compare-source`
-    and `base-branch` will be either read from context or the primary branch of project.
+    and `base-branch` will be either read from context or the default branch of project.
   If no branches are specified, compare the context branch with its parent
 */
 export const parseSchemaDiffParams = async (props) => {
@@ -138,11 +138,11 @@ export const parseSchemaDiffParams = async (props) => {
         }
         else {
             const { data } = await props.apiClient.listProjectBranches(props.projectId);
-            const primaryBranch = data.branches.find((b) => b.primary);
-            if (primaryBranch?.parent_id == undefined) {
-                throw new Error('No branch specified. Include a base branch or add a set-context branch to continue. Your primary branch has no parent, so no comparison is possible.');
+            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.');
             }
-            log.info(`No branches specified. Comparing primary branch with its parent`);
+            log.info(`No branches specified. Comparing default branch with its parent`);
             props.compareSource = '^parent';
         }
     }

package/commands/set_context.js

@@ -1,5 +1,4 @@
 import { updateContextFile } from '../context.js';
-import { branchIdFromProps } from '../utils/enrichers.js';
 export const command = 'set-context';
 export const describe = 'Set the current context';
 export const builder = (argv) => argv.usage('$0 set-context [options]').options({
@@ -7,16 +6,10 @@ export const builder = (argv) => argv.usage('$0 set-context [options]').options(
         describe: 'Project ID',
         type: 'string',
     },
-    branch: {
-        describe: 'Branch ID or name',
-        type: 'string',
-    },
 });
 export const handler = async (props) => {
-    const branchId = await branchIdFromProps(props);
     const context = {
         projectId: props.projectId,
-        branchId,
     };
     updateContextFile(props.contextFile, context);
 };

package/commands/set_context.test.js

@@ -28,24 +28,64 @@ describe('set_context', () => {
         });
         const overrideContextFile = join(tmpdir(), `neon_override_ctx_${Date.now()}`);
         testCliCommand({
-            name: 'get branch id overrides context set branch',
+            name: 'get project id overrides context set project',
             before: async () => {
                 writeFileSync(overrideContextFile, JSON.stringify({
-                    projectId: 'test',
-                    branchId: 'br-cloudy-branch-12345678',
+                    projectId: 'new-project id',
                 }));
             },
             after: async () => {
                 rmSync(overrideContextFile);
             },
             args: [
-                'branches',
+                'project',
                 'get',
-                'br-sunny-branch-123456',
+                'project-id-123',
+                '--context-file',
+                overrideContextFile,
+            ],
+            expected: {
+                snapshot: true,
+            },
+        });
+        testCliCommand({
+            name: 'set the branchId and projectId is from context',
+            before: async () => {
+                writeFileSync(overrideContextFile, JSON.stringify({
+                    projectId: 'test',
+                    branchId: 'test_branch',
+                }));
+            },
+            after: async () => {
+                rmSync(overrideContextFile);
+            },
+            args: ['databases', 'list', '--context-file', overrideContextFile],
+            expected: {
+                snapshot: true,
+            },
+        });
+        testCliCommand({
+            name: 'should not set branchId from context for non-context projectId',
+            before: async () => {
+                writeFileSync(overrideContextFile, JSON.stringify({
+                    projectId: 'project-id-123',
+                    branchId: 'test_branch',
+                }));
+            },
+            after: async () => {
+                rmSync(overrideContextFile);
+            },
+            args: [
+                'databases',
+                'list',
+                '--project-id',
+                'test',
                 '--context-file',
                 overrideContextFile,
             ],
             expected: {
+                code: 1,
+                stderr: 'ERROR: Not Found',
                 snapshot: true,
             },
         });

package/context.js

@@ -36,12 +36,15 @@ export const enrichFromContext = (args) => {
         return;
     }
     const context = readContextFile(args.contextFile);
-    if (!args.branch && !args.id && !args.name) {
-        args.branch = context.branchId;
-    }
     if (!args.projectId) {
         args.projectId = context.projectId;
     }
+    if (!args.branch &&
+        !args.id &&
+        !args.name &&
+        context.projectId === args.projectId) {
+        args.branch = context.branchId;
+    }
 };
 export const updateContextFile = (file, context) => {
     writeFileSync(file, JSON.stringify(context, null, 2));

package/package.json

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

package/parameters.gen.js

@@ -37,7 +37,7 @@ export const projectCreateRequest = {
     },
     'project.settings.allowed_ips.primary_branch_only': {
         type: "boolean",
-        description: "If true, the list will be applied only to the primary branch.",
+        description: "If true, the list will be applied only to the default branch.",
         demandOption: false,
     },
     'project.settings.enable_logical_replication': {
@@ -140,7 +140,7 @@ export const projectUpdateRequest = {
     },
     'project.settings.allowed_ips.primary_branch_only': {
         type: "boolean",
-        description: "If true, the list will be applied only to the primary branch.",
+        description: "If true, the list will be applied only to the default branch.",
         demandOption: false,
     },
     'project.settings.enable_logical_replication': {
@@ -172,7 +172,7 @@ export const branchCreateRequest = {
     },
     'branch.parent_id': {
         type: "string",
-        description: "The `branch_id` of the parent branch. If omitted or empty, the branch will be created from the project's primary branch.\n",
+        description: "The `branch_id` of the parent branch. If omitted or empty, the branch will be created from the project's default branch.\n",
         demandOption: false,
     },
     'branch.name': {

package/utils/enrichers.js

@@ -25,11 +25,11 @@ export const branchIdFromProps = async (props) => {
         });
     }
     const { data } = await props.apiClient.listProjectBranches(props.projectId);
-    const primaryBranch = data.branches.find((b) => b.primary);
-    if (primaryBranch) {
-        return primaryBranch.id;
+    const defaultBranch = data.branches.find((b) => b.default);
+    if (defaultBranch) {
+        return defaultBranch.id;
     }
-    throw new Error('No primary branch found');
+    throw new Error('No default branch found');
 };
 export const fillSingleProject = async (props) => {
     if (props.projectId) {