@stream-io/feeds-client 0.1.9 → 0.1.11

package/index.ts

@@ -1,5 +1,5 @@
-export * from './src/FeedsClient';
-export * from './src/Feed';
+export * from './src/feeds-client';
+export * from './src/feed/feed';
 export * from './src/gen/models';
 export * from './src/types';
 export * from './src/common/types';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/feeds-client",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "packageManager": "yarn@3.2.4",
   "main": "./dist/index.node.js",
   "exports": {
@@ -67,6 +67,7 @@
     "@types/react": "^19.1.8",
     "@vitest/coverage-v8": "3.2.4",
     "dotenv": "^16.4.5",
+    "human-id": "^4.1.1",
     "react": "19.0.0",
     "rimraf": "^6.0.1",
     "rollup": "^4.24.0",

package/src/common/ActivitySearchSource.ts

@@ -1,18 +1,12 @@
 import { BaseSearchSource } from './BaseSearchSource';
 import type { SearchSourceOptions } from './BaseSearchSource';
 
-import { FeedsClient } from '../FeedsClient';
+import { FeedsClient } from '../feeds-client';
 import { ActivityResponse } from '../gen/models';
 
 export class ActivitySearchSource extends BaseSearchSource<ActivityResponse> {
   readonly type = 'activity' as const;
   private readonly client: FeedsClient;
-  // messageSearchChannelFilters: ChannelFilters | undefined;
-  // messageSearchFilters: MessageFilters | undefined;
-  // messageSearchSort: SearchMessageSort | undefined;
-  // channelQueryFilters: ChannelFilters | undefined;
-  // channelQuerySort: ChannelSort | undefined;
-  // channelQueryOptions: Omit<ChannelOptions, 'limit' | 'offset'> | undefined;
 
   constructor(client: FeedsClient, options?: SearchSourceOptions) {
     super(options);
@@ -20,12 +14,15 @@ export class ActivitySearchSource extends BaseSearchSource<ActivityResponse> {
   }
 
   protected async query(searchQuery: string) {
-    const { connected_user: connectedUser } = this.client.state.getLatestValue();
+    const { connected_user: connectedUser } =
+      this.client.state.getLatestValue();
     if (!connectedUser) return { items: [] };
 
     const { activities: items, next } = await this.client.queryActivities({
       sort: [{ direction: -1, field: 'created_at' }],
-      filter: { text: { $autocomplete: searchQuery } },
+      ...(!this.allowEmptySearchString || searchQuery.length > 0
+        ? { filter: { text: { $autocomplete: searchQuery } } }
+        : {}),
       limit: 10,
       next: this.next ?? undefined,
     });
@@ -37,10 +34,3 @@ export class ActivitySearchSource extends BaseSearchSource<ActivityResponse> {
     return items;
   }
 }
-
-
-  // filter: {
-  //   'feed.name': { $autocomplete: searchQuery }
-  //   'feed.description': { $autocomplete: searchQuery }
-  //   'created_by.name': { $autocomplete: searchQuery }
-  // },

package/src/common/BaseSearchSource.ts

@@ -1,12 +1,10 @@
 import { StateStore } from './StateStore';
 import { debounce, type DebouncedFunc } from './utils';
 
-export type SearchSourceType =
-  | 'channels'
-  | 'users'
-  | 'messages'
-  | (string & {});
+export type SearchSourceType = 'activity' | 'user' | 'feed' | (string & {});
+
 export type QueryReturnValue<T> = { items: T[]; next?: string | null };
+
 export type DebounceOptions = {
   debounceMs: number;
 };
@@ -14,7 +12,6 @@ type DebouncedExecQueryFunction = DebouncedFunc<
   (searchString?: string) => Promise<void>
 >;
 
- 
 export interface SearchSource<T = any> {
   activate(): void;
 
@@ -46,7 +43,6 @@ export interface SearchSource<T = any> {
   readonly type: SearchSourceType;
 }
 
- 
 export type SearchSourceState<T = any> = {
   hasNext: boolean;
   isActive: boolean;
@@ -61,24 +57,28 @@ export type SearchSourceOptions = {
   /** The number of milliseconds to debounce the search query. The default interval is 300ms. */
   debounceMs?: number;
   pageSize?: number;
+  allowEmptySearchString?: boolean;
 };
 const DEFAULT_SEARCH_SOURCE_OPTIONS: Required<SearchSourceOptions> = {
   debounceMs: 300,
   pageSize: 10,
+  allowEmptySearchString: false,
 } as const;
 
 export abstract class BaseSearchSource<T> implements SearchSource<T> {
   state: StateStore<SearchSourceState<T>>;
   protected pageSize: number;
+  protected allowEmptySearchString: boolean;
   abstract readonly type: SearchSourceType;
   protected searchDebounced!: DebouncedExecQueryFunction;
 
   protected constructor(options?: SearchSourceOptions) {
-    const { debounceMs, pageSize } = {
+    const { debounceMs, pageSize, allowEmptySearchString } = {
       ...DEFAULT_SEARCH_SOURCE_OPTIONS,
       ...options,
     };
     this.pageSize = pageSize;
+    this.allowEmptySearchString = allowEmptySearchString;
     this.state = new StateStore<SearchSourceState<T>>(this.initialState);
     this.setDebounceOptions({ debounceMs });
   }
@@ -157,7 +157,7 @@ export abstract class BaseSearchSource<T> implements SearchSource<T> {
       this.isActive &&
       !this.isLoading &&
       (this.hasNext || hasNewSearchQuery) &&
-      searchString
+      (this.allowEmptySearchString || searchString)
     );
   };
 

package/src/common/FeedSearchSource.ts

@@ -1,88 +1,43 @@
 import { BaseSearchSource } from './BaseSearchSource';
 import type { SearchSourceOptions } from './BaseSearchSource';
 
-import { FeedsClient } from '../FeedsClient';
-import { Feed } from '../Feed';
+import { FeedsClient } from '../feeds-client';
+import { Feed } from '../feed';
+
+export type FeedSearchSourceOptions = SearchSourceOptions & {
+  groupId?: string;
+};
 
 export class FeedSearchSource extends BaseSearchSource<Feed> {
   readonly type = 'feed' as const;
   private readonly client: FeedsClient;
-  // messageSearchChannelFilters: ChannelFilters | undefined;
-  // messageSearchFilters: MessageFilters | undefined;
-  // messageSearchSort: SearchMessageSort | undefined;
-  // channelQueryFilters: ChannelFilters | undefined;
-  // channelQuerySort: ChannelSort | undefined;
-  // channelQueryOptions: Omit<ChannelOptions, 'limit' | 'offset'> | undefined;
+  private readonly feedGroupId?: string | undefined;
 
-  constructor(client: FeedsClient, options?: SearchSourceOptions) {
+  constructor(client: FeedsClient, options?: FeedSearchSourceOptions) {
     super(options);
     this.client = client;
+    this.feedGroupId = options?.groupId;
   }
 
   protected async query(searchQuery: string) {
-    const { connected_user: connectedUser } = this.client.state.getLatestValue();
+    const { connected_user: connectedUser } =
+      this.client.state.getLatestValue();
     if (!connectedUser) return { items: [] };
 
-    // const channelFilters: ChannelFilters = {
-    //   members: { $in: [this.client.userID] },
-    //   ...this.messageSearchChannelFilters,
-    // } as ChannelFilters;
-
-    // const messageFilters: MessageFilters = {
-    //   text: searchQuery,
-    //   type: 'regular', // FIXME: type: 'reply' resp. do not filter by type and allow to jump to a message in a thread - missing support
-    //   ...this.messageSearchFilters,
-    // } as MessageFilters;
-
-    // const sort: SearchMessageSort = {
-    //   created_at: -1,
-    //   ...this.messageSearchSort,
-    // };
-
-    // const options = {
-    //   limit: this.pageSize,
-    //   next: this.next,
-    //   sort,
-    // } as SearchOptions;
-
-    // const { next, results } = await this.client.search(
-    //   channelFilters,
-    //   messageFilters,
-    //   options,
-    // );
-    // const items = results.map(({ message }) => message);
-
-    // const cids = Array.from(
-    //   items.reduce((acc, message) => {
-    //     if (message.cid && !this.client.activeChannels[message.cid])
-    //       acc.add(message.cid);
-    //     return acc;
-    //   }, new Set<string>()), // keep the cids unique
-    // );
-    // const allChannelsLoadedLocally = cids.length === 0;
-    // if (!allChannelsLoadedLocally) {
-    //   await this.client.queryChannels(
-    //     {
-    //       cid: { $in: cids },
-    //       ...this.channelQueryFilters,
-    //     } as ChannelFilters,
-    //     {
-    //       last_message_at: -1,
-    //       ...this.channelQuerySort,
-    //     },
-    //     this.channelQueryOptions,
-    //   );
-    // }
-
     const { feeds: items, next } = await this.client.queryFeeds({
       filter: {
-        group_id: 'user',
-        $or: [
-          { name: { $autocomplete: searchQuery } },
-          { description: { $autocomplete: searchQuery } },
-          { 'created_by.name': { $autocomplete: searchQuery } },
-        ],
+        ...(this.feedGroupId ? { group_id: this.feedGroupId } : {}),
+        ...(!this.allowEmptySearchString || searchQuery.length > 0
+          ? {
+              $or: [
+                { name: { $autocomplete: searchQuery } },
+                { description: { $autocomplete: searchQuery } },
+                { 'created_by.name': { $autocomplete: searchQuery } },
+              ],
+            }
+          : {}),
       },
+      next: this.next ?? undefined,
     });
 
     return { items, next };

package/src/common/Poll.ts

@@ -1,5 +1,5 @@
 import { StateStore } from './StateStore';
-import type { FeedsClient } from '../FeedsClient';
+import type { FeedsClient } from '../feeds-client';
 import type {
   PollVote,
   QueryPollVotesRequest,

package/src/common/SearchController.ts

@@ -23,6 +23,8 @@ export class SearchController {
   /**
    * Not intended for direct use by integrators, might be removed without notice resulting in
    * broken integrations.
+   *
+   * @internal
    */
   _internalState: StateStore<InternalSearchControllerState>;
   state: StateStore<SearchControllerState>;

package/src/common/UserSearchSource.ts

@@ -1,18 +1,12 @@
 import { BaseSearchSource } from './BaseSearchSource';
 import type { SearchSourceOptions } from './BaseSearchSource';
 
-import { FeedsClient } from '../FeedsClient';
+import { FeedsClient } from '../feeds-client';
 import { UserResponse } from '../gen/models';
 
 export class UserSearchSource extends BaseSearchSource<UserResponse> {
   readonly type = 'user' as const;
   private readonly client: FeedsClient;
-  // messageSearchChannelFilters: ChannelFilters | undefined;
-  // messageSearchFilters: MessageFilters | undefined;
-  // messageSearchSort: SearchMessageSort | undefined;
-  // channelQueryFilters: ChannelFilters | undefined;
-  // channelQuerySort: ChannelSort | undefined;
-  // channelQueryOptions: Omit<ChannelOptions, 'limit' | 'offset'> | undefined;
 
   constructor(client: FeedsClient, options?: SearchSourceOptions) {
     super(options);
@@ -20,66 +14,20 @@ export class UserSearchSource extends BaseSearchSource<UserResponse> {
   }
 
   protected async query(searchQuery: string) {
-    const { connected_user: connectedUser } = this.client.state.getLatestValue();
+    const { connected_user: connectedUser } =
+      this.client.state.getLatestValue();
     if (!connectedUser) return { items: [] };
 
-    // const channelFilters: ChannelFilters = {
-    //   members: { $in: [this.client.userID] },
-    //   ...this.messageSearchChannelFilters,
-    // } as ChannelFilters;
-
-    // const messageFilters: MessageFilters = {
-    //   text: searchQuery,
-    //   type: 'regular', // FIXME: type: 'reply' resp. do not filter by type and allow to jump to a message in a thread - missing support
-    //   ...this.messageSearchFilters,
-    // } as MessageFilters;
-
-    // const sort: SearchMessageSort = {
-    //   created_at: -1,
-    //   ...this.messageSearchSort,
-    // };
-
-    // const options = {
-    //   limit: this.pageSize,
-    //   next: this.next,
-    //   sort,
-    // } as SearchOptions;
-
-    // const { next, results } = await this.client.search(
-    //   channelFilters,
-    //   messageFilters,
-    //   options,
-    // );
-    // const items = results.map(({ message }) => message);
-
-    // const cids = Array.from(
-    //   items.reduce((acc, message) => {
-    //     if (message.cid && !this.client.activeChannels[message.cid])
-    //       acc.add(message.cid);
-    //     return acc;
-    //   }, new Set<string>()), // keep the cids unique
-    // );
-    // const allChannelsLoadedLocally = cids.length === 0;
-    // if (!allChannelsLoadedLocally) {
-    //   await this.client.queryChannels(
-    //     {
-    //       cid: { $in: cids },
-    //       ...this.channelQueryFilters,
-    //     } as ChannelFilters,
-    //     {
-    //       last_message_at: -1,
-    //       ...this.channelQuerySort,
-    //     },
-    //     this.channelQueryOptions,
-    //   );
-    // }
-
     const { users: items } = await this.client.queryUsers({
       payload: {
         filter_conditions: {
-          name: {
-            $autocomplete: searchQuery,
-          },
+          ...(!this.allowEmptySearchString || searchQuery.length > 0
+            ? {
+                name: {
+                  $autocomplete: searchQuery,
+                },
+              }
+            : {}),
         },
       },
     });

package/src/{state-updates → feed/event-handlers/activity}/activity-reaction-utils.test.ts

@@ -4,13 +4,13 @@ import {
   ActivityReactionDeletedEvent,
   ActivityResponse,
   FeedsReactionResponse,
-} from '../gen/models';
+} from '../../../gen/models';
 import {
   addReactionToActivity,
   removeReactionFromActivity,
   addReactionToActivities,
   removeReactionFromActivities,
-} from './activity-reaction-utils';
+} from './';
 
 const createMockActivity = (id: string): ActivityResponse => ({
   id,
@@ -109,6 +109,7 @@ describe('activity-reaction-utils', () => {
           count: 1,
           first_reaction_at: reaction.created_at,
           last_reaction_at: reaction.created_at,
+          sum_scores: 0,
         },
       };
 
@@ -123,6 +124,7 @@ describe('activity-reaction-utils', () => {
         count: 1,
         first_reaction_at: reaction.created_at,
         last_reaction_at: reaction.created_at,
+        sum_scores: 0,
       });
     });
 
@@ -136,6 +138,7 @@ describe('activity-reaction-utils', () => {
           count: 1,
           first_reaction_at: reaction.created_at,
           last_reaction_at: reaction.created_at,
+          sum_scores: 0,
         },
       };
       const event = createMockAddedEvent(reaction, eventActivity);
@@ -150,6 +153,7 @@ describe('activity-reaction-utils', () => {
         count: 1,
         first_reaction_at: reaction.created_at,
         last_reaction_at: reaction.created_at,
+        sum_scores: 0,
       });
     });
   });
@@ -165,6 +169,7 @@ describe('activity-reaction-utils', () => {
           count: 1,
           first_reaction_at: reaction.created_at,
           last_reaction_at: reaction.created_at,
+          sum_scores: 0,
         },
       };
       const event = createMockAddedEvent(reaction, eventActivity);
@@ -196,6 +201,7 @@ describe('activity-reaction-utils', () => {
           count: 1,
           first_reaction_at: reaction.created_at,
           last_reaction_at: reaction.created_at,
+          sum_scores: 0,
         },
       };
       const event = createMockAddedEvent(reaction, eventActivity);
@@ -230,6 +236,7 @@ describe('activity-reaction-utils', () => {
           count: 1,
           first_reaction_at: reaction.created_at,
           last_reaction_at: reaction.created_at,
+          sum_scores: 0,
         },
       };
       const event = createMockAddedEvent(reaction, eventActivity);
@@ -253,6 +260,7 @@ describe('activity-reaction-utils', () => {
           count: 1,
           first_reaction_at: reaction.created_at,
           last_reaction_at: reaction.created_at,
+          sum_scores: 0,
         },
       };
       const event = createMockAddedEvent(reaction, eventActivity);
@@ -274,6 +282,7 @@ describe('activity-reaction-utils', () => {
           count: 1,
           first_reaction_at: reaction.created_at,
           last_reaction_at: reaction.created_at,
+          sum_scores: 0,
         },
       };
       const event = createMockAddedEvent(reaction, eventActivity);
@@ -296,6 +305,7 @@ describe('activity-reaction-utils', () => {
           count: 1,
           first_reaction_at: reaction.created_at,
           last_reaction_at: reaction.created_at,
+          sum_scores: 0,
         },
       };
       const event = createMockAddedEvent(reaction, eventActivity);

package/src/{state-updates → feed/event-handlers/activity}/activity-utils.test.ts

@@ -1,10 +1,10 @@
 import { describe, it, expect } from 'vitest';
-import { ActivityResponse, FeedsReactionResponse } from '../gen/models';
+import { ActivityResponse, FeedsReactionResponse } from '../../../gen/models';
 import {
   addActivitiesToState,
   updateActivityInState,
   removeActivityFromState,
-} from './activity-utils';
+} from './';
 
 const createMockActivity = (id: string, text?: string): ActivityResponse =>
   ({
@@ -181,6 +181,7 @@ describe('activity-utils', () => {
       ];
       originalActivity.reaction_groups = {
         like: {
+          sum_scores: 0,
           count: 1,
           first_reaction_at: new Date(),
           last_reaction_at: new Date(),

package/src/{state-updates/activity-utils.ts → feed/event-handlers/activity/handle-activity-added.ts}

@@ -1,5 +1,6 @@
-import { ActivityResponse } from '../gen/models';
-import { UpdateStateResult } from '../types-internal';
+import { Feed } from '../../../feed';
+import { ActivityResponse } from '../../../gen/models';
+import { EventPayload, UpdateStateResult } from '../../../types-internal';
 
 export const addActivitiesToState = (
   newActivities: ActivityResponse[],
@@ -42,39 +43,18 @@ export const addActivitiesToState = (
   return result;
 };
 
-export const updateActivityInState = (
-  updatedActivityResponse: ActivityResponse,
-  activities: ActivityResponse[],
-) => {
-  const index = activities.findIndex(
-    (a) => a.id === updatedActivityResponse.id,
+export function handleActivityAdded(
+  this: Feed,
+  event: EventPayload<'feeds.activity.added'>,
+) {
+  const currentActivities = this.currentState.activities;
+  const result = addActivitiesToState(
+    [event.activity],
+    currentActivities,
+    'start',
   );
-  if (index !== -1) {
-    const newActivities = [...activities];
-    const activity = activities[index];
-    newActivities[index] = {
-      ...updatedActivityResponse,
-      own_reactions: activity.own_reactions,
-      own_bookmarks: activity.own_bookmarks,
-      latest_reactions: activity.latest_reactions,
-      reaction_groups: activity.reaction_groups,
-    };
-    return { changed: true, activities: newActivities };
-  } else {
-    return { changed: false, activities };
+  if (result.changed) {
+    this.client.hydratePollCache([event.activity]);
+    this.state.partialNext({ activities: result.activities });
   }
-};
-
-export const removeActivityFromState = (
-  activityResponse: ActivityResponse,
-  activities: ActivityResponse[],
-) => {
-  const index = activities.findIndex((a) => a.id === activityResponse.id);
-  if (index !== -1) {
-    const newActivities = [...activities];
-    newActivities.splice(index, 1);
-    return { changed: true, activities: newActivities };
-  } else {
-    return { changed: false, activities };
-  }
-};
+}

package/src/feed/event-handlers/activity/handle-activity-deleted.ts

@@ -0,0 +1,30 @@
+import type { Feed } from '../../../feed';
+import type { ActivityResponse } from '../../../gen/models';
+import type { EventPayload } from '../../../types-internal';
+
+export const removeActivityFromState = (
+  activityResponse: ActivityResponse,
+  activities: ActivityResponse[],
+) => {
+  const index = activities.findIndex((a) => a.id === activityResponse.id);
+  if (index !== -1) {
+    const newActivities = [...activities];
+    newActivities.splice(index, 1);
+    return { changed: true, activities: newActivities };
+  } else {
+    return { changed: false, activities };
+  }
+};
+
+export function handleActivityDeleted(
+  this: Feed,
+  event: EventPayload<'feeds.activity.deleted'>,
+) {
+  const currentActivities = this.currentState.activities;
+  if (currentActivities) {
+    const result = removeActivityFromState(event.activity, currentActivities);
+    if (result.changed) {
+      this.state.partialNext({ activities: result.activities });
+    }
+  }
+}

package/src/feed/event-handlers/activity/handle-activity-reaction-added.ts

@@ -0,0 +1,67 @@
+import type { Feed } from '../../../feed';
+import type {
+  ActivityReactionAddedEvent,
+  ActivityResponse,
+} from '../../../gen/models';
+import type { EventPayload, UpdateStateResult } from '../../../types-internal';
+
+import { updateActivityInState } from './handle-activity-updated';
+
+export const addReactionToActivity = (
+  event: ActivityReactionAddedEvent,
+  activity: ActivityResponse,
+  isCurrentUser: boolean,
+): UpdateStateResult<ActivityResponse> => {
+  // Update own_reactions if the reaction is from the current user
+  const ownReactions = [...(activity.own_reactions || [])];
+  if (isCurrentUser) {
+    ownReactions.push(event.reaction);
+  }
+
+  return {
+    ...activity,
+    own_reactions: ownReactions,
+    latest_reactions: event.activity.latest_reactions,
+    reaction_groups: event.activity.reaction_groups,
+    changed: true,
+  };
+};
+
+export const addReactionToActivities = (
+  event: ActivityReactionAddedEvent,
+  activities: ActivityResponse[] | undefined,
+  isCurrentUser: boolean,
+): UpdateStateResult<{ activities: ActivityResponse[] }> => {
+  if (!activities) {
+    return { changed: false, activities: [] };
+  }
+
+  const activityIndex = activities.findIndex((a) => a.id === event.activity.id);
+  if (activityIndex === -1) {
+    return { changed: false, activities };
+  }
+
+  const activity = activities[activityIndex];
+  const updatedActivity = addReactionToActivity(event, activity, isCurrentUser);
+  return updateActivityInState(updatedActivity, activities, true);
+};
+
+export function handleActivityReactionAdded(
+  this: Feed,
+  event: EventPayload<'feeds.activity.reaction.added'>,
+) {
+  const currentActivities = this.currentState.activities;
+  const connectedUser = this.client.state.getLatestValue().connected_user;
+  const isCurrentUser = Boolean(
+    connectedUser && event.reaction.user.id === connectedUser.id,
+  );
+
+  const result = addReactionToActivities(
+    event,
+    currentActivities,
+    isCurrentUser,
+  );
+  if (result.changed) {
+    this.state.partialNext({ activities: result.activities });
+  }
+}