@wxn0brp/db-core 0.11.1-alpha.0 → 0.11.1-alpha.2

package/README.md

@@ -1,17 +1,30 @@
 # @wxn0brp/db-core
 
-Core library for [ValtheraDB](https://github.com/wxn0brp/ValtheraDB).
+Core runtime for [ValtheraDB](https://github.com/wxn0brP/ValtheraDB). This package contains the shared database logic that the higher-level Valthera packages build on.
 
-## ⚠️ Disclaimer
+It is usually not something you install directly unless you are:
 
-It is **not recommended** to install this module separately unless you plan to create your own ValtheraDB adapter.
+- building a custom storage adapter
+- extending the lower-level database runtime
+- working on Valthera itself
 
-## Installation
+## Install
 
 ```bash
 npm install @wxn0brp/db-core
 ```
 
+## What It Provides
+
+- collection and document primitives
+- query and update operators
+- relation handling
+- shared types used by the Valthera packages
+
+## Package Note
+
+If you are building an application, you probably want `@wxn0brp/db` instead of this package. `db-core` is the internal foundation.
+
 ## Documentation
 
 See [typedoc](https://wxn0brp.github.io/ValtheraDB-core/).
@@ -22,4 +35,4 @@ Contributions are welcome! Please submit pull requests or open issues on GitHub.
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+MIT. See [LICENSE](LICENSE).

package/dist/base/actions.d.ts

@@ -6,6 +6,7 @@ export declare abstract class ActionsBase implements ActionsBaseInterface {
     numberId: boolean;
     smartExecutor: boolean;
     init(...args: any[]): Promise<void>;
+    close(...args: any[]): Promise<void>;
     abstract getCollections(): Promise<string[]>;
     abstract ensureCollection(collection: string): Promise<boolean>;
     abstract issetCollection(collection: string): Promise<boolean>;

package/dist/base/actions.js

@@ -4,6 +4,7 @@ export class ActionsBase {
     numberId = false;
     smartExecutor = false;
     async init(...args) { }
+    async close(...args) { }
     async updateOneOrAdd(config) {
         const res = await this.updateOne(config);
         if (res)

package/dist/db/multiStorage.d.ts

@@ -5,6 +5,7 @@ export declare class MultiBackend extends ActionsBase {
     primaryBackend: ActionsBase;
     constructor(backends: ActionsBase[], primaryIndex?: number);
     init(...args: any[]): Promise<void>;
+    close(...args: any[]): Promise<void>;
     add(config: VQueryT.Add): Promise<import("../types/data.js").DataInternal>;
     find(config: VQueryT.Find): Promise<import("../types/data.js").DataInternal[]>;
     findOne(config: VQueryT.FindOne): Promise<import("../types/data.js").DataInternal>;

package/dist/db/multiStorage.js

@@ -10,6 +10,9 @@ export class MultiBackend extends ActionsBase {
     async init(...args) {
         await Promise.all(this.backends.map(b => b.init?.(...args)));
     }
+    async close(...args) {
+        await Promise.all(this.backends.map(b => b.close(...args)));
+    }
     async add(config) {
         return await this.primaryBackend.add({ ...config });
     }

package/dist/db/routedStorage.d.ts

@@ -13,6 +13,7 @@ export declare class RoutedStorage extends ActionsBase {
     _withAll<T>(config: VQuery | string, fn: (b: ActionsBase) => Promise<T>, gather?: boolean): Promise<T>;
     _withFirst<T>(config: VQuery | string, fn: (b: ActionsBase) => Promise<T>): Promise<T>;
     init(...args: any[]): Promise<void>;
+    close(...args: any[]): Promise<void>;
     add(config: VQueryT.Add): Promise<import("../types/data.js").DataInternal>;
     find(config: VQueryT.Find): Promise<import("../types/data.js").DataInternal[]>;
     findOne(config: VQueryT.FindOne): Promise<import("../types/data.js").DataInternal>;

package/dist/db/routedStorage.js

@@ -41,6 +41,13 @@ export class RoutedStorage extends ActionsBase {
         const all = new Set(this.rules.flatMap(r => r.backends));
         await Promise.all(Array.from(all).map(b => b.init?.(...args)));
     }
+    async close(...args) {
+        const all = new Set([
+            ...this.rules.flatMap(r => r.backends),
+            ...this.defaultBackend
+        ]);
+        await Promise.all(Array.from(all).map(b => b.close(...args)));
+    }
     async add(config) {
         const res = await this._withFirst(config, b => b.add(config));
         await this._withAll({ ...config, data: res }, b => b.add({ ...config, data: res }));

package/dist/db/valthera.d.ts

@@ -40,6 +40,7 @@ export declare class ValtheraClass implements ValtheraCompatible {
     version: string;
     constructor(options: DbOpts);
     init(...args: any[]): Promise<any>;
+    close(...args: any[]): Promise<any>;
     execute<T>(name: keyof ValtheraCompatible, query: VQuery<any> | string): Promise<T>;
     /**
      * Create a new instance of a Collection class.

package/dist/db/valthera.js

@@ -30,6 +30,17 @@ export class ValtheraClass {
             self.dbAction._inited = true;
         });
     }
+    async close(...args) {
+        if (!this.dbAction._inited)
+            return;
+        const self = this;
+        return await this.executor.addOp(async () => {
+            if (!self.dbAction._inited)
+                return;
+            await self.dbAction.close(...args);
+            self.dbAction._inited = false;
+        });
+    }
     async execute(name, query) {
         await this.init();
         const result = await this.executor.addOp(this.dbAction[name].bind(this.dbAction), query, typeof query === "string" ? query : query.collection);

package/dist/types/action.d.ts

@@ -4,6 +4,7 @@ export interface ActionsBaseInterface {
     _inited: boolean;
     numberId: boolean;
     init(...args: any[]): Promise<void>;
+    close(...args: any[]): Promise<void>;
     getCollections(): Promise<string[]>;
     ensureCollection(collection: string): Promise<boolean>;
     issetCollection(collection: string): Promise<boolean>;

package/dist/types/fileCpu.d.ts

@@ -5,27 +5,27 @@ export interface FileCpu {
      * Asynchronously adds an entry to a file.
      * @returns A promise resolving to `void`.
      */
-    add(file: string, config: VQueryT.Add): Promise<void>;
+    add(file: string, config: VQueryT.Add, opts?: any): Promise<void>;
     /**
      * Asynchronously finds multiple entries in a file based on search criteria.
      * @returns A promise resolving to an array of found entries, or `false` if the file does not exist.
      */
-    find(file: string, config: VQueryT.Find): Promise<DataInternal[]>;
+    find(file: string, config: VQueryT.Find, opts?: any): Promise<DataInternal[]>;
     /**
      * Asynchronously finds one entry in a file based on search criteria.
      * @returns A promise resolving to the found entry or `false` if not found.
      */
-    findOne(file: string, config: VQueryT.FindOne): Promise<DataInternal | false>;
+    findOne(file: string, config: VQueryT.FindOne, opts?: any): Promise<DataInternal | false>;
     /**
    * Asynchronously removes entries from a file based on search criteria.
    * @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, config: VQueryT.Remove, one: boolean): Promise<DataInternal[]>;
+    remove(file: string, config: VQueryT.Remove, one: boolean, opts?: any): Promise<DataInternal[]>;
     /**
      * Asynchronously updates entries in a file based on search criteria and an updater function or object.
      * @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, config: VQueryT.Update, one: boolean): Promise<DataInternal[]>;
+    update(file: string, config: VQueryT.Update, one: boolean, opts?: any): Promise<DataInternal[]>;
 }

package/dist/utils/action.d.ts

@@ -1,4 +1,4 @@
 import { Data } from "../types/data.js";
 import { FileCpu } from "../types/fileCpu.js";
 import { VQueryT } from "../types/query.js";
-export declare function findUtil(query: VQueryT.Find, fileCpuOrData: FileCpu | Object[], files: string[]): Promise<Data[]>;
+export declare function findUtil(query: VQueryT.Find, fileCpuOrData: FileCpu | Object[], files: string[], fileCpuOpts?: any): Promise<Data[]>;

package/dist/utils/action.js

@@ -1,5 +1,5 @@
 import { compareSafe } from "./compare.js";
-export async function findUtil(query, fileCpuOrData, files) {
+export async function findUtil(query, fileCpuOrData, files, fileCpuOpts) {
     const { dbFindOpts = {} } = query;
     const { reverse = false, offset = 0, limit = -1, sortBy, sortAsc = true, min, max, avg, groupBy, count, } = dbFindOpts;
     const needsAllData = min || max || avg || groupBy || count || sortBy;
@@ -18,7 +18,7 @@ export async function findUtil(query, fileCpuOrData, files) {
     else {
         const filesToProcess = reverse && !sortBy ? [...files].reverse() : files;
         for (const f of filesToProcess) {
-            let entries = await fileCpuOrData.find(f, query);
+            let entries = await fileCpuOrData.find(f, query, fileCpuOpts);
             if (reverse && !sortBy)
                 entries.reverse();
             if (needsAllData) {

package/dist/version.js

@@ -1 +1 @@
-export const version = "0.11.1-alpha.0";
+export const version = "0.11.1-alpha.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/db-core",
-  "version": "0.11.1-alpha.0",
+  "version": "0.11.1-alpha.2",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "author": "wxn0brP",