Skip to content

Releases: sapphiredev/framework

v2.1.1

17 Oct 13:40
Compare
Choose a tag to compare

2.1.1 (2021-10-17)

Features

  • pieces: add options field to read raw options (#303) (9f45bc9)

Bug Fixes

  • allow more npm versions in engines field (ccecf4e)
  • register cooldown correctly (#304) (44bf46e)

v2.1.0

17 Oct 12:53
Compare
Choose a tag to compare

2.1.0 (2021-10-17)

Features

  • pieces: add options field to read raw options (#303) (9f45bc9)

Bug Fixes

  • allow more npm versions in engines field (ccecf4e)

Full Changelog: v2.0.0...v2.1.0

v2.0.0

16 Oct 16:19
Compare
Choose a tag to compare

What's Changed

2.0.0 (2021-10-16)

⚠ BREAKING CHANGES

  • For TypeScript users only, if you were previously using from or fromAsync and you expected the error result to be of type Error, it will now be unknown. You can reset this back to Error by providing it as the second generic type argument.
  • command: For TypeScript users please rename your Command#run methods to Command#messageRun
  • Awaited type has been renamed to Awaitable
  • Updated @sapphire/pieces to 3.0.0
  • Removed Command#categories, use CommandStore#categories instead
  • arguments: Changed the error message of DateArgument
  • arguments: Changed the error message of FloatArgument
  • arguments: Changed the error message of NumberArgument
  • arguments: Changed the error message of IntegerArgument
  • arguments: Changed the error message of all arguments that must be run in a guild
  • arguments: Changed the error message of GuildNewsThreadChannelArgument
  • arguments: Changed the error message of GuildPrivateThreadChannelArgument
  • arguments: Changed the error message of GuildPublicThreadChannelArgument
  • arguments: Changed the error message of GuildStageVoiceChannelArgument
  • arguments: Changed the error message of GuildTextChannelArgument
  • arguments: Changed the error message of GuildThreadChannelArgument
  • arguments: Changed the error message of GuildVoiceChannelArgument
  • arguments: Changed the error message of GuildMemberArgument
  • arguments: Changed the error message of UserArgument
  • arguments: Made MessageArgumentContext private
  • arguments: Stop exposing the channel property in context of the ChannelArgument error
  • arguments: Stop exposing the channel property in context of the GuildCategoryChannelArgument error
  • arguments: Stop exposing the channel property in context of the GuildNewsChannelArgument error
  • arguments: Stop exposing the channel property in context of the GuildPrivateThreadArgument error
  • arguments: Stop exposing the channel property in context of the GuildStageVoiceChannelArgument error
  • arguments: Stop exposing the channel property in context of the GuildTextChannelArgument error
  • arguments: Stop exposing the channel property in context of the GuildThreadChannelArgument error
  • arguments: Stop exposing the channel property in context of the GuildVoiceChannelArgument error
  • arguments: Rename Identifiers.ArgumentBoolean to Identifiers.ArgumentBooleanError
  • arguments: Rename Identifiers.ArgumentCategoryChannel to Identifiers.ArgumentGuildCategoryChannelError
  • arguments: Rename Identifiers.ArgumentChannel to Identifiers.ArgumentChannelError
  • arguments: Rename Identifiers.ArgumentDate to Identifiers.ArgumentDateError
  • arguments: Rename Identifiers.ArgumentDateTooSmall to Identifiers.ArgumentDateTooEarly
  • arguments: Rename Identifiers.ArgumentDateTooBig to Identifiers.ArgumentDateTooFar
  • arguments: Rename Identifiers.ArgumentDMChannel to Identifiers.ArgumentDMChannelError
  • arguments: Rename Identifiers.ArgumentFloat to Identifiers.ArgumentFloatError
  • arguments: Rename Identifiers.ArgumentFloatTooBig to Identifiers.ArgumentFloatTooLarge
  • arguments: Rename Identifiers.ArgumentGuildChannel to Identifiers.ArgumentGuildChannelError
  • arguments: Rename Identifiers.ArgumentGuildChannelMissingGuild to Identifiers.ArgumentGuildChannelMissingGuildError
  • arguments: Rename Identifiers.ArgumentHyperlink to Identifiers.ArgumentHyperlinkError
  • arguments: Rename Identifiers.ArgumentInteger to Identifiers.ArgumentIntegerError
  • arguments: Rename Identifiers.ArgumentIntegerTooBig to Identifiers.ArgumentIntegerTooLarge
  • arguments: Rename Identifiers.ArgumentMember to Identifiers.ArgumentMemberError
  • arguments: Rename Identifiers.ArgumentMessage to Identifiers.ArgumentMessageError
  • arguments: Rename Identifiers.ArgumentNewsChannel to Identifiers.ArgumentGuildNewsChannelError
  • arguments: Rename Identifiers.ArgumentNumber to Identifiers.ArgumentNumberError
  • arguments: Rename Identifiers.ArgumentNumberTooBig to Identifiers.ArgumentNumberTooLarge
  • arguments: Rename Identifiers.ArgumentRole to Identifiers.ArgumentRoleError
  • arguments: Rename Identifiers.ArgumentTextChannel to Identifiers.ArgumentGuildTextChannel
  • arguments: Rename Identifiers.ArgumentUser to Identifiers.ArgumentUserError
  • arguments: Rename Identifiers.ArgumentVoiceChannel to Identifiers.ArgumentGuildVoiceChannel
  • Identifiers.PreconditionPermissions has been renamed to Identifiers.PreconditionClientPermissions
  • UserError identifier preconditionPermissions has been renamed to preconditionClientPermissions
  • Permissions precondition has been renamed to ClientPermissions
  • PermissionsPrecondition class has been renamed to ClientPermissionsPrecondition
  • listener: Listeners will now be automatically unloaded if no emitter is found
  • Changed guildChannel argument to return GuildChannel | ThreadChannel.
  • Changed SapphireClient.id's type to Snowflake | null.
  • Changed SapphireClientOptions.id's type to Snowflake | null.
  • Removed Events.GuildMemberSpeaking.
  • Removed StoreRegistry, it is now re-exported from @sapphire/pieces.
  • Renamed ArgType.categoryChannel to guildCategoryChannel.
  • Renamed ArgType.newsChannel to guildNewsChannel.
  • Renamed ArgType.textChannel to guildTextChannel.
  • Renamed ArgType.voiceChannel to guildVoiceChannel.
  • Renamed CommandPreConditions.NewsOnly to GuildNewsOnly.
  • Renamed CommandPreConditions.TextOnly to GuildTextOnly.
  • Renamed Identifiers.PreconditionNewsOnly to PreconditionGuildNewsOnly.
  • Renamed Identifiers.PreconditionTextOnly to PreconditionGuildTextOnly.
  • Renamed Preconditions.NewsOnly to GuildNewsOnly.
  • Renamed Preconditions.TextOnly to GuildTextOnly.
  • Renamed the possible values for CommandOptionsRunType.
  • Updated CooldownContext.delay to not be optional.
  • Updated discord.js requirement to v13.
  • Changed Command#preconditions to PreconditionContainerArray.
  • Removed Command#resolveConstructorPreConditions.
  • Renamed CommandOptions.cooldownBucket to cooldownLimit.
  • Renamed CommandOptions.cooldownDuration to cooldownDelay.
  • Renamed BucketType to BucketScope.
  • Changed PreconditionSingleResolvableDetails to take a type parameter.
  • Changed PreconditionSingleResolvable to use Preconditions's type.
  • Renamed CooldownContext.bucketType to scope.
  • Renamed Event to Listener
  • Renamed EventStore to ListenerStore
  • Changed events directory from events to listeners
  • Renamed SapphireClientOptions.loadDefaultErrorEvents to loadDefaultErrorListeners
  • Renamed StoreRegistryEntries.events to StoreRegistryEntries.listeners
  • Refactored Events enum to be an object, so we can use discord.js's constants
  • Renamed Events.EventError to Events.ListenerError
  • Renamed EventErrorPayload to ListenerErrorPayload
  • Renamed Events.Ready to Events.ClientReady
  • Renamed Events.Message to Events.MessageCreate
  • Flattened CommandOptions.strategyOptions into CommandOptions
  • Changed CommandOptions.preconditions to always require an array
  • Updated @sapphire/pieces to 2.0.0
  • Renamed PieceContextExtras to Container, usage and augmentation is the same.
  • Removed Store.injectedContext, use globally exported container
    variable instead.
  • Renamed Store#context to Store#container.
  • Renamed Piece#context to Piece#container.

Features

  • add Result#from and Result#fromAsync (#267) (300f2ed)
  • Add typing property to fire TextChannel.sendTyping() when a command is accepted (#258) (71c1883)
  • add managed role mention prefix support (#289) (7846d6c)
  • add partial dm channel argument (#288) (c8c74de)
  • add UserPermissions precondition (#252) (2bb2e12)
  • added auto-preconditions (#199) (7e79e15)
  • arguments: extract logic to resolvers (#237) (32d591b)
  • client: added option to set a default cooldown for all commands (#294) (7734d59)
  • command: add command#messageRun method and deprecation warning for command#run (#299) (750c25c)
  • command: add Command...
Read more

v1.0.2

02 May 18:20
Compare
Choose a tag to compare

1.0.2 (2021-05-02)

Bug Fixes

  • drop the www. from the SapphireJS URL (e9ed4e8)
  • update all the SapphireJS URLs from .com to .dev (4d0c8ea)

v1.0.1

21 Apr 13:29
Compare
Choose a tag to compare

1.0.1 (2021-04-21)

Bug Fixes

  • dependencies: update in semver scope dependencies (ca9a2c1)
  • change all Sapphire URLs from "project"->"community" & use our domain where applicable 👨‍🌾🚜 (#192) (650260e)

v1.0.0

16 Mar 20:56
Compare
Choose a tag to compare

1.0.0 (2021-03-16)

Features

Bug Fixes

v1.0.0-alpha.11

16 Feb 09:49
Compare
Choose a tag to compare
v1.0.0-alpha.11 Pre-release
Pre-release

1.0.0-alpha.11 (2021-02-16)

Features

  • structures: add global preconditions (#176) (e8ef41f)

Bug Fixes

  • enabled: remove last remnant of essentials (4928823)

v1.0.0-alpha.10

12 Feb 09:56
Compare
Choose a tag to compare
v1.0.0-alpha.10 Pre-release
Pre-release

1.0.0-alpha.10 (2021-02-12)

⚠ BREAKING CHANGES

  • command-accepted: Events.CommandRun third argument changed type to CommandRunPayload,
    this is mostly identical to CommandAcceptedPayload (and exactly identical to CommandFinishPayload)
    and likely won't be a breaking change for your code, however you may need to adjust
    your import when using TypeScript.
  • command-accepted: Events.CommandFinish third argument changed type to CommandFinishPayload,
    this is mostly identical to CommandAcceptedPayload (and exactly identical to CommandRunPayload)
    and likely won't be a breaking change for your code, however you may need to adjust
    your import when using TypeScript.

Features

  • args: add name to context of Args.unavailableArgument (#171) (a5bda61)
  • args: add more data to error context for core arguments (0cfff79)
  • args: pass more context to args errors (#174) (007eaed)
  • argumenterror: add type default of unknown (55be30a)
  • command-accepted: add received args to event payloads (#173) (fa60b13)
  • message-parser: add caseInsensitivePrefixes client option (#170) (61f9c41)

v1.0.0-alpha.9

07 Feb 15:27
Compare
Choose a tag to compare
v1.0.0-alpha.9 Pre-release
Pre-release

⚠ BREAKING CHANGES

  • preconditions: Changed PreconditionContext.command to external

Features

  • events: added UnknownCommandPayload.commandName (#166) (3dbcffd)

  • preconditions: make IPreconditionContainer#run's context optional (#167) (57ad8d2)

v1.0.0-alpha.8

07 Feb 13:44
Compare
Choose a tag to compare
v1.0.0-alpha.8 Pre-release
Pre-release

1.0.0-alpha.8 (2021-02-07)

⚠ BREAKING CHANGES

  • events: Changed Events.UnknownCommandName event arguments to UnknownCommandNamePayload.
  • events: Changed Events.UnknownCommand event arguments to UnknownCommandPayload.
  • events: CoreMessageParser is not longer a message event listener

Features

  • events: create Events.PreMessageParsed (#164) (0311838)

  • events: remove UnknownCommandName, changed UnknownCommand (#165) (c3273d1)