@deck.gl/carto 8.8.0-beta.2 → 8.8.0-beta.5

package/package.json

@@ -2,7 +2,7 @@
   "name": "@deck.gl/carto",
   "description": "CARTO official integration with Deck.gl. Build geospatial applications using CARTO and Deck.gl.",
   "license": "MIT",
-  "version": "8.8.0-beta.2",
+  "version": "8.8.0-beta.5",
   "publishConfig": {
     "access": "public"
   },
@@ -61,5 +61,5 @@
     "@deck.gl/layers": "^8.0.0",
     "@loaders.gl/core": "^3.0.0"
   },
-  "gitHead": "d9bae59d015387c547366465d75d80950c60a34e"
+  "gitHead": "20b7becdb467aa917c17c9517461bf62ecc48b12"
 }

package/src/api/index.ts

@@ -1,3 +1,3 @@
 export {FORMATS, TILE_FORMATS, MAP_TYPES, API_VERSIONS} from './maps-api-common';
 export {getDataV2, CONNECTIONS} from './maps-client';
-export {fetchLayerData, fetchMap, getData, mapInstantiation} from './maps-v3-client';
+export {fetchLayerData, fetchMap, mapInstantiation} from './maps-v3-client';

package/src/api/maps-v3-client.ts

@@ -356,30 +356,6 @@ async function _fetchDataUrl({
   return {url, accessToken, mapFormat, metadata};
 }
 
-export async function getData({
-  type,
-  source,
-  connection,
-  credentials,
-  geoColumn,
-  columns,
-  format,
-  clientId
-}: FetchLayerDataParams) {
-  log.deprecated('getData', 'fetchLayerData')();
-  const layerData = await fetchLayerData({
-    type,
-    source,
-    connection,
-    credentials,
-    geoColumn,
-    columns,
-    format,
-    clientId
-  });
-  return layerData.data;
-}
-
 /* global clearInterval, setInterval, URL */
 async function _fetchMapDataset(
   dataset,

package/src/index.ts

@@ -2,7 +2,7 @@ export {getDefaultCredentials, setDefaultCredentials} from './config';
 export {default as CartoLayer} from './layers/carto-layer';
 export {default as _CartoTileLayer} from './layers/carto-tile-layer';
 export {default as _H3TileLayer} from './layers/h3-tile-layer';
-export {default as _QuadkeyTileLayer} from './layers/quadkey-tile-layer';
+export {default as _QuadbinTileLayer} from './layers/quadbin-tile-layer';
 export {default as BASEMAP} from './basemap';
 export {default as colorBins} from './style/color-bins-style';
 export {default as colorCategories} from './style/color-categories-style';
@@ -15,7 +15,6 @@ export {
   fetchLayerData,
   fetchMap,
   getDataV2 as _getDataV2,
-  getData,
   mapInstantiation as _mapInstantiation
 } from './api';
 

package/src/layers/carto-layer.ts

@@ -8,13 +8,11 @@ import {
 } from '@deck.gl/core';
 import CartoTileLayer from './carto-tile-layer';
 import H3TileLayer from './h3-tile-layer';
-import QuadkeyTileLayer from './quadkey-tile-layer';
+import QuadbinTileLayer from './quadbin-tile-layer';
 import {MVTLayer} from '@deck.gl/geo-layers';
-import {GeoJsonLayer} from '@deck.gl/layers';
 import {fetchLayerData, getDataV2, API_VERSIONS} from '../api';
 import {
   COLUMNS_SUPPORT,
-  Format,
   FORMATS,
   GEO_COLUMN_SUPPORT,
   MapType,
@@ -64,10 +62,10 @@ const defaultProps = {
   // (Array<String>, optional): names of columns to fetch. By default, all columns are fetched.
   columns: {type: 'array', value: null},
 
-  // (String, optional): aggregration SQL expression. Only used for spatial index datasets
+  // (String, optional): aggregation SQL expression. Only used for spatial index datasets
   aggregationExp: null,
 
-  // (Number, optional): aggregration resolution level. Only used for spatial index datasets, defaults to 6 for quadkeys, 4 for h3
+  // (Number, optional): aggregation resolution level. Only used for spatial index datasets, defaults to 6 for quadbins, 4 for h3
   aggregationResLevel: null
 };
 
@@ -98,19 +96,10 @@ type _CartoLayerProps = {
    */
   connection?: string;
 
-  /**
-   * Use to override the default data format.
-   *
-   * Only supported when apiVersion is `API_VERSIONS.V3`.
-   *
-   * Possible values are: `FORMATS.GEOJSON`, `FORMATS.JSON` and `FORMATS.TILEJSON`.
-   */
-  format?: Format;
-
   /**
    * Use to override the default tile data format.
    *
-   * Only supported when apiVersion is `API_VERSIONS.V3` and format is `FORMATS.TILEJSON`.
+   * Only supported when apiVersion is `API_VERSIONS.V3`.
    *
    * Possible values are: `TILE_FORMATS.BINARY`, `TILE_FORMATS.GEOJSON` and `TILE_FORMATS.MVT`.
    */
@@ -156,6 +145,12 @@ type _CartoLayerProps = {
   onDataError?: (err: unknown) => void;
 
   clientId?: string;
+
+  /** Aggregation SQL expression. Only used for spatial index datasets **/
+  aggregationExp?: string;
+
+  /** Aggregation resolution level. Only used for spatial index datasets, defaults to 6 for quadbins, 4 for h3. **/
+  aggregationResLevel?: number;
 };
 
 export default class CartoLayer<ExtraProps = {}> extends CompositeLayer<
@@ -227,9 +222,10 @@ export default class CartoLayer<ExtraProps = {}> extends CompositeLayer<
     this._checkProps(props);
     const shouldUpdateData =
       changeFlags.dataChanged ||
+      props.aggregationExp !== oldProps.aggregationExp ||
+      props.aggregationResLevel !== oldProps.aggregationResLevel ||
       props.connection !== oldProps.connection ||
       props.geoColumn !== oldProps.geoColumn ||
-      props.format !== oldProps.format ||
       props.formatTiles !== oldProps.formatTiles ||
       props.type !== oldProps.type ||
       JSON.stringify(props.columns) !== JSON.stringify(oldProps.columns) ||
@@ -260,7 +256,9 @@ export default class CartoLayer<ExtraProps = {}> extends CompositeLayer<
           clientId,
           credentials: credentials as CloudNativeCredentials,
           connection,
-          ...rest
+          ...rest,
+          // CartoLayer only supports tiled output from v8.8, force data format
+          format: FORMATS.TILEJSON
         });
       }
 
@@ -282,7 +280,7 @@ export default class CartoLayer<ExtraProps = {}> extends CompositeLayer<
   _getSubLayerAndProps(): [any, LayerProps] {
     assert(this.state);
 
-    const {data, format, apiVersion} = this.state;
+    const {data, apiVersion} = this.state;
 
     const {uniqueIdProperty} = defaultProps;
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -294,26 +292,21 @@ export default class CartoLayer<ExtraProps = {}> extends CompositeLayer<
       return [MVTLayer, props];
     }
 
-    if (format === FORMATS.TILEJSON) {
-      /* global URL */
-      const tileUrl = new URL(data.tiles[0]);
+    /* global URL */
+    const tileUrl = new URL(data.tiles[0]);
 
-      props.formatTiles =
-        props.formatTiles ||
-        (tileUrl.searchParams.get('formatTiles') as TileFormat) ||
-        TILE_FORMATS.MVT;
+    props.formatTiles =
+      props.formatTiles ||
+      (tileUrl.searchParams.get('formatTiles') as TileFormat) ||
+      TILE_FORMATS.MVT;
 
-      if (data.scheme === 'h3') {
-        return [H3TileLayer, props];
-      }
-      if (data.scheme === 'quadkey') {
-        return [QuadkeyTileLayer, props];
-      }
-      return props.formatTiles === TILE_FORMATS.MVT ? [MVTLayer, props] : [CartoTileLayer, props];
+    if (data.scheme === 'h3') {
+      return [H3TileLayer, props];
     }
-
-    // It's a geojson layer
-    return [GeoJsonLayer, props];
+    if (data.scheme === 'quadbin') {
+      return [QuadbinTileLayer, props];
+    }
+    return props.formatTiles === TILE_FORMATS.MVT ? [MVTLayer, props] : [CartoTileLayer, props];
   }
 
   renderLayers(): Layer | null {

package/src/layers/h3-tile-layer.ts

@@ -7,7 +7,7 @@ import {
   DefaultProps
 } from '@deck.gl/core';
 import {H3HexagonLayer} from '@deck.gl/geo-layers';
-import H3Tileset2D from './h3-tileset-2d';
+import H3Tileset2D, {getHexagonResolution} from './h3-tileset-2d';
 import SpatialIndexTileLayer from './spatial-index-tile-layer';
 
 const renderSubLayers = props => {
@@ -50,6 +50,7 @@ export default class H3TileLayer<DataT = any, ExtraPropsT = {}> extends Composit
   };
 
   initializeState(): void {
+    H3HexagonLayer._checkH3Lib();
     this.setState({data: null, tileJSON: null});
   }
 
@@ -64,7 +65,26 @@ export default class H3TileLayer<DataT = any, ExtraPropsT = {}> extends Composit
 
   renderLayers(): Layer | null | LayersList {
     const {data, tileJSON} = this.state;
-    const maxZoom = parseInt(tileJSON.maxresolution);
+    let minresolution = parseInt(tileJSON.minresolution);
+    let maxresolution = parseInt(tileJSON.maxresolution);
+
+    // Convert Mercator zooms provided in props into H3 res levels
+    // and clip into valid range provided from the tilejson
+    if (this.props.minZoom) {
+      minresolution = Math.max(
+        minresolution,
+        getHexagonResolution({zoom: this.props.minZoom, latitude: 0})
+      );
+    }
+    if (this.props.maxZoom) {
+      maxresolution = Math.min(
+        maxresolution,
+        getHexagonResolution({zoom: this.props.maxZoom, latitude: 0})
+      );
+    }
+
+    // The naming is unfortunate, but minZoom & maxZoom in the context
+    // of a Tileset2D refer to the resolution levels, not the Mercator zooms
     return [
       new SpatialIndexTileLayer(this.props, {
         id: `h3-tile-layer-${this.props.id}`,
@@ -72,7 +92,9 @@ export default class H3TileLayer<DataT = any, ExtraPropsT = {}> extends Composit
         // @ts-expect-error Tileset2D should be generic over TileIndex
         TilesetClass: H3Tileset2D,
         renderSubLayers,
-        maxZoom
+        // minZoom and maxZoom are H3 resolutions, however we must use this naming as that is what the Tileset2D class expects
+        minZoom: minresolution,
+        maxZoom: maxresolution
       })
     ];
   }

package/src/layers/h3-tileset-2d.ts

@@ -7,16 +7,20 @@ function getHexagonsInBoundingBox(
   {west, north, east, south}: GeoBoundingBox,
   resolution: number
 ): string[] {
-  if (Math.abs(east - west) > 180) {
+  const longitudeSpan = Math.abs(east - west);
+  if (longitudeSpan > 180) {
     // This is a known issue in h3-js: polyfill does not work correctly
     // when longitude span is larger than 180 degrees.
-    return [
-      ...new Set(
-        getHexagonsInBoundingBox({west, north, east: 0, south}, resolution).concat(
-          getHexagonsInBoundingBox({west: 0, north, east, south}, resolution)
-        )
-      )
-    ];
+    const nSegments = Math.ceil(longitudeSpan / 180);
+    let h3Indices: string[] = [];
+    for (let s = 0; s < nSegments; s++) {
+      const segmentEast = east + s * 180;
+      const segmentWest = Math.min(segmentEast + 179.9999999, west);
+      h3Indices = h3Indices.concat(
+        getHexagonsInBoundingBox({west: segmentWest, north, east: segmentEast, south}, resolution)
+      );
+    }
+    return [...new Set(h3Indices)];
   }
 
   // `polyfill()` fills based on hexagon center, which means tiles vanish
@@ -55,7 +59,7 @@ function tileToBoundingBox(index: string): GeoBoundingBox {
 // similar
 // Relative scale factor (0 = no biasing, 2 = a few hexagons cover view)
 const BIAS = 2;
-function getHexagonResolution(viewport): number {
+export function getHexagonResolution(viewport): number {
   const hexagonScaleFactor = (2 / 3) * viewport.zoom;
   const latitudeScaleFactor = Math.log(1 / Math.cos((Math.PI * viewport.latitude) / 180));
 
@@ -64,6 +68,11 @@ function getHexagonResolution(viewport): number {
 }
 
 export default class H3Tileset2D extends Tileset2D {
+  /**
+   * Returns all tile indices in the current viewport. If the current zoom level is smaller
+   * than minZoom, return an empty array. If the current zoom level is greater than maxZoom,
+   * return tiles that are on maxZoom.
+   */
   // @ts-expect-error Tileset2D should be generic over TileIndex
   getTileIndices({viewport, minZoom, maxZoom}): H3TileIndex[] {
     const [east, south, west, north] = viewport.getBounds();
@@ -71,7 +80,8 @@ export default class H3Tileset2D extends Tileset2D {
     let z = getHexagonResolution(viewport);
     let indices: string[];
     if (typeof minZoom === 'number' && Number.isFinite(minZoom) && z < minZoom) {
-      z = minZoom;
+      // TODO support `extent` prop
+      return [];
     }
     if (typeof maxZoom === 'number' && Number.isFinite(maxZoom) && z > maxZoom) {
       z = maxZoom;

package/src/layers/quadbin-layer.ts

@@ -0,0 +1,43 @@
+import {AccessorFunction, DefaultProps} from '@deck.gl/core';
+import {
+  _GeoCellLayer as GeoCellLayer,
+  _GeoCellLayerProps as GeoCellLayerProps
+} from '@deck.gl/geo-layers';
+import {getQuadbinPolygon} from './quadbin-utils';
+
+const defaultProps: DefaultProps<QuadbinLayerProps> = {
+  getQuadbin: {type: 'accessor', value: d => d.quadbin}
+};
+
+/** All properties supported by QuadbinLayer. */
+export type QuadbinLayerProps<DataT = any> = _QuadbinLayerProps<DataT> & GeoCellLayerProps<DataT>;
+
+/** Properties added by QuadbinLayer. */
+type _QuadbinLayerProps<DataT> = {
+  /**
+   * Called for each data object to retrieve the quadbin string identifier.
+   *
+   * By default, it reads `quadbin` property of data object.
+   */
+  getQuadbin?: AccessorFunction<DataT, string>;
+};
+
+export default class QuadbinLayer<DataT = any, ExtraProps = {}> extends GeoCellLayer<
+  DataT,
+  Required<_QuadbinLayerProps<DataT>> & ExtraProps
+> {
+  static layerName = 'QuadbinLayer';
+  static defaultProps = defaultProps;
+
+  indexToBounds(): Partial<GeoCellLayer['props']> | null {
+    const {data, getQuadbin} = this.props;
+
+    return {
+      data,
+      _normalize: false,
+      positionFormat: 'XY',
+
+      getPolygon: (x: DataT, objectInfo) => getQuadbinPolygon(getQuadbin(x, objectInfo))
+    };
+  }
+}

package/src/layers/{quadkey-tile-layer.ts → quadbin-tile-layer.ts}

@@ -6,33 +6,35 @@ import {
   UpdateParameters,
   DefaultProps
 } from '@deck.gl/core';
-import {QuadkeyLayer, QuadkeyLayerProps} from '@deck.gl/geo-layers';
-import QuadkeyTileset2D from './quadkey-tileset-2d';
+import QuadbinLayer, {QuadbinLayerProps} from './quadbin-layer';
+import QuadbinTileset2D from './quadbin-tileset-2d';
 import SpatialIndexTileLayer from './spatial-index-tile-layer';
 
 const renderSubLayers = props => {
   const {data} = props;
   if (!data || !data.length) return null;
-  return new QuadkeyLayer(props, {getQuadkey: d => d.id});
+  return new QuadbinLayer(props, {
+    getQuadbin: d => d.id
+  });
 };
 
-const defaultProps: DefaultProps<QuadkeyTileLayerProps> = {
+const defaultProps: DefaultProps<QuadbinTileLayerProps> = {
   aggregationResLevel: 6
 };
 
-/** All properties supported by QuadkeyTileLayer. */
-export type QuadkeyTileLayerProps<DataT = any> = _QuadkeyTileLayerProps<DataT> &
+/** All properties supported by QuadbinTileLayer. */
+export type QuadbinTileLayerProps<DataT = any> = _QuadbinTileLayerProps<DataT> &
   CompositeLayerProps<DataT>;
 
-/** Properties added by QuadkeyTileLayer. */
-type _QuadkeyTileLayerProps<DataT> = QuadkeyLayerProps<DataT> & {
+/** Properties added by QuadbinTileLayer. */
+type _QuadbinTileLayerProps<DataT> = QuadbinLayerProps<DataT> & {
   aggregationResLevel?: number;
 };
 
-export default class QuadkeyTileLayer<DataT = any, ExtraProps = {}> extends CompositeLayer<
-  ExtraProps & Required<_QuadkeyTileLayerProps<DataT>>
+export default class QuadbinTileLayer<DataT = any, ExtraProps = {}> extends CompositeLayer<
+  ExtraProps & Required<_QuadbinTileLayerProps<DataT>>
 > {
-  static layerName = 'QuadkeyTileLayer';
+  static layerName = 'QuadbinTileLayer';
   static defaultProps = defaultProps;
 
   state!: {
@@ -57,10 +59,10 @@ export default class QuadkeyTileLayer<DataT = any, ExtraProps = {}> extends Comp
     const maxZoom = parseInt(tileJSON?.maxresolution);
     return [
       new SpatialIndexTileLayer(this.props, {
-        id: `quadkey-tile-layer-${this.props.id}`,
+        id: `quadbin-tile-layer-${this.props.id}`,
         data,
         // TODO: Tileset2D should be generic over TileIndex type
-        TilesetClass: QuadkeyTileset2D as any,
+        TilesetClass: QuadbinTileset2D as any,
         renderSubLayers,
         maxZoom
       })

package/src/layers/quadbin-tileset-2d.ts

@@ -0,0 +1,34 @@
+import {_Tileset2D as Tileset2D} from '@deck.gl/geo-layers';
+import {tileToQuadbin, quadbinToTile, quadbinParent, quadbinZoom} from './quadbin-utils';
+
+type QuadbinTileIndex = {i: string};
+
+export default class QuadbinTileset2D extends Tileset2D {
+  // @ts-expect-error for spatial indices, TileSet2d should be parametrized by TileIndexT
+  getTileIndices(opts): QuadbinTileIndex[] {
+    return super
+      .getTileIndices(opts)
+      .map(tileToQuadbin)
+      .map(i => ({i}));
+  }
+
+  // @ts-expect-error TileIndex must be generic
+  getTileId({i}: QuadbinTileIndex): string {
+    return i;
+  }
+
+  // @ts-expect-error TileIndex must be generic
+  getTileMetadata({i}: QuadbinTileIndex) {
+    return super.getTileMetadata(quadbinToTile(i));
+  }
+
+  // @ts-expect-error TileIndex must be generic
+  getTileZoom({i}: QuadbinTileIndex): number {
+    return Number(quadbinZoom(i));
+  }
+
+  // @ts-expect-error TileIndex must be generic
+  getParentIndex({i}: QuadbinTileIndex): QuadbinTileIndex {
+    return {i: quadbinParent(i)};
+  }
+}

package/src/layers/quadbin-utils.ts

@@ -0,0 +1,102 @@
+import {worldToLngLat} from '@math.gl/web-mercator';
+
+const TILE_SIZE = 512;
+
+const B = [
+  0x5555555555555555n,
+  0x3333333333333333n,
+  0x0f0f0f0f0f0f0f0fn,
+  0x00ff00ff00ff00ffn,
+  0x0000ffff0000ffffn,
+  0x00000000ffffffffn
+];
+const S = [0n, 1n, 2n, 4n, 8n, 16n];
+
+function indexToBigInt(index: string): bigint {
+  return BigInt(`0x${index}`);
+}
+
+function bigIntToIndex(quadbin: bigint): string {
+  return quadbin.toString(16);
+}
+
+export function tileToQuadbin(tile): string {
+  if (tile.z < 0 || tile.z > 26) {
+    throw new Error('Wrong zoom');
+  }
+  const z = BigInt(tile.z);
+  let x = BigInt(tile.x) << (32n - z);
+  let y = BigInt(tile.y) << (32n - z);
+
+  for (let i = 0; i < 5; i++) {
+    const s = S[5 - i];
+    const b = B[4 - i];
+    x = (x | (x << s)) & b;
+    y = (y | (y << s)) & b;
+  }
+
+  const quadbin =
+    0x4000000000000000n |
+    (1n << 59n) | // | (mode << 59) | (mode_dep << 57)
+    (z << 52n) |
+    ((x | (y << 1n)) >> 12n) |
+    (0xfffffffffffffn >> (z * 2n));
+  return bigIntToIndex(quadbin);
+}
+
+export function quadbinToTile(index: string) {
+  const quadbin = indexToBigInt(index);
+  const mode = (quadbin >> 59n) & 7n;
+  const modeDep = (quadbin >> 57n) & 3n;
+  const z = (quadbin >> 52n) & 0x1fn;
+  const q = (quadbin & 0xfffffffffffffn) << 12n;
+
+  if (mode !== 1n && modeDep !== 0n) {
+    throw new Error('Wrong mode');
+  }
+
+  let x = q;
+  let y = q >> 1n;
+
+  for (let i = 0; i < 6; i++) {
+    const s = S[i];
+    const b = B[i];
+    x = (x | (x >> s)) & b;
+    y = (y | (y >> s)) & b;
+  }
+
+  x = x >> (32n - z);
+  y = y >> (32n - z);
+
+  return {z: Number(z), x: Number(x), y: Number(y)};
+}
+
+export function quadbinZoom(index: string) {
+  const quadbin = indexToBigInt(index);
+  return (quadbin >> 52n) & 0x1fn;
+}
+
+export function quadbinParent(index: string) {
+  const quadbin = indexToBigInt(index);
+  const zparent = quadbinZoom(index) - 1n;
+  const parent =
+    (quadbin & ~(0x1fn << 52n)) | (zparent << 52n) | (0xfffffffffffffn >> (zparent * 2n));
+  return bigIntToIndex(parent);
+}
+
+export function quadbinToWorldBounds(quadbin: string): [number[], number[]] {
+  const {x, y, z} = quadbinToTile(quadbin);
+  const mask = 1 << z;
+  const scale = mask / TILE_SIZE;
+  return [
+    [x / scale, TILE_SIZE - y / scale],
+    [(x + 0.99) / scale, TILE_SIZE - (y + 0.99) / scale]
+  ];
+}
+
+export function getQuadbinPolygon(quadbin: string): number[] {
+  const [topLeft, bottomRight] = quadbinToWorldBounds(quadbin);
+  const [w, n] = worldToLngLat(topLeft);
+  const [e, s] = worldToLngLat(bottomRight);
+  return [e, n, e, s, w, s, w, n, e, n];
+}

package/typed/api/index.d.ts

@@ -1,4 +1,4 @@
 export { FORMATS, TILE_FORMATS, MAP_TYPES, API_VERSIONS } from './maps-api-common';
 export { getDataV2, CONNECTIONS } from './maps-client';
-export { fetchLayerData, fetchMap, getData, mapInstantiation } from './maps-v3-client';
+export { fetchLayerData, fetchMap, mapInstantiation } from './maps-v3-client';
 //# sourceMappingURL=index.d.ts.map

package/typed/api/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY,EAAC,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAC,SAAS,EAAE,WAAW,EAAC,MAAM,eAAe,CAAC;AACrD,OAAO,EAAC,cAAc,EAAE,QAAQ,EAAE,OAAO,EAAE,gBAAgB,EAAC,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY,EAAC,MAAM,mBAAmB,CAAC;AACjF,OAAO,EAAC,SAAS,EAAE,WAAW,EAAC,MAAM,eAAe,CAAC;AACrD,OAAO,EAAC,cAAc,EAAE,QAAQ,EAAE,gBAAgB,EAAC,MAAM,kBAAkB,CAAC"}

package/typed/api/maps-v3-client.d.ts

@@ -23,7 +23,6 @@ export interface FetchLayerDataResult {
     schema: SchemaField[];
 }
 export declare function fetchLayerData({ type, source, connection, credentials, geoColumn, columns, format, formatTiles, clientId, aggregationExp, aggregationResLevel }: FetchLayerDataParams): Promise<FetchLayerDataResult>;
-export declare function getData({ type, source, connection, credentials, geoColumn, columns, format, clientId }: FetchLayerDataParams): Promise<any>;
 export declare function fetchMap({ cartoMapId, clientId, credentials, autoRefresh, onNewData }: {
     cartoMapId: string;
     clientId: string;

package/typed/api/maps-v3-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"maps-v3-client.d.ts","sourceRoot":"","sources":["../../src/api/maps-v3-client.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAA8C,sBAAsB,EAAC,MAAM,WAAW,CAAC;AAC9F,OAAO,EAIL,MAAM,EAGN,gBAAgB,EAChB,OAAO,EAEP,WAAW,EACX,UAAU,EAEX,MAAM,mBAAmB,CAAC;AA0F3B,aAAK,oBAAoB,GAAG;IAC1B,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,sBAAsB,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,UAAU,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAmCF,wBAAsB,gBAAgB,CAAC,EACrC,IAAI,EACJ,MAAM,EACN,UAAU,EACV,WAAW,EACX,SAAS,EACT,OAAO,EACP,QAAQ,EACR,cAAc,EACd,mBAAmB,EACpB,EAAE,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAuBlD;AAsDD,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,GAAG,CAAC;IACV,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB;AACD,wBAAsB,cAAc,CAAC,EACnC,IAAI,EACJ,MAAM,EACN,UAAU,EACV,WAAW,EACX,SAAS,EACT,OAAO,EACP,MAAM,EACN,WAAW,EACX,QAAQ,EACR,cAAc,EACd,mBAAmB,EACpB,EAAE,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAoBtD;AAgFD,wBAAsB,OAAO,CAAC,EAC5B,IAAI,EACJ,MAAM,EACN,UAAU,EACV,WAAW,EACX,SAAS,EACT,OAAO,EACP,MAAM,EACN,QAAQ,EACT,EAAE,oBAAoB,gBAatB;AA4CD,wBAAsB,QAAQ,CAAC,EAC7B,UAAU,EACV,QAAQ,EACR,WAAW,EACX,WAAW,EACX,SAAS,EACV,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,sBAAsB,CAAC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC;CAChC;4BA8B6B,IAAI;;;;;;;;;GA8BjC"}
+{"version":3,"file":"maps-v3-client.d.ts","sourceRoot":"","sources":["../../src/api/maps-v3-client.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAA8C,sBAAsB,EAAC,MAAM,WAAW,CAAC;AAC9F,OAAO,EAIL,MAAM,EAGN,gBAAgB,EAChB,OAAO,EAEP,WAAW,EACX,UAAU,EAEX,MAAM,mBAAmB,CAAC;AA0F3B,aAAK,oBAAoB,GAAG;IAC1B,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,sBAAsB,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,UAAU,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAmCF,wBAAsB,gBAAgB,CAAC,EACrC,IAAI,EACJ,MAAM,EACN,UAAU,EACV,WAAW,EACX,SAAS,EACT,OAAO,EACP,QAAQ,EACR,cAAc,EACd,mBAAmB,EACpB,EAAE,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAuBlD;AAsDD,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,GAAG,CAAC;IACV,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB;AACD,wBAAsB,cAAc,CAAC,EACnC,IAAI,EACJ,MAAM,EACN,UAAU,EACV,WAAW,EACX,SAAS,EACT,OAAO,EACP,MAAM,EACN,WAAW,EACX,QAAQ,EACR,cAAc,EACd,mBAAmB,EACpB,EAAE,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAoBtD;AA0HD,wBAAsB,QAAQ,CAAC,EAC7B,UAAU,EACV,QAAQ,EACR,WAAW,EACX,WAAW,EACX,SAAS,EACV,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,sBAAsB,CAAC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC;CAChC;4BA8B6B,IAAI;;;;;;;;;GA8BjC"}

package/typed/index.d.ts

@@ -2,11 +2,11 @@ export { getDefaultCredentials, setDefaultCredentials } from './config';
 export { default as CartoLayer } from './layers/carto-layer';
 export { default as _CartoTileLayer } from './layers/carto-tile-layer';
 export { default as _H3TileLayer } from './layers/h3-tile-layer';
-export { default as _QuadkeyTileLayer } from './layers/quadkey-tile-layer';
+export { default as _QuadbinTileLayer } from './layers/quadbin-tile-layer';
 export { default as BASEMAP } from './basemap';
 export { default as colorBins } from './style/color-bins-style';
 export { default as colorCategories } from './style/color-categories-style';
 export { default as colorContinuous } from './style/color-continuous-style';
-export { FORMATS, TILE_FORMATS, MAP_TYPES, API_VERSIONS, fetchLayerData, fetchMap, getDataV2 as _getDataV2, getData, mapInstantiation as _mapInstantiation } from './api';
+export { FORMATS, TILE_FORMATS, MAP_TYPES, API_VERSIONS, fetchLayerData, fetchMap, getDataV2 as _getDataV2, mapInstantiation as _mapInstantiation } from './api';
 export type { CartoLayerProps } from './layers/carto-layer';
 //# sourceMappingURL=index.d.ts.map

package/typed/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,qBAAqB,EAAE,qBAAqB,EAAC,MAAM,UAAU,CAAC;AACtE,OAAO,EAAC,OAAO,IAAI,UAAU,EAAC,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAC,OAAO,IAAI,OAAO,EAAC,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,gCAAgC,CAAC;AAC1E,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,gCAAgC,CAAC;AAC1E,OAAO,EACL,OAAO,EACP,YAAY,EACZ,SAAS,EACT,YAAY,EACZ,cAAc,EACd,QAAQ,EACR,SAAS,IAAI,UAAU,EACvB,OAAO,EACP,gBAAgB,IAAI,iBAAiB,EACtC,MAAM,OAAO,CAAC;AAEf,YAAY,EAAC,eAAe,EAAC,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,qBAAqB,EAAE,qBAAqB,EAAC,MAAM,UAAU,CAAC;AACtE,OAAO,EAAC,OAAO,IAAI,UAAU,EAAC,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAC,OAAO,IAAI,iBAAiB,EAAC,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAC,OAAO,IAAI,OAAO,EAAC,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,gCAAgC,CAAC;AAC1E,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,gCAAgC,CAAC;AAC1E,OAAO,EACL,OAAO,EACP,YAAY,EACZ,SAAS,EACT,YAAY,EACZ,cAAc,EACd,QAAQ,EACR,SAAS,IAAI,UAAU,EACvB,gBAAgB,IAAI,iBAAiB,EACtC,MAAM,OAAO,CAAC;AAEf,YAAY,EAAC,eAAe,EAAC,MAAM,sBAAsB,CAAC"}

package/typed/layers/carto-layer.d.ts

@@ -1,5 +1,5 @@
 import { CompositeLayer, Layer, CompositeLayerProps, LayerProps, ChangeFlags } from '@deck.gl/core/typed';
-import { Format, MapType, TileFormat } from '../api/maps-api-common';
+import { MapType, TileFormat } from '../api/maps-api-common';
 import { Credentials } from '../config';
 /** All properties supported by CartoLayer. */
 export declare type CartoLayerProps<DataT = any> = _CartoLayerProps & CompositeLayerProps<DataT>;
@@ -24,18 +24,10 @@ declare type _CartoLayerProps = {
      * Required when apiVersion is `API_VERSIONS.V3`.
      */
     connection?: string;
-    /**
-     * Use to override the default data format.
-     *
-     * Only supported when apiVersion is `API_VERSIONS.V3`.
-     *
-     * Possible values are: `FORMATS.GEOJSON`, `FORMATS.JSON` and `FORMATS.TILEJSON`.
-     */
-    format?: Format;
     /**
      * Use to override the default tile data format.
      *
-     * Only supported when apiVersion is `API_VERSIONS.V3` and format is `FORMATS.TILEJSON`.
+     * Only supported when apiVersion is `API_VERSIONS.V3`.
      *
      * Possible values are: `TILE_FORMATS.BINARY`, `TILE_FORMATS.GEOJSON` and `TILE_FORMATS.MVT`.
      */
@@ -75,6 +67,10 @@ declare type _CartoLayerProps = {
      */
     onDataError?: (err: unknown) => void;
     clientId?: string;
+    /** Aggregation SQL expression. Only used for spatial index datasets **/
+    aggregationExp?: string;
+    /** Aggregation resolution level. Only used for spatial index datasets, defaults to 6 for quadbins, 4 for h3. **/
+    aggregationResLevel?: number;
 };
 export default class CartoLayer<ExtraProps = {}> extends CompositeLayer<Required<_CartoLayerProps> & ExtraProps> {
     static layerName: string;

package/typed/layers/carto-layer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"carto-layer.d.ts","sourceRoot":"","sources":["../../src/layers/carto-layer.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,KAAK,EAEL,mBAAmB,EACnB,UAAU,EACV,WAAW,EACZ,MAAM,eAAe,CAAC;AAOvB,OAAO,EAEL,MAAM,EAGN,OAAO,EAEP,UAAU,EAEX,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAGL,WAAW,EAEZ,MAAM,WAAW,CAAC;AA4CnB,8CAA8C;AAC9C,oBAAY,eAAe,CAAC,KAAK,GAAG,GAAG,IAAI,gBAAgB,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;AAEzF,sCAAsC;AACtC,aAAK,gBAAgB,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,UAAU,CAAC;IAEzB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;;;OAIG;IACH,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;IAErC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,UAAU,CAAC,UAAU,GAAG,EAAE,CAAE,SAAQ,cAAc,CACrE,QAAQ,CAAC,gBAAgB,CAAC,GAAG,UAAU,CACxC;IACC,MAAM,CAAC,SAAS,SAAgB;IAChC,MAAM,CAAC,YAAY,MAAuB;IAE1C,eAAe,IAAI,IAAI;IAOvB,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED,WAAW,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI;IAuCzC,WAAW,CAAC,EACV,KAAK,EACL,QAAQ,EACR,WAAW,EACZ,EAAE;QACD,KAAK,EAAE,eAAe,CAAC;QACvB,QAAQ,EAAE,eAAe,CAAC;QAC1B,OAAO,EAAE,GAAG,CAAC;QACb,WAAW,EAAE,WAAW,CAAC;KAC1B,GAAG,IAAI;IAmBF,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAqClC,oBAAoB,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC;IAqCzC,YAAY,IAAI,KAAK,GAAG,IAAI;CAqB7B"}
+{"version":3,"file":"carto-layer.d.ts","sourceRoot":"","sources":["../../src/layers/carto-layer.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,KAAK,EAEL,mBAAmB,EACnB,UAAU,EACV,WAAW,EACZ,MAAM,eAAe,CAAC;AAMvB,OAAO,EAIL,OAAO,EAEP,UAAU,EAEX,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAGL,WAAW,EAEZ,MAAM,WAAW,CAAC;AA4CnB,8CAA8C;AAC9C,oBAAY,eAAe,CAAC,KAAK,GAAG,GAAG,IAAI,gBAAgB,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;AAEzF,sCAAsC;AACtC,aAAK,gBAAgB,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;;OAOG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,UAAU,CAAC;IAEzB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;;;OAIG;IACH,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;IAErC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,wEAAwE;IACxE,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,iHAAiH;IACjH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,UAAU,CAAC,UAAU,GAAG,EAAE,CAAE,SAAQ,cAAc,CACrE,QAAQ,CAAC,gBAAgB,CAAC,GAAG,UAAU,CACxC;IACC,MAAM,CAAC,SAAS,SAAgB;IAChC,MAAM,CAAC,YAAY,MAAuB;IAE1C,eAAe,IAAI,IAAI;IAOvB,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED,WAAW,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI;IAuCzC,WAAW,CAAC,EACV,KAAK,EACL,QAAQ,EACR,WAAW,EACZ,EAAE;QACD,KAAK,EAAE,eAAe,CAAC;QACvB,QAAQ,EAAE,eAAe,CAAC;QAC1B,OAAO,EAAE,GAAG,CAAC;QACb,WAAW,EAAE,WAAW,CAAC;KAC1B,GAAG,IAAI;IAoBF,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAuClC,oBAAoB,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC;IAgCzC,YAAY,IAAI,KAAK,GAAG,IAAI;CAqB7B"}