feat: use get sticker pack endpoint

discordjs · Aug 19, 2024 · 632ab4c · 632ab4c
1 parent 8fb4008
commit 632ab4c
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 5 deletions.
diff --git a/packages/core/src/api/sticker.ts b/packages/core/src/api/sticker.ts
@@ -3,6 +3,7 @@
 import type { RequestData, REST } from '@discordjs/rest';
 import {
 	Routes,
+	type RESTGetAPIStickerPack,
 	type RESTGetAPIStickerResult,
 	type RESTGetStickerPacksResult,
 	type Snowflake,
@@ -11,6 +12,17 @@ import {
 export class StickersAPI {
 	public constructor(private readonly rest: REST) {}
 
+	/**
+	 * Fetches a sticker pack
+	 *
+	 * @see {@link https://discord.com/developers/docs/resources/sticker#get-sticker-pack}
+	 * @param packId - The id of the sticker pack
+	 * @param options - The options for fetching the sticker pack
+	 */
+	public async getStickerPack(packId: Snowflake, { signal }: Pick<RequestData, 'signal'> = {}) {
+		return this.rest.get(Routes.stickerPack(packId), { signal }) as Promise<RESTGetAPIStickerPack>;
+	}
+
 	/**
 	 * Fetches all of the sticker packs
 	 *

diff --git a/packages/discord.js/src/client/Client.js b/packages/discord.js/src/client/Client.js
@@ -342,15 +342,32 @@ class Client extends BaseClient {
     return new Sticker(this, data);
   }
 
+  /**
+   * Options for fetching sticker packs.
+   * @typedef {Object} StickerPackFetchOptions
+   * @property {Snowflake} [packId] The id of the sticker pack to fetch
+   */
+
   /**
    * Obtains the list of available sticker packs.
-   * @returns {Promise<Collection<Snowflake, StickerPack>>}
+   * @param {StickerPackFetchOptions} [options={}] Options for fetching sticker packs
+   * @returns {Promise<Collection<Snowflake, StickerPack>|StickerPack>}
+   * A collection of sticker packs, or a single sticker pack if a packId was provided
    * @example
    * client.fetchStickerPacks()
    *   .then(packs => console.log(`Available sticker packs are: ${packs.map(pack => pack.name).join(', ')}`))
    *   .catch(console.error);
+   * @example
+   * client.fetchStickerPacks({ packId: '751604115435421716' })
+   *   .then(pack => console.log(`Sticker pack name: ${pack.name}`))
+   *   .catch(console.error);
    */
-  async fetchStickerPacks() {
+  async fetchStickerPacks({ packId } = {}) {
+    if (packId) {
+      const data = await this.rest.get(Routes.stickerPack(packId));
+      return new StickerPack(this, data);
+    }
+
     const data = await this.rest.get(Routes.stickerPacks());
     return new Collection(data.sticker_packs.map(stickerPack => [stickerPack.id, new StickerPack(this, stickerPack)]));
   }

diff --git a/packages/discord.js/src/structures/Sticker.js b/packages/discord.js/src/structures/Sticker.js
@@ -182,8 +182,9 @@ class Sticker extends Base {
    * Fetches the pack that contains this sticker.
    * @returns {Promise<?StickerPack>} The sticker pack or `null` if this sticker does not belong to one.
    */
-  async fetchPack() {
-    return (this.packId && (await this.client.fetchStickerPacks()).get(this.packId)) ?? null;
+  fetchPack() {
+    if (!this.packId) return null;
+    return this.client.fetchStickerPacks({ packId: this.packId });
   }
 
   /**

diff --git a/packages/discord.js/typings/index.d.ts b/packages/discord.js/typings/index.d.ts
@@ -1020,7 +1020,8 @@ export class Client<Ready extends boolean = boolean> extends BaseClient {
   public fetchGuildTemplate(template: GuildTemplateResolvable): Promise<GuildTemplate>;
   public fetchVoiceRegions(): Promise<Collection<string, VoiceRegion>>;
   public fetchSticker(id: Snowflake): Promise<Sticker>;
-  public fetchStickerPacks(): Promise<Collection<Snowflake, StickerPack>>;
+  public fetchStickerPacks(options: { packId: Snowflake }): Promise<StickerPack>;
+  public fetchStickerPacks(options?: StickerPackFetchOptions): Promise<Collection<Snowflake, StickerPack>>;
   /** @deprecated Use {@link Client.fetchStickerPacks} instead. */
   public fetchPremiumStickerPacks(): ReturnType<Client['fetchStickerPacks']>;
   public fetchWebhook(id: Snowflake, token?: string): Promise<Webhook>;
@@ -1055,6 +1056,10 @@ export class Client<Ready extends boolean = boolean> extends BaseClient {
   public removeAllListeners<Event extends string | symbol>(event?: Exclude<Event, keyof ClientEvents>): this;
 }
 
+export interface StickerPackFetchOptions {
+  packId?: Snowflake;
+}
+
 export class ClientApplication extends Application {
   private constructor(client: Client<true>, data: RawClientApplicationData);
   public botPublic: boolean | null;

diff --git a/packages/discord.js/typings/index.test-d.ts b/packages/discord.js/typings/index.test-d.ts
@@ -205,6 +205,7 @@ import {
   ChannelSelectMenuComponent,
   MentionableSelectMenuComponent,
   Poll,
+  StickerPack,
 } from '.';
 import { expectAssignable, expectDeprecated, expectNotAssignable, expectNotType, expectType } from 'tsd';
 import type { ContextMenuCommandBuilder, SlashCommandBuilder } from '@discordjs/builders';
@@ -2561,3 +2562,7 @@ declare const poll: Poll;
     answerId: 1,
   });
 }
+
+expectType<Collection<Snowflake, StickerPack>>(await client.fetchStickerPacks());
+expectType<Collection<Snowflake, StickerPack>>(await client.fetchStickerPacks({}));
+expectType<StickerPack>(await client.fetchStickerPacks({ packId: snowflake }));