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

package/package.json

@@ -8,7 +8,7 @@
   "homepage": "https://github.com/CartoDB/carto-api-client#readme",
   "author": "Don McCurdy <donmccurdy@carto.com>",
   "packageManager": "yarn@4.3.1",
-  "version": "0.5.7-alpha.1",
+  "version": "0.5.7-alpha.3",
   "license": "MIT",
   "publishConfig": {
     "access": "public"

package/src/operations/groupBy.ts

@@ -1,4 +1,5 @@
 import {aggregationFunctions, aggregate} from './aggregation.js';
+import {OTHERS_CATEGORY_NAME} from '../widget-sources/constants.js';
 import type {AggregationType} from '../types.js';
 import type {FeatureData} from '../types-internal.js';
 
@@ -15,12 +16,14 @@ export function groupValuesByColumn({
   joinOperation,
   keysColumn,
   operation,
+  othersThreshold,
 }: {
   data: FeatureData[];
   valuesColumns?: string[];
   joinOperation?: AggregationType;
   keysColumn: string;
   operation: AggregationType;
+  othersThreshold?: number;
 }): GroupByFeature | null {
   if (Array.isArray(data) && data.length === 0) {
     return null;
@@ -48,12 +51,27 @@ export function groupValuesByColumn({
   const targetOperation =
     aggregationFunctions[operation as Exclude<AggregationType, 'custom'>];
 
-  if (targetOperation) {
-    return Array.from(groups).map(([name, value]) => ({
-      name,
-      value: targetOperation(value),
-    }));
+  if (!targetOperation) {
+    return [];
   }
 
-  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 allCategories;
 }

package/src/widget-sources/constants.ts

@@ -0,0 +1,6 @@
+/**
+ * Name of the category that represents the "Others" category.
+ *
+ * See `WidgetSource.getCategories` for more information.
+ */
+export const OTHERS_CATEGORY_NAME = '_carto_others';

package/src/widget-sources/index.ts

@@ -5,3 +5,4 @@ export * from './widget-remote-source.js';
 export * from './widget-table-source.js';
 export * from './widget-tileset-source.js';
 export * from './types.js';
+export * from './constants.js';

package/src/widget-sources/types.ts

@@ -59,8 +59,8 @@ export interface CategoryRequestOptions extends BaseRequestOptions {
   operationColumn?: string;
   /** Local only. */
   joinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
-  /** Maximum number of items to return. Backend calculates also __carto_others category. Remote only. */
-  maxItems?: number;
+  /** Calculate `_carto_others` category for all categories after first N (N is threshold). */
+  othersThreshold?: number;
 }
 
 /**
@@ -208,7 +208,7 @@ export type FeaturesResponse = {rows: Record<string, unknown>[]};
 export type FormulaResponse = {value: number | null};
 
 /** Response from {@link WidgetRemoteSource#getCategories}. */
-export type CategoryResponse = {name: string; value: number}[];
+export type CategoryResponse = {name: string | null; value: number}[];
 
 /** Response from {@link WidgetRemoteSource#getRange}. */
 export type RangeResponse = {min: number; max: number} | null;

package/src/widget-sources/widget-remote-source.ts

@@ -74,7 +74,8 @@ export abstract class WidgetRemoteSource<
       spatialFiltersMode,
       ...params
     } = options;
-    const {column, operation, operationColumn, operationExp, maxItems} = params;
+    const {column, operation, operationColumn, operationExp, othersThreshold} =
+      params;
 
     if (operation === AggregationTypes.Custom) {
       assert(operationExp, 'operationExp is required for custom operation');
@@ -94,7 +95,7 @@ export abstract class WidgetRemoteSource<
         operation,
         operationExp,
         operationColumn: operationColumn || column,
-        maxItems,
+        othersThreshold,
       },
       opts: {signal, headers: this.props.headers},
     }).then((res: CategoriesModelResponse) => normalizeObjectKeys(res.rows));

package/src/widget-sources/widget-tileset-source-impl.ts

@@ -190,6 +190,7 @@ export class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePro
     filters,
     filterOwner,
     spatialFilter,
+    othersThreshold,
   }: CategoryRequestOptions): Promise<CategoryResponse> {
     const filteredFeatures = this._getFilteredFeatures(
       spatialFilter,
@@ -209,6 +210,7 @@ export class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePro
       joinOperation,
       keysColumn: column,
       operation,
+      othersThreshold,
     });
 
     return groups || [];