@carto/api-client 0.5.3 → 0.5.4-alpha.1

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.3",
+  "version": "0.5.4-alpha.1",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -128,5 +128,6 @@
   "resolutions": {
     "@carto/api-client": "portal:./",
     "rollup": "^4.20.0"
-  }
+  },
+  "stableVersion": "0.5.3"
 }

package/src/filters/tileFeatures.ts

@@ -22,7 +22,7 @@ export type TileFeatures = {
   spatialFilter: SpatialFilter;
   uniqueIdProperty?: string;
   rasterMetadata?: RasterMetadata;
-  options?: TileFeatureExtractOptions;
+  storeGeometry?: boolean;
 };
 
 /** @privateRemarks Source: @carto/react-core */
@@ -42,7 +42,7 @@ export function tileFeatures({
   spatialDataColumn = DEFAULT_GEO_COLUMN,
   spatialDataType,
   rasterMetadata,
-  options = {},
+  storeGeometry = false,
 }: TileFeatures): FeatureData[] {
   if (spatialDataType === 'geo') {
     return tileFeaturesGeometries({
@@ -50,7 +50,7 @@ export function tileFeatures({
       tileFormat,
       spatialFilter,
       uniqueIdProperty,
-      options,
+      options: {storeGeometry},
     });
   }
 

package/src/filters/tileFeaturesGeometries.ts

@@ -16,7 +16,6 @@ import type {
   Position,
 } from 'geojson';
 import type {SpatialFilter, Tile} from '../types.js';
-import type {TileFeatureExtractOptions} from './tileFeatures.js';
 import {featureCollection} from '@turf/helpers';
 import type {FeatureData} from '../types-internal.js';
 import type {
@@ -39,6 +38,10 @@ type TileDataInternal = {
   numericProps: Record<string, number>;
 };
 
+type GeometryExtractOptions = {
+  storeGeometry?: boolean;
+};
+
 export function tileFeaturesGeometries({
   tiles,
   tileFormat,
@@ -50,7 +53,7 @@ export function tileFeaturesGeometries({
   tileFormat?: TileFormat;
   spatialFilter: SpatialFilter;
   uniqueIdProperty?: string;
-  options?: {storeGeometry?: boolean};
+  options?: GeometryExtractOptions;
 }): FeatureData[] {
   const map = new Map();
 
@@ -212,7 +215,7 @@ function addIntersectedFeaturesInTile({
   bbox: BBox;
   tileFormat?: TileFormat;
   uniqueIdProperty?: string;
-  options?: TileFeatureExtractOptions;
+  options?: GeometryExtractOptions;
 }) {
   const indices = getIndices(data, type);
   const storeGeometry = options?.storeGeometry || false;
@@ -364,7 +367,7 @@ function calculateFeatures({
   bbox: BBox;
   tileFormat?: TileFormat;
   uniqueIdProperty?: string;
-  options?: TileFeatureExtractOptions;
+  options?: GeometryExtractOptions;
 }) {
   if (!data?.properties.length) {
     return;
@@ -409,7 +412,7 @@ function addAllFeaturesInTile({
   bbox: BBox;
   tileFormat?: TileFormat;
   uniqueIdProperty?: string;
-  options?: TileFeatureExtractOptions;
+  options?: GeometryExtractOptions;
 }) {
   const indices = getIndices(data, type);
   const storeGeometry = options?.storeGeometry || false;

package/src/sources/h3-query-source.ts

@@ -3,6 +3,7 @@
 // Copyright (c) vis.gl contributors
 
 import {DEFAULT_AGGREGATION_RES_LEVEL_H3} from '../constants-internal.js';
+import {getWidgetSpatialDataType} from '../utils.js';
 import {
   WidgetQuerySource,
   type WidgetQuerySourceResult,
@@ -72,7 +73,11 @@ export const h3QuerySource = async function (
         ...options,
         // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType,
+        spatialDataType: getWidgetSpatialDataType(
+          spatialDataType,
+          spatialDataColumn,
+          result.schema
+        ),
       }),
     })
   );

package/src/sources/h3-table-source.ts

@@ -3,6 +3,7 @@
 // Copyright (c) vis.gl contributors
 
 import {DEFAULT_AGGREGATION_RES_LEVEL_H3} from '../constants-internal.js';
+import {getWidgetSpatialDataType} from '../utils.js';
 import {
   WidgetTableSource,
   type WidgetTableSourceResult,
@@ -67,7 +68,11 @@ export const h3TableSource = async function (
         ...options,
         // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType,
+        spatialDataType: getWidgetSpatialDataType(
+          spatialDataType,
+          spatialDataColumn,
+          result.schema
+        ),
       }),
     })
   );

package/src/sources/quadbin-query-source.ts

@@ -3,6 +3,7 @@
 // Copyright (c) vis.gl contributors
 
 import {DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN} from '../constants-internal.js';
+import {getWidgetSpatialDataType} from '../utils.js';
 import {
   WidgetQuerySource,
   type WidgetQuerySourceResult,
@@ -73,7 +74,11 @@ export const quadbinQuerySource = async function (
         ...options,
         // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType,
+        spatialDataType: getWidgetSpatialDataType(
+          spatialDataType,
+          spatialDataColumn,
+          result.schema
+        ),
       }),
     })
   );

package/src/sources/quadbin-table-source.ts

@@ -3,6 +3,7 @@
 // Copyright (c) vis.gl contributors
 
 import {DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN} from '../constants-internal.js';
+import {getWidgetSpatialDataType} from '../utils.js';
 import {
   WidgetTableSource,
   type WidgetTableSourceResult,
@@ -68,7 +69,11 @@ export const quadbinTableSource = async function (
         ...options,
         // NOTE: Parameters with default values above must be explicitly passed here.
         spatialDataColumn,
-        spatialDataType,
+        spatialDataType: getWidgetSpatialDataType(
+          spatialDataType,
+          spatialDataColumn,
+          result.schema
+        ),
       }),
     })
   );

package/src/utils.ts

@@ -1,5 +1,6 @@
-import type {Filter} from './types.js';
+import {SchemaFieldType, type Filter, type SchemaField} from './types.js';
 import {FilterType} from './constants.js';
+import type {SpatialDataType} from './sources/types.js';
 
 const FILTER_TYPES = new Set(Object.values(FilterType));
 const isFilterType = (type: string): type is FilterType =>
@@ -127,3 +128,21 @@ export function assignOptional<T extends object, U>(
   }
   return target as T & U;
 }
+
+/**
+ * Returns the spatialDataType expected for widget operations, given layer source props. The
+ * spatialDataType used in widget operations may be different from that of the layer. For
+ * dynamically aggregated point datasets, widgets use type 'geo', not the aggregation type.
+ */
+export function getWidgetSpatialDataType(
+  spatialDataType: SpatialDataType,
+  spatialDataColumn: string,
+  schema: SchemaField[]
+): SpatialDataType {
+  const field = schema.find((field) => field.name === spatialDataColumn);
+  if (field && field.type === SchemaFieldType.Geometry) {
+    return 'geo';
+  }
+
+  return spatialDataType;
+}