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