@wxn0brp/db-storage-dir 0.100.0 → 0.101.0-alpha.0

package/README.md

@@ -5,5 +5,23 @@ This plugin provides directory-based operations for ValtheraDB.
 ## Installation
 
 ```bash
-npm install @wxn0brp/db-storage-dir
+npm install @wxn0brp/db-storage-dir json5
 ```
+
+## Usage
+
+```typescript
+import { createFileActions } from "@wxn0brp/db-storage-dir";
+
+const actions = createFileActions("dir", {
+    format: "json5:x", // or json, json:x, json5
+})
+```
+
+## Benchmark
+
+Performance benchmarks are available on the [`benchmark`](https://github.com/wxn0brP/ValtheraDB-storage-dir/tree/benchmark) branch.
+
+## License
+
+MIT

package/dist/action.d.ts

@@ -3,7 +3,7 @@ import { Data } from "@wxn0brp/db-core/types/data";
 import { FileCpu } from "@wxn0brp/db-core/types/fileCpu";
 import * as Query from "@wxn0brp/db-core/types/query";
 import { FileActionsUtils } from "./action.utils.js";
-import { DbDirOpts } from "./types.js";
+import { DbDirOpts, Format } from "./types.js";
 /**
  * A class representing database actions on files.
  * @class
@@ -14,6 +14,7 @@ export declare class FileActions extends ActionsBase {
     folder: string;
     options: DbDirOpts;
     _inited: boolean;
+    format: Format;
     /**
      * Creates a new instance of FileActions.
      * @constructor
@@ -25,6 +26,7 @@ export declare class FileActions extends ActionsBase {
     constructor(folder: string, options: DbDirOpts, fileCpu: FileCpu, utils?: FileActionsUtils);
     init(): Promise<void>;
     _getCollectionPath(collection: string): string;
+    _ensureQueryFormat(query: Query.VQuery): void;
     /**
      * Get a list of available databases in the specified folder.
      */

package/dist/action.js

@@ -5,6 +5,7 @@ import { promises } from "fs";
 import { resolve, sep } from "path";
 import { FileActionsUtils } from "./action.utils.js";
 import { exists } from "./utils.js";
+import { extendJson, format } from "./format.js";
 /**
  * A class representing database actions on files.
  * @class
@@ -15,6 +16,7 @@ export class FileActions extends ActionsBase {
     folder;
     options;
     _inited = false;
+    format;
     /**
      * Creates a new instance of FileActions.
      * @constructor
@@ -30,16 +32,35 @@ export class FileActions extends ActionsBase {
         this.folder = folder;
         this.options = {
             maxFileSize: 2 * 1024 * 1024, //2 MB
+            format: "json",
             ...options,
         };
+        if (typeof this.options.format === "string") {
+            const [name, x] = this.options.format.split(":");
+            if (format[name]) {
+                if (x)
+                    this.format = extendJson(format[name]);
+                else
+                    this.format = { ...format[name] };
+            }
+            else {
+                throw new Error(`Unknown format: ${this.options.format}`);
+            }
+        }
     }
     async init() {
         if (!await exists(this.folder))
             await promises.mkdir(this.folder, { recursive: true });
+        await this.format?.init?.();
     }
     _getCollectionPath(collection) {
         return this.folder + "/" + collection + "/";
     }
+    _ensureQueryFormat(query) {
+        query.control ||= {};
+        query.control.dir ||= {};
+        query.control.dir.format ||= this.format;
+    }
     /**
      * Get a list of available databases in the specified folder.
      */
@@ -84,6 +105,7 @@ export class FileActions extends ActionsBase {
      */
     async add(query) {
         const { collection, data } = query;
+        this._ensureQueryFormat(query);
         await this.ensureCollection(collection);
         const c_path = this._getCollectionPath(collection);
         const file = c_path + await this.utils.getLastFile(c_path, this.options.maxFileSize, query);
@@ -96,6 +118,7 @@ export class FileActions extends ActionsBase {
      */
     async find(query) {
         await this.ensureCollection(query.collection);
+        this._ensureQueryFormat(query);
         const c_path = this._getCollectionPath(query.collection);
         let files = await this.utils.getSortedFiles(c_path, query);
         if (files.length == 0)
@@ -109,6 +132,7 @@ export class FileActions extends ActionsBase {
      */
     async findOne(query) {
         const { collection } = query;
+        this._ensureQueryFormat(query);
         await this.ensureCollection(collection);
         const c_path = this._getCollectionPath(collection);
         const files = await this.utils.getSortedFiles(c_path, query);
@@ -124,6 +148,7 @@ export class FileActions extends ActionsBase {
      */
     async update(query) {
         const { collection } = query;
+        this._ensureQueryFormat(query);
         await this.ensureCollection(collection);
         return await this.utils.operationUpdater(this._getCollectionPath(collection), this.fileCpu.update.bind(this.fileCpu), false, query);
     }
@@ -132,6 +157,7 @@ export class FileActions extends ActionsBase {
      */
     async updateOne(query) {
         const { collection } = query;
+        this._ensureQueryFormat(query);
         await this.ensureCollection(collection);
         const res = await this.utils.operationUpdater(this._getCollectionPath(collection), this.fileCpu.update.bind(this.fileCpu), true, query);
         return res[0];
@@ -141,6 +167,7 @@ export class FileActions extends ActionsBase {
      */
     async remove(query) {
         const { collection } = query;
+        this._ensureQueryFormat(query);
         await this.ensureCollection(query.collection);
         return await this.utils.operationUpdater(this._getCollectionPath(collection), this.fileCpu.remove.bind(this.fileCpu), false, query);
     }
@@ -149,6 +176,7 @@ export class FileActions extends ActionsBase {
      */
     async removeOne(query) {
         const { collection } = query;
+        this._ensureQueryFormat(query);
         await this.ensureCollection(query.collection);
         const res = await this.utils.operationUpdater(this._getCollectionPath(collection), this.fileCpu.remove.bind(this.fileCpu), true, query);
         return res[0];

package/dist/file/find.js

@@ -2,13 +2,12 @@ import { pathRepair } from "@wxn0brp/db-core/customFileCpu";
 import { hasFieldsAdvanced } from "@wxn0brp/db-core/utils/hasFieldsAdvanced";
 import { updateFindObject } from "@wxn0brp/db-core/utils/updateFindObject";
 import { existsSync, promises } from "fs";
-import { parseData } from "../format.js";
 import { createRL } from "./utils.js";
 /**
  * Processes a line of text from a file and checks if it matches the search criteria.
  */
 async function findProcesLine(config, line) {
-    const ob = parseData(line);
+    const ob = config.control.dir.format.parse(line);
     let res = false;
     const { search, context, findOpts = {} } = config;
     if (typeof search === "function") {

package/dist/file/index.js

@@ -1,12 +1,11 @@
-import { appendFileSync } from "fs";
-import { stringifyData } from "../format.js";
+import { appendFile } from "fs/promises";
 import { find, findOne } from "./find.js";
 import { remove } from "./remove.js";
 import { update } from "./update.js";
 export const vFileCpu = {
     add: async (file, config) => {
-        const dataString = stringifyData(config.data);
-        appendFileSync(file, dataString + "\n");
+        const dataString = config.control.dir.format.stringify(config.data);
+        await appendFile(file, dataString + "\n");
     },
     find,
     findOne,

package/dist/file/remove.js

@@ -1,7 +1,6 @@
 import { pathRepair } from "@wxn0brp/db-core/customFileCpu";
 import { hasFieldsAdvanced } from "@wxn0brp/db-core/utils/hasFieldsAdvanced";
 import { appendFileSync, existsSync, promises } from "fs";
-import { parseData } from "../format.js";
 import { createRL } from "./utils.js";
 /**
  * Removes entries from a file based on search criteria.
@@ -27,7 +26,7 @@ export async function remove(file, config, one) {
         }
         if (!trimmed)
             continue;
-        const data = parseData(trimmed);
+        const data = config.control.dir.format.parse(trimmed);
         if (typeof search === "function") {
             if (search(data, context)) {
                 removed.push(data);

package/dist/file/update.js

@@ -2,7 +2,6 @@ import { pathRepair } from "@wxn0brp/db-core/customFileCpu";
 import { hasFieldsAdvanced } from "@wxn0brp/db-core/utils/hasFieldsAdvanced";
 import { updateObjectAdvanced } from "@wxn0brp/db-core/utils/updateObject";
 import { existsSync, promises } from "fs";
-import { parseData, stringifyData } from "../format.js";
 import { createRL } from "./utils.js";
 /**
  * Updates a file based on search criteria and an updater function or object.
@@ -28,7 +27,7 @@ export async function update(file, config, one) {
         }
         if (!trimmed)
             continue;
-        const data = parseData(trimmed);
+        const data = config.control.dir.format.parse(trimmed);
         let ob = false;
         if (typeof search === "function") {
             ob = search(data, context) || false;
@@ -46,7 +45,7 @@ export async function update(file, config, one) {
             else if (typeof updater === "object" && !Array.isArray(updater)) {
                 updateObj = updateObjectAdvanced(data, updater);
             }
-            line = await stringifyData(updateObj);
+            line = config.control.dir.format.stringify(updateObj);
             updated.push(updateObj);
         }
         await promises.appendFile(file, line + "\n");

package/dist/format.d.ts

@@ -1,2 +1,3 @@
-export declare function parseData(data: string): any;
-export declare function stringifyData(data: any): string;
+import { Format } from "./types.js";
+export declare const format: Record<string, Format>;
+export declare function extendJson(format: Format): Format;

package/dist/format.js

@@ -1,9 +1,39 @@
-import json5 from "json5";
-export function parseData(data) {
-    if (data[0] !== "{")
-        return json5.parse(`{${data}}`);
-    return json5.parse(data);
-}
-export function stringifyData(data) {
-    return json5.stringify(data).slice(1, -1);
+let json5;
+export const format = {
+    json: {
+        parse(data) {
+            return JSON.parse(data);
+        },
+        stringify(data) {
+            return JSON.stringify(data);
+        }
+    },
+    json5: {
+        parse(data) {
+            return json5.parse(data);
+        },
+        stringify(data) {
+            return json5.stringify(data);
+        },
+        async init() {
+            if (!json5)
+                json5 = await import("json5");
+        }
+    },
+};
+export function extendJson(format) {
+    if (format._extended)
+        return;
+    return {
+        ...format,
+        _extended: true,
+        parse(data) {
+            if (data[0] !== "{")
+                return format.parse(`{${data}}`);
+            return format.parse(data);
+        },
+        stringify(data) {
+            return format.stringify(data).slice(1, -1);
+        }
+    };
 }

package/dist/types.d.ts

@@ -4,9 +4,17 @@ declare module "@wxn0brp/db-core/types/query" {
         dir?: {
             lastFileNum?: number;
             sortedFiles?: string[];
+            format?: Format;
         };
     }
 }
 export type DbDirOpts = Omit<DbOpts, "dbAction"> & {
     maxFileSize?: number;
+    format?: string | Format;
 };
+export interface Format {
+    stringify: (data: any) => string;
+    parse: (data: string) => any;
+    init?: () => Promise<void>;
+    _extended?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/db-storage-dir",
-  "version": "0.100.0",
+  "version": "0.101.0-alpha.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "wxn0brP",
@@ -17,17 +17,21 @@
     "valtheradb",
     "vdb-adapter"
   ],
-  "dependencies": {
-    "json5": "^2.2.3"
-  },
   "peerDependencies": {
-    "@wxn0brp/db-core": "~0.10.0"
+    "@wxn0brp/db-core": "^0.10.2",
+    "json5": ""
+  },
+  "peerDependenciesMeta": {
+    "json5": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "@types/bun": "*",
-    "@wxn0brp/db-core": "~0.10.0",
-    "tsc-alias": "*",
-    "typescript": "*"
+    "@wxn0brp/db-core": "^0.10.2",
+    "json5": "^2.2.3",
+    "tsc-alias": "^1",
+    "typescript": "^6"
   },
   "files": [
     "dist"