@catbee/utils 1.0.5 → 2.0.0-next.0

package/fs/index.cjs

@@ -0,0 +1,253 @@
+/*
+ * The MIT License
+ * 
+ * Copyright (c) 2025 Catbee Technologies. https://catbee.in/license
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+'use strict';
+
+var fs$1 = require('fs');
+var fs = require('fs/promises');
+var os = require('os');
+var path = require('path');
+var promises = require('stream/promises');
+var crypto = require('crypto');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var fs__default = /*#__PURE__*/_interopDefault(fs);
+var path__default = /*#__PURE__*/_interopDefault(path);
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+async function fileExists(path2) {
+  try {
+    await fs__default.default.access(path2);
+    return true;
+  } catch {
+    return false;
+  }
+}
+__name(fileExists, "fileExists");
+async function readJsonFile(path2) {
+  try {
+    const data = await fs__default.default.readFile(path2, "utf-8");
+    return JSON.parse(data);
+  } catch {
+    return null;
+  }
+}
+__name(readJsonFile, "readJsonFile");
+async function readJsonOrDefault(path2, defaultValue) {
+  const res = await safeReadJsonFile(path2);
+  return res.data === null ? defaultValue : res.data;
+}
+__name(readJsonOrDefault, "readJsonOrDefault");
+async function writeJsonFile(path2, data, space = 2) {
+  const json = JSON.stringify(data, null, space);
+  await fs__default.default.writeFile(path2, json, "utf-8");
+}
+__name(writeJsonFile, "writeJsonFile");
+async function deleteFileIfExists(path2) {
+  try {
+    await fs__default.default.unlink(path2);
+    return true;
+  } catch (err) {
+    if (err.code === "ENOENT") return true;
+    return false;
+  }
+}
+__name(deleteFileIfExists, "deleteFileIfExists");
+async function readTextFile(path2, encoding = "utf-8") {
+  try {
+    return await fs__default.default.readFile(path2, encoding);
+  } catch {
+    return null;
+  }
+}
+__name(readTextFile, "readTextFile");
+async function writeTextFile(path2, content, encoding = "utf-8") {
+  try {
+    await fs__default.default.writeFile(path2, content, encoding);
+    return true;
+  } catch {
+    return false;
+  }
+}
+__name(writeTextFile, "writeTextFile");
+async function appendTextFile(path2, content, encoding = "utf-8") {
+  try {
+    await fs__default.default.appendFile(path2, content, encoding);
+    return true;
+  } catch {
+    return false;
+  }
+}
+__name(appendTextFile, "appendTextFile");
+async function copyFile(source, destination, overwrite = false) {
+  try {
+    const flags = overwrite ? 0 : fs__default.default.constants.COPYFILE_EXCL;
+    await fs__default.default.copyFile(source, destination, flags);
+    return true;
+  } catch {
+    return false;
+  }
+}
+__name(copyFile, "copyFile");
+async function moveFile(oldPath, newPath) {
+  try {
+    await fs__default.default.rename(oldPath, newPath);
+    return true;
+  } catch {
+    try {
+      await fs__default.default.copyFile(oldPath, newPath);
+      await fs__default.default.unlink(oldPath);
+      return true;
+    } catch {
+      return false;
+    }
+  }
+}
+__name(moveFile, "moveFile");
+async function getFileStats(path2) {
+  try {
+    return await fs__default.default.stat(path2);
+  } catch {
+    return null;
+  }
+}
+__name(getFileStats, "getFileStats");
+async function createTempFile({ prefix = "tmp-", extension = "", dir = os.tmpdir(), content } = {}) {
+  const ext = extension ? extension.startsWith(".") ? extension : `.${extension}` : "";
+  const filename = `${prefix}${crypto.randomUUID()}${ext}`;
+  const filepath = path__default.default.join(dir, filename);
+  if (content) {
+    await fs__default.default.writeFile(filepath, content);
+  } else {
+    await fs__default.default.writeFile(filepath, "");
+  }
+  return filepath;
+}
+__name(createTempFile, "createTempFile");
+async function streamFile(source, destination) {
+  const readStream = fs$1.createReadStream(source);
+  const writeStream = fs$1.createWriteStream(destination);
+  try {
+    await promises.pipeline(readStream, writeStream);
+  } catch (error) {
+    readStream.destroy();
+    writeStream.destroy();
+    throw error;
+  }
+}
+__name(streamFile, "streamFile");
+async function readDirectory(dirPath, options = {}) {
+  const files = await fs__default.default.readdir(dirPath);
+  let result = files;
+  if (options.filter) {
+    result = result.filter((file) => options.filter.test(file));
+  }
+  if (options.fullPaths) {
+    result = result.map((file) => path__default.default.join(dirPath, file));
+  }
+  return result;
+}
+__name(readDirectory, "readDirectory");
+async function createDirectory(dirPath, recursive = true) {
+  try {
+    await fs__default.default.mkdir(dirPath, {
+      recursive
+    });
+    return true;
+  } catch (err) {
+    return err.code === "EEXIST";
+  }
+}
+__name(createDirectory, "createDirectory");
+async function safeReadJsonFile(path2) {
+  try {
+    const content = await fs__default.default.readFile(path2, "utf-8");
+    try {
+      const data = JSON.parse(content);
+      return {
+        data,
+        error: null
+      };
+    } catch (error) {
+      return {
+        data: null,
+        error: new Error(`Invalid JSON in file ${path2}: ${error.message}`)
+      };
+    }
+  } catch (error) {
+    return {
+      data: null,
+      error: new Error(`Failed to read file ${path2}: ${error.message}`)
+    };
+  }
+}
+__name(safeReadJsonFile, "safeReadJsonFile");
+async function isFile(path2) {
+  try {
+    const stat = await fs__default.default.stat(path2);
+    return stat.isFile();
+  } catch {
+    return false;
+  }
+}
+__name(isFile, "isFile");
+async function getFileSize(path2) {
+  try {
+    const stat = await fs__default.default.stat(path2);
+    return stat.size;
+  } catch {
+    return -1;
+  }
+}
+__name(getFileSize, "getFileSize");
+async function readFileBuffer(path2) {
+  try {
+    return await fs__default.default.readFile(path2);
+  } catch {
+    return null;
+  }
+}
+__name(readFileBuffer, "readFileBuffer");
+
+exports.appendTextFile = appendTextFile;
+exports.copyFile = copyFile;
+exports.createDirectory = createDirectory;
+exports.createTempFile = createTempFile;
+exports.deleteFileIfExists = deleteFileIfExists;
+exports.fileExists = fileExists;
+exports.getFileSize = getFileSize;
+exports.getFileStats = getFileStats;
+exports.isFile = isFile;
+exports.moveFile = moveFile;
+exports.readDirectory = readDirectory;
+exports.readFileBuffer = readFileBuffer;
+exports.readJsonFile = readJsonFile;
+exports.readJsonOrDefault = readJsonOrDefault;
+exports.readTextFile = readTextFile;
+exports.safeReadJsonFile = safeReadJsonFile;
+exports.streamFile = streamFile;
+exports.writeJsonFile = writeJsonFile;
+exports.writeTextFile = writeTextFile;

package/fs/index.d.ts

@@ -0,0 +1,25 @@
+/*
+ * The MIT License
+ * 
+ * Copyright (c) 2025 Catbee Technologies. https://catbee.in/license
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+export * from './fs.utils';

package/fs/index.mjs

@@ -0,0 +1,228 @@
+/*
+ * The MIT License
+ * 
+ * Copyright (c) 2025 Catbee Technologies. https://catbee.in/license
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import { createReadStream, createWriteStream } from 'fs';
+import fs from 'fs/promises';
+import { tmpdir } from 'os';
+import path from 'path';
+import { pipeline } from 'stream/promises';
+import { randomUUID } from 'crypto';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+async function fileExists(path2) {
+  try {
+    await fs.access(path2);
+    return true;
+  } catch {
+    return false;
+  }
+}
+__name(fileExists, "fileExists");
+async function readJsonFile(path2) {
+  try {
+    const data = await fs.readFile(path2, "utf-8");
+    return JSON.parse(data);
+  } catch {
+    return null;
+  }
+}
+__name(readJsonFile, "readJsonFile");
+async function readJsonOrDefault(path2, defaultValue) {
+  const res = await safeReadJsonFile(path2);
+  return res.data === null ? defaultValue : res.data;
+}
+__name(readJsonOrDefault, "readJsonOrDefault");
+async function writeJsonFile(path2, data, space = 2) {
+  const json = JSON.stringify(data, null, space);
+  await fs.writeFile(path2, json, "utf-8");
+}
+__name(writeJsonFile, "writeJsonFile");
+async function deleteFileIfExists(path2) {
+  try {
+    await fs.unlink(path2);
+    return true;
+  } catch (err) {
+    if (err.code === "ENOENT") return true;
+    return false;
+  }
+}
+__name(deleteFileIfExists, "deleteFileIfExists");
+async function readTextFile(path2, encoding = "utf-8") {
+  try {
+    return await fs.readFile(path2, encoding);
+  } catch {
+    return null;
+  }
+}
+__name(readTextFile, "readTextFile");
+async function writeTextFile(path2, content, encoding = "utf-8") {
+  try {
+    await fs.writeFile(path2, content, encoding);
+    return true;
+  } catch {
+    return false;
+  }
+}
+__name(writeTextFile, "writeTextFile");
+async function appendTextFile(path2, content, encoding = "utf-8") {
+  try {
+    await fs.appendFile(path2, content, encoding);
+    return true;
+  } catch {
+    return false;
+  }
+}
+__name(appendTextFile, "appendTextFile");
+async function copyFile(source, destination, overwrite = false) {
+  try {
+    const flags = overwrite ? 0 : fs.constants.COPYFILE_EXCL;
+    await fs.copyFile(source, destination, flags);
+    return true;
+  } catch {
+    return false;
+  }
+}
+__name(copyFile, "copyFile");
+async function moveFile(oldPath, newPath) {
+  try {
+    await fs.rename(oldPath, newPath);
+    return true;
+  } catch {
+    try {
+      await fs.copyFile(oldPath, newPath);
+      await fs.unlink(oldPath);
+      return true;
+    } catch {
+      return false;
+    }
+  }
+}
+__name(moveFile, "moveFile");
+async function getFileStats(path2) {
+  try {
+    return await fs.stat(path2);
+  } catch {
+    return null;
+  }
+}
+__name(getFileStats, "getFileStats");
+async function createTempFile({ prefix = "tmp-", extension = "", dir = tmpdir(), content } = {}) {
+  const ext = extension ? extension.startsWith(".") ? extension : `.${extension}` : "";
+  const filename = `${prefix}${randomUUID()}${ext}`;
+  const filepath = path.join(dir, filename);
+  if (content) {
+    await fs.writeFile(filepath, content);
+  } else {
+    await fs.writeFile(filepath, "");
+  }
+  return filepath;
+}
+__name(createTempFile, "createTempFile");
+async function streamFile(source, destination) {
+  const readStream = createReadStream(source);
+  const writeStream = createWriteStream(destination);
+  try {
+    await pipeline(readStream, writeStream);
+  } catch (error) {
+    readStream.destroy();
+    writeStream.destroy();
+    throw error;
+  }
+}
+__name(streamFile, "streamFile");
+async function readDirectory(dirPath, options = {}) {
+  const files = await fs.readdir(dirPath);
+  let result = files;
+  if (options.filter) {
+    result = result.filter((file) => options.filter.test(file));
+  }
+  if (options.fullPaths) {
+    result = result.map((file) => path.join(dirPath, file));
+  }
+  return result;
+}
+__name(readDirectory, "readDirectory");
+async function createDirectory(dirPath, recursive = true) {
+  try {
+    await fs.mkdir(dirPath, {
+      recursive
+    });
+    return true;
+  } catch (err) {
+    return err.code === "EEXIST";
+  }
+}
+__name(createDirectory, "createDirectory");
+async function safeReadJsonFile(path2) {
+  try {
+    const content = await fs.readFile(path2, "utf-8");
+    try {
+      const data = JSON.parse(content);
+      return {
+        data,
+        error: null
+      };
+    } catch (error) {
+      return {
+        data: null,
+        error: new Error(`Invalid JSON in file ${path2}: ${error.message}`)
+      };
+    }
+  } catch (error) {
+    return {
+      data: null,
+      error: new Error(`Failed to read file ${path2}: ${error.message}`)
+    };
+  }
+}
+__name(safeReadJsonFile, "safeReadJsonFile");
+async function isFile(path2) {
+  try {
+    const stat = await fs.stat(path2);
+    return stat.isFile();
+  } catch {
+    return false;
+  }
+}
+__name(isFile, "isFile");
+async function getFileSize(path2) {
+  try {
+    const stat = await fs.stat(path2);
+    return stat.size;
+  } catch {
+    return -1;
+  }
+}
+__name(getFileSize, "getFileSize");
+async function readFileBuffer(path2) {
+  try {
+    return await fs.readFile(path2);
+  } catch {
+    return null;
+  }
+}
+__name(readFileBuffer, "readFileBuffer");
+
+export { appendTextFile, copyFile, createDirectory, createTempFile, deleteFileIfExists, fileExists, getFileSize, getFileStats, isFile, moveFile, readDirectory, readFileBuffer, readJsonFile, readJsonOrDefault, readTextFile, safeReadJsonFile, streamFile, writeJsonFile, writeTextFile };