stream-chat 9.44.0 → 9.44.2

package/dist/esm/index.mjs

@@ -12280,6 +12280,33 @@ var DEFAULT_CHANNEL_MANAGER_OPTIONS = {
 var DEFAULT_CHANNEL_MANAGER_PAGINATION_OPTIONS = {
   offset: 0
 };
+var mapPredefinedFilterSortToChannelSort = (sort) => (sort ?? []).map(({ direction = 1, field }) => ({
+  [field]: direction
+}));
+var getResponsePaginationParams = ({
+  queryChannelsResponse,
+  sort
+}) => {
+  const predefinedFilter = queryChannelsResponse?.predefined_filter;
+  if (!predefinedFilter) {
+    return {};
+  }
+  return {
+    responseFilters: predefinedFilter.filter,
+    responseSort: predefinedFilter.sort !== void 0 ? mapPredefinedFilterSortToChannelSort(predefinedFilter.sort) : sort
+  };
+};
+var getResponseFiltersAndSort = (pagination) => ({
+  filters: pagination.responseFilters ?? pagination.filters,
+  sort: pagination.responseSort ?? pagination.sort
+});
+var omitResponsePaginationParams = (pagination) => {
+  const paginationWithoutResponseParams = { ...pagination };
+  delete paginationWithoutResponseParams.responseFilters;
+  delete paginationWithoutResponseParams.responseSort;
+  return paginationWithoutResponseParams;
+};
+var isQueryChannelsResponseWithChannels = (response) => !Array.isArray(response);
 var ChannelManager = class extends WithSubscriptions {
   constructor({
     client,
@@ -12303,12 +12330,13 @@ var ChannelManager = class extends WithSubscriptions {
       });
       const {
         channels,
-        pagination: { filters, sort }
+        pagination: { filters, options, sort }
       } = this.state.getLatestValue();
       this.client.offlineDb?.executeQuerySafely(
         (db) => db.upsertCidsForQuery({
           cids: channels.map((channel) => channel.cid),
           filters,
+          options,
           sort
         }),
         { method: "upsertCidsForQuery" }
@@ -12338,22 +12366,34 @@ var ChannelManager = class extends WithSubscriptions {
         ...options
       };
       try {
-        const channels = await this.queryChannelsRequest(
+        const queryChannelsResponse = await this.queryChannelsRequest(
           filters,
           sort,
           options,
-          stateOptions
+          { ...stateOptions, withResponse: true }
         );
+        const channels = isQueryChannelsResponseWithChannels(queryChannelsResponse) ? queryChannelsResponse.channels : queryChannelsResponse;
         const newOffset = offset + (channels?.length ?? 0);
         const newOptions = { ...options, offset: newOffset };
         const { pagination } = this.state.getLatestValue();
+        const responsePaginationParams = getResponsePaginationParams({
+          queryChannelsResponse: isQueryChannelsResponseWithChannels(queryChannelsResponse) ? queryChannelsResponse : void 0,
+          sort
+        });
+        const paginationWithoutResponseParams = omitResponsePaginationParams(pagination);
         this.state.partialNext({
           channels,
           pagination: {
-            ...pagination,
+            // Drop response derived filter/sort from the previous query before applying
+            // the current response. Non predefined queries do not return this metadata,
+            // so keeping the old values would make later WS mutations use stale
+            // predefined filter semantics. Also the predefined_filter might change, producing
+            // a different combination as well so we always need to first clean up.
+            ...paginationWithoutResponseParams,
             hasNext: (channels?.length ?? 0) >= (limit ?? 1),
             isLoading: false,
-            options: newOptions
+            options: newOptions,
+            ...responsePaginationParams
           },
           initialized: true,
           error: void 0
@@ -12362,6 +12402,7 @@ var ChannelManager = class extends WithSubscriptions {
           (db) => db.upsertCidsForQuery({
             cids: channels.map((channel) => channel.cid),
             filters: pagination.filters,
+            options,
             sort: pagination.sort
           }),
           { method: "upsertCidsForQuery" }
@@ -12404,7 +12445,7 @@ var ChannelManager = class extends WithSubscriptions {
         this.state.next((currentState) => ({
           ...currentState,
           pagination: {
-            ...currentState.pagination,
+            ...omitResponsePaginationParams(currentState.pagination),
             isLoading: true,
             isLoadingNext: false,
             filters,
@@ -12418,6 +12459,7 @@ var ChannelManager = class extends WithSubscriptions {
             const channelsFromDB = await this.client.offlineDb.getChannelsForQuery({
               userId: this.client.user.id,
               filters,
+              options,
               sort
             });
             if (channelsFromDB) {
@@ -12463,12 +12505,13 @@ var ChannelManager = class extends WithSubscriptions {
         this.state.partialNext({
           pagination: { ...pagination, isLoading: false, isLoadingNext: true }
         });
-        const nextChannels = await this.queryChannelsRequest(
+        const queryChannelsResponse = await this.queryChannelsRequest(
           filters,
           sort,
           options,
           this.stateOptions
         );
+        const nextChannels = isQueryChannelsResponseWithChannels(queryChannelsResponse) ? queryChannelsResponse.channels : queryChannelsResponse;
         const { channels } = this.state.getLatestValue();
         const newOffset = offset + (nextChannels?.length ?? 0);
         const newOptions = { ...options, offset: newOffset };
@@ -12516,7 +12559,7 @@ var ChannelManager = class extends WithSubscriptions {
       if (!channels) {
         return;
       }
-      const { sort } = pagination ?? {};
+      const { sort } = getResponseFiltersAndSort(pagination);
       this.setChannels(
         promoteChannel({
           channels,
@@ -12546,7 +12589,7 @@ var ChannelManager = class extends WithSubscriptions {
       if (!channels) {
         return;
       }
-      const { filters, sort } = pagination ?? {};
+      const { filters, sort } = getResponseFiltersAndSort(pagination);
       const channelType = event.channel_type;
       const channelId = event.channel_id;
       if (!channelType || !channelId) {
@@ -12589,7 +12632,7 @@ var ChannelManager = class extends WithSubscriptions {
         type
       });
       const { channels, pagination } = this.state.getLatestValue();
-      const { filters, sort } = pagination ?? {};
+      const { filters, sort } = getResponseFiltersAndSort(pagination);
       const considerArchivedChannels = shouldConsiderArchivedChannels(filters);
       const isTargetChannelArchived = isChannelArchived(channel);
       if (!channels || considerArchivedChannels && isTargetChannelArchived && !filters.archived || considerArchivedChannels && !isTargetChannelArchived && filters.archived || !this.options.allowNotLoadedChannelPromotionForEvent?.["notification.message_new"]) {
@@ -12614,7 +12657,7 @@ var ChannelManager = class extends WithSubscriptions {
         type: event.channel_type
       });
       const { channels, pagination } = this.state.getLatestValue();
-      const { sort, filters } = pagination ?? {};
+      const { filters, sort } = getResponseFiltersAndSort(pagination);
       const considerArchivedChannels = shouldConsiderArchivedChannels(filters);
       const isTargetChannelArchived = isChannelArchived(channel);
       if (!channels || considerArchivedChannels && isTargetChannelArchived && !filters.archived || considerArchivedChannels && !isTargetChannelArchived && filters.archived || !this.options.allowNotLoadedChannelPromotionForEvent?.["channel.visible"]) {
@@ -12631,7 +12674,7 @@ var ChannelManager = class extends WithSubscriptions {
     this.notificationRemovedFromChannelHandler = this.channelDeletedHandler;
     this.memberUpdatedHandler = (event) => {
       const { pagination, channels } = this.state.getLatestValue();
-      const { filters, sort } = pagination;
+      const { filters, sort } = getResponseFiltersAndSort(pagination);
       if (!event.member?.user || event.member.user.id !== this.client.userID || !event.channel_type || !event.channel_id) {
         return;
       }
@@ -14370,16 +14413,22 @@ var StreamChat = class _StreamChat {
     );
   }
   /**
-   * queryChannelsRequest - Queries channels and returns the raw response
+   * queryChannelsRequestWithResponse - Queries channels and returns the full API response
+   * including top-level metadata such as `predefined_filter`.
+   *
+   * This exists as a compatibility bridge, as changing `queryChannelsRequest()` to return
+   * `QueryChannelsAPIResponse` would be a breaking change because it currently returns
+   * only the channel list. In the next major release, the request/response APIs should
+   * be consolidated so callers can access the full response through the primary API.
    *
    * @param {ChannelFilters} filterConditions object MongoDB style filters. Can be empty object when using predefined_filter in options.
    * @param {ChannelSort} [sort] Sort options, for instance {created_at: -1}.
    * When using multiple fields, make sure you use array of objects to guarantee field order, for instance [{last_updated: -1}, {created_at: 1}]
    * @param {ChannelOptions} [options] Options object. Can include predefined_filter, filter_values, and sort_values for using predefined filters.
    *
-   * @return {Promise<Array<ChannelAPIResponse>>} search channels response
+   * @return {Promise<QueryChannelsAPIResponse>} full search channels response
    */
-  async queryChannelsRequest(filterConditions, sort = [], options = {}) {
+  async queryChannelsRequestWithResponse(filterConditions, sort = [], options = {}) {
     const defaultOptions = {
       state: true,
       watch: true,
@@ -14404,27 +14453,38 @@ var StreamChat = class _StreamChat {
       ...defaultOptions,
       ...restOptions
     };
-    const data = await this.post(
-      this.baseURL + "/channels",
-      payload
-    );
-    return data.channels;
+    return await this.post(this.baseURL + "/channels", payload);
   }
   /**
-   * queryChannels - Query channels
+   * queryChannelsRequest - Queries channels and returns the raw channel response list.
+   *
+   * This preserves the historical return shape for backwards compatibility. Use
+   * `queryChannelsRequestWithResponse()` when response level metadata such as
+   * `predefined_filter` is needed. In the next major release these APIs should be
+   * consolidated into a single full-response API.
    *
-   * @param {ChannelFilters} filterConditions object MongoDB style filters
+   * @param {ChannelFilters} filterConditions object MongoDB style filters. Can be empty object when using predefined_filter in options.
    * @param {ChannelSort} [sort] Sort options, for instance {created_at: -1}.
    * When using multiple fields, make sure you use array of objects to guarantee field order, for instance [{last_updated: -1}, {created_at: 1}]
-   * @param {ChannelOptions} [options] Options object
-   * @param {ChannelStateOptions} [stateOptions] State options object. These options will only be used for state management and won't be sent in the request.
-   * - stateOptions.skipInitialization - Skips the initialization of the state for the channels matching the ids in the list.
-   * - stateOptions.skipHydration - Skips returning the channels as instances of the Channel class and rather returns the raw query response.
+   * @param {ChannelOptions} [options] Options object. Can include predefined_filter, filter_values, and sort_values for using predefined filters.
    *
-   * @return {Promise<Array<Channel>>} search channels response
+   * @return {Promise<Array<ChannelAPIResponse>>} search channels response
    */
+  async queryChannelsRequest(filterConditions, sort = [], options = {}) {
+    const data = await this.queryChannelsRequestWithResponse(
+      filterConditions,
+      sort,
+      options
+    );
+    return data.channels;
+  }
   async queryChannels(filterConditions, sort = [], options = {}, stateOptions = {}) {
-    const channels = await this.queryChannelsRequest(filterConditions, sort, options);
+    const queryChannelsResponse = await this.queryChannelsRequestWithResponse(
+      filterConditions,
+      sort,
+      options
+    );
+    const channels = queryChannelsResponse.channels;
     this.dispatchEvent({
       type: "channels.queried",
       queriedChannels: {
@@ -14438,7 +14498,14 @@ var StreamChat = class _StreamChat {
         isLatestMessagesSet: true
       });
     }
-    return this.hydrateActiveChannels(channels, stateOptions, options);
+    const hydratedChannels = this.hydrateActiveChannels(channels, stateOptions, options);
+    if (stateOptions.withResponse) {
+      return {
+        ...queryChannelsResponse,
+        channels: hydratedChannels
+      };
+    }
+    return hydratedChannels;
   }
   /**
    * queryReactions - Query reactions
@@ -15563,7 +15630,7 @@ var StreamChat = class _StreamChat {
     if (this.userAgent) {
       return this.userAgent;
     }
-    const version = "9.44.0";
+    const version = "9.44.2";
     const clientBundle = "browser-esm";
     let userAgentString = "";
     if (this.sdkIdentifier) {