neonctl 1.2.0 → 1.3.0

package/api.js

@@ -1,3 +1,3 @@
 import { createApiClient } from '@neondatabase/api-client';
-export const getApiClient = ({ apiKey, apiHost }) => createApiClient({ apiKey, baseURL: apiHost });
+export const getApiClient = ({ apiKey, apiHost }) => createApiClient({ apiKey, baseURL: apiHost, timeout: 10000 });
 export const isApiError = (err) => err instanceof Error && 'response' in err;

package/commands/auth.js

@@ -52,7 +52,10 @@ export const ensureAuth = async (props) => {
                 const refreshedTokenSet = await refreshToken({
                     oauthHost: props.oauthHost,
                     clientId: props.clientId,
-                }, tokenSet);
+                }, tokenSet).catch((e) => {
+                    log.error('failed to refresh token\n%s', e?.message);
+                    process.exit(1);
+                });
                 props.apiKey = refreshedTokenSet.access_token || 'UNKNOWN';
                 props.apiClient = getApiClient({
                     apiKey: props.apiKey,

package/commands/branches.js

@@ -0,0 +1,91 @@
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { writeOut } from '../writer.js';
+import { branchCreateRequest, branchCreateRequestEndpointOptions, branchUpdateRequest, } from '../parameters.gen.js';
+export const command = 'branches';
+export const describe = 'Manage branches';
+export const builder = (argv) => argv
+    .demandCommand(1, '')
+    .fail(async (_msg, _err, argv) => {
+    const y = yargs(hideBin(process.argv));
+    if (y.argv._.length === 1) {
+        argv.showHelp();
+        process.exit(1);
+    }
+})
+    .usage('usage: $0 branches <cmd> [args]')
+    .options({
+    'project.id': {
+        describe: 'Project ID',
+        type: 'string',
+        demandOption: true,
+    },
+})
+    .command('list', 'List branches', (yargs) => yargs, async (args) => await list(args))
+    .command('create', 'Create a branch', (yargs) => yargs.options({
+    ...branchCreateRequest,
+    ...Object.fromEntries(Object.entries(branchCreateRequestEndpointOptions).map(([key, value]) => [`endpoint.${key}`, value])),
+}), async (args) => await create(args))
+    .command('update', 'Update a branch', (yargs) => yargs.options(branchUpdateRequest).option('branch.id', {
+    describe: 'Branch ID',
+    type: 'string',
+    demandOption: true,
+}), async (args) => await update(args))
+    .command('delete', 'Delete a branch', (yargs) => yargs.option('branch.id', {
+    describe: 'Branch ID',
+    type: 'string',
+    demandOption: true,
+}), async (args) => await deleteBranch(args));
+export const handler = (args) => {
+    return args;
+};
+const list = async (props) => {
+    const { data } = await props.apiClient.listProjectBranches(props.project.id);
+    writeOut(props)(data.branches, {
+        fields: ['id', 'name', 'created_at'],
+    });
+};
+const create = async (props) => {
+    const { data } = await props.apiClient.createProjectBranch(props.project.id, {
+        branch: props.branch,
+        endpoints: props.endpoint ? [props.endpoint] : undefined,
+    });
+    writeOut(props)({
+        branch: {
+            data: data.branch,
+            config: { fields: ['id', 'name', 'created_at'] },
+        },
+        ...(data.endpoints?.length > 0
+            ? {
+                endpoints: {
+                    data: data.endpoints,
+                    config: { fields: ['id', 'created_at'] },
+                },
+            }
+            : {}),
+        ...(data.connection_uris
+            ? {
+                connection_uri: {
+                    data: data.connection_uris[0],
+                    config: {
+                        fields: ['connection_uri'],
+                    },
+                },
+            }
+            : {}),
+    });
+};
+const update = async (props) => {
+    const { data } = await props.apiClient.updateProjectBranch(props.project.id, props.branch.id, {
+        branch: props.branch,
+    });
+    writeOut(props)(data.branch, {
+        fields: ['id', 'name', 'created_at'],
+    });
+};
+const deleteBranch = async (props) => {
+    const { data } = await props.apiClient.deleteProjectBranch(props.project.id, props.branch.id);
+    writeOut(props)(data.branch, {
+        fields: ['id', 'name', 'created_at'],
+    });
+};

package/commands/index.js

@@ -1,4 +1,5 @@
 import * as auth from './auth.js';
 import * as projects from './projects.js';
 import * as users from './users.js';
-export default [auth, projects, users];
+import * as branches from './branches.js';
+export default [auth, projects, users, branches];

package/commands/projects.js

@@ -1,14 +1,19 @@
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
 import { projectCreateRequest } from '../parameters.gen.js';
 import { writeOut } from '../writer.js';
 const PROJECT_FIELDS = ['id', 'name', 'region_id', 'created_at'];
 export const command = 'projects [command]';
 export const describe = 'Manage projects';
-export const builder = (yargs) => {
-    return yargs
+export const builder = (argv) => {
+    return argv
         .demandCommand(1, '')
-        .fail((msg, err, yargs) => {
-        yargs.showHelp();
-        process.exit(1);
+        .fail((_msg, _err, yyargs) => {
+        const y = yargs(hideBin(process.argv));
+        if (y.argv._.length === 1) {
+            yyargs.showHelp();
+            process.exit(1);
+        }
     })
         .usage('usage: $0 projects <cmd> [args]')
         .command('list', 'List projects', (yargs) => yargs, async (args) => {
@@ -46,11 +51,14 @@ const list = async (props) => {
 };
 const create = async (props) => {
     if (props.project == null) {
+        props.project = {};
         const inquirer = await import('inquirer');
         const answers = await inquirer.default.prompt([
-            { name: 'name', message: 'Project name', type: 'input' },
+            { name: 'name', message: 'Project name (optional)', type: 'input' },
         ]);
-        props.project = answers;
+        if (answers.name) {
+            props.project = answers;
+        }
     }
     writeOut(props)((await props.apiClient.createProject({
         project: props.project,

package/index.js

@@ -2,6 +2,7 @@ import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { fileURLToPath } from 'node:url';
 import { readFileSync } from 'node:fs';
+import 'axios-debug-log';
 import { ensureAuth } from './commands/auth.js';
 import { defaultDir, ensureConfigDir } from './config.js';
 import { log } from './log.js';
@@ -15,6 +16,7 @@ const builder = yargs(hideBin(process.argv))
     .usage('usage: $0 <cmd> [args]')
     .help()
     .option('output', {
+    alias: 'o',
     describe: 'Set output format',
     type: 'string',
     choices: ['json', 'yaml', 'table'],

package/package.json

@@ -5,7 +5,7 @@
     "url": "git@github.com:neondatabase/neonctl.git"
   },
   "type": "module",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "CLI tool for NeonDB Cloud management",
   "main": "index.js",
   "author": "NeonDB",
@@ -18,6 +18,8 @@
     "neonctl": "cli.js"
   },
   "devDependencies": {
+    "@apidevtools/swagger-parser": "^10.1.0",
+    "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@types/cli-table": "^0.3.0",
     "@types/inquirer": "^9.0.3",
@@ -30,13 +32,14 @@
     "lint-staged": "^13.0.3",
     "prettier": "^2.7.1",
     "semantic-release": "^21.0.2",
-    "ts-morph": "^18.0.0",
     "ts-node": "^10.9.1",
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@neondatabase/api-client": "^0.1.0",
+    "@neondatabase/api-client": "^1.1.0",
     "axios": "^1.4.0",
+    "axios-debug-log": "^1.0.0",
+    "chalk": "^5.2.0",
     "cli-table": "^0.3.11",
     "inquirer": "^9.2.6",
     "open": "^8.4.0",
@@ -53,7 +56,7 @@
     "lint": "tsc --noEmit && eslint src --ext .ts",
     "build": "npm run generateParams && npm run clean && tsc && cp src/*.html dist/ && cp package.json ./dist",
     "clean": "rm -rf dist",
-    "generateParams": "ts-node --esm generateParams.ts",
+    "generateParams": "ts-node --esm generateOptionsFromSpec.ts",
     "start": "node src/index.js"
   },
   "lint-staged": {

package/parameters.gen.js

@@ -1,64 +1,100 @@
 // FILE IS GENERATED, DO NOT EDIT
 export const projectCreateRequest = {
     'project.settings.quota.active_time_seconds': {
-        type: 'number',
-        description: "The total amount of wall-clock time allowed to be spent by project's compute endpoints.",
+        type: "number",
+        description: "The total amount of wall-clock time allowed to be spent by project's compute endpoints.\n",
     },
     'project.settings.quota.compute_time_seconds': {
-        type: 'number',
-        description: "The total amount of CPU seconds allowed to be spent by project's compute endpoints.",
+        type: "number",
+        description: "The total amount of CPU seconds allowed to be spent by project's compute endpoints.\n",
     },
     'project.settings.quota.written_data_bytes': {
-        type: 'number',
-        description: "Total amount of data written to all project's branches.",
+        type: "number",
+        description: "Total amount of data written to all project's branches.\n",
     },
     'project.settings.quota.data_transfer_bytes': {
-        type: 'number',
-        description: "Total amount of data transferred from all project's branches using proxy.",
+        type: "number",
+        description: "Total amount of data transferred from all project's branches using proxy.\n",
     },
     'project.settings.quota.logical_size_bytes': {
-        type: 'number',
-        description: "Limit on the logical size of every project's branch.",
+        type: "number",
+        description: "Limit on the logical size of every project's branch.\n",
     },
     'project.name': {
-        type: 'string',
+        type: "string",
         description: "The project name",
     },
     'project.branch.name': {
-        type: 'string',
-        description: "The branch name. If not specified, the default branch name will be used.",
+        type: "string",
+        description: "The branch name. If not specified, the default branch name will be used.\n",
     },
     'project.branch.role_name': {
-        type: 'string',
-        description: "The role name. If not specified, the default role name will be used.",
+        type: "string",
+        description: "The role name. If not specified, the default role name will be used.\n",
     },
     'project.branch.database_name': {
-        type: 'string',
-        description: "The database name. If not specified, the default database name will be used.",
-    },
-    'project.autoscaling_limit_min_cu': {
-        type: 'number',
-        description: "The minimum number of CPU units",
-    },
-    'project.autoscaling_limit_max_cu': {
-        type: 'number',
-        description: "The maximum number of CPU units",
+        type: "string",
+        description: "The database name. If not specified, the default database name will be used.\n",
     },
     'project.provisioner': {
-        type: 'string',
+        type: "string",
+        description: "The Neon compute provisioner.\n",
         choices: ["k8s-pod", "k8s-neonvm", "docker"],
-        description: "The Neon compute provisioner.",
     },
     'project.region_id': {
-        type: 'string',
-        description: "The region identifier. See [the documentation](https://neon.tech/docs/introduction/regions) for the list of supported regions.",
+        type: "string",
+        description: "The region identifier. See [the documentation](https://neon.tech/docs/introduction/regions) for the list of supported regions.\n",
     },
     'project.pg_version': {
-        type: 'number',
+        type: "number",
         description: "The major PostgreSQL version number. Currently supported version are `14` and `15`.",
     },
     'project.store_passwords': {
-        type: 'boolean',
-        description: "Whether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.",
+        type: "boolean",
+        description: "Whether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.\n",
+    },
+    'project.history_retention_seconds': {
+        type: "number",
+        description: "The number of seconds to retain PITR backup history for this project. Defaults to 7 days\n",
+    },
+};
+export const branchCreateRequest = {
+    'branch.parent_id': {
+        type: "string",
+        description: "The `branch_id` of the parent branch\n",
+    },
+    'branch.name': {
+        type: "string",
+        description: "The branch name\n",
+    },
+    'branch.parent_lsn': {
+        type: "string",
+        description: "A Log Sequence Number (LSN) on the parent branch. The branch will be created with data from this LSN.\n",
+    },
+    '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",
+    },
+};
+export const branchCreateRequestEndpointOptions = {
+    'type': {
+        type: "string",
+        description: "The compute endpoint type. Either `read_write` or `read_only`.\nThe `read_only` compute endpoint type is not yet supported.\n",
+        choices: ["read_only", "read_write"],
+    },
+    'provisioner': {
+        type: "string",
+        description: "The Neon compute provisioner.\n",
+        choices: ["k8s-pod", "k8s-neonvm", "docker"],
+    },
+    'suspend_timeout_seconds': {
+        type: "number",
+        description: "Duration of inactivity in seconds after which endpoint will be\nautomatically suspended. Value `0` means use global default,\n`-1` means never suspend. Maximum value is 1 week in seconds.\n",
+    },
+};
+export const branchUpdateRequest = {
+    'branch.name': {
+        type: "string",
+        description: undefined,
     },
 };

package/writer.js

@@ -1,33 +1,62 @@
 import YAML from 'yaml';
 import Table from 'cli-table';
+import chalk from 'chalk';
 // Allow PIPE to finish reading before the end of the output.
 process.stdout.on('error', function (err) {
     if (err.code == 'EPIPE') {
         process.exit(0);
     }
 });
-export const writeOut = (props) => (data, config) => {
+/**
+ *
+ * Parses the output format, takes data and writes the output to stdout.
+ *
+ * @example
+ * // to output single data
+ * const { data } = await props.apiClient.listProjectBranches(props.project.id);
+ * writeOut(props)(data, { fields: ['id', 'name', 'created_at'] })
+ * // to output multiple data
+ * writeOut(props)({
+ *  branches: {
+ *   data,
+ *  config: { fields: ['id', 'name', 'created_at'] }
+ * },
+ * endpoints: {
+ *  data,
+ *  config: { fields: ['id', 'created_at'] }
+ * }
+ * })
+ */
+export const writeOut = (props) => (arg1, arg2) => {
     if (props.output == 'yaml') {
-        process.stdout.write(YAML.stringify(data, null, 2));
+        process.stdout.write(YAML.stringify(arg2 === undefined
+            ? Object.fromEntries(Object.entries(arg1).map(([k, v]) => [k, v.data]))
+            : arg1, null, 2));
         return;
     }
     if (props.output == 'json') {
-        process.stdout.write(JSON.stringify(data, null, 2));
+        process.stdout.write(JSON.stringify(arg2 === undefined
+            ? Object.fromEntries(Object.entries(arg1).map(([k, v]) => [k, v.data]))
+            : arg1, null, 2));
         return;
     }
-    const arrayData = Array.isArray(data) ? data : [data];
-    const table = new Table({
-        style: {
-            head: ['green'],
-        },
-        head: config.fields.map((field) => field
-            .split('_')
-            .map((word) => word[0].toUpperCase() + word.slice(1))
-            .join(' ')),
+    const options = arg2 === undefined ? arg1 : { '': { data: arg1, config: arg2 } };
+    Object.entries(options).forEach(([key, { data, config }]) => {
+        const arrayData = Array.isArray(data) ? data : [data];
+        const table = new Table({
+            style: {
+                head: ['green'],
+            },
+            head: config.fields.map((field) => field
+                .split('_')
+                .map((word) => word[0].toUpperCase() + word.slice(1))
+                .join(' ')),
+        });
+        arrayData.forEach((item) => {
+            table.push(config.fields.map((field) => item[field] ?? ''));
+        });
+        process.stdout.write(chalk.bold(key) + '\n');
+        process.stdout.write(table.toString());
+        process.stdout.write('\n');
     });
-    arrayData.forEach((item) => {
-        table.push(config.fields.map((field) => item[field] ?? ''));
-    });
-    process.stdout.write(table.toString());
-    process.stdout.write('\n');
 };