import {z} from 'zod' export type GetApiSearchArchivesArgs = {'sps.repositoryCountries'?: Array | undefined, 'sps.repositoryRegions'?: Array | undefined, 'sps.repositoryCounties'?: Array | undefined, 'sps.repositoryTypes'?: (Array<'Local' | 'Special' | 'National' | 'University' | 'Private' | 'Business'>) | undefined, 'sps.archiveCode'?: number | undefined, 'sps.titleContains'?: string | 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 GetApiSearchArchivesOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const repositorySearchResultViewModel = z.object({Address: 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 repositorySearchResultsViewModel = z.object({Repositories: z.array(repositorySearchResultViewModel).optional(), RepositoryTypes: z.array(facetItemViewModel).optional(), Countries: z.array(facetItemViewModel).optional(), Regions: z.array(facetItemViewModel).optional(), Counties: 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 }; /** * Execute search of archives/repositories * * GET /search/archives */ export const getApiSearchArchives = async (args: GetApiSearchArchivesArgs, options?: GetApiSearchArchivesOptions) => { 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.repositoryCountries'] ?? []) query.append("sps.repositoryCountries", String(item)) for (const item of args['sps.repositoryRegions'] ?? []) query.append("sps.repositoryRegions", String(item)) for (const item of args['sps.repositoryCounties'] ?? []) query.append("sps.repositoryCounties", String(item)) for (const item of args['sps.repositoryTypes'] ?? []) query.append("sps.repositoryTypes", String(item)) if (args['sps.archiveCode'] != null) query.append("sps.archiveCode", String(args['sps.archiveCode'])) if (args['sps.titleContains'] != null) query.append("sps.titleContains", String(args['sps.titleContains'])) 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/archives${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(repositorySearchResultsViewModel, await res.json()) };