@wxn0brp/db 0.40.0 → 0.40.2

package/README.md

@@ -1,6 +1,6 @@
-# <img src="https://raw.githubusercontent.com/wxn0brP/ValtheraDB/main/logo.svg" alt="ValtheraDB Logo" width="36" height="36"> ValtheraDB (@wxn0brp/db)
+# <img src="https://raw.githubusercontent.com/wxn0brP/ValtheraDB/master/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.
+A lightweight file-based database management system that supports CRUD operations, custom queries and relations.
 
 [![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)
@@ -16,37 +16,37 @@ npm install @wxn0brp/db
 
 ## Usage
 
-You can import the necessary classes from the package as follows:
+You can import the necessary classes/functions from the package as follows:
 
 ```javascript
-import { Valthera, Graph, ValtheraRemote, GraphRemote, Relation, genId, ValtheraMemory, ValtheraAutoCreate } from "@wxn0brp/db";
+import { Valthera, ValtheraRemote, Relation, genId, ValtheraMemory, ValtheraAutoCreate } from "@wxn0brp/db";
 ```
 
 ### Examples
 ```javascript
-import { Valthera } from '@wxn0brp/db';
+import { Valthera } from "@wxn0brp/db";
 
 // Create a new Valthera database instance
-const db = new Valthera('./database');
+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 }
+const addResult = await db.add("users", { name: "John Doe", age: 30 });
+console.log(addResult); // { _id: "abcdefghi-4-9", 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 }]
+const findResults = await db.find("users", {});
+console.log(findResults); // [{ _id: "abcdefghi-4-9", 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 }
+const user = await db.findOne("users", { $gt: { age: 25 } });
+console.log(user); // { _id: "abcdefghi-4-9", name: "John Doe", age: 30 }
 
 // Update a document in the collection
-const updateResult = await db.updateOne('users', { name: 'John Doe' }, { age: 31 });
+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' });
+const removeResult = await db.removeOne("users", { name: "John Doe" });
 console.log(removeResult); // true
 ```
 
@@ -57,12 +57,12 @@ Website: [https://wxn0brp.github.io/ValtheraDB/](https://wxn0brp.github.io/Valth
 For detailed information, refer to the following resources:
 
 - [Valthera Documentation](./docs/valthera.md)
-- [Graph Documentation](./docs/graph.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)
+- [Graph Documentation](./docs/graph.md)
 
 ## License
 

package/dist/bin.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/bin.js

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+import Valthera from "./valthera.js";
+const args = process.argv.slice(2);
+if (args.length < 2) {
+    console.error(`Use: ${process.argv[1]} <path> <op> <collection> [args]`);
+    process.exit(1);
+}
+const path = args.shift();
+const op = args.shift();
+const opts = args.map((arg) => {
+    try {
+        return JSON.parse(arg);
+    }
+    catch {
+        return arg;
+    }
+});
+const db = new Valthera(path);
+try {
+    const res = await db[op](...opts);
+    console.log(JSON.stringify(res));
+}
+catch (e) {
+    console.error(e);
+    process.exit(1);
+}

package/dist/graph.d.ts

@@ -3,6 +3,7 @@ import Valthera from "./valthera.js";
 /**
  * A class representing a graph database.
  * @class
+ * @deprecated
  */
 declare class Graph {
     db: Valthera;

package/dist/graph.js

@@ -2,6 +2,7 @@ import Valthera from "./valthera.js";
 /**
  * A class representing a graph database.
  * @class
+ * @deprecated
  */
 class Graph {
     db;

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import GraphRemote from "@wxn0brp/db-client/graph";
 import { ValtheraAutoCreate } from "./autoCreate.js";
 import Graph from "./graph.js";
 import { Valthera } from "./valthera.js";
+/** @deprecated */
 type GraphCompatible = Graph | GraphRemote;
 export * from "@wxn0brp/db-core";
 export * from "@wxn0brp/db-client";

package/dist/version.js

@@ -1 +1 @@
-export const version = "0.40.0";
+export const version = "0.40.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/db",
-  "version": "0.40.0",
+  "version": "0.40.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "wxn0brP",
@@ -11,10 +11,22 @@
     "type": "git",
     "url": "https://github.com/wxn0brP/ValtheraDB.git"
   },
+  "bin": {
+    "valthera-db-cli": "./dist/bin.js"
+  },
+  "keywords": [
+    "valthera",
+    "db",
+    "database",
+    "file",
+    "storage",
+    "data",
+    "lightweight"
+  ],
   "dependencies": {
-    "@wxn0brp/db-client": ">=0.2.0",
-    "@wxn0brp/db-core": ">=0.2.0",
-    "@wxn0brp/db-storage-dir": ">=0.1.1"
+    "@wxn0brp/db-client": ">=0.2.1",
+    "@wxn0brp/db-core": ">=0.2.5",
+    "@wxn0brp/db-storage-dir": ">=0.1.4"
   },
   "devDependencies": {
     "@types/node": "*",