@design-edito/tools 0.4.22 → 0.5.0

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

@@ -1,6 +1,6 @@
+export * as copy from './copy/index.js'
 export * as download from './download/index.js'
 export * as exists from './exists/index.js'
-export * as copy from './copy/index.js'
 export * as generateSignedUrl from './generate-signed-url/index.js'
 export * as getMetadata from './get-metadata/index.js'
 export * as getPermissions from './get-permissions/index.js'

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

@@ -1,4 +1,4 @@
-import { type Bucket, type FileOptions, type CopyOptions, type DeleteFileOptions as GCSDeleteFileOptions } from '@google-cloud/storage';
+import type { Bucket, FileOptions, CopyOptions, DeleteFileOptions as GCSDeleteFileOptions } from '@google-cloud/storage';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 export type MoveOptions = {
     /** Options applied when obtaining `bucket.file(...)` handles. */
@@ -21,15 +21,15 @@ export type MoveOptions = {
  * successful copy, deletes the original. If `overwrite` is **false** and the
  * destination already exists, the operation aborts.
  *
- * @param {Bucket}   bucket      - The Google Cloud Storage bucket.
- * @param {string}   sourcePath  - The path of the source object.
- * @param {string}   targetPath  - The destination path.
- * @param {MoveOptions} [options] - Optional configuration.
- * @param {FileOptions}   [options.fileOptions]   - Options for file handles.
- * @param {CopyOptions}   [options.copyOptions]   - Extra options for `copy`.
- * @param {GCSDeleteFileOptions} [options.deleteOptions] - Extra options for `delete`.
- * @param {boolean}      [options.overwrite=false] - Whether to overwrite an existing destination.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param   bucket      - The Google Cloud Storage bucket.
+ * @param   sourcePath  - The path of the source object.
+ * @param   targetPath  - The destination path.
+ * @param [options] - Optional configuration.
+ * @param   [options.fileOptions]   - Options for file handles.
+ * @param   [options.copyOptions]   - Extra options for `copy`.
+ * @param [options.deleteOptions] - Extra options for `delete`.
+ * @param      [options.overwrite=false] - Whether to overwrite an existing destination.
+ * @returns
  * - Success: `Outcome.makeSuccess(true)` if the move succeeds.
  * - Failure: `Outcome.makeFailure(errStr)` if the move fails.
  */

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

@@ -7,15 +7,15 @@ import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
  * successful copy, deletes the original. If `overwrite` is **false** and the
  * destination already exists, the operation aborts.
  *
- * @param {Bucket}   bucket      - The Google Cloud Storage bucket.
- * @param {string}   sourcePath  - The path of the source object.
- * @param {string}   targetPath  - The destination path.
- * @param {MoveOptions} [options] - Optional configuration.
- * @param {FileOptions}   [options.fileOptions]   - Options for file handles.
- * @param {CopyOptions}   [options.copyOptions]   - Extra options for `copy`.
- * @param {GCSDeleteFileOptions} [options.deleteOptions] - Extra options for `delete`.
- * @param {boolean}      [options.overwrite=false] - Whether to overwrite an existing destination.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param   bucket      - The Google Cloud Storage bucket.
+ * @param   sourcePath  - The path of the source object.
+ * @param   targetPath  - The destination path.
+ * @param [options] - Optional configuration.
+ * @param   [options.fileOptions]   - Options for file handles.
+ * @param   [options.copyOptions]   - Extra options for `copy`.
+ * @param [options.deleteOptions] - Extra options for `delete`.
+ * @param      [options.overwrite=false] - Whether to overwrite an existing destination.
+ * @returns
  * - Success: `Outcome.makeSuccess(true)` if the move succeeds.
  * - Failure: `Outcome.makeFailure(errStr)` if the move fails.
  */

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

@@ -1,4 +1,4 @@
-import { type Bucket, type FileOptions, type DeleteFileOptions as GCSDeleteFileOptions } from '@google-cloud/storage';
+import type { Bucket, FileOptions, DeleteFileOptions as GCSDeleteFileOptions } from '@google-cloud/storage';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 export type RemoveOptions = {
     fileOptions?: FileOptions;
@@ -14,10 +14,10 @@ export type RemoveOptions = {
  * If the `ignoreMissing` option is **true**, the function treats a missing object as a
  * successful outcome instead of returning an error.
  *
- * @param {Bucket} bucket - The Google Cloud Storage bucket instance.
- * @param {string} targetPath - The path of the file to remove in the bucket.
- * @param {RemoveOptions} [options] - Optional settings for configuring the removal process.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an Outcome.Either.
+ * @param bucket - The Google Cloud Storage bucket instance.
+ * @param targetPath - The path of the file to remove in the bucket.
+ * @param [options] - Optional settings for configuring the removal process.
+ * @returns A promise that resolves to an Outcome.Either.
  * - On success: `Outcome.makeSuccess(true)` indicating the removal was successful.
  * - On failure:  `Outcome.makeFailure(errStr)` with an error message if the removal fails.
  */

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

@@ -9,10 +9,10 @@ import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
  * If the `ignoreMissing` option is **true**, the function treats a missing object as a
  * successful outcome instead of returning an error.
  *
- * @param {Bucket} bucket - The Google Cloud Storage bucket instance.
- * @param {string} targetPath - The path of the file to remove in the bucket.
- * @param {RemoveOptions} [options] - Optional settings for configuring the removal process.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an Outcome.Either.
+ * @param bucket - The Google Cloud Storage bucket instance.
+ * @param targetPath - The path of the file to remove in the bucket.
+ * @param [options] - Optional settings for configuring the removal process.
+ * @returns A promise that resolves to an Outcome.Either.
  * - On success: `Outcome.makeSuccess(true)` indicating the removal was successful.
  * - On failure:  `Outcome.makeFailure(errStr)` with an error message if the removal fails.
  */

package/node/@google-cloud/storage/file/revoke-signed-urls/index.d.ts

@@ -1,4 +1,4 @@
-import { type Bucket } from '@google-cloud/storage';
+import type { Bucket } from '@google-cloud/storage';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 import { type DownloadOptions } from '../download/index.js';
 import { type RemoveOptions } from '../remove/index.js';
@@ -16,10 +16,10 @@ export type RevokeSignedUrlsOptions = {
  * and finally re-uploads the file to the same path. The re-upload effectively revokes any signed URLs that
  * were generated for the file, as they are tied to the file's existence and content.
  *
- * @param {Bucket} bucket - The Google Cloud Storage bucket containing the file.
- * @param {string} targetPath - The path of the file for which the signed URLs are to be revoked.
- * @param {RevokeSignedUrlsOptions} [options] - Optional configuration options for the file operations.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`.
+ * @param bucket - The Google Cloud Storage bucket containing the file.
+ * @param targetPath - The path of the file for which the signed URLs are to be revoked.
+ * @param [options] - Optional configuration options for the file operations.
+ * @returns A promise that resolves to an `Outcome.Either`.
  * - On success: `Outcome.makeSuccess(true)` if the file has been successfully re-uploaded after deletion.
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if any of the steps (download, remove, or upload) fail.
  */

package/node/@google-cloud/storage/file/revoke-signed-urls/index.js

@@ -10,16 +10,16 @@ import { upload } from '../upload/index.js';
  * and finally re-uploads the file to the same path. The re-upload effectively revokes any signed URLs that
  * were generated for the file, as they are tied to the file's existence and content.
  *
- * @param {Bucket} bucket - The Google Cloud Storage bucket containing the file.
- * @param {string} targetPath - The path of the file for which the signed URLs are to be revoked.
- * @param {RevokeSignedUrlsOptions} [options] - Optional configuration options for the file operations.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`.
+ * @param bucket - The Google Cloud Storage bucket containing the file.
+ * @param targetPath - The path of the file for which the signed URLs are to be revoked.
+ * @param [options] - Optional configuration options for the file operations.
+ * @returns A promise that resolves to an `Outcome.Either`.
  * - On success: `Outcome.makeSuccess(true)` if the file has been successfully re-uploaded after deletion.
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if any of the steps (download, remove, or upload) fail.
  */
 export async function revokeSignedUrls(bucket, targetPath, options) {
     const { downloadOptions, removeOptions, uploadOptions } = options ?? {};
-    const downloadAttempt = await download(bucket, targetPath, downloadOptions);
+    const downloadAttempt = download(bucket, targetPath, downloadOptions);
     if (!downloadAttempt.success)
         return downloadAttempt;
     const deletionAttempt = await remove(bucket, targetPath, removeOptions);

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

@@ -1,4 +1,4 @@
-import { type Bucket, type FileOptions, type GetFileMetadataOptions, type FileMetadata } from '@google-cloud/storage';
+import type { Bucket, FileOptions, GetFileMetadataOptions, FileMetadata } from '@google-cloud/storage';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 /** Provider‑agnostic view + strongly‑typed raw metadata */
 export interface Stat {
@@ -17,9 +17,9 @@ export type StatOptions = {
 /**
  * Retrieves metadata for a single GCS object.
  *
- * @param {Bucket} bucket – GCS bucket.
- * @param {string} path  – Object path.
- * @param {StatOptions} [options] – Extra getMetadata options.
- * @returns {Promise<Outcome.Either<Stat, string>>}
+ * @param bucket – GCS bucket.
+ * @param path  – Object path.
+ * @param [options] – Extra getMetadata options.
+ * @returns
  */
 export declare function stat(bucket: Bucket, path: string, options?: StatOptions): Promise<Outcome.Either<Stat, string>>;

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

@@ -3,10 +3,10 @@ import { unknownToString } from '../../../../../agnostic/errors/unknown-to-strin
 /**
  * Retrieves metadata for a single GCS object.
  *
- * @param {Bucket} bucket – GCS bucket.
- * @param {string} path  – Object path.
- * @param {StatOptions} [options] – Extra getMetadata options.
- * @returns {Promise<Outcome.Either<Stat, string>>}
+ * @param bucket – GCS bucket.
+ * @param path  – Object path.
+ * @param [options] – Extra getMetadata options.
+ * @returns
  */
 export async function stat(bucket, path, options) {
     const { fileOptions, getMetadataOptions } = options ?? {};

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

@@ -1,4 +1,4 @@
-import { type Bucket, type FileOptions, type SetFileMetadataOptions } from '@google-cloud/storage';
+import type { Bucket, FileOptions, SetFileMetadataOptions } from '@google-cloud/storage';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 export type UpdateFileMetadataOptions = {
     fileOptions?: FileOptions;
@@ -11,14 +11,14 @@ export type UpdateFileMetadataOptions = {
  * The metadata is updated according to the provided `metadata` object, which contains the new metadata key-value pairs.
  * It can be customized using optional `fileOptions` and `metadataOptions` to control the update behavior.
  *
- * @param {Bucket} bucket - The Google Cloud Storage bucket object containing the file whose metadata is being updated.
- * @param {string} targetPath - The path of the file whose metadata is to be updated.
- * @param {Record<string, any>} metadata - The metadata object containing key-value pairs to be set on the file.
- * @param {UpdateFileMetadataOptions} [options] - Optional configuration options for the metadata update operation.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`.
+ * @param bucket - The Google Cloud Storage bucket object containing the file whose metadata is being updated.
+ * @param targetPath - The path of the file whose metadata is to be updated.
+ * @param metadata - The metadata object containing key-value pairs to be set on the file.
+ * @param [options] - Optional configuration options for the metadata update operation.
+ * @returns A promise that resolves to an `Outcome.Either`.
  * - On success: `Outcome.makeSuccess(true)` indicating the metadata was successfully updated.
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the metadata update operation fails.
  *
  * @throws {Error} Throws an error if the metadata update operation fails (e.g., file not found, insufficient permissions, etc.).
  */
-export declare function updateFileMetadata(bucket: Bucket, targetPath: string, metadata: Record<string, any>, options?: UpdateFileMetadataOptions): Promise<Outcome.Either<true, string>>;
+export declare function updateFileMetadata(bucket: Bucket, targetPath: string, metadata: Record<string, unknown>, options?: UpdateFileMetadataOptions): Promise<Outcome.Either<true, string>>;

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

@@ -7,11 +7,11 @@ import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
  * The metadata is updated according to the provided `metadata` object, which contains the new metadata key-value pairs.
  * It can be customized using optional `fileOptions` and `metadataOptions` to control the update behavior.
  *
- * @param {Bucket} bucket - The Google Cloud Storage bucket object containing the file whose metadata is being updated.
- * @param {string} targetPath - The path of the file whose metadata is to be updated.
- * @param {Record<string, any>} metadata - The metadata object containing key-value pairs to be set on the file.
- * @param {UpdateFileMetadataOptions} [options] - Optional configuration options for the metadata update operation.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`.
+ * @param bucket - The Google Cloud Storage bucket object containing the file whose metadata is being updated.
+ * @param targetPath - The path of the file whose metadata is to be updated.
+ * @param metadata - The metadata object containing key-value pairs to be set on the file.
+ * @param [options] - Optional configuration options for the metadata update operation.
+ * @returns A promise that resolves to an `Outcome.Either`.
  * - On success: `Outcome.makeSuccess(true)` indicating the metadata was successfully updated.
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the metadata update operation fails.
  *

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

@@ -1,5 +1,5 @@
-import { type Readable } from 'node:stream';
-import { type Bucket, type FileOptions, type SaveOptions } from '@google-cloud/storage';
+import type { Readable } from 'node:stream';
+import type { Bucket, FileOptions, SaveOptions } from '@google-cloud/storage';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 export type UploadOptions = {
     fileOptions?: FileOptions;
@@ -13,11 +13,11 @@ export type UploadOptions = {
  * The upload can be customized using optional `fileOptions` and `saveOptions`.
  * If the `overwrite` option is false and a file already exists at the target path, the upload is aborted.
  *
- * @param {Bucket} bucket - The Google Cloud Storage bucket object.
- * @param {string} targetPath - The target path where the file will be saved in the bucket.
- * @param {Readable} fileStream - The file content to be uploaded.
- * @param {UploadOptions} [options] - Optional options to configure the upload process.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an Outcome.Either.
+ * @param bucket - The Google Cloud Storage bucket object.
+ * @param targetPath - The target path where the file will be saved in the bucket.
+ * @param fileStream - The file content to be uploaded.
+ * @param [options] - Optional options to configure the upload process.
+ * @returns A promise that resolves to an Outcome.Either.
  * - On success: Outcome.makeSuccess(true) indicating the upload was successful.
  * - On failure: Outcome.makeFailure(errStr) with an error message if the upload fails.
  */

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

@@ -7,11 +7,11 @@ import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
  * The upload can be customized using optional `fileOptions` and `saveOptions`.
  * If the `overwrite` option is false and a file already exists at the target path, the upload is aborted.
  *
- * @param {Bucket} bucket - The Google Cloud Storage bucket object.
- * @param {string} targetPath - The target path where the file will be saved in the bucket.
- * @param {Readable} fileStream - The file content to be uploaded.
- * @param {UploadOptions} [options] - Optional options to configure the upload process.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an Outcome.Either.
+ * @param bucket - The Google Cloud Storage bucket object.
+ * @param targetPath - The target path where the file will be saved in the bucket.
+ * @param fileStream - The file content to be uploaded.
+ * @param [options] - Optional options to configure the upload process.
+ * @returns A promise that resolves to an Outcome.Either.
  * - On success: Outcome.makeSuccess(true) indicating the upload was successful.
  * - On failure: Outcome.makeFailure(errStr) with an error message if the upload fails.
  */

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

@@ -1,3 +1,3 @@
 export * as bucket from './bucket/index.js'
-export * as file from './file/index.js'
 export * as directory from './directory/index.js'
+export * as file from './file/index.js'

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

@@ -1,3 +1,3 @@
 export * as bucket from './bucket/index.js'
-export * as file from './file/index.js'
 export * as directory from './directory/index.js'
+export * as file from './file/index.js'

package/node/cloud-storage/clients/index.d.ts

@@ -13,28 +13,28 @@ export type AnyClient = GCSBucket | S3ClientWithBucket | FtpClient | SftpClient;
 /**
  * Type guard to check if a client is a Google Cloud Storage bucket.
  *
- * @param {AnyClient} client - The client to check.
- * @returns {boolean} `true` if the client is a `GCSBucket`, `false` otherwise.
+ * @param client - The client to check.
+ * @returns `true` if the client is a `GCSBucket`, `false` otherwise.
  */
 export declare const isGcsBucket: (client: AnyClient) => client is GCSBucket;
 /**
  * Type guard to check if a client is an S3 client with bucket configuration.
  *
- * @param {AnyClient} client - The client to check.
- * @returns {boolean} `true` if the client is an `S3ClientWithBucket`, `false` otherwise.
+ * @param client - The client to check.
+ * @returns `true` if the client is an `S3ClientWithBucket`, `false` otherwise.
  */
 export declare const isS3ClientWithBucket: (client: AnyClient) => client is S3ClientWithBucket;
 /**
  * Type guard to check if a client is an FTP client.
  *
- * @param {AnyClient} client - The client to check.
- * @returns {boolean} `true` if the client is an `FtpClient`, `false` otherwise.
+ * @param client - The client to check.
+ * @returns `true` if the client is an `FtpClient`, `false` otherwise.
  */
 export declare const isFtpClient: (client: AnyClient) => client is FtpClient;
 /**
  * Type guard to check if a client is an SFTP client.
  *
- * @param {AnyClient} client - The client to check.
- * @returns {boolean} `true` if the client is an `SftpClient`, `false` otherwise.
+ * @param client - The client to check.
+ * @returns `true` if the client is an `SftpClient`, `false` otherwise.
  */
 export declare const isSftpClient: (client: AnyClient) => client is SftpClient;

package/node/cloud-storage/clients/index.js

@@ -5,15 +5,15 @@ import SftpClient from 'ssh2-sftp-client';
 /**
  * Type guard to check if a client is a Google Cloud Storage bucket.
  *
- * @param {AnyClient} client - The client to check.
- * @returns {boolean} `true` if the client is a `GCSBucket`, `false` otherwise.
+ * @param client - The client to check.
+ * @returns `true` if the client is a `GCSBucket`, `false` otherwise.
  */
 export const isGcsBucket = (client) => client instanceof GCSBucket;
 /**
  * Type guard to check if a client is an S3 client with bucket configuration.
  *
- * @param {AnyClient} client - The client to check.
- * @returns {boolean} `true` if the client is an `S3ClientWithBucket`, `false` otherwise.
+ * @param client - The client to check.
+ * @returns `true` if the client is an `S3ClientWithBucket`, `false` otherwise.
  */
 export const isS3ClientWithBucket = (client) => ('bucketName' in client)
     && typeof client.bucketName === 'string'
@@ -22,14 +22,14 @@ export const isS3ClientWithBucket = (client) => ('bucketName' in client)
 /**
  * Type guard to check if a client is an FTP client.
  *
- * @param {AnyClient} client - The client to check.
- * @returns {boolean} `true` if the client is an `FtpClient`, `false` otherwise.
+ * @param client - The client to check.
+ * @returns `true` if the client is an `FtpClient`, `false` otherwise.
  */
 export const isFtpClient = (client) => client instanceof FtpClient;
 /**
  * Type guard to check if a client is an SFTP client.
  *
- * @param {AnyClient} client - The client to check.
- * @returns {boolean} `true` if the client is an `SftpClient`, `false` otherwise.
+ * @param client - The client to check.
+ * @returns `true` if the client is an `SftpClient`, `false` otherwise.
  */
 export const isSftpClient = (client) => client instanceof SftpClient;

package/node/cloud-storage/operations/copy-dir/index.d.ts

@@ -1,5 +1,5 @@
-import { type Bucket as GCSBucket } from '@google-cloud/storage';
-import { type Client as FtpClient } from 'basic-ftp';
+import type { Bucket as GCSBucket } from '@google-cloud/storage';
+import type { Client as FtpClient } from 'basic-ftp';
 import type SftpClient from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 import { type S3ClientWithBucket } from '../../clients/index.js';
@@ -12,11 +12,11 @@ type Returned = Outcome.Either<true, string>;
 /**
  * Recursively copies a directory from one path to another using a Google Cloud Storage bucket.
  *
- * @param {GCSBucket} client              - The Google Cloud Storage bucket instance.
- * @param {string}   sourcePath           - The source directory path to copy from.
- * @param {string}   targetPath           - The target directory path to copy to.
- * @param {GcsCopyDirOptions} [options]  - Optional copy configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client              - The Google Cloud Storage bucket instance.
+ * @param   sourcePath           - The source directory path to copy from.
+ * @param   targetPath           - The target directory path to copy to.
+ * @param [options]  - Optional copy configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -24,11 +24,11 @@ export declare function copyDir(client: GCSBucket, sourcePath: string, targetPat
 /**
  * Recursively copies a directory from one path to another using an S3 client.
  *
- * @param {S3ClientWithBucket} client    - The S3 client with bucket configuration.
- * @param {string}   sourcePath           - The source directory path to copy from.
- * @param {string}   targetPath           - The target directory path to copy to.
- * @param {S3CopyDirOptions} [options]    - Optional copy configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client    - The S3 client with bucket configuration.
+ * @param   sourcePath           - The source directory path to copy from.
+ * @param   targetPath           - The target directory path to copy to.
+ * @param [options]    - Optional copy configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -36,11 +36,11 @@ export declare function copyDir(client: S3ClientWithBucket, sourcePath: string,
 /**
  * Recursively copies a directory from one path to another using an FTP client.
  *
- * @param {FtpClient} client              - The FTP client instance.
- * @param {string}   sourcePath           - The source directory path to copy from.
- * @param {string}   targetPath           - The target directory path to copy to.
- * @param {FtpsCopyDirOptions} [options]  - Optional copy configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client              - The FTP client instance.
+ * @param   sourcePath           - The source directory path to copy from.
+ * @param   targetPath           - The target directory path to copy to.
+ * @param [options]  - Optional copy configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -48,11 +48,11 @@ export declare function copyDir(client: FtpClient, sourcePath: string, targetPat
 /**
  * Recursively copies a directory from one path to another using an SFTP client.
  *
- * @param {SftpClient} client             - The SFTP client instance.
- * @param {string}   sourcePath           - The source directory path to copy from.
- * @param {string}   targetPath           - The target directory path to copy to.
- * @param {SftpCopyDirOptions} [options]  - Optional copy configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client             - The SFTP client instance.
+ * @param   sourcePath           - The source directory path to copy from.
+ * @param   targetPath           - The target directory path to copy to.
+ * @param [options]  - Optional copy configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

package/node/cloud-storage/operations/copy-dir/index.js

@@ -10,11 +10,11 @@ import { copyDir as gcsCopyDir } from '../../../@google-cloud/storage/directory/
  * The function automatically dispatches to the appropriate implementation based on
  * the client type (Google Cloud Storage, S3, FTP, or SFTP).
  *
- * @param {AnyClient} client              - The cloud storage client instance.
- * @param {string}   sourcePath           - The source directory path to copy from.
- * @param {string}   targetPath           - The target directory path to copy to.
- * @param {GcsCopyDirOptions | S3CopyDirOptions | FtpsCopyDirOptions | SftpCopyDirOptions} [options] - Optional copy configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client              - The cloud storage client instance.
+ * @param   sourcePath           - The source directory path to copy from.
+ * @param   targetPath           - The target directory path to copy to.
+ * @param [options] - Optional copy configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

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

@@ -1,5 +1,5 @@
-import { type Bucket as GCSBucket } from '@google-cloud/storage';
-import { type Client as FtpClient } from 'basic-ftp';
+import type { Bucket as GCSBucket } from '@google-cloud/storage';
+import type { Client as FtpClient } from 'basic-ftp';
 import type SftpClient from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 import { type S3ClientWithBucket } from '../../clients/index.js';
@@ -12,11 +12,11 @@ type Returned = Outcome.Either<true, string>;
 /**
  * Copies a file from one path to another using a Google Cloud Storage bucket.
  *
- * @param {GCSBucket} client              - The Google Cloud Storage bucket instance.
- * @param {string}   sourcePath           - The source file path to copy from.
- * @param {string}   targetPath           - The target file path to copy to.
- * @param {GcsCopyOptions} [options]      - Optional copy configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client              - The Google Cloud Storage bucket instance.
+ * @param   sourcePath           - The source file path to copy from.
+ * @param   targetPath           - The target file path to copy to.
+ * @param [options]      - Optional copy configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -24,11 +24,11 @@ export declare function copyFile(client: GCSBucket, sourcePath: string, targetPa
 /**
  * Copies a file from one path to another using an S3 client.
  *
- * @param {S3ClientWithBucket} client     - The S3 client with bucket configuration.
- * @param {string}   sourcePath           - The source file path to copy from.
- * @param {string}   targetPath           - The target file path to copy to.
- * @param {S3CopyOptions} [options]       - Optional copy configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client     - The S3 client with bucket configuration.
+ * @param   sourcePath           - The source file path to copy from.
+ * @param   targetPath           - The target file path to copy to.
+ * @param [options]       - Optional copy configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -36,11 +36,11 @@ export declare function copyFile(client: S3ClientWithBucket, sourcePath: string,
 /**
  * Copies a file from one path to another using an FTP client.
  *
- * @param {FtpClient} client              - The FTP client instance.
- * @param {string}   sourcePath           - The source file path to copy from.
- * @param {string}   targetPath           - The target file path to copy to.
- * @param {FtpsCopyOptions} [options]      - Optional copy configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client              - The FTP client instance.
+ * @param   sourcePath           - The source file path to copy from.
+ * @param   targetPath           - The target file path to copy to.
+ * @param [options]      - Optional copy configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -48,11 +48,11 @@ export declare function copyFile(client: FtpClient, sourcePath: string, targetPa
 /**
  * Copies a file from one path to another using an SFTP client.
  *
- * @param {SftpClient} client             - The SFTP client instance.
- * @param {string}   sourcePath           - The source file path to copy from.
- * @param {string}   targetPath           - The target file path to copy to.
- * @param {SftpCopyOptions} [options]     - Optional copy configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client             - The SFTP client instance.
+ * @param   sourcePath           - The source file path to copy from.
+ * @param   targetPath           - The target file path to copy to.
+ * @param [options]     - Optional copy configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

package/node/cloud-storage/operations/copy-file/index.js

@@ -10,11 +10,11 @@ import { copy as gcsCopy } from '../../../@google-cloud/storage/file/copy/index.
  * The function automatically dispatches to the appropriate implementation based on
  * the client type (Google Cloud Storage, S3, FTP, or SFTP).
  *
- * @param {AnyClient} client              - The cloud storage client instance.
- * @param {string}   sourcePath           - The source file path to copy from.
- * @param {string}   targetPath           - The target file path to copy to.
- * @param {GcsCopyOptions | S3CopyOptions | FtpsCopyOptions | SftpCopyOptions} [options] - Optional copy configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client              - The cloud storage client instance.
+ * @param   sourcePath           - The source file path to copy from.
+ * @param   targetPath           - The target file path to copy to.
+ * @param [options] - Optional copy configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

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

@@ -1,6 +1,6 @@
-import { type Readable } from 'node:stream';
-import { type Bucket as GCSBucket } from '@google-cloud/storage';
-import { type Client as FtpClient } from 'basic-ftp';
+import type { Readable } from 'node:stream';
+import type { Bucket as GCSBucket } from '@google-cloud/storage';
+import type { Client as FtpClient } from 'basic-ftp';
 import type SftpClient from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 import { type S3ClientWithBucket } from '../../clients/index.js';
@@ -15,10 +15,10 @@ type Returned = Outcome.Either<Readable, string>;
  *
  * The function streams the file's content back as a Node `Readable`.
  *
- * @param {GCSBucket} client              - The Google Cloud Storage bucket instance.
- * @param {string}   path                 - The path of the file to download.
- * @param {GcsDownloadOptions} [options] - Optional download configuration.
- * @returns {Promise<Outcome.Either<Readable, string>>}
+ * @param client              - The Google Cloud Storage bucket instance.
+ * @param   path                 - The path of the file to download.
+ * @param [options] - Optional download configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(stream)` containing the file content.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -28,10 +28,10 @@ export declare function downloadFile(client: GCSBucket, path: string, options?:
  *
  * The function streams the file's content back as a Node `Readable`.
  *
- * @param {S3ClientWithBucket} client     - The S3 client with bucket configuration.
- * @param {string}   path                 - The path of the file to download.
- * @param {S3DownloadOptions} [options]   - Optional download configuration.
- * @returns {Promise<Outcome.Either<Readable, string>>}
+ * @param client     - The S3 client with bucket configuration.
+ * @param   path                 - The path of the file to download.
+ * @param [options]   - Optional download configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(stream)` containing the file content.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -41,10 +41,10 @@ export declare function downloadFile(client: S3ClientWithBucket, path: string, o
  *
  * The function streams the file's content back as a Node `Readable`.
  *
- * @param {FtpClient} client              - The FTP client instance.
- * @param {string}   path                 - The path of the file to download.
- * @param {FtpDownloadOptions} [options]  - Optional download configuration.
- * @returns {Promise<Outcome.Either<Readable, string>>}
+ * @param client              - The FTP client instance.
+ * @param   path                 - The path of the file to download.
+ * @param [options]  - Optional download configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(stream)` containing the file content.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -54,10 +54,10 @@ export declare function downloadFile(client: FtpClient, path: string, options?:
  *
  * The function streams the file's content back as a Node `Readable`.
  *
- * @param {SftpClient} client              - The SFTP client instance.
- * @param {string}   path                  - The path of the file to download.
- * @param {SftpDownloadOptions} [options] - Optional download configuration.
- * @returns {Promise<Outcome.Either<Readable, string>>}
+ * @param client              - The SFTP client instance.
+ * @param   path                  - The path of the file to download.
+ * @param [options] - Optional download configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(stream)` containing the file content.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */