@amityco/ts-sdk-react-native/src/commentRepository/api/getCommentByIds.ts

Amity Social Cloud Typescript SDK

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';
import { LinkedObject } from '~/utils/linkedObject';

/* 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.map(comment => LinkedObject.comment(comment)),
    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.InternalComment>(['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.map(comment => LinkedObject.comment(comment)),
    cachedAt: oldest.cachedAt,
  };
};