stream-chat 8.47.1 → 8.49.0

package/dist/types/moderation.d.ts

@@ -1,4 +1,4 @@
-import { APIResponse, ModerationConfig, DefaultGenerics, ExtendableGenerics, GetConfigResponse, GetUserModerationReportResponse, ReviewQueueFilters, ReviewQueuePaginationOptions, ReviewQueueResponse, ReviewQueueSort, UpsertConfigResponse, ModerationFlagOptions, ModerationMuteOptions, GetUserModerationReportOptions, SubmitActionOptions, QueryModerationConfigsFilters, QueryModerationConfigsSort, Pager } from './types';
+import { APIResponse, ModerationConfig, DefaultGenerics, ExtendableGenerics, GetConfigResponse, GetUserModerationReportResponse, ReviewQueueFilters, ReviewQueuePaginationOptions, ReviewQueueResponse, ReviewQueueSort, UpsertConfigResponse, ModerationFlagOptions, ModerationMuteOptions, GetUserModerationReportOptions, SubmitActionOptions, QueryModerationConfigsFilters, QueryModerationConfigsSort, Pager, CustomCheckFlag, ReviewQueueItem, QueryConfigsResponse } from './types';
 import { StreamChat } from './client';
 export declare const MODERATION_ENTITY_TYPES: {
     user: string;
@@ -94,20 +94,24 @@ export declare class Moderation<StreamChatGenerics extends ExtendableGenerics =
      * Upsert moderation config
      * @param {Object} config Moderation config to be upserted
      */
-    upsertConfig(config?: ModerationConfig): Promise<UpsertConfigResponse>;
+    upsertConfig(config: ModerationConfig): Promise<UpsertConfigResponse>;
     /**
      * Get moderation config
      * @param {string} key Key for which moderation config is to be fetched
      */
-    getConfig(key: string): Promise<GetConfigResponse>;
-    deleteConfig(key: string): Promise<unknown>;
+    getConfig(key: string, data?: {
+        team?: string;
+    }): Promise<GetConfigResponse>;
+    deleteConfig(key: string, data?: {
+        team?: string;
+    }): Promise<unknown>;
     /**
      * Query moderation configs
      * @param {Object} filterConditions Filter conditions for querying moderation configs
      * @param {Object} sort Sort conditions for querying moderation configs
      * @param {Object} options Additional options for querying moderation configs
      */
-    queryConfigs(filterConditions: QueryModerationConfigsFilters, sort: QueryModerationConfigsSort, options?: Pager): Promise<unknown>;
+    queryConfigs(filterConditions: QueryModerationConfigsFilters, sort: QueryModerationConfigsSort, options?: Pager): Promise<QueryConfigsResponse>;
     submitAction(actionType: string, itemID: string, options?: SubmitActionOptions): Promise<{
         item_id: string;
     } & APIResponse>;
@@ -132,5 +136,37 @@ export declare class Moderation<StreamChatGenerics extends ExtendableGenerics =
     }, configKey: string, options?: {
         force_sync?: boolean;
     }): Promise<unknown>;
+    /**
+     *
+     * @param {string} entityType string Type of entity to be checked E.g., stream:user, stream:chat:v1:message, or any custom string
+     * @param {string} entityID string ID of the entity to be checked. This is mainly for tracking purposes
+     * @param {string} entityCreatorID string ID of the entity creator
+     * @param {object} moderationPayload object Content to be checked for moderation. E.g., { texts: ['text1', 'text2'], images: ['image1', 'image2']}
+     * @param {Array} moderationPayload.texts array Array of texts to be checked for moderation
+     * @param {Array} moderationPayload.images array Array of images to be checked for moderation
+     * @param {Array} moderationPayload.videos array Array of videos to be checked for moderation
+     * @param {Array<CustomCheckFlag>} flags Array of CustomCheckFlag to be passed to flag the entity
+     * @returns
+     */
+    addCustomFlags(entityType: string, entityID: string, entityCreatorID: string, moderationPayload: {
+        images?: string[];
+        texts?: string[];
+        videos?: string[];
+    }, flags: CustomCheckFlag[]): Promise<{
+        id: string;
+        item: ReviewQueueItem;
+        status: string;
+    } & APIResponse>;
+    /**
+     * Add custom flags to a message
+     * @param {string} messageID Message ID to be flagged
+     * @param {Array<CustomCheckFlag>} flags Array of CustomCheckFlag to be passed to flag the message
+     * @returns
+     */
+    addCustomMessageFlags(messageID: string, flags: CustomCheckFlag[]): Promise<{
+        id: string;
+        item: ReviewQueueItem;
+        status: string;
+    } & APIResponse>;
 }
 //# sourceMappingURL=moderation.d.ts.map

package/dist/types/moderation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"moderation.d.ts","sourceRoot":"","sources":["../../src/moderation.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,+BAA+B,EAE/B,kBAAkB,EAClB,4BAA4B,EAC5B,mBAAmB,EACnB,eAAe,EACf,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,8BAA8B,EAC9B,mBAAmB,EACnB,6BAA6B,EAC7B,0BAA0B,EAC1B,KAAK,EACN,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGtC,eAAO,MAAM,uBAAuB;;;CAGnC,CAAC;AAGF,qBAAa,UAAU,CAAC,kBAAkB,SAAS,kBAAkB,GAAG,eAAe;IACrF,MAAM,EAAE,UAAU,CAAC,kBAAkB,CAAC,CAAC;gBAE3B,MAAM,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAIlD;;;;;;;;;OASG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B;;;IAIzF;;;;;;;;;OASG;IACG,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B;;;IAIxF;;;;;;;;;;;;OAYG;IACG,IAAI,CACR,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,EACvB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,qBAA0B;iBAEM,MAAM;;IASjD;;;;;;;OAOG;IACG,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B;;;;;IAUpE;;;;;;OAMG;IACG,UAAU,CACd,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE;QACP,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;iBAEwC,MAAM;;IASjD;;;;;;;OAOG;IACG,uBAAuB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC;IAU1F;;;;;OAKG;IACG,gBAAgB,CACpB,gBAAgB,GAAE,kBAAuB,EACzC,IAAI,GAAE,eAAoB,EAC1B,OAAO,GAAE,4BAAiC;IAS5C;;;OAGG;IACG,YAAY,CAAC,MAAM,GAAE,gBAAqB;IAIhD;;;OAGG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM;IAIrB,YAAY,CAAC,GAAG,EAAE,MAAM;IAI9B;;;;;OAKG;IACG,YAAY,CAChB,gBAAgB,EAAE,6BAA6B,EAC/C,IAAI,EAAE,0BAA0B,EAChC,OAAO,GAAE,KAAU;IASf,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB;iBAC7C,MAAM;;IAUjD;;;;;;;;;;;;OAYG;IACG,KAAK,CACT,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,EACvB,iBAAiB,EAAE;QAEjB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC7B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,EACD,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE;QACR,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB;CAWJ"}
+{"version":3,"file":"moderation.d.ts","sourceRoot":"","sources":["../../src/moderation.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,+BAA+B,EAE/B,kBAAkB,EAClB,4BAA4B,EAC5B,mBAAmB,EACnB,eAAe,EACf,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,8BAA8B,EAC9B,mBAAmB,EACnB,6BAA6B,EAC7B,0BAA0B,EAC1B,KAAK,EACL,eAAe,EACf,eAAe,EACf,oBAAoB,EACrB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGtC,eAAO,MAAM,uBAAuB;;;CAGnC,CAAC;AAGF,qBAAa,UAAU,CAAC,kBAAkB,SAAS,kBAAkB,GAAG,eAAe;IACrF,MAAM,EAAE,UAAU,CAAC,kBAAkB,CAAC,CAAC;gBAE3B,MAAM,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAIlD;;;;;;;;;OASG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B;;;IAIzF;;;;;;;;;OASG;IACG,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B;;;IAIxF;;;;;;;;;;;;OAYG;IACG,IAAI,CACR,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,EACvB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,qBAA0B;iBAEM,MAAM;;IASjD;;;;;;;OAOG;IACG,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B;;;;;IAUpE;;;;;;OAMG;IACG,UAAU,CACd,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE;QACP,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;iBAEwC,MAAM;;IASjD;;;;;;;OAOG;IACG,uBAAuB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC;IAU1F;;;;;OAKG;IACG,gBAAgB,CACpB,gBAAgB,GAAE,kBAAuB,EACzC,IAAI,GAAE,eAAoB,EAC1B,OAAO,GAAE,4BAAiC;IAS5C;;;OAGG;IACG,YAAY,CAAC,MAAM,EAAE,gBAAgB;IAI3C;;;OAGG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE;IAI/C,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE;IAIxD;;;;;OAKG;IACG,YAAY,CAChB,gBAAgB,EAAE,6BAA6B,EAC/C,IAAI,EAAE,0BAA0B,EAChC,OAAO,GAAE,KAAU;IASf,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB;iBAC7C,MAAM;;IAUjD;;;;;;;;;;;;OAYG;IACG,KAAK,CACT,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,EACvB,iBAAiB,EAAE;QAEjB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC7B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,EACD,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE;QACR,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB;IAYH;;;;;;;;;;;OAWG;IACG,cAAc,CAClB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,EACvB,iBAAiB,EAAE;QACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,EACD,KAAK,EAAE,eAAe,EAAE;YAEY,MAAM;cAAQ,eAAe;gBAAU,MAAM;;IAYnF;;;;;OAKG;IACG,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,EAAE;;;;;CAGxE"}

package/dist/types/types.d.ts

@@ -2489,6 +2489,12 @@ export declare type ReviewQueueItem = {
     status: string;
     updated_at: string;
 };
+export declare type CustomCheckFlag = {
+    type: string;
+    custom?: Record<string, any>[];
+    labels?: string[];
+    reason?: string;
+};
 export declare type SubmitActionOptions = {
     ban?: {
         channel_ban_only?: boolean;
@@ -2524,6 +2530,8 @@ export declare type QueryModerationConfigsFilters = QueryFilters<{
     created_at?: PrimitiveFilter<string>;
 } & {
     updated_at?: PrimitiveFilter<string>;
+} & {
+    team?: string;
 }>;
 export declare type ReviewQueueFilters = QueryFilters<{
     assigned_to?: RequireOnlyOne<Pick<QueryFilter<ReviewQueueItem['assigned_to']>, '$eq' | '$in'>> | PrimitiveFilter<ReviewQueueItem['assigned_to']>;
@@ -2562,12 +2570,31 @@ export declare type ReviewQueueResponse = {
     next?: string;
     prev?: string;
 };
-export declare type ModerationConfig = {};
+export declare type ModerationConfig = {
+    key: string;
+    ai_image_config?: AIImageConfig;
+    ai_text_config?: AITextConfig;
+    ai_video_config?: AIVideoConfig;
+    automod_platform_circumvention_config?: AutomodPlatformCircumventionConfig;
+    automod_semantic_filters_config?: AutomodSemanticFiltersConfig;
+    automod_toxicity_config?: AutomodToxicityConfig;
+    block_list_config?: BlockListConfig;
+    team?: string;
+};
+export declare type ModerationConfigResponse = ModerationConfig & {
+    created_at: string;
+    updated_at: string;
+};
 export declare type GetConfigResponse = {
-    config: ModerationConfig;
+    config: ModerationConfigResponse;
+};
+export declare type QueryConfigsResponse = {
+    configs: ModerationConfigResponse[];
+    next?: string;
+    prev?: string;
 };
 export declare type UpsertConfigResponse = {
-    config: ModerationConfig;
+    config: ModerationConfigResponse;
 };
 export declare type ModerationFlagOptions = {
     custom?: Record<string, unknown>;
@@ -2584,5 +2611,97 @@ export declare type GetUserModerationReportOptions = {
     include_user_mutes?: boolean;
 };
 export declare type AIState = 'AI_STATE_ERROR' | 'AI_STATE_CHECKING_SOURCES' | 'AI_STATE_THINKING' | 'AI_STATE_GENERATING' | (string & {});
+export declare type ModerationActionType = 'flag' | 'shadow' | 'remove' | 'bounce' | 'bounce_flag' | 'bounce_remove';
+export declare type AutomodRule = {
+    action: ModerationActionType;
+    label: string;
+    threshold: number;
+};
+export declare type BlockListRule = {
+    action: ModerationActionType;
+    name?: string;
+};
+export declare type BlockListConfig = {
+    enabled: boolean;
+    rules: BlockListRule[];
+    async?: boolean;
+};
+export declare type AutomodToxicityConfig = {
+    enabled: boolean;
+    rules: AutomodRule[];
+    async?: boolean;
+};
+export declare type AutomodPlatformCircumventionConfig = {
+    enabled: boolean;
+    rules: AutomodRule[];
+    async?: boolean;
+};
+export declare type AutomodSemanticFiltersRule = {
+    action: ModerationActionType;
+    name: string;
+    threshold: number;
+};
+export declare type AutomodSemanticFiltersConfig = {
+    enabled: boolean;
+    rules: AutomodSemanticFiltersRule[];
+    async?: boolean;
+};
+export declare type AITextSeverityRule = {
+    action: ModerationActionType;
+    severity: 'low' | 'medium' | 'high' | 'critical';
+};
+export declare type AITextRule = {
+    label: string;
+    action?: ModerationActionType;
+    severity_rules?: AITextSeverityRule[];
+};
+export declare type AITextConfig = {
+    enabled: boolean;
+    rules: AITextRule[];
+    async?: boolean;
+    profile?: string;
+    severity_rules?: AITextSeverityRule[];
+};
+export declare type AIImageRule = {
+    action: ModerationActionType;
+    label: string;
+    min_confidence?: number;
+};
+export declare type AIImageConfig = {
+    enabled: boolean;
+    rules: AIImageRule[];
+    async?: boolean;
+};
+export declare type AIVideoRule = {
+    action: ModerationActionType;
+    label: string;
+    min_confidence?: number;
+};
+export declare type AIVideoConfig = {
+    enabled: boolean;
+    rules: AIVideoRule[];
+    async?: boolean;
+};
+export declare type VelocityFilterConfigRule = {
+    action: 'flag' | 'shadow' | 'remove' | 'ban';
+    ban_duration?: number;
+    cascading_action?: 'flag' | 'shadow' | 'remove' | 'ban';
+    cascading_threshold?: number;
+    check_message_context?: boolean;
+    fast_spam_threshold?: number;
+    fast_spam_ttl?: number;
+    ip_ban?: boolean;
+    shadow_ban?: boolean;
+    slow_spam_ban_duration?: number;
+    slow_spam_threshold?: number;
+    slow_spam_ttl?: number;
+};
+export declare type VelocityFilterConfig = {
+    cascading_actions: boolean;
+    enabled: boolean;
+    first_message_only: boolean;
+    rules: VelocityFilterConfigRule[];
+    async?: boolean;
+};
 export {};
 //# sourceMappingURL=types.d.ts.map