feat: unify exposed types naming to colormap (#2584)

Both colormap and colorMap naming scheme are present, bringing some
confusion.
Moving to single notation: colormap.

Exposed part: exported API types
Rename:
- exposed types

Old types are exported as deprecated


Occurrence count, after and before the PR
| | colormap | colorMap |
|--|--|--|
|Published Code (a)| 618 results in 40 files<br>~547~ results in ~38~
files | 143 results in 28 files<br>~209~ results in ~33~ files |
|Full Code (b)| 767 results in 60 files<br>~674~ results in ~57~ files |
267 results in 49 files<br>~355~ results in ~54~ files |
|Overall (c)| 783 results in 66 files<br>~692~ results in ~64~ files |
293 results in 58 files<br>~381~ results in ~63~ files |

PR for #2581

Author: w1nklr

typescript/packages/subsurface-viewer/src/components/ColorLegend.tsx

@@ -10,13 +10,13 @@ import {
 } from "@emerson-eps/color-tables";
 
 import type { ExtendedLegendLayer } from "../layers/utils/layerTools";
-import type { ColorMapFunctionType } from "../layers/utils/colormapTools";
+import type { ColormapFunctionType } from "../layers/utils/colormapTools";
 
 interface LegendBaseData {
     title: string;
     colorName: string;
     discrete: boolean;
-    colorMapFunction?: ColorMapFunctionType;
+    colorMapFunction?: ColormapFunctionType;
 }
 export interface DiscreteLegendDataType extends LegendBaseData {
     metadata: Record<string, [Color, number]>;

typescript/packages/subsurface-viewer/src/layers/colormap/colormapLayer.ts

@@ -15,7 +15,7 @@ import type {
 } from "../utils/layerTools";
 import { type DeckGLLayerContext, getModelMatrix } from "../utils/layerTools";
 import {
-    type ColorMapFunctionType,
+    type ColormapFunctionType,
     getImageData,
 } from "../utils/colormapTools";
 import { decodeRGB, type ValueDecoder } from "../utils/propertyMapTools";
@@ -49,7 +49,7 @@ export interface ColormapLayerProps
     // Optional function property.
     // If defined this function will override the color map.
     // Takes a value in the range [0,1] and returns a color.
-    colorMapFunction?: ColorMapFunctionType;
+    colorMapFunction?: ColormapFunctionType;
 
     // Min and max property values.
     valueRange: [number, number];

typescript/packages/subsurface-viewer/src/layers/grid3d/grid3dLayer.ts

@@ -15,7 +15,7 @@ import type {
     ExtendedLayerProps,
     ReportBoundingBoxAction,
 } from "../utils/layerTools";
-import type { ColorMapFunctionType } from "../utils/colormapTools";
+import type { ColormapFunctionType } from "../utils/colormapTools";
 
 import config from "../../SubsurfaceConfig.json";
 import { findConfig } from "../../utils/configTools";
@@ -232,7 +232,7 @@ export interface Grid3DLayerProps extends ExtendedLayerProps {
      * E.g. [255, 0, 0] for constant red cells.
      * Can be defined as Uint8Array containing [R, G, B] triplets in [0, 255] range each.
      */
-    colorMapFunction?: ColorMapFunctionType | Uint8Array;
+    colorMapFunction?: ColormapFunctionType | Uint8Array;
 
     /**
      * Value in propertiesData indicating that the property is undefined.
@@ -473,7 +473,7 @@ export default class Grid3DLayer extends CompositeLayer<Grid3DLayerProps> {
     }
 
     private isColormapFunctionConstantColor(
-        colorFunc: Uint8Array | ColorMapFunctionType | undefined
+        colorFunc: Uint8Array | ColormapFunctionType | undefined
     ): colorFunc is Uint8Array {
         return (
             (Array.isArray(colorFunc) || colorFunc instanceof Uint8Array) &&

typescript/packages/subsurface-viewer/src/layers/grid3d/privateGrid3dLayer.ts

@@ -23,7 +23,7 @@ import type {
 } from "../utils/layerTools";
 import { createPropertyData } from "../utils/layerTools";
 import {
-    type ColorMapFunctionType,
+    type ColormapFunctionType,
     createColormapTexture,
 } from "../utils/colormapTools";
 import linearFragmentShader from "./nodeProperty.fs.glsl";
@@ -51,7 +51,7 @@ export interface PrivateLayerProps extends ExtendedLayerProps {
     colormapClampColor: Color | undefined | boolean;
     undefinedPropertyValue: number;
     undefinedPropertyColor: [number, number, number];
-    colormapFunction?: ColorMapFunctionType;
+    colormapFunction?: ColormapFunctionType;
     coloringMode: TGrid3DColoringMode.Property;
     gridLines: boolean;
     propertyValueRange: [number, number];

typescript/packages/subsurface-viewer/src/layers/map/mapLayer.ts

@@ -16,7 +16,7 @@ import type {
     ExtendedLayerProps,
 } from "../utils/layerTools";
 import { getModelMatrix } from "../utils/layerTools";
-import type { ColorMapFunctionType } from "../utils/colormapTools";
+import type { ColormapFunctionType } from "../utils/colormapTools";
 import config from "../../SubsurfaceConfig.json";
 import { findConfig } from "../../utils/configTools";
 import { loadFloat32Data } from "../../utils/serialize";
@@ -175,7 +175,7 @@ export interface MapLayerProps extends ExtendedLayerProps {
      * May also be set as constant color:
      * E.g. [255, 0, 0] for constant red surface.
      */
-    colorMapFunction?: ColorMapFunctionType;
+    colorMapFunction?: ColormapFunctionType;
 
     /**  Surface material properties.
      * material: true  = default material, coloring depends on surface orientation and lighting.

typescript/packages/subsurface-viewer/src/layers/map/privateMapLayer.ts

@@ -24,7 +24,7 @@ import type {
 } from "../utils/layerTools";
 import { createPropertyData } from "../utils/layerTools";
 import {
-    type ColorMapFunctionType,
+    type ColormapFunctionType,
     getImageData,
 } from "../utils/colormapTools";
 
@@ -46,7 +46,7 @@ export interface PrivateMapLayerProps extends ExtendedLayerProps {
     colormapName: string;
     colormapRange: [number, number];
     colormapClampColor: Color | undefined | boolean;
-    colormapFunction?: ColorMapFunctionType;
+    colormapFunction?: ColormapFunctionType;
     propertyValueRange: [number, number];
     smoothShading: boolean;
     depthTest: boolean;

typescript/packages/subsurface-viewer/src/layers/utils/colormapTools.ts

@@ -12,9 +12,11 @@ import { createDefaultContinuousColorScale } from "@emerson-eps/color-tables/dis
 import type { DeckGLLayerContext } from "./layerTools";
 
 /** Type of functions returning a color from a value in the [0,1] range. */
-export type ColorMapFunctionType = ReturnType<typeof createColormapFunction>;
-/** @deprecated Use ColorMapFunctionType instead. */
-export type colorMapFunctionType = ColorMapFunctionType;
+export type ColormapFunctionType = ReturnType<typeof createColormapFunction>;
+/** @deprecated Use ColormapFunctionType instead. */
+export type colorMapFunctionType = ColormapFunctionType;
+/** @deprecated Use ColormapFunctionType instead. */
+export type ColorMapFunctionType = ColormapFunctionType;
 
 export interface IColormapHints {
     discreteData: boolean;
@@ -40,16 +42,16 @@ export interface ColorTableDef extends ColorTableProps {
     colorTables: colorTablesArray;
 }
 
-export type ColormapProps = ColorMapFunctionType | Uint8Array | ColorTableProps;
+export type ColormapProps = ColormapFunctionType | Uint8Array | ColorTableProps;
 
 /**
  * Represents the possible types that can be used as colormap properties.
  *
- * - `ColorMapFunctionType`: A function converting a value to a color.
+ * - `ColormapFunctionType`: A function converting a value to a color.
  * - `Uint8Array`: A typed array containing color data.
  * - `ColorTableDef`: An object representing a color table.
  */
-export type TColormapDef = ColorMapFunctionType | Uint8Array | ColorTableDef;
+export type TColormapDef = ColormapFunctionType | Uint8Array | ColorTableDef;
 
 /**
  * Creates an array of colors as RGB triplets in range [0, 1] using the colormap definition.
@@ -66,7 +68,7 @@ export function getImageData(
     type funcType = (x: number) => Color;
 
     if (colormapDef instanceof Uint8Array) {
-        // If colorMapProps is a Uint8Array, return it directly
+        // If colormapProps is a Uint8Array, return it directly
         return colormapDef;
     }
 

typescript/packages/subsurface-viewer/src/layers/wells/wellsLayer.ts

@@ -32,7 +32,7 @@ import {
     getLayersById,
     isDrawingEnabled,
 } from "../utils/layerTools";
-import type { ColorMapFunctionType } from "../utils/colormapTools";
+import type { ColormapFunctionType } from "../utils/colormapTools";
 
 import type {
     ContinuousLegendDataType,
@@ -110,7 +110,7 @@ export interface WellsLayerProps extends ExtendedLayerProps {
      */
     refine: boolean | number;
     wellHeadStyle: WellHeadStyleAccessor;
-    colorMappingFunction: ColorMapFunctionType;
+    colorMappingFunction: ColormapFunctionType;
     lineStyle: LineStyleAccessor;
 
     /**

typescript/packages/subsurface-viewer/src/storybook/layers/MapLayer.stories.tsx

@@ -15,7 +15,7 @@ import { ViewFooter } from "../../components/ViewFooter";
 import AxesLayer from "../../layers/axes/axesLayer";
 import MapLayer from "../../layers/map/mapLayer";
 import NorthArrow3DLayer from "../../layers/northarrow/northArrow3DLayer";
-import type { ColorMapFunctionType } from "../../layers/utils/colormapTools";
+import type { ColormapFunctionType } from "../../layers/utils/colormapTools";
 
 import {
     default2DViews,
@@ -501,7 +501,7 @@ const TypedArrayInputComponent: React.FC<{
                 material: true,
                 ZIncreasingDownwards: false,
                 contours: [0, 5],
-                colorMapFunction: nearestColormap as ColorMapFunctionType,
+                colorMapFunction: nearestColormap as ColormapFunctionType,
             },
             {
                 "@@type": "AxesLayer",

typescript/packages/well-log-viewer/src/Storybook/examples/MapAndWellLogViewer.tsx

@@ -34,16 +34,16 @@ import wellLogsJson from "../../../../../../example-data/volve_logs.json";
 import templateJson from "../../../../../../example-data/welllog_template_2.json";
 import colorTables from "../../../../../../example-data/wellpick_colors.json";
 import wellPicks from "../../../../../../example-data/wellpicks.json";
-import type { ColorMapFunction } from "../../utils/color-function";
+import type { ColormapFunction } from "../../utils/color-function";
 import { indexOfElementByName, isEqualRanges } from "../../utils/arrays";
 import { getDiscreteMeta } from "../../utils/well-log";
 
 const wellLogs = wellLogsJson as unknown as WellLogSet[];
 const template = templateJson as unknown as Template;
 
-const exampleColormapFunctions: ColorMapFunction[] = [
+const exampleColormapFunctions: ColormapFunction[] = [
     // copy color tables and add some color functions
-    ...(colorTables as ColorMapFunction[]),
+    ...(colorTables as ColormapFunction[]),
     {
         name: "Grey scale",
         func: (v: number) => [v * 255, v * 255, v * 255],