import {z} from 'zod' export type CreateApiTaxaSuggestArgs = {body: BodyInit}; export type CreateApiTaxaSuggestOptions = {baseUrl?: string | undefined, userJwtRequired?: string | undefined, fetch?: typeof fetch | undefined}; export const conservationStatus = z.object({id: z.number().int(), authority: z.string().nullable().optional(), description: z.string().nullable().optional(), geoprivacy: z.string().nullable().optional(), iucn: z.number().int().optional(), iucn_status: z.string().optional(), iucn_status_code: z.string().optional(), place: z.object({id: z.number().int().optional(), name: z.string().optional(), display_name: z.string().optional(), ancestry: z.string().nullable().optional()}).nullable().optional(), place_id: z.number().int().nullable().optional(), source_id: z.number().int().nullable().optional(), status: z.string().optional(), status_name: z.string().optional(), taxon_id: z.number().int().optional(), user_id: z.number().int().nullable().optional(), url: z.string().nullable().optional()}).nullable(); export const site = z.object({id: z.number().int(), icon_url: z.string().optional(), locale: z.string().nullable().optional(), name: z.string().optional(), place_id: z.number().int().nullable().optional(), site_name_short: z.string().nullable().optional(), url: z.string().optional()}).nullable(); export const user = z.object({id: z.number().int(), uuid: z.string().optional(), created_at: z.string().optional(), description: z.string().nullable().optional(), faved_project_ids: z.array(z.number()).optional(), icon: z.string().nullable().optional(), icon_url: z.string().nullable().optional(), identifications_count: z.number().int().optional(), journal_posts_count: z.number().int().optional(), annotated_observations_count: z.number().int().optional(), last_active: z.string().optional(), login: z.string().optional(), monthly_supporter: z.boolean().nullable().optional(), name: z.string().nullable().optional(), observations_count: z.number().int().optional(), orcid: z.string().nullable().optional(), preferences: z.object({prefers_community_taxa: z.boolean().optional(), prefers_observation_fields_by: z.enum(["anyone", "curators", "observer"]).optional(), prefers_project_addition_by: z.enum(["any", "joined", "none"]).optional()}).optional(), roles: z.array(z.string()).optional(), site: site.optional(), site_id: z.number().int().nullable().optional(), spam: z.boolean().optional(), species_count: z.number().int().optional(), suspended: z.boolean().optional(), updated_at: z.string().optional()}).nullable(); export const flag = z.object({id: z.number().int(), comment: z.string().nullable().optional(), created_at: z.string().optional(), created_at_utc: z.string().nullable().optional(), flag: z.string().optional(), flaggable_content: z.string().nullable().optional(), flaggable_id: z.number().int().nullable().optional(), flaggable_type: z.string().nullable().optional(), flaggable_user_id: z.number().int().nullable().optional(), resolved: z.boolean().optional(), resolver_id: z.number().int().nullable().optional(), resolved_at: z.string().nullable().optional(), updated_at: z.string().nullable().optional(), updated_at_utc: z.string().nullable().optional(), user: user.optional(), user_id: z.number().int().optional(), uuid: z.string().nullable().optional()}); export const dateDetails = z.object({date: z.string(), day: z.number().int(), hour: z.number().int(), month: z.number().int(), week: z.number().int(), year: z.number().int()}).nullable(); export const moderatorAction = z.object({id: z.number().int(), created_at: z.string().optional(), created_at_details: dateDetails.optional(), user: user.optional(), action: z.string().optional(), reason: z.string().optional(), private: z.boolean().optional()}); export const photo = z.object({id: z.number().int(), attribution: z.string().optional(), attribution_name: z.string().nullable().optional(), flags: z.array(flag).optional(), hidden: z.boolean().optional(), large_url: z.string().nullable().optional(), license_code: z.string().nullable().optional(), medium_url: z.string().nullable().optional(), moderator_actions: z.array(moderatorAction).optional(), native_page_url: z.string().nullable().optional(), native_photo_id: z.string().nullable().optional(), original_dimensions: z.object({height: z.number().int().nullable().optional(), width: z.number().int().nullable().optional()}).nullable().optional(), original_url: z.string().nullable().optional(), small_url: z.string().nullable().optional(), square_url: z.string().nullable().optional(), type: z.string().optional(), url: z.string().nullable().optional(), original_filename: z.string().nullable().optional()}).nullable(); export const list = z.object({id: z.number().int(), title: z.string().nullable().optional()}).nullable(); export const polygonGeoJson = z.object({type: z.string(), coordinates: z.union([z.array(z.array(z.array(z.array(z.number())))), z.array(z.array(z.array(z.number())))])}).nullable(); export const pointGeoJson = z.object({coordinates: z.array(z.number()), type: z.string()}).nullable(); export const place = z.object({id: z.number().int(), admin_level: z.number().int().nullable().optional(), ancestor_place_ids: z.array(z.number().int()).nullable().optional(), bbox_area: z.number().nullable().optional(), bounding_box_geojson: polygonGeoJson.optional(), display_name: z.string().nullable().optional(), display_name_autocomplete: z.string().nullable().optional(), geometry_geojson: polygonGeoJson.optional(), location: z.string().nullable().optional(), matched_term: z.string().nullable().optional(), name: z.string().optional(), observations_count: z.number().int().optional(), place_type: z.number().int().nullable().optional(), point_geojson: pointGeoJson.optional(), slug: z.string().nullable().optional(), universal_search_rank: z.number().int().nullable().optional(), user: user.optional(), uuid: z.string().optional(), without_check_list: z.boolean().nullable().optional()}).nullable(); export const taxon: z.ZodType = z.object({id: z.number().int(), uuid: z.string().optional(), ancestors: z.array(z.lazy(() => taxon)).optional(), ancestor_ids: z.array(z.number().int()).optional(), ancestry: z.string().nullable().optional(), atlas_id: z.number().int().nullable().optional(), children: z.array(z.lazy(() => taxon)).optional(), complete_rank: z.string().optional(), complete_species_count: z.number().int().nullable().optional(), conservation_status: conservationStatus.optional(), conservation_statuses: z.array(conservationStatus).optional(), created_at: z.string().optional(), current_synonymous_taxon_ids: z.array(z.number().int()).nullable().optional(), default_photo: photo.optional(), endemic: z.boolean().optional(), english_common_name: z.string().optional(), establishment_means: z.object({establishment_means: z.string().optional(), id: z.number().int().optional(), place: z.object({id: z.number().int().optional(), name: z.string().optional(), display_name: z.string().optional(), ancestry: z.string().nullable().optional()}).optional()}).optional(), preferred_establishment_means: z.string().optional(), extinct: z.boolean().optional(), provisional: z.boolean().optional(), flag_counts: z.object({resolved: z.number().int().optional(), unresolved: z.number().int().optional()}).optional(), iconic_taxon_id: z.number().int().nullable().optional(), iconic_taxon_name: z.string().nullable().optional(), introduced: z.boolean().optional(), is_active: z.boolean().optional(), listed_taxa: z.array(z.object({id: z.number().int().optional(), establishment_means: z.string().optional(), list: list.optional(), taxon: z.lazy(() => taxon.optional()), taxon_id: z.number().int().optional(), place: place.optional()})).optional(), listed_taxa_count: z.number().int().optional(), matched_term: z.string().optional(), min_species_ancestry: z.string().optional(), min_species_taxon_id: z.number().int().optional(), name: z.string().optional(), native: z.boolean().optional(), observations_count: z.number().int().optional(), parent_id: z.number().int().nullable().optional(), photos_locked: z.boolean().optional(), preferred_common_name: z.string().nullable().optional(), preferred_common_names: z.array(z.unknown()).nullable().optional(), rank: z.string().optional(), rank_level: z.number().optional(), representative_photo: photo.optional(), statuses: z.array(z.unknown()).optional(), taxon_changes_count: z.number().int().optional(), taxon_photos: z.array(z.object({taxon: z.lazy(() => taxon.optional()), taxon_id: z.number().int().optional(), photo: photo.optional()})).optional(), taxon_schemes_count: z.number().int().optional(), threatened: z.boolean().optional(), universal_search_rank: z.number().int().optional(), vision: z.boolean().optional(), wikipedia_summary: z.string().nullable().optional(), wikipedia_url: z.string().nullable().optional()}).nullable(); export const commonAncestor = z.object({score: z.number().gte(0).lte(100).optional(), taxon: taxon}); export const listedTaxon = z.object({description: z.string().nullable().optional(), place: place.optional(), id: z.number().int(), created_at: z.string().optional(), updated_at: z.string().optional(), comments_count: z.number().int().optional(), occurrence_status_level: z.number().int().nullable().optional(), establishment_means: z.enum(["native", "endemic", "introduced"]).optional(), observations_count: z.number().int().optional(), manually_added: z.boolean().nullable().optional(), primary_listing: z.boolean().optional(), establishment_means_label: z.string().optional(), establishment_means_description: z.string().optional()}).nullable(); export const resultsTaxaSuggest = z.object({comprehensiveness: z.object({list: z.object({id: z.number().int(), title: z.string().optional(), source: z.object({url: z.string().optional(), in_text: z.string().optional()}).optional()}).optional()}).optional(), common_ancestor: commonAncestor.optional(), results: z.array(z.object({source_type: z.string(), score: z.number(), source_details: z.object({combined_score: z.number().optional(), frequency_score: z.number().optional(), listed_taxon: listedTaxon.optional(), observations_count: z.number().int().optional(), vision_score: z.number().optional()}).optional(), taxon: taxon})), query: z.object({featured_observation_id: z.string().optional(), fields: z.unknown(), image_url: z.string().optional(), include_representative_photos: z.union([z.boolean(), z.string()]).optional(), limit: z.number().gte(0).optional(), lat: z.number().gte(-90).lte(90).optional(), lng: z.number().gte(-180).lte(180).optional(), locale: z.string().optional(), months: z.string().optional(), observation_id: z.string().optional(), observed_on: z.string().optional(), order_by: z.enum(["taxonomy", "default", "sciname"]).optional(), place_id: z.number().int().optional(), place_lat: z.number().gte(-90).lte(90).optional(), place_lng: z.number().gte(-180).lte(180).optional(), source: z.enum(["captive_observations", "checklist", "misidentifications", "observations", "rg_observations", "visual"]).nullable().optional(), taxon_id: z.number().int().optional()}).optional(), queryTaxon: taxon.optional(), queryPlace: place.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 }; /** * Suggest taxa for identifications given conditions and an image * * POST /taxa/suggest */ export const createApiTaxaSuggest = async (args: CreateApiTaxaSuggestArgs, options?: CreateApiTaxaSuggestOptions) => { const {baseUrl = "https://api.inaturalist.org/v2", fetch: fetchFn = fetch, userJwtRequired} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (userJwtRequired !== undefined) headers.set("Authorization", userJwtRequired) const url = `${baseUrl.replace(/\/+$/, '')}/taxa/suggest${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: args.body}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(resultsTaxaSuggest, await res.json()) };