CARTO: v9 API cleanup

.github/workflows/release.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@f1f314fca9dfce2769ece7d933488f076716723e # v1.4.6
         with:
-          node-version: '18.x'
+          node-version: '16.x'
 
       - name: Publish release
         run: |

.github/workflows/test.yml

@@ -24,7 +24,7 @@ jobs:
         uses: actions/setup-node@f1f314fca9dfce2769ece7d933488f076716723e # v1.4.6
         with:
           # headless GL 6.0.1 needs recent version of Node 16.
-          node-version: '18.18'
+          node-version: '16.19'
 
       - name: Install dependencies
         run: |
@@ -58,7 +58,7 @@ jobs:
       - name: Install dependencies
         run: |
           curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.1/install.sh | bash
-          nvm install 18.18 && nvm use 18.18
+          nvm install 16.9 && nvm use 16.9
           cd bindings/pydeck
           make setup-env
           make init

.github/workflows/website.yml

@@ -30,7 +30,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@f1f314fca9dfce2769ece7d933488f076716723e # v1.4.6
         with:
-          node-version: '18.x'
+          node-version: '16.x'
 
       - name: Get version
         id: get-version

modules/carto/src/api/carto-api-error.ts

@@ -1,12 +1,4 @@
-import {MapType, RequestType} from './maps-api-common';
-
-export type APIErrorContext = {
-  requestType: RequestType;
-  mapId?: string;
-  connection?: string;
-  source?: string;
-  type?: MapType;
-};
+import type {APIErrorContext} from './types';
 
 /**
  *

modules/carto/src/api/common.ts

@@ -0,0 +1,14 @@
+export const DEFAULT_API_BASE_URL = 'https://gcp-us-east1.api.carto.com';
+export const DEFAULT_CLIENT = 'deck-gl-carto';
+export const V3_MINOR_VERSION = '3.2';
+export const MAX_GET_LENGTH = 8192;
+
+export const DEFAULT_PARAMETERS = {
+  client: DEFAULT_CLIENT,
+  v: V3_MINOR_VERSION
+};
+
+export const DEFAULT_HEADERS = {
+  Accept: 'application/json',
+  'Content-Type': 'application/json'
+};

modules/carto/src/api/endpoints.ts

@@ -0,0 +1,34 @@
+import {MapType} from './types';
+
+export type V3Endpoint = 'maps' | 'stats';
+
+function buildUrlFromBase(apiBaseUrl: string, endpoint: V3Endpoint) {
+  let suffix = `/v3/${endpoint}`;
+  if (apiBaseUrl.endsWith('/')) {
+    suffix = suffix.substring(1);
+  }
+
+  return `${apiBaseUrl}${suffix}`;
+}
+
+export function buildMapsUrlFromBase(apiBaseUrl: string): string {
+  return buildUrlFromBase(apiBaseUrl, 'maps');
+}
+
+export function buildStatsUrlFromBase(apiBaseUrl: string): string {
+  return buildUrlFromBase(apiBaseUrl, 'stats');
+}
+
+export function buildSourceUrl({
+  apiBaseUrl,
+  connectionName,
+  endpoint,
+  mapsUrl
+}: {
+  apiBaseUrl: string;
+  connectionName: string;
+  endpoint: MapType;
+  mapsUrl?: string;
+}): string {
+  return `${mapsUrl || buildMapsUrlFromBase(apiBaseUrl)}/${connectionName}/${endpoint}`;
+}

modules/carto/src/api/maps-v3-client.ts → modules/carto/src/api/fetch-map.ts

@@ -2,17 +2,12 @@
 /**
  * Maps API Client for Carto 3
  */
-import {buildMapsUrlFromBase, buildStatsUrlFromBase} from '../config';
-import {Format, MapType, MAP_TYPES, QueryParameters} from './maps-api-common';
-
-import {CartoAPIError, APIErrorContext} from './carto-api-error';
-
-import {parseMap} from './parseMap';
-import {assert} from '../utils';
+import {CartoAPIError} from './carto-api-error';
+import {DEFAULT_API_BASE_URL, DEFAULT_CLIENT} from './common';
+import {buildMapsUrlFromBase, buildStatsUrlFromBase} from './endpoints';
 import {
   GeojsonResult,
   JsonResult,
-  SOURCE_DEFAULTS,
   TilejsonResult,
   h3QuerySource,
   h3TableSource,
@@ -22,7 +17,10 @@ import {
   vectorTableSource,
   vectorTilesetSource
 } from '../sources';
-import {requestWithParameters} from '../sources/utils';
+import {parseMap} from './parse-map';
+import {requestWithParameters} from './request-with-parameters';
+import {assert} from '../utils';
+import type {APIErrorContext, Format, MapType, QueryParameters} from './types';
 
 type Dataset = {
   id: string;
@@ -157,15 +155,18 @@ async function fillInMapDatasets(
   return await Promise.all(promises);
 }
 
-async function fillInTileStats({datasets, keplerMapConfig, token}, apiBaseUrl: string) {
+async function fillInTileStats(
+  {datasets, keplerMapConfig, token}: {datasets: Dataset[]; keplerMapConfig: any; token: string},
+  apiBaseUrl: string
+) {
   const attributes: {attribute?: string; dataset?: any}[] = [];
   const {layers} = keplerMapConfig.config.visState;
   for (const layer of layers) {
     for (const channel of Object.keys(layer.visualChannels)) {
       const attribute = layer.visualChannels[channel]?.name;
       if (attribute) {
         const dataset = datasets.find(d => d.id === layer.config.dataId);
-        if (dataset.data.tilestats && dataset.type !== MAP_TYPES.TILESET) {
+        if (dataset && dataset.type !== 'tileset' && (dataset.data as TilejsonResult).tilestats) {
           // Only fetch stats for QUERY & TABLE map types
           attributes.push({attribute, dataset});
         }
@@ -190,24 +191,26 @@ async function fillInTileStats({datasets, keplerMapConfig, token}, apiBaseUrl: s
   return await Promise.all(promises);
 }
 
+export type FetchMapOptions = {
+  apiBaseUrl?: string;
+  cartoMapId: string;
+  clientId?: string;
+  headers?: Record<string, string>;
+  mapsUrl?: string;
+  autoRefresh?: number;
+  onNewData?: (map: any) => void;
+};
+
 /* eslint-disable max-statements */
 export async function fetchMap({
-  apiBaseUrl = SOURCE_DEFAULTS.apiBaseUrl,
+  apiBaseUrl = DEFAULT_API_BASE_URL,
   cartoMapId,
-  clientId = SOURCE_DEFAULTS.clientId,
+  clientId = DEFAULT_CLIENT,
   headers = {},
   mapsUrl,
   autoRefresh,
   onNewData
-}: {
-  apiBaseUrl: string;
-  cartoMapId: string;
-  clientId: string;
-  headers: Record<string, string>;
-  mapsUrl?: string;
-  autoRefresh?: number;
-  onNewData?: (map: any) => void;
-}) {
+}: FetchMapOptions) {
   assert(cartoMapId, 'Must define CARTO map id: fetchMap({cartoMapId: "XXXX-XXXX-XXXX"})');
   assert(apiBaseUrl, 'Must define apiBaseUrl');
 

modules/carto/src/api/index.ts

@@ -1,5 +1,4 @@
 export {CartoAPIError} from './carto-api-error';
-export type {APIErrorContext} from './carto-api-error';
-export {FORMATS, TILE_FORMATS, MAP_TYPES, API_VERSIONS} from './maps-api-common';
-export type {QueryParameters} from './maps-api-common';
-export {fetchMap} from './maps-v3-client';
+export {fetchMap} from './fetch-map';
+export type {FetchMapOptions} from './fetch-map';
+export type {APIErrorContext, Format, MapType, RequestType, QueryParameters} from './types';

modules/carto/src/api/layer-map.ts

@@ -22,7 +22,7 @@ import H3TileLayer from '../layers/h3-tile-layer';
 import QuadbinTileLayer from '../layers/quadbin-tile-layer';
 import RasterTileLayer from '../layers/raster-tile-layer';
 import VectorTileLayer from '../layers/vector-tile-layer';
-import {MapType, TILE_FORMATS, TileFormat} from './maps-api-common';
+import {MapType} from './types';
 import {assert, createBinaryProxy, scaleIdentity} from '../utils';
 import {
   CustomMarkersRange,
@@ -202,7 +202,6 @@ export function getLayer(
 }
 
 export function layerFromTileDataset(
-  formatTiles: TileFormat | null = TILE_FORMATS.MVT,
   scheme: string,
   type?: MapType
 ): typeof VectorTileLayer | typeof H3TileLayer | typeof QuadbinTileLayer {
@@ -223,22 +222,16 @@ function getTileLayer(dataset: MapDataset, basePropMap) {
   const {
     aggregationExp,
     aggregationResLevel,
-    data: {
-      scheme,
-      tiles: [tileUrl]
-    }
+    data: {scheme}
   } = dataset;
-  /* global URL */
-  const formatTiles = new URL(tileUrl).searchParams.get('formatTiles') as TileFormat;
 
   return {
-    Layer: layerFromTileDataset(formatTiles, scheme),
+    Layer: layerFromTileDataset(scheme),
     propMap: basePropMap,
     defaultProps: {
       ...defaultProps,
       ...(aggregationExp && {aggregationExp}),
       ...(aggregationResLevel && {aggregationResLevel}),
-      formatTiles,
       uniqueIdProperty: 'geoid'
     }
   };

modules/carto/src/sources/utils.ts → modules/carto/src/api/request-with-parameters.ts

@@ -1,7 +1,13 @@
-import {APIErrorContext, CartoAPIError} from '../api/carto-api-error';
-import {encodeParameter, MapType} from '../api/maps-api-common';
+import {CartoAPIError} from './carto-api-error';
 import {DEFAULT_HEADERS, DEFAULT_PARAMETERS, MAX_GET_LENGTH} from './common';
-import {buildMapsUrlFromBase} from '../config';
+import type {APIErrorContext} from './types';
+
+/**
+ * Simple encode parameter
+ */
+function encodeParameter(name: string, value: string | boolean | number): string {
+  return `${name}=${encodeURIComponent(value)}`;
+}
 
 const REQUEST_CACHE = new Map();
 export async function requestWithParameters<T = any>({
@@ -55,17 +61,3 @@ export async function requestWithParameters<T = any>({
     throw new CartoAPIError(error as Error, errorContext);
   }
 }
-
-export function buildApiEndpoint({
-  apiBaseUrl,
-  connectionName,
-  endpoint,
-  mapsUrl
-}: {
-  apiBaseUrl: string;
-  connectionName: string;
-  endpoint: MapType;
-  mapsUrl?: string;
-}): string {
-  return `${mapsUrl || buildMapsUrlFromBase(apiBaseUrl)}/${connectionName}/${endpoint}`;
-}