@carto/api-client 0.5.15-alpha.raster-0 → 0.5.15-alpha.raster-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.15-alpha.raster-0",
+  "version": "0.5.15-alpha.raster-1",
   "license": "MIT",
   "publishConfig": {
     "access": "public"

package/src/fetch-map/basemap-styles.ts

@@ -92,7 +92,7 @@ export const STYLE_LAYER_GROUPS: StyleLayerGroup[] = [
 ];
 
 export function applyLayerGroupFilters(
-  style: any,
+  style: any, // this Maplibre/Mapbox style, we don't want to add a dependency on Maplibre
   visibleLayerGroups: Record<StyleLayerGroupSlug, boolean>
 ) {
   if (!Array.isArray(style?.layers)) {

package/src/fetch-map/index.ts

@@ -1,4 +1,7 @@
-export {default as BASEMAP} from './basemap-styles.js';
+export {
+  default as BASEMAP,
+  applyLayerGroupFilters as _applyLayerGroupFilters,
+} from './basemap-styles.js';
 export {getRasterTileLayerStyleProps as _getRasterTileLayerStyleProps} from './raster-layer.js';
 export {fetchMap} from './fetch-map.js';
 export type {FetchMapOptions, FetchMapResult} from './fetch-map.js';

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

@@ -39,7 +39,7 @@ import type {
 import type {ProviderType, SchemaField} from '../types.js';
 import {DEFAULT_AGGREGATION_EXP_ALIAS} from '../constants-internal.js';
 import {AggregationTypes} from '../constants.js';
-import type {TilejsonResult} from '../sources/types.js';
+import type {Attribute, TilejsonResult} from '../sources/types.js';
 
 export type D3Scale = {
   domain: (d?: any) => any[];
@@ -211,10 +211,10 @@ export function getLayerProps(
 }
 
 function domainFromAttribute(
-  attribute: any,
+  attribute: Attribute,
   scaleType: ScaleType,
   scaleLength: number
-) {
+): number[] | string[] {
   if (scaleType === 'ordinal' || scaleType === 'point') {
     if (!attribute.categories) {
       return [0, 1];
@@ -225,7 +225,7 @@ function domainFromAttribute(
   }
 
   if (scaleType === 'quantile' && attribute.quantiles) {
-    return attribute.quantiles.global
+    return 'global' in attribute.quantiles
       ? attribute.quantiles.global[scaleLength]
       : attribute.quantiles[scaleLength];
   }
@@ -234,7 +234,7 @@ function domainFromAttribute(
   if (scaleType === 'log' && min === 0) {
     min = 1e-5;
   }
-  return [min, attribute.max];
+  return [min ?? 0, attribute.max ?? 1];
 }
 
 function domainFromValues(values: any, scaleType: ScaleType) {
@@ -263,7 +263,9 @@ function calculateDomain(
     // Tileset data type
     const {attributes} = data.tilestats.layers[0];
     const attribute = attributes.find((a: any) => a.attribute === name);
-    return domainFromAttribute(attribute, scaleType, scaleLength as number);
+    if (attribute) {
+      return domainFromAttribute(attribute, scaleType, scaleLength as number);
+    }
   }
 
   return [0, 1];
@@ -318,7 +320,7 @@ export function getColorAccessor(
   scaleType: ScaleType,
   {aggregation, range}: {aggregation: string; range: any},
   opacity: number | undefined,
-  data: any
+  data: TilejsonResult
 ): {accessor: any; scale: any} {
   const scale = calculateLayerScale(
     colorColumn || name,
@@ -456,7 +458,7 @@ export function getSizeAccessor(
   scaleType: ScaleType | undefined,
   aggregation: string | null | undefined,
   range: Iterable<Range> | null | undefined,
-  data: any
+  data: TilejsonResult
 ): {accessor: any; scale: any} {
   const scale = scaleType ? SCALE_FUNCS[scaleType]() : identity;
   if (scaleType) {

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

@@ -36,6 +36,7 @@ import {
   getRasterTileLayerStylePropsRgb,
   getRasterTileLayerStylePropsScaledBand,
 } from './raster-layer.js';
+import type {TilejsonResult} from '../sources/types.js';
 
 export type Scale = {
   field: VisualChannelField;
@@ -257,7 +258,7 @@ function createChannelProps(
   layerType: LayerType,
   config: MapLayerConfig,
   visualChannels: VisualChannels,
-  data: any,
+  data: TilejsonResult,
   dataset: Dataset
 ): {
   channelProps: Record<string, any>;
@@ -270,15 +271,24 @@ function createChannelProps(
     radiusScale,
     strokeColorField,
     strokeColorScale,
+    sizeField: strokeWidthField,
+    sizeScale: strokeWidthScale,
     weightField,
   } = visualChannels;
   if (layerType === 'raster') {
+    const rasterMetadata = data.raster_metadata;
+    if (!rasterMetadata) {
+      return {
+        channelProps: {},
+        scales: {},
+      };
+    }
     const rasterStyleType = config.visConfig.rasterStyleType;
     if (rasterStyleType === 'Rgb') {
       return {
         channelProps: getRasterTileLayerStylePropsRgb({
           layerConfig: config,
-          rasterMetadata: data.raster_metadata,
+          rasterMetadata,
           visualChannels,
         }),
         scales: {},
@@ -288,7 +298,7 @@ function createChannelProps(
         channelProps: getRasterTileLayerStylePropsScaledBand({
           layerConfig: config,
           visualChannels,
-          rasterMetadata: data.raster_metadata,
+          rasterMetadata,
         }),
         scales: {
           ...(colorField && {
@@ -427,6 +437,22 @@ function createChannelProps(
       ...domainAndRangeFromScale(scale),
     };
   }
+  if (strokeWidthField) {
+    const {accessor, scale} = getSizeAccessor(
+      strokeWidthField,
+      strokeWidthScale,
+      visConfig.sizeAggregation,
+      visConfig.sizeRange,
+      data
+    );
+    result.getLineWidth = accessor;
+    scales.lineWidth = updateTriggers.getLineWidth = {
+      field: strokeWidthField,
+      type: strokeWidthScale || 'identity',
+      ...domainAndRangeFromScale(scale),
+    };
+  }
+
   if (heightField && visConfig.enable3d) {
     const {accessor, scale} = getSizeAccessor(
       heightField,

package/src/index.ts

@@ -2,11 +2,6 @@ export * from './client.js';
 export * from './constants.js';
 export * from './deck/index.js';
 export * from './fetch-map/index.js';
-export type {
-  LayerDescriptor,
-  LayerType,
-  _getRasterTileLayerStyleProps,
-} from './fetch-map/index.js';
 export {
   createVecExprEvaluator as _createVecExprEvaluator,
   evaluateVecExpr as _evaluateVecExpr,

package/src/sources/types.ts

@@ -292,14 +292,64 @@ export interface Tilestats {
 
 export interface Layer {
   layer: string;
+  /** Number of features in the layer. */
   count: number;
+
+  /** Number of attributes in the layer. */
   attributeCount: number;
   attributes: Attribute[];
+
+  /** Type of geometry as in geojson geometry type (Point, LineString, Polygon, etc.) */
+  geometry?: string;
+}
+
+export interface AttributeCategoryItem {
+  category: string;
+  frequency: number;
+}
+
+/**
+ * Quantiles by number of buckets.
+ *
+ * Example:
+ * ```ts
+ *   {
+ *     // for 3 buckets, first 1/3 of items lies in range [min, 20], second 1/3 is in [20, 40], and last 1/3 is in [40, max]
+ *     3: [20, 40],
+ *     4: [20, 30, 50], for 4 buckets ...
+ *   }
+ * ```
+ */
+export interface QuantileStats {
+  [bucketCount: number]: number[];
 }
 
 export interface Attribute {
-  attribute: string;
+  /**
+   * String, Number, Timestamp, Boolean
+   */
   type: string;
+
+  /**
+   * Attribute name.
+   */
+  attribute: string;
+
+  // Stats for numeric attributes
+  min?: number;
+  max?: number;
+  sum?: number;
+
+  /** Quantiles by number of buckets */
+  quantiles?:
+    | {
+        // Quantile stats for numeric attributes in static spatial index tilesets are enclosed in extra global object
+        global: QuantileStats;
+      }
+    | QuantileStats;
+
+  // Stats for string/boolean attributes
+  categories?: AttributeCategoryItem[];
 }
 
 export interface VectorLayer {
@@ -325,17 +375,8 @@ export type RasterMetadataBandStats = {
 
   /**
    * Quantiles by number of buckets.
-   *
-   * Example:
-   * ```ts
-   *   {
-   *     // for 3 buckets, first 1/3 of items lies in range [min, 20], second 1/3 is in [20, 40], and last 1/3 is in [40, max]
-   *     3: [20, 40],
-   *     4: [20, 30, 50], for 4 buckets ...
-   *   }
-   * ```
    */
-  quantiles?: Record<number, number[]>;
+  quantiles?: QuantileStats;
 
   /**
    * Top values by number of values.