trails-cool/trails
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

one source of truth for Route/Activity shapes; enforce api contracts

Browse source 
Route and Activity existed three times: hand-written interfaces in
packages/types, Zod contracts in packages/api, and Drizzle columns in
packages/db — each with different fields and nullability. The
hand-written ones had drifted so far they had zero importers; the Zod
contracts were advisory because v1 handlers hand-rolled Response.json
shapes nothing validated.

- packages/types keeps only what both apps actually share (Waypoint,
  WaypointPoiTags) and documents where row types and wire contracts
  live; the dead Route/RouteMetadata/RouteVersion/Activity interfaces
  are gone
- packages/db exports canonical inferred row types (RouteRow,
  ActivityRow, RouteVersionRow, UserRow)
- packages/api contracts are reconciled with the real wire format
  (RouteVersionSchema gains the id and createdBy fields the endpoint
  has always returned) and gain Create*ResponseSchemas
- apiJson(schema, payload) in api-guard parses every v1 response
  through its contract: drift is now a thrown ZodError in tests/CI,
  unknown keys are stripped, and payloads are compile-checked as
  z.input of the schema

Enforcement immediately caught two real drifts: nullable DB
descriptions could ship null where the contract promises string (now
coalesced at the boundary), and GET /api/v1/activities/:id was missing
the routeName and photos fields its contract declares.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Ullrich Schäfer 2026-06-10 07:39:50 +02:00
parent 1a65b40d18
commit 61a2d0085b
No known key found for this signature in database
GPG key ID: A32FF691A0F752D9
11 changed files with 83 additions and 73 deletions
Download patch file Download diff file Expand all files Collapse all files

4
packages/api/src/activities.ts
View file

@ -39,7 +39,11 @@ export const CreateActivityRequestSchema = z.object({
distance: z.number().optional(),
});
/** Response to POST /api/v1/activities */
export const CreateActivityResponseSchema = z.object({ id: z.uuid() });
export type ActivitySummary = z.infer<typeof ActivitySummarySchema>;
export type CreateActivityResponse = z.infer<typeof CreateActivityResponseSchema>;
export type ActivityDetail = z.infer<typeof ActivityDetailSchema>;
export type ActivityListResponse = z.infer<typeof ActivityListResponseSchema>;
export type CreateActivityRequest = z.infer<typeof CreateActivityRequestSchema>;