@deck.gl/carto 9.0.40 → 9.1.0-beta.3

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.40",
+  "version": "9.1.0-beta.3",
   "publishConfig": {
     "access": "public"
   },
@@ -42,14 +42,15 @@
     "prepublishOnly": "npm run build-bundle && npm run build-bundle -- --env=dev"
   },
   "dependencies": {
+    "@carto/api-client": "^0.4.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.16",
+    "@luma.gl/shadertools": "^9.1.0-beta.16",
+    "@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.1.0-beta",
+    "@deck.gl/core": "^9.1.0-beta",
+    "@deck.gl/extensions": "^9.1.0-beta",
+    "@deck.gl/geo-layers": "^9.1.0-beta",
+    "@deck.gl/layers": "^9.1.0-beta",
+    "@loaders.gl/core": "^4.2.0",
+    "@luma.gl/core": "^9.1.0-beta"
   },
-  "gitHead": "fe6e4763b3dcd5b602291e7732e9d30b0a4eaec1"
+  "gitHead": "6625885881202cb753b64c6f2b8ee6f323092075"
 }

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,32 @@
-/* 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 {
+  DEFAULT_API_BASE_URL,
+  APIErrorContext,
+  CartoAPIError,
   GeojsonResult,
   JsonResult,
   TilejsonResult,
+  Format,
+  MapType,
+  QueryParameters,
+  SourceOptions,
+  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 = {
@@ -37,14 +46,7 @@ type Dataset = {
 
 /* global clearInterval, setInterval, URL */
 /* eslint-disable complexity, max-statements, max-params */
-async function _fetchMapDataset(
-  dataset: Dataset,
-  accessToken: string,
-  apiBaseUrl: string,
-  clientId?: string,
-  headers?: Record<string, string>,
-  maxLengthURL = DEFAULT_MAX_LENGTH_URL
-) {
+async function _fetchMapDataset(dataset: Dataset, context: _FetchMapContext) {
   const {
     aggregationExp,
     aggregationResLevel,
@@ -58,16 +60,12 @@ async function _fetchMapDataset(
   } = dataset;
 
   const cache: {value?: number} = {};
-  const globalOptions: any = {
-    accessToken,
-    apiBaseUrl,
+  const globalOptions = {
+    ...context,
     cache,
-    clientId,
     connectionName,
-    format,
-    headers,
-    maxLengthURL
-  };
+    format
+  } as SourceOptions;
 
   if (type === 'tileset') {
     // TODO do we want a generic tilesetSource?
@@ -112,14 +110,9 @@ async function _fetchMapDataset(
   return cacheChanged;
 }
 
-async function _fetchTilestats(
-  attribute: string,
-  dataset: Dataset,
-  accessToken: string,
-  apiBaseUrl: string,
-  maxLengthURL = DEFAULT_MAX_LENGTH_URL
-) {
+async function _fetchTilestats(attribute: string, dataset: Dataset, context: _FetchMapContext) {
   const {connectionName, data, id, source, type, queryParameters} = dataset;
+  const {apiBaseUrl} = context;
   const errorContext: APIErrorContext = {
     requestType: 'Tile stats',
     connection: connectionName,
@@ -132,7 +125,7 @@ async function _fetchTilestats(
 
   const baseUrl = buildStatsUrl({attribute, apiBaseUrl, ...dataset});
   const client = new URLSearchParams(data.tiles[0]).get('client');
-  const headers = {Authorization: `Bearer ${accessToken}`};
+  const headers = {Authorization: `Bearer ${context.accessToken}`};
   const parameters: Record<string, string> = {};
   if (client) {
     parameters.client = client;
@@ -148,7 +141,7 @@ async function _fetchTilestats(
     headers,
     parameters,
     errorContext,
-    maxLengthURL
+    maxLengthURL: context.maxLengthURL
   });
 
   // Replace tilestats for attribute with value from API
@@ -158,23 +151,14 @@ async function _fetchTilestats(
   return true;
 }
 
-async function fillInMapDatasets(
-  {datasets, token}: {datasets: Dataset[]; token: string},
-  clientId: string,
-  apiBaseUrl: string,
-  headers?: Record<string, string>,
-  maxLengthURL = DEFAULT_MAX_LENGTH_URL
-) {
-  const promises = datasets.map(dataset =>
-    _fetchMapDataset(dataset, token, apiBaseUrl, clientId, headers, maxLengthURL)
-  );
+async function fillInMapDatasets({datasets}: {datasets: Dataset[]}, context: _FetchMapContext) {
+  const promises = datasets.map(dataset => _fetchMapDataset(dataset, context));
   return await Promise.all(promises);
 }
 
 async function fillInTileStats(
-  {datasets, keplerMapConfig, token}: {datasets: Dataset[]; keplerMapConfig: any; token: string},
-  apiBaseUrl: string,
-  maxLengthURL = DEFAULT_MAX_LENGTH_URL
+  {datasets, keplerMapConfig}: {datasets: Dataset[]; keplerMapConfig: any},
+  context: _FetchMapContext
 ) {
   const attributes: {attribute: string; dataset: any}[] = [];
   const {layers} = keplerMapConfig.config.visState;
@@ -203,7 +187,7 @@ async function fillInTileStats(
   }
 
   const promises = filteredAttributes.map(({attribute, dataset}) =>
-    _fetchTilestats(attribute, dataset, token, apiBaseUrl, maxLengthURL)
+    _fetchTilestats(attribute, dataset, context)
   );
   return await Promise.all(promises);
 }
@@ -252,6 +236,14 @@ export type FetchMapOptions = {
   maxLengthURL?: number;
 };
 
+/**
+ * Context reused while fetching and updating a map with fetchMap().
+ */
+type _FetchMapContext = {apiBaseUrl: string} & Pick<
+  FetchMapOptions,
+  'accessToken' | 'clientId' | 'headers' | 'maxLengthURL'
+>;
+
 export type FetchMapResult = ParseMapResult & {
   /**
    * Basemap properties.
@@ -265,14 +257,13 @@ export async function fetchMap({
   accessToken,
   apiBaseUrl = DEFAULT_API_BASE_URL,
   cartoMapId,
-  clientId = DEFAULT_CLIENT,
-  headers = {},
+  clientId,
+  headers,
   autoRefresh,
   onNewData,
-  maxLengthURL = DEFAULT_MAX_LENGTH_URL
+  maxLengthURL
 }: FetchMapOptions): Promise<FetchMapResult> {
   assert(cartoMapId, 'Must define CARTO map id: fetchMap({cartoMapId: "XXXX-XXXX-XXXX"})');
-  assert(apiBaseUrl, 'Must define apiBaseUrl');
 
   if (accessToken) {
     headers = {Authorization: `Bearer ${accessToken}`, ...headers};
@@ -290,6 +281,13 @@ export async function fetchMap({
   const baseUrl = buildPublicMapUrl({apiBaseUrl, cartoMapId});
   const errorContext: APIErrorContext = {requestType: 'Public map', mapId: cartoMapId};
   const map = await requestWithParameters({baseUrl, headers, errorContext, maxLengthURL});
+  const context: _FetchMapContext = {
+    accessToken: map.token || accessToken,
+    apiBaseUrl,
+    clientId,
+    headers,
+    maxLengthURL
+  };
 
   // Periodically check if the data has changed. Note that this
   // will not update when a map is published.
@@ -297,16 +295,13 @@ export async function fetchMap({
   if (autoRefresh) {
     // eslint-disable-next-line @typescript-eslint/no-misused-promises
     const intervalId = setInterval(async () => {
-      const changed = await fillInMapDatasets(
-        map,
-        clientId,
-        apiBaseUrl,
-        {
+      const changed = await fillInMapDatasets(map, {
+        ...context,
+        headers: {
           ...headers,
           'If-Modified-Since': new Date().toUTCString()
-        },
-        maxLengthURL
-      );
+        }
+      });
       if (onNewData && changed.some(v => v === true)) {
         onNewData(parseMap(map));
       }
@@ -335,11 +330,11 @@ export async function fetchMap({
     fetchBasemapProps({config: map.keplerMapConfig.config, errorContext}),
 
     // Mutates map.datasets so that dataset.data contains data
-    fillInMapDatasets(map, clientId, apiBaseUrl, headers, maxLengthURL)
+    fillInMapDatasets(map, context)
   ]);
 
   // Mutates attributes in visualChannels to contain tile stats
-  await fillInTileStats(map, apiBaseUrl, maxLengthURL);
+  await fillInTileStats(map, context);
 
   const out = {...parseMap(map), basemap, ...{stopAutoRefresh}};
 

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';
 
@@ -193,7 +197,7 @@ export function getLayer(
       Layer: GeoJsonLayer,
       propMap: {
         columns: {
-          altitude: x => ({parameters: {depthTest: Boolean(x)}})
+          altitude: x => ({parameters: {depthWriteEnabled: Boolean(x)}})
         },
         visConfig: {outline: 'stroked'}
       }
@@ -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,8 +1,12 @@
+// 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';
-import {default as _PointLabelLayer} from './layers/point-label-layer';
+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';
@@ -12,7 +16,7 @@ const CARTO_LAYERS = {
   ClusterTileLayer,
   H3TileLayer,
   HeatmapTileLayer,
-  _PointLabelLayer,
+  PointLabelLayer,
   QuadbinTileLayer,
   RasterTileLayer,
   VectorTileLayer
@@ -22,7 +26,7 @@ export {
   ClusterTileLayer,
   H3TileLayer,
   HeatmapTileLayer,
-  _PointLabelLayer,
+  PointLabelLayer,
   QuadbinTileLayer,
   RasterTileLayer,
   VectorTileLayer
@@ -57,22 +61,18 @@ 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
 } from './api/index';
 
+// TODO(v10): Consider removing re-exports from '@carto/api-client' below.
+
 import {
   boundaryQuerySource,
   boundaryTableSource,
@@ -85,11 +85,10 @@ import {
   quadbinTilesetSource,
   vectorQuerySource,
   vectorTableSource,
-  vectorTilesetSource,
-  SOURCE_DEFAULTS
-} from './sources/index';
+  vectorTilesetSource
+} from '@carto/api-client';
 
-const CARTO_SOURCES = {
+export const CARTO_SOURCES = {
   boundaryQuerySource,
   boundaryTableSource,
   h3QuerySource,
@@ -117,9 +116,10 @@ export {
   vectorQuerySource,
   vectorTableSource,
   vectorTilesetSource,
-  CARTO_SOURCES,
+  query,
+  CartoAPIError,
   SOURCE_DEFAULTS
-};
+} from '@carto/api-client';
 
 export type {
   GeojsonResult,
@@ -140,5 +140,6 @@ export type {
   QuadbinTilesetSourceOptions,
   VectorQuerySourceOptions,
   VectorTableSourceOptions,
-  VectorTilesetSourceOptions
-} from './sources/index';
+  VectorTilesetSourceOptions,
+  QueryParameters
+} 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';
 

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,