@design-edito/tools 0.4.23 → 0.5.0

package/node/ftps/directory/copy-dir/index.js

@@ -5,11 +5,11 @@ import { unknownToString } from '../../../../agnostic/errors/unknown-to-string/i
  * Recursively copies every file under `sourceDir` to the same relative path
  * beneath `targetDir` on an FTP server, streaming data to avoid buffering.
  *
- * @param {Client}  ftpClient  - The FTP client instance.
- * @param {string}  sourceDir  - The source directory path to copy from.
- * @param {string}  targetDir  - The target directory path to copy to.
- * @param {CopyDirOptions} [options] - Optional parameters for the operation.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param  ftpClient  - The FTP client instance.
+ * @param  sourceDir  - The source directory path to copy from.
+ * @param  targetDir  - The target directory path to copy to.
+ * @param [options] - Optional parameters for the operation.
+ * @returns
  * - Success: `Outcome.makeSuccess(true)` if the copy succeeds.
  * - Failure: `Outcome.makeFailure(errStr)` if an error occurs.
  */
@@ -18,7 +18,7 @@ export async function copyDir(ftpClient, sourceDir, targetDir, options) {
     async function recurse(dir) {
         const list = await ftpClient.list(dir);
         for (const entry of list) {
-            const src = dir.endsWith('/') ? dir + entry.name : dir + '/' + entry.name;
+            const src = dir.endsWith('/') ? `${dir}${entry.name}` : `${dir}/${entry.name}`;
             const rel = src.substring(sourceDir.length + (sourceDir.endsWith('/') ? 0 : 1));
             const dst = targetDir.endsWith('/') ? targetDir + rel : `${targetDir}/${rel}`;
             if (entry.isDirectory) {

package/node/ftps/directory/list/index.d.ts

@@ -1,12 +1,12 @@
-import { type Client } from 'basic-ftp';
+import type { Client } from 'basic-ftp';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 /**
  * Lists all direct children files under a given directory on an FTP server.
  *
  * This function returns only the immediate files (not recursive) under the specified directory.
  *
- * @param {Client} ftpClient - The basic-ftp client instance used to interact with the FTP server.
- * @param {string} directoryPath - The directory path to list files under.
- * @returns {Promise<Outcome.Either<string[], string>>} Returns either a success with an array of file paths, or a failure with an error message.
+ * @param ftpClient - The basic-ftp client instance used to interact with the FTP server.
+ * @param directoryPath - The directory path to list files under.
+ * @returns Returns either a success with an array of file paths, or a failure with an error message.
  */
 export declare function list(ftpClient: Client, directoryPath: string): Promise<Outcome.Either<string[], string>>;

package/node/ftps/directory/list/index.js

@@ -5,9 +5,9 @@ import { unknownToString } from '../../../../agnostic/errors/unknown-to-string/i
  *
  * This function returns only the immediate files (not recursive) under the specified directory.
  *
- * @param {Client} ftpClient - The basic-ftp client instance used to interact with the FTP server.
- * @param {string} directoryPath - The directory path to list files under.
- * @returns {Promise<Outcome.Either<string[], string>>} Returns either a success with an array of file paths, or a failure with an error message.
+ * @param ftpClient - The basic-ftp client instance used to interact with the FTP server.
+ * @param directoryPath - The directory path to list files under.
+ * @returns Returns either a success with an array of file paths, or a failure with an error message.
  */
 export async function list(ftpClient, directoryPath) {
     try {

package/node/ftps/directory/move-dir/index.d.ts

@@ -1,4 +1,4 @@
-import { type Client } from 'basic-ftp';
+import type { Client } from 'basic-ftp';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type MoveDirOptions = {
     /** If false and `targetDir` exists, the operation is aborted. Defaults to false. */
@@ -15,11 +15,11 @@ export type MoveDirOptions = {
  * If `ensureDir` is true (default), the parent directory of `targetDir` is
  * created if it does not exist.
  *
- * @param {Client} ftpClient - The FTP client instance.
- * @param {string} sourceDir - The source directory path to move from.
- * @param {string} targetDir - The target directory path to move to.
- * @param {MoveDirOptions} [options] - Optional parameters for the operation.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`:
+ * @param ftpClient - The FTP client instance.
+ * @param sourceDir - The source directory path to move from.
+ * @param targetDir - The target directory path to move to.
+ * @param [options] - Optional parameters for the operation.
+ * @returns A promise that resolves to an `Outcome.Either`:
  * - On success: `Outcome.makeSuccess(true)` indicating the move was successful.
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the move fails.
  */

package/node/ftps/directory/move-dir/index.js

@@ -9,11 +9,11 @@ import { unknownToString } from '../../../../agnostic/errors/unknown-to-string/i
  * If `ensureDir` is true (default), the parent directory of `targetDir` is
  * created if it does not exist.
  *
- * @param {Client} ftpClient - The FTP client instance.
- * @param {string} sourceDir - The source directory path to move from.
- * @param {string} targetDir - The target directory path to move to.
- * @param {MoveDirOptions} [options] - Optional parameters for the operation.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`:
+ * @param ftpClient - The FTP client instance.
+ * @param sourceDir - The source directory path to move from.
+ * @param targetDir - The target directory path to move to.
+ * @param [options] - Optional parameters for the operation.
+ * @returns A promise that resolves to an `Outcome.Either`:
  * - On success: `Outcome.makeSuccess(true)` indicating the move was successful.
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the move fails.
  */

package/node/ftps/directory/remove-dir/index.d.ts

@@ -1,4 +1,4 @@
-import { type Client } from 'basic-ftp';
+import type { Client } from 'basic-ftp';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type RemoveDirOptions = {
     /**
@@ -12,11 +12,11 @@ export type RemoveDirOptions = {
 /**
  * Recursively deletes a directory (and all contents) on an FTP server.
  *
- * @param {Client} ftpClient            - The FTP client instance.
- * @param {string} directoryPath        - The path of the directory to delete.
- * @param {RemoveDirOptions} [options]  - Optional configuration.
- * @param {boolean} [options.ignoreMissing=true] - Whether to ignore a missing directory.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param ftpClient            - The FTP client instance.
+ * @param directoryPath        - The path of the directory to delete.
+ * @param [options]  - Optional configuration.
+ * @param [options.ignoreMissing=true] - Whether to ignore a missing directory.
+ * @returns
  * - On success: `Outcome.makeSuccess(true)` – deletion succeeded, or directory
  *   was absent and `ignoreMissing` is true.
  * - On failure: `Outcome.makeFailure(errStr)` if deletion fails, or directory

package/node/ftps/directory/remove-dir/index.js

@@ -1,13 +1,14 @@
 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';
 /**
  * Recursively deletes a directory (and all contents) on an FTP server.
  *
- * @param {Client} ftpClient            - The FTP client instance.
- * @param {string} directoryPath        - The path of the directory to delete.
- * @param {RemoveDirOptions} [options]  - Optional configuration.
- * @param {boolean} [options.ignoreMissing=true] - Whether to ignore a missing directory.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param ftpClient            - The FTP client instance.
+ * @param directoryPath        - The path of the directory to delete.
+ * @param [options]  - Optional configuration.
+ * @param [options.ignoreMissing=true] - Whether to ignore a missing directory.
+ * @returns
  * - On success: `Outcome.makeSuccess(true)` – deletion succeeded, or directory
  *   was absent and `ignoreMissing` is true.
  * - On failure: `Outcome.makeFailure(errStr)` if deletion fails, or directory
@@ -33,10 +34,10 @@ export async function removeDir(ftpClient, directoryPath, options) {
         return Outcome.makeSuccess(true);
     }
     catch (err) {
+        const code = deepGetProperty(err, 'code');
         // 550 (“No such file or directory”) when the path is missing
-        if (ignoreMissing && err.code === 550) {
+        if (ignoreMissing && code === 550)
             return Outcome.makeSuccess(true);
-        }
         return Outcome.makeFailure(unknownToString(err));
     }
 }

package/node/ftps/file/copy/index.d.ts

@@ -1,4 +1,4 @@
-import { type Client } from 'basic-ftp';
+import type { Client } from 'basic-ftp';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type CopyOptions = {
     /**
@@ -17,11 +17,11 @@ export type CopyOptions = {
  * Copies a file from one path to another on the same FTP server, streaming the
  * data instead of buffering it in memory.
  *
- * @param {Client}  ftpClient  - The basic‑ftp client instance.
- * @param {string}  sourcePath - The path of the source file.
- * @param {string}  targetPath - The destination path.
- * @param {CopyOptions} [options] - Optional copy configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param  ftpClient  - The basic‑ftp client instance.
+ * @param  sourcePath - The path of the source file.
+ * @param  targetPath - The destination path.
+ * @param [options] - Optional copy configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

package/node/ftps/file/copy/index.js

@@ -5,11 +5,11 @@ import { unknownToString } from '../../../../agnostic/errors/unknown-to-string/i
  * Copies a file from one path to another on the same FTP server, streaming the
  * data instead of buffering it in memory.
  *
- * @param {Client}  ftpClient  - The basic‑ftp client instance.
- * @param {string}  sourcePath - The path of the source file.
- * @param {string}  targetPath - The destination path.
- * @param {CopyOptions} [options] - Optional copy configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param  ftpClient  - The basic‑ftp client instance.
+ * @param  sourcePath - The path of the source file.
+ * @param  targetPath - The destination path.
+ * @param [options] - Optional copy configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

package/node/ftps/file/download/index.d.ts

@@ -1,5 +1,5 @@
 import { type Readable } from 'node:stream';
-import { type Client } from 'basic-ftp';
+import type { Client } from 'basic-ftp';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type DownloadOptions = {
     startAt?: number;
@@ -11,11 +11,11 @@ export type DownloadOptions = {
  * returning the file content as a Readable stream. The download process can be customized
  * using optional download options.
  *
- * @param {Client} ftpClient - The basic-ftp client instance used to interact with the FTP server.
- * @param {string} sourcePath - The path of the file to be downloaded from the FTP server.
- * @param {DownloadOptions} [options] - Optional settings for configuring the download process.
- * @param {number} [options.startAt] - The byte offset at which to start downloading the file.
- * @returns {Promise<Outcome.Either<Readable, string>>} A promise that resolves to an Outcome.Either.
+ * @param ftpClient - The basic-ftp client instance used to interact with the FTP server.
+ * @param sourcePath - The path of the file to be downloaded from the FTP server.
+ * @param [options] - Optional settings for configuring the download process.
+ * @param [options.startAt] - The byte offset at which to start downloading the file.
+ * @returns A promise that resolves to an Outcome.Either.
  * - On success: Outcome.makeSuccess(stream) containing the downloaded file's content as a Readable stream.
  * - On failure: Outcome.makeFailure(errStr) with an error message if the download fails.
  */

package/node/ftps/file/download/index.js

@@ -8,11 +8,11 @@ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
  * returning the file content as a Readable stream. The download process can be customized
  * using optional download options.
  *
- * @param {Client} ftpClient - The basic-ftp client instance used to interact with the FTP server.
- * @param {string} sourcePath - The path of the file to be downloaded from the FTP server.
- * @param {DownloadOptions} [options] - Optional settings for configuring the download process.
- * @param {number} [options.startAt] - The byte offset at which to start downloading the file.
- * @returns {Promise<Outcome.Either<Readable, string>>} A promise that resolves to an Outcome.Either.
+ * @param ftpClient - The basic-ftp client instance used to interact with the FTP server.
+ * @param sourcePath - The path of the file to be downloaded from the FTP server.
+ * @param [options] - Optional settings for configuring the download process.
+ * @param [options.startAt] - The byte offset at which to start downloading the file.
+ * @returns A promise that resolves to an Outcome.Either.
  * - On success: Outcome.makeSuccess(stream) containing the downloaded file's content as a Readable stream.
  * - On failure: Outcome.makeFailure(errStr) with an error message if the download fails.
  */

package/node/ftps/file/exists/index.d.ts

@@ -12,9 +12,9 @@ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
  * `FileType.SymbolicLink`, mirroring the SFTP behaviour where `'-'` and `'l'`
  * are considered files.
  *
- * @param {Client} ftpClient  - The basic‑ftp client instance.
- * @param {string} sourcePath - The full path to check on the FTP server.
- * @returns {Promise<Outcome.Either<boolean, string>>}
+ * @param ftpClient  - The basic‑ftp client instance.
+ * @param sourcePath - The full path to check on the FTP server.
+ * @returns
  * - Success: `Outcome.makeSuccess(true | false)` – true only if a file exists.
  * - Failure: `Outcome.makeFailure(errStr)` if an error occurs.
  */

package/node/ftps/file/exists/index.js

@@ -13,9 +13,9 @@ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
  * `FileType.SymbolicLink`, mirroring the SFTP behaviour where `'-'` and `'l'`
  * are considered files.
  *
- * @param {Client} ftpClient  - The basic‑ftp client instance.
- * @param {string} sourcePath - The full path to check on the FTP server.
- * @returns {Promise<Outcome.Either<boolean, string>>}
+ * @param ftpClient  - The basic‑ftp client instance.
+ * @param sourcePath - The full path to check on the FTP server.
+ * @returns
  * - Success: `Outcome.makeSuccess(true | false)` – true only if a file exists.
  * - Failure: `Outcome.makeFailure(errStr)` if an error occurs.
  */

package/node/ftps/file/move/index.d.ts

@@ -1,4 +1,4 @@
-import { type Client } from 'basic-ftp';
+import type { Client } from 'basic-ftp';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type MoveOptions = {
     /**
@@ -25,13 +25,13 @@ export type MoveOptions = {
  * 2. **overwrite** – If disabled (default) the function first checks whether
  *    an object already exists at `targetPath`; if so, it aborts.
  *
- * @param {Client} ftpClient  - The basic‑ftp client instance.
- * @param {string} sourcePath - The full path of the source file.
- * @param {string} targetPath - The full destination path.
- * @param {MoveOptions} [options] - Optional move configuration.
- * @param {boolean} [options.ensureDir=true]  - Whether to create missing parent directories.
- * @param {boolean} [options.overwrite=false] - Whether to overwrite an existing destination.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param ftpClient  - The basic‑ftp client instance.
+ * @param sourcePath - The full path of the source file.
+ * @param targetPath - The full destination path.
+ * @param [options] - Optional move configuration.
+ * @param [options.ensureDir=true]  - Whether to create missing parent directories.
+ * @param [options.overwrite=false] - Whether to overwrite an existing destination.
+ * @returns
  * - On success: `Outcome.makeSuccess(true)`.
  * - On failure: `Outcome.makeFailure(errStr)`.
  */

package/node/ftps/file/move/index.js

@@ -1,5 +1,6 @@
 import { unknownToString } from '../../../../agnostic/errors/unknown-to-string/index.js';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
+import { deepGetProperty } from '../../../../agnostic/objects/deep-get-property/index.js';
 /**
  * Moves (renames) a file on an FTP server.
  *
@@ -11,13 +12,13 @@ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
  * 2. **overwrite** – If disabled (default) the function first checks whether
  *    an object already exists at `targetPath`; if so, it aborts.
  *
- * @param {Client} ftpClient  - The basic‑ftp client instance.
- * @param {string} sourcePath - The full path of the source file.
- * @param {string} targetPath - The full destination path.
- * @param {MoveOptions} [options] - Optional move configuration.
- * @param {boolean} [options.ensureDir=true]  - Whether to create missing parent directories.
- * @param {boolean} [options.overwrite=false] - Whether to overwrite an existing destination.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param ftpClient  - The basic‑ftp client instance.
+ * @param sourcePath - The full path of the source file.
+ * @param targetPath - The full destination path.
+ * @param [options] - Optional move configuration.
+ * @param [options.ensureDir=true]  - Whether to create missing parent directories.
+ * @param [options.overwrite=false] - Whether to overwrite an existing destination.
+ * @returns
  * - On success: `Outcome.makeSuccess(true)`.
  * - On failure: `Outcome.makeFailure(errStr)`.
  */
@@ -34,9 +35,10 @@ export async function move(ftpClient, sourcePath, targetPath, options) {
                 return Outcome.makeFailure(`File already exists at ${targetPath}.`);
             }
             catch (err) {
-                if (err.code !== 550) { // 550 = "not found"; any other error -> propagate
+                const code = deepGetProperty(err, 'code');
+                // 550 = "not found"; any other error -> propagate
+                if (code !== 550)
                     return Outcome.makeFailure(unknownToString(err));
-                }
                 // 550 means destination does not exist – proceed
             }
         }

package/node/ftps/file/remove/index.d.ts

@@ -1,4 +1,4 @@
-import { type Client } from 'basic-ftp';
+import type { Client } from 'basic-ftp';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type RemoveOptions = {
     ignoreMissing?: boolean;
@@ -10,10 +10,10 @@ export type RemoveOptions = {
  * The deletion process can be customized using optional delete options.
  * If the `ignoreMissing` option is true, it does not treat a missing file as an error.
  *
- * @param {Client} ftpClient - The basic-ftp client instance used to interact with the FTP server.
- * @param {string} targetPath - The path of the file to delete on the FTP server.
- * @param {RemoveOptions} [options] - Optional settings for configuring the deletion process.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an Outcome.Either.
+ * @param ftpClient - The basic-ftp client instance used to interact with the FTP server.
+ * @param targetPath - The path of the file to delete on the FTP server.
+ * @param [options] - Optional settings for configuring the deletion process.
+ * @returns A promise that resolves to an Outcome.Either.
  * - On success: Outcome.makeSuccess(true) indicating the deletion was successful.
  * - On failure: Outcome.makeFailure(errStr) with an error message if the deletion fails.
  */

package/node/ftps/file/remove/index.js

@@ -7,10 +7,10 @@ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
  * The deletion process can be customized using optional delete options.
  * If the `ignoreMissing` option is true, it does not treat a missing file as an error.
  *
- * @param {Client} ftpClient - The basic-ftp client instance used to interact with the FTP server.
- * @param {string} targetPath - The path of the file to delete on the FTP server.
- * @param {RemoveOptions} [options] - Optional settings for configuring the deletion process.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an Outcome.Either.
+ * @param ftpClient - The basic-ftp client instance used to interact with the FTP server.
+ * @param targetPath - The path of the file to delete on the FTP server.
+ * @param [options] - Optional settings for configuring the deletion process.
+ * @returns A promise that resolves to an Outcome.Either.
  * - On success: Outcome.makeSuccess(true) indicating the deletion was successful.
  * - On failure: Outcome.makeFailure(errStr) with an error message if the deletion fails.
  */

package/node/ftps/file/stat/index.d.ts

@@ -1,4 +1,4 @@
-import { type Client as FtpClient, type FileInfo } from 'basic-ftp';
+import type { Client as FtpClient, FileInfo } from 'basic-ftp';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export interface Stat {
     size?: number;
@@ -10,8 +10,8 @@ export interface Stat {
  * Retrieves metadata for a single file on an FTP server by listing its parent
  * directory and matching the entry.
  *
- * @param {FtpClient} ftp – basic‑ftp client.
- * @param {string} path  – Remote file path.
- * @returns {Promise<Outcome.Either<Stat, string>>}
+ * @param ftp – basic‑ftp client.
+ * @param path  – Remote file path.
+ * @returns
  */
 export declare function stat(ftp: FtpClient, path: string): Promise<Outcome.Either<Stat, string>>;

package/node/ftps/file/stat/index.js

@@ -4,9 +4,9 @@ import { unknownToString } from '../../../../agnostic/errors/unknown-to-string/i
  * Retrieves metadata for a single file on an FTP server by listing its parent
  * directory and matching the entry.
  *
- * @param {FtpClient} ftp – basic‑ftp client.
- * @param {string} path  – Remote file path.
- * @returns {Promise<Outcome.Either<Stat, string>>}
+ * @param ftp – basic‑ftp client.
+ * @param path  – Remote file path.
+ * @returns
  */
 export async function stat(ftp, path) {
     try {
@@ -21,7 +21,7 @@ export async function stat(ftp, path) {
         return Outcome.makeSuccess({
             size: entry.size,
             modifiedAt: entry.modifiedAt ?? undefined,
-            permissions: entry.rawModifiedAt.toString(),
+            permissions: entry.rawModifiedAt,
             raw: entry
         });
     }

package/node/ftps/file/upload/index.d.ts

@@ -1,5 +1,5 @@
-import { type Readable } from 'node:stream';
-import { type Client, type UploadOptions as BasicFtpUploadOptions } from 'basic-ftp';
+import type { Readable } from 'node:stream';
+import type { Client, UploadOptions as BasicFtpUploadOptions } from 'basic-ftp';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type UploadOptions = BasicFtpUploadOptions & {
     ensureDir?: boolean;
@@ -13,11 +13,11 @@ export type UploadOptions = BasicFtpUploadOptions & {
  * If the `ensureDir` option is true, it ensures that the target directory exists before uploading.
  * If the `overwrite` option is false, it prevents overwriting an existing file.
  *
- * @param {Client} ftpClient - The basic-ftp client instance used to interact with the FTP server.
- * @param {string} targetPath - The target path where the file will be stored on the FTP server.
- * @param {Readable} fileStream - The file content to be uploaded.
- * @param {UploadOptions} [options] - Optional settings for configuring the upload process.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an Outcome.Either.
+ * @param ftpClient - The basic-ftp client instance used to interact with the FTP server.
+ * @param targetPath - The target path where the file will be stored on the FTP server.
+ * @param fileStream - The file content to be uploaded.
+ * @param [options] - Optional settings for configuring 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/ftps/file/upload/index.js

@@ -8,11 +8,11 @@ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
  * If the `ensureDir` option is true, it ensures that the target directory exists before uploading.
  * If the `overwrite` option is false, it prevents overwriting an existing file.
  *
- * @param {Client} ftpClient - The basic-ftp client instance used to interact with the FTP server.
- * @param {string} targetPath - The target path where the file will be stored on the FTP server.
- * @param {Readable} fileStream - The file content to be uploaded.
- * @param {UploadOptions} [options] - Optional settings for configuring the upload process.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an Outcome.Either.
+ * @param ftpClient - The basic-ftp client instance used to interact with the FTP server.
+ * @param targetPath - The target path where the file will be stored on the FTP server.
+ * @param fileStream - The file content to be uploaded.
+ * @param [options] - Optional settings for configuring 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/images/create/index.d.ts

@@ -1,4 +1,4 @@
-import sharp from 'sharp';
+import type { Sharp } from 'sharp';
 import type { CreateOptions } from '../types.js';
 /**
  * Creates a new image using Sharp with the specified options.
@@ -6,4 +6,4 @@ import type { CreateOptions } from '../types.js';
  * @param options - Image creation options. See `CreateOptions` for details.
  * @returns A Sharp instance ready for further image operations.
  */
-export declare function create(options: CreateOptions): Promise<sharp.Sharp>;
+export declare function create(options: CreateOptions): Sharp;

package/node/images/create/index.js

@@ -6,6 +6,6 @@ import { toCreateOptions } from '../utils/index.js';
  * @param options - Image creation options. See `CreateOptions` for details.
  * @returns A Sharp instance ready for further image operations.
  */
-export async function create(options) {
+export function create(options) {
     return sharp({ create: toCreateOptions(options) });
 }

package/node/images/format/index.d.ts

@@ -1,4 +1,4 @@
-import type sharp from 'sharp';
+import type { ResizeOptions, JpegOptions, PngOptions, WebpOptions, AvifOptions, TiffOptions, HeifOptions } from 'sharp';
 import * as Outcome from '../../../agnostic/misc/outcome/index.js';
 import type { FormatCommonOptions, FormatJpgOptions, FormatPngOptions, FormatWebpOptions, FormatAvifOptions, FormatTiffOptions, FormatHeifOptions, FormatOptions, ImageLike } from '../types.js';
 /** Type guard to check if options match FormatCommonOptions. */
@@ -18,19 +18,19 @@ export declare const isFormatHeifOptions: (options: unknown) => options is Forma
 /** Type guard to check if options match FormatOptions. */
 export declare const isFormatOptions: (options: unknown) => options is FormatOptions;
 /** Converts FormatCommonOptions to Sharp resize options. */
-export declare const toSharpResizeOptions: (options: FormatCommonOptions) => sharp.ResizeOptions;
+export declare const toSharpResizeOptions: (options: FormatCommonOptions) => ResizeOptions;
 /** Converts FormatJpgOptions to Sharp JPEG options. */
-export declare const toSharpJpegOptions: (options: FormatJpgOptions) => sharp.JpegOptions;
+export declare const toSharpJpegOptions: (options: FormatJpgOptions) => JpegOptions;
 /** Converts FormatPngOptions to Sharp PNG options. */
-export declare const toSharpPngOptions: (options: FormatPngOptions) => sharp.PngOptions;
+export declare const toSharpPngOptions: (options: FormatPngOptions) => PngOptions;
 /** Converts FormatWebpOptions to Sharp WebP options. */
-export declare const toSharpWebpOptions: (options: FormatWebpOptions) => sharp.WebpOptions;
+export declare const toSharpWebpOptions: (options: FormatWebpOptions) => WebpOptions;
 /** Converts FormatAvifOptions to Sharp AVIF options. */
-export declare const toSharpAvifOptions: (options: FormatAvifOptions) => sharp.AvifOptions;
+export declare const toSharpAvifOptions: (options: FormatAvifOptions) => AvifOptions;
 /** Converts FormatTiffOptions to Sharp TIFF options. */
-export declare const toSharpTiffOptions: (options: FormatTiffOptions) => sharp.TiffOptions;
+export declare const toSharpTiffOptions: (options: FormatTiffOptions) => TiffOptions;
 /** Converts FormatHeifOptions to Sharp HEIF options. */
-export declare const toSharpHeifOptions: (options: FormatHeifOptions) => sharp.HeifOptions;
+export declare const toSharpHeifOptions: (options: FormatHeifOptions) => HeifOptions;
 /**
  * Formats an image with the specified options.
  *

package/node/images/metadata/index.d.ts

@@ -1,4 +1,4 @@
-import type sharp from 'sharp';
+import type { Metadata } from 'sharp';
 import type { ImageLike } from '../types.js';
 /**
  * Retrieves metadata from an image.
@@ -6,4 +6,4 @@ import type { ImageLike } from '../types.js';
  * @param imageInput - The image to get metadata from. Can be a Sharp instance, Buffer, CreateOptions, or file path.
  * @returns Image metadata including dimensions, format, color space, and other properties.
  */
-export declare function metadata(imageInput: ImageLike): Promise<sharp.Metadata>;
+export declare function metadata(imageInput: ImageLike): Promise<Metadata>;

package/node/images/transform/index.d.ts

@@ -1,4 +1,4 @@
-import type sharp from 'sharp';
+import type { Sharp } from 'sharp';
 import * as Outcome from '../../../agnostic/misc/outcome/index.js';
 import { type OperationDescriptor, type TransformLimits, type TransformErr, type ImageLike } from '../types.js';
 /**
@@ -24,4 +24,4 @@ export declare function isOperationDescriptor(obj: unknown): Outcome.Either<Oper
  * - On success:  `Outcome.makeSuccess(sharpInstance)` with the transformed Sharp instance.
  * - On failure:  `Outcome.makeFailure(error)` with error code and details.
  */
-export declare function transform(input: ImageLike, operationsSequence: OperationDescriptor[], limits?: TransformLimits): Promise<Outcome.Either<sharp.Sharp, TransformErr>>;
+export declare function transform(input: ImageLike, operationsSequence: OperationDescriptor[], limits?: TransformLimits): Promise<Outcome.Either<Sharp, TransformErr>>;

package/node/images/transform/index.js

@@ -46,22 +46,28 @@ export function isOperationDescriptor(obj) {
         return Outcome.makeFailure('Invalid operation descriptor');
     if (!('name' in obj) || typeof obj.name !== 'string')
         return Outcome.makeFailure('Field named \'name\' in operation descriptor is required and must be a string');
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- not yet proven; verified below via Set.has(...)/object-key lookup, which are safe regardless of this type
     const name = obj.name;
     const validateOperation = (validatorFn) => {
         const result = validatorFn(obj);
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions, @typescript-eslint/no-unsafe-type-assertion
         if (result.success)
             return Outcome.makeSuccess({
-                name: obj.name,
+                name,
                 ...result.payload
             });
         return Outcome.makeFailure(result.error);
     };
     const simpleOperations = new Set([OpName.FLIP, OpName.FLOP]);
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Set.has(...) performs the real runtime membership check regardless of this cast
     if (simpleOperations.has(name))
         return Outcome.makeSuccess({
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- membership was just confirmed by simpleOperations.has(...) above
             name: name
         });
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- the object-key lookup that follows returns undefined for any non-matching name, which is handled below
     const validator = validators[name];
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (validator !== undefined)
         return validateOperation(validator);
     return Outcome.makeFailure('Invalid operation descriptor');
@@ -90,7 +96,9 @@ export async function transform(input, operationsSequence, limits) {
     const runWithOpTimeout = async (op) => {
         return limits?.opTimeoutMs === undefined
             ? await op()
-            : await Promise.race([op(), new Promise(resolve => setTimeout(() => resolve(TransformErrCodes.OP_TIMEOUT), limits.opTimeoutMs))]);
+            : await Promise.race([op(), new Promise(resolve => {
+                    setTimeout(() => resolve(TransformErrCodes.OP_TIMEOUT), limits.opTimeoutMs);
+                })]);
     };
     for (const operation of operationsSequence) {
         // Process timeout check
@@ -103,6 +111,7 @@ export async function transform(input, operationsSequence, limits) {
         // Apply transformation
         let result;
         try {
+            // eslint-disable-next-line no-loop-func
             result = await runWithOpTimeout(async () => {
                 switch (operation.name) {
                     case OpName.BLUR: return await blur(sharpInstance, operation);
@@ -120,6 +129,7 @@ export async function transform(input, operationsSequence, limits) {
                     case OpName.RESIZE: return await resize(sharpInstance, operation);
                     case OpName.ROTATE: return await rotate(sharpInstance, operation);
                     case OpName.SATURATE: return await saturate(sharpInstance, operation);
+                    // eslint-disable-next-line @typescript-eslint/switch-exhaustiveness-check
                     default: return sharpInstance;
                 }
             });

package/node/images/transform/operations/blur/index.d.ts

@@ -1,5 +1,5 @@
-import type sharp from 'sharp';
+import type { Sharp } from 'sharp';
 import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 import type { BlurOperationParams } from '../../../types.js';
 export declare function isBlurOperationParams(obj: unknown): Outcome.Either<BlurOperationParams, string>;
-export declare function blur(sharpInstance: sharp.Sharp, params: BlurOperationParams): Promise<sharp.Sharp>;
+export declare function blur(sharpInstance: Sharp, params: BlurOperationParams): Promise<Sharp>;

package/node/images/transform/operations/blur/index.js

@@ -7,6 +7,7 @@ export function isBlurOperationParams(obj) {
         return Outcome.makeFailure(result.error.message);
     return Outcome.makeSuccess(result.data);
 }
+// eslint-disable-next-line @typescript-eslint/require-await
 export async function blur(sharpInstance, params) {
     return sharpInstance.blur(params.sigma);
 }