276 lines
No EOL
11 KiB
JavaScript
276 lines
No EOL
11 KiB
JavaScript
import { encode, is_buffer, maybe_map } from "./utils.mjs";
|
|
import { default_format, formatters } from "./formats.mjs";
|
|
const has = Object.prototype.hasOwnProperty;
|
|
const array_prefix_generators = {
|
|
brackets(prefix) {
|
|
return String(prefix) + '[]';
|
|
},
|
|
comma: 'comma',
|
|
indices(prefix, key) {
|
|
return String(prefix) + '[' + key + ']';
|
|
},
|
|
repeat(prefix) {
|
|
return String(prefix);
|
|
},
|
|
};
|
|
const is_array = Array.isArray;
|
|
const push = Array.prototype.push;
|
|
const push_to_array = function (arr, value_or_array) {
|
|
push.apply(arr, is_array(value_or_array) ? value_or_array : [value_or_array]);
|
|
};
|
|
const to_ISO = Date.prototype.toISOString;
|
|
const defaults = {
|
|
addQueryPrefix: false,
|
|
allowDots: false,
|
|
allowEmptyArrays: false,
|
|
arrayFormat: 'indices',
|
|
charset: 'utf-8',
|
|
charsetSentinel: false,
|
|
delimiter: '&',
|
|
encode: true,
|
|
encodeDotInKeys: false,
|
|
encoder: encode,
|
|
encodeValuesOnly: false,
|
|
format: default_format,
|
|
formatter: formatters[default_format],
|
|
/** @deprecated */
|
|
indices: false,
|
|
serializeDate(date) {
|
|
return to_ISO.call(date);
|
|
},
|
|
skipNulls: false,
|
|
strictNullHandling: false,
|
|
};
|
|
function is_non_nullish_primitive(v) {
|
|
return (typeof v === 'string' ||
|
|
typeof v === 'number' ||
|
|
typeof v === 'boolean' ||
|
|
typeof v === 'symbol' ||
|
|
typeof v === 'bigint');
|
|
}
|
|
const sentinel = {};
|
|
function inner_stringify(object, prefix, generateArrayPrefix, commaRoundTrip, allowEmptyArrays, strictNullHandling, skipNulls, encodeDotInKeys, encoder, filter, sort, allowDots, serializeDate, format, formatter, encodeValuesOnly, charset, sideChannel) {
|
|
let obj = object;
|
|
let tmp_sc = sideChannel;
|
|
let step = 0;
|
|
let find_flag = false;
|
|
while ((tmp_sc = tmp_sc.get(sentinel)) !== void undefined && !find_flag) {
|
|
// Where object last appeared in the ref tree
|
|
const pos = tmp_sc.get(object);
|
|
step += 1;
|
|
if (typeof pos !== 'undefined') {
|
|
if (pos === step) {
|
|
throw new RangeError('Cyclic object value');
|
|
}
|
|
else {
|
|
find_flag = true; // Break while
|
|
}
|
|
}
|
|
if (typeof tmp_sc.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' && is_array(obj)) {
|
|
obj = maybe_map(obj, function (value) {
|
|
if (value instanceof Date) {
|
|
return serializeDate?.(value);
|
|
}
|
|
return value;
|
|
});
|
|
}
|
|
if (obj === null) {
|
|
if (strictNullHandling) {
|
|
return encoder && !encodeValuesOnly ?
|
|
// @ts-expect-error
|
|
encoder(prefix, defaults.encoder, charset, 'key', format)
|
|
: prefix;
|
|
}
|
|
obj = '';
|
|
}
|
|
if (is_non_nullish_primitive(obj) || is_buffer(obj)) {
|
|
if (encoder) {
|
|
const key_value = encodeValuesOnly ? prefix
|
|
// @ts-expect-error
|
|
: encoder(prefix, defaults.encoder, charset, 'key', format);
|
|
return [
|
|
formatter?.(key_value) +
|
|
'=' +
|
|
// @ts-expect-error
|
|
formatter?.(encoder(obj, defaults.encoder, charset, 'value', format)),
|
|
];
|
|
}
|
|
return [formatter?.(prefix) + '=' + formatter?.(String(obj))];
|
|
}
|
|
const values = [];
|
|
if (typeof obj === 'undefined') {
|
|
return values;
|
|
}
|
|
let obj_keys;
|
|
if (generateArrayPrefix === 'comma' && is_array(obj)) {
|
|
// we need to join elements in
|
|
if (encodeValuesOnly && encoder) {
|
|
// @ts-expect-error values only
|
|
obj = maybe_map(obj, encoder);
|
|
}
|
|
obj_keys = [{ value: obj.length > 0 ? obj.join(',') || null : void undefined }];
|
|
}
|
|
else if (is_array(filter)) {
|
|
obj_keys = filter;
|
|
}
|
|
else {
|
|
const keys = Object.keys(obj);
|
|
obj_keys = sort ? keys.sort(sort) : keys;
|
|
}
|
|
const encoded_prefix = encodeDotInKeys ? String(prefix).replace(/\./g, '%2E') : String(prefix);
|
|
const adjusted_prefix = commaRoundTrip && is_array(obj) && obj.length === 1 ? encoded_prefix + '[]' : encoded_prefix;
|
|
if (allowEmptyArrays && is_array(obj) && obj.length === 0) {
|
|
return adjusted_prefix + '[]';
|
|
}
|
|
for (let j = 0; j < obj_keys.length; ++j) {
|
|
const key = obj_keys[j];
|
|
const value =
|
|
// @ts-ignore
|
|
typeof key === 'object' && typeof key.value !== 'undefined' ? key.value : obj[key];
|
|
if (skipNulls && value === null) {
|
|
continue;
|
|
}
|
|
// @ts-ignore
|
|
const encoded_key = allowDots && encodeDotInKeys ? key.replace(/\./g, '%2E') : key;
|
|
const key_prefix = is_array(obj) ?
|
|
typeof generateArrayPrefix === 'function' ?
|
|
generateArrayPrefix(adjusted_prefix, encoded_key)
|
|
: adjusted_prefix
|
|
: adjusted_prefix + (allowDots ? '.' + encoded_key : '[' + encoded_key + ']');
|
|
sideChannel.set(object, step);
|
|
const valueSideChannel = new WeakMap();
|
|
valueSideChannel.set(sentinel, sideChannel);
|
|
push_to_array(values, inner_stringify(value, key_prefix, generateArrayPrefix, commaRoundTrip, allowEmptyArrays, strictNullHandling, skipNulls, encodeDotInKeys,
|
|
// @ts-ignore
|
|
generateArrayPrefix === 'comma' && encodeValuesOnly && is_array(obj) ? null : encoder, filter, sort, allowDots, serializeDate, format, formatter, encodeValuesOnly, charset, valueSideChannel));
|
|
}
|
|
return values;
|
|
}
|
|
function normalize_stringify_options(opts = defaults) {
|
|
if (typeof opts.allowEmptyArrays !== 'undefined' && typeof opts.allowEmptyArrays !== 'boolean') {
|
|
throw new TypeError('`allowEmptyArrays` option can only be `true` or `false`, when provided');
|
|
}
|
|
if (typeof opts.encodeDotInKeys !== 'undefined' && typeof opts.encodeDotInKeys !== 'boolean') {
|
|
throw new TypeError('`encodeDotInKeys` option can only be `true` or `false`, when provided');
|
|
}
|
|
if (opts.encoder !== null && typeof opts.encoder !== 'undefined' && typeof opts.encoder !== 'function') {
|
|
throw new TypeError('Encoder has to be a function.');
|
|
}
|
|
const 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');
|
|
}
|
|
let format = default_format;
|
|
if (typeof opts.format !== 'undefined') {
|
|
if (!has.call(formatters, opts.format)) {
|
|
throw new TypeError('Unknown format option provided.');
|
|
}
|
|
format = opts.format;
|
|
}
|
|
const formatter = formatters[format];
|
|
let filter = defaults.filter;
|
|
if (typeof opts.filter === 'function' || is_array(opts.filter)) {
|
|
filter = opts.filter;
|
|
}
|
|
let arrayFormat;
|
|
if (opts.arrayFormat && opts.arrayFormat in array_prefix_generators) {
|
|
arrayFormat = opts.arrayFormat;
|
|
}
|
|
else if ('indices' in opts) {
|
|
arrayFormat = opts.indices ? 'indices' : 'repeat';
|
|
}
|
|
else {
|
|
arrayFormat = defaults.arrayFormat;
|
|
}
|
|
if ('commaRoundTrip' in opts && typeof opts.commaRoundTrip !== 'boolean') {
|
|
throw new TypeError('`commaRoundTrip` must be a boolean, or absent');
|
|
}
|
|
const allowDots = typeof opts.allowDots === 'undefined' ?
|
|
!!opts.encodeDotInKeys === true ?
|
|
true
|
|
: defaults.allowDots
|
|
: !!opts.allowDots;
|
|
return {
|
|
addQueryPrefix: typeof opts.addQueryPrefix === 'boolean' ? opts.addQueryPrefix : defaults.addQueryPrefix,
|
|
// @ts-ignore
|
|
allowDots: allowDots,
|
|
allowEmptyArrays: typeof opts.allowEmptyArrays === 'boolean' ? !!opts.allowEmptyArrays : defaults.allowEmptyArrays,
|
|
arrayFormat: arrayFormat,
|
|
charset: charset,
|
|
charsetSentinel: typeof opts.charsetSentinel === 'boolean' ? opts.charsetSentinel : defaults.charsetSentinel,
|
|
commaRoundTrip: !!opts.commaRoundTrip,
|
|
delimiter: typeof opts.delimiter === 'undefined' ? defaults.delimiter : opts.delimiter,
|
|
encode: typeof opts.encode === 'boolean' ? opts.encode : defaults.encode,
|
|
encodeDotInKeys: typeof opts.encodeDotInKeys === 'boolean' ? opts.encodeDotInKeys : defaults.encodeDotInKeys,
|
|
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,
|
|
// @ts-ignore
|
|
sort: typeof opts.sort === 'function' ? opts.sort : null,
|
|
strictNullHandling: typeof opts.strictNullHandling === 'boolean' ? opts.strictNullHandling : defaults.strictNullHandling,
|
|
};
|
|
}
|
|
export function stringify(object, opts = {}) {
|
|
let obj = object;
|
|
const options = normalize_stringify_options(opts);
|
|
let obj_keys;
|
|
let filter;
|
|
if (typeof options.filter === 'function') {
|
|
filter = options.filter;
|
|
obj = filter('', obj);
|
|
}
|
|
else if (is_array(options.filter)) {
|
|
filter = options.filter;
|
|
obj_keys = filter;
|
|
}
|
|
const keys = [];
|
|
if (typeof obj !== 'object' || obj === null) {
|
|
return '';
|
|
}
|
|
const generateArrayPrefix = array_prefix_generators[options.arrayFormat];
|
|
const commaRoundTrip = generateArrayPrefix === 'comma' && options.commaRoundTrip;
|
|
if (!obj_keys) {
|
|
obj_keys = Object.keys(obj);
|
|
}
|
|
if (options.sort) {
|
|
obj_keys.sort(options.sort);
|
|
}
|
|
const sideChannel = new WeakMap();
|
|
for (let i = 0; i < obj_keys.length; ++i) {
|
|
const key = obj_keys[i];
|
|
if (options.skipNulls && obj[key] === null) {
|
|
continue;
|
|
}
|
|
push_to_array(keys, inner_stringify(obj[key], key,
|
|
// @ts-expect-error
|
|
generateArrayPrefix, commaRoundTrip, options.allowEmptyArrays, options.strictNullHandling, options.skipNulls, options.encodeDotInKeys, options.encode ? options.encoder : null, options.filter, options.sort, options.allowDots, options.serializeDate, options.format, options.formatter, options.encodeValuesOnly, options.charset, sideChannel));
|
|
}
|
|
const joined = keys.join(options.delimiter);
|
|
let 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 : '';
|
|
}
|
|
//# sourceMappingURL=stringify.mjs.map
|