neonctl 2.28.0 → 2.29.0

package/dist/commands/bucket.js

@@ -1,15 +1,15 @@
-import { createReadStream, createWriteStream } from 'node:fs';
-import { stat, unlink } from 'node:fs/promises';
-import { basename } from 'node:path';
-import { pipeline } from 'node:stream/promises';
-import { isNeonApiError, retryOnLock } from '../api.js';
-import { branchIdFromProps, fillSingleProject } from '../utils/enrichers.js';
-import { log } from '../log.js';
-import { writer } from '../writer.js';
-import { createProjectBranchBucket, listProjectBranchBuckets, deleteProjectBranchBucket, listProjectBranchBucketObjects, getProjectBranchBucketObject, deleteProjectBranchBucketObject, deleteProjectBranchBucketObjectsByPrefix, presignUpload, } from '../storage_api.js';
-const OBJECT_FIELDS = ['key', 'size', 'last_modified', 'etag'];
-const BUCKET_FIELDS = ['name', 'access_level'];
-const ACCESS_LEVELS = ['private', 'public_read'];
+import { createReadStream, createWriteStream } from "node:fs";
+import { stat, unlink } from "node:fs/promises";
+import { basename } from "node:path";
+import { pipeline } from "node:stream/promises";
+import { isNeonApiError, retryOnLock } from "../api.js";
+import { log } from "../log.js";
+import { createProjectBranchBucket, deleteProjectBranchBucket, deleteProjectBranchBucketObject, deleteProjectBranchBucketObjectsByPrefix, getProjectBranchBucketObject, listProjectBranchBucketObjects, listProjectBranchBuckets, presignUpload, } from "../storage_api.js";
+import { branchIdFromProps, fillSingleProject } from "../utils/enrichers.js";
+import { writer } from "../writer.js";
+const OBJECT_FIELDS = ["key", "size", "last_modified", "etag"];
+const BUCKET_FIELDS = ["name", "access_level"];
+const ACCESS_LEVELS = ["private", "public_read"];
 // Single-PUT upload cap. Objects larger than this must use multipart upload,
 // which is out of scope for v1; we reject them client-side before any HTTP so
 // the user gets an immediate, clear error rather than a server-side rejection
@@ -18,13 +18,13 @@ const MAX_OBJECT_BYTES = 100 * 1024 * 1024; // 100 MB
 // Ambient scope shared by every bucket sub-command. The bucket name (and the
 // object key/prefix) is always a positional, never a flag.
 const scopeOptions = {
-    'project-id': {
-        describe: 'Project ID',
-        type: 'string',
+    "project-id": {
+        describe: "Project ID",
+        type: "string",
     },
     branch: {
-        describe: 'Branch ID or name',
-        type: 'string',
+        describe: "Branch ID or name",
+        type: "string",
     },
 };
 // Split an object target into its bucket and the remainder (key or prefix) on
@@ -32,156 +32,156 @@ const scopeOptions = {
 // remainder may contain further slashes and is returned verbatim. When the
 // target has no slash, `rest` is the empty string.
 export const splitBucketTarget = (target) => {
-    const slash = target.indexOf('/');
+    const slash = target.indexOf("/");
     if (slash === -1) {
-        return { bucket: target, rest: '' };
+        return { bucket: target, rest: "" };
     }
     return {
         bucket: target.slice(0, slash),
         rest: target.slice(slash + 1),
     };
 };
-export const command = 'buckets';
-export const describe = 'Manage branch object-storage buckets and their objects';
-export const aliases = ['bucket'];
+export const command = "buckets";
+export const describe = "Manage branch object-storage buckets and their objects";
+export const aliases = ["bucket"];
 export const builder = (argv) => argv
-    .usage('$0 bucket <sub-command> [options]')
+    .usage("$0 bucket <sub-command> [options]")
     .options({
-    'project-id': {
-        describe: 'Project ID',
-        type: 'string',
+    "project-id": {
+        describe: "Project ID",
+        type: "string",
     },
 })
     .middleware(fillSingleProject)
-    .command('create <name>', 'Create a bucket on a branch', (yargs) => yargs
-    .usage('$0 bucket create <name> [options]')
-    .positional('name', {
-    describe: 'The bucket name to create',
-    type: 'string',
+    .command("create <name>", "Create a bucket on a branch", (yargs) => yargs
+    .usage("$0 bucket create <name> [options]")
+    .positional("name", {
+    describe: "The bucket name to create",
+    type: "string",
     demandOption: true,
 })
     .options({
     ...scopeOptions,
-    'access-level': {
-        describe: 'The visibility of the bucket',
-        type: 'string',
+    "access-level": {
+        describe: "The visibility of the bucket",
+        type: "string",
         choices: ACCESS_LEVELS,
-        default: 'private',
+        default: "private",
     },
 }), (args) => createBucket(args))
     .command({
-    command: 'list',
-    aliases: ['ls'],
-    describe: 'List the buckets on a branch',
-    builder: (yargs) => yargs.usage('$0 bucket list [options]').options(scopeOptions),
+    command: "list",
+    aliases: ["ls"],
+    describe: "List the buckets on a branch",
+    builder: (yargs) => yargs.usage("$0 bucket list [options]").options(scopeOptions),
     handler: (args) => listBuckets(args),
 })
     .command({
-    command: 'delete <name>',
-    aliases: ['rm'],
-    describe: 'Delete a bucket from a branch',
+    command: "delete <name>",
+    aliases: ["rm"],
+    describe: "Delete a bucket from a branch",
     builder: (yargs) => yargs
-        .usage('$0 bucket delete <name> [options]')
-        .positional('name', {
-        describe: 'The bucket name to delete',
-        type: 'string',
+        .usage("$0 bucket delete <name> [options]")
+        .positional("name", {
+        describe: "The bucket name to delete",
+        type: "string",
         demandOption: true,
     })
         .options(scopeOptions),
     handler: (args) => deleteBucket(args),
 })
-    .command('object <sub-command>', 'List, download, upload or delete objects in a bucket', (yargs) => yargs
-    .usage('$0 bucket object <sub-command> [options]')
+    .command("object <sub-command>", "List, download, upload or delete objects in a bucket", (yargs) => yargs
+    .usage("$0 bucket object <sub-command> [options]")
     .command({
-    command: 'list <target>',
-    aliases: ['ls'],
+    command: "list <target>",
+    aliases: ["ls"],
     describe: 'List objects in a bucket. By default folders are collapsed (like "aws s3 ls"); pass --recursive for a flat listing of every key',
     builder: (yargs) => yargs
-        .usage('$0 bucket object list <bucket>[/<prefix>] [options]')
-        .positional('target', {
-        describe: 'The bucket to list, optionally with a key prefix: <bucket>[/<prefix>]',
-        type: 'string',
+        .usage("$0 bucket object list <bucket>[/<prefix>] [options]")
+        .positional("target", {
+        describe: "The bucket to list, optionally with a key prefix: <bucket>[/<prefix>]",
+        type: "string",
         demandOption: true,
     })
         .options({
         ...scopeOptions,
         recursive: {
             describe: 'List every key flat, descending into nested folders (no delimiter). Mutually exclusive with --delimiter. Mirrors "aws s3 ls --recursive"',
-            type: 'boolean',
+            type: "boolean",
             default: false,
         },
         delimiter: {
             describe: 'Collapse keys sharing this prefix separator into folders. Defaults to "/" (folder view); ignored when --recursive is set',
-            type: 'string',
+            type: "string",
         },
         cursor: {
-            describe: 'Pagination cursor returned as next_cursor by a previous call',
-            type: 'string',
+            describe: "Pagination cursor returned as next_cursor by a previous call",
+            type: "string",
         },
         limit: {
-            describe: 'Maximum number of items (objects + folders) to return',
-            type: 'number',
+            describe: "Maximum number of items (objects + folders) to return",
+            type: "number",
         },
     }),
     handler: (args) => listObjects(args),
 })
-    .command('get <target>', 'Download an object from a bucket to a local file', (yargs) => yargs
-    .usage('$0 bucket object get <bucket>/<key> [options]')
-    .positional('target', {
-    describe: 'The object to download: <bucket>/<key>',
-    type: 'string',
+    .command("get <target>", "Download an object from a bucket to a local file", (yargs) => yargs
+    .usage("$0 bucket object get <bucket>/<key> [options]")
+    .positional("target", {
+    describe: "The object to download: <bucket>/<key>",
+    type: "string",
     demandOption: true,
 })
     .options({
     ...scopeOptions,
     file: {
-        describe: 'Path to write the downloaded object to (defaults to the object filename in the current directory)',
-        type: 'string',
+        describe: "Path to write the downloaded object to (defaults to the object filename in the current directory)",
+        type: "string",
     },
 }), (args) => getObject(args))
-    .command('put <target>', 'Upload a local file to a bucket as an object', (yargs) => yargs
-    .usage('$0 bucket object put <bucket>/<key> [options]')
-    .positional('target', {
-    describe: 'The object to upload to: <bucket>/<key>',
-    type: 'string',
+    .command("put <target>", "Upload a local file to a bucket as an object", (yargs) => yargs
+    .usage("$0 bucket object put <bucket>/<key> [options]")
+    .positional("target", {
+    describe: "The object to upload to: <bucket>/<key>",
+    type: "string",
     demandOption: true,
 })
     .options({
     ...scopeOptions,
     file: {
-        describe: 'Path to the local file to upload',
-        type: 'string',
+        describe: "Path to the local file to upload",
+        type: "string",
         demandOption: true,
     },
-    'content-type': {
-        describe: 'Content-Type to store the object with (e.g. text/plain)',
-        type: 'string',
+    "content-type": {
+        describe: "Content-Type to store the object with (e.g. text/plain)",
+        type: "string",
     },
 }), (args) => putObject(args))
     .command({
-    command: 'delete <target>',
-    aliases: ['rm'],
-    describe: 'Delete an object, or every object under a prefix',
+    command: "delete <target>",
+    aliases: ["rm"],
+    describe: "Delete an object, or every object under a prefix",
     builder: (yargs) => yargs
-        .usage('$0 bucket object delete <bucket>/<key> [options]')
-        .positional('target', {
-        describe: 'The object to delete: <bucket>/<key>, or <bucket>/<prefix>/ with --recursive',
-        type: 'string',
+        .usage("$0 bucket object delete <bucket>/<key> [options]")
+        .positional("target", {
+        describe: "The object to delete: <bucket>/<key>, or <bucket>/<prefix>/ with --recursive",
+        type: "string",
         demandOption: true,
     })
         .options({
         ...scopeOptions,
         recursive: {
             describe: 'Delete every object under the given prefix. The prefix must end with "/"',
-            type: 'boolean',
+            type: "boolean",
             default: false,
         },
     }),
     handler: (args) => deleteObject(args),
 })
-    .demandCommand(1, '')
+    .demandCommand(1, "")
     .strictCommands())
-    .demandCommand(1, '');
+    .demandCommand(1, "");
 export const handler = (args) => {
     return args;
 };
@@ -201,14 +201,14 @@ const listBuckets = async (props) => {
         projectId: props.projectId,
         branchId,
     });
-    if (props.output === 'json' || props.output === 'yaml') {
+    if (props.output === "json" || props.output === "yaml") {
         writer(props).end(data.buckets, { fields: BUCKET_FIELDS });
         return;
     }
     writer(props).end(data.buckets, {
         fields: BUCKET_FIELDS,
-        title: 'buckets',
-        emptyMessage: 'No buckets found.',
+        title: "buckets",
+        emptyMessage: "No buckets found.",
     });
 };
 const deleteBucket = async (props) => {
@@ -236,7 +236,7 @@ const deleteBucket = async (props) => {
 // rejected client-side before any HTTP request is made.
 export const resolveListDelimiter = (props) => {
     if (props.recursive && props.delimiter !== undefined) {
-        throw new Error('--recursive and --delimiter cannot be used together. Use --recursive for a flat listing, or --delimiter to collapse on a separator.');
+        throw new Error("--recursive and --delimiter cannot be used together. Use --recursive for a flat listing, or --delimiter to collapse on a separator.");
     }
     if (props.recursive) {
         return undefined;
@@ -244,7 +244,7 @@ export const resolveListDelimiter = (props) => {
     if (props.delimiter !== undefined) {
         return props.delimiter;
     }
-    return '/';
+    return "/";
 };
 const listObjects = async (props) => {
     const delimiter = resolveListDelimiter(props);
@@ -254,25 +254,31 @@ const listObjects = async (props) => {
         projectId: props.projectId,
         branchId,
         bucketName: bucket,
-        prefix: rest === '' ? undefined : rest,
+        prefix: rest === "" ? undefined : rest,
         delimiter,
         cursor: props.cursor,
         limit: props.limit,
     });
-    if (props.output === 'json' || props.output === 'yaml') {
+    if (props.output === "json" || props.output === "yaml") {
         writer(props).end(data, {
-            fields: ['folders', 'objects', 'prefix', 'next_cursor', 'is_truncated'],
+            fields: [
+                "folders",
+                "objects",
+                "prefix",
+                "next_cursor",
+                "is_truncated",
+            ],
         });
         return;
     }
     const w = writer(props);
     if (data.folders.length > 0) {
-        w.write(data.folders.map((name) => ({ name })), { fields: ['name'], title: 'folders' });
+        w.write(data.folders.map((name) => ({ name })), { fields: ["name"], title: "folders" });
     }
     w.write(data.objects, {
         fields: OBJECT_FIELDS,
-        title: 'objects',
-        emptyMessage: 'No objects found.',
+        title: "objects",
+        emptyMessage: "No objects found.",
     });
     w.end();
     if (data.is_truncated && data.next_cursor) {
@@ -304,7 +310,7 @@ const filenameFromContentDisposition = (contentDisposition, key) => {
 // the body is absent, not an object, or carries no usable message.
 const serverErrorMessage = (body) => {
     const message = body?.message;
-    return typeof message === 'string' && message.trim() !== ''
+    return typeof message === "string" && message.trim() !== ""
         ? message
         : undefined;
 };
@@ -312,7 +318,7 @@ const serverErrorMessage = (body) => {
 // and parse its `message`. Returns undefined on any read/parse failure so the
 // caller falls back to its default message.
 const streamErrorMessage = async (stream) => {
-    if (typeof stream?.[Symbol.asyncIterator] !== 'function') {
+    if (typeof stream?.[Symbol.asyncIterator] !== "function") {
         return undefined;
     }
     try {
@@ -347,15 +353,15 @@ const fileToWebStream = (path) => {
     const source = createReadStream(path);
     return new ReadableStream({
         start(controller) {
-            source.on('data', (chunk) => {
+            source.on("data", (chunk) => {
                 controller.enqueue(new Uint8Array(chunk));
                 if ((controller.desiredSize ?? 0) <= 0)
                     source.pause();
             });
-            source.on('end', () => {
+            source.on("end", () => {
                 controller.close();
             });
-            source.on('error', (err) => {
+            source.on("error", (err) => {
                 controller.error(err instanceof Error ? err : new Error(String(err)));
             });
         },
@@ -370,8 +376,8 @@ const fileToWebStream = (path) => {
 const getObject = async (props) => {
     const branchId = await branchIdFromProps(props);
     const { bucket, rest: key } = splitBucketTarget(props.target);
-    if (key === '') {
-        throw new Error('Object target must be in the form <bucket>/<key>.');
+    if (key === "") {
+        throw new Error("Object target must be in the form <bucket>/<key>.");
     }
     let response;
     try {
@@ -392,7 +398,7 @@ const getObject = async (props) => {
         }
         throw err;
     }
-    const contentDisposition = response.headers['content-disposition'];
+    const contentDisposition = response.headers["content-disposition"];
     const destination = props.file ?? filenameFromContentDisposition(contentDisposition, key);
     try {
         await pipeline(response.data, createWriteStream(destination));
@@ -407,8 +413,8 @@ const getObject = async (props) => {
 const putObject = async (props) => {
     const branchId = await branchIdFromProps(props);
     const { bucket, rest: key } = splitBucketTarget(props.target);
-    if (bucket === '' || key === '') {
-        throw new Error('Object target must be in the form <bucket>/<key>.');
+    if (bucket === "" || key === "") {
+        throw new Error("Object target must be in the form <bucket>/<key>.");
     }
     // Stat the file first so we fail fast on a missing/unreadable file and can
     // enforce the single-PUT size cap BEFORE any network round-trip. We also
@@ -423,7 +429,7 @@ const putObject = async (props) => {
         fileSize = fileStat.size;
     }
     catch (err) {
-        if (err?.code === 'ENOENT') {
+        if (err?.code === "ENOENT") {
             throw new Error(`File "${props.file}" does not exist.`);
         }
         throw err;
@@ -455,7 +461,7 @@ const putObject = async (props) => {
             // usable message, fall back to a clean status-bearing error.
             const serverMessage = serverErrorMessage(err.data);
             throw new Error(serverMessage ??
-                `Failed to presign upload for "${key}" in bucket "${bucket}" on branch ${branchId}${status !== undefined ? ` (HTTP ${status})` : ''}: ${err.message}`);
+                `Failed to presign upload for "${key}" in bucket "${bucket}" on branch ${branchId}${status !== undefined ? ` (HTTP ${status})` : ""}: ${err.message}`);
         }
         throw err;
     }
@@ -470,14 +476,14 @@ const putObject = async (props) => {
     // endpoint were to answer with a redirect. `duplex: 'half'` is required by
     // fetch when streaming a request body.
     const upload = {
-        method: 'PUT',
+        method: "PUT",
         headers: {
             ...presign.headers,
-            'Content-Length': String(fileSize),
+            "Content-Length": String(fileSize),
         },
         body: fileToWebStream(props.file),
-        redirect: 'error',
-        duplex: 'half',
+        redirect: "error",
+        duplex: "half",
     };
     let uploadResponse;
     try {
@@ -501,10 +507,10 @@ const deleteObject = async (props) => {
     const branchId = await branchIdFromProps(props);
     const { bucket, rest } = splitBucketTarget(props.target);
     if (props.recursive) {
-        if (rest === '') {
+        if (rest === "") {
             throw new Error('Recursive delete requires a non-empty prefix ending in "/".');
         }
-        if (!rest.endsWith('/')) {
+        if (!rest.endsWith("/")) {
             throw new Error(`Recursive delete requires a prefix ending in "/" (got "${rest}").`);
         }
         const { data } = await retryOnLock(() => deleteProjectBranchBucketObjectsByPrefix(props.apiClient, {
@@ -516,8 +522,8 @@ const deleteObject = async (props) => {
         log.info(`Deleted ${data.deleted} object(s) under prefix "${rest}" from bucket "${bucket}" on branch ${branchId}`);
         return;
     }
-    if (rest === '') {
-        throw new Error('Object target must be in the form <bucket>/<key>.');
+    if (rest === "") {
+        throw new Error("Object target must be in the form <bucket>/<key>.");
     }
     try {
         await retryOnLock(() => deleteProjectBranchBucketObject(props.apiClient, {