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

package/build/models/model.d.ts

@@ -1,7 +1,6 @@
 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];
@@ -15,14 +14,9 @@ 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,30 +38,6 @@ 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.
      */
@@ -97,10 +73,6 @@ 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 = {
     /**
@@ -109,8 +81,28 @@ export type FilterOptions = {
     filters?: Filters;
 };
 export type QuerySourceOptions = {
-    /** Full SQL query with query paremeter placeholders (if any). */
+    /**
+     * 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. */
     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,6 +134,26 @@ 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;
 };
 export type TilesetSourceOptions = {
     /**
@@ -158,13 +170,6 @@ 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/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): asserts condition;
+export declare function assert(condition: unknown, message: string): void;
 /**
  * @internalRemarks Source: @carto/react-core
  * @internal

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

@@ -1,20 +1,13 @@
-import { SpatialFilterPolyfillMode, TileResolution } from '../sources/types';
+import { 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;
     abortController?: AbortController;
     filterOwner?: string;
-    viewState?: ViewState;
 }
 /** Options for {@link WidgetBaseSource#getCategories}. */
 export interface CategoryRequestOptions extends BaseRequestOptions {

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

@@ -5,6 +5,7 @@ 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;
 }

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.2-alpha.0",
+  "version": "0.4.2",
   "license": "MIT",
   "publishConfig": {
     "access": "public",

package/src/api/query.ts

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

package/src/models/model.ts

@@ -7,10 +7,9 @@ import {
   SpatialFilter,
 } from '../types.js';
 import {$TODO} from '../types-internal.js';
-import {assert, isPureObject} from '../utils.js';
+import {assert} 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 = [
@@ -36,14 +35,9 @@ 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;
@@ -85,51 +79,50 @@ export function executeModel(props: {
     data,
     filters,
     filtersLogicalOperator = 'and',
-    spatialDataType = 'geo',
-    spatialFiltersMode = 'intersects',
-    spatialFiltersResolution = 0,
+    geoColumn = DEFAULT_GEO_COLUMN,
   } = source;
 
-  const queryParams: Record<string, unknown> = {
+  const queryParameters = source.queryParameters
+    ? JSON.stringify(source.queryParameters)
+    : '';
+
+  const queryParams: Record<string, string> = {
     type,
     client: clientId,
     source: data,
-    params,
-    queryParameters: source.queryParameters || '',
-    filters,
+    params: JSON.stringify(params),
+    queryParameters,
+    filters: JSON.stringify(filters),
     filtersLogicalOperator,
   };
 
-  const spatialDataColumn = source.spatialDataColumn || DEFAULT_GEO_COLUMN;
-
   // Picking Model API requires 'spatialDataColumn'.
   if (model === 'pick') {
-    queryParams.spatialDataColumn = spatialDataColumn;
+    queryParams.spatialDataColumn = geoColumn;
   }
 
-  // API supports multiple filters, we apply it only to spatialDataColumn
+  // API supports multiple filters, we apply it only to geoColumn
   const spatialFilters = source.spatialFilter
-    ? {[spatialDataColumn]: source.spatialFilter}
+    ? {[geoColumn]: source.spatialFilter}
     : undefined;
 
   if (spatialFilters) {
-    queryParams.spatialFilters = spatialFilters; // JSON.stringify(spatialFilters);
-    queryParams.spatialDataColumn = spatialDataColumn;
-    queryParams.spatialDataType = spatialDataType;
-  }
-
-  if (spatialDataType !== 'geo') {
-    if (spatialFiltersResolution > 0) {
-      queryParams.spatialFiltersResolution = spatialFiltersResolution;
-    }
-    queryParams.spatialFiltersMode = spatialFiltersMode;
+    queryParams.spatialFilters = JSON.stringify(spatialFilters);
   }
 
   const urlWithSearchParams =
-    url + '?' + objectToURLSearchParams(queryParams).toString();
+    url + '?' + new URLSearchParams(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,
@@ -141,19 +134,3 @@ 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/h3-query-source.ts

@@ -19,7 +19,6 @@ export type H3QuerySourceOptions = SourceOptions &
   QuerySourceOptions &
   AggregationOptions &
   FilterOptions;
-
 type UrlParameters = {
   aggregationExp: string;
   aggregationResLevel?: string;
@@ -60,12 +59,7 @@ export const h3QuerySource = async function (
   return baseSource<UrlParameters>('query', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetQuerySource({
-        ...options,
-        // NOTE: passing redundant spatialDataColumn here to apply the default value 'h3'
-        spatialDataColumn,
-        spatialDataType: 'h3',
-      }),
+      widgetSource: new WidgetQuerySource(options),
     })
   );
 };

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

@@ -55,12 +55,7 @@ export const h3TableSource = async function (
   return baseSource<UrlParameters>('table', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetTableSource({
-        ...options,
-        // NOTE: passing redundant spatialDataColumn here to apply the default value 'h3'
-        spatialDataColumn,
-        spatialDataType: 'h3',
-      }),
+      widgetSource: new WidgetTableSource(options),
     })
   );
 };

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

@@ -60,12 +60,7 @@ export const quadbinQuerySource = async function (
   return baseSource<UrlParameters>('query', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetQuerySource({
-        ...options,
-        // NOTE: passing redundant spatialDataColumn here to apply the default value 'quadbin'
-        spatialDataColumn,
-        spatialDataType: 'quadbin',
-      }),
+      widgetSource: new WidgetQuerySource(options),
     })
   );
 };

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

@@ -56,12 +56,7 @@ export const quadbinTableSource = async function (
   return baseSource<UrlParameters>('table', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetTableSource({
-        ...options,
-        // NOTE: passing redundant spatialDataColumn here to apply the default value 'quadbin'
-        spatialDataColumn,
-        spatialDataType: 'quadbin',
-      }),
+      widgetSource: new WidgetTableSource(options),
     })
   );
 };

package/src/sources/types.ts

@@ -48,33 +48,6 @@ 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.
    */
@@ -116,11 +89,6 @@ 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 = {
@@ -131,9 +99,31 @@ export type FilterOptions = {
 };
 
 export type QuerySourceOptions = {
-  /** Full SQL query with query paremeter placeholders (if any). */
+  /**
+   * 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. */
   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.
    *
@@ -166,6 +156,28 @@ 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;
 };
 
 export type TilesetSourceOptions = {
@@ -186,14 +198,6 @@ 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

@@ -64,10 +64,7 @@ export const vectorQuerySource = async function (
   return baseSource<UrlParameters>('query', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetQuerySource({
-        ...options,
-        spatialDataType: 'geo',
-      }),
+      widgetSource: new WidgetQuerySource(options),
     })
   );
 };

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

@@ -22,7 +22,6 @@ export type VectorTableSourceOptions = SourceOptions &
   TableSourceOptions &
   FilterOptions &
   ColumnsOption;
-
 type UrlParameters = {
   columns?: string;
   filters?: Record<string, unknown>;
@@ -59,10 +58,7 @@ export const vectorTableSource = async function (
   return baseSource<UrlParameters>('table', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetTableSource({
-        ...options,
-        spatialDataType: 'geo',
-      }),
+      widgetSource: new WidgetTableSource(options),
     })
   );
 };

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): asserts condition {
+export function assert(condition: unknown, message: string) {
   if (!condition) {
     throw new Error(message);
   }

package/src/widget-sources/types.ts

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