@wxn0brp/db 0.0.5 → 0.0.6

package/action.js

@@ -1,258 +0,0 @@
-import { existsSync, mkdirSync, readdirSync, appendFileSync, rmSync, writeFileSync, statSync } from "fs";
-import gen from "./gen.js";
-import { stringify } from "./format.js";
-import { find as _find, findOne as _findOne, update as _update, remove as _remove } from "./file/index.js";
-
-/**
- * A class representing database actions on files.
- * @class
- */
-class dbActionC{
-    /**
-     * Creates a new instance of dbActionC.
-     * @constructor
-     * @param {string} folder - The folder where database files are stored.
-     * @param {object} options - The options object.
-     */
-    constructor(folder, options){
-        this.folder = folder;
-        this.options = {
-            maxFileSize: 2 * 1024 * 1024, //2 MB
-            ...options,
-        };
-        
-        if(!existsSync(folder)) mkdirSync(folder, { recursive: true });
-    }
-
-    _getCollectionPath(collection){
-        return this.folder + "/" + collection + "/";
-    }
-
-    /**
-     * Get a list of available databases in the specified folder.
-     * @returns {string[]} An array of database names.
-     */
-    getCollections(){
-        const collections = readdirSync(this.folder, { recursive: true, withFileTypes: true })
-            .filter(dirent => dirent.isDirectory())
-            .map(dirent => {
-                if(dirent.parentPath === this.folder) return dirent.name;
-                return dirent.parentPath.replace(this.folder + "/", "") + "/" + dirent.name
-            });
-
-        return collections;
-    }
-
-    /**
-     * Check and create the specified collection if it doesn't exist.
-     * @function
-     * @param {string} collection - The collection to check.
-     */
-    checkCollection(collection){
-        const cpath = this._getCollectionPath(collection);
-        if(!existsSync(cpath)) mkdirSync(cpath, { recursive: true });
-    }
-
-    /**
-     * Check if a collection exists.
-     * @function
-     * @param {string} collection - The name of the collection.
-     * @returns {boolean} True if the collection exists, false otherwise.
-     */
-    issetCollection(collection){
-        const path = this.folder + "/" + collection;
-        return existsSync(path);
-    }
-
-    /**
-     * Add a new entry to the specified database.
-     * @async
-     * @param {string} collection - The name of the collection.
-     * @param {Object} arg - The data to be added to the database.
-     * @param {boolean} id_gen - Whether to generate an ID for the entry. Default is true.
-     * @returns {Promise<Object>} A Promise that resolves to the added data.
-     */
-    async add(collection, arg, id_gen=true){
-        await this.checkCollection(collection);
-        const cpath = this._getCollectionPath(collection);
-        const file = cpath + getLastFile(cpath, this.options.maxFileSize);
-
-        if(id_gen) arg._id = arg._id || gen();
-        const data = stringify(arg);
-        appendFileSync(file, data+"\n");
-        return arg;
-    }
-
-    /**
-     * Find entries in the specified database based on search criteria.
-     * @async
-     * @param {string} collection - The name of 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 {Object} options - The options for the search.
-     * @param {number} options.max - The maximum number of entries to return. Default is -1, meaning no limit.
-     * @param {boolean} options.reverse - Whether to reverse the order of returned entries. Default is false.
-     * @param {Object} findOpts - Update result object with findOpts options.
-     * @returns {Promise<Object[]>} A Promise that resolves to an array of matching entries.
-     */
-    async find(collection, arg, context={}, options={}, findOpts={}){
-        options.reverse = options.reverse || false;
-        options.max = options.max || -1;
-
-        await this.checkCollection(collection);
-        const cpath = this._getCollectionPath(collection);
-        const files = getSortedFiles(cpath).map(f => f.f);
-        if(options.reverse) files.reverse();
-        let datas = [];
-
-        let totalEntries = 0;
-
-        for(let f of files){
-            let data = await _find(cpath + f, arg, context, findOpts);
-            if(options.reverse) data.reverse();
-
-            if(options.max !== -1){
-                if(totalEntries + data.length > options.max){
-                    let remainingEntries = options.max - totalEntries;
-                    data = data.slice(0, remainingEntries);
-                    totalEntries = options.max;
-                }else{
-                    totalEntries += data.length;
-                }
-            }
-
-            datas = datas.concat(data);
-
-            if(options.max !== -1 && totalEntries >= options.max) break;
-        }
-        return datas;
-    }
-
-    /**
-     * Find the first matching entry in the specified database based on search criteria.
-     * @async
-     * @param {string} collection - Name of the database 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 {Object} findOpts - Update result object with findOpts options.
-     * @returns {Promise<Object|null>} A Promise that resolves to the first matching entry or null if not found.
-     */
-    async findOne(collection, arg, context={}, findOpts={}){
-        await this.checkCollection(collection);
-        const cpath = this._getCollectionPath(collection);
-        const files = getSortedFiles(cpath).map(f => f.f);
-
-        for(let f of files){
-            let data = await _findOne(cpath + f, arg, context, findOpts);
-            if(data){
-                return data;
-            }
-        }
-        return null;
-    }
-
-    /**
-     * Update entries in the specified database based on search criteria and an updater function or object.
-     * @async
-     * @param {string} collection - Name of the database 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).
-     * @returns {Promise<boolean>} A Promise that resolves to `true` if entries were updated, or `false` otherwise.
-     */
-    async update(collection, arg, obj, context={}){
-        await this.checkCollection(collection);
-        return await _update(this._getCollectionPath(collection), arg, obj, context);
-    }
-
-    /**
-     * Update the first matching entry in the specified database based on search criteria and an updater function or object.
-     * @async
-     * @param {string} collection - Name of the database 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).
-     * @returns {Promise<boolean>} A Promise that resolves to `true` if one entry was updated, or `false` otherwise.
-     */
-    async updateOne(collection, arg, obj, context={}){
-        await this.checkCollection(collection);
-        return await _update(this._getCollectionPath(collection), arg, obj, context, true);
-    }
-
-    /**
-     * Remove entries from the specified database based on search criteria.
-     * @async
-     * @param {string} collection - Name of the database collection.
-     * @param {function|Object} arg - The search criteria. It can be a function or an object.
-     * @param {Object} context - The context object (for functions).
-     * @returns {Promise<boolean>} A Promise that resolves to `true` if entries were removed, or `false` otherwise.
-     */
-    async remove(collection, arg, context={}){
-        await this.checkCollection(collection);
-        return await _remove(this._getCollectionPath(collection), arg, context);
-    }
-
-    /**
-     * Remove the first matching entry from the specified database based on search criteria.
-     * @async
-     * @param {string} collection - Name of the database collection.
-     * @param {function|Object} arg - The search criteria. It can be a function or an object.
-     * @param {Object} context - The context object (for functions).
-     * @returns {Promise<boolean>} A Promise that resolves to `true` if one entry was removed, or `false` otherwise.
-     */
-    async removeOne(collection, arg, context={}){
-        await this.checkCollection(collection);
-        return await _remove(this._getCollectionPath(collection), arg, context, true);
-    }
-
-    /**
-     * Removes a database collection from the file system.
-     *
-     * @param {string} collection - The name of the collection to remove.
-     * @return {void}
-     */
-    removeCollection(collection){
-        rmSync(this.folder + "/" + collection, { recursive: true, force: true });
-    }
-}
-
-/**
- * Get the last file in the specified directory.
- * @param {string} path - The directory path.
- * @param {number} maxFileSize - The maximum file size in bytes. Default is 1 MB.
- * @returns {string} The name of the last file in the directory.
- */
-function getLastFile(path, maxFileSize=1024*1024){
-    if(!existsSync(path)) mkdirSync(path, { recursive: true });
-    const files = getSortedFiles(path);
-
-    if(files.length == 0){
-        writeFileSync(path+"/1.db", "");
-        return "1.db";
-    }
-
-    const last = files[files.length-1];
-    const info = path + "/" + last.f;
-
-    if(statSync(info).size < maxFileSize) return last.f;
-    
-    const num = last.i + 1;
-    writeFileSync(path + "/" + num + ".db", "");
-    return num+".db";
-}
-
-/**
- * Get all files in a directory sorted by name.
- * @param {string} path - The path to the directory.
- * @return {string[]} An array of file names sorted by name.
- */
-function getSortedFiles(path){
-    let files = readdirSync(path).filter(file => file.endsWith(".db"));
-    if(files.length == 0) return [];
-    files = files.map(file => parseInt(file.replace(".db", "")))
-    files = files.sort();
-    files = files.map(file => { return { i: file, f: file+".db" } });
-    return files;
-}
-
-export default dbActionC;

package/database.d.ts

@@ -1,44 +0,0 @@
-import dbActionC from "./action.js";
-import executorC from "./executor.js";
-import CollectionManager from "./CollectionManager.js";
-
-declare class DataBase {
-    constructor(folder: string, options?: {
-        cacheThreshold?: number,
-        cacheTTL?: number
-    });
-
-    dbAction: dbActionC;
-    executor: executorC;
-
-    c(collection: string): CollectionManager;
-
-    getCollections(): Promise<string[]>;
-
-    checkCollection(collection: string): Promise<void>;
-
-    issetCollection(collection: string): Promise<boolean>;
-
-    add(collection: string, data: object, id_gen?: boolean): Promise<object>;
-
-    find(collection: string, search: object | Function, context?: object, options?: {
-        max?: number,
-        reverse?: boolean
-    }, findOpts?: object): Promise<object[]>;
-
-    findOne(collection: string, search: object | Function, context?: object, findOpts?: object): Promise<object | null>;
-
-    update(collection: string, search: object | Function, arg: object | Function, context?: object): Promise<boolean>;
-
-    updateOne(collection: string, search: object | Function, arg: object | Function, context?: object): Promise<boolean>;
-
-    remove(collection: string, search: object | Function, context?: object): Promise<boolean>;
-
-    removeOne(collection: string, search: object | Function, context?: object): Promise<boolean>;
-
-    updateOneOrAdd(collection: string, search: object | Function, arg: object | Function, add_arg?: object, context?: object, id_gen?: boolean): Promise<boolean>;
-
-    removeCollection(collection: string): void;
-}
-
-export default DataBase;

package/database.js

@@ -1,203 +0,0 @@
-import dbActionC from "./action.js";
-import executorC from "./executor.js";
-import CollectionManager from "./CollectionManager.js";
-
-/**
- * Represents a database management class for performing CRUD operations.
- * @class
- */
-class DataBase{
-    /**
-     * Create a new database instance.
-     * @constructor
-     * @param {string} folder - The folder path where the database files are stored.
-     * @param {object} [options] - The options object.
-     * @param {number} [options.maxFileSize=2*1024*1024] - The maximum size of a file in bytes. Default is 2 MB.
-     * @param {number} 
-     */
-    constructor(folder, options={}){
-        this.dbAction = new dbActionC(folder, options);
-        this.executor = new executorC();
-    }
-
-    /**
-     * Create a new instance of a CollectionManager class.
-     * @function
-     * @param {string} collection - The name of the collection.
-     * @returns {CollectionManager} A new instance of CollectionManager.
-     */
-    c(collection){
-        return new CollectionManager(this, collection);
-    }
-
-    /**
-     * Get the names of all available databases.
-     *
-     * @function
-     * @returns {string[]} An array of database names.
-     */
-    async getCollections(){
-        return await this.dbAction.getCollections();
-    }
-
-    /**
-     * Check and create the specified collection if it doesn't exist.
-     *
-     * @function
-     * @param {string} collection - The collection to check.
-     */
-    async checkCollection(collection){
-        await this.dbAction.checkCollection(collection);
-    }
-
-    /**
-     * Check if a collection exists.
-     *
-     * @function
-     * @param {string} collection - The name of the collection.
-     * @returns {boolean} True if the collection exists, false otherwise.
-     */
-    async issetCollection(collection){
-        return await this.dbAction.issetCollection(collection);
-    }
-
-    /**
-     * Add data to a database.
-     *
-     * @async
-     * @function
-     * @param {string} collection - The name of the collection.
-     * @param {Object} data - The data to add.
-     * @param {boolean} id_gen - Whether to generate an ID for the entry. Default is true.
-     * @returns {Promise<Object>} A Promise that resolves with the added data.
-     */
-    async add(collection, data, id_gen=true){
-        return await this.executor.addOp(this.dbAction.add.bind(this.dbAction), collection, data, id_gen);
-    }
-
-    /**
-     * Find data in a database.
-     *
-     * @async
-     * @function
-     * @param {string} collection - Name of the database collection.
-     * @param {function|Object} search - The query. It can be an object or a function.
-     * @param {Object} context - The context object (for functions).
-     * @param {Object} options - The options for the search.
-     * @param {number} options.max - The maximum number of entries to return. Default is -1, meaning no limit.
-     * @param {boolean} options.reverse - Whether to reverse the order of returned entries. Default is false.
-     * @param {Object} findOpts - Update result object with findOpts options.
-     * @returns {Promise<Array<Object>>} A Promise that resolves with the matching data.
-     */
-    async find(collection, search, context={}, options={}, findOpts={}){
-        return await this.executor.addOp(this.dbAction.find.bind(this.dbAction), collection, search, context, options, findOpts);
-    }
-
-    /**
-     * Find one data entry in a database.
-     *
-     * @async
-     * @function
-     * @param {string} collection - Name of the database collection.
-     * @param {function|Object} search - The query. It can be an object or a function.
-     * @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 with the first matching data entry.
-     */
-    async findOne(collection, search, context={}, findOpts={}){
-        return await this.executor.addOp(this.dbAction.findOne.bind(this.dbAction), collection, search, context, findOpts);
-    }
-
-    /**
-     * Update data in a database.
-     *
-     * @async
-     * @function
-     * @param {string} collection - Name of the database collection.
-     * @param {function|Object} search - The query. It can be an object or a function.
-     * @param {function|Object} arg - Update arguments.
-     * @param {Object} context - The context object (for functions).
-     * @returns {Promise<boolean>} A Promise that resolves when the data is updated.
-     */
-    async update(collection, search, arg, context={}){
-        return await this.executor.addOp(this.dbAction.update.bind(this.dbAction), collection, search, arg, context);
-    }
-
-    /**
-     * Update one data entry in a database.
-     *
-     * @async
-     * @function
-     * @param {string} collection - Name of the database collection.
-     * @param {function|Object} search - The query. It can be an object or a function.
-     * @param {function|Object} arg - The query.
-     * @param {Object} context - The context object (for functions).
-     * @returns {Promise<boolean>} A Promise that resolves when the data entry is updated.
-     */
-    async updateOne(collection, search, arg, context={}){
-        return await this.executor.addOp(this.dbAction.updateOne.bind(this.dbAction), collection, search, arg, context);
-    }
-
-    /**
-     * Remove data from a database.
-     *
-     * @async
-     * @function
-     * @param {string} collection - Name of the database collection.
-     * @param {function|Object} search - The query. It can be an object or a function.
-     * @param {Object} context - The context object (for functions).
-     * @returns {Promise<boolean>} A Promise that resolves when the data is removed.
-     */
-    async remove(collection, search, context={}){
-        return await this.executor.addOp(this.dbAction.remove.bind(this.dbAction), collection, search, context);
-    }
-
-    /**
-     * Remove one data entry from a database.
-     *
-     * @async
-     * @function
-     * @param {string} collection - Name of the database collection.
-     * @param {function|Object} search - The query. It can be an object or a function.
-     * @param {Object} context - The context object (for functions).
-     * @returns {Promise<boolean>} A Promise that resolves when the data entry is removed.
-     */
-    async removeOne(collection, search, context={}){
-        return await this.executor.addOp(this.dbAction.removeOne.bind(this.dbAction), collection, search, context);
-    }
-
-    /**
-     * Asynchronously updates one entry in a database or adds a new one if it doesn't exist.
-     *
-     * @param {string} collection - Name of the database collection.
-     * @param {function|Object} search - The query. It can be an object or a function.
-     * @param {function|Object} arg - The search criteria for the update.
-     * @param {function|Object} add_arg - The arguments to be added to the new entry.
-     * @param {Object} context - The context object (for functions).
-     * @param {boolean} id_gen - Whether to generate an ID for the entry. Default is true.
-     * @return {Promise<boolean>} A Promise that resolves to `true` if the entry was updated, or `false` if it was added.
-     */
-    async updateOneOrAdd(collection, search, arg, add_arg={}, context={}, id_gen=true){
-        const res = await this.updateOne(collection, search, arg, context);
-        if(!res){
-            const assignData = [];
-            if(typeof search === "object" && !Array.isArray(search)) assignData.push(search);
-            if(typeof arg === "object" && !Array.isArray(arg)) assignData.push(arg);
-            if(typeof add_arg === "object" && !Array.isArray(add_arg)) assignData.push(add_arg);
-            await this.add(collection, Object.assign({}, ...assignData), id_gen);
-        }
-        return res;
-    }
-
-    /**
-     * Removes a database collection from the file system.
-     *
-     * @param {string} collection - The name of the collection to remove.
-     * @return {void}
-     */
-    removeCollection(collection){
-         this.dbAction.removeCollection(collection);
-    }
-}
-
-export default DataBase;

package/docs/database.md

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