Add types

Author: CarolineDenis

specifyweb/frontend/js_src/lib/components/WorkBench/hooks.ts

@@ -1,5 +1,5 @@
 import type Handsontable from 'handsontable';
-import type { Events } from 'handsontable/pluginHooks';
+import type { Hooks } from 'handsontable';
 import type { Action } from 'handsontable/plugins/undoRedo';
 import React from 'react';
 
@@ -32,7 +32,7 @@ export function useHotHooks({
   readonly checkDeletedFail: (statusCode: number) => boolean;
   readonly isReadOnly: boolean;
   readonly isResultsOpen: boolean;
-}): Partial<Events> {
+}): Partial<Hooks> {
   let sortConfigIsSet: boolean = false;
   const loading = React.useContext(LoadingContext);
 
@@ -45,7 +45,13 @@ export function useHotHooks({
      * cases
      *
      */
-    afterRenderer: (td, visualRow, visualCol, property, _value) => {
+    afterRenderer: (
+      td: HTMLTableCellElement,
+      visualRow: number,
+      visualCol: number,
+      property: number | string,
+      _value: unknown
+    ) => {
       if (workbench.hot === undefined) {
         td.classList.add('text-gray-500');
         return;
@@ -83,7 +89,11 @@ export function useHotHooks({
     },
 
     // Make HOT use defaultValues for validation if cell is empty
-    beforeValidate: (value, _visualRow, property) => {
+    beforeValidate: (
+      value: unknown,
+      _visualRow: number,
+      property: number | string
+    ) => {
       if (Boolean(value) || workbench.hot === undefined) return value;
 
       const visualCol = workbench.hot.propToCol(property);
@@ -93,10 +103,10 @@ export function useHotHooks({
     },
 
     afterValidate: (
-      isValid,
-      value: string | null = '',
-      visualRow,
-      property
+      isValid: boolean,
+      value: string | null,
+      visualRow: number,
+      property: number | string
     ) => {
       if (workbench.hot === undefined) return;
       const visualCol = workbench.hot.propToCol(property);
@@ -158,7 +168,15 @@ export function useHotHooks({
      * arguments that are inconvenient to work with
      *
      */
-    beforeChange: (unfilteredChanges, source) => {
+    beforeChange: (
+      unfilteredChanges: readonly (readonly [
+        number,
+        number | string,
+        unknown,
+        unknown,
+      ])[],
+      source: string
+    ) => {
       if (source !== 'CopyPaste.paste') return true;
 
       const filteredChanges = unfilteredChanges.filter(
@@ -181,7 +199,15 @@ export function useHotHooks({
       return false;
     },
 
-    afterChange: (unfilteredChanges, source) => {
+    afterChange: (
+      unfilteredChanges: readonly (readonly [
+        number,
+        number | string,
+        unknown,
+        unknown,
+      ])[],
+      source: string
+    ) => {
       if (
         ![
           'edit',
@@ -307,7 +333,11 @@ export function useHotHooks({
      * beforeCreateRow, instead of afterCreateRow
      *
      */
-    beforeCreateRow: (visualRowStart, amount, source) => {
+    beforeCreateRow: (
+      visualRowStart: number,
+      amount: number,
+      source?: string
+    ) => {
       const addedRows = Array.from(
         { length: amount },
         (_, index) =>
@@ -332,7 +362,12 @@ export function useHotHooks({
       return true;
     },
 
-    beforeRemoveRow: (visualRowStart, amount, _, source) => {
+    beforeRemoveRow: (
+      visualRowStart: number,
+      amount: number,
+      _,
+      source?: string
+    ) => {
       if (workbench.hot === undefined) return;
       // Get indexes of removed rows in reverse order
       const removedRows = Array.from({ length: amount }, (_, index) =>
@@ -363,7 +398,10 @@ export function useHotHooks({
      * finding all lower level ranks of that tree (within the same -to-many)
      * and sorting them in the same direction
      */
-    beforeColumnSort: (currentSortConfig, newSortConfig) => {
+    beforeColumnSort: (
+      currentSortConfig: readonly Handsontable.plugins.ColumnSorting.Config[],
+      newSortConfig: readonly Handsontable.plugins.ColumnSorting.Config[]
+    ) => {
       workbench.cells.indexedCellMeta = undefined;
 
       if (
@@ -455,7 +493,10 @@ export function useHotHooks({
     },
 
     // Cache sort config to preserve column sort order across sessions
-    afterColumnSort: async (_previousSortConfig, sortConfig) => {
+    afterColumnSort: async (
+      _previousSortConfig: readonly Handsontable.plugins.ColumnSorting.Config[],
+      sortConfig: readonly Handsontable.plugins.ColumnSorting.Config[]
+    ) => {
       if (workbench.hot === undefined) return;
       const physicalSortConfig = sortConfig.map((rest) => ({
         ...rest,
@@ -468,12 +509,20 @@ export function useHotHooks({
       );
     },
 
-    beforeColumnMove: (_columnIndexes, _finalIndex, dropIndex) =>
+    beforeColumnMove: (
+      _columnIndexes: readonly number[],
+      _finalIndex: number,
+      dropIndex?: number
+    ) =>
       !isResultsOpen &&
       (dropIndex !== undefined || workbench.hot !== undefined),
 
     // Save new visualOrder on the back end
-    afterColumnMove: (_columnIndexes, _finalIndex, dropIndex) => {
+    afterColumnMove: (
+      _columnIndexes: readonly number[],
+      _finalIndex: number,
+      dropIndex?: number
+    ) => {
       // An ugly fix for jQuery's dialogs conflicting with HOT
       if (dropIndex === undefined || workbench.hot == undefined) return;
       workbench.cells.indexedCellMeta = undefined;
@@ -500,7 +549,15 @@ export function useHotHooks({
     },
 
     // Do not scroll the viewport to the last column after inserting a row
-    afterPaste: (data, coords) => {
+    afterPaste: (
+      data: readonly (readonly string[])[],
+      coords: readonly {
+        readonly startRow: number;
+        readonly startCol: number;
+        readonly endRow: number;
+        readonly endCol: number;
+      }[]
+    ) => {
       const lastCoords = coords.at(-1);
       if (
         typeof lastCoords === 'object' &&