@wxn0brp/db 0.2.0 → 0.3.0

package/dist/esm/client/graph.d.ts

@@ -1,54 +0,0 @@
-import { Remote } from "./remote.js";
-/**
- * A class representing a graph database.
- * Uses a remote database.
- * @class
- */
-declare class GraphRemote {
-    remote: Remote;
-    /**
-     * Create a new database instance.
-     */
-    constructor(remote: Remote);
-    /**
-     * Make a request to the remote database.
-     */
-    _request(type: string, params?: any[]): Promise<any>;
-    /**
-     * Adds an edge between two nodes.
-     */
-    add(collection: string, nodeA: string, nodeB: string): Promise<any>;
-    /**
-     * Removes an edge between two nodes.
-     */
-    remove(collection: string, nodeA: string, nodeB: string): Promise<any>;
-    /**
-     * Finds all edges with either node equal to `node`.
-     */
-    find(collection: string, node: string): Promise<any>;
-    /**
-     * Finds one edge with either node equal to `nodeA` and the other equal to `nodeB`.
-     */
-    findOne(collection: string, nodeA: string, nodeB: string): Promise<any>;
-    /**
-     * Get all edges in the collection.
-     */
-    getAll(collection: string): Promise<any>;
-    /**
-     * Get the names of all available databases.
-     */
-    getCollections(): Promise<any>;
-    /**
-     * Check and create the specified collection if it doesn't exist.
-     */
-    checkCollection(collection: string): Promise<any>;
-    /**
-     * Check if a collection exists.
-     */
-    issetCollection(collection: string): Promise<any>;
-    /**
-     * Remove the specified collection.
-     */
-    removeCollection(collection: string): Promise<any>;
-}
-export default GraphRemote;

package/dist/esm/client/remote.d.ts

@@ -1,15 +0,0 @@
-export interface Remote {
-    name: string;
-    url: string;
-    auth: string;
-}
-export interface RequestData {
-    db?: string;
-    keys?: string[];
-    params?: Record<string, any>;
-}
-export interface findOptsRemote {
-    select?: string[];
-    exclude?: string[];
-    transform?: string;
-}

package/dist/esm/database.d.ts

@@ -1,70 +0,0 @@
-import dbActionC from "./action.js";
-import executorC from "./executor.js";
-import CollectionManager from "./CollectionManager.js";
-import { DbFindOpts, DbOpts, FindOpts } from "./types/options.js";
-import { Arg, Search, Updater } from "./types/arg.js";
-import Data from "./types/data.js";
-import { Context } from "./types/types.js";
-import FileCpu from "./types/fileCpu.js";
-/**
- * Represents a database management class for performing CRUD operations.
- * @class
- */
-declare class DataBase {
-    dbAction: dbActionC;
-    executor: executorC;
-    constructor(folder: string, options?: DbOpts, fileCpu?: FileCpu);
-    /**
-     * Create a new instance of a CollectionManager class.
-     */
-    c(collection: string): CollectionManager;
-    /**
-     * Get the names of all available databases.
-     */
-    getCollections(): Promise<string[]>;
-    /**
-     * Check and create the specified collection if it doesn't exist.
-     */
-    checkCollection(collection: string): Promise<void>;
-    /**
-     * Check if a collection exists.
-     */
-    issetCollection(collection: string): Promise<boolean>;
-    /**
-     * Add data to a database.
-     */
-    add<T = Data>(collection: string, data: Arg, id_gen?: boolean): Promise<T>;
-    /**
-     * Find data in a database.
-     */
-    find<T = Data>(collection: string, search: Search, context?: Context, options?: DbFindOpts, findOpts?: FindOpts): Promise<T[]>;
-    /**
-     * Find one data entry in a database.
-     */
-    findOne<T = Data>(collection: string, search: Search, context?: Context, findOpts?: FindOpts): Promise<T>;
-    /**
-     * Update data in a database.
-     */
-    update(collection: string, search: Search, updater: Updater, context?: {}): Promise<boolean>;
-    /**
-     * Update one data entry in a database.
-     */
-    updateOne(collection: string, search: Search, updater: Updater, context?: Context): Promise<boolean>;
-    /**
-     * Remove data from a database.
-     */
-    remove(collection: string, search: Search, context?: Context): Promise<boolean>;
-    /**
-     * Remove one data entry from a database.
-     */
-    removeOne(collection: string, search: Search, context?: Context): Promise<boolean>;
-    /**
-     * Asynchronously updates one entry in a database or adds a new one if it doesn't exist.
-     */
-    updateOneOrAdd(collection: string, search: Search, updater: Updater, add_arg?: Arg, context?: Context, id_gen?: boolean): Promise<boolean>;
-    /**
-     * Removes a database collection from the file system.
-     */
-    removeCollection(collection: string): Promise<void>;
-}
-export default DataBase;

package/dist/esm/executor.d.ts

@@ -1,28 +0,0 @@
-interface Task {
-    func: Function;
-    param: any[];
-    resolve: Function;
-    reject: Function;
-}
-/**
- * A simple executor for queuing and executing asynchronous operations sequentially.
- * @class
- */
-declare class executorC {
-    quote: Task[];
-    isExecuting: boolean;
-    /**
-     * Create a new executor instance.
-     * @constructor
-     */
-    constructor();
-    /**
-     * Add an asynchronous operation to the execution queue.
-     */
-    addOp(func: Function, ...param: any[]): Promise<unknown>;
-    /**
-     * Execute the queued asynchronous operations sequentially.
-     */
-    execute(): Promise<void>;
-}
-export default executorC;

package/dist/esm/file/customFileCpu.d.ts

@@ -1,19 +0,0 @@
-import { Context } from "vm";
-import { Search, Updater } from "../types/arg.js";
-import Data from "../types/data.js";
-import FileCpu from "../types/fileCpu.js";
-import { FindOpts } from "../types/options.js";
-type WriteFile = (file: string, data: any[]) => Promise<void>;
-type ReadFile = (file: string) => Promise<any[]>;
-declare class CustomFileCpu implements FileCpu {
-    _readFile: ReadFile;
-    _writeFile: WriteFile;
-    constructor(readFile: ReadFile, writeFile: WriteFile);
-    add(file: string, data: Data): Promise<void>;
-    addMany(file: string, data: Data[]): Promise<void>;
-    find(file: string, arg: Search, context?: Context, findOpts?: FindOpts): Promise<any[] | false>;
-    findOne(file: string, arg: Search, context?: Context, findOpts?: FindOpts): Promise<any | false>;
-    remove(file: string, one: boolean, arg: Search, context?: Context): Promise<boolean>;
-    update(file: string, one: boolean, arg: Search, updater: Updater, context?: Context): Promise<boolean>;
-}
-export default CustomFileCpu;

package/dist/esm/file/find.d.ts

@@ -1,11 +0,0 @@
-import { Search } from "../types/arg.js";
-import { Context } from "../types/types.js";
-import { FindOpts } from "../types/options.js";
-/**
- * Asynchronously finds entries in a file based on search criteria.
- */
-export declare function find(file: string, arg: Search, context?: Context, findOpts?: FindOpts): Promise<any[] | false>;
-/**
- * Asynchronously finds one entry in a file based on search criteria.
- */
-export declare function findOne(file: string, arg: Search, context?: Context, findOpts?: FindOpts): Promise<any | false>;

package/dist/esm/file/index.d.ts

@@ -1,3 +0,0 @@
-import FileCpu from "../types/fileCpu.js";
-declare const vFileCpu: FileCpu;
-export default vFileCpu;

package/dist/esm/file/remove.d.ts

@@ -1,7 +0,0 @@
-import { Search } from "../types/arg.js";
-import { Context } from "../types/types.js";
-/**
- * Removes entries from a file based on search criteria.
- */
-declare function removeWorker(file: string, one: boolean, search: Search, context?: Context): Promise<boolean>;
-export default removeWorker;

package/dist/esm/file/update.d.ts

@@ -1,7 +0,0 @@
-import { Context } from "../types/types.js";
-import { Search, Updater } from "../types/arg.js";
-/**
- * Updates a file based on search criteria and an updater function or object.
- */
-declare function updateWorker(file: string, one: boolean, search: Search, updater: Updater, context?: Context): Promise<boolean>;
-export default updateWorker;

package/dist/esm/file/utils.d.ts

@@ -1,8 +0,0 @@
-/**
- * Repairs a file path by replacing double slashes
- */
-export declare function pathRepair(path: string): string;
-/**
- * Creates a Readline interface for reading large files with a specified high water mark.
- */
-export declare function createRL(file: string): import("readline").Interface;

package/dist/esm/format.d.ts

@@ -1,12 +0,0 @@
-/**
- * Parses given string into a JSON object. If the string does not start with
- * a {, it is wrapped in one. This allows for a shorthand when
- * storing/reading data from a file.
- */
-export declare function parse(data: string): any;
-/**
- * Converts given object to a string. If the string is a valid json5, it is
- * returned as is. If it is a valid json5 wrapped in {}, the curly brackets
- * are removed. Otherwise the string is wrapped in {}.
- */
-export declare function stringify(data: any): any;

package/dist/esm/gen.d.ts

@@ -1,8 +0,0 @@
-import Id from "./types/Id.js";
-/**
- * Generates a unique random identifier based on time and parts.
- *
- * @param {number[]} [parts] - an array of lengths of parts of the identifier
- * @returns {Id} - a new unique identifier
- */
-export default function genId(parts?: number[]): Id;

package/dist/esm/graph.d.ts

@@ -1,47 +0,0 @@
-import DataBase from "./database.js";
-import Data from "./types/data.js";
-/**
- * A class representing a graph database.
- * @class
- */
-declare class Graph {
-    db: DataBase;
-    constructor(databaseFolder: string);
-    /**
-     * Adds an edge between two nodes.
-     */
-    add(collection: string, nodeA: string, nodeB: string): Promise<Data>;
-    /**
-     * Removes an edge between two nodes.
-     */
-    remove(collection: string, nodeA: string, nodeB: string): Promise<boolean>;
-    /**
-     * Finds all edges with either node equal to `node`.
-     */
-    find(collection: string, node: string): Promise<Data[]>;
-    /**
-     * Finds one edge with either node equal to `nodeA` and the other equal to `nodeB`.
-     */
-    findOne(collection: any, nodeA: any, nodeB: any): Promise<Data>;
-    /**
-     * Gets all edges in the database.
-     */
-    getAll(collection: any): Promise<Data[]>;
-    /**
-     * Get the names of all available databases.
-     */
-    getCollections(): Promise<string[]>;
-    /**
-     * Check and create the specified collection if it doesn't exist.
-     */
-    checkCollection(collection: any): Promise<void>;
-    /**
-     * Check if a collection exists.
-     */
-    issetCollection(collection: any): Promise<boolean>;
-    /**
-     * Removes a database collection from the file system.
-     */
-    removeCollection(collection: any): void;
-}
-export default Graph;

package/dist/esm/index.d.ts

@@ -1,14 +0,0 @@
-import DataBase from "./database.js";
-import Graph from "./graph.js";
-import DataBaseRemote from "./client/database.js";
-import GraphRemote from "./client/graph.js";
-import genId from "./gen.js";
-import Relation from "./relation.js";
-import CustomFileCpu from "./file/customFileCpu.js";
-export { DataBase, Graph, DataBaseRemote, GraphRemote, Relation, genId, CustomFileCpu, };
-import type Id from "./types/Id.js";
-import type { Arg, Search, Updater } from "./types/arg.js";
-import type { DbFindOpts, FindOpts, DbOpts } from "./types/options.js";
-import type Data from "./types/data.js";
-import type { SearchOptions } from "./types/searchOpts.js";
-export type { Id, Arg, Search, Updater, DbFindOpts, FindOpts, DbOpts, Data, SearchOptions, };

package/dist/esm/relation.d.ts

@@ -1,34 +0,0 @@
-import DataBase from "./database.js";
-import { Search } from "./types/arg.js";
-import { DbFindOpts } from "./types/options.js";
-export interface Databases {
-    [key: string]: DataBase;
-}
-interface RelationConfig {
-    from: string;
-    localField: string;
-    foreignField: string;
-    as?: string;
-    multiple?: boolean;
-}
-declare class Relation {
-    private databases;
-    constructor(databases: Databases);
-    /**
-     * Resolves the relation path in format 'dbName.collectionName'.
-     */
-    private _resolvePath;
-    /**
-     * Processes relations for a single item.
-     */
-    private _processItemRelations;
-    /**
-     * Finds multiple items with relations.
-     */
-    find(path: string, search: Search, relations?: Record<string, RelationConfig>, options?: DbFindOpts): Promise<Record<string, any>[]>;
-    /**
-     * Finds a single item with relations.
-     */
-    findOne(path: string, search: Search, relations?: Record<string, RelationConfig>): Promise<Record<string, any> | null>;
-}
-export default Relation;

package/dist/esm/types/Id.d.ts

@@ -1,3 +0,0 @@
-type Id = string;
-export default Id;
-export { Id };

package/dist/esm/types/arg.d.ts

@@ -1,12 +0,0 @@
-import Id from "./Id.js";
-import { SearchOptions } from "./searchOpts.js";
-import { Context } from "./types.js";
-import { UpdaterArg } from "./updater.js";
-export interface Arg {
-    _id?: Id;
-    [key: string]: any;
-}
-export type SearchFunc<T = any> = (data: T, context: Context) => boolean;
-export type UpdaterFunc<T = any> = (data: T, context: Context) => boolean;
-export type Search<T = any> = SearchOptions | SearchFunc<T>;
-export type Updater<T = any> = UpdaterArg | UpdaterArg[] | UpdaterFunc<T>;

package/dist/esm/types/data.d.ts

@@ -1,4 +0,0 @@
-export interface Data {
-    [key: string]: any;
-}
-export default Data;

package/dist/esm/types/fileCpu.d.ts

@@ -1,51 +0,0 @@
-import { Search, Updater } from "./arg.js";
-import Data from "./data.js";
-import { FindOpts } from "./options.js";
-import { Context } from "./types.js";
-interface FileCpu {
-    /**
-     * Asynchronously adds an entry to a file.
-     * @param file The path to the file.
-     * @param data The data to add.
-     * @returns A promise resolving to `void`.
-     */
-    add(file: string, data: Data): Promise<void>;
-    /**
-     * Asynchronously finds multiple entries in a file based on search criteria.
-     * @param file The path to the file.
-     * @param arg The search criteria.
-     * @param context Additional context for the search.
-     * @param findOpts Additional options for searching.
-     * @returns A promise resolving to an array of found entries, or `false` if the file does not exist.
-     */
-    find(file: string, arg: Search, context?: Context, findOpts?: FindOpts): Promise<any[] | false>;
-    /**
-     * Asynchronously finds one entry in a file based on search criteria.
-     * @param file The path to the file.
-     * @param arg The search criteria.
-     * @param context Additional context for the search.
-     * @param findOpts Additional options for searching.
-     * @returns A promise resolving to the found entry or `false` if not found.
-     */
-    findOne(file: string, arg: Search, context?: Context, findOpts?: FindOpts): Promise<any | false>;
-    /**
-   * Asynchronously removes entries from a file based on search criteria.
-   * @param file The path to the file.
-   * @param arg The search criteria.
-   * @param context Additional context for the operation.
-   * @param one If `true`, removes only the first matching entry.
-   * @returns A promise resolving to `true` if at least one entry was removed, otherwise `false`.
-   */
-    remove(file: string, one: boolean, arg: Search, context?: Context): Promise<boolean>;
-    /**
-     * Asynchronously updates entries in a file based on search criteria and an updater function or object.
-     * @param file The path to the file.
-     * @param arg The search criteria.
-     * @param updater The updater function or object.
-     * @param context Additional context for the operation.
-     * @param one If `true`, updates only the first matching entry.
-     * @returns A promise resolving to `true` if at least one entry was updated, otherwise `false`.
-     */
-    update(file: string, one: boolean, arg: Search, updater: Updater, context?: Context): Promise<boolean>;
-}
-export default FileCpu;

package/dist/esm/types/options.d.ts

@@ -1,12 +0,0 @@
-export interface DbOpts {
-    maxFileSize?: number;
-}
-export interface DbFindOpts {
-    reverse?: boolean;
-    max?: number;
-}
-export interface FindOpts {
-    select?: string[];
-    exclude?: string[];
-    transform?: Function;
-}

package/dist/esm/types/searchOpts.d.ts

@@ -1,62 +0,0 @@
-/**
- * Predefined Search Options Quick Reference
- *
- * This module defines the types and structures for search operators used
- * to validate and query data objects.
- */
-import { Arg } from "./arg.js";
-/** Logical Operators */
-export type LogicalOperators = {
-    /**
-     * Recursively applies multiple conditions, all of which must evaluate to true.
-     * Can include other operators such as $gt, $exists, or nested $and/$or conditions.
-     */
-    $and?: Array<SearchOptions>;
-    /**
-     * Recursively applies multiple conditions, at least one of which must evaluate to true.
-     * Can include other operators such as $lt, $type, or nested $and/$or conditions.
-     */
-    $or?: Array<SearchOptions>;
-    /**
-     * Negates a single condition.
-     * Can include any other operator as its value.
-     */
-    $not?: SearchOptions;
-};
-/** Comparison Operators */
-export type ComparisonOperators = {
-    $gt?: Record<string, number>;
-    $lt?: Record<string, number>;
-    $gte?: Record<string, number>;
-    $lte?: Record<string, number>;
-    $in?: Record<string, any[]>;
-    $nin?: Record<string, any[]>;
-    $between?: Record<string, [number, number]>;
-};
-/** Type and Existence Operators */
-export type TypeAndExistenceOperators = {
-    $exists?: Record<string, boolean>;
-    $type?: Record<string, string>;
-};
-/** Array Operators */
-export type ArrayOperators = {
-    $arrinc?: Record<string, any[]>;
-    $arrincall?: Record<string, any[]>;
-    $size?: Record<string, number>;
-};
-/** String Operators */
-export type StringOperators = {
-    $regex?: Record<string, RegExp>;
-    $startsWith?: Record<string, string>;
-    $endsWith?: Record<string, string>;
-};
-/** Other Operators */
-export type OtherOperators = {
-    $subset?: Record<string, any>;
-};
-/** Predefined Search Operators */
-export type PredefinedSearchOperators = LogicalOperators & ComparisonOperators & TypeAndExistenceOperators & ArrayOperators & StringOperators & OtherOperators;
-/**
- * SearchOptions can be either a function or an object with predefined operators.
- */
-export type SearchOptions = PredefinedSearchOperators & Arg;

package/dist/esm/types/types.d.ts

@@ -1,3 +0,0 @@
-export interface Context {
-    [key: string]: any;
-}

package/dist/esm/types/updater.d.ts

@@ -1,26 +0,0 @@
-/**
- * Predefined type for updating data.
- */
-/** Arrays */
-export type ArrayUpdater = {
-    $push?: any;
-    /** Pushes items into an array and removes duplicates */
-    $pushset?: any;
-    $pull?: any;
-    $pullall?: any;
-};
-/** Objects */
-export type ObjectUpdater = {
-    $merge?: any;
-};
-/** Values */
-export type ValueUpdater = {
-    $set?: any;
-    $inc?: any;
-    $dec?: any;
-    $unset?: any;
-    $rename?: any;
-};
-export type UpdaterArg = ArrayUpdater & ObjectUpdater & ValueUpdater & {
-    [key: string]: any;
-};

package/dist/esm/utils/hasFields.d.ts

@@ -1,7 +0,0 @@
-/**
- * Checks if an object matches the standard field comparison.
- * @param obj - The object to check.
- * @param fields - Criteria to compare.
- * @returns Whether the object matches the criteria.
- */
-export default function hasFields(obj: Object, fields: Object): boolean;

package/dist/esm/utils/hasFieldsAdvanced.d.ts

@@ -1,5 +0,0 @@
-import { Arg } from "../types/arg.js";
-/**
- * Checks if an object meets the criteria specified in the fields with operators.
- */
-export default function hasFieldsAdvanced(obj: Object, fields: Arg): any;

package/dist/esm/utils/updateFindObject.d.ts

@@ -1,11 +0,0 @@
-import { FindOpts } from "../types/options.js";
-/**
- * Updates an object with new values from a findOpts object.
- * @param obj - The object to update.
- * @param findOpts - An object containing options to update the target object.
- * @param [findOpts.transform] - A function to transform the object before applying the other options.
- * @param [findOpts.select] - An array of fields to select from the target object.
- * @param [findOpts.exclude] - An array of fields to exclude from the target object.
- * @returns The updated object.
- */
-export default function updateFindObject(obj: Object, findOpts: FindOpts): Object;

package/dist/esm/utils/updateObject.d.ts

@@ -1,7 +0,0 @@
-import { UpdaterArg } from "../types/updater.js";
-/**
- * Updates an object with new values.
- * @param obj - The object to update.
- * @param fields - An object containing new values to update in the target object.
- */
-export default function updateObjectAdvanced(obj: Object, fields: UpdaterArg | UpdaterArg[]): Object;