update ephemeral responses to use MessageFlags.Ephemeral

Author: notunderctrl

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2024 Avraj Sahota
+Copyright 2025 Avraj Sahota
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so.
 

apps/docs/content/guide/validation-file-setup.mdx

@@ -19,12 +19,13 @@ Validation functions are called on every command trigger, so it's important to k
     <Tab value="CommonJS">
         ```js title="validations/cooldowns.js"
         const cooldowns = require('../cooldowns-cache');
+        const { MessageFlags } = require('discord.js');
 
         module.exports = ({ interaction, commandObj, handler }) => {
             if (cooldowns.has(`${interaction.user.id}-${commandObj.data.name}`)) {
                 interaction.reply({
                     content: "You're on cooldown, please wait some time before running this command again.",
-                    ephemeral: true,
+                    flags: MessageFlags.Ephemeral
                 });
 
                 return true; // This is important
@@ -36,12 +37,13 @@ Validation functions are called on every command trigger, so it's important to k
     <Tab value="ESM">
         ```js title="validations/cooldowns.js"
         import cooldowns from '../cooldowns-cache';
+        import { MessageFlags } from 'discord.js';
 
         export default function ({ interaction, commandObj, handler }) {
             if (cooldowns.has(`${interaction.user.id}-${commandObj.data.name}`)) {
                 interaction.reply({
                     content: "You're on cooldown, please wait some time before running this command again.",
-                    ephemeral: true,
+                    flags: MessageFlags.Ephemeral
                 });
 
                 return true; // This is important
@@ -54,12 +56,13 @@ Validation functions are called on every command trigger, so it's important to k
         ```ts title="validations/cooldowns.ts"
         import type { ValidationProps } from 'commandkit';
         import cooldowns from '../cooldowns-cache';
+        import { MessageFlags } from 'discord.js';
 
         export default function ({ interaction, commandObj, handler }: ValidationProps) {
             if (cooldowns.has(`${interaction.user.id}-${commandObj.data.name}`)) {
                 interaction.reply({
                     content: "You're on cooldown, please wait some time before running this command again.",
-                    ephemeral: true,
+                    flags: MessageFlags.Ephemeral,
                 });
 
                 return true; // This is important

apps/website/docs/guide/06-validation-file-setup.mdx

@@ -22,12 +22,13 @@ commands.
   <TabItem value='cjs' label='CommonJS' default>
     ```js title="src/validations/cooldowns.js"
     const cooldowns = require('../cooldowns-cache');
+    const { MessageFlags } = require('discord.js');
 
     module.exports = ({ interaction, commandObj, handler }) => {
       if (cooldowns.has(`${interaction.user.id}-${commandObj.data.name}`)) {
         interaction.reply({
           content: "You're on cooldown, please wait some time before running this command again.",
-          ephemeral: true,
+          flags: MessageFlags.Ephemeral,
         });
 
         return true; // This is important
@@ -39,12 +40,13 @@ commands.
   <TabItem value='esm' label='ESM'>
     ```js title="src/validations/cooldowns.js"
     import cooldowns from '../cooldowns-cache';
+    import { MessageFlags } from 'discord.js';
 
     export default function ({ interaction, commandObj, handler }) {
       if (cooldowns.has(`${interaction.user.id}-${commandObj.data.name}`)) {
         interaction.reply({
           content: "You're on cooldown, please wait some time before running this command again.",
-          ephemeral: true,
+          flags: MessageFlags.Ephemeral,
         });
 
         return true; // This is important
@@ -57,12 +59,13 @@ commands.
     ```ts title="src/validations/cooldowns.ts"
     import type { ValidationProps } from 'commandkit';
     import cooldowns from '../cooldowns-cache';
+    import { MessageFlags } from 'discord.js';
 
     export default function ({ interaction, commandObj, handler }: ValidationProps) {
       if (cooldowns.has(`${interaction.user.id}-${commandObj.data.name}`)) {
         interaction.reply({
           content: "You're on cooldown, please wait some time before running this command again.",
-          ephemeral: true,
+          flags: MessageFlags.Ephemeral,
         });
 
         return true; // This is important

apps/website/versioned_docs/version-0.1.10/guide/06-validation-file-setup.mdx

@@ -22,12 +22,13 @@ commands.
   <TabItem value='cjs' label='CommonJS' default>
     ```js title="src/validations/cooldowns.js"
     const cooldowns = require('../cooldowns-cache');
+    const { MessageFlags } = require('discord.js');
 
     module.exports = ({ interaction, commandObj, handler }) => {
       if (cooldowns.has(`${interaction.user.id}-${commandObj.data.name}`)) {
         interaction.reply({
           content: "You're on cooldown, please wait some time before running this command again.",
-          ephemeral: true,
+          flags: MessageFlags.Ephemeral,
         });
 
         return true; // This is important
@@ -39,12 +40,13 @@ commands.
   <TabItem value='esm' label='ESM'>
     ```js title="src/validations/cooldowns.js"
     import cooldowns from '../cooldowns-cache';
+    import { MessageFlags } from 'discord.js';
 
     export default function ({ interaction, commandObj, handler }) {
       if (cooldowns.has(`${interaction.user.id}-${commandObj.data.name}`)) {
         interaction.reply({
           content: "You're on cooldown, please wait some time before running this command again.",
-          ephemeral: true,
+          flags: MessageFlags.Ephemeral,
         });
 
         return true; // This is important
@@ -57,12 +59,13 @@ commands.
     ```ts title="src/validations/cooldowns.ts"
     import type { ValidationProps } from 'commandkit';
     import cooldowns from '../cooldowns-cache';
+    import { MessageFlags } from 'discord.js';
 
     export default function ({ interaction, commandObj, handler }: ValidationProps) {
       if (cooldowns.has(`${interaction.user.id}-${commandObj.data.name}`)) {
         interaction.reply({
           content: "You're on cooldown, please wait some time before running this command again.",
-          ephemeral: true,
+          flags: MessageFlags.Ephemeral,
         });
 
         return true; // This is important

packages/commandkit/src/context/async-context.ts

@@ -1,7 +1,7 @@
 import { AsyncLocalStorage } from 'node:async_hooks';
 import { CommandKitEnvironment } from './environment';
 import { CommandKitErrorCodes, isCommandKitError } from '../utils/error-codes';
-import { Interaction } from 'discord.js';
+import { Interaction, MessageFlags } from 'discord.js';
 import { CommandKit } from '../CommandKit';
 
 const context = new AsyncLocalStorage<CommandKitEnvironment>();
@@ -42,7 +42,7 @@ export function makeContextAwareFunction<
               if (interaction.isRepliable()) {
                 await interaction.reply({
                   content: 'This command is only available in guilds.',
-                  ephemeral: true,
+                  flags: MessageFlags.Ephemeral,
                 });
               }
               return;
@@ -51,7 +51,7 @@ export function makeContextAwareFunction<
               if (interaction.isRepliable()) {
                 await interaction.reply({
                   content: 'This command is only available in DMs.',
-                  ephemeral: true,
+                  flags: MessageFlags.Ephemeral,
                 });
               }
               return;

packages/commandkit/src/handlers/command-handler/validations/devOnly.ts

@@ -1,4 +1,5 @@
 import type { BuiltInValidationParams } from '../typings';
+import { MessageFlags } from 'discord.js';
 
 export default function ({
   interaction,
@@ -14,7 +15,7 @@ export default function ({
     ) {
       interaction.reply({
         content: '❌ This command can only be used inside development servers.',
-        ephemeral: true,
+        flags: MessageFlags.Ephemeral,
       });
 
       return true;
@@ -39,7 +40,7 @@ export default function ({
     if (!isDevUser) {
       interaction.reply({
         content: '❌ This command can only be used by developers.',
-        ephemeral: true,
+        flags: MessageFlags.Ephemeral,
       });
 
       return true;

packages/commandkit/src/handlers/command-handler/validations/permissions.ts

@@ -1,5 +1,5 @@
 import type { BuiltInValidationParams } from '../typings';
-import { EmbedBuilder } from 'discord.js';
+import { EmbedBuilder, MessageFlags } from 'discord.js';
 
 export default function ({
   interaction,
@@ -93,6 +93,6 @@ export default function ({
     .setDescription(embedDescription)
     .setColor('Red');
 
-  interaction.reply({ embeds: [embed], ephemeral: true });
+  interaction.reply({ embeds: [embed], flags: MessageFlags.Ephemeral });
   return true;
 }