all repos — kitten @ 6742b6ccdb8cfbedfbee82d9baa7c6da27190208

pkgs/router/src/kitten.ts (view raw)

 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
import { EventEmitter } from "node:events";
import {
	type Client,
	type ChatInputCommandInteraction,
	type AutocompleteInteraction,
	type ButtonInteraction,
	type AnySelectMenuInteraction,
	type ModalSubmitInteraction,
	type APIApplicationCommandOption,
	type APIApplicationCommandBasicOption,
	type UserContextMenuCommandInteraction,
	type MessageContextMenuCommandInteraction,
	BaseInteraction,
	type RESTPostAPIApplicationCommandsJSONBody,
	ApplicationCommandType,
	PermissionsBitField,
} from "discord.js";

import { HaltExecution } from "./errors";
import { type Option, type CommandOption, OPTION_TYPES } from "./options";
import {
	KittenComponent,
	type KittenComponentConfig,
	type KittenComponentInteraction,
} from "./components";
import {
	Command,
	CommandBuilder,
	Subcommand,
	SubcommandGroupBuilder,
	ContextMenuCommand,
	type BaseCommandConfig,
	type LocalizedDescription,
	type ChatCommandConfig,
	type ContextMenuConfig,
	type CommandResultType,
	type Middleware,
	type ErrorHandler,
	type Afterware,
} from "./commands";

export interface KittenOptions {
	/** a global fallback error handler. */
	onError?: ErrorHandler<BaseInteraction, any>;
}

export interface KittenEvents {
	/** diagnostics and routing traces. */
	debug: [message: string, data?: Record<string, any>];
	/** command registration and API sync notices. */
	info: [message: string, data?: Record<string, any>];
	/** non-fatal runtime warning telemetry. */
	warn: [message: string, data?: Record<string, any>];
	/** fallback system telemetry for unhandled execution failures. */
	error: [message: string, data?: Record<string, any>];
}

/**
 * the main entry point for routing your bot.
 *
 * @see {@link KittenEvents} for telemetry events you can subscribe to.
 */
export class Kitten extends EventEmitter<KittenEvents> {
	private commands = new Map<string, Command<any, any> | SubcommandGroupBuilder<any, any>>();
	private userContextMenus = new Map<string, ContextMenuCommand<any, any, any>>();
	private messageContextMenus = new Map<string, ContextMenuCommand<any, any, any>>();
	private components = new Map<string, KittenComponent<any, any, any, any>>();
	private globalOnError?: ErrorHandler<BaseInteraction, any>;

	constructor(
		private client: Client,
		options: KittenOptions = {},
	) {
		super();
		this.client.on("interactionCreate", this.handleInteraction.bind(this));
		this.globalOnError = options.onError;

		process.nextTick(() => {
			this.emit("debug", "kitten instance initialized.");
		});
	}

	/**
	 * instantiate a fresh `CommandBuilder` to start chaining middleware and afterware.
	 */
	builder() {
		return new CommandBuilder();
	}

	/**
	 * register a global error handler. this acts as the final safety net if an exception
	 * bubbles all the way up through your local and builder scopes.
	 */
	onError(handler: ErrorHandler<BaseInteraction, any>) {
		this.globalOnError = handler;
		return this;
	}

	/**
	 * define a chat input command attached directly to the global instance.
	 */
	command<O extends Record<string, CommandOption<any, any>>>(
		name: string,
		config: ChatCommandConfig<O, {}, unknown>,
	): Command<{}>;

	/**
	 * define a subcommand group attached directly to the global instance.
	 */
	command(
		name: string,
		config: BaseCommandConfig<ChatInputCommandInteraction, {}> & LocalizedDescription,
	): SubcommandGroupBuilder<{}>;

	command(name: string, config: any): any {
		return this.builder().command(name, config);
	}

	/**
	 * define a user context menu attached directly to the global instance.
	 */
	userContextMenu(
		name: string,
		runOrConfig:
			| ((interaction: UserContextMenuCommandInteraction) => CommandResultType)
			| ContextMenuConfig<UserContextMenuCommandInteraction, {}, unknown>,
	): ContextMenuCommand<{}, UserContextMenuCommandInteraction> {
		return this.builder().userContextMenu(name, runOrConfig as any);
	}

	/**
	 * define a message context menu attached directly to the global instance.
	 */
	messageContextMenu(
		name: string,
		runOrConfig:
			| ((interaction: MessageContextMenuCommandInteraction) => CommandResultType)
			| ContextMenuConfig<MessageContextMenuCommandInteraction, {}, unknown>,
	): ContextMenuCommand<{}, MessageContextMenuCommandInteraction> {
		return this.builder().messageContextMenu(name, runOrConfig as any);
	}

	/**
	 * define a button component attached directly to the global instance.
	 */
	button<O extends Record<string, Option<any, any>>>(
		name: string,
		config: KittenComponentConfig<ButtonInteraction, O, {}, unknown>,
	): KittenComponent<ButtonInteraction, O, {}> {
		return this.builder().button(name, config);
	}

	/**
	 * define a select menu component attached directly to the global instance.
	 */
	selectMenu<O extends Record<string, Option<any, any>>>(
		name: string,
		config: KittenComponentConfig<AnySelectMenuInteraction, O, {}, unknown>,
	): KittenComponent<AnySelectMenuInteraction, O, {}> {
		return this.builder().selectMenu(name, config);
	}

	/**
	 * define a modal component attached directly to the global instance.
	 */
	modal<O extends Record<string, Option<any, any>>>(
		name: string,
		config: KittenComponentConfig<ModalSubmitInteraction, O, {}, unknown>,
	): KittenComponent<ModalSubmitInteraction, O, {}> {
		return this.builder().modal(name, config);
	}

	/**
	 * tell kitten about your commands and components so it can route them.
	 * ensure you do this *before* calling `kitten.sync()`.
	 */
	register(registry: {
		commands?: (
			| Command<any, any>
			| SubcommandGroupBuilder<any, any>
			| ContextMenuCommand<any, any, any>
		)[];
		components?: KittenComponent<any, any, any, any>[];
	}) {
		registry.commands?.forEach((cmd) => {
			if (cmd instanceof ContextMenuCommand) {
				const targetMap = cmd.type === "user" ? this.userContextMenus : this.messageContextMenus;
				targetMap.set(cmd.name, cmd);
				this.emit("debug", `registered ${cmd.type} context menu: "${cmd.name}"`);
			} else {
				this.commands.set(cmd.name, cmd);
				const subInfo = cmd instanceof SubcommandGroupBuilder ? " (subcommand group)" : "";
				this.emit("debug", `registered command: "${cmd.name}"${subInfo}`);
			}
		});

		registry.components?.forEach((comp) => {
			this.components.set(comp.name, comp);

			const keys = Object.keys(comp.config.options || {});
			const staticOverhead = comp.name.length + keys.length;
			const dynamicBudget = 100 - staticOverhead;

			if (dynamicBudget < 25) {
				this.emit(
					"warn",
					[
						`component "${comp.name}" has a high static ID overhead (${staticOverhead} chars).`,
						`This leaves only ${dynamicBudget} characters for actual runtime values before`,
						`hitting Discord's 100-character limit.`,
					].join(" "),
				);
			} else {
				this.emit("debug", `registered component prefix: "${comp.name}"`);
			}
		});
	}

	private async handleInteraction(interaction: BaseInteraction) {
		this.emit("debug", `received interaction ID: ${interaction.id}, Type: ${interaction.type}`);

		if (interaction.isChatInputCommand()) return this.routeCommand(interaction);
		if (interaction.isAutocomplete()) return this.routeAutocomplete(interaction);
		if (interaction.isUserContextMenuCommand()) return this.routeContextMenu(interaction, "user");
		if (interaction.isMessageContextMenuCommand())
			return this.routeContextMenu(interaction, "message");
		if (interaction.isButton() || interaction.isAnySelectMenu() || interaction.isModalSubmit()) {
			return this.routeComponent(interaction);
		}

		this.emit("debug", `interaction ID: ${interaction.id} could not be classified or handled.`);
	}

	private async routeCommand(interaction: ChatInputCommandInteraction) {
		const entry = this.commands.get(interaction.commandName);
		if (!entry) {
			this.emit(
				"debug",
				`command routing aborted: "${interaction.commandName}" is not registered.`,
			);
			return;
		}

		if (entry instanceof SubcommandGroupBuilder) {
			const groupName = interaction.options.getSubcommandGroup(false);
			const subName = interaction.options.getSubcommand(false);

			this.emit(
				"debug",
				`routing group-based command: "${interaction.commandName}", group: ${groupName ?? "none"}, subcommand: ${subName ?? "none"}`,
			);

			let subcommand: Subcommand | undefined;

			if (groupName) {
				const group = entry.groups[groupName];
				if (!group) return this.emit("debug", `subcommand group "${groupName}" not found.`);
				subcommand = group.subcommands[subName ?? ""];
				if (!subcommand)
					return this.emit("debug", `subcommand "${subName}" not found in group "${groupName}".`);
			} else if (subName) {
				subcommand = entry.subcommands[subName];
				if (!subcommand) return this.emit("debug", `subcommand "${subName}" not found.`);
			}

			if (subcommand) {
				await this.executeWithMiddlewares(
					interaction,
					entry.middlewares,
					subcommand.config.run,
					subcommand.config.options,
					undefined,
					{
						localOnError: subcommand.config.onError,
						builderErrorHandlers: entry.errorHandlers,
						afterwares: entry.afterwares,
					},
				);
			}
		} else {
			this.emit("debug", `routing top-level chat command: "${interaction.commandName}"`);
			await this.executeWithMiddlewares(
				interaction,
				entry.middlewares,
				entry.config.run,
				entry.config.options,
				undefined,
				{
					localOnError: entry.config.onError,
					builderErrorHandlers: entry.errorHandlers,
					afterwares: entry.afterwares,
				},
			);
		}
	}

	private async routeContextMenu(
		interaction: UserContextMenuCommandInteraction | MessageContextMenuCommandInteraction,
		type: "user" | "message",
	) {
		const entry =
			type === "user"
				? this.userContextMenus.get(interaction.commandName)
				: this.messageContextMenus.get(interaction.commandName);

		if (!entry) {
			this.emit(
				"debug",
				`context menu routing aborted: "${interaction.commandName}" (${type}) is not registered.`,
			);
			return;
		}

		this.emit("debug", `routing context menu command: "${interaction.commandName}" (${type})`);
		await this.executeWithMiddlewares(
			interaction,
			entry.middlewares,
			entry.run,
			undefined,
			undefined,
			{
				localOnError: entry.config?.onError,
				builderErrorHandlers: entry.errorHandlers,
				afterwares: entry.afterwares,
			},
		);
	}

	private async executeWithMiddlewares(
		interaction: BaseInteraction,
		middlewares: Middleware<any, any, any>[],
		run: Function,
		optionsSchema?: Record<string, Option<any, any>>,
		componentArgs?: Record<string, any>,
		extra?: {
			localOnError?: ErrorHandler<any, any>;
			builderErrorHandlers?: ErrorHandler<any, any>[];
			afterwares?: Afterware<any, any, any>[];
		},
	) {
		let context: Record<string, any> = {};
		let executionResult: unknown = undefined;
		let executionError: unknown = null;
		let didStartExecution = false;

		try {
			this.emit(
				"debug",
				`Running ${middlewares.length} middleware(s) for interaction ${interaction.id}`,
			);

			didStartExecution = true;

			for (let i = 0; i < middlewares.length; i++) {
				const mw = middlewares[i];
				if (!mw) continue;
				this.emit("debug", `executing middleware [${i + 1}/${middlewares.length}]`);
				const result = await mw(interaction, context);
				if (result) context = { ...context, ...result };
			}

			if (interaction.isChatInputCommand()) {
				const args = this.parseSlashOptions(interaction, optionsSchema);
				this.emit("debug", `executing command handler for "${interaction.commandName}"`, { args });
				executionResult = await run(interaction, args, context);
			} else if (
				interaction.isButton() ||
				interaction.isAnySelectMenu() ||
				interaction.isModalSubmit()
			) {
				const customId = (interaction as any).customId;
				this.emit("debug", `executing component handler for custom ID: "${customId}"`, {
					componentArgs,
				});
				executionResult = await run(interaction, componentArgs ?? {}, context);
			} else {
				this.emit("debug", `executing generic fallback handler for interaction ${interaction.id}`);
				executionResult = await run(interaction, context);
			}
		} catch (err) {
			executionError = err;
			if (err instanceof HaltExecution) {
				this.emit("debug", `execution halted intentionally for interaction ${interaction.id}.`);
				if (
					err.replyPayload &&
					interaction.isRepliable() &&
					!interaction.replied &&
					!interaction.deferred
				) {
					const replyOptions =
						typeof err.replyPayload === "string"
							? { content: err.replyPayload, ephemeral: true }
							: err.replyPayload;
					await interaction.reply(replyOptions).catch(() => null);
				}
				return;
			}

			let activeError = err;
			let handled = false;

			const handleErr = async (handler?: ErrorHandler<any, any>) => {
				if (!handler) return false;
				try {
					this.emit("debug", `executing error handler for interaction ${interaction.id}`);
					await handler(activeError, interaction, context);
					return true;
				} catch (e) {
					this.emit("debug", `error handler threw an error, propagating...`);
					activeError = e;
					return false;
				}
			};

			if (await handleErr(extra?.localOnError)) handled = true;

			if (!handled && extra?.builderErrorHandlers) {
				for (const handler of extra.builderErrorHandlers) {
					if (await handleErr(handler)) {
						handled = true;
						break;
					}
				}
			}

			if (!handled) handled = await handleErr(this.globalOnError);

			if (!handled) {
				const isCommand = "commandName" in interaction;
				const identifier = isCommand
					? (interaction as any).commandName
					: "customId" in interaction
						? (interaction as any).customId
						: "unknown";
				const typeLabel = isCommand ? "command" : "component";

				this.emit("error", `unhandled error executing ${typeLabel} ${identifier}:`, {
					error: activeError instanceof Error ? activeError.stack : String(activeError),
					[typeLabel]: identifier,
					user: interaction.user.id,
				});

				if (interaction.isRepliable() && !interaction.replied && !interaction.deferred) {
					await interaction
						.reply({
							content: `An error occurred while executing this ${typeLabel}.`,
							flags: ["Ephemeral"],
						})
						.catch(() => null);
				}
			}
		} finally {
			if (didStartExecution && extra?.afterwares?.length) {
				this.emit(
					"debug",
					`Running ${extra.afterwares.length} afterware(s) for interaction ${interaction.id}`,
				);
				for (let i = 0; i < extra.afterwares.length; i++) {
					const aw = extra.afterwares[i];
					if (!aw) continue;
					try {
						this.emit("debug", `executing afterware [${i + 1}/${extra.afterwares.length}]`);
						await aw(interaction, context, executionError, executionResult);
					} catch (awErr) {
						this.emit(
							"error",
							`unhandled error executing afterware [${i + 1}/${extra.afterwares.length}]:`,
							{
								error: awErr instanceof Error ? awErr.stack : String(awErr),
								interaction: interaction.id,
							},
						);
					}
				}
			}
		}
	}

	private async routeAutocomplete(interaction: AutocompleteInteraction) {
		const entry = this.commands.get(interaction.commandName);
		if (!entry) {
			this.emit(
				"debug",
				`autocomplete aborted: command "${interaction.commandName}" not registered.`,
			);
			return;
		}

		const focused = interaction.options.getFocused(true);
		let optionsSchema: Record<string, Option<any, any>> | undefined;

		if (entry instanceof SubcommandGroupBuilder) {
			const groupName = interaction.options.getSubcommandGroup(false);
			const subName = interaction.options.getSubcommand(false);

			if (groupName && subName)
				optionsSchema = entry.groups[groupName]?.subcommands[subName]?.config.options;
			else if (subName) optionsSchema = entry.subcommands[subName]?.config.options;
		} else {
			optionsSchema = entry.config.options;
		}

		const opt = optionsSchema?.[focused.name];
		if (opt?.autocomplete) {
			this.emit(
				"debug",
				`handling autocomplete for command "${interaction.commandName}" option "${focused.name}" with value "${focused.value}"`,
			);
			const choices = await opt.autocomplete(interaction, focused.value);
			await interaction.respond(choices).catch(() => null);
		} else {
			this.emit(
				"debug",
				`no autocomplete handler configured for option "${focused.name}" in command "${interaction.commandName}"`,
			);
		}
	}

	private async routeComponent(interaction: KittenComponentInteraction) {
		const [prefix] = interaction.customId.split(":");
		if (!prefix) {
			this.emit(
				"debug",
				`component routing skipped: unable to extract prefix from customId "${interaction.customId}".`,
			);
			return;
		}

		const component = this.components.get(prefix);
		if (!component) {
			this.emit(
				"debug",
				`component routing skipped: no component handler registered for prefix "${prefix}".`,
			);
			return;
		}

		this.emit(
			"debug",
			`routing component for prefix "${prefix}" (customId:${interaction.customId})`,
		);
		const args = component.parseArgs(interaction.customId);

		await this.executeWithMiddlewares(
			interaction,
			component.middlewares,
			component.config.run,
			undefined,
			args,
			{
				localOnError: component.config.onError,
				builderErrorHandlers: component.errorHandlers,
				afterwares: component.afterwares,
			},
		);
	}

	private parseSlashOptions(
		interaction: ChatInputCommandInteraction,
		optionsSchema?: Record<string, Option<any, any>>,
	): Record<string, any> {
		if (!optionsSchema) return {};
		const parsed: Record<string, any> = {};

		this.emit("debug", `parsing options for command "${interaction.commandName}"`);

		const typeToMethod = {
			string: "getString",
			integer: "getInteger",
			number: "getNumber",
			boolean: "getBoolean",
			user: "getUser",
			channel: "getChannel",
			role: "getRole",
			mentionable: "getMentionable",
			attachment: "getAttachment",
		} as const;

		for (const [name, opt] of Object.entries(optionsSchema)) {
			const method = typeToMethod[opt.type as keyof typeof typeToMethod];
			if (method) {
				parsed[name] = (interaction.options as any)[method](name);
			} else {
				this.emit("debug", `skipping option "${name}" due to unmapped option type: "${opt.type}"`);
			}
		}

		return parsed;
	}

	private applyBaseAppCommandConfig(payload: any, config: any) {
		if (!config) return payload;
		if (config.nameLocalizations) payload.name_localizations = config.nameLocalizations;
		if (config.descriptionLocalizations)
			payload.description_localizations = config.descriptionLocalizations;
		if (config.integrationTypes) payload.integration_types = config.integrationTypes;
		if (config.contexts) payload.contexts = config.contexts;
		if (config.defaultMemberPermissions !== undefined) {
			payload.default_member_permissions =
				config.defaultMemberPermissions === null
					? null
					: new PermissionsBitField(config.defaultMemberPermissions).bitfield.toString();
		}
		if (config.nsfw !== undefined) payload.nsfw = config.nsfw;
		return payload;
	}

	private mapSubcommand(sub: Subcommand): APIApplicationCommandOption {
		return {
			type: OPTION_TYPES.subcommand,
			name: sub.name,
			name_localizations: sub.config.nameLocalizations,
			description: sub.config.description,
			description_localizations: sub.config.descriptionLocalizations,
			options: this.transformOptionsForDiscord(sub.config.options),
		} as APIApplicationCommandOption;
	}

	/**
	 * syncs your registered commands and context menus with the discord API.
	 *
	 * @remarks
	 * it is recommended to pass `{ guildId: "..." }` during active development, as
	 * discord updates guild commands instantly, while global syncs can take up to an hour.
	 */
	async sync({ guildId }: { guildId?: string } = {}) {
		const payloads: RESTPostAPIApplicationCommandsJSONBody[] = [];

		// chat input commands
		for (const cmd of this.commands.values()) {
			const payload: any = {
				type: ApplicationCommandType.ChatInput,
				name: cmd.name,
				description:
					cmd instanceof SubcommandGroupBuilder ? cmd.description : cmd.config.description,
			};

			if (cmd instanceof SubcommandGroupBuilder) {
				payload.options = [
					...Object.values(cmd.subcommands).map((sub) => this.mapSubcommand(sub)),
					...Object.values(cmd.groups).map((group) => ({
						type: OPTION_TYPES.subcommandGroup,
						name: group.name,
						name_localizations: group.config?.nameLocalizations,
						description: group.description,
						description_localizations: group.config?.descriptionLocalizations,
						options: Object.values(group.subcommands).map((sub) => this.mapSubcommand(sub)),
					})),
				];
				this.applyBaseAppCommandConfig(payload, cmd.config);
			} else {
				payload.options = this.transformOptionsForDiscord(cmd.config.options);
				this.applyBaseAppCommandConfig(payload, cmd.config);
			}

			payloads.push(payload);
		}

		// context menus
		for (const cmd of this.userContextMenus.values()) {
			payloads.push(
				this.applyBaseAppCommandConfig(
					{
						type: ApplicationCommandType.User,
						name: cmd.name,
					},
					cmd.config,
				),
			);
		}

		for (const cmd of this.messageContextMenus.values()) {
			payloads.push(
				this.applyBaseAppCommandConfig(
					{
						type: ApplicationCommandType.Message,
						name: cmd.name,
					},
					cmd.config,
				),
			);
		}

		if (!this.client.application) {
			throw new Error("client application not ready to sync. ensure you await client.login()");
		}

		this.emit("debug", `preparing to sync ${payloads.length} command(s) to Discord API...`);

		if (guildId) {
			await this.client.application.commands.set(payloads, guildId);
			this.emit("info", `synced ${payloads.length} commands to guild ${guildId}.`, {
				guildId,
				commandCount: payloads.length,
			});
		} else {
			await this.client.application.commands.set(payloads);
			this.emit("info", `synced ${payloads.length} global commands.`, {
				commandCount: payloads.length,
			});
		}
	}

	private transformOptionsForDiscord(
		options?: Record<string, CommandOption<any, any>>,
	): APIApplicationCommandBasicOption[] {
		if (!options) return [];

		return Object.entries(options).map(([name, opt]) => {
			const payload: any = {
				name,
				description: opt.description,
				type: OPTION_TYPES[opt.type],
				required: opt.required,
			};

			if (opt.autocomplete) payload.autocomplete = true;

			if (opt.choices) {
				payload.choices = opt.choices.map((c) => ({
					name: c.name,
					name_localizations: c.nameLocalizations,
					value: c.value,
				}));
			}

			if (opt.nameLocalizations) payload.name_localizations = opt.nameLocalizations;
			if (opt.descriptionLocalizations)
				payload.description_localizations = opt.descriptionLocalizations;

			return payload as APIApplicationCommandBasicOption;
		});
	}
}