import {z} from 'zod' export type ReturnFormat = 'json' | 'csv'; export type JSONSchema = 'array-of-objects' | 'array-of-arrays'; export type GetApiDatasetsDatasetIdAuditArgs = {dataset_id: string, api_key?: (string | null) | undefined, return_format?: ReturnFormat | undefined, download?: boolean | undefined, json_schema?: JSONSchema | undefined, 'x-api-key'?: (string | null) | undefined}; export type GetApiDatasetsDatasetIdAuditOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const datasetAudit = z.object({market_date: z.string().nullable(), number_of_datapoints: z.number().int().nullable(), number_of_unique_time_index_values: z.number().int().nullable(), number_of_unique_subseries_index_values: z.number().int().nullable(), number_of_unique_publish_times_on_publish_date: z.number().int().nullable()}); export const datasetAuditResponse = z.object({status_code: z.number().int(), data: z.array(datasetAudit)}); 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 Dataset Audit * * GET /datasets/{dataset_id}/audit */ export const getApiDatasetsDatasetIdAudit = async (args: GetApiDatasetsDatasetIdAuditArgs, options?: GetApiDatasetsDatasetIdAuditOptions) => { 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.api_key != null) query.append("api_key", String(args.api_key)) if (args.return_format != null) query.append("return_format", String(args.return_format)) if (args.download != null) query.append("download", String(args.download)) if (args.json_schema != null) query.append("json_schema", String(args.json_schema)) if (args['x-api-key'] != null) headers.set("x-api-key", String(args['x-api-key'])) const url = `${baseUrl.replace(/\/+$/, '')}/datasets/${encodeURIComponent(String(args.dataset_id))}/audit${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(datasetAuditResponse, await res.json()) };