@design-edito/tools 0.3.0 → 1.0.1

package/node/process/spawner/index.d.ts

@@ -1,18 +0,0 @@
-import { type SpawnOptions, type SpawnSyncOptions } from 'node:child_process';
-import * as Outcome from '../../../agnostic/misc/outcome/index.js';
-type Output = {
-    stdout: string;
-    stderr: string;
-    err: unknown;
-};
-export declare function spawner(label: string | null, command: string, args: string[], argsPrintFormat?: (args: string[]) => string[], throwOnError?: boolean, options?: SpawnOptions): Promise<Outcome.Either<Output, Output>>;
-export declare function spawnerSync(label: string | null, command: string, args: string[], argsPrintFormat?: (args: string[]) => string[], throwOnError?: boolean, options?: SpawnSyncOptions): Outcome.Failure<{
-    stdout: string;
-    stderr: string;
-    err: Error | undefined;
-}> | Outcome.Success<{
-    stdout: string;
-    stderr: string;
-    err: Error | undefined;
-}>;
-export {};

package/node/process/spawner/index.js

@@ -1,83 +0,0 @@
-import {
-  ansiRegex
-} from "../../../chunks/chunk-4WE2WEXL.js";
-import {
-  styles
-} from "../../../chunks/chunk-L3OCRR3V.js";
-import "../../../chunks/chunk-H4PP6AHP.js";
-import {
-  makeFailure,
-  makeSuccess
-} from "../../../chunks/chunk-QEKI6WGQ.js";
-import {
-  unknownToString
-} from "../../../chunks/chunk-FENXVJYO.js";
-import "../../../chunks/chunk-XCBH6NLF.js";
-
-// src/node/process/spawner/index.ts
-import {
-  spawn,
-  spawnSync
-} from "node:child_process";
-import chalk from "chalk";
-async function spawner(label, command, args, argsPrintFormat, throwOnError, options) {
-  return new Promise((resolve, reject) => {
-    if (label !== null) console.log("\n" + styles.info(label) + "\n");
-    const printableArgs = argsPrintFormat !== void 0 ? argsPrintFormat(args) : args;
-    console.log(styles.light(`> ${command} ${printableArgs.join(" ")}
-`));
-    const prcss = spawn(command, args, { stdio: "pipe", ...options });
-    let stdout = "";
-    let stderr = "";
-    let err = null;
-    prcss.stdout?.on("data", (data) => {
-      stdout += data.toString();
-      console.log(styles.light(data.toString().replace(ansiRegex(), "").trim()));
-    });
-    prcss.stderr?.on("data", (data) => {
-      stderr += data.toString();
-      console.log(styles.warning(data.toString().replace(ansiRegex(), "").trim()));
-    });
-    prcss.on("error", (e) => {
-      err = e;
-      console.log(styles.error(unknownToString(err).replace(ansiRegex(), "").trim()));
-    });
-    prcss.on("close", (code) => {
-      if (code !== 0 && throwOnError === true) reject(stderr + "\n" + stdout);
-      else if (code !== 0) return resolve(makeFailure({ stdout, stderr, err }));
-      else return resolve(makeSuccess({ stdout, stderr, err }));
-    });
-  });
-}
-function spawnerSync(label, command, args, argsPrintFormat, throwOnError, options) {
-  if (label !== null) console.log("\n" + styles.info(label) + "\n");
-  const printableArgs = argsPrintFormat !== void 0 ? argsPrintFormat(args) : args;
-  console.log(styles.light(`> ${command} ${printableArgs.join(" ")}
-`));
-  const result = spawnSync(command, args, { stdio: "pipe", encoding: "utf8", ...options });
-  const stderr = result.stderr?.toString().trim();
-  const stdout = result.stdout?.toString().trim();
-  const err = result.error;
-  if (err !== void 0) {
-    console.log(styles.light(chalk.italic("err:\n")));
-    console.log(styles.error(unknownToString(err).replace(ansiRegex(), "")));
-    console.log("");
-  }
-  if (stderr) {
-    console.log(styles.light(chalk.italic("stderr:\n")));
-    console.log(styles.warning(stderr.replace(ansiRegex(), "")));
-    console.log("");
-  }
-  if (stdout) {
-    console.log(styles.light(chalk.italic("stdout:\n")));
-    console.log(styles.light(stdout.replace(ansiRegex(), "")));
-    console.log("");
-  }
-  if (result.status !== 0 && throwOnError === true) throw new Error(stderr + "\n" + stdout);
-  else if (result.status !== 0) return makeFailure({ stdout, stderr, err });
-  return makeSuccess({ stdout, stderr, err });
-}
-export {
-  spawner,
-  spawnerSync
-};

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

@@ -1,28 +0,0 @@
-import Client, { TransferOptions } from 'ssh2-sftp-client';
-import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
-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

@@ -1,9 +0,0 @@
-import {
-  copyDir
-} from "../../../../chunks/chunk-OF2W4ZRG.js";
-import "../../../../chunks/chunk-QEKI6WGQ.js";
-import "../../../../chunks/chunk-FENXVJYO.js";
-import "../../../../chunks/chunk-XCBH6NLF.js";
-export {
-  copyDir
-};

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

@@ -1,12 +0,0 @@
-import Client from 'ssh2-sftp-client';
-import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
-/**
- * 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

@@ -1,9 +0,0 @@
-import {
-  list
-} from "../../../../chunks/chunk-EBQRPRRC.js";
-import "../../../../chunks/chunk-QEKI6WGQ.js";
-import "../../../../chunks/chunk-FENXVJYO.js";
-import "../../../../chunks/chunk-XCBH6NLF.js";
-export {
-  list
-};

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

@@ -1,26 +0,0 @@
-import Client from 'ssh2-sftp-client';
-import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
-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

@@ -1,9 +0,0 @@
-import {
-  moveDir
-} from "../../../../chunks/chunk-JN2UETL4.js";
-import "../../../../chunks/chunk-QEKI6WGQ.js";
-import "../../../../chunks/chunk-FENXVJYO.js";
-import "../../../../chunks/chunk-XCBH6NLF.js";
-export {
-  moveDir
-};

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

@@ -1,25 +0,0 @@
-import Client from 'ssh2-sftp-client';
-import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
-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

@@ -1,9 +0,0 @@
-import {
-  removeDir
-} from "../../../../chunks/chunk-6YVXSCRH.js";
-import "../../../../chunks/chunk-QEKI6WGQ.js";
-import "../../../../chunks/chunk-FENXVJYO.js";
-import "../../../../chunks/chunk-XCBH6NLF.js";
-export {
-  removeDir
-};

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

@@ -1,28 +0,0 @@
-import Client, { TransferOptions } from 'ssh2-sftp-client';
-import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
-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

@@ -1,9 +0,0 @@
-import {
-  copy
-} from "../../../../chunks/chunk-O7UCJNVF.js";
-import "../../../../chunks/chunk-QEKI6WGQ.js";
-import "../../../../chunks/chunk-FENXVJYO.js";
-import "../../../../chunks/chunk-XCBH6NLF.js";
-export {
-  copy
-};

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

@@ -1,20 +0,0 @@
-import { Readable } from 'node:stream';
-import { ReadStreamOptions } from 'ssh2';
-import Client from 'ssh2-sftp-client';
-import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
-export type DownloadOptions = ReadStreamOptions;
-/**
- * Downloads a file from a specified SFTP server.
- *
- * This function downloads a file from the given SFTP 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 {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(sftp: Client, sourcePath: string, options?: DownloadOptions): Promise<Outcome.Either<Readable, string>>;

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

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

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

@@ -1,21 +0,0 @@
-import Client from 'ssh2-sftp-client';
-import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
-/**
- * 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

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

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

@@ -1,38 +0,0 @@
-import Client from 'ssh2-sftp-client';
-import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
-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

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

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

@@ -1,20 +0,0 @@
-import SftpClient from 'ssh2-sftp-client';
-import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
-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

@@ -1,9 +0,0 @@
-import {
-  remove
-} from "../../../../chunks/chunk-BHGRXDTS.js";
-import "../../../../chunks/chunk-QEKI6WGQ.js";
-import "../../../../chunks/chunk-FENXVJYO.js";
-import "../../../../chunks/chunk-XCBH6NLF.js";
-export {
-  remove
-};

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

@@ -1,18 +0,0 @@
-import SftpClient from 'ssh2-sftp-client';
-import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
-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

@@ -1,9 +0,0 @@
-import {
-  stat
-} from "../../../../chunks/chunk-EEPLTO3E.js";
-import "../../../../chunks/chunk-QEKI6WGQ.js";
-import "../../../../chunks/chunk-FENXVJYO.js";
-import "../../../../chunks/chunk-XCBH6NLF.js";
-export {
-  stat
-};

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

@@ -1,24 +0,0 @@
-import { Readable } from 'node:stream';
-import Client, { TransferOptions } from 'ssh2-sftp-client';
-import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
-export type UploadOptions = TransferOptions & {
-    ensureDir?: boolean;
-    overwrite?: boolean;
-};
-/**
- * Uploads a file stream to a specified SFTP server.
- *
- * This function uploads the provided file stream to the given SFTP 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 and a file already exists at the target path, the upload is aborted.
- *
- * @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(sftp: Client, targetPath: string, fileStream: Readable, options?: UploadOptions): Promise<Outcome.Either<true, string>>;

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

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