refactor: change the rest

Author: Jiralite

packages/rest/__tests__/CDN.test.ts

@@ -23,7 +23,7 @@ test('avatar default', () => {
 });
 
 test('avatar dynamic-animated', () => {
-	expect(cdn.avatar(id, animatedHash)).toEqual(`${baseCDN}/avatars/${id}/${animatedHash}.gif`);
+	expect(cdn.avatar(id, animatedHash)).toEqual(`${baseCDN}/avatars/${id}/${animatedHash}.webp?animated=true`);
 });
 
 test('avatar dynamic-not-animated', () => {
@@ -68,7 +68,7 @@ test('guildMemberAvatar default', () => {
 
 test('guildMemberAvatar dynamic-animated', () => {
 	expect(cdn.guildMemberAvatar(id, id, animatedHash)).toEqual(
-		`${baseCDN}/guilds/${id}/users/${id}/avatars/${animatedHash}.gif`,
+		`${baseCDN}/guilds/${id}/users/${id}/avatars/${animatedHash}.webp?animated=true`,
 	);
 });
 
@@ -82,7 +82,7 @@ test('guildMemberBanner default', () => {
 
 test('guildMemberBanner dynamic-animated', () => {
 	expect(cdn.guildMemberBanner(id, id, animatedHash)).toEqual(
-		`${baseCDN}/guilds/${id}/users/${id}/banners/${animatedHash}.gif`,
+		`${baseCDN}/guilds/${id}/users/${id}/banners/${animatedHash}.webp?animated=true`,
 	);
 });
 
@@ -99,7 +99,7 @@ test('icon default', () => {
 });
 
 test('icon dynamic-animated', () => {
-	expect(cdn.icon(id, animatedHash)).toEqual(`${baseCDN}/icons/${id}/${animatedHash}.gif`);
+	expect(cdn.icon(id, animatedHash)).toEqual(`${baseCDN}/icons/${id}/${animatedHash}.webp?animated=true`);
 });
 
 test('icon dynamic-not-animated', () => {
@@ -145,5 +145,7 @@ test('makeURL throws on invalid extension', () => {
 });
 
 test('makeURL valid size', () => {
-	expect(cdn.avatar(id, animatedHash, { size: 512 })).toEqual(`${baseCDN}/avatars/${id}/${animatedHash}.gif?size=512`);
+	expect(cdn.avatar(id, animatedHash, { size: 512 })).toEqual(
+		`${baseCDN}/avatars/${id}/${animatedHash}.webp?animated=true&size=512`,
+	);
 });

packages/rest/src/lib/CDN.ts

@@ -11,54 +11,62 @@ import {
 } from './utils/constants.js';
 
 /**
- * The options used for image URLs
+ * The options used for image URLs.
  */
 export 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 {
+export interface EmojiURLOptionsWebp extends BaseImageURLOptions {
 	/**
 	 * Whether to use the `animated` query parameter.
-	 *
-	 * @remarks An animated custom emoji with the WebP format utilises this query paramter to be animated.
 	 */
 	animated?: boolean;
 	extension?: 'webp';
 }
 
-interface EmojiURLOptionsNotWebP extends BaseImageURLOptions {
+export interface EmojiURLOptionsNotWebp extends BaseImageURLOptions {
 	extension: Exclude<ImageExtension, 'webp'>;
 }
 
 /**
  * The options used for emoji URLs.
  */
-export type EmojiURLOptions = EmojiURLOptionsNotWebP | EmojiURLOptionsWebp;
+export type EmojiURLOptions = EmojiURLOptionsNotWebp | EmojiURLOptionsWebp;
 
-/**
- * The options used for image URLs with animated content
- */
-export interface ImageURLOptions extends BaseImageURLOptions {
+export interface BaseAnimatedImageURLOptions extends BaseImageURLOptions {
 	/**
-	 * Whether or not to prefer the static version of an image asset.
+	 * Whether to prefer the static asset.
 	 */
 	forceStatic?: boolean;
 }
 
+export interface ImageURLOptionsWebp extends BaseAnimatedImageURLOptions {
+	extension?: 'webp';
+}
+
+export interface ImageURLOptionsNotWebp extends BaseAnimatedImageURLOptions {
+	extension: Exclude<ImageExtension, 'webp'>;
+}
+
+/**
+ * The options used for image URLs that may be animated.
+ */
+export type ImageURLOptions = ImageURLOptionsNotWebp | ImageURLOptionsWebp;
+
 /**
  * The options to use when making a CDN URL
  */
-export interface MakeURLOptions {
+interface MakeURLOptions {
 	/**
 	 * The allowed extensions that can be used
 	 */
@@ -332,7 +340,7 @@ export class CDN {
 		hash: string,
 		{ forceStatic = false, ...options }: Readonly<ImageURLOptions> = {},
 	): string {
-		return this.makeURL(route, !forceStatic && hash.startsWith('a_') ? { ...options, extension: 'gif' } : options);
+		return this.makeURL(route, !forceStatic && hash.startsWith('a_') ? { ...options, animated: true } : options);
 	}
 
 	/**
@@ -364,14 +372,14 @@ export class CDN {
 
 		const url = new URL(`${base}${route}.${extension}`);
 
-		if (size) {
-			url.searchParams.set('size', String(size));
-		}
-
 		if (animated !== undefined) {
 			url.searchParams.set('animated', String(animated));
 		}
 
+		if (size) {
+			url.searchParams.set('size', String(size));
+		}
+
 		return url.toString();
 	}
 }