@carto/api-client 0.5.26 → 0.5.27-alpha.dd7e837.114

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.26",
+  "version": "0.5.27-alpha.dd7e837.114",
   "license": "MIT",
   "publishConfig": {
     "access": "public"

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

@@ -342,9 +342,17 @@ function findAccessorKey(keys: string[], properties: any): string[] {
 }
 
 export function getColorAccessor(
-  {name, colorColumn}: VisualChannelField,
+  {name, colorColumn, accessorKey}: VisualChannelField,
   scaleType: ScaleType,
-  {aggregation, range}: {aggregation?: string; range: ColorRange},
+  {
+    aggregation,
+    range,
+    domainOverride,
+  }: {
+    aggregation?: string;
+    range: ColorRange;
+    domainOverride?: [number, number];
+  },
   opacity: number | undefined,
   data: TilejsonResult
 ): {
@@ -353,15 +361,23 @@ export function getColorAccessor(
   scaleDomain: number[] | string[];
   range: string[];
 } {
+  // accessorKey (custom-agg alias) wins over colorColumn (legacy identity-color
+  // column), which wins over name (standard field).
+  const effectiveName = accessorKey ?? colorColumn ?? name;
+  const effectiveScaleType =
+    colorColumn && !accessorKey ? 'identity' : scaleType;
   const {scale, 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: any) => {
     if (!(accessorKeys[0] in properties)) {
       accessorKeys = findAccessorKey(accessorKeys, properties);
@@ -383,13 +399,20 @@ export function calculateLayerScale(
   name: string,
   scaleType: ScaleType,
   range: ColorRange,
-  data: TilejsonResult
+  data: TilejsonResult,
+  domainOverride?: [number, number]
 ): {scale: D3Scale; domain: string[] | number[]} {
   let scaleDomain: number[] | string[] | undefined;
   let scaleColors: string[] = [];
   const {colors} = range;
 
-  const domain = calculateDomain(data, name, scaleType, colors.length);
+  // colorMap (explicit break values from Custom classification) wins over
+  // domainOverride (user Min/Max for Custom aggregation). colorMap defines
+  // its own domain, so the override does not apply.
+  const domain =
+    domainOverride && !range.colorMap
+      ? domainOverride
+      : calculateDomain(data, name, scaleType, colors.length);
   if (scaleType !== 'identity') {
     if (range.colorMap) {
       const {colorMap} = range;
@@ -506,11 +529,12 @@ export function negateAccessor(accessor: Accessor): Accessor {
 }
 
 export function getSizeAccessor(
-  {name}: VisualChannelField,
+  {name, accessorKey}: VisualChannelField,
   scaleType: ScaleType | undefined,
   aggregation: string | null | undefined,
   range: number[] | undefined,
-  data: TilejsonResult
+  data: TilejsonResult,
+  domainOverride?: [number, number]
 ): {
   accessor: any;
   domain: number[];
@@ -521,7 +545,10 @@ export function getSizeAccessor(
   let domain: number[] = [];
   if (scaleType && range) {
     if (aggregation !== AggregationTypes.Count) {
-      domain = calculateDomain(data, name, scaleType) as number[];
+      const source = accessorKey ?? name;
+      domain =
+        domainOverride ??
+        (calculateDomain(data, source, scaleType) as number[]);
       (scale as D3Scale).domain(domain);
     } else {
       domain = (scale as D3Scale).domain();
@@ -529,7 +556,9 @@ export function getSizeAccessor(
     (scale as D3Scale).range(range);
   }
 
-  let accessorKeys = getAccessorKeys(name, aggregation);
+  let accessorKeys = accessorKey
+    ? [accessorKey]
+    : getAccessorKeys(name, aggregation);
   const accessor = (properties: any) => {
     if (!(accessorKeys[0] in properties)) {
       accessorKeys = findAccessorKey(accessorKeys, properties);
@@ -597,14 +626,42 @@ export function getDefaultAggregationExpColumnAliasForLayerType(
   }
 }
 
+function hashString(input: string): string {
+  let h = 0x811c9dc5;
+  for (let i = 0; i < input.length; i++) {
+    h ^= input.charCodeAt(i);
+    h = Math.imul(h, 0x01000193);
+  }
+  return (h >>> 0).toString(16).padStart(8, '0');
+}
+
+function normalizeExpression(exp: string): string {
+  return exp.trim().replace(/\s+/g, ' ');
+}
+
+function applyProviderCase(alias: string, provider: ProviderType): string {
+  return provider === 'snowflake' ? alias.toUpperCase() : alias;
+}
+
 /** @privateRemarks Source: Builder */
 function getColumnAliasForAggregationExp(
   name: string,
   aggregation: string,
   provider: ProviderType
 ) {
-  const columnAlias = `${name}_${aggregation}`;
-  return provider === 'snowflake' ? columnAlias.toUpperCase() : columnAlias;
+  return applyProviderCase(`${name}_${aggregation}`, provider);
+}
+
+export function compileCustomAggregation(
+  exp: string,
+  opts: {provider: ProviderType}
+): string {
+  const normalized = normalizeExpression(exp);
+  if (!normalized) {
+    throw new Error('Custom aggregation expression must not be empty');
+  }
+  const hash = hashString(normalized);
+  return applyProviderCase('custom_agg_' + hash, opts.provider);
 }
 
 /** @privateRemarks Source: Builder */

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

@@ -2,6 +2,7 @@ import type {ColorParameters} from '@luma.gl/core';
 import {
   calculateClusterRadius,
   calculateClusterTextFontSize,
+  compileCustomAggregation,
   getDefaultAggregationExpColumnAliasForLayerType,
   getLayerProps,
   getColorAccessor,
@@ -35,6 +36,7 @@ import {
   getRasterTileLayerStylePropsRgb,
   getRasterTileLayerStylePropsScaledBand,
 } from './raster-layer.js';
+import type {ProviderType} from '../types.js';
 import type {TilejsonResult} from '../sources/types.js';
 
 export type Scale = {
@@ -53,6 +55,7 @@ export type ScaleKey =
   | 'fillColor'
   | 'pointRadius'
   | 'lineColor'
+  | 'lineWidth'
   | 'elevation'
   | 'weight';
 
@@ -250,6 +253,37 @@ function createStyleProps(config: MapLayerConfig, mapping: any) {
   return result;
 }
 
+function resolveCustomAggregation({
+  field,
+  aggregation,
+  expression,
+  domain,
+  providerId,
+}: {
+  field: VisualChannelField | undefined;
+  aggregation: string | undefined;
+  expression: string | undefined;
+  domain: [number, number] | undefined;
+  providerId: ProviderType;
+}): {
+  field: VisualChannelField | undefined;
+  aggregation: string | undefined;
+  domainOverride: [number, number] | undefined;
+} {
+  if (aggregation !== 'custom') {
+    return {field, aggregation, domainOverride: undefined};
+  }
+  if (!field || !expression?.trim()) {
+    return {field, aggregation: undefined, domainOverride: undefined};
+  }
+  const alias = compileCustomAggregation(expression, {provider: providerId});
+  return {
+    field: {...field, accessorKey: alias},
+    aggregation: undefined,
+    domainOverride: domain,
+  };
+}
+
 function createChannelProps(
   id: string,
   layerType: LayerType,
@@ -313,18 +347,25 @@ function createChannelProps(
   // fill color
   {
     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,
       };
@@ -398,44 +439,57 @@ function createChannelProps(
 
   // point radius
   {
-    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,
       };
     }
   }
 
-  // stroke/ouline color
+  // stroke/outline color
   {
-    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 !== undefined ? 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,
       };
@@ -446,19 +500,26 @@ function createChannelProps(
   {
     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,
       };
@@ -467,19 +528,27 @@ function createChannelProps(
 
   // height / elevation
   {
-    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,
       };
@@ -489,18 +558,25 @@ function createChannelProps(
   // weight
   {
     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,
         undefined,
-        weightAggregation,
+        aggregation,
         undefined,
-        data
+        data,
+        domainOverride
       );
       result.getWeight = accessor;
       scales.weight = updateTriggers.getWeight = {
-        field: weightField,
+        field,
         type: 'identity' as ScaleType,
         ...scaleProps,
       };

package/src/fetch-map/types.ts

@@ -6,6 +6,7 @@ export type VisualChannelField = {
   name: string;
   type: string;
   colorColumn?: string;
+  accessorKey?: string;
 };
 
 export type VisualChannels = {
@@ -65,6 +66,8 @@ export type VisConfig = {
   enable3d?: boolean;
 
   colorAggregation?: string;
+  colorAggregationExp?: string;
+  colorAggregationDomain?: [number, number];
   colorRange: ColorRange;
 
   customMarkers?: boolean;
@@ -74,18 +77,28 @@ export type VisConfig = {
   radius: number;
   radiusRange?: number[];
   radiusAggregation?: string;
+  radiusAggregationExp?: string;
+  radiusAggregationDomain?: [number, number];
 
   sizeAggregation?: string;
+  sizeAggregationExp?: string;
+  sizeAggregationDomain?: [number, number];
   sizeRange?: number[];
 
   strokeColorAggregation?: string;
+  strokeColorAggregationExp?: string;
+  strokeColorAggregationDomain?: [number, number];
   strokeOpacity?: number;
   strokeColorRange?: ColorRange;
 
   heightRange?: number[];
   heightAggregation?: string;
+  heightAggregationExp?: string;
+  heightAggregationDomain?: [number, number];
 
   weightAggregation?: string;
+  weightAggregationExp?: string;
+  weightAggregationDomain?: [number, number];
 
   // type = clusterTile
   clusterLevel?: number;