import {z} from 'zod' export type GetApiRecordsV1DetailsIdArgs = {id: string}; export type GetApiRecordsV1DetailsIdOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const accessRegulationViewModel = z.object({ClosureCriteria: z.array(z.string()).optional(), ClosureSetId: z.number().int().optional(), SignedDate: z.string().optional(), ReviewDate: z.string().optional(), ReconsiderDueInDate: z.string().optional(), LordChancellorsInstrument: z.string().optional(), Explanation: z.string().optional(), ProcatTitleText: z.string().optional()}); export const entityReferenceViewModel = z.object({Description: z.string().optional(), EndDate: z.number().int().optional(), FirstName: z.string().optional(), PreTitle: z.string().optional(), StartDate: z.number().int().optional(), Surname: z.string().optional(), Title: z.string().optional(), XReferenceId: z.string().optional(), XReferenceCode: z.string().optional(), XReferenceName: z.string().optional(), XReferenceType: z.string().optional(), XReferenceURL: z.string().optional(), XReferenceDescription: z.string().optional(), XReferenceSortWord: z.string().optional()}); export const xReferenceViewModel = z.object({XReferenceId: z.string().optional(), XReferenceCode: z.string().optional(), XReferenceName: z.string().optional(), XReferenceType: z.string().optional(), XReferenceURL: z.string().optional(), XReferenceDescription: z.string().optional(), XReferenceSortWord: z.string().optional()}); export const keyValuePairReferenceTypeString = z.object({Key: z.enum(["NRA_CATALOGUE", "NRA_OTHER"]).optional(), Value: z.string().optional()}); export const placeViewModel = z.object({Country: z.string().optional(), CountryID: z.number().int().optional(), County: z.string().optional(), CountyID: z.number().int().optional(), Description: z.string().optional(), DisplayName: z.string().optional(), EndDate: z.number().int().optional(), Grid: z.string().optional(), LocationType: z.string().optional(), NewCounty: z.string().optional(), NewCountyID: z.number().int().optional(), OldCounty: z.string().optional(), OldCountyID: z.number().int().optional(), Parish: z.string().optional(), PlaceName: z.string().optional(), Region: z.string().optional(), RegionID: z.number().int().optional(), StartDate: z.number().int().optional(), Town: z.string().optional(), TownID: z.number().int().optional(), Validation: z.string().optional()}); export const scopeContentViewModel = z.object({PlaceNames: z.array(z.string()).optional(), Description: z.string().optional(), Ephemera: z.string().optional(), Schema: z.string().optional()}); export const informationAssetViewModel = z.object({AccessRegulation: accessRegulationViewModel.optional(), Accruals: z.string().optional(), AccumulationDates: z.string().optional(), AdministrativeBackground: z.string().optional(), AppraisalInformation: z.string().optional(), Arrangement: z.string().optional(), BatchId: z.string().optional(), CopiesInformation: z.array(entityReferenceViewModel).optional(), CorporateNames: z.array(entityReferenceViewModel).optional(), CreatorName: z.array(entityReferenceViewModel).optional(), CustodialHistory: z.string().optional(), DetailedRelatedMaterial: z.array(entityReferenceViewModel).optional(), DetailedSeparatedMaterial: z.array(entityReferenceViewModel).optional(), Dimensions: z.string().optional(), FormerReferenceDep: z.string().optional(), FormerReferencePro: z.string().optional(), ImmediateSourceOfAcquisition: z.array(entityReferenceViewModel).optional(), Language: z.string().optional(), LegalStatus: z.string().optional(), Links: z.array(xReferenceViewModel).optional(), LocationOfOriginals: z.array(entityReferenceViewModel).optional(), MapDesignation: z.string().optional(), MapScaleNumber: z.number().int().optional(), Note: z.string().optional(), OtherReferences: z.array(keyValuePairReferenceTypeString).optional(), People: z.array(entityReferenceViewModel).optional(), PhysicalCondition: z.string().optional(), PhysicalDescriptionExtent: z.string().optional(), PhysicalDescriptionForm: z.string().optional(), Places: z.array(placeViewModel).optional(), PublicationNote: z.array(z.string()).optional(), RegistryUrl: z.string().optional(), RestrictionsOnUse: z.string().optional(), ScannedLists: z.array(xReferenceViewModel).optional(), Subjects: z.array(z.string()).optional(), UnpublishedFindingAids: z.array(z.string()).optional(), AccessConditions: z.string().optional(), CatalogueId: z.number().int().optional(), CitableReference: z.string().optional(), ClosureCode: z.string().optional(), ClosureStatus: z.string().optional(), ClosureType: z.string().optional(), CoveringDates: z.string().optional(), CoveringFromDate: z.number().int().optional(), CoveringToDate: z.number().int().optional(), ScopeContent: scopeContentViewModel.optional(), Digitised: z.boolean().optional(), HeldBy: z.array(xReferenceViewModel).optional(), Id: z.string().optional(), IsParent: z.boolean().optional(), CatalogueLevel: z.number().int().optional(), ParentId: z.string().optional(), RecordOpeningDate: z.string().optional(), ReferencePart: z.string().optional(), ReferenceParentId: z.string().optional(), SortKey: z.string().optional(), Source: z.string().optional(), Title: 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 }; /** * Get record details by ID * * GET /records/v1/details/{id} */ export const getApiRecordsV1DetailsId = async (args: GetApiRecordsV1DetailsIdArgs, options?: GetApiRecordsV1DetailsIdOptions) => { 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(/\/+$/, '')}/records/v1/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(informationAssetViewModel, await res.json()) };