import {z} from 'zod' export type GetApiArticlesArgs = {'X-Cursor'?: string | undefined, page?: number | undefined, page_size?: number | undefined, limit?: number | undefined, offset?: number | undefined, order?: ('published_date' | 'created_date' | 'modified_date' | 'views' | 'shares' | 'downloads' | 'cites') | undefined, order_direction?: ('asc' | 'desc') | undefined, institution?: number | undefined, published_since?: string | undefined, modified_since?: string | undefined, group?: number | undefined, resource_doi?: string | undefined, item_type?: number | undefined, doi?: string | undefined, handle?: string | undefined}; export type GetApiArticlesOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const timeline = z.object({firstOnline: z.string().optional(), publisherPublication: z.string().optional(), publisherAcceptance: z.string().optional()}); export const article = z.object({id: z.number().int(), title: z.string(), doi: z.string(), handle: z.string(), url: z.string(), url_public_html: z.string(), url_public_api: z.string(), url_private_html: z.string(), url_private_api: z.string(), timeline: timeline, thumb: z.string(), defined_type: z.number().int(), defined_type_name: z.string(), resource_doi: z.string(), resource_title: z.string(), created_date: z.string(), modified_date: z.string().optional(), published_date: z.string().optional(), group_id: z.number().int().optional()}); export const getApiArticlesResponse = z.array(article); 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 }; /** * Public Articles * * GET /articles */ export const getApiArticles = async (args: GetApiArticlesArgs, options?: GetApiArticlesOptions) => { const {baseUrl = "https://api.figshare.com/v2", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['X-Cursor'] != null) headers.set("X-Cursor", String(args['X-Cursor'])) if (args.page != null) query.append("page", String(args.page)) if (args.page_size != null) query.append("page_size", String(args.page_size)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.offset != null) query.append("offset", String(args.offset)) if (args.order != null) query.append("order", String(args.order)) if (args.order_direction != null) query.append("order_direction", String(args.order_direction)) if (args.institution != null) query.append("institution", String(args.institution)) if (args.published_since != null) query.append("published_since", String(args.published_since)) if (args.modified_since != null) query.append("modified_since", String(args.modified_since)) if (args.group != null) query.append("group", String(args.group)) if (args.resource_doi != null) query.append("resource_doi", String(args.resource_doi)) if (args.item_type != null) query.append("item_type", String(args.item_type)) if (args.doi != null) query.append("doi", String(args.doi)) if (args.handle != null) query.append("handle", String(args.handle)) const url = `${baseUrl.replace(/\/+$/, '')}/articles${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(getApiArticlesResponse, await res.json()) };