/** * Atlas of Living Australia (ALA) API Type Definitions * * ALA provides access to 165M+ species occurrence records across Australia. */ export type ALAFacetField = 'kingdom' | 'phylum' | 'class' | 'order' | 'family' | 'genus' | 'species' | 'stateProvince' | 'basisOfRecord' | 'year' | 'month' | 'dataResourceName'; export declare const ALA_FACET_FIELDS: ALAFacetField[]; export declare const ALA_FACET_DISPLAY_NAMES: Record; export interface ALAFacetValue { value: string; count: number; } export interface ALAFacet { name: ALAFacetField; displayName: string; values: ALAFacetValue[]; } export type ALASortOption = 'relevance' | 'date_asc' | 'date_desc' | 'taxon_name'; export declare const ALA_SORT_OPTIONS: ALASortOption[]; export declare const ALA_SORT_MAPPINGS: Record; /** Basis of record types - how the occurrence was recorded */ export type ALABasisOfRecord = 'PRESERVED_SPECIMEN' | 'HUMAN_OBSERVATION' | 'MACHINE_OBSERVATION' | 'FOSSIL_SPECIMEN' | 'LIVING_SPECIMEN'; export declare const ALA_BASIS_OF_RECORD: ALABasisOfRecord[]; export interface ALAOccurrenceSearchParams { /** Search query (taxon name, location, etc.) */ q?: string; /** Filter by scientific name */ scientificName?: string; /** Filter by common name */ vernacularName?: string; /** Filter by kingdom (Animalia, Plantae, etc.) */ kingdom?: string; /** Filter by family */ family?: string; /** Filter by genus */ genus?: string; /** Filter by species */ species?: string; /** Filter by state/territory */ stateProvince?: string; /** Filter by data resource UID */ dataResourceUid?: string; /** Filter by data resource name */ dataResourceName?: string; /** Start year */ startYear?: number; /** End year */ endYear?: number; /** Only records with images */ hasImages?: boolean; /** Only spatially valid records */ spatiallyValid?: boolean; /** Basis of record filter */ basisOfRecord?: ALABasisOfRecord; /** Maximum coordinate uncertainty in metres */ coordinateUncertaintyMax?: number; /** Occurrence status (present/absent) */ occurrenceStatus?: 'present' | 'absent'; /** Collector/recorded by name */ collector?: string; /** Centre latitude for spatial search (SEARCH-016) */ lat?: number; /** Centre longitude for spatial search (SEARCH-016) */ lon?: number; /** Search radius in kilometres (SEARCH-016) */ radius?: number; /** Page size (max 100) */ pageSize?: number; /** Start index for pagination */ startIndex?: number; /** Sort field */ sort?: 'score' | 'taxon_name' | 'event_date'; /** Sort direction */ dir?: 'asc' | 'desc'; /** Include facet counts */ includeFacets?: boolean; /** Facet fields to return */ facetFields?: ALAFacetField[]; /** Max values per facet */ facetLimit?: number; } export interface ALASpeciesSearchParams { /** Search query */ q: string; /** Filter by ID list */ idxtype?: 'TAXON' | 'COMMON' | 'IDENTIFIER'; /** Maximum results */ max?: number; /** Start offset */ start?: number; } export interface ALAOccurrence { uuid: string; occurrenceID?: string; scientificName: string; vernacularName?: string; taxonRank?: string; kingdom?: string; phylum?: string; classs?: string; order?: string; family?: string; genus?: string; species?: string; stateProvince?: string; country?: string; decimalLatitude?: number; decimalLongitude?: number; coordinateUncertaintyInMeters?: number; eventDate?: number; year?: number; month?: string; basisOfRecord?: string; dataResourceName?: string; dataResourceUid?: string; dataProviderName?: string; license?: string; imageUrl?: string; thumbnailUrl?: string; images?: string[]; spatiallyValid?: boolean; assertions?: string[]; recordedBy?: string[]; collectors?: string[]; } export interface ALAOccurrenceSearchResult { totalRecords: number; pageSize: number; startIndex: number; status: string; sort: string; dir: string; occurrences: ALAOccurrence[]; facets?: ALAFacet[]; } export interface ALASpecies { guid: string; name: string; scientificName: string; author?: string; rank?: string; rankId?: number; commonName?: string; commonNames?: string[]; kingdom?: string; phylum?: string; classs?: string; order?: string; family?: string; genus?: string; nameComplete?: string; acceptedConceptGuid?: string; acceptedConceptName?: string; taxonomicStatus?: string; imageUrl?: string; thumbnailUrl?: string; occurrenceCount?: number; } export interface ALASpeciesProfile { taxonConcept: ALASpecies; commonNames?: Array<{ nameString: string; status?: string; priority?: number; }>; synonyms?: Array<{ nameString: string; author?: string; }>; imageIdentifier?: string; images?: Array<{ imageId: string; title?: string; creator?: string; license?: string; thumbnailUrl?: string; largeImageUrl?: string; }>; conservationStatuses?: Array<{ status: string; region?: string; system?: string; }>; habitats?: string[]; } export interface ALASpeciesSearchResult { searchResults: { totalRecords: number; startIndex: number; pageSize: number; results: ALASpecies[]; }; } export interface ALAAutoCompleteResult { guid: string; name: string; commonName?: string; matchedNames?: string[]; kingdom?: string; rankId?: number; rankString?: string; } export interface ALAImageSearchParams { /** Search query */ q: string; /** Maximum results (default 20) */ pageSize?: number; /** Start offset */ offset?: number; } export interface ALAImage { imageId: string; imageUrl: string; thumbnailUrl?: string; largeImageUrl?: string; title?: string; creator?: string; license?: string; dataResourceName?: string; occurrenceId?: string; scientificName?: string; vernacularName?: string; recognisedLicence?: string; } export interface ALAImageSearchResult { totalRecords: number; pageSize: number; startIndex: number; images: ALAImage[]; } export interface ALANameMatchResult { success: boolean; scientificName?: string; scientificNameAuthorship?: string; taxonConceptID?: string; rank?: string; rankId?: number; lft?: number; rgt?: number; matchType?: string; nameType?: string; synonymType?: string; kingdom?: string; kingdomID?: string; phylum?: string; phylumID?: string; classs?: string; classID?: string; order?: string; orderID?: string; family?: string; familyID?: string; genus?: string; genusID?: string; species?: string; speciesID?: string; vernacularName?: string; issues?: string[]; } export interface ALASpeciesList { dataResourceUid: string; listName: string; listType?: string; dateCreated?: string; lastUpdated?: string; itemCount: number; isAuthoritative?: boolean; isPrivate?: boolean; region?: string; description?: string; } export interface ALASpeciesListSearchResult { lists: ALASpeciesList[]; listCount: number; max: number; offset: number; } export interface ALASpeciesListItem { id: number; lsid?: string; name: string; commonName?: string; scientificName?: string; kvpValues?: Record[]; } export interface ALASpeciesListDetail { dataResourceUid: string; listName: string; listType?: string; description?: string; dateCreated?: string; lastUpdated?: string; itemCount: number; items: ALASpeciesListItem[]; } //# sourceMappingURL=types.d.ts.map