@design-edito/tools 0.4.23 → 0.5.0

package/node/@aws-s3/storage/file/remove/index.js

@@ -1,16 +1,17 @@
 import { HeadObjectCommand, DeleteObjectCommand } from '@aws-sdk/client-s3';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 import { unknownToString } from '../../../../../agnostic/errors/unknown-to-string/index.js';
+import { deepGetProperty } from '../../../../../agnostic/objects/deep-get-property/index.js';
 /**
  * Removes a file from a specified Amazon S3 bucket (AWS SDK v3).
  *
  * If `ignoreMissing` is true (default), a missing object is considered success.
  *
- * @param {S3Client} s3 - The AWS S3 client instance.
- * @param {string} bucketName - The name of the bucket.
- * @param {string} targetPath - The key of the object to delete.
- * @param {RemoveOptions} [options] - Optional settings.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param s3 - The AWS S3 client instance.
+ * @param bucketName - The name of the bucket.
+ * @param targetPath - The key of the object to delete.
+ * @param [options] - Optional settings.
+ * @returns
  */
 export async function remove(s3, bucketName, targetPath, options) {
     const { ignoreMissing = true } = options ?? {};
@@ -20,12 +21,16 @@ export async function remove(s3, bucketName, targetPath, options) {
             await s3.send(new HeadObjectCommand({ Bucket: bucketName, Key: targetPath }));
         }
         catch (err) {
-            const code = err?.name ?? err?.Code ?? err?.code;
-            if (code === 'NotFound' || code === 'NoSuchKey' || code === 'NotFoundException') {
-                if (ignoreMissing)
-                    return Outcome.makeSuccess(true);
-                return Outcome.makeFailure(`File not found at ${targetPath}.`);
-            }
+            const name = deepGetProperty(err, 'name');
+            const Code = deepGetProperty(err, 'Code');
+            const _code = deepGetProperty(err, 'code');
+            const code = name ?? Code ?? _code;
+            if (code === 'NotFound'
+                || code === 'NoSuchKey'
+                || code === 'NotFoundException')
+                return ignoreMissing
+                    ? Outcome.makeSuccess(true)
+                    : Outcome.makeFailure(`File not found at ${targetPath}.`);
             return Outcome.makeFailure(unknownToString(err));
         }
         // Delete the object

package/node/@aws-s3/storage/file/stat/index.d.ts

@@ -15,10 +15,10 @@ export type StatOptions = {
 /**
  * Retrieves metadata for a single S3 object.
  *
- * @param {S3Client} client – v3 S3 client.
- * @param {string}   bucket – Bucket name.
- * @param {string}   key    – Object key.
- * @param {StatOptions} [options] – Extra HeadObject params.
- * @returns {Promise<Outcome.Either<Stat, string>>}
+ * @param client – v3 S3 client.
+ * @param   bucket – Bucket name.
+ * @param   key    – Object key.
+ * @param [options] – Extra HeadObject params.
+ * @returns
  */
 export declare function stat(client: S3Client, bucket: string, key: string, options?: StatOptions): Promise<Outcome.Either<Stat, string>>;

package/node/@aws-s3/storage/file/stat/index.js

@@ -1,14 +1,15 @@
 import { HeadObjectCommand } from '@aws-sdk/client-s3';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 import { unknownToString } from '../../../../../agnostic/errors/unknown-to-string/index.js';
+import { deepGetProperty } from '../../../../../agnostic/objects/deep-get-property/index.js';
 /**
  * Retrieves metadata for a single S3 object.
  *
- * @param {S3Client} client – v3 S3 client.
- * @param {string}   bucket – Bucket name.
- * @param {string}   key    – Object key.
- * @param {StatOptions} [options] – Extra HeadObject params.
- * @returns {Promise<Outcome.Either<Stat, string>>}
+ * @param client – v3 S3 client.
+ * @param   bucket – Bucket name.
+ * @param   key    – Object key.
+ * @param [options] – Extra HeadObject params.
+ * @returns
  */
 export async function stat(client, bucket, key, options) {
     const { headObjectOptions } = options ?? {};
@@ -17,7 +18,7 @@ export async function stat(client, bucket, key, options) {
         const stat = {
             size: res.ContentLength,
             modifiedAt: res.LastModified,
-            checksum: res.ETag?.replace(/"/g, ''),
+            checksum: res.ETag?.replace(/"/gv, ''),
             contentType: res.ContentType,
             metadata: res.Metadata,
             storageClass: res.StorageClass,
@@ -26,7 +27,9 @@ export async function stat(client, bucket, key, options) {
         return Outcome.makeSuccess(stat);
     }
     catch (err) {
-        const notFound = err.$metadata?.httpStatusCode === 404 || err.name === 'NotFound';
+        const name = deepGetProperty(err, 'name');
+        const httpStatusCode = deepGetProperty(err, '$metadata.httpStatusCode');
+        const notFound = httpStatusCode === 404 || name === 'NotFound';
         if (notFound)
             return Outcome.makeFailure(`Object not found: ${key}`);
         return Outcome.makeFailure(unknownToString(err));

package/node/@aws-s3/storage/file/upload/index.d.ts

@@ -1,4 +1,4 @@
-import { type Readable } from 'node:stream';
+import type { Readable } from 'node:stream';
 import { type S3Client, type PutObjectCommandInput } from '@aws-sdk/client-s3';
 import { Upload } from '@aws-sdk/lib-storage';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
@@ -12,11 +12,11 @@ export type UploadOptions = {
  *
  * If `overwrite` is false and the target file exists, upload is aborted.
  *
- * @param {S3Client} s3 - The AWS S3 v3 client instance.
- * @param {string} bucketName - The S3 bucket name.
- * @param {string} targetPath - The key to upload the file to.
- * @param {Readable} fileStream - The file content as a stream.
- * @param {UploadOptions} [options] - Optional configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param s3 - The AWS S3 v3 client instance.
+ * @param bucketName - The S3 bucket name.
+ * @param targetPath - The key to upload the file to.
+ * @param fileStream - The file content as a stream.
+ * @param [options] - Optional configuration.
+ * @returns
  */
 export declare function upload(s3: S3Client, bucketName: string, targetPath: string, fileStream: Readable, options?: UploadOptions): Promise<Outcome.Either<true, string>>;

package/node/@aws-s3/storage/file/upload/index.js

@@ -2,17 +2,18 @@ import { HeadObjectCommand } from '@aws-sdk/client-s3';
 import { Upload } from '@aws-sdk/lib-storage';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 import { unknownToString } from '../../../../../agnostic/errors/unknown-to-string/index.js';
+import { deepGetProperty } from '../../../../../agnostic/objects/deep-get-property/index.js';
 /**
  * Uploads a file stream to a specified Amazon S3 bucket using AWS SDK v3.
  *
  * If `overwrite` is false and the target file exists, upload is aborted.
  *
- * @param {S3Client} s3 - The AWS S3 v3 client instance.
- * @param {string} bucketName - The S3 bucket name.
- * @param {string} targetPath - The key to upload the file to.
- * @param {Readable} fileStream - The file content as a stream.
- * @param {UploadOptions} [options] - Optional configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param s3 - The AWS S3 v3 client instance.
+ * @param bucketName - The S3 bucket name.
+ * @param targetPath - The key to upload the file to.
+ * @param fileStream - The file content as a stream.
+ * @param [options] - Optional configuration.
+ * @returns
  */
 export async function upload(s3, bucketName, targetPath, fileStream, options) {
     const { uploadSettings, fileMetadata, overwrite = false } = options ?? {};
@@ -27,10 +28,11 @@ export async function upload(s3, bucketName, targetPath, fileStream, options) {
             return Outcome.makeFailure(`File already exists at ${targetPath}.`);
         }
         catch (err) {
-            const code = err?.name ?? err?.$metadata?.httpStatusCode;
-            if (code !== 'NotFound' && code !== 404) {
+            const name = deepGetProperty(err, 'name');
+            const httpStatusCode = deepGetProperty(err, '$metadata.httpStatusCode');
+            const code = name ?? httpStatusCode;
+            if (code !== 'NotFound' && code !== 404)
                 return Outcome.makeFailure(unknownToString(err));
-            }
             // Object not found, proceed with upload
         }
     }

package/node/@express/@multer/index.d.ts

@@ -1,4 +1,4 @@
-import { type Request, type Response } from 'express';
+import type { Request, Response } from 'express';
 import multer from 'multer';
 import * as Outcome from '../../../agnostic/misc/outcome/index.js';
 export type WithMulterModeOptions = {
@@ -39,17 +39,17 @@ export type WithMulterError = {
  * applies the appropriate middleware based on the upload mode. Errors are
  * captured and returned as a structured `WithMulterError` object.
  *
- * @param {Request} req                    - The Express request object.
- * @param {Response} res                   - The Express response object.
- * @param {WithMulterOptions} options      - Multer configuration and upload mode.
- * @param {multer.StorageEngine} [options.storage] - Storage engine (defaults to memory).
- * @param {multer.Options['limits']} [options.limits] - File size and count limits.
- * @param {multer.Options['fileFilter']} [options.fileFilter] - File filter function.
- * @param {'none'|'any'|'single'|'array'|'fields'} options.mode - Upload mode.
- * @param {string} [options.fieldName]     - Field name (required for 'single' and 'array' modes).
- * @param {number} [options.maxCount]      - Max file count (for 'array' mode).
- * @param {multer.Field[]} [options.fields] - Field configurations (for 'fields' mode).
- * @returns {Promise<Outcome.Either<true, WithMulterError>>}
+ * @param req                    - The Express request object.
+ * @param res                   - The Express response object.
+ * @param options      - Multer configuration and upload mode.
+ * @param [options.storage] - Storage engine (defaults to memory).
+ * @param [options.limits] - File size and count limits.
+ * @param [options.fileFilter] - File filter function.
+ * @param options.mode - Upload mode.
+ * @param [options.fieldName]     - Field name (required for 'single' and 'array' modes).
+ * @param [options.maxCount]      - Max file count (for 'array' mode).
+ * @param [options.fields] - Field configurations (for 'fields' mode).
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(error)` with structured error details.
  */

package/node/@express/@multer/index.js

@@ -8,17 +8,17 @@ import { unknownToString } from '../../../agnostic/errors/unknown-to-string/inde
  * applies the appropriate middleware based on the upload mode. Errors are
  * captured and returned as a structured `WithMulterError` object.
  *
- * @param {Request} req                    - The Express request object.
- * @param {Response} res                   - The Express response object.
- * @param {WithMulterOptions} options      - Multer configuration and upload mode.
- * @param {multer.StorageEngine} [options.storage] - Storage engine (defaults to memory).
- * @param {multer.Options['limits']} [options.limits] - File size and count limits.
- * @param {multer.Options['fileFilter']} [options.fileFilter] - File filter function.
- * @param {'none'|'any'|'single'|'array'|'fields'} options.mode - Upload mode.
- * @param {string} [options.fieldName]     - Field name (required for 'single' and 'array' modes).
- * @param {number} [options.maxCount]      - Max file count (for 'array' mode).
- * @param {multer.Field[]} [options.fields] - Field configurations (for 'fields' mode).
- * @returns {Promise<Outcome.Either<true, WithMulterError>>}
+ * @param req                    - The Express request object.
+ * @param res                   - The Express response object.
+ * @param options      - Multer configuration and upload mode.
+ * @param [options.storage] - Storage engine (defaults to memory).
+ * @param [options.limits] - File size and count limits.
+ * @param [options.fileFilter] - File filter function.
+ * @param options.mode - Upload mode.
+ * @param [options.fieldName]     - Field name (required for 'single' and 'array' modes).
+ * @param [options.maxCount]      - Max file count (for 'array' mode).
+ * @param [options.fields] - Field configurations (for 'fields' mode).
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(error)` with structured error details.
  */
@@ -46,18 +46,20 @@ export async function useMulterMiddleware(req, res, options) {
     else {
         middleware = uploader.any();
     }
-    return await new Promise(resolve => middleware(req, res, (err) => {
-        if (err instanceof multer.MulterError)
-            return resolve(Outcome.makeFailure({
-                code: err.code,
-                message: err.message,
-                field: err.field
-            }));
-        return resolve(err !== undefined
-            ? Outcome.makeFailure({
-                code: 'UNKNOWN',
-                message: unknownToString(err)
-            })
-            : Outcome.makeSuccess(true));
-    }));
+    return await new Promise(resolve => {
+        middleware(req, res, (err) => {
+            if (err instanceof multer.MulterError)
+                return resolve(Outcome.makeFailure({
+                    code: err.code,
+                    message: err.message,
+                    field: err.field
+                }));
+            return resolve(err !== undefined
+                ? Outcome.makeFailure({
+                    code: 'UNKNOWN',
+                    message: unknownToString(err)
+                })
+                : Outcome.makeSuccess(true));
+        });
+    });
 }

package/node/@google-cloud/storage/bucket/get-metadata/index.d.ts

@@ -1,4 +1,4 @@
-import { type Bucket, type BucketMetadata, type GetBucketMetadataOptions as GCSGetBucketMetadataOptions } from '@google-cloud/storage';
+import type { Bucket, BucketMetadata, GetBucketMetadataOptions as GCSGetBucketMetadataOptions } from '@google-cloud/storage';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 export type GetBucketMetadataOptions = GCSGetBucketMetadataOptions;
 /**
@@ -7,9 +7,9 @@ export type GetBucketMetadataOptions = GCSGetBucketMetadataOptions;
  * This function calls the Google Cloud Storage API to get information about the bucket,
  * such as its location, storage class, and other configuration details.
  *
- * @param {Bucket} bucket - The Google Cloud Storage bucket object.
- * @param {GetBucketMetadataOptions} [options] - Optional configuration options to pass to the `getMetadata` method.
- * @returns {Promise<Outcome.Either<BucketMetadata, string>>} A promise that resolves to an `Outcome.Either`.
+ * @param bucket - The Google Cloud Storage bucket object.
+ * @param [options] - Optional configuration options to pass to the `getMetadata` method.
+ * @returns A promise that resolves to an `Outcome.Either`.
  * - On success: `Outcome.makeSuccess(metadata)` with the bucket metadata.
  * - On failure: `Outcome.makeFailure(errStr)` with an error message.
  *

package/node/@google-cloud/storage/bucket/get-metadata/index.js

@@ -6,9 +6,9 @@ import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
  * This function calls the Google Cloud Storage API to get information about the bucket,
  * such as its location, storage class, and other configuration details.
  *
- * @param {Bucket} bucket - The Google Cloud Storage bucket object.
- * @param {GetBucketMetadataOptions} [options] - Optional configuration options to pass to the `getMetadata` method.
- * @returns {Promise<Outcome.Either<BucketMetadata, string>>} A promise that resolves to an `Outcome.Either`.
+ * @param bucket - The Google Cloud Storage bucket object.
+ * @param [options] - Optional configuration options to pass to the `getMetadata` method.
+ * @returns A promise that resolves to an `Outcome.Either`.
  * - On success: `Outcome.makeSuccess(metadata)` with the bucket metadata.
  * - On failure: `Outcome.makeFailure(errStr)` with an error message.
  *

package/node/@google-cloud/storage/directory/copy-dir/index.d.ts

@@ -1,4 +1,4 @@
-import { type Bucket, type GetFileOptions, type CopyOptions as GCSCopyOptions } from '@google-cloud/storage';
+import type { Bucket, GetFileOptions, CopyOptions as GCSCopyOptions } from '@google-cloud/storage';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 export type CopyDirOptions = {
     getFileOptions?: GetFileOptions;
@@ -10,12 +10,12 @@ export type CopyDirOptions = {
 };
 /** Recursively copies every object under `sourceDir` to the same relative path
  *  beneath `targetDir` within a single GCS bucket.
- * @param {Bucket} bucket - The GCS bucket instance.
- * @param {string} sourceDir - The source directory path (prefix) to copy from.
- * @param {string} targetDir - The target directory path (prefix) to copy to.
- * @param {CopyDirOptions} [options] - Optional parameters for the operation.
- * @param {boolean} [options.overwrite=false] - Whether to overwrite existing files at target.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`:
+ * @param bucket - The GCS bucket instance.
+ * @param sourceDir - The source directory path (prefix) to copy from.
+ * @param targetDir - The target directory path (prefix) to copy to.
+ * @param [options] - Optional parameters for the operation.
+ * @param [options.overwrite=false] - Whether to overwrite existing files at target.
+ * @returns A promise that resolves to an `Outcome.Either`:
  * - On success: `Outcome.makeSuccess(true)` indicating the copy was successful.
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the copy fails.
  * */

package/node/@google-cloud/storage/directory/copy-dir/index.js

@@ -2,12 +2,12 @@ import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 import { unknownToString } from '../../../../../agnostic/errors/unknown-to-string/index.js';
 /** Recursively copies every object under `sourceDir` to the same relative path
  *  beneath `targetDir` within a single GCS bucket.
- * @param {Bucket} bucket - The GCS bucket instance.
- * @param {string} sourceDir - The source directory path (prefix) to copy from.
- * @param {string} targetDir - The target directory path (prefix) to copy to.
- * @param {CopyDirOptions} [options] - Optional parameters for the operation.
- * @param {boolean} [options.overwrite=false] - Whether to overwrite existing files at target.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`:
+ * @param bucket - The GCS bucket instance.
+ * @param sourceDir - The source directory path (prefix) to copy from.
+ * @param targetDir - The target directory path (prefix) to copy to.
+ * @param [options] - Optional parameters for the operation.
+ * @param [options.overwrite=false] - Whether to overwrite existing files at target.
+ * @returns A promise that resolves to an `Outcome.Either`:
  * - On success: `Outcome.makeSuccess(true)` indicating the copy was successful.
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the copy fails.
  * */

package/node/@google-cloud/storage/directory/index.d.ts

@@ -1,4 +1,4 @@
 export * as copyDir from './copy-dir/index.js'
 export * as list from './list/index.js'
-export * as moveDir from './move-dir/index.js'
 export * as removeDir from './remove-dir/index.js'
+export * as moveDir from './move-dir/index.js'

package/node/@google-cloud/storage/directory/index.js

@@ -1,4 +1,4 @@
 export * as copyDir from './copy-dir/index.js'
 export * as list from './list/index.js'
-export * as moveDir from './move-dir/index.js'
 export * as removeDir from './remove-dir/index.js'
+export * as moveDir from './move-dir/index.js'

package/node/@google-cloud/storage/directory/list/index.d.ts

@@ -1,4 +1,4 @@
-import { type Bucket, type FileOptions } from '@google-cloud/storage';
+import type { Bucket, FileOptions } from '@google-cloud/storage';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 export type ListOptions = {
     fileOptions?: FileOptions;
@@ -8,10 +8,10 @@ export type ListOptions = {
  *
  * This function returns only the immediate files (not recursive) under the specified directory prefix.
  *
- * @param {Bucket} bucket - The GCS bucket to list files from.
- * @param {string} directoryPath - The directory prefix to list files under.
- * @param {ListOptions} [options] - Optional configuration for the listing.
- * @param {FileOptions} [options.fileOptions] - Additional options for file retrieval.
- * @returns {Promise<Outcome.Either<string[], string>>} Returns either a success with an array of file paths, or a failure with an error message.
+ * @param bucket - The GCS bucket to list files from.
+ * @param directoryPath - The directory prefix to list files under.
+ * @param [options] - Optional configuration for the listing.
+ * @param [options.fileOptions] - Additional options for file retrieval.
+ * @returns Returns either a success with an array of file paths, or a failure with an error message.
  */
 export declare function list(bucket: Bucket, directoryPath: string, options?: ListOptions): Promise<Outcome.Either<string[], string>>;

package/node/@google-cloud/storage/directory/list/index.js

@@ -5,11 +5,11 @@ import { unknownToString } from '../../../../../agnostic/errors/unknown-to-strin
  *
  * This function returns only the immediate files (not recursive) under the specified directory prefix.
  *
- * @param {Bucket} bucket - The GCS bucket to list files from.
- * @param {string} directoryPath - The directory prefix to list files under.
- * @param {ListOptions} [options] - Optional configuration for the listing.
- * @param {FileOptions} [options.fileOptions] - Additional options for file retrieval.
- * @returns {Promise<Outcome.Either<string[], string>>} Returns either a success with an array of file paths, or a failure with an error message.
+ * @param bucket - The GCS bucket to list files from.
+ * @param directoryPath - The directory prefix to list files under.
+ * @param [options] - Optional configuration for the listing.
+ * @param [options.fileOptions] - Additional options for file retrieval.
+ * @returns Returns either a success with an array of file paths, or a failure with an error message.
  */
 export async function list(bucket, directoryPath, options) {
     const { fileOptions } = options ?? {};

package/node/@google-cloud/storage/directory/move-dir/index.d.ts

@@ -1,4 +1,4 @@
-import { type Bucket, type FileOptions, type CopyOptions as GCSCopyOptions, type DeleteFileOptions as GCSDeleteOptions } from '@google-cloud/storage';
+import type { Bucket, FileOptions, CopyOptions as GCSCopyOptions, DeleteFileOptions as GCSDeleteOptions } from '@google-cloud/storage';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 export type MoveDirOptions = {
     fileOptions?: FileOptions;
@@ -20,11 +20,11 @@ export type MoveDirOptions = {
  * If `overwrite` is false (default), the operation aborts if any destination file
  * already exists.
  *
- * @param {Bucket} bucket - The GCS bucket instance.
- * @param {string} sourceDir - The source directory prefix to move from.
- * @param {string} targetDir - The target directory prefix to move to.
- * @param {MoveDirOptions} [options] - Optional parameters for the operation.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param bucket - The GCS bucket instance.
+ * @param sourceDir - The source directory prefix to move from.
+ * @param targetDir - The target directory prefix to move to.
+ * @param [options] - Optional parameters for the operation.
+ * @returns
  * - On success: `Outcome.makeSuccess(true)`.
  * - On failure: `Outcome.makeFailure(errStr)`.
  */

package/node/@google-cloud/storage/directory/move-dir/index.js

@@ -10,11 +10,11 @@ import { unknownToString } from '../../../../../agnostic/errors/unknown-to-strin
  * If `overwrite` is false (default), the operation aborts if any destination file
  * already exists.
  *
- * @param {Bucket} bucket - The GCS bucket instance.
- * @param {string} sourceDir - The source directory prefix to move from.
- * @param {string} targetDir - The target directory prefix to move to.
- * @param {MoveDirOptions} [options] - Optional parameters for the operation.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param bucket - The GCS bucket instance.
+ * @param sourceDir - The source directory prefix to move from.
+ * @param targetDir - The target directory prefix to move to.
+ * @param [options] - Optional parameters for the operation.
+ * @returns
  * - On success: `Outcome.makeSuccess(true)`.
  * - On failure: `Outcome.makeFailure(errStr)`.
  */

package/node/@google-cloud/storage/directory/remove-dir/index.d.ts

@@ -1,4 +1,4 @@
-import { type Bucket, type DeleteFileOptions as GCSDeleteFileOptions } from '@google-cloud/storage';
+import type { Bucket, DeleteFileOptions as GCSDeleteFileOptions } from '@google-cloud/storage';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 export type RemoveDirOptions = {
     /** Extra parameters forwarded to `bucket.deleteFiles`. */
@@ -17,12 +17,12 @@ export type RemoveDirOptions = {
  * Recursively deletes all objects under a directory prefix in a GCS bucket
  * (including the directory placeholder itself, if present).
  *
- * @param {Bucket} bucket - The GCS bucket instance.
- * @param {string} directoryPath - The “directory” prefix to delete.
- * @param {RemoveDirOptions} [options] - Optional configuration.
- * @param {GCSDeleteFileOptions & {force?: boolean}} [options.deleteOptions] - Extra delete parameters.
- * @param {boolean} [options.ignoreMissing=true] - Whether to ignore an empty/missing prefix.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param bucket - The GCS bucket instance.
+ * @param directoryPath - The “directory” prefix to delete.
+ * @param [options] - Optional configuration.
+ * @param [options.deleteOptions] - Extra delete parameters.
+ * @param [options.ignoreMissing=true] - Whether to ignore an empty/missing prefix.
+ * @returns
  * - On success: `Outcome.makeSuccess(true)` if deletion succeeds
  *   (or prefix absent and `ignoreMissing` is true).
  * - On failure: `Outcome.makeFailure(errStr)` if deletion fails

package/node/@google-cloud/storage/directory/remove-dir/index.js

@@ -4,12 +4,12 @@ import { unknownToString } from '../../../../../agnostic/errors/unknown-to-strin
  * Recursively deletes all objects under a directory prefix in a GCS bucket
  * (including the directory placeholder itself, if present).
  *
- * @param {Bucket} bucket - The GCS bucket instance.
- * @param {string} directoryPath - The “directory” prefix to delete.
- * @param {RemoveDirOptions} [options] - Optional configuration.
- * @param {GCSDeleteFileOptions & {force?: boolean}} [options.deleteOptions] - Extra delete parameters.
- * @param {boolean} [options.ignoreMissing=true] - Whether to ignore an empty/missing prefix.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param bucket - The GCS bucket instance.
+ * @param directoryPath - The “directory” prefix to delete.
+ * @param [options] - Optional configuration.
+ * @param [options.deleteOptions] - Extra delete parameters.
+ * @param [options.ignoreMissing=true] - Whether to ignore an empty/missing prefix.
+ * @returns
  * - On success: `Outcome.makeSuccess(true)` if deletion succeeds
  *   (or prefix absent and `ignoreMissing` is true).
  * - On failure: `Outcome.makeFailure(errStr)` if deletion fails

package/node/@google-cloud/storage/file/copy/index.d.ts

@@ -1,4 +1,4 @@
-import { type Bucket, type FileOptions, type CopyOptions as GCSFileCopyOptions } from '@google-cloud/storage';
+import type { Bucket, FileOptions, CopyOptions as GCSFileCopyOptions } from '@google-cloud/storage';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 export type CopyOptions = {
     /** Additional options for constructing the `File` handles. */
@@ -18,14 +18,14 @@ export type CopyOptions = {
  * If `overwrite` is **false** (default) and the destination object already
  * exists, the operation aborts.
  *
- * @param {Bucket} bucket - The Google Cloud Storage bucket containing the file.
- * @param {string} sourcePath - The path of the source object to copy.
- * @param {string} targetPath - The destination path for the copied object.
- * @param {CopyOptions} [options] - Optional copy configuration.
- * @param {FileOptions} [options.fileOptions] - Extra options for `bucket.file`.
- * @param {GCSFileCopyOptions} [options.copyOptions] - Extra options for `file.copy`.
- * @param {boolean} [options.overwrite=false] - Whether to overwrite an existing destination object.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param bucket - The Google Cloud Storage bucket containing the file.
+ * @param sourcePath - The path of the source object to copy.
+ * @param targetPath - The destination path for the copied object.
+ * @param [options] - Optional copy configuration.
+ * @param [options.fileOptions] - Extra options for `bucket.file`.
+ * @param [options.copyOptions] - Extra options for `file.copy`.
+ * @param [options.overwrite=false] - Whether to overwrite an existing destination object.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

package/node/@google-cloud/storage/file/copy/index.js

@@ -6,14 +6,14 @@ import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
  * If `overwrite` is **false** (default) and the destination object already
  * exists, the operation aborts.
  *
- * @param {Bucket} bucket - The Google Cloud Storage bucket containing the file.
- * @param {string} sourcePath - The path of the source object to copy.
- * @param {string} targetPath - The destination path for the copied object.
- * @param {CopyOptions} [options] - Optional copy configuration.
- * @param {FileOptions} [options.fileOptions] - Extra options for `bucket.file`.
- * @param {GCSFileCopyOptions} [options.copyOptions] - Extra options for `file.copy`.
- * @param {boolean} [options.overwrite=false] - Whether to overwrite an existing destination object.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param bucket - The Google Cloud Storage bucket containing the file.
+ * @param sourcePath - The path of the source object to copy.
+ * @param targetPath - The destination path for the copied object.
+ * @param [options] - Optional copy configuration.
+ * @param [options.fileOptions] - Extra options for `bucket.file`.
+ * @param [options.copyOptions] - Extra options for `file.copy`.
+ * @param [options.overwrite=false] - Whether to overwrite an existing destination object.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

package/node/@google-cloud/storage/file/download/index.d.ts

@@ -1,5 +1,5 @@
-import { type Readable } from 'node:stream';
-import { type Bucket, type FileOptions, type DownloadOptions as GCSFileDownloadOptions } from '@google-cloud/storage';
+import type { Readable } from 'node:stream';
+import type { Bucket, FileOptions, DownloadOptions as GCSFileDownloadOptions } from '@google-cloud/storage';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 export type DownloadOptions = {
     fileOptions?: FileOptions;
@@ -11,11 +11,11 @@ export type DownloadOptions = {
  * This function downloads a file from the given bucket and path, returning the file content as a `Readable`.
  * The download process can be customized using optional `fileOptions` and `downloadOptions`.
  *
- * @param {Bucket} bucket - The Google Cloud Storage bucket object from which to download the file.
- * @param {string} sourcePath - The path of the file to be downloaded in the bucket.
- * @param {DownloadOptions} [options] - Optional configuration options for the download.
- * @returns {Promise<Outcome.Either<Readable, string>>} A promise that resolves to an `Outcome.Either`.
+ * @param bucket - The Google Cloud Storage bucket object from which to download the file.
+ * @param sourcePath - The path of the file to be downloaded in the bucket.
+ * @param [options] - Optional configuration options for the download.
+ * @returns A promise that resolves to an `Outcome.Either`.
  * - On success: `Outcome.makeSuccess(stream)` containing the downloaded file's content as a `Readable`.
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the download fails.
  */
-export declare function download(bucket: Bucket, sourcePath: string, options?: DownloadOptions): Promise<Outcome.Either<Readable, string>>;
+export declare function download(bucket: Bucket, sourcePath: string, options?: DownloadOptions): Outcome.Either<Readable, string>;

package/node/@google-cloud/storage/file/download/index.js

@@ -6,14 +6,14 @@ import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
  * This function downloads a file from the given bucket and path, returning the file content as a `Readable`.
  * The download process can be customized using optional `fileOptions` and `downloadOptions`.
  *
- * @param {Bucket} bucket - The Google Cloud Storage bucket object from which to download the file.
- * @param {string} sourcePath - The path of the file to be downloaded in the bucket.
- * @param {DownloadOptions} [options] - Optional configuration options for the download.
- * @returns {Promise<Outcome.Either<Readable, string>>} A promise that resolves to an `Outcome.Either`.
+ * @param bucket - The Google Cloud Storage bucket object from which to download the file.
+ * @param sourcePath - The path of the file to be downloaded in the bucket.
+ * @param [options] - Optional configuration options for the download.
+ * @returns A promise that resolves to an `Outcome.Either`.
  * - On success: `Outcome.makeSuccess(stream)` containing the downloaded file's content as a `Readable`.
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the download fails.
  */
-export async function download(bucket, sourcePath, options) {
+export function download(bucket, sourcePath, options) {
     const { fileOptions, downloadOptions } = options ?? {};
     try {
         const file = bucket.file(sourcePath, fileOptions);