import {z} from 'zod' export type GetApiApiV2TransportVesselsHistoryDensityArgs = {bbox?: string | undefined, date?: string | undefined}; export type GetApiApiV2TransportVesselsHistoryDensityOptions = {baseUrl?: string | undefined, APIKeyHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const aisGridCell = z.object({lat_bin: z.number(), lon_bin: z.number(), vessel_count: z.number().int(), by_ship_type: z.record(z.string(), z.number().int()).optional()}); export const aisAttribution = z.object({source: z.string(), license: z.string(), license_url: z.string(), attribution_text: z.string(), modified: z.boolean(), original_url: z.string()}); export const aisHistoryDensityData = z.object({coverage_label: z.string().optional(), as_of_date: z.string(), lag_note: z.string().optional(), grid: z.array(aisGridCell), sources: z.array(aisAttribution), stale: z.boolean()}); export const sugraMeta = z.object({endpoint: z.string(), data_time: z.string(), response_time: z.string(), provider: z.string(), data_age_days: z.number().nullable().optional(), source: z.string().nullable().optional(), attribution: z.string().nullable().optional(), source_url: z.string().nullable().optional(), citation: z.string().nullable().optional(), fallback_used: z.boolean().nullable().optional(), fallback_chain: z.array(z.string()).nullable().optional(), cached: z.boolean().nullable().optional(), stale: z.boolean().nullable().optional(), stale_since: z.string().nullable().optional(), period: z.string().nullable().optional(), notes: z.string().nullable().optional()}); export const envelopeAisHistoryDensityData = z.object({data: aisHistoryDensityData, meta: sugraMeta}); 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 }; /** * Historical AIS vessel-density grid (US, months-lagged analytics) * * GET /api/v2/transport/vessels/history/density */ export const getApiApiV2TransportVesselsHistoryDensity = async (args: GetApiApiV2TransportVesselsHistoryDensityArgs, options?: GetApiApiV2TransportVesselsHistoryDensityOptions) => { const {baseUrl = "https://sugra.ai", fetch: fetchFn = fetch, APIKeyHeader} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.bbox != null) query.append("bbox", String(args.bbox)) if (args.date != null) query.append("date", String(args.date)) if (APIKeyHeader !== undefined) headers.set("x-api-key", APIKeyHeader) const url = `${baseUrl.replace(/\/+$/, '')}/api/v2/transport/vessels/history/density${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(envelopeAisHistoryDensityData, await res.json()) };