aboutsummaryrefslogtreecommitdiff
path: root/src/frontend/app/api/schema.ts
blob: 40358a65495472e10a543a899d6a6ca955144a7d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
import { z } from "zod";

export const RouteInfoSchema = z.object({
  gtfsId: z.string().optional().nullable(),
  shortName: z.string(),
  colour: z.string(),
  textColour: z.string(),
});

export const HeadsignInfoSchema = z.object({
  badge: z.string().optional().nullable(),
  destination: z.string().nullable(),
  marquee: z.string().optional().nullable(),
});

export const ArrivalPrecisionSchema = z.enum([
  "confident",
  "unsure",
  "scheduled",
  "past",
]);

export const ArrivalDetailsSchema = z.object({
  minutes: z.number().int(),
  precision: ArrivalPrecisionSchema,
});

export const DelayBadgeSchema = z.object({
  minutes: z.number(),
});

export const ShiftBadgeSchema = z.object({
  shiftName: z.string(),
  shiftTrip: z.string(),
});

export const PositionSchema = z.object({
  latitude: z.number(),
  longitude: z.number(),
  orientationDegrees: z.number().optional().nullable(),
  shapeIndex: z.number().optional().nullable(),
});

export const BusStopUsagePointSchema = z.object({
  h: z.number().int(),
  t: z.number().int(),
  d: z.number().int(),
});

export const VehicleInformationSchema = z.object({
  identifier: z.string(),
  make: z.string().optional().nullable(),
  model: z.string().optional().nullable(),
  kind: z.string().optional().nullable(),
  year: z.string().optional().nullable(),
});

export const ArrivalSchema = z.object({
  tripId: z.string(),
  route: RouteInfoSchema,
  headsign: HeadsignInfoSchema,
  estimate: ArrivalDetailsSchema,
  delay: DelayBadgeSchema.optional().nullable(),
  shift: ShiftBadgeSchema.optional().nullable(),
  shape: z.any().optional().nullable(),
  currentPosition: PositionSchema.optional().nullable(),
  vehicleInformation: VehicleInformationSchema.optional().nullable(),
  operator: z.string().nullable(),
});

export const ArrivalEstimateSchema = z.object({
  tripId: z.string(),
  patternId: z.string().optional().nullable(),
  estimate: ArrivalDetailsSchema,
  delay: DelayBadgeSchema.optional().nullable(),
});

export const StopArrivalsResponseSchema = z.object({
  stopCode: z.string(),
  stopName: z.string(),
  stopLocation: PositionSchema.optional().nullable(),
  routes: z.array(RouteInfoSchema),
  arrivals: z.array(ArrivalSchema),
  usage: z.array(BusStopUsagePointSchema).optional().nullable(),
});

export const StopEstimatesResponseSchema = z.object({
  arrivals: z.array(ArrivalEstimateSchema),
});

export type RouteInfo = z.infer<typeof RouteInfoSchema>;
export type HeadsignInfo = z.infer<typeof HeadsignInfoSchema>;
export type ArrivalPrecision = z.infer<typeof ArrivalPrecisionSchema>;
export type ArrivalDetails = z.infer<typeof ArrivalDetailsSchema>;
export type DelayBadge = z.infer<typeof DelayBadgeSchema>;
export type ShiftBadge = z.infer<typeof ShiftBadgeSchema>;
export type Position = z.infer<typeof PositionSchema>;
export type Arrival = z.infer<typeof ArrivalSchema>;
export type ArrivalEstimate = z.infer<typeof ArrivalEstimateSchema>;
export type BusStopUsagePoint = z.infer<typeof BusStopUsagePointSchema>;
export type StopArrivalsResponse = z.infer<typeof StopArrivalsResponseSchema>;
export type StopEstimatesResponse = z.infer<typeof StopEstimatesResponseSchema>;

// Transit Routes
export const RouteSchema = z.object({
  id: z.string(),
  shortName: z.string().nullable(),
  longName: z.string().nullable(),
  color: z.string().nullable(),
  textColor: z.string().nullable(),
  sortOrder: z.number().nullable(),
  agencyName: z.string().nullable().optional(),
  agencyId: z.string().nullable().optional(),
  tripCount: z.number(),
});

export const PatternStopSchema = z.object({
  id: z.string(),
  code: z.string().nullable(),
  name: z.string(),
  lat: z.number(),
  lon: z.number(),
  scheduledDepartures: z.array(z.number()),
  pickupType: z.string().optional().nullable(),
  dropOffType: z.string().optional().nullable(),
});

export const PatternSchema = z.object({
  id: z.string(),
  name: z.string().nullable(),
  headsign: z.string().nullable(),
  directionId: z.number(),
  code: z.string().nullable(),
  semanticHash: z.string().nullable(),
  tripCount: z.number(),
  geometry: z.array(z.array(z.number())).nullable(),
  stops: z.array(PatternStopSchema),
});

export const RouteDetailsSchema = z.object({
  shortName: z.string().nullable(),
  longName: z.string().nullable(),
  color: z.string().nullable(),
  textColor: z.string().nullable(),
  agencyName: z.string().nullable().optional(),
  patterns: z.array(PatternSchema),
});

export type Route = z.infer<typeof RouteSchema>;
export type PatternStop = z.infer<typeof PatternStopSchema>;
export type Pattern = z.infer<typeof PatternSchema>;
export type RouteDetails = z.infer<typeof RouteDetailsSchema>;

// Consolidated Circulation (Legacy/Alternative API)
export const ConsolidatedCirculationSchema = z.object({
  line: z.string(),
  route: z.string(),
  schedule: z
    .object({
      running: z.boolean(),
      minutes: z.number(),
      serviceId: z.string(),
      tripId: z.string(),
      shapeId: z.string().optional().nullable(),
    })
    .optional()
    .nullable(),
  realTime: z
    .object({
      minutes: z.number(),
      distance: z.number(),
    })
    .optional()
    .nullable(),
  currentPosition: z
    .object({
      latitude: z.number(),
      longitude: z.number(),
      orientationDegrees: z.number(),
      shapeIndex: z.number().optional().nullable(),
    })
    .optional()
    .nullable(),
  isPreviousTrip: z.boolean().optional().nullable(),
  previousTripShapeId: z.string().optional().nullable(),
  nextStreets: z.array(z.string()).optional().nullable(),
});

export type ConsolidatedCirculation = z.infer<
  typeof ConsolidatedCirculationSchema
>;

// Route Planner
export const PlannerPlaceSchema = z.object({
  name: z.string().optional().nullable(),
  lat: z.number(),
  lon: z.number(),
  stopId: z.string().optional().nullable(),
  stopCode: z.string().optional().nullable(),
  zoneId: z.string().optional().nullable(),
});

export const PlannerGeometrySchema = z.object({
  type: z.string(),
  coordinates: z.array(z.array(z.number())),
});

export const PlannerStepSchema = z.object({
  distanceMeters: z.number(),
  relativeDirection: z.string().optional().nullable(),
  absoluteDirection: z.string().optional().nullable(),
  streetName: z.string().optional().nullable(),
  lat: z.number(),
  lon: z.number(),
});

export const PlannerLegSchema = z.object({
  mode: z.string().optional().nullable(),
  feedId: z.string().optional().nullable(),
  routeId: z.string().optional().nullable(),
  tripId: z.string().optional().nullable(),
  routeName: z.string().optional().nullable(),
  routeShortName: z.string().optional().nullable(),
  routeLongName: z.string().optional().nullable(),
  routeColor: z.string().optional().nullable(),
  routeTextColor: z.string().optional().nullable(),
  headsign: z.string().optional().nullable(),
  agencyName: z.string().optional().nullable(),
  from: PlannerPlaceSchema.optional().nullable(),
  to: PlannerPlaceSchema.optional().nullable(),
  startTime: z.string(),
  endTime: z.string(),
  distanceMeters: z.number(),
  geometry: PlannerGeometrySchema.optional().nullable(),
  steps: z.array(PlannerStepSchema),
  intermediateStops: z.array(PlannerPlaceSchema),
});

export const ItinerarySchema = z.object({
  durationSeconds: z.number(),
  startTime: z.string(),
  endTime: z.string(),
  walkDistanceMeters: z.number(),
  walkTimeSeconds: z.number(),
  transitTimeSeconds: z.number(),
  waitingTimeSeconds: z.number(),
  legs: z.array(PlannerLegSchema),
  cashFare: z.number().optional().nullable(),
  cashFareIsTotal: z.boolean().optional().nullable(),
  cardFare: z.number().optional().nullable(),
  cardFareIsTotal: z.boolean().optional().nullable(),
});

export const RoutePlanSchema = z.object({
  itineraries: z.array(ItinerarySchema),
  timeOffsetSeconds: z.number().optional().nullable(),
});

export type PlannerPlace = z.infer<typeof PlannerPlaceSchema>;
export type PlannerGeometry = z.infer<typeof PlannerGeometrySchema>;
export type PlannerStep = z.infer<typeof PlannerStepSchema>;
export type PlannerLeg = z.infer<typeof PlannerLegSchema>;
export type Itinerary = z.infer<typeof ItinerarySchema>;
export type RoutePlan = z.infer<typeof RoutePlanSchema>;