mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-11-21 03:26:07 +00:00
2d7392c4c0
Every integer column is bigint on Postgres. SQLite stored a fraction sent to one (a packing quantity of 1.5, a budget item for 2.5 days, an id of 3.5) as a REAL, while Postgres rounded it in a statement MikroORM renders and refused it with a 500 in a Kysely statement, so the engines held different data for the same request. The request schemas of those fields now take whole numbers only, and INTCOL (tests/unit/contracts/integer-columns.test.ts) holds the class: it reads the integer columns from the entities and fails on any DTO field or inline MCP tool field of that name that takes any number.
163 lines
7.4 KiB
TypeScript
163 lines
7.4 KiB
TypeScript
import { assignmentPlaceSchema } from '../place/place.schema';
|
|
import { stationKeySchema } from '../tours/tours.schema';
|
|
|
|
import { z } from 'zod';
|
|
|
|
/**
|
|
* Assignment API contract — single source of truth for the place↔day itinerary
|
|
* endpoints under /api/trips/:tripId/days/:dayId/assignments and
|
|
* /api/trips/:tripId/assignments/:id/*.
|
|
*
|
|
* Trip-scoped; mutations use the 'day_edit' permission. The server side is the
|
|
* DI-native AssignmentsService (server/src/nest/assignments/), validated via
|
|
* the createZodDto wrappers in assignments.dto.ts. Assignment rows carry
|
|
* joined place data and are kept open in responses; the request schemas + the
|
|
* bespoke 404 controller messages pin the rest.
|
|
*/
|
|
|
|
/**
|
|
* Assignment participant embedded on an assignment
|
|
* (server/src/services/queryHelpers.ts -> loadParticipantsByAssignmentIds).
|
|
*/
|
|
export const assignmentParticipantSchema = z.object({
|
|
user_id: z.number(),
|
|
username: z.string(),
|
|
avatar: z.string().nullable().optional(),
|
|
});
|
|
export type AssignmentParticipant = z.infer<typeof assignmentParticipantSchema>;
|
|
|
|
/**
|
|
* Assignment entity as returned by the day/assignment endpoints
|
|
* (server/src/services/queryHelpers.ts -> formatAssignmentWithPlace, and
|
|
* assignmentService.getAssignmentWithPlace). The embedded `place` is the trimmed
|
|
* assignment-place projection, NOT the full place pool entity. `assignment_time`
|
|
* /`assignment_end_time` carry the per-assignment override times.
|
|
*/
|
|
export const assignmentSchema = z.object({
|
|
id: z.number(),
|
|
day_id: z.number(),
|
|
place_id: z.number(),
|
|
order_index: z.number(),
|
|
notes: z.string().nullable().optional(),
|
|
assignment_time: z.string().nullable().optional(),
|
|
assignment_end_time: z.string().nullable().optional(),
|
|
end_day: z.boolean().optional(),
|
|
// How long the drive stands at this visit, in minutes (#3092). Null, or absent on an
|
|
// older server, reads the place's own duration_minutes, so a place planned twice can
|
|
// be stopped at on one visit and only driven past on the other.
|
|
stay_minutes: z.number().nullable().optional(),
|
|
// Per-segment travel mode (#1281): the transport mode of the leg LEAVING this
|
|
// stop for the next one. null = inherit the day's default_transport_mode.
|
|
leg_transport_mode: z.string().nullable().optional(),
|
|
// Per-segment travel mode of the leg ENTERING this stop when its origin is
|
|
// not a place (booking arrival / morning hotel). null = inherit the day default.
|
|
// Inert when the previous timeline element is a place.
|
|
incoming_leg_transport_mode: z.string().nullable().optional(),
|
|
// Kept on the day and on the map, but not part of the day's route (#2532).
|
|
route_excluded: z.boolean().optional(),
|
|
// The lodging booking that put this stop on the day, when one did. The day
|
|
// planner already shows that booking as its own overnight block, so it hides
|
|
// this row and leaves it to road trip mode, which is the view that needs the
|
|
// hotel in the driving chain. Null for every stop a traveller placed.
|
|
accommodation_id: z.number().nullable().optional(),
|
|
tour_place_id: z.number().nullable().optional(),
|
|
tour_route_geometry: z.string().nullable().optional(),
|
|
/**
|
|
* MDT-02: the stage of a multi-day tour this day holds, by the key of the
|
|
* stop the stage starts at; null where the day holds the whole tour or a place.
|
|
*/
|
|
tour_stage_key: z.string().nullable().optional(),
|
|
participants: z.array(assignmentParticipantSchema).optional(),
|
|
created_at: z.string().optional(),
|
|
place: assignmentPlaceSchema,
|
|
});
|
|
export type Assignment = z.infer<typeof assignmentSchema>;
|
|
|
|
export const assignmentCreateRequestSchema = z.object({
|
|
place_id: z.union([z.number().int(), z.string()]),
|
|
notes: z.string().nullable().optional(),
|
|
/**
|
|
* MDT-02: puts one stage of a multi-day tour on the day instead of the whole
|
|
* tour, by the key of the stop the stage starts at (the tour list's
|
|
* `stage_stops`). A stage is on one day at most.
|
|
*/
|
|
tour_stage_key: stationKeySchema.optional(),
|
|
});
|
|
export type AssignmentCreateRequest = z.infer<typeof assignmentCreateRequestSchema>;
|
|
|
|
export const assignmentReorderRequestSchema = z.object({
|
|
orderedIds: z.array(z.number()),
|
|
});
|
|
export type AssignmentReorderRequest = z.infer<typeof assignmentReorderRequestSchema>;
|
|
|
|
export const assignmentMoveRequestSchema = z.object({
|
|
new_day_id: z.union([z.number(), z.string()]),
|
|
// The client api types this `number | null` (assignmentsApi.move) and the
|
|
// legacy route accepted null (`orderIndex || 0`) — keep null on the wire.
|
|
order_index: z.number().int().nullable().optional(),
|
|
});
|
|
export type AssignmentMoveRequest = z.infer<typeof assignmentMoveRequestSchema>;
|
|
|
|
export const assignmentTimeRequestSchema = z.object({
|
|
place_time: z.string().nullable().optional(),
|
|
end_time: z.string().nullable().optional(),
|
|
});
|
|
export type AssignmentTimeRequest = z.infer<typeof assignmentTimeRequestSchema>;
|
|
|
|
export const assignmentEndDayRequestSchema = z.object({
|
|
end_day: z.boolean(),
|
|
});
|
|
export type AssignmentEndDayRequest = z.infer<typeof assignmentEndDayRequestSchema>;
|
|
|
|
/**
|
|
* PUT /:id/stay (#3092) — how long the drive stands at this one visit, in whole
|
|
* minutes, a week at most like the road trip's own stay bounds. Zero is a visit
|
|
* driven past without stopping; null hands the visit back to the stay its place
|
|
* carries (`places.duration_minutes`).
|
|
*/
|
|
export const assignmentStayRequestSchema = z.object({
|
|
stay_minutes: z.number().int().min(0).max(10_080).nullable(),
|
|
});
|
|
export type AssignmentStayRequest = z.infer<typeof assignmentStayRequestSchema>;
|
|
|
|
/** What a write to one assignment answers with: the assignment as the day list reads it. */
|
|
export const assignmentResponseSchema = z.object({
|
|
assignment: assignmentSchema,
|
|
});
|
|
export type AssignmentResponse = z.infer<typeof assignmentResponseSchema>;
|
|
|
|
/**
|
|
* PUT /:id/notes (#2163) — edit the per-assignment note after creation.
|
|
* Deliberately uncapped like the create contract above: the REST create body
|
|
* and the plugin RPC accept notes of any length, so a length cap here would
|
|
* strand an existing longer note as uneditable (the unchanged textarea would
|
|
* be rejected on save). Falsy values ('' or null) clear the column, the same
|
|
* `notes || null` normalisation createAssignment applies on the way in.
|
|
*/
|
|
export const assignmentNotesRequestSchema = z.object({
|
|
notes: z.string().nullable(),
|
|
});
|
|
export type AssignmentNotesRequest = z.infer<typeof assignmentNotesRequestSchema>;
|
|
|
|
/** Set the leg's travel mode (a RouteProfileKey, or null to inherit the day default). */
|
|
export const assignmentTransportRequestSchema = z.object({
|
|
// The legacy route read `body.transport_mode ?? null`, so an absent key
|
|
// behaves like an explicit null — keep it optional on the wire.
|
|
transport_mode: z.string().nullable().optional(),
|
|
// Which leg this write targets: the one leaving this stop (default, and the
|
|
// legacy behaviour) or the one arriving at it (#1281 boundary legs).
|
|
direction: z.enum(['outgoing', 'incoming']).default('outgoing'),
|
|
});
|
|
export type AssignmentTransportRequest = z.infer<typeof assignmentTransportRequestSchema>;
|
|
|
|
/** Take a stop out of the day's route, or put it back (#2532). */
|
|
export const assignmentRouteRequestSchema = z.object({
|
|
excluded: z.boolean(),
|
|
});
|
|
export type AssignmentRouteRequest = z.infer<typeof assignmentRouteRequestSchema>;
|
|
|
|
export const assignmentParticipantsRequestSchema = z.object({
|
|
user_ids: z.array(z.number()),
|
|
});
|
|
export type AssignmentParticipantsRequest = z.infer<typeof assignmentParticipantsRequestSchema>;
|