@wxn0brp/db 0.5.3 → 0.5.5

package/README.md

@@ -1,4 +1,4 @@
-# ValtheraDB (@wxn0brp/db)
+# <img src="./logo.svg" alt="ValtheraDB Logo" style="width: 36px; height: 36px"> ValtheraDB (@wxn0brp/db)
 
 A lightweight file-based database management system that supports CRUD operations, custom queries, and graph structures.
 

package/dist/memory.d.ts

@@ -1,8 +1,84 @@
+import dbActionC from "./action.js";
 import DataBase from "./database.js";
+import { Arg, Search, Updater } from "./types/arg.js";
 import Data from "./types/data.js";
+import FileCpu from "./types/fileCpu.js";
+import { DbFindOpts, DbOpts, FindOpts } from "./types/options.js";
+import { SearchOptions } from "./types/searchOpts.js";
+import { Transaction } from "./types/transactions.js";
+import { Context } from "./types/types.js";
+export declare class MemoryAction implements dbActionC {
+    folder: string;
+    options: DbOpts;
+    fileCpu: FileCpu;
+    memory: Map<string, any[]>;
+    /**
+     * Creates a new instance of dbActionC.
+     * @constructor
+     * @param folder - The folder where database files are stored.
+     * @param options - The options object.
+     */
+    constructor();
+    _readMemory(key: string): any[];
+    _writeMemory(key: string, data: any[]): void;
+    _getCollectionPath(collection: string): string;
+    /**
+     * Get a list of available databases in the specified folder.
+     */
+    getCollections(): Promise<string[]>;
+    /**
+     * Check and create the specified collection if it doesn't exist.
+     */
+    checkCollection(collection: string): Promise<void>;
+    /**
+     * Check if a collection exists.
+     */
+    issetCollection(collection: string): Promise<boolean>;
+    /**
+     * Add a new entry to the specified database.
+     */
+    add(collection: string, arg: Arg, id_gen?: boolean): Promise<Arg>;
+    /**
+     * Find entries in the specified database based on search criteria.
+     */
+    find(collection: string, arg: Search, context?: Context, options?: DbFindOpts, findOpts?: FindOpts): Promise<Data[]>;
+    /**
+     * Find the first matching entry in the specified database based on search criteria.
+     */
+    findOne(collection: string, arg: SearchOptions, context?: Context, findOpts?: FindOpts): Promise<Data>;
+    /**
+     * Find entries in the specified database based on search criteria and return a stream of results.
+     */
+    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.
+     */
+    update(collection: string, arg: Search, updater: Updater, context?: {}): Promise<boolean>;
+    /**
+     * Update the first matching entry in the specified database based on search criteria and an updater function or object.
+     */
+    updateOne(collection: string, arg: Search, updater: Updater, context?: Context): Promise<boolean>;
+    /**
+     * Remove entries from the specified database based on search criteria.
+     */
+    remove(collection: string, arg: Search, context?: Context): Promise<boolean>;
+    /**
+     * Remove the first matching entry from the specified database based on search criteria.
+     */
+    removeOne(collection: string, arg: Search, context?: Context): Promise<boolean>;
+    /**
+     * Removes a database collection from the file system.
+     */
+    removeCollection(collection: string): Promise<void>;
+    /**
+     * Executes a list of transactions on the specified database collection.
+     * @throws Error - Method not supported in memory.
+     */
+    transaction(collection: string, transactions: Transaction[]): Promise<void>;
+}
 export default class ValtheraMemory extends DataBase {
     constructor(...args: any[]);
 }
-export declare function createMemoryValthera(data?: {
+export declare function createMemoryValthera<T = {
     [key: string]: Data[];
-}): ValtheraMemory;
+}>(data?: T): ValtheraMemory;

package/dist/memory.js

@@ -1,7 +1,7 @@
 import DataBase from "./database.js";
 import CustomFileCpu from "./file/customFileCpu.js";
 import genId from "./gen.js";
-class MemoryAction {
+export class MemoryAction {
     folder;
     options;
     fileCpu;

package/dist/relation.d.ts

@@ -4,7 +4,7 @@ import { RelationTypes } from "./types/relation.js";
 declare class Relation {
     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[]>;
+    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

@@ -52,8 +52,10 @@ function selectDataSelf(data, select) {
     return selectDataSelf(data[select[0]], select.slice(1));
 }
 function selectData(data, select) {
-    if (!select || select.length === 0)
+    if (!select)
         return data;
+    if (!data && select.length === 0)
+        return null;
     const newData = {};
     for (const field of select) {
         const key = field.map(f => f.replaceAll(".", "\\.")).join(".");
@@ -70,7 +72,8 @@ class Relation {
         const db = this.dbs[path[0]];
         const data = await db.findOne(path[1], search);
         await processRelations(this.dbs, relations, data);
-        return selectData(data, select);
+        const result = selectData(data, select);
+        return Object.keys(result).length === 0 ? null : result;
     }
     async find(path, search, relations, select, findOpts = {}) {
         const db = this.dbs[path[0]];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/db",
-  "version": "0.5.3",
+  "version": "0.5.5",
   "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.",