@types/mapbox__mapbox-sdk 0.13.10 → 0.14.0

mapbox__mapbox-sdk/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for @mapbox/mapbox-sdk (https://github.co
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mapbox__mapbox-sdk.
 
 ### Additional Details
- * Last updated: Fri, 17 Nov 2023 02:17:33 GMT
+ * Last updated: Thu, 04 Jan 2024 06:36:13 GMT
  * Dependencies: [@types/geojson](https://npmjs.com/package/@types/geojson), [@types/mapbox-gl](https://npmjs.com/package/@types/mapbox-gl), [@types/node](https://npmjs.com/package/@types/node)
 
 # Credits

mapbox__mapbox-sdk/index.d.ts

@@ -865,6 +865,368 @@ declare module "@mapbox/mapbox-sdk/services/directions" {
     }
 }
 
+// eslint-disable-next-line @definitelytyped/no-declare-current-package
+declare module "@mapbox/mapbox-sdk/services/geocoding-v6" {
+    // eslint-disable-next-line @definitelytyped/no-self-import
+    import { Coordinates as MapiRequestCoordinates, MapiRequest } from "@mapbox/mapbox-sdk/lib/classes/mapi-request";
+    // eslint-disable-next-line @definitelytyped/no-self-import
+    import MapiClient, { SdkConfig } from "@mapbox/mapbox-sdk/lib/classes/mapi-client";
+
+    /*********************************************************************************************************************
+     * Geocoder Types for v6 API
+     *********************************************************************************************************************/
+
+    export default function GeocodingV6(config: SdkConfig | MapiClient): GeocodeService;
+
+    interface GeocodeService {
+        forwardGeocode(request: ForwardGeocodeRequest): MapiRequest<GeocodeResponse>;
+        reverseGeocode(request: ReverseGeocodeRequest): MapiRequest<GeocodeResponse>;
+    }
+
+    type BoundingBox = [number, number, number, number];
+
+    type GeocodeMode = "standard" | "structured";
+
+    type GeocodeQueryType =
+        | "address"
+        | "country"
+        | "district"
+        | "locality"
+        | "neighborhood"
+        | "place"
+        | "postcode"
+        | "region"
+        | "street";
+
+    interface GeocodeV6Request {
+        /**
+         * Either `standard` for common forward geocoding, or `structured` for
+         * increasing the accuracy of results. To use Structured Input, the
+         * query parameter must be dropped in favor of a separate parameter for
+         * individual feature components. Defaults to `standard`.
+         */
+        mode?: GeocodeMode;
+        /**
+         * Limits results to the specified countries. Each item in the array
+         * should be an ISO 3166 alpha 2 country code. [OR] if used with input
+         * mode="structured" denotes single country in free form.
+         */
+        countries?: string[] | string;
+        /**
+         * Bias local results based on a provided coordinate location or a
+         * user's IP address.
+         */
+        proximity?: Coordinates | "ip";
+        /**
+         * Filter results by feature types.
+         */
+        types?: GeocodeQueryType[];
+        /**
+         * Specify the desired response format of results (geojson, default) or
+         * for backwards compatibility (v5).
+         */
+        format?: "geojson" | "v5";
+        /**
+         * Specify the language to use for response text and, for forward
+         * geocoding, query result weighting.
+         */
+        language?: string;
+        /**
+         * Limit the number of results returned. The default is 5 for forward
+         */
+        limit?: number;
+        /**
+         * Filter results to geographic features whose characteristics are
+         * defined differently by audiences belonging to various regional,
+         * cultural, or political groups. Defaults to "us".
+         */
+        worldview?: string;
+        /**
+         * Return autocomplete results or not. Defaults to true.
+         */
+        autocomplete?: boolean;
+        /**
+         * Specify whether you intend to store the results of the query (true)
+         * or not (false, default). Temporary results are not allowed to be
+         * cached, while Permanent results are allowed to be cached and stored
+         * indefinitely. Defaults to false.
+         */
+        permanent?: boolean;
+    }
+
+    interface BaseForwardGeocodeRequest extends GeocodeV6Request {
+        /**
+         * Limit results to a bounding box.
+         */
+        bbox?: BoundingBox;
+    }
+
+    interface ReverseGeocodeRequest extends GeocodeV6Request {
+        /**
+         * longitude coordinate at which features will be searched.
+         */
+        longitude: number;
+        /**
+         * latitude coordinate at which features will be searched.
+         */
+        latitude: number;
+        countries?: string[];
+    }
+
+    interface StructuredGeocodeRequest extends BaseForwardGeocodeRequest {
+        mode: Extract<GeocodeMode, "structured">;
+        countries?: string;
+        /**
+         * A string including address_number and street. These values can
+         * alternatively be provided as separate parameters. (Structured Input
+         * specific field)
+         */
+        address_line1?: string;
+        /**
+         * The number associated with the house (Structured Input specific
+         * field)
+         */
+        address_number?: string;
+        /**
+         * The name of the street in the address (Structured Input specific
+         * field)
+         */
+        street?: string;
+        /**
+         * In some countries like Japan, the block is a component in the address
+         * (Structured Input specific field)
+         */
+        block?: string;
+        /**
+         * Typically these are cities, villages, municipalities, etc.
+         * (Structured Input specific field)
+         */
+        place?: string;
+        /**
+         * Top-level sub-national administrative features, such as states in the
+         * United States or provinces in Canada or China. (Structured Input
+         * specific field)
+         */
+        region?: string;
+        /**
+         * Colloquial sub-city features often referred to in local parlance
+         * (Structured Input specific field)
+         */
+        neighborhood?: string;
+        /**
+         * Postal codes used in country-specific national addressing systems.
+         * (Structured Input specific field)
+         */
+        postcode?: string;
+        /**
+         * Official sub-city features (Structured Input specific field)
+         */
+        locality?: string;
+    }
+
+    interface StandardGeocodeRequest extends BaseForwardGeocodeRequest {
+        /**
+         * A place name.
+         */
+        query: string;
+        mode?: Extract<GeocodeMode, "standard">;
+        countries?: string[];
+    }
+
+    type ForwardGeocodeRequest = StructuredGeocodeRequest | StandardGeocodeRequest;
+
+    interface GeocodeResponse {
+        /**
+         * "FeatureCollection", a GeoJSON type from the GeoJSON specification.
+         */
+        type: string;
+        /**
+         * An array of feature objects.
+         */
+        features: Feature[];
+        /**
+         * Attributes the results of the Mapbox Geocoding API to Mapbox.
+         */
+        attribution: string;
+    }
+
+    interface Feature {
+        /**
+         * Feature id. This property is named "id" to conform to the GeoJSON
+         * specification, but is the same id referred to as mapbox_id elsewhere
+         * in the response.
+         */
+        id: string;
+        /**
+         * "Feature", a GeoJSON type from the GeoJSON specification.
+         */
+        type: string;
+        /**
+         * An object describing the spatial geometry of the returned feature.
+         */
+        geometry: Geometry;
+        /**
+         * An object containing the resulting feature's details.
+         */
+        properties: Properties;
+    }
+
+    interface Geometry {
+        /**
+         * "Point", a GeoJSON type from the GeoJSON specification.
+         */
+        type: string;
+        /**
+         * An array in the format [longitude,latitude] at the center of the
+         * specified bbox.
+         */
+        coordinates: MapiRequestCoordinates;
+    }
+
+    interface Properties extends NamedLocation {
+        /**
+         * A string describing the type of the feature. Options are country,
+         * region, postcode, district, place, locality, neighborhood, street,
+         * address. Formerly place_type in v5.
+         */
+        feature_type: string;
+        /**
+         * The coordinates of the properties.
+         */
+        coordinates: Coordinates;
+        /**
+         * An array of additional feature types.
+         */
+        additional_feature_types: string[];
+        /**
+         * The bounding box of the feature in minLon,minLat,maxLon,maxLat order.
+         * This property is only provided with features of type country, region,
+         * postcode, district, place, locality, or neighborhood.
+         */
+        bbox: number[];
+        /**
+         * An object representing the hierarchy of encompassing parent features.
+         * This may include a sub-object for any of the following properties:
+         * country, region, postcode, district, place, locality, neighborhood,
+         * street.
+         *
+         * Which sub-objects are included is dependent upon the data coverage
+         * available and applicable to a given country or area.
+         */
+        context: Context;
+    }
+
+    interface Coordinates {
+        /**
+         * The longitude coordinate.
+         */
+        longitude: number;
+        /**
+         * The latitude coordinate.
+         */
+        latitude: number;
+        /**
+         * Accuracy metric for a returned address-type result. See "Point
+         * accuracy for address features" below.
+         */
+        accuracy?: string;
+    }
+
+    interface Context {
+        /**
+         * The region information of the context.
+         */
+        region?: Region;
+        /**
+         * The country information of the context.
+         */
+        country?: Country;
+        /**
+         * The place information of the context.
+         */
+        place?: Place;
+        /**
+         * The locality information of the context.
+         */
+        locality?: Locality;
+        /**
+         * The district information of the context.
+         */
+        district?: District;
+        /**
+         * The postcode information of the context.
+         */
+        postcode?: Postcode;
+    }
+
+    interface Region extends NamedLocation {
+        /**
+         * The full region code of the region.
+         */
+        region_code_full?: string;
+        /**
+         * The region code of the region.
+         */
+        region_code?: string;
+    }
+
+    interface Country extends NamedLocation {
+        /**
+         * The country code of the country.
+         */
+        country_code?: string;
+        /**
+         * The alpha-3 country code of the country.
+         */
+        country_code_alpha_3?: string;
+    }
+
+    interface Place extends IdentifiableLocation {
+        /**
+         * The short code of the place.
+         */
+        short_code?: string;
+    }
+
+    type Locality = IdentifiableLocation;
+
+    type District = IdentifiableLocation;
+
+    interface IdentifiableLocation extends NamedLocation {
+        /**
+         * The Wikidata ID of the identifiable location.
+         */
+        wikidata_id: string;
+    }
+
+    type Postcode = NamedLocation;
+
+    interface NamedLocation {
+        /**
+         * Feature id. The mapbox_id uniquely identifies a place in the Mapbox
+         * search database. Mapbox ID’s are accepted in requests to the
+         * Geocoding API as a forward search, and will return the feature
+         * corresponding to that id.
+         */
+        mapbox_id: string;
+        /**
+         * Formatted string of address_number and street.
+         */
+        name: string;
+        /**
+         *  Present when there is a canonical or otherwise more common alias for
+         *  the feature name. For example, searching for "America" will return
+         *  "America" as the name, and "United States" as name_preferred.
+         */
+        name_preferred?: string;
+        /**
+         *  Formatted string of result context: place region country postcode.
+         *  The part of the result which comes after name.
+         */
+        place_formatted?: string;
+    }
+}
+
 // eslint-disable-next-line @definitelytyped/no-declare-current-package
 declare module "@mapbox/mapbox-sdk/services/geocoding" {
     import { LngLatLike } from "mapbox-gl";
@@ -914,9 +1276,9 @@ declare module "@mapbox/mapbox-sdk/services/geocoding" {
          */
         countries?: string[] | undefined;
         /**
-         * Bias local results based on a provided location. Options are  longitude,latitude coordinates.
+         * Bias local results based on a provided location. Options are longitude,latitude coordinates or the user's ip.
          */
-        proximity?: Coordinates | undefined;
+        proximity?: Coordinates | "ip" | undefined;
         /**
          * Filter results by one or more feature types
          */

mapbox__mapbox-sdk/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/mapbox__mapbox-sdk",
-    "version": "0.13.10",
+    "version": "0.14.0",
     "description": "TypeScript definitions for @mapbox/mapbox-sdk",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mapbox__mapbox-sdk",
     "license": "MIT",
@@ -44,6 +44,6 @@
         "@types/mapbox-gl": "*",
         "@types/node": "*"
     },
-    "typesPublisherContentHash": "6f6df6168f7982d9d12475050b13e7de5c956d4802cafddb2f2db75d8b66b8f4",
-    "typeScriptVersion": "4.5"
+    "typesPublisherContentHash": "adf26329686e9e88629db4282009bb3236765e927dd2482e2c9956372b390aef",
+    "typeScriptVersion": "4.6"
 }