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

package/build/api-client.d.cts

@@ -1165,6 +1165,7 @@ interface BaseRequestOptions {
     filters?: Filters;
     filterOwner?: string;
 }
+type CategoryOrderBy = 'frequency_asc' | 'frequency_desc' | 'alphabetical_asc' | 'alphabetical_desc';
 /**
  * Examples:
  *   * population by state
@@ -1193,6 +1194,15 @@ 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). */
+    othersThreshold?: number;
+    /**
+     * Order categories by frequency or alphabetically.
+     * @default 'frequency_desc'
+     */
+    orderBy?: CategoryOrderBy;
+    /** Return raw result (CategoryResponseRaw). */
+    rawResult?: boolean;
 }
 /**
  * Options for {@link WidgetRemoteSource#getFeatures}.
@@ -1327,11 +1337,19 @@ type FeaturesResponse = {
 type FormulaResponse = {
     value: number | null;
 };
-/** Response from {@link WidgetRemoteSource#getCategories}. */
-type CategoryResponse = {
-    name: string;
+/** Entry in the category widget response, see  {@link WidgetRemoteSource#getCategories}. */
+type CategoryResponseEntry = {
+    name: string | null;
     value: number;
-}[];
+};
+/** Response from {@link WidgetRemoteSource#getCategories}. */
+type CategoryResponse = CategoryResponseEntry[];
+type CategoryResponseRaw = {
+    rows: CategoryResponseEntry[] | null;
+    metadata?: {
+        others?: number;
+    };
+};
 /** Response from {@link WidgetRemoteSource#getRange}. */
 type RangeResponse = {
     min: number;
@@ -1613,7 +1631,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, orderBy, rawResult, }: 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>;
@@ -1734,6 +1752,13 @@ declare class WidgetTableSource extends WidgetRemoteSource<LayerTableSourceOptio
     protected getModelSource(filters: Filters | undefined, filterOwner?: string): ModelSource;
 }
 
+/**
+ * Name of the category that represents the "Others" category.
+ *
+ * See `WidgetSource.getCategories` for more information.
+ */
+declare const OTHERS_CATEGORY_NAME = "_carto_others";
+
 type H3QuerySourceOptions = SourceOptions & QuerySourceOptions & AggregationOptions & FilterOptions;
 type H3QuerySourceResponse = TilejsonResult & WidgetQuerySourceResult;
 declare const h3QuerySource: (options: H3QuerySourceOptions) => Promise<H3QuerySourceResponse>;
@@ -1812,19 +1837,22 @@ interface SortOptions {
 declare function applySorting(features: FeatureData[], { sortBy, sortByDirection, sortByColumnType, }?: SortOptions): FeatureData[];
 
 /** @privateRemarks Source: @carto/react-core */
-type GroupByFeature = {
-    name: string;
-    value: number;
-}[];
-/** @privateRemarks Source: @carto/react-core */
-declare function groupValuesByColumn({ data, valuesColumns, joinOperation, keysColumn, operation, }: {
+declare function groupValuesByColumn({ data, valuesColumns, joinOperation, keysColumn, operation, othersThreshold, orderBy, }: {
     data: FeatureData[];
     valuesColumns?: string[];
     joinOperation?: AggregationType;
     keysColumn: string;
     operation: AggregationType;
-}): GroupByFeature | null;
+    othersThreshold?: number;
+    orderBy?: CategoryOrderBy;
+}): CategoryResponseRaw | null;
+declare function getSorter(orderBy: CategoryOrderBy): (a: CategoryResponseEntry, b: CategoryResponseEntry) => number;
 
+/** @privateRemarks Source: @carto/react-core */
+type GroupByFeature = {
+    name: string;
+    value: number;
+}[];
 /** @privateRemarks Source: @carto/react-core */
 declare function groupValuesByDateColumn({ data, valuesColumns, joinOperation, keysColumn, groupType, operation, }: {
     data: Record<string, unknown>[];
@@ -1921,4 +1949,4 @@ declare function getColumnNameFromGeoColumn(geoColumn: string | null | undefined
  */
 declare function getSpatialIndexFromGeoColumn(geoColumn: string): SpatialIndex | null;
 
-export { type APIErrorContext, type APIRequestType, type AddFilterOptions, type AggregationFunction, type AggregationType, AggregationTypes, ApiVersion, type Attribute, _default as BASEMAP, type BaseRequestOptions, type Basemap, type BoundaryQuerySourceOptions, type BoundaryQuerySourceResponse, type BoundaryTableSourceOptions, type BoundaryTableSourceResponse, CartoAPIError, type CategoryRequestOptions, type CategoryResponse, CellSet, type ColumnsOption, type D3Scale, DEFAULT_API_BASE_URL, FEATURE_GEOM_PROPERTY, type FeaturesRequestOptions, type FeaturesResponse, type FetchMapOptions, type FetchMapResult, type Filter, type FilterFunction, type FilterInterval, type FilterIntervalComplete, type FilterIntervalExtremum, type FilterLogicalOperator, type FilterOptions, FilterType, type Filters, type Format, type FormulaRequestOptions, type FormulaResponse, type GetFilterOptions, type GoogleBasemap, type GroupByFeature, type GroupDateType, type H3QuerySourceOptions, type H3QuerySourceResponse, type H3TableSourceOptions, type H3TableSourceResponse, type H3TilesetSourceOptions, type H3TilesetSourceResponse, type HasFilterOptions, type HistogramRequestOptions, type HistogramResponse, type KeplerMapConfig, type Layer, type LayerDescriptor, type LayerType, type MapLibreBasemap, type MapType, type NamedQueryParameter, OPACITY_MAP, type ParseMapResult, type PositionalQueryParameter, Provider, type ProviderType, type QuadbinQuerySourceOptions, type QuadbinQuerySourceResponse, type QuadbinTableSourceOptions, type QuadbinTableSourceResponse, type QuadbinTilesetSourceOptions, type QuadbinTilesetSourceResponse, type QueryOptions, type QueryParameterValue, type QueryParameters, type QueryResult, type QuerySourceOptions, type RangeRequestOptions, type RangeResponse, type Raster, RasterBandColorinterp, type RasterBandType, type RasterMetadata, type RasterMetadataBand, type RasterMetadataBandStats, type RasterSourceOptions, type RasterTile, type RemoveFilterOptions, SOURCE_DEFAULTS, type Scale, type ScaleKey, type ScaleType, type ScatterPlotFeature, type ScatterRequestOptions, type ScatterResponse, type SchemaField, SchemaFieldType, type SortColumnType, type SortDirection, type SourceOptionalOptions, type SourceOptions, type SourceRequiredOptions, type SpatialDataType, type SpatialFilter, type SpatialFilterPolyfillMode, SpatialIndex, SpatialIndexColumn, type SpatialIndexTile, type StringSearchOptions, TEXT_LABEL_INDEX, TEXT_NUMBER_FORMATTER, TEXT_OUTLINE_OPACITY, type TableRequestOptions, type TableResponse, type TableSourceOptions, type Tile, type TileFeatureExtractOptions, type TileFeatures, type TileFeaturesSpatialIndexOptions, TileFormat, type TileResolution, type Tilejson, type TilejsonResult, type TilesetSourceOptions, type Tilestats, type TimeSeriesRequestOptions, type TimeSeriesResponse, type VectorLayer, type VectorQuerySourceOptions, type VectorQuerySourceResponse, type VectorTableSourceOptions, type VectorTableSourceResponse, type VectorTilesetSourceOptions, type VectorTilesetSourceResponse, type ViewState, type Viewport, WidgetQuerySource, type WidgetQuerySourceResult, WidgetRasterSource, type WidgetRasterSourceProps, type WidgetRasterSourceResult, WidgetRemoteSource, type WidgetRemoteSourceProps, WidgetSource, type WidgetSourceProps, WidgetTableSource, type WidgetTableSourceResult, WidgetTilesetSource, type WidgetTilesetSourceProps, type WidgetTilesetSourceResult, type _DataFilterExtensionProps, _buildFeatureFilter, domainFromValues as _domainFromValues, _getHexagonResolution, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildPublicMapUrl, buildStatsUrl, calculateClusterRadius, calculateClusterTextFontSize, clearDefaultRequestCache, clearFilters, configureSource, createPolygonSpatialFilter, createViewportSpatialFilter, fetchBasemapProps, fetchMap, filterFunctions, geojsonFeatures, getApplicableFilters, getClient, getColorAccessor, getColumnNameFromGeoColumn, getDataFilterExtensionProps, getDefaultAggregationExpColumnAliasForLayerType, getFilter, getIconUrlAccessor, getLayerProps, getMaxMarkerSize, getSizeAccessor, getSpatialIndexFromGeoColumn, getTextAccessor, groupValuesByColumn, groupValuesByDateColumn, h3QuerySource, h3TableSource, h3TilesetSource, hasFilter, histogram, makeIntervalComplete, negateAccessor, opacityToAlpha, parseMap, quadbinQuerySource, quadbinTableSource, quadbinTilesetSource, query, rasterSource, removeFilter, requestWithParameters, scaleAggregationResLevel, scatterPlot, setClient, tileFeatures, tileFeaturesGeometries, tileFeaturesSpatialIndex, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };
+export { type APIErrorContext, type APIRequestType, type AddFilterOptions, type AggregationFunction, type AggregationType, AggregationTypes, ApiVersion, type Attribute, _default as BASEMAP, type BaseRequestOptions, type Basemap, type BoundaryQuerySourceOptions, type BoundaryQuerySourceResponse, type BoundaryTableSourceOptions, type BoundaryTableSourceResponse, CartoAPIError, type CategoryOrderBy, type CategoryRequestOptions, type CategoryResponse, type CategoryResponseEntry, type CategoryResponseRaw, CellSet, type ColumnsOption, type D3Scale, DEFAULT_API_BASE_URL, FEATURE_GEOM_PROPERTY, type FeaturesRequestOptions, type FeaturesResponse, type FetchMapOptions, type FetchMapResult, type Filter, type FilterFunction, type FilterInterval, type FilterIntervalComplete, type FilterIntervalExtremum, type FilterLogicalOperator, type FilterOptions, FilterType, type Filters, type Format, type FormulaRequestOptions, type FormulaResponse, type GetFilterOptions, type GoogleBasemap, type GroupByFeature, type GroupDateType, type H3QuerySourceOptions, type H3QuerySourceResponse, type H3TableSourceOptions, type H3TableSourceResponse, type H3TilesetSourceOptions, type H3TilesetSourceResponse, type HasFilterOptions, type HistogramRequestOptions, type HistogramResponse, type KeplerMapConfig, type Layer, type LayerDescriptor, type LayerType, type MapLibreBasemap, type MapType, type NamedQueryParameter, OPACITY_MAP, OTHERS_CATEGORY_NAME, type ParseMapResult, type PositionalQueryParameter, Provider, type ProviderType, type QuadbinQuerySourceOptions, type QuadbinQuerySourceResponse, type QuadbinTableSourceOptions, type QuadbinTableSourceResponse, type QuadbinTilesetSourceOptions, type QuadbinTilesetSourceResponse, type QueryOptions, type QueryParameterValue, type QueryParameters, type QueryResult, type QuerySourceOptions, type RangeRequestOptions, type RangeResponse, type Raster, RasterBandColorinterp, type RasterBandType, type RasterMetadata, type RasterMetadataBand, type RasterMetadataBandStats, type RasterSourceOptions, type RasterTile, type RemoveFilterOptions, SOURCE_DEFAULTS, type Scale, type ScaleKey, type ScaleType, type ScatterPlotFeature, type ScatterRequestOptions, type ScatterResponse, type SchemaField, SchemaFieldType, type SortColumnType, type SortDirection, type SourceOptionalOptions, type SourceOptions, type SourceRequiredOptions, type SpatialDataType, type SpatialFilter, type SpatialFilterPolyfillMode, SpatialIndex, SpatialIndexColumn, type SpatialIndexTile, type StringSearchOptions, TEXT_LABEL_INDEX, TEXT_NUMBER_FORMATTER, TEXT_OUTLINE_OPACITY, type TableRequestOptions, type TableResponse, type TableSourceOptions, type Tile, type TileFeatureExtractOptions, type TileFeatures, type TileFeaturesSpatialIndexOptions, TileFormat, type TileResolution, type Tilejson, type TilejsonResult, type TilesetSourceOptions, type Tilestats, type TimeSeriesRequestOptions, type TimeSeriesResponse, type VectorLayer, type VectorQuerySourceOptions, type VectorQuerySourceResponse, type VectorTableSourceOptions, type VectorTableSourceResponse, type VectorTilesetSourceOptions, type VectorTilesetSourceResponse, type ViewState, type Viewport, WidgetQuerySource, type WidgetQuerySourceResult, WidgetRasterSource, type WidgetRasterSourceProps, type WidgetRasterSourceResult, WidgetRemoteSource, type WidgetRemoteSourceProps, WidgetSource, type WidgetSourceProps, WidgetTableSource, type WidgetTableSourceResult, WidgetTilesetSource, type WidgetTilesetSourceProps, type WidgetTilesetSourceResult, type _DataFilterExtensionProps, _buildFeatureFilter, domainFromValues as _domainFromValues, _getHexagonResolution, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildPublicMapUrl, buildStatsUrl, calculateClusterRadius, calculateClusterTextFontSize, clearDefaultRequestCache, clearFilters, configureSource, createPolygonSpatialFilter, createViewportSpatialFilter, fetchBasemapProps, fetchMap, filterFunctions, geojsonFeatures, getApplicableFilters, getClient, getColorAccessor, getColumnNameFromGeoColumn, getDataFilterExtensionProps, getDefaultAggregationExpColumnAliasForLayerType, getFilter, getIconUrlAccessor, getLayerProps, getMaxMarkerSize, getSizeAccessor, getSorter, getSpatialIndexFromGeoColumn, getTextAccessor, groupValuesByColumn, groupValuesByDateColumn, h3QuerySource, h3TableSource, h3TilesetSource, hasFilter, histogram, makeIntervalComplete, negateAccessor, opacityToAlpha, parseMap, quadbinQuerySource, quadbinTableSource, quadbinTilesetSource, query, rasterSource, removeFilter, requestWithParameters, scaleAggregationResLevel, scatterPlot, setClient, tileFeatures, tileFeaturesGeometries, tileFeaturesSpatialIndex, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };

package/build/api-client.d.ts

@@ -1165,6 +1165,7 @@ interface BaseRequestOptions {
     filters?: Filters;
     filterOwner?: string;
 }
+type CategoryOrderBy = 'frequency_asc' | 'frequency_desc' | 'alphabetical_asc' | 'alphabetical_desc';
 /**
  * Examples:
  *   * population by state
@@ -1193,6 +1194,15 @@ 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). */
+    othersThreshold?: number;
+    /**
+     * Order categories by frequency or alphabetically.
+     * @default 'frequency_desc'
+     */
+    orderBy?: CategoryOrderBy;
+    /** Return raw result (CategoryResponseRaw). */
+    rawResult?: boolean;
 }
 /**
  * Options for {@link WidgetRemoteSource#getFeatures}.
@@ -1327,11 +1337,19 @@ type FeaturesResponse = {
 type FormulaResponse = {
     value: number | null;
 };
-/** Response from {@link WidgetRemoteSource#getCategories}. */
-type CategoryResponse = {
-    name: string;
+/** Entry in the category widget response, see  {@link WidgetRemoteSource#getCategories}. */
+type CategoryResponseEntry = {
+    name: string | null;
     value: number;
-}[];
+};
+/** Response from {@link WidgetRemoteSource#getCategories}. */
+type CategoryResponse = CategoryResponseEntry[];
+type CategoryResponseRaw = {
+    rows: CategoryResponseEntry[] | null;
+    metadata?: {
+        others?: number;
+    };
+};
 /** Response from {@link WidgetRemoteSource#getRange}. */
 type RangeResponse = {
     min: number;
@@ -1613,7 +1631,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, orderBy, rawResult, }: 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>;
@@ -1734,6 +1752,13 @@ declare class WidgetTableSource extends WidgetRemoteSource<LayerTableSourceOptio
     protected getModelSource(filters: Filters | undefined, filterOwner?: string): ModelSource;
 }
 
+/**
+ * Name of the category that represents the "Others" category.
+ *
+ * See `WidgetSource.getCategories` for more information.
+ */
+declare const OTHERS_CATEGORY_NAME = "_carto_others";
+
 type H3QuerySourceOptions = SourceOptions & QuerySourceOptions & AggregationOptions & FilterOptions;
 type H3QuerySourceResponse = TilejsonResult & WidgetQuerySourceResult;
 declare const h3QuerySource: (options: H3QuerySourceOptions) => Promise<H3QuerySourceResponse>;
@@ -1812,19 +1837,22 @@ interface SortOptions {
 declare function applySorting(features: FeatureData[], { sortBy, sortByDirection, sortByColumnType, }?: SortOptions): FeatureData[];
 
 /** @privateRemarks Source: @carto/react-core */
-type GroupByFeature = {
-    name: string;
-    value: number;
-}[];
-/** @privateRemarks Source: @carto/react-core */
-declare function groupValuesByColumn({ data, valuesColumns, joinOperation, keysColumn, operation, }: {
+declare function groupValuesByColumn({ data, valuesColumns, joinOperation, keysColumn, operation, othersThreshold, orderBy, }: {
     data: FeatureData[];
     valuesColumns?: string[];
     joinOperation?: AggregationType;
     keysColumn: string;
     operation: AggregationType;
-}): GroupByFeature | null;
+    othersThreshold?: number;
+    orderBy?: CategoryOrderBy;
+}): CategoryResponseRaw | null;
+declare function getSorter(orderBy: CategoryOrderBy): (a: CategoryResponseEntry, b: CategoryResponseEntry) => number;
 
+/** @privateRemarks Source: @carto/react-core */
+type GroupByFeature = {
+    name: string;
+    value: number;
+}[];
 /** @privateRemarks Source: @carto/react-core */
 declare function groupValuesByDateColumn({ data, valuesColumns, joinOperation, keysColumn, groupType, operation, }: {
     data: Record<string, unknown>[];
@@ -1921,4 +1949,4 @@ declare function getColumnNameFromGeoColumn(geoColumn: string | null | undefined
  */
 declare function getSpatialIndexFromGeoColumn(geoColumn: string): SpatialIndex | null;
 
-export { type APIErrorContext, type APIRequestType, type AddFilterOptions, type AggregationFunction, type AggregationType, AggregationTypes, ApiVersion, type Attribute, _default as BASEMAP, type BaseRequestOptions, type Basemap, type BoundaryQuerySourceOptions, type BoundaryQuerySourceResponse, type BoundaryTableSourceOptions, type BoundaryTableSourceResponse, CartoAPIError, type CategoryRequestOptions, type CategoryResponse, CellSet, type ColumnsOption, type D3Scale, DEFAULT_API_BASE_URL, FEATURE_GEOM_PROPERTY, type FeaturesRequestOptions, type FeaturesResponse, type FetchMapOptions, type FetchMapResult, type Filter, type FilterFunction, type FilterInterval, type FilterIntervalComplete, type FilterIntervalExtremum, type FilterLogicalOperator, type FilterOptions, FilterType, type Filters, type Format, type FormulaRequestOptions, type FormulaResponse, type GetFilterOptions, type GoogleBasemap, type GroupByFeature, type GroupDateType, type H3QuerySourceOptions, type H3QuerySourceResponse, type H3TableSourceOptions, type H3TableSourceResponse, type H3TilesetSourceOptions, type H3TilesetSourceResponse, type HasFilterOptions, type HistogramRequestOptions, type HistogramResponse, type KeplerMapConfig, type Layer, type LayerDescriptor, type LayerType, type MapLibreBasemap, type MapType, type NamedQueryParameter, OPACITY_MAP, type ParseMapResult, type PositionalQueryParameter, Provider, type ProviderType, type QuadbinQuerySourceOptions, type QuadbinQuerySourceResponse, type QuadbinTableSourceOptions, type QuadbinTableSourceResponse, type QuadbinTilesetSourceOptions, type QuadbinTilesetSourceResponse, type QueryOptions, type QueryParameterValue, type QueryParameters, type QueryResult, type QuerySourceOptions, type RangeRequestOptions, type RangeResponse, type Raster, RasterBandColorinterp, type RasterBandType, type RasterMetadata, type RasterMetadataBand, type RasterMetadataBandStats, type RasterSourceOptions, type RasterTile, type RemoveFilterOptions, SOURCE_DEFAULTS, type Scale, type ScaleKey, type ScaleType, type ScatterPlotFeature, type ScatterRequestOptions, type ScatterResponse, type SchemaField, SchemaFieldType, type SortColumnType, type SortDirection, type SourceOptionalOptions, type SourceOptions, type SourceRequiredOptions, type SpatialDataType, type SpatialFilter, type SpatialFilterPolyfillMode, SpatialIndex, SpatialIndexColumn, type SpatialIndexTile, type StringSearchOptions, TEXT_LABEL_INDEX, TEXT_NUMBER_FORMATTER, TEXT_OUTLINE_OPACITY, type TableRequestOptions, type TableResponse, type TableSourceOptions, type Tile, type TileFeatureExtractOptions, type TileFeatures, type TileFeaturesSpatialIndexOptions, TileFormat, type TileResolution, type Tilejson, type TilejsonResult, type TilesetSourceOptions, type Tilestats, type TimeSeriesRequestOptions, type TimeSeriesResponse, type VectorLayer, type VectorQuerySourceOptions, type VectorQuerySourceResponse, type VectorTableSourceOptions, type VectorTableSourceResponse, type VectorTilesetSourceOptions, type VectorTilesetSourceResponse, type ViewState, type Viewport, WidgetQuerySource, type WidgetQuerySourceResult, WidgetRasterSource, type WidgetRasterSourceProps, type WidgetRasterSourceResult, WidgetRemoteSource, type WidgetRemoteSourceProps, WidgetSource, type WidgetSourceProps, WidgetTableSource, type WidgetTableSourceResult, WidgetTilesetSource, type WidgetTilesetSourceProps, type WidgetTilesetSourceResult, type _DataFilterExtensionProps, _buildFeatureFilter, domainFromValues as _domainFromValues, _getHexagonResolution, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildPublicMapUrl, buildStatsUrl, calculateClusterRadius, calculateClusterTextFontSize, clearDefaultRequestCache, clearFilters, configureSource, createPolygonSpatialFilter, createViewportSpatialFilter, fetchBasemapProps, fetchMap, filterFunctions, geojsonFeatures, getApplicableFilters, getClient, getColorAccessor, getColumnNameFromGeoColumn, getDataFilterExtensionProps, getDefaultAggregationExpColumnAliasForLayerType, getFilter, getIconUrlAccessor, getLayerProps, getMaxMarkerSize, getSizeAccessor, getSpatialIndexFromGeoColumn, getTextAccessor, groupValuesByColumn, groupValuesByDateColumn, h3QuerySource, h3TableSource, h3TilesetSource, hasFilter, histogram, makeIntervalComplete, negateAccessor, opacityToAlpha, parseMap, quadbinQuerySource, quadbinTableSource, quadbinTilesetSource, query, rasterSource, removeFilter, requestWithParameters, scaleAggregationResLevel, scatterPlot, setClient, tileFeatures, tileFeaturesGeometries, tileFeaturesSpatialIndex, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };
+export { type APIErrorContext, type APIRequestType, type AddFilterOptions, type AggregationFunction, type AggregationType, AggregationTypes, ApiVersion, type Attribute, _default as BASEMAP, type BaseRequestOptions, type Basemap, type BoundaryQuerySourceOptions, type BoundaryQuerySourceResponse, type BoundaryTableSourceOptions, type BoundaryTableSourceResponse, CartoAPIError, type CategoryOrderBy, type CategoryRequestOptions, type CategoryResponse, type CategoryResponseEntry, type CategoryResponseRaw, CellSet, type ColumnsOption, type D3Scale, DEFAULT_API_BASE_URL, FEATURE_GEOM_PROPERTY, type FeaturesRequestOptions, type FeaturesResponse, type FetchMapOptions, type FetchMapResult, type Filter, type FilterFunction, type FilterInterval, type FilterIntervalComplete, type FilterIntervalExtremum, type FilterLogicalOperator, type FilterOptions, FilterType, type Filters, type Format, type FormulaRequestOptions, type FormulaResponse, type GetFilterOptions, type GoogleBasemap, type GroupByFeature, type GroupDateType, type H3QuerySourceOptions, type H3QuerySourceResponse, type H3TableSourceOptions, type H3TableSourceResponse, type H3TilesetSourceOptions, type H3TilesetSourceResponse, type HasFilterOptions, type HistogramRequestOptions, type HistogramResponse, type KeplerMapConfig, type Layer, type LayerDescriptor, type LayerType, type MapLibreBasemap, type MapType, type NamedQueryParameter, OPACITY_MAP, OTHERS_CATEGORY_NAME, type ParseMapResult, type PositionalQueryParameter, Provider, type ProviderType, type QuadbinQuerySourceOptions, type QuadbinQuerySourceResponse, type QuadbinTableSourceOptions, type QuadbinTableSourceResponse, type QuadbinTilesetSourceOptions, type QuadbinTilesetSourceResponse, type QueryOptions, type QueryParameterValue, type QueryParameters, type QueryResult, type QuerySourceOptions, type RangeRequestOptions, type RangeResponse, type Raster, RasterBandColorinterp, type RasterBandType, type RasterMetadata, type RasterMetadataBand, type RasterMetadataBandStats, type RasterSourceOptions, type RasterTile, type RemoveFilterOptions, SOURCE_DEFAULTS, type Scale, type ScaleKey, type ScaleType, type ScatterPlotFeature, type ScatterRequestOptions, type ScatterResponse, type SchemaField, SchemaFieldType, type SortColumnType, type SortDirection, type SourceOptionalOptions, type SourceOptions, type SourceRequiredOptions, type SpatialDataType, type SpatialFilter, type SpatialFilterPolyfillMode, SpatialIndex, SpatialIndexColumn, type SpatialIndexTile, type StringSearchOptions, TEXT_LABEL_INDEX, TEXT_NUMBER_FORMATTER, TEXT_OUTLINE_OPACITY, type TableRequestOptions, type TableResponse, type TableSourceOptions, type Tile, type TileFeatureExtractOptions, type TileFeatures, type TileFeaturesSpatialIndexOptions, TileFormat, type TileResolution, type Tilejson, type TilejsonResult, type TilesetSourceOptions, type Tilestats, type TimeSeriesRequestOptions, type TimeSeriesResponse, type VectorLayer, type VectorQuerySourceOptions, type VectorQuerySourceResponse, type VectorTableSourceOptions, type VectorTableSourceResponse, type VectorTilesetSourceOptions, type VectorTilesetSourceResponse, type ViewState, type Viewport, WidgetQuerySource, type WidgetQuerySourceResult, WidgetRasterSource, type WidgetRasterSourceProps, type WidgetRasterSourceResult, WidgetRemoteSource, type WidgetRemoteSourceProps, WidgetSource, type WidgetSourceProps, WidgetTableSource, type WidgetTableSourceResult, WidgetTilesetSource, type WidgetTilesetSourceProps, type WidgetTilesetSourceResult, type _DataFilterExtensionProps, _buildFeatureFilter, domainFromValues as _domainFromValues, _getHexagonResolution, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildPublicMapUrl, buildStatsUrl, calculateClusterRadius, calculateClusterTextFontSize, clearDefaultRequestCache, clearFilters, configureSource, createPolygonSpatialFilter, createViewportSpatialFilter, fetchBasemapProps, fetchMap, filterFunctions, geojsonFeatures, getApplicableFilters, getClient, getColorAccessor, getColumnNameFromGeoColumn, getDataFilterExtensionProps, getDefaultAggregationExpColumnAliasForLayerType, getFilter, getIconUrlAccessor, getLayerProps, getMaxMarkerSize, getSizeAccessor, getSorter, getSpatialIndexFromGeoColumn, getTextAccessor, groupValuesByColumn, groupValuesByDateColumn, h3QuerySource, h3TableSource, h3TilesetSource, hasFilter, histogram, makeIntervalComplete, negateAccessor, opacityToAlpha, parseMap, quadbinQuerySource, quadbinTableSource, quadbinTilesetSource, query, rasterSource, removeFilter, requestWithParameters, scaleAggregationResLevel, scatterPlot, setClient, tileFeatures, tileFeaturesGeometries, tileFeaturesSpatialIndex, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };

package/build/api-client.js

@@ -6292,6 +6292,9 @@ function getApplicableFilters(owner, filters) {
   return applicableFilters;
 }
 
+// src/widget-sources/constants.ts
+var OTHERS_CATEGORY_NAME = "_carto_others";
+
 // src/widget-sources/widget-remote-source.ts
 var WidgetRemoteSource = class extends WidgetSource {
   _getModelSource(filters, filterOwner) {
@@ -6315,13 +6318,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),
@@ -6332,10 +6343,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 {
@@ -6728,10 +6752,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];
@@ -6746,13 +6772,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/utils/dateUtils.ts
@@ -7315,7 +7372,10 @@ var WidgetTilesetSourceImpl = class extends WidgetSource {
     joinOperation,
     filters,
     filterOwner,
-    spatialFilter
+    spatialFilter,
+    othersThreshold,
+    orderBy = "frequency_desc",
+    rawResult
   }) {
     const filteredFeatures = this._getFilteredFeatures(
       spatialFilter,
@@ -7326,14 +7386,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,
@@ -10079,6 +10150,7 @@ export {
   FEATURE_GEOM_PROPERTY,
   FilterType,
   OPACITY_MAP,
+  OTHERS_CATEGORY_NAME,
   Provider,
   SOURCE_DEFAULTS,
   SchemaFieldType,
@@ -10129,6 +10201,7 @@ export {
   getLayerProps,
   getMaxMarkerSize,
   getSizeAccessor,
+  getSorter,
   getSpatialIndexFromGeoColumn,
   getTextAccessor,
   groupValuesByColumn,