@stream-io/feeds-client 0.1.11 → 0.2.0

package/index.ts

@@ -1,4 +1,4 @@
-export * from './src/feeds-client';
+export * from './src/feeds-client/feeds-client';
 export * from './src/feed/feed';
 export * from './src/gen/models';
 export * from './src/types';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/feeds-client",
-  "version": "0.1.11",
+  "version": "0.2.0",
   "packageManager": "yarn@3.2.4",
   "main": "./dist/index.node.js",
   "exports": {
@@ -63,7 +63,7 @@
   "devDependencies": {
     "@rollup/plugin-replace": "^6.0.1",
     "@rollup/plugin-typescript": "^12.1.0",
-    "@stream-io/node-sdk": "0.5.0",
+    "@stream-io/node-sdk": "0.6.0",
     "@types/react": "^19.1.8",
     "@vitest/coverage-v8": "3.2.4",
     "dotenv": "^16.4.5",

package/src/feed/event-handlers/follow/handle-follow-created.test.ts

@@ -1,4 +1,8 @@
-import { FeedResponse, FollowResponse, UserResponse } from '../../../gen/models';
+import {
+  FeedResponse,
+  FollowResponse,
+  UserResponse,
+} from '../../../gen/models';
 import { generateFollowResponse } from '../../../test-utils';
 import { updateStateFollowCreated } from './handle-follow-created';
 
@@ -44,7 +48,7 @@ describe('handle-follow-created', () => {
         source_feed: {
           ...mockFeed,
           id: 'feed-x',
-          fid: 'user:feed-x',
+          feed: 'user:feed-x',
           created_by: {
             ...mockUser,
             id: 'user-x',
@@ -54,7 +58,7 @@ describe('handle-follow-created', () => {
         target_feed: {
           ...mockFeed,
           id: 'other-feed',
-          fid: 'user:other-feed',
+          feed: 'user:other-feed',
           created_by: mockUser,
         },
       };
@@ -86,7 +90,7 @@ describe('handle-follow-created', () => {
         source_feed: {
           ...mockFeed,
           id: 'other-feed',
-          fid: 'user:other-feed',
+          feed: 'user:other-feed',
           created_by: {
             ...mockUser,
             id: 'other-user',
@@ -95,7 +99,7 @@ describe('handle-follow-created', () => {
         target_feed: {
           ...mockFeed,
           id: 'feed-1',
-          fid: 'user:feed-1',
+          feed: 'user:feed-1',
           created_by: mockUser,
           follower_count: 1,
         },
@@ -128,13 +132,13 @@ describe('handle-follow-created', () => {
         source_feed: {
           ...mockFeed,
           id: 'feed-1',
-          fid: 'user:feed-1',
+          feed: 'user:feed-1',
           created_by: { ...mockUser, id: 'user-1' },
         },
         target_feed: {
           ...mockFeed,
           id: 'feed-x',
-          fid: 'user:feed-x',
+          feed: 'user:feed-x',
           created_by: {
             ...mockUser,
             id: 'user-x',
@@ -166,13 +170,13 @@ describe('handle-follow-created', () => {
         source_feed: {
           ...mockFeed,
           id: 'other-feed',
-          fid: 'user:other-feed',
+          feed: 'user:other-feed',
           created_by: mockUser,
         },
         target_feed: {
           ...mockFeed,
           id: 'feed-1',
-          fid: 'user:feed-1',
+          feed: 'user:feed-1',
           created_by: mockUser,
         },
       };
@@ -202,7 +206,7 @@ describe('handle-follow-created', () => {
         source_feed: {
           ...mockFeed,
           id: 'existing-feed',
-          fid: 'user:existing-feed',
+          feed: 'user:existing-feed',
           created_by: mockUser,
         },
       };
@@ -212,13 +216,13 @@ describe('handle-follow-created', () => {
         source_feed: {
           ...mockFeed,
           id: 'other-feed',
-          fid: 'user:other-feed',
+          feed: 'user:other-feed',
           created_by: mockUser,
         },
         target_feed: {
           ...mockFeed,
           id: 'feed-1',
-          fid: 'user:feed-1',
+          feed: 'user:feed-1',
           created_by: mockUser,
         },
       };

package/src/feed/event-handlers/follow/handle-follow-created.ts

@@ -5,10 +5,7 @@ import type {
   PartializeAllBut,
   UpdateStateResult,
 } from '../../../types-internal';
-import {
-  getStateUpdateQueueId,
-  shouldUpdateState,
-} from '../../../utils';
+import { getStateUpdateQueueId, shouldUpdateState } from '../../../utils';
 
 export const updateStateFollowCreated = (
   follow: FollowResponse,
@@ -24,7 +21,7 @@ export const updateStateFollowCreated = (
   let newState: FeedState = { ...currentState };
 
   // this feed followed someone
-  if (follow.source_feed.fid === currentFeedId) {
+  if (follow.source_feed.feed === currentFeedId) {
     newState = {
       ...newState,
       // Update FeedResponse fields, that has the new follower/following count
@@ -37,7 +34,7 @@ export const updateStateFollowCreated = (
     }
   } else if (
     // someone followed this feed
-    follow.target_feed.fid === currentFeedId
+    follow.target_feed.feed === currentFeedId
   ) {
     const source = follow.source_feed;
 
@@ -84,7 +81,7 @@ export function handleFollowCreated(
   const result = updateStateFollowCreated(
     follow,
     this.currentState,
-    this.fid,
+    this.feed,
     connectedUser?.id,
   );
   if (result.changed) {

package/src/feed/event-handlers/follow/handle-follow-deleted.test.ts

@@ -1,4 +1,8 @@
-import { FollowResponse, FeedResponse, UserResponse } from '../../../gen/models';
+import {
+  FollowResponse,
+  FeedResponse,
+  UserResponse,
+} from '../../../gen/models';
 import { generateFollowResponse } from '../../../test-utils';
 import { updateStateFollowDeleted } from './handle-follow-deleted';
 
@@ -22,13 +26,13 @@ describe('handle-follow-deleted', () => {
         source_feed: {
           ...mockFeed,
           id: 'feed-1',
-          fid: 'user:feed-1',
+          feed: 'user:feed-1',
           created_by: mockUser,
         },
         target_feed: {
           ...mockFeed,
           id: 'other-feed',
-          fid: 'user:other-feed',
+          feed: 'user:other-feed',
           created_by: mockUser,
         },
       };
@@ -59,7 +63,7 @@ describe('handle-follow-deleted', () => {
         source_feed: {
           ...mockFeed,
           id: 'other-feed',
-          fid: 'user:other-feed',
+          feed: 'user:other-feed',
           created_by: {
             ...mockUser,
             id: 'other-user',
@@ -68,7 +72,7 @@ describe('handle-follow-deleted', () => {
         target_feed: {
           ...mockFeed,
           id: 'feed-1',
-          fid: 'user:feed-1',
+          feed: 'user:feed-1',
           created_by: mockUser,
         },
       };
@@ -101,13 +105,13 @@ describe('handle-follow-deleted', () => {
         source_feed: {
           ...mockFeed,
           id: 'other-feed',
-          fid: 'user:other-feed',
+          feed: 'user:other-feed',
           created_by: { ...mockUser, id: 'user-1' },
         },
         target_feed: {
           ...mockFeed,
           id: 'feed-1',
-          fid: 'user:feed-1',
+          feed: 'user:feed-1',
           created_by: mockUser,
         },
       };
@@ -139,13 +143,13 @@ describe('handle-follow-deleted', () => {
         source_feed: {
           ...mockFeed,
           id: 'other-feed',
-          fid: 'user:other-feed',
+          feed: 'user:other-feed',
           created_by: { ...mockUser, id: 'other-user' },
         },
         target_feed: {
           ...mockFeed,
           id: 'feed-1',
-          fid: 'user:feed-1',
+          feed: 'user:feed-1',
           created_by: mockUser,
         },
       };
@@ -176,13 +180,13 @@ describe('handle-follow-deleted', () => {
         source_feed: {
           ...mockFeed,
           id: 'other-feed',
-          fid: 'user:other-feed',
+          feed: 'user:other-feed',
           created_by: mockUser,
         },
         target_feed: {
           ...mockFeed,
           id: 'feed-1',
-          fid: 'user:feed-1',
+          feed: 'user:feed-1',
           created_by: mockUser,
         },
       };
@@ -214,13 +218,13 @@ describe('handle-follow-deleted', () => {
         source_feed: {
           ...mockFeed,
           id: 'feed-1',
-          fid: 'user:feed-1',
+          feed: 'user:feed-1',
           created_by: mockUser,
         },
         target_feed: {
           ...mockFeed,
           id: 'target-to-remove',
-          fid: 'user:target-to-remove',
+          feed: 'user:target-to-remove',
           created_by: mockUser,
         },
       };
@@ -230,13 +234,13 @@ describe('handle-follow-deleted', () => {
         source_feed: {
           ...mockFeed,
           id: 'feed-1',
-          fid: 'user:feed-1',
+          feed: 'user:feed-1',
           created_by: mockUser,
         },
         target_feed: {
           ...mockFeed,
           id: 'target-to-keep',
-          fid: 'user:target-to-keep',
+          feed: 'user:target-to-keep',
           created_by: mockUser,
         },
       };

package/src/feed/event-handlers/follow/handle-follow-deleted.ts

@@ -17,7 +17,7 @@ export const updateStateFollowDeleted = (
   let newState: FeedState = { ...currentState };
 
   // this feed unfollowed someone
-  if (follow.source_feed.fid === currentFeedId) {
+  if (follow.source_feed.feed === currentFeedId) {
     newState = {
       ...newState,
       // Update FeedResponse fields, that has the new follower/following count
@@ -27,12 +27,12 @@ export const updateStateFollowDeleted = (
     // Only update if following array already exists
     if (currentState.following !== undefined) {
       newState.following = currentState.following.filter(
-        (followItem) => followItem.target_feed.fid !== follow.target_feed.fid,
+        (followItem) => followItem.target_feed.feed !== follow.target_feed.feed,
       );
     }
   } else if (
     // someone unfollowed this feed
-    follow.target_feed.fid === currentFeedId
+    follow.target_feed.feed === currentFeedId
   ) {
     const source = follow.source_feed;
 
@@ -47,14 +47,14 @@ export const updateStateFollowDeleted = (
       currentState.own_follows !== undefined
     ) {
       newState.own_follows = currentState.own_follows.filter(
-        (followItem) => followItem.source_feed.fid !== follow.source_feed.fid,
+        (followItem) => followItem.source_feed.feed !== follow.source_feed.feed,
       );
     }
 
     // Only update if followers array already exists
     if (currentState.followers !== undefined) {
       newState.followers = currentState.followers.filter(
-        (followItem) => followItem.source_feed.fid !== follow.source_feed.fid,
+        (followItem) => followItem.source_feed.feed !== follow.source_feed.feed,
       );
     }
   }
@@ -85,7 +85,7 @@ export function handleFollowDeleted(
   const result = updateStateFollowDeleted(
     follow,
     this.currentState,
-    this.fid,
+    this.feed,
     connectedUser?.id,
   );
 

package/src/feed/event-handlers/follow/handle-follow-updated.ts

@@ -1,8 +1,5 @@
 import type { Feed, FeedState } from '../../../feed';
-import {
-  getStateUpdateQueueId,
-  shouldUpdateState,
-} from '../../../utils';
+import { getStateUpdateQueueId, shouldUpdateState } from '../../../utils';
 import { EventPayload, PartializeAllBut } from '../../../types-internal';
 
 export function handleFollowUpdated(
@@ -14,7 +11,7 @@ export function handleFollowUpdated(
 ) {
   const follow = eventOrResponse.follow;
   const connectedUserId = this.client.state.getLatestValue().connected_user?.id;
-  const currentFeedId = this.fid;
+  const currentFeedId = this.feed;
 
   if (
     !shouldUpdateState({
@@ -30,7 +27,7 @@ export function handleFollowUpdated(
     let newState: FeedState | undefined;
 
     // this feed followed someone
-    if (follow.source_feed.fid === currentFeedId) {
+    if (follow.source_feed.feed === currentFeedId) {
       newState ??= {
         ...currentState,
         // Update FeedResponse fields, that has the new follower/following count
@@ -39,7 +36,7 @@ export function handleFollowUpdated(
 
       const index =
         currentState.following?.findIndex(
-          (f) => f.target_feed.fid === follow.target_feed.fid,
+          (f) => f.target_feed.feed === follow.target_feed.feed,
         ) ?? -1;
 
       if (index >= 0) {
@@ -48,7 +45,7 @@ export function handleFollowUpdated(
       }
     } else if (
       // someone followed this feed
-      follow.target_feed.fid === currentFeedId
+      follow.target_feed.feed === currentFeedId
     ) {
       const source = follow.source_feed;
 
@@ -63,7 +60,7 @@ export function handleFollowUpdated(
         currentState.own_follows
       ) {
         const index = currentState.own_follows.findIndex(
-          (f) => f.source_feed.fid === follow.source_feed.fid,
+          (f) => f.source_feed.feed === follow.source_feed.feed,
         );
 
         if (index >= 0) {
@@ -74,7 +71,7 @@ export function handleFollowUpdated(
 
       const index =
         currentState.followers?.findIndex(
-          (f) => f.source_feed.fid === follow.source_feed.fid,
+          (f) => f.source_feed.feed === follow.source_feed.feed,
         ) ?? -1;
 
       if (index >= 0) {

package/src/feed/event-handlers/index.ts

@@ -4,4 +4,5 @@ export * from './feed-member';
 export * from './bookmark';
 export * from './activity';
 export * from './feed';
-export * from './notification-feed';
+export * from './notification-feed';
+export * from './watch';

package/src/feed/event-handlers/watch/handle-watch-started.ts

@@ -0,0 +1,5 @@
+import { Feed } from '../../feed';
+
+export function handleWatchStarted(this: Feed) {
+  this.state.partialNext({ watch: true });
+}

package/src/feed/event-handlers/watch/handle-watch-stopped.ts

@@ -0,0 +1,5 @@
+import { Feed } from '../../feed';
+
+export function handleWatchStopped(this: Feed) {
+  this.state.partialNext({ watch: false });
+}

package/src/feed/event-handlers/watch/index.ts

@@ -0,0 +1,2 @@
+export * from './handle-watch-started';
+export * from './handle-watch-stopped';

package/src/feed/feed.ts

@@ -8,10 +8,10 @@ import {
   ActivityResponse,
   CommentResponse,
   PagerResponse,
-  SingleFollowRequest,
   QueryFeedMembersRequest,
   SortParamRequest,
   ThreadedCommentResponse,
+  FollowRequest,
 } from '../gen/models';
 import { StreamResponse } from '../gen-imports';
 import { StateStore } from '../common/StateStore';
@@ -205,7 +205,7 @@ export class Feed extends FeedApi {
   ) {
     super(client, groupId, id);
     this.state = new StateStore<FeedState>({
-      fid: `${groupId}:${id}`,
+      feed: `${groupId}:${id}`,
       group_id: groupId,
       id,
       ...(data ?? {}),
@@ -219,7 +219,7 @@ export class Feed extends FeedApi {
 
   protected readonly client: FeedsClient;
 
-  get fid() {
+  get feed() {
     return `${this.group}:${this.id}`;
   }
 
@@ -270,7 +270,7 @@ export class Feed extends FeedApi {
         this.stateUpdateQueue.clear();
         const responseCopy: Partial<
           StreamResponse<GetOrCreateFeedResponse>['feed'] &
-            StreamResponse<GetOrCreateFeedResponse>
+            StreamResponse<Omit<GetOrCreateFeedResponse, 'feed'>>
         > = {
           ...response,
           ...response.feed,
@@ -316,24 +316,6 @@ export class Feed extends FeedApi {
     }
   }
 
-  /**
-   * @internal
-   */
-  handleWatchStopped() {
-    this.state.partialNext({
-      watch: false,
-    });
-  }
-
-  /**
-   * @internal
-   */
-  handleWatchStarted() {
-    this.state.partialNext({
-      watch: true,
-    });
-  }
-
   /**
    * Returns index of the provided comment object.
    */
@@ -569,7 +551,7 @@ export class Feed extends FeedApi {
       base: () =>
         this.client.getCommentReplies({
           ...request,
-          comment_id: comment.id,
+          id: comment.id,
           // use known sort first (prevents broken pagination)
           sort,
           next: currentNextCursor,
@@ -623,7 +605,7 @@ export class Feed extends FeedApi {
                   currentState[type],
                   follows,
                   (follow) =>
-                    `${follow.source_feed.fid}-${follow.target_feed.fid}`,
+                    `${follow.source_feed.feed}-${follow.target_feed.feed}`,
                 ),
           [paginationKey]: {
             ...currentState[paginationKey],
@@ -734,7 +716,7 @@ export class Feed extends FeedApi {
    */
   async queryFollowers(request: Omit<QueryFollowsRequest, 'filter'>) {
     const filter: QueryFollowsRequest['filter'] = {
-      target_feed: this.fid,
+      target_feed: this.feed,
     };
 
     const response = await this.client.queryFollows({
@@ -752,7 +734,7 @@ export class Feed extends FeedApi {
    */
   async queryFollowing(request: Omit<QueryFollowsRequest, 'filter'>) {
     const filter: QueryFollowsRequest['filter'] = {
-      source_feed: this.fid,
+      source_feed: this.feed,
     };
 
     const response = await this.client.queryFollows({
@@ -765,13 +747,13 @@ export class Feed extends FeedApi {
 
   async follow(
     feedOrFid: Feed | string,
-    options?: Omit<SingleFollowRequest, 'source' | 'target'>,
+    options?: Omit<FollowRequest, 'source' | 'target'>,
   ) {
-    const fid = typeof feedOrFid === 'string' ? feedOrFid : feedOrFid.fid;
+    const fid = typeof feedOrFid === 'string' ? feedOrFid : feedOrFid.feed;
 
     const response = await this.client.follow({
       ...options,
-      source: this.fid,
+      source: this.feed,
       target: fid,
     });
 
@@ -779,10 +761,10 @@ export class Feed extends FeedApi {
   }
 
   async unfollow(feedOrFid: Feed | string) {
-    const fid = typeof feedOrFid === 'string' ? feedOrFid : feedOrFid.fid;
+    const fid = typeof feedOrFid === 'string' ? feedOrFid : feedOrFid.feed;
 
     const response = await this.client.unfollow({
-      source: this.fid,
+      source: this.feed,
       target: fid,
     });
 
@@ -807,10 +789,10 @@ export class Feed extends FeedApi {
     });
   }
 
-  addActivity(request: Omit<ActivityRequest, 'fids'>) {
+  addActivity(request: Omit<ActivityRequest, 'feeds'>) {
     return this.feedsApi.addActivity({
       ...request,
-      fids: [this.fid],
+      feeds: [this.feed],
     });
   }
 

package/src/feeds-client/event-handlers/index.ts

@@ -0,0 +1 @@
+export * from './user/handle-user-updated';

package/src/feeds-client/event-handlers/user/handle-user-updated.test.ts

@@ -0,0 +1,53 @@
+import { describe, it, beforeEach, expect } from 'vitest';
+
+import { FeedsClient, handleUserUpdated } from '../..';
+import { generateOwnUser, generateUserResponse } from '../../../test-utils';
+import { EventPayload } from '../../../types-internal';
+
+describe('handleUserUpdated', () => {
+  let feedsClient: FeedsClient;
+
+  beforeEach(() => {
+    feedsClient = new FeedsClient('mock-api-key');
+    const connectedUser = generateOwnUser();
+
+    feedsClient.state.partialNext({ connected_user: connectedUser });
+  });
+
+  it('should update the connected user in the state', () => {
+    const stateBefore = feedsClient.state.getLatestValue();
+
+    const event: EventPayload<'user.updated'> = {
+      type: 'user.updated',
+      created_at: new Date(),
+      custom: {},
+      user: {
+        ...generateUserResponse(),
+        ...stateBefore.connected_user!,
+      },
+    };
+
+    handleUserUpdated.call(feedsClient, event);
+
+    const stateAfter = feedsClient.state.getLatestValue();
+
+    expect(stateAfter.connected_user).toMatchObject({ name: event.user.name });
+  });
+
+  it('should not update the connected user if the incoming event contains other user', () => {
+    const event: EventPayload<'user.updated'> = {
+      type: 'user.updated',
+      created_at: new Date(),
+      custom: {},
+      user: generateUserResponse(),
+    };
+
+    const stateBefore = feedsClient.state.getLatestValue();
+
+    handleUserUpdated.call(feedsClient, event);
+
+    const stateAfter = feedsClient.state.getLatestValue();
+
+    expect(stateAfter.connected_user).toBe(stateBefore.connected_user);
+  });
+});

package/src/feeds-client/event-handlers/user/handle-user-updated.ts

@@ -0,0 +1,28 @@
+import type { EventPayload } from '../../../types-internal';
+import type { FeedsClient, FeedsClientState } from '../../feeds-client';
+
+export function handleUserUpdated(
+  this: FeedsClient,
+  event: EventPayload<'user.updated'>,
+) {
+  this.state.next((currentState) => {
+    let newState: FeedsClientState | undefined;
+
+    const { connected_user } = currentState;
+
+    if (connected_user && connected_user.id === event.user.id) {
+      newState ??= {
+        ...currentState,
+      };
+
+      newState.connected_user = {
+        ...connected_user,
+        ...event.user,
+      };
+    }
+
+    // TODO: update other users in user map (if/once applicable)
+
+    return newState ?? currentState;
+  });
+}