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

package/build/api-client.cjs

@@ -433,7 +433,6 @@ __export(src_exports, {
   WidgetSource: () => WidgetSource,
   WidgetTableSource: () => WidgetTableSource,
   WidgetTilesetSource: () => WidgetTilesetSource,
-  WidgetTilesetWorkerSource: () => WidgetTilesetWorkerSource,
   _buildFeatureFilter: () => _buildFeatureFilter,
   _getHexagonResolution: () => _getHexagonResolution,
   addFilter: () => addFilter,
@@ -2105,6 +2104,15 @@ var _WidgetSource = class _WidgetSource {
     __publicField(this, "props");
     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() {
+  }
   _getSpatialFiltersResolution(source, spatialFilter, referenceViewState) {
     if (!spatialFilter || source.spatialDataType === "geo") {
       return;
@@ -2180,7 +2188,7 @@ async function makeCall({
         method: opts?.method,
         body: opts?.body
       },
-      signal: opts?.abortController?.signal,
+      signal: opts?.signal,
       ...opts?.otherOptions
     });
     data = await response.json();
@@ -2315,12 +2323,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;
@@ -2343,17 +2351,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;
@@ -2379,18 +2387,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;
@@ -2414,17 +2422,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;
@@ -2443,7 +2451,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);
@@ -2456,12 +2464,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;
@@ -2480,17 +2488,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;
@@ -2516,17 +2524,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;
@@ -2551,7 +2559,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,
@@ -2560,9 +2568,9 @@ var WidgetRemoteSource = class extends WidgetSource {
   }
   async getTimeSeries(options) {
     const {
+      signal,
       filters = this.props.filters,
       filterOwner,
-      abortController,
       spatialFilter,
       spatialFiltersMode,
       spatialIndexReferenceViewState,
@@ -2604,7 +2612,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
@@ -2639,6 +2647,9 @@ var WidgetTableSource = class extends WidgetRemoteSource {
 // src/widget-sources/widget-tileset-source.ts
 init_cjs_shims();
 
+// src/widget-sources/widget-tileset-source-impl.ts
+init_cjs_shims();
+
 // src/operations/aggregation.ts
 init_cjs_shims();
 var aggregationFunctions = {
@@ -2987,9 +2998,9 @@ function scatterPlot({
   );
 }
 
-// src/widget-sources/widget-tileset-source.ts
+// src/widget-sources/widget-tileset-source-impl.ts
 var import_boolean_equal = require("@turf/boolean-equal");
-var WidgetTilesetSource = class extends WidgetSource {
+var WidgetTilesetSourceImpl = class extends WidgetSource {
   constructor() {
     super(...arguments);
     __publicField(this, "_tiles", []);
@@ -3274,40 +3285,56 @@ function normalizeColumns(columns) {
   return Array.isArray(columns) ? columns : typeof columns === "string" ? [columns] : [];
 }
 
-// src/widget-sources/widget-tileset-worker-source.ts
-init_cjs_shims();
-var WidgetTilesetWorkerSource = class extends WidgetSource {
+// src/widget-sources/widget-tileset-source.ts
+var WidgetTilesetSource = class extends WidgetSource {
   constructor(props) {
     super(props);
-    /////////////////////////////////////////////////////////////////////////////
-    // WEB WORKER MANAGEMENT
-    __publicField(this, "_worker", null);
+    __publicField(this, "_localImpl", null);
+    __publicField(this, "_workerImpl", null);
+    __publicField(this, "_workerEnabled");
     __publicField(this, "_workerNextRequestId", 1);
+    this._workerEnabled = (props.widgetSourceWorker ?? true) && false;
+    this._localImpl = this._workerEnabled ? null : new WidgetTilesetSourceImpl(this.props);
+  }
+  destroy() {
+    this._localImpl?.destroy();
+    this._localImpl = null;
+    this._workerImpl?.terminate();
+    this._workerImpl = null;
+    super.destroy();
   }
+  /////////////////////////////////////////////////////////////////////////////
+  // WEB WORKER MANAGEMENT
   /**
    * Returns an initialized Worker, to be reused for the lifecycle of this
    * source instance.
    */
   _getWorker() {
-    if (this._worker) {
-      return this._worker;
+    if (this._workerImpl || this._localImpl) {
+      return this._workerImpl;
     }
-    this._worker = new Worker(
-      new URL("@carto/api-client/worker", importMetaUrl),
-      {
+    try {
+      this._workerImpl = new Worker(new URL("worker.js", importMetaUrl), {
         type: "module",
         name: "cartowidgettileset"
-      }
-    );
-    this._worker.postMessage({
-      method: "init" /* INIT */,
-      params: [this.props]
-    });
-    return this._worker;
+      });
+      this._workerImpl.postMessage({
+        method: "init" /* INIT */,
+        params: [this.props]
+      });
+      return this._workerImpl;
+    } catch {
+      this._workerEnabled = false;
+      this._localImpl = new WidgetTilesetSourceImpl(this.props);
+      return null;
+    }
   }
   /** Executes a given method on the worker. */
   _executeWorkerMethod(method, params, signal) {
     const worker = this._getWorker();
+    if (!worker) {
+      return this._localImpl[method](...params);
+    }
     const requestId = this._workerNextRequestId++;
     const options = params[0];
     if (options?.spatialIndexReferenceViewState) {
@@ -3355,19 +3382,27 @@ var WidgetTilesetWorkerSource = class extends WidgetSource {
    * before computing statistics on the tiles.
    */
   loadTiles(tiles2) {
+    const worker = this._getWorker();
+    if (!worker) {
+      return this._localImpl.loadTiles(tiles2);
+    }
     tiles2 = tiles2.map(({ id, bbox, data }) => ({
       id,
       bbox,
       data
     }));
-    this._getWorker().postMessage({
+    worker.postMessage({
       method: "loadTiles" /* LOAD_TILES */,
       params: [tiles2]
     });
   }
   /** Configures options used to extract features from tiles. */
   setTileFeatureExtractOptions(options) {
-    this._getWorker().postMessage({
+    const worker = this._getWorker();
+    if (!worker) {
+      return this._localImpl?.setTileFeatureExtractOptions(options);
+    }
+    worker.postMessage({
       type: "setTileFeatureExtractOptions" /* SET_TILE_FEATURE_EXTRACT_OPTIONS */,
       params: [options]
     });
@@ -3381,7 +3416,11 @@ var WidgetTilesetWorkerSource = class extends WidgetSource {
     geojson,
     spatialFilter
   }) {
-    this._getWorker().postMessage({
+    const worker = this._getWorker();
+    if (!worker) {
+      return this._localImpl.loadGeoJSON({ geojson, spatialFilter });
+    }
+    worker.postMessage({
       method: "loadGeoJSON" /* LOAD_GEOJSON */,
       params: [{ geojson, spatialFilter }]
     });
@@ -3393,74 +3432,46 @@ var WidgetTilesetWorkerSource = class extends WidgetSource {
     throw new Error("getFeatures not supported for tilesets");
   }
   async getFormula({
-    abortController,
+    signal,
     ...options
   }) {
-    return this._executeWorkerMethod(
-      "getFormula" /* GET_FORMULA */,
-      [options],
-      abortController?.signal
-    );
+    return this._executeWorkerMethod("getFormula" /* GET_FORMULA */, [options], signal);
   }
   async getHistogram({
-    abortController,
+    signal,
     ...options
   }) {
-    return this._executeWorkerMethod(
-      "getHistogram" /* GET_HISTOGRAM */,
-      [options],
-      abortController?.signal
-    );
+    return this._executeWorkerMethod("getHistogram" /* GET_HISTOGRAM */, [options], signal);
   }
   async getCategories({
-    abortController,
+    signal,
     ...options
   }) {
-    return this._executeWorkerMethod(
-      "getCategories" /* GET_CATEGORIES */,
-      [options],
-      abortController?.signal
-    );
+    return this._executeWorkerMethod("getCategories" /* GET_CATEGORIES */, [options], signal);
   }
   async getScatter({
-    abortController,
+    signal,
     ...options
   }) {
-    return this._executeWorkerMethod(
-      "getScatter" /* GET_SCATTER */,
-      [options],
-      abortController?.signal
-    );
+    return this._executeWorkerMethod("getScatter" /* GET_SCATTER */, [options], signal);
   }
   async getTable({
-    abortController,
+    signal,
     ...options
   }) {
-    return this._executeWorkerMethod(
-      "getTable" /* GET_TABLE */,
-      [options],
-      abortController?.signal
-    );
+    return this._executeWorkerMethod("getTable" /* GET_TABLE */, [options], signal);
   }
   async getTimeSeries({
-    abortController,
+    signal,
     ...options
   }) {
-    return this._executeWorkerMethod(
-      "getTimeSeries" /* GET_TIME_SERIES */,
-      [options],
-      abortController?.signal
-    );
+    return this._executeWorkerMethod("getTimeSeries" /* GET_TIME_SERIES */, [options], signal);
   }
   async getRange({
-    abortController,
+    signal,
     ...options
   }) {
-    return this._executeWorkerMethod(
-      "getRange" /* GET_RANGE */,
-      [options],
-      abortController?.signal
-    );
+    return this._executeWorkerMethod("getRange" /* GET_RANGE */, [options], signal);
   }
 };
 
@@ -3549,36 +3560,14 @@ function getTileFormat(tilejson) {
   return tileParams.get("formatTiles") === "mvt" ? "mvt" /* MVT */ : "binary" /* BINARY */;
 }
 
-// src/workers/utils.ts
-init_cjs_shims();
-var _isModuleWorkerSupported = true ? false : null;
-function isModuleWorkerSupported() {
-  if (_isModuleWorkerSupported !== null) {
-    return _isModuleWorkerSupported;
-  }
-  try {
-    new Worker("blob://", {
-      get type() {
-        _isModuleWorkerSupported = true;
-        return "module";
-      }
-    });
-  } catch {
-  } finally {
-    _isModuleWorkerSupported || (_isModuleWorkerSupported = false);
-  }
-  return _isModuleWorkerSupported;
-}
-
 // src/sources/h3-tileset-source.ts
 var h3TilesetSource = async function(options) {
   const { tableName, spatialDataColumn = "h3" } = options;
   const urlParameters = { name: tableName };
-  const WidgetSourceClass = options.widgetSourceWorker !== false && isModuleWorkerSupported() ? WidgetTilesetWorkerSource : WidgetTilesetSource;
   return baseSource("tileset", options, urlParameters).then(
     (result) => ({
       ...result,
-      widgetSource: new WidgetSourceClass({
+      widgetSource: new WidgetTilesetSource({
         ...options,
         tileFormat: getTileFormat(result),
         spatialDataColumn,
@@ -3684,11 +3673,10 @@ init_cjs_shims();
 var quadbinTilesetSource = async function(options) {
   const { tableName, spatialDataColumn = "quadbin" } = options;
   const urlParameters = { name: tableName };
-  const WidgetSourceClass = options.widgetSourceWorker !== false && isModuleWorkerSupported() ? WidgetTilesetWorkerSource : WidgetTilesetSource;
   return baseSource("tileset", options, urlParameters).then(
     (result) => ({
       ...result,
-      widgetSource: new WidgetSourceClass({
+      widgetSource: new WidgetTilesetSource({
         ...options,
         tileFormat: getTileFormat(result),
         spatialDataColumn,
@@ -3789,11 +3777,10 @@ init_cjs_shims();
 var vectorTilesetSource = async function(options) {
   const { tableName, spatialDataColumn = DEFAULT_GEO_COLUMN } = options;
   const urlParameters = { name: tableName };
-  const WidgetSourceClass = options.widgetSourceWorker !== false && isModuleWorkerSupported() ? WidgetTilesetWorkerSource : WidgetTilesetSource;
   return baseSource("tileset", options, urlParameters).then(
     (result) => ({
       ...result,
-      widgetSource: new WidgetSourceClass({
+      widgetSource: new WidgetTilesetSource({
         ...options,
         tileFormat: getTileFormat(result),
         spatialDataColumn,
@@ -3859,7 +3846,6 @@ var query = async function(options) {
   WidgetSource,
   WidgetTableSource,
   WidgetTilesetSource,
-  WidgetTilesetWorkerSource,
   _buildFeatureFilter,
   _getHexagonResolution,
   addFilter,