@carto/api-client 0.5.30 → 0.5.31-alpha.7cee4d3.120

package/build/api-client.d.cts

@@ -1108,7 +1108,7 @@ type Dataset = {
     name?: string | null;
     spatialIndex?: string | null;
     exportToBucketAvailable?: boolean;
-    featureBbox?: boolean;
+    prepareLabels?: boolean;
 };
 
 type StyleLayerGroupSlug = 'label' | 'road' | 'border' | 'building' | 'water' | 'land';
@@ -1370,7 +1370,7 @@ declare function getFilter<T extends FilterType>(filters: Record<string, Filter>
 declare function getApplicableFilters(owner?: string, filters?: Record<string, Filter>): Record<string, Filter>;
 
 /**
- * Returns a {@link SpatialFilter} for a given viewport, typically obtained
+ * Returns a {@link GeometrySpatialFilter} for a given viewport, typically obtained
  * from deck.gl's `viewport.getBounds()` method ([west, south, east, north]).
  * If the viewport covers the entire world (to some margin of error in Web
  * Mercator space), `undefined` is returned instead.
@@ -1378,14 +1378,14 @@ declare function getApplicableFilters(owner?: string, filters?: Record<string, F
  * If the viewport extends beyond longitude range [-180, +180], the polygon
  * may be reformatted for compatibility with CARTO APIs.
  */
-declare function createViewportSpatialFilter(viewport: BBox): SpatialFilter | undefined;
+declare function createViewportSpatialFilter(viewport: BBox): GeometrySpatialFilter | undefined;
 /**
- * Returns a {@link SpatialFilter} for a given {@link Polygon} or
+ * Returns a {@link GeometrySpatialFilter} for a given {@link Polygon} or
  * {@link MultiPolygon}. If the polygon(s) extend outside longitude
  * range [-180, +180], the result may be reformatted for compatibility
  * with CARTO APIs.
  */
-declare function createPolygonSpatialFilter(spatialFilter: Polygon | MultiPolygon): SpatialFilter | undefined;
+declare function createPolygonSpatialFilter(spatialFilter: Polygon | MultiPolygon): GeometrySpatialFilter | undefined;
 
 /******************************************************************************
  * WIDGET API REQUESTS
@@ -2092,7 +2092,7 @@ type VectorTableSourceOptions = SourceOptions & TableSourceOptions & FilterOptio
      * a `"west,south,east,north"` string in WGS84. Used by clients to compute
      * stable label positions for polygons that span multiple tiles.
      */
-    featureBbox?: boolean;
+    prepareLabels?: boolean;
 };
 type VectorTableSourceResponse = TilejsonResult & WidgetTableSourceResult;
 declare const vectorTableSource: (options: VectorTableSourceOptions) => Promise<VectorTableSourceResponse>;
@@ -2104,7 +2104,7 @@ type VectorQuerySourceOptions = SourceOptions & QuerySourceOptions & FilterOptio
      * a `"west,south,east,north"` string in WGS84. Used by clients to compute
      * stable label positions for polygons that span multiple tiles.
      */
-    featureBbox?: boolean;
+    prepareLabels?: boolean;
 };
 type VectorQuerySourceResponse = TilejsonResult & WidgetQuerySourceResult;
 declare const vectorQuerySource: (options: VectorQuerySourceOptions) => Promise<VectorQuerySourceResponse>;

package/build/api-client.d.ts

@@ -1108,7 +1108,7 @@ type Dataset = {
     name?: string | null;
     spatialIndex?: string | null;
     exportToBucketAvailable?: boolean;
-    featureBbox?: boolean;
+    prepareLabels?: boolean;
 };
 
 type StyleLayerGroupSlug = 'label' | 'road' | 'border' | 'building' | 'water' | 'land';
@@ -1370,7 +1370,7 @@ declare function getFilter<T extends FilterType>(filters: Record<string, Filter>
 declare function getApplicableFilters(owner?: string, filters?: Record<string, Filter>): Record<string, Filter>;
 
 /**
- * Returns a {@link SpatialFilter} for a given viewport, typically obtained
+ * Returns a {@link GeometrySpatialFilter} for a given viewport, typically obtained
  * from deck.gl's `viewport.getBounds()` method ([west, south, east, north]).
  * If the viewport covers the entire world (to some margin of error in Web
  * Mercator space), `undefined` is returned instead.
@@ -1378,14 +1378,14 @@ declare function getApplicableFilters(owner?: string, filters?: Record<string, F
  * If the viewport extends beyond longitude range [-180, +180], the polygon
  * may be reformatted for compatibility with CARTO APIs.
  */
-declare function createViewportSpatialFilter(viewport: BBox): SpatialFilter | undefined;
+declare function createViewportSpatialFilter(viewport: BBox): GeometrySpatialFilter | undefined;
 /**
- * Returns a {@link SpatialFilter} for a given {@link Polygon} or
+ * Returns a {@link GeometrySpatialFilter} for a given {@link Polygon} or
  * {@link MultiPolygon}. If the polygon(s) extend outside longitude
  * range [-180, +180], the result may be reformatted for compatibility
  * with CARTO APIs.
  */
-declare function createPolygonSpatialFilter(spatialFilter: Polygon | MultiPolygon): SpatialFilter | undefined;
+declare function createPolygonSpatialFilter(spatialFilter: Polygon | MultiPolygon): GeometrySpatialFilter | undefined;
 
 /******************************************************************************
  * WIDGET API REQUESTS
@@ -2092,7 +2092,7 @@ type VectorTableSourceOptions = SourceOptions & TableSourceOptions & FilterOptio
      * a `"west,south,east,north"` string in WGS84. Used by clients to compute
      * stable label positions for polygons that span multiple tiles.
      */
-    featureBbox?: boolean;
+    prepareLabels?: boolean;
 };
 type VectorTableSourceResponse = TilejsonResult & WidgetTableSourceResult;
 declare const vectorTableSource: (options: VectorTableSourceOptions) => Promise<VectorTableSourceResponse>;
@@ -2104,7 +2104,7 @@ type VectorQuerySourceOptions = SourceOptions & QuerySourceOptions & FilterOptio
      * a `"west,south,east,north"` string in WGS84. Used by clients to compute
      * stable label positions for polygons that span multiple tiles.
      */
-    featureBbox?: boolean;
+    prepareLabels?: boolean;
 };
 type VectorQuerySourceResponse = TilejsonResult & WidgetQuerySourceResult;
 declare const vectorQuerySource: (options: VectorQuerySourceOptions) => Promise<VectorQuerySourceResponse>;

package/build/api-client.js

@@ -8332,7 +8332,7 @@ var vectorQuerySource = async function(options) {
     tileResolution = DEFAULT_TILE_RESOLUTION,
     queryParameters,
     aggregationExp,
-    featureBbox
+    prepareLabels
   } = options;
   const spatialDataType = "geo";
   const urlParameters = {
@@ -8353,7 +8353,7 @@ var vectorQuerySource = async function(options) {
   if (aggregationExp) {
     urlParameters.aggregationExp = aggregationExp;
   }
-  if (featureBbox) {
+  if (prepareLabels) {
     urlParameters.featureBbox = true;
   }
   return baseSource("query", options, urlParameters).then(
@@ -8379,7 +8379,7 @@ var vectorTableSource = async function(options) {
     tableName,
     tileResolution = DEFAULT_TILE_RESOLUTION,
     aggregationExp,
-    featureBbox
+    prepareLabels
   } = options;
   const spatialDataType = "geo";
   const urlParameters = {
@@ -8397,7 +8397,7 @@ var vectorTableSource = async function(options) {
   if (aggregationExp) {
     urlParameters.aggregationExp = aggregationExp;
   }
-  if (featureBbox) {
+  if (prepareLabels) {
     urlParameters.featureBbox = true;
   }
   return baseSource("table", options, urlParameters).then(
@@ -10963,13 +10963,13 @@ function configureSource({
     tileResolution,
     ...queryParameters && { queryParameters }
   };
-  const { featureBbox } = dataset;
+  const { prepareLabels } = dataset;
   const vectorOptions = {
     spatialDataColumn,
     ...columns && { columns },
     ...filters && { filters },
     ...aggregationExp && { aggregationExp },
-    ...featureBbox && { featureBbox }
+    ...prepareLabels && { prepareLabels }
   };
   if (type === "raster") {
     return rasterSource({
@@ -11265,7 +11265,7 @@ async function fetchMap({
   }
   map.datasets.forEach((dataset) => {
     if (datasetsWithLabels.has(dataset.id) && (dataset.type === "table" || dataset.type === "query")) {
-      dataset.featureBbox = true;
+      dataset.prepareLabels = true;
     }
   });
   const [basemap] = await Promise.all([