@carto/api-client 0.5.7 → 0.5.8-alpha-others-orderby.1

package/build/api-client.cjs

@@ -108,6 +108,7 @@ __export(src_exports, {
   FEATURE_GEOM_PROPERTY: () => FEATURE_GEOM_PROPERTY,
   FilterType: () => FilterType,
   OPACITY_MAP: () => OPACITY_MAP,
+  OTHERS_CATEGORY_NAME: () => OTHERS_CATEGORY_NAME,
   Provider: () => Provider,
   SOURCE_DEFAULTS: () => SOURCE_DEFAULTS,
   SchemaFieldType: () => SchemaFieldType,
@@ -158,6 +159,7 @@ __export(src_exports, {
   getLayerProps: () => getLayerProps,
   getMaxMarkerSize: () => getMaxMarkerSize,
   getSizeAccessor: () => getSizeAccessor,
+  getSorter: () => getSorter,
   getSpatialIndexFromGeoColumn: () => getSpatialIndexFromGeoColumn,
   getTextAccessor: () => getTextAccessor,
   groupValuesByColumn: () => groupValuesByColumn,
@@ -6551,6 +6553,10 @@ function getApplicableFilters(owner, filters) {
   return applicableFilters;
 }
 
+// src/widget-sources/constants.ts
+init_cjs_shims();
+var OTHERS_CATEGORY_NAME = "_carto_others";
+
 // src/widget-sources/widget-remote-source.ts
 var WidgetRemoteSource = class extends WidgetSource {
   _getModelSource(filters, filterOwner) {
@@ -6574,13 +6580,21 @@ var WidgetRemoteSource = class extends WidgetSource {
       filterOwner,
       spatialFilter,
       spatialFiltersMode,
+      rawResult,
       ...params
     } = options;
-    const { column, operation: operation2, operationColumn, operationExp } = params;
+    const {
+      column,
+      operation: operation2,
+      operationColumn,
+      operationExp,
+      othersThreshold,
+      orderBy
+    } = params;
     if (operation2 === AggregationTypes.Custom) {
       assert2(operationExp, "operationExp is required for custom operation");
     }
-    return executeModel({
+    const result = await executeModel({
       model: "category",
       source: {
         ...this.getModelSource(filters, filterOwner),
@@ -6591,10 +6605,23 @@ var WidgetRemoteSource = class extends WidgetSource {
         column,
         operation: operation2,
         operationExp,
-        operationColumn: operationColumn || column
+        operationColumn: operationColumn || column,
+        othersThreshold,
+        orderBy
       },
       opts: { signal, headers: this.props.headers }
-    }).then((res) => normalizeObjectKeys(res.rows));
+    });
+    const normalizedRows = normalizeObjectKeys(result.rows || []);
+    if (rawResult) {
+      return result;
+    }
+    if (!othersThreshold) {
+      return normalizedRows;
+    }
+    return [
+      ...normalizedRows,
+      { name: OTHERS_CATEGORY_NAME, value: result?.metadata?.others }
+    ];
   }
   async getFeatures(options) {
     const {
@@ -6999,10 +7026,12 @@ function groupValuesByColumn({
   valuesColumns,
   joinOperation,
   keysColumn,
-  operation: operation2
+  operation: operation2,
+  othersThreshold,
+  orderBy = "frequency_desc"
 }) {
   if (Array.isArray(data) && data.length === 0) {
-    return null;
+    return { rows: null };
   }
   const groups = data.reduce((accumulator, item) => {
     const group2 = item[keysColumn];
@@ -7017,13 +7046,44 @@ 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 { rows: [] };
+  }
+  const allCategories = Array.from(groups).map(([name, value]) => ({
+    name,
+    value: targetOperation(value)
+  })).sort(getSorter(orderBy));
+  if (othersThreshold && allCategories.length > othersThreshold) {
+    const otherValue = allCategories.slice(othersThreshold).flatMap(({ name }) => groups.get(name));
+    allCategories.push({
+      name: OTHERS_CATEGORY_NAME,
+      value: targetOperation(otherValue)
+    });
+    return {
+      rows: allCategories,
+      metadata: {
+        others: targetOperation(otherValue)
+      }
+    };
+  }
+  return {
+    rows: allCategories
+  };
+}
+function getSorter(orderBy) {
+  switch (orderBy) {
+    case "frequency_asc":
+      return (a, b) => a.value - b.value || localeCompare(a.name, b.name);
+    case "frequency_desc":
+      return (a, b) => b.value - a.value || localeCompare(a.name, b.name);
+    case "alphabetical_asc":
+      return (a, b) => localeCompare(a.name, b.name) || b.value - a.value;
+    case "alphabetical_desc":
+      return (a, b) => localeCompare(b.name, a.name) || b.value - a.value;
   }
-  return [];
+}
+function localeCompare(a, b) {
+  return (a ?? "null").localeCompare(b ?? "null");
 }
 
 // src/operations/groupByDate.ts
@@ -7597,7 +7657,10 @@ var WidgetTilesetSourceImpl = class extends WidgetSource {
     joinOperation,
     filters,
     filterOwner,
-    spatialFilter
+    spatialFilter,
+    othersThreshold,
+    orderBy = "frequency_desc",
+    rawResult
   }) {
     const filteredFeatures = this._getFilteredFeatures(
       spatialFilter,
@@ -7608,14 +7671,25 @@ var WidgetTilesetSourceImpl = class extends WidgetSource {
       return [];
     }
     assertColumn(this._features, column, operationColumn);
-    const groups = groupValuesByColumn({
+    const result = groupValuesByColumn({
       data: filteredFeatures,
       valuesColumns: normalizeColumns(operationColumn || column),
       joinOperation,
       keysColumn: column,
-      operation: operation2
+      operation: operation2,
+      othersThreshold,
+      orderBy
     });
-    return groups || [];
+    if (rawResult) {
+      return result;
+    }
+    if (!othersThreshold) {
+      return result?.rows || [];
+    }
+    return [
+      ...result?.rows || [],
+      { name: OTHERS_CATEGORY_NAME, value: result?.metadata?.others }
+    ];
   }
   async getScatter({
     xAxisColumn,
@@ -10408,6 +10482,7 @@ function hashBuckets(initialCount) {
   FEATURE_GEOM_PROPERTY,
   FilterType,
   OPACITY_MAP,
+  OTHERS_CATEGORY_NAME,
   Provider,
   SOURCE_DEFAULTS,
   SchemaFieldType,
@@ -10458,6 +10533,7 @@ function hashBuckets(initialCount) {
   getLayerProps,
   getMaxMarkerSize,
   getSizeAccessor,
+  getSorter,
   getSpatialIndexFromGeoColumn,
   getTextAccessor,
   groupValuesByColumn,