@carto/api-client 0.4.1-alpha.0 → 0.4.1

package/build/api-client.modern.js

@@ -493,43 +493,41 @@ function executeModel(props) {
     data,
     filters,
     filtersLogicalOperator = 'and',
-    spatialDataType = 'geo',
-    spatialFiltersMode = 'intersects',
-    spatialFiltersResolution = 0
+    geoColumn = DEFAULT_GEO_COLUMN
   } = source;
+  const queryParameters = source.queryParameters ? JSON.stringify(source.queryParameters) : '';
   const queryParams = {
     type,
     client: clientId,
     source: data,
-    params,
-    queryParameters: source.queryParameters || '',
-    filters,
+    params: JSON.stringify(params),
+    queryParameters,
+    filters: JSON.stringify(filters),
     filtersLogicalOperator
   };
-  const spatialDataColumn = source.spatialDataColumn || DEFAULT_GEO_COLUMN;
   // Picking Model API requires 'spatialDataColumn'.
   if (model === 'pick') {
-    queryParams.spatialDataColumn = spatialDataColumn;
+    queryParams.spatialDataColumn = geoColumn;
   }
-  // API supports multiple filters, we apply it only to spatialDataColumn
+  // API supports multiple filters, we apply it only to geoColumn
   const spatialFilters = source.spatialFilter ? {
-    [spatialDataColumn]: source.spatialFilter
+    [geoColumn]: source.spatialFilter
   } : undefined;
   if (spatialFilters) {
-    queryParams.spatialFilters = spatialFilters; // JSON.stringify(spatialFilters);
-    queryParams.spatialDataColumn = spatialDataColumn;
-    queryParams.spatialDataType = spatialDataType;
+    queryParams.spatialFilters = JSON.stringify(spatialFilters);
   }
-  if (spatialDataType !== 'geo') {
-    if (spatialFiltersResolution > 0) {
-      queryParams.spatialFiltersResolution = spatialFiltersResolution;
-    }
-    queryParams.spatialFiltersMode = spatialFiltersMode;
-  }
-  const urlWithSearchParams = url + '?' + objectToURLSearchParams(queryParams).toString();
+  const urlWithSearchParams = url + '?' + new URLSearchParams(queryParams).toString();
   const isGet = urlWithSearchParams.length <= REQUEST_GET_MAX_URL_LENGTH;
   if (isGet) {
     url = urlWithSearchParams;
+  } else {
+    // undo the JSON.stringify, @TODO find a better pattern
+    queryParams.params = params;
+    queryParams.filters = filters;
+    queryParams.queryParameters = source.queryParameters;
+    if (spatialFilters) {
+      queryParams.spatialFilters = spatialFilters;
+    }
   }
   return makeCall({
     url,
@@ -541,75 +539,15 @@ function executeModel(props) {
     })
   });
 }
-function objectToURLSearchParams(object) {
-  const params = new URLSearchParams();
-  for (const key in object) {
-    if (isPureObject(object[key])) {
-      params.append(key, JSON.stringify(object[key]));
-    } else if (Array.isArray(object[key])) {
-      params.append(key, JSON.stringify(object[key]));
-    } else if (object[key] === null) {
-      params.append(key, 'null');
-    } else if (object[key] !== undefined) {
-      params.append(key, String(object[key]));
-    }
-  }
-  return params;
-}
 
-const DEFAULT_TILE_SIZE = 512;
-const QUADBIN_ZOOM_MAX_OFFSET = 4;
-function getSpatialFiltersResolution({
-  source,
-  viewState
-}) {
-  var _source$dataResolutio, _source$aggregationRe;
-  assert(viewState, 'viewState prop is required to compute automatic spatialFiltersResolution when using spatialFilter with spatial indexes. Either pass a `spatialFiltersResolution` prop or a `viewState` prop to avoid this error');
-  const dataResolution = (_source$dataResolutio = source.dataResolution) != null ? _source$dataResolutio : Number.MAX_VALUE;
-  const aggregationResLevel = (_source$aggregationRe = source.aggregationResLevel) != null ? _source$aggregationRe : source.spatialDataType === 'h3' ? DEFAULT_AGGREGATION_RES_LEVEL_H3 : DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN;
-  const aggregationResLevelOffset = Math.max(0, Math.floor(aggregationResLevel));
-  const currentZoomInt = Math.ceil(viewState.zoom);
-  if (source.spatialDataType === 'h3') {
-    var _maxH3SpatialFiltersR, _maxH3SpatialFiltersR2;
-    const tileSize = DEFAULT_TILE_SIZE;
-    const maxResolutionForZoom = (_maxH3SpatialFiltersR = (_maxH3SpatialFiltersR2 = maxH3SpatialFiltersResolutions.find(([zoom]) => zoom === currentZoomInt)) == null ? void 0 : _maxH3SpatialFiltersR2[1]) != null ? _maxH3SpatialFiltersR : Math.max(0, currentZoomInt - 3);
-    const maxSpatialFiltersResolution = maxResolutionForZoom ? Math.min(dataResolution, maxResolutionForZoom) : dataResolution;
-    const hexagonResolution = getHexagonResolution(viewState, tileSize) + aggregationResLevelOffset;
-    return Math.min(hexagonResolution, maxSpatialFiltersResolution);
-  }
-  if (source.spatialDataType === 'quadbin') {
-    const maxResolutionForZoom = currentZoomInt + QUADBIN_ZOOM_MAX_OFFSET;
-    const maxSpatialFiltersResolution = Math.min(dataResolution, maxResolutionForZoom);
-    const quadsResolution = Math.floor(viewState.zoom) + aggregationResLevelOffset;
-    return Math.min(quadsResolution, maxSpatialFiltersResolution);
-  }
-  return undefined;
-}
-const maxH3SpatialFiltersResolutions = [[20, 14], [19, 13], [18, 12], [17, 11], [16, 10], [15, 9], [14, 8], [13, 7], [12, 7], [11, 7], [10, 6], [9, 6], [8, 5], [7, 4], [6, 4], [5, 3], [4, 2], [3, 1], [2, 1], [1, 0]];
-// stolen from https://github.com/visgl/deck.gl/blob/master/modules/carto/src/layers/h3-tileset-2d.ts
-// Relative scale factor (0 = no biasing, 2 = a few hexagons cover view)
-const BIAS = 2;
-// Resolution conversion function. Takes a WebMercatorViewport and returns
-// a H3 resolution such that the screen space size of the hexagons is
-// similar
-function getHexagonResolution(viewport, tileSize) {
-  // Difference in given tile size compared to deck's internal 512px tile size,
-  // expressed as an offset to the viewport zoom.
-  const zoomOffset = Math.log2(tileSize / DEFAULT_TILE_SIZE);
-  const hexagonScaleFactor = 2 / 3 * (viewport.zoom - zoomOffset);
-  const latitudeScaleFactor = Math.log(1 / Math.cos(Math.PI * viewport.latitude / 180));
-  // Clip and bias
-  return Math.max(0, Math.floor(hexagonScaleFactor + latitudeScaleFactor - BIAS));
-}
-
-const _excluded$1 = ["filterOwner", "spatialFilter", "spatialFiltersMode", "abortController", "viewState"],
-  _excluded2 = ["filterOwner", "spatialFilter", "spatialFiltersMode", "abortController", "viewState"],
-  _excluded3 = ["filterOwner", "spatialFilter", "spatialFiltersMode", "abortController", "operationExp", "viewState"],
-  _excluded4 = ["filterOwner", "spatialFilter", "spatialFiltersMode", "abortController", "viewState"],
-  _excluded5 = ["filterOwner", "spatialFilter", "spatialFiltersMode", "abortController", "viewState"],
-  _excluded6 = ["filterOwner", "spatialFilter", "spatialFiltersMode", "abortController", "viewState"],
-  _excluded7 = ["filterOwner", "spatialFilter", "spatialFiltersMode", "abortController", "viewState"],
-  _excluded8 = ["filterOwner", "abortController", "spatialFilter", "spatialFiltersMode", "viewState"];
+const _excluded$1 = ["filterOwner", "spatialFilter", "abortController"],
+  _excluded2 = ["filterOwner", "spatialFilter", "abortController"],
+  _excluded3 = ["filterOwner", "spatialFilter", "abortController", "operationExp"],
+  _excluded4 = ["filterOwner", "spatialFilter", "abortController"],
+  _excluded5 = ["filterOwner", "spatialFilter", "abortController"],
+  _excluded6 = ["filterOwner", "spatialFilter", "abortController"],
+  _excluded7 = ["filterOwner", "spatialFilter", "abortController"],
+  _excluded8 = ["filterOwner", "abortController", "spatialFilter"];
 /**
  * Source for Widget API requests on a data source defined by a SQL query.
  *
@@ -630,8 +568,7 @@ class WidgetBaseSource {
       connectionName: props.connectionName,
       filters: getApplicableFilters(owner, props.filters),
       filtersLogicalOperator: props.filtersLogicalOperator,
-      spatialDataType: props.spatialDataType,
-      spatialDataColumn: props.spatialDataColumn
+      geoColumn: props.geoColumn
     };
   }
   /****************************************************************************
@@ -645,9 +582,7 @@ class WidgetBaseSource {
     const {
         filterOwner,
         spatialFilter,
-        spatialFiltersMode,
-        abortController,
-        viewState
+        abortController
       } = options,
       params = _objectWithoutPropertiesLoose(options, _excluded$1);
     const {
@@ -655,19 +590,9 @@ class WidgetBaseSource {
       operation,
       operationColumn
     } = params;
-    const source = this.getModelSource(filterOwner);
-    let spatialFiltersResolution;
-    if (spatialFilter && source.spatialDataType !== 'geo') {
-      spatialFiltersResolution = getSpatialFiltersResolution({
-        source,
-        viewState
-      });
-    }
     return executeModel({
       model: 'category',
-      source: _extends({}, source, {
-        spatialFiltersResolution,
-        spatialFiltersMode,
+      source: _extends({}, this.getModelSource(filterOwner), {
         spatialFilter
       }),
       params: {
@@ -695,9 +620,7 @@ class WidgetBaseSource {
     const {
         filterOwner,
         spatialFilter,
-        spatialFiltersMode,
-        abortController,
-        viewState
+        abortController
       } = options,
       params = _objectWithoutPropertiesLoose(options, _excluded2);
     const {
@@ -708,19 +631,9 @@ class WidgetBaseSource {
       limit,
       tileResolution
     } = params;
-    const source = this.getModelSource(filterOwner);
-    let spatialFiltersResolution;
-    if (spatialFilter && source.spatialDataType !== 'geo') {
-      spatialFiltersResolution = getSpatialFiltersResolution({
-        source,
-        viewState
-      });
-    }
     return executeModel({
       model: 'pick',
-      source: _extends({}, source, {
-        spatialFiltersResolution,
-        spatialFiltersMode,
+      source: _extends({}, this.getModelSource(filterOwner), {
         spatialFilter
       }),
       params: {
@@ -749,29 +662,17 @@ class WidgetBaseSource {
     const {
         filterOwner,
         spatialFilter,
-        spatialFiltersMode,
         abortController,
-        operationExp,
-        viewState
+        operationExp
       } = options,
       params = _objectWithoutPropertiesLoose(options, _excluded3);
     const {
       column,
       operation
     } = params;
-    const source = this.getModelSource(filterOwner);
-    let spatialFiltersResolution;
-    if (spatialFilter && source.spatialDataType !== 'geo') {
-      spatialFiltersResolution = getSpatialFiltersResolution({
-        source,
-        viewState
-      });
-    }
     return executeModel({
       model: 'formula',
-      source: _extends({}, source, {
-        spatialFiltersResolution,
-        spatialFiltersMode,
+      source: _extends({}, this.getModelSource(filterOwner), {
         spatialFilter
       }),
       params: {
@@ -795,9 +696,7 @@ class WidgetBaseSource {
     const {
         filterOwner,
         spatialFilter,
-        spatialFiltersMode,
-        abortController,
-        viewState
+        abortController
       } = options,
       params = _objectWithoutPropertiesLoose(options, _excluded4);
     const {
@@ -805,19 +704,9 @@ class WidgetBaseSource {
       operation,
       ticks
     } = params;
-    const source = this.getModelSource(filterOwner);
-    let spatialFiltersResolution;
-    if (spatialFilter && source.spatialDataType !== 'geo') {
-      spatialFiltersResolution = getSpatialFiltersResolution({
-        source,
-        viewState
-      });
-    }
     const data = await executeModel({
       model: 'histogram',
-      source: _extends({}, source, {
-        spatialFiltersResolution,
-        spatialFiltersMode,
+      source: _extends({}, this.getModelSource(filterOwner), {
         spatialFilter
       }),
       params: {
@@ -853,27 +742,15 @@ class WidgetBaseSource {
     const {
         filterOwner,
         spatialFilter,
-        spatialFiltersMode,
-        abortController,
-        viewState
+        abortController
       } = options,
       params = _objectWithoutPropertiesLoose(options, _excluded5);
     const {
       column
     } = params;
-    const source = this.getModelSource(filterOwner);
-    let spatialFiltersResolution;
-    if (spatialFilter && source.spatialDataType !== 'geo') {
-      spatialFiltersResolution = getSpatialFiltersResolution({
-        source,
-        viewState
-      });
-    }
     return executeModel({
       model: 'range',
-      source: _extends({}, source, {
-        spatialFiltersResolution,
-        spatialFiltersMode,
+      source: _extends({}, this.getModelSource(filterOwner), {
         spatialFilter
       }),
       params: {
@@ -895,9 +772,7 @@ class WidgetBaseSource {
     const {
         filterOwner,
         spatialFilter,
-        spatialFiltersMode,
-        abortController,
-        viewState
+        abortController
       } = options,
       params = _objectWithoutPropertiesLoose(options, _excluded6);
     const {
@@ -906,21 +781,11 @@ class WidgetBaseSource {
       yAxisColumn,
       yAxisJoinOperation
     } = params;
-    const source = this.getModelSource(filterOwner);
-    let spatialFiltersResolution;
-    if (spatialFilter && source.spatialDataType !== 'geo') {
-      spatialFiltersResolution = getSpatialFiltersResolution({
-        source,
-        viewState
-      });
-    }
     // Make sure this is sync with the same constant in cloud-native/maps-api
     const HARD_LIMIT = 500;
     return executeModel({
       model: 'scatterplot',
-      source: _extends({}, source, {
-        spatialFiltersResolution,
-        spatialFiltersMode,
+      source: _extends({}, this.getModelSource(filterOwner), {
         spatialFilter
       }),
       params: {
@@ -949,9 +814,7 @@ class WidgetBaseSource {
     const {
         filterOwner,
         spatialFilter,
-        spatialFiltersMode,
-        abortController,
-        viewState
+        abortController
       } = options,
       params = _objectWithoutPropertiesLoose(options, _excluded7);
     const {
@@ -961,19 +824,9 @@ class WidgetBaseSource {
       offset = 0,
       limit = 10
     } = params;
-    const source = this.getModelSource(filterOwner);
-    let spatialFiltersResolution;
-    if (spatialFilter && source.spatialDataType !== 'geo') {
-      spatialFiltersResolution = getSpatialFiltersResolution({
-        source,
-        viewState
-      });
-    }
     return executeModel({
       model: 'table',
-      source: _extends({}, source, {
-        spatialFiltersResolution,
-        spatialFiltersMode,
+      source: _extends({}, this.getModelSource(filterOwner), {
         spatialFilter
       }),
       params: {
@@ -1006,9 +859,7 @@ class WidgetBaseSource {
     const {
         filterOwner,
         abortController,
-        spatialFilter,
-        spatialFiltersMode,
-        viewState
+        spatialFilter
       } = options,
       params = _objectWithoutPropertiesLoose(options, _excluded8);
     const {
@@ -1022,19 +873,9 @@ class WidgetBaseSource {
       splitByCategoryLimit,
       splitByCategoryValues
     } = params;
-    const source = this.getModelSource(filterOwner);
-    let spatialFiltersResolution;
-    if (spatialFilter && source.spatialDataType !== 'geo') {
-      spatialFiltersResolution = getSpatialFiltersResolution({
-        source,
-        viewState
-      });
-    }
     return executeModel({
       model: 'timeseries',
-      source: _extends({}, source, {
-        spatialFiltersResolution,
-        spatialFiltersMode,
+      source: _extends({}, this.getModelSource(filterOwner), {
         spatialFilter
       }),
       params: {
@@ -1065,7 +906,8 @@ WidgetBaseSource.defaultProps = {
   apiBaseUrl: DEFAULT_API_BASE_URL,
   clientId: getClient(),
   filters: {},
-  filtersLogicalOperator: 'and'
+  filtersLogicalOperator: 'and',
+  geoColumn: DEFAULT_GEO_COLUMN
 };
 
 /**
@@ -1235,13 +1077,14 @@ const DEFAULT_HEADERS = {
   Accept: 'application/json',
   'Content-Type': 'application/json'
 };
-const REQUEST_CACHE = new Map();
+const DEFAULT_REQUEST_CACHE = new Map();
 async function requestWithParameters({
   baseUrl,
   parameters = {},
   headers: customHeaders = {},
   errorContext,
-  maxLengthURL = DEFAULT_MAX_LENGTH_URL
+  maxLengthURL = DEFAULT_MAX_LENGTH_URL,
+  localCache
 }) {
   // Parameters added to all requests issued with `requestWithParameters()`.
   // These parameters override parameters already in the base URL, but not
@@ -1254,7 +1097,12 @@ async function requestWithParameters({
   }, parameters);
   baseUrl = excludeURLParameters(baseUrl, Object.keys(parameters));
   const key = createCacheKey(baseUrl, parameters, customHeaders);
-  if (REQUEST_CACHE.has(key)) {
+  const {
+    cache: REQUEST_CACHE,
+    canReadCache,
+    canStoreInCache
+  } = getCacheSettings(localCache);
+  if (canReadCache && REQUEST_CACHE.has(key)) {
     return REQUEST_CACHE.get(key);
   }
   const url = createURLWithParameters(baseUrl, parameters);
@@ -1279,12 +1127,27 @@ async function requestWithParameters({
     }
     return json;
   }).catch(error => {
-    REQUEST_CACHE.delete(key);
+    if (canStoreInCache) {
+      REQUEST_CACHE.delete(key);
+    }
     throw new CartoAPIError(error, errorContext, response, responseJson);
   });
-  REQUEST_CACHE.set(key, jsonPromise);
+  if (canStoreInCache) {
+    REQUEST_CACHE.set(key, jsonPromise);
+  }
   return jsonPromise;
 }
+function getCacheSettings(localCache) {
+  var _localCache$cacheCont, _localCache$cacheCont2;
+  const canReadCache = localCache != null && (_localCache$cacheCont = localCache.cacheControl) != null && _localCache$cacheCont.includes('no-cache') ? false : true;
+  const canStoreInCache = localCache != null && (_localCache$cacheCont2 = localCache.cacheControl) != null && _localCache$cacheCont2.includes('no-store') ? false : true;
+  const cache = (localCache == null ? void 0 : localCache.cache) || DEFAULT_REQUEST_CACHE;
+  return {
+    cache,
+    canReadCache,
+    canStoreInCache
+  };
+}
 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);
@@ -1352,7 +1215,8 @@ async function baseSource(endpoint, options, urlParameters) {
   const {
     clientId,
     maxLengthURL,
-    format
+    format,
+    localCache
   } = mergedOptions;
   const headers = _extends({
     Authorization: `Bearer ${options.accessToken}`
@@ -1371,7 +1235,8 @@ async function baseSource(endpoint, options, urlParameters) {
     parameters,
     headers,
     errorContext,
-    maxLengthURL
+    maxLengthURL,
+    localCache
   });
   const dataUrl = mapInstantiation[format].url[0];
   if (cache) {
@@ -1383,7 +1248,8 @@ async function baseSource(endpoint, options, urlParameters) {
       baseUrl: dataUrl,
       headers,
       errorContext,
-      maxLengthURL
+      maxLengthURL,
+      localCache
     });
     if (accessToken) {
       json.accessToken = accessToken;
@@ -1394,7 +1260,8 @@ async function baseSource(endpoint, options, urlParameters) {
     baseUrl: dataUrl,
     headers,
     errorContext,
-    maxLengthURL
+    maxLengthURL,
+    localCache
   });
 }
 
@@ -1469,11 +1336,7 @@ const h3QuerySource = async function h3QuerySource(options) {
     urlParameters.filters = filters;
   }
   return baseSource('query', options, urlParameters).then(result => _extends({}, result, {
-    widgetSource: new WidgetQuerySource(_extends({}, options, {
-      // NOTE: passing redundant spatialDataColumn here to apply the default value 'h3'
-      spatialDataColumn,
-      spatialDataType: 'h3'
-    }))
+    widgetSource: new WidgetQuerySource(options)
   }));
 };
 
@@ -1498,11 +1361,7 @@ const h3TableSource = async function h3TableSource(options) {
     urlParameters.filters = filters;
   }
   return baseSource('table', options, urlParameters).then(result => _extends({}, result, {
-    widgetSource: new WidgetTableSource(_extends({}, options, {
-      // NOTE: passing redundant spatialDataColumn here to apply the default value 'h3'
-      spatialDataColumn,
-      spatialDataType: 'h3'
-    }))
+    widgetSource: new WidgetTableSource(options)
   }));
 };
 
@@ -1557,11 +1416,7 @@ const quadbinQuerySource = async function quadbinQuerySource(options) {
     urlParameters.filters = filters;
   }
   return baseSource('query', options, urlParameters).then(result => _extends({}, result, {
-    widgetSource: new WidgetQuerySource(_extends({}, options, {
-      // NOTE: passing redundant spatialDataColumn here to apply the default value 'quadbin'
-      spatialDataColumn,
-      spatialDataType: 'quadbin'
-    }))
+    widgetSource: new WidgetQuerySource(options)
   }));
 };
 
@@ -1586,11 +1441,7 @@ const quadbinTableSource = async function quadbinTableSource(options) {
     urlParameters.filters = filters;
   }
   return baseSource('table', options, urlParameters).then(result => _extends({}, result, {
-    widgetSource: new WidgetTableSource(_extends({}, options, {
-      // NOTE: passing redundant spatialDataColumn here to apply the default value 'quadbin'
-      spatialDataColumn,
-      spatialDataType: 'quadbin'
-    }))
+    widgetSource: new WidgetTableSource(options)
   }));
 };
 
@@ -1630,9 +1481,7 @@ const vectorQuerySource = async function vectorQuerySource(options) {
     urlParameters.queryParameters = queryParameters;
   }
   return baseSource('query', options, urlParameters).then(result => _extends({}, result, {
-    widgetSource: new WidgetQuerySource(_extends({}, options, {
-      spatialDataType: 'geo'
-    }))
+    widgetSource: new WidgetQuerySource(options)
   }));
 };
 
@@ -1657,9 +1506,7 @@ const vectorTableSource = async function vectorTableSource(options) {
     urlParameters.filters = filters;
   }
   return baseSource('table', options, urlParameters).then(result => _extends({}, result, {
-    widgetSource: new WidgetTableSource(_extends({}, options, {
-      spatialDataType: 'geo'
-    }))
+    widgetSource: new WidgetTableSource(options)
   }));
 };
 
@@ -1679,6 +1526,7 @@ const query = async function query(options) {
     apiBaseUrl = SOURCE_DEFAULTS.apiBaseUrl,
     clientId = SOURCE_DEFAULTS.clientId,
     maxLengthURL = SOURCE_DEFAULTS.maxLengthURL,
+    localCache,
     connectionName,
     sqlQuery,
     queryParameters
@@ -1710,7 +1558,8 @@ const query = async function query(options) {
     parameters,
     headers,
     errorContext,
-    maxLengthURL
+    maxLengthURL,
+    localCache
   });
 };