@design-edito/tools 0.3.9 → 0.3.11

package/node/process/spawner/index.js

@@ -8,10 +8,10 @@ import chalk from "chalk";
 import * as Outcome from "../../../agnostic/misc/outcome/index.js";
 import { styles } from "../../../agnostic/misc/logs/styles/index.js";
 import { unknownToString } from "../../../agnostic/errors/unknown-to-string/index.js";
-async function spawner(label, command, args, argsPrintFormat, throwOnError, options) {
-  return new Promise((resolve, reject) => {
+async function spawner(label, command, args, options) {
+  return await new Promise((resolve, reject) => {
     if (label !== null) console.log("\n" + styles.info(label) + "\n");
-    const printableArgs = argsPrintFormat !== void 0 ? argsPrintFormat(args) : args;
+    const printableArgs = options?.argsPrintFormat !== void 0 ? options.argsPrintFormat(args) : args;
     console.log(styles.light(`> ${command} ${printableArgs.join(" ")}
 `));
     const prcss = spawn(command, args, { stdio: "pipe", ...options });
@@ -19,27 +19,29 @@ async function spawner(label, command, args, argsPrintFormat, throwOnError, opti
     let stderr = "";
     let err = null;
     prcss.stdout?.on("data", (data) => {
-      stdout += data.toString();
-      console.log(styles.light(data.toString().replace(ansiRegex(), "").trim()));
+      const strData = unknownToString(data);
+      stdout += strData;
+      console.log(styles.light(strData.replace(ansiRegex(), "").trim()));
     });
     prcss.stderr?.on("data", (data) => {
-      stderr += data.toString();
-      console.log(styles.warning(data.toString().replace(ansiRegex(), "").trim()));
+      const strData = unknownToString(data);
+      stderr += strData;
+      console.log(styles.warning(strData.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);
+      if (code !== 0 && options?.throwOnError === true) reject(new Error(stderr + "\n" + stdout));
       else if (code !== 0) return resolve(Outcome.makeFailure({ stdout, stderr, err }));
       else return resolve(Outcome.makeSuccess({ stdout, stderr, err }));
     });
   });
 }
-function spawnerSync(label, command, args, argsPrintFormat, throwOnError, options) {
+function spawnerSync(label, command, args, options) {
   if (label !== null) console.log("\n" + styles.info(label) + "\n");
-  const printableArgs = argsPrintFormat !== void 0 ? argsPrintFormat(args) : args;
+  const printableArgs = options?.argsPrintFormat !== void 0 ? options.argsPrintFormat(args) : args;
   console.log(styles.light(`> ${command} ${printableArgs.join(" ")}
 `));
   const result = spawnSync(command, args, { stdio: "pipe", encoding: "utf8", ...options });
@@ -51,17 +53,17 @@ function spawnerSync(label, command, args, argsPrintFormat, throwOnError, option
     console.log(styles.error(unknownToString(err).replace(ansiRegex(), "")));
     console.log("");
   }
-  if (stderr) {
+  if (stderr !== "") {
     console.log(styles.light(chalk.italic("stderr:\n")));
     console.log(styles.warning(stderr.replace(ansiRegex(), "")));
     console.log("");
   }
-  if (stdout) {
+  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);
+  if (result.status !== 0 && options?.throwOnError === true) throw new Error(stderr + "\n" + stdout);
   else if (result.status !== 0) return Outcome.makeFailure({ stdout, stderr, err });
   return Outcome.makeSuccess({ stdout, stderr, err });
 }

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

@@ -1,4 +1,5 @@
-import Client, { TransferOptions } from 'ssh2-sftp-client';
+import { type TransferOptions } from 'ssh2-sftp-client';
+import type Client from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type CopyDirOptions = TransferOptions & {
     /**

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

@@ -20,11 +20,11 @@ async function copyDir(sftp, sourceDir, targetDir, options) {
       } else if (entry.type === "-") {
         if (!overwrite) {
           const exists = await sftp.exists(dst);
-          if (exists) throw new Error(`File already exists at ${dst}.`);
+          if (exists !== false) throw new Error(`File already exists at ${dst}.`);
         }
         if (ensureDir) {
           const dirPath = dst.substring(0, dst.lastIndexOf("/"));
-          if (dirPath) await sftp.mkdir(dirPath, true);
+          await sftp.mkdir(dirPath, true);
         }
         const pass = new PassThrough();
         const upload = sftp.put(pass, dst, transferOptions);

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

@@ -1,4 +1,4 @@
 export * as copyDir from './copy-dir/index.js'
-export * as moveDir from './move-dir/index.js'
 export * as list from './list/index.js'
+export * as moveDir from './move-dir/index.js'
 export * as removeDir from './remove-dir/index.js'

package/node/sftp/directory/index.js

@@ -1,4 +1,4 @@
 export * as copyDir from './copy-dir/index.js'
-export * as moveDir from './move-dir/index.js'
 export * as list from './list/index.js'
+export * as moveDir from './move-dir/index.js'
 export * as removeDir from './remove-dir/index.js'

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

@@ -1,4 +1,4 @@
-import Client from 'ssh2-sftp-client';
+import type 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.

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

@@ -1,4 +1,4 @@
-import Client from 'ssh2-sftp-client';
+import type 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. */

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

@@ -6,13 +6,11 @@ async function moveDir(sftp, sourceDir, targetDir, options) {
   try {
     if (ensureDir) {
       const parentDir = targetDir.substring(0, targetDir.lastIndexOf("/"));
-      if (parentDir) {
-        await sftp.mkdir(parentDir, true);
-      }
+      await sftp.mkdir(parentDir, true);
     }
     if (!overwrite) {
       const exists = await sftp.exists(targetDir);
-      if (exists) return Outcome.makeFailure(`Target ${targetDir} already exists.`);
+      if (exists !== false) return Outcome.makeFailure(`Target ${targetDir} already exists.`);
     }
     await sftp.rename(sourceDir, targetDir);
     return Outcome.makeSuccess(true);

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

@@ -1,4 +1,4 @@
-import Client from 'ssh2-sftp-client';
+import type Client from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type RemoveDirOptions = {
     /**
@@ -17,7 +17,7 @@ export type RemoveDirOptions = {
  * @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
+ * - 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.

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

@@ -1,4 +1,5 @@
-import Client, { TransferOptions } from 'ssh2-sftp-client';
+import { type TransferOptions } from 'ssh2-sftp-client';
+import type Client from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type CopyOptions = TransferOptions & {
     /**

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

@@ -11,11 +11,11 @@ async function copy(sftp, sourcePath, targetPath, options) {
   try {
     if (!overwrite) {
       const exists = await sftp.exists(targetPath);
-      if (exists) return Outcome.makeFailure(`File already exists at ${targetPath}.`);
+      if (exists !== false) return Outcome.makeFailure(`File already exists at ${targetPath}.`);
     }
     if (ensureDir) {
       const dirPath = targetPath.substring(0, targetPath.lastIndexOf("/"));
-      if (dirPath) await sftp.mkdir(dirPath, true);
+      await sftp.mkdir(dirPath, true);
     }
     const pass = new PassThrough();
     const uploadPromise = sftp.put(pass, targetPath, transferOptions);

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

@@ -1,6 +1,6 @@
-import { Readable } from 'node:stream';
-import { ReadStreamOptions } from 'ssh2';
-import Client from 'ssh2-sftp-client';
+import { type Readable } from 'node:stream';
+import { type ReadStreamOptions } from 'ssh2';
+import type Client from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type DownloadOptions = ReadStreamOptions;
 /**

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

@@ -1,4 +1,4 @@
-import Client from 'ssh2-sftp-client';
+import type 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.

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

@@ -1,7 +1,7 @@
 export * as copy from './copy/index.js'
 export * as download from './download/index.js'
-export * as exists from './exists/index.js'
+export * as stat from './stat/index.js'
 export * as move from './move/index.js'
 export * as remove from './remove/index.js'
-export * as stat from './stat/index.js'
+export * as exists from './exists/index.js'
 export * as upload from './upload/index.js'

package/node/sftp/file/index.js

@@ -1,7 +1,7 @@
 export * as copy from './copy/index.js'
 export * as download from './download/index.js'
-export * as exists from './exists/index.js'
+export * as stat from './stat/index.js'
 export * as move from './move/index.js'
 export * as remove from './remove/index.js'
-export * as stat from './stat/index.js'
+export * as exists from './exists/index.js'
 export * as upload from './upload/index.js'

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

@@ -1,4 +1,4 @@
-import Client from 'ssh2-sftp-client';
+import type Client from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type MoveOptions = {
     /**
@@ -20,9 +20,9 @@ export type MoveOptions = {
  * 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`
+ * 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
+ * 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.

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

@@ -9,13 +9,11 @@ async function move(sftp, sourcePath, targetPath, options) {
   try {
     if (ensureDir) {
       const dirPath = targetPath.substring(0, targetPath.lastIndexOf("/"));
-      if (dirPath) await sftp.mkdir(dirPath, true);
+      await sftp.mkdir(dirPath, true);
     }
     if (!overwrite) {
-      const exists = await sftp.exists(targetPath);
-      if (exists) {
-        return Outcome.makeFailure(`File already exists at ${targetPath}.`);
-      }
+      const exists = await sftp.exists(targetPath) !== false;
+      if (exists) return Outcome.makeFailure(`File already exists at ${targetPath}.`);
     }
     await sftp.rename(sourcePath, targetPath);
     return Outcome.makeSuccess(true);

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

@@ -1,4 +1,4 @@
-import SftpClient from 'ssh2-sftp-client';
+import type SftpClient from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type RemoveOptions = {
     ignoreMissing?: boolean;

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

@@ -4,7 +4,7 @@ import * as Outcome from "../../../../agnostic/misc/outcome/index.js";
 async function remove(sftp, targetPath, options) {
   const { ignoreMissing = true } = options ?? {};
   try {
-    const exists = await sftp.exists(targetPath);
+    const exists = await sftp.exists(targetPath) !== false;
     if (!exists) {
       if (ignoreMissing) return Outcome.makeSuccess(true);
       return Outcome.makeFailure(`File not found at ${targetPath}.`);

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

@@ -1,4 +1,4 @@
-import SftpClient from 'ssh2-sftp-client';
+import type SftpClient from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export interface Stat {
     size?: number;

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

@@ -6,7 +6,7 @@ async function stat(sftp, path) {
     const info = await sftp.stat(path);
     return Outcome.makeSuccess({
       size: info.size,
-      modifiedAt: info.modifyTime ? new Date(info.modifyTime * 1e3) : void 0,
+      modifiedAt: new Date(info.modifyTime * 1e3),
       mode: info.mode,
       uid: info.uid,
       gid: info.gid,

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

@@ -1,5 +1,6 @@
-import { Readable } from 'node:stream';
-import Client, { TransferOptions } from 'ssh2-sftp-client';
+import type { Readable } from 'node:stream';
+import type Client from 'ssh2-sftp-client';
+import { type TransferOptions } from 'ssh2-sftp-client';
 import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type UploadOptions = TransferOptions & {
     ensureDir?: boolean;

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

@@ -7,7 +7,7 @@ async function upload(sftp, targetPath, fileStream, options) {
     overwrite = false
   } = options ?? {};
   try {
-    const exists = await sftp.exists(targetPath);
+    const exists = await sftp.exists(targetPath) !== false;
     if (exists && !overwrite) return Outcome.makeFailure(`File already exists at ${targetPath}.`);
     if (ensureDir) {
       const dirPath = targetPath.substring(0, targetPath.lastIndexOf("/"));