strict-qs 6.1.3 → 7.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 +12 -0
- package/README.md +0 -6
- package/dist/index.d.ts +85 -0
- package/dist/index.js +135 -167
- package/dist/index.js.map +1 -1
- package/dist/index.test.d.ts +1 -0
- package/dist/index.test.js +228 -236
- package/dist/index.test.js.map +1 -1
- package/package.json +76 -52
- package/src/{index.test.js → index.test.ts} +35 -31
- package/src/{index.js → index.ts} +88 -36
- package/dist/index.mjs +0 -163
- package/dist/index.mjs.map +0 -1
- package/dist/index.test.mjs +0 -229
- package/dist/index.test.mjs.map +0 -1
- package/src/index.d.ts +0 -47
|
@@ -1,12 +1,57 @@
|
|
|
1
1
|
import initDebug from 'debug';
|
|
2
|
-
import YError from 'yerror';
|
|
2
|
+
import { YError } from 'yerror';
|
|
3
3
|
|
|
4
4
|
export const SEARCH_FLAG = '?';
|
|
5
5
|
export const BASE_10 = 10;
|
|
6
6
|
|
|
7
7
|
const debug = initDebug('strict-qs');
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
type QueryPart = {
|
|
10
|
+
name: string;
|
|
11
|
+
value: string;
|
|
12
|
+
};
|
|
13
|
+
|
|
14
|
+
export type QSOptions = {
|
|
15
|
+
allowEmptySearch?: boolean;
|
|
16
|
+
allowUnknownParams?: boolean;
|
|
17
|
+
allowDefault?: boolean;
|
|
18
|
+
allowUnorderedParams?: boolean;
|
|
19
|
+
};
|
|
20
|
+
export type QSValue = string | number | boolean;
|
|
21
|
+
export type QSParamValue = QSValue;
|
|
22
|
+
export type QSParamType = 'string' | 'number' | 'boolean';
|
|
23
|
+
|
|
24
|
+
export type QSUniqueParameter = {
|
|
25
|
+
name: string;
|
|
26
|
+
description?: string;
|
|
27
|
+
in: 'query';
|
|
28
|
+
pattern?: string;
|
|
29
|
+
required?: boolean;
|
|
30
|
+
enum?: QSParamValue[];
|
|
31
|
+
type: QSParamType;
|
|
32
|
+
default?: QSParamValue;
|
|
33
|
+
};
|
|
34
|
+
|
|
35
|
+
export type QSArrayParameter = {
|
|
36
|
+
name: string;
|
|
37
|
+
description?: string;
|
|
38
|
+
in: 'query';
|
|
39
|
+
type: 'array';
|
|
40
|
+
required?: boolean;
|
|
41
|
+
ordered?: boolean;
|
|
42
|
+
default?: QSParamValue[];
|
|
43
|
+
items: {
|
|
44
|
+
pattern?: string;
|
|
45
|
+
enum?: QSParamValue[];
|
|
46
|
+
type: QSParamType;
|
|
47
|
+
};
|
|
48
|
+
};
|
|
49
|
+
|
|
50
|
+
export type QSParameter = QSUniqueParameter | QSArrayParameter;
|
|
51
|
+
|
|
52
|
+
export type QSParameterValues = {
|
|
53
|
+
[name: string]: QSValue | QSValue[];
|
|
54
|
+
};
|
|
10
55
|
|
|
11
56
|
/**
|
|
12
57
|
* Parse a queryString according to the provided definitions
|
|
@@ -49,18 +94,23 @@ export default qsStrict;
|
|
|
49
94
|
* // pages: [0, 1, 2], // eslint-disable-line
|
|
50
95
|
* // }
|
|
51
96
|
*/
|
|
52
|
-
|
|
97
|
+
|
|
98
|
+
function qsStrict(
|
|
99
|
+
options: QSOptions,
|
|
100
|
+
definitions: QSParameter[],
|
|
101
|
+
search: string,
|
|
102
|
+
): QSParameterValues {
|
|
53
103
|
if (!search) {
|
|
54
104
|
return {};
|
|
55
105
|
}
|
|
56
106
|
if (!search.startsWith(SEARCH_FLAG)) {
|
|
57
|
-
throw new
|
|
107
|
+
throw new YError('E_MALFORMED_SEARCH', search);
|
|
58
108
|
}
|
|
59
109
|
if (search === SEARCH_FLAG) {
|
|
60
110
|
if (options.allowEmptySearch) {
|
|
61
111
|
return {};
|
|
62
112
|
}
|
|
63
|
-
throw new
|
|
113
|
+
throw new YError('E_EMPTY_SEARCH', search);
|
|
64
114
|
}
|
|
65
115
|
|
|
66
116
|
const usefulDefinitions = definitions.filter(swaggerInQueryDefinitions);
|
|
@@ -75,7 +125,7 @@ function qsStrict(options, definitions, search) {
|
|
|
75
125
|
(queryStringPart) => queryStringPart.name === definition.name,
|
|
76
126
|
),
|
|
77
127
|
],
|
|
78
|
-
[],
|
|
128
|
+
[] as QueryPart[],
|
|
79
129
|
)
|
|
80
130
|
.concat(
|
|
81
131
|
queryStringParts.filter(
|
|
@@ -120,7 +170,7 @@ function qsStrict(options, definitions, search) {
|
|
|
120
170
|
}
|
|
121
171
|
|
|
122
172
|
function pickupQueryParams(
|
|
123
|
-
options,
|
|
173
|
+
options: QSOptions,
|
|
124
174
|
{ queryStringParams, queryStringPartsLeft },
|
|
125
175
|
queryParamDefinition,
|
|
126
176
|
) {
|
|
@@ -165,11 +215,14 @@ function pickupQueryParams(
|
|
|
165
215
|
}
|
|
166
216
|
|
|
167
217
|
function pickQueryPartsByName(
|
|
168
|
-
name,
|
|
169
|
-
{
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
218
|
+
name: string,
|
|
219
|
+
{
|
|
220
|
+
lastIndex,
|
|
221
|
+
keptQueryParts,
|
|
222
|
+
}: { lastIndex: number; keptQueryParts: QueryPart[] },
|
|
223
|
+
queryPart: QueryPart,
|
|
224
|
+
index: number,
|
|
225
|
+
): { lastIndex: number; keptQueryParts: QueryPart[] } {
|
|
173
226
|
if (queryPart.name === name) {
|
|
174
227
|
const isNotFoundAtNextIndex = index !== lastIndex + 1;
|
|
175
228
|
|
|
@@ -182,11 +235,11 @@ function pickQueryPartsByName(
|
|
|
182
235
|
return { lastIndex, keptQueryParts };
|
|
183
236
|
}
|
|
184
237
|
|
|
185
|
-
function swaggerInQueryDefinitions(definition) {
|
|
238
|
+
function swaggerInQueryDefinitions(definition: QSParameter): boolean {
|
|
186
239
|
return !definition.in || 'query' === definition.in;
|
|
187
240
|
}
|
|
188
241
|
|
|
189
|
-
function getQueryStringParts(queryString) {
|
|
242
|
+
function getQueryStringParts(queryString: string): QueryPart[] {
|
|
190
243
|
return queryString
|
|
191
244
|
.split('&')
|
|
192
245
|
.map((queryStringChunk) => queryStringChunk.split('='))
|
|
@@ -197,17 +250,18 @@ function getQueryStringParts(queryString) {
|
|
|
197
250
|
}
|
|
198
251
|
|
|
199
252
|
function assignQueryStringPart(
|
|
200
|
-
options,
|
|
201
|
-
queryParamDefinition,
|
|
202
|
-
queryStringParams,
|
|
203
|
-
queryStringPart,
|
|
204
|
-
) {
|
|
253
|
+
options: QSOptions,
|
|
254
|
+
queryParamDefinition: QSParameter,
|
|
255
|
+
queryStringParams: QSParameterValues,
|
|
256
|
+
queryStringPart: QueryPart,
|
|
257
|
+
): QSParameterValues {
|
|
205
258
|
// Supporting only a subset of JSON schema core
|
|
206
259
|
// http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2
|
|
207
|
-
const itemDefinition =
|
|
260
|
+
const itemDefinition = (
|
|
208
261
|
'array' === queryParamDefinition.type
|
|
209
262
|
? queryParamDefinition.items
|
|
210
|
-
: queryParamDefinition
|
|
263
|
+
: queryParamDefinition
|
|
264
|
+
) as QSUniqueParameter;
|
|
211
265
|
const value =
|
|
212
266
|
'string' === itemDefinition.type
|
|
213
267
|
? decodeQueryComponent(queryStringPart.value)
|
|
@@ -237,7 +291,7 @@ function assignQueryStringPart(
|
|
|
237
291
|
|
|
238
292
|
if (
|
|
239
293
|
itemDefinition.pattern &&
|
|
240
|
-
!new RegExp(itemDefinition.pattern).test(value)
|
|
294
|
+
!new RegExp(itemDefinition.pattern).test(value.toString())
|
|
241
295
|
) {
|
|
242
296
|
throw new YError(
|
|
243
297
|
'E_PATTERN_DOES_NOT_MATCH',
|
|
@@ -247,32 +301,28 @@ function assignQueryStringPart(
|
|
|
247
301
|
}
|
|
248
302
|
|
|
249
303
|
if ('array' === queryParamDefinition.type) {
|
|
250
|
-
queryStringParams[queryStringPart.name]
|
|
251
|
-
queryStringParams[queryStringPart.name] || [];
|
|
304
|
+
const values = (queryStringParams[queryStringPart.name] || []) as QSValue[];
|
|
252
305
|
if (
|
|
253
306
|
queryParamDefinition.ordered &&
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
queryStringParams[queryStringPart.name].length - 1
|
|
257
|
-
] > value
|
|
307
|
+
values.length &&
|
|
308
|
+
values[values.length - 1] > value
|
|
258
309
|
) {
|
|
259
310
|
throw new YError(
|
|
260
311
|
'E_UNORDERED_QUERY_PARAMS',
|
|
261
312
|
value,
|
|
262
|
-
|
|
263
|
-
queryStringParams[queryStringPart.name].length - 1
|
|
264
|
-
],
|
|
313
|
+
values[values.length - 1],
|
|
265
314
|
);
|
|
266
315
|
}
|
|
267
|
-
|
|
316
|
+
values.push(value);
|
|
317
|
+
queryStringParams[queryStringPart.name] = values;
|
|
268
318
|
} else {
|
|
269
319
|
queryStringParams[queryStringPart.name] = value;
|
|
270
320
|
}
|
|
271
321
|
return queryStringParams;
|
|
272
322
|
}
|
|
273
323
|
|
|
274
|
-
export function parseReentrantNumber(str) {
|
|
275
|
-
const value = parseFloat(str
|
|
324
|
+
export function parseReentrantNumber(str: string): number {
|
|
325
|
+
const value = parseFloat(str);
|
|
276
326
|
|
|
277
327
|
if (value.toString(BASE_10) !== str) {
|
|
278
328
|
throw new YError('E_NON_REENTRANT_NUMBER', str, value.toString(BASE_10));
|
|
@@ -281,7 +331,7 @@ export function parseReentrantNumber(str) {
|
|
|
281
331
|
return value;
|
|
282
332
|
}
|
|
283
333
|
|
|
284
|
-
export function parseBoolean(str) {
|
|
334
|
+
export function parseBoolean(str: string): boolean {
|
|
285
335
|
if ('true' === str) {
|
|
286
336
|
return true;
|
|
287
337
|
} else if ('false' === str) {
|
|
@@ -290,6 +340,8 @@ export function parseBoolean(str) {
|
|
|
290
340
|
throw new YError('E_BAD_BOOLEAN', str);
|
|
291
341
|
}
|
|
292
342
|
|
|
293
|
-
export function decodeQueryComponent(value) {
|
|
343
|
+
export function decodeQueryComponent(value: string): string {
|
|
294
344
|
return decodeURIComponent(value.replace(/\+/g, '%20'));
|
|
295
345
|
}
|
|
346
|
+
|
|
347
|
+
export { qsStrict };
|
package/dist/index.mjs
DELETED
|
@@ -1,163 +0,0 @@
|
|
|
1
|
-
import initDebug from 'debug';
|
|
2
|
-
import YError from 'yerror';
|
|
3
|
-
export const SEARCH_FLAG = '?';
|
|
4
|
-
export const BASE_10 = 10;
|
|
5
|
-
const debug = initDebug('strict-qs');
|
|
6
|
-
export default qsStrict;
|
|
7
|
-
|
|
8
|
-
function qsStrict(options, definitions, search) {
|
|
9
|
-
if (!search) {
|
|
10
|
-
return {};
|
|
11
|
-
}
|
|
12
|
-
|
|
13
|
-
if (!search.startsWith(SEARCH_FLAG)) {
|
|
14
|
-
throw new Error('E_MALFORMED_SEARCH', search);
|
|
15
|
-
}
|
|
16
|
-
|
|
17
|
-
if (search === SEARCH_FLAG) {
|
|
18
|
-
if (options.allowEmptySearch) {
|
|
19
|
-
return {};
|
|
20
|
-
}
|
|
21
|
-
|
|
22
|
-
throw new Error('E_EMPTY_SEARCH', search);
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
const usefulDefinitions = definitions.filter(swaggerInQueryDefinitions);
|
|
26
|
-
let queryStringParts = getQueryStringParts(search.slice(1));
|
|
27
|
-
|
|
28
|
-
if (options.allowUnorderedParams) {
|
|
29
|
-
queryStringParts = definitions.reduce((sortedParts, definition) => [...sortedParts, ...queryStringParts.filter(queryStringPart => queryStringPart.name === definition.name)], []).concat(queryStringParts.filter(queryStringPart => !definitions.some(definition => queryStringPart.name === definition.name)));
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
const params = usefulDefinitions.reduce(pickupQueryParams.bind(null, options), {
|
|
33
|
-
queryStringParams: {},
|
|
34
|
-
queryStringPartsLeft: queryStringParts.map(queryStringPart => {
|
|
35
|
-
debug('Looking for "' + queryStringPart.name + '" definitions.');
|
|
36
|
-
|
|
37
|
-
if (!usefulDefinitions.some(definition => {
|
|
38
|
-
const found = queryStringPart.name === definition.name;
|
|
39
|
-
debug('Definition found.', definition);
|
|
40
|
-
return found;
|
|
41
|
-
})) {
|
|
42
|
-
if (options.allowUnknownParams) {
|
|
43
|
-
return null;
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
throw new YError('E_UNAUTHORIZED_QUERY_PARAM', queryStringPart.name);
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
return queryStringPart;
|
|
50
|
-
}).filter(identity => identity)
|
|
51
|
-
}).queryStringParams;
|
|
52
|
-
debug('Params computed:', params);
|
|
53
|
-
return params;
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
function pickupQueryParams(options, {
|
|
57
|
-
queryStringParams,
|
|
58
|
-
queryStringPartsLeft
|
|
59
|
-
}, queryParamDefinition) {
|
|
60
|
-
const involvedQueryStringParts = queryStringPartsLeft.reduce(pickQueryPartsByName.bind(null, queryParamDefinition.name), {
|
|
61
|
-
lastIndex: -1,
|
|
62
|
-
keptQueryParts: []
|
|
63
|
-
}).keptQueryParts;
|
|
64
|
-
debug('Found ' + involvedQueryStringParts.length + ' values for ' + queryParamDefinition.name + '.', involvedQueryStringParts);
|
|
65
|
-
|
|
66
|
-
if (0 === involvedQueryStringParts.length && queryParamDefinition.required) {
|
|
67
|
-
throw new YError('E_REQUIRED_QUERY_PARAM', queryParamDefinition.name);
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
queryStringParams = involvedQueryStringParts.reduce((queryStringParams, queryStringPart) => assignQueryStringPart(options, queryParamDefinition, queryStringParams, queryStringPart), queryStringParams);
|
|
71
|
-
return {
|
|
72
|
-
queryStringParams,
|
|
73
|
-
queryStringPartsLeft: queryStringPartsLeft.slice(involvedQueryStringParts.length)
|
|
74
|
-
};
|
|
75
|
-
}
|
|
76
|
-
|
|
77
|
-
function pickQueryPartsByName(name, {
|
|
78
|
-
lastIndex,
|
|
79
|
-
keptQueryParts
|
|
80
|
-
}, queryPart, index) {
|
|
81
|
-
if (queryPart.name === name) {
|
|
82
|
-
const isNotFoundAtNextIndex = index !== lastIndex + 1;
|
|
83
|
-
|
|
84
|
-
if (isNotFoundAtNextIndex) {
|
|
85
|
-
throw new YError('E_BAD_QUERY_PARAM_POSITION', name, lastIndex, index);
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
keptQueryParts = keptQueryParts.concat(queryPart);
|
|
89
|
-
lastIndex = index;
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
return {
|
|
93
|
-
lastIndex,
|
|
94
|
-
keptQueryParts
|
|
95
|
-
};
|
|
96
|
-
}
|
|
97
|
-
|
|
98
|
-
function swaggerInQueryDefinitions(definition) {
|
|
99
|
-
return !definition.in || 'query' === definition.in;
|
|
100
|
-
}
|
|
101
|
-
|
|
102
|
-
function getQueryStringParts(queryString) {
|
|
103
|
-
return queryString.split('&').map(queryStringChunk => queryStringChunk.split('=')).map(([queryPartName, queryPartValue]) => ({
|
|
104
|
-
name: queryPartName,
|
|
105
|
-
value: queryPartValue
|
|
106
|
-
}));
|
|
107
|
-
}
|
|
108
|
-
|
|
109
|
-
function assignQueryStringPart(options, queryParamDefinition, queryStringParams, queryStringPart) {
|
|
110
|
-
const itemDefinition = 'array' === queryParamDefinition.type ? queryParamDefinition.items : queryParamDefinition;
|
|
111
|
-
const value = 'string' === itemDefinition.type ? decodeQueryComponent(queryStringPart.value) : 'boolean' === itemDefinition.type ? parseBoolean(decodeQueryComponent(queryStringPart.value)) : 'number' === itemDefinition.type ? parseReentrantNumber(decodeQueryComponent(queryStringPart.value)) : (() => {
|
|
112
|
-
throw new YError('E_UNSUPPORTED_TYPE', queryParamDefinition.name, itemDefinition.type);
|
|
113
|
-
})();
|
|
114
|
-
|
|
115
|
-
if (itemDefinition.default === value && !options.allowDefault) {
|
|
116
|
-
throw new YError('E_CANNOT_SET_TO_DEFAULT', queryParamDefinition.name, value);
|
|
117
|
-
}
|
|
118
|
-
|
|
119
|
-
if (itemDefinition.enum && !itemDefinition.enum.includes(value)) {
|
|
120
|
-
throw new YError('E_NOT_IN_ENUM', queryParamDefinition.name, value);
|
|
121
|
-
}
|
|
122
|
-
|
|
123
|
-
if (itemDefinition.pattern && !new RegExp(itemDefinition.pattern).test(value)) {
|
|
124
|
-
throw new YError('E_PATTERN_DOES_NOT_MATCH', queryParamDefinition.name, value);
|
|
125
|
-
}
|
|
126
|
-
|
|
127
|
-
if ('array' === queryParamDefinition.type) {
|
|
128
|
-
queryStringParams[queryStringPart.name] = queryStringParams[queryStringPart.name] || [];
|
|
129
|
-
|
|
130
|
-
if (queryParamDefinition.ordered && queryStringParams[queryStringPart.name].length && queryStringParams[queryStringPart.name][queryStringParams[queryStringPart.name].length - 1] > value) {
|
|
131
|
-
throw new YError('E_UNORDERED_QUERY_PARAMS', value, queryStringParams[queryStringPart.name][queryStringParams[queryStringPart.name].length - 1]);
|
|
132
|
-
}
|
|
133
|
-
|
|
134
|
-
queryStringParams[queryStringPart.name].push(value);
|
|
135
|
-
} else {
|
|
136
|
-
queryStringParams[queryStringPart.name] = value;
|
|
137
|
-
}
|
|
138
|
-
|
|
139
|
-
return queryStringParams;
|
|
140
|
-
}
|
|
141
|
-
|
|
142
|
-
export function parseReentrantNumber(str) {
|
|
143
|
-
const value = parseFloat(str, BASE_10);
|
|
144
|
-
|
|
145
|
-
if (value.toString(BASE_10) !== str) {
|
|
146
|
-
throw new YError('E_NON_REENTRANT_NUMBER', str, value.toString(BASE_10));
|
|
147
|
-
}
|
|
148
|
-
|
|
149
|
-
return value;
|
|
150
|
-
}
|
|
151
|
-
export function parseBoolean(str) {
|
|
152
|
-
if ('true' === str) {
|
|
153
|
-
return true;
|
|
154
|
-
} else if ('false' === str) {
|
|
155
|
-
return false;
|
|
156
|
-
}
|
|
157
|
-
|
|
158
|
-
throw new YError('E_BAD_BOOLEAN', str);
|
|
159
|
-
}
|
|
160
|
-
export function decodeQueryComponent(value) {
|
|
161
|
-
return decodeURIComponent(value.replace(/\+/g, '%20'));
|
|
162
|
-
}
|
|
163
|
-
//# sourceMappingURL=index.mjs.map
|
package/dist/index.mjs.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.js"],"names":["initDebug","YError","SEARCH_FLAG","BASE_10","debug","qsStrict","options","definitions","search","startsWith","Error","allowEmptySearch","usefulDefinitions","filter","swaggerInQueryDefinitions","queryStringParts","getQueryStringParts","slice","allowUnorderedParams","reduce","sortedParts","definition","queryStringPart","name","concat","some","params","pickupQueryParams","bind","queryStringParams","queryStringPartsLeft","map","found","allowUnknownParams","identity","queryParamDefinition","involvedQueryStringParts","pickQueryPartsByName","lastIndex","keptQueryParts","length","required","assignQueryStringPart","queryPart","index","isNotFoundAtNextIndex","in","queryString","split","queryStringChunk","queryPartName","queryPartValue","value","itemDefinition","type","items","decodeQueryComponent","parseBoolean","parseReentrantNumber","default","allowDefault","enum","includes","pattern","RegExp","test","ordered","push","str","parseFloat","toString","decodeURIComponent","replace"],"mappings":"AAAA,OAAOA,SAAP,MAAsB,OAAtB;AACA,OAAOC,MAAP,MAAmB,QAAnB;AAEA,OAAO,MAAMC,WAAW,GAAG,GAApB;AACP,OAAO,MAAMC,OAAO,GAAG,EAAhB;AAEP,MAAMC,KAAK,GAAGJ,SAAS,CAAC,WAAD,CAAvB;AAEA,eAAeK,QAAf;;AA2CA,SAASA,QAAT,CAAkBC,OAAlB,EAA2BC,WAA3B,EAAwCC,MAAxC,EAAgD;AAC9C,MAAI,CAACA,MAAL,EAAa;AACX,WAAO,EAAP;AACD;;AACD,MAAI,CAACA,MAAM,CAACC,UAAP,CAAkBP,WAAlB,CAAL,EAAqC;AACnC,UAAM,IAAIQ,KAAJ,CAAU,oBAAV,EAAgCF,MAAhC,CAAN;AACD;;AACD,MAAIA,MAAM,KAAKN,WAAf,EAA4B;AAC1B,QAAII,OAAO,CAACK,gBAAZ,EAA8B;AAC5B,aAAO,EAAP;AACD;;AACD,UAAM,IAAID,KAAJ,CAAU,gBAAV,EAA4BF,MAA5B,CAAN;AACD;;AAED,QAAMI,iBAAiB,GAAGL,WAAW,CAACM,MAAZ,CAAmBC,yBAAnB,CAA1B;AACA,MAAIC,gBAAgB,GAAGC,mBAAmB,CAACR,MAAM,CAACS,KAAP,CAAa,CAAb,CAAD,CAA1C;;AAEA,MAAIX,OAAO,CAACY,oBAAZ,EAAkC;AAChCH,IAAAA,gBAAgB,GAAGR,WAAW,CAC3BY,MADgB,CAEf,CAACC,WAAD,EAAcC,UAAd,KAA6B,CAC3B,GAAGD,WADwB,EAE3B,GAAGL,gBAAgB,CAACF,MAAjB,CACAS,eAAD,IAAqBA,eAAe,CAACC,IAAhB,KAAyBF,UAAU,CAACE,IADxD,CAFwB,CAFd,EAQf,EARe,EAUhBC,MAVgB,CAWfT,gBAAgB,CAACF,MAAjB,CACGS,eAAD,IACE,CAACf,WAAW,CAACkB,IAAZ,CACEJ,UAAD,IAAgBC,eAAe,CAACC,IAAhB,KAAyBF,UAAU,CAACE,IADrD,CAFL,CAXe,CAAnB;AAkBD;;AAED,QAAMG,MAAM,GAAGd,iBAAiB,CAACO,MAAlB,CACbQ,iBAAiB,CAACC,IAAlB,CAAuB,IAAvB,EAA6BtB,OAA7B,CADa,EAEb;AACEuB,IAAAA,iBAAiB,EAAE,EADrB;AAEEC,IAAAA,oBAAoB,EAAEf,gBAAgB,CACnCgB,GADmB,CACdT,eAAD,IAAqB;AACxBlB,MAAAA,KAAK,CAAC,kBAAkBkB,eAAe,CAACC,IAAlC,GAAyC,gBAA1C,CAAL;;AACA,UACE,CAACX,iBAAiB,CAACa,IAAlB,CAAwBJ,UAAD,IAAgB;AACtC,cAAMW,KAAK,GAAGV,eAAe,CAACC,IAAhB,KAAyBF,UAAU,CAACE,IAAlD;AAEAnB,QAAAA,KAAK,CAAC,mBAAD,EAAsBiB,UAAtB,CAAL;AACA,eAAOW,KAAP;AACD,OALA,CADH,EAOE;AACA,YAAI1B,OAAO,CAAC2B,kBAAZ,EAAgC;AAC9B,iBAAO,IAAP;AACD;;AACD,cAAM,IAAIhC,MAAJ,CACJ,4BADI,EAEJqB,eAAe,CAACC,IAFZ,CAAN;AAID;;AACD,aAAOD,eAAP;AACD,KApBmB,EAqBnBT,MArBmB,CAqBXqB,QAAD,IAAcA,QArBF;AAFxB,GAFa,EA2BbL,iBA3BF;AA4BAzB,EAAAA,KAAK,CAAC,kBAAD,EAAqBsB,MAArB,CAAL;AACA,SAAOA,MAAP;AACD;;AAED,SAASC,iBAAT,CACErB,OADF,EAEE;AAAEuB,EAAAA,iBAAF;AAAqBC,EAAAA;AAArB,CAFF,EAGEK,oBAHF,EAIE;AACA,QAAMC,wBAAwB,GAAGN,oBAAoB,CAACX,MAArB,CAC/BkB,oBAAoB,CAACT,IAArB,CAA0B,IAA1B,EAAgCO,oBAAoB,CAACZ,IAArD,CAD+B,EAE/B;AACEe,IAAAA,SAAS,EAAE,CAAC,CADd;AAEEC,IAAAA,cAAc,EAAE;AAFlB,GAF+B,EAM/BA,cANF;AAQAnC,EAAAA,KAAK,CACH,WACEgC,wBAAwB,CAACI,MAD3B,GAEE,cAFF,GAGEL,oBAAoB,CAACZ,IAHvB,GAIE,GALC,EAMHa,wBANG,CAAL;;AASA,MAAI,MAAMA,wBAAwB,CAACI,MAA/B,IAAyCL,oBAAoB,CAACM,QAAlE,EAA4E;AAC1E,UAAM,IAAIxC,MAAJ,CAAW,wBAAX,EAAqCkC,oBAAoB,CAACZ,IAA1D,CAAN;AACD;;AAEDM,EAAAA,iBAAiB,GAAGO,wBAAwB,CAACjB,MAAzB,CAClB,CAACU,iBAAD,EAAoBP,eAApB,KACEoB,qBAAqB,CACnBpC,OADmB,EAEnB6B,oBAFmB,EAGnBN,iBAHmB,EAInBP,eAJmB,CAFL,EAQlBO,iBARkB,CAApB;AAWA,SAAO;AACLA,IAAAA,iBADK;AAELC,IAAAA,oBAAoB,EAAEA,oBAAoB,CAACb,KAArB,CACpBmB,wBAAwB,CAACI,MADL;AAFjB,GAAP;AAMD;;AAED,SAASH,oBAAT,CACEd,IADF,EAEE;AAAEe,EAAAA,SAAF;AAAaC,EAAAA;AAAb,CAFF,EAGEI,SAHF,EAIEC,KAJF,EAKE;AACA,MAAID,SAAS,CAACpB,IAAV,KAAmBA,IAAvB,EAA6B;AAC3B,UAAMsB,qBAAqB,GAAGD,KAAK,KAAKN,SAAS,GAAG,CAApD;;AAEA,QAAIO,qBAAJ,EAA2B;AACzB,YAAM,IAAI5C,MAAJ,CAAW,4BAAX,EAAyCsB,IAAzC,EAA+Ce,SAA/C,EAA0DM,KAA1D,CAAN;AACD;;AACDL,IAAAA,cAAc,GAAGA,cAAc,CAACf,MAAf,CAAsBmB,SAAtB,CAAjB;AACAL,IAAAA,SAAS,GAAGM,KAAZ;AACD;;AACD,SAAO;AAAEN,IAAAA,SAAF;AAAaC,IAAAA;AAAb,GAAP;AACD;;AAED,SAASzB,yBAAT,CAAmCO,UAAnC,EAA+C;AAC7C,SAAO,CAACA,UAAU,CAACyB,EAAZ,IAAkB,YAAYzB,UAAU,CAACyB,EAAhD;AACD;;AAED,SAAS9B,mBAAT,CAA6B+B,WAA7B,EAA0C;AACxC,SAAOA,WAAW,CACfC,KADI,CACE,GADF,EAEJjB,GAFI,CAECkB,gBAAD,IAAsBA,gBAAgB,CAACD,KAAjB,CAAuB,GAAvB,CAFtB,EAGJjB,GAHI,CAGA,CAAC,CAACmB,aAAD,EAAgBC,cAAhB,CAAD,MAAsC;AACzC5B,IAAAA,IAAI,EAAE2B,aADmC;AAEzCE,IAAAA,KAAK,EAAED;AAFkC,GAAtC,CAHA,CAAP;AAOD;;AAED,SAAST,qBAAT,CACEpC,OADF,EAEE6B,oBAFF,EAGEN,iBAHF,EAIEP,eAJF,EAKE;AAGA,QAAM+B,cAAc,GAClB,YAAYlB,oBAAoB,CAACmB,IAAjC,GACInB,oBAAoB,CAACoB,KADzB,GAEIpB,oBAHN;AAIA,QAAMiB,KAAK,GACT,aAAaC,cAAc,CAACC,IAA5B,GACIE,oBAAoB,CAAClC,eAAe,CAAC8B,KAAjB,CADxB,GAEI,cAAcC,cAAc,CAACC,IAA7B,GACAG,YAAY,CAACD,oBAAoB,CAAClC,eAAe,CAAC8B,KAAjB,CAArB,CADZ,GAEA,aAAaC,cAAc,CAACC,IAA5B,GACAI,oBAAoB,CAACF,oBAAoB,CAAClC,eAAe,CAAC8B,KAAjB,CAArB,CADpB,GAEA,CAAC,MAAM;AACL,UAAM,IAAInD,MAAJ,CACJ,oBADI,EAEJkC,oBAAoB,CAACZ,IAFjB,EAGJ8B,cAAc,CAACC,IAHX,CAAN;AAKD,GAND,GAPN;;AAeA,MAAID,cAAc,CAACM,OAAf,KAA2BP,KAA3B,IAAoC,CAAC9C,OAAO,CAACsD,YAAjD,EAA+D;AAC7D,UAAM,IAAI3D,MAAJ,CACJ,yBADI,EAEJkC,oBAAoB,CAACZ,IAFjB,EAGJ6B,KAHI,CAAN;AAKD;;AAED,MAAIC,cAAc,CAACQ,IAAf,IAAuB,CAACR,cAAc,CAACQ,IAAf,CAAoBC,QAApB,CAA6BV,KAA7B,CAA5B,EAAiE;AAC/D,UAAM,IAAInD,MAAJ,CAAW,eAAX,EAA4BkC,oBAAoB,CAACZ,IAAjD,EAAuD6B,KAAvD,CAAN;AACD;;AAED,MACEC,cAAc,CAACU,OAAf,IACA,CAAC,IAAIC,MAAJ,CAAWX,cAAc,CAACU,OAA1B,EAAmCE,IAAnC,CAAwCb,KAAxC,CAFH,EAGE;AACA,UAAM,IAAInD,MAAJ,CACJ,0BADI,EAEJkC,oBAAoB,CAACZ,IAFjB,EAGJ6B,KAHI,CAAN;AAKD;;AAED,MAAI,YAAYjB,oBAAoB,CAACmB,IAArC,EAA2C;AACzCzB,IAAAA,iBAAiB,CAACP,eAAe,CAACC,IAAjB,CAAjB,GACEM,iBAAiB,CAACP,eAAe,CAACC,IAAjB,CAAjB,IAA2C,EAD7C;;AAEA,QACEY,oBAAoB,CAAC+B,OAArB,IACArC,iBAAiB,CAACP,eAAe,CAACC,IAAjB,CAAjB,CAAwCiB,MADxC,IAEAX,iBAAiB,CAACP,eAAe,CAACC,IAAjB,CAAjB,CACEM,iBAAiB,CAACP,eAAe,CAACC,IAAjB,CAAjB,CAAwCiB,MAAxC,GAAiD,CADnD,IAEIY,KALN,EAME;AACA,YAAM,IAAInD,MAAJ,CACJ,0BADI,EAEJmD,KAFI,EAGJvB,iBAAiB,CAACP,eAAe,CAACC,IAAjB,CAAjB,CACEM,iBAAiB,CAACP,eAAe,CAACC,IAAjB,CAAjB,CAAwCiB,MAAxC,GAAiD,CADnD,CAHI,CAAN;AAOD;;AACDX,IAAAA,iBAAiB,CAACP,eAAe,CAACC,IAAjB,CAAjB,CAAwC4C,IAAxC,CAA6Cf,KAA7C;AACD,GAnBD,MAmBO;AACLvB,IAAAA,iBAAiB,CAACP,eAAe,CAACC,IAAjB,CAAjB,GAA0C6B,KAA1C;AACD;;AACD,SAAOvB,iBAAP;AACD;;AAED,OAAO,SAAS6B,oBAAT,CAA8BU,GAA9B,EAAmC;AACxC,QAAMhB,KAAK,GAAGiB,UAAU,CAACD,GAAD,EAAMjE,OAAN,CAAxB;;AAEA,MAAIiD,KAAK,CAACkB,QAAN,CAAenE,OAAf,MAA4BiE,GAAhC,EAAqC;AACnC,UAAM,IAAInE,MAAJ,CAAW,wBAAX,EAAqCmE,GAArC,EAA0ChB,KAAK,CAACkB,QAAN,CAAenE,OAAf,CAA1C,CAAN;AACD;;AAED,SAAOiD,KAAP;AACD;AAED,OAAO,SAASK,YAAT,CAAsBW,GAAtB,EAA2B;AAChC,MAAI,WAAWA,GAAf,EAAoB;AAClB,WAAO,IAAP;AACD,GAFD,MAEO,IAAI,YAAYA,GAAhB,EAAqB;AAC1B,WAAO,KAAP;AACD;;AACD,QAAM,IAAInE,MAAJ,CAAW,eAAX,EAA4BmE,GAA5B,CAAN;AACD;AAED,OAAO,SAASZ,oBAAT,CAA8BJ,KAA9B,EAAqC;AAC1C,SAAOmB,kBAAkB,CAACnB,KAAK,CAACoB,OAAN,CAAc,KAAd,EAAqB,KAArB,CAAD,CAAzB;AACD","sourcesContent":["import initDebug from 'debug';\nimport YError from 'yerror';\n\nexport const SEARCH_FLAG = '?';\nexport const BASE_10 = 10;\n\nconst debug = initDebug('strict-qs');\n\nexport default qsStrict;\n\n/**\n * Parse a queryString according to the provided definitions\n * @param {Object} options\n * Parser options\n * @param {Boolean} options.allowEmptySearch\n * Avoid throwing when the search is empty\n * @param {Boolean} options.allowUnknownParams\n * Avoid throwing when some params are unknown\n * @param {Boolean} options.allowDefault\n * Avoid throwing when some params is set to its default value\n * @param {Boolean} options.allowUnorderedParams\n * Avoid throwing when params are not set in the same order\n * than declarations\n * @param {Array} definitions\n * Swagger compatible list of defitions\n * @param {string} search\n * The actual query string to parse\n * @return {Object}\n * The parsed properties\n * @example\n *\n * import qs from 'strict-qs';\n *\n * const qsOptions = { allowEmptySearch: true };\n * const qsDefinition = [{\n * name: 'pages',\n * in: 'query',\n * type: 'array',\n * items: {\n * type: 'number',\n * },\n * ordered: true,\n * description: 'The pages to print',\n *}];\n *\n * qs(qsOptions, qsDefinition, '?pages=0&pages=1&pages=2');\n * // Returns:\n * // {\n * // pages: [0, 1, 2], // eslint-disable-line\n * // }\n */\nfunction qsStrict(options, definitions, search) {\n if (!search) {\n return {};\n }\n if (!search.startsWith(SEARCH_FLAG)) {\n throw new Error('E_MALFORMED_SEARCH', search);\n }\n if (search === SEARCH_FLAG) {\n if (options.allowEmptySearch) {\n return {};\n }\n throw new Error('E_EMPTY_SEARCH', search);\n }\n\n const usefulDefinitions = definitions.filter(swaggerInQueryDefinitions);\n let queryStringParts = getQueryStringParts(search.slice(1));\n\n if (options.allowUnorderedParams) {\n queryStringParts = definitions\n .reduce(\n (sortedParts, definition) => [\n ...sortedParts,\n ...queryStringParts.filter(\n (queryStringPart) => queryStringPart.name === definition.name,\n ),\n ],\n [],\n )\n .concat(\n queryStringParts.filter(\n (queryStringPart) =>\n !definitions.some(\n (definition) => queryStringPart.name === definition.name,\n ),\n ),\n );\n }\n\n const params = usefulDefinitions.reduce(\n pickupQueryParams.bind(null, options),\n {\n queryStringParams: {},\n queryStringPartsLeft: queryStringParts\n .map((queryStringPart) => {\n debug('Looking for \"' + queryStringPart.name + '\" definitions.');\n if (\n !usefulDefinitions.some((definition) => {\n const found = queryStringPart.name === definition.name;\n\n debug('Definition found.', definition);\n return found;\n })\n ) {\n if (options.allowUnknownParams) {\n return null;\n }\n throw new YError(\n 'E_UNAUTHORIZED_QUERY_PARAM',\n queryStringPart.name,\n );\n }\n return queryStringPart;\n })\n .filter((identity) => identity),\n },\n ).queryStringParams;\n debug('Params computed:', params);\n return params;\n}\n\nfunction pickupQueryParams(\n options,\n { queryStringParams, queryStringPartsLeft },\n queryParamDefinition,\n) {\n const involvedQueryStringParts = queryStringPartsLeft.reduce(\n pickQueryPartsByName.bind(null, queryParamDefinition.name),\n {\n lastIndex: -1,\n keptQueryParts: [],\n },\n ).keptQueryParts;\n\n debug(\n 'Found ' +\n involvedQueryStringParts.length +\n ' values for ' +\n queryParamDefinition.name +\n '.',\n involvedQueryStringParts,\n );\n\n if (0 === involvedQueryStringParts.length && queryParamDefinition.required) {\n throw new YError('E_REQUIRED_QUERY_PARAM', queryParamDefinition.name);\n }\n\n queryStringParams = involvedQueryStringParts.reduce(\n (queryStringParams, queryStringPart) =>\n assignQueryStringPart(\n options,\n queryParamDefinition,\n queryStringParams,\n queryStringPart,\n ),\n queryStringParams,\n );\n\n return {\n queryStringParams,\n queryStringPartsLeft: queryStringPartsLeft.slice(\n involvedQueryStringParts.length,\n ),\n };\n}\n\nfunction pickQueryPartsByName(\n name,\n { lastIndex, keptQueryParts },\n queryPart,\n index,\n) {\n if (queryPart.name === name) {\n const isNotFoundAtNextIndex = index !== lastIndex + 1;\n\n if (isNotFoundAtNextIndex) {\n throw new YError('E_BAD_QUERY_PARAM_POSITION', name, lastIndex, index);\n }\n keptQueryParts = keptQueryParts.concat(queryPart);\n lastIndex = index;\n }\n return { lastIndex, keptQueryParts };\n}\n\nfunction swaggerInQueryDefinitions(definition) {\n return !definition.in || 'query' === definition.in;\n}\n\nfunction getQueryStringParts(queryString) {\n return queryString\n .split('&')\n .map((queryStringChunk) => queryStringChunk.split('='))\n .map(([queryPartName, queryPartValue]) => ({\n name: queryPartName,\n value: queryPartValue,\n }));\n}\n\nfunction assignQueryStringPart(\n options,\n queryParamDefinition,\n queryStringParams,\n queryStringPart,\n) {\n // Supporting only a subset of JSON schema core\n // http://json-schema.org/latest/json-schema-core.html#rfc.section.4.2\n const itemDefinition =\n 'array' === queryParamDefinition.type\n ? queryParamDefinition.items\n : queryParamDefinition;\n const value =\n 'string' === itemDefinition.type\n ? decodeQueryComponent(queryStringPart.value)\n : 'boolean' === itemDefinition.type\n ? parseBoolean(decodeQueryComponent(queryStringPart.value))\n : 'number' === itemDefinition.type\n ? parseReentrantNumber(decodeQueryComponent(queryStringPart.value))\n : (() => {\n throw new YError(\n 'E_UNSUPPORTED_TYPE',\n queryParamDefinition.name,\n itemDefinition.type,\n );\n })();\n\n if (itemDefinition.default === value && !options.allowDefault) {\n throw new YError(\n 'E_CANNOT_SET_TO_DEFAULT',\n queryParamDefinition.name,\n value,\n );\n }\n\n if (itemDefinition.enum && !itemDefinition.enum.includes(value)) {\n throw new YError('E_NOT_IN_ENUM', queryParamDefinition.name, value);\n }\n\n if (\n itemDefinition.pattern &&\n !new RegExp(itemDefinition.pattern).test(value)\n ) {\n throw new YError(\n 'E_PATTERN_DOES_NOT_MATCH',\n queryParamDefinition.name,\n value,\n );\n }\n\n if ('array' === queryParamDefinition.type) {\n queryStringParams[queryStringPart.name] =\n queryStringParams[queryStringPart.name] || [];\n if (\n queryParamDefinition.ordered &&\n queryStringParams[queryStringPart.name].length &&\n queryStringParams[queryStringPart.name][\n queryStringParams[queryStringPart.name].length - 1\n ] > value\n ) {\n throw new YError(\n 'E_UNORDERED_QUERY_PARAMS',\n value,\n queryStringParams[queryStringPart.name][\n queryStringParams[queryStringPart.name].length - 1\n ],\n );\n }\n queryStringParams[queryStringPart.name].push(value);\n } else {\n queryStringParams[queryStringPart.name] = value;\n }\n return queryStringParams;\n}\n\nexport function parseReentrantNumber(str) {\n const value = parseFloat(str, BASE_10);\n\n if (value.toString(BASE_10) !== str) {\n throw new YError('E_NON_REENTRANT_NUMBER', str, value.toString(BASE_10));\n }\n\n return value;\n}\n\nexport function parseBoolean(str) {\n if ('true' === str) {\n return true;\n } else if ('false' === str) {\n return false;\n }\n throw new YError('E_BAD_BOOLEAN', str);\n}\n\nexport function decodeQueryComponent(value) {\n return decodeURIComponent(value.replace(/\\+/g, '%20'));\n}\n"],"file":"index.mjs"}
|
package/dist/index.test.mjs
DELETED
|
@@ -1,229 +0,0 @@
|
|
|
1
|
-
import assert from 'assert';
|
|
2
|
-
import qs from '.';
|
|
3
|
-
describe('strict-qs', () => {
|
|
4
|
-
describe('with no search', () => {
|
|
5
|
-
const qsDefinition = [];
|
|
6
|
-
test('should work', () => {
|
|
7
|
-
assert.deepEqual(qs(qsDefinition, ''), {});
|
|
8
|
-
});
|
|
9
|
-
});
|
|
10
|
-
describe('with bad search', () => {
|
|
11
|
-
const qsDefinition = [];
|
|
12
|
-
test('should fail', () => {
|
|
13
|
-
assert.throws(() => {
|
|
14
|
-
qs({}, qsDefinition, '?');
|
|
15
|
-
}, /E_EMPTY_SEARCH/);
|
|
16
|
-
});
|
|
17
|
-
test('should work when allowed', () => {
|
|
18
|
-
assert.deepEqual(qs({
|
|
19
|
-
allowEmptySearch: true
|
|
20
|
-
}, qsDefinition, '?'), {});
|
|
21
|
-
});
|
|
22
|
-
test('should fail', () => {
|
|
23
|
-
assert.throws(() => {
|
|
24
|
-
qs({}, qsDefinition, 'lol');
|
|
25
|
-
}, /E_MALFORMED_SEARCH/);
|
|
26
|
-
});
|
|
27
|
-
});
|
|
28
|
-
describe('with unsupported definition type', () => {
|
|
29
|
-
const qsDefinition = [{
|
|
30
|
-
name: 'user',
|
|
31
|
-
in: 'query',
|
|
32
|
-
type: 'object',
|
|
33
|
-
required: true,
|
|
34
|
-
description: 'The user'
|
|
35
|
-
}];
|
|
36
|
-
test('should fail', () => {
|
|
37
|
-
assert.throws(() => {
|
|
38
|
-
qs({}, qsDefinition, '?user=lol');
|
|
39
|
-
}, /E_UNSUPPORTED_TYPE/);
|
|
40
|
-
});
|
|
41
|
-
});
|
|
42
|
-
describe('with ordered collections', () => {
|
|
43
|
-
const qsDefinition = [{
|
|
44
|
-
name: 'pages',
|
|
45
|
-
in: 'query',
|
|
46
|
-
type: 'array',
|
|
47
|
-
items: {
|
|
48
|
-
type: 'number'
|
|
49
|
-
},
|
|
50
|
-
ordered: true,
|
|
51
|
-
description: 'The pages to print'
|
|
52
|
-
}];
|
|
53
|
-
test('should work when params are ordered', () => {
|
|
54
|
-
assert.deepEqual(qs({}, qsDefinition, '?pages=0&pages=1&pages=2'), {
|
|
55
|
-
pages: [0, 1, 2]
|
|
56
|
-
});
|
|
57
|
-
});
|
|
58
|
-
test('should fail when params are not ordered', () => {
|
|
59
|
-
assert.throws(() => {
|
|
60
|
-
qs({}, qsDefinition, '?pages=0&pages=2&pages=1');
|
|
61
|
-
}, /E_UNORDERED_QUERY_PARAMS/);
|
|
62
|
-
});
|
|
63
|
-
});
|
|
64
|
-
describe('with encoded components', () => {
|
|
65
|
-
const qsDefinition = [{
|
|
66
|
-
name: 'redirectURL',
|
|
67
|
-
in: 'query',
|
|
68
|
-
type: 'string'
|
|
69
|
-
}];
|
|
70
|
-
test('should work', () => {
|
|
71
|
-
assert.deepEqual(qs({}, qsDefinition, '?redirectURL=' + encodeURIComponent('http://localhost/plop')), {
|
|
72
|
-
redirectURL: 'http://localhost/plop'
|
|
73
|
-
});
|
|
74
|
-
});
|
|
75
|
-
});
|
|
76
|
-
describe('with axios components', () => {
|
|
77
|
-
const qsDefinition = [{
|
|
78
|
-
name: 'query',
|
|
79
|
-
in: 'query',
|
|
80
|
-
type: 'string'
|
|
81
|
-
}];
|
|
82
|
-
test('should work', () => {
|
|
83
|
-
assert.deepEqual(qs({}, qsDefinition, '?query=a+b+c'), {
|
|
84
|
-
query: 'a b c'
|
|
85
|
-
});
|
|
86
|
-
});
|
|
87
|
-
});
|
|
88
|
-
describe('with lots of different definitions', () => {
|
|
89
|
-
const qsDefinition = [{
|
|
90
|
-
name: 'lang',
|
|
91
|
-
in: 'query',
|
|
92
|
-
type: 'string',
|
|
93
|
-
required: true,
|
|
94
|
-
default: 'en',
|
|
95
|
-
enum: ['fr', 'en', 'de'],
|
|
96
|
-
description: 'The language for the search'
|
|
97
|
-
}, {
|
|
98
|
-
name: 'types',
|
|
99
|
-
in: 'query',
|
|
100
|
-
type: 'array',
|
|
101
|
-
items: {
|
|
102
|
-
type: 'string',
|
|
103
|
-
enum: ['open', 'closed', 'pending', 'idle', 'invalid']
|
|
104
|
-
},
|
|
105
|
-
description: 'The types of the search'
|
|
106
|
-
}, {
|
|
107
|
-
name: 'code',
|
|
108
|
-
in: 'query',
|
|
109
|
-
type: 'number',
|
|
110
|
-
pattern: '^[0-9]+$',
|
|
111
|
-
description: 'The code id'
|
|
112
|
-
}, {
|
|
113
|
-
name: 'full',
|
|
114
|
-
in: 'query',
|
|
115
|
-
type: 'boolean',
|
|
116
|
-
description: 'Wether it is a full search or not'
|
|
117
|
-
}, {
|
|
118
|
-
name: 'nums',
|
|
119
|
-
in: 'query',
|
|
120
|
-
type: 'array',
|
|
121
|
-
items: {
|
|
122
|
-
type: 'number',
|
|
123
|
-
enum: [1, 2, 3, 4]
|
|
124
|
-
},
|
|
125
|
-
description: 'The types of the search'
|
|
126
|
-
}];
|
|
127
|
-
test('should work with good params', () => {
|
|
128
|
-
assert.deepEqual(qs({}, qsDefinition, '?lang=fr&types=open&types=closed&types=pending&code=3&full=true'), {
|
|
129
|
-
lang: 'fr',
|
|
130
|
-
types: ['open', 'closed', 'pending'],
|
|
131
|
-
code: 3,
|
|
132
|
-
full: true
|
|
133
|
-
});
|
|
134
|
-
assert.throws(qs.bind(null, {}, qsDefinition, '?lang=cn&types=open&types=closed&types=pending&code=3&full=true'), /E_NOT_IN_ENUM/);
|
|
135
|
-
assert.throws(qs.bind(null, {}, qsDefinition, '?lang=fr&types=open&types=closed&types=pending&code=3.4&full=true'), /E_PATTERN_DOES_NOT_MATCH/);
|
|
136
|
-
});
|
|
137
|
-
test('should work with all params', () => {
|
|
138
|
-
assert.deepEqual(qs({}, qsDefinition, '?lang=fr&types=open&types=closed&types=pending&code=3&full=false&nums=4'), {
|
|
139
|
-
lang: 'fr',
|
|
140
|
-
types: ['open', 'closed', 'pending'],
|
|
141
|
-
code: 3,
|
|
142
|
-
full: false,
|
|
143
|
-
nums: [4]
|
|
144
|
-
});
|
|
145
|
-
});
|
|
146
|
-
test('should fail when required params are not in order', () => {
|
|
147
|
-
assert.throws(() => {
|
|
148
|
-
qs({}, qsDefinition, '?lang=fr&types=open&lang=hop&types=closed&types=pending&code=3&full=true');
|
|
149
|
-
}, /E_BAD_QUERY_PARAM_POSITION/);
|
|
150
|
-
});
|
|
151
|
-
test('should work when required params are not in order with option allowUnorderedParams', () => {
|
|
152
|
-
assert.deepEqual(qs({
|
|
153
|
-
allowUnorderedParams: true
|
|
154
|
-
}, qsDefinition, '?lang=fr&types=open&lang=fr&types=closed&types=pending&code=3&full=true'), {
|
|
155
|
-
lang: 'fr',
|
|
156
|
-
types: ['open', 'closed', 'pending'],
|
|
157
|
-
code: 3,
|
|
158
|
-
full: true
|
|
159
|
-
});
|
|
160
|
-
});
|
|
161
|
-
test('should work when required params are not in order with option allowUnorderedParams and allowUnknownParams', () => {
|
|
162
|
-
assert.deepEqual(qs({
|
|
163
|
-
allowUnorderedParams: true,
|
|
164
|
-
allowUnknownParams: true
|
|
165
|
-
}, qsDefinition, '?lang=fr&types=open&pippip=yeah&lang=fr&types=closed&types=pending&code=3&full=true'), {
|
|
166
|
-
lang: 'fr',
|
|
167
|
-
types: ['open', 'closed', 'pending'],
|
|
168
|
-
code: 3,
|
|
169
|
-
full: true
|
|
170
|
-
});
|
|
171
|
-
});
|
|
172
|
-
test('should fail when required params are not provided', () => {
|
|
173
|
-
assert.throws(() => {
|
|
174
|
-
qs({}, qsDefinition, '?types=open&types=closed&types=pending&code=3&full=true');
|
|
175
|
-
}, /E_REQUIRED_QUERY_PARAM/);
|
|
176
|
-
});
|
|
177
|
-
test('should fail when a bad boolean is provided', () => {
|
|
178
|
-
assert.throws(() => {
|
|
179
|
-
qs({}, qsDefinition, '?lang=fr&types=open&types=closed&types=pending&code=3&full=1');
|
|
180
|
-
}, /E_BAD_BOOLEAN/);
|
|
181
|
-
});
|
|
182
|
-
test('should fail when a bad array item is given', () => {
|
|
183
|
-
assert.throws(() => {
|
|
184
|
-
qs({}, qsDefinition, '?lang=fr&types=open&types=closed&types=pending&code=3&full=true&nums=1&nums=0.0');
|
|
185
|
-
}, /E_NON_REENTRANT_NUMBER/);
|
|
186
|
-
});
|
|
187
|
-
test('should work whith an unexisting param and the allowUnknownParams option', () => {
|
|
188
|
-
assert.deepEqual(qs({
|
|
189
|
-
allowUnknownParams: true
|
|
190
|
-
}, qsDefinition, '?lol=9&lang=fr&types=open&types=closed&types=pending&code=3&full=true'), {
|
|
191
|
-
code: 3,
|
|
192
|
-
full: true,
|
|
193
|
-
lang: 'fr',
|
|
194
|
-
types: ['open', 'closed', 'pending']
|
|
195
|
-
});
|
|
196
|
-
});
|
|
197
|
-
test('should fail when an unexisting param is set at the begin', () => {
|
|
198
|
-
assert.throws(() => {
|
|
199
|
-
qs({}, qsDefinition, '?lol=9&lang=fr&types=open&types=closed&types=pending&code=3&full=true');
|
|
200
|
-
}, /E_UNAUTHORIZED_QUERY_PARAM/);
|
|
201
|
-
});
|
|
202
|
-
test('should fail when an unexisting param is set in the middle', () => {
|
|
203
|
-
assert.throws(() => {
|
|
204
|
-
qs({}, qsDefinition, '?lang=fr&types=open&types=closed&types=pendinglol=9&&code=3&full=true');
|
|
205
|
-
}, /E_UNAUTHORIZED_QUERY_PARAM/);
|
|
206
|
-
});
|
|
207
|
-
test('should fail when an unexisting param is set at the end', () => {
|
|
208
|
-
assert.throws(() => {
|
|
209
|
-
qs({}, qsDefinition, '?lang=fr&types=open&types=closed&types=pending&code=3&full=true&lol=9');
|
|
210
|
-
}, /E_UNAUTHORIZED_QUERY_PARAM/);
|
|
211
|
-
});
|
|
212
|
-
test('should fail when setting a query param to the default value', () => {
|
|
213
|
-
assert.throws(() => {
|
|
214
|
-
qs({}, qsDefinition, '?lang=en&types=open&types=closed&types=pending&code=3&full=true');
|
|
215
|
-
}, /E_CANNOT_SET_TO_DEFAULT/);
|
|
216
|
-
});
|
|
217
|
-
test('should work when setting a query param to the default value and allowDefault option', () => {
|
|
218
|
-
assert.deepEqual(qs({
|
|
219
|
-
allowDefault: true
|
|
220
|
-
}, qsDefinition, '?lang=en&types=open&types=closed&types=pending&code=3&full=true'), {
|
|
221
|
-
code: 3,
|
|
222
|
-
full: true,
|
|
223
|
-
lang: 'en',
|
|
224
|
-
types: ['open', 'closed', 'pending']
|
|
225
|
-
});
|
|
226
|
-
});
|
|
227
|
-
});
|
|
228
|
-
});
|
|
229
|
-
//# sourceMappingURL=index.test.mjs.map
|