@carto/api-client 0.5.15 → 0.5.16

package/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## 0.5
 
+### 0.5.16
+
+- feat(widgets): Add getAggregations() method (#229)
+- chore(deps): bump h3-js from 4.2.1 to 4.3.0 (#232)
+
 ### 0.5.15
 
 - feat(sources): Add support for trajectory data sources (#227, #228)

package/build/api-client.cjs

@@ -6420,7 +6420,8 @@ var AVAILABLE_MODELS = [
   "timeseries",
   "range",
   "scatterplot",
-  "table"
+  "table",
+  "aggregations"
 ];
 var { V3 } = ApiVersion;
 var REQUEST_GET_MAX_URL_LENGTH = 2048;
@@ -6863,6 +6864,30 @@ var WidgetRemoteSource = class extends WidgetSource {
       categories: res.metadata?.categories
     }));
   }
+  async getAggregations(options) {
+    const {
+      signal,
+      filters = this.props.filters,
+      filterOwner,
+      spatialFilter,
+      spatialFiltersMode,
+      aggregations
+    } = options;
+    return executeModel({
+      model: "aggregations",
+      source: {
+        ...this.getModelSource(filters, filterOwner),
+        spatialFiltersMode,
+        spatialFilter
+      },
+      params: {
+        aggregations
+      },
+      opts: { signal, headers: this.props.headers }
+    }).then((res) => ({
+      rows: res.rows.map((row) => normalizeObjectKeys(row))
+    }));
+  }
   /** @experimental */
   async getExtent(options = {}) {
     const { signal, filters = this.props.filters, filterOwner } = options;
@@ -7685,6 +7710,7 @@ var WidgetTilesetSourceImpl = class extends WidgetSource {
       assertColumn(this._features, column);
     }
     const targetOperation = aggregationFunctions[operation2];
+    assert2(targetOperation, `Unsupported aggregation operation: ${operation2}`);
     return {
       value: targetOperation(filteredFeatures, column, joinOperation)
     };
@@ -7883,6 +7909,39 @@ var WidgetTilesetSourceImpl = class extends WidgetSource {
       max: aggregationFunctions.max(filteredFeatures, column)
     };
   }
+  async getAggregations({
+    aggregations,
+    filters,
+    filterOwner,
+    spatialFilter
+  }) {
+    const filteredFeatures = this._getFilteredFeatures(
+      spatialFilter,
+      filters,
+      filterOwner
+    );
+    if (!this._features.length) {
+      return { rows: [] };
+    }
+    assert2(
+      typeof aggregations !== "string",
+      "Unsupported tileset SQL aggregation"
+    );
+    const result = {};
+    const usedAliases = /* @__PURE__ */ new Set();
+    for (const { column, operation: operation2, alias } of aggregations) {
+      if (column && column !== "*" || operation2 !== AggregationTypes.Count) {
+        assertColumn(this._features, column);
+      }
+      const aliasKey = alias.toLowerCase();
+      assert2(!usedAliases.has(aliasKey), `Duplicate alias: ${aliasKey}`);
+      usedAliases.add(aliasKey);
+      const targetOperation = aggregationFunctions[operation2];
+      assert2(targetOperation, `Unsupported operation: ${operation2}`);
+      result[alias] = targetOperation(filteredFeatures, column);
+    }
+    return { rows: [result] };
+  }
   /** @experimental */
   async getExtent() {
     return Promise.reject(new Error("not implemented"));
@@ -8117,6 +8176,16 @@ var WidgetTilesetSource = class extends WidgetSource {
   }) {
     return this._executeWorkerMethod("getRange" /* GET_RANGE */, [options], signal);
   }
+  async getAggregations({
+    signal,
+    ...options
+  }) {
+    return this._executeWorkerMethod(
+      "getAggregations" /* GET_AGGREGATIONS */,
+      [options],
+      signal
+    );
+  }
   /** @experimental */
   async getExtent() {
     return Promise.resolve({