@design-edito/tools 0.4.4 → 0.4.6

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

@@ -1,9 +1,28 @@
-import {
-  stat
-} from "../../../../chunks/chunk-S2UZ3HZR.js";
-import "../../../../chunks/chunk-LUAYN7VJ.js";
-import "../../../../chunks/chunk-PUQUSA6S.js";
-import "../../../../chunks/chunk-WSFCRVEQ.js";
-export {
-  stat
-};
+import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
+import { unknownToString } from '../../../../agnostic/errors/unknown-to-string/index.js';
+/**
+ * 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 async function stat(sftp, path) {
+    try {
+        const info = await sftp.stat(path); // throws if not found
+        return Outcome.makeSuccess({
+            size: info.size,
+            modifiedAt: new Date(info.modifyTime * 1000),
+            mode: info.mode,
+            uid: info.uid,
+            gid: info.gid,
+            raw: info
+        });
+    }
+    catch (err) {
+        if (err.code === 2 || err.code === 'ENOENT') {
+            return Outcome.makeFailure(`File not found: ${path}`);
+        }
+        return Outcome.makeFailure(unknownToString(err));
+    }
+}

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

@@ -1,9 +1,36 @@
-import {
-  upload
-} from "../../../../chunks/chunk-H3HRQ52T.js";
-import "../../../../chunks/chunk-LUAYN7VJ.js";
-import "../../../../chunks/chunk-PUQUSA6S.js";
-import "../../../../chunks/chunk-WSFCRVEQ.js";
-export {
-  upload
-};
+import { unknownToString } from '../../../../agnostic/errors/unknown-to-string/index.js';
+import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
+/**
+ * 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 async function upload(sftp, targetPath, fileStream, options) {
+    const { ensureDir = true, overwrite = false } = options ?? {};
+    try {
+        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('/'));
+            await sftp.mkdir(dirPath, true);
+        }
+        await sftp.put(fileStream, targetPath, options);
+        return Outcome.makeSuccess(true);
+    }
+    catch (err) {
+        const errStr = unknownToString(err);
+        return Outcome.makeFailure(errStr);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@design-edito/tools",
-  "version": "0.4.4",
+  "version": "0.4.6",
   "description": "",
   "author": "Maxime Fabas",
   "license": "ISC",
@@ -1314,13 +1314,6 @@
       "import": "./agnostic/typescript/types.js",
       "types": "./agnostic/typescript/types.d.ts"
     },
-    "./chunks": {
-      "import": "./chunks/index.js",
-      "types": "./chunks/index.d.ts"
-    },
-    "./chunks/index.js": {
-      "import": "./chunks/index.js"
-    },
     "./components": {
       "import": "./components/index.js",
       "types": "./components/index.d.ts"

package/chunks/chunk-2FNCUXAX.js

@@ -1,27 +0,0 @@
-import {
-  makeFailure,
-  makeSuccess
-} from "./chunk-LUAYN7VJ.js";
-import {
-  unknownToString
-} from "./chunk-PUQUSA6S.js";
-
-// src/node/ftps/file/exists/index.ts
-import { FileType } from "basic-ftp";
-async function exists(ftpClient, sourcePath) {
-  try {
-    const lastSlash = sourcePath.lastIndexOf("/");
-    const parentDir = lastSlash === -1 ? "." : sourcePath.slice(0, lastSlash) || "/";
-    const baseName = lastSlash === -1 ? sourcePath : sourcePath.slice(lastSlash + 1);
-    const list = await ftpClient.list(parentDir);
-    const entry = list.find((e) => e.name === baseName);
-    const isFile = entry !== void 0 ? entry.type === FileType.File || entry.type === FileType.SymbolicLink : false;
-    return makeSuccess(isFile);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-export {
-  exists
-};

package/chunks/chunk-2GJSPEO4.js

@@ -1,31 +0,0 @@
-import {
-  makeFailure,
-  makeSuccess
-} from "./chunk-LUAYN7VJ.js";
-import {
-  unknownToString
-} from "./chunk-PUQUSA6S.js";
-
-// src/node/@aws-s3/storage/file/download/index.ts
-import {
-  GetObjectCommand
-} from "@aws-sdk/client-s3";
-async function download(client, bucketName, sourcePath, options) {
-  try {
-    const response = await client.send(
-      new GetObjectCommand({
-        Bucket: bucketName,
-        Key: sourcePath,
-        ...options
-      })
-    );
-    const stream = response.Body;
-    return makeSuccess(stream);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-export {
-  download
-};

package/chunks/chunk-2IGP6V77.js

@@ -1,22 +0,0 @@
-import {
-  makeFailure,
-  makeSuccess
-} from "./chunk-LUAYN7VJ.js";
-import {
-  unknownToString
-} from "./chunk-PUQUSA6S.js";
-
-// src/node/sftp/directory/list/index.ts
-async function list(sftp, directoryPath) {
-  try {
-    const list2 = await sftp.list(directoryPath);
-    const files = list2.filter((entry) => entry.type === "-").map((entry) => directoryPath.endsWith("/") ? directoryPath + entry.name : directoryPath + "/" + entry.name);
-    return makeSuccess(files);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-export {
-  list
-};

package/chunks/chunk-3QI2MSDK.js

@@ -1,34 +0,0 @@
-import {
-  makeFailure,
-  makeSuccess
-} from "./chunk-LUAYN7VJ.js";
-import {
-  unknownToString
-} from "./chunk-PUQUSA6S.js";
-
-// src/node/@google-cloud/storage/file/copy/index.ts
-async function copy(bucket, sourcePath, targetPath, options) {
-  const {
-    fileOptions,
-    copyOptions,
-    overwrite = false
-  } = options ?? {};
-  try {
-    const srcFile = bucket.file(sourcePath, fileOptions);
-    const destFile = bucket.file(targetPath, fileOptions);
-    if (!overwrite) {
-      const [destExists] = await destFile.exists();
-      if (destExists) {
-        return makeFailure(`Object already exists at ${targetPath}.`);
-      }
-    }
-    await srcFile.copy(destFile, copyOptions);
-    return makeSuccess(true);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-export {
-  copy
-};

package/chunks/chunk-3RNLPW7B.js

@@ -1,101 +0,0 @@
-import {
-  isDuckTypedSharpInstance,
-  toSharpInstance
-} from "./chunk-HMMPT3UM.js";
-import {
-  makeFailure,
-  makeSuccess
-} from "./chunk-LUAYN7VJ.js";
-import {
-  isColor
-} from "./chunk-OBSTP7YR.js";
-
-// src/node/images/transform/operations/overlay/index.ts
-import sharp from "sharp";
-import z from "zod";
-function isOverlayOperationParams(obj) {
-  const schema = z.object({
-    input: z.union([
-      z.custom(isDuckTypedSharpInstance),
-      z.custom((data) => Buffer.isBuffer(data)),
-      z.string(),
-      z.object({
-        width: z.number().optional(),
-        height: z.number().optional(),
-        channels: z.union([z.literal(3), z.literal(4)]).optional(),
-        background: z.custom(isColor).optional(),
-        noise: z.object({
-          mean: z.number().optional(),
-          sigma: z.number().optional()
-        }).optional(),
-        pageHeight: z.number().optional()
-      })
-    ]),
-    top: z.number().optional(),
-    left: z.number().optional(),
-    tile: z.boolean().optional(),
-    premultiplied: z.boolean().optional(),
-    density: z.number().optional(),
-    animated: z.boolean().optional(),
-    autoOrient: z.boolean().optional(),
-    ignoreIcc: z.boolean().optional(),
-    pages: z.number().optional(),
-    page: z.number().optional(),
-    blend: z.enum([
-      "clear",
-      "source",
-      "over",
-      "in",
-      "out",
-      "atop",
-      "dest",
-      "dest-over",
-      "dest-in",
-      "dest-out",
-      "dest-atop",
-      "xor",
-      "add",
-      "saturate",
-      "multiply",
-      "screen",
-      "overlay",
-      "darken",
-      "lighten",
-      "color-dodge",
-      "colour-dodge",
-      "color-burn",
-      "colour-burn",
-      "hard-light",
-      "soft-light",
-      "difference",
-      "exclusion"
-    ]).optional(),
-    gravity: z.enum([
-      "north",
-      "northeast",
-      "southeast",
-      "south",
-      "southwest",
-      "west",
-      "northwest",
-      "east",
-      "center",
-      "centre"
-    ]).optional()
-  });
-  const result = schema.safeParse(obj);
-  if (!result.success) return makeFailure(result.error.message);
-  return makeSuccess(result.data);
-}
-async function overlay(sharpInstance, params) {
-  const inputBuffer = params.input instanceof Buffer ? params.input : await (await toSharpInstance(params.input)).toBuffer();
-  return sharp(await sharpInstance.composite([{
-    ...params,
-    input: inputBuffer
-  }]).webp().toBuffer());
-}
-
-export {
-  isOverlayOperationParams,
-  overlay
-};

package/chunks/chunk-3RZMW72G.js

@@ -1,33 +0,0 @@
-import {
-  makeFailure,
-  makeSuccess
-} from "./chunk-LUAYN7VJ.js";
-import {
-  unknownToString
-} from "./chunk-PUQUSA6S.js";
-
-// src/node/@aws-s3/storage/directory/list/index.ts
-import {
-  ListObjectsV2Command
-} from "@aws-sdk/client-s3";
-async function list(client, bucketName, directoryPath, options) {
-  const prefix = directoryPath.endsWith("/") ? directoryPath : `${directoryPath}/`;
-  try {
-    const response = await client.send(
-      new ListObjectsV2Command({
-        Bucket: bucketName,
-        Prefix: prefix,
-        Delimiter: "/",
-        ...options
-      })
-    );
-    const keys = (response.Contents ?? []).map((obj) => obj.Key).filter((e) => e !== void 0);
-    return makeSuccess(keys);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-export {
-  list
-};

package/chunks/chunk-4KLCJX2T.js

@@ -1,36 +0,0 @@
-import {
-  makeFailure,
-  makeSuccess
-} from "./chunk-LUAYN7VJ.js";
-import {
-  unknownToString
-} from "./chunk-PUQUSA6S.js";
-
-// src/node/@google-cloud/storage/file/move/index.ts
-async function move(bucket, sourcePath, targetPath, options) {
-  const {
-    fileOptions,
-    copyOptions,
-    deleteOptions,
-    overwrite = false
-  } = options ?? {};
-  try {
-    const srcFile = bucket.file(sourcePath, fileOptions);
-    const destFile = bucket.file(targetPath, fileOptions);
-    if (!overwrite) {
-      const [exists] = await destFile.exists();
-      if (exists) {
-        return makeFailure(`Object already exists at ${targetPath}.`);
-      }
-    }
-    await srcFile.copy(destFile, copyOptions);
-    await srcFile.delete(deleteOptions);
-    return makeSuccess(true);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-export {
-  move
-};

package/chunks/chunk-4LTN4SCD.js

@@ -1,55 +0,0 @@
-import {
-  makeFailure,
-  makeSuccess
-} from "./chunk-LUAYN7VJ.js";
-import {
-  unknownToString
-} from "./chunk-PUQUSA6S.js";
-
-// src/node/ftps/directory/copy-dir/index.ts
-import { PassThrough } from "node:stream";
-async function copyDir(ftpClient, sourceDir, targetDir, options) {
-  const {
-    overwrite = false,
-    ensureDir = true
-  } = options ?? {};
-  async function recurse(dir) {
-    const list = await ftpClient.list(dir);
-    for (const entry of list) {
-      const src = dir.endsWith("/") ? dir + entry.name : dir + "/" + entry.name;
-      const rel = src.substring(sourceDir.length + (sourceDir.endsWith("/") ? 0 : 1));
-      const dst = targetDir.endsWith("/") ? targetDir + rel : `${targetDir}/${rel}`;
-      if (entry.isDirectory) {
-        if (ensureDir) await ftpClient.ensureDir(dst);
-        await recurse(src);
-      } else if (entry.isFile) {
-        if (!overwrite) {
-          try {
-            await ftpClient.size(dst);
-            throw new Error(`File already exists at ${dst}.`);
-          } catch {
-          }
-        }
-        if (ensureDir) {
-          const dirPath = dst.substring(0, dst.lastIndexOf("/"));
-          await ftpClient.ensureDir(dirPath);
-        }
-        const pass = new PassThrough();
-        const upload = ftpClient.uploadFrom(pass, dst);
-        await ftpClient.downloadTo(pass, src);
-        await upload;
-      }
-    }
-  }
-  try {
-    if (ensureDir) await ftpClient.ensureDir(targetDir);
-    await recurse(sourceDir);
-    return makeSuccess(true);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-export {
-  copyDir
-};

package/chunks/chunk-4Q4T7QQO.js

@@ -1,27 +0,0 @@
-import {
-  makeFailure,
-  makeSuccess
-} from "./chunk-LUAYN7VJ.js";
-import {
-  unknownToString
-} from "./chunk-PUQUSA6S.js";
-
-// src/node/@google-cloud/storage/file/download/index.ts
-async function download(bucket, sourcePath, options) {
-  const { fileOptions, downloadOptions } = options ?? {};
-  try {
-    const file = bucket.file(sourcePath, fileOptions);
-    const stream = file.createReadStream(downloadOptions);
-    stream.on("error", (err) => {
-      throw err;
-    });
-    return makeSuccess(stream);
-  } catch (err) {
-    const errStr = unknownToString(err);
-    return makeFailure(errStr);
-  }
-}
-
-export {
-  download
-};

package/chunks/chunk-4Q5TKOIG.js

@@ -1,53 +0,0 @@
-import {
-  makeFailure,
-  makeSuccess
-} from "./chunk-LUAYN7VJ.js";
-import {
-  unknownToString
-} from "./chunk-PUQUSA6S.js";
-
-// src/node/sftp/directory/copy-dir/index.ts
-import { PassThrough } from "node:stream";
-async function copyDir(sftp, sourceDir, targetDir, options) {
-  const {
-    overwrite = false,
-    ensureDir = true,
-    ...transferOptions
-  } = options ?? {};
-  async function recurse(dir) {
-    const list = await sftp.list(dir);
-    for (const entry of list) {
-      const src = dir.endsWith("/") ? dir + entry.name : dir + "/" + entry.name;
-      const rel = src.substring(sourceDir.length + (sourceDir.endsWith("/") ? 0 : 1));
-      const dst = targetDir.endsWith("/") ? targetDir + rel : `${targetDir}/${rel}`;
-      if (entry.type === "d") {
-        if (ensureDir) await sftp.mkdir(dst, true);
-        await recurse(src);
-      } else if (entry.type === "-") {
-        if (!overwrite) {
-          const exists = await sftp.exists(dst);
-          if (exists !== false) throw new Error(`File already exists at ${dst}.`);
-        }
-        if (ensureDir) {
-          const dirPath = dst.substring(0, dst.lastIndexOf("/"));
-          await sftp.mkdir(dirPath, true);
-        }
-        const pass = new PassThrough();
-        const upload = sftp.put(pass, dst, transferOptions);
-        await sftp.get(src, pass, transferOptions);
-        await upload;
-      }
-    }
-  }
-  try {
-    if (ensureDir) await sftp.mkdir(targetDir, true);
-    await recurse(sourceDir);
-    return makeSuccess(true);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-export {
-  copyDir
-};

package/chunks/chunk-57YKZBJR.js

@@ -1,29 +0,0 @@
-// src/agnostic/misc/crossenv/window/index.ts
-function exists() {
-  return typeof globalThis !== "undefined" && "window" in globalThis;
-}
-var _window = exists() ? globalThis.window ?? null : null;
-function set(customWindow) {
-  _window = customWindow;
-  return customWindow;
-}
-function unset() {
-  if (exists()) {
-    _window = globalThis.window;
-  } else {
-    _window = null;
-  }
-  return _window;
-}
-function get() {
-  if (_window !== null) return _window;
-  const message = "window is undefined. Please call Window.setWindow(windowObj) before using Window.get.";
-  throw new Error(message);
-}
-
-export {
-  exists,
-  set,
-  unset,
-  get
-};

package/chunks/chunk-5H3IRSOB.js

@@ -1,8 +0,0 @@
-// src/agnostic/misc/is-constructor-function/index.ts
-function isConstructorFunction(input) {
-  return typeof input === "function" && "prototype" in input && typeof input.prototype === "object" && "constructor" in input.prototype && input.prototype.constructor === input;
-}
-
-export {
-  isConstructorFunction
-};

package/chunks/chunk-5NTPCRFH.js

@@ -1,32 +0,0 @@
-// src/node/images/types.ts
-var OpName = /* @__PURE__ */ ((OpName2) => {
-  OpName2["BLUR"] = "blur";
-  OpName2["BRIGHTEN"] = "brighten";
-  OpName2["EXTEND"] = "extend";
-  OpName2["EXTRACT"] = "extract";
-  OpName2["FLATTEN"] = "flatten";
-  OpName2["FLIP"] = "flip";
-  OpName2["FLOP"] = "flop";
-  OpName2["HUE"] = "hue";
-  OpName2["LEVEL"] = "level";
-  OpName2["LIGHTEN"] = "lighten";
-  OpName2["NORMALIZE"] = "normalize";
-  OpName2["OVERLAY"] = "overlay";
-  OpName2["RESIZE"] = "resize";
-  OpName2["ROTATE"] = "rotate";
-  OpName2["SATURATE"] = "saturate";
-  return OpName2;
-})(OpName || {});
-var TransformErrCodes = /* @__PURE__ */ ((TransformErrCodes2) => {
-  TransformErrCodes2["PROCESS_TIMEOUT"] = "process-timeout";
-  TransformErrCodes2["OP_TIMEOUT"] = "op-timeout";
-  TransformErrCodes2["WIDTH_LIMIT_EXCEEDED"] = "width-limit-exceeded";
-  TransformErrCodes2["HEIGHT_LIMIT_EXCEEDED"] = "height-limit-exceeded";
-  TransformErrCodes2["UNKNOWN_ERROR"] = "unknown-error";
-  return TransformErrCodes2;
-})(TransformErrCodes || {});
-
-export {
-  OpName,
-  TransformErrCodes
-};

package/chunks/chunk-5TM235Z3.js

@@ -1,40 +0,0 @@
-import {
-  makeFailure,
-  makeSuccess
-} from "./chunk-LUAYN7VJ.js";
-import {
-  unknownToString
-} from "./chunk-PUQUSA6S.js";
-
-// src/node/ftps/file/upload/index.ts
-async function upload(ftpClient, targetPath, fileStream, options) {
-  const {
-    ensureDir = true,
-    overwrite = false
-  } = options ?? {};
-  try {
-    if (ensureDir) {
-      const dirPath = targetPath.substring(0, targetPath.lastIndexOf("/"));
-      await ftpClient.ensureDir(dirPath);
-    }
-    let fileExists = false;
-    try {
-      await ftpClient.size(targetPath);
-      fileExists = true;
-    } catch {
-      fileExists = false;
-    }
-    if (fileExists && !overwrite) {
-      return makeFailure(`File already exists at ${targetPath}.`);
-    }
-    await ftpClient.uploadFrom(fileStream, targetPath, options);
-    return makeSuccess(true);
-  } catch (err) {
-    const errStr = unknownToString(err);
-    return makeFailure(errStr);
-  }
-}
-
-export {
-  upload
-};

package/chunks/chunk-5WVGUZL5.js

@@ -1,35 +0,0 @@
-import {
-  makeFailure,
-  makeSuccess
-} from "./chunk-LUAYN7VJ.js";
-import {
-  unknownToString
-} from "./chunk-PUQUSA6S.js";
-
-// src/node/ftps/file/remove/index.ts
-async function remove(ftpClient, targetPath, options) {
-  const { ignoreMissing = true } = options ?? {};
-  try {
-    let fileExists = true;
-    try {
-      await ftpClient.size(targetPath);
-    } catch {
-      fileExists = false;
-    }
-    if (!fileExists) {
-      if (ignoreMissing) {
-        return makeSuccess(true);
-      }
-      return makeFailure(`File not found at ${targetPath}.`);
-    }
-    await ftpClient.remove(targetPath);
-    return makeSuccess(true);
-  } catch (err) {
-    const errStr = unknownToString(err);
-    return makeFailure(errStr);
-  }
-}
-
-export {
-  remove
-};