stringify.mjs 11 KB

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