@amityco/ts-sdk 0.0.1-beta.39 → 0.0.1-beta.40

package/src/comment/api/tests/createComment.test.ts

@@ -1,19 +1,64 @@
-import { createComment } from '../createComment';
 import { getActiveClient } from '~/client/api';
 import {
   client,
   connectClient,
   disconnectClient,
   comment11,
+  imageComment11,
+  textImageComment11,
+  textMentionComment11,
+  textWithParentComment11,
   post11,
-  commentPayload,
+  textCommentPayload,
+  imageCommentPayload,
+  textImageCommentPayload,
+  textCommentMentionPayload,
+  textCommentParentIdPayload,
+  file11,
+  user11,
+  user12,
+  post12,
 } from '~/utils/tests';
+import { ASCApiError } from '~/core/errors';
+import { createComment } from '../createComment';
 
-const createCommentResponse = {
+const createTextCommentResponse = {
   data: {
-    ...commentPayload,
+    ...textCommentPayload,
+    files: [],
+    commentChildren: [],
+  },
+};
+
+const createImageCommentResponse = {
+  data: {
+    ...imageCommentPayload,
+    files: [],
     commentChildren: [],
+  },
+};
+
+const createTextImageCommentResponse = {
+  data: {
+    ...textImageCommentPayload,
     files: [],
+    commentChildren: [],
+  },
+};
+
+const createTextMentionCommentResponse = {
+  data: {
+    ...textCommentMentionPayload,
+    files: [],
+    commentChildren: [],
+  },
+};
+
+const createTextCommentParentIdResponse = {
+  data: {
+    ...textCommentParentIdPayload,
+    files: [],
+    commentChildren: [],
   },
 };
 
@@ -22,12 +67,60 @@ const getPostResponse = {
   cachedAt: 1673337034544,
 };
 
-const bundle: Parameters<typeof createComment>[0] = {
+const textCommentRequestPayload: Parameters<typeof createComment>[0] = {
+  referenceId: post11.postId,
+  referenceType: 'post',
+  data: {
+    text: 'test',
+  },
+};
+
+const textCommentParentIdRequestPayload: Parameters<typeof createComment>[0] = {
+  referenceId: post11.postId,
+  referenceType: 'post',
+  parentId: post12.postId,
+  data: {
+    text: 'test',
+  },
+};
+
+const imageCommentRequestPayload: Parameters<typeof createComment>[0] = {
+  referenceId: post11.postId,
+  referenceType: 'post',
+  attachments: [
+    {
+      type: 'image',
+      fileId: file11.fileId,
+    },
+  ],
+};
+
+const textImageCommentRequestPayload: Parameters<typeof createComment>[0] = {
   referenceId: post11.postId,
   referenceType: 'post',
   data: {
     text: 'test',
   },
+  attachments: [
+    {
+      type: 'image',
+      fileId: file11.fileId,
+    },
+  ],
+};
+
+const textCommentWithMentionRequestPayload: Parameters<typeof createComment>[0] = {
+  referenceId: post11.postId,
+  referenceType: 'post',
+  data: {
+    text: 'test',
+  },
+  mentionees: [
+    {
+      type: 'user',
+      userIds: [user11._id, user12._id],
+    },
+  ],
 };
 
 jest.mock('~/post/api/getPost', () => ({
@@ -38,12 +131,79 @@ describe('createComment', () => {
   beforeAll(connectClient);
   afterAll(disconnectClient);
 
-  it('creates a comment and returns the new comment', async () => {
-    client.http.post = jest.fn().mockResolvedValueOnce(createCommentResponse);
+  // integration_test_id: 2f83eabc-46db-43d8-89c6-1b5339d6a273
+  it('creates a text comment and returns the new valid comment', async () => {
+    client.http.post = jest.fn().mockResolvedValueOnce(createTextCommentResponse);
 
-    const newComment = await createComment(bundle);
+    const newComment = await createComment(textCommentRequestPayload);
 
-    expect(getActiveClient().http.post).toHaveBeenCalledWith('/api/v3/comments', bundle);
+    expect(getActiveClient().http.post).toHaveBeenCalledWith(
+      '/api/v3/comments',
+      textCommentRequestPayload,
+    );
     expect(newComment.data).toEqual(comment11);
   });
+
+  // integration_test_id: 81e7d5bc-6881-4f9b-b8d4-deb5fe67200c
+  it('creates a image comment and returns the new valid comment', async () => {
+    client.http.post = jest.fn().mockResolvedValueOnce(createImageCommentResponse);
+
+    const newComment = await createComment(imageCommentRequestPayload);
+
+    expect(getActiveClient().http.post).toHaveBeenCalledWith(
+      '/api/v3/comments',
+      imageCommentRequestPayload,
+    );
+    expect(newComment.data).toEqual(imageComment11);
+  });
+
+  // integration_test_id: 015838a8-3267-4253-920a-9ae83197cf22
+  it('creates an image + text comment and returns the new valid comment', async () => {
+    client.http.post = jest.fn().mockResolvedValueOnce(createTextImageCommentResponse);
+
+    const newComment = await createComment(textImageCommentRequestPayload);
+
+    expect(getActiveClient().http.post).toHaveBeenCalledWith(
+      '/api/v3/comments',
+      textImageCommentRequestPayload,
+    );
+    expect(newComment.data).toEqual(textImageComment11);
+  });
+
+  // integration_test_id: c2285355-f3b6-4e22-926b-11bcf0393161
+  it('creates text comment with mention and returns the new valid comment', async () => {
+    client.http.post = jest.fn().mockResolvedValueOnce(createTextMentionCommentResponse);
+
+    const newComment = await createComment(textCommentWithMentionRequestPayload);
+
+    expect(getActiveClient().http.post).toHaveBeenCalledWith(
+      '/api/v3/comments',
+      textCommentWithMentionRequestPayload,
+    );
+    expect(newComment.data).toEqual(textMentionComment11);
+  });
+
+  // integration_test_id: cb1bfe11-c11a-4324-aeb5-03370da820ad
+  it('creates text comment with parent_id and returns the new valid comment', async () => {
+    client.http.post = jest.fn().mockResolvedValueOnce(createTextCommentParentIdResponse);
+
+    const newComment = await createComment(textCommentParentIdRequestPayload);
+
+    expect(getActiveClient().http.post).toHaveBeenCalledWith(
+      '/api/v3/comments',
+      textCommentParentIdRequestPayload,
+    );
+    expect(newComment.data).toEqual(textWithParentComment11);
+  });
+
+  // integration_test_id: 7f411488-abba-46d1-8707-a1d8adbd7242
+  it('creates text comment with invalid parent_id and returns 400400 error', async () => {
+    client.http.post = jest
+      .fn()
+      .mockRejectedValueOnce(
+        new ASCApiError('not found!', Amity.ServerError.ITEM_NOT_FOUND, Amity.ErrorLevel.ERROR),
+      );
+
+    await expect(createComment(textCommentParentIdRequestPayload)).rejects.toThrow();
+  });
 });

package/src/comment/api/tests/updateComment.test.ts

@@ -0,0 +1,189 @@
+import { createComment } from '../createComment';
+import { updateComment } from '../updateComment';
+import { getActiveClient } from '~/client/api';
+import {
+  client,
+  connectClient,
+  disconnectClient,
+  comment11,
+  imageComment11,
+  textImageComment11,
+  textMentionComment11,
+  textCommentPayload,
+  imageCommentPayload,
+  textImageCommentPayload,
+  textCommentMentionPayload,
+  file11,
+  user11,
+  user12,
+  post11,
+} from '~/utils/tests';
+import { ASCApiError } from '~/core/errors';
+
+const updateTextCommentResponse = {
+  data: {
+    ...textCommentPayload,
+    files: [],
+    commentChildren: [],
+  },
+};
+
+const updateImageCommentResponse = {
+  data: {
+    ...imageCommentPayload,
+    files: [],
+    commentChildren: [],
+  },
+};
+
+const updateTextMentionCommentResponse = {
+  data: {
+    ...textCommentMentionPayload,
+    files: [],
+    commentChildren: [],
+  },
+};
+
+const updateTextImageCommentResponse = {
+  data: {
+    ...textImageCommentPayload,
+    files: [],
+    commentChildren: [],
+  },
+};
+
+const textCommentRequestPayload: Parameters<typeof createComment>[0] = {
+  referenceId: post11.postId,
+  referenceType: 'post',
+  data: {
+    text: 'test',
+  },
+};
+
+const textCommentWithMentionRequestPayload: Parameters<typeof createComment>[0] = {
+  ...textCommentRequestPayload,
+  mentionees: [
+    {
+      type: 'user',
+      userIds: [user11._id, user12._id],
+    },
+  ],
+};
+
+const textImageCommentRequestPayload: Parameters<typeof createComment>[0] = {
+  ...textCommentRequestPayload,
+  attachments: [
+    {
+      type: 'image',
+      fileId: file11.fileId,
+    },
+  ],
+};
+
+const imageCommentRequestPayload: Parameters<typeof createComment>[0] = {
+  referenceId: post11.postId,
+  referenceType: 'post',
+  attachments: [
+    {
+      type: 'image',
+      fileId: file11.fileId,
+    },
+  ],
+};
+
+describe('updateComment', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  // functional and logic test
+  [
+    {
+      // integration_test_id: 1f0c74da-863e-44eb-acf1-3de57b1a0e79
+      title: 'update comment with valid data and return a new data',
+      mockRequest: updateTextCommentResponse,
+      mockFunction: textCommentRequestPayload,
+      expectResult: comment11,
+      extraCase: [],
+    },
+    {
+      // integration_test_id: 72550ea2-2943-4708-bc36-dd2b4fcf44b7
+      title: 'update text comment with mention and returns the new valid comment',
+      mockRequest: updateTextMentionCommentResponse,
+      mockFunction: textCommentWithMentionRequestPayload,
+      expectResult: textMentionComment11,
+      extraCase: [],
+    },
+    {
+      // integration_test_id: 9df2ff6c-81b7-4bdd-bcd2-33d9752735ed
+      title: 'update an image + text comment and returns the new valid comment',
+      mockRequest: updateTextImageCommentResponse,
+      mockFunction: textImageCommentRequestPayload,
+      expectResult: textImageComment11,
+      extraCase: [],
+    },
+    {
+      // integration_test_id: 75c77684-09f3-442e-8089-6d37e2182a65
+      title: 'add image to existing comment and returns the new valid comment',
+      mockRequest: updateTextImageCommentResponse,
+      mockFunction: textImageCommentRequestPayload,
+      expectResult: textImageComment11,
+      extraCase: [],
+    },
+    {
+      // integration_test_id: b50d7783-ab5e-4473-be3b-08ffe8b5142a
+      title: 'remove image from existing comment and returns the new valid comment',
+      mockRequest: updateTextCommentResponse,
+      mockFunction: textCommentRequestPayload,
+      expectResult: comment11,
+      extraCase: [{ attachments: [] }],
+    },
+    {
+      // integration_test_id: f31daa63-7214-400a-a7a1-d9b00d37137e
+      title: 'remove text from existing media comment and returns the new valid comment',
+      mockRequest: updateImageCommentResponse,
+      mockFunction: imageCommentRequestPayload,
+      expectResult: imageComment11,
+      extraCase: [{ data: { text: '' } }],
+    },
+  ].forEach(({ title, mockRequest, mockFunction, expectResult, extraCase }) =>
+    it(title, async () => {
+      client.http.put = jest.fn().mockResolvedValueOnce(mockRequest);
+
+      const newComment = await updateComment(comment11.commentId, mockFunction);
+
+      expect(getActiveClient().http.put).toHaveBeenCalledWith(
+        `/api/v3/comments/${comment11.commentId}`,
+        mockFunction,
+      );
+      expect(newComment.data).toEqual(expectResult);
+
+      extraCase.forEach(value => {
+        expect(newComment.data).toEqual(expect.objectContaining(value));
+      });
+    }),
+  );
+
+  // Failed case
+  [
+    {
+      // integration_test_id: f2c24783-733e-4a4a-90c4-b518a8d584a1
+      title: 'edit text comment with invalid comment_id and returns 400400 error',
+      errorCode: Amity.ServerError.ITEM_NOT_FOUND,
+      payload: textCommentRequestPayload,
+    },
+    {
+      // integration_test_id: 2f556a4c-2148-4d59-b07e-f415d7c8928c
+      title: 'edit text comment which not own by current user and returns 400301 error',
+      errorCode: Amity.ServerError.PERMISSION_DENIED,
+      payload: textCommentRequestPayload,
+    },
+  ].forEach(({ title, errorCode, payload }) =>
+    it(title, async () => {
+      client.http.put = jest
+        .fn()
+        .mockRejectedValueOnce(new ASCApiError('not found!', errorCode, Amity.ErrorLevel.ERROR));
+
+      await expect(createComment(payload)).rejects.toThrow();
+    }),
+  );
+});

package/src/comment/events/tests/onCommentCreated.test.ts

@@ -1,4 +1,4 @@
-import { client, comment11, commentPayload } from '~/utils/tests';
+import { client, comment11, textCommentPayload } from '~/utils/tests';
 import { onCommentCreated } from '../onCommentCreated';
 
 describe('onCommentCreated', () => {
@@ -6,7 +6,7 @@ describe('onCommentCreated', () => {
     const callback = jest.fn();
 
     const unsub = onCommentCreated(callback);
-    client.emitter.emit('comment.created', commentPayload);
+    client.emitter.emit('comment.created', textCommentPayload);
 
     unsub();
 
@@ -20,7 +20,7 @@ describe('onCommentCreated', () => {
     const unsub = onCommentCreated(callback);
     unsub();
 
-    client.emitter.emit('comment.created', commentPayload);
+    client.emitter.emit('comment.created', textCommentPayload);
 
     expect(callback).not.toHaveBeenCalled();
   });

package/src/comment/events/tests/onCommentDeleted.test.ts

@@ -1,4 +1,4 @@
-import { client, comment11, commentPayload } from '~/utils/tests';
+import { client, comment11, textCommentPayload } from '~/utils/tests';
 import { onCommentDeleted } from '../onCommentDeleted';
 
 describe('onCommentDeleted', () => {
@@ -6,7 +6,7 @@ describe('onCommentDeleted', () => {
     const callback = jest.fn();
 
     const unsub = onCommentDeleted(callback);
-    client.emitter.emit('comment.deleted', commentPayload);
+    client.emitter.emit('comment.deleted', textCommentPayload);
 
     unsub();
 
@@ -20,7 +20,7 @@ describe('onCommentDeleted', () => {
     const unsub = onCommentDeleted(callback);
     unsub();
 
-    client.emitter.emit('comment.deleted', commentPayload);
+    client.emitter.emit('comment.deleted', textCommentPayload);
 
     expect(callback).not.toHaveBeenCalled();
   });

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

@@ -8,6 +8,7 @@ import {
   user12,
 } from '~/utils/tests';
 import { getFutureDate } from '~/core/model';
+
 import { liveComment } from '../liveComment';
 
 describe('liveComment', () => {
@@ -45,7 +46,14 @@ describe('liveComment', () => {
 
     liveComment(comment.commentId, callback);
     await pause();
-    client.emitter.emit(event, { comments: [update] });
+
+    client.emitter.emit(event, {
+      comments: [update],
+      commentChildren: [],
+      users: [],
+      files: [],
+    });
+
     await pause();
 
     expect(callback).toHaveBeenCalledTimes(3);
@@ -80,7 +88,15 @@ describe('liveComment', () => {
 
     liveComment(comment.commentId, callback);
     await pause();
-    client.emitter.emit(event, { comments: [update], reactor });
+
+    client.emitter.emit(event, {
+      comments: [update],
+      reactor,
+      commentChildren: [],
+      users: [],
+      files: [],
+    });
+
     await pause();
 
     expect(callback).toHaveBeenCalledTimes(3);

package/src/community/api/addCommunityMembers.ts

@@ -2,6 +2,7 @@ import { getActiveClient } from '~/client/api';
 
 import { fireEvent } from '~/core/events';
 import { ingestInCache } from '~/cache/api/ingestInCache';
+import { prepareMembershipPayload } from '~/group/utils';
 
 /**
  * ```js
@@ -25,14 +26,16 @@ export const addCommunityMembers = async (
   const client = getActiveClient();
   client.log('community/addCommunityMembers', communityId, userIds);
 
-  const { data } = await client.http.post<Amity.CommunityMembershipPayload>(
+  const { data: payload } = await client.http.post<Amity.CommunityMembershipPayload>(
     `/api/v3/communities/${communityId}/users`,
     { communityId, userIds },
   );
 
-  if (client.cache) ingestInCache(data);
+  fireEvent('community.userAdded', payload);
+
+  const data = prepareMembershipPayload(payload, 'communityUsers');
 
-  fireEvent('community.userAdded', data);
+  if (client.cache) ingestInCache(data);
 
   const { communityUsers } = data;
   return !!communityUsers.find(

package/src/community/api/addCommunityMembersRoles.ts

@@ -1,6 +1,7 @@
 import { getActiveClient } from '~/client/api';
 
 import { ingestInCache } from '~/cache/api/ingestInCache';
+import { prepareMembershipPayload } from '~/group/utils';
 
 /**
  * ```js
@@ -12,7 +13,7 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
  *
  * @param communityId The ID of the {@link Amity.Community} to perform
  * @param roleIds Array of IDs of the {@link Amity.Role} to apply
- * @param userId Array of IDs of the {@link Amity.User} to perform
+ * @param userIds Array of IDs of the {@link Amity.User} to perform
  * @returns A success boolean if the {@link Amity.Role} were added to list of {@link Amity.User} in the {@link Amity.Community}
  *
  * @category Community API
@@ -26,11 +27,13 @@ export const addCommunityMembersRoles = async (
   const client = getActiveClient();
   client.log('community/addCommunityMembersRoles', communityId, roleIds, userIds);
 
-  const { data } = await client.http.post<Amity.CommunityMembershipPayload>(
+  const { data: payload } = await client.http.post<Amity.CommunityMembershipPayload>(
     `/api/v4/communities/${communityId}/users/roles`,
     { communityId, roles: roleIds, userIds },
   );
 
+  const data = prepareMembershipPayload(payload, 'communityUsers');
+
   if (client.cache) ingestInCache(data);
 
   const { communityUsers } = data;

package/src/community/api/createCommunity.ts

@@ -3,7 +3,7 @@ import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { fireEvent } from '~/core/events';
 
-import { packCommunityPayload, unpackCommunityPayload } from '../utils';
+import { prepareCommunityRequest, prepareCommunityPayload } from '../utils';
 
 /**
  * ```js
@@ -41,16 +41,16 @@ export const createCommunity = async (
 
   const { data: payload } = await client.http.post<Amity.CommunityPayload>(
     '/api/v3/communities/',
-    packCommunityPayload(bundle),
+    prepareCommunityRequest(bundle),
   );
 
-  const data = unpackCommunityPayload(payload);
+  fireEvent('community.created', payload);
+
+  const data = prepareCommunityPayload(payload);
 
   const cachedAt = client.cache && Date.now();
   if (client.cache) ingestInCache(data, { cachedAt });
 
-  fireEvent('community.created', data);
-
   const { communities } = data;
   return {
     data: communities[0],

package/src/community/api/deleteCommunity.ts

@@ -27,7 +27,15 @@ export const deleteCommunity = async (
   await client.http.delete<{ success: boolean }>(`/api/v3/communities/${communityId}`);
 
   const deleted = await getCommunity(communityId);
-  fireEvent('community.deleted', { communities: [deleted.data] });
+
+  fireEvent('community.deleted', {
+    communities: [deleted.data],
+    categories: [],
+    communityUsers: [],
+    feeds: [],
+    files: [],
+    users: [],
+  });
 
   return deleted.data;
 };

package/src/community/api/getCommunities.ts

@@ -3,7 +3,7 @@ import { getActiveClient } from '~/client/api';
 import { pullFromCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
-import { unpackCommunityPayload } from '../utils';
+import { prepareCommunityPayload } from '../utils';
 
 /**
  * ```js
@@ -33,7 +33,7 @@ export const getCommunities = async (
     },
   );
 
-  const data = unpackCommunityPayload(payload);
+  const data = prepareCommunityPayload(payload);
 
   const cachedAt = client.cache && Date.now();
   if (client.cache) ingestInCache(data, { cachedAt });

package/src/community/api/getCommunity.ts

@@ -3,7 +3,7 @@ import { getActiveClient } from '~/client/api';
 import { pullFromCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
-import { unpackCommunityPayload } from '../utils';
+import { prepareCommunityPayload } from '../utils';
 
 /**
  * ```js
@@ -30,7 +30,7 @@ export const getCommunity = async (
     `/api/v3/communities/${communityId}`,
   );
 
-  const data = unpackCommunityPayload(payload);
+  const data = prepareCommunityPayload(payload);
 
   const cachedAt = client.cache && Date.now();
   if (client.cache) ingestInCache(data, { cachedAt });

package/src/community/api/getRecommendedCommunities.ts

@@ -4,7 +4,7 @@ import { getResolver } from '~/core/model';
 import { pullFromCache, pushToCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
-import { unpackCommunityPayload } from '../utils';
+import { prepareCommunityPayload } from '../utils';
 
 /**
  * ```js
@@ -35,7 +35,7 @@ export const getRecommendedCommunities = async (
     { params: { options: { limit } } },
   );
 
-  const data = unpackCommunityPayload(payload);
+  const data = prepareCommunityPayload(payload);
   const { communities } = data;
 
   const cachedAt = client.cache && Date.now();

package/src/community/api/getTopTrendingCommunities.ts

@@ -4,7 +4,7 @@ import { getResolver } from '~/core/model';
 import { pullFromCache, pushToCache } from '~/cache/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 
-import { unpackCommunityPayload } from '../utils';
+import { prepareCommunityPayload } from '../utils';
 
 /**
  * ```js
@@ -35,7 +35,7 @@ export const getTopTrendingCommunities = async (
     { params: { options: { limit } } },
   );
 
-  const data = unpackCommunityPayload(payload);
+  const data = prepareCommunityPayload(payload);
   const { communities } = data;
 
   const cachedAt = client.cache && Date.now();