import {z} from 'zod' export type GetApiSearchRecordsArgs = {'sps.recordSeries'?: Array | undefined, 'sps.references'?: Array | undefined, 'sps.recordCollections'?: (Array<'All' | 'Records' | 'DigitisedRecords' | 'NRARecords' | 'A2ARecords'>) | undefined, 'sps.dateFrom'?: string | undefined, 'sps.dateTo'?: string | undefined, 'sps.timePeriods'?: Array | undefined, 'sps.recordRepositories'?: Array | undefined, 'sps.departments'?: Array | undefined, 'sps.taxonomySubjects'?: Array | undefined, 'sps.catalogueLevels'?: (Array<'NotStated' | 'Level1' | 'Level2' | 'Level3' | 'Level4' | 'Level5' | 'Level6' | 'Level7' | 'Level8' | 'Level9' | 'Level10' | 'Level11'>) | undefined, 'sps.closureStatuses'?: (Array<'O' | 'C' | 'R' | 'P' | 'U' | 'NA'>) | undefined, 'sps.corporateNames'?: string | undefined, 'sps.heldByCode'?: ('ALL' | 'TNA' | 'OTH') | undefined, 'sps.documentType'?: string | undefined, 'sps.titleName'?: string | undefined, 'sps.firstName'?: string | undefined, 'sps.lastName'?: string | undefined, 'sps.dateOfBirthFrom'?: string | undefined, 'sps.dateOfBirthTo'?: string | undefined, 'sps.number'?: string | undefined, 'sps.occupation'?: string | undefined, 'sps.recordPlace'?: string | undefined, 'sps.oldCountyName'?: string | undefined, 'sps.townName'?: string | undefined, 'sps.recordOpeningFromDate'?: string | undefined, 'sps.recordOpeningToDate'?: string | undefined, 'sps.referenceFirstLetter'?: string | undefined, 'sps.referenceQuery'?: string | undefined, 'sps.searchRestrictionFields'?: Array | undefined, 'sps.searchQuery': string, 'sps.returnHighlighted'?: boolean | undefined, 'sps.sortByOption'?: ('RELEVANCE' | 'REFERENCE_ASCENDING' | 'DATE_ASCENDING' | 'DATE_DESCENDING' | 'TITLE_ASCENDING' | 'TITLE_DESCENDING') | undefined, 'sps.page'?: number | undefined, 'sps.resultsPageSize'?: number | undefined, 'sps.titleFirstLetter'?: string | undefined, 'sps.batchStartMark'?: string | undefined, 'sps.preferenceQueryStringParameter'?: string | undefined}; export type GetApiSearchRecordsOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const recordSearchResultViewModels = z.object({AltName: z.string().optional(), Places: z.array(z.string()).optional(), CorpBodies: z.array(z.string()).optional(), Taxonomies: z.array(z.string()).optional(), FormerReferenceDep: z.string().optional(), FormerReferencePro: z.string().optional(), HeldBy: z.array(z.string()).optional(), Context: z.string().optional(), Content: z.string().optional(), URLParameters: z.string().optional(), Department: z.string().optional(), Note: z.string().optional(), AdminHistory: z.string().optional(), Arrangement: z.string().optional(), MapDesignation: z.string().optional(), MapScale: z.string().optional(), PhysicalCondition: z.string().optional(), CatalogueLevel: z.number().int().optional(), OpeningDate: z.string().optional(), ClosureStatus: z.string().optional(), ClosureType: z.string().optional(), ClosureCode: z.string().optional(), DocumentType: z.string().optional(), CoveringDates: z.string().optional(), Description: z.string().optional(), EndDate: z.string().optional(), NumEndDate: z.number().int().optional(), NumStartDate: z.number().int().optional(), StartDate: z.string().optional(), Id: z.string().optional(), Reference: z.string().optional(), Score: z.number().optional(), Source: z.string().optional(), Title: z.string().optional()}); export const facetItemViewModel = z.object({Code: z.string().optional(), Count: z.number().int().optional()}); export const recordSearchResultsViewModel = z.object({Records: z.array(recordSearchResultViewModels).optional(), TaxonomySubjects: z.array(facetItemViewModel).optional(), TimePeriods: z.array(facetItemViewModel).optional(), Departments: z.array(facetItemViewModel).optional(), CatalogueLevels: z.array(facetItemViewModel).optional(), ClosureStatuses: z.array(facetItemViewModel).optional(), Sources: z.array(facetItemViewModel).optional(), Repositories: z.array(facetItemViewModel).optional(), HeldByReps: z.array(facetItemViewModel).optional(), ReferenceFirstLetters: z.array(facetItemViewModel).optional(), TitleFirstLetters: z.array(facetItemViewModel).optional(), Count: z.number().int().optional(), NextBatchMark: z.string().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 }; /** * Executes search of records * * GET /search/records */ export const getApiSearchRecords = async (args: GetApiSearchRecordsArgs, options?: GetApiSearchRecordsOptions) => { const {baseUrl = "https://discovery.nationalarchives.gov.uk/API", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") for (const item of args['sps.recordSeries'] ?? []) query.append("sps.recordSeries", String(item)) for (const item of args['sps.references'] ?? []) query.append("sps.references", String(item)) for (const item of args['sps.recordCollections'] ?? []) query.append("sps.recordCollections", String(item)) if (args['sps.dateFrom'] != null) query.append("sps.dateFrom", String(args['sps.dateFrom'])) if (args['sps.dateTo'] != null) query.append("sps.dateTo", String(args['sps.dateTo'])) for (const item of args['sps.timePeriods'] ?? []) query.append("sps.timePeriods", String(item)) for (const item of args['sps.recordRepositories'] ?? []) query.append("sps.recordRepositories", String(item)) for (const item of args['sps.departments'] ?? []) query.append("sps.departments", String(item)) for (const item of args['sps.taxonomySubjects'] ?? []) query.append("sps.taxonomySubjects", String(item)) for (const item of args['sps.catalogueLevels'] ?? []) query.append("sps.catalogueLevels", String(item)) for (const item of args['sps.closureStatuses'] ?? []) query.append("sps.closureStatuses", String(item)) if (args['sps.corporateNames'] != null) query.append("sps.corporateNames", String(args['sps.corporateNames'])) if (args['sps.heldByCode'] != null) query.append("sps.heldByCode", String(args['sps.heldByCode'])) if (args['sps.documentType'] != null) query.append("sps.documentType", String(args['sps.documentType'])) if (args['sps.titleName'] != null) query.append("sps.titleName", String(args['sps.titleName'])) if (args['sps.firstName'] != null) query.append("sps.firstName", String(args['sps.firstName'])) if (args['sps.lastName'] != null) query.append("sps.lastName", String(args['sps.lastName'])) if (args['sps.dateOfBirthFrom'] != null) query.append("sps.dateOfBirthFrom", String(args['sps.dateOfBirthFrom'])) if (args['sps.dateOfBirthTo'] != null) query.append("sps.dateOfBirthTo", String(args['sps.dateOfBirthTo'])) if (args['sps.number'] != null) query.append("sps.number", String(args['sps.number'])) if (args['sps.occupation'] != null) query.append("sps.occupation", String(args['sps.occupation'])) if (args['sps.recordPlace'] != null) query.append("sps.recordPlace", String(args['sps.recordPlace'])) if (args['sps.oldCountyName'] != null) query.append("sps.oldCountyName", String(args['sps.oldCountyName'])) if (args['sps.townName'] != null) query.append("sps.townName", String(args['sps.townName'])) if (args['sps.recordOpeningFromDate'] != null) query.append("sps.recordOpeningFromDate", String(args['sps.recordOpeningFromDate'])) if (args['sps.recordOpeningToDate'] != null) query.append("sps.recordOpeningToDate", String(args['sps.recordOpeningToDate'])) if (args['sps.referenceFirstLetter'] != null) query.append("sps.referenceFirstLetter", String(args['sps.referenceFirstLetter'])) if (args['sps.referenceQuery'] != null) query.append("sps.referenceQuery", String(args['sps.referenceQuery'])) for (const item of args['sps.searchRestrictionFields'] ?? []) query.append("sps.searchRestrictionFields", String(item)) if (args['sps.searchQuery'] != null) query.append("sps.searchQuery", String(args['sps.searchQuery'])) if (args['sps.returnHighlighted'] != null) query.append("sps.returnHighlighted", String(args['sps.returnHighlighted'])) if (args['sps.sortByOption'] != null) query.append("sps.sortByOption", String(args['sps.sortByOption'])) if (args['sps.page'] != null) query.append("sps.page", String(args['sps.page'])) if (args['sps.resultsPageSize'] != null) query.append("sps.resultsPageSize", String(args['sps.resultsPageSize'])) if (args['sps.titleFirstLetter'] != null) query.append("sps.titleFirstLetter", String(args['sps.titleFirstLetter'])) if (args['sps.batchStartMark'] != null) query.append("sps.batchStartMark", String(args['sps.batchStartMark'])) if (args['sps.preferenceQueryStringParameter'] != null) query.append("sps.preferenceQueryStringParameter", String(args['sps.preferenceQueryStringParameter'])) const url = `${baseUrl.replace(/\/+$/, '')}/search/records${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(recordSearchResultsViewModel, await res.json()) };