@design-edito/tools 0.4.23 → 0.5.0

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

@@ -10,10 +10,10 @@ import { removeDir as gcsRemoveDir } from '../../../@google-cloud/storage/direct
  * The function automatically dispatches to the appropriate implementation based on
  * the client type (Google Cloud Storage, S3, FTP, or SFTP).
  *
- * @param {AnyClient} client               - The cloud storage client instance.
- * @param {string}   sourcePath           - The directory path to remove.
- * @param {GcsRemoveDirOptions | S3RemoveDirOptions | FtpsRemoveDirOptions | SftpRemoveDirOptions} [options] - Optional remove configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client               - The cloud storage client instance.
+ * @param   sourcePath           - The directory path to remove.
+ * @param [options] - Optional remove configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

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

@@ -1,5 +1,5 @@
-import { type Bucket as GCSBucket } from '@google-cloud/storage';
-import { type Client as FtpClient } from 'basic-ftp';
+import type { Bucket as GCSBucket } from '@google-cloud/storage';
+import type { Client as FtpClient } from 'basic-ftp';
 import type SftpClient from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 import { type S3ClientWithBucket } from '../../clients/index.js';
@@ -12,10 +12,10 @@ type Returned = Outcome.Either<true, string>;
 /**
  * Removes a file from a Google Cloud Storage bucket.
  *
- * @param {GCSBucket} client               - The Google Cloud Storage bucket instance.
- * @param {string}   path                 - The file path to remove.
- * @param {GcsRemoveOptions} [options]     - Optional remove configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client               - The Google Cloud Storage bucket instance.
+ * @param   path                 - The file path to remove.
+ * @param [options]     - Optional remove configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -23,10 +23,10 @@ export declare function removeFile(client: GCSBucket, path: string, options?: Gc
 /**
  * Removes a file from an S3 bucket.
  *
- * @param {S3ClientWithBucket} client      - The S3 client with bucket configuration.
- * @param {string}   path                 - The file path to remove.
- * @param {S3RemoveOptions} [options]      - Optional remove configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client      - The S3 client with bucket configuration.
+ * @param   path                 - The file path to remove.
+ * @param [options]      - Optional remove configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -34,10 +34,10 @@ export declare function removeFile(client: S3ClientWithBucket, path: string, opt
 /**
  * Removes a file from an FTP server.
  *
- * @param {FtpClient} client               - The FTP client instance.
- * @param {string}   path                 - The file path to remove.
- * @param {FtpRemoveOptions} [options]     - Optional remove configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client               - The FTP client instance.
+ * @param   path                 - The file path to remove.
+ * @param [options]     - Optional remove configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -45,10 +45,10 @@ export declare function removeFile(client: FtpClient, path: string, options?: Ft
 /**
  * Removes a file from an SFTP server.
  *
- * @param {SftpClient} client              - The SFTP client instance.
- * @param {string}   path                 - The file path to remove.
- * @param {SftpRemoveOptions} [options]    - Optional remove configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client              - The SFTP client instance.
+ * @param   path                 - The file path to remove.
+ * @param [options]    - Optional remove configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

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

@@ -10,10 +10,10 @@ import { remove as gcsRemove } from '../../../@google-cloud/storage/file/remove/
  * The function automatically dispatches to the appropriate implementation based on
  * the client type (Google Cloud Storage, S3, FTP, or SFTP).
  *
- * @param {AnyClient} client               - The cloud storage client instance.
- * @param {string}   path                 - The file path to remove.
- * @param {GcsRemoveOptions | S3RemoveOptions | FtpRemoveOptions | SftpRemoveOptions} [options] - Optional remove configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client               - The cloud storage client instance.
+ * @param   path                 - The file path to remove.
+ * @param [options] - Optional remove configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

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

@@ -1,5 +1,5 @@
-import { type Bucket as GCSBucket } from '@google-cloud/storage';
-import { type Client as FtpClient } from 'basic-ftp';
+import type { Bucket as GCSBucket } from '@google-cloud/storage';
+import type { Client as FtpClient } from 'basic-ftp';
 import type SftpClient from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 import { type S3ClientWithBucket } from '../../clients/index.js';
@@ -12,10 +12,10 @@ type Returned<K extends FtpStat | SftpStat | S3Stat | GcsStat> = Outcome.Either<
 /**
  * Retrieves metadata for a file in a Google Cloud Storage bucket.
  *
- * @param {GCSBucket} client              - The Google Cloud Storage bucket instance.
- * @param {string}   path                 - The file path to stat.
- * @param {GcsStatOptions} [options]       - Optional stat configuration.
- * @returns {Promise<Outcome.Either<GcsStat, string>>}
+ * @param client              - The Google Cloud Storage bucket instance.
+ * @param   path                 - The file path to stat.
+ * @param [options]       - Optional stat configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(stat)` containing file metadata.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -23,10 +23,10 @@ export declare function statFile(client: GCSBucket, path: string, options?: GcsS
 /**
  * Retrieves metadata for a file in an S3 bucket.
  *
- * @param {S3ClientWithBucket} client      - The S3 client with bucket configuration.
- * @param {string}   path                 - The file path to stat.
- * @param {S3StatOptions} [options]        - Optional stat configuration.
- * @returns {Promise<Outcome.Either<S3Stat, string>>}
+ * @param client      - The S3 client with bucket configuration.
+ * @param   path                 - The file path to stat.
+ * @param [options]        - Optional stat configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(stat)` containing file metadata.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -34,9 +34,9 @@ export declare function statFile(client: S3ClientWithBucket, path: string, optio
 /**
  * Retrieves metadata for a file on an FTP server.
  *
- * @param {FtpClient} client              - The FTP client instance.
- * @param {string}   path                 - The file path to stat.
- * @returns {Promise<Outcome.Either<FtpStat, string>>}
+ * @param client              - The FTP client instance.
+ * @param   path                 - The file path to stat.
+ * @returns
  * - On success:  `Outcome.makeSuccess(stat)` containing file metadata.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -44,9 +44,9 @@ export declare function statFile(client: FtpClient, path: string): Promise<Retur
 /**
  * Retrieves metadata for a file on an SFTP server.
  *
- * @param {SftpClient} client             - The SFTP client instance.
- * @param {string}   path                 - The file path to stat.
- * @returns {Promise<Outcome.Either<SftpStat, string>>}
+ * @param client             - The SFTP client instance.
+ * @param   path                 - The file path to stat.
+ * @returns
  * - On success:  `Outcome.makeSuccess(stat)` containing file metadata.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

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

@@ -10,10 +10,10 @@ import { stat as gcsStat } from '../../../@google-cloud/storage/file/stat/index.
  * The function automatically dispatches to the appropriate implementation based on
  * the client type (Google Cloud Storage, S3, FTP, or SFTP).
  *
- * @param {AnyClient} client              - The cloud storage client instance.
- * @param {string}   path                 - The file path to stat.
- * @param {GcsStatOptions | S3StatOptions} [options] - Optional stat configuration.
- * @returns {Promise<Outcome.Either<GcsStat | S3Stat | FtpStat | SftpStat, string>>}
+ * @param client              - The cloud storage client instance.
+ * @param   path                 - The file path to stat.
+ * @param [options] - Optional stat configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(stat)` containing file metadata.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

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

@@ -1,6 +1,6 @@
-import { type Readable } from 'node:stream';
-import { type Bucket as GCSBucket } from '@google-cloud/storage';
-import { type Client as FtpClient } from 'basic-ftp';
+import type { Readable } from 'node:stream';
+import type { Bucket as GCSBucket } from '@google-cloud/storage';
+import type { Client as FtpClient } from 'basic-ftp';
 import type SftpClient from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 import { type S3ClientWithBucket } from '../../clients/index.js';
@@ -13,11 +13,11 @@ type Returned = Outcome.Either<true, string>;
 /**
  * Uploads a file stream to a Google Cloud Storage bucket.
  *
- * @param {Readable} fileStream           - The file content as a stream.
- * @param {string}   path                 - The path to upload the file to.
- * @param {GCSBucket} client              - The Google Cloud Storage bucket instance.
- * @param {GcsUploadOptions} [options]     - Optional upload configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param fileStream           - The file content as a stream.
+ * @param   path                 - The path to upload the file to.
+ * @param client              - The Google Cloud Storage bucket instance.
+ * @param [options]     - Optional upload configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -25,11 +25,11 @@ export declare function uploadFile(fileStream: Readable, path: string, client: G
 /**
  * Uploads a file stream to an S3 bucket.
  *
- * @param {Readable} fileStream           - The file content as a stream.
- * @param {string}   path                 - The path to upload the file to.
- * @param {S3ClientWithBucket} client     - The S3 client with bucket configuration.
- * @param {S3UploadOptions} [options]      - Optional upload configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param fileStream           - The file content as a stream.
+ * @param   path                 - The path to upload the file to.
+ * @param client     - The S3 client with bucket configuration.
+ * @param [options]      - Optional upload configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -37,11 +37,11 @@ export declare function uploadFile(fileStream: Readable, path: string, client: S
 /**
  * Uploads a file stream to an FTP server.
  *
- * @param {Readable} fileStream           - The file content as a stream.
- * @param {string}   path                 - The path to upload the file to.
- * @param {FtpClient} client              - The FTP client instance.
- * @param {FtpUploadOptions} [options]     - Optional upload configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param fileStream           - The file content as a stream.
+ * @param   path                 - The path to upload the file to.
+ * @param client              - The FTP client instance.
+ * @param [options]     - Optional upload configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -49,11 +49,11 @@ export declare function uploadFile(fileStream: Readable, path: string, client: F
 /**
  * Uploads a file stream to an SFTP server.
  *
- * @param {Readable} fileStream           - The file content as a stream.
- * @param {string}   path                 - The path to upload the file to.
- * @param {SftpClient} client             - The SFTP client instance.
- * @param {SftpUploadOptions} [options]   - Optional upload configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param fileStream           - The file content as a stream.
+ * @param   path                 - The path to upload the file to.
+ * @param client             - The SFTP client instance.
+ * @param [options]   - Optional upload configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

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

@@ -10,11 +10,11 @@ import { upload as gcsUpload } from '../../../@google-cloud/storage/file/upload/
  * The function automatically dispatches to the appropriate implementation based on
  * the client type (Google Cloud Storage, S3, FTP, or SFTP).
  *
- * @param {Readable} fileStream           - The file content as a stream.
- * @param {string}   path                 - The path to upload the file to.
- * @param {AnyClient} client              - The cloud storage client instance.
- * @param {GcsUploadOptions | S3UploadOptions | FtpUploadOptions | SftpUploadOptions} [options] - Optional upload configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param fileStream           - The file content as a stream.
+ * @param   path                 - The path to upload the file to.
+ * @param client              - The cloud storage client instance.
+ * @param [options] - Optional upload configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

package/node/encryption/@aes-256-gcm/buffer/index.d.ts

@@ -3,18 +3,18 @@ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 /**
  * Encrypts a `Buffer` by converting it to a `Uint8Array`, performing encryption, and then returning the result as a `Buffer`.
  *
- * @param {Buffer} inputBuffer - The input data to encrypt.
- * @param {string} encryptionKey - The encryption key to use.
+ * @param inputBuffer - The input data to encrypt.
+ * @param encryptionKey - The encryption key to use.
  *
- * @returns {Outcome.Either<Buffer, string>} The result of the encryption. Success returns the encrypted data as a `Buffer` (with IV prepended), or failure returns an error message.
+ * @returns The result of the encryption. Success returns the encrypted data as a `Buffer` (with IV prepended), or failure returns an error message.
  */
 export declare function encrypt(inputBuffer: Buffer, encryptionKey: string): Outcome.Either<Buffer, string>;
 /**
  * Decrypts an encrypted `Buffer` by converting it to a `Uint8Array`, performing decryption, and then returning the result as a `Buffer`.
  *
- * @param {Buffer} encryptedBuffer - The encrypted data to decrypt.
- * @param {string} encryptionKey - The encryption key to use.
+ * @param encryptedBuffer - The encrypted data to decrypt.
+ * @param encryptionKey - The encryption key to use.
  *
- * @returns {Outcome.Either<Buffer, string>} The result of the decryption. Success returns the decrypted data as a `Buffer`, or failure returns an error message.
+ * @returns The result of the decryption. Success returns the decrypted data as a `Buffer`, or failure returns an error message.
  */
 export declare function decrypt(encryptedBuffer: Buffer, encryptionKey: string): Outcome.Either<Buffer, string>;

package/node/encryption/@aes-256-gcm/buffer/index.js

@@ -4,10 +4,10 @@ import { encryptUint8Array, decryptUint8Array } from '../uint8-array/index.js';
 /**
  * Encrypts a `Buffer` by converting it to a `Uint8Array`, performing encryption, and then returning the result as a `Buffer`.
  *
- * @param {Buffer} inputBuffer - The input data to encrypt.
- * @param {string} encryptionKey - The encryption key to use.
+ * @param inputBuffer - The input data to encrypt.
+ * @param encryptionKey - The encryption key to use.
  *
- * @returns {Outcome.Either<Buffer, string>} The result of the encryption. Success returns the encrypted data as a `Buffer` (with IV prepended), or failure returns an error message.
+ * @returns The result of the encryption. Success returns the encrypted data as a `Buffer` (with IV prepended), or failure returns an error message.
  */
 export function encrypt(inputBuffer, encryptionKey) {
     const fileArray = new Uint8Array(inputBuffer);
@@ -19,10 +19,10 @@ export function encrypt(inputBuffer, encryptionKey) {
 /**
  * Decrypts an encrypted `Buffer` by converting it to a `Uint8Array`, performing decryption, and then returning the result as a `Buffer`.
  *
- * @param {Buffer} encryptedBuffer - The encrypted data to decrypt.
- * @param {string} encryptionKey - The encryption key to use.
+ * @param encryptedBuffer - The encrypted data to decrypt.
+ * @param encryptionKey - The encryption key to use.
  *
- * @returns {Outcome.Either<Buffer, string>} The result of the decryption. Success returns the decrypted data as a `Buffer`, or failure returns an error message.
+ * @returns The result of the decryption. Success returns the decrypted data as a `Buffer`, or failure returns an error message.
  */
 export function decrypt(encryptedBuffer, encryptionKey) {
     const encryptedArray = new Uint8Array(encryptedBuffer);

package/node/encryption/@aes-256-gcm/uint8-array/index.d.ts

@@ -2,20 +2,20 @@ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 /**
  * Encrypts a `Uint8Array` using AES-256-GCM encryption and the specified encryption key.
  *
- * @param {Uint8Array} fileArray - The input data to encrypt.
- * @param {string} encryptionKey - The encryption key to use.
- * @param {number} [options.ivLength=16] - The length of the initialization vector (IV). Defaults to 16 bytes.
+ * @param fileArray - The input data to encrypt.
+ * @param encryptionKey - The encryption key to use.
+ * @param [options.ivLength=16] - The length of the initialization vector (IV). Defaults to 16 bytes.
  *
- * @returns {Outcome.Either<Uint8Array, string>} The result of the encryption. Success returns the encrypted data as a `Uint8Array` (with IV prepended), or failure returns an error message.
+ * @returns The result of the encryption. Success returns the encrypted data as a `Uint8Array` (with IV prepended), or failure returns an error message.
  */
 export declare function encryptUint8Array(fileArray: Uint8Array, encryptionKey: string): Outcome.Either<Uint8Array, string>;
 /**
  * Decrypts an encrypted `Uint8Array` using AES-256-GCM encryption and the specified encryption key.
  *
- * @param {Uint8Array} encryptedFile - The encrypted data to decrypt.
- * @param {string} encryptionKey - The encryption key to use.
- * @param {number} [options.ivLength=16] - The length of the initialization vector (IV). Defaults to 16 bytes.
+ * @param encryptedFile - The encrypted data to decrypt.
+ * @param encryptionKey - The encryption key to use.
+ * @param [options.ivLength=16] - The length of the initialization vector (IV). Defaults to 16 bytes.
  *
- * @returns {Outcome.Either<Uint8Array, string>} The result of the decryption. Success returns the decrypted data as a `Uint8Array`, or failure returns an error message.
+ * @returns The result of the decryption. Success returns the decrypted data as a `Uint8Array`, or failure returns an error message.
  */
 export declare function decryptUint8Array(encryptedFile: Uint8Array, encryptionKey: string): Outcome.Either<Uint8Array, string>;

package/node/encryption/@aes-256-gcm/uint8-array/index.js

@@ -5,11 +5,11 @@ import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 /**
  * Encrypts a `Uint8Array` using AES-256-GCM encryption and the specified encryption key.
  *
- * @param {Uint8Array} fileArray - The input data to encrypt.
- * @param {string} encryptionKey - The encryption key to use.
- * @param {number} [options.ivLength=16] - The length of the initialization vector (IV). Defaults to 16 bytes.
+ * @param fileArray - The input data to encrypt.
+ * @param encryptionKey - The encryption key to use.
+ * @param [options.ivLength=16] - The length of the initialization vector (IV). Defaults to 16 bytes.
  *
- * @returns {Outcome.Either<Uint8Array, string>} The result of the encryption. Success returns the encrypted data as a `Uint8Array` (with IV prepended), or failure returns an error message.
+ * @returns The result of the encryption. Success returns the encrypted data as a `Uint8Array` (with IV prepended), or failure returns an error message.
  */
 export function encryptUint8Array(fileArray, encryptionKey) {
     const ivLength = 12;
@@ -31,11 +31,11 @@ export function encryptUint8Array(fileArray, encryptionKey) {
 /**
  * Decrypts an encrypted `Uint8Array` using AES-256-GCM encryption and the specified encryption key.
  *
- * @param {Uint8Array} encryptedFile - The encrypted data to decrypt.
- * @param {string} encryptionKey - The encryption key to use.
- * @param {number} [options.ivLength=16] - The length of the initialization vector (IV). Defaults to 16 bytes.
+ * @param encryptedFile - The encrypted data to decrypt.
+ * @param encryptionKey - The encryption key to use.
+ * @param [options.ivLength=16] - The length of the initialization vector (IV). Defaults to 16 bytes.
  *
- * @returns {Outcome.Either<Uint8Array, string>} The result of the decryption. Success returns the decrypted data as a `Uint8Array`, or failure returns an error message.
+ * @returns The result of the decryption. Success returns the decrypted data as a `Uint8Array`, or failure returns an error message.
  */
 export function decryptUint8Array(encryptedFile, encryptionKey) {
     const ivLength = 12;

package/node/encryption/key/index.d.ts

@@ -5,12 +5,12 @@ export type GenerateOptions = {
 /**
  * Generates an encryption key from a passphrase using PBKDF2.
  *
- * @param {string} passphrase - The passphrase to derive the key from.
- * @param {number} outputByteLength - The length of the output encryption key in bytes.
- * @param {GenerateOptions} [options] - Optional options.
- * @param {number} [options.saltLength=16] - The length of the salt in bytes. Defaults to 16 bytes.
- * @param {number} [options.iterations=100000] - The number of PBKDF2 iterations. Defaults to 100,000 iterations.
+ * @param passphrase - The passphrase to derive the key from.
+ * @param outputByteLength - The length of the output encryption key in bytes.
+ * @param [options] - Optional options.
+ * @param [options.saltLength=16] - The length of the salt in bytes. Defaults to 16 bytes.
+ * @param [options.iterations=100000] - The number of PBKDF2 iterations. Defaults to 100,000 iterations.
  *
- * @returns {string} The derived encryption key and salt, concatenated as a string in the format `salt:encryptionKey`.
+ * @returns The derived encryption key and salt, concatenated as a string in the format `salt:encryptionKey`.
  */
 export declare function generate(passphrase: string, outputByteLength: number, options?: GenerateOptions): string;

package/node/encryption/key/index.js

@@ -2,13 +2,13 @@ import { pbkdf2Sync, randomBytes } from 'node:crypto';
 /**
  * Generates an encryption key from a passphrase using PBKDF2.
  *
- * @param {string} passphrase - The passphrase to derive the key from.
- * @param {number} outputByteLength - The length of the output encryption key in bytes.
- * @param {GenerateOptions} [options] - Optional options.
- * @param {number} [options.saltLength=16] - The length of the salt in bytes. Defaults to 16 bytes.
- * @param {number} [options.iterations=100000] - The number of PBKDF2 iterations. Defaults to 100,000 iterations.
+ * @param passphrase - The passphrase to derive the key from.
+ * @param outputByteLength - The length of the output encryption key in bytes.
+ * @param [options] - Optional options.
+ * @param [options.saltLength=16] - The length of the salt in bytes. Defaults to 16 bytes.
+ * @param [options.iterations=100000] - The number of PBKDF2 iterations. Defaults to 100,000 iterations.
  *
- * @returns {string} The derived encryption key and salt, concatenated as a string in the format `salt:encryptionKey`.
+ * @returns The derived encryption key and salt, concatenated as a string in the format `salt:encryptionKey`.
  */
 export function generate(passphrase, outputByteLength, options) {
     const { saltLength = 16, iterations = 100000 } = options ?? {};

package/node/files/read-write/index.d.ts

@@ -23,14 +23,14 @@ export type Replacements = Record<string, string>;
  * - **Replacements mode**: Pass an object with string replacements.
  * - **Function mode**: Pass a function that transforms the file content.
  *
- * @param {Path} path                    - The path to the file to read and edit.
- * @param {Replacements} editor          - Object mapping strings to replace with their replacements.
- * @param {Options} [opts]               - Optional configuration.
- * @param {Parameters<typeof fs.readFile>[1]} [opts.readOptions]  - Extra `readFile` params.
- * @param {Parameters<typeof fs.writeFile>[2]} [opts.writeOptions] - Extra `writeFile` params.
- * @param {Path} [opts.output]           - Output path (defaults to `path`).
- * @param {boolean} [opts.dryRun=false]  - If `true`, skip writing to disk.
- * @returns {Promise<string>} The edited file content as a string.
+ * @param path                    - The path to the file to read and edit.
+ * @param editor          - Object mapping strings to replace with their replacements.
+ * @param [opts]               - Optional configuration.
+ * @param [opts.readOptions]  - Extra `readFile` params.
+ * @param [opts.writeOptions] - Extra `writeFile` params.
+ * @param [opts.output]           - Output path (defaults to `path`).
+ * @param [opts.dryRun=false]  - If `true`, skip writing to disk.
+ * @returns The edited file content as a string.
  */
 export declare function readWrite(path: Path, editor: Replacements, opts?: Options): Promise<string>;
 /**
@@ -40,14 +40,14 @@ export declare function readWrite(path: Path, editor: Replacements, opts?: Optio
  * - **Replacements mode**: Pass an object with string replacements.
  * - **Function mode**: Pass a function that transforms the file content.
  *
- * @param {Path} path                    - The path to the file to read and edit.
- * @param {EditorFunc<T>} editor         - Function that transforms the file content.
- * @param {Options} [opts]               - Optional configuration.
- * @param {Parameters<typeof fs.readFile>[1]} [opts.readOptions]  - Extra `readFile` params.
- * @param {Parameters<typeof fs.writeFile>[2]} [opts.writeOptions] - Extra `writeFile` params.
- * @param {Path} [opts.output]           - Output path (defaults to `path`).
- * @param {boolean} [opts.dryRun=false]  - If `true`, skip writing to disk.
- * @returns {Promise<T>} The edited file content of type `T`.
+ * @param path                    - The path to the file to read and edit.
+ * @param editor         - Function that transforms the file content.
+ * @param [opts]               - Optional configuration.
+ * @param [opts.readOptions]  - Extra `readFile` params.
+ * @param [opts.writeOptions] - Extra `writeFile` params.
+ * @param [opts.output]           - Output path (defaults to `path`).
+ * @param [opts.dryRun=false]  - If `true`, skip writing to disk.
+ * @returns The edited file content of type `T`.
  */
 export declare function readWrite<T extends WriteFileData>(path: Path, editor: EditorFunc<T>, opts?: Options): Promise<T>;
 export {};

package/node/files/subpaths/index.d.ts

@@ -15,8 +15,8 @@ export declare const defaultListContext: Required<ListContext>;
 /**
  * Fills missing properties in a list context with default values.
  *
- * @param {ListContext} input - The partial list context to fill.
- * @returns {Required<ListContext>} A complete list context with all properties set.
+ * @param input - The partial list context to fill.
+ * @returns A complete list context with all properties set.
  */
 export declare const fillListContext: (input: ListContext) => Required<ListContext>;
 export type ListOptions = {
@@ -36,8 +36,8 @@ export declare const defaultListOptions: Required<ListOptions>;
 /**
  * Fills missing properties in list options with default values.
  *
- * @param {ListOptions} input - The partial list options to fill.
- * @returns {Required<ListOptions>} A complete list options object with all properties set.
+ * @param input - The partial list options to fill.
+ * @returns A complete list options object with all properties set.
  */
 export declare const fillOptions: (input: ListOptions) => Required<ListOptions>;
 /**
@@ -54,10 +54,10 @@ export declare function list(...args: Parameters<typeof listAbsoluteSubpaths>):
 /**
  * Internal function that lists absolute subpaths recursively.
  *
- * @param {string} inputPath              - The directory path to list.
- * @param {ListOptions} [_options]        - Optional configuration.
- * @param {ListContext} [__private_context] - Internal recursion context.
- * @returns {Promise<string[]>} Array of absolute subpaths.
+ * @param inputPath              - The directory path to list.
+ * @param [_options]        - Optional configuration.
+ * @param [__private_context] - Internal recursion context.
+ * @returns Array of absolute subpaths.
  */
 declare function listAbsoluteSubpaths(inputPath: string, _options?: ListOptions, __private_context?: ListContext): Promise<string[]>;
 export {};

package/node/files/subpaths/index.js

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-throw-literal */
 import { promises as fs } from 'node:fs';
 import path from 'node:path';
 import { matchesSome as stringMatchesSome } from '../../../agnostic/strings/matches/index.js';
@@ -10,8 +9,8 @@ export const defaultListContext = {
 /**
  * Fills missing properties in a list context with default values.
  *
- * @param {ListContext} input - The partial list context to fill.
- * @returns {Required<ListContext>} A complete list context with all properties set.
+ * @param input - The partial list context to fill.
+ * @returns A complete list context with all properties set.
  */
 export const fillListContext = (input) => {
     return {
@@ -35,8 +34,8 @@ export const defaultListOptions = {
 /**
  * Fills missing properties in list options with default values.
  *
- * @param {ListOptions} input - The partial list options to fill.
- * @returns {Required<ListOptions>} A complete list options object with all properties set.
+ * @param input - The partial list options to fill.
+ * @returns A complete list options object with all properties set.
  */
 export const fillOptions = (input) => {
     return {
@@ -65,10 +64,10 @@ export async function list(...args) {
 /**
  * Internal function that lists absolute subpaths recursively.
  *
- * @param {string} inputPath              - The directory path to list.
- * @param {ListOptions} [_options]        - Optional configuration.
- * @param {ListContext} [__private_context] - Internal recursion context.
- * @returns {Promise<string[]>} Array of absolute subpaths.
+ * @param inputPath              - The directory path to list.
+ * @param [_options]        - Optional configuration.
+ * @param [__private_context] - Internal recursion context.
+ * @returns Array of absolute subpaths.
  */
 async function listAbsoluteSubpaths(inputPath, _options = {}, 
 // eslint-disable-next-line @typescript-eslint/naming-convention
@@ -76,9 +75,7 @@ __private_context = {}) {
     const options = fillOptions(_options);
     // eslint-disable-next-line @typescript-eslint/naming-convention
     const _private_context = fillListContext(__private_context);
-    if (_private_context.rootPath === null) {
-        _private_context.rootPath = inputPath;
-    }
+    _private_context.rootPath ??= inputPath;
     const subpaths = [];
     if (_private_context.depth > options.maxDepth)
         return subpaths;
@@ -132,6 +129,7 @@ __private_context = {}) {
                 }
             }
             else {
+                // eslint-disable-next-line no-lonely-if
                 if (isDirectory) {
                     const childSubpaths = await listAbsoluteSubpaths(childAbsPath, options, {
                         ..._private_context,
@@ -147,7 +145,7 @@ __private_context = {}) {
         }
         catch (err) {
             if (typeof err !== 'boolean')
-                throw new Error('This try/catch block should only throw booleans');
+                throw new Error('This try/catch block should only throw booleans', { cause: err });
             const shouldDiveDeeper = err;
             if (!shouldDiveDeeper)
                 return [];

package/node/ftps/directory/copy-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 CopyDirOptions = {
     /**
@@ -17,11 +17,11 @@ export type CopyDirOptions = {
  * 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.
  */