@carto/api-client 0.5.0-alpha.0 → 0.5.0-alpha.2

package/CHANGELOG.md

@@ -4,6 +4,11 @@
 
 ## 0.4
 
+### 0.4.5
+
+- types: Export TileResolution and SpatialFilterPolyfillMode types (#63)
+- fix: Propagate spatialDataColumn and tileResolution defaults to widget source (#64)
+
 ### 0.4.4
 
 - feat: Add support for spatial index types (H3, quadbin) in Widget APIs

package/build/api-client.cjs

@@ -796,6 +796,95 @@ 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
+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.
+ *
+ * Abstract class. Use {@link WidgetQuerySource} or {@link WidgetTableSource}.
+ */
+class WidgetSource {
+  constructor(props) {
+    this.props = void 0;
+    this.props = {
+      ...WidgetSource.defaultProps,
+      ...props
+    };
+  }
+  _getModelSource(owner) {
+    const props = this.props;
+    return {
+      apiVersion: props.apiVersion,
+      apiBaseUrl: props.apiBaseUrl,
+      clientId: props.clientId,
+      accessToken: props.accessToken,
+      connectionName: props.connectionName,
+      filters: getApplicableFilters(owner, props.filters),
+      filtersLogicalOperator: props.filtersLogicalOperator,
+      spatialDataType: props.spatialDataType,
+      spatialDataColumn: props.spatialDataColumn,
+      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);
+  }
+}
+WidgetSource.defaultProps = {
+  apiVersion: exports.ApiVersion.V3,
+  apiBaseUrl: DEFAULT_API_BASE_URL,
+  clientId: getClient(),
+  filters: {},
+  filtersLogicalOperator: 'and'
+};
+
 /**
  * Return more descriptive error from API
  * @internalRemarks Source: @carto/react-api
@@ -990,95 +1079,6 @@ function objectToURLSearchParams(object) {
   return params;
 }
 
-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
-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.
- *
- * Abstract class. Use {@link WidgetQuerySource} or {@link WidgetTableSource}.
- */
-class WidgetSource {
-  constructor(props) {
-    this.props = void 0;
-    this.props = {
-      ...WidgetSource.defaultProps,
-      ...props
-    };
-  }
-  _getModelSource(owner) {
-    const props = this.props;
-    return {
-      apiVersion: props.apiVersion,
-      apiBaseUrl: props.apiBaseUrl,
-      clientId: props.clientId,
-      accessToken: props.accessToken,
-      connectionName: props.connectionName,
-      filters: getApplicableFilters(owner, props.filters),
-      filtersLogicalOperator: props.filtersLogicalOperator,
-      spatialDataType: props.spatialDataType,
-      spatialDataColumn: props.spatialDataColumn,
-      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);
-  }
-}
-WidgetSource.defaultProps = {
-  apiVersion: exports.ApiVersion.V3,
-  apiBaseUrl: DEFAULT_API_BASE_URL,
-  clientId: getClient(),
-  filters: {},
-  filtersLogicalOperator: 'and'
-};
-
 /**
  * Source for Widget API requests.
  *
@@ -3152,6 +3152,7 @@ function scatterPlot(_ref) {
 class WidgetTilesetSource extends WidgetSource {
   constructor() {
     super(...arguments);
+    this._tiles = [];
     this._features = [];
   }
   getModelSource(owner) {
@@ -3161,16 +3162,26 @@ class WidgetTilesetSource extends WidgetSource {
       data: this.props.tableName
     };
   }
-  /** Loads features as a list of tiles (typically provided by deck.gl). */
-  loadTiles(_ref) {
+  /**
+   * Loads features as a list of tiles (typically provided by deck.gl).
+   * After tiles are loaded, {@link extractTileFeatures} must be called
+   * before computing statistics on the tiles.
+   */
+  loadTiles(tiles) {
+    this._tiles = tiles;
+  }
+  /**
+   * Extracts feature data from tiles previously loaded with {@link loadTiles}.
+   * Must be called before computing statistics on tiles.
+   */
+  extractTileFeatures(_ref) {
     let {
-      tiles,
       spatialFilter,
       uniqueIdProperty,
       options
     } = _ref;
     this._features = tileFeatures({
-      tiles,
+      tiles: this._tiles,
       options,
       spatialFilter,
       uniqueIdProperty,
@@ -3461,10 +3472,11 @@ const h3QuerySource = function (options) {
       queryParameters,
       filters
     } = options;
+    const spatialDataType = 'h3';
     const urlParameters = {
       aggregationExp,
       spatialDataColumn,
-      spatialDataType: 'h3',
+      spatialDataType,
       q: sqlQuery
     };
     if (aggregationResLevel) {
@@ -3480,9 +3492,9 @@ const h3QuerySource = function (options) {
       ...result,
       widgetSource: new WidgetQuerySource({
         ...options,
-        // NOTE: passing redundant spatialDataColumn here to apply the default value 'h3'
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'h3'
+        spatialDataType
       })
     })));
   } catch (e) {
@@ -3503,11 +3515,12 @@ const h3TableSource = function (options) {
       tableName,
       filters
     } = options;
+    const spatialDataType = 'h3';
     const urlParameters = {
       aggregationExp,
       name: tableName,
       spatialDataColumn,
-      spatialDataType: 'h3'
+      spatialDataType
     };
     if (aggregationResLevel) {
       urlParameters.aggregationResLevel = String(aggregationResLevel);
@@ -3519,9 +3532,9 @@ const h3TableSource = function (options) {
       ...result,
       widgetSource: new WidgetTableSource({
         ...options,
-        // NOTE: passing redundant spatialDataColumn here to apply the default value 'h3'
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'h3'
+        spatialDataType
       })
     })));
   } catch (e) {
@@ -3595,11 +3608,12 @@ const quadbinQuerySource = function (options) {
       queryParameters,
       filters
     } = options;
+    const spatialDataType = 'quadbin';
     const urlParameters = {
       aggregationExp,
       q: sqlQuery,
       spatialDataColumn,
-      spatialDataType: 'quadbin'
+      spatialDataType
     };
     if (aggregationResLevel) {
       urlParameters.aggregationResLevel = String(aggregationResLevel);
@@ -3614,9 +3628,9 @@ const quadbinQuerySource = function (options) {
       ...result,
       widgetSource: new WidgetQuerySource({
         ...options,
-        // NOTE: passing redundant spatialDataColumn here to apply the default value 'quadbin'
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'quadbin'
+        spatialDataType
       })
     })));
   } catch (e) {
@@ -3637,11 +3651,12 @@ const quadbinTableSource = function (options) {
       tableName,
       filters
     } = options;
+    const spatialDataType = 'quadbin';
     const urlParameters = {
       aggregationExp,
       name: tableName,
       spatialDataColumn,
-      spatialDataType: 'quadbin'
+      spatialDataType
     };
     if (aggregationResLevel) {
       urlParameters.aggregationResLevel = String(aggregationResLevel);
@@ -3653,9 +3668,9 @@ const quadbinTableSource = function (options) {
       ...result,
       widgetSource: new WidgetTableSource({
         ...options,
-        // NOTE: passing redundant spatialDataColumn here to apply the default value 'quadbin'
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'quadbin'
+        spatialDataType
       })
     })));
   } catch (e) {
@@ -3704,9 +3719,10 @@ const vectorQuerySource = function (options) {
       queryParameters,
       aggregationExp
     } = options;
+    const spatialDataType = 'geo';
     const urlParameters = {
       spatialDataColumn,
-      spatialDataType: 'geo',
+      spatialDataType,
       tileResolution: tileResolution.toString(),
       q: sqlQuery
     };
@@ -3726,8 +3742,10 @@ const vectorQuerySource = function (options) {
       ...result,
       widgetSource: new WidgetQuerySource({
         ...options,
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'geo'
+        spatialDataType,
+        tileResolution
       })
     })));
   } catch (e) {
@@ -3749,10 +3767,11 @@ const vectorTableSource = function (options) {
       tileResolution = DEFAULT_TILE_RESOLUTION,
       aggregationExp
     } = options;
+    const spatialDataType = 'geo';
     const urlParameters = {
       name: tableName,
       spatialDataColumn,
-      spatialDataType: 'geo',
+      spatialDataType,
       tileResolution: tileResolution.toString()
     };
     if (columns) {
@@ -3768,8 +3787,10 @@ const vectorTableSource = function (options) {
       ...result,
       widgetSource: new WidgetTableSource({
         ...options,
+        // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType: 'geo'
+        spatialDataType,
+        tileResolution
       })
     })));
   } catch (e) {
@@ -3860,6 +3881,7 @@ exports.FEATURE_GEOM_PROPERTY = FEATURE_GEOM_PROPERTY;
 exports.SOURCE_DEFAULTS = SOURCE_DEFAULTS;
 exports.WidgetQuerySource = WidgetQuerySource;
 exports.WidgetRemoteSource = WidgetRemoteSource;
+exports.WidgetSource = WidgetSource;
 exports.WidgetTableSource = WidgetTableSource;
 exports.WidgetTilesetSource = WidgetTilesetSource;
 exports.addFilter = addFilter;