@design-edito/tools 0.4.5 → 0.4.11

package/node/cloud-storage/operations/index.d.ts

@@ -1,11 +1,11 @@
 export * as copyDir from './copy-dir/index.js'
-export * as downloadFile from './download-file/index.js'
 export * as copyFile from './copy-file/index.js'
+export * as downloadFile from './download-file/index.js'
 export * as existsFile from './exists-file/index.js'
 export * as listDir from './list-dir/index.js'
+export * as moveDir from './move-dir/index.js'
 export * as moveFile from './move-file/index.js'
 export * as removeDir from './remove-dir/index.js'
 export * as removeFile from './remove-file/index.js'
 export * as statFile from './stat-file/index.js'
 export * as uploadFile from './upload-file/index.js'
-export * as moveDir from './move-dir/index.js'

package/node/cloud-storage/operations/index.js

@@ -1,11 +1,11 @@
 export * as copyDir from './copy-dir/index.js'
-export * as downloadFile from './download-file/index.js'
 export * as copyFile from './copy-file/index.js'
+export * as downloadFile from './download-file/index.js'
 export * as existsFile from './exists-file/index.js'
 export * as listDir from './list-dir/index.js'
+export * as moveDir from './move-dir/index.js'
 export * as moveFile from './move-file/index.js'
 export * as removeDir from './remove-dir/index.js'
 export * as removeFile from './remove-file/index.js'
 export * as statFile from './stat-file/index.js'
 export * as uploadFile from './upload-file/index.js'
-export * as moveDir from './move-dir/index.js'

package/node/cloud-storage/operations/list-dir/index.js

@@ -1,99 +1,30 @@
-// src/agnostic/misc/outcome/index.ts
-function makeSuccess(payload) {
-  return { success: true, payload };
+import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
+import { isFtpClient, isGcsBucket, isS3ClientWithBucket, isSftpClient } from '../../clients/index.js';
+import { list as ftpList } from '../../../ftps/directory/list/index.js';
+import { list as sftpList } from '../../../sftp/directory/list/index.js';
+import { list as s3List } from '../../../@aws-s3/storage/directory/list/index.js';
+import { list as gcsList } from '../../../@google-cloud/storage/directory/list/index.js';
+/**
+ * Lists the contents of a directory in cloud storage.
+ *
+ * The function automatically dispatches to the appropriate implementation based on
+ * the client type (Google Cloud Storage, S3, FTP, or SFTP).
+ *
+ * @param {AnyClient} client               - The cloud storage client instance.
+ * @param {string}   path                 - The directory path to list.
+ * @param {GcsListOptions | S3ListOptions} [options] - Optional list configuration.
+ * @returns {Promise<Outcome.Either<string[], string>>}
+ * - On success:  `Outcome.makeSuccess(paths)` containing an array of file/directory paths.
+ * - On failure:  `Outcome.makeFailure(errStr)`.
+ */
+export async function listDir(client, path, options) {
+    if (isGcsBucket(client))
+        return await gcsList(client, path, options);
+    if (isS3ClientWithBucket(client))
+        return await s3List(client.client, client.bucketName, path, options);
+    if (isFtpClient(client))
+        return await ftpList(client, path);
+    if (isSftpClient(client))
+        return await sftpList(client, path);
+    return Outcome.makeFailure('Invalid client type');
 }
-function makeFailure(error) {
-  return { success: false, error };
-}
-
-// src/node/cloud-storage/clients/index.ts
-import { Bucket as GCSBucket } from "@google-cloud/storage";
-import { S3Client } from "@aws-sdk/client-s3";
-import { Client as FtpClient } from "basic-ftp";
-import SftpClient from "ssh2-sftp-client";
-var isGcsBucket = (client) => client instanceof GCSBucket;
-var isS3ClientWithBucket = (client) => "bucketName" in client && typeof client.bucketName === "string" && "client" in client && client.client instanceof S3Client;
-var isFtpClient = (client) => client instanceof FtpClient;
-var isSftpClient = (client) => client instanceof SftpClient;
-
-// src/agnostic/errors/unknown-to-string/index.ts
-function unknownToString(unk, encoding) {
-  if (unk instanceof Error) return unk.message;
-  if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
-  if (typeof unk === "string") return unk;
-  if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
-  return `${unk}`;
-}
-
-// src/node/ftps/directory/list/index.ts
-async function list(ftpClient, directoryPath) {
-  try {
-    const list5 = await ftpClient.list(directoryPath);
-    const files = list5.filter((entry) => entry.isFile).map((entry) => directoryPath.endsWith("/") ? `${directoryPath}${entry.name}` : `${directoryPath}/${entry.name}`);
-    return makeSuccess(files);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-// src/node/sftp/directory/list/index.ts
-async function list2(sftp, directoryPath) {
-  try {
-    const list5 = await sftp.list(directoryPath);
-    const files = list5.filter((entry) => entry.type === "-").map((entry) => directoryPath.endsWith("/") ? directoryPath + entry.name : directoryPath + "/" + entry.name);
-    return makeSuccess(files);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-// src/node/@aws-s3/storage/directory/list/index.ts
-import {
-  ListObjectsV2Command
-} from "@aws-sdk/client-s3";
-async function list3(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));
-  }
-}
-
-// src/node/@google-cloud/storage/directory/list/index.ts
-async function list4(bucket, directoryPath, options) {
-  const { fileOptions } = options ?? {};
-  try {
-    const prefix = directoryPath.endsWith("/") ? directoryPath : `${directoryPath}/`;
-    const [files] = await bucket.getFiles({
-      prefix,
-      delimiter: "/",
-      ...fileOptions
-    });
-    const paths = files.map((file) => file.name);
-    return makeSuccess(paths);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-// src/node/cloud-storage/operations/list-dir/index.ts
-async function listDir(client, path, options) {
-  if (isGcsBucket(client)) return await list4(client, path, options);
-  if (isS3ClientWithBucket(client)) return await list3(client.client, client.bucketName, path, options);
-  if (isFtpClient(client)) return await list(client, path);
-  if (isSftpClient(client)) return await list2(client, path);
-  return makeFailure("Invalid client type");
-}
-export {
-  listDir
-};

package/node/cloud-storage/operations/move-dir/index.js

@@ -1,170 +1,31 @@
-// src/agnostic/misc/outcome/index.ts
-function makeSuccess(payload) {
-  return { success: true, payload };
+import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
+import { isFtpClient, isGcsBucket, isS3ClientWithBucket, isSftpClient } from '../../clients/index.js';
+import { moveDir as ftpMoveDir } from '../../../ftps/directory/move-dir/index.js';
+import { moveDir as sftpMoveDir } from '../../../sftp/directory/move-dir/index.js';
+import { moveDir as s3MoveDir } from '../../../@aws-s3/storage/directory/move-dir/index.js';
+import { moveDir as gcsMoveDir } from '../../../@google-cloud/storage/directory/move-dir/index.js';
+/**
+ * Moves a directory from one path to another.
+ *
+ * The function automatically dispatches to the appropriate implementation based on
+ * the client type (Google Cloud Storage, S3, FTP, or SFTP).
+ *
+ * @param {AnyClient} client               - The cloud storage client instance.
+ * @param {string}   sourcePath           - The source directory path to move from.
+ * @param {string}   targetPath           - The target directory path to move to.
+ * @param {GcsMoveDirOptions | S3MoveDirOptions | FtpsMoveDirOptions | SftpMoveDirOptions} [options] - Optional move configuration.
+ * @returns {Promise<Outcome.Either<true, string>>}
+ * - On success:  `Outcome.makeSuccess(true)`.
+ * - On failure:  `Outcome.makeFailure(errStr)`.
+ */
+export async function moveDir(client, sourcePath, targetPath, options) {
+    if (isGcsBucket(client))
+        return await gcsMoveDir(client, sourcePath, targetPath, options);
+    if (isS3ClientWithBucket(client))
+        return await s3MoveDir(client.client, client.bucketName, sourcePath, targetPath, options);
+    if (isFtpClient(client))
+        return await ftpMoveDir(client, sourcePath, targetPath, options);
+    if (isSftpClient(client))
+        return await sftpMoveDir(client, sourcePath, targetPath, options);
+    return Outcome.makeFailure('Invalid client type');
 }
-function makeFailure(error) {
-  return { success: false, error };
-}
-
-// src/node/cloud-storage/clients/index.ts
-import { Bucket as GCSBucket } from "@google-cloud/storage";
-import { S3Client } from "@aws-sdk/client-s3";
-import { Client as FtpClient } from "basic-ftp";
-import SftpClient from "ssh2-sftp-client";
-var isGcsBucket = (client) => client instanceof GCSBucket;
-var isS3ClientWithBucket = (client) => "bucketName" in client && typeof client.bucketName === "string" && "client" in client && client.client instanceof S3Client;
-var isFtpClient = (client) => client instanceof FtpClient;
-var isSftpClient = (client) => client instanceof SftpClient;
-
-// src/agnostic/errors/unknown-to-string/index.ts
-function unknownToString(unk, encoding) {
-  if (unk instanceof Error) return unk.message;
-  if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
-  if (typeof unk === "string") return unk;
-  if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
-  return `${unk}`;
-}
-
-// src/node/ftps/directory/move-dir/index.ts
-async function moveDir(ftpClient, sourceDir, targetDir, options) {
-  const { overwrite = false, ensureDir = true } = options ?? {};
-  try {
-    if (ensureDir) {
-      const parentDir = targetDir.substring(0, targetDir.lastIndexOf("/"));
-      await ftpClient.ensureDir(parentDir);
-    }
-    if (!overwrite) {
-      try {
-        await ftpClient.size(targetDir);
-        return makeFailure(`Target ${targetDir} already exists.`);
-      } catch {
-      }
-    }
-    await ftpClient.rename(sourceDir, targetDir);
-    return makeSuccess(true);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-// src/node/sftp/directory/move-dir/index.ts
-async function moveDir2(sftp, sourceDir, targetDir, options) {
-  const { overwrite = false, ensureDir = true } = options ?? {};
-  try {
-    if (ensureDir) {
-      const parentDir = targetDir.substring(0, targetDir.lastIndexOf("/"));
-      await sftp.mkdir(parentDir, true);
-    }
-    if (!overwrite) {
-      const exists = await sftp.exists(targetDir);
-      if (exists !== false) return makeFailure(`Target ${targetDir} already exists.`);
-    }
-    await sftp.rename(sourceDir, targetDir);
-    return makeSuccess(true);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-// src/node/@aws-s3/storage/directory/move-dir/index.ts
-import {
-  ListObjectsV2Command,
-  CopyObjectCommand,
-  DeleteObjectCommand,
-  HeadObjectCommand
-} from "@aws-sdk/client-s3";
-async function moveDir3(client, bucketName, sourceDir, targetDir, options) {
-  const {
-    listObjectsOptions,
-    copyOptions,
-    deleteOptions,
-    overwrite = false
-  } = options ?? {};
-  const from = sourceDir.endsWith("/") ? sourceDir : `${sourceDir}/`;
-  const to = targetDir.endsWith("/") ? targetDir : `${targetDir}/`;
-  try {
-    let token;
-    do {
-      const listResp = await client.send(
-        new ListObjectsV2Command({
-          Bucket: bucketName,
-          Prefix: from,
-          ContinuationToken: token,
-          ...listObjectsOptions
-        })
-      );
-      for (const obj of listResp.Contents ?? []) {
-        if (obj.Key === void 0) continue;
-        const rel = obj.Key.substring(from.length);
-        const dest = `${to}${rel}`;
-        if (!overwrite) {
-          try {
-            await client.send(
-              new HeadObjectCommand({ Bucket: bucketName, Key: dest })
-            );
-            throw new Error(`Object already exists at ${dest}.`);
-          } catch (err) {
-            if (err.$metadata?.httpStatusCode !== 404 && err.name !== "NotFound")
-              throw err;
-          }
-        }
-        await client.send(
-          new CopyObjectCommand({
-            Bucket: bucketName,
-            Key: dest,
-            CopySource: `${bucketName}/${obj.Key}`,
-            ...copyOptions
-          })
-        );
-        await client.send(
-          new DeleteObjectCommand({
-            Bucket: bucketName,
-            Key: obj.Key,
-            ...deleteOptions
-          })
-        );
-      }
-      token = listResp.IsTruncated === true ? listResp.NextContinuationToken : void 0;
-    } while (token !== void 0);
-    return makeSuccess(true);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-// src/node/@google-cloud/storage/directory/move-dir/index.ts
-async function moveDir4(bucket, sourceDir, targetDir, options) {
-  const { fileOptions, copyOptions, deleteOptions, overwrite = false } = options ?? {};
-  const from = sourceDir.endsWith("/") ? sourceDir : `${sourceDir}/`;
-  const to = targetDir.endsWith("/") ? targetDir : `${targetDir}/`;
-  try {
-    const [files] = await bucket.getFiles({ prefix: from });
-    for (const f of files) {
-      const rel = f.name.substring(from.length);
-      const dest = `${to}${rel}`;
-      const srcFile = bucket.file(f.name, fileOptions);
-      const destFile = bucket.file(dest, fileOptions);
-      if (!overwrite) {
-        const [exists] = await destFile.exists();
-        if (exists) throw new Error(`File already exists at ${dest}.`);
-      }
-      await srcFile.copy(dest, copyOptions);
-      await srcFile.delete(deleteOptions);
-    }
-    return makeSuccess(true);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-// src/node/cloud-storage/operations/move-dir/index.ts
-async function moveDir5(client, sourcePath, targetPath, options) {
-  if (isGcsBucket(client)) return await moveDir4(client, sourcePath, targetPath, options);
-  if (isS3ClientWithBucket(client)) return await moveDir3(client.client, client.bucketName, sourcePath, targetPath, options);
-  if (isFtpClient(client)) return await moveDir(client, sourcePath, targetPath, options);
-  if (isSftpClient(client)) return await moveDir2(client, sourcePath, targetPath, options);
-  return makeFailure("Invalid client type");
-}
-export {
-  moveDir5 as moveDir
-};

package/node/cloud-storage/operations/move-file/index.js

@@ -1,158 +1,31 @@
-// src/agnostic/misc/outcome/index.ts
-function makeSuccess(payload) {
-  return { success: true, payload };
+import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
+import { isFtpClient, isGcsBucket, isS3ClientWithBucket, isSftpClient } from '../../clients/index.js';
+import { move as ftpMove } from '../../../ftps/file/move/index.js';
+import { move as sftpMove } from '../../../sftp/file/move/index.js';
+import { move as s3Move } from '../../../@aws-s3/storage/file/move/index.js';
+import { move as gcsMove } from '../../../@google-cloud/storage/file/move/index.js';
+/**
+ * Moves a file from one path to another.
+ *
+ * The function automatically dispatches to the appropriate implementation based on
+ * the client type (Google Cloud Storage, S3, FTP, or SFTP).
+ *
+ * @param {AnyClient} client               - The cloud storage client instance.
+ * @param {string}   sourcePath           - The source file path to move from.
+ * @param {string}   targetPath           - The target file path to move to.
+ * @param {GcsMoveOptions | S3MoveOptions | FtpsMoveOptions | SftpMoveOptions} [options] - Optional move configuration.
+ * @returns {Promise<Outcome.Either<true, string>>}
+ * - On success:  `Outcome.makeSuccess(true)`.
+ * - On failure:  `Outcome.makeFailure(errStr)`.
+ */
+export async function moveFile(client, sourcePath, targetPath, options) {
+    if (isGcsBucket(client))
+        return await gcsMove(client, sourcePath, targetPath, options);
+    if (isS3ClientWithBucket(client))
+        return await s3Move(client.client, client.bucketName, sourcePath, targetPath, options);
+    if (isFtpClient(client))
+        return await ftpMove(client, sourcePath, targetPath);
+    if (isSftpClient(client))
+        return await sftpMove(client, sourcePath, targetPath);
+    return Outcome.makeFailure('Invalid client type');
 }
-function makeFailure(error) {
-  return { success: false, error };
-}
-
-// src/node/cloud-storage/clients/index.ts
-import { Bucket as GCSBucket } from "@google-cloud/storage";
-import { S3Client } from "@aws-sdk/client-s3";
-import { Client as FtpClient } from "basic-ftp";
-import SftpClient from "ssh2-sftp-client";
-var isGcsBucket = (client) => client instanceof GCSBucket;
-var isS3ClientWithBucket = (client) => "bucketName" in client && typeof client.bucketName === "string" && "client" in client && client.client instanceof S3Client;
-var isFtpClient = (client) => client instanceof FtpClient;
-var isSftpClient = (client) => client instanceof SftpClient;
-
-// src/agnostic/errors/unknown-to-string/index.ts
-function unknownToString(unk, encoding) {
-  if (unk instanceof Error) return unk.message;
-  if (unk instanceof Buffer) return unk.toString(encoding ?? "utf-8");
-  if (typeof unk === "string") return unk;
-  if (typeof unk === "object" && unk !== null) return JSON.stringify(unk);
-  return `${unk}`;
-}
-
-// src/node/ftps/file/move/index.ts
-async function move(ftpClient, sourcePath, targetPath, options) {
-  const {
-    ensureDir = true,
-    overwrite = false
-  } = options ?? {};
-  try {
-    if (ensureDir) {
-      const dirPath = targetPath.substring(0, targetPath.lastIndexOf("/"));
-      await ftpClient.ensureDir(dirPath);
-    }
-    if (!overwrite) {
-      try {
-        await ftpClient.size(targetPath);
-        return makeFailure(`File already exists at ${targetPath}.`);
-      } catch (err) {
-        if (err.code !== 550) {
-          return makeFailure(unknownToString(err));
-        }
-      }
-    }
-    await ftpClient.rename(sourcePath, targetPath);
-    return makeSuccess(true);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-// src/node/sftp/file/move/index.ts
-async function move2(sftp, sourcePath, targetPath, options) {
-  const {
-    ensureDir = true,
-    overwrite = false
-  } = options ?? {};
-  try {
-    if (ensureDir) {
-      const dirPath = targetPath.substring(0, targetPath.lastIndexOf("/"));
-      await sftp.mkdir(dirPath, true);
-    }
-    if (!overwrite) {
-      const exists = await sftp.exists(targetPath) !== false;
-      if (exists) return makeFailure(`File already exists at ${targetPath}.`);
-    }
-    await sftp.rename(sourcePath, targetPath);
-    return makeSuccess(true);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-// src/node/@aws-s3/storage/file/move/index.ts
-import {
-  HeadObjectCommand,
-  CopyObjectCommand,
-  DeleteObjectCommand
-} from "@aws-sdk/client-s3";
-async function move3(client, bucketName, sourcePath, targetPath, options) {
-  const {
-    copyOptions,
-    deleteOptions,
-    overwrite = false
-  } = options ?? {};
-  try {
-    if (!overwrite) {
-      try {
-        await client.send(new HeadObjectCommand({ Bucket: bucketName, Key: targetPath }));
-        return makeFailure(`Object already exists at ${targetPath}.`);
-      } catch (err) {
-        const notFound = err.$metadata?.httpStatusCode === 404 || err.name === "NotFound" || err.Code === "NotFound" || err.Code === "NoSuchKey";
-        if (!notFound) {
-          return makeFailure(unknownToString(err));
-        }
-      }
-    }
-    await client.send(
-      new CopyObjectCommand({
-        Bucket: bucketName,
-        Key: targetPath,
-        CopySource: `${bucketName}/${sourcePath}`,
-        ...copyOptions
-      })
-    );
-    await client.send(
-      new DeleteObjectCommand({
-        Bucket: bucketName,
-        Key: sourcePath,
-        ...deleteOptions
-      })
-    );
-    return makeSuccess(true);
-  } catch (err) {
-    return makeFailure(unknownToString(err));
-  }
-}
-
-// src/node/@google-cloud/storage/file/move/index.ts
-async function move4(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));
-  }
-}
-
-// src/node/cloud-storage/operations/move-file/index.ts
-async function moveFile(client, sourcePath, targetPath, options) {
-  if (isGcsBucket(client)) return await move4(client, sourcePath, targetPath, options);
-  if (isS3ClientWithBucket(client)) return await move3(client.client, client.bucketName, sourcePath, targetPath, options);
-  if (isFtpClient(client)) return await move(client, sourcePath, targetPath);
-  if (isSftpClient(client)) return await move2(client, sourcePath, targetPath);
-  return makeFailure("Invalid client type");
-}
-export {
-  moveFile
-};