@ewb/mongoose-query 1.0.0

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 (60) hide show
  1. package/README.md +70 -0
  2. package/lib/ExpressHandler.d.ts +30 -0
  3. package/lib/ExpressHandler.js +215 -0
  4. package/lib/ExpressHandler.js.map +1 -0
  5. package/lib/ModelQuery.d.ts +24 -0
  6. package/lib/ModelQuery.js +80 -0
  7. package/lib/ModelQuery.js.map +1 -0
  8. package/lib/Query.d.ts +77 -0
  9. package/lib/Query.js +307 -0
  10. package/lib/Query.js.map +1 -0
  11. package/lib/QueryError.d.ts +50 -0
  12. package/lib/QueryError.js +62 -0
  13. package/lib/QueryError.js.map +1 -0
  14. package/lib/QueryExpressHandler.d.ts +50 -0
  15. package/lib/QueryExpressHandler.js +383 -0
  16. package/lib/QueryExpressHandler.js.map +1 -0
  17. package/lib/QueryExpressSubHandler.d.ts +20 -0
  18. package/lib/QueryExpressSubHandler.js +137 -0
  19. package/lib/QueryExpressSubHandler.js.map +1 -0
  20. package/lib/QueryHandler.d.ts +59 -0
  21. package/lib/QueryHandler.js +297 -0
  22. package/lib/QueryHandler.js.map +1 -0
  23. package/lib/QueryHistory.d.ts +76 -0
  24. package/lib/QueryHistory.js +154 -0
  25. package/lib/QueryHistory.js.map +1 -0
  26. package/lib/QueryModel.d.ts +80 -0
  27. package/lib/QueryModel.js +201 -0
  28. package/lib/QueryModel.js.map +1 -0
  29. package/lib/constants.d.ts +2 -0
  30. package/lib/constants.js +6 -0
  31. package/lib/constants.js.map +1 -0
  32. package/lib/declarations.d.ts +16 -0
  33. package/lib/declarations.js +3 -0
  34. package/lib/declarations.js.map +1 -0
  35. package/lib/error/ExpressError.d.ts +44 -0
  36. package/lib/error/ExpressError.js +39 -0
  37. package/lib/error/ExpressError.js.map +1 -0
  38. package/lib/error/QueryError.d.ts +47 -0
  39. package/lib/error/QueryError.js +50 -0
  40. package/lib/error/QueryError.js.map +1 -0
  41. package/lib/error/QueryExpressError.d.ts +46 -0
  42. package/lib/error/QueryExpressError.js +39 -0
  43. package/lib/error/QueryExpressError.js.map +1 -0
  44. package/lib/error/V1Error.d.ts +12 -0
  45. package/lib/error/V1Error.js +27 -0
  46. package/lib/error/V1Error.js.map +1 -0
  47. package/lib/error/error.handler.d.ts +3 -0
  48. package/lib/error/error.handler.js +30 -0
  49. package/lib/error/error.handler.js.map +1 -0
  50. package/lib/index.d.ts +10 -0
  51. package/lib/index.js +32 -0
  52. package/lib/index.js.map +1 -0
  53. package/lib/statics.d.ts +17 -0
  54. package/lib/statics.js +35 -0
  55. package/lib/statics.js.map +1 -0
  56. package/lib/tsconfig.tsbuildinfo +1 -0
  57. package/lib/utils.d.ts +3 -0
  58. package/lib/utils.js +44 -0
  59. package/lib/utils.js.map +1 -0
  60. package/package.json +61 -0
package/README.md ADDED
@@ -0,0 +1,70 @@
1
+ ## Mongoose Query helper
2
+
3
+ ### Info
4
+ Library to create middlewares for server to parse queries from users to valid mongoose queries.
5
+
6
+ ```
7
+ function queryMiddleware(req, next) {
8
+ req.mongooseQuery = new Query(req.params, req.query);
9
+ next();
10
+ }
11
+
12
+ const modelQuery = new ModelQuery<Doc>({
13
+ limit: 10,
14
+ query: ['name', 'slug'], // Valid queries for model. Filters all other fields
15
+ select: ['_id', 'name', 'slug'], // Valid select fields for search,
16
+ sort: ['_id', 'name'], // Valid sort fields. Not defined = all
17
+ populate: [{
18
+ path: 'organization', // Valid path to populate
19
+ select: ['_id', 'name', 'slug'] // Valid fields to select from populated
20
+ }]
21
+ });
22
+
23
+ function modelStaticSearch<T>(this: Model<T>, query: Query<T>) {
24
+ return modelQuerySearchPaginate(modelQuery, query).bind(this);
25
+ }
26
+
27
+ const model = mongoose.model('Name', Schema);
28
+ model.statics.search(modelStaticSearch);
29
+
30
+ function someController(req, res) {
31
+ // add organization ID to root query so query will always search inside organization
32
+ req.mongooseQuery.addParamToRoot('organization');
33
+ res.json(await Model.search(req.mongooseQuery));
34
+ }
35
+
36
+ ```
37
+
38
+ ### Queries
39
+
40
+ #### Text
41
+ ``?text=some%20text``
42
+
43
+ #### Sort
44
+ ``?sort=name,-_order``
45
+
46
+ #### Populate
47
+ ``?populate=organization:_id,name;user:_id,name``
48
+
49
+ #### Select
50
+ ``?select=_id,name``
51
+
52
+ #### Mongoose Ids
53
+ ``?_id=60ec0aa707bda11b64ecbf6b,60ec0aa707bda11b64ecbf6c``
54
+
55
+ #### Skip
56
+ ``?skip=10``
57
+
58
+ #### Limit
59
+ ``?limit=20``
60
+
61
+ #### Returns
62
+
63
+ ```
64
+ {
65
+ data: [Doc, Doc];
66
+ skip: 10;
67
+ limit: 2;
68
+ count: 20;
69
+ }
70
+ ```
@@ -0,0 +1,30 @@
1
+ import { Request, Response, NextFunction } from 'express';
2
+ import { Document, Types } from 'mongoose';
3
+ import { QueryHandler } from './QueryHandler';
4
+ import { Query } from './Query';
5
+ export interface IExpressRequest extends Request {
6
+ mongoosePostBody: {
7
+ [key: string]: string | Types.ObjectId;
8
+ };
9
+ mongooseQuery: Query;
10
+ }
11
+ export default class ExpressHandler<R extends IExpressRequest, T extends Document> {
12
+ private param;
13
+ private handler;
14
+ constructor(param: keyof R, handler: QueryHandler<T>);
15
+ post(req: R, res: Response, next: NextFunction): Promise<void>;
16
+ findOne(req: R, _res: Response, next: NextFunction): Promise<void>;
17
+ search(req: R, res: Response, next: NextFunction): Promise<Response<any, Record<string, any>> | undefined>;
18
+ patch(req: R, _res: Response, next: NextFunction): Promise<void>;
19
+ archive(req: R, _res: Response, next: NextFunction): Promise<void>;
20
+ delete(req: R, _res: Response, next: NextFunction): Promise<void>;
21
+ json(req: R, res: Response, next: NextFunction): void;
22
+ subRoute(req: R, _res: Response, next: NextFunction): void;
23
+ addToQuery(req: R, _res: Response, next: NextFunction): void;
24
+ addToPost(req: R, _res: Response, next: NextFunction): void;
25
+ private getDoc;
26
+ private validateBody;
27
+ private getFindOpts;
28
+ private getParam;
29
+ private validateReq;
30
+ }
@@ -0,0 +1,215 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ const mongoose_1 = require("mongoose");
13
+ class ExpressHandler {
14
+ constructor(param, handler) {
15
+ this.param = param;
16
+ this.handler = handler;
17
+ this.post = this.post.bind(this);
18
+ this.findOne = this.findOne.bind(this);
19
+ this.search = this.search.bind(this);
20
+ this.patch = this.patch.bind(this);
21
+ this.archive = this.archive.bind(this);
22
+ this.delete = this.delete.bind(this);
23
+ this.json = this.json.bind(this);
24
+ this.subRoute = this.subRoute.bind(this);
25
+ this.addToQuery = this.addToQuery.bind(this);
26
+ this.addToPost = this.addToPost.bind(this);
27
+ this.getDoc = this.getDoc.bind(this);
28
+ }
29
+ post(req, res, next) {
30
+ return __awaiter(this, void 0, void 0, function* () {
31
+ try {
32
+ this.validateBody(req);
33
+ if (req.mongoosePostBody) {
34
+ for (const key in req.mongoosePostBody) {
35
+ req.body[key] = req.mongoosePostBody[key];
36
+ }
37
+ }
38
+ req[this.param] = (yield this.handler.create(req.body));
39
+ res.status(201);
40
+ next();
41
+ }
42
+ catch (e) {
43
+ next(e);
44
+ }
45
+ });
46
+ }
47
+ findOne(req, _res, next) {
48
+ return __awaiter(this, void 0, void 0, function* () {
49
+ try {
50
+ const param = this.getParam(req);
51
+ const query = param.match(/^[0-9a-fA-F]{24}$/) && mongoose_1.Types.ObjectId.isValid(param)
52
+ ? { _id: mongoose_1.Types.ObjectId(param) }
53
+ : { slug: param };
54
+ req.mongooseQuery.addRoot(query);
55
+ req[this.param] = (yield this.handler.findOne(req.mongooseQuery, this.getFindOpts(req)));
56
+ req.mongooseQuery.deleteKeysFromRoot(Object.keys(query));
57
+ this.validateReq(req);
58
+ next();
59
+ }
60
+ catch (e) {
61
+ next(e);
62
+ }
63
+ });
64
+ }
65
+ search(req, res, next) {
66
+ return __awaiter(this, void 0, void 0, function* () {
67
+ try {
68
+ if ('searchV2' in this.handler.model) {
69
+ req.mongooseQuery.removeQuery('as');
70
+ // @ts-ignore
71
+ const data = yield this.handler.model.searchV2(req.mongooseQuery);
72
+ if (req.query.as === 'array') {
73
+ return res.json(data.data);
74
+ }
75
+ return res.json(data);
76
+ }
77
+ next(new Error(JSON.stringify({
78
+ status: 501,
79
+ message: 'Missing searchV2 function i model'
80
+ })));
81
+ }
82
+ catch (e) {
83
+ next(e);
84
+ }
85
+ });
86
+ }
87
+ patch(req, _res, next) {
88
+ return __awaiter(this, void 0, void 0, function* () {
89
+ try {
90
+ this.validateReq(req);
91
+ this.validateBody(req);
92
+ const query = req.mongooseQuery;
93
+ req[this.param] = (yield this.handler.findOneAndUpdate(query, { _id: this.getDoc(req)._id }, req.body));
94
+ next();
95
+ }
96
+ catch (e) {
97
+ next(e);
98
+ }
99
+ });
100
+ }
101
+ archive(req, _res, next) {
102
+ return __awaiter(this, void 0, void 0, function* () {
103
+ try {
104
+ this.validateReq(req);
105
+ req[this.param] = (yield this.handler.findOneAndUpdate(req.mongooseQuery, { _id: this.getDoc(req)._id }, { archived: true }));
106
+ next();
107
+ }
108
+ catch (e) {
109
+ next(e);
110
+ }
111
+ });
112
+ }
113
+ delete(req, _res, next) {
114
+ return __awaiter(this, void 0, void 0, function* () {
115
+ try {
116
+ this.validateReq(req);
117
+ yield this.handler.deleteOne({ _id: this.getDoc(req)._id });
118
+ next();
119
+ }
120
+ catch (e) {
121
+ next(e);
122
+ }
123
+ });
124
+ }
125
+ json(req, res, next) {
126
+ try {
127
+ this.validateReq(req);
128
+ // @ts-ignore
129
+ const ret = req[this.param].toJSON({ transform: this.handler.toJSON });
130
+ res.json(ret);
131
+ }
132
+ catch (e) {
133
+ next(e);
134
+ }
135
+ }
136
+ subRoute(req, _res, next) {
137
+ try {
138
+ this.validateReq(req);
139
+ if (!req.mongoosePostBody) {
140
+ req.mongoosePostBody = {};
141
+ }
142
+ req.mongoosePostBody[this.param] = this.getDoc(req)._id;
143
+ req.mongooseQuery.addRoot({ [this.param]: this.getDoc(req)._id });
144
+ next();
145
+ }
146
+ catch (e) {
147
+ next(e);
148
+ }
149
+ }
150
+ addToQuery(req, _res, next) {
151
+ try {
152
+ req.mongooseQuery.addRoot({ [this.param]: this.getDoc(req)._id });
153
+ next();
154
+ }
155
+ catch (e) {
156
+ next(e);
157
+ }
158
+ }
159
+ addToPost(req, _res, next) {
160
+ try {
161
+ this.validateReq(req);
162
+ if (!req.mongoosePostBody) {
163
+ req.mongoosePostBody = {};
164
+ }
165
+ req.mongoosePostBody[this.param] = this.getDoc(req)._id;
166
+ next();
167
+ }
168
+ catch (e) {
169
+ next(e);
170
+ }
171
+ }
172
+ getDoc(req) {
173
+ return req[this.param];
174
+ }
175
+ validateBody(req) {
176
+ const invalidFields = this.handler.validateBody(req.body);
177
+ if (invalidFields) {
178
+ throw new Error(JSON.stringify({
179
+ status: 400,
180
+ title: 'Invalid body',
181
+ detail: 'Body contained invalid keys, remove keys located in source.body to post or patch',
182
+ source: {
183
+ body: invalidFields.join(', ')
184
+ }
185
+ }));
186
+ }
187
+ }
188
+ getFindOpts(_req) {
189
+ return {
190
+ select: false,
191
+ populate: false
192
+ };
193
+ }
194
+ getParam(req) {
195
+ if (!req.params[this.param]) {
196
+ throw new Error(JSON.stringify({
197
+ status: 500,
198
+ message: `Param ${this.param} not found`,
199
+ source: { parameter: this.param },
200
+ }));
201
+ }
202
+ return req.params[this.param];
203
+ }
204
+ validateReq(req) {
205
+ if (!req[this.param]) {
206
+ throw new Error(JSON.stringify({
207
+ status: 404,
208
+ message: `${this.param} not found`,
209
+ source: { parameter: this.param },
210
+ }));
211
+ }
212
+ }
213
+ }
214
+ exports.default = ExpressHandler;
215
+ //# sourceMappingURL=ExpressHandler.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ExpressHandler.js","sourceRoot":"","sources":["../src/ExpressHandler.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,uCAA2C;AAS3C,MAAqB,cAAc;IAIjC,YAAoB,KAAc,EAAU,OAAwB;QAAhD,UAAK,GAAL,KAAK,CAAS;QAAU,YAAO,GAAP,OAAO,CAAiB;QAClE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IAEY,IAAI,CAAC,GAAM,EAAE,GAAa,EAAE,IAAkB;;YACzD,IAAI;gBACF,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;gBACvB,IAAI,GAAG,CAAC,gBAAgB,EAAE;oBACxB,KAAK,MAAM,GAAG,IAAI,GAAG,CAAC,gBAAgB,EAAE;wBACtC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;qBAC3C;iBACF;gBACD,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAQ,CAAC;gBAC/D,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBAChB,IAAI,EAAE,CAAC;aACR;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI,CAAC,CAAC,CAAC,CAAC;aACT;QACH,CAAC;KAAA;IAEY,OAAO,CAAC,GAAM,EAAE,IAAc,EAAE,IAAkB;;YAC7D,IAAI;gBACF,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBACjC,MAAM,KAAK,GACT,KAAK,CAAC,KAAK,CAAC,mBAAmB,CAAC,IAAI,gBAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC;oBAC/D,CAAC,CAAC,EAAE,GAAG,EAAE,gBAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;oBAChC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;gBACtB,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBACjC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAC3C,GAAG,CAAC,aAAyB,EAC7B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CACtB,CAAQ,CAAC;gBACV,GAAG,CAAC,aAAa,CAAC,kBAAkB,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;gBACzD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBAEtB,IAAI,EAAE,CAAC;aACR;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI,CAAC,CAAC,CAAC,CAAC;aACT;QACH,CAAC;KAAA;IAEY,MAAM,CAAC,GAAM,EAAE,GAAa,EAAE,IAAkB;;YAC3D,IAAI;gBACF,IAAI,UAAU,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;oBACpC,GAAG,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;oBACpC,aAAa;oBACb,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;oBAClE,IAAI,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,OAAO,EAAE;wBAC5B,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;qBAC5B;oBACD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACvB;gBACD,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC;oBAC5B,MAAM,EAAE,GAAG;oBACX,OAAO,EAAE,mCAAmC;iBAC7C,CAAC,CAAC,CAAC,CAAC;aACN;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI,CAAC,CAAC,CAAC,CAAC;aACT;QACH,CAAC;KAAA;IAEY,KAAK,CAAC,GAAM,EAAE,IAAc,EAAE,IAAkB;;YAC3D,IAAI;gBACF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBACtB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;gBACvB,MAAM,KAAK,GAAG,GAAG,CAAC,aAAyB,CAAC;gBAC5C,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CACpD,KAAK,EACL,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAC7B,GAAG,CAAC,IAAI,CACT,CAAQ,CAAC;gBAEV,IAAI,EAAE,CAAC;aACR;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI,CAAC,CAAC,CAAC,CAAC;aACT;QACH,CAAC;KAAA;IAEY,OAAO,CAAC,GAAM,EAAE,IAAc,EAAE,IAAkB;;YAC7D,IAAI;gBACF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBACtB,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CACpD,GAAG,CAAC,aAAyB,EAC7B,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAC7B,EAAE,QAAQ,EAAE,IAAI,EAAS,CAC1B,CAAQ,CAAC;gBAEV,IAAI,EAAE,CAAC;aACR;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI,CAAC,CAAC,CAAC,CAAC;aACT;QACH,CAAC;KAAA;IAEY,MAAM,CAAC,GAAM,EAAE,IAAc,EAAE,IAAkB;;YAC5D,IAAI;gBACF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBACtB,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;gBAE5D,IAAI,EAAE,CAAC;aACR;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI,CAAC,CAAC,CAAC,CAAC;aACT;QACH,CAAC;KAAA;IAEM,IAAI,CAAC,GAAM,EAAE,GAAa,EAAE,IAAkB;QACnD,IAAI;YACF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACtB,aAAa;YACb,MAAM,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YAEvE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACf;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,CAAC,CAAC,CAAC;SACT;IACH,CAAC;IAEM,QAAQ,CAAC,GAAM,EAAE,IAAc,EAAE,IAAkB;QACxD,IAAI;YACF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACtB,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE;gBACzB,GAAG,CAAC,gBAAgB,GAAG,EAAE,CAAC;aAC3B;YACD,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAe,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC;YAClE,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;YAClE,IAAI,EAAE,CAAC;SACR;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,CAAC,CAAC,CAAC;SACT;IACH,CAAC;IAEM,UAAU,CAAC,GAAM,EAAE,IAAc,EAAE,IAAkB;QAC1D,IAAI;YACF,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;YAClE,IAAI,EAAE,CAAC;SACR;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,CAAC,CAAC,CAAC;SACT;IACH,CAAC;IAEM,SAAS,CAAC,GAAM,EAAE,IAAc,EAAE,IAAkB;QACzD,IAAI;YACF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACtB,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE;gBACzB,GAAG,CAAC,gBAAgB,GAAG,EAAE,CAAC;aAC3B;YACD,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAe,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC;YAClE,IAAI,EAAE,CAAC;SACR;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,CAAC,CAAC,CAAC;SACT;IACH,CAAC;IAEO,MAAM,CAAC,GAAM;QACnB,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,CAAiB,CAAC;IACzC,CAAC;IAEO,YAAY,CAAC,GAAM;QACzB,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1D,IAAI,aAAa,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC;gBAC7B,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE,cAAc;gBACrB,MAAM,EAAE,kFAAkF;gBAC1F,MAAM,EAAE;oBACN,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC;iBAC/B;aACF,CAAC,CAAC,CAAC;SACL;IACH,CAAC;IAEO,WAAW,CAAC,IAAO;QACzB,OAAO;YACL,MAAM,EAAE,KAAK;YACb,QAAQ,EAAE,KAAK;SAChB,CAAC;IACJ,CAAC;IAEO,QAAQ,CAAC,GAAM;QACrB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAe,CAAC,EAAE;YACrC,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC;gBAC7B,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,SAAS,IAAI,CAAC,KAAK,YAAY;gBACxC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,EAAE;aAClC,CAAC,CAAC,CAAA;SACJ;QACD,OAAO,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAe,CAAC,CAAC;IAC1C,CAAC;IAEO,WAAW,CAAC,GAAM;QACxB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC;gBAC7B,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,GAAG,IAAI,CAAC,KAAK,YAAY;gBAClC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,EAAE;aAClC,CAAC,CAAC,CAAA;SACJ;IACH,CAAC;CACF;AAnND,iCAmNC"}
@@ -0,0 +1,24 @@
1
+ import { Document, FilterQuery, QueryWithHelpers } from 'mongoose';
2
+ import { Query } from './Query';
3
+ interface ModelSearchPopulate<T, K extends keyof T> {
4
+ path: K;
5
+ select: (T[K] extends object ? keyof T[K] : string)[];
6
+ }
7
+ interface ModelSearchOpts<T extends object> {
8
+ query?: (keyof T)[];
9
+ select?: (keyof T)[];
10
+ sort?: (keyof T)[];
11
+ populate?: ModelSearchPopulate<T, keyof T>[];
12
+ limit?: number;
13
+ }
14
+ declare type IModelQuery = QueryWithHelpers<unknown, unknown>;
15
+ export declare class ModelQuery<T extends Document> {
16
+ private opts;
17
+ constructor(opts?: ModelSearchOpts<T>);
18
+ createQuery(query: Query<T>): FilterQuery<T>;
19
+ setPopulate(modelQuery: IModelQuery, query: Query<T>): void;
20
+ setLimitAndSkip(modelQuery: IModelQuery, query: Query<T>): void;
21
+ setSelect(modelQuery: IModelQuery, query: Query<T>, overrideValid?: (keyof T)[]): void;
22
+ setSort(modelQuery: IModelQuery, query: Query<T>): void;
23
+ }
24
+ export {};
@@ -0,0 +1,80 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ModelQuery = void 0;
4
+ const constants_1 = require("./constants");
5
+ class ModelQuery {
6
+ constructor(opts = {}) {
7
+ this.opts = opts;
8
+ }
9
+ createQuery(query) {
10
+ return query.createQuery();
11
+ }
12
+ setPopulate(modelQuery, query) {
13
+ let populate = [];
14
+ if (query.populate.length > 0) {
15
+ populate = query.populate.map(pop => {
16
+ var _a, _b;
17
+ const found = (_a = this.opts.populate) === null || _a === void 0 ? void 0 : _a.find(x => x.path === pop.path);
18
+ if (!found)
19
+ return null;
20
+ const select = ((_b = pop.select) === null || _b === void 0 ? void 0 : _b.filter(x => found.select.includes(x))) || [];
21
+ return {
22
+ path: pop.path,
23
+ select: (select.length > 0 ? select : found.select).join(' ')
24
+ };
25
+ }).filter(Boolean);
26
+ }
27
+ if (query.rootPopulate.length > 0) {
28
+ populate.push(...query.rootPopulate);
29
+ }
30
+ if (populate.length > 0) {
31
+ modelQuery.populate(populate);
32
+ }
33
+ }
34
+ setLimitAndSkip(modelQuery, query) {
35
+ var _a, _b, _c;
36
+ modelQuery.skip((_a = query.skip) !== null && _a !== void 0 ? _a : 0);
37
+ modelQuery.limit((_c = (_b = query.limit) !== null && _b !== void 0 ? _b : this.opts.limit) !== null && _c !== void 0 ? _c : constants_1.DEFAULT_LIMIT);
38
+ }
39
+ setSelect(modelQuery, query, overrideValid) {
40
+ const valids = overrideValid || this.opts.select;
41
+ let selects = valids || [];
42
+ if (valids && query.select.length > 0) {
43
+ selects = query.select.filter(select => valids.some(valid => String(select).match(new RegExp(`^${valid}(\..|$)`))));
44
+ }
45
+ if (selects.length > 0) {
46
+ modelQuery.select(selects.join(' '));
47
+ }
48
+ }
49
+ setSort(modelQuery, query) {
50
+ if (query.sort.length > 0) {
51
+ if (this.opts.sort) {
52
+ const validSorts = query.sort.filter(x => this.opts.sort.some(y => x.match(new RegExp(`^(\\+|-)?(${y}|text)$`))));
53
+ modelQuery.sort(sortArrayToSortObject(validSorts, query.hasTextSearch));
54
+ }
55
+ else {
56
+ modelQuery.sort(sortArrayToSortObject(query.sort, query.hasTextSearch));
57
+ }
58
+ }
59
+ }
60
+ }
61
+ exports.ModelQuery = ModelQuery;
62
+ function sortArrayToSortObject(arr, hasText) {
63
+ const sortObj = {};
64
+ for (const item of arr) {
65
+ if (item === 'text' && hasText) {
66
+ sortObj['score'] = { $meta: 'textScore' };
67
+ }
68
+ else if (item[0] === '-') {
69
+ sortObj[item.substr(1)] = -1;
70
+ }
71
+ else if (item[0] === '+') {
72
+ sortObj[item.substr(1)] = 1;
73
+ }
74
+ else {
75
+ sortObj[item] = 1;
76
+ }
77
+ }
78
+ return sortObj;
79
+ }
80
+ //# sourceMappingURL=ModelQuery.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ModelQuery.js","sourceRoot":"","sources":["../src/ModelQuery.ts"],"names":[],"mappings":";;;AAEA,2CAA4C;AAoB5C,MAAa,UAAU;IACrB,YAAoB,OAA2B,EAAE;QAA7B,SAAI,GAAJ,IAAI,CAAyB;IACjD,CAAC;IAEM,WAAW,CAAC,KAAe;QAChC,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;IAEM,WAAW,CAAC,UAAuB,EAAE,KAAe;QACzD,IAAI,QAAQ,GAAsB,EAAE,CAAC;QACrC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YAC7B,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;;gBAClC,MAAM,KAAK,GAAG,MAAA,IAAI,CAAC,IAAI,CAAC,QAAQ,0CAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC;gBACjE,IAAI,CAAC,KAAK;oBAAE,OAAO,IAAI,CAAC;gBACxB,MAAM,MAAM,GAAG,CAAA,MAAA,GAAG,CAAC,MAAM,0CAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAQ,CAAC,CAAC,KAAI,EAAE,CAAC;gBAC9E,OAAO;oBACL,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,MAAM,EAAE,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;iBAC9D,CAAA;YACH,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAsB,CAAC;SACzC;QACD,IAAI,KAAK,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;SACtC;QACD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACvB,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;SAC9B;IACH,CAAC;IAEM,eAAe,CAAC,UAAuB,EAAE,KAAe;;QAC7D,UAAU,CAAC,IAAI,CAAC,MAAA,KAAK,CAAC,IAAI,mCAAI,CAAC,CAAC,CAAC;QACjC,UAAU,CAAC,KAAK,CAAC,MAAA,MAAA,KAAK,CAAC,KAAK,mCAAI,IAAI,CAAC,IAAI,CAAC,KAAK,mCAAI,yBAAa,CAAC,CAAC;IACpE,CAAC;IAEM,SAAS,CAAC,UAAuB,EAAE,KAAe,EAAE,aAA2B;QACpF,MAAM,MAAM,GAAG,aAAa,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;QACjD,IAAI,OAAO,GAAG,MAAM,IAAI,EAAE,CAAC;QAC3B,IAAI,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACrC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAC3B,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CACrF,CAAC;SACH;QAED,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACtB,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;SACtC;IACH,CAAC;IAEM,OAAO,CAAC,UAAuB,EAAE,KAAe;QACrD,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;gBAClB,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAClC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAC7E,CAAA;gBACD,UAAU,CAAC,IAAI,CAAC,qBAAqB,CAAC,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;aACzE;iBAAM;gBACL,UAAU,CAAC,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;aACzE;SACF;IACH,CAAC;CACF;AA5DD,gCA4DC;AAED,SAAS,qBAAqB,CAAC,GAAa,EAAE,OAAiB;IAC7D,MAAM,OAAO,GAAQ,EAAE,CAAC;IACxB,KAAI,MAAM,IAAI,IAAI,GAAG,EAAE;QACrB,IAAI,IAAI,KAAK,MAAM,IAAI,OAAO,EAAE;YAC9B,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;SAC3C;aAAM,IAAG,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;YACzB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;SAC9B;aAAM,IAAG,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;YACzB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;SAC7B;aAAM;YACL,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACnB;KACF;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}
package/lib/Query.d.ts ADDED
@@ -0,0 +1,77 @@
1
+ import { Request } from 'express';
2
+ import { Document, FilterQuery, LeanDocument, PopulateOptions, QueryOptions } from 'mongoose';
3
+ import { IQueryPopulate } from './QueryModel';
4
+ export interface IMongooseQueryOptions extends QueryOptions {
5
+ score?: {
6
+ $meta: 'textScore';
7
+ };
8
+ }
9
+ export interface IQueryOpts {
10
+ skip?: number | string;
11
+ limit?: number | string;
12
+ text?: string;
13
+ sort?: string;
14
+ populate?: string;
15
+ select?: string;
16
+ _id?: string;
17
+ '!_id'?: string;
18
+ [key: string]: string | number | undefined;
19
+ }
20
+ export declare type IQueryAddToModelQuery<T extends Document, R extends Request = Request> = {
21
+ [key in keyof R]?: FilterQuery<T>;
22
+ };
23
+ export declare class Query<T extends Document = Document, P extends object = object, Q extends IQueryOpts = IQueryOpts> {
24
+ private _root;
25
+ private _rootNext;
26
+ private _rootPopulate;
27
+ private _query;
28
+ private _$Query;
29
+ private _param;
30
+ private _select;
31
+ private _or;
32
+ private _addToModelQuery;
33
+ private _skip;
34
+ private _limit;
35
+ private _export;
36
+ private _parameter;
37
+ private _projection;
38
+ readonly hasTextSearch: boolean;
39
+ readonly options: IMongooseQueryOptions;
40
+ readonly sort: string[];
41
+ readonly populate: IQueryPopulate[];
42
+ readonly page: number;
43
+ constructor(queries: Q);
44
+ get skip(): number;
45
+ get limit(): number;
46
+ get root(): FilterQuery<T> | null;
47
+ get query(): { [P_1 in keyof T]?: (P_1 extends "_id" ? [Extract<T[P_1], import("bson").ObjectId>] extends [never] ? import("mongodb").Condition<T[P_1]> : import("mongodb").Condition<string | {
48
+ _id: import("bson").ObjectId;
49
+ } | T[P_1]> : [Extract<T[P_1], import("bson").ObjectId>] extends [never] ? import("mongodb").Condition<T[P_1]> : import("mongodb").Condition<string | T[P_1]>) | undefined; } & import("mongodb").RootQuerySelector<import("mongoose")._AllowStringsForIds<LeanDocument<T>>>;
50
+ get param(): P;
51
+ get rootPopulate(): PopulateOptions[];
52
+ get select(): Exclude<keyof T, "$getAllSubdocs" | "$ignore" | "$isDefault" | "$isDeleted" | "$getPopulatedDocs" | "$isEmpty" | "$isValid" | "$locals" | "$markValid" | "$op" | "$session" | "$set" | "$where" | "baseModelName" | "collection" | "db" | "delete" | "deleteOne" | "depopulate" | "directModifiedPaths" | "equals" | "errors" | "execPopulate" | "get" | "getChanges" | "increment" | "init" | "invalidate" | "isDirectModified" | "isDirectSelected" | "isInit" | "isModified" | "isNew" | "isSelected" | "markModified" | "modifiedPaths" | "model" | "modelName" | "overwrite" | "$parent" | "populate" | "populated" | "remove" | "replaceOne" | "save" | "schema" | "set" | "toJSON" | "toObject" | "unmarkModified" | "update" | "updateOne" | "validate" | "validateSync" | "$isSingleNested">[];
53
+ get or(): FilterQuery<T>[];
54
+ get export(): boolean;
55
+ set export(value: boolean);
56
+ get projection(): object | undefined;
57
+ set projection(value: object | undefined);
58
+ set parameter(value: keyof Request);
59
+ setSkipAndLimit(skip: number, limit: number): void;
60
+ setQuery<K extends keyof FilterQuery<T>>(key: K, value: FilterQuery<T>[K]): void;
61
+ addOr(query: FilterQuery<T>): void;
62
+ defaultSelect(select: (keyof LeanDocument<T>)[]): void;
63
+ addPopulate(populate: PopulateOptions | PopulateOptions[]): void;
64
+ addParamToRoot(key: keyof P): void;
65
+ addRoot(query: FilterQuery<T>): FilterQuery<T>;
66
+ addRootNext(query: FilterQuery<T>): FilterQuery<T>;
67
+ removeQuery(key: keyof FilterQuery<T>): void;
68
+ deleteKeysFromRoot(keys: (keyof FilterQuery<T>)[]): void;
69
+ addToModelQuery<R extends any, K extends keyof R = keyof R>(key: K | K[], query: FilterQuery<R[K]>): void;
70
+ createQuery<R extends Request = Request>({ param, query, noRoot, }?: ICreateQueryOptions<R, T>): FilterQuery<T>;
71
+ }
72
+ interface ICreateQueryOptions<R extends Request, T extends Document> {
73
+ param?: keyof R;
74
+ query?: (keyof LeanDocument<T>)[];
75
+ noRoot?: boolean;
76
+ }
77
+ export {};