@design-edito/tools 0.1.51 → 0.1.53

package/node/@google-cloud/storage/file/download/index.d.ts

@@ -0,0 +1,20 @@
+import { Bucket, FileOptions, DownloadOptions as GCSFileDownloadOptions } from '@google-cloud/storage';
+import { Outcome } from '~/agnostic/misc/outcome';
+export type DownloadOptions = {
+    fileOptions?: FileOptions;
+    downloadOptions?: GCSFileDownloadOptions;
+};
+/**
+ * Downloads a file from a specified Google Cloud Storage bucket.
+ *
+ * This function downloads a file from the given bucket and path, returning the file content as a `Buffer`.
+ * The download process can be customized using optional `fileOptions` and `downloadOptions`.
+ *
+ * @param {string} sourcePath - The path of the file to be downloaded in the bucket.
+ * @param {Bucket} bucket - The Google Cloud Storage bucket object from which to download the file.
+ * @param {DownloadOptions} [options] - Optional configuration options for the download.
+ * @returns {Promise<Outcome.Either<Buffer, string>>} A promise that resolves to an `Outcome.Either`.
+ * - On success: `Outcome.makeSuccess(buffer)` containing the downloaded file's content as a `Buffer`.
+ * - On failure: `Outcome.makeFailure(errStr)` with an error message if the download fails.
+ */
+export declare function download(sourcePath: string, bucket: Bucket, options?: DownloadOptions): Promise<Outcome.Either<Buffer, string>>;

package/node/@google-cloud/storage/file/download/index.js

@@ -0,0 +1,9 @@
+import {
+  download
+} from "../../../../../chunks/chunk-LAA2DQDK.js";
+import "../../../../../chunks/chunk-JMU5PDBD.js";
+import "../../../../../chunks/chunk-FENXVJYO.js";
+import "../../../../../chunks/chunk-XCBH6NLF.js";
+export {
+  download
+};

package/node/@google-cloud/storage/file/erase/index.d.ts

@@ -0,0 +1,20 @@
+import { Bucket, FileOptions, DeleteFileOptions as GCSDeleteFileOptions } from '@google-cloud/storage';
+import { Outcome } from '~/agnostic/misc/outcome';
+export type EraseOptions = {
+    fileOptions?: FileOptions;
+    deleteOptions?: GCSDeleteFileOptions;
+};
+/**
+ * Erases a file from a specified Google Cloud Storage bucket.
+ *
+ * This function erases the file located at `sourcePath` in the given bucket.
+ * It can be customized using optional `fileOptions` and `eraseOptions` to modify how the file is erased.
+ *
+ * @param {string} sourcePath - The path of the file to be erased in the bucket.
+ * @param {Bucket} bucket - The Google Cloud Storage bucket object from which to erase the file.
+ * @param {EraseOptions} [options] - Optional configuration options for the file deletion.
+ * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`.
+ * - On success: `Outcome.makeSuccess(true)` indicating the file was successfully erased.
+ * - On failure: `Outcome.makeFailure(errStr)` with an error message if the erase operation fails.
+ */
+export declare function erase(sourcePath: string, bucket: Bucket, options?: EraseOptions): Promise<Outcome.Either<true, string>>;

package/node/@google-cloud/storage/file/erase/index.js

@@ -0,0 +1,9 @@
+import {
+  erase
+} from "../../../../../chunks/chunk-FG53JEP2.js";
+import "../../../../../chunks/chunk-JMU5PDBD.js";
+import "../../../../../chunks/chunk-FENXVJYO.js";
+import "../../../../../chunks/chunk-XCBH6NLF.js";
+export {
+  erase
+};

package/node/@google-cloud/storage/file/exists/index.d.ts

@@ -0,0 +1,19 @@
+import { Bucket, FileOptions, FileExistsOptions as GCSFileExistsOptions } from '@google-cloud/storage';
+import { Outcome } from '~/agnostic/misc/outcome';
+export type ExistsOptions = {
+    fileOptions?: FileOptions;
+    existsOptions?: GCSFileExistsOptions;
+};
+/**
+ * Checks if a file exists in the specified bucket.
+ *
+ * This function verifies whether a file at the given `sourcePath` exists in the bucket. It can be configured with options to customize the behavior of the check.
+ *
+ * @param {Bucket} bucket - The GCS bucket to check for the file existence.
+ * @param {string} sourcePath - The path of the file to check within the bucket.
+ * @param {ExistsOptions} [options] - Optional configuration for the file existence check.
+ * @param {FileOptions} [options.fileOptions] - Additional options for the file, such as custom metadata or ACL settings.
+ * @param {ExistsOptions} [options.existsOptions] - Options for controlling the `exists` method (if any).
+ * @returns {Promise<Outcome.Either<boolean, string>>} - Returns either a success with `true` or `false` indicating whether the file exists, or a failure with an error message.
+ */
+export declare function exists(bucket: Bucket, sourcePath: string, options?: ExistsOptions): Promise<Outcome.Either<boolean, string>>;

package/node/@google-cloud/storage/file/exists/index.js

@@ -0,0 +1,9 @@
+import {
+  exists
+} from "../../../../../chunks/chunk-CIJQHLIW.js";
+import "../../../../../chunks/chunk-JMU5PDBD.js";
+import "../../../../../chunks/chunk-FENXVJYO.js";
+import "../../../../../chunks/chunk-XCBH6NLF.js";
+export {
+  exists
+};

package/node/@google-cloud/storage/file/generate-signed-url/index.d.ts

@@ -0,0 +1,23 @@
+import { Bucket, FileOptions, GetSignedUrlConfig } from '@google-cloud/storage';
+import { Outcome } from '~/agnostic/misc/outcome';
+export type GenerateSignedUrlOptions = {
+    fileOptions?: FileOptions;
+    getSignedUrlOptions?: Omit<GetSignedUrlConfig, 'action' | 'expires'>;
+};
+/**
+ * Generates a signed URL that provides temporary access to a file in Google Cloud Storage.
+ *
+ * This function generates a signed URL for the file located at `sourcePath` in the given bucket. The signed URL
+ * allows users to perform an action on the file (e.g., `read`, `write`) for a limited time as defined by the `expiresOn` parameter.
+ * The behavior can be customized using optional `fileOptions` and `getSignedUrlOptions`.
+ *
+ * @param {string} sourcePath - The path of the file for which the signed URL is being generated.
+ * @param {Bucket} bucket - The Google Cloud Storage bucket object containing the file.
+ * @param {GetSignedUrlConfig['action']} action - The action allowed by the signed URL (e.g., 'read', 'write', 'delete').
+ * @param {GetSignedUrlConfig['expires']} expiresOn - The expiration time of the signed URL, after which it is no longer valid.
+ * @param {GenerateSignedUrlOptions} [options] - Optional configuration options for generating the signed URL.
+ * @returns {Promise<Outcome.Either<string, string>>} A promise that resolves to an `Outcome.Either`.
+ * - On success: `Outcome.makeSuccess(url)` containing the generated signed URL.
+ * - On failure: `Outcome.makeFailure(errStr)` with an error message if the signed URL generation fails.
+ */
+export declare function generateSignedUrl(sourcePath: string, bucket: Bucket, action: GetSignedUrlConfig['action'], expiresOn: GetSignedUrlConfig['expires'], options?: GenerateSignedUrlOptions): Promise<Outcome.Either<string, string>>;

package/node/@google-cloud/storage/file/generate-signed-url/index.js

@@ -0,0 +1,9 @@
+import {
+  generateSignedUrl
+} from "../../../../../chunks/chunk-4FOK7DUZ.js";
+import "../../../../../chunks/chunk-JMU5PDBD.js";
+import "../../../../../chunks/chunk-FENXVJYO.js";
+import "../../../../../chunks/chunk-XCBH6NLF.js";
+export {
+  generateSignedUrl
+};

package/node/@google-cloud/storage/file/get-metadata/index.d.ts

@@ -0,0 +1,22 @@
+import { Bucket, FileOptions, GetFileMetadataOptions as GCSGetFileMetadataOptions, FileMetadata } from '@google-cloud/storage';
+import { Outcome } from '~/agnostic/misc/outcome';
+export type GetMetadataOptions = {
+    fileOptions?: FileOptions;
+    getFileMetadataOptions?: GCSGetFileMetadataOptions;
+};
+/**
+ * Retrieves the metadata of a file from a specified Google Cloud Storage bucket.
+ *
+ * This function fetches the metadata for a file located at `sourcePath` in the given bucket.
+ * It can be customized using optional `fileOptions` and `getFileMetadataOptions` to control the retrieval behavior.
+ *
+ * @param {string} sourcePath - The path of the file whose metadata is to be fetched.
+ * @param {Bucket} bucket - The Google Cloud Storage bucket object containing the file whose metadata is being retrieved.
+ * @param {GetMetadataOptions} [options] - Optional configuration options for the file metadata retrieval.
+ * @returns {Promise<Outcome.Either<FileMetadata, string>>} A promise that resolves to an `Outcome.Either`.
+ * - On success: `Outcome.makeSuccess(metadata)` containing the file's metadata.
+ * - On failure: `Outcome.makeFailure(errStr)` with an error message if the metadata retrieval fails.
+ *
+ * @throws {Error} Throws an error if the metadata retrieval operation fails (e.g., file not found, insufficient permissions, etc.).
+ */
+export declare function getMetadata(sourcePath: string, bucket: Bucket, options?: GetMetadataOptions): Promise<Outcome.Either<FileMetadata, string>>;

package/node/@google-cloud/storage/file/get-metadata/index.js

@@ -0,0 +1,9 @@
+import {
+  getMetadata
+} from "../../../../../chunks/chunk-YDNQHZRS.js";
+import "../../../../../chunks/chunk-JMU5PDBD.js";
+import "../../../../../chunks/chunk-FENXVJYO.js";
+import "../../../../../chunks/chunk-XCBH6NLF.js";
+export {
+  getMetadata
+};

package/node/@google-cloud/storage/file/get-permissions/index.d.ts

@@ -0,0 +1,19 @@
+import { Bucket, FileOptions, GetAclOptions } from '@google-cloud/storage';
+import { Outcome } from '~/agnostic/misc/outcome';
+export type GetPermissionsOptions = {
+    fileOptions?: FileOptions;
+    getAclOptions?: GetAclOptions;
+};
+/**
+ * Retrieves the access control list (ACL) for a file in Google Cloud Storage.
+ *
+ * This function fetches the ACL settings of a given file to determine the permissions assigned to different users or roles.
+ *
+ * @param {string} sourcePath - The path of the file whose permissions need to be retrieved.
+ * @param {Bucket} bucket - The Google Cloud Storage bucket containing the file.
+ * @param {GetPermissionsOptions} [options] - Optional configuration options for the file and ACL retrieval.
+ * @returns {Promise<Outcome.Either<any, string>>} A promise that resolves to an `Outcome.Either`.
+ * - On success: `Outcome.makeSuccess(acl)` containing the file's ACL settings.
+ * - On failure: `Outcome.makeFailure(errStr)` with an error message if the ACL retrieval fails.
+ */
+export declare function getPermissions(sourcePath: string, bucket: Bucket, options?: GetPermissionsOptions): Promise<Outcome.Either<any, string>>;

package/node/@google-cloud/storage/file/get-permissions/index.js

@@ -0,0 +1,9 @@
+import {
+  getPermissions
+} from "../../../../../chunks/chunk-F5GXXF3A.js";
+import "../../../../../chunks/chunk-JMU5PDBD.js";
+import "../../../../../chunks/chunk-FENXVJYO.js";
+import "../../../../../chunks/chunk-XCBH6NLF.js";
+export {
+  getPermissions
+};

package/node/@google-cloud/storage/file/index.d.ts

@@ -0,0 +1,12 @@
+import * as Copy from './copy';
+import * as Download from './download';
+import * as Erase from './erase';
+import * as Exists from './exists';
+import * as GenerateSignedUrl from './generate-signed-url';
+import * as GetMetaData from './get-metadata';
+import * as GetPermissions from './get-permissions';
+import * as Move from './move';
+import * as RevokeSignedUrls from './revoke-signed-urls';
+import * as UpdateMetadata from './update-metadata';
+import * as Upload from './upload';
+export { Copy, Download, Erase, Exists, GenerateSignedUrl, GetMetaData, GetPermissions, Move, RevokeSignedUrls, UpdateMetadata, Upload };

package/node/@google-cloud/storage/file/index.js

@@ -0,0 +1,50 @@
+import "../../../../chunks/chunk-QMWX2A56.js";
+import {
+  revoke_signed_urls_exports
+} from "../../../../chunks/chunk-YZDZQ7AZ.js";
+import {
+  upload_exports
+} from "../../../../chunks/chunk-RSMUYH5H.js";
+import {
+  move_exports
+} from "../../../../chunks/chunk-I2ILSLBK.js";
+import {
+  update_metadata_exports
+} from "../../../../chunks/chunk-UG36UPJK.js";
+import {
+  copy_exports
+} from "../../../../chunks/chunk-PVHLWKA6.js";
+import {
+  download_exports
+} from "../../../../chunks/chunk-LAA2DQDK.js";
+import {
+  erase_exports
+} from "../../../../chunks/chunk-FG53JEP2.js";
+import {
+  generate_signed_url_exports
+} from "../../../../chunks/chunk-4FOK7DUZ.js";
+import {
+  exists_exports
+} from "../../../../chunks/chunk-CIJQHLIW.js";
+import {
+  get_permissions_exports
+} from "../../../../chunks/chunk-F5GXXF3A.js";
+import {
+  get_metadata_exports
+} from "../../../../chunks/chunk-YDNQHZRS.js";
+import "../../../../chunks/chunk-JMU5PDBD.js";
+import "../../../../chunks/chunk-FENXVJYO.js";
+import "../../../../chunks/chunk-XCBH6NLF.js";
+export {
+  copy_exports as Copy,
+  download_exports as Download,
+  erase_exports as Erase,
+  exists_exports as Exists,
+  generate_signed_url_exports as GenerateSignedUrl,
+  get_metadata_exports as GetMetaData,
+  get_permissions_exports as GetPermissions,
+  move_exports as Move,
+  revoke_signed_urls_exports as RevokeSignedUrls,
+  update_metadata_exports as UpdateMetadata,
+  upload_exports as Upload
+};

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

@@ -0,0 +1,24 @@
+import { Bucket, FileOptions, CopyOptions, DeleteFileOptions as GCSDeleteFileOptions } from '@google-cloud/storage';
+import { Outcome } from '~/agnostic/misc/outcome';
+export type MoveOptions = {
+    fileOptions?: FileOptions;
+    copyOptions?: CopyOptions;
+    deleteOptions?: GCSDeleteFileOptions;
+};
+/**
+ * Moves a file from one location to another within a Google Cloud Storage bucket.
+ *
+ * This function first copies the file located at `sourcePath` to `destinationPath`, then deletes the source file
+ * after the copy is successful. The process can be customized using optional `fileOptions`, `copyOptions`, and `deleteOptions`.
+ *
+ * @param {string} sourcePath - The path of the source file to be moved.
+ * @param {string} destinationPath - The destination path where the file will be moved to.
+ * @param {Bucket} bucket - The Google Cloud Storage bucket object containing the file to be moved.
+ * @param {MoveOptions} [options] - Optional configuration options for the file move operation.
+ * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`.
+ * - On success: `Outcome.makeSuccess(true)` indicating the file was successfully moved.
+ * - On failure: `Outcome.makeFailure(errStr)` with an error message if the move operation fails.
+ *
+ * @throws {Error} Throws an error if the move operation fails (e.g., source file not found, insufficient permissions, etc.).
+ */
+export declare function move(sourcePath: string, destinationPath: string, bucket: Bucket, options?: MoveOptions): Promise<Outcome.Either<true, string>>;

package/node/@google-cloud/storage/file/move/index.js

@@ -0,0 +1,9 @@
+import {
+  move
+} from "../../../../../chunks/chunk-I2ILSLBK.js";
+import "../../../../../chunks/chunk-JMU5PDBD.js";
+import "../../../../../chunks/chunk-FENXVJYO.js";
+import "../../../../../chunks/chunk-XCBH6NLF.js";
+export {
+  move
+};

package/node/@google-cloud/storage/file/revoke-signed-urls/index.d.ts

@@ -0,0 +1,26 @@
+import { Bucket } from '@google-cloud/storage';
+import { Outcome } from '~/agnostic/misc/outcome';
+import { DownloadOptions } from '../download';
+import { EraseOptions } from '../erase';
+import { UploadOptions } from '../upload';
+export type RevokeSignedUrlsOptions = {
+    downloadOptions?: DownloadOptions;
+    eraseOptions?: EraseOptions;
+    uploadOptions?: UploadOptions;
+};
+/**
+ * Revokes the signed URLs for a file in Google Cloud Storage by downloading the file,
+ * deleting it, and re-uploading it to effectively invalidate any previously generated signed URLs.
+ *
+ * This function first attempts to download the file from the bucket, then erases the file,
+ * and finally re-uploads the file to the same path. The re-upload effectively revokes any signed URLs that
+ * were generated for the file, as they are tied to the file's existence and content.
+ *
+ * @param {string} sourcePath - The path of the file for which the signed URLs are to be revoked.
+ * @param {Bucket} bucket - The Google Cloud Storage bucket containing the file.
+ * @param {RevokeSignedUrlsOptions} [options] - Optional configuration options for the file operations.
+ * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`.
+ * - On success: `Outcome.makeSuccess(true)` if the file has been successfully re-uploaded after deletion.
+ * - On failure: `Outcome.makeFailure(errStr)` with an error message if any of the steps (download, erase, or upload) fail.
+ */
+export declare function revokeSignedUrls(sourcePath: string, bucket: Bucket, options?: RevokeSignedUrlsOptions): Promise<Outcome.Either<true, string>>;

package/node/@google-cloud/storage/file/revoke-signed-urls/index.js

@@ -0,0 +1,12 @@
+import {
+  revokeSignedUrls
+} from "../../../../../chunks/chunk-YZDZQ7AZ.js";
+import "../../../../../chunks/chunk-RSMUYH5H.js";
+import "../../../../../chunks/chunk-LAA2DQDK.js";
+import "../../../../../chunks/chunk-FG53JEP2.js";
+import "../../../../../chunks/chunk-JMU5PDBD.js";
+import "../../../../../chunks/chunk-FENXVJYO.js";
+import "../../../../../chunks/chunk-XCBH6NLF.js";
+export {
+  revokeSignedUrls
+};

package/node/@google-cloud/storage/file/update-metadata/index.d.ts

@@ -0,0 +1,24 @@
+import { Bucket, FileOptions, SetFileMetadataOptions } from '@google-cloud/storage';
+import { Outcome } from '~/agnostic/misc/outcome';
+export type UpdateFileMetadataOptions = {
+    fileOptions?: FileOptions;
+    metadataOptions?: SetFileMetadataOptions;
+};
+/**
+ * Updates the metadata of a file in a Google Cloud Storage bucket.
+ *
+ * This function allows updating the metadata of a file located at `sourcePath` in the given bucket.
+ * The metadata is updated according to the provided `metadata` object, which contains the new metadata key-value pairs.
+ * It can be customized using optional `fileOptions` and `metadataOptions` to control the update behavior.
+ *
+ * @param {string} sourcePath - The path of the file whose metadata is to be updated.
+ * @param {Bucket} bucket - The Google Cloud Storage bucket object containing the file whose metadata is being updated.
+ * @param {Record<string, any>} metadata - The metadata object containing key-value pairs to be set on the file.
+ * @param {UpdateFileMetadataOptions} [options] - Optional configuration options for the metadata update operation.
+ * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`.
+ * - On success: `Outcome.makeSuccess(true)` indicating the metadata was successfully updated.
+ * - On failure: `Outcome.makeFailure(errStr)` with an error message if the metadata update operation fails.
+ *
+ * @throws {Error} Throws an error if the metadata update operation fails (e.g., file not found, insufficient permissions, etc.).
+ */
+export declare function updateFileMetadata(sourcePath: string, bucket: Bucket, metadata: Record<string, any>, options?: UpdateFileMetadataOptions): Promise<Outcome.Either<true, string>>;

package/node/@google-cloud/storage/file/update-metadata/index.js

@@ -0,0 +1,9 @@
+import {
+  updateFileMetadata
+} from "../../../../../chunks/chunk-UG36UPJK.js";
+import "../../../../../chunks/chunk-JMU5PDBD.js";
+import "../../../../../chunks/chunk-FENXVJYO.js";
+import "../../../../../chunks/chunk-XCBH6NLF.js";
+export {
+  updateFileMetadata
+};

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

@@ -0,0 +1,21 @@
+import { Bucket, FileOptions, SaveOptions } from '@google-cloud/storage';
+import { Outcome } from '~/agnostic/misc/outcome';
+export type UploadOptions = {
+    fileOptions?: FileOptions;
+    saveOptions?: SaveOptions;
+};
+/**
+ * Uploads a file buffer to a specified Google Cloud Storage bucket.
+ *
+ * This function uploads the provided file buffer to the specified bucket at the given destination path.
+ * The upload can be customized using optional `fileOptions` and `saveOptions`.
+ *
+ * @param {Buffer} filebuffer - The file content to be uploaded.
+ * @param {string} destinationPath - The destination path where the file will be saved in the bucket.
+ * @param {Bucket} bucket - The Google Cloud Storage bucket object.
+ * @param {UploadOptions} [options] - Optional options to configure the upload process.
+ * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`.
+ * - On success: `Outcome.makeSuccess(true)` indicating the upload was successful.
+ * - On failure: `Outcome.makeFailure(errStr)` with an error message if the upload fails.
+ */
+export declare function upload(filebuffer: Buffer, destinationPath: string, bucket: Bucket, options?: UploadOptions): Promise<Outcome.Either<true, string>>;

package/node/@google-cloud/storage/file/upload/index.js

@@ -0,0 +1,9 @@
+import {
+  upload
+} from "../../../../../chunks/chunk-RSMUYH5H.js";
+import "../../../../../chunks/chunk-JMU5PDBD.js";
+import "../../../../../chunks/chunk-FENXVJYO.js";
+import "../../../../../chunks/chunk-XCBH6NLF.js";
+export {
+  upload
+};

package/node/@google-cloud/storage/index.d.ts

@@ -0,0 +1,3 @@
+import * as Bucket from './bucket';
+import * as File from './file';
+export { Bucket, File };

package/node/@google-cloud/storage/index.js

@@ -0,0 +1,27 @@
+import "../../../chunks/chunk-BV67SWXG.js";
+import {
+  file_exports
+} from "../../../chunks/chunk-QMWX2A56.js";
+import "../../../chunks/chunk-YZDZQ7AZ.js";
+import "../../../chunks/chunk-RSMUYH5H.js";
+import "../../../chunks/chunk-I2ILSLBK.js";
+import "../../../chunks/chunk-UG36UPJK.js";
+import "../../../chunks/chunk-PVHLWKA6.js";
+import "../../../chunks/chunk-LAA2DQDK.js";
+import "../../../chunks/chunk-FG53JEP2.js";
+import "../../../chunks/chunk-4FOK7DUZ.js";
+import "../../../chunks/chunk-CIJQHLIW.js";
+import "../../../chunks/chunk-F5GXXF3A.js";
+import "../../../chunks/chunk-YDNQHZRS.js";
+import {
+  bucket_exports
+} from "../../../chunks/chunk-GL54CDM2.js";
+import "../../../chunks/chunk-KYMCGWPM.js";
+import "../../../chunks/chunk-AF2MI5O5.js";
+import "../../../chunks/chunk-JMU5PDBD.js";
+import "../../../chunks/chunk-FENXVJYO.js";
+import "../../../chunks/chunk-XCBH6NLF.js";
+export {
+  bucket_exports as Bucket,
+  file_exports as File
+};

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

@@ -0,0 +1,55 @@
+import { Readable } from 'node:stream';
+import { Outcome } from '~/agnostic/misc/outcome';
+import { EncryptDecryptOptions } from '../uint8-array';
+/**
+ * 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 {string} [algorithm='aes-256-gcm'] - The encryption algorithm to use. Defaults to 'aes-256-gcm'.
+ * @param {EncryptDecryptOptions} [options] - Optional options.
+ * @param {number} [options.ivLength=16] - The length of the initialization vector (IV). Defaults to 16 bytes.
+ *
+ * @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.
+ */
+export declare function encryptBuffer(inputBuffer: Buffer, encryptionKey: string, algorithm?: string, options?: EncryptDecryptOptions): Outcome.Either<Buffer, string>;
+/**
+ * Encrypts a `Buffer` using streams and returns a `Readable` stream containing the encrypted data.
+ * The `Readable` stream will emit encrypted data in chunks.
+ *
+ * @param {Buffer} inputBuffer - The input data to be encrypted.
+ * @param {string} encryptionKey - The encryption key to use for encryption.
+ * @param {string} [algorithm='aes-256-gcm'] - The encryption algorithm to use (default: 'aes-256-gcm').
+ * @param {EncryptDecryptOptions} [options] - Optional parameters for encryption, such as `ivLength`.
+ * @param {number} [options.ivLength=16] - The length of the initialization vector (IV) to use (default: 16).
+ *
+ * @returns {Outcome.Either<Readable, string>} - An `Outcome` containing either the `Readable` stream on success,
+ * or an error message on failure.
+ */
+export declare function encryptBufferWithStream(inputBuffer: Buffer, encryptionKey: string, algorithm?: string, options?: EncryptDecryptOptions): Outcome.Either<Readable, 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 {string} [algorithm='aes-256-gcm'] - The encryption algorithm to use. Defaults to 'aes-256-gcm'.
+ * @param {EncryptDecryptOptions} [options] - Optional options.
+ * @param {number} [options.ivLength=16] - The length of the initialization vector (IV). Defaults to 16 bytes.
+ *
+ * @returns {Outcome.Either<Buffer, string>} The result of the decryption. Success returns the decrypted data as a `Buffer`, or failure returns an error message.
+ */
+export declare function decryptBuffer(encryptedBuffer: Buffer, encryptionKey: string, algorithm?: string, options?: EncryptDecryptOptions): Outcome.Either<Buffer, string>;
+/**
+ * Decrypts an encrypted `Buffer` using streams and returns a `Readable` stream containing the decrypted data.
+ * The `Readable` stream will emit decrypted data in chunks.
+ *
+ * @param {Buffer} encryptedBuffer - The encrypted data to be decrypted. The first `ivLength` bytes are treated as the initialization vector (IV).
+ * @param {string} encryptionKey - The encryption key to use for decryption.
+ * @param {string} [algorithm='aes-256-gcm'] - The decryption algorithm to use (default: 'aes-256-gcm').
+ * @param {EncryptDecryptOptions} [options] - Optional parameters for decryption, such as `ivLength`.
+ * @param {number} [options.ivLength=16] - The length of the initialization vector (IV) to use (default: 16).
+ *
+ * @returns {Outcome.Either<Readable, string>} - An `Outcome` containing either the `Readable` stream on success,
+ * or an error message on failure.
+ */
+export declare function decryptBufferWithStream(encryptedBuffer: Buffer, encryptionKey: string, algorithm?: string, options?: EncryptDecryptOptions): Outcome.Either<Readable, string>;

package/node/encryption/buffer/index.js

@@ -0,0 +1,16 @@
+import {
+  decryptBuffer,
+  decryptBufferWithStream,
+  encryptBuffer,
+  encryptBufferWithStream
+} from "../../../chunks/chunk-IUFAHY2R.js";
+import "../../../chunks/chunk-5QVKJGTN.js";
+import "../../../chunks/chunk-JMU5PDBD.js";
+import "../../../chunks/chunk-FENXVJYO.js";
+import "../../../chunks/chunk-XCBH6NLF.js";
+export {
+  decryptBuffer,
+  decryptBufferWithStream,
+  encryptBuffer,
+  encryptBufferWithStream
+};

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

@@ -0,0 +1,16 @@
+export type GenerateEncryptionKeyOptions = {
+    saltLength?: number;
+    iterations?: number;
+};
+/**
+ * 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 {GenerateEncryptionKeyOptions} [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.
+ *
+ * @returns {string} The derived encryption key and salt, concatenated as a string in the format `salt:encryptionKey`.
+ */
+export declare function generateEncryptionKey(passphrase: string, outputByteLength: number, options?: GenerateEncryptionKeyOptions): string;

package/node/encryption/generate-key/index.js

@@ -0,0 +1,7 @@
+import {
+  generateEncryptionKey
+} from "../../../chunks/chunk-GNZY3ZTH.js";
+import "../../../chunks/chunk-XCBH6NLF.js";
+export {
+  generateEncryptionKey
+};

package/node/encryption/index.d.ts

@@ -0,0 +1,5 @@
+import { encryptBuffer, decryptBuffer, encryptBufferWithStream, decryptBufferWithStream } from './buffer';
+import { generateEncryptionKey, GenerateEncryptionKeyOptions } from './generate-key';
+import { EncryptDecryptOptions, encryptUint8Array, decryptUint8Array, encryptUint8ArrayWithStream, decryptUint8ArrayWithStream } from './uint8-array';
+export { encryptBuffer, decryptBuffer, encryptBufferWithStream, decryptBufferWithStream, generateEncryptionKey, encryptUint8Array, decryptUint8Array, encryptUint8ArrayWithStream, decryptUint8ArrayWithStream };
+export type { EncryptDecryptOptions, GenerateEncryptionKeyOptions };

package/node/encryption/index.js

@@ -0,0 +1,29 @@
+import {
+  generateEncryptionKey
+} from "../../chunks/chunk-GNZY3ZTH.js";
+import {
+  decryptBuffer,
+  decryptBufferWithStream,
+  encryptBuffer,
+  encryptBufferWithStream
+} from "../../chunks/chunk-IUFAHY2R.js";
+import {
+  decryptUint8Array,
+  decryptUint8ArrayWithStream,
+  encryptUint8Array,
+  encryptUint8ArrayWithStream
+} from "../../chunks/chunk-5QVKJGTN.js";
+import "../../chunks/chunk-JMU5PDBD.js";
+import "../../chunks/chunk-FENXVJYO.js";
+import "../../chunks/chunk-XCBH6NLF.js";
+export {
+  decryptBuffer,
+  decryptBufferWithStream,
+  decryptUint8Array,
+  decryptUint8ArrayWithStream,
+  encryptBuffer,
+  encryptBufferWithStream,
+  encryptUint8Array,
+  encryptUint8ArrayWithStream,
+  generateEncryptionKey
+};