@carto/api-client 0.5.0-alpha.5 → 0.5.0-alpha.7

package/build/api-client.js

@@ -41,7 +41,7 @@ import {
   tileFeaturesGeometries,
   tileFeaturesSpatialIndex,
   transformToTileCoords
-} from "./chunk-V3E7BKVR.js";
+} from "./chunk-LEI5PI5X.js";
 
 // src/deck/get-data-filter-extension-props.ts
 function getDataFilterExtensionProps(filters, filtersLogicalOperator, filterSize) {
@@ -653,7 +653,7 @@ async function makeCall({
         method: opts?.method,
         body: opts?.body
       },
-      signal: opts?.abortController?.signal,
+      signal: opts?.signal,
       ...opts?.otherOptions
     });
     data = await response.json();
@@ -788,12 +788,12 @@ var WidgetRemoteSource = class extends WidgetSource {
   }
   async getCategories(options) {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
-      abortController,
       ...params
     } = options;
     const { column, operation, operationColumn } = params;
@@ -816,17 +816,17 @@ var WidgetRemoteSource = class extends WidgetSource {
         operation,
         operationColumn: operationColumn || column
       },
-      opts: { abortController, headers: this._headers }
+      opts: { signal, headers: this._headers }
     }).then((res) => normalizeObjectKeys(res.rows));
   }
   async getFeatures(options) {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
-      abortController,
       ...params
     } = options;
     const { columns, dataType, featureIds, z, limit, tileResolution } = params;
@@ -852,18 +852,18 @@ var WidgetRemoteSource = class extends WidgetSource {
         limit: limit || 1e3,
         tileResolution: tileResolution || DEFAULT_TILE_RESOLUTION
       },
-      opts: { abortController, headers: this._headers }
+      opts: { signal, headers: this._headers }
       // Avoid `normalizeObjectKeys()`, which changes column names.
     }).then(({ rows }) => ({ rows }));
   }
   async getFormula(options) {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
-      abortController,
       operationExp,
       ...params
     } = options;
@@ -887,17 +887,17 @@ var WidgetRemoteSource = class extends WidgetSource {
         operation: operation ?? "count",
         operationExp
       },
-      opts: { abortController, headers: this._headers }
+      opts: { signal, headers: this._headers }
     }).then((res) => normalizeObjectKeys(res.rows[0]));
   }
   async getHistogram(options) {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
-      abortController,
       ...params
     } = options;
     const { column, operation, ticks } = params;
@@ -916,7 +916,7 @@ var WidgetRemoteSource = class extends WidgetSource {
         spatialFilter
       },
       params: { column, operation, ticks },
-      opts: { abortController, headers: this._headers }
+      opts: { signal, headers: this._headers }
     }).then((res) => normalizeObjectKeys(res.rows));
     if (data.length) {
       const result = Array(ticks.length + 1).fill(0);
@@ -929,12 +929,12 @@ var WidgetRemoteSource = class extends WidgetSource {
   }
   async getRange(options) {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
-      abortController,
       ...params
     } = options;
     const { column } = params;
@@ -953,17 +953,17 @@ var WidgetRemoteSource = class extends WidgetSource {
         spatialFilter
       },
       params: { column },
-      opts: { abortController, headers: this._headers }
+      opts: { signal, headers: this._headers }
     }).then((res) => normalizeObjectKeys(res.rows[0]));
   }
   async getScatter(options) {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
-      abortController,
       ...params
     } = options;
     const { xAxisColumn, xAxisJoinOperation, yAxisColumn, yAxisJoinOperation } = params;
@@ -989,17 +989,17 @@ var WidgetRemoteSource = class extends WidgetSource {
         yAxisJoinOperation,
         limit: HARD_LIMIT
       },
-      opts: { abortController, headers: this._headers }
+      opts: { signal, headers: this._headers }
     }).then((res) => normalizeObjectKeys(res.rows)).then((res) => res.map(({ x, y }) => [x, y]));
   }
   async getTable(options) {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
-      abortController,
       ...params
     } = options;
     const { columns, sortBy, sortDirection, offset = 0, limit = 10 } = params;
@@ -1024,7 +1024,7 @@ var WidgetRemoteSource = class extends WidgetSource {
         limit,
         offset
       },
-      opts: { abortController, headers: this._headers }
+      opts: { signal, headers: this._headers }
     }).then((res) => ({
       // Avoid `normalizeObjectKeys()`, which changes column names.
       rows: res.rows ?? res.ROWS,
@@ -1033,9 +1033,9 @@ var WidgetRemoteSource = class extends WidgetSource {
   }
   async getTimeSeries(options) {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
-      abortController,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
@@ -1077,7 +1077,7 @@ var WidgetRemoteSource = class extends WidgetSource {
         splitByCategoryLimit,
         splitByCategoryValues
       },
-      opts: { abortController, headers: this._headers }
+      opts: { signal, headers: this._headers }
     }).then((res) => ({
       rows: normalizeObjectKeys(res.rows),
       categories: res.metadata?.categories
@@ -1109,16 +1109,79 @@ var WidgetTableSource = class extends WidgetRemoteSource {
 };
 
 // src/widget-sources/widget-tileset-worker-source.ts
-var _WidgetTilesetWorkerSource = class _WidgetTilesetWorkerSource extends WidgetSource {
+var WidgetTilesetWorkerSource = class extends WidgetSource {
   constructor(props) {
     super(props);
-    _WidgetTilesetWorkerSource.init();
-    _WidgetTilesetWorkerSource.WORKER.postMessage({
-      tableName: this.props.tableName,
+    /////////////////////////////////////////////////////////////////////////////
+    // WEB WORKER MANAGEMENT
+    __publicField(this, "_worker", null);
+    __publicField(this, "_workerNextRequestId", 1);
+  }
+  /**
+   * Returns an initialized Worker, to be reused for the lifecycle of this
+   * source instance.
+   */
+  _getWorker() {
+    if (this._worker) {
+      return this._worker;
+    }
+    this._worker = new Worker(
+      new URL("@carto/api-client/worker", import.meta.url),
+      {
+        type: "module",
+        name: "cartowidgettileset"
+      }
+    );
+    this._worker.postMessage({
       method: "init" /* INIT */,
       params: [this.props]
     });
+    return this._worker;
   }
+  /** Executes a given method on the worker. */
+  _executeWorkerMethod(method, params, signal) {
+    const worker = this._getWorker();
+    const requestId = this._workerNextRequestId++;
+    const options = params[0];
+    if (options?.spatialIndexReferenceViewState) {
+      const { zoom, latitude, longitude } = options.spatialIndexReferenceViewState;
+      options.spatialIndexReferenceViewState = { zoom, latitude, longitude };
+    }
+    let resolve = null;
+    let reject = null;
+    function onMessage(e) {
+      const response = e.data;
+      if (response.requestId !== requestId) return;
+      if (signal?.aborted) {
+        reject(new Error(signal.reason));
+      } else if (response.ok) {
+        resolve(response.result);
+      } else {
+        reject(new Error(response.error));
+      }
+    }
+    function onAbort() {
+      reject(new Error(signal.reason));
+    }
+    worker.addEventListener("message", onMessage);
+    signal?.addEventListener("abort", onAbort);
+    const promise = new Promise((_resolve, _reject) => {
+      resolve = _resolve;
+      reject = _reject;
+      worker.postMessage({
+        requestId,
+        method,
+        params
+      });
+    });
+    void promise.finally(() => {
+      worker.removeEventListener("message", onMessage);
+      signal?.removeEventListener("abort", onAbort);
+    });
+    return promise;
+  }
+  /////////////////////////////////////////////////////////////////////////////
+  // DATA LOADING
   /**
    * Loads features as a list of tiles (typically provided by deck.gl).
    * After tiles are loaded, {@link extractTileFeatures} must be called
@@ -1130,16 +1193,14 @@ var _WidgetTilesetWorkerSource = class _WidgetTilesetWorkerSource extends Widget
       bbox,
       data
     }));
-    _WidgetTilesetWorkerSource.WORKER.postMessage({
-      tableName: this.props.tableName,
+    this._getWorker().postMessage({
       method: "loadTiles" /* LOAD_TILES */,
       params: [tiles]
     });
   }
   /** Configures options used to extract features from tiles. */
   setTileFeatureExtractOptions(options) {
-    _WidgetTilesetWorkerSource.WORKER.postMessage({
-      tableName: this.props.tableName,
+    this._getWorker().postMessage({
       type: "setTileFeatureExtractOptions" /* SET_TILE_FEATURE_EXTRACT_OPTIONS */,
       params: [options]
     });
@@ -1153,139 +1214,60 @@ var _WidgetTilesetWorkerSource = class _WidgetTilesetWorkerSource extends Widget
     geojson,
     spatialFilter
   }) {
-    _WidgetTilesetWorkerSource.WORKER.postMessage({
-      tableName: this.props.tableName,
+    this._getWorker().postMessage({
       method: "loadGeoJSON" /* LOAD_GEOJSON */,
       params: [{ geojson, spatialFilter }]
     });
   }
+  /////////////////////////////////////////////////////////////////////////////
+  // WIDGETS API
   // eslint-disable-next-line @typescript-eslint/require-await
   async getFeatures() {
     throw new Error("getFeatures not supported for tilesets");
   }
   async getFormula({
-    abortController,
+    signal,
     ...options
   }) {
-    return this._executeWorkerMethod(
-      this.props.tableName,
-      "getFormula" /* GET_FORMULA */,
-      [options],
-      abortController?.signal
-    );
+    return this._executeWorkerMethod("getFormula" /* GET_FORMULA */, [options], signal);
   }
   async getHistogram({
-    abortController,
+    signal,
     ...options
   }) {
-    return this._executeWorkerMethod(
-      this.props.tableName,
-      "getHistogram" /* GET_HISTOGRAM */,
-      [options],
-      abortController?.signal
-    );
+    return this._executeWorkerMethod("getHistogram" /* GET_HISTOGRAM */, [options], signal);
   }
   async getCategories({
-    abortController,
+    signal,
     ...options
   }) {
-    return this._executeWorkerMethod(
-      this.props.tableName,
-      "getCategories" /* GET_CATEGORIES */,
-      [options],
-      abortController?.signal
-    );
+    return this._executeWorkerMethod("getCategories" /* GET_CATEGORIES */, [options], signal);
   }
   async getScatter({
-    abortController,
+    signal,
     ...options
   }) {
-    return this._executeWorkerMethod(
-      this.props.tableName,
-      "getScatter" /* GET_SCATTER */,
-      [options],
-      abortController?.signal
-    );
+    return this._executeWorkerMethod("getScatter" /* GET_SCATTER */, [options], signal);
   }
   async getTable({
-    abortController,
+    signal,
     ...options
   }) {
-    return this._executeWorkerMethod(
-      this.props.tableName,
-      "getTable" /* GET_TABLE */,
-      [options],
-      abortController?.signal
-    );
+    return this._executeWorkerMethod("getTable" /* GET_TABLE */, [options], signal);
   }
   async getTimeSeries({
-    abortController,
+    signal,
     ...options
   }) {
-    return this._executeWorkerMethod(
-      this.props.tableName,
-      "getTimeSeries" /* GET_TIME_SERIES */,
-      [options],
-      abortController?.signal
-    );
+    return this._executeWorkerMethod("getTimeSeries" /* GET_TIME_SERIES */, [options], signal);
   }
   async getRange({
-    abortController,
+    signal,
     ...options
   }) {
-    return this._executeWorkerMethod(
-      this.props.tableName,
-      "getRange" /* GET_RANGE */,
-      [options],
-      abortController?.signal
-    );
-  }
-  static init() {
-    _WidgetTilesetWorkerSource.WORKER = new Worker(
-      new URL("@carto/api-client/worker", import.meta.url),
-      {
-        type: "module",
-        name: "cartowidgettileset"
-      }
-    );
-  }
-  _executeWorkerMethod(tableName, method, params, signal) {
-    const worker = _WidgetTilesetWorkerSource.WORKER;
-    const requestId = _WidgetTilesetWorkerSource._nextRequestID++;
-    const options = params[0];
-    if (options?.spatialIndexReferenceViewState) {
-      const { zoom, latitude, longitude } = options.spatialIndexReferenceViewState;
-      options.spatialIndexReferenceViewState = { zoom, latitude, longitude };
-    }
-    worker.postMessage({
-      requestId,
-      tableName,
-      method,
-      params
-    });
-    return new Promise((resolve, reject) => {
-      function listener(e) {
-        const response = e.data;
-        if (response.requestId !== requestId) return;
-        worker.removeEventListener("message", listener);
-        if (signal?.aborted) {
-          reject(new Error(signal.reason));
-        } else if (response.ok) {
-          resolve(response.result);
-        } else {
-          reject(new Error(response.error));
-        }
-      }
-      worker.addEventListener("message", listener);
-    });
+    return this._executeWorkerMethod("getRange" /* GET_RANGE */, [options], signal);
   }
 };
-/////////////////////////////////////////////////////////////////////////////
-// WEB WORKER MANAGEMENT
-// TODO: Singleton? Pool shared among datasets? One per dataset?
-__publicField(_WidgetTilesetWorkerSource, "WORKER");
-__publicField(_WidgetTilesetWorkerSource, "_nextRequestID", 1);
-var WidgetTilesetWorkerSource = _WidgetTilesetWorkerSource;
 
 // src/sources/h3-query-source.ts
 var h3QuerySource = async function(options) {

package/build/worker.js

@@ -1,19 +1,17 @@
 import {
   WidgetTilesetSource
-} from "./chunk-V3E7BKVR.js";
+} from "./chunk-LEI5PI5X.js";
 
 // src/workers/widget-tileset-worker.ts
-var SOURCES_BY_NAME = /* @__PURE__ */ new Map();
+var source;
 addEventListener("message", (e) => {
-  const { tableName, method, params, requestId } = e.data;
+  const { method, params, requestId } = e.data;
   if (method === "init" /* INIT */) {
-    const props = params[0];
-    SOURCES_BY_NAME.set(tableName, new WidgetTilesetSource(props));
+    source = new WidgetTilesetSource(params[0]);
     return;
   }
-  const source = SOURCES_BY_NAME.get(tableName);
   if (!source) {
-    const error = `Unknown dataset: ${tableName}`;
+    const error = `Cannot execute "${method}" on uninitialized source.`;
     postMessage({ ok: false, error, requestId });
     return;
   }

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.5",
+  "version": "0.5.0-alpha.7",
   "license": "MIT",
-  "publishConfig": {
-    "access": "public",
-    "tag": "alpha"
-  },
   "type": "module",
   "sideEffects": false,
   "exports": {

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/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,