@carto/api-client 0.5.6-alpha.bundle.4 → 0.5.7-alpha.1

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.6-alpha.bundle.4",
+  "version": "0.5.7-alpha.1",
   "license": "MIT",
   "publishConfig": {
     "access": "public"

package/src/constants.ts

@@ -60,3 +60,15 @@ export const SpatialIndexColumn = Object.freeze({
   [SpatialIndex.H3]: ['h3', 'hex', 'h3id', 'hex_id', 'h3hex'],
   [SpatialIndex.QUADBIN]: ['quadbin'],
 });
+
+/**
+ * Enum like container for all types of aggregations available for widgets.
+ */
+export const AggregationTypes = {
+  Count: 'count' as const,
+  Avg: 'avg' as const,
+  Min: 'min' as const,
+  Max: 'max' as const,
+  Sum: 'sum' as const,
+  Custom: 'custom' as const,
+} as const;

package/src/fetch-map/layer-map.ts

@@ -37,6 +37,7 @@ import type {
 } from './types.js';
 import type {ProviderType, SchemaField} from '../types.js';
 import {DEFAULT_AGGREGATION_EXP_ALIAS} from '../constants-internal.js';
+import {AggregationTypes} from '../constants.js';
 
 export type D3Scale = {
   domain: (d?: any) => any[];
@@ -431,7 +432,7 @@ export function getSizeAccessor(
 ): {accessor: any; scale: any} {
   const scale = scaleType ? SCALE_FUNCS[scaleType]() : identity;
   if (scaleType) {
-    if (aggregation !== 'count') {
+    if (aggregation !== AggregationTypes.Count) {
       (scale as D3Scale).domain(calculateDomain(data, name, scaleType));
     }
     (scale as D3Scale).range(range);

package/src/types.ts

@@ -95,7 +95,7 @@ export type Raster = {
  */
 
 /**
- * Enum for the different types of aggregations available for widgets.
+ * Enum type for the different types of aggregations available for widgets.
  *
  * @privateRemarks Source: @carto/constants
  * @privateRemarks Converted from enum to type union, for improved declarative API.

package/src/widget-sources/types.ts

@@ -59,6 +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;
 }
 
 /**

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

@@ -21,7 +21,7 @@ import {assert, normalizeObjectKeys} from '../utils.js';
 import {DEFAULT_TILE_RESOLUTION} from '../constants-internal.js';
 import {WidgetSource, type WidgetSourceProps} from './widget-source.js';
 import type {Filters} from '../types.js';
-import {ApiVersion} from '../constants.js';
+import {AggregationTypes, ApiVersion} from '../constants.js';
 import {getApplicableFilters} from '../filters.js';
 
 export type WidgetRemoteSourceProps = WidgetSourceProps;
@@ -74,9 +74,9 @@ export abstract class WidgetRemoteSource<
       spatialFiltersMode,
       ...params
     } = options;
-    const {column, operation, operationColumn, operationExp} = params;
+    const {column, operation, operationColumn, operationExp, maxItems} = params;
 
-    if (operation === 'custom') {
+    if (operation === AggregationTypes.Custom) {
       assert(operationExp, 'operationExp is required for custom operation');
     }
 
@@ -94,6 +94,7 @@ export abstract class WidgetRemoteSource<
         operation,
         operationExp,
         operationColumn: operationColumn || column,
+        maxItems,
       },
       opts: {signal, headers: this.props.headers},
     }).then((res: CategoriesModelResponse) => normalizeObjectKeys(res.rows));
@@ -148,7 +149,7 @@ export abstract class WidgetRemoteSource<
 
     type FormulaModelResponse = {rows: {value: number}[]};
 
-    if (operation === 'custom') {
+    if (operation === AggregationTypes.Custom) {
       assert(operationExp, 'operationExp is required for custom operation');
     }
 
@@ -161,7 +162,7 @@ export abstract class WidgetRemoteSource<
       },
       params: {
         column: column ?? '*',
-        operation: operation ?? 'count',
+        operation: operation ?? AggregationTypes.Count,
         operationExp,
       },
       opts: {signal, headers: this.props.headers},
@@ -331,7 +332,7 @@ export abstract class WidgetRemoteSource<
       splitByCategoryValues,
     } = params;
 
-    if (operation === 'custom') {
+    if (operation === AggregationTypes.Custom) {
       assert(operationExp, 'operationExp is required for custom operation');
     }
 

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

@@ -39,6 +39,7 @@ import {WidgetSource} from './widget-source.js';
 import {booleanEqual} from '@turf/boolean-equal';
 import type {WidgetTilesetSourceProps} from './widget-tileset-source.js';
 import {getApplicableFilters} from '../filters.js';
+import {AggregationTypes} from '../constants.js';
 
 // TODO(cleanup): Parameter defaults in source functions and widget API calls are
 // currently duplicated and possibly inconsistent. Consider consolidating and
@@ -120,7 +121,7 @@ export class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePro
 
   async getFormula({
     column = '*',
-    operation = 'count',
+    operation = AggregationTypes.Count,
     joinOperation,
     filters,
     filterOwner,
@@ -132,16 +133,16 @@ export class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePro
       filterOwner
     );
 
-    if (filteredFeatures.length === 0 && operation !== 'count') {
+    if (filteredFeatures.length === 0 && operation !== AggregationTypes.Count) {
       return {value: null};
     }
 
-    if (operation === 'custom') {
+    if (operation === AggregationTypes.Custom) {
       throw new Error('Custom aggregation not supported for tilesets');
     }
 
     // Column is required except when operation is 'count'.
-    if ((column && column !== '*') || operation !== 'count') {
+    if ((column && column !== '*') || operation !== AggregationTypes.Count) {
       assertColumn(this._features, column);
     }
 
@@ -152,7 +153,7 @@ export class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePro
   }
 
   override async getHistogram({
-    operation = 'count',
+    operation = AggregationTypes.Count,
     ticks,
     column,
     joinOperation,
@@ -183,7 +184,7 @@ export class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePro
 
   override async getCategories({
     column,
-    operation = 'count',
+    operation = AggregationTypes.Count,
     operationColumn,
     joinOperation,
     filters,