fiberx-backend-toolkit 0.1.21 → 1.0.1

package/dist/utils/logger_util.js

@@ -23,7 +23,7 @@ class LoggerUtil {
      * Ensures a directory exists. If it doesn't, creates it.
      * @param directory_path - Path to the directory
      * @returns The absolute path of the ensured directory
-    */
+     */
     ensureDirExists(directory_path) {
         const resolved_path = path_1.default.resolve(directory_path);
         if (!fs_1.default.existsSync(resolved_path)) {
@@ -34,7 +34,7 @@ class LoggerUtil {
     /**
      * Generate log unique log file name with timestamp and module name
      * @returns The absolute path of the module log file
-    */
+     */
     getLogFilePath() {
         const timestamp = Math.floor(Date.now() / 1000);
         const file_name = `${this.module_name}-${timestamp}.log`;
@@ -57,15 +57,21 @@ class LoggerUtil {
     // Log a message with optional error data and level
     log(message = "", data_error = {}, status = "INFO") {
         const timestamp = new Date().toISOString();
-        const error_str = data_error && typeof data_error === "object" && Object.keys(data_error).length ? this.safeStringify(data_error, 0) : "";
-        const formatted_message = message.startsWith(`[${this.module_name}]`) ? message : `[${this.module_name}] ${message}`;
+        const error_str = data_error && typeof data_error === "object" && Object.keys(data_error).length
+            ? this.safeStringify(data_error, 0)
+            : "";
+        const formatted_message = message.startsWith(`[${this.module_name}]`)
+            ? message
+            : `[${this.module_name}] ${message}`;
         const log_line = `${timestamp} [${status}] ${formatted_message} ${error_str}\n`;
         const log_entry = { timestamp, status, message, data_error: data_error };
         if (this.store_log_locally) {
             fs_1.default.appendFileSync(this.log_file_path, log_line);
         }
         console.log(`\n${timestamp} [${status}] ${formatted_message}\n`);
-        if (data_error && typeof data_error === "object" && Object.keys(data_error).length) {
+        if (data_error &&
+            typeof data_error === "object" &&
+            Object.keys(data_error).length) {
             console.log({ ...data_error });
             console.log("\n");
             console.log("========================================");
@@ -73,13 +79,21 @@ class LoggerUtil {
         return log_entry;
     }
     // Log info-level messages
-    info(message, data = "") { return this.log(message, data, "INFO"); }
+    info(message, data = "") {
+        return this.log(message, data, "INFO");
+    }
     // Log error-level messages
-    error(message, error = "") { return this.log(message, error, "ERROR"); }
+    error(message, error = "") {
+        return this.log(message, error, "ERROR");
+    }
     // Log alert-level messages
-    alert(message, data = "") { return this.log(message, data, "ALERT"); }
+    alert(message, data = "") {
+        return this.log(message, data, "ALERT");
+    }
     // Log success-level messages
-    success(message, data = "") { return this.log(message, data, "SUCCESS"); }
+    success(message, data = "") {
+        return this.log(message, data, "SUCCESS");
+    }
     // Log how long a method took to execute
     logExecutionTime(start_time, class_name, method_name) {
         const [seconds, nanoseconds] = process.hrtime(start_time);

package/dist/utils/main.d.ts

@@ -14,4 +14,4 @@ import FsActionsUtil from "./fs_actions_util";
 import EJSRenderUtil from "./ejs_render_util";
 import PLimitUtil from "./p_limit_util";
 import CryptoKeyUtil from "./crypto_key_util";
-export { LoggerUtil, InputTransformerUtil, InputValidatorUtil, EnvManagerUtil, SqlFormatterUtil, ServerUtil, SafeExecuteUtil, InMemoryCacheUtil, UUIDGeneratorUtil, EncryptorDecryptorUtil, TOTPServiceUtil, ContentManagerUtil, FsActionsUtil, EJSRenderUtil, PLimitUtil, CryptoKeyUtil };
+export { LoggerUtil, InputTransformerUtil, InputValidatorUtil, EnvManagerUtil, SqlFormatterUtil, ServerUtil, SafeExecuteUtil, InMemoryCacheUtil, UUIDGeneratorUtil, EncryptorDecryptorUtil, TOTPServiceUtil, ContentManagerUtil, FsActionsUtil, EJSRenderUtil, PLimitUtil, CryptoKeyUtil, };

package/dist/utils/safe_execute_util.js

@@ -38,13 +38,17 @@ class SafeExecuteUtil {
     }
     // Method to handle on error action
     static handleOnErrorAction(error, strategy, default_value, controller_response) {
-        if (strategy === util_type_1.ErrorHandlingStrategyEnum.CONTROLLER_ERROR && controller_response?.errResponse) {
+        if (strategy === util_type_1.ErrorHandlingStrategyEnum.CONTROLLER_ERROR &&
+            controller_response?.errResponse) {
             return controller_response?.errResponse?.(500, "invalid_error_request");
         }
         switch (strategy) {
-            case util_type_1.ErrorHandlingStrategyEnum.RETURN_DEFAULT: return default_value;
-            case util_type_1.ErrorHandlingStrategyEnum.EXIT_PROCESS: process.exit(1);
-            case util_type_1.ErrorHandlingStrategyEnum.THROW_ERROR: throw error;
+            case util_type_1.ErrorHandlingStrategyEnum.RETURN_DEFAULT:
+                return default_value;
+            case util_type_1.ErrorHandlingStrategyEnum.EXIT_PROCESS:
+                process.exit(1);
+            case util_type_1.ErrorHandlingStrategyEnum.THROW_ERROR:
+                throw error;
         }
         return;
     }
@@ -59,7 +63,11 @@ class SafeExecuteUtil {
             }
             catch (error) {
                 const safely_stringified_error = SafeExecuteUtil.safeStringify(error);
-                logger.error(`[${class_name}] ❌ Error in method ${method_name}`, { method_params, error, safely_stringified_error });
+                logger.error(`[${class_name}] ❌ Error in method ${method_name}`, {
+                    method_params,
+                    error,
+                    safely_stringified_error,
+                });
                 SafeExecuteUtil.handleOnErrorAction(error, strategy, default_value);
             }
         };
@@ -78,7 +86,11 @@ class SafeExecuteUtil {
             }
             catch (error) {
                 const safely_stringified_error = SafeExecuteUtil.safeStringify(error);
-                logger.error(`[${class_name}] ❌ Error in method ${method_name}`, { method_params, error, safely_stringified_error });
+                logger.error(`[${class_name}] ❌ Error in method ${method_name}`, {
+                    method_params,
+                    error,
+                    safely_stringified_error,
+                });
                 SafeExecuteUtil.handleOnErrorAction(error, strategy, default_value, controller_response);
             }
             finally {
@@ -86,16 +98,14 @@ class SafeExecuteUtil {
             }
         };
     }
-    ;
     // Decorator Method to handle wrapping cclass methods
     static applySafeWrapper(target, class_name, property_key, descriptor, strategy, timed, default_value) {
         if (typeof descriptor.value !== "function") {
             return;
         }
-        descriptor.value = timed ?
-            SafeExecuteUtil.createTimedSafeFunction(class_name, String(property_key), descriptor.value, strategy, default_value)
-            :
-                SafeExecuteUtil.createSafeFunction(class_name, String(property_key), descriptor.value, strategy, default_value);
+        descriptor.value = timed
+            ? SafeExecuteUtil.createTimedSafeFunction(class_name, String(property_key), descriptor.value, strategy, default_value)
+            : SafeExecuteUtil.createSafeFunction(class_name, String(property_key), descriptor.value, strategy, default_value);
     }
     // Decorator method to handle controller methods
     static safeExecuteController(class_name) {

package/dist/utils/sql_formatter_util.js

@@ -21,11 +21,7 @@ class SqlFormatterUtil {
      * - Remove extra spaces inside parentheses
      */
     static normalize(sql) {
-        return sql
-            .replace(/\s+/g, " ")
-            .replace(/\(\s+/g, "(")
-            .replace(/\s+\)/g, ")")
-            .trim();
+        return sql.replace(/\s+/g, " ").replace(/\(\s+/g, "(").replace(/\s+\)/g, ")").trim();
     }
     /**
      * Colorize SQL keywords (SELECT, INSERT, UPDATE, DELETE)

package/dist/utils/totp_service_util.js

@@ -20,7 +20,7 @@ class TOTPServiceUtil {
     DIGITS;
     WINDOW;
     ALGORITHM;
-    SECRET_KEY_REGEX = (/^[A-Z2-7]+$/i);
+    SECRET_KEY_REGEX = /^[A-Z2-7]+$/i;
     constructor(options = {}) {
         this.STEP = options.STEP ?? constants_1.DEFAULT_TOTP_STEP;
         this.DIGITS = options.DIGITS ?? constants_1.DEFAULT_TOTP_DIGITS;
@@ -87,10 +87,7 @@ class TOTPServiceUtil {
     generateForCounter(secret, counter) {
         const buffer = Buffer.alloc(8);
         buffer.writeBigUInt64BE(BigInt(counter));
-        const hmac = crypto_1.default
-            .createHmac(this.ALGORITHM, secret)
-            .update(buffer)
-            .digest();
+        const hmac = crypto_1.default.createHmac(this.ALGORITHM, secret).update(buffer).digest();
         const offset = hmac[hmac.length - 1] & 0xf;
         const code = ((hmac[offset] & 0x7f) << 24) |
             ((hmac[offset + 1] & 0xff) << 16) |
@@ -153,8 +150,7 @@ class TOTPServiceUtil {
             const generated = this.generateForCounter(key, counter);
             if (input_validator_util_1.default.isSafeHashCompare(generated, token)) {
                 // 🔒 Replay protection
-                if (typeof last_used_counter === "number" &&
-                    counter <= last_used_counter) {
+                if (typeof last_used_counter === "number" && counter <= last_used_counter) {
                     return { valid: false };
                 }
                 return { valid: true, counter };

package/dist/utils/uuid_gen_util.js

@@ -4,7 +4,9 @@ const crypto_1 = require("crypto");
 const uuid_1 = require("uuid");
 class UUIDGeneratorUtil {
     // Method to Generate a standard UUID (Version 4) following RFC 4122.
-    static generateUUIDV1() { return (0, crypto_1.randomUUID)(); }
+    static generateUUIDV1() {
+        return (0, crypto_1.randomUUID)();
+    }
     // Method to Generate a unique code based on the current timestamp and random characters.
     static generateUUIDV2(prefix = "") {
         const timestamp = Date.now().toString();
@@ -21,7 +23,9 @@ class UUIDGeneratorUtil {
         return `${time_stamp_part}${random_part}`.toUpperCase();
     }
     // Method to Generate a random byte string with optional prefix.
-    static generateUUIDV4(prefix = "") { return `${prefix}_${(0, uuid_1.v4)()}`; }
+    static generateUUIDV4(prefix = "") {
+        return `${prefix}_${(0, uuid_1.v4)()}`;
+    }
     // Method to Generate a new file name with a unique UUID
     static generateNewFileName(file) {
         const split = file.name.split(".");

package/dist/validators/file_validator_util.js

@@ -66,7 +66,7 @@ class FileValidatorUtil {
             this.logger.error("File size exceeds limit", {
                 size: input.size,
                 max_size,
-                category
+                category,
             });
             return { v_state: false, v_msg: "file_size_to_large" };
         }
@@ -76,7 +76,7 @@ class FileValidatorUtil {
             this.logger.error("Invalid mime type", {
                 mime: input.mime_type,
                 allowed,
-                category
+                category,
             });
             return { v_state: false, v_msg: "invalid_file_mime_type" };
         }

package/dist/validators/query_validator_util.js

@@ -15,7 +15,7 @@ class QueryValidatorUtil {
                 if (field.required) {
                     return {
                         v_state: false,
-                        v_msg: `missing_required_query_${field.key}`
+                        v_msg: `missing_required_query_${field.key}`,
                     };
                 }
                 result[field.key] = field.default ?? null;
@@ -80,7 +80,7 @@ class QueryValidatorUtil {
                     }
                     result[field.key] = {
                         start_date: start.toDate(),
-                        end_date: end.toDate()
+                        end_date: end.toDate(),
                     };
                     break;
                 }
@@ -103,7 +103,7 @@ class QueryValidatorUtil {
         return {
             v_state: true,
             v_msg: "valid_query_params",
-            v_data: result
+            v_data: result,
         };
     }
 }

package/package.json

@@ -1,12 +1,72 @@
 {
     "name": "fiberx-backend-toolkit",
-    "version": "0.1.21",
+    "version": "1.0.1",
     "description": "A TypeScript backend toolkit providing shared domain logic, infrastructure helpers, and utilities for FiberX server-side applications and services.",
     "type": "commonjs",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "require": "./dist/index.js",
+            "default": "./dist/index.js"
+        },
+        "./types": {
+            "types": "./dist/types/main.d.ts",
+            "require": "./dist/types/main.js",
+            "default": "./dist/types/main.js"
+        },
+        "./utils": {
+            "types": "./dist/utils/main.d.ts",
+            "require": "./dist/utils/main.js",
+            "default": "./dist/utils/main.js"
+        },
+        "./database": {
+            "types": "./dist/database/main.d.ts",
+            "require": "./dist/database/main.js",
+            "default": "./dist/database/main.js"
+        },
+        "./middle-ware": {
+            "types": "./dist/middle_ware/main.d.ts",
+            "require": "./dist/middle_ware/main.js",
+            "default": "./dist/middle_ware/main.js"
+        },
+        "./middle_ware": {
+            "types": "./dist/middle_ware/main.d.ts",
+            "require": "./dist/middle_ware/main.js",
+            "default": "./dist/middle_ware/main.js"
+        },
+        "./validators": {
+            "types": "./dist/validators/main.d.ts",
+            "require": "./dist/validators/main.js",
+            "default": "./dist/validators/main.js"
+        },
+        "./storage": {
+            "types": "./dist/storage/main.d.ts",
+            "require": "./dist/storage/main.js",
+            "default": "./dist/storage/main.js"
+        },
+        "./mailer": {
+            "types": "./dist/mailer/main.d.ts",
+            "require": "./dist/mailer/main.js",
+            "default": "./dist/mailer/main.js"
+        },
+        "./rbac": {
+            "types": "./dist/rbac/main.d.ts",
+            "require": "./dist/rbac/main.js",
+            "default": "./dist/rbac/main.js"
+        },
+        "./dist/*": "./dist/*",
+        "./package.json": "./package.json"
+    },
     "scripts": {
         "build": "tsc && tsc-alias",
+        "typecheck": "tsc --noEmit",
+        "lint": "eslint . --max-warnings=0",
+        "format": "prettier --write .",
+        "format:check": "prettier --check .",
+        "spell:check": "cspell .",
+        "check": "npm run typecheck && npm run lint && npm run format:check && npm run spell:check && npm run build",
         "prepublishOnly": "npm run build"
     },
     "files": [
@@ -38,6 +98,7 @@
         "uuid": "^12.0.0"
     },
     "devDependencies": {
+        "@eslint/js": "^10.0.1",
         "@types/axios": "^0.9.36",
         "@types/bcrypt": "^6.0.0",
         "@types/ejs": "^3.1.5",
@@ -46,11 +107,16 @@
         "@types/jsonwebtoken": "^9.0.10",
         "@types/node": "^25.2.0",
         "@types/uuid": "^10.0.0",
+        "cspell": "^9.8.0",
+        "eslint": "^10.4.0",
+        "globals": "^17.6.0",
+        "prettier": "^3.8.3",
         "ts-node": "^10.9.2",
         "tsc-alias": "^1.8.16",
         "tsconfig-paths": "^4.2.0",
         "tsup": "^8.5.1",
-        "typescript": "^5.8.3"
+        "typescript": "^5.8.3",
+        "typescript-eslint": "^8.59.3"
     },
     "engines": {
         "node": "20.x"