stream-chat 8.52.3 → 8.54.0

package/src/client.ts

@@ -141,6 +141,7 @@ import {
   PollVote,
   PollVoteData,
   PollVotesAPIResponse,
+  PushPreference,
   PushProvider,
   PushProviderConfig,
   PushProviderID,
@@ -201,6 +202,7 @@ import {
   UpdatePollAPIResponse,
   UpdatePollOptionAPIResponse,
   UpdateSegmentData,
+  UpsertPushPreferencesResponse,
   UserCustomEvent,
   UserFilters,
   UserOptions,
@@ -1666,6 +1668,7 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
       c.data = channelState.channel;
       c.offlineMode = offlineMode;
       c.initialized = !offlineMode;
+      c.push_preferences = channelState.push_preferences;
 
       let updatedMessagesSet;
       if (skipInitialization === undefined) {
@@ -1805,6 +1808,17 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
     return await this.post<GetUnreadCountBatchAPIResponse>(this.baseURL + '/unread_batch', { user_ids: userIDs });
   }
 
+  /**
+   * setPushPreferences - Applies the list of push preferences.
+   *
+   * @param {PushPreference[]} A list of push preferences.
+   *
+   * @return {<UpsertPushPreferencesResponse>}
+   */
+  async setPushPreferences(preferences: PushPreference[]) {
+    return await this.post<UpsertPushPreferencesResponse>(this.baseURL + '/push_preferences', { preferences });
+  }
+
   /**
    * removeDevice - Removes the device with the given id. Clientside users can only delete their own devices
    *
@@ -3087,26 +3101,73 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
     });
   }
 
+  /**
+   * Creates a new block list
+   *
+   * @param {BlockList} blockList - The block list to create
+   * @param {string} blockList.name - The name of the block list
+   * @param {string[]} blockList.words - List of words to block
+   * @param {string} [blockList.team] - Team ID the block list belongs to
+   *
+   * @returns {Promise<APIResponse>} The server response
+   */
   createBlockList(blockList: BlockList) {
     return this.post<APIResponse>(`${this.baseURL}/blocklists`, blockList);
   }
 
-  listBlockLists() {
-    return this.get<APIResponse & { blocklists: BlockListResponse[] }>(`${this.baseURL}/blocklists`);
+  /**
+   * Lists all block lists
+   *
+   * @param {Object} [data] - Query parameters
+   * @param {string} [data.team] - Team ID to filter block lists by
+   *
+   * @returns {Promise<APIResponse & {blocklists: BlockListResponse[]}>} Response containing array of block lists
+   */
+  listBlockLists(data?: { team?: string }) {
+    return this.get<APIResponse & { blocklists: BlockListResponse[] }>(`${this.baseURL}/blocklists`, data);
   }
 
-  getBlockList(name: string) {
+  /**
+   * Gets a specific block list
+   *
+   * @param {string} name - The name of the block list to retrieve
+   * @param {Object} [data] - Query parameters
+   * @param {string} [data.team] - Team ID that blocklist belongs to
+   *
+   * @returns {Promise<APIResponse & {blocklist: BlockListResponse}>} Response containing the block list
+   */
+  getBlockList(name: string, data?: { team?: string }) {
     return this.get<APIResponse & { blocklist: BlockListResponse }>(
       `${this.baseURL}/blocklists/${encodeURIComponent(name)}`,
+      data,
     );
   }
 
-  updateBlockList(name: string, data: { words: string[] }) {
+  /**
+   * Updates an existing block list
+   *
+   * @param {string} name - The name of the block list to update
+   * @param {Object} data - The update data
+   * @param {string[]} data.words - New list of words to block
+   * @param {string} [data.team] - Team ID that blocklist belongs to
+   *
+   * @returns {Promise<APIResponse>} The server response
+   */
+  updateBlockList(name: string, data: { words: string[]; team?: string }) {
     return this.put<APIResponse>(`${this.baseURL}/blocklists/${encodeURIComponent(name)}`, data);
   }
 
-  deleteBlockList(name: string) {
-    return this.delete<APIResponse>(`${this.baseURL}/blocklists/${encodeURIComponent(name)}`);
+  /**
+   * Deletes a block list
+   *
+   * @param {string} name - The name of the block list to delete
+   * @param {Object} [data] - Query parameters
+   * @param {string} [data.team] - Team ID that blocklist belongs to
+   *
+   * @returns {Promise<APIResponse>} The server response
+   */
+  deleteBlockList(name: string, data?: { team?: string }) {
+    return this.delete<APIResponse>(`${this.baseURL}/blocklists/${encodeURIComponent(name)}`, data);
   }
 
   exportChannels(request: Array<ExportChannelRequest>, options: ExportChannelOptions = {}) {

package/src/constants.ts

@@ -1,4 +1,4 @@
 export const DEFAULT_QUERY_CHANNELS_MESSAGE_LIST_PAGE_SIZE = 25;
 export const DEFAULT_QUERY_CHANNEL_MESSAGE_LIST_PAGE_SIZE = 100;
 
-export const DEFAULT_MESSAGE_SET_PAGINATION = { hasNext: true, hasPrev: true };
+export const DEFAULT_MESSAGE_SET_PAGINATION = { hasNext: false, hasPrev: false };

package/src/types.ts

@@ -323,6 +323,7 @@ export type ChannelAPIResponse<StreamChatGenerics extends ExtendableGenerics = D
   hidden?: boolean;
   membership?: ChannelMemberResponse<StreamChatGenerics> | null;
   pending_messages?: PendingMessageResponse<StreamChatGenerics>[];
+  push_preferences?: PushPreference;
   read?: ReadResponse<StreamChatGenerics>[];
   threads?: ThreadResponse[];
   watcher_count?: number;
@@ -633,6 +634,27 @@ export type GetUnreadCountAPIResponse = APIResponse & {
   total_unread_threads_count: number;
 };
 
+export type ChatLevelPushPreference = 'all' | 'none' | 'mentions' | (string & {});
+
+export type PushPreference = {
+  callLevel?: 'all' | 'none' | (string & {});
+  chatLevel?: ChatLevelPushPreference;
+  disabledUntil?: string; // snooze till this time
+  removeDisable?: boolean; // Temporary flag for resetting disabledUntil
+};
+
+export type ChannelPushPreference = {
+  chatLevel?: ChatLevelPushPreference; // "all", "none", "mentions", or other custom strings
+  disabledUntil?: string;
+  removeDisable?: boolean; // Temporary flag for resetting disabledUntil
+};
+
+export type UpsertPushPreferencesResponse = APIResponse & {
+  // Mapping of user IDs to their push preferences
+  userChannelPreferences: Record<string, Record<string, ChannelPushPreference>>;
+  userPreferences: Record<string, PushPreference>; // Mapping of user -> channel id -> push preferences
+};
+
 export type GetUnreadCountBatchAPIResponse = APIResponse & {
   counts_by_user: { [userId: string]: GetUnreadCountAPIResponse };
 };
@@ -773,6 +795,7 @@ export type OwnUserBase<StreamChatGenerics extends ExtendableGenerics = DefaultG
   unread_threads: number;
   invisible?: boolean;
   privacy_settings?: PrivacySettings;
+  push_preferences?: PushPreference;
   roles?: string[];
 };
 
@@ -2205,6 +2228,7 @@ export type OGAttachment = {
 export type BlockList = {
   name: string;
   words: string[];
+  team?: string;
   type?: string;
   validate?: boolean;
 };
@@ -2620,6 +2644,7 @@ export type MessageBase<
   pinned_at?: string | null;
   poll_id?: string;
   quoted_message_id?: string;
+  restricted_visibility?: string[];
   show_in_channel?: boolean;
   silent?: boolean;
   text?: string;

package/src/utils.ts

@@ -92,6 +92,7 @@ export function isOwnUserBaseProperty(property: string) {
     invisible: true,
     privacy_settings: true,
     roles: true,
+    push_preferences: true,
   };
 
   return ownUserBaseProperties[property as keyof OwnUserBase];