import {z} from 'zod' export type GetApiSamplingPointPointNotationSampleSampleNotationObservationObservationNotationArgs = {pointNotation: string, sampleNotation: number, observationNotation: number, 'Accept-Crs'?: ('http://www.opengis.net/def/crs/EPSG/0/27700' | 'http://www.opengis.net/def/crs/EPSG/0/4326') | undefined, 'API-Version'?: string | undefined}; export type GetApiSamplingPointPointNotationSampleSampleNotationObservationObservationNotationOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const hydraViewModel = z.object({first: z.string().nullable().optional(), last: z.string().nullable().optional(), next: z.string().nullable().optional(), previous: z.string().nullable().optional()}); export const geometryModel = z.object({id: z.string(), "@type": z.string().optional(), asWKT: z.string()}); export const samplingPointRegionModel = z.record(z.string(), z.unknown()); export const samplingPointAreaModel = z.record(z.string(), z.unknown()); export const samplingPointSubAreaModel = z.record(z.string(), z.unknown()); export const samplingPointStatusModel = z.record(z.string(), z.unknown()); export const samplingPointTypeModel = z.record(z.string(), z.unknown()); export const samplingPointModelAbridged = z.object({id: z.string().nullable().optional(), "@type": z.array(z.string()).optional(), notation: z.string().nullable().optional(), hasObservations: z.string().nullable().optional(), prefLabel: z.string().nullable().optional(), altLabel: z.string().nullable().optional(), geometry: geometryModel.nullable().optional(), region: samplingPointRegionModel.nullable().optional(), area: samplingPointAreaModel.nullable().optional(), subArea: samplingPointSubAreaModel.nullable().optional(), samplingPointStatus: samplingPointStatusModel.nullable().optional(), samplingPointType: samplingPointTypeModel.nullable().optional()}); export const samplingPointModel = z.object({id: z.string(), "@type": z.array(z.string()).optional(), altLabel: z.string(), prefLabel: z.string().nullable().optional(), notation: z.string().nullable().optional(), hasObservations: z.string().nullable().optional(), geometry: geometryModel.nullable().optional(), samplingPointStatus: samplingPointStatusModel.nullable().optional(), samplingPointType: samplingPointTypeModel.nullable().optional(), region: samplingPointRegionModel.nullable().optional(), area: samplingPointAreaModel.nullable().optional(), subArea: samplingPointSubAreaModel.nullable().optional()}); export const sampleMaterialModel = z.record(z.string(), z.unknown()); export const sampleModelAbridged = z.object({id: z.string(), "@type": z.string().optional(), sampleMaterialType: sampleMaterialModel.nullable().optional()}); export const samplingPurposeModel = z.record(z.string(), z.unknown()); export const samplingModel = z.object({id: z.string(), "@type": z.string().optional(), samplingPurpose: z.union([samplingPurposeModel, z.string()]).nullable().optional(), resultDate: z.string().nullable().optional(), startTime: z.string().nullable().optional(), hasResult: z.union([z.lazy(() => sampleModel), sampleModelAbridged, z.string()]).nullable().optional(), hasFeatureOfInterest: z.union([samplingPointModel, z.string()]).nullable().optional()}); export const samplingModelAbridged = z.object({id: z.string(), "@type": z.string().optional(), samplingPurpose: z.union([samplingPurposeModel, z.string()]).nullable().optional()}); export const sampleModel: z.ZodType = z.object({id: z.string(), "@type": z.string().optional(), sampleMaterialType: sampleMaterialModel.nullable().optional(), hasSamplingPoint: z.union([samplingPointModel, z.string()]).nullable().optional(), isResultOf: z.union([samplingModel, samplingModelAbridged, z.string()]).nullable().optional()}); export const unitModel = z.record(z.string(), z.unknown()); export const resultNumericModel = z.object({"@type": z.string().optional(), numericValue: z.union([z.number().int(), z.number()]).nullable().optional(), upperBound: z.union([z.number().int(), z.number()]).nullable().optional(), lowerBound: z.union([z.number().int(), z.number()]).nullable().optional(), hasUnit: unitModel.nullable().optional()}); export const resultCodedModel = z.record(z.string(), z.unknown()); export const observedPropertyModel = z.record(z.string(), z.unknown()); export const observationModel = z.object({id: z.string(), "@type": z.string().optional(), hasSamplingPoint: z.union([samplingPointModelAbridged, samplingPointModel, z.string()]).nullable().optional(), hasSample: z.union([sampleModelAbridged, sampleModel, z.string()]).nullable().optional(), phenomenonTime: z.string().nullable().optional(), hasSimpleResult: z.union([z.string(), z.number()]).nullable().optional(), hasUnit: z.string().nullable().optional(), hasResult: z.union([resultNumericModel, resultCodedModel]).nullable().optional(), observedProperty: z.union([observedPropertyModel, z.string()]).nullable().optional()}); export const hydraObservationModel = z.object({"@context": z.string().optional(), "@type": z.string().optional(), totalItems: z.number().int().optional(), view: hydraViewModel.nullable().optional(), member: z.array(observationModel)}); 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 a specific observation from its constituent notations * * GET /sampling-point/{pointNotation}/sample/{sampleNotation}/observation/{observationNotation} */ export const getApiSamplingPointPointNotationSampleSampleNotationObservationObservationNotation = async (args: GetApiSamplingPointPointNotationSampleSampleNotationObservationObservationNotationArgs, options?: GetApiSamplingPointPointNotationSampleSampleNotationObservationObservationNotationOptions) => { const {baseUrl = "https://environment.data.gov.uk/water-quality", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/ld+json") if (args['Accept-Crs'] != null) headers.set("Accept-Crs", String(args['Accept-Crs'])) if (args['API-Version'] != null) headers.set("API-Version", String(args['API-Version'])) const url = `${baseUrl.replace(/\/+$/, '')}/sampling-point/${encodeURIComponent(String(args.pointNotation))}/sample/${encodeURIComponent(String(args.sampleNotation))}/observation/${encodeURIComponent(String(args.observationNotation))}${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(hydraObservationModel, await res.json()) };