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

package/CHANGELOG.md

@@ -11,6 +11,14 @@
 
 ## 0.4
 
+### 0.4.9 (Unreleased)
+
+- feat: Remove spatialIndexReferenceViewState param (#128)
+
+### 0.4.8
+
+- fix: Fix clientId defaults in query and source calls (#122)
+
 ### 0.4.7
 
 - fix: Fix clientId customization in table and query widget calls (#120)

package/build/api-client.cjs

@@ -2104,51 +2104,6 @@ const boundaryTableSource = function (options) {
   }
 };
 
-const DEFAULT_TILE_SIZE = 512;
-const QUADBIN_ZOOM_MAX_OFFSET = 4;
-function getSpatialFiltersResolution(source, viewState) {
-  const dataResolution = source.dataResolution ?? Number.MAX_VALUE;
-  const aggregationResLevel = source.aggregationResLevel ?? (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') {
-    const tileSize = DEFAULT_TILE_SIZE;
-    const maxResolutionForZoom = maxH3SpatialFiltersResolutions.find(_ref => {
-      let [zoom] = _ref;
-      return zoom === currentZoomInt;
-    })?.[1] ?? 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.
  *
@@ -2179,16 +2134,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.
@@ -2332,8 +2277,7 @@ function executeModel(props) {
     filters,
     filtersLogicalOperator = 'and',
     spatialDataType = 'geo',
-    spatialFiltersMode = 'intersects',
-    spatialFiltersResolution = 0
+    spatialFiltersMode = 'intersects'
   } = source;
   const queryParams = {
     type,
@@ -2359,9 +2303,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();
@@ -2412,7 +2353,6 @@ class WidgetRemoteSource extends WidgetSource {
         filterOwner,
         spatialFilter,
         spatialFiltersMode,
-        spatialIndexReferenceViewState,
         ...params
       } = options;
       const {
@@ -2420,13 +2360,10 @@ class WidgetRemoteSource extends WidgetSource {
         operation,
         operationColumn
       } = params;
-      const source = _this.getModelSource(filters, filterOwner);
-      const spatialFiltersResolution = _this._getSpatialFiltersResolution(source, spatialFilter, spatialIndexReferenceViewState);
       return Promise.resolve(executeModel({
         model: 'category',
         source: {
-          ...source,
-          spatialFiltersResolution,
+          ..._this.getModelSource(filters, filterOwner),
           spatialFiltersMode,
           spatialFilter
         },
@@ -2454,7 +2391,6 @@ class WidgetRemoteSource extends WidgetSource {
         filterOwner,
         spatialFilter,
         spatialFiltersMode,
-        spatialIndexReferenceViewState,
         ...params
       } = options;
       const {
@@ -2465,13 +2401,10 @@ class WidgetRemoteSource extends WidgetSource {
         limit,
         tileResolution
       } = params;
-      const source = _this2.getModelSource(filters, filterOwner);
-      const spatialFiltersResolution = _this2._getSpatialFiltersResolution(source, spatialFilter, spatialIndexReferenceViewState);
       return Promise.resolve(executeModel({
         model: 'pick',
         source: {
-          ...source,
-          spatialFiltersResolution,
+          ..._this2.getModelSource(filters, filterOwner),
           spatialFiltersMode,
           spatialFilter
         },
@@ -2510,7 +2443,6 @@ class WidgetRemoteSource extends WidgetSource {
         filterOwner,
         spatialFilter,
         spatialFiltersMode,
-        spatialIndexReferenceViewState,
         operationExp,
         ...params
       } = options;
@@ -2518,13 +2450,10 @@ class WidgetRemoteSource extends WidgetSource {
         column,
         operation
       } = params;
-      const source = _this3.getModelSource(filters, filterOwner);
-      const spatialFiltersResolution = _this3._getSpatialFiltersResolution(source, spatialFilter, spatialIndexReferenceViewState);
       return Promise.resolve(executeModel({
         model: 'formula',
         source: {
-          ...source,
-          spatialFiltersResolution,
+          ..._this3.getModelSource(filters, filterOwner),
           spatialFiltersMode,
           spatialFilter
         },
@@ -2552,7 +2481,6 @@ class WidgetRemoteSource extends WidgetSource {
         filterOwner,
         spatialFilter,
         spatialFiltersMode,
-        spatialIndexReferenceViewState,
         ...params
       } = options;
       const {
@@ -2560,13 +2488,10 @@ class WidgetRemoteSource extends WidgetSource {
         operation,
         ticks
       } = params;
-      const source = _this4.getModelSource(filters, filterOwner);
-      const spatialFiltersResolution = _this4._getSpatialFiltersResolution(source, spatialFilter, spatialIndexReferenceViewState);
       return Promise.resolve(executeModel({
         model: 'histogram',
         source: {
-          ...source,
-          spatialFiltersResolution,
+          ..._this4.getModelSource(filters, filterOwner),
           spatialFiltersMode,
           spatialFilter
         },
@@ -2609,19 +2534,15 @@ class WidgetRemoteSource extends WidgetSource {
         filterOwner,
         spatialFilter,
         spatialFiltersMode,
-        spatialIndexReferenceViewState,
         ...params
       } = options;
       const {
         column
       } = params;
-      const source = _this5.getModelSource(filters, filterOwner);
-      const spatialFiltersResolution = _this5._getSpatialFiltersResolution(source, spatialFilter, spatialIndexReferenceViewState);
       return Promise.resolve(executeModel({
         model: 'range',
         source: {
-          ...source,
-          spatialFiltersResolution,
+          ..._this5.getModelSource(filters, filterOwner),
           spatialFiltersMode,
           spatialFilter
         },
@@ -2647,7 +2568,6 @@ class WidgetRemoteSource extends WidgetSource {
         filterOwner,
         spatialFilter,
         spatialFiltersMode,
-        spatialIndexReferenceViewState,
         ...params
       } = options;
       const {
@@ -2656,15 +2576,12 @@ class WidgetRemoteSource extends WidgetSource {
         yAxisColumn,
         yAxisJoinOperation
       } = params;
-      const source = _this6.getModelSource(filters, filterOwner);
-      const spatialFiltersResolution = _this6._getSpatialFiltersResolution(source, spatialFilter, spatialIndexReferenceViewState);
       // Make sure this is sync with the same constant in cloud-native/maps-api
       const HARD_LIMIT = 500;
       return Promise.resolve(executeModel({
         model: 'scatterplot',
         source: {
-          ...source,
-          spatialFiltersResolution,
+          ..._this6.getModelSource(filters, filterOwner),
           spatialFiltersMode,
           spatialFilter
         },
@@ -2700,7 +2617,6 @@ class WidgetRemoteSource extends WidgetSource {
         filterOwner,
         spatialFilter,
         spatialFiltersMode,
-        spatialIndexReferenceViewState,
         ...params
       } = options;
       const {
@@ -2710,13 +2626,10 @@ class WidgetRemoteSource extends WidgetSource {
         offset = 0,
         limit = 10
       } = params;
-      const source = _this7.getModelSource(filters, filterOwner);
-      const spatialFiltersResolution = _this7._getSpatialFiltersResolution(source, spatialFilter, spatialIndexReferenceViewState);
       return Promise.resolve(executeModel({
         model: 'table',
         source: {
-          ...source,
-          spatialFiltersResolution,
+          ..._this7.getModelSource(filters, filterOwner),
           spatialFiltersMode,
           spatialFilter
         },
@@ -2750,7 +2663,6 @@ class WidgetRemoteSource extends WidgetSource {
         filterOwner,
         spatialFilter,
         spatialFiltersMode,
-        spatialIndexReferenceViewState,
         ...params
       } = options;
       const {
@@ -2764,13 +2676,10 @@ class WidgetRemoteSource extends WidgetSource {
         splitByCategoryLimit,
         splitByCategoryValues
       } = params;
-      const source = _this8.getModelSource(filters, filterOwner);
-      const spatialFiltersResolution = _this8._getSpatialFiltersResolution(source, spatialFilter, spatialIndexReferenceViewState);
       return Promise.resolve(executeModel({
         model: 'timeseries',
         source: {
-          ...source,
-          spatialFiltersResolution,
+          ..._this8.getModelSource(filters, filterOwner),
           spatialFiltersMode,
           spatialFilter
         },
@@ -4011,6 +3920,28 @@ const query = function (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));
+}
+
 exports.CartoAPIError = CartoAPIError;
 exports.DEFAULT_API_BASE_URL = DEFAULT_API_BASE_URL;
 exports.FEATURE_GEOM_PROPERTY = FEATURE_GEOM_PROPERTY;