From 1b1ae2f0cb339170e4c0692eb43fbc966fd64030 Mon Sep 17 00:00:00 2001 From: Almeida Date: Tue, 20 Aug 2024 11:13:26 +0100 Subject: [PATCH] feat: use get sticker pack endpoint (#10445) * feat: use get sticker pack endpoint * fix: mark fetchPack as async * style: resolve eslint warning --------- Co-authored-by: Vlad Frangu Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com> --- packages/core/src/api/sticker.ts | 12 +++++++++++ packages/discord.js/src/client/Client.js | 21 +++++++++++++++++-- packages/discord.js/src/structures/Sticker.js | 5 +++-- packages/discord.js/typings/index.d.ts | 7 ++++++- packages/discord.js/typings/index.test-d.ts | 5 +++++ 5 files changed, 45 insertions(+), 5 deletions(-) diff --git a/packages/core/src/api/sticker.ts b/packages/core/src/api/sticker.ts index 6734f23f4834..1d5dcf1e0202 100644 --- 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 = {}) { + return this.rest.get(Routes.stickerPack(packId), { signal }) as Promise; + } + /** * Fetches all of the sticker packs * diff --git a/packages/discord.js/src/client/Client.js b/packages/discord.js/src/client/Client.js index bbf1af478fc9..1d378a4dcd3d 100644 --- 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>} + * @param {StickerPackFetchOptions} [options={}] Options for fetching sticker packs + * @returns {Promise|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 index 07f859969453..58f22b72741b 100644 --- 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} 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 Promise.resolve(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 index df77541a43a1..a7b00f808e01 100644 --- a/packages/discord.js/typings/index.d.ts +++ b/packages/discord.js/typings/index.d.ts @@ -1019,7 +1019,8 @@ export class Client extends BaseClient { public fetchGuildTemplate(template: GuildTemplateResolvable): Promise; public fetchVoiceRegions(): Promise>; public fetchSticker(id: Snowflake): Promise; - public fetchStickerPacks(): Promise>; + public fetchStickerPacks(options: { packId: Snowflake }): Promise; + public fetchStickerPacks(options?: StickerPackFetchOptions): Promise>; /** @deprecated Use {@link Client.fetchStickerPacks} instead. */ public fetchPremiumStickerPacks(): ReturnType; public fetchWebhook(id: Snowflake, token?: string): Promise; @@ -1054,6 +1055,10 @@ export class Client extends BaseClient { public removeAllListeners(event?: Exclude): this; } +export interface StickerPackFetchOptions { + packId?: Snowflake; +} + export class ClientApplication extends Application { private constructor(client: Client, 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 index 2665cf028457..78093fc55654 100644 --- a/packages/discord.js/typings/index.test-d.ts +++ b/packages/discord.js/typings/index.test-d.ts @@ -208,6 +208,7 @@ import { Poll, ApplicationEmoji, ApplicationEmojiManager, + StickerPack, } from '.'; import { expectAssignable, expectDeprecated, expectNotAssignable, expectNotType, expectType } from 'tsd'; import type { ContextMenuCommandBuilder, SlashCommandBuilder } from '@discordjs/builders'; @@ -2587,3 +2588,7 @@ declare const poll: Poll; answerId: 1, }); } + +expectType>(await client.fetchStickerPacks()); +expectType>(await client.fetchStickerPacks({})); +expectType(await client.fetchStickerPacks({ packId: snowflake }));