@deck.gl/carto 9.0.34 → 9.1.0-beta.1

package/package.json

@@ -3,7 +3,7 @@
   "description": "CARTO official integration with Deck.gl. Build geospatial applications using CARTO and Deck.gl.",
   "license": "MIT",
   "type": "module",
-  "version": "9.0.34",
+  "version": "9.1.0-beta.1",
   "publishConfig": {
     "access": "public"
   },
@@ -42,14 +42,15 @@
     "prepublishOnly": "npm run build-bundle && npm run build-bundle -- --env=dev"
   },
   "dependencies": {
+    "@carto/api-client": "^0.4.0-alpha.4",
     "@loaders.gl/gis": "^4.2.0",
     "@loaders.gl/loader-utils": "^4.2.0",
     "@loaders.gl/mvt": "^4.2.0",
     "@loaders.gl/schema": "^4.2.0",
     "@loaders.gl/tiles": "^4.2.0",
-    "@luma.gl/core": "~9.0.27",
-    "@luma.gl/shadertools": "~9.0.27",
-    "@math.gl/web-mercator": "^4.0.0",
+    "@luma.gl/core": "^9.1.0-beta.11",
+    "@luma.gl/shadertools": "^9.1.0-beta.11",
+    "@math.gl/web-mercator": "^4.1.0",
     "@types/d3-array": "^3.0.2",
     "@types/d3-color": "^1.4.2",
     "@types/d3-scale": "^3.0.0",
@@ -65,12 +66,13 @@
     "quadbin": "^0.2.0"
   },
   "peerDependencies": {
-    "@deck.gl/aggregation-layers": "^9.0.0",
-    "@deck.gl/core": "^9.0.0",
-    "@deck.gl/extensions": "^9.0.0",
-    "@deck.gl/geo-layers": "^9.0.0",
-    "@deck.gl/layers": "^9.0.0",
-    "@loaders.gl/core": "^4.2.0"
+    "@deck.gl/aggregation-layers": "9.0.0-alpha.0",
+    "@deck.gl/core": "9.0.0-alpha.0",
+    "@deck.gl/extensions": "9.0.0-alpha.0",
+    "@deck.gl/geo-layers": "9.0.0-alpha.0",
+    "@deck.gl/layers": "9.0.0-alpha.0",
+    "@loaders.gl/core": "^4.2.0",
+    "@luma.gl/core": "^9.1.0-beta.11"
   },
-  "gitHead": "eb03446717e49042747ef6f7b1be581561a2249e"
+  "gitHead": "a86fb154cf323eacc3f56ef087f636fb9f6c30b6"
 }

package/src/api/basemap.ts

@@ -1,3 +1,7 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 import {MapViewState} from '@deck.gl/core';
 import {
   GOOGLE_BASEMAPS,
@@ -7,7 +11,8 @@ import {
   getStyleUrl,
   someLayerGroupsDisabled
 } from '../basemap';
-import {APIErrorContext, Basemap, KeplerMapConfig, MapLibreBasemapProps} from './types';
+import {Basemap, KeplerMapConfig, MapLibreBasemapProps} from './types';
+import {APIErrorContext} from '@carto/api-client';
 
 const CUSTOM_STYLE_ID_PREFIX = 'custom:';
 const DEFAULT_CARTO_STYLE = 'positron';

package/src/api/fetch-map.ts

@@ -1,23 +1,31 @@
-/* eslint-disable camelcase */
-import {CartoAPIError} from './carto-api-error';
-import {DEFAULT_API_BASE_URL, DEFAULT_CLIENT, DEFAULT_MAX_LENGTH_URL} from './common';
-import {buildPublicMapUrl, buildStatsUrl} from './endpoints';
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 import {
+  SOURCE_DEFAULTS,
+  APIErrorContext,
+  CartoAPIError,
   GeojsonResult,
   JsonResult,
   TilejsonResult,
+  Format,
+  MapType,
+  QueryParameters,
+  buildPublicMapUrl,
+  buildStatsUrl,
   h3QuerySource,
   h3TableSource,
   quadbinQuerySource,
   quadbinTableSource,
   vectorQuerySource,
   vectorTableSource,
-  vectorTilesetSource
-} from '../sources/index';
+  vectorTilesetSource,
+  requestWithParameters
+} from '@carto/api-client';
 import {ParseMapResult, parseMap} from './parse-map';
-import {requestWithParameters} from './request-with-parameters';
 import {assert} from '../utils';
-import type {APIErrorContext, Basemap, Format, MapType, QueryParameters} from './types';
+import type {Basemap} from './types';
 import {fetchBasemapProps} from './basemap';
 
 type Dataset = {
@@ -43,7 +51,7 @@ async function _fetchMapDataset(
   apiBaseUrl: string,
   clientId?: string,
   headers?: Record<string, string>,
-  maxLengthURL = DEFAULT_MAX_LENGTH_URL
+  maxLengthURL = SOURCE_DEFAULTS.maxLengthURL
 ) {
   const {
     aggregationExp,
@@ -117,7 +125,7 @@ async function _fetchTilestats(
   dataset: Dataset,
   accessToken: string,
   apiBaseUrl: string,
-  maxLengthURL = DEFAULT_MAX_LENGTH_URL
+  maxLengthURL = SOURCE_DEFAULTS.maxLengthURL
 ) {
   const {connectionName, data, id, source, type, queryParameters} = dataset;
   const errorContext: APIErrorContext = {
@@ -163,7 +171,7 @@ async function fillInMapDatasets(
   clientId: string,
   apiBaseUrl: string,
   headers?: Record<string, string>,
-  maxLengthURL = DEFAULT_MAX_LENGTH_URL
+  maxLengthURL = SOURCE_DEFAULTS.maxLengthURL
 ) {
   const promises = datasets.map(dataset =>
     _fetchMapDataset(dataset, token, apiBaseUrl, clientId, headers, maxLengthURL)
@@ -174,7 +182,7 @@ async function fillInMapDatasets(
 async function fillInTileStats(
   {datasets, keplerMapConfig, token}: {datasets: Dataset[]; keplerMapConfig: any; token: string},
   apiBaseUrl: string,
-  maxLengthURL = DEFAULT_MAX_LENGTH_URL
+  maxLengthURL = SOURCE_DEFAULTS.maxLengthURL
 ) {
   const attributes: {attribute: string; dataset: any}[] = [];
   const {layers} = keplerMapConfig.config.visState;
@@ -263,13 +271,13 @@ export type FetchMapResult = ParseMapResult & {
 /* eslint-disable max-statements */
 export async function fetchMap({
   accessToken,
-  apiBaseUrl = DEFAULT_API_BASE_URL,
+  apiBaseUrl = SOURCE_DEFAULTS.apiBaseUrl,
   cartoMapId,
-  clientId = DEFAULT_CLIENT,
+  clientId = SOURCE_DEFAULTS.clientId,
   headers = {},
   autoRefresh,
   onNewData,
-  maxLengthURL = DEFAULT_MAX_LENGTH_URL
+  maxLengthURL = SOURCE_DEFAULTS.maxLengthURL
 }: FetchMapOptions): Promise<FetchMapResult> {
   assert(cartoMapId, 'Must define CARTO map id: fetchMap({cartoMapId: "XXXX-XXXX-XXXX"})');
   assert(apiBaseUrl, 'Must define apiBaseUrl');

package/src/api/index.ts

@@ -1,15 +1,7 @@
-export {CartoAPIError} from './carto-api-error';
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 export {fetchMap} from './fetch-map';
 export type {FetchMapOptions, FetchMapResult} from './fetch-map';
-export type {
-  APIErrorContext,
-  Format,
-  MapType,
-  RequestType,
-  QueryParameters,
-  Basemap,
-  MapLibreBasemap,
-  GoogleBasemap
-} from './types';
-export {query} from './query';
-export type {QueryOptions} from './query';
+export type {Basemap, MapLibreBasemap, GoogleBasemap} from './types';

package/src/api/layer-map.ts

@@ -1,3 +1,7 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 import {deviation, extent, groupSort, median, variance} from 'd3-array';
 import {rgb} from 'd3-color';
 import {
@@ -14,7 +18,7 @@ import {format as d3Format} from 'd3-format';
 import moment from 'moment-timezone';
 
 import {Accessor, Layer, _ConstructorOf as ConstructorOf} from '@deck.gl/core';
-import {CPUGridLayer, HeatmapLayer, HexagonLayer} from '@deck.gl/aggregation-layers';
+import {GridLayer, HeatmapLayer, HexagonLayer} from '@deck.gl/aggregation-layers';
 import {GeoJsonLayer} from '@deck.gl/layers';
 import {H3HexagonLayer} from '@deck.gl/geo-layers';
 
@@ -202,7 +206,7 @@ export function getLayer(
       Layer: GeoJsonLayer
     },
     grid: {
-      Layer: CPUGridLayer,
+      Layer: GridLayer,
       propMap: {visConfig: {...aggregationVisConfig, worldUnitSize: x => ({cellSize: 1000 * x})}},
       defaultProps: {getPosition}
     },

package/src/api/parse-map.ts

@@ -1,3 +1,7 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 import {ColorParameters} from '@luma.gl/core';
 import {Layer, log} from '@deck.gl/core';
 import {

package/src/api/types.ts

@@ -1,86 +1,15 @@
-import {SCALE_TYPE} from './layer-map';
-
-export type Format = 'json' | 'geojson' | 'tilejson';
-export type MapType = 'boundary' | 'query' | 'table' | 'tileset' | 'raster';
-export type RequestType =
-  | 'Map data'
-  | 'Map instantiation'
-  | 'Public map'
-  | 'Tile stats'
-  | 'SQL'
-  | 'Basemap style';
-
-export type APIErrorContext = {
-  requestType: RequestType;
-  mapId?: string;
-  connection?: string;
-  source?: string;
-  type?: MapType;
-};
-
-export enum SchemaFieldType {
-  Number = 'number',
-  Bigint = 'bigint',
-  String = 'string',
-  Geometry = 'geometry',
-  Timestamp = 'timestamp',
-  Object = 'object',
-  Boolean = 'boolean',
-  Variant = 'variant',
-  Unknown = 'unknown'
-}
-export interface SchemaField {
-  name: string;
-  type: SchemaFieldType; // Field type in the CARTO stack, common for all providers
-}
-
-export interface MapInstantiation extends MapInstantiationFormats {
-  nrows: number;
-  size?: number;
-  schema: SchemaField[];
-}
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 
-type MapInstantiationFormats = Record<
-  Format,
-  {
-    url: string[];
-    error?: any;
-  }
->;
-
-export type QueryParameterValue = string | number | boolean | Array<QueryParameterValue> | object;
-
-export type NamedQueryParameter = Record<string, QueryParameterValue>;
-
-export type PositionalQueryParameter = QueryParameterValue[];
+import {SCALE_TYPE} from './layer-map';
 
-export type QueryParameters = NamedQueryParameter | PositionalQueryParameter;
 export type VisualChannelField = {
   name: string;
   type: string;
   colorColumn?: string;
 };
 
-export interface Filters {
-  [column: string]: Filter;
-}
-
-interface Filter {
-  [FilterTypes.In]?: number[];
-  [FilterTypes.Between]?: number[][];
-  [FilterTypes.ClosedOpen]?: number[][];
-  [FilterTypes.Time]?: number[][];
-  [FilterTypes.StringSearch]?: string[];
-}
-
-export enum FilterTypes {
-  In = 'in',
-  Between = 'between', // [a, b] both are included
-  ClosedOpen = 'closed_open', // [a, b) a is included, b is not
-  Time = 'time',
-  StringSearch = 'stringSearch'
-}
-
 export type VisualChannels = {
   colorField?: VisualChannelField;
   colorScale?: SCALE_TYPE;

package/src/basemap.ts

@@ -1,5 +1,9 @@
-import {CartoAPIError} from './api/carto-api-error';
-import {APIErrorContext, GoogleBasemapProps} from './api/types';
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import {CartoAPIError, APIErrorContext} from '@carto/api-client';
+import {GoogleBasemapProps} from './api/types';
 
 const cartoStyleUrlTemplate = 'https://basemaps.cartocdn.com/gl/{basemap}-gl-style/style.json';
 

package/src/constants.ts

@@ -1,5 +1,5 @@
-export const DEFAULT_TILE_SIZE = 512;
-export const DEFAULT_TILE_RESOLUTION = 0.5;
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 
-export const DEFAULT_AGGREGATION_RES_LEVEL_H3 = 4;
-export const DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN = 6;
+export const DEFAULT_TILE_SIZE = 512;

package/src/index.ts

@@ -1,3 +1,8 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+// CARTO Layers
 import {default as ClusterTileLayer} from './layers/cluster-tile-layer';
 import {default as H3TileLayer} from './layers/h3-tile-layer';
 import {default as HeatmapTileLayer} from './layers/heatmap-tile-layer';
@@ -5,6 +10,8 @@ import {default as _PointLabelLayer} from './layers/point-label-layer';
 import {default as QuadbinTileLayer} from './layers/quadbin-tile-layer';
 import {default as RasterTileLayer} from './layers/raster-tile-layer';
 import {default as VectorTileLayer} from './layers/vector-tile-layer';
+
+// Exports for playground/bindings
 const CARTO_LAYERS = {
   ClusterTileLayer,
   H3TileLayer,
@@ -25,6 +32,24 @@ export {
   VectorTileLayer
 };
 
+// Internal Layers
+export {default as _QuadbinLayer} from './layers/quadbin-layer';
+export {default as _RasterLayer} from './layers/raster-layer';
+export {default as _SpatialIndexTileLayer} from './layers/spatial-index-tile-layer';
+
+// Types
+export type {ClusterTileLayerProps} from './layers/cluster-tile-layer';
+export type {H3TileLayerProps} from './layers/h3-tile-layer';
+export type {HeatmapTileLayerProps} from './layers/heatmap-tile-layer';
+export type {PointLabelLayerProps} from './layers/point-label-layer';
+export type {QuadbinLayerProps} from './layers/quadbin-layer';
+export type {QuadbinTileLayerProps} from './layers/quadbin-tile-layer';
+export type {RasterLayerProps} from './layers/raster-layer';
+export type {RasterTileLayerProps} from './layers/raster-tile-layer';
+export type {SpatialIndexTileLayerProps} from './layers/spatial-index-tile-layer';
+export type {VectorTileLayerProps} from './layers/vector-tile-layer';
+
+// Helpers
 export {
   default as BASEMAP,
   GOOGLE_BASEMAPS as _GOOGLE_BASEMAPS,
@@ -36,17 +61,11 @@ export {
 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 {CartoAPIError, fetchMap, query} from './api/index';
+export {fetchMap} from './api/index';
 export {fetchBasemapProps} from './api/basemap';
 export type {
-  APIErrorContext,
   FetchMapOptions,
   FetchMapResult,
-  Format,
-  MapType,
-  RequestType,
-  QueryParameters,
-  QueryOptions,
   Basemap as _Basemap,
   MapLibreBasemap as _MapLibreBasemap,
   GoogleBasemap as _GoogleBasemap
@@ -66,7 +85,7 @@ import {
   vectorTableSource,
   vectorTilesetSource,
   SOURCE_DEFAULTS
-} from './sources/index';
+} from '@carto/api-client';
 
 const CARTO_SOURCES = {
   boundaryQuerySource,
@@ -120,4 +139,4 @@ export type {
   VectorQuerySourceOptions,
   VectorTableSourceOptions,
   VectorTilesetSourceOptions
-} from './sources/index';
+} from '@carto/api-client';

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

@@ -1,3 +1,7 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 import {GeoJsonLayer, GeoJsonLayerProps} from '@deck.gl/layers';
 import {
   TileLayer,
@@ -35,7 +39,7 @@ import QuadbinTileset2D from './quadbin-tileset-2d';
 import {getQuadbinPolygon} from './quadbin-utils';
 import CartoSpatialTileLoader from './schema/carto-spatial-tile-loader';
 import {injectAccessToken, TilejsonPropType} from './utils';
-import type {TilejsonResult} from '../sources/types';
+import type {TilejsonResult} from '@carto/api-client';
 
 registerLoaders([CartoSpatialTileLoader]);
 
@@ -114,6 +118,7 @@ class ClusterGeoJsonLayer<
     this.state.aggregationCache = new WeakMap();
   }
 
+  // eslint-disable-next-line max-statements
   renderLayers(): Layer | null | LayersList {
     const visibleTiles = this.state.tileset?.tiles.filter((tile: Tile2DHeader) => {
       return tile.isLoaded && tile.content && this.state.tileset!.isTileVisible(tile);

package/src/layers/cluster-utils.ts

@@ -1,3 +1,7 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 import {cellToParent} from 'quadbin';
 import {_Tile2DHeader as Tile2DHeader} from '@deck.gl/geo-layers';
 import {Accessor, log} from '@deck.gl/core';

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

@@ -1,8 +1,12 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 import {CompositeLayer, CompositeLayerProps, Layer, LayersList, DefaultProps} from '@deck.gl/core';
 import {H3HexagonLayer, H3HexagonLayerProps} from '@deck.gl/geo-layers';
 import H3Tileset2D, {getHexagonResolution} from './h3-tileset-2d';
 import SpatialIndexTileLayer, {SpatialIndexTileLayerProps} from './spatial-index-tile-layer';
-import type {TilejsonResult} from '../sources/types';
+import type {TilejsonResult} from '@carto/api-client';
 import {injectAccessToken, TilejsonPropType} from './utils';
 import {DEFAULT_TILE_SIZE} from '../constants';
 
@@ -50,7 +54,7 @@ export default class H3TileLayer<DataT = any, ExtraPropsT extends {} = {}> exten
     return loadOptions;
   }
 
-  renderLayers(): Layer | null | LayersList {
+  renderLayers(): SpatialIndexTileLayer | null {
     const tileJSON = this.props.data as TilejsonResult;
     if (!tileJSON) return null;
 
@@ -71,21 +75,19 @@ export default class H3TileLayer<DataT = any, ExtraPropsT extends {} = {}> exten
       );
     }
 
+    const SubLayerClass = this.getSubLayerClass('spatial-index-tile', SpatialIndexTileLayer);
     // The naming is unfortunate, but minZoom & maxZoom in the context
     // of a Tileset2D refer to the resolution levels, not the Mercator zooms
-    return [
-      // @ts-ignore
-      new SpatialIndexTileLayer(this.props, {
-        id: `h3-tile-layer-${this.props.id}`,
-        data,
-        // TODO: Tileset2D should be generic over TileIndex type
-        TilesetClass: H3Tileset2D as any,
-        renderSubLayers,
-        // minZoom and maxZoom are H3 resolutions, however we must use this naming as that is what the Tileset2D class expects
-        minZoom: minresolution,
-        maxZoom: maxresolution,
-        loadOptions: this.getLoadOptions()
-      })
-    ];
+    return new SubLayerClass(this.props, {
+      id: `h3-tile-layer-${this.props.id}`,
+      data,
+      // TODO: Tileset2D should be generic over TileIndex type
+      TilesetClass: H3Tileset2D as any,
+      renderSubLayers,
+      // minZoom and maxZoom are H3 resolutions, however we must use this naming as that is what the Tileset2D class expects
+      minZoom: minresolution,
+      maxZoom: maxresolution,
+      loadOptions: this.getLoadOptions()
+    });
   }
 }

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

@@ -1,3 +1,7 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 import {_Tileset2D as Tileset2D, GeoBoundingBox} from '@deck.gl/geo-layers';
 import {
   polygonToCells,