import {z} from 'zod' export type Body = {object_identifier: string, test_debug?: boolean | undefined, metadata_service_endpoint?: string | undefined, metadata_service_type?: string | undefined, use_datacite?: boolean | undefined, use_github?: boolean | undefined, use_headless?: boolean | undefined, metric_version?: string | undefined, auth_token?: string | undefined, auth_token_type?: string | undefined, oaipmh_endpoint?: string | undefined}; export type CreateApiEvaluateArgs = {body: Body}; export type CreateApiEvaluateOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const fAIRResultCommonScore = z.object({earned: z.number().optional(), total: z.number().optional()}); export const fAIRResultEvaluationCriterium = z.object({metric_test_name: z.string().optional(), metric_test_requirements: z.array(z.record(z.string(), z.unknown())).optional(), metric_test_score: fAIRResultCommonScore.optional(), metric_test_maturity: z.number().int().nullable().optional(), metric_test_status: z.enum(["pass", "fail"]).optional()}); export const uniquenessOutputInner = z.object({guid: z.string().optional(), guid_scheme: z.string().optional(), target: z.string().optional()}); export const uniquenessOutput = z.object({unique_identifiers: z.array(uniquenessOutputInner).optional(), guid: z.string().optional(), guid_scheme: z.string().optional()}); export const debug = z.array(z.string()); export const uniqueness = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: uniquenessOutput.optional(), test_debug: debug.optional()}); export const persistenceOutputInner = z.object({pid: z.string().optional(), pid_scheme: z.string().optional(), resolvable_status: z.boolean().optional(), resolved_url: z.string().optional(), target: z.string().optional()}); export const persistenceOutput = z.object({persistent_identifiers: z.array(persistenceOutputInner).optional()}); export const persistence = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: persistenceOutput.optional(), test_debug: debug.optional()}); export const outputCoreMetadataFound = z.record(z.string(), z.string()); export const coreMetadataOutput = z.object({core_metadata_status: z.enum(["insufficent metadata", "partial metadata", "all metadata"]).optional(), core_metadata_found: outputCoreMetadataFound.optional(), core_metadata_source: z.array(z.string()).optional()}); export const coreMetadata = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: coreMetadataOutput.optional(), test_debug: debug.optional()}); export const identifierIncludedOutputInner = z.object({content_identifier_included: z.string().optional()}); export const identifierIncludedOutput = z.object({object_identifier_included: z.string().optional(), object_content_identifier_included: z.array(identifierIncludedOutputInner).optional()}); export const identifierIncluded = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: identifierIncludedOutput.optional(), test_debug: debug.optional()}); export const outputSearchMechanisms = z.object({mechanism: z.enum(["metadata registry", "structured data"]).optional(), mechanism_info: z.array(z.string()).optional()}); export const searchableOutput = z.object({search_mechanisms: z.array(outputSearchMechanisms).optional()}); export const searchable = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: searchableOutput.optional(), test_debug: debug.optional()}); export const dataAccessOutput = z.object({access_level: z.enum(["public", "embargoed", "restricted", "closed", "metadataonly"]).optional(), access_details: z.object({}).optional()}); export const dataAccessLevel = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: dataAccessOutput.optional(), test_debug: debug.optional()}); export const formalMetadataOutputInner = z.object({serialization_format: z.string().optional(), source: z.enum(["typed_link", "content_negotiate", "structured_data", "sparql_endpoint"]).optional(), is_metadata_found: z.boolean().optional()}); export const formalMetadataOutput = z.array(formalMetadataOutputInner); export const formalMetadata = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: formalMetadataOutput.optional(), test_debug: debug.optional()}); export const semanticVocabularyOutputInner = z.object({namespace: z.string().optional(), is_namespace_active: z.boolean().optional()}); export const semanticVocabularyOutput = z.array(semanticVocabularyOutputInner); export const semanticVocabulary = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: semanticVocabularyOutput.optional(), test_debug: debug.optional()}); export const relatedResourceOutputInner = z.object({related_resource: z.string().optional(), relation_type: z.string().optional()}); export const relatedResourceOutput = z.array(relatedResourceOutputInner); export const relatedResource = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: relatedResourceOutput.optional(), test_debug: debug.optional()}); export const dataContentMetadataOutputInner = z.object({descriptor: z.string().optional(), descriptor_value: z.string().optional(), matches_content: z.boolean().optional()}); export const dataContentMetadataOutput = z.object({object_type: z.string().optional(), data_content_descriptor: z.array(dataContentMetadataOutputInner).optional()}); export const dataContentMetadata = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: dataContentMetadataOutput.optional(), test_debug: debug.optional()}); export const licenseOutputInner = z.object({license: z.string().optional(), OSI_approved: z.boolean().optional(), details_url: z.string().optional()}); export const licenseOutput = z.array(licenseOutputInner); export const license = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: licenseOutput.optional(), test_debug: debug.optional()}); export const dataProvenanceOutputInner = z.object({is_available: z.boolean().optional(), provenance_metadata: z.array(z.record(z.string(), z.string())).optional()}); export const dataProvenanceOutput = z.object({provenance_metadata_included: dataProvenanceOutputInner.optional(), structured_provenance_available: dataProvenanceOutputInner.optional()}); export const dataProvenance = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: dataProvenanceOutput.optional(), test_debug: debug.optional()}); export const communityEndorsedStandardOutputInner = z.object({metadata_standard: z.string().optional(), url: z.string().optional(), subject_areas: z.array(z.string()).optional(), type: z.string().optional(), source: z.string().optional()}); export const communityEndorsedStandardOutput = z.array(communityEndorsedStandardOutputInner); export const communityEndorsedStandard = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: communityEndorsedStandardOutput.optional(), test_debug: debug.optional()}); export const dataFileFormatOutputInner = z.object({file_uri: z.string().optional(), mime_type: z.string().optional(), is_preferred_format: z.boolean().optional(), preference_reason: z.array(z.string()).optional(), subject_areas: z.array(z.string()).optional()}); export const dataFileFormatOutput = z.array(dataFileFormatOutputInner); export const dataFileFormat = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: dataFileFormatOutput.optional(), test_debug: debug.optional()}); export const metadataPreservedOutput = z.object({metadata_preservation_method: z.array(z.enum(["datacite", "tombstone"])).optional()}); export const metadataPreserved = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: metadataPreservedOutput.optional(), test_debug: debug.optional()}); export const codeProvenanceOutput = z.object({}); export const codeProvenance = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: codeProvenanceOutput.optional(), test_debug: debug.optional()}); export const componentIdentifierOutput = z.object({}); export const componentIdentifier = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: componentIdentifierOutput.optional(), test_debug: debug.optional()}); export const testCaseOutput = z.object({}); export const testCase = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: testCaseOutput.optional(), test_debug: debug.optional()}); export const uniquePersistentIdentifierSoftwareOutput = z.object({}); export const uniquePersistentIdentifierSoftware = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: uniquePersistentIdentifierSoftwareOutput.optional(), test_debug: debug.optional()}); export const versionIdentifierOutput = z.object({}); export const versionIdentifier = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: versionIdentifierOutput.optional(), test_debug: debug.optional()}); export const aPIOutput = z.object({}); export const aPI = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: aPIOutput.optional(), test_debug: debug.optional()}); export const developmentMetadataOutput = z.object({}); export const developmentMetadata = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: developmentMetadataOutput.optional(), test_debug: debug.optional()}); export const requirementsOutput = z.object({}); export const requirements = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: requirementsOutput.optional(), test_debug: debug.optional()}); export const standardisedProtocolOutputInner = z.object({protocol_type: z.string().optional(), auth_method: z.string().optional(), found_in: z.string().optional(), target: z.string().optional()}); export const standardisedProtocolOutput = z.object({standard_protocol: z.array(standardisedProtocolOutputInner).optional()}); export const standardisedProtocolData = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: standardisedProtocolOutput.optional(), test_debug: debug.optional()}); export const standardisedProtocolMetadata = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: standardisedProtocolOutput.optional(), test_debug: debug.optional()}); export const retrievableOutputInner = z.object({format: z.string().optional(), method: z.string().optional(), resolved_url: z.string().optional(), target: z.string().optional()}); export const retrievableOutput = z.object({retrievable_objects: z.array(retrievableOutputInner).optional()}); export const retrievable = z.object({id: z.number().int(), metric_identifier: z.string(), metric_name: z.string(), metric_tests: z.record(z.string(), fAIRResultEvaluationCriterium).optional(), test_status: z.enum(["pass", "fail", "indeterminate"]), score: fAIRResultCommonScore, maturity: z.number().int().optional(), output: retrievableOutput.optional(), test_debug: debug.optional()}); export const fAIRResults = z.object({test_id: z.string().optional(), request: z.record(z.string(), z.unknown()).optional(), resolved_url: z.string().optional(), start_timestamp: z.string().optional(), end_timestamp: z.string().optional(), metric_specification: z.string().optional(), metric_version: z.string().optional(), software_version: z.string().optional(), total_metrics: z.number().int().optional(), summary: z.record(z.string(), z.unknown()).optional(), results: z.array(z.union([uniqueness, persistence, coreMetadata, identifierIncluded, searchable, dataAccessLevel, formalMetadata, semanticVocabulary, relatedResource, dataContentMetadata, license, dataProvenance, communityEndorsedStandard, dataFileFormat, metadataPreserved, codeProvenance, componentIdentifier, testCase, uniquePersistentIdentifierSoftware, versionIdentifier, aPI, developmentMetadata, requirements, standardisedProtocolData, standardisedProtocolMetadata, retrievable])).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 }; /** * Evaluate FAIRness of a data object based on its identifier * * POST /evaluate */ export const createApiEvaluate = async (args: CreateApiEvaluateArgs, options?: CreateApiEvaluateOptions) => { const {baseUrl = "http://localhost:1071/fuji/api/v1", fetch: fetchFn = fetch, basicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/evaluate${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(fAIRResults, await res.json()) };