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

package/src/widget-sources/widget-base-source.ts

@@ -16,10 +16,9 @@ import {
   TableResponse,
   TimeSeriesRequestOptions,
   TimeSeriesResponse,
-  ViewState,
 } from './types.js';
 import {FilterLogicalOperator, Filter} from '../types.js';
-import {assert, getApplicableFilters, normalizeObjectKeys} from '../utils.js';
+import {getApplicableFilters, normalizeObjectKeys} from '../utils.js';
 import {getClient} from '../client.js';
 import {ModelSource} from '../models/model.js';
 import {SourceOptions} from '../sources/index.js';
@@ -28,11 +27,10 @@ import {
   DEFAULT_GEO_COLUMN,
   DEFAULT_TILE_RESOLUTION,
 } from '../constants-internal.js';
-import {getSpatialFiltersResolution} from '../spatial-index.js';
-import {AggregationOptions} from '../sources/types.js';
 
 export interface WidgetBaseSourceProps extends Omit<SourceOptions, 'filters'> {
   apiVersion?: ApiVersion;
+  geoColumn?: string;
   filters?: Record<string, Filter>;
   filtersLogicalOperator?: FilterLogicalOperator;
 }
@@ -53,6 +51,7 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
     clientId: getClient(),
     filters: {},
     filtersLogicalOperator: 'and',
+    geoColumn: DEFAULT_GEO_COLUMN,
   };
 
   constructor(props: Props) {
@@ -79,9 +78,7 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
       connectionName: props.connectionName,
       filters: getApplicableFilters(owner, props.filters),
       filtersLogicalOperator: props.filtersLogicalOperator,
-      spatialDataType: props.spatialDataType,
-      spatialDataColumn: props.spatialDataColumn,
-      dataResolution: (props as Partial<AggregationOptions>).dataResolution,
+      geoColumn: props.geoColumn,
     };
   }
 
@@ -96,35 +93,14 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
   async getCategories(
     options: CategoryRequestOptions
   ): Promise<CategoryResponse> {
-    const {
-      filterOwner,
-      spatialFilter,
-      spatialFiltersMode,
-      abortController,
-      viewState,
-      ...params
-    } = options;
+    const {filterOwner, spatialFilter, abortController, ...params} = options;
     const {column, operation, operationColumn} = params;
-    const source = this.getModelSource(filterOwner);
-
-    let spatialFiltersResolution: number | undefined;
-    if (spatialFilter && source.spatialDataType !== 'geo') {
-      spatialFiltersResolution = getSpatialFiltersResolution({
-        source,
-        viewState,
-      });
-    }
 
     type CategoriesModelResponse = {rows: {name: string; value: number}[]};
 
     return executeModel({
       model: 'category',
-      source: {
-        ...source,
-        spatialFiltersResolution,
-        spatialFiltersMode,
-        spatialFilter,
-      },
+      source: {...this.getModelSource(filterOwner), spatialFilter},
       params: {
         column,
         operation,
@@ -149,35 +125,14 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
   async getFeatures(
     options: FeaturesRequestOptions
   ): Promise<FeaturesResponse> {
-    const {
-      filterOwner,
-      spatialFilter,
-      spatialFiltersMode,
-      abortController,
-      viewState,
-      ...params
-    } = options;
+    const {filterOwner, spatialFilter, abortController, ...params} = options;
     const {columns, dataType, featureIds, z, limit, tileResolution} = params;
-    const source = this.getModelSource(filterOwner);
-
-    let spatialFiltersResolution: number | undefined;
-    if (spatialFilter && source.spatialDataType !== 'geo') {
-      spatialFiltersResolution = getSpatialFiltersResolution({
-        source,
-        viewState,
-      });
-    }
 
     type FeaturesModelResponse = {rows: Record<string, unknown>[]};
 
     return executeModel({
       model: 'pick',
-      source: {
-        ...source,
-        spatialFiltersResolution,
-        spatialFiltersMode,
-        spatialFilter,
-      },
+      source: {...this.getModelSource(filterOwner), spatialFilter},
       params: {
         columns,
         dataType,
@@ -187,9 +142,8 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
         tileResolution: tileResolution || DEFAULT_TILE_RESOLUTION,
       },
       opts: {abortController},
-    }).then((res: FeaturesModelResponse) => ({
-      rows: normalizeObjectKeys(res.rows),
-    }));
+      // Avoid `normalizeObjectKeys()`, which changes column names.
+    }).then(({rows}: FeaturesModelResponse) => ({rows}));
   }
 
   /****************************************************************************
@@ -204,33 +158,17 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
     const {
       filterOwner,
       spatialFilter,
-      spatialFiltersMode,
       abortController,
       operationExp,
-      viewState,
       ...params
     } = options;
     const {column, operation} = params;
-    const source = this.getModelSource(filterOwner);
-
-    let spatialFiltersResolution: number | undefined;
-    if (spatialFilter && source.spatialDataType !== 'geo') {
-      spatialFiltersResolution = getSpatialFiltersResolution({
-        source,
-        viewState,
-      });
-    }
 
     type FormulaModelResponse = {rows: {value: number}[]};
 
     return executeModel({
       model: 'formula',
-      source: {
-        ...source,
-        spatialFiltersResolution,
-        spatialFiltersMode,
-        spatialFilter,
-      },
+      source: {...this.getModelSource(filterOwner), spatialFilter},
       params: {column: column ?? '*', operation, operationExp},
       opts: {abortController},
     }).then((res: FormulaModelResponse) => normalizeObjectKeys(res.rows[0]));
@@ -247,35 +185,14 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
   async getHistogram(
     options: HistogramRequestOptions
   ): Promise<HistogramResponse> {
-    const {
-      filterOwner,
-      spatialFilter,
-      spatialFiltersMode,
-      abortController,
-      viewState,
-      ...params
-    } = options;
+    const {filterOwner, spatialFilter, abortController, ...params} = options;
     const {column, operation, ticks} = params;
-    const source = this.getModelSource(filterOwner);
-
-    let spatialFiltersResolution: number | undefined;
-    if (spatialFilter && source.spatialDataType !== 'geo') {
-      spatialFiltersResolution = getSpatialFiltersResolution({
-        source,
-        viewState,
-      });
-    }
 
     type HistogramModelResponse = {rows: {tick: number; value: number}[]};
 
     const data = await executeModel({
       model: 'histogram',
-      source: {
-        ...source,
-        spatialFiltersResolution,
-        spatialFiltersMode,
-        spatialFilter,
-      },
+      source: {...this.getModelSource(filterOwner), spatialFilter},
       params: {column, operation, ticks},
       opts: {abortController},
     }).then((res: HistogramModelResponse) => normalizeObjectKeys(res.rows));
@@ -303,35 +220,14 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
    * or rendering a range slider UI for filtering.
    */
   async getRange(options: RangeRequestOptions): Promise<RangeResponse> {
-    const {
-      filterOwner,
-      spatialFilter,
-      spatialFiltersMode,
-      abortController,
-      viewState,
-      ...params
-    } = options;
+    const {filterOwner, spatialFilter, abortController, ...params} = options;
     const {column} = params;
-    const source = this.getModelSource(filterOwner);
-
-    let spatialFiltersResolution: number | undefined;
-    if (spatialFilter && source.spatialDataType !== 'geo') {
-      spatialFiltersResolution = getSpatialFiltersResolution({
-        source,
-        viewState,
-      });
-    }
 
     type RangeModelResponse = {rows: {min: number; max: number}[]};
 
     return executeModel({
       model: 'range',
-      source: {
-        ...source,
-        spatialFiltersResolution,
-        spatialFiltersMode,
-        spatialFilter,
-      },
+      source: {...this.getModelSource(filterOwner), spatialFilter},
       params: {column},
       opts: {abortController},
     }).then((res: RangeModelResponse) => normalizeObjectKeys(res.rows[0]));
@@ -346,27 +242,10 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
    * values. Suitable for rendering scatter plots.
    */
   async getScatter(options: ScatterRequestOptions): Promise<ScatterResponse> {
-    const {
-      filterOwner,
-      spatialFilter,
-      spatialFiltersMode,
-      abortController,
-      viewState,
-      ...params
-    } = options;
+    const {filterOwner, spatialFilter, abortController, ...params} = options;
     const {xAxisColumn, xAxisJoinOperation, yAxisColumn, yAxisJoinOperation} =
       params;
 
-    const source = this.getModelSource(filterOwner);
-
-    let spatialFiltersResolution: number | undefined;
-    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;
 
@@ -374,12 +253,7 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
 
     return executeModel({
       model: 'scatterplot',
-      source: {
-        ...source,
-        spatialFiltersResolution,
-        spatialFiltersMode,
-        spatialFilter,
-      },
+      source: {...this.getModelSource(filterOwner), spatialFilter},
       params: {
         xAxisColumn,
         xAxisJoinOperation,
@@ -402,24 +276,8 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
    * sorting. Suitable for displaying tables and lists.
    */
   async getTable(options: TableRequestOptions): Promise<TableResponse> {
-    const {
-      filterOwner,
-      spatialFilter,
-      spatialFiltersMode,
-      abortController,
-      viewState,
-      ...params
-    } = options;
+    const {filterOwner, spatialFilter, abortController, ...params} = options;
     const {columns, sortBy, sortDirection, offset = 0, limit = 10} = params;
-    const source = this.getModelSource(filterOwner);
-
-    let spatialFiltersResolution: number | undefined;
-    if (spatialFilter && source.spatialDataType !== 'geo') {
-      spatialFiltersResolution = getSpatialFiltersResolution({
-        source,
-        viewState,
-      });
-    }
 
     type TableModelResponse = {
       rows: Record<string, number | string>[];
@@ -428,12 +286,7 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
 
     return executeModel({
       model: 'table',
-      source: {
-        ...source,
-        spatialFiltersResolution,
-        spatialFiltersMode,
-        spatialFilter,
-      },
+      source: {...this.getModelSource(filterOwner), spatialFilter},
       params: {
         column: columns,
         sortBy,
@@ -460,14 +313,7 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
   async getTimeSeries(
     options: TimeSeriesRequestOptions
   ): Promise<TimeSeriesResponse> {
-    const {
-      filterOwner,
-      abortController,
-      spatialFilter,
-      spatialFiltersMode,
-      viewState,
-      ...params
-    } = options;
+    const {filterOwner, abortController, spatialFilter, ...params} = options;
     const {
       column,
       operationColumn,
@@ -480,16 +326,6 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
       splitByCategoryValues,
     } = params;
 
-    const source = this.getModelSource(filterOwner);
-
-    let spatialFiltersResolution: number | undefined;
-    if (spatialFilter && source.spatialDataType !== 'geo') {
-      spatialFiltersResolution = getSpatialFiltersResolution({
-        source,
-        viewState,
-      });
-    }
-
     type TimeSeriesModelResponse = {
       rows: {name: string; value: number}[];
       metadata: {categories: string[]};
@@ -497,12 +333,7 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
 
     return executeModel({
       model: 'timeseries',
-      source: {
-        ...source,
-        spatialFiltersResolution,
-        spatialFiltersMode,
-        spatialFilter,
-      },
+      source: {...this.getModelSource(filterOwner), spatialFilter},
       params: {
         column,
         stepSize,

package/build/spatial-index.d.ts

@@ -1,11 +0,0 @@
-import type { ModelSource } from './models/model';
-import type { AggregationOptions } from './sources/types';
-import type { ViewState } from './widget-sources';
-export declare function getSpatialFiltersResolution({ source, viewState, }: {
-    source: Partial<ModelSource & AggregationOptions>;
-    viewState?: ViewState;
-}): number | undefined;
-export declare function getHexagonResolution(viewport: {
-    zoom: number;
-    latitude: number;
-}, tileSize: number): number;

package/src/spatial-index.ts

@@ -1,119 +0,0 @@
-import {
-  DEFAULT_AGGREGATION_RES_LEVEL_H3,
-  DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN,
-} from './constants-internal';
-import type {ModelSource} from './models/model';
-import type {AggregationOptions} from './sources/types';
-import {assert} from './utils';
-import type {ViewState} from './widget-sources';
-
-const DEFAULT_TILE_SIZE = 512;
-const QUADBIN_ZOOM_MAX_OFFSET = 4;
-
-export function getSpatialFiltersResolution({
-  source,
-  viewState,
-}: {
-  source: Partial<ModelSource & AggregationOptions>;
-  viewState?: ViewState;
-}) {
-  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.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(
-        ([zoom]) => 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
-export function getHexagonResolution(
-  viewport: {zoom: number; latitude: number},
-  tileSize: number
-): number {
-  // 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)
-  );
-}