types: Export some core-specific types (#10620)

types: export core-specific types

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

packages/core/src/api/channel.ts

@@ -41,6 +41,14 @@ export interface StartForumThreadOptions extends RESTPostAPIGuildForumThreadsJSO
 	message: RESTPostAPIGuildForumThreadsJSONBody['message'] & { files?: RawFile[] };
 }
 
+export interface CreateMessageOptions extends RESTPostAPIChannelMessageJSONBody {
+	files?: RawFile[];
+}
+
+export interface EditMessageOptions extends RESTPatchAPIChannelMessageJSONBody {
+	files?: RawFile[];
+}
+
 export class ChannelsAPI {
 	public constructor(private readonly rest: REST) {}
 
@@ -54,7 +62,7 @@ export class ChannelsAPI {
 	 */
 	public async createMessage(
 		channelId: Snowflake,
-		{ files, ...body }: RESTPostAPIChannelMessageJSONBody & { files?: RawFile[] },
+		{ files, ...body }: CreateMessageOptions,
 		{ signal }: Pick<RequestData, 'signal'> = {},
 	) {
 		return this.rest.post(Routes.channelMessages(channelId), {
@@ -76,7 +84,7 @@ export class ChannelsAPI {
 	public async editMessage(
 		channelId: Snowflake,
 		messageId: Snowflake,
-		{ files, ...body }: RESTPatchAPIChannelMessageJSONBody & { files?: RawFile[] },
+		{ files, ...body }: EditMessageOptions,
 		{ signal }: Pick<RequestData, 'signal'> = {},
 	) {
 		return this.rest.patch(Routes.channelMessage(channelId, messageId), {

packages/core/src/api/guild.ts

@@ -1,6 +1,6 @@
 /* eslint-disable jsdoc/check-param-names */
 
-import { makeURLSearchParams, type REST, type RawFile, type RequestData } from '@discordjs/rest';
+import { makeURLSearchParams, type RawFile, type REST, type RequestData } from '@discordjs/rest';
 import {
 	Routes,
 	type GuildMFALevel,
@@ -110,6 +110,10 @@ import {
 } from 'discord-api-types/v10';
 import { VoiceAPI } from './voice';
 
+export interface CreateStickerOptions extends Omit<RESTPostAPIGuildStickerFormDataBody, 'file'> {
+	file: RawFile;
+}
+
 export class GuildsAPI {
 	public constructor(private readonly rest: REST) {}
 
@@ -1013,7 +1017,7 @@ export class GuildsAPI {
 	 */
 	public async createSticker(
 		guildId: Snowflake,
-		{ file, ...body }: Omit<RESTPostAPIGuildStickerFormDataBody, 'file'> & { file: RawFile },
+		{ file, ...body }: CreateStickerOptions,
 		{ reason, signal }: Pick<RequestData, 'reason' | 'signal'> = {},
 	) {
 		const fileData = { ...file, key: 'file' };

packages/core/src/api/interactions.ts

@@ -16,6 +16,26 @@ import {
 } from 'discord-api-types/v10';
 import type { WebhooksAPI } from './webhook.js';
 
+export interface CreateInteractionResponseOptions
+	extends APIInteractionResponseCallbackData,
+		RESTPostAPIInteractionCallbackQuery {
+	files?: RawFile[];
+}
+
+export type CreateInteractionDeferResponseOptions = APIInteractionResponseDeferredChannelMessageWithSource['data'] &
+	RESTPostAPIInteractionCallbackQuery;
+
+export type CreateInteractionFollowUpResponseOptions = APIInteractionResponseCallbackData & { files?: RawFile[] };
+export type EditInteractionResponseOptions = APIInteractionResponseCallbackData & { files?: RawFile[] };
+
+export type CreateInteractionUpdateMessageResponseOptions = APIInteractionResponseCallbackData &
+	RESTPostAPIInteractionCallbackQuery & { files?: RawFile[] };
+
+export type CreateAutocompleteResponseOptions = APICommandAutocompleteInteractionResponseCallbackData &
+	RESTPostAPIInteractionCallbackQuery;
+
+export type CreateModalResponseOptions = APIModalInteractionResponseCallbackData & RESTPostAPIInteractionCallbackQuery;
+
 export class InteractionsAPI {
 	public constructor(
 		private readonly rest: REST,
@@ -34,8 +54,7 @@ export class InteractionsAPI {
 	public async reply(
 		interactionId: Snowflake,
 		interactionToken: string,
-		body: APIInteractionResponseCallbackData &
+		body: CreateInteractionResponseOptions & { with_response: true },
-			RESTPostAPIInteractionCallbackQuery & { files?: RawFile[]; with_response: true },
 		options?: Pick<RequestData, 'signal'>,
 	): Promise<RESTPostAPIInteractionCallbackWithResponseResult>;
 
@@ -51,19 +70,14 @@ export class InteractionsAPI {
 	public async reply(
 		interactionId: Snowflake,
 		interactionToken: string,
-		body: APIInteractionResponseCallbackData &
+		body: CreateInteractionResponseOptions & { with_response?: false },
-			RESTPostAPIInteractionCallbackQuery & { files?: RawFile[]; with_response?: false },
 		options?: Pick<RequestData, 'signal'>,
 	): Promise<undefined>;
 
 	public async reply(
 		interactionId: Snowflake,
 		interactionToken: string,
-		{
+		{ files, with_response, ...data }: CreateInteractionResponseOptions,
-			files,
-			with_response,
-			...data
-		}: APIInteractionResponseCallbackData & RESTPostAPIInteractionCallbackQuery & { files?: RawFile[] },
 		{ signal }: Pick<RequestData, 'signal'> = {},
 	) {
 		const response = await this.rest.post(Routes.interactionCallback(interactionId, interactionToken), {
@@ -92,8 +106,7 @@ export class InteractionsAPI {
 	public async defer(
 		interactionId: Snowflake,
 		interactionToken: string,
-		body: APIInteractionResponseDeferredChannelMessageWithSource['data'] &
+		body: CreateInteractionDeferResponseOptions & { with_response: true },
-			RESTPostAPIInteractionCallbackQuery & { with_response: true },
 		options?: Pick<RequestData, 'signal'>,
 	): Promise<RESTPostAPIInteractionCallbackWithResponseResult>;
 
@@ -109,18 +122,14 @@ export class InteractionsAPI {
 	public async defer(
 		interactionId: Snowflake,
 		interactionToken: string,
-		body?: APIInteractionResponseDeferredChannelMessageWithSource['data'] &
+		body?: CreateInteractionDeferResponseOptions & { with_response?: false },
-			RESTPostAPIInteractionCallbackQuery & { with_response?: false },
 		options?: Pick<RequestData, 'signal'>,
 	): Promise<undefined>;
 
 	public async defer(
 		interactionId: Snowflake,
 		interactionToken: string,
-		{
+		{ with_response, ...data }: CreateInteractionDeferResponseOptions = {},
-			with_response,
-			...data
-		}: APIInteractionResponseDeferredChannelMessageWithSource['data'] & RESTPostAPIInteractionCallbackQuery = {},
 		{ signal }: Pick<RequestData, 'signal'> = {},
 	) {
 		const response = await this.rest.post(Routes.interactionCallback(interactionId, interactionToken), {
@@ -198,7 +207,7 @@ export class InteractionsAPI {
 	public async followUp(
 		applicationId: Snowflake,
 		interactionToken: string,
-		body: APIInteractionResponseCallbackData & { files?: RawFile[] },
+		body: CreateInteractionFollowUpResponseOptions,
 		{ signal }: Pick<RequestData, 'signal'> = {},
 	) {
 		return this.webhooks.execute(applicationId, interactionToken, { ...body, wait: true }, { signal });
@@ -218,7 +227,7 @@ export class InteractionsAPI {
 	public async editReply(
 		applicationId: Snowflake,
 		interactionToken: string,
-		callbackData: APIInteractionResponseCallbackData & { files?: RawFile[] },
+		callbackData: EditInteractionResponseOptions,
 		messageId?: Snowflake | '@original',
 		{ signal }: Pick<RequestData, 'signal'> = {},
 	) {
@@ -280,8 +289,7 @@ export class InteractionsAPI {
 	public async updateMessage(
 		interactionId: Snowflake,
 		interactionToken: string,
-		callbackData: APIInteractionResponseCallbackData &
+		callbackData: CreateInteractionUpdateMessageResponseOptions & { with_response: true },
-			RESTPostAPIInteractionCallbackQuery & { files?: RawFile[]; with_response: true },
 		options: Pick<RequestData, 'signal'>,
 	): Promise<RESTPostAPIInteractionCallbackWithResponseResult>;
 
@@ -297,19 +305,14 @@ export class InteractionsAPI {
 	public async updateMessage(
 		interactionId: Snowflake,
 		interactionToken: string,
-		callbackData: APIInteractionResponseCallbackData &
+		callbackData: CreateInteractionUpdateMessageResponseOptions & { with_response?: false },
-			RESTPostAPIInteractionCallbackQuery & { files?: RawFile[]; with_response?: false },
 		options: Pick<RequestData, 'signal'>,
 	): Promise<undefined>;
 
 	public async updateMessage(
 		interactionId: Snowflake,
 		interactionToken: string,
-		{
+		{ files, with_response, ...data }: CreateInteractionUpdateMessageResponseOptions,
-			files,
-			with_response,
-			...data
-		}: APIInteractionResponseCallbackData & RESTPostAPIInteractionCallbackQuery & { files?: RawFile[] },
 		{ signal }: Pick<RequestData, 'signal'> = {},
 	) {
 		const response = await this.rest.post(Routes.interactionCallback(interactionId, interactionToken), {
@@ -337,8 +340,7 @@ export class InteractionsAPI {
 	public async createAutocompleteResponse(
 		interactionId: Snowflake,
 		interactionToken: string,
-		callbackData: APICommandAutocompleteInteractionResponseCallbackData &
+		callbackData: CreateAutocompleteResponseOptions & { with_response: true },
-			RESTPostAPIInteractionCallbackQuery & { with_response: true },
 		options?: Pick<RequestData, 'signal'>,
 	): Promise<APICommandAutocompleteInteractionResponseCallbackData>;
 
@@ -354,18 +356,14 @@ export class InteractionsAPI {
 	public async createAutocompleteResponse(
 		interactionId: Snowflake,
 		interactionToken: string,
-		callbackData: APICommandAutocompleteInteractionResponseCallbackData &
+		callbackData: CreateAutocompleteResponseOptions & { with_response?: false },
-			RESTPostAPIInteractionCallbackQuery & { with_response?: false },
 		options: Pick<RequestData, 'signal'>,
 	): Promise<undefined>;
 
 	public async createAutocompleteResponse(
 		interactionId: Snowflake,
 		interactionToken: string,
-		{
+		{ with_response, ...data }: CreateAutocompleteResponseOptions,
-			with_response,
-			...data
-		}: APICommandAutocompleteInteractionResponseCallbackData & RESTPostAPIInteractionCallbackQuery,
 		{ signal }: Pick<RequestData, 'signal'> = {},
 	) {
 		const response = await this.rest.post(Routes.interactionCallback(interactionId, interactionToken), {
@@ -392,8 +390,7 @@ export class InteractionsAPI {
 	public async createModal(
 		interactionId: Snowflake,
 		interactionToken: string,
-		callbackData: APIModalInteractionResponseCallbackData &
+		callbackData: CreateModalResponseOptions & { with_response: true },
-			RESTPostAPIInteractionCallbackQuery & { with_response: true },
 		options?: Pick<RequestData, 'signal'>,
 	): Promise<RESTPostAPIInteractionCallbackWithResponseResult>;
 
@@ -409,15 +406,14 @@ export class InteractionsAPI {
 	public async createModal(
 		interactionId: Snowflake,
 		interactionToken: string,
-		callbackData: APIModalInteractionResponseCallbackData &
+		callbackData: CreateModalResponseOptions & { with_response?: false },
-			RESTPostAPIInteractionCallbackQuery & { with_response?: false },
 		options?: Pick<RequestData, 'signal'>,
 	): Promise<undefined>;
 
 	public async createModal(
 		interactionId: Snowflake,
 		interactionToken: string,
-		{ with_response, ...data }: APIModalInteractionResponseCallbackData & RESTPostAPIInteractionCallbackQuery,
+		{ with_response, ...data }: CreateModalResponseOptions,
 		{ signal }: Pick<RequestData, 'signal'> = {},
 	) {
 		const response = await this.rest.post(Routes.interactionCallback(interactionId, interactionToken), {

packages/core/src/api/webhook.ts

@@ -18,6 +18,14 @@ import {
 	type Snowflake,
 } from 'discord-api-types/v10';
 
+export type CreateWebhookMessageOptions = RESTPostAPIWebhookWithTokenJSONBody &
+	RESTPostAPIWebhookWithTokenQuery & { files?: RawFile[] };
+
+export type EditWebhookMessageOptions = RESTPatchAPIWebhookWithTokenMessageJSONBody & {
+	files?: RawFile[];
+	thread_id?: string;
+};
+
 export class WebhooksAPI {
 	public constructor(private readonly rest: REST) {}
 
@@ -92,7 +100,7 @@ export class WebhooksAPI {
 	public async execute(
 		id: Snowflake,
 		token: string,
-		body: RESTPostAPIWebhookWithTokenJSONBody & RESTPostAPIWebhookWithTokenQuery & { files?: RawFile[]; wait: true },
+		body: CreateWebhookMessageOptions & { wait: true },
 		options?: Pick<RequestData, 'signal'>,
 	): Promise<RESTPostAPIWebhookWithTokenWaitResult>;
 
@@ -108,7 +116,7 @@ export class WebhooksAPI {
 	public async execute(
 		id: Snowflake,
 		token: string,
-		body: RESTPostAPIWebhookWithTokenJSONBody & RESTPostAPIWebhookWithTokenQuery & { files?: RawFile[]; wait?: false },
+		body: CreateWebhookMessageOptions & { wait?: false },
 		options?: Pick<RequestData, 'signal'>,
 	): Promise<void>;
 
@@ -124,12 +132,7 @@ export class WebhooksAPI {
 	public async execute(
 		id: Snowflake,
 		token: string,
-		{
+		{ wait, thread_id, files, ...body }: CreateWebhookMessageOptions,
-			wait,
-			thread_id,
-			files,
-			...body
-		}: RESTPostAPIWebhookWithTokenJSONBody & RESTPostAPIWebhookWithTokenQuery & { files?: RawFile[] },
 		{ signal }: Pick<RequestData, 'signal'> = {},
 	) {
 		return this.rest.post(Routes.webhook(id, token), {
@@ -230,11 +233,7 @@ export class WebhooksAPI {
 		id: Snowflake,
 		token: string,
 		messageId: Snowflake,
-		{
+		{ thread_id, files, ...body }: EditWebhookMessageOptions,
-			thread_id,
-			files,
-			...body
-		}: RESTPatchAPIWebhookWithTokenMessageJSONBody & { files?: RawFile[]; thread_id?: string },
 		{ signal }: Pick<RequestData, 'signal'> = {},
 	) {
 		return this.rest.patch(Routes.webhookMessage(id, token, messageId), {