@carto/api-client 0.5.9-alpha.PR193.3 → 0.5.9-alpha.orderby.1

package/build/api-client.d.cts

@@ -388,8 +388,6 @@ type SourceOptionalOptions = {
      * By default, local in-memory caching is enabled.
      */
     localCache?: LocalCacheOptions;
-    /** Additional tags appended to HTTP requests, available for analytics and audits. */
-    tags?: Record<string, string>;
 };
 type LocalCacheOptions = {
     /**
@@ -689,26 +687,16 @@ type QueryResult = {
     }[];
 };
 
-type QueryOptions = SourceOptions & QuerySourceOptions & {
-    /**
-     * @internal
-     * @experimental
-     * Used to append additional parameters to the SQL API request for features specific to providers or integrations.
-     */
-    internalParameters?: Record<string, string | boolean | number>;
-    /** Used to abort the request. */
-    signal?: AbortSignal;
-};
+type QueryOptions = SourceOptions & QuerySourceOptions;
 declare const query: (options: QueryOptions) => Promise<QueryResult>;
 
-declare function requestWithParameters<T = any>({ baseUrl, parameters, headers: customHeaders, errorContext, maxLengthURL, localCache, signal, }: {
+declare function requestWithParameters<T = any>({ baseUrl, parameters, headers: customHeaders, errorContext, maxLengthURL, localCache, }: {
     baseUrl: string;
     parameters?: Record<string, unknown>;
     headers?: Record<string, string>;
     errorContext: APIErrorContext;
     maxLengthURL?: number;
     localCache?: LocalCacheOptions;
-    signal?: AbortSignal;
 }): Promise<T>;
 /**
  * Clears the HTTP response cache for all requests using the default cache.
@@ -1177,6 +1165,7 @@ interface BaseRequestOptions {
     filters?: Filters;
     filterOwner?: string;
 }
+type CategoryOrderBy = 'frequency_asc' | 'frequency_desc' | 'alphabetical_asc' | 'alphabetical_desc';
 /**
  * Examples:
  *   * population by state
@@ -1207,6 +1196,11 @@ interface CategoryRequestOptions extends BaseRequestOptions {
     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;
 }
@@ -1343,6 +1337,7 @@ type FeaturesResponse = {
 type FormulaResponse = {
     value: number | null;
 };
+/** Entry in the category widget response, see  {@link WidgetRemoteSource#getCategories}. */
 type CategoryResponseEntry = {
     name: string | null;
     value: number;
@@ -1462,7 +1457,6 @@ interface ModelSource {
     spatialDataColumn?: string;
     spatialDataType?: SpatialDataType;
     spatialFiltersMode?: SpatialFilterPolyfillMode;
-    tags?: Record<string, string>;
 }
 
 type WidgetRemoteSourceProps = WidgetSourceProps;
@@ -1637,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, othersThreshold, rawResult, }: 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>;
@@ -1843,14 +1837,16 @@ interface SortOptions {
 declare function applySorting(features: FeatureData[], { sortBy, sortByDirection, sortByColumnType, }?: SortOptions): FeatureData[];
 
 /** @privateRemarks Source: @carto/react-core */
-declare function groupValuesByColumn({ data, valuesColumns, joinOperation, keysColumn, operation, othersThreshold, }: {
+declare function groupValuesByColumn({ data, valuesColumns, joinOperation, keysColumn, operation, othersThreshold, orderBy, }: {
     data: FeatureData[];
     valuesColumns?: string[];
     joinOperation?: AggregationType;
     keysColumn: string;
     operation: AggregationType;
     othersThreshold?: number;
+    orderBy?: CategoryOrderBy;
 }): CategoryResponseRaw | null;
+declare function getSorter(orderBy: CategoryOrderBy): (a: CategoryResponseEntry, b: CategoryResponseEntry) => number;
 
 /** @privateRemarks Source: @carto/react-core */
 type GroupByFeature = {
@@ -1953,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, 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, 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

@@ -388,8 +388,6 @@ type SourceOptionalOptions = {
      * By default, local in-memory caching is enabled.
      */
     localCache?: LocalCacheOptions;
-    /** Additional tags appended to HTTP requests, available for analytics and audits. */
-    tags?: Record<string, string>;
 };
 type LocalCacheOptions = {
     /**
@@ -689,26 +687,16 @@ type QueryResult = {
     }[];
 };
 
-type QueryOptions = SourceOptions & QuerySourceOptions & {
-    /**
-     * @internal
-     * @experimental
-     * Used to append additional parameters to the SQL API request for features specific to providers or integrations.
-     */
-    internalParameters?: Record<string, string | boolean | number>;
-    /** Used to abort the request. */
-    signal?: AbortSignal;
-};
+type QueryOptions = SourceOptions & QuerySourceOptions;
 declare const query: (options: QueryOptions) => Promise<QueryResult>;
 
-declare function requestWithParameters<T = any>({ baseUrl, parameters, headers: customHeaders, errorContext, maxLengthURL, localCache, signal, }: {
+declare function requestWithParameters<T = any>({ baseUrl, parameters, headers: customHeaders, errorContext, maxLengthURL, localCache, }: {
     baseUrl: string;
     parameters?: Record<string, unknown>;
     headers?: Record<string, string>;
     errorContext: APIErrorContext;
     maxLengthURL?: number;
     localCache?: LocalCacheOptions;
-    signal?: AbortSignal;
 }): Promise<T>;
 /**
  * Clears the HTTP response cache for all requests using the default cache.
@@ -1177,6 +1165,7 @@ interface BaseRequestOptions {
     filters?: Filters;
     filterOwner?: string;
 }
+type CategoryOrderBy = 'frequency_asc' | 'frequency_desc' | 'alphabetical_asc' | 'alphabetical_desc';
 /**
  * Examples:
  *   * population by state
@@ -1207,6 +1196,11 @@ interface CategoryRequestOptions extends BaseRequestOptions {
     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;
 }
@@ -1343,6 +1337,7 @@ type FeaturesResponse = {
 type FormulaResponse = {
     value: number | null;
 };
+/** Entry in the category widget response, see  {@link WidgetRemoteSource#getCategories}. */
 type CategoryResponseEntry = {
     name: string | null;
     value: number;
@@ -1462,7 +1457,6 @@ interface ModelSource {
     spatialDataColumn?: string;
     spatialDataType?: SpatialDataType;
     spatialFiltersMode?: SpatialFilterPolyfillMode;
-    tags?: Record<string, string>;
 }
 
 type WidgetRemoteSourceProps = WidgetSourceProps;
@@ -1637,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, othersThreshold, rawResult, }: 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>;
@@ -1843,14 +1837,16 @@ interface SortOptions {
 declare function applySorting(features: FeatureData[], { sortBy, sortByDirection, sortByColumnType, }?: SortOptions): FeatureData[];
 
 /** @privateRemarks Source: @carto/react-core */
-declare function groupValuesByColumn({ data, valuesColumns, joinOperation, keysColumn, operation, othersThreshold, }: {
+declare function groupValuesByColumn({ data, valuesColumns, joinOperation, keysColumn, operation, othersThreshold, orderBy, }: {
     data: FeatureData[];
     valuesColumns?: string[];
     joinOperation?: AggregationType;
     keysColumn: string;
     operation: AggregationType;
     othersThreshold?: number;
+    orderBy?: CategoryOrderBy;
 }): CategoryResponseRaw | null;
+declare function getSorter(orderBy: CategoryOrderBy): (a: CategoryResponseEntry, b: CategoryResponseEntry) => number;
 
 /** @privateRemarks Source: @carto/react-core */
 type GroupByFeature = {
@@ -1953,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, 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, 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

@@ -5839,8 +5839,7 @@ async function requestWithParameters({
   headers: customHeaders = {},
   errorContext,
   maxLengthURL = DEFAULT_MAX_LENGTH_URL,
-  localCache,
-  signal
+  localCache
 }) {
   parameters = {
     v: V3_MINOR_VERSION,
@@ -5863,9 +5862,8 @@ async function requestWithParameters({
   const fetchPromise = url.length > maxLengthURL ? fetch(baseUrl, {
     method: "POST",
     body: JSON.stringify(parameters),
-    headers,
-    signal
-  }) : fetch(url, { headers, signal });
+    headers
+  }) : fetch(url, { headers });
   let response;
   let responseJson;
   const jsonPromise = fetchPromise.then((_response) => {
@@ -5917,12 +5915,10 @@ function createURLWithParameters(baseUrlString, parameters) {
     if (isPureObject(value) || Array.isArray(value)) {
       baseUrl.searchParams.set(key, JSON.stringify(value));
     } else {
-      if (value !== null && value !== void 0) {
-        baseUrl.searchParams.set(
-          key,
-          value.toString()
-        );
-      }
+      baseUrl.searchParams.set(
+        key,
+        value.toString()
+      );
     }
   }
   return baseUrl.toString();
@@ -5966,7 +5962,7 @@ async function baseSource(endpoint, options, urlParameters) {
     Authorization: `Bearer ${options.accessToken}`,
     ...options.headers
   };
-  const parameters = { client: clientId, ...options.tags, ...urlParameters };
+  const parameters = { client: clientId, ...urlParameters };
   const errorContext = {
     requestType: "Map instantiation",
     connection: options.connectionName,
@@ -6168,8 +6164,7 @@ function executeModel(props) {
     filtersLogicalOperator = "and",
     spatialDataType = "geo",
     spatialDataColumn = DEFAULT_GEO_COLUMN,
-    spatialFiltersMode = "intersects",
-    tags
+    spatialFiltersMode = "intersects"
   } = source;
   const queryParams = {
     type,
@@ -6178,8 +6173,7 @@ function executeModel(props) {
     params,
     queryParameters: source.queryParameters || "",
     filters,
-    filtersLogicalOperator,
-    ...tags ?? {}
+    filtersLogicalOperator
   };
   queryParams.spatialDataType = spatialDataType;
   queryParams.spatialDataColumn = spatialDataColumn;
@@ -6312,8 +6306,7 @@ var WidgetRemoteSource = class extends WidgetSource {
       filters: getApplicableFilters(filterOwner, filters || props.filters),
       filtersLogicalOperator: props.filtersLogicalOperator,
       spatialDataType: props.spatialDataType,
-      spatialDataColumn: props.spatialDataColumn,
-      tags: props.tags
+      spatialDataColumn: props.spatialDataColumn
     };
   }
   async getCategories(options) {
@@ -6326,7 +6319,14 @@ var WidgetRemoteSource = class extends WidgetSource {
       rawResult,
       ...params
     } = options;
-    const { column, operation: operation2, operationColumn, operationExp, othersThreshold } = params;
+    const {
+      column,
+      operation: operation2,
+      operationColumn,
+      operationExp,
+      othersThreshold,
+      orderBy
+    } = params;
     if (operation2 === AggregationTypes.Custom) {
       assert2(operationExp, "operationExp is required for custom operation");
     }
@@ -6342,7 +6342,8 @@ var WidgetRemoteSource = class extends WidgetSource {
         operation: operation2,
         operationExp,
         operationColumn: operationColumn || column,
-        othersThreshold
+        othersThreshold,
+        orderBy
       },
       opts: { signal, headers: this.props.headers }
     });
@@ -6750,7 +6751,8 @@ function groupValuesByColumn({
   joinOperation,
   keysColumn,
   operation: operation2,
-  othersThreshold
+  othersThreshold,
+  orderBy = "frequency_desc"
 }) {
   if (Array.isArray(data) && data.length === 0) {
     return { rows: null };
@@ -6774,7 +6776,7 @@ function groupValuesByColumn({
   const allCategories = Array.from(groups).map(([name, value]) => ({
     name,
     value: targetOperation(value)
-  })).sort((a, b) => b.value - a.value);
+  })).sort(getSorter(orderBy));
   if (othersThreshold && allCategories.length > othersThreshold) {
     const otherValue = allCategories.slice(othersThreshold).flatMap(({ name }) => groups.get(name));
     return {
@@ -6788,6 +6790,21 @@ function groupValuesByColumn({
     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;
+  }
+}
+function localeCompare(a, b) {
+  return (a ?? "null").localeCompare(b ?? "null");
+}
 
 // src/utils/dateUtils.ts
 function getUTCMonday(date) {
@@ -7351,6 +7368,7 @@ var WidgetTilesetSourceImpl = class extends WidgetSource {
     filterOwner,
     spatialFilter,
     othersThreshold,
+    orderBy = "frequency_desc",
     rawResult
   }) {
     const filteredFeatures = this._getFilteredFeatures(
@@ -7368,7 +7386,8 @@ var WidgetTilesetSourceImpl = class extends WidgetSource {
       joinOperation,
       keysColumn: column,
       operation: operation2,
-      othersThreshold
+      othersThreshold,
+      orderBy
     });
     if (rawResult) {
       return result;
@@ -8090,8 +8109,7 @@ var query = async function(options) {
     localCache,
     connectionName,
     sqlQuery,
-    queryParameters,
-    internalParameters
+    queryParameters
   } = options;
   const urlParameters = { q: sqlQuery };
   if (queryParameters) {
@@ -8102,12 +8120,7 @@ var query = async function(options) {
     Authorization: `Bearer ${options.accessToken}`,
     ...options.headers
   };
-  const parameters = {
-    client: clientId,
-    ...options.tags,
-    ...internalParameters,
-    ...urlParameters
-  };
+  const parameters = { client: clientId, ...urlParameters };
   const errorContext = {
     requestType: "SQL",
     connection: options.connectionName,
@@ -8120,8 +8133,7 @@ var query = async function(options) {
     headers,
     errorContext,
     maxLengthURL,
-    localCache,
-    signal: options.signal
+    localCache
   });
 };
 
@@ -10183,6 +10195,7 @@ export {
   getLayerProps,
   getMaxMarkerSize,
   getSizeAccessor,
+  getSorter,
   getSpatialIndexFromGeoColumn,
   getTextAccessor,
   groupValuesByColumn,