@discordjs/rest 2.5.1 → 2.6.0

package/dist/index.d.mts

@@ -446,26 +446,40 @@ declare const BurstHandlerMajorIdKey = "burst";
 declare const DEPRECATION_WARNING_PREFIX: "DeprecationWarning";
 
 /**
- * The options used for image URLs
+ * The options used for image URLs.
  */
 interface BaseImageURLOptions {
     /**
-     * The extension to use for the image URL
+     * The extension to use for the image URL.
      *
      * @defaultValue `'webp'`
      */
     extension?: ImageExtension;
     /**
-     * The size specified in the image URL
+     * The size specified in the image URL.
      */
     size?: ImageSize;
 }
+interface EmojiURLOptionsWebp extends BaseImageURLOptions {
+    /**
+     * Whether to use the `animated` query parameter.
+     */
+    animated?: boolean;
+    extension?: 'webp';
+}
+interface EmojiURLOptionsNotWebp extends BaseImageURLOptions {
+    extension: Exclude<ImageExtension, 'webp'>;
+}
 /**
- * The options used for image URLs with animated content
+ * The options used for emoji URLs.
+ */
+type EmojiURLOptions = EmojiURLOptionsNotWebp | EmojiURLOptionsWebp;
+/**
+ * The options used for image URLs that may be animated.
  */
 interface ImageURLOptions extends BaseImageURLOptions {
     /**
-     * Whether or not to prefer the static version of an image asset.
+     * Whether to prefer the static asset.
      */
     forceStatic?: boolean;
 }
@@ -477,6 +491,10 @@ interface MakeURLOptions {
      * The allowed extensions that can be used
      */
     allowedExtensions?: readonly string[];
+    /**
+     * Whether to use the `animated` query parameter
+     */
+    animated?: boolean;
     /**
      * The base URL.
      *
@@ -579,7 +597,7 @@ declare class CDN {
      * @param emojiId - The emoji id
      * @param options - Optional options for the emoji
      */
-    emoji(emojiId: string, options?: Readonly<BaseImageURLOptions>): string;
+    emoji(emojiId: string, options?: Readonly<EmojiURLOptions>): string;
     /**
      * Generates an emoji's URL for an emoji.
      *
@@ -669,6 +687,14 @@ declare class CDN {
      * @param soundId - The soundboard sound id
      */
     soundboardSound(soundId: string): string;
+    /**
+     * Generates a URL for a guild tag badge.
+     *
+     * @param guildId - The guild id
+     * @param badgeHash - The hash of the badge
+     * @param options - Optional options for the badge
+     */
+    guildTagBadge(guildId: string, badgeHash: string, options?: Readonly<BaseImageURLOptions>): string;
     /**
      * Constructs the URL for the resource, checking whether or not `hash` starts with `a_` if `dynamic` is set to `true`.
      *
@@ -929,4 +955,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 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 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

@@ -446,26 +446,40 @@ declare const BurstHandlerMajorIdKey = "burst";
 declare const DEPRECATION_WARNING_PREFIX: "DeprecationWarning";
 
 /**
- * The options used for image URLs
+ * The options used for image URLs.
  */
 interface BaseImageURLOptions {
     /**
-     * The extension to use for the image URL
+     * The extension to use for the image URL.
      *
      * @defaultValue `'webp'`
      */
     extension?: ImageExtension;
     /**
-     * The size specified in the image URL
+     * The size specified in the image URL.
      */
     size?: ImageSize;
 }
+interface EmojiURLOptionsWebp extends BaseImageURLOptions {
+    /**
+     * Whether to use the `animated` query parameter.
+     */
+    animated?: boolean;
+    extension?: 'webp';
+}
+interface EmojiURLOptionsNotWebp extends BaseImageURLOptions {
+    extension: Exclude<ImageExtension, 'webp'>;
+}
 /**
- * The options used for image URLs with animated content
+ * The options used for emoji URLs.
+ */
+type EmojiURLOptions = EmojiURLOptionsNotWebp | EmojiURLOptionsWebp;
+/**
+ * The options used for image URLs that may be animated.
  */
 interface ImageURLOptions extends BaseImageURLOptions {
     /**
-     * Whether or not to prefer the static version of an image asset.
+     * Whether to prefer the static asset.
      */
     forceStatic?: boolean;
 }
@@ -477,6 +491,10 @@ interface MakeURLOptions {
      * The allowed extensions that can be used
      */
     allowedExtensions?: readonly string[];
+    /**
+     * Whether to use the `animated` query parameter
+     */
+    animated?: boolean;
     /**
      * The base URL.
      *
@@ -579,7 +597,7 @@ declare class CDN {
      * @param emojiId - The emoji id
      * @param options - Optional options for the emoji
      */
-    emoji(emojiId: string, options?: Readonly<BaseImageURLOptions>): string;
+    emoji(emojiId: string, options?: Readonly<EmojiURLOptions>): string;
     /**
      * Generates an emoji's URL for an emoji.
      *
@@ -669,6 +687,14 @@ declare class CDN {
      * @param soundId - The soundboard sound id
      */
     soundboardSound(soundId: string): string;
+    /**
+     * Generates a URL for a guild tag badge.
+     *
+     * @param guildId - The guild id
+     * @param badgeHash - The hash of the badge
+     * @param options - Optional options for the badge
+     */
+    guildTagBadge(guildId: string, badgeHash: string, options?: Readonly<BaseImageURLOptions>): string;
     /**
      * Constructs the URL for the resource, checking whether or not `hash` starts with `a_` if `dynamic` is set to `true`.
      *
@@ -929,4 +955,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 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 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.5.1)`;
+var DefaultUserAgent = `DiscordBot (https://discord.js.org, 2.6.0)`;
 var DefaultUserAgentAppendix = (0, import_util.getUserAgentAppendix)();
 var DefaultRestOptions = {
   agent: null,
@@ -543,6 +543,16 @@ var CDN = class {
   soundboardSound(soundId) {
     return `${this.cdn}${import_v102.CDNRoutes.soundboardSound(soundId)}`;
   }
+  /**
+   * Generates a URL for a guild tag badge.
+   *
+   * @param guildId - The guild id
+   * @param badgeHash - The hash of the badge
+   * @param options - Optional options for the badge
+   */
+  guildTagBadge(guildId, badgeHash, options) {
+    return this.makeURL(`/guild-tag-badges/${guildId}/${badgeHash}`, options);
+  }
   /**
    * Constructs the URL for the resource, checking whether or not `hash` starts with `a_` if `dynamic` is set to `true`.
    *
@@ -563,7 +573,8 @@ var CDN = class {
     allowedExtensions = ALLOWED_EXTENSIONS,
     base = this.cdn,
     extension = "webp",
-    size
+    size,
+    animated
   } = {}) {
     extension = String(extension).toLowerCase();
     if (!allowedExtensions.includes(extension)) {
@@ -575,6 +586,9 @@ Must be one of: ${allowedExtensions.join(", ")}`);
 Must be one of: ${ALLOWED_SIZES.join(", ")}`);
     }
     const url = new URL(`${base}${route}.${extension}`);
+    if (animated !== void 0) {
+      url.searchParams.set("animated", String(animated));
+    }
     if (size) {
       url.searchParams.set("size", String(size));
     }
@@ -1469,7 +1483,7 @@ var REST = class _REST extends import_async_event_emitter.AsyncEventEmitter {
 };
 
 // src/shared.ts
-var version = "2.5.1";
+var version = "2.6.0";
 
 // src/index.ts
 globalThis.FormData ??= import_undici2.FormData;