@carto/api-client 0.5.7-alpha.2 → 0.5.7-alpha.3

package/build/api-client.d.cts

@@ -1193,8 +1193,8 @@ interface CategoryRequestOptions extends BaseRequestOptions {
     operationColumn?: string;
     /** Local only. */
     joinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
-    /** Calculate `_carto_others` category for all categories after first N (N is threshold). Remote only. */
-    othersThreshold?: boolean;
+    /** Calculate `_carto_others` category for all categories after first N (N is threshold). */
+    othersThreshold?: number;
 }
 /**
  * Options for {@link WidgetRemoteSource#getFeatures}.
@@ -1331,7 +1331,7 @@ type FormulaResponse = {
 };
 /** Response from {@link WidgetRemoteSource#getCategories}. */
 type CategoryResponse = {
-    name: string;
+    name: string | null;
     value: number;
 }[];
 /** Response from {@link WidgetRemoteSource#getRange}. */
@@ -1615,7 +1615,7 @@ declare class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePr
     getFeatures(): Promise<FeaturesResponse>;
     getFormula({ column, operation, joinOperation, filters, filterOwner, spatialFilter, }: FormulaRequestOptions): Promise<FormulaResponse>;
     getHistogram({ operation, ticks, column, joinOperation, filters, filterOwner, spatialFilter, }: HistogramRequestOptions): Promise<HistogramResponse>;
-    getCategories({ column, operation, operationColumn, joinOperation, filters, filterOwner, spatialFilter, }: CategoryRequestOptions): Promise<CategoryResponse>;
+    getCategories({ column, operation, operationColumn, joinOperation, filters, filterOwner, spatialFilter, othersThreshold, }: CategoryRequestOptions): Promise<CategoryResponse>;
     getScatter({ xAxisColumn, yAxisColumn, xAxisJoinOperation, yAxisJoinOperation, filters, filterOwner, spatialFilter, }: ScatterRequestOptions): Promise<ScatterResponse>;
     getTable({ columns, searchFilterColumn, searchFilterText, sortBy, sortDirection, sortByColumnType, offset, limit, filters, filterOwner, spatialFilter, }: TableRequestOptions): Promise<TableResponse>;
     getTimeSeries({ column, stepSize, operation, operationColumn, joinOperation, filters, filterOwner, spatialFilter, }: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
@@ -1826,12 +1826,13 @@ type GroupByFeature = {
     value: number;
 }[];
 /** @privateRemarks Source: @carto/react-core */
-declare function groupValuesByColumn({ data, valuesColumns, joinOperation, keysColumn, operation, }: {
+declare function groupValuesByColumn({ data, valuesColumns, joinOperation, keysColumn, operation, othersThreshold, }: {
     data: FeatureData[];
     valuesColumns?: string[];
     joinOperation?: AggregationType;
     keysColumn: string;
     operation: AggregationType;
+    othersThreshold?: number;
 }): GroupByFeature | null;
 
 /** @privateRemarks Source: @carto/react-core */

package/build/api-client.d.ts

@@ -1193,8 +1193,8 @@ interface CategoryRequestOptions extends BaseRequestOptions {
     operationColumn?: string;
     /** Local only. */
     joinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
-    /** Calculate `_carto_others` category for all categories after first N (N is threshold). Remote only. */
-    othersThreshold?: boolean;
+    /** Calculate `_carto_others` category for all categories after first N (N is threshold). */
+    othersThreshold?: number;
 }
 /**
  * Options for {@link WidgetRemoteSource#getFeatures}.
@@ -1331,7 +1331,7 @@ type FormulaResponse = {
 };
 /** Response from {@link WidgetRemoteSource#getCategories}. */
 type CategoryResponse = {
-    name: string;
+    name: string | null;
     value: number;
 }[];
 /** Response from {@link WidgetRemoteSource#getRange}. */
@@ -1615,7 +1615,7 @@ declare class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePr
     getFeatures(): Promise<FeaturesResponse>;
     getFormula({ column, operation, joinOperation, filters, filterOwner, spatialFilter, }: FormulaRequestOptions): Promise<FormulaResponse>;
     getHistogram({ operation, ticks, column, joinOperation, filters, filterOwner, spatialFilter, }: HistogramRequestOptions): Promise<HistogramResponse>;
-    getCategories({ column, operation, operationColumn, joinOperation, filters, filterOwner, spatialFilter, }: CategoryRequestOptions): Promise<CategoryResponse>;
+    getCategories({ column, operation, operationColumn, joinOperation, filters, filterOwner, spatialFilter, othersThreshold, }: CategoryRequestOptions): Promise<CategoryResponse>;
     getScatter({ xAxisColumn, yAxisColumn, xAxisJoinOperation, yAxisJoinOperation, filters, filterOwner, spatialFilter, }: ScatterRequestOptions): Promise<ScatterResponse>;
     getTable({ columns, searchFilterColumn, searchFilterText, sortBy, sortDirection, sortByColumnType, offset, limit, filters, filterOwner, spatialFilter, }: TableRequestOptions): Promise<TableResponse>;
     getTimeSeries({ column, stepSize, operation, operationColumn, joinOperation, filters, filterOwner, spatialFilter, }: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
@@ -1826,12 +1826,13 @@ type GroupByFeature = {
     value: number;
 }[];
 /** @privateRemarks Source: @carto/react-core */
-declare function groupValuesByColumn({ data, valuesColumns, joinOperation, keysColumn, operation, }: {
+declare function groupValuesByColumn({ data, valuesColumns, joinOperation, keysColumn, operation, othersThreshold, }: {
     data: FeatureData[];
     valuesColumns?: string[];
     joinOperation?: AggregationType;
     keysColumn: string;
     operation: AggregationType;
+    othersThreshold?: number;
 }): GroupByFeature | null;
 
 /** @privateRemarks Source: @carto/react-core */

package/build/api-client.js

@@ -6677,13 +6677,17 @@ function normalizeSortByOptions({
   });
 }
 
+// src/widget-sources/constants.ts
+var OTHERS_CATEGORY_NAME = "_carto_others";
+
 // src/operations/groupBy.ts
 function groupValuesByColumn({
   data,
   valuesColumns,
   joinOperation,
   keysColumn,
-  operation: operation2
+  operation: operation2,
+  othersThreshold
 }) {
   if (Array.isArray(data) && data.length === 0) {
     return null;
@@ -6701,13 +6705,23 @@ function groupValuesByColumn({
     return accumulator;
   }, /* @__PURE__ */ new Map());
   const targetOperation = aggregationFunctions[operation2];
-  if (targetOperation) {
-    return Array.from(groups).map(([name, value]) => ({
-      name,
-      value: targetOperation(value)
-    }));
+  if (!targetOperation) {
+    return [];
+  }
+  const allCategories = Array.from(groups).map(([name, value]) => ({
+    name,
+    value: targetOperation(value)
+  }));
+  allCategories.sort((a, b) => b.value - a.value);
+  if (othersThreshold && allCategories.length > othersThreshold) {
+    const otherNames = allCategories.map((entry) => entry.name).slice(othersThreshold);
+    const otherValue = otherNames.flatMap((name) => groups.get(name));
+    allCategories.push({
+      name: OTHERS_CATEGORY_NAME,
+      value: targetOperation(otherValue)
+    });
   }
-  return [];
+  return allCategories;
 }
 
 // src/utils/dateUtils.ts
@@ -7270,7 +7284,8 @@ var WidgetTilesetSourceImpl = class extends WidgetSource {
     joinOperation,
     filters,
     filterOwner,
-    spatialFilter
+    spatialFilter,
+    othersThreshold
   }) {
     const filteredFeatures = this._getFilteredFeatures(
       spatialFilter,
@@ -7286,7 +7301,8 @@ var WidgetTilesetSourceImpl = class extends WidgetSource {
       valuesColumns: normalizeColumns(operationColumn || column),
       joinOperation,
       keysColumn: column,
-      operation: operation2
+      operation: operation2,
+      othersThreshold
     });
     return groups || [];
   }
@@ -7660,9 +7676,6 @@ var WidgetTableSource = class extends WidgetRemoteSource {
   }
 };
 
-// src/widget-sources/constants.ts
-var OTHERS_CATEGORY_NAME = "_carto_others";
-
 // src/sources/h3-query-source.ts
 var h3QuerySource = async function(options) {
   const {