fix: Fix compiler warnings from the TiCS dashboard

steverydz · steverydz · commit 5ef72adbcff5 · 2025-04-09T10:59:28.000+01:00
diff --git a/static/js/publisher/components/UpdateMetadataModal/UpdateMetadataModal.tsx b/static/js/publisher/components/UpdateMetadataModal/UpdateMetadataModal.tsx
@@ -1,9 +1,12 @@
 import { Dispatch, SetStateAction } from "react";
+import { FieldValues } from "react-hook-form";
 import { Modal, Button } from "@canonical/react-components";
 
+import { UseMutateFunction } from "react-query";
+
 type Props = {
   setShowMetadataWarningModal: Dispatch<SetStateAction<boolean>>;
-  submitForm: (arg: { [key: string]: unknown }) => void;
+  submitForm: UseMutateFunction<void, unknown, FieldValues, unknown>;
   formData: { [key: string]: unknown };
 };
 
diff --git a/static/js/publisher/pages/Listing/ListingForm/ListingForm.tsx b/static/js/publisher/pages/Listing/ListingForm/ListingForm.tsx
@@ -74,8 +74,7 @@ function ListingForm({ data, refetch }: Props): React.JSX.Element {
     <>
       <form
         className="p-form"
-        // @ts-expect-error Conflict between React Query and Reach Hook Form
-        onSubmit={handleSubmit((values: ListingData) => {
+        onSubmit={handleSubmit((values: FieldValues) => {
           if (
             data.update_metadata_on_release &&
             shouldShowUpdateMetadataWarning(dirtyFields)
diff --git a/static/js/publisher/pages/Metrics/metrics/graphs/activeDevicesGraph/rendering.ts b/static/js/publisher/pages/Metrics/metrics/graphs/activeDevicesGraph/rendering.ts
@@ -18,7 +18,7 @@ function renderXAxis(this: any) {
 
   let monthCache: string;
 
-  xAxis.selectAll(".tick").each((d: any, i: number, nodes: string | any[]) => {
+  xAxis.selectAll(".tick").each((_d: any, i: number, nodes: string | any[]) => {
     const node = select(nodes[i]);
     if (i % freq !== 0 && nodes.length > 7) {
       node.select("text").attr("opacity", "0");
@@ -50,7 +50,7 @@ function renderYAxis(this: any) {
 
   yAxis
     .selectAll(".tick")
-    .each((d: any, i: number, nodes: { [x: string]: any }) => {
+    .each((_d: any, i: number, nodes: { [x: string]: any }) => {
       const node = select(nodes[i]);
       if (i % freq === 0) {
         node.classed("active", true);
@@ -153,7 +153,7 @@ function renderAnnotations(this: any) {
             .attr("transform", `translate(${annotation.x - textBox.width},10)`)
             .attr("x", 0);
         }
-      }
+      },
     );
   }
 }
diff --git a/static/js/publisher/pages/PublisherSettings/PublisherSettingsForm.tsx b/static/js/publisher/pages/PublisherSettings/PublisherSettingsForm.tsx
@@ -1,5 +1,5 @@
 import { useState, useEffect } from "react";
-import { useForm, useWatch } from "react-hook-form";
+import { FieldValues, useForm, useWatch } from "react-hook-form";
 import {
   Button,
   Form,
@@ -18,10 +18,8 @@ import { UnregisterSnapModal } from "./UnregisterSnapModal";
 
 import { getSettingsData, getSettingsFormData } from "../../utils";
 
-import type { SettingsData } from "../../types";
-
 type Props = {
-  settings: SettingsData;
+  settings: FieldValues;
 };
 
 function PublisherSettingsForm({ settings }: Props) {
@@ -68,7 +66,7 @@ function PublisherSettingsForm({ settings }: Props) {
     name: "blacklist_country_keys",
   });
 
-  const onSubmit = (data: SettingsData) => {
+  const onSubmit = (data: FieldValues) => {
     if (getValues("update_metadata_on_release") && dirtyFields.visibility) {
       setShowMetadataWarningModal(true);
       setFormData(data);
@@ -77,7 +75,7 @@ function PublisherSettingsForm({ settings }: Props) {
     }
   };
 
-  const submitForm = async (data: SettingsData) => {
+  const submitForm = async (data: FieldValues) => {
     setIsSaving(true);
     setHasSaved(false);
     setSavedError(false);
@@ -334,13 +332,9 @@ function PublisherSettingsForm({ settings }: Props) {
                     data={countries}
                     field="whitelist_country_keys"
                     currentValues={settingsData?.whitelist_countries}
-                    // @ts-expect-error Conflict between React Query and React Hook Form
                     register={register}
-                    // @ts-expect-error Conflict between React Query and React Hook Form
                     setValue={setValue}
-                    // @ts-expect-error Conflict between React Query and React Hook Form
                     getValues={getValues}
-                    // @ts-expect-error Conflict between React Query and React Hook Form
                     control={control}
                     disabled={getValues("country_keys_status") === "exclude"}
                   />
@@ -364,13 +358,9 @@ function PublisherSettingsForm({ settings }: Props) {
                     data={countries}
                     field="blacklist_country_keys"
                     currentValues={settingsData?.blacklist_countries}
-                    // @ts-expect-error Conflict between React Query and React Hook Form
                     register={register}
-                    // @ts-expect-error Conflict between React Query and React Hook Form
                     setValue={setValue}
-                    // @ts-expect-error Conflict between React Query and React Hook Form
                     getValues={getValues}
-                    // @ts-expect-error Conflict between React Query and React Hook Form
                     control={control}
                     disabled={getValues("country_keys_status") === "include"}
                   />
@@ -537,7 +527,6 @@ function PublisherSettingsForm({ settings }: Props) {
       {showMetadataWarningModal ? (
         <UpdateMetadataModal
           setShowMetadataWarningModal={setShowMetadataWarningModal}
-          // @ts-expect-error Conflict between React Query and React Hook Form
           submitForm={submitForm}
           formData={formData}
         />
diff --git a/static/js/publisher/pages/Releases/constants.ts b/static/js/publisher/pages/Releases/constants.ts
diff --git a/static/js/publisher/types/index.ts b/static/js/publisher/types/index.ts
@@ -13,27 +13,6 @@ export type ValidationSet = {
   timestamp: string;
 };
 
-export type SettingsData = {
-  blacklist_countries: string[];
-  blacklist_country_keys: string;
-  countries: Array<{ key: string; name: string }>;
-  country_keys_status: string | null;
-  private: boolean;
-  publisher_name: string;
-  snap_id: string;
-  snap_name: string;
-  snap_title: string;
-  status: string;
-  store: string;
-  territory_distribution_status: string;
-  unlisted: boolean;
-  update_metadata_on_release: boolean;
-  visibility: string;
-  visibility_locked: boolean;
-  whitelist_countries: string[];
-  whitelist_country_keys: string;
-};
-
 export type TourStep = {
   id: string;
   position?: string;
diff --git a/static/js/publisher/utils/getSettingsChanges.ts b/static/js/publisher/utils/getSettingsChanges.ts
@@ -1,8 +1,8 @@
-import type { SettingsData } from "../types";
+import { FieldValues } from "react-hook-form";
 
 function getSettingsChanges(
   dirtyFields: { [key: string]: unknown },
-  data: SettingsData,
+  data: FieldValues,
 ) {
   const changes: { [key: string]: unknown } = {};
 
diff --git a/static/js/publisher/utils/getSettingsData.ts b/static/js/publisher/utils/getSettingsData.ts
@@ -1,14 +1,14 @@
-import type { SettingsData } from "../types";
+import { FieldValues } from "react-hook-form";
 
-function getCountryKeysStatus(settingsData: SettingsData) {
+function getCountryKeysStatus(settingsData: FieldValues) {
   if (settingsData?.blacklist_country_keys) {
     return "exclude";
   }
 
   return "include";
 }
 
-function getTerritoryDistributionStatus(data: SettingsData) {
+function getTerritoryDistributionStatus(data: FieldValues) {
   if (
     data?.whitelist_countries.length > 0 ||
     data?.blacklist_countries.length > 0
@@ -19,7 +19,7 @@ function getTerritoryDistributionStatus(data: SettingsData) {
   }
 }
 
-function getVisibilityStatus(data: SettingsData) {
+function getVisibilityStatus(data: FieldValues) {
   if (data?.unlisted) {
     return "unlisted";
   }
@@ -31,7 +31,7 @@ function getVisibilityStatus(data: SettingsData) {
   return "public";
 }
 
-function getSettingsData(settingsData: SettingsData) {
+function getSettingsData(settingsData: FieldValues) {
   settingsData.visibility = getVisibilityStatus(settingsData);
   settingsData.territory_distribution_status =
     getTerritoryDistributionStatus(settingsData);
diff --git a/static/js/publisher/utils/getSettingsFormData.ts b/static/js/publisher/utils/getSettingsFormData.ts
@@ -1,11 +1,11 @@
 import getSettingsChanges from "./getSettingsChanges";
 
-import type { SettingsData } from "../types";
+import { FieldValues } from "react-hook-form";
 
 function getSettingsFormData(
-  settingsData: SettingsData,
+  settingsData: FieldValues,
   dirtyFields: { [key: string]: unknown },
-  data: SettingsData,
+  data: FieldValues,
 ) {
   const changes = getSettingsChanges(dirtyFields, data);
   const formData = new FormData();

Original file line number	Diff line number	Diff line change
`@@ -1,14 +1,14 @@`
`1`		`-import type { SettingsData } from "../types";`
	`1`	`+import { FieldValues } from "react-hook-form";`
`2`	`2`
`3`		`-function getCountryKeysStatus(settingsData: SettingsData) {`
	`3`	`+function getCountryKeysStatus(settingsData: FieldValues) {`
`4`	`4`	`if (settingsData?.blacklist_country_keys) {`
`5`	`5`	`return "exclude";`
`6`	`6`	`}`
`7`	`7`
`8`	`8`	`return "include";`
`9`	`9`	`}`
`10`	`10`
`11`		`-function getTerritoryDistributionStatus(data: SettingsData) {`
	`11`	`+function getTerritoryDistributionStatus(data: FieldValues) {`
`12`	`12`	`if (`
`13`	`13`	`data?.whitelist_countries.length > 0 \|\|`
`14`	`14`	`data?.blacklist_countries.length > 0`
`@@ -19,7 +19,7 @@ function getTerritoryDistributionStatus(data: SettingsData) {`
`19`	`19`	`}`
`20`	`20`	`}`
`21`	`21`
`22`		`-function getVisibilityStatus(data: SettingsData) {`
	`22`	`+function getVisibilityStatus(data: FieldValues) {`
`23`	`23`	`if (data?.unlisted) {`
`24`	`24`	`return "unlisted";`
`25`	`25`	`}`
`@@ -31,7 +31,7 @@ function getVisibilityStatus(data: SettingsData) {`
`31`	`31`	`return "public";`
`32`	`32`	`}`
`33`	`33`
`34`		`-function getSettingsData(settingsData: SettingsData) {`
	`34`	`+function getSettingsData(settingsData: FieldValues) {`
`35`	`35`	`settingsData.visibility = getVisibilityStatus(settingsData);`
`36`	`36`	`settingsData.territory_distribution_status =`
`37`	`37`	`getTerritoryDistributionStatus(settingsData);`