import {z} from 'zod' export type GetApiV01DiscoveryResourcesArgs = {q?: string | undefined, page?: number | undefined, per_page?: number | undefined, sort?: ('relevance' | 'title' | 'creator' | 'date') | undefined, sort_direction?: ('asc' | 'desc') | undefined, search_scope?: ('all' | 'title' | 'journal_title' | 'contributor' | 'subject' | 'series' | 'callnumber' | 'standard_number') | undefined, 'filters[*]'?: string | undefined, contributor?: string | undefined, title?: string | undefined, subject?: string | undefined, isbn?: string | undefined, issn?: string | undefined, lccn?: string | undefined, oclc?: string | undefined}; export type GetApiV01DiscoveryResourcesOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const entityStub = z.object({"@type": z.string().optional(), "@id": z.string().optional(), prefLabel: z.string().optional()}); export const item = z.object({"@id": z.string().optional(), accessMessage: z.array(entityStub).optional(), deliveryLocation: z.array(entityStub).optional(), eddRequestable: z.boolean().optional(), holdingLocation: z.array(entityStub).optional(), idBarcode: z.string().optional(), identifier: z.array(z.string()).optional(), owner: z.array(entityStub).optional(), physRequestable: z.boolean().optional(), requestable: z.array(z.boolean()).optional(), shelfMark: z.array(z.string()).optional(), specRequestable: z.boolean().optional(), status: z.array(entityStub).optional(), uri: z.string().optional()}); export const resource = z.object({"@type": z.array(z.string()).optional(), "@id": z.string().optional(), carrierType: z.array(entityStub).optional(), creatorLiteral: z.array(z.string()).optional(), contributorLiteral: z.array(z.string()).optional(), created: z.string().optional(), createdYear: z.number().int().optional(), dateStartYear: z.number().int().optional(), depiction: z.string().optional(), description: z.string().optional(), endYear: z.number().int().optional(), extent: z.array(z.string()).optional(), holdingCount: z.number().int().optional(), issuance: z.array(entityStub).optional(), items: z.array(item).optional(), "^id": z.string().optional(), language: z.array(entityStub).optional(), materialType: z.array(entityStub).optional(), mediaType: z.array(entityStub).optional(), note: z.array(z.object({"@type": z.literal("bf:Note").optional(), noteType: z.string().optional(), label: z.string().optional()})).optional(), numAvailable: z.number().int().optional(), placeOfPublication: z.array(z.string()).optional(), prefLabel: z.array(z.string()).optional(), "roles:ROLE": z.array(z.string()).optional(), startYear: z.number().int().optional(), subject: z.array(entityStub).optional(), suppressed: z.boolean().optional(), title: z.array(z.string()).optional(), titleDisplay: z.array(z.string()).optional(), type: z.array(z.enum(["nypl:Item", "nypl:Collection"])).optional(), uri: z.string().optional()}); export const resourceResult = z.object({"@type": z.literal("searchResult").optional(), result: resource.optional()}); export const resourcesResponse = z.object({"@context": z.string().optional(), "@type": z.literal("itemList").optional(), itemListElement: z.array(resourceResult).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 }; /** * Search resources (bibs and items) * * GET /v0.1/discovery/resources */ export const getApiV01DiscoveryResources = async (args: GetApiV01DiscoveryResourcesArgs, options?: GetApiV01DiscoveryResourcesOptions) => { const {baseUrl = "https://platform.nypl.org/api", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.q != null) query.append("q", String(args.q)) if (args.page != null) query.append("page", String(args.page)) if (args.per_page != null) query.append("per_page", String(args.per_page)) if (args.sort != null) query.append("sort", String(args.sort)) if (args.sort_direction != null) query.append("sort_direction", String(args.sort_direction)) if (args.search_scope != null) query.append("search_scope", String(args.search_scope)) if (args['filters[*]'] != null) query.append("filters[*]", String(args['filters[*]'])) if (args.contributor != null) query.append("contributor", String(args.contributor)) if (args.title != null) query.append("title", String(args.title)) if (args.subject != null) query.append("subject", String(args.subject)) if (args.isbn != null) query.append("isbn", String(args.isbn)) if (args.issn != null) query.append("issn", String(args.issn)) if (args.lccn != null) query.append("lccn", String(args.lccn)) if (args.oclc != null) query.append("oclc", String(args.oclc)) const url = `${baseUrl.replace(/\/+$/, '')}/v0.1/discovery/resources${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(resourcesResponse, await res.json()) };