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

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

@@ -0,0 +1,147 @@
+import { queryComments } from '../queryComments';
+
+import {
+  client,
+  connectClient,
+  disconnectClient,
+  textCommentPayload,
+  imageCommentPayload,
+  post11,
+  textCommentResponse,
+  imageCommentResponse,
+  textAndImageCommentMixedPayload,
+  textCommentRequestPayload,
+  comment12,
+  comment12Payload,
+  deletedCommentPayload,
+  deletedCommentResponse,
+} from '~/utils/tests';
+import { ASCApiError } from '~/core/errors';
+
+type mockParamAndResponse = {
+  query: Amity.QueryComments;
+  response: Amity.Comment[];
+};
+
+const queryParams: mockParamAndResponse = {
+  query: {
+    referenceType: 'post',
+    referenceId: post11.postId,
+  },
+  response: textCommentPayload.comments,
+};
+
+const queryImageOnly: mockParamAndResponse = {
+  query: {
+    ...queryParams.query,
+    dataTypes: {
+      values: ['image'],
+      matchType: 'exact',
+    },
+  },
+  response: imageCommentPayload.comments,
+};
+
+const queryImageAny: mockParamAndResponse = {
+  query: {
+    ...queryParams.query,
+    dataTypes: {
+      values: ['image'],
+      matchType: 'any',
+    },
+  },
+  response: textAndImageCommentMixedPayload.comments,
+};
+
+const queryWithParentId: mockParamAndResponse = {
+  query: {
+    ...queryParams.query,
+    parentId: comment12.parentId,
+  },
+  response: comment12Payload.comments,
+};
+
+const deletedComment: mockParamAndResponse = {
+  query: {
+    ...queryParams.query,
+    includeDeleted: true,
+  },
+  response: deletedCommentPayload.comments,
+};
+
+describe('queryComments', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  const testCase: [string, object, Amity.QueryComments, Amity.Comment[]][] = [
+    [
+      // integration_test_id: 0be48975-be6d-4199-bec0-af186af444d3
+      'Should return valid comment when user query with valid query',
+      textCommentResponse,
+      queryParams.query,
+      queryParams.response,
+    ],
+    [
+      // integration_test_id: 4550e036-53d0-4f35-b83f-9edc10f1c974
+
+      'Should return only valid image comment types when user query with dataType exact image',
+      imageCommentResponse,
+      queryImageOnly.query,
+      queryImageOnly.response,
+    ],
+    [
+      // integration_test_id: 03056892-251f-4a85-a9bf-f9978c1912e5
+      'Should return only valid deleted comment list when user query with isDeleted=true',
+      deletedCommentResponse,
+      deletedComment.query,
+      deletedComment.response,
+    ],
+    [
+      // integration_test_id: 2f68da78-7738-4371-ae72-b6a4ff043404
+
+      'Should return only valid mixed types comment list when user query with dataType any image',
+      {
+        data: {
+          ...textAndImageCommentMixedPayload,
+          paging: {},
+        },
+      },
+      queryImageAny.query,
+      queryImageAny.response,
+    ],
+    [
+      // integration_test_id: 8207d436-a800-4224-8fb0-a46c05f7d11e
+      'Should return only valid mixed types comment list when user query with parent_id',
+      {
+        data: {
+          ...comment12Payload,
+          paging: {},
+        },
+      },
+      queryWithParentId.query,
+      queryWithParentId.response,
+    ],
+  ];
+
+  test.each(testCase)('%s', async (title, mockResponse, query, expectResult) => {
+    client.http.get = jest.fn().mockResolvedValueOnce(mockResponse);
+    const result = await queryComments(query);
+    expect(result.data).toEqual(expectResult);
+  });
+
+  const errorCase: [string, number, Amity.QueryComments][] = [
+    [
+      // integration_test_id: 2719d77f-177a-401f-864f-ef0f0804cc24
+      'Should return error 400400 when query with wrong post_id', // title
+      Amity.ServerError.ITEM_NOT_FOUND, // errorCode
+      textCommentRequestPayload, // payload
+    ],
+  ];
+
+  test.each(errorCase)('%s', async (title, errorCode, payload) => {
+    client.http.get = jest
+      .fn()
+      .mockRejectedValueOnce(new ASCApiError('not found!', errorCode, Amity.ErrorLevel.ERROR));
+    await expect(queryComments(payload)).rejects.toThrow();
+  });
+});

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

@@ -9,88 +9,17 @@ import {
   imageComment11,
   textImageComment11,
   textMentionComment11,
-  textCommentPayload,
-  imageCommentPayload,
-  textImageCommentPayload,
-  textCommentMentionPayload,
-  file11,
-  user11,
-  user12,
-  post11,
+  imageCommentResponse,
+  textCommentResponse,
+  textImageCommentResponse,
+  textMentionCommentResponse,
+  imageCommentRequestPayload,
+  textCommentRequestPayload,
+  textCommentWithMentionRequestPayload,
+  textImageCommentRequestPayload,
 } 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);
@@ -100,7 +29,7 @@ describe('updateComment', () => {
     {
       // integration_test_id: 1f0c74da-863e-44eb-acf1-3de57b1a0e79
       title: 'update comment with valid data and return a new data',
-      mockRequest: updateTextCommentResponse,
+      mockRequest: textCommentResponse,
       mockFunction: textCommentRequestPayload,
       expectResult: comment11,
       extraCase: [],
@@ -108,7 +37,7 @@ describe('updateComment', () => {
     {
       // integration_test_id: 72550ea2-2943-4708-bc36-dd2b4fcf44b7
       title: 'update text comment with mention and returns the new valid comment',
-      mockRequest: updateTextMentionCommentResponse,
+      mockRequest: textMentionCommentResponse,
       mockFunction: textCommentWithMentionRequestPayload,
       expectResult: textMentionComment11,
       extraCase: [],
@@ -116,7 +45,7 @@ describe('updateComment', () => {
     {
       // integration_test_id: 9df2ff6c-81b7-4bdd-bcd2-33d9752735ed
       title: 'update an image + text comment and returns the new valid comment',
-      mockRequest: updateTextImageCommentResponse,
+      mockRequest: textImageCommentResponse,
       mockFunction: textImageCommentRequestPayload,
       expectResult: textImageComment11,
       extraCase: [],
@@ -124,7 +53,7 @@ describe('updateComment', () => {
     {
       // integration_test_id: 75c77684-09f3-442e-8089-6d37e2182a65
       title: 'add image to existing comment and returns the new valid comment',
-      mockRequest: updateTextImageCommentResponse,
+      mockRequest: textImageCommentResponse,
       mockFunction: textImageCommentRequestPayload,
       expectResult: textImageComment11,
       extraCase: [],
@@ -132,7 +61,7 @@ describe('updateComment', () => {
     {
       // integration_test_id: b50d7783-ab5e-4473-be3b-08ffe8b5142a
       title: 'remove image from existing comment and returns the new valid comment',
-      mockRequest: updateTextCommentResponse,
+      mockRequest: textCommentResponse,
       mockFunction: textCommentRequestPayload,
       expectResult: comment11,
       extraCase: [{ attachments: [] }],
@@ -140,7 +69,7 @@ describe('updateComment', () => {
     {
       // integration_test_id: f31daa63-7214-400a-a7a1-d9b00d37137e
       title: 'remove text from existing media comment and returns the new valid comment',
-      mockRequest: updateImageCommentResponse,
+      mockRequest: imageCommentResponse,
       mockFunction: imageCommentRequestPayload,
       expectResult: imageComment11,
       extraCase: [{ data: { text: '' } }],

package/src/comment/api/updateComment.ts

@@ -3,6 +3,9 @@ import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { fireEvent } from '~/core/events';
 
+/* begin_public_function
+  id: comment.update_comment
+*/
 /**
  * ```js
  * import { updateComment } from '@amityco/ts-sdk'
@@ -43,3 +46,4 @@ export const updateComment = async (
     cachedAt,
   };
 };
+/* end_public_function */

package/src/comment/observers/liveComments.ts

@@ -80,7 +80,9 @@ export const liveComments = (
         .filter(Boolean)
         .map(({ data }) => data) ?? [];
 
-    comments = filterByPropEquality(comments, 'isDeleted', params.isDeleted);
+    if (params.includeDeleted === false) {
+      comments = filterByPropEquality(comments, 'isDeleted', false);
+    }
 
     const sortBy = params.sortBy ? params.sortBy : 'lastCreated';
 

package/src/community/api/addCommunityMembers.ts

@@ -4,6 +4,9 @@ import { fireEvent } from '~/core/events';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: community.membership.add_members
+*/
 /**
  * ```js
  * import { addCommunityMembers } from '@amityco/ts-sdk'
@@ -43,3 +46,4 @@ export const addCommunityMembers = async (
       communityUser.communityId === communityId && communityUser.communityMembership === 'member',
   );
 };
+/* end_public_function */

package/src/community/api/addCommunityMembersRoles.ts

@@ -3,6 +3,9 @@ import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: community.moderation.add_roles
+*/
 /**
  * ```js
  * import { addCommunityMembersRoles } from '@amityco/ts-sdk'
@@ -43,3 +46,4 @@ export const addCommunityMembersRoles = async (
       roleIds.some(role => communityUser.roles.includes(role)),
   );
 };
+/* end_public_function */

package/src/community/api/createCommunity.ts

@@ -5,6 +5,9 @@ import { fireEvent } from '~/core/events';
 
 import { prepareCommunityRequest, prepareCommunityPayload } from '../utils';
 
+/* begin_public_function
+  id: community.create
+*/
 /**
  * ```js
  * import { createCommunity } from '@amityco/ts-sdk'
@@ -57,3 +60,4 @@ export const createCommunity = async (
     cachedAt,
   };
 };
+/* end_public_function */

package/src/community/api/deleteCommunity.ts

@@ -3,6 +3,9 @@ import { getActiveClient } from '~/client/api';
 import { fireEvent } from '~/core/events';
 import { getCommunity } from './getCommunity';
 
+/* begin_public_function
+  id: community.delete
+*/
 /**
  * ```js
  * import { deleteCommunity } from '@amityco/ts-sdk'
@@ -39,3 +42,4 @@ export const deleteCommunity = async (
 
   return deleted.data;
 };
+/* end_public_function */

package/src/community/api/getCommunity.ts

@@ -5,6 +5,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareCommunityPayload } from '../utils';
 
+/* begin_public_function
+  id: community.get
+*/
 /**
  * ```js
  * import { getCommunity } from '@amityco/ts-sdk'
@@ -42,6 +45,7 @@ export const getCommunity = async (
     cachedAt,
   };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/community/api/getRecommendedCommunities.ts

@@ -6,6 +6,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareCommunityPayload } from '../utils';
 
+/* begin_public_function
+  id: community.query.recommended_communities
+*/
 /**
  * ```js
  * import { getRecommendedCommunities } from '@amityco/ts-sdk'
@@ -49,6 +52,7 @@ export const getRecommendedCommunities = async (
 
   return { data: communities, cachedAt };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/community/api/getTopTrendingCommunities.ts

@@ -6,6 +6,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 
 import { prepareCommunityPayload } from '../utils';
 
+/* begin_public_function
+  id: community.query.trending_communities
+*/
 /**
  * ```js
  * import { getTopTrendingCommunities } from '@amityco/ts-sdk'
@@ -49,6 +52,7 @@ export const getTopTrendingCommunities = async (
 
   return { data: communities, cachedAt };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/community/api/joinCommunity.ts

@@ -4,6 +4,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 import { prepareCommunityPayload } from '~/community/utils';
 import { fireEvent } from '~/core/events';
 
+/* begin_public_function
+  id: community.join
+*/
 /**
  * ```js
  * import { joinCommunity } from '@amityco/ts-sdk'
@@ -42,3 +45,4 @@ export const joinCommunity = async (
       communityUser.communityId === communityId && communityUser.communityMembership === 'member',
   );
 };
+/* end_public_function */

package/src/community/api/leaveCommunity.ts

@@ -4,6 +4,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 import { prepareCommunityPayload } from '~/community/utils';
 import { fireEvent } from '~/core/events';
 
+/* begin_public_function
+  id: community.leave
+*/
 /**
  * ```js
  * import { leaveCommunity } from '@amityco/ts-sdk'
@@ -42,3 +45,4 @@ export const leaveCommunity = async (
       communityUser.communityId === communityId && communityUser.communityMembership !== 'member',
   );
 };
+/* end_public_function */

package/src/community/api/queryCommunities.ts

@@ -7,6 +7,9 @@ import { getResolver } from '~/core/model';
 
 import { prepareCommunityPayload } from '../utils';
 
+/* begin_public_function
+  id: community.query
+*/
 /**
  * ```js
  * import { queryCommunities } from '@amityco/ts-sdk'
@@ -30,7 +33,7 @@ export const queryCommunities = async (
 
   // safe decapsulation
   const { page, ...params } = query ?? {};
-  const { displayName, membership, ...restParams } = params ?? {};
+  const { displayName, membership, includeDeleted, ...restParams } = params ?? {};
 
   // API-FIX: parameters should be querystring.
   // API-FIX: backend doesnt answer Amity.Response
@@ -40,6 +43,7 @@ export const queryCommunities = async (
     {
       params: {
         ...restParams,
+        isDeleted: includeDeleted === false ? false : undefined,
         keyword: displayName,
         filter: membership,
         options: {
@@ -71,6 +75,7 @@ export const queryCommunities = async (
 
   return { data: communities, cachedAt, prevPage, nextPage };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/community/api/queryCommunityMembers.ts

@@ -6,6 +6,9 @@ import { toPage, toToken } from '~/core/query';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: community.membership.query
+*/
 /**
  * ```js
  * import { queryCommunityMembers } from '@amityco/ts-sdk'
@@ -66,6 +69,7 @@ export const queryCommunityMembers = async (
 
   return { data: communityUsers, cachedAt, nextPage, prevPage };
 };
+/* end_public_function */
 
 /**
  * ```js

package/src/community/api/removeCommunityMembers.ts

@@ -4,6 +4,9 @@ import { ingestInCache } from '~/cache/api/ingestInCache';
 import { fireEvent } from '~/core/events';
 import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: community.membership.remove_member
+*/
 /**
  * ```js
  * import { removeCommunityMembers } from '@amityco/ts-sdk'
@@ -44,3 +47,4 @@ export const removeCommunityMembers = async (
       communityUser.communityId === communityId && communityUser.communityMembership !== 'member',
   );
 };
+/* end_public_function */

package/src/community/api/removeCommunityMembersRoles.ts

@@ -3,6 +3,9 @@ import { getActiveClient } from '~/client/api';
 import { ingestInCache } from '~/cache/api/ingestInCache';
 import { prepareMembershipPayload } from '~/group/utils';
 
+/* begin_public_function
+  id: community.moderation.remove_roles
+*/
 /**
  * ```js
  * import { removeCommunityMembersRoles } from '@amityco/ts-sdk'
@@ -43,3 +46,4 @@ export const removeCommunityMembersRoles = async (
       !roleIds.some(role => communityUser.roles.includes(role)),
   );
 };
+/* end_public_function */

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

@@ -68,6 +68,36 @@ describe('queryCommunities', () => {
 
     await expect(queryCommunities(queryCriteria)).rejects.toThrow('error');
   });
+
+  test('it should set isDeleted to undefined if includeDeleted is true', async () => {
+    const mockFn = jest.fn();
+    client.http.get = mockFn.mockResolvedValue(resolvedGetValue);
+
+    await queryCommunities({ ...queryCriteriaWithoutPage, includeDeleted: true });
+
+    expect(mockFn.mock.lastCall).toHaveLength(2);
+    expect(mockFn.mock.lastCall[1].params.isDeleted).toBeUndefined();
+  });
+
+  test('it should set isDeleted to false if includeDeleted is false', async () => {
+    const mockFn = jest.fn();
+    client.http.get = mockFn.mockResolvedValue(resolvedGetValue);
+
+    await queryCommunities({ ...queryCriteriaWithoutPage, includeDeleted: false });
+
+    expect(mockFn.mock.lastCall).toHaveLength(2);
+    expect(mockFn.mock.lastCall[1].params.isDeleted).toBe(false);
+  });
+
+  test('it should set isDeleted to undefined if includeDeleted is undefined', async () => {
+    const mockFn = jest.fn();
+    client.http.get = mockFn.mockResolvedValue(resolvedGetValue);
+
+    await queryCommunities(queryCriteriaWithoutPage);
+
+    expect(mockFn.mock.lastCall).toHaveLength(2);
+    expect(mockFn.mock.lastCall[1].params.isDeleted).toBeUndefined();
+  });
 });
 
 describe.skip('queryCommunities.locally', () => {

package/src/community/api/updateCommunity.ts

@@ -5,6 +5,9 @@ import { fireEvent } from '~/core/events';
 
 import { prepareCommunityRequest, prepareCommunityPayload } from '../utils';
 
+/* begin_public_function
+  id: community.update
+*/
 /**
  * ```js
  * import { updateCommunity } from '@amityco/ts-sdk'
@@ -49,3 +52,4 @@ export const updateCommunity = async (
     cachedAt,
   };
 };
+/* end_public_function */

package/src/community/observers/liveCommunities.ts

@@ -73,9 +73,12 @@ export const liveCommunities = (
         .filter(Boolean)
         .map(({ data }) => data) ?? [];
 
-    communities = filterByPropEquality(communities, 'isDeleted', params.isDeleted);
     communities = filterByPropEquality(communities, 'displayName', params.displayName);
 
+    if (params.includeDeleted === false) {
+      communities = filterByPropEquality(communities, 'isDeleted', false);
+    }
+
     if (params.categoryId) {
       communities = communities.filter(c => c.categoryIds?.includes(params.categoryId!));
     }

package/src/community/observers/tests/liveCommunities.test.ts

@@ -85,7 +85,7 @@ describe('liveCommunities', () => {
   });
 
   const filters: [string, Amity.CommunityLiveCollection, Amity.Community[]][] = [
-    ['deleted', { isDeleted: true }, [community1]],
+    ['not deleted', { includeDeleted: false }, [community2]],
     ['categoryId', { categoryId: 'test-category-id' }, [community1]],
     ['displayName', { displayName: 'community 1' }, [community1]],
     ['tagged', { tags: ['test-community-tag'] }, [community1]],
@@ -200,7 +200,7 @@ describe('liveCommunities', () => {
       const callback = jest.fn();
       client.http.get = jest.fn().mockResolvedValue(communityQueryResponse);
 
-      liveCommunities({ isDeleted: false }, callback);
+      liveCommunities({ includeDeleted: false }, callback);
       await pause();
 
       client.emitter.emit(event, communityPayload);

package/src/core/model/idResolvers.ts

@@ -31,6 +31,7 @@ const idResolvers: Resolvers = {
   stream: ({ streamId }) => streamId,
 
   follow: ({ from, to }) => `${from}#${to}`,
+  followInfo: ({ userId }) => userId,
   followCount: ({ userId }) => userId,
 
   feed: ({ targetId, feedId }) => `${targetId}#${feedId}`,

package/src/core/model/identifyModel.ts

@@ -36,8 +36,9 @@ const CRITERIAS: Criterias = {
   reaction: ['reactionId'],
   stream: ['streamId'],
   follow: ['from', 'to'],
-  followCount: ['userId', 'followerCount'],
   feed: ['feedId', 'feedType'],
+  followInfo: ['userId', 'status'],
+  followCount: ['userId', 'followerCount'],
 };
 
 /** @hidden */