nyxx_commands 6.0.3 nyxx_commands: ^6.0.3 copied to clipboard
A framework for easily creating slash commands and text commands for Discord using the nyxx library.
6.0.3 #
Bug fixes
- Expose the arguments list of the
execute
function (#154) - Fix crash when no permission overrides are present in a guild (#155)
6.0.2 #
Bug fixes
- Fixed autocompletion in commands in chat groups
6.0.1 #
Bug fixes
- Fixed ephemeral response levels breaking component helpers.
- Fixed
getMultiSelection
not working. CommandsPlugin.guild
is not longer ignored.
6.0.0 #
Breaking changes
- Update nyxx to version 6.0.0.
Bug fixes
- Fixes a type error that could occur when using FallbackConverter's toButton and toMultiselect.
6.0.0-dev.1 #
Breaking changes
- Update nyxx to version 6.0.0. See the changelog at https://pub.dev/packages/nyxx for more details.
5.0.2 #
Bug fixes
- Fix disposing the plugin partway through command execution causing errors.
5.0.1 #
Bug fixes
- Fix component timeouts triggering instantly.
- Fix component wrappers causing null assertions to trigger.
5.0.0 #
Breaking changes
- Removed all deprecated APIs.
- APIs which used to take
Type
objects now takeRuntimeType
s for the relevant type. - APIs which used to take the
customId
of a component now take aComponentId
. - Context types have been reorganized. See the docs for
IContextData
,ICommandContext
andIInteractiveContext
for more. - Converter & check APIs now take
IContextData
objects instead ofIContext
objects. - Checks now use named parameters instead of positional ones in their constructors.
IInteractiveContext.respond
(formerlyIContext.respond
) now takes aResponseLevel
object instead ofprivate
andhidden
.- The
interactions
field onCommandsPlugin
is now nullable to avoid alate
modifier. UseIContextData.interactions
instead for a non nullable field.
New features
- Contexts are now managed by a
ContextManager
which allows users to create their own contexts. - Added support for modal helpers. See
IInteractionInteractiveContext.getModal
for more. - Added new errors:
ConverterFailedException
,InteractionTimeoutException
,UncaughtCommandsException
andUnhandledInteractionException
. - Events & listeners are now handled by an
EventManager
andComponentId
s. - Prefix callbacks can now be asynchronous and return any
Pattern
. - Added
autoAcknowledgeDuration
for more control over auto-acknowledge. - Added parsing utilities on
AutocompleteContext
for parsing arguments. - Contexts in a command are now chained, so interaction expiry and inconsistent formatting of responses to commands are no longer an issue. See
IInteractiveContext.delegate
for more. - Added many helpers for handling message components:
awaitButtonPress
,awaitSelection
andawaitMultiSelection
for using fully custom components with nyxx_commands;getButtonPress
,getButtonSelection
andgetConfirmation
for handling buttons;getSelection
andgetMultiSelection
for handling multiselect menus.
- Added
SimpleConverter
to simplify creating custom converters. - The prefix callback can now be set to null to disable message commands. This will change the default command type to
slashOnly
unlessCommandsOptions.inferDefaultCommandType
is set tofalse
. - Added
skipPattern
toStringView
, similar toskipString
.
Bug fixes
- Fixed a bug that prevented
part
files from being compiled. - Fixed a bug that prevented enum parameters from being compiled.
- Fixed nested command
fullName
s not being correct.
Miscellaneous
- Optimized the compilation script to generate less code and use a more reliable subtype checking method.
- Instructions for compilation can now be found at the package README.
- Bump
nyxx
to 5.0.0 andnyxx_interactions
to 4.6.0.
5.0.0-dev.3 #
Bug fixes
- Fixed a bug which caused
IInteractiveContext.respond
to error after auto-acknowledge. - Fixed a bug where
getSelection
andgetMultiSelection
would result in an "Interaction failed" error, despite the response being sent. - Fixed a bug that caused a late initialization error to occur if an error occurred in
respond
. - Fixed
getSelection
sending a new message for different pages instead of editing the same message.
5.0.0-dev.2 #
Breaking changes
- The
DartType
class introduced in 5.0.0-dev.0 has been replaced withRuntimeType
frompackage:runtime_type
. - All errors thrown by command callbacks are now caught instead of only subclasses of
Exception
. The relevant fields onUncaughtException
andAutocompleteFailedException
have therefore been changed fromException
toObject
. - APIs that took a combination of user, timeout and component id have been changed to use the new
ComponentId
class.
New features
- Errors will now be added to
CommandsPlugin.onCommandError
when a message component created by nyxx_commands enters an invalid state (e.g no handler found or the user was not allowed to use the component). See the docs forUnhandledInteractionException
for more. - Added
ComponentId
as a way for nyxx_commands to generate an ID for message components that contains information about the component's state in nyxx_commands. - Added a new
InteractionTimeoutException
thrown when an interaction times out instead of Dart'sTimeoutException
. - Added a
stackTrace
getter to allCommandsExceptions
.
Bug fixes
- Fixed an issue where enum values in annotations caused the compiler to crash.
Miscellaneous
- Added documentation with instructions on how to compile nyxx_commands to the README.
- Correctly export
ContextManager
. - Changed the log message for uncaught exceptions. The message no longer contains the error description, instead passing the error object through the log record's error field. Versions of nyxx after 4.5.0 contain a
Logging
plugin that will display this error for you.
5.0.0-dev.1 #
Breaking changes:
CommandsPlugin
has been made more type safe, making theinteractions
field nullable. To use theIInteractions
instance from your commands, seeIContextData.interactions
.client
has also been changed to be read-only.
New features:
- A helper for using modals has been added. See
IInteractionInteractiveContext.getModal
for more. getSelection
andgetMultiSelection
fromIInteractiveContext
can now be used without a converter, using thetoMultiSelect
parameter.- Failed converters now throw a
ConverterFailedException
instead of aBadInputException
. SimpleConverter.provider
can now be async.
Bug fixes:
IChatCommandComponent.fullName
now correctly returns the full command name.- Responding to a component context now correctly clears components on the message.
Miscellaneous:
package:analyzer
has been bumped to 5.0.0.- A few elements that were previously unexported are now correctly exported.
5.0.0-dev.0 #
Breaking changes:
ChatCommand.type
has been moved toCommandOptions
. UseChatCommand(options: CommandOptions(type: ...))
instead ofChatCommand(type: ...)
to set a commands type. With this change, thetextOnly
andslashOnly
constructors have been removed fromChatCommand
.Converter
s no longer take anIContext
as a parameter but now take anICommandContextData
.- Some of the arguments in
Check
constructors have been changed from positional to named arguments. - All deprecated fields have been removed.
IInteractiveContext.respond
(previouslyIContext.respond
) now takes aResponseLevel
instead of the context-type-specific named parameters. SeeResponseLevel
for more.- All uses of
Type
s in the package have been replaced withDartType
s. This wrapper class allows for sound type safety and simplifies compilation. Notable places this change has an effect are inCommandsPlugin.getConverter
andNoConverterException.type
. - The old component wrappers have been replaced with newer, more versatile methods.
New features:
- The
prefix
function used to determine the prefix for a given text message can now return aPattern
and be asynchronous. This allows the use ofRegExp
s to determine command prefixes. CommandsPlugin.contextManager
can be used to create your own contexts from raw events.SimpleConverter
is a newConverter
that simplifies the creation of custom converters. Providing a function to generate items and a function to stringify each item will create a converter with support for basic conversion, autocompletion and more.- The prefix is now nullable in the
CommandsPlugin
constructor. Setting it tonull
will make the default command type automatically beslashOnly
ifCommandsOptions.inferDefaultCommandType
istrue
. - Commands will now respond to the latest interaction instead of the original interaction if the component wrappers on
IInteractiveContext
are used. SeeIInteractiveContext.delegate
for more. CommandOptions.preserveComponentMessages
can be used to choose whether Message Component responses should overwrite the message.CommandOptions.autoAcknowledgeDuration
can be used to manually set the auto-acknowledge timeout.CommandOptions.caseInsensitiveCommands
can be used to allow commands to be invoked case-insensitively.AutocompleteContext
has new methods for parsing values in the autocompletion event.
Bug fixes:
- Returning
null
in an autocomplete handler no longer displays an error in the Discord UI.
4.4.1 #
Bug fixes:
- Fix
part
directives breaking compilation.
4.4.0 #
Miscellaneous:
- Bump
analyzer
to 5.7.1,args
to 2.4.0,dart_style
to 2.2.5,logging
to 1.1.1,meta
to 1.9.0,nyxx
to 4.5.0,nyxx_interactions
to 4.5.0,path
to 1.8.3build_runner
to 2.1.0,coverage
to 1.6.3,lints
to 2.0.1,mockito
to 5.3.2, andtest
to 1.23.1.
4.3.0 #
New features:
- Added support for command localization. See
localizedNames
on allICommand
s andlocalizedDescriptions
forChatCommand
s and the@Description()
annotation.
Bug fixes:
- Fixes
@Name
annotations not working when running withdart:mirrors
. - Fixes the plugin not correctly disposing when the client is disposed.
- Fixed the automatic response sometimes failing.
Miscellaneous:
- Bump
nyxx
to 4.0.0 andnyxx_interactions
to 4.3.1.
4.2.0 #
New features:
- Added a script which allows
nyxx_commands
to be compiled. For more information, rundart pub global activate nyxx_commands
andnyxx-compile --help
. - Implemented support for permissions V2. See
PermissionsCheck
for more.
Deprecations:
- Deprecated
AbstractCheck.permissions
and all associated features.
4.2.0-dev.1 #
New features:
- Added a script which allows
nyxx_commands
to be compiled. For more information, rundart pub global activate nyxx_commands
andnyxx-compile --help
.
4.2.0-dev.0 #
Deprecations:
- Deprecated
AbstractCheck.permissions
and all associated features.
New features:
- Added
AbstractCheck.allowsDm
andAbstractCheck.requiredPermissions
for integrating checks with permissions v2. - Updated
Check.deny
,Check.any
andCheck.all
to work with permissions v2. - Added
PermissionsCheck
, for checking if users have a specific permission.
Miscellaneous:
- Bump
nyxx_interactions
to 4.2.0. - Added proper names to context type checks if none is provided.
4.1.2 #
Bug fixes:
- Fixes an issue where slash commands nested within text-only commands would not be registered
4.1.1 #
Bug fixes:
- Correctly export the
@Autocomplete(...)
annotation.
4.1.0 #
New features:
- Support for autocompletion has been added. See
Converter.autocompleteCallback
and the@Autocomplete(...)
annotation for more. - Added the ability to allow only slash commands or disable them entirely. See
CommandType.def
andCommandOptions.defaultCommandType
for more. - Added
ChatCommand.argumentTypes
, which allows developers to access the argument types for a chat command callback. - Added
Converter.processOptionCallback
, which allows developers to modify the builder generated for a command argument. - Added
IntConverter
,DoubleConverter
andNumConverter
for converting numbers with custom bounds. These new classes allow you to specify a minimum and maximum value for an argument when used with@UseConverter(...)
. - Added
GUildChannelConverter
for converting more specific types of guild channels.
Bug fixes:
- Fixed an issue with
IContext.getButtonPress
not behaving correctly whenauthorOnly
ortimeout
was specified. - Fixed the default converters for guild channels accepting all channels in the Discord UI even if they were not the correct type.
Miscellaneous:
- Updated the command name validation regex.
- Bump
nyxx_interactions
to 4.1.0.
4.0.0 #
Breaking changes:
nyxx_interactions
has been upgraded to 4.0.0.- The names of command classes have changed. The old class
Command
is now namedChatCommand
andGroup
is nowChatGroup
. - The names of context classes have changed. The old class
Context
is now namedIChatContext
,MessageContext
isMessageChatContext
andInteractionContext
is nowInteractionChatContext
. - All deprecated members have been removed.
- The
hideOriginalResponse
parameter has been removed from theChatCommand
constructor. Use the newoptions
parameter and specifyhideOriginalResponse
there instead.
New features:
- Added support for User and Message Application Commands. See the docs for
UserCommand
andMessageCommand
for more information. - Added new in-built checks for validating content types.
- Added helper methods for using
nyxx_interactions
withnyxx_commands
. - Added support for the attachment command option type. Use the
IAttachment
type as your command callback parameter type to use the appropriate converter.
Documentation:
- The documentation for the entire package has been rewritten, with examples, references and more. See the documentation for more details.
Bug fixes:
- Fix a bug concerning optional arguments having their default values wrapped in futures.
4.0.0-dev.2.1 #
Bug fixes:
- Fix a bug concerning types that didn't need to be converted being wrapped in Futures.
4.0.0-dev.2.0 #
Breaking changes:
- Upgrade to
nyxx_interactions
4.0.0.
Bug fixes
- Fix
UserCommandCheck
always failing. - Fix parsing multiple arguments at once leading to race conditions.
- Fix a casting error that occurred when a text command was not found.
Documentation:
- The documentation for the entire package has been rewritten, with examples, references and more. See the documentation for more details.
New features:
- Added support for the
attachment
command option type. UseIAttachment
(fromnyxx_interactions
) as the argument type in your commands callback fornyxx_commands
to register it as an attachment command option. - Added
IInteractionContext
, an interface implemented by all contexts originating from interactions.
4.0.0-dev.1.2 #
Bug fixes:
- Fixed a bug affecting command syncing with external sharding.
4.0.0-dev.1.1 #
Bug fixes:
- Fixed a bug affecting registration of slash commands nested two layers deep.
4.0.0-dev.1 #
New features:
- Export the command types for better typing. See the documentation for
ICallHooked
,IChatCommandComponent
,IChecked
,ICommand
,ICommandGroup
,ICommandRegisterable
andIOptions
for more information. - Add new checks for allowing certain checks to be bypassed by certain command types. See the documentation for
ChatCommandCheck
,InteractionCommandCheck
,InteractionChatCommandCheck
,MessageChatCommandCheck
,MessageCommandCheck
andUserCommandCheck
for more info. - Export
registerDefaultConverters
andparse
for users wanting to implement their own commands plugin.
4.0.0-dev.0 #
Breaking changes:
- The names of command classes have changed. The old class
Command
is now namedChatCommand
andGroup
is nowChatGroup
. - The names of context classes have changed. The old class
Context
is now namedIChatContext
,MessageContext
isMessageChatContext
andInteractionContext
is nowInteractionChatContext
. - All deprecated members have been removed.
- The
hideOriginalResponse
parameter has been removed from theChatCommand
constructor. Use the newoptions
parameter and specifyhideOriginalResponse
there instead.
If you find any more breaking changes please notify us on the official nyxx Discord server, or open an issue on GitHub.
New features:
- Support for User Application Commands has been added. They can be created through the
UserCommand
class similarly toChatCommand
s, and must be added withCommandsPlugin.addCommand()
asChatCommand
s are. - Support for Message Application Commands has been added. They can be created through the
MessageCommand
class similarly toChatCommand
s, and must be added withCommandsPlugin.addCommand()
asChatCommand
s are. - Better support for command configuration has been added. Users can now specify options to apply only to specific commands through the
options
parameter in all command constructors with the newCommandOptions
class. Similarly to checks, these options are inherited but can be overridden by children. - Added a few simple functions for easier interaction with
nyxx_interactions
covering common use cases for interactions.
Bug fixes:
- Fixed an edge case issue with converters where assembled converters sometimes wouldn't return the correct type
3.3.0 #
New features:
- Added a
remaining()
method toCooldownCheck
to get the remaining cooldown for a context.
Deprecations:
registerChild
has been deprecated, users should prefer the better namedaddCommand
method.
3.2.0 #
Bug fixes:
- Exceptions are now correctly caught for commands with async
execute
functions. - Check hooks are now correctly called when using
Check.all
,Check.any
orCheck.deny
.
New features:
- Added a new
private
option toContext.respond
that allows users to send private responses to commands. - Added the ability to combine
CooldownTypes
using the binary OR (|
) operator. - Added a new
dmOr
function that can be used inCommandsPlugin.prefix
to allow users to omit the bot prefix in DMs.
3.1.1 #
Bug fixes:
- Fixed an issue where
Check.all
,Check.any
andCheck.deny
would not acceptAbstractCheck
s as arguments.
3.1.0 #
New features:
- Default choices for
CombineConverter
s andFallbackConverter
s can now be specified in thechoices
parameter. - You can now specify the Discord slash command option type to use in
Converter
,CombineConverter
andFallbackConverter
s with thetype
parameter. - Added a new
hideOriginalResponse
option toCommandsOptions
that allows you to hide the automatic acknowledgement of interactions withautoAcknowledgeInteractions
. - Added a new
acknowledge
method toInteractionContext
that allows you to overridehideOriginalResponse
. - Added a new
hideOriginalResponse
parameter toCommand
constructors that allows you to overrideCommandsOptions.hideOriginalResponse
on a per-command basis. - Added a new
hidden
parameter toInteractionContext.respond
that allows you to send an ephemeral response. The hidden state of the response sent is guaranteed to match thehidden
parameter, however to avoid strange behavior it is recommended to acknowledge the interaction withInteractionContext.acknowledge
if the response is delayed. - Added a new
mention
parameter toMessageContext.respond
that allows you to specify whether the reply to the command should mention the user or not. - Added a new
UseConverter
decorator that allows you to override the converter used to parse a specific argument. - Added converters for
double
s andMentionable
s. - Added a new global
mentionOr
function that can be used inCommandsPlugin.prefix
to allow mention prefixes.
Miscellaneous:
autoAcknowledgeInteractions
no longer immediately acknowledges interactions upon receiving them, allowing ephemeral responses to be correctly sent.- Bumped
nyxx_interactions
to 3.1.0 - Argument parsing is now done in parallel, making commands with multiple arguments faster to invoke.
Deprecations:
- Setting the Discord slash command option type to use for a Dart
Type
via thediscordTypes
map is now deprecated. Use thetype
parameter in converter constructors instead. Context.send
is now deprecated asContext.respond
is more appropriate for most cases. IfContext.send
was really what you wanted, useContext.channel.sendMessage
instead.
3.0.0 #
Breaking changes:
- The base
Bot
class has been replaced with aCommandsPlugin
class that can be used as a plugin with nyxx3.0.0
. nyxx
andnyxx_interactions
dependencies have been bumped to3.0.0
; versions2.x
are now unsupported.BotOptions
has been renamed toCommandsOptions
and no longer supports the options found inClientOptions
. Create two separate instances and pass them toNyxxFactory.createNyxx...
andCommandsPlugin
respectively, in theoptions
named parameter.- The
bot
field onContext
has been replaced with aclient
field pointing to theINyxx
instance and acommands
field pointing to theCommandsPlugin
instance.
2.0.0 #
Breaking changes:
- Messages sent by bot users will no longer be executed by default, see
BotOptions.acceptBotCommands
andBotOptions.acceptSelfCommands
.
New features:
- A new
acceptBotCommands
option has been added toBotOptions
to allow executing commands from messages sent by other bot users. - A new
acceptSelfCommands
options has been added toBotOptions
to allow executing commands from messages sent by the bot itself. onPreCall
andonPostCall
streams onCommands
andGroups
can be used to register pre- and post- call hooks.AbstractCheck
class can be extended to implement stateful checks.CooldownCheck
can be used to apply a cooldown to a command based on different criteria.InteractionCheck
andMessageCheck
can be used withCheck.any()
to allow slash commands or text commands to bypass other checks.Check.all()
can be used to group checks.
Bug fixes:
- Invalid cased command/group/argument names are now caught and a
CommandRegistrationError
is thrown. StringView.escape()
now correctly escapes fromstart
toend
and notstart
toindex
.
1.0.0 #
- Version 1 was skipped to keep version consistent with the other nyxx libraries.
0.4.0 #
Breaking changes:
- Exceptions have been reworked and are no longer named the same.
New features:
- Converters can now specify pre-defined choices for their type, this behavior can be overridden on a per-command basis with the
@Choices
decorator. - Command arguments can now have custom names with the
@Name
decorator.
0.3.0 #
New features:
- Checks now integrate with Discord's slash command permissions.
- Checks can now be asynchronous.
- Added
RoleCheck
,UserCheck
andGuildCheck
that represent the basic Discord slash command permissions: role restricted, user restricted and guild restricted (guild command). - Slash command arguments can have descriptions set with the
@Description
decorator.
Breaking changes:
- Checks are no longer a simple function.
0.2.0 #
Breaking changes:
- Reorder
description
andexecute
parameters inCommand.textOnly
andCommand.slashOnly
constructors. - Remove
syncDeleted
option fromBotOptions
as nyxx_interactions removes them on sync anyways.
New features:
- Add
send(MessageBuilder)
andrespond(MessageBuilder)
methods toContext
. - Add
children
as an optional argument toCommand
andGroup
constructor. - Add
autoAcknowledgeInteractions
option toBotOptions
to determine whether to automatically respond to interaction events. - Commands can now restrict execution using checks.
Bugfixes:
InteractionContext.respond
will no longer throw an error when responding immediately.- Slash Commands can no longer have direct slash command children.
- Errors emitted outside of argument parsing and callback execution are now correctly sent to
Bot.onCommandError
.
Miscellaneous:
- Text-only and slash-only commands can now have
Context
as their first argument type.
0.1.0 #
- Initial release.