From 386556bb41e8940872b6d5f0fbc08fa6d755daa9 Mon Sep 17 00:00:00 2001 From: Aaron William Po Date: Mon, 18 Dec 2023 13:24:22 -0500 Subject: [PATCH] Refactor paginated query response schema --- src/pages/api/beers/[id]/comments/index.ts | 7 ++----- src/pages/api/beers/[id]/recommendations.ts | 7 ++----- src/pages/api/beers/styles/[id]/beers/index.ts | 7 ++----- src/pages/api/beers/styles/[id]/comments/index.ts | 7 ++----- src/pages/api/breweries/[id]/beers/index.ts | 7 ++----- src/pages/api/breweries/[id]/comments/index.ts | 7 ++----- src/pages/api/users/[id]/followers.ts | 7 ++----- src/pages/api/users/[id]/following.ts | 7 ++----- src/services/schema/PaginatedQueryResponseSchema.ts | 4 ++-- 9 files changed, 18 insertions(+), 42 deletions(-) diff --git a/src/pages/api/beers/[id]/comments/index.ts b/src/pages/api/beers/[id]/comments/index.ts index f9bc088..1efb734 100644 --- a/src/pages/api/beers/[id]/comments/index.ts +++ b/src/pages/api/beers/[id]/comments/index.ts @@ -11,6 +11,7 @@ import { createBeerPostComment, getAllBeerPostComments, } from '@/controllers/comments/beer-comments'; +import PaginatedQueryResponseSchema from '@/services/schema/PaginatedQueryResponseSchema'; const router = createRouter< // @TODO: Fix this any type @@ -29,11 +30,7 @@ router.post( router.get( validateRequest({ - querySchema: z.object({ - id: z.string().cuid(), - page_size: z.coerce.number().int().positive(), - page_num: z.coerce.number().int().positive(), - }), + querySchema: PaginatedQueryResponseSchema.extend({ id: z.string().cuid() }), }), getAllBeerPostComments, ); diff --git a/src/pages/api/beers/[id]/recommendations.ts b/src/pages/api/beers/[id]/recommendations.ts index 15b5d36..a3f6f92 100644 --- a/src/pages/api/beers/[id]/recommendations.ts +++ b/src/pages/api/beers/[id]/recommendations.ts @@ -2,6 +2,7 @@ import NextConnectOptions from '@/config/nextConnect/NextConnectOptions'; import validateRequest from '@/config/nextConnect/middleware/validateRequest'; import { getBeerPostRecommendations } from '@/controllers/posts/beer-posts'; import { GetBeerRecommendationsRequest } from '@/controllers/posts/beer-posts/types'; +import PaginatedQueryResponseSchema from '@/services/schema/PaginatedQueryResponseSchema'; import APIResponseValidationSchema from '@/validation/APIResponseValidationSchema'; import { NextApiResponse } from 'next'; import { createRouter } from 'next-connect'; @@ -14,11 +15,7 @@ const router = createRouter< router.get( validateRequest({ - querySchema: z.object({ - id: z.string().cuid(), - page_num: z.string().regex(/^[0-9]+$/), - page_size: z.string().regex(/^[0-9]+$/), - }), + querySchema: PaginatedQueryResponseSchema.extend({ id: z.string().cuid() }), }), getBeerPostRecommendations, ); diff --git a/src/pages/api/beers/styles/[id]/beers/index.ts b/src/pages/api/beers/styles/[id]/beers/index.ts index 5d89585..7da569f 100644 --- a/src/pages/api/beers/styles/[id]/beers/index.ts +++ b/src/pages/api/beers/styles/[id]/beers/index.ts @@ -1,6 +1,7 @@ import NextConnectOptions from '@/config/nextConnect/NextConnectOptions'; import validateRequest from '@/config/nextConnect/middleware/validateRequest'; import { getAllBeersByBeerStyle } from '@/controllers/posts/beer-styles'; +import PaginatedQueryResponseSchema from '@/services/schema/PaginatedQueryResponseSchema'; import APIResponseValidationSchema from '@/validation/APIResponseValidationSchema'; import { NextApiRequest, NextApiResponse } from 'next'; @@ -18,11 +19,7 @@ const router = createRouter< router.get( validateRequest({ - querySchema: z.object({ - page_size: z.string().min(1), - page_num: z.string().min(1), - id: z.string().min(1), - }), + querySchema: PaginatedQueryResponseSchema.extend({ id: z.string().cuid() }), }), getAllBeersByBeerStyle, ); diff --git a/src/pages/api/beers/styles/[id]/comments/index.ts b/src/pages/api/beers/styles/[id]/comments/index.ts index 174d413..b8e9b8c 100644 --- a/src/pages/api/beers/styles/[id]/comments/index.ts +++ b/src/pages/api/beers/styles/[id]/comments/index.ts @@ -8,6 +8,7 @@ import getCurrentUser from '@/config/nextConnect/middleware/getCurrentUser'; import { NextApiResponse } from 'next'; import CreateCommentValidationSchema from '@/services/schema/CommentSchema/CreateCommentValidationSchema'; import { createComment, getAll } from '@/controllers/comments/beer-style-comments'; +import PaginatedQueryResponseSchema from '@/services/schema/PaginatedQueryResponseSchema'; const router = createRouter< // I don't want to use any, but I can't figure out how to get the types to work @@ -26,11 +27,7 @@ router.post( router.get( validateRequest({ - querySchema: z.object({ - id: z.string().cuid(), - page_size: z.coerce.number().int().positive(), - page_num: z.coerce.number().int().positive(), - }), + querySchema: PaginatedQueryResponseSchema.extend({ id: z.string().cuid() }), }), getAll, ); diff --git a/src/pages/api/breweries/[id]/beers/index.ts b/src/pages/api/breweries/[id]/beers/index.ts index c50ebe4..b3a51f0 100644 --- a/src/pages/api/breweries/[id]/beers/index.ts +++ b/src/pages/api/breweries/[id]/beers/index.ts @@ -2,6 +2,7 @@ import NextConnectOptions from '@/config/nextConnect/NextConnectOptions'; import validateRequest from '@/config/nextConnect/middleware/validateRequest'; import { getAllBeersByBrewery } from '@/controllers/posts/breweries'; import { GetAllPostsByConnectedPostId } from '@/controllers/posts/types'; +import PaginatedQueryResponseSchema from '@/services/schema/PaginatedQueryResponseSchema'; import APIResponseValidationSchema from '@/validation/APIResponseValidationSchema'; import { NextApiResponse } from 'next'; import { createRouter } from 'next-connect'; @@ -14,11 +15,7 @@ const router = createRouter< router.get( validateRequest({ - querySchema: z.object({ - page_size: z.string().nonempty(), - page_num: z.string().nonempty(), - id: z.string().nonempty(), - }), + querySchema: PaginatedQueryResponseSchema.extend({ id: z.string().cuid() }), }), getAllBeersByBrewery, ); diff --git a/src/pages/api/breweries/[id]/comments/index.ts b/src/pages/api/breweries/[id]/comments/index.ts index 2e0175d..338ff16 100644 --- a/src/pages/api/breweries/[id]/comments/index.ts +++ b/src/pages/api/breweries/[id]/comments/index.ts @@ -9,6 +9,7 @@ import { NextApiResponse } from 'next'; import CreateCommentValidationSchema from '@/services/schema/CommentSchema/CreateCommentValidationSchema'; import { createComment, getAll } from '@/controllers/comments/brewery-comments'; +import PaginatedQueryResponseSchema from '@/services/schema/PaginatedQueryResponseSchema'; const router = createRouter< // I don't want to use any, but I can't figure out how to get the types to work @@ -27,11 +28,7 @@ router.post( router.get( validateRequest({ - querySchema: z.object({ - id: z.string().cuid(), - page_size: z.coerce.number().int().positive(), - page_num: z.coerce.number().int().positive(), - }), + querySchema: PaginatedQueryResponseSchema.extend({ id: z.string().cuid() }), }), getAll, ); diff --git a/src/pages/api/users/[id]/followers.ts b/src/pages/api/users/[id]/followers.ts index 761e1a3..5eaf28f 100644 --- a/src/pages/api/users/[id]/followers.ts +++ b/src/pages/api/users/[id]/followers.ts @@ -2,6 +2,7 @@ import NextConnectOptions from '@/config/nextConnect/NextConnectOptions'; import validateRequest from '@/config/nextConnect/middleware/validateRequest'; import { getUserFollowers } from '@/controllers/users/profile'; import { GetUserFollowInfoRequest } from '@/controllers/users/profile/types'; +import PaginatedQueryResponseSchema from '@/services/schema/PaginatedQueryResponseSchema'; import APIResponseValidationSchema from '@/validation/APIResponseValidationSchema'; import { NextApiResponse } from 'next'; @@ -15,11 +16,7 @@ const router = createRouter< router.get( validateRequest({ - querySchema: z.object({ - id: z.string().cuid(), - page_size: z.string().regex(/^\d+$/), - page_num: z.string().regex(/^\d+$/), - }), + querySchema: PaginatedQueryResponseSchema.extend({ id: z.string().cuid() }), }), getUserFollowers, ); diff --git a/src/pages/api/users/[id]/following.ts b/src/pages/api/users/[id]/following.ts index 9e99111..55ed2c9 100644 --- a/src/pages/api/users/[id]/following.ts +++ b/src/pages/api/users/[id]/following.ts @@ -2,6 +2,7 @@ import { UserExtendedNextApiRequest } from '@/config/auth/types'; import NextConnectOptions from '@/config/nextConnect/NextConnectOptions'; import validateRequest from '@/config/nextConnect/middleware/validateRequest'; import { getUsersFollowed } from '@/controllers/users/profile'; +import PaginatedQueryResponseSchema from '@/services/schema/PaginatedQueryResponseSchema'; import APIResponseValidationSchema from '@/validation/APIResponseValidationSchema'; import { NextApiResponse } from 'next'; @@ -19,11 +20,7 @@ const router = createRouter< router.get( validateRequest({ - querySchema: z.object({ - id: z.string().cuid(), - page_size: z.string().regex(/^\d+$/), - page_num: z.string().regex(/^\d+$/), - }), + querySchema: PaginatedQueryResponseSchema.extend({ id: z.string().cuid() }), }), getUsersFollowed, ); diff --git a/src/services/schema/PaginatedQueryResponseSchema.ts b/src/services/schema/PaginatedQueryResponseSchema.ts index 22acabc..a9b880f 100644 --- a/src/services/schema/PaginatedQueryResponseSchema.ts +++ b/src/services/schema/PaginatedQueryResponseSchema.ts @@ -1,8 +1,8 @@ import { z } from 'zod'; const PaginatedQueryResponseSchema = z.object({ - page_num: z.string(), - page_size: z.string(), + page_num: z.string().regex(/^\d+$/), + page_size: z.string().regex(/^\d+$/), }); export default PaginatedQueryResponseSchema;