import {z} from 'zod' export type GetApiFeatureImageArgs = {space_id: string, bbox?: string | undefined, type?: string | undefined, page?: number | undefined, size?: number | undefined}; export type GetApiFeatureImageOptions = {baseUrl: string, fetch?: typeof fetch | undefined}; 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 siibraAtIdModel = z.object({"@id": z.string()}); export const locationModel = z.object({"@type": z.string(), space: siibraAtIdModel}); export const vocabModel = z.object({"@vocab": z.string()}); export const apiModelsOpenmindsSANDSV3MiscellaneousCoordinatePointCoordinates = z.object({"@context": vocabModel.optional(), typeOfUncertainty: z.unknown(), uncertainty: z.array(z.number()).optional(), unit: z.unknown(), value: z.number()}); export const coordinatePointModel = z.object({"@type": z.string(), "@context": vocabModel.optional(), "@id": z.string(), coordinateSpace: z.object({}), coordinates: z.array(apiModelsOpenmindsSANDSV3MiscellaneousCoordinatePointCoordinates)}); export const apiModelsOpenmindsSANDSV3AtlasParcellationEntityVersionCoordinates = z.object({"@context": vocabModel.optional(), typeOfUncertainty: z.unknown(), uncertainty: z.array(z.number()).optional(), unit: z.unknown(), value: z.number()}); export const bestViewPoint = z.object({"@context": vocabModel.optional(), coordinateSpace: z.unknown(), coordinates: z.array(apiModelsOpenmindsSANDSV3AtlasParcellationEntityVersionCoordinates)}); export const hasAnnotation = z.object({"@context": vocabModel.optional(), bestViewPoint: bestViewPoint.optional(), criteria: z.unknown(), criteriaQualityType: z.unknown(), displayColor: z.string().optional(), inspiredBy: z.array(z.unknown()).optional(), internalIdentifier: z.string(), laterality: z.array(z.unknown()).optional(), visualizedIn: z.unknown()}); export const relationAssessmentItem = z.object({"@context": vocabModel.optional(), criteria: z.unknown(), inRelationTo: z.unknown(), qualitativeOverlap: z.unknown()}); export const quantitativeOverlapItem = z.object({"@context": vocabModel.optional(), typeOfUncertainty: z.unknown(), uncertainty: z.array(z.number()).optional(), unit: z.unknown(), value: z.number()}); export const quantitativeOverlapItem1 = z.object({"@context": vocabModel.optional(), maxValue: z.number(), maxValueUnit: z.unknown(), minValue: z.number(), minValueUnit: z.unknown()}); export const relationAssessmentItem1 = z.object({"@context": vocabModel.optional(), criteria: z.unknown(), inRelationTo: z.unknown(), quantitativeOverlap: z.union([quantitativeOverlapItem, quantitativeOverlapItem1])}); export const parcellationEntityVersionModel = z.object({"@type": z.string(), "@context": vocabModel.optional(), "@id": z.string(), hasAnnotation: hasAnnotation.optional(), hasParent: z.array(z.unknown()).optional(), lookupLabel: z.string().optional(), name: z.string().optional(), ontologyIdentifier: z.array(z.string()).optional(), relationAssessment: z.union([relationAssessmentItem, relationAssessmentItem1]).optional(), versionIdentifier: z.string(), versionInnovation: z.string().optional()}); export const siibraRegionAssignmentQual = z.object({"@type": z.string(), region: parcellationEntityVersionModel, qualification: z.string()}); export const copyright = z.object({"@context": vocabModel.optional(), holder: z.array(z.unknown()), year: z.string()}); export const hasTerminologyVersion = z.object({"@context": vocabModel.optional(), definedIn: z.array(z.unknown()).optional(), hasEntityVersion: z.array(z.unknown()), ontologyIdentifier: z.array(z.string()).optional()}); export const otherContribution = z.object({"@context": vocabModel.optional(), contributionType: z.array(z.unknown()), contributor: z.unknown()}); export const brainAtlasVersionModel = z.object({"@type": z.string(), "@context": vocabModel.optional(), "@id": z.string(), abbreviation: z.string().optional(), accessibility: z.object({}), atlasType: z.object({}).optional(), author: z.array(z.unknown()).optional(), coordinateSpace: z.object({}), copyright: copyright.optional(), custodian: z.array(z.unknown()).optional(), description: z.string().max(2000).optional(), digitalIdentifier: z.object({}).optional(), fullDocumentation: z.object({}), fullName: z.string().optional(), funding: z.array(z.unknown()).optional(), hasTerminologyVersion: hasTerminologyVersion, homepage: z.object({}).optional(), howToCite: z.string().optional(), isAlternativeVersionOf: z.array(z.unknown()).optional(), isNewVersionOf: z.object({}).optional(), keyword: z.array(z.unknown()).optional(), license: z.object({}), ontologyIdentifier: z.array(z.string()).optional(), otherContribution: otherContribution.optional(), relatedPublication: z.array(z.unknown()).optional(), releaseDate: z.string(), repository: z.object({}).optional(), shortName: z.string().max(30), supportChannel: z.array(z.string()).optional(), versionIdentifier: z.string(), versionInnovation: z.string()}); export const siibraParcellationVersionModel = z.object({"@type": z.string(), name: z.string(), deprecated: z.boolean().optional(), collection: z.string().optional(), prev: siibraAtIdModel.optional(), next: siibraAtIdModel.optional()}); export const siibraParcellationModel = z.object({"@type": z.string(), "@id": z.string(), name: z.string(), modality: z.string().optional(), datasets: z.array(ebrainsDatasetModel), brainAtlasVersions: z.array(brainAtlasVersionModel), version: siibraParcellationVersionModel.optional(), shortname: z.string().optional()}); export const siibraAnatomicalAssignmentModel = z.object({"@type": z.string(), qualification: z.string(), query_structure: z.union([locationModel, parcellationEntityVersionModel, siibraParcellationModel]), assigned_structure: z.union([locationModel, parcellationEntityVersionModel, siibraParcellationModel]), explanation: z.string()}); export const siibraAnchorModel = z.object({"@type": z.string(), location: z.union([locationModel, coordinatePointModel]).optional(), regions: z.array(siibraRegionAssignmentQual), last_match_description: z.string().optional(), last_match_result: z.array(siibraAnatomicalAssignmentModel).optional()}); 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 boundingBoxModel = z.object({"@type": z.string(), space: siibraAtIdModel, center: coordinatePointModel, minpoint: coordinatePointModel, maxpoint: coordinatePointModel, shape: z.array(z.number()), isPlanar: z.boolean()}); export const siibraVoiModel = z.object({"@type": z.string(), id: z.string(), modality: z.string().optional(), category: z.string(), description: z.string(), name: z.string(), datasets: z.array(ebrainsDatasetModel), anchor: siibraAnchorModel.optional(), volume: volumeModel, boundingbox: boundingBoxModel}); export const pageSiibraVoiModel = z.object({items: z.array(siibraVoiModel), total: z.number().int().gte(0).optional(), page: z.number().int().gte(1).optional(), size: z.number().int().gte(1).optional(), pages: z.number().int().gte(0).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 All Voi * * GET /feature/Image */ export const getApiFeatureImage = async (args: GetApiFeatureImageArgs, options: GetApiFeatureImageOptions) => { const {baseUrl, fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.space_id != null) query.append("space_id", String(args.space_id)) if (args.bbox != null) query.append("bbox", String(args.bbox)) if (args.type != null) query.append("type", String(args.type)) if (args.page != null) query.append("page", String(args.page)) if (args.size != null) query.append("size", String(args.size)) const url = `${baseUrl.replace(/\/+$/, '')}/feature/Image${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(pageSiibraVoiModel, await res.json()) };