@design-edito/tools 0.4.23 → 0.5.1

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

@@ -1,5 +1,5 @@
-import { type Bucket as GCSBucket } from '@google-cloud/storage';
-import { type Client as FtpClient } from 'basic-ftp';
+import type { Bucket as GCSBucket } from '@google-cloud/storage';
+import type { Client as FtpClient } from 'basic-ftp';
 import type SftpClient from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 import { type S3ClientWithBucket } from '../../clients/index.js';
@@ -12,11 +12,11 @@ type Returned = Outcome.Either<true, string>;
 /**
  * Moves a file from one path to another using a Google Cloud Storage bucket.
  *
- * @param {GCSBucket} client               - The Google Cloud Storage bucket instance.
- * @param {string}   sourcePath           - The source file path to move from.
- * @param {string}   targetPath           - The target file path to move to.
- * @param {GcsMoveOptions} [options]       - Optional move configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client               - The Google Cloud Storage bucket instance.
+ * @param   sourcePath           - The source file path to move from.
+ * @param   targetPath           - The target file path to move to.
+ * @param [options]       - Optional move configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -24,11 +24,11 @@ export declare function moveFile(client: GCSBucket, sourcePath: string, targetPa
 /**
  * Moves a file from one path to another using an S3 client.
  *
- * @param {S3ClientWithBucket} client      - The S3 client with bucket configuration.
- * @param {string}   sourcePath           - The source file path to move from.
- * @param {string}   targetPath           - The target file path to move to.
- * @param {S3MoveOptions} [options]        - Optional move configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client      - The S3 client with bucket configuration.
+ * @param   sourcePath           - The source file path to move from.
+ * @param   targetPath           - The target file path to move to.
+ * @param [options]        - Optional move configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -36,11 +36,11 @@ export declare function moveFile(client: S3ClientWithBucket, sourcePath: string,
 /**
  * Moves a file from one path to another using an FTP client.
  *
- * @param {FtpClient} client               - The FTP client instance.
- * @param {string}   sourcePath           - The source file path to move from.
- * @param {string}   targetPath           - The target file path to move to.
- * @param {FtpsMoveOptions} [options]      - Optional move configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client               - The FTP client instance.
+ * @param   sourcePath           - The source file path to move from.
+ * @param   targetPath           - The target file path to move to.
+ * @param [options]      - Optional move configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */
@@ -48,11 +48,11 @@ export declare function moveFile(client: FtpClient, sourcePath: string, targetPa
 /**
  * Moves a file from one path to another using an SFTP client.
  *
- * @param {SftpClient} client              - The SFTP client instance.
- * @param {string}   sourcePath           - The source file path to move from.
- * @param {string}   targetPath           - The target file path to move to.
- * @param {SftpMoveOptions} [options]      - Optional move configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client              - The SFTP client instance.
+ * @param   sourcePath           - The source file path to move from.
+ * @param   targetPath           - The target file path to move to.
+ * @param [options]      - Optional move configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

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

@@ -10,11 +10,11 @@ import { move as gcsMove } from '../../../@google-cloud/storage/file/move/index.
  * The function automatically dispatches to the appropriate implementation based on
  * the client type (Google Cloud Storage, S3, FTP, or SFTP).
  *
- * @param {AnyClient} client               - The cloud storage client instance.
- * @param {string}   sourcePath           - The source file path to move from.
- * @param {string}   targetPath           - The target file path to move to.
- * @param {GcsMoveOptions | S3MoveOptions | FtpsMoveOptions | SftpMoveOptions} [options] - Optional move configuration.
- * @returns {Promise<Outcome.Either<true, string>>}
+ * @param client               - The cloud storage client instance.
+ * @param   sourcePath           - The source file path to move from.
+ * @param   targetPath           - The target file path to move to.
+ * @param [options] - Optional move configuration.
+ * @returns
  * - On success:  `Outcome.makeSuccess(true)`.
  * - On failure:  `Outcome.makeFailure(errStr)`.
  */

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

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

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 ?? {};