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

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

@@ -1,22 +1,32 @@
-import { TileResolution } from '../sources/types';
+import { SpatialFilterPolyfillMode, TileResolution } from '../sources/types';
 import { GroupDateType, SortColumnType, SortDirection, SpatialFilter } from '../types';
 /******************************************************************************
  * WIDGET API REQUESTS
  */
-/** Common options for {@link WidgetBaseSource} requests. */
+export interface ViewState {
+    zoom: number;
+    latitude: number;
+    longitude: number;
+}
+/** Common options for {@link WidgetRemoteSource} requests. */
 interface BaseRequestOptions {
     spatialFilter?: SpatialFilter;
+    spatialFiltersMode?: SpatialFilterPolyfillMode;
+    /** Required for table- and query-based spatial index sources (H3, Quadbin). */
+    spatialIndexReferenceViewState?: ViewState;
     abortController?: AbortController;
     filterOwner?: string;
 }
-/** Options for {@link WidgetBaseSource#getCategories}. */
+/** Options for {@link WidgetRemoteSource#getCategories}. */
 export interface CategoryRequestOptions extends BaseRequestOptions {
     column: string;
     operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
     operationColumn?: string;
+    /** Local only. */
+    joinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
 }
 /**
- * Options for {@link WidgetBaseSource#getFeatures}.
+ * Options for {@link WidgetRemoteSource#getFeatures}.
  * @experimental
  * @internal
  */
@@ -52,30 +62,33 @@ export interface FeaturesRequestOptions extends BaseRequestOptions {
      */
     tileResolution?: TileResolution;
 }
-/** Options for {@link WidgetBaseSource#getFormula}. */
+/** Options for {@link WidgetRemoteSource#getFormula}. */
 export interface FormulaRequestOptions extends BaseRequestOptions {
     column: string;
-    operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
+    operation?: 'count' | 'avg' | 'min' | 'max' | 'sum' | 'custom';
     operationExp?: string;
+    joinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
 }
-/** Options for {@link WidgetBaseSource#getHistogram}. */
+/** Options for {@link WidgetRemoteSource#getHistogram}. */
 export interface HistogramRequestOptions extends BaseRequestOptions {
     column: string;
     ticks: number[];
     operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
+    /** Local only. */
+    joinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
 }
-/** Options for {@link WidgetBaseSource#getRange}. */
+/** Options for {@link WidgetRemoteSource#getRange}. */
 export interface RangeRequestOptions extends BaseRequestOptions {
     column: string;
 }
-/** Options for {@link WidgetBaseSource#getScatter}. */
+/** Options for {@link WidgetRemoteSource#getScatter}. */
 export interface ScatterRequestOptions extends BaseRequestOptions {
     xAxisColumn: string;
     xAxisJoinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
     yAxisColumn: string;
     yAxisJoinOperation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
 }
-/** Options for {@link WidgetBaseSource#getTable}. */
+/** Options for {@link WidgetRemoteSource#getTable}. */
 export interface TableRequestOptions extends BaseRequestOptions {
     columns: string[];
     sortBy?: string;
@@ -83,11 +96,15 @@ export interface TableRequestOptions extends BaseRequestOptions {
     sortByColumnType?: SortColumnType;
     offset?: number;
     limit?: number;
+    /** Local only. */
+    searchFilterColumn?: string;
+    /** Local only. */
+    searchFilterText?: string;
 }
-/** Options for {@link WidgetBaseSource#getTimeSeries}. */
+/** Options for {@link WidgetRemoteSource#getTimeSeries}. */
 export interface TimeSeriesRequestOptions extends BaseRequestOptions {
     column: string;
-    stepSize?: GroupDateType;
+    stepSize: GroupDateType;
     stepMultiplier?: number;
     operation?: 'count' | 'avg' | 'min' | 'max' | 'sum';
     operationColumn?: string;
@@ -100,42 +117,42 @@ export interface TimeSeriesRequestOptions extends BaseRequestOptions {
  * WIDGET API RESPONSES
  */
 /**
- * Response from {@link WidgetBaseSource#getFeatures}.
+ * Response from {@link WidgetRemoteSource#getFeatures}.
  * @experimental
  * @internal
  */
 export type FeaturesResponse = {
     rows: Record<string, unknown>[];
 };
-/** Response from {@link WidgetBaseSource#getFormula}. */
+/** Response from {@link WidgetRemoteSource#getFormula}. */
 export type FormulaResponse = {
-    value: number;
+    value: number | null;
 };
-/** Response from {@link WidgetBaseSource#getCategories}. */
+/** Response from {@link WidgetRemoteSource#getCategories}. */
 export type CategoryResponse = {
     name: string;
     value: number;
 }[];
-/** Response from {@link WidgetBaseSource#getRange}. */
+/** Response from {@link WidgetRemoteSource#getRange}. */
 export type RangeResponse = {
     min: number;
     max: number;
-};
-/** Response from {@link WidgetBaseSource#getTable}. */
+} | null;
+/** Response from {@link WidgetRemoteSource#getTable}. */
 export type TableResponse = {
     totalCount: number;
     rows: Record<string, number | string>[];
 };
-/** Response from {@link WidgetBaseSource#getScatter}. */
+/** Response from {@link WidgetRemoteSource#getScatter}. */
 export type ScatterResponse = [number, number][];
-/** Response from {@link WidgetBaseSource#getTimeSeries}. */
+/** Response from {@link WidgetRemoteSource#getTimeSeries}. */
 export type TimeSeriesResponse = {
     rows: {
         name: string;
         value: number;
     }[];
-    categories: string[];
+    categories?: string[];
 };
-/** Response from {@link WidgetBaseSource#getHistogram}. */
+/** Response from {@link WidgetRemoteSource#getHistogram}. */
 export type HistogramResponse = number[];
 export {};

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

@@ -1,5 +1,5 @@
 import { H3QuerySourceOptions, QuadbinQuerySourceOptions, VectorQuerySourceOptions } from '../sources/index.js';
-import { WidgetBaseSource, WidgetBaseSourceProps } from './widget-base-source.js';
+import { WidgetRemoteSource, WidgetRemoteSourceProps } from './widget-remote-source.js';
 import { ModelSource } from '../models/model.js';
 type LayerQuerySourceOptions = Omit<VectorQuerySourceOptions, 'filters'> | Omit<H3QuerySourceOptions, 'filters'> | Omit<QuadbinQuerySourceOptions, 'filters'>;
 export type WidgetQuerySourceResult = {
@@ -27,7 +27,7 @@ export type WidgetQuerySourceResult = {
  * const { widgetSource } = await data;
  * ```
  */
-export declare class WidgetQuerySource extends WidgetBaseSource<LayerQuerySourceOptions & WidgetBaseSourceProps> {
+export declare class WidgetQuerySource extends WidgetRemoteSource<LayerQuerySourceOptions & WidgetRemoteSourceProps> {
     protected getModelSource(owner: string): ModelSource;
 }
 export {};

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

@@ -0,0 +1,18 @@
+import { CategoryRequestOptions, CategoryResponse, FeaturesRequestOptions, FeaturesResponse, FormulaRequestOptions, FormulaResponse, HistogramRequestOptions, HistogramResponse, RangeRequestOptions, RangeResponse, ScatterRequestOptions, ScatterResponse, TableRequestOptions, TableResponse, TimeSeriesRequestOptions, TimeSeriesResponse } from './types.js';
+import { WidgetSource, WidgetSourceProps } from './widget-source.js';
+export type WidgetRemoteSourceProps = WidgetSourceProps;
+/**
+ * Source for Widget API requests.
+ *
+ * Abstract class. Use {@link WidgetQuerySource} or {@link WidgetTableSource}.
+ */
+export declare abstract class WidgetRemoteSource<Props extends WidgetRemoteSourceProps> extends WidgetSource<Props> {
+    getCategories(options: CategoryRequestOptions): Promise<CategoryResponse>;
+    getFeatures(options: FeaturesRequestOptions): Promise<FeaturesResponse>;
+    getFormula(options: FormulaRequestOptions): Promise<FormulaResponse>;
+    getHistogram(options: HistogramRequestOptions): Promise<HistogramResponse>;
+    getRange(options: RangeRequestOptions): Promise<RangeResponse>;
+    getScatter(options: ScatterRequestOptions): Promise<ScatterResponse>;
+    getTable(options: TableRequestOptions): Promise<TableResponse>;
+    getTimeSeries(options: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
+}

package/build/widget-sources/{widget-base-source.d.ts → widget-source.d.ts}

@@ -1,43 +1,36 @@
-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'> {
+export interface WidgetSourceProps extends Omit<SourceOptions, 'filters'> {
     apiVersion?: ApiVersion;
-    geoColumn?: string;
     filters?: Record<string, Filter>;
     filtersLogicalOperator?: FilterLogicalOperator;
 }
-export type WidgetSource = WidgetBaseSource<WidgetBaseSourceProps>;
 /**
  * Source for Widget API requests on a data source defined by a SQL query.
  *
  * Abstract class. Use {@link WidgetQuerySource} or {@link WidgetTableSource}.
  */
-export declare abstract class WidgetBaseSource<Props extends WidgetBaseSourceProps> {
+export declare abstract class WidgetSource<Props extends WidgetSourceProps> {
     readonly props: Props;
-    static defaultProps: Partial<WidgetBaseSourceProps>;
+    static defaultProps: Partial<WidgetSourceProps>;
     constructor(props: Props);
     /**
-     * Subclasses of {@link WidgetBaseSource} must implement this method, calling
-     * {@link WidgetBaseSource.prototype._getModelSource} for common source
+     * Subclasses of {@link WidgetRemoteSource} must implement this method, calling
+     * {@link WidgetRemoteSource.prototype._getModelSource} for common source
      * properties, and adding additional required properties including 'type' and
      * 'data'.
      */
     protected abstract getModelSource(owner: string | undefined): ModelSource;
     protected _getModelSource(owner?: string): Omit<ModelSource, 'type' | 'data'>;
-    /****************************************************************************
-     * CATEGORIES
-     */
+    protected _getSpatialFiltersResolution(source: Omit<ModelSource, 'type' | 'data'>, spatialFilter?: SpatialFilter, referenceViewState?: ViewState): number | undefined;
     /**
      * Returns a list of labeled datapoints for categorical data. Suitable for
      * charts including grouped bar charts, pie charts, and tree charts.
      */
-    getCategories(options: CategoryRequestOptions): Promise<CategoryResponse>;
-    /****************************************************************************
-     * FEATURES
-     */
+    abstract getCategories(options: CategoryRequestOptions): Promise<CategoryResponse>;
     /**
      * Given a list of feature IDs (as found in `_carto_feature_id`) returns all
      * matching features. In datasets containing features with duplicate geometries,
@@ -46,54 +39,36 @@ export declare abstract class WidgetBaseSource<Props extends WidgetBaseSourcePro
      * @internal
      * @experimental
      */
-    getFeatures(options: FeaturesRequestOptions): Promise<FeaturesResponse>;
-    /****************************************************************************
-     * FORMULA
-     */
+    abstract getFeatures(options: FeaturesRequestOptions): Promise<FeaturesResponse>;
     /**
      * Returns a scalar numerical statistic over all matching data. Suitable
      * for 'headline' or 'scorecard' figures such as counts and sums.
      */
-    getFormula(options: FormulaRequestOptions): Promise<FormulaResponse>;
-    /****************************************************************************
-     * HISTOGRAM
-     */
+    abstract getFormula(options: FormulaRequestOptions): Promise<FormulaResponse>;
     /**
      * Returns a list of labeled datapoints for 'bins' of data defined as ticks
      * over a numerical range. Suitable for histogram charts.
      */
-    getHistogram(options: HistogramRequestOptions): Promise<HistogramResponse>;
-    /****************************************************************************
-     * RANGE
-     */
+    abstract getHistogram(options: HistogramRequestOptions): Promise<HistogramResponse>;
     /**
      * Returns a range (min and max) for a numerical column of matching rows.
      * Suitable for displaying certain 'headline' or 'scorecard' statistics,
      * or rendering a range slider UI for filtering.
      */
-    getRange(options: RangeRequestOptions): Promise<RangeResponse>;
-    /****************************************************************************
-     * SCATTER
-     */
+    abstract getRange(options: RangeRequestOptions): Promise<RangeResponse>;
     /**
      * Returns a list of bivariate datapoints defined as numerical 'x' and 'y'
      * values. Suitable for rendering scatter plots.
      */
-    getScatter(options: ScatterRequestOptions): Promise<ScatterResponse>;
-    /****************************************************************************
-     * TABLE
-     */
+    abstract getScatter(options: ScatterRequestOptions): Promise<ScatterResponse>;
     /**
      * Returns a list of arbitrary data rows, with support for pagination and
      * sorting. Suitable for displaying tables and lists.
      */
-    getTable(options: TableRequestOptions): Promise<TableResponse>;
-    /****************************************************************************
-     * TIME SERIES
-     */
+    abstract getTable(options: TableRequestOptions): Promise<TableResponse>;
     /**
      * Returns a series of labeled numerical values, grouped into equally-sized
      * time intervals. Suitable for rendering time series charts.
      */
-    getTimeSeries(options: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
+    abstract getTimeSeries(options: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
 }

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

@@ -1,5 +1,5 @@
 import { H3TableSourceOptions, QuadbinTableSourceOptions, VectorTableSourceOptions } from '../sources/index.js';
-import { WidgetBaseSource, WidgetBaseSourceProps } from './widget-base-source.js';
+import { WidgetRemoteSource, WidgetRemoteSourceProps } from './widget-remote-source.js';
 import { ModelSource } from '../models/model.js';
 type LayerTableSourceOptions = Omit<VectorTableSourceOptions, 'filters'> | Omit<H3TableSourceOptions, 'filters'> | Omit<QuadbinTableSourceOptions, 'filters'>;
 export type WidgetTableSourceResult = {
@@ -27,7 +27,7 @@ export type WidgetTableSourceResult = {
  * const { widgetSource } = await data;
  * ```
  */
-export declare class WidgetTableSource extends WidgetBaseSource<LayerTableSourceOptions & WidgetBaseSourceProps> {
+export declare class WidgetTableSource extends WidgetRemoteSource<LayerTableSourceOptions & WidgetRemoteSourceProps> {
     protected getModelSource(owner: string): ModelSource;
 }
 export {};

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

@@ -0,0 +1,67 @@
+import { TilesetSourceOptions } from '../sources/index.js';
+import type { ModelSource } from '../models/index.js';
+import { CategoryRequestOptions, CategoryResponse, FeaturesRequestOptions, FeaturesResponse, FormulaRequestOptions, FormulaResponse, HistogramRequestOptions, HistogramResponse, RangeRequestOptions, RangeResponse, ScatterRequestOptions, ScatterResponse, TableRequestOptions, TableResponse, TimeSeriesRequestOptions, TimeSeriesResponse } from './types.js';
+import { TileFormat } from '../constants.js';
+import { SpatialFilter, Tile } from '../types.js';
+import { TileFeatureExtractOptions } from '../filters/index.js';
+import { FeatureCollection } from 'geojson';
+import { SpatialDataType } from '../sources/types.js';
+import { WidgetSource, WidgetSourceProps } from './widget-source.js';
+export type WidgetTilesetSourceProps = WidgetSourceProps & Omit<TilesetSourceOptions, 'filters'> & {
+    tileFormat: TileFormat;
+    spatialDataType: SpatialDataType;
+};
+export type WidgetTilesetSourceResult = {
+    widgetSource: WidgetTilesetSource;
+};
+/**
+ * Source for Widget API requests on a data source defined by a tileset.
+ *
+ * Generally not intended to be constructed directly. Instead, call
+ * {@link vectorTilesetSource}, {@link h3TilesetSource}, or {@link quadbinTilesetSource},
+ * which can be shared with map layers. Sources contain a `widgetSource`
+ * property, for use by widget implementations.
+ *
+ * Example:
+ *
+ * ```javascript
+ * import { vectorTilesetSource } from '@carto/api-client';
+ *
+ * const data = vectorTilesetSource({
+ *   accessToken: '••••',
+ *   connectionName: 'carto_dw',
+ *   tableName: 'carto-demo-data.demo_rasters.my_tileset_source'
+ * });
+ *
+ * const { widgetSource } = await data;
+ * ```
+ */
+export declare class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps> {
+    private _features;
+    protected getModelSource(owner: string): ModelSource;
+    /** Loads features as a list of tiles (typically provided by deck.gl). */
+    loadTiles({ tiles, spatialFilter, uniqueIdProperty, options, }: {
+        tiles: Tile[];
+        spatialFilter: SpatialFilter;
+        uniqueIdProperty?: string;
+        options?: TileFeatureExtractOptions;
+    }): void;
+    /** Loads features as GeoJSON (used for testing). */
+    loadGeoJSON({ geojson, spatialFilter, uniqueIdProperty, }: {
+        geojson: FeatureCollection;
+        spatialFilter: SpatialFilter;
+        uniqueIdProperty?: string;
+    }): void;
+    getFeatures(options: FeaturesRequestOptions): Promise<FeaturesResponse>;
+    getFormula({ column, operation, joinOperation, filterOwner, }: FormulaRequestOptions): Promise<FormulaResponse>;
+    getHistogram({ operation, ticks, column, joinOperation, filterOwner, }: HistogramRequestOptions): Promise<HistogramResponse>;
+    getCategories({ column, operation, operationColumn, joinOperation, filterOwner, }: CategoryRequestOptions): Promise<CategoryResponse>;
+    getScatter({ xAxisColumn, yAxisColumn, xAxisJoinOperation, yAxisJoinOperation, filterOwner, }: ScatterRequestOptions): Promise<ScatterResponse>;
+    getTable(options: TableRequestOptions): Promise<TableResponse>;
+    getTimeSeries({ column, stepSize, operation, operationColumn, joinOperation, filterOwner, }: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
+    getRange({ column, filterOwner, }: RangeRequestOptions): Promise<RangeResponse>;
+    /****************************************************************************
+     * INTERNAL
+     */
+    private _getFilteredFeatures;
+}

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.5.0-alpha.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public",
@@ -52,51 +52,52 @@
     "LICENSE.md"
   ],
   "dependencies": {
+    "@loaders.gl/schema": "^4.3.3",
     "@turf/bbox-clip": "^7.1.0",
     "@turf/bbox-polygon": "^7.1.0",
+    "@turf/boolean-intersects": "^7.1.0",
+    "@turf/boolean-within": "^7.1.0",
     "@turf/helpers": "^7.1.0",
+    "@turf/intersect": "^7.1.0",
     "@turf/invariant": "^7.1.0",
     "@turf/union": "^7.1.0",
-    "@types/geojson": "^7946.0.14"
+    "@types/geojson": "^7946.0.15",
+    "h3-js": "4.1.0"
   },
   "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"
-  }
+    "thenby": "^1.3.4",
+    "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/constants.ts

@@ -31,3 +31,28 @@ export enum ApiVersion {
 
 /** @internalRemarks Source: @carto/constants, @deck.gl/carto */
 export const DEFAULT_API_BASE_URL = 'https://gcp-us-east1.api.carto.com';
+
+/** @internalRemarks Source: @carto/react-core */
+export enum TileFormat {
+  MVT = 'mvt',
+  JSON = 'json',
+  GEOJSON = 'geojson',
+  BINARY = 'binary',
+}
+
+/** @internalRemarks Source: @carto/react-core */
+export enum SpatialIndex {
+  H3 = 'h3',
+  S2 = 's2',
+  QUADBIN = 'quadbin',
+}
+
+/** @internalRemarks Source: @carto/react-core */
+export enum Provider {
+  BIGQUERY = 'bigquery',
+  REDSHIFT = 'redshift',
+  POSTGRES = 'postgres',
+  SNOWFLAKE = 'snowflake',
+  DATABRICKS = 'databricks',
+  DATABRICKS_REST = 'databricksRest',
+}