@carto/api-client 0.5.27 → 0.5.29

package/build/api-client.d.cts

@@ -882,6 +882,10 @@ type VisConfig = {
     radiusAggregation?: string;
     radiusAggregationExp?: string;
     radiusAggregationDomain?: [number, number];
+    sizeMinPixels?: number;
+    sizeMaxPixels?: number;
+    radiusScaleWithZoom?: boolean;
+    radiusReferenceZoom?: number;
     sizeAggregation?: string;
     sizeAggregationExp?: string;
     sizeAggregationDomain?: [number, number];
@@ -903,6 +907,7 @@ type VisConfig = {
     rasterStyleType?: 'Rgb' | 'ColorRange' | 'UniqueValues';
     colorBands?: RasterLayerConfigColorBand[];
     uniqueValuesColorRange?: ColorRange;
+    textLabelUniqueIdField?: string | null;
 };
 type TextLabel = {
     field: VisualChannelField | null | undefined;
@@ -1035,6 +1040,7 @@ type Dataset = {
     name?: string | null;
     spatialIndex?: string | null;
     exportToBucketAvailable?: boolean;
+    featureBbox?: boolean;
 };
 
 type StyleLayerGroupSlug = 'label' | 'road' | 'border' | 'building' | 'water' | 'land';
@@ -1988,11 +1994,27 @@ type VectorTilesetSourceOptions = SourceOptions & TilesetSourceOptions;
 type VectorTilesetSourceResponse = TilejsonResult & WidgetTilesetSourceResult;
 declare const vectorTilesetSource: (options: VectorTilesetSourceOptions) => Promise<VectorTilesetSourceResponse>;
 
-type VectorTableSourceOptions = SourceOptions & TableSourceOptions & FilterOptions & ColumnsOption;
+type VectorTableSourceOptions = SourceOptions & TableSourceOptions & FilterOptions & ColumnsOption & {
+    /**
+     * If `true`, the server includes a `_carto_bbox` property on each polygon
+     * feature, containing the bounding box of the full (unclipped) geometry as
+     * a `"west,south,east,north"` string in WGS84. Used by clients to compute
+     * stable label positions for polygons that span multiple tiles.
+     */
+    featureBbox?: boolean;
+};
 type VectorTableSourceResponse = TilejsonResult & WidgetTableSourceResult;
 declare const vectorTableSource: (options: VectorTableSourceOptions) => Promise<VectorTableSourceResponse>;
 
-type VectorQuerySourceOptions = SourceOptions & QuerySourceOptions & FilterOptions & ColumnsOption;
+type VectorQuerySourceOptions = SourceOptions & QuerySourceOptions & FilterOptions & ColumnsOption & {
+    /**
+     * If `true`, the server includes a `_carto_bbox` property on each polygon
+     * feature, containing the bounding box of the full (unclipped) geometry as
+     * a `"west,south,east,north"` string in WGS84. Used by clients to compute
+     * stable label positions for polygons that span multiple tiles.
+     */
+    featureBbox?: boolean;
+};
 type VectorQuerySourceResponse = TilejsonResult & WidgetQuerySourceResult;
 declare const vectorQuerySource: (options: VectorQuerySourceOptions) => Promise<VectorQuerySourceResponse>;
 

package/build/api-client.d.ts

@@ -882,6 +882,10 @@ type VisConfig = {
     radiusAggregation?: string;
     radiusAggregationExp?: string;
     radiusAggregationDomain?: [number, number];
+    sizeMinPixels?: number;
+    sizeMaxPixels?: number;
+    radiusScaleWithZoom?: boolean;
+    radiusReferenceZoom?: number;
     sizeAggregation?: string;
     sizeAggregationExp?: string;
     sizeAggregationDomain?: [number, number];
@@ -903,6 +907,7 @@ type VisConfig = {
     rasterStyleType?: 'Rgb' | 'ColorRange' | 'UniqueValues';
     colorBands?: RasterLayerConfigColorBand[];
     uniqueValuesColorRange?: ColorRange;
+    textLabelUniqueIdField?: string | null;
 };
 type TextLabel = {
     field: VisualChannelField | null | undefined;
@@ -1035,6 +1040,7 @@ type Dataset = {
     name?: string | null;
     spatialIndex?: string | null;
     exportToBucketAvailable?: boolean;
+    featureBbox?: boolean;
 };
 
 type StyleLayerGroupSlug = 'label' | 'road' | 'border' | 'building' | 'water' | 'land';
@@ -1988,11 +1994,27 @@ type VectorTilesetSourceOptions = SourceOptions & TilesetSourceOptions;
 type VectorTilesetSourceResponse = TilejsonResult & WidgetTilesetSourceResult;
 declare const vectorTilesetSource: (options: VectorTilesetSourceOptions) => Promise<VectorTilesetSourceResponse>;
 
-type VectorTableSourceOptions = SourceOptions & TableSourceOptions & FilterOptions & ColumnsOption;
+type VectorTableSourceOptions = SourceOptions & TableSourceOptions & FilterOptions & ColumnsOption & {
+    /**
+     * If `true`, the server includes a `_carto_bbox` property on each polygon
+     * feature, containing the bounding box of the full (unclipped) geometry as
+     * a `"west,south,east,north"` string in WGS84. Used by clients to compute
+     * stable label positions for polygons that span multiple tiles.
+     */
+    featureBbox?: boolean;
+};
 type VectorTableSourceResponse = TilejsonResult & WidgetTableSourceResult;
 declare const vectorTableSource: (options: VectorTableSourceOptions) => Promise<VectorTableSourceResponse>;
 
-type VectorQuerySourceOptions = SourceOptions & QuerySourceOptions & FilterOptions & ColumnsOption;
+type VectorQuerySourceOptions = SourceOptions & QuerySourceOptions & FilterOptions & ColumnsOption & {
+    /**
+     * If `true`, the server includes a `_carto_bbox` property on each polygon
+     * feature, containing the bounding box of the full (unclipped) geometry as
+     * a `"west,south,east,north"` string in WGS84. Used by clients to compute
+     * stable label positions for polygons that span multiple tiles.
+     */
+    featureBbox?: boolean;
+};
 type VectorQuerySourceResponse = TilejsonResult & WidgetQuerySourceResult;
 declare const vectorQuerySource: (options: VectorQuerySourceOptions) => Promise<VectorQuerySourceResponse>;
 

package/build/api-client.js

@@ -8242,7 +8242,8 @@ var vectorQuerySource = async function(options) {
     sqlQuery,
     tileResolution = DEFAULT_TILE_RESOLUTION,
     queryParameters,
-    aggregationExp
+    aggregationExp,
+    featureBbox
   } = options;
   const spatialDataType = "geo";
   const urlParameters = {
@@ -8263,6 +8264,9 @@ var vectorQuerySource = async function(options) {
   if (aggregationExp) {
     urlParameters.aggregationExp = aggregationExp;
   }
+  if (featureBbox) {
+    urlParameters.featureBbox = true;
+  }
   return baseSource("query", options, urlParameters).then(
     (result) => ({
       ...result,
@@ -8285,7 +8289,8 @@ var vectorTableSource = async function(options) {
     spatialDataColumn = DEFAULT_GEO_COLUMN,
     tableName,
     tileResolution = DEFAULT_TILE_RESOLUTION,
-    aggregationExp
+    aggregationExp,
+    featureBbox
   } = options;
   const spatialDataType = "geo";
   const urlParameters = {
@@ -8303,6 +8308,9 @@ var vectorTableSource = async function(options) {
   if (aggregationExp) {
     urlParameters.aggregationExp = aggregationExp;
   }
+  if (featureBbox) {
+    urlParameters.featureBbox = true;
+  }
   return baseSource("table", options, urlParameters).then(
     (result) => ({
       ...result,
@@ -9699,10 +9707,11 @@ function getIconUrlAccessor(field, range, {
   return normalizeAccessor(accessor, data);
 }
 function getMaxMarkerSize(visConfig, visualChannels) {
-  const { radiusRange, radius } = visConfig;
+  const { radiusRange, radius, sizeMaxPixels } = visConfig;
   const { radiusField, sizeField } = visualChannels;
   const field = radiusField || sizeField;
-  return Math.ceil(radiusRange && field ? radiusRange[1] : radius);
+  const baseSize = radiusRange && field ? radiusRange[1] : radius;
+  return Math.ceil(sizeMaxPixels ?? baseSize);
 }
 function negateAccessor(accessor) {
   if (typeof accessor === "function") {
@@ -10213,6 +10222,7 @@ function getLayerDescriptor({
       ...createInteractionProps(interactionConfig),
       ...styleProps,
       ...channelProps,
+      ...createZoomScaleProps(config2, visualChannels),
       ...createParametersProp(layerBlending, styleProps.parameters || {}),
       // Must come after style
       ...createLoadOptions(data.accessToken)
@@ -10282,6 +10292,28 @@ function createInteractionProps(interactionConfig) {
     pickable
   };
 }
+function createZoomScaleProps(config2, visualChannels) {
+  const { visConfig } = config2;
+  if (!visConfig.radiusScaleWithZoom || visualChannels.radiusField || visualChannels.sizeField) {
+    return {};
+  }
+  const scale2 = Math.pow(2, -visConfig.radiusReferenceZoom);
+  const result = {
+    pointRadiusUnits: "common",
+    pointRadiusScale: scale2,
+    iconSizeUnits: "common",
+    iconSizeScale: scale2
+  };
+  if (visConfig.sizeMinPixels !== void 0) {
+    result.pointRadiusMinPixels = visConfig.sizeMinPixels;
+    result.iconSizeMinPixels = visConfig.sizeMinPixels;
+  }
+  if (visConfig.sizeMaxPixels !== void 0) {
+    result.pointRadiusMaxPixels = visConfig.sizeMaxPixels;
+    result.iconSizeMaxPixels = visConfig.sizeMaxPixels;
+  }
+  return result;
+}
 function mapProps(source, target, mapping) {
   for (const sourceKey in mapping) {
     const sourceValue = source[sourceKey];
@@ -10671,7 +10703,15 @@ function createChannelProps(id, layerType, config2, visualChannels, data, datase
     } = secondaryLabel || {};
     result.getText = mainLabel.field && getTextAccessor(mainLabel.field, data);
     const getSecondaryText = secondaryField && getTextAccessor(secondaryField, data);
-    result.pointType = `${result.pointType}+text`;
+    const geometry = data.tilestats?.layers?.[0]?.geometry;
+    const isLineOrPolygon = geometry === "Polygon" || geometry === "MultiPolygon" || geometry === "Line" || geometry === "LineString" || geometry === "MultiLineString";
+    if (isLineOrPolygon && (layerType === "tileset" || layerType === "mvt")) {
+      const uniqueIdProperty = visConfig.textLabelUniqueIdField;
+      result.autoLabels = uniqueIdProperty ? { uniqueIdProperty } : true;
+      result.pointType = "text";
+    } else {
+      result.pointType = `${result.pointType}+text`;
+    }
     result.textCharacterSet = "auto";
     result.textFontFamily = "Inter, sans";
     result.textFontSettings = { sdf: true };
@@ -10830,11 +10870,13 @@ function configureSource({
     tileResolution,
     ...queryParameters && { queryParameters }
   };
+  const { featureBbox } = dataset;
   const vectorOptions = {
     spatialDataColumn,
     ...columns && { columns },
     ...filters && { filters },
-    ...aggregationExp && { aggregationExp }
+    ...aggregationExp && { aggregationExp },
+    ...featureBbox && { featureBbox }
   };
   if (type === "raster") {
     return rasterSource({
@@ -11118,6 +11160,21 @@ async function fetchMap({
       }
     }
   });
+  const layers = map.keplerMapConfig.config.visState.layers;
+  const datasetsWithLabels = /* @__PURE__ */ new Set();
+  for (const layer of layers) {
+    const hasTextLabel = layer.config?.textLabel?.some(
+      (t) => t.field?.name
+    );
+    if (hasTextLabel) {
+      datasetsWithLabels.add(layer.config.dataId);
+    }
+  }
+  map.datasets.forEach((dataset) => {
+    if (datasetsWithLabels.has(dataset.id) && (dataset.type === "table" || dataset.type === "query")) {
+      dataset.featureBbox = true;
+    }
+  });
   const [basemap] = await Promise.all([
     fetchBasemapProps({ config: map.keplerMapConfig.config, errorContext }),
     // Mutates map.datasets so that dataset.data contains data