neonctl 1.29.1 → 1.29.4

package/src/parameters.gen.ts

@@ -1,332 +0,0 @@
-// 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 the project's compute endpoints.\n",
-              demandOption: false,
-  },
-  'project.settings.quota.compute_time_seconds': {
-              type: "number",
-              description: "The total amount of CPU seconds allowed to be spent by the project's compute endpoints.\n",
-              demandOption: false,
-  },
-  'project.settings.quota.written_data_bytes': {
-              type: "number",
-              description: "Total amount of data written to all of a project's branches.\n",
-              demandOption: false,
-  },
-  'project.settings.quota.data_transfer_bytes': {
-              type: "number",
-              description: "Total amount of data transferred from all of a project's branches using the proxy.\n",
-              demandOption: false,
-  },
-  'project.settings.quota.logical_size_bytes': {
-              type: "number",
-              description: "Limit on the logical size of every project's branch.\n",
-              demandOption: false,
-  },
-  'project.settings.allowed_ips.ips': {
-              type: "array",
-              description: "A list of IP addresses that are allowed to connect to the endpoint.",
-              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",
-              demandOption: false,
-  },
-  'project.branch.name': {
-              type: "string",
-              description: "The branch name. If not specified, the default branch name will be used.\n",
-              demandOption: false,
-  },
-  'project.branch.role_name': {
-              type: "string",
-              description: "The role name. If not specified, the default role name will be used.\n",
-              demandOption: false,
-  },
-  'project.branch.database_name': {
-              type: "string",
-              description: "The database name. If not specified, the default database name will be used.\n",
-              demandOption: false,
-  },
-  'project.provisioner': {
-              type: "string",
-              description: "The Neon compute provisioner.\nSpecify the `k8s-neonvm` provisioner to create a compute endpoint that supports Autoscaling.\n",
-              demandOption: false,
- choices: ["k8s-pod","k8s-neonvm"],
-  },
-  'project.region_id': {
-              type: "string",
-              description: "The region identifier. Refer to our [Regions](https://neon.tech/docs/introduction/regions) documentation for supported regions. Values are specified in this format: `aws-us-east-1`\n",
-              demandOption: false,
-  },
-  '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",
-              demandOption: false,
-  },
-  'project.pg_version': {
-              type: "number",
-              description: "The major Postgres version number. Currently supported versions are `14`, `15`, and `16`.",
-              demandOption: false,
-  },
-  '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.\n",
-              demandOption: false,
-  },
-  'project.history_retention_seconds': {
-              type: "number",
-              description: "The number of seconds to retain the point-in-time restore (PITR) backup history for this project.\nThe default is 604800 seconds (7 days).\n",
-              demandOption: false,
-  },
-} as const;
-
-export const projectUpdateRequest = {
-  'project.settings.quota.active_time_seconds': {
-              type: "number",
-              description: "The total amount of wall-clock time allowed to be spent by the project's compute endpoints.\n",
-              demandOption: false,
-  },
-  'project.settings.quota.compute_time_seconds': {
-              type: "number",
-              description: "The total amount of CPU seconds allowed to be spent by the project's compute endpoints.\n",
-              demandOption: false,
-  },
-  'project.settings.quota.written_data_bytes': {
-              type: "number",
-              description: "Total amount of data written to all of a project's branches.\n",
-              demandOption: false,
-  },
-  'project.settings.quota.data_transfer_bytes': {
-              type: "number",
-              description: "Total amount of data transferred from all of a project's branches using the proxy.\n",
-              demandOption: false,
-  },
-  'project.settings.quota.logical_size_bytes': {
-              type: "number",
-              description: "Limit on the logical size of every project's branch.\n",
-              demandOption: false,
-  },
-  'project.settings.allowed_ips.ips': {
-              type: "array",
-              description: "A list of IP addresses that are allowed to connect to the endpoint.",
-              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",
-              demandOption: false,
-  },
-  '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",
-              demandOption: false,
-  },
-  'project.history_retention_seconds': {
-              type: "number",
-              description: "The number of seconds to retain the point-in-time restore (PITR) backup history for this project.\nThe default is 604800 seconds (7 days).\n",
-              demandOption: false,
-  },
-} as const;
-
-export const branchCreateRequest = {
-  'endpoints': {
-              type: "array",
-              description: undefined,
-              demandOption: false,
-  },
-  '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",
-              demandOption: false,
-  },
-  'branch.name': {
-              type: "string",
-              description: "The branch name\n",
-              demandOption: false,
-  },
-  '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",
-              demandOption: false,
-  },
-  '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.\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,
-  },
-} as const;
-
-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",
-              demandOption: true,
- choices: ["read_only","read_write"],
-  },
-  'provisioner': {
-              type: "string",
-              description: "The Neon compute provisioner.\nSpecify the `k8s-neonvm` provisioner to create a compute endpoint that supports Autoscaling.\n",
-              demandOption: false,
- choices: ["k8s-pod","k8s-neonvm"],
-  },
-  '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",
-              demandOption: false,
-  },
-} as const;
-
-export const branchUpdateRequest = {
-  'branch.name': {
-              type: "string",
-              description: undefined,
-              demandOption: false,
-  },
-  'branch.protected': {
-              type: "boolean",
-              description: undefined,
-              demandOption: false,
-  },
-} as const;
-
-export const endpointCreateRequest = {
-  'endpoint.branch_id': {
-              type: "string",
-              description: "The ID of the branch the compute endpoint will be associated with\n",
-              demandOption: true,
-  },
-  'endpoint.region_id': {
-              type: "string",
-              description: "The region where the compute endpoint will be created. Only the project's `region_id` is permitted.\n",
-              demandOption: false,
-  },
-  'endpoint.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",
-              demandOption: true,
- choices: ["read_only","read_write"],
-  },
-  'endpoint.provisioner': {
-              type: "string",
-              description: "The Neon compute provisioner.\nSpecify the `k8s-neonvm` provisioner to create a compute endpoint that supports Autoscaling.\n",
-              demandOption: false,
- choices: ["k8s-pod","k8s-neonvm"],
-  },
-  'endpoint.pooler_enabled': {
-              type: "boolean",
-              description: "Whether to enable connection pooling for the compute endpoint\n",
-              demandOption: false,
-  },
-  'endpoint.pooler_mode': {
-              type: "string",
-              description: "The connection pooler mode. Neon supports PgBouncer in `transaction` mode only.\n",
-              demandOption: false,
- choices: ["transaction"],
-  },
-  'endpoint.disabled': {
-              type: "boolean",
-              description: "Whether to restrict connections to the compute endpoint.\nEnabling this option schedules a suspend compute operation.\nA disabled compute endpoint cannot be enabled by a connection or\nconsole action. However, the compute endpoint is periodically\nenabled by check_availability operations.\n",
-              demandOption: false,
-  },
-  'endpoint.passwordless_access': {
-              type: "boolean",
-              description: "NOT YET IMPLEMENTED. Whether to permit passwordless access to the compute endpoint.\n",
-              demandOption: false,
-  },
-  '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",
-              demandOption: false,
-  },
-} as const;
-
-export const endpointUpdateRequest = {
-  'endpoint.branch_id': {
-              type: "string",
-              description: "The destination branch ID. The destination branch must not have an exsiting read-write endpoint.\n",
-              demandOption: false,
-  },
-  'endpoint.provisioner': {
-              type: "string",
-              description: "The Neon compute provisioner.\nSpecify the `k8s-neonvm` provisioner to create a compute endpoint that supports Autoscaling.\n",
-              demandOption: false,
- choices: ["k8s-pod","k8s-neonvm"],
-  },
-  'endpoint.pooler_enabled': {
-              type: "boolean",
-              description: "Whether to enable connection pooling for the compute endpoint\n",
-              demandOption: false,
-  },
-  'endpoint.pooler_mode': {
-              type: "string",
-              description: "The connection pooler mode. Neon supports PgBouncer in `transaction` mode only.\n",
-              demandOption: false,
- choices: ["transaction"],
-  },
-  'endpoint.disabled': {
-              type: "boolean",
-              description: "Whether to restrict connections to the compute endpoint.\nEnabling this option schedules a suspend compute operation.\nA disabled compute endpoint cannot be enabled by a connection or\nconsole action. However, the compute endpoint is periodically\nenabled by check_availability operations.\n",
-              demandOption: false,
-  },
-  'endpoint.passwordless_access': {
-              type: "boolean",
-              description: "NOT YET IMPLEMENTED. Whether to permit passwordless access to the compute endpoint.\n",
-              demandOption: false,
-  },
-  '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",
-              demandOption: false,
-  },
-} as const;
-
-export const databaseCreateRequest = {
-  'database.name': {
-              type: "string",
-              description: "The name of the datbase\n",
-              demandOption: true,
-  },
-  'database.owner_name': {
-              type: "string",
-              description: "The name of the role that owns the database\n",
-              demandOption: true,
-  },
-} as const;
-
-export const roleCreateRequest = {
-  'role.name': {
-              type: "string",
-              description: "The role name. Cannot exceed 63 bytes in length.\n",
-              demandOption: true,
-  },
-} as const;
-

package/src/pkg.ts

@@ -1,9 +0,0 @@
-import { readFileSync } from 'node:fs';
-import { fileURLToPath } from 'node:url';
-
-export default JSON.parse(
-  readFileSync(
-    fileURLToPath(new URL('./package.json', import.meta.url)),
-    'utf-8',
-  ),
-);

package/src/test_utils/mock_server.ts

@@ -1,27 +0,0 @@
-import emocks from 'emocks';
-import express from 'express';
-import { Server } from 'node:http';
-import { AddressInfo } from 'node:net';
-import { join } from 'node:path';
-import { log } from '../log';
-
-export const runMockServer = async (mockDir: string) =>
-  new Promise<Server>((resolve) => {
-    const app = express();
-    app.use(express.json());
-    app.use(
-      '/',
-      emocks(join(process.cwd(), 'mocks', mockDir), {
-        '404': (req, res) => res.status(404).send({ message: 'Not Found' }),
-      }),
-    );
-
-    const server = app.listen(0);
-    server.on('listening', () => {
-      resolve(server);
-      log.info(
-        'Mock server listening at %d',
-        (server.address() as AddressInfo).port,
-      );
-    });
-  });

package/src/test_utils/oauth_server.ts

@@ -1,10 +0,0 @@
-import { log } from '../log';
-import { OAuth2Server } from 'oauth2-mock-server';
-
-export const startOauthServer = async () => {
-  const server = new OAuth2Server();
-  await server.issuer.keys.generate('RS256');
-  await server.start(0, 'localhost');
-  log.info('Started OAuth server');
-  return server;
-};

package/src/test_utils/test_cli_command.ts

@@ -1,117 +0,0 @@
-import { test, expect, describe, beforeAll, afterAll } from '@jest/globals';
-import { fork } from 'node:child_process';
-import { Server } from 'node:http';
-import { AddressInfo } from 'node:net';
-import { join } from 'node:path';
-import { log } from '../log.js';
-import strip from 'strip-ansi';
-
-import { runMockServer } from './mock_server.js';
-
-export type TestCliCommandOptions = {
-  name: string;
-  args: string[];
-  before?: () => Promise<void>;
-  after?: () => Promise<void>;
-  mockDir?: string;
-  expected?: {
-    snapshot?: true;
-    stdout?: string | ReturnType<typeof expect.stringMatching>;
-    stderr?: string | ReturnType<typeof expect.stringMatching>;
-    code?: number;
-  };
-};
-
-export const testCliCommand = ({
-  args,
-  name,
-  expected,
-  before,
-  after,
-  mockDir = 'main',
-}: TestCliCommandOptions) => {
-  let server: Server;
-  describe(name, () => {
-    beforeAll(async () => {
-      if (before) {
-        await before();
-      }
-      server = await runMockServer(mockDir);
-    });
-
-    afterAll(async () => {
-      if (after) {
-        await after();
-      }
-      return new Promise<void>((resolve) => {
-        server.close(() => {
-          resolve();
-        });
-      });
-    });
-
-    test('test', async () => {
-      let output = '';
-      let error = '';
-
-      const cp = fork(
-        join(process.cwd(), './dist/index.js'),
-        [
-          '--api-host',
-          `http://localhost:${(server.address() as AddressInfo).port}`,
-          '--output',
-          'yaml',
-          '--api-key',
-          'test-key',
-          '--no-analytics',
-          ...args,
-        ],
-        {
-          stdio: 'pipe',
-          env: {
-            PATH: `mocks/bin:${process.env.PATH}`,
-          },
-        },
-      );
-
-      return new Promise<void>((resolve, reject) => {
-        cp.stdout?.on('data', (data) => {
-          output += data.toString();
-        });
-
-        cp.stderr?.on('data', (data) => {
-          error += data.toString();
-          log.error(data.toString());
-        });
-
-        cp.on('error', (err) => {
-          throw err;
-        });
-
-        cp.on('close', (code) => {
-          try {
-            expect(code).toBe(expected?.code ?? 0);
-            if (expected) {
-              if (expected.snapshot) {
-                expect(output).toMatchSnapshot();
-              }
-              if (expected.stdout !== undefined) {
-                expect(strip(output)).toEqual(expected.stdout);
-              }
-              if (expected.stderr !== undefined) {
-                expect(strip(error).replace(/\s+/g, ' ').trim()).toEqual(
-                  typeof expected.stderr === 'string'
-                    ? expected.stderr.toString().replace(/\s+/g, ' ')
-                    : expected.stderr,
-                );
-              }
-            }
-            resolve();
-          } catch (err) {
-            reject(err);
-          }
-        });
-      });
-    });
-  });
-};

package/src/types.ts

@@ -1,25 +0,0 @@
-import { Api } from '@neondatabase/api-client';
-
-export type CommonProps = {
-  apiClient: Api<unknown>;
-  apiKey: string;
-  apiHost: string;
-  output: 'yaml' | 'json' | 'table';
-  contextFile: string;
-};
-
-export type ProjectScopeProps = CommonProps & {
-  projectId: string;
-};
-
-export type IdOrNameProps = {
-  id: string;
-};
-
-export type BranchScopeProps = ProjectScopeProps &
-  (
-    | {
-        branch: string;
-      }
-    | IdOrNameProps
-  );

package/src/utils/enrichers.ts

@@ -1,73 +0,0 @@
-import { BranchScopeProps, CommonProps, ProjectScopeProps } from '../types.js';
-import { looksLikeBranchId } from './formats.js';
-
-export const branchIdResolve = async ({
-  branch,
-  apiClient,
-  projectId,
-}: {
-  branch: string | number;
-  apiClient: CommonProps['apiClient'];
-  projectId: string;
-}) => {
-  branch = branch.toString();
-  if (looksLikeBranchId(branch)) {
-    return branch;
-  }
-
-  const { data } = await apiClient.listProjectBranches(projectId);
-  const branchData = data.branches.find((b) => b.name === branch);
-  if (!branchData) {
-    throw new Error(
-      `Branch ${branch} not found.\nAvailable branches: ${data.branches
-        .map((b) => b.name)
-        .join(', ')}`,
-    );
-  }
-  return branchData.id;
-};
-
-export const branchIdFromProps = async (props: BranchScopeProps) => {
-  const branch =
-    'branch' in props && typeof props.branch === 'string'
-      ? props.branch
-      : (props as any).id;
-
-  if (branch) {
-    return await branchIdResolve({
-      branch,
-      apiClient: props.apiClient,
-      projectId: props.projectId,
-    });
-  }
-
-  const { data } = await props.apiClient.listProjectBranches(props.projectId);
-  const primaryBranch = data.branches.find((b) => b.primary);
-
-  if (primaryBranch) {
-    return primaryBranch.id;
-  }
-
-  throw new Error('No primary branch found');
-};
-
-export const fillSingleProject = async (
-  props: CommonProps & Partial<Pick<ProjectScopeProps, 'projectId'>>,
-) => {
-  if (props.projectId) {
-    return props;
-  }
-  const { data } = await props.apiClient.listProjects({});
-  if (data.projects.length === 0) {
-    throw new Error('No projects found');
-  }
-  if (data.projects.length > 1) {
-    throw new Error(
-      `Multiple projects found, please provide one with the --project-id option`,
-    );
-  }
-  return {
-    ...props,
-    projectId: data.projects[0].id,
-  };
-};

package/src/utils/formats.test.ts

@@ -1,41 +0,0 @@
-import { test, describe, expect } from '@jest/globals';
-
-import { looksLikeBranchId, looksLikeLSN, looksLikeTimestamp } from './formats';
-
-describe('branch formats', () => {
-  test('branch name', () => {
-    expect(looksLikeBranchId('master')).toBe(false);
-  });
-
-  test('initial short', () => {
-    expect(looksLikeBranchId('br-flower-sunshine-123456')).toBe(true);
-  });
-
-  test('update 1, longer version', () => {
-    expect(looksLikeBranchId('br-flower-sunshine-12345678')).toBe(true);
-  });
-
-  test('update 2, includes region', () => {
-    expect(looksLikeBranchId('br-bold-recipe-a13oexw7')).toBe(true);
-  });
-});
-
-describe('timestamp formats', () => {
-  test('valid', () => {
-    expect(looksLikeTimestamp('2021-03-13T19:47:33.000Z')).toBe(true);
-  });
-
-  test('invalid', () => {
-    expect(looksLikeTimestamp('branch_name')).toBe(false);
-  });
-});
-
-describe('LSN formats', () => {
-  test('valid', () => {
-    expect(looksLikeLSN('0/1F56000')).toBe(true);
-  });
-
-  test('invalid', () => {
-    expect(looksLikeLSN('branch_name')).toBe(false);
-  });
-});

package/src/utils/formats.ts

@@ -1,11 +0,0 @@
-const HAIKU_REGEX = /^[a-z]+-[a-z]+-[a-z0-9]+$/;
-
-export const looksLikeBranchId = (branch: string) =>
-  branch.startsWith('br-') && HAIKU_REGEX.test(branch.substring(3));
-
-const LSN_REGEX = /^[a-fA-F0-9]{1,8}\/[a-fA-F0-9]{1,8}$/;
-
-export const looksLikeLSN = (lsn: string) => LSN_REGEX.test(lsn);
-
-export const looksLikeTimestamp = (timestamp: string) =>
-  !isNaN(Date.parse(timestamp));

package/src/utils/middlewares.ts

@@ -1,23 +0,0 @@
-/**
- * This middleware is needed to fill in the args for nested objects,
- * so that required arguments would work
- * otherwise yargs just throws an error
- */
-export const fillInArgs = (
-  args: Record<string, unknown>,
-  currentArgs: Record<string, unknown> = args,
-  acc: string[] = [],
-) => {
-  Object.entries(currentArgs).forEach(([k, v]) => {
-    if (k === '_') {
-      return;
-    }
-    // check if the value is an Object
-    if (typeof v === 'object' && v !== null) {
-      fillInArgs(args, v as any, [...acc, k]);
-    } else if (acc.length > 0) {
-      // if it's not an object, and we have a path, fill it in
-      args[acc.join('.') + '.' + k] = v;
-    }
-  });
-};