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

package/build/api-client.modern.js

@@ -3,7 +3,6 @@ import bboxPolygon from '@turf/bbox-polygon';
 import union from '@turf/union';
 import { getType } from '@turf/invariant';
 import { featureCollection, feature, polygon, multiPolygon } from '@turf/helpers';
-import { vectorTableSource as vectorTableSource$1, vectorQuerySource as vectorQuerySource$1, h3TableSource as h3TableSource$1, h3QuerySource as h3QuerySource$1, quadbinTableSource as quadbinTableSource$1, quadbinQuerySource as quadbinQuerySource$1 } from '@deck.gl/carto';
 
 /**
  * @internal
@@ -30,7 +29,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.
  *
@@ -123,6 +131,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
@@ -536,7 +548,7 @@ function executeModel(props) {
   });
 }
 
-const _excluded = ["filterOwner", "spatialFilter", "abortController"],
+const _excluded$1 = ["filterOwner", "spatialFilter", "abortController"],
   _excluded2 = ["filterOwner", "spatialFilter", "abortController", "operationExp"],
   _excluded3 = ["filterOwner", "spatialFilter", "abortController"],
   _excluded4 = ["filterOwner", "spatialFilter", "abortController"],
@@ -579,7 +591,7 @@ class WidgetBaseSource {
         spatialFilter,
         abortController
       } = options,
-      params = _objectWithoutPropertiesLoose(options, _excluded);
+      params = _objectWithoutPropertiesLoose(options, _excluded$1);
     const {
       column,
       operation,
@@ -788,10 +800,14 @@ class WidgetBaseSource {
       opts: {
         abortController
       }
-    }).then(res => ({
-      rows: normalizeObjectKeys(res.rows),
-      totalCount: res.metadata.total
-    }));
+    }).then(res => {
+      var _res$rows, _res$metadata$total, _res$metadata, _res$METADATA;
+      return {
+        // Avoid `normalizeObjectKeys()`, which changes column names.
+        rows: (_res$rows = res.rows) != null ? _res$rows : res.ROWS,
+        totalCount: (_res$metadata$total = (_res$metadata = res.metadata) == null ? void 0 : _res$metadata.total) != null ? _res$metadata$total : (_res$METADATA = res.METADATA) == null ? void 0 : _res$METADATA.TOTAL
+      };
+    });
   }
   /****************************************************************************
    * TIME SERIES
@@ -838,10 +854,10 @@ class WidgetBaseSource {
         abortController
       }
     }).then(res => {
-      var _res$metadata;
+      var _res$metadata2;
       return {
         rows: normalizeObjectKeys(res.rows),
-        categories: (_res$metadata = res.metadata) == null ? void 0 : _res$metadata.categories
+        categories: (_res$metadata2 = res.metadata) == null ? void 0 : _res$metadata2.categories
       };
     });
   }
@@ -918,9 +934,404 @@ class WidgetTableSource extends WidgetBaseSource {
   }
 }
 
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+function joinPath(...args) {
+  return args.map(part => part.endsWith('/') ? part.slice(0, -1) : part).join('/');
+}
+function buildV3Path(apiBaseUrl, version, endpoint, ...rest) {
+  return joinPath(apiBaseUrl, version, endpoint, ...rest);
+}
+function buildSourceUrl({
+  apiBaseUrl,
+  connectionName,
+  endpoint
+}) {
+  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());
+}
+
+const DEFAULT_HEADERS = {
+  Accept: 'application/json',
+  'Content-Type': 'application/json'
+};
+const REQUEST_CACHE = new Map();
+async function requestWithParameters({
+  baseUrl,
+  parameters = {},
+  headers: customHeaders = {},
+  errorContext,
+  maxLengthURL = DEFAULT_MAX_LENGTH_URL
+}) {
+  // Parameters added to all requests issued with `requestWithParameters()`.
+  // These parameters override parameters already in the base URL, but not
+  // user-provided parameters.
+  parameters = _extends({
+    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 REQUEST_CACHE.get(key);
+  }
+  const url = createURLWithParameters(baseUrl, parameters);
+  const headers = _extends({}, 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 jsonPromise;
+}
+function createCacheKey(baseUrl, parameters, headers) {
+  const parameterEntries = Object.entries(parameters).sort(([a], [b]) => a > b ? 1 : -1);
+  const headerEntries = Object.entries(headers).sort(([a], [b]) => 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();
+}
+
+const _excluded = ["accessToken", "connectionName", "cache"];
+const SOURCE_DEFAULTS = {
+  apiBaseUrl: DEFAULT_API_BASE_URL$1,
+  clientId: DEFAULT_CLIENT,
+  format: 'tilejson',
+  headers: {},
+  maxLengthURL: DEFAULT_MAX_LENGTH_URL
+};
+async function baseSource(endpoint, options, urlParameters) {
+  const {
+      accessToken,
+      connectionName,
+      cache
+    } = options,
+    optionalOptions = _objectWithoutPropertiesLoose(options, _excluded);
+  const mergedOptions = _extends({}, 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 = _extends({
+    Authorization: `Bearer ${options.accessToken}`
+  }, options.headers);
+  const parameters = _extends({
+    client: clientId
+  }, urlParameters);
+  const errorContext = {
+    requestType: 'Map instantiation',
+    connection: options.connectionName,
+    type: endpoint,
+    source: JSON.stringify(parameters, undefined, 2)
+  };
+  const mapInstantiation = await requestWithParameters({
+    baseUrl,
+    parameters,
+    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';
+  if (format === 'tilejson') {
+    const json = await requestWithParameters({
+      baseUrl: dataUrl,
+      headers,
+      errorContext,
+      maxLengthURL
+    });
+    if (accessToken) {
+      json.accessToken = accessToken;
+    }
+    return json;
+  }
+  return await requestWithParameters({
+    baseUrl: dataUrl,
+    headers,
+    errorContext,
+    maxLengthURL
+  });
+}
+
+// deck.gl
+const h3QuerySource$1 = async function h3QuerySource(options) {
+  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 baseSource('query', options, urlParameters);
+};
+
+// deck.gl
+const h3TableSource$1 = async function h3TableSource(options) {
+  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 baseSource('table', options, urlParameters);
+};
+
+// deck.gl
+const quadbinQuerySource$1 = async function quadbinQuerySource(options) {
+  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 baseSource('query', options, urlParameters);
+};
+
+// deck.gl
+const quadbinTableSource$1 = async function quadbinTableSource(options) {
+  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 baseSource('table', options, urlParameters);
+};
+
+// deck.gl
+const vectorQuerySource$1 = async function vectorQuerySource(options) {
+  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 baseSource('query', options, urlParameters);
+};
+
+// deck.gl
+const vectorTableSource$1 = async function vectorTableSource(options) {
+  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 baseSource('table', options, urlParameters);
+};
+
 /** Wrapper adding Widget API support to [vectorTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
 async function vectorTableSource(props) {
-  assignDefaultProps(props);
   const response = await vectorTableSource$1(props);
   return _extends({}, response, {
     widgetSource: new WidgetTableSource(props)
@@ -928,7 +1339,6 @@ async function vectorTableSource(props) {
 }
 /** Wrapper adding Widget API support to [vectorQuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
 async function vectorQuerySource(props) {
-  assignDefaultProps(props);
   const response = await vectorQuerySource$1(props);
   return _extends({}, response, {
     widgetSource: new WidgetQuerySource(props)
@@ -936,7 +1346,6 @@ async function vectorQuerySource(props) {
 }
 /** Wrapper adding Widget API support to [h3TableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
 async function h3TableSource(props) {
-  assignDefaultProps(props);
   const response = await h3TableSource$1(props);
   return _extends({}, response, {
     widgetSource: new WidgetTableSource(props)
@@ -944,7 +1353,6 @@ async function h3TableSource(props) {
 }
 /** Wrapper adding Widget API support to [h3QuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
 async function h3QuerySource(props) {
-  assignDefaultProps(props);
   const response = await h3QuerySource$1(props);
   return _extends({}, response, {
     widgetSource: new WidgetQuerySource(props)
@@ -952,7 +1360,6 @@ async function h3QuerySource(props) {
 }
 /** Wrapper adding Widget API support to [quadbinTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
 async function quadbinTableSource(props) {
-  assignDefaultProps(props);
   const response = await quadbinTableSource$1(props);
   return _extends({}, response, {
     widgetSource: new WidgetTableSource(props)
@@ -960,20 +1367,11 @@ async function quadbinTableSource(props) {
 }
 /** Wrapper adding Widget API support to [quadbinQuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
 async function quadbinQuerySource(props) {
-  assignDefaultProps(props);
   const response = await quadbinQuerySource$1(props);
   return _extends({}, response, {
     widgetSource: new WidgetQuerySource(props)
   });
 }
-function assignDefaultProps(props) {
-  if (typeof deck !== 'undefined' && deck && deck.VERSION) {
-    props.clientId || (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;
-  }
-}
 
-export { API_CLIENT_VERSION, FilterType, WidgetBaseSource, WidgetQuerySource, WidgetTableSource, addFilter, clearFilters, createPolygonSpatialFilter, createViewportSpatialFilter, getClient, getFilter, h3QuerySource, h3TableSource, hasFilter, quadbinQuerySource, quadbinTableSource, removeFilter, setClient, vectorQuerySource, vectorTableSource };
+export { API_CLIENT_VERSION, DEFAULT_AGGREGATION_RES_LEVEL_H3, DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN, DEFAULT_API_BASE_URL$1 as DEFAULT_API_BASE_URL, DEFAULT_CLIENT, DEFAULT_MAX_LENGTH_URL, DEFAULT_TILE_RESOLUTION, DEFAULT_TILE_SIZE, FilterType, V3_MINOR_VERSION, WidgetBaseSource, WidgetQuerySource, WidgetTableSource, addFilter, clearFilters, createPolygonSpatialFilter, createViewportSpatialFilter, getClient, getFilter, h3QuerySource, h3TableSource, hasFilter, quadbinQuerySource, quadbinTableSource, removeFilter, setClient, vectorQuerySource, vectorTableSource };
 //# sourceMappingURL=api-client.modern.js.map