@carto/api-client 0.5.28 → 0.5.30-alpha.3cf7d80.116

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+- feat(widgetSources): support `featureIds` / `geometryType` request options to filter widget aggregations by a feature selection without relying on the synthetic `_carto_feature_id` column (#294)
+
+### 0.5.29
+
+- feat(sources): Support featureBbox parameter (#289)
+
 ### 0.5.28
 
 - feat(fetchMap): Support zoom-dependent point styling (#287)

package/build/api-client.cjs

@@ -6590,6 +6590,19 @@ init_cjs_shims();
 var OTHERS_CATEGORY_NAME = "_carto_others";
 
 // src/widget-sources/widget-remote-source.ts
+var FEATURE_IDS_LIMIT = 1e3;
+function getFeatureSelectionParams(options) {
+  const { featureIds, geometryType } = options;
+  if (!featureIds || featureIds.length === 0) {
+    return {};
+  }
+  assert2(geometryType, "geometryType is required when featureIds are provided");
+  assert2(
+    featureIds.length <= FEATURE_IDS_LIMIT,
+    `featureIds is limited to ${FEATURE_IDS_LIMIT} values, received ${featureIds.length}`
+  );
+  return { featureIds, geometryType };
+}
 var WidgetRemoteSource = class extends WidgetSource {
   _getModelSource(filters, filterOwner) {
     const props = this.props;
@@ -6640,7 +6653,8 @@ var WidgetRemoteSource = class extends WidgetSource {
         operationExp,
         operationColumn: operationColumn || column,
         othersThreshold,
-        orderBy
+        orderBy,
+        ...getFeatureSelectionParams(options)
       },
       opts: { signal, headers: this.props.headers }
     });
@@ -6710,7 +6724,8 @@ var WidgetRemoteSource = class extends WidgetSource {
       params: {
         column: column ?? "*",
         operation: operation2 ?? AggregationTypes.Count,
-        operationExp
+        operationExp,
+        ...getFeatureSelectionParams(options)
       },
       opts: { signal, headers: this.props.headers }
     }).then((res) => normalizeObjectKeys(res.rows[0]));
@@ -6732,7 +6747,7 @@ var WidgetRemoteSource = class extends WidgetSource {
         spatialFiltersMode,
         spatialFilter
       },
-      params: { column, operation: operation2, ticks },
+      params: { column, operation: operation2, ticks, ...getFeatureSelectionParams(options) },
       opts: { signal, headers: this.props.headers }
     }).then((res) => normalizeObjectKeys(res.rows));
     if (data.length) {
@@ -6761,7 +6776,7 @@ var WidgetRemoteSource = class extends WidgetSource {
         spatialFiltersMode,
         spatialFilter
       },
-      params: { column },
+      params: { column, ...getFeatureSelectionParams(options) },
       opts: { signal, headers: this.props.headers }
     }).then((res) => normalizeObjectKeys(res.rows[0]));
   }
@@ -6788,7 +6803,8 @@ var WidgetRemoteSource = class extends WidgetSource {
         xAxisJoinOperation,
         yAxisColumn,
         yAxisJoinOperation,
-        limit: HARD_LIMIT
+        limit: HARD_LIMIT,
+        ...getFeatureSelectionParams(options)
       },
       opts: { signal, headers: this.props.headers }
     }).then((res) => normalizeObjectKeys(res.rows)).then((res) => res.map(({ x, y }) => [x, y]));
@@ -6815,7 +6831,8 @@ var WidgetRemoteSource = class extends WidgetSource {
         sortBy,
         sortDirection,
         limit,
-        offset
+        offset,
+        ...getFeatureSelectionParams(options)
       },
       opts: { signal, headers: this.props.headers }
     }).then((res) => ({
@@ -6865,7 +6882,8 @@ var WidgetRemoteSource = class extends WidgetSource {
         operationExp,
         splitByCategory,
         splitByCategoryLimit,
-        splitByCategoryValues
+        splitByCategoryValues,
+        ...getFeatureSelectionParams(options)
       },
       opts: { signal, headers: this.props.headers }
     }).then((res) => ({
@@ -6890,7 +6908,8 @@ var WidgetRemoteSource = class extends WidgetSource {
         spatialFilter
       },
       params: {
-        aggregations
+        aggregations,
+        ...getFeatureSelectionParams(options)
       },
       opts: { signal, headers: this.props.headers }
     }).then((res) => ({
@@ -8564,7 +8583,8 @@ var vectorQuerySource = async function(options) {
     sqlQuery,
     tileResolution = DEFAULT_TILE_RESOLUTION,
     queryParameters,
-    aggregationExp
+    aggregationExp,
+    featureBbox
   } = options;
   const spatialDataType = "geo";
   const urlParameters = {
@@ -8585,6 +8605,9 @@ var vectorQuerySource = async function(options) {
   if (aggregationExp) {
     urlParameters.aggregationExp = aggregationExp;
   }
+  if (featureBbox) {
+    urlParameters.featureBbox = true;
+  }
   return baseSource("query", options, urlParameters).then(
     (result) => ({
       ...result,
@@ -8608,7 +8631,8 @@ var vectorTableSource = async function(options) {
     spatialDataColumn = DEFAULT_GEO_COLUMN,
     tableName,
     tileResolution = DEFAULT_TILE_RESOLUTION,
-    aggregationExp
+    aggregationExp,
+    featureBbox
   } = options;
   const spatialDataType = "geo";
   const urlParameters = {
@@ -8626,6 +8650,9 @@ var vectorTableSource = async function(options) {
   if (aggregationExp) {
     urlParameters.aggregationExp = aggregationExp;
   }
+  if (featureBbox) {
+    urlParameters.featureBbox = true;
+  }
   return baseSource("table", options, urlParameters).then(
     (result) => ({
       ...result,
@@ -11216,11 +11243,13 @@ function configureSource({
     tileResolution,
     ...queryParameters && { queryParameters }
   };
+  const { featureBbox } = dataset;
   const vectorOptions = {
     spatialDataColumn,
     ...columns && { columns },
     ...filters && { filters },
-    ...aggregationExp && { aggregationExp }
+    ...aggregationExp && { aggregationExp },
+    ...featureBbox && { featureBbox }
   };
   if (type === "raster") {
     return rasterSource({
@@ -11504,6 +11533,21 @@ async function fetchMap({
       }
     }
   });
+  const layers = map.keplerMapConfig.config.visState.layers;
+  const datasetsWithLabels = /* @__PURE__ */ new Set();
+  for (const layer of layers) {
+    const hasTextLabel = layer.config?.textLabel?.some(
+      (t) => t.field?.name
+    );
+    if (hasTextLabel) {
+      datasetsWithLabels.add(layer.config.dataId);
+    }
+  }
+  map.datasets.forEach((dataset) => {
+    if (datasetsWithLabels.has(dataset.id) && (dataset.type === "table" || dataset.type === "query")) {
+      dataset.featureBbox = true;
+    }
+  });
   const [basemap] = await Promise.all([
     fetchBasemapProps({ config: map.keplerMapConfig.config, errorContext }),
     // Mutates map.datasets so that dataset.data contains data