Refactor paginated query response schema

This commit is contained in:
Aaron William Po
2023-12-18 13:24:22 -05:00
parent 736e8ebf10
commit 386556bb41
9 changed files with 18 additions and 42 deletions

View File

@@ -11,6 +11,7 @@ import {
createBeerPostComment, createBeerPostComment,
getAllBeerPostComments, getAllBeerPostComments,
} from '@/controllers/comments/beer-comments'; } from '@/controllers/comments/beer-comments';
import PaginatedQueryResponseSchema from '@/services/schema/PaginatedQueryResponseSchema';
const router = createRouter< const router = createRouter<
// @TODO: Fix this any type // @TODO: Fix this any type
@@ -29,11 +30,7 @@ router.post(
router.get( router.get(
validateRequest({ validateRequest({
querySchema: z.object({ querySchema: PaginatedQueryResponseSchema.extend({ id: z.string().cuid() }),
id: z.string().cuid(),
page_size: z.coerce.number().int().positive(),
page_num: z.coerce.number().int().positive(),
}),
}), }),
getAllBeerPostComments, getAllBeerPostComments,
); );

View File

@@ -2,6 +2,7 @@ import NextConnectOptions from '@/config/nextConnect/NextConnectOptions';
import validateRequest from '@/config/nextConnect/middleware/validateRequest'; import validateRequest from '@/config/nextConnect/middleware/validateRequest';
import { getBeerPostRecommendations } from '@/controllers/posts/beer-posts'; import { getBeerPostRecommendations } from '@/controllers/posts/beer-posts';
import { GetBeerRecommendationsRequest } from '@/controllers/posts/beer-posts/types'; import { GetBeerRecommendationsRequest } from '@/controllers/posts/beer-posts/types';
import PaginatedQueryResponseSchema from '@/services/schema/PaginatedQueryResponseSchema';
import APIResponseValidationSchema from '@/validation/APIResponseValidationSchema'; import APIResponseValidationSchema from '@/validation/APIResponseValidationSchema';
import { NextApiResponse } from 'next'; import { NextApiResponse } from 'next';
import { createRouter } from 'next-connect'; import { createRouter } from 'next-connect';
@@ -14,11 +15,7 @@ const router = createRouter<
router.get( router.get(
validateRequest({ validateRequest({
querySchema: z.object({ querySchema: PaginatedQueryResponseSchema.extend({ id: z.string().cuid() }),
id: z.string().cuid(),
page_num: z.string().regex(/^[0-9]+$/),
page_size: z.string().regex(/^[0-9]+$/),
}),
}), }),
getBeerPostRecommendations, getBeerPostRecommendations,
); );

View File

@@ -1,6 +1,7 @@
import NextConnectOptions from '@/config/nextConnect/NextConnectOptions'; import NextConnectOptions from '@/config/nextConnect/NextConnectOptions';
import validateRequest from '@/config/nextConnect/middleware/validateRequest'; import validateRequest from '@/config/nextConnect/middleware/validateRequest';
import { getAllBeersByBeerStyle } from '@/controllers/posts/beer-styles'; import { getAllBeersByBeerStyle } from '@/controllers/posts/beer-styles';
import PaginatedQueryResponseSchema from '@/services/schema/PaginatedQueryResponseSchema';
import APIResponseValidationSchema from '@/validation/APIResponseValidationSchema'; import APIResponseValidationSchema from '@/validation/APIResponseValidationSchema';
import { NextApiRequest, NextApiResponse } from 'next'; import { NextApiRequest, NextApiResponse } from 'next';
@@ -18,11 +19,7 @@ const router = createRouter<
router.get( router.get(
validateRequest({ validateRequest({
querySchema: z.object({ querySchema: PaginatedQueryResponseSchema.extend({ id: z.string().cuid() }),
page_size: z.string().min(1),
page_num: z.string().min(1),
id: z.string().min(1),
}),
}), }),
getAllBeersByBeerStyle, getAllBeersByBeerStyle,
); );

View File

@@ -8,6 +8,7 @@ import getCurrentUser from '@/config/nextConnect/middleware/getCurrentUser';
import { NextApiResponse } from 'next'; import { NextApiResponse } from 'next';
import CreateCommentValidationSchema from '@/services/schema/CommentSchema/CreateCommentValidationSchema'; import CreateCommentValidationSchema from '@/services/schema/CommentSchema/CreateCommentValidationSchema';
import { createComment, getAll } from '@/controllers/comments/beer-style-comments'; import { createComment, getAll } from '@/controllers/comments/beer-style-comments';
import PaginatedQueryResponseSchema from '@/services/schema/PaginatedQueryResponseSchema';
const router = createRouter< const router = createRouter<
// I don't want to use any, but I can't figure out how to get the types to work // 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( router.get(
validateRequest({ validateRequest({
querySchema: z.object({ querySchema: PaginatedQueryResponseSchema.extend({ id: z.string().cuid() }),
id: z.string().cuid(),
page_size: z.coerce.number().int().positive(),
page_num: z.coerce.number().int().positive(),
}),
}), }),
getAll, getAll,
); );

View File

@@ -2,6 +2,7 @@ import NextConnectOptions from '@/config/nextConnect/NextConnectOptions';
import validateRequest from '@/config/nextConnect/middleware/validateRequest'; import validateRequest from '@/config/nextConnect/middleware/validateRequest';
import { getAllBeersByBrewery } from '@/controllers/posts/breweries'; import { getAllBeersByBrewery } from '@/controllers/posts/breweries';
import { GetAllPostsByConnectedPostId } from '@/controllers/posts/types'; import { GetAllPostsByConnectedPostId } from '@/controllers/posts/types';
import PaginatedQueryResponseSchema from '@/services/schema/PaginatedQueryResponseSchema';
import APIResponseValidationSchema from '@/validation/APIResponseValidationSchema'; import APIResponseValidationSchema from '@/validation/APIResponseValidationSchema';
import { NextApiResponse } from 'next'; import { NextApiResponse } from 'next';
import { createRouter } from 'next-connect'; import { createRouter } from 'next-connect';
@@ -14,11 +15,7 @@ const router = createRouter<
router.get( router.get(
validateRequest({ validateRequest({
querySchema: z.object({ querySchema: PaginatedQueryResponseSchema.extend({ id: z.string().cuid() }),
page_size: z.string().nonempty(),
page_num: z.string().nonempty(),
id: z.string().nonempty(),
}),
}), }),
getAllBeersByBrewery, getAllBeersByBrewery,
); );

View File

@@ -9,6 +9,7 @@ import { NextApiResponse } from 'next';
import CreateCommentValidationSchema from '@/services/schema/CommentSchema/CreateCommentValidationSchema'; import CreateCommentValidationSchema from '@/services/schema/CommentSchema/CreateCommentValidationSchema';
import { createComment, getAll } from '@/controllers/comments/brewery-comments'; import { createComment, getAll } from '@/controllers/comments/brewery-comments';
import PaginatedQueryResponseSchema from '@/services/schema/PaginatedQueryResponseSchema';
const router = createRouter< const router = createRouter<
// I don't want to use any, but I can't figure out how to get the types to work // 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( router.get(
validateRequest({ validateRequest({
querySchema: z.object({ querySchema: PaginatedQueryResponseSchema.extend({ id: z.string().cuid() }),
id: z.string().cuid(),
page_size: z.coerce.number().int().positive(),
page_num: z.coerce.number().int().positive(),
}),
}), }),
getAll, getAll,
); );

View File

@@ -2,6 +2,7 @@ import NextConnectOptions from '@/config/nextConnect/NextConnectOptions';
import validateRequest from '@/config/nextConnect/middleware/validateRequest'; import validateRequest from '@/config/nextConnect/middleware/validateRequest';
import { getUserFollowers } from '@/controllers/users/profile'; import { getUserFollowers } from '@/controllers/users/profile';
import { GetUserFollowInfoRequest } from '@/controllers/users/profile/types'; import { GetUserFollowInfoRequest } from '@/controllers/users/profile/types';
import PaginatedQueryResponseSchema from '@/services/schema/PaginatedQueryResponseSchema';
import APIResponseValidationSchema from '@/validation/APIResponseValidationSchema'; import APIResponseValidationSchema from '@/validation/APIResponseValidationSchema';
import { NextApiResponse } from 'next'; import { NextApiResponse } from 'next';
@@ -15,11 +16,7 @@ const router = createRouter<
router.get( router.get(
validateRequest({ validateRequest({
querySchema: z.object({ querySchema: PaginatedQueryResponseSchema.extend({ id: z.string().cuid() }),
id: z.string().cuid(),
page_size: z.string().regex(/^\d+$/),
page_num: z.string().regex(/^\d+$/),
}),
}), }),
getUserFollowers, getUserFollowers,
); );

View File

@@ -2,6 +2,7 @@ import { UserExtendedNextApiRequest } from '@/config/auth/types';
import NextConnectOptions from '@/config/nextConnect/NextConnectOptions'; import NextConnectOptions from '@/config/nextConnect/NextConnectOptions';
import validateRequest from '@/config/nextConnect/middleware/validateRequest'; import validateRequest from '@/config/nextConnect/middleware/validateRequest';
import { getUsersFollowed } from '@/controllers/users/profile'; import { getUsersFollowed } from '@/controllers/users/profile';
import PaginatedQueryResponseSchema from '@/services/schema/PaginatedQueryResponseSchema';
import APIResponseValidationSchema from '@/validation/APIResponseValidationSchema'; import APIResponseValidationSchema from '@/validation/APIResponseValidationSchema';
import { NextApiResponse } from 'next'; import { NextApiResponse } from 'next';
@@ -19,11 +20,7 @@ const router = createRouter<
router.get( router.get(
validateRequest({ validateRequest({
querySchema: z.object({ querySchema: PaginatedQueryResponseSchema.extend({ id: z.string().cuid() }),
id: z.string().cuid(),
page_size: z.string().regex(/^\d+$/),
page_num: z.string().regex(/^\d+$/),
}),
}), }),
getUsersFollowed, getUsersFollowed,
); );

View File

@@ -1,8 +1,8 @@
import { z } from 'zod'; import { z } from 'zod';
const PaginatedQueryResponseSchema = z.object({ const PaginatedQueryResponseSchema = z.object({
page_num: z.string(), page_num: z.string().regex(/^\d+$/),
page_size: z.string(), page_size: z.string().regex(/^\d+$/),
}); });
export default PaginatedQueryResponseSchema; export default PaginatedQueryResponseSchema;