@wxn0brp/vql-client 0.2.6 → 0.2.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/vql.d.ts +52 -44
  2. package/package.json +1 -1
package/dist/vql.d.ts CHANGED
@@ -7,66 +7,74 @@ export interface VContext {
7
7
  export type KeysMatching<T, V, C = V> = {
8
8
  [K in keyof T]-?: T[K] extends C ? K : never;
9
9
  }[keyof T];
10
- export type PartialOfType<T, V, C = V> = Partial<Record<KeysMatching<T, V, C>, V>>;
11
- export type PartialPickMatching<T, V, C = V> = Partial<Pick<T, KeysMatching<T, V, C>>>;
10
+ export type NestedValue<T, V, C = V> = {
11
+ [K in keyof T as T[K] extends C ? K : T[K] extends object ? K : never]?: T[K] extends C ? V : T[K] extends object ? NestedValue<T[K], V, C> : never;
12
+ };
13
+ export type DeepPartial<T> = {
14
+ [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
15
+ };
12
16
  export type LogicalOperators<T = any> = {
13
17
  $and?: Array<SearchOptions<T>>;
14
18
  $or?: Array<SearchOptions<T>>;
15
19
  $not?: SearchOptions<T>;
16
20
  };
17
21
  export type ComparisonOperators<T = any> = {
18
- $gt?: PartialOfType<T, number>;
19
- $lt?: PartialOfType<T, number>;
20
- $gte?: PartialOfType<T, number>;
21
- $lte?: PartialOfType<T, number>;
22
- $between?: PartialOfType<T, [
22
+ $gt?: NestedValue<T, number, number>;
23
+ $lt?: NestedValue<T, number, number>;
24
+ $gte?: NestedValue<T, number, number>;
25
+ $lte?: NestedValue<T, number, number>;
26
+ $between?: NestedValue<T, [
23
27
  number,
24
28
  number
25
29
  ], number>;
26
- $in?: Partial<Record<keyof T, T[keyof T][]>>;
27
- $nin?: Partial<Record<keyof T, T[keyof T][]>>;
28
- $idGt?: PartialOfType<T, string | number>;
29
- $idLt?: PartialOfType<T, string | number>;
30
- $idGte?: PartialOfType<T, string | number>;
31
- $idLte?: PartialOfType<T, string | number>;
30
+ $in?: DeepPartial<T> & {
31
+ [K in keyof T]?: T[K] extends any[] ? T[K] : T[K][];
32
+ };
33
+ $nin?: DeepPartial<T> & {
34
+ [K in keyof T]?: T[K] extends any[] ? T[K] : T[K][];
35
+ };
36
+ $idGt?: NestedValue<T, string | number, string | number>;
37
+ $idLt?: NestedValue<T, string | number, string | number>;
38
+ $idGte?: NestedValue<T, string | number, string | number>;
39
+ $idLte?: NestedValue<T, string | number, string | number>;
32
40
  };
33
41
  export type TypeAndExistenceOperators<T = any> = {
34
- $exists?: PartialOfType<T, boolean, any>;
35
- $type?: PartialOfType<T, string>;
42
+ $exists?: NestedValue<T, boolean>;
43
+ $type?: NestedValue<T, string>;
36
44
  };
37
45
  export type ArrayOperators<T = any> = {
38
- $arrinc?: PartialPickMatching<T, any[]>;
39
- $arrincall?: PartialPickMatching<T, any[]>;
40
- $size?: PartialOfType<T, number>;
46
+ $arrinc?: DeepPartial<T>;
47
+ $arrincall?: DeepPartial<T>;
48
+ $size?: NestedValue<T, number>;
41
49
  };
42
50
  export type StringOperators<T = any> = {
43
- $regex?: PartialOfType<T, RegExp | string, string>;
44
- $startsWith?: PartialOfType<T, string>;
45
- $endsWith?: PartialOfType<T, string>;
51
+ $regex?: NestedValue<T, RegExp | string, string>;
52
+ $startsWith?: NestedValue<T, string, string>;
53
+ $endsWith?: NestedValue<T, string, string>;
46
54
  };
47
55
  export type OtherOperators<T = any> = {
48
- $subset?: Partial<Record<keyof T, T[keyof T]>>;
56
+ $subset?: DeepPartial<T>;
49
57
  };
50
58
  export type PredefinedSearchOperators<T = any> = LogicalOperators<T> & ComparisonOperators<T> & TypeAndExistenceOperators<T> & ArrayOperators<T> & StringOperators<T> & OtherOperators<T>;
51
- export type SearchOptions<T = any> = PredefinedSearchOperators<T> & Arg<T>;
59
+ export type SearchOptions<T = any> = PredefinedSearchOperators<T> & DeepPartial<T> & Record<string, any>;
52
60
  export type ArrayUpdater<T = any> = {
53
- $push?: PartialOfType<T, any>;
54
- $pushset?: PartialOfType<T, any>;
55
- $pull?: PartialOfType<T, any>;
56
- $pullall?: PartialOfType<T, any>;
61
+ $push?: NestedValue<T, any>;
62
+ $pushset?: NestedValue<T, any>;
63
+ $pull?: NestedValue<T, any>;
64
+ $pullall?: NestedValue<T, any>;
57
65
  };
58
66
  export type ObjectUpdater<T = any> = {
59
- $merge?: PartialOfType<T, any>;
60
- $deepMerge?: PartialOfType<T, any>;
67
+ $merge?: NestedValue<T, any>;
68
+ $deepMerge?: NestedValue<T, any>;
61
69
  };
62
70
  export type ValueUpdater<T = any> = {
63
- $inc?: PartialOfType<T, number>;
64
- $dec?: PartialOfType<T, number>;
65
- $unset?: PartialOfType<T, any>;
66
- $rename?: PartialOfType<T, any>;
67
- $set?: PartialOfType<T, any>;
71
+ $inc?: NestedValue<T, number>;
72
+ $dec?: NestedValue<T, number>;
73
+ $unset?: NestedValue<T, any>;
74
+ $rename?: NestedValue<T, any>;
75
+ $set?: NestedValue<T, any>;
68
76
  };
69
- export type UpdaterArg<T = any> = ArrayUpdater<T> & ObjectUpdater<T> & ValueUpdater<T> & Arg<T>;
77
+ export type UpdaterArg<T = any> = ArrayUpdater<T> & ObjectUpdater<T> & ValueUpdater<T> & DeepPartial<T> & Record<string, any>;
70
78
  export type Arg<T = any> = {
71
79
  [K in keyof T]?: any;
72
80
  } & Record<string, any>;
@@ -76,7 +84,7 @@ export type Search<T = any> = SearchOptions<T> | SearchFunc<T>;
76
84
  export type Updater<T = any> = UpdaterArg<T> | UpdaterArg<T>[] | UpdaterFunc<T>;
77
85
  export interface DbFindOpts<T = any> {
78
86
  reverse?: boolean;
79
- max?: number;
87
+ limit?: number;
80
88
  offset?: number;
81
89
  sortBy?: KeysMatching<T, any>;
82
90
  sortAsc?: boolean;
@@ -91,14 +99,14 @@ declare class CollectionManager<D = Data> {
91
99
  private collection;
92
100
  constructor(db: ValtheraCompatible, collection: string);
93
101
  add<T = Data>(data: Arg<T & D>, id_gen?: boolean): Promise<T>;
94
- find<T = Data>(search?: Search<T & D>, options?: DbFindOpts<T & Data>, findOpts?: FindOpts<T & Data>, context?: VContext): Promise<T[]>;
95
- findOne<T = Data>(search?: Search<T & Data>, findOpts?: FindOpts<T & Data>, context?: VContext): Promise<T>;
96
- update<T = Data>(search: Search<T & Data>, updater: Updater<T & Data>, context?: VContext): Promise<boolean>;
97
- updateOne<T = Data>(search: Search<T & Data>, updater: Updater<T & Data>, context?: VContext): Promise<boolean>;
98
- remove<T = Data>(search: Search<T & Data>, context?: VContext): Promise<boolean>;
99
- removeOne<T = Data>(search: Search<T & Data>, context?: VContext): Promise<boolean>;
100
- updateOneOrAdd<T = Data>(search: Search<T & Data>, updater: Updater<T & Data>, { add_arg, context, id_gen }: UpdateOneOrAdd<T & Data>): Promise<boolean>;
101
- toggleOne<T = Data>(search: Search<T & Data>, data?: Arg<T & Data>, context?: VContext): Promise<boolean>;
102
+ find<T = Data>(search?: Search<T & D>, options?: DbFindOpts<T & D>, findOpts?: FindOpts<T & D>, context?: VContext): Promise<T[]>;
103
+ findOne<T = Data>(search?: Search<T & D>, findOpts?: FindOpts<T & D>, context?: VContext): Promise<T>;
104
+ update<T = Data>(search: Search<T & D>, updater: Updater<T & D>, context?: VContext): Promise<boolean>;
105
+ updateOne<T = Data>(search: Search<T & D>, updater: Updater<T & D>, context?: VContext): Promise<boolean>;
106
+ remove<T = Data>(search: Search<T & D>, context?: VContext): Promise<boolean>;
107
+ removeOne<T = Data>(search: Search<T & D>, context?: VContext): Promise<boolean>;
108
+ updateOneOrAdd<T = Data>(search: Search<T & D>, updater: Updater<T & D>, { add_arg, context, id_gen }: UpdateOneOrAdd<T & D>): Promise<boolean>;
109
+ toggleOne<T = Data>(search: Search<T & D>, data?: Arg<T & D>, context?: VContext): Promise<boolean>;
102
110
  }
103
111
  export interface ValtheraCompatible {
104
112
  c(collection: string): CollectionManager;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wxn0brp/vql-client",
3
- "version": "0.2.6",
3
+ "version": "0.2.7",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "description": "VQL Client",