@ewb/mongoose-query 1.1.17 → 1.2.1
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.
- package/lib/Query.d.ts +0 -25
- package/lib/Query.js +3 -2
- package/lib/QueryError.d.ts +0 -25
- package/lib/QueryError.js +1 -2
- package/lib/QueryHistory.d.ts +3 -26
- package/lib/QueryHistory.js +5 -3
- package/lib/QueryModel.d.ts +26 -38
- package/lib/QueryModel.js +12 -8
- package/lib/QueryOptions.d.ts +3 -28
- package/lib/QueryOptions.js +2 -1
- package/lib/src/Query.d.ts +64 -0
- package/lib/src/Query.js +250 -0
- package/lib/src/QueryError.d.ts +16 -0
- package/lib/src/QueryError.js +52 -0
- package/lib/src/QueryHistory.d.ts +77 -0
- package/lib/src/QueryHistory.js +137 -0
- package/lib/src/QueryModel.d.ts +58 -0
- package/lib/src/QueryModel.js +250 -0
- package/lib/src/QueryOptions.d.ts +64 -0
- package/lib/src/QueryOptions.js +200 -0
- package/lib/src/index.d.ts +6 -0
- package/lib/src/index.js +6 -0
- package/lib/src/utils/Query.utils.d.ts +40 -0
- package/lib/src/utils/Query.utils.js +144 -0
- package/lib/src/utils/constants.d.ts +1 -0
- package/lib/src/utils/constants.js +1 -0
- package/lib/src/utils/index.d.ts +3 -0
- package/lib/src/utils/index.js +3 -0
- package/lib/src/utils/types.d.ts +23 -0
- package/lib/src/utils/types.js +1 -0
- package/lib/src/utils/utils.d.ts +8 -0
- package/lib/src/utils/utils.js +38 -0
- package/lib/utils/Query.utils.d.ts +4 -29
- package/lib/utils/types.d.ts +1 -26
- package/package.json +21 -29
package/lib/Query.d.ts
CHANGED
|
@@ -1,28 +1,3 @@
|
|
|
1
|
-
/// <reference types="mongoose/types/aggregate.js" />
|
|
2
|
-
/// <reference types="mongoose/types/callback.js" />
|
|
3
|
-
/// <reference types="mongoose/types/collection.js" />
|
|
4
|
-
/// <reference types="mongoose/types/connection.js" />
|
|
5
|
-
/// <reference types="mongoose/types/cursor.js" />
|
|
6
|
-
/// <reference types="mongoose/types/document.js" />
|
|
7
|
-
/// <reference types="mongoose/types/error.js" />
|
|
8
|
-
/// <reference types="mongoose/types/expressions.js" />
|
|
9
|
-
/// <reference types="mongoose/types/helpers.js" />
|
|
10
|
-
/// <reference types="mongoose/types/middlewares.js" />
|
|
11
|
-
/// <reference types="mongoose/types/indexes.js" />
|
|
12
|
-
/// <reference types="mongoose/types/models.js" />
|
|
13
|
-
/// <reference types="mongoose/types/mongooseoptions.js" />
|
|
14
|
-
/// <reference types="mongoose/types/pipelinestage.js" />
|
|
15
|
-
/// <reference types="mongoose/types/populate.js" />
|
|
16
|
-
/// <reference types="mongoose/types/query.js" />
|
|
17
|
-
/// <reference types="mongoose/types/schemaoptions.js" />
|
|
18
|
-
/// <reference types="mongoose/types/schematypes.js" />
|
|
19
|
-
/// <reference types="mongoose/types/session.js" />
|
|
20
|
-
/// <reference types="mongoose/types/types.js" />
|
|
21
|
-
/// <reference types="mongoose/types/utility.js" />
|
|
22
|
-
/// <reference types="mongoose/types/validation.js" />
|
|
23
|
-
/// <reference types="mongoose/types/virtuals.js" />
|
|
24
|
-
/// <reference types="mongoose/types/inferschematype.js" />
|
|
25
|
-
/// <reference types="mongoose/types/inferrawdoctype.js" />
|
|
26
1
|
import mongoose from 'mongoose';
|
|
27
2
|
import { IQueryPopulate } from './QueryOptions.js';
|
|
28
3
|
import { IMongooseQueryOptions, IQueryOptions, MongooseSortSelectValue, QueryType } from './utils/types.js';
|
package/lib/Query.js
CHANGED
|
@@ -178,8 +178,9 @@ export class Query {
|
|
|
178
178
|
if (Object.keys(_query).length > 0) {
|
|
179
179
|
const addQuery = query
|
|
180
180
|
? query.reduce((obj, key) => {
|
|
181
|
-
|
|
182
|
-
|
|
181
|
+
const name = String(key);
|
|
182
|
+
if (typeof _query[name] !== 'undefined') {
|
|
183
|
+
obj[name] = _query[name];
|
|
183
184
|
}
|
|
184
185
|
return obj;
|
|
185
186
|
}, {})
|
package/lib/QueryError.d.ts
CHANGED
|
@@ -1,28 +1,3 @@
|
|
|
1
|
-
/// <reference types="mongoose/types/aggregate" />
|
|
2
|
-
/// <reference types="mongoose/types/callback" />
|
|
3
|
-
/// <reference types="mongoose/types/collection" />
|
|
4
|
-
/// <reference types="mongoose/types/connection" />
|
|
5
|
-
/// <reference types="mongoose/types/cursor" />
|
|
6
|
-
/// <reference types="mongoose/types/document" />
|
|
7
|
-
/// <reference types="mongoose/types/error" />
|
|
8
|
-
/// <reference types="mongoose/types/expressions" />
|
|
9
|
-
/// <reference types="mongoose/types/helpers" />
|
|
10
|
-
/// <reference types="mongoose/types/middlewares" />
|
|
11
|
-
/// <reference types="mongoose/types/indexes" />
|
|
12
|
-
/// <reference types="mongoose/types/models" />
|
|
13
|
-
/// <reference types="mongoose/types/mongooseoptions" />
|
|
14
|
-
/// <reference types="mongoose/types/pipelinestage" />
|
|
15
|
-
/// <reference types="mongoose/types/populate" />
|
|
16
|
-
/// <reference types="mongoose/types/query" />
|
|
17
|
-
/// <reference types="mongoose/types/schemaoptions" />
|
|
18
|
-
/// <reference types="mongoose/types/schematypes" />
|
|
19
|
-
/// <reference types="mongoose/types/session" />
|
|
20
|
-
/// <reference types="mongoose/types/types" />
|
|
21
|
-
/// <reference types="mongoose/types/utility" />
|
|
22
|
-
/// <reference types="mongoose/types/validation" />
|
|
23
|
-
/// <reference types="mongoose/types/virtuals" />
|
|
24
|
-
/// <reference types="mongoose/types/inferschematype" />
|
|
25
|
-
/// <reference types="mongoose/types/inferrawdoctype" />
|
|
26
1
|
import mongoose from 'mongoose';
|
|
27
2
|
interface ErrorOpts {
|
|
28
3
|
message?: string;
|
package/lib/QueryError.js
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import mongoose from 'mongoose';
|
|
2
|
-
import mongodb from 'mongodb';
|
|
3
2
|
import httpStatus from 'http-status';
|
|
4
3
|
export class QueryError extends Error {
|
|
5
4
|
constructor(status, message, opts) {
|
|
@@ -17,7 +16,7 @@ export class QueryError extends Error {
|
|
|
17
16
|
return new QueryError(status, message, opts);
|
|
18
17
|
}
|
|
19
18
|
static getData(error) {
|
|
20
|
-
if (error instanceof
|
|
19
|
+
if (error instanceof mongoose.mongo.MongoServerError) {
|
|
21
20
|
if (error.code === 11000) {
|
|
22
21
|
return [
|
|
23
22
|
httpStatus.CONFLICT,
|
package/lib/QueryHistory.d.ts
CHANGED
|
@@ -1,28 +1,3 @@
|
|
|
1
|
-
/// <reference types="mongoose/types/aggregate" />
|
|
2
|
-
/// <reference types="mongoose/types/callback" />
|
|
3
|
-
/// <reference types="mongoose/types/collection" />
|
|
4
|
-
/// <reference types="mongoose/types/connection" />
|
|
5
|
-
/// <reference types="mongoose/types/cursor" />
|
|
6
|
-
/// <reference types="mongoose/types/document" />
|
|
7
|
-
/// <reference types="mongoose/types/error" />
|
|
8
|
-
/// <reference types="mongoose/types/expressions" />
|
|
9
|
-
/// <reference types="mongoose/types/helpers" />
|
|
10
|
-
/// <reference types="mongoose/types/middlewares" />
|
|
11
|
-
/// <reference types="mongoose/types/indexes" />
|
|
12
|
-
/// <reference types="mongoose/types/models" />
|
|
13
|
-
/// <reference types="mongoose/types/mongooseoptions" />
|
|
14
|
-
/// <reference types="mongoose/types/pipelinestage" />
|
|
15
|
-
/// <reference types="mongoose/types/populate" />
|
|
16
|
-
/// <reference types="mongoose/types/query" />
|
|
17
|
-
/// <reference types="mongoose/types/schemaoptions" />
|
|
18
|
-
/// <reference types="mongoose/types/schematypes" />
|
|
19
|
-
/// <reference types="mongoose/types/session" />
|
|
20
|
-
/// <reference types="mongoose/types/types" />
|
|
21
|
-
/// <reference types="mongoose/types/utility" />
|
|
22
|
-
/// <reference types="mongoose/types/validation" />
|
|
23
|
-
/// <reference types="mongoose/types/virtuals" />
|
|
24
|
-
/// <reference types="mongoose/types/inferschematype" />
|
|
25
|
-
/// <reference types="mongoose/types/inferrawdoctype" />
|
|
26
1
|
import mongoose from 'mongoose';
|
|
27
2
|
export interface IQueryHistorySchema {
|
|
28
3
|
_id: mongoose.Types.ObjectId;
|
|
@@ -89,7 +64,9 @@ export declare class QueryHistory<T extends IQueryHistorySchema & mongoose.Docum
|
|
|
89
64
|
setMeta(meta: object): void;
|
|
90
65
|
setUpdatedDoc(doc: T): void;
|
|
91
66
|
setDiff(_id: mongoose.Types.ObjectId, referenceDate?: Date): Promise<mongoose.UpdateWriteOpResult>;
|
|
92
|
-
revertHistory(_id: mongoose.Types.ObjectId, historyID: mongoose.Types.ObjectId): Promise<mongoose.IfAny<T, any, mongoose.Document<unknown, {}, T> & mongoose.Require_id<T
|
|
67
|
+
revertHistory(_id: mongoose.Types.ObjectId, historyID: mongoose.Types.ObjectId): Promise<mongoose.IfAny<T, any, mongoose.Document<unknown, {}, T, {}, mongoose.DefaultSchemaOptions> & mongoose.Require_id<T> & {
|
|
68
|
+
__v: number;
|
|
69
|
+
} & mongoose.AddDefaultId<T, {}, mongoose.DefaultSchemaOptions>>>;
|
|
93
70
|
getOld(): T;
|
|
94
71
|
getUpdated(): T;
|
|
95
72
|
findUpdated(): Promise<T>;
|
package/lib/QueryHistory.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import mongoose from 'mongoose';
|
|
2
|
-
import
|
|
3
|
-
const diffPatcher =
|
|
2
|
+
import { create } from 'jsondiffpatch';
|
|
3
|
+
const diffPatcher = create({
|
|
4
4
|
objectHash: (obj) => {
|
|
5
5
|
return '_id' in obj ? obj._id.toString() : obj.toString();
|
|
6
6
|
},
|
|
@@ -77,7 +77,9 @@ export class QueryHistory {
|
|
|
77
77
|
const model = this.getModel();
|
|
78
78
|
const [doc, historyDoc] = await Promise.all([
|
|
79
79
|
model.findOne({ _id }).select(this.ignoreToSelect()),
|
|
80
|
-
model
|
|
80
|
+
model
|
|
81
|
+
.findOne({ _id, 'history._id': historyID }, { 'history.$': 1 })
|
|
82
|
+
.lean(),
|
|
81
83
|
]);
|
|
82
84
|
if (!doc) {
|
|
83
85
|
throw new Error('Doc not found');
|
package/lib/QueryModel.d.ts
CHANGED
|
@@ -1,28 +1,3 @@
|
|
|
1
|
-
/// <reference types="mongoose/types/aggregate.js" />
|
|
2
|
-
/// <reference types="mongoose/types/callback.js" />
|
|
3
|
-
/// <reference types="mongoose/types/collection.js" />
|
|
4
|
-
/// <reference types="mongoose/types/connection.js" />
|
|
5
|
-
/// <reference types="mongoose/types/cursor.js" />
|
|
6
|
-
/// <reference types="mongoose/types/document.js" />
|
|
7
|
-
/// <reference types="mongoose/types/error.js" />
|
|
8
|
-
/// <reference types="mongoose/types/expressions.js" />
|
|
9
|
-
/// <reference types="mongoose/types/helpers.js" />
|
|
10
|
-
/// <reference types="mongoose/types/middlewares.js" />
|
|
11
|
-
/// <reference types="mongoose/types/indexes.js" />
|
|
12
|
-
/// <reference types="mongoose/types/models.js" />
|
|
13
|
-
/// <reference types="mongoose/types/mongooseoptions.js" />
|
|
14
|
-
/// <reference types="mongoose/types/pipelinestage.js" />
|
|
15
|
-
/// <reference types="mongoose/types/populate.js" />
|
|
16
|
-
/// <reference types="mongoose/types/query.js" />
|
|
17
|
-
/// <reference types="mongoose/types/schemaoptions.js" />
|
|
18
|
-
/// <reference types="mongoose/types/schematypes.js" />
|
|
19
|
-
/// <reference types="mongoose/types/session.js" />
|
|
20
|
-
/// <reference types="mongoose/types/types.js" />
|
|
21
|
-
/// <reference types="mongoose/types/utility.js" />
|
|
22
|
-
/// <reference types="mongoose/types/validation.js" />
|
|
23
|
-
/// <reference types="mongoose/types/virtuals.js" />
|
|
24
|
-
/// <reference types="mongoose/types/inferschematype.js" />
|
|
25
|
-
/// <reference types="mongoose/types/inferrawdoctype.js" />
|
|
26
1
|
import mongoose from 'mongoose';
|
|
27
2
|
import { Query } from './Query.js';
|
|
28
3
|
import { IQueryOptionsPopulate, QueryOptions } from './QueryOptions.js';
|
|
@@ -35,9 +10,18 @@ type SubDocItem<T extends object, K extends keyof T> = (T[K] extends [] ? T[K][0
|
|
|
35
10
|
export declare class QueryModel<T extends object> {
|
|
36
11
|
private _model;
|
|
37
12
|
private options;
|
|
38
|
-
constructor(_model: mongoose.Model<T
|
|
39
|
-
get model(): mongoose.Model<T
|
|
40
|
-
|
|
13
|
+
constructor(_model: mongoose.Model<NoInfer<T>>, options: QueryOptions<T>);
|
|
14
|
+
get model(): mongoose.Model<NoInfer<T>, {}, {}, {}, mongoose.IfAny<NoInfer<T>, any, mongoose.Document<unknown, {}, NoInfer<T>, {}, mongoose.DefaultSchemaOptions> & mongoose.Require_id<NoInfer<T>> & {
|
|
15
|
+
__v: number;
|
|
16
|
+
} & mongoose.AddDefaultId<NoInfer<T>, {}, mongoose.DefaultSchemaOptions>>, any, mongoose.Require_id<NoInfer<T>> extends infer T_1 ? T_1 extends mongoose.Require_id<NoInfer<T>> ? T_1 extends {
|
|
17
|
+
__v?: infer U;
|
|
18
|
+
} ? T_1 : T_1 & {
|
|
19
|
+
__v: number;
|
|
20
|
+
} : never : never>;
|
|
21
|
+
private get dynamicModel();
|
|
22
|
+
create<B extends Partial<T>>(body: B): Promise<mongoose.IfAny<NoInfer<T>, any, mongoose.Document<unknown, {}, NoInfer<T>, {}, mongoose.DefaultSchemaOptions> & mongoose.Require_id<NoInfer<T>> & {
|
|
23
|
+
__v: number;
|
|
24
|
+
} & mongoose.AddDefaultId<NoInfer<T>, {}, mongoose.DefaultSchemaOptions>>>;
|
|
41
25
|
json<D extends mongoose.Document>(doc: D): Promise<any>;
|
|
42
26
|
search(query: Query<T>): Promise<{
|
|
43
27
|
data: T[];
|
|
@@ -45,27 +29,31 @@ export declare class QueryModel<T extends object> {
|
|
|
45
29
|
limit: number;
|
|
46
30
|
skip: number;
|
|
47
31
|
}>;
|
|
48
|
-
findOne(query: Query<T>, opts?: QueryFindOpts): Promise<mongoose.Document<unknown, {}, T> & mongoose.Require_id<T
|
|
49
|
-
|
|
50
|
-
|
|
32
|
+
findOne(query: Query<T>, opts?: QueryFindOpts): Promise<mongoose.IfAny<NoInfer<T>, any, mongoose.Document<unknown, {}, NoInfer<T>, {}, mongoose.DefaultSchemaOptions> & mongoose.Require_id<NoInfer<T>> & {
|
|
33
|
+
__v: number;
|
|
34
|
+
} & mongoose.AddDefaultId<NoInfer<T>, {}, mongoose.DefaultSchemaOptions>>>;
|
|
35
|
+
findOneAndUpdate(query: Query<T>, filter: mongoose.QueryFilter<T>, update: mongoose.UpdateQuery<T>): Promise<mongoose.IfAny<NoInfer<T>, any, mongoose.Document<unknown, {}, NoInfer<T>, {}, mongoose.DefaultSchemaOptions> & mongoose.Require_id<NoInfer<T>> & {
|
|
36
|
+
__v: number;
|
|
37
|
+
} & mongoose.AddDefaultId<NoInfer<T>, {}, mongoose.DefaultSchemaOptions>>>;
|
|
38
|
+
deleteOne(filter: mongoose.QueryFilter<T>): Promise<mongoose.mongo.DeleteResult>;
|
|
51
39
|
populate(query: Query<T>, doc: T | T[any], type?: keyof IQueryOptionsPopulate<T, any>): Promise<void>;
|
|
52
40
|
getPopulates(type: keyof IQueryOptionsPopulate<T, any>): IQueryOptionsPopulate<T, keyof T>[];
|
|
53
|
-
updateMany(query: mongoose.
|
|
54
|
-
deleteMany(query: mongoose.
|
|
41
|
+
updateMany(query: mongoose.QueryFilter<T>, $in: mongoose.Types.ObjectId[], body: Partial<T>): Promise<mongoose.UpdateWriteOpResult>;
|
|
42
|
+
deleteMany(query: mongoose.QueryFilter<T>, $in: mongoose.Types.ObjectId[]): Promise<mongoose.mongo.DeleteResult>;
|
|
55
43
|
subCreate<K extends keyof T>(sub: K, query: Query<T>, body: any): Promise<(T[K] extends [] ? T[K][0] : null) | null>;
|
|
56
|
-
subSearch<K extends keyof T>(sub: K, query: Query<T>, rootQuery: mongoose.
|
|
44
|
+
subSearch<K extends keyof T>(sub: K, query: Query<T>, rootQuery: mongoose.QueryFilter<T>): Promise<{
|
|
57
45
|
count: number;
|
|
58
46
|
limit: number;
|
|
59
47
|
skip: number;
|
|
60
48
|
data: SubDocArray<T, K>;
|
|
61
49
|
}>;
|
|
62
|
-
subFindOne<K extends keyof T>(sub: K, query: Query<T>, subQuery: mongoose.
|
|
63
|
-
subFindOneAndUpdate<K extends keyof T>(sub: K, query: Query<T>, subQuery: mongoose.
|
|
64
|
-
subDelete<K extends keyof T>(sub: K, query: Query<T>, subQuery: mongoose.
|
|
50
|
+
subFindOne<K extends keyof T>(sub: K, query: Query<T>, subQuery: mongoose.QueryFilter<T[K]>): Promise<SubDocItem<T, K>>;
|
|
51
|
+
subFindOneAndUpdate<K extends keyof T>(sub: K, query: Query<T>, subQuery: mongoose.QueryFilter<T[K]>, body: T[K]): Promise<(T[K] extends [] ? T[K][0] : null) | null>;
|
|
52
|
+
subDelete<K extends keyof T>(sub: K, query: Query<T>, subQuery: mongoose.QueryFilter<T[K]>): Promise<(T[K] extends [] ? T[K][0] : null) | null>;
|
|
65
53
|
subPopulate<R extends Request, SD, K extends keyof T>(query: Query<T>, subDoc: SD, sub: K, type?: keyof IQueryOptionsPopulate<T, K>): Promise<void[]>;
|
|
66
54
|
getSubPopulate<K extends keyof T>(sub: K, type: keyof IQueryOptionsPopulate<T, K>): IQueryOptionsPopulate<T[keyof T], keyof T[keyof T]>[];
|
|
67
55
|
private getSubDocument;
|
|
68
|
-
toJSON(_: unknown, ret:
|
|
56
|
+
toJSON(_: unknown, ret: Record<string, any>): void;
|
|
69
57
|
private populateDoc;
|
|
70
58
|
}
|
|
71
59
|
export {};
|
package/lib/QueryModel.js
CHANGED
|
@@ -11,6 +11,9 @@ export class QueryModel {
|
|
|
11
11
|
get model() {
|
|
12
12
|
return this._model;
|
|
13
13
|
}
|
|
14
|
+
get dynamicModel() {
|
|
15
|
+
return this._model;
|
|
16
|
+
}
|
|
14
17
|
async create(body) {
|
|
15
18
|
const newDoc = new this._model(body);
|
|
16
19
|
await newDoc.validate();
|
|
@@ -92,7 +95,7 @@ export class QueryModel {
|
|
|
92
95
|
if (!('_id' in body)) {
|
|
93
96
|
body['_id'] = new mongoose.Types.ObjectId();
|
|
94
97
|
}
|
|
95
|
-
await this.
|
|
98
|
+
await this.dynamicModel.updateOne({ ...query.root }, { $push: { [sub]: body } });
|
|
96
99
|
return this.subFindOne(sub, query, { _id: body._id });
|
|
97
100
|
}
|
|
98
101
|
async subSearch(sub, query, rootQuery) {
|
|
@@ -158,7 +161,7 @@ export class QueryModel {
|
|
|
158
161
|
}, { count: 0, data: [], skip, limit });
|
|
159
162
|
}
|
|
160
163
|
async subFindOne(sub, query, subQuery) {
|
|
161
|
-
const subDoc = await this.
|
|
164
|
+
const subDoc = await this.dynamicModel.findOne({
|
|
162
165
|
...query.root,
|
|
163
166
|
[sub]: { $elemMatch: subQuery },
|
|
164
167
|
}, { [`${String(sub)}.$`]: 1 });
|
|
@@ -170,15 +173,15 @@ export class QueryModel {
|
|
|
170
173
|
$set[`${String(sub)}.$.${key}`] = body[key];
|
|
171
174
|
}
|
|
172
175
|
const filter = query.root;
|
|
173
|
-
filter[sub] = { $elemMatch: subQuery };
|
|
174
|
-
await this.
|
|
176
|
+
filter[String(sub)] = { $elemMatch: subQuery };
|
|
177
|
+
await this.dynamicModel.updateOne(filter, { $set });
|
|
175
178
|
return this.subFindOne(sub, query, subQuery);
|
|
176
179
|
}
|
|
177
180
|
async subDelete(sub, query, subQuery) {
|
|
178
181
|
const subDoc = await this.subFindOne(sub, query, subQuery);
|
|
179
182
|
if (!subDoc)
|
|
180
183
|
return null;
|
|
181
|
-
await this.
|
|
184
|
+
await this.dynamicModel.updateOne({
|
|
182
185
|
...query.root,
|
|
183
186
|
[sub]: { $elemMatch: subQuery },
|
|
184
187
|
}, { $pull: { [sub]: { _id: subDoc._id } } });
|
|
@@ -201,7 +204,7 @@ export class QueryModel {
|
|
|
201
204
|
getSubDocument(key, doc) {
|
|
202
205
|
if (!doc)
|
|
203
206
|
return null;
|
|
204
|
-
const array = doc[key];
|
|
207
|
+
const array = doc[String(key)];
|
|
205
208
|
if (array && Array.isArray(array)) {
|
|
206
209
|
return array[0] || null;
|
|
207
210
|
}
|
|
@@ -210,8 +213,9 @@ export class QueryModel {
|
|
|
210
213
|
toJSON(_, ret) {
|
|
211
214
|
if (this.options.privateFields) {
|
|
212
215
|
for (const key of this.options.privateFields) {
|
|
213
|
-
|
|
214
|
-
|
|
216
|
+
const name = String(key);
|
|
217
|
+
if (name in ret) {
|
|
218
|
+
delete ret[name];
|
|
215
219
|
}
|
|
216
220
|
}
|
|
217
221
|
}
|
package/lib/QueryOptions.d.ts
CHANGED
|
@@ -1,28 +1,3 @@
|
|
|
1
|
-
/// <reference types="mongoose/types/aggregate.js" />
|
|
2
|
-
/// <reference types="mongoose/types/callback.js" />
|
|
3
|
-
/// <reference types="mongoose/types/collection.js" />
|
|
4
|
-
/// <reference types="mongoose/types/connection.js" />
|
|
5
|
-
/// <reference types="mongoose/types/cursor.js" />
|
|
6
|
-
/// <reference types="mongoose/types/document.js" />
|
|
7
|
-
/// <reference types="mongoose/types/error.js" />
|
|
8
|
-
/// <reference types="mongoose/types/expressions.js" />
|
|
9
|
-
/// <reference types="mongoose/types/helpers.js" />
|
|
10
|
-
/// <reference types="mongoose/types/middlewares.js" />
|
|
11
|
-
/// <reference types="mongoose/types/indexes.js" />
|
|
12
|
-
/// <reference types="mongoose/types/models.js" />
|
|
13
|
-
/// <reference types="mongoose/types/mongooseoptions.js" />
|
|
14
|
-
/// <reference types="mongoose/types/pipelinestage.js" />
|
|
15
|
-
/// <reference types="mongoose/types/populate.js" />
|
|
16
|
-
/// <reference types="mongoose/types/query.js" />
|
|
17
|
-
/// <reference types="mongoose/types/schemaoptions.js" />
|
|
18
|
-
/// <reference types="mongoose/types/schematypes.js" />
|
|
19
|
-
/// <reference types="mongoose/types/session.js" />
|
|
20
|
-
/// <reference types="mongoose/types/types.js" />
|
|
21
|
-
/// <reference types="mongoose/types/utility.js" />
|
|
22
|
-
/// <reference types="mongoose/types/validation.js" />
|
|
23
|
-
/// <reference types="mongoose/types/virtuals.js" />
|
|
24
|
-
/// <reference types="mongoose/types/inferschematype.js" />
|
|
25
|
-
/// <reference types="mongoose/types/inferrawdoctype.js" />
|
|
26
1
|
import mongoose from 'mongoose';
|
|
27
2
|
import { Query } from './Query.js';
|
|
28
3
|
export interface IQueryOptionsPopulate<T extends any, K extends keyof T> {
|
|
@@ -60,7 +35,7 @@ export interface IQueryPopulate {
|
|
|
60
35
|
type IModelQuery = mongoose.QueryWithHelpers<unknown, unknown>;
|
|
61
36
|
export declare const toValidSelectRegexp: (select: string | number | symbol) => RegExp;
|
|
62
37
|
export declare const toValidSortRegexp: (sort: string | number | symbol) => RegExp;
|
|
63
|
-
export declare const toValidTextRegexp: (str: string) =>
|
|
38
|
+
export declare const toValidTextRegexp: (str: string) => "" | RegExp;
|
|
64
39
|
export declare class QueryOptions<T extends object> {
|
|
65
40
|
private opts;
|
|
66
41
|
constructor(opts?: IQueryOptions<T>);
|
|
@@ -69,7 +44,7 @@ export declare class QueryOptions<T extends object> {
|
|
|
69
44
|
get subs(): IQuerySearchOptionsSub<T, keyof T>[];
|
|
70
45
|
get updateDateKey(): keyof T;
|
|
71
46
|
get query(): (keyof T)[];
|
|
72
|
-
createSearchQuery(query: Query<any, T>): mongoose.
|
|
47
|
+
createSearchQuery(query: Query<any, T>): mongoose.QueryFilter<T>;
|
|
73
48
|
setPopulate(modelQuery: IModelQuery, query: Query<T>): void;
|
|
74
49
|
getValidPopulate(queryPopulate: IQueryPopulate[], sub?: keyof T): IQueryOptionsPopulate<any, any>[];
|
|
75
50
|
setLimitAndSkip(modelQuery: IModelQuery, query: Query<T>): void;
|
|
@@ -77,7 +52,7 @@ export declare class QueryOptions<T extends object> {
|
|
|
77
52
|
setSort(modelQuery: IModelQuery, query: Query<T>): void;
|
|
78
53
|
setProjection(modelQuery: IModelQuery, query: Query<T>): void;
|
|
79
54
|
getSubPopulateLookup<K extends keyof T>(query: Query<T>, subOptions: IQuerySearchOptionsSub<T, keyof T>): any[];
|
|
80
|
-
getSubFilterConditionAndMatch(subQuery: mongoose.
|
|
55
|
+
getSubFilterConditionAndMatch(subQuery: mongoose.QueryFilter<T>, options: IQuerySearchOptionsSub<T, keyof T>): {
|
|
81
56
|
$filter: {
|
|
82
57
|
input: string;
|
|
83
58
|
as: string;
|
package/lib/QueryOptions.js
CHANGED
|
@@ -176,8 +176,9 @@ function queryToSubFilter(key, value) {
|
|
|
176
176
|
function toCorrectIdValue(v) {
|
|
177
177
|
if (!v)
|
|
178
178
|
return v;
|
|
179
|
-
if (mongoose.isValidObjectId(v))
|
|
179
|
+
if (typeof v === 'string' && mongoose.isValidObjectId(v)) {
|
|
180
180
|
return new mongoose.Types.ObjectId(v);
|
|
181
|
+
}
|
|
181
182
|
return v;
|
|
182
183
|
}
|
|
183
184
|
function sortArrayToSortObject(arr, hasText) {
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import mongoose from 'mongoose';
|
|
2
|
+
import { IQueryPopulate } from './QueryOptions.js';
|
|
3
|
+
import { IMongooseQueryOptions, IQueryOptions, MongooseSortSelectValue, QueryType } from './utils/types.js';
|
|
4
|
+
export declare class Query<R extends object, T extends object = object, Q extends IMongooseQueryOptions = IMongooseQueryOptions> {
|
|
5
|
+
private _root;
|
|
6
|
+
private _rootNext;
|
|
7
|
+
private _rootPopulate;
|
|
8
|
+
private _or;
|
|
9
|
+
private _model;
|
|
10
|
+
private _addToModelQuery;
|
|
11
|
+
private _export;
|
|
12
|
+
private _projection;
|
|
13
|
+
readonly page: number | undefined;
|
|
14
|
+
private _skip;
|
|
15
|
+
private _limit;
|
|
16
|
+
readonly sort: MongooseSortSelectValue<T>[];
|
|
17
|
+
private _select;
|
|
18
|
+
private _query;
|
|
19
|
+
private textQuery;
|
|
20
|
+
private documentQuery;
|
|
21
|
+
readonly hasTextSearch: boolean;
|
|
22
|
+
readonly options: IQueryOptions;
|
|
23
|
+
readonly populate: IQueryPopulate[];
|
|
24
|
+
constructor(queries: Q);
|
|
25
|
+
get skip(): number;
|
|
26
|
+
get limit(): number;
|
|
27
|
+
get root(): QueryType<T> | null;
|
|
28
|
+
get model(): keyof R;
|
|
29
|
+
set model(value: keyof R);
|
|
30
|
+
get rootPopulate(): mongoose.PopulateOptions[];
|
|
31
|
+
get select(): MongooseSortSelectValue<T>[];
|
|
32
|
+
get or(): mongoose.FilterQuery<T_1>[];
|
|
33
|
+
get query(): Q;
|
|
34
|
+
get export(): boolean;
|
|
35
|
+
set export(value: boolean);
|
|
36
|
+
get projection(): object | undefined;
|
|
37
|
+
set projection(value: object | undefined);
|
|
38
|
+
setSkipAndLimit(skip: number | undefined, limit: number | undefined): void;
|
|
39
|
+
setQuery<K extends keyof QueryType<T>>(key: K, value: QueryType<T>[K]): void;
|
|
40
|
+
addOr(query: QueryType<T>): void;
|
|
41
|
+
defaultSelect(select: MongooseSortSelectValue<T>[]): void;
|
|
42
|
+
addPopulate(populate: mongoose.PopulateOptions | mongoose.PopulateOptions[]): void;
|
|
43
|
+
addRoot(query: QueryType<T>): any;
|
|
44
|
+
removeRoot(key: string): any;
|
|
45
|
+
addRootNext(query: QueryType<T>): any;
|
|
46
|
+
removeQuery(key: keyof QueryType<T>): void;
|
|
47
|
+
deleteKeysFromQuery(key: keyof QueryType<T>): void;
|
|
48
|
+
deleteKeysFromRoot(keys: (keyof QueryType<T>)[]): void;
|
|
49
|
+
getModelQuery<TT extends object>(key: string): QueryType<TT>;
|
|
50
|
+
addToModelQuery<TT extends {
|
|
51
|
+
[key: string]: object;
|
|
52
|
+
}, K extends keyof TT = keyof TT>(model: K | K[], query: QueryType<TT[K]>): this;
|
|
53
|
+
removeFromModelQuery(model: string, key: string): this;
|
|
54
|
+
createQuery({ query, noRoot, }?: ICreateQueryOptions<R, T>): QueryType<T>;
|
|
55
|
+
private initQuery;
|
|
56
|
+
private mongooseTextSearch;
|
|
57
|
+
private mongooseQueryWithOperations;
|
|
58
|
+
private sanitizedQuery;
|
|
59
|
+
}
|
|
60
|
+
interface ICreateQueryOptions<R, T extends object> {
|
|
61
|
+
query?: (keyof T)[];
|
|
62
|
+
noRoot?: boolean;
|
|
63
|
+
}
|
|
64
|
+
export {};
|