@types/mapbox__mapbox-sdk 0.13.3 → 0.13.5

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: Thu, 07 Apr 2022 05:31:19 GMT
+ * Last updated: Sat, 02 Sep 2023 13:03:02 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)
  * Global values: none
 

mapbox__mapbox-sdk/index.d.ts

@@ -11,7 +11,7 @@
 /// <reference types="node" />
 
 declare module '@mapbox/mapbox-sdk/lib/classes/mapi-client' {
-    import { MapiRequest, MapiRequestOptions, DirectionsApproach } from '@mapbox/mapbox-sdk/lib/classes/mapi-request';
+    import { MapiRequest, MapiRequestOptions } from '@mapbox/mapbox-sdk/lib/classes/mapi-request';
     export default class MapiClient {
         constructor(config: SdkConfig);
         accessToken: string;
@@ -30,9 +30,9 @@ declare module '@mapbox/mapbox-sdk/lib/classes/mapi-request' {
     import MapiClient from '@mapbox/mapbox-sdk/lib/classes/mapi-client';
     import { MapiError } from '@mapbox/mapbox-sdk/lib/classes/mapi-error';
 
-    interface EventEmitter {
-        response: MapiResponse;
-        error: MapiError;
+    interface EventEmitter<T> {
+        response: MapiResponse<T>;
+        error: MapiError<T>;
         downloadProgress: ProgressEvent;
         uploadProgress: ProgressEvent;
     }
@@ -80,11 +80,11 @@ declare module '@mapbox/mapbox-sdk/lib/classes/mapi-request' {
         sendFileAs: 'data' | 'form';
     }
 
-    type MapiRequest = MapiRequestOptions & {
+    type MapiRequest<T = any> = MapiRequestOptions & {
         /**
          * An event emitter.
          */
-        emitter: EventEmitter;
+        emitter: EventEmitter<T>;
         /**
          * This request's MapiClient.
          */
@@ -92,11 +92,11 @@ declare module '@mapbox/mapbox-sdk/lib/classes/mapi-request' {
         /**
          * If this request has been sent and received a response, the response is available on this property.
          */
-        response?: MapiResponse | undefined;
+        response?: MapiResponse<T> | undefined;
         /**
          * If this request has been sent and received an error in response, the error is available on this property.
          */
-        error?: MapiError | Error | undefined;
+        error?: MapiError<T> | Error | undefined;
         /**
          * If the request has been aborted (via abort), this property will be true.
          */
@@ -108,15 +108,15 @@ declare module '@mapbox/mapbox-sdk/lib/classes/mapi-request' {
          */
         sent: boolean;
         url(accessToken?: string): string;
-        send(): Promise<MapiResponse>;
+        send(): Promise<MapiResponse<T>>;
         abort(): void;
-        eachPage(callback: PageCallbackFunction): void;
-        clone(): MapiRequest;
+        eachPage(callback: PageCallbackFunction<T>): void;
+        clone(): MapiRequest<T>;
     };
 
-    interface PageCallbackFunction {
-        error: MapiError;
-        response: MapiResponse;
+    interface PageCallbackFunction<T> {
+        error: MapiError<T>;
+        response: MapiResponse<T>;
         next: () => void;
     }
 
@@ -130,11 +130,11 @@ declare module '@mapbox/mapbox-sdk/lib/classes/mapi-request' {
 declare module '@mapbox/mapbox-sdk/lib/classes/mapi-response' {
     import { MapiRequest } from '@mapbox/mapbox-sdk/lib/classes/mapi-request';
 
-    interface MapiResponse {
+    interface MapiResponse<T = any> {
         /**
          * The response body, parsed as JSON.
          */
-        body: any;
+        body: T;
         /**
          * The raw response body.
          */
@@ -154,20 +154,20 @@ declare module '@mapbox/mapbox-sdk/lib/classes/mapi-response' {
         /**
          * The response's originating MapiRequest.
          */
-        request: MapiRequest;
+        request: MapiRequest<T>;
         hasNextPage(): boolean;
-        nextPage(): MapiRequest | null;
+        nextPage(): MapiRequest<T> | null;
     }
 }
 
 declare module '@mapbox/mapbox-sdk/lib/classes/mapi-error' {
     import { MapiRequest } from '@mapbox/mapbox-sdk/lib/classes/mapi-request';
 
-    interface MapiError {
+    interface MapiError<T = any> {
         /**
          * The errored request.
          */
-        request: MapiRequest;
+        request: MapiRequest<T>;
         /**
          * The type of error. Usually this is 'HttpError'.
          * If the request was aborted, so the error was not sent from the server, the type will be 'RequestAbortedError'.
@@ -180,7 +180,7 @@ declare module '@mapbox/mapbox-sdk/lib/classes/mapi-error' {
         /**
          * If the server sent a response body, this property exposes that response, parsed as JSON if possible.
          */
-        body?: any;
+        body?: T;
         /**
          * Whatever message could be derived from the call site and HTTP response.
          */
@@ -312,7 +312,8 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
     export default function Directions(config: SdkConfig | MapiClient): DirectionsService;
 
     interface DirectionsService {
-        getDirections(request: DirectionsRequest): MapiRequest;
+        getDirections(request: DirectionsRequest | DirectionsRequest<'polyline' | 'polyline6'>): MapiRequest<DirectionsResponse>;
+        getDirections(request: DirectionsRequest<'geojson'>): MapiRequest<DirectionsResponse<GeoJSON.MultiLineString | GeoJSON.LineString>>;
     }
 
     type DirectionsAnnotation = 'duration' | 'distance' | 'speed' | 'congestion';
@@ -350,8 +351,10 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
         | 'notification'
         | 'exit roundabout'
         | 'exit rotary';
+    type Polyline = string;
+    type RouteGeometry = GeoJSON.LineString | GeoJSON.MultiLineString | Polyline;
 
-    interface CommonDirectionsRequest {
+    interface CommonDirectionsRequest<T extends DirectionsGeometry = 'polyline'> {
         waypoints: DirectionsWaypoint[];
         /**
          * Whether to try to return alternative routes. An alternative is classified as a route that is significantly
@@ -382,7 +385,7 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
          * Format of the returned geometry. Allowed values are:  geojson (as LineString ),
          * polyline with precision 5,  polyline6 (a polyline with precision 6). The default value is  polyline .
          */
-        geometries?: DirectionsGeometry | undefined;
+        geometries?: T;
         /**
          * Language of returned turn-by-turn text instructions. See supported languages . The default is  en for English.
          */
@@ -426,7 +429,7 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
               exclude?: Array<'ferry' | 'toll' | 'motorway'> | undefined;
           };
 
-    type DirectionsRequest = CommonDirectionsRequest & DirectionsProfileExclusion;
+    type DirectionsRequest<T extends DirectionsGeometry = "polyline"> = CommonDirectionsRequest<T> & DirectionsProfileExclusion;
 
     interface Waypoint {
         /**
@@ -464,11 +467,11 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
         waypointName?: string | undefined;
     };
 
-    interface DirectionsResponse {
+    interface DirectionsResponse<T extends RouteGeometry = Polyline> {
         /**
          * Array of Route objects ordered by descending recommendation rank. May contain at most two routes.
          */
-        routes: Route[];
+        routes: Array<Route<T>>;
         /**
          * Array of Waypoint objects. Each waypoints is an input coordinate snapped to the road and path network.
          * The waypoints appear in the array in the order of the input coordinates.
@@ -482,13 +485,13 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
         uuid: string;
     }
 
-    interface Route {
+    interface Route<T extends RouteGeometry> {
         /**
          * Depending on the geometries parameter this is a GeoJSON LineString or a Polyline string.
          * Depending on the overview parameter this is the complete route geometry (full), a simplified geometry
          * to the zoom level at which the route can be displayed in full (simplified), or is not included (false)
          */
-        geometry: GeoJSON.LineString | GeoJSON.MultiLineString;
+        geometry: T;
         /**
          * Array of RouteLeg objects.
          */
@@ -804,7 +807,6 @@ declare module '@mapbox/mapbox-sdk/services/directions' {
 declare module '@mapbox/mapbox-sdk/services/geocoding' {
     import { LngLatLike } from 'mapbox-gl';
     import { MapiRequest, Coordinates } from '@mapbox/mapbox-sdk/lib/classes/mapi-request';
-    import { MapiResponse } from '@mapbox/mapbox-sdk/lib/classes/mapi-response';
     import MapiClient, { SdkConfig } from '@mapbox/mapbox-sdk/lib/classes/mapi-client';
 
     /*********************************************************************************************************************
@@ -814,8 +816,8 @@ declare module '@mapbox/mapbox-sdk/services/geocoding' {
     export default function Geocoding(config: SdkConfig | MapiClient): GeocodeService;
 
     interface GeocodeService {
-        forwardGeocode(request: GeocodeRequest): MapiRequest;
-        reverseGeocode(request: GeocodeRequest): MapiRequest;
+        forwardGeocode(request: GeocodeRequest): MapiRequest<GeocodeResponse>;
+        reverseGeocode(request: GeocodeRequest): MapiRequest<GeocodeResponse>;
     }
 
     type BoundingBox = [number, number, number, number];
@@ -883,7 +885,7 @@ declare module '@mapbox/mapbox-sdk/services/geocoding' {
         /**
          * "Feature Collection" , a GeoJSON type from the GeoJSON specification.
          */
-        type: string;
+        type: "FeatureCollection";
         /**
          * An array of space and punctuation-separated strings from the original query.
          */
@@ -905,9 +907,9 @@ declare module '@mapbox/mapbox-sdk/services/geocoding' {
          */
         id: string;
         /**
-         * "Feature" , a GeoJSON type from the GeoJSON specification.
+         * "Feature", a GeoJSON type from the GeoJSON specification.
          */
-        type: string;
+        type: "Feature";
         /**
          * An array of feature types describing the feature. Options are  country ,  region ,  postcode ,  district ,  place , locality ,  neighborhood ,
          * address ,  poi , and  poi.landmark . Most features have only one type, but if the feature has multiple types,
@@ -933,6 +935,10 @@ declare module '@mapbox/mapbox-sdk/services/geocoding' {
          * A string representing the feature in the requested language, if specified.
          */
         text: string;
+        /**
+         * The ISO 3166-1 country and ISO 3166-2 region code for the feature.
+         */
+        short_code?: string;
         /**
          * A string representing the feature in the requested language, if specified, and its full result hierarchy.
          */
@@ -977,7 +983,7 @@ declare module '@mapbox/mapbox-sdk/services/geocoding' {
         /**
          * Point, a GeoJSON type from the GeoJSON specification .
          */
-        type: string;
+        type: "Point";
         /**
          * An array in the format [ longitude,latitude ] at the center of the specified  bbox .
          */
@@ -1018,7 +1024,6 @@ declare module '@mapbox/mapbox-sdk/services/geocoding' {
 }
 
 declare module '@mapbox/mapbox-sdk/services/map-matching' {
-    import { LngLatLike } from 'mapbox-gl';
     import {
         DirectionsAnnotation,
         DirectionsGeometry,
@@ -1039,7 +1044,7 @@ declare module '@mapbox/mapbox-sdk/services/map-matching' {
     export default function MapMatching(config: SdkConfig | MapiClient): MapMatchingService;
 
     interface MapMatchingService {
-        getMatch(request: MapMatchingRequest): MapiRequest;
+        getMatch(request: MapMatchingRequest): MapiRequest<MapMatchingResponse>;
     }
 
     interface MapMatchingRequest {
@@ -1170,7 +1175,7 @@ declare module '@mapbox/mapbox-sdk/services/matrix' {
          * Get a duration and/or distance matrix showing travel times and distances between coordinates.
          * @param request
          */
-        getMatrix(request: MatrixRequest): MapiRequest;
+        getMatrix(request: MatrixRequest): MapiRequest<MatrixResponse>;
     }
 
     interface MatrixRequest {
@@ -1198,7 +1203,6 @@ declare module '@mapbox/mapbox-sdk/services/matrix' {
 declare module '@mapbox/mapbox-sdk/services/optimization' {
     import { Waypoint } from '@mapbox/mapbox-sdk/services/directions';
     import { MapiRequest, MapboxProfile, DirectionsApproach } from '@mapbox/mapbox-sdk/lib/classes/mapi-request';
-    import { MapiResponse } from '@mapbox/mapbox-sdk/lib/classes/mapi-response';
     import MapiClient, { SdkConfig } from '@mapbox/mapbox-sdk/lib/classes/mapi-client';
 
     /*********************************************************************************************************************
@@ -1650,7 +1654,6 @@ declare module '@mapbox/mapbox-sdk/services/tilesets' {
 
 declare module '@mapbox/mapbox-sdk/services/tokens' {
     import { MapiRequest } from '@mapbox/mapbox-sdk/lib/classes/mapi-request';
-    import { MapiResponse } from '@mapbox/mapbox-sdk/lib/classes/mapi-response';
     import MapiClient, { SdkConfig } from '@mapbox/mapbox-sdk/lib/classes/mapi-client';
 
     /*********************************************************************************************************************

mapbox__mapbox-sdk/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/mapbox__mapbox-sdk",
-    "version": "0.13.3",
+    "version": "0.13.5",
     "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": "a187dca402af20e5fc089bc696726b296d07ac88c9b8e7aede7355686c33eee0",
-    "typeScriptVersion": "3.9"
+    "typesPublisherContentHash": "375dc71b596496627d740e0ee597d465d6b1ce20c159fe612b97ef15fb32b557",
+    "typeScriptVersion": "4.3"
 }