the-biergarten-app/hooks/useBeerPostComments.ts

import BeerCommentQueryResult from '@/services/BeerComment/schema/BeerCommentQueryResult';
import APIResponseValidationSchema from '@/validation/APIResponseValidationSchema';
import { z } from 'zod';
import useSWR from 'swr';

interface UseBeerPostCommentsProps {
  pageNum: number;
  id: string;
  pageSize: number;
}

/**
 * A custom React hook that fetches comments for a specific beer post.
 *
 * @param props - The props object.
 * @param props.pageNum - The page number of the comments to fetch.
 * @param props.id - The ID of the beer post to fetch comments for.
 * @param props.pageSize - The number of comments to fetch per page.
 * @returns An object containing the fetched comments, the total number of comment pages,
 *   a boolean indicating if the request is currently loading, and a function to mutate
 *   the data.
 */
const useBeerPostComments = ({ pageNum, id, pageSize }: UseBeerPostCommentsProps) => {
  const { data, error, isLoading, mutate } = useSWR(
    `/api/beers/${id}/comments?page_num=${pageNum}&page_size=${pageSize}`,
    async (url) => {
      const response = await fetch(url);
      const json = await response.json();
      const count = response.headers.get('X-Total-Count');
      const parsed = APIResponseValidationSchema.safeParse(json);

      if (!parsed.success) {
        throw new Error(parsed.error.message);
      }
      const parsedPayload = z
        .array(BeerCommentQueryResult)
        .safeParse(parsed.data.payload);

      if (!parsedPayload.success) {
        throw new Error(parsedPayload.error.message);
      }

      const pageCount = Math.ceil(parseInt(count as string, 10) / pageSize);
      return { comments: parsedPayload.data, pageCount };
    },
  );
  return {
    comments: data?.comments,
    commentsPageCount: data?.pageCount,
    isLoading,
    error: error as undefined,
    mutate,
  };
};

export default useBeerPostComments;