@discordjs/rest 2.6.2 → 2.6.3

package/dist/index.d.mts

@@ -6,8 +6,8 @@ import { Collection } from '@discordjs/collection';
 import { Awaitable } from '@discordjs/util';
 import { ImageSize, Snowflake } from 'discord-api-types/v10';
 export { ImageSize } from 'discord-api-types/v10';
-import { AsyncEventEmitter } from '@vladfrangu/async_event_emitter';
 import * as url from 'url';
+import { AsyncEventEmitter } from '@vladfrangu/async_event_emitter';
 
 interface IHandler {
     /**
@@ -928,14 +928,27 @@ declare class REST extends AsyncEventEmitter<RestEvents> {
     private static generateRouteData;
 }
 
+/**
+ * Options for serializing URL search parameters.
+ */
+interface MakeURLSearchParamsOptions {
+    /**
+     * How array values should be serialized.
+     *
+     * @defaultValue `'repeat'`
+     * @see {@link https://docs.discord.com/developers/reference#array-query-strings}
+     */
+    arrayFormat?: 'comma' | 'repeat';
+}
 /**
  * Creates and populates an URLSearchParams instance from an object, stripping
  * out null and undefined values, while also coercing non-strings to strings.
  *
- * @param options - The options to use
+ * @param parameters - The parameters to use
+ * @param options - The options for serializing URL search parameters
  * @returns A populated URLSearchParams instance
  */
-declare function makeURLSearchParams<OptionsType extends object>(options?: Readonly<OptionsType>): url.URLSearchParams;
+declare function makeURLSearchParams<ParametersType extends object>(parameters?: Readonly<ParametersType>, options?: MakeURLSearchParamsOptions): url.URLSearchParams;
 /**
  * Converts the response to usable data
  *
@@ -955,4 +968,4 @@ declare function calculateUserDefaultAvatarIndex(userId: Snowflake): number;
  */
 declare const version: string;
 
-export { ALLOWED_EXTENSIONS, ALLOWED_SIZES, ALLOWED_STICKER_EXTENSIONS, type APIRequest, type BaseImageURLOptions, BurstHandlerMajorIdKey, CDN, DEPRECATION_WARNING_PREFIX, DefaultRestOptions, DefaultUserAgent, DefaultUserAgentAppendix, DiscordAPIError, type DiscordErrorData, type EmojiURLOptions, type EmojiURLOptionsNotWebp, type EmojiURLOptionsWebp, type GetRateLimitOffsetFunction, HTTPError, type HandlerRequestData, type HashData, type ImageExtension, type ImageURLOptions, type InternalRequest, type InvalidRequestWarningData, type MakeURLOptions, type OAuthErrorData, OverwrittenMimeTypes, REST, RESTEvents, type RESTOptions, type RateLimitData, RateLimitError, type RateLimitQueueFilter, type RawFile, type RequestBody, type RequestData, type RequestHeaders, RequestMethod, type ResponseLike, type RestEvents, type RestEventsMap, type RouteData, type RouteLike, type StickerExtension, calculateUserDefaultAvatarIndex, makeURLSearchParams, parseResponse, version };
+export { ALLOWED_EXTENSIONS, ALLOWED_SIZES, ALLOWED_STICKER_EXTENSIONS, type APIRequest, type BaseImageURLOptions, BurstHandlerMajorIdKey, CDN, DEPRECATION_WARNING_PREFIX, DefaultRestOptions, DefaultUserAgent, DefaultUserAgentAppendix, DiscordAPIError, type DiscordErrorData, type EmojiURLOptions, type EmojiURLOptionsNotWebp, type EmojiURLOptionsWebp, type GetRateLimitOffsetFunction, HTTPError, type HandlerRequestData, type HashData, type ImageExtension, type ImageURLOptions, type InternalRequest, type InvalidRequestWarningData, type MakeURLOptions, type MakeURLSearchParamsOptions, type OAuthErrorData, OverwrittenMimeTypes, REST, RESTEvents, type RESTOptions, type RateLimitData, RateLimitError, type RateLimitQueueFilter, type RawFile, type RequestBody, type RequestData, type RequestHeaders, RequestMethod, type ResponseLike, type RestEvents, type RestEventsMap, type RouteData, type RouteLike, type StickerExtension, calculateUserDefaultAvatarIndex, makeURLSearchParams, parseResponse, version };

package/dist/index.d.ts

@@ -6,8 +6,8 @@ import { Collection } from '@discordjs/collection';
 import { Awaitable } from '@discordjs/util';
 import { ImageSize, Snowflake } from 'discord-api-types/v10';
 export { ImageSize } from 'discord-api-types/v10';
-import { AsyncEventEmitter } from '@vladfrangu/async_event_emitter';
 import * as url from 'url';
+import { AsyncEventEmitter } from '@vladfrangu/async_event_emitter';
 
 interface IHandler {
     /**
@@ -928,14 +928,27 @@ declare class REST extends AsyncEventEmitter<RestEvents> {
     private static generateRouteData;
 }
 
+/**
+ * Options for serializing URL search parameters.
+ */
+interface MakeURLSearchParamsOptions {
+    /**
+     * How array values should be serialized.
+     *
+     * @defaultValue `'repeat'`
+     * @see {@link https://docs.discord.com/developers/reference#array-query-strings}
+     */
+    arrayFormat?: 'comma' | 'repeat';
+}
 /**
  * Creates and populates an URLSearchParams instance from an object, stripping
  * out null and undefined values, while also coercing non-strings to strings.
  *
- * @param options - The options to use
+ * @param parameters - The parameters to use
+ * @param options - The options for serializing URL search parameters
  * @returns A populated URLSearchParams instance
  */
-declare function makeURLSearchParams<OptionsType extends object>(options?: Readonly<OptionsType>): url.URLSearchParams;
+declare function makeURLSearchParams<ParametersType extends object>(parameters?: Readonly<ParametersType>, options?: MakeURLSearchParamsOptions): url.URLSearchParams;
 /**
  * Converts the response to usable data
  *
@@ -955,4 +968,4 @@ declare function calculateUserDefaultAvatarIndex(userId: Snowflake): number;
  */
 declare const version: string;
 
-export { ALLOWED_EXTENSIONS, ALLOWED_SIZES, ALLOWED_STICKER_EXTENSIONS, type APIRequest, type BaseImageURLOptions, BurstHandlerMajorIdKey, CDN, DEPRECATION_WARNING_PREFIX, DefaultRestOptions, DefaultUserAgent, DefaultUserAgentAppendix, DiscordAPIError, type DiscordErrorData, type EmojiURLOptions, type EmojiURLOptionsNotWebp, type EmojiURLOptionsWebp, type GetRateLimitOffsetFunction, HTTPError, type HandlerRequestData, type HashData, type ImageExtension, type ImageURLOptions, type InternalRequest, type InvalidRequestWarningData, type MakeURLOptions, type OAuthErrorData, OverwrittenMimeTypes, REST, RESTEvents, type RESTOptions, type RateLimitData, RateLimitError, type RateLimitQueueFilter, type RawFile, type RequestBody, type RequestData, type RequestHeaders, RequestMethod, type ResponseLike, type RestEvents, type RestEventsMap, type RouteData, type RouteLike, type StickerExtension, calculateUserDefaultAvatarIndex, makeURLSearchParams, parseResponse, version };
+export { ALLOWED_EXTENSIONS, ALLOWED_SIZES, ALLOWED_STICKER_EXTENSIONS, type APIRequest, type BaseImageURLOptions, BurstHandlerMajorIdKey, CDN, DEPRECATION_WARNING_PREFIX, DefaultRestOptions, DefaultUserAgent, DefaultUserAgentAppendix, DiscordAPIError, type DiscordErrorData, type EmojiURLOptions, type EmojiURLOptionsNotWebp, type EmojiURLOptionsWebp, type GetRateLimitOffsetFunction, HTTPError, type HandlerRequestData, type HashData, type ImageExtension, type ImageURLOptions, type InternalRequest, type InvalidRequestWarningData, type MakeURLOptions, type MakeURLSearchParamsOptions, type OAuthErrorData, OverwrittenMimeTypes, REST, RESTEvents, type RESTOptions, type RateLimitData, RateLimitError, type RateLimitQueueFilter, type RawFile, type RequestBody, type RequestData, type RequestHeaders, RequestMethod, type ResponseLike, type RestEvents, type RestEventsMap, type RouteData, type RouteLike, type StickerExtension, calculateUserDefaultAvatarIndex, makeURLSearchParams, parseResponse, version };

package/dist/index.js

@@ -127,7 +127,7 @@ var import_v102 = require("discord-api-types/v10");
 // src/lib/utils/constants.ts
 var import_util = require("@discordjs/util");
 var import_v10 = require("discord-api-types/v10");
-var DefaultUserAgent = `DiscordBot (https://discord.js.org, 2.6.2)`;
+var DefaultUserAgent = `DiscordBot (https://discord.js.org, 2.6.3)`;
 var DefaultUserAgentAppendix = (0, import_util.getUserAgentAppendix)();
 var DefaultRestOptions = {
   agent: null,
@@ -264,10 +264,29 @@ function serializeSearchParam(value) {
   }
 }
 __name(serializeSearchParam, "serializeSearchParam");
-function makeURLSearchParams(options) {
+function makeURLSearchParams(parameters, options = {}) {
   const params = new URLSearchParams();
-  if (!options) return params;
-  for (const [key, value] of Object.entries(options)) {
+  if (!parameters) return params;
+  const { arrayFormat = "repeat" } = options;
+  for (const [key, value] of Object.entries(parameters)) {
+    if (Array.isArray(value)) {
+      const commaSeparatedElements = arrayFormat === "comma" ? [] : null;
+      for (const element of value) {
+        const serialized2 = serializeSearchParam(element);
+        if (serialized2 === null) {
+          continue;
+        }
+        if (commaSeparatedElements) {
+          commaSeparatedElements.push(serialized2);
+        } else {
+          params.append(key, serialized2);
+        }
+      }
+      if (commaSeparatedElements?.length) {
+        params.append(key, commaSeparatedElements.join(","));
+      }
+      continue;
+    }
     const serialized = serializeSearchParam(value);
     if (serialized !== null) params.append(key, serialized);
   }
@@ -1499,7 +1518,7 @@ var REST = class _REST extends import_async_event_emitter.AsyncEventEmitter {
 };
 
 // src/shared.ts
-var version = "2.6.2";
+var version = "2.6.3";
 
 // src/index.ts
 globalThis.FormData ??= import_undici2.FormData;