Skip to content

refactor: strictly type return types in backend routes #698

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
br-Chan wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

refactor: strictly type return types in backend routes #698

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a9f2b1e
refactor: strictly type PATCH booking with extended CommonResponse type
br-Chan Aug 5, 2025
961d041
feat: implement possible change to booking common response schema
br-Chan Aug 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions apps/backend/src/app/api/admin/bookings/[id]/route.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { UpdateBookingRequestSchema } from "@repo/shared"
import { type CommonBookingResponse, UpdateBookingRequestSchema } from "@repo/shared"
import { getReasonPhrase, StatusCodes } from "http-status-codes"
import { type NextRequest, NextResponse } from "next/server"
import { NotFound } from "payload"
Expand All @@ -15,7 +15,10 @@ class BookingsRouteWrapper {
* @returns The updated {@link Booking} document, otherwise an appropriate error response.
*/
@Security("jwt", ["admin"])
static async PATCH(req: NextRequest, { params }: { params: Promise<{ id: string }> }) {
static async PATCH(
req: NextRequest,
{ params }: { params: Promise<{ id: string }> },
): Promise<NextResponse<CommonBookingResponse>> {
try {
const parsedBody = UpdateBookingRequestSchema.parse(await req.json())
const bookingDataService = new BookingDataService()
Expand Down
9 changes: 7 additions & 2 deletions packages/shared/src/schemas/booking.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
import { z } from "zod"
import { type EditBookingData, PlayLevel } from "../types"
import type { EditBookingData } from "../types"
import { GameSessionSchema } from "./game-session"
import { CommonResponseSchema } from "./response"
import { UserSchema } from "./user"

export const BookingSchema = z.object({
id: z.string(),
user: z.union([z.string(), UserSchema]),
gameSession: z.union([z.string(), GameSessionSchema]),
playerLevel: z.nativeEnum(PlayLevel),
playerLevel: z.enum(["beginner", "intermediate", "advanced"]),
Copy link

Copilot AI Aug 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The hardcoded string literals for player levels replace the imported PlayLevel enum, which reduces type safety and maintainability. Consider keeping the enum import and using z.nativeEnum(PlayLevel) to maintain consistency with the type system.

Copilot uses AI. Check for mistakes.
updatedAt: z.string(),
createdAt: z.string(),
})
Expand All @@ -23,5 +24,9 @@ export const GetBookingsResponseSchema = z.object({
data: z.array(BookingSchema),
})

export const CommonBookingResponseSchema = CommonResponseSchema.extend({
data: BookingSchema.optional(),
})

export const UpdateBookingRequestSchema =
CreateBookingRequestSchema.partial() satisfies z.ZodType<EditBookingData>
8 changes: 7 additions & 1 deletion packages/shared/src/types/booking.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
import type z from "zod"
import type { BookingSchema, CreateBookingRequestSchema } from "../schemas"
import type {
BookingSchema,
CommonBookingResponseSchema,
CreateBookingRequestSchema,
} from "../schemas"

export type BookingType = z.infer<typeof BookingSchema>

export type CreateBookingRequest = z.infer<typeof CreateBookingRequestSchema>

export type CommonBookingResponse = z.infer<typeof CommonBookingResponseSchema>