@carto/api-client 0.5.13 → 0.5.15-alpha.raster-0

package/build/api-client.d.cts

@@ -1,5 +1,6 @@
 import { Feature, Polygon, MultiPolygon, BBox, FeatureCollection, Geometry } from 'geojson';
 import { BinaryFeatureCollection, BinaryFeature } from '@loaders.gl/schema';
+import jsep from 'jsep';
 
 /**
  * Returns current client ID, used to categorize API requests. For internal use only.
@@ -750,6 +751,8 @@ declare function getColorAccessor({ name, colorColumn }: VisualChannelField, sca
     accessor: any;
     scale: any;
 };
+declare function calculateLayerScale(name: string, scaleType: ScaleType, range: ColorRange, data: TilejsonResult): D3Scale;
+declare function createColorScale<T>(scaleType: ScaleType, domain: string[] | number[], range: T[], unknown: T): D3Scale;
 declare function getIconUrlAccessor(field: VisualChannelField | null | undefined, range: CustomMarkersRange | null | undefined, { fallbackUrl, maxIconSize, useMaskedIcons, }: {
     fallbackUrl?: string | null;
     maxIconSize: number;
@@ -804,6 +807,7 @@ type ColorRange = {
     colorMap: string[][] | undefined;
     name: string;
     type: string;
+    uiCustomScaleType?: 'logarithmic';
 };
 type CustomMarkersRange = {
     markerMap: {
@@ -812,6 +816,12 @@ type CustomMarkersRange = {
     }[];
     othersMarker?: string;
 };
+type ColorBand = 'red' | 'green' | 'blue' | 'alpha';
+type RasterLayerConfigColorBand = {
+    band: ColorBand;
+    type: 'none' | 'band' | 'expression';
+    value: string;
+};
 type VisConfig = {
     filled?: boolean;
     opacity?: number;
@@ -833,6 +843,9 @@ type VisConfig = {
     weightAggregation?: any;
     clusterLevel?: number;
     isTextVisible?: boolean;
+    rasterStyleType?: 'Rgb' | 'ColorRange' | 'UniqueValues';
+    colorBands?: RasterLayerConfigColorBand[];
+    uniqueValuesColorRange?: ColorRange;
 };
 type TextLabel = {
     field: VisualChannelField | null | undefined;
@@ -976,17 +989,32 @@ declare const _default: {
     readonly DARK_MATTER_NOLABELS: string;
 };
 
+declare function getRasterTileLayerStyleProps({ layerConfig, visualChannels, rasterMetadata, }: {
+    layerConfig: MapLayerConfig;
+    visualChannels: VisualChannels;
+    rasterMetadata: RasterMetadata;
+}): {
+    dataTransform: () => any;
+    updateTriggers: {
+        getFillColor: Record<string, unknown>;
+    };
+} | {
+    dataTransform?: undefined;
+    updateTriggers?: undefined;
+};
+
 type Scale = {
     field: VisualChannelField;
     domain: string[] | number[];
     range: string[] | number[];
     type: ScaleType;
 };
+type ScaleKey = 'fillColor' | 'pointRadius' | 'lineColor' | 'elevation' | 'weight';
 type LayerDescriptor = {
     type: LayerType;
     props: Record<string, any>;
     filters?: Filters;
-    scales: Record<ScaleKey, Scale>;
+    scales: Partial<Record<ScaleKey, Scale>>;
 };
 type ParseMapResult = {
     /** Map id. */
@@ -1004,6 +1032,11 @@ type ParseMapResult = {
     token: string;
     layers: LayerDescriptor[];
 };
+declare function getLayerDescriptor({ mapConfig, layer, dataset, }: {
+    mapConfig: KeplerMapConfig;
+    layer: MapConfigLayer;
+    dataset: Dataset;
+}): LayerDescriptor;
 declare function parseMap(json: any): {
     id: any;
     title: any;
@@ -1021,7 +1054,6 @@ declare function parseMap(json: any): {
     token: any;
     layers: (LayerDescriptor | undefined)[];
 };
-type ScaleKey = 'fillColor' | 'pointRadius' | 'lineColor' | 'elevation' | 'weight';
 
 type FetchMapOptions = {
     /**
@@ -1085,6 +1117,38 @@ declare function fetchBasemapProps({ config, errorContext, applyLayerFilters, }:
     errorContext?: APIErrorContext;
 }): Promise<Basemap | null>;
 
+/**
+ * Create vector expresion evaluator.
+ *
+ * Used to calculate vector expressions, such as `(band_1 * 3) + band_2/2`,
+ * where `band_1` and `band_2` are arrays or typed arrays.
+ *
+ * Note that all vector operations are element-wise, in paricular `band_1 * band_2`
+ * is not "mathematical" dot or cross product, but just element-wise multiplication.
+ *
+ * Based on:
+ * - Copyright (c) 2013 Stephen Oney, http://jsep.from.so/, MIT License
+ * - Copyright (c) 2023 Don McCurdy, https://github.com/donmccurdy/expression-eval, MIT License
+ */
+declare function createVecExprEvaluator(expression: string | jsep.Expression): VecExprEvaluator | null;
+declare function evaluateVecExpr(expression: string | jsep.Expression, context: Record<string, VecExprResult>): VecExprResult | null | undefined;
+declare enum ErrorCode {
+    InvalidSyntax = 0,
+    UnknownIdentifier = 1
+}
+type ValidationResult = {
+    valid: boolean;
+    errorCode?: ErrorCode;
+    errorMessage?: string;
+};
+declare function validateVecExprSyntax(expression: string | jsep.Expression, context: Record<string, unknown>): ValidationResult;
+type VecExprVecLike = number[] | Float32Array | Float64Array | Uint8Array | Int8Array | Int32Array | Uint32Array | Uint16Array | Int16Array;
+type VecExprResult = number | VecExprVecLike;
+type VecExprEvaluator = {
+    (context: object): VecExprResult;
+    symbols?: string[];
+};
+
 type FilterTypeOptions<T extends FilterType> = {
     type: T;
     column: string;
@@ -1341,6 +1405,8 @@ interface TimeSeriesRequestOptions extends BaseRequestOptions {
     splitByCategoryLimit?: number;
     splitByCategoryValues?: string[];
 }
+/** @experimental */
+type ExtentRequestOptions = BaseRequestOptions;
 /******************************************************************************
  * WIDGET API RESPONSES
  */
@@ -1391,6 +1457,10 @@ type TimeSeriesResponse = {
 };
 /** Response from {@link WidgetRemoteSource#getHistogram}. */
 type HistogramResponse = number[];
+/** @experimental */
+type ExtentResponse = {
+    bbox: BBox;
+};
 
 interface WidgetSourceProps extends Omit<SourceOptions, 'filters'> {
     apiVersion?: ApiVersion;
@@ -1459,6 +1529,8 @@ declare abstract class WidgetSource<Props extends WidgetSourceProps = WidgetSour
      * time intervals. Suitable for rendering time series charts.
      */
     abstract getTimeSeries(options: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
+    /** @experimental */
+    abstract getExtent(options?: ExtentRequestOptions): Promise<ExtentResponse>;
 }
 
 interface ModelSource {
@@ -1502,6 +1574,8 @@ declare abstract class WidgetRemoteSource<Props extends WidgetRemoteSourceProps>
     getScatter(options: ScatterRequestOptions): Promise<ScatterResponse>;
     getTable(options: TableRequestOptions): Promise<TableResponse>;
     getTimeSeries(options: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
+    /** @experimental */
+    getExtent(options?: ExtentRequestOptions): Promise<ExtentResponse>;
 }
 
 type LayerQuerySourceOptions = Omit<VectorQuerySourceOptions, 'filters'> | Omit<H3QuerySourceOptions, 'filters'> | Omit<QuadbinQuerySourceOptions, 'filters'>;
@@ -1656,6 +1730,8 @@ declare class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePr
     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>;
     getRange({ column, filters, filterOwner, spatialFilter, }: RangeRequestOptions): Promise<RangeResponse>;
+    /** @experimental */
+    getExtent(): Promise<ExtentResponse>;
     /****************************************************************************
      * INTERNAL
      */
@@ -1665,6 +1741,10 @@ declare class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePr
 type WidgetTilesetSourceProps = WidgetSourceProps & Omit<TilesetSourceOptions, 'filters'> & {
     tileFormat: TileFormat;
     spatialDataType: SpatialDataType;
+    /**
+     * Extent of spatial data, typically from TileJSON. Does not include filters.
+     */
+    spatialDataBounds: BBox;
 };
 type WidgetTilesetSourceResult = {
     widgetSource: WidgetTilesetSource;
@@ -1730,6 +1810,8 @@ declare class WidgetTilesetSource<Props extends WidgetTilesetSourceProps = Widge
     getTable({ signal, ...options }: TableRequestOptions): Promise<TableResponse>;
     getTimeSeries({ signal, ...options }: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
     getRange({ signal, ...options }: RangeRequestOptions): Promise<RangeResponse>;
+    /** @experimental */
+    getExtent(): Promise<ExtentResponse>;
 }
 
 type WidgetRasterSourceProps = WidgetTilesetSourceProps & {
@@ -1969,4 +2051,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 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 };
+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, 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 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, ErrorCode as _ErrorCode, type VecExprResult as _VecExprResult, _buildFeatureFilter, createVecExprEvaluator as _createVecExprEvaluator, domainFromValues as _domainFromValues, evaluateVecExpr as _evaluateVecExpr, _getHexagonResolution, getRasterTileLayerStyleProps as _getRasterTileLayerStyleProps, validateVecExprSyntax as _validateVecExprSyntax, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildPublicMapUrl, buildStatsUrl, calculateClusterRadius, calculateClusterTextFontSize, calculateLayerScale, clearDefaultRequestCache, clearFilters, 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, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };

package/build/api-client.d.ts

@@ -1,5 +1,6 @@
 import { Feature, Polygon, MultiPolygon, BBox, FeatureCollection, Geometry } from 'geojson';
 import { BinaryFeatureCollection, BinaryFeature } from '@loaders.gl/schema';
+import jsep from 'jsep';
 
 /**
  * Returns current client ID, used to categorize API requests. For internal use only.
@@ -750,6 +751,8 @@ declare function getColorAccessor({ name, colorColumn }: VisualChannelField, sca
     accessor: any;
     scale: any;
 };
+declare function calculateLayerScale(name: string, scaleType: ScaleType, range: ColorRange, data: TilejsonResult): D3Scale;
+declare function createColorScale<T>(scaleType: ScaleType, domain: string[] | number[], range: T[], unknown: T): D3Scale;
 declare function getIconUrlAccessor(field: VisualChannelField | null | undefined, range: CustomMarkersRange | null | undefined, { fallbackUrl, maxIconSize, useMaskedIcons, }: {
     fallbackUrl?: string | null;
     maxIconSize: number;
@@ -804,6 +807,7 @@ type ColorRange = {
     colorMap: string[][] | undefined;
     name: string;
     type: string;
+    uiCustomScaleType?: 'logarithmic';
 };
 type CustomMarkersRange = {
     markerMap: {
@@ -812,6 +816,12 @@ type CustomMarkersRange = {
     }[];
     othersMarker?: string;
 };
+type ColorBand = 'red' | 'green' | 'blue' | 'alpha';
+type RasterLayerConfigColorBand = {
+    band: ColorBand;
+    type: 'none' | 'band' | 'expression';
+    value: string;
+};
 type VisConfig = {
     filled?: boolean;
     opacity?: number;
@@ -833,6 +843,9 @@ type VisConfig = {
     weightAggregation?: any;
     clusterLevel?: number;
     isTextVisible?: boolean;
+    rasterStyleType?: 'Rgb' | 'ColorRange' | 'UniqueValues';
+    colorBands?: RasterLayerConfigColorBand[];
+    uniqueValuesColorRange?: ColorRange;
 };
 type TextLabel = {
     field: VisualChannelField | null | undefined;
@@ -976,17 +989,32 @@ declare const _default: {
     readonly DARK_MATTER_NOLABELS: string;
 };
 
+declare function getRasterTileLayerStyleProps({ layerConfig, visualChannels, rasterMetadata, }: {
+    layerConfig: MapLayerConfig;
+    visualChannels: VisualChannels;
+    rasterMetadata: RasterMetadata;
+}): {
+    dataTransform: () => any;
+    updateTriggers: {
+        getFillColor: Record<string, unknown>;
+    };
+} | {
+    dataTransform?: undefined;
+    updateTriggers?: undefined;
+};
+
 type Scale = {
     field: VisualChannelField;
     domain: string[] | number[];
     range: string[] | number[];
     type: ScaleType;
 };
+type ScaleKey = 'fillColor' | 'pointRadius' | 'lineColor' | 'elevation' | 'weight';
 type LayerDescriptor = {
     type: LayerType;
     props: Record<string, any>;
     filters?: Filters;
-    scales: Record<ScaleKey, Scale>;
+    scales: Partial<Record<ScaleKey, Scale>>;
 };
 type ParseMapResult = {
     /** Map id. */
@@ -1004,6 +1032,11 @@ type ParseMapResult = {
     token: string;
     layers: LayerDescriptor[];
 };
+declare function getLayerDescriptor({ mapConfig, layer, dataset, }: {
+    mapConfig: KeplerMapConfig;
+    layer: MapConfigLayer;
+    dataset: Dataset;
+}): LayerDescriptor;
 declare function parseMap(json: any): {
     id: any;
     title: any;
@@ -1021,7 +1054,6 @@ declare function parseMap(json: any): {
     token: any;
     layers: (LayerDescriptor | undefined)[];
 };
-type ScaleKey = 'fillColor' | 'pointRadius' | 'lineColor' | 'elevation' | 'weight';
 
 type FetchMapOptions = {
     /**
@@ -1085,6 +1117,38 @@ declare function fetchBasemapProps({ config, errorContext, applyLayerFilters, }:
     errorContext?: APIErrorContext;
 }): Promise<Basemap | null>;
 
+/**
+ * Create vector expresion evaluator.
+ *
+ * Used to calculate vector expressions, such as `(band_1 * 3) + band_2/2`,
+ * where `band_1` and `band_2` are arrays or typed arrays.
+ *
+ * Note that all vector operations are element-wise, in paricular `band_1 * band_2`
+ * is not "mathematical" dot or cross product, but just element-wise multiplication.
+ *
+ * Based on:
+ * - Copyright (c) 2013 Stephen Oney, http://jsep.from.so/, MIT License
+ * - Copyright (c) 2023 Don McCurdy, https://github.com/donmccurdy/expression-eval, MIT License
+ */
+declare function createVecExprEvaluator(expression: string | jsep.Expression): VecExprEvaluator | null;
+declare function evaluateVecExpr(expression: string | jsep.Expression, context: Record<string, VecExprResult>): VecExprResult | null | undefined;
+declare enum ErrorCode {
+    InvalidSyntax = 0,
+    UnknownIdentifier = 1
+}
+type ValidationResult = {
+    valid: boolean;
+    errorCode?: ErrorCode;
+    errorMessage?: string;
+};
+declare function validateVecExprSyntax(expression: string | jsep.Expression, context: Record<string, unknown>): ValidationResult;
+type VecExprVecLike = number[] | Float32Array | Float64Array | Uint8Array | Int8Array | Int32Array | Uint32Array | Uint16Array | Int16Array;
+type VecExprResult = number | VecExprVecLike;
+type VecExprEvaluator = {
+    (context: object): VecExprResult;
+    symbols?: string[];
+};
+
 type FilterTypeOptions<T extends FilterType> = {
     type: T;
     column: string;
@@ -1341,6 +1405,8 @@ interface TimeSeriesRequestOptions extends BaseRequestOptions {
     splitByCategoryLimit?: number;
     splitByCategoryValues?: string[];
 }
+/** @experimental */
+type ExtentRequestOptions = BaseRequestOptions;
 /******************************************************************************
  * WIDGET API RESPONSES
  */
@@ -1391,6 +1457,10 @@ type TimeSeriesResponse = {
 };
 /** Response from {@link WidgetRemoteSource#getHistogram}. */
 type HistogramResponse = number[];
+/** @experimental */
+type ExtentResponse = {
+    bbox: BBox;
+};
 
 interface WidgetSourceProps extends Omit<SourceOptions, 'filters'> {
     apiVersion?: ApiVersion;
@@ -1459,6 +1529,8 @@ declare abstract class WidgetSource<Props extends WidgetSourceProps = WidgetSour
      * time intervals. Suitable for rendering time series charts.
      */
     abstract getTimeSeries(options: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
+    /** @experimental */
+    abstract getExtent(options?: ExtentRequestOptions): Promise<ExtentResponse>;
 }
 
 interface ModelSource {
@@ -1502,6 +1574,8 @@ declare abstract class WidgetRemoteSource<Props extends WidgetRemoteSourceProps>
     getScatter(options: ScatterRequestOptions): Promise<ScatterResponse>;
     getTable(options: TableRequestOptions): Promise<TableResponse>;
     getTimeSeries(options: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
+    /** @experimental */
+    getExtent(options?: ExtentRequestOptions): Promise<ExtentResponse>;
 }
 
 type LayerQuerySourceOptions = Omit<VectorQuerySourceOptions, 'filters'> | Omit<H3QuerySourceOptions, 'filters'> | Omit<QuadbinQuerySourceOptions, 'filters'>;
@@ -1656,6 +1730,8 @@ declare class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePr
     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>;
     getRange({ column, filters, filterOwner, spatialFilter, }: RangeRequestOptions): Promise<RangeResponse>;
+    /** @experimental */
+    getExtent(): Promise<ExtentResponse>;
     /****************************************************************************
      * INTERNAL
      */
@@ -1665,6 +1741,10 @@ declare class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePr
 type WidgetTilesetSourceProps = WidgetSourceProps & Omit<TilesetSourceOptions, 'filters'> & {
     tileFormat: TileFormat;
     spatialDataType: SpatialDataType;
+    /**
+     * Extent of spatial data, typically from TileJSON. Does not include filters.
+     */
+    spatialDataBounds: BBox;
 };
 type WidgetTilesetSourceResult = {
     widgetSource: WidgetTilesetSource;
@@ -1730,6 +1810,8 @@ declare class WidgetTilesetSource<Props extends WidgetTilesetSourceProps = Widge
     getTable({ signal, ...options }: TableRequestOptions): Promise<TableResponse>;
     getTimeSeries({ signal, ...options }: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
     getRange({ signal, ...options }: RangeRequestOptions): Promise<RangeResponse>;
+    /** @experimental */
+    getExtent(): Promise<ExtentResponse>;
 }
 
 type WidgetRasterSourceProps = WidgetTilesetSourceProps & {
@@ -1969,4 +2051,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 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 };
+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, 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 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, ErrorCode as _ErrorCode, type VecExprResult as _VecExprResult, _buildFeatureFilter, createVecExprEvaluator as _createVecExprEvaluator, domainFromValues as _domainFromValues, evaluateVecExpr as _evaluateVecExpr, _getHexagonResolution, getRasterTileLayerStyleProps as _getRasterTileLayerStyleProps, validateVecExprSyntax as _validateVecExprSyntax, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildPublicMapUrl, buildStatsUrl, calculateClusterRadius, calculateClusterTextFontSize, calculateLayerScale, clearDefaultRequestCache, clearFilters, 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, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };