@wxn0brp/db 0.0.1 → 0.0.2

package/README.md

@@ -1,194 +1,28 @@
-# DataBase Class
+# @wxn0brp/db
 
-The `DataBase` class simplifies managing data with a file-based database, providing an easy way to perform CRUD operations, caching, and custom queries.
+A lightweight file-based database management system that supports CRUD operations, custom queries, and graph structures.
 
 ## Installation
 
-Ensure you have Node.js installed. To install the `DataBase` package, run:
+To install the package, run:
 
 ```bash
-npm install @wxn0brp/database
+npm install @wxn0brp/db
 ```
 
-## Usage Example
+## Usage
 
-```javascript
-import DataBase from '@wxn0brp/database/database.js';
-
-async function main(){
-    // Initialize the database with a folder path and optional cache settings
-    const db = new DataBase('./data');
-
-    // Create or check a collection
-    await db.checkCollection('users');
-
-    // Add a new user to the collection
-    await db.add('users', { name: 'Alice', age: 30 });
-
-    // Find users based on search criteria
-    const users = await db.find('users', { age: 30 });
-    console.log(users);
-
-    // Update a user's data
-    await db.update('users', { name: 'Alice' }, { age: 31 });
-
-    // Remove a user
-    await db.remove('users', { name: 'Alice' });
-}
-
-main().catch(console.error);
-
-```
-
-## Methods Overview
-
-| Method Name | Description | Parameters | Returns |
-| ----------- | ----------- | ---------- | ------- | 
-| `getCollections` | Retrieves the names of all available collections. | None | `string[]` |
-| `checkCollection` | Ensures that a collection exists, creating it if necessary. | `collection` (string): Name of the collection | `Promise<void>` |
-| `issetCollection` | Checks if a collection exists. | `collection` (string): Name of the collection | `Promise<boolean>` |
-| `add` | Adds data to a collection, optionally generating an ID. | `collection` (string), `data` (Object), `id_gen` (boolean) | `Promise<Object>` |
-| `find` | Finds data entries matching a query. | `collection` (string), `search` (function/Object), `context` (Object), `options` (Object) - { max, reverse } | `Promise<Array<Object>>` |
-| `findOne` | Finds the first data entry matching a query. | `collection` (string), `search` (function/Object), `context` (Object) | `Promise<Object\|null>` |
-| `update` | Updates data entries matching a query. | `collection` (string), `search` (function/Object), `arg` (function/Object), `context` (Object) | `Promise<boolean>` |
-| `updateOne` | Updates the first data entry matching a query. | `collection` (string), `search` (function/Object), `arg` (function/Object), `context` (Object) | `Promise<boolean>` |
-| `remove` | Removes data entries matching a query. | `collection` (string), `search` (function/Object), `context` (Object) | `Promise<boolean>` |
-| `removeOne` | Removes the first data entry matching a query. | `collection` (string), `search` (function/Object), `context` (Object) | `Promise<boolean>` |
-| `updateOneOrAdd` | Updates one entry or adds a new one if no match is found. | `collection` (string), `search` (function/Object), `arg` (function/Object), `add_arg` (function/Object), `context` (Object), `id_gen` (boolean) | `Promise<boolean>` |
-| `removeDb` | Removes an entire database collection from the file system. | `collection` (string)  | `void` |
-
----
-
-### Querying Data
-
-The `DataBase` class offers flexibility for querying collections using either an object or a function as the `search` parameter in methods like `find`, `findOne`, `update`, and `remove`.
-
-#### Object-Based Queries
-
-You can use the following operators to build your queries:
-
-- **`$or`**: Matches if at least one condition is true.
-
-  ```javascript
-  const result = await db.find('users', {
-      $or: [{ status: 'active' }, { role: 'admin' }]
-  });
-  ```
-
-- **`$not`**: Matches if the condition is false.
-
-  ```javascript
-  const result = await db.find('users', {
-      $not: { status: 'inactive' }
-  });
-  ```
-
-- **`$and`**: Combines multiple conditions, all of which must be true. Useful for complex queries involving other operators.
-
-  ```javascript
-  const result = await db.find('users', {
-      $and: [
-        { age: 25 },
-        { $or: [{ status: 'active' }, { status: 'away' }] }
-      ]
-  });
-  ```
-
-- **`$set`**: Ensures that specified fields are present in the document.
-
-  ```javascript
-  const result = await db.find('users', {
-      $set: { name: true }
-  });
-  ```
-
-#### Search as a Function
-
-Alternatively, you can use a function for more dynamic queries. The function receives each document as an argument and should return `true` for documents that match the criteria.
-
-```javascript
-const results = await db.find('users', obj => obj.age > 30);
-```
-
-This approach is powerful for cases where the query logic is too complex to be represented as an object.
-
-### Update Argument
-
-When updating data, the `update` argument can also be either an object or a function.
-
-#### Update as an Object
-
-If you pass an object as the `update` argument, it will directly set the new values for the specified fields.
-
-##### Example: Update with Object
+You can import the necessary classes from the package as follows:
 
 ```javascript
-// Updates the age of all users named 'Alice' to 31
-await db.update('users', { name: 'Alice' }, { age: 31 });
+import { DataBase, Graph, DataBaseRemote, GraphRemote } from "@wxn0brp/db";
 ```
 
-#### Update as a Function
-
-If you pass a function, it receives the current object as an argument and should return the updated object. This allows for dynamic updates based on the current state of the object.
-
-##### Example: Update with Function
-
-```javascript
-// Increments the age of all users named 'Alice' by 1
-await db.update('users', { name: 'Alice' }, obj => {
-    obj.age++;
-    return obj;
-});
-```
-
-This method is useful when you need to compute new values based on existing ones.
-
-## Other Features
-
-### Graph.js
-
-The `Graph` class extends the functionality of the `DataBase` class to handle graph-like structures, where relationships (edges) between nodes (vertices) are stored in collections.
-
-#### Methods
-
-- **`add(collection, a, b)`**: Adds an edge between `a` and `b` in the specified collection. The nodes are sorted to ensure consistency in the storage format.
-
-    ```javascript
-    // Adds a friendship between Alice and Bob
-    await graph.add('friends', 'Alice', 'Bob');
-    ```
-
-- **`remove(collection, a, b)`**: Removes the edge between `a` and `b`.
-
-    ```javascript
-    // Removes the friendship between Alice and Bob
-    await graph.remove('friends', 'Alice', 'Bob');
-    ```
-
-- **`find(collection, d)`**: Finds all edges where `d` is one of the nodes.
-
-    ```javascript
-    // Returns all friends of Alice
-    const friends = await graph.find('friends', 'Alice');
-    ```
-
-- **`findOne(collection, d, e)`**: Finds the edge between `d` and `e`.
-
-    ```javascript
-    // Returns the friendship between Alice and Bob, if it exists
-    const relation = await graph.findOne('friends', 'Alice', 'Bob');
-    ```
-
-### Gen.js
-
-The `gen.js` file contains a utility function `genId`, which generates a unique identifier.
-
-#### Example: Generating an ID
-
-```javascript
-const id = genId();
-```
+## Documentation
 
-## License
+For detailed information, refer to the following resources:
 
-This project is licensed under the [MIT License](https://opensource.org/licenses/MIT). See the [LICENSE](./LICENSE) file for details.
+- [DataBase Documentation](./docs/database.md)
+- [Graph Documentation](./docs/graph.md)
+- [Remote Database and Graph Client Documentation](./docs/remote.md)
+- [Remote Server Documentation](./docs/remote_server.md)

package/docs/database.md

@@ -0,0 +1,140 @@
+# DataBase Class Documentation
+
+This documentation provides a detailed overview of the `DataBase` class, designed for performing CRUD operations on database collections. The class uses the `dbActionC` module for file-based operations and `executorC` for managing execution tasks.
+
+## Class: `DataBase`
+
+### Constructor: `DataBase(folder, options={})`
+Creates a new instance of the `DataBase` class.
+
+- **Parameters:**
+  - `folder` (`string`): The folder path where the database files are stored.
+  - `options` (`object`): Optional configuration options.
+    - `cacheThreshold` (`number`, default: 3): The threshold for caching entries.
+    - `cacheTTL` (`number`, default: 300000): Time-to-live for cache entries in milliseconds (default: 5 minutes).
+
+### Method: `c(collection)`
+Creates a new instance of the `CollectionManager` class for the specified collection.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+- **Returns:**
+  - `CollectionManager`: A new instance of `CollectionManager`.
+
+### Method: `async getCollections()`
+Gets the names of all available collections in the database.
+
+- **Returns:**
+  - `Promise<string[]>`: A promise that resolves with an array of collection names.
+
+### Method: `async checkCollection(collection)`
+Checks and creates the specified collection if it doesn't exist.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection to check.
+
+### Method: `async issetCollection(collection)`
+Checks if a collection exists.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+- **Returns:**
+  - `Promise<boolean>`: A promise that resolves to `true` if the collection exists, otherwise `false`.
+
+### Method: `async add(collection, data, id_gen=true)`
+Adds data to a specified collection.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+  - `data` (`Object`): The data to add.
+  - `id_gen` (`boolean`, default: true): Whether to generate an ID for the entry.
+- **Returns:**
+  - `Promise<Object>`: A promise that resolves with the added data.
+
+### Method: `async find(collection, search, context={}, options={}, findOpts={})`
+Finds data in a collection based on a query.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+  - `search` (`function|Object`): The search query.
+  - `context` (`Object`): The context object (for functions).
+  - `options` (`Object`): Search options.
+    - `max` (`number`, default: -1): Maximum number of entries to return.
+    - `reverse` (`boolean`, default: false): Whether to reverse the search results.
+  - `findOpts` (`Object`): Options for updating the search result.
+- **Returns:**
+  - `Promise<Array<Object>>`: A promise that resolves with the matching data.
+
+### Method: `async findOne(collection, search, context={}, findOpts={})`
+Finds one matching entry in a collection.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+  - `search` (`function|Object`): The search query.
+  - `context` (`Object`): The context object (for functions).
+  - `findOpts` (`Object`): Options for updating the search result.
+- **Returns:**
+  - `Promise<Object|null>`: A promise that resolves with the found entry, or `null` if no match is found.
+
+### Method: `async update(collection, search, arg, context={})`
+Updates data in a collection.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+  - `search` (`function|Object`): The search query.
+  - `arg` (`function|Object`): Update arguments.
+  - `context` (`Object`): The context object (for functions).
+- **Returns:**
+  - `Promise<boolean>`: A promise that resolves when the data is updated.
+
+### Method: `async updateOne(collection, search, arg, context={})`
+Updates one entry in a collection.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+  - `search` (`function|Object`): The search query.
+  - `arg` (`function|Object`): Update arguments.
+  - `context` (`Object`): The context object (for functions).
+- **Returns:**
+  - `Promise<boolean>`: A promise that resolves when the data is updated.
+
+### Method: `async updateOneOrAdd(collection, search, arg, add_arg={}, context={}, id_gen=true)`
+Updates one entry or adds a new one if it doesn't exist.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+  - `search` (`function|Object`): The search query.
+  - `arg` (`function|Object`): Update arguments.
+  - `add_arg` (`function|Object`): Data to add if no match is found.
+  - `context` (`Object`): The context object (for functions).
+  - `id_gen` (`boolean`, default: true): Whether to generate an ID for the new entry.
+- **Returns:**
+  - `Promise<boolean>`: A promise that resolves to `true` if the entry was updated, otherwise `false`.
+
+### Method: `async remove(collection, search, context={})`
+Removes data from a collection.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+  - `search` (`function|Object`): The search query.
+  - `context` (`Object`): The context object (for functions).
+- **Returns:**
+  - `Promise<boolean>`: A promise that resolves when the data is removed.
+
+### Method: `async removeOne(collection, search, context={})`
+Removes one entry from a collection.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+  - `search` (`function|Object`): The search query.
+  - `context` (`Object`): The context object (for functions).
+- **Returns:**
+  - `Promise<boolean>`: A promise that resolves when the entry is removed.
+
+### Method: `removeDb(collection)`
+Removes the specified collection from the database file system.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection to remove.
+- **Returns:**
+  - `void`

package/docs/graph.md

@@ -0,0 +1,78 @@
+# Graph Database Documentation
+
+This documentation provides an overview of the `Graph` class, which represents a graph database built on top of a custom `DataBase` module. The `Graph` class allows for managing graph structures by adding, removing, and querying edges between nodes in the database.
+
+## Class: `Graph`
+
+### Constructor: `Graph(databaseFolder)`
+Initializes the graph database.
+
+- **Parameters:**
+  - `databaseFolder` (`string`): The folder where the database is stored.
+
+### Method: `async add(collection, nodeA, nodeB)`
+Adds an edge between two nodes in the specified collection.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+  - `nodeA` (`string`): The first node.
+  - `nodeB` (`string`): The second node.
+- **Returns:**
+  - `Promise<Object>`: A promise that resolves with the added edge.
+
+### Method: `async remove(collection, nodeA, nodeB)`
+Removes an edge between two nodes in the specified collection.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+  - `nodeA` (`string`): The first node.
+  - `nodeB` (`string`): The second node.
+- **Returns:**
+  - `Promise<boolean>`: A promise that resolves to `true` if the edge is removed, otherwise `false`.
+
+### Method: `async find(collection, node)`
+Finds all edges with either node equal to the specified `node`.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+  - `node` (`string`): The node to search for.
+- **Returns:**
+  - `Promise<Object[]>`: A promise that resolves with an array of edges.
+
+### Method: `async findOne(collection, nodeA, nodeB)`
+Finds one edge with either `nodeA` or `nodeB` as nodes.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+  - `nodeA` (`string`): The first node.
+  - `nodeB` (`string`): The second node.
+- **Returns:**
+  - `Promise<Object|null>`: A promise that resolves with the found edge or `null` if no edge is found.
+
+### Method: `async getAll(collection)`
+Gets all edges in the specified collection.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+- **Returns:**
+  - `Promise<Object[]>`: A promise that resolves with all edges in the collection.
+
+### Method: `async getCollections()`
+Returns the names of all available collections in the database.
+
+- **Returns:**
+  - `Promise<string[]>`: A promise that resolves with an array of collection names.
+
+### Method: `async checkCollection(collection)`
+Checks and creates the specified collection if it doesn't exist.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+
+### Method: `async issetCollection(collection)`
+Checks if the specified collection exists.
+
+- **Parameters:**
+  - `collection` (`string`): The name of the collection.
+- **Returns:**
+  - `Promise<boolean>`: A promise that resolves to `true` if the collection exists, otherwise `false`.

package/docs/remote.md

@@ -0,0 +1,30 @@
+# Remote Database and Graph Database Client Documentation
+
+## `remote` object structure.
+- `name` (`string`): The name of the database.
+- `url` (`string`): The URL of the remote database.
+- `auth` (`string`): The authentication token for accessing the database.
+
+## Class: `DataBaseRemote(remote)`
+`DataBaseRemote` is an extended version of the `DataBase` class, designed to handle API requests. It provides the same functionalities as `DataBase`, but enables remote communication, allowing you to interact with databases through HTTP requests.
+
+## Example Usage
+```javascript
+const remoteDB = new DataBaseRemote({
+    name: 'myRemoteDB',
+    url: 'https://example.com/db',
+    auth: 'your-auth-token'
+});
+```
+
+## Class: `GraphRemote(remote)`
+`GraphRemote` is an extension of the `Graph` class, specifically designed for working with graph databases over HTTP. It supports querying and modifying graph data, providing methods tailored for graph operations such as adding nodes, edges, and executing graph queries.
+
+## Example Usage
+```javascript
+const remoteGraph = new GraphRemote({
+    name: 'myRemoteGraph',
+    url: 'https://example.com/db',
+    auth: 'your-auth-token'
+});
+```

package/docs/remote_server.md

@@ -0,0 +1,35 @@
+# Installation
+
+Clone the repository and install the necessary development dependencies:
+
+```bash
+git clone https://github.com/wxn0brP/db.git
+cd db
+npm install
+```
+
+# Usage
+
+To start the server, run:
+
+```bash
+node remote/server/index.js
+```
+
+# Server Management
+
+Manage the server using the following command:
+
+```bash
+node remote/serverMgmt/index.js
+```
+
+## Available Parameters:
+
+- `help`: Display this help message
+- `add-db <type> <name> <folder> <opts>`: Add a new database
+- `rm-db <name>`: Remove an existing database
+- `list-dbs`: List all databases
+- `add-user <login> <password>`: Create a new user
+- `rm-user <login>`: Delete a user
+- `list-users`: Display all users

package/index.js

@@ -0,0 +1,6 @@
+import DataBase from "./database.js";
+import Graph from "./graph.js";
+import DataBaseRemote from "./remote/client/database.js";
+import GraphRemote from "./remote/client/graph.js";
+
+export { DataBase, Graph, DataBaseRemote, GraphRemote };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/db",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "main": "index.js",
   "description": "A simple file-based database management system with support for CRUD operations, custom queries, and graph structures.",
   "homepage": "https://github.com/wxn0brP/database",
@@ -19,14 +19,16 @@
   "license": "MIT",
   "type": "module",
   "dependencies": {
+    "json5": "^2.2.3",
+    "got": "^14.4.2",
+    "readline": "^1.3.0"
+  },
+  "devDependencies": {
     "body-parser": "^1.20.3",
     "cors": "^2.8.5",
     "dotenv": "^16.4.5",
     "express": "^4.21.1",
-    "got": "^14.4.2",
-    "json5": "^2.2.3",
     "jwt-simple": "^0.5.6",
-    "node-cache": "^5.1.2",
-    "readline": "^1.3.0"
+    "node-cache": "^5.1.2"
   }
 }

package/remote/client/database.js

@@ -12,7 +12,6 @@ class DataBaseRemote{
      * @constructor
      * @param {object} remote - The remote database object.
      * @param {string} remote.name - The name of the database.
-     * @param {string} remote.folder - The folder path where the database files are stored.
      * @param {string} remote.auth - The authentication token.
      * @param {string} remote.url - The URL of the remote database.
      */

package/remote/client/graph.js

@@ -11,7 +11,6 @@ class GraphRemote{
      * @constructor
      * @param {object} remote - The remote database object.
      * @param {string} remote.name - The name of the database.
-     * @param {string} remote.folder - The folder path where the database files are stored.
      * @param {string} remote.auth - The authentication token.
      * @param {string} remote.url - The URL of the remote database.
      */

package/cacheManager.js

@@ -1,83 +0,0 @@
-/**
- * A cache manager for storing and managing cached data.
- * @class
- */
-class CacheManager{
-    /**
-     * Create a new cache manager instance.
-     * @constructor
-     * @param {number} cacheThreshold - The threshold for caching query results.
-     * @param {number} ttl - The time-to-live (TTL) for cached data in milliseconds.
-     */
-    constructor(cacheThreshold, ttl){
-        this.queryCounterCache = {};
-        this.dataCache = {};
-        this.cacheThreshold = cacheThreshold;
-        this.ttl = ttl;
-    }
-
-    /**
-     * Increment the query counter for a specific cache key.
-     * @private
-     * @param {string} key - The cache key.
-     * @returns {number} The updated query count for the cache key.
-     */
-    _incrementQueryCounter(key){
-        if(!this.queryCounterCache[key]){
-            this.queryCounterCache[key] = 1;
-        }else{
-            this.queryCounterCache[key]++;
-        }
-        return this.queryCounterCache[key];
-    }
-
-    /**
-     * Set data in the cache for a specific cache key.
-     * @private
-     * @param {string} key - The cache key.
-     * @param {*} data - The data to be cached.
-     */
-    _setCache(key, data){
-        this.dataCache[key] = { data, expires: Date.now() + this.ttl };
-    }
-
-    /**
-     * Get data from the cache for a specific cache key if it is not expired.
-     * @param {string} key - The cache key.
-     * @returns {*} The cached data if not expired, otherwise null.
-     */
-    getFromCache(key){
-        const item = this.dataCache[key];
-        if(item && Date.now() < item.expires){
-            return item.data;
-        }
-        delete this.dataCache[key];
-        return null;
-    }
-
-    /**
-     * Add data to the cache if the query count exceeds the cache threshold.
-     * @param {string} key - The cache key.
-     * @param {*} data - The data to be cached.
-     */
-    addToCacheIfNeeded(key, data){
-        const queryCount = this._incrementQueryCounter(key);
-        if(queryCount > this.cacheThreshold){
-            this._setCache(key, data);
-        }
-    }
-
-    /**
-     * Invalidate cache entries matching a specific key pattern.
-     * @param {string} keyPattern - The key pattern to match and invalidate cache entries.
-     */
-    invalidateCache(keyPattern){
-        Object.keys(this.dataCache).forEach(key => {
-            if(key.startsWith(keyPattern)){
-                delete this.dataCache[key];
-            }
-        });
-    }
-}
-
-export default CacheManager;

package/remote/client/index.js

@@ -1,10 +0,0 @@
-import databaseC from "./database.js";
-import graphC from "./graph.js";
-
-export async function DataBase(remote){
-    return new databaseC(remote);
-}
-
-export async function Graph(remote){
-    return new graphC(remote);
-}