@carto/api-client 0.5.0-alpha.6 → 0.5.0-alpha.8

package/package.json

@@ -8,12 +8,8 @@
   "homepage": "https://github.com/CartoDB/carto-api-client#readme",
   "author": "Don McCurdy <donmccurdy@carto.com>",
   "packageManager": "yarn@4.3.1",
-  "version": "0.5.0-alpha.6",
+  "version": "0.5.0-alpha.8",
   "license": "MIT",
-  "publishConfig": {
-    "access": "public",
-    "tag": "alpha"
-  },
   "type": "module",
   "sideEffects": false,
   "exports": {
@@ -44,6 +40,7 @@
     "test": "vitest run --typecheck",
     "test:watch": "vitest watch --typecheck",
     "coverage": "vitest run --coverage.enabled --coverage.all false",
+    "benchmark": "node scripts/benchmark.js",
     "lint": "eslint .",
     "format": "prettier \"**/*.{cjs,html,js,json,md,ts}\" --write",
     "format:check": "prettier \"**/*.{cjs,html,js,json,md,ts}\" --check",
@@ -90,6 +87,8 @@
     "@luma.gl/core": "~9.1.0",
     "@luma.gl/engine": "~9.1.0",
     "@luma.gl/shadertools": "~9.1.0",
+    "@turf/buffer": "^7.2.0",
+    "@turf/random": "^7.2.0",
     "@types/json-schema": "^7.0.15",
     "@types/react": "^18.3.18",
     "@types/semver": "^7.5.8",
@@ -105,6 +104,7 @@
     "rimraf": "^6.0.1",
     "semver": "^7.7.1",
     "thenby": "^1.3.4",
+    "tinybench": "^3.1.1",
     "tsup": "^8.3.6",
     "typescript": "~5.7.3",
     "typescript-eslint": "^8.24.0",

package/src/models/common.ts

@@ -4,7 +4,7 @@ import {InvalidColumnError} from '../utils.js';
 export interface ModelRequestOptions {
   method: 'GET' | 'POST';
   headers?: Record<string, string>;
-  abortController?: AbortController;
+  signal?: AbortSignal;
   otherOptions?: Record<string, unknown>;
   body?: string;
 }
@@ -75,7 +75,7 @@ export async function makeCall({
         method: opts?.method,
         body: opts?.body,
       }),
-      signal: opts?.abortController?.signal,
+      signal: opts?.signal,
       ...opts?.otherOptions,
     });
     data = await response.json();

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

@@ -6,9 +6,7 @@ import {getTileFormat} from '../utils/getTileFormat.js';
 import {
   WidgetTilesetSource,
   WidgetTilesetSourceResult,
-  WidgetTilesetWorkerSource,
 } from '../widget-sources/index.js';
-import {isModuleWorkerSupported} from '../workers/utils.js';
 import {baseSource} from './base-source.js';
 import type {
   SourceOptions,
@@ -28,15 +26,10 @@ export const h3TilesetSource = async function (
   const {tableName, spatialDataColumn = 'h3'} = options;
   const urlParameters: UrlParameters = {name: tableName};
 
-  const WidgetSourceClass =
-    options.widgetSourceWorker !== false && isModuleWorkerSupported()
-      ? WidgetTilesetWorkerSource
-      : WidgetTilesetSource;
-
   return baseSource<UrlParameters>('tileset', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetSourceClass({
+      widgetSource: new WidgetTilesetSource({
         ...options,
         tileFormat: getTileFormat(result as TilejsonResult),
         spatialDataColumn,

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

@@ -6,9 +6,7 @@ import {getTileFormat} from '../utils/getTileFormat.js';
 import {
   WidgetTilesetSource,
   WidgetTilesetSourceResult,
-  WidgetTilesetWorkerSource,
 } from '../widget-sources/index.js';
-import {isModuleWorkerSupported} from '../workers/utils.js';
 import {baseSource} from './base-source.js';
 import type {
   SourceOptions,
@@ -28,15 +26,10 @@ export const quadbinTilesetSource = async function (
   const {tableName, spatialDataColumn = 'quadbin'} = options;
   const urlParameters: UrlParameters = {name: tableName};
 
-  const WidgetSourceClass =
-    options.widgetSourceWorker !== false && isModuleWorkerSupported()
-      ? WidgetTilesetWorkerSource
-      : WidgetTilesetSource;
-
   return baseSource<UrlParameters>('tileset', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetSourceClass({
+      widgetSource: new WidgetTilesetSource({
         ...options,
         tileFormat: getTileFormat(result as TilejsonResult),
         spatialDataColumn,

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

@@ -7,9 +7,7 @@ import {getTileFormat} from '../utils/getTileFormat.js';
 import {
   WidgetTilesetSource,
   WidgetTilesetSourceResult,
-  WidgetTilesetWorkerSource,
 } from '../widget-sources/index.js';
-import {isModuleWorkerSupported} from '../workers/utils.js';
 import {baseSource} from './base-source.js';
 import type {
   SourceOptions,
@@ -29,15 +27,10 @@ export const vectorTilesetSource = async function (
   const {tableName, spatialDataColumn = DEFAULT_GEO_COLUMN} = options;
   const urlParameters: UrlParameters = {name: tableName};
 
-  const WidgetSourceClass =
-    options.widgetSourceWorker !== false && isModuleWorkerSupported()
-      ? WidgetTilesetWorkerSource
-      : WidgetTilesetSource;
-
   return baseSource<UrlParameters>('tileset', options, urlParameters).then(
     (result) => ({
       ...(result as TilejsonResult),
-      widgetSource: new WidgetSourceClass({
+      widgetSource: new WidgetTilesetSource({
         ...options,
         tileFormat: getTileFormat(result as TilejsonResult),
         spatialDataColumn,

package/src/widget-sources/index.ts

@@ -3,5 +3,4 @@ export * from './widget-query-source.js';
 export * from './widget-remote-source.js';
 export * from './widget-table-source.js';
 export * from './widget-tileset-source.js';
-export * from './widget-tileset-worker-source.js';
 export * from './types.js';

package/src/widget-sources/types.ts

@@ -19,11 +19,11 @@ export interface ViewState {
 
 /** Common options for {@link WidgetRemoteSource} requests. */
 interface BaseRequestOptions {
+  signal?: AbortSignal;
   spatialFilter?: SpatialFilter;
   spatialFiltersMode?: SpatialFilterPolyfillMode;
   /** Required for table- and query-based spatial index sources (H3, Quadbin). */
   spatialIndexReferenceViewState?: ViewState;
-  abortController?: AbortController;
   /** Overrides source filters, if any. */
   filters?: Filters;
   filterOwner?: string;

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

@@ -75,12 +75,12 @@ export abstract class WidgetRemoteSource<
     options: CategoryRequestOptions
   ): Promise<CategoryResponse> {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
-      abortController,
       ...params
     } = options;
     const {column, operation, operationColumn} = params;
@@ -106,7 +106,7 @@ export abstract class WidgetRemoteSource<
         operation,
         operationColumn: operationColumn || column,
       },
-      opts: {abortController, headers: this._headers},
+      opts: {signal, headers: this._headers},
     }).then((res: CategoriesModelResponse) => normalizeObjectKeys(res.rows));
   }
 
@@ -114,12 +114,12 @@ export abstract class WidgetRemoteSource<
     options: FeaturesRequestOptions
   ): Promise<FeaturesResponse> {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
-      abortController,
       ...params
     } = options;
     const {columns, dataType, featureIds, z, limit, tileResolution} = params;
@@ -148,19 +148,19 @@ export abstract class WidgetRemoteSource<
         limit: limit || 1000,
         tileResolution: tileResolution || DEFAULT_TILE_RESOLUTION,
       },
-      opts: {abortController, headers: this._headers},
+      opts: {signal, headers: this._headers},
       // Avoid `normalizeObjectKeys()`, which changes column names.
     }).then(({rows}: FeaturesModelResponse) => ({rows}));
   }
 
   async getFormula(options: FormulaRequestOptions): Promise<FormulaResponse> {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
-      abortController,
       operationExp,
       ...params
     } = options;
@@ -187,7 +187,7 @@ export abstract class WidgetRemoteSource<
         operation: operation ?? 'count',
         operationExp,
       },
-      opts: {abortController, headers: this._headers},
+      opts: {signal, headers: this._headers},
     }).then((res: FormulaModelResponse) => normalizeObjectKeys(res.rows[0]));
   }
 
@@ -195,12 +195,12 @@ export abstract class WidgetRemoteSource<
     options: HistogramRequestOptions
   ): Promise<HistogramResponse> {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
-      abortController,
       ...params
     } = options;
     const {column, operation, ticks} = params;
@@ -222,7 +222,7 @@ export abstract class WidgetRemoteSource<
         spatialFilter,
       },
       params: {column, operation, ticks},
-      opts: {abortController, headers: this._headers},
+      opts: {signal, headers: this._headers},
     }).then((res: HistogramModelResponse) => normalizeObjectKeys(res.rows));
 
     if (data.length) {
@@ -240,12 +240,12 @@ export abstract class WidgetRemoteSource<
 
   async getRange(options: RangeRequestOptions): Promise<RangeResponse> {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
-      abortController,
       ...params
     } = options;
     const {column} = params;
@@ -267,18 +267,18 @@ export abstract class WidgetRemoteSource<
         spatialFilter,
       },
       params: {column},
-      opts: {abortController, headers: this._headers},
+      opts: {signal, headers: this._headers},
     }).then((res: RangeModelResponse) => normalizeObjectKeys(res.rows[0]));
   }
 
   async getScatter(options: ScatterRequestOptions): Promise<ScatterResponse> {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
-      abortController,
       ...params
     } = options;
     const {xAxisColumn, xAxisJoinOperation, yAxisColumn, yAxisJoinOperation} =
@@ -311,7 +311,7 @@ export abstract class WidgetRemoteSource<
         yAxisJoinOperation,
         limit: HARD_LIMIT,
       },
-      opts: {abortController, headers: this._headers},
+      opts: {signal, headers: this._headers},
     })
       .then((res: ScatterModelResponse) => normalizeObjectKeys(res.rows))
       .then((res) => res.map(({x, y}: {x: number; y: number}) => [x, y]));
@@ -319,12 +319,12 @@ export abstract class WidgetRemoteSource<
 
   async getTable(options: TableRequestOptions): Promise<TableResponse> {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
-      abortController,
       ...params
     } = options;
     const {columns, sortBy, sortDirection, offset = 0, limit = 10} = params;
@@ -355,7 +355,7 @@ export abstract class WidgetRemoteSource<
         limit,
         offset,
       },
-      opts: {abortController, headers: this._headers},
+      opts: {signal, headers: this._headers},
     }).then((res: TableModelResponse) => ({
       // Avoid `normalizeObjectKeys()`, which changes column names.
       rows: res.rows ?? (res as any).ROWS,
@@ -367,9 +367,9 @@ export abstract class WidgetRemoteSource<
     options: TimeSeriesRequestOptions
   ): Promise<TimeSeriesResponse> {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
-      abortController,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
@@ -418,7 +418,7 @@ export abstract class WidgetRemoteSource<
         splitByCategoryLimit,
         splitByCategoryValues,
       },
-      opts: {abortController, headers: this._headers},
+      opts: {signal, headers: this._headers},
     }).then((res: TimeSeriesModelResponse) => ({
       rows: normalizeObjectKeys(res.rows),
       categories: res.metadata?.categories,

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

@@ -50,6 +50,17 @@ export abstract class WidgetSource<Props extends WidgetSourceProps> {
     this.props = {...WidgetSource.defaultProps, ...props};
   }
 
+  /**
+   * Destroys the widget source and releases allocated resources.
+   *
+   * For remote sources (tables, queries) this has no effect, but for local
+   * sources (tilesets, rasters) these resources will affect performance
+   * and stability if many (10+) sources are created and not released.
+   */
+  destroy() {
+    // no-op in most cases, but required for worker sources.
+  }
+
   protected _getSpatialFiltersResolution(
     source: Omit<ModelSource, 'type' | 'data'>,
     spatialFilter?: SpatialFilter,