Improve type safety of tool definitions (Stirling-Tools#6895)

# Description of Changes
Followup work requested in review of Stirling-Tools#6867. Currently, there is nothing
enforcing that the endpoint chosen in the tool config is the correct
mapping for `toApiParams`, so theoretically it's possible for a tool to
be set up to call an endpoint with the wrong API params for it. There's
also nothing currently enforcing that `toApiParams` and `fromApiParams`
are compatible with each other (using the same types). This PR changes
it so that instead of creating the config object directly, tools create
it via a generic function, which enforces that all of the relevant
mappings are using compatible types.

Author: jbrunton96

frontend/editor/src/core/components/tools/addPageNumbers/useAddPageNumbersOperation.ts

@@ -1,7 +1,7 @@
 import { useTranslation } from "react-i18next";
 import {
-  ToolType,
   useToolOperation,
+  defineSingleFileTool,
 } from "@app/hooks/tools/shared/useToolOperation";
 import {
   objectToFormData,
@@ -73,15 +73,14 @@ export const buildAddPageNumbersFormData = (
 ): FormData =>
   objectToFormData(addPageNumbersToApiParams(parameters), { fileInput: file });
 
-export const addPageNumbersOperationConfig = {
-  toolType: ToolType.singleFile,
+export const addPageNumbersOperationConfig = defineSingleFileTool({
   buildFormData: buildAddPageNumbersFormData,
   toApiParams: addPageNumbersToApiParams,
   fromApiParams: addPageNumbersFromApiParams,
   operationType: "addPageNumbers",
   endpoint: ENDPOINT,
   defaultParameters,
-} as const;
+});
 
 export const useAddPageNumbersOperation = () => {
   const { t } = useTranslation();

frontend/editor/src/core/components/tools/addStamp/useAddStampOperation.ts

@@ -1,7 +1,7 @@
 import { useTranslation } from "react-i18next";
 import {
-  ToolType,
   useToolOperation,
+  defineSingleFileTool,
 } from "@app/hooks/tools/shared/useToolOperation";
 import {
   objectToFormData,
@@ -87,15 +87,14 @@ export const buildAddStampFormData = (
       : { fileInput: file },
   );
 
-export const addStampOperationConfig = {
-  toolType: ToolType.singleFile,
+export const addStampOperationConfig = defineSingleFileTool({
   buildFormData: buildAddStampFormData,
   toApiParams: addStampToApiParams,
   fromApiParams: addStampFromApiParams,
   operationType: "addStamp",
   endpoint: ENDPOINT,
   defaultParameters,
-} as const;
+});
 
 export const useAddStampOperation = () => {
   const { t } = useTranslation();

frontend/editor/src/core/hooks/tools/addAttachments/useAddAttachmentsOperation.ts

@@ -1,8 +1,7 @@
 import { useTranslation } from "react-i18next";
 import {
   useToolOperation,
-  ToolOperationConfig,
-  ToolType,
+  defineSingleFileTool,
 } from "@app/hooks/tools/shared/useToolOperation";
 import {
   objectToFormData,
@@ -48,16 +47,14 @@ const buildFormData = (
   });
 
 // Operation configuration for automation
-export const addAttachmentsOperationConfig: ToolOperationConfig<AddAttachmentsParameters> =
-  {
-    toolType: ToolType.singleFile,
-    buildFormData,
-    toApiParams: addAttachmentsToApiParams,
-    fromApiParams: addAttachmentsFromApiParams,
-    operationType: "addAttachments",
-    endpoint: ENDPOINT,
-    defaultParameters: DEFAULT_ADD_ATTACHMENTS_PARAMETERS,
-  };
+export const addAttachmentsOperationConfig = defineSingleFileTool({
+  buildFormData,
+  toApiParams: addAttachmentsToApiParams,
+  fromApiParams: addAttachmentsFromApiParams,
+  operationType: "addAttachments",
+  endpoint: ENDPOINT,
+  defaultParameters: DEFAULT_ADD_ATTACHMENTS_PARAMETERS,
+});
 
 export const useAddAttachmentsOperation = () => {
   const { t } = useTranslation();

frontend/editor/src/core/hooks/tools/addPassword/useAddPasswordOperation.ts

@@ -1,7 +1,7 @@
 import { useTranslation } from "react-i18next";
 import {
-  ToolType,
   useToolOperation,
+  defineSingleFileTool,
 } from "@app/hooks/tools/shared/useToolOperation";
 import {
   objectToFormData,
@@ -85,15 +85,14 @@ const fullDefaultParameters: AddPasswordFullParameters = {
 };
 
 // Static configuration object
-export const addPasswordOperationConfig = {
-  toolType: ToolType.singleFile,
+export const addPasswordOperationConfig = defineSingleFileTool({
   buildFormData: buildAddPasswordFormData,
   toApiParams: addPasswordToApiParams,
   fromApiParams: addPasswordFromApiParams,
   operationType: "addPassword",
   endpoint: ENDPOINT,
   defaultParameters: fullDefaultParameters,
-} as const;
+});
 
 export const useAddPasswordOperation = () => {
   const { t } = useTranslation();

frontend/editor/src/core/hooks/tools/addWatermark/useAddWatermarkOperation.ts

@@ -1,7 +1,7 @@
 import { useTranslation } from "react-i18next";
 import {
-  ToolType,
   useToolOperation,
+  defineSingleFileTool,
 } from "@app/hooks/tools/shared/useToolOperation";
 import {
   objectToFormData,
@@ -87,15 +87,14 @@ export const buildAddWatermarkFormData = (
   );
 
 // Static configuration object
-export const addWatermarkOperationConfig = {
-  toolType: ToolType.singleFile,
+export const addWatermarkOperationConfig = defineSingleFileTool({
   buildFormData: buildAddWatermarkFormData,
   toApiParams: addWatermarkToApiParams,
   fromApiParams: addWatermarkFromApiParams,
   operationType: "watermark",
   endpoint: ENDPOINT,
   defaultParameters,
-} as const;
+});
 
 export const useAddWatermarkOperation = () => {
   const { t } = useTranslation();

frontend/editor/src/core/hooks/tools/adjustContrast/useAdjustContrastOperation.ts

@@ -1,6 +1,6 @@
 import { useTranslation } from "react-i18next";
 import {
-  ToolType,
+  defineCustomTool,
   useToolOperation,
   CustomProcessorResult,
 } from "@app/hooks/tools/shared/useToolOperation";
@@ -195,14 +195,11 @@ async function processPdfClientSide(
   };
 }
 
-export const adjustContrastOperationConfig = {
-  toolType: ToolType.custom,
+export const adjustContrastOperationConfig = defineCustomTool({
   customProcessor: processPdfClientSide,
   operationType: "adjustContrast",
   defaultParameters,
-  settingsComponentPath:
-    "components/tools/adjustContrast/AdjustContrastSingleStepSettings",
-} as const;
+});
 
 export const useAdjustContrastOperation = () => {
   const { t } = useTranslation();

frontend/editor/src/core/hooks/tools/adjustPageScale/useAdjustPageScaleOperation.ts

@@ -1,7 +1,7 @@
 import { useTranslation } from "react-i18next";
 import {
   useToolOperation,
-  ToolType,
+  defineSingleFileTool,
 } from "@app/hooks/tools/shared/useToolOperation";
 import { createStandardErrorHandler } from "@app/utils/toolErrorHandler";
 import {
@@ -21,15 +21,14 @@ export {
   adjustPageScaleFromApiParams,
 };
 
-export const adjustPageScaleOperationConfig = {
-  toolType: ToolType.singleFile,
+export const adjustPageScaleOperationConfig = defineSingleFileTool({
   buildFormData: buildAdjustPageScaleFormData,
   toApiParams: adjustPageScaleToApiParams,
   fromApiParams: adjustPageScaleFromApiParams,
   operationType: "scalePages",
   endpoint: ADJUST_PAGE_SCALE_ENDPOINT,
   defaultParameters,
-} as const;
+});
 
 export const useAdjustPageScaleOperation = () => {
   const { t } = useTranslation();

frontend/editor/src/core/hooks/tools/autoRename/useAutoRenameOperation.ts

@@ -1,7 +1,7 @@
 import { useTranslation } from "react-i18next";
 import {
-  ToolType,
   useToolOperation,
+  defineSingleFileTool,
 } from "@app/hooks/tools/shared/useToolOperation";
 import {
   objectToFormData,
@@ -44,16 +44,15 @@ export const buildAutoRenameFormData = (
   objectToFormData(autoRenameToApiParams(parameters), { fileInput: file });
 
 // Static configuration object
-export const autoRenameOperationConfig = {
-  toolType: ToolType.singleFile,
+export const autoRenameOperationConfig = defineSingleFileTool({
   buildFormData: buildAutoRenameFormData,
   toApiParams: autoRenameToApiParams,
   fromApiParams: autoRenameFromApiParams,
   operationType: "autoRename",
   endpoint: ENDPOINT,
   preserveBackendFilename: true, // Use filename from backend response headers
   defaultParameters,
-} as const;
+});
 
 export const useAutoRenameOperation = () => {
   const { t } = useTranslation();

frontend/editor/src/core/hooks/tools/automate/useAutomateOperation.ts

@@ -1,5 +1,5 @@
 import {
-  ToolType,
+  defineCustomTool,
   useToolOperation,
 } from "@app/hooks/tools/shared/useToolOperation";
 import { useCallback } from "react";
@@ -55,10 +55,11 @@ export function useAutomateOperation() {
     [toolRegistry],
   );
 
-  return useToolOperation<AutomateParameters>({
-    toolType: ToolType.custom,
-    operationType: "automate",
-    customProcessor,
-    consumesAllInputs: true,
-  });
+  return useToolOperation<AutomateParameters>(
+    defineCustomTool({
+      operationType: "automate",
+      customProcessor,
+      consumesAllInputs: true,
+    }),
+  );
 }

frontend/editor/src/core/hooks/tools/bookletImposition/useBookletImpositionOperation.ts

@@ -1,7 +1,7 @@
 import { useTranslation } from "react-i18next";
 import {
   useToolOperation,
-  ToolType,
+  defineSingleFileTool,
 } from "@app/hooks/tools/shared/useToolOperation";
 import {
   objectToFormData,
@@ -59,15 +59,14 @@ export const buildBookletImpositionFormData = (
   });
 
 // Static configuration object
-export const bookletImpositionOperationConfig = {
-  toolType: ToolType.singleFile,
+export const bookletImpositionOperationConfig = defineSingleFileTool({
   buildFormData: buildBookletImpositionFormData,
   toApiParams: bookletImpositionToApiParams,
   fromApiParams: bookletImpositionFromApiParams,
   operationType: "bookletImposition",
   endpoint: ENDPOINT,
   defaultParameters,
-} as const;
+});
 
 export const useBookletImpositionOperation = () => {
   const { t } = useTranslation();