stringify.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", { value: true });
  3. exports.stringify = stringify;
  4. const utils_1 = require("./utils.js");
  5. const formats_1 = require("./formats.js");
  6. const values_1 = require("../utils/values.js");
  7. const array_prefix_generators = {
  8. brackets(prefix) {
  9. return String(prefix) + '[]';
  10. },
  11. comma: 'comma',
  12. indices(prefix, key) {
  13. return String(prefix) + '[' + key + ']';
  14. },
  15. repeat(prefix) {
  16. return String(prefix);
  17. },
  18. };
  19. const push_to_array = function (arr, value_or_array) {
  20. Array.prototype.push.apply(arr, (0, values_1.isArray)(value_or_array) ? value_or_array : [value_or_array]);
  21. };
  22. let toISOString;
  23. const defaults = {
  24. addQueryPrefix: false,
  25. allowDots: false,
  26. allowEmptyArrays: false,
  27. arrayFormat: 'indices',
  28. charset: 'utf-8',
  29. charsetSentinel: false,
  30. delimiter: '&',
  31. encode: true,
  32. encodeDotInKeys: false,
  33. encoder: utils_1.encode,
  34. encodeValuesOnly: false,
  35. format: formats_1.default_format,
  36. formatter: formats_1.default_formatter,
  37. /** @deprecated */
  38. indices: false,
  39. serializeDate(date) {
  40. return (toISOString ?? (toISOString = Function.prototype.call.bind(Date.prototype.toISOString)))(date);
  41. },
  42. skipNulls: false,
  43. strictNullHandling: false,
  44. };
  45. function is_non_nullish_primitive(v) {
  46. return (typeof v === 'string' ||
  47. typeof v === 'number' ||
  48. typeof v === 'boolean' ||
  49. typeof v === 'symbol' ||
  50. typeof v === 'bigint');
  51. }
  52. const sentinel = {};
  53. function inner_stringify(object, prefix, generateArrayPrefix, commaRoundTrip, allowEmptyArrays, strictNullHandling, skipNulls, encodeDotInKeys, encoder, filter, sort, allowDots, serializeDate, format, formatter, encodeValuesOnly, charset, sideChannel) {
  54. let obj = object;
  55. let tmp_sc = sideChannel;
  56. let step = 0;
  57. let find_flag = false;
  58. while ((tmp_sc = tmp_sc.get(sentinel)) !== void undefined && !find_flag) {
  59. // Where object last appeared in the ref tree
  60. const pos = tmp_sc.get(object);
  61. step += 1;
  62. if (typeof pos !== 'undefined') {
  63. if (pos === step) {
  64. throw new RangeError('Cyclic object value');
  65. }
  66. else {
  67. find_flag = true; // Break while
  68. }
  69. }
  70. if (typeof tmp_sc.get(sentinel) === 'undefined') {
  71. step = 0;
  72. }
  73. }
  74. if (typeof filter === 'function') {
  75. obj = filter(prefix, obj);
  76. }
  77. else if (obj instanceof Date) {
  78. obj = serializeDate?.(obj);
  79. }
  80. else if (generateArrayPrefix === 'comma' && (0, values_1.isArray)(obj)) {
  81. obj = (0, utils_1.maybe_map)(obj, function (value) {
  82. if (value instanceof Date) {
  83. return serializeDate?.(value);
  84. }
  85. return value;
  86. });
  87. }
  88. if (obj === null) {
  89. if (strictNullHandling) {
  90. return encoder && !encodeValuesOnly ?
  91. // @ts-expect-error
  92. encoder(prefix, defaults.encoder, charset, 'key', format)
  93. : prefix;
  94. }
  95. obj = '';
  96. }
  97. if (is_non_nullish_primitive(obj) || (0, utils_1.is_buffer)(obj)) {
  98. if (encoder) {
  99. const key_value = encodeValuesOnly ? prefix
  100. // @ts-expect-error
  101. : encoder(prefix, defaults.encoder, charset, 'key', format);
  102. return [
  103. formatter?.(key_value) +
  104. '=' +
  105. // @ts-expect-error
  106. formatter?.(encoder(obj, defaults.encoder, charset, 'value', format)),
  107. ];
  108. }
  109. return [formatter?.(prefix) + '=' + formatter?.(String(obj))];
  110. }
  111. const values = [];
  112. if (typeof obj === 'undefined') {
  113. return values;
  114. }
  115. let obj_keys;
  116. if (generateArrayPrefix === 'comma' && (0, values_1.isArray)(obj)) {
  117. // we need to join elements in
  118. if (encodeValuesOnly && encoder) {
  119. // @ts-expect-error values only
  120. obj = (0, utils_1.maybe_map)(obj, encoder);
  121. }
  122. obj_keys = [{ value: obj.length > 0 ? obj.join(',') || null : void undefined }];
  123. }
  124. else if ((0, values_1.isArray)(filter)) {
  125. obj_keys = filter;
  126. }
  127. else {
  128. const keys = Object.keys(obj);
  129. obj_keys = sort ? keys.sort(sort) : keys;
  130. }
  131. const encoded_prefix = encodeDotInKeys ? String(prefix).replace(/\./g, '%2E') : String(prefix);
  132. const adjusted_prefix = commaRoundTrip && (0, values_1.isArray)(obj) && obj.length === 1 ? encoded_prefix + '[]' : encoded_prefix;
  133. if (allowEmptyArrays && (0, values_1.isArray)(obj) && obj.length === 0) {
  134. return adjusted_prefix + '[]';
  135. }
  136. for (let j = 0; j < obj_keys.length; ++j) {
  137. const key = obj_keys[j];
  138. const value =
  139. // @ts-ignore
  140. typeof key === 'object' && typeof key.value !== 'undefined' ? key.value : obj[key];
  141. if (skipNulls && value === null) {
  142. continue;
  143. }
  144. // @ts-ignore
  145. const encoded_key = allowDots && encodeDotInKeys ? key.replace(/\./g, '%2E') : key;
  146. const key_prefix = (0, values_1.isArray)(obj) ?
  147. typeof generateArrayPrefix === 'function' ?
  148. generateArrayPrefix(adjusted_prefix, encoded_key)
  149. : adjusted_prefix
  150. : adjusted_prefix + (allowDots ? '.' + encoded_key : '[' + encoded_key + ']');
  151. sideChannel.set(object, step);
  152. const valueSideChannel = new WeakMap();
  153. valueSideChannel.set(sentinel, sideChannel);
  154. push_to_array(values, inner_stringify(value, key_prefix, generateArrayPrefix, commaRoundTrip, allowEmptyArrays, strictNullHandling, skipNulls, encodeDotInKeys,
  155. // @ts-ignore
  156. generateArrayPrefix === 'comma' && encodeValuesOnly && (0, values_1.isArray)(obj) ? null : encoder, filter, sort, allowDots, serializeDate, format, formatter, encodeValuesOnly, charset, valueSideChannel));
  157. }
  158. return values;
  159. }
  160. function normalize_stringify_options(opts = defaults) {
  161. if (typeof opts.allowEmptyArrays !== 'undefined' && typeof opts.allowEmptyArrays !== 'boolean') {
  162. throw new TypeError('`allowEmptyArrays` option can only be `true` or `false`, when provided');
  163. }
  164. if (typeof opts.encodeDotInKeys !== 'undefined' && typeof opts.encodeDotInKeys !== 'boolean') {
  165. throw new TypeError('`encodeDotInKeys` option can only be `true` or `false`, when provided');
  166. }
  167. if (opts.encoder !== null && typeof opts.encoder !== 'undefined' && typeof opts.encoder !== 'function') {
  168. throw new TypeError('Encoder has to be a function.');
  169. }
  170. const charset = opts.charset || defaults.charset;
  171. if (typeof opts.charset !== 'undefined' && opts.charset !== 'utf-8' && opts.charset !== 'iso-8859-1') {
  172. throw new TypeError('The charset option must be either utf-8, iso-8859-1, or undefined');
  173. }
  174. let format = formats_1.default_format;
  175. if (typeof opts.format !== 'undefined') {
  176. if (!(0, utils_1.has)(formats_1.formatters, opts.format)) {
  177. throw new TypeError('Unknown format option provided.');
  178. }
  179. format = opts.format;
  180. }
  181. const formatter = formats_1.formatters[format];
  182. let filter = defaults.filter;
  183. if (typeof opts.filter === 'function' || (0, values_1.isArray)(opts.filter)) {
  184. filter = opts.filter;
  185. }
  186. let arrayFormat;
  187. if (opts.arrayFormat && opts.arrayFormat in array_prefix_generators) {
  188. arrayFormat = opts.arrayFormat;
  189. }
  190. else if ('indices' in opts) {
  191. arrayFormat = opts.indices ? 'indices' : 'repeat';
  192. }
  193. else {
  194. arrayFormat = defaults.arrayFormat;
  195. }
  196. if ('commaRoundTrip' in opts && typeof opts.commaRoundTrip !== 'boolean') {
  197. throw new TypeError('`commaRoundTrip` must be a boolean, or absent');
  198. }
  199. const allowDots = typeof opts.allowDots === 'undefined' ?
  200. !!opts.encodeDotInKeys === true ?
  201. true
  202. : defaults.allowDots
  203. : !!opts.allowDots;
  204. return {
  205. addQueryPrefix: typeof opts.addQueryPrefix === 'boolean' ? opts.addQueryPrefix : defaults.addQueryPrefix,
  206. // @ts-ignore
  207. allowDots: allowDots,
  208. allowEmptyArrays: typeof opts.allowEmptyArrays === 'boolean' ? !!opts.allowEmptyArrays : defaults.allowEmptyArrays,
  209. arrayFormat: arrayFormat,
  210. charset: charset,
  211. charsetSentinel: typeof opts.charsetSentinel === 'boolean' ? opts.charsetSentinel : defaults.charsetSentinel,
  212. commaRoundTrip: !!opts.commaRoundTrip,
  213. delimiter: typeof opts.delimiter === 'undefined' ? defaults.delimiter : opts.delimiter,
  214. encode: typeof opts.encode === 'boolean' ? opts.encode : defaults.encode,
  215. encodeDotInKeys: typeof opts.encodeDotInKeys === 'boolean' ? opts.encodeDotInKeys : defaults.encodeDotInKeys,
  216. encoder: typeof opts.encoder === 'function' ? opts.encoder : defaults.encoder,
  217. encodeValuesOnly: typeof opts.encodeValuesOnly === 'boolean' ? opts.encodeValuesOnly : defaults.encodeValuesOnly,
  218. filter: filter,
  219. format: format,
  220. formatter: formatter,
  221. serializeDate: typeof opts.serializeDate === 'function' ? opts.serializeDate : defaults.serializeDate,
  222. skipNulls: typeof opts.skipNulls === 'boolean' ? opts.skipNulls : defaults.skipNulls,
  223. // @ts-ignore
  224. sort: typeof opts.sort === 'function' ? opts.sort : null,
  225. strictNullHandling: typeof opts.strictNullHandling === 'boolean' ? opts.strictNullHandling : defaults.strictNullHandling,
  226. };
  227. }
  228. function stringify(object, opts = {}) {
  229. let obj = object;
  230. const options = normalize_stringify_options(opts);
  231. let obj_keys;
  232. let filter;
  233. if (typeof options.filter === 'function') {
  234. filter = options.filter;
  235. obj = filter('', obj);
  236. }
  237. else if ((0, values_1.isArray)(options.filter)) {
  238. filter = options.filter;
  239. obj_keys = filter;
  240. }
  241. const keys = [];
  242. if (typeof obj !== 'object' || obj === null) {
  243. return '';
  244. }
  245. const generateArrayPrefix = array_prefix_generators[options.arrayFormat];
  246. const commaRoundTrip = generateArrayPrefix === 'comma' && options.commaRoundTrip;
  247. if (!obj_keys) {
  248. obj_keys = Object.keys(obj);
  249. }
  250. if (options.sort) {
  251. obj_keys.sort(options.sort);
  252. }
  253. const sideChannel = new WeakMap();
  254. for (let i = 0; i < obj_keys.length; ++i) {
  255. const key = obj_keys[i];
  256. if (options.skipNulls && obj[key] === null) {
  257. continue;
  258. }
  259. push_to_array(keys, inner_stringify(obj[key], key,
  260. // @ts-expect-error
  261. 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));
  262. }
  263. const joined = keys.join(options.delimiter);
  264. let prefix = options.addQueryPrefix === true ? '?' : '';
  265. if (options.charsetSentinel) {
  266. if (options.charset === 'iso-8859-1') {
  267. // encodeURIComponent('&#10003;'), the "numeric entity" representation of a checkmark
  268. prefix += 'utf8=%26%2310003%3B&';
  269. }
  270. else {
  271. // encodeURIComponent('✓')
  272. prefix += 'utf8=%E2%9C%93&';
  273. }
  274. }
  275. return joined.length > 0 ? prefix + joined : '';
  276. }
  277. //# sourceMappingURL=stringify.js.map