axiodb 1.2.6 → 1.2.8

package/lib/Caching/cache.operation.d.ts

@@ -1,7 +1,36 @@
+/**
+ * @description This class is responsible for caching data in memory
+ * @class InMemoryCache
+ * @export InMemoryCache
+ * @version 1.0.1
+ * @since 24 December 2024
+ **/
 export default class InMemoryCache {
     private readonly ttl;
     private cacheObject;
+    /**
+     * Creates a new instance of the cache operation class
+     * @param TTL - Time to live in seconds for cache entries. Defaults to 60 seconds
+     */
     constructor(TTL?: string | number);
+    /**
+     * Sets a value in the cache with the specified key.
+     * The cached item will expire after the TTL (Time To Live) duration set for the cache.
+     *
+     * @param key - The unique identifier for the cached item
+     * @param value - The value to be stored in the cache
+     * @returns A Promise that resolves when the value has been cached
+     *
+     * @example
+     * ```typescript
+     * await cache.setCache('user-123', { name: 'John', age: 30 });
+     * ```
+     */
     setCache(key: string, value: any): Promise<void>;
+    /**
+     * Retrieves a value from the cache using the specified key
+     * @param key - The unique identifier to lookup in the cache
+     * @returns A Promise that resolves to the cached value if found and not expired, null otherwise
+     */
     getCache(key: string): Promise<any>;
 }

package/lib/Caching/cache.operation.js

@@ -9,11 +9,36 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * @description This class is responsible for caching data in memory
+ * @class InMemoryCache
+ * @export InMemoryCache
+ * @version 1.0.1
+ * @since 24 December 2024
+ **/
 class InMemoryCache {
+    /**
+     * Creates a new instance of the cache operation class
+     * @param TTL - Time to live in seconds for cache entries. Defaults to 60 seconds
+     */
     constructor(TTL = 60) {
         this.ttl = typeof TTL === "string" ? parseInt(TTL) : TTL;
         this.cacheObject = {};
     }
+    /**
+     * Sets a value in the cache with the specified key.
+     * The cached item will expire after the TTL (Time To Live) duration set for the cache.
+     *
+     * @param key - The unique identifier for the cached item
+     * @param value - The value to be stored in the cache
+     * @returns A Promise that resolves when the value has been cached
+     *
+     * @example
+     * ```typescript
+     * await cache.setCache('user-123', { name: 'John', age: 30 });
+     * ```
+     */
     setCache(key, value) {
         return __awaiter(this, void 0, void 0, function* () {
             this.cacheObject[key] = {
@@ -22,6 +47,11 @@ class InMemoryCache {
             };
         });
     }
+    /**
+     * Retrieves a value from the cache using the specified key
+     * @param key - The unique identifier to lookup in the cache
+     * @returns A Promise that resolves to the cached value if found and not expired, null otherwise
+     */
     getCache(key) {
         return __awaiter(this, void 0, void 0, function* () {
             const cacheItem = this.cacheObject[key];

package/lib/Caching/cache.operation.js.map

@@ -1 +1 @@
-{"version":3,"file":"cache.operation.js","sourceRoot":"","sources":["../../source/Caching/cache.operation.ts"],"names":[],"mappings":";;;;;;;;;;;AAQA,MAAqB,aAAa;IAShC,YAAY,MAAuB,EAAE;QACnC,IAAI,CAAC,GAAG,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QACzD,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAeY,QAAQ,CAAC,GAAW,EAAE,KAAU;;YAC3C,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG;gBACtB,KAAK,EAAE,KAAK;gBACZ,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,GAAG,IAAI;aACrC,CAAC;QACJ,CAAC;KAAA;IAOY,QAAQ,CAAC,GAAW;;YAC/B,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC;YACd,CAAC;YACD,IAAI,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;gBAClC,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBAC7B,OAAO,IAAI,CAAC;YACd,CAAC;YACD,OAAO,SAAS,CAAC,KAAK,CAAC;QACzB,CAAC;KAAA;CACF;AAlDD,gCAkDC"}
+{"version":3,"file":"cache.operation.js","sourceRoot":"","sources":["../../source/Caching/cache.operation.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,uDAAuD;AACvD;;;;;;IAMI;AACJ,MAAqB,aAAa;IAKhC;;;OAGG;IACH,YAAY,MAAuB,EAAE;QACnC,IAAI,CAAC,GAAG,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QACzD,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;OAYG;IACU,QAAQ,CAAC,GAAW,EAAE,KAAU;;YAC3C,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG;gBACtB,KAAK,EAAE,KAAK;gBACZ,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,GAAG,IAAI;aACrC,CAAC;QACJ,CAAC;KAAA;IAED;;;;OAIG;IACU,QAAQ,CAAC,GAAW;;YAC/B,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC;YACd,CAAC;YACD,IAAI,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;gBAClC,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBAC7B,OAAO,IAAI,CAAC;YACd,CAAC;YACD,OAAO,SAAS,CAAC,KAAK,CAAC;QACzB,CAAC;KAAA;CACF;AAlDD,gCAkDC"}

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

@@ -1,8 +1,33 @@
 export default class Converter {
     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): object;
+    /**
+     * 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

@@ -1,19 +1,44 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 class Converter {
-    constructor() { }
+    constructor() { } // Empty constructor
+    /**
+     * Converts a string to a boolean.
+     * @param value The string to convert.
+     * @returns The boolean value.
+     */
     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,MAAqB,SAAS;IAC5B,gBAAe,CAAC;IAOT,SAAS,CAAC,KAAa;QAC5B,OAAO,KAAK,KAAK,MAAM,CAAC;IAC1B,CAAC;IAQM,QAAQ,CAAC,KAAa;QAC3B,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAOM,QAAQ,CAAC,KAAa;QAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAOM,QAAQ,CAAC,KAAa;QAC3B,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAQM,aAAa,CAAC,KAAa;QAChC,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;CACF;AAjDD,4BAiDC"}
+{"version":3,"file":"Converter.helper.js","sourceRoot":"","sources":["../../source/Helper/Converter.helper.ts"],"names":[],"mappings":";;AAAA,MAAqB,SAAS;IAC5B,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;AAjDD,4BAiDC"}

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

@@ -1,13 +1,57 @@
 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.
+     */
     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<object>;
+    /**
+     * 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

@@ -13,38 +13,78 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CryptoHelper = void 0;
+// All Imports
 const node_os_1 = require("node:os");
 const response_helper_1 = __importDefault(require("./response.helper"));
 const outers_1 = require("outers");
 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.
+     */
     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 outers_1.ClassBased.CryptoGraphy(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":";;;;;;;;;;;;;;;AACA,qCAA6C;AAC7C,wEAA+C;AAE/C,mCAAoC;AACpC,0EAA2C;AAK3C,MAAa,YAAY;IA0BvB,YAAY,aAAsB;QAhBjB,mBAAc,GAAmB,IAAI,yBAAc,EAAE,CAAC;QAUtD,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,mBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpE,IAAI,CAAC,SAAS,GAAG,IAAI,0BAAS,EAAE,CAAC;IACnC,CAAC;IAQY,gBAAgB,CAC3B,aAAqB;;YAErB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;YACnC,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAChC,0CAA0C,CAC3C,CAAC;QACJ,CAAC;KAAA;IAOY,OAAO,CAAC,IAAY;;YAC/B,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC;KAAA;IAOY,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;IAOM,WAAW,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAOM,WAAW,CAAC,IAAY;QAC7B,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;IACtE,CAAC;CACF;AAnFD,oCAmFC"}
+{"version":3,"file":"Crypto.helper.js","sourceRoot":"","sources":["../../source/Helper/Crypto.helper.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,cAAc;AACd,qCAA6C;AAC7C,wEAA+C;AAE/C,mCAAoC;AACpC,0EAA2C;AAE3C;;GAEG;AACH,MAAa,YAAY;IAsBvB;;;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,mBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpE,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;AAnFD,oCAmFC"}

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

@@ -1,8 +1,56 @@
 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.
+ *
+ * @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,12 +9,56 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+// Purpose: Helper class for response.
 const outers_1 = require("outers");
+/* 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.
+ *
+ * @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 = outers_1.StatusCodes.OK;
         this.ErrorCode = outers_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 {
@@ -24,6 +68,12 @@ 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":";;;;;;;;;;;AACA,mCAAqC;AA6CrC,MAAqB,cAAc;IAKjC;QACE,IAAI,CAAC,UAAU,GAAG,oBAAW,CAAC,EAAE,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,oBAAW,CAAC,qBAAqB,CAAC;IACrD,CAAC;IAQY,OAAO,CAAC,IAAU;;YAC7B,OAAO;gBACL,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,MAAM,EAAE,IAAI;gBACZ,IAAI,EAAE,IAAI;aACX,CAAC;QACJ,CAAC;KAAA;IAQY,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;AArCD,iCAqCC"}
+{"version":3,"file":"response.helper.js","sourceRoot":"","sources":["../../source/Helper/response.helper.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,sCAAsC;AACtC,mCAAqC;AAQrC,uDAAuD;AACvD;;;;;;;;;;;;;;;;;;;GAmBG;AACH;;;;;;;;;;;;;;;GAeG;AACH,MAAqB,cAAc;IAKjC;QACE,IAAI,CAAC,UAAU,GAAG,oBAAW,CAAC,EAAE,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,oBAAW,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;AArCD,iCAqCC"}

package/lib/Models/DataTypes.models.js

@@ -4,7 +4,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SchemaTypes = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
 const joi_1 = __importDefault(require("joi"));
+// Create an object to hold all Joi types under the name SchemaTypes
 exports.SchemaTypes = {
     string: joi_1.default.string,
     number: joi_1.default.number,
@@ -16,6 +18,7 @@ exports.SchemaTypes = {
     func: joi_1.default.func,
     ref: joi_1.default.ref,
     any: joi_1.default.any,
+    // Add additional types from Joi if needed
     alphanum: joi_1.default.string().alphanum,
     email: joi_1.default.string().email,
     guid: joi_1.default.string().guid,

package/lib/Models/DataTypes.models.js.map

@@ -1 +1 @@
-{"version":3,"file":"DataTypes.models.js","sourceRoot":"","sources":["../../source/Models/DataTypes.models.ts"],"names":[],"mappings":";;;;;;AACA,8CAAsB;AAGT,QAAA,WAAW,GAAG;IACzB,MAAM,EAAE,aAAG,CAAC,MAAM;IAClB,MAAM,EAAE,aAAG,CAAC,MAAM;IAClB,OAAO,EAAE,aAAG,CAAC,OAAO;IACpB,MAAM,EAAE,aAAG,CAAC,MAAM;IAClB,KAAK,EAAE,aAAG,CAAC,KAAK;IAChB,IAAI,EAAE,aAAG,CAAC,IAAI;IACd,MAAM,EAAE,aAAG,CAAC,MAAM;IAClB,IAAI,EAAE,aAAG,CAAC,IAAI;IACd,GAAG,EAAE,aAAG,CAAC,GAAG;IACZ,GAAG,EAAE,aAAG,CAAC,GAAG;IAEZ,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ;IAC/B,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK;IACzB,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI;IACvB,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,EAAE;IACnB,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG;IACrB,GAAG,EAAE,CAAC,KAA6B,EAAE,EAAE,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC;IAC/D,GAAG,EAAE,CAAC,KAA6B,EAAE,EAAE,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC;IAC/D,MAAM,EAAE,CAAC,KAA6B,EAAE,EAAE,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC;IACrE,OAAO,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IACvD,QAAQ,EAAE,GAAG,EAAE,CAAC,aAAG,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAE,GAAG,EAAE,CAAC,aAAG,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,CAAC,MAAa,EAAE,EAAE,CAAC,aAAG,CAAC,KAAK,CAAC,MAAM,CAAC;IAC3C,KAAK,EAAE,CAAC,MAAa,EAAE,EAAE,CAAC,aAAG,CAAC,KAAK,CAAC,MAAM,CAAC;CAC5C,CAAC"}
+{"version":3,"file":"DataTypes.models.js","sourceRoot":"","sources":["../../source/Models/DataTypes.models.ts"],"names":[],"mappings":";;;;;;AAAA,uDAAuD;AACvD,8CAAsB;AAEtB,oEAAoE;AACvD,QAAA,WAAW,GAAG;IACzB,MAAM,EAAE,aAAG,CAAC,MAAM;IAClB,MAAM,EAAE,aAAG,CAAC,MAAM;IAClB,OAAO,EAAE,aAAG,CAAC,OAAO;IACpB,MAAM,EAAE,aAAG,CAAC,MAAM;IAClB,KAAK,EAAE,aAAG,CAAC,KAAK;IAChB,IAAI,EAAE,aAAG,CAAC,IAAI;IACd,MAAM,EAAE,aAAG,CAAC,MAAM;IAClB,IAAI,EAAE,aAAG,CAAC,IAAI;IACd,GAAG,EAAE,aAAG,CAAC,GAAG;IACZ,GAAG,EAAE,aAAG,CAAC,GAAG;IACZ,0CAA0C;IAC1C,QAAQ,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ;IAC/B,KAAK,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,KAAK;IACzB,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,IAAI;IACvB,EAAE,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,EAAE;IACnB,GAAG,EAAE,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG;IACrB,GAAG,EAAE,CAAC,KAA6B,EAAE,EAAE,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC;IAC/D,GAAG,EAAE,CAAC,KAA6B,EAAE,EAAE,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC;IAC/D,MAAM,EAAE,CAAC,KAA6B,EAAE,EAAE,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC;IACrE,OAAO,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IACvD,QAAQ,EAAE,GAAG,EAAE,CAAC,aAAG,CAAC,QAAQ,EAAE;IAC9B,QAAQ,EAAE,GAAG,EAAE,CAAC,aAAG,CAAC,QAAQ,EAAE;IAC9B,KAAK,EAAE,CAAC,MAAa,EAAE,EAAE,CAAC,aAAG,CAAC,KAAK,CAAC,MAAM,CAAC;IAC3C,KAAK,EAAE,CAAC,MAAa,EAAE,EAAE,CAAC,aAAG,CAAC,KAAK,CAAC,MAAM,CAAC;CAC5C,CAAC"}

package/lib/Models/validator.models.d.ts

@@ -1,2 +1,9 @@
 import { Schema } from "joi";
+/**
+ * Validates the provided data against the given Joi schema.
+ *
+ * @param dataSchema - The Joi schema to validate against.
+ * @param data - The data to be validated.
+ * @returns A promise that resolves with the validated data if validation is successful, or rejects with a validation error.
+ */
 export default function schemaValidate(dataSchema: Schema, data: any): Promise<any>;

package/lib/Models/validator.models.js

@@ -13,12 +13,21 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = schemaValidate;
-const joi_1 = __importDefault(require("joi"));
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const joi_1 = __importDefault(require("joi")); // Ensure to import Joi correctly
+/**
+ * Validates the provided data against the given Joi schema.
+ *
+ * @param dataSchema - The Joi schema to validate against.
+ * @param data - The data to be validated.
+ * @returns A promise that resolves with the validated data if validation is successful, or rejects with a validation error.
+ */
 function schemaValidate(dataSchema, data) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            const joiSchema = joi_1.default.object(dataSchema);
-            return yield joiSchema.validateAsync(data);
+            // Use Joi.object() correctly to wrap the schema and validate data.
+            const joiSchema = joi_1.default.object(dataSchema); // Converts the provided schema to a Joi object
+            return yield joiSchema.validateAsync(data); // Validate the actual data against the schema
         }
         catch (error) {
             return error;

package/lib/Models/validator.models.js.map

@@ -1 +1 @@
-{"version":3,"file":"validator.models.js","sourceRoot":"","sources":["../../source/Models/validator.models.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAUA,iCAWC;AApBD,8CAAkC;AASlC,SAA8B,cAAc,CAC1C,UAAkB,EAClB,IAAS;;QAET,IAAI,CAAC;YAEH,MAAM,SAAS,GAAG,aAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACzC,OAAO,MAAM,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;CAAA"}
+{"version":3,"file":"validator.models.js","sourceRoot":"","sources":["../../source/Models/validator.models.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAUA,iCAWC;AArBD,uDAAuD;AACvD,8CAAkC,CAAC,iCAAiC;AAEpE;;;;;;GAMG;AACH,SAA8B,cAAc,CAC1C,UAAkB,EAClB,IAAS;;QAET,IAAI,CAAC;YACH,mEAAmE;YACnE,MAAM,SAAS,GAAG,aAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,+CAA+C;YACzF,OAAO,MAAM,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,8CAA8C;QAC5F,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;CAAA"}

package/lib/Operation/CRUD Operation/Create.operation.d.ts

@@ -1,8 +1,25 @@
 import { ErrorInterface, SuccessInterface } from "../../config/Interfaces/Helper/response.helper.interface";
+/**
+ * Class representing an insertion operation.
+ */
 export default class Insertion {
     private readonly collectionName;
     private readonly path;
-    constructor(collectionName: string, path: object | any);
+    private readonly Converter;
+    /**
+     * Creates an instance of Insertion.
+     * @param {string} collectionName - The name of the collection.
+     * @param {string | any} path - The data to be inserted.
+     */
+    constructor(collectionName: string, path: string | any);
+    /**
+     * Saves the data to a file.
+     * @returns {Promise<any>} A promise that resolves with the response of the save operation.
+     */
     Save(data: object | any): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Generates a unique document ID.
+     * @returns {Promise<string>} A promise that resolves with a unique document ID.
+     */
     private generateUniqueDocumentId;
 }