import {z} from 'zod' export type GetApiV2SpeciesDetailsIdArgs = {id: number, key: string}; export type GetApiV2SpeciesDetailsIdOptions = {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 speciesDetail = 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.union([z.literal(0), z.literal(1)]).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(), origin: z.array(z.string()).optional(), type: z.string().optional(), dimensions: z.array(z.object({type: z.string().nullable().optional(), min_value: z.number().optional(), max_value: z.number().optional(), unit: z.string().optional()})).optional(), cycle: z.string().optional(), attracts: z.array(z.string()).optional(), propagation: z.array(z.string()).optional(), hardiness: z.object({min: z.string().optional(), max: z.string().optional()}).optional(), hardiness_location: z.object({full_url: z.string().optional(), full_iframe: z.string().optional()}).optional(), watering: z.string().optional(), watering_general_benchmark: z.object({value: z.string().optional(), unit: z.string().optional()}).optional(), plant_anatomy: z.array(z.object({part: z.string().optional(), color: z.array(z.string()).optional()})).optional(), sunlight: z.array(z.string()).optional(), pruning_month: z.array(z.string()).optional(), pruning_count: z.object({amount: z.number().int().optional(), interval: z.string().optional()}).optional(), seeds: z.union([z.literal(0), z.literal(1)]).optional(), maintenance: z.string().optional(), care_guides: z.string().optional(), soil: z.array(z.string()).optional(), growth_rate: z.string().optional(), drought_tolerant: z.union([z.literal(0), z.literal(1)]).optional(), salt_tolerant: z.union([z.literal(0), z.literal(1)]).optional(), thorny: z.union([z.literal(0), z.literal(1)]).optional(), invasive: z.union([z.literal(0), z.literal(1)]).optional(), tropical: z.union([z.literal(0), z.literal(1)]).optional(), indoor: z.union([z.literal(0), z.literal(1)]).optional(), care_level: z.string().nullable().optional(), pest_susceptibility: z.array(z.string()).optional(), flowers: z.union([z.literal(0), z.literal(1)]).optional(), flowering_season: z.string().nullable().optional(), cones: z.union([z.literal(0), z.literal(1)]).optional(), fruits: z.union([z.literal(0), z.literal(1)]).optional(), edible_fruit: z.union([z.literal(0), z.literal(1)]).optional(), harvest_season: z.string().nullable().optional(), leaf: z.union([z.literal(0), z.literal(1)]).optional(), edible_leaf: z.union([z.literal(0), z.literal(1)]).optional(), cuisine: z.union([z.literal(0), z.literal(1)]).optional(), medicinal: z.union([z.literal(0), z.literal(1)]).optional(), poisonous_to_humans: z.union([z.literal(0), z.literal(1)]).optional(), poisonous_to_pets: z.union([z.literal(0), z.literal(1)]).optional(), description: z.string().optional(), default_image: speciesImage.optional(), other_images: z.array(speciesImage).optional(), xWateringQuality: z.array(z.string()).optional(), xWateringPeriod: z.array(z.string()).optional(), xWateringAvgVolumeRequirement: z.array(z.string()).optional(), xWateringDepthRequirement: z.object({unit: z.string().optional(), value: z.string().optional()}).optional(), xWateringBasedTemperature: z.object({unit: z.string().optional(), min: z.number().optional(), max: z.number().optional()}).optional(), xWateringPhLevel: z.object({min: z.number().optional(), max: z.number().optional()}).optional(), xSunlightDuration: z.object({min: z.string().optional(), max: z.string().optional(), unit: z.string().optional()}).optional(), xTemperatureTolence: z.array(z.string()).optional(), xPlantSpacingRequirement: z.object({unit: z.string().optional(), value: z.number().optional()}).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 species details (v2) * * GET /v2/species/details/{id} */ export const getApiV2SpeciesDetailsId = async (args: GetApiV2SpeciesDetailsIdArgs, options?: GetApiV2SpeciesDetailsIdOptions) => { 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)) const url = `${baseUrl.replace(/\/+$/, '')}/v2/species/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(speciesDetail, await res.json()) };