feat: implementing commands preconditions (ownerOnly, userPermissions)

Author: davidabou

src/commands.ts

@@ -4,6 +4,7 @@ import { filename } from 'pathe/utils'
 import {
   ApplicationCommandType,
   ContextMenuCommandBuilder,
+  PermissionFlagsBits,
   SlashCommandBuilder
 } from 'discord.js'
 import {
@@ -52,6 +53,12 @@ export const slashToJSON = (cmd: HarmonixCommand<true, CommandArg[]>) => {
   const builder = new SlashCommandBuilder()
     .setName(cmd.options.name!)
     .setDescription(cmd.options.description || 'No description provided')
+    .setDefaultMemberPermissions(
+      cmd.options.userPermissions?.reduce(
+        (acc, perm) => acc | PermissionFlagsBits[perm],
+        0n
+      )
+    )
 
   if (cmd.options.args) {
     for (const arg of cmd.options.args) {

src/discord.ts

@@ -18,6 +18,7 @@ import {
 } from './types'
 import 'dotenv/config'
 import { slashToJSON, contextMenuToJSON } from './commands'
+import { createError } from './harmonix'
 
 export const initCient = (harmonixOptions: Harmonix['options']) => {
   const client = new Client({ intents: harmonixOptions.intents })
@@ -37,7 +38,7 @@ export const refreshApplicationCommands = async (
     consola.info('Started refreshing application commands.')
     await rest.put(
       Routes.applicationCommands(
-        harmonix.options.clientId || process.env.HARMONIX_CLIENT_ID!
+        harmonix.options.clientId || process.env.HARMONIX_CLIENT_ID || ''
       ),
       {
         body: commands.map((cmd) =>
@@ -47,7 +48,7 @@ export const refreshApplicationCommands = async (
     )
     consola.success('Successfully reloaded application commands.')
   } catch {
-    consola.error('Failed to reload application commands.')
+    createError('Failed to reload application commands.')
   }
 }
 
@@ -83,6 +84,8 @@ export const registerCommands = (
 
     if (!command) return
     const cmd = commands.find((cmd) => cmd.options.name === command)
+
+    if (!cmd || cmd.options.slash) return
     const resolvedArgs = await Promise.all(
       (cmd?.options.args || []).map(async (arg, i) => [
         arg.name,
@@ -91,7 +94,17 @@ export const registerCommands = (
     )
     const fullArgs = Object.fromEntries(resolvedArgs)
 
-    if (!cmd || cmd.options.slash) return
+    if (cmd.options.ownerOnly) {
+      if (!harmonix.options.ownerId) {
+        createError('Owner ID is required for ownerOnly commands.')
+      }
+      if (!isOwner(harmonix, message.author.id)) return // TODO: Make possibility to customize ownerOnly message
+    }
+    if (cmd.options.userPermissions) {
+      for (const perm of cmd.options.userPermissions) {
+        if (!message.member?.permissions.has(perm)) return // TODO: Make possibility to customize userPermissions message
+      }
+    }
     cmd.execute(harmonix.client!, message, { slash: false, args: fullArgs })
   })
 }
@@ -112,15 +125,18 @@ export const registerSlashCommands = (
         opt.name,
         await resolveArgument(
           interaction,
-          commandArgType(opt.type)!,
+          commandArgType(opt.type),
           String(opt.value)
         )
       ])
     )
     const fullArgs = Object.fromEntries(resolvedArgs)
 
+    if (cmd.options.ownerOnly && harmonix.options.ownerId) {
+      if (!isOwner(harmonix, interaction.user.id)) return // TODO: Make possibility to customize ownerOnly message
+    }
     cmd.execute(harmonix.client!, interaction, {
-      slash: true,
+      slash: false,
       args: fullArgs
     })
   })
@@ -141,6 +157,20 @@ export const registerContextMenu = (
   })
 }
 
+const isOwner = (harmonix: Harmonix, authorId: string) => {
+  if (
+    Array.isArray(harmonix.options.ownerId) &&
+    !harmonix.options.ownerId.includes(authorId)
+  )
+    return false
+  if (
+    typeof harmonix.options.ownerId === 'string' &&
+    authorId !== harmonix.options.ownerId
+  )
+    return false
+  return true
+}
+
 const isHarmonixCommand = (
   command: HarmonixCommand<true, CommandArg[]> | HarmonixContextMenu
 ): command is HarmonixCommand<true, CommandArg[]> => {
@@ -151,7 +181,7 @@ const isHarmonixCommand = (
 
 export const resolveArgument = async (
   entity: MessageOrInteraction,
-  type: CommandArgType,
+  type: CommandArgType | null,
   value: string
 ) => {
   switch (type) {
@@ -208,7 +238,7 @@ const resolveRole = async (entity: MessageOrInteraction, value: string) => {
   )
 }
 
-const commandArgType = (type: ApplicationCommandOptionType) => {
+const commandArgType = (type: ApplicationCommandOptionType | null) => {
   switch (type) {
     case ApplicationCommandOptionType.String:
       return CommandArgType.String
@@ -224,5 +254,7 @@ const commandArgType = (type: ApplicationCommandOptionType) => {
       return CommandArgType.Role
     case ApplicationCommandOptionType.Number:
       return CommandArgType.Number
+    default:
+      return null
   }
 }

src/harmonix.ts

@@ -1,4 +1,5 @@
 import type { LoadConfigOptions } from 'c12'
+import consola from 'consola'
 import { loadOptions } from './options'
 import { scanCommands, scanContextMenus, scanEvents } from './scan'
 import { resolveHarmonixCommand } from './commands'
@@ -45,21 +46,21 @@ export const createHarmonix = async (
   )
 
   if (!process.env.HARMONIX_CLIENT_TOKEN) {
-    throw new Error(
+    createError(
       'Client token is required. Please provide it in the environment variable HARMONIX_CLIENT_TOKEN.'
     )
   }
   if (!harmonix.options.clientId && !process.env.HARMONIX_CLIENT_ID) {
-    throw new Error(
+    createError(
       'Client ID is required. You can provide it in the configuration file or in the environment variable HARMONIX_CLIENT_ID.'
     )
   }
   harmonix.client = initCient(harmonix.options)
-  refreshApplicationCommands(harmonix, [
+  registerEvents(harmonix, events)
+  await refreshApplicationCommands(harmonix, [
     ...commands.filter((cmd) => cmd.options.slash),
     ...contextMenus
   ])
-  registerEvents(harmonix, events)
   registerCommands(
     harmonix,
     commands.filter((cmd) => !cmd.options.slash)
@@ -72,3 +73,8 @@ export const createHarmonix = async (
 
   return harmonix
 }
+
+export const createError = (message: string) => {
+  consola.error(new Error(message))
+  process.exit(1)
+}

src/options.ts

@@ -1,11 +1,11 @@
 import { LoadConfigOptions, loadConfig } from 'c12'
 import { resolve } from 'pathe'
 import type { HarmonixConfig } from './types'
+import { createError } from './harmonix'
 
 const HarmonixDefaults: HarmonixConfig = {
   scanDirs: [],
-  ignore: [],
-  intents: ['Guilds', 'GuildMessages', 'MessageContent']
+  ignore: []
 }
 
 export const loadOptions = async (
@@ -24,7 +24,7 @@ export const loadOptions = async (
   })
 
   if (!config) {
-    throw new Error('No configuration found')
+    return createError('No configuration found')
   }
   const options = config
 
@@ -36,6 +36,11 @@ export const loadOptions = async (
   )
   options.scanDirs = [...new Set(options.scanDirs)]
   options.defaultPrefix = options.defaultPrefix || '!'
+  options.intents = options.intents || [
+    'Guilds',
+    'GuildMessages',
+    'MessageContent'
+  ]
 
   return options
 }

src/types/commands.ts

@@ -2,7 +2,8 @@ import type {
   Client,
   Message,
   ChatInputCommandInteraction,
-  CacheType
+  CacheType,
+  PermissionsString
 } from 'discord.js'
 
 export enum CommandArgType {
@@ -65,9 +66,7 @@ export interface CommandOptions {
   nsfw?: boolean
   slash?: boolean
   ownerOnly?: boolean
-  guildOnly?: boolean
-  userPermissions?: any[]
-  botPermissions?: any[]
+  userPermissions?: PermissionsString[]
   cooldown?: number
 }