@wxn0brp/db 0.5.6 → 0.6.0

package/README.md

@@ -1,7 +1,11 @@
-# <img src="./logo.svg" alt="ValtheraDB Logo" style="width: 36px; height: 36px"> ValtheraDB (@wxn0brp/db)
+# <img src="./logo.svg" alt="ValtheraDB Logo" width="36" height="36"> ValtheraDB (@wxn0brp/db)
 
 A lightweight file-based database management system that supports CRUD operations, custom queries, and graph structures.
 
+[![npm version](https://img.shields.io/npm/v/@wxn0brp/db)](https://www.npmjs.com/package/@wxn0brp/db)
+[![License](https://img.shields.io/npm/l/@wxn0brp/db)](./LICENSE)
+[![Downloads](https://img.shields.io/npm/dm/@wxn0brp/db)](https://www.npmjs.com/package/@wxn0brp/db)
+
 ## Installation
 
 To install the package, run:
@@ -15,7 +19,35 @@ npm install @wxn0brp/db
 You can import the necessary classes from the package as follows:
 
 ```javascript
-import { DataBase, Graph, DataBaseRemote, GraphRemote, Relation, genId } from "@wxn0brp/db";
+import { Valthera, Graph, ValtheraRemote, GraphRemote, Relation, genId, ValtheraMemory, ValtheraAutoCreate } from "@wxn0brp/db";
+```
+
+### Examples
+```javascript
+import { Valthera } from '@wxn0brp/db';
+
+// Create a new Valthera database instance
+const db = new Valthera('./database');
+
+// Add a new document to the database
+const result = await db.add('users', { name: 'John Doe', age: 30 });
+console.log(result); // { _id: 'xxx', name: 'John Doe', age: 30 }
+
+// Find all documents in the collection
+const results = await db.find('users', {});
+console.log(results); // [{ _id: 'xxx', name: 'John Doe', age: 30 }]
+
+// Find a single document in the collection.
+const user = await db.findOne('users', { $gt: { age: 25 } });
+console.log(user); // { _id: 'xxx', name: 'John Doe', age: 30 }
+
+// Update a document in the collection
+const updateResult = await db.updateOne('users', { name: 'John Doe' }, { age: 31 });
+console.log(updateResult); // true
+
+// Remove a document from the collection
+const removeResult = await db.removeOne('users', { name: 'John Doe' });
+console.log(removeResult); // true
 ```
 
 ## Documentation
@@ -24,10 +56,18 @@ Website: [https://wxn0brp.github.io/ValtheraDB/](https://wxn0brp.github.io/Valth
 
 For detailed information, refer to the following resources:
 
-- [DataBase Documentation](./docs/database.md)
+- [Valthera Documentation](./docs/valthera.md)
 - [Graph Documentation](./docs/graph.md)
-- [Remote Database and Graph Client Documentation](./docs/remote.md)
+- [Remote Valthera and Graph Client Documentation](./docs/remote.md)
 - [Search Options Documentation](./docs/search_opts.md)
 - [Find Options Documentation](./docs/find_opts.md)
 - [Updater Options Documentation](./docs/updater.md)
-- [Relation Documentation](./docs/relation.md)
+- [Relation Documentation](./docs/relation.md)
+
+## License
+
+This project is released under the [MIT License](./LICENSE).
+
+## Contributing
+
+Contributions are welcome! Please submit a pull request or open an issue on our GitHub repository.

package/dist/CollectionManager.d.ts

@@ -1,13 +1,12 @@
-import DataBase from "./database.js";
-import DataBaseRemote from "./client/database.js";
 import { Arg, Search, Updater } from "./types/arg.js";
 import { DbFindOpts, FindOpts } from "./types/options.js";
 import { Context } from "./types/types.js";
 import Data from "./types/data.js";
+import { ValtheraCompatible } from "./types/valthera.js";
 declare class CollectionManager {
-    db: DataBase | DataBaseRemote;
-    collection: string;
-    constructor(db: DataBase | DataBaseRemote, collection: string);
+    private db;
+    private collection;
+    constructor(db: ValtheraCompatible, collection: string);
     /**
      * Add data to a database.
      */

package/dist/autoCreate.d.ts

@@ -0,0 +1,12 @@
+import { Remote } from "./client/remote.js";
+import { ValtheraCompatible } from "./types/valthera.js";
+/**
+ * Creates a database instance based on the provided configuration.
+ * If the configuration is an object, it creates a DataBaseRemote instance.
+ * If the configuration is a string starting with "http", it also creates a DataBaseRemote instance.
+ * Otherwise, it creates a DataBase instance.
+ *
+ * @param cfg - The configuration object or string for the database.
+ * @returns A new instance of DataBaseRemote or DataBase.
+ */
+export declare function ValtheraAutoCreate(cfg: string | Remote): ValtheraCompatible;

package/dist/autoCreate.js

@@ -0,0 +1,18 @@
+import ValtheraRemote from "./client/valthera.js";
+import Valthera from "./valthera.js";
+/**
+ * Creates a database instance based on the provided configuration.
+ * If the configuration is an object, it creates a DataBaseRemote instance.
+ * If the configuration is a string starting with "http", it also creates a DataBaseRemote instance.
+ * Otherwise, it creates a DataBase instance.
+ *
+ * @param cfg - The configuration object or string for the database.
+ * @returns A new instance of DataBaseRemote or DataBase.
+ */
+export function ValtheraAutoCreate(cfg) {
+    if (typeof cfg === "object")
+        return new ValtheraRemote(cfg);
+    if (cfg.startsWith("http"))
+        return new ValtheraRemote(cfg);
+    return new Valthera(cfg);
+}

package/dist/client/{database.d.ts → valthera.d.ts}

@@ -5,12 +5,13 @@ import { DbFindOpts, FindOpts } from "../types/options.js";
 import { Context } from "../types/types.js";
 import Data from "../types/data.js";
 import { Transaction } from "../types/transactions.js";
+import { ValtheraCompatible } from "../types/valthera.js";
 /**
  * Represents a database management class for performing CRUD operations.
  * Uses a remote database.
  * @class
  */
-declare class DataBaseRemote {
+declare class ValtheraRemote implements ValtheraCompatible {
     remote: Remote;
     constructor(remote: Remote | string);
     /**
@@ -48,7 +49,7 @@ declare class DataBaseRemote {
     /**
      * Find data in a database as a stream.
      */
-    findStream<T = Data>(collection: string, search: Search, context?: Context, dbFindOpts?: DbFindOpts, findOpts?: FindOpts): Promise<void>;
+    findStream<T = Data>(collection: string, search: Search, context?: Context, findOpts?: FindOpts, limit?: number): Promise<AsyncGenerator<T, any, any>>;
     /**
      * Update data in a database.
      */
@@ -78,4 +79,4 @@ declare class DataBaseRemote {
      */
     transaction(collection: string, transaction: Transaction[]): Promise<boolean>;
 }
-export default DataBaseRemote;
+export default ValtheraRemote;

package/dist/client/{database.js → valthera.js}

@@ -6,7 +6,7 @@ import serializeFunctions from "./function.js";
  * Uses a remote database.
  * @class
  */
-class DataBaseRemote {
+class ValtheraRemote {
     remote;
     constructor(remote) {
         if (typeof remote === "string") {
@@ -96,8 +96,9 @@ class DataBaseRemote {
     /**
      * Find data in a database as a stream.
      */
-    async findStream(collection, search, context = {}, dbFindOpts = {}, findOpts = {}) {
+    async findStream(collection, search, context = {}, findOpts = {}, limit = -1) {
         throw new Error("Method not implemented.");
+        return await this._request("findStream", [collection, search, context, findOpts, limit]);
     }
     /**
      * Update data in a database.
@@ -142,4 +143,4 @@ class DataBaseRemote {
         return await this._request("transaction", [collection, transaction]);
     }
 }
-export default DataBaseRemote;
+export default ValtheraRemote;

package/dist/graph.d.ts

@@ -1,11 +1,11 @@
-import DataBase from "./database.js";
+import Valthera from "./valthera.js";
 import Data from "./types/data.js";
 /**
  * A class representing a graph database.
  * @class
  */
 declare class Graph {
-    db: DataBase;
+    db: Valthera;
     constructor(databaseFolder: string);
     /**
      * Adds an edge between two nodes.

package/dist/graph.js

@@ -1,4 +1,4 @@
-import DataBase from "./database.js";
+import Valthera from "./valthera.js";
 /**
  * A class representing a graph database.
  * @class
@@ -6,7 +6,7 @@ import DataBase from "./database.js";
 class Graph {
     db;
     constructor(databaseFolder) {
-        this.db = new DataBase(databaseFolder);
+        this.db = new Valthera(databaseFolder);
     }
     /**
      * Adds an edge between two nodes.

package/dist/index.d.ts

@@ -1,12 +1,17 @@
-import DataBase from "./database.js";
+import Valthera from "./valthera.js";
 import Graph from "./graph.js";
-import DataBaseRemote from "./client/database.js";
+import ValtheraRemote from "./client/valthera.js";
 import GraphRemote from "./client/graph.js";
 import genId from "./gen.js";
 import Relation from "./relation.js";
 import CustomFileCpu from "./file/customFileCpu.js";
 import ValtheraMemory, { createMemoryValthera } from "./memory.js";
-export { DataBase as Valthera, Graph, DataBaseRemote as ValtheraRemote, GraphRemote, Relation, genId, CustomFileCpu, ValtheraMemory, createMemoryValthera };
+import { ValtheraAutoCreate } from "./autoCreate.js";
+import { RelationTypes } from "./types/relation.js";
+import { ValtheraCompatible } from "./types/valthera.js";
+export { Valthera, Graph, ValtheraRemote, GraphRemote, Relation, genId, CustomFileCpu, ValtheraMemory, createMemoryValthera, ValtheraAutoCreate, };
+type GraphCompatible = Graph | GraphRemote;
+export type { ValtheraCompatible, RelationTypes, GraphCompatible, };
 export type Id = import("./types/Id.js").Id;
 export declare namespace ValtheraTypes {
     type Arg = import("./types/arg.js").Arg;
@@ -18,5 +23,3 @@ export declare namespace ValtheraTypes {
     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

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

package/dist/memory.d.ts

@@ -1,5 +1,5 @@
 import dbActionC from "./action.js";
-import DataBase from "./database.js";
+import Valthera from "./valthera.js";
 import { Arg, Search, Updater } from "./types/arg.js";
 import Data from "./types/data.js";
 import FileCpu from "./types/fileCpu.js";
@@ -76,7 +76,7 @@ export declare class MemoryAction implements dbActionC {
      */
     transaction(collection: string, transactions: Transaction[]): Promise<void>;
 }
-export default class ValtheraMemory extends DataBase {
+export default class ValtheraMemory extends Valthera {
     constructor(...args: any[]);
 }
 export declare function createMemoryValthera<T = {

package/dist/memory.js

@@ -1,4 +1,4 @@
-import DataBase from "./database.js";
+import Valthera from "./valthera.js";
 import CustomFileCpu from "./file/customFileCpu.js";
 import genId from "./gen.js";
 export class MemoryAction {
@@ -128,7 +128,7 @@ export class MemoryAction {
         throw new Error("Method not supported in memory.");
     }
 }
-export default class ValtheraMemory extends DataBase {
+export default class ValtheraMemory extends Valthera {
     constructor(...args) {
         super("", { dbAction: new MemoryAction() });
     }

package/dist/types/relation.d.ts

@@ -1,11 +1,10 @@
-import DataBaseRemote from "../client/database.js";
-import DataBase from "../database.js";
 import { DbFindOpts } from "./options.js";
+import { ValtheraCompatible } from "./valthera.js";
 export declare namespace RelationTypes {
     type Path = [string, string];
     type FieldPath = string[];
     interface DBS {
-        [key: string]: DataBase | DataBaseRemote;
+        [key: string]: ValtheraCompatible;
     }
     interface Relation {
         [key: string]: RelationConfig;

package/dist/types/valthera.d.ts

@@ -0,0 +1,23 @@
+import CollectionManager from "../CollectionManager.js";
+import { Arg, Search, Updater } from "./arg.js";
+import Data from "./data.js";
+import { DbFindOpts, FindOpts } from "./options.js";
+import { Transaction } from "./transactions.js";
+import { Context } from "./types.js";
+export interface ValtheraCompatible {
+    c(collection: string): CollectionManager;
+    getCollections(): Promise<string[]>;
+    checkCollection(collection: string): Promise<boolean>;
+    issetCollection(collection: string): Promise<boolean>;
+    add<T = Data>(collection: string, data: Arg, id_gen?: boolean): Promise<T>;
+    find<T = Data>(collection: string, search: Search, context?: Context, options?: DbFindOpts, findOpts?: FindOpts): Promise<T[]>;
+    findOne<T = Data>(collection: string, search: Search, context?: Context, findOpts?: FindOpts): Promise<T | null>;
+    findStream<T = Data>(collection: string, search: Search, context?: Context, findOpts?: FindOpts, limit?: number): Promise<AsyncGenerator<T>>;
+    update(collection: string, search: Search, updater: Updater, context?: Context): Promise<boolean>;
+    updateOne(collection: string, search: Search, updater: Updater, context?: Context): Promise<boolean>;
+    remove(collection: string, search: Search, context?: Context): Promise<boolean>;
+    removeOne(collection: string, search: Search, context?: Context): Promise<boolean>;
+    removeCollection(collection: string): Promise<boolean>;
+    transaction(collection: string, transaction: Transaction[]): Promise<boolean>;
+    updateOneOrAdd(collection: string, search: Search, updater: Updater, add_arg?: Arg, context?: Context, id_gen?: boolean): Promise<boolean>;
+}

package/dist/types/valthera.js

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

package/dist/{database.d.ts → valthera.d.ts}

@@ -8,11 +8,12 @@ import { Context } from "./types/types.js";
 import FileCpu from "./types/fileCpu.js";
 import { Transaction } from "./types/transactions.js";
 import { EventEmitter } from "events";
+import { ValtheraCompatible } from "./types/valthera.js";
 /**
  * Represents a database management class for performing CRUD operations.
  * @class
  */
-declare class DataBase {
+declare class Valthera implements ValtheraCompatible {
     dbAction: dbActionC;
     executor: executorC;
     emiter: EventEmitter;
@@ -79,4 +80,4 @@ declare class DataBase {
      */
     transaction(collection: string, transaction: Transaction[]): Promise<boolean>;
 }
-export default DataBase;
+export default Valthera;

package/dist/{database.js → valthera.js}

@@ -7,7 +7,7 @@ import { EventEmitter } from "events";
  * Represents a database management class for performing CRUD operations.
  * @class
  */
-class DataBase {
+class Valthera {
     dbAction;
     executor;
     emiter;
@@ -140,4 +140,4 @@ class DataBase {
         return await this.execute("transaction", collection, transaction);
     }
 }
-export default DataBase;
+export default Valthera;

package/package.json

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