import {z} from 'zod' export type GetApiRepositoryDetailsIdArgs = {id: string}; export type GetApiRepositoryDetailsIdOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const contactDetailsViewModel = z.object({AddressCountry: z.string().optional(), AddressLine1: z.string().optional(), AddressTown: z.string().optional(), CorrespondenceAddress: z.string().optional(), Email: z.string().optional(), Fax: z.string().optional(), MapUrl: z.string().optional(), PostCode: z.string().optional(), Telephone: z.string().optional(), Url: z.string().optional()}); export const accessInformationViewModel = z.object({Appointment: z.string().optional(), Carn: z.string().optional(), Comments: z.string().optional(), DisabledAccess: z.string().optional(), FeeText: z.string().optional(), Holidays: z.string().optional(), IdRequired: z.string().optional(), Introduction: z.string().optional(), OpeningHours: z.string().optional(), ResearchService: z.string().optional(), TicketText: z.string().optional()}); export const registryRecordViewModel = z.object({NRAID: z.number().int().optional(), RecordTitle: z.string().optional(), ROCollectionRef: z.string().optional(), OtherReference: z.string().optional(), ISADGReference: z.string().optional(), SortWord: z.string().optional(), ROAccessionNo: z.string().optional(), NRADetails: z.string().optional(), RecordType: z.enum(["Catalogue", "ScannedList"]).optional(), RegistryLinks: z.array(z.string()).optional()}); export const networkRecordViewModel = z.object({NetworkName: z.string().optional(), NetworkURL: z.string().optional()}); export const accessionViewModel = z.object({Year: z.string().optional(), Url: z.string().optional()}); export const nraDataViewModel = z.object({Id: z.string().optional(), Name: z.string().optional(), Description: z.string().optional(), SortPhrase: z.string().optional()}); export const repositoryViewModel = z.object({Id: z.string().optional(), ArchonReference: z.string().optional(), Title: z.string().optional(), SortKey: z.string().optional(), ContactDetails: contactDetailsViewModel.optional(), AccessInformation: accessInformationViewModel.optional(), RegistryRecords: z.array(registryRecordViewModel).optional(), NetworkNames: z.array(networkRecordViewModel).optional(), RepositoryType: z.string().optional(), CatalogueUrl: z.string().optional(), Accessions: z.array(accessionViewModel).optional(), People: z.array(nraDataViewModel).optional(), Businesses: z.array(nraDataViewModel).optional(), Organisations: z.array(nraDataViewModel).optional(), Families: z.array(nraDataViewModel).optional(), Other: z.array(nraDataViewModel).optional(), IsParent: z.boolean().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 }; /** * Get archive details by archive record ID * * GET /repository/details/{id} */ export const getApiRepositoryDetailsId = async (args: GetApiRepositoryDetailsIdArgs, options?: GetApiRepositoryDetailsIdOptions) => { 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") const url = `${baseUrl.replace(/\/+$/, '')}/repository/details/${encodeURIComponent(String(args.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(repositoryViewModel, await res.json()) };