@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/lib/Query.js ADDED
@@ -0,0 +1,307 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Query = void 0;
4
+ const mongoose_1 = require("mongoose");
5
+ const constants_1 = require("./constants");
6
+ const QueryModel_1 = require("./QueryModel");
7
+ const mongoSanitize = require("express-mongo-sanitize");
8
+ const toValidNumber = (v, defaultV) => typeof v === 'number' ? Number(v) : v ? parseInt(v, 10) : defaultV;
9
+ const SORT_SPLIT = /,|\s/;
10
+ const SELECT_SPLIT = /,|\s/;
11
+ const POPULATE_SPLIT = ';';
12
+ const POPULATE_PATH_SPLIT = ':';
13
+ const POPULATE_SELECT_SPLIT = /,|\s/;
14
+ class Query {
15
+ constructor(queries) {
16
+ this._root = null;
17
+ this._rootNext = null;
18
+ this._rootPopulate = [];
19
+ this._query = {};
20
+ this._$Query = {};
21
+ this._param = {};
22
+ this._select = [];
23
+ this._or = [];
24
+ this._addToModelQuery = {};
25
+ this._skip = constants_1.DEFAULT_SKIP;
26
+ this._limit = constants_1.DEFAULT_LIMIT;
27
+ this._export = false;
28
+ this._parameter = undefined;
29
+ this._projection = undefined;
30
+ this.hasTextSearch = false;
31
+ this.options = {};
32
+ this.sort = [];
33
+ this.populate = [];
34
+ this.page = 0;
35
+ const query = Object.assign({}, queries);
36
+ if ('limit' in query) {
37
+ this._limit = toValidNumber(query.limit, this._limit);
38
+ delete query.limit;
39
+ }
40
+ if ('skip' in query) {
41
+ this._skip = toValidNumber(query.skip, this._skip);
42
+ delete query.skip;
43
+ }
44
+ if ('page' in query && typeof query.page === 'number') {
45
+ this.page = toValidNumber(query.page, this.page);
46
+ this._skip = this._limit * this.page;
47
+ delete query.page;
48
+ }
49
+ if ('text' in query) {
50
+ if (query.text) {
51
+ this._$Query['$text'] = { $search: query.text };
52
+ this.options['score'] = { $meta: 'textScore' };
53
+ this.hasTextSearch = true;
54
+ }
55
+ delete query.text;
56
+ }
57
+ if ('sort' in query && query.sort) {
58
+ this.sort = query.sort.split(SORT_SPLIT).filter(Boolean);
59
+ delete query.sort;
60
+ }
61
+ if ('select' in query && query.select) {
62
+ this._select = query.select
63
+ .split(SELECT_SPLIT)
64
+ .filter(Boolean);
65
+ delete query.select;
66
+ }
67
+ if ('_id' in query) {
68
+ if (query._id) {
69
+ const $in = query._id.split(SELECT_SPLIT).filter(Boolean);
70
+ if ($in.length > 0) {
71
+ // @ts-ignore
72
+ this._query['_id'] = { $in: $in.map(mongoose_1.Types.ObjectId) };
73
+ }
74
+ }
75
+ delete query._id;
76
+ }
77
+ if ('!_id' in query) {
78
+ if (query['!_id']) {
79
+ const $nin = query['!_id'].split(SELECT_SPLIT).filter(Boolean);
80
+ if ($nin.length > 0) {
81
+ // @ts-ignore
82
+ this._query['_id'] = {
83
+ $nin: $nin.map(mongoose_1.Types.ObjectId),
84
+ };
85
+ }
86
+ }
87
+ delete query['!_id'];
88
+ }
89
+ if ('populate' in query) {
90
+ if (query.populate) {
91
+ const pathsToPopulate = query.populate
92
+ .split(POPULATE_SPLIT)
93
+ .filter(Boolean);
94
+ for (const pathToPopulate of pathsToPopulate) {
95
+ const [path, selects] = pathToPopulate.split(POPULATE_PATH_SPLIT);
96
+ if (path) {
97
+ this.populate.push(Object.assign({ path }, (selects
98
+ ? { select: selects.split(POPULATE_SELECT_SPLIT) }
99
+ : {})));
100
+ }
101
+ }
102
+ }
103
+ delete query.populate;
104
+ }
105
+ const regExpQuery = {};
106
+ for (const key in query) {
107
+ if (query.hasOwnProperty(key) && key[0] === '$') {
108
+ if (typeof query[key] !== 'string')
109
+ continue;
110
+ try {
111
+ const str = String(query[key]);
112
+ if (str) {
113
+ if (key.match(/^\$gte?_/) || key.match(/^\$lte?_/)) {
114
+ const [operation, field] = key.split('_');
115
+ if (regExpQuery[field]) {
116
+ regExpQuery[field][operation] = new Date(str);
117
+ }
118
+ else {
119
+ regExpQuery[field] = { [operation]: new Date(str) };
120
+ }
121
+ }
122
+ else if (key.match(/^\$n?in_/)) {
123
+ const [op, field] = key.split('_');
124
+ regExpQuery[field] = { [op]: str.split(SORT_SPLIT) };
125
+ }
126
+ else {
127
+ // @ts-ignore
128
+ regExpQuery[key.slice(1)] = {
129
+ $regex: new RegExp(QueryModel_1.toValidTextRegexp(str), 'i'),
130
+ };
131
+ }
132
+ }
133
+ }
134
+ catch (e) {
135
+ // empty
136
+ }
137
+ delete query[key];
138
+ }
139
+ }
140
+ const advancedQuery = {};
141
+ for (const key in query) {
142
+ if (query.hasOwnProperty(key) && key[0] === '!') {
143
+ // @ts-ignore
144
+ advancedQuery[key.slice(1)] = { $ne: query[key] };
145
+ delete query[key];
146
+ }
147
+ }
148
+ const cleanedQuery = {};
149
+ for (const key in query) {
150
+ if (query.hasOwnProperty(key)) {
151
+ if (typeof query[key] !== 'string' || query[key] !== '') {
152
+ cleanedQuery[key] = query[key];
153
+ }
154
+ }
155
+ }
156
+ this._query = Object.assign(Object.assign(Object.assign(Object.assign({}, this._query), regExpQuery), advancedQuery), mongoSanitize.sanitize(cleanedQuery, { replaceWith: '_' }));
157
+ }
158
+ get skip() {
159
+ return this._skip;
160
+ }
161
+ get limit() {
162
+ return this._limit;
163
+ }
164
+ get root() {
165
+ const root = this._root;
166
+ if (this._parameter && this._addToModelQuery[this._parameter]) {
167
+ if (root) {
168
+ return {
169
+ $and: [root, this._addToModelQuery[this._parameter]],
170
+ };
171
+ }
172
+ return this._addToModelQuery[this._parameter];
173
+ }
174
+ return root;
175
+ }
176
+ get query() {
177
+ return Object.assign(Object.assign({}, this._query), this._$Query);
178
+ }
179
+ get param() {
180
+ return this._param;
181
+ }
182
+ get rootPopulate() {
183
+ return this._rootPopulate;
184
+ }
185
+ get select() {
186
+ return this._select;
187
+ }
188
+ get or() {
189
+ return this._or;
190
+ }
191
+ get export() {
192
+ return this._export;
193
+ }
194
+ set export(value) {
195
+ this._export = value;
196
+ }
197
+ get projection() {
198
+ return this._projection;
199
+ }
200
+ set projection(value) {
201
+ this._projection = value;
202
+ }
203
+ set parameter(value) {
204
+ this._parameter = value;
205
+ }
206
+ setSkipAndLimit(skip, limit) {
207
+ this._skip = skip;
208
+ this._limit = limit;
209
+ }
210
+ setQuery(key, value) {
211
+ this._query[key] = value;
212
+ }
213
+ addOr(query) {
214
+ this._or.push(query);
215
+ }
216
+ defaultSelect(select) {
217
+ if (this._select.length !== 0)
218
+ return;
219
+ this._select = select;
220
+ }
221
+ addPopulate(populate) {
222
+ this._rootPopulate.push(...(Array.isArray(populate) ? populate : [populate]));
223
+ }
224
+ addParamToRoot(key) {
225
+ if (key in this._param && this._param[key]) {
226
+ // @ts-ignore
227
+ this.addRoot({ [key]: this._param[key] });
228
+ }
229
+ }
230
+ addRoot(query) {
231
+ this._root = Object.assign(Object.assign({}, (this._root || {})), query);
232
+ return this._root;
233
+ }
234
+ addRootNext(query) {
235
+ this._rootNext = Object.assign(Object.assign({}, (this._rootNext || {})), query);
236
+ return this._rootNext;
237
+ }
238
+ removeQuery(key) {
239
+ // @ts-ignore
240
+ if (key in this._query) {
241
+ delete this._query[key];
242
+ }
243
+ }
244
+ deleteKeysFromRoot(keys) {
245
+ if (this._root) {
246
+ for (const key of keys) {
247
+ // @ts-ignore
248
+ if (key in this._root) {
249
+ delete this._root[key];
250
+ }
251
+ }
252
+ }
253
+ }
254
+ addToModelQuery(key, query) {
255
+ const modelKeys = key;
256
+ const keys = Array.isArray(modelKeys)
257
+ ? modelKeys
258
+ : [modelKeys];
259
+ for (const modelKey of keys) {
260
+ if (this._addToModelQuery[modelKey]) {
261
+ // @ts-ignore
262
+ this._addToModelQuery[modelKey] = Object.assign(Object.assign({}, this._addToModelQuery[modelKey]), query);
263
+ }
264
+ else {
265
+ // @ts-ignore
266
+ this._addToModelQuery[modelKey] = Object.assign({}, query);
267
+ }
268
+ }
269
+ }
270
+ createQuery({ param, query, noRoot, } = {}) {
271
+ if (param) {
272
+ this.parameter = param;
273
+ }
274
+ const queryArray = [];
275
+ const root = this.root;
276
+ if (!noRoot && root && Object.keys(root).length > 0) {
277
+ queryArray.push(root);
278
+ }
279
+ if (!noRoot && this._rootNext && Object.keys(this._rootNext).length > 0) {
280
+ queryArray.push(this._rootNext);
281
+ this._rootNext = null;
282
+ }
283
+ if (Object.keys(this._query).length > 0 ||
284
+ Object.keys(this._$Query).length > 0) {
285
+ const addQuery = query
286
+ ? query.reduce((obj, key) => {
287
+ if (typeof this._query[key] !== 'undefined') {
288
+ obj[key] = this._query[key];
289
+ }
290
+ return obj;
291
+ }, Object.assign({}, this._$Query))
292
+ : Object.assign(Object.assign({}, this._$Query), this._query);
293
+ if (Object.keys(addQuery).length > 0) {
294
+ queryArray.push(addQuery);
295
+ }
296
+ }
297
+ const mQuery = queryArray.length > 1 ? { $and: queryArray } : queryArray[0] || {};
298
+ if (this._or.length > 0) {
299
+ return {
300
+ $or: [...this._or, mQuery],
301
+ };
302
+ }
303
+ return mQuery || {};
304
+ }
305
+ }
306
+ exports.Query = Query;
307
+ //# sourceMappingURL=Query.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Query.js","sourceRoot":"","sources":["../src/Query.ts"],"names":[],"mappings":";;;AACA,uCAOkB;AAClB,2CAA0D;AAC1D,6CAAiE;AACjE,wDAAyD;AA2BzD,MAAM,aAAa,GAAG,CAAC,CAA8B,EAAE,QAAgB,EAAE,EAAE,CACzE,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;AAErE,MAAM,UAAU,GAAG,MAAM,CAAC;AAC1B,MAAM,YAAY,GAAG,MAAM,CAAC;AAC5B,MAAM,cAAc,GAAG,GAAG,CAAC;AAC3B,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAChC,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAErC,MAAa,KAAK;IA0BhB,YAAY,OAAU;QArBd,UAAK,GAA0B,IAAI,CAAC;QACpC,cAAS,GAA0B,IAAI,CAAC;QACxC,kBAAa,GAAsB,EAAE,CAAC;QACtC,WAAM,GAAmB,EAAE,CAAC;QAC5B,YAAO,GAAmB,EAAE,CAAC;QAC7B,WAAM,GAAM,EAAO,CAAC;QACpB,YAAO,GAA8B,EAAE,CAAC;QACxC,QAAG,GAAqB,EAAE,CAAC;QAC3B,qBAAgB,GAA6B,EAAE,CAAC;QAChD,UAAK,GAAW,wBAAY,CAAC;QAC7B,WAAM,GAAW,yBAAa,CAAC;QAC/B,YAAO,GAAY,KAAK,CAAC;QACzB,eAAU,GAA8B,SAAS,CAAC;QAClD,gBAAW,GAAuB,SAAS,CAAC;QAE3C,kBAAa,GAAY,KAAK,CAAC;QAC/B,YAAO,GAA0B,EAAE,CAAC;QACpC,SAAI,GAAa,EAAE,CAAC;QACpB,aAAQ,GAAqB,EAAE,CAAC;QAChC,SAAI,GAAW,CAAC,CAAC;QAGxB,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QACzC,IAAI,OAAO,IAAI,KAAK,EAAE;YACpB,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YACtD,OAAO,KAAK,CAAC,KAAK,CAAC;SACpB;QACD,IAAI,MAAM,IAAI,KAAK,EAAE;YACnB,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YACnD,OAAO,KAAK,CAAC,IAAI,CAAC;SACnB;QACD,IAAI,MAAM,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE;YACrD,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACjD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC;YACrC,OAAO,KAAK,CAAC,IAAI,CAAC;SACnB;QACD,IAAI,MAAM,IAAI,KAAK,EAAE;YACnB,IAAI,KAAK,CAAC,IAAI,EAAE;gBACd,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;gBAChD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;gBAC/C,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;aAC3B;YACD,OAAO,KAAK,CAAC,IAAI,CAAC;SACnB;QACD,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE;YACjC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACzD,OAAO,KAAK,CAAC,IAAI,CAAC;SACnB;QACD,IAAI,QAAQ,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE;YACrC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM;iBACxB,KAAK,CAAC,YAAY,CAAC;iBACnB,MAAM,CAAC,OAAO,CAA8B,CAAC;YAChD,OAAO,KAAK,CAAC,MAAM,CAAC;SACrB;QACD,IAAI,KAAK,IAAI,KAAK,EAAE;YAClB,IAAI,KAAK,CAAC,GAAG,EAAE;gBACb,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAC1D,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;oBAClB,aAAa;oBACb,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,gBAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;iBACvD;aACF;YACD,OAAO,KAAK,CAAC,GAAG,CAAC;SAClB;QACD,IAAI,MAAM,IAAI,KAAK,EAAE;YACnB,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE;gBACjB,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAC/D,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;oBACnB,aAAa;oBACb,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG;wBACnB,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,gBAAK,CAAC,QAAQ,CAAC;qBAC/B,CAAC;iBACH;aACF;YACD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC;SACtB;QACD,IAAI,UAAU,IAAI,KAAK,EAAE;YACvB,IAAI,KAAK,CAAC,QAAQ,EAAE;gBAClB,MAAM,eAAe,GAAG,KAAK,CAAC,QAAQ;qBACnC,KAAK,CAAC,cAAc,CAAC;qBACrB,MAAM,CAAC,OAAO,CAAC,CAAC;gBACnB,KAAK,MAAM,cAAc,IAAI,eAAe,EAAE;oBAC5C,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;oBAClE,IAAI,IAAI,EAAE;wBACR,IAAI,CAAC,QAAQ,CAAC,IAAI,iBAChB,IAAI,IACD,CAAC,OAAO;4BACT,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,qBAAqB,CAAC,EAAE;4BAClD,CAAC,CAAC,EAAE,CAAC,EACP,CAAC;qBACJ;iBACF;aACF;YACD,OAAO,KAAK,CAAC,QAAQ,CAAC;SACvB;QAED,MAAM,WAAW,GAAmB,EAAE,CAAC;QACvC,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE;YACvB,IAAI,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;gBAC/C,IAAI,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,QAAQ;oBAAE,SAAS;gBAC7C,IAAI;oBACF,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;oBAC/B,IAAI,GAAG,EAAE;wBACP,IAAI,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;4BAClD,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAGvC,CAAC;4BACF,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE;gCACtB,WAAW,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC;6BAC/C;iCAAM;gCACL,WAAW,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;6BACrD;yBACF;6BAAM,IAAI,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;4BAChC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAGhC,CAAC;4BACF,WAAW,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;yBACtD;6BAAM;4BACL,aAAa;4BACb,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG;gCAC1B,MAAM,EAAE,IAAI,MAAM,CAAC,8BAAiB,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC;6BAChD,CAAC;yBACH;qBACF;iBACF;gBAAC,OAAO,CAAC,EAAE;oBACV,QAAQ;iBACT;gBACD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;aACnB;SACF;QACD,MAAM,aAAa,GAAmB,EAAE,CAAC;QACzC,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE;YACvB,IAAI,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;gBAC/C,aAAa;gBACb,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAClD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;aACnB;SACF;QAED,MAAM,YAAY,GAAmB,EAAE,CAAC;QACxC,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE;YACvB,IAAI,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE;gBAC7B,IAAI,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE;oBACvD,YAAY,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;iBAChC;aACF;SACF;QAED,IAAI,CAAC,MAAM,+DACN,IAAI,CAAC,MAAM,GACX,WAAW,GACX,aAAa,GACb,aAAa,CAAC,QAAQ,CAAC,YAAY,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,CAC9D,CAAC;IACJ,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,IAAI;QACN,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YAC7D,IAAI,IAAI,EAAE;gBACR,OAAO;oBACL,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAE,CAAC;iBACpC,CAAC;aACrB;YACD,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAE,CAAC;SAChD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,KAAK;QACP,uCAAY,IAAI,CAAC,MAAM,GAAK,IAAI,CAAC,OAAO,EAAG;IAC7C,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,MAAM,CAAC,KAAc;QACvB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,IAAI,UAAU,CAAC,KAAyB;QACtC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,SAAS,CAAC,KAAoB;QAChC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;IAC1B,CAAC;IAEM,eAAe,CAAC,IAAY,EAAE,KAAa;QAChD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAEM,QAAQ,CACb,GAAM,EACN,KAAwB;QAExB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAC3B,CAAC;IAEM,KAAK,CAAC,KAAqB;QAChC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAEM,aAAa,CAAC,MAAiC;QACpD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QACtC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAEM,WAAW,CAAC,QAA6C;QAC9D,IAAI,CAAC,aAAa,CAAC,IAAI,CACrB,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CACrD,CAAC;IACJ,CAAC;IAEM,cAAc,CAAC,GAAY;QAChC,IAAI,GAAG,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE;YAC1C,aAAa;YACb,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SAC3C;IACH,CAAC;IAEM,OAAO,CAAC,KAAqB;QAClC,IAAI,CAAC,KAAK,mCACL,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,GAClB,KAAK,CACT,CAAC;QAEF,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEM,WAAW,CAAC,KAAqB;QACtC,IAAI,CAAC,SAAS,mCACT,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC,GACtB,KAAK,CACT,CAAC;QAEF,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAEM,WAAW,CAAC,GAAyB;QAC1C,aAAa;QACb,IAAI,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE;YACtB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SACzB;IACH,CAAC;IAEM,kBAAkB,CAAC,IAA8B;QACtD,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;gBACtB,aAAa;gBACb,IAAI,GAAG,IAAI,IAAI,CAAC,KAAK,EAAE;oBACrB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;iBACxB;aACF;SACF;IACH,CAAC;IAEM,eAAe,CACpB,GAAY,EACZ,KAAwB;QAExB,MAAM,SAAS,GAAG,GAAoB,CAAC;QACvC,MAAM,IAAI,GAAsB,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC;YACtD,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAChB,KAAK,MAAM,QAAQ,IAAI,IAAI,EAAE;YAC3B,IAAI,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE;gBACnC,aAAa;gBACb,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,mCAC1B,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAC/B,KAAK,CACT,CAAC;aACH;iBAAM;gBACL,aAAa;gBACb,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,qBAAQ,KAAK,CAAE,CAAC;aAChD;SACF;IACH,CAAC;IAEM,WAAW,CAA8B,EAC9C,KAAK,EACL,KAAK,EACL,MAAM,MACuB,EAAE;QAC/B,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,SAAS,GAAG,KAAsB,CAAC;SACzC;QACD,MAAM,UAAU,GAAG,EAAE,CAAC;QACtB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,MAAM,IAAI,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YACnD,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACvB;QACD,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YACvE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAChC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;SACvB;QACD,IACE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC;YACnC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EACpC;YACA,MAAM,QAAQ,GAAG,KAAK;gBACpB,CAAC,CAAC,KAAK,CAAC,MAAM,CACV,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;oBACX,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE;wBAC3C,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;qBAC7B;oBACD,OAAO,GAAG,CAAC;gBACb,CAAC,oBACI,IAAI,CAAC,OAAO,EAClB;gBACH,CAAC,iCAAM,IAAI,CAAC,OAAO,GAAK,IAAI,CAAC,MAAM,CAAE,CAAC;YACxC,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;gBACpC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aAC3B;SACF;QAED,MAAM,MAAM,GACV,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAErE,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;YACvB,OAAO;gBACL,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC;aACT,CAAC;SACrB;QAED,OAAQ,MAAyB,IAAI,EAAE,CAAC;IAC1C,CAAC;CACF;AA5WD,sBA4WC"}
@@ -0,0 +1,50 @@
1
+ export * from './error/error.handler';
2
+ export declare enum QueryErrorCode {
3
+ Default = "default",
4
+ ServerError = "server-error",
5
+ NotFound = "not-found",
6
+ BadRequest = "bad-request",
7
+ Unauthorized = "unauthorized",
8
+ Forbidden = "forbidden",
9
+ NotImplemented = "not-implemented",
10
+ SessionExpired = "session-expired"
11
+ }
12
+ export interface IQueryErrorExpressRequest {
13
+ id: string;
14
+ }
15
+ export interface IQueryError<C extends string> {
16
+ id: string;
17
+ links?: {
18
+ self?: IQueryErrorLink | string;
19
+ };
20
+ status: string;
21
+ code: C;
22
+ title?: string;
23
+ detail?: string;
24
+ source?: {
25
+ pointer?: string;
26
+ parameter?: string;
27
+ header?: string;
28
+ body?: string;
29
+ };
30
+ meta?: object;
31
+ }
32
+ export interface IQueryErrorLink {
33
+ href: string;
34
+ title?: string;
35
+ describedBy?: string;
36
+ meta: {
37
+ count: number;
38
+ };
39
+ }
40
+ export declare type IQueryErrorOptional = Pick<IQueryError<QueryErrorCode>, 'meta' | 'title' | 'detail' | 'links' | 'source'>;
41
+ export declare class QueryError<R extends IQueryErrorExpressRequest, C extends string> extends Error {
42
+ private req;
43
+ readonly code: C;
44
+ readonly optional: IQueryErrorOptional;
45
+ readonly status: number;
46
+ constructor(req: R, code: C, optional?: IQueryErrorOptional);
47
+ toJSON(): IQueryError<C>;
48
+ static catch<R extends IQueryErrorExpressRequest, C extends string>(req: R, e: Error | QueryError<R, C>): QueryError<R, C>;
49
+ static getStatusFromCode<C extends string>(code: C): 500 | 404 | 400 | 440 | 501;
50
+ }
@@ -0,0 +1,62 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
5
+ }) : (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ o[k2] = m[k];
8
+ }));
9
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
10
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
11
+ };
12
+ Object.defineProperty(exports, "__esModule", { value: true });
13
+ exports.QueryError = exports.QueryErrorCode = void 0;
14
+ __exportStar(require("./error/error.handler"), exports);
15
+ var QueryErrorCode;
16
+ (function (QueryErrorCode) {
17
+ QueryErrorCode["Default"] = "default";
18
+ QueryErrorCode["ServerError"] = "server-error";
19
+ QueryErrorCode["NotFound"] = "not-found";
20
+ QueryErrorCode["BadRequest"] = "bad-request";
21
+ QueryErrorCode["Unauthorized"] = "unauthorized";
22
+ QueryErrorCode["Forbidden"] = "forbidden";
23
+ QueryErrorCode["NotImplemented"] = "not-implemented";
24
+ QueryErrorCode["SessionExpired"] = "session-expired";
25
+ })(QueryErrorCode = exports.QueryErrorCode || (exports.QueryErrorCode = {}));
26
+ class QueryError extends Error {
27
+ constructor(req, code, optional = {}) {
28
+ super(code);
29
+ this.req = req;
30
+ this.code = code;
31
+ this.optional = optional;
32
+ this.status = QueryError.getStatusFromCode(code);
33
+ }
34
+ toJSON() {
35
+ return Object.assign({ id: this.req.id, status: String(this.status), code: this.code }, this.optional);
36
+ }
37
+ static catch(req, e) {
38
+ if (e instanceof QueryError) {
39
+ return e;
40
+ }
41
+ console.error(e);
42
+ return new QueryError(req, QueryErrorCode.ServerError, {
43
+ detail: e.message,
44
+ });
45
+ }
46
+ static getStatusFromCode(code) {
47
+ switch (code) {
48
+ case QueryErrorCode.NotFound:
49
+ return 404;
50
+ case QueryErrorCode.BadRequest:
51
+ return 400;
52
+ case QueryErrorCode.SessionExpired:
53
+ return 440;
54
+ case QueryErrorCode.NotImplemented:
55
+ return 501;
56
+ default:
57
+ return 500;
58
+ }
59
+ }
60
+ }
61
+ exports.QueryError = QueryError;
62
+ //# sourceMappingURL=QueryError.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"QueryError.js","sourceRoot":"","sources":["../src/QueryError.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,wDAAsC;AAEtC,IAAY,cASX;AATD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,8CAA4B,CAAA;IAC5B,wCAAsB,CAAA;IACtB,4CAA0B,CAAA;IAC1B,+CAA6B,CAAA;IAC7B,yCAAuB,CAAA;IACvB,oDAAkC,CAAA;IAClC,oDAAkC,CAAA;AACpC,CAAC,EATW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QASzB;AAqCD,MAAa,UAGX,SAAQ,KAAK;IAGb,YACU,GAAM,EACL,IAAO,EACP,WAAgC,EAAE;QAE3C,KAAK,CAAC,IAAI,CAAC,CAAC;QAJJ,QAAG,GAAH,GAAG,CAAG;QACL,SAAI,GAAJ,IAAI,CAAG;QACP,aAAQ,GAAR,QAAQ,CAA0B;QAG3C,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;IAEM,MAAM;QACX,uBACE,EAAE,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,EACf,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAC3B,IAAI,EAAE,IAAI,CAAC,IAAI,IACZ,IAAI,CAAC,QAAQ,EAChB;IACJ,CAAC;IAED,MAAM,CAAC,KAAK,CACV,GAAM,EACN,CAA2B;QAE3B,IAAI,CAAC,YAAY,UAAU,EAAE;YAC3B,OAAO,CAAC,CAAC;SACV;QACD,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACjB,OAAO,IAAI,UAAU,CAAO,GAAG,EAAE,cAAc,CAAC,WAAgB,EAAE;YAChE,MAAM,EAAE,CAAC,CAAC,OAAO;SAClB,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,iBAAiB,CAAmB,IAAO;QAChD,QAAQ,IAAI,EAAE;YACZ,KAAK,cAAc,CAAC,QAAQ;gBAC1B,OAAO,GAAG,CAAC;YACb,KAAK,cAAc,CAAC,UAAU;gBAC5B,OAAO,GAAG,CAAC;YACb,KAAK,cAAc,CAAC,cAAc;gBAChC,OAAO,GAAG,CAAC;YACb,KAAK,cAAc,CAAC,cAAc;gBAChC,OAAO,GAAG,CAAC;YACb;gBACE,OAAO,GAAG,CAAC;SACd;IACH,CAAC;CACF;AAnDD,gCAmDC"}
@@ -0,0 +1,50 @@
1
+ import { NextFunction, Request, Response } from 'express';
2
+ import { Document, FilterQuery, LeanDocument } from 'mongoose';
3
+ import { QueryHandler } from './QueryHandler';
4
+ import { QueryExpressSubHandler } from './QueryExpressSubHandler';
5
+ export interface IQueryExpressHandlerOptions<T extends Document> {
6
+ slugKey?: keyof T & string;
7
+ archiveKey?: keyof T;
8
+ history?: {
9
+ active: boolean;
10
+ ignoreFields?: (keyof LeanDocument<T>)[];
11
+ };
12
+ }
13
+ interface BulkProps {
14
+ runNext?: boolean;
15
+ }
16
+ export declare class QueryExpressHandler<R extends Request, T extends Document> {
17
+ private param;
18
+ private handler;
19
+ readonly options: IQueryExpressHandlerOptions<T>;
20
+ constructor(param: keyof R, handler: QueryHandler<T>, options?: IQueryExpressHandlerOptions<T>);
21
+ post(req: R, res: Response, next: NextFunction): Promise<void>;
22
+ findOne(req: R, _res: Response, next: NextFunction): Promise<void>;
23
+ search(req: R, res: Response, next: NextFunction): Promise<Response<any, Record<string, any>> | undefined>;
24
+ export(req: R, res: Response, next: NextFunction): Promise<void>;
25
+ patch(req: R, _res: Response, next: NextFunction): Promise<void>;
26
+ archive(req: R, _res: Response, next: NextFunction): Promise<void>;
27
+ delete(req: R, _res: Response, next: NextFunction): Promise<void>;
28
+ json(req: R, res: Response, next: NextFunction): Promise<Response<any, Record<string, any>> | undefined>;
29
+ bulkPatch(req: R, res: Response, next: NextFunction): Promise<Response<any, Record<string, any>> | undefined>;
30
+ bulkDelete({ runNext }: BulkProps): (req: R, res: Response, next: NextFunction) => Promise<void>;
31
+ bulkArchive({ runNext }: BulkProps): (req: R, res: Response, next: NextFunction) => Promise<void>;
32
+ addToNextQuery(fn: (req: R) => FilterQuery<T> | null): (req: R, _: Response, next: NextFunction) => void;
33
+ subRoute(req: R, _res: Response, next: NextFunction): void;
34
+ subDoc<R2 extends keyof R, P extends keyof T>(reqKey: R2, subArrayKey: P): QueryExpressSubHandler<R, T, P>;
35
+ addRootRequest(req: R): void;
36
+ getRootQuery(req: R): FilterQuery<T>;
37
+ removeRootRequest(req: R, slugKey?: string): void;
38
+ addToQuery(req: R, _res: Response, next: NextFunction): void;
39
+ addToPost(req: R, _res: Response, next: NextFunction): void;
40
+ getParam(req: R, param?: keyof R): any;
41
+ preHistory(req: R): void;
42
+ postHistory(req: R, fetchNew?: boolean): Promise<void>;
43
+ init(req: R): void;
44
+ private getDoc;
45
+ private validateBody;
46
+ private getFindOpts;
47
+ private validateReq;
48
+ private validateIdsInBody;
49
+ }
50
+ export {};