import {z} from 'zod' export type TitleNumber = string; export type GetApiTitlesTitleNumberOfficialCopiesAvailabilityArgs = {title_number: TitleNumber}; export type GetApiTitlesTitleNumberOfficialCopiesAvailabilityOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const titleNumber = z.string().max(9); export const officialCopyAvailabilityCode = z.enum(["IMMEDIATE", "MANUAL", "UNAVAILABLE"]); export const referredDocumentAvailability = z.object({type: z.string(), type_code: z.string(), entry_numbers: z.array(z.string()), date: z.string().nullable().optional(), filed_under: z.string().max(9).nullable(), availability: z.string(), availability_code: officialCopyAvailabilityCode}); export const registerAvailability = z.object({type: z.string(), type_code: z.literal("REGISTER"), availability: z.string(), availability_code: officialCopyAvailabilityCode, backdated: z.boolean()}); export const titlePlanAvailability = z.object({type: z.string(), type_code: z.literal("TITLEPLAN"), availability: z.string(), availability_code: officialCopyAvailabilityCode, backdated: z.boolean()}); export const officialCopiesResponse = z.object({title_status: z.string(), title_status_code: z.enum(["VALID", "CLOSED", "CLOSED_AND_CONTINUED", "NOT_COMPUTERISED", "PENDING_APPLICATIONS", "PENDING_DEALING", "PENDING_FIRST", "SCHEME"]), title_number: titleNumber, applications_pending: z.boolean(), continued_under_title_number: z.string().optional(), referred_to_documents: z.array(referredDocumentAvailability), register: registerAvailability, title_plan: titlePlanAvailability}); export const getApiTitlesTitleNumberOfficialCopiesAvailabilityResponse = z.object({data: officialCopiesResponse}); 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 document availability associated with a title number. * * GET /titles/{title_number}/official-copies/availability */ export const getApiTitlesTitleNumberOfficialCopiesAvailability = async (args: GetApiTitlesTitleNumberOfficialCopiesAvailabilityArgs, options?: GetApiTitlesTitleNumberOfficialCopiesAvailabilityOptions) => { const {baseUrl = "https://businessgateway.landregistry.gov.uk/bg2/api/v1", fetch: fetchFn = fetch, basicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/titles/${encodeURIComponent(String(args.title_number))}/official-copies/availability${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(getApiTitlesTitleNumberOfficialCopiesAvailabilityResponse, await res.json()) };