b2b-platform-utils 1.1.24 → 1.1.25

package/fileSystem.js

@@ -1,4 +1,4 @@
-'use strict';
+"use strict";
 
 /**
  * @module fileSystem
@@ -19,10 +19,11 @@
  *   It is NOT recommended in hot request/response paths.
  */
 
-const fs = require('fs');
-const path = require('path');
-const { warningNote } = require('./logger');
-const { getValue } = require('./localCache');
+const fs = require("fs");
+const fsPromises = require("fs/promises");
+const path = require("path");
+const { warningNote } = require("./logger");
+const { getValue } = require("./localCache");
 
 // -----------------------------------------------------------------------------
 // Internal helpers
@@ -36,9 +37,9 @@ const { getValue } = require('./localCache');
  * @returns {string} Absolute path.
  */
 function resolvePath(fileName) {
-    return path.isAbsolute(fileName)
-        ? fileName
-        : path.resolve(process.cwd(), fileName);
+  return path.isAbsolute(fileName)
+    ? fileName
+    : path.resolve(process.cwd(), fileName);
 }
 
 /**
@@ -47,7 +48,7 @@ function resolvePath(fileName) {
  * @param {string} absolutePath
  */
 function ensureDirForFile(absolutePath) {
-    fs.mkdirSync(path.dirname(absolutePath), { recursive: true });
+  fs.mkdirSync(path.dirname(absolutePath), { recursive: true });
 }
 
 /**
@@ -59,11 +60,11 @@ function ensureDirForFile(absolutePath) {
  * @returns {string} extension without dot, e.g. "png"
  */
 function extractCleanExtension(filename) {
-    // remove query/hash if passed like "avatar.png?ts=123" or "file.pdf#v2"
-    const cleanName = filename.split('?')[0].split('#')[0];
-    const parts = cleanName.split('.');
-    if (parts.length < 2) return '';
-    return parts.pop().toLowerCase();
+  // remove query/hash if passed like "avatar.png?ts=123" or "file.pdf#v2"
+  const cleanName = filename.split("?")[0].split("#")[0];
+  const parts = cleanName.split(".");
+  if (parts.length < 2) return "";
+  return parts.pop().toLowerCase();
 }
 
 // -----------------------------------------------------------------------------
@@ -80,13 +81,13 @@ function extractCleanExtension(filename) {
  * @param {number} [options.spaces=0] - JSON indentation level, e.g. 2 for pretty debug output.
  */
 function saveFile(fileName, data, options = {}) {
-    const absPath = resolvePath(fileName);
-    ensureDirForFile(absPath);
+  const absPath = resolvePath(fileName);
+  ensureDirForFile(absPath);
 
-    const spaces = Number.isInteger(options.spaces) ? options.spaces : 0;
-    const json = JSON.stringify(data, null, spaces);
+  const spaces = Number.isInteger(options.spaces) ? options.spaces : 0;
+  const json = JSON.stringify(data, null, spaces);
 
-    fs.writeFileSync(absPath, json, { encoding: 'utf-8' });
+  fs.writeFileSync(absPath, json, { encoding: "utf-8" });
 }
 
 /**
@@ -97,8 +98,8 @@ function saveFile(fileName, data, options = {}) {
  * @returns {string} File contents.
  */
 function readFile(fileName) {
-    const absPath = resolvePath(fileName);
-    return fs.readFileSync(absPath, 'utf-8');
+  const absPath = resolvePath(fileName);
+  return fs.readFileSync(absPath, "utf-8");
 }
 
 /**
@@ -110,14 +111,14 @@ function readFile(fileName) {
  * @returns {any|null}
  */
 function readJsonFile(fileName) {
-    const absPath = resolvePath(fileName);
+  const absPath = resolvePath(fileName);
 
-    if (!fs.existsSync(absPath)) {
-        return null;
-    }
+  if (!fs.existsSync(absPath)) {
+    return null;
+  }
 
-    const raw = fs.readFileSync(absPath, 'utf-8');
-    return JSON.parse(raw);
+  const raw = fs.readFileSync(absPath, "utf-8");
+  return JSON.parse(raw);
 }
 
 /**
@@ -127,13 +128,34 @@ function readJsonFile(fileName) {
  * @param {string} fileName
  */
 function removeFile(fileName) {
-    const absPath = resolvePath(fileName);
+  const absPath = resolvePath(fileName);
 
-    if (!fs.existsSync(absPath)) {
-        return;
-    }
+  if (!fs.existsSync(absPath)) {
+    return;
+  }
 
-    fs.unlinkSync(absPath);
+  fs.unlinkSync(absPath);
+}
+
+/**
+ * Remove a file from the filesystem if it exists (async).
+ * Safe no-op if the file is already missing.
+ *
+ * @param {string} fileName - Target file path (absolute or relative).
+ * @returns {Promise<boolean>} True if removed, false if file did not exist.
+ */
+async function unlinkIfExists(fileName) {
+  const absPath = resolvePath(fileName);
+
+  try {
+    await fsPromises.unlink(absPath);
+    return true;
+  } catch (err) {
+    if (err?.code === "ENOENT") {
+      return false;
+    }
+    throw err;
+  }
 }
 
 // -----------------------------------------------------------------------------
@@ -149,58 +171,58 @@ function removeFile(fileName) {
  * @returns {{ extension: string|null, error: string }}
  */
 function getImageExtension(mimetype) {
-    let extension = null;
-    let error = '';
-
-    switch (mimetype) {
-        case 'image/png':
-            extension = 'png';
-            break;
-        case 'image/jpeg':
-            extension = 'jpeg';
-            break;
-        case 'image/jpg':
-            extension = 'jpg';
-            break;
-        case 'image/svg+xml':
-            extension = 'svg';
-            break;
-        case 'image/webp':
-            extension = 'webp';
-            break;
-        case 'image/gif':
-            extension = 'gif';
-            break;
-        case 'image/vnd.microsoft.icon':
-            extension = 'ico';
-            break;
-        case 'font/ttf':
-            extension = 'ttf';
-            break;
-        case 'text/plain':
-            extension = 'txt';
-            break;
-        case 'text/csv':
-            extension = 'csv';
-            break;
-        case 'application/pdf':
-            extension = 'pdf';
-            break;
-        case 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet':
-            extension = 'xlsx';
-            break;
-        default:
-            error = `Undefined file mimetype: ${mimetype}`;
-            extension = null;
-
-            // Emit a non-fatal warning. Service can still decide what to do.
-            if (typeof warningNote === 'function') {
-                warningNote(error);
-            }
-            break;
-    }
+  let extension = null;
+  let error = "";
+
+  switch (mimetype) {
+    case "image/png":
+      extension = "png";
+      break;
+    case "image/jpeg":
+      extension = "jpeg";
+      break;
+    case "image/jpg":
+      extension = "jpg";
+      break;
+    case "image/svg+xml":
+      extension = "svg";
+      break;
+    case "image/webp":
+      extension = "webp";
+      break;
+    case "image/gif":
+      extension = "gif";
+      break;
+    case "image/vnd.microsoft.icon":
+      extension = "ico";
+      break;
+    case "font/ttf":
+      extension = "ttf";
+      break;
+    case "text/plain":
+      extension = "txt";
+      break;
+    case "text/csv":
+      extension = "csv";
+      break;
+    case "application/pdf":
+      extension = "pdf";
+      break;
+    case "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":
+      extension = "xlsx";
+      break;
+    default:
+      error = `Undefined file mimetype: ${mimetype}`;
+      extension = null;
+
+      // Emit a non-fatal warning. Service can still decide what to do.
+      if (typeof warningNote === "function") {
+        warningNote(error);
+      }
+      break;
+  }
 
-    return { extension, error };
+  return { extension, error };
 }
 
 /**
@@ -211,43 +233,43 @@ function getImageExtension(mimetype) {
  * @returns {string} MIME type string or "" if unknown.
  */
 function getMimeTypeByFileExtension(filename) {
-    const ext = extractCleanExtension(filename);
-
-    switch (ext) {
-        case 'png':
-            return 'image/png';
-        case 'gif':
-            return 'image/gif';
-        case 'jpeg':
-        case 'jpg':
-            return 'image/jpeg';
-        case 'webp':
-            return 'image/webp';
-        case 'ico':
-            return 'image/vnd.microsoft.icon';
-        case 'svg':
-            return 'image/svg+xml';
-        case 'csv':
-            return 'text/csv';
-        case 'txt':
-            return 'text/plain';
-        case 'xml':
-            return 'application/xml';
-        case 'pdf':
-            return 'application/pdf';
-        case 'xls':
-            return 'application/vnd.ms-excel';
-        case 'xlsx':
-            return 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';
-        case 'doc':
-            return 'application/msword';
-        case 'docx':
-            return 'application/vnd.openxmlformats-officedocument.wordprocessingml.document';
-        case 'mp4':
-            return 'video/mp4';
-        default:
-            return '';
-    }
+  const ext = extractCleanExtension(filename);
+
+  switch (ext) {
+    case "png":
+      return "image/png";
+    case "gif":
+      return "image/gif";
+    case "jpeg":
+    case "jpg":
+      return "image/jpeg";
+    case "webp":
+      return "image/webp";
+    case "ico":
+      return "image/vnd.microsoft.icon";
+    case "svg":
+      return "image/svg+xml";
+    case "csv":
+      return "text/csv";
+    case "txt":
+      return "text/plain";
+    case "xml":
+      return "application/xml";
+    case "pdf":
+      return "application/pdf";
+    case "xls":
+      return "application/vnd.ms-excel";
+    case "xlsx":
+      return "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
+    case "doc":
+      return "application/msword";
+    case "docx":
+      return "application/vnd.openxmlformats-officedocument.wordprocessingml.document";
+    case "mp4":
+      return "video/mp4";
+    default:
+      return "";
+  }
 }
 
 // -----------------------------------------------------------------------------
@@ -273,8 +295,8 @@ function getMimeTypeByFileExtension(filename) {
  * @returns {string} Absolute URL.
  */
 function getAbsoluteMediaResourceUrl(service, instance, fileName) {
-    const baseUrl = getValue('baseApiURL') || '';
-    return `${baseUrl}/file/${service}/${instance}/${fileName}`;
+  const baseUrl = getValue("baseApiURL") || "";
+  return `${baseUrl}/file/${service}/${instance}/${fileName}`;
 }
 
 // -----------------------------------------------------------------------------
@@ -282,17 +304,18 @@ function getAbsoluteMediaResourceUrl(service, instance, fileName) {
 // -----------------------------------------------------------------------------
 
 module.exports = {
-    // Filesystem I/O
-    resolvePath,
-    saveFile,
-    readFile,
-    readJsonFile,
-    removeFile,
-
-    // MIME helpers
-    getImageExtension,
-    getMimeTypeByFileExtension,
-
-    // URL helpers
-    getAbsoluteMediaResourceUrl
+  // Filesystem I/O
+  resolvePath,
+  saveFile,
+  readFile,
+  readJsonFile,
+  removeFile,
+  unlinkIfExists,
+
+  // MIME helpers
+  getImageExtension,
+  getMimeTypeByFileExtension,
+
+  // URL helpers
+  getAbsoluteMediaResourceUrl,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "b2b-platform-utils",
-  "version": "1.1.24",
+  "version": "1.1.25",
   "description": "Shared utilities for Node.js microservices: errors map, local cache, logger, numbers, dates, filesystem, media optimization, paginator, slugger, crypto wrapper, sanitize HTML, sorting.",
   "type": "commonjs",
   "license": "KingSizer",