feat: application commands hint provider in client options, and set name from base command options

Author: bitomic

src/lib/ApplicationCommand.ts

@@ -1,5 +1,6 @@
 import type { ApplicationCommandData, ApplicationCommandPermissionData, ChatInputApplicationCommandData, MessageApplicationCommandData, UserApplicationCommandData } from 'discord.js'
 import type { Command } from '@sapphire/framework'
+import { container } from '@sapphire/framework'
 
 const types = [ 'chatInput', 'message', 'user' ] as const
 
@@ -10,11 +11,22 @@ export class ApplicationCommand {
 	public messageApplicationIdHints: Set<string> | null = null
 	public userApplicationIdHints: Set<string> | null = null
 
-	public constructor( options: ApplicationCommandOptions ) {
+	private constructor( options: ApplicationCommandOptions ) {
 		this.command = options.command
 
+		if ( this.command.options.chatInputApplicationOptions ) {
+			this.command.options.chatInputApplicationOptions.description ??= this.command.description
+		}
+
 		for ( const type of types ) {
-			const idHints = this.command.options[ `${ type }ApplicationOptions` ]?.idHints
+			// Set some defaults
+			const options = this.command.options[ `${ type }ApplicationOptions` ]
+			if ( !options ) continue
+
+			options.name ??= this.command.name
+
+			// Store id hints
+			const { idHints } = options
 			if ( idHints && idHints.length > 0 ) {
 				const set = new Set<string>()
 				idHints.forEach( id => set.add( id ) )
@@ -23,6 +35,33 @@ export class ApplicationCommand {
 		}
 	}
 
+	public static async create( options: ApplicationCommandOptions ): Promise<ApplicationCommand> {
+		const instance = new ApplicationCommand( options )
+		await instance.fillHints()
+		return instance
+	}
+
+	protected async fillHints(): Promise<void> {
+		const clientOptions = container.client.options
+		const hintProvider = clientOptions.applicationCommandsHintProvider
+		if ( !hintProvider ) return
+
+		for ( const type of types ) {
+			const hints = await hintProvider( this.command.name, type )
+			if ( !hints ) continue
+			const options = this.command.options[ `${ type }ApplicationOptions` ]
+			if ( !options ) continue
+			if ( hints.guildIds ) {
+				options.guildIds ??= []
+				options.guildIds.push( ...hints.guildIds )
+			}
+			if ( hints.idHints ) {
+				options.idHints ??= []
+				options.idHints.push( ...hints.idHints )
+			}
+		}
+	}
+
 	public get allGuilds(): string[] | null {
 		const chatInputHints = this.chatInputApplicationGuilds
 		const messageHints = this.messageApplicationGuilds
@@ -68,6 +107,15 @@ export class ApplicationCommand {
 	public get chatInputApplicationData(): ChatInputApplicationCommandData | null {
 		const options = this.command.options.chatInputApplicationOptions
 		if ( !options ) return null
+		if ( !options.description ) {
+			container.logger.error( 'Missing required property "description"' )
+			return null
+		}
+		if ( !options.name ) {
+			container.logger.error( 'Missing required property "name"' )
+			return null
+		}
+
 		return {
 			defaultPermission: options.defaultPermission ?? true,
 			description: options.description,
@@ -80,6 +128,10 @@ export class ApplicationCommand {
 	public get messageApplicationData(): MessageApplicationCommandData | null {
 		const options = this.command.options.messageApplicationOptions
 		if ( !options ) return null
+		if ( !options.name ) {
+			container.logger.error( 'Missing required property "name"' )
+			return null
+		}
 		return {
 			defaultPermission: options.defaultPermission ?? true,
 			name: options.name,
@@ -90,6 +142,10 @@ export class ApplicationCommand {
 	public get userApplicationData(): UserApplicationCommandData | null {
 		const options = this.command.options.userApplicationOptions
 		if ( !options ) return null
+		if ( !options.name ) {
+			container.logger.error( 'Missing required property "name"' )
+			return null
+		}
 		return {
 			defaultPermission: options.defaultPermission ?? true,
 			name: options.name,

src/listeners/Ready.ts

@@ -14,7 +14,7 @@ export class UserEvent extends Listener {
 	public async run(): Promise<void> {
 		this.container.applicationCommands = new Map()
 
-		const [ applicationCommandsList, guildIds ] = this.getLists()
+		const [ applicationCommandsList, guildIds ] = await this.getLists()
 
 		const [ globalCommandList, guildCommandList ] = this.filterCommandList( applicationCommandsList )
 
@@ -37,14 +37,14 @@ export class UserEvent extends Listener {
 		return [ globalList, guildList ]
 	}
 
-	protected getLists(): [ ApplicationCommand[], Set<string> ] {
+	protected async getLists(): Promise<[ ApplicationCommand[], Set<string> ]> {
 		const list: ApplicationCommand[] = []
 		const guilds = new Set<string>()
 		const commands = this.container.stores.get( 'commands' )
 
 		for ( const [ , command ] of commands ) {
 			if ( !command.options.chatInputApplicationOptions && !command.options.messageApplicationOptions && !command.options.userApplicationOptions ) continue
-			const applicationCommand = new ApplicationCommand( {
+			const applicationCommand = await ApplicationCommand.create( {
 				command
 			} )
 			list.push( applicationCommand )

src/main.ts

@@ -1,20 +1,26 @@
 import type { ApplicationCommandPermissionData, BaseApplicationCommandData, ChatInputApplicationCommandData, CommandInteraction, MessageApplicationCommandData, MessageInteraction, UserApplicationCommandData, UserContextMenuInteraction } from 'discord.js'
 import type { ApplicationCommand } from './lib'
+import type { Awaitable } from '@sapphire/framework'
 
 export * from './lib'
 
-type NoType<T> = Omit<T, 'type'>
+type ApplicationCommandOptionsFilter<T extends BaseApplicationCommandData> = Omit<T, 'type' | 'name' | 'description'>
+	& Partial<Pick<T, T extends ChatInputApplicationCommandData ? 'name' | 'description' : 'name'>>
 
 interface ApplicationCommandAdditionalData {
 	guildIds?: string[]
 	idHints?: string[]
 }
 
-type ApplicationCommandOptions<T extends BaseApplicationCommandData> = NoType<T> & ApplicationCommandAdditionalData & {
+type ApplicationCommandOptions<T extends BaseApplicationCommandData> = ApplicationCommandOptionsFilter<T> & ApplicationCommandAdditionalData & {
 	permissions?: ApplicationCommandPermissionData[]
 }
 
 declare module '@sapphire/framework' {
+	interface SapphireClientOptions {
+		applicationCommandsHintProvider?: ( name: string, type: 'chatInput' | 'message' | 'user' ) => Awaitable<ApplicationCommandAdditionalData | undefined | null>
+	}
+
 	class Command {
 		public chatInputApplicationRun?( interaction: CommandInteraction ): void | Promise<void>
 		public messageApplicationRun?( interaction: MessageInteraction ): void | Promise<void>