fix(Command): support BulkOverwrite for reloads (#600)

Author: favna

src/lib/structures/Command.ts

@@ -1,5 +1,5 @@
 import { ArgumentStream, Lexer, Parser, type IUnorderedStrategy } from '@sapphire/lexure';
-import { AliasPiece, type AliasPieceJSON, type AliasStore } from '@sapphire/pieces';
+import { AliasPiece, type AliasPieceJSON } from '@sapphire/pieces';
 import { isNullish, type Awaitable, type NonNullObject } from '@sapphire/utilities';
 import {
 	ChatInputCommandInteraction,
@@ -11,13 +11,14 @@ import {
 	type Snowflake
 } from 'discord.js';
 import { Args } from '../parsers/Args';
-import { BucketScope } from '../types/Enums';
-import { acquire } from '../utils/application-commands/ApplicationCommandRegistries';
+import { BucketScope, RegisterBehavior } from '../types/Enums';
+import { acquire, getDefaultBehaviorWhenNotIdentical, handleBulkOverwrite } from '../utils/application-commands/ApplicationCommandRegistries';
 import type { ApplicationCommandRegistry } from '../utils/application-commands/ApplicationCommandRegistry';
 import { emitRegistryError } from '../utils/application-commands/emitRegistryError';
 import { getNeededRegistryParameters } from '../utils/application-commands/getNeededParameters';
 import { PreconditionContainerArray, type PreconditionEntryResolvable } from '../utils/preconditions/PreconditionContainerArray';
 import { FlagUnorderedStrategy, type FlagStrategyOptions } from '../utils/strategies/FlagUnorderedStrategy';
+import type { CommandStore } from './CommandStore';
 
 export class Command<PreParseReturn = Args, O extends Command.Options = Command.Options> extends AliasPiece<O> {
 	/**
@@ -248,7 +249,7 @@ export class Command<PreParseReturn = Args, O extends Command.Options = Command.
 
 	public override async reload() {
 		// Remove the aliases from the command store
-		const store = this.store as AliasStore<this>;
+		const store = this.store as CommandStore;
 		const registry = this.applicationCommandRegistry;
 
 		for (const nameOrId of registry.chatInputCommands) {
@@ -293,6 +294,12 @@ export class Command<PreParseReturn = Args, O extends Command.Options = Command.
 			}
 		}
 
+		// If the default behavior is set to bulk overwrite, handle it as such and return.
+		if (getDefaultBehaviorWhenNotIdentical() === RegisterBehavior.BulkOverwrite) {
+			await handleBulkOverwrite(store, this.container.client.application!.commands);
+			return;
+		}
+
 		// Re-initialize the store and the API data (insert in the store handles the register method)
 		const { applicationCommands, globalCommands, guildCommands } = await getNeededRegistryParameters(updatedRegistry.guildIdsToFetch);
 

src/lib/structures/CommandStore.ts

@@ -1,5 +1,11 @@
 import { AliasStore } from '@sapphire/pieces';
-import { allGuildIdsToFetchCommandsFor, registries } from '../utils/application-commands/ApplicationCommandRegistries';
+import { RegisterBehavior } from '../types/Enums';
+import {
+	allGuildIdsToFetchCommandsFor,
+	getDefaultBehaviorWhenNotIdentical,
+	handleBulkOverwrite,
+	registries
+} from '../utils/application-commands/ApplicationCommandRegistries';
 import { emitRegistryError } from '../utils/application-commands/emitRegistryError';
 import { getNeededRegistryParameters } from '../utils/application-commands/getNeededParameters';
 import { Command } from './Command';
@@ -64,6 +70,12 @@ export class CommandStore extends AliasStore<Command> {
 			}
 		}
 
+		// If the default behavior is set to bulk overwrite, handle it as such and return.
+		if (getDefaultBehaviorWhenNotIdentical() === RegisterBehavior.BulkOverwrite) {
+			await handleBulkOverwrite(this, this.container.client.application.commands);
+			return;
+		}
+
 		const { applicationCommands, globalCommands, guildCommands } = await getNeededRegistryParameters(allGuildIdsToFetchCommandsFor);
 
 		for (const command of this.values()) {

src/lib/utils/application-commands/ApplicationCommandRegistries.ts

@@ -69,7 +69,7 @@ export async function handleRegistryAPICalls() {
 	await handleAppendOrUpdate(commandStore, params);
 }
 
-async function handleBulkOverwrite(commandStore: CommandStore, applicationCommands: ApplicationCommandManager) {
+export async function handleBulkOverwrite(commandStore: CommandStore, applicationCommands: ApplicationCommandManager) {
 	// Map registries by guild, global, etc
 	const foundGlobalCommands: BulkOverwriteData[] = [];
 	const foundGuildCommands: Record<string, BulkOverwriteData[]> = {};
@@ -109,7 +109,7 @@ async function handleBulkOverwrite(commandStore: CommandStore, applicationComman
 				registry.globalCommandId = id;
 				registry.addChatInputCommandIds(id);
 
-				// idHints are useless, and any manually added id or names could end up not being valid anymore if you use bulk overwrites
+				// idHints are useless, and any manually added id or names could end up not being valid any longer if you use bulk overwrites
 				// That said, this might be an issue, so we might need to do it like `handleAppendOrUpdate`
 				commandStore.aliases.set(id, piece);
 			} else {