From ad3c3572ddf588b5a5fb9457588c1cb423b5d4af Mon Sep 17 00:00:00 2001 From: Salvatore Giordano Date: Wed, 22 Sep 2021 15:25:45 +0200 Subject: [PATCH] feat!(core): commit breaking changes --- .../stream_chat_flutter_core/CHANGELOG.md | 8 +++--- .../lib/src/channel_list_core.dart | 22 +++------------- .../lib/src/user_list_core.dart | 25 +++---------------- 3 files changed, 12 insertions(+), 43 deletions(-) diff --git a/packages/stream_chat_flutter_core/CHANGELOG.md b/packages/stream_chat_flutter_core/CHANGELOG.md index e1ec1fc5..b14c7cbc 100644 --- a/packages/stream_chat_flutter_core/CHANGELOG.md +++ b/packages/stream_chat_flutter_core/CHANGELOG.md @@ -1,6 +1,6 @@ ## 3.0.0 -⚠️ Deprecated +🛑️ Breaking Changes from `2.2.1` - `MessageSearchListViewCore` `paginationParams` property is now deprecated in favor of `limit`. ```dart @@ -10,7 +10,7 @@ // new limit = 30 ``` -- `UserListViewCore` `pagination` property is now deprecated in favor of `limit`. +- `UserListCore` `pagination` property is now deprecated in favor of `limit`. ```dart // previous pagination = const PaginationParams(limit: 30) @@ -18,7 +18,7 @@ // new limit = 30 ``` -- `ChannelListViewCore` `pagination` property is now deprecated in favor of `limit`. +- `ChannelListCore` `pagination` property is now deprecated in favor of `limit`. ```dart // previous pagination = const PaginationParams(limit: 30) @@ -27,6 +27,8 @@ limit = 30 ``` +- `UserListViewCore` `filter` property now is non-nullable. + 🔄 Changed - `UserListViewCore` filter property now has a default value. diff --git a/packages/stream_chat_flutter_core/lib/src/channel_list_core.dart b/packages/stream_chat_flutter_core/lib/src/channel_list_core.dart index d3d6c312..8ac28e76 100644 --- a/packages/stream_chat_flutter_core/lib/src/channel_list_core.dart +++ b/packages/stream_chat_flutter_core/lib/src/channel_list_core.dart @@ -56,7 +56,7 @@ import 'package:stream_chat_flutter_core/src/typedef.dart'; /// information about the channels. class ChannelListCore extends StatefulWidget { /// Instantiate a new ChannelListView - ChannelListCore({ + const ChannelListCore({ Key? key, required this.errorBuilder, required this.emptyBuilder, @@ -69,15 +69,9 @@ class ChannelListCore extends StatefulWidget { this.memberLimit, this.messageLimit, this.sort, - @Deprecated( - "'pagination' is deprecated and shouldn't be used. " - "This property is no longer used, Please use 'limit' instead", - ) - this.pagination, this.channelListController, - int? limit, - }) : limit = limit ?? pagination?.limit ?? 25, - super(key: key); + this.limit = 25, + }) : super(key: key); /// A [ChannelListController] allows reloading and pagination. /// Use [ChannelListController.loadData] and @@ -124,16 +118,6 @@ class ChannelListCore extends StatefulWidget { /// Number of messages to fetch in each channel final int? messageLimit; - /// Pagination parameters - /// limit: the number of channels to return (max is 30) - /// offset: the offset (max is 1000) - /// message_limit: how many messages should be included to each channel - @Deprecated( - "'pagination' is deprecated and shouldn't be used. " - "This property is no longer used, Please use 'limit' instead", - ) - final PaginationParams? pagination; - /// The amount of channels requested per API call. final int limit; diff --git a/packages/stream_chat_flutter_core/lib/src/user_list_core.dart b/packages/stream_chat_flutter_core/lib/src/user_list_core.dart index 839067bf..05e9730b 100644 --- a/packages/stream_chat_flutter_core/lib/src/user_list_core.dart +++ b/packages/stream_chat_flutter_core/lib/src/user_list_core.dart @@ -57,7 +57,7 @@ import 'package:stream_chat_flutter_core/stream_chat_flutter_core.dart'; /// [errorBuilder] must all be supplied and not null. class UserListCore extends StatefulWidget { /// Instantiate a new [UserListCore] - UserListCore({ + const UserListCore({ required this.errorBuilder, required this.emptyBuilder, required this.loadingBuilder, @@ -66,16 +66,10 @@ class UserListCore extends StatefulWidget { this.filter = const Filter.empty(), this.sort, this.presence, - @Deprecated( - "'pagination' is deprecated and shouldn't be used. " - "This property is no longer used, Please use 'limit' instead", - ) - this.pagination, this.groupAlphabetically = false, this.userListController, - int? limit, - }) : limit = limit ?? pagination?.limit ?? 30, - super(key: key); + this.limit = 30, + }) : super(key: key); /// A [UserListController] allows reloading and pagination. /// Use [UserListController.loadData] and [UserListController.paginateData] @@ -97,8 +91,7 @@ class UserListCore extends StatefulWidget { /// The query filters to use. /// You can query on any of the custom fields you've defined on the [Channel]. /// You can also filter other built-in channel fields. - // TODO: Make it non-nullable in a future breaking release - final Filter? filter; + final Filter filter; /// The sorting used for the channels matching the filters. /// Sorting is based on field and direction, multiple sorting options can be @@ -109,16 +102,6 @@ class UserListCore extends StatefulWidget { /// If true you’ll receive user presence updates via the websocket events final bool? presence; - /// Pagination parameters - /// limit: the number of users to return (max is 30) - /// offset: the offset (max is 1000) - /// message_limit: how many messages should be included to each channel - @Deprecated( - "'pagination' is deprecated and shouldn't be used. " - "This property is no longer used, Please use 'limit' instead", - ) - final PaginationParams? pagination; - /// The amount of users requested per API call. final int limit;