@stream-io/feeds-client 0.2.18 → 0.2.20

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.
Files changed (84) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/dist/cjs/index.js +94 -25
  3. package/dist/cjs/index.js.map +1 -1
  4. package/dist/cjs/react-bindings.js +26 -55
  5. package/dist/cjs/react-bindings.js.map +1 -1
  6. package/dist/es/index.mjs +86 -17
  7. package/dist/es/index.mjs.map +1 -1
  8. package/dist/es/react-bindings.mjs +19 -48
  9. package/dist/es/react-bindings.mjs.map +1 -1
  10. package/dist/{index-Zde8UE5f.mjs → feeds-client-BObWT4vl.mjs} +191 -92
  11. package/dist/feeds-client-BObWT4vl.mjs.map +1 -0
  12. package/dist/{index--koeDtxd.js → feeds-client-BlR_3zy2.js} +178 -79
  13. package/dist/feeds-client-BlR_3zy2.js.map +1 -0
  14. package/dist/tsconfig.tsbuildinfo +1 -1
  15. package/dist/types/bindings/react/hooks/feed-state-hooks/useOwnCapabilities.d.ts +2 -32
  16. package/dist/types/bindings/react/hooks/feed-state-hooks/useOwnCapabilities.d.ts.map +1 -1
  17. package/dist/types/common/real-time/event-models.d.ts +7 -2
  18. package/dist/types/common/real-time/event-models.d.ts.map +1 -1
  19. package/dist/types/common/types.d.ts +1 -0
  20. package/dist/types/common/types.d.ts.map +1 -1
  21. package/dist/types/feed/event-handlers/activity/handle-activity-added.d.ts.map +1 -1
  22. package/dist/types/feed/event-handlers/activity/handle-activity-updated.d.ts.map +1 -1
  23. package/dist/types/feed/feed.d.ts +1 -1
  24. package/dist/types/feed/feed.d.ts.map +1 -1
  25. package/dist/types/feeds-client/feeds-client.d.ts +9 -1
  26. package/dist/types/feeds-client/feeds-client.d.ts.map +1 -1
  27. package/dist/types/utils/throttling/index.d.ts +3 -0
  28. package/dist/types/utils/throttling/index.d.ts.map +1 -0
  29. package/dist/types/utils/throttling/throttle.d.ts +34 -0
  30. package/dist/types/utils/throttling/throttle.d.ts.map +1 -0
  31. package/dist/types/utils/throttling/throttled-get-batched-own-capabilities.d.ts +14 -0
  32. package/dist/types/utils/throttling/throttled-get-batched-own-capabilities.d.ts.map +1 -0
  33. package/package.json +7 -3
  34. package/react-bindings.d.ts +11 -0
  35. package/react-bindings.js +7 -0
  36. package/react-bindings.mjs +11 -0
  37. package/src/bindings/react/hooks/feed-state-hooks/useOwnCapabilities.ts +21 -73
  38. package/src/common/real-time/event-models.ts +8 -2
  39. package/src/common/types.ts +1 -0
  40. package/src/feed/event-handlers/activity/handle-activity-added.ts +9 -1
  41. package/src/feed/event-handlers/activity/handle-activity-updated.ts +4 -0
  42. package/src/feed/feed.ts +18 -3
  43. package/src/feeds-client/feeds-client.ts +106 -3
  44. package/src/utils/throttling/index.ts +2 -0
  45. package/src/utils/throttling/throttle.ts +123 -0
  46. package/src/utils/throttling/throttled-get-batched-own-capabilities.ts +44 -0
  47. package/dist/index--koeDtxd.js.map +0 -1
  48. package/dist/index-Zde8UE5f.mjs.map +0 -1
  49. package/src/feed/event-handlers/activity/activity-marked-utils.test.ts +0 -208
  50. package/src/feed/event-handlers/activity/activity-reaction-utils.test.ts +0 -371
  51. package/src/feed/event-handlers/activity/handle-activity-added.test.ts +0 -97
  52. package/src/feed/event-handlers/activity/handle-activity-deleted.test.ts +0 -117
  53. package/src/feed/event-handlers/activity/handle-activity-pinned.test.ts +0 -60
  54. package/src/feed/event-handlers/activity/handle-activity-reaction-added.test.ts +0 -257
  55. package/src/feed/event-handlers/activity/handle-activity-reaction-deleted.test.ts +0 -317
  56. package/src/feed/event-handlers/activity/handle-activity-reaction-updated.test.ts +0 -282
  57. package/src/feed/event-handlers/activity/handle-activity-unpinned.test.ts +0 -95
  58. package/src/feed/event-handlers/activity/handle-activity-updated.test.ts +0 -245
  59. package/src/feed/event-handlers/add-aggregated-activities-to-state.test.ts +0 -510
  60. package/src/feed/event-handlers/bookmark/bookmark-utils.test.ts +0 -521
  61. package/src/feed/event-handlers/bookmark/handle-bookmark-added.test.ts +0 -178
  62. package/src/feed/event-handlers/bookmark/handle-bookmark-deleted.test.ts +0 -188
  63. package/src/feed/event-handlers/bookmark/handle-bookmark-updated.test.ts +0 -196
  64. package/src/feed/event-handlers/comment/handle-comment-added.test.ts +0 -271
  65. package/src/feed/event-handlers/comment/handle-comment-deleted.test.ts +0 -255
  66. package/src/feed/event-handlers/comment/handle-comment-reaction-added.test.ts +0 -329
  67. package/src/feed/event-handlers/comment/handle-comment-reaction-deleted.test.ts +0 -343
  68. package/src/feed/event-handlers/comment/handle-comment-reaction-updated.test.ts +0 -350
  69. package/src/feed/event-handlers/comment/handle-comment-updated.test.ts +0 -267
  70. package/src/feed/event-handlers/comment/utils/update-comment-count.test.ts +0 -322
  71. package/src/feed/event-handlers/feed-member/handle-feed-member-added.test.ts +0 -75
  72. package/src/feed/event-handlers/feed-member/handle-feed-member-removed.test.ts +0 -82
  73. package/src/feed/event-handlers/feed-member/handle-feed-member-updated.test.ts +0 -84
  74. package/src/feed/event-handlers/follow/follow-state-update-queue.test.ts +0 -219
  75. package/src/feed/event-handlers/follow/handle-follow-created.test.ts +0 -250
  76. package/src/feed/event-handlers/follow/handle-follow-deleted.test.ts +0 -268
  77. package/src/feed/event-handlers/follow/handle-follow-updated.test.ts +0 -131
  78. package/src/feed/event-handlers/notification-feed/handle-notification-feed-updated.test.ts +0 -182
  79. package/src/feed/event-handlers/story-feeds/handle-story-feeds-updated.test.ts +0 -45
  80. package/src/feed/feed.test.ts +0 -90
  81. package/src/feeds-client/event-handlers/user/handle-user-updated.test.ts +0 -53
  82. package/src/utils/event-triggered-by-connected-user.test.ts +0 -73
  83. package/src/utils/state-update-queue.test.ts +0 -129
  84. package/src/utils/unique-array-merge.test.ts +0 -179
@@ -1,117 +0,0 @@
1
- import { describe, it, expect, beforeEach } from 'vitest';
2
- import { Feed } from '../../../feed';
3
- import { FeedsClient } from '../../../feeds-client';
4
- import { handleActivityDeleted } from './handle-activity-deleted';
5
- import {
6
- generateActivityDeletedEvent,
7
- generateActivityPinResponse,
8
- generateActivityResponse,
9
- generateFeedResponse,
10
- generateOwnUser,
11
- getHumanId,
12
- } from '../../../test-utils/response-generators';
13
-
14
- describe(handleActivityDeleted.name, () => {
15
- let feed: Feed;
16
- let client: FeedsClient;
17
- let currentUserId: string;
18
-
19
- beforeEach(() => {
20
- client = new FeedsClient('mock-api-key');
21
- currentUserId = getHumanId();
22
- client.state.partialNext({
23
- connected_user: generateOwnUser({ id: currentUserId }),
24
- });
25
-
26
- const feedResponse = generateFeedResponse({
27
- id: 'main',
28
- group_id: 'user',
29
- created_by: { id: currentUserId },
30
- });
31
-
32
- feed = new Feed(
33
- client,
34
- feedResponse.group_id,
35
- feedResponse.id,
36
- feedResponse,
37
- );
38
- });
39
-
40
- it('removes the activity from activities array when present', () => {
41
- const activity1 = generateActivityResponse();
42
- const activity2 = generateActivityResponse();
43
- feed.state.partialNext({ activities: [activity1, activity2] });
44
-
45
- const event = generateActivityDeletedEvent({
46
- activity: { id: activity1.id },
47
- });
48
-
49
- const stateBefore = feed.currentState;
50
- expect(stateBefore.activities).toHaveLength(2);
51
-
52
- handleActivityDeleted.call(feed, event);
53
-
54
- const stateAfter = feed.currentState;
55
- expect(stateAfter.activities).toHaveLength(1);
56
- expect(stateAfter.activities?.[0].id).toBe(activity2.id);
57
- });
58
-
59
- it('removes the activity from pinned_activities when present', () => {
60
- const pin1 = generateActivityPinResponse();
61
- const pin2 = generateActivityPinResponse();
62
- feed.state.partialNext({ pinned_activities: [pin1, pin2] });
63
-
64
- const event = generateActivityDeletedEvent({
65
- activity: { id: pin1.activity.id },
66
- });
67
-
68
- const stateBefore = feed.currentState;
69
- expect(stateBefore.pinned_activities).toHaveLength(2);
70
-
71
- handleActivityDeleted.call(feed, event);
72
-
73
- const stateAfter = feed.currentState;
74
-
75
- expect(stateAfter.pinned_activities).toHaveLength(1);
76
- expect(stateAfter.pinned_activities?.[0]).toBe(pin2);
77
- });
78
-
79
- it('updates both arrays when the activity exists in both activities and pinned_activities', () => {
80
- const sharedId = getHumanId();
81
- const activity = generateActivityResponse({ id: sharedId });
82
- const pinnedActivity = generateActivityPinResponse({
83
- activity: { id: sharedId },
84
- });
85
- feed.state.partialNext({
86
- activities: [activity],
87
- pinned_activities: [pinnedActivity],
88
- });
89
-
90
- const event = generateActivityDeletedEvent({
91
- activity: { id: sharedId },
92
- });
93
-
94
- handleActivityDeleted.call(feed, event);
95
-
96
- const stateAfter = feed.currentState;
97
- expect(stateAfter.activities).toHaveLength(0);
98
- expect(stateAfter.pinned_activities).toHaveLength(0);
99
- });
100
-
101
- it('does nothing if the activity is not found in either list', () => {
102
- const activity = generateActivityResponse();
103
- const pinnedActivity = generateActivityPinResponse();
104
- feed.state.partialNext({
105
- activities: [activity],
106
- pinned_activities: [pinnedActivity],
107
- });
108
-
109
- const event = generateActivityDeletedEvent({ activity: { id: 'unknown' } });
110
-
111
- const stateBefore = feed.currentState;
112
- handleActivityDeleted.call(feed, event);
113
- const stateAfter = feed.currentState;
114
-
115
- expect(stateAfter).toBe(stateBefore);
116
- });
117
- });
@@ -1,60 +0,0 @@
1
- import { describe, it, expect, beforeEach } from 'vitest';
2
-
3
- import { Feed } from '../../../feed';
4
- import { FeedsClient } from '../../../feeds-client';
5
- import { handleActivityPinned } from './handle-activity-pinned';
6
- import {
7
- generateActivityPinnedEvent,
8
- generateActivityPinResponse,
9
- generateFeedResponse,
10
- } from '../../../test-utils/response-generators';
11
- import type { ActivityPinResponse } from '../../../gen/models';
12
-
13
- describe(handleActivityPinned.name, () => {
14
- let feed: Feed;
15
- let client: FeedsClient;
16
- let pinnedActivity: ActivityPinResponse;
17
- let otherPinnedActivity: ActivityPinResponse;
18
-
19
- beforeEach(() => {
20
- client = new FeedsClient('mock-api-key');
21
- const feedResponse = generateFeedResponse({ id: 'main', group_id: 'user' });
22
- feed = new Feed(
23
- client,
24
- feedResponse.group_id,
25
- feedResponse.id,
26
- feedResponse,
27
- );
28
- pinnedActivity = generateActivityPinResponse();
29
- otherPinnedActivity = generateActivityPinResponse();
30
- feed.state.next((currentState) => ({
31
- ...currentState,
32
- pinned_activities: [otherPinnedActivity],
33
- }));
34
- });
35
-
36
- it('adds a new activity to pinned_activities', () => {
37
- const event = generateActivityPinnedEvent({
38
- pinned_activity: pinnedActivity,
39
- });
40
- handleActivityPinned.call(feed, event);
41
- const { pinned_activities } = feed.currentState;
42
- expect(pinned_activities).toHaveLength(2);
43
- expect(pinned_activities![0].activity.id).toBe(pinnedActivity.activity.id);
44
- expect(pinned_activities![1]).toBe(otherPinnedActivity);
45
- });
46
-
47
- it('creates pinned_activities if it was undefined', () => {
48
- feed.state.next((currentState) => ({
49
- ...currentState,
50
- pinned_activities: undefined,
51
- }));
52
- const event = generateActivityPinnedEvent({
53
- pinned_activity: pinnedActivity,
54
- });
55
- handleActivityPinned.call(feed, event);
56
- const { pinned_activities } = feed.currentState;
57
- expect(pinned_activities).toHaveLength(1);
58
- expect(pinned_activities![0].activity.id).toBe(pinnedActivity.activity.id);
59
- });
60
- });
@@ -1,257 +0,0 @@
1
- import { describe, it, expect, beforeEach } from 'vitest';
2
- import { Feed } from '../../../feed';
3
- import { FeedsClient } from '../../../feeds-client';
4
- import { handleActivityReactionAdded } from './handle-activity-reaction-added';
5
- import {
6
- generateActivityPinResponse,
7
- generateActivityResponse,
8
- generateFeedResponse,
9
- generateOwnUser,
10
- generateActivityReactionAddedEvent,
11
- getHumanId,
12
- } from '../../../test-utils';
13
- import { shouldUpdateState } from '../../../utils';
14
- import type { EventPayload } from '../../../types-internal';
15
-
16
- describe(handleActivityReactionAdded.name, () => {
17
- let feed: Feed;
18
- let client: FeedsClient;
19
- let currentUserId: string;
20
-
21
- beforeEach(() => {
22
- client = new FeedsClient('mock-api-key');
23
- currentUserId = getHumanId();
24
- client.state.partialNext({
25
- connected_user: generateOwnUser({ id: currentUserId }),
26
- });
27
- const feedResponse = generateFeedResponse({
28
- id: 'main',
29
- group_id: 'user',
30
- created_by: { id: currentUserId },
31
- });
32
- feed = new Feed(
33
- client,
34
- feedResponse.group_id,
35
- feedResponse.id,
36
- feedResponse,
37
- );
38
- });
39
-
40
- it('adds a reaction to the correct activity for current user & updates activities with event.activity', () => {
41
- const event = generateActivityReactionAddedEvent({
42
- reaction: {
43
- user: { id: currentUserId },
44
- },
45
- activity: {
46
- reaction_count: 1,
47
- },
48
- });
49
- const activity = generateActivityResponse({
50
- id: event.activity.id,
51
- reaction_count: 0,
52
- });
53
- const activityPin = generateActivityPinResponse({
54
- activity: { ...activity },
55
- });
56
- feed.state.partialNext({
57
- activities: [activity],
58
- pinned_activities: [activityPin],
59
- });
60
-
61
- const stateBefore = feed.currentState;
62
-
63
- expect(stateBefore.activities![0].reaction_count).toBe(0);
64
- expect(stateBefore.pinned_activities![0].activity.reaction_count).toBe(
65
- 0,
66
- );
67
-
68
- handleActivityReactionAdded.call(feed, event);
69
-
70
- const stateAfter = feed.currentState;
71
-
72
- expect(stateAfter.activities![0].own_reactions).toContain(event.reaction);
73
- expect(stateAfter.pinned_activities![0].activity.own_reactions).toContain(
74
- event.reaction,
75
- );
76
- expect(stateAfter.activities![0].own_bookmarks).toBe(
77
- stateBefore.activities![0].own_bookmarks,
78
- );
79
- expect(stateAfter.pinned_activities![0].activity.own_bookmarks).toBe(
80
- stateBefore.pinned_activities![0].activity.own_bookmarks,
81
- );
82
- expect(stateAfter.activities![0].reaction_count).toBe(1);
83
- expect(stateAfter.pinned_activities![0].activity.reaction_count).toBe(1);
84
- });
85
-
86
- it('does not add to own_reactions if reaction is from another user but still updates activity', () => {
87
- const event = generateActivityReactionAddedEvent({
88
- reaction: { user: { id: 'other-user-id' } },
89
- activity: {
90
- reaction_count: 1,
91
- },
92
- });
93
- const activity = generateActivityResponse({
94
- id: event.activity.id,
95
- reaction_count: 0,
96
- });
97
- const activityPin = generateActivityPinResponse({
98
- activity: { ...activity },
99
- });
100
- feed.state.partialNext({
101
- activities: [activity],
102
- pinned_activities: [activityPin],
103
- });
104
-
105
- const stateBefore = feed.currentState;
106
-
107
- expect(stateBefore.activities![0].reaction_count).toBe(0);
108
- expect(stateBefore.pinned_activities![0].activity.reaction_count).toBe(
109
- 0,
110
- );
111
-
112
- handleActivityReactionAdded.call(feed, event);
113
-
114
- const stateAfter = feed.currentState;
115
-
116
- expect(stateAfter.activities![0].own_reactions).toHaveLength(0);
117
- expect(
118
- stateAfter.pinned_activities![0].activity.own_reactions,
119
- ).toHaveLength(0);
120
- expect(stateAfter.activities![0].reaction_count).toBe(1);
121
- expect(stateAfter.pinned_activities![0].activity.reaction_count).toBe(1);
122
- expect(stateAfter.activities![0].own_bookmarks).toBe(
123
- stateBefore.activities![0].own_bookmarks,
124
- );
125
- expect(stateAfter.pinned_activities![0].activity.own_bookmarks).toBe(
126
- stateBefore.pinned_activities![0].activity.own_bookmarks,
127
- );
128
- expect(stateAfter.activities![0].own_reactions).toBe(
129
- stateBefore.activities![0].own_reactions,
130
- );
131
- expect(stateAfter.pinned_activities![0].activity.own_reactions).toBe(
132
- stateBefore.pinned_activities![0].activity.own_reactions,
133
- );
134
- });
135
-
136
- it('does nothing if activity is not found', () => {
137
- const event = generateActivityReactionAddedEvent({
138
- reaction: { user: { id: currentUserId } },
139
- });
140
- const activity = generateActivityResponse({
141
- id: 'unrelated',
142
- });
143
- const activityPin = generateActivityPinResponse({
144
- activity: { ...activity },
145
- });
146
- feed.state.partialNext({
147
- activities: [activity],
148
- pinned_activities: [activityPin],
149
- });
150
-
151
- const stateBefore = feed.currentState;
152
-
153
- handleActivityReactionAdded.call(feed, event);
154
-
155
- const stateAfter = feed.currentState;
156
-
157
- expect(stateAfter).toBe(stateBefore);
158
- });
159
-
160
- describe(`Activity reaction added ${shouldUpdateState.name} integration`, () => {
161
- const activityId = 'reacted-activity';
162
- let currentUserPayload: EventPayload<'feeds.activity.reaction.added'>;
163
-
164
- beforeEach(() => {
165
- currentUserPayload = generateActivityReactionAddedEvent({
166
- reaction: { user: { id: currentUserId }, activity_id: activityId },
167
- activity: { id: activityId }
168
- });
169
-
170
- feed.state.partialNext({ activities: [currentUserPayload.activity]});
171
- feed.state.partialNext({ watch: true });
172
- })
173
-
174
- it(`skips update if ${shouldUpdateState.name} returns false`, () => {
175
- // 1. HTTP and then WS
176
-
177
- handleActivityReactionAdded.call(feed, currentUserPayload, false);
178
-
179
- let stateBefore = feed.currentState;
180
-
181
- handleActivityReactionAdded.call(feed, currentUserPayload);
182
-
183
- let stateAfter = feed.currentState;
184
-
185
- expect(stateAfter).toBe(stateBefore);
186
- // @ts-expect-error Using Feed internals for tests only
187
- expect(feed.stateUpdateQueue.size).toEqual(0);
188
-
189
- // 2. WS and the HTTP
190
-
191
- handleActivityReactionAdded.call(feed, currentUserPayload);
192
-
193
- stateBefore = feed.currentState;
194
-
195
- handleActivityReactionAdded.call(feed, currentUserPayload, false);
196
-
197
- stateAfter = feed.currentState;
198
-
199
- expect(stateAfter).toBe(stateBefore);
200
- // @ts-expect-error Using Feed internals for tests only
201
- expect(feed.stateUpdateQueue.size).toEqual(0);
202
- })
203
-
204
- it('allows update again from WS after clearing the stateUpdateQueue', () => {
205
- handleActivityReactionAdded.call(feed, currentUserPayload);
206
-
207
- // Clear the queue
208
- (feed as any).stateUpdateQueue.clear();
209
-
210
- // Now update should be allowed from another WS event
211
- handleActivityReactionAdded.call(feed, currentUserPayload);
212
-
213
- const activities = feed.currentState.activities!;
214
- const activity = activities.find((a) => a.id === activityId);
215
- const [latestReaction] = activity?.own_reactions ?? [];
216
-
217
- expect(activity?.own_reactions.length).toEqual(2);
218
- expect(latestReaction).toMatchObject(currentUserPayload.reaction);
219
- });
220
-
221
- it('allows update again from HTTP response after clearing the stateUpdateQueue', () => {
222
- handleActivityReactionAdded.call(feed, currentUserPayload, false);
223
-
224
- // Clear the queue
225
- (feed as any).stateUpdateQueue.clear();
226
-
227
- // Now update should be allowed from another HTTP response
228
- handleActivityReactionAdded.call(feed, currentUserPayload, false);
229
-
230
- const activities = feed.currentState.activities!;
231
- const activity = activities.find((a) => a.id === activityId);
232
- const [latestReaction] = activity?.own_reactions ?? [];
233
-
234
- expect(activity?.own_reactions.length).toEqual(2);
235
- expect(latestReaction).toMatchObject(currentUserPayload.reaction);
236
- });
237
-
238
- it('should not insert anything into the stateUpdateQueue if the connected_user did not trigger the reaction', () => {
239
- const otherUserPayload = generateActivityReactionAddedEvent({
240
- reaction: { user: { id: getHumanId() }, activity_id: activityId },
241
- activity: { id: activityId }
242
- });
243
-
244
- handleActivityReactionAdded.call(feed, otherUserPayload);
245
-
246
- expect((feed as any).stateUpdateQueue).toEqual(new Set());
247
-
248
- handleActivityReactionAdded.call(feed, otherUserPayload);
249
-
250
- const activities = feed.currentState.activities!;
251
- const activity = activities.find((a) => a.id === activityId);
252
-
253
- expect((feed as any).stateUpdateQueue).toEqual(new Set());
254
- expect(activity?.own_reactions.length).toEqual(0);
255
- });
256
- })
257
- });