import {z} from 'zod' export type AnnotationsCreate = {resource_type: string, resource_id: string, controlled_attribute_id: number, controlled_value_id: number}; export type CreateApiAnnotationsArgs = {body: AnnotationsCreate}; export type CreateApiAnnotationsOptions = {baseUrl?: string | undefined, userJwtRequired?: string | undefined, fetch?: typeof fetch | undefined}; export const controlledTerm: z.ZodType = z.object({id: z.number().int(), blocking: z.boolean().optional(), is_value: z.boolean().optional(), excepted_taxon_ids: z.array(z.number().int()).optional(), label: z.string().optional(), labels: z.array(z.object({id: z.number().int().optional(), definition: z.string().optional(), label: z.string().optional(), locale: z.string().optional(), valid_within_clade: z.number().int().nullable().optional()})).optional(), multivalued: z.boolean().optional(), ontology_uri: z.string().optional(), taxon_ids: z.array(z.number().int()).optional(), uri: z.string().optional(), uuid: z.string().nullable().optional(), valid_within_clade: z.number().int().nullable().optional(), values: z.array(z.lazy(() => controlledTerm)).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 vote = z.object({id: z.number().int().optional(), created_at: z.string().optional(), user: user.optional(), user_id: z.number().int().optional(), vote_flag: z.boolean().optional(), vote_scope: z.string().nullable().optional()}); export const annotation = z.object({concatenated_attr_val: z.string().optional(), controlled_attribute: controlledTerm.optional(), controlled_attribute_id: z.number().int().optional(), controlled_value: controlledTerm.optional(), controlled_value_id: z.number().int().optional(), user: user.optional(), user_id: z.number().int().optional(), uuid: z.string(), vote_score: z.number().int().optional(), votes: z.array(vote).optional()}); export const resultsAnnotations = z.object({total_results: z.number().int(), page: z.number().int(), per_page: z.number().int(), results: z.array(annotation)}); 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 }; /** * Create an annotation * * POST /annotations */ export const createApiAnnotations = async (args: CreateApiAnnotationsArgs, options?: CreateApiAnnotationsOptions) => { const {baseUrl = "https://api.inaturalist.org/v2", fetch: fetchFn = fetch, userJwtRequired} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (userJwtRequired !== undefined) headers.set("Authorization", userJwtRequired) const url = `${baseUrl.replace(/\/+$/, '')}/annotations${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(resultsAnnotations, await res.json()) };