@amityco/ts-sdk-react-native 6.7.1-80c1951.0

package/src/commentRepository/api/getCommentByIds.ts

@@ -0,0 +1,96 @@
+import { getActiveClient } from '~/client/api';
+
+import { pullFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { checkIfShouldGoesToTombstone } from '~/cache/utils';
+import { pushToTombstone } from '~/cache/api/pushToTombstone';
+
+/* begin_public_function
+  id: comment.get_by_ids
+*/
+/**
+ * ```js
+ * import { CommentRepository } from '@amityco/ts-sdk-react-native'
+ * const comments = await CommentRepository.getCommentByIds(['foo', 'bar'])
+ * ```
+ *
+ * Fetches a collection of {@link Amity.Comment} objects
+ *
+ * @param commentIds the IDs of the {@link Amity.Comment} to fetch
+ * @returns the associated collection of {@link Amity.Comment} objects
+ *
+ * @category Comment API
+ * @async
+ */
+export const getCommentByIds = async (
+  commentIds: Amity.Comment['commentId'][],
+): Promise<Amity.Cached<Amity.Comment[]>> => {
+  const client = getActiveClient();
+  client.log('comment/getCommentByIds', commentIds);
+
+  const encodedCommentIds = commentIds.map(commentId => encodeURIComponent(commentId));
+
+  let data: Amity.CommentPayload;
+
+  try {
+    // API-FIX: endpoint should not be /list, parameters should be querystring.
+    const response = await client.http.get<Amity.CommentPayload>(`/api/v3/comments/list`, {
+      params: { commentIds: encodedCommentIds },
+    });
+
+    data = response.data;
+  } catch (error) {
+    commentIds.forEach(commentId => {
+      if (checkIfShouldGoesToTombstone((error as Amity.ErrorResponse)?.code)) {
+        pushToTombstone('comment', commentId);
+      }
+    });
+
+    throw error;
+  }
+
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
+
+  return {
+    data: data.comments,
+    cachedAt,
+  };
+};
+/* end_public_function */
+
+/**
+ * ```js
+ * import { getCommentByIds } from '@amityco/ts-sdk-react-native'
+ * const comments = getCommentByIds.locally(['foo', 'bar'])
+ * ```
+ *
+ * Fetches a collection of {@link Amity.Comment} objects from cache
+ *
+ * @param commentIds the IDs of the {@link Amity.Comment} to fetch
+ * @returns the associated collection of {@link Amity.Comment} objects
+ *
+ * @category Comment API
+ */
+getCommentByIds.locally = (
+  commentIds: Amity.Comment['commentId'][],
+): Amity.Cached<Amity.Comment[]> | undefined => {
+  const client = getActiveClient();
+  client.log('comment/getCommentByIds.locally', commentIds);
+
+  if (!client.cache) return;
+
+  const cached = commentIds
+    .map(commentId => pullFromCache<Amity.Comment>(['comment', 'get', commentId])!)
+    .filter(Boolean);
+
+  const comments = cached.map(({ data }) => data);
+  const oldest = cached.sort((a, b) => (a.cachedAt! < b.cachedAt! ? -1 : 1))?.[0];
+
+  if (cached?.length < commentIds.length) return;
+
+  return {
+    data: comments,
+    cachedAt: oldest.cachedAt,
+  };
+};

package/src/commentRepository/api/hardDeleteComment.ts

@@ -0,0 +1,32 @@
+import { getActiveClient } from '~/client/api';
+
+import { deleteComment } from './deleteComment';
+
+/* begin_public_function
+  id: comment.hard_delete
+*/
+/**
+ * ```js
+ * import { CommentRepository } from '@amityco/ts-sdk-react-native'
+ * const success = await CommentRepository.hardDeleteComment('foobar')
+ * ```
+ *
+ * Deletes a {@link Amity.Comment}
+ *
+ * @param commentId The {@link Amity.Comment} ID to delete
+ * @return A success boolean if the {@link Amity.Comment} was deleted
+ *
+ * @category Comment API
+ * @async
+ */
+export const hardDeleteComment = async (
+  commentId: Amity.Comment['commentId'],
+): Promise<Amity.Comment> => {
+  const client = getActiveClient();
+  client.log('comment/hardDeleteComment', commentId);
+
+  const hardDeleted = deleteComment(commentId, true);
+
+  return hardDeleted;
+};
+/* end_public_function */

package/src/commentRepository/api/index.ts

@@ -0,0 +1,12 @@
+export * from './getCommentByIds';
+
+export * from './createComment';
+export * from './updateComment';
+
+export * from './deleteComment';
+export * from './softDeleteComment';
+export * from './hardDeleteComment';
+
+export * from './flagComment';
+export * from './unflagComment';
+export * from './isCommentFlaggedByMe';

package/src/commentRepository/api/isCommentFlaggedByMe.ts

@@ -0,0 +1,35 @@
+import { getActiveClient } from '~/client/api/activeClient';
+import { synchronousWSCall } from '~/core/transports';
+
+/* begin_public_function
+  id: comment.check_flag_by_me
+*/
+/**
+ * ```js
+ * import { CommentRepository } from '@amityco/ts-sdk-react-native'
+ * const isReported = await CommentRepository.isCommentFlaggedByMe('commentId')
+ * ```
+ *
+ * @param commentId The ID of the comment to check if flagged by current user
+ * @returns `true` if the comment is flagged by me, `false` if doesn't.
+ *
+ * @category Comment API
+ * @async
+ * */
+export const isCommentFlaggedByMe = async (
+  commentId: Amity.Comment['commentId'],
+): Promise<boolean> => {
+  const client = getActiveClient();
+  client.log('comment/isCommentFlaggedByMe', commentId);
+
+  const { result, isFlagByMe } =
+    (await synchronousWSCall<{
+      result?: boolean;
+      isFlagByMe?: boolean;
+    }>(client, 'v3/comment.isflagbyme', {
+      commentId,
+    })) ?? {};
+
+  return result ?? isFlagByMe ?? false;
+};
+/* end_public_function */

package/src/commentRepository/api/queryComments.ts

@@ -0,0 +1,75 @@
+import { getActiveClient } from '~/client/api';
+
+import { toPage, toToken } from '~/core/query';
+import { pullFromCache, pushToCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { getResolver } from '~/core/model';
+
+import { inferIsDeleted } from '~/utils/inferIsDeleted';
+
+/**
+ * ```js
+ * import { CommentRepository } from '@amityco/ts-sdk-react-native'
+ * const comments = await CommentRepository.queryComments({ referenceType: 'post', referenceId: 'foo' })
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.Comment} objects
+ *
+ * @param query The query parameters
+ * @returns A page of {@link Amity.Comment} objects
+ *
+ * @category Comment API
+ * @async
+ */
+export const queryComments = async (
+  query: Amity.QueryComments,
+): Promise<Amity.Cached<Amity.Paged<Amity.Comment>>> => {
+  const client = getActiveClient();
+  client.log('comment/queryComments', query);
+
+  const { page = { limit: 10 }, includeDeleted, ...params } = query;
+
+  const options = {
+    type: params.sortBy ? 'pagination' : undefined,
+    token: toToken(page, params.sortBy ? 'skiplimit' : 'afterbefore'),
+  };
+  // const filterByParentId = query.parentId !== undefined
+
+  // API-FIX: parameters should be querystring. (1)
+  // API-FIX: backend should answer Amity.Response (2)
+  // const { data } = await client.http.get<Amity.Response<Amity.PagedResponse<Amity.CommentPayload>>>(
+  const { data } = await client.http.get<Amity.CommentPayload & Amity.Pagination>(
+    `/api/v3/comments`,
+    {
+      params: {
+        ...params,
+        isDeleted: inferIsDeleted(includeDeleted),
+        //      filterByParentId, API-FIX: backend does not support this boolean LOL. what the hell seriously.
+        options,
+      },
+    },
+  );
+
+  // API-FIX: backend should answer Amity.Response (2)
+  // const { paging, comments } = unwrapPayload(data)
+  const { paging, ...payload } = data;
+  const { comments } = payload;
+
+  const cachedAt = client.cache && Date.now();
+
+  if (client.cache) {
+    ingestInCache(payload as Amity.CommentPayload, { cachedAt });
+
+    const cacheKey = [
+      'comment',
+      'query',
+      { ...params, options: { ...page } } as Amity.Serializable,
+    ];
+    pushToCache(cacheKey, { comments: comments.map(getResolver('comment')), paging });
+  }
+
+  const nextPage = toPage(paging.next);
+  const prevPage = toPage(paging.previous);
+
+  return { data: comments, cachedAt, prevPage, nextPage };
+};

package/src/commentRepository/api/softDeleteComment.ts

@@ -0,0 +1,32 @@
+import { getActiveClient } from '~/client/api';
+
+import { deleteComment } from './deleteComment';
+
+/* begin_public_function
+  id: comment.soft_delete
+*/
+/**
+ * ```js
+ * import { CommentRepository } from '@amityco/ts-sdk-react-native'
+ * const success = await CommentRepository.softDeleteComment('foobar')
+ * ```
+ *
+ * Deletes a {@link Amity.Comment}
+ *
+ * @param commentId The {@link Amity.Comment} ID to delete
+ * @return A success boolean if the {@link Amity.Comment} was deleted
+ *
+ * @category Comment API
+ * @async
+ */
+export const softDeleteComment = async (
+  commentId: Amity.Comment['commentId'],
+): Promise<Amity.Comment> => {
+  const client = getActiveClient();
+  client.log('comment/softDeleteComment', commentId);
+
+  const softDeleted = deleteComment(commentId);
+
+  return softDeleted;
+};
+/* end_public_function */

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

@@ -0,0 +1,114 @@
+import { getActiveClient } from '~/client/api';
+import {
+  client,
+  connectClient,
+  disconnectClient,
+  comment11,
+  imageComment11,
+  textImageComment11,
+  textMentionComment11,
+  comment12,
+  post11,
+  imageCommentResponse,
+  textCommentParentIdResponse,
+  textCommentResponse,
+  textImageCommentResponse,
+  textMentionCommentResponse,
+  imageCommentRequestPayload,
+  textCommentParentIdRequestPayload,
+  textCommentRequestPayload,
+  textCommentWithMentionRequestPayload,
+  textImageCommentRequestPayload,
+} from '~/utils/tests';
+import { ASCApiError } from '~/core/errors';
+import { createComment } from '../createComment';
+
+const getPostResponse = {
+  data: post11,
+  cachedAt: 1673337034544,
+};
+
+jest.mock('~/postRepository/api/getPost', () => ({
+  getPost: jest.fn(() => Promise.resolve(getPostResponse)),
+}));
+
+describe('createComment', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  // 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(textCommentResponse);
+
+    const newComment = await createComment(textCommentRequestPayload);
+
+    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(imageCommentResponse);
+
+    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(textImageCommentResponse);
+
+    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(textMentionCommentResponse);
+
+    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(textCommentParentIdResponse);
+
+    const newComment = await createComment(textCommentParentIdRequestPayload);
+
+    expect(getActiveClient().http.post).toHaveBeenCalledWith(
+      '/api/v3/comments',
+      textCommentParentIdRequestPayload,
+    );
+    expect(newComment.data).toEqual(comment12);
+  });
+
+  // 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/commentRepository/api/tests/deleteComment.test.ts

@@ -0,0 +1,60 @@
+import {
+  client,
+  comment11,
+  connectClient,
+  disconnectClient,
+  emptyPostPayload,
+  generateComment,
+  generatePost,
+  textCommentResponse,
+  user11,
+} from '~/utils/tests';
+import { ASCApiError } from '~/core/errors';
+import { deleteComment } from '../deleteComment';
+
+const commentId = 'comment11';
+const commentData = generateComment({ commentId });
+
+const singlePostResponse = {
+  data: {
+    ...emptyPostPayload,
+    posts: [generatePost({ comments: [commentId], commentsCount: 1 })],
+    comments: [commentData],
+    users: [user11],
+  } as Amity.ProcessedPostPayload,
+};
+
+describe('deleteComment', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  // integration_test_id: ff01df65-2cc0-4fd8-8c3e-a12cea5a359b
+  test('should return success for soft and hard delete', async () => {
+    client.http.get = jest.fn().mockImplementation(url => {
+      if (url === '/api/v3/comments/comment11') return textCommentResponse;
+      // /api/v3/posts/postId11
+      return singlePostResponse;
+    });
+    client.http.delete = jest.fn().mockResolvedValueOnce({ success: true });
+
+    const result = await deleteComment(commentId);
+    expect(result.isDeleted).toEqual(true);
+    expect(result.commentId).toEqual(commentId);
+  });
+
+  // integration_test_id: 322954d6-bc89-40ae-bd18-691ee0c60105
+  test('should return error for deletion not successful', async () => {
+    client.http.get = jest.fn().mockImplementation(url => {
+      if (url === '/api/v3/comments/comment11') return textCommentResponse;
+      // /api/v3/posts/postId11
+      return singlePostResponse;
+    });
+    client.http.delete = jest
+      .fn()
+      .mockRejectedValueOnce(
+        new ASCApiError('not found!', Amity.ServerError.ITEM_NOT_FOUND, Amity.ErrorLevel.ERROR),
+      );
+
+    await expect(deleteComment(commentId)).rejects.toThrow();
+  });
+});

package/src/commentRepository/api/tests/getCommentByIds.test.ts

@@ -0,0 +1,47 @@
+import { enableCache } from '~/cache/api';
+import { client, comment11, connectClient, disconnectClient, user11 } from '~/utils/tests';
+import { ASCApiError } from '~/core/errors';
+import { getCommentByIds } from '../getCommentByIds';
+
+const apiResponse = {
+  data: {
+    comments: [comment11],
+    commentChildren: [],
+    users: [user11],
+    files: [],
+  },
+};
+
+const commentsListResponse = {
+  data: [comment11],
+};
+
+describe('getCommentByIds', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  test('Should return the comments from backend', async () => {
+    enableCache();
+    client.http.get = jest.fn().mockResolvedValueOnce(apiResponse);
+    const { data } = await getCommentByIds([comment11.commentId]);
+    expect(data).toEqual(commentsListResponse.data);
+  });
+
+  test('Should return comments from locally', () => {
+    const comments: ReturnType<typeof getCommentByIds.locally> = getCommentByIds.locally([
+      comment11.commentId,
+    ]);
+
+    expect(comments?.data).toEqual(commentsListResponse.data);
+  });
+
+  test('Should return Error: 400400 when getCommentByIds from invalid commentId', async () => {
+    client.http.get = jest
+      .fn()
+      .mockRejectedValueOnce(
+        new ASCApiError('not found!', Amity.ServerError.ITEM_NOT_FOUND, Amity.ErrorLevel.ERROR),
+      );
+
+    await expect(getCommentByIds([comment11.commentId])).rejects.toThrow();
+  });
+});

package/src/commentRepository/api/tests/getComments.test.ts

@@ -0,0 +1,47 @@
+import { enableCache } from '~/cache/api';
+import { client, comment11, connectClient, disconnectClient, user11 } from '~/utils/tests';
+import { ASCApiError } from '~/core/errors';
+import { getCommentByIds } from '../getCommentByIds';
+
+const apiResponse = {
+  data: {
+    comments: [comment11],
+    commentChildren: [],
+    users: [user11],
+    files: [],
+  },
+};
+
+const commentsListResponse = {
+  data: [comment11],
+};
+
+describe('getCommentByIds', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  test('Should return the comments from backend', async () => {
+    enableCache();
+    client.http.get = jest.fn().mockResolvedValueOnce(apiResponse);
+    const { data } = await getCommentByIds([comment11.commentId]);
+    expect(data).toEqual(commentsListResponse.data);
+  });
+
+  test('Should return comments from locally', () => {
+    const comments: ReturnType<typeof getCommentByIds.locally> = getCommentByIds.locally([
+      comment11.commentId,
+    ]);
+
+    expect(comments?.data).toEqual(commentsListResponse.data);
+  });
+
+  test('Should return Error: 400400 when getCommentByIds from invalid commentId', async () => {
+    client.http.get = jest
+      .fn()
+      .mockRejectedValueOnce(
+        new ASCApiError('not found!', Amity.ServerError.ITEM_NOT_FOUND, Amity.ErrorLevel.ERROR),
+      );
+
+    await expect(getCommentByIds([comment11.commentId])).rejects.toThrow();
+  });
+});

package/src/commentRepository/api/tests/hardDeleteComment.test.ts

@@ -0,0 +1,52 @@
+import {
+  client,
+  connectClient,
+  disconnectClient,
+  generatePost,
+  generateComment,
+} from '~/utils/tests';
+import { disableCache, enableCache } from '~/cache/api';
+
+import { hardDeleteComment } from '../hardDeleteComment';
+
+const getPostResponse = {
+  data: generatePost,
+  cachedAt: 1673337034544,
+};
+
+jest.mock('~/postRepository/api/getPost', () => ({
+  getPost: jest.fn(() => Promise.resolve(getPostResponse)),
+}));
+
+describe('hardDeleteComment', () => {
+  beforeAll(connectClient);
+  afterAll(disconnectClient);
+
+  beforeEach(enableCache);
+  afterEach(disableCache);
+
+  /*
+   * this is the only test required as the rest should be tested in
+   * deleteComment.test.ts
+   */
+  test('it should call the api with the correct param', async () => {
+    const mockApi = jest.fn().mockResolvedValue({ data: {} });
+    const commentId = 'comment-id';
+    const expected = { params: { permanent: true, commentId } };
+
+    // mock get comment
+    client.http.get = jest.fn().mockResolvedValue({
+      data: {
+        comments: [{ ...generateComment(), commentId: 'comment-id' }],
+        commentChildren: [],
+      },
+    });
+    client.http.delete = mockApi;
+
+    await hardDeleteComment(commentId);
+
+    const recieved = mockApi.mock.lastCall[1];
+
+    expect(recieved).toStrictEqual(expected);
+  });
+});