@carto/api-client 0.4.3 → 0.4.5-alpha.0

package/build/models/model.d.ts

@@ -1,6 +1,7 @@
 import { Filter, FilterLogicalOperator, MapType, QueryParameters, SpatialFilter } from '../types.js';
 import { ModelRequestOptions } from './common.js';
 import { ApiVersion } from '../constants.js';
+import { SpatialDataType, SpatialFilterPolyfillMode } from '../sources/types.js';
 /** @internalRemarks Source: @carto/react-api */
 declare const AVAILABLE_MODELS: readonly ["category", "histogram", "formula", "pick", "timeseries", "range", "scatterplot", "table"];
 export type Model = (typeof AVAILABLE_MODELS)[number];
@@ -14,9 +15,14 @@ export interface ModelSource {
     data: string;
     filters?: Record<string, Filter>;
     filtersLogicalOperator?: FilterLogicalOperator;
-    geoColumn?: string;
     spatialFilter?: SpatialFilter;
     queryParameters?: QueryParameters;
+    spatialDataColumn?: string;
+    spatialDataType?: SpatialDataType;
+    spatialFiltersResolution?: number;
+    spatialFiltersMode?: SpatialFilterPolyfillMode;
+    /** original resolution of the spatial index data as stored in the DW */
+    dataResolution?: number;
 }
 /**
  * Execute a SQL model request.

package/build/sources/types.d.ts

@@ -38,6 +38,30 @@ export type SourceOptionalOptions = {
      * @default {@link DEFAULT_MAX_LENGTH_URL}
      */
     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.
      */
@@ -73,6 +97,10 @@ 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 = {
     /**
@@ -81,28 +109,8 @@ export type FilterOptions = {
     filters?: Filters;
 };
 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.
      *
@@ -142,26 +150,6 @@ export type TableSourceOptions = {
      * Fully qualified name of table.
      */
     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.
-     *
-     * Supported `tileResolution` values, with corresponding grid sizes:
-     *
-     * - 0.25: 256x256
-     * - 0.5: 512x512
-     * - 1: 1024x1024
-     * - 2: 2048x2048
-     * - 4: 4096x4096
-     */
-    tileResolution?: TileResolution;
     /**
      * Comma-separated aggregation expressions. If assigned on a vector source, source is grouped by geometry and then aggregated.
      *
@@ -186,6 +174,13 @@ export type ColumnsOption = {
     columns?: string[];
 };
 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/build/spatial-index.d.ts

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

package/build/utils.d.ts

@@ -14,7 +14,7 @@ type Row<T> = Record<string, T> | Record<string, T>[] | T[] | T;
  */
 export declare function normalizeObjectKeys<T, R extends Row<T>>(el: R): R;
 /** @internalRemarks Source: @carto/react-core */
-export declare function assert(condition: unknown, message: string): void;
+export declare function assert(condition: unknown, message: string): asserts condition;
 /**
  * @internalRemarks Source: @carto/react-core
  * @internal

package/build/widget-sources/types.d.ts

@@ -1,11 +1,19 @@
-import { TileResolution } from '../sources/types';
+import { SpatialFilterPolyfillMode, TileResolution } from '../sources/types';
 import { GroupDateType, SortColumnType, SortDirection, SpatialFilter } from '../types';
 /******************************************************************************
  * 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;
 }

package/build/widget-sources/widget-base-source.d.ts

@@ -1,11 +1,10 @@
-import { CategoryRequestOptions, CategoryResponse, FeaturesRequestOptions, FeaturesResponse, FormulaRequestOptions, FormulaResponse, HistogramRequestOptions, HistogramResponse, RangeRequestOptions, RangeResponse, ScatterRequestOptions, ScatterResponse, TableRequestOptions, TableResponse, TimeSeriesRequestOptions, TimeSeriesResponse } from './types.js';
-import { FilterLogicalOperator, Filter } from '../types.js';
+import { CategoryRequestOptions, CategoryResponse, FeaturesRequestOptions, FeaturesResponse, FormulaRequestOptions, FormulaResponse, HistogramRequestOptions, HistogramResponse, RangeRequestOptions, RangeResponse, ScatterRequestOptions, ScatterResponse, TableRequestOptions, TableResponse, TimeSeriesRequestOptions, TimeSeriesResponse, ViewState } from './types.js';
+import { FilterLogicalOperator, Filter, SpatialFilter } from '../types.js';
 import { ModelSource } from '../models/model.js';
 import { SourceOptions } from '../sources/index.js';
 import { ApiVersion } from '../constants.js';
 export interface WidgetBaseSourceProps extends Omit<SourceOptions, 'filters'> {
     apiVersion?: ApiVersion;
-    geoColumn?: string;
     filters?: Record<string, Filter>;
     filtersLogicalOperator?: FilterLogicalOperator;
 }
@@ -27,6 +26,7 @@ export declare abstract class WidgetBaseSource<Props extends WidgetBaseSourcePro
      */
     protected abstract getModelSource(owner: string | undefined): ModelSource;
     protected _getModelSource(owner?: string): Omit<ModelSource, 'type' | 'data'>;
+    protected _getSpatialFiltersResolution(source: Omit<ModelSource, 'type' | 'data'>, spatialFilter?: SpatialFilter, referenceViewState?: ViewState): number | undefined;
     /****************************************************************************
      * CATEGORIES
      */

package/package.json

@@ -4,7 +4,7 @@
   "repository": "github:CartoDB/carto-api-client",
   "author": "Don McCurdy <donmccurdy@carto.com>",
   "packageManager": "yarn@4.3.1",
-  "version": "0.4.3",
+  "version": "0.4.5-alpha.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public",
@@ -57,46 +57,41 @@
     "@turf/helpers": "^7.1.0",
     "@turf/invariant": "^7.1.0",
     "@turf/union": "^7.1.0",
-    "@types/geojson": "^7946.0.14"
+    "@types/geojson": "^7946.0.15"
   },
   "devDependencies": {
-    "@deck.gl/aggregation-layers": "^9.0.30",
-    "@deck.gl/carto": "^9.0.30",
-    "@deck.gl/core": "^9.0.30",
-    "@deck.gl/extensions": "^9.0.30",
-    "@deck.gl/geo-layers": "^9.0.30",
-    "@deck.gl/layers": "^9.0.30",
-    "@deck.gl/mesh-layers": "^9.0.30",
-    "@deck.gl/react": "^9.0.30",
-    "@lit/react": "^1.0.5",
+    "@deck.gl/aggregation-layers": "^9.0.38",
+    "@deck.gl/carto": "^9.0.38",
+    "@deck.gl/core": "^9.0.38",
+    "@deck.gl/extensions": "^9.0.38",
+    "@deck.gl/geo-layers": "^9.0.38",
+    "@deck.gl/layers": "^9.0.38",
+    "@deck.gl/mesh-layers": "^9.0.38",
+    "@lit/react": "^1.0.6",
     "@lit/task": "^1.0.1",
-    "@loaders.gl/core": "^4.2.3",
-    "@luma.gl/core": "^9.0.27",
-    "@luma.gl/engine": "^9.0.27",
-    "@sveltejs/vite-plugin-svelte": "^3.1.2",
+    "@loaders.gl/core": "^4.3.3",
+    "@luma.gl/core": "9.0.27",
+    "@luma.gl/engine": "9.0.27",
     "@types/json-schema": "^7.0.15",
-    "@types/react": "^18.3.3",
-    "@types/react-dom": "^18.3.0",
+    "@types/react": "^18.3.18",
     "@types/semver": "^7.5.8",
-    "@vitejs/plugin-vue": "^5.0.5",
-    "@vitest/coverage-istanbul": "^1.6.0",
+    "@vitest/coverage-istanbul": "^2.1.8",
     "@webcomponents/webcomponentsjs": "^2.8.0",
-    "concurrently": "^8.2.2",
-    "echarts": "^5.5.0",
-    "lit": "^3.1.4",
-    "lit-analyzer": "^1.2.1",
-    "maplibre-gl": "^4.6.0",
+    "concurrently": "^9.1.2",
+    "echarts": "^5.6.0",
+    "lit": "^3.2.1",
+    "lit-analyzer": "^2.0.3",
+    "maplibre-gl": "^5.0.0",
     "microbundle": "^0.15.1",
-    "prettier": "^2.6.2",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1",
-    "react-map-gl": "^7.1.7",
-    "rimraf": "^3.0.2",
+    "prettier": "^3.4.2",
+    "rimraf": "^6.0.1",
     "semver": "^7.6.3",
-    "svelte": "^4.2.17",
-    "typescript": "~5.3.3",
-    "vite": "^5.2.10",
-    "vitest": "1.6.0",
-    "vue": "^3.4.27"
-  }
+    "typescript": "~5.7.3",
+    "vite": "^6.0.7",
+    "vitest": "2.1.8"
+  },
+  "resolutions": {
+    "rollup": "^4.20.0"
+  },
+  "stableVersion": "0.4.4"
 }

package/src/api/query.ts

@@ -12,8 +12,7 @@ import {buildQueryUrl} from './endpoints';
 import {requestWithParameters} from './request-with-parameters';
 import {APIErrorContext} from './carto-api-error';
 
-export type QueryOptions = SourceOptions &
-  Omit<QuerySourceOptions, 'spatialDataColumn'>;
+export type QueryOptions = SourceOptions & QuerySourceOptions;
 type UrlParameters = {q: string; queryParameters?: string};
 
 export const query = async function (

package/src/models/model.ts

@@ -7,9 +7,10 @@ import {
   SpatialFilter,
 } from '../types.js';
 import {$TODO} from '../types-internal.js';
-import {assert} from '../utils.js';
+import {assert, isPureObject} from '../utils.js';
 import {ModelRequestOptions, makeCall} from './common.js';
 import {ApiVersion} from '../constants.js';
+import {SpatialDataType, SpatialFilterPolyfillMode} from '../sources/types.js';
 
 /** @internalRemarks Source: @carto/react-api */
 const AVAILABLE_MODELS = [
@@ -35,9 +36,14 @@ export interface ModelSource {
   data: string;
   filters?: Record<string, Filter>;
   filtersLogicalOperator?: FilterLogicalOperator;
-  geoColumn?: string;
   spatialFilter?: SpatialFilter;
   queryParameters?: QueryParameters;
+  spatialDataColumn?: string;
+  spatialDataType?: SpatialDataType;
+  spatialFiltersResolution?: number;
+  spatialFiltersMode?: SpatialFilterPolyfillMode;
+  /** original resolution of the spatial index data as stored in the DW */
+  dataResolution?: number;
 }
 
 const {V3} = ApiVersion;
@@ -79,50 +85,51 @@ export function executeModel(props: {
     data,
     filters,
     filtersLogicalOperator = 'and',
-    geoColumn = DEFAULT_GEO_COLUMN,
+    spatialDataType = 'geo',
+    spatialFiltersMode = 'intersects',
+    spatialFiltersResolution = 0,
   } = source;
 
-  const queryParameters = source.queryParameters
-    ? JSON.stringify(source.queryParameters)
-    : '';
-
-  const queryParams: Record<string, string> = {
+  const queryParams: Record<string, unknown> = {
     type,
     client: clientId,
     source: data,
-    params: JSON.stringify(params),
-    queryParameters,
-    filters: JSON.stringify(filters),
+    params,
+    queryParameters: source.queryParameters || '',
+    filters,
     filtersLogicalOperator,
   };
 
+  const spatialDataColumn = source.spatialDataColumn || DEFAULT_GEO_COLUMN;
+
   // Picking Model API requires 'spatialDataColumn'.
   if (model === 'pick') {
-    queryParams.spatialDataColumn = geoColumn;
+    queryParams.spatialDataColumn = spatialDataColumn;
   }
 
-  // API supports multiple filters, we apply it only to geoColumn
+  // API supports multiple filters, we apply it only to spatialDataColumn
   const spatialFilters = source.spatialFilter
-    ? {[geoColumn]: source.spatialFilter}
+    ? {[spatialDataColumn]: source.spatialFilter}
     : undefined;
 
   if (spatialFilters) {
-    queryParams.spatialFilters = JSON.stringify(spatialFilters);
+    queryParams.spatialFilters = spatialFilters;
+    queryParams.spatialDataColumn = spatialDataColumn;
+    queryParams.spatialDataType = spatialDataType;
+  }
+
+  if (spatialDataType !== 'geo') {
+    if (spatialFiltersResolution > 0) {
+      queryParams.spatialFiltersResolution = spatialFiltersResolution;
+    }
+    queryParams.spatialFiltersMode = spatialFiltersMode;
   }
 
   const urlWithSearchParams =
-    url + '?' + new URLSearchParams(queryParams).toString();
+    url + '?' + objectToURLSearchParams(queryParams).toString();
   const isGet = urlWithSearchParams.length <= REQUEST_GET_MAX_URL_LENGTH;
   if (isGet) {
     url = urlWithSearchParams;
-  } else {
-    // undo the JSON.stringify, @TODO find a better pattern
-    queryParams.params = params as $TODO;
-    queryParams.filters = filters as $TODO;
-    queryParams.queryParameters = source.queryParameters as $TODO;
-    if (spatialFilters) {
-      queryParams.spatialFilters = spatialFilters as $TODO;
-    }
   }
   return makeCall({
     url,
@@ -134,3 +141,19 @@ export function executeModel(props: {
     },
   });
 }
+
+function objectToURLSearchParams(object: Record<string, unknown>) {
+  const params = new URLSearchParams();
+  for (const key in object) {
+    if (isPureObject(object[key])) {
+      params.append(key, JSON.stringify(object[key]));
+    } else if (Array.isArray(object[key])) {
+      params.append(key, JSON.stringify(object[key]));
+    } else if (object[key] === null) {
+      params.append(key, 'null');
+    } else if (object[key] !== undefined) {
+      params.append(key, String(object[key]));
+    }
+  }
+  return params;
+}

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

@@ -47,6 +47,7 @@ export const boundaryQuerySource = async function (
   if (queryParameters) {
     urlParameters.queryParameters = queryParameters;
   }
+
   return baseSource<UrlParameters>(
     'boundary',
     options,

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

@@ -35,6 +35,7 @@ export const boundaryTableSource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
+
   return baseSource<UrlParameters>(
     'boundary',
     options,

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

@@ -19,6 +19,7 @@ export type H3QuerySourceOptions = SourceOptions &
   QuerySourceOptions &
   AggregationOptions &
   FilterOptions;
+
 type UrlParameters = {
   aggregationExp: string;
   aggregationResLevel?: string;
@@ -42,10 +43,13 @@ export const h3QuerySource = async function (
     queryParameters,
     filters,
   } = options;
+
+  const spatialDataType = 'h3';
+
   const urlParameters: UrlParameters = {
     aggregationExp,
     spatialDataColumn,
-    spatialDataType: 'h3',
+    spatialDataType,
     q: sqlQuery,
   };
 
@@ -58,10 +62,16 @@ export const h3QuerySource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
+
   return baseSource<UrlParameters>('query', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetQuerySource(options),
+      widgetSource: new WidgetQuerySource({
+        ...options,
+        // NOTE: Parameters with default values above must be explicitly passed here.
+        spatialDataColumn,
+        spatialDataType,
+      }),
     })
   );
 };

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

@@ -41,11 +41,14 @@ export const h3TableSource = async function (
     tableName,
     filters,
   } = options;
+
+  const spatialDataType = 'h3';
+
   const urlParameters: UrlParameters = {
     aggregationExp,
     name: tableName,
     spatialDataColumn,
-    spatialDataType: 'h3',
+    spatialDataType,
   };
 
   if (aggregationResLevel) {
@@ -54,10 +57,16 @@ export const h3TableSource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
+
   return baseSource<UrlParameters>('table', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetTableSource(options),
+      widgetSource: new WidgetTableSource({
+        ...options,
+        // NOTE: Parameters with default values above must be explicitly passed here.
+        spatialDataColumn,
+        spatialDataType,
+      }),
     })
   );
 };

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

@@ -44,11 +44,14 @@ export const quadbinQuerySource = async function (
     queryParameters,
     filters,
   } = options;
+
+  const spatialDataType = 'quadbin';
+
   const urlParameters: UrlParameters = {
     aggregationExp,
     q: sqlQuery,
     spatialDataColumn,
-    spatialDataType: 'quadbin',
+    spatialDataType,
   };
 
   if (aggregationResLevel) {
@@ -60,10 +63,16 @@ export const quadbinQuerySource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
+
   return baseSource<UrlParameters>('query', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetQuerySource(options),
+      widgetSource: new WidgetQuerySource({
+        ...options,
+        // NOTE: Parameters with default values above must be explicitly passed here.
+        spatialDataColumn,
+        spatialDataType,
+      }),
     })
   );
 };

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

@@ -43,11 +43,13 @@ export const quadbinTableSource = async function (
     filters,
   } = options;
 
+  const spatialDataType = 'quadbin';
+
   const urlParameters: UrlParameters = {
     aggregationExp,
     name: tableName,
     spatialDataColumn,
-    spatialDataType: 'quadbin',
+    spatialDataType,
   };
 
   if (aggregationResLevel) {
@@ -56,10 +58,16 @@ export const quadbinTableSource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
+
   return baseSource<UrlParameters>('table', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetTableSource(options),
+      widgetSource: new WidgetTableSource({
+        ...options,
+        // NOTE: Parameters with default values above must be explicitly passed here.
+        spatialDataColumn,
+        spatialDataType,
+      }),
     })
   );
 };