@maptiler/geocoding-control 2.1.0-with-autocomplete-timeout → 2.1.1

package/types.d.ts

@@ -1,344 +0,0 @@
-import type { Feature as FeatureType, Geometry } from "geojson";
-export type BBox = [minx: number, miny: number, maxx: number, maxy: number];
-export type Position = [x: number, y: number];
-export type Feature<T extends Geometry = Geometry> = FeatureType<T> & {
-    id: string;
-    text: string;
-    place_name: string;
-    place_type: string[];
-    center: Position;
-    bbox: BBox;
-    address?: string;
-    matching_text?: string;
-};
-export type FeatureCollection<T extends Geometry = Geometry> = {
-    type: "FeatureCollection";
-    features: Feature<T>[];
-};
-export type MapEvent = {
-    type: "mapClick";
-    coordinates: Position;
-} | {
-    type: "markerClick";
-    id: string;
-} | {
-    type: "markerMouseEnter";
-    id: string;
-} | {
-    type: "markerMouseLeave";
-    id: string;
-};
-export type MapController = {
-    setEventHandler(handler: undefined | ((e: MapEvent) => void)): void;
-    flyTo(center: Position, zoom?: number): void;
-    fitBounds(bbox: BBox, padding: number, maxZoom?: number): void;
-    indicateReverse(reverse: boolean): void;
-    setFeatures(features: Feature[] | undefined, picked: Feature | undefined, showPolygonMarker: boolean): void;
-    setReverseMarker(coordinates?: Position): void;
-    setSelectedMarker(index: number): void;
-    getCenterAndZoom(): [zoom: number, lon: number, lat: number] | undefined;
-};
-export type ProximityRule = {
-    /** minimal map zoom for the rule to be used */
-    minZoom?: number;
-    /** maximal map zoom for the rule to be used */
-    maxZoom?: number;
-} & ({
-    /** fixed proximity */
-    type: "fixed";
-    /** coordinates of the fixed proximity */
-    coordinates: Position;
-} | {
-    /** use map center coordinates for the proximity */
-    type: "map-center";
-} | {
-    /** resolve proximity by geolocating IP of the geocoding API call */
-    type: "server-geolocation";
-} | ({
-    /** use browser's geolocation API for proximity. If it fails, following proximity rules are iterated. */
-    type: "client-geolocation";
-    /** how long should the geolocation result be cached, in milliseconds */
-    cachedLocationExpiry?: number;
-} & PositionOptions));
-export type ControlOptions = {
-    /**
-     * Maptiler API key
-     */
-    apiKey: string;
-    /**
-     * Sets the amount of time, in milliseconds, to wait before querying the server when a user types into the Geocoder input box.
-     * This parameter may be useful for reducing the total number of API calls made for a single query.
-     *
-     * Default value is `200`.
-     */
-    debounceSearch?: number;
-    /**
-     * Search results closer to the proximity point will be given higher priority. First matching rule from the array will be used.
-     * Set to `null` to disable the proximity.
-     *
-     * Default value is `[{ type: "server-geolocation" }]`.
-     */
-    proximity?: ProximityRule[] | null;
-    /**
-     * Override the default placeholder attribute value.
-     *
-     * Default value is `"Search"`.
-     */
-    placeholder?: string;
-    /**
-     * Override the default error message.
-     *
-     * Default value is `"Something went wrong…"`.
-     */
-    errorMessage?: string;
-    /**
-     * Override the default message if no results are found.
-     *
-     * Default value is `"Oops! Looks like you're trying to predict something that's not quite right. We can't seem to find what you're looking for. Maybe try double-checking your spelling or try a different search term. Keep on typing - we'll do our best to get you where you need to go!"`.
-     */
-    noResultsMessage?: string;
-    /**
-     * Minimum number of characters to enter before results are shown.
-     *
-     * Default value is `2`.
-     */
-    minLength?: number;
-    /**
-     * A bounding box argument: this is a bounding box given as an array in the format [minX, minY, maxX, maxY].
-     * Search results will be limited to the bounding box.
-     *
-     * Default value is `undefined`.
-     */
-    bbox?: BBox;
-    /**
-     * Maximum number of results to show.
-     *
-     * Default value is `5`.
-     */
-    limit?: number;
-    /**
-     * Specify the language to use for response text and query result weighting.
-     * Options are IETF language tags comprised of a mandatory ISO 639-1 language code and optionally one or more IETF subtags for country or script.
-     * More than one value can also be specified, separated by commas.
-     * Set to `null` or empty string for disabling language-specific searching.
-     *
-     * Default value is `undefined` which means to use the browser's language settings.
-     */
-    language?: string | string[] | null;
-    /**
-     * If `false`, indicates that search will only occur on enter key press.
-     * If `true`, indicates that the Geocoder will search on the input box being updated above the minLength option.
-     *
-     * Default value is `false`.
-     */
-    showResultsWhileTyping?: boolean;
-    autocompleteTimeout?: number;
-    /**
-     * Set to `false` to disable fuzzy search.
-     *
-     * Default value is `true`.
-     */
-    fuzzyMatch?: boolean;
-    /**
-     * On geocoded result what zoom level should the map animate to when a bbox in the response isn't present or is a point.
-     * If a bbox is present and not a point then the map will fit to the bbox.
-     *
-     * Value is key-value pairs, where key is a &lt;type&gt; or &lt;type&gt;.&lt;categoy&gt; and the value is the zoom level.
-     *
-     * Default value is `GeocodingControl.ZOOM_DEFAULTS`.
-     */
-    zoom?: Record<string, number>;
-    /**
-     * If `true`, the geocoder control will collapse until hovered or in focus.
-     *
-     * Default value is `false`.
-     */
-    collapsed?: boolean;
-    /**
-     * If `true`, the geocoder control will clear its value when the input blurs.
-     *
-     * Default value is `false`.
-     */
-    clearOnBlur?: boolean;
-    /**
-     * If `true`, then after picking a result from the list or map the list will be cleared and not re-displayed on input box focus.
-     *
-     * Default value is `false`.
-     */
-    clearListOnPick?: boolean;
-    /**
-     * Keep the list open even if the control is not focused.
-     *
-     * Default value is `false`.
-     */
-    keepListOpen?: boolean;
-    /**
-     * A function which accepts a Feature in the Carmen GeoJSON format to filter out results from the Geocoding API response before they are included in the suggestions list.
-     * Return true to keep the item, false otherwise.
-     *
-     * Default value is a function returning always `true`.
-     */
-    filter?: (feature: Feature) => boolean;
-    /**
-     * Class of the root element.
-     *
-     * Default value is `undefined`.
-     */
-    class?: string;
-    /**
-     * Set to `button` to enable reverse geocoding button with title. Set to `"always"` to reverse geocoding be always active.
-     *
-     * Default value is `"never"`.
-     */
-    enableReverse?: EnableReverse;
-    /**
-     * Reverse mode active.
-     *
-     * Default value is `false`.
-     */
-    reverseActive?: boolean;
-    /**
-     * Title of the reverse toggle button.
-     *
-     * Default value is `"toggle reverse geocoding"`.
-     */
-    reverseButtonTitle?: string;
-    /**
-     * Title of the clear button.
-     *
-     * Default value is `"clear"`.
-     */
-    clearButtonTitle?: string;
-    /**
-     * Set to `"never"` to hide place/POI type. If set to `"always"` then type is shown for all items.
-     * If set to `"if-needed"` then type is shown only for places/POIs not determined from the icon.
-     *
-     * Default value is `"if-needed"`.
-     */
-    showPlaceType?: ShowPlaceType;
-    /**
-     * Style of the picked result on the map:
-     *
-     * - `"marker-only"` - show only marker at the center of the feature
-     * - `"full-geometry"` - show full feature geometry of the chosen result
-     * - `"full-geometry-including-polygon-center-marker"` - show full feature geometry of the chosen result together with a marker in the center of polygon feature
-     *
-     * Default value is `true`.
-     */
-    pickedResultStyle?: PickedResultStyle;
-    /**
-     * Limit search to specified country(ies).
-     *
-     * Default value is `undefined` - use all countries.
-     */
-    country?: string | string[];
-    /**
-     * Filter of feature types to return.
-     *
-     * Default value is `undefined` - all available feature types are returned.
-     */
-    types?: string[];
-    /**
-     * Use `limit` value for reverse geocoding even if `types` is not an array with a single element.
-     * Will work only if enabled on the server.
-     *
-     * Default value is `false`.
-     */
-    exhaustiveReverseGeocoding?: boolean;
-    /**
-     * If set to `true` then use all types except for those listed in `types`.
-     *
-     * Default value is `false`.
-     */
-    excludeTypes?: boolean;
-    /**
-     * Geocoding API URL.
-     *
-     * Default value is MapTiler Geocoding API URL.
-     */
-    apiUrl?: string;
-    /**
-     * Extra fetch parameters.
-     *
-     * Default value is `undefined`.
-     */
-    fetchParameters?: RequestInit;
-    /**
-     * Base URL for POI icons.
-     *
-     * Default value is `"icons/"` for Svelte apps, otherwise `"https://cdn.maptiler.com/maptiler-geocoding-control/v${version}/icons/"`.
-     */
-    iconsBaseUrl?: string;
-    /**
-     * Function to adjust URL search parameters.
-     *
-     * Default value is empty function.
-     *
-     * @deprecated use `adjustUrl`
-     */
-    adjustUrlQuery?: (sp: URLSearchParams) => void;
-    /**
-     * Function to adjust geocoding URL before the fetch.
-     *
-     * @param url [URL](https://developer.mozilla.org/en-US/docs/Web/API/URL) parameter which can be modified
-     *
-     * Default value is empty function.
-     */
-    adjustUrl?: (url: URL) => void;
-    /**
-     * Automatically select the first feature from the result list.
-     *
-     * Default value is `true`.
-     */
-    selectFirst?: boolean;
-    /**
-     * Fly to selected feature from the result list.
-     *
-     * Default value is `false`.
-     */
-    flyToSelected?: boolean;
-    /**
-     * Show marker on the selected feature from the result list.
-     *
-     * Default value is `true`.
-     */
-    markerOnSelected?: boolean;
-};
-export type PickedResultStyle = "marker-only" | "full-geometry" | "full-geometry-including-polygon-center-marker";
-export type EnableReverse = "never" | "always" | "button";
-export type ShowPlaceType = "never" | "always" | "if-needed";
-export type DispatcherTypeCC = {
-    featuresListed: {
-        features: Feature[] | undefined;
-    };
-    featuresMarked: {
-        features: Feature[] | undefined;
-    };
-    optionsVisibilityChange: {
-        optionsVisible: boolean;
-    };
-    pick: {
-        feature: Feature | undefined;
-    };
-    queryChange: {
-        query: string;
-    };
-    response: {
-        url: string;
-        featureCollection: FeatureCollection;
-    };
-    reverseToggle: {
-        reverse: boolean;
-    };
-    select: {
-        feature: Feature | undefined;
-    };
-};
-export type DispatcherType = {
-    [T in keyof DispatcherTypeCC as Lowercase<T>]: DispatcherTypeCC[T];
-};
-export type RedefineType<OriginalType, UpdatedType extends {
-    [K in keyof OriginalType]: OriginalType[K];
-} & {
-    [K in Exclude<keyof UpdatedType, keyof OriginalType>]: never;
-}> = UpdatedType;