@wxn0brp/db-core 0.4.0 → 0.5.0-alpha.1

package/dist/types/query.d.ts

@@ -1,6 +1,17 @@
 import { VContext } from "./types.js";
 import { Arg, Search, Updater } from "./arg.js";
 import { DbFindOpts, FindOpts } from "./options.js";
+/**
+ * To extend via adapters
+ * @example
+ * declare module "@wxn0brp/db-core" {
+ *   export interface VQuery_Control {
+ *     key?: "value";
+ *   }
+ * }
+ */
+export interface VQuery_Control {
+}
 export interface VQuery {
     collection?: string;
     search?: Search;
@@ -11,4 +22,5 @@ export interface VQuery {
     id_gen?: boolean;
     add_arg?: Arg;
     updater?: Updater;
+    control?: VQuery_Control;
 }

package/dist/types/relation.d.ts

@@ -15,7 +15,7 @@ export declare namespace RelationTypes {
         fk?: string;
         as?: string;
         select?: string[];
-        findOpts?: DbFindOpts;
+        dbFindOpts?: DbFindOpts;
         type?: "1" | "11" | "1n" | "nm";
         relations?: Relation;
         through?: {

package/dist/types/valthera.d.ts

@@ -1,23 +1,31 @@
-import { CollectionManager } from "../helpers/collectionManager.js";
-import { Arg, Search, Updater } from "./arg.js";
-import Data from "./data.js";
-import { DbFindOpts, FindOpts } from "./options.js";
+import { Collection } from "../helpers/collection.js";
+import { Arg } from "./arg.js";
+import { Data } from "./data.js";
+import { VQuery } from "./query.js";
 import { VContext } from "./types.js";
+export type QueryBase = Required<Pick<VQuery, "collection" | "search">> & Pick<VQuery, "control">;
+export type AddQuery = Required<Pick<VQuery, "data" | "collection">> & Pick<VQuery, "id_gen" | "control">;
+export type FindQuery = QueryBase & Pick<VQuery, "findOpts" | "dbFindOpts" | "context">;
+export type FindOneQuery = QueryBase & Pick<VQuery, "findOpts" | "context">;
+export type UpdateQuery = QueryBase & Required<Pick<VQuery, "updater">> & Pick<VQuery, "context">;
+export type RemoveQuery = QueryBase & Pick<VQuery, "context">;
+export type UpdateOneOrAddQuery = QueryBase & UpdateQuery & Pick<VQuery, "add_arg" | "id_gen">;
+export type ToggleOneQuery = QueryBase & Pick<VQuery, "data" | "context">;
 export interface ValtheraCompatible {
-    c(collection: string): CollectionManager;
+    c(collection: string): Collection;
     getCollections(): Promise<string[]>;
     ensureCollection(collection: string): Promise<boolean>;
     issetCollection(collection: string): Promise<boolean>;
-    add<T = Data>(collection: string, data: Arg<T>, id_gen?: boolean): Promise<T>;
-    find<T = Data>(collection: string, search?: Search<T>, options?: DbFindOpts<T>, findOpts?: FindOpts<T>, context?: VContext): Promise<T[]>;
-    findOne<T = Data>(collection: string, search?: Search<T>, findOpts?: FindOpts<T>, context?: VContext): Promise<T | null>;
-    update<T = Data>(collection: string, search: Search<T>, updater: Updater<T>, context?: VContext): Promise<boolean>;
-    updateOne<T = Data>(collection: string, search: Search<T>, updater: Updater<T>, context?: VContext): Promise<boolean>;
-    remove<T = Data>(collection: string, search: Search<T>, context?: VContext): Promise<boolean>;
-    removeOne<T = Data>(collection: string, search: Search<T>, context?: VContext): Promise<boolean>;
+    add<T = Data>(query: AddQuery): Promise<T>;
+    find<T = Data>(query: FindQuery): Promise<T[]>;
+    findOne<T = Data>(query: FindOneQuery): Promise<T | null>;
+    update<T = Data>(query: UpdateQuery): Promise<T[] | null>;
+    updateOne<T = Data>(query: UpdateQuery): Promise<T | null>;
+    remove<T = Data>(query: RemoveQuery): Promise<T[] | null>;
+    removeOne<T = Data>(query: RemoveQuery): Promise<T | null>;
     removeCollection(collection: string): Promise<boolean>;
-    updateOneOrAdd<T = Data>(collection: string, search: Search<T>, updater: Updater<T>, opts?: UpdateOneOrAdd<T>): Promise<boolean>;
-    toggleOne<T = Data>(collection: string, search: Search<T>, data?: Arg<T>, context?: VContext): Promise<boolean>;
+    updateOneOrAdd<T = Data>(query: UpdateOneOrAddQuery): Promise<T>;
+    toggleOne<T = Data>(query: ToggleOneQuery): Promise<T | null>;
 }
 export interface UpdateOneOrAdd<T> {
     add_arg?: Arg<T>;

package/dist/utils/action.d.ts

@@ -1,4 +1,4 @@
-import Data from "../types/data.js";
-import FileCpu from "../types/fileCpu.js";
+import { Data } from "../types/data.js";
+import { FileCpu } from "../types/fileCpu.js";
 import { VQuery } from "../types/query.js";
 export declare function findUtil(query: VQuery, fileCpu: FileCpu, files: string[]): Promise<Data[]>;

package/dist/utils/hasFields.d.ts

@@ -4,4 +4,4 @@
  * @param fields - Criteria to compare.
  * @returns Whether the object matches the criteria.
  */
-export default function hasFields(obj: Object, fields: Object): boolean;
+export declare function hasFields(obj: Object, fields: Object): boolean;

package/dist/utils/hasFields.js

@@ -4,7 +4,7 @@
  * @param fields - Criteria to compare.
  * @returns Whether the object matches the criteria.
  */
-export default function hasFields(obj, fields) {
+export function hasFields(obj, fields) {
     const keys = Object.keys(fields);
     return keys.every(key => {
         if (obj[key] !== undefined) {

package/dist/utils/hasFieldsAdvanced.d.ts

@@ -2,4 +2,4 @@ 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;
+export declare function hasFieldsAdvanced(obj: Object, fields: Arg): any;

package/dist/utils/hasFieldsAdvanced.js

@@ -1,9 +1,9 @@
-import hasFields from "./hasFields.js";
+import { hasFields } from "./hasFields.js";
 import { compareIds } from "./id.js";
 /**
  * Checks if an object meets the criteria specified in the fields with operators.
  */
-export default function hasFieldsAdvanced(obj, fields) {
+export function hasFieldsAdvanced(obj, fields) {
     if (typeof fields !== "object" || fields === null) {
         throw new Error("Fields must be an object");
     }

package/dist/utils/updateFindObject.d.ts

@@ -8,4 +8,4 @@ import { FindOpts } from "../types/options.js";
  * @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;
+export declare function updateFindObject(obj: Object, findOpts: FindOpts): Object;

package/dist/utils/updateFindObject.js

@@ -7,7 +7,7 @@
  * @param [findOpts.exclude] - An array of fields to exclude from the target object.
  * @returns The updated object.
  */
-export default function updateFindObject(obj, findOpts) {
+export function updateFindObject(obj, findOpts) {
     const { transform, select, exclude, } = findOpts;
     if (typeof transform === "function")
         obj = transform(obj);

package/dist/utils/updateObject.d.ts

@@ -4,4 +4,4 @@ import { UpdaterArg } from "../types/updater.js";
  * @param obj - The object to update.
  * @param field - An object containing new values to update in the target object.
  */
-export default function updateObjectAdvanced(obj: Record<string, any>, field: UpdaterArg): Record<string, any>;
+export declare function updateObjectAdvanced(obj: Record<string, any>, field: UpdaterArg): Record<string, any>;

package/dist/utils/updateObject.js

@@ -4,7 +4,7 @@ import { _deepMerge } from "./merge.js";
  * @param obj - The object to update.
  * @param field - An object containing new values to update in the target object.
  */
-export default function updateObjectAdvanced(obj, field) {
+export function updateObjectAdvanced(obj, field) {
     if (typeof field !== "object" || field === null) {
         throw new Error("Fields must be an object or object array");
     }

package/dist/version.js

@@ -1 +1 @@
-export const version = "0.4.0";
+export const version = "0.5.0-alpha.1";

package/package.json

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

package/dist/helpers/collectionManager.js

@@ -1,62 +0,0 @@
-export class CollectionManager {
-    db;
-    collection;
-    constructor(db, collection) {
-        this.db = db;
-        this.collection = collection;
-    }
-    /**
-     * Add data to a database.
-     */
-    async add(data, id_gen = true) {
-        return await this.db.add(this.collection, data, id_gen);
-    }
-    /**
-     * Find data in a database.
-     */
-    async find(search = {}, options = {}, findOpts = {}, context = {}) {
-        return await this.db.find(this.collection, search, options, findOpts, context);
-    }
-    /**
-     * Find one data entry in a database.
-     */
-    async findOne(search = {}, findOpts = {}, context = {}) {
-        return await this.db.findOne(this.collection, search, findOpts, context);
-    }
-    /**
-     * Update data in a database.
-     */
-    async update(search, updater, context = {}) {
-        return await this.db.update(this.collection, search, updater, context);
-    }
-    /**
-     * Update one data entry in a database.
-     */
-    async updateOne(search, updater, context = {}) {
-        return await this.db.updateOne(this.collection, search, updater, context);
-    }
-    /**
-     * Remove data from a database.
-     */
-    async remove(search, context = {}) {
-        return await this.db.remove(this.collection, search, context);
-    }
-    /**
-     * Remove one data entry from a database.
-     */
-    async removeOne(search, context = {}) {
-        return await this.db.removeOne(this.collection, search, context);
-    }
-    /**
-     * Asynchronously updates one entry in a database or adds a new one if it doesn't exist.
-     */
-    async updateOneOrAdd(search, updater, { add_arg = {}, context = {}, id_gen = true } = {}) {
-        return await this.db.updateOneOrAdd(this.collection, search, updater, { add_arg, context, id_gen });
-    }
-    /**
-     * Asynchronously removes one entry in a database or adds a new one if it doesn't exist. Usage e.g. for toggling a flag.
-     */
-    async toggleOne(search, data = {}, context = {}) {
-        return await this.db.toggleOne(this.collection, search, data, context);
-    }
-}