@nextgis/geocoder 1.18.15 → 1.18.18

package/lib/index.d.ts

@@ -9,6 +9,7 @@ import CancelablePromise from '@nextgis/cancelable-promise';
 import type { FeatureItem } from '@nextgis/ngw-connector';
 import type { FetchNgwItemsOptions } from '@nextgis/ngw-kit';
 import { GeoJsonObject } from 'geojson';
+import { LngLatArray } from '@nextgis/utils';
 import { LngLatBoundsArray } from '@nextgis/utils';
 import NgwConnector from '@nextgis/ngw-connector';
 import type { NgwConnectorOptions } from '@nextgis/ngw-connector';
@@ -26,18 +27,27 @@ declare abstract class BaseGeocoder<O extends Record<string, any> = Record<strin
      * Search method to retrieve geocoding results.
      *
      * @abstract
-     * @param {string} query - The search string to geocode.
-     * @yields {AsyncGenerator<SearchItem>} - An async generator that yields search results.
+     * @param query - The search string to geocode.
+     * @yields An async generator that yields search results.
      */
     abstract search(query: string): AsyncGenerator<SearchItem>;
     /**
      * Method to retrieve detailed result for a specific search item.
      *
      * @abstract
-     * @param {SearchItem} item - The search item to get detailed result for.
-     * @returns {CancelablePromise<any>} - A promise that resolves to the detailed result.
+     * @param item - The search item to get detailed result for.
+     * @returns A promise that resolves to the detailed result.
      */
     abstract result(item: SearchItem): CancelablePromise<any>;
+    /**
+     * Method for reverse geocoding.
+     * Takes coordinates and returns the corresponding address or location information.
+     *
+     * @abstract
+     * @param  coordinates - The longitude and latitude values.
+     * @returns An async generator that yields reverse geocoding results.
+     */
+    abstract reverse(coordinates: LngLatArray): AsyncGenerator<SearchItem>;
     /**
      * Optional method to abort any ongoing geocoding requests.
      *
@@ -88,6 +98,14 @@ export declare class Geocoder extends BaseGeocoder<GeocoderOptions> {
     abort(): void;
     search(query: string): AsyncGenerator<SearchItem, void, unknown>;
     result(item: SearchItem): CancelablePromise<any>;
+    reverse(coordinates: LngLatArray): AsyncGenerator<SearchItem, void, unknown>;
+    /**
+     * Returns the first reverse geocoding result for given coordinates from any provider.
+     *
+     * @param coordinates - The longitude and latitude values.
+     * @returns A promise that resolves to the first reverse geocoding result, or undefined if no results are found.
+     */
+    reverseGeocodeFirstResult(coordinates: LngLatArray): Promise<SearchItem | undefined>;
 }
 
 /**
@@ -109,6 +127,7 @@ export declare class NgwProvider extends BaseProvider<NgwProviderOptions> {
     abort(): void;
     search(query: string): AsyncGenerator<NgwSearchItem, void, unknown>;
     result(item: NgwSearchItem): CancelablePromise<ResultItem>;
+    reverse(coordinates: LngLatArray): AsyncGenerator<SearchItem, void, unknown>;
     private _makeSignal;
     private _items;
 }
@@ -146,6 +165,7 @@ export declare class NominatimProvider extends BaseProvider {
     abort(): void;
     search(val: string): AsyncGenerator<SearchItem, void, unknown>;
     result(model: SearchItem): CancelablePromise<ResultItem>;
+    reverse(coordinates: LngLatArray): AsyncGenerator<SearchItem, void, unknown>;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nextgis/geocoder",
-  "version": "1.18.15",
+  "version": "1.18.18",
   "description": "",
   "main": "index.js",
   "module": "lib/geocoder.esm-bundler.js",
@@ -53,5 +53,5 @@
   "bugs": {
     "url": "https://github.com/nextgis/nextgis_frontend/issues"
   },
-  "gitHead": "10fc096eaf42c9191dcdb7fb2bfec77a315285a8"
+  "gitHead": "383fb908139c79f1265a69fc9b48fef82028076c"
 }