Skip to content

Latest commit

 

History

History
1125 lines (733 loc) · 35.3 KB

CHANGELOG.md

File metadata and controls

1125 lines (733 loc) · 35.3 KB
Raw

0.8.0-M5

Breaking

  • slash commands and interactions have been redesigned to support the new command and interaction types.

Changes

  • Move SlashCommands functions to Kord. (#366)
  • ApplicationCommands are now cached. (#366)
  • Interaction events are split up into distinct events. (#366)
  • Proper hierarchy for applications commands, interactions and their events. (#366)
  • Rename UsePrivate/PublicThreads to CreatePrivate/PublicThreads. (#366)
  • Include json error in exception message. (#369)

Additions

  • Experimental Voice support. #(363)
  • Context support. (#366)
  • Add ResolvedObjects#messages to resolve messages. (#366)
  • Add ChannelBehavior#of/OrNull to safely get a typed channel. (#366)
  • Add type safe arguments for chat input commands. (#366)
  • Add SendMessagesInThread Permission. (#366)

Fixes

  • Ephemeral followups not being passed the ephemeral flags. (#368)
  • Missing optional default values in some data types. (#362)
  • incorrect serialization of CommandArguement. (#362)

0.8.0-M4

Fixes

  • Fixed the space in active threads get endpoint causing it to fail. (5dd3f380)
  • Fixed incorrect serialization of NUMBER option. (#360)
  • Fixed Missing properties in MemberData, InteractionData and others. (#361)

Changes

  • Region no longer has a vip property (5dd3f380)

0.8.0-M3

Fixes

  • Fixed Typo in ephemeral acks body causing acking to fail.

0.8.0-M2

Fixes

  • interaction acknowledgements no longer require data
  • Add SerialName for InteractionApplicationCommandCallbackData#allowedMentions

0.8.0-M1

Additions

  • Added support for threads. (#349 #358 #353 d1bf947)
  • Added missing JSON error codes. (#347)
  • Added support for slash command number type arguments. (#351)
  • Added support for user banners. (#352)
  • Added missing guild features. (d1bf947)

Changes

  • The Channel hierarchy has been changed to support threads. Some behavior in GuildChannel(Behavior) and GuildMessageChannel(Behavior) has been removed to accommodate ThreadChannels and moved to TopGuildChannel(Behavior) and TopGuildMessageChannel(Behavior) respectively. (#353)

Fixes

  • Fixed missing audit log reasons on certain endpoints. (#346)

0.7.4

Changes

  • Promote user property in component interaction to a data object.

Fixes

  • Fixed ComponentInteraction#user throwing a NullPointerException when the interaction was created in a direct message.

0.7.3

Additions

  • Add StoreEntitySupplier.
  • Add caching rest strategy.
  • Add cache-rest caching strategy.
  • Add select menus.

Fixes

  • Fix average ping conversion in MasterGateway.

Changes

  • Make UpdateMessageInteractionResponseCreateBuilder fields nullable.
  • type in option builders is now private

Breaking

  • DiscordComponent
  • InteractionCallbackData
  • ApplicationInteractionData
  • ComponentData
  • CommandInteraction
  • OptionsBuilder
  • UpdateMessageInteractionResponseCreateBuilder

0.7.2

Additions

  • Allow adding a mentionable argument to commands

Changes

  • Make Intent#values a getter function.

Fixes

  • Mentionable arguments now correctly retrieve their entity.
  • Intent.values emitting null when filtering.

0.7.1

Breaking

  • BaseInteractionResponseBuilder
  • BaseInteractionResponseBuilder
  • BaseInteractionResponseModifyBuilder
  • EphemeralInteractionResponseModifyBuilder
  • PublicInteractionResponseModifyBuilder
  • MessageModifyBuilder
  • EditWebhookMessageBuilder
  • InteractionResponseModifyRequest
  • FollowupMessageBuilder
  • PublicFollowupMessageModifyBuilder
  • EphemeralFollowupMessageModifyBuilder
  • PublicFollowupMessageCreateBuilder
  • EphemeralFollowupMessageCreateBuilder
  • FollowupMessageModifyRequest
  • ComponentInteraction

Changes

  • Message-related builders have been changed to accept null (for non-collections) and "empty list" (for collections) when editing a message. This makes it possible to remove fields from a message without providing a substitution.
  • FollowupMessageBuilder no longer has the tts field, since it does not apply to all its subclasses.

Fixes

  • ActionRowComponent properly returns its children.
  • ComponentInteraction#button is now nullable as its documentation implies.

0.7.0

Additions

  • Implement voice stage channel (#239)
  • Add "Competing" activity type (#272)
  • Add unsafe application commands behavior (#281)
  • Add buttons to Activity (#287)
  • Add Message.applicationId (#289)
  • Implement Stage instances (#291)
  • Add Message interaction (#283)
  • Add Ephemeral embed support (#296 #321)

Changes

  • Update deprecated message (#280)
  • Sealed message types (#282)
  • Improve slash command API and add support for components (#310 #294 #312 #324)
  • Live entities can define a parent job (#304)

Fixes

  • Close InputStreams used for attachments (#309 #296)
  • Make Updatestatus activities not-null (#274)
  • Fix GuildUpdate core handling (#284)

Performance

  • Fix memory issues related to Permission combining (#277)

Dependencies

  • kotlin 1.4.32 -> 1.5.10
  • kotlinxSerialization 1.1.0 -> 1.2.1
  • ktor 1.5.2 -> 1.6.0
  • kotlinxCoroutines = 1.4.2 -> 1.5.0
  • kotlinLogging 2.0.4 -> 2.0.6
  • atomicFu 0.15.1 -> 0.16.1
  • binaryCompatibilityValidator 0.4.0 -> 0.5.0
  • datetime 0.2.1

0.7.0-RC3

Fixes

  • Unhandled missing access when trying to get vanity url with the feature disabled. #264

0.7.0-RC2

Additions

  • Added slash commands support. #145 #201 #253 #249
  • Added core representation of templates #136
  • Added overloaded operations for Intents and Permissions. #152 #203
  • Added welcome screens. #141
  • Added Kord#getInvite. #143
  • Added pending property to member. #153
  • Added Kord functions to get webhooks. #232
  • Added ability to send a message through request. #184
  • Added extension methods for LiveEntity. #177
  • Added USE_SLASH_COMMANDS permission. #208
  • Added Permission#values and Permissions#values. #255
  • Added allowed mentions. #256
  • Added new webhook endpoints. #217
  • Added missing error codes. #250
  • Added Message#messageReference. #245

Fixes

  • Fix GuildBehavior#getWidgetOrNull #138
  • Fix nullity in builders. #135
  • Fix channelId nullity in UpdateVoiceState. #144
  • Fix provider nullity in embeds. #151
  • Fix WebhookType.Incoming incorrect value. #156
  • Fix DiscordErrorResponse inability to consume full input #162
  • Fix MessageCreateEvent#withStrategy returning Strategizable. #233
  • Fix serialization issues for DiscordActivityPartySize. #168
  • Fix Attachment#isImage check. #172
  • Fixrpc_origins being nullable instead of optional. #173
  • Fix LiveMessage not being shut down on bulk delete. #174
  • Fix Message#authorAsMember throwing if guild was not found. #178
  • Fix swapped mute and deaf in VoiceStateData. #188
  • Fix preview_asset not being optional. #206.
  • Fix parsing raw responses into Json. #205
  • Fix typos in webhook and welcome screen routes. #219 #220
  • Fix gateway 0 blocking other shard gateways from running. #194
  • Fix unhandled unknown channel types. #251

Changes

  • Allow controlling the number of total shards #196
  • Replaced invoke functions with top-level factory functions. #210
  • Allow multiple file upload. #247 #228 #229
  • Added missing contracts #243

Dependencies

  • kotlin 1.4.10 -> 1.4.32 #198
  • kotlinx.serialization 1.0.0 -> 1.1.0 #198
  • kotlinx.coroutines 1.4.0 -> 1.4.2 #198
  • kotlinx.atomicfu 0.14.4 -> 0.15.1 #198
  • kotlinx.binary-compatibility-validator 0.2.3 -> 0.4.0 #198
  • ktor 1.4.1 -> 1.5.2 #198
  • kotlin-logging 2.0.3 -> 2.0.4 #198

0.7.0-RC

Additions

  • Added support for MessageSticker. #119
  • Added support for RoleTags. #119
  • Added GuildBehavior#getMembers. #119
  • Added the ability to move a channel under a category when moving channels. #119

Fixes

  • Fixed MemberBehavior#edit, now returning a member. #120
  • Gateway#on now allows suspending consumers.
  • Fixed GuildBehavior#editSelfNickname incorrectly parsing the response json. #125
  • Fixed getting user's avatar url. #128

Changes

  • VoiceServerUpdateEvent#endpoint is now nullable. #119
  • Moved com.gitlab.kord.common to dev.kord.common. #122
  • Moved com.gitlab.kord.rest to dev.kord.rest. #122
  • Moved com.gitlab.kord.gateway to dev.kord.gateway. #122
  • Moved com.gitlab.kord.core to dev.kord.core. #122

Removals

  • Removed deprecated API from 0.6.x.

0.7.0-M2

Additions

  • Re-added values in Intent and Intents.
  • Added support for inline replies and MessageBehavior#reply to quickly create a reply to a message. #110
  • Added a shortcut to create channels from a CategoryBehavior, giving them a parentId by default. #109
  • Added Gateway#requestMembers and GuildBehavior#RequestMembers as a shortcut for the RequestGuildMembers command.

Fixes

  • Fixed Color bug when converting from java.awt.Color with alpha. #114

Changes

  • Gateway reconnect retries reset on handshake. #68

0.7.0-M1

Changes

  • Updated API to Discord V8. #108
  • Introduced Optionals in lower level API and core xData classes. #108 #95
  • De-inlined Snowflake and implemented it into the lower level API. #108
  • Rewrote AuditLog and its child classes and introduced them to to core. #108
  • Kord#events is now a SharedFlow which can be configured via KordBuilder#eventFlow. #102
  • Image now supports image sizes that are common for Discord image resources. #98
  • java.awt.Color has been replaced with com.gitlab.kordlib.common.Color. #5
  • core Entities should have a meaningful toString representation. #88
  • Request builders no longer have lateinit fields, these are now required arguments in the builder DSLs. #108
  • Permissions and Intents now have more and easier constructors. #103

Additions

  • RestRequestException now holds a reference to an (optional) DiscordErrorResponse with a more specific error message and code.
  • PremiumTier now has a maxEmotes field. #74
  • Added a getDmChannelOrNull to UserBehavior to safely try and open a DmChannel with a user. #111

Fixes

  • GuildBehavior#getVanityUrl will now correctly return null when the guild does not have a vanity url.
  • Voice channels can now change their topic.
  • Fixed CacheEntitySupplier not returning certain cached entities.

Dependencies

  • Kotlin 1.4.0 -> 1.4.10
  • ktor 1.4.0 -> 1.4.1
  • kotlinx.serialization 1.0.0-RC -> 1.0.0
  • kotlinx.coroutines 1.3.9 -> 1.4.0
  • kotlinLogging 1.7.10 -> 2.0.3

0.6.10

Fixes

  • Fixed Guild#getVanityUrl throwing an exception when a guild did not support vanity invites. #104
  • Fixed Embed#fields always returning empty. #105

0.6.9

Fixes

  • Fixed Rolebehavior#mention for everyone roles. #96
  • Fixed NPE being thrown when trying to query data types that were not cached.
  • Fixed message content not being sent when uploading a file. #99

0.6.8

Fixes

  • Fixed rest action reasons not encoding properly. #86

0.6.7

Fixes

  • Fixed removed channels not being removed from cache. #84

0.6.6

Fixes

  • Fixed an issue where Members would not consider Users with the same ID equal.
  • Removed a dependency on Java 10 introduced in 0.6.5. #78
  • Fixed the event flow dropping events under too much pressure. #81
  • Fixed the KordCacheBuilder ignoring configuration #82

0.6.5

Fixes

  • Fixed an issue where LiveMessage would not filter its event flow. #70
  • Fixed an issue where emojis from events would be decoded incorrectly.

0.6.4

Additions

  • Added a MemberBehavior#addRole and MemberBehavior#removeRole variant which accepts an audit log message.

0.6.3

Fixes

  • Fixed GuildMessageChannelBehavior#bulkdelete incorrectly deleting messages older than 14 days

0.6.2

Additions

  • Added a new Field builder function. #57
  • Added Kord#getChannelOf to request a type of channel.

Changes

  • name and value default to empty space.
  • PRESENCES_REPLACE event will be ignored. #42

0.6.1

Additions

  • Added Team and other properties to ApplicationInfo.

Changes

  • ReactionEmoji.Unicode now correctly compares on name for equality.

Performance

  • CacheEntitySupplier#getGuildMembers will no longer query MemberData on each user.
  • Reduced the number of mappings inside suppliers.

Fixes

  • Fixed type mismatch when comparing guildId in CacheEntitySupplier#getGuildMembers

0.6.0

Changes

  • Member#kick and Guild#kick now have an optional reason.
  • KordBuilder now throws a (more) useful exception when building a bot with an invalid token.
  • The REST module will now use discord.com/api instead of the deprecated discordapp.com/api.
  • Kord now uses Dispatchers.default as the default dispatcher.

Fixes

  • Fixed an issue where Invite events would not fire if the invited user didn't have an avatar.
  • Fixed some outdated docs on the KordBuilder.
  • Fixed an issue where voice states from guild creates were not getting cached.

Additions

  • Introduced an experimental REST-only variant of the Kord builder. This will automatically disable gateway and cache related APIs and replace them with a no-op implementation.
  • Introduced a no-op Gateway implementation.

Performance

  • Removed an unneeded REST call when building Kord.

Dependencies

  • kotlin 1.3.72 -> 1.4.0
  • ktor 1.3.2 -> 1.4.0
  • kotlinx.serialization 0.2.0 -> 1.0.0-RC
  • kotlinx.coroutines 1.3.7 -> 1.3.9

0.5.11

Fixes

  • Fixed an issue where multiple voice states could be present per user per guild.
  • Fixed an issue where presences would be incorrectly deserialized in guild member chunk events.
  • Fixes member chunk events not caching presences.

0.5.10

Fixes

  • Fixed an issue with entity flows requested from REST duplicating entities.

0.5.9

Fixes

  • Fixed an issue where getting a channel from a guild would incorrectly throw an exception during the guild id check. (again)

0.5.8

Fixes

  • Fixed an issue where getting a channel from a guild would incorrectly throw an exception during the guild id check.

0.5.7

Additions

  • Added BanAddEvent#getBan to get the full ban object.
  • Re-added MessageCreateBuilder#allowedMentions after removal in 0.5.0.

0.5.6

Fixes

  • Fixed incorrect calculations of denied Permissions.

0.5.5

Additions

  • Added MessageBehavior#publish to publish a message in an announcement channel.
  • Added NewsChannelBehavior#follow to follow an announcement channel in another text channel.

Fixes

  • Fixed GuildChannel#getEffectivePermissions not correctly denying permissions denied for the user specifically.

0.5.4

Additions

  • Added GuildBehavior#getChannel, GuildBehavior#getChannelOf and their nullable variants.

Deprecations

  • GuildBehavior#unBan has been deprecated for GuildBehavior#unban.

0.5.3

Fixes

  • getGuildMembers returns the correct limit for both Cache and Rest suppliers.

0.5.2

Additions

  • Add missing mention property for unicode emojis.
  • Re-add guildId to Invite for compatibility.

0.5.1

Additions

  • Added PartialGuild in Invite
  • Added GuildBehavior.createEmoji
  • Added GuildEmoji.delete and GuildEmoji.edit

Fixes

  • DiscordInvite#targetUser is now correctly nullable.
  • PermissionOverwriteEntity#getGuildOrNull uses the correct supplier method.

Changes

  • Invite now uses a Channel instead of GuildChannel.

0.5.0

Additions

  • mention properties for GuildEmoji and ReactionEmoji

0.5.0-rc2

Additions

  • Added Gateway Intents, allowing users to filter events send by Discord. #60
  • Added VIEW_GUILD_INSIGHTS permission #88
  • Added MessageCreateEvent#guildId to replace the removed Message#guildId.
  • Added MessageCreateEvent#member.

Removals

  • Removed deprecated API from 0.4.x

Dependencies

  • kotlin 1.3.70 -> 1.3.72
  • ktor 1.3.1 -> 1.3.2
  • kotlinx.coroutines 1.3.4 -> 1.3.7
  • kotlin-logging 1.7.8 -> 1.7.10

0.5.0-rc1

Performance

  • Getting entities from a flow of non-cached entities should be considerably faster.

Fixes

  • non-final socket closures use 4900 instead of 1000.

Additions

  • Added the EntitySupplyStrategy, entities will now keep a reference to a EntitySupplier (fetched from the strategy) from which they'll be able to fetch other entities (getX methods). #74
  • Added withStrategy(EntitySupplyStrategy) to change the EntitySupplier of most entities. #74
  • Added a CacheEntitySupplier and RestEntitySupplier supplier that exclusively operates on Cache and REST respectively, as well as a strategy that prioritizes Cache over REST like previous versions. #74
  • Added getXOrNull variants to fetching entities that won't explode when trying to get an entity that doesn't exist. #74

Changes

  • Changed GuildCreateBuilder to be more inline with recent api changes. #77
  • core Event constructors are no longer internal.
  • Kord#gateway is now a MasterGateway, exposing all sharded gateways #65
  • core Events now expose their shard index as well as the Gateway they were spawned from. #65
  • DisconnectEvent and Close have been extended with more detailed implementations #65
  • Gateway now accepts a PresenceBuilder to configure its original presence. #72
  • Rest Discord API version can now be configured by setting the com.gitlab.kordlib.rest.version system property, v6 by default.
  • DefaultGateway now supports zlib compression and enables it by default.

0.4.22

This release contains breaking changes related to webhooks.

Additions

  • Added WebhookBehavior#executeIgnored which does not wait for the message to be processed.

Changes

  • WebhookBehavior#execute will now return a Message.

Fixes

  • Fixed an issue when deserializing a Webhook would throw an exception.
  • Fixed an issue where endpoints returning nullable types would throw an exception.

0.4.21

Fixes

  • Fixed cache not removing messages deleted from a MessageDeleteBulk.

0.4.20

Additions

  • Added error codes 10026(Unknown ban), 40002(You need to verify your account in order to perform this action) and 30015(Maximum number of attachments in a message reached (10)) to the JsonErrorCode.
  • Added approximate_member_count approximate_presence_count to guilds, which will be present when requesting a guild through rest.
  • Added missing DmChannel#recipientBehaviors.
  • Added missing MessageUpdateEvent#message, MessageUpdateEvent#channel, MessageUpdateEvent#getMessage, MessageUpdateEvent#getChannel.
  • Added missing PresenceUpdateEvent#member, PresenceUpdateEvent#guild, PresenceUpdateEvent#getUser, PresenceUpdateEvent#getMember, PresenceUpdateEvent#member, PresenceUpdateEvent#getGuild.
  • Added chunk_index and chunck_count properties to GuildMembersChunkData.
  • Added Invite#targetUserType.
  • Added User#flag.
  • Added GuildFeature.WelcomeScreenEnabled.
  • Added MessageModifyBuilder#allowedMentions.
  • Embeds can now copy their contents over to builders by using Embed#apply(EmbedBuilder).
  • Added User#premiumType.
  • Added GuildPreview and the ability to get previews for public guilds via Kord#getGuildPreview.

Fixes

  • Fixed MessageModifyBuilder ignoring flags.

0.4.19

Fixes

  • Fixed an issue where ClientStatus would only display the desktop status.

0.4.18

Fixes

  • Fixed an issue where presences from guild creates were cached without guild id.

0.4.17

Fixes

  • Fixed REST throwing an exception when parsing an error without code.

0.4.16

Changes

  • Behaviors have been removed from VoiceState due to lack of guildId.

Fixes

  • Unmatched data structure between VoiceState and its data.
  • ISO_INSTANT not being used to format and Instant object.

0.4.15

Changes

  • Classes implementing Entity now correctly implement equals and hashcode based on ids.

0.4.14

Fixes

  • Fix GuildMessageChannelBehavior#bulkDelete manually deleting messages younger than 14 days and trying to bulk delete messages older than 14 days, instead of the other way around.

0.4.13

Fixes

  • Fix guild emojis not having their correct id.

0.4.12

Fixes

  • Fix unexpected data fields throwing exceptions when parsing Gateway Events. This should now be limited to unknown opcodes only.

0.4.11

Fixes

  • ParallelRequestRateLimiter will no longer try to unlock a mutex twice on a error response

0.4.10

Fixes

  • DiscordErrorResponse incorrect serialization

0.4.9

ID collections in modify builders have undergone a breaking critical bug fix.

Additions

  • Added JsonErrorCode and DiscordErrorResponse to map Discord's Json error messages.

Changes

  • Added error field to KtorRequestException to include DiscordErrorResponse

Fixes

  • Fixed permissionOverwrites in TextChannelModifyBuilder, VoiceChannelModifyBuilder, NewsChannelModifyBuilder being final.
  • Fixed roles in EmojiModifyBuilder and MemberModifyBuilder being final.

0.4.8

Additions

  • Added Integrations.
  • Guilds can now request their own Integrations with GuildBhehavior#integrations.
  • Added preferredLocale and publicUpdatesChannelId to Guild and GuildModifyBuilder.
  • Added some utility functions to the KordCacheBuilder.
  • Added GuildDiscoveryDisqualified and GuildDiscoveryRequalified to MessageType. #79

Changes

  • KtorRequestHandler will now log the body of requests and responses.

Fixes

  • The GuildService now returns the correct type of integration objects.
  • Fixed a typo in the Embed#type property kdocs.
  • Fixed an issue where paginated flows would emit duplicate items.

Deprecations

  • Embed#type has been deprecated. #80
  • LiveNewsChannel, LiveStoreChannel and LiveTextChannel have been deprecated. Message channels in guilds can change type during their lifetime, which means type can't be guaranteed. LiveGuildMessageChannel has been introduced as an alternative.

0.4.7

Fixes

  • Fixed an issue where editing a guild category would reset permissions.
  • Fixed an issue where editing a guild emoji would reset permissions.
  • Fixed an issue where editing a guild member would reset permissions.

Removals

  • Removed some Kord functions that fetched non 'top-level' entities. Kord is no longer the central source for getting entities and these changes try to reflect that. #74 You should use the new entity suppliers for those instead. #74
  • KordCache has been removed, Kord now keeps a reference to a generic cache instead. You can still get similar behavior using kord.with(EntitySupplyStrategy.cache). #74

0.4.6

Additions

  • Added Guild#memberCount.
  • Added GuildEmoji#isAvaiable. #84
  • Added allowed mentions to message create. #83

Changes

  • MessageChannel#withTyping should now properly stop when cancelling the coroutine context

Fixes

  • Fixed channels cached in guild create events not having a guild id.
  • Fixed DiscordCreatedInvite#maxUses serialization typo.
  • Fixed an issue where editing a guild channel would reset permissions.

0.4.5

Additions

  • Added Member#roleBehaviors
  • You can now add or remove entire Permissions to/from the PermissionsBuilder
  • Added Member#isOwner
  • Added Member#getPermissions
  • Added Message.isPinned
  • Added GuildChannel#getEffectivePermissions

Changes

  • Message#guildId and Message#guild are deprecated due to inconsistent availability.
  • removed ReactionEmoji.id due to compiler issues regarding nullable inline classes, check for Custom type instead.

Fixes

  • Guild emojis update correctly on GuildEmojisUpdate event.
  • Ratelimiters should no longer lock up when throwing an exception during requests.

0.4.4

Additions

  • Added MessageBehavior#withTyping.

Changes

  • usage of kotlinx.io.inputstream has been replaced with java.io.inputstream following the internalization of the typealias.

Dependencies

  • kotlin 1.3.61 -> 1.3.70
  • kotlinx.serialization 0.14.0 -> 0.20.0
  • kotlinx.coroutines 1.3.3 -> 1.3.4

0.4.3

Additions

  • Added Guild#roleBehaviors.

Fixes

  • Fix incorrect deserialization of mentioned roles in messages.
  • Message updates now correctly update mentioned channels.

0.4.2

Additions

  • Added GuildBehavior.getRole.
  • Added missing Guild.channelIds and Guild.channelBehaviors.

0.4.1

Additions

  • Added a CategoryCreateBuilder to GuildBehavior. #67

Fixes

  • Removed url from EmbedFooterRequest, as it's not an actual field in the Discord API. #66

0.4.0

Additions

  • Kord and itsCache now implement a common interface EntitySupplier to retrieve entities that can be cached. #54
  • mentionedRoleIds, mentionedRoleBehaviors, mentionedUserIds, mentionedUserBehaviors were added to Message.
  • Introduced two implementations for the RequestRateLimiter: ExclusionRequestRateLimiter and ParallelRequestRateLimiter, which will be replacing the ExclusionRequestHandler and ParallelRequestHandler respectively. #59

Changes

  • All fields but name are now optional in GuildCreateBuilder and GuildCreateRequest. #62
  • Removed the ExclusionRequestHandler and ParallelRequestHandler and introduced the KtorRequestHandler, which accepts any RequestRateLimiter. #59
  • Message#mentionedRoles and Message#mentionedUsers now return a Flow of their respective entities instead of a Set<Snwoflake>.
  • StoreChannel#edit, TextChannel#edit and NewsChannel#edit now supply their builder as a receiver.
  • core entity builders were moved from com.gitlab.kordlib.core.builder to com.gitlab.kordlib.rest.builder and are now part of the rest module.
  • Snowflake was moved to the common module from core. #53
  • Kord#getRegions() was deprecated for Kord#regions.
  • Kord#getUsers() was deprecated for cache#users.
  • various Snowflake argument names have been changed inKord to better reflect the entity they represent.
  • A reified getChannel has been added to EntitySupplier that will try to cast the channel to the given type.
  • CategoryModifyBuilder#permissions is now a val.
  • ChannelPermissionModifyBuilder is now a proper AuditRequestBuilder.

Fixes

  • fixed typo CategoryModifyBuilder#positon -> CategoryModifyBuilder#position

0.3.3

Fixes

  • Fixed guild-id being wrongly deserialized as guildId in DiscordAddedGuildMember.

  • Fixed an issue where disconnecting from the DefaultGateway without closing the connection (i.e. dropping your internet connection) would indefinitely suspend the DefaultGateway, making it unusable.

0.3.2

Additions

  • Added InviteCreate, InviteDelete an MessageReactionRemoveEmoji events. #61
  • Added deleteAllReactionsForEmoji to ChannelService. #61

Fixes

  • Fixed an issue where DiscordInvite was wrongly representing inviter as a String instead of a DiscordUser.

Dependencies

  • ktor 1.3.0-rc2 -> 1.3.0

0.3.1

Fixes

  • Fixed an issue with Kord ignoring cached entries that relied on querying data by id. again.

0.3.0

This version contains an upgrade of ktor that brings breaking changes, be sure to check out ktor's changelog if you were interacting with ktor or the rest module directly.

This change also comes with the removal of kotlinx.io, which was a transitive dependency. If your code relied on kotlinx.io consider manually including the dependency or migrating away from it entirely.

Changes

  • Kord#getGuilds() has been replaced with the non-suspending Kord#guilds.
  • @KordBuilder has been renamed to @KordDsl.
  • KordClientBuilder has been renamed to KordBuilder.
  • fileName has been renamed to filename.
  • DefaultGateway's constructor accepts a single DefaultGatewayData instead of multiple properties.
  • DefaultGateway is now able to rate limit identify attempts and accepts a RateLimiter that can be shared between multiple gateways. This will be done by default for Kord clients now.
  • KordClientBuilder's gateway function has been renamed to gateways. It now gives a list of shards and requests a list of gateways, this change allows you to more easily share configuration between gateways.
  • Emojis now have nullable names, this only appears when interacting with guild emojis that have been deleted.
  • Rest, Gateway and Common entities have gained a Discord prefix to reduce name collisions with Core.
  • ParallalRequestHandler has been upgraded to stable.
  • features in Guilds are now represented as enum values instead of Strings.

Additions

  • Added LiveEntity and its implementations to Core. These are self-updating entities that contain a filtered event stream, only emitting related events.
  • Added targetUser and targetUserType to invite creation. #47
  • Added a rules channel, SystemChannelFlags and discoverySplash to Guild. #48
  • Added premium since to Member. #45
  • Added inviter to Invite. #44

Fixes

  • Ending the process while enabling the shutdownHook and without logging in causes UninitializedPropertyAccessException #50

Dependencies

  • gradle 5.4 -> 6.0.1
  • kotlin -> 1.3.60 -> 1.3.61
  • kotlinx.serialization 0.13.0 -> 0.14.0
  • ktor 1.2.5 -> 1.3.0-rc2
  • kotlinx.coroutines 1.3.2 -> 1.3.3
  • kotlin-logging 1.7.6 -> 1.7.8

0.2.4

Additions

  • uses has been added as a nullable property to InviteResponse .
  • Added mentionedChannel-related fields to Message.
  • Added KordClientBuilder#enableShutdownHook, which enables a shutdownHook that automatically closes the gateway on process exit.

Changes

  • User.Avatar#getUrl no longer returns null when requesting a static version of a user's animated avatar.

Fixes

  • Fixed an issue where PartialEmoji would not deserialize with a missing id.
  • Fixed an issue where subscribing to the events Flow while kord was already logged in caused it to emit old events.
  • Fixed an issue where DefaultGateway would stop reading payloads after throwing an Exception while parsing json.

0.2.3

Additions

Enums now have an Unknown value to mitigate the effects of unannounced discord changes moving forward. #39

  • nicknameMention has been added to MemberBehavior

Changes

  • Flow extension now support suspending functions

Fixes

  • MessageCreateBuilder#addFile no longer ignores files added.
  • GuildMembersChunkData#presences has become nullable.
  • RequestGuildMembers#query is no longer nullable.
  • Fixed an issue with Kord ignoring cached entries that relied on querying data by id.
  • User#discriminator and User#tag will now properly format discriminators with leading spaces.

Dependencies

  • kotlin-logging: 1.7.6
  • kotlinx.coroutines: 1.3.2
  • kotlinx.serialization 0.13.0
  • ktor 1.2.5

0.2.2

Additions

A new RequestHandler, the ParallalRequestHandler has been introduced as a preview feature. Compared to the ExclusionRequestHandler, this handler offers increased parallelism by allowing requests with different identifiers to be handled in parallel. The drawback is that this opens a small window for exceeding the global rate limit.

Gateway now has a ping field, containing the duration between the latest heartbeat and heartbeat ack. GuildModifyRequest now has an optional banner field, which can contain a base64 16:9 png/jpeg image for the guild banner (when the server has BANNER feature). Added presences and userIds to the RequestGuildMembers class and the equivalents to GuildMembersChunkData.

Removals

Invite#revoked has been removed since it never existed.

Fixes

filename is now correctly deserialized for Attachment objects.

0.2.2

Additions

Gateway now has a ping field, containing the duration between the latest heartbeat and heartbeat ack.

0.2.1

This is the first maintenance update for Kord 0.2. With it, we have started hosting Kord on bintray, check our README on what to include to get the newest version.

Additions

  • Added Flow<T: Any>.firstOrNull and Flow<T: Any>.any as their behavior is often needed when interacting with flows of members, channels, etc (and really, they should've been part of the coroutines api).
  • Added isSelfSteaming to VoiceState, indicating when a user is streaming using "Go Live".

Changes

  • KordClientBuilder now allows you to pass a custom CoroutineDispatcher.
  • Since most suspending calls in Kord will be IO related, Kord now uses Dispatchers.IO as its CoroutineDispatcher.
  • StoreChannel can no longer be used to read or send messages. discord api.
  • NewsChannel and StoreChannel have been upgraded to the stable api and are no longer in preview.
  • ExclusionRequestHandler now takes request buckets into consideration.

Fixes

0.2.1

This is the first maintenance update for Kord 0.2. With it, we have started hosting Kord on bintray, check our README on what to include to get the newest version.

Additions

  • Added Flow<T: Any>.firstOrNull and Flow<T: Any>.any as their behavior is often needed when interacting with flows of members, channels, etc (and really, they should've been part of the coroutines api).

Changes

  • KordClientBuilder now allows you to pass a custom CoroutineDispatcher.
  • Since most suspending calls in Kord will be IO related, Kord now uses Dispatchers.IO as its CoroutineDispatcher.
  • StoreChannel can no longer be used to read or send messages. discord api.
  • NewsChannel and StoreChannel have been upgraded to the stable api and are no longer in preview.

Fixes

0.2.0

Additions

  • Added the core module, a wrapper around gateway and rest that introduces caching using our cache module. As with all our api, it's not stable yet and we will probably continue to introduce breaking changes to improve the general look and feel and fix design flaws.

  • Along with core comes the concept of entity Behaviour, which are stripped down discord entities (mostly only retaining their id) that are able to interact with rest on a higher level than the rest module exposes. This is specifically geared towards users who have disabled caching, but its use should be preferred towards anyone who doesn't want to risk increased cache hits or rest calls.

  • Gateways now come with a detach function, which will allow implementations to (permanently) shut down and release all resources. DefaultGateway didn't require this, but other implementations that use e.g. thread pools can now shut those down in here.

  • DefaultGateway now comes with a builder dsl that has sane defaults.

  • ExclusionHandler now comes with a secondary constructor that accepts a token.

Changes

  • Kotlin's experimental Duration has replaced Long typed arguments that represented durations in milliseconds. The previous functions/constructors have been marked with @Deprecated and should be replaced with the new ones.

Fixes

  • Numerous nullability fixes and other inconsistencies with/because of the discord api.

0.1.0

Additions

  • Added the rest module, a direct mapping of Discord's REST API with rate limiting
  • Added a common module, containing shared code between rest and gateway
  • Preview and Experimental annotations

Changes

  • Moved shared json classes to common
  • Removed Snowflake from common and gateway

Fixes

  • guildId field has been renamed to id in GuildIntegrations
  • The color field in Embed is now optional
  • The timestamp filed in Embed is now optional
  • The All Permission now correctly represents all permissions
  • Missing fields have been added to GuildIntegrations
  • DefaultGateway should now correctly reconnect on reconnect events
  • DefaultGateway should no longer delay on user invoked close