import {z} from 'zod' export type ImageAttachmentUpload = {type: 'image', caption: string, data: string, attachment_id?: (string | null) | undefined}; export type NoteAttachmentUpload = {type: 'note', data: string, attachment_id?: (string | null) | undefined}; export type SignatureAttachmentUpload = {type: 'signature', data: string, attachment_id?: (string | null) | undefined}; export type GetApiVisitsArgs = {visit_id?: (string | null) | undefined, geofence_id?: (string | null) | undefined, driver_handle?: (string | null) | undefined, worker_handle?: (string | null) | undefined, device_id?: (string | null) | undefined, order_handle?: (string | null) | undefined, place_handle?: (string | null) | undefined, pagination_token?: (string | null) | undefined, visited_at_from?: (string | null) | undefined, visited_at_to?: (string | null) | undefined, metadata_filter?: (unknown | null) | undefined, region_filter?: (unknown | null) | undefined, search_term?: (string | null) | undefined, aggregate?: boolean | undefined, arrived_at_date_without_tz_from?: (string | null) | undefined, arrived_at_date_without_tz_to?: (string | null) | undefined, limit?: (number | null) | undefined, ops_group_handles?: (string | null) | undefined, attachments?: (Array | null) | undefined}; export type GetApiVisitsOptions = {baseUrl?: string | undefined, BasicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const serviceStatsInfo = z.object({duration: z.number().int().nullable().optional(), distance: z.number().int().nullable().optional(), outage_duration: z.number().int().nullable().optional(), outage: z.record(z.string(), z.unknown()).nullable().optional(), tracking_rate: z.number().nullable().optional()}); export const enrouteStatsInfo = z.object({duration: z.number().int().nullable().optional(), distance: z.number().int().nullable().optional(), idle_time: z.number().int().nullable().optional(), outage_duration: z.number().int().nullable().optional(), outage_distance: z.number().int().nullable().optional(), outage: z.record(z.string(), z.unknown()).nullable().optional(), tracking_rate: z.number().nullable().optional()}); export const locationGeometry = z.object({type: z.literal("Point"), coordinates: z.array(z.number())}); export const locationInfo = z.object({location: z.union([locationGeometry, z.unknown()]).optional(), recorded_at: z.string(), location_accuracy: z.number().nullable().optional()}); export const anyLocationGeometry = z.object({type: z.enum(["Point", "Polygon"]), coordinates: z.array(z.unknown())}); export const visitGeometryModel = z.object({radius: z.number().int(), geometry: anyLocationGeometry}); export const imageAttachmentResponse = z.object({type: z.literal("image"), url: z.string(), caption: z.string().nullable().optional(), attachment_id: z.string().nullable().optional()}); export const noteAttachmentResponse = z.object({type: z.literal("note"), data: z.string(), attachment_id: z.string().nullable().optional()}); export const signatureAttachmentResponse = z.object({type: z.literal("signature"), url: z.string(), attachment_id: z.string().nullable().optional()}); export const visit = z.object({visit_id: z.string(), created_at: z.string(), updated_at: z.string().nullable().optional(), geofence_id: z.string(), driver_handle: z.string().optional(), worker_handle: z.string().optional(), worker_name: z.string().nullable().optional(), worker_profile: z.record(z.string(), z.unknown()).nullable().optional(), device_id: z.string().nullable().optional(), order_handle: z.string(), place_handle: z.string().nullable().optional(), ops_group_handle: z.string(), arrival: z.union([locationInfo, z.unknown()]).optional(), exit: z.union([locationInfo, z.unknown()]).optional(), enroute: z.union([enrouteStatsInfo, z.unknown()]).optional(), service: z.union([serviceStatsInfo, z.unknown()]).optional(), metadata: z.record(z.string(), z.unknown()).nullable().optional(), geofence_metadata: z.record(z.string(), z.unknown()).nullable().optional(), tracking_rate: z.number().optional(), system_generated_order_handle: z.boolean().nullable().optional(), visit_geometry: z.union([visitGeometryModel, z.unknown()]).optional(), geofence_address: z.string().nullable().optional(), timezone: z.string().nullable().optional(), attachments: z.array(z.union([imageAttachmentResponse, noteAttachmentResponse, signatureAttachmentResponse])).nullable().optional()}); export const visitOrder = z.object({order_handle: z.string(), service: serviceStatsInfo, enroute: enrouteStatsInfo, driver_handle: z.string().optional(), tracking_rate: z.number().optional(), worker_handle: z.string().optional(), system_generated_order_handle: z.boolean().nullable().optional(), ops_group_handle: z.string().optional(), visits: z.array(visit).optional()}); export const visitsAggregate = z.object({count: z.number().int().optional()}); export const workersAggregate = z.object({count: z.number().int().optional()}); export const visitOrderAggregate = z.object({count: z.number().int(), tracking_rate: z.number().optional(), visits: visitsAggregate.optional(), workers: workersAggregate.optional()}); export const getVisitsResponse = z.object({orders: z.array(visitOrder).nullable().optional(), pagination_token: z.string().nullable().optional(), aggregate: z.union([visitOrderAggregate, z.unknown()]).optional()}); 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 }; /** * Get Visits * * GET /visits/ * * Also accepts auth: TokenAuth */ export const getApiVisits = async (args: GetApiVisitsArgs, options?: GetApiVisitsOptions) => { 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.visit_id != null) query.append("visit_id", String(args.visit_id)) if (args.geofence_id != null) query.append("geofence_id", String(args.geofence_id)) if (args.driver_handle != null) query.append("driver_handle", String(args.driver_handle)) if (args.worker_handle != null) query.append("worker_handle", String(args.worker_handle)) if (args.device_id != null) query.append("device_id", String(args.device_id)) if (args.order_handle != null) query.append("order_handle", String(args.order_handle)) if (args.place_handle != null) query.append("place_handle", String(args.place_handle)) if (args.pagination_token != null) query.append("pagination_token", String(args.pagination_token)) if (args.visited_at_from != null) query.append("visited_at_from", String(args.visited_at_from)) if (args.visited_at_to != null) query.append("visited_at_to", String(args.visited_at_to)) if (args.metadata_filter != null) query.append("metadata_filter", String(args.metadata_filter)) if (args.region_filter != null) query.append("region_filter", String(args.region_filter)) if (args.search_term != null) query.append("search_term", String(args.search_term)) if (args.aggregate != null) query.append("aggregate", String(args.aggregate)) if (args.arrived_at_date_without_tz_from != null) query.append("arrived_at_date_without_tz_from", String(args.arrived_at_date_without_tz_from)) if (args.arrived_at_date_without_tz_to != null) query.append("arrived_at_date_without_tz_to", String(args.arrived_at_date_without_tz_to)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.ops_group_handles != null) query.append("ops_group_handles", String(args.ops_group_handles)) for (const item of args.attachments ?? []) query.append("attachments", String(item)) if (BasicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${BasicAuth.username}:${BasicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/visits/${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(getVisitsResponse, await res.json()) };