import {z} from 'zod' export type MapType = 'LABELLED' | 'STATISTICAL'; export type GetApiMapArgs = {parcellation_id: string, space_id: string, map_type: MapType}; export type GetApiMapOptions = {baseUrl: string, fetch?: typeof fetch | undefined}; export const siibraPublication = z.object({"@type": z.string(), citation: z.string(), url: z.string()}); export const ebrainsDsUrl = z.object({"@type": z.string(), url: z.string()}); export const ebrainsDsPerson = z.object({"@type": z.string(), "@id": z.string(), "schema.org/shortName": z.string(), identifier: z.string(), shortName: z.string(), name: z.string()}); export const ebrainsDatasetModel = z.object({"@type": z.string(), "@id": z.string(), name: z.string(), urls: z.array(ebrainsDsUrl), description: z.string().optional(), contributors: z.array(ebrainsDsPerson), ebrains_page: z.string().optional(), custodians: z.array(ebrainsDsPerson)}); export const mapIndexModel = z.object({"@type": z.string(), volume: z.number().int(), label: z.number().int().optional(), fragment: z.string().optional()}); export const siibraAtIdModel = z.object({"@id": z.string()}); export const volumeModel = z.object({"@type": z.string(), name: z.string(), formats: z.array(z.string()), providesMesh: z.boolean(), providesImage: z.boolean(), fragments: z.record(z.string(), z.array(z.string())), variant: z.string().optional(), providedVolumes: z.record(z.string(), z.union([z.string(), z.record(z.string(), z.string())])), space: siibraAtIdModel, datasets: z.array(ebrainsDatasetModel)}); export const mapModel = z.object({"@type": z.string(), "@id": z.string(), name: z.string(), shortname: z.string().optional(), modality: z.string().optional(), description: z.string().optional(), publications: z.array(siibraPublication), datasets: z.array(ebrainsDatasetModel), species: z.string(), indices: z.record(z.string(), z.array(mapIndexModel)), volumes: z.array(volumeModel), parcellation: siibraAtIdModel, space: siibraAtIdModel, maptype: z.string()}); 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 Siibra Map * * GET /map */ export const getApiMap = async (args: GetApiMapArgs, options: GetApiMapOptions) => { const {baseUrl, fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.parcellation_id != null) query.append("parcellation_id", String(args.parcellation_id)) if (args.space_id != null) query.append("space_id", String(args.space_id)) if (args.map_type != null) query.append("map_type", String(args.map_type)) const url = `${baseUrl.replace(/\/+$/, '')}/map${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(mapModel, await res.json()) };