@carto/api-client 0.3.0 → 0.4.0-alpha.0

package/build/api-client.cjs

@@ -3,7 +3,6 @@ var bboxPolygon = require('@turf/bbox-polygon');
 var union = require('@turf/union');
 var invariant = require('@turf/invariant');
 var helpers = require('@turf/helpers');
-var carto = require('@deck.gl/carto');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -36,7 +35,16 @@ function setClient(c) {
 }
 
 /** Current version of @carto/api-client. */
-const API_CLIENT_VERSION = "0.3.0";
+const API_CLIENT_VERSION = "0.4.0-alpha.0";
+const DEFAULT_API_BASE_URL$1 = 'https://gcp-us-east1.api.carto.com';
+const DEFAULT_CLIENT = 'deck-gl-carto';
+const V3_MINOR_VERSION = '3.4';
+// Fastly default limit is 8192; leave some padding.
+const DEFAULT_MAX_LENGTH_URL = 7000;
+const DEFAULT_TILE_SIZE = 512;
+const DEFAULT_TILE_RESOLUTION = 0.5;
+const DEFAULT_AGGREGATION_RES_LEVEL_H3 = 4;
+const DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN = 6;
 /**
  * Defines a comparator used when matching a column's values against given filter values.
  *
@@ -129,6 +137,10 @@ function isEmptyObject(object) {
   }
   return true;
 }
+/** @internal */
+const isObject = x => x !== null && typeof x === 'object';
+/** @internal */
+const isPureObject = x => isObject(x) && x.constructor === {}.constructor;
 
 /**
  * Adds a {@link Filter} to the filter set. Any previous filters with the same
@@ -843,8 +855,9 @@ class WidgetBaseSource {
           abortController
         }
       }).then(res => ({
-        rows: normalizeObjectKeys(res.rows),
-        totalCount: res.metadata.total
+        // Avoid `normalizeObjectKeys()`, which changes column names.
+        rows: res.rows ?? res.ROWS,
+        totalCount: res.metadata?.total ?? res.METADATA?.TOTAL
       })));
     } catch (e) {
       return Promise.reject(e);
@@ -980,13 +993,468 @@ class WidgetTableSource extends WidgetBaseSource {
   }
 }
 
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+function joinPath() {
+  return [].slice.call(arguments).map(part => part.endsWith('/') ? part.slice(0, -1) : part).join('/');
+}
+function buildV3Path(apiBaseUrl, version, endpoint) {
+  return joinPath(apiBaseUrl, version, endpoint, ...[].slice.call(arguments, 3));
+}
+function buildSourceUrl(_ref3) {
+  let {
+    apiBaseUrl,
+    connectionName,
+    endpoint
+  } = _ref3;
+  return buildV3Path(apiBaseUrl, 'v3', 'maps', connectionName, endpoint);
+}
+
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+/**
+ *
+ * Custom error for reported errors in CARTO Maps API.
+ * Provides useful debugging information in console and context for applications.
+ *
+ */
+class CartoAPIError extends Error {
+  constructor(error, errorContext, response, responseJson) {
+    let responseString = 'Failed to connect';
+    if (response) {
+      responseString = 'Server returned: ';
+      if (response.status === 400) {
+        responseString += 'Bad request';
+      } else if (response.status === 401 || response.status === 403) {
+        responseString += 'Unauthorized access';
+      } else if (response.status === 404) {
+        responseString += 'Not found';
+      } else {
+        responseString += 'Error';
+      }
+      responseString += ` (${response.status}):`;
+    }
+    responseString += ` ${error.message || error}`;
+    let message = `${errorContext.requestType} API request failed`;
+    message += `\n${responseString}`;
+    for (const key of Object.keys(errorContext)) {
+      if (key === 'requestType') continue;
+      message += `\n${formatErrorKey(key)}: ${errorContext[key]}`;
+    }
+    message += '\n';
+    super(message);
+    /** Source error from server */
+    this.error = void 0;
+    /** Context (API call & parameters) in which error occured */
+    this.errorContext = void 0;
+    /** Response from server */
+    this.response = void 0;
+    /** JSON Response from server */
+    this.responseJson = void 0;
+    this.name = 'CartoAPIError';
+    this.response = response;
+    this.responseJson = responseJson;
+    this.error = error;
+    this.errorContext = errorContext;
+  }
+}
+/**
+ * Converts camelCase to Camel Case
+ */
+function formatErrorKey(key) {
+  return key.replace(/([A-Z])/g, ' $1').replace(/^./, s => s.toUpperCase());
+}
+
+// deck.gl
+const requestWithParameters = function (_ref) {
+  let {
+    baseUrl,
+    parameters = {},
+    headers: customHeaders = {},
+    errorContext,
+    maxLengthURL = DEFAULT_MAX_LENGTH_URL
+  } = _ref;
+  try {
+    // Parameters added to all requests issued with `requestWithParameters()`.
+    // These parameters override parameters already in the base URL, but not
+    // user-provided parameters.
+    parameters = {
+      v: V3_MINOR_VERSION,
+      clientId: DEFAULT_CLIENT,
+      ...(typeof deck !== 'undefined' && deck.VERSION && {
+        deckglVersion: deck.VERSION
+      }),
+      ...parameters
+    };
+    baseUrl = excludeURLParameters(baseUrl, Object.keys(parameters));
+    const key = createCacheKey(baseUrl, parameters, customHeaders);
+    if (REQUEST_CACHE.has(key)) {
+      return Promise.resolve(REQUEST_CACHE.get(key));
+    }
+    const url = createURLWithParameters(baseUrl, parameters);
+    const headers = {
+      ...DEFAULT_HEADERS,
+      ...customHeaders
+    };
+    /* global fetch */
+    const fetchPromise = url.length > maxLengthURL ? fetch(baseUrl, {
+      method: 'POST',
+      body: JSON.stringify(parameters),
+      headers
+    }) : fetch(url, {
+      headers
+    });
+    let response;
+    let responseJson;
+    const jsonPromise = fetchPromise.then(_response => {
+      response = _response;
+      return response.json();
+    }).then(json => {
+      responseJson = json;
+      if (!response || !response.ok) {
+        throw new Error(json.error);
+      }
+      return json;
+    }).catch(error => {
+      REQUEST_CACHE.delete(key);
+      throw new CartoAPIError(error, errorContext, response, responseJson);
+    });
+    REQUEST_CACHE.set(key, jsonPromise);
+    return Promise.resolve(jsonPromise);
+  } catch (e) {
+    return Promise.reject(e);
+  }
+};
+const DEFAULT_HEADERS = {
+  Accept: 'application/json',
+  'Content-Type': 'application/json'
+};
+const REQUEST_CACHE = new Map();
+function createCacheKey(baseUrl, parameters, headers) {
+  const parameterEntries = Object.entries(parameters).sort((_ref2, _ref3) => {
+    let [a] = _ref2;
+    let [b] = _ref3;
+    return a > b ? 1 : -1;
+  });
+  const headerEntries = Object.entries(headers).sort((_ref4, _ref5) => {
+    let [a] = _ref4;
+    let [b] = _ref5;
+    return a > b ? 1 : -1;
+  });
+  return JSON.stringify({
+    baseUrl,
+    parameters: parameterEntries,
+    headers: headerEntries
+  });
+}
+/**
+ * Appends query string parameters to a URL. Existing URL parameters are kept,
+ * unless there is a conflict, in which case the new parameters override
+ * those already in the URL.
+ */
+function createURLWithParameters(baseUrlString, parameters) {
+  const baseUrl = new URL(baseUrlString);
+  for (const [key, value] of Object.entries(parameters)) {
+    if (isPureObject(value) || Array.isArray(value)) {
+      baseUrl.searchParams.set(key, JSON.stringify(value));
+    } else {
+      baseUrl.searchParams.set(key, value.toString());
+    }
+  }
+  return baseUrl.toString();
+}
+/**
+ * Deletes query string parameters from a URL.
+ */
+function excludeURLParameters(baseUrlString, parameters) {
+  const baseUrl = new URL(baseUrlString);
+  for (const param of parameters) {
+    if (baseUrl.searchParams.has(param)) {
+      baseUrl.searchParams.delete(param);
+    }
+  }
+  return baseUrl.toString();
+}
+
+// deck.gl
+const baseSource = function (endpoint, options, urlParameters) {
+  try {
+    const {
+      accessToken,
+      connectionName,
+      cache,
+      ...optionalOptions
+    } = options;
+    const mergedOptions = {
+      ...SOURCE_DEFAULTS,
+      accessToken,
+      connectionName,
+      endpoint
+    };
+    for (const key in optionalOptions) {
+      if (optionalOptions[key]) {
+        mergedOptions[key] = optionalOptions[key];
+      }
+    }
+    const baseUrl = buildSourceUrl(mergedOptions);
+    const {
+      clientId,
+      maxLengthURL,
+      format
+    } = mergedOptions;
+    const headers = {
+      Authorization: `Bearer ${options.accessToken}`,
+      ...options.headers
+    };
+    const parameters = {
+      client: clientId,
+      ...urlParameters
+    };
+    const errorContext = {
+      requestType: 'Map instantiation',
+      connection: options.connectionName,
+      type: endpoint,
+      source: JSON.stringify(parameters, undefined, 2)
+    };
+    return Promise.resolve(requestWithParameters({
+      baseUrl,
+      parameters,
+      headers,
+      errorContext,
+      maxLengthURL
+    })).then(function (mapInstantiation) {
+      let _exit;
+      function _temp2(_result) {
+        return _exit ? _result : Promise.resolve(requestWithParameters({
+          baseUrl: dataUrl,
+          headers,
+          errorContext,
+          maxLengthURL
+        }));
+      }
+      const dataUrl = mapInstantiation[format].url[0];
+      if (cache) {
+        cache.value = parseInt(new URL(dataUrl).searchParams.get('cache') || '', 10);
+      }
+      errorContext.requestType = 'Map data';
+      const _temp = function () {
+        if (format === 'tilejson') {
+          return Promise.resolve(requestWithParameters({
+            baseUrl: dataUrl,
+            headers,
+            errorContext,
+            maxLengthURL
+          })).then(function (json) {
+            if (accessToken) {
+              json.accessToken = accessToken;
+            }
+            _exit = 1;
+            return json;
+          });
+        }
+      }();
+      return _temp && _temp.then ? _temp.then(_temp2) : _temp2(_temp);
+    });
+  } catch (e) {
+    return Promise.reject(e);
+  }
+};
+const SOURCE_DEFAULTS = {
+  apiBaseUrl: DEFAULT_API_BASE_URL$1,
+  clientId: DEFAULT_CLIENT,
+  format: 'tilejson',
+  headers: {},
+  maxLengthURL: DEFAULT_MAX_LENGTH_URL
+};
+
+// deck.gl
+const h3QuerySource$1 = function (options) {
+  try {
+    const {
+      aggregationExp,
+      aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_H3,
+      sqlQuery,
+      spatialDataColumn = 'h3',
+      queryParameters,
+      filters
+    } = options;
+    const urlParameters = {
+      aggregationExp,
+      spatialDataColumn,
+      spatialDataType: 'h3',
+      q: sqlQuery
+    };
+    if (aggregationResLevel) {
+      urlParameters.aggregationResLevel = String(aggregationResLevel);
+    }
+    if (queryParameters) {
+      urlParameters.queryParameters = queryParameters;
+    }
+    if (filters) {
+      urlParameters.filters = filters;
+    }
+    return Promise.resolve(baseSource('query', options, urlParameters));
+  } catch (e) {
+    return Promise.reject(e);
+  }
+};
+
+// deck.gl
+const h3TableSource$1 = function (options) {
+  try {
+    const {
+      aggregationExp,
+      aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_H3,
+      spatialDataColumn = 'h3',
+      tableName,
+      filters
+    } = options;
+    const urlParameters = {
+      aggregationExp,
+      name: tableName,
+      spatialDataColumn,
+      spatialDataType: 'h3'
+    };
+    if (aggregationResLevel) {
+      urlParameters.aggregationResLevel = String(aggregationResLevel);
+    }
+    if (filters) {
+      urlParameters.filters = filters;
+    }
+    return Promise.resolve(baseSource('table', options, urlParameters));
+  } catch (e) {
+    return Promise.reject(e);
+  }
+};
+
+// deck.gl
+const quadbinQuerySource$1 = function (options) {
+  try {
+    const {
+      aggregationExp,
+      aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN,
+      sqlQuery,
+      spatialDataColumn = 'quadbin',
+      queryParameters,
+      filters
+    } = options;
+    const urlParameters = {
+      aggregationExp,
+      q: sqlQuery,
+      spatialDataColumn,
+      spatialDataType: 'quadbin'
+    };
+    if (aggregationResLevel) {
+      urlParameters.aggregationResLevel = String(aggregationResLevel);
+    }
+    if (queryParameters) {
+      urlParameters.queryParameters = queryParameters;
+    }
+    if (filters) {
+      urlParameters.filters = filters;
+    }
+    return Promise.resolve(baseSource('query', options, urlParameters));
+  } catch (e) {
+    return Promise.reject(e);
+  }
+};
+
+// deck.gl
+const quadbinTableSource$1 = function (options) {
+  try {
+    const {
+      aggregationExp,
+      aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN,
+      spatialDataColumn = 'quadbin',
+      tableName,
+      filters
+    } = options;
+    const urlParameters = {
+      aggregationExp,
+      name: tableName,
+      spatialDataColumn,
+      spatialDataType: 'quadbin'
+    };
+    if (aggregationResLevel) {
+      urlParameters.aggregationResLevel = String(aggregationResLevel);
+    }
+    if (filters) {
+      urlParameters.filters = filters;
+    }
+    return Promise.resolve(baseSource('table', options, urlParameters));
+  } catch (e) {
+    return Promise.reject(e);
+  }
+};
+
+// deck.gl
+const vectorQuerySource$1 = function (options) {
+  try {
+    const {
+      columns,
+      filters,
+      spatialDataColumn = 'geom',
+      sqlQuery,
+      tileResolution = DEFAULT_TILE_RESOLUTION,
+      queryParameters
+    } = options;
+    const urlParameters = {
+      spatialDataColumn,
+      spatialDataType: 'geo',
+      tileResolution: tileResolution.toString(),
+      q: sqlQuery
+    };
+    if (columns) {
+      urlParameters.columns = columns.join(',');
+    }
+    if (filters) {
+      urlParameters.filters = filters;
+    }
+    if (queryParameters) {
+      urlParameters.queryParameters = queryParameters;
+    }
+    return Promise.resolve(baseSource('query', options, urlParameters));
+  } catch (e) {
+    return Promise.reject(e);
+  }
+};
+
+// deck.gl
+const vectorTableSource$1 = function (options) {
+  try {
+    const {
+      columns,
+      filters,
+      spatialDataColumn = 'geom',
+      tableName,
+      tileResolution = DEFAULT_TILE_RESOLUTION
+    } = options;
+    const urlParameters = {
+      name: tableName,
+      spatialDataColumn,
+      spatialDataType: 'geo',
+      tileResolution: tileResolution.toString()
+    };
+    if (columns) {
+      urlParameters.columns = columns.join(',');
+    }
+    if (filters) {
+      urlParameters.filters = filters;
+    }
+    return Promise.resolve(baseSource('table', options, urlParameters));
+  } catch (e) {
+    return Promise.reject(e);
+  }
+};
+
 /** Wrapper adding Widget API support to [vectorTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
 
 /** Wrapper adding Widget API support to [quadbinQuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
 const quadbinQuerySource = function (props) {
   try {
-    assignDefaultProps(props);
-    return Promise.resolve(carto.quadbinQuerySource(props)).then(function (response) {
+    return Promise.resolve(quadbinQuerySource$1(props)).then(function (response) {
       return {
         ...response,
         widgetSource: new WidgetQuerySource(props)
@@ -999,8 +1467,7 @@ const quadbinQuerySource = function (props) {
 /** Wrapper adding Widget API support to [quadbinTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
 const quadbinTableSource = function (props) {
   try {
-    assignDefaultProps(props);
-    return Promise.resolve(carto.quadbinTableSource(props)).then(function (response) {
+    return Promise.resolve(quadbinTableSource$1(props)).then(function (response) {
       return {
         ...response,
         widgetSource: new WidgetTableSource(props)
@@ -1013,8 +1480,7 @@ const quadbinTableSource = function (props) {
 /** Wrapper adding Widget API support to [h3QuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
 const h3QuerySource = function (props) {
   try {
-    assignDefaultProps(props);
-    return Promise.resolve(carto.h3QuerySource(props)).then(function (response) {
+    return Promise.resolve(h3QuerySource$1(props)).then(function (response) {
       return {
         ...response,
         widgetSource: new WidgetQuerySource(props)
@@ -1027,8 +1493,7 @@ const h3QuerySource = function (props) {
 /** Wrapper adding Widget API support to [h3TableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
 const h3TableSource = function (props) {
   try {
-    assignDefaultProps(props);
-    return Promise.resolve(carto.h3TableSource(props)).then(function (response) {
+    return Promise.resolve(h3TableSource$1(props)).then(function (response) {
       return {
         ...response,
         widgetSource: new WidgetTableSource(props)
@@ -1041,8 +1506,7 @@ const h3TableSource = function (props) {
 /** Wrapper adding Widget API support to [vectorQuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
 const vectorQuerySource = function (props) {
   try {
-    assignDefaultProps(props);
-    return Promise.resolve(carto.vectorQuerySource(props)).then(function (response) {
+    return Promise.resolve(vectorQuerySource$1(props)).then(function (response) {
       return {
         ...response,
         widgetSource: new WidgetQuerySource(props)
@@ -1054,8 +1518,7 @@ const vectorQuerySource = function (props) {
 };
 const vectorTableSource = function (props) {
   try {
-    assignDefaultProps(props);
-    return Promise.resolve(carto.vectorTableSource(props)).then(function (response) {
+    return Promise.resolve(vectorTableSource$1(props)).then(function (response) {
       return {
         ...response,
         widgetSource: new WidgetTableSource(props)
@@ -1065,16 +1528,16 @@ const vectorTableSource = function (props) {
     return Promise.reject(e);
   }
 };
-function assignDefaultProps(props) {
-  if (typeof deck !== 'undefined' && deck && deck.VERSION) {
-    props.clientId ||= 'deck-gl-carto';
-    // TODO: Uncomment if/when `@deck.gl/carto` devDependency is removed,
-    // and source functions are moved here rather than wrapped.
-    // props.deckglVersion ||= deck.VERSION;
-  }
-}
 
 exports.API_CLIENT_VERSION = API_CLIENT_VERSION;
+exports.DEFAULT_AGGREGATION_RES_LEVEL_H3 = DEFAULT_AGGREGATION_RES_LEVEL_H3;
+exports.DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN = DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN;
+exports.DEFAULT_API_BASE_URL = DEFAULT_API_BASE_URL$1;
+exports.DEFAULT_CLIENT = DEFAULT_CLIENT;
+exports.DEFAULT_MAX_LENGTH_URL = DEFAULT_MAX_LENGTH_URL;
+exports.DEFAULT_TILE_RESOLUTION = DEFAULT_TILE_RESOLUTION;
+exports.DEFAULT_TILE_SIZE = DEFAULT_TILE_SIZE;
+exports.V3_MINOR_VERSION = V3_MINOR_VERSION;
 exports.WidgetBaseSource = WidgetBaseSource;
 exports.WidgetQuerySource = WidgetQuerySource;
 exports.WidgetTableSource = WidgetTableSource;