import {z} from 'zod' export type ISOEnum = 'CAISO' | 'ERCOT' | 'IESO' | 'ISONE' | 'MISO' | 'NYISO' | 'PJM' | 'SPP'; export type GetApiReportsDailyPeakIsoArgs = {iso: ISOEnum, date: string, api_key?: (string | null) | undefined, 'x-api-key'?: (string | null) | undefined}; export type GetApiReportsDailyPeakIsoOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const peakDamLmpResponse = z.record(z.string(), z.union([z.number(), z.string(), z.string()]).nullable()); export const peakIntervalResponse = z.object({interval_start_market: z.string(), interval_end_market: z.string(), load: z.number(), net_load: z.number()}).and(z.record(z.string(), z.number().nullable())); export const peakLoadReportResponse = z.object({ISO: z.string(), market_date: z.string(), timezone: z.string(), peak_dam_lmp: z.array(peakDamLmpResponse).nullable().optional(), peak_load: peakIntervalResponse.nullable().optional(), peak_net_load: peakIntervalResponse.nullable().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 Daily Peak Report * * GET /reports/daily_peak/{iso} */ export const getApiReportsDailyPeakIso = async (args: GetApiReportsDailyPeakIsoArgs, options?: GetApiReportsDailyPeakIsoOptions) => { const {baseUrl = "https://api.gridstatus.io/v1", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.date != null) query.append("date", String(args.date)) if (args.api_key != null) query.append("api_key", String(args.api_key)) if (args['x-api-key'] != null) headers.set("x-api-key", String(args['x-api-key'])) const url = `${baseUrl.replace(/\/+$/, '')}/reports/daily_peak/${encodeURIComponent(String(args.iso))}${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(peakLoadReportResponse, await res.json()) };