@carto/api-client 0.5.27-alpha.482101a.112 → 0.5.27

package/CHANGELOG.md

@@ -1,7 +1,8 @@
 # CHANGELOG
 
-## Unreleased
+### 0.5.27
 
+- feat(parseMap): custom aggregation support on spatial-index and geometry-aggregated layers. Adds `compileCustomAggregation(expression, { provider })` helper, `VisualChannelField.accessorKey`, and `{channel}AggregationExp` / `{channel}AggregationDomain` on `VisConfig` for all 6 channels.
 - chore(ci): add prerelease support to release workflow (#274)
 
 ### 0.5.26

package/build/api-client.cjs

@@ -154,6 +154,7 @@ __export(src_exports, {
   calculateLayerScale: () => calculateLayerScale,
   clearDefaultRequestCache: () => clearDefaultRequestCache,
   clearFilters: () => clearFilters,
+  compileCustomAggregation: () => compileCustomAggregation,
   configureSource: () => configureSource,
   createColorScale: () => createColorScale,
   createPolygonSpatialFilter: () => createPolygonSpatialFilter,
@@ -9936,15 +9937,22 @@ function findAccessorKey(keys, properties) {
   }
   return keys;
 }
-function getColorAccessor({ name, colorColumn }, scaleType, { aggregation, range }, opacity, data) {
+function getColorAccessor({ name, colorColumn, accessorKey }, scaleType, {
+  aggregation,
+  range,
+  domainOverride
+}, opacity, data) {
+  const effectiveName = accessorKey ?? colorColumn ?? name;
+  const effectiveScaleType = colorColumn && !accessorKey ? "identity" : scaleType;
   const { scale: scale2, domain } = calculateLayerScale(
-    colorColumn || name,
-    colorColumn ? "identity" : scaleType,
+    effectiveName,
+    effectiveScaleType,
     range,
-    data
+    data,
+    domainOverride
   );
   const alpha = opacityToAlpha(opacity);
-  let accessorKeys = getAccessorKeys(colorColumn || name, aggregation);
+  let accessorKeys = accessorKey ? [accessorKey] : getAccessorKeys(colorColumn || name, aggregation);
   const accessor = (properties) => {
     if (!(accessorKeys[0] in properties)) {
       accessorKeys = findAccessorKey(accessorKeys, properties);
@@ -9961,11 +9969,11 @@ function getColorAccessor({ name, colorColumn }, scaleType, { aggregation, range
     range: (scale2.range() || []).map(rgbToHex)
   };
 }
-function calculateLayerScale(name, scaleType, range, data) {
+function calculateLayerScale(name, scaleType, range, data, domainOverride) {
   let scaleDomain;
   let scaleColors = [];
   const { colors } = range;
-  const domain = calculateDomain(data, name, scaleType, colors.length);
+  const domain = domainOverride && !range.colorMap ? domainOverride : calculateDomain(data, name, scaleType, colors.length);
   if (scaleType !== "identity") {
     if (range.colorMap) {
       const { colorMap } = range;
@@ -10050,19 +10058,20 @@ function negateAccessor(accessor) {
   }
   return -accessor;
 }
-function getSizeAccessor({ name }, scaleType, aggregation, range, data) {
+function getSizeAccessor({ name, accessorKey }, scaleType, aggregation, range, data, domainOverride) {
   const scale2 = scaleType ? SCALE_FUNCS[scaleType]() : identity2;
   let domain = [];
   if (scaleType && range) {
     if (aggregation !== AggregationTypes.Count) {
-      domain = calculateDomain(data, name, scaleType);
+      const source = accessorKey ?? name;
+      domain = domainOverride ?? calculateDomain(data, source, scaleType);
       scale2.domain(domain);
     } else {
       domain = scale2.domain();
     }
     scale2.range(range);
   }
-  let accessorKeys = getAccessorKeys(name, aggregation);
+  let accessorKeys = accessorKey ? [accessorKey] : getAccessorKeys(name, aggregation);
   const accessor = (properties) => {
     if (!(accessorKeys[0] in properties)) {
       accessorKeys = findAccessorKey(accessorKeys, properties);
@@ -10109,9 +10118,30 @@ function getDefaultAggregationExpColumnAliasForLayerType(layerType, provider, sc
     return DEFAULT_AGGREGATION_EXP_ALIAS;
   }
 }
+function hashString(input) {
+  let h = 2166136261;
+  for (let i = 0; i < input.length; i++) {
+    h ^= input.charCodeAt(i);
+    h = Math.imul(h, 16777619);
+  }
+  return (h >>> 0).toString(16).padStart(8, "0");
+}
+function normalizeExpression(exp) {
+  return exp.trim().replace(/\s+/g, " ");
+}
+function applyProviderCase(alias, provider) {
+  return provider === "snowflake" ? alias.toUpperCase() : alias;
+}
 function getColumnAliasForAggregationExp(name, aggregation, provider) {
-  const columnAlias = `${name}_${aggregation}`;
-  return provider === "snowflake" ? columnAlias.toUpperCase() : columnAlias;
+  return applyProviderCase(`${name}_${aggregation}`, provider);
+}
+function compileCustomAggregation(exp, opts) {
+  const normalized = normalizeExpression(exp);
+  if (!normalized) {
+    throw new Error("Custom aggregation expression must not be empty");
+  }
+  const hash2 = hashString(normalized);
+  return applyProviderCase("custom_agg_" + hash2, opts.provider);
 }
 function getDefaultColumnFromSchemaForAggregationExp(schema) {
   return schema ? schema[0].name : "";
@@ -10639,6 +10669,26 @@ function createStyleProps(config2, mapping) {
   result.highlightColor = config2.visConfig.enable3d ? [255, 255, 255, 60] : [252, 242, 26, 255];
   return result;
 }
+function resolveCustomAggregation({
+  field,
+  aggregation,
+  expression,
+  domain,
+  providerId
+}) {
+  if (aggregation !== "custom") {
+    return { field, aggregation, domainOverride: void 0 };
+  }
+  if (!field || !expression?.trim()) {
+    return { field, aggregation: void 0, domainOverride: void 0 };
+  }
+  const alias = compileCustomAggregation(expression, { provider: providerId });
+  return {
+    field: { ...field, accessorKey: alias },
+    aggregation: void 0,
+    domainOverride: domain
+  };
+}
 function createChannelProps(id, layerType, config2, visualChannels, data, dataset) {
   if (layerType === "raster") {
     const rasterMetadata = data.raster_metadata;
@@ -10687,18 +10737,25 @@ function createChannelProps(id, layerType, config2, visualChannels, data, datase
   const scales = {};
   {
     const { colorField, colorScale } = visualChannels;
-    const { colorRange, colorAggregation } = visConfig;
-    if (colorField && colorScale && colorRange) {
+    const { colorRange } = visConfig;
+    const { field, aggregation, domainOverride } = resolveCustomAggregation({
+      field: colorField,
+      aggregation: visConfig.colorAggregation,
+      expression: visConfig.colorAggregationExp,
+      domain: visConfig.colorAggregationDomain,
+      providerId: dataset.providerId
+    });
+    if (field && colorScale && colorRange) {
       const { accessor, ...scaleProps } = getColorAccessor(
-        colorField,
+        field,
         colorScale,
-        { aggregation: colorAggregation, range: colorRange },
+        { aggregation, range: colorRange, domainOverride },
         visConfig.opacity,
         data
       );
       result.getFillColor = accessor;
       scales.fillColor = updateTriggers.getFillColor = {
-        field: colorField,
+        field,
         type: colorScale,
         ...scaleProps
       };
@@ -10758,40 +10815,54 @@ function createChannelProps(id, layerType, config2, visualChannels, data, datase
     };
   }
   {
-    const radiusRange = visConfig.radiusRange;
     const { radiusField, radiusScale } = visualChannels;
-    if (radiusField && radiusRange && radiusScale) {
+    const { radiusRange } = visConfig;
+    const { field, aggregation, domainOverride } = resolveCustomAggregation({
+      field: radiusField,
+      aggregation: visConfig.radiusAggregation,
+      expression: visConfig.radiusAggregationExp,
+      domain: visConfig.radiusAggregationDomain,
+      providerId: dataset.providerId
+    });
+    if (field && radiusRange && radiusScale) {
       const { accessor, ...scaleProps } = getSizeAccessor(
-        radiusField,
+        field,
         radiusScale,
-        visConfig.radiusAggregation,
+        aggregation,
         radiusRange,
-        data
+        data,
+        domainOverride
       );
       result.getPointRadius = accessor;
       scales.pointRadius = updateTriggers.getPointRadius = {
-        field: radiusField,
+        field,
         type: radiusScale,
         ...scaleProps
       };
     }
   }
   {
-    const strokeColorRange = visConfig.strokeColorRange;
     const { strokeColorScale, strokeColorField } = visualChannels;
-    if (strokeColorField && strokeColorRange && strokeColorScale) {
-      const { strokeColorAggregation: aggregation } = visConfig;
+    const { strokeColorRange } = visConfig;
+    const { field, aggregation, domainOverride } = resolveCustomAggregation({
+      field: strokeColorField,
+      aggregation: visConfig.strokeColorAggregation,
+      expression: visConfig.strokeColorAggregationExp,
+      domain: visConfig.strokeColorAggregationDomain,
+      providerId: dataset.providerId
+    });
+    if (field && strokeColorRange && strokeColorScale) {
       const opacity = visConfig.strokeOpacity !== void 0 ? visConfig.strokeOpacity : 1;
       const { accessor, ...scaleProps } = getColorAccessor(
-        strokeColorField,
+        field,
         strokeColorScale,
-        { aggregation, range: strokeColorRange },
+        { aggregation, range: strokeColorRange, domainOverride },
         opacity,
         data
       );
       result.getLineColor = accessor;
       scales.lineColor = updateTriggers.getLineColor = {
-        field: strokeColorField,
+        field,
         type: strokeColorScale,
         ...scaleProps
       };
@@ -10799,37 +10870,53 @@ function createChannelProps(id, layerType, config2, visualChannels, data, datase
   }
   {
     const { sizeField: strokeWidthField, sizeScale: strokeWidthScale } = visualChannels;
-    const { sizeRange, sizeAggregation } = visConfig;
-    if (strokeWidthField && sizeRange) {
+    const { sizeRange } = visConfig;
+    const { field, aggregation, domainOverride } = resolveCustomAggregation({
+      field: strokeWidthField,
+      aggregation: visConfig.sizeAggregation,
+      expression: visConfig.sizeAggregationExp,
+      domain: visConfig.sizeAggregationDomain,
+      providerId: dataset.providerId
+    });
+    if (field && sizeRange) {
       const { accessor, ...scaleProps } = getSizeAccessor(
-        strokeWidthField,
+        field,
         strokeWidthScale,
-        sizeAggregation,
+        aggregation,
         sizeRange,
-        data
+        data,
+        domainOverride
       );
       result.getLineWidth = accessor;
       scales.lineWidth = updateTriggers.getLineWidth = {
-        field: strokeWidthField,
+        field,
         type: strokeWidthScale || "identity",
         ...scaleProps
       };
     }
   }
   {
-    const { enable3d, heightRange } = visConfig;
     const { heightField, heightScale } = visualChannels;
-    if (heightField && heightRange && enable3d) {
+    const { enable3d, heightRange } = visConfig;
+    const { field, aggregation, domainOverride } = resolveCustomAggregation({
+      field: heightField,
+      aggregation: visConfig.heightAggregation,
+      expression: visConfig.heightAggregationExp,
+      domain: visConfig.heightAggregationDomain,
+      providerId: dataset.providerId
+    });
+    if (field && heightRange && enable3d) {
       const { accessor, ...scaleProps } = getSizeAccessor(
-        heightField,
+        field,
         heightScale,
-        visConfig.heightAggregation,
+        aggregation,
         heightRange,
-        data
+        data,
+        domainOverride
       );
       result.getElevation = accessor;
       scales.elevation = updateTriggers.getElevation = {
-        field: heightField,
+        field,
         type: heightScale || "identity",
         ...scaleProps
       };
@@ -10837,18 +10924,25 @@ function createChannelProps(id, layerType, config2, visualChannels, data, datase
   }
   {
     const { weightField } = visualChannels;
-    const { weightAggregation } = visConfig;
-    if (weightField && weightAggregation) {
+    const { field, aggregation, domainOverride } = resolveCustomAggregation({
+      field: weightField,
+      aggregation: visConfig.weightAggregation,
+      expression: visConfig.weightAggregationExp,
+      domain: visConfig.weightAggregationDomain,
+      providerId: dataset.providerId
+    });
+    if (field && (aggregation || visConfig.weightAggregation === "custom")) {
       const { accessor, ...scaleProps } = getSizeAccessor(
-        weightField,
+        field,
         void 0,
-        weightAggregation,
+        aggregation,
         void 0,
-        data
+        data,
+        domainOverride
       );
       result.getWeight = accessor;
       scales.weight = updateTriggers.getWeight = {
-        field: weightField,
+        field,
         type: "identity",
         ...scaleProps
       };
@@ -11653,6 +11747,7 @@ function hashBuckets(initialCount) {
   calculateLayerScale,
   clearDefaultRequestCache,
   clearFilters,
+  compileCustomAggregation,
   configureSource,
   createColorScale,
   createPolygonSpatialFilter,