@wxn0brp/db 0.4.2 → 0.5.2

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

@@ -7,7 +7,7 @@ import Data from "./types/data.js";
 import { Context } from "./types/types.js";
 import FileCpu from "./types/fileCpu.js";
 import { Transaction } from "./types/transactions.js";
-import EventEmitter from "events";
+import { EventEmitter } from "events";
 /**
  * Represents a database management class for performing CRUD operations.
  * @class
@@ -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

@@ -2,7 +2,7 @@ import dbActionC from "./action.js";
 import executorC from "./executor.js";
 import CollectionManager from "./CollectionManager.js";
 import vFileCpu from "./file/index.js";
-import EventEmitter from "events";
+import { EventEmitter } from "events";
 /**
  * Represents a database management class for performing CRUD operations.
  * @class
@@ -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

@@ -5,11 +5,18 @@ import GraphRemote from "./client/graph.js";
 import genId from "./gen.js";
 import Relation from "./relation.js";
 import CustomFileCpu from "./file/customFileCpu.js";
-import ValtheraMemory from "./memory.js";
-export { DataBase, DataBase as Valthera, Graph, DataBaseRemote, DataBaseRemote as ValtheraRemote, GraphRemote, Relation, genId, CustomFileCpu, ValtheraMemory, };
-import type Id from "./types/Id.js";
-import type { Arg, Search, Updater } from "./types/arg.js";
-import type { DbFindOpts, FindOpts, DbOpts } from "./types/options.js";
-import type Data from "./types/data.js";
-import type { SearchOptions } from "./types/searchOpts.js";
-export type { Id, Arg, Search, Updater, DbFindOpts, FindOpts, DbOpts, Data, SearchOptions, };
+import ValtheraMemory, { createMemoryValthera } from "./memory.js";
+export { DataBase as Valthera, Graph, DataBaseRemote as ValtheraRemote, GraphRemote, Relation, genId, CustomFileCpu, ValtheraMemory, createMemoryValthera };
+export type Id = import("./types/Id.js").Id;
+export declare namespace ValtheraTypes {
+    type Arg = import("./types/arg.js").Arg;
+    type Search = import("./types/arg.js").Search;
+    type Updater = import("./types/arg.js").Updater;
+    type DbFindOpts = import("./types/options.js").DbFindOpts;
+    type FindOpts = import("./types/options.js").FindOpts;
+    type DbOpts = import("./types/options.js").DbOpts;
+    type Data = import("./types/data.js").Data;
+    type SearchOptions = import("./types/searchOpts.js").SearchOptions;
+}
+import type { RelationTypes } from "./types/relation.js";
+export type { RelationTypes };

package/dist/index.js

@@ -5,5 +5,5 @@ import GraphRemote from "./client/graph.js";
 import genId from "./gen.js";
 import Relation from "./relation.js";
 import CustomFileCpu from "./file/customFileCpu.js";
-import ValtheraMemory from "./memory.js";
-export { DataBase, DataBase as Valthera, Graph, DataBaseRemote, DataBaseRemote as ValtheraRemote, GraphRemote, Relation, genId, CustomFileCpu, ValtheraMemory, };
+import ValtheraMemory, { createMemoryValthera } from "./memory.js";
+export { DataBase as Valthera, Graph, DataBaseRemote as ValtheraRemote, GraphRemote, Relation, genId, CustomFileCpu, ValtheraMemory, createMemoryValthera };

package/dist/memory.d.ts

@@ -1,4 +1,8 @@
 import DataBase from "./database.js";
+import Data from "./types/data.js";
 export default class ValtheraMemory extends DataBase {
     constructor(...args: any[]);
 }
+export declare function createMemoryValthera(data?: {
+    [key: string]: Data[];
+}): ValtheraMemory;

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.
      */
@@ -127,3 +133,12 @@ export default class ValtheraMemory extends DataBase {
         super("", { dbAction: new MemoryAction() });
     }
 }
+export function createMemoryValthera(data) {
+    const db = new ValtheraMemory();
+    if (!data)
+        return db;
+    for (const collection of Object.keys(data)) {
+        db.dbAction.memory.set(collection, data[collection]);
+    }
+    return db;
+}

package/dist/relation.d.ts

@@ -1,34 +1,10 @@
-import DataBase from "./database.js";
 import { Search } from "./types/arg.js";
 import { DbFindOpts } from "./types/options.js";
-export interface Databases {
-    [key: string]: DataBase;
-}
-interface RelationConfig {
-    from: string;
-    localField: string;
-    foreignField: string;
-    as?: string;
-    multiple?: boolean;
-}
+import { RelationTypes } from "./types/relation.js";
 declare class Relation {
-    private databases;
-    constructor(databases: Databases);
-    /**
-     * Resolves the relation path in format 'dbName.collectionName'.
-     */
-    private _resolvePath;
-    /**
-     * Processes relations for a single item.
-     */
-    private _processItemRelations;
-    /**
-     * Finds multiple items with relations.
-     */
-    find(path: string, search: Search, relations?: Record<string, RelationConfig>, options?: DbFindOpts): Promise<Record<string, any>[]>;
-    /**
-     * Finds a single item with relations.
-     */
-    findOne(path: string, search: Search, relations?: Record<string, RelationConfig>): Promise<Record<string, any> | null>;
+    dbs: RelationTypes.DBS;
+    constructor(dbs: RelationTypes.DBS);
+    findOne(path: RelationTypes.Path, search: Search, relations: RelationTypes.Relation, select: RelationTypes.FieldPath[]): Promise<any>;
+    find(path: RelationTypes.Path, search: Search, relations: RelationTypes.Relation, select: RelationTypes.FieldPath[], findOpts?: DbFindOpts): Promise<any[]>;
 }
 export default Relation;

package/dist/relation.js

@@ -1,62 +1,80 @@
-class Relation {
-    databases;
-    constructor(databases) {
-        this.databases = databases;
-    }
-    /**
-     * Resolves the relation path in format 'dbName.collectionName'.
-     */
-    _resolvePath(path) {
-        if (!path.includes(".")) {
-            throw new Error(`Invalid path format "${path}". Expected format 'dbName.collectionName'.`);
-        }
-        const sanitizedPath = path.replace(/\\\./g, "\uffff");
-        const [dbName, collectionName] = sanitizedPath.split(".", 2).map(part => part.replace(/\uffff/g, "."));
-        const db = this.databases[dbName];
-        if (!db) {
-            throw new Error(`Database "${dbName}" not found.`);
-        }
-        return { db, collection: collectionName };
-    }
-    /**
-     * Processes relations for a single item.
-     */
-    async _processItemRelations(item, relations) {
-        if (!item || typeof item !== "object")
-            return item;
-        const result = { ...item };
-        for (const [field, relationConfig] of Object.entries(relations)) {
-            if (!relationConfig.from || !relationConfig.localField || !relationConfig.foreignField) {
-                console.warn(`Skipping invalid relation configuration for field: "${field}"`);
+async function processRelations(dbs, cfg, data) {
+    for (const [key, relation] of Object.entries(cfg)) {
+        const { pk = "_id", fk = "_id", type = "1" } = relation;
+        if (type === "1") {
+            const db = dbs[relation.path[0]];
+            const collection = relation.path[1];
+            const item = await db.findOne(collection, { [fk]: data[pk] }, {}, { select: relation.select || null });
+            const field = relation.as || key;
+            if (!item) {
+                data[field] = null;
                 continue;
             }
-            try {
-                const { db, collection } = this._resolvePath(relationConfig.from);
-                const searchQuery = { [relationConfig.foreignField]: item[relationConfig.localField] };
-                const fetchFn = relationConfig.multiple ? db.find.bind(db) : db.findOne.bind(db);
-                result[relationConfig.as || field] = await fetchFn(collection, searchQuery) || null;
+            if (relation.relations) {
+                await processRelations(dbs, relation.relations, item);
+            }
+            data[field] = item;
+        }
+        else if (type === "1n") {
+            const db = dbs[relation.path[0]];
+            const collection = relation.path[1];
+            const items = await db.find(collection, { [fk]: data[pk] }, {}, relation.findOpts || {}, { select: relation.select || null });
+            const field = relation.as || key;
+            if (relation.relations) {
+                await Promise.all(items.map(item => processRelations(dbs, relation.relations, item)));
             }
-            catch (error) {
-                console.error(`Error processing relation for field "${field}":`, error);
+            data[field] = items;
+        }
+        else if (type === "nm") {
+            const db = dbs[relation.path[0]];
+            const collection = relation.path[1];
+            const items = await db.find(collection, {}, {}, {}, { select: relation.select || null });
+            const field = relation.as || key;
+            if (relation.relations) {
+                await Promise.all(items.map(item => processRelations(dbs, relation.relations, item)));
             }
+            data[field] = items;
         }
-        return result;
+        else {
+            throw new Error(`Unknown relation type: ${relation.type}`);
+        }
+    }
+}
+function selectDataSelf(data, select) {
+    if (!data)
+        return null;
+    if (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)
+        return data;
+    const newData = {};
+    for (const field of select) {
+        const key = field.map(f => f.replaceAll(".", "\\.")).join(".");
+        newData[key] = selectDataSelf(data, field);
+    }
+    return newData;
+}
+class Relation {
+    dbs;
+    constructor(dbs) {
+        this.dbs = dbs;
     }
-    /**
-     * Finds multiple items with relations.
-     */
-    async find(path, search, relations = {}, options = {}) {
-        const { db, collection } = this._resolvePath(path);
-        const items = await db.find(collection, search, {}, options);
-        return Promise.all(items.map(item => this._processItemRelations(item, relations)));
+    async findOne(path, search, relations, select) {
+        const db = this.dbs[path[0]];
+        const data = await db.findOne(path[1], search);
+        await processRelations(this.dbs, relations, data);
+        return selectData(data, select);
     }
-    /**
-     * Finds a single item with relations.
-     */
-    async findOne(path, search, relations = {}) {
-        const { db, collection } = this._resolvePath(path);
-        const item = await db.findOne(collection, search);
-        return item ? this._processItemRelations(item, relations) : null;
+    async find(path, search, relations, select, findOpts = {}) {
+        const db = this.dbs[path[0]];
+        const data = await db.find(path[1], search, {}, findOpts);
+        await Promise.all(data.map(item => processRelations(this.dbs, relations, item)));
+        return data.map(item => selectData(item, select));
     }
 }
 export default Relation;

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,22 @@
+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;
+    }
+    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,6 +1,6 @@
 {
 	"name": "@wxn0brp/db",
-	"version": "0.4.2",
+	"version": "0.5.2",
 	"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.",