stream-chat 9.4.0 → 9.5.1

package/dist/types/types.d.ts

@@ -73,6 +73,7 @@ export type AppSettingsAPIResponse = APIResponse & {
             updated_at?: string;
             uploads?: boolean;
             url_enrichment?: boolean;
+            user_message_reminders?: boolean;
         }>;
         reminders_interval: number;
         async_moderation_config?: AsyncModerationOptions;
@@ -579,6 +580,7 @@ export type MessageResponseBase = MessageBase & {
     reaction_scores?: {
         [key: string]: number;
     } | null;
+    reminder?: ReminderResponseBase;
     reply_count?: number;
     shadowed?: boolean;
     status?: string;
@@ -855,6 +857,7 @@ export type CreateChannelOptions = {
     typing_events?: boolean;
     uploads?: boolean;
     url_enrichment?: boolean;
+    user_message_reminders?: boolean;
 };
 export type CreateCommandOptions = {
     description: string;
@@ -1258,6 +1261,7 @@ export type Event = CustomEventData & {
     offlineReactions?: ReactionResponse[];
     reaction?: ReactionResponse;
     received_at?: string | Date;
+    reminder?: ReminderResponse;
     shadow?: boolean;
     team?: string;
     thread?: ThreadResponse;
@@ -1816,6 +1820,7 @@ export type ChannelConfigFields = {
     typing_events?: boolean;
     uploads?: boolean;
     url_enrichment?: boolean;
+    user_message_reminders?: boolean;
 };
 export type ChannelConfigWithInfo = ChannelConfigFields & CreatedAtUpdatedAt & {
     commands?: CommandResponse[];
@@ -2909,6 +2914,44 @@ export type ThreadFilters = QueryFilters<{
 } & {
     last_message_at?: RequireOnlyOne<Pick<QueryFilter<ThreadResponse['last_message_at']>, '$eq' | '$gt' | '$lt' | '$gte' | '$lte'>> | PrimitiveFilter<ThreadResponse['last_message_at']>;
 }>;
+export type ReminderResponseBase = {
+    channel_cid: string;
+    created_at: string;
+    message_id: string;
+    updated_at: string;
+    user_id: string;
+    remind_at?: string;
+};
+export type ReminderResponse = ReminderResponseBase & {
+    user: UserResponse;
+    message: MessageResponse;
+};
+export type ReminderAPIResponse = APIResponse & {
+    reminder: ReminderResponse;
+};
+export type CreateReminderOptions = {
+    messageId: string;
+    remind_at?: string;
+    user_id?: string;
+};
+export type UpdateReminderOptions = CreateReminderOptions;
+export type ReminderFilters = QueryFilters<{
+    channel_cid?: RequireOnlyOne<Pick<QueryFilter<ReminderResponseBase['channel_cid']>, '$eq' | '$in'>> | PrimitiveFilter<ReminderResponseBase['channel_cid']>;
+    created_at?: RequireOnlyOne<Pick<QueryFilter<ReminderResponseBase['created_at']>, '$eq' | '$gt' | '$lt' | '$gte' | '$lte'>> | PrimitiveFilter<ReminderResponseBase['created_at']>;
+    message_id?: RequireOnlyOne<Pick<QueryFilter<ReminderResponseBase['message_id']>, '$eq' | '$in'>> | PrimitiveFilter<ReminderResponseBase['message_id']>;
+    remind_at?: RequireOnlyOne<Pick<QueryFilter<ReminderResponseBase['remind_at']>, '$eq' | '$gt' | '$lt' | '$gte' | '$lte'>> | PrimitiveFilter<ReminderResponseBase['remind_at']>;
+    user_id?: RequireOnlyOne<Pick<QueryFilter<ReminderResponseBase['user_id']>, '$eq' | '$in'>> | PrimitiveFilter<ReminderResponseBase['user_id']>;
+}>;
+export type ReminderSort = Sort<Pick<ReminderResponseBase, 'channel_cid' | 'created_at' | 'remind_at' | 'updated_at'>> | Array<Sort<Pick<ReminderResponseBase, 'channel_cid' | 'created_at' | 'remind_at' | 'updated_at'>>>;
+export type QueryRemindersOptions = Pager & {
+    filter?: ReminderFilters;
+    sort?: ReminderSort;
+};
+export type QueryRemindersResponse = {
+    reminders: ReminderResponse[];
+    prev?: string;
+    next?: string;
+};
 export type HookType = 'webhook' | 'sqs' | 'sns';
 export type EventHook = {
     id?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stream-chat",
-  "version": "9.4.0",
+  "version": "9.5.1",
   "description": "JS SDK for the Stream Chat API",
   "homepage": "https://getstream.io/chat/",
   "author": {

package/src/channel.ts

@@ -1325,7 +1325,7 @@ export class Channel {
    */
   countUnread(lastRead?: Date | null) {
     if (!lastRead) return this.state.unreadCount;
-
+    // todo: prevent finding the latest message set on each iteration
     let count = 0;
     for (let i = 0; i < this.state.latestMessages.length; i += 1) {
       const message = this.state.latestMessages[i];
@@ -1461,6 +1461,7 @@ export class Channel {
     };
 
     this.getClient().polls.hydratePollCache(state.messages, true);
+    this.getClient().reminders.hydrateState(state.messages);
 
     if (state.draft) {
       this.messageComposer.initState({ composition: state.draft });

package/src/client.ts

@@ -74,6 +74,7 @@ import type {
   CreatePollAPIResponse,
   CreatePollData,
   CreatePollOptionAPIResponse,
+  CreateReminderOptions,
   CustomPermissionOptions,
   DeactivateUsersOptions,
   DeleteChannelsResponse,
@@ -163,6 +164,8 @@ import type {
   QueryPollsResponse,
   QueryReactionsAPIResponse,
   QueryReactionsOptions,
+  QueryRemindersOptions,
+  QueryRemindersResponse,
   QuerySegmentsOptions,
   QuerySegmentTargetsFilter,
   QueryThreadsAPIResponse,
@@ -174,6 +177,7 @@ import type {
   ReactionSort,
   ReactivateUserOptions,
   ReactivateUsersOptions,
+  ReminderAPIResponse,
   ReviewFlagReportOptions,
   ReviewFlagReportResponse,
   SdkIdentifier,
@@ -206,6 +210,7 @@ import type {
   UpdateMessageOptions,
   UpdatePollAPIResponse,
   UpdatePollOptionAPIResponse,
+  UpdateReminderOptions,
   UpdateSegmentData,
   UpsertPushPreferencesResponse,
   UserCustomEvent,
@@ -228,6 +233,7 @@ import type {
 } from './channel_manager';
 import { ChannelManager } from './channel_manager';
 import { NotificationManager } from './notifications';
+import { ReminderManager } from './reminders';
 import { StateStore } from './store';
 import type { MessageComposer } from './messageComposer';
 import type { AbstractOfflineDB } from './offline-support';
@@ -268,6 +274,7 @@ export class StreamChat {
   polls: PollManager;
   offlineDb?: AbstractOfflineDB;
   notifications: NotificationManager;
+  reminders: ReminderManager;
   anonymous: boolean;
   persistUserOnConnectionFailure?: boolean;
   axiosInstance: AxiosInstance;
@@ -443,9 +450,9 @@ export class StreamChat {
      *
      * e.g.,
      * const client = new StreamChat('api_key', {}, {
-     * 		logger = (logLevel, message, extraData) => {
-     * 			console.log(message);
-     * 		}
+     *    logger = (logLevel, message, extraData) => {
+     *      console.log(message);
+     *    }
      * })
      *
      * extraData contains tags array attached to log message. Tags can have one/many of following values:
@@ -459,34 +466,35 @@ export class StreamChat {
      *
      * It may also contains some extra data, some examples have been mentioned below:
      * 1. {
-     * 		tags: ['api', 'api_request', 'client'],
-     * 		url: string,
-     * 		payload: object,
-     * 		config: object
+     *    tags: ['api', 'api_request', 'client'],
+     *    url: string,
+     *    payload: object,
+     *    config: object
      * }
      * 2. {
-     * 		tags: ['api', 'api_response', 'client'],
-     * 		url: string,
-     * 		response: object
+     *    tags: ['api', 'api_response', 'client'],
+     *    url: string,
+     *    response: object
      * }
      * 3. {
-     * 		tags: ['api', 'api_response', 'client'],
-     * 		url: string,
-     * 		error: object
+     *    tags: ['api', 'api_response', 'client'],
+     *    url: string,
+     *    error: object
      * }
      * 4. {
-     * 		tags: ['event', 'client'],
-     * 		event: object
+     *    tags: ['event', 'client'],
+     *    event: object
      * }
      * 5. {
-     * 		tags: ['channel'],
-     * 		channel: object
+     *    tags: ['channel'],
+     *    channel: object
      * }
      */
     this.logger = isFunction(inputOptions.logger) ? inputOptions.logger : () => null;
     this.recoverStateOnReconnect = this.options.recoverStateOnReconnect;
     this.threads = new ThreadManager({ client: this });
     this.polls = new PollManager({ client: this });
+    this.reminders = new ReminderManager({ client: this });
   }
 
   /**
@@ -559,6 +567,12 @@ export class StreamChat {
 
   _hasConnectionID = () => Boolean(this._getConnectionID());
 
+  public setMessageComposerSetupFunction = (
+    setupFunction: MessageComposerSetupState['setupFunction'],
+  ) => {
+    this._messageComposerSetupState.partialNext({ setupFunction });
+  };
+
   /**
    * connectUser - Set the current user and open a WebSocket connection
    *
@@ -878,15 +892,15 @@ export class StreamChat {
    * @param {string} userID User ID. If user has no devices, it will error
    * @param {TestPushDataInput} [data] Overrides for push templates/message used
    *  IE: {
-        messageID: 'id-of-message', // will error if message does not exist
-        apnTemplate: '{}', // if app doesn't have apn configured it will error
-        firebaseTemplate: '{}', // if app doesn't have firebase configured it will error
-        firebaseDataTemplate: '{}', // if app doesn't have firebase configured it will error
-        skipDevices: true, // skip config/device checks and sending to real devices
-        pushProviderName: 'staging' // one of your configured push providers
-        pushProviderType: 'apn' // one of supported provider types
-      }
-  */
+   messageID: 'id-of-message', // will error if message does not exist
+   apnTemplate: '{}', // if app doesn't have apn configured it will error
+   firebaseTemplate: '{}', // if app doesn't have firebase configured it will error
+   firebaseDataTemplate: '{}', // if app doesn't have firebase configured it will error
+   skipDevices: true, // skip config/device checks and sending to real devices
+   pushProviderName: 'staging' // one of your configured push providers
+   pushProviderType: 'apn' // one of supported provider types
+   }
+   */
   async testPushSettings(userID: string, data: TestPushDataInput = {}) {
     return await this.post<CheckPushResponse>(this.baseURL + '/check_push', {
       user_id: userID,
@@ -907,10 +921,10 @@ export class StreamChat {
    *
    * @param {TestSQSDataInput} [data] Overrides SQS settings for testing if needed
    *  IE: {
-        sqs_key: 'auth_key',
-        sqs_secret: 'auth_secret',
-        sqs_url: 'url_to_queue',
-      }
+   sqs_key: 'auth_key',
+   sqs_secret: 'auth_secret',
+   sqs_url: 'url_to_queue',
+   }
    */
   async testSQSSettings(data: TestSQSDataInput = {}) {
     return await this.post<CheckSQSResponse>(this.baseURL + '/check_sqs', data);
@@ -921,10 +935,10 @@ export class StreamChat {
    *
    * @param {TestSNSDataInput} [data] Overrides SNS settings for testing if needed
    *  IE: {
-        sns_key: 'auth_key',
-        sns_secret: 'auth_secret',
-        sns_topic_arn: 'topic_to_publish_to',
-      }
+   sns_key: 'auth_key',
+   sns_secret: 'auth_secret',
+   sns_topic_arn: 'topic_to_publish_to',
+   }
    */
   async testSNSSettings(data: TestSNSDataInput = {}) {
     return await this.post<CheckSNSResponse>(this.baseURL + '/check_sns', data);
@@ -1952,6 +1966,7 @@ export class StreamChat {
           }),
         };
         this.polls.hydratePollCache(channelState.messages, true);
+        this.reminders.hydrateState(channelState.messages);
       }
 
       if (channelState.draft) {
@@ -2540,6 +2555,7 @@ export class StreamChat {
       ...options,
     });
   }
+
   async blockUser(blockedUserID: string, user_id?: string) {
     return await this.post<BlockUserAPIResponse>(this.baseURL + '/users/block', {
       blocked_user_id: blockedUserID,
@@ -2552,12 +2568,14 @@ export class StreamChat {
       ...(user_id ? { user_id } : {}),
     });
   }
+
   async unBlockUser(blockedUserID: string, userID?: string) {
     return await this.post<APIResponse>(this.baseURL + '/users/unblock', {
       blocked_user_id: blockedUserID,
       ...(userID ? { user_id: userID } : {}),
     });
   }
+
   /** muteUser - mutes a user
    *
    * @param {string} targetID
@@ -2747,6 +2765,7 @@ export class StreamChat {
       ...options,
     });
   }
+
   // alias for backwards compatibility
   _unblockMessage = this.unblockMessage;
 
@@ -2817,7 +2836,7 @@ export class StreamChat {
     );
   }
 
-  DBDeleteChannelType(channelType: string) {
+  deleteChannelType(channelType: string) {
     return this.delete<APIResponse>(
       this.baseURL + `/channeltypes/${encodeURIComponent(channelType)}`,
     );
@@ -3714,6 +3733,7 @@ export class StreamChat {
       },
     );
   }
+
   /**
    * removeSegmentTargets - Remove targets from a segment
    *
@@ -3830,6 +3850,7 @@ export class StreamChat {
       stop_at: options?.stopAt,
     });
   }
+
   /**
    * queryCampaigns - Query Campaigns
    *
@@ -4496,9 +4517,57 @@ export class StreamChat {
     return await this.post<QueryDraftsResponse>(this.baseURL + '/drafts/query', payload);
   }
 
-  public setMessageComposerSetupFunction = (
-    setupFunction: MessageComposerSetupState['setupFunction'],
-  ) => {
-    this._messageComposerSetupState.partialNext({ setupFunction });
-  };
+  /**
+   * createReminder - Creates a reminder for a message
+   *
+   * @param {CreateReminderOptions} options The options for creating the reminder
+   * @returns {Promise<ReminderAPIResponse>}
+   */
+  async createReminder({ messageId, ...options }: CreateReminderOptions) {
+    return await this.post<ReminderAPIResponse>(
+      `${this.baseURL}/messages/${messageId}/reminders`,
+      options,
+    );
+  }
+
+  /**
+   * updateReminder - Updates an existing reminder for a message
+   *
+   * @param {UpdateReminderOptions} options The options for updating the reminder
+   * @returns {Promise<ReminderAPIResponse>}
+   */
+  async updateReminder({ messageId, ...options }: UpdateReminderOptions) {
+    return await this.patch<ReminderAPIResponse>(
+      `${this.baseURL}/messages/${messageId}/reminders`,
+      options,
+    );
+  }
+
+  /**
+   * deleteReminder - Deletes a reminder for a message
+   *
+   * @param {string} messageId The ID of the message whose reminder to delete
+   * @param {string} [userId] Optional user ID, required for server-side operations
+   * @returns {Promise<APIResponse>}
+   */
+  async deleteReminder(messageId: string, userId?: string): Promise<APIResponse> {
+    return await this.delete<APIResponse>(
+      `${this.baseURL}/messages/${messageId}/reminders`,
+      userId ? { user_id: userId } : {},
+    );
+  }
+
+  /**
+   * queryReminders - Queries reminders based on given filters
+   *
+   * @param {QueryRemindersOptions} options The options for querying reminders
+   * @returns {Promise<QueryRemindersResponse>}
+   */
+  async queryReminders({ filter, sort, ...rest }: QueryRemindersOptions = {}) {
+    return await this.post<QueryRemindersResponse>(`${this.baseURL}/reminders/query`, {
+      filter_conditions: filter,
+      sort: sort && normalizeQuerySort(sort),
+      ...rest,
+    });
+  }
 }

package/src/events.ts

@@ -63,4 +63,10 @@ export const EVENT_MAP = {
   'connection.recovered': true,
   'transport.changed': true,
   'capabilities.changed': true,
+
+  // Reminder events
+  'reminder.created': true,
+  'reminder.updated': true,
+  'reminder.deleted': true,
+  'notification.reminder_due': true,
 };

package/src/index.ts

@@ -10,10 +10,12 @@ export * from './insights';
 export * from './messageComposer';
 export * from './middleware';
 export * from './moderation';
+export * from './pagination';
 export * from './permissions';
 export * from './poll';
 export * from './poll_manager';
-export * from './search_controller';
+export * from './reminders';
+export * from './search';
 export * from './segment';
 export * from './signing';
 export * from './store';

package/src/messageComposer/middleware/pollComposer/state.ts

@@ -41,16 +41,15 @@ export const pollStateChangeValidators: Partial<
       return { max_votes_allowed: 'Type a number from 2 to 10' };
     return { max_votes_allowed: undefined };
   },
-  options: ({ value }) => {
+  options: ({ value: options }) => {
     const errors: Record<string, string> = {};
     const seenOptions = new Set<string>();
 
-    value.forEach((option: { id: string; text: string }) => {
-      const trimmedText = option.text.trim();
-      if (seenOptions.has(trimmedText)) {
+    options.forEach((option: { id: string; text: string }) => {
+      if (seenOptions.has(option.text) && option.text.length) {
         errors[option.id] = 'Option already exists';
       } else {
-        seenOptions.add(trimmedText);
+        seenOptions.add(option.text);
       }
     });
 

package/src/messageComposer/middleware/textComposer/commands.ts

@@ -1,7 +1,7 @@
 import type { Channel } from '../../../channel';
 import type { Middleware } from '../../../middleware';
-import type { SearchSourceOptions } from '../../../search_controller';
-import { BaseSearchSource } from '../../../search_controller';
+import type { SearchSourceOptions } from '../../../search';
+import { BaseSearchSource } from '../../../search';
 import type { CommandResponse } from '../../../types';
 import { mergeWith } from '../../../utils/mergeWith';
 import type { CommandSuggestion, TextComposerMiddlewareOptions } from './types';

package/src/messageComposer/middleware/textComposer/mentions.ts

@@ -3,8 +3,8 @@ import {
   getTriggerCharWithToken,
   insertItemWithTrigger,
 } from './textMiddlewareUtils';
-import type { SearchSourceOptions } from '../../../search_controller';
-import { BaseSearchSource } from '../../../search_controller';
+import type { SearchSourceOptions } from '../../../search';
+import { BaseSearchSource } from '../../../search';
 import { mergeWith } from '../../../utils/mergeWith';
 import type { TextComposerMiddlewareOptions, UserSuggestion } from './types';
 import type { StreamChat } from '../../../client';

package/src/messageComposer/middleware/textComposer/types.ts

@@ -1,7 +1,7 @@
 import type { MessageComposer } from '../../messageComposer';
 import type { CommandResponse, UserResponse } from '../../../types';
 import type { TokenizationPayload } from './textMiddlewareUtils';
-import type { SearchSource } from '../../../search_controller';
+import type { SearchSource } from '../../../search';
 import type { CustomTextComposerSuggestion } from '../../types.custom';
 
 export type TextComposerSuggestion<T = unknown> = T & {

package/src/messageComposer/pollComposer.ts

@@ -83,7 +83,8 @@ export class PollComposer {
 
   get canCreatePoll() {
     const { data, errors } = this.state.getLatestValue();
-    const hasAtLeastOneOption = data.options.filter((o) => !!o.text).length > 0;
+    const hasAtLeastOneNonEmptyOption =
+      data.options.filter((o) => !!o.text.trim()).length > 0;
     const hasName = !!data.name;
     const maxVotesAllowedNumber = parseInt(
       data.max_votes_allowed?.match(VALID_MAX_VOTES_VALUE_REGEX)?.[0] || '',
@@ -95,7 +96,7 @@ export class PollComposer {
         (2 <= maxVotesAllowedNumber || maxVotesAllowedNumber <= 10));
 
     return (
-      hasAtLeastOneOption &&
+      hasAtLeastOneNonEmptyOption &&
       hasName &&
       validMaxVotesAllowed &&
       Object.values(errors).filter((errorText) => !!errorText).length === 0