@carto/api-client 0.5.28 → 0.5.30-alpha.143d135.117

package/build/api-client.d.cts

@@ -184,8 +184,30 @@ type AggregationType = 'count' | 'avg' | 'min' | 'max' | 'sum' | 'custom';
 /******************************************************************************
  * FILTERS
  */
+/** A spatial filter expressed as a GeoJSON polygon, applied client- or server-side. */
+type GeometrySpatialFilter = Polygon | MultiPolygon;
+/**
+ * Filter restricting a widget query to a set of spatial-index cells (H3 or
+ * Quadbin). Used for point-and-click selection on cell-rendered layers. Sent to
+ * the server-side model API only; maps-api chooses the SQL strategy from
+ * `spatialDataType`, so the same payload works for both natively-indexed
+ * sources and point/geometry sources dynamically aggregated into cells.
+ *
+ * @privateRemarks Source: @carto/query-builder (SpatialIndexFilter)
+ */
+interface SpatialIndexFilter {
+    /**
+     * Selected cell ids. h3 = hex string; h3int = `BigInt(\`0x${id}\`)`; quadbin
+     * = decimal or `0x`-hex string.
+     */
+    indexes: string[];
+    /** Must match the column type; `h3` and `h3int` are interchangeable. */
+    type: 'h3' | 'h3int' | 'quadbin';
+}
 /** @privateRemarks Source: @carto/react-api */
-type SpatialFilter = Polygon | MultiPolygon;
+type SpatialFilter = GeometrySpatialFilter | SpatialIndexFilter;
+/** True when a {@link SpatialFilter} selects spatial-index cells rather than a polygon. */
+declare function isSpatialIndexFilter(spatialFilter: SpatialFilter): spatialFilter is SpatialIndexFilter;
 /** @privateRemarks Source: @deck.gl/carto */
 interface Filters {
     [column: string]: Filter;
@@ -1040,6 +1062,7 @@ type Dataset = {
     name?: string | null;
     spatialIndex?: string | null;
     exportToBucketAvailable?: boolean;
+    featureBbox?: boolean;
 };
 
 type StyleLayerGroupSlug = 'label' | 'road' | 'border' | 'building' | 'water' | 'land';
@@ -1760,7 +1783,7 @@ declare const filterFunctions: Record<FilterType, FilterFunction>;
 
 declare function geojsonFeatures({ geojson, spatialFilter, uniqueIdProperty, }: {
     geojson: FeatureCollection;
-    spatialFilter: SpatialFilter;
+    spatialFilter: GeometrySpatialFilter;
     uniqueIdProperty?: string;
 }): FeatureData[];
 
@@ -1770,7 +1793,7 @@ type TileFeatures = {
     tileFormat: TileFormat;
     spatialDataType: SpatialDataType;
     spatialDataColumn?: string;
-    spatialFilter?: SpatialFilter;
+    spatialFilter?: GeometrySpatialFilter;
     uniqueIdProperty?: string;
     rasterMetadata?: RasterMetadata;
     storeGeometry?: boolean;
@@ -1792,14 +1815,14 @@ type GeometryExtractOptions = {
 declare function tileFeaturesGeometries({ tiles, tileFormat, spatialFilter, uniqueIdProperty, options, }: {
     tiles: Tile[];
     tileFormat?: TileFormat;
-    spatialFilter?: SpatialFilter;
+    spatialFilter?: GeometrySpatialFilter;
     uniqueIdProperty?: string;
     options?: GeometryExtractOptions;
 }): FeatureData[];
 
 type TileFeaturesSpatialIndexOptions = {
     tiles: SpatialIndexTile[];
-    spatialFilter?: SpatialFilter;
+    spatialFilter?: GeometrySpatialFilter;
     spatialDataColumn: string;
     spatialDataType: SpatialDataType;
 };
@@ -1846,7 +1869,7 @@ declare class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePr
      */
     loadGeoJSON({ geojson, spatialFilter, }: {
         geojson: FeatureCollection;
-        spatialFilter: SpatialFilter;
+        spatialFilter: GeometrySpatialFilter;
     }): void;
     getFeatures(): Promise<FeaturesResponse>;
     getFormula({ column, operation, joinOperation, filters, filterOwner, spatialFilter, }: FormulaRequestOptions): Promise<FormulaResponse>;
@@ -1927,7 +1950,7 @@ declare class WidgetTilesetSource<Props extends WidgetTilesetSourceProps = Widge
      */
     loadGeoJSON({ geojson, spatialFilter, }: {
         geojson: FeatureCollection;
-        spatialFilter: SpatialFilter;
+        spatialFilter: GeometrySpatialFilter;
     }): void;
     getFeatures(): Promise<FeaturesResponse>;
     getFormula({ signal, ...options }: FormulaRequestOptions): Promise<FormulaResponse>;
@@ -1993,11 +2016,27 @@ type VectorTilesetSourceOptions = SourceOptions & TilesetSourceOptions;
 type VectorTilesetSourceResponse = TilejsonResult & WidgetTilesetSourceResult;
 declare const vectorTilesetSource: (options: VectorTilesetSourceOptions) => Promise<VectorTilesetSourceResponse>;
 
-type VectorTableSourceOptions = SourceOptions & TableSourceOptions & FilterOptions & ColumnsOption;
+type VectorTableSourceOptions = SourceOptions & TableSourceOptions & FilterOptions & ColumnsOption & {
+    /**
+     * If `true`, the server includes a `_carto_bbox` property on each polygon
+     * feature, containing the bounding box of the full (unclipped) geometry as
+     * a `"west,south,east,north"` string in WGS84. Used by clients to compute
+     * stable label positions for polygons that span multiple tiles.
+     */
+    featureBbox?: boolean;
+};
 type VectorTableSourceResponse = TilejsonResult & WidgetTableSourceResult;
 declare const vectorTableSource: (options: VectorTableSourceOptions) => Promise<VectorTableSourceResponse>;
 
-type VectorQuerySourceOptions = SourceOptions & QuerySourceOptions & FilterOptions & ColumnsOption;
+type VectorQuerySourceOptions = SourceOptions & QuerySourceOptions & FilterOptions & ColumnsOption & {
+    /**
+     * If `true`, the server includes a `_carto_bbox` property on each polygon
+     * feature, containing the bounding box of the full (unclipped) geometry as
+     * a `"west,south,east,north"` string in WGS84. Used by clients to compute
+     * stable label positions for polygons that span multiple tiles.
+     */
+    featureBbox?: boolean;
+};
 type VectorQuerySourceResponse = TilejsonResult & WidgetQuerySourceResult;
 declare const vectorQuerySource: (options: VectorQuerySourceOptions) => Promise<VectorQuerySourceResponse>;
 
@@ -2238,4 +2277,4 @@ declare function getColumnNameFromGeoColumn(geoColumn: string | null | undefined
  */
 declare function getSpatialIndexFromGeoColumn(geoColumn: string): SpatialIndex | null;
 
-export { type APIErrorContext, type APIRequestType, AUDIT_TAGS, type AddFilterOptions, type AggregationFunction, type AggregationType, AggregationTypes, type AggregationsRequestOptions, type AggregationsResponse, ApiVersion, type Attribute, _default as BASEMAP, type BaseRequestOptions, type Basemap, type BoundaryQuerySourceOptions, type BoundaryQuerySourceResponse, type BoundaryTableSourceOptions, type BoundaryTableSourceResponse, CARTO_SOURCES, CartoAPIError, type CategoryOrderBy, type CategoryRequestOptions, type CategoryResponse, type CategoryResponseEntry, type CategoryResponseRaw, CellSet, type ColumnsOption, type D3Scale, DEFAULT_API_BASE_URL, type ExtentRequestOptions, type ExtentResponse, 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 Scales, 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 TrajectoryQuerySourceOptions, type TrajectoryQuerySourceResponse, type TrajectoryTableSourceOptions, type TrajectoryTableSourceResponse, 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, ErrorCode as _ErrorCode, type VecExprResult as _VecExprResult, applyLayerGroupFilters as _applyLayerGroupFilters, _buildFeatureFilter, createVecExprEvaluator as _createVecExprEvaluator, domainFromValues as _domainFromValues, evaluateVecExpr as _evaluateVecExpr, fillInMapDatasets as _fillInMapDatasets, fillInTileStats as _fillInTileStats, _getHexagonResolution, getLog10ScaleSteps as _getLog10ScaleSteps, getRasterTileLayerStyleProps as _getRasterTileLayerStyleProps, validateVecExprSyntax as _validateVecExprSyntax, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildPublicMapUrl, buildStatsUrl, calculateClusterRadius, calculateClusterTextFontSize, calculateLayerScale, clearDefaultRequestCache, clearFilters, compileCustomAggregation, configureSource, createColorScale, createPolygonSpatialFilter, createViewportSpatialFilter, fetchBasemapProps, fetchMap, filterFunctions, geojsonFeatures, getApplicableFilters, getClient, getColorAccessor, getColumnNameFromGeoColumn, getDataFilterExtensionProps, getDefaultAggregationExpColumnAliasForLayerType, getFilter, getIconUrlAccessor, getLayerDescriptor, 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, trajectoryQuerySource, trajectoryTableSource, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };
+export { type APIErrorContext, type APIRequestType, AUDIT_TAGS, type AddFilterOptions, type AggregationFunction, type AggregationType, AggregationTypes, type AggregationsRequestOptions, type AggregationsResponse, ApiVersion, type Attribute, _default as BASEMAP, type BaseRequestOptions, type Basemap, type BoundaryQuerySourceOptions, type BoundaryQuerySourceResponse, type BoundaryTableSourceOptions, type BoundaryTableSourceResponse, CARTO_SOURCES, CartoAPIError, type CategoryOrderBy, type CategoryRequestOptions, type CategoryResponse, type CategoryResponseEntry, type CategoryResponseRaw, CellSet, type ColumnsOption, type D3Scale, DEFAULT_API_BASE_URL, type ExtentRequestOptions, type ExtentResponse, 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 GeometrySpatialFilter, 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 Scales, 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 SpatialIndexFilter, 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 TrajectoryQuerySourceOptions, type TrajectoryQuerySourceResponse, type TrajectoryTableSourceOptions, type TrajectoryTableSourceResponse, 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, ErrorCode as _ErrorCode, type VecExprResult as _VecExprResult, applyLayerGroupFilters as _applyLayerGroupFilters, _buildFeatureFilter, createVecExprEvaluator as _createVecExprEvaluator, domainFromValues as _domainFromValues, evaluateVecExpr as _evaluateVecExpr, fillInMapDatasets as _fillInMapDatasets, fillInTileStats as _fillInTileStats, _getHexagonResolution, getLog10ScaleSteps as _getLog10ScaleSteps, getRasterTileLayerStyleProps as _getRasterTileLayerStyleProps, validateVecExprSyntax as _validateVecExprSyntax, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildPublicMapUrl, buildStatsUrl, calculateClusterRadius, calculateClusterTextFontSize, calculateLayerScale, clearDefaultRequestCache, clearFilters, compileCustomAggregation, configureSource, createColorScale, createPolygonSpatialFilter, createViewportSpatialFilter, fetchBasemapProps, fetchMap, filterFunctions, geojsonFeatures, getApplicableFilters, getClient, getColorAccessor, getColumnNameFromGeoColumn, getDataFilterExtensionProps, getDefaultAggregationExpColumnAliasForLayerType, getFilter, getIconUrlAccessor, getLayerDescriptor, getLayerProps, getMaxMarkerSize, getSizeAccessor, getSorter, getSpatialIndexFromGeoColumn, getTextAccessor, groupValuesByColumn, groupValuesByDateColumn, h3QuerySource, h3TableSource, h3TilesetSource, hasFilter, histogram, isSpatialIndexFilter, makeIntervalComplete, negateAccessor, opacityToAlpha, parseMap, quadbinQuerySource, quadbinTableSource, quadbinTilesetSource, query, rasterSource, removeFilter, requestWithParameters, scaleAggregationResLevel, scatterPlot, setClient, tileFeatures, tileFeaturesGeometries, tileFeaturesSpatialIndex, trajectoryQuerySource, trajectoryTableSource, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };

package/build/api-client.d.ts

@@ -184,8 +184,30 @@ type AggregationType = 'count' | 'avg' | 'min' | 'max' | 'sum' | 'custom';
 /******************************************************************************
  * FILTERS
  */
+/** A spatial filter expressed as a GeoJSON polygon, applied client- or server-side. */
+type GeometrySpatialFilter = Polygon | MultiPolygon;
+/**
+ * Filter restricting a widget query to a set of spatial-index cells (H3 or
+ * Quadbin). Used for point-and-click selection on cell-rendered layers. Sent to
+ * the server-side model API only; maps-api chooses the SQL strategy from
+ * `spatialDataType`, so the same payload works for both natively-indexed
+ * sources and point/geometry sources dynamically aggregated into cells.
+ *
+ * @privateRemarks Source: @carto/query-builder (SpatialIndexFilter)
+ */
+interface SpatialIndexFilter {
+    /**
+     * Selected cell ids. h3 = hex string; h3int = `BigInt(\`0x${id}\`)`; quadbin
+     * = decimal or `0x`-hex string.
+     */
+    indexes: string[];
+    /** Must match the column type; `h3` and `h3int` are interchangeable. */
+    type: 'h3' | 'h3int' | 'quadbin';
+}
 /** @privateRemarks Source: @carto/react-api */
-type SpatialFilter = Polygon | MultiPolygon;
+type SpatialFilter = GeometrySpatialFilter | SpatialIndexFilter;
+/** True when a {@link SpatialFilter} selects spatial-index cells rather than a polygon. */
+declare function isSpatialIndexFilter(spatialFilter: SpatialFilter): spatialFilter is SpatialIndexFilter;
 /** @privateRemarks Source: @deck.gl/carto */
 interface Filters {
     [column: string]: Filter;
@@ -1040,6 +1062,7 @@ type Dataset = {
     name?: string | null;
     spatialIndex?: string | null;
     exportToBucketAvailable?: boolean;
+    featureBbox?: boolean;
 };
 
 type StyleLayerGroupSlug = 'label' | 'road' | 'border' | 'building' | 'water' | 'land';
@@ -1760,7 +1783,7 @@ declare const filterFunctions: Record<FilterType, FilterFunction>;
 
 declare function geojsonFeatures({ geojson, spatialFilter, uniqueIdProperty, }: {
     geojson: FeatureCollection;
-    spatialFilter: SpatialFilter;
+    spatialFilter: GeometrySpatialFilter;
     uniqueIdProperty?: string;
 }): FeatureData[];
 
@@ -1770,7 +1793,7 @@ type TileFeatures = {
     tileFormat: TileFormat;
     spatialDataType: SpatialDataType;
     spatialDataColumn?: string;
-    spatialFilter?: SpatialFilter;
+    spatialFilter?: GeometrySpatialFilter;
     uniqueIdProperty?: string;
     rasterMetadata?: RasterMetadata;
     storeGeometry?: boolean;
@@ -1792,14 +1815,14 @@ type GeometryExtractOptions = {
 declare function tileFeaturesGeometries({ tiles, tileFormat, spatialFilter, uniqueIdProperty, options, }: {
     tiles: Tile[];
     tileFormat?: TileFormat;
-    spatialFilter?: SpatialFilter;
+    spatialFilter?: GeometrySpatialFilter;
     uniqueIdProperty?: string;
     options?: GeometryExtractOptions;
 }): FeatureData[];
 
 type TileFeaturesSpatialIndexOptions = {
     tiles: SpatialIndexTile[];
-    spatialFilter?: SpatialFilter;
+    spatialFilter?: GeometrySpatialFilter;
     spatialDataColumn: string;
     spatialDataType: SpatialDataType;
 };
@@ -1846,7 +1869,7 @@ declare class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePr
      */
     loadGeoJSON({ geojson, spatialFilter, }: {
         geojson: FeatureCollection;
-        spatialFilter: SpatialFilter;
+        spatialFilter: GeometrySpatialFilter;
     }): void;
     getFeatures(): Promise<FeaturesResponse>;
     getFormula({ column, operation, joinOperation, filters, filterOwner, spatialFilter, }: FormulaRequestOptions): Promise<FormulaResponse>;
@@ -1927,7 +1950,7 @@ declare class WidgetTilesetSource<Props extends WidgetTilesetSourceProps = Widge
      */
     loadGeoJSON({ geojson, spatialFilter, }: {
         geojson: FeatureCollection;
-        spatialFilter: SpatialFilter;
+        spatialFilter: GeometrySpatialFilter;
     }): void;
     getFeatures(): Promise<FeaturesResponse>;
     getFormula({ signal, ...options }: FormulaRequestOptions): Promise<FormulaResponse>;
@@ -1993,11 +2016,27 @@ type VectorTilesetSourceOptions = SourceOptions & TilesetSourceOptions;
 type VectorTilesetSourceResponse = TilejsonResult & WidgetTilesetSourceResult;
 declare const vectorTilesetSource: (options: VectorTilesetSourceOptions) => Promise<VectorTilesetSourceResponse>;
 
-type VectorTableSourceOptions = SourceOptions & TableSourceOptions & FilterOptions & ColumnsOption;
+type VectorTableSourceOptions = SourceOptions & TableSourceOptions & FilterOptions & ColumnsOption & {
+    /**
+     * If `true`, the server includes a `_carto_bbox` property on each polygon
+     * feature, containing the bounding box of the full (unclipped) geometry as
+     * a `"west,south,east,north"` string in WGS84. Used by clients to compute
+     * stable label positions for polygons that span multiple tiles.
+     */
+    featureBbox?: boolean;
+};
 type VectorTableSourceResponse = TilejsonResult & WidgetTableSourceResult;
 declare const vectorTableSource: (options: VectorTableSourceOptions) => Promise<VectorTableSourceResponse>;
 
-type VectorQuerySourceOptions = SourceOptions & QuerySourceOptions & FilterOptions & ColumnsOption;
+type VectorQuerySourceOptions = SourceOptions & QuerySourceOptions & FilterOptions & ColumnsOption & {
+    /**
+     * If `true`, the server includes a `_carto_bbox` property on each polygon
+     * feature, containing the bounding box of the full (unclipped) geometry as
+     * a `"west,south,east,north"` string in WGS84. Used by clients to compute
+     * stable label positions for polygons that span multiple tiles.
+     */
+    featureBbox?: boolean;
+};
 type VectorQuerySourceResponse = TilejsonResult & WidgetQuerySourceResult;
 declare const vectorQuerySource: (options: VectorQuerySourceOptions) => Promise<VectorQuerySourceResponse>;
 
@@ -2238,4 +2277,4 @@ declare function getColumnNameFromGeoColumn(geoColumn: string | null | undefined
  */
 declare function getSpatialIndexFromGeoColumn(geoColumn: string): SpatialIndex | null;
 
-export { type APIErrorContext, type APIRequestType, AUDIT_TAGS, type AddFilterOptions, type AggregationFunction, type AggregationType, AggregationTypes, type AggregationsRequestOptions, type AggregationsResponse, ApiVersion, type Attribute, _default as BASEMAP, type BaseRequestOptions, type Basemap, type BoundaryQuerySourceOptions, type BoundaryQuerySourceResponse, type BoundaryTableSourceOptions, type BoundaryTableSourceResponse, CARTO_SOURCES, CartoAPIError, type CategoryOrderBy, type CategoryRequestOptions, type CategoryResponse, type CategoryResponseEntry, type CategoryResponseRaw, CellSet, type ColumnsOption, type D3Scale, DEFAULT_API_BASE_URL, type ExtentRequestOptions, type ExtentResponse, 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 Scales, 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 TrajectoryQuerySourceOptions, type TrajectoryQuerySourceResponse, type TrajectoryTableSourceOptions, type TrajectoryTableSourceResponse, 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, ErrorCode as _ErrorCode, type VecExprResult as _VecExprResult, applyLayerGroupFilters as _applyLayerGroupFilters, _buildFeatureFilter, createVecExprEvaluator as _createVecExprEvaluator, domainFromValues as _domainFromValues, evaluateVecExpr as _evaluateVecExpr, fillInMapDatasets as _fillInMapDatasets, fillInTileStats as _fillInTileStats, _getHexagonResolution, getLog10ScaleSteps as _getLog10ScaleSteps, getRasterTileLayerStyleProps as _getRasterTileLayerStyleProps, validateVecExprSyntax as _validateVecExprSyntax, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildPublicMapUrl, buildStatsUrl, calculateClusterRadius, calculateClusterTextFontSize, calculateLayerScale, clearDefaultRequestCache, clearFilters, compileCustomAggregation, configureSource, createColorScale, createPolygonSpatialFilter, createViewportSpatialFilter, fetchBasemapProps, fetchMap, filterFunctions, geojsonFeatures, getApplicableFilters, getClient, getColorAccessor, getColumnNameFromGeoColumn, getDataFilterExtensionProps, getDefaultAggregationExpColumnAliasForLayerType, getFilter, getIconUrlAccessor, getLayerDescriptor, 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, trajectoryQuerySource, trajectoryTableSource, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };
+export { type APIErrorContext, type APIRequestType, AUDIT_TAGS, type AddFilterOptions, type AggregationFunction, type AggregationType, AggregationTypes, type AggregationsRequestOptions, type AggregationsResponse, ApiVersion, type Attribute, _default as BASEMAP, type BaseRequestOptions, type Basemap, type BoundaryQuerySourceOptions, type BoundaryQuerySourceResponse, type BoundaryTableSourceOptions, type BoundaryTableSourceResponse, CARTO_SOURCES, CartoAPIError, type CategoryOrderBy, type CategoryRequestOptions, type CategoryResponse, type CategoryResponseEntry, type CategoryResponseRaw, CellSet, type ColumnsOption, type D3Scale, DEFAULT_API_BASE_URL, type ExtentRequestOptions, type ExtentResponse, 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 GeometrySpatialFilter, 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 Scales, 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 SpatialIndexFilter, 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 TrajectoryQuerySourceOptions, type TrajectoryQuerySourceResponse, type TrajectoryTableSourceOptions, type TrajectoryTableSourceResponse, 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, ErrorCode as _ErrorCode, type VecExprResult as _VecExprResult, applyLayerGroupFilters as _applyLayerGroupFilters, _buildFeatureFilter, createVecExprEvaluator as _createVecExprEvaluator, domainFromValues as _domainFromValues, evaluateVecExpr as _evaluateVecExpr, fillInMapDatasets as _fillInMapDatasets, fillInTileStats as _fillInTileStats, _getHexagonResolution, getLog10ScaleSteps as _getLog10ScaleSteps, getRasterTileLayerStyleProps as _getRasterTileLayerStyleProps, validateVecExprSyntax as _validateVecExprSyntax, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildPublicMapUrl, buildStatsUrl, calculateClusterRadius, calculateClusterTextFontSize, calculateLayerScale, clearDefaultRequestCache, clearFilters, compileCustomAggregation, configureSource, createColorScale, createPolygonSpatialFilter, createViewportSpatialFilter, fetchBasemapProps, fetchMap, filterFunctions, geojsonFeatures, getApplicableFilters, getClient, getColorAccessor, getColumnNameFromGeoColumn, getDataFilterExtensionProps, getDefaultAggregationExpColumnAliasForLayerType, getFilter, getIconUrlAccessor, getLayerDescriptor, getLayerProps, getMaxMarkerSize, getSizeAccessor, getSorter, getSpatialIndexFromGeoColumn, getTextAccessor, groupValuesByColumn, groupValuesByDateColumn, h3QuerySource, h3TableSource, h3TilesetSource, hasFilter, histogram, isSpatialIndexFilter, makeIntervalComplete, negateAccessor, opacityToAlpha, parseMap, quadbinQuerySource, quadbinTableSource, quadbinTilesetSource, query, rasterSource, removeFilter, requestWithParameters, scaleAggregationResLevel, scatterPlot, setClient, tileFeatures, tileFeaturesGeometries, tileFeaturesSpatialIndex, trajectoryQuerySource, trajectoryTableSource, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };

package/build/api-client.js

@@ -5559,6 +5559,9 @@ var SchemaFieldType = /* @__PURE__ */ ((SchemaFieldType2) => {
   SchemaFieldType2["Unknown"] = "unknown";
   return SchemaFieldType2;
 })(SchemaFieldType || {});
+function isSpatialIndexFilter(spatialFilter) {
+  return Array.isArray(spatialFilter.indexes);
+}
 
 // src/utils.ts
 var FILTER_TYPES = new Set(Object.values(FilterType));
@@ -7357,16 +7360,17 @@ var WidgetTilesetSourceImpl = class extends WidgetSource {
     this._features.length = 0;
   }
   _extractTileFeatures(spatialFilter) {
+    const geometryFilter = spatialFilter && !isSpatialIndexFilter(spatialFilter) ? spatialFilter : void 0;
     const prevInputs = this._tileFeatureExtractPreviousInputs;
-    if (this._features.length && spatialFilterEquals(prevInputs.spatialFilter, spatialFilter)) {
+    if (this._features.length && spatialFilterEquals(prevInputs.spatialFilter, geometryFilter)) {
       return;
     }
     this._features = tileFeatures({
       ...assignOptional({}, this.props, this._tileFeatureExtractOptions),
       tiles: this._tiles,
-      spatialFilter
+      spatialFilter: geometryFilter
     });
-    prevInputs.spatialFilter = spatialFilter;
+    prevInputs.spatialFilter = geometryFilter;
   }
   /**
    * Loads features as GeoJSON (used for testing).
@@ -8242,7 +8246,8 @@ var vectorQuerySource = async function(options) {
     sqlQuery,
     tileResolution = DEFAULT_TILE_RESOLUTION,
     queryParameters,
-    aggregationExp
+    aggregationExp,
+    featureBbox
   } = options;
   const spatialDataType = "geo";
   const urlParameters = {
@@ -8263,6 +8268,9 @@ var vectorQuerySource = async function(options) {
   if (aggregationExp) {
     urlParameters.aggregationExp = aggregationExp;
   }
+  if (featureBbox) {
+    urlParameters.featureBbox = true;
+  }
   return baseSource("query", options, urlParameters).then(
     (result) => ({
       ...result,
@@ -8285,7 +8293,8 @@ var vectorTableSource = async function(options) {
     spatialDataColumn = DEFAULT_GEO_COLUMN,
     tableName,
     tileResolution = DEFAULT_TILE_RESOLUTION,
-    aggregationExp
+    aggregationExp,
+    featureBbox
   } = options;
   const spatialDataType = "geo";
   const urlParameters = {
@@ -8303,6 +8312,9 @@ var vectorTableSource = async function(options) {
   if (aggregationExp) {
     urlParameters.aggregationExp = aggregationExp;
   }
+  if (featureBbox) {
+    urlParameters.featureBbox = true;
+  }
   return baseSource("table", options, urlParameters).then(
     (result) => ({
       ...result,
@@ -10862,11 +10874,13 @@ function configureSource({
     tileResolution,
     ...queryParameters && { queryParameters }
   };
+  const { featureBbox } = dataset;
   const vectorOptions = {
     spatialDataColumn,
     ...columns && { columns },
     ...filters && { filters },
-    ...aggregationExp && { aggregationExp }
+    ...aggregationExp && { aggregationExp },
+    ...featureBbox && { featureBbox }
   };
   if (type === "raster") {
     return rasterSource({
@@ -11150,6 +11164,21 @@ async function fetchMap({
       }
     }
   });
+  const layers = map.keplerMapConfig.config.visState.layers;
+  const datasetsWithLabels = /* @__PURE__ */ new Set();
+  for (const layer of layers) {
+    const hasTextLabel = layer.config?.textLabel?.some(
+      (t) => t.field?.name
+    );
+    if (hasTextLabel) {
+      datasetsWithLabels.add(layer.config.dataId);
+    }
+  }
+  map.datasets.forEach((dataset) => {
+    if (datasetsWithLabels.has(dataset.id) && (dataset.type === "table" || dataset.type === "query")) {
+      dataset.featureBbox = true;
+    }
+  });
   const [basemap] = await Promise.all([
     fetchBasemapProps({ config: map.keplerMapConfig.config, errorContext }),
     // Mutates map.datasets so that dataset.data contains data
@@ -11449,6 +11478,7 @@ export {
   h3TilesetSource,
   hasFilter,
   histogram,
+  isSpatialIndexFilter,
   makeIntervalComplete,
   negateAccessor,
   opacityToAlpha,