@design-edito/tools 0.1.71 → 0.1.73

package/node/process/index.js

@@ -5,7 +5,7 @@ import {
   onAllExits,
   onExit
 } from "../../chunks/chunk-LEXQ6E6L.js";
-import "../../chunks/chunk-NZLE2WMY.js";
+import "../../chunks/chunk-WSFCRVEQ.js";
 
 // src/node/process/index.ts
 var forceExitEvents2 = forceExitEvents;

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

@@ -5,7 +5,7 @@ import {
   onAllExits,
   onExit
 } from "../../../chunks/chunk-LEXQ6E6L.js";
-import "../../../chunks/chunk-NZLE2WMY.js";
+import "../../../chunks/chunk-WSFCRVEQ.js";
 export {
   beforeExit,
   beforeForcedExit,

package/node/sftp/directory/copy-dir/index.d.ts

@@ -0,0 +1,28 @@
+import Client, { TransferOptions } from 'ssh2-sftp-client';
+import { Outcome } from '../../../../agnostic/misc/outcome';
+export type CopyDirOptions = TransferOptions & {
+    /**
+     * If `false` and a destination file already exists, copying aborts.
+     * @default false
+     */
+    overwrite?: boolean;
+    /**
+     * When `true`, creates missing directories along the path.
+     * Equivalent to `mkdir -p` using `sftp.mkdir(..., true)`.
+     * @default true
+     */
+    ensureDir?: boolean;
+};
+/**
+ * Recursively copies every file under `sourceDir` to the same relative path
+ * beneath `targetDir` on an SFTP server, streaming data to minimize memory usage.
+ *
+ * @param {Client} sftp - The SFTP client instance.
+ * @param {string} sourceDir - The source directory path to copy from.
+ * @param {string} targetDir - The target directory path to copy to.
+ * @param {CopyDirOptions} [options] - Optional parameters for the operation.
+ * @returns {Promise<Outcome.Either<true, string>>}
+ * - On success: `Outcome.makeSuccess(true)` indicating the copy was successful.
+ * - On failure: `Outcome.makeFailure(errStr)` with an error message if the copy fails.
+ */
+export declare function copyDir(sftp: Client, sourceDir: string, targetDir: string, options?: CopyDirOptions): Promise<Outcome.Either<true, string>>;

package/node/sftp/directory/copy-dir/index.js

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

package/node/sftp/directory/index.d.ts

@@ -0,0 +1,5 @@
+import * as CopyDir from './copy-dir';
+import * as List from './list';
+import * as MoveDir from './move-dir';
+import * as RemoveDir from './remove-dir';
+export { CopyDir, List, MoveDir, RemoveDir };

package/node/sftp/directory/index.js

@@ -0,0 +1,22 @@
+import "../../../chunks/chunk-X33GT7VY.js";
+import {
+  move_dir_exports
+} from "../../../chunks/chunk-RWO53U4X.js";
+import {
+  remove_dir_exports
+} from "../../../chunks/chunk-5ZJ3KJPK.js";
+import {
+  copy_dir_exports
+} from "../../../chunks/chunk-WAHPAZQS.js";
+import {
+  list_exports
+} from "../../../chunks/chunk-UK2F7CWI.js";
+import "../../../chunks/chunk-JMU5PDBD.js";
+import "../../../chunks/chunk-FENXVJYO.js";
+import "../../../chunks/chunk-WSFCRVEQ.js";
+export {
+  copy_dir_exports as CopyDir,
+  list_exports as List,
+  move_dir_exports as MoveDir,
+  remove_dir_exports as RemoveDir
+};

package/node/sftp/directory/list/index.d.ts

@@ -0,0 +1,12 @@
+import Client from 'ssh2-sftp-client';
+import { Outcome } from '../../../../agnostic/misc/outcome';
+/**
+ * Lists all direct children files under a given directory on an SFTP server.
+ *
+ * This function returns only the immediate files (not recursive) under the specified directory.
+ *
+ * @param {Client} sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
+ * @param {string} directoryPath - The directory path to list files under.
+ * @returns {Promise<Outcome.Either<string[], string>>} Returns either a success with an array of file paths, or a failure with an error message.
+ */
+export declare function list(sftp: Client, directoryPath: string): Promise<Outcome.Either<string[], string>>;

package/node/sftp/directory/list/index.js

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

package/node/sftp/directory/move-dir/index.d.ts

@@ -0,0 +1,26 @@
+import Client from 'ssh2-sftp-client';
+import { Outcome } from '../../../../agnostic/misc/outcome';
+export type MoveDirOptions = {
+    /** If false and `targetDir` exists, the operation is aborted. Defaults to false. */
+    overwrite?: boolean;
+    /** If true, ensures the parent directory of `targetDir` exists before moving. Defaults to true. */
+    ensureDir?: boolean;
+};
+/**
+ * Renames (moves) a directory on an SFTP server using `rename`, which moves
+ * the entire tree in one operation when supported by the server.
+ *
+ * If `ensureDir` is true (default), the parent directory of `targetDir` is
+ * created if it does not exist.
+ *
+ * @param {Client} sftp - The SFTP client instance.
+ * @param {string} sourceDir - The source directory path to move from.
+ * @param {string} targetDir - The target directory path to move to.
+ * @param {MoveDirOptions} [options] - Optional parameters for the operation.
+ * @param {boolean} [options.overwrite=false] - If false and `targetDir` exists, abort.
+ * @param {boolean} [options.ensureDir=true] - Whether to create the parent directory of `targetDir`.
+ * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an `Outcome.Either`:
+ * - On success: `Outcome.makeSuccess(true)` indicating the move was successful.
+ * - On failure: `Outcome.makeFailure(errStr)` with an error message if the move fails.
+ */
+export declare function moveDir(sftp: Client, sourceDir: string, targetDir: string, options?: MoveDirOptions): Promise<Outcome.Either<true, string>>;

package/node/sftp/directory/move-dir/index.js

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

package/node/sftp/directory/remove-dir/index.d.ts

@@ -0,0 +1,25 @@
+import Client from 'ssh2-sftp-client';
+import { Outcome } from '../../../../agnostic/misc/outcome';
+export type RemoveDirOptions = {
+    /**
+     * If **true** (default) the function ignores the case where `directoryPath`
+     * does not exist and simply returns success.
+     * If **false** and the path is missing, the function returns a failure.
+     * @default true
+     */
+    ignoreMissing?: boolean;
+};
+/**
+ * Recursively deletes a directory (and all contents) on an SFTP server.
+ *
+ * @param {Client}  sftp           - The SFTP client instance.
+ * @param {string}  directoryPath  - The path of the directory to delete.
+ * @param {RemoveDirOptions} [options] - Optional configuration.
+ * @param {boolean} [options.ignoreMissing=true] - Whether to ignore a missing directory.
+ * @returns {Promise<Outcome.Either<true, string>>}
+ * - On success: `Outcome.makeSuccess(true)` – deletion succeeded, or the
+ *   directory was absent and `ignoreMissing` is true.
+ * - On failure: `Outcome.makeFailure(errStr)` if deletion fails, or directory
+ *   absent and `ignoreMissing` is false.
+ */
+export declare function removeDir(sftp: Client, directoryPath: string, options?: RemoveDirOptions): Promise<Outcome.Either<true, string>>;

package/node/sftp/directory/remove-dir/index.js

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

package/node/sftp/file/copy/index.d.ts

@@ -0,0 +1,28 @@
+import Client, { TransferOptions } from 'ssh2-sftp-client';
+import { Outcome } from '../../../../agnostic/misc/outcome';
+export type CopyOptions = TransferOptions & {
+    /**
+     * If `false` and the target already exists, the operation is aborted.
+     * @default false
+     */
+    overwrite?: boolean;
+    /**
+     * If `true`, ensures that the target directory hierarchy exists before the
+     * upload starts (creates missing folders with `mkdir -p` behaviour).
+     * @default true
+     */
+    ensureDir?: boolean;
+};
+/**
+ * Copies a file from one path to another on the same SFTP server using streams
+ * (avoids loading the entire file into memory).
+ *
+ * @param {Client}  sftp       - The ssh2‑sftp‑client instance.
+ * @param {string}  sourcePath - The path of the source file.
+ * @param {string}  targetPath - The destination path.
+ * @param {CopyOptions} [options] - Optional copy configuration.
+ * @returns {Promise<Outcome.Either<true, string>>}
+ * - On success:  `Outcome.makeSuccess(true)`.
+ * - On failure:  `Outcome.makeFailure(errStr)`.
+ */
+export declare function copy(sftp: Client, sourcePath: string, targetPath: string, options?: CopyOptions): Promise<Outcome.Either<true, string>>;

package/node/sftp/file/copy/index.js

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

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

@@ -10,11 +10,11 @@ export type DownloadOptions = ReadStreamOptions;
  * 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 SFTP server.
  * @param {Client} sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
+ * @param {string} sourcePath - The path of the file to be downloaded from the SFTP server.
  * @param {DownloadOptions} [options] - Optional settings for configuring the download process.
  * @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, sftp: Client, options?: DownloadOptions): Promise<Outcome.Either<Readable, string>>;
+export declare function download(sftp: Client, sourcePath: string, options?: DownloadOptions): Promise<Outcome.Either<Readable, string>>;

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

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

package/node/sftp/file/exists/index.d.ts

@@ -0,0 +1,21 @@
+import Client from 'ssh2-sftp-client';
+import { Outcome } from '../../../../agnostic/misc/outcome';
+/**
+ * Checks if a *file* (not a directory) exists on a specified SFTP server.
+ *
+ * `sftp.exists(path)` resolves to:
+ *   • `'d'` – the path exists and is a **directory**
+ *   • `'-'` – the path exists and is a **regular file**
+ *   • `'l'` – the path exists and is a **symlink**
+ *   • `false` – the path does **not** exist
+ *
+ * For the purpose of this util we treat a regular file (`'-'`) **or** a
+ * symlink (`'l'`) as a “file”. A directory (`'d'`) returns `false`.
+ *
+ * @param {Client} sftp        - The ssh2‑sftp‑client instance.
+ * @param {string} sourcePath  - The path to check.
+ * @returns {Promise<Outcome.Either<boolean, string>>}
+ * - Success: `Outcome.makeSuccess(true | false)` indicating file existence.
+ * - Failure: `Outcome.makeFailure(errStr)` if an error occurs.
+ */
+export declare function exists(sftp: Client, sourcePath: string): Promise<Outcome.Either<boolean, string>>;

package/node/sftp/file/exists/index.js

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

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

@@ -1,3 +1,8 @@
+import * as Copy from './copy';
 import * as Download from './download';
+import * as Exists from './exists';
+import * as Move from './move';
+import * as Remove from './remove';
+import * as Stat from './stat';
 import * as Upload from './upload';
-export { Download, Upload };
+export { Copy, Download, Exists, Move, Remove, Stat, Upload };

package/node/sftp/file/index.js

@@ -1,14 +1,34 @@
-import "../../../chunks/chunk-NA3M6VUU.js";
+import "../../../chunks/chunk-INGSSBWK.js";
 import {
-  download_exports
-} from "../../../chunks/chunk-V4S34MIM.js";
+  move_exports
+} from "../../../chunks/chunk-FE4DECBU.js";
+import {
+  remove_exports
+} from "../../../chunks/chunk-ANPXBD2G.js";
+import {
+  stat_exports
+} from "../../../chunks/chunk-TGVYEQIA.js";
 import {
   upload_exports
-} from "../../../chunks/chunk-45WKBXSF.js";
+} from "../../../chunks/chunk-QDVDHFMZ.js";
+import {
+  copy_exports
+} from "../../../chunks/chunk-QH64MYGA.js";
+import {
+  download_exports
+} from "../../../chunks/chunk-HWEGQVBQ.js";
+import {
+  exists_exports
+} from "../../../chunks/chunk-QVPS2BCJ.js";
 import "../../../chunks/chunk-JMU5PDBD.js";
 import "../../../chunks/chunk-FENXVJYO.js";
-import "../../../chunks/chunk-NZLE2WMY.js";
+import "../../../chunks/chunk-WSFCRVEQ.js";
 export {
+  copy_exports as Copy,
   download_exports as Download,
+  exists_exports as Exists,
+  move_exports as Move,
+  remove_exports as Remove,
+  stat_exports as Stat,
   upload_exports as Upload
 };

package/node/sftp/file/move/index.d.ts

@@ -0,0 +1,38 @@
+import Client from 'ssh2-sftp-client';
+import { Outcome } from '../../../../agnostic/misc/outcome';
+export type MoveOptions = {
+    /**
+     * When `true`, ensures that the parent directory of `targetPath` exists
+     * before attempting the rename (`mkdir` with the recursive flag).
+     * @default true
+     */
+    ensureDir?: boolean;
+    /**
+     * When `false` (default) and `targetPath` already exists, the move is aborted
+     * and a failure is returned.
+     * @default false
+     */
+    overwrite?: boolean;
+};
+/**
+ * Moves (renames) a file on an SFTP server.
+ *
+ * The function uses `rename`, which atomically moves the file from
+ * `sourcePath` to `targetPath`.  It supports two safety features:
+ *
+ * 1. **ensureDir** – If enabled, the parent directory of `targetPath`
+ *    is created with `mkdir -p` semantics before the rename.
+ * 2. **overwrite** – If disabled (default) the function first checks whether
+ *    something already exists at `targetPath`; if so, it aborts.
+ *
+ * @param {Client} sftp          - The ssh2‑sftp‑client instance.
+ * @param {string} sourcePath    - The full path of the source file.
+ * @param {string} targetPath    - The full destination path.
+ * @param {MoveOptions} [options] - Optional move configuration.
+ * @param {boolean} [options.ensureDir=true]  - Whether to create missing parent directories.
+ * @param {boolean} [options.overwrite=false] - Whether to overwrite an existing destination.
+ * @returns {Promise<Outcome.Either<true, string>>}
+ * - On success:  `Outcome.makeSuccess(true)`.
+ * - On failure:  `Outcome.makeFailure(errStr)`.
+ */
+export declare function move(sftp: Client, sourcePath: string, targetPath: string, options?: MoveOptions): Promise<Outcome.Either<true, string>>;

package/node/sftp/file/move/index.js

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

package/node/sftp/file/remove/index.d.ts

@@ -0,0 +1,20 @@
+import SftpClient from 'ssh2-sftp-client';
+import { Outcome } from '../../../../agnostic/misc/outcome';
+export type RemoveOptions = {
+    ignoreMissing?: boolean;
+};
+/**
+ * Deletes a file from a specified SFTP server.
+ *
+ * This function removes the file located at the given path on the SFTP server.
+ * The deletion process can be customized using optional delete options.
+ * If the `ignoreMissing` option is true, it does not treat a missing file as an error.
+ *
+ * @param {SftpClient} sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
+ * @param {string} targetPath - The path of the file to delete on the SFTP server.
+ * @param {RemoveOptions} [options] - Optional settings for configuring the deletion process.
+ * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an Outcome.Either.
+ * - On success: Outcome.makeSuccess(true) indicating the deletion was successful.
+ * - On failure: Outcome.makeFailure(errStr) with an error message if the deletion fails.
+ */
+export declare function remove(sftp: SftpClient, targetPath: string, options?: RemoveOptions): Promise<Outcome.Either<true, string>>;

package/node/sftp/file/remove/index.js

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

package/node/sftp/file/stat/index.d.ts

@@ -0,0 +1,18 @@
+import SftpClient from 'ssh2-sftp-client';
+import { Outcome } from '../../../../agnostic/misc/outcome';
+export interface Stat {
+    size?: number;
+    modifiedAt?: Date;
+    mode?: number;
+    uid?: number;
+    gid?: number;
+    raw: SftpClient.FileStats;
+}
+/**
+ * Retrieves metadata for a file on an SFTP server.
+ *
+ * @param {SftpClient} sftp – ssh2-sftp-client.
+ * @param {string} path     – Remote file path.
+ * @returns {Promise<Outcome.Either<Stat, string>>}
+ */
+export declare function stat(sftp: SftpClient, path: string): Promise<Outcome.Either<Stat, string>>;

package/node/sftp/file/stat/index.js

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

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

@@ -13,12 +13,12 @@ export type UploadOptions = TransferOptions & {
  * If the `ensureDir` option is true, it ensures that the target directory exists before uploading.
  * If the `overwrite` option is false and a file already exists at the target path, the upload is aborted.
  *
- * @param {Readable} fileStream - The file content to be uploaded.
- * @param {string} targetPath - The target path where the file will be stored on the SFTP server.
  * @param {Client} sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
+ * @param {string} targetPath - The target path where the file will be stored on the SFTP server.
+ * @param {Readable} fileStream - The file content to be uploaded.
  * @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, sftp: Client, options?: UploadOptions): Promise<Outcome.Either<true, string>>;
+export declare function upload(sftp: Client, targetPath: string, fileStream: Readable, options?: UploadOptions): Promise<Outcome.Either<true, string>>;

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

@@ -1,9 +1,9 @@
 import {
   upload
-} from "../../../../chunks/chunk-45WKBXSF.js";
+} from "../../../../chunks/chunk-QDVDHFMZ.js";
 import "../../../../chunks/chunk-JMU5PDBD.js";
 import "../../../../chunks/chunk-FENXVJYO.js";
-import "../../../../chunks/chunk-NZLE2WMY.js";
+import "../../../../chunks/chunk-WSFCRVEQ.js";
 export {
   upload
 };

package/node/sftp/index.d.ts

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

package/node/sftp/index.js

@@ -1,11 +1,24 @@
+import {
+  directory_exports
+} from "../../chunks/chunk-X33GT7VY.js";
 import {
   file_exports
-} from "../../chunks/chunk-NA3M6VUU.js";
-import "../../chunks/chunk-V4S34MIM.js";
-import "../../chunks/chunk-45WKBXSF.js";
+} from "../../chunks/chunk-INGSSBWK.js";
+import "../../chunks/chunk-FE4DECBU.js";
+import "../../chunks/chunk-RWO53U4X.js";
+import "../../chunks/chunk-5ZJ3KJPK.js";
+import "../../chunks/chunk-ANPXBD2G.js";
+import "../../chunks/chunk-TGVYEQIA.js";
+import "../../chunks/chunk-QDVDHFMZ.js";
+import "../../chunks/chunk-WAHPAZQS.js";
+import "../../chunks/chunk-QH64MYGA.js";
+import "../../chunks/chunk-HWEGQVBQ.js";
+import "../../chunks/chunk-QVPS2BCJ.js";
+import "../../chunks/chunk-UK2F7CWI.js";
 import "../../chunks/chunk-JMU5PDBD.js";
 import "../../chunks/chunk-FENXVJYO.js";
-import "../../chunks/chunk-NZLE2WMY.js";
+import "../../chunks/chunk-WSFCRVEQ.js";
 export {
+  directory_exports as Directory,
   file_exports as File
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@design-edito/tools",
-  "version": "0.1.71",
+  "version": "0.1.73",
   "description": "",
   "author": "Maxime Fabas",
   "license": "ISC",
@@ -12,9 +12,10 @@
   "main": "index.js",
   "module": "index.js",
   "peerDependencies": {
+    "@aws-sdk/client-s3": "^3.842.0",
+    "@aws-sdk/lib-storage": "^3.842.0",
     "@google-cloud/storage": "^7.16.0",
     "archiver": "^7.0.1",
-    "aws-sdk": "^2.1692.0",
     "basic-ftp": "^5.0.5",
     "chalk": "^5.4.1",
     "express": "^5.1.0",