stream-chat 6.7.2 → 6.9.0

package/src/types.ts

@@ -1,4 +1,5 @@
 import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { StableWSConnection } from './connection';
 import { EVENT_MAP } from './events';
 import { Role } from './permissions';
 
@@ -101,6 +102,7 @@ export type AppSettingsAPIResponse<StreamChatGenerics extends ExtendableGenerics
       }
     >;
     reminders_interval: number;
+    agora_options?: AgoraOptions | null;
     async_url_enrich_enabled?: boolean;
     auto_translation_enabled?: boolean;
     before_message_send_hook_url?: string;
@@ -112,6 +114,7 @@ export type AppSettingsAPIResponse<StreamChatGenerics extends ExtendableGenerics
     enforce_unique_usernames?: 'no' | 'app' | 'team';
     file_upload_config?: FileUploadConfig;
     grants?: Record<string, string[]>;
+    hms_options?: HMSOptions | null;
     image_moderation_enabled?: boolean;
     image_upload_config?: FileUploadConfig;
     multi_tenant_enabled?: boolean;
@@ -136,6 +139,7 @@ export type AppSettingsAPIResponse<StreamChatGenerics extends ExtendableGenerics
     suspended?: boolean;
     suspended_explanation?: string;
     user_search_disallowed_roles?: string[] | null;
+    video_provider?: string;
     webhook_events?: Array<string>;
     webhook_url?: string;
   };
@@ -270,6 +274,7 @@ export type ChannelAPIResponse<StreamChatGenerics extends ExtendableGenerics = D
   pinned_messages: MessageResponse<StreamChatGenerics>[];
   hidden?: boolean;
   membership?: ChannelMembership<StreamChatGenerics> | null;
+  pending_messages?: PendingMessageResponse<StreamChatGenerics>[];
   read?: ReadResponse<StreamChatGenerics>[];
   watcher_count?: number;
   watchers?: UserResponse<StreamChatGenerics>[];
@@ -434,6 +439,10 @@ export type GetCommandResponse<StreamChatGenerics extends ExtendableGenerics = D
   CreateCommandOptions<StreamChatGenerics> &
   CreatedAtUpdatedAt;
 
+export type GetMessageAPIResponse<
+  StreamChatGenerics extends ExtendableGenerics = DefaultGenerics
+> = SendMessageAPIResponse<StreamChatGenerics>;
+
 export type GetMultipleMessagesAPIResponse<
   StreamChatGenerics extends ExtendableGenerics = DefaultGenerics
 > = APIResponse & {
@@ -601,6 +610,12 @@ export type SendFileAPIResponse = APIResponse & { file: string; thumb_url?: stri
 
 export type SendMessageAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
   message: MessageResponse<StreamChatGenerics>;
+  pending_message_metadata?: Record<string, string> | null;
+};
+
+export type SyncResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
+  events: Event<StreamChatGenerics>[];
+  inaccessible_cids?: string[];
 };
 
 export type TruncateChannelAPIResponse<
@@ -893,6 +908,22 @@ 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.
+  wsConnection?: StableWSConnection;
+};
+
+export type SyncOptions = {
+  /**
+   * This will behave as queryChannels option.
+   */
+  watch?: boolean;
+  /**
+   * Return channels from request that user does not have access to in a separate
+   * field in the response called 'inaccessible_cids' instead of
+   * adding them as 'notification.removed_from_channel' events.
+   */
+  with_inaccessible_cids?: boolean;
 };
 
 export type UnBanUserOptions = {
@@ -1468,6 +1499,7 @@ export type AppSettings = {
   };
   async_url_enrich_enabled?: boolean;
   auto_translation_enabled?: boolean;
+  before_message_send_hook_url?: string;
   cdn_expiration_seconds?: number;
   custom_action_handler_url?: string;
   disable_auth_checks?: boolean;
@@ -1998,6 +2030,11 @@ export type PartialMessageUpdate<StreamChatGenerics extends ExtendableGenerics =
   unset?: Array<keyof MessageUpdatableFields<StreamChatGenerics>>;
 };
 
+export type PendingMessageResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
+  message: MessageResponse<StreamChatGenerics>;
+  pending_message_metadata?: Record<string, string>;
+};
+
 export type PermissionAPIObject = {
   action?: string;
   condition?: object;