@wxn0brp/db 0.0.4 → 0.0.6

package/docs/graph.md

@@ -1,86 +0,0 @@
-# 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`.
-
-### Method: `removeCollection(collection)`
-Removes the specified collection from the database file system.
-
-- **Parameters:**
-  - `collection` (`string`): The name of the collection to remove.
-- **Returns:**
-  - `void`

package/docs/relation.md

@@ -1,51 +0,0 @@
-# Relation Class Documentation
-
-This documentation provides an overview of the `Relation` class, which is designed to manage and resolve relations between database collections.
-
-## Class: `Relation`
-
-### Constructor: `Relation(databases)`
-Creates a new instance of the `Relation` class.
-
-- **Parameters:**
-  - `databases` (`Record<string, Database>`): An object containing database instances, where keys are database names.
-
-### Method: `async find(path: string, search: object | Function, relations?: Record<string, any>, options?: object)`
-Finds items with relations based on the provided path and search criteria.
-
-- **Parameters:**
-  - `path` (`string`): Path in format 'dbName.collectionName'.
-  - `search` (`object | Function`): The search query or function to execute.
-  - `relations` (`Record<string, any>`, optional): Relations configuration for resolving related data.
-  - `options` (`object`, optional): Additional search options.
-- **Returns:**
-  - `Promise<Array<object>>`: A promise that resolves with an array of items, each containing resolved relations.
-
-### Method: `async findOne(path: string, search: object | Function, relations?: Record<string, any>)`
-Finds one item with relations based on the provided path and search criteria.
-
-- **Parameters:**
-  - `path` (`string`): Path in format 'dbName.collectionName'.
-  - `search` (`object | Function`): The search query or function to execute.
-  - `relations` (`Record<string, any>`, optional): Relations configuration for resolving related data.
-- **Returns:**
-  - `Promise<object | null>`: A promise that resolves with the found item containing resolved relations or `null` if no match is found.
-
-### Method: `private _processItemRelations(item: object, relations: Record<string, any>)`
-Processes relations for a single item.
-
-- **Parameters:**
-  - `item` (`object`): The item to process relations for.
-  - `relations` (`Record<string, any>`): Relations configuration.
-- **Returns:**
-  - `Promise<object>`: A promise that resolves with the processed item containing resolved relations.
-
-### Private Method: `_resolvePath(path: string)`
-Resolves the relation path in the format 'dbName.collectionName'.
-
-- **Parameters:**
-  - `path` (`string`): The path to resolve, supporting escaped dots (`\.`).
-- **Returns:**
-  - `{ db: Database; collection: string }`: An object containing the resolved database and collection names.
-- **Throws:**
-  - `Error`: If the database does not exist or if the path format is invalid.

package/docs/remote.md

@@ -1,30 +0,0 @@
-# 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

@@ -1,35 +0,0 @@
-# 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/docs/search_opts.md

@@ -1,227 +0,0 @@
-# Predefined Search Options Quick Reference
-
-## Operators
-
-### Logical Operators
-
-#### $and
-Checks if all conditions in an array are true.
-```javascript
-{
-  $and: [
-    { $gt: { age: 20 } },
-    { $exists: { name: true } }
-  ]
-}
-```
-
-#### $or
-Checks if at least one condition in an array is true.
-```javascript
-{
-  $or: [
-    { $lt: { age: 20 } },
-    { $gt: { age: 60 } }
-  ]
-}
-```
-
-#### $not
-Negates a condition.
-```javascript
-{
-  $not: { $type: { age: "string" } }
-}
-```
-
-### Comparison Operators
-
-#### $gt
-Greater than comparison.
-```javascript
-{ $gt: { age: 18 } }
-```
-
-#### $lt
-Less than comparison.
-```javascript
-{ $lt: { score: 100 } }
-```
-
-#### $gte
-Greater than or equal comparison.
-```javascript
-{ $gte: { price: 9.99 } }
-```
-
-#### $lte
-Less than or equal comparison.
-```javascript
-{ $lte: { quantity: 50 } }
-```
-
-#### $in
-Checks if value is in an array.
-```javascript
-{ $in: { status: ["active", "pending"] } }
-```
-
-#### $nin
-Checks if value is not in an array.
-```javascript
-{ $nin: { category: ["archived", "deleted"] } }
-```
-
-#### $between
-Checks if a number is between two values (inclusive).
-```javascript
-{ $between: { age: [18, 65] } }
-```
-
-### Type and Existence Operators
-
-#### $exists
-Checks if a field exists (or doesn't exist).
-```javascript
-{ $exists: { email: true, deletedAt: false } }
-```
-
-#### $type
-Checks the type of a field.
-```javascript
-{ $type: { age: "number", name: "string" } }
-```
-
-### Array Operators
-
-#### $arrinc
-Checks if an array includes at least one of the specified values.
-```javascript
-{ $arrinc: { tags: ["developer", "designer"] } }
-```
-
-#### $arrincall
-Checks if an array includes all of the specified values.
-```javascript
-{ $arrincall: { permissions: ["read", "write"] } }
-```
-
-#### $size
-Checks the length of an array or string.
-```javascript
-{ $size: { tags: 3 } }
-```
-
-### String Operators
-
-#### $regex
-Tests a string against a regular expression.
-```javascript
-{ $regex: { email: /^[^@]+@[^@]+\.[^@]+$/ } }
-```
-
-#### $startsWith
-Checks if a string starts with a specified value.
-```javascript
-{ $startsWith: { name: "Dr." } }
-```
-
-#### $endsWith
-Checks if a string ends with a specified value.
-```javascript
-{ $endsWith: { email: "@example.com" } }
-```
-
-### Other Operators
-
-#### $subset
-Allows for skipping advanced validation for specific fields, applying only basic validation. This is useful when validation data may conflict with predefined functions (starting with $), while user data might also contain similar keys. Use this operator as a compromise.
-```javascript
-{ $subset: { $lt: "John Doe" } } // chcek if "$lt" is "John Doe"
-```
-
-## Examples
-
-### Complex Validation
-
-```javascript
-const criteria = {
-  $and: [
-    {
-      $or: [
-        { $gt: { age: 18 } },
-        { $exists: { guardianConsent: true } }
-      ]
-    },
-    {
-      $type: { email: "string" },
-      $regex: { email: /^[^@]+@[^@]+\.[^@]+$/ }
-    },
-    {
-      $arrincall: { roles: ["user"] },
-      $not: { $in: { status: ["banned", "suspended"] } }
-    }
-  ]
-};
-
-const user = {
-  age: 16,
-  guardianConsent: true,
-  email: "john@example.com",
-  roles: ["user", "premium"],
-  status: "active"
-};
-
-const isValid = hasFieldsAdvanced(user, criteria); // true
-```
-
-### Nested Conditions
-
-```javascript
-const criteria = {
-  $and: [
-    {
-      $exists: { address: true },
-      $type: { address: "object" }
-    },
-    {
-      $or: [
-        { $exists: { "address.zipCode": true } },
-        {
-          $and: [
-            { $exists: { "address.city": true } },
-            { $exists: { "address.country": true } }
-          ]
-        }
-      ]
-    }
-  ]
-};
-
-const user = {
-  address: {
-    city: "New York",
-    country: "USA"
-  }
-};
-
-const isValid = hasFieldsAdvanced(user, criteria); // true
-```
-
-## Error Handling
-
-The function will throw an error if:
-- The `fields` parameter is not an object
-- The `fields` parameter is null
-
-Always wrap the function call in a try-catch block when using with untrusted input:
-
-```javascript
-try {
-  const isValid = hasFieldsAdvanced(obj, criteria);
-  // Handle result
-} catch (error) {
-  // Handle error
-  console.error('Validation error:', error.message);
-}
-```

package/file/find.js

@@ -1,89 +0,0 @@
-import { existsSync, promises } from "fs";
-import { pathRepair, createRL } from "./utils.js";
-import { parse } from "../format.js";
-import hasFieldsAdvanced from "../utils/hasFieldsAdvanced.js";
-import updateFindObject from "../utils/updateFindObject.js";
-
-/**
- * Processes a line of text from a file and checks if it matches the search criteria.
- * @private
- * @param {function|Object} arg - The search criteria. It can be a function or an object.
- * @param {string} line - The line of text from the file.
- * @param {Object} context - The context object (for functions).
- * @param {Object} findOpts - Update result object with findOpts options.
- * @returns {Promise<Object|null>} A Promise that resolves to the matching object or null.
- */
-async function findProcesLine(arg, line, context={}, findOpts={}){
-    const ob = parse(line);
-    let res = false;
-    
-    if(typeof arg === "function"){
-        if(arg(ob, context)) res = true;
-    }else if(typeof arg === "object" && !Array.isArray(arg)){
-        if(hasFieldsAdvanced(ob, arg)) res = true;
-    }
-
-    if(res) return updateFindObject(ob, findOpts);
-    return null;
-}
-
-/**
- * Asynchronously finds entries in a file based on search criteria.
- * @function
- * @param {string} file - The file path to search in.
- * @param {function|Object} arg - The search criteria. It can be a function or an object.
- * @param {Object} context - The context object (for functions).
- * @param {Object} findOpts - Update result object with findOpts options.
- * @returns {Promise<Object[]>} A Promise that resolves to an array of matching objects.
- */
-export async function find(file, arg, context={}, findOpts={}){
-    file = pathRepair(file);
-    return await new Promise(async (resolve) => {
-        if(!existsSync(file)){
-            await promises.writeFile(file, "");
-            resolve(false);
-            return;
-        }
-        const rl = createRL(file);
-        const resF = [];
-        for await(const line of rl){
-            if(line == "" || !line) continue;
-
-            const res = await findProcesLine(arg, line, context, findOpts);
-            if(res) resF.push(res); 
-        };
-        resolve(resF);
-        rl.close();
-    })
-}
-
-/**
- * Asynchronously finds one entry in a file based on search criteria.
- * @function
- * @param {string} file - The file path to search in.
- * @param {function|Object} arg - The search criteria. It can be a function or an object.
- * @param {Object} context - The context object (for functions).
- * @param {Object} findOpts - Update result object with findOpts options.
- * @returns {Promise<Object>} A Promise that resolves to the first matching object found or an empty array.
- */
-export async function findOne(file, arg, context={}, findOpts={}){
-    file = pathRepair(file);
-    return await new Promise(async (resolve) => {
-        if(!existsSync(file)){
-            await promises.writeFile(file, "");
-            resolve(false);
-            return;
-        }
-        const rl = createRL(file);
-        for await(const line of rl){
-            if(line == "" || !line) continue;
-
-            const res = await findProcesLine(arg, line, context, findOpts);
-            if(res){
-                resolve(res);
-                rl.close();
-            }
-        };
-        resolve(false);
-    });
-}

package/file/remove.js

@@ -1,74 +0,0 @@
-import { existsSync, promises, appendFileSync, readdirSync, cp } from "fs";
-import { pathRepair, createRL } from "./utils.js";
-import { parse } from "../format.js";
-import hasFieldsAdvanced from "../utils/hasFieldsAdvanced.js";
-
-/**
- * Removes entries from a file based on search criteria.
- * @private
- * @param {string} file - The file path to remove entries from.
- * @param {function|Object} search - The search criteria. It can be a function or an object.
- * @param {Object} context - The context object (for functions).
- * @param {boolean} [one=false] - Indicates whether to remove only one matching entry (default: false).
- * @returns {Promise<boolean>} A Promise that resolves to `true` if entries were removed, or `false` otherwise.
- */
-async function removeWorker(file, search, context={}, one=false){
-    file = pathRepair(file);
-    if(!existsSync(file)){
-        await promises.writeFile(file, "");
-        return false;
-    }
-    await promises.copyFile(file, file+".tmp");
-    await promises.writeFile(file, "");
-
-    const rl = createRL(file+".tmp");
-  
-    let removed = false;
-    for await(let line of rl){
-        if(one && removed){
-            appendFileSync(file, line+"\n");
-            continue;
-        }
-
-        const data = parse(line);
-
-        if(typeof search === "function"){
-            if(search(data, context)){
-                removed = true;
-                continue;
-            }
-        }else if(typeof search === "object" && !Array.isArray(search)){
-            if(hasFieldsAdvanced(data, search)){
-                removed = true;
-                continue;
-            }
-        }
-        
-        appendFileSync(file, line+"\n");
-    }
-    await promises.writeFile(file+".tmp", "");
-    return removed;
-}
-
-/**
- * Asynchronously removes entries from a file based on search criteria.
- * @function
- * @param {string} cpath - Path to the collection.
- * @param {function|Object} arg - The search criteria. It can be a function or an object.
- * @param {Object} context - The context object (for functions).
- * @param {boolean} one - Indicates whether to remove only one matching entry (default: false).
- * @returns {Promise<boolean>} A Promise that resolves to `true` if entries were removed, or `false` otherwise.
- */
-async function remove(cpath, arg, context={}, one){
-    let files = readdirSync(cpath).filter(file => !/\.tmp$/.test(file));
-    files.reverse();
-    let remove = false;
-    for(const file of files){
-        const removed = await removeWorker(cpath + file, arg, context, one);
-        if(one && removed) break;
-        remove = remove || removed;
-    }
-    return remove;
-}
-
-export default remove;

package/file/update.js

@@ -1,83 +0,0 @@
-import { existsSync, promises, appendFileSync, readdirSync } from "fs";
-import { pathRepair, createRL } from "./utils.js";
-import { parse, stringify } from "../format.js";
-import hasFieldsAdvanced from "../utils/hasFieldsAdvanced.js";
-import updateObject from "../utils/updateObject.js";
-
-/**
- * Updates a file based on search criteria and an updater function or object.
- * @private
- * @param {string} file - The file path to update.
- * @param {function|Object} search - The search criteria. It can be a function or an object.
- * @param {function|Object} updater - The updater function or object.
- * @param {Object} context - The context object (for functions).
- * @param {boolean} [one=false] - Indicates whether to update only one matching entry (default: false).
- * @returns {Promise<boolean>} A Promise that resolves to `true` if the file was updated, or `false` otherwise.
- */
-async function updateWorker(file, search, updater, context={}, one=false){
-    file = pathRepair(file);
-    if(!existsSync(file)){
-        await promises.writeFile(file, "");
-        return false;
-    }
-    await promises.copyFile(file, file+".tmp");
-    await promises.writeFile(file, "");
-
-    const rl = createRL(file+".tmp");
-  
-    let updated = false;
-    for await(let line of rl){
-        if(one && updated){
-            appendFileSync(file, line+"\n");
-            continue;
-        }
-
-        const data = parse(line);
-        let ob = false;
-
-        if(typeof search === "function"){
-            ob = search(data, context) || false;
-        }else if(typeof search === "object" && !Array.isArray(search)){
-            ob = hasFieldsAdvanced(data, search);
-        }
-
-        if(ob){
-            let updateObj;
-            if(typeof updater === "function"){
-                updateObj = updater(data, context);
-            }else if(typeof updater === "object" && !Array.isArray(updater)){
-                updateObj = updateObject(data, updater);
-            }
-            line = await stringify(updateObj);
-            updated = true;
-        }
-        
-        appendFileSync(file, line+"\n");
-    }
-    await promises.writeFile(file+".tmp", "");
-    return updated;
-}
-
-/**
- * Asynchronously updates entries in a file based on search criteria and an updater function or object.
- * @function
- * @param {string} cpath - Path to the collection.
- * @param {function|Object} arg - The search criteria. It can be a function or an object.
- * @param {function|Object} obj - The updater function or object.
- * @param {Object} context - The context object (for functions).
- * @param {boolean} one - Indicates whether to update only one matching entry (default: false).
- * @returns {Promise<boolean>} A Promise that resolves to `true` if entries were updated, or `false` otherwise.
- */
-async function update(cpath, arg, obj, context={}, one){
-    let files = readdirSync(cpath).filter(file => !/\.tmp$/.test(file));
-    files.reverse();
-    let update = false;
-    for(const file of files){
-        const updated = await updateWorker(cpath + file, arg, obj, context, one);
-        if(one && updated) return true;
-        update = update || updated;
-    }
-    return update;
-}
-
-export default update;

package/gen.d.ts

@@ -1 +0,0 @@
-export default function genId(parts: number | number[], fill?: number): string;