@nextgis/geocoder 1.19.2 → 2.0.0-alpha.1

package/lib/geocoder.cjs.js

@@ -1,4 +1,4 @@
-/** Bundle of @nextgis/geocoder; version: 1.19.2; author: NextGIS */
+/** Bundle of @nextgis/geocoder; version: 2.0.0-alpha.1; author: NextGIS */
 'use strict';
 
 Object.defineProperty(exports, '__esModule', { value: true });
@@ -8,362 +8,389 @@ var utils = require('@nextgis/utils');
 var NgwConnector = require('@nextgis/ngw-connector');
 var ngwKit = require('@nextgis/ngw-kit');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
-
-var CancelablePromise__default = /*#__PURE__*/_interopDefaultLegacy(CancelablePromise);
-var NgwConnector__default = /*#__PURE__*/_interopDefaultLegacy(NgwConnector);
-
-/**
- * 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.
- */
 class BaseGeocoder {
-    constructor(options) {
-        if (options) {
-            utils.objectAssign(this, options);
-        }
+  constructor(options) {
+    if (options) {
+      utils.objectAssign(this, options);
     }
+  }
 }
 
+var __defProp$3 = Object.defineProperty;
+var __defNormalProp$3 = (obj, key, value) => key in obj ? __defProp$3(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$3 = (obj, key, value) => {
+  __defNormalProp$3(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
 let ID = 0;
 class Geocoder extends BaseGeocoder {
-    constructor(options) {
-        super(options);
-        this.providers = [];
-        if (options && options.providers) {
-            this.providers = options.providers;
-        }
+  constructor(options) {
+    super(options);
+    __publicField$3(this, "providers", []);
+    if (options && options.providers) {
+      this.providers = options.providers;
     }
-    abort() {
-        this.providers.forEach((x) => {
-            if (x.abort) {
-                x.abort();
-            }
-        });
-    }
-    async *search(query) {
-        this.abort();
-        let allProvidersFailed = true;
-        const errors = [];
-        for (const provider of this.providers) {
-            try {
-                const results = provider.search(query);
-                for await (const r of results) {
-                    allProvidersFailed = false;
-                    yield { ...r, provider, _id: ID++ };
-                }
-            }
-            catch (err) {
-                const er = err;
-                if (er.name !== 'CancelError') {
-                    errors.push(er);
-                }
-            }
+  }
+  abort() {
+    this.providers.forEach((x) => {
+      if (x.abort) {
+        x.abort();
+      }
+    });
+  }
+  async *search(query) {
+    this.abort();
+    let allProvidersFailed = true;
+    const errors = [];
+    for (const provider of this.providers) {
+      try {
+        const results = provider.search(query);
+        for await (const r of results) {
+          allProvidersFailed = false;
+          yield { ...r, provider, _id: ID++ };
         }
-        if (allProvidersFailed && errors.length) {
-            throw new Error(`All providers failed: ${errors.map((e) => e.message).join('; ')}`);
+      } catch (err) {
+        const er = err;
+        if (er.name !== "CancelError") {
+          errors.push(er);
         }
+      }
     }
-    result(item) {
-        if (item.provider) {
-            return item.provider.result(item);
-        }
-        return CancelablePromise__default.resolve(undefined);
+    if (allProvidersFailed && errors.length) {
+      throw new Error(
+        `All providers failed: ${errors.map((e) => e.message).join("; ")}`
+      );
     }
-    async *reverse(coordinates) {
-        for (const provider of this.providers) {
-            if (!provider.reverse) {
-                continue;
-            }
-            try {
-                const results = provider.reverse(coordinates);
-                for await (const r of results) {
-                    yield { ...r, provider, _id: ID++ };
-                }
-            }
-            catch (er) {
-                // Handle or log errors as needed
-            }
+  }
+  result(item) {
+    if (item.provider) {
+      return item.provider.result(item);
+    }
+    return CancelablePromise.resolve(void 0);
+  }
+  async *reverse(coordinates) {
+    for (const provider of this.providers) {
+      if (!provider.reverse) {
+        continue;
+      }
+      try {
+        const results = provider.reverse(coordinates);
+        for await (const r of results) {
+          yield { ...r, provider, _id: ID++ };
         }
+      } catch (er) {
+      }
     }
-    /**
-     * 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.
-     */
-    async reverseGeocodeFirstResult(coordinates) {
-        for (const provider of this.providers) {
-            if (typeof provider.reverse === 'function') {
-                try {
-                    for await (const result of provider.reverse(coordinates)) {
-                        return result;
-                    }
-                }
-                catch (error) {
-                    console.error('Error in reverse geocoding:', error);
-                }
-            }
+  }
+  /**
+   * 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.
+   */
+  async reverseGeocodeFirstResult(coordinates) {
+    for (const provider of this.providers) {
+      if (typeof provider.reverse === "function") {
+        try {
+          for await (const result of provider.reverse(coordinates)) {
+            return result;
+          }
+        } catch (error) {
+          console.error("Error in reverse geocoding:", error);
         }
-        return undefined;
+      }
     }
+    return void 0;
+  }
 }
 
-/**
- * Abstract base class representing a search provider.
- * It builds upon the BaseGeocoder functionalities with provider-specific properties.
- * @template O - Options type which extends BaseProviderOptions.
- */
+var __defProp$2 = Object.defineProperty;
+var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$2 = (obj, key, value) => {
+  __defNormalProp$2(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
 class BaseProvider extends BaseGeocoder {
+  constructor() {
+    super(...arguments);
+    /**
+     * URL endpoint for the search service.
+     * This is where queries will be sent to obtain search results.
+     */
+    __publicField$2(this, "searchUrl");
+    /**
+     * Label to represent the provider.
+     * Useful for user interfaces to display the source of search results.
+     */
+    __publicField$2(this, "label");
+  }
 }
 
-class NgwProvider extends BaseProvider {
-    constructor(options) {
-        var _a;
-        super(options);
-        this.searchResources = [];
-        this._abortControllers = [];
-        if (!options.searchUrl && !((_a = options.connectorOptions) === null || _a === void 0 ? void 0 : _a.baseUrl)) {
-            throw new Error('The `searchUrl` of `connectorOptions.baseUrl` are required');
-        }
-        this.connector =
-            options.connector ||
-                new NgwConnector__default({
-                    baseUrl: this.searchUrl,
-                    ...options.connectorOptions,
-                });
-        this.searchResources = options.searchResources;
+var __defProp$1 = Object.defineProperty;
+var __defNormalProp$1 = (obj, key, value) => key in obj ? __defProp$1(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField$1 = (obj, key, value) => {
+  __defNormalProp$1(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+const _NgwProvider = class _NgwProvider extends BaseProvider {
+  constructor(options) {
+    var _a;
+    super(options);
+    __publicField$1(this, "searchResources", []);
+    __publicField$1(this, "connector");
+    __publicField$1(this, "_abortControllers", []);
+    if (!options.searchUrl && !((_a = options.connectorOptions) == null ? void 0 : _a.baseUrl)) {
+      throw new Error(
+        "The `searchUrl` of `connectorOptions.baseUrl` are required"
+      );
     }
-    abort() {
-        this._abortControllers.forEach((a) => {
-            a.abort();
+    this.connector = options.connector || new NgwConnector({
+      baseUrl: this.searchUrl,
+      ...options.connectorOptions
+    });
+    this.searchResources = options.searchResources;
+  }
+  abort() {
+    this._abortControllers.forEach((a) => {
+      a.abort();
+    });
+    this._abortControllers.length = 0;
+  }
+  async *search(query) {
+    var _a, _b;
+    const signal = this._makeSignal();
+    for (const config of this.searchResources) {
+      if (signal.aborted) {
+        break;
+      }
+      const { searchMethod } = config;
+      const limit = (_a = config.limit) != null ? _a : _NgwProvider.limit;
+      const resourceId = (_b = config.id) != null ? _b : config.resourceId;
+      try {
+        const resource = await this.connector.getResourceOrFail(resourceId, {
+          cache: true
         });
-        this._abortControllers.length = 0;
-    }
-    async *search(query) {
-        var _a, _b;
-        const signal = this._makeSignal();
-        for (const config of this.searchResources) {
-            if (signal.aborted) {
-                break;
-            }
-            const { searchMethod } = config;
-            const limit = (_a = config.limit) !== null && _a !== void 0 ? _a : NgwProvider.limit;
-            //
-            const resourceId = (_b = config.id) !== null && _b !== void 0 ? _b : config.resourceId;
-            try {
-                const resource = await this.connector.getResourceOrFail(resourceId, {
-                    cache: true,
-                });
-                const options = {
-                    connector: this.connector,
-                    resourceId,
-                    signal,
-                    limit,
-                };
-                if (searchMethod === 'like') {
-                    options.like = query;
-                }
-                else {
-                    options.ilike = query;
-                }
-                const request = ngwKit.fetchNgwLayerItems(options);
-                const entries = await request;
-                for (const item of this._items({
-                    entries,
-                    query,
-                    config,
-                    resourceItem: resource,
-                })) {
-                    item.result = () => this.result(item);
-                    yield item;
-                }
-            }
-            catch (er) {
-                if (er &&
-                    'name' in er &&
-                    er.name !== 'CancelError') {
-                    console.warn(er);
-                }
-            }
+        const options = {
+          connector: this.connector,
+          resourceId,
+          signal,
+          limit
+        };
+        if (searchMethod === "like") {
+          options.like = query;
+        } else {
+          options.ilike = query;
         }
+        const request = ngwKit.fetchNgwLayerItems(options);
+        const entries = await request;
+        for (const item of this._items({
+          entries,
+          query,
+          config,
+          resourceItem: resource
+        })) {
+          item.result = () => this.result(item);
+          yield item;
+        }
+      } catch (er) {
+        if (er && "name" in er && er.name !== "CancelError") {
+          console.warn(er);
+        }
+      }
     }
-    result(item) {
-        const signal = this._makeSignal();
-        const req = this.connector
-            .get('feature_layer.feature.item_extent', { signal }, {
-            id: item.resourceId,
-            fid: item.featureId,
-        })
-            .then((x) => {
-            const e = x.extent;
-            return {
-                text: item.text,
-                extent: [e.minLon, e.minLat, e.maxLon, e.maxLat],
-            };
-        });
-        return req;
-    }
-    async *reverse(coordinates) {
-        throw new Error('Not implemented');
-    }
-    _makeSignal() {
-        const abortController = new AbortController();
-        this._abortControllers.push(abortController);
-        return abortController.signal;
+  }
+  result(item) {
+    const signal = this._makeSignal();
+    const req = this.connector.get(
+      "feature_layer.feature.item_extent",
+      { signal },
+      {
+        id: item.resourceId,
+        fid: item.featureId
+      }
+    ).then((x) => {
+      const e = x.extent;
+      return {
+        text: item.text,
+        extent: [e.minLon, e.minLat, e.maxLon, e.maxLat]
+      };
+    });
+    return req;
+  }
+  async *reverse(coordinates) {
+    throw new Error("Not implemented");
+  }
+  _makeSignal() {
+    const abortController = new AbortController();
+    this._abortControllers.push(abortController);
+    return abortController.signal;
+  }
+  _items({
+    entries,
+    query,
+    config,
+    resourceItem
+  }) {
+    var _a;
+    const items = [];
+    let labelField = void 0;
+    if (resourceItem.feature_layer) {
+      labelField = (_a = resourceItem.feature_layer.fields.find(
+        (f) => f.label_field
+      )) == null ? void 0 : _a.keyname;
     }
-    _items({ entries, query, config, resourceItem, }) {
-        var _a;
-        const items = [];
-        let labelField = undefined;
-        if (resourceItem.feature_layer) {
-            labelField = (_a = resourceItem.feature_layer.fields.find((f) => f.label_field)) === null || _a === void 0 ? void 0 : _a.keyname;
+    const meta = this.searchResources.find(
+      (x) => {
+        var _a2;
+        return (_a2 = x.id) != null ? _a2 : x.resourceId === resourceItem.resource.id;
+      }
+    );
+    if (meta) {
+      entries.forEach((entry) => {
+        let text = labelField ? entry.fields[labelField] : entry.id;
+        if (config.renderSearch) {
+          text = config.renderSearch({
+            item: entry,
+            resourceItem
+          });
+        } else if (labelField) {
+          text = entry.fields[labelField];
         }
-        const meta = this.searchResources.find((x) => { var _a; return (_a = x.id) !== null && _a !== void 0 ? _a : x.resourceId === resourceItem.resource.id; });
-        if (meta) {
-            entries.forEach((entry) => {
-                let text = labelField ? entry.fields[labelField] : entry.id;
-                if (config.renderSearch) {
-                    text = config.renderSearch({
-                        item: entry,
-                        resourceItem,
-                    });
-                }
-                else if (labelField) {
-                    text = entry.fields[labelField];
-                }
-                items.push({
-                    query: query,
-                    text,
-                    featureId: entry.id,
-                    resourceId: resourceItem.resource.id,
-                    item: entry,
-                    resourceItem,
-                });
-            });
-        }
-        return items;
+        items.push({
+          query,
+          text,
+          featureId: entry.id,
+          resourceId: resourceItem.resource.id,
+          item: entry,
+          resourceItem
+        });
+      });
     }
-}
-NgwProvider.limit = 300;
+    return items;
+  }
+};
+__publicField$1(_NgwProvider, "limit", 300);
+let NgwProvider = _NgwProvider;
 
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
 class NominatimProvider extends BaseProvider {
-    constructor(options) {
-        super(options);
-        this.searchUrl = 'https://nominatim.openstreetmap.org';
-        this._requests = [];
-        if (options && options.searchUrl) {
-            this.searchUrl = options.searchUrl;
-        }
+  constructor(options) {
+    super(options);
+    __publicField(this, "searchUrl", "https://nominatim.openstreetmap.org");
+    __publicField(this, "_requests", []);
+    if (options && options.searchUrl) {
+      this.searchUrl = options.searchUrl;
     }
-    abort() {
-        this._requests.forEach((x) => x.cancel());
-        this._requests = [];
-    }
-    async *search(val) {
-        // RFC2616 accept - language string
-        const url = utils.fixUrlStr(
-        // `${this.baseUrl}/search?format=geojson&polygon_geojson=1${window.locale === 'ru' ? '&accept-language=ru-RU,en-US' : ''}&q=${val}`
-        `${this.searchUrl}/search?format=geojson&polygon_geojson=1&q=${val}`);
-        const request = new CancelablePromise__default((resolve, reject, onCancel) => {
-            const xhr = new XMLHttpRequest();
-            xhr.open('GET', url, true);
-            xhr.onload = () => {
-                try {
-                    const geojson = JSON.parse(xhr.responseText);
-                    const features = geojson.features.map((x) => {
-                        return {
-                            geom: x,
-                            extent: x.bbox,
-                            text: x.properties && x.properties.display_name,
-                            query: val,
-                        };
-                    });
-                    resolve(features);
-                }
-                catch (er) {
-                    reject(er);
-                }
-            };
-            xhr.onerror = (er) => {
-                reject(er);
-            };
-            onCancel(() => {
-                xhr.abort();
+  }
+  abort() {
+    this._requests.forEach((x) => x.cancel());
+    this._requests = [];
+  }
+  async *search(val) {
+    const url = utils.fixUrlStr(
+      // `${this.baseUrl}/search?format=geojson&polygon_geojson=1${window.locale === 'ru' ? '&accept-language=ru-RU,en-US' : ''}&q=${val}`
+      `${this.searchUrl}/search?format=geojson&polygon_geojson=1&q=${val}`
+    );
+    const request = new CancelablePromise(
+      (resolve, reject, onCancel) => {
+        const xhr = new XMLHttpRequest();
+        xhr.open("GET", url, true);
+        xhr.onload = () => {
+          try {
+            const geojson = JSON.parse(xhr.responseText);
+            const features = geojson.features.map((x) => {
+              return {
+                geom: x,
+                extent: x.bbox,
+                text: x.properties && x.properties.display_name,
+                query: val
+              };
             });
-            xhr.send();
-        }).catch((er) => {
-            if (er.name === 'CancelError') ;
-            throw er;
+            resolve(features);
+          } catch (er) {
+            reject(er);
+          }
+        };
+        xhr.onerror = (er) => {
+          reject(er);
+        };
+        onCancel(() => {
+          xhr.abort();
         });
-        this._requests.push(request);
-        const items = await request;
-        if (items) {
-            for (const i of items) {
-                i.result = () => this.result(i);
-                yield i;
-            }
-        }
+        xhr.send();
+      }
+    ).catch((er) => {
+      if (er.name === "CancelError") ;
+      throw er;
+    });
+    this._requests.push(request);
+    const items = await request;
+    if (items) {
+      for (const i of items) {
+        i.result = () => this.result(i);
+        yield i;
+      }
     }
-    result(model) {
-        return CancelablePromise__default.resolve({
-            text: model.text,
-            extent: model.extent || [],
-            geom: model.geom,
-        });
-    }
-    async *reverse(coordinates) {
-        const [lng, lat] = coordinates;
-        const url = utils.fixUrlStr(`${this.searchUrl}/reverse?format=geojson&lat=${lat}&lon=${lng}`);
-        const request = new CancelablePromise__default((resolve, reject, onCancel) => {
-            const xhr = new XMLHttpRequest();
-            xhr.open('GET', url, true);
-            xhr.onload = () => {
-                try {
-                    const geojson = JSON.parse(xhr.responseText);
-                    const feature = geojson.features[0];
-                    const result = {
-                        geom: feature,
-                        extent: feature.bbox,
-                        text: feature.properties && feature.properties.display_name,
-                        query: `${lat}, ${lng}`,
-                    };
-                    resolve(result);
-                }
-                catch (er) {
-                    reject(er);
-                }
-            };
-            xhr.onerror = (er) => {
-                reject(er);
+  }
+  result(model) {
+    return CancelablePromise.resolve({
+      text: model.text,
+      extent: model.extent || [],
+      geom: model.geom
+    });
+  }
+  async *reverse(coordinates) {
+    const [lng, lat] = coordinates;
+    const url = utils.fixUrlStr(
+      `${this.searchUrl}/reverse?format=geojson&lat=${lat}&lon=${lng}`
+    );
+    const request = new CancelablePromise(
+      (resolve, reject, onCancel) => {
+        const xhr = new XMLHttpRequest();
+        xhr.open("GET", url, true);
+        xhr.onload = () => {
+          try {
+            const geojson = JSON.parse(xhr.responseText);
+            const feature = geojson.features[0];
+            const result = {
+              geom: feature,
+              extent: feature.bbox,
+              text: feature.properties && feature.properties.display_name,
+              query: `${lat}, ${lng}`
             };
-            onCancel(() => {
-                xhr.abort();
-            });
-            xhr.send();
-        }).catch((er) => {
-            if (er.name === 'CancelError') ;
-            throw er;
+            resolve(result);
+          } catch (er) {
+            reject(er);
+          }
+        };
+        xhr.onerror = (er) => {
+          reject(er);
+        };
+        onCancel(() => {
+          xhr.abort();
         });
-        this._requests.push(request);
-        const item = await request;
-        if (item) {
-            item.result = () => this.result(item);
-            yield item;
-        }
+        xhr.send();
+      }
+    ).catch((er) => {
+      if (er.name === "CancelError") ;
+      throw er;
+    });
+    this._requests.push(request);
+    const item = await request;
+    if (item) {
+      item.result = () => this.result(item);
+      yield item;
     }
+  }
 }
 
-/**
- * Modern geocoder on async generators. May use different data providers.
- *
- * @packageDocumentation
- * @module geocoder
- */
 function create(options) {
-    return new Geocoder(options);
+  return new Geocoder(options);
 }
 
 exports.BaseProvider = BaseProvider;