@stream-io/feeds-client 0.1.9 → 0.1.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/feeds-client",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "packageManager": "yarn@3.2.4",
   "main": "./dist/index.node.js",
   "exports": {

package/src/common/ActivitySearchSource.ts

@@ -7,12 +7,6 @@ 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

@@ -4,85 +4,40 @@ import type { SearchSourceOptions } from './BaseSearchSource';
 import { FeedsClient } from '../FeedsClient';
 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/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

@@ -7,12 +7,6 @@ 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,
+                },
+              }
+            : {}),
         },
       },
     });