neonctl 2.9.2 → 2.11.0

package/commands/auth.js

@@ -41,6 +41,7 @@ export const authFlow = async ({ configDir, oauthHost, clientId, apiHost, forceA
 const preserveCredentials = async (path, credentials, apiClient) => {
     const { data: { id }, } = await apiClient.getCurrentUserInfo();
     const contents = JSON.stringify({
+        // Making the linter happy by explicitly confirming we don't care about @typescript-eslint/no-misused-spread
         ...credentials,
         user_id: id,
     });

package/commands/projects.js

@@ -4,6 +4,9 @@ import { writer } from '../writer.js';
 import { psql } from '../utils/psql.js';
 import { updateContextFile } from '../context.js';
 import { getComputeUnits } from '../utils/compute_units.js';
+import { isAxiosError } from 'axios';
+import prompts from 'prompts';
+import { isCi } from '../env.js';
 export const PROJECT_FIELDS = [
     'id',
     'name',
@@ -36,7 +39,7 @@ export const builder = (argv) => {
             type: 'string',
         },
     }), async (args) => {
-        await list(args);
+        await handleMissingOrgId(args, list);
     })
         .command('create', 'Create a project', (yargs) => yargs.options({
         'block-public-connections': {
@@ -49,6 +52,10 @@ export const builder = (argv) => {
                 .description,
             type: 'boolean',
         },
+        hipaa: {
+            describe: projectCreateRequest['project.settings.hipaa'].description,
+            type: 'boolean',
+        },
         name: {
             describe: projectCreateRequest['project.name'].description,
             type: 'string',
@@ -84,7 +91,7 @@ export const builder = (argv) => {
             type: 'string',
         },
     }), async (args) => {
-        await create(args);
+        await handleMissingOrgId(args, create);
     })
         .command('update <id>', 'Update a project', (yargs) => yargs.options({
         'block-vpc-connections': {
@@ -99,6 +106,10 @@ export const builder = (argv) => {
                 ' Use --block-public-connections=false to set the value to false.',
             type: 'boolean',
         },
+        hipaa: {
+            describe: projectUpdateRequest['project.settings.hipaa'].description,
+            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',
@@ -161,6 +172,12 @@ const list = async (props) => {
 };
 const create = async (props) => {
     const project = {};
+    if (props.hipaa !== undefined) {
+        if (!project.settings) {
+            project.settings = {};
+        }
+        project.settings.hipaa = props.hipaa;
+    }
     if (props.blockPublicConnections !== undefined) {
         if (!project.settings) {
             project.settings = {};
@@ -223,6 +240,12 @@ const deleteProject = async (props) => {
 };
 const update = async (props) => {
     const project = {};
+    if (props.hipaa !== undefined) {
+        if (!project.settings) {
+            project.settings = {};
+        }
+        project.settings.hipaa = props.hipaa;
+    }
     if (props.blockPublicConnections !== undefined) {
         if (!project.settings) {
             project.settings = {};
@@ -252,3 +275,71 @@ const get = async (props) => {
     const { data } = await props.apiClient.getProject(props.id);
     writer(props).end(data.project, { fields: PROJECT_FIELDS });
 };
+const handleMissingOrgId = async (args, cmd) => {
+    try {
+        await cmd(args);
+    }
+    catch (err) {
+        if (!isCi() && isOrgIdError(err)) {
+            const orgId = await selectOrg(args);
+            await cmd({ ...args, orgId });
+        }
+        else {
+            throw err;
+        }
+    }
+};
+const isOrgIdError = (err) => {
+    return (isAxiosError(err) &&
+        err.response?.status == 400 &&
+        err.response?.data?.message?.includes('org_id is required'));
+};
+const selectOrg = async (props) => {
+    const { data: { organizations }, } = await props.apiClient.getCurrentUserOrganizations();
+    if (!organizations?.length) {
+        throw new Error(`You don't belong to any organizations. Please create an organization first.`);
+    }
+    const { orgId } = await prompts({
+        onState: onPromptState,
+        type: 'select',
+        name: 'orgId',
+        message: `What organization would you like to use?`,
+        choices: organizations.map((org) => ({
+            title: `${org.name} (${org.id})`,
+            value: org.id,
+        })),
+        initial: 0,
+    });
+    const { save } = await prompts({
+        onState: onPromptState,
+        type: 'confirm',
+        name: 'save',
+        message: `Would you like to use this organization by default?`,
+        initial: true,
+    });
+    if (save) {
+        updateContextFile(props.contextFile, { orgId });
+        writer(props).text(`
+The organization ID has been saved in ${props.contextFile}
+
+If you'd like to change the default organization later, use
+
+    neonctl set-context --org-id <org_id>
+
+Or to clear the context file and forget the default organization
+
+    neonctl set-context
+
+`);
+    }
+    return orgId;
+};
+const onPromptState = (state) => {
+    if (state.aborted) {
+        // If we don't re-enable the terminal cursor before exiting
+        // the program, the cursor will remain hidden
+        process.stdout.write('\x1B[?25h');
+        process.stdout.write('\n');
+        process.exit(1);
+    }
+};

package/commands/projects.test.js

@@ -13,6 +13,15 @@ describe('projects', () => {
     test('create', async ({ testCliCommand }) => {
         await testCliCommand(['projects', 'create', '--name', 'test_project']);
     });
+    test('create with hipaa flag', async ({ testCliCommand }) => {
+        await testCliCommand([
+            'projects',
+            'create',
+            '--name',
+            'test_project',
+            '--hipaa',
+        ]);
+    });
     test('create with org id', async ({ testCliCommand }) => {
         await testCliCommand([
             'projects',
@@ -102,6 +111,9 @@ describe('projects', () => {
             'test_project_new_name',
         ]);
     });
+    test('update hipaa flag', async ({ testCliCommand }) => {
+        await testCliCommand(['projects', 'update', 'test', '--hipaa']);
+    });
     test('update project with default fixed size CU', async ({ testCliCommand, }) => {
         await testCliCommand([
             'projects',

package/commands/schema_diff.js

@@ -59,14 +59,13 @@ const createSchemaDiff = async (baseBranch, pointInTime, database, props) => {
 };
 const fetchSchema = async (pointInTime, database, props) => {
     try {
-        return props.apiClient
-            .getProjectBranchSchema({
+        const response = await props.apiClient.getProjectBranchSchema({
             projectId: props.projectId,
             branchId: pointInTime.branchId,
             db_name: database.name,
             ...pointInTimeParams(pointInTime),
-        })
-            .then((response) => response.data.sql ?? '');
+        });
+        return response.data.sql ?? '';
     }
     catch (error) {
         if (isAxiosError(error)) {

package/package.json

@@ -5,7 +5,7 @@
     "url": "git+ssh://git@github.com/neondatabase/neonctl.git"
   },
   "type": "module",
-  "version": "2.9.2",
+  "version": "2.11.0",
   "description": "CLI tool for NeonDB Cloud management",
   "main": "index.js",
   "author": "NeonDB",
@@ -22,7 +22,7 @@
     "@apidevtools/swagger-parser": "^10.1.0",
     "@commitlint/cli": "^17.6.5",
     "@commitlint/config-conventional": "^17.6.5",
-    "@eslint/js": "^9.6.0",
+    "@eslint/js": "^9.23.0",
     "@rollup/plugin-commonjs": "^25.0.2",
     "@rollup/plugin-json": "^6.0.0",
     "@rollup/plugin-node-resolve": "^15.1.0",
@@ -39,7 +39,7 @@
     "@types/which": "^3.0.0",
     "@types/yargs": "^17.0.24",
     "emocks": "^3.0.1",
-    "eslint": "^9.6.0",
+    "eslint": "^9.23.0",
     "express": "^4.18.2",
     "husky": "^8.0.3",
     "lint-staged": "^13.0.3",
@@ -50,11 +50,11 @@
     "semantic-release": "^23.0.8",
     "strip-ansi": "^7.1.0",
     "typescript": "^4.7.4",
-    "typescript-eslint": "v8.0.0-alpha.41",
-    "vitest": "^1.6.1"
+    "typescript-eslint": "8.28.0",
+    "vitest": "^1.6.0"
   },
   "dependencies": {
-    "@neondatabase/api-client": "1.12.0",
+    "@neondatabase/api-client": "2.1.0",
     "@segment/analytics-node": "^1.0.0-beta.26",
     "axios": "^1.4.0",
     "axios-debug-log": "^1.0.0",

package/parameters.gen.js

@@ -22,7 +22,7 @@ export const projectCreateRequest = {
     },
     'project.settings.quota.logical_size_bytes': {
         type: "number",
-        description: "Limit on the logical size of every project's branch.\n",
+        description: "Limit on the logical size of every project's branch.\n\nIf a branch exceeds its `logical_size_bytes` quota, computes can still be started,\nbut write operations will fail—allowing data to be deleted to free up space.\nComputes on other branches are not affected.\n\nSetting `logical_size_bytes` overrides any lower value set by the `neon.max_cluster_size` Postgres setting.\n",
         demandOption: false,
     },
     'project.settings.allowed_ips.ips': {
@@ -65,9 +65,30 @@ export const projectCreateRequest = {
         description: "When set, connections using VPC endpoints are disallowed.\nThis parameter is under active development and its semantics may change in the future.\n",
         demandOption: false,
     },
+    'project.settings.audit_log_level': {
+        type: "string",
+        description: undefined,
+        demandOption: false,
+        choices: ["base", "extended", "full"],
+    },
+    'project.settings.hipaa': {
+        type: "boolean",
+        description: undefined,
+        demandOption: false,
+    },
+    'project.settings.preload_libraries.use_defaults': {
+        type: "boolean",
+        description: undefined,
+        demandOption: false,
+    },
+    'project.settings.preload_libraries.enabled_libraries': {
+        type: "array",
+        description: undefined,
+        demandOption: false,
+    },
     'project.name': {
         type: "string",
-        description: "The project name",
+        description: "The project name. If not specified, the name will be identical to the generated project ID",
         demandOption: false,
     },
     'project.branch.name': {
@@ -144,7 +165,7 @@ export const projectUpdateRequest = {
     },
     'project.settings.quota.logical_size_bytes': {
         type: "number",
-        description: "Limit on the logical size of every project's branch.\n",
+        description: "Limit on the logical size of every project's branch.\n\nIf a branch exceeds its `logical_size_bytes` quota, computes can still be started,\nbut write operations will fail—allowing data to be deleted to free up space.\nComputes on other branches are not affected.\n\nSetting `logical_size_bytes` overrides any lower value set by the `neon.max_cluster_size` Postgres setting.\n",
         demandOption: false,
     },
     'project.settings.allowed_ips.ips': {
@@ -187,6 +208,27 @@ export const projectUpdateRequest = {
         description: "When set, connections using VPC endpoints are disallowed.\nThis parameter is under active development and its semantics may change in the future.\n",
         demandOption: false,
     },
+    'project.settings.audit_log_level': {
+        type: "string",
+        description: undefined,
+        demandOption: false,
+        choices: ["base", "extended", "full"],
+    },
+    'project.settings.hipaa': {
+        type: "boolean",
+        description: undefined,
+        demandOption: false,
+    },
+    'project.settings.preload_libraries.use_defaults': {
+        type: "boolean",
+        description: undefined,
+        demandOption: false,
+    },
+    'project.settings.preload_libraries.enabled_libraries': {
+        type: "array",
+        description: undefined,
+        demandOption: false,
+    },
     'project.name': {
         type: "string",
         description: "The project name",
@@ -241,7 +283,7 @@ export const branchCreateRequest = {
     },
     'branch.init_source': {
         type: "string",
-        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",
+        description: "The source of initialization for the branch. Valid values are `schema-only` and `parent-data` (default).\n  * `schema-only` - creates a new root branch containing only the schema. Use `parent_id` to specify the source branch. Optionally, you can provide `parent_lsn` or `parent_timestamp` to branch from a specific point in time or LSN. These fields define which branch to copy the schema from and at what point—they do not establish a parent-child relationship between the `parent_id` branch and the new schema-only branch.\n  * `parent-data` - creates the branch with both schema and data from the parent.\n",
         demandOption: false,
     },
 };