import {z} from 'zod' export type GetApiSearchFileauthoritiesArgs = {'sps.fileAuthorityEntityTypes'?: (Array<'B' | 'D' | 'F' | 'M' | 'O' | 'P'>) | undefined, 'sps.fileAuthorityCategories'?: Array | undefined, 'sps.fileAuthoritySubCategories'?: Array | undefined, 'sps.fileAuthorityGender'?: (Array<'M' | 'F' | 'O'>) | undefined, 'sps.fileAuthourityCountries'?: Array | undefined, 'sps.fileAuthorityRegions'?: Array | undefined, 'sps.fileAuthorityCounties'?: Array | undefined, 'sps.dateFrom'?: string | undefined, 'sps.dateTo'?: string | undefined, 'sps.oldCountyName'?: string | undefined, 'sps.timePeriods'?: Array | undefined, 'sps.townName'?: 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 GetApiSearchFileauthoritiesOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const nRARepositoryViewModel = z.object({RepositoryId: z.string().optional(), RepositoryName: z.string().optional()}); export const fileAuthoritySearchResultViewModel = z.object({AltName: z.string().optional(), SubjectType: z.string().optional(), RepositoriesCount: z.number().int().optional(), CollectionCount: z.number().int().optional(), Places: z.array(z.string()).optional(), Collections: z.array(nRARepositoryViewModel).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 fileAuthoritySearchResultsViewModel = z.object({FileAuthorityAssets: z.array(fileAuthoritySearchResultViewModel).optional(), NACategories: z.array(facetItemViewModel).optional(), NASubCategories: z.array(facetItemViewModel).optional(), Gender: z.array(facetItemViewModel).optional(), EntityTypes: z.array(facetItemViewModel).optional(), Countries: z.array(facetItemViewModel).optional(), Regions: z.array(facetItemViewModel).optional(), Counties: z.array(facetItemViewModel).optional(), Towns: z.array(facetItemViewModel).optional(), Places: z.array(facetItemViewModel).optional(), TimePeriods: 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 File AUthorities (Record creators) * * GET /search/fileauthorities */ export const getApiSearchFileauthorities = async (args: GetApiSearchFileauthoritiesArgs, options?: GetApiSearchFileauthoritiesOptions) => { 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.fileAuthorityEntityTypes'] ?? []) query.append("sps.fileAuthorityEntityTypes", String(item)) for (const item of args['sps.fileAuthorityCategories'] ?? []) query.append("sps.fileAuthorityCategories", String(item)) for (const item of args['sps.fileAuthoritySubCategories'] ?? []) query.append("sps.fileAuthoritySubCategories", String(item)) for (const item of args['sps.fileAuthorityGender'] ?? []) query.append("sps.fileAuthorityGender", String(item)) for (const item of args['sps.fileAuthourityCountries'] ?? []) query.append("sps.fileAuthourityCountries", String(item)) for (const item of args['sps.fileAuthorityRegions'] ?? []) query.append("sps.fileAuthorityRegions", String(item)) for (const item of args['sps.fileAuthorityCounties'] ?? []) query.append("sps.fileAuthorityCounties", 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'])) if (args['sps.oldCountyName'] != null) query.append("sps.oldCountyName", String(args['sps.oldCountyName'])) for (const item of args['sps.timePeriods'] ?? []) query.append("sps.timePeriods", String(item)) if (args['sps.townName'] != null) query.append("sps.townName", String(args['sps.townName'])) 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/fileauthorities${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(fileAuthoritySearchResultsViewModel, await res.json()) };