@design-edito/tools 0.1.54 → 0.1.55

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

@@ -1,9 +1,9 @@
 import {
   revokeSignedUrls
-} from "../../../../../chunks/chunk-QTTNO4T6.js";
-import "../../../../../chunks/chunk-4WOYAD35.js";
+} from "../../../../../chunks/chunk-X4XXZ44B.js";
 import "../../../../../chunks/chunk-G66DWXF3.js";
-import "../../../../../chunks/chunk-I66DPQN2.js";
+import "../../../../../chunks/chunk-KH5JTC2N.js";
+import "../../../../../chunks/chunk-6WVNJVBE.js";
 import "../../../../../chunks/chunk-JMU5PDBD.js";
 import "../../../../../chunks/chunk-FENXVJYO.js";
 import "../../../../../chunks/chunk-WSFCRVEQ.js";

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

@@ -1,21 +1,25 @@
+import { Readable } from 'node:stream';
 import { Bucket, FileOptions, SaveOptions } from '@google-cloud/storage';
 import { Outcome } from '~/agnostic/misc/outcome';
 export type UploadOptions = {
     fileOptions?: FileOptions;
-    saveOptions?: SaveOptions;
+    saveOptions?: SaveOptions & {
+        overwrite?: boolean;
+    };
 };
 /**
- * Uploads a file buffer to a specified Google Cloud Storage bucket.
+ * Uploads a file stream to a specified Google Cloud Storage bucket.
  *
- * This function uploads the provided file buffer to the specified bucket at the given destination path.
+ * This function uploads the provided file stream to the specified bucket at the given target path.
  * The upload can be customized using optional `fileOptions` and `saveOptions`.
+ * If the `overwrite` option is false and a file already exists at the target path, the upload is aborted.
  *
- * @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 {Readable} fileStream - The file content to be uploaded.
+ * @param {string} targetPath - The target 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.
+ * @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>>;
+export declare function upload(fileStream: Readable, targetPath: string, bucket: Bucket, options?: UploadOptions): Promise<Outcome.Either<true, string>>;

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

@@ -1,6 +1,6 @@
 import {
   upload
-} from "../../../../../chunks/chunk-4WOYAD35.js";
+} from "../../../../../chunks/chunk-KH5JTC2N.js";
 import "../../../../../chunks/chunk-JMU5PDBD.js";
 import "../../../../../chunks/chunk-FENXVJYO.js";
 import "../../../../../chunks/chunk-WSFCRVEQ.js";

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

@@ -1,23 +1,23 @@
-import "../../../chunks/chunk-Q7HA7IAA.js";
-import {
-  file_exports
-} from "../../../chunks/chunk-W6BFU7Y5.js";
-import "../../../chunks/chunk-JBDWHJ4Q.js";
-import "../../../chunks/chunk-QTTNO4T6.js";
-import "../../../chunks/chunk-3GTGE66Y.js";
-import "../../../chunks/chunk-4WOYAD35.js";
-import "../../../chunks/chunk-N4LMP4UM.js";
-import "../../../chunks/chunk-G66DWXF3.js";
-import "../../../chunks/chunk-I66DPQN2.js";
-import "../../../chunks/chunk-5VHFXWFM.js";
-import "../../../chunks/chunk-QVIRBFMQ.js";
-import "../../../chunks/chunk-EM37BFXO.js";
-import "../../../chunks/chunk-WOGRENMM.js";
+import "../../../chunks/chunk-VHCD3Z4T.js";
 import {
   bucket_exports
 } from "../../../chunks/chunk-YMRAUWRW.js";
 import "../../../chunks/chunk-ZNA7SWFK.js";
 import "../../../chunks/chunk-7YSTZ7GY.js";
+import {
+  file_exports
+} from "../../../chunks/chunk-L2L27BLX.js";
+import "../../../chunks/chunk-EM37BFXO.js";
+import "../../../chunks/chunk-QVIRBFMQ.js";
+import "../../../chunks/chunk-4CAHGPFA.js";
+import "../../../chunks/chunk-WOGRENMM.js";
+import "../../../chunks/chunk-X4XXZ44B.js";
+import "../../../chunks/chunk-G66DWXF3.js";
+import "../../../chunks/chunk-JBDWHJ4Q.js";
+import "../../../chunks/chunk-5IPSIDXB.js";
+import "../../../chunks/chunk-5VHFXWFM.js";
+import "../../../chunks/chunk-KH5JTC2N.js";
+import "../../../chunks/chunk-6WVNJVBE.js";
 import "../../../chunks/chunk-JMU5PDBD.js";
 import "../../../chunks/chunk-FENXVJYO.js";
 import "../../../chunks/chunk-WSFCRVEQ.js";

package/node/cloud-storage/client/index.d.ts

@@ -0,0 +1,14 @@
+import { Bucket } from '@google-cloud/storage';
+import { S3 } from 'aws-sdk';
+import { Client as FtpClient } from 'basic-ftp';
+import SftpClient from 'ssh2-sftp-client';
+import { Outcome } from '~/agnostic/misc/outcome';
+import { GcsBucketCredentials, S3BucketCredentials, FtpCredentials, FtpsCredentials, SftpCredentials, Credentials } from '../credentials';
+import { Type, Endpoint } from '../endpoint';
+export type Client<T extends Type> = T extends Type.GCS ? Bucket : T extends Type.S3 ? S3 : T extends Type.FTP ? FtpClient : T extends Type.FTPS ? FtpClient : T extends Type.SFTP ? SftpClient : never;
+export declare function makeClient<T extends Type>(endpointType: T, endpointIdentifier: Endpoint<T>['identifier'], credentials: Credentials<T>): Promise<Outcome.Either<Client<T>, string>>;
+export declare function makeGcsClient(endpoint: Endpoint<Type.GCS>, credentials: GcsBucketCredentials): Outcome.Either<Bucket, string>;
+export declare function makeS3Client(credentials: S3BucketCredentials): Outcome.Either<S3, string>;
+export declare function makeFtpClient(endpoint: Endpoint<Type.FTP>, credentials: FtpCredentials): Promise<Outcome.Either<FtpClient, string>>;
+export declare function makeFtpsClient(endpoint: Endpoint<Type.FTPS>, credentials: FtpsCredentials): Promise<Outcome.Either<FtpClient, string>>;
+export declare function makeSftpClient(endpoint: Endpoint<Type.SFTP>, credentials: SftpCredentials): Promise<Outcome.Either<SftpClient, string>>;

package/node/cloud-storage/client/index.js

@@ -0,0 +1,20 @@
+import {
+  makeClient,
+  makeFtpClient,
+  makeFtpsClient,
+  makeGcsClient,
+  makeS3Client,
+  makeSftpClient
+} from "../../../chunks/chunk-P3QFJTAE.js";
+import "../../../chunks/chunk-CMWR77VW.js";
+import "../../../chunks/chunk-JMU5PDBD.js";
+import "../../../chunks/chunk-FENXVJYO.js";
+import "../../../chunks/chunk-WSFCRVEQ.js";
+export {
+  makeClient,
+  makeFtpClient,
+  makeFtpsClient,
+  makeGcsClient,
+  makeS3Client,
+  makeSftpClient
+};

package/node/cloud-storage/credentials/index.d.ts

@@ -0,0 +1,33 @@
+import { Type } from '../endpoint';
+export type GcsBucketCredentials = {
+    client_email: string;
+    private_key: string;
+    project_id: string;
+};
+export type S3BucketCredentials = {
+    accessKeyId: string;
+    secretAccessKey: string;
+    region?: string;
+};
+export type FtpCredentials = {
+    host: string;
+    port: number;
+    username: string;
+    password: string;
+};
+export type FtpsCredentials = {
+    host: string;
+    port: number;
+    username: string;
+    password: string;
+    implicit: boolean;
+};
+export type SftpCredentials = {
+    host: string;
+    port: number;
+    username: string;
+    password?: string;
+    privateKey?: string;
+    passphrase?: string;
+};
+export type Credentials<T extends Type> = T extends Type.GCS ? GcsBucketCredentials : T extends Type.S3 ? S3BucketCredentials : T extends Type.FTP ? FtpCredentials : T extends Type.FTPS ? FtpsCredentials : T extends Type.SFTP ? SftpCredentials : never;

package/node/cloud-storage/credentials/index.js

@@ -0,0 +1 @@
+import "../../../chunks/chunk-JSYVAPV6.js";

package/node/cloud-storage/endpoint/index.d.ts

@@ -0,0 +1,24 @@
+export declare enum Type {
+    GCS = "gcs-bucket",
+    S3 = "s3-bucket",
+    FTP = "ftp",
+    FTPS = "ftps",
+    SFTP = "sftp"
+}
+export type Endpoint<T extends Type = Type> = {
+    type: T;
+    identifier: string;
+};
+export declare function gcsIdentifierData(identifier: string): {
+    bucketName: string | null;
+    path: string;
+};
+export declare function s3IdentifierData(identifier: string): {
+    bucketName: string | null;
+    path: string;
+};
+export declare function ftpIdentifierData(identifier: string): {
+    host: string | null;
+    port: string | null;
+    path: string;
+};

package/node/cloud-storage/endpoint/index.js

@@ -0,0 +1,13 @@
+import {
+  Type,
+  ftpIdentifierData,
+  gcsIdentifierData,
+  s3IdentifierData
+} from "../../../chunks/chunk-CMWR77VW.js";
+import "../../../chunks/chunk-WSFCRVEQ.js";
+export {
+  Type,
+  ftpIdentifierData,
+  gcsIdentifierData,
+  s3IdentifierData
+};

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

@@ -0,0 +1,5 @@
+import * as Client from './client';
+import * as Credentials from './credentials';
+import * as Endpoint from './endpoint';
+import * as Operations from './operations';
+export { Client, Credentials, Endpoint, Operations };

package/node/cloud-storage/index.js

@@ -0,0 +1,31 @@
+import {
+  credentials_exports
+} from "../../chunks/chunk-JSYVAPV6.js";
+import {
+  operations_exports
+} from "../../chunks/chunk-UT75PSLP.js";
+import "../../chunks/chunk-EHVYR4OU.js";
+import "../../chunks/chunk-N5QAGJXV.js";
+import "../../chunks/chunk-KH5JTC2N.js";
+import "../../chunks/chunk-AIESW26U.js";
+import "../../chunks/chunk-AZLVQV5A.js";
+import "../../chunks/chunk-HQGZVWBB.js";
+import "../../chunks/chunk-7N7BJA6C.js";
+import "../../chunks/chunk-6WVNJVBE.js";
+import "../../chunks/chunk-UJN2WZGO.js";
+import "../../chunks/chunk-OD33BN4K.js";
+import {
+  client_exports
+} from "../../chunks/chunk-P3QFJTAE.js";
+import {
+  endpoint_exports
+} from "../../chunks/chunk-CMWR77VW.js";
+import "../../chunks/chunk-JMU5PDBD.js";
+import "../../chunks/chunk-FENXVJYO.js";
+import "../../chunks/chunk-WSFCRVEQ.js";
+export {
+  client_exports as Client,
+  credentials_exports as Credentials,
+  endpoint_exports as Endpoint,
+  operations_exports as Operations
+};

package/node/cloud-storage/operations/download/index.d.ts

@@ -0,0 +1,5 @@
+import { Outcome } from '~/agnostic/misc/outcome';
+import { Client } from '../../client';
+import { Credentials } from '../../credentials';
+import { Type, Endpoint } from '../../endpoint';
+export declare function download<T extends Type>(targetPath: string, endpointType: T, endpointIdentifier: Endpoint<T>['identifier'], credentials: Credentials<T>, client?: Client<T>): Promise<Outcome.Either<import("stream").Readable, string>>;

package/node/cloud-storage/operations/download/index.js

@@ -0,0 +1,15 @@
+import {
+  download
+} from "../../../../chunks/chunk-HQGZVWBB.js";
+import "../../../../chunks/chunk-7N7BJA6C.js";
+import "../../../../chunks/chunk-6WVNJVBE.js";
+import "../../../../chunks/chunk-UJN2WZGO.js";
+import "../../../../chunks/chunk-OD33BN4K.js";
+import "../../../../chunks/chunk-P3QFJTAE.js";
+import "../../../../chunks/chunk-CMWR77VW.js";
+import "../../../../chunks/chunk-JMU5PDBD.js";
+import "../../../../chunks/chunk-FENXVJYO.js";
+import "../../../../chunks/chunk-WSFCRVEQ.js";
+export {
+  download
+};

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

@@ -0,0 +1,3 @@
+import * as Download from './download';
+import * as Upload from './upload';
+export { Download, Upload };

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

@@ -0,0 +1,24 @@
+import "../../../chunks/chunk-UT75PSLP.js";
+import {
+  upload_exports
+} from "../../../chunks/chunk-EHVYR4OU.js";
+import "../../../chunks/chunk-N5QAGJXV.js";
+import "../../../chunks/chunk-KH5JTC2N.js";
+import "../../../chunks/chunk-AIESW26U.js";
+import "../../../chunks/chunk-AZLVQV5A.js";
+import {
+  download_exports
+} from "../../../chunks/chunk-HQGZVWBB.js";
+import "../../../chunks/chunk-7N7BJA6C.js";
+import "../../../chunks/chunk-6WVNJVBE.js";
+import "../../../chunks/chunk-UJN2WZGO.js";
+import "../../../chunks/chunk-OD33BN4K.js";
+import "../../../chunks/chunk-P3QFJTAE.js";
+import "../../../chunks/chunk-CMWR77VW.js";
+import "../../../chunks/chunk-JMU5PDBD.js";
+import "../../../chunks/chunk-FENXVJYO.js";
+import "../../../chunks/chunk-WSFCRVEQ.js";
+export {
+  download_exports as Download,
+  upload_exports as Upload
+};

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

@@ -0,0 +1,6 @@
+import { Readable } from 'node:stream';
+import { Outcome } from '~/agnostic/misc/outcome';
+import { Client } from '../../client';
+import { Credentials } from '../../credentials';
+import { Type, Endpoint } from '../../endpoint';
+export declare function upload<T extends Type>(fileReadable: Readable, targetPath: string, endpointType: T, endpointIdentifier: Endpoint<T>['identifier'], credentials: Credentials<T>, client?: Client<T>): Promise<Outcome.Either<true, string>>;

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

@@ -0,0 +1,15 @@
+import {
+  upload
+} from "../../../../chunks/chunk-EHVYR4OU.js";
+import "../../../../chunks/chunk-N5QAGJXV.js";
+import "../../../../chunks/chunk-KH5JTC2N.js";
+import "../../../../chunks/chunk-AIESW26U.js";
+import "../../../../chunks/chunk-AZLVQV5A.js";
+import "../../../../chunks/chunk-P3QFJTAE.js";
+import "../../../../chunks/chunk-CMWR77VW.js";
+import "../../../../chunks/chunk-JMU5PDBD.js";
+import "../../../../chunks/chunk-FENXVJYO.js";
+import "../../../../chunks/chunk-WSFCRVEQ.js";
+export {
+  upload
+};

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

@@ -1,3 +1,4 @@
+import { Buffer } from 'node:buffer';
 import { Readable } from 'node:stream';
 import { Outcome } from '~/agnostic/misc/outcome';
 import { EncryptDecryptOptions } from '../uint8-array';
@@ -12,7 +13,7 @@ import { EncryptDecryptOptions } from '../uint8-array';
  *
  * @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>;
+export declare function encrypt(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.
@@ -26,7 +27,7 @@ export declare function encryptBuffer(inputBuffer: Buffer, encryptionKey: string
  * @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>;
+export declare function encryptWithStream(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`.
  *
@@ -38,7 +39,7 @@ export declare function encryptBufferWithStream(inputBuffer: Buffer, encryptionK
  *
  * @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>;
+export declare function decrypt(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.
@@ -52,4 +53,4 @@ export declare function decryptBuffer(encryptedBuffer: Buffer, encryptionKey: st
  * @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>;
+export declare function decryptWithStream(encryptedBuffer: Buffer, encryptionKey: string, algorithm?: string, options?: EncryptDecryptOptions): Outcome.Either<Readable, string>;

package/node/encryption/buffer/index.js

@@ -1,16 +1,16 @@
 import {
-  decryptBuffer,
-  decryptBufferWithStream,
-  encryptBuffer,
-  encryptBufferWithStream
-} from "../../../chunks/chunk-IUFAHY2R.js";
-import "../../../chunks/chunk-5QVKJGTN.js";
+  decrypt,
+  decryptWithStream,
+  encrypt,
+  encryptWithStream
+} from "../../../chunks/chunk-MUZGZ3ZF.js";
+import "../../../chunks/chunk-IJ7SOXLA.js";
 import "../../../chunks/chunk-JMU5PDBD.js";
 import "../../../chunks/chunk-FENXVJYO.js";
 import "../../../chunks/chunk-WSFCRVEQ.js";
 export {
-  decryptBuffer,
-  decryptBufferWithStream,
-  encryptBuffer,
-  encryptBufferWithStream
+  decrypt,
+  decryptWithStream,
+  encrypt,
+  encryptWithStream
 };

package/node/encryption/index.d.ts

@@ -1,5 +1,4 @@
-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 };
+import * as Buffer from './buffer';
+import * as Key from './key';
+import * as Uint8Array from './uint8-array';
+export { Buffer, Key, Uint8Array };

package/node/encryption/index.js

@@ -1,29 +1,17 @@
 import {
-  generateEncryptionKey
-} from "../../chunks/chunk-GNZY3ZTH.js";
+  key_exports
+} from "../../chunks/chunk-HKTNK262.js";
 import {
-  decryptBuffer,
-  decryptBufferWithStream,
-  encryptBuffer,
-  encryptBufferWithStream
-} from "../../chunks/chunk-IUFAHY2R.js";
+  buffer_exports
+} from "../../chunks/chunk-MUZGZ3ZF.js";
 import {
-  decryptUint8Array,
-  decryptUint8ArrayWithStream,
-  encryptUint8Array,
-  encryptUint8ArrayWithStream
-} from "../../chunks/chunk-5QVKJGTN.js";
+  uint8_array_exports
+} from "../../chunks/chunk-IJ7SOXLA.js";
 import "../../chunks/chunk-JMU5PDBD.js";
 import "../../chunks/chunk-FENXVJYO.js";
 import "../../chunks/chunk-WSFCRVEQ.js";
 export {
-  decryptBuffer,
-  decryptBufferWithStream,
-  decryptUint8Array,
-  decryptUint8ArrayWithStream,
-  encryptBuffer,
-  encryptBufferWithStream,
-  encryptUint8Array,
-  encryptUint8ArrayWithStream,
-  generateEncryptionKey
+  buffer_exports as Buffer,
+  key_exports as Key,
+  uint8_array_exports as Uint8Array
 };

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

@@ -0,0 +1,16 @@
+export type GenerateOptions = {
+    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 {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.
+ *
+ * @returns {string} 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

@@ -0,0 +1,7 @@
+import {
+  generate
+} from "../../../chunks/chunk-HKTNK262.js";
+import "../../../chunks/chunk-WSFCRVEQ.js";
+export {
+  generate
+};

package/node/encryption/uint8-array/index.js

@@ -3,7 +3,7 @@ import {
   decryptUint8ArrayWithStream,
   encryptUint8Array,
   encryptUint8ArrayWithStream
-} from "../../../chunks/chunk-5QVKJGTN.js";
+} from "../../../chunks/chunk-IJ7SOXLA.js";
 import "../../../chunks/chunk-JMU5PDBD.js";
 import "../../../chunks/chunk-FENXVJYO.js";
 import "../../../chunks/chunk-WSFCRVEQ.js";

package/node/files/index.js

@@ -1,12 +1,12 @@
+import {
+  Subpaths
+} from "../../chunks/chunk-HGCG2J77.js";
 import {
   isInDirectory
 } from "../../chunks/chunk-NRITRUZW.js";
 import {
   readWrite
 } from "../../chunks/chunk-7DBNMU6N.js";
-import {
-  Subpaths
-} from "../../chunks/chunk-HGCG2J77.js";
 import "../../chunks/chunk-LQFKUNVQ.js";
 import "../../chunks/chunk-WSFCRVEQ.js";
 

package/node/ftps/file/download/index.d.ts

@@ -0,0 +1,22 @@
+import { Readable } from 'node:stream';
+import { Client } from 'basic-ftp';
+import { Outcome } from '~/agnostic/misc/outcome';
+export type DownloadOptions = {
+    startAt?: number;
+};
+/**
+ * Downloads a file from a specified FTP server.
+ *
+ * This function downloads a file from the given FTP server at the specified source path,
+ * returning the file content as a Readable stream. The download process can be customized
+ * using optional download options.
+ *
+ * @param {string} sourcePath - The path of the file to be downloaded from the FTP server.
+ * @param {Client} ftpClient - The basic-ftp client instance used to interact with the FTP server.
+ * @param {DownloadOptions} [options] - Optional settings for configuring the download process.
+ * @param {number} [options.startAt] - The byte offset at which to start downloading the file.
+ * @returns {Promise<Outcome.Either<Readable, string>>} A promise that resolves to an Outcome.Either.
+ * - On success: Outcome.makeSuccess(stream) containing the downloaded file's content as a Readable stream.
+ * - On failure: Outcome.makeFailure(errStr) with an error message if the download fails.
+ */
+export declare function download(sourcePath: string, ftpClient: Client, options?: DownloadOptions): Promise<Outcome.Either<Readable, string>>;

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

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

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

@@ -0,0 +1,3 @@
+import * as Download from './download';
+import * as Upload from './upload';
+export { Download, Upload };

package/node/ftps/file/index.js

@@ -0,0 +1,14 @@
+import "../../../chunks/chunk-WO2R3QFK.js";
+import {
+  upload_exports
+} from "../../../chunks/chunk-AIESW26U.js";
+import {
+  download_exports
+} from "../../../chunks/chunk-UJN2WZGO.js";
+import "../../../chunks/chunk-JMU5PDBD.js";
+import "../../../chunks/chunk-FENXVJYO.js";
+import "../../../chunks/chunk-WSFCRVEQ.js";
+export {
+  download_exports as Download,
+  upload_exports as Upload
+};

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

@@ -0,0 +1,24 @@
+import { Readable } from 'node:stream';
+import { Client, UploadOptions as BasicFtpUploadOptions } from 'basic-ftp';
+import { Outcome } from '~/agnostic/misc/outcome';
+export type UploadOptions = BasicFtpUploadOptions & {
+    ensureDir?: boolean;
+    overwrite?: boolean;
+};
+/**
+ * Uploads a file stream to a specified FTP server.
+ *
+ * This function uploads the provided file stream to the given FTP server at the specified target path.
+ * The upload process can be customized using optional upload options.
+ * If the `ensureDir` option is true, it ensures that the target directory exists before uploading.
+ * If the `overwrite` option is false, it prevents overwriting an existing file.
+ *
+ * @param {Readable} fileStream - The file content to be uploaded.
+ * @param {string} targetPath - The target path where the file will be stored on the FTP server.
+ * @param {Client} ftpClient - The basic-ftp client instance used to interact with the FTP server.
+ * @param {UploadOptions} [options] - Optional settings for configuring 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(fileStream: Readable, targetPath: string, ftpClient: Client, options?: UploadOptions): Promise<Outcome.Either<true, string>>;

package/node/ftps/file/upload/index.js

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

package/node/ftps/index.d.ts

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

package/node/ftps/index.js

@@ -0,0 +1,11 @@
+import {
+  file_exports
+} from "../../chunks/chunk-WO2R3QFK.js";
+import "../../chunks/chunk-AIESW26U.js";
+import "../../chunks/chunk-UJN2WZGO.js";
+import "../../chunks/chunk-JMU5PDBD.js";
+import "../../chunks/chunk-FENXVJYO.js";
+import "../../chunks/chunk-WSFCRVEQ.js";
+export {
+  file_exports as File
+};