Stricter types, remove remaining types

Don McCurdy · Don McCurdy · commit 016736001b01 · 2023-11-20T16:17:58.000-05:00
diff --git a/examples/website/plot/app.jsx b/examples/website/plot/app.jsx
@@ -28,12 +28,12 @@ export default function App({resolution = 200, showAxis = true, equation = EQUAT
     equation &&
       resolution &&
       new PlotLayer({
-        getPosition: (u, v) => {
+        getPosition: ([u, v]) => {
           const x = (u - 1 / 2) * Math.PI * 2;
           const y = (v - 1 / 2) * Math.PI * 2;
           return [x, y, equation(x, y)];
         },
-        getColor: (x, y, z) => [40, z * 128 + 128, 160],
+        getColor: ([x, y, z]) => [40, z * 128 + 128, 160],
         getXScale: getScale,
         getYScale: getScale,
         getZScale: getScale,
diff --git a/examples/website/plot/plot-layer/axes-layer.ts b/examples/website/plot/plot-layer/axes-layer.ts
@@ -14,7 +14,7 @@ import {Axis, Tick, TickFormat, Vec2, Vec3} from './types';
 /* Constants */
 const DEFAULT_FONT_SIZE = 48;
 const DEFAULT_TICK_COUNT = 6;
-const DEFAULT_TICK_FORMAT = x => x.toFixed(2);
+const DEFAULT_TICK_FORMAT = (x: number) => x.toFixed(2);
 const DEFAULT_COLOR: Color = [0, 0, 0, 255];
 
 interface LabelTexture {
@@ -33,9 +33,9 @@ const defaultProps: DefaultProps<AxesLayerProps> = {
   xTicks: DEFAULT_TICK_COUNT,
   yTicks: DEFAULT_TICK_COUNT,
   zTicks: DEFAULT_TICK_COUNT,
-  xTickFormat: DEFAULT_TICK_FORMAT,
-  yTickFormat: DEFAULT_TICK_FORMAT,
-  zTickFormat: DEFAULT_TICK_FORMAT,
+  xTickFormat: DEFAULT_TICK_FORMAT as TickFormat<unknown>,
+  yTickFormat: DEFAULT_TICK_FORMAT as TickFormat<unknown>,
+  zTickFormat: DEFAULT_TICK_FORMAT as TickFormat<unknown>,
   padding: 0,
   color: DEFAULT_COLOR,
   xTitle: 'x',
diff --git a/examples/website/plot/plot-layer/plot-layer.ts b/examples/website/plot/plot-layer/plot-layer.ts
@@ -1,4 +1,7 @@
 import {
+  Accessor,
+  AccessorContext,
+  AccessorFunction,
   Color,
   CompositeLayer,
   CompositeLayerProps,
@@ -9,23 +12,23 @@ import {ScaleLinear, scaleLinear} from 'd3-scale';
 
 import AxesLayer from './axes-layer';
 import SurfaceLayer from './surface-layer';
-import {$TODO} from './types';
+import {Range, TickFormat, Vec3} from './types';
 
-const DEFAULT_GET_SCALE = {type: 'function', value: () => scaleLinear()};
-const DEFAULT_TICK_FORMAT = {type: 'function', value: x => x.toFixed(2)};
+const DEFAULT_GET_SCALE = {type: 'function', value: () => scaleLinear()} as const;
+const DEFAULT_TICK_FORMAT = {type: 'function', value: (x: number) => x.toFixed(2)} as const;
 const DEFAULT_TICK_COUNT = 6;
-const DEFAULT_COLOR = [0, 0, 0, 255];
+const DEFAULT_COLOR: Color = [0, 0, 0, 255];
 
 /** All props supported by PlotLayer. */
-export type PlotLayerProps<DataT = unknown> = _PlotLayerProps<DataT> & CompositeLayerProps;
+export type PlotLayerProps<DataT extends Vec3 = Vec3> = _PlotLayerProps<DataT> & CompositeLayerProps;
 
-type _PlotLayerProps<DataT> = {
+type _PlotLayerProps<DataT extends Vec3 = Vec3> = {
   // SurfaceLayer props
-  getPosition: $TODO;
-  getColor: $TODO;
-  getXScale: $TODO;
-  getYScale: $TODO;
-  getZScale: $TODO;
+  getPosition: AccessorFunction<DataT, Vec3>;
+  getColor: AccessorFunction<DataT, Color>;
+  getXScale: AccessorFunction<Range, ScaleLinear<number, number>>;
+  getYScale: AccessorFunction<Range, ScaleLinear<number, number>>;
+  getZScale: AccessorFunction<Range, ScaleLinear<number, number>>;
   uCount: number;
   vCount: number;
   lightStrength: number;
@@ -39,9 +42,9 @@ type _PlotLayerProps<DataT> = {
   xTicks: number;
   yTicks: number;
   zTicks: number;
-  xTickFormat: $TODO;
-  yTickFormat: $TODO;
-  zTickFormat: $TODO;
+  xTickFormat: TickFormat<DataT>;
+  yTickFormat: TickFormat<DataT>;
+  zTickFormat: TickFormat<DataT>;
   axesPadding: 0;
   axesColor: Color;
   xTitle: string;
@@ -51,8 +54,8 @@ type _PlotLayerProps<DataT> = {
 
 const defaultProps: DefaultProps<PlotLayerProps> = {
   // SurfaceLayer props
-  getPosition: {type: 'accessor', value: (u, v) => [0, 0, 0]},
-  getColor: {type: 'accessor', value: (x, y, z) => DEFAULT_COLOR},
+  getPosition: {type: 'accessor', value: ([u, v]) => [0, 0, 0]},
+  getColor: {type: 'accessor', value: ([x, y, z]) => DEFAULT_COLOR},
   getXScale: DEFAULT_GET_SCALE,
   getYScale: DEFAULT_GET_SCALE,
   getZScale: DEFAULT_GET_SCALE,
@@ -66,9 +69,9 @@ const defaultProps: DefaultProps<PlotLayerProps> = {
   xTicks: DEFAULT_TICK_COUNT,
   yTicks: DEFAULT_TICK_COUNT,
   zTicks: DEFAULT_TICK_COUNT,
-  xTickFormat: DEFAULT_TICK_FORMAT,
-  yTickFormat: DEFAULT_TICK_FORMAT,
-  zTickFormat: DEFAULT_TICK_FORMAT,
+  xTickFormat: DEFAULT_TICK_FORMAT as unknown as TickFormat<unknown>,
+  yTickFormat: DEFAULT_TICK_FORMAT as unknown as TickFormat<unknown>,
+  zTickFormat: DEFAULT_TICK_FORMAT as unknown as TickFormat<unknown>,
   xTitle: 'x',
   yTitle: 'y',
   zTitle: 'z',
@@ -109,7 +112,7 @@ const defaultProps: DefaultProps<PlotLayerProps> = {
  * @param {Number} [props.fontSize] - size of the labels
  * @param {Array} [props.axesColor] - color of the gridlines, in [r,g,b,a]
  */
-export default class PlotLayer<DataT = any, ExtraPropsT extends {} = {}> extends CompositeLayer<
+export default class PlotLayer<DataT extends Vec3 = Vec3, ExtraPropsT extends {} = {}> extends CompositeLayer<
   ExtraPropsT & Required<_PlotLayerProps<DataT>>
 > {
   static layerName = 'PlotLayer';
@@ -137,7 +140,7 @@ export default class PlotLayer<DataT = any, ExtraPropsT extends {} = {}> extends
       for (let uIndex = 0; uIndex < uCount; uIndex++) {
         const u = uIndex / (uCount - 1);
         const v = vIndex / (vCount - 1);
-        const [x, y, z] = getPosition(u, v);
+        const [x, y, z] = getPosition([u, v, 0] as DataT, {} as AccessorContext<DataT>);
 
         if (isFinite(x)) {
           xMin = Math.min(xMin, x);
@@ -154,9 +157,9 @@ export default class PlotLayer<DataT = any, ExtraPropsT extends {} = {}> extends
       }
     }
 
-    const xScale = getXScale({min: xMin, max: xMax});
-    const yScale = getYScale({min: yMin, max: yMax});
-    const zScale = getZScale({min: zMin, max: zMax});
+    const xScale = getXScale({min: xMin, max: xMax}, {} as AccessorContext<Range>);
+    const yScale = getYScale({min: yMin, max: yMax}, {} as AccessorContext<Range>);
+    const zScale = getZScale({min: zMin, max: zMax}, {} as AccessorContext<Range>);
 
     this.setState({xScale, yScale, zScale});
   }
@@ -188,8 +191,8 @@ export default class PlotLayer<DataT = any, ExtraPropsT extends {} = {}> extends
     return [
       new SurfaceLayer(
         {
-          getPosition,
-          getColor,
+          getPosition: getPosition as AccessorFunction<Vec3, Vec3>,
+          getColor: getColor as Accessor<Vec3, Color>,
           uCount,
           vCount,
           xScale,
diff --git a/examples/website/plot/plot-layer/surface-layer.ts b/examples/website/plot/plot-layer/surface-layer.ts
@@ -1,12 +1,20 @@
 import {Layer, picking} from '@deck.gl/core';
-import type {Color, DefaultProps, LayerDataSource, LayerProps} from '@deck.gl/core';
+import type {
+  Accessor,
+  AccessorContext,
+  AccessorFunction,
+  Color,
+  DefaultProps,
+  LayerDataSource,
+  LayerProps
+} from '@deck.gl/core';
 import {GL} from '@luma.gl/constants';
 import {Model} from '@luma.gl/engine';
 import {ScaleLinear} from 'd3-scale';
 
 import surfaceVertex from './surface-vertex.glsl';
 import fragmentShader from './fragment.glsl';
-import {$TODO} from './types';
+import {Vec3} from './types';
 
 const DEFAULT_COLOR: Color = [0, 0, 0, 255];
 
@@ -23,12 +31,12 @@ const defaultProps: DefaultProps<SurfaceLayerProps> = {
 };
 
 /** All props supported by SurfaceLayer. */
-export type SurfaceLayerProps<DataT = unknown> = _SurfaceLayerProps<DataT> & LayerProps;
+export type SurfaceLayerProps<DataT extends Vec3 = Vec3> = _SurfaceLayerProps<DataT> & LayerProps;
 
-type _SurfaceLayerProps<DataT> = {
+type _SurfaceLayerProps<DataT extends Vec3 = Vec3> = {
   data: LayerDataSource<DataT>;
-  getPosition?: $TODO;
-  getColor?: $TODO;
+  getPosition?: AccessorFunction<DataT, Vec3>;
+  getColor?: Accessor<DataT, Color>;
   xScale?: ScaleLinear<number, number>;
   yScale?: ScaleLinear<number, number>;
   zScale?: ScaleLinear<number, number>;
@@ -53,9 +61,10 @@ type _SurfaceLayerProps<DataT> = {
  * @param {Integer} [props.vCount] - number of samples within y range
  * @param {Number} [props.lightStrength] - front light strength
  */
-export default class SurfaceLayer<DataT = any, ExtraPropsT extends {} = {}> extends Layer<
-  ExtraPropsT & Required<_SurfaceLayerProps<DataT>>
-> {
+export default class SurfaceLayer<
+  DataT extends Vec3 = Vec3,
+  ExtraPropsT extends {} = {}
+> extends Layer<ExtraPropsT & Required<_SurfaceLayerProps<DataT>>> {
   static defaultProps = defaultProps;
   static layerName: string = 'SurfaceLayer';
 
@@ -139,7 +148,7 @@ export default class SurfaceLayer<DataT = any, ExtraPropsT extends {} = {}> exte
     if (b === 0) {
       return -1;
     }
-    return r | g << 8;
+    return r | (g << 8);
   }
 
   getPickingInfo(opts) {
@@ -149,7 +158,7 @@ export default class SurfaceLayer<DataT = any, ExtraPropsT extends {} = {}> exte
       const {getPosition} = this.props;
       const u = (info.index & 255) / 255;
       const v = (info.index >> 8) / 255;
-      info.sample = getPosition(u, v);
+      info.sample = getPosition([u, v, 0] as DataT, {} as AccessorContext<DataT>);
     }
 
     return info;
@@ -205,7 +214,7 @@ export default class SurfaceLayer<DataT = any, ExtraPropsT extends {} = {}> exte
       for (let uIndex = 0; uIndex < uCount; uIndex++) {
         const u = uIndex / (uCount - 1);
         const v = vIndex / (vCount - 1);
-        const [x, y, z] = getPosition(u, v);
+        const [x, y, z] = getPosition([u, v, 0] as DataT, {} as AccessorContext<DataT>);
 
         const isXFinite = isFinite(x);
         const isYFinite = isFinite(y);
@@ -231,12 +240,13 @@ export default class SurfaceLayer<DataT = any, ExtraPropsT extends {} = {}> exte
     const value = new Uint8ClampedArray(vertexCount! * attribute.size);
 
     // Support constant colors
-    let {getColor} = this.props;
-    getColor = typeof getColor === 'function' ? getColor : () => getColor;
+    const getColor =
+      typeof this.props.getColor === 'function' ? this.props.getColor : () => this.props.getColor;
 
     for (let i = 0; i < vertexCount; i++) {
       const index = i * 4;
-      const color = getColor(positions[index], positions[index + 2], positions[index + 1]);
+      const position = [positions[index], positions[index + 2], positions[index + 1]];
+      const color = getColor(position as DataT, {} as AccessorContext<DataT>);
       value[i * 4] = color[0];
       value[i * 4 + 1] = color[1];
       value[i * 4 + 2] = color[2];
diff --git a/examples/website/plot/plot-layer/types.ts b/examples/website/plot/plot-layer/types.ts
@@ -1,6 +1,8 @@
 export type Vec2 = [number, number];
 export type Vec3 = [number, number, number];
 
+export type Range = {min: number, max: number};
+
 export type Axis = 'x' | 'y' | 'z';
 
 export type Tick = {
@@ -10,9 +12,3 @@ export type Tick = {
 };
 
 export type TickFormat<DataT = unknown> = (t: DataT, axis: Axis) => string;
-
-/**
- * Unresolved complaint from type checker. Used while migrating code to
- * TypeScript, and should be fixed when possible.
- */
-export type $TODO = any;
