Merge branch 'master' into feat/rework_custom_attachments_builders

GetStream · Feb 2, 2024 · 86f6fdd · 86f6fdd
2 parents 62e7007 + 1d1acdc
commit 86f6fdd
Show file tree

Hide file tree

Showing 52 changed files with 186 additions and 133 deletions.
diff --git a/.github/workflows/dispatch_workflows.yml b/.github/workflows/dispatch_workflows.yml
diff --git a/...docs/Flutter/01-basics/choose_package.mdx → ...s/docs/Flutter/01-basics/installation.mdx b/...docs/Flutter/01-basics/choose_package.mdx → ...s/docs/Flutter/01-basics/installation.mdx
@@ -1,5 +1,5 @@
 ---
-id: choose_package
+id: installation
 sidebar_position: 2
 title: Installation
 ---
@@ -55,3 +55,20 @@ and architecture.
 <b>Summary:</b>
 
 For the most control over the SDK and dealing with low level calls to the API, use `stream_chat`.
+
+### Versioning Policy
+
+All of the Stream Chat packages follow [semantic versioning](https://semver.org/).
+
+That means that with a version number x.y.z (major.minor.patch):
+- When releasing bug fixes (backwards compatible), we make a patch release by changing the z number (ex: 3.6.2 to 3.6.3). A bug fix is defined as an internal change that fixes incorrect behavior.
+- When releasing new features or non-critical fixes, we make a minor release by changing the y number (ex: 3.6.2 to 3.7.0).
+- When releasing breaking changes (backward incompatible), we make a major release by changing the x number (ex: 3.6.2 to 4.0.0).
+
+See the [semantic versioning](https://dart.dev/tools/pub/versioning#semantic-versions) section from the Dart docs for more information.
+
+This versioning policy does not apply to prerelease packages (below major version of 1). See this
+[StackOverflow thread](https://stackoverflow.com/questions/66201337/how-do-dart-package-versions-work-how-should-i-version-my-flutter-plugins)
+for more information on Dart package versioning.
+
+Whenever possible, we will add deprecation warnings in preparation for future breaking changes.
diff --git a/docusaurus/docs/Flutter/01-basics/versioning_policy.mdx b/docusaurus/docs/Flutter/01-basics/versioning_policy.mdx
diff --git a/...-stream_chat_flutter/03-custom_widgets/05-customize_attachment_picker_modal.mdx b/...-stream_chat_flutter/03-custom_widgets/05-customize_attachment_picker_modal.mdx
@@ -8,7 +8,7 @@ Customizing the Attachment Picker Modal
 ### Introduction
 
 The Attachment Picker is a modal that allows users to select attachments from their device.
-It is generally used when a user taps the attachment button in the [StreamMessageInput](../../03-stream_chat_flutter/stream_message_input.mdx).
+It is generally used when a user taps the attachment button in the [StreamMessageInput](../07-message_composer/stream_message_input.mdx).
 
 By default, the Attachment Picker provides multiple picker options as per the platform.
 - For example, on Mobile, the default options are Camera, Gallery, File, and Video.

diff --git a/...s/Flutter/02-stream_chat_flutter/03-custom_widgets/06-autocomplete_triggers.mdx b/...s/Flutter/02-stream_chat_flutter/03-custom_widgets/06-autocomplete_triggers.mdx
@@ -7,7 +7,7 @@ Adding Custom Autocomplete Triggers
 
 ### Introduction
 
-The [StreamMessageInput](../../03-stream_chat_flutter/stream_message_input.mdx) widget provides a way to add custom autocomplete triggers using the `StreamMessageInput.customAutocompleteTriggers` property.
+The [StreamMessageInput](../07-message_composer/stream_message_input.mdx) widget provides a way to add custom autocomplete triggers using the `StreamMessageInput.customAutocompleteTriggers` property.
 
 By default we provide autocomplete triggers for mentions and commands, but it's very easy to add your custom ones.
 

diff --git a/...s/Flutter/02-stream_chat_flutter/04-channel_list/stream_channel_list_header.mdx b/...s/Flutter/02-stream_chat_flutter/04-channel_list/stream_channel_list_header.mdx
@@ -8,7 +8,7 @@ A Header Widget For A List Of Channels
 
 Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/StreamChannelListHeader-class.html)
 
-![](../assets/channel_list_header.png)
+![](../../assets/channel_list_header.png)
 
 ### Background
 
@@ -88,7 +88,7 @@ StreamChannelListHeader(
 ),
 ```
 
-![](../assets/channel_list_header_custom_subtitle.png)
+![](../../assets/channel_list_header_custom_subtitle.png)
 
 The `titleBuilder` parameter helps you build different titles depending on the connection state:
 

diff --git a/...ocs/Flutter/02-stream_chat_flutter/04-channel_list/stream_channel_list_view.mdx b/...ocs/Flutter/02-stream_chat_flutter/04-channel_list/stream_channel_list_view.mdx
@@ -8,7 +8,7 @@ A Widget For Displaying A List Of Channels
 
 Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/StreamChannelListView-class.html)
 
-![](../assets/channel_list_view.png)
+![](../../assets/channel_list_view.png)
 
 ### Background
 
@@ -23,7 +23,7 @@ ONLY the channels that the user is a part of. This section goes into setting up
 widget.
 
 :::note
-Make sure to check the [StreamChannelListController](../04-stream_chat_flutter_core/stream_channel_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamChannelListView`.
+Make sure to check the [StreamChannelListController](../../04-stream_chat_flutter_core/stream_channel_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamChannelListView`.
 :::
 
 ### Basic Example
@@ -104,4 +104,4 @@ StreamChannelListView(
 
 Which gives you a new Channel preview in the list:
 
-![](../assets/channel_preview.png)
+![](../../assets/channel_preview.png)
diff --git a/...ocs/Flutter/02-stream_chat_flutter/06-message_list/stream_message_list_view.mdx b/...ocs/Flutter/02-stream_chat_flutter/06-message_list/stream_message_list_view.mdx
@@ -8,7 +8,7 @@ A Widget For Displaying A List Of Messages
 
 Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/StreamMessageListView-class.html)
 
-![](../assets/message_list_view.png)
+![](../../assets/message_list_view.png)
 
 ### Background
 
@@ -64,7 +64,7 @@ StreamMessageListView(
 ),
 ```
 
-![](../assets/message_list_view_threads.png)
+![](../../assets/message_list_view_threads.png)
 
 The `StreamMessageListView` itself can render the thread by supplying the `parentMessage` parameter.
 

diff --git a/...tter/02-stream_chat_flutter/06-message_list/stream_message_search_list_view.mdx b/...tter/02-stream_chat_flutter/06-message_list/stream_message_search_list_view.mdx
@@ -8,7 +8,7 @@ A Widget To Search For Messages Across Channels
 
 Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/StreamMessageSearchListView-class.html)
 
-![](../assets/message_search_list_view.png)
+![](../../assets/message_search_list_view.png)
 
 ### Background
 
@@ -17,7 +17,7 @@ message they are searching for. As such, there needs to be a way to search for a
 channels. This is where `StreamMessageSearchListView` comes in.
 
 :::note
-Make sure to check the [StreamMessageSearchListController](../04-stream_chat_flutter_core/stream_message_search_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageSearchListView`.
+Make sure to check the [StreamMessageSearchListController](../../04-stream_chat_flutter_core/stream_message_search_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageSearchListView`.
 :::
 
 ### Basic Example

diff --git a/...ocs/Flutter/02-stream_chat_flutter/07-message_composer/stream_message_input.mdx b/...ocs/Flutter/02-stream_chat_flutter/07-message_composer/stream_message_input.mdx
@@ -8,7 +8,7 @@ A Widget Dealing With Everything Related To Sending A Message
 
 Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/StreamMessageInput-class.html)
 
-![](../assets/message_input.png)
+![](../../assets/message_input.png)
 
 ### Background
 
@@ -57,7 +57,7 @@ class ChannelPage extends StatelessWidget {
 It is common to put this widget in the same page of a `StreamMessageListView` as the bottom widget.
 
 :::note
-Make sure to check the [StreamMessageInputController](../04-stream_chat_flutter_core/stream_message_input_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageInput`.
+Make sure to check the [StreamMessageInputController](../../04-stream_chat_flutter_core/stream_message_input_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMessageInput`.
 :::
 
 ### Adding Custom Actions
@@ -110,4 +110,4 @@ StreamMessageInput(
 ),
 ```
 
-![](../assets/message_input_change_position.png)
+![](../../assets/message_input_change_position.png)
diff --git a/.../docs/Flutter/02-stream_chat_flutter/08-member_list/stream_member_list_view.mdx b/.../docs/Flutter/02-stream_chat_flutter/08-member_list/stream_member_list_view.mdx
@@ -13,7 +13,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_
 A list of members is required for many different purposes, for example, showing a list of users in a Channel. The `StreamMemberListView` displays a list of members.
 
 :::note
-Make sure to check the [StreamMemberListController](../04-stream_chat_flutter_core/stream_member_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMemberListView`.
+Make sure to check the [StreamMemberListController](../../04-stream_chat_flutter_core/stream_member_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamMemberListView`.
 :::
 
 ### Basic Example

diff --git a/...urus/docs/Flutter/02-stream_chat_flutter/09-user_list/stream_user_list_view.mdx b/...urus/docs/Flutter/02-stream_chat_flutter/09-user_list/stream_user_list_view.mdx
@@ -8,7 +8,7 @@ A Widget For Displaying And Selecting Users
 
 Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_flutter/latest/stream_chat_flutter/StreamUserListView-class.html)
 
-![](../assets/user_list_view.png)
+![](../../assets/user_list_view.png)
 
 ### Background
 
@@ -17,7 +17,7 @@ selecting users to add in a channel, etc. The `StreamUserListView` displays a li
 of users.
 
 :::note
-Make sure to check the [StreamUserListController](../04-stream_chat_flutter_core/stream_user_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamUserListView`.
+Make sure to check the [StreamUserListController](../../04-stream_chat_flutter_core/stream_user_list_controller.mdx) documentation for more information on how to use the controller to manipulate the `StreamUserListView`.
 :::
 
 ### Basic Example

diff --git a/...rus/docs/Flutter/04-stream_chat_flutter_core/stream_channel_list_controller.mdx b/...rus/docs/Flutter/04-stream_chat_flutter_core/stream_channel_list_controller.mdx
@@ -12,7 +12,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_
 
 The `StreamChannelListController` is a controller class that allows you to control a list of channels.
 `StreamChannelListController` is a required parameter of the `StreamChannelListView` widget.
-Check the [`StreamChannelListView` documentation](../03-stream_chat_flutter/stream_channel_list_view.mdx) to read more about that.
+Check the [`StreamChannelListView` documentation](../02-stream_chat_flutter/04-channel_list/stream_channel_list_view.mdx) to read more about that.
 
 The `StreamChannelListController` also listens for various events and manipulates the current list of channels accordingly.
 Passing a `StreamChannelListEventHandler` to the `StreamChannelListController` will allow you to customize this behaviour.

diff --git a/...urus/docs/Flutter/04-stream_chat_flutter_core/stream_member_list_controller.mdx b/...urus/docs/Flutter/04-stream_chat_flutter_core/stream_member_list_controller.mdx
@@ -12,7 +12,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_
 
 The `StreamMemberListController` is a controller class that allows you to control a list of users.
 `StreamMemberListController` is a required parameter of the `StreamMemberListView` widget.
-Check the [`StreamMemberListView` documentation](../03-stream_chat_flutter/stream_member_list_view.mdx) to read more about that.
+Check the [`StreamMemberListView` documentation](../02-stream_chat_flutter/04-channel_list/stream_channel_list_view.mdx) to read more about that.
 
 ### Basic Example
 

diff --git a/...us/docs/Flutter/04-stream_chat_flutter_core/stream_message_input_controller.mdx b/...us/docs/Flutter/04-stream_chat_flutter_core/stream_message_input_controller.mdx
@@ -12,7 +12,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_
 
 The `StreamMessageInputController` is a controller class that embed the business logic to compose a message.
 `StreamMessageInputController` is a parameter of the `StreamMessageInput` widget.
-Check the [`StreamMessageInput` documentation](../03-stream_chat_flutter/stream_message_input.mdx) to read more about that.
+Check the [`StreamMessageInput` documentation](../02-stream_chat_flutter/07-message_composer/stream_message_input.mdx) to read more about that.
 
 ### Basic Example
 

diff --git a/...s/Flutter/04-stream_chat_flutter_core/stream_message_search_list_controller.mdx b/...s/Flutter/04-stream_chat_flutter_core/stream_message_search_list_controller.mdx
@@ -12,7 +12,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_
 
 The `StreamMessageSearchListController` is a controller class that allows you to control a list of searched messages.
 `StreamMessageSearchListController` is a required parameter of the `StreamMessageSearchListView` widget.
-Check the [`StreamMessageSearchListView` documentation](../03-stream_chat_flutter/stream_message_search_list_view.mdx) to read more about that.
+Check the [`StreamMessageSearchListView` documentation](../02-stream_chat_flutter/06-message_list/stream_message_search_list_view.mdx) to read more about that.
 
 ### Basic Example
 

diff --git a/...saurus/docs/Flutter/04-stream_chat_flutter_core/stream_user_list_controller.mdx b/...saurus/docs/Flutter/04-stream_chat_flutter_core/stream_user_list_controller.mdx
@@ -12,7 +12,7 @@ Find the pub.dev documentation [here](https://pub.dev/documentation/stream_chat_
 
 The `StreamUserListController` is a controller class that allows you to control a list of users.
 `StreamUserListController` is a required parameter of the `StreamUserListView` widget.
-Check the [`StreamUserListView` documentation](../03-stream_chat_flutter/stream_user_list_view.mdx) to read more about that.
+Check the [`StreamUserListView` documentation](../02-stream_chat_flutter/09-user_list/stream_user_list_view.mdx) to read more about that.
 
 ### Basic Example
 

diff --git a/docusaurus/docs/Flutter/05-guides/08-migrations/migration_guide_4_0.mdx b/docusaurus/docs/Flutter/05-guides/08-migrations/migration_guide_4_0.mdx
@@ -77,7 +77,7 @@ The automatic video compression when uploading a video has been removed. You can
 
 ### Slidable Channel List Item
 
-The default slidable channel preview behavior has been removed. We have created a [guide](../../02-customization/01-custom-widgets/07-slidable_channel_list_preview.mdx) showing you how you can easily add this functionality yourself.
+The default slidable channel preview behavior has been removed. We have created a [guide](../../02-stream_chat_flutter/03-custom_widgets/07-slidable_channel_list_preview.mdx) showing you how you can easily add this functionality yourself.
 
 ![Slidable demo](../../assets/slidable_demo.jpg)
 
@@ -195,7 +195,7 @@ Version 4 of the Stream Chat Flutter packages introduces a new controller called
 - Return/Create a new channel and start watching it.
 - Pause and Resume all subscriptions added to this composite.
 
-For more information see the [`StreamChannelListView` documentation](../../03-stream_chat_flutter/stream_channel_list_view.mdx).
+For more information see the [`StreamChannelListView` documentation](../../02-stream_chat_flutter/04-channel_list/stream_channel_list_view.mdx).
 
 ### ChannelsBloc to StreamChannelListController
 
@@ -311,7 +311,7 @@ Version 4 of the Stream Chat Flutter packages introduces a new controller called
 - Load more data using `loadMore`.
 - Refresh data.
 
-For more information see the [`StreamMessageSearchListView` documentation](../../03-stream_chat_flutter/stream_message_search_list_view.mdx).
+For more information see the [`StreamMessageSearchListView` documentation](../../02-stream_chat_flutter/06-message_list/stream_message_search_list_view.mdx).
 
 ### MessageSearchBloc to StreamMessageSearchListController
 
@@ -422,7 +422,7 @@ Version 4 of the Stream Chat Flutter packages introduces a new controller called
 - Set filters.
 - Refresh data.
 
-For more information see the [`StreamUserListView` documentation](../../03-stream_chat_flutter/stream_user_list_view.mdx).
+For more information see the [`StreamUserListView` documentation](../../02-stream_chat_flutter/09-user_list/stream_user_list_view.mdx).
 
 ### UsersBloc to StreamUserListController
 

diff --git a/docusaurus/docs/Flutter/05-guides/08-migrations/migration_guide_5_0.mdx b/docusaurus/docs/Flutter/05-guides/08-migrations/migration_guide_5_0.mdx
@@ -39,7 +39,7 @@ This section highlights our efforts on Desktop (macOS, Windows, and Linux) and W
 
 ### Setup
 
-See the [setup guide](../../03-stream_chat_flutter/setup.mdx) for platform specific instructions.
+See the [setup guide](../../../../flutter_versioned_docs/version-5.x.x/03-stream_chat_flutter/setup.mdx) for platform specific instructions.
 
 ### Supporting Larger Screens
 
@@ -50,7 +50,7 @@ We've added support for larger screens and have made changes to the UI to suppor
 
 Below is an example running on macOS, with a split-screen view showing channels on the left and messages on the right.
 
-![MacOS split](../../assets/mac_os_split.png)
+![MacOS split](../../../../flutter_versioned_docs/version-5.x.x/assets/mac_os_split.png)
 
 ### Native Platform Interactions
 
@@ -106,13 +106,13 @@ For additional information, see [#1125](https://github.com/GetStream/stream-chat
 
 The `StreamMemberListView` and `StreamMemberGridView` widgets are new widgets that allow you to display a list of members in a channel.
 
-Check out the dedicated [documentation](../../03-stream_chat_flutter/stream_member_list_view.mdx) for more information.
+Check out the dedicated [documentation](../../../../flutter_versioned_docs/version-5.x.x/03-stream_chat_flutter/stream_member_list_view.mdx) for more information.
 
 ### Attachment Picker
 
 As part of the v5 release, we've refactored the `AttachmentPicker` to be more flexible and customizable. This allows you to use the `AttachmentPicker` in various ways and customize the UI to your liking.
 
-Check out the dedicated [guide](../../02-customization/01-custom-widgets/05-customize_attachment_picker_modal.mdx) for more information.
+Check out the dedicated [guide](../../../../flutter_versioned_docs/version-5.x.x/02-customization/01-custom-widgets/05-customize_attachment_picker_modal.mdx) for more information.
 
 ### Other Changes
 
@@ -170,6 +170,6 @@ StreamImageAttachment(
 )
 ```
 
-- Removed `StreamMessageInput.customOverlays` in favor of `StreamMessageInput.customAutocompleteTriggers`. Read the guide on [Adding Custom Autocomplete Triggers](../../02-customization/01-custom-widgets/06-autocomplete_triggers.mdx) to learn how to migrate your code.
+- Removed `StreamMessageInput.customOverlays` in favor of `StreamMessageInput.customAutocompleteTriggers`. Read the guide on [Adding Custom Autocomplete Triggers](../../../../flutter_versioned_docs/version-5.x.x/02-customization/01-custom-widgets/06-autocomplete_triggers.mdx) to learn how to migrate your code.
 
-- Removed the default emoji overlay picker. Read the guide on [Adding Custom Autocomplete Triggers](../../02-customization/01-custom-widgets/06-autocomplete_triggers.mdx) to learn how to migrate your code.
+- Removed the default emoji overlay picker. Read the guide on [Adding Custom Autocomplete Triggers](../../../../flutter_versioned_docs/version-5.x.x/02-customization/01-custom-widgets/06-autocomplete_triggers.mdx) to learn how to migrate your code.
diff --git a/docusaurus/docs/Flutter/05-guides/09-initialize_stream_chat_widget_tree.mdx b/docusaurus/docs/Flutter/05-guides/09-initialize_stream_chat_widget_tree.mdx
@@ -12,7 +12,7 @@ This guide demonstrates three alternative ways for you to initialize Stream Chat
 
 Before investigating potential solutions, let’s first take a look at the relevant Stream Chat widgets and classes.
 
-Most of the Stream Chat Flutter UI widgets rely on having a [StreamChat](../../customization/stream_chat_and_theming/) ancestor in the widget tree.
+Most of the Stream Chat Flutter UI widgets rely on having a [StreamChat](../02-stream_chat_flutter/stream_chat_and_theming.mdx) ancestor in the widget tree.
 The **StreamChat** widget is an [InheritedWidget](https://api.flutter.dev/flutter/widgets/InheritedWidget-class.html) that exposes the **StreamChatClient** through **BuildContext**.
 This widget also initializes the [StreamChatCore](../04-stream_chat_flutter_core/stream_chat_core.mdx) widget and the **StreamChatTheme**.
 

diff --git a/packages/stream_chat/CHANGELOG.md b/packages/stream_chat/CHANGELOG.md
@@ -1,3 +1,10 @@
+## Unreleased
+
+🐞 Fixed
+
+- [[#1837]](https://github.com/GetStream/stream-chat-flutter/issues/1837) Delete image and file 
+  attachments from the CDN, when the message get's hard deleted.
+
 ## 7.0.1
 
 🐞 Fixed