@nextgis/geocoder 3.0.0-alpha.8 → 3.0.0

package/lib/index.d.ts

@@ -1,22 +1,8 @@
 import { LngLatBoundsArray, LngLatArray } from '@nextgis/utils';
 import { GeoJsonObject } from 'geojson';
-import NgwConnector, { FeatureItem, ResourceItem, NgwConnectorOptions } from '@nextgis/ngw-connector';
+import NgwConnector, { FeatureItem, NgwConnectorOptions } from '@nextgis/ngw-connector';
 import { FetchNgwItemsOptions } from '@nextgis/ngw-kit';
-
-interface ResultItem {
-    /**
-     * Display text of the result item.
-     */
-    text: string;
-    /**
-     * Bounding box of the result item in [west, south, east, north] format.
-     */
-    extent: LngLatBoundsArray;
-    /**
-     * Optional GeoJSON geometry associated with this result item.
-     */
-    geom?: GeoJsonObject;
-}
+import { CompositeRead } from '@nextgisweb/resource/type/api';
 
 /**
  * Options for initializing a basic search provider.
@@ -52,6 +38,21 @@ declare abstract class BaseProvider<O extends BaseProviderOptions = BaseProvider
     label?: string;
 }
 
+interface ResultItem {
+    /**
+     * Display text of the result item.
+     */
+    text: string;
+    /**
+     * Bounding box of the result item in [west, south, east, north] format.
+     */
+    extent: LngLatBoundsArray;
+    /**
+     * Optional GeoJSON geometry associated with this result item.
+     */
+    geom?: GeoJsonObject;
+}
+
 interface SearchItem {
     /**
      * A dynamic property bucket for the `SearchItem`.
@@ -165,7 +166,7 @@ interface NgwSearchItem extends SearchItem {
     /** The specific feature item from NGW */
     item: FeatureItem;
     /** The NGW resource item */
-    resourceItem: ResourceItem;
+    resourceItem: CompositeRead;
 }
 /**
  * Defines the structure for a rendered search item.
@@ -174,7 +175,7 @@ interface RenderSearchItem {
     /** The specific feature item */
     item: FeatureItem;
     /** The NGW resource item */
-    resourceItem: ResourceItem;
+    resourceItem: CompositeRead;
 }
 /**
  * Options for searching within a NGW resource.
@@ -210,10 +211,28 @@ declare class NgwProvider extends BaseProvider<NgwProviderOptions> {
     private _items;
 }
 
-declare class NominatimProvider extends BaseProvider {
+/**
+ * Nominatim based options {@link https://nominatim.org/release-docs/latest/api/Search}
+ */
+interface NominatimProviderOptions extends BaseProviderOptions {
+    /** Browser language string */
+    language?: string;
+    /** Comma-separated list of country codes {}*/
+    countrycodes?: string;
+    /** Limit the number of search results */
+    limit?: number;
+    /** Include address details in the results */
+    addressdetails?: boolean;
+    /** Restrict the results to the specified viewbox */
+    bounded?: boolean;
+    /** Focuses the search on the given area [minLon, minLat, maxLon, maxLat] */
+    viewbox?: [number, number, number, number];
+}
+declare class NominatimProvider extends BaseProvider<NominatimProviderOptions> implements NominatimProviderOptions {
+    options?: NominatimProviderOptions | undefined;
     searchUrl: string;
-    private _abort;
-    constructor(options?: BaseProviderOptions);
+    private _abortControllers;
+    constructor(options?: NominatimProviderOptions | undefined);
     abort(): void;
     search(val: string): AsyncGenerator<SearchItem, void, unknown>;
     result(model: SearchItem): Promise<ResultItem>;
@@ -222,4 +241,5 @@ declare class NominatimProvider extends BaseProvider {
 
 declare function create(options: GeocoderOptions): Geocoder;
 
-export { BaseProvider, type BaseProviderOptions, Geocoder, type GeocoderOptions, NgwProvider, NominatimProvider, type ResultItem, type SearchItem, create };
+export { BaseProvider, Geocoder, NgwProvider, NominatimProvider, create };
+export type { BaseProviderOptions, GeocoderOptions, ResultItem, SearchItem };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nextgis/geocoder",
-  "version": "3.0.0-alpha.8",
+  "version": "3.0.0",
   "description": "",
   "main": "index.js",
   "module": "lib/geocoder.esm-bundler.js",
@@ -8,16 +8,16 @@
   "jsdelivr": "lib/geocoder.global.prod.js",
   "types": "lib/index.d.ts",
   "dependencies": {
-    "@nextgis/cancelable-promise": "^3.0.0-alpha.5",
-    "@nextgis/ngw-connector": "^3.0.0-alpha.8",
-    "@nextgis/ngw-kit": "^3.0.0-alpha.8",
-    "@nextgis/utils": "^3.0.0-alpha.5",
+    "@nextgis/cancelable-promise": "3.0.0",
+    "@nextgis/ngw-connector": "3.0.0",
+    "@nextgis/ngw-kit": "3.0.0",
+    "@nextgis/utils": "3.0.0",
     "@types/events": "^3.0.0",
     "@types/geojson": "^7946.0.14",
     "events": "*"
   },
   "devDependencies": {
-    "@nextgis/build-tools": "^3.0.0-alpha.5"
+    "@nextgis/build-tools": "3.0.0"
   },
   "buildOptions": {
     "name": "Geocoder",
@@ -53,5 +53,5 @@
   "bugs": {
     "url": "https://github.com/nextgis/nextgis_frontend/issues"
   },
-  "gitHead": "ef384211e9024fbf72594c5d34a5c2c554534b2c"
+  "gitHead": "9a06597ef6f097f255ff52843c96375247a5e064"
 }