@carto/api-client 0.5.0-alpha.9 → 0.5.1-alpha.0

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

@@ -84,13 +84,10 @@ export class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePro
     }
 
     this._features = tileFeatures({
-      tiles: this._tiles,
-      tileFormat: this.props.tileFormat,
+      ...this.props,
       ...this._tileFeatureExtractOptions,
-
+      tiles: this._tiles,
       spatialFilter,
-      spatialDataColumn: this.props.spatialDataColumn,
-      spatialDataType: this.props.spatialDataType,
     });
 
     prevInputs.spatialFilter = spatialFilter;
@@ -128,15 +125,6 @@ export class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePro
     filterOwner,
     spatialFilter,
   }: FormulaRequestOptions): Promise<FormulaResponse> {
-    if (operation === 'custom') {
-      throw new Error('Custom aggregation not supported for tilesets');
-    }
-
-    // Column is required except when operation is 'count'.
-    if ((column && column !== '*') || operation !== 'count') {
-      assertColumn(this._features, column);
-    }
-
     const filteredFeatures = this._getFilteredFeatures(
       spatialFilter,
       filters,
@@ -147,6 +135,15 @@ export class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePro
       return {value: null};
     }
 
+    if (operation === 'custom') {
+      throw new Error('Custom aggregation not supported for tilesets');
+    }
+
+    // Column is required except when operation is 'count'.
+    if ((column && column !== '*') || operation !== 'count') {
+      assertColumn(this._features, column);
+    }
+
     const targetOperation = aggregationFunctions[operation];
     return {
       value: targetOperation(filteredFeatures, column, joinOperation),
@@ -347,8 +344,6 @@ export class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePro
     filterOwner,
     spatialFilter,
   }: RangeRequestOptions): Promise<RangeResponse> {
-    assertColumn(this._features, column);
-
     const filteredFeatures = this._getFilteredFeatures(
       spatialFilter,
       filters,
@@ -361,6 +356,8 @@ export class WidgetTilesetSourceImpl extends WidgetSource<WidgetTilesetSourcePro
       return null;
     }
 
+    assertColumn(this._features, column);
+
     return {
       min: aggregationFunctions.min(filteredFeatures, column),
       max: aggregationFunctions.max(filteredFeatures, column),
@@ -390,15 +387,15 @@ function assertColumn(
   features: FeatureData[],
   ...columnArgs: string[] | string[][]
 ) {
-  // TODO(cleanup): Can drop support for multiple column shapes here?
-
   // Due to the multiple column shape, we normalise it as an array with normalizeColumns
   const columns = Array.from(new Set(columnArgs.map(normalizeColumns).flat()));
 
   const featureKeys = Object.keys(features[0]);
 
+  // For backward compatibility, '' should pass column validation. For example,
+  // operation='count',operationColumn='' is accepted.
   const invalidColumns = columns.filter(
-    (column) => !featureKeys.includes(column)
+    (column) => column && !featureKeys.includes(column)
   );
 
   if (invalidColumns.length) {

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

@@ -55,18 +55,20 @@ export type WidgetTilesetSourceResult = {widgetSource: WidgetTilesetSource};
  * const { widgetSource } = await data;
  * ```
  */
-export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps> {
+export class WidgetTilesetSource<
+  Props extends WidgetTilesetSourceProps = WidgetTilesetSourceProps,
+> extends WidgetSource<Props> {
   protected _localImpl: WidgetTilesetSourceImpl | null = null;
 
   protected _workerImpl: Worker | null = null;
   protected _workerEnabled: boolean;
   protected _workerNextRequestId = 1;
 
-  constructor(props: WidgetTilesetSourceProps) {
+  constructor(props: Props) {
     super(props);
 
     this._workerEnabled =
-      (props.widgetSourceWorker ?? true) &&
+      (props.widgetWorker ?? true) &&
       TSUP_FORMAT !== 'cjs' &&
       typeof Worker !== 'undefined';
 
@@ -127,15 +129,6 @@ export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
     const worker = this._getWorker();
     const requestId = this._workerNextRequestId++;
 
-    // TODO: ViewState may contain non-serializable data, which we do not need.
-    // Remove this sanitization after sc-469614 is fixed.
-    const options = params[0] as any;
-    if (options?.spatialIndexReferenceViewState) {
-      const {zoom, latitude, longitude} =
-        options.spatialIndexReferenceViewState;
-      options.spatialIndexReferenceViewState = {zoom, latitude, longitude};
-    }
-
     let resolve: ((value: T) => void) | null = null;
     let reject: ((reason: any) => void) | null = null;
 
@@ -145,10 +138,9 @@ export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
     function onMessage(e: MessageEvent) {
       const response = e.data as WorkerResponse;
       if (response.requestId !== requestId) return;
+      if (signal?.aborted) return; // handled by 'abort' listener
 
-      if (signal?.aborted) {
-        reject!(new Error(signal.reason));
-      } else if (response.ok) {
+      if (response.ok) {
         resolve!(response.result as T);
       } else {
         reject!(new Error(response.error));
@@ -199,11 +191,22 @@ export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
 
     const worker = this._getWorker();
 
-    tiles = (tiles as Tile[]).map(({id, bbox, data}) => ({
-      id,
-      bbox,
-      data,
-    }));
+    // We cannot pass an instance of Tile2DHeader to a Web Worker, and must
+    // extract properties required for widget calculations. Note that the
+    // `tile: Tile = {...}` assignment is structured so TS will warn if any
+    // types required by the internal 'Tile' type are missing.
+    tiles = (tiles as Tile[]).map(
+      ({id, index, bbox, isVisible, data}: Tile) => {
+        const tile: Tile = {
+          id,
+          index,
+          isVisible,
+          data,
+          bbox,
+        };
+        return tile;
+      }
+    );
 
     worker.postMessage({
       method: Method.LOAD_TILES,
@@ -220,7 +223,7 @@ export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
     const worker = this._getWorker();
 
     worker.postMessage({
-      type: Method.SET_TILE_FEATURE_EXTRACT_OPTIONS,
+      method: Method.SET_TILE_FEATURE_EXTRACT_OPTIONS,
       params: [options],
     });
   }

package/src/workers/widget-tileset-worker.ts

@@ -18,7 +18,7 @@ addEventListener('message', (e) => {
   if (method === Method.INIT) {
     source = new WidgetTilesetSourceImpl({
       ...(params[0] as WidgetTilesetSourceProps),
-      widgetSourceWorker: false,
+      widgetWorker: false,
     });
     return;
   }