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

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.2",
   "license": "MIT",
   "publishConfig": {
     "access": "public"

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). Remote only. */
+  othersThreshold?: boolean;
 }
 
 /**

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));