@wxn0brp/db-core 0.0.3 → 0.0.6

package/dist/db/valthera.d.ts

@@ -37,35 +37,35 @@ declare class ValtheraClass implements ValtheraCompatible {
     /**
      * Add data to a database.
      */
-    add<T = Data>(collection: string, data: Arg, id_gen?: boolean): Promise<T>;
+    add<T = Data>(collection: string, data: Arg<T>, id_gen?: boolean): Promise<T>;
     /**
      * Find data in a database.
      */
-    find<T = Data>(collection: string, search: Search, context?: VContext, dbFindOpts?: DbFindOpts, findOpts?: FindOpts): Promise<T[]>;
+    find<T = Data>(collection: string, search: Search<T>, context?: VContext, dbFindOpts?: DbFindOpts<T>, findOpts?: FindOpts<T>): Promise<T[]>;
     /**
      * Find one data entry in a database.
      */
-    findOne<T = Data>(collection: string, search: Search, context?: VContext, findOpts?: FindOpts): Promise<T>;
+    findOne<T = Data>(collection: string, search: Search<T>, context?: VContext, findOpts?: FindOpts<T>): Promise<T>;
     /**
      * Update data in a database.
      */
-    update(collection: string, search: Search, updater: Updater, context?: {}): Promise<boolean>;
+    update<T = Data>(collection: string, search: Search<T>, updater: Updater<T>, context?: {}): Promise<boolean>;
     /**
      * Update one data entry in a database.
      */
-    updateOne(collection: string, search: Search, updater: Updater, context?: VContext): Promise<boolean>;
+    updateOne<T = Data>(collection: string, search: Search<T>, updater: Updater<T>, context?: VContext): Promise<boolean>;
     /**
      * Remove data from a database.
      */
-    remove(collection: string, search: Search, context?: VContext): Promise<boolean>;
+    remove<T = Data>(collection: string, search: Search<T>, context?: VContext): Promise<boolean>;
     /**
      * Remove one data entry from a database.
      */
-    removeOne(collection: string, search: Search, context?: VContext): Promise<boolean>;
+    removeOne<T = Data>(collection: string, search: Search<T>, context?: VContext): 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?: VContext, id_gen?: boolean): Promise<boolean>;
+    updateOneOrAdd<T = Data>(collection: string, search: Search<T>, updater: Updater<T>, add_arg?: Arg, context?: VContext, id_gen?: boolean): Promise<boolean>;
     /**
      * Removes a database collection from the file system.
      */

package/dist/types/arg.d.ts

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

package/dist/types/options.d.ts

@@ -1,19 +1,20 @@
 import dbActionBase from "../base/actions.js";
 import executorC from "../helpers/executor.js";
+import { KeysMatching } from "./utils.js";
 export interface DbOpts {
     maxFileSize?: number;
     dbAction?: dbActionBase;
     executor?: executorC;
 }
-export interface DbFindOpts {
+export interface DbFindOpts<T = any> {
     reverse?: boolean;
     max?: number;
     offset?: number;
-    sortBy?: string;
+    sortBy?: KeysMatching<T, any>;
     sortAsc?: boolean;
 }
-export interface FindOpts {
-    select?: string[];
-    exclude?: string[];
+export interface FindOpts<T = any> {
+    select?: KeysMatching<T, any>[];
+    exclude?: KeysMatching<T, any>[];
     transform?: Function;
 }

package/dist/types/searchOpts.d.ts

@@ -5,58 +5,59 @@
  * to validate and query data objects.
  */
 import { Arg } from "./arg.js";
+import { PartialOfType, PartialPickMatching } from "./utils.js";
 /** Logical Operators */
-export type LogicalOperators = {
+export type LogicalOperators<T = any> = {
     /**
      * 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>;
+    $and?: Array<SearchOptions<T>>;
     /**
      * 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>;
+    $or?: Array<SearchOptions<T>>;
     /**
      * Negates a single condition.
      * Can include any other operator as its value.
      */
-    $not?: SearchOptions;
+    $not?: SearchOptions<T>;
 };
 /** 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]>;
+export type ComparisonOperators<T = any> = {
+    $gt?: PartialOfType<T, number>;
+    $lt?: PartialOfType<T, number>;
+    $gte?: PartialOfType<T, number>;
+    $lte?: PartialOfType<T, number>;
+    $between?: PartialOfType<T, [number, number], number>;
+    $in?: Partial<Record<keyof T, T[keyof T][]>>;
+    $nin?: Partial<Record<keyof T, T[keyof T][]>>;
 };
 /** Type and Existence Operators */
-export type TypeAndExistenceOperators = {
-    $exists?: Record<string, boolean>;
-    $type?: Record<string, string>;
+export type TypeAndExistenceOperators<T = any> = {
+    $exists?: PartialOfType<T, boolean, any>;
+    $type?: PartialOfType<T, string>;
 };
 /** Array Operators */
-export type ArrayOperators = {
-    $arrinc?: Record<string, any[]>;
-    $arrincall?: Record<string, any[]>;
-    $size?: Record<string, number>;
+export type ArrayOperators<T = any> = {
+    $arrinc?: PartialPickMatching<T, any[]>;
+    $arrincall?: PartialPickMatching<T, any[]>;
+    $size?: PartialOfType<T, number>;
 };
 /** String Operators */
-export type StringOperators = {
-    $regex?: Record<string, RegExp>;
-    $startsWith?: Record<string, string>;
-    $endsWith?: Record<string, string>;
+export type StringOperators<T = any> = {
+    $regex?: PartialOfType<T, RegExp, string>;
+    $startsWith?: PartialOfType<T, string>;
+    $endsWith?: PartialOfType<T, string>;
 };
 /** Other Operators */
-export type OtherOperators = {
-    $subset?: Record<string, any>;
+export type OtherOperators<T = any> = {
+    $subset?: Partial<Record<keyof T, T[keyof T]>>;
 };
 /** Predefined Search Operators */
-export type PredefinedSearchOperators = LogicalOperators & ComparisonOperators & TypeAndExistenceOperators & ArrayOperators & StringOperators & OtherOperators;
+export type PredefinedSearchOperators<T = any> = LogicalOperators<T> & ComparisonOperators<T> & TypeAndExistenceOperators<T> & ArrayOperators<T> & StringOperators<T> & OtherOperators<T>;
 /**
  * SearchOptions can be either a function or an object with predefined operators.
  */
-export type SearchOptions = PredefinedSearchOperators & Arg;
+export type SearchOptions<T = any> = PredefinedSearchOperators<T> & Arg<T>;

package/dist/types/updater.d.ts

@@ -1,26 +1,25 @@
 /**
  * Predefined type for updating data.
  */
+import { Arg } from "./arg.js";
+import { PartialOfType } from "./utils.js";
 /** Arrays */
-export type ArrayUpdater = {
-    $push?: any;
+export type ArrayUpdater<T = any> = {
+    $push?: PartialOfType<T, any>;
     /** Pushes items into an array and removes duplicates */
-    $pushset?: any;
-    $pull?: any;
-    $pullall?: any;
+    $pushset?: PartialOfType<T, any>;
+    $pull?: PartialOfType<T, any>;
+    $pullall?: PartialOfType<T, any>;
 };
 /** Objects */
-export type ObjectUpdater = {
-    $merge?: any;
+export type ObjectUpdater<T = any> = {
+    $merge?: PartialOfType<T, any[]>;
 };
 /** Values */
-export type ValueUpdater = {
-    $set?: any;
-    $inc?: any;
-    $dec?: any;
-    $unset?: any;
-    $rename?: any;
-};
-export type UpdaterArg = ArrayUpdater & ObjectUpdater & ValueUpdater & {
-    [key: string]: any;
+export type ValueUpdater<T = any> = {
+    $inc?: PartialOfType<T, number>;
+    $dec?: PartialOfType<T, number>;
+    $unset?: PartialOfType<T, any>;
+    $rename?: PartialOfType<T, any>;
 };
+export type UpdaterArg<T = any> = ArrayUpdater<T> & ObjectUpdater<T> & ValueUpdater<T> & Arg<T>;

package/dist/types/utils.d.ts

@@ -0,0 +1,5 @@
+export type KeysMatching<T, V, C = V> = {
+    [K in keyof T]-?: T[K] extends C ? K : never;
+}[keyof T];
+export type PartialOfType<T, V, C = V> = Partial<Record<KeysMatching<T, V, C>, V>>;
+export type PartialPickMatching<T, V, C = V> = Partial<Pick<T, KeysMatching<T, V, C>>>;

package/dist/types/utils.js

@@ -0,0 +1 @@
+export {};

package/dist/types/valthera.d.ts

@@ -9,15 +9,15 @@ export interface ValtheraCompatible {
     getCollections(): Promise<string[]>;
     checkCollection(collection: string): Promise<boolean>;
     issetCollection(collection: string): Promise<boolean>;
-    add<T = Data>(collection: string, data: Arg, id_gen?: boolean): Promise<T>;
-    find<T = Data>(collection: string, search: Search, context?: VContext, options?: DbFindOpts, findOpts?: FindOpts): Promise<T[]>;
-    findOne<T = Data>(collection: string, search: Search, context?: VContext, findOpts?: FindOpts): Promise<T | null>;
-    update(collection: string, search: Search, updater: Updater, context?: VContext): Promise<boolean>;
-    updateOne(collection: string, search: Search, updater: Updater, context?: VContext): Promise<boolean>;
-    remove(collection: string, search: Search, context?: VContext): Promise<boolean>;
-    removeOne(collection: string, search: Search, context?: VContext): Promise<boolean>;
+    add<T = Data>(collection: string, data: Arg<T>, id_gen?: boolean): Promise<T>;
+    find<T = Data>(collection: string, search: Search<T>, context?: VContext, options?: DbFindOpts<T>, findOpts?: FindOpts<T>): Promise<T[]>;
+    findOne<T = Data>(collection: string, search: Search<T>, context?: VContext, findOpts?: FindOpts<T>): 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>;
     removeCollection(collection: string): Promise<boolean>;
-    updateOneOrAdd(collection: string, search: Search, updater: Updater, add_arg?: Arg, context?: VContext, id_gen?: boolean): Promise<boolean>;
+    updateOneOrAdd<T = Data>(collection: string, search: Search<T>, updater: Updater<T>, add_arg?: Arg<T>, context?: VContext, id_gen?: boolean): Promise<boolean>;
 }
 export interface ValtheraCompatibleInternal {
     c(config: VQuery): CollectionManager;

package/dist/version.js

@@ -1 +1 @@
-export const version = "0.0.3";
+export const version = "0.0.6";

package/package.json

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