@deck.gl/carto 8.5.5 → 8.5.9

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

@@ -55,10 +55,11 @@ async function request({method, url, format, accessToken, body}) {
  */
 function dealWithError({response, error}) {
   switch (response.status) {
+    case 400:
+      throw new Error(`Bad request. ${error}`);
     case 401:
     case 403:
-      throw new Error(`Unauthorized access to Maps API`);
-
+      throw new Error(`Unauthorized access. ${error}`);
     default:
       throw new Error(error);
   }
@@ -67,19 +68,35 @@ function dealWithError({response, error}) {
 /**
  * Build a URL with all required parameters
  */
-function getParameters({type, source}) {
+function getParameters({type, source, geoColumn, columns}) {
   const encodedClient = encodeParameter('client', 'deck-gl-carto');
   const parameters = [encodedClient];
 
   const sourceName = type === MAP_TYPES.QUERY ? 'q' : 'name';
   parameters.push(encodeParameter(sourceName, source));
 
+  if (type === MAP_TYPES.TABLE) {
+    if (geoColumn) {
+      parameters.push(encodeParameter('geo_column', geoColumn));
+    }
+    if (columns) {
+      parameters.push(encodeParameter('columns', columns.join(',')));
+    }
+  }
+
   return parameters.join('&');
 }
 
-export async function mapInstantiation({type, source, connection, credentials}) {
+export async function mapInstantiation({
+  type,
+  source,
+  connection,
+  credentials,
+  geoColumn,
+  columns
+}) {
   const baseUrl = `${credentials.mapsUrl}/${connection}/${type}`;
-  const url = `${baseUrl}?${getParameters({type, source})}`;
+  const url = `${baseUrl}?${getParameters({type, source, geoColumn, columns})}`;
   const {accessToken} = credentials;
 
   const format = 'json';
@@ -106,7 +123,7 @@ function getUrlFromMetadata(metadata, format) {
   return null;
 }
 
-export async function getData({type, source, connection, credentials, format}) {
+export async function getData({type, source, connection, credentials, geoColumn, columns, format}) {
   const localCreds = {...getDefaultCredentials(), ...credentials};
 
   log.assert(connection, 'Must define connection');
@@ -122,7 +139,14 @@ export async function getData({type, source, connection, credentials, format}) {
     localCreds.mapsUrl = buildMapsUrlFromBase(localCreds.apiBaseUrl);
   }
 
-  const metadata = await mapInstantiation({type, source, connection, credentials: localCreds});
+  const metadata = await mapInstantiation({
+    type,
+    source,
+    connection,
+    credentials: localCreds,
+    geoColumn,
+    columns
+  });
   let url;
   let mapFormat;
 

package/src/layers/carto-layer.js

@@ -20,7 +20,13 @@ const defaultProps = {
   /* API v3 PARAMETERS */
   /**********************/
   // (String, required): connection name at CARTO platform
-  connection: null
+  connection: null,
+
+  // (String, optional): name of the `geo_column` in the CARTO platform. Use this override the default column ('geom'), from which the geometry information should be fetched.
+  geoColumn: null,
+
+  // (Array<String>, optional): names of columns to fetch. By default, all columns are fetched.
+  columns: {type: 'array', value: null}
 };
 
 export default class CartoLayer extends CompositeLayer {
@@ -36,7 +42,7 @@ export default class CartoLayer extends CompositeLayer {
   }
 
   _checkProps(props) {
-    const {type, credentials, connection} = props;
+    const {type, credentials, connection, geoColumn, columns} = props;
     const localCreds = {...getDefaultCredentials(), ...credentials};
     const {apiVersion} = localCreds;
 
@@ -51,12 +57,21 @@ export default class CartoLayer extends CompositeLayer {
         `Invalid type ${type}. Use type MAP_TYPES.QUERY or MAP_TYPES.TILESET for apiVersion ${apiVersion}`
       );
       log.assert(!connection, `Connection prop is not supported for apiVersion ${apiVersion}`);
+      log.assert(!geoColumn, `geoColumn prop is not supported for apiVersion ${apiVersion}`);
+      log.assert(!columns, `columns prop is not supported for apiVersion ${apiVersion}`);
     } else if (apiVersion === API_VERSIONS.V3) {
       log.assert(connection, 'Missing mandatory connection parameter');
       log.assert(
         Object.values(MAP_TYPES).includes(type),
         `Invalid type ${type}. Use MAP_TYPES enum.`
       );
+      if (type !== MAP_TYPES.TABLE) {
+        log.assert(!geoColumn, `geoColumn prop is only supported for type ${MAP_TYPES.TABLE}`);
+        log.assert(!columns, `columns prop is only supported for type ${MAP_TYPES.TABLE}`);
+      }
+      if (columns) {
+        log.assert(Array.isArray(columns), 'columns prop must be an Array');
+      }
     }
   }
 
@@ -65,6 +80,8 @@ export default class CartoLayer extends CompositeLayer {
     const shouldUpdateData =
       changeFlags.dataChanged ||
       props.connection !== oldProps.connection ||
+      props.geoColumn !== oldProps.geoColumn ||
+      JSON.stringify(props.columns) !== JSON.stringify(oldProps.columns) ||
       props.type !== oldProps.type ||
       JSON.stringify(props.credentials) !== JSON.stringify(oldProps.credentials);
 
@@ -76,7 +93,7 @@ export default class CartoLayer extends CompositeLayer {
 
   async _updateData() {
     try {
-      const {type, data: source, connection, credentials} = this.props;
+      const {type, data: source, connection, credentials, geoColumn, columns} = this.props;
       const localConfig = {...getDefaultCredentials(), ...credentials};
       const {apiVersion} = localConfig;
 
@@ -87,7 +104,9 @@ export default class CartoLayer extends CompositeLayer {
           type,
           source,
           connection,
-          credentials
+          credentials,
+          geoColumn,
+          columns
         });
       } else if (apiVersion === API_VERSIONS.V1 || apiVersion === API_VERSIONS.V2) {
         data = await getDataV2({type, source, credentials});