@design-edito/tools 0.3.10 → 0.3.12

package/node/images/index.js

@@ -1,5 +1,5 @@
 export * as create from './create/index.js'
+export * as format from './format/index.js'
 export * as metadata from './metadata/index.js'
 export * as transform from './transform/index.js'
 export * as utils from './utils/index.js'
-export * as format from './format/index.js'

package/node/images/transform/operations/index.d.ts

@@ -1,15 +1,15 @@
 export * as blur from './blur/index.js'
 export * as brighten from './brighten/index.js'
-export * as extract from './extract/index.js'
 export * as extend from './extend/index.js'
+export * as extract from './extract/index.js'
 export * as flatten from './flatten/index.js'
+export * as flip from './flip/index.js'
 export * as flop from './flop/index.js'
 export * as hue from './hue/index.js'
 export * as level from './level/index.js'
 export * as lighten from './lighten/index.js'
-export * as flip from './flip/index.js'
+export * as normalize from './normalize/index.js'
 export * as overlay from './overlay/index.js'
-export * as rotate from './rotate/index.js'
 export * as resize from './resize/index.js'
-export * as normalize from './normalize/index.js'
+export * as rotate from './rotate/index.js'
 export * as saturate from './saturate/index.js'

package/node/images/transform/operations/index.js

@@ -1,15 +1,15 @@
 export * as blur from './blur/index.js'
 export * as brighten from './brighten/index.js'
-export * as extract from './extract/index.js'
 export * as extend from './extend/index.js'
+export * as extract from './extract/index.js'
 export * as flatten from './flatten/index.js'
+export * as flip from './flip/index.js'
 export * as flop from './flop/index.js'
 export * as hue from './hue/index.js'
 export * as level from './level/index.js'
 export * as lighten from './lighten/index.js'
-export * as flip from './flip/index.js'
+export * as normalize from './normalize/index.js'
 export * as overlay from './overlay/index.js'
-export * as rotate from './rotate/index.js'
 export * as resize from './resize/index.js'
-export * as normalize from './normalize/index.js'
+export * as rotate from './rotate/index.js'
 export * as saturate from './saturate/index.js'

package/node/index.d.ts

@@ -1,11 +1,11 @@
 export * as awsS3 from './@aws-s3/index.js'
 export * as designEdito from './@design-edito/index.js'
-export * as googleCloud from './@google-cloud/index.js'
 export * as express from './@express/index.js'
-export * as encryption from './encryption/index.js'
+export * as googleCloud from './@google-cloud/index.js'
 export * as cloudStorage from './cloud-storage/index.js'
 export * as files from './files/index.js'
-export * as ftps from './ftps/index.js'
+export * as encryption from './encryption/index.js'
 export * as images from './images/index.js'
+export * as ftps from './ftps/index.js'
 export * as process from './process/index.js'
 export * as sftp from './sftp/index.js'

package/node/index.js

@@ -1,11 +1,11 @@
 export * as awsS3 from './@aws-s3/index.js'
 export * as designEdito from './@design-edito/index.js'
-export * as googleCloud from './@google-cloud/index.js'
 export * as express from './@express/index.js'
-export * as encryption from './encryption/index.js'
+export * as googleCloud from './@google-cloud/index.js'
 export * as cloudStorage from './cloud-storage/index.js'
 export * as files from './files/index.js'
-export * as ftps from './ftps/index.js'
+export * as encryption from './encryption/index.js'
 export * as images from './images/index.js'
+export * as ftps from './ftps/index.js'
 export * as process from './process/index.js'
 export * as sftp from './sftp/index.js'

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

@@ -5,6 +5,65 @@ type Output = {
     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.Either<Output, Output>;
+type ThisOptions = {
+    argsPrintFormat?: (args: string[]) => string[];
+    throwOnError?: boolean;
+};
+/**
+ * Options for the asynchronous `spawner` function.
+ *
+ * Extends Node.js `SpawnOptions` with additional behaviors specific to this utility.
+ *
+ * - `argsPrintFormat`: Optional function used to transform the command arguments
+ *   before they are printed to the console (does not affect execution).
+ * - `throwOnError`: If `true`, the function throws when the spawned process exits
+ *   with a non-zero status instead of returning a failure outcome.
+ */
+export type Options = SpawnOptions & ThisOptions;
+/**
+ * Options for the synchronous `spawnerSync` function.
+ *
+ * Extends Node.js `SpawnSyncOptions` with additional behaviors specific to this utility.
+ *
+ * - `argsPrintFormat`: Optional function used to transform the command arguments
+ *   before they are printed to the console (does not affect execution).
+ * - `throwOnError`: If `true`, the function throws when the spawned process exits
+ *   with a non-zero status instead of returning a failure outcome.
+ */
+export type SyncOptions = SpawnSyncOptions & ThisOptions;
+/**
+ * Spawns a child process asynchronously and logs its execution and output.
+ *
+ * Stdout and stderr are streamed, logged in real time, and collected.
+ * The result is returned as an `Outcome.Either`, representing success or failure.
+ *
+ * @param label - Optional label printed before execution to visually group logs.
+ * @param command - The command to execute.
+ * @param args - Arguments passed to the command.
+ * @param options - Optional spawn configuration and utility-specific options:
+ *   - `argsPrintFormat`: Function to format arguments for logging.
+ *   - `throwOnError`: If `true`, rejects on non-zero exit code instead of resolving a failure.
+ * @returns A promise resolving to an `Outcome.Either`:
+ *   - success: `{ stdout, stderr, err }` when the command exits with code `0`
+ *   - failure: `{ stdout, stderr, err }` when the command exits with a non-zero code
+ */
+export declare function spawner(label: string | null, command: string, args: string[], options?: Options): Promise<Outcome.Either<Output, Output>>;
+/**
+ * Spawns a child process synchronously and logs its execution and output.
+ *
+ * Stdout, stderr, and execution errors are logged after the process completes.
+ * The result is returned as an `Outcome.Either`, representing success or failure.
+ *
+ * @param label - Optional label printed before execution to visually group logs.
+ * @param command - The command to execute.
+ * @param args - Arguments passed to the command.
+ * @param options - Optional spawn configuration and utility-specific options:
+ *   - `argsPrintFormat`: Function to format arguments for logging.
+ *   - `throwOnError`: If `true`, throws on non-zero exit code instead of returning a failure.
+ * @returns An `Outcome.Either`:
+ *   - success: `{ stdout, stderr, err }` when the command exits with code `0`
+ *   - failure: `{ stdout, stderr, err }` when the command exits with a non-zero code
+ * @throws Error if `throwOnError` is `true` and the process exits with a non-zero status
+ */
+export declare function spawnerSync(label: string | null, command: string, args: string[], options?: SyncOptions): Outcome.Either<Output, Output>;
 export {};

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) {
+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 });
@@ -33,15 +33,15 @@ async function spawner(label, command, args, argsPrintFormat, throwOnError, opti
       console.log(styles.error(unknownToString(err).replace(ansiRegex(), "").trim()));
     });
     prcss.on("close", (code) => {
-      if (code !== 0 && throwOnError === true) reject(new Error(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 });
@@ -63,7 +63,7 @@ function spawnerSync(label, command, args, argsPrintFormat, throwOnError, option
     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/file/index.d.ts

@@ -1,7 +1,7 @@
-export * as download from './download/index.js'
 export * as copy from './copy/index.js'
-export * as move from './move/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 upload from './upload/index.js'

package/node/sftp/file/index.js

@@ -1,7 +1,7 @@
-export * as download from './download/index.js'
 export * as copy from './copy/index.js'
-export * as move from './move/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 upload from './upload/index.js'