strict-qs 6.1.5 → 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 +4 -0
- package/README.md +0 -1
- package/dist/index.d.ts +85 -0
- package/dist/index.js +135 -168
- 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 +65 -43
- 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
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,"file":"index.mjs","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"],"sources":["../src/index.js"],"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"],"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;EAC9C,IAAI,CAACA,MAAL,EAAa;IACX,OAAO,EAAP;EACD;;EACD,IAAI,CAACA,MAAM,CAACC,UAAP,CAAkBP,WAAlB,CAAL,EAAqC;IACnC,MAAM,IAAIQ,KAAJ,CAAU,oBAAV,EAAgCF,MAAhC,CAAN;EACD;;EACD,IAAIA,MAAM,KAAKN,WAAf,EAA4B;IAC1B,IAAII,OAAO,CAACK,gBAAZ,EAA8B;MAC5B,OAAO,EAAP;IACD;;IACD,MAAM,IAAID,KAAJ,CAAU,gBAAV,EAA4BF,MAA5B,CAAN;EACD;;EAED,MAAMI,iBAAiB,GAAGL,WAAW,CAACM,MAAZ,CAAmBC,yBAAnB,CAA1B;EACA,IAAIC,gBAAgB,GAAGC,mBAAmB,CAACR,MAAM,CAACS,KAAP,CAAa,CAAb,CAAD,CAA1C;;EAEA,IAAIX,OAAO,CAACY,oBAAZ,EAAkC;IAChCH,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;EAkBD;;EAED,MAAMG,MAAM,GAAGd,iBAAiB,CAACO,MAAlB,CACbQ,iBAAiB,CAACC,IAAlB,CAAuB,IAAvB,EAA6BtB,OAA7B,CADa,EAEb;IACEuB,iBAAiB,EAAE,EADrB;IAEEC,oBAAoB,EAAEf,gBAAgB,CACnCgB,GADmB,CACdT,eAAD,IAAqB;MACxBlB,KAAK,CAAC,kBAAkBkB,eAAe,CAACC,IAAlC,GAAyC,gBAA1C,CAAL;;MACA,IACE,CAACX,iBAAiB,CAACa,IAAlB,CAAwBJ,UAAD,IAAgB;QACtC,MAAMW,KAAK,GAAGV,eAAe,CAACC,IAAhB,KAAyBF,UAAU,CAACE,IAAlD;QAEAnB,KAAK,CAAC,mBAAD,EAAsBiB,UAAtB,CAAL;QACA,OAAOW,KAAP;MACD,CALA,CADH,EAOE;QACA,IAAI1B,OAAO,CAAC2B,kBAAZ,EAAgC;UAC9B,OAAO,IAAP;QACD;;QACD,MAAM,IAAIhC,MAAJ,CACJ,4BADI,EAEJqB,eAAe,CAACC,IAFZ,CAAN;MAID;;MACD,OAAOD,eAAP;IACD,CApBmB,EAqBnBT,MArBmB,CAqBXqB,QAAD,IAAcA,QArBF;EAFxB,CAFa,EA2BbL,iBA3BF;EA4BAzB,KAAK,CAAC,kBAAD,EAAqBsB,MAArB,CAAL;EACA,OAAOA,MAAP;AACD;;AAED,SAASC,iBAAT,CACErB,OADF,EAEE;EAAEuB,iBAAF;EAAqBC;AAArB,CAFF,EAGEK,oBAHF,EAIE;EACA,MAAMC,wBAAwB,GAAGN,oBAAoB,CAACX,MAArB,CAC/BkB,oBAAoB,CAACT,IAArB,CAA0B,IAA1B,EAAgCO,oBAAoB,CAACZ,IAArD,CAD+B,EAE/B;IACEe,SAAS,EAAE,CAAC,CADd;IAEEC,cAAc,EAAE;EAFlB,CAF+B,EAM/BA,cANF;EAQAnC,KAAK,CACH,WACEgC,wBAAwB,CAACI,MAD3B,GAEE,cAFF,GAGEL,oBAAoB,CAACZ,IAHvB,GAIE,GALC,EAMHa,wBANG,CAAL;;EASA,IAAI,MAAMA,wBAAwB,CAACI,MAA/B,IAAyCL,oBAAoB,CAACM,QAAlE,EAA4E;IAC1E,MAAM,IAAIxC,MAAJ,CAAW,wBAAX,EAAqCkC,oBAAoB,CAACZ,IAA1D,CAAN;EACD;;EAEDM,iBAAiB,GAAGO,wBAAwB,CAACjB,MAAzB,CAClB,CAACU,iBAAD,EAAoBP,eAApB,KACEoB,qBAAqB,CACnBpC,OADmB,EAEnB6B,oBAFmB,EAGnBN,iBAHmB,EAInBP,eAJmB,CAFL,EAQlBO,iBARkB,CAApB;EAWA,OAAO;IACLA,iBADK;IAELC,oBAAoB,EAAEA,oBAAoB,CAACb,KAArB,CACpBmB,wBAAwB,CAACI,MADL;EAFjB,CAAP;AAMD;;AAED,SAASH,oBAAT,CACEd,IADF,EAEE;EAAEe,SAAF;EAAaC;AAAb,CAFF,EAGEI,SAHF,EAIEC,KAJF,EAKE;EACA,IAAID,SAAS,CAACpB,IAAV,KAAmBA,IAAvB,EAA6B;IAC3B,MAAMsB,qBAAqB,GAAGD,KAAK,KAAKN,SAAS,GAAG,CAApD;;IAEA,IAAIO,qBAAJ,EAA2B;MACzB,MAAM,IAAI5C,MAAJ,CAAW,4BAAX,EAAyCsB,IAAzC,EAA+Ce,SAA/C,EAA0DM,KAA1D,CAAN;IACD;;IACDL,cAAc,GAAGA,cAAc,CAACf,MAAf,CAAsBmB,SAAtB,CAAjB;IACAL,SAAS,GAAGM,KAAZ;EACD;;EACD,OAAO;IAAEN,SAAF;IAAaC;EAAb,CAAP;AACD;;AAED,SAASzB,yBAAT,CAAmCO,UAAnC,EAA+C;EAC7C,OAAO,CAACA,UAAU,CAACyB,EAAZ,IAAkB,YAAYzB,UAAU,CAACyB,EAAhD;AACD;;AAED,SAAS9B,mBAAT,CAA6B+B,WAA7B,EAA0C;EACxC,OAAOA,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;IACzC5B,IAAI,EAAE2B,aADmC;IAEzCE,KAAK,EAAED;EAFkC,CAAtC,CAHA,CAAP;AAOD;;AAED,SAAST,qBAAT,CACEpC,OADF,EAEE6B,oBAFF,EAGEN,iBAHF,EAIEP,eAJF,EAKE;EAGA,MAAM+B,cAAc,GAClB,YAAYlB,oBAAoB,CAACmB,IAAjC,GACInB,oBAAoB,CAACoB,KADzB,GAEIpB,oBAHN;EAIA,MAAMiB,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;IACL,MAAM,IAAInD,MAAJ,CACJ,oBADI,EAEJkC,oBAAoB,CAACZ,IAFjB,EAGJ8B,cAAc,CAACC,IAHX,CAAN;EAKD,CAND,GAPN;;EAeA,IAAID,cAAc,CAACM,OAAf,KAA2BP,KAA3B,IAAoC,CAAC9C,OAAO,CAACsD,YAAjD,EAA+D;IAC7D,MAAM,IAAI3D,MAAJ,CACJ,yBADI,EAEJkC,oBAAoB,CAACZ,IAFjB,EAGJ6B,KAHI,CAAN;EAKD;;EAED,IAAIC,cAAc,CAACQ,IAAf,IAAuB,CAACR,cAAc,CAACQ,IAAf,CAAoBC,QAApB,CAA6BV,KAA7B,CAA5B,EAAiE;IAC/D,MAAM,IAAInD,MAAJ,CAAW,eAAX,EAA4BkC,oBAAoB,CAACZ,IAAjD,EAAuD6B,KAAvD,CAAN;EACD;;EAED,IACEC,cAAc,CAACU,OAAf,IACA,CAAC,IAAIC,MAAJ,CAAWX,cAAc,CAACU,OAA1B,EAAmCE,IAAnC,CAAwCb,KAAxC,CAFH,EAGE;IACA,MAAM,IAAInD,MAAJ,CACJ,0BADI,EAEJkC,oBAAoB,CAACZ,IAFjB,EAGJ6B,KAHI,CAAN;EAKD;;EAED,IAAI,YAAYjB,oBAAoB,CAACmB,IAArC,EAA2C;IACzCzB,iBAAiB,CAACP,eAAe,CAACC,IAAjB,CAAjB,GACEM,iBAAiB,CAACP,eAAe,CAACC,IAAjB,CAAjB,IAA2C,EAD7C;;IAEA,IACEY,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;MACA,MAAM,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;IAOD;;IACDX,iBAAiB,CAACP,eAAe,CAACC,IAAjB,CAAjB,CAAwC4C,IAAxC,CAA6Cf,KAA7C;EACD,CAnBD,MAmBO;IACLvB,iBAAiB,CAACP,eAAe,CAACC,IAAjB,CAAjB,GAA0C6B,KAA1C;EACD;;EACD,OAAOvB,iBAAP;AACD;;AAED,OAAO,SAAS6B,oBAAT,CAA8BU,GAA9B,EAAmC;EACxC,MAAMhB,KAAK,GAAGiB,UAAU,CAACD,GAAD,EAAMjE,OAAN,CAAxB;;EAEA,IAAIiD,KAAK,CAACkB,QAAN,CAAenE,OAAf,MAA4BiE,GAAhC,EAAqC;IACnC,MAAM,IAAInE,MAAJ,CAAW,wBAAX,EAAqCmE,GAArC,EAA0ChB,KAAK,CAACkB,QAAN,CAAenE,OAAf,CAA1C,CAAN;EACD;;EAED,OAAOiD,KAAP;AACD;AAED,OAAO,SAASK,YAAT,CAAsBW,GAAtB,EAA2B;EAChC,IAAI,WAAWA,GAAf,EAAoB;IAClB,OAAO,IAAP;EACD,CAFD,MAEO,IAAI,YAAYA,GAAhB,EAAqB;IAC1B,OAAO,KAAP;EACD;;EACD,MAAM,IAAInE,MAAJ,CAAW,eAAX,EAA4BmE,GAA5B,CAAN;AACD;AAED,OAAO,SAASZ,oBAAT,CAA8BJ,KAA9B,EAAqC;EAC1C,OAAOmB,kBAAkB,CAACnB,KAAK,CAACoB,OAAN,CAAc,KAAd,EAAqB,KAArB,CAAD,CAAzB;AACD"}
|
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
|
package/dist/index.test.mjs.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.test.mjs","names":["assert","qs","describe","qsDefinition","test","deepEqual","throws","allowEmptySearch","name","in","type","required","description","items","ordered","pages","encodeURIComponent","redirectURL","query","default","enum","pattern","lang","types","code","full","bind","nums","allowUnorderedParams","allowUnknownParams","allowDefault"],"sources":["../src/index.test.js"],"sourcesContent":["import assert from 'assert';\nimport qs from '.';\n\ndescribe('strict-qs', () => {\n describe('with no search', () => {\n const qsDefinition = [];\n\n test('should work', () => {\n assert.deepEqual(qs(qsDefinition, ''), {});\n });\n });\n\n describe('with bad search', () => {\n const qsDefinition = [];\n\n test('should fail', () => {\n assert.throws(() => {\n qs({}, qsDefinition, '?');\n }, /E_EMPTY_SEARCH/);\n });\n\n test('should work when allowed', () => {\n assert.deepEqual(qs({ allowEmptySearch: true }, qsDefinition, '?'), {});\n });\n\n test('should fail', () => {\n assert.throws(() => {\n qs({}, qsDefinition, 'lol');\n }, /E_MALFORMED_SEARCH/);\n });\n });\n\n describe('with unsupported definition type', () => {\n const qsDefinition = [\n {\n name: 'user',\n in: 'query',\n type: 'object',\n required: true,\n description: 'The user',\n },\n ];\n\n test('should fail', () => {\n assert.throws(() => {\n qs({}, qsDefinition, '?user=lol');\n }, /E_UNSUPPORTED_TYPE/);\n });\n });\n\n describe('with ordered collections', () => {\n const qsDefinition = [\n {\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\n test('should work when params are ordered', () => {\n assert.deepEqual(qs({}, qsDefinition, '?pages=0&pages=1&pages=2'), {\n pages: [0, 1, 2], // eslint-disable-line\n });\n });\n\n test('should fail when params are not ordered', () => {\n assert.throws(() => {\n qs({}, qsDefinition, '?pages=0&pages=2&pages=1');\n }, /E_UNORDERED_QUERY_PARAMS/);\n });\n });\n\n describe('with encoded components', () => {\n const qsDefinition = [\n {\n name: 'redirectURL',\n in: 'query',\n type: 'string',\n },\n ];\n\n test('should work', () => {\n assert.deepEqual(\n qs(\n {},\n qsDefinition,\n '?redirectURL=' + encodeURIComponent('http://localhost/plop'),\n ),\n {\n redirectURL: 'http://localhost/plop',\n },\n );\n });\n });\n\n describe('with axios components', () => {\n const qsDefinition = [\n {\n name: 'query',\n in: 'query',\n type: 'string',\n },\n ];\n\n test('should work', () => {\n assert.deepEqual(qs({}, qsDefinition, '?query=a+b+c'), {\n query: 'a b c',\n });\n });\n });\n\n describe('with lots of different definitions', () => {\n const qsDefinition = [\n {\n name: 'lang',\n in: 'query',\n type: 'string',\n required: true,\n default: 'en',\n enum: ['fr', 'en', 'de'],\n description: 'The language for the search',\n },\n {\n name: 'types',\n in: 'query',\n type: 'array',\n items: {\n type: 'string',\n enum: ['open', 'closed', 'pending', 'idle', 'invalid'],\n },\n description: 'The types of the search',\n },\n {\n name: 'code',\n in: 'query',\n type: 'number',\n pattern: '^[0-9]+$',\n description: 'The code id',\n },\n {\n name: 'full',\n in: 'query',\n type: 'boolean',\n description: 'Wether it is a full search or not',\n },\n {\n name: 'nums',\n in: 'query',\n type: 'array',\n items: {\n type: 'number',\n enum: [1, 2, 3, 4], // eslint-disable-line\n },\n description: 'The types of the search',\n },\n ];\n\n test('should work with good params', () => {\n assert.deepEqual(\n qs(\n {},\n qsDefinition,\n '?lang=fr&types=open&types=closed&types=pending&code=3&full=true',\n ),\n {\n lang: 'fr',\n types: ['open', 'closed', 'pending'],\n code: 3,\n full: true,\n },\n );\n assert.throws(\n qs.bind(\n null,\n {},\n qsDefinition,\n '?lang=cn&types=open&types=closed&types=pending&code=3&full=true',\n ),\n /E_NOT_IN_ENUM/,\n );\n assert.throws(\n qs.bind(\n null,\n {},\n qsDefinition,\n '?lang=fr&types=open&types=closed&types=pending&code=3.4&full=true',\n ),\n /E_PATTERN_DOES_NOT_MATCH/,\n );\n });\n\n test('should work with all params', () => {\n assert.deepEqual(\n qs(\n {},\n qsDefinition,\n '?lang=fr&types=open&types=closed&types=pending&code=3&full=false&nums=4',\n ),\n {\n lang: 'fr',\n types: ['open', 'closed', 'pending'],\n code: 3,\n full: false,\n nums: [4], // eslint-disable-line\n },\n );\n });\n\n test('should fail when required params are not in order', () => {\n assert.throws(() => {\n qs(\n {},\n qsDefinition,\n '?lang=fr&types=open&lang=hop&types=closed&types=pending&code=3&full=true',\n );\n }, /E_BAD_QUERY_PARAM_POSITION/);\n });\n\n test('should work when required params are not in order with option allowUnorderedParams', () => {\n assert.deepEqual(\n qs(\n { allowUnorderedParams: true },\n qsDefinition,\n '?lang=fr&types=open&lang=fr&types=closed&types=pending&code=3&full=true',\n ),\n {\n lang: 'fr',\n types: ['open', 'closed', 'pending'],\n code: 3,\n full: true,\n },\n );\n });\n\n test('should work when required params are not in order with option allowUnorderedParams and allowUnknownParams', () => {\n assert.deepEqual(\n qs(\n { allowUnorderedParams: true, allowUnknownParams: true },\n qsDefinition,\n '?lang=fr&types=open&pippip=yeah&lang=fr&types=closed&types=pending&code=3&full=true',\n ),\n {\n lang: 'fr',\n types: ['open', 'closed', 'pending'],\n code: 3,\n full: true,\n },\n );\n });\n\n test('should fail when required params are not provided', () => {\n assert.throws(() => {\n qs(\n {},\n qsDefinition,\n '?types=open&types=closed&types=pending&code=3&full=true',\n );\n }, /E_REQUIRED_QUERY_PARAM/);\n });\n\n test('should fail when a bad boolean is provided', () => {\n assert.throws(() => {\n qs(\n {},\n qsDefinition,\n '?lang=fr&types=open&types=closed&types=pending&code=3&full=1',\n );\n }, /E_BAD_BOOLEAN/);\n });\n\n test('should fail when a bad array item is given', () => {\n assert.throws(() => {\n qs(\n {},\n qsDefinition,\n '?lang=fr&types=open&types=closed&types=pending&code=3&full=true&nums=1&nums=0.0',\n );\n }, /E_NON_REENTRANT_NUMBER/);\n });\n\n test('should work whith an unexisting param and the allowUnknownParams option', () => {\n assert.deepEqual(\n qs(\n { allowUnknownParams: true },\n qsDefinition,\n '?lol=9&lang=fr&types=open&types=closed&types=pending&code=3&full=true',\n ),\n {\n code: 3,\n full: true,\n lang: 'fr',\n types: ['open', 'closed', 'pending'],\n },\n );\n });\n\n test('should fail when an unexisting param is set at the begin', () => {\n assert.throws(() => {\n qs(\n {},\n qsDefinition,\n '?lol=9&lang=fr&types=open&types=closed&types=pending&code=3&full=true',\n );\n }, /E_UNAUTHORIZED_QUERY_PARAM/);\n });\n\n test('should fail when an unexisting param is set in the middle', () => {\n assert.throws(() => {\n qs(\n {},\n qsDefinition,\n '?lang=fr&types=open&types=closed&types=pendinglol=9&&code=3&full=true',\n );\n }, /E_UNAUTHORIZED_QUERY_PARAM/);\n });\n\n test('should fail when an unexisting param is set at the end', () => {\n assert.throws(() => {\n qs(\n {},\n qsDefinition,\n '?lang=fr&types=open&types=closed&types=pending&code=3&full=true&lol=9',\n );\n }, /E_UNAUTHORIZED_QUERY_PARAM/);\n });\n\n test('should fail when setting a query param to the default value', () => {\n assert.throws(() => {\n qs(\n {},\n qsDefinition,\n '?lang=en&types=open&types=closed&types=pending&code=3&full=true',\n );\n }, /E_CANNOT_SET_TO_DEFAULT/);\n });\n test('should work when setting a query param to the default value and allowDefault option', () => {\n assert.deepEqual(\n qs(\n { allowDefault: true },\n qsDefinition,\n '?lang=en&types=open&types=closed&types=pending&code=3&full=true',\n ),\n {\n code: 3,\n full: true,\n lang: 'en',\n types: ['open', 'closed', 'pending'],\n },\n );\n });\n });\n});\n"],"mappings":"AAAA,OAAOA,MAAP,MAAmB,QAAnB;AACA,OAAOC,EAAP,MAAe,GAAf;AAEAC,QAAQ,CAAC,WAAD,EAAc,MAAM;EAC1BA,QAAQ,CAAC,gBAAD,EAAmB,MAAM;IAC/B,MAAMC,YAAY,GAAG,EAArB;IAEAC,IAAI,CAAC,aAAD,EAAgB,MAAM;MACxBJ,MAAM,CAACK,SAAP,CAAiBJ,EAAE,CAACE,YAAD,EAAe,EAAf,CAAnB,EAAuC,EAAvC;IACD,CAFG,CAAJ;EAGD,CANO,CAAR;EAQAD,QAAQ,CAAC,iBAAD,EAAoB,MAAM;IAChC,MAAMC,YAAY,GAAG,EAArB;IAEAC,IAAI,CAAC,aAAD,EAAgB,MAAM;MACxBJ,MAAM,CAACM,MAAP,CAAc,MAAM;QAClBL,EAAE,CAAC,EAAD,EAAKE,YAAL,EAAmB,GAAnB,CAAF;MACD,CAFD,EAEG,gBAFH;IAGD,CAJG,CAAJ;IAMAC,IAAI,CAAC,0BAAD,EAA6B,MAAM;MACrCJ,MAAM,CAACK,SAAP,CAAiBJ,EAAE,CAAC;QAAEM,gBAAgB,EAAE;MAApB,CAAD,EAA6BJ,YAA7B,EAA2C,GAA3C,CAAnB,EAAoE,EAApE;IACD,CAFG,CAAJ;IAIAC,IAAI,CAAC,aAAD,EAAgB,MAAM;MACxBJ,MAAM,CAACM,MAAP,CAAc,MAAM;QAClBL,EAAE,CAAC,EAAD,EAAKE,YAAL,EAAmB,KAAnB,CAAF;MACD,CAFD,EAEG,oBAFH;IAGD,CAJG,CAAJ;EAKD,CAlBO,CAAR;EAoBAD,QAAQ,CAAC,kCAAD,EAAqC,MAAM;IACjD,MAAMC,YAAY,GAAG,CACnB;MACEK,IAAI,EAAE,MADR;MAEEC,EAAE,EAAE,OAFN;MAGEC,IAAI,EAAE,QAHR;MAIEC,QAAQ,EAAE,IAJZ;MAKEC,WAAW,EAAE;IALf,CADmB,CAArB;IAUAR,IAAI,CAAC,aAAD,EAAgB,MAAM;MACxBJ,MAAM,CAACM,MAAP,CAAc,MAAM;QAClBL,EAAE,CAAC,EAAD,EAAKE,YAAL,EAAmB,WAAnB,CAAF;MACD,CAFD,EAEG,oBAFH;IAGD,CAJG,CAAJ;EAKD,CAhBO,CAAR;EAkBAD,QAAQ,CAAC,0BAAD,EAA6B,MAAM;IACzC,MAAMC,YAAY,GAAG,CACnB;MACEK,IAAI,EAAE,OADR;MAEEC,EAAE,EAAE,OAFN;MAGEC,IAAI,EAAE,OAHR;MAIEG,KAAK,EAAE;QACLH,IAAI,EAAE;MADD,CAJT;MAOEI,OAAO,EAAE,IAPX;MAQEF,WAAW,EAAE;IARf,CADmB,CAArB;IAaAR,IAAI,CAAC,qCAAD,EAAwC,MAAM;MAChDJ,MAAM,CAACK,SAAP,CAAiBJ,EAAE,CAAC,EAAD,EAAKE,YAAL,EAAmB,0BAAnB,CAAnB,EAAmE;QACjEY,KAAK,EAAE,CAAC,CAAD,EAAI,CAAJ,EAAO,CAAP;MAD0D,CAAnE;IAGD,CAJG,CAAJ;IAMAX,IAAI,CAAC,yCAAD,EAA4C,MAAM;MACpDJ,MAAM,CAACM,MAAP,CAAc,MAAM;QAClBL,EAAE,CAAC,EAAD,EAAKE,YAAL,EAAmB,0BAAnB,CAAF;MACD,CAFD,EAEG,0BAFH;IAGD,CAJG,CAAJ;EAKD,CAzBO,CAAR;EA2BAD,QAAQ,CAAC,yBAAD,EAA4B,MAAM;IACxC,MAAMC,YAAY,GAAG,CACnB;MACEK,IAAI,EAAE,aADR;MAEEC,EAAE,EAAE,OAFN;MAGEC,IAAI,EAAE;IAHR,CADmB,CAArB;IAQAN,IAAI,CAAC,aAAD,EAAgB,MAAM;MACxBJ,MAAM,CAACK,SAAP,CACEJ,EAAE,CACA,EADA,EAEAE,YAFA,EAGA,kBAAkBa,kBAAkB,CAAC,uBAAD,CAHpC,CADJ,EAME;QACEC,WAAW,EAAE;MADf,CANF;IAUD,CAXG,CAAJ;EAYD,CArBO,CAAR;EAuBAf,QAAQ,CAAC,uBAAD,EAA0B,MAAM;IACtC,MAAMC,YAAY,GAAG,CACnB;MACEK,IAAI,EAAE,OADR;MAEEC,EAAE,EAAE,OAFN;MAGEC,IAAI,EAAE;IAHR,CADmB,CAArB;IAQAN,IAAI,CAAC,aAAD,EAAgB,MAAM;MACxBJ,MAAM,CAACK,SAAP,CAAiBJ,EAAE,CAAC,EAAD,EAAKE,YAAL,EAAmB,cAAnB,CAAnB,EAAuD;QACrDe,KAAK,EAAE;MAD8C,CAAvD;IAGD,CAJG,CAAJ;EAKD,CAdO,CAAR;EAgBAhB,QAAQ,CAAC,oCAAD,EAAuC,MAAM;IACnD,MAAMC,YAAY,GAAG,CACnB;MACEK,IAAI,EAAE,MADR;MAEEC,EAAE,EAAE,OAFN;MAGEC,IAAI,EAAE,QAHR;MAIEC,QAAQ,EAAE,IAJZ;MAKEQ,OAAO,EAAE,IALX;MAMEC,IAAI,EAAE,CAAC,IAAD,EAAO,IAAP,EAAa,IAAb,CANR;MAOER,WAAW,EAAE;IAPf,CADmB,EAUnB;MACEJ,IAAI,EAAE,OADR;MAEEC,EAAE,EAAE,OAFN;MAGEC,IAAI,EAAE,OAHR;MAIEG,KAAK,EAAE;QACLH,IAAI,EAAE,QADD;QAELU,IAAI,EAAE,CAAC,MAAD,EAAS,QAAT,EAAmB,SAAnB,EAA8B,MAA9B,EAAsC,SAAtC;MAFD,CAJT;MAQER,WAAW,EAAE;IARf,CAVmB,EAoBnB;MACEJ,IAAI,EAAE,MADR;MAEEC,EAAE,EAAE,OAFN;MAGEC,IAAI,EAAE,QAHR;MAIEW,OAAO,EAAE,UAJX;MAKET,WAAW,EAAE;IALf,CApBmB,EA2BnB;MACEJ,IAAI,EAAE,MADR;MAEEC,EAAE,EAAE,OAFN;MAGEC,IAAI,EAAE,SAHR;MAIEE,WAAW,EAAE;IAJf,CA3BmB,EAiCnB;MACEJ,IAAI,EAAE,MADR;MAEEC,EAAE,EAAE,OAFN;MAGEC,IAAI,EAAE,OAHR;MAIEG,KAAK,EAAE;QACLH,IAAI,EAAE,QADD;QAELU,IAAI,EAAE,CAAC,CAAD,EAAI,CAAJ,EAAO,CAAP,EAAU,CAAV;MAFD,CAJT;MAQER,WAAW,EAAE;IARf,CAjCmB,CAArB;IA6CAR,IAAI,CAAC,8BAAD,EAAiC,MAAM;MACzCJ,MAAM,CAACK,SAAP,CACEJ,EAAE,CACA,EADA,EAEAE,YAFA,EAGA,iEAHA,CADJ,EAME;QACEmB,IAAI,EAAE,IADR;QAEEC,KAAK,EAAE,CAAC,MAAD,EAAS,QAAT,EAAmB,SAAnB,CAFT;QAGEC,IAAI,EAAE,CAHR;QAIEC,IAAI,EAAE;MAJR,CANF;MAaAzB,MAAM,CAACM,MAAP,CACEL,EAAE,CAACyB,IAAH,CACE,IADF,EAEE,EAFF,EAGEvB,YAHF,EAIE,iEAJF,CADF,EAOE,eAPF;MASAH,MAAM,CAACM,MAAP,CACEL,EAAE,CAACyB,IAAH,CACE,IADF,EAEE,EAFF,EAGEvB,YAHF,EAIE,mEAJF,CADF,EAOE,0BAPF;IASD,CAhCG,CAAJ;IAkCAC,IAAI,CAAC,6BAAD,EAAgC,MAAM;MACxCJ,MAAM,CAACK,SAAP,CACEJ,EAAE,CACA,EADA,EAEAE,YAFA,EAGA,yEAHA,CADJ,EAME;QACEmB,IAAI,EAAE,IADR;QAEEC,KAAK,EAAE,CAAC,MAAD,EAAS,QAAT,EAAmB,SAAnB,CAFT;QAGEC,IAAI,EAAE,CAHR;QAIEC,IAAI,EAAE,KAJR;QAKEE,IAAI,EAAE,CAAC,CAAD;MALR,CANF;IAcD,CAfG,CAAJ;IAiBAvB,IAAI,CAAC,mDAAD,EAAsD,MAAM;MAC9DJ,MAAM,CAACM,MAAP,CAAc,MAAM;QAClBL,EAAE,CACA,EADA,EAEAE,YAFA,EAGA,0EAHA,CAAF;MAKD,CAND,EAMG,4BANH;IAOD,CARG,CAAJ;IAUAC,IAAI,CAAC,oFAAD,EAAuF,MAAM;MAC/FJ,MAAM,CAACK,SAAP,CACEJ,EAAE,CACA;QAAE2B,oBAAoB,EAAE;MAAxB,CADA,EAEAzB,YAFA,EAGA,yEAHA,CADJ,EAME;QACEmB,IAAI,EAAE,IADR;QAEEC,KAAK,EAAE,CAAC,MAAD,EAAS,QAAT,EAAmB,SAAnB,CAFT;QAGEC,IAAI,EAAE,CAHR;QAIEC,IAAI,EAAE;MAJR,CANF;IAaD,CAdG,CAAJ;IAgBArB,IAAI,CAAC,2GAAD,EAA8G,MAAM;MACtHJ,MAAM,CAACK,SAAP,CACEJ,EAAE,CACA;QAAE2B,oBAAoB,EAAE,IAAxB;QAA8BC,kBAAkB,EAAE;MAAlD,CADA,EAEA1B,YAFA,EAGA,qFAHA,CADJ,EAME;QACEmB,IAAI,EAAE,IADR;QAEEC,KAAK,EAAE,CAAC,MAAD,EAAS,QAAT,EAAmB,SAAnB,CAFT;QAGEC,IAAI,EAAE,CAHR;QAIEC,IAAI,EAAE;MAJR,CANF;IAaD,CAdG,CAAJ;IAgBArB,IAAI,CAAC,mDAAD,EAAsD,MAAM;MAC9DJ,MAAM,CAACM,MAAP,CAAc,MAAM;QAClBL,EAAE,CACA,EADA,EAEAE,YAFA,EAGA,yDAHA,CAAF;MAKD,CAND,EAMG,wBANH;IAOD,CARG,CAAJ;IAUAC,IAAI,CAAC,4CAAD,EAA+C,MAAM;MACvDJ,MAAM,CAACM,MAAP,CAAc,MAAM;QAClBL,EAAE,CACA,EADA,EAEAE,YAFA,EAGA,8DAHA,CAAF;MAKD,CAND,EAMG,eANH;IAOD,CARG,CAAJ;IAUAC,IAAI,CAAC,4CAAD,EAA+C,MAAM;MACvDJ,MAAM,CAACM,MAAP,CAAc,MAAM;QAClBL,EAAE,CACA,EADA,EAEAE,YAFA,EAGA,iFAHA,CAAF;MAKD,CAND,EAMG,wBANH;IAOD,CARG,CAAJ;IAUAC,IAAI,CAAC,yEAAD,EAA4E,MAAM;MACpFJ,MAAM,CAACK,SAAP,CACEJ,EAAE,CACA;QAAE4B,kBAAkB,EAAE;MAAtB,CADA,EAEA1B,YAFA,EAGA,uEAHA,CADJ,EAME;QACEqB,IAAI,EAAE,CADR;QAEEC,IAAI,EAAE,IAFR;QAGEH,IAAI,EAAE,IAHR;QAIEC,KAAK,EAAE,CAAC,MAAD,EAAS,QAAT,EAAmB,SAAnB;MAJT,CANF;IAaD,CAdG,CAAJ;IAgBAnB,IAAI,CAAC,0DAAD,EAA6D,MAAM;MACrEJ,MAAM,CAACM,MAAP,CAAc,MAAM;QAClBL,EAAE,CACA,EADA,EAEAE,YAFA,EAGA,uEAHA,CAAF;MAKD,CAND,EAMG,4BANH;IAOD,CARG,CAAJ;IAUAC,IAAI,CAAC,2DAAD,EAA8D,MAAM;MACtEJ,MAAM,CAACM,MAAP,CAAc,MAAM;QAClBL,EAAE,CACA,EADA,EAEAE,YAFA,EAGA,uEAHA,CAAF;MAKD,CAND,EAMG,4BANH;IAOD,CARG,CAAJ;IAUAC,IAAI,CAAC,wDAAD,EAA2D,MAAM;MACnEJ,MAAM,CAACM,MAAP,CAAc,MAAM;QAClBL,EAAE,CACA,EADA,EAEAE,YAFA,EAGA,uEAHA,CAAF;MAKD,CAND,EAMG,4BANH;IAOD,CARG,CAAJ;IAUAC,IAAI,CAAC,6DAAD,EAAgE,MAAM;MACxEJ,MAAM,CAACM,MAAP,CAAc,MAAM;QAClBL,EAAE,CACA,EADA,EAEAE,YAFA,EAGA,iEAHA,CAAF;MAKD,CAND,EAMG,yBANH;IAOD,CARG,CAAJ;IASAC,IAAI,CAAC,qFAAD,EAAwF,MAAM;MAChGJ,MAAM,CAACK,SAAP,CACEJ,EAAE,CACA;QAAE6B,YAAY,EAAE;MAAhB,CADA,EAEA3B,YAFA,EAGA,iEAHA,CADJ,EAME;QACEqB,IAAI,EAAE,CADR;QAEEC,IAAI,EAAE,IAFR;QAGEH,IAAI,EAAE,IAHR;QAIEC,KAAK,EAAE,CAAC,MAAD,EAAS,QAAT,EAAmB,SAAnB;MAJT,CANF;IAaD,CAdG,CAAJ;EAeD,CA/OO,CAAR;AAgPD,CAjWO,CAAR"}
|
package/src/index.d.ts
DELETED
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
type QSOptions = {
|
|
2
|
-
allowEmptySearch: boolean;
|
|
3
|
-
allowUnknownParams: boolean;
|
|
4
|
-
allowDefault: boolean;
|
|
5
|
-
allowUnorderedParams: boolean;
|
|
6
|
-
};
|
|
7
|
-
type QSValue = string | number | boolean;
|
|
8
|
-
type QSParamValue = QSValue;
|
|
9
|
-
type QSParamType = 'string' | 'number' | 'boolean';
|
|
10
|
-
|
|
11
|
-
type QSUniqueParameter = {
|
|
12
|
-
name: string;
|
|
13
|
-
in: 'query';
|
|
14
|
-
pattern?: string;
|
|
15
|
-
enum?: QSParamValue[];
|
|
16
|
-
type: QSParamType;
|
|
17
|
-
};
|
|
18
|
-
|
|
19
|
-
type QSArrayParameter = {
|
|
20
|
-
name: string;
|
|
21
|
-
in: 'query';
|
|
22
|
-
type: 'array';
|
|
23
|
-
ordered: boolean;
|
|
24
|
-
items: {
|
|
25
|
-
pattern?: string;
|
|
26
|
-
enum?: QSParamValue[];
|
|
27
|
-
type: QSParamType;
|
|
28
|
-
};
|
|
29
|
-
};
|
|
30
|
-
|
|
31
|
-
type QSParameter = QSUniqueParameter | QSArrayParameter;
|
|
32
|
-
|
|
33
|
-
declare function qsStrict(
|
|
34
|
-
options: QSOptions,
|
|
35
|
-
definitions: QSParameter[],
|
|
36
|
-
search: string,
|
|
37
|
-
): {
|
|
38
|
-
[name: string]: QSValue | QSValue[];
|
|
39
|
-
};
|
|
40
|
-
|
|
41
|
-
export default qsStrict;
|
|
42
|
-
|
|
43
|
-
export function parseReentrantNumber(str: string): number;
|
|
44
|
-
|
|
45
|
-
export function parseBoolean(str: string): boolean;
|
|
46
|
-
|
|
47
|
-
export function decodeQueryComponent(value: string): string;
|