@carto/api-client 0.5.0-alpha.11 → 0.5.0-alpha.13

package/build/api-client.d.cts

@@ -225,13 +225,23 @@ type _DataFilterExtensionProps = {
 };
 /**
  * Creates props for DataFilterExtension, from `@deck.gl/extensions`, given
- * a set of filters.
+ * a set of filters. Requires that DataFilterExtension is initialized with
+ * filterSize=4, where the CARTO filters will occupy the first two slots.
  *
- * @privateRemarks DataFilterExtension accepts up to 4 values to filter. This
- *  implementation uses the 1st for all filters except the time filter, and the
- *  2nd for the time filter.
+ * @example To create a deck.gl layer with GPU data filtering:
+ * ```typescript
+ * import {DataFilterExtension} from '@deck.gl/extensions';
+ * import {VectorTileLayer} from '@deck.gl/layers';
+ * import {getDataFilterExtensionProps} from '@carto/api-client';
+ *
+ * const layer = new VectorTileLayer({
+ *  data: data,
+ *  extensions: [new DataFilterExtension({filterSize: 4})],
+ *  ...getDataFilterExtensionProps(filters),
+ * });
+ * ```
  */
-declare function getDataFilterExtensionProps(filters: Filters, filtersLogicalOperator?: FilterLogicalOperator, filterSize?: 0 | 1 | 2 | 3 | 4): _DataFilterExtensionProps;
+declare function getDataFilterExtensionProps(filters: Filters, filtersLogicalOperator?: FilterLogicalOperator): _DataFilterExtensionProps;
 
 type FilterTypeOptions<T extends FilterType> = {
     type: T;

package/build/api-client.d.ts

@@ -225,13 +225,23 @@ type _DataFilterExtensionProps = {
 };
 /**
  * Creates props for DataFilterExtension, from `@deck.gl/extensions`, given
- * a set of filters.
+ * a set of filters. Requires that DataFilterExtension is initialized with
+ * filterSize=4, where the CARTO filters will occupy the first two slots.
  *
- * @privateRemarks DataFilterExtension accepts up to 4 values to filter. This
- *  implementation uses the 1st for all filters except the time filter, and the
- *  2nd for the time filter.
+ * @example To create a deck.gl layer with GPU data filtering:
+ * ```typescript
+ * import {DataFilterExtension} from '@deck.gl/extensions';
+ * import {VectorTileLayer} from '@deck.gl/layers';
+ * import {getDataFilterExtensionProps} from '@carto/api-client';
+ *
+ * const layer = new VectorTileLayer({
+ *  data: data,
+ *  extensions: [new DataFilterExtension({filterSize: 4})],
+ *  ...getDataFilterExtensionProps(filters),
+ * });
+ * ```
  */
-declare function getDataFilterExtensionProps(filters: Filters, filtersLogicalOperator?: FilterLogicalOperator, filterSize?: 0 | 1 | 2 | 3 | 4): _DataFilterExtensionProps;
+declare function getDataFilterExtensionProps(filters: Filters, filtersLogicalOperator?: FilterLogicalOperator): _DataFilterExtensionProps;
 
 type FilterTypeOptions<T extends FilterType> = {
     type: T;

package/build/api-client.js

@@ -1241,11 +1241,11 @@ function tileFeatures({
 }
 
 // src/deck/get-data-filter-extension-props.ts
-function getDataFilterExtensionProps(filters, filtersLogicalOperator, filterSize) {
-  filterSize ?? (filterSize = 4);
+var DEFAULT_FILTER_SIZE = 4;
+function getDataFilterExtensionProps(filters, filtersLogicalOperator) {
   const { filtersWithoutTimeType, timeColumn, timeFilter } = getFiltersByType(filters);
   return {
-    filterRange: getFilterRange(timeFilter, filterSize),
+    filterRange: getFilterRange(timeFilter, DEFAULT_FILTER_SIZE),
     updateTriggers: getUpdateTriggers(
       filtersWithoutTimeType,
       timeColumn,
@@ -1255,7 +1255,7 @@ function getDataFilterExtensionProps(filters, filtersLogicalOperator, filterSize
       filtersWithoutTimeType,
       timeColumn,
       timeFilter,
-      filterSize,
+      DEFAULT_FILTER_SIZE,
       filtersLogicalOperator
     )
   };
@@ -3143,9 +3143,8 @@ var WidgetTilesetSource = class extends WidgetSource {
     function onMessage(e) {
       const response = e.data;
       if (response.requestId !== requestId) return;
-      if (signal?.aborted) {
-        reject(new Error(signal.reason));
-      } else if (response.ok) {
+      if (signal?.aborted) return;
+      if (response.ok) {
         resolve(response.result);
       } else {
         reject(new Error(response.error));