stream-chat 9.17.0 → 9.18.1

package/dist/types/moderation.d.ts

@@ -1,4 +1,4 @@
-import type { APIResponse, CustomCheckFlag, GetConfigResponse, GetUserModerationReportOptions, GetUserModerationReportResponse, ModerationConfig, ModerationFlagOptions, ModerationMuteOptions, Pager, QueryConfigsResponse, QueryModerationConfigsFilters, QueryModerationConfigsSort, RequireAtLeastOne, ReviewQueueFilters, ReviewQueueItem, ReviewQueuePaginationOptions, ReviewQueueResponse, ReviewQueueSort, SubmitActionOptions, UpsertConfigResponse } from './types';
+import type { APIResponse, CustomCheckFlag, GetConfigResponse, GetUserModerationReportOptions, GetUserModerationReportResponse, ModerationConfig, ModerationFlagOptions, ModerationMuteOptions, ModerationRule, ModerationRuleRequest, Pager, QueryConfigsResponse, QueryModerationConfigsFilters, QueryModerationConfigsSort, QueryModerationRulesFilters, QueryModerationRulesResponse, QueryModerationRulesSort, RequireAtLeastOne, ReviewQueueFilters, ReviewQueueItem, ReviewQueuePaginationOptions, ReviewQueueResponse, ReviewQueueSort, SubmitActionOptions, UpsertConfigResponse, UpsertModerationRuleResponse } from './types';
 import type { StreamChat } from './client';
 export declare const MODERATION_ENTITY_TYPES: {
     user: string;
@@ -199,4 +199,32 @@ export declare class Moderation {
         item: ReviewQueueItem;
         status: string;
     } & APIResponse>;
+    /**
+     * Create or update a moderation rule
+     * @param {ModerationRuleRequest} rule Rule configuration to be upserted
+     * @returns
+     */
+    upsertModerationRule(rule: ModerationRuleRequest): Promise<UpsertModerationRuleResponse>;
+    /**
+     * Query moderation rules
+     * @param {QueryModerationRulesFilters} filterConditions Filter conditions for querying moderation rules
+     * @param {QueryModerationRulesSort} sort Sort conditions for querying moderation rules
+     * @param {Pager} options Pagination options for querying moderation rules
+     * @returns
+     */
+    queryModerationRules(filterConditions?: QueryModerationRulesFilters, sort?: QueryModerationRulesSort, options?: Pager): Promise<QueryModerationRulesResponse>;
+    /**
+     * Get a specific moderation rule by ID
+     * @param {string} id ID of the moderation rule to fetch
+     * @returns
+     */
+    getModerationRule(id: string): Promise<{
+        rule: ModerationRule;
+    }>;
+    /**
+     * Delete a moderation rule by ID
+     * @param {string} id ID of the moderation rule to delete
+     * @returns
+     */
+    deleteModerationRule(id: string): Promise<unknown>;
 }

package/dist/types/types.d.ts

@@ -1726,6 +1726,7 @@ export type AppSettings = {
     disable_permissions_checks?: boolean;
     enforce_unique_usernames?: 'no' | 'app' | 'team';
     event_hooks?: Array<EventHook> | null;
+    explicit_event_hooks_deletion?: boolean;
     file_upload_config?: FileUploadConfig;
     firebase_config?: {
         apn_template?: string;
@@ -2753,6 +2754,143 @@ export type QueryConfigsResponse = {
 export type UpsertConfigResponse = {
     config: ModerationConfigResponse;
 };
+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;
@@ -3049,6 +3187,7 @@ export type EventHook = {
     id?: string;
     hook_type?: HookType;
     enabled?: boolean;
+    product?: Product | 'all';
     event_types?: Array<string>;
     webhook_url?: string;
     sqs_queue_url?: string;
@@ -3067,6 +3206,7 @@ export type EventHook = {
     callback?: {
         mode: 'CALLBACK_MODE_NONE' | 'CALLBACK_MODE_REST' | 'CALLBACK_MODE_TWIRP';
     };
+    delete?: boolean;
     created_at?: string;
     updated_at?: string;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stream-chat",
-  "version": "9.17.0",
+  "version": "9.18.1",
   "description": "JS SDK for the Stream Chat API",
   "homepage": "https://getstream.io/chat/",
   "author": {

package/src/moderation.ts

@@ -7,11 +7,16 @@ import type {
   ModerationConfig,
   ModerationFlagOptions,
   ModerationMuteOptions,
+  ModerationRule,
+  ModerationRuleRequest,
   MuteUserResponse,
   Pager,
   QueryConfigsResponse,
   QueryModerationConfigsFilters,
   QueryModerationConfigsSort,
+  QueryModerationRulesFilters,
+  QueryModerationRulesResponse,
+  QueryModerationRulesSort,
   RequireAtLeastOne,
   ReviewQueueFilters,
   ReviewQueueItem,
@@ -20,6 +25,7 @@ import type {
   ReviewQueueSort,
   SubmitActionOptions,
   UpsertConfigResponse,
+  UpsertModerationRuleResponse,
 } from './types';
 import type { StreamChat } from './client';
 import { normalizeQuerySort } from './utils';
@@ -388,4 +394,60 @@ export class Moderation {
       flags,
     );
   }
+
+  /**
+   * Create or update a moderation rule
+   * @param {ModerationRuleRequest} rule Rule configuration to be upserted
+   * @returns
+   */
+  async upsertModerationRule(rule: ModerationRuleRequest) {
+    return await this.client.post<UpsertModerationRuleResponse>(
+      this.client.baseURL + '/api/v2/moderation/moderation_rule',
+      rule,
+    );
+  }
+
+  /**
+   * Query moderation rules
+   * @param {QueryModerationRulesFilters} filterConditions Filter conditions for querying moderation rules
+   * @param {QueryModerationRulesSort} sort Sort conditions for querying moderation rules
+   * @param {Pager} options Pagination options for querying moderation rules
+   * @returns
+   */
+  async queryModerationRules(
+    filterConditions: QueryModerationRulesFilters = {},
+    sort: QueryModerationRulesSort = [],
+    options: Pager = {},
+  ) {
+    return await this.client.post<QueryModerationRulesResponse>(
+      this.client.baseURL + '/api/v2/moderation/moderation_rules',
+      {
+        filter: filterConditions,
+        sort,
+        ...options,
+      },
+    );
+  }
+
+  /**
+   * Get a specific moderation rule by ID
+   * @param {string} id ID of the moderation rule to fetch
+   * @returns
+   */
+  async getModerationRule(id: string) {
+    return await this.client.get<{ rule: ModerationRule }>(
+      this.client.baseURL + '/api/v2/moderation/moderation_rule/' + id,
+    );
+  }
+
+  /**
+   * Delete a moderation rule by ID
+   * @param {string} id ID of the moderation rule to delete
+   * @returns
+   */
+  async deleteModerationRule(id: string) {
+    return await this.client.delete(
+      this.client.baseURL + '/api/v2/moderation/moderation_rule/' + id,
+    );
+  }
 }

package/src/types.ts

@@ -2244,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?: {
@@ -3786,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;
@@ -4206,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;
@@ -4227,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

@@ -310,16 +310,16 @@ export function formatMessage(
     if (!msg) return null;
     return {
       ...msg,
-      created_at: message.created_at ? new Date(message.created_at) : new Date(),
-      deleted_at: message.deleted_at ? new Date(message.deleted_at) : null,
-      pinned_at: message.pinned_at ? new Date(message.pinned_at) : null,
+      created_at: msg.created_at ? new Date(msg.created_at) : new Date(),
+      deleted_at: msg.deleted_at ? new Date(msg.deleted_at) : null,
+      pinned_at: msg.pinned_at ? new Date(msg.pinned_at) : null,
       reaction_groups: maybeGetReactionGroupsFallback(
-        message.reaction_groups,
-        message.reaction_counts,
-        message.reaction_scores,
+        msg.reaction_groups,
+        msg.reaction_counts,
+        msg.reaction_scores,
       ),
-      status: message.status || 'received',
-      updated_at: message.updated_at ? new Date(message.updated_at) : new Date(),
+      status: msg.status || 'received',
+      updated_at: msg.updated_at ? new Date(msg.updated_at) : new Date(),
     };
   };