refactor(llc): refactor FilterField and SortField to support local filtering (#51)

Author: xsahil03x

docs/code_snippets/03_02_querying_activities.dart

@@ -5,7 +5,7 @@ late Feed feed;
 
 Future<void> activitySearchAndQueries() async {
   final query = ActivitiesQuery(
-    filter: const Filter.equal(ActivitiesFilterField.type, 'post'),
+    filter: Filter.equal(ActivitiesFilterField.type, 'post'),
     sort: [ActivitiesSort.desc(ActivitiesSortField.createdAt)],
     limit: 10,
   );
@@ -16,7 +16,7 @@ Future<void> activitySearchAndQueries() async {
 
 Future<void> queryActivitiesByText() async {
   // search for activities where the text includes the word 'popularity'.
-  const query = ActivitiesQuery(
+  final query = ActivitiesQuery(
     filter: Filter.equal(ActivitiesFilterField.text, 'popularity'),
   );
 
@@ -38,7 +38,7 @@ Future<void> queryActivitiesBySearchData() async {
   final activities = await activityList.get();
 
   // search for activities where the campaign took place in a mall
-  const query2 = ActivitiesQuery(
+  final query2 = ActivitiesQuery(
     filter: Filter.pathExists(
       ActivitiesFilterField.searchData,
       'campaign.location.mall',

docs/code_snippets/04_01_feeds.dart

@@ -34,8 +34,8 @@ Future<void> readingAFeed() async {
 }
 
 Future<void> readingAFeedMoreOptions() async {
-  const query = FeedQuery(
-    fid: FeedId(group: 'user', id: 'john'),
+  final query = FeedQuery(
+    fid: const FeedId.user('john'),
     // filter activities with filter tag green
     activityFilter: Filter.in_(
       ActivitiesFilterField.filterTags,
@@ -106,7 +106,7 @@ Future<void> filteringExamples() async {
     ],
   );
   // Now read the feed, this will fetch activity 1 and 2
-  const query = FeedQuery(
+  final query = FeedQuery(
     fid: feedId,
     activityFilter: Filter.in_(ActivitiesFilterField.filterTags, ['blue']),
   );
@@ -119,8 +119,8 @@ Future<void> filteringExamples() async {
 
 Future<void> moreComplexFilterExamples() async {
   // Get all the activities where filter tags contain both "green" and "orange"
-  const query = FeedQuery(
-    fid: FeedId(group: 'user', id: 'john'),
+  final query = FeedQuery(
+    fid: const FeedId.user('john'),
     activityFilter: Filter.and([
       Filter.in_(ActivitiesFilterField.filterTags, ['green']),
       Filter.in_(ActivitiesFilterField.filterTags, ['orange']),
@@ -190,7 +190,7 @@ Future<void> memberInvites() async {
 
 Future<void> queryMyFeeds() async {
   final query = FeedsQuery(
-    filter: const Filter.equal(FeedsFilterField.createdById, 'john'),
+    filter: Filter.equal(FeedsFilterField.createdById, 'john'),
     sort: [FeedsSort.desc(FeedsSortField.createdAt)],
     limit: 10,
     watch: true,
@@ -208,15 +208,15 @@ Future<void> queryMyFeeds() async {
 }
 
 Future<void> queryFeedsWhereIAmAMember() async {
-  const query = FeedsQuery(
+  final query = FeedsQuery(
     filter: Filter.contains(FeedsFilterField.members, 'john'),
   );
   final feedList = client.feedList(query);
   final feeds = await feedList.get();
 }
 
 Future<void> queryFeedsByNameOrVisibility() async {
-  const sportsQuery = FeedsQuery(
+  final sportsQuery = FeedsQuery(
     filter: Filter.and([
       Filter.equal(FeedsFilterField.visibility, 'public'),
       Filter.query(FeedsFilterField.name, 'Sports'),
@@ -226,7 +226,7 @@ Future<void> queryFeedsByNameOrVisibility() async {
   final sportsFeedList = client.feedList(sportsQuery);
   final sportsFeeds = await sportsFeedList.get();
 
-  const techQuery = FeedsQuery(
+  final techQuery = FeedsQuery(
     filter: Filter.and([
       Filter.equal(FeedsFilterField.visibility, 'public'),
       Filter.autoComplete(FeedsFilterField.description, 'tech'),
@@ -238,7 +238,7 @@ Future<void> queryFeedsByNameOrVisibility() async {
 }
 
 Future<void> queryFeedsByCreatorName() async {
-  const query = FeedsQuery(
+  final query = FeedsQuery(
     filter: Filter.and([
       Filter.equal(FeedsFilterField.visibility, 'public'),
       Filter.query(FeedsFilterField.createdByName, 'Thompson'),

docs/code_snippets/04_03_follows.dart

@@ -22,7 +22,7 @@ Future<void> followsAndUnfollows() async {
 Future<void> queryFollows() async {
   // Do I follow a list of feeds
   // My feed is timeline:john
-  const followQuery = FollowsQuery(
+  final followQuery = FollowsQuery(
     filter: Filter.and([
       Filter.equal(FollowsFilterField.sourceFeed, 'timeline:john'),
       Filter.in_(FollowsFilterField.targetFeed, ['user:sara', 'user:adam']),
@@ -34,7 +34,7 @@ Future<void> queryFollows() async {
   final page1And2 = followList.state.follows;
   // Paginating through followers for a feed
   // My feed is timeline:john
-  const followerQuery = FollowsQuery(
+  final followerQuery = FollowsQuery(
     filter: Filter.equal(FollowsFilterField.targetFeed, 'timeline:john'),
   );
   final followerList = client.followList(followerQuery);

docs/code_snippets/06_02_bookmarks.dart

@@ -49,14 +49,14 @@ Future<void> queryingBookmarks() async {
   final page2 = await bookmarkList.queryMoreBookmarks(limit: 3);
   // Query by activity ID
   final activityBookmarkList = client.bookmarkList(
-    const BookmarksQuery(
+    BookmarksQuery(
       filter: Filter.equal(BookmarksFilterField.activityId, 'activity_123'),
     ),
   );
   final activityBookmarks = await activityBookmarkList.get();
   // Query by folder ID
   final folderBookmarkList = client.bookmarkList(
-    const BookmarksQuery(
+    BookmarksQuery(
       filter: Filter.equal(BookmarksFilterField.folderId, 'folder_456'),
     ),
   );
@@ -72,8 +72,8 @@ Future<void> queryingBookmarkFolders() async {
   final page2 = await bookmarkFolderList.queryMoreBookmarkFolders(limit: 3);
   // Query by folder name (partial matching)
   final projectFolderList = client.bookmarkFolderList(
-    const BookmarkFoldersQuery(
-      filter: Filter.contains(BookmarkFoldersFilterField.name, 'project'),
+    BookmarkFoldersQuery(
+      filter: Filter.contains(BookmarkFoldersFilterField.folderName, 'project'),
     ),
   );
   final projectFolders = await projectFolderList.get();

docs/code_snippets/06_03_comments.dart

@@ -54,15 +54,15 @@ Future<void> readingComments() async {
 Future<void> queryingComments() async {
   // Search in comment texts
   final list1 = client.commentList(
-    const CommentsQuery(
+    CommentsQuery(
       filter: Filter.query(CommentsFilterField.commentText, 'oat'),
     ),
   );
   final comments1 = await list1.get();
 
   // All comments for an activity
   final list2 = client.commentList(
-    const CommentsQuery(
+    CommentsQuery(
       filter: Filter.and([
         Filter.equal(CommentsFilterField.objectId, 'activity_123'),
         Filter.equal(CommentsFilterField.objectType, 'activity'),
@@ -73,15 +73,15 @@ Future<void> queryingComments() async {
 
   // Replies to a parent activity
   final list3 = client.commentList(
-    const CommentsQuery(
+    CommentsQuery(
       filter: Filter.equal(CommentsFilterField.parentId, 'parent_id'),
     ),
   );
   final comments3 = await list3.get();
 
   // Comments from an user
   final list4 = client.commentList(
-    const CommentsQuery(
+    CommentsQuery(
       filter: Filter.equal(CommentsFilterField.userId, 'jane'),
     ),
   );

docs/code_snippets/09_01_polls.dart

@@ -132,7 +132,7 @@ Future<void> deletePollOption() async {
 Future<void> queryingVotes() async {
   // Retrieve all votes on either option1Id or option2Id
   final pollVoteList = client.pollVoteList(
-    const PollVotesQuery(
+    PollVotesQuery(
       pollId: 'poll_456',
       filter: Filter.in_(
         PollVotesFilterField.optionId,
@@ -148,7 +148,7 @@ Future<void> queryingVotes() async {
 Future<void> queryingPolls() async {
   // Retrieve all polls that are closed for voting sorted by created_at
   final pollList = client.pollList(
-    const PollsQuery(
+    PollsQuery(
       filter: Filter.equal(PollsFilterField.isClosed, true),
     ),
   );

melos.yaml

@@ -47,7 +47,7 @@ command:
       shared_preferences: ^2.5.3
       state_notifier: ^1.0.0
       stream_feeds: ^0.3.1
-      stream_core: ^0.2.0
+      stream_core: ^0.3.0
       video_player: ^2.10.0
       uuid: ^4.5.1
 

packages/stream_feeds/example/pubspec.yaml

@@ -11,8 +11,7 @@ dependencies:
   flutter:
     sdk: flutter
   flutter_state_notifier: ^1.0.0
-  stream_feeds: 
-    path: ../
+  stream_feeds: ^0.3.1
 
 dev_dependencies:
   flutter_test:

packages/stream_feeds/lib/src/feeds_client.dart

@@ -1,3 +1,4 @@
+import 'package:meta/meta.dart';
 import 'package:stream_core/stream_core.dart';
 
 import 'client/feeds_client_impl.dart';
@@ -160,6 +161,8 @@ abstract interface class StreamFeedsClient {
     NetworkStateProvider? networkStateProvider,
     LifecycleStateProvider? lifecycleStateProvider,
     List<AutomaticReconnectionPolicy>? reconnectionPolicies,
+    @visibleForTesting WebSocketProvider? wsProvider,
+    @visibleForTesting api.DefaultApi? feedsRestApi,
   }) = StreamFeedsClientImpl;
 
   User get user;

packages/stream_feeds/lib/src/models/get_or_create_feed_data.dart

@@ -1,7 +1,6 @@
 import 'package:freezed_annotation/freezed_annotation.dart';
 
 import '../generated/api/models.dart';
-import '../state/query/activities_query.dart';
 import 'activity_data.dart';
 import 'activity_pin_data.dart';
 import 'aggregated_activity_data.dart';
@@ -43,8 +42,7 @@ class GetOrCreateFeedData with _$GetOrCreateFeedData {
 
   /// The configuration used to query activities.
   @override
-  final QueryConfiguration<ActivitiesSort, ActivitiesFilterField>
-      activitiesQueryConfig;
+  final QueryConfiguration<ActivityData> activitiesQueryConfig;
 
   /// The feed data associated with the feed.
   @override