@design-edito/tools 0.4.23 → 0.5.0

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)`.
  */

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

@@ -11,21 +11,21 @@ import { download as gcsDownload } from '../../../@google-cloud/storage/file/dow
  * the client type (Google Cloud Storage, S3, FTP, or SFTP) and streams the file's
  * content back as a Node `Readable`.
  *
- * @param {AnyClient} client               - The cloud storage client instance.
- * @param {string}   path                  - The path of the file to download.
- * @param {GcsDownloadOptions | S3DownloadOptions | FtpDownloadOptions | SftpDownloadOptions} [options] - Optional download configuration.
- * @returns {Promise<Outcome.Either<Readable, string>>}
+ * @param client               - The cloud storage 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)`.
  */
 export async function downloadFile(client, path, options) {
     if (isGcsBucket(client))
-        return await gcsDownload(client, path, options);
+        return gcsDownload(client, path, options);
     if (isS3ClientWithBucket(client))
         return await s3Download(client.client, client.bucketName, path, options);
     if (isFtpClient(client))
         return await ftpDownload(client, path, options);
     if (isSftpClient(client))
-        return await sftpDownload(client, path, options);
+        return sftpDownload(client, path, options);
     return Outcome.makeFailure('Invalid client type');
 }

package/node/cloud-storage/operations/exists-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';
@@ -10,10 +10,10 @@ type Returned = Outcome.Either<boolean, string>;
 /**
  * Checks whether a file exists in a Google Cloud Storage bucket.
  *
- * @param {GCSBucket} client              - The Google Cloud Storage bucket instance.
- * @param {string}   path                 - The path of the file to check.
- * @param {GcsExistsOptions} [options]    - Optional configuration.
- * @returns {Promise<Outcome.Either<boolean, string>>}
+ * @param client              - The Google Cloud Storage bucket instance.
+ * @param   path                 - The path of the file to check.
+ * @param [options]    - Optional configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)` if the file exists,
  *                `Outcome.makeSuccess(false)` if it does not.
  * - On failure:  `Outcome.makeFailure(errStr)` for unexpected errors.
@@ -22,35 +22,24 @@ export declare function existsFile(client: GCSBucket, path: string, options?: Gc
 /**
  * Checks whether a file exists in an S3 bucket.
  *
- * @param {S3ClientWithBucket} client     - The S3 client with bucket configuration.
- * @param {string}   path                 - The path of the file to check.
- * @param {S3ExistsOptions} [options]    - Optional configuration.
- * @returns {Promise<Outcome.Either<boolean, string>>}
+ * @param client     - The S3 client with bucket configuration.
+ * @param   path                 - The path of the file to check.
+ * @param [options]    - Optional configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)` if the file exists,
  *                `Outcome.makeSuccess(false)` if it does not.
  * - On failure:  `Outcome.makeFailure(errStr)` for unexpected errors.
  */
 export declare function existsFile(client: S3ClientWithBucket, path: string, options?: S3ExistsOptions): Promise<Returned>;
 /**
- * Checks whether a file exists on an FTP server.
+ * Checks whether a file exists on an SFTP or FTP server.
  *
- * @param {FtpClient} client              - The FTP client instance.
- * @param {string}   path                 - The path of the file to check.
- * @returns {Promise<Outcome.Either<boolean, string>>}
+ * @param client             - The FTP or SFTP client instance.
+ * @param   path                 - The path of the file to check.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)` if the file exists,
  *                `Outcome.makeSuccess(false)` if it does not.
  * - On failure:  `Outcome.makeFailure(errStr)` for unexpected errors.
  */
-export declare function existsFile(client: FtpClient, path: string): Promise<Returned>;
-/**
- * Checks whether a file exists on an SFTP server.
- *
- * @param {SftpClient} client             - The SFTP client instance.
- * @param {string}   path                 - The path of the file to check.
- * @returns {Promise<Outcome.Either<boolean, string>>}
- * - On success:  `Outcome.makeSuccess(true)` if the file exists,
- *                `Outcome.makeSuccess(false)` if it does not.
- * - On failure:  `Outcome.makeFailure(errStr)` for unexpected errors.
- */
-export declare function existsFile(client: SftpClient, path: string): Promise<Returned>;
+export declare function existsFile(client: FtpClient | SftpClient, path: string): Promise<Returned>;
 export {};

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

@@ -10,10 +10,10 @@ import { exists as gcsExists } from '../../../@google-cloud/storage/file/exists/
  * 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}   path                 - The path of the file to check.
- * @param {GcsExistsOptions | S3ExistsOptions} [options] - Optional configuration.
- * @returns {Promise<Outcome.Either<boolean, string>>}
+ * @param client              - The cloud storage client instance.
+ * @param   path                 - The path of the file to check.
+ * @param [options] - Optional configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)` if the file exists,
  *                `Outcome.makeSuccess(false)` if it does not.
  * - On failure:  `Outcome.makeFailure(errStr)` for unexpected errors.

package/node/cloud-storage/operations/list-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';
@@ -10,10 +10,10 @@ type Returned = Outcome.Either<string[], string>;
 /**
  * Lists the contents of a directory in a Google Cloud Storage bucket.
  *
- * @param {GCSBucket} client              - The Google Cloud Storage bucket instance.
- * @param {string}   path                 - The directory path to list.
- * @param {GcsListOptions} [options]      - Optional list configuration.
- * @returns {Promise<Outcome.Either<string[], string>>}
+ * @param client              - The Google Cloud Storage bucket instance.
+ * @param   path                 - The directory path to list.
+ * @param [options]      - Optional list configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(paths)` containing an array of file/directory paths.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -21,32 +21,22 @@ export declare function listDir(client: GCSBucket, path: string, options?: GcsLi
 /**
  * Lists the contents of a directory in an S3 bucket.
  *
- * @param {S3ClientWithBucket} client     - The S3 client with bucket configuration.
- * @param {string}   path                 - The directory path to list.
- * @param {S3ListOptions} [options]        - Optional list configuration.
- * @returns {Promise<Outcome.Either<string[], string>>}
+ * @param client     - The S3 client with bucket configuration.
+ * @param   path                 - The directory path to list.
+ * @param [options]        - Optional list configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(paths)` containing an array of file/directory paths.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
 export declare function listDir(client: S3ClientWithBucket, path: string, options?: S3ListOptions): Promise<Returned>;
 /**
- * Lists the contents of a directory on an FTP server.
+ * Lists the contents of a directory on an FTP or SFTP server.
  *
- * @param {FtpClient} client               - The FTP client instance.
- * @param {string}   path                 - The directory path to list.
- * @returns {Promise<Outcome.Either<string[], string>>}
+ * @param client              - The FTP or SFTP client instance.
+ * @param   path                 - The directory path to list.
+ * @returns
  * - On success:  `Outcome.makeSuccess(paths)` containing an array of file/directory paths.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
-export declare function listDir(client: FtpClient, path: string): Promise<Returned>;
-/**
- * Lists the contents of a directory on an SFTP server.
- *
- * @param {SftpClient} client              - The SFTP client instance.
- * @param {string}   path                 - The directory path to list.
- * @returns {Promise<Outcome.Either<string[], string>>}
- * - On success:  `Outcome.makeSuccess(paths)` containing an array of file/directory paths.
- * - On failure:  `Outcome.makeFailure(errStr)`.
- */
-export declare function listDir(client: SftpClient, path: string): Promise<Returned>;
+export declare function listDir(client: FtpClient | SftpClient, path: string): Promise<Returned>;
 export {};

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

@@ -10,10 +10,10 @@ import { list as gcsList } from '../../../@google-cloud/storage/directory/list/i
  * 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}   path                 - The directory path to list.
- * @param {GcsListOptions | S3ListOptions} [options] - Optional list configuration.
- * @returns {Promise<Outcome.Either<string[], string>>}
+ * @param client               - The cloud storage client instance.
+ * @param   path                 - The directory path to list.
+ * @param [options] - Optional list configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(paths)` containing an array of file/directory paths.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

package/node/cloud-storage/operations/move-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>;
 /**
  * Moves 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 move from.
- * @param {string}   targetPath           - The target directory path to move to.
- * @param {GcsMoveDirOptions} [options]    - Optional move configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client               - The Google Cloud Storage bucket instance.
+ * @param   sourcePath           - The source directory path to move from.
+ * @param   targetPath           - The target directory path to move to.
+ * @param [options]    - Optional move configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -24,11 +24,11 @@ export declare function moveDir(client: GCSBucket, sourcePath: string, targetPat
 /**
  * Moves 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 move from.
- * @param {string}   targetPath           - The target directory path to move to.
- * @param {S3MoveDirOptions} [options]     - Optional move configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client      - The S3 client with bucket configuration.
+ * @param   sourcePath           - The source directory path to move from.
+ * @param   targetPath           - The target directory path to move to.
+ * @param [options]     - Optional move configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -36,11 +36,11 @@ export declare function moveDir(client: S3ClientWithBucket, sourcePath: string,
 /**
  * Moves 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 move from.
- * @param {string}   targetPath           - The target directory path to move to.
- * @param {FtpsMoveDirOptions} [options]   - Optional move configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client               - The FTP client instance.
+ * @param   sourcePath           - The source directory path to move from.
+ * @param   targetPath           - The target directory path to move to.
+ * @param [options]   - Optional move configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -48,11 +48,11 @@ export declare function moveDir(client: FtpClient, sourcePath: string, targetPat
 /**
  * Moves 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 move from.
- * @param {string}   targetPath           - The target directory path to move to.
- * @param {SftpMoveDirOptions} [options]   - Optional move configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client              - The SFTP client instance.
+ * @param   sourcePath           - The source directory path to move from.
+ * @param   targetPath           - The target directory path to move to.
+ * @param [options]   - Optional move configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

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

@@ -10,11 +10,11 @@ import { moveDir as gcsMoveDir } 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 move from.
- * @param {string}   targetPath           - The target directory path to move to.
- * @param {GcsMoveDirOptions | S3MoveDirOptions | FtpsMoveDirOptions | SftpMoveDirOptions} [options] - Optional move configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client               - The cloud storage client instance.
+ * @param   sourcePath           - The source directory path to move from.
+ * @param   targetPath           - The target directory path to move to.
+ * @param [options] - Optional move configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

package/node/cloud-storage/operations/move-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>;
 /**
  * Moves 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 move from.
- * @param {string}   targetPath           - The target file path to move to.
- * @param {GcsMoveOptions} [options]       - Optional move configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client               - The Google Cloud Storage bucket instance.
+ * @param   sourcePath           - The source file path to move from.
+ * @param   targetPath           - The target file path to move to.
+ * @param [options]       - Optional move configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -24,11 +24,11 @@ export declare function moveFile(client: GCSBucket, sourcePath: string, targetPa
 /**
  * Moves 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 move from.
- * @param {string}   targetPath           - The target file path to move to.
- * @param {S3MoveOptions} [options]        - Optional move configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client      - The S3 client with bucket configuration.
+ * @param   sourcePath           - The source file path to move from.
+ * @param   targetPath           - The target file path to move to.
+ * @param [options]        - Optional move configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -36,11 +36,11 @@ export declare function moveFile(client: S3ClientWithBucket, sourcePath: string,
 /**
  * Moves 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 move from.
- * @param {string}   targetPath           - The target file path to move to.
- * @param {FtpsMoveOptions} [options]      - Optional move configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client               - The FTP client instance.
+ * @param   sourcePath           - The source file path to move from.
+ * @param   targetPath           - The target file path to move to.
+ * @param [options]      - Optional move configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -48,11 +48,11 @@ export declare function moveFile(client: FtpClient, sourcePath: string, targetPa
 /**
  * Moves 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 move from.
- * @param {string}   targetPath           - The target file path to move to.
- * @param {SftpMoveOptions} [options]      - Optional move configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client              - The SFTP client instance.
+ * @param   sourcePath           - The source file path to move from.
+ * @param   targetPath           - The target file path to move to.
+ * @param [options]      - Optional move configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

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

@@ -10,11 +10,11 @@ import { move as gcsMove } from '../../../@google-cloud/storage/file/move/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 move from.
- * @param {string}   targetPath           - The target file path to move to.
- * @param {GcsMoveOptions | S3MoveOptions | FtpsMoveOptions | SftpMoveOptions} [options] - Optional move configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client               - The cloud storage client instance.
+ * @param   sourcePath           - The source file path to move from.
+ * @param   targetPath           - The target file path to move to.
+ * @param [options] - Optional move configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

package/node/cloud-storage/operations/remove-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,10 +12,10 @@ type Returned = Outcome.Either<true, string>;
 /**
  * Removes a directory from a Google Cloud Storage bucket.
  *
- * @param {GCSBucket} client               - The Google Cloud Storage bucket instance.
- * @param {string}   sourcePath           - The directory path to remove.
- * @param {GcsRemoveDirOptions} [options] - Optional remove configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client               - The Google Cloud Storage bucket instance.
+ * @param   sourcePath           - The directory path to remove.
+ * @param [options] - Optional remove configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -23,10 +23,10 @@ export declare function removeDir(client: GCSBucket, sourcePath: string, options
 /**
  * Removes a directory from an S3 bucket.
  *
- * @param {S3ClientWithBucket} client      - The S3 client with bucket configuration.
- * @param {string}   sourcePath           - The directory path to remove.
- * @param {S3RemoveDirOptions} [options]   - Optional remove configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client      - The S3 client with bucket configuration.
+ * @param   sourcePath           - The directory path to remove.
+ * @param [options]   - Optional remove configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -34,10 +34,10 @@ export declare function removeDir(client: S3ClientWithBucket, sourcePath: string
 /**
  * Removes a directory from an FTP server.
  *
- * @param {FtpClient} client               - The FTP client instance.
- * @param {string}   sourcePath           - The directory path to remove.
- * @param {FtpsRemoveDirOptions} [options] - Optional remove configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client               - The FTP client instance.
+ * @param   sourcePath           - The directory path to remove.
+ * @param [options] - Optional remove configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -45,10 +45,10 @@ export declare function removeDir(client: FtpClient, sourcePath: string, options
 /**
  * Removes a directory from an SFTP server.
  *
- * @param {SftpClient} client              - The SFTP client instance.
- * @param {string}   sourcePath           - The directory path to remove.
- * @param {SftpRemoveDirOptions} [options] - Optional remove configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client              - The SFTP client instance.
+ * @param   sourcePath           - The directory path to remove.
+ * @param [options] - Optional remove configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */