-
-
Notifications
You must be signed in to change notification settings - Fork 519
/
request-query.parser.ts
347 lines (297 loc) · 8.4 KB
/
request-query.parser.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
import {
hasLength,
hasValue,
isString,
isArrayFull,
isDate,
isDateString,
isObject,
isStringFull,
objKeys,
isNil,
ObjectLiteral,
} from '@nestjsx/util';
import { RequestQueryException } from './exceptions';
import {
ParamsOptions,
ParsedRequestParams,
RequestQueryBuilderOptions,
} from './interfaces';
import { RequestQueryBuilder } from './request-query.builder';
import {
validateCondition,
validateJoin,
validateNumeric,
validateParamOption,
validateSort,
validateUUID,
} from './request-query.validator';
import {
ComparisonOperator,
QueryFields,
QueryFilter,
QueryJoin,
QuerySort,
SCondition,
SConditionAND,
SFields,
} from './types';
// tslint:disable:variable-name ban-types
export class RequestQueryParser implements ParsedRequestParams {
public fields: QueryFields = [];
public paramsFilter: QueryFilter[] = [];
public authPersist: ObjectLiteral = undefined;
public search: SCondition;
public filter: QueryFilter[] = [];
public or: QueryFilter[] = [];
public join: QueryJoin[] = [];
public sort: QuerySort[] = [];
public limit: number;
public offset: number;
public page: number;
public cache: number;
private _params: any;
private _query: any;
private _paramNames: string[];
private _paramsOptions: ParamsOptions;
private get _options(): RequestQueryBuilderOptions {
return RequestQueryBuilder.getOptions();
}
static create(): RequestQueryParser {
return new RequestQueryParser();
}
getParsed(): ParsedRequestParams {
return {
fields: this.fields,
paramsFilter: this.paramsFilter,
authPersist: this.authPersist,
search: this.search,
filter: this.filter,
or: this.or,
join: this.join,
sort: this.sort,
limit: this.limit,
offset: this.offset,
page: this.page,
cache: this.cache,
};
}
parseQuery(query: any): this {
if (isObject(query)) {
const paramNames = objKeys(query);
if (hasLength(paramNames)) {
this._query = query;
this._paramNames = paramNames;
let searchData = this._query[this.getParamNames('search')[0]];
this.search = this.parseSearchQueryParam(searchData) as any;
if (isNil(this.search)) {
this.filter = this.parseQueryParam(
'filter',
this.conditionParser.bind(this, 'filter'),
);
this.or = this.parseQueryParam('or', this.conditionParser.bind(this, 'or'));
}
this.fields =
this.parseQueryParam('fields', this.fieldsParser.bind(this))[0] || [];
this.join = this.parseQueryParam('join', this.joinParser.bind(this));
this.sort = this.parseQueryParam('sort', this.sortParser.bind(this));
this.limit = this.parseQueryParam(
'limit',
this.numericParser.bind(this, 'limit'),
)[0];
this.offset = this.parseQueryParam(
'offset',
this.numericParser.bind(this, 'offset'),
)[0];
this.page = this.parseQueryParam(
'page',
this.numericParser.bind(this, 'page'),
)[0];
this.cache = this.parseQueryParam(
'cache',
this.numericParser.bind(this, 'cache'),
)[0];
}
}
return this;
}
parseParams(params: any, options: ParamsOptions): this {
if (isObject(params)) {
const paramNames = objKeys(params);
if (hasLength(paramNames)) {
this._params = params;
this._paramsOptions = options;
this.paramsFilter = paramNames
.map((name) => this.paramParser(name))
.filter((filter) => filter);
}
}
return this;
}
setAuthPersist(persist: ObjectLiteral = {}) {
this.authPersist = persist || /* istanbul ignore next */ {};
}
convertFilterToSearch(filter: QueryFilter): SFields | SConditionAND {
const isEmptyValue = {
isnull: true,
notnull: true,
};
return filter
? {
[filter.field]: {
[filter.operator]: isEmptyValue[filter.operator]
? isEmptyValue[filter.operator]
: filter.value,
},
}
: /* istanbul ignore next */ {};
}
private getParamNames(
type: keyof RequestQueryBuilderOptions['paramNamesMap'],
): string[] {
return this._paramNames.filter((p) => {
const name = this._options.paramNamesMap[type];
return isString(name) ? name === p : (name as string[]).some((m) => m === p);
});
}
private getParamValues(value: string | string[], parser: Function): string[] {
if (isStringFull(value)) {
return [parser.call(this, value)];
}
if (isArrayFull(value)) {
return (value as string[]).map((val) => parser(val));
}
return [];
}
private parseQueryParam(
type: keyof RequestQueryBuilderOptions['paramNamesMap'],
parser: Function,
) {
const param = this.getParamNames(type);
if (isArrayFull(param)) {
return param.reduce(
(a, name) => [...a, ...this.getParamValues(this._query[name], parser)],
[],
);
}
return [];
}
private parseValue(val: any) {
try {
const parsed = JSON.parse(val);
if (!isDate(parsed) && isObject(parsed)) {
// throw new Error('Don\'t support object now');
return val;
} else if (
typeof parsed === 'number' &&
parsed.toLocaleString('fullwide', { useGrouping: false }) !== val
) {
// JS cannot handle big numbers. Leave it as a string to prevent data loss
return val;
}
return parsed;
} catch (ignored) {
if (isDateString(val)) {
return new Date(val);
}
return val;
}
}
private parseValues(vals: any) {
if (isArrayFull(vals)) {
return vals.map((v: any) => this.parseValue(v));
} else {
return this.parseValue(vals);
}
}
private fieldsParser(data: string): QueryFields {
return data.split(this._options.delimStr);
}
private parseSearchQueryParam(d: any): SCondition {
try {
if (isNil(d)) {
return undefined;
}
const data = JSON.parse(d);
if (!isObject(data)) {
throw new Error();
}
return data;
} catch (_) {
throw new RequestQueryException('Invalid search param. JSON expected');
}
}
private conditionParser(cond: 'filter' | 'or' | 'search', data: string): QueryFilter {
const isArrayValue = [
'in',
'notin',
'between',
'$in',
'$notin',
'$between',
'$inL',
'$notinL',
];
const isEmptyValue = ['isnull', 'notnull', '$isnull', '$notnull'];
const param = data.split(this._options.delim);
const field = param[0];
const operator = param[1] as ComparisonOperator;
let value = param[2] || '';
if (isArrayValue.some((name) => name === operator)) {
value = value.split(this._options.delimStr) as any;
}
value = this.parseValues(value);
if (!isEmptyValue.some((name) => name === operator) && !hasValue(value)) {
throw new RequestQueryException(`Invalid ${cond} value`);
}
const condition: QueryFilter = { field, operator, value };
validateCondition(condition, cond);
return condition;
}
private joinParser(data: string): QueryJoin {
const param = data.split(this._options.delim);
const join: QueryJoin = {
field: param[0],
select: isStringFull(param[1]) ? param[1].split(this._options.delimStr) : undefined,
};
validateJoin(join);
return join;
}
private sortParser(data: string): QuerySort {
const param = data.split(this._options.delimStr);
const sort: QuerySort = {
field: param[0],
order: param[1] as any,
};
validateSort(sort);
return sort;
}
private numericParser(
num: 'limit' | 'offset' | 'page' | 'cache',
data: string,
): number {
const val = this.parseValue(data);
validateNumeric(val, num);
return val;
}
private paramParser(name: string): QueryFilter {
validateParamOption(this._paramsOptions, name);
const option = this._paramsOptions[name];
if (option.disabled) {
return undefined;
}
let value = this._params[name];
switch (option.type) {
case 'number':
value = this.parseValue(value);
validateNumeric(value, `param ${name}`);
break;
case 'uuid':
validateUUID(value, name);
break;
default:
break;
}
return { field: option.field, operator: '$eq', value };
}
}