feat(llc): add support for location based filtering for activities (#66)

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: Filter.equal(ActivitiesFilterField.type, 'post'),
+    filter: Filter.equal(ActivitiesFilterField.activityType, 'post'),
     sort: [ActivitiesSort.desc(ActivitiesSortField.createdAt)],
     limit: 10,
   );

melos.yaml

@@ -48,7 +48,7 @@ command:
       shared_preferences: ^2.5.3
       state_notifier: ^1.0.0
       stream_feeds: ^0.4.0
-      stream_core: ^0.3.1
+      stream_core: ^0.3.2
       video_player: ^2.10.0
       uuid: ^4.5.1
 

packages/stream_feeds/CHANGELOG.md

@@ -1,6 +1,10 @@
 ## Upcoming
 - [BREAKING] Unified `ThreadedCommentData` into `CommentData` to handle both flat and threaded comments.
+- [BREAKING] Renamed `ActivitiesFilterField.type` to `ActivitiesFilterField.activityType`.
+- [BREAKING] Changed `ActivityData.location` field type from `ActivityLocation?` to `LocationCoordinate?`.
 - Add support for `enforceUnique` parameter while adding reactions.
+- Add location filtering support for activities with `ActivitiesFilterField.near` and `ActivitiesFilterField.withinBounds` filter fields.
+- Add new activity filter fields: `ActivitiesFilterField.feed` and `ActivitiesFilterField.interestTags`.
 
 ## 0.4.0
 - [BREAKING] Change `queryFollowSuggestions` return type to `List<FeedSuggestionData>`.

packages/stream_feeds/lib/src/feeds_client.dart

@@ -319,7 +319,7 @@ abstract interface class StreamFeedsClient {
   /// ```dart
   /// final activityList = client.activityList(ActivitiesQuery(
   ///   filter: Filter.and([
-  ///     Filter.equal(ActivitiesFilterField.type, 'post'),
+  ///     Filter.equal(ActivitiesFilterField.activityType, 'post'),
   ///     Filter.greaterThan(ActivitiesFilterField.createdAt,
   ///       DateTime.now().subtract(Duration(days: 7))),
   ///   ]),

packages/stream_feeds/lib/src/models.dart

@@ -1,3 +1,6 @@
+export 'package:stream_core/stream_core.dart'
+    show BoundingBox, CircularRegion, LocationCoordinate;
+
 export 'models/activity_data.dart';
 export 'models/aggregated_activity_data.dart';
 export 'models/bookmark_data.dart';

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

@@ -127,7 +127,7 @@ class ActivityData with _$ActivityData {
 
   /// Geographic location data associated with the activity, if any.
   @override
-  final ActivityLocation? location;
+  final LocationCoordinate? location;
 
   /// Users mentioned in the activity.
   @override
@@ -277,7 +277,12 @@ extension ActivityResponseMapper on ActivityResponse {
       interestTags: interestTags,
       isWatched: isWatched,
       latestReactions: [...latestReactions.map((r) => r.toModel())],
-      location: location,
+      location: location?.let(
+        (it) => LocationCoordinate(
+          latitude: it.lat,
+          longitude: it.lng,
+        ),
+      ),
       mentionedUsers: [...mentionedUsers.map((u) => u.toModel())],
       moderation: moderation?.toModel(),
       notificationContext: notificationContext,

packages/stream_feeds/lib/src/models/activity_data.freezed.dart

@@ -16,7 +16,7 @@ part 'activities_query.freezed.dart';
 /// ## Example
 /// ```dart
 /// final query = ActivitiesQuery(
-///   filter: Filter.equal(ActivitiesFilterField.type, "post"),
+///   filter: Filter.equal(ActivitiesFilterField.activityType, "post"),
 ///   sort: [ActivitiesSort.desc(ActivitiesSortField.createdAt)],
 ///   limit: 20,
 /// );
@@ -66,6 +66,14 @@ class ActivitiesFilterField extends FilterField<ActivityData> {
   /// Creates a new activities filter field.
   ActivitiesFilterField(super.remote, super.value);
 
+  /// Filter by the type of activity (e.g., "post", "comment", "reaction").
+  ///
+  /// **Supported operators:** `.equal`, `.in`
+  static final activityType = ActivitiesFilterField(
+    'activity_type',
+    (data) => data.type,
+  );
+
   /// Filter by the creation timestamp of the activity.
   ///
   /// **Supported operators:** `.equal`, `.greaterThan`, `.lessThan`, `.greaterThanOrEqual`, `.lessThanOrEqual`
@@ -76,7 +84,8 @@ class ActivitiesFilterField extends FilterField<ActivityData> {
 
   /// Filter by the expiration timestamp of the activity.
   ///
-  /// **Supported operators:** `.exists`
+  /// **Supported operators:** `.equal`, `.notEqual`, `.greaterThan`,
+  /// `.lessThan`, `.greaterThanOrEqual`, `.lessThanOrEqual`, `.exists`
   static final expiresAt = ActivitiesFilterField(
     'expires_at',
     (data) => data.expiresAt,
@@ -90,14 +99,30 @@ class ActivitiesFilterField extends FilterField<ActivityData> {
     (data) => data.id,
   );
 
+  /// Filter by the feed ID(s) the activity belongs to.
+  ///
+  /// **Supported operators:** `.equal`, `.in`
+  static final feed = ActivitiesFilterField(
+    'feed',
+    (data) => data.feeds,
+  );
+
   /// Filter by the filter tags associated with the activity.
   ///
-  /// **Supported operators:** `.equal`, `.in`, `.customContains`
+  /// **Supported operators:** `.equal`, `.in`, `.contains`
   static final filterTags = ActivitiesFilterField(
     'filter_tags',
     (data) => data.filterTags,
   );
 
+  /// Filter by the interest tags associated with the activity.
+  ///
+  /// **Supported operators:** `.equal`, `.in`, `.contains`
+  static final interestTags = ActivitiesFilterField(
+    'interest_tags',
+    (data) => data.interestTags,
+  );
+
   /// Filter by the popularity score of the activity.
   ///
   /// **Supported operators:** `.equal`, `.greaterThan`, `.lessThan`, `.greaterThanOrEqual`, `.lessThanOrEqual`
@@ -108,35 +133,49 @@ class ActivitiesFilterField extends FilterField<ActivityData> {
 
   /// Filter by the search data content of the activity.
   ///
-  /// **Supported operators:** `.equal`, `.customQ`, `.customAutocomplete`
+  /// **Supported operators:** `.contains`, `.in`, `.pathExists`
   static final searchData = ActivitiesFilterField(
     'search_data',
     (data) => data.searchData,
   );
 
   /// Filter by the text content of the activity.
   ///
-  /// **Supported operators:** `.equal`, `.customQ`, `.customAutocomplete`
+  /// **Supported operators:** `.equal`, `.q` (full-text search), `.autocomplete`
   static final text = ActivitiesFilterField(
     'text',
     (data) => data.text,
   );
 
-  /// Filter by the type of activity (e.g., "post", "comment", "reaction").
-  ///
-  /// **Supported operators:** `.equal`, `.in`
-  static final type = ActivitiesFilterField(
-    'type',
-    (data) => data.type,
-  );
-
   /// Filter by the user ID who created the activity.
   ///
   /// **Supported operators:** `.equal`, `.in`
   static final userId = ActivitiesFilterField(
     'user_id',
     (data) => data.user.id,
   );
+
+  /// Filter by the proximity to a specific location.
+  ///
+  /// Note: This requires an object with latitude ('lat'), longitude ('lng')
+  /// and distance in km ('distance).
+  ///
+  /// **Supported operators:** `.equal`
+  static final near = ActivitiesFilterField(
+    'near',
+    (data) => data.location,
+  );
+
+  /// Filter by activities within specific geographical bounds.
+  ///
+  /// Note: This requires an object with 'sw_lat', 'sw_lng' (southwest corner)
+  /// and 'ne_lat', 'ne_lng' (northeast) corner keys.
+  ///
+  /// **Supported operators:** `.equal`
+  static final withinBounds = ActivitiesFilterField(
+    'within_bounds',
+    (data) => data.location,
+  );
 }
 
 // endregion

packages/stream_feeds/lib/src/state/query/activities_query.dart

@@ -19,7 +19,7 @@ part 'feed_query.freezed.dart';
 /// ```dart
 /// final query = FeedQuery(
 ///   fid: FeedId(group: 'user', id: 'john'),
-///   activityFilter: Filter.equal(ActivitiesFilterField.type, 'post'),
+///   activityFilter: Filter.equal(ActivitiesFilterField.activityType, 'post'),
 ///   activityLimit: 25,
 ///   watch: true,
 /// );

packages/stream_feeds/lib/src/state/query/feed_query.dart

@@ -30,7 +30,7 @@ dependencies:
   retrofit: ">=4.6.0 <=4.9.0"
   rxdart: ^0.28.0
   state_notifier: ^1.0.0
-  stream_core: ^0.3.1
+  stream_core: ^0.3.2
   uuid: ^4.5.1
 
 dev_dependencies: