neonctl 1.27.6 → 1.28.0

package/commands/branches.js

@@ -249,17 +249,13 @@ const reset = async (props) => {
         throw new Error('Only resetting to parent is supported for now');
     }
     const branchId = await branchIdFromProps(props);
-    const { data: { branch }, } = await props.apiClient.getProjectBranch(props.projectId, branchId);
-    if (!branch.parent_id) {
+    const { data: { branch: { parent_id }, }, } = await props.apiClient.getProjectBranch(props.projectId, branchId);
+    if (!parent_id) {
         throw new Error('Branch has no parent');
     }
-    const { data } = await retryOnLock(() => props.apiClient.request({
-        method: 'POST',
-        path: `/projects/${props.projectId}/branches/${branch.id}/reset`,
-        body: {
-            source_branch_id: branch.parent_id,
-            preserve_under_name: props.preserveUnderName || undefined,
-        },
+    const { data } = await retryOnLock(() => props.apiClient.restoreProjectBranch(props.projectId, branchId, {
+        source_branch_id: parent_id,
+        preserve_under_name: props.preserveUnderName || undefined,
     }));
     const resultBranch = data.branch;
     writer(props).end(resultBranch, {
@@ -283,17 +279,13 @@ const restore = async (props) => {
         (pointInTime.tag === 'timestamp' &&
             'timestamp ' + pointInTime.timestamp) ||
         'head'}`);
-    const { data } = await retryOnLock(() => props.apiClient.request({
-        method: 'POST',
-        path: `/projects/${props.projectId}/branches/${targetBranchId}/reset`,
-        body: {
-            source_branch_id: pointInTime.branchId,
-            preserve_under_name: props.preserveUnderName || undefined,
-            ...(pointInTime.tag === 'lsn' && { source_lsn: pointInTime.lsn }),
-            ...(pointInTime.tag === 'timestamp' && {
-                source_timestamp: pointInTime.timestamp,
-            }),
-        },
+    const { data } = await retryOnLock(() => props.apiClient.restoreProjectBranch(props.projectId, targetBranchId, {
+        source_branch_id: pointInTime.branchId,
+        preserve_under_name: props.preserveUnderName || undefined,
+        ...(pointInTime.tag === 'lsn' && { source_lsn: pointInTime.lsn }),
+        ...(pointInTime.tag === 'timestamp' && {
+            source_timestamp: pointInTime.timestamp,
+        }),
     }));
     const branch = data.branch;
     const writeInst = writer(props).write(branch, {

package/commands/ip_allow.js

@@ -95,7 +95,7 @@ const remove = async (props) => {
     const existingAllowedIps = data.project.settings?.allowed_ips;
     project.settings = {
         allowed_ips: {
-            ips: existingAllowedIps?.ips.filter((ip) => !props.ips.includes(ip)) ?? [],
+            ips: existingAllowedIps?.ips?.filter((ip) => !props.ips.includes(ip)) ?? [],
             primary_branch_only: existingAllowedIps?.primary_branch_only ?? false,
         },
     };

package/commands/projects.js

@@ -10,7 +10,6 @@ const REGIONS = [
     'aws-eu-central-1',
     'aws-us-east-2',
     'aws-us-east-1',
-    'aws-il-central-1',
 ];
 const PROJECTS_LIST_LIMIT = 100;
 export const command = 'projects';
@@ -36,6 +35,14 @@ export const builder = (argv) => {
             describe: 'Connect to a new project via psql',
             default: false,
         },
+        database: {
+            describe: projectCreateRequest['project.branch.database_name'].description,
+            type: 'string',
+        },
+        role: {
+            describe: projectCreateRequest['project.branch.role_name'].description,
+            type: 'string',
+        },
         'set-context': {
             type: 'boolean',
             describe: 'Set the current context to the new project',
@@ -100,6 +107,13 @@ const create = async (props) => {
     if (props.regionId) {
         project.region_id = props.regionId;
     }
+    project.branch = {};
+    if (props.database) {
+        project.branch.database_name = props.database;
+    }
+    if (props.role) {
+        project.branch.role_name = props.role;
+    }
     const { data } = await props.apiClient.createProject({
         project,
     });

package/commands/projects.test.js

@@ -19,6 +19,22 @@ describe('projects', () => {
             snapshot: true,
         },
     });
+    testCliCommand({
+        name: 'create with database and role',
+        args: [
+            'projects',
+            'create',
+            '--name',
+            'test_project',
+            '--database',
+            'test_db',
+            '--role',
+            'test_role',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
     testCliCommand({
         name: 'create and connect with psql',
         args: ['projects', 'create', '--name', 'test_project', '--psql'],

package/package.json

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

package/parameters.gen.js

@@ -28,13 +28,18 @@ export const projectCreateRequest = {
     'project.settings.allowed_ips.ips': {
         type: "array",
         description: "A list of IP addresses that are allowed to connect to the endpoint.",
-        demandOption: true,
+        demandOption: false,
     },
     'project.settings.allowed_ips.primary_branch_only': {
         type: "boolean",
         description: "If true, the list will be applied only to the primary branch.",
         demandOption: true,
     },
+    'project.settings.enable_logical_replication': {
+        type: "boolean",
+        description: "Sets wal_level=logical for all compute endpoints in this project.\nAll active endpoints will be suspended.\nOnce enabled, logical replication cannot be disabled.\n",
+        demandOption: false,
+    },
     'project.name': {
         type: "string",
         description: "The project name",
@@ -68,12 +73,12 @@ 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 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 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",
         demandOption: false,
     },
     'project.pg_version': {
         type: "number",
-        description: "The major PostgreSQL version number. Currently supported versions are `14`, `15` and `16`.",
+        description: "The major Postgres version number. Currently supported versions are `14`, `15`, and `16`.",
         demandOption: false,
     },
     'project.store_passwords': {
@@ -116,13 +121,18 @@ export const projectUpdateRequest = {
     'project.settings.allowed_ips.ips': {
         type: "array",
         description: "A list of IP addresses that are allowed to connect to the endpoint.",
-        demandOption: true,
+        demandOption: false,
     },
     'project.settings.allowed_ips.primary_branch_only': {
         type: "boolean",
         description: "If true, the list will be applied only to the primary branch.",
         demandOption: true,
     },
+    'project.settings.enable_logical_replication': {
+        type: "boolean",
+        description: "Sets wal_level=logical for all compute endpoints in this project.\nAll active endpoints will be suspended.\nOnce enabled, logical replication cannot be disabled.\n",
+        demandOption: false,
+    },
     'project.name': {
         type: "string",
         description: "The project name",
@@ -130,7 +140,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 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 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",
         demandOption: false,
     },
     'project.history_retention_seconds': {
@@ -162,7 +172,12 @@ export const branchCreateRequest = {
     },
     'branch.parent_timestamp': {
         type: "string",
-        description: "A timestamp identifying a point in time on the parent branch. The branch will be created with data starting from this point in time.\n",
+        description: "A timestamp identifying a point in time on the parent branch. The branch will be created with data starting from this point in time.\nThe timestamp must be provided in ISO 8601 format; for example: `2024-02-26T12:00:00Z`.\n",
+        demandOption: false,
+    },
+    'branch.protected': {
+        type: "boolean",
+        description: "Whether the branch is protected\n",
         demandOption: false,
     },
 };
@@ -181,7 +196,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 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 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",
         demandOption: false,
     },
 };
@@ -191,6 +206,11 @@ export const branchUpdateRequest = {
         description: undefined,
         demandOption: false,
     },
+    'branch.protected': {
+        type: "boolean",
+        description: undefined,
+        demandOption: false,
+    },
 };
 export const endpointCreateRequest = {
     'endpoint.branch_id': {
@@ -238,7 +258,7 @@ 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 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 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",
         demandOption: false,
     },
 };
@@ -277,7 +297,7 @@ 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 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 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",
         demandOption: false,
     },
 };