@carto/api-client 0.4.9-alpha.0 → 0.4.10-alpha.0

package/build/constants-internal.d.ts

@@ -14,6 +14,11 @@ export declare const DEFAULT_GEO_COLUMN = "geom";
 export declare const DEFAULT_MAX_LENGTH_URL = 7000;
 /** @privateRemarks Source: @deck.gl/carto */
 export declare const DEFAULT_TILE_RESOLUTION = 0.5;
+/**
+ * @todo TODO(v0.5): Update DEFAULT_TILE_RESOLUTION and remove this constant.
+ * @internal
+ */
+export declare const REDUCED_QUERIES_TILE_RESOLUTION = 1;
 /**
  * @privateRemarks Source: @deck.gl/carto
  * @internal
@@ -24,3 +29,6 @@ export declare const DEFAULT_AGGREGATION_RES_LEVEL_H3 = 4;
  * @internal
  */
 export declare const DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN = 6;
+/** @internal */
+export declare const DEFAULT_AGGREGATION_EXP_ALIAS = "__aggregationValue";
+export declare const DEFAULT_AGGREGATION_EXP = "1 AS __aggregationValue";

package/build/constants.d.ts

@@ -39,7 +39,6 @@ export declare enum TileFormat {
 /** @privateRemarks Source: @carto/react-core */
 export declare enum SpatialIndex {
     H3 = "h3",
-    S2 = "s2",
     QUADBIN = "quadbin"
 }
 /** @privateRemarks Source: @carto/react-core */
@@ -51,3 +50,7 @@ export declare enum Provider {
     DATABRICKS = "databricks",
     DATABRICKS_REST = "databricksRest"
 }
+export declare const SpatialIndexColumn: Readonly<{
+    h3: string[];
+    quadbin: string[];
+}>;

package/build/fetch-map/basemap-styles.d.ts

@@ -0,0 +1,27 @@
+import { APIErrorContext } from '../api/index.js';
+import { GoogleBasemapProps } from './types.js';
+export declare const CARTO_MAP_STYLES: string[];
+export declare const GOOGLE_BASEMAPS: Record<string, GoogleBasemapProps>;
+type StyleLayerGroupSlug = 'label' | 'road' | 'border' | 'building' | 'water' | 'land';
+type StyleLayerGroup = {
+    slug: StyleLayerGroupSlug;
+    filter: (layer: any) => boolean;
+    defaultVisibility: boolean;
+};
+export declare const STYLE_LAYER_GROUPS: StyleLayerGroup[];
+export declare function applyLayerGroupFilters(style: any, visibleLayerGroups: Record<StyleLayerGroupSlug, boolean>): any;
+export declare function someLayerGroupsDisabled(visibleLayerGroups?: Record<StyleLayerGroupSlug, boolean>): boolean | undefined;
+export declare function getStyleUrl(styleType: string): string;
+export declare function fetchStyle({ styleUrl, errorContext, }: {
+    styleUrl: string;
+    errorContext?: APIErrorContext;
+}): Promise<any>;
+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;
+};
+export default _default;

package/build/fetch-map/basemap.d.ts

@@ -0,0 +1,17 @@
+import { Basemap, KeplerMapConfig } from './types.js';
+import { APIErrorContext } from '../api/index.js';
+/**
+ * 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.
+ */
+export 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>;

package/build/fetch-map/fetch-map.d.ts

@@ -0,0 +1,47 @@
+import { ParseMapResult } from './parse-map.js';
+import type { Basemap } from './types.js';
+export 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;
+};
+export type FetchMapResult = ParseMapResult & {
+    /**
+     * Basemap properties.
+     */
+    basemap: Basemap | null;
+    stopAutoRefresh?: () => void;
+};
+export declare function fetchMap({ accessToken, apiBaseUrl, cartoMapId, clientId, headers, autoRefresh, onNewData, maxLengthURL, }: FetchMapOptions): Promise<FetchMapResult>;

package/build/fetch-map/index.d.ts

@@ -0,0 +1,7 @@
+export { default as BASEMAP } from './basemap-styles.js';
+export { fetchMap } from './fetch-map.js';
+export type { FetchMapOptions, FetchMapResult } from './fetch-map.js';
+export type { Basemap, MapLibreBasemap, GoogleBasemap, KeplerMapConfig, } from './types.js';
+export * from './basemap.js';
+export * from './layer-map.js';
+export * from './parse-map.js';

package/build/fetch-map/layer-map.d.ts

@@ -0,0 +1,28 @@
+export type LayerType = 'clusterTile' | 'h3' | 'heatmapTile' | 'mvt' | 'quadbin' | 'raster' | 'tileset';
+import { CustomMarkersRange, Dataset, MapLayerConfig, VisConfig, VisualChannelField, VisualChannels } from './types.js';
+declare const SCALE_FUNCS: Record<string, () => any>;
+export type SCALE_TYPE = keyof typeof SCALE_FUNCS;
+export declare const AGGREGATION: Record<string, string>;
+export declare const OPACITY_MAP: Record<string, string>;
+export declare function getLayerProps(type: LayerType, config: MapLayerConfig, dataset: Dataset): {
+    propMap: any;
+    defaultProps: any;
+};
+declare function domainFromValues(values: any, scaleType: SCALE_TYPE): any;
+export declare function opacityToAlpha(opacity?: number): number;
+export declare function getColorValueAccessor({ name }: VisualChannelField, colorAggregation: string, data: any): any;
+export declare function getColorAccessor({ name, colorColumn }: VisualChannelField, scaleType: SCALE_TYPE, { aggregation, range }: {
+    aggregation: string;
+    range: any;
+}, opacity: number | undefined, data: any): any;
+export declare function getIconUrlAccessor(field: VisualChannelField | null | undefined, range: CustomMarkersRange | null | undefined, { fallbackUrl, maxIconSize, useMaskedIcons, }: {
+    fallbackUrl?: string | null;
+    maxIconSize: number;
+    useMaskedIcons?: boolean;
+}, data: any): any;
+export declare function getMaxMarkerSize(visConfig: VisConfig, visualChannels: VisualChannels): number;
+type Accessor = number | ((d: any, i: any) => number);
+export declare function negateAccessor(accessor: Accessor): Accessor;
+export declare function getSizeAccessor({ name }: VisualChannelField, scaleType: SCALE_TYPE | undefined, aggregation: string | null | undefined, range: Iterable<Range> | null | undefined, data: any): any;
+export declare function getTextAccessor({ name, type }: VisualChannelField, data: any): any;
+export { domainFromValues as _domainFromValues };

package/build/fetch-map/parse-map.d.ts

@@ -0,0 +1,39 @@
+import { LayerType } from './layer-map.js';
+import { Filters } from '../types.js';
+export type LayerDescriptor = {
+    type: LayerType;
+    props: Record<string, any>;
+    filters?: Filters;
+};
+export 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[];
+};
+export 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)[];
+};

package/build/fetch-map/source.d.ts

@@ -0,0 +1,20 @@
+import { Dataset } from './types.js';
+import { TilejsonResult } from '../sources/types.js';
+import { Filter } from '../types.js';
+type FetchDatasetOptions = {
+    accessToken: string;
+    apiBaseUrl: string;
+    connection: string;
+    headers?: Record<string, string>;
+    localCache?: {
+        cacheControl: 'no-cache'[];
+    };
+    maxLengthURL?: number;
+};
+type FetchDataset = {
+    dataset: Dataset;
+    filters?: Filter;
+    options: FetchDatasetOptions;
+};
+export declare function configureSource({ dataset, filters, options, }: FetchDataset): Promise<TilejsonResult>;
+export {};

package/build/fetch-map/types.d.ts

@@ -0,0 +1,220 @@
+import { LayerType, SCALE_TYPE } from './layer-map.js';
+import { Format, MapType, ProviderType, QueryParameters } from '../types.js';
+import { TilejsonResult, GeojsonResult, JsonResult } from '../sources/types.js';
+export type VisualChannelField = {
+    name: string;
+    type: string;
+    colorColumn?: string;
+};
+export 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;
+};
+export type ColorRange = {
+    category: string;
+    colors: string[];
+    colorMap: string[][] | undefined;
+    name: string;
+    type: string;
+};
+export type CustomMarkersRange = {
+    markerMap: {
+        value: string;
+        markerUrl?: string;
+    }[];
+    othersMarker?: string;
+};
+export 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;
+};
+export type TextLabel = {
+    field: VisualChannelField | null | undefined;
+    alignment?: 'center' | 'bottom' | 'top';
+    anchor?: 'middle' | 'start' | 'end';
+    size: number;
+    color?: number[];
+    offset?: [number, number];
+    outlineColor?: number[];
+};
+export type MapLayerConfig = {
+    columns?: Record<string, any>;
+    color?: number[];
+    label?: string;
+    dataId: string;
+    textLabel: TextLabel[];
+    visConfig: VisConfig;
+};
+export type MapConfigLayer = {
+    type: LayerType;
+    id: string;
+    config: MapLayerConfig;
+    visualChannels: VisualChannels;
+};
+export interface CustomStyle {
+    url?: string;
+    style?: any;
+    customAttribution?: string;
+}
+export 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;
+    };
+};
+export type BasemapType = 'maplibre' | 'google-maps';
+export type Basemap = MapLibreBasemap | GoogleBasemap;
+export 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>;
+};
+export 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>;
+};
+export type MapLibreBasemapProps = {
+    style: string | Record<string, any>;
+    center: [number, number];
+    zoom: number;
+    pitch?: number;
+    bearing?: number;
+};
+export type GoogleBasemap = BasemapCommon & {
+    type: 'google-maps';
+    /**
+     * Google map properties.
+     *
+     * Meant to be passed to directly to `google.maps.Map` object.
+     */
+    props: GoogleBasemapProps;
+};
+export type GoogleBasemapProps = {
+    mapTypeId: string;
+    mapId?: string;
+    center?: {
+        lat: number;
+        lng: number;
+    };
+    zoom?: number;
+    tilt?: number;
+    heading?: number;
+};
+export 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;
+};
+export type AttributeType = 'String' | 'Number' | 'Timestamp' | 'Boolean';
+export type AttributeStatsBase = {
+    attribute: string;
+    type: AttributeType;
+};
+export type AttributeStatsNumber = AttributeStatsBase & {
+    type: 'Number';
+    min: number;
+    avg: number;
+    max: number;
+    sum: number;
+    quantiles: number[][];
+};
+export type AttributeStatsTimestamp = AttributeStatsBase & {
+    type: 'Timestamp';
+    min: string;
+    max: string;
+};
+export interface AttributeStatsStringCategory {
+    category: string;
+    frequency: number;
+}
+export type AttributeStatsString = AttributeStatsBase & {
+    type: 'String' | 'Boolean';
+    categories: AttributeStatsStringCategory[];
+};
+/**
+ * Result of getAttributeStats request to backend.
+ */
+export type AttributeStats = AttributeStatsString | AttributeStatsNumber | AttributeStatsTimestamp;

package/build/fetch-map/utils.d.ts

@@ -0,0 +1,18 @@
+import type { BinaryFeature } from '@loaders.gl/schema';
+import type { Dataset } from './types.js';
+type Properties = BinaryFeature['properties'];
+type NumericProps = BinaryFeature['numericProps'];
+export declare function createBinaryProxy(data: {
+    numericProps: NumericProps;
+    properties: Properties[];
+}, index: number): object[];
+export declare function scaleIdentity(): {
+    (x: any): any;
+    invert: /*elided*/ any;
+    domain: (d: any) => any;
+    range(d: any): any;
+    unknown(u: any): any;
+    copy(): /*elided*/ any;
+};
+export declare function isRemoteCalculationSupported(dataset: Dataset): boolean;
+export {};

package/build/index.d.ts

@@ -1,6 +1,7 @@
 export * from './client.js';
 export * from './constants.js';
 export * from './deck/index.js';
+export * from './fetch-map/index.js';
 export * from './filters.js';
 export * from './geo.js';
 export * from './sources/index.js';

package/build/models/model.d.ts

@@ -20,8 +20,6 @@ export interface ModelSource {
     spatialDataColumn?: string;
     spatialDataType?: SpatialDataType;
     spatialFiltersMode?: SpatialFilterPolyfillMode;
-    /** original resolution of the spatial index data as stored in the DW */
-    dataResolution?: number;
 }
 /**
  * Execute a SQL model request.

package/build/sources/types.d.ts

@@ -98,7 +98,10 @@ export type AggregationOptions = {
      */
     aggregationResLevel?: number;
     /**
-     * Original resolution of the spatial index data as stored in the DW
+     * Deprecated parameter previously used for H3 and Quadbin widgets. Now has
+     * no effect and will be removed in a future version.
+     * @deprecated Parameter has no effect.
+     * @todo TODO(v0.5): Remove spatialIndexReferenceViewState parameter.
      */
     dataResolution?: number;
 };

package/build/types.d.ts

@@ -8,6 +8,8 @@ import type { BinaryFeature, BinaryFeatureCollection } from '@loaders.gl/schema'
 export type Format = 'json' | 'geojson' | 'tilejson';
 /** @privateRemarks Source: @carto/constants, @deck.gl/carto */
 export type MapType = 'boundary' | 'query' | 'table' | 'tileset' | 'raster';
+/** @privateRemarks Source: cloud-native */
+export 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".

package/build/widget-sources/types.d.ts

@@ -15,6 +15,13 @@ interface BaseRequestOptions {
     signal?: AbortSignal;
     spatialFilter?: SpatialFilter;
     spatialFiltersMode?: SpatialFilterPolyfillMode;
+    /**
+     * Deprecated parameter previously used for H3 and Quadbin widgets. Now has
+     * no effect and will be removed in a future version.
+     * @deprecated Parameter has no effect.
+     * @todo TODO(v0.5): Remove spatialIndexReferenceViewState parameter.
+     */
+    spatialIndexReferenceViewState?: ViewState;
     /** Overrides source filters, if any. */
     filters?: Filters;
     filterOwner?: string;

package/package.json

@@ -8,7 +8,7 @@
   "homepage": "https://github.com/CartoDB/carto-api-client#readme",
   "author": "Don McCurdy <donmccurdy@carto.com>",
   "packageManager": "yarn@4.3.1",
-  "version": "0.4.9-alpha.0",
+  "version": "0.4.10-alpha.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -68,55 +68,58 @@
     "@turf/invariant": "^7.2.0",
     "@turf/union": "^7.2.0",
     "@types/geojson": "^7946.0.16",
+    "d3-format": "^3.1.0",
     "d3-scale": "^4.0.2",
     "h3-js": "4.1.0"
   },
   "devDependencies": {
-    "@deck.gl/aggregation-layers": "~9.1.0",
-    "@deck.gl/carto": "~9.1.0",
-    "@deck.gl/core": "~9.1.0",
-    "@deck.gl/extensions": "~9.1.0",
-    "@deck.gl/geo-layers": "~9.1.0",
-    "@deck.gl/google-maps": "~9.1.0",
-    "@deck.gl/layers": "~9.1.0",
-    "@deck.gl/mapbox": "~9.1.0",
-    "@deck.gl/mesh-layers": "~9.1.0",
+    "@deck.gl/aggregation-layers": "~9.1.6",
+    "@deck.gl/carto": "~9.1.6",
+    "@deck.gl/core": "~9.1.6",
+    "@deck.gl/extensions": "~9.1.6",
+    "@deck.gl/geo-layers": "~9.1.6",
+    "@deck.gl/google-maps": "~9.1.6",
+    "@deck.gl/layers": "~9.1.6",
+    "@deck.gl/mapbox": "~9.1.6",
+    "@deck.gl/mesh-layers": "~9.1.6",
     "@eslint/js": "^9.20.0",
     "@googlemaps/js-api-loader": "^1.16.6",
     "@lit/react": "^1.0.7",
     "@lit/task": "^1.0.2",
     "@loaders.gl/core": "^4.3.3",
-    "@luma.gl/core": "~9.1.0",
-    "@luma.gl/engine": "~9.1.0",
-    "@luma.gl/shadertools": "~9.1.0",
+    "@luma.gl/core": "~9.1.5",
+    "@luma.gl/engine": "~9.1.5",
+    "@luma.gl/shadertools": "~9.1.5",
+    "@luma.gl/webgl": "~9.1.5",
     "@turf/buffer": "^7.2.0",
     "@turf/random": "^7.2.0",
+    "@types/d3-format": "^3.0.4",
     "@types/d3-scale": "^4.0.9",
     "@types/json-schema": "^7.0.15",
     "@types/react": "^18.3.18",
     "@types/semver": "^7.5.8",
-    "@vitest/coverage-istanbul": "^3.0.5",
+    "@vitest/coverage-istanbul": "^3.0.9",
     "@webcomponents/webcomponentsjs": "^2.8.0",
     "concurrently": "^9.1.2",
     "echarts": "^5.6.0",
-    "eslint": "^9.20.1",
+    "eslint": "^9.22.0",
     "lit": "^3.2.1",
     "lit-analyzer": "^2.0.3",
-    "maplibre-gl": "^5.1.0",
+    "maplibre-gl": "^5.2.0",
     "microbundle": "^0.15.1",
-    "prettier": "^3.4.2",
+    "prettier": "^3.5.3",
     "rimraf": "^6.0.1",
     "semver": "^7.7.1",
     "thenby": "^1.3.4",
     "tinybench": "^3.1.1",
     "typescript": "~5.8.2",
-    "typescript-eslint": "^8.24.0",
-    "vite": "^6.1.0",
-    "vitest": "3.0.7"
+    "typescript-eslint": "^8.26.1",
+    "vite": "^6.2.2",
+    "vitest": "3.0.9"
   },
   "resolutions": {
     "@carto/api-client": "portal:./",
     "rollup": "^4.20.0"
   },
-  "stableVersion": "0.4.8"
+  "stableVersion": "0.4.9"
 }

package/src/constants-internal.ts

@@ -19,6 +19,12 @@ export const DEFAULT_MAX_LENGTH_URL = 7000;
 /** @privateRemarks Source: @deck.gl/carto */
 export const DEFAULT_TILE_RESOLUTION = 0.5;
 
+/**
+ * @todo TODO(v0.5): Update DEFAULT_TILE_RESOLUTION and remove this constant.
+ * @internal
+ */
+export const REDUCED_QUERIES_TILE_RESOLUTION = 1;
+
 /**
  * @privateRemarks Source: @deck.gl/carto
  * @internal
@@ -30,3 +36,7 @@ export const DEFAULT_AGGREGATION_RES_LEVEL_H3 = 4;
  * @internal
  */
 export const DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN = 6;
+
+/** @internal */
+export const DEFAULT_AGGREGATION_EXP_ALIAS = '__aggregationValue';
+export const DEFAULT_AGGREGATION_EXP = `1 AS ${DEFAULT_AGGREGATION_EXP_ALIAS}`;

package/src/constants.ts

@@ -43,7 +43,6 @@ export enum TileFormat {
 /** @privateRemarks Source: @carto/react-core */
 export enum SpatialIndex {
   H3 = 'h3',
-  S2 = 's2',
   QUADBIN = 'quadbin',
 }
 
@@ -56,3 +55,8 @@ export enum Provider {
   DATABRICKS = 'databricks',
   DATABRICKS_REST = 'databricksRest',
 }
+
+export const SpatialIndexColumn = Object.freeze({
+  [SpatialIndex.H3]: ['h3', 'hex', 'h3id', 'hex_id', 'h3hex'],
+  [SpatialIndex.QUADBIN]: ['quadbin'],
+});