Enforce more immutable types (adazzle#1876)

Author: nstepien

src/Canvas.tsx

@@ -40,7 +40,7 @@ type SharedDataGridProps<R, K extends keyof R> = Pick<DataGridProps<R, K>,
 
 export interface CanvasProps<R, K extends keyof R> extends SharedDataGridProps<R, K> {
   columnMetrics: ColumnMetrics<R>;
-  viewportColumns: CalculatedColumn<R>[];
+  viewportColumns: readonly CalculatedColumn<R>[];
   height: number;
   scrollLeft: number;
   onScroll(position: ScrollPosition): void;

src/DataGrid.tsx

@@ -33,7 +33,7 @@ export { DataGridHandle };
 
 export interface DataGridProps<R, K extends keyof R> {
   /** An array of objects representing each column on the grid */
-  columns: Column<R>[];
+  columns: readonly Column<R>[];
   /** The minimum width of the grid in pixels */
   minWidth?: number;
   /** The height of the header row in pixels */
@@ -56,7 +56,7 @@ export interface DataGridProps<R, K extends keyof R> {
   /** Function called whenever keyboard key is pressed down */
   onGridKeyDown?(event: React.KeyboardEvent<HTMLDivElement>): void;
 
-  selectedRows?: Set<R[K]>;
+  selectedRows?: ReadonlySet<R[K]>;
   /** Function called whenever row selection is changed */
   onSelectedRowsChange?(selectedRows: Set<R[K]>): void;
 
@@ -122,7 +122,7 @@ export interface DataGridProps<R, K extends keyof R> {
    * Rows to be pinned at the bottom of the rows view for summary, the vertical scroll bar will not scroll these rows.
    * Bottom horizontal scroll bar can move the row left / right. Or a customized row renderer can be used to disabled the scrolling support.
    */
-  summaryRows?: R[];
+  summaryRows?: readonly R[];
   /** Control how big render row batches will be. */
   renderBatchSize?: number;
 }
@@ -189,7 +189,7 @@ function DataGrid<R, K extends keyof R>({
     });
   }, [columnMetrics, scrollLeft]);
 
-  const viewportColumns: CalculatedColumn<R>[] = useMemo(() => {
+  const viewportColumns: readonly CalculatedColumn<R>[] = useMemo(() => {
     if (!columnMetrics) return [];
 
     return getViewportColumns(

src/EventBus.ts

@@ -12,7 +12,7 @@ interface EventMap {
 type EventName = keyof EventMap;
 
 export default class EventBus {
-  readonly subscribers = new Map<EventName, Set<EventMap[EventName]>>();
+  private readonly subscribers = new Map<EventName, Set<EventMap[EventName]>>();
 
   subscribe<T extends EventName>(type: T, handler: EventMap[T]) {
     if (!this.subscribers.has(type)) {

src/FilterRow.tsx

@@ -14,7 +14,7 @@ export interface FilterRowProps<R, K extends keyof R> extends SharedDataGridProp
   height: number;
   width: number;
   lastFrozenColumnIndex: number;
-  columns: CalculatedColumn<R>[];
+  columns: readonly CalculatedColumn<R>[];
   scrollLeft: number | undefined;
 }
 

src/HeaderRow.tsx

@@ -21,7 +21,7 @@ export interface HeaderRowProps<R, K extends keyof R> extends SharedDataGridProp
   height: number;
   width: number;
   lastFrozenColumnIndex: number;
-  columns: CalculatedColumn<R>[];
+  columns: readonly CalculatedColumn<R>[];
   allRowsSelected: boolean;
   scrollLeft: number | undefined;
   onColumnResize(column: CalculatedColumn<R>, width: number): void;

src/common/types.ts

@@ -54,7 +54,7 @@ export type CalculatedColumn<TRow, TField extends keyof TRow = keyof TRow> =
   };
 
 export interface ColumnMetrics<TRow> {
-  columns: CalculatedColumn<TRow>[];
+  columns: readonly CalculatedColumn<TRow>[];
   lastFrozenColumnIndex: number;
   viewportWidth: number;
   totalColumnWidth: number;
@@ -150,7 +150,7 @@ export interface RowsContainerProps {
 export interface IRowRendererProps<TRow> {
   height: number;
   width: number;
-  viewportColumns: CalculatedColumn<TRow>[];
+  viewportColumns: readonly CalculatedColumn<TRow>[];
   row: TRow;
   cellRenderer?: React.ComponentType<CellRendererProps<TRow>>;
   idx: number;

src/utils/columnUtils.ts

@@ -2,8 +2,8 @@ import { Column, CalculatedColumn, ColumnMetrics, FormatterProps } from '../comm
 import { getScrollbarSize } from './domUtils';
 
 interface Metrics<R> {
-  columns: Column<R>[];
-  columnWidths: Map<keyof R, number>;
+  columns: readonly Column<R>[];
+  columnWidths: ReadonlyMap<keyof R, number>;
   minColumnWidth: number;
   viewportWidth: number;
   defaultFormatter: React.ComponentType<FormatterProps<R>>;
@@ -66,7 +66,7 @@ export function getColumnMetrics<R>(metrics: Metrics<R>): ColumnMetrics<R> {
 
 function getSpecifiedWidth<R>(
   column: Column<R>,
-  columnWidths: Map<keyof R, number>,
+  columnWidths: ReadonlyMap<keyof R, number>,
   viewportWidth: number,
   minColumnWidth: number
 ): number | void {
@@ -92,7 +92,7 @@ export function canEdit<R>(column: CalculatedColumn<R>, rowData: R, enableCellSe
   return enableCellSelect === true && (!!column.editor || !!column.editable);
 }
 
-export function getColumnScrollPosition<R>(columns: CalculatedColumn<R>[], idx: number, currentScrollLeft: number, currentClientWidth: number): number {
+export function getColumnScrollPosition<R>(columns: readonly CalculatedColumn<R>[], idx: number, currentScrollLeft: number, currentClientWidth: number): number {
   let left = 0;
   let frozen = 0;
 

src/utils/selectedCellUtils.ts

@@ -6,7 +6,7 @@ const getRowTop = (rowIdx: number, rowHeight: number): number => rowIdx * rowHei
 
 interface getSelectedDimensionsOpts<R> {
   selectedPosition: Position;
-  columns: CalculatedColumn<R>[];
+  columns: readonly CalculatedColumn<R>[];
   rowHeight: number;
   scrollLeft: number;
 }
@@ -25,7 +25,7 @@ export function getSelectedDimensions<R>({ selectedPosition: { idx, rowIdx }, co
 
 interface getSelectedRangeDimensionsOpts<R> {
   selectedRange: Range;
-  columns: CalculatedColumn<R>[];
+  columns: readonly CalculatedColumn<R>[];
   rowHeight: number;
 }
 
@@ -52,7 +52,7 @@ export function getSelectedRangeDimensions<R>({ selectedRange: { topLeft, bottom
 
 interface getSelectedCellValueOpts<R> {
   selectedPosition: Position;
-  columns: CalculatedColumn<R>[];
+  columns: readonly CalculatedColumn<R>[];
   rowGetter: RowGetter<R>;
 }
 
@@ -66,7 +66,7 @@ export function getSelectedCellValue<R>({ selectedPosition, columns, rowGetter }
 interface isSelectedCellEditableOpts<R> {
   enableCellSelect: boolean;
   selectedPosition: Position;
-  columns: CalculatedColumn<R>[];
+  columns: readonly CalculatedColumn<R>[];
   rowGetter: RowGetter<R>;
   onCheckCellIsEditable?(arg: { row: R; column: CalculatedColumn<R> } & Position): boolean;
 }
@@ -80,7 +80,7 @@ export function isSelectedCellEditable<R>({ enableCellSelect, selectedPosition,
 
 interface getNextSelectedCellPositionOpts<R> {
   cellNavigationMode: CellNavigationMode;
-  columns: CalculatedColumn<R>[];
+  columns: readonly CalculatedColumn<R>[];
   rowsCount: number;
   nextPosition: Position;
 }
@@ -130,7 +130,7 @@ export function getNextSelectedCellPosition<R>({ cellNavigationMode, columns, ro
 
 interface canExitGridOpts<R> {
   cellNavigationMode: CellNavigationMode;
-  columns: CalculatedColumn<R>[];
+  columns: readonly CalculatedColumn<R>[];
   rowsCount: number;
   selectedPosition: Position;
 }

src/utils/viewportUtils.ts

@@ -1,6 +1,6 @@
 import { CalculatedColumn, ColumnMetrics } from '../common/types';
 
-function getTotalFrozenColumnWidth<R>(columns: CalculatedColumn<R>[], lastFrozenColumnIndex: number): number {
+function getTotalFrozenColumnWidth<R>(columns: readonly CalculatedColumn<R>[], lastFrozenColumnIndex: number): number {
   if (lastFrozenColumnIndex === -1) {
     return 0;
   }
@@ -77,7 +77,7 @@ export function getHorizontalRangeToRender<R>({
   return [colOverscanStartIdx, colOverscanEndIdx];
 }
 
-export function getViewportColumns<R>(columns: CalculatedColumn<R>[], colOverscanStartIdx: number, colOverscanEndIdx: number) {
+export function getViewportColumns<R>(columns: readonly CalculatedColumn<R>[], colOverscanStartIdx: number, colOverscanEndIdx: number) {
   const viewportColumns: CalculatedColumn<R>[] = [];
   for (let colIdx = 0; colIdx <= colOverscanEndIdx; colIdx++) {
     const column = columns[colIdx];