import {z} from 'zod' export type GetApiV2SpeciesListArgs = {key: string, q?: string | undefined, page?: number | undefined, order?: ('asc' | 'desc') | undefined, edible?: (0 | 1) | undefined, indoor?: (0 | 1) | undefined, poisonous?: (0 | 1) | undefined, cycle?: ('annual' | 'biennial' | 'biannual' | 'perennial') | undefined, watering?: ('none' | 'minimum' | 'average' | 'frequent') | undefined, sunlight?: ('full_shade' | 'part_shade' | 'sun-part_shade' | 'full_sun') | undefined, hardiness?: string | undefined}; export type GetApiV2SpeciesListOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const speciesImage = z.object({license: z.number().int().optional(), license_name: z.string().optional(), license_url: z.string().optional(), original_url: z.string().optional(), regular_url: z.string().optional(), medium_url: z.string().optional(), small_url: z.string().optional(), thumbnail: z.string().optional()}); export const speciesList = z.object({id: z.number().int().optional(), common_name: z.string().optional(), scientific_name: z.array(z.string()).optional(), other_name: z.array(z.string()).optional(), family: z.string().optional(), hybrid: z.string().optional(), authority: z.string().optional(), subspecies: z.string().optional(), cultivar: z.string().optional(), variety: z.string().optional(), species_epithet: z.string().optional(), genus: z.string().optional(), default_image: speciesImage.optional()}); export const paginationMeta = z.object({to: z.number().int().optional(), per_page: z.number().int().optional(), current_page: z.number().int().optional(), from: z.number().int().optional(), last_page: z.number().int().optional(), total: z.number().int().optional()}); export const getApiV2SpeciesListResponse = z.object({data: z.array(speciesList).optional(), meta: paginationMeta.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 }; /** * List plant species (v2) * * GET /v2/species-list */ export const getApiV2SpeciesList = async (args: GetApiV2SpeciesListArgs, options?: GetApiV2SpeciesListOptions) => { const {baseUrl = "https://perenual.com/api", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.key != null) query.append("key", String(args.key)) if (args.q != null) query.append("q", String(args.q)) if (args.page != null) query.append("page", String(args.page)) if (args.order != null) query.append("order", String(args.order)) if (args.edible != null) query.append("edible", String(args.edible)) if (args.indoor != null) query.append("indoor", String(args.indoor)) if (args.poisonous != null) query.append("poisonous", String(args.poisonous)) if (args.cycle != null) query.append("cycle", String(args.cycle)) if (args.watering != null) query.append("watering", String(args.watering)) if (args.sunlight != null) query.append("sunlight", String(args.sunlight)) if (args.hardiness != null) query.append("hardiness", String(args.hardiness)) const url = `${baseUrl.replace(/\/+$/, '')}/v2/species-list${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(getApiV2SpeciesListResponse, await res.json()) };