import {z} from 'zod' export type GetApiApiV1DataDistributionUrlsArgs = {name: string, start: string, end: string, site_uid?: (string | null) | undefined, device_uid?: (string | null) | undefined, include_total_bytes?: boolean | undefined}; export type GetApiApiV1DataDistributionUrlsOptions = {baseUrl: string, fetch?: typeof fetch | undefined}; export const dataset = z.object({name: z.string(), short_description: z.string(), long_description: z.string(), data_tree_url: z.string(), file_listing_supported: z.boolean(), level: z.string(), doi: z.string().nullable().optional(), doi_details: z.string().nullable().optional(), citation: z.string().nullable().optional(), supported_libraries: z.array(z.enum(["pyaurorax", "pyucrio", "idl-aurorax", "idl-ucrio", "pyucalgarysrs"])).optional(), file_time_resolution: z.enum(["1min", "1hr", "1day", "not_applicable"])}); export const datasetLegacy1 = z.object({name: z.string(), short_description: z.string(), long_description: z.string(), data_tree_url: z.string(), file_listing_supported: z.boolean(), level: z.string(), doi: z.string().nullable().optional(), doi_details: z.string().nullable().optional(), citation: z.string().nullable().optional()}); export const datasetLegacy2 = z.object({name: z.string(), short_description: z.string(), long_description: z.string(), data_tree_url: z.string(), file_listing_supported: z.boolean(), level: z.string(), doi: z.string().nullable().optional(), doi_details: z.string().nullable().optional(), citation: z.string().nullable().optional(), supported_libraries: z.array(z.enum(["pyaurorax", "pyucrio", "idl-aurorax", "idl-ucrio", "pyucalgarysrs"])).optional()}); export const fileListingResponse = z.object({urls: z.array(z.string()), path_prefix: z.string(), count: z.number().int(), total_bytes: z.number().int().nullable(), dataset: z.union([dataset, datasetLegacy1, datasetLegacy2])}); 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 }; /** * Retrieve list of URLs for a given dataset * * GET /api/v1/data_distribution/urls */ export const getApiApiV1DataDistributionUrls = async (args: GetApiApiV1DataDistributionUrlsArgs, options: GetApiApiV1DataDistributionUrlsOptions) => { const {baseUrl, fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.name != null) query.append("name", String(args.name)) if (args.start != null) query.append("start", String(args.start)) if (args.end != null) query.append("end", String(args.end)) if (args.site_uid != null) query.append("site_uid", String(args.site_uid)) if (args.device_uid != null) query.append("device_uid", String(args.device_uid)) if (args.include_total_bytes != null) query.append("include_total_bytes", String(args.include_total_bytes)) const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/data_distribution/urls${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(fileListingResponse, await res.json()) };