stringify.js 11 KB

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