stream-chat 9.50.3 → 10.0.0-rc.2

package/src/reminders/ReminderManager.ts

@@ -8,10 +8,9 @@ import type { StreamChat } from '../client';
 import type {
   CreateReminderOptions,
   Event,
-  EventTypes,
+  EventPayload,
   LocalMessage,
   MessageResponse,
-  ReminderResponse,
 } from '../types';
 
 const oneMinute = 60 * 1000;
@@ -38,14 +37,9 @@ const isReminderDoesNotExistError = (error: Error) =>
 
 type MessageId = string;
 
-export type ReminderEvent = {
-  cid: string;
-  created_at: string;
-  message_id: MessageId;
-  reminder: ReminderResponse;
-  type: EventTypes;
-  user_id: string;
-};
+export type ReminderEvent = EventPayload<
+  `reminder.${string}` | 'notification.reminder_due'
+>;
 
 export type ReminderManagerState = {
   reminders: Map<MessageId, Reminder>;
@@ -167,6 +161,7 @@ export class ReminderManager extends WithSubscriptions {
 
   // WS event handling START //
   static isReminderWsEventPayload = (event: Event): event is ReminderEvent =>
+    'reminder' in event &&
     !!event.reminder &&
     (event.type.startsWith('reminder.') || event.type === 'notification.reminder_due');
 
@@ -186,14 +181,17 @@ export class ReminderManager extends WithSubscriptions {
     this.client.on('reminder.created', (event) => {
       if (!ReminderManager.isReminderWsEventPayload(event)) return;
       const { reminder } = event;
-      this.upsertToState({ data: reminder });
+      // TODO: OAPI discrepancy?
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      this.upsertToState({ data: reminder! });
     }).unsubscribe;
 
   private subscribeReminderUpdated = () =>
     this.client.on('reminder.updated', (event) => {
       if (!ReminderManager.isReminderWsEventPayload(event)) return;
       const { reminder } = event;
-      this.upsertToState({ data: reminder });
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      this.upsertToState({ data: reminder! });
     }).unsubscribe;
 
   private subscribeReminderDeleted = () =>
@@ -249,8 +247,8 @@ export class ReminderManager extends WithSubscriptions {
 
   // API calls START //
   upsertReminder = async (options: CreateReminderOptions) => {
-    const { messageId } = options;
-    if (this.getFromState(messageId)) {
+    const { message_id } = options;
+    if (this.getFromState(message_id)) {
       try {
         return await this.updateReminder(options);
       } catch (error) {
@@ -272,26 +270,26 @@ export class ReminderManager extends WithSubscriptions {
   };
 
   createReminder = async (options: CreateReminderOptions) => {
-    const { reminder } = await this.client.createReminder(options);
-    return this.upsertToState({ data: reminder, overwrite: false });
+    const response = await this.client.createReminder(options);
+    return this.upsertToState({ data: response, overwrite: false });
   };
 
   updateReminder = async (options: CreateReminderOptions) => {
-    const { reminder } = await this.client.updateReminder(options);
-    return this.upsertToState({ data: reminder });
+    const response = await this.client.updateReminder(options);
+    return this.upsertToState({ data: response.reminder });
   };
 
   deleteReminder = async (messageId: MessageId) => {
-    await this.client.deleteReminder(messageId);
+    await this.client.deleteReminder({ message_id: messageId });
     this.removeFromState(messageId);
   };
 
   queryNextReminders = async () => {
-    await this.paginator.next();
+    await this.paginator.toTail();
   };
 
   queryPreviousReminders = async () => {
-    await this.paginator.prev();
+    await this.paginator.toHead();
   };
 
   // API calls END //

package/src/search/BaseSearchSource.ts

@@ -14,7 +14,6 @@ export type DebounceOptions = {
 };
 type DebouncedExecQueryFunction = DebouncedFunc<(searchString?: string) => Promise<void>>;
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 interface ISearchSource<T = any> {
   activate(): void;
 
@@ -40,14 +39,12 @@ interface ISearchSource<T = any> {
   readonly type: SearchSourceType;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export interface SearchSource<T = any> extends ISearchSource<T> {
   cancelScheduledQuery(): void;
   setDebounceOptions(options: DebounceOptions): void;
   search(text?: string): Promise<void> | undefined;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export interface SearchSourceSync<T = any> extends ISearchSource<T> {
   cancelScheduledQuery(): void;
   setDebounceOptions(options: DebounceOptions): void;

package/src/search/ChannelMemberSearchSource.ts

@@ -75,7 +75,13 @@ export class ChannelMemberSearchSource<
     });
     const sort = this.sort ?? [];
     const options = { ...this.searchOptions, limit: this.pageSize, offset: this.offset };
-    const { members } = await this.channel.queryMembers(filters ?? {}, sort, options);
+    const { members } = await this.channel.queryMembers({
+      payload: {
+        filter_conditions: filters ?? {},
+        sort,
+        ...options,
+      },
+    });
     return { items: members };
   }
 

package/src/search/ChannelSearchSource.ts

@@ -54,16 +54,23 @@ export class ChannelSearchSource<
   protected async query(searchQuery: string) {
     const filters = this.filterBuilder.buildFilters({
       baseFilters: {
-        ...(this.client.userID ? { members: { $in: [this.client.userID] } } : {}),
+        ...(this.client.userId ? { members: { $in: [this.client.userId] } } : {}),
         ...this.filters,
       },
       context: { searchQuery } as Partial<
         ChannelSearchSourceFilterBuilderContext<TFilterContext>
       >,
     });
-    const sort = this.sort ?? {};
+    const sort = this.sort;
     const options = { ...this.searchOptions, limit: this.pageSize, offset: this.offset };
-    const items = await this.client.queryChannels(filters, sort, options);
+    const items = await this.client.queryChannelsAndHydrate(
+      {
+        filter_conditions: filters,
+        sort,
+        ...options,
+      },
+      { withResponse: false },
+    );
     return { items };
   }
 

package/src/search/MessageSearchSource.ts

@@ -6,7 +6,7 @@ import type {
   MessageFilters,
   MessageResponse,
   SearchMessageSort,
-  SearchOptions,
+  SearchPayload,
 } from '../types';
 import type { StreamChat } from '../client';
 import type { SearchSourceOptions } from './types';
@@ -60,7 +60,7 @@ export class MessageSearchSource<
   readonly type = 'messages';
   private client: StreamChat;
 
-  messageSearchChannelFilters: ChannelFilters | undefined;
+  messageSearchChannelFilters: SearchPayload['filter_conditions'] | undefined;
   messageSearchFilters: MessageFilters | undefined;
   messageSearchSort: SearchMessageSort | undefined;
 
@@ -69,7 +69,7 @@ export class MessageSearchSource<
   channelQueryOptions: Omit<ChannelOptions, 'limit' | 'offset'> | undefined;
 
   messageSearchChannelFilterBuilder: FilterBuilder<
-    ChannelFilters,
+    SearchPayload['filter_conditions'],
     MergeContext<
       BuiltInContexts['messageSearchChannel'],
       TContexts['messageSearchChannelContext']
@@ -130,11 +130,11 @@ export class MessageSearchSource<
   }
 
   protected async query(searchQuery: string) {
-    if (!this.client.userID || this.next === null) return { items: [] };
+    if (!this.client.userId || this.next === null) return { items: [] };
 
     const channelFilters = this.messageSearchChannelFilterBuilder.buildFilters({
       baseFilters: {
-        ...(this.client.userID ? { members: { $in: [this.client.userID] } } : {}),
+        ...(this.client.userId ? { members: { $in: [this.client.userId] } } : {}),
         ...this.messageSearchChannelFilters,
       },
       context: { searchQuery } as Partial<
@@ -155,23 +155,25 @@ export class MessageSearchSource<
       >,
     });
 
-    const sort: SearchMessageSort = {
-      created_at: -1,
-      ...this.messageSearchSort,
-    };
-
-    const options: SearchOptions = {
-      limit: this.pageSize,
-      next: this.next,
-      sort,
-    };
-
-    const { next, results } = await this.client.search(
-      channelFilters,
-      messageFilters,
-      options,
-    );
-    const items = results.map(({ message }) => message);
+    const { next, results } = await this.client.search({
+      payload: {
+        filter_conditions: channelFilters,
+        message_filter_conditions: messageFilters,
+        limit: this.pageSize,
+        next: this.next,
+        sort: [
+          {
+            field: 'created_at',
+            direction: -1,
+          },
+          ...(this.messageSearchSort ?? []),
+        ],
+      },
+    });
+
+    const items = results
+      .map(({ message }) => message)
+      .filter((m): m is NonNullable<typeof m> => Boolean(m));
 
     const cids = Array.from(
       items.reduce((acc, message) => {
@@ -187,14 +189,11 @@ export class MessageSearchSource<
           MergeContext<BuiltInContexts['channelQuery'], TContexts['channelQueryContext']>
         >,
       });
-      await this.client.queryChannels(
-        channelQueryFilters,
-        {
-          last_message_at: -1,
-          ...this.channelQuerySort,
-        },
-        this.channelQueryOptions,
-      );
+      await this.client.queryChannelsAndHydrate({
+        filter_conditions: channelQueryFilters,
+        sort: [{ direction: -1, field: 'last_message_at' }],
+        ...this.channelQueryOptions,
+      });
     }
 
     return { items, next };

package/src/search/UserSearchSource.ts

@@ -60,15 +60,19 @@ export class UserSearchSource<
       baseFilters: this.filters,
       context: { searchQuery } as UserSearchSourceFilterBuilderContext<TFilterContext>,
     });
-    let sort: UserSort;
-    if (Array.isArray(this.sort)) {
-      const hasIdSort = this.sort.some((entry) => 'id' in entry);
-      sort = hasIdSort ? this.sort : [...this.sort, { id: 1 }];
-    } else {
-      sort = { id: 1, ...this.sort };
-    }
+    const baseSort = this.sort ?? [];
+    const hasIdSort = baseSort.some((entry) => entry.field === 'id');
+    const sort: UserSort = hasIdSort
+      ? baseSort
+      : [...baseSort, { field: 'id', direction: 1 }];
     const options = { ...this.searchOptions, limit: this.pageSize, offset: this.offset };
-    const { users } = await this.client.queryUsers(filters, sort, options);
+    const { users } = await this.client.queryUsers({
+      payload: {
+        filter_conditions: filters,
+        sort,
+        ...options,
+      },
+    });
     return { items: users };
   }
 

package/src/search/types.ts

@@ -1,4 +1,3 @@
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type SearchSourceState<T = any> = {
   hasNext: boolean;
   isActive: boolean;
@@ -11,12 +10,12 @@ export type SearchSourceState<T = any> = {
 };
 
 export type SearchSourceOptions = {
-  /** The number of milliseconds to debounce the search query. The default interval is 300ms. */
+  /** The number of milliseconds to debounce the search query (defaults to `300`). */
   debounceMs?: number;
   pageSize?: number;
-  /** When true, the source can execute queries with an empty search string. Defaults to false. */
+  /** When `true`, the source can execute queries with an empty search string (defaults to `false`). */
   allowEmptySearchString?: boolean;
-  /** When true, previously loaded items are cleared at the start of a new search query. Defaults to true. */
+  /** When `true`, previously loaded items are cleared at the start of a new search query (defaults to `true`). */
   resetOnNewSearchQuery?: boolean;
 };
 

package/src/segment.ts

@@ -1,95 +1 @@
-import type { StreamChat } from './client';
-import type {
-  QuerySegmentTargetsFilter,
-  SegmentData,
-  SegmentResponse,
-  SortParam,
-} from './types';
-
-type SegmentType = 'user' | 'channel';
-
-type SegmentUpdatableFields = {
-  description?: string;
-  filter?: {};
-  name?: string;
-};
-
-export class Segment {
-  type: SegmentType;
-  id: string | null;
-  client: StreamChat;
-  data?: SegmentData | SegmentResponse;
-
-  constructor(
-    client: StreamChat,
-    type: SegmentType,
-    id: string | null,
-    data?: SegmentData,
-  ) {
-    this.client = client;
-    this.type = type;
-    this.id = id;
-    this.data = data;
-  }
-
-  create() {
-    const body = {
-      name: this.data?.name,
-      filter: this.data?.filter,
-      description: this.data?.description,
-      all_sender_channels: this.data?.all_sender_channels,
-      all_users: this.data?.all_users,
-    };
-
-    return this.client.createSegment(this.type, this.id, body);
-  }
-
-  verifySegmentId() {
-    if (!this.id) {
-      throw new Error(
-        'Segment id is missing. Either create the segment using segment.create() or set the id during instantiation - const segment = client.segment(id)',
-      );
-    }
-  }
-
-  get() {
-    this.verifySegmentId();
-    return this.client.getSegment(this.id as string);
-  }
-
-  update(data: Partial<SegmentUpdatableFields>) {
-    this.verifySegmentId();
-
-    return this.client.updateSegment(this.id as string, data);
-  }
-
-  addTargets(targets: string[]) {
-    this.verifySegmentId();
-    return this.client.addSegmentTargets(this.id as string, targets);
-  }
-
-  removeTargets(targets: string[]) {
-    this.verifySegmentId();
-    return this.client.removeSegmentTargets(this.id as string, targets);
-  }
-
-  delete() {
-    this.verifySegmentId();
-    return this.client.deleteSegment(this.id as string);
-  }
-
-  targetExists(targetId: string) {
-    this.verifySegmentId();
-    return this.client.segmentTargetExists(this.id as string, targetId);
-  }
-
-  queryTargets(
-    filter: QuerySegmentTargetsFilter | null = {},
-    sort: SortParam[] | null | [] = [],
-    options = {},
-  ) {
-    this.verifySegmentId();
-
-    return this.client.querySegmentTargets(this.id as string, filter, sort, options);
-  }
-}
+// Segment functionality has been moved to the server-side SDK.