@carto/api-client 0.5.1 → 0.5.2-alpha.0

package/package.json

@@ -8,7 +8,7 @@
   "homepage": "https://github.com/CartoDB/carto-api-client#readme",
   "author": "Don McCurdy <donmccurdy@carto.com>",
   "packageManager": "yarn@4.3.1",
-  "version": "0.5.1",
+  "version": "0.5.2-alpha.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -127,5 +127,6 @@
   "resolutions": {
     "@carto/api-client": "portal:./",
     "rollup": "^4.20.0"
-  }
+  },
+  "stableVersion": "0.5.1"
 }

package/src/filters.ts

@@ -2,6 +2,10 @@ import {FilterType} from './constants.js';
 import {Filter} from './types.js';
 import {isEmptyObject} from './utils.js';
 
+const FILTER_TYPES = new Set(Object.values(FilterType));
+const isFilterType = (type: string): type is FilterType =>
+  FILTER_TYPES.has(type as FilterType);
+
 type FilterTypeOptions<T extends FilterType> = {
   type: T;
   column: string;
@@ -53,7 +57,7 @@ export function removeFilter(
   }
 
   if (owner) {
-    for (const type of Object.values(FilterType)) {
+    for (const type of FILTER_TYPES) {
       if (owner === filter[type as FilterType]?.owner) {
         delete filter[type as FilterType];
       }
@@ -97,7 +101,7 @@ export function hasFilter(
     return true;
   }
 
-  for (const type of Object.values(FilterType)) {
+  for (const type of FILTER_TYPES) {
     if (owner === filter[type as FilterType]?.owner) {
       return true;
     }
@@ -127,3 +131,34 @@ export function getFilter<T extends FilterType>(
 
   return null;
 }
+
+/**
+ * Given all filters for a dataset, returns the subset of filters that are not
+ * attributable to the given owner. Typically used to allow filterable widgets
+ * to affect other widgets *without* filtering themselves.
+ *
+ * @privateRemarks Source: @carto/react-widgets
+ */
+export function getApplicableFilters(
+  owner?: string,
+  filters?: Record<string, Filter>
+): Record<string, Filter> {
+  if (!filters) return {};
+
+  const applicableFilters: Record<string, Filter> = {};
+
+  for (const column in filters) {
+    for (const type in filters[column]) {
+      if (!isFilterType(type)) continue;
+
+      const filter = filters[column][type];
+      const isApplicable = !owner || !filter?.owner || filter?.owner !== owner;
+      if (filter && isApplicable) {
+        applicableFilters[column] ||= {};
+        (applicableFilters[column][type] as typeof filter) = filter;
+      }
+    }
+  }
+
+  return applicableFilters;
+}

package/src/utils.ts

@@ -1,38 +1,3 @@
-import {Filter} from './types.js';
-import {FilterType} from './constants.js';
-
-const FILTER_TYPES = new Set(Object.values(FilterType));
-const isFilterType = (type: string): type is FilterType =>
-  FILTER_TYPES.has(type as FilterType);
-
-/**
- * @privateRemarks Source: @carto/react-widgets
- * @internal
- */
-export function getApplicableFilters(
-  owner?: string,
-  filters?: Record<string, Filter>
-): Record<string, Filter> {
-  if (!filters) return {};
-
-  const applicableFilters: Record<string, Filter> = {};
-
-  for (const column in filters) {
-    for (const type in filters[column]) {
-      if (!isFilterType(type)) continue;
-
-      const filter = filters[column][type];
-      const isApplicable = !owner || !filter?.owner || filter?.owner !== owner;
-      if (filter && isApplicable) {
-        applicableFilters[column] ||= {};
-        (applicableFilters[column][type] as typeof filter) = filter;
-      }
-    }
-  }
-
-  return applicableFilters;
-}
-
 type Row<T> = Record<string, T> | Record<string, T>[] | T[] | T;
 
 /**

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

@@ -17,11 +17,12 @@ import {
   TimeSeriesRequestOptions,
   TimeSeriesResponse,
 } from './types.js';
-import {getApplicableFilters, normalizeObjectKeys} from '../utils.js';
+import {normalizeObjectKeys} from '../utils.js';
 import {DEFAULT_TILE_RESOLUTION} from '../constants-internal.js';
 import {WidgetSource, WidgetSourceProps} from './widget-source.js';
 import {Filters} from '../types.js';
 import {ApiVersion} from '../constants.js';
+import {getApplicableFilters} from '../filters.js';
 
 export type WidgetRemoteSourceProps = WidgetSourceProps;
 

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

@@ -16,12 +16,7 @@ import {
   TimeSeriesRequestOptions,
   TimeSeriesResponse,
 } from './types.js';
-import {
-  InvalidColumnError,
-  assert,
-  assignOptional,
-  getApplicableFilters,
-} from '../utils.js';
+import {InvalidColumnError, assert, assignOptional} from '../utils.js';
 import {Filter, SpatialFilter, Tile} from '../types.js';
 import {
   TileFeatureExtractOptions,
@@ -42,6 +37,7 @@ import {FeatureCollection} from 'geojson';
 import {WidgetSource} from './widget-source.js';
 import {booleanEqual} from '@turf/boolean-equal';
 import type {WidgetTilesetSourceProps} from './widget-tileset-source.js';
+import {getApplicableFilters} from '../filters.js';
 
 // TODO(cleanup): Parameter defaults in source functions and widget API calls are
 // currently duplicated and possibly inconsistent. Consider consolidating and