feat(booking): Introduce comprehensive booking DTO, refine form validation, and enhance API docs

apps/edr-freight-web/portal/src/pages/bookings/new-booking-form/schema.ts

@@ -141,9 +141,6 @@ export const BOOKING_DOCS_SETTING = {
   ],
 };
 
-const requiredString = (message: string) =>
-  z.string().trim().min(1, { message });
-
 const fileValueSchema = z.union([
   z.custom<File>(),
   z.array(z.custom<File>()),
@@ -152,10 +149,10 @@ const fileValueSchema = z.union([
 
 export const bookingFormSchema = z
   .object({
-    contractType: z.enum(["new", "renewal", ""]),
+    contractType: z.enum(["new", "renewal"], "Select a contract type."),
     previousContractRef: z.string(),
     draftContractId: z.string(),
-    serviceType: z.enum(["rail", "rail_forwarding", ""]),
+    serviceType: z.enum(["rail", "rail_forwarding"], "Select a service type."),
     firstMileEnabled: z.boolean(),
     pickUpAddress: z.string(),
     lastMileEnabled: z.boolean(),
@@ -163,9 +160,9 @@ export const bookingFormSchema = z
     equipmentReturn: z.enum(["with_return", "without_return"]),
     originYard: z.string(),
     destinationYard: z.string(),
-    cargoType: z.enum(["container", "bulk", ""]),
+    cargoType: z.enum(["container", "bulk"], "Select a cargo type."),
     cargoWeight: z.string(),
-    freightType: z.enum(["bulk", "break_bulk", ""]),
+    freightType: z.enum(["bulk", "break_bulk"]),
     bulkCommodity: z.string(),
     bulkCommodityOther: z.string(),
     breakBulkType: z.string(),
@@ -191,14 +188,6 @@ export const bookingFormSchema = z
     termsAccepted: z.boolean(),
   })
   .superRefine((data, ctx) => {
-    if (!data.contractType) {
-      ctx.addIssue({
-        code: "custom",
-        path: ["contractType"],
-        message: "Select a contract type.",
-      });
-    }
-
     if (data.contractType === "new" && !data.draftContractId.trim()) {
       ctx.addIssue({
         code: "custom",
@@ -215,14 +204,6 @@ export const bookingFormSchema = z
       });
     }
 
-    if (!data.serviceType) {
-      ctx.addIssue({
-        code: "custom",
-        path: ["serviceType"],
-        message: "Select a service type.",
-      });
-    }
-
     if (data.firstMileEnabled && !data.pickUpAddress.trim()) {
       ctx.addIssue({
         code: "custom",
@@ -267,14 +248,6 @@ export const bookingFormSchema = z
       });
     }
 
-    if (!data.cargoType) {
-      ctx.addIssue({
-        code: "custom",
-        path: ["cargoType"],
-        message: "Select a cargo type.",
-      });
-    }
-
     if (data.cargoType === "bulk") {
       if (!data.freightType) {
         ctx.addIssue({
@@ -385,11 +358,9 @@ export const bookingFormSchema = z
 
 export type BookingFormValues = z.infer<typeof bookingFormSchema>;
 
-export const initialBookingFormValues: BookingFormValues = {
-  contractType: "",
+export const initialBookingFormValues: Partial<BookingFormValues> = {
   previousContractRef: "",
   draftContractId: "",
-  serviceType: "",
   firstMileEnabled: false,
   pickUpAddress: "",
   lastMileEnabled: false,
@@ -397,9 +368,7 @@ export const initialBookingFormValues: BookingFormValues = {
   equipmentReturn: "with_return",
   originYard: "",
   destinationYard: "",
-  cargoType: "",
   cargoWeight: "",
-  freightType: "",
   bulkCommodity: "",
   bulkCommodityOther: "",
   breakBulkType: "",

apps/edr-freight-web/portal/src/services/bookings.service.ts

@@ -2,13 +2,7 @@ import type { Freight, PaginatedResponse } from "@edr/types";
 
 import { api } from "./crud";
 
-export interface CreateBookingPayload {
-  reference: string;
-  customerId: string;
-  scheduledDate: string;
-  totalAmount: number;
-  trainId?: string;
-}
+export type CreateBookingPayload = Freight.CreateBookingDto;
 
 export const bookingsService = {
   list: async (): Promise<PaginatedResponse<Freight.IBooking>> => {

apps/edr-freight-web/portal/src/services/consignments.service.ts

@@ -1,14 +1,14 @@
 import type { Freight, PaginatedResponse } from "@edr/types";
 
-import { api } from "../utils/api";
+import { client } from "../utils/api";
 
 export const consignmentsService = {
   list: async (): Promise<PaginatedResponse<Freight.IConsignment>> => {
-    const { data } = await api.get("/consignments");
+    const { data } = await client.get("/consignments");
     return data.data;
   },
   get: async (id: string): Promise<Freight.IConsignment> => {
-    const { data } = await api.get(`/consignments/${id}`);
+    const { data } = await client.get(`/consignments/${id}`);
     return data.data;
   },
 };