import {z} from 'zod' export type GetApiOrdersEstimateArgs = {ops_group_handle: string, orders: string}; export type GetApiOrdersEstimateOptions = {baseUrl?: string | undefined, BasicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const estimatePolyline = z.object({type: z.string(), coordinates: z.array(z.array(z.unknown()))}); export const locationGeometryResponse = z.object({type: z.string(), coordinates: z.array(z.unknown())}); export const routeDetailEstimate = z.object({start_by: z.string().nullable().optional(), distance: z.number().int(), duration: z.number().int(), polyline: estimatePolyline, start_location: z.union([locationGeometryResponse, z.unknown()]).optional(), end_location: z.union([locationGeometryResponse, z.unknown()]).optional()}); export const pointGeometry = z.object({coordinates: z.array(z.number()), type: z.literal("Point").optional()}); export const polygonGeometry = z.object({type: z.literal("Polygon"), coordinates: z.array(z.array(z.array(z.number())))}); export const orderDestinationSpecialType = z.object({geofence_id: z.string().nullable().optional(), place_handle: z.string().nullable().optional(), address: z.string().nullable().optional(), geometry: z.union([pointGeometry, polygonGeometry]), place_id: z.string().nullable().optional(), radius: z.number().int().nullable().optional()}); export const region = z.object({country: z.string(), city: z.string().nullable().optional(), state: z.string().nullable().optional()}); export const driverLocation = z.object({geometry: locationGeometryResponse, bearing: z.number(), accuracy: z.number(), speed: z.number(), recorded_at: z.string()}); export const orderListEstimate = z.object({start_at: z.string().nullable().optional(), start_by: z.string().nullable().optional(), arrive_at: z.string().nullable().optional(), distance: z.number().int().nullable().optional(), duration: z.number().int().nullable().optional(), initial_arrive_at: z.string().nullable().optional(), current_worker_location: z.union([driverLocation, z.unknown()]).optional()}); export const source = z.object({source: z.string().nullable().optional(), timestamp: z.string().nullable().optional(), "ip-address": z.string().nullable().optional(), device_id: z.string().nullable().optional(), driver_handle: z.string().nullable().optional(), user_id: z.string().nullable().optional(), email: z.string().nullable().optional()}); export const orderOutageSummary = z.object({duration: z.number().int(), distance: z.number().int().optional(), code: z.string(), label: z.string(), description: z.string(), category: z.enum(["behavioural", "adversarial", "reachability", "os", "sporadic", "null"]).nullable().optional()}); export const orderTask = z.object({label: z.string(), task_definition_id: z.string().nullable().optional(), description: z.string().nullable().optional(), metadata: z.record(z.string(), z.unknown()).nullable().optional(), priority: z.enum(["none", "low", "medium", "high", "null"]).nullable().optional(), task_id: z.string(), status: z.string().nullable().optional()}); export const breakEntry = z.object({type: z.string(), start_time: z.string(), end_time: z.string(), duration: z.number().int()}); export const hypertrackLocationTimesheet = z.object({source: z.string(), type: z.string(), start_time: z.string().nullable().optional(), end_time: z.string().nullable().optional(), total_duration_on_premises: z.number().int(), total_break_duration: z.number().int(), breaks: z.array(breakEntry).nullable().optional(), finalized: z.boolean()}); export const order = z.object({order_handle: z.string(), status: z.enum(["planned", "assigned", "dispatched", "ongoing", "disabled", "cancelled", "completed", "summarizing", "unplanned"]), destination: orderDestinationSpecialType, fulfillment_attempt: z.number().int().nullable().optional(), risk_status: z.boolean().nullable().optional(), ops_group_handle: z.string().nullable().optional(), plan_mode: z.unknown(), plan_id: z.string().nullable().optional(), planning_failure_reason: z.string().nullable().optional(), device_id: z.string().nullable().optional(), driver_handle: z.string().nullable().optional(), worker_handle: z.string().nullable().optional(), place_handle: z.string().nullable().optional(), created_at: z.string().nullable().optional(), started_at: z.string().nullable().optional(), assigned_at: z.string().nullable().optional(), driver_name: z.string().nullable().optional(), planned_at: z.string().nullable().optional(), scheduled_at: z.string().nullable().optional(), scheduled_after: z.string().nullable().optional(), completed_at: z.string().nullable().optional(), cancelled_at: z.string().nullable().optional(), disabled_at: z.string().nullable().optional(), enabled_at: z.string().nullable().optional(), arrived_at: z.string().nullable().optional(), exited_at: z.string().nullable().optional(), metadata: z.record(z.string(), z.unknown()).nullable().optional(), risks: z.record(z.string(), z.unknown()).nullable().optional(), expected_service_time: z.number().int().nullable().optional(), product_type: z.array(z.string()).nullable().optional(), type: z.unknown(), type_index: z.number().int().nullable().optional(), capacity_used: z.number().int().nullable().optional(), region: z.union([region, z.unknown()]).optional(), distance: z.number().int().nullable().optional(), duration: z.number().int().nullable().optional(), estimate: z.union([orderListEstimate, z.unknown()]).optional(), share_url: z.string().nullable().optional(), route_handle: z.string().nullable().optional(), track_mode: z.unknown(), actual_service_time: z.number().int().nullable().optional(), tracked_service_time: z.number().int().nullable().optional(), tracking_rate: z.number().nullable().optional(), time_to_first_event: z.number().nullable().optional(), time_to_first_location: z.number().nullable().optional(), created_by: z.union([source, z.unknown()]).optional(), outage_summary: z.array(orderOutageSummary).nullable().optional(), embed_url: z.string().nullable().optional(), device_switch_mode: z.unknown(), tasks: z.array(orderTask).nullable().optional(), priority: z.unknown(), worker_profile: z.record(z.string(), z.unknown()).nullable().optional(), rescheduled_marked_at: z.string().nullable().optional(), cancellation_source: z.record(z.string(), z.unknown()).nullable().optional(), cancellation_reason: z.string().nullable().optional(), timesheets: z.array(z.union([hypertrackLocationTimesheet, z.record(z.string(), z.unknown())])).nullable().optional()}); export const estimateRouteResponse = z.object({estimate: routeDetailEstimate, orders: z.array(order)}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Estimate Route * * GET /orders/estimate * * Also accepts auth: TokenAuth */ export const getApiOrdersEstimate = async (args: GetApiOrdersEstimateArgs, options?: GetApiOrdersEstimateOptions) => { const {baseUrl = "https://v3.api.hypertrack.com", fetch: fetchFn = fetch, BasicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.ops_group_handle != null) query.append("ops_group_handle", String(args.ops_group_handle)) if (args.orders != null) query.append("orders", String(args.orders)) if (BasicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${BasicAuth.username}:${BasicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/orders/estimate${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(estimateRouteResponse, await res.json()) };