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

package/src/widget-sources/types.ts

@@ -1,4 +1,4 @@
-import {TileResolution} from '../sources/types';
+import {SpatialFilterPolyfillMode, TileResolution} from '../sources/types';
 import {
   GroupDateType,
   SortColumnType,
@@ -10,11 +10,19 @@ import {
  * WIDGET API REQUESTS
  */
 
+export interface ViewState {
+  zoom: number;
+  latitude: number;
+  longitude: number;
+}
+
 /** Common options for {@link WidgetBaseSource} requests. */
 interface BaseRequestOptions {
   spatialFilter?: SpatialFilter;
+  spatialFiltersMode?: SpatialFilterPolyfillMode;
   abortController?: AbortController;
   filterOwner?: string;
+  viewState?: ViewState;
 }
 
 /** Options for {@link WidgetBaseSource#getCategories}. */

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

@@ -16,9 +16,10 @@ import {
   TableResponse,
   TimeSeriesRequestOptions,
   TimeSeriesResponse,
+  ViewState,
 } from './types.js';
 import {FilterLogicalOperator, Filter} from '../types.js';
-import {getApplicableFilters, normalizeObjectKeys} from '../utils.js';
+import {assert, getApplicableFilters, normalizeObjectKeys} from '../utils.js';
 import {getClient} from '../client.js';
 import {ModelSource} from '../models/model.js';
 import {SourceOptions} from '../sources/index.js';
@@ -27,10 +28,11 @@ 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;
 }
@@ -51,7 +53,6 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
     clientId: getClient(),
     filters: {},
     filtersLogicalOperator: 'and',
-    geoColumn: DEFAULT_GEO_COLUMN,
   };
 
   constructor(props: Props) {
@@ -78,7 +79,9 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
       connectionName: props.connectionName,
       filters: getApplicableFilters(owner, props.filters),
       filtersLogicalOperator: props.filtersLogicalOperator,
-      geoColumn: props.geoColumn,
+      spatialDataType: props.spatialDataType,
+      spatialDataColumn: props.spatialDataColumn,
+      dataResolution: (props as Partial<AggregationOptions>).dataResolution,
     };
   }
 
@@ -93,14 +96,35 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
   async getCategories(
     options: CategoryRequestOptions
   ): Promise<CategoryResponse> {
-    const {filterOwner, spatialFilter, abortController, ...params} = options;
+    const {
+      filterOwner,
+      spatialFilter,
+      spatialFiltersMode,
+      abortController,
+      viewState,
+      ...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: {...this.getModelSource(filterOwner), spatialFilter},
+      source: {
+        ...source,
+        spatialFiltersResolution,
+        spatialFiltersMode,
+        spatialFilter,
+      },
       params: {
         column,
         operation,
@@ -125,14 +149,35 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
   async getFeatures(
     options: FeaturesRequestOptions
   ): Promise<FeaturesResponse> {
-    const {filterOwner, spatialFilter, abortController, ...params} = options;
+    const {
+      filterOwner,
+      spatialFilter,
+      spatialFiltersMode,
+      abortController,
+      viewState,
+      ...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: {...this.getModelSource(filterOwner), spatialFilter},
+      source: {
+        ...source,
+        spatialFiltersResolution,
+        spatialFiltersMode,
+        spatialFilter,
+      },
       params: {
         columns,
         dataType,
@@ -159,17 +204,33 @@ 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: {...this.getModelSource(filterOwner), spatialFilter},
+      source: {
+        ...source,
+        spatialFiltersResolution,
+        spatialFiltersMode,
+        spatialFilter,
+      },
       params: {column: column ?? '*', operation, operationExp},
       opts: {abortController},
     }).then((res: FormulaModelResponse) => normalizeObjectKeys(res.rows[0]));
@@ -186,14 +247,35 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
   async getHistogram(
     options: HistogramRequestOptions
   ): Promise<HistogramResponse> {
-    const {filterOwner, spatialFilter, abortController, ...params} = options;
+    const {
+      filterOwner,
+      spatialFilter,
+      spatialFiltersMode,
+      abortController,
+      viewState,
+      ...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: {...this.getModelSource(filterOwner), spatialFilter},
+      source: {
+        ...source,
+        spatialFiltersResolution,
+        spatialFiltersMode,
+        spatialFilter,
+      },
       params: {column, operation, ticks},
       opts: {abortController},
     }).then((res: HistogramModelResponse) => normalizeObjectKeys(res.rows));
@@ -221,14 +303,35 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
    * or rendering a range slider UI for filtering.
    */
   async getRange(options: RangeRequestOptions): Promise<RangeResponse> {
-    const {filterOwner, spatialFilter, abortController, ...params} = options;
+    const {
+      filterOwner,
+      spatialFilter,
+      spatialFiltersMode,
+      abortController,
+      viewState,
+      ...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: {...this.getModelSource(filterOwner), spatialFilter},
+      source: {
+        ...source,
+        spatialFiltersResolution,
+        spatialFiltersMode,
+        spatialFilter,
+      },
       params: {column},
       opts: {abortController},
     }).then((res: RangeModelResponse) => normalizeObjectKeys(res.rows[0]));
@@ -243,10 +346,27 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
    * values. Suitable for rendering scatter plots.
    */
   async getScatter(options: ScatterRequestOptions): Promise<ScatterResponse> {
-    const {filterOwner, spatialFilter, abortController, ...params} = options;
+    const {
+      filterOwner,
+      spatialFilter,
+      spatialFiltersMode,
+      abortController,
+      viewState,
+      ...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;
 
@@ -254,7 +374,12 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
 
     return executeModel({
       model: 'scatterplot',
-      source: {...this.getModelSource(filterOwner), spatialFilter},
+      source: {
+        ...source,
+        spatialFiltersResolution,
+        spatialFiltersMode,
+        spatialFilter,
+      },
       params: {
         xAxisColumn,
         xAxisJoinOperation,
@@ -277,8 +402,24 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
    * sorting. Suitable for displaying tables and lists.
    */
   async getTable(options: TableRequestOptions): Promise<TableResponse> {
-    const {filterOwner, spatialFilter, abortController, ...params} = options;
+    const {
+      filterOwner,
+      spatialFilter,
+      spatialFiltersMode,
+      abortController,
+      viewState,
+      ...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>[];
@@ -287,7 +428,12 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
 
     return executeModel({
       model: 'table',
-      source: {...this.getModelSource(filterOwner), spatialFilter},
+      source: {
+        ...source,
+        spatialFiltersResolution,
+        spatialFiltersMode,
+        spatialFilter,
+      },
       params: {
         column: columns,
         sortBy,
@@ -314,7 +460,14 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
   async getTimeSeries(
     options: TimeSeriesRequestOptions
   ): Promise<TimeSeriesResponse> {
-    const {filterOwner, abortController, spatialFilter, ...params} = options;
+    const {
+      filterOwner,
+      abortController,
+      spatialFilter,
+      spatialFiltersMode,
+      viewState,
+      ...params
+    } = options;
     const {
       column,
       operationColumn,
@@ -327,6 +480,16 @@ 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[]};
@@ -334,7 +497,12 @@ export abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
 
     return executeModel({
       model: 'timeseries',
-      source: {...this.getModelSource(filterOwner), spatialFilter},
+      source: {
+        ...source,
+        spatialFiltersResolution,
+        spatialFiltersMode,
+        spatialFilter,
+      },
       params: {
         column,
         stepSize,