import {z} from 'zod' export type GridpointForecastUnits = 'us' | 'si'; export type GetApiGridpointsWfoXYForecastArgs = {'Feature-Flags'?: (Array<'forecast_temperature_qv' | 'forecast_wind_speed_qv'>) | undefined, units?: GridpointForecastUnits | undefined}; export type GetApiGridpointsWfoXYForecastOptions = {baseUrl?: string | undefined, userAgent?: string | undefined, fetch?: typeof fetch | undefined}; export const jsonLdContext = z.union([z.array(z.unknown()), z.object({})]); export const geoJsonCoordinate = z.array(z.number()); export const geoJsonBoundingBox = z.array(z.number()); export const geoJsonLineString = z.array(geoJsonCoordinate); export const geoJsonPolygon = z.array(z.array(geoJsonCoordinate)); export const geoJsonGeometry = z.union([z.object({type: z.literal("Point"), coordinates: geoJsonCoordinate, bbox: geoJsonBoundingBox.optional()}), z.object({type: z.literal("LineString"), coordinates: geoJsonLineString, bbox: geoJsonBoundingBox.optional()}), z.object({type: z.literal("Polygon"), coordinates: geoJsonPolygon, bbox: geoJsonBoundingBox.optional()}), z.object({type: z.literal("MultiPoint"), coordinates: z.array(geoJsonCoordinate), bbox: geoJsonBoundingBox.optional()}), z.object({type: z.literal("MultiLineString"), coordinates: z.array(geoJsonLineString), bbox: geoJsonBoundingBox.optional()}), z.object({type: z.literal("MultiPolygon"), coordinates: z.array(geoJsonPolygon), bbox: geoJsonBoundingBox.optional()})]).nullable(); export const geometryString = z.string().nullable(); export const gridpointForecastUnits = z.enum(["us", "si"]); export const iSO8601Interval = z.union([z.string(), z.string(), z.string()]); export const unitOfMeasure = z.string(); export const quantitativeValue = z.object({value: z.number().nullable().optional(), maxValue: z.number().optional(), minValue: z.number().optional(), unitCode: unitOfMeasure.optional(), qualityControl: z.enum(["Z", "C", "S", "V", "X", "Q", "G", "B", "T"]).optional()}); export const gridpoint12hForecastPeriod = z.object({number: z.number().int().gte(1).optional(), name: z.string().optional(), startTime: z.string().optional(), endTime: z.string().optional(), isDaytime: z.boolean().optional(), temperature: z.union([quantitativeValue, z.number().int()]).optional(), temperatureUnit: z.enum(["F", "C"]).optional(), temperatureTrend: z.enum(["rising", "falling"]).nullable().optional(), probabilityOfPrecipitation: quantitativeValue.optional(), windSpeed: z.union([quantitativeValue, z.string()]).optional(), windGust: z.union([quantitativeValue, z.string()]).nullable().optional(), windDirection: z.enum(["N", "NNE", "NE", "ENE", "E", "ESE", "SE", "SSE", "S", "SSW", "SW", "WSW", "W", "WNW", "NW", "NNW"]).optional(), icon: z.string().optional(), shortForecast: z.string().optional(), detailedForecast: z.string().optional()}); export const gridpoint12hForecastGeoJson = z.object({"@context": jsonLdContext.optional(), id: z.string().optional(), type: z.literal("Feature"), geometry: geoJsonGeometry, properties: z.object({"@context": jsonLdContext.optional(), geometry: geometryString.optional(), units: gridpointForecastUnits.optional(), forecastGenerator: z.string().optional(), generatedAt: z.string().optional(), updateTime: z.string().optional(), validTimes: iSO8601Interval.optional(), elevation: quantitativeValue.optional(), periods: z.array(gridpoint12hForecastPeriod).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 }; /** * Returns a textual forecast for a 2.5km grid area * * GET /gridpoints/{wfo}/{x},{y}/forecast * * Also accepts auth: apiKeyAuth */ export const getApiGridpointsWfoXYForecast = async (args: GetApiGridpointsWfoXYForecastArgs, options?: GetApiGridpointsWfoXYForecastOptions) => { const {baseUrl = "https://api.weather.gov", fetch: fetchFn = fetch, userAgent} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/geo+json") if (args['Feature-Flags'] != null) headers.set("Feature-Flags", args['Feature-Flags'].join(',')) if (args.units != null) query.append("units", String(args.units)) if (userAgent !== undefined) headers.set("User-Agent", userAgent) const url = `${baseUrl.replace(/\/+$/, '')}/gridpoints/${encodeURIComponent(String(args.wfo))}/${encodeURIComponent(String(args.x))},${encodeURIComponent(String(args.y))}/forecast${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(gridpoint12hForecastGeoJson, await res.json()) };