@maptiler/geocoding-control 2.1.7 → 3.0.0-rc.2

package/dist/src/components/clear-icon.d.ts

@@ -0,0 +1,10 @@
+import { LitElement } from 'lit';
+export declare class MaptilerGeocodeClearIconElement extends LitElement {
+    static styles: import('lit').CSSResult;
+    render(): import('lit-html').TemplateResult<2>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "maptiler-geocode-clear-icon": MaptilerGeocodeClearIconElement;
+    }
+}

package/dist/src/components/fail-icon.d.ts

@@ -0,0 +1,10 @@
+import { LitElement } from 'lit';
+export declare class MaptilerGeocodeFailIconElement extends LitElement {
+    static styles: import('lit').CSSResult;
+    render(): import('lit-html').TemplateResult<2>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "maptiler-geocode-fail-icon": MaptilerGeocodeFailIconElement;
+    }
+}

package/dist/src/components/loading-icon.d.ts

@@ -0,0 +1,10 @@
+import { LitElement } from 'lit';
+export declare class MaptilerGeocodeLoadingIconElement extends LitElement {
+    static styles: import('lit').CSSResult;
+    render(): import('lit-html').TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "maptiler-geocode-loading-icon": MaptilerGeocodeLoadingIconElement;
+    }
+}

package/dist/src/components/marker.d.ts

@@ -0,0 +1,10 @@
+import { LitElement } from 'lit';
+export declare class MaptilerGeocodeMarkerElement extends LitElement {
+    static styles: import('lit').CSSResult;
+    render(): import('lit-html').TemplateResult<2>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "maptiler-geocode-marker": MaptilerGeocodeMarkerElement;
+    }
+}

package/dist/src/components/reverse-geocoding-icon.d.ts

@@ -0,0 +1,10 @@
+import { LitElement } from 'lit';
+export declare class MaptilerGeocodeReverseGeocodingIconElement extends LitElement {
+    static styles: import('lit').CSSResult;
+    render(): import('lit-html').TemplateResult<2>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "maptiler-geocode-reverse-geocoding-icon": MaptilerGeocodeReverseGeocodingIconElement;
+    }
+}

package/dist/src/components/search-icon.d.ts

@@ -0,0 +1,10 @@
+import { LitElement } from 'lit';
+export declare class MaptilerGeocodeSearchIconElement extends LitElement {
+    static styles: import('lit').CSSResult;
+    render(): import('lit-html').TemplateResult<2>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "maptiler-geocode-search-icon": MaptilerGeocodeSearchIconElement;
+    }
+}

package/dist/src/controls/base-control.d.ts

@@ -0,0 +1,44 @@
+export interface GeocodingControlBase<Options extends object> {
+    /**
+     * Update the control options.
+     *
+     * @param options options to update
+     */
+    setOptions(options: Options): void;
+    /**
+     * Set the content of search input box.
+     *
+     * @param value text to set
+     */
+    setQuery(value: string): void;
+    /**
+     * Set the content of search input box and immediately submit it.
+     *
+     * @param value text to set and submit
+     */
+    submitQuery(value: string): void;
+    /**
+     * Clear geocoding search results from the map.
+     */
+    clearMap(): void;
+    /**
+     * Clear search result list.
+     */
+    clearList(): void;
+    /**
+     * Set reverse geocoding mode.
+     *
+     * @param reverseActive reverse geocoding active
+     */
+    setReverseMode(reverseActive: boolean): void;
+    /**
+     * Focus the search input box.
+     *
+     * @param options [FocusOptions](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus#options)
+     */
+    focus(options?: FocusOptions): void;
+    /**
+     * Blur the search input box.
+     */
+    blur(): void;
+}

package/dist/src/controls/leaflet-control.d.ts

@@ -0,0 +1,27 @@
+import { Control, ControlOptions, Evented, Map as LMap } from 'leaflet';
+import { GeocodingControlBase } from './base-control';
+import { LeafletGeocodingControlOptions } from './leaflet-options';
+/** Base class for Control needs to extend both Control and Evented */
+declare abstract class EventedControl<Options extends ControlOptions> extends Control {
+    options: Options;
+}
+interface EventedControl<Options extends ControlOptions> extends Control, Evented {
+    options: Options;
+}
+export declare class LeafletGeocodingControl extends EventedControl<LeafletGeocodingControlOptions> implements GeocodingControlBase<LeafletGeocodingControlOptions> {
+    #private;
+    constructor(options?: LeafletGeocodingControlOptions);
+    /** @internal Not to be called directly */
+    onAdd(map: LMap): HTMLElement;
+    /** @internal Not to be called directly */
+    onRemove(): void;
+    setOptions(options: LeafletGeocodingControlOptions): void;
+    setQuery(value: string): void;
+    submitQuery(value: string): void;
+    clearMap(): void;
+    clearList(): void;
+    setReverseMode(reverseActive: boolean): void;
+    focus(options?: FocusOptions): void;
+    blur(): void;
+}
+export {};

package/dist/src/controls/leaflet-events.d.ts

@@ -0,0 +1,42 @@
+import { Marker } from 'leaflet';
+import { Feature } from '../types';
+import type * as Geocoder from "../geocoder/geocoder-events";
+export type ReverseToggleEvent = Geocoder.ReverseToggleEvent["detail"];
+export type QueryChangeEvent = Geocoder.QueryChangeEvent["detail"];
+export type FeaturesListedEvent = Geocoder.FeaturesListedEvent["detail"];
+export type RequestEvent = Geocoder.RequestEvent["detail"];
+export type ResponseEvent = Geocoder.ResponseEvent["detail"];
+export type SelectEvent = Geocoder.SelectEvent["detail"];
+export type PickEvent = Geocoder.PickEvent["detail"];
+export type MarkerClickEvent = {
+    feature: Feature;
+    marker: Marker;
+};
+export type MarkerMouseEnterEvent = {
+    feature: Feature;
+    marker: Marker;
+};
+export type MarkerMouseLeaveEvent = {
+    feature: Feature;
+    marker: Marker;
+};
+export type LeafletGeocodingControlEventNameMap = {
+    reversetoggle: ReverseToggleEvent;
+    querychange: QueryChangeEvent;
+    queryclear: never;
+    request: RequestEvent;
+    response: ResponseEvent;
+    select: SelectEvent;
+    pick: PickEvent;
+    featuresshow: never;
+    featureshide: never;
+    featureslisted: FeaturesListedEvent;
+    featuresclear: never;
+    focusin: never;
+    focusout: never;
+    markerclick: MarkerClickEvent;
+    markermouseenter: MarkerMouseEnterEvent;
+    markermouseleave: MarkerMouseLeaveEvent;
+};
+export type LeafletGeocodingControlEvent = LeafletGeocodingControlEventNameMap[keyof LeafletGeocodingControlEventNameMap];
+export type LeafletGeocodingControlEventName = keyof LeafletGeocodingControlEventNameMap;

package/dist/src/controls/leaflet-options.d.ts

@@ -0,0 +1,84 @@
+import { ControlOptions, Map as LMap, Marker, MarkerOptions, PathOptions, StyleFunction, ZoomPanOptions } from 'leaflet';
+import { MaptilerGeocoderOptions } from '../geocoder/geocoder-options';
+import { Feature, PickedResultStyle } from '../types';
+export type LeafletGeocodingControlOptions = Omit<MaptilerGeocoderOptions, "fetchFullGeometryOnPick"> & {
+    /**
+     * Marker to be added to the map at the location of the user-selected result using a default set of Marker options.
+     *
+     * - If `true` or `undefined` then a default marker will be used.
+     * - If the value is a [MarkerOptions](https://leafletjs.com/reference.html#marker-option) then the marker will be constructed using these options.
+     * - If the value is a function then it can return instance of the [Marker](https://leafletjs.com/reference.html#marker).
+     *   Function can accept `Feature` as a parameter which is `undefined` for the reverse location marker.
+     * - If `false` or `null` then no marker will be added to the map.
+     *
+     * Default value is `true`.
+     */
+    marker?: null | boolean | MarkerOptions | ((map: LMap, feature?: Feature) => undefined | null | Marker);
+    /**
+     * Displays a marker on the selected feature from the result list. `marker` must be enabled in any way for this to display.
+     *
+     * Default: `true`.
+     */
+    markerOnSelected?: boolean;
+    /**
+     * Marker be added to the map at the location the geocoding results.
+     *
+     * - If `true` or `undefined` then a default marker will be used.
+     * - If the value is a [MarkerOptions](https://leafletjs.com/reference.html#marker-option) then the marker will be constructed using these options.
+     * - If the value is a function then it can return instance of the [Marker](https://leafletjs.com/reference.html#marker).
+     *   In this case the default pop-up won't be added to the marker.
+     *   Function can accept `Feature` as a parameter.
+     * - If `false` or `null` then no marker will be added to the map.
+     *
+     * Default value is `true`.
+     */
+    showResultMarkers?: null | boolean | MarkerOptions | ((map: LMap, feature: Feature) => undefined | null | Marker);
+    /**
+     * Animation to picked feature on the map.
+     *
+     * - If `false` or `null` then animating the map to a selected result is disabled.
+     * - If `true` or `undefined` then animating the map will use the default animation parameters.
+     * - If the value is [ZoomPanOptions](https://leafletjs.com/reference.html#zoom/pan-options)
+     *     then it will be passed as options to the map [flyTo](https://leafletjs.com/reference.html#map-flyto)
+     *     or [fitBounds](https://leafletjs.com/reference.html#map-fitbounds) method providing control over the animation of the transition.
+     *
+     * Default value is `true`.
+     */
+    flyTo?: null | boolean | ZoomPanOptions;
+    /**
+     * Specifies if selected (not picked) feature should be also animated to on the map.
+     *
+     * Default: `false`.
+     */
+    flyToSelected?: boolean;
+    /**
+     * Style for full feature geometry GeoJSON.
+     *
+     * - If `false` or `null` then no full geometry is drawn.
+     * - If `true` or `undefined` then default-styled full geometry is drawn.
+     * - If an T then it must represent the style and will be used to style the full geometry.
+     *
+     * Default is the default style.
+     */
+    fullGeometryStyle?: null | boolean | PathOptions | StyleFunction;
+    /**
+     * Style of the picked result on the map:
+     * - `"marker-only"`: Show only a marker at the center of the feature.
+     * - `"full-geometry"`: Display the full feature geometry.
+     * - `"full-geometry-including-polygon-center-marker"`: Display full geometry with a marker at the polygon center.
+     *
+     * Default: `"full-geometry"`.
+     */
+    pickedResultStyle?: PickedResultStyle;
+    /**
+     * Specifies the zoom level to animate the map to for a geocoded result when no bounding box is present or when the result is a point.
+     * If a bounding box is present and not a point, the map will fit to the bounding box.
+     *
+     * Values are key-value pairs where the key is a `<type>` or `<type>.<category>` and the value is the zoom level.
+     *
+     * Default: `ZOOM_DEFAULTS`.
+     */
+    zoom?: Record<string, number>;
+} & ControlOptions;
+export declare const ZOOM_DEFAULTS: Record<string, number>;
+export declare const DEFAULT_GEOMETRY_STYLE: StyleFunction;

package/dist/src/controls/maplibregl-control.d.ts

@@ -0,0 +1,34 @@
+import { default as maplibregl } from 'maplibre-gl';
+import { GeocodingControlBase } from './base-control';
+import { MaplibreglGeocodingControlEventName, MaplibreglGeocodingControlEventNameMap } from './maplibregl-events';
+import { MaplibreglGeocodingControlOptions } from './maplibregl-options';
+declare const Evented: typeof maplibregl.Evented;
+type Evented = maplibregl.Evented;
+type IControl = maplibregl.IControl;
+type MLMap = maplibregl.Map;
+type Subscription = maplibregl.Subscription;
+type EventHandlingMethod<Return> = <Type extends MaplibreglGeocodingControlEventName>(type: Type, listener: (event: MaplibreglGeocodingControlEventNameMap[Type]) => void) => Return;
+interface EventOnceHandlingMethod<Return> {
+    <Type extends MaplibreglGeocodingControlEventName>(type: Type, listener: (event: MaplibreglGeocodingControlEventNameMap[Type]) => void): Return;
+    <Type extends MaplibreglGeocodingControlEventName>(type: Type, listener?: undefined): Promise<MaplibreglGeocodingControlEventNameMap[Type]>;
+}
+export declare class MaplibreglGeocodingControl extends Evented implements IControl, GeocodingControlBase<MaplibreglGeocodingControlOptions> {
+    #private;
+    constructor(options?: MaplibreglGeocodingControlOptions);
+    /** @internal Not to be called directly */
+    onAdd(map: MLMap): HTMLElement;
+    /** @internal Not to be called directly */
+    onRemove(): void;
+    setOptions(options: MaplibreglGeocodingControlOptions): void;
+    setQuery(value: string): void;
+    submitQuery(value: string): void;
+    clearMap(): void;
+    clearList(): void;
+    setReverseMode(reverseActive: boolean): void;
+    focus(options?: FocusOptions): void;
+    blur(): void;
+    on: EventHandlingMethod<Subscription>;
+    off: EventHandlingMethod<this>;
+    once: EventOnceHandlingMethod<this>;
+}
+export {};

package/dist/src/controls/maplibregl-events.d.ts

@@ -0,0 +1,44 @@
+import { default as maplibregl } from 'maplibre-gl';
+import { Feature } from '../types';
+type Marker = maplibregl.Marker;
+import type * as Geocoder from "../geocoder/geocoder-events";
+export type ReverseToggleEvent = Geocoder.ReverseToggleEvent["detail"];
+export type QueryChangeEvent = Geocoder.QueryChangeEvent["detail"];
+export type FeaturesListedEvent = Geocoder.FeaturesListedEvent["detail"];
+export type RequestEvent = Geocoder.RequestEvent["detail"];
+export type ResponseEvent = Geocoder.ResponseEvent["detail"];
+export type SelectEvent = Geocoder.SelectEvent["detail"];
+export type PickEvent = Geocoder.PickEvent["detail"];
+export type MarkerClickEvent = {
+    feature: Feature;
+    marker: Marker;
+};
+export type MarkerMouseEnterEvent = {
+    feature: Feature;
+    marker: Marker;
+};
+export type MarkerMouseLeaveEvent = {
+    feature: Feature;
+    marker: Marker;
+};
+export type MaplibreglGeocodingControlEventNameMap = {
+    reversetoggle: ReverseToggleEvent;
+    querychange: QueryChangeEvent;
+    queryclear: never;
+    request: RequestEvent;
+    response: ResponseEvent;
+    select: SelectEvent;
+    pick: PickEvent;
+    featuresshow: never;
+    featureshide: never;
+    featureslisted: FeaturesListedEvent;
+    featuresclear: never;
+    focusin: never;
+    focusout: never;
+    markerclick: MarkerClickEvent;
+    markermouseenter: MarkerMouseEnterEvent;
+    markermouseleave: MarkerMouseLeaveEvent;
+};
+export type MaplibreglGeocodingControlEvent = MaplibreglGeocodingControlEventNameMap[keyof MaplibreglGeocodingControlEventNameMap];
+export type MaplibreglGeocodingControlEventName = keyof MaplibreglGeocodingControlEventNameMap;
+export {};

package/dist/src/controls/maplibregl-options.d.ts

@@ -0,0 +1,104 @@
+import { default as maplibregl } from 'maplibre-gl';
+import { MaptilerGeocoderOptions } from '../geocoder/geocoder-options';
+import { Feature, PickedResultStyle } from '../types';
+type FillLayerSpecification = maplibregl.FillLayerSpecification;
+type FitBoundsOptions = maplibregl.FitBoundsOptions;
+type FlyToOptions = maplibregl.FlyToOptions;
+type LineLayerSpecification = maplibregl.LineLayerSpecification;
+type Marker = maplibregl.Marker;
+type MarkerOptions = maplibregl.MarkerOptions;
+type MLMap = maplibregl.Map;
+export type MaplibreglGeocodingControlOptions = Omit<MaptilerGeocoderOptions, "apiKey" | "fetchFullGeometryOnPick"> & {
+    /**
+     * Maptiler API key. Optional if used with MapTiler SDK - if not specified, the control will use the same API key as the map uses.
+     */
+    apiKey?: string;
+    /**
+     * Marker to be added to the map at the location of the user-selected result using a default set of Marker options.
+     *
+     * - If `true` or `undefined` then a default marker will be used.
+     * - If the value is a [MarkerOptions](https://maplibre.org/maplibre-gl-js/docs/API/type-aliases/MarkerOptions/) then the marker will be constructed using these options.
+     * - If the value is a function then it can return instance of the [Marker](https://maplibre.org/maplibre-gl-js/docs/API/classes/Marker/).
+     *   Function can accept `Feature` as a parameter which is `undefined` for the reverse location marker.
+     * - If `false` or `null` then no marker will be added to the map.
+     *
+     * Default value is `true`.
+     */
+    marker?: null | boolean | MarkerOptions | ((map: MLMap, feature?: Feature) => undefined | null | Marker);
+    /**
+     * Displays a marker on the selected feature from the result list. `marker` must be enabled in any way for this to display.
+     *
+     * Default: `true`.
+     */
+    markerOnSelected?: boolean;
+    /**
+     * Marker be added to the map at the location the geocoding results.
+     *
+     * - If `true` or `undefined` then a default marker will be used.
+     * - If the value is a [MarkerOptions](https://maplibre.org/maplibre-gl-js/docs/API/type-aliases/MarkerOptions/) then the marker will be constructed using these options.
+     * - If the value is a function then it can return instance of the [Marker](https://maplibre.org/maplibre-gl-js/docs/API/classes/Marker/).
+     *   In this case the default pop-up won't be added to the marker.
+     *   Function can accept `Feature` as a parameter.
+     * - If `false` or `null` then no marker will be added to the map.
+     *
+     * Default value is `true`.
+     */
+    showResultMarkers?: null | boolean | MarkerOptions | ((map: MLMap, feature: Feature) => undefined | null | Marker);
+    /**
+     * Animation to picked feature on the map.
+     *
+     * - If `false` or `null` then animating the map to a selected result is disabled.
+     * - If `true` or `undefined` then animating the map will use the default animation parameters.
+     * - If an [FlyToOptions](https://maplibre.org/maplibre-gl-js/docs/API/type-aliases/FlyToOptions/)
+     *     ` & `[FitBoundsOptions](https://maplibre.org/maplibre-gl-js/docs/API/type-aliases/FitBoundsOptions/)
+     *     then it will be passed as options to the map [flyTo](https://maplibre.org/maplibre-gl-js/docs/API/classes/Map/#flyto)
+     *     or [fitBounds](https://maplibre.org/maplibre-gl-js/docs/API/classes/Map/#fitbounds) method providing control over the animation of the transition.
+     *
+     * Default value is `true`.
+     */
+    flyTo?: null | boolean | (FlyToOptions & FitBoundsOptions);
+    /**
+     * Specifies if selected (not picked) feature should be also animated to on the map.
+     *
+     * Default: `false`.
+     */
+    flyToSelected?: boolean;
+    /**
+     * Style for full feature geometry GeoJSON.
+     *
+     * - If `false` or `null` then no full geometry is drawn.
+     * - If `true` or `undefined` then default-styled full geometry is drawn.
+     * - If an T then it must represent the style and will be used to style the full geometry.
+     *
+     * Default is the default style.
+     */
+    fullGeometryStyle?: null | boolean | Partial<FullGeometryStyle>;
+    /**
+     * Style of the picked result on the map:
+     * - `"marker-only"`: Show only a marker at the center of the feature.
+     * - `"full-geometry"`: Display the full feature geometry.
+     * - `"full-geometry-including-polygon-center-marker"`: Display full geometry with a marker at the polygon center.
+     *
+     * Default: `"full-geometry"`.
+     */
+    pickedResultStyle?: PickedResultStyle;
+    /**
+     * Specifies the zoom level to animate the map to for a geocoded result when no bounding box is present or when the result is a point.
+     * If a bounding box is present and not a point, the map will fit to the bounding box.
+     *
+     * Values are key-value pairs where the key is a `<type>` or `<type>.<category>` and the value is the zoom level.
+     *
+     * Default: `ZOOM_DEFAULTS`.
+     */
+    zoom?: Record<string, number>;
+};
+export type FullGeometryStyle = {
+    fill: Pick<FillLayerSpecification, "layout" | "paint" | "filter">;
+    line: Pick<LineLayerSpecification, "layout" | "paint" | "filter">;
+};
+export declare const ZOOM_DEFAULTS: Record<string, number>;
+export declare const DEFAULT_GEOMETRY_STYLE: FullGeometryStyle;
+export declare const RESULT_SOURCE = "mtlr-gc-full-geom";
+export declare const RESULT_LAYER_FILL = "mtlr-gc-full-geom-fill";
+export declare const RESULT_LAYER_LINE = "mtlr-gc-full-geom-line";
+export {};

package/dist/src/controls/maptilersdk-control.d.ts

@@ -0,0 +1,7 @@
+import { GeocodingControlBase } from './base-control';
+import { MaplibreglGeocodingControl } from './maplibregl-control';
+import { MaptilerGeocodingControlOptions } from './maptilersdk-options';
+export declare class MaptilerGeocodingControl extends MaplibreglGeocodingControl implements GeocodingControlBase<MaptilerGeocodingControlOptions> {
+    constructor(options?: MaptilerGeocodingControlOptions);
+    setOptions(options: MaptilerGeocodingControlOptions): void;
+}

package/dist/src/controls/maptilersdk-events.d.ts

@@ -0,0 +1,2 @@
+import { FeaturesListedEvent, MaplibreglGeocodingControlEvent, MaplibreglGeocodingControlEventName, MaplibreglGeocodingControlEventNameMap, MarkerClickEvent, MarkerMouseEnterEvent, MarkerMouseLeaveEvent, PickEvent, QueryChangeEvent, RequestEvent, ResponseEvent, ReverseToggleEvent, SelectEvent } from './maplibregl-events';
+export type { FeaturesListedEvent, MaplibreglGeocodingControlEvent as MaptilerGeocodingControlEvent, MaplibreglGeocodingControlEventName as MaptilerGeocodingControlEventName, MaplibreglGeocodingControlEventNameMap as MaptilerGeocodingControlEventNameMap, MarkerClickEvent, MarkerMouseEnterEvent, MarkerMouseLeaveEvent, PickEvent, QueryChangeEvent, RequestEvent, ResponseEvent, ReverseToggleEvent, SelectEvent, };

package/dist/src/controls/maptilersdk-options.d.ts

@@ -0,0 +1,10 @@
+import { MaplibreglGeocodingControlOptions } from './maplibregl-options';
+export type MaptilerGeocodingControlOptions = Omit<MaplibreglGeocodingControlOptions, "apiKey"> & {
+    /**
+     * Maptiler API key.
+     *
+     * Default: The same API key as the connected map uses.
+     */
+    apiKey?: string;
+};
+export { DEFAULT_GEOMETRY_STYLE, RESULT_LAYER_FILL, RESULT_LAYER_LINE, RESULT_SOURCE, ZOOM_DEFAULTS, type FullGeometryStyle } from './maplibregl-options';

package/dist/src/controls/openlayers-control.d.ts

@@ -0,0 +1,35 @@
+import { Map as OLMap } from 'ol';
+import { Types as ObjectEventTypes } from 'ol/ObjectEventType';
+import { EventTypes } from 'ol/Observable';
+import { Control } from 'ol/control';
+import { EventsKey } from 'ol/events';
+import { default as BaseEvent } from 'ol/events/Event';
+import { GeocodingControlBase } from './base-control';
+import { OpenLayersGeocodingControlEventName, OpenLayersGeocodingControlEventNameMap } from './openlayers-events';
+import { OpenLayersGeocodingControlOptions } from './openlayers-options';
+type TypedBaseEvent<Type extends OpenLayersGeocodingControlEventName> = BaseEvent & {
+    type: Type;
+} & OpenLayersGeocodingControlEventNameMap[Type];
+interface EventHandlingMethod {
+    (type: EventTypes | ObjectEventTypes, listener: (event: BaseEvent) => unknown): EventsKey;
+    <Type extends OpenLayersGeocodingControlEventName>(type: Type, listener: (event: TypedBaseEvent<Type>) => unknown): EventsKey;
+    (type: Array<EventTypes | ObjectEventTypes | OpenLayersGeocodingControlEventName>, listener: (event: BaseEvent) => unknown): EventsKey[];
+}
+export declare class OpenLayersGeocodingControl extends Control implements GeocodingControlBase<OpenLayersGeocodingControlOptions> {
+    #private;
+    constructor(options?: OpenLayersGeocodingControlOptions);
+    /** @internal Not to be called directly */
+    setMap(map: OLMap | null): void;
+    setOptions(options: OpenLayersGeocodingControlOptions): void;
+    setQuery(value: string): void;
+    submitQuery(value: string): void;
+    clearMap(): void;
+    clearList(): void;
+    setReverseMode(reverseActive: boolean): void;
+    focus(options?: FocusOptions): void;
+    blur(): void;
+    on: EventHandlingMethod;
+    once: EventHandlingMethod;
+    un: EventHandlingMethod;
+}
+export {};

package/dist/src/controls/openlayers-events.d.ts

@@ -0,0 +1,43 @@
+import { Feature as OlFeature } from 'ol';
+import { Point as OlPoint } from 'ol/geom';
+import { Feature } from '../types';
+import type * as Geocoder from "../geocoder/geocoder-events";
+export type ReverseToggleEvent = Geocoder.ReverseToggleEvent["detail"];
+export type QueryChangeEvent = Geocoder.QueryChangeEvent["detail"];
+export type FeaturesListedEvent = Geocoder.FeaturesListedEvent["detail"];
+export type RequestEvent = Geocoder.RequestEvent["detail"];
+export type ResponseEvent = Geocoder.ResponseEvent["detail"];
+export type SelectEvent = Geocoder.SelectEvent["detail"];
+export type PickEvent = Geocoder.PickEvent["detail"];
+export type MarkerClickEvent = {
+    feature: Feature;
+    marker: OlFeature<OlPoint>;
+};
+export type MarkerMouseEnterEvent = {
+    feature: Feature;
+    marker: OlFeature<OlPoint>;
+};
+export type MarkerMouseLeaveEvent = {
+    feature: Feature;
+    marker: OlFeature<OlPoint>;
+};
+export type OpenLayersGeocodingControlEventNameMap = {
+    reversetoggle: ReverseToggleEvent;
+    querychange: QueryChangeEvent;
+    queryclear: never;
+    request: RequestEvent;
+    response: ResponseEvent;
+    select: SelectEvent;
+    pick: PickEvent;
+    featuresshow: never;
+    featureshide: never;
+    featureslisted: FeaturesListedEvent;
+    featuresclear: never;
+    focusin: never;
+    focusout: never;
+    markerclick: MarkerClickEvent;
+    markermouseenter: MarkerMouseEnterEvent;
+    markermouseleave: MarkerMouseLeaveEvent;
+};
+export type OpenLayersGeocodingControlEvent = OpenLayersGeocodingControlEventNameMap[keyof OpenLayersGeocodingControlEventNameMap];
+export type OpenLayersGeocodingControlEventName = keyof OpenLayersGeocodingControlEventNameMap;

package/dist/src/controls/openlayers-options.d.ts

@@ -0,0 +1,83 @@
+import { AnimationOptions, FitOptions } from 'ol/View';
+import { Options } from 'ol/control/Control';
+import { StyleFunction, StyleLike } from 'ol/style/Style';
+import { FlatStyleLike } from 'ol/style/flat';
+import { MaptilerGeocoderOptions } from '../geocoder/geocoder-options';
+import { PickedResultStyle } from '../types';
+export type OpenLayersGeocodingControlOptions = Omit<MaptilerGeocoderOptions, "fetchFullGeometryOnPick"> & {
+    /**
+     * Marker to be added to the map at the location of the user-selected result.
+     *
+     * Default value is `true`.
+     */
+    marker?: boolean;
+    /**
+     * Displays a marker on the selected feature from the result list. `marker` must be also enabled for this to display.
+     *
+     * Default: `true`.
+     */
+    markerOnSelected?: boolean;
+    /**
+     * Marker be added to the map at the location the geocoding results.
+     *
+     * Default value is `true`.
+     */
+    showResultMarkers?: boolean;
+    /**
+     * Animation to picked feature on the map.
+     *
+     * - If `false` or `null` then animating the map to a selected result is disabled.
+     * - If `true` or `undefined` then animating the map will use the default animation parameters.
+     * - If the value is [AnimationOptions](https://openlayers.org/en/latest/apidoc/module-ol_View.html#~AnimationOptions)
+     *     and [FitOptions](https://openlayers.org/en/latest/apidoc/module-ol_View.html#~FitOptions)
+     *     then it will be passed as options to the map's view [animate](https://openlayers.org/en/latest/apidoc/module-ol_View-View.html#animate)
+     *     or [fit](https://openlayers.org/en/latest/apidoc/module-ol_View-View.html#fit) method providing control over the animation of the transition.
+     *
+     * Default value is `true`.
+     */
+    flyTo?: null | boolean | (AnimationOptions & FitOptions);
+    /**
+     * Specifies if selected (not picked) feature should be also animated to on the map.
+     *
+     * Default: `false`.
+     */
+    flyToSelected?: boolean;
+    /**
+     * Style for full feature geometry GeoJSON.
+     *
+     * - If `false` or `null` then no full geometry is drawn.
+     * - If `true` or `undefined` then default-styled full geometry is drawn.
+     * - If the value is [StyleLike](https://openlayers.org/en/latest/apidoc/module-ol_style_Style.html#~StyleLike)
+     *     or [FlatStyleLike](https://openlayers.org/en/latest/apidoc/module-ol_style_flat.html#~FlatStyleLike)
+     *     then it must represent the style and will be used to style the full geometry.
+     *
+     * Default is the default style.
+     */
+    fullGeometryStyle?: null | boolean | StyleLike | FlatStyleLike;
+    /**
+     * Opens the Geocoder result list above the query input instead of below. Used when positioned near the bottom of a map.
+     *
+     * Default: `false`.
+     */
+    openListOnTop?: boolean;
+    /**
+     * Style of the picked result on the map:
+     * - `"marker-only"`: Show only a marker at the center of the feature.
+     * - `"full-geometry"`: Display the full feature geometry.
+     * - `"full-geometry-including-polygon-center-marker"`: Display full geometry with a marker at the polygon center.
+     *
+     * Default: `"full-geometry"`.
+     */
+    pickedResultStyle?: PickedResultStyle;
+    /**
+     * Specifies the zoom level to animate the map to for a geocoded result when no bounding box is present or when the result is a point.
+     * If a bounding box is present and not a point, the map will fit to the bounding box.
+     *
+     * Values are key-value pairs where the key is a `<type>` or `<type>.<category>` and the value is the zoom level.
+     *
+     * Default: `ZOOM_DEFAULTS`.
+     */
+    zoom?: Record<string, number>;
+} & Omit<Options, "element">;
+export declare const ZOOM_DEFAULTS: Record<string, number>;
+export declare const DEFAULT_GEOMETRY_STYLE: (options: OpenLayersGeocodingControlOptions) => StyleFunction;