axiodb 3.32.114 → 4.32.117

package/lib/Services/Index/ReadIndex.service.d.ts

@@ -0,0 +1,44 @@
+import { IndexManager } from "./Index.service";
+export declare class ReadIndex extends IndexManager {
+    constructor(path: string);
+    /**
+     * Retrieve file path(s) from an index that match the provided query.
+     *
+     * @param query - An object containing the value to look up. The concrete lookup key is determined
+     *                by the matched index metadata's `fieldName` (i.e. the method will use
+     *                query[metaContent.fieldName] to find entries).
+     *
+     * @returns A Promise that resolves to an array of string file paths associated with the query value.
+     *          If no matching index metadata is found, the promise resolves to an empty array.
+     *          If a matching index is found but no entries exist for the queried value, the returned
+     *          value may be undefined at runtime (callers should guard against a missing entry).
+     *
+     * @remarks
+     * - This method calls `findMatchingIndexMeta(query)` to locate the appropriate index metadata.
+     * - When a match is found, it reads the index file via `fileManager.ReadFile(...)` and converts the
+     *   file content to an object using `converter.ToObject(...)`.
+     * - The resolved object is expected to have `indexEntries` and `fieldName` properties. The method
+     *   uses `indexEntries[query[fieldName]]` to obtain the associated file list.
+     * - The index object is logged to the console for debugging purposes.
+     *
+     * @throws The returned promise will reject if reading or parsing the index file fails (for example,
+     *         due to I/O errors or converter failures).
+     */
+    getFileFromIndex(query: any): Promise<string[]>;
+    /**
+   * Finds index metadata entries that correspond to properties present on the provided document.
+   *
+   * Reads the index metadata file at `this.indexMetaPath`, converts its content into an object,
+   * and returns the subset of metadata entries whose `indexFieldName` is an own property of `doc`.
+   *
+   * @param doc - The document to check for matching index fields. The function tests own properties
+   *              (via `Object.prototype.hasOwnProperty.call`) rather than inherited properties.
+   * @returns A Promise that resolves to an array of matching index metadata entries, or `undefined`
+   *          if the index metadata file could not be successfully read. The array may be empty if
+   *          no metadata entries match.
+   *
+   * @throws May propagate errors from `fileManager.ReadFile` or `converter.ToObject` if those
+   *         operations throw or reject.
+   */
+    protected findMatchingIndexMeta(document: any): Promise<any | undefined>;
+}

package/lib/Services/Index/ReadIndex.service.js

@@ -0,0 +1,81 @@
+"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 });
+exports.ReadIndex = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const Index_service_1 = require("./Index.service");
+class ReadIndex extends Index_service_1.IndexManager {
+    constructor(path) {
+        super(path);
+    }
+    /**
+     * Retrieve file path(s) from an index that match the provided query.
+     *
+     * @param query - An object containing the value to look up. The concrete lookup key is determined
+     *                by the matched index metadata's `fieldName` (i.e. the method will use
+     *                query[metaContent.fieldName] to find entries).
+     *
+     * @returns A Promise that resolves to an array of string file paths associated with the query value.
+     *          If no matching index metadata is found, the promise resolves to an empty array.
+     *          If a matching index is found but no entries exist for the queried value, the returned
+     *          value may be undefined at runtime (callers should guard against a missing entry).
+     *
+     * @remarks
+     * - This method calls `findMatchingIndexMeta(query)` to locate the appropriate index metadata.
+     * - When a match is found, it reads the index file via `fileManager.ReadFile(...)` and converts the
+     *   file content to an object using `converter.ToObject(...)`.
+     * - The resolved object is expected to have `indexEntries` and `fieldName` properties. The method
+     *   uses `indexEntries[query[fieldName]]` to obtain the associated file list.
+     * - The index object is logged to the console for debugging purposes.
+     *
+     * @throws The returned promise will reject if reading or parsing the index file fails (for example,
+     *         due to I/O errors or converter failures).
+     */
+    getFileFromIndex(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const matchedIndexFile = yield this.findMatchingIndexMeta(query);
+            if (matchedIndexFile !== undefined) {
+                const metaContent = this.converter.ToObject((yield this.fileManager.ReadFile(matchedIndexFile.path)).data);
+                const finalValueFiles = metaContent.indexEntries[query[metaContent.fieldName]];
+                return finalValueFiles;
+            }
+            else {
+                return [];
+            }
+        });
+    }
+    /**
+   * Finds index metadata entries that correspond to properties present on the provided document.
+   *
+   * Reads the index metadata file at `this.indexMetaPath`, converts its content into an object,
+   * and returns the subset of metadata entries whose `indexFieldName` is an own property of `doc`.
+   *
+   * @param doc - The document to check for matching index fields. The function tests own properties
+   *              (via `Object.prototype.hasOwnProperty.call`) rather than inherited properties.
+   * @returns A Promise that resolves to an array of matching index metadata entries, or `undefined`
+   *          if the index metadata file could not be successfully read. The array may be empty if
+   *          no metadata entries match.
+   *
+   * @throws May propagate errors from `fileManager.ReadFile` or `converter.ToObject` if those
+   *         operations throw or reject.
+   */
+    findMatchingIndexMeta(document) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const indexMetaContent = yield this.fileManager.ReadFile(this.indexMetaPath);
+            if (indexMetaContent.status) {
+                const indexMeta = this.converter.ToObject(indexMetaContent.data);
+                return indexMeta.find((meta) => Object.prototype.hasOwnProperty.call(document, meta.indexFieldName));
+            }
+        });
+    }
+}
+exports.ReadIndex = ReadIndex;
+//# sourceMappingURL=ReadIndex.service.js.map

package/lib/Services/Index/ReadIndex.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadIndex.service.js","sourceRoot":"","sources":["../../../source/Services/Index/ReadIndex.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uDAAuD;AACvD,mDAA+C;AAE/C,MAAa,SAAU,SAAQ,4BAAY;IAEzC,YAAa,IAAY;QACvB,KAAK,CAAC,IAAI,CAAC,CAAA;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACU,gBAAgB,CAAE,KAAU;;YACvC,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAA;YAChE,IAAG,gBAAgB,KAAK,SAAS,EAAE,CAAC;gBAClC,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBAC3G,MAAM,eAAe,GAAG,WAAW,CAAC,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAA;gBAC9E,OAAO,eAAe,CAAC;YACzB,CAAC;iBACI,CAAC;gBACJ,OAAO,EAAE,CAAC;YACZ,CAAC;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;KAcC;IACe,qBAAqB,CAAC,QAAa;;YACjD,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAC7E,IAAI,gBAAgB,CAAC,MAAM,EAAE,CAAC;gBAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBACjE,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,IAA8B,EAAE,EAAE,CACvD,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,cAAc,CAAC,CACpE,CAAC;YACJ,CAAC;QACH,CAAC;KAAA;CACF;AAjED,8BAiEC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axiodb",
-  "version": "3.32.114",
+  "version": "4.32.117",
   "description": "The Pure JavaScript Alternative to SQLite. Embedded NoSQL database for Node.js with MongoDB-style queries, zero native dependencies, built-in InMemoryCache, and web GUI. Perfect for desktop apps, CLI tools, and embedded systems. No compilation, no platform issues—pure JavaScript from npm install to production.",
   "main": "./lib/config/DB.js",
   "types": "./lib/config/DB.d.ts",