feat: add CoreApplicationCommandRegistriesBulkOverwrite event listener (#855)

This event listener is used to log when bulk overwrite is successful. By default is is automatically loaded, it can be overwritten to log something else or null by creating a custom listener with the same name.

Co-authored-by: Aura <kyradiscord@gmail.com>

Author: minemalox

src/lib/types/Events.ts

@@ -6,7 +6,9 @@ import {
 	type ChatInputCommandInteraction,
 	type ContextMenuCommandInteraction,
 	type Interaction,
-	type Message
+	type Message,
+	type Collection,
+	type Snowflake
 } from 'discord.js';
 import type { UserError } from '../errors/UserError';
 import type { Command } from '../structures/Command';
@@ -219,6 +221,13 @@ export const Events = {
 	 */
 	ApplicationCommandRegistriesRegistered: 'applicationCommandRegistriesRegistered' as const,
 
+	/**
+	 * Emitted when handling the command registries in bulk overwrite mode.
+	 * @param {Collection<Snowflake, ApplicationCommand>} result The result of the bulk overwrite
+	 * @param {string|null} guildId The guild id where the bulk overwrite was applied, null if global
+	 */
+	ApplicationCommandRegistriesBulkOverwrite: 'applicationCommandRegistriesBulkOverwrite' as const,
+
 	/**
 	 * Emitted when an error is encountered when handling the command registries in bulk overwrite mode.
 	 * @param {*} error The error that was thrown
@@ -606,6 +615,7 @@ declare module 'discord.js' {
 		[SapphireEvents.CommandApplicationCommandRegistryError]: [error: unknown, command: Command];
 		[SapphireEvents.ApplicationCommandRegistriesInitialising]: [];
 		[SapphireEvents.ApplicationCommandRegistriesRegistered]: [registries: Map<string, ApplicationCommandRegistry>, timeTaken: number];
+		[SapphireEvents.ApplicationCommandRegistriesBulkOverwrite]: [result: Collection<Snowflake, ApplicationCommand>, guildId: string | null];
 		[SapphireEvents.ApplicationCommandRegistriesBulkOverwriteError]: [error: unknown, guildId: string | null];
 
 		[SapphireEvents.PreMessageParsed]: [message: Message];

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

@@ -10,7 +10,7 @@ import { Events } from '../../types/Events';
 import { ApplicationCommandRegistry } from './ApplicationCommandRegistry';
 import { getNeededRegistryParameters } from './getNeededParameters';
 import { emitBulkOverwriteError, emitPerRegistryError } from './registriesErrors';
-import { bulkOverwriteDebug, bulkOverwriteInfo, bulkOverwriteWarn } from './registriesLog';
+import { bulkOverwriteDebug, bulkOverwriteWarn } from './registriesLog';
 
 export let defaultBehaviorWhenNotIdentical = RegisterBehavior.Overwrite;
 export let defaultGuildIds: ApplicationCommandRegistry.RegisterOptions['guildIds'] = undefined;
@@ -183,7 +183,7 @@ async function handleBulkOverwriteGlobalCommands(
 			}
 		}
 
-		bulkOverwriteInfo(`Successfully overwrote global application commands. The application now has ${result.size} global commands`);
+		container.client.emit(Events.ApplicationCommandRegistriesBulkOverwrite, result, null);
 	} catch (error) {
 		if (error instanceof Error && error.name === 'AbortError') throw error;
 
@@ -236,9 +236,7 @@ async function handleBulkOverwriteGuildCommands(
 			}
 		}
 
-		bulkOverwriteInfo(
-			`Successfully overwrote guild application commands for guild ${guildId}. The application now has ${result.size} guild commands for guild ${guildId}`
-		);
+		container.client.emit(Events.ApplicationCommandRegistriesBulkOverwrite, result, guildId);
 	} catch (error) {
 		if (error instanceof Error && error.name === 'AbortError') throw error;
 

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

@@ -1,9 +1,5 @@
 import { container } from '@sapphire/pieces';
 
-export function bulkOverwriteInfo(message: string, ...other: unknown[]) {
-	container.logger.info(`ApplicationCommandRegistries(BulkOverwrite) ${message}`, ...other);
-}
-
 export function bulkOverwriteError(message: string, ...other: unknown[]) {
 	container.logger.error(`ApplicationCommandRegistries(BulkOverwrite) ${message}`, ...other);
 }

src/optional-listeners/application-command-registries-listeners/CoreApplicationCommandRegistriesBulkOverwrite.ts

@@ -0,0 +1,21 @@
+import { Listener } from '../../lib/structures/Listener';
+import { Events } from '../../lib/types/Events';
+import type { ApplicationCommand, Collection, Snowflake } from 'discord.js';
+
+export class CoreListener extends Listener<typeof Events.ApplicationCommandRegistriesBulkOverwrite> {
+	public constructor(context: Listener.LoaderContext) {
+		super(context, { event: Events.ApplicationCommandRegistriesBulkOverwrite });
+	}
+
+	public run(result: Collection<Snowflake, ApplicationCommand>, guildId: string | null) {
+		if (guildId) {
+			this.container.logger.info(
+				`ApplicationCommandRegistries(BulkOverwrite) Successfully overwrote guild application commands for guild ${guildId}. The application now has ${result.size} guild commands for guild ${guildId}`
+			);
+		} else {
+			this.container.logger.info(
+				`ApplicationCommandRegistries(BulkOverwrite) Successfully overwrote global application commands. The application now has ${result.size} global commands`
+			);
+		}
+	}
+}

src/optional-listeners/application-command-registries-listeners/_load.ts

@@ -1,6 +1,7 @@
 import { container } from '@sapphire/pieces';
 import { CoreListener as CoreApplicationCommandRegistriesInitialising } from './CoreApplicationCommandRegistriesInitialising';
 import { CoreListener as CoreApplicationCommandRegistriesRegistered } from './CoreApplicationCommandRegistriesRegistered';
+import { CoreListener as CoreApplicationCommandRegistriesBulkOverwrite } from './CoreApplicationCommandRegistriesBulkOverwrite';
 
 export function loadApplicationCommandRegistriesListeners() {
 	const store = 'listeners' as const;
@@ -14,4 +15,9 @@ export function loadApplicationCommandRegistriesListeners() {
 		piece: CoreApplicationCommandRegistriesRegistered,
 		store
 	});
+	void container.stores.loadPiece({
+		name: 'CoreApplicationCommandRegistriesBulkOverwrite',
+		piece: CoreApplicationCommandRegistriesBulkOverwrite,
+		store
+	});
 }