@stream-io/feeds-client 0.1.10 → 0.2.0

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

@@ -0,0 +1,76 @@
+import type { Feed } from '../../../feed';
+import type {
+  ActivityResponse,
+  BookmarkUpdatedEvent,
+} from '../../../gen/models';
+import type { EventPayload, UpdateStateResult } from '../../../types-internal';
+
+import { updateActivityInState } from '../activity';
+import { isSameBookmark } from './handle-bookmark-deleted';
+
+export const updateBookmarkInActivity = (
+  event: BookmarkUpdatedEvent,
+  activity: ActivityResponse,
+  isCurrentUser: boolean,
+): UpdateStateResult<ActivityResponse> => {
+  // Update own_bookmarks if the bookmark is from the current user
+  let ownBookmarks = activity.own_bookmarks || [];
+  if (isCurrentUser) {
+    const bookmarkIndex = ownBookmarks.findIndex((bookmark) =>
+      isSameBookmark(bookmark, event.bookmark),
+    );
+    if (bookmarkIndex !== -1) {
+      ownBookmarks = [...ownBookmarks];
+      ownBookmarks[bookmarkIndex] = event.bookmark;
+    }
+  }
+
+  return {
+    ...activity,
+    own_bookmarks: ownBookmarks,
+    changed: true,
+  };
+};
+
+export const updateBookmarkInActivities = (
+  event: BookmarkUpdatedEvent,
+  activities: ActivityResponse[] | undefined,
+  isCurrentUser: boolean,
+): UpdateStateResult<{ activities: ActivityResponse[] }> => {
+  if (!activities) {
+    return { changed: false, activities: [] };
+  }
+
+  const activityIndex = activities.findIndex(
+    (a) => a.id === event.bookmark.activity.id,
+  );
+  if (activityIndex === -1) {
+    return { changed: false, activities };
+  }
+
+  const activity = activities[activityIndex];
+  const updatedActivity = updateBookmarkInActivity(
+    event,
+    activity,
+    isCurrentUser,
+  );
+  return updateActivityInState(updatedActivity, activities, true);
+};
+
+export function handleBookmarkUpdated(
+  this: Feed,
+  event: EventPayload<'feeds.bookmark.updated'>,
+) {
+  const currentActivities = this.currentState.activities;
+  const { connected_user: connectedUser } = this.client.state.getLatestValue();
+  const isCurrentUser = event.bookmark.user.id === connectedUser?.id;
+
+  const result = updateBookmarkInActivities(
+    event,
+    currentActivities,
+    isCurrentUser,
+  );
+  if (result.changed) {
+    this.state.partialNext({ activities: result.activities });
+  }
+}

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

@@ -0,0 +1,3 @@
+export * from './handle-bookmark-added';
+export * from './handle-bookmark-deleted';
+export * from './handle-bookmark-updated';

package/src/feed/event-handlers/comment/handle-comment-added.ts

@@ -0,0 +1,38 @@
+import type { Feed } from '../../../feed';
+import type { EventPayload } from '../../../types-internal';
+
+export function handleCommentAdded(
+  this: Feed,
+  event: EventPayload<'feeds.comment.added'>,
+) {
+  const { comment } = event;
+  const entityId = comment.parent_id ?? comment.object_id;
+
+  this.state.next((currentState) => {
+    const entityState = currentState.comments_by_entity_id[entityId];
+
+    if (typeof entityState?.comments === 'undefined') {
+      return currentState;
+    }
+
+    const newComments = entityState?.comments ? [...entityState.comments] : [];
+
+    if (entityState.pagination?.sort === 'last') {
+      newComments.unshift(comment);
+    } else {
+      // 'first' and other sort options
+      newComments.push(comment);
+    }
+
+    return {
+      ...currentState,
+      comments_by_entity_id: {
+        ...currentState.comments_by_entity_id,
+        [entityId]: {
+          ...currentState.comments_by_entity_id[entityId],
+          comments: newComments,
+        },
+      },
+    };
+  });
+}

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

@@ -0,0 +1,35 @@
+import { Feed } from '../../../feed';
+import { EventPayload } from '../../../types-internal';
+
+export function handleCommentDeleted(
+  this: Feed,
+  { comment }: EventPayload<'feeds.comment.deleted'>,
+) {
+  const entityId = comment.parent_id ?? comment.object_id;
+
+  this.state.next((currentState) => {
+    const newCommentsByEntityId = {
+      ...currentState.comments_by_entity_id,
+      [entityId]: {
+        ...currentState.comments_by_entity_id[entityId],
+      },
+    };
+
+    const index = this.getCommentIndex(comment, currentState);
+
+    if (newCommentsByEntityId?.[entityId]?.comments?.length && index !== -1) {
+      newCommentsByEntityId[entityId].comments = [
+        ...newCommentsByEntityId[entityId].comments,
+      ];
+
+      newCommentsByEntityId[entityId]?.comments?.splice(index, 1);
+    }
+
+    delete newCommentsByEntityId[comment.id];
+
+    return {
+      ...currentState,
+      comments_by_entity_id: newCommentsByEntityId,
+    };
+  });
+}

package/src/feed/event-handlers/comment/handle-comment-reaction.ts

@@ -0,0 +1,61 @@
+import { Feed } from '../../../feed';
+import { CommentResponse } from '../../../gen/models';
+import { EventPayload } from '../../../types-internal';
+
+export function handleCommentReaction(
+  this: Feed,
+  event: EventPayload<
+    'feeds.comment.reaction.added' | 'feeds.comment.reaction.deleted'
+  >,
+) {
+  const { comment, reaction } = event;
+  const connectedUser = this.client.state.getLatestValue().connected_user;
+
+  this.state.next((currentState) => {
+    const forId = comment.parent_id ?? comment.object_id;
+    const entityState = currentState.comments_by_entity_id[forId];
+
+    const commentIndex = this.getCommentIndex(comment, currentState);
+
+    if (commentIndex === -1) return currentState;
+
+    const newComments = entityState?.comments?.concat([]) ?? [];
+
+    const commentCopy: Partial<CommentResponse> = { ...comment };
+
+    delete commentCopy.own_reactions;
+
+    const newComment: CommentResponse = {
+      ...newComments[commentIndex],
+      ...commentCopy,
+      // TODO: FIXME this should be handled by the backend
+      latest_reactions: commentCopy.latest_reactions ?? [],
+      reaction_groups: commentCopy.reaction_groups ?? {},
+    };
+
+    newComments[commentIndex] = newComment;
+
+    if (reaction.user.id === connectedUser?.id) {
+      if (event.type === 'feeds.comment.reaction.added') {
+        newComment.own_reactions = newComment.own_reactions.concat(
+          reaction,
+        ) ?? [reaction];
+      } else if (event.type === 'feeds.comment.reaction.deleted') {
+        newComment.own_reactions = newComment.own_reactions.filter(
+          (r) => r.type !== reaction.type,
+        );
+      }
+    }
+
+    return {
+      ...currentState,
+      comments_by_entity_id: {
+        ...currentState.comments_by_entity_id,
+        [forId]: {
+          ...entityState,
+          comments: newComments,
+        },
+      },
+    };
+  });
+}

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

@@ -0,0 +1,35 @@
+import { Feed } from '../../../feed';
+import { EventPayload } from '../../../types-internal';
+
+export function handleCommentUpdated(
+  this: Feed,
+  event: EventPayload<'feeds.comment.updated'>,
+) {
+  const { comment } = event;
+  const entityId = comment.parent_id ?? comment.object_id;
+
+  this.state.next((currentState) => {
+    const entityState = currentState.comments_by_entity_id[entityId];
+
+    if (!entityState?.comments?.length) return currentState;
+
+    const index = this.getCommentIndex(comment, currentState);
+
+    if (index === -1) return currentState;
+
+    const newComments = [...entityState.comments];
+
+    newComments[index] = comment;
+
+    return {
+      ...currentState,
+      comments_by_entity_id: {
+        ...currentState.comments_by_entity_id,
+        [entityId]: {
+          ...currentState.comments_by_entity_id[entityId],
+          comments: newComments,
+        },
+      },
+    };
+  });
+}

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

@@ -0,0 +1,4 @@
+export * from './handle-comment-added';
+export * from './handle-comment-deleted';
+export * from './handle-comment-updated';
+export * from './handle-comment-reaction';

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

@@ -0,0 +1,9 @@
+import { Feed } from '../../../feed';
+import { EventPayload } from '../../../types-internal';
+
+export function handleFeedUpdated(
+  this: Feed,
+  event: EventPayload<'feeds.feed.updated'>,
+) {
+  this.state.partialNext({ ...event.feed });
+}

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

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

package/src/feed/event-handlers/feed-member/handle-feed-member-added.ts

@@ -0,0 +1,31 @@
+import { Feed, FeedState } from '../../../feed';
+import { EventPayload } from '../../../types-internal';
+
+export function handleFeedMemberAdded(
+  this: Feed,
+  event: EventPayload<'feeds.feed_member.added'>,
+) {
+  const { connected_user: connectedUser } = this.client.state.getLatestValue();
+
+  this.state.next((currentState) => {
+    let newState: FeedState | undefined;
+
+    if (typeof currentState.members !== 'undefined') {
+      newState ??= {
+        ...currentState,
+      };
+
+      newState.members = [event.member, ...currentState.members];
+    }
+
+    if (connectedUser?.id === event.member.user.id) {
+      newState ??= {
+        ...currentState,
+      };
+
+      newState.own_membership = event.member;
+    }
+
+    return newState ?? currentState;
+  });
+}

package/src/feed/event-handlers/feed-member/handle-feed-member-removed.ts

@@ -0,0 +1,24 @@
+import { Feed } from '../../../feed';
+import { EventPayload } from '../../../types-internal';
+
+export function handleFeedMemberRemoved(
+  this: Feed,
+  event: EventPayload<'feeds.feed_member.removed'>,
+) {
+  const { connected_user: connectedUser } = this.client.state.getLatestValue();
+
+  this.state.next((currentState) => {
+    const newState = {
+      ...currentState,
+      members: currentState.members?.filter(
+        (member) => member.user.id !== event.user?.id,
+      ),
+    };
+
+    if (connectedUser?.id === event.member_id) {
+      delete newState.own_membership;
+    }
+
+    return newState;
+  });
+}

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

@@ -0,0 +1,40 @@
+import { Feed, FeedState } from '../../../feed';
+import { EventPayload } from '../../../types-internal';
+
+export function handleFeedMemberUpdated(
+  this: Feed,
+  event: EventPayload<'feeds.feed_member.updated'>,
+) {
+  const { connected_user: connectedUser } = this.client.state.getLatestValue();
+
+  this.state.next((currentState) => {
+    const memberIndex =
+      currentState.members?.findIndex(
+        (member) => member.user.id === event.member.user.id,
+      ) ?? -1;
+
+    let newState: FeedState | undefined;
+
+    if (memberIndex !== -1) {
+      // if there's an index, there's a member to update
+      const newMembers = [...currentState.members!];
+      newMembers[memberIndex] = event.member;
+
+      newState ??= {
+        ...currentState,
+      };
+
+      newState.members = newMembers;
+    }
+
+    if (connectedUser?.id === event.member.user.id) {
+      newState ??= {
+        ...currentState,
+      };
+
+      newState.own_membership = event.member;
+    }
+
+    return newState ?? currentState;
+  });
+}

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

@@ -0,0 +1,3 @@
+export * from './handle-feed-member-added';
+export * from './handle-feed-member-updated';
+export * from './handle-feed-member-removed';

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

@@ -0,0 +1,250 @@
+import {
+  FeedResponse,
+  FollowResponse,
+  UserResponse,
+} from '../../../gen/models';
+import { generateFollowResponse } from '../../../test-utils';
+import { updateStateFollowCreated } from './handle-follow-created';
+
+import { describe, it, expect, beforeEach } from 'vitest';
+
+describe('handle-follow-created', () => {
+  describe(updateStateFollowCreated.name, () => {
+    let mockFollow: FollowResponse;
+    let mockFeed: FeedResponse;
+    let mockUser: UserResponse;
+
+    beforeEach(() => {
+      mockFollow = generateFollowResponse();
+      mockFeed = mockFollow.source_feed;
+      mockUser = mockFeed.created_by;
+    });
+
+    it('should return unchanged state for non-accepted follows', () => {
+      const follow: FollowResponse = {
+        ...mockFollow,
+        status: 'pending',
+      };
+
+      // @ts-expect-error - we're not testing the full state here
+      const currentState: FeedState = {
+        followers: [],
+        following: [],
+      };
+
+      const result = updateStateFollowCreated(
+        follow,
+        currentState,
+        'user:feed-1',
+        'user-1',
+      );
+
+      expect(result.changed).toBe(false);
+    });
+
+    it('should handle when this feed follows someone', () => {
+      const follow: FollowResponse = {
+        ...mockFollow,
+        source_feed: {
+          ...mockFeed,
+          id: 'feed-x',
+          feed: 'user:feed-x',
+          created_by: {
+            ...mockUser,
+            id: 'user-x',
+          },
+          following_count: 1,
+        },
+        target_feed: {
+          ...mockFeed,
+          id: 'other-feed',
+          feed: 'user:other-feed',
+          created_by: mockUser,
+        },
+      };
+
+      // @ts-expect-error - we're not testing the full state here
+      const currentState: FeedState = {
+        following: [],
+        following_count: 0,
+      };
+
+      const result = updateStateFollowCreated(
+        follow,
+        currentState,
+        'user:feed-x',
+        'user-1',
+      );
+
+      expect(result.changed).toBe(true);
+      expect(result.data.following).toHaveLength(1);
+      expect(result.data.following?.[0]).toEqual(follow);
+      expect(result.data).toMatchObject(follow.source_feed);
+      expect(result.data.own_follows).toBeUndefined();
+      expect(result.data.following_count).toEqual(1);
+    });
+
+    it('should handle when someone follows this feed', () => {
+      const follow: FollowResponse = {
+        ...mockFollow,
+        source_feed: {
+          ...mockFeed,
+          id: 'other-feed',
+          feed: 'user:other-feed',
+          created_by: {
+            ...mockUser,
+            id: 'other-user',
+          },
+        },
+        target_feed: {
+          ...mockFeed,
+          id: 'feed-1',
+          feed: 'user:feed-1',
+          created_by: mockUser,
+          follower_count: 1,
+        },
+      };
+
+      // @ts-expect-error - we're not testing the full state here
+      const currentState: FeedState = {
+        followers: [],
+        follower_count: 0,
+      };
+
+      const result = updateStateFollowCreated(
+        follow,
+        currentState,
+        'user:feed-1',
+        'user-1',
+      );
+
+      expect(result.changed).toBe(true);
+      expect(result.data.followers).toHaveLength(1);
+      expect(result.data.followers?.[0]).toEqual(follow);
+      expect(result.data).toMatchObject(follow.target_feed);
+      expect(result.data.own_follows).toBeUndefined();
+      expect(result.data.follower_count).toEqual(1);
+    });
+
+    it('should add to own_follows when connected user is the source', () => {
+      const follow: FollowResponse = {
+        ...mockFollow,
+        source_feed: {
+          ...mockFeed,
+          id: 'feed-1',
+          feed: 'user:feed-1',
+          created_by: { ...mockUser, id: 'user-1' },
+        },
+        target_feed: {
+          ...mockFeed,
+          id: 'feed-x',
+          feed: 'user:feed-x',
+          created_by: {
+            ...mockUser,
+            id: 'user-x',
+          },
+        },
+      };
+
+      // @ts-expect-error - we're not testing the full state here
+      const currentState: FeedState = {
+        followers: [],
+        own_follows: [],
+      };
+
+      const result = updateStateFollowCreated(
+        follow,
+        currentState,
+        'user:feed-x',
+        'user-1',
+      );
+
+      expect(result.changed).toBe(true);
+      expect(result.data.own_follows).toHaveLength(1);
+      expect(result.data.own_follows?.[0]).toEqual(follow);
+    });
+
+    it('should not update followers/following when they are undefined', () => {
+      const follow: FollowResponse = {
+        ...mockFollow,
+        source_feed: {
+          ...mockFeed,
+          id: 'other-feed',
+          feed: 'user:other-feed',
+          created_by: mockUser,
+        },
+        target_feed: {
+          ...mockFeed,
+          id: 'feed-1',
+          feed: 'user:feed-1',
+          created_by: mockUser,
+        },
+      };
+
+      // @ts-expect-error - we're not testing the full state here
+      const currentState: FeedState = {
+        followers: undefined,
+        following: undefined,
+        own_follows: undefined,
+      };
+
+      const result = updateStateFollowCreated(
+        follow,
+        currentState,
+        'user:feed-1',
+        'user-1',
+      );
+
+      expect(result.changed).toBe(true);
+      expect(result.data.followers).toBeUndefined();
+      expect(result.data).toMatchObject(follow.target_feed);
+    });
+
+    it('should add new followers to the top of existing arrays', () => {
+      const existingFollow: FollowResponse = {
+        ...mockFollow,
+        source_feed: {
+          ...mockFeed,
+          id: 'existing-feed',
+          feed: 'user:existing-feed',
+          created_by: mockUser,
+        },
+      };
+
+      const follow: FollowResponse = {
+        ...mockFollow,
+        source_feed: {
+          ...mockFeed,
+          id: 'other-feed',
+          feed: 'user:other-feed',
+          created_by: mockUser,
+        },
+        target_feed: {
+          ...mockFeed,
+          id: 'feed-1',
+          feed: 'user:feed-1',
+          created_by: mockUser,
+        },
+      };
+
+      // @ts-expect-error - we're not testing the full state here
+      const currentState: FeedState = {
+        followers: [existingFollow],
+        following: undefined,
+        own_follows: undefined,
+      };
+
+      const result = updateStateFollowCreated(
+        follow,
+        currentState,
+        'user:feed-1',
+        'user-1',
+      );
+
+      expect(result.changed).toBe(true);
+      expect(result.data.followers).toHaveLength(2);
+      expect(result.data.followers?.[0]).toEqual(follow);
+      expect(result.data.followers?.[1]).toEqual(existingFollow);
+    });
+  });
+});