@carto/api-client 0.4.8-alpha.0 → 0.4.9-alpha.0

package/build/api-client.modern.js

@@ -2056,50 +2056,6 @@ const boundaryTableSource = async function boundaryTableSource(options) {
   return baseSource('boundary', options, urlParameters);
 };
 
-const DEFAULT_TILE_SIZE = 512;
-const QUADBIN_ZOOM_MAX_OFFSET = 4;
-function getSpatialFiltersResolution(source, viewState) {
-  var _source$dataResolutio, _source$aggregationRe;
-  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" to the given tileSize on screen. Intended for use with deck.gl.
- * @internal
- */
-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));
-}
-
 /**
  * Source for Widget API requests on a data source defined by a SQL query.
  *
@@ -2127,16 +2083,6 @@ class WidgetSource {
       dataResolution: props.dataResolution
     };
   }
-  _getSpatialFiltersResolution(source, spatialFilter, referenceViewState) {
-    // spatialFiltersResolution applies only to spatial index sources.
-    if (!spatialFilter || source.spatialDataType === 'geo') {
-      return;
-    }
-    if (!referenceViewState) {
-      throw new Error('Missing required option, "spatialIndexReferenceViewState".');
-    }
-    return getSpatialFiltersResolution(source, referenceViewState);
-  }
 }
 /**
  * @todo TODO(v0.5): Remove WidgetBaseSource alias.
@@ -2250,8 +2196,7 @@ function executeModel(props) {
     filters,
     filtersLogicalOperator = 'and',
     spatialDataType = 'geo',
-    spatialFiltersMode = 'intersects',
-    spatialFiltersResolution = 0
+    spatialFiltersMode = 'intersects'
   } = source;
   const queryParams = {
     type,
@@ -2277,9 +2222,6 @@ function executeModel(props) {
     queryParams.spatialDataType = spatialDataType;
   }
   if (spatialDataType !== 'geo') {
-    if (spatialFiltersResolution > 0) {
-      queryParams.spatialFiltersResolution = spatialFiltersResolution;
-    }
     queryParams.spatialFiltersMode = spatialFiltersMode;
   }
   const urlWithSearchParams = url + '?' + objectToURLSearchParams(queryParams).toString();
@@ -2313,14 +2255,14 @@ function objectToURLSearchParams(object) {
   return params;
 }
 
-const _excluded = ["signal", "filters", "filterOwner", "spatialFilter", "spatialFiltersMode", "spatialIndexReferenceViewState"],
-  _excluded2 = ["abortController", "signal", "filters", "filterOwner", "spatialFilter", "spatialFiltersMode", "spatialIndexReferenceViewState"],
-  _excluded3 = ["abortController", "signal", "filters", "filterOwner", "spatialFilter", "spatialFiltersMode", "spatialIndexReferenceViewState", "operationExp"],
-  _excluded4 = ["abortController", "signal", "filters", "filterOwner", "spatialFilter", "spatialFiltersMode", "spatialIndexReferenceViewState"],
-  _excluded5 = ["abortController", "signal", "filters", "filterOwner", "spatialFilter", "spatialFiltersMode", "spatialIndexReferenceViewState"],
-  _excluded6 = ["abortController", "signal", "filters", "filterOwner", "spatialFilter", "spatialFiltersMode", "spatialIndexReferenceViewState"],
-  _excluded7 = ["abortController", "signal", "filters", "filterOwner", "spatialFilter", "spatialFiltersMode", "spatialIndexReferenceViewState"],
-  _excluded8 = ["abortController", "signal", "filters", "filterOwner", "spatialFilter", "spatialFiltersMode", "spatialIndexReferenceViewState"];
+const _excluded = ["signal", "filters", "filterOwner", "spatialFilter", "spatialFiltersMode"],
+  _excluded2 = ["abortController", "signal", "filters", "filterOwner", "spatialFilter", "spatialFiltersMode"],
+  _excluded3 = ["abortController", "signal", "filters", "filterOwner", "spatialFilter", "spatialFiltersMode", "operationExp"],
+  _excluded4 = ["abortController", "signal", "filters", "filterOwner", "spatialFilter", "spatialFiltersMode"],
+  _excluded5 = ["abortController", "signal", "filters", "filterOwner", "spatialFilter", "spatialFiltersMode"],
+  _excluded6 = ["abortController", "signal", "filters", "filterOwner", "spatialFilter", "spatialFiltersMode"],
+  _excluded7 = ["abortController", "signal", "filters", "filterOwner", "spatialFilter", "spatialFiltersMode"],
+  _excluded8 = ["abortController", "signal", "filters", "filterOwner", "spatialFilter", "spatialFiltersMode"];
 /**
  * Source for Widget API requests.
  *
@@ -2333,8 +2275,7 @@ class WidgetRemoteSource extends WidgetSource {
         filters = this.props.filters,
         filterOwner,
         spatialFilter,
-        spatialFiltersMode,
-        spatialIndexReferenceViewState
+        spatialFiltersMode
       } = options,
       params = _objectWithoutPropertiesLoose(options, _excluded);
     const {
@@ -2342,12 +2283,9 @@ class WidgetRemoteSource extends WidgetSource {
       operation,
       operationColumn
     } = params;
-    const source = this.getModelSource(filters, filterOwner);
-    const spatialFiltersResolution = this._getSpatialFiltersResolution(source, spatialFilter, spatialIndexReferenceViewState);
     return executeModel({
       model: 'category',
-      source: _extends({}, source, {
-        spatialFiltersResolution,
+      source: _extends({}, this.getModelSource(filters, filterOwner), {
         spatialFiltersMode,
         spatialFilter
       }),
@@ -2369,8 +2307,7 @@ class WidgetRemoteSource extends WidgetSource {
         filters = this.props.filters,
         filterOwner,
         spatialFilter,
-        spatialFiltersMode,
-        spatialIndexReferenceViewState
+        spatialFiltersMode
       } = options,
       params = _objectWithoutPropertiesLoose(options, _excluded2);
     const {
@@ -2381,12 +2318,9 @@ class WidgetRemoteSource extends WidgetSource {
       limit,
       tileResolution
     } = params;
-    const source = this.getModelSource(filters, filterOwner);
-    const spatialFiltersResolution = this._getSpatialFiltersResolution(source, spatialFilter, spatialIndexReferenceViewState);
     return executeModel({
       model: 'pick',
-      source: _extends({}, source, {
-        spatialFiltersResolution,
+      source: _extends({}, this.getModelSource(filters, filterOwner), {
         spatialFiltersMode,
         spatialFilter
       }),
@@ -2417,7 +2351,6 @@ class WidgetRemoteSource extends WidgetSource {
         filterOwner,
         spatialFilter,
         spatialFiltersMode,
-        spatialIndexReferenceViewState,
         operationExp
       } = options,
       params = _objectWithoutPropertiesLoose(options, _excluded3);
@@ -2425,12 +2358,9 @@ class WidgetRemoteSource extends WidgetSource {
       column,
       operation
     } = params;
-    const source = this.getModelSource(filters, filterOwner);
-    const spatialFiltersResolution = this._getSpatialFiltersResolution(source, spatialFilter, spatialIndexReferenceViewState);
     return executeModel({
       model: 'formula',
-      source: _extends({}, source, {
-        spatialFiltersResolution,
+      source: _extends({}, this.getModelSource(filters, filterOwner), {
         spatialFiltersMode,
         spatialFilter
       }),
@@ -2452,8 +2382,7 @@ class WidgetRemoteSource extends WidgetSource {
         filters = this.props.filters,
         filterOwner,
         spatialFilter,
-        spatialFiltersMode,
-        spatialIndexReferenceViewState
+        spatialFiltersMode
       } = options,
       params = _objectWithoutPropertiesLoose(options, _excluded4);
     const {
@@ -2461,12 +2390,9 @@ class WidgetRemoteSource extends WidgetSource {
       operation,
       ticks
     } = params;
-    const source = this.getModelSource(filters, filterOwner);
-    const spatialFiltersResolution = this._getSpatialFiltersResolution(source, spatialFilter, spatialIndexReferenceViewState);
     const data = await executeModel({
       model: 'histogram',
-      source: _extends({}, source, {
-        spatialFiltersResolution,
+      source: _extends({}, this.getModelSource(filters, filterOwner), {
         spatialFiltersMode,
         spatialFilter
       }),
@@ -2499,19 +2425,15 @@ class WidgetRemoteSource extends WidgetSource {
         filters = this.props.filters,
         filterOwner,
         spatialFilter,
-        spatialFiltersMode,
-        spatialIndexReferenceViewState
+        spatialFiltersMode
       } = options,
       params = _objectWithoutPropertiesLoose(options, _excluded5);
     const {
       column
     } = params;
-    const source = this.getModelSource(filters, filterOwner);
-    const spatialFiltersResolution = this._getSpatialFiltersResolution(source, spatialFilter, spatialIndexReferenceViewState);
     return executeModel({
       model: 'range',
-      source: _extends({}, source, {
-        spatialFiltersResolution,
+      source: _extends({}, this.getModelSource(filters, filterOwner), {
         spatialFiltersMode,
         spatialFilter
       }),
@@ -2531,8 +2453,7 @@ class WidgetRemoteSource extends WidgetSource {
         filters = this.props.filters,
         filterOwner,
         spatialFilter,
-        spatialFiltersMode,
-        spatialIndexReferenceViewState
+        spatialFiltersMode
       } = options,
       params = _objectWithoutPropertiesLoose(options, _excluded6);
     const {
@@ -2541,14 +2462,11 @@ class WidgetRemoteSource extends WidgetSource {
       yAxisColumn,
       yAxisJoinOperation
     } = params;
-    const source = this.getModelSource(filters, filterOwner);
-    const spatialFiltersResolution = this._getSpatialFiltersResolution(source, spatialFilter, spatialIndexReferenceViewState);
     // 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,
+      source: _extends({}, this.getModelSource(filters, filterOwner), {
         spatialFiltersMode,
         spatialFilter
       }),
@@ -2575,8 +2493,7 @@ class WidgetRemoteSource extends WidgetSource {
         filters = this.props.filters,
         filterOwner,
         spatialFilter,
-        spatialFiltersMode,
-        spatialIndexReferenceViewState
+        spatialFiltersMode
       } = options,
       params = _objectWithoutPropertiesLoose(options, _excluded7);
     const {
@@ -2586,12 +2503,9 @@ class WidgetRemoteSource extends WidgetSource {
       offset = 0,
       limit = 10
     } = params;
-    const source = this.getModelSource(filters, filterOwner);
-    const spatialFiltersResolution = this._getSpatialFiltersResolution(source, spatialFilter, spatialIndexReferenceViewState);
     return executeModel({
       model: 'table',
-      source: _extends({}, source, {
-        spatialFiltersResolution,
+      source: _extends({}, this.getModelSource(filters, filterOwner), {
         spatialFiltersMode,
         spatialFilter
       }),
@@ -2622,8 +2536,7 @@ class WidgetRemoteSource extends WidgetSource {
         filters = this.props.filters,
         filterOwner,
         spatialFilter,
-        spatialFiltersMode,
-        spatialIndexReferenceViewState
+        spatialFiltersMode
       } = options,
       params = _objectWithoutPropertiesLoose(options, _excluded8);
     const {
@@ -2637,12 +2550,9 @@ class WidgetRemoteSource extends WidgetSource {
       splitByCategoryLimit,
       splitByCategoryValues
     } = params;
-    const source = this.getModelSource(filters, filterOwner);
-    const spatialFiltersResolution = this._getSpatialFiltersResolution(source, spatialFilter, spatialIndexReferenceViewState);
     return executeModel({
       model: 'timeseries',
-      source: _extends({}, source, {
-        spatialFiltersResolution,
+      source: _extends({}, this.getModelSource(filters, filterOwner), {
         spatialFiltersMode,
         spatialFilter
       }),
@@ -3725,5 +3635,27 @@ const query = async function query(options) {
   });
 };
 
+// Default tile display size in deck.gl, in viewport pixels. May differ
+// from size or resolution assumed when generating the tile data,
+const DEFAULT_TILE_SIZE = 512;
+// 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" to the given tileSize on screen. Intended for use with deck.gl.
+ * @internal
+ * @privateRemarks Source: https://github.com/visgl/deck.gl/blob/master/modules/carto/src/layers/h3-tileset-2d.ts
+ */
+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));
+}
+
 export { ApiVersion, CartoAPIError, DEFAULT_API_BASE_URL, FEATURE_GEOM_PROPERTY, FilterType, Provider, SOURCE_DEFAULTS, SpatialIndex, TileFormat, WidgetBaseSource, WidgetQuerySource, WidgetRemoteSource, WidgetSource, WidgetTableSource, WidgetTilesetSource, _buildFeatureFilter, _getHexagonResolution, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildPublicMapUrl, buildStatsUrl, clearFilters, createPolygonSpatialFilter, createViewportSpatialFilter, filterFunctions, geojsonFeatures, getClient, getDataFilterExtensionProps, getFilter, groupValuesByColumn, groupValuesByDateColumn, h3QuerySource, h3TableSource, h3TilesetSource, hasFilter, histogram, makeIntervalComplete, quadbinQuerySource, quadbinTableSource, quadbinTilesetSource, query, rasterSource, removeFilter, requestWithParameters, scatterPlot, setClient, tileFeatures, tileFeaturesGeometries, tileFeaturesSpatialIndex, transformToTileCoords, vectorQuerySource, vectorTableSource, vectorTilesetSource };
 //# sourceMappingURL=api-client.modern.js.map