@wxn0brp/db 0.5.1 → 0.5.3

package/dist/CollectionManager.d.ts

@@ -20,6 +20,10 @@ declare class CollectionManager {
      * Find one data entry in a database.
      */
     findOne<T = Data>(search: Search, context?: Context, findOpts?: FindOpts): Promise<T>;
+    /**
+     * Find data in a database as a stream.
+     */
+    findStream<T = Data>(search: Search, context?: Context, findOpts?: FindOpts, limit?: number): AsyncGenerator<T>;
     /**
      * Update data in a database.
      */

package/dist/CollectionManager.js

@@ -23,6 +23,12 @@ class CollectionManager {
     async findOne(search, context = {}, findOpts = {}) {
         return await this.db.findOne(this.collection, search, context, findOpts);
     }
+    /**
+     * Find data in a database as a stream.
+     */
+    async *findStream(search, context = {}, findOpts = {}, limit = -1) {
+        return await this.db.findStream(this.collection, search, context, findOpts, limit);
+    }
     /**
      * Update data in a database.
      */

package/dist/action.d.ts

@@ -45,6 +45,7 @@ declare class dbActionC {
      * Find the first matching entry in the specified database based on search criteria.
      */
     findOne(collection: string, arg: SearchOptions, context?: Context, findOpts?: FindOpts): Promise<Data>;
+    findStream(collection: string, arg: Search, context?: Context, findOpts?: FindOpts, limit?: number): AsyncGenerator<any>;
     /**
      * Update entries in the specified database based on search criteria and an updater function or object.
      */

package/dist/action.js

@@ -122,6 +122,21 @@ class dbActionC {
         }
         return null;
     }
+    async *findStream(collection, arg, context = {}, findOpts = {}, limit = -1) {
+        await this.checkCollection(collection);
+        const cpath = this._getCollectionPath(collection);
+        const files = await getSortedFiles(cpath);
+        let count = 0;
+        for (let f of files) {
+            for await (const data of this.fileCpu.findStream(cpath + f, arg, context, findOpts, limit)) {
+                yield data;
+                count++;
+                if (limit !== -1 && count >= limit) {
+                    return;
+                }
+            }
+        }
+    }
     /**
      * Update entries in the specified database based on search criteria and an updater function or object.
      */

package/dist/client/database.d.ts

@@ -45,6 +45,10 @@ declare class DataBaseRemote {
      * Find one data entry in a database.
      */
     findOne<T = Data>(collection: string, search: Search, context?: Context, findOpts?: FindOpts): Promise<T>;
+    /**
+     * Find data in a database as a stream.
+     */
+    findStream<T = Data>(collection: string, search: Search, context?: Context, dbFindOpts?: DbFindOpts, findOpts?: FindOpts): Promise<void>;
     /**
      * Update data in a database.
      */

package/dist/client/database.js

@@ -74,6 +74,12 @@ class DataBaseRemote {
     async findOne(collection, search, context = {}, findOpts = {}) {
         return await this._request("findOne", [collection, search, context, findOpts]);
     }
+    /**
+     * Find data in a database as a stream.
+     */
+    async findStream(collection, search, context = {}, dbFindOpts = {}, findOpts = {}) {
+        throw new Error("Method not implemented.");
+    }
     /**
      * Update data in a database.
      */

package/dist/database.d.ts

@@ -46,6 +46,10 @@ declare class DataBase {
      * Find one data entry in a database.
      */
     findOne<T = Data>(collection: string, search: Search, context?: Context, findOpts?: FindOpts): Promise<T>;
+    /**
+     * Find data in a database as a stream.
+     */
+    findStream<T = Data>(collection: string, search: Search, context?: Context, findOpts?: FindOpts, limit?: number): Promise<AsyncGenerator<T, any, any>>;
     /**
      * Update data in a database.
      */

package/dist/database.js

@@ -68,6 +68,12 @@ class DataBase {
     async findOne(collection, search, context = {}, findOpts = {}) {
         return await this.execute("findOne", collection, search, context, findOpts);
     }
+    /**
+     * Find data in a database as a stream.
+     */
+    async findStream(collection, search, context = {}, findOpts = {}, limit = -1) {
+        return await this.execute("findStream", collection, search, context, findOpts, limit);
+    }
     /**
      * Update data in a database.
      */

package/dist/file/customFileCpu.d.ts

@@ -13,6 +13,7 @@ declare class CustomFileCpu implements FileCpu {
     add(file: string, data: Data): Promise<void>;
     find(file: string, arg: Search, context?: Context, findOpts?: FindOpts): Promise<any[] | false>;
     findOne(file: string, arg: Search, context?: Context, findOpts?: FindOpts): Promise<any | false>;
+    findStream(file: string, arg: Search, context?: Context, findOpts?: FindOpts, limit?: number): AsyncGenerator<any>;
     remove(file: string, one: boolean, arg: Search, context?: Context): Promise<boolean>;
     update(file: string, one: boolean, arg: Search, updater: Updater, context?: Context): Promise<boolean>;
     transactions(file: string, transactions: Transaction[]): Promise<void>;

package/dist/file/customFileCpu.js

@@ -26,6 +26,9 @@ class CustomFileCpu {
         const result = entries.find(entry => typeof arg === "function" ? arg(entry, context) : hasFieldsAdvanced(entry, arg));
         return result ? updateFindObject(result, findOpts) : false;
     }
+    async *findStream(file, arg, context, findOpts, limit) {
+        throw new Error("Method not implemented.");
+    }
     async remove(file, one, arg, context = {}) {
         file = pathRepair(file);
         let entries = await this._readFile(file);

package/dist/file/find.d.ts

@@ -9,3 +9,4 @@ export declare function find(file: string, arg: Search, context?: Context, findO
  * Asynchronously finds one entry in a file based on search criteria.
  */
 export declare function findOne(file: string, arg: Search, context?: Context, findOpts?: FindOpts): Promise<any | false>;
+export declare function findStream(file: string, arg: Search, context?: Context, findOpts?: FindOpts, limit?: number): AsyncGenerator<any>;

package/dist/file/find.js

@@ -71,3 +71,30 @@ export async function findOne(file, arg, context = {}, findOpts = {}) {
         resolve(false);
     });
 }
+export async function* findStream(file, arg, context = {}, findOpts = {}, limit = -1) {
+    file = pathRepair(file);
+    if (!existsSync(file)) {
+        await promises.writeFile(file, "");
+        return;
+    }
+    const rl = createRL(file);
+    try {
+        let count = 0;
+        for await (const line of rl) {
+            if (!line?.trim())
+                continue;
+            const res = await findProcesLine(arg, line, context, findOpts);
+            if (res) {
+                yield res;
+                count++;
+                if (limit > 0 && count >= limit) {
+                    rl.close();
+                    return;
+                }
+            }
+        }
+    }
+    finally {
+        rl.close();
+    }
+}

package/dist/file/index.js

@@ -1,6 +1,6 @@
 import update from "./update.js";
 import remove from "./remove.js";
-import { find, findOne } from "./find.js";
+import { find, findOne, findStream } from "./find.js";
 import { appendFileSync } from "fs";
 import { stringify } from "../format.js";
 import transactions from "./transactions.js";
@@ -11,6 +11,7 @@ const vFileCpu = {
     },
     find,
     findOne,
+    findStream,
     update,
     remove,
     transactions

package/dist/index.d.ts

@@ -18,5 +18,5 @@ export declare namespace ValtheraTypes {
     type Data = import("./types/data.js").Data;
     type SearchOptions = import("./types/searchOpts.js").SearchOptions;
 }
-import type { RelationTypes } from "./relation.js";
+import type { RelationTypes } from "./types/relation.js";
 export type { RelationTypes };

package/dist/memory.js

@@ -80,6 +80,12 @@ class MemoryAction {
         let data = await this.fileCpu.findOne(collection, arg, context, findOpts);
         return data || null;
     }
+    /**
+     * Find entries in the specified database based on search criteria and return a stream of results.
+     */
+    async *findStream(collection, arg, context, findOpts, limit) {
+        throw new Error("Method not implemented.");
+    }
     /**
      * Update entries in the specified database based on search criteria and an updater function or object.
      */

package/dist/relation.d.ts

@@ -1,26 +1,6 @@
-import DataBase from "./database.js";
 import { Search } from "./types/arg.js";
 import { DbFindOpts } from "./types/options.js";
-export declare namespace RelationTypes {
-    type Path = [string, string];
-    type FieldPath = string[];
-    interface DBS {
-        [key: string]: DataBase;
-    }
-    interface Relation {
-        [key: string]: RelationConfig;
-    }
-    interface RelationConfig {
-        path: Path;
-        pk?: string;
-        fk?: string;
-        as?: string;
-        select?: string[];
-        findOpts?: DbFindOpts;
-        type?: "1" | "1n" | "nm";
-        relations?: Relation;
-    }
-}
+import { RelationTypes } from "./types/relation.js";
 declare class Relation {
     dbs: RelationTypes.DBS;
     constructor(dbs: RelationTypes.DBS);

package/dist/relation.js

@@ -1,4 +1,6 @@
 async function processRelations(dbs, cfg, data) {
+    if (!data)
+        return;
     for (const [key, relation] of Object.entries(cfg)) {
         const { pk = "_id", fk = "_id", type = "1" } = relation;
         if (type === "1") {
@@ -43,14 +45,14 @@ async function processRelations(dbs, cfg, data) {
 function selectDataSelf(data, select) {
     if (!data)
         return null;
-    if (select.length === 0)
+    if (!select || select.length === 0)
         return data;
     if (Array.isArray(data))
         return data.map(item => selectDataSelf(item, select));
     return selectDataSelf(data[select[0]], select.slice(1));
 }
 function selectData(data, select) {
-    if (select.length === 0)
+    if (!select || select.length === 0)
         return data;
     const newData = {};
     for (const field of select) {

package/dist/types/fileCpu.d.ts

@@ -29,6 +29,16 @@ interface FileCpu {
      * @returns A promise resolving to the found entry or `false` if not found.
      */
     findOne(file: string, arg: Search, context?: Context, findOpts?: FindOpts): Promise<any | false>;
+    /**
+     * Asynchronously finds entries in a file based on search criteria and returns a stream of results.
+     * @param file The path to the file.
+     * @param arg The search criteria.
+     * @param context Additional context for the search.
+     * @param findOpts Additional options for searching.
+     * @param limit The maximum number of entries to return.
+     * @returns An async generator yielding found entries.
+     */
+    findStream(file: string, arg: Search, context?: Context, findOpts?: FindOpts, limit?: number): AsyncGenerator<any>;
     /**
    * Asynchronously removes entries from a file based on search criteria.
    * @param file The path to the file.

package/dist/types/relation.d.ts

@@ -0,0 +1,23 @@
+import DataBaseRemote from "../client/database.js";
+import DataBase from "../database.js";
+import { DbFindOpts } from "./options.js";
+export declare namespace RelationTypes {
+    type Path = [string, string];
+    type FieldPath = string[];
+    interface DBS {
+        [key: string]: DataBase | DataBaseRemote;
+    }
+    interface Relation {
+        [key: string]: RelationConfig;
+    }
+    interface RelationConfig {
+        path: Path;
+        pk?: string;
+        fk?: string;
+        as?: string;
+        select?: string[];
+        findOpts?: DbFindOpts;
+        type?: "1" | "1n" | "nm";
+        relations?: Relation;
+    }
+}

package/dist/types/relation.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,51 +1,45 @@
 {
-	"name": "@wxn0brp/db",
-	"version": "0.5.1",
-	"main": "dist/index.js",
-	"types": "dist/index.d.ts",
-	"description": "A simple file-based database management system with support for CRUD operations, custom queries, and graph structures.",
-	"homepage": "https://github.com/wxn0brP/ValtheraDB",
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/wxn0brP/ValtheraDB.git"
-	},
-	"keywords": [
-		"database",
-		"file-based",
-		"CRUD",
-		"graph",
-		"query"
-	],
-	"author": "wxn0brP",
-	"license": "MIT",
-	"type": "module",
-	"dependencies": {
-		"json5": "^2.2.3",
-		"ky": "^1.7.4",
-		"readline": "^1.3.0"
-	},
-	"devDependencies": {
-		"@types/node": "^22.10.2",
-		"tsc-alias": "^1.8.10",
-		"typescript": "^5.7.2"
-	},
-	"scripts": {
-		"build": "tsc && tsc-alias",
-		"prepare": "rm -rf dist && npm run build",
-		"postversion": "git push && git push --tags",
-		"build:cdn": "npm run build && cd cdn && node index.js"
-	},
-	"files": [
-		"dist"
-	],
-	"exports": {
-		".": {
-			"types": "./dist/index.d.ts",
-			"import": "./dist/index.js"
-		},
-		"./*": {
-			"types": "./dist/*",
-			"import": "./dist/*"
-		}
-	}
+  "name": "@wxn0brp/db",
+  "version": "0.5.3",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "description": "A simple file-based database management system with support for CRUD operations, custom queries, and graph structures.",
+  "homepage": "https://github.com/wxn0brP/ValtheraDB",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wxn0brP/ValtheraDB.git"
+  },
+  "keywords": [
+    "database",
+    "file-based",
+    "CRUD",
+    "graph",
+    "query"
+  ],
+  "author": "wxn0brP",
+  "license": "MIT",
+  "type": "module",
+  "dependencies": {
+    "json5": "^2.2.3",
+    "ky": "^1.7.4",
+    "readline": "^1.3.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.2",
+    "tsc-alias": "^1.8.10",
+    "typescript": "^5.7.2"
+  },
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./*": {
+      "types": "./dist/*",
+      "import": "./dist/*"
+    }
+  }
 }