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

package/build/api-client.modern.js

@@ -764,6 +764,91 @@ 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
+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 = _extends({}, 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: ApiVersion.V3,
+  apiBaseUrl: DEFAULT_API_BASE_URL,
+  clientId: getClient(),
+  filters: {},
+  filtersLogicalOperator: 'and'
+};
+
 /**
  * Return more descriptive error from API
  * @internalRemarks Source: @carto/react-api
@@ -928,91 +1013,6 @@ function objectToURLSearchParams(object) {
   return params;
 }
 
-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
-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 = _extends({}, 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: ApiVersion.V3,
-  apiBaseUrl: DEFAULT_API_BASE_URL,
-  clientId: getClient(),
-  filters: {},
-  filtersLogicalOperator: 'and'
-};
-
 const _excluded$1 = ["filterOwner", "spatialFilter", "spatialFiltersMode", "spatialIndexReferenceViewState", "abortController"],
   _excluded2 = ["filterOwner", "spatialFilter", "spatialFiltersMode", "spatialIndexReferenceViewState", "abortController"],
   _excluded3 = ["filterOwner", "spatialFilter", "spatialFiltersMode", "spatialIndexReferenceViewState", "abortController", "operationExp"],
@@ -2998,6 +2998,7 @@ const _excluded = ["filterOwner", "spatialFilter", "abortController"];
 class WidgetTilesetSource extends WidgetSource {
   constructor(...args) {
     super(...args);
+    this._tiles = [];
     this._features = [];
   }
   getModelSource(owner) {
@@ -3006,15 +3007,25 @@ class WidgetTilesetSource extends WidgetSource {
       data: this.props.tableName
     });
   }
-  /** Loads features as a list of tiles (typically provided by deck.gl). */
-  loadTiles({
-    tiles,
+  /**
+   * 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({
     spatialFilter,
     uniqueIdProperty,
     options
   }) {
     this._features = tileFeatures({
-      tiles,
+      tiles: this._tiles,
       options,
       spatialFilter,
       uniqueIdProperty,
@@ -3251,10 +3262,11 @@ const h3QuerySource = async function h3QuerySource(options) {
     queryParameters,
     filters
   } = options;
+  const spatialDataType = 'h3';
   const urlParameters = {
     aggregationExp,
     spatialDataColumn,
-    spatialDataType: 'h3',
+    spatialDataType,
     q: sqlQuery
   };
   if (aggregationResLevel) {
@@ -3268,9 +3280,9 @@ const h3QuerySource = async function h3QuerySource(options) {
   }
   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'
+      // NOTE: Parameters with default values above must be explicitly passed here.
       spatialDataColumn,
-      spatialDataType: 'h3'
+      spatialDataType
     }))
   }));
 };
@@ -3283,11 +3295,12 @@ const h3TableSource = async function h3TableSource(options) {
     tableName,
     filters
   } = options;
+  const spatialDataType = 'h3';
   const urlParameters = {
     aggregationExp,
     name: tableName,
     spatialDataColumn,
-    spatialDataType: 'h3'
+    spatialDataType
   };
   if (aggregationResLevel) {
     urlParameters.aggregationResLevel = String(aggregationResLevel);
@@ -3297,9 +3310,9 @@ const h3TableSource = async function h3TableSource(options) {
   }
   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'
+      // NOTE: Parameters with default values above must be explicitly passed here.
       spatialDataColumn,
-      spatialDataType: 'h3'
+      spatialDataType
     }))
   }));
 };
@@ -3352,11 +3365,12 @@ const quadbinQuerySource = async function quadbinQuerySource(options) {
     queryParameters,
     filters
   } = options;
+  const spatialDataType = 'quadbin';
   const urlParameters = {
     aggregationExp,
     q: sqlQuery,
     spatialDataColumn,
-    spatialDataType: 'quadbin'
+    spatialDataType
   };
   if (aggregationResLevel) {
     urlParameters.aggregationResLevel = String(aggregationResLevel);
@@ -3369,9 +3383,9 @@ const quadbinQuerySource = async function quadbinQuerySource(options) {
   }
   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'
+      // NOTE: Parameters with default values above must be explicitly passed here.
       spatialDataColumn,
-      spatialDataType: 'quadbin'
+      spatialDataType
     }))
   }));
 };
@@ -3384,11 +3398,12 @@ const quadbinTableSource = async function quadbinTableSource(options) {
     tableName,
     filters
   } = options;
+  const spatialDataType = 'quadbin';
   const urlParameters = {
     aggregationExp,
     name: tableName,
     spatialDataColumn,
-    spatialDataType: 'quadbin'
+    spatialDataType
   };
   if (aggregationResLevel) {
     urlParameters.aggregationResLevel = String(aggregationResLevel);
@@ -3398,9 +3413,9 @@ const quadbinTableSource = async function quadbinTableSource(options) {
   }
   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'
+      // NOTE: Parameters with default values above must be explicitly passed here.
       spatialDataColumn,
-      spatialDataType: 'quadbin'
+      spatialDataType
     }))
   }));
 };
@@ -3432,9 +3447,10 @@ const vectorQuerySource = async function vectorQuerySource(options) {
     queryParameters,
     aggregationExp
   } = options;
+  const spatialDataType = 'geo';
   const urlParameters = {
     spatialDataColumn,
-    spatialDataType: 'geo',
+    spatialDataType,
     tileResolution: tileResolution.toString(),
     q: sqlQuery
   };
@@ -3452,8 +3468,10 @@ const vectorQuerySource = async function vectorQuerySource(options) {
   }
   return baseSource('query', options, urlParameters).then(result => _extends({}, result, {
     widgetSource: new WidgetQuerySource(_extends({}, options, {
+      // NOTE: Parameters with default values above must be explicitly passed here.
       spatialDataColumn,
-      spatialDataType: 'geo'
+      spatialDataType,
+      tileResolution
     }))
   }));
 };
@@ -3467,10 +3485,11 @@ const vectorTableSource = async function vectorTableSource(options) {
     tileResolution = DEFAULT_TILE_RESOLUTION,
     aggregationExp
   } = options;
+  const spatialDataType = 'geo';
   const urlParameters = {
     name: tableName,
     spatialDataColumn,
-    spatialDataType: 'geo',
+    spatialDataType,
     tileResolution: tileResolution.toString()
   };
   if (columns) {
@@ -3484,8 +3503,10 @@ const vectorTableSource = async function vectorTableSource(options) {
   }
   return baseSource('table', options, urlParameters).then(result => _extends({}, result, {
     widgetSource: new WidgetTableSource(_extends({}, options, {
+      // NOTE: Parameters with default values above must be explicitly passed here.
       spatialDataColumn,
-      spatialDataType: 'geo'
+      spatialDataType,
+      tileResolution
     }))
   }));
 };
@@ -3549,5 +3570,5 @@ const query = async function query(options) {
   });
 };
 
-export { ApiVersion, CartoAPIError, DEFAULT_API_BASE_URL, FEATURE_GEOM_PROPERTY, FilterType, Provider, SOURCE_DEFAULTS, SpatialIndex, TileFormat, WidgetQuerySource, WidgetRemoteSource, WidgetTableSource, WidgetTilesetSource, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildFeatureFilter, buildPublicMapUrl, buildStatsUrl, clearFilters, createPolygonSpatialFilter, createViewportSpatialFilter, filterFunctions, geojsonFeatures, getClient, 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 };
+export { ApiVersion, CartoAPIError, DEFAULT_API_BASE_URL, FEATURE_GEOM_PROPERTY, FilterType, Provider, SOURCE_DEFAULTS, SpatialIndex, TileFormat, WidgetQuerySource, WidgetRemoteSource, WidgetSource, WidgetTableSource, WidgetTilesetSource, addFilter, aggregate, aggregationFunctions, applyFilters, applySorting, boundaryQuerySource, boundaryTableSource, buildBinaryFeatureFilter, buildFeatureFilter, buildPublicMapUrl, buildStatsUrl, clearFilters, createPolygonSpatialFilter, createViewportSpatialFilter, filterFunctions, geojsonFeatures, getClient, 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