@types/mapbox__mapbox-sdk 0.14.0 → 0.15.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: Thu, 04 Jan 2024 06:36:13 GMT
+ * Last updated: Fri, 12 Jul 2024 21:35:59 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

@@ -1,5 +1,13 @@
 /// <reference types="node" />
 
+// eslint-disable-next-line @definitelytyped/no-declare-current-package
+declare module "@mapbox/mapbox-sdk" {
+    // eslint-disable-next-line @definitelytyped/no-self-import
+    import MapiClient, { SdkConfig } from "@mapbox/mapbox-sdk/lib/classes/mapi-client";
+
+    export default function createNodeClient(config: SdkConfig): MapiClient;
+}
+
 // eslint-disable-next-line @definitelytyped/no-declare-current-package
 declare module "@mapbox/mapbox-sdk/lib/classes/mapi-client" {
     // eslint-disable-next-line @definitelytyped/no-self-import
@@ -1227,6 +1235,100 @@ declare module "@mapbox/mapbox-sdk/services/geocoding-v6" {
     }
 }
 
+// eslint-disable-next-line @definitelytyped/no-declare-current-package
+declare module "@mapbox/mapbox-sdk/services/isochrone" {
+    import * as GeoJSON from "geojson";
+    // eslint-disable-next-line @definitelytyped/no-self-import
+    import MapiClient, { SdkConfig } from "@mapbox/mapbox-sdk/lib/classes/mapi-client";
+    // eslint-disable-next-line @definitelytyped/no-self-import
+    import { MapiRequest } from "@mapbox/mapbox-sdk/lib/classes/mapi-request";
+
+    export default function Isochrone(config: SdkConfig | MapiClient): IsochroneService;
+
+    interface IsochroneService {
+        getContours(
+            request: IsochroneRequest<false | undefined>,
+        ): MapiRequest<GeoJSON.FeatureCollection<GeoJSON.LineString>>;
+        getContours(
+            request: IsochroneRequest<true>,
+        ): MapiRequest<GeoJSON.FeatureCollection<GeoJSON.Polygon>>;
+    }
+
+    interface IsochroneDistance {
+        /**
+         * The times in minutes to use for each isochrone contour. You can specify up to four contours.
+         * Times must be in increasing order. The maximum time that can be specified is 60 minutes.
+         * Setting minutes and meters in the same time is an error.
+         */
+        minutes?: never;
+        /**
+         * The distances in meters to use for each isochrone contour. You can specify up to four contours.
+         * Distances must be in increasing order. The maximum distance that can be specified is
+         * 100000 meters. Setting minutes and meters in the same time is an error.
+         */
+        meters: [number, number?, number?, number?];
+    }
+
+    interface IsochroneTime {
+        /**
+         * The times in minutes to use for each isochrone contour. You can specify up to four contours.
+         * Times must be in increasing order. The maximum time that can be specified is 60 minutes.
+         * Setting minutes and meters in the same time is an error.
+         */
+        minutes: [number, number?, number?, number?];
+        /**
+         * The distances in meters to use for each isochrone contour. You can specify up to four contours.
+         * Distances must be in increasing order. The maximum distance that can be specified is
+         * 100000 meters. Setting minutes and meters in the same time is an error.
+         */
+        meters?: never;
+    }
+
+    type IsochroneRequest<T extends boolean | undefined = false> = (IsochroneDistance | IsochroneTime) & {
+        /**
+         * The colors to use for each isochrone contour, specified as hex values without a leading
+         * `#`(for example, `ff0000` for red). If this parameter is used, there must be the same
+         * number of colors as there are entries in contours_minutes or contours_meters. If no
+         * colors are specified, the Isochrone API will assign a default rainbow color scheme to
+         * the output.
+         */
+        colors?: [string?, string?, string?, string?];
+        /** A {longitude,latitude} coordinate pair around which to center the isochrone lines. */
+        coordinates: [number, number];
+        /**
+         * A floating point value from 0.0 to 1.0 that can be used to remove smaller contours. The
+         * default is 1.0. A value of 1.0 will only return the largest contour for a given time
+         * value. A value of 0.5 drops any contours that are less than half the area of the largest
+         * contour in the set of contours for that same time value.
+         *
+         * @default 1.0
+         */
+        denoise?: number;
+        /**
+         *  A positive floating point value in meters used as the tolerance for Douglas-Peucker
+         * generalization. There is no upper bound. If no value is specified in the request, the
+         * Isochrone API will choose the most optimized generalization to use for the request.
+         * Note that the generalization of contours can lead to self-intersections, as well as
+         * intersections of adjacent contours.
+         */
+        generalize?: number;
+        /**
+         * Specify whether to return the contours as GeoJSON polygons (`true`) or linestrings
+         * (`false`, default). When polygons=`true`, any contour that forms a ring is returned as a
+         * polygon.
+         *
+         * @default false
+         */
+        polygons?: T;
+        /**
+         * A Mapbox Directions routing profile ID.
+         *
+         * @default 'driving'
+         */
+        profile?: "driving" | "driving-traffic" | "walking" | "cycling";
+    };
+}
+
 // eslint-disable-next-line @definitelytyped/no-declare-current-package
 declare module "@mapbox/mapbox-sdk/services/geocoding" {
     import { LngLatLike } from "mapbox-gl";

mapbox__mapbox-sdk/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/mapbox__mapbox-sdk",
-    "version": "0.14.0",
+    "version": "0.15.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": "adf26329686e9e88629db4282009bb3236765e927dd2482e2c9956372b390aef",
-    "typeScriptVersion": "4.6"
+    "typesPublisherContentHash": "b1738034479cde9f36ebab60d799341c061bf5e9a3b97b1002db17d3ac1dcbac",
+    "typeScriptVersion": "4.8"
 }