import {z} from 'zod' export type GetApiResponseResponseIdArgs = {response_id: string}; export type GetApiResponseResponseIdOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const cURIE = z.string(); export const attribute: z.ZodType = z.object({attribute_type_id: z.string(), original_attribute_name: z.string().nullable().optional(), value: z.unknown(), value_type_id: cURIE.nullable().optional(), attribute_source: z.string().nullable().optional(), value_url: z.string().nullable().optional(), description: z.string().nullable().optional(), attributes: z.array(z.lazy(() => attribute)).nullable().optional()}); export const nodeBinding = z.object({id: cURIE, query_id: cURIE.optional(), attributes: z.array(attribute).nullable().optional()}).and(z.record(z.string(), z.unknown())); export const edgeBinding = z.object({id: z.string(), attributes: z.array(attribute).nullable().optional()}).and(z.record(z.string(), z.unknown())); export const analysis = z.object({resource_id: z.string(), score: z.number().nullable().optional(), edge_bindings: z.record(z.string(), z.array(edgeBinding)), support_graphs: z.array(z.string()).nullable().optional(), scoring_method: z.string().nullable().optional(), attributes: z.array(attribute).nullable().optional()}).and(z.record(z.string(), z.unknown())); export const result = z.object({node_bindings: z.record(z.string(), z.array(nodeBinding)), analyses: z.array(analysis), id: z.string().nullable().optional(), description: z.string().nullable().optional(), essence: z.string().nullable().optional(), essence_category: z.string().nullable().optional(), row_data: z.array(z.union([z.string(), z.number()])).nullable().optional(), score: z.number().nullable().optional(), score_name: z.string().nullable().optional(), score_direction: z.string().nullable().optional(), confidence: z.number().nullable().optional(), result_group: z.number().int().nullable().optional(), result_group_similarity_score: z.number().nullable().optional(), resource_id: z.string().nullable().optional()}).and(z.record(z.string(), z.unknown())); export const biolinkEntity = z.string(); export const attributeConstraint = z.object({id: cURIE, name: z.string(), not: z.boolean().optional(), operator: z.enum(["==", ">", "<", "matches", "==="]), value: z.unknown(), unit_id: z.string().nullable().optional(), unit_name: z.string().nullable().optional()}); export const qNode = z.object({ids: z.array(cURIE).nullable().optional(), categories: z.array(biolinkEntity).nullable().optional(), is_set: z.boolean().optional(), set_id: z.string().nullable().optional(), set_interpretation: z.enum(["BATCH", "ALL", "MANY"]).nullable().optional(), constraints: z.array(attributeConstraint).optional(), option_group_id: z.string().nullable().optional()}).and(z.record(z.string(), z.unknown())); export const biolinkPredicate = z.string(); export const qualifier = z.object({qualifier_type_id: z.string(), qualifier_value: z.string()}); export const qualifierConstraint = z.object({qualifier_set: z.array(qualifier)}); export const qEdge = z.object({knowledge_type: z.string().nullable().optional(), predicates: z.array(biolinkPredicate).nullable().optional(), subject: z.string(), object: z.string(), attribute_constraints: z.array(attributeConstraint).optional(), qualifier_constraints: z.array(qualifierConstraint).optional(), exclude: z.boolean().optional(), option_group_id: z.string().nullable().optional()}).and(z.record(z.string(), z.unknown())); export const queryGraph = z.object({nodes: z.record(z.string(), qNode), edges: z.record(z.string(), qEdge)}).and(z.record(z.string(), z.unknown())); export const node = z.object({name: z.string().nullable().optional(), categories: z.array(biolinkEntity).nullable().optional(), attributes: z.array(attribute).nullable().optional()}); export const resourceRoleEnum = z.enum(["primary_knowledge_source", "aggregator_knowledge_source", "supporting_data_source"]); export const retrievalSource = z.object({resource_id: z.string(), resource_role: resourceRoleEnum, upstream_resource_ids: z.array(cURIE).optional(), source_record_urls: z.array(z.string()).optional()}).and(z.record(z.string(), z.unknown())); export const edge = z.object({predicate: biolinkPredicate, subject: cURIE, object: cURIE, attributes: z.array(attribute).nullable().optional(), qualifiers: z.array(qualifier).nullable().optional(), sources: z.array(retrievalSource)}); export const knowledgeGraph = z.object({nodes: z.record(z.string(), node), edges: z.record(z.string(), edge)}).and(z.record(z.string(), z.unknown())); export const auxiliaryGraph = z.object({edges: z.array(z.string()), attributes: z.array(attribute).nullable().optional()}).and(z.record(z.string(), z.unknown())); export const message = z.object({results: z.array(result).nullable().optional(), query_graph: queryGraph.nullable().optional(), knowledge_graph: knowledgeGraph.nullable().optional(), auxiliary_graphs: z.record(z.string(), auxiliaryGraph).optional()}); export const logLevel = z.enum(["ERROR", "WARNING", "INFO", "DEBUG"]); export const logEntry = z.object({timestamp: z.string(), level: logLevel.nullable().optional(), code: z.string().nullable().optional(), message: z.string()}).and(z.record(z.string(), z.unknown())); export const operationAnnotate = z.object({id: z.literal("annotate"), parameters: z.unknown(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationAnnotateEdgesParameters = z.object({attributes: z.array(z.string()).optional()}); export const operationAnnotateEdges = z.object({id: z.literal("annotate_edges"), parameters: operationAnnotateEdgesParameters.optional(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationAnnotateNodesParameters = z.object({attributes: z.array(z.string()).optional()}); export const operationAnnotateNodes = z.object({id: z.literal("annotate_nodes"), parameters: operationAnnotateNodesParameters.optional(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationBind = z.object({id: z.literal("bind"), parameters: z.unknown(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationCompleteResults = z.object({id: z.literal("complete_results"), parameters: z.unknown(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationEnrichResultsParameters = z.object({pvalue_threshold: z.number().gte(0).lte(1).optional(), qnode_keys: z.array(z.string()).optional()}); export const operationEnrichResults = z.object({id: z.literal("enrich_results"), parameters: operationEnrichResultsParameters.optional(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationFill = z.object({id: z.literal("fill"), parameters: z.union([z.object({allowlist: z.array(z.string()).optional(), qedge_keys: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional(), qedge_keys: z.array(z.string()).optional()})]).optional(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationFilterKgraph = z.object({id: z.literal("filter_kgraph"), parameters: z.unknown(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationFilterKgraphContinuousKedgeAttributeParameters = z.object({edge_attribute: z.string(), qedge_keys: z.array(z.string()).optional(), qnode_keys: z.array(z.string()).optional(), remove_above_or_below: z.enum(["above", "below"]), threshold: z.number()}); export const operationFilterKgraphContinuousKedgeAttribute = z.object({id: z.literal("filter_kgraph_continuous_kedge_attribute"), parameters: operationFilterKgraphContinuousKedgeAttributeParameters, runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationFilterKgraphDiscreteKedgeAttributeParameters = z.object({edge_attribute: z.string(), qedge_keys: z.array(z.string()).optional(), qnode_keys: z.array(z.string()).optional(), remove_value: z.string()}); export const operationFilterKgraphDiscreteKedgeAttribute = z.object({id: z.literal("filter_kgraph_discrete_kedge_attribute"), parameters: operationFilterKgraphDiscreteKedgeAttributeParameters, runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationFilterKgraphDiscreteKnodeAttributeParameters = z.object({node_attribute: z.string(), qnode_keys: z.array(z.string()).optional(), remove_value: z.string()}); export const operationFilterKgraphDiscreteKnodeAttribute = z.object({id: z.literal("filter_kgraph_discrete_knode_attribute"), parameters: operationFilterKgraphDiscreteKnodeAttributeParameters, runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationFilterKgraphOrphans = z.object({id: z.literal("filter_kgraph_orphans"), parameters: z.unknown(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationFilterKgraphPercentileParameters = z.object({edge_attribute: z.string(), qedge_keys: z.array(z.string()).optional(), qnode_keys: z.array(z.string()).optional(), remove_above_or_below: z.enum(["above", "below"]).optional(), threshold: z.number().gte(0).lte(100).optional()}); export const operationFilterKgraphPercentile = z.object({id: z.literal("filter_kgraph_percentile"), parameters: operationFilterKgraphPercentileParameters, runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationFilterKgraphStdDevParameters = z.object({edge_attribute: z.string(), num_sigma: z.number().gte(0).optional(), plus_or_minus_std_dev: z.enum(["plus", "minus"]).optional(), qedge_keys: z.array(z.string()).optional(), qnode_keys: z.array(z.string()).optional(), remove_above_or_below: z.enum(["above", "below"]).optional()}); export const operationFilterKgraphStdDev = z.object({id: z.literal("filter_kgraph_std_dev"), parameters: operationFilterKgraphStdDevParameters, runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationFilterKgraphTopNParameters = z.object({edge_attribute: z.string(), keep_top_or_bottom: z.enum(["top", "bottom"]).optional(), max_edges: z.number().int().gte(0).optional(), qedge_keys: z.array(z.string()).optional(), qnode_keys: z.array(z.string()).optional()}); export const operationFilterKgraphTopN = z.object({id: z.literal("filter_kgraph_top_n"), parameters: operationFilterKgraphTopNParameters, runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationFilterResults = z.object({id: z.literal("filter_results"), parameters: z.unknown(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationFilterResultsTopNParameters = z.object({max_results: z.number().int().gte(0)}); export const operationFilterResultsTopN = z.object({id: z.literal("filter_results_top_n"), parameters: operationFilterResultsTopNParameters, runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationLookup = z.object({id: z.literal("lookup"), parameters: z.unknown(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationLookupAndScore = z.object({id: z.literal("lookup_and_score"), parameters: z.unknown(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationOverlay = z.object({id: z.literal("overlay"), parameters: z.unknown(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationOverlayComputeJaccardParameters = z.object({end_node_keys: z.array(z.string()), intermediate_node_key: z.string(), virtual_relation_label: z.string()}); export const operationOverlayComputeJaccard = z.object({id: z.literal("overlay_compute_jaccard"), parameters: operationOverlayComputeJaccardParameters, runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationOverlayComputeNgdParameters = z.object({qnode_keys: z.array(z.string()), virtual_relation_label: z.string()}); export const operationOverlayComputeNgd = z.object({id: z.literal("overlay_compute_ngd"), parameters: operationOverlayComputeNgdParameters, runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationOverlayConnectKnodes = z.object({id: z.literal("overlay_connect_knodes"), parameters: z.unknown(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationOverlayFisherExactTestParameters = z.object({object_qnode_key: z.string(), rel_edge_key: z.string().optional(), subject_qnode_key: z.string(), virtual_relation_label: z.string()}); export const operationOverlayFisherExactTest = z.object({id: z.literal("overlay_fisher_exact_test"), parameters: operationOverlayFisherExactTestParameters, runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationRestate = z.object({id: z.literal("restate"), parameters: z.unknown(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationScore = z.object({id: z.literal("score"), parameters: z.unknown(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationSortResults = z.object({id: z.literal("sort_results"), parameters: z.unknown(), runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationSortResultsEdgeAttributeParameters = z.object({ascending_or_descending: z.enum(["ascending", "descending"]), edge_attribute: z.string(), qedge_keys: z.array(z.string()).optional()}); export const operationSortResultsEdgeAttribute = z.object({id: z.literal("sort_results_edge_attribute"), parameters: operationSortResultsEdgeAttributeParameters, runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationSortResultsNodeAttributeParameters = z.object({ascending_or_descending: z.enum(["ascending", "descending"]), node_attribute: z.string(), qnode_keys: z.array(z.string()).optional()}); export const operationSortResultsNodeAttribute = z.object({id: z.literal("sort_results_node_attribute"), parameters: operationSortResultsNodeAttributeParameters, runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operationSortResultsScoreParameters = z.object({ascending_or_descending: z.enum(["ascending", "descending"])}); export const operationSortResultsScore = z.object({id: z.literal("sort_results_score"), parameters: operationSortResultsScoreParameters, runner_parameters: z.union([z.object({allowlist: z.array(z.string()).optional()}), z.object({denylist: z.array(z.string()).optional()})]).optional(), unique: z.boolean().optional()}); export const operations = z.object({message_uris: z.array(z.string()).optional(), messages: z.array(message).optional(), actions: z.array(z.string()).optional(), options: z.record(z.string(), z.unknown()).optional()}).and(z.record(z.string(), z.unknown())).nullable(); export const response = z.object({message: message, status: z.string().nullable().optional(), description: z.string().nullable().optional(), logs: z.array(logEntry).nullable().optional(), workflow: z.array(z.union([operationAnnotate, operationAnnotateEdges, operationAnnotateNodes, operationBind, operationCompleteResults, operationEnrichResults, operationFill, operationFilterKgraph, operationFilterKgraphContinuousKedgeAttribute, operationFilterKgraphDiscreteKedgeAttribute, operationFilterKgraphDiscreteKnodeAttribute, operationFilterKgraphOrphans, operationFilterKgraphPercentile, operationFilterKgraphStdDev, operationFilterKgraphTopN, operationFilterResults, operationFilterResultsTopN, operationLookup, operationLookupAndScore, operationOverlay, operationOverlayComputeJaccard, operationOverlayComputeNgd, operationOverlayConnectKnodes, operationOverlayFisherExactTest, operationRestate, operationScore, operationSortResults, operationSortResultsEdgeAttribute, operationSortResultsNodeAttribute, operationSortResultsScore])).optional(), submitter: z.string().nullable().optional(), operations: operations.optional(), job_id: z.string().nullable().optional(), resource_id: z.string().nullable().optional(), tool_version: z.string().optional(), schema_version: z.string().optional(), biolink_version: z.string().optional(), datetime: z.string().optional(), table_column_names: z.array(z.string()).optional(), original_question: z.string().optional(), restated_question: z.string().optional(), query_options: z.object({}).optional(), context: z.string().optional(), type: z.string().optional(), id: z.string().optional(), validation_result: z.object({}).optional(), total_results_count: z.number().int().nullable().optional(), info: z.string().nullable().optional()}).and(z.record(z.string(), z.unknown())); 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 }; /** * Request a previously stored response from the server * * GET /response/{response_id} */ export const getApiResponseResponseId = async (args: GetApiResponseResponseIdArgs, options?: GetApiResponseResponseIdOptions) => { const {baseUrl = "https://arax.transltr.io/api/arax/v1.4", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") const url = `${baseUrl.replace(/\/+$/, '')}/response/${encodeURIComponent(String(args.response_id))}${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(response, await res.json()) };