Hikari

Breaking Changes

- Remove previously deprecated functionality.

This includes:
- `Message.mentions`
- `nick` argument in rest methods
- `edit_permission_overwrites`, `edit_my_nick` and `command_builder` rest methods
- `CacheView.iterator` ([1347](https://github.com/hikari-py/hikari/issues/1347))

Deprecation

- Deprecate `RESTClientImpl.build_action_row` in favour of `RESTClientImpl.build_message_action_row`. ([1002](https://github.com/hikari-py/hikari/issues/1002))

Features

- Implement modal interactions.
- Additionally, it is now guaranteed (typing-wise) that top level components will be an action row ([1002](https://github.com/hikari-py/hikari/issues/1002))
- Add new `UserFlag.ACTIVE_DEVELOPER`. ([1355](https://github.com/hikari-py/hikari/issues/1355))
- Allow specifying a filename to `hikari.files.URL`. ([1368](https://github.com/hikari-py/hikari/issues/1368))
- Only subscribe to voice events when needed in the voice manager. ([1369](https://github.com/hikari-py/hikari/issues/1369))
- Add functionality to create and deserialize age-restricted (NSFW) commands. ([1382](https://github.com/hikari-py/hikari/issues/1382))
- Threads cache. ([1384](https://github.com/hikari-py/hikari/issues/1384))

Bugfixes

- Allow re-uploading attachments when creating messages ([1367](https://github.com/hikari-py/hikari/issues/1367))
- Fix error caused when disconnecting the bot and having active voice connections. ([1369](https://github.com/hikari-py/hikari/issues/1369))
- Remove incorrect `is_nsfw` field from threads.
- The "NSFW" status is inherited from the parent object and not sent for threads.
- This also involved moving the base attribute from `GuildChannel` to `PermissibleGuildChannel`. ([1386](https://github.com/hikari-py/hikari/issues/1386))

Documentation Improvements

- Documentation overhaul and move to docs.hikari-py.dev domain. ([1118](https://github.com/hikari-py/hikari/issues/1118))

---

Breaking Changes

- Moved permission overwrite mapping and permission related methods from `GuildChannel` to `PermissibleGuildChannel`. ([811](https://github.com/hikari-py/hikari/issues/811))
- Support v10 attachments edits

This includes breaking changes, features and things to look out for when editing messages:
- Modifying attachments in messages that contain embeds with any image attached to them now requires the images of that embed
image to be re-passed in the edit or they will be lost.
- `attachment` and `attachments` in message edits now support passing an `Attachment` object to keep existing attachments.
- `replace_attachments` has been removed, as it is now the default.
- `attachment` and `attachments` now supports `None` to replicate the behaviour of fully removing all attachments.
- `InteractionMessageBuilder.clear_attachments` has been implemented to remove existing attachments from messages. ([1260](https://github.com/hikari-py/hikari/issues/1260))

Features

- Thread support for REST requests and gateway events. ([811](https://github.com/hikari-py/hikari/issues/811))
- Startup and shutdown callbacks for the RESTBot interface/impl. ([999](https://github.com/hikari-py/hikari/issues/999))
- Support specifying `with_counts` and `with_expiration` in `RESTClient.fetch_invite` ([1330](https://github.com/hikari-py/hikari/issues/1330))
- Support for including the `SUPPRESS_EMBEDS` flag while creating a message. ([1331](https://github.com/hikari-py/hikari/issues/1331))
- Add `MANAGE_EVENTS` permission to `hikari.Permissions` ([1334](https://github.com/hikari-py/hikari/issues/1334))

Bugfixes

- Wrong typehint for `InviteGuild.features`. ([1307](https://github.com/hikari-py/hikari/issues/1307))
- Fix aiohttp error "charset must not be in content type" when using `InteractionServer` ([1320](https://github.com/hikari-py/hikari/issues/1320))
- The REST list methods (e.g. `fetch_channels`) no-longer raise `hikari.errors.UnrecognisedEntityError` when they encounter an unknown type. ([1337](https://github.com/hikari-py/hikari/issues/1337))
- Fix deprecation warnings in CPython3.11 in `hikari.internal.ux`. ([1344](https://github.com/hikari-py/hikari/issues/1344))

---

Breaking Changes

- Lifetime improvements breaking changes:
- `GatewayBot.join`'s `until_close` argument removed.
- `GatewayShardImpl.get_user_id` is no longer async and will now always be available.
- `GatewayBotAware` no longer defines the default parameters for `join`, `start` and `run`. It is left to implementation detail. ([1204](https://github.com/hikari-py/hikari/issues/1204))
- Remove support for ProcessPoolExecutor executor when reading files
- It is much more efficient to use a threadpool executor for I/O actions like this one
- Due to the nature of process pool, we were also not able to perform proper chunking when reading off the file ([1273](https://github.com/hikari-py/hikari/issues/1273))

Deprecation

- Deprecate `CacheView.iterator` in favour of using the `itertools` module. ([1289](https://github.com/hikari-py/hikari/issues/1289))

Features

- Add python 3.11-dev support. ([847](https://github.com/hikari-py/hikari/issues/847))
- Support for Application Command Localizations. ([1141](https://github.com/hikari-py/hikari/issues/1141))
- Improve components lifetimes:
- `GatewayBot`:
- General speedups.
- Fix a lot of edge cases of hard crashes if the application shuts unexpectedly.
- More consistent signal handling.
- `run`'s `shard_ids` argument can now be a `typing.Sequence`.
- Improved logging.
- `RESTBot`:
- Consistent signal handling inline with `GatewayBot`.
- Improved logging.
- Improved loop closing.
- `GatewayShardImpl`:
- New `is_connected` property to determine whether the shard is connected to the gateway.
- Faster websocket pulling and heartbeating.
- Improved error handling.
- Rate limiting changes:
- Chunking no longer has its own special ratelimit. Now it is shared with the rest of
"non-priority" packages sent, which is of 117/60s (3 less than the hard limit).
- "priority" packages currently only include heartbeating. ([1204](https://github.com/hikari-py/hikari/issues/1204))
- Implement slash option min/max length fields ([1216](https://github.com/hikari-py/hikari/issues/1216))
- Add `mention` property to `PartialChannel`. ([1221](https://github.com/hikari-py/hikari/issues/1221))
- Implement new Gateway reconnect logic enforced by Discord. ([1245](https://github.com/hikari-py/hikari/issues/1245))

Bugfixes

- Lifetime improvements bugfixes:
- `GatewayShardImpl` can now be instantiated out of an async environment for consistency with other components.
- Correct signal handling in `RESTBot`. ([1204](https://github.com/hikari-py/hikari/issues/1204))
- Improve `BadRequestError`'s error string. ([1213](https://github.com/hikari-py/hikari/issues/1213))
- Fix `hikari.impl.VoiceImpl.connect_to` silently failing if the guild or voice channel do not exist by providing a timeout. ([1242](https://github.com/hikari-py/hikari/issues/1242))
- `dm_permission` now correctly defaults to `True` instead of `False` when parsing command objects from Discord. ([1243](https://github.com/hikari-py/hikari/issues/1243))
- Fix float precision issues when creating a snowflake from a datetime object. ([1247](https://github.com/hikari-py/hikari/issues/1247))
- Fix `reposition_channels` to use the correct route. ([1259](https://github.com/hikari-py/hikari/issues/1259))
- Allow for `replace_attachments` kwarg to be used in `RESTClient.create_initial_response`. ([1266](https://github.com/hikari-py/hikari/issues/1266))
- Ignore guild create events which contain unavailable guilds ([1284](https://github.com/hikari-py/hikari/issues/1284))

---

Breaking Changes

- Removed case of `Member.mention` returning bang (`!`) mention, as it is deprecated by Discord. ([1207](https://github.com/hikari-py/hikari/issues/1207))

Deprecation

- `RESTClient.edit_permission_overwrites` renamed to `RESTClient.edit_permission_overwrite` ([1195](https://github.com/hikari-py/hikari/issues/1195))

Features

- Add `hikari.events.StickersUpdateEvent` and relevant cache internals.
Add sticker related public methods onto `hikari.impl.CacheImpl` and `hikari.guilds.Guild`. ([1126](https://github.com/hikari-py/hikari/issues/1126))
- `GuildVoiceChannel` now inherits from `TextableGuildChannel` instead of `GuildChannel`. ([1189](https://github.com/hikari-py/hikari/issues/1189))
- Add the `app_permissions` field to command and component interactions. ([1201](https://github.com/hikari-py/hikari/issues/1201))
- Add application command badge ([1225](https://github.com/hikari-py/hikari/issues/1225))

Bugfixes

- Fix how CommandBuilder handles `default_member_permissions` to match the behaviour on PartialCommand. ([1212](https://github.com/hikari-py/hikari/issues/1212))

---

Breaking Changes

- Removal of all application commands v1 related fields and endpoints.
- Discord has completely disabled some endpoints, so we unfortunately can't
deprecate them instead of removing them ([1148](https://github.com/hikari-py/hikari/issues/1148))
- Removed the `resolved` attribute from `AutocompleteInteraction` as autocomplete interactions never have resolved objects. ([1152](https://github.com/hikari-py/hikari/issues/1152))
- `build` methods are now typed as returning `MutableMapping[str, typing.Any]`. ([1164](https://github.com/hikari-py/hikari/issues/1164))

Deprecation

- `messages.Mentions` object deprecated
- Alternatives can be found in the base message object ([1149](https://github.com/hikari-py/hikari/issues/1149))

Features

- Add `create` method to `CommandBuilder`. ([1016](https://github.com/hikari-py/hikari/issues/1016))
- Support for attachments in REST-based interaction responses. ([1048](https://github.com/hikari-py/hikari/issues/1048))
- Add option to disable automatic member chunking.
Added the `auto_chunk_members` kwarg to `GatewayBot` and `EventManagerImpl`, which when `False` will disable automatic member chunking. ([1084](https://github.com/hikari-py/hikari/issues/1084))
- Allow passing multiple event types to the listen decorator.
Parse union type hints for events if listen decorator is empty. ([1103](https://github.com/hikari-py/hikari/issues/1103))
- Animated guild banner support. ([1116](https://github.com/hikari-py/hikari/issues/1116))
- Implement application commands permission v2.
- New `default_member_permissions` and `is_dm_enabled` related fields.
- Added `hikari.events.application_events.ApplicationCommandPermissionsUpdate`.
- Added `APPLICATION_COMMAND_PERMISSION_UPDATE` audit log entry ([1148](https://github.com/hikari-py/hikari/issues/1148))

Bugfixes

- Improved pyright support. ([1108](https://github.com/hikari-py/hikari/issues/1108))
- `RESTClientImpl.fetch_bans` now return a `LazyIterator` to allow pagination of values. ([1119](https://github.com/hikari-py/hikari/issues/1119))
- Fix unicode decode error caused by `latin-1` encoding when sending the banner. ([1120](https://github.com/hikari-py/hikari/issues/1120))
- Don't error on an out-of-spec HTTP status code (e.g one of Cloudflare's custom status codes).
`HTTPResponseError.status` may now be of type `http.HTTPStatus` or `int`. ([1121](https://github.com/hikari-py/hikari/issues/1121))
- Fix name of polish locale (`hikari.Locale.OL` -> `hikari.Locale.PL`) ([1144](https://github.com/hikari-py/hikari/issues/1144))
- Properly garbage collect message references in the cache
- Properly deserialize `PartialMessage.referenced_message` as a partial message ([1192](https://github.com/hikari-py/hikari/issues/1192))

---

Breaking Changes

- `hikari.config` has now been split up to `hikari.api.config` and `hikari.impl.config` to avoid leaking impl detail.
This also means that config types are no-longer accessible at the top level (directly on `hikari`). ([1067](https://github.com/hikari-py/hikari/issues/1067))
- Hide the entity factory's component deserialize methods. ([1074](https://github.com/hikari-py/hikari/issues/1074))
- Remove nonce parameter from create message.
This was purposely removed from the bot api documentation inferring that its no-longer officially supported. ([1075](https://github.com/hikari-py/hikari/issues/1075))
- Remove `VoiceRegion.is_vip` due to Discord no longer sending it. ([1086](https://github.com/hikari-py/hikari/issues/1086))
- Remove store sku related application fields and store channels. ([1092](https://github.com/hikari-py/hikari/issues/1092))

Deprecation

- Renamed `nick` argument to `nickname` for edit member and add user to guild REST methods. ([1095](https://github.com/hikari-py/hikari/issues/1095))

Features

- Scheduled event support. ([1056](https://github.com/hikari-py/hikari/issues/1056))
- `get_guild()` is now available on `hikari.GuildChannel`. ([1057](https://github.com/hikari-py/hikari/issues/1057))
- Optimize receiving websocket JSON for the happy path. ([1058](https://github.com/hikari-py/hikari/issues/1058))
- The threaded file reader now persists the open file pointer while the context manager is active. ([1073](https://github.com/hikari-py/hikari/issues/1073))
- Optimize event dispatching by only deserializing events when they are needed. ([1094](https://github.com/hikari-py/hikari/issues/1094))
- Add `hikari.locales.Locale` to help with Discord locale strings. ([1090](https://github.com/hikari-py/hikari/issues/1090))

Bugfixes

- `fetch_my_guilds` no-longer returns duplicate guilds nor makes unnecessary (duplicated) requests when `newest_first` is set to `True`. ([1059](https://github.com/hikari-py/hikari/issues/1059))
- Add `InviteEvent` to `hikari.events.channel_events.__all__`, `hikari.events.__all__` and `hikari.__all__`. ([1065](https://github.com/hikari-py/hikari/issues/1065))
- Fix incorrect type for ATTACHMENT option values. ([1066](https://github.com/hikari-py/hikari/issues/1066))
- `EventManager.get_listeners` now correctly defines polymorphic and returns accordingly. ([1094](https://github.com/hikari-py/hikari/issues/1094))
- Take the major param for webhook without token endpoints when handling bucket ratelimits. ([1102](https://github.com/hikari-py/hikari/issues/1102))
- Fix incorrect value for `GuildFeature.MORE_STICKERS`. ([1989](https://github.com/hikari-py/hikari/issues/1989))

---