stream-chat 4.2.0 → 4.3.0

package/src/types.ts

@@ -79,6 +79,7 @@ export type AppSettingsAPIResponse<
         url_enrichment?: boolean;
       }
     >;
+    async_url_enrich_enabled?: boolean;
     auto_translation_enabled?: boolean;
     before_message_send_hook_url?: string;
     campaign_enabled?: boolean;
@@ -99,14 +100,17 @@ export type AppSettingsAPIResponse<
       version: string;
       apn?: APNConfig;
       firebase?: FirebaseConfig;
+      huawei?: HuaweiConfig;
     };
     revoke_tokens_issued_before?: string | null;
+    search_backend?: 'disabled' | 'elasticsearch' | 'postgres';
     sqs_key?: string;
     sqs_secret?: string;
     sqs_url?: string;
     suspended?: boolean;
     suspended_explanation?: string;
-    user_search_disallowed_roles?: string[];
+    user_search_disallowed_roles?: string[] | null;
+    webhook_events?: Array<string>;
     webhook_url?: string;
   };
 };
@@ -191,6 +195,7 @@ export type ChannelResponse<
   created_by?: UserResponse<UserType> | null;
   created_by_id?: string;
   deleted_at?: string;
+  hidden?: boolean;
   invites?: string[];
   last_message_at?: string;
   member_count?: number;
@@ -262,6 +267,7 @@ export type CheckPushResponse = APIResponse & {
   general_errors?: string[];
   rendered_apn_template?: string;
   rendered_firebase_template?: string;
+  rendered_huawei_template?: string;
 };
 
 export type CheckSQSResponse = APIResponse & {
@@ -824,7 +830,7 @@ export type ChannelQueryOptions<
   connection_id?: string;
   data?: ChannelResponse<ChannelType, CommandType, UserType>;
   members?: PaginationOptions;
-  messages?: PaginationOptions;
+  messages?: MessagePaginationOptions;
   presence?: boolean;
   state?: boolean;
   watch?: boolean;
@@ -871,9 +877,9 @@ export type CreateCommandOptions<CommandType extends string = LiteralStringForUn
 
 export type CustomPermissionOptions = {
   action: string;
+  condition: object;
   id: string;
   name: string;
-  condition?: string;
   description?: string;
   owner?: boolean;
   same_team?: boolean;
@@ -910,9 +916,15 @@ export type InviteOptions<
   user_id?: string;
 };
 
-export type MarkAllReadOptions<UserType = UnknownType> = {
+/** @deprecated use MarkChannelsReadOptions instead */
+export type MarkAllReadOptions<
+  UserType = UnknownType
+> = MarkChannelsReadOptions<UserType>;
+
+export type MarkChannelsReadOptions<UserType = UnknownType> = {
   client_id?: string;
   connection_id?: string;
+  read_by_channel?: Record<string, string>;
   user?: UserResponse<UserType>;
   user_id?: string;
 };
@@ -950,6 +962,11 @@ export type PaginationOptions = {
   offset?: number;
 };
 
+export type MessagePaginationOptions = PaginationOptions & {
+  created_at_around?: string | Date;
+  id_around?: string;
+};
+
 export type QueryMembersOptions = {
   limit?: number;
   offset?: number;
@@ -1442,6 +1459,10 @@ export type UserSort<UserType = UnknownType> =
   | Sort<UserResponse<UserType>>
   | Array<Sort<UserResponse<UserType>>>;
 
+export type MemberSort<UserType = UnknownType> =
+  | Sort<Pick<UserResponse<UserType>, 'id' | 'created_at' | 'name'>>
+  | Array<Sort<Pick<UserResponse<UserType>, 'id' | 'created_at' | 'name'>>>;
+
 export type SearchMessageSortBase<MessageType = UnknownType> = Sort<MessageType> & {
   attachments?: AscDesc;
   'attachments.type'?: AscDesc;
@@ -1509,6 +1530,7 @@ export type AppSettings = {
     p12_cert?: string;
     team_id?: string;
   };
+  async_url_enrich_enabled?: boolean;
   auto_translation_enabled?: boolean;
   custom_action_handler_url?: string;
   disable_auth_checks?: boolean;
@@ -1523,6 +1545,11 @@ export type AppSettings = {
     server_key?: string;
   };
   grants?: Record<string, string[]>;
+  huawei_config?: {
+    id: string;
+    secret: string;
+    data_template?: string;
+  };
   image_moderation_enabled?: boolean;
   image_upload_config?: FileUploadConfig;
   multi_tenant_enabled?: boolean;
@@ -1533,6 +1560,7 @@ export type AppSettings = {
   sqs_key?: string;
   sqs_secret?: string;
   sqs_url?: string;
+  webhook_events?: Array<string> | null;
   webhook_url?: string;
 };
 
@@ -1557,6 +1585,19 @@ export type Attachment<T = UnknownType> = T & {
   type?: string;
 };
 
+export type OGAttachment = {
+  og_scrape_url: string;
+  asset_url?: string; // og:video | og:audio
+  author_link?: string; // og:site
+  author_name?: string; // og:site_name
+  image_url?: string; // og:image
+  text?: string; // og:description
+  thumb_url?: string; // og:image
+  title?: string; // og:title
+  title_link?: string; // og:url
+  type?: string | 'video' | 'audio' | 'image';
+};
+
 export type BlockList = {
   name: string;
   words: string[];
@@ -1653,6 +1694,8 @@ export type CheckPushInput<UserType = UnknownType> = {
   user_id?: string;
 };
 
+export type PushProvider = 'apn' | 'firebase' | 'huawei';
+
 export type CommandVariants<CommandType extends string = LiteralStringForUnion> =
   | 'all'
   | 'ban'
@@ -1695,7 +1738,7 @@ export type Device<UserType = UnknownType> = DeviceFields & {
 
 export type BaseDeviceFields = {
   id: string;
-  push_provider: 'apn' | 'firebase';
+  push_provider: PushProvider;
 };
 
 export type DeviceFields = BaseDeviceFields & {
@@ -1799,6 +1842,7 @@ export type ExportChannelRequest = {
 
 export type ExportChannelOptions = {
   clear_deleted_message_text?: boolean;
+  include_truncated_messages?: boolean;
 };
 
 export type Field = {
@@ -1808,10 +1852,10 @@ export type Field = {
 };
 
 export type FileUploadConfig = {
-  allowed_file_extensions?: string[];
-  allowed_mime_types?: string[];
-  blocked_file_extensions?: string[];
-  blocked_mime_types?: string[];
+  allowed_file_extensions?: string[] | null;
+  allowed_mime_types?: string[] | null;
+  blocked_file_extensions?: string[] | null;
+  blocked_mime_types?: string[] | null;
 };
 
 export type FirebaseConfig = {
@@ -1821,6 +1865,11 @@ export type FirebaseConfig = {
   notification_template?: string;
 };
 
+export type HuaweiConfig = {
+  data_template?: string;
+  enabled?: boolean;
+};
+
 export type LiteralStringForUnion = string & {};
 
 export type Logger = (
@@ -1893,6 +1942,7 @@ export type PartialMessageUpdate<MessageType = UnknownType> = {
 
 export type PermissionAPIObject = {
   action?: string;
+  condition?: object;
   custom?: boolean;
   description?: string;
   id?: string;
@@ -1990,6 +2040,7 @@ export type TestPushDataInput = {
   apnTemplate?: string;
   firebaseDataTemplate?: string;
   firebaseTemplate?: string;
+  huaweiDataTemplate?: string;
   messageID?: string;
   skipDevices?: boolean;
 };
@@ -2092,6 +2143,30 @@ export type User<UserType = UnknownType> = UserType & {
   username?: string;
 };
 
+export type TaskResponse = {
+  task_id: string;
+};
+
+export type DeleteChannelsResponse = {
+  result: Record<string, string>;
+} & Partial<TaskResponse>;
+
+export type DeleteType = 'soft' | 'hard';
+
+/*
+  DeleteUserOptions specifies a collection of one or more `user_ids` to be deleted.
+
+  `user` soft|hard determines if the user needs to be hard- or soft-deleted, where hard-delete
+  implies that all related objects (messages, flags, etc) will be hard-deleted as well.
+  `conversations` soft|hard will delete any 1to1 channels that the user was a member of.
+  `messages` soft-hard will delete any messages that the user has sent.
+ */
+export type DeleteUserOptions = {
+  user: DeleteType;
+  conversations?: DeleteType;
+  messages?: DeleteType;
+};
+
 export type SegmentData = {
   description: string;
   // TODO: define this type in more detail
@@ -2146,3 +2221,15 @@ export type Campaign = {
   updated_at: string;
 } & CampaignData &
   CampaignStatus;
+
+export type TaskStatus = {
+  created_at: string;
+  status: string;
+  task_id: string;
+  updated_at: string;
+  error?: {
+    description: string;
+    type: string;
+  };
+  result?: UnknownType;
+};