@carto/api-client 0.4.2 → 0.4.4

package/src/sources/h3-table-source.ts

@@ -29,9 +29,11 @@ type UrlParameters = {
   filters?: Record<string, unknown>;
 };
 
+export type H3TableSourceResponse = TilejsonResult & WidgetTableSourceResult;
+
 export const h3TableSource = async function (
   options: H3TableSourceOptions
-): Promise<TilejsonResult & WidgetTableSourceResult> {
+): Promise<H3TableSourceResponse> {
   const {
     aggregationExp,
     aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_H3,
@@ -55,7 +57,12 @@ export const h3TableSource = async function (
   return baseSource<UrlParameters>('table', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetTableSource(options),
+      widgetSource: new WidgetTableSource({
+        ...options,
+        // NOTE: passing redundant spatialDataColumn here to apply the default value 'h3'
+        spatialDataColumn,
+        spatialDataType: 'h3',
+      }),
     })
   );
 };

package/src/sources/h3-tileset-source.ts

@@ -12,9 +12,11 @@ import type {
 export type H3TilesetSourceOptions = SourceOptions & TilesetSourceOptions;
 type UrlParameters = {name: string};
 
+export type H3TilesetSourceResponse = TilejsonResult;
+
 export const h3TilesetSource = async function (
   options: H3TilesetSourceOptions
-): Promise<TilejsonResult> {
+): Promise<H3TilesetSourceResponse> {
   const {tableName} = options;
   const urlParameters: UrlParameters = {name: tableName};
 
@@ -22,5 +24,5 @@ export const h3TilesetSource = async function (
     'tileset',
     options,
     urlParameters
-  ) as Promise<TilejsonResult>;
+  ) as Promise<H3TilesetSourceResponse>;
 };

package/src/sources/index.ts

@@ -4,56 +4,86 @@
 
 export {SOURCE_DEFAULTS} from './base-source';
 export type {
-  VectorLayer,
-  RasterMetadataBandStats,
-  RasterBandColorinterp,
-  RasterMetadataBand,
-  RasterMetadata,
-  TilejsonResult,
   GeojsonResult,
   JsonResult,
   QueryResult,
+  QuerySourceOptions,
+  RasterBandColorinterp,
+  RasterMetadata,
+  RasterMetadataBand,
+  RasterMetadataBandStats,
+  SourceOptions,
+  TableSourceOptions,
+  TilejsonResult,
+  TilesetSourceOptions,
+  VectorLayer,
 } from './types';
 
 export {boundaryQuerySource} from './boundary-query-source';
-export type {BoundaryQuerySourceOptions} from './boundary-query-source';
+export type {
+  BoundaryQuerySourceOptions,
+  BoundaryQuerySourceResponse,
+} from './boundary-query-source';
 
 export {boundaryTableSource} from './boundary-table-source';
-export type {BoundaryTableSourceOptions} from './boundary-table-source';
+export type {
+  BoundaryTableSourceOptions,
+  BoundaryTableSourceResponse,
+} from './boundary-table-source';
 
 export {h3QuerySource} from './h3-query-source';
-export type {H3QuerySourceOptions} from './h3-query-source';
+export type {
+  H3QuerySourceOptions,
+  H3QuerySourceResponse,
+} from './h3-query-source';
 
 export {h3TableSource} from './h3-table-source';
-export type {H3TableSourceOptions} from './h3-table-source';
+export type {
+  H3TableSourceOptions,
+  H3TableSourceResponse,
+} from './h3-table-source';
 
 export {h3TilesetSource} from './h3-tileset-source';
-export type {H3TilesetSourceOptions} from './h3-tileset-source';
+export type {
+  H3TilesetSourceOptions,
+  H3TilesetSourceResponse,
+} from './h3-tileset-source';
 
 export {rasterSource} from './raster-source';
-export type {RasterSourceOptions} from './raster-source';
+export type {RasterSourceOptions, RasterSourceResponse} from './raster-source';
 
 export {quadbinQuerySource} from './quadbin-query-source';
-export type {QuadbinQuerySourceOptions} from './quadbin-query-source';
+export type {
+  QuadbinQuerySourceOptions,
+  QuadbinQuerySourceResponse,
+} from './quadbin-query-source';
 
 export {quadbinTableSource} from './quadbin-table-source';
-export type {QuadbinTableSourceOptions} from './quadbin-table-source';
+export type {
+  QuadbinTableSourceOptions,
+  QuadbinTableSourceResponse,
+} from './quadbin-table-source';
 
 export {quadbinTilesetSource} from './quadbin-tileset-source';
-export type {QuadbinTilesetSourceOptions} from './quadbin-tileset-source';
+export type {
+  QuadbinTilesetSourceOptions,
+  QuadbinTilesetSourceResponse,
+} from './quadbin-tileset-source';
 
 export {vectorQuerySource} from './vector-query-source';
-export type {VectorQuerySourceOptions} from './vector-query-source';
+export type {
+  VectorQuerySourceOptions,
+  VectorQuerySourceResponse,
+} from './vector-query-source';
 
 export {vectorTableSource} from './vector-table-source';
-export type {VectorTableSourceOptions} from './vector-table-source';
+export type {
+  VectorTableSourceOptions,
+  VectorTableSourceResponse,
+} from './vector-table-source';
 
 export {vectorTilesetSource} from './vector-tileset-source';
-export type {VectorTilesetSourceOptions} from './vector-tileset-source';
-
 export type {
-  SourceOptions,
-  QuerySourceOptions,
-  TableSourceOptions,
-  TilesetSourceOptions,
-} from './types';
+  VectorTilesetSourceOptions,
+  VectorTilesetSourceResponse,
+} from './vector-tileset-source';

package/src/sources/quadbin-query-source.ts

@@ -30,9 +30,12 @@ type UrlParameters = {
   filters?: Record<string, unknown>;
 };
 
+export type QuadbinQuerySourceResponse = TilejsonResult &
+  WidgetQuerySourceResult;
+
 export const quadbinQuerySource = async function (
   options: QuadbinQuerySourceOptions
-): Promise<TilejsonResult & WidgetQuerySourceResult> {
+): Promise<QuadbinQuerySourceResponse> {
   const {
     aggregationExp,
     aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN,
@@ -60,7 +63,12 @@ export const quadbinQuerySource = async function (
   return baseSource<UrlParameters>('query', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetQuerySource(options),
+      widgetSource: new WidgetQuerySource({
+        ...options,
+        // NOTE: passing redundant spatialDataColumn here to apply the default value 'quadbin'
+        spatialDataColumn,
+        spatialDataType: 'quadbin',
+      }),
     })
   );
 };

package/src/sources/quadbin-table-source.ts

@@ -29,9 +29,12 @@ type UrlParameters = {
   filters?: Record<string, unknown>;
 };
 
+export type QuadbinTableSourceResponse = TilejsonResult &
+  WidgetTableSourceResult;
+
 export const quadbinTableSource = async function (
   options: QuadbinTableSourceOptions
-): Promise<TilejsonResult & WidgetTableSourceResult> {
+): Promise<QuadbinTableSourceResponse> {
   const {
     aggregationExp,
     aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN,
@@ -56,7 +59,12 @@ export const quadbinTableSource = async function (
   return baseSource<UrlParameters>('table', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetTableSource(options),
+      widgetSource: new WidgetTableSource({
+        ...options,
+        // NOTE: passing redundant spatialDataColumn here to apply the default value 'quadbin'
+        spatialDataColumn,
+        spatialDataType: 'quadbin',
+      }),
     })
   );
 };

package/src/sources/quadbin-tileset-source.ts

@@ -12,9 +12,11 @@ import type {
 export type QuadbinTilesetSourceOptions = SourceOptions & TilesetSourceOptions;
 type UrlParameters = {name: string};
 
+export type QuadbinTilesetSourceResponse = TilejsonResult;
+
 export const quadbinTilesetSource = async function (
   options: QuadbinTilesetSourceOptions
-): Promise<TilejsonResult> {
+): Promise<QuadbinTilesetSourceResponse> {
   const {tableName} = options;
   const urlParameters: UrlParameters = {name: tableName};
 
@@ -22,5 +24,5 @@ export const quadbinTilesetSource = async function (
     'tileset',
     options,
     urlParameters
-  ) as Promise<TilejsonResult>;
+  ) as Promise<QuadbinTilesetSourceResponse>;
 };

package/src/sources/raster-source.ts

@@ -18,9 +18,11 @@ type UrlParameters = {
   filters?: Record<string, unknown>;
 };
 
+export type RasterSourceResponse = TilejsonResult;
+
 export const rasterSource = async function (
   options: RasterSourceOptions
-): Promise<TilejsonResult> {
+): Promise<RasterSourceResponse> {
   const {tableName, filters} = options;
   const urlParameters: UrlParameters = {name: tableName};
   if (filters) {
@@ -30,5 +32,5 @@ export const rasterSource = async function (
     'raster',
     options,
     urlParameters
-  ) as Promise<TilejsonResult>;
+  ) as Promise<RasterSourceResponse>;
 };

package/src/sources/types.ts

@@ -48,6 +48,33 @@ export type SourceOptionalOptions = {
    */
   maxLengthURL?: number;
 
+  /**
+   * The column name and the type of geospatial support.
+   *
+   * If not present, defaults to `'geom'` for generic queries, `'quadbin'` for Quadbin sources and `'h3'` for H3 sources.
+   */
+  spatialDataColumn?: string;
+
+  /**
+   * The type of geospatial support. Defaults to `'geo'`.
+   */
+  spatialDataType?: SpatialDataType;
+
+  /**
+   * Relative resolution of a tile. Higher values increase density and data size. At `tileResolution = 1`, tile geometry is
+   * quantized to a 1024x1024 grid. Increasing or decreasing the resolution will increase or decrease the dimensions of
+   * the quantization grid proportionately.
+   *
+   * Supported `tileResolution` values, with corresponding grid sizes:
+   *
+   * - 0.25: 256x256
+   * - 0.5: 512x512
+   * - 1: 1024x1024
+   * - 2: 2048x2048
+   * - 4: 4096x4096
+   */
+  tileResolution?: TileResolution;
+
   /**
    * By default, local in-memory caching is enabled.
    */
@@ -89,6 +116,11 @@ export type AggregationOptions = {
    * @default 6 for quadbin and 4 for h3 sources
    */
   aggregationResLevel?: number;
+
+  /**
+   * Original resolution of the spatial index data as stored in the DW
+   */
+  dataResolution?: number;
 };
 
 export type FilterOptions = {
@@ -99,31 +131,9 @@ export type FilterOptions = {
 };
 
 export type QuerySourceOptions = {
-  /**
-   * The column name and the type of geospatial support.
-   *
-   * If not present, defaults to `'geom'` for generic queries, `'quadbin'` for Quadbin sources and `'h3'` for H3 sources.
-   */
-  spatialDataColumn?: string;
-
-  /** SQL query. */
+  /** Full SQL query with query paremeter placeholders (if any). */
   sqlQuery: string;
 
-  /**
-   * Relative resolution of a tile. Higher values increase density and data size. At `tileResolution = 1`, tile geometry is
-   * quantized to a 1024x1024 grid. Increasing or decreasing the resolution will increase or decrease the dimensions of
-   * the quantization grid proportionately.
-   *
-   * Supported `tileResolution` values, with corresponding grid sizes:
-   *
-   * - 0.25: 256x256
-   * - 0.5: 512x512
-   * - 1: 1024x1024
-   * - 2: 2048x2048
-   * - 4: 4096x4096
-   */
-  tileResolution?: TileResolution;
-
   /**
    * Values for named or positional paramteres in the query.
    *
@@ -149,6 +159,15 @@ export type QuerySourceOptions = {
    *     ```
    */
   queryParameters?: QueryParameters;
+
+  /**
+   * Comma-separated aggregation expressions. If assigned on a vector source, source is grouped by geometry and then aggregated.
+   *
+   * Example:
+   *
+   *     1 as value, avg(rev) as average_revenue
+   */
+  aggregationExp?: string;
 };
 
 export type TableSourceOptions = {
@@ -158,26 +177,13 @@ export type TableSourceOptions = {
   tableName: string;
 
   /**
-   * The column name and the type of geospatial support.
-   *
-   * If not present, defaults to `'geom'` for generic tables, `'quadbin'` for Quadbin sources and `'h3'` for H3 sources.
-   */
-  spatialDataColumn?: string;
-
-  /**
-   * Relative resolution of a tile. Higher values increase density and data size. At `tileResolution = 1`, tile geometry is
-   * quantized to a 1024x1024 grid. Increasing or decreasing the resolution will increase or decrease the dimensions of
-   * the quantization grid proportionately.
+   * Comma-separated aggregation expressions. If assigned on a vector source, source is grouped by geometry and then aggregated.
    *
-   * Supported `tileResolution` values, with corresponding grid sizes:
+   * Example:
    *
-   * - 0.25: 256x256
-   * - 0.5: 512x512
-   * - 1: 1024x1024
-   * - 2: 2048x2048
-   * - 4: 4096x4096
+   *     1 as value, avg(rev) as average_revenue
    */
-  tileResolution?: TileResolution;
+  aggregationExp?: string;
 };
 
 export type TilesetSourceOptions = {
@@ -198,6 +204,14 @@ export type ColumnsOption = {
 
 export type SpatialDataType = 'geo' | 'h3' | 'quadbin';
 
+/**
+ * Strategy used for covering spatial filter geometry with spatial indexes.
+ * See https://docs.carto.com/data-and-analysis/analytics-toolbox-for-bigquery/sql-reference/quadbin#quadbin_polyfill_mode
+ * or https://docs.carto.com/data-and-analysis/analytics-toolbox-for-bigquery/sql-reference/h3#h3_polyfill_mode for more information.
+ * @internalRemarks Source: cloud-native maps-api
+ * */
+export type SpatialFilterPolyfillMode = 'center' | 'intersects' | 'contains';
+
 export type TilejsonMapInstantiation = MapInstantiation & {
   tilejson: {url: string[]};
 };

package/src/sources/vector-query-source.ts

@@ -31,11 +31,15 @@ type UrlParameters = {
   tileResolution?: string;
   q: string;
   queryParameters?: Record<string, unknown> | unknown[];
+  aggregationExp?: string;
 };
 
+export type VectorQuerySourceResponse = TilejsonResult &
+  WidgetQuerySourceResult;
+
 export const vectorQuerySource = async function (
   options: VectorQuerySourceOptions
-): Promise<TilejsonResult & WidgetQuerySourceResult> {
+): Promise<VectorQuerySourceResponse> {
   const {
     columns,
     filters,
@@ -43,6 +47,7 @@ export const vectorQuerySource = async function (
     sqlQuery,
     tileResolution = DEFAULT_TILE_RESOLUTION,
     queryParameters,
+    aggregationExp,
   } = options;
 
   const urlParameters: UrlParameters = {
@@ -61,10 +66,16 @@ export const vectorQuerySource = async function (
   if (queryParameters) {
     urlParameters.queryParameters = queryParameters;
   }
+  if (aggregationExp) {
+    urlParameters.aggregationExp = aggregationExp;
+  }
   return baseSource<UrlParameters>('query', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetQuerySource(options),
+      widgetSource: new WidgetQuerySource({
+        ...options,
+        spatialDataType: 'geo',
+      }),
     })
   );
 };

package/src/sources/vector-table-source.ts

@@ -22,6 +22,7 @@ export type VectorTableSourceOptions = SourceOptions &
   TableSourceOptions &
   FilterOptions &
   ColumnsOption;
+
 type UrlParameters = {
   columns?: string;
   filters?: Record<string, unknown>;
@@ -29,17 +30,22 @@ type UrlParameters = {
   spatialDataColumn?: string;
   tileResolution?: string;
   name: string;
+  aggregationExp?: string;
 };
 
+export type VectorTableSourceResponse = TilejsonResult &
+  WidgetTableSourceResult;
+
 export const vectorTableSource = async function (
   options: VectorTableSourceOptions
-): Promise<TilejsonResult & WidgetTableSourceResult> {
+): Promise<VectorTableSourceResponse> {
   const {
     columns,
     filters,
     spatialDataColumn = 'geom',
     tableName,
     tileResolution = DEFAULT_TILE_RESOLUTION,
+    aggregationExp,
   } = options;
 
   const urlParameters: UrlParameters = {
@@ -55,10 +61,16 @@ export const vectorTableSource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
+  if (aggregationExp) {
+    urlParameters.aggregationExp = aggregationExp;
+  }
   return baseSource<UrlParameters>('table', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetTableSource(options),
+      widgetSource: new WidgetTableSource({
+        ...options,
+        spatialDataType: 'geo',
+      }),
     })
   );
 };

package/src/sources/vector-tileset-source.ts

@@ -12,9 +12,11 @@ import type {
 export type VectorTilesetSourceOptions = SourceOptions & TilesetSourceOptions;
 type UrlParameters = {name: string};
 
+export type VectorTilesetSourceResponse = TilejsonResult;
+
 export const vectorTilesetSource = async function (
   options: VectorTilesetSourceOptions
-): Promise<TilejsonResult> {
+): Promise<VectorTilesetSourceResponse> {
   const {tableName} = options;
   const urlParameters: UrlParameters = {name: tableName};
 
@@ -22,5 +24,5 @@ export const vectorTilesetSource = async function (
     'tileset',
     options,
     urlParameters
-  ) as Promise<TilejsonResult>;
+  ) as Promise<VectorTilesetSourceResponse>;
 };

package/src/spatial-index.ts

@@ -0,0 +1,111 @@
+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: Partial<ModelSource & AggregationOptions>,
+  viewState: ViewState
+): number | undefined {
+  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)
+  );
+}

package/src/utils.ts

@@ -57,7 +57,7 @@ export function normalizeObjectKeys<T, R extends Row<T>>(el: R): R {
 }
 
 /** @internalRemarks Source: @carto/react-core */
-export function assert(condition: unknown, message: string) {
+export function assert(condition: unknown, message: string): asserts condition {
   if (!condition) {
     throw new Error(message);
   }

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,9 +10,18 @@ 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;
+  /** Required for table- and query-based spatial index sources (H3, Quadbin). */
+  spatialIndexReferenceViewState?: ViewState;
   abortController?: AbortController;
   filterOwner?: string;
 }