axiodb 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ankan Saha
+
+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.

package/README.md

@@ -0,0 +1,29 @@
+# AxioDB
+
+[![npm version](https://badge.fury.io/js/axiodb.svg)](https://badge.fury.io/js/axiodb)
+
+AxioDB is a JSON-based database management system built using Node.js streams, designed to offer an all-in-one solution for data management. It provides a flexible and efficient way to handle data storage, retrieval, and manipulation without the need for a traditional database setup.
+
+## Features
+
+- **Custom Schemas:** Define your own data schemas for structured data management.
+- **Data Manipulation:** Easily perform operations like create, read, update, and delete (CRUD) on your JSON files.
+- **Query Capabilities:** Support for advanced querying with methods like `find()`, `skip()`, and `limit()`.
+- **Stream Support:** Utilize Node.js streams for efficient data reading and writing.
+- **Custom Encryption:** Implement your own encryption algorithms to secure sensitive data.
+- **DaaS (Data as a Service):** Easily integrate your data management capabilities into a DaaS model.
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js (v14 or higher)
+- npm (v6 or higher)
+
+### Installation
+
+To install AxioDB, run the following command:
+
+```bash
+npm install axiodb@latest --save
+```

package/eslint.config.mjs

@@ -0,0 +1,10 @@
+import globals from 'globals'
+import pluginJs from '@eslint/js'
+import tseslint from 'typescript-eslint'
+
+export default [
+  { files: ['**/*.{js,mjs,cjs,ts}'] },
+  { languageOptions: { globals: globals.browser } },
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended
+]

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

@@ -0,0 +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

@@ -0,0 +1,88 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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 {
+                statusCode: this.SucessCode,
+                status: true,
+                data: data,
+            };
+        });
+    }
+    /**
+     * 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 {
+                statusCode: this.ErrorCode,
+                status: false,
+                message: message,
+            };
+        });
+    }
+}
+exports.default = ResponseHelper;
+//# sourceMappingURL=response.helper.js.map

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

@@ -0,0 +1 @@
+{"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.d.ts

@@ -0,0 +1,26 @@
+import Joi from "joi";
+export declare const SchemaTypes: {
+    string: <TSchema = string>() => Joi.StringSchema<TSchema>;
+    number: <TSchema = number>() => Joi.NumberSchema<TSchema>;
+    boolean: <TSchema = boolean>() => Joi.BooleanSchema<TSchema>;
+    object: <TSchema = any, isStrict = false, T = TSchema>(schema?: Joi.SchemaMap<T, isStrict>) => Joi.ObjectSchema<TSchema>;
+    array: <TSchema = any[]>() => Joi.ArraySchema<TSchema>;
+    date: <TSchema = Date>() => Joi.DateSchema<TSchema>;
+    binary: <TSchema = Buffer>() => Joi.BinarySchema<TSchema>;
+    func: <TSchema = Function>() => Joi.FunctionSchema<TSchema>;
+    ref: (key: string, options?: Joi.ReferenceOptions) => Joi.Reference;
+    any: <TSchema = any>() => Joi.AnySchema<TSchema>;
+    alphanum: () => Joi.StringSchema<string>;
+    email: (options?: Joi.EmailOptions) => Joi.StringSchema<string>;
+    guid: (options?: Joi.GuidOptions) => Joi.StringSchema<string>;
+    ip: (options?: Joi.IpOptions) => Joi.StringSchema<string>;
+    uri: (options?: Joi.UriOptions) => Joi.StringSchema<string>;
+    max: (limit: number | Joi.Reference) => Joi.NumberSchema<number>;
+    min: (limit: number | Joi.Reference) => Joi.NumberSchema<number>;
+    length: (limit: number | Joi.Reference) => Joi.StringSchema<string>;
+    pattern: (regex: RegExp) => Joi.StringSchema<string>;
+    required: () => Joi.Schema<any>;
+    optional: () => Joi.Schema<any>;
+    allow: (values: any[]) => Joi.Schema<any>;
+    valid: (values: any[]) => Joi.Schema<any>;
+};

package/lib/Models/DataTypes.models.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": 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,
+    boolean: joi_1.default.boolean,
+    object: joi_1.default.object,
+    array: joi_1.default.array,
+    date: joi_1.default.date,
+    binary: joi_1.default.binary,
+    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,
+    ip: joi_1.default.string().ip,
+    uri: joi_1.default.string().uri,
+    max: (limit) => joi_1.default.number().max(limit),
+    min: (limit) => joi_1.default.number().min(limit),
+    length: (limit) => joi_1.default.string().length(limit),
+    pattern: (regex) => joi_1.default.string().pattern(regex),
+    required: () => joi_1.default.required(),
+    optional: () => joi_1.default.optional(),
+    allow: (values) => joi_1.default.allow(values),
+    valid: (values) => joi_1.default.valid(values),
+};
+//# sourceMappingURL=DataTypes.models.js.map

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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +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

@@ -0,0 +1,37 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = schemaValidate;
+/* 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 {
+            // 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;
+        }
+    });
+}
+//# sourceMappingURL=validator.models.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validator.models.js","sourceRoot":"","sources":["../../source/Models/validator.models.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAUA,iCAQC;AAlBD,uDAAuD;AACvD,8CAAkC,CAAC,iCAAiC;AAEpE;;;;;;GAMG;AACH,SAA8B,cAAc,CAAC,UAAkB,EAAE,IAAS;;QACxE,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/Indexation.operation.d.ts

@@ -0,0 +1,23 @@
+export default class Configure {
+    #private;
+    private readonly Schema;
+    private isEncrypted;
+    private readonly clusterName;
+    private readonly currentPATH;
+    constructor(Schema: object | any, isEncrypted?: boolean, ClusterName?: string);
+    getSchema(): object | any;
+    EncryptionStatus(): boolean;
+    getEncryptionKey(): string;
+    setEncryptionKey(key: string): void;
+    setEncryptionStatus(status: boolean): void;
+    getConfiguration(): object | any;
+    /**
+     * Creates the root directory for the tree structure.
+     *
+     * This method initializes the root directory using the cluster name.
+     * It utilizes the FolderManager to create the directory asynchronously.
+     *
+     * @returns {Promise<void>} A promise that resolves when the directory is created.
+     */
+    private CreateTreeRoot;
+}

package/lib/Operation/Indexation.operation.js

@@ -0,0 +1,83 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _Configure_encryptionKey;
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import Libraries
+const DB_1 = require("../config/DB");
+const path_1 = __importDefault(require("path"));
+class Configure {
+    constructor(Schema, isEncrypted = false, ClusterName = DB_1.DBMS_Name) {
+        _Configure_encryptionKey.set(this, void 0); // Private Property
+        this.Schema = Schema;
+        this.isEncrypted = isEncrypted;
+        __classPrivateFieldSet(this, _Configure_encryptionKey, DB_1.DBMS_Name, "f");
+        this.clusterName = ClusterName;
+        this.currentPATH = path_1.default.resolve(".");
+        this.CreateTreeRoot(); // Create
+    }
+    // Configure Method
+    getSchema() {
+        return this.Schema;
+    }
+    EncryptionStatus() {
+        return this.isEncrypted;
+    }
+    getEncryptionKey() {
+        return __classPrivateFieldGet(this, _Configure_encryptionKey, "f");
+    }
+    setEncryptionKey(key) {
+        __classPrivateFieldSet(this, _Configure_encryptionKey, key, "f");
+    }
+    setEncryptionStatus(status) {
+        this.isEncrypted = status;
+    }
+    getConfiguration() {
+        return {
+            Schema: this.getSchema(),
+            Encryption: {
+                Status: this.EncryptionStatus(),
+                Key: this.getEncryptionKey(),
+            },
+        };
+    }
+    // Internal Functions
+    /**
+     * Creates the root directory for the tree structure.
+     *
+     * This method initializes the root directory using the cluster name.
+     * It utilizes the FolderManager to create the directory asynchronously.
+     *
+     * @returns {Promise<void>} A promise that resolves when the directory is created.
+     */
+    CreateTreeRoot() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield new DB_1.FolderManager().CreateDirectory(`${this.currentPATH}/${this.clusterName}`);
+        });
+    }
+}
+_Configure_encryptionKey = new WeakMap();
+exports.default = Configure;
+//# sourceMappingURL=Indexation.operation.js.map

package/lib/Operation/Indexation.operation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Indexation.operation.js","sourceRoot":"","sources":["../../source/Operation/Indexation.operation.ts"],"names":[],"mappings":";AAAA,uDAAuD;;;;;;;;;;;;;;;;;;;;;;;;;;AAEvD,mBAAmB;AACnB,qCAAwD;AACxD,gDAAwB;AAExB,MAAqB,SAAS;IAQ5B,YACE,MAAoB,EACpB,WAAW,GAAG,KAAK,EACnB,cAAsB,cAAS;QAPjC,2CAAuB,CAAC,mBAAmB;QASzC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,uBAAA,IAAI,4BAAkB,cAAS,MAAA,CAAC;QAChC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,cAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,SAAS;IAClC,CAAC;IAED,mBAAmB;IACZ,SAAS;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAEM,gBAAgB;QACrB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEM,gBAAgB;QACrB,OAAO,uBAAA,IAAI,gCAAe,CAAC;IAC7B,CAAC;IAEM,gBAAgB,CAAC,GAAW;QACjC,uBAAA,IAAI,4BAAkB,GAAG,MAAA,CAAC;IAC5B,CAAC;IAEM,mBAAmB,CAAC,MAAe;QACxC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;IAC5B,CAAC;IAEM,gBAAgB;QACrB,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE;YACxB,UAAU,EAAE;gBACV,MAAM,EAAE,IAAI,CAAC,gBAAgB,EAAE;gBAC/B,GAAG,EAAE,IAAI,CAAC,gBAAgB,EAAE;aAC7B;SACF,CAAC;IACJ,CAAC;IAED,qBAAqB;IACrB;;;;;;;OAOG;IACW,cAAc;;YAC1B,MAAM,IAAI,kBAAa,EAAE,CAAC,eAAe,CACvC,GAAG,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,EAAE,CAC1C,CAAC;QACJ,CAAC;KAAA;CACF;;kBAlEoB,SAAS"}

package/lib/Storage/FileManager.d.ts

@@ -0,0 +1,100 @@
+import FileSystemSync from "fs";
+import { ErrorInterface, SuccessInterface } from "../config/Interfaces/Helper/response.helper.interface";
+/**
+ * Class responsible for managing file operations.
+ */
+export default class FileManager {
+    /**
+     * Reference to the file system module.
+     */
+    private readonly fileSystem;
+    private readonly fileSystemSync;
+    private readonly responseHelper;
+    /**
+     * Initializes a new instance of the FileManager class.
+     */
+    constructor();
+    /**
+     * Writes data to a file at the specified path.
+     *
+     * @param path - The path where the file will be written.
+     * @param data - The data to write to the file.
+     * @returns A promise that resolves when the file has been written.
+     */
+    WriteFile(path: string, data: string): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Reads data from a file at the specified path.
+     *
+     * @param path - The path of the file to read.
+     * @returns A promise that resolves with the data read from the file.
+     */
+    ReadFile(path: string): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Deletes a file at the specified path.
+     *
+     * @param path - The path of the file to delete.
+     * @returns A promise that resolves when the file has been deleted.
+     */
+    DeleteFile(path: string): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Checks if a file exists at the specified path.
+     *
+     * @param path - The path of the file to check.
+     * @returns A promise that resolves with a boolean indicating if the file exists.
+     */
+    FileExists(path: string): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Creates a new file at the specified path.
+     *
+     * @param path - The path of the file to create.
+     * @returns A promise that resolves when the file has been created.
+     */
+    CreateFile(path: string): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Locks a file at the specified path.
+     *
+     * @param path - The path of the file to lock.
+     * @returns A promise that resolves when the file has been locked.
+     */
+    LockFile(path: string): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Unlocks a file at the specified path.
+     *
+     * @param path - The path of the file to unlock.
+     * @returns A promise that resolves when the file has been unlocked.
+     */
+    UnlockFile(path: string): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Moves a file from the specified old path to the new path.
+     *
+     * @param oldPath - The current path of the file to be moved.
+     * @param newPath - The destination path where the file should be moved.
+     * @returns A promise that resolves to a SuccessInterface if the file is moved successfully,
+     * or an ErrorInterface if an error occurs during the move operation.
+     */
+    MoveFile(oldPath: string, newPath: string): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Checks if a file is locked by examining its file mode.
+     *
+     * @param path - The path to the file to check.
+     * @returns A promise that resolves to a `SuccessInterface` if the file is locked,
+     *          or an `ErrorInterface` if an error occurs.
+     *
+     * The file is considered locked if its mode (permissions) ends with "400".
+     */
+    IsFileLocked(path: string): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Creates a read stream for the file at the specified path.
+     *
+     * @param path - The path of the file to read.
+     * @returns A read stream for the file.
+     */
+    CreateReadStream(path: string): Promise<ErrorInterface | FileSystemSync.ReadStream>;
+    /**
+     * Creates a write stream for the file at the specified path.
+     *
+     * @param path - The path of the file to write.
+     * @returns A write stream for the file.
+     */
+    CreateWriteStream(path: string): Promise<ErrorInterface | FileSystemSync.WriteStream>;
+}

package/lib/Storage/FileManager.js

@@ -0,0 +1,226 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const promises_1 = __importDefault(require("fs/promises"));
+const fs_1 = __importDefault(require("fs"));
+// Import Helpers
+const response_helper_1 = __importDefault(require("../Helper/response.helper"));
+/**
+ * Class responsible for managing file operations.
+ */
+class FileManager {
+    /**
+     * Initializes a new instance of the FileManager class.
+     */
+    constructor() {
+        this.fileSystem = promises_1.default;
+        this.fileSystemSync = fs_1.default;
+        this.responseHelper = new response_helper_1.default();
+    }
+    /**
+     * Writes data to a file at the specified path.
+     *
+     * @param path - The path where the file will be written.
+     * @param data - The data to write to the file.
+     * @returns A promise that resolves when the file has been written.
+     */
+    WriteFile(path, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const SuccesResponse = yield this.fileSystem.writeFile(path, data);
+                return yield this.responseHelper.Success(SuccesResponse);
+            }
+            catch (error) {
+                return yield this.responseHelper.Error(error);
+            }
+        });
+    }
+    /**
+     * Reads data from a file at the specified path.
+     *
+     * @param path - The path of the file to read.
+     * @returns A promise that resolves with the data read from the file.
+     */
+    ReadFile(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const ReadResponse = yield this.fileSystem.readFile(path, "utf-8");
+                return yield this.responseHelper.Success(ReadResponse);
+            }
+            catch (error) {
+                return yield this.responseHelper.Error(error);
+            }
+        });
+    }
+    /**
+     * Deletes a file at the specified path.
+     *
+     * @param path - The path of the file to delete.
+     * @returns A promise that resolves when the file has been deleted.
+     */
+    DeleteFile(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const DeleteResponse = yield this.fileSystem.unlink(path);
+                return this.responseHelper.Success(DeleteResponse);
+            }
+            catch (error) {
+                return this.responseHelper.Error(error);
+            }
+        });
+    }
+    /**
+     * Checks if a file exists at the specified path.
+     *
+     * @param path - The path of the file to check.
+     * @returns A promise that resolves with a boolean indicating if the file exists.
+     */
+    FileExists(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const ExistsResponse = yield this.fileSystem.access(path);
+                return this.responseHelper.Success(ExistsResponse);
+            }
+            catch (error) {
+                return this.responseHelper.Error(error);
+            }
+        });
+    }
+    /**
+     * Creates a new file at the specified path.
+     *
+     * @param path - The path of the file to create.
+     * @returns A promise that resolves when the file has been created.
+     */
+    CreateFile(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const CreateResponse = yield this.fileSystem.writeFile(path, "");
+                return this.responseHelper.Success(CreateResponse);
+            }
+            catch (error) {
+                return this.responseHelper.Error(error);
+            }
+        });
+    }
+    // Lock/Unlock Operations
+    /**
+     * Locks a file at the specified path.
+     *
+     * @param path - The path of the file to lock.
+     * @returns A promise that resolves when the file has been locked.
+     */
+    LockFile(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const LockResponse = yield this.fileSystem.chmod(path, 0o400);
+                return this.responseHelper.Success(LockResponse);
+            }
+            catch (error) {
+                return this.responseHelper.Error(error);
+            }
+        });
+    }
+    /**
+     * Unlocks a file at the specified path.
+     *
+     * @param path - The path of the file to unlock.
+     * @returns A promise that resolves when the file has been unlocked.
+     */
+    UnlockFile(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const UnlockResponse = yield this.fileSystem.chmod(path, 0o777);
+                return this.responseHelper.Success(UnlockResponse);
+            }
+            catch (error) {
+                return this.responseHelper.Error(error);
+            }
+        });
+    }
+    /**
+     * Moves a file from the specified old path to the new path.
+     *
+     * @param oldPath - The current path of the file to be moved.
+     * @param newPath - The destination path where the file should be moved.
+     * @returns A promise that resolves to a SuccessInterface if the file is moved successfully,
+     * or an ErrorInterface if an error occurs during the move operation.
+     */
+    MoveFile(oldPath, newPath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const MoveResponse = yield this.fileSystem.rename(oldPath, newPath);
+                return this.responseHelper.Success(MoveResponse);
+            }
+            catch (error) {
+                return this.responseHelper.Error(error);
+            }
+        });
+    }
+    /**
+     * Checks if a file is locked by examining its file mode.
+     *
+     * @param path - The path to the file to check.
+     * @returns A promise that resolves to a `SuccessInterface` if the file is locked,
+     *          or an `ErrorInterface` if an error occurs.
+     *
+     * The file is considered locked if its mode (permissions) ends with "400".
+     */
+    IsFileLocked(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const Stats = yield this.fileSystem.stat(path);
+                return this.responseHelper.Success(Stats.mode.toString(8).slice(-3) === "400");
+            }
+            catch (error) {
+                return this.responseHelper.Error(error);
+            }
+        });
+    }
+    // Stream Operations
+    /**
+     * Creates a read stream for the file at the specified path.
+     *
+     * @param path - The path of the file to read.
+     * @returns A read stream for the file.
+     */
+    CreateReadStream(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return this.fileSystemSync.createReadStream(path);
+            }
+            catch (error) {
+                return yield this.responseHelper.Error(error);
+            }
+        });
+    }
+    /**
+     * Creates a write stream for the file at the specified path.
+     *
+     * @param path - The path of the file to write.
+     * @returns A write stream for the file.
+     */
+    CreateWriteStream(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return this.fileSystemSync.createWriteStream(path);
+            }
+            catch (error) {
+                return yield this.responseHelper.Error(error);
+            }
+        });
+    }
+}
+exports.default = FileManager;
+//# sourceMappingURL=FileManager.js.map

package/lib/Storage/FileManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileManager.js","sourceRoot":"","sources":["../../source/Storage/FileManager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,2DAAqC;AACrC,4CAAgC;AAEhC,iBAAiB;AACjB,gFAAuD;AAMvD;;GAEG;AACH,MAAqB,WAAW;IAQ9B;;OAEG;IACH;QACE,IAAI,CAAC,UAAU,GAAG,kBAAU,CAAC;QAC7B,IAAI,CAAC,cAAc,GAAG,YAAc,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAc,EAAE,CAAC;IAC7C,CAAC;IAED;;;;;;OAMG;IACU,SAAS,CACpB,IAAY,EACZ,IAAY;;YAEZ,IAAI,CAAC;gBACH,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACnE,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YAC3D,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACU,QAAQ,CACnB,IAAY;;YAEZ,IAAI,CAAC;gBACH,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;gBACnE,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YACzD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACU,UAAU,CACrB,IAAY;;YAEZ,IAAI,CAAC;gBACH,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC1D,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YACrD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACU,UAAU,CACrB,IAAY;;YAEZ,IAAI,CAAC;gBACH,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC1D,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YACrD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IAEU,UAAU,CACrB,IAAY;;YAEZ,IAAI,CAAC;gBACH,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBACjE,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YACrD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAED,yBAAyB;IAEzB;;;;;OAKG;IACU,QAAQ,CACnB,IAAY;;YAEZ,IAAI,CAAC;gBACH,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAC9D,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YACnD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACU,UAAU,CACrB,IAAY;;YAEZ,IAAI,CAAC;gBACH,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAChE,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YACrD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;OAOG;IACU,QAAQ,CACnB,OAAe,EACf,OAAe;;YAEf,IAAI,CAAC;gBACH,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBACpE,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YACnD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;OAQG;IACU,YAAY,CACvB,IAAY;;YAEZ,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC/C,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAChC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,CAC3C,CAAC;YACJ,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAED,oBAAoB;IAEpB;;;;;OAKG;IACU,gBAAgB,CAC3B,IAAY;;YAEZ,IAAI,CAAC;gBACH,OAAO,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;YACpD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACU,iBAAiB,CAC5B,IAAY;;YAEZ,IAAI,CAAC;gBACH,OAAO,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;YACrD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;KAAA;CACF;AAxND,8BAwNC"}

package/lib/Storage/FolderManager.d.ts

@@ -0,0 +1,65 @@
+import { ErrorInterface, SuccessInterface } from "../config/Interfaces/Helper/response.helper.interface";
+export default class FolderManager {
+    private readonly fileSystem;
+    private readonly fileSystemSync;
+    private readonly responseHelper;
+    constructor();
+    /**
+     * Creates a new directory at the specified path.
+     *
+     * @param path - The path of the directory to create.
+     * @returns A promise that resolves when the directory has been created.
+     */
+    CreateDirectory(path: string): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Deletes a directory at the specified path.
+     *
+     * @param path - The path of the directory to delete.
+     * @returns A promise that resolves when the directory has been deleted.
+     */
+    DeleteDirectory(path: string): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Checks if a directory exists at the specified path.
+     *
+     * @param path - The path of the directory to check.
+     * @returns A promise that resolves with a boolean indicating if the directory exists.
+     */
+    DirectoryExists(path: string): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Lists the contents of a directory at the specified path.
+     *
+     * @param path - The path of the directory to list.
+     * @returns A promise that resolves with an array of directory contents.
+     */
+    ListDirectory(path: string): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Moves a directory from the old path to the new path.
+     *
+     * @param oldPath - The current path of the directory to be moved.
+     * @param newPath - The new path where the directory should be moved.
+     * @returns A promise that resolves to a SuccessInterface if the operation is successful,
+     * or an ErrorInterface if an error occurs.
+     */
+    MoveDirectory(oldPath: string, newPath: string): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Locks a directory at the specified path.
+     *
+     * @param path - The path of the directory to lock.
+     * @returns A promise that resolves when the directory has been locked.
+     */
+    LockDirectory(path: string): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Unlocks a directory at the specified path.
+     *
+     * @param path - The path of the directory to unlock.
+     * @returns A promise that resolves when the directory has been unlocked.
+     */
+    UnlockDirectory(path: string): Promise<SuccessInterface | ErrorInterface>;
+    /**
+     * Checks if a directory is locked at the specified path.
+     *
+     * @param path - The path of the directory to check.
+     * @returns A promise that resolves with a boolean indicating if the directory is locked.
+     */
+    IsDirectoryLocked(path: string): Promise<SuccessInterface | ErrorInterface>;
+}

package/lib/Storage/FolderManager.js

@@ -0,0 +1,166 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const promises_1 = __importDefault(require("fs/promises"));
+const fs_1 = __importDefault(require("fs"));
+// Import Helpers
+const response_helper_1 = __importDefault(require("../Helper/response.helper"));
+class FolderManager {
+    constructor() {
+        this.fileSystem = promises_1.default;
+        this.fileSystemSync = fs_1.default;
+        this.responseHelper = new response_helper_1.default();
+    }
+    /**
+     * Creates a new directory at the specified path.
+     *
+     * @param path - The path of the directory to create.
+     * @returns A promise that resolves when the directory has been created.
+     */
+    CreateDirectory(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const CreateResponse = yield this.fileSystem.mkdir(path);
+                return this.responseHelper.Success(CreateResponse);
+            }
+            catch (error) {
+                return this.responseHelper.Error(error);
+            }
+        });
+    }
+    /**
+     * Deletes a directory at the specified path.
+     *
+     * @param path - The path of the directory to delete.
+     * @returns A promise that resolves when the directory has been deleted.
+     */
+    DeleteDirectory(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const DeleteResponse = yield this.fileSystem.rmdir(path);
+                return this.responseHelper.Success(DeleteResponse);
+            }
+            catch (error) {
+                return this.responseHelper.Error(error);
+            }
+        });
+    }
+    /**
+     * Checks if a directory exists at the specified path.
+     *
+     * @param path - The path of the directory to check.
+     * @returns A promise that resolves with a boolean indicating if the directory exists.
+     */
+    DirectoryExists(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const ExistsResponse = yield this.fileSystem.access(path);
+                return this.responseHelper.Success(ExistsResponse);
+            }
+            catch (error) {
+                return this.responseHelper.Error(error);
+            }
+        });
+    }
+    /**
+     * Lists the contents of a directory at the specified path.
+     *
+     * @param path - The path of the directory to list.
+     * @returns A promise that resolves with an array of directory contents.
+     */
+    ListDirectory(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const ListResponse = yield this.fileSystem.readdir(path);
+                return this.responseHelper.Success(ListResponse);
+            }
+            catch (error) {
+                return this.responseHelper.Error(error);
+            }
+        });
+    }
+    /**
+     * Moves a directory from the old path to the new path.
+     *
+     * @param oldPath - The current path of the directory to be moved.
+     * @param newPath - The new path where the directory should be moved.
+     * @returns A promise that resolves to a SuccessInterface if the operation is successful,
+     * or an ErrorInterface if an error occurs.
+     */
+    MoveDirectory(oldPath, newPath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const MoveResponse = yield this.fileSystem.rename(oldPath, newPath);
+                return this.responseHelper.Success(MoveResponse);
+            }
+            catch (error) {
+                return this.responseHelper.Error(error);
+            }
+        });
+    }
+    /**
+     * Locks a directory at the specified path.
+     *
+     * @param path - The path of the directory to lock.
+     * @returns A promise that resolves when the directory has been locked.
+     */
+    LockDirectory(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const LockResponse = yield this.fileSystem.chmod(path, 0o400);
+                return this.responseHelper.Success(LockResponse);
+            }
+            catch (error) {
+                return this.responseHelper.Error(error);
+            }
+        });
+    }
+    /**
+     * Unlocks a directory at the specified path.
+     *
+     * @param path - The path of the directory to unlock.
+     * @returns A promise that resolves when the directory has been unlocked.
+     */
+    UnlockDirectory(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const UnlockResponse = yield this.fileSystem.chmod(path, 0o777);
+                return this.responseHelper.Success(UnlockResponse);
+            }
+            catch (error) {
+                return this.responseHelper.Error(error);
+            }
+        });
+    }
+    /**
+     * Checks if a directory is locked at the specified path.
+     *
+     * @param path - The path of the directory to check.
+     * @returns A promise that resolves with a boolean indicating if the directory is locked.
+     */
+    IsDirectoryLocked(path) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const Stats = yield this.fileSystem.stat(path);
+                const IsLocked = Stats.mode.toString(8).slice(-3) === "400";
+                return this.responseHelper.Success(IsLocked);
+            }
+            catch (error) {
+                return this.responseHelper.Error(error);
+            }
+        });
+    }
+}
+exports.default = FolderManager;
+//# sourceMappingURL=FolderManager.js.map

package/lib/Storage/FolderManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FolderManager.js","sourceRoot":"","sources":["../../source/Storage/FolderManager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,2DAAqC;AACrC,4CAAgC;AAEhC,iBAAiB;AACjB,gFAAuD;AAMvD,MAAqB,aAAa;IAKhC;QACE,IAAI,CAAC,UAAU,GAAG,kBAAU,CAAC;QAC7B,IAAI,CAAC,cAAc,GAAG,YAAc,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,IAAI,yBAAc,EAAE,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACU,eAAe,CAC1B,IAAY;;YAEZ,IAAI,CAAC;gBACH,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACzD,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YACrD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACU,eAAe,CAC1B,IAAY;;YAEZ,IAAI,CAAC;gBACH,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACzD,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YACrD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACU,eAAe,CAC1B,IAAY;;YAEZ,IAAI,CAAC;gBACH,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC1D,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YACrD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IAEU,aAAa,CACxB,IAAY;;YAEZ,IAAI,CAAC;gBACH,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACzD,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YACnD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;OAOG;IACU,aAAa,CACxB,OAAe,EACf,OAAe;;YAEf,IAAI,CAAC;gBACH,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBACpE,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YACnD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACU,aAAa,CACxB,IAAY;;YAEZ,IAAI,CAAC;gBACH,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAC9D,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YACnD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACU,eAAe,CAC1B,IAAY;;YAEZ,IAAI,CAAC;gBACH,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAChE,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YACrD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACU,iBAAiB,CAC5B,IAAY;;YAEZ,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC/C,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC;gBAC5D,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC/C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;CACF;AAvJD,gCAuJC"}

package/lib/Web/DBstatusApi.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=DBstatusApi.js.map

package/lib/Web/DBstatusApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DBstatusApi.js","sourceRoot":"","sources":["../../source/Web/DBstatusApi.ts"],"names":[],"mappings":""}

package/lib/config/DB.d.ts

@@ -0,0 +1,40 @@
+import { SchemaTypes } from "../Models/DataTypes.models";
+import schemaValidate from "../Models/validator.models";
+import FileManager from "../Storage/FileManager";
+import FolderManager from "../Storage/FolderManager";
+import Configure from "../Operation/Indexation.operation";
+export declare const DBMS_Name = "AxioDB";
+export declare const DBMS_File_EXT = ".axiodb";
+export { SchemaTypes, schemaValidate, FileManager, FolderManager, Configure };
+declare const _default: {
+    SchemaTypes: {
+        string: <TSchema = string>() => import("joi").StringSchema<TSchema>;
+        number: <TSchema = number>() => import("joi").NumberSchema<TSchema>;
+        boolean: <TSchema = boolean>() => import("joi").BooleanSchema<TSchema>;
+        object: <TSchema = any, isStrict = false, T = TSchema>(schema?: import("joi").SchemaMap<T, isStrict>) => import("joi").ObjectSchema<TSchema>;
+        array: <TSchema = any[]>() => import("joi").ArraySchema<TSchema>;
+        date: <TSchema = Date>() => import("joi").DateSchema<TSchema>;
+        binary: <TSchema = Buffer>() => import("joi").BinarySchema<TSchema>;
+        func: <TSchema = Function>() => import("joi").FunctionSchema<TSchema>;
+        ref: (key: string, options?: import("joi").ReferenceOptions) => import("joi").Reference;
+        any: <TSchema = any>() => import("joi").AnySchema<TSchema>;
+        alphanum: () => import("joi").StringSchema<string>;
+        email: (options?: import("joi").EmailOptions) => import("joi").StringSchema<string>;
+        guid: (options?: import("joi").GuidOptions) => import("joi").StringSchema<string>;
+        ip: (options?: import("joi").IpOptions) => import("joi").StringSchema<string>;
+        uri: (options?: import("joi").UriOptions) => import("joi").StringSchema<string>;
+        max: (limit: number | import("joi").Reference) => import("joi").NumberSchema<number>;
+        min: (limit: number | import("joi").Reference) => import("joi").NumberSchema<number>;
+        length: (limit: number | import("joi").Reference) => import("joi").StringSchema<string>;
+        pattern: (regex: RegExp) => import("joi").StringSchema<string>;
+        required: () => import("joi").Schema<any>;
+        optional: () => import("joi").Schema<any>;
+        allow: (values: any[]) => import("joi").Schema<any>;
+        valid: (values: any[]) => import("joi").Schema<any>;
+    };
+    schemaValidate: typeof schemaValidate;
+    FileManager: typeof FileManager;
+    Configure: typeof Configure;
+    FolderManager: typeof FolderManager;
+};
+export default _default;

package/lib/config/DB.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Configure = exports.FolderManager = exports.FileManager = exports.schemaValidate = exports.SchemaTypes = exports.DBMS_File_EXT = exports.DBMS_Name = void 0;
+// Import All Required Sub Modules
+const DataTypes_models_1 = require("../Models/DataTypes.models");
+Object.defineProperty(exports, "SchemaTypes", { enumerable: true, get: function () { return DataTypes_models_1.SchemaTypes; } });
+const validator_models_1 = __importDefault(require("../Models/validator.models"));
+exports.schemaValidate = validator_models_1.default;
+const FileManager_1 = __importDefault(require("../Storage/FileManager"));
+exports.FileManager = FileManager_1.default;
+const FolderManager_1 = __importDefault(require("../Storage/FolderManager"));
+exports.FolderManager = FolderManager_1.default;
+const Indexation_operation_1 = __importDefault(require("../Operation/Indexation.operation"));
+exports.Configure = Indexation_operation_1.default;
+// Default Keys
+exports.DBMS_Name = "AxioDB";
+exports.DBMS_File_EXT = ".axiodb";
+// Export With All Sub Modules
+exports.default = {
+    SchemaTypes: DataTypes_models_1.SchemaTypes,
+    schemaValidate: validator_models_1.default,
+    FileManager: FileManager_1.default,
+    Configure: Indexation_operation_1.default,
+    FolderManager: FolderManager_1.default,
+};
+//# sourceMappingURL=DB.js.map

package/lib/config/DB.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DB.js","sourceRoot":"","sources":["../../source/config/DB.ts"],"names":[],"mappings":";;;;;;AAAA,kCAAkC;AAClC,iEAAyD;AAWhD,4FAXA,8BAAW,OAWA;AAVpB,kFAAwD;AAUlC,yBAVf,0BAAc,CAUe;AATpC,yEAAiD;AASX,sBAT/B,qBAAW,CAS+B;AARjD,6EAAqD;AAQF,wBAR5C,uBAAa,CAQ4C;AAPhE,6FAA0D;AAOQ,oBAP3D,8BAAS,CAO2D;AAL3E,eAAe;AACF,QAAA,SAAS,GAAG,QAAQ,CAAC;AACrB,QAAA,aAAa,GAAG,SAAS,CAAC;AAKvC,8BAA8B;AAC9B,kBAAe;IACb,WAAW,EAAX,8BAAW;IACX,cAAc,EAAd,0BAAc;IACd,WAAW,EAAX,qBAAW;IACX,SAAS,EAAT,8BAAS;IACT,aAAa,EAAb,uBAAa;CACd,CAAC"}

package/lib/config/Interfaces/Helper/response.helper.interface.d.ts

@@ -0,0 +1,10 @@
+export interface SuccessInterface {
+    statusCode: number;
+    status: boolean;
+    data?: any;
+}
+export interface ErrorInterface {
+    statusCode: number;
+    status: boolean;
+    message?: string;
+}

package/lib/config/Interfaces/Helper/response.helper.interface.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=response.helper.interface.js.map

package/lib/config/Interfaces/Helper/response.helper.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.helper.interface.js","sourceRoot":"","sources":["../../../../source/config/Interfaces/Helper/response.helper.interface.ts"],"names":[],"mappings":";AAAA,uDAAuD"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "axiodb",
+  "version": "1.0.0",
+  "description": "A fast, lightweight, and scalable open-source DBMS for modern apps. Supports JSON-based data storage, simple APIs, and secure data management. Ideal for projects needing efficient and flexible database solutions.",
+  "main": "./lib/config/DB.js",
+  "types": "./lib/config/DB.d.ts",
+  "scripts": {
+    "test": "eslint source/**/*.ts --fix",
+    "build": "npm test && tsc",
+    "prepare": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/AnkanSaha/AxioDB.git"
+  },
+  "keywords": [
+    "database",
+    "dbms",
+    "db",
+    "json",
+    "json database",
+    "json db",
+    "json storage",
+    "json data storage",
+    "json data management"
+  ],
+  "author": "Ankan Saha",
+  "license": "MIT",
+  "sponsor": {
+    "url": "https://github.com/sponsors/AnkanSaha"
+  },
+  "funding": {
+    "type": "git",
+    "url": "https://github.com/sponsors/AnkanSaha"
+  },
+  "dependencies": {
+    "joi": "^17.13.3",
+    "outers": "^8.5.8"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.11.1",
+    "@types/crypto-js": "^4.2.1",
+    "eslint": "^8.57.1",
+    "fastify": "^5.1.0",
+    "globals": "^15.9.0",
+    "typescript": "^5.6.2",
+    "typescript-eslint": "^8.8.0"
+  }
+}