@wxn0brp/db-core 0.8.1 → 0.9.0

package/dist/base/actions.d.ts

@@ -11,9 +11,9 @@ export declare abstract class ActionsBase implements ActionsBaseInterface {
     abstract add(config: VQuery): Promise<DataInternal>;
     abstract find(config: VQuery): Promise<DataInternal[]>;
     abstract findOne(config: VQuery): Promise<DataInternal | null>;
-    abstract update(config: VQuery): Promise<DataInternal[] | null>;
+    abstract update(config: VQuery): Promise<DataInternal[]>;
     abstract updateOne(config: VQuery): Promise<DataInternal | null>;
-    abstract remove(config: VQuery): Promise<DataInternal[] | null>;
+    abstract remove(config: VQuery): Promise<DataInternal[]>;
     abstract removeOne(config: VQuery): Promise<DataInternal | null>;
     abstract removeCollection(config: VQuery): Promise<boolean>;
     updateOneOrAdd(config: VQuery): Promise<UpdateOneOrAddResult<DataInternal>>;

package/dist/base/custom.d.ts

@@ -8,7 +8,7 @@ export declare abstract class CustomActionsBase extends ActionsBase {
     /**
      * Add a new entry to the specified database.
      */
-    add(query: VQuery): Promise<import("../types/arg.js").Arg>;
+    add(query: VQuery): Promise<import("../types/arg.js").Arg<Data>>;
     /**
      * Find entries in the specified database based on search criteria.
      */

package/dist/db/valthera.d.ts

@@ -4,7 +4,7 @@ import { Collection } from "../helpers/collection.js";
 import { Executor } from "../helpers/executor.js";
 import { Data } from "../types/data.js";
 import { DbOpts } from "../types/options.js";
-import { AddQuery, FindOneQuery, FindQuery, RemoveQuery, ToggleOneQuery, UpdateOneOrAddQuery, UpdateQuery, VQuery } from "../types/query.js";
+import { AddQuery, FindOneQuery, FindQuery, RemoveQuery, ToggleOneQuery, ToggleOneResult, UpdateOneOrAddQuery, UpdateOneOrAddResult, UpdateQuery, VQuery } from "../types/query.js";
 import { ValtheraCompatible } from "../types/valthera.js";
 /**
  * Represents a database management class for performing CRUD operations.
@@ -21,7 +21,7 @@ export declare class ValtheraClass implements ValtheraCompatible {
     version: string;
     constructor(options: DbOpts);
     init(...args: any[]): Promise<unknown>;
-    execute<T>(name: keyof ValtheraCompatible, query: VQuery): Promise<T>;
+    execute<T>(name: keyof ValtheraCompatible, query: VQuery<any>): Promise<T>;
     /**
      * Create a new instance of a CollectionManager class.
      */
@@ -41,42 +41,42 @@ export declare class ValtheraClass implements ValtheraCompatible {
     /**
      * Add data to a database.
      */
-    add<T = Data>(query: AddQuery): Promise<T>;
+    add<T = Data>(query: AddQuery<T>): Promise<T>;
     /**
      * Find data in a database.
      */
-    find<T = Data>(query: FindQuery): Promise<T[]>;
+    find<T = Data>(query: FindQuery<T>): Promise<T[]>;
     /**
      * Find one data entry in a database.
      */
-    findOne<T = Data>(query: FindOneQuery): Promise<T>;
+    findOne<T = Data>(query: FindOneQuery<T>): Promise<T>;
     /**
      * Update data in a database.
      */
-    update<T = Data>(query: UpdateQuery): Promise<T[]>;
+    update<T = Data>(query: UpdateQuery<T>): Promise<T[]>;
     /**
      * Update one data entry in a database.
      */
-    updateOne<T = Data>(query: UpdateQuery): Promise<T>;
+    updateOne<T = Data>(query: UpdateQuery<T>): Promise<T>;
     /**
      * Remove data from a database.
      */
-    remove<T = Data>(query: RemoveQuery): Promise<T[]>;
+    remove<T = Data>(query: RemoveQuery<T>): Promise<T[]>;
     /**
      * Remove one data entry from a database.
      */
-    removeOne<T = Data>(query: RemoveQuery): Promise<T>;
+    removeOne<T = Data>(query: RemoveQuery<T>): Promise<T>;
     /**
      * Asynchronously updates one entry in a database or adds a new one if it doesn't exist.
      */
-    updateOneOrAdd<T = Data>(query: UpdateOneOrAddQuery): Promise<T>;
+    updateOneOrAdd<T = Data>(query: UpdateOneOrAddQuery<T>): Promise<UpdateOneOrAddResult<T>>;
     /**
      * Asynchronously removes one entry in a database or adds a new one if it doesn't exist. Usage e.g. for toggling a flag.
      * Returns a promise resolving to `false` if the entry was found and removed,
      * or `true` if the entry was added. The returned value reflects the state of the database
      * after the operation.
      */
-    toggleOne<T = Data>(query: ToggleOneQuery): Promise<T>;
+    toggleOne<T = Data>(query: ToggleOneQuery<T>): Promise<ToggleOneResult<T>>;
     /**
      * Removes a database collection from the file system.
      */

package/dist/helpers/addId.d.ts

@@ -1,3 +1,3 @@
 import { ActionsBase } from "../base/actions.js";
 import { VQuery } from "../types/query.js";
-export declare function addId(query: VQuery, actions: ActionsBase, defaultGen?: boolean): Promise<import("../types/arg.js").Arg>;
+export declare function addId(query: VQuery, actions: ActionsBase, defaultGen?: boolean): Promise<import("../types/arg.js").Arg<import("../types/data.js").Data>>;

package/dist/helpers/collection.d.ts

@@ -31,7 +31,7 @@ export declare class Collection<D = Data> {
     /**
      * Update one data entry in a database.
      */
-    updateOne(search: Search<D>, updater: Updater<D>, context?: VContext): Promise<D>;
+    updateOne(search: Search<D>, updater: Updater<D>, context?: VContext): Promise<D | null>;
     /**
      * Remove data from a database.
      */
@@ -39,7 +39,7 @@ export declare class Collection<D = Data> {
     /**
      * Remove one data entry from a database.
      */
-    removeOne(search: Search<D>, context?: VContext): Promise<D>;
+    removeOne(search: Search<D>, context?: VContext): Promise<D | null>;
     /**
      * Asynchronously updates one entry in a database or adds a new one if it doesn't exist.
      */

package/dist/types/action.d.ts

@@ -10,9 +10,9 @@ export interface ActionsBaseInterface {
     add(config: VQuery): Promise<DataInternal>;
     find(config: VQuery): Promise<DataInternal[]>;
     findOne(config: VQuery): Promise<DataInternal | null>;
-    update(config: VQuery): Promise<DataInternal[] | null>;
+    update(config: VQuery): Promise<DataInternal[]>;
     updateOne(config: VQuery): Promise<DataInternal | null>;
-    remove(config: VQuery): Promise<DataInternal[] | null>;
+    remove(config: VQuery): Promise<DataInternal[]>;
     removeOne(config: VQuery): Promise<DataInternal | null>;
     removeCollection(config: VQuery): Promise<boolean>;
     updateOneOrAdd(config: VQuery): Promise<UpdateOneOrAddResult<DataInternal>>;

package/dist/types/query.d.ts

@@ -1,4 +1,5 @@
 import { Arg, Search, Updater } from "./arg.js";
+import { Data } from "./data.js";
 import { DbFindOpts, FindOpts } from "./options.js";
 import { VContext } from "./types.js";
 /**
@@ -12,26 +13,26 @@ import { VContext } from "./types.js";
  */
 export interface VQuery_Control {
 }
-export interface VQuery {
+export interface VQuery<T = Data> {
     collection?: string;
-    search?: Search;
+    search?: Search<T>;
     context?: VContext;
-    dbFindOpts?: DbFindOpts;
-    findOpts?: FindOpts;
-    data?: Arg;
+    dbFindOpts?: DbFindOpts<T>;
+    findOpts?: FindOpts<T>;
+    data?: Arg<T>;
     id_gen?: boolean;
-    add_arg?: Arg;
-    updater?: Updater;
+    add_arg?: Arg<T>;
+    updater?: Updater<T>;
     control?: VQuery_Control;
 }
-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 = Omit<QueryBase, "search"> & Pick<VQuery, "search"> & 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 type QueryBase<T = Data> = Required<Pick<VQuery<T>, "collection" | "search">> & Pick<VQuery<T>, "control">;
+export type AddQuery<T = Data> = Required<Pick<VQuery<T>, "data" | "collection">> & Pick<VQuery<T>, "id_gen" | "control">;
+export type FindQuery<T = Data> = Omit<QueryBase, "search"> & Pick<VQuery<T>, "search"> & Pick<VQuery<T>, "findOpts" | "dbFindOpts" | "context">;
+export type FindOneQuery<T = Data> = QueryBase & Pick<VQuery<T>, "findOpts" | "context">;
+export type UpdateQuery<T = Data> = QueryBase & Required<Pick<VQuery<T>, "updater">> & Pick<VQuery<T>, "context">;
+export type RemoveQuery<T = Data> = QueryBase & Pick<VQuery<T>, "context">;
+export type UpdateOneOrAddQuery<T = Data> = QueryBase & UpdateQuery & Pick<VQuery<T>, "add_arg" | "id_gen">;
+export type ToggleOneQuery<T = Data> = QueryBase & Pick<VQuery<T>, "data" | "context">;
 export interface UpdateOneOrAddResult<T> {
     data: T;
     type: "added" | "updated";

package/dist/types/valthera.d.ts

@@ -2,18 +2,18 @@ import { Collection } from "../helpers/collection.js";
 import { Data } from "./data.js";
 import { AddQuery, FindOneQuery, FindQuery, RemoveQuery, ToggleOneQuery, ToggleOneResult, UpdateOneOrAddQuery, UpdateOneOrAddResult, UpdateQuery } from "./query.js";
 export interface ValtheraCompatible {
-    c(collection: string): Collection;
+    c<T = Data>(collection: string): Collection<T>;
     getCollections(): Promise<string[]>;
     ensureCollection(collection: string): Promise<boolean>;
     issetCollection(collection: string): 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>;
+    add<T = Data>(query: AddQuery<T>): Promise<T>;
+    find<T = Data>(query: FindQuery<T>): Promise<T[]>;
+    findOne<T = Data>(query: FindOneQuery<T>): Promise<T | null>;
+    update<T = Data>(query: UpdateQuery<T>): Promise<T[]>;
+    updateOne<T = Data>(query: UpdateQuery<T>): Promise<T | null>;
+    remove<T = Data>(query: RemoveQuery<T>): Promise<T[]>;
+    removeOne<T = Data>(query: RemoveQuery<T>): Promise<T | null>;
     removeCollection(collection: string): Promise<boolean>;
-    updateOneOrAdd<T = Data>(query: UpdateOneOrAddQuery): Promise<UpdateOneOrAddResult<T>>;
-    toggleOne<T = Data>(query: ToggleOneQuery): Promise<ToggleOneResult<T>>;
+    updateOneOrAdd<T = Data>(query: UpdateOneOrAddQuery<T>): Promise<UpdateOneOrAddResult<T>>;
+    toggleOne<T = Data>(query: ToggleOneQuery<T>): Promise<ToggleOneResult<T>>;
 }

package/dist/version.js

@@ -1 +1 @@
-export const version = "0.8.1";
+export const version = "0.9.0";

package/package.json

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