stream-chat 8.59.0 → 8.61.0

package/src/client.ts

@@ -32,6 +32,7 @@ import {
 import {
   APIErrorResponse,
   APIResponse,
+  AppIdentifier,
   AppSettings,
   AppSettingsAPIResponse,
   BannedUsersFilters,
@@ -283,6 +284,8 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
   defaultWSTimeout: number;
   sdkIdentifier?: SdkIdentifier;
   deviceIdentifier?: DeviceIdentifier;
+  appIdentifier?: AppIdentifier;
+  private cachedUserAgent?: string;
   private nextRequestAbortController: AbortController | null = null;
 
   /**
@@ -2828,6 +2831,8 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
    * @param {boolean} options.watch Subscribes the user to the channels of the threads.
    * @param {number}  options.participant_limit Limits the number of participants returned per threads.
    * @param {number}  options.reply_limit Limits the number of replies returned per threads.
+   * @param {ThreadFilters} options.filter MongoDB style filters for threads
+   * @param {ThreadSort} options.sort MongoDB style sort for threads
    *
    * @returns {{ threads: Thread<StreamChatGenerics>[], next: string }} Returns the list of threads and the next cursor.
    */
@@ -2840,9 +2845,26 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
       ...options,
     };
 
+    const requestBody: Record<string, unknown> = {
+      ...optionsWithDefaults,
+    };
+
+    if (optionsWithDefaults.filter && Object.keys(optionsWithDefaults.filter).length > 0) {
+      requestBody.filter = optionsWithDefaults.filter;
+    }
+
+    if (
+      optionsWithDefaults.sort &&
+      (Array.isArray(optionsWithDefaults.sort)
+        ? optionsWithDefaults.sort.length > 0
+        : Object.keys(optionsWithDefaults.sort).length > 0)
+    ) {
+      requestBody.sort = normalizeQuerySort(optionsWithDefaults.sort);
+    }
+
     const response = await this.post<QueryThreadsAPIResponse<StreamChatGenerics>>(
       `${this.baseURL}/threads`,
-      optionsWithDefaults,
+      requestBody,
     );
 
     return {
@@ -2926,36 +2948,42 @@ export class StreamChat<StreamChatGenerics extends ExtendableGenerics = DefaultG
     );
   }
 
-  getUserAgent() {
+  getUserAgent = (): string => {
+    // An explicit override (deprecated `setUserAgent`) always wins and is never cached.
     if (this.userAgent) {
       return this.userAgent;
     }
 
-    const version = process.env.PKG_VERSION;
-    const clientBundle = process.env.CLIENT_BUNDLE;
+    // Computed once, then memoized for the client's lifetime - inputs read on
+    // the first call (sdk/app/device identifiers, build-time env) are not re-read.
+    if (!this.cachedUserAgent) {
+      const version = process.env.PKG_VERSION;
+      const { name: sdkName, version: sdkVersion } = this.sdkIdentifier ?? {};
+      const { name: appName, version: appVersion } = this.appIdentifier ?? {};
+      const { os, model: deviceModel } = this.deviceIdentifier ?? {};
+
+      const head = sdkName
+        ? `stream-chat-${sdkName}-v${sdkVersion}-llc-v${version}`
+        : `stream-chat-js-v${version}-${this.node ? 'node' : 'browser'}`;
+
+      this.cachedUserAgent = [
+        head,
+        // reports the host app, the device OS, the device model, and the picked
+        // exports bundle, each only when a value is present
+        ...Object.entries({
+          app: appName,
+          app_version: appVersion,
+          os,
+          device_model: deviceModel,
+          client_bundle: process.env.CLIENT_BUNDLE,
+        })
+          .filter(([, value]) => value && value.length > 0)
+          .map(([key, value]) => `${key}=${value}`),
+      ].join('|');
+    }
 
-    let userAgentString = '';
-    if (this.sdkIdentifier) {
-      userAgentString = `stream-chat-${this.sdkIdentifier.name}-v${this.sdkIdentifier.version}-llc-v${version}`;
-    } else {
-      userAgentString = `stream-chat-js-v${version}-${this.node ? 'node' : 'browser'}`;
-    }
-
-    const { os, model } = this.deviceIdentifier ?? {};
-
-    return ([
-      // reports the device OS, if provided
-      ['os', os],
-      // reports the device model, if provided
-      ['device_model', model],
-      // reports which bundle is being picked from the exports
-      ['client_bundle', clientBundle],
-    ] as const).reduce(
-      (withArguments, [key, value]) =>
-        value && value.length > 0 ? withArguments.concat(`|${key}=${value}`) : withArguments,
-      userAgentString,
-    );
-  }
+    return this.cachedUserAgent;
+  };
 
   /**
    * @deprecated use sdkIdentifier instead

package/src/types.ts

@@ -353,7 +353,7 @@ export type ChannelMemberUpdates<
 export type ChannelMemberResponse<
   StreamChatGenerics extends ExtendableGenerics = DefaultGenerics
 > = StreamChatGenerics['memberType'] & {
-  archived_at?: string;
+  archived_at?: string | null;
   ban_expires?: string;
   banned?: boolean;
   channel_role?: Role;
@@ -363,7 +363,7 @@ export type ChannelMemberResponse<
   invited?: boolean;
   is_moderator?: boolean;
   notifications_muted?: boolean;
-  pinned_at?: string;
+  pinned_at?: string | null;
   role?: string;
   shadow_banned?: boolean;
   status?: InviteStatus;
@@ -571,11 +571,13 @@ export type PartialThreadUpdate = {
 };
 
 export type QueryThreadsOptions = {
+  filter?: ThreadFilters;
   limit?: number;
   member_limit?: number;
   next?: string;
   participant_limit?: number;
   reply_limit?: number;
+  sort?: ThreadSort;
   watch?: boolean;
 };
 
@@ -3859,6 +3861,13 @@ export type SdkIdentifier = { name: 'react' | 'react-native' | 'expo' | 'angular
  */
 export type DeviceIdentifier = { os: string; model?: string };
 
+/**
+ * An identifier containing information about the downstream application integrating
+ * stream-chat, if available. `name` is reported as `app` and `version` as `app_version`
+ * in the user agent. Distinct from the SDK and device identifiers.
+ */
+export type AppIdentifier = { name: string; version?: string };
+
 export type DraftResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
   channel_cid: string;
   created_at: string;
@@ -3900,3 +3909,41 @@ export type DraftMessage<StreamChatGenerics extends ExtendableGenerics = Default
   silent?: boolean;
   type?: MessageLabel;
 };
+
+export type ThreadSort = ThreadSortBase | Array<ThreadSortBase>;
+
+export type ThreadSortBase = {
+  active_participant_count?: AscDesc;
+  created_at?: AscDesc;
+  last_message_at?: AscDesc;
+  parent_message_id?: AscDesc;
+  participant_count?: AscDesc;
+  reply_count?: AscDesc;
+  updated_at?: AscDesc;
+};
+
+export type ThreadFilters = QueryFilters<
+  {
+    channel_cid?: RequireOnlyOne<Pick<QueryFilter<string>, '$eq' | '$in'>> | PrimitiveFilter<string>;
+  } & {
+    parent_message_id?:
+      | RequireOnlyOne<Pick<QueryFilter<ThreadResponse['parent_message_id']>, '$eq' | '$in'>>
+      | PrimitiveFilter<ThreadResponse['parent_message_id']>;
+  } & {
+    created_by_user_id?:
+      | RequireOnlyOne<Pick<QueryFilter<ThreadResponse['created_by_user_id']>, '$eq' | '$in'>>
+      | PrimitiveFilter<ThreadResponse['created_by_user_id']>;
+  } & {
+    created_at?:
+      | RequireOnlyOne<Pick<QueryFilter<ThreadResponse['created_at']>, '$eq' | '$gt' | '$lt' | '$gte' | '$lte'>>
+      | PrimitiveFilter<ThreadResponse['created_at']>;
+  } & {
+    updated_at?:
+      | RequireOnlyOne<Pick<QueryFilter<ThreadResponse['updated_at']>, '$eq' | '$gt' | '$lt' | '$gte' | '$lte'>>
+      | PrimitiveFilter<ThreadResponse['updated_at']>;
+  } & {
+    last_message_at?:
+      | RequireOnlyOne<Pick<QueryFilter<ThreadResponse['last_message_at']>, '$eq' | '$gt' | '$lt' | '$gte' | '$lte'>>
+      | PrimitiveFilter<ThreadResponse['last_message_at']>;
+  }
+>;