stream-chat 6.0.0 → 6.3.0

package/src/types.ts

@@ -120,6 +120,7 @@ export type AppSettingsAPIResponse<StreamChatGenerics extends ExtendableGenerics
       apn?: APNConfig;
       firebase?: FirebaseConfig;
       huawei?: HuaweiConfig;
+      providers?: PushProviderConfig[];
       xiaomi?: XiaomiConfig;
     };
     revoke_tokens_issued_before?: string | null;
@@ -147,6 +148,31 @@ export type ModerationResult = {
   moderated_by?: string;
 };
 
+export type AutomodDetails = {
+  action?: string;
+  image_labels?: Array<string>;
+  original_message_type?: string;
+  result?: ModerationResult;
+};
+
+export type FlagDetails = {
+  automod?: AutomodDetails;
+};
+
+export type Flag<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
+  created_at: string;
+  created_by_automod: boolean;
+  updated_at: string;
+  details?: FlagDetails;
+  target_message?: MessageResponse<StreamChatGenerics>;
+  target_user?: UserResponse<StreamChatGenerics>;
+  user?: UserResponse<StreamChatGenerics>;
+};
+
+export type FlagsResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
+  flags?: Array<Flag<StreamChatGenerics>>;
+};
+
 export type MessageFlagsResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
   flags?: Array<{
     message: MessageResponse<StreamChatGenerics>;
@@ -168,7 +194,7 @@ export type FlagReport<StreamChatGenerics extends ExtendableGenerics = DefaultGe
   message: MessageResponse<StreamChatGenerics>;
   user: UserResponse<StreamChatGenerics>;
   created_at?: string;
-  details?: Object;
+  details?: FlagDetails;
   review_result?: string;
   reviewed_at?: string;
   reviewed_by?: UserResponse<StreamChatGenerics>;
@@ -632,6 +658,11 @@ export type MessageFlagsPaginationOptions = {
   offset?: number;
 };
 
+export type FlagsPaginationOptions = {
+  limit?: number;
+  offset?: number;
+};
+
 export type FlagReportsPaginationOptions = {
   limit?: number;
   offset?: number;
@@ -963,10 +994,48 @@ export type MessageFlagsFilters = QueryFilters<
     }
 >;
 
+export type FlagsFiltersOptions = {
+  channel_cid?: string;
+  message_id?: string;
+  message_user_id?: string;
+  reporter_id?: string;
+  team?: string;
+  user_id?: string;
+};
+
+export type FlagsFilters = QueryFilters<
+  {
+    user_id?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagsFiltersOptions['user_id']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagsFiltersOptions['user_id']>;
+  } & {
+    message_id?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagsFiltersOptions['message_id']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagsFiltersOptions['message_id']>;
+  } & {
+    message_user_id?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagsFiltersOptions['message_user_id']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagsFiltersOptions['message_user_id']>;
+  } & {
+    channel_cid?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagsFiltersOptions['channel_cid']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagsFiltersOptions['channel_cid']>;
+  } & {
+    reporter_id?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagsFiltersOptions['reporter_id']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagsFiltersOptions['reporter_id']>;
+  } & {
+    team?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagsFiltersOptions['team']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagsFiltersOptions['team']>;
+  }
+>;
+
 export type FlagReportsFiltersOptions = {
   channel_cid?: string;
   is_reviewed?: boolean;
   message_id?: string;
+  message_user_id?: string;
   report_id?: string;
   review_result?: string;
   reviewed_by?: string;
@@ -995,6 +1064,10 @@ export type FlagReportsFilters = QueryFilters<
     message_id?:
       | RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['message_id']>, '$eq' | '$in'>>
       | PrimitiveFilter<FlagReportsFiltersOptions['message_id']>;
+  } & {
+    message_user_id?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['message_user_id']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagReportsFiltersOptions['message_user_id']>;
   } & {
     channel_cid?:
       | RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['channel_cid']>, '$eq' | '$in'>>
@@ -1010,6 +1083,7 @@ export type FlagReportsFilters = QueryFilters<
       >]: RequireOnlyOne<QueryFilter<FlagReportsFiltersOptions[Key]>> | PrimitiveFilter<FlagReportsFiltersOptions[Key]>;
     }
 >;
+
 export type BannedUsersFilterOptions = {
   banned_by_id?: string;
   channel_cid?: string;
@@ -1340,6 +1414,7 @@ export type Action = {
 export type AnonUserType = {};
 
 export type APNConfig = {
+  auth_key?: string;
   auth_type?: string;
   bundle_id?: string;
   development?: boolean;
@@ -1347,6 +1422,7 @@ export type APNConfig = {
   host?: string;
   key_id?: string;
   notification_template?: string;
+  p12_cert?: string;
   team_id?: string;
 };
 
@@ -1371,7 +1447,7 @@ export type AppSettings = {
   // all possible file mime types are https://www.iana.org/assignments/media-types/media-types.xhtml
   file_upload_config?: FileUploadConfig;
   firebase_config?: {
-    credentials_json: string;
+    credentials_json?: string;
     data_template?: string;
     notification_template?: string;
     server_key?: string;
@@ -1413,6 +1489,7 @@ export type Attachment<
   file_size?: number | string;
   footer?: string;
   footer_icon?: string;
+  giphy?: GiphyData;
   image_url?: string;
   mime_type?: string;
   og_scrape_url?: string;
@@ -1534,6 +1611,54 @@ export type CheckPushInput<StreamChatGenerics extends ExtendableGenerics = Defau
 
 export type PushProvider = 'apn' | 'firebase' | 'huawei' | 'xiaomi';
 
+export type PushProviderConfig = PushProviderCommon &
+  PushProviderAPN &
+  PushProviderFirebase &
+  PushProviderHuawei &
+  PushProviderXiaomi;
+
+export type PushProviderID = {
+  name: string;
+  type: PushProvider;
+};
+
+export type PushProviderCommon = {
+  created_at: string;
+  updated_at: string;
+  description?: string;
+  disabled_at?: string;
+  disabled_reason?: string;
+};
+
+export type PushProviderAPN = {
+  apn_auth_key?: string;
+  apn_auth_type?: 'token' | 'certificate';
+  apn_development?: boolean;
+  apn_host?: string;
+  apn_key_id?: string;
+  apn_notification_template?: string;
+  apn_p12_cert?: string;
+  apn_team_id?: string;
+  apn_topic?: string;
+};
+
+export type PushProviderFirebase = {
+  firebase_credentials?: string;
+  firebase_data_template?: string;
+  firebase_notification_template?: string;
+  firebase_server_key?: string;
+};
+
+export type PushProviderHuawei = {
+  huawei_app_id?: string;
+  huawei_app_secret?: string;
+};
+
+export type PushProviderXiaomi = {
+  xiaomi_package_name?: string;
+  xiaomi_secret?: string;
+};
+
 export type CommandVariants<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> =
   | 'all'
   | 'ban'
@@ -1702,14 +1827,38 @@ export type FirebaseConfig = {
   data_template?: string;
   enabled?: boolean;
   notification_template?: string;
+  server_key?: string;
+};
+
+type GiphyVersionInfo = {
+  height: string;
+  url: string;
+  width: string;
+};
+
+type GiphyVersions =
+  | 'original'
+  | 'fixed_height'
+  | 'fixed_height_still'
+  | 'fixed_height_downsampled'
+  | 'fixed_width'
+  | 'fixed_width_still'
+  | 'fixed_width_downsampled';
+
+type GiphyData = {
+  [key in GiphyVersions]: GiphyVersionInfo;
 };
 
 export type HuaweiConfig = {
   enabled?: boolean;
+  id?: string;
+  secret?: string;
 };
 
 export type XiaomiConfig = {
   enabled?: boolean;
+  package_name?: string;
+  secret?: string;
 };
 
 export type LiteralStringForUnion = string & {};
@@ -2057,9 +2206,13 @@ export type TruncateOptions<StreamChatGenerics extends ExtendableGenerics = Defa
   truncated_at?: Date;
 };
 
+export type CreateImportURLResponse = {
+  path: string;
+  upload_url: string;
+};
+
 export type CreateImportResponse = {
   import_task: ImportTask;
-  upload_url: string;
 };
 
 export type GetImportResponse = {
@@ -2083,11 +2236,21 @@ export type ImportTaskHistory = {
 
 export type ImportTask = {
   created_at: string;
-  filename: string;
   history: ImportTaskHistory[];
   id: string;
+  path: string;
   state: string;
   updated_at: string;
   result?: UR;
   size?: number;
 };
+
+export type MessageSetType = 'latest' | 'current' | 'new';
+
+export type PushProviderUpsertResponse = {
+  push_provider: PushProvider;
+};
+
+export type PushProviderListResponse = {
+  push_providers: PushProvider[];
+};