import {z} from 'zod' export type GetApiFormQueryArgs = {publicId?: string | undefined, protocolId?: string | undefined}; export type GetApiFormQueryOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const classificationSchemeItem = z.object({publicId: z.string(), version: z.string(), longName: z.string(), context: z.string()}); export const classificationScheme = z.object({publicId: z.string(), version: z.string(), longName: z.string(), context: z.string(), ClassificationSchemeItems: z.array(classificationSchemeItem).optional()}); export const referenceDocument = z.object({name: z.string(), type: z.string(), docText: z.string(), context: z.string(), url: z.string()}); export const designation = z.object({name: z.string(), type: z.string(), language: z.string(), contextName: z.string()}); export const dataElement = z.object({beginDate: z.string(), changeNote: z.string(), createdBy: z.string(), dateCreated: z.string(), dateModified: z.string(), deletedIndicator: z.string(), endDate: z.string(), latestVersionIndicator: z.string(), longName: z.string(), modifiedBy: z.string(), publicID: z.string(), version: z.string(), shortName: z.string(), preferredDefinition: z.string(), origin: z.string(), referenceDocuments: z.array(referenceDocument), designations: z.array(designation)}); export const instruction = z.object({instruction: z.string()}); export const triggerAction = z.object({sourcePUB_ID: z.string(), sourceVER_NR: z.string(), source: z.string(), sourceModule: z.string(), sourceQuestion: z.string(), sourceValidValue: z.string(), targetPUB_ID: z.string(), targetVER_NR: z.string(), target: z.string(), targetModule: z.string(), targetQuestion: z.string(), targetValidValue: z.string(), dateCreated: z.string(), createdBy: z.string(), modifiedBy: z.string(), dateModified: z.string(), deletedIndicator: z.string(), triggerActionId: z.string(), instructions: instruction}); export const permissibleValue = z.object({validValue: z.string(), valueMeaning: z.string(), meaningDescription: z.string(), meaningConcepts: z.string(), meaningConceptOrigin: z.string(), meaningConceptDisplayOrder: z.string(), beginDate: z.string(), endDate: z.string(), publicID: z.string(), version: z.string()}); export const valueDomain = z.object({beginDate: z.string(), changeNote: z.string(), createdBy: z.string(), dateCreated: z.string(), dateModified: z.string(), deletedIndicator: z.string(), endDate: z.string(), latestVersionIndicator: z.string(), longName: z.string(), modifiedBy: z.string(), publicID: z.string(), version: z.string(), preferredDefinition: z.string(), preferredName: z.string(), datatypeName: z.string(), decimalPlace: z.string(), formatName: z.string(), highValueNumber: z.string(), lowValueNumber: z.string(), maximumLengthNumber: z.string(), minimumLengthNumber: z.string(), UOMName: z.string(), context: z.string(), origin: z.string(), triggerActions: z.array(triggerAction), permissibleValues: z.array(permissibleValue)}); export const valueMeaning = z.object({publicID: z.string(), version: z.string(), meaningConcepts: z.string().optional(), meaningConceptOrigin: z.string().optional(), meaningConceptDisplayOrder: z.string().optional(), longName: z.string().optional(), preferredDefinition: z.string().optional()}); export const validValues = z.object({value: z.string(), description: z.string(), dipslayOrder: z.string(), meaningText: z.string(), publicId: z.string(), version: z.string(), valueMeaning: valueMeaning, instructions: z.array(instruction), triggerActions: z.array(triggerAction)}); export const question = z.object({displayOrder: z.string(), defaultValue: z.string(), isEditable: z.string(), isMandatory: z.string(), questionShortName: z.string(), questionText: z.string(), dataElement: z.array(dataElement), instructions: z.array(instruction), valueDomain: z.array(valueDomain), validValues: z.array(validValues), triggerActions: z.array(triggerAction)}); export const module = z.object({longName: z.string(), displayOrder: z.string(), maximumQuestionRepeat: z.string(), publicID: z.string(), version: z.string(), questions: z.array(question), instructions: z.array(instruction), referenceDocuments: z.array(referenceDocument), triggerActions: z.array(triggerAction)}); export const protocol = z.object({protocolId: z.string(), longName: z.string(), organizationName: z.string(), beginDate: z.string(), changeNote: z.string(), createdBy: z.string(), dateCreated: z.string(), dateModified: z.string(), deletedIndicator: z.string(), endDate: z.string(), id: z.string(), modifiedBy: z.string(), origin: z.string(), preferredDefinition: z.string(), preferredName: z.string(), publicID: z.string(), version: z.string(), latestVersionIndicator: z.string()}); export const form = z.object({publicID: z.string(), version: z.string(), longName: z.string().optional(), context: z.string().optional(), latestVersionIndicator: z.string().optional(), type: z.string().optional(), definition: z.string().optional(), beginDate: z.string().optional(), changeNote: z.string().optional(), createdBy: z.string().optional(), dateCreated: z.string().optional(), dateModified: z.string().optional(), deletedIndicator: z.string().optional(), endDate: z.string().optional(), modifiedBy: z.string().optional(), preferredDefinition: z.string().optional(), category: z.string().optional(), registrationStatus: z.string().optional(), administrativeNotes: z.string().optional(), unresolvedIssues: z.string().optional(), workflowStatus: z.string().optional(), classificationSchemes: z.array(classificationScheme), modules: z.array(module), protocols: z.array(protocol), instructions: z.array(instruction), referenceDocuments: z.array(referenceDocument), triggerActions: z.array(triggerAction)}); export const callstackItem = z.object({service: z.string(), flowStep: z.string()}); export const apiResponse = z.object({type: z.string(), message: z.string().optional(), service: z.string().optional(), time: z.string().optional(), ssnid: z.string().optional(), callStack: z.array(callstackItem).optional()}); export const formqueryGETResponse = z.object({Forms: z.array(form).optional(), apiResponse: apiResponse}); 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 list of Form objects. * * GET /Form/query */ export const getApiFormQuery = async (args: GetApiFormQueryArgs, options?: GetApiFormQueryOptions) => { const {baseUrl = "https://cadsrapi.cancer.gov/rad/NCIFormAPI.v1_0:NciFormApiRad", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.publicId != null) query.append("publicId", String(args.publicId)) if (args.protocolId != null) query.append("protocolId", String(args.protocolId)) const url = `${baseUrl.replace(/\/+$/, '')}/Form/query${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(formqueryGETResponse, await res.json()) };