stream-chat 9.16.0 → 9.18.0

package/src/types.ts

@@ -1446,6 +1446,8 @@ export type Event = CustomEventData & {
   ai_message?: string;
   ai_state?: AIState;
   channel?: ChannelResponse;
+  channel_custom?: CustomChannelData;
+  channel_member_count?: number;
   channel_id?: string;
   channel_type?: string;
   cid?: string;
@@ -2242,6 +2244,7 @@ export type AppSettings = {
   disable_permissions_checks?: boolean;
   enforce_unique_usernames?: 'no' | 'app' | 'team';
   event_hooks?: Array<EventHook> | null;
+  explicit_event_hooks_deletion?: boolean;
   // all possible file mime types are https://www.iana.org/assignments/media-types/media-types.xhtml
   file_upload_config?: FileUploadConfig;
   firebase_config?: {
@@ -3784,6 +3787,171 @@ export type UpsertConfigResponse = {
   config: ModerationConfigResponse;
 };
 
+// Moderation Rule Builder Types
+export type ModerationRule = {
+  id: string;
+  name: string;
+  description: string;
+  config_keys: string[];
+  team: string;
+  rule: RuleBuilderRule;
+  enabled: boolean;
+  created_at: string;
+  updated_at: string;
+};
+
+export type ModerationRuleRequest = {
+  name: string;
+  description: string;
+  config_keys: string[];
+  team: string;
+  rule: RuleBuilderRule;
+  enabled: boolean;
+};
+
+export type RuleBuilderRule = {
+  id: string;
+  rule_type: 'user' | 'content';
+  conditions?: RuleBuilderCondition[];
+  logic?: 'AND' | 'OR';
+  groups?: RuleBuilderConditionGroup[];
+  action: RuleBuilderAction;
+  cooldown_period?: string;
+};
+
+export type RuleBuilderCondition = {
+  type: string;
+  confidence?: number;
+  text_rule_params?: TextRuleParameters;
+  image_rule_params?: ImageRuleParameters;
+  video_rule_params?: VideoRuleParameters;
+  user_rule_params?: UserRuleParameters;
+  content_count_rule_params?: ContentCountRuleParameters;
+  text_content_params?: TextContentParameters;
+  image_content_params?: ImageContentParameters;
+  video_content_params?: VideoContentParameters;
+  user_created_within_params?: UserCreatedWithinParameters;
+  user_custom_property_params?: UserCustomPropertyParameters;
+};
+
+export type RuleBuilderConditionGroup = {
+  logic: 'AND' | 'OR';
+  conditions: RuleBuilderCondition[];
+};
+
+export type RuleBuilderAction = {
+  type: string;
+  ban_options?: BanOptions;
+  flag_user_options?: FlagUserOptions;
+  flag_content_options?: FlagContentOptions;
+  remove_content_options?: RemoveContentOptions;
+  shadow_content_options?: ShadowContentOptions;
+};
+
+export type TextRuleParameters = {
+  threshold: number;
+  time_window: string;
+  harm_labels?: string[];
+  llm_harm_labels?: Record<string, string>;
+  contains_url?: boolean;
+  severity?: string;
+  blocklist_match?: string[];
+};
+
+export type ImageRuleParameters = {
+  threshold: number;
+  time_window: string;
+  harm_labels: string[];
+};
+
+export type VideoRuleParameters = {
+  threshold: number;
+  time_window: string;
+  harm_labels: string[];
+};
+
+export type UserRuleParameters = {
+  max_age: string;
+};
+
+export type ContentCountRuleParameters = {
+  threshold: number;
+  time_window: string;
+};
+
+export type TextContentParameters = {
+  harm_labels?: string[];
+  llm_harm_labels?: Record<string, string>;
+  contains_url?: boolean;
+  severity?: string;
+  blocklist_match?: string[];
+};
+
+export type ImageContentParameters = {
+  harm_labels: string[];
+};
+
+export type VideoContentParameters = {
+  harm_labels: string[];
+};
+
+export type UserCreatedWithinParameters = {
+  max_age: string;
+};
+
+export type UserCustomPropertyParameters = {
+  property_key: string;
+  operator: string;
+  expected_value: string;
+};
+
+export type BanOptions = {
+  duration: number;
+  reason: string;
+  shadow_ban: boolean;
+  ip_ban: boolean;
+};
+
+export type FlagUserOptions = {
+  reason: string;
+};
+
+export type FlagContentOptions = {
+  reason: string;
+};
+
+export type RemoveContentOptions = {
+  reason: string;
+};
+
+export type ShadowContentOptions = {
+  reason: string;
+};
+
+export type QueryModerationRulesFilters = QueryFilters<{
+  name?: string;
+  team?: string;
+  enabled?: boolean;
+  rule_type?: string;
+  created_at?: PrimitiveFilter<string>;
+  updated_at?: PrimitiveFilter<string>;
+}>;
+
+export type QueryModerationRulesSort = Array<
+  Sort<'name' | 'enabled' | 'team' | 'created_at' | 'updated_at'>
+>;
+
+export type QueryModerationRulesResponse = {
+  rules: ModerationRule[];
+  default_llm_labels: Record<string, string>;
+  next?: string;
+  prev?: string;
+};
+
+export type UpsertModerationRuleResponse = {
+  rule: ModerationRule;
+};
+
 export type ModerationFlagOptions = {
   custom?: Record<string, unknown>;
   moderation_payload?: ModerationPayload;
@@ -4204,6 +4372,7 @@ export type EventHook = {
   id?: string;
   hook_type?: HookType;
   enabled?: boolean;
+  product?: Product | 'all'; // optional, default is 'all'
   event_types?: Array<string>;
   webhook_url?: string;
   sqs_queue_url?: string;
@@ -4225,6 +4394,7 @@ export type EventHook = {
     mode: 'CALLBACK_MODE_NONE' | 'CALLBACK_MODE_REST' | 'CALLBACK_MODE_TWIRP';
   };
 
+  delete?: boolean;
   created_at?: string;
   updated_at?: string;
 };

package/src/utils.ts

@@ -416,6 +416,81 @@ export const toUpdatedMessagePayload = (
   };
 };
 
+export const toDeletedMessage = ({
+  message,
+  deletedAt,
+  hardDelete = false,
+}: {
+  message: LocalMessage | LocalMessageBase;
+  deletedAt: LocalMessage['deleted_at'];
+  hardDelete: boolean;
+}) => {
+  if (hardDelete) {
+    /**
+     * In case of hard delete, we need to strip down all text, html, attachments and all the custom properties on message
+     * The hard-deleted message is kept in the UI until the messages are re-queried
+     * FIXME: we are returning an object that does not match LocalMessage | LocalMessageBase
+     */
+    return {
+      attachments: [],
+      cid: message.cid,
+      created_at: message.created_at,
+      deleted_at: deletedAt,
+      id: message.id,
+      latest_reactions: [],
+      mentioned_users: [],
+      own_reactions: [],
+      parent_id: message.parent_id,
+      reply_count: message.reply_count,
+      status: message.status,
+      thread_participants: message.thread_participants,
+      type: 'deleted' as const,
+      updated_at: message.updated_at,
+      user: message.user,
+    };
+  } else {
+    return {
+      ...message,
+      attachments: [],
+      type: 'deleted',
+      deleted_at: deletedAt,
+    };
+  }
+};
+
+export const deleteUserMessages = ({
+  messages,
+  user,
+  hardDelete = false,
+  deletedAt,
+}: {
+  messages: Array<LocalMessage>;
+  user: UserResponse;
+  hardDelete: boolean;
+  deletedAt: LocalMessage['deleted_at'];
+}) => {
+  for (let i = 0; i < messages.length; i++) {
+    const message = messages[i];
+    if (message.user?.id === user.id) {
+      messages[i] =
+        message.type === 'deleted'
+          ? message
+          : (toDeletedMessage({ message, hardDelete, deletedAt }) as LocalMessage);
+    }
+
+    if (message.quoted_message?.user?.id === user.id) {
+      messages[i].quoted_message =
+        message.quoted_message.type === 'deleted'
+          ? message.quoted_message
+          : (toDeletedMessage({
+              message: messages[i].quoted_message as LocalMessageBase,
+              hardDelete,
+              deletedAt,
+            }) as LocalMessage);
+    }
+  }
+};
+
 export const findIndexInSortedArray = <T, L>({
   needle,
   sortedArray,