@stream-io/feeds-client 0.2.1 → 0.2.3

package/dist/src/common/{ActivitySearchSource.d.ts → search/ActivitySearchSource.d.ts}

@@ -1,7 +1,7 @@
 import { BaseSearchSource } from './BaseSearchSource';
-import type { SearchSourceOptions } from './BaseSearchSource';
-import { FeedsClient } from '../feeds-client';
-import { ActivityResponse } from '../gen/models';
+import type { SearchSourceOptions } from './types';
+import { FeedsClient } from '../../feeds-client';
+import { ActivityResponse } from '../../gen/models';
 export declare class ActivitySearchSource extends BaseSearchSource<ActivityResponse> {
     readonly type: "activity";
     private readonly client;

package/dist/src/common/{BaseSearchSource.d.ts → search/BaseSearchSource.d.ts}

@@ -1,17 +1,12 @@
-import { StateStore } from './StateStore';
-import { type DebouncedFunc } from './utils';
-export type SearchSourceType = 'activity' | 'user' | 'feed' | (string & {});
-export type QueryReturnValue<T> = {
-    items: T[];
-    next?: string | null;
-};
+import { StateStore } from '../StateStore';
+import { type DebouncedFunc } from '../utils';
+import type { QueryReturnValue, SearchSourceOptions, SearchSourceState, SearchSourceType } from './types';
 export type DebounceOptions = {
     debounceMs: number;
 };
 type DebouncedExecQueryFunction = DebouncedFunc<(searchString?: string) => Promise<void>>;
-export interface SearchSource<T = any> {
+interface ISearchSource<T = any> {
     activate(): void;
-    cancelScheduledQuery(): void;
     canExecuteQuery(newSearchString?: string): boolean;
     deactivate(): void;
     readonly hasNext: boolean;
@@ -24,34 +19,26 @@ export interface SearchSource<T = any> {
     readonly next: string | undefined | null;
     readonly offset: number | undefined;
     resetState(): void;
-    search(text?: string): Promise<void> | undefined;
     readonly searchQuery: string;
-    setDebounceOptions(options: DebounceOptions): void;
     readonly state: StateStore<SearchSourceState<T>>;
     readonly type: SearchSourceType;
 }
-export type SearchSourceState<T = any> = {
-    hasNext: boolean;
-    isActive: boolean;
-    isLoading: boolean;
-    items: T[] | undefined;
-    searchQuery: string;
-    lastQueryError?: Error;
-    next?: string | null;
-    offset?: number;
-};
-export type SearchSourceOptions = {
-    /** The number of milliseconds to debounce the search query. The default interval is 300ms. */
-    debounceMs?: number;
-    pageSize?: number;
-    allowEmptySearchString?: boolean;
-};
-export declare abstract class BaseSearchSource<T> implements SearchSource<T> {
+export interface SearchSource<T = any> extends ISearchSource<T> {
+    cancelScheduledQuery(): void;
+    setDebounceOptions(options: DebounceOptions): void;
+    search(text?: string): Promise<void> | undefined;
+}
+export interface SearchSourceSync<T = any> extends ISearchSource<T> {
+    cancelScheduledQuery(): void;
+    setDebounceOptions(options: DebounceOptions): void;
+    search(text?: string): void;
+}
+declare abstract class BaseSearchSourceBase<T> implements ISearchSource<T> {
     state: StateStore<SearchSourceState<T>>;
-    protected pageSize: number;
+    pageSize: number;
     protected allowEmptySearchString: boolean;
+    protected resetOnNewSearchQuery: boolean;
     abstract readonly type: SearchSourceType;
-    protected searchDebounced: DebouncedExecQueryFunction;
     protected constructor(options?: SearchSourceOptions);
     get lastQueryError(): Error | undefined;
     get hasNext(): boolean;
@@ -72,18 +59,37 @@ export declare abstract class BaseSearchSource<T> implements SearchSource<T> {
     get next(): string | null | undefined;
     get offset(): number | undefined;
     get searchQuery(): string;
-    protected abstract query(searchQuery: string): Promise<QueryReturnValue<T>>;
-    protected abstract filterQueryResults(items: T[]): T[] | Promise<T[]>;
-    setDebounceOptions: ({ debounceMs }: DebounceOptions) => void;
     activate: () => void;
     deactivate: () => void;
     canExecuteQuery: (newSearchString?: string) => boolean;
     protected getStateBeforeFirstQuery(newSearchString: string): SearchSourceState<T>;
     protected getStateAfterQuery(stateUpdate: Partial<SearchSourceState<T>>, isFirstPage: boolean): SearchSourceState<T>;
+    protected prepareStateForQuery(newSearchString?: string): {
+        searchString: string;
+        hasNewSearchQuery: boolean;
+    };
+    protected updatePaginationStateFromQuery(result: QueryReturnValue<T>): Partial<SearchSourceState<T>>;
+    resetState(): void;
+    resetStateAndActivate(): void;
+}
+export declare abstract class BaseSearchSource<T> extends BaseSearchSourceBase<T> implements SearchSource<T> {
+    protected searchDebounced: DebouncedExecQueryFunction;
+    constructor(options?: SearchSourceOptions);
+    protected abstract query(searchQuery: string): Promise<QueryReturnValue<T>>;
+    protected abstract filterQueryResults(items: T[]): T[] | Promise<T[]>;
+    setDebounceOptions: ({ debounceMs }: DebounceOptions) => void;
     executeQuery(newSearchString?: string): Promise<void>;
     search: (searchQuery?: string) => Promise<void> | undefined;
     cancelScheduledQuery(): void;
-    resetState(): void;
-    resetStateAndActivate(): void;
+}
+export declare abstract class BaseSearchSourceSync<T> extends BaseSearchSourceBase<T> implements SearchSourceSync<T> {
+    protected searchDebounced: DebouncedExecQueryFunction;
+    constructor(options?: SearchSourceOptions);
+    protected abstract query(searchQuery: string): QueryReturnValue<T>;
+    protected abstract filterQueryResults(items: T[]): T[];
+    setDebounceOptions: ({ debounceMs }: DebounceOptions) => void;
+    executeQuery(newSearchString?: string): void;
+    search: (searchQuery?: string) => Promise<void> | undefined;
+    cancelScheduledQuery(): void;
 }
 export {};

package/dist/src/common/{FeedSearchSource.d.ts → search/FeedSearchSource.d.ts}

@@ -1,7 +1,7 @@
 import { BaseSearchSource } from './BaseSearchSource';
-import type { SearchSourceOptions } from './BaseSearchSource';
-import { FeedsClient } from '../feeds-client';
-import { Feed } from '../feed';
+import type { SearchSourceOptions } from './types';
+import { FeedsClient } from '../../feeds-client';
+import { Feed } from '../../feed';
 export type FeedSearchSourceOptions = SearchSourceOptions & {
     groupId?: string;
 };

package/dist/src/common/{SearchController.d.ts → search/SearchController.d.ts}

@@ -1,4 +1,4 @@
-import { StateStore } from './StateStore';
+import { StateStore } from '../StateStore';
 import type { SearchSource } from './BaseSearchSource';
 export type SearchControllerState = {
     isActive: boolean;
@@ -17,8 +17,6 @@ export declare class SearchController {
     /**
      * Not intended for direct use by integrators, might be removed without notice resulting in
      * broken integrations.
-     *
-     * @internal
      */
     _internalState: StateStore<InternalSearchControllerState>;
     state: StateStore<SearchControllerState>;

package/dist/src/common/{UserSearchSource.d.ts → search/UserSearchSource.d.ts}

@@ -1,7 +1,7 @@
 import { BaseSearchSource } from './BaseSearchSource';
-import type { SearchSourceOptions } from './BaseSearchSource';
-import { FeedsClient } from '../feeds-client';
-import { UserResponse } from '../gen/models';
+import type { SearchSourceOptions } from './types';
+import { FeedsClient } from '../../feeds-client';
+import { UserResponse } from '../../gen/models';
 export declare class UserSearchSource extends BaseSearchSource<UserResponse> {
     readonly type: "user";
     private readonly client;
@@ -10,7 +10,7 @@ export declare class UserSearchSource extends BaseSearchSource<UserResponse> {
         items: never[];
         next?: undefined;
     } | {
-        items: import("../gen/models").FullUserResponse[];
+        items: import("../../gen/models").FullUserResponse[];
         next: undefined;
     }>;
     protected filterQueryResults(items: UserResponse[]): UserResponse[];

package/dist/src/common/search/index.d.ts

@@ -0,0 +1,6 @@
+export * from './SearchController';
+export * from './BaseSearchSource';
+export * from './ActivitySearchSource';
+export * from './FeedSearchSource';
+export * from './UserSearchSource';
+export * from './types';

package/dist/src/common/search/types.d.ts

@@ -0,0 +1,22 @@
+export type SearchSourceState<T = any> = {
+    hasNext: boolean;
+    isActive: boolean;
+    isLoading: boolean;
+    items: T[] | undefined;
+    searchQuery: string;
+    lastQueryError?: Error;
+    next?: string | null;
+    offset?: number;
+};
+export type SearchSourceOptions = {
+    /** The number of milliseconds to debounce the search query. The default interval is 300ms. */
+    debounceMs?: number;
+    pageSize?: number;
+    allowEmptySearchString?: boolean;
+    resetOnNewSearchQuery?: boolean;
+};
+export type SearchSourceType = 'activity' | 'user' | 'feed' | (string & {});
+export type QueryReturnValue<T> = {
+    items: T[];
+    next?: string | null;
+};

package/dist/src/common/types.d.ts

@@ -1,3 +1,4 @@
+export * from './search/types';
 export type FeedsClientOptions = {
     base_url?: string;
     timeout?: number;

package/dist/src/feed/event-handlers/activity/handle-activity-deleted.d.ts

@@ -1,17 +1,10 @@
 import type { Feed } from '../../../feed';
 import type { ActivityPinResponse, ActivityResponse } from '../../../gen/models';
-import type { EventPayload } from '../../../types-internal';
-export declare const removeActivityFromState: (activityResponse: ActivityResponse, activities: ActivityResponse[] | undefined) => {
-    changed: boolean;
+import type { EventPayload, UpdateStateResult } from '../../../types-internal';
+export declare const removeActivityFromState: (activityResponse: ActivityResponse, activities: ActivityResponse[] | undefined) => UpdateStateResult<{
     activities: ActivityResponse[] | undefined;
-};
-export declare const removePinnedActivityFromState: (activityResponse: ActivityResponse, pinnedActivities: ActivityPinResponse[] | undefined) => {
-    changed: boolean;
-    activities: ActivityPinResponse[];
-    pinned_activities?: undefined;
-} | {
-    changed: boolean;
+}>;
+export declare const removePinnedActivityFromState: (activityResponse: ActivityResponse, pinnedActivities: ActivityPinResponse[] | undefined) => UpdateStateResult<{
     pinned_activities: ActivityPinResponse[] | undefined;
-    activities?: undefined;
-};
+}>;
 export declare function handleActivityDeleted(this: Feed, event: EventPayload<'feeds.activity.deleted'>): void;

package/dist/src/feed/event-handlers/activity/handle-activity-marked.d.ts

@@ -0,0 +1,11 @@
+import { ActivityMarkEvent, NotificationStatusResponse } from '../../../gen/models';
+import { EventPayload, UpdateStateResult } from '../../../types-internal';
+import { Feed } from '../../feed';
+export declare const updateNotificationStatusFromActivityMarked: (event: ActivityMarkEvent, currentNotificationStatus: NotificationStatusResponse | undefined, aggregatedActivities?: Array<{
+    group: string;
+}>) => UpdateStateResult<{
+    data?: {
+        notification_status: NotificationStatusResponse;
+    };
+}>;
+export declare function handleActivityMarked(this: Feed, event: EventPayload<'feeds.activity.marked'>): void;

package/dist/src/feed/event-handlers/activity/index.d.ts

@@ -4,3 +4,4 @@ export * from './handle-activity-removed-from-feed';
 export * from './handle-activity-updated';
 export * from './handle-activity-reaction-added';
 export * from './handle-activity-reaction-deleted';
+export * from './handle-activity-marked';

package/dist/src/feed/event-handlers/notification-feed/handle-notification-feed-updated.d.ts

@@ -1,3 +1,10 @@
 import type { Feed } from '../../../feed';
-import type { EventPayload } from '../../../types-internal';
+import { AggregatedActivityResponse, NotificationFeedUpdatedEvent, NotificationStatusResponse } from '../../../gen/models';
+import type { EventPayload, UpdateStateResult } from '../../../types-internal';
+export declare const updateNotificationFeedFromEvent: (event: NotificationFeedUpdatedEvent) => UpdateStateResult<{
+    data?: {
+        notification_status?: NotificationStatusResponse;
+        aggregated_activities?: AggregatedActivityResponse[];
+    };
+}>;
 export declare function handleNotificationFeedUpdated(this: Feed, event: EventPayload<'feeds.notification_feed.updated'>): void;

package/dist/src/feed/feed.d.ts

@@ -1,4 +1,4 @@
-import { ActivityRequest, FeedResponse, GetOrCreateFeedRequest, GetOrCreateFeedResponse, QueryFollowsRequest, WSEvent, ActivityResponse, CommentResponse, QueryFeedMembersRequest, SortParamRequest, FollowRequest } from '../gen/models';
+import { ActivityRequest, FeedResponse, GetOrCreateFeedRequest, GetOrCreateFeedResponse, QueryFollowsRequest, WSEvent, ActivityResponse, CommentResponse, QueryFeedMembersRequest, SortParamRequest, FollowRequest, QueryCommentsRequest } from '../gen/models';
 import { StreamResponse } from '../gen-imports';
 import { StateStore } from '../common/StateStore';
 import { EventDispatcher } from '../common/EventDispatcher';
@@ -16,7 +16,7 @@ export type FeedState = Omit<Partial<GetOrCreateFeedResponse & FeedResponse>, 'f
     is_loading_activities: boolean;
     comments_by_entity_id: Record<ActivityIdOrCommentId, {
         pagination?: PagerResponseWithLoadingStates & {
-            sort?: string;
+            sort?: QueryCommentsRequest['sort'] | (string & {});
         };
         /**
          * Id of the "store" where the actual parent is stored in the comments array.

package/dist/src/gen/models/index.d.ts

@@ -326,6 +326,7 @@ export interface AddBookmarkResponse {
 export interface AddCommentReactionRequest {
     type: string;
     create_notification_activity?: boolean;
+    skip_push?: boolean;
     custom?: Record<string, any>;
 }
 export interface AddCommentReactionResponse {
@@ -339,6 +340,7 @@ export interface AddCommentRequest {
     object_type: string;
     create_notification_activity?: boolean;
     parent_id?: string;
+    skip_push?: boolean;
     attachments?: Attachment[];
     mentioned_user_ids?: string[];
     custom?: Record<string, any>;
@@ -361,6 +363,7 @@ export interface AddFolderRequest {
 export interface AddReactionRequest {
     type: string;
     create_notification_activity?: boolean;
+    skip_push?: boolean;
     custom?: Record<string, any>;
 }
 export interface AddReactionResponse {
@@ -495,10 +498,10 @@ export interface BanActionRequest {
     timeout?: number;
 }
 export interface BanOptions {
-    duration: number;
-    ip_ban: boolean;
-    reason: string;
-    shadow_ban: boolean;
+    duration?: number;
+    ip_ban?: boolean;
+    reason?: string;
+    shadow_ban?: boolean;
 }
 export interface BanRequest {
     target_user_id: string;
@@ -515,7 +518,7 @@ export interface BanResponse {
     duration: string;
 }
 export interface BlockContentOptions {
-    reason: string;
+    reason?: string;
 }
 export interface BlockListConfig {
     enabled: boolean;
@@ -944,6 +947,9 @@ export interface ChannelMember {
     deleted_messages?: string[];
     user?: UserResponse;
 }
+export interface ChannelMemberResponse {
+    channel_role: string;
+}
 export interface ChannelMute {
     created_at: Date;
     updated_at: Date;
@@ -1030,6 +1036,7 @@ export interface Command {
 export interface CommentAddedEvent {
     created_at: Date;
     fid: string;
+    activity: ActivityResponse;
     comment: CommentResponse;
     custom: Record<string, any>;
     type: string;
@@ -1050,6 +1057,7 @@ export interface CommentDeletedEvent {
 export interface CommentReactionAddedEvent {
     created_at: Date;
     fid: string;
+    activity: ActivityResponse;
     comment: CommentResponse;
     custom: Record<string, any>;
     reaction: FeedsReactionResponse;
@@ -1071,6 +1079,7 @@ export interface CommentReactionDeletedEvent {
 export interface CommentReactionUpdatedEvent {
     created_at: Date;
     fid: string;
+    activity: ActivityResponse;
     comment: CommentResponse;
     custom: Record<string, any>;
     reaction: FeedsReactionResponse;
@@ -1149,7 +1158,6 @@ export interface ConfigResponse {
     automod_toxicity_config?: AutomodToxicityConfig;
     block_list_config?: BlockListConfig;
     llm_config?: LLMConfig;
-    rule_builder_config?: RuleBuilderConfig;
     velocity_filter_config?: VelocityFilterConfig;
     video_call_rule_config?: VideoCallRuleConfig;
 }
@@ -1163,8 +1171,8 @@ export interface ConnectUserDetailsRequest {
     privacy_settings?: PrivacySettingsResponse;
 }
 export interface ContentCountRuleParameters {
-    threshold: number;
-    time_window: string;
+    threshold?: number;
+    time_window?: string;
 }
 export interface CreateBlockListRequest {
     name: string;
@@ -1484,6 +1492,7 @@ export interface FeedGroup {
     last_feed_get_at?: Date;
     aggregation?: AggregationConfig;
     notification?: NotificationConfig;
+    push_notification?: PushNotificationConfig;
     ranking?: RankingConfig;
     stories?: StoriesConfig;
 }
@@ -1635,6 +1644,12 @@ export interface FeedUpdatedEvent {
     received_at?: Date;
     user?: UserResponseCommonFields;
 }
+export interface FeedsEventPreferences {
+    comments?: string;
+    mentions?: string;
+    new_followers?: string;
+    reactions?: string;
+}
 export interface FeedsReactionResponse {
     activity_id: string;
     created_at: Date;
@@ -1684,7 +1699,7 @@ export interface Flag {
     user?: User;
 }
 export interface FlagContentOptions {
-    reason: string;
+    reason?: string;
 }
 export interface FlagRequest {
     entity_id: string;
@@ -1699,7 +1714,7 @@ export interface FlagResponse {
     item_id: string;
 }
 export interface FlagUserOptions {
-    reason: string;
+    reason?: string;
 }
 export interface FollowBatchRequest {
     follows: FollowRequest[];
@@ -1731,6 +1746,7 @@ export interface FollowRequest {
     target: string;
     create_notification_activity?: boolean;
     push_preference?: 'all' | 'none';
+    skip_push?: boolean;
     custom?: Record<string, any>;
 }
 export interface FollowResponse {
@@ -1951,8 +1967,8 @@ export interface ImageData {
     width: string;
 }
 export interface ImageRuleParameters {
-    threshold: number;
-    time_window: string;
+    threshold?: number;
+    time_window?: string;
     harm_labels?: string[];
 }
 export interface ImageSize {
@@ -2024,6 +2040,7 @@ export interface IngressVideoLayerResponse {
 export interface LLMConfig {
     enabled: boolean;
     rules: LLMRule[];
+    app_context?: string;
     async?: boolean;
     severity_descriptions?: Record<string, string>;
 }
@@ -2125,6 +2142,7 @@ export interface Message {
     thread_participants?: User[];
     i18n?: Record<string, string>;
     image_labels?: Record<string, string[]>;
+    member?: ChannelMember;
     moderation?: ModerationV2Response;
     pinned_by?: User;
     poll?: Poll;
@@ -2182,6 +2200,7 @@ export interface MessageResponse {
     draft?: DraftResponse;
     i18n?: Record<string, string>;
     image_labels?: Record<string, string[]>;
+    member?: ChannelMemberResponse;
     moderation?: ModerationV2Response;
     pinned_by?: UserResponse;
     poll?: PollResponseData;
@@ -2206,11 +2225,11 @@ export interface ModerationCustomActionEvent {
     user?: User;
 }
 export interface ModerationFlagResponse {
-    created_at: string;
+    created_at: Date;
     entity_id: string;
     entity_type: string;
     type: string;
-    updated_at: string;
+    updated_at: Date;
     user_id: string;
     result: Array<Record<string, any>>;
     entity_creator_id?: string;
@@ -2554,10 +2573,16 @@ export interface PrivacySettingsResponse {
     read_receipts?: ReadReceiptsResponse;
     typing_indicators?: TypingIndicatorsResponse;
 }
+export interface PushNotificationConfig {
+    enabled?: boolean;
+    activity_types?: string[];
+}
 export interface PushPreferences {
     call_level?: string;
     chat_level?: string;
     disabled_until?: Date;
+    feeds_level?: string;
+    feeds_events?: FeedsEventPreferences;
 }
 export interface Quality {
     bitdepth?: number;
@@ -2947,40 +2972,39 @@ export interface RingSettingsResponse {
     missed_call_timeout_ms: number;
 }
 export interface RuleBuilderAction {
-    type: string;
+    type?: string;
     ban_options?: BanOptions;
     flag_content_options?: FlagContentOptions;
     flag_user_options?: FlagUserOptions;
     remove_content_options?: BlockContentOptions;
 }
 export interface RuleBuilderCondition {
-    type: string;
     confidence?: number;
+    type?: string;
     content_count_rule_params?: ContentCountRuleParameters;
     image_content_params?: ImageContentParameters;
     image_rule_params?: ImageRuleParameters;
     text_content_params?: TextContentParameters;
     text_rule_params?: TextRuleParameters;
     user_created_within_params?: UserCreatedWithinParameters;
+    user_custom_property_params?: UserCustomPropertyParameters;
     user_rule_params?: UserRuleParameters;
     video_content_params?: VideoContentParameters;
     video_rule_params?: VideoRuleParameters;
 }
 export interface RuleBuilderConditionGroup {
-    logic: string;
-    conditions: RuleBuilderCondition[];
+    logic?: string;
+    conditions?: RuleBuilderCondition[];
 }
 export interface RuleBuilderConfig {
-    rules: RuleBuilderRule[];
     async?: boolean;
+    rules?: RuleBuilderRule[];
 }
 export interface RuleBuilderRule {
-    enabled: boolean;
-    id: string;
-    name: string;
     rule_type: string;
     action: RuleBuilderAction;
     cooldown_period?: string;
+    id?: string;
     logic?: string;
     conditions?: RuleBuilderCondition[];
     groups?: RuleBuilderConditionGroup[];
@@ -3104,14 +3128,16 @@ export interface TextContentParameters {
     severity?: string;
     blocklist_match?: string[];
     harm_labels?: string[];
+    llm_harm_labels?: Record<string, string>;
 }
 export interface TextRuleParameters {
-    threshold: number;
-    time_window: string;
     contains_url?: boolean;
     severity?: string;
+    threshold?: number;
+    time_window?: string;
     blocklist_match?: string[];
     harm_labels?: string[];
+    llm_harm_labels?: Record<string, string>;
 }
 export interface ThreadedCommentResponse {
     confidence_score: number;
@@ -3244,6 +3270,7 @@ export interface UpdateBookmarkResponse {
 }
 export interface UpdateCommentRequest {
     comment?: string;
+    skip_push?: boolean;
     custom?: Record<string, any>;
 }
 export interface UpdateCommentResponse {
@@ -3276,6 +3303,7 @@ export interface UpdateFollowRequest {
     create_notification_activity?: boolean;
     follower_role?: string;
     push_preference?: 'all' | 'none';
+    skip_push?: boolean;
     custom?: Record<string, any>;
 }
 export interface UpdateFollowResponse {
@@ -3393,6 +3421,10 @@ export interface UserBannedEvent {
 export interface UserCreatedWithinParameters {
     max_age?: string;
 }
+export interface UserCustomPropertyParameters {
+    operator?: string;
+    property_key?: string;
+}
 export interface UserDeactivatedEvent {
     created_at: Date;
     created_by: User;
@@ -3545,8 +3577,8 @@ export interface VideoOrientation {
     orientation?: number;
 }
 export interface VideoRuleParameters {
-    threshold: number;
-    time_window: string;
+    threshold?: number;
+    time_window?: string;
     harm_labels?: string[];
 }
 export interface VideoSettings {