@design-edito/tools 0.4.22 → 0.5.0

package/node/images/transform/operations/normalize/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 { NormalizeOperationParams } from '../../../types.js';
 export declare function isNormalizeOperationParams(obj: unknown): Outcome.Either<NormalizeOperationParams, string>;
-export declare function normalize(sharpInstance: sharp.Sharp, params: NormalizeOperationParams): Promise<sharp.Sharp>;
+export declare function normalize(sharpInstance: Sharp, params: NormalizeOperationParams): Promise<Sharp>;

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

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

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

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

package/node/images/transform/operations/resize/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 { ResizeOperationParams } from '../../../types.js';
 export declare function isResizeOperationParams(obj: unknown): Outcome.Either<ResizeOperationParams, string>;
-export declare function resize(sharpInstance: sharp.Sharp, params: ResizeOperationParams): Promise<sharp.Sharp>;
+export declare function resize(sharpInstance: Sharp, params: ResizeOperationParams): Promise<Sharp>;

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

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

package/node/images/transform/operations/rotate/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 { RotateOperationParams } from '../../../types.js';
 export declare function isRotateOperationParams(obj: unknown): Outcome.Either<RotateOperationParams, string>;
-export declare function rotate(sharpInstance: sharp.Sharp, params: RotateOperationParams): Promise<sharp.Sharp>;
+export declare function rotate(sharpInstance: Sharp, params: RotateOperationParams): Promise<Sharp>;

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

@@ -12,6 +12,7 @@ export function isRotateOperationParams(obj) {
         return Outcome.makeFailure(result.error.message);
     return Outcome.makeSuccess(result.data);
 }
+// eslint-disable-next-line @typescript-eslint/require-await
 export async function rotate(sharpInstance, params) {
     return sharpInstance.rotate(params.angleDeg, {
         background: params.background !== undefined

package/node/images/transform/operations/saturate/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 { SaturateOperationParams } from '../../../types.js';
 export declare function isSaturateOperationParams(obj: unknown): Outcome.Either<SaturateOperationParams, string>;
-export declare function saturate(sharpInstance: sharp.Sharp, params: SaturateOperationParams): Promise<sharp.Sharp>;
+export declare function saturate(sharpInstance: Sharp, params: SaturateOperationParams): Promise<Sharp>;

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

@@ -9,6 +9,7 @@ export function isSaturateOperationParams(obj) {
         return Outcome.makeFailure(result.error.message);
     return Outcome.makeSuccess(result.data);
 }
+// eslint-disable-next-line @typescript-eslint/require-await
 export async function saturate(sharpInstance, params) {
     return sharpInstance.modulate({
         saturation: params.saturation

package/node/images/types.d.ts

@@ -2,6 +2,7 @@ import type { Sharp } from 'sharp';
 import type { Color } from '../../agnostic/colors/types.js';
 /** Union type representing any valid image input. */
 export type ImageLike = Sharp | Buffer | CreateOptions | string;
+/** Options for creating a new blank image. */
 export type CreateOptions = {
     /** Image width in pixels. */
     width?: number;
@@ -21,6 +22,7 @@ export type CreateOptions = {
     /** Page height for multi-page images. */
     pageHeight?: number;
 };
+/** Common resizing options shared across all output format types. */
 export type FormatCommonOptions = {
     /** Target width in pixels. */
     width?: number;
@@ -41,6 +43,7 @@ export type FormatCommonOptions = {
     /** If `true`, use fast shrink-on-load for JPEG images. */
     fastShrinkOnLoad?: boolean;
 };
+/** Encoding options for JPEG output. */
 export type FormatJpgOptions = FormatCommonOptions & {
     /** Format type identifier. */
     type: 'jpg' | 'jpeg';
@@ -65,6 +68,7 @@ export type FormatJpgOptions = FormatCommonOptions & {
     /** Use mozjpeg encoder. */
     mozjpeg?: boolean;
 };
+/** Encoding options for PNG output. */
 export type FormatPngOptions = FormatCommonOptions & {
     /** Format type identifier. */
     type: 'png';
@@ -87,6 +91,7 @@ export type FormatPngOptions = FormatCommonOptions & {
     /** Dither level (0-1). */
     dither?: number;
 };
+/** Encoding options for WebP output. */
 export type FormatWebpOptions = FormatCommonOptions & {
     /** Format type identifier. */
     type: 'webp';
@@ -117,6 +122,7 @@ export type FormatWebpOptions = FormatCommonOptions & {
     /** Animation frame delays. */
     delay?: number | number[];
 };
+/** Encoding options for AVIF output. */
 export type FormatAvifOptions = FormatCommonOptions & {
     /** Format type identifier. */
     type: 'avif';
@@ -133,6 +139,7 @@ export type FormatAvifOptions = FormatCommonOptions & {
     /** Bit depth (8, 10, or 12 bits). */
     bitdepth?: 8 | 10 | 12;
 };
+/** Encoding options for TIFF output. */
 export type FormatTiffOptions = FormatCommonOptions & {
     /** Format type identifier. */
     type: 'tiff';
@@ -156,13 +163,14 @@ export type FormatTiffOptions = FormatCommonOptions & {
     xres?: number;
     /** Vertical resolution. */
     yres?: number;
-    /** Bit depth (1, 2, 4, or 8 bits). */
-    bitdepth?: 1 | 2 | 4 | 8;
+    /** Bit depth (1, 2, or 4 bits). */
+    bitdepth?: 1 | 2 | 4;
     /** If `true`, minimum value is white. */
     miniswhite?: boolean;
     /** Resolution unit. */
     resolutionUnit?: 'inch' | 'cm';
 };
+/** Encoding options for HEIF/HEIC output. */
 export type FormatHeifOptions = FormatCommonOptions & {
     /** Format type identifier. */
     type: 'heif';
@@ -201,14 +209,17 @@ export declare enum OpName {
     ROTATE = "rotate",
     SATURATE = "saturate"
 }
+/** Parameters for the blur operation. */
 export type BlurOperationParams = {
     /** Blur sigma value (standard deviation). */
     sigma: number;
 };
+/** Parameters for the brighten operation. */
 export type BrightenOperationParams = {
     /** Brightness factor. */
     factor: number;
 };
+/** Parameters for the extend operation (add pixels around the image). */
 export type ExtendOperationParams = {
     /** Pixels to extend on the left side. */
     left?: number;
@@ -223,6 +234,7 @@ export type ExtendOperationParams = {
     /** Background color for extension. */
     background?: Color;
 };
+/** Parameters for the extract operation (crop a region). */
 export type ExtractOperationParams = {
     /** Left coordinate of the extraction region. */
     left: number;
@@ -233,30 +245,36 @@ export type ExtractOperationParams = {
     /** Height of the extraction region. */
     height: number;
 };
+/** Parameters for the flatten operation (merge alpha channel onto a background). */
 export type FlattenOperationParams = {
     /** Background color for flattening. */
     background?: Color;
 };
+/** Parameters for the hue rotation operation. */
 export type HueOperationParams = {
     /** Hue rotation in degrees. */
     rotateDeg?: number;
 };
+/** Parameters for the level adjustment operation. */
 export type LevelOperationParams = {
     /** Multiplier for level adjustment. */
     multiplier?: number;
     /** Offset for level adjustment. */
     offset?: number;
 };
+/** Parameters for the lighten operation. */
 export type LightenOperationParams = {
     /** Lightening amount. */
     amount?: number;
 };
+/** Parameters for the normalize operation (stretch contrast to fill the output range). */
 export type NormalizeOperationParams = {
     /** Lower bound for normalization. */
     lower?: number;
     /** Upper bound for normalization. */
     upper?: number;
 };
+/** Parameters for the overlay (composite) operation. */
 export type OverlayOperationParams = {
     /** Image to overlay. */
     input: ImageLike;
@@ -285,6 +303,7 @@ export type OverlayOperationParams = {
     /** Gravity for positioning the overlay. */
     gravity?: 'north' | 'northeast' | 'southeast' | 'south' | 'southwest' | 'west' | 'northwest' | 'east' | 'center' | 'centre';
 };
+/** Parameters for the resize operation. */
 export type ResizeOperationParams = {
     /** Target width in pixels. */
     width?: number;
@@ -305,62 +324,81 @@ export type ResizeOperationParams = {
     /** If `true`, use fast shrink-on-load for JPEG images. */
     fastShrinkOnLoad?: boolean;
 };
+/** Parameters for the rotate operation. */
 export type RotateOperationParams = {
     /** Rotation angle in degrees. */
     angleDeg?: number;
     /** Background color for areas revealed by rotation. */
     background?: Color;
 };
+/** Parameters for the saturation adjustment operation. */
 export type SaturateOperationParams = {
     /** Saturation level. */
     saturation?: number;
 };
+/** Discriminated union descriptor for the blur operation. */
 export type BlurOperationDescriptor = {
     name: OpName.BLUR;
 } & BlurOperationParams;
+/** Discriminated union descriptor for the brighten operation. */
 export type BrightenOperationDescriptor = {
     name: OpName.BRIGHTEN;
 } & BrightenOperationParams;
+/** Discriminated union descriptor for the extend operation. */
 export type ExtendOperationDescriptor = {
     name: OpName.EXTEND;
 } & ExtendOperationParams;
+/** Discriminated union descriptor for the extract operation. */
 export type ExtractOperationDescriptor = {
     name: OpName.EXTRACT;
 } & ExtractOperationParams;
+/** Discriminated union descriptor for the flatten operation. */
 export type FlattenOperationDescriptor = {
     name: OpName.FLATTEN;
 } & FlattenOperationParams;
+/** Discriminated union descriptor for the flip operation (vertical axis). */
 export type FlipOperationDescriptor = {
     name: OpName.FLIP;
 };
+/** Discriminated union descriptor for the flop operation (horizontal axis). */
 export type FlopOperationDescriptor = {
     name: OpName.FLOP;
 };
+/** Discriminated union descriptor for the hue rotation operation. */
 export type HueOperationDescriptor = {
     name: OpName.HUE;
 } & HueOperationParams;
+/** Discriminated union descriptor for the level adjustment operation. */
 export type LevelOperationDescriptor = {
     name: OpName.LEVEL;
 } & LevelOperationParams;
+/** Discriminated union descriptor for the lighten operation. */
 export type LightenOperationDescriptor = {
     name: OpName.LIGHTEN;
 } & LightenOperationParams;
+/** Discriminated union descriptor for the normalize operation. */
 export type NormalizeOperationDescriptor = {
     name: OpName.NORMALIZE;
 } & NormalizeOperationParams;
+/** Discriminated union descriptor for the overlay operation. */
 export type OverlayOperationDescriptor = {
     name: OpName.OVERLAY;
 } & OverlayOperationParams;
+/** Discriminated union descriptor for the resize operation. */
 export type ResizeOperationDescriptor = {
     name: OpName.RESIZE;
 } & ResizeOperationParams;
+/** Discriminated union descriptor for the rotate operation. */
 export type RotateOperationDescriptor = {
     name: OpName.ROTATE;
 } & RotateOperationParams;
+/** Discriminated union descriptor for the saturation adjustment operation. */
 export type SaturateOperationDescriptor = {
     name: OpName.SATURATE;
 } & SaturateOperationParams;
+/** Union of all supported image transformation operation descriptors. */
 export type OperationDescriptor = BlurOperationDescriptor | BrightenOperationDescriptor | ExtendOperationDescriptor | ExtractOperationDescriptor | FlattenOperationDescriptor | FlipOperationDescriptor | FlopOperationDescriptor | HueOperationDescriptor | LevelOperationDescriptor | LightenOperationDescriptor | NormalizeOperationDescriptor | OverlayOperationDescriptor | ResizeOperationDescriptor | RotateOperationDescriptor | SaturateOperationDescriptor;
+/** Safety limits applied during image transformation. */
 export type TransformLimits = {
     /** Maximum time allowed for the entire transformation process in milliseconds. */
     timeoutMs?: number;
@@ -379,6 +417,7 @@ export declare enum TransformErrCodes {
     HEIGHT_LIMIT_EXCEEDED = "height-limit-exceeded",
     UNKNOWN_ERROR = "unknown-error"
 }
+/** Error descriptor returned when an image transformation fails. */
 export type TransformErr = {
     /** Error code indicating the type of error. */
     code: TransformErrCodes;

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

@@ -1,8 +1,13 @@
-import sharp from 'sharp';
+import type { Sharp, SharpOptions } from 'sharp';
 import type { Color } from '../../../agnostic/colors/types.js';
 import type { CreateOptions, ImageLike } from '../types.js';
 /** Converts a Color to Sharp RGBA format. */
-export declare function toSharpColor(color: Color): sharp.RGBA;
+export declare function toSharpColor(color: Color): {
+    r: number;
+    g: number;
+    b: number;
+    alpha?: number;
+};
 /**
  * Type guard to check if an object is a duck-typed Sharp instance.
  *
@@ -11,9 +16,9 @@ export declare function toSharpColor(color: Color): sharp.RGBA;
  * @param obj - The object to check.
  * @returns `true` if the object appears to be a Sharp instance, `false` otherwise.
  */
-export declare function isDuckTypedSharpInstance(obj: unknown): obj is sharp.Sharp;
+export declare function isDuckTypedSharpInstance(obj: unknown): obj is Sharp;
 /** Converts CreateOptions to Sharp create options with defaults applied. */
-export declare function toCreateOptions(options: CreateOptions): sharp.SharpOptions['create'];
+export declare function toCreateOptions(options: CreateOptions): SharpOptions['create'];
 /**
  * Converts an ImageLike input to a Sharp instance.
  *
@@ -24,4 +29,4 @@ export declare function toCreateOptions(options: CreateOptions): sharp.SharpOpti
  * @param [clone=false] - If `true` and input is a Sharp instance, returns a cloned instance.
  * @returns A Sharp instance ready for image operations.
  */
-export declare function toSharpInstance(imageLike: ImageLike, clone?: boolean): Promise<sharp.Sharp>;
+export declare function toSharpInstance(imageLike: ImageLike, clone?: boolean): Promise<Sharp>;

package/node/index.d.ts

@@ -1,5 +1,5 @@
-export * as designEdito from './@design-edito/index.js'
 export * as awsS3 from './@aws-s3/index.js'
+export * as designEdito from './@design-edito/index.js'
 export * as express from './@express/index.js'
 export * as googleCloud from './@google-cloud/index.js'
 export * as cloudStorage from './cloud-storage/index.js'

package/node/index.js

@@ -1,5 +1,5 @@
-export * as designEdito from './@design-edito/index.js'
 export * as awsS3 from './@aws-s3/index.js'
+export * as designEdito from './@design-edito/index.js'
 export * as express from './@express/index.js'
 export * as googleCloud from './@google-cloud/index.js'
 export * as cloudStorage from './cloud-storage/index.js'

package/node/process/on-exit/index.js

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/strict-void-return, @typescript-eslint/no-misused-promises */
 /** Events that trigger a forced exit of the process. */
 export const forceExitEvents = ['SIGINT', 'SIGTERM', 'uncaughtException'];
 /**
@@ -6,7 +7,6 @@ export const forceExitEvents = ['SIGINT', 'SIGTERM', 'uncaughtException'];
  * @param callback - Function to execute before forced exit. Can be async.
  */
 export function beforeForcedExit(callback) {
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
     forceExitEvents.forEach(ev => process.on(ev, callback));
 }
 /**
@@ -15,7 +15,6 @@ export function beforeForcedExit(callback) {
  * @param callback - Function to execute before exit. Can be async.
  */
 export function beforeExit(callback) {
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
     process.on('beforeExit', callback);
 }
 /**
@@ -24,7 +23,6 @@ export function beforeExit(callback) {
  * @param callback - Function to execute on exit. Can be async.
  */
 export function onExit(callback) {
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
     process.on('exit', callback);
 }
 /**
@@ -39,7 +37,7 @@ export function onAllExits(callback) {
     const actualCallback = () => {
         if (!alreadyCalled) {
             alreadyCalled = true;
-            // eslint-disable-next-line @typescript-eslint/no-misused-promises, @typescript-eslint/no-floating-promises
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises
             callback();
         }
     };

package/node/process/prompt-continue/index.d.ts

@@ -1,9 +1,9 @@
 /**
  * Prompts the user with a yes/no confirmation in the terminal.
  *
- * @param {string} [message] - The message to display in the prompt. Defaults to "Continue?" if not provided.
- * @param {boolean} [throws=false] - If true, the function will throw an error when the user declines.
- * @returns {Promise<boolean>} - Resolves to `true` if the user confirms, `false` if the user declines and `throws` is false.
+ * @param [message] - The message to display in the prompt. Defaults to "Continue?" if not provided.
+ * @param [throws=false] - If true, the function will throw an error when the user declines.
+ * @returns - Resolves to `true` if the user confirms, `false` if the user declines and `throws` is false.
  *
  * @throws {Error} - Throws an error with message 'Aborted' if the user declines and `throws` is true.
  *

package/node/process/prompt-continue/index.js

@@ -2,9 +2,9 @@ import * as inquirer from '@inquirer/prompts';
 /**
  * Prompts the user with a yes/no confirmation in the terminal.
  *
- * @param {string} [message] - The message to display in the prompt. Defaults to "Continue?" if not provided.
- * @param {boolean} [throws=false] - If true, the function will throw an error when the user declines.
- * @returns {Promise<boolean>} - Resolves to `true` if the user confirms, `false` if the user declines and `throws` is false.
+ * @param [message] - The message to display in the prompt. Defaults to "Continue?" if not provided.
+ * @param [throws=false] - If true, the function will throw an error when the user declines.
+ * @returns - Resolves to `true` if the user confirms, `false` if the user declines and `throws` is false.
  *
  * @throws {Error} - Throws an error with message 'Aborted' if the user declines and `throws` is true.
  *
@@ -17,6 +17,7 @@ import * as inquirer from '@inquirer/prompts';
  * }
  */
 export async function promptContinue(message, throws = false) {
+    // eslint-disable-next-line no-console
     console.log('');
     const answer = await inquirer.confirm({
         message: message ?? 'Continue?',

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/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