@stream-io/feeds-client 0.1.7 → 0.1.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/@react-bindings/hooks/util/index.ts +1 -0
- package/CHANGELOG.md +20 -0
- package/dist/@react-bindings/hooks/util/index.d.ts +1 -0
- package/dist/@react-bindings/hooks/util/useBookmarkActions.d.ts +13 -0
- package/dist/@react-bindings/hooks/util/useReactionActions.d.ts +1 -1
- package/dist/index-react-bindings.browser.cjs +363 -141
- package/dist/index-react-bindings.browser.cjs.map +1 -1
- package/dist/index-react-bindings.browser.js +363 -142
- package/dist/index-react-bindings.browser.js.map +1 -1
- package/dist/index-react-bindings.node.cjs +363 -141
- package/dist/index-react-bindings.node.cjs.map +1 -1
- package/dist/index-react-bindings.node.js +363 -142
- package/dist/index-react-bindings.node.js.map +1 -1
- package/dist/index.browser.cjs +337 -140
- package/dist/index.browser.cjs.map +1 -1
- package/dist/index.browser.js +337 -141
- package/dist/index.browser.js.map +1 -1
- package/dist/index.node.cjs +337 -140
- package/dist/index.node.cjs.map +1 -1
- package/dist/index.node.js +337 -141
- package/dist/index.node.js.map +1 -1
- package/dist/src/Feed.d.ts +42 -11
- package/dist/src/FeedsClient.d.ts +10 -3
- package/dist/src/common/real-time/StableWSConnection.d.ts +3 -3
- package/dist/src/gen/models/index.d.ts +25 -2
- package/dist/src/gen-imports.d.ts +1 -1
- package/dist/src/state-updates/follow-utils.d.ts +19 -0
- package/dist/src/state-updates/state-update-queue.d.ts +15 -0
- package/dist/src/utils.d.ts +1 -0
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/Feed.ts +230 -192
- package/src/FeedsClient.ts +75 -3
- package/src/gen/feeds/FeedsApi.ts +0 -1
- package/src/gen/model-decoders/decoders.ts +16 -0
- package/src/gen/model-decoders/event-decoder-mapping.ts +3 -0
- package/src/gen/models/index.ts +42 -4
- package/src/gen-imports.ts +1 -1
- package/src/state-updates/activity-reaction-utils.test.ts +1 -0
- package/src/state-updates/activity-utils.test.ts +1 -0
- package/src/state-updates/follow-utils.test.ts +552 -0
- package/src/state-updates/follow-utils.ts +126 -0
- package/src/state-updates/state-update-queue.test.ts +53 -0
- package/src/state-updates/state-update-queue.ts +35 -0
- package/src/utils.test.ts +175 -0
- package/src/utils.ts +20 -0
package/dist/src/Feed.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ActivityRequest, FeedResponse, GetOrCreateFeedRequest, GetOrCreateFeedResponse, QueryFollowsRequest, WSEvent, ActivityResponse, CommentResponse, SingleFollowRequest, QueryFeedMembersRequest, SortParamRequest } from './gen/models';
|
|
1
|
+
import { ActivityRequest, FeedResponse, GetOrCreateFeedRequest, GetOrCreateFeedResponse, QueryFollowsRequest, WSEvent, ActivityResponse, CommentResponse, SingleFollowRequest, QueryFeedMembersRequest, SortParamRequest, FollowResponse } from './gen/models';
|
|
2
2
|
import { StateStore } from './common/StateStore';
|
|
3
3
|
import { EventDispatcher } from './common/EventDispatcher';
|
|
4
4
|
import { FeedApi } from './gen/feeds/FeedApi';
|
|
@@ -41,17 +41,17 @@ export type FeedState = Omit<Partial<GetOrCreateFeedResponse & FeedResponse>, 'f
|
|
|
41
41
|
* comments_by_entity_id: {
|
|
42
42
|
* 'activity-1': {
|
|
43
43
|
* comments: [comment1],
|
|
44
|
-
*
|
|
44
|
+
* entity_parent_id: undefined,
|
|
45
45
|
* },
|
|
46
46
|
* 'comment-1': {
|
|
47
47
|
* comments: [comment2],
|
|
48
|
-
*
|
|
48
|
+
* entity_parent_id: 'activity-1', // parent store where "comment-1" is located in "comments" array
|
|
49
49
|
* }
|
|
50
50
|
* }
|
|
51
51
|
* }
|
|
52
52
|
* ```
|
|
53
53
|
*/
|
|
54
|
-
|
|
54
|
+
entity_parent_id?: ActivityIdOrCommentId;
|
|
55
55
|
comments?: CommentResponse[];
|
|
56
56
|
} | undefined>;
|
|
57
57
|
followers_pagination?: LoadingStates & {
|
|
@@ -64,19 +64,47 @@ export type FeedState = Omit<Partial<GetOrCreateFeedResponse & FeedResponse>, 'f
|
|
|
64
64
|
sort?: SortParamRequest[];
|
|
65
65
|
};
|
|
66
66
|
last_get_or_create_request_config?: GetOrCreateFeedRequest;
|
|
67
|
+
/**
|
|
68
|
+
* `true` if the feed is receiving real-time updates via WebSocket
|
|
69
|
+
*/
|
|
70
|
+
watch: boolean;
|
|
67
71
|
};
|
|
68
72
|
export declare class Feed extends FeedApi {
|
|
69
73
|
readonly state: StateStore<FeedState>;
|
|
70
74
|
private static readonly noop;
|
|
75
|
+
private readonly stateUpdateQueue;
|
|
71
76
|
private readonly eventHandlers;
|
|
72
77
|
protected eventDispatcher: EventDispatcher<WSEvent['type'], WSEvent>;
|
|
73
|
-
constructor(client: FeedsClient, groupId: 'user' | 'timeline' | (string & {}), id: string, data?: FeedResponse);
|
|
78
|
+
constructor(client: FeedsClient, groupId: 'user' | 'timeline' | (string & {}), id: string, data?: FeedResponse, watch?: boolean);
|
|
74
79
|
private readonly client;
|
|
75
80
|
get fid(): string;
|
|
76
81
|
get currentState(): FeedState;
|
|
77
82
|
private handleCommentReactionEvent;
|
|
78
83
|
synchronize(): Promise<void>;
|
|
79
84
|
getOrCreate(request?: GetOrCreateFeedRequest): Promise<StreamResponse<GetOrCreateFeedResponse>>;
|
|
85
|
+
/**
|
|
86
|
+
* @internal
|
|
87
|
+
*/
|
|
88
|
+
handleFollowCreated(follow: FollowResponse): void;
|
|
89
|
+
/**
|
|
90
|
+
* @internal
|
|
91
|
+
*/
|
|
92
|
+
handleFollowDeleted(follow: FollowResponse | {
|
|
93
|
+
source_feed: {
|
|
94
|
+
fid: string;
|
|
95
|
+
};
|
|
96
|
+
target_feed: {
|
|
97
|
+
fid: string;
|
|
98
|
+
};
|
|
99
|
+
}): void;
|
|
100
|
+
/**
|
|
101
|
+
* @internal
|
|
102
|
+
*/
|
|
103
|
+
handleWatchStopped(): void;
|
|
104
|
+
/**
|
|
105
|
+
* @internal
|
|
106
|
+
*/
|
|
107
|
+
handleWatchStarted(): void;
|
|
80
108
|
private handleBookmarkAdded;
|
|
81
109
|
private handleBookmarkDeleted;
|
|
82
110
|
private handleBookmarkUpdated;
|
|
@@ -84,14 +112,17 @@ export declare class Feed extends FeedApi {
|
|
|
84
112
|
* Returns index of the provided comment object.
|
|
85
113
|
*/
|
|
86
114
|
private getCommentIndex;
|
|
87
|
-
|
|
88
|
-
|
|
115
|
+
/**
|
|
116
|
+
* Load child comments of entity (activity or comment) into the state, if the target entity is comment,
|
|
117
|
+
* `entityParentId` should be provided (`CommentResponse.parent_id ?? CommentResponse.object_id`).
|
|
118
|
+
*/
|
|
119
|
+
private loadCommentsIntoState;
|
|
89
120
|
private loadNextPageComments;
|
|
90
121
|
loadNextPageActivityComments(activity: ActivityResponse, request?: Partial<Omit<GetCommentsRequest, 'object_id' | 'object_type' | 'next'>>): Promise<void>;
|
|
91
122
|
loadNextPageCommentReplies(comment: CommentResponse, request?: Partial<Omit<GetCommentsRepliesRequest, 'comment_id' | 'next'>>): Promise<void>;
|
|
92
123
|
private loadNextPageFollows;
|
|
93
|
-
loadNextPageFollowers(request: Pick<QueryFollowsRequest, 'limit'>): Promise<void>;
|
|
94
|
-
loadNextPageFollowing(request: Pick<QueryFollowsRequest, 'limit'>): Promise<void>;
|
|
124
|
+
loadNextPageFollowers(request: Pick<QueryFollowsRequest, 'limit' | 'sort'>): Promise<void>;
|
|
125
|
+
loadNextPageFollowing(request: Pick<QueryFollowsRequest, 'limit' | 'sort'>): Promise<void>;
|
|
95
126
|
loadNextPageMembers(request: Omit<QueryFeedMembersRequest, 'next' | 'prev'>): Promise<void>;
|
|
96
127
|
/**
|
|
97
128
|
* Method which queries followers of this feed (feeds which target this feed).
|
|
@@ -109,7 +140,7 @@ export declare class Feed extends FeedApi {
|
|
|
109
140
|
unfollow(feedOrFid: Feed | string): Promise<StreamResponse<import("./gen/models").UnfollowResponse>>;
|
|
110
141
|
getNextPage(): Promise<StreamResponse<GetOrCreateFeedResponse>>;
|
|
111
142
|
addActivity(request: Omit<ActivityRequest, 'fids'>): Promise<StreamResponse<import("./gen/models").AddActivityResponse>>;
|
|
112
|
-
on: (eventName: "all" | "app.updated" | "feeds.activity.added" | "feeds.activity.deleted" | "feeds.activity.marked" | "feeds.activity.pinned" | "feeds.activity.reaction.added" | "feeds.activity.reaction.deleted" | "feeds.activity.reaction.updated" | "feeds.activity.removed_from_feed" | "feeds.activity.unpinned" | "feeds.activity.updated" | "feeds.bookmark.added" | "feeds.bookmark.deleted" | "feeds.bookmark.updated" | "feeds.bookmark_folder.deleted" | "feeds.bookmark_folder.updated" | "feeds.comment.added" | "feeds.comment.deleted" | "feeds.comment.reaction.added" | "feeds.comment.reaction.deleted" | "feeds.comment.reaction.updated" | "feeds.comment.updated" | "feeds.feed.created" | "feeds.feed.deleted" | "feeds.feed.updated" | "feeds.feed_group.changed" | "feeds.feed_group.deleted" | "feeds.feed_member.added" | "feeds.feed_member.removed" | "feeds.feed_member.updated" | "feeds.follow.created" | "feeds.follow.deleted" | "feeds.follow.updated" | "feeds.poll.closed" | "feeds.poll.deleted" | "feeds.poll.updated" | "feeds.poll.vote_casted" | "feeds.poll.vote_changed" | "feeds.poll.vote_removed" | "health.check" | "user.updated" | "moderation.custom_action" | "moderation.flagged" | "moderation.mark_reviewed" | "user.banned" | "user.deactivated" | "user.muted" | "user.reactivated", handler: (event: WSEvent) => void) => () => void;
|
|
113
|
-
off: (eventName: "all" | "app.updated" | "feeds.activity.added" | "feeds.activity.deleted" | "feeds.activity.marked" | "feeds.activity.pinned" | "feeds.activity.reaction.added" | "feeds.activity.reaction.deleted" | "feeds.activity.reaction.updated" | "feeds.activity.removed_from_feed" | "feeds.activity.unpinned" | "feeds.activity.updated" | "feeds.bookmark.added" | "feeds.bookmark.deleted" | "feeds.bookmark.updated" | "feeds.bookmark_folder.deleted" | "feeds.bookmark_folder.updated" | "feeds.comment.added" | "feeds.comment.deleted" | "feeds.comment.reaction.added" | "feeds.comment.reaction.deleted" | "feeds.comment.reaction.updated" | "feeds.comment.updated" | "feeds.feed.created" | "feeds.feed.deleted" | "feeds.feed.updated" | "feeds.feed_group.changed" | "feeds.feed_group.deleted" | "feeds.feed_member.added" | "feeds.feed_member.removed" | "feeds.feed_member.updated" | "feeds.follow.created" | "feeds.follow.deleted" | "feeds.follow.updated" | "feeds.poll.closed" | "feeds.poll.deleted" | "feeds.poll.updated" | "feeds.poll.vote_casted" | "feeds.poll.vote_changed" | "feeds.poll.vote_removed" | "health.check" | "user.updated" | "moderation.custom_action" | "moderation.flagged" | "moderation.mark_reviewed" | "user.banned" | "user.deactivated" | "user.muted" | "user.reactivated", handler: (event: WSEvent) => void) => void;
|
|
143
|
+
on: (eventName: "all" | "app.updated" | "feeds.activity.added" | "feeds.activity.deleted" | "feeds.activity.marked" | "feeds.activity.pinned" | "feeds.activity.reaction.added" | "feeds.activity.reaction.deleted" | "feeds.activity.reaction.updated" | "feeds.activity.removed_from_feed" | "feeds.activity.unpinned" | "feeds.activity.updated" | "feeds.bookmark.added" | "feeds.bookmark.deleted" | "feeds.bookmark.updated" | "feeds.bookmark_folder.deleted" | "feeds.bookmark_folder.updated" | "feeds.comment.added" | "feeds.comment.deleted" | "feeds.comment.reaction.added" | "feeds.comment.reaction.deleted" | "feeds.comment.reaction.updated" | "feeds.comment.updated" | "feeds.feed.created" | "feeds.feed.deleted" | "feeds.feed.updated" | "feeds.feed_group.changed" | "feeds.feed_group.deleted" | "feeds.feed_member.added" | "feeds.feed_member.removed" | "feeds.feed_member.updated" | "feeds.follow.created" | "feeds.follow.deleted" | "feeds.follow.updated" | "feeds.notification_feed.updated" | "feeds.poll.closed" | "feeds.poll.deleted" | "feeds.poll.updated" | "feeds.poll.vote_casted" | "feeds.poll.vote_changed" | "feeds.poll.vote_removed" | "health.check" | "user.updated" | "moderation.custom_action" | "moderation.flagged" | "moderation.mark_reviewed" | "user.banned" | "user.deactivated" | "user.muted" | "user.reactivated", handler: (event: WSEvent) => void) => () => void;
|
|
144
|
+
off: (eventName: "all" | "app.updated" | "feeds.activity.added" | "feeds.activity.deleted" | "feeds.activity.marked" | "feeds.activity.pinned" | "feeds.activity.reaction.added" | "feeds.activity.reaction.deleted" | "feeds.activity.reaction.updated" | "feeds.activity.removed_from_feed" | "feeds.activity.unpinned" | "feeds.activity.updated" | "feeds.bookmark.added" | "feeds.bookmark.deleted" | "feeds.bookmark.updated" | "feeds.bookmark_folder.deleted" | "feeds.bookmark_folder.updated" | "feeds.comment.added" | "feeds.comment.deleted" | "feeds.comment.reaction.added" | "feeds.comment.reaction.deleted" | "feeds.comment.reaction.updated" | "feeds.comment.updated" | "feeds.feed.created" | "feeds.feed.deleted" | "feeds.feed.updated" | "feeds.feed_group.changed" | "feeds.feed_group.deleted" | "feeds.feed_member.added" | "feeds.feed_member.removed" | "feeds.feed_member.updated" | "feeds.follow.created" | "feeds.follow.deleted" | "feeds.follow.updated" | "feeds.notification_feed.updated" | "feeds.poll.closed" | "feeds.poll.deleted" | "feeds.poll.updated" | "feeds.poll.vote_casted" | "feeds.poll.vote_changed" | "feeds.poll.vote_removed" | "health.check" | "user.updated" | "moderation.custom_action" | "moderation.flagged" | "moderation.mark_reviewed" | "user.banned" | "user.deactivated" | "user.muted" | "user.reactivated", handler: (event: WSEvent) => void) => void;
|
|
114
145
|
handleWSEvent(event: WSEvent): void;
|
|
115
146
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { FeedsApi } from './gen/feeds/FeedsApi';
|
|
2
|
-
import { ActivityResponse, FileUploadRequest, ImageUploadRequest, OwnUser, PollResponse, PollVotesResponse, QueryFeedsRequest, QueryPollVotesRequest, UserRequest } from './gen/models';
|
|
2
|
+
import { ActivityResponse, FileUploadRequest, FollowBatchRequest, ImageUploadRequest, OwnUser, PollResponse, PollVotesResponse, QueryFeedsRequest, QueryPollVotesRequest, SingleFollowRequest, UserRequest } from './gen/models';
|
|
3
3
|
import { FeedsEvent, StreamFile, TokenOrProvider } from './types';
|
|
4
4
|
import { StateStore } from './common/StateStore';
|
|
5
5
|
import { Feed } from './Feed';
|
|
@@ -46,10 +46,10 @@ export declare class FeedsClient extends FeedsApi {
|
|
|
46
46
|
user_id?: string;
|
|
47
47
|
}) => Promise<StreamResponse<PollVotesResponse>>;
|
|
48
48
|
disconnectUser: () => Promise<void>;
|
|
49
|
-
on: (eventName: "all" | "app.updated" | "feeds.activity.added" | "feeds.activity.deleted" | "feeds.activity.marked" | "feeds.activity.pinned" | "feeds.activity.reaction.added" | "feeds.activity.reaction.deleted" | "feeds.activity.reaction.updated" | "feeds.activity.removed_from_feed" | "feeds.activity.unpinned" | "feeds.activity.updated" | "feeds.bookmark.added" | "feeds.bookmark.deleted" | "feeds.bookmark.updated" | "feeds.bookmark_folder.deleted" | "feeds.bookmark_folder.updated" | "feeds.comment.added" | "feeds.comment.deleted" | "feeds.comment.reaction.added" | "feeds.comment.reaction.deleted" | "feeds.comment.reaction.updated" | "feeds.comment.updated" | "feeds.feed.created" | "feeds.feed.deleted" | "feeds.feed.updated" | "feeds.feed_group.changed" | "feeds.feed_group.deleted" | "feeds.feed_member.added" | "feeds.feed_member.removed" | "feeds.feed_member.updated" | "feeds.follow.created" | "feeds.follow.deleted" | "feeds.follow.updated" | "feeds.poll.closed" | "feeds.poll.deleted" | "feeds.poll.updated" | "feeds.poll.vote_casted" | "feeds.poll.vote_changed" | "feeds.poll.vote_removed" | "health.check" | "user.updated" | "moderation.custom_action" | "moderation.flagged" | "moderation.mark_reviewed" | "user.banned" | "user.deactivated" | "user.muted" | "user.reactivated" | "connection.changed" | "network.changed", handler: (event: FeedsEvent & {
|
|
49
|
+
on: (eventName: "all" | "app.updated" | "feeds.activity.added" | "feeds.activity.deleted" | "feeds.activity.marked" | "feeds.activity.pinned" | "feeds.activity.reaction.added" | "feeds.activity.reaction.deleted" | "feeds.activity.reaction.updated" | "feeds.activity.removed_from_feed" | "feeds.activity.unpinned" | "feeds.activity.updated" | "feeds.bookmark.added" | "feeds.bookmark.deleted" | "feeds.bookmark.updated" | "feeds.bookmark_folder.deleted" | "feeds.bookmark_folder.updated" | "feeds.comment.added" | "feeds.comment.deleted" | "feeds.comment.reaction.added" | "feeds.comment.reaction.deleted" | "feeds.comment.reaction.updated" | "feeds.comment.updated" | "feeds.feed.created" | "feeds.feed.deleted" | "feeds.feed.updated" | "feeds.feed_group.changed" | "feeds.feed_group.deleted" | "feeds.feed_member.added" | "feeds.feed_member.removed" | "feeds.feed_member.updated" | "feeds.follow.created" | "feeds.follow.deleted" | "feeds.follow.updated" | "feeds.notification_feed.updated" | "feeds.poll.closed" | "feeds.poll.deleted" | "feeds.poll.updated" | "feeds.poll.vote_casted" | "feeds.poll.vote_changed" | "feeds.poll.vote_removed" | "health.check" | "user.updated" | "moderation.custom_action" | "moderation.flagged" | "moderation.mark_reviewed" | "user.banned" | "user.deactivated" | "user.muted" | "user.reactivated" | "connection.changed" | "network.changed", handler: (event: FeedsEvent & {
|
|
50
50
|
fid?: string;
|
|
51
51
|
}) => void) => () => void;
|
|
52
|
-
off: (eventName: "all" | "app.updated" | "feeds.activity.added" | "feeds.activity.deleted" | "feeds.activity.marked" | "feeds.activity.pinned" | "feeds.activity.reaction.added" | "feeds.activity.reaction.deleted" | "feeds.activity.reaction.updated" | "feeds.activity.removed_from_feed" | "feeds.activity.unpinned" | "feeds.activity.updated" | "feeds.bookmark.added" | "feeds.bookmark.deleted" | "feeds.bookmark.updated" | "feeds.bookmark_folder.deleted" | "feeds.bookmark_folder.updated" | "feeds.comment.added" | "feeds.comment.deleted" | "feeds.comment.reaction.added" | "feeds.comment.reaction.deleted" | "feeds.comment.reaction.updated" | "feeds.comment.updated" | "feeds.feed.created" | "feeds.feed.deleted" | "feeds.feed.updated" | "feeds.feed_group.changed" | "feeds.feed_group.deleted" | "feeds.feed_member.added" | "feeds.feed_member.removed" | "feeds.feed_member.updated" | "feeds.follow.created" | "feeds.follow.deleted" | "feeds.follow.updated" | "feeds.poll.closed" | "feeds.poll.deleted" | "feeds.poll.updated" | "feeds.poll.vote_casted" | "feeds.poll.vote_changed" | "feeds.poll.vote_removed" | "health.check" | "user.updated" | "moderation.custom_action" | "moderation.flagged" | "moderation.mark_reviewed" | "user.banned" | "user.deactivated" | "user.muted" | "user.reactivated" | "connection.changed" | "network.changed", handler: (event: FeedsEvent & {
|
|
52
|
+
off: (eventName: "all" | "app.updated" | "feeds.activity.added" | "feeds.activity.deleted" | "feeds.activity.marked" | "feeds.activity.pinned" | "feeds.activity.reaction.added" | "feeds.activity.reaction.deleted" | "feeds.activity.reaction.updated" | "feeds.activity.removed_from_feed" | "feeds.activity.unpinned" | "feeds.activity.updated" | "feeds.bookmark.added" | "feeds.bookmark.deleted" | "feeds.bookmark.updated" | "feeds.bookmark_folder.deleted" | "feeds.bookmark_folder.updated" | "feeds.comment.added" | "feeds.comment.deleted" | "feeds.comment.reaction.added" | "feeds.comment.reaction.deleted" | "feeds.comment.reaction.updated" | "feeds.comment.updated" | "feeds.feed.created" | "feeds.feed.deleted" | "feeds.feed.updated" | "feeds.feed_group.changed" | "feeds.feed_group.deleted" | "feeds.feed_member.added" | "feeds.feed_member.removed" | "feeds.feed_member.updated" | "feeds.follow.created" | "feeds.follow.deleted" | "feeds.follow.updated" | "feeds.notification_feed.updated" | "feeds.poll.closed" | "feeds.poll.deleted" | "feeds.poll.updated" | "feeds.poll.vote_casted" | "feeds.poll.vote_changed" | "feeds.poll.vote_removed" | "health.check" | "user.updated" | "moderation.custom_action" | "moderation.flagged" | "moderation.mark_reviewed" | "user.banned" | "user.deactivated" | "user.muted" | "user.reactivated" | "connection.changed" | "network.changed", handler: (event: FeedsEvent & {
|
|
53
53
|
fid?: string;
|
|
54
54
|
}) => void) => void;
|
|
55
55
|
feed: (groupId: string, id: string) => Feed;
|
|
@@ -63,6 +63,13 @@ export declare class FeedsClient extends FeedsApi {
|
|
|
63
63
|
updateNetworkConnectionStatus: (event: {
|
|
64
64
|
type: "online" | "offline";
|
|
65
65
|
} | Event) => void;
|
|
66
|
+
follow(request: SingleFollowRequest): Promise<StreamResponse<import("./gen/models").SingleFollowResponse>>;
|
|
67
|
+
followBatch(request: FollowBatchRequest): Promise<StreamResponse<import("./gen/models").FollowBatchResponse>>;
|
|
68
|
+
unfollow(request: SingleFollowRequest): Promise<StreamResponse<import("./gen/models").UnfollowResponse>>;
|
|
69
|
+
stopWatchingFeed(request: {
|
|
70
|
+
feed_group_id: string;
|
|
71
|
+
feed_id: string;
|
|
72
|
+
}): Promise<StreamResponse<import("./gen/models").Response>>;
|
|
66
73
|
private readonly getOrCreateActiveFeed;
|
|
67
74
|
private findActiveFeedByActivityId;
|
|
68
75
|
}
|
|
@@ -57,9 +57,9 @@ export declare class StableWSConnection {
|
|
|
57
57
|
private readonly clientId;
|
|
58
58
|
constructor(config: WSConfig, tokenManager: TokenManager, connectionIdManager: ConnectionIdManager, decoders?: Array<(event: any) => any>);
|
|
59
59
|
_log: (msg: string, extra?: any, level?: LogLevel) => void;
|
|
60
|
-
on: (eventName: "all" | "app.updated" | "feeds.activity.added" | "feeds.activity.deleted" | "feeds.activity.marked" | "feeds.activity.pinned" | "feeds.activity.reaction.added" | "feeds.activity.reaction.deleted" | "feeds.activity.reaction.updated" | "feeds.activity.removed_from_feed" | "feeds.activity.unpinned" | "feeds.activity.updated" | "feeds.bookmark.added" | "feeds.bookmark.deleted" | "feeds.bookmark.updated" | "feeds.bookmark_folder.deleted" | "feeds.bookmark_folder.updated" | "feeds.comment.added" | "feeds.comment.deleted" | "feeds.comment.reaction.added" | "feeds.comment.reaction.deleted" | "feeds.comment.reaction.updated" | "feeds.comment.updated" | "feeds.feed.created" | "feeds.feed.deleted" | "feeds.feed.updated" | "feeds.feed_group.changed" | "feeds.feed_group.deleted" | "feeds.feed_member.added" | "feeds.feed_member.removed" | "feeds.feed_member.updated" | "feeds.follow.created" | "feeds.follow.deleted" | "feeds.follow.updated" | "feeds.poll.closed" | "feeds.poll.deleted" | "feeds.poll.updated" | "feeds.poll.vote_casted" | "feeds.poll.vote_changed" | "feeds.poll.vote_removed" | "health.check" | "user.updated" | "moderation.custom_action" | "moderation.flagged" | "moderation.mark_reviewed" | "user.banned" | "user.deactivated" | "user.muted" | "user.reactivated" | "connection.changed" | "network.changed", handler: (event: import("../../types").FeedsEvent) => void) => () => void;
|
|
61
|
-
off: (eventName: "all" | "app.updated" | "feeds.activity.added" | "feeds.activity.deleted" | "feeds.activity.marked" | "feeds.activity.pinned" | "feeds.activity.reaction.added" | "feeds.activity.reaction.deleted" | "feeds.activity.reaction.updated" | "feeds.activity.removed_from_feed" | "feeds.activity.unpinned" | "feeds.activity.updated" | "feeds.bookmark.added" | "feeds.bookmark.deleted" | "feeds.bookmark.updated" | "feeds.bookmark_folder.deleted" | "feeds.bookmark_folder.updated" | "feeds.comment.added" | "feeds.comment.deleted" | "feeds.comment.reaction.added" | "feeds.comment.reaction.deleted" | "feeds.comment.reaction.updated" | "feeds.comment.updated" | "feeds.feed.created" | "feeds.feed.deleted" | "feeds.feed.updated" | "feeds.feed_group.changed" | "feeds.feed_group.deleted" | "feeds.feed_member.added" | "feeds.feed_member.removed" | "feeds.feed_member.updated" | "feeds.follow.created" | "feeds.follow.deleted" | "feeds.follow.updated" | "feeds.poll.closed" | "feeds.poll.deleted" | "feeds.poll.updated" | "feeds.poll.vote_casted" | "feeds.poll.vote_changed" | "feeds.poll.vote_removed" | "health.check" | "user.updated" | "moderation.custom_action" | "moderation.flagged" | "moderation.mark_reviewed" | "user.banned" | "user.deactivated" | "user.muted" | "user.reactivated" | "connection.changed" | "network.changed", handler: (event: import("../../types").FeedsEvent) => void) => void;
|
|
62
|
-
offAll: (eventName?: "all" | "app.updated" | "feeds.activity.added" | "feeds.activity.deleted" | "feeds.activity.marked" | "feeds.activity.pinned" | "feeds.activity.reaction.added" | "feeds.activity.reaction.deleted" | "feeds.activity.reaction.updated" | "feeds.activity.removed_from_feed" | "feeds.activity.unpinned" | "feeds.activity.updated" | "feeds.bookmark.added" | "feeds.bookmark.deleted" | "feeds.bookmark.updated" | "feeds.bookmark_folder.deleted" | "feeds.bookmark_folder.updated" | "feeds.comment.added" | "feeds.comment.deleted" | "feeds.comment.reaction.added" | "feeds.comment.reaction.deleted" | "feeds.comment.reaction.updated" | "feeds.comment.updated" | "feeds.feed.created" | "feeds.feed.deleted" | "feeds.feed.updated" | "feeds.feed_group.changed" | "feeds.feed_group.deleted" | "feeds.feed_member.added" | "feeds.feed_member.removed" | "feeds.feed_member.updated" | "feeds.follow.created" | "feeds.follow.deleted" | "feeds.follow.updated" | "feeds.poll.closed" | "feeds.poll.deleted" | "feeds.poll.updated" | "feeds.poll.vote_casted" | "feeds.poll.vote_changed" | "feeds.poll.vote_removed" | "health.check" | "user.updated" | "moderation.custom_action" | "moderation.flagged" | "moderation.mark_reviewed" | "user.banned" | "user.deactivated" | "user.muted" | "user.reactivated" | "connection.changed" | "network.changed" | undefined) => void;
|
|
60
|
+
on: (eventName: "all" | "app.updated" | "feeds.activity.added" | "feeds.activity.deleted" | "feeds.activity.marked" | "feeds.activity.pinned" | "feeds.activity.reaction.added" | "feeds.activity.reaction.deleted" | "feeds.activity.reaction.updated" | "feeds.activity.removed_from_feed" | "feeds.activity.unpinned" | "feeds.activity.updated" | "feeds.bookmark.added" | "feeds.bookmark.deleted" | "feeds.bookmark.updated" | "feeds.bookmark_folder.deleted" | "feeds.bookmark_folder.updated" | "feeds.comment.added" | "feeds.comment.deleted" | "feeds.comment.reaction.added" | "feeds.comment.reaction.deleted" | "feeds.comment.reaction.updated" | "feeds.comment.updated" | "feeds.feed.created" | "feeds.feed.deleted" | "feeds.feed.updated" | "feeds.feed_group.changed" | "feeds.feed_group.deleted" | "feeds.feed_member.added" | "feeds.feed_member.removed" | "feeds.feed_member.updated" | "feeds.follow.created" | "feeds.follow.deleted" | "feeds.follow.updated" | "feeds.notification_feed.updated" | "feeds.poll.closed" | "feeds.poll.deleted" | "feeds.poll.updated" | "feeds.poll.vote_casted" | "feeds.poll.vote_changed" | "feeds.poll.vote_removed" | "health.check" | "user.updated" | "moderation.custom_action" | "moderation.flagged" | "moderation.mark_reviewed" | "user.banned" | "user.deactivated" | "user.muted" | "user.reactivated" | "connection.changed" | "network.changed", handler: (event: import("../../types").FeedsEvent) => void) => () => void;
|
|
61
|
+
off: (eventName: "all" | "app.updated" | "feeds.activity.added" | "feeds.activity.deleted" | "feeds.activity.marked" | "feeds.activity.pinned" | "feeds.activity.reaction.added" | "feeds.activity.reaction.deleted" | "feeds.activity.reaction.updated" | "feeds.activity.removed_from_feed" | "feeds.activity.unpinned" | "feeds.activity.updated" | "feeds.bookmark.added" | "feeds.bookmark.deleted" | "feeds.bookmark.updated" | "feeds.bookmark_folder.deleted" | "feeds.bookmark_folder.updated" | "feeds.comment.added" | "feeds.comment.deleted" | "feeds.comment.reaction.added" | "feeds.comment.reaction.deleted" | "feeds.comment.reaction.updated" | "feeds.comment.updated" | "feeds.feed.created" | "feeds.feed.deleted" | "feeds.feed.updated" | "feeds.feed_group.changed" | "feeds.feed_group.deleted" | "feeds.feed_member.added" | "feeds.feed_member.removed" | "feeds.feed_member.updated" | "feeds.follow.created" | "feeds.follow.deleted" | "feeds.follow.updated" | "feeds.notification_feed.updated" | "feeds.poll.closed" | "feeds.poll.deleted" | "feeds.poll.updated" | "feeds.poll.vote_casted" | "feeds.poll.vote_changed" | "feeds.poll.vote_removed" | "health.check" | "user.updated" | "moderation.custom_action" | "moderation.flagged" | "moderation.mark_reviewed" | "user.banned" | "user.deactivated" | "user.muted" | "user.reactivated" | "connection.changed" | "network.changed", handler: (event: import("../../types").FeedsEvent) => void) => void;
|
|
62
|
+
offAll: (eventName?: "all" | "app.updated" | "feeds.activity.added" | "feeds.activity.deleted" | "feeds.activity.marked" | "feeds.activity.pinned" | "feeds.activity.reaction.added" | "feeds.activity.reaction.deleted" | "feeds.activity.reaction.updated" | "feeds.activity.removed_from_feed" | "feeds.activity.unpinned" | "feeds.activity.updated" | "feeds.bookmark.added" | "feeds.bookmark.deleted" | "feeds.bookmark.updated" | "feeds.bookmark_folder.deleted" | "feeds.bookmark_folder.updated" | "feeds.comment.added" | "feeds.comment.deleted" | "feeds.comment.reaction.added" | "feeds.comment.reaction.deleted" | "feeds.comment.reaction.updated" | "feeds.comment.updated" | "feeds.feed.created" | "feeds.feed.deleted" | "feeds.feed.updated" | "feeds.feed_group.changed" | "feeds.feed_group.deleted" | "feeds.feed_member.added" | "feeds.feed_member.removed" | "feeds.feed_member.updated" | "feeds.follow.created" | "feeds.follow.deleted" | "feeds.follow.updated" | "feeds.notification_feed.updated" | "feeds.poll.closed" | "feeds.poll.deleted" | "feeds.poll.updated" | "feeds.poll.vote_casted" | "feeds.poll.vote_changed" | "feeds.poll.vote_removed" | "health.check" | "user.updated" | "moderation.custom_action" | "moderation.flagged" | "moderation.mark_reviewed" | "user.banned" | "user.deactivated" | "user.muted" | "user.reactivated" | "connection.changed" | "network.changed" | undefined) => void;
|
|
63
63
|
/**
|
|
64
64
|
* connect - Connect to the WS URL
|
|
65
65
|
* the default 15s timeout allows between 2~3 tries
|
|
@@ -235,9 +235,9 @@ export interface ActivityResponse {
|
|
|
235
235
|
current_feed?: FeedResponse;
|
|
236
236
|
location?: ActivityLocation;
|
|
237
237
|
moderation?: ModerationV2Response;
|
|
238
|
+
object?: Record<string, any>;
|
|
238
239
|
parent?: ActivityResponse;
|
|
239
240
|
poll?: PollResponseData;
|
|
240
|
-
target?: Record<string, any>;
|
|
241
241
|
}
|
|
242
242
|
export interface ActivityUnpinnedEvent {
|
|
243
243
|
created_at: Date;
|
|
@@ -658,6 +658,7 @@ export interface CallParticipant {
|
|
|
658
658
|
user_session_id: string;
|
|
659
659
|
custom: Record<string, any>;
|
|
660
660
|
teams_role: Record<string, string>;
|
|
661
|
+
avg_response_time?: number;
|
|
661
662
|
ban_expires?: Date;
|
|
662
663
|
created_at?: Date;
|
|
663
664
|
deactivated_at?: Date;
|
|
@@ -1326,6 +1327,7 @@ export interface EntityCreator {
|
|
|
1326
1327
|
role: string;
|
|
1327
1328
|
custom: Record<string, any>;
|
|
1328
1329
|
teams_role: Record<string, string>;
|
|
1330
|
+
avg_response_time?: number;
|
|
1329
1331
|
ban_expires?: Date;
|
|
1330
1332
|
created_at?: Date;
|
|
1331
1333
|
deactivated_at?: Date;
|
|
@@ -1353,6 +1355,7 @@ export interface EntityCreatorResponse {
|
|
|
1353
1355
|
blocked_user_ids: string[];
|
|
1354
1356
|
teams: string[];
|
|
1355
1357
|
custom: Record<string, any>;
|
|
1358
|
+
avg_response_time?: number;
|
|
1356
1359
|
deactivated_at?: Date;
|
|
1357
1360
|
deleted_at?: Date;
|
|
1358
1361
|
image?: string;
|
|
@@ -1709,6 +1712,7 @@ export interface FullUserResponse {
|
|
|
1709
1712
|
mutes: UserMuteResponse[];
|
|
1710
1713
|
teams: string[];
|
|
1711
1714
|
custom: Record<string, any>;
|
|
1715
|
+
avg_response_time?: number;
|
|
1712
1716
|
ban_expires?: Date;
|
|
1713
1717
|
deactivated_at?: Date;
|
|
1714
1718
|
deleted_at?: Date;
|
|
@@ -2101,6 +2105,16 @@ export interface NotificationConfig {
|
|
|
2101
2105
|
track_read?: boolean;
|
|
2102
2106
|
track_seen?: boolean;
|
|
2103
2107
|
}
|
|
2108
|
+
export interface NotificationFeedUpdatedEvent {
|
|
2109
|
+
created_at: Date;
|
|
2110
|
+
fid: string;
|
|
2111
|
+
custom: Record<string, any>;
|
|
2112
|
+
type: string;
|
|
2113
|
+
received_at?: Date;
|
|
2114
|
+
aggregated_activities?: AggregatedActivityResponse[];
|
|
2115
|
+
notification_status?: NotificationStatusResponse;
|
|
2116
|
+
user?: UserResponseCommonFields;
|
|
2117
|
+
}
|
|
2104
2118
|
export interface NotificationSettings {
|
|
2105
2119
|
enabled: boolean;
|
|
2106
2120
|
call_live_started: EventNotificationSettings;
|
|
@@ -2141,6 +2155,7 @@ export interface OwnUser {
|
|
|
2141
2155
|
mutes: UserMute[];
|
|
2142
2156
|
custom: Record<string, any>;
|
|
2143
2157
|
total_unread_count_by_team: Record<string, number>;
|
|
2158
|
+
avg_response_time?: number;
|
|
2144
2159
|
deactivated_at?: Date;
|
|
2145
2160
|
deleted_at?: Date;
|
|
2146
2161
|
invisible?: boolean;
|
|
@@ -2171,6 +2186,7 @@ export interface OwnUserResponse {
|
|
|
2171
2186
|
mutes: UserMuteResponse[];
|
|
2172
2187
|
teams: string[];
|
|
2173
2188
|
custom: Record<string, any>;
|
|
2189
|
+
avg_response_time?: number;
|
|
2174
2190
|
deactivated_at?: Date;
|
|
2175
2191
|
deleted_at?: Date;
|
|
2176
2192
|
image?: string;
|
|
@@ -3088,7 +3104,6 @@ export interface UpdateFollowResponse {
|
|
|
3088
3104
|
follow: FollowResponse;
|
|
3089
3105
|
}
|
|
3090
3106
|
export interface UpdateLiveLocationRequest {
|
|
3091
|
-
created_by_device_id: string;
|
|
3092
3107
|
message_id: string;
|
|
3093
3108
|
end_at?: Date;
|
|
3094
3109
|
latitude?: number;
|
|
@@ -3168,6 +3183,7 @@ export interface User {
|
|
|
3168
3183
|
role: string;
|
|
3169
3184
|
custom: Record<string, any>;
|
|
3170
3185
|
teams_role: Record<string, string>;
|
|
3186
|
+
avg_response_time?: number;
|
|
3171
3187
|
ban_expires?: Date;
|
|
3172
3188
|
created_at?: Date;
|
|
3173
3189
|
deactivated_at?: Date;
|
|
@@ -3249,6 +3265,7 @@ export interface UserResponse {
|
|
|
3249
3265
|
blocked_user_ids: string[];
|
|
3250
3266
|
teams: string[];
|
|
3251
3267
|
custom: Record<string, any>;
|
|
3268
|
+
avg_response_time?: number;
|
|
3252
3269
|
deactivated_at?: Date;
|
|
3253
3270
|
deleted_at?: Date;
|
|
3254
3271
|
image?: string;
|
|
@@ -3268,6 +3285,7 @@ export interface UserResponseCommonFields {
|
|
|
3268
3285
|
blocked_user_ids: string[];
|
|
3269
3286
|
teams: string[];
|
|
3270
3287
|
custom: Record<string, any>;
|
|
3288
|
+
avg_response_time?: number;
|
|
3271
3289
|
deactivated_at?: Date;
|
|
3272
3290
|
deleted_at?: Date;
|
|
3273
3291
|
image?: string;
|
|
@@ -3287,6 +3305,7 @@ export interface UserResponsePrivacyFields {
|
|
|
3287
3305
|
blocked_user_ids: string[];
|
|
3288
3306
|
teams: string[];
|
|
3289
3307
|
custom: Record<string, any>;
|
|
3308
|
+
avg_response_time?: number;
|
|
3290
3309
|
deactivated_at?: Date;
|
|
3291
3310
|
deleted_at?: Date;
|
|
3292
3311
|
image?: string;
|
|
@@ -3440,6 +3459,8 @@ export type WSClientEvent = ({
|
|
|
3440
3459
|
} & FollowDeletedEvent) | ({
|
|
3441
3460
|
type: 'feeds.follow.updated';
|
|
3442
3461
|
} & FollowUpdatedEvent) | ({
|
|
3462
|
+
type: 'feeds.notification_feed.updated';
|
|
3463
|
+
} & NotificationFeedUpdatedEvent) | ({
|
|
3443
3464
|
type: 'feeds.poll.closed';
|
|
3444
3465
|
} & PollClosedFeedEvent) | ({
|
|
3445
3466
|
type: 'feeds.poll.deleted';
|
|
@@ -3523,6 +3544,8 @@ export type WSEvent = ({
|
|
|
3523
3544
|
} & FollowDeletedEvent) | ({
|
|
3524
3545
|
type: 'feeds.follow.updated';
|
|
3525
3546
|
} & FollowUpdatedEvent) | ({
|
|
3547
|
+
type: 'feeds.notification_feed.updated';
|
|
3548
|
+
} & NotificationFeedUpdatedEvent) | ({
|
|
3526
3549
|
type: 'feeds.poll.closed';
|
|
3527
3550
|
} & PollClosedFeedEvent) | ({
|
|
3528
3551
|
type: 'feeds.poll.deleted';
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { FeedState } from '../Feed';
|
|
2
|
+
import { FollowResponse } from '../gen/models';
|
|
3
|
+
import { UpdateStateResult } from '../types-internal';
|
|
4
|
+
export declare const handleFollowCreated: (follow: FollowResponse, currentState: FeedState, currentFeedId: string, connectedUserId?: string) => UpdateStateResult<{
|
|
5
|
+
data: FeedState;
|
|
6
|
+
}>;
|
|
7
|
+
export declare const handleFollowDeleted: (follow: FollowResponse | {
|
|
8
|
+
source_feed: {
|
|
9
|
+
fid: string;
|
|
10
|
+
};
|
|
11
|
+
target_feed: {
|
|
12
|
+
fid: string;
|
|
13
|
+
};
|
|
14
|
+
}, currentState: FeedState, currentFeedId: string, connectedUserId?: string) => UpdateStateResult<{
|
|
15
|
+
data: FeedState;
|
|
16
|
+
}>;
|
|
17
|
+
export declare const handleFollowUpdated: (currentState: FeedState) => UpdateStateResult<{
|
|
18
|
+
data: FeedState;
|
|
19
|
+
}>;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { FollowResponse } from '../gen/models';
|
|
2
|
+
export declare const shouldUpdateState: ({ stateUpdateId, stateUpdateQueue, watch, }: {
|
|
3
|
+
stateUpdateId: string;
|
|
4
|
+
stateUpdateQueue: Set<string>;
|
|
5
|
+
watch: boolean;
|
|
6
|
+
}) => boolean;
|
|
7
|
+
export declare const getStateUpdateQueueIdForFollow: (follow: FollowResponse) => string;
|
|
8
|
+
export declare const getStateUpdateQueueIdForUnfollow: (follow: FollowResponse | {
|
|
9
|
+
source_feed: {
|
|
10
|
+
fid: string;
|
|
11
|
+
};
|
|
12
|
+
target_feed: {
|
|
13
|
+
fid: string;
|
|
14
|
+
};
|
|
15
|
+
}) => string;
|
package/dist/src/utils.d.ts
CHANGED
|
@@ -7,3 +7,4 @@ export declare const isCommentResponse: (entity: CommentParent) => entity is Com
|
|
|
7
7
|
export declare const Constants: {
|
|
8
8
|
readonly DEFAULT_COMMENT_PAGINATION: "first";
|
|
9
9
|
};
|
|
10
|
+
export declare const uniqueArrayMerge: <T>(existingArray: T[], arrayToMerge: T[], getKey: (v: T) => string) => T[];
|