@stream-io/feeds-client 0.1.8 → 0.1.10

package/dist/src/Feed.d.ts

@@ -1,4 +1,4 @@
-import { ActivityRequest, FeedResponse, GetOrCreateFeedRequest, GetOrCreateFeedResponse, QueryFollowsRequest, WSEvent, ActivityResponse, CommentResponse, SingleFollowRequest, QueryFeedMembersRequest, SortParamRequest } from './gen/models';
+import { ActivityRequest, FeedResponse, GetOrCreateFeedRequest, GetOrCreateFeedResponse, QueryFollowsRequest, WSEvent, ActivityResponse, CommentResponse, SingleFollowRequest, QueryFeedMembersRequest, SortParamRequest, FollowResponse } from './gen/models';
 import { StateStore } from './common/StateStore';
 import { EventDispatcher } from './common/EventDispatcher';
 import { FeedApi } from './gen/feeds/FeedApi';
@@ -41,17 +41,17 @@ export type FeedState = Omit<Partial<GetOrCreateFeedResponse & FeedResponse>, 'f
          *   comments_by_entity_id: {
          *     'activity-1': {
          *       comments: [comment1],
-         *       parent_id: undefined,
+         *       entity_parent_id: undefined,
          *     },
          *     'comment-1': {
          *       comments: [comment2],
-         *       parent_id: 'activity-1', // parent store where "comment-1" is located in "comments" array
+         *       entity_parent_id: 'activity-1', // parent store where "comment-1" is located in "comments" array
          *     }
          *   }
          * }
          * ```
          */
-        parent_id?: ActivityIdOrCommentId;
+        entity_parent_id?: ActivityIdOrCommentId;
         comments?: CommentResponse[];
     } | undefined>;
     followers_pagination?: LoadingStates & {
@@ -64,19 +64,47 @@ export type FeedState = Omit<Partial<GetOrCreateFeedResponse & FeedResponse>, 'f
         sort?: SortParamRequest[];
     };
     last_get_or_create_request_config?: GetOrCreateFeedRequest;
+    /**
+     * `true` if the feed is receiving real-time updates via WebSocket
+     */
+    watch: boolean;
 };
 export declare class Feed extends FeedApi {
     readonly state: StateStore<FeedState>;
     private static readonly noop;
+    private readonly stateUpdateQueue;
     private readonly eventHandlers;
     protected eventDispatcher: EventDispatcher<WSEvent['type'], WSEvent>;
-    constructor(client: FeedsClient, groupId: 'user' | 'timeline' | (string & {}), id: string, data?: FeedResponse);
+    constructor(client: FeedsClient, groupId: 'user' | 'timeline' | (string & {}), id: string, data?: FeedResponse, watch?: boolean);
     private readonly client;
     get fid(): string;
     get currentState(): FeedState;
     private handleCommentReactionEvent;
     synchronize(): Promise<void>;
     getOrCreate(request?: GetOrCreateFeedRequest): Promise<StreamResponse<GetOrCreateFeedResponse>>;
+    /**
+     * @internal
+     */
+    handleFollowCreated(follow: FollowResponse): void;
+    /**
+     * @internal
+     */
+    handleFollowDeleted(follow: FollowResponse | {
+        source_feed: {
+            fid: string;
+        };
+        target_feed: {
+            fid: string;
+        };
+    }): void;
+    /**
+     * @internal
+     */
+    handleWatchStopped(): void;
+    /**
+     * @internal
+     */
+    handleWatchStarted(): void;
     private handleBookmarkAdded;
     private handleBookmarkDeleted;
     private handleBookmarkUpdated;
@@ -84,14 +112,17 @@ export declare class Feed extends FeedApi {
      * Returns index of the provided comment object.
      */
     private getCommentIndex;
-    private getActivityIndex;
-    private updateActivityInState;
+    /**
+     * Load child comments of entity (activity or comment) into the state, if the target entity is comment,
+     * `entityParentId` should be provided (`CommentResponse.parent_id ?? CommentResponse.object_id`).
+     */
+    private loadCommentsIntoState;
     private loadNextPageComments;
     loadNextPageActivityComments(activity: ActivityResponse, request?: Partial<Omit<GetCommentsRequest, 'object_id' | 'object_type' | 'next'>>): Promise<void>;
     loadNextPageCommentReplies(comment: CommentResponse, request?: Partial<Omit<GetCommentsRepliesRequest, 'comment_id' | 'next'>>): Promise<void>;
     private loadNextPageFollows;
-    loadNextPageFollowers(request: Pick<QueryFollowsRequest, 'limit'>): Promise<void>;
-    loadNextPageFollowing(request: Pick<QueryFollowsRequest, 'limit'>): Promise<void>;
+    loadNextPageFollowers(request: Pick<QueryFollowsRequest, 'limit' | 'sort'>): Promise<void>;
+    loadNextPageFollowing(request: Pick<QueryFollowsRequest, 'limit' | 'sort'>): Promise<void>;
     loadNextPageMembers(request: Omit<QueryFeedMembersRequest, 'next' | 'prev'>): Promise<void>;
     /**
      * Method which queries followers of this feed (feeds which target this feed).

package/dist/src/FeedsClient.d.ts

@@ -1,5 +1,5 @@
 import { FeedsApi } from './gen/feeds/FeedsApi';
-import { ActivityResponse, FileUploadRequest, ImageUploadRequest, OwnUser, PollResponse, PollVotesResponse, QueryFeedsRequest, QueryPollVotesRequest, UserRequest } from './gen/models';
+import { ActivityResponse, FileUploadRequest, FollowBatchRequest, ImageUploadRequest, OwnUser, PollResponse, PollVotesResponse, QueryFeedsRequest, QueryPollVotesRequest, SingleFollowRequest, UserRequest } from './gen/models';
 import { FeedsEvent, StreamFile, TokenOrProvider } from './types';
 import { StateStore } from './common/StateStore';
 import { Feed } from './Feed';
@@ -63,6 +63,13 @@ export declare class FeedsClient extends FeedsApi {
     updateNetworkConnectionStatus: (event: {
         type: "online" | "offline";
     } | Event) => void;
+    follow(request: SingleFollowRequest): Promise<StreamResponse<import("./gen/models").SingleFollowResponse>>;
+    followBatch(request: FollowBatchRequest): Promise<StreamResponse<import("./gen/models").FollowBatchResponse>>;
+    unfollow(request: SingleFollowRequest): Promise<StreamResponse<import("./gen/models").UnfollowResponse>>;
+    stopWatchingFeed(request: {
+        feed_group_id: string;
+        feed_id: string;
+    }): Promise<StreamResponse<import("./gen/models").Response>>;
     private readonly getOrCreateActiveFeed;
     private findActiveFeedByActivityId;
 }

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

@@ -1,6 +1,6 @@
 import { StateStore } from './StateStore';
 import { type DebouncedFunc } from './utils';
-export type SearchSourceType = 'channels' | 'users' | 'messages' | (string & {});
+export type SearchSourceType = 'activity' | 'user' | 'feed' | (string & {});
 export type QueryReturnValue<T> = {
     items: T[];
     next?: string | null;
@@ -44,10 +44,12 @@ 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> {
     state: StateStore<SearchSourceState<T>>;
     protected pageSize: number;
+    protected allowEmptySearchString: boolean;
     abstract readonly type: SearchSourceType;
     protected searchDebounced: DebouncedExecQueryFunction;
     protected constructor(options?: SearchSourceOptions);

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

@@ -2,10 +2,14 @@ import { BaseSearchSource } from './BaseSearchSource';
 import type { SearchSourceOptions } from './BaseSearchSource';
 import { FeedsClient } from '../FeedsClient';
 import { Feed } from '../Feed';
+export type FeedSearchSourceOptions = SearchSourceOptions & {
+    groupId?: string;
+};
 export declare class FeedSearchSource extends BaseSearchSource<Feed> {
     readonly type: "feed";
     private readonly client;
-    constructor(client: FeedsClient, options?: SearchSourceOptions);
+    private readonly feedGroupId?;
+    constructor(client: FeedsClient, options?: FeedSearchSourceOptions);
     protected query(searchQuery: string): Promise<{
         items: never[];
         next?: undefined;

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

@@ -17,6 +17,8 @@ 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/gen-imports.d.ts

@@ -1,3 +1,3 @@
 export type { ApiClient } from './common/ApiClient';
 export type { StreamResponse } from './common/types';
-export { FeedsApi } from './gen/feeds/FeedsApi';
+export { FeedsClient as FeedsApi } from './FeedsClient';

package/dist/src/state-updates/follow-utils.d.ts

@@ -0,0 +1,19 @@
+import { FeedState } from '../Feed';
+import { FollowResponse } from '../gen/models';
+import { UpdateStateResult } from '../types-internal';
+export declare const handleFollowCreated: (follow: FollowResponse, currentState: FeedState, currentFeedId: string, connectedUserId?: string) => UpdateStateResult<{
+    data: FeedState;
+}>;
+export declare const handleFollowDeleted: (follow: FollowResponse | {
+    source_feed: {
+        fid: string;
+    };
+    target_feed: {
+        fid: string;
+    };
+}, currentState: FeedState, currentFeedId: string, connectedUserId?: string) => UpdateStateResult<{
+    data: FeedState;
+}>;
+export declare const handleFollowUpdated: (currentState: FeedState) => UpdateStateResult<{
+    data: FeedState;
+}>;

package/dist/src/state-updates/state-update-queue.d.ts

@@ -0,0 +1,15 @@
+import { FollowResponse } from '../gen/models';
+export declare const shouldUpdateState: ({ stateUpdateId, stateUpdateQueue, watch, }: {
+    stateUpdateId: string;
+    stateUpdateQueue: Set<string>;
+    watch: boolean;
+}) => boolean;
+export declare const getStateUpdateQueueIdForFollow: (follow: FollowResponse) => string;
+export declare const getStateUpdateQueueIdForUnfollow: (follow: FollowResponse | {
+    source_feed: {
+        fid: string;
+    };
+    target_feed: {
+        fid: string;
+    };
+}) => string;

package/dist/src/utils.d.ts

@@ -7,3 +7,4 @@ export declare const isCommentResponse: (entity: CommentParent) => entity is Com
 export declare const Constants: {
     readonly DEFAULT_COMMENT_PAGINATION: "first";
 };
+export declare const uniqueArrayMerge: <T>(existingArray: T[], arrayToMerge: T[], getKey: (v: T) => string) => T[];