@amityco/ts-sdk 0.0.1-beta.36 → 0.0.1-beta.38

package/src/comment/observers/liveComment.ts

@@ -0,0 +1,43 @@
+import { liveObject } from '~/utils/liveObject';
+import { getComment } from '../api';
+import {
+  onCommentDeleted,
+  onCommentFlagged,
+  onCommentReactionAdded,
+  onCommentReactionRemoved,
+  onCommentUnflagged,
+  onCommentUpdated,
+} from '../events';
+
+/**
+ * ```js
+ * import { liveComment } from '@amityco/ts-sdk';
+ *
+ * let comment;
+ *
+ * const unsubscribe = liveComment(commentId, response => {
+ *   comment = response.data;
+ * });
+ * ```
+ *
+ * Observe all mutation on a given {@link Amity.Comment}
+ *
+ * @param commentId the ID of the comment to observe
+ * @param callback the function to call when new data are available
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the comment
+ *
+ * @category Comment Live Object
+ */
+export const liveComment = (
+  commentId: Amity.Comment['commentId'],
+  callback: Amity.LiveObjectCallback<Amity.Comment>,
+): Amity.Unsubscriber => {
+  return liveObject(commentId, callback, 'commentId', getComment, [
+    onCommentDeleted,
+    onCommentFlagged,
+    onCommentReactionAdded,
+    onCommentReactionRemoved,
+    onCommentUnflagged,
+    onCommentUpdated,
+  ]);
+};

package/src/comment/observers/tests/liveComment.test.ts

@@ -0,0 +1,95 @@
+import { disableCache, enableCache } from '~/cache/api';
+import {
+  pause,
+  client,
+  connectClient,
+  disconnectClient,
+  generateComment,
+  user12,
+} from '~/utils/tests';
+import { getFutureDate } from '~/core/model';
+import { liveComment } from '../liveComment';
+
+describe('liveComment', () => {
+  const comment = generateComment();
+  const response = { data: { comments: [comment] } };
+
+  beforeAll(async () => {
+    await connectClient();
+  });
+
+  afterAll(async () => {
+    await disconnectClient();
+  });
+
+  beforeEach(enableCache);
+
+  afterEach(disableCache);
+
+  const events: [string, keyof Amity.MqttCommentEvents][] = [
+    ['should get update on comment.updated event', 'comment.updated'],
+    ['should get update on comment.deleted event', 'comment.deleted'],
+    ['should get update on comment.flagged event', 'comment.flagged'],
+    ['should get update on comment.unflagged event', 'comment.unflagged'],
+  ];
+
+  test.each(events)('%s', async (test, event) => {
+    const update = {
+      ...comment,
+      data: { text: 'new-text' },
+      updatedAt: getFutureDate(comment.updatedAt),
+    };
+
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue(response);
+
+    liveComment(comment.commentId, callback);
+    await pause();
+    client.emitter.emit(event, { comments: [update] });
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(3);
+    expect(callback).toHaveBeenNthCalledWith(
+      3,
+      expect.objectContaining({
+        data: update,
+        loading: false,
+      }),
+    );
+  });
+
+  test.each([
+    ['should get update on comment.addReaction event', 'comment.addReaction'],
+    ['should get update on comment.removeReaction event', 'comment.removeReaction'],
+  ] as [string, keyof Amity.MqttCommentEvents][])('%s', async (test, event) => {
+    const update = {
+      ...comment,
+      data: { text: 'new-text' },
+      updatedAt: getFutureDate(comment.updatedAt),
+    };
+    const reactor: Amity.Reaction = {
+      createdAt: getFutureDate(comment.updatedAt),
+      reactionId: 'like',
+      reactionName: 'like',
+      referenceId: comment.commentId,
+      referenceType: 'comment',
+      userId: user12.userId,
+    };
+    const callback = jest.fn();
+    client.http.get = jest.fn().mockResolvedValue(response);
+
+    liveComment(comment.commentId, callback);
+    await pause();
+    client.emitter.emit(event, { comments: [update], reactor });
+    await pause();
+
+    expect(callback).toHaveBeenCalledTimes(3);
+    expect(callback).toHaveBeenNthCalledWith(
+      3,
+      expect.objectContaining({
+        data: update,
+        loading: false,
+      }),
+    );
+  });
+});

package/src/community/api/queryCommunities.ts

@@ -22,16 +22,9 @@ import { unpackCommunityPayload } from '../utils';
  * @category Community API
  * @async
  */
-export const queryCommunities = async (query?: {
-  displayName?: string;
-  membership?: 'all' | 'member' | 'notMember';
-  categoryId?: Amity.Category['categoryId'];
-  isDeleted?: Amity.Community['isDeleted'];
-  hasFlag?: boolean;
-  tags?: Amity.Taggable['tags'];
-  sortBy?: 'displayName' | 'firstCreated' | 'lastCreated';
-  page?: Amity.Page;
-}): Promise<Amity.Cached<Amity.Paged<Amity.Community>>> => {
+export const queryCommunities = async (
+  query?: Amity.QueryCommunities,
+): Promise<Amity.Cached<Amity.Paged<Amity.Community>>> => {
   const client = getActiveClient();
   client.log('channel/queryCommunities', query);
 

package/src/community/api/test/addCommunityMember.test.ts

@@ -1,7 +1,14 @@
 import { disableCache, enableCache, pullFromCache } from '~/cache/api';
 import { getResolver } from '~/core/model';
 
-import { client, community11, communityUser11, user11 } from '~/utils/tests';
+import {
+  client,
+  connectClient,
+  disconnectClient,
+  community11,
+  communityUser11,
+  user11,
+} from '~/utils/tests';
 
 import { onCommunityUserAdded } from '../../events';
 import { addCommunityMembers } from '../addCommunityMembers';
@@ -21,6 +28,9 @@ const resolvedPostValue = {
 };
 
 describe('addCommunityMembers', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
   test('should return true value', async () => {
     client.http.post = jest.fn().mockResolvedValue(resolvedPostValue);
 
@@ -66,6 +76,8 @@ describe('addCommunityMembers', () => {
 
     await addCommunityMembers(communityToAddUserTo.communityId, [userToAdd.userId]);
 
-    await expect(callback).resolves.toEqual(expect.objectContaining(communityToAddUserTo));
+    await expect(callback).resolves.toEqual(
+      expect.objectContaining({ ...communityToAddUserTo, isJoined: true }),
+    );
   });
 });

package/src/community/api/test/joinCommunity.test.ts

@@ -1,7 +1,14 @@
 import { disableCache, enableCache, pullFromCache } from '~/cache/api';
 import { getResolver } from '~/core/model';
 
-import { client, community11, communityUser11, user11 } from '~/utils/tests';
+import {
+  client,
+  connectClient,
+  disconnectClient,
+  community11,
+  communityUser11,
+  user11,
+} from '~/utils/tests';
 
 import { onCommunityJoined } from '../../events';
 import { joinCommunity } from '../joinCommunity';
@@ -21,6 +28,9 @@ const resolvedPostValue = {
 };
 
 describe('joinCommunity', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
   test('should return true value', async () => {
     client.http.post = jest.fn().mockResolvedValue(resolvedPostValue);
 
@@ -65,6 +75,8 @@ describe('joinCommunity', () => {
 
     await joinCommunity(communityToJoin.communityId);
 
-    await expect(callback).resolves.toEqual(expect.objectContaining(communityToJoin));
+    await expect(callback).resolves.toEqual(
+      expect.objectContaining({ ...communityToJoin, isJoined: true }),
+    );
   });
 });

package/src/community/api/test/leaveCommunity.test.ts

@@ -1,6 +1,13 @@
 import { disableCache, enableCache, pullFromCache, pushToCache } from '~/cache/api';
 import { getResolver } from '~/core/model';
-import { client, community11, communityUser11, user11 } from '~/utils/tests';
+import {
+  client,
+  connectClient,
+  disconnectClient,
+  community11,
+  communityUser11,
+  user11,
+} from '~/utils/tests';
 
 import { leaveCommunity } from '../leaveCommunity';
 import { onCommunityLeft } from '../../events';
@@ -21,6 +28,9 @@ const resolvedDeleteValue = {
 };
 
 describe('leaveCommunity', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
   test('should return true value', async () => {
     client.http.delete = jest.fn().mockResolvedValueOnce(resolvedDeleteValue);
 

package/src/community/api/test/removeCommunityMembers.test.ts

@@ -1,7 +1,14 @@
 import { disableCache, enableCache, pullFromCache } from '~/cache/api';
 import { getResolver } from '~/core/model';
 
-import { client, community11, communityUser11, user11 } from '~/utils/tests';
+import {
+  client,
+  community11,
+  communityUser11,
+  user11,
+  connectClient,
+  disconnectClient,
+} from '~/utils/tests';
 
 import { onCommunityUserRemoved } from '../../events';
 import { removeCommunityMembers } from '../removeCommunityMembers';
@@ -22,6 +29,9 @@ const resolvedDeleteValue = {
 };
 
 describe('removeCommunityMembers', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
   test('should return true value', async () => {
     client.http.delete = jest.fn().mockResolvedValue(resolvedDeleteValue);
 

package/src/community/events/index.ts

@@ -7,5 +7,6 @@ export * from './onCommunityLeft';
 
 export * from './onCommunityUserAdded';
 export * from './onCommunityUserRemoved';
+export * from './onCommunityUserChanged';
 export * from './onCommunityUserBanned';
 export * from './onCommunityUserUnbanned';

package/src/community/events/onCommunityUserChanged.ts

@@ -0,0 +1,20 @@
+import { createCommunityMemberEventSubscriber } from './utils';
+
+/**
+ * ```js
+ * import { onCommunityUserChanged } from '@amityco/ts-sdk'
+ * const dispose = onCommunityUserChanged((community, member) => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a user has been added or removed from a {@link Amity.Community}
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Community Events
+ */
+export const onCommunityUserChanged = (
+  callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void,
+) => createCommunityMemberEventSubscriber('community.userChanged', callback);

package/src/community/events/test/onCommunityJoined.test.ts

@@ -35,7 +35,7 @@ describe('onCommunityJoined', () => {
     unsub();
 
     expect(callback).toHaveBeenCalled();
-    expect(callback).toHaveBeenCalledWith(communityToJoin, joinedUser);
+    expect(callback).toHaveBeenCalledWith({ ...communityToJoin, isJoined: true }, joinedUser);
   });
 
   test('it should got nothing if we did unsubscribe before got event', () => {

package/src/community/events/test/onCommunityUserAdded.test.ts

@@ -35,7 +35,7 @@ describe('onCommunityUserAdded', () => {
     unsub();
 
     expect(callback).toHaveBeenCalled();
-    expect(callback).toHaveBeenCalledWith(communityToAddUserTo, userToAdd);
+    expect(callback).toHaveBeenCalledWith({ ...communityToAddUserTo, isJoined: true }, userToAdd);
   });
 
   test('it should got nothing if we did unsubscribe before got event', () => {

package/src/community/events/test/onCommunityUserBanned.test.ts

@@ -35,7 +35,7 @@ describe('onCommunityUserBanned', () => {
     unsub();
 
     expect(callback).toHaveBeenCalled();
-    expect(callback).toHaveBeenCalledWith(community, banedUser);
+    expect(callback).toHaveBeenCalledWith({ ...community, isJoined: true }, banedUser);
   });
 
   test('it should got nothing if we did unsubscribe before got event', () => {

package/src/community/events/test/onCommunityUserUnbaned.test.ts

@@ -35,7 +35,7 @@ describe('onCommunityUserUnbanned', () => {
     unsub();
 
     expect(callback).toHaveBeenCalled();
-    expect(callback).toHaveBeenCalledWith(community, unbannedUser);
+    expect(callback).toHaveBeenCalledWith({ ...community, isJoined: true }, unbannedUser);
   });
 
   test('it should got nothing if we did unsubscribe before got event', () => {

package/src/community/events/test/utils.test.ts

@@ -10,7 +10,11 @@ import {
   user11,
 } from '~/utils/tests';
 
-import { createCommunityEventSubscriber, createCommunityMemberEventSubscriber } from '../utils';
+import {
+  createCommunityEventSubscriber,
+  createCommunityMemberEventSubscriber,
+  updateMembershipStatus,
+} from '../utils';
 
 const event = 'community.created';
 const communityToCreate = community11;
@@ -115,7 +119,7 @@ describe('createCommunityMemberEventSubscriber', () => {
     unsub();
 
     expect(callback).toHaveBeenCalled();
-    expect(callback).toHaveBeenCalledWith(communityToAddUser, addedUser);
+    expect(callback).toHaveBeenCalledWith({ ...communityToAddUser, isJoined: true }, addedUser);
   });
 
   test('it should trigger callback with correctly params when cache is enabled', () => {
@@ -128,7 +132,7 @@ describe('createCommunityMemberEventSubscriber', () => {
     unsub();
 
     expect(callback).toHaveBeenCalled();
-    expect(callback).toHaveBeenCalledWith(communityToAddUser, addedUser);
+    expect(callback).toHaveBeenCalledWith({ ...communityToCreate, isJoined: true }, addedUser);
 
     disableCache();
   });
@@ -156,3 +160,48 @@ describe('createCommunityMemberEventSubscriber', () => {
     disableCache();
   });
 });
+
+describe('updateMembershipStatus', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  const communities = [
+    {
+      communityId: 'test-membership',
+    } as Amity.Community,
+  ];
+
+  const getCommunityUsers = (membership = 'member') => [
+    {
+      communityId: 'test-membership',
+      communityMembership: membership,
+      userId: client?.userId || 'test',
+    } as Amity.Membership<'community'>,
+    {
+      communityId: 'test-membership',
+      communityMembership: 'member',
+      userId: 'some-other-user',
+    } as Amity.Membership<'community'>,
+  ];
+
+  test('it should update isJoined status to true if membership member', () => {
+    const expected = { ...communities[0], isJoined: true };
+    const recieved = updateMembershipStatus(communities, getCommunityUsers())[0];
+
+    expect(recieved).toStrictEqual(expected);
+  });
+
+  test('it should update isJoined status to true if membership banned', () => {
+    const expected = { ...communities[0], isJoined: true };
+    const recieved = updateMembershipStatus(communities, getCommunityUsers('banned'))[0];
+
+    expect(recieved).toStrictEqual(expected);
+  });
+
+  test('it should update isJoined status to false if membership none', () => {
+    const expected = { ...communities[0], isJoined: false };
+    const recieved = updateMembershipStatus(communities, getCommunityUsers('none'))[0];
+
+    expect(recieved).toStrictEqual(expected);
+  });
+});

package/src/community/events/utils.ts

@@ -1,4 +1,5 @@
 import { getActiveClient } from '~/client/api';
+import { getActiveUser } from '~/client/api/activeUser';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { createEventSubscriber } from '~/core/events';
 import { pullFromCache } from '~/cache/api';
@@ -35,6 +36,43 @@ export const createCommunityEventSubscriber = (
   return createEventSubscriber(client, event, event, filter);
 };
 
+/*
+ * verifies membership status
+ */
+function isMember(membership: Amity.Membership<'community'>['communityMembership']): boolean {
+  return membership !== 'none';
+}
+
+/*
+ * checks if currently logged in user is part of the community
+ */
+function isCurrentUserPartOfCommunity(
+  c: Amity.Community,
+  m: Amity.Membership<'community'>,
+): boolean {
+  const { userId } = getActiveUser();
+
+  return c.communityId === m.communityId && m.userId === userId;
+}
+
+/*
+ * For mqtt events server will not send user specific data as it's broadcasted
+ * to multiple users. Althought this can be calculated, it's not scalable. Hence
+ * the client SDK needs to calculate this info
+ */
+export function updateMembershipStatus(
+  communities: Amity.Community[],
+  communityUsers: Amity.Membership<'community'>[],
+): Amity.Community[] {
+  return communities.map(c => {
+    const isJoined = communityUsers.some(
+      m => isCurrentUserPartOfCommunity(c, m) && isMember(m.communityMembership),
+    );
+
+    return { ...c, isJoined };
+  });
+}
+
 function hasPermission(
   member: Amity.Membership<'community'>,
   payload: {
@@ -88,7 +126,18 @@ export const createCommunityMemberEventSubscriber = (
 
   const filter = (payload: Amity.CommunityMembershipPayload) => {
     const communityPayload = unpackCommunityPayload(payload);
+    const { communities } = communityPayload;
+
     const preparedPayload = prepareMembershipPayload(communityPayload, 'communityUsers');
+    const { communityUsers } = preparedPayload;
+
+    /*
+     * community.isJoined is not part of the communityMembership payload, and needs
+     * to be calculated based on the communityMembership value
+     */
+    const communitiesWithMembership = updateMembershipStatus(communities, communityUsers);
+
+    preparedPayload.communities = communitiesWithMembership;
 
     if (!client.cache) {
       // TODO: here we are missing specific properties here!

package/src/community/observers/index.ts

@@ -1 +1,2 @@
 export * from './observeCommunity';
+export * from './liveCommunities';