You can not select more than 25 topics
			Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
		
		
		
		
		
			
		
			
				
					327 lines
				
				10 KiB
			
		
		
			
		
	
	
					327 lines
				
				10 KiB
			| 
											3 years ago
										 | 'use strict'; | ||
|  | 
 | ||
|  | var getSideChannel = require('side-channel'); | ||
|  | var utils = require('./utils'); | ||
|  | var formats = require('./formats'); | ||
|  | var has = Object.prototype.hasOwnProperty; | ||
|  | 
 | ||
|  | var arrayPrefixGenerators = { | ||
|  |     brackets: function brackets(prefix) { | ||
|  |         return prefix + '[]'; | ||
|  |     }, | ||
|  |     comma: 'comma', | ||
|  |     indices: function indices(prefix, key) { | ||
|  |         return prefix + '[' + key + ']'; | ||
|  |     }, | ||
|  |     repeat: function repeat(prefix) { | ||
|  |         return prefix; | ||
|  |     } | ||
|  | }; | ||
|  | 
 | ||
|  | var isArray = Array.isArray; | ||
|  | var split = String.prototype.split; | ||
|  | var push = Array.prototype.push; | ||
|  | var pushToArray = function (arr, valueOrArray) { | ||
|  |     push.apply(arr, isArray(valueOrArray) ? valueOrArray : [valueOrArray]); | ||
|  | }; | ||
|  | 
 | ||
|  | var toISO = Date.prototype.toISOString; | ||
|  | 
 | ||
|  | var defaultFormat = formats['default']; | ||
|  | var defaults = { | ||
|  |     addQueryPrefix: false, | ||
|  |     allowDots: false, | ||
|  |     charset: 'utf-8', | ||
|  |     charsetSentinel: false, | ||
|  |     delimiter: '&', | ||
|  |     encode: true, | ||
|  |     encoder: utils.encode, | ||
|  |     encodeValuesOnly: false, | ||
|  |     format: defaultFormat, | ||
|  |     formatter: formats.formatters[defaultFormat], | ||
|  |     // deprecated
 | ||
|  |     indices: false, | ||
|  |     serializeDate: function serializeDate(date) { | ||
|  |         return toISO.call(date); | ||
|  |     }, | ||
|  |     skipNulls: false, | ||
|  |     strictNullHandling: false | ||
|  | }; | ||
|  | 
 | ||
|  | var isNonNullishPrimitive = function isNonNullishPrimitive(v) { | ||
|  |     return typeof v === 'string' | ||
|  |         || typeof v === 'number' | ||
|  |         || typeof v === 'boolean' | ||
|  |         || typeof v === 'symbol' | ||
|  |         || typeof v === 'bigint'; | ||
|  | }; | ||
|  | 
 | ||
|  | var sentinel = {}; | ||
|  | 
 | ||
|  | var stringify = function stringify( | ||
|  |     object, | ||
|  |     prefix, | ||
|  |     generateArrayPrefix, | ||
|  |     commaRoundTrip, | ||
|  |     strictNullHandling, | ||
|  |     skipNulls, | ||
|  |     encoder, | ||
|  |     filter, | ||
|  |     sort, | ||
|  |     allowDots, | ||
|  |     serializeDate, | ||
|  |     format, | ||
|  |     formatter, | ||
|  |     encodeValuesOnly, | ||
|  |     charset, | ||
|  |     sideChannel | ||
|  | ) { | ||
|  |     var obj = object; | ||
|  | 
 | ||
|  |     var tmpSc = sideChannel; | ||
|  |     var step = 0; | ||
|  |     var findFlag = false; | ||
|  |     while ((tmpSc = tmpSc.get(sentinel)) !== void undefined && !findFlag) { | ||
|  |         // Where object last appeared in the ref tree
 | ||
|  |         var pos = tmpSc.get(object); | ||
|  |         step += 1; | ||
|  |         if (typeof pos !== 'undefined') { | ||
|  |             if (pos === step) { | ||
|  |                 throw new RangeError('Cyclic object value'); | ||
|  |             } else { | ||
|  |                 findFlag = true; // Break while
 | ||
|  |             } | ||
|  |         } | ||
|  |         if (typeof tmpSc.get(sentinel) === 'undefined') { | ||
|  |             step = 0; | ||
|  |         } | ||
|  |     } | ||
|  | 
 | ||
|  |     if (typeof filter === 'function') { | ||
|  |         obj = filter(prefix, obj); | ||
|  |     } else if (obj instanceof Date) { | ||
|  |         obj = serializeDate(obj); | ||
|  |     } else if (generateArrayPrefix === 'comma' && isArray(obj)) { | ||
|  |         obj = utils.maybeMap(obj, function (value) { | ||
|  |             if (value instanceof Date) { | ||
|  |                 return serializeDate(value); | ||
|  |             } | ||
|  |             return value; | ||
|  |         }); | ||
|  |     } | ||
|  | 
 | ||
|  |     if (obj === null) { | ||
|  |         if (strictNullHandling) { | ||
|  |             return encoder && !encodeValuesOnly ? encoder(prefix, defaults.encoder, charset, 'key', format) : prefix; | ||
|  |         } | ||
|  | 
 | ||
|  |         obj = ''; | ||
|  |     } | ||
|  | 
 | ||
|  |     if (isNonNullishPrimitive(obj) || utils.isBuffer(obj)) { | ||
|  |         if (encoder) { | ||
|  |             var keyValue = encodeValuesOnly ? prefix : encoder(prefix, defaults.encoder, charset, 'key', format); | ||
|  |             if (generateArrayPrefix === 'comma' && encodeValuesOnly) { | ||
|  |                 var valuesArray = split.call(String(obj), ','); | ||
|  |                 var valuesJoined = ''; | ||
|  |                 for (var i = 0; i < valuesArray.length; ++i) { | ||
|  |                     valuesJoined += (i === 0 ? '' : ',') + formatter(encoder(valuesArray[i], defaults.encoder, charset, 'value', format)); | ||
|  |                 } | ||
|  |                 return [formatter(keyValue) + (commaRoundTrip && isArray(obj) && valuesArray.length === 1 ? '[]' : '') + '=' + valuesJoined]; | ||
|  |             } | ||
|  |             return [formatter(keyValue) + '=' + formatter(encoder(obj, defaults.encoder, charset, 'value', format))]; | ||
|  |         } | ||
|  |         return [formatter(prefix) + '=' + formatter(String(obj))]; | ||
|  |     } | ||
|  | 
 | ||
|  |     var values = []; | ||
|  | 
 | ||
|  |     if (typeof obj === 'undefined') { | ||
|  |         return values; | ||
|  |     } | ||
|  | 
 | ||
|  |     var objKeys; | ||
|  |     if (generateArrayPrefix === 'comma' && isArray(obj)) { | ||
|  |         // we need to join elements in
 | ||
|  |         objKeys = [{ value: obj.length > 0 ? obj.join(',') || null : void undefined }]; | ||
|  |     } else if (isArray(filter)) { | ||
|  |         objKeys = filter; | ||
|  |     } else { | ||
|  |         var keys = Object.keys(obj); | ||
|  |         objKeys = sort ? keys.sort(sort) : keys; | ||
|  |     } | ||
|  | 
 | ||
|  |     var adjustedPrefix = commaRoundTrip && isArray(obj) && obj.length === 1 ? prefix + '[]' : prefix; | ||
|  | 
 | ||
|  |     for (var j = 0; j < objKeys.length; ++j) { | ||
|  |         var key = objKeys[j]; | ||
|  |         var value = typeof key === 'object' && typeof key.value !== 'undefined' ? key.value : obj[key]; | ||
|  | 
 | ||
|  |         if (skipNulls && value === null) { | ||
|  |             continue; | ||
|  |         } | ||
|  | 
 | ||
|  |         var keyPrefix = isArray(obj) | ||
|  |             ? typeof generateArrayPrefix === 'function' ? generateArrayPrefix(adjustedPrefix, key) : adjustedPrefix | ||
|  |             : adjustedPrefix + (allowDots ? '.' + key : '[' + key + ']'); | ||
|  | 
 | ||
|  |         sideChannel.set(object, step); | ||
|  |         var valueSideChannel = getSideChannel(); | ||
|  |         valueSideChannel.set(sentinel, sideChannel); | ||
|  |         pushToArray(values, stringify( | ||
|  |             value, | ||
|  |             keyPrefix, | ||
|  |             generateArrayPrefix, | ||
|  |             commaRoundTrip, | ||
|  |             strictNullHandling, | ||
|  |             skipNulls, | ||
|  |             encoder, | ||
|  |             filter, | ||
|  |             sort, | ||
|  |             allowDots, | ||
|  |             serializeDate, | ||
|  |             format, | ||
|  |             formatter, | ||
|  |             encodeValuesOnly, | ||
|  |             charset, | ||
|  |             valueSideChannel | ||
|  |         )); | ||
|  |     } | ||
|  | 
 | ||
|  |     return values; | ||
|  | }; | ||
|  | 
 | ||
|  | var normalizeStringifyOptions = function normalizeStringifyOptions(opts) { | ||
|  |     if (!opts) { | ||
|  |         return defaults; | ||
|  |     } | ||
|  | 
 | ||
|  |     if (opts.encoder !== null && typeof opts.encoder !== 'undefined' && typeof opts.encoder !== 'function') { | ||
|  |         throw new TypeError('Encoder has to be a function.'); | ||
|  |     } | ||
|  | 
 | ||
|  |     var charset = opts.charset || defaults.charset; | ||
|  |     if (typeof opts.charset !== 'undefined' && opts.charset !== 'utf-8' && opts.charset !== 'iso-8859-1') { | ||
|  |         throw new TypeError('The charset option must be either utf-8, iso-8859-1, or undefined'); | ||
|  |     } | ||
|  | 
 | ||
|  |     var format = formats['default']; | ||
|  |     if (typeof opts.format !== 'undefined') { | ||
|  |         if (!has.call(formats.formatters, opts.format)) { | ||
|  |             throw new TypeError('Unknown format option provided.'); | ||
|  |         } | ||
|  |         format = opts.format; | ||
|  |     } | ||
|  |     var formatter = formats.formatters[format]; | ||
|  | 
 | ||
|  |     var filter = defaults.filter; | ||
|  |     if (typeof opts.filter === 'function' || isArray(opts.filter)) { | ||
|  |         filter = opts.filter; | ||
|  |     } | ||
|  | 
 | ||
|  |     return { | ||
|  |         addQueryPrefix: typeof opts.addQueryPrefix === 'boolean' ? opts.addQueryPrefix : defaults.addQueryPrefix, | ||
|  |         allowDots: typeof opts.allowDots === 'undefined' ? defaults.allowDots : !!opts.allowDots, | ||
|  |         charset: charset, | ||
|  |         charsetSentinel: typeof opts.charsetSentinel === 'boolean' ? opts.charsetSentinel : defaults.charsetSentinel, | ||
|  |         delimiter: typeof opts.delimiter === 'undefined' ? defaults.delimiter : opts.delimiter, | ||
|  |         encode: typeof opts.encode === 'boolean' ? opts.encode : defaults.encode, | ||
|  |         encoder: typeof opts.encoder === 'function' ? opts.encoder : defaults.encoder, | ||
|  |         encodeValuesOnly: typeof opts.encodeValuesOnly === 'boolean' ? opts.encodeValuesOnly : defaults.encodeValuesOnly, | ||
|  |         filter: filter, | ||
|  |         format: format, | ||
|  |         formatter: formatter, | ||
|  |         serializeDate: typeof opts.serializeDate === 'function' ? opts.serializeDate : defaults.serializeDate, | ||
|  |         skipNulls: typeof opts.skipNulls === 'boolean' ? opts.skipNulls : defaults.skipNulls, | ||
|  |         sort: typeof opts.sort === 'function' ? opts.sort : null, | ||
|  |         strictNullHandling: typeof opts.strictNullHandling === 'boolean' ? opts.strictNullHandling : defaults.strictNullHandling | ||
|  |     }; | ||
|  | }; | ||
|  | 
 | ||
|  | module.exports = function (object, opts) { | ||
|  |     var obj = object; | ||
|  |     var options = normalizeStringifyOptions(opts); | ||
|  | 
 | ||
|  |     var objKeys; | ||
|  |     var filter; | ||
|  | 
 | ||
|  |     if (typeof options.filter === 'function') { | ||
|  |         filter = options.filter; | ||
|  |         obj = filter('', obj); | ||
|  |     } else if (isArray(options.filter)) { | ||
|  |         filter = options.filter; | ||
|  |         objKeys = filter; | ||
|  |     } | ||
|  | 
 | ||
|  |     var keys = []; | ||
|  | 
 | ||
|  |     if (typeof obj !== 'object' || obj === null) { | ||
|  |         return ''; | ||
|  |     } | ||
|  | 
 | ||
|  |     var arrayFormat; | ||
|  |     if (opts && opts.arrayFormat in arrayPrefixGenerators) { | ||
|  |         arrayFormat = opts.arrayFormat; | ||
|  |     } else if (opts && 'indices' in opts) { | ||
|  |         arrayFormat = opts.indices ? 'indices' : 'repeat'; | ||
|  |     } else { | ||
|  |         arrayFormat = 'indices'; | ||
|  |     } | ||
|  | 
 | ||
|  |     var generateArrayPrefix = arrayPrefixGenerators[arrayFormat]; | ||
|  |     if (opts && 'commaRoundTrip' in opts && typeof opts.commaRoundTrip !== 'boolean') { | ||
|  |         throw new TypeError('`commaRoundTrip` must be a boolean, or absent'); | ||
|  |     } | ||
|  |     var commaRoundTrip = generateArrayPrefix === 'comma' && opts && opts.commaRoundTrip; | ||
|  | 
 | ||
|  |     if (!objKeys) { | ||
|  |         objKeys = Object.keys(obj); | ||
|  |     } | ||
|  | 
 | ||
|  |     if (options.sort) { | ||
|  |         objKeys.sort(options.sort); | ||
|  |     } | ||
|  | 
 | ||
|  |     var sideChannel = getSideChannel(); | ||
|  |     for (var i = 0; i < objKeys.length; ++i) { | ||
|  |         var key = objKeys[i]; | ||
|  | 
 | ||
|  |         if (options.skipNulls && obj[key] === null) { | ||
|  |             continue; | ||
|  |         } | ||
|  |         pushToArray(keys, stringify( | ||
|  |             obj[key], | ||
|  |             key, | ||
|  |             generateArrayPrefix, | ||
|  |             commaRoundTrip, | ||
|  |             options.strictNullHandling, | ||
|  |             options.skipNulls, | ||
|  |             options.encode ? options.encoder : null, | ||
|  |             options.filter, | ||
|  |             options.sort, | ||
|  |             options.allowDots, | ||
|  |             options.serializeDate, | ||
|  |             options.format, | ||
|  |             options.formatter, | ||
|  |             options.encodeValuesOnly, | ||
|  |             options.charset, | ||
|  |             sideChannel | ||
|  |         )); | ||
|  |     } | ||
|  | 
 | ||
|  |     var joined = keys.join(options.delimiter); | ||
|  |     var prefix = options.addQueryPrefix === true ? '?' : ''; | ||
|  | 
 | ||
|  |     if (options.charsetSentinel) { | ||
|  |         if (options.charset === 'iso-8859-1') { | ||
|  |             // encodeURIComponent('✓'), the "numeric entity" representation of a checkmark
 | ||
|  |             prefix += 'utf8=%26%2310003%3B&'; | ||
|  |         } else { | ||
|  |             // encodeURIComponent('✓')
 | ||
|  |             prefix += 'utf8=%E2%9C%93&'; | ||
|  |         } | ||
|  |     } | ||
|  | 
 | ||
|  |     return joined.length > 0 ? prefix + joined : ''; | ||
|  | }; |