@design-edito/tools 0.4.23 → 0.5.1

package/node/process/spawner/index.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 import { spawn, spawnSync } from 'node:child_process';
 import ansiRegex from 'ansi-regex';
 import chalk from 'chalk';
@@ -23,7 +24,7 @@ import { unknownToString } from '../../../agnostic/errors/unknown-to-string/inde
 export async function spawner(label, command, args, options) {
     return await new Promise((resolve, reject) => {
         if (label !== null)
-            console.log('\n' + styles.info(label) + '\n');
+            console.log(`\n${styles.info(label)}\n`);
         const printableArgs = options?.argsPrintFormat !== undefined
             ? options.argsPrintFormat(args)
             : args;
@@ -48,7 +49,7 @@ export async function spawner(label, command, args, options) {
         });
         prcss.on('close', code => {
             if (code !== 0 && options?.throwOnError === true)
-                reject(new Error(stderr + '\n' + stdout));
+                reject(new Error(`${stderr}\n${stdout}`));
             else if (code !== 0)
                 return resolve(Outcome.makeFailure({ stdout, stderr, err }));
             else
@@ -75,14 +76,14 @@ export async function spawner(label, command, args, options) {
  */
 export function spawnerSync(label, command, args, options) {
     if (label !== null)
-        console.log('\n' + styles.info(label) + '\n');
+        console.log(`\n${styles.info(label)}\n}`);
     const printableArgs = options?.argsPrintFormat !== undefined
         ? options.argsPrintFormat(args)
         : args;
     console.log(styles.light(`> ${command} ${printableArgs.join(' ')}\n`));
     const result = spawnSync(command, args, { stdio: 'pipe', encoding: 'utf8', ...options });
-    const stderr = result.stderr?.toString().trim();
-    const stdout = result.stdout?.toString().trim();
+    const stderr = result.stderr.toString().trim();
+    const stdout = result.stdout.toString().trim();
     const err = result.error;
     if (err !== undefined) {
         console.log(styles.light(chalk.italic('err:\n')));
@@ -100,7 +101,7 @@ export function spawnerSync(label, command, args, options) {
         console.log('');
     }
     if (result.status !== 0 && options?.throwOnError === true)
-        throw new Error(stderr + '\n' + stdout);
+        throw new Error(`${stderr}\n${stdout}`);
     else if (result.status !== 0)
         return Outcome.makeFailure({ stdout, stderr, err });
     return Outcome.makeSuccess({ stdout, stderr, err });

package/node/sftp/directory/copy-dir/index.d.ts

@@ -1,4 +1,4 @@
-import { type TransferOptions } from 'ssh2-sftp-client';
+import type { TransferOptions } from 'ssh2-sftp-client';
 import type Client from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type CopyDirOptions = TransferOptions & {
@@ -18,11 +18,11 @@ export type CopyDirOptions = TransferOptions & {
  * Recursively copies every file under `sourceDir` to the same relative path
  * beneath `targetDir` on an SFTP server, streaming data to minimize memory usage.
  *
- * @param {Client} sftp - The SFTP 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 sftp - The SFTP 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
  * - On success: `Outcome.makeSuccess(true)` indicating the copy was successful.
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the copy fails.
  */

package/node/sftp/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 SFTP server, streaming data to minimize memory usage.
  *
- * @param {Client} sftp - The SFTP 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 sftp - The SFTP 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
  * - On success: `Outcome.makeSuccess(true)` indicating the copy was successful.
  * - On failure: `Outcome.makeFailure(errStr)` with an error message if the copy fails.
  */
@@ -18,7 +18,7 @@ export async function copyDir(sftp, sourceDir, targetDir, options) {
     async function recurse(dir) {
         const list = await sftp.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.type === 'd') {

package/node/sftp/directory/index.d.ts

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

package/node/sftp/directory/index.js

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

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

@@ -5,8 +5,8 @@ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
  *
  * This function returns only the immediate files (not recursive) under the specified directory.
  *
- * @param {Client} sftp - The ssh2-sftp-client instance used to interact with the SFTP 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 sftp - The ssh2-sftp-client instance used to interact with the SFTP 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(sftp: Client, directoryPath: string): Promise<Outcome.Either<string[], string>>;

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

@@ -5,16 +5,16 @@ import { unknownToString } from '../../../../agnostic/errors/unknown-to-string/i
  *
  * This function returns only the immediate files (not recursive) under the specified directory.
  *
- * @param {Client} sftp - The ssh2-sftp-client instance used to interact with the SFTP 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 sftp - The ssh2-sftp-client instance used to interact with the SFTP 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(sftp, directoryPath) {
     try {
         const list = await sftp.list(directoryPath);
         const files = list
             .filter(entry => entry.type === '-')
-            .map(entry => (directoryPath.endsWith('/') ? directoryPath + entry.name : directoryPath + '/' + entry.name));
+            .map(entry => (directoryPath.endsWith('/') ? `${directoryPath}${entry.name}` : `${directoryPath}/${entry.name}`));
         return Outcome.makeSuccess(files);
     }
     catch (err) {

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

@@ -13,13 +13,13 @@ export type MoveDirOptions = {
  * If `ensureDir` is true (default), the parent directory of `targetDir` is
  * created if it does not exist.
  *
- * @param {Client} sftp - The SFTP 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.
- * @param {boolean} [options.overwrite=false] - If false and `targetDir` exists, abort.
- * @param {boolean} [options.ensureDir=true] - Whether to create the parent directory of `targetDir`.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`:
+ * @param sftp - The SFTP 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.
+ * @param [options.overwrite=false] - If false and `targetDir` exists, abort.
+ * @param [options.ensureDir=true] - Whether to create the parent directory of `targetDir`.
+ * @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/sftp/directory/move-dir/index.js

@@ -7,13 +7,13 @@ 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} sftp - The SFTP 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.
- * @param {boolean} [options.overwrite=false] - If false and `targetDir` exists, abort.
- * @param {boolean} [options.ensureDir=true] - Whether to create the parent directory of `targetDir`.
- * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`:
+ * @param sftp - The SFTP 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.
+ * @param [options.overwrite=false] - If false and `targetDir` exists, abort.
+ * @param [options.ensureDir=true] - Whether to create the parent directory of `targetDir`.
+ * @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/sftp/directory/remove-dir/index.d.ts

@@ -12,11 +12,11 @@ export type RemoveDirOptions = {
 /**
  * Recursively deletes a directory (and all contents) on an SFTP server.
  *
- * @param {Client}  sftp           - The SFTP 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  sftp           - The SFTP 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 the
  *   directory was absent and `ignoreMissing` is true.
  * - On failure: `Outcome.makeFailure(errStr)` if deletion fails, or directory

package/node/sftp/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 SFTP server.
  *
- * @param {Client}  sftp           - The SFTP 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  sftp           - The SFTP 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 the
  *   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(sftp, directoryPath, options) {
         return Outcome.makeSuccess(true);
     }
     catch (err) {
+        const code = deepGetProperty(err, 'code');
         // ssh2-sftp-client uses code 2 / ENOENT for “No such file or directory”
-        if (ignoreMissing && (err.code === 2 || err.code === 'ENOENT')) {
+        if (ignoreMissing && (code === 2 || code === 'ENOENT'))
             return Outcome.makeSuccess(true);
-        }
         return Outcome.makeFailure(unknownToString(err));
     }
 }

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

@@ -1,4 +1,4 @@
-import { type TransferOptions } from 'ssh2-sftp-client';
+import type { TransferOptions } from 'ssh2-sftp-client';
 import type Client from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type CopyOptions = TransferOptions & {
@@ -18,11 +18,11 @@ export type CopyOptions = TransferOptions & {
  * Copies a file from one path to another on the same SFTP server using streams
  * (avoids loading the entire file into memory).
  *
- * @param {Client}  sftp       - The ssh2‑sftp‑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  sftp       - The ssh2‑sftp‑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/sftp/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 SFTP server using streams
  * (avoids loading the entire file into memory).
  *
- * @param {Client}  sftp       - The ssh2‑sftp‑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  sftp       - The ssh2‑sftp‑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/sftp/file/download/index.d.ts

@@ -1,5 +1,5 @@
-import { type Readable } from 'node:stream';
-import { type ReadStreamOptions } from 'ssh2';
+import type { Readable } from 'node:stream';
+import type { ReadStreamOptions } from 'ssh2';
 import type Client from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type DownloadOptions = ReadStreamOptions;
@@ -10,11 +10,11 @@ export type DownloadOptions = ReadStreamOptions;
  * returning the file content as a Readable stream. The download process can be customized
  * using optional download options.
  *
- * @param {Client} sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
- * @param {string} sourcePath - The path of the file to be downloaded from the SFTP server.
- * @param {DownloadOptions} [options] - Optional settings for configuring the download process.
- * @returns {Promise<Outcome.Either<Readable, string>>} A promise that resolves to an Outcome.Either.
+ * @param sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
+ * @param sourcePath - The path of the file to be downloaded from the SFTP server.
+ * @param [options] - Optional settings for configuring the download process.
+ * @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.
  */
-export declare function download(sftp: Client, sourcePath: string, options?: DownloadOptions): Promise<Outcome.Either<Readable, string>>;
+export declare function download(sftp: Client, sourcePath: string, options?: DownloadOptions): Outcome.Either<Readable, string>;

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

@@ -7,14 +7,14 @@ 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} sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
- * @param {string} sourcePath - The path of the file to be downloaded from the SFTP server.
- * @param {DownloadOptions} [options] - Optional settings for configuring the download process.
- * @returns {Promise<Outcome.Either<Readable, string>>} A promise that resolves to an Outcome.Either.
+ * @param sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
+ * @param sourcePath - The path of the file to be downloaded from the SFTP server.
+ * @param [options] - Optional settings for configuring the download process.
+ * @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.
  */
-export async function download(sftp, sourcePath, options) {
+export function download(sftp, sourcePath, options) {
     try {
         const stream = sftp.createReadStream(sourcePath, options);
         stream.on('error', (err) => { throw err; });

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

@@ -12,9 +12,9 @@ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
  * For the purpose of this util we treat a regular file (`'-'`) **or** a
  * symlink (`'l'`) as a “file”. A directory (`'d'`) returns `false`.
  *
- * @param {Client} sftp        - The ssh2‑sftp‑client instance.
- * @param {string} sourcePath  - The path to check.
- * @returns {Promise<Outcome.Either<boolean, string>>}
+ * @param sftp        - The ssh2‑sftp‑client instance.
+ * @param sourcePath  - The path to check.
+ * @returns
  * - Success: `Outcome.makeSuccess(true | false)` indicating file existence.
  * - Failure: `Outcome.makeFailure(errStr)` if an error occurs.
  */

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

@@ -12,9 +12,9 @@ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
  * For the purpose of this util we treat a regular file (`'-'`) **or** a
  * symlink (`'l'`) as a “file”. A directory (`'d'`) returns `false`.
  *
- * @param {Client} sftp        - The ssh2‑sftp‑client instance.
- * @param {string} sourcePath  - The path to check.
- * @returns {Promise<Outcome.Either<boolean, string>>}
+ * @param sftp        - The ssh2‑sftp‑client instance.
+ * @param sourcePath  - The path to check.
+ * @returns
  * - Success: `Outcome.makeSuccess(true | false)` indicating file existence.
  * - Failure: `Outcome.makeFailure(errStr)` if an error occurs.
  */

package/node/sftp/file/index.d.ts

@@ -1,7 +1,7 @@
-export * as download from './download/index.js'
 export * as copy from './copy/index.js'
+export * as download from './download/index.js'
+export * as remove from './remove/index.js'
 export * as exists from './exists/index.js'
 export * as move from './move/index.js'
-export * as remove from './remove/index.js'
 export * as stat from './stat/index.js'
 export * as upload from './upload/index.js'

package/node/sftp/file/index.js

@@ -1,7 +1,7 @@
-export * as download from './download/index.js'
 export * as copy from './copy/index.js'
+export * as download from './download/index.js'
+export * as remove from './remove/index.js'
 export * as exists from './exists/index.js'
 export * as move from './move/index.js'
-export * as remove from './remove/index.js'
 export * as stat from './stat/index.js'
 export * as upload from './upload/index.js'

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

@@ -25,13 +25,13 @@ export type MoveOptions = {
  * 2. **overwrite** – If disabled (default) the function first checks whether
  *    something already exists at `targetPath`; if so, it aborts.
  *
- * @param {Client} sftp          - The ssh2‑sftp‑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 sftp          - The ssh2‑sftp‑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/sftp/file/move/index.js

@@ -11,13 +11,13 @@ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
  * 2. **overwrite** – If disabled (default) the function first checks whether
  *    something already exists at `targetPath`; if so, it aborts.
  *
- * @param {Client} sftp          - The ssh2‑sftp‑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 sftp          - The ssh2‑sftp‑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/sftp/file/remove/index.d.ts

@@ -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 {SftpClient} sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
- * @param {string} targetPath - The path of the file to delete on the SFTP 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 sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
+ * @param targetPath - The path of the file to delete on the SFTP 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/sftp/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 {SftpClient} sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
- * @param {string} targetPath - The path of the file to delete on the SFTP 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 sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
+ * @param targetPath - The path of the file to delete on the SFTP 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/sftp/file/stat/index.d.ts

@@ -11,8 +11,8 @@ export interface Stat {
 /**
  * Retrieves metadata for a file on an SFTP server.
  *
- * @param {SftpClient} sftp – ssh2-sftp-client.
- * @param {string} path     – Remote file path.
- * @returns {Promise<Outcome.Either<Stat, string>>}
+ * @param sftp – ssh2-sftp-client.
+ * @param path     – Remote file path.
+ * @returns
  */
 export declare function stat(sftp: SftpClient, path: string): Promise<Outcome.Either<Stat, string>>;

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

@@ -1,11 +1,12 @@
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 import { unknownToString } from '../../../../agnostic/errors/unknown-to-string/index.js';
+import { deepGetProperty } from '../../../../agnostic/objects/deep-get-property/index.js';
 /**
  * Retrieves metadata for a file on an SFTP server.
  *
- * @param {SftpClient} sftp – ssh2-sftp-client.
- * @param {string} path     – Remote file path.
- * @returns {Promise<Outcome.Either<Stat, string>>}
+ * @param sftp – ssh2-sftp-client.
+ * @param path     – Remote file path.
+ * @returns
  */
 export async function stat(sftp, path) {
     try {
@@ -20,9 +21,9 @@ export async function stat(sftp, path) {
         });
     }
     catch (err) {
-        if (err.code === 2 || err.code === 'ENOENT') {
+        const code = deepGetProperty(err, 'code');
+        if (code === 2 || code === 'ENOENT')
             return Outcome.makeFailure(`File not found: ${path}`);
-        }
         return Outcome.makeFailure(unknownToString(err));
     }
 }

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

@@ -1,6 +1,6 @@
 import type { Readable } from 'node:stream';
 import type Client from 'ssh2-sftp-client';
-import { type TransferOptions } from 'ssh2-sftp-client';
+import type { TransferOptions } from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type UploadOptions = TransferOptions & {
     ensureDir?: boolean;
@@ -14,11 +14,11 @@ export type UploadOptions = TransferOptions & {
  * If the `ensureDir` option is true, it ensures that the target directory exists before uploading.
  * If the `overwrite` option is false and a file already exists at the target path, the upload is aborted.
  *
- * @param {Client} sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
- * @param {string} targetPath - The target path where the file will be stored on the SFTP 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 sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
+ * @param targetPath - The target path where the file will be stored on the SFTP 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/sftp/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 and a file already exists at the target path, the upload is aborted.
  *
- * @param {Client} sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
- * @param {string} targetPath - The target path where the file will be stored on the SFTP 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 sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
+ * @param targetPath - The target path where the file will be stored on the SFTP 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.
  */