stream-chat 8.51.0 → 8.52.1

package/src/client_state.ts

@@ -1,16 +1,19 @@
 import { UserResponse, ExtendableGenerics, DefaultGenerics } from './types';
+import { StreamChat } from './client';
 
 /**
  * ClientState - A container class for the client state.
  */
 export class ClientState<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> {
+  private client: StreamChat<StreamChatGenerics>;
   users: {
     [key: string]: UserResponse<StreamChatGenerics>;
   };
   userChannelReferences: { [key: string]: { [key: string]: boolean } };
-  constructor() {
+  constructor({ client }: { client: StreamChat<StreamChatGenerics> }) {
     // show the status for a certain user...
     // ie online, offline etc
+    this.client = client;
     this.users = {};
     // store which channels contain references to the specified user...
     this.userChannelReferences = {};
@@ -23,13 +26,13 @@ export class ClientState<StreamChatGenerics extends ExtendableGenerics = Default
   }
 
   updateUser(user?: UserResponse<StreamChatGenerics>) {
-    if (user != null) {
+    if (user != null && this.client._cacheEnabled()) {
       this.users[user.id] = user;
     }
   }
 
   updateUserReference(user: UserResponse<StreamChatGenerics>, channelID: string) {
-    if (user == null) {
+    if (user == null || !this.client._cacheEnabled()) {
       return;
     }
     this.updateUser(user);

package/src/poll_manager.ts

@@ -101,6 +101,9 @@ export class PollManager<SCG extends ExtendableGenerics = DefaultGenerics> {
   };
 
   private setOrOverwriteInCache = (pollResponse: PollResponse<SCG>, overwriteState?: boolean) => {
+    if (!this.client._cacheEnabled()) {
+      return;
+    }
     const pollFromCache = this.fromState(pollResponse.id);
     if (!pollFromCache) {
       const poll = new Poll<SCG>({ client: this.client, poll: pollResponse });

package/src/types.ts

@@ -77,6 +77,11 @@ export type APIResponse = {
   duration: string;
 };
 
+export type TranslateResponse = {
+  language: string;
+  translated_text: string;
+};
+
 export type AppSettingsAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
   app?: {
     // TODO
@@ -1176,6 +1181,15 @@ export type StreamChatOptions = AxiosRequestConfig & {
   baseURL?: string;
   browser?: boolean;
   device?: BaseDeviceFields;
+  /**
+   * Disables the hydration of all caches within the JS Client. This includes this.activeChannels,
+   * this.polls.pollCache and this.config.
+   * It is mainly meant to be used for integrations where stream-chat is used as a server-side service
+   * interacting with Stream's REST API, not depending on any state and purely serving as a wrapper
+   * around HTTP requests. Using this property on either the client side or a backend implementation
+   * that also relies on WS events will break these functionalities, so please use carefully.
+   */
+  disableCache?: boolean;
   enableInsights?: boolean;
   /** experimental feature, please contact support if you want this feature enabled for you */
   enableWSFallback?: boolean;
@@ -1198,8 +1212,10 @@ export type StreamChatOptions = AxiosRequestConfig & {
    */
   recoverStateOnReconnect?: boolean;
   warmUp?: boolean;
-  // Set the instance of StableWSConnection on chat client. Its purely for testing purpose and should
-  // not be used in production apps.
+  /**
+   * Set the instance of StableWSConnection on chat client. Its purely for testing purpose and should
+   * not be used in production apps.
+   */
   wsConnection?: StableWSConnection;
 };