import {z} from 'zod' export type GetApiApiV1MaritimeChokepointsHormuzImportFloorOptions = {baseUrl?: string | undefined, APIKeyHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const floorCoverage = z.object({importers_in: z.array(z.string()), importers_not_yet: z.record(z.string(), z.string()), coverage_share: z.unknown(), coverage_share_reason: z.string().min(1), observed_gulf_origin_mbd: z.number(), observed_hormuz_required_mbd: z.number(), binds_ais_42: z.boolean(), binds_ais_42_reason: z.string().min(1)}); export const floorOrigin = z.object({country: z.string().min(1), iso2: z.string(), status: z.string(), native: z.number().nullable().optional(), native_unit: z.string().min(1), barrels: z.number().nullable().optional(), hormuz_required: z.boolean(), routes_avoiding_hormuz: z.array(z.string())}); export const floorImporter = z.object({name: z.string().min(1), source: z.string().min(1), latest_period: z.string(), days_in_latest_period: z.number().int().gte(28).lte(31), origins: z.record(z.string(), floorOrigin), gulf_origin_mbd: z.number(), hormuz_required_mbd: z.number(), gulf_origin_transits_per_day: z.number(), hormuz_required_transits_per_day: z.number(), source_url: z.string().nullable().optional(), kl_to_bbl: z.number().nullable().optional(), periods: z.array(z.string()).nullable().optional(), not_in_file: z.array(z.string()).nullable().optional(), dataset: z.string().nullable().optional(), siec: z.string().nullable().optional(), geo: z.string().nullable().optional(), tonne_to_bbl: z.number().nullable().optional(), tonne_to_bbl_note: z.string().nullable().optional()}); export const hormuzImportFloorData = z.object({source: z.string(), product: z.string(), measure: z.string(), unit: z.string(), region: z.string(), latest_period: z.string(), latest_period_note: z.string().min(1), months_since_latest_period: z.number().int().gte(0).nullable().optional(), observation_months_mixed: z.boolean(), floor_period_claim: z.string().min(1), cargo_assumption_mmbbl: z.number(), cargo_assumption_note: z.string().min(1), ballast_multiplier: z.number().int(), round_trip_transits_per_day: z.number(), round_trip_note: z.string().min(1), floor_transits_per_day: z.number(), gulf_origin_transits_per_day: z.number(), aligned_period: z.string().nullable().optional(), aligned_floor_transits_per_day: z.number().nullable().optional(), aligned_gulf_origin_transits_per_day: z.number().nullable().optional(), hormuz_required_origins: z.array(z.string()), not_a_proved_hormuz_bound: z.string(), routing_uncertainty: z.string().min(1), independence: z.string(), excluded_tracking_derived: z.array(z.string()), coverage: floorCoverage, importers: z.record(z.string(), floorImporter), retrieved_at: z.string()}); 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 envelopeHormuzImportFloorData = z.object({data: hormuzImportFloorData, 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 }; /** * Hormuz destination-side crude-import floor * * GET /api/v1/maritime/chokepoints/hormuz/import-floor */ export const getApiApiV1MaritimeChokepointsHormuzImportFloor = async (options?: GetApiApiV1MaritimeChokepointsHormuzImportFloorOptions) => { const {baseUrl = "https://sugra.ai", fetch: fetchFn = fetch, APIKeyHeader} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (APIKeyHeader !== undefined) headers.set("x-api-key", APIKeyHeader) const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/maritime/chokepoints/hormuz/import-floor${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(envelopeHormuzImportFloorData, await res.json()) };