@geosdi/ngx-geocoding 1.2.0 → 2.0.0

package/types/geosdi-ngx-geocoding.d.ts

@@ -1,28 +1,25 @@
-import * as i0 from '@angular/core';
-import { InjectionToken, Provider } from '@angular/core';
-import { Subject, Observable } from 'rxjs';
-
+import * as i0 from "@angular/core";
+import { InjectionToken, Provider } from "@angular/core";
+import { Observable, Subject } from "rxjs";
 /**
  * @author Vito Salvia - CNR IMAA geoSDI Group
  * @email vito.salvia@gmail.com
  */
-declare class NgxGeocodingModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgxGeocodingModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<NgxGeocodingModule, never, never, never>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<NgxGeocodingModule>;
+export declare class NgxGeocodingModule {
+  static ɵfac: i0.ɵɵFactoryDeclaration<NgxGeocodingModule, never>;
+  static ɵmod: i0.ɵɵNgModuleDeclaration<NgxGeocodingModule, never, never, never>;
+  static ɵinj: i0.ɵɵInjectorDeclaration<NgxGeocodingModule>;
 }
-
 /**
  * @author Vito Salvia - CNR IMAA geoSDI Group
  * @email vito.salvia@gmail.com
  */
-interface GeocodingLocation {
-    display_name?: string;
-    lat?: string;
-    lon?: string;
-    place_id?: string;
+export interface GeocodingLocation {
+  display_name?: string;
+  lat?: string;
+  lon?: string;
+  place_id?: string;
 }
-
 /**
  * La ricerca di indirizzi, da una o più sorgenti.
  *
@@ -63,133 +60,132 @@ interface GeocodingLocation {
  * **Le proposte di Places non portano le coordinate**, che si chiedono per il
  * solo luogo scelto : vedi {@link resolve}, ed è il motivo per cui esiste.
  */
-declare class NgxGeocodingService {
-    subjectLocation: Subject<GeocodingLocation>;
-    subjectNoResults: Subject<unknown>;
-    subjectRemove: Subject<unknown>;
-    private http;
-    private config;
-    /**
-     * Una sorgente che ha detto di no non si richiama per il resto della
-     * sessione : chiave senza il prodotto abilitato, referrer fuori dalle
-     * restrizioni, quota. Senza questo sarebbe una richiesta negata a ogni
-     * tasto premuto.
-     */
-    private spente;
-    /**
-     * Dentro `google`, i gradini già scesi : `AutocompleteSuggestion` (Places
-     * New) e `AutocompleteService` (Places legacy). Da lì in poi si parte
-     * direttamente da dove si era arrivati.
-     */
-    private suggestionSpenta;
-    private placesSpenta;
-    /**
-     * Le proposte per quello che si sta digitando, dalla prima sorgente che
-     * risponde.
-     *
-     * @param address il testo digitato
-     */
-    geocode(address: string): Observable<GeocodingLocation[]>;
-    /**
-     * Le coordinate del luogo **scelto**, chieste solo adesso.
-     *
-     * Le proposte di Places arrivano senza, e risolverle tutte a ogni tasto
-     * premuto vorrebbe dire una richiesta di dettaglio per proposta. Chi le ha
-     * già — Nominatim le manda sempre, e il `Geocoder` pure — non paga niente e
-     * si riprende il luogo così com'è, quindi **chiamarla è sempre corretto** :
-     * è la riga da mettere dove si sceglie una proposta, prima di usarne `lat`
-     * e `lon`.
-     *
-     * Fallendo restituisce il luogo com'è, senza coordinate : chi ha chiamato
-     * lo sa già gestire, ed è meglio che muovere una mappa a caso.
-     *
-     * @param place la proposta scelta fra quelle di {@link geocode}
-     */
-    resolve(place: GeocodingLocation): Observable<GeocodingLocation>;
-    /**
-     * Le coordinate con **Places (New)** : `Place` nasce con l'id e
-     * `fetchFields` lo **riempie**, quindi i campi si leggono dall'oggetto
-     * dopo l'attesa e non dal valore restituito.
-     */
-    private luogoDaSuggestion;
-    /** Le coordinate con **Places legacy**, cioè `PlacesService.getDetails`. */
-    private luogoDaLegacy;
-    /**
-     * Prova le sorgenti in ordine, passando alla successiva quando una rifiuta.
-     *
-     * Finite le sorgenti si rilancia un errore invece di restituire un elenco
-     * vuoto : «non ho trovato niente» e «non ho potuto cercare» sono due cose
-     * diverse, e chi mostra la barra deve poterle distinguere.
-     */
-    private daSorgenti;
-    /**
-     * Nominatim, **identico a come questa libreria l'ha sempre chiamato** : è
-     * il comportamento su cui contano le applicazioni che la usavano prima che
-     * Google esistesse qui dentro.
-     */
-    private daNominatim;
-    /**
-     * Google : le proposte di Places, e il `Geocoder` quando Places dice di no.
-     *
-     * `ZERO_RESULTS` **non** è un rifiuto : è una ricerca senza esiti, e
-     * confonderlo con un errore farebbe scivolare al `Geocoder` — e poi fuori
-     * da Google — alla prima ricerca sfortunata.
-     */
-    private daGoogle;
-    /** Il secondo e il terzo gradino : Places legacy, poi il `Geocoder`. */
-    private dallaLegacy;
-    /**
-     * Le proposte di **Places (New)**, con `AutocompleteSuggestion`.
-     *
-     * Due cose che non si vedono dalla firma : `text` di una proposta non è una
-     * stringa ma un oggetto formattabile, e va letto con `toString()` — messo
-     * in un template darebbe `[object Object]` ; e un elenco **vuoto non è un
-     * errore**, è una ricerca senza esiti, quindi non fa scendere di gradino.
-     *
-     * Se la classe non c'è nell'SDK — versione più vecchia — si solleva subito,
-     * che è il modo di scendere senza aspettare una risposta che non arriverà.
-     */
-    private daSuggestion;
-    /** Le proposte incrementali di `AutocompleteService`. */
-    private daPlaces;
-    /**
-     * Il `Geocoder`, l'ultima strada di Google.
-     *
-     * I suoi risultati **portano già le coordinate**, quindi su questi
-     * {@link resolve} non fa nessuna richiesta in più.
-     */
-    private daGeocoder;
-    /** Il bias come lo vuole `AutocompleteService`. */
-    private cerchio;
-    /**
-     * Il bias come lo vuole il `Geocoder`, che prende un **riquadro** e non un
-     * cerchio : lo si iscrive attorno al punto. La longitudine si stringe con
-     * la latitudine (`cos`), o alle nostre latitudini il riquadro verrebbe
-     * largo un terzo in più del voluto.
-     */
-    private riquadro;
-    /** Le sorgenti dichiarate, o quella storica. */
-    private sorgenti;
-    /**
-     * Perché una strada ha detto di no, in una riga : dall'SDK arriva uno stato
-     * (`REQUEST_DENIED` per la chiave senza il prodotto abilitato o per il
-     * referrer, `OVER_QUERY_LIMIT` per la quota), da una http il corpo
-     * d'errore. Senza questo il motivo resta dentro un oggetto che in console
-     * va aperto, e si legge solo «si ripiega».
-     */
-    private perche;
-    /**
-     * Una coordinata come stringa, o `undefined` se non c'è.
-     *
-     * `String(undefined)` darebbe `"undefined"`, che passerebbe indenne per
-     * ogni controllo di presenza e morirebbe in `Number()` — cioè una mappa
-     * portata su `NaN, NaN` senza che niente lo dica.
-     */
-    private testo;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgxGeocodingService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<NgxGeocodingService>;
+export declare class NgxGeocodingService {
+  subjectLocation: Subject<GeocodingLocation>;
+  subjectNoResults: Subject<unknown>;
+  subjectRemove: Subject<unknown>;
+  private http;
+  private config;
+  /**
+   * Una sorgente che ha detto di no non si richiama per il resto della
+   * sessione : chiave senza il prodotto abilitato, referrer fuori dalle
+   * restrizioni, quota. Senza questo sarebbe una richiesta negata a ogni
+   * tasto premuto.
+   */
+  private spente;
+  /**
+   * Dentro `google`, i gradini già scesi : `AutocompleteSuggestion` (Places
+   * New) e `AutocompleteService` (Places legacy). Da lì in poi si parte
+   * direttamente da dove si era arrivati.
+   */
+  private suggestionSpenta;
+  private placesSpenta;
+  /**
+   * Le proposte per quello che si sta digitando, dalla prima sorgente che
+   * risponde.
+   *
+   * @param address il testo digitato
+   */
+  geocode(address: string): Observable<GeocodingLocation[]>;
+  /**
+   * Le coordinate del luogo **scelto**, chieste solo adesso.
+   *
+   * Le proposte di Places arrivano senza, e risolverle tutte a ogni tasto
+   * premuto vorrebbe dire una richiesta di dettaglio per proposta. Chi le ha
+   * già — Nominatim le manda sempre, e il `Geocoder` pure — non paga niente e
+   * si riprende il luogo così com'è, quindi **chiamarla è sempre corretto** :
+   * è la riga da mettere dove si sceglie una proposta, prima di usarne `lat`
+   * e `lon`.
+   *
+   * Fallendo restituisce il luogo com'è, senza coordinate : chi ha chiamato
+   * lo sa già gestire, ed è meglio che muovere una mappa a caso.
+   *
+   * @param place la proposta scelta fra quelle di {@link geocode}
+   */
+  resolve(place: GeocodingLocation): Observable<GeocodingLocation>;
+  /**
+   * Le coordinate con **Places (New)** : `Place` nasce con l'id e
+   * `fetchFields` lo **riempie**, quindi i campi si leggono dall'oggetto
+   * dopo l'attesa e non dal valore restituito.
+   */
+  private luogoDaSuggestion;
+  /** Le coordinate con **Places legacy**, cioè `PlacesService.getDetails`. */
+  private luogoDaLegacy;
+  /**
+   * Prova le sorgenti in ordine, passando alla successiva quando una rifiuta.
+   *
+   * Finite le sorgenti si rilancia un errore invece di restituire un elenco
+   * vuoto : «non ho trovato niente» e «non ho potuto cercare» sono due cose
+   * diverse, e chi mostra la barra deve poterle distinguere.
+   */
+  private daSorgenti;
+  /**
+   * Nominatim, **identico a come questa libreria l'ha sempre chiamato** : è
+   * il comportamento su cui contano le applicazioni che la usavano prima che
+   * Google esistesse qui dentro.
+   */
+  private daNominatim;
+  /**
+   * Google : le proposte di Places, e il `Geocoder` quando Places dice di no.
+   *
+   * `ZERO_RESULTS` **non** è un rifiuto : è una ricerca senza esiti, e
+   * confonderlo con un errore farebbe scivolare al `Geocoder` — e poi fuori
+   * da Google — alla prima ricerca sfortunata.
+   */
+  private daGoogle;
+  /** Il secondo e il terzo gradino : Places legacy, poi il `Geocoder`. */
+  private dallaLegacy;
+  /**
+   * Le proposte di **Places (New)**, con `AutocompleteSuggestion`.
+   *
+   * Due cose che non si vedono dalla firma : `text` di una proposta non è una
+   * stringa ma un oggetto formattabile, e va letto con `toString()` — messo
+   * in un template darebbe `[object Object]` ; e un elenco **vuoto non è un
+   * errore**, è una ricerca senza esiti, quindi non fa scendere di gradino.
+   *
+   * Se la classe non c'è nell'SDK — versione più vecchia — si solleva subito,
+   * che è il modo di scendere senza aspettare una risposta che non arriverà.
+   */
+  private daSuggestion;
+  /** Le proposte incrementali di `AutocompleteService`. */
+  private daPlaces;
+  /**
+   * Il `Geocoder`, l'ultima strada di Google.
+   *
+   * I suoi risultati **portano già le coordinate**, quindi su questi
+   * {@link resolve} non fa nessuna richiesta in più.
+   */
+  private daGeocoder;
+  /** Il bias come lo vuole `AutocompleteService`. */
+  private cerchio;
+  /**
+   * Il bias come lo vuole il `Geocoder`, che prende un **riquadro** e non un
+   * cerchio : lo si iscrive attorno al punto. La longitudine si stringe con
+   * la latitudine (`cos`), o alle nostre latitudini il riquadro verrebbe
+   * largo un terzo in più del voluto.
+   */
+  private riquadro;
+  /** Le sorgenti dichiarate, o quella storica. */
+  private sorgenti;
+  /**
+   * Perché una strada ha detto di no, in una riga : dall'SDK arriva uno stato
+   * (`REQUEST_DENIED` per la chiave senza il prodotto abilitato o per il
+   * referrer, `OVER_QUERY_LIMIT` per la quota), da una http il corpo
+   * d'errore. Senza questo il motivo resta dentro un oggetto che in console
+   * va aperto, e si legge solo «si ripiega».
+   */
+  private perche;
+  /**
+   * Una coordinata come stringa, o `undefined` se non c'è.
+   *
+   * `String(undefined)` darebbe `"undefined"`, che passerebbe indenne per
+   * ogni controllo di presenza e morirebbe in `Number()` — cioè una mappa
+   * portata su `NaN, NaN` senza che niente lo dica.
+   */
+  private testo;
+  static ɵfac: i0.ɵɵFactoryDeclaration<NgxGeocodingService, never>;
+  static ɵprov: i0.ɵɵInjectableDeclaration<any>;
 }
-
 /**
  * @author Vito Salvia - CNR IMAA geoSDI Group
  * @email vito.salvia@gmail.com
@@ -204,7 +200,7 @@ declare class NgxGeocodingService {
  * - `nominatim` : il servizio pubblico di OpenStreetMap, che non vuole nessuna
  *   chiave. È il comportamento storico di questa libreria.
  */
-type NgxGeocodingSource = "google" | "nominatim";
+export type NgxGeocodingSource = "google" | "nominatim";
 /**
  * Il punto su cui polarizzare le proposte, e con che raggio.
  *
@@ -212,11 +208,11 @@ type NgxGeocodingSource = "google" | "nominatim";
  * ma «via Roma» propone prima quella vicina. Senza, Google ordina come crede,
  * e su un nome di via comune la prima proposta è quasi sempre altrove.
  */
-interface NgxGeocodingBias {
-    lat: number;
-    lon: number;
-    /** Raggio in metri. */
-    radiusM: number;
+export interface NgxGeocodingBias {
+  lat: number;
+  lon: number;
+  /** Raggio in metri. */
+  radiusM: number;
 }
 /**
  * Come questa libreria cerca gli indirizzi.
@@ -225,30 +221,29 @@ interface NgxGeocodingBias {
  * quello che la libreria ha sempre fatto. Google si accende dichiarandolo in
  * {@link sources}.
  */
-interface NgxGeocodingConfig {
-    /**
-     * Le sorgenti da provare, **in ordine**. La prima che risponde vince, e
-     * quella che rifiuta passa la mano alla successiva.
-     *
-     * Una sorgente che non è utilizzabile viene **saltata**, e non è un errore :
-     * `google` senza l'SDK in pagina. È il modo in cui la stessa configurazione
-     * vale per il deploy che ha la chiave e per quello che non ce l'ha.
-     *
-     * Default : `["nominatim"]`.
-     */
-    sources?: NgxGeocodingSource[];
-    /**
-     * Paese a cui limitare le proposte, in due lettere (`"it"`). Vale per
-     * `google` — Nominatim qui non è filtrato, per non cambiare quello che la
-     * libreria ha sempre restituito.
-     */
-    country?: string;
-    /** Dove polarizzare le proposte di `google`. Vedi {@link NgxGeocodingBias}. */
-    bias?: NgxGeocodingBias;
-    /** Il servizio Nominatim, se non quello pubblico di OpenStreetMap. */
-    nominatimUrl?: string;
+export interface NgxGeocodingConfig {
+  /**
+   * Le sorgenti da provare, **in ordine**. La prima che risponde vince, e
+   * quella che rifiuta passa la mano alla successiva.
+   *
+   * Una sorgente che non è utilizzabile viene **saltata**, e non è un errore :
+   * `google` senza l'SDK in pagina. È il modo in cui la stessa configurazione
+   * vale per il deploy che ha la chiave e per quello che non ce l'ha.
+   *
+   * Default : `["nominatim"]`.
+   */
+  sources?: NgxGeocodingSource[];
+  /**
+   * Paese a cui limitare le proposte, in due lettere (`"it"`). Vale per
+   * `google` — Nominatim qui non è filtrato, per non cambiare quello che la
+   * libreria ha sempre restituito.
+   */
+  country?: string;
+  /** Dove polarizzare le proposte di `google`. Vedi {@link NgxGeocodingBias}. */
+  bias?: NgxGeocodingBias;
+  /** Il servizio Nominatim, se non quello pubblico di OpenStreetMap. */
+  nominatimUrl?: string;
 }
-
 /**
  * @author Vito Salvia - CNR IMAA geoSDI Group
  * @email vito.salvia@gmail.com
@@ -257,7 +252,7 @@ interface NgxGeocodingConfig {
  * La configurazione della ricerca, che **può non esserci** : in quel caso vale
  * il comportamento storico, cioè Nominatim e basta.
  */
-declare const NGX_GEOCODING_CONFIG: InjectionToken<NgxGeocodingConfig>;
+export declare const NGX_GEOCODING_CONFIG: InjectionToken<NgxGeocodingConfig>;
 /**
  * Dichiara da dove arrivano gli indirizzi, nei `providers` dell'applicazione :
  *
@@ -275,7 +270,4 @@ declare const NGX_GEOCODING_CONFIG: InjectionToken<NgxGeocodingConfig>;
  *
  * Chi non la chiama non cambia niente.
  */
-declare function provideNgxGeocoding(config: NgxGeocodingConfig): Provider;
-
-export { NGX_GEOCODING_CONFIG, NgxGeocodingModule, NgxGeocodingService, provideNgxGeocoding };
-export type { GeocodingLocation, NgxGeocodingBias, NgxGeocodingConfig, NgxGeocodingSource };
+export declare function provideNgxGeocoding(config: NgxGeocodingConfig): Provider;