@carto/api-client 0.5.0-alpha.13 → 0.5.0-alpha.15

package/build/api-client.d.ts

@@ -1,4 +1,4 @@
-import { Polygon, MultiPolygon, Feature, BBox, FeatureCollection, Geometry } from 'geojson';
+import { Feature, Polygon, MultiPolygon, BBox, FeatureCollection, Geometry } from 'geojson';
 import { BinaryFeatureCollection, BinaryFeature } from '@loaders.gl/schema';
 
 /**
@@ -57,7 +57,6 @@ declare enum TileFormat {
 /** @privateRemarks Source: @carto/react-core */
 declare enum SpatialIndex {
     H3 = "h3",
-    S2 = "s2",
     QUADBIN = "quadbin"
 }
 /** @privateRemarks Source: @carto/react-core */
@@ -69,6 +68,10 @@ declare enum Provider {
     DATABRICKS = "databricks",
     DATABRICKS_REST = "databricksRest"
 }
+declare const SpatialIndexColumn: Readonly<{
+    h3: string[];
+    quadbin: string[];
+}>;
 
 /******************************************************************************
  * MAPS AND TILES
@@ -77,6 +80,8 @@ declare enum Provider {
 type Format = 'json' | 'geojson' | 'tilejson';
 /** @privateRemarks Source: @carto/constants, @deck.gl/carto */
 type MapType = 'boundary' | 'query' | 'table' | 'tileset' | 'raster';
+/** @privateRemarks Source: cloud-native */
+type ProviderType = 'bigquery' | 'postgres' | 'snowflake' | 'redshift' | 'databricks' | 'carto' | 'carto_dw';
 /**
  * Alias for GeoJSON 'BBox' type, semantically representing a viewport.
  * Order of values is "west", "south", "east", "north".
@@ -96,8 +101,6 @@ type Tile = {
         z: number;
     };
     id: string;
-    content: unknown;
-    zoom: number;
     bbox: {
         west: number;
         east: number;
@@ -113,6 +116,14 @@ type SpatialIndexTile = Tile & {
         id: bigint;
     })[];
 };
+type RasterTile = Tile & {
+    id: string;
+    index: {
+        q: bigint;
+        i: string;
+    };
+    data?: Raster;
+};
 /** @privateRemarks Source: @deck.gl/carto */
 type Raster = {
     blockSize: number;
@@ -243,60 +254,45 @@ type _DataFilterExtensionProps = {
  */
 declare function getDataFilterExtensionProps(filters: Filters, filtersLogicalOperator?: FilterLogicalOperator): _DataFilterExtensionProps;
 
-type FilterTypeOptions<T extends FilterType> = {
-    type: T;
-    column: string;
-} & Filter[T];
-type AddFilterOptions = FilterTypeOptions<FilterType.IN> | FilterTypeOptions<FilterType.BETWEEN> | FilterTypeOptions<FilterType.CLOSED_OPEN> | FilterTypeOptions<FilterType.TIME> | FilterTypeOptions<FilterType.STRING_SEARCH>;
-/**
- * Adds a {@link Filter} to the filter set. Any previous filters with the same
- * `column` and `type` will be replaced.
- */
-declare function addFilter(filters: Record<string, Filter>, { column, type, values, owner }: AddFilterOptions): Record<string, Filter>;
-type RemoveFilterOptions = {
-    column: string;
-    owner?: string;
-};
-/**
- * Removes one or more {@link Filter filters} from the filter set. If only
- * `column` is specified, then all filters on that column are removed. If both
- * `column` and `owner` are specified, then only filters for that column
- * associated with the owner are removed.
- */
-declare function removeFilter(filters: Record<string, Filter>, { column, owner }: RemoveFilterOptions): Record<string, Filter>;
-/**
- * Clears all {@link Filter filters} from the filter set.
- */
-declare function clearFilters(filters: Record<string, Filter>): Record<string, Filter>;
-type HasFilterOptions = {
-    column: string;
-    owner?: string;
-};
-declare function hasFilter(filters: Record<string, Filter>, { column, owner }: HasFilterOptions): boolean;
-type GetFilterOptions<T extends FilterType> = {
-    column: string;
-    type: T;
-    owner?: string;
+type APIRequestType = 'Map data' | 'Map instantiation' | 'Public map' | 'Tile stats' | 'SQL' | 'Basemap style';
+type APIErrorContext = {
+    requestType: APIRequestType;
+    mapId?: string;
+    connection?: string;
+    source?: string;
+    type?: MapType;
 };
-declare function getFilter<T extends FilterType>(filters: Record<string, Filter>, { column, type, owner }: GetFilterOptions<T>): Filter[T] | null;
-
 /**
- * Returns a {@link SpatialFilter} for a given viewport, typically obtained
- * from deck.gl's `viewport.getBounds()` method ([west, south, east, north]).
- * If the viewport covers the entire world (to some margin of error in Web
- * Mercator space), `undefined` is returned instead.
  *
- * If the viewport extends beyond longitude range [-180, +180], the polygon
- * may be reformatted for compatibility with CARTO APIs.
- */
-declare function createViewportSpatialFilter(viewport: BBox): SpatialFilter | undefined;
-/**
- * Returns a {@link SpatialFilter} for a given {@link Polygon} or
- * {@link MultiPolygon}. If the polygon(s) extend outside longitude
- * range [-180, +180], the result may be reformatted for compatibility
- * with CARTO APIs.
+ * Custom error for reported errors in CARTO Maps API.
+ * Provides useful debugging information in console and context for applications.
+ *
  */
-declare function createPolygonSpatialFilter(spatialFilter: Polygon | MultiPolygon): SpatialFilter | undefined;
+declare class CartoAPIError extends Error {
+    /** Source error from server */
+    error: Error;
+    /** Context (API call & parameters) in which error occured */
+    errorContext: APIErrorContext;
+    /** Response from server */
+    response?: Response;
+    /** JSON Response from server */
+    responseJson?: any;
+    constructor(error: Error, errorContext: APIErrorContext, response?: Response, responseJson?: any);
+}
+
+/** @internal Required by fetchMap(). */
+declare function buildPublicMapUrl({ apiBaseUrl, cartoMapId, }: {
+    apiBaseUrl: string;
+    cartoMapId: string;
+}): string;
+/** @internal Required by fetchMap(). */
+declare function buildStatsUrl({ attribute, apiBaseUrl, connectionName, source, type, }: {
+    attribute: string;
+    apiBaseUrl: string;
+    connectionName: string;
+    source: string;
+    type: MapType;
+}): string;
 
 type SourceRequiredOptions = {
     /** Carto platform access token. */
@@ -394,10 +390,6 @@ type AggregationOptions = {
      * @default 6 for quadbin and 4 for h3 sources
      */
     aggregationResLevel?: number;
-    /**
-     * Original resolution of the spatial index data as stored in the DW
-     */
-    dataResolution?: number;
 };
 type FilterOptions = {
     /**
@@ -602,8 +594,9 @@ declare enum RasterBandColorinterp {
     Alpha = "alpha",
     Palette = "palette"
 }
+type RasterBandType = 'uint8' | 'int8' | 'uint16' | 'int16' | 'uint32' | 'int32' | 'uint64' | 'int64' | 'float32' | 'float64';
 type RasterMetadataBand = {
-    type: string;
+    type: RasterBandType;
     name: string;
     stats: RasterMetadataBandStats;
     /**
@@ -616,7 +609,7 @@ type RasterMetadataBand = {
     /**
      * Default color mapping for unique values (or if coloprinterp is `palette`)
      */
-    colortable?: Record<string, number[]>;
+    colortable?: Record<string, [number, number, number, number]>;
     /**
      * No value representation.
      * Observed values:
@@ -662,7 +655,399 @@ type QueryResult = {
     }[];
 };
 
-declare const SOURCE_DEFAULTS: SourceOptionalOptions;
+type QueryOptions = SourceOptions & QuerySourceOptions;
+declare const query: (options: QueryOptions) => Promise<QueryResult>;
+
+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;
+}): Promise<T>;
+
+type LayerType = 'clusterTile' | 'h3' | 'heatmapTile' | 'mvt' | 'quadbin' | 'raster' | 'tileset';
+
+declare const SCALE_FUNCS: Record<string, () => any>;
+type SCALE_TYPE = keyof typeof SCALE_FUNCS;
+declare const AGGREGATION: Record<string, string>;
+declare const OPACITY_MAP: Record<string, string>;
+declare function getLayerProps(type: LayerType, config: MapLayerConfig, dataset: Dataset): {
+    propMap: any;
+    defaultProps: any;
+};
+declare function domainFromValues(values: any, scaleType: SCALE_TYPE): any;
+declare function opacityToAlpha(opacity?: number): number;
+declare function getColorValueAccessor({ name }: VisualChannelField, colorAggregation: string, data: any): any;
+declare function getColorAccessor({ name, colorColumn }: VisualChannelField, scaleType: SCALE_TYPE, { aggregation, range }: {
+    aggregation: string;
+    range: any;
+}, opacity: number | undefined, data: any): any;
+declare function getIconUrlAccessor(field: VisualChannelField | null | undefined, range: CustomMarkersRange | null | undefined, { fallbackUrl, maxIconSize, useMaskedIcons, }: {
+    fallbackUrl?: string | null;
+    maxIconSize: number;
+    useMaskedIcons?: boolean;
+}, data: any): any;
+declare function getMaxMarkerSize(visConfig: VisConfig, visualChannels: VisualChannels): number;
+type Accessor = number | ((d: any, i: any) => number);
+declare function negateAccessor(accessor: Accessor): Accessor;
+declare function getSizeAccessor({ name }: VisualChannelField, scaleType: SCALE_TYPE | undefined, aggregation: string | null | undefined, range: Iterable<Range> | null | undefined, data: any): any;
+declare function getTextAccessor({ name, type }: VisualChannelField, data: any): any;
+
+type VisualChannelField = {
+    name: string;
+    type: string;
+    colorColumn?: string;
+};
+type VisualChannels = {
+    colorField?: VisualChannelField;
+    colorScale?: SCALE_TYPE;
+    customMarkersField?: VisualChannelField;
+    customMarkersScale?: SCALE_TYPE;
+    radiusField?: VisualChannelField;
+    radiusScale?: SCALE_TYPE;
+    rotationScale?: SCALE_TYPE;
+    rotationField?: VisualChannelField;
+    sizeField?: VisualChannelField;
+    sizeScale?: SCALE_TYPE;
+    strokeColorField?: VisualChannelField;
+    strokeColorScale?: SCALE_TYPE;
+    heightField?: VisualChannelField;
+    heightScale?: SCALE_TYPE;
+    weightField?: VisualChannelField;
+};
+type ColorRange = {
+    category: string;
+    colors: string[];
+    colorMap: string[][] | undefined;
+    name: string;
+    type: string;
+};
+type CustomMarkersRange = {
+    markerMap: {
+        value: string;
+        markerUrl?: string;
+    }[];
+    othersMarker?: string;
+};
+type VisConfig = {
+    filled?: boolean;
+    opacity?: number;
+    enable3d?: boolean;
+    colorAggregation?: any;
+    colorRange: ColorRange;
+    customMarkers?: boolean;
+    customMarkersRange?: CustomMarkersRange | null;
+    customMarkersUrl?: string | null;
+    radius: number;
+    radiusRange?: number[];
+    sizeAggregation?: any;
+    sizeRange?: any;
+    strokeColorAggregation?: any;
+    strokeOpacity?: number;
+    strokeColorRange?: ColorRange;
+    heightRange?: any;
+    heightAggregation?: any;
+    weightAggregation?: any;
+};
+type TextLabel = {
+    field: VisualChannelField | null | undefined;
+    alignment?: 'center' | 'bottom' | 'top';
+    anchor?: 'middle' | 'start' | 'end';
+    size: number;
+    color?: number[];
+    offset?: [number, number];
+    outlineColor?: number[];
+};
+type MapLayerConfig = {
+    columns?: Record<string, any>;
+    color?: number[];
+    label?: string;
+    dataId: string;
+    textLabel: TextLabel[];
+    visConfig: VisConfig;
+};
+type MapConfigLayer = {
+    type: LayerType;
+    id: string;
+    config: MapLayerConfig;
+    visualChannels: VisualChannels;
+};
+interface CustomStyle {
+    url?: string;
+    style?: any;
+    customAttribution?: string;
+}
+type KeplerMapConfig = {
+    filters: any;
+    mapState: any;
+    mapStyle: {
+        styleType: string;
+        visibleLayerGroups: Record<string, boolean>;
+    };
+    popupSettings: any;
+    visState: {
+        layers: MapConfigLayer[];
+        layerBlending: any;
+        interactionConfig: any;
+    };
+    customBaseMaps?: {
+        customStyle?: CustomStyle;
+    };
+};
+type BasemapType = 'maplibre' | 'google-maps';
+type Basemap = MapLibreBasemap | GoogleBasemap;
+type BasemapCommon = {
+    /**
+     * Type of basemap.
+     */
+    type: BasemapType;
+    /**
+     * Custom attribution for style data if not provided by style definition.
+     */
+    attribution?: string;
+    /**
+     * Properties of the basemap. These properties are specific to the basemap type.
+     */
+    props: Record<string, any>;
+};
+type MapLibreBasemap = BasemapCommon & {
+    type: 'maplibre';
+    /**
+     * MapLibre map properties.
+     *
+     * Meant to be passed to directly to `maplibregl.Map` object.
+     */
+    props: MapLibreBasemapProps;
+    /**
+     * Layer groups to be displayed in the basemap.
+     */
+    visibleLayerGroups?: Record<string, boolean>;
+    /**
+     * If `style` has been filtered by `visibleLayerGroups` then this property contains original style object, so user
+     * can use `applyLayerGroupFilters` again with new settings.
+     */
+    rawStyle?: string | Record<string, any>;
+};
+type MapLibreBasemapProps = {
+    style: string | Record<string, any>;
+    center: [number, number];
+    zoom: number;
+    pitch?: number;
+    bearing?: number;
+};
+type GoogleBasemap = BasemapCommon & {
+    type: 'google-maps';
+    /**
+     * Google map properties.
+     *
+     * Meant to be passed to directly to `google.maps.Map` object.
+     */
+    props: GoogleBasemapProps;
+};
+type GoogleBasemapProps = {
+    mapTypeId: string;
+    mapId?: string;
+    center?: {
+        lat: number;
+        lng: number;
+    };
+    zoom?: number;
+    tilt?: number;
+    heading?: number;
+};
+type Dataset = {
+    id: string;
+    type: MapType;
+    source: string;
+    cache?: number;
+    connectionName: string;
+    geoColumn: string;
+    data: TilejsonResult | GeojsonResult | JsonResult;
+    columns: string[];
+    format: Format;
+    aggregationExp: string;
+    aggregationResLevel: number;
+    queryParameters: QueryParameters;
+    connectionId?: string;
+    providerId: ProviderType;
+    createdAt?: string;
+    updatedAt?: string;
+    label?: string;
+    color?: string;
+    uniqueIdProperty?: string;
+    queryTemplate?: string | null;
+    name?: string | null;
+    spatialIndex?: string | null;
+    exportToBucketAvailable?: boolean;
+};
+
+declare const _default: {
+    readonly VOYAGER: string;
+    readonly POSITRON: string;
+    readonly DARK_MATTER: string;
+    readonly VOYAGER_NOLABELS: string;
+    readonly POSITRON_NOLABELS: string;
+    readonly DARK_MATTER_NOLABELS: string;
+};
+
+type LayerDescriptor = {
+    type: LayerType;
+    props: Record<string, any>;
+    filters?: Filters;
+};
+type ParseMapResult = {
+    /** Map id. */
+    id: string;
+    /** Title of map. */
+    title: string;
+    /** Description of map. */
+    description?: string;
+    createdAt: string;
+    updatedAt: string;
+    initialViewState: any;
+    /** @deprecated Use `basemap`. */
+    mapStyle: any;
+    popupSettings: any;
+    token: string;
+    layers: LayerDescriptor[];
+};
+declare function parseMap(json: any): {
+    id: any;
+    title: any;
+    description: any;
+    createdAt: any;
+    updatedAt: any;
+    initialViewState: any;
+    /** @deprecated Use `basemap`. */
+    mapStyle: {
+        styleType: string;
+        visibleLayerGroups: Record<string, boolean>;
+    };
+    popupSettings: any;
+    token: any;
+    layers: (LayerDescriptor | undefined)[];
+};
+
+type FetchMapOptions = {
+    /**
+     * CARTO platform access token. Only required for private maps.
+     */
+    accessToken?: string;
+    /**
+     * Base URL of the CARTO Maps API.
+     *
+     * Example for account located in EU-west region: `https://gcp-eu-west1.api.carto.com`
+     *
+     * @default https://gcp-us-east1.api.carto.com
+     */
+    apiBaseUrl?: string;
+    /**
+     * Identifier of map created in CARTO Builder.
+     */
+    cartoMapId: string;
+    clientId?: string;
+    /**
+     * Custom HTTP headers added to map instantiation and data requests.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Interval in seconds at which to autoRefresh the data. If provided, `onNewData` must also be provided.
+     */
+    autoRefresh?: number;
+    /**
+     * Callback function that will be invoked whenever data in layers is changed. If provided, `autoRefresh` must also be provided.
+     */
+    onNewData?: (map: any) => void;
+    /**
+     * Maximum URL character length. Above this limit, requests use POST.
+     * Used to avoid browser and CDN limits.
+     * @default {@link DEFAULT_MAX_LENGTH_URL}
+     */
+    maxLengthURL?: number;
+};
+type FetchMapResult = ParseMapResult & {
+    /**
+     * Basemap properties.
+     */
+    basemap: Basemap | null;
+    stopAutoRefresh?: () => void;
+};
+declare function fetchMap({ accessToken, apiBaseUrl, cartoMapId, clientId, headers, autoRefresh, onNewData, maxLengthURL, }: FetchMapOptions): Promise<FetchMapResult>;
+
+/**
+ * Get basemap properties for Carto map.
+ *
+ * For maplibre-based basemaps it returns style or style URL that can be used with  `maplibregl.Map` compatible component.
+ *  * style url is returned for non-filtered standard Carto basemaps or if user used style URL directly in configuration
+ *  * filtered style object returned for Carto basemaps with layer groups filtered
+ *
+ * For Google-maps base maps, it returns options that can be used with `google.maps.Map` constructor.
+ */
+declare function fetchBasemapProps({ config, errorContext, applyLayerFilters, }: {
+    config: KeplerMapConfig;
+    /** By default `fetchBasemapProps` applies layers filters to style. Set this to `false` to disable it. */
+    applyLayerFilters?: boolean;
+    errorContext?: APIErrorContext;
+}): Promise<Basemap | null>;
+
+type FilterTypeOptions<T extends FilterType> = {
+    type: T;
+    column: string;
+} & Filter[T];
+type AddFilterOptions = FilterTypeOptions<FilterType.IN> | FilterTypeOptions<FilterType.BETWEEN> | FilterTypeOptions<FilterType.CLOSED_OPEN> | FilterTypeOptions<FilterType.TIME> | FilterTypeOptions<FilterType.STRING_SEARCH>;
+/**
+ * Adds a {@link Filter} to the filter set. Any previous filters with the same
+ * `column` and `type` will be replaced.
+ */
+declare function addFilter(filters: Record<string, Filter>, { column, type, values, owner }: AddFilterOptions): Record<string, Filter>;
+type RemoveFilterOptions = {
+    column: string;
+    owner?: string;
+};
+/**
+ * Removes one or more {@link Filter filters} from the filter set. If only
+ * `column` is specified, then all filters on that column are removed. If both
+ * `column` and `owner` are specified, then only filters for that column
+ * associated with the owner are removed.
+ */
+declare function removeFilter(filters: Record<string, Filter>, { column, owner }: RemoveFilterOptions): Record<string, Filter>;
+/**
+ * Clears all {@link Filter filters} from the filter set.
+ */
+declare function clearFilters(filters: Record<string, Filter>): Record<string, Filter>;
+type HasFilterOptions = {
+    column: string;
+    owner?: string;
+};
+declare function hasFilter(filters: Record<string, Filter>, { column, owner }: HasFilterOptions): boolean;
+type GetFilterOptions<T extends FilterType> = {
+    column: string;
+    type: T;
+    owner?: string;
+};
+declare function getFilter<T extends FilterType>(filters: Record<string, Filter>, { column, type, owner }: GetFilterOptions<T>): Filter[T] | null;
+
+/**
+ * Returns a {@link SpatialFilter} for a given viewport, typically obtained
+ * from deck.gl's `viewport.getBounds()` method ([west, south, east, north]).
+ * If the viewport covers the entire world (to some margin of error in Web
+ * Mercator space), `undefined` is returned instead.
+ *
+ * If the viewport extends beyond longitude range [-180, +180], the polygon
+ * may be reformatted for compatibility with CARTO APIs.
+ */
+declare function createViewportSpatialFilter(viewport: BBox): SpatialFilter | undefined;
+/**
+ * Returns a {@link SpatialFilter} for a given {@link Polygon} or
+ * {@link MultiPolygon}. If the polygon(s) extend outside longitude
+ * range [-180, +180], the result may be reformatted for compatibility
+ * with CARTO APIs.
+ */
+declare function createPolygonSpatialFilter(spatialFilter: Polygon | MultiPolygon): SpatialFilter | undefined;
+
+declare const SOURCE_DEFAULTS: Omit<SourceOptionalOptions, 'clientId'>;
 
 type BoundaryQuerySourceOptions = SourceOptions & FilterOptions & {
     columns?: string[];
@@ -694,8 +1079,6 @@ interface BaseRequestOptions {
     signal?: AbortSignal;
     spatialFilter?: SpatialFilter;
     spatialFiltersMode?: SpatialFilterPolyfillMode;
-    /** Required for table- and query-based spatial index sources (H3, Quadbin). */
-    spatialIndexReferenceViewState?: ViewState;
     /** Overrides source filters, if any. */
     filters?: Filters;
     filterOwner?: string;
@@ -839,26 +1222,6 @@ type TimeSeriesResponse = {
 /** Response from {@link WidgetRemoteSource#getHistogram}. */
 type HistogramResponse = number[];
 
-interface ModelSource {
-    type: MapType;
-    apiVersion: ApiVersion;
-    apiBaseUrl: string;
-    accessToken: string;
-    clientId: string;
-    connectionName: string;
-    data: string;
-    filters?: Record<string, Filter>;
-    filtersLogicalOperator?: FilterLogicalOperator;
-    spatialFilter?: SpatialFilter;
-    queryParameters?: QueryParameters;
-    spatialDataColumn?: string;
-    spatialDataType?: SpatialDataType;
-    spatialFiltersResolution?: number;
-    spatialFiltersMode?: SpatialFilterPolyfillMode;
-    /** original resolution of the spatial index data as stored in the DW */
-    dataResolution?: number;
-}
-
 interface WidgetSourceProps extends Omit<SourceOptions, 'filters'> {
     apiVersion?: ApiVersion;
     filters?: Record<string, Filter>;
@@ -881,7 +1244,6 @@ declare abstract class WidgetSource<Props extends WidgetSourceProps = WidgetSour
      * and stability if many (10+) sources are created and not released.
      */
     destroy(): void;
-    protected _getSpatialFiltersResolution(source: Omit<ModelSource, 'type' | 'data'>, spatialFilter?: SpatialFilter, referenceViewState?: ViewState): number | undefined;
     /**
      * Returns a list of labeled datapoints for categorical data. Suitable for
      * charts including grouped bar charts, pie charts, and tree charts.
@@ -929,6 +1291,23 @@ declare abstract class WidgetSource<Props extends WidgetSourceProps = WidgetSour
     abstract getTimeSeries(options: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
 }
 
+interface ModelSource {
+    type: MapType;
+    apiVersion: ApiVersion;
+    apiBaseUrl: string;
+    accessToken: string;
+    clientId: string;
+    connectionName: string;
+    data: string;
+    filters?: Record<string, Filter>;
+    filtersLogicalOperator?: FilterLogicalOperator;
+    spatialFilter?: SpatialFilter;
+    queryParameters?: QueryParameters;
+    spatialDataColumn?: string;
+    spatialDataType?: SpatialDataType;
+    spatialFiltersMode?: SpatialFilterPolyfillMode;
+}
+
 type WidgetRemoteSourceProps = WidgetSourceProps;
 /**
  * Source for Widget API requests.
@@ -984,36 +1363,6 @@ declare class WidgetQuerySource extends WidgetRemoteSource<LayerQuerySourceOptio
     protected getModelSource(filters: Filters | undefined, filterOwner?: string): ModelSource;
 }
 
-type LayerTableSourceOptions = Omit<VectorTableSourceOptions, 'filters'> | Omit<H3TableSourceOptions, 'filters'> | Omit<QuadbinTableSourceOptions, 'filters'>;
-type WidgetTableSourceResult = {
-    widgetSource: WidgetTableSource;
-};
-/**
- * Source for Widget API requests on a data source defined as a table.
- *
- * Generally not intended to be constructed directly. Instead, call
- * {@link vectorTableSource}, {@link h3TableSource}, or {@link quadbinTableSource},
- * which can be shared with map layers. Sources contain a `widgetSource` property,
- * for use by widget implementations.
- *
- * Example:
- *
- * ```javascript
- * import { vectorTableSource } from '@carto/api-client';
- *
- * const data = vectorTableSource({
- *   accessToken: '••••',
- *   connectionName: 'carto_dw',
- *   tableName: 'carto-demo-data.demo_tables.retail_stores'
- * });
- *
- * const { widgetSource } = await data;
- * ```
- */
-declare class WidgetTableSource extends WidgetRemoteSource<LayerTableSourceOptions & WidgetRemoteSourceProps> {
-    protected getModelSource(filters: Filters | undefined, filterOwner?: string): ModelSource;
-}
-
 /**
  * @internal
  * @privateRemarks Exported for use in @deck.gl/carto's getDataFilterExtensionProps.
@@ -1053,6 +1402,7 @@ type TileFeatures = {
     spatialDataColumn?: string;
     spatialFilter: SpatialFilter;
     uniqueIdProperty?: string;
+    rasterMetadata?: RasterMetadata;
     options?: TileFeatureExtractOptions;
 };
 /** @privateRemarks Source: @carto/react-core */
@@ -1061,7 +1411,7 @@ type TileFeatureExtractOptions = {
     uniqueIdProperty?: string;
 };
 /** @privateRemarks Source: @carto/react-core */
-declare function tileFeatures({ tiles, spatialFilter, uniqueIdProperty, tileFormat, spatialDataColumn, spatialDataType, options, }: TileFeatures): FeatureData[];
+declare function tileFeatures({ tiles, spatialFilter, uniqueIdProperty, tileFormat, spatialDataColumn, spatialDataType, rasterMetadata, options, }: TileFeatures): FeatureData[];
 
 declare const FEATURE_GEOM_PROPERTY = "__geomValue";
 declare function tileFeaturesGeometries({ tiles, tileFormat, spatialFilter, uniqueIdProperty, options, }: {
@@ -1167,12 +1517,12 @@ type WidgetTilesetSourceResult = {
  * const { widgetSource } = await data;
  * ```
  */
-declare class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps> {
+declare class WidgetTilesetSource<Props extends WidgetTilesetSourceProps = WidgetTilesetSourceProps> extends WidgetSource<Props> {
     protected _localImpl: WidgetTilesetSourceImpl | null;
     protected _workerImpl: Worker | null;
     protected _workerEnabled: boolean;
     protected _workerNextRequestId: number;
-    constructor(props: WidgetTilesetSourceProps);
+    constructor(props: Props);
     destroy(): void;
     /**
      * Returns an initialized Worker, to be reused for the lifecycle of this
@@ -1208,6 +1558,46 @@ declare class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
     getRange({ signal, ...options }: RangeRequestOptions): Promise<RangeResponse>;
 }
 
+type WidgetRasterSourceProps = WidgetTilesetSourceProps & {
+    rasterMetadata: RasterMetadata;
+    spatialDataType: 'quadbin';
+};
+type WidgetRasterSourceResult = {
+    widgetSource: WidgetRasterSource;
+};
+declare class WidgetRasterSource extends WidgetTilesetSource<WidgetRasterSourceProps> {
+}
+
+type LayerTableSourceOptions = Omit<VectorTableSourceOptions, 'filters'> | Omit<H3TableSourceOptions, 'filters'> | Omit<QuadbinTableSourceOptions, 'filters'>;
+type WidgetTableSourceResult = {
+    widgetSource: WidgetTableSource;
+};
+/**
+ * Source for Widget API requests on a data source defined as a table.
+ *
+ * Generally not intended to be constructed directly. Instead, call
+ * {@link vectorTableSource}, {@link h3TableSource}, or {@link quadbinTableSource},
+ * which can be shared with map layers. Sources contain a `widgetSource` property,
+ * for use by widget implementations.
+ *
+ * Example:
+ *
+ * ```javascript
+ * import { vectorTableSource } from '@carto/api-client';
+ *
+ * const data = vectorTableSource({
+ *   accessToken: '••••',
+ *   connectionName: 'carto_dw',
+ *   tableName: 'carto-demo-data.demo_tables.retail_stores'
+ * });
+ *
+ * const { widgetSource } = await data;
+ * ```
+ */
+declare class WidgetTableSource extends WidgetRemoteSource<LayerTableSourceOptions & WidgetRemoteSourceProps> {
+    protected getModelSource(filters: Filters | undefined, filterOwner?: string): ModelSource;
+}
+
 type H3QuerySourceOptions = SourceOptions & QuerySourceOptions & AggregationOptions & FilterOptions;
 type H3QuerySourceResponse = TilejsonResult & WidgetQuerySourceResult;
 declare const h3QuerySource: (options: H3QuerySourceOptions) => Promise<H3QuerySourceResponse>;
@@ -1221,7 +1611,7 @@ type H3TilesetSourceResponse = TilejsonResult & WidgetTilesetSourceResult;
 declare const h3TilesetSource: (options: H3TilesetSourceOptions) => Promise<H3TilesetSourceResponse>;
 
 type RasterSourceOptions = SourceOptions & TilesetSourceOptions & FilterOptions;
-type RasterSourceResponse = TilejsonResult;
+type RasterSourceResponse = TilejsonResult & WidgetRasterSourceResult;
 declare const rasterSource: (options: RasterSourceOptions) => Promise<RasterSourceResponse>;
 
 type QuadbinQuerySourceOptions = SourceOptions & QuerySourceOptions & AggregationOptions & FilterOptions;
@@ -1248,63 +1638,12 @@ type VectorTilesetSourceOptions = SourceOptions & TilesetSourceOptions;
 type VectorTilesetSourceResponse = TilejsonResult & WidgetTilesetSourceResult;
 declare const vectorTilesetSource: (options: VectorTilesetSourceOptions) => Promise<VectorTilesetSourceResponse>;
 
-type APIRequestType = 'Map data' | 'Map instantiation' | 'Public map' | 'Tile stats' | 'SQL' | 'Basemap style';
-type APIErrorContext = {
-    requestType: APIRequestType;
-    mapId?: string;
-    connection?: string;
-    source?: string;
-    type?: MapType;
-};
-/**
- *
- * Custom error for reported errors in CARTO Maps API.
- * Provides useful debugging information in console and context for applications.
- *
- */
-declare class CartoAPIError extends Error {
-    /** Source error from server */
-    error: Error;
-    /** Context (API call & parameters) in which error occured */
-    errorContext: APIErrorContext;
-    /** Response from server */
-    response?: Response;
-    /** JSON Response from server */
-    responseJson?: any;
-    constructor(error: Error, errorContext: APIErrorContext, response?: Response, responseJson?: any);
-}
-
-/** @internal Required by fetchMap(). */
-declare function buildPublicMapUrl({ apiBaseUrl, cartoMapId, }: {
-    apiBaseUrl: string;
-    cartoMapId: string;
-}): string;
-/** @internal Required by fetchMap(). */
-declare function buildStatsUrl({ attribute, apiBaseUrl, connectionName, source, type, }: {
-    attribute: string;
-    apiBaseUrl: string;
-    connectionName: string;
-    source: string;
-    type: MapType;
-}): string;
-
-type QueryOptions = SourceOptions & QuerySourceOptions;
-declare const query: (options: QueryOptions) => Promise<QueryResult>;
-
-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;
-}): Promise<T>;
-
 /**
  * Resolution conversion function. Takes a WebMercatorViewport and returns
  * a H3 resolution such that the screen space size of the hexagons is
  * "similar" to the given tileSize on screen. Intended for use with deck.gl.
  * @internal
+ * @privateRemarks Source: https://github.com/visgl/deck.gl/blob/master/modules/carto/src/layers/h3-tileset-2d.ts
  */
 declare function _getHexagonResolution(viewport: {
     zoom: number;
@@ -1396,4 +1735,4 @@ declare function makeIntervalComplete(intervals: FilterInterval[]): FilterInterv
  */
 declare function transformToTileCoords<T extends Geometry>(geometry: T, bbox: BBox): T;
 
-export { type APIErrorContext, type APIRequestType, type AddFilterOptions, type AggregationFunction, type AggregationType, ApiVersion, type BoundaryQuerySourceOptions, type BoundaryQuerySourceResponse, type BoundaryTableSourceOptions, type BoundaryTableSourceResponse, CartoAPIError, type CategoryRequestOptions, type CategoryResponse, DEFAULT_API_BASE_URL, FEATURE_GEOM_PROPERTY, type FeaturesRequestOptions, type FeaturesResponse, type Filter, type FilterFunction, type FilterInterval, type FilterIntervalComplete, type FilterIntervalExtremum, type FilterLogicalOperator, FilterType, type Filters, type Format, type FormulaRequestOptions, type FormulaResponse, type GeojsonResult, type GetFilterOptions, type GroupByFeature, type GroupDateType, type H3QuerySourceOptions, type H3QuerySourceResponse, type H3TableSourceOptions, type H3TableSourceResponse, type H3TilesetSourceOptions, type H3TilesetSourceResponse, type HasFilterOptions, type HistogramRequestOptions, type HistogramResponse, type JsonResult, type MapType, type NamedQueryParameter, type PositionalQueryParameter, Provider, 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 RasterMetadata, type RasterMetadataBand, type RasterMetadataBandStats, type RasterSourceOptions, type RemoveFilterOptions, SOURCE_DEFAULTS, type ScatterPlotFeature, type ScatterRequestOptions, type ScatterResponse, type SortColumnType, type SortDirection, type SourceOptions, type SpatialFilter, type SpatialFilterPolyfillMode, SpatialIndex, type SpatialIndexTile, type StringSearchOptions, type TableRequestOptions, type TableResponse, type TableSourceOptions, type Tile, type TileFeatureExtractOptions, type TileFeatures, type TileFeaturesSpatialIndexOptions, TileFormat, type TileResolution, type TilejsonResult, type TilesetSourceOptions, 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, WidgetRemoteSource, type WidgetRemoteSourceProps, WidgetSource, type WidgetSourceProps, WidgetTableSource, type WidgetTableSourceResult, WidgetTilesetSource, type WidgetTilesetSourceProps, type WidgetTilesetSourceResult, type _DataFilterExtensionProps, _buildFeatureFilter, _getHexagonResolution, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildPublicMapUrl, buildStatsUrl, clearFilters, createPolygonSpatialFilter, createViewportSpatialFilter, filterFunctions, geojsonFeatures, getClient, getDataFilterExtensionProps, getFilter, groupValuesByColumn, groupValuesByDateColumn, h3QuerySource, h3TableSource, h3TilesetSource, hasFilter, histogram, makeIntervalComplete, quadbinQuerySource, quadbinTableSource, quadbinTilesetSource, query, rasterSource, removeFilter, requestWithParameters, scatterPlot, setClient, tileFeatures, tileFeaturesGeometries, tileFeaturesSpatialIndex, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };
+export { AGGREGATION, type APIErrorContext, type APIRequestType, type AddFilterOptions, type AggregationFunction, type AggregationType, ApiVersion, _default as BASEMAP, type Basemap, type BoundaryQuerySourceOptions, type BoundaryQuerySourceResponse, type BoundaryTableSourceOptions, type BoundaryTableSourceResponse, CartoAPIError, type CategoryRequestOptions, type CategoryResponse, 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, FilterType, type Filters, type Format, type FormulaRequestOptions, type FormulaResponse, type GeojsonResult, 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 JsonResult, type KeplerMapConfig, type LayerDescriptor, type LayerType, type MapLibreBasemap, type MapType, type NamedQueryParameter, OPACITY_MAP, type ParseMapResult, type PositionalQueryParameter, Provider, type ProviderType, type QuadbinQuerySourceOptions, type QuadbinQuerySourceResponse, type QuadbinTableSourceOptions, type QuadbinTableSourceResponse, type QuadbinTilesetSourceOptions, type QuadbinTilesetSourceResponse, type QueryOptions, type QueryParameterValue, type QueryParameters, type QueryResult, type QuerySourceOptions, type RangeRequestOptions, type RangeResponse, type Raster, RasterBandColorinterp, type RasterMetadata, type RasterMetadataBand, type RasterMetadataBandStats, type RasterSourceOptions, type RasterTile, type RemoveFilterOptions, type SCALE_TYPE, SOURCE_DEFAULTS, type ScatterPlotFeature, type ScatterRequestOptions, type ScatterResponse, type SortColumnType, type SortDirection, type SourceOptions, type SpatialFilter, type SpatialFilterPolyfillMode, SpatialIndex, SpatialIndexColumn, type SpatialIndexTile, type StringSearchOptions, type TableRequestOptions, type TableResponse, type TableSourceOptions, type Tile, type TileFeatureExtractOptions, type TileFeatures, type TileFeaturesSpatialIndexOptions, TileFormat, type TileResolution, type TilejsonResult, type TilesetSourceOptions, 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, clearFilters, createPolygonSpatialFilter, createViewportSpatialFilter, fetchBasemapProps, fetchMap, filterFunctions, geojsonFeatures, getClient, getColorAccessor, getColorValueAccessor, getDataFilterExtensionProps, getFilter, getIconUrlAccessor, getLayerProps, getMaxMarkerSize, getSizeAccessor, getTextAccessor, groupValuesByColumn, groupValuesByDateColumn, h3QuerySource, h3TableSource, h3TilesetSource, hasFilter, histogram, makeIntervalComplete, negateAccessor, opacityToAlpha, parseMap, quadbinQuerySource, quadbinTableSource, quadbinTilesetSource, query, rasterSource, removeFilter, requestWithParameters, scatterPlot, setClient, tileFeatures, tileFeaturesGeometries, tileFeaturesSpatialIndex, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };