🤖 Merge PR DefinitelyTyped#72659 feat(mapbox__mapbox-sdk): refine TileQueryService.listFeatures() return by @hkleungai

Author: hkleungai

types/mapbox__mapbox-sdk/index.d.ts

@@ -198,6 +198,7 @@ declare module "@mapbox/mapbox-sdk/lib/classes/mapi-error" {
 
 // eslint-disable-next-line @definitelytyped/no-declare-current-package
 declare module "@mapbox/mapbox-sdk/services/datasets" {
+    import * as GeoJSON from "geojson";
     // eslint-disable-next-line @definitelytyped/no-self-import
     import { MapiRequest } from "@mapbox/mapbox-sdk/lib/classes/mapi-request";
     // eslint-disable-next-line @definitelytyped/no-self-import
@@ -1844,6 +1845,7 @@ declare module "@mapbox/mapbox-sdk/services/optimization" {
 
 // eslint-disable-next-line @definitelytyped/no-declare-current-package
 declare module "@mapbox/mapbox-sdk/services/static" {
+    import * as GeoJSON from "geojson";
     import { AnyLayer, LngLatBoundsLike, LngLatLike } from "mapbox-gl";
     // eslint-disable-next-line @definitelytyped/no-self-import
     import { MapiRequest } from "@mapbox/mapbox-sdk/lib/classes/mapi-request";
@@ -2107,6 +2109,7 @@ declare module "@mapbox/mapbox-sdk/services/styles" {
 
 // eslint-disable-next-line @definitelytyped/no-declare-current-package
 declare module "@mapbox/mapbox-sdk/services/tilequery" {
+    import * as GeoJSON from "geojson";
     // eslint-disable-next-line @definitelytyped/no-self-import
     import { Coordinates, MapiRequest } from "@mapbox/mapbox-sdk/lib/classes/mapi-request";
     // eslint-disable-next-line @definitelytyped/no-self-import
@@ -2122,7 +2125,9 @@ declare module "@mapbox/mapbox-sdk/services/tilequery" {
          * Get a static map image..
          * @param request
          */
-        listFeatures(request: TileQueryRequest): MapiRequest;
+        listFeatures(
+            request: TileQueryRequest,
+        ): MapiRequest<GeoJSON.FeatureCollection<GeoJSON.Point, TileQueryResponseProperty>>;
     }
 
     interface TileQueryRequest {
@@ -2150,7 +2155,27 @@ declare module "@mapbox/mapbox-sdk/services/tilequery" {
          * Queries for a specific geometry type.
          */
         geometry?: GeometryType | undefined;
-        layers?: string[] | undefined;
+        /**
+         * A comma-separated list of bands to query, rather than querying all bands.
+         * If a specified layer does not exist, it is skipped.
+         * If no bands exist, returns an empty `FeatureCollection`.
+         */
+        bands?: string | undefined;
+        /**
+         * A comma-separated list of layers to query, rather than querying all layers.
+         * If a specified layer does not exist, it is skipped.
+         * If no layers exist, returns an empty `FeatureCollection`.
+         */
+        layers?: string | undefined;
+    }
+
+    interface TileQueryResponseProperty {
+        tilequery: {
+            distance: number;
+            geometry: GeometryType;
+            layer: string;
+        };
+        [name: string]: any;
     }
 
     type GeometryType = "polygon" | "linestring" | "point";

types/mapbox__mapbox-sdk/mapbox__mapbox-sdk-tests.ts

@@ -1,5 +1,5 @@
 import mbxClient from "@mapbox/mapbox-sdk";
-import { SdkConfig } from "@mapbox/mapbox-sdk/lib/classes/mapi-client";
+import MapiClient, { SdkConfig } from "@mapbox/mapbox-sdk/lib/classes/mapi-client";
 import { MapiRequest } from "@mapbox/mapbox-sdk/lib/classes/mapi-request";
 import { MapiResponse } from "@mapbox/mapbox-sdk/lib/classes/mapi-response";
 import Directions, { DirectionsService } from "@mapbox/mapbox-sdk/services/directions";
@@ -10,6 +10,12 @@ import MapMatching, { MapMatchingResponse, MapMatchingService } from "@mapbox/ma
 import Optimization, { OptimizationService } from "@mapbox/mapbox-sdk/services/optimization";
 import StaticMap, { StaticMapService } from "@mapbox/mapbox-sdk/services/static";
 import Styles, { StylesService } from "@mapbox/mapbox-sdk/services/styles";
+import TileQuery, {
+    GeometryType,
+    TileQueryRequest,
+    TileQueryResponseProperty,
+    TileQueryService,
+} from "@mapbox/mapbox-sdk/services/tilequery";
 import { LineString } from "geojson";
 
 const config: SdkConfig = {
@@ -332,3 +338,76 @@ optimizationService.getOptimization({
     roundtrip: true,
     steps: true,
 });
+
+{
+    let tileQueryService: TileQueryService;
+    tileQueryService = TileQuery({ accessToken: "" } satisfies SdkConfig);
+    tileQueryService = TileQuery(new MapiClient({ accessToken: "" }));
+
+    // Required request params
+    let mapiRequest = tileQueryService.listFeatures(
+        {
+            mapIds: ["id"],
+            coordinates: [2, 3],
+        } satisfies TileQueryRequest,
+    );
+
+    // Optional request params
+    mapiRequest = tileQueryService.listFeatures(
+        {
+            mapIds: ["id"],
+            coordinates: [2, 3],
+            radius: 0,
+            limit: 5,
+            dedupe: true,
+            bands: "band1,band2",
+            layers: "layer1,layer2",
+        } satisfies TileQueryRequest,
+    );
+
+    // Optional Geometry params
+    mapiRequest = tileQueryService.listFeatures(
+        {
+            mapIds: ["id"],
+            coordinates: [2, 3],
+            geometry: "linestring" satisfies GeometryType,
+        } satisfies TileQueryRequest,
+    );
+    mapiRequest = tileQueryService.listFeatures(
+        {
+            mapIds: ["id"],
+            coordinates: [2, 3],
+            geometry: "point" satisfies GeometryType,
+        } satisfies TileQueryRequest,
+    );
+    mapiRequest = tileQueryService.listFeatures(
+        {
+            mapIds: ["id"],
+            coordinates: [2, 3],
+            geometry: "polygon" satisfies GeometryType,
+        } satisfies TileQueryRequest,
+    );
+
+    const featureCollection = mapiRequest.response!.body;
+    // $ExpectType "FeatureCollection"
+    featureCollection.type;
+
+    const [feature] = featureCollection.features;
+    // $ExpectType "Feature"
+    feature.type;
+    // $ExpectType string | number | undefined
+    feature.id;
+
+    // $ExpectType "Point"
+    feature.geometry.type;
+    // $ExpectType Position
+    feature.geometry.coordinates;
+
+    feature.properties satisfies TileQueryResponseProperty;
+    // $ExpectType number
+    feature.properties.tilequery.distance;
+    // $ExpectType GeometryType
+    feature.properties.tilequery.geometry;
+    // $ExpectType string
+    feature.properties.tilequery.layer;
+}