strict-qs 8.0.3 → 9.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.
- package/CHANGELOG.md +2 -0
- package/dist/index.d.ts +7 -11
- package/dist/index.js +27 -13
- package/dist/index.js.map +1 -1
- package/dist/index.test.js +102 -48
- package/dist/index.test.js.map +1 -1
- package/package.json +46 -60
- package/src/index.test.ts +160 -109
- package/src/index.ts +41 -41
package/src/index.ts
CHANGED
|
@@ -6,35 +6,33 @@ export const BASE_10 = 10;
|
|
|
6
6
|
|
|
7
7
|
const debug = initDebug('strict-qs');
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
interface QueryPart {
|
|
10
10
|
name: string;
|
|
11
11
|
value: string;
|
|
12
|
-
}
|
|
12
|
+
}
|
|
13
13
|
|
|
14
|
-
export
|
|
14
|
+
export interface QSOptions {
|
|
15
15
|
allowEmptySearch?: boolean;
|
|
16
16
|
allowUnknownParams?: boolean;
|
|
17
17
|
allowDefault?: boolean;
|
|
18
18
|
allowUnorderedParams?: boolean;
|
|
19
|
-
}
|
|
19
|
+
}
|
|
20
20
|
export type QSValue = string | number | boolean;
|
|
21
21
|
export type QSParamValue = QSValue;
|
|
22
22
|
export type QSParamType = 'string' | 'number' | 'boolean';
|
|
23
23
|
|
|
24
|
-
export
|
|
24
|
+
export interface QSUniqueParameter {
|
|
25
25
|
name: string;
|
|
26
|
-
description?: string;
|
|
27
26
|
in: 'query';
|
|
28
27
|
pattern?: string;
|
|
29
28
|
required?: boolean;
|
|
30
29
|
enum?: QSParamValue[];
|
|
31
30
|
type: QSParamType;
|
|
32
31
|
default?: QSParamValue;
|
|
33
|
-
}
|
|
32
|
+
}
|
|
34
33
|
|
|
35
|
-
export
|
|
34
|
+
export interface QSArrayParameter {
|
|
36
35
|
name: string;
|
|
37
|
-
description?: string;
|
|
38
36
|
in: 'query';
|
|
39
37
|
type: 'array';
|
|
40
38
|
required?: boolean;
|
|
@@ -45,13 +43,11 @@ export type QSArrayParameter = {
|
|
|
45
43
|
enum?: QSParamValue[];
|
|
46
44
|
type: QSParamType;
|
|
47
45
|
};
|
|
48
|
-
}
|
|
46
|
+
}
|
|
49
47
|
|
|
50
48
|
export type QSParameter = QSUniqueParameter | QSArrayParameter;
|
|
51
49
|
|
|
52
|
-
export type QSParameterValues =
|
|
53
|
-
[name: string]: QSValue | QSValue[];
|
|
54
|
-
};
|
|
50
|
+
export type QSParameterValues = Record<string, QSValue | QSValue[]>;
|
|
55
51
|
|
|
56
52
|
/**
|
|
57
53
|
* Parse a queryString according to the provided definitions
|
|
@@ -104,13 +100,13 @@ function qsStrict(
|
|
|
104
100
|
return {};
|
|
105
101
|
}
|
|
106
102
|
if (!search.startsWith(SEARCH_FLAG)) {
|
|
107
|
-
throw new YError('E_MALFORMED_SEARCH', search);
|
|
103
|
+
throw new YError('E_MALFORMED_SEARCH', [search]);
|
|
108
104
|
}
|
|
109
105
|
if (search === SEARCH_FLAG) {
|
|
110
106
|
if (options.allowEmptySearch) {
|
|
111
107
|
return {};
|
|
112
108
|
}
|
|
113
|
-
throw new YError('E_EMPTY_SEARCH', search);
|
|
109
|
+
throw new YError('E_EMPTY_SEARCH', [search]);
|
|
114
110
|
}
|
|
115
111
|
|
|
116
112
|
const usefulDefinitions = definitions.filter(swaggerInQueryDefinitions);
|
|
@@ -140,9 +136,9 @@ function qsStrict(
|
|
|
140
136
|
const params = usefulDefinitions.reduce(
|
|
141
137
|
pickupQueryParams.bind(null, options),
|
|
142
138
|
{
|
|
143
|
-
queryStringParams: {},
|
|
139
|
+
queryStringParams: {} as QSParameterValues,
|
|
144
140
|
queryStringPartsLeft: queryStringParts
|
|
145
|
-
.map((queryStringPart) => {
|
|
141
|
+
.map((queryStringPart: QueryPart) => {
|
|
146
142
|
debug('Looking for "' + queryStringPart.name + '" definitions.');
|
|
147
143
|
if (
|
|
148
144
|
!usefulDefinitions.some((definition) => {
|
|
@@ -155,14 +151,13 @@ function qsStrict(
|
|
|
155
151
|
if (options.allowUnknownParams) {
|
|
156
152
|
return null;
|
|
157
153
|
}
|
|
158
|
-
throw new YError(
|
|
159
|
-
'E_UNAUTHORIZED_QUERY_PARAM',
|
|
154
|
+
throw new YError('E_UNAUTHORIZED_QUERY_PARAM', [
|
|
160
155
|
queryStringPart.name,
|
|
161
|
-
);
|
|
156
|
+
]);
|
|
162
157
|
}
|
|
163
158
|
return queryStringPart;
|
|
164
159
|
})
|
|
165
|
-
.filter((identity) => identity),
|
|
160
|
+
.filter((identity) => identity) as QueryPart[],
|
|
166
161
|
},
|
|
167
162
|
).queryStringParams;
|
|
168
163
|
debug('Params computed:', params);
|
|
@@ -171,9 +166,18 @@ function qsStrict(
|
|
|
171
166
|
|
|
172
167
|
function pickupQueryParams(
|
|
173
168
|
options: QSOptions,
|
|
174
|
-
{
|
|
175
|
-
|
|
176
|
-
|
|
169
|
+
{
|
|
170
|
+
queryStringParams,
|
|
171
|
+
queryStringPartsLeft,
|
|
172
|
+
}: {
|
|
173
|
+
queryStringParams: QSParameterValues;
|
|
174
|
+
queryStringPartsLeft: QueryPart[];
|
|
175
|
+
},
|
|
176
|
+
queryParamDefinition: QSParameter,
|
|
177
|
+
): {
|
|
178
|
+
queryStringParams: QSParameterValues;
|
|
179
|
+
queryStringPartsLeft: QueryPart[];
|
|
180
|
+
} {
|
|
177
181
|
const involvedQueryStringParts = queryStringPartsLeft.reduce(
|
|
178
182
|
pickQueryPartsByName.bind(null, queryParamDefinition.name),
|
|
179
183
|
{
|
|
@@ -192,7 +196,7 @@ function pickupQueryParams(
|
|
|
192
196
|
);
|
|
193
197
|
|
|
194
198
|
if (0 === involvedQueryStringParts.length && queryParamDefinition.required) {
|
|
195
|
-
throw new YError('E_REQUIRED_QUERY_PARAM', queryParamDefinition.name);
|
|
199
|
+
throw new YError('E_REQUIRED_QUERY_PARAM', [queryParamDefinition.name]);
|
|
196
200
|
}
|
|
197
201
|
|
|
198
202
|
queryStringParams = involvedQueryStringParts.reduce(
|
|
@@ -227,7 +231,7 @@ function pickQueryPartsByName(
|
|
|
227
231
|
const isNotFoundAtNextIndex = index !== lastIndex + 1;
|
|
228
232
|
|
|
229
233
|
if (isNotFoundAtNextIndex) {
|
|
230
|
-
throw new YError('E_BAD_QUERY_PARAM_POSITION', name, lastIndex, index);
|
|
234
|
+
throw new YError('E_BAD_QUERY_PARAM_POSITION', [name, lastIndex, index]);
|
|
231
235
|
}
|
|
232
236
|
keptQueryParts = keptQueryParts.concat(queryPart);
|
|
233
237
|
lastIndex = index;
|
|
@@ -270,34 +274,31 @@ function assignQueryStringPart(
|
|
|
270
274
|
: 'number' === itemDefinition.type
|
|
271
275
|
? parseReentrantNumber(decodeQueryComponent(queryStringPart.value))
|
|
272
276
|
: (() => {
|
|
273
|
-
throw new YError(
|
|
274
|
-
'E_UNSUPPORTED_TYPE',
|
|
277
|
+
throw new YError('E_UNSUPPORTED_TYPE', [
|
|
275
278
|
queryParamDefinition.name,
|
|
276
279
|
itemDefinition.type,
|
|
277
|
-
);
|
|
280
|
+
]);
|
|
278
281
|
})();
|
|
279
282
|
|
|
280
283
|
if (itemDefinition.default === value && !options.allowDefault) {
|
|
281
|
-
throw new YError(
|
|
282
|
-
'E_CANNOT_SET_TO_DEFAULT',
|
|
284
|
+
throw new YError('E_CANNOT_SET_TO_DEFAULT', [
|
|
283
285
|
queryParamDefinition.name,
|
|
284
286
|
value,
|
|
285
|
-
);
|
|
287
|
+
]);
|
|
286
288
|
}
|
|
287
289
|
|
|
288
290
|
if (itemDefinition.enum && !itemDefinition.enum.includes(value)) {
|
|
289
|
-
throw new YError('E_NOT_IN_ENUM', queryParamDefinition.name, value);
|
|
291
|
+
throw new YError('E_NOT_IN_ENUM', [queryParamDefinition.name, value]);
|
|
290
292
|
}
|
|
291
293
|
|
|
292
294
|
if (
|
|
293
295
|
itemDefinition.pattern &&
|
|
294
296
|
!new RegExp(itemDefinition.pattern).test(value.toString())
|
|
295
297
|
) {
|
|
296
|
-
throw new YError(
|
|
297
|
-
'E_PATTERN_DOES_NOT_MATCH',
|
|
298
|
+
throw new YError('E_PATTERN_DOES_NOT_MATCH', [
|
|
298
299
|
queryParamDefinition.name,
|
|
299
300
|
value,
|
|
300
|
-
);
|
|
301
|
+
]);
|
|
301
302
|
}
|
|
302
303
|
|
|
303
304
|
if ('array' === queryParamDefinition.type) {
|
|
@@ -307,11 +308,10 @@ function assignQueryStringPart(
|
|
|
307
308
|
values.length &&
|
|
308
309
|
values[values.length - 1] > value
|
|
309
310
|
) {
|
|
310
|
-
throw new YError(
|
|
311
|
-
'E_UNORDERED_QUERY_PARAMS',
|
|
311
|
+
throw new YError('E_UNORDERED_QUERY_PARAMS', [
|
|
312
312
|
value,
|
|
313
313
|
values[values.length - 1],
|
|
314
|
-
);
|
|
314
|
+
]);
|
|
315
315
|
}
|
|
316
316
|
values.push(value);
|
|
317
317
|
queryStringParams[queryStringPart.name] = values;
|
|
@@ -325,7 +325,7 @@ export function parseReentrantNumber(str: string): number {
|
|
|
325
325
|
const value = parseFloat(str);
|
|
326
326
|
|
|
327
327
|
if (value.toString(BASE_10) !== str) {
|
|
328
|
-
throw new YError('E_NON_REENTRANT_NUMBER', str, value.toString(BASE_10));
|
|
328
|
+
throw new YError('E_NON_REENTRANT_NUMBER', [str, value.toString(BASE_10)]);
|
|
329
329
|
}
|
|
330
330
|
|
|
331
331
|
return value;
|
|
@@ -337,7 +337,7 @@ export function parseBoolean(str: string): boolean {
|
|
|
337
337
|
} else if ('false' === str) {
|
|
338
338
|
return false;
|
|
339
339
|
}
|
|
340
|
-
throw new YError('E_BAD_BOOLEAN', str);
|
|
340
|
+
throw new YError('E_BAD_BOOLEAN', [str]);
|
|
341
341
|
}
|
|
342
342
|
|
|
343
343
|
export function decodeQueryComponent(value: string): string {
|