@nextgis/geocoder 1.19.1 → 2.0.0-alpha.0

package/lib/index.d.ts

@@ -1,241 +1,226 @@
-/**
- * Modern geocoder on async generators. May use different data providers.
- *
- * @packageDocumentation
- * @module geocoder
- */
-
-import CancelablePromise from '@nextgis/cancelable-promise';
-import type { FeatureItem } from '@nextgis/ngw-connector';
-import type { FetchNgwItemsOptions } from '@nextgis/ngw-kit';
-import type { GeoJsonObject } from 'geojson';
-import type { LngLatArray } from '@nextgis/utils';
-import type { LngLatBoundsArray } from '@nextgis/utils';
-import NgwConnector from '@nextgis/ngw-connector';
-import type { NgwConnectorOptions } from '@nextgis/ngw-connector';
-import type { ResourceItem } from '@nextgis/ngw-connector';
-
-/**
- * Represents the base class for a geocoder.
- * This abstract class provides the basic methods that every geocoder should implement.
- *
- * @template O - The type of options that can be passed to the geocoder.
- */
-declare abstract class BaseGeocoder<O extends Record<string, any> = Record<string, any>> {
-    constructor(options?: O);
-    /**
-     * Search method to retrieve geocoding results.
-     *
-     * @abstract
-     * @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 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.
-     *
-     * @abstract
-     */
-    abstract abort?(): void;
-}
-
-/**
- * Abstract base class representing a search provider.
- * It builds upon the BaseGeocoder functionalities with provider-specific properties.
- * @template O - Options type which extends BaseProviderOptions.
- */
-export declare abstract class BaseProvider<O extends BaseProviderOptions = BaseProviderOptions> extends BaseGeocoder<O> {
-    /**
-     * URL endpoint for the search service.
-     * This is where queries will be sent to obtain search results.
-     */
-    searchUrl?: string;
-    /**
-     * Label to represent the provider.
-     * Useful for user interfaces to display the source of search results.
-     */
-    label?: string;
-}
-
-/**
- * Options for initializing a basic search provider.
- */
-export declare interface BaseProviderOptions {
-    /**
-     * URL endpoint for the search service.
-     * This is where queries will be sent to obtain search results.
-     */
-    searchUrl?: string;
-    /**
-     * Label to represent the provider.
-     * This could be used for user interfaces to display the source of search results.
-     */
-    label?: string;
-}
-
-export declare function create(options: GeocoderOptions): Geocoder;
-
-export declare class Geocoder extends BaseGeocoder<GeocoderOptions> {
-    providers: BaseProvider[];
-    constructor(options: 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>;
-}
-
-/**
- * Defines the options for creating a Geocoder instance.
- */
-export declare interface GeocoderOptions {
-    /**
-     * An array of providers to be used for geocoding.
-     */
-    providers: BaseProvider[];
-}
-
-export declare class NgwProvider extends BaseProvider<NgwProviderOptions> {
-    static limit: number;
-    searchResources: SearchResource[];
-    private connector;
-    private _abortControllers;
-    constructor(options: 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;
-}
-
-/**
- * Options required to initialize an NGW provider.
- */
-declare interface NgwProviderOptions extends BaseProviderOptions {
-    /** Connector instance for NGW. If not provided, will be created internally */
-    connector?: NgwConnector;
-    /** List of NGW resources to search within */
-    searchResources: SearchResource[];
-    /** Options for the internal NgwConnector (if one needs to be created) */
-    connectorOptions?: NgwConnectorOptions;
-}
-
-/**
- * Extends the basic search item with NGW-specific properties.
- */
-declare interface NgwSearchItem extends SearchItem {
-    /** ID of the NGW resource */
-    resourceId: number;
-    /** ID of the feature in the NGW resource */
-    featureId: number;
-    /** The specific feature item from NGW */
-    item: FeatureItem;
-    /** The NGW resource item */
-    resourceItem: ResourceItem;
-}
-
-export declare class NominatimProvider extends BaseProvider {
-    searchUrl: string;
-    private _requests;
-    constructor(options?: BaseProviderOptions);
-    abort(): void;
-    search(val: string): AsyncGenerator<SearchItem, void, unknown>;
-    result(model: SearchItem): CancelablePromise<ResultItem>;
-    reverse(coordinates: LngLatArray): AsyncGenerator<SearchItem, void, unknown>;
-}
-
-/**
- * Defines the structure for a rendered search item.
- */
-declare interface RenderSearchItem {
-    /** The specific feature item */
-    item: FeatureItem;
-    /** The NGW resource item */
-    resourceItem: ResourceItem;
-}
-
-export declare 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;
-}
-
-export declare interface SearchItem {
-    /**
-     * A dynamic property bucket for the `SearchItem`.
-     */
-    [prop: string]: any;
-    /**
-     * An optional unique identifier for the search result.
-     */
-    _id?: number | string;
-    /**
-     * Display text of the search result.
-     */
-    text: string;
-    /**
-     * The original query string that resulted in this search result.
-     */
-    query: string;
-    /**
-     * An optional bounding box of the search result in [west, south, east, north] format.
-     */
-    extent?: LngLatBoundsArray;
-    /**
-     * The provider that sourced this search result.
-     */
-    provider?: BaseProvider;
-    /**
-     * Optional GeoJSON geometry associated with this search result.
-     */
-    geom?: GeoJsonObject;
-    /**
-     * An optional function that can be called to retrieve detailed result for this search item.
-     */
-    result?: () => CancelablePromise<ResultItem>;
-}
-
-/**
- * Options for searching within a NGW resource.
- */
-declare interface SearchResource extends FetchNgwItemsOptions {
-    /** The search method used ('ilike' is case-insensitive) */
-    searchMethod?: 'ilike' | 'like';
-    /** Custom rendering function for search results */
-    renderSearch?: (item: RenderSearchItem) => string | HTMLElement;
-}
-
-export { }
+import CancelablePromise from '@nextgis/cancelable-promise';
+import { LngLatBoundsArray, LngLatArray } from '@nextgis/utils';
+import { GeoJsonObject } from 'geojson';
+import NgwConnector, { FeatureItem, ResourceItem, 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;
+}
+
+/**
+ * Options for initializing a basic search provider.
+ */
+interface BaseProviderOptions {
+    /**
+     * URL endpoint for the search service.
+     * This is where queries will be sent to obtain search results.
+     */
+    searchUrl?: string;
+    /**
+     * Label to represent the provider.
+     * This could be used for user interfaces to display the source of search results.
+     */
+    label?: string;
+}
+
+/**
+ * Abstract base class representing a search provider.
+ * It builds upon the BaseGeocoder functionalities with provider-specific properties.
+ * @template O - Options type which extends BaseProviderOptions.
+ */
+declare abstract class BaseProvider<O extends BaseProviderOptions = BaseProviderOptions> extends BaseGeocoder<O> {
+    /**
+     * URL endpoint for the search service.
+     * This is where queries will be sent to obtain search results.
+     */
+    searchUrl?: string;
+    /**
+     * Label to represent the provider.
+     * Useful for user interfaces to display the source of search results.
+     */
+    label?: string;
+}
+
+interface SearchItem {
+    /**
+     * A dynamic property bucket for the `SearchItem`.
+     */
+    [prop: string]: any;
+    /**
+     * An optional unique identifier for the search result.
+     */
+    _id?: number | string;
+    /**
+     * Display text of the search result.
+     */
+    text: string;
+    /**
+     * The original query string that resulted in this search result.
+     */
+    query: string;
+    /**
+     * An optional bounding box of the search result in [west, south, east, north] format.
+     */
+    extent?: LngLatBoundsArray;
+    /**
+     * The provider that sourced this search result.
+     */
+    provider?: BaseProvider;
+    /**
+     * Optional GeoJSON geometry associated with this search result.
+     */
+    geom?: GeoJsonObject;
+    /**
+     * An optional function that can be called to retrieve detailed result for this search item.
+     */
+    result?: () => CancelablePromise<ResultItem>;
+}
+
+/**
+ * Represents the base class for a geocoder.
+ * This abstract class provides the basic methods that every geocoder should implement.
+ *
+ * @template O - The type of options that can be passed to the geocoder.
+ */
+declare abstract class BaseGeocoder<O extends Record<string, any> = Record<string, any>> {
+    constructor(options?: O);
+    /**
+     * Search method to retrieve geocoding results.
+     *
+     * @abstract
+     * @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 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.
+     *
+     * @abstract
+     */
+    abstract abort?(): void;
+}
+
+/**
+ * Defines the options for creating a Geocoder instance.
+ */
+interface GeocoderOptions {
+    /**
+     * An array of providers to be used for geocoding.
+     */
+    providers: BaseProvider[];
+}
+
+declare class Geocoder extends BaseGeocoder<GeocoderOptions> {
+    providers: BaseProvider[];
+    constructor(options: 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>;
+}
+
+/**
+ * Extends the basic search item with NGW-specific properties.
+ */
+interface NgwSearchItem extends SearchItem {
+    /** ID of the NGW resource */
+    resourceId: number;
+    /** ID of the feature in the NGW resource */
+    featureId: number;
+    /** The specific feature item from NGW */
+    item: FeatureItem;
+    /** The NGW resource item */
+    resourceItem: ResourceItem;
+}
+/**
+ * Defines the structure for a rendered search item.
+ */
+interface RenderSearchItem {
+    /** The specific feature item */
+    item: FeatureItem;
+    /** The NGW resource item */
+    resourceItem: ResourceItem;
+}
+/**
+ * Options for searching within a NGW resource.
+ */
+interface SearchResource extends FetchNgwItemsOptions {
+    /** The search method used ('ilike' is case-insensitive) */
+    searchMethod?: 'ilike' | 'like';
+    /** Custom rendering function for search results */
+    renderSearch?: (item: RenderSearchItem) => string | HTMLElement;
+}
+/**
+ * Options required to initialize an NGW provider.
+ */
+interface NgwProviderOptions extends BaseProviderOptions {
+    /** Connector instance for NGW. If not provided, will be created internally */
+    connector?: NgwConnector;
+    /** List of NGW resources to search within */
+    searchResources: SearchResource[];
+    /** Options for the internal NgwConnector (if one needs to be created) */
+    connectorOptions?: NgwConnectorOptions;
+}
+declare class NgwProvider extends BaseProvider<NgwProviderOptions> {
+    static limit: number;
+    searchResources: SearchResource[];
+    private connector;
+    private _abortControllers;
+    constructor(options: 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;
+}
+
+declare class NominatimProvider extends BaseProvider {
+    searchUrl: string;
+    private _requests;
+    constructor(options?: BaseProviderOptions);
+    abort(): void;
+    search(val: string): AsyncGenerator<SearchItem, void, unknown>;
+    result(model: SearchItem): CancelablePromise<ResultItem>;
+    reverse(coordinates: LngLatArray): AsyncGenerator<SearchItem, void, unknown>;
+}
+
+declare function create(options: GeocoderOptions): Geocoder;
+
+export { BaseProvider, type BaseProviderOptions, Geocoder, type GeocoderOptions, NgwProvider, NominatimProvider, type ResultItem, type SearchItem, create };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nextgis/geocoder",
-  "version": "1.19.1",
+  "version": "2.0.0-alpha.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": "^1.19.0",
-    "@nextgis/ngw-connector": "^1.19.0",
-    "@nextgis/ngw-kit": "^1.19.1",
-    "@nextgis/utils": "^1.19.0",
+    "@nextgis/cancelable-promise": "^2.0.0-alpha.0",
+    "@nextgis/ngw-connector": "^2.0.0-alpha.0",
+    "@nextgis/ngw-kit": "^2.0.0-alpha.0",
+    "@nextgis/utils": "^2.0.0-alpha.0",
     "@types/events": "^3.0.0",
     "@types/geojson": "^7946.0.8",
-    "events": "^3.3.0"
+    "events": "*"
   },
   "devDependencies": {
-    "@nextgis/build-tools": "^1.19.0"
+    "@nextgis/build-tools": "^2.0.0-alpha.0"
   },
   "buildOptions": {
     "name": "Geocoder",
@@ -53,5 +53,5 @@
   "bugs": {
     "url": "https://github.com/nextgis/nextgis_frontend/issues"
   },
-  "gitHead": "9d8042e241b1a9e8856c5554ec35faf8241028cc"
+  "gitHead": "6a4a43d17a08e468d2362f1ae9590094e39aa6cc"
 }