@carto/api-client 0.5.2 → 0.5.4-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.2",
+  "version": "0.5.4-alpha.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -67,7 +67,7 @@
     "@types/geojson": "^7946.0.16",
     "d3-format": "^3.1.0",
     "d3-scale": "^4.0.2",
-    "h3-js": "4.2.1",
+    "h3-js": "^4.1.0",
     "quadbin": "^0.4.1-alpha.0"
   },
   "devDependencies": {
@@ -128,5 +128,6 @@
   "resolutions": {
     "@carto/api-client": "portal:./",
     "rollup": "^4.20.0"
-  }
+  },
+  "stableVersion": "0.5.3"
 }

package/src/fetch-map/layer-map.ts

@@ -35,9 +35,8 @@ import type {
   VisualChannelField,
   VisualChannels,
 } from './types.js';
-import type {ProviderType} from '../types.js';
+import type {ProviderType, SchemaField} from '../types.js';
 import {DEFAULT_AGGREGATION_EXP_ALIAS} from '../constants-internal.js';
-import type {SchemaField} from '../types-internal.js';
 
 const SCALE_FUNCS: Record<string, () => any> = {
   linear: scaleLinear,

package/src/index.ts

@@ -2,6 +2,7 @@ export * from './client.js';
 export * from './constants.js';
 export * from './deck/index.js';
 export * from './fetch-map/index.js';
+export type {LayerDescriptor, LayerType} from './fetch-map/index.js';
 export * from './filters.js';
 export * from './geo.js';
 export * from './sources/index.js';

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/sources/types.ts

@@ -2,8 +2,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import type {SchemaField} from '../types-internal.js';
-import type {Filters, QueryParameters} from '../types.js';
+import type {Filters, SchemaField, QueryParameters} from '../types.js';
 
 export type SourceRequiredOptions = {
   /** Carto platform access token. */

package/src/types-internal.ts

@@ -8,35 +8,6 @@ export type $TODO = any;
 /** @internal */
 export type $IntentionalAny = any;
 
-/******************************************************************************
- * MAP INSTANTIATION
- */
-
-/**
- * @privateRemarks Source: @deck.gl/carto
- * @internal
- */
-export enum SchemaFieldType {
-  Number = 'number',
-  Bigint = 'bigint',
-  String = 'string',
-  Geometry = 'geometry',
-  Timestamp = 'timestamp',
-  Object = 'object',
-  Boolean = 'boolean',
-  Variant = 'variant',
-  Unknown = 'unknown',
-}
-
-/**
- * @privateRemarks Source: @deck.gl/carto
- * @internal
- */
-export interface SchemaField {
-  name: string;
-  type: SchemaFieldType; // Field type in the CARTO stack, common for all providers
-}
-
 /******************************************************************************
  * LOCAL CALCULATIONS
  */

package/src/types.ts

@@ -2,6 +2,33 @@ import type {FilterType} from './constants.js';
 import type {Polygon, MultiPolygon, Feature} from 'geojson';
 import type {BinaryFeature, BinaryFeatureCollection} from '@loaders.gl/schema';
 
+/******************************************************************************
+ * MAP INSTANTIATION
+ */
+
+/**
+ * @privateRemarks Source: @deck.gl/carto
+ */
+export enum SchemaFieldType {
+  Number = 'number',
+  Bigint = 'bigint',
+  String = 'string',
+  Geometry = 'geometry',
+  Timestamp = 'timestamp',
+  Object = 'object',
+  Boolean = 'boolean',
+  Variant = 'variant',
+  Unknown = 'unknown',
+}
+
+/**
+ * @privateRemarks Source: @deck.gl/carto
+ */
+export interface SchemaField {
+  name: string;
+  type: SchemaFieldType; // Field type in the CARTO stack, common for all providers
+}
+
 /******************************************************************************
  * MAPS AND TILES
  */

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;
+}