import {z} from 'zod' export type GetApiFileauthoritiesV1DetailsIdArgs = {id: string}; export type GetApiFileauthoritiesV1DetailsIdOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; 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 categoryViewModel = z.object({CategoryDescription: z.string().optional(), CategoryID: z.number().int().optional(), SubCategoryDescription: z.string().optional(), SubCategoryID: z.number().int().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 collectionViewModel = z.object({CatalogueURL: z.string().optional(), CoverindDates: z.string().optional(), OtherReferences: z.string().optional(), RecordDescription: z.string().optional(), RegistryRecordId: z.number().int().optional(), RegistryRecordReference: z.string().optional(), RegistryRecordSortWord: z.string().optional(), RegistryRecordTitle: z.string().optional(), RelatedIARecord: z.string().optional(), RepositoryID: z.string().optional(), RepositoryName: z.string().optional(), ScannedLists: z.array(entityReferenceViewModel).optional(), SortKey: z.string().optional(), Source: 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 relationshipViewModel = z.object({AuthorityName: z.string().optional(), FAID: z.string().optional(), RelationshipCategory: z.string().optional(), RelationshipDates: z.string().optional(), RelationshipDescription: z.string().optional()}); export const fileAuthorityViewModel = z.object({AuthorityName: z.string().optional(), BiographyHistory: z.string().optional(), BiographyHistoryLinks: z.array(xReferenceViewModel).optional(), Categories: z.array(categoryViewModel).optional(), Collections: z.array(collectionViewModel).optional(), CorpBodyIsPlaceOfDeposit: z.boolean().optional(), CorpBodyJurisdictionText: z.string().optional(), CorpBodyNationalPlaceOfDepositCode: z.string().optional(), CorpBodyRemitAndFunction: z.string().optional(), CorporateNumber: z.string().optional(), Epithet: z.string().optional(), Forenames: z.string().optional(), FunctionsOccupationsOrActivities: z.string().optional(), Gender: z.string().optional(), Genealogy: z.string().optional(), HistoricalContext: z.string().optional(), History: z.string().optional(), IsAuthorityRecord: z.boolean().optional(), IsPublic: z.boolean().optional(), LegalStatus: z.string().optional(), Name: z.string().optional(), NameForm: z.string().optional(), Places: z.array(placeViewModel).optional(), PreTitle: z.string().optional(), RelatedResources: z.array(xReferenceViewModel).optional(), Relationships: z.array(relationshipViewModel).optional(), SortName: z.string().optional(), Sources: z.string().optional(), SourcesOfAuthority: z.string().optional(), SubjectType: z.string().optional(), Title: z.string().optional(), ValidationText: z.string().optional(), VariantText: 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 a file authority details by record ID * * GET /fileauthorities/v1/details/{id} */ export const getApiFileauthoritiesV1DetailsId = async (args: GetApiFileauthoritiesV1DetailsIdArgs, options?: GetApiFileauthoritiesV1DetailsIdOptions) => { 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(/\/+$/, '')}/fileauthorities/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(fileAuthorityViewModel, await res.json()) };