@deck.gl/carto 8.6.0-beta.1 → 8.6.3

package/src/api/maps-client.js

@@ -1,9 +1,10 @@
 /**
  * Maps API Client for Maps API v1 and Maps API v2
  */
-import {getDefaultCredentials} from '../config';
+import {defaultClassicCredentials, getDefaultCredentials} from '../config';
 import {
   API_VERSIONS,
+  DEFAULT_MAPS_URL_FORMAT,
   DEFAULT_REGION_COMPONENT_IN_URL,
   DEFAULT_USER_COMPONENT_IN_URL,
   encodeParameter,
@@ -22,8 +23,20 @@ const TILE_EXTENT = 4096;
  * Obtain a TileJson from Maps API v1 and v2
  */
 export async function getDataV2({type, source, credentials}) {
-  const localCreds = {...getDefaultCredentials(), ...credentials};
-  const {apiVersion} = localCreds;
+  const defaultCredentials = getDefaultCredentials();
+  const apiVersion = (credentials && credentials.apiVersion) || defaultCredentials.apiVersion;
+  // Only pick up default credentials if they have been defined for
+  // correct API version
+  const localCreds = {
+    ...defaultClassicCredentials,
+    ...(defaultCredentials.apiVersion === apiVersion && defaultCredentials),
+    ...credentials
+  };
+
+  if (!localCreds.mapsUrl) {
+    localCreds.mapsUrl = DEFAULT_MAPS_URL_FORMAT[apiVersion];
+  }
+
   let url;
 
   const connection = type === 'tileset' ? CONNECTIONS.BIGQUERY : CONNECTIONS.CARTO;

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

@@ -68,9 +68,11 @@ function dealWithError({response, error}) {
 /**
  * Build a URL with all required parameters
  */
-function getParameters({type, source, geoColumn, columns}) {
-  const encodedClient = encodeParameter('client', 'deck-gl-carto');
-  const parameters = [encodedClient];
+function getParameters({type, source, geoColumn, columns, schema}) {
+  const parameters = [encodeParameter('client', 'deck-gl-carto')];
+  if (schema) {
+    parameters.push(encodeParameter('schema', true));
+  }
 
   const sourceName = type === MAP_TYPES.QUERY ? 'q' : 'name';
   parameters.push(encodeParameter(sourceName, source));
@@ -93,10 +95,11 @@ export async function mapInstantiation({
   connection,
   credentials,
   geoColumn,
-  columns
+  columns,
+  schema
 }) {
   const baseUrl = `${credentials.mapsUrl}/${connection}/${type}`;
-  const url = `${baseUrl}?${getParameters({type, source, geoColumn, columns})}`;
+  const url = `${baseUrl}?${getParameters({type, source, geoColumn, columns, schema})}`;
   const {accessToken} = credentials;
 
   const format = 'json';
@@ -123,9 +126,7 @@ function getUrlFromMetadata(metadata, format) {
   return null;
 }
 
-export async function getData({type, source, connection, credentials, geoColumn, columns, format}) {
-  const localCreds = {...getDefaultCredentials(), ...credentials};
-
+function checkGetLayerDataParameters({type, source, connection, localCreds}) {
   log.assert(connection, 'Must define connection');
   log.assert(type, 'Must define a type');
   log.assert(source, 'Must define a source');
@@ -133,7 +134,26 @@ export async function getData({type, source, connection, credentials, geoColumn,
   log.assert(localCreds.apiVersion === API_VERSIONS.V3, 'Method only available for v3');
   log.assert(localCreds.apiBaseUrl, 'Must define apiBaseUrl');
   log.assert(localCreds.accessToken, 'Must define an accessToken');
-  log.assert(localCreds.mapsUrl, 'mapsUrl cannot be undefined');
+}
+
+export async function fetchLayerData({
+  type,
+  source,
+  connection,
+  credentials,
+  geoColumn,
+  columns,
+  format,
+  schema
+}) {
+  const defaultCredentials = getDefaultCredentials();
+  // Only pick up default credentials if they have been defined for
+  // correct API version
+  const localCreds = {
+    ...(defaultCredentials.apiVersion === API_VERSIONS.V3 && defaultCredentials),
+    ...credentials
+  };
+  checkGetLayerDataParameters({type, source, connection, localCreds});
 
   if (!localCreds.mapsUrl) {
     localCreds.mapsUrl = buildMapsUrlFromBase(localCreds.apiBaseUrl);
@@ -145,7 +165,8 @@ export async function getData({type, source, connection, credentials, geoColumn,
     connection,
     credentials: localCreds,
     geoColumn,
-    columns
+    columns,
+    schema
   });
   let url;
   let mapFormat;
@@ -168,5 +189,25 @@ export async function getData({type, source, connection, credentials, geoColumn,
 
   const {accessToken} = localCreds;
 
-  return await request({url, format: mapFormat, accessToken});
+  const data = await request({url, format: mapFormat, accessToken});
+  const result = {data, format: mapFormat};
+  if (schema) {
+    result.schema = metadata.schema;
+  }
+
+  return result;
+}
+
+export async function getData({type, source, connection, credentials, geoColumn, columns, format}) {
+  const layerData = await fetchLayerData({
+    type,
+    source,
+    connection,
+    credentials,
+    geoColumn,
+    columns,
+    format,
+    schema: false
+  });
+  return layerData.data;
 }

package/src/config.js

@@ -1,6 +1,6 @@
-import {API_VERSIONS} from './api/maps-api-common';
+import {API_VERSIONS, DEFAULT_MAPS_URL_FORMAT} from './api/maps-api-common';
 
-const defaultClassicCredentials = {
+export const defaultClassicCredentials = {
   username: 'public',
   apiKey: 'default_public',
   region: 'us',
@@ -22,7 +22,7 @@ export function setDefaultCredentials(opts) {
 
   switch (apiVersion) {
     case API_VERSIONS.V1:
-      opts.mapsUrl = opts.mapsUrl || 'https://{user}.carto.com/api/v1/map';
+      opts.mapsUrl = opts.mapsUrl || DEFAULT_MAPS_URL_FORMAT[apiVersion];
       credentials = {
         apiVersion,
         ...defaultClassicCredentials,
@@ -31,7 +31,7 @@ export function setDefaultCredentials(opts) {
       break;
 
     case API_VERSIONS.V2:
-      opts.mapsUrl = opts.mapsUrl || 'https://maps-api-v2.{region}.carto.com/user/{user}';
+      opts.mapsUrl = opts.mapsUrl || DEFAULT_MAPS_URL_FORMAT[apiVersion];
       credentials = {
         apiVersion,
         ...defaultClassicCredentials,

package/src/index.js

@@ -10,6 +10,7 @@ export {
   FORMATS,
   MAP_TYPES,
   API_VERSIONS,
+  fetchLayerData,
   getDataV2 as _getDataV2,
   getData,
   mapInstantiation as _mapInstantiation