Stricter layer prop types (#10024)

Pessimistress · web-flow · commit 9b4f6132bad5 · 2026-02-20T12:43:17.000-08:00
diff --git a/modules/aggregation-layers/src/contour-layer/contour-layer.ts b/modules/aggregation-layers/src/contour-layer/contour-layer.ts
@@ -64,7 +64,7 @@ type _ContourLayerProps<DataT> = {
    * The grid origin
    * @default [0, 0]
    */
-  gridOrigin?: [number, number];
+  gridOrigin?: Readonly<[number, number]>;
 
   /**
    * When set to true, aggregation is performed on GPU, provided other conditions are met.
diff --git a/modules/aggregation-layers/src/grid-layer/grid-cell-layer.ts b/modules/aggregation-layers/src/grid-layer/grid-cell-layer.ts
@@ -13,15 +13,15 @@ import type {ScaleType} from '../common/types';
 
 /** Proprties added by GridCellLayer. */
 type GridCellLayerProps = {
-  cellSizeCommon: [number, number];
-  cellOriginCommon: [number, number];
-  colorDomain: [number, number];
-  colorCutoff: [number, number] | null;
+  cellSizeCommon: Readonly<[number, number]>;
+  cellOriginCommon: Readonly<[number, number]>;
+  colorDomain: Readonly<[number, number]>;
+  colorCutoff: Readonly<[number, number]> | null;
   colorRange: Color[];
   colorScaleType: ScaleType;
-  elevationDomain: [number, number];
-  elevationCutoff: [number, number] | null;
-  elevationRange: [number, number];
+  elevationDomain: Readonly<[number, number]>;
+  elevationCutoff: Readonly<[number, number]> | null;
+  elevationRange: Readonly<[number, number]>;
 };
 
 export class GridCellLayer<ExtraPropsT extends {} = {}> extends ColumnLayer<
diff --git a/modules/aggregation-layers/src/grid-layer/grid-layer-uniforms.ts b/modules/aggregation-layers/src/grid-layer/grid-layer-uniforms.ts
@@ -16,12 +16,12 @@ uniform gridUniforms {
 `;
 
 export type GridProps = {
-  colorDomain: [number, number, number, number];
+  colorDomain: Readonly<[number, number, number, number]>;
   colorRange: Texture;
-  elevationDomain: [number, number, number, number];
-  elevationRange: [number, number];
-  originCommon: [number, number];
-  sizeCommon: [number, number];
+  elevationDomain: Readonly<[number, number, number, number]>;
+  elevationRange: Readonly<[number, number]>;
+  originCommon: Readonly<[number, number]>;
+  sizeCommon: Readonly<[number, number]>;
 };
 
 export const gridUniforms = {
diff --git a/modules/aggregation-layers/src/grid-layer/grid-layer.ts b/modules/aggregation-layers/src/grid-layer/grid-layer.ts
@@ -90,7 +90,7 @@ type _GridLayerProps<DataT> = {
    * Color scale domain, default is set to the extent of aggregated weights in each cell.
    * @default [min(colorWeight), max(colorWeight)]
    */
-  colorDomain?: [number, number] | null;
+  colorDomain?: Readonly<[number, number]> | null;
 
   /**
    * Default: [colorbrewer](http://colorbrewer2.org/#type=sequential&scheme=YlOrRd&n=6) `6-class YlOrRd`
@@ -107,13 +107,13 @@ type _GridLayerProps<DataT> = {
    * Elevation scale input domain, default is set to between 0 and the max of aggregated weights in each cell.
    * @default [0, max(elevationWeight)]
    */
-  elevationDomain?: [number, number] | null;
+  elevationDomain?: Readonly<[number, number]> | null;
 
   /**
    * Elevation scale output range.
    * @default [0, 1000]
    */
-  elevationRange?: [number, number];
+  elevationRange?: Readonly<[number, number]>;
 
   /**
    * Cell elevation multiplier.
diff --git a/modules/aggregation-layers/src/heatmap-layer/heatmap-layer.ts b/modules/aggregation-layers/src/heatmap-layer/heatmap-layer.ts
@@ -55,7 +55,7 @@ const TEXTURE_PROPS: TextureProps = {
     addressModeV: 'clamp-to-edge'
   }
 };
-const DEFAULT_COLOR_DOMAIN = [0, 0];
+const DEFAULT_COLOR_DOMAIN = [0, 0] as const;
 const AGGREGATION_MODE = {
   SUM: 0,
   MEAN: 1
@@ -126,7 +126,7 @@ type _HeatmapLayerProps<DataT> = {
    *
    * @default null
    */
-  colorDomain?: [number, number] | null;
+  colorDomain?: Readonly<[number, number]> | null;
 
   /**
    * Defines the type of aggregation operation
@@ -174,7 +174,7 @@ export default class HeatmapLayer<
   static defaultProps = defaultProps;
 
   state!: AggregationLayer<DataT>['state'] & {
-    colorDomain?: number[];
+    colorDomain?: Readonly<[number, number]>;
     isWeightMapDirty?: boolean;
     weightsTexture?: Texture;
     maxWeightsTexture?: Texture;
@@ -594,7 +594,10 @@ export default class HeatmapLayer<
       const metersPerPixel =
         (viewport.distanceScales.metersPerUnit[2] * (commonBounds[2] - commonBounds[0])) /
         textureSize;
-      this.state.colorDomain = colorDomain.map(x => x * metersPerPixel * weightsScale);
+      this.state.colorDomain = [
+        colorDomain[0] * metersPerPixel * weightsScale,
+        colorDomain[1] * metersPerPixel * weightsScale
+      ];
     } else {
       this.state.colorDomain = colorDomain || DEFAULT_COLOR_DOMAIN;
     }
diff --git a/modules/aggregation-layers/src/heatmap-layer/triangle-layer-uniforms.ts b/modules/aggregation-layers/src/heatmap-layer/triangle-layer-uniforms.ts
@@ -16,7 +16,7 @@ uniform triangleUniforms {
 
 export type TriangleProps = {
   aggregationMode: number;
-  colorDomain: [number, number];
+  colorDomain: Readonly<[number, number]>;
   intensity: number;
   threshold: number;
   colorTexture: Texture;
diff --git a/modules/aggregation-layers/src/heatmap-layer/triangle-layer.ts b/modules/aggregation-layers/src/heatmap-layer/triangle-layer.ts
@@ -11,7 +11,7 @@ import {TriangleProps, triangleUniforms} from './triangle-layer-uniforms';
 
 type _TriangleLayerProps = {
   data: {attributes: {positions: Buffer; texCoords: Buffer}};
-  colorDomain: [number, number];
+  colorDomain: Readonly<[number, number]>;
   aggregationMode: number;
   threshold: number;
   intensity: number;
diff --git a/modules/aggregation-layers/src/hexagon-layer/hexagon-cell-layer.ts b/modules/aggregation-layers/src/hexagon-layer/hexagon-cell-layer.ts
@@ -12,14 +12,14 @@ import type {ScaleType} from '../common/types';
 
 /** Proprties added by HexagonCellLayer. */
 export type _HexagonCellLayerProps = {
-  hexOriginCommon: [number, number];
-  colorDomain: [number, number];
-  colorCutoff: [number, number] | null;
+  hexOriginCommon: Readonly<[number, number]>;
+  colorDomain: Readonly<[number, number]>;
+  colorCutoff: Readonly<[number, number]> | null;
   colorRange: Color[];
   colorScaleType: ScaleType;
-  elevationDomain: [number, number];
-  elevationCutoff: [number, number] | null;
-  elevationRange: [number, number];
+  elevationDomain: Readonly<[number, number]>;
+  elevationCutoff: Readonly<[number, number]> | null;
+  elevationRange: Readonly<[number, number]>;
 };
 
 export default class HexagonCellLayer<ExtraPropsT extends {} = {}> extends ColumnLayer<
diff --git a/modules/aggregation-layers/src/hexagon-layer/hexagon-layer-uniforms.ts b/modules/aggregation-layers/src/hexagon-layer/hexagon-layer-uniforms.ts
@@ -15,11 +15,11 @@ uniform hexagonUniforms {
 `;
 
 export type HexagonProps = {
-  colorDomain: [number, number, number, number];
+  colorDomain: Readonly<[number, number, number, number]>;
   colorRange: Texture;
-  elevationDomain: [number, number, number, number];
-  elevationRange: [number, number];
-  originCommon: [number, number];
+  elevationDomain: Readonly<[number, number, number, number]>;
+  elevationRange: Readonly<[number, number]>;
+  originCommon: Readonly<[number, number]>;
 };
 
 export const hexagonUniforms = {
diff --git a/modules/aggregation-layers/src/hexagon-layer/hexagon-layer.ts b/modules/aggregation-layers/src/hexagon-layer/hexagon-layer.ts
@@ -92,7 +92,7 @@ type _HexagonLayerProps<DataT> = {
    * Color scale domain, default is set to the extent of aggregated weights in each cell.
    * @default [min(colorWeight), max(colorWeight)]
    */
-  colorDomain?: [number, number] | null;
+  colorDomain?: Readonly<[number, number]> | null;
 
   /**
    * Default: [colorbrewer](http://colorbrewer2.org/#type=sequential&scheme=YlOrRd&n=6) `6-class YlOrRd`
@@ -109,13 +109,13 @@ type _HexagonLayerProps<DataT> = {
    * Elevation scale input domain, default is set to between 0 and the max of aggregated weights in each cell.
    * @default [0, max(elevationWeight)]
    */
-  elevationDomain?: [number, number] | null;
+  elevationDomain?: Readonly<[number, number]> | null;
 
   /**
    * Elevation scale output range.
    * @default [0, 1000]
    */
-  elevationRange?: [number, number];
+  elevationRange?: Readonly<[number, number]>;
 
   /**
    * Cell elevation multiplier.
diff --git a/modules/aggregation-layers/src/screen-grid-layer/screen-grid-layer.ts b/modules/aggregation-layers/src/screen-grid-layer/screen-grid-layer.ts
@@ -55,7 +55,7 @@ export type _ScreenGridLayerProps<DataT> = {
    * Color scale input domain. The color scale maps continues numeric domain into discrete color range.
    * @default [1, max(weight)]
    */
-  colorDomain?: [number, number] | null;
+  colorDomain?: Readonly<[number, number]> | null;
 
   /**
    * Specified as an array of colors [color1, color2, ...].
diff --git a/modules/core/src/lib/attribute/data-column.ts b/modules/core/src/lib/attribute/data-column.ts
@@ -102,7 +102,7 @@ export type DataColumnOptions<Options> = Options &
     /** Internal API, use `type` instead */
     logicalType?: LogicalDataType;
     isIndexed?: boolean;
-    defaultValue?: number | number[];
+    defaultValue?: number | Readonly<number[]>;
   };
 
 export type DataColumnSettings<Options> = DataColumnOptions<Options> & {
diff --git a/modules/core/src/types/layer-props.ts b/modules/core/src/types/layer-props.ts
@@ -53,14 +53,18 @@ export type Accessor<In, Out> = Out | AccessorFunction<In, Out>;
 /** A position in the format of `[lng, lat, alt?]` or `[x, y, z?]` depending on the coordinate system.
  * See https://deck.gl/docs/developer-guide/coordinate-systems#positions
  */
-export type Position = [number, number] | [number, number, number] | Float32Array | Float64Array;
+export type Position =
+  | Readonly<[number, number]>
+  | Readonly<[number, number, number]>
+  | Readonly<Float32Array>
+  | Readonly<Float64Array>;
 
 /** A color in the format of `[r, g, b, a?]` */
 export type Color =
-  | [number, number, number]
-  | [number, number, number, number]
-  | Uint8Array
-  | Uint8ClampedArray;
+  | Readonly<[number, number, number]>
+  | Readonly<[number, number, number, number]>
+  | Readonly<Uint8Array>
+  | Readonly<Uint8ClampedArray>;
 
 export type Material = LightingModuleSettings['material'];
 
diff --git a/modules/extensions/src/brushing/brushing-extension.ts b/modules/extensions/src/brushing/brushing-extension.ts
@@ -20,7 +20,7 @@ export type BrushingExtensionProps<DataT = any> = {
    * Called to retrieve an arbitrary position for each object that it will be filtered by.
    * Only effective if `brushingTarget` is set to `custom`.
    */
-  getBrushingTarget?: Accessor<DataT, [number, number]>;
+  getBrushingTarget?: Accessor<DataT, Readonly<[number, number]>>;
   /**
    * Enable/disable brushing. If brushing is disabled, all objects are rendered.
    * @default true
diff --git a/modules/extensions/src/clip/clip-extension.ts b/modules/extensions/src/clip/clip-extension.ts
@@ -16,7 +16,7 @@ export type ClipExtensionProps = {
   /** Rectangular bounds to be used for clipping the rendered region, in `[left, bottom, right, top]`.
    * @default [0, 0, 1, 1]
    */
-  clipBounds?: [number, number, number, number];
+  clipBounds?: Readonly<[number, number, number, number]>;
   /**
    * Controls whether an object is clipped by its anchor (e.g. icon, point) or by its geometry (e.g. path, polygon).
    * If not specified, it is automatically deduced from the layer.
@@ -35,7 +35,7 @@ bool clip_isInBounds(vec2 position) {
 `;
 
 export type ClipModuleProps = {
-  bounds: [number, number, number, number];
+  bounds: Readonly<[number, number, number, number]>;
 };
 
 /*
diff --git a/modules/extensions/src/data-filter/data-filter-extension.ts b/modules/extensions/src/data-filter/data-filter-extension.ts
@@ -52,13 +52,13 @@ export type DataFilterExtensionProps<DataT = any> = {
    * If an object's filtered value is within the bounds, the object will be rendered; otherwise it will be hidden.
    * @default [-1, 1]
    */
-  filterRange?: [number, number] | [number, number][];
+  filterRange?: Readonly<[number, number]> | Readonly<[number, number]>[];
   /**
    * If specified, objects will be faded in/out instead of abruptly shown/hidden.
    * When the filtered value is outside of the bounds defined by `filterSoftRange` but still within the bounds defined by `filterRange`, the object will be rendered as "faded."
    * @default null
    */
-  filterSoftRange?: [number, number] | [number, number][] | null;
+  filterSoftRange?: Readonly<[number, number]> | Readonly<[number, number]>[] | null;
   /**
    * When an object is "faded", manipulate its size so that it appears smaller or thinner. Only works if `filterSoftRange` is specified.
    * @default true
diff --git a/modules/extensions/src/fill-style/fill-style-extension.ts b/modules/extensions/src/fill-style/fill-style-extension.ts
@@ -70,7 +70,7 @@ export type FillStyleExtensionProps<DataT = any> = {
    * Accessor for the offset of the pattern, relative to the original size. Offset `[0.5, 0.5]` shifts the pattern alignment by half.
    * @default [0, 0]
    */
-  getFillPatternOffset?: Accessor<DataT, [number, number]>;
+  getFillPatternOffset?: Accessor<DataT, Readonly<[number, number]>>;
 };
 
 export type FillStyleExtensionOptions = {
diff --git a/modules/extensions/src/path-style/path-style-extension.ts b/modules/extensions/src/path-style/path-style-extension.ts
@@ -26,7 +26,7 @@ export type PathStyleExtensionProps<DataT = any> = {
    * Accessor for the dash array to draw each path with: `[dashSize, gapSize]` relative to the width of the path.
    * Requires the `dash` option to be on.
    */
-  getDashArray?: Accessor<DataT, [number, number]>;
+  getDashArray?: Accessor<DataT, Readonly<[number, number]>>;
   /**
    * Accessor for the offset to draw each path with, relative to the width of the path.
    * Negative offset is to the left hand side, and positive offset is to the right hand side.
diff --git a/modules/layers/src/arc-layer/arc-layer.ts b/modules/layers/src/arc-layer/arc-layer.ts
@@ -24,7 +24,7 @@ import {arcUniforms, ArcProps} from './arc-layer-uniforms';
 import vs from './arc-layer-vertex.glsl';
 import fs from './arc-layer-fragment.glsl';
 
-const DEFAULT_COLOR: [number, number, number, number] = [0, 0, 0, 255];
+const DEFAULT_COLOR = [0, 0, 0, 255] as const;
 
 const defaultProps: DefaultProps<ArcLayerProps> = {
   getSourcePosition: {type: 'accessor', value: (x: any) => x.sourcePosition},
diff --git a/modules/layers/src/column-layer/column-layer-uniforms.ts b/modules/layers/src/column-layer/column-layer-uniforms.ts
@@ -26,7 +26,7 @@ uniform columnUniforms {
 export type ColumnProps = {
   radius: number;
   angle: number;
-  offset: [number, number];
+  offset: Readonly<[number, number]>;
   extruded: boolean;
   stroked: boolean;
   isStroke: boolean;
diff --git a/modules/layers/src/column-layer/column-layer.ts b/modules/layers/src/column-layer/column-layer.ts
@@ -26,7 +26,7 @@ import {columnUniforms, ColumnProps} from './column-layer-uniforms';
 import vs from './column-layer-vertex.glsl';
 import fs from './column-layer-fragment.glsl';
 
-const DEFAULT_COLOR: [number, number, number, number] = [0, 0, 0, 255];
+const DEFAULT_COLOR = [0, 0, 0, 255] as const;
 
 const defaultProps: DefaultProps<ColumnLayerProps> = {
   diskResolution: {type: 'number', min: 4, value: 20},
@@ -91,7 +91,7 @@ type _ColumnLayerProps<DataT> = {
    * Disk offset from the position, relative to the radius.
    * @default [0,0]
    */
-  offset?: [number, number];
+  offset?: Readonly<[number, number]>;
 
   /**
    * Radius multiplier, between 0 - 1
diff --git a/modules/layers/src/icon-layer/icon-layer.ts b/modules/layers/src/icon-layer/icon-layer.ts
@@ -91,7 +91,7 @@ type _IconLayerProps<DataT> = {
    * Icon offsest accessor, in pixels.
    * @default [0, 0]
    */
-  getPixelOffset?: Accessor<DataT, [number, number]>;
+  getPixelOffset?: Accessor<DataT, Readonly<[number, number]>>;
   /**
    * Callback called if the attempt to fetch an icon returned by `getIcon` fails.
    */
@@ -103,7 +103,7 @@ type _IconLayerProps<DataT> = {
 
 export type IconLayerProps<DataT = unknown> = _IconLayerProps<DataT> & LayerProps;
 
-const DEFAULT_COLOR: [number, number, number, number] = [0, 0, 0, 255];
+const DEFAULT_COLOR = [0, 0, 0, 255] as const;
 
 const defaultProps: DefaultProps<IconLayerProps> = {
   iconAtlas: {type: 'image', value: null, async: true},
diff --git a/modules/layers/src/line-layer/line-layer.ts b/modules/layers/src/line-layer/line-layer.ts
@@ -25,7 +25,7 @@ import {shaderWGSL as source} from './line-layer.wgsl';
 import vs from './line-layer-vertex.glsl';
 import fs from './line-layer-fragment.glsl';
 
-const DEFAULT_COLOR: [number, number, number, number] = [0, 0, 0, 255];
+const DEFAULT_COLOR = [0, 0, 0, 255] as const;
 
 const defaultProps: DefaultProps<LineLayerProps> = {
   getSourcePosition: {type: 'accessor', value: (x: any) => x.sourcePosition},
diff --git a/modules/layers/src/path-layer/path-layer.ts b/modules/layers/src/path-layer/path-layer.ts
@@ -95,7 +95,7 @@ type _PathLayerProps<DataT> = {
 
 export type PathLayerProps<DataT = unknown> = _PathLayerProps<DataT> & LayerProps;
 
-const DEFAULT_COLOR: [number, number, number, number] = [0, 0, 0, 255];
+const DEFAULT_COLOR = [0, 0, 0, 255] as const;
 
 const defaultProps: DefaultProps<PathLayerProps> = {
   widthUnits: 'meters',
diff --git a/modules/layers/src/path-layer/path-tesselator.ts b/modules/layers/src/path-layer/path-tesselator.ts
@@ -56,11 +56,11 @@ export default class PathTesselator extends Tesselator<
   }
 
   /* Implement base Tesselator interface */
-  protected normalizeGeometry(path: PathGeometry): number[][] | PathGeometry {
+  protected normalizeGeometry(path: PathGeometry): NormalizedPathGeometry {
     if (this.normalize) {
       return normalizePath(path, this.positionSize, this.opts.resolution, this.opts.wrapLongitude);
     }
-    return path;
+    return path as NormalizedPathGeometry;
   }
 
   /* Implement base Tesselator interface */
diff --git a/modules/layers/src/path-layer/path.ts b/modules/layers/src/path-layer/path.ts
diff --git a/modules/layers/src/point-cloud-layer/point-cloud-layer.ts b/modules/layers/src/point-cloud-layer/point-cloud-layer.ts
diff --git a/modules/layers/src/polygon-layer/polygon-layer.ts b/modules/layers/src/polygon-layer/polygon-layer.ts
diff --git a/modules/layers/src/scatterplot-layer/scatterplot-layer.ts b/modules/layers/src/scatterplot-layer/scatterplot-layer.ts
diff --git a/modules/layers/src/solid-polygon-layer/solid-polygon-layer.ts b/modules/layers/src/solid-polygon-layer/solid-polygon-layer.ts
diff --git a/modules/layers/src/text-layer/multi-icon-layer/multi-icon-layer.ts b/modules/layers/src/text-layer/multi-icon-layer/multi-icon-layer.ts
diff --git a/modules/layers/src/text-layer/text-background-layer/text-background-layer-uniforms.ts b/modules/layers/src/text-layer/text-background-layer/text-background-layer-uniforms.ts
diff --git a/modules/layers/src/text-layer/text-background-layer/text-background-layer.ts b/modules/layers/src/text-layer/text-background-layer/text-background-layer.ts
diff --git a/modules/layers/src/text-layer/text-layer.ts b/modules/layers/src/text-layer/text-layer.ts
diff --git a/modules/mesh-layers/src/scenegraph-layer/scenegraph-layer.ts b/modules/mesh-layers/src/scenegraph-layer/scenegraph-layer.ts
diff --git a/modules/mesh-layers/src/simple-mesh-layer/simple-mesh-layer.ts b/modules/mesh-layers/src/simple-mesh-layer/simple-mesh-layer.ts
