@carto/api-client 0.5.13 → 0.5.14

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## 0.5
 
+### 0.5.14
+
+- feat(widgets): Add 'getExtent()' method, experimental (#220)
+
+### 0.5.13
+
+- fix(constants): Export RasterBandColorinterp (#216)
+
 ### 0.5.12
 
 - feat(sources): allow passing tags to baseSource and query methods (#193)

package/build/api-client.cjs

@@ -215,11 +215,11 @@ var FilterType = /* @__PURE__ */ ((FilterType2) => {
   FilterType2["STRING_SEARCH"] = "stringSearch";
   return FilterType2;
 })(FilterType || {});
-var ApiVersion = /* @__PURE__ */ ((ApiVersion3) => {
-  ApiVersion3["V1"] = "v1";
-  ApiVersion3["V2"] = "v2";
-  ApiVersion3["V3"] = "v3";
-  return ApiVersion3;
+var ApiVersion = /* @__PURE__ */ ((ApiVersion2) => {
+  ApiVersion2["V1"] = "v1";
+  ApiVersion2["V2"] = "v2";
+  ApiVersion2["V3"] = "v3";
+  return ApiVersion2;
 })(ApiVersion || {});
 var DEFAULT_API_BASE_URL = "https://gcp-us-east1.api.carto.com";
 var TileFormat = /* @__PURE__ */ ((TileFormat2) => {
@@ -6861,6 +6861,48 @@ var WidgetRemoteSource = class extends WidgetSource {
       categories: res.metadata?.categories
     }));
   }
+  /** @experimental */
+  async getExtent(options = {}) {
+    const { signal, filters = this.props.filters, filterOwner } = options;
+    const {
+      type,
+      data,
+      apiBaseUrl,
+      apiVersion,
+      connectionName,
+      spatialDataColumn,
+      spatialDataType,
+      queryParameters
+    } = this.getModelSource(filters, filterOwner);
+    assert2(apiVersion === "v3" /* V3 */, "Stats API requires CARTO 3+");
+    let url;
+    const parameters = { filters, spatialDataType };
+    if (type === "query") {
+      url = `${apiBaseUrl}/${apiVersion}/stats/${connectionName}/${spatialDataColumn}`;
+      parameters.q = data;
+      parameters.queryParameters = queryParameters;
+    } else {
+      url = `${apiBaseUrl}/${apiVersion}/stats/${connectionName}/${data}/${spatialDataColumn}`;
+    }
+    const headers = {
+      Authorization: `Bearer ${this.props.accessToken}`,
+      ...this.props.headers
+    };
+    const errorContext = {
+      requestType: "Tile stats",
+      connection: connectionName,
+      type
+    };
+    return requestWithParameters({
+      baseUrl: url,
+      headers,
+      signal,
+      errorContext,
+      parameters
+    }).then(({ extent: { xmin, ymin, xmax, ymax } }) => ({
+      bbox: [xmin, ymin, xmax, ymax]
+    }));
+  }
 };
 
 // src/widget-sources/widget-query-source.ts
@@ -7839,6 +7881,10 @@ var WidgetTilesetSourceImpl = class extends WidgetSource {
       max: aggregationFunctions.max(filteredFeatures, column)
     };
   }
+  /** @experimental */
+  async getExtent() {
+    return Promise.reject(new Error("not implemented"));
+  }
   /****************************************************************************
    * INTERNAL
    */
@@ -8069,6 +8115,12 @@ var WidgetTilesetSource = class extends WidgetSource {
   }) {
     return this._executeWorkerMethod("getRange" /* GET_RANGE */, [options], signal);
   }
+  /** @experimental */
+  async getExtent() {
+    return Promise.resolve({
+      bbox: this.props.spatialDataBounds
+    });
+  }
 };
 
 // src/widget-sources/widget-raster-source.ts
@@ -8191,7 +8243,8 @@ var h3TilesetSource = async function(options) {
         ...options,
         tileFormat: getTileFormat(result),
         spatialDataColumn,
-        spatialDataType: "h3"
+        spatialDataType: "h3",
+        spatialDataBounds: result.bounds
       })
     })
   );
@@ -8213,6 +8266,7 @@ var rasterSource = async function(options) {
         tileFormat: getTileFormat(result),
         spatialDataColumn: "quadbin",
         spatialDataType: "quadbin",
+        spatialDataBounds: result.bounds,
         rasterMetadata: result.raster_metadata
       })
     })
@@ -8315,7 +8369,8 @@ var quadbinTilesetSource = async function(options) {
         ...options,
         tileFormat: getTileFormat(result),
         spatialDataColumn,
-        spatialDataType: "quadbin"
+        spatialDataType: "quadbin",
+        spatialDataBounds: result.bounds
       })
     })
   );
@@ -8419,7 +8474,8 @@ var vectorTilesetSource = async function(options) {
         ...options,
         tileFormat: getTileFormat(result),
         spatialDataColumn,
-        spatialDataType: "geo"
+        spatialDataType: "geo",
+        spatialDataBounds: result.bounds
       })
     })
   );