axiodb 12.10.17 → 12.10.20

package/lib/Helper/Converter.helper.d.ts

@@ -1,34 +1,9 @@
 export default class Converter {
     static ToObject(): string;
     constructor();
-    /**
-     * Converts a string to a boolean.
-     * @param value The string to convert.
-     * @returns The boolean value.
-     */
     ToBoolean(value: string): boolean;
-    /**
-     * Converts a string to a number.
-     * @param value The string to convert.
-     * @returns The number value.
-     */
     ToNumber(value: string): number;
-    /**
-     * Converts a string to a JSON object.
-     * @param value The string to convert.
-     * @returns The JSON object.
-     */
     ToObject(value: string): any;
-    /**
-     * Converts a JSON object to a string.
-     * @param value The JSON object to convert.
-     * @returns The string.
-     */
     ToString(value: object): string;
-    /**
-     * Converts a string to a string array.
-     * @param value The string to convert.
-     * @returns The string array.
-     */
     ToStringArray(value: string): string[];
 }

package/lib/Helper/Converter.helper.js

@@ -5,44 +5,19 @@ class Converter {
     static ToObject() {
         throw new Error("Method not implemented.");
     }
-    constructor() { } // Empty constructor
-    /**
-     * Converts a string to a boolean.
-     * @param value The string to convert.
-     * @returns The boolean value.
-     */
+    constructor() { }
     ToBoolean(value) {
         return value === "true";
     }
-    /**
-     * Converts a string to a number.
-     * @param value The string to convert.
-     * @returns The number value.
-     */
     ToNumber(value) {
         return parseInt(value);
     }
-    /**
-     * Converts a string to a JSON object.
-     * @param value The string to convert.
-     * @returns The JSON object.
-     */
     ToObject(value) {
         return JSON.parse(value);
     }
-    /**
-     * Converts a JSON object to a string.
-     * @param value The JSON object to convert.
-     * @returns The string.
-     */
     ToString(value) {
         return JSON.stringify(value);
     }
-    /**
-     * Converts a string to a string array.
-     * @param value The string to convert.
-     * @returns The string array.
-     */
     ToStringArray(value) {
         return value.split(",");
     }

package/lib/Helper/Converter.helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"Converter.helper.js","sourceRoot":"","sources":["../../source/Helper/Converter.helper.ts"],"names":[],"mappings":";;AAAA,uDAAuD;AACvD;IACE,MAAM,CAAC,QAAQ;QACb,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,gBAAe,CAAC,CAAC,oBAAoB;IAErC;;;;OAIG;IACI,SAAS,CAAC,KAAa;QAC5B,OAAO,KAAK,KAAK,MAAM,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IAEI,QAAQ,CAAC,KAAa;QAC3B,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,KAAa;QAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,KAAa;QAC3B,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IAEI,aAAa,CAAC,KAAa;QAChC,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;CACF"}
+{"version":3,"file":"Converter.helper.js","sourceRoot":"","sources":["../../source/Helper/Converter.helper.ts"],"names":[],"mappings":";;AAAA,uDAAuD;AACvD;IACE,MAAM,CAAC,QAAQ;QACb,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,gBAAe,CAAC;IAET,SAAS,CAAC,KAAa;QAC5B,OAAO,KAAK,KAAK,MAAM,CAAC;IAC1B,CAAC;IAEM,QAAQ,CAAC,KAAa;QAC3B,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAEM,QAAQ,CAAC,KAAa;QAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAEM,QAAQ,CAAC,KAAa;QAC3B,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAEM,aAAa,CAAC,KAAa;QAChC,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;CACF"}

package/lib/Helper/Crypto.helper.d.ts

@@ -1,57 +1,14 @@
 import { SuccessInterface } from "../config/Interfaces/Helper/response.helper.interface";
-/**
- * Helper class for cryptographic operations such as encryption and decryption.
- */
 export declare class CryptoHelper {
-    /**
-     * The encryption key used for cryptographic operations.
-     */
     private encryptionKey;
-    /**
-     * Instance of ResponseHelper to handle responses.
-     */
     private readonly responseHelper;
-    /**
-     * Instance of Cryptography class for performing cryptographic operations.
-     */
     private readonly Cryptography;
-    /**
-     * Instance of Converter class for converting data formats.
-     */
     private readonly Converter;
-    /**
-     * Constructor to initialize the CryptoHelper class.
-     * @param encryptionKey - Optional encryption key. If not provided, a default key based on hostname and platform will be used.
-     */
+    /** If no encryptionKey is given, falls back to a default key derived from hostname + platform. */
     constructor(encryptionKey?: string);
-    /**
-     * Sets a new encryption key.
-     * @param encryptionKey - The new encryption key to be set.
-     * @returns A promise that resolves to a success response.
-     */
     setEncryptionKey(encryptionKey: string): Promise<SuccessInterface>;
-    /**
-     * Encrypts data asynchronously.
-     * @param data - The data to be encrypted.
-     * @returns A promise that resolves to the encrypted data as a string.
-     */
     encrypt(data: string): Promise<string>;
-    /**
-     * Decrypts data asynchronously.
-     * @param data - The data to be decrypted.
-     * @returns A promise that resolves to the decrypted data as an object.
-     */
     decrypt(data: string): Promise<any>;
-    /**
-     * Encrypts data synchronously.
-     * @param data - The data to be encrypted.
-     * @returns The encrypted data as a string.
-     */
     encryptSync(data: string): string;
-    /**
-     * Decrypts data synchronously.
-     * @param data - The data to be decrypted.
-     * @returns The decrypted data as an object.
-     */
     decryptSync(data: string): object;
 }

package/lib/Helper/Crypto.helper.js

@@ -14,78 +14,39 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CryptoHelper = void 0;
 /* eslint-disable @typescript-eslint/no-explicit-any */
-// All Imports
 const node_os_1 = require("node:os");
 const response_helper_1 = __importDefault(require("./response.helper"));
 const CryptoGraphy_helper_1 = __importDefault(require("./CryptoGraphy.helper"));
 const Converter_helper_1 = __importDefault(require("./Converter.helper"));
-/**
- * Helper class for cryptographic operations such as encryption and decryption.
- */
 class CryptoHelper {
-    /**
-     * Constructor to initialize the CryptoHelper class.
-     * @param encryptionKey - Optional encryption key. If not provided, a default key based on hostname and platform will be used.
-     */
+    /** If no encryptionKey is given, falls back to a default key derived from hostname + platform. */
     constructor(encryptionKey) {
-        /**
-         * Instance of ResponseHelper to handle responses.
-         */
         this.responseHelper = new response_helper_1.default();
-        /**
-         * Instance of Converter class for converting data formats.
-         */
         this.Converter = new Converter_helper_1.default();
         this.encryptionKey = encryptionKey || `${(0, node_os_1.hostname)()}-${(0, node_os_1.platform)()}`;
         this.responseHelper = new response_helper_1.default();
         this.Cryptography = new CryptoGraphy_helper_1.default(this.encryptionKey);
         this.Converter = new Converter_helper_1.default();
     }
-    // methods
-    /**
-     * Sets a new encryption key.
-     * @param encryptionKey - The new encryption key to be set.
-     * @returns A promise that resolves to a success response.
-     */
     setEncryptionKey(encryptionKey) {
         return __awaiter(this, void 0, void 0, function* () {
             this.encryptionKey = encryptionKey;
             return this.responseHelper.Success("Encryption key has been set successfully");
         });
     }
-    /**
-     * Encrypts data asynchronously.
-     * @param data - The data to be encrypted.
-     * @returns A promise that resolves to the encrypted data as a string.
-     */
     encrypt(data) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.Cryptography.Encrypt(data);
         });
     }
-    /**
-     * Decrypts data asynchronously.
-     * @param data - The data to be decrypted.
-     * @returns A promise that resolves to the decrypted data as an object.
-     */
     decrypt(data) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.Converter.ToObject(yield this.Cryptography.Decrypt(data));
         });
     }
-    /**
-     * Encrypts data synchronously.
-     * @param data - The data to be encrypted.
-     * @returns The encrypted data as a string.
-     */
     encryptSync(data) {
         return this.Cryptography.EncryptSync(data);
     }
-    /**
-     * Decrypts data synchronously.
-     * @param data - The data to be decrypted.
-     * @returns The decrypted data as an object.
-     */
     decryptSync(data) {
         return this.Converter.ToObject(this.Cryptography.DecryptSync(data));
     }

package/lib/Helper/Crypto.helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"Crypto.helper.js","sourceRoot":"","sources":["../../source/Helper/Crypto.helper.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAuD;AACvD,cAAc;AACd,qCAA6C;AAC7C,wEAA+C;AAE/C,gFAAiD;AACjD,0EAA2C;AAE3C;;GAEG;AACH;IAsBE;;;OAGG;IACH,YAAY,aAAsB;QAnBlC;;WAEG;QACc,mBAAc,GAAmB,IAAI,yBAAc,EAAE,CAAC;QAOvE;;WAEG;QACc,cAAS,GAAG,IAAI,0BAAS,EAAE,CAAC;QAO3C,IAAI,CAAC,aAAa,GAAG,aAAa,IAAI,GAAG,IAAA,kBAAQ,GAAE,IAAI,IAAA,kBAAQ,GAAE,EAAE,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAc,EAAE,CAAC;QAC3C,IAAI,CAAC,YAAY,GAAG,IAAI,6BAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,CAAC,SAAS,GAAG,IAAI,0BAAS,EAAE,CAAC;IACnC,CAAC;IAED,UAAU;IACV;;;;OAIG;IACU,gBAAgB,CAC3B,aAAqB;;YAErB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;YACnC,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAChC,0CAA0C,CAC3C,CAAC;QACJ,CAAC;KAAA;IAED;;;;OAIG;IACU,OAAO,CAAC,IAAY;;YAC/B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED;;;;OAIG;IACU,OAAO,CAAC,IAAY;;YAC/B,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QACxE,CAAC;KAAA;IAED;;;;OAIG;IACI,WAAW,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;IACtE,CAAC;CACF"}
+{"version":3,"file":"Crypto.helper.js","sourceRoot":"","sources":["../../source/Helper/Crypto.helper.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uDAAuD;AACvD,qCAA6C;AAC7C,wEAA+C;AAE/C,gFAAiD;AACjD,0EAA2C;AAE3C;IAME,kGAAkG;IAClG,YAAY,aAAsB;QALjB,mBAAc,GAAmB,IAAI,yBAAc,EAAE,CAAC;QAEtD,cAAS,GAAG,IAAI,0BAAS,EAAE,CAAC;QAI3C,IAAI,CAAC,aAAa,GAAG,aAAa,IAAI,GAAG,IAAA,kBAAQ,GAAE,IAAI,IAAA,kBAAQ,GAAE,EAAE,CAAC;QACpE,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAc,EAAE,CAAC;QAC3C,IAAI,CAAC,YAAY,GAAG,IAAI,6BAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACzD,IAAI,CAAC,SAAS,GAAG,IAAI,0BAAS,EAAE,CAAC;IACnC,CAAC;IAEY,gBAAgB,CAC3B,aAAqB;;YAErB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;YACnC,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAChC,0CAA0C,CAC3C,CAAC;QACJ,CAAC;KAAA;IAEY,OAAO,CAAC,IAAY;;YAC/B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC;KAAA;IAEY,OAAO,CAAC,IAAY;;YAC/B,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QACxE,CAAC;KAAA;IAEM,WAAW,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAEM,WAAW,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;IACtE,CAAC;CACF"}

package/lib/Helper/DocumentLoader.helper.d.ts

@@ -1,45 +1,10 @@
 import { SuccessInterface, ErrorInterface } from '../config/Interfaces/Helper/response.helper.interface';
 /**
- * DocumentLoader - Shared utility for loading documents from collection directories
- *
- * Provides a centralized method for loading document files using worker threads,
- * replacing duplicated code in Reader, Update, Delete, and Aggregation operations.
- *
- * @class DocumentLoader
+ * Centralizes document-loading logic that used to be duplicated across the Reader,
+ * Update, Delete, and Aggregation operations - handles both a direct file list and
+ * full directory scanning (filtered to `.axiodb` files), loaded via worker threads.
  */
 export default class DocumentLoader {
     private static readonly ResponseHelper;
-    /**
-     * Loads all documents from a collection directory using worker threads
-     *
-     * This method consolidates the LoadAllBufferRawData logic that was previously
-     * duplicated across multiple CRUD operations. It handles both direct file
-     * specification and directory scanning with .axiodb file filtering.
-     *
-     * @param collectionPath - Full path to collection directory
-     * @param encryptionKey - Optional encryption key for encrypted documents
-     * @param isEncrypted - Whether documents are encrypted (default: false)
-     * @param documentFiles - Optional specific file names to load
-     * @param includeFileName - Whether to include fileName in result (default: false)
-     * @returns Success with document array or Error
-     *
-     * @example
-     * // Load all documents from a collection
-     * const result = await DocumentLoader.loadDocuments(
-     *   '/path/to/collection',
-     *   undefined,
-     *   false
-     * );
-     *
-     * @example
-     * // Load specific documents with filenames included
-     * const result = await DocumentLoader.loadDocuments(
-     *   '/path/to/collection',
-     *   'encryption-key',
-     *   true,
-     *   ['doc1.axiodb', 'doc2.axiodb'],
-     *   true
-     * );
-     */
     static loadDocuments(collectionPath: string, encryptionKey?: string, isEncrypted?: boolean, documentFiles?: string[], includeFileName?: boolean): Promise<SuccessInterface | ErrorInterface>;
 }

package/lib/Helper/DocumentLoader.helper.js

@@ -16,59 +16,21 @@ const FolderManager_1 = __importDefault(require("../engine/Filesystem/FolderMana
 const BufferLoaderWithWorker_utils_1 = __importDefault(require("../utility/BufferLoaderWithWorker.utils"));
 const response_helper_1 = __importDefault(require("./response.helper"));
 /**
- * DocumentLoader - Shared utility for loading documents from collection directories
- *
- * Provides a centralized method for loading document files using worker threads,
- * replacing duplicated code in Reader, Update, Delete, and Aggregation operations.
- *
- * @class DocumentLoader
+ * Centralizes document-loading logic that used to be duplicated across the Reader,
+ * Update, Delete, and Aggregation operations - handles both a direct file list and
+ * full directory scanning (filtered to `.axiodb` files), loaded via worker threads.
  */
 class DocumentLoader {
-    /**
-     * Loads all documents from a collection directory using worker threads
-     *
-     * This method consolidates the LoadAllBufferRawData logic that was previously
-     * duplicated across multiple CRUD operations. It handles both direct file
-     * specification and directory scanning with .axiodb file filtering.
-     *
-     * @param collectionPath - Full path to collection directory
-     * @param encryptionKey - Optional encryption key for encrypted documents
-     * @param isEncrypted - Whether documents are encrypted (default: false)
-     * @param documentFiles - Optional specific file names to load
-     * @param includeFileName - Whether to include fileName in result (default: false)
-     * @returns Success with document array or Error
-     *
-     * @example
-     * // Load all documents from a collection
-     * const result = await DocumentLoader.loadDocuments(
-     *   '/path/to/collection',
-     *   undefined,
-     *   false
-     * );
-     *
-     * @example
-     * // Load specific documents with filenames included
-     * const result = await DocumentLoader.loadDocuments(
-     *   '/path/to/collection',
-     *   'encryption-key',
-     *   true,
-     *   ['doc1.axiodb', 'doc2.axiodb'],
-     *   true
-     * );
-     */
     static loadDocuments(collectionPath_1, encryptionKey_1) {
         return __awaiter(this, arguments, void 0, function* (collectionPath, encryptionKey, isEncrypted = false, documentFiles, includeFileName = false) {
             try {
                 const dataFilesList = [];
                 if (documentFiles !== undefined) {
-                    // Use provided file list
                     dataFilesList.push(...documentFiles);
                 }
                 else {
-                    // Scan directory for .axiodb files
                     const readResponse = yield new FolderManager_1.default().ListDirectory(collectionPath);
                     if ("data" in readResponse) {
-                        // Filter for .axiodb files only
                         const axiodbFiles = readResponse.data.filter((file) => file.endsWith(".axiodb"));
                         dataFilesList.push(...axiodbFiles);
                     }
@@ -76,7 +38,7 @@ class DocumentLoader {
                         return this.ResponseHelper.Error("Failed to read directory");
                     }
                 }
-                // Load all files using worker threads (parallel processing)
+                // Loaded via worker threads for parallelism
                 const resultData = yield (0, BufferLoaderWithWorker_utils_1.default)(dataFilesList, encryptionKey, collectionPath, isEncrypted, includeFileName);
                 return this.ResponseHelper.Success(resultData);
             }

package/lib/Helper/DocumentLoader.helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"DocumentLoader.helper.js","sourceRoot":"","sources":["../../source/Helper/DocumentLoader.helper.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AACA,uFAA+D;AAC/D,2GAAuE;AACvE,wEAA+C;AAE/C;;;;;;;GAOG;AACH,MAAqB,cAAc;IAGjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,MAAM,CAAO,aAAa;6DACxB,cAAsB,EACtB,aAAsB,EACtB,WAAW,GAAY,KAAK,EAC5B,aAAwB,EACxB,eAAe,GAAY,KAAK;YAEhC,IAAI,CAAC;gBACH,MAAM,aAAa,GAAa,EAAE,CAAC;gBAEnC,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;oBAChC,yBAAyB;oBACzB,aAAa,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;gBACvC,CAAC;qBAAM,CAAC;oBACN,mCAAmC;oBACnC,MAAM,YAAY,GAAG,MAAM,IAAI,uBAAa,EAAE,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;oBAE7E,IAAI,MAAM,IAAI,YAAY,EAAE,CAAC;wBAC3B,gCAAgC;wBAChC,MAAM,WAAW,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAY,EAAE,EAAE,CAC5D,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CACzB,CAAC;wBACF,aAAa,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC;oBACrC,CAAC;yBAAM,CAAC;wBACN,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;oBAC/D,CAAC;gBACH,CAAC;gBAED,4DAA4D;gBAC5D,MAAM,UAAU,GAAG,MAAM,IAAA,sCAAgB,EACvC,aAAa,EACb,aAAa,EACb,cAAc,EACd,WAAW,EACX,eAAe,CAChB,CAAC;gBAEF,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACjD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;CACF;AA5EyB,6BAAc,GAAG,IAAI,yBAAc,EAAE,CAAC"}
+{"version":3,"file":"DocumentLoader.helper.js","sourceRoot":"","sources":["../../source/Helper/DocumentLoader.helper.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AACA,uFAA+D;AAC/D,2GAAuE;AACvE,wEAA+C;AAE/C;;;;GAIG;AACH,MAAqB,cAAc;IAGjC,MAAM,CAAO,aAAa;6DACxB,cAAsB,EACtB,aAAsB,EACtB,WAAW,GAAY,KAAK,EAC5B,aAAwB,EACxB,eAAe,GAAY,KAAK;YAEhC,IAAI,CAAC;gBACH,MAAM,aAAa,GAAa,EAAE,CAAC;gBAEnC,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;oBAChC,aAAa,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;gBACvC,CAAC;qBAAM,CAAC;oBACN,MAAM,YAAY,GAAG,MAAM,IAAI,uBAAa,EAAE,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;oBAE7E,IAAI,MAAM,IAAI,YAAY,EAAE,CAAC;wBAC3B,MAAM,WAAW,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAY,EAAE,EAAE,CAC5D,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CACzB,CAAC;wBACF,aAAa,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC;oBACrC,CAAC;yBAAM,CAAC;wBACN,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;oBAC/D,CAAC;gBACH,CAAC;gBAED,4CAA4C;gBAC5C,MAAM,UAAU,GAAG,MAAM,IAAA,sCAAgB,EACvC,aAAa,EACb,aAAa,EACb,cAAc,EACd,WAAW,EACX,eAAe,CAChB,CAAC;gBAEF,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACjD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;CACF;AAzCyB,6BAAc,GAAG,IAAI,yBAAc,EAAE,CAAC"}

package/lib/Helper/PathSanitizer.helper.js

@@ -37,20 +37,17 @@ class PathSanitizer {
         if (!userInput || typeof userInput !== 'string') {
             throw new Error('Invalid path component: must be a non-empty string');
         }
-        // Remove all directory traversal attempts
         let sanitized = userInput
-            .replace(/\.\./g, '_') // Remove .. (parent directory)
-            .replace(/\//g, '_') // Remove / (Unix path separator)
-            .replace(/\\/g, '_') // Remove \ (Windows path separator)
-            .replace(/\0/g, '_'); // Remove null bytes
-        // Allow only alphanumeric, dash, underscore, and dot (for file extensions)
-        // Note: We preserve dots for file extensions but removed '..' above
+            .replace(/\.\./g, '_') // parent directory
+            .replace(/\//g, '_') // Unix path separator
+            .replace(/\\/g, '_') // Windows path separator
+            .replace(/\0/g, '_'); // null bytes
+        // Dots are preserved (for file extensions) since '..' was already stripped above
         sanitized = sanitized.replace(/[^a-zA-Z0-9-_.]/g, '_');
-        // Prevent empty result
         if (sanitized.length === 0) {
             throw new Error('Invalid path component: results in empty string after sanitization');
         }
-        // Prevent starting with dot (hidden files) to avoid potential issues
+        // Avoid producing a hidden file
         if (sanitized.startsWith('.')) {
             sanitized = '_' + sanitized.substring(1);
         }
@@ -100,11 +97,8 @@ class PathSanitizer {
      * // Throws: Security violation (after sanitization and validation)
      */
     static safePath(basePath, ...components) {
-        // Sanitize each component
         const sanitizedComponents = components.map(c => this.sanitizePathComponent(c));
-        // Join paths using Node.js path.join (handles platform differences)
         const fullPath = path_1.default.join(basePath, ...sanitizedComponents);
-        // Validate final path is within base (defense in depth)
         this.validatePath(basePath, fullPath);
         return fullPath;
     }

package/lib/Helper/PathSanitizer.helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"PathSanitizer.helper.js","sourceRoot":"","sources":["../../source/Helper/PathSanitizer.helper.ts"],"names":[],"mappings":";;;;;AAAA,gDAAwB;AAExB;;;;;;;;;;GAUG;AACH;IACE;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,qBAAqB,CAAC,SAAiB;QAC5C,IAAI,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACxE,CAAC;QAED,0CAA0C;QAC1C,IAAI,SAAS,GAAG,SAAS;aACtB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAI,+BAA+B;aACxD,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAM,iCAAiC;aAC1D,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAM,oCAAoC;aAC7D,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAK,oBAAoB;QAEhD,2EAA2E;QAC3E,oEAAoE;QACpE,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC;QAEvD,uBAAuB;QACvB,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;QACxF,CAAC;QAED,qEAAqE;QACrE,IAAI,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,SAAS,GAAG,GAAG,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC3C,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,YAAY,CAAC,QAAgB,EAAE,QAAgB;QACpD,MAAM,YAAY,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC5C,MAAM,YAAY,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAE5C,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACzE,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,QAAQ,CAAC,QAAgB,EAAE,GAAG,UAAoB;QACvD,0BAA0B;QAC1B,MAAM,mBAAmB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/E,oEAAoE;QACpE,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,mBAAmB,CAAC,CAAC;QAE7D,wDAAwD;QACxD,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAEtC,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}
+{"version":3,"file":"PathSanitizer.helper.js","sourceRoot":"","sources":["../../source/Helper/PathSanitizer.helper.ts"],"names":[],"mappings":";;;;;AAAA,gDAAwB;AAExB;;;;;;;;;;GAUG;AACH;IACE;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,qBAAqB,CAAC,SAAiB;QAC5C,IAAI,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,SAAS,GAAG,SAAS;aACtB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAI,mBAAmB;aAC5C,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAM,sBAAsB;aAC/C,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAM,yBAAyB;aAClD,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAK,aAAa;QAEzC,iFAAiF;QACjF,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC;QAEvD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;QACxF,CAAC;QAED,gCAAgC;QAChC,IAAI,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,SAAS,GAAG,GAAG,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC3C,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,YAAY,CAAC,QAAgB,EAAE,QAAgB;QACpD,MAAM,YAAY,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC5C,MAAM,YAAY,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAE5C,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACzE,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,QAAQ,CAAC,QAAgB,EAAE,GAAG,UAAoB;QACvD,MAAM,mBAAmB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/E,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,mBAAmB,CAAC,CAAC;QAC7D,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAEtC,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF"}

package/lib/Helper/response.helper.d.ts

@@ -1,56 +1,15 @@
 import { ErrorInterface, SuccessInterface } from "../config/Interfaces/Helper/response.helper.interface";
 /**
- * @class ResponseHelper
- * @description A helper class to standardize API responses.
- *
- * @property {number} SucessCode - The HTTP status code for a successful response.
- * @property {number} ErrorCode - The HTTP status code for an error response.
- *
- * @constructor
- * Initializes the ResponseHelper with default status codes.
- *
- * @method Success
- * @async
- * @param {any} [data] - Optional data to include in the success response.
- * @returns {Promise<SuccessInterface>} A promise that resolves to a success response object.
- *
- * @method Error
- * @async
- * @param {string} [message] - Optional error message to include in the error response.
- * @returns {Promise<ErrorInterface>} A promise that resolves to an error response object.
- */
-/**
- * A helper class for generating standardized success and error response objects.
- *
- * @remarks
- * This class provides methods to generate success and error responses with predefined status codes.
- * It uses the `StatusCodes` enumeration to set the HTTP status codes for success and error responses.
- *
+ * Generates standardized success/error response objects.
  * @example
- * ```typescript
  * const responseHelper = new ResponseHelper();
  * const successResponse = await responseHelper.Success({ key: 'value' });
  * const errorResponse = await responseHelper.Error('An error occurred');
- * ```
- *
- * @public
  */
 export default class ResponseHelper {
     private SucessCode;
     private ErrorCode;
     constructor();
-    /**
-     * Generates a success response object.
-     *
-     * @param data - Optional data to include in the success response.
-     * @returns A promise that resolves to a success response object implementing the SuccessInterface.
-     */
     Success(data?: any): Promise<SuccessInterface>;
-    /**
-     * Generates an error response object.
-     *
-     * @param {string} [message] - Optional error message to include in the response.
-     * @returns {Promise<ErrorInterface>} A promise that resolves to an error response object.
-     */
     Error(message?: any): Promise<ErrorInterface>;
 }

package/lib/Helper/response.helper.js

@@ -9,56 +9,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-// Purpose: Helper class for response.
 const StatusCode_1 = require("../config/Keys/StatusCode");
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /**
- * @class ResponseHelper
- * @description A helper class to standardize API responses.
- *
- * @property {number} SucessCode - The HTTP status code for a successful response.
- * @property {number} ErrorCode - The HTTP status code for an error response.
- *
- * @constructor
- * Initializes the ResponseHelper with default status codes.
- *
- * @method Success
- * @async
- * @param {any} [data] - Optional data to include in the success response.
- * @returns {Promise<SuccessInterface>} A promise that resolves to a success response object.
- *
- * @method Error
- * @async
- * @param {string} [message] - Optional error message to include in the error response.
- * @returns {Promise<ErrorInterface>} A promise that resolves to an error response object.
- */
-/**
- * A helper class for generating standardized success and error response objects.
- *
- * @remarks
- * This class provides methods to generate success and error responses with predefined status codes.
- * It uses the `StatusCodes` enumeration to set the HTTP status codes for success and error responses.
- *
+ * Generates standardized success/error response objects.
  * @example
- * ```typescript
  * const responseHelper = new ResponseHelper();
  * const successResponse = await responseHelper.Success({ key: 'value' });
  * const errorResponse = await responseHelper.Error('An error occurred');
- * ```
- *
- * @public
  */
 class ResponseHelper {
     constructor() {
         this.SucessCode = StatusCode_1.StatusCodes.OK;
         this.ErrorCode = StatusCode_1.StatusCodes.INTERNAL_SERVER_ERROR;
     }
-    /**
-     * Generates a success response object.
-     *
-     * @param data - Optional data to include in the success response.
-     * @returns A promise that resolves to a success response object implementing the SuccessInterface.
-     */
     Success(data) {
         return __awaiter(this, void 0, void 0, function* () {
             return {
@@ -68,12 +32,6 @@ class ResponseHelper {
             };
         });
     }
-    /**
-     * Generates an error response object.
-     *
-     * @param {string} [message] - Optional error message to include in the response.
-     * @returns {Promise<ErrorInterface>} A promise that resolves to an error response object.
-     */
     Error(message) {
         return __awaiter(this, void 0, void 0, function* () {
             return {

package/lib/Helper/response.helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"response.helper.js","sourceRoot":"","sources":["../../source/Helper/response.helper.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,sCAAsC;AACtC,0DAAwD;AAQxD,uDAAuD;AACvD;;;;;;;;;;;;;;;;;;;GAmBG;AACH;;;;;;;;;;;;;;;GAeG;AACH;IAKE;QACE,IAAI,CAAC,UAAU,GAAG,wBAAW,CAAC,EAAE,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,wBAAW,CAAC,qBAAqB,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACU,OAAO,CAAC,IAAU;;YAC7B,OAAO;gBACL,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,MAAM,EAAE,IAAI;gBACZ,IAAI,EAAE,IAAI;aACX,CAAC;QACJ,CAAC;KAAA;IAED;;;;;OAKG;IACU,KAAK,CAAC,OAAa;;YAC9B,OAAO;gBACL,UAAU,EAAE,IAAI,CAAC,SAAS;gBAC1B,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE,OAAO;aACjB,CAAC;QACJ,CAAC;KAAA;CACF"}
+{"version":3,"file":"response.helper.js","sourceRoot":"","sources":["../../source/Helper/response.helper.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,0DAAwD;AAMxD,uDAAuD;AACvD;;;;;;GAMG;AACH;IAIE;QACE,IAAI,CAAC,UAAU,GAAG,wBAAW,CAAC,EAAE,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,wBAAW,CAAC,qBAAqB,CAAC;IACrD,CAAC;IAEY,OAAO,CAAC,IAAU;;YAC7B,OAAO;gBACL,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,MAAM,EAAE,IAAI;gBACZ,IAAI,EAAE,IAAI;aACX,CAAC;QACJ,CAAC;KAAA;IAEY,KAAK,CAAC,OAAa;;YAC9B,OAAO;gBACL,UAAU,EAAE,IAAI,CAAC,SAAS;gBAC1B,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE,OAAO;aACjB,CAAC;QACJ,CAAC;KAAA;CACF"}