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

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## 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)

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) => ({