Chore/w3a controllers linting (#7455)

## Explanation

<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->
Fixed or suppressed linting for the following controllers ~
- `@metamask/subscription-controller`
- `@metamask/shield-controller`
- `@metamask/claims-controller`
- `@metamask/seedless-onboarding-controller`

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->
Fixes Shield-Controller: #7392 
Fixes Subscription-Controller:
#7395
Fixes Claims-Controller: #7349 
Fixes Seedless-Onboarding-Controller:
#7390

## Checklist

- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs)
- [x] I've introduced [breaking
changes](https://github.com/MetaMask/core/tree/main/docs/breaking-changes.md)
in this PR and have prepared draft pull requests for clients and
consumer packages to resolve them


<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Adds explicit TypeScript return types, minor refactors, and small
correctness tweaks across multiple controllers with corresponding test
and fixture updates.
> 
> - **Seedless Onboarding Controller**:
> - Add explicit return types across public/private APIs, helpers, and
tests; tighten generics and nullish coalescing.
> - Refactor `SecretMetadata.fromBatch` param names; type getters; minor
branch tweak in `#changeEncryptionKey` to use vault data when
`latestKeyIndex` is present.
> - Improve token-refresh wrapper typing; add ESLint suppressions for
test env crypto.
> - **Shield Controller**:
> - Add return types and JSDoc; rename internal `#getCoverageStatus` to
`#getCoverageShownStatus` and use it in logging.
> - Type-safe polling and backend helpers; refine error message fallback
and latency metrics typing.
> - **Subscription Controller/Service**:
> - Define precise return types (e.g., `getSubscriptions():
Subscription[]`, `cancel/unCancel: Promise<void>`), rename params for
clarity, and tighten validations.
> - Service: typed helpers, query handling, and safer defaults
(`assignedCohort ?? null`).
>   - Update tests/mocks to match new types.
> - **Claims**:
> - Add explicit return types in tests; enum members annotated to match
API format.
> - **Lint**:
> - Reduce/adjust ESLint suppressions to reflect fixed rules across the
touched packages.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
41d9596. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: lwin-kyaw

eslint-suppressions.json

@@ -963,21 +963,6 @@
       "count": 2
     }
   },
-  "packages/claims-controller/src/ClaimsController.test.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 1
-    }
-  },
-  "packages/claims-controller/src/ClaimsService.test.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 1
-    }
-  },
-  "packages/claims-controller/src/constants.ts": {
-    "@typescript-eslint/naming-convention": {
-      "count": 2
-    }
-  },
   "packages/composable-controller/src/ComposableController.test.ts": {
     "@typescript-eslint/explicit-function-return-type": {
       "count": 2
@@ -3011,97 +2996,6 @@
       "count": 1
     }
   },
-  "packages/seedless-onboarding-controller/jest.environment.js": {
-    "n/no-unsupported-features/node-builtins": {
-      "count": 1
-    }
-  },
-  "packages/seedless-onboarding-controller/src/SecretMetadata.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 3
-    },
-    "id-length": {
-      "count": 1
-    }
-  },
-  "packages/seedless-onboarding-controller/src/SeedlessOnboardingController.test.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 14
-    },
-    "@typescript-eslint/naming-convention": {
-      "count": 1
-    },
-    "id-length": {
-      "count": 1
-    },
-    "jest/unbound-method": {
-      "count": 1
-    },
-    "no-new": {
-      "count": 1
-    }
-  },
-  "packages/seedless-onboarding-controller/src/SeedlessOnboardingController.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 23
-    },
-    "@typescript-eslint/naming-convention": {
-      "count": 1
-    },
-    "@typescript-eslint/prefer-nullish-coalescing": {
-      "count": 3
-    },
-    "no-negated-condition": {
-      "count": 1
-    }
-  },
-  "packages/seedless-onboarding-controller/src/assertions.test.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 1
-    }
-  },
-  "packages/seedless-onboarding-controller/src/types.ts": {
-    "@typescript-eslint/naming-convention": {
-      "count": 4
-    }
-  },
-  "packages/seedless-onboarding-controller/tests/__fixtures__/mockMessenger.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 2
-    }
-  },
-  "packages/seedless-onboarding-controller/tests/__fixtures__/topfClient.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 7
-    }
-  },
-  "packages/seedless-onboarding-controller/tests/mocks/toprf.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 1
-    },
-    "@typescript-eslint/naming-convention": {
-      "count": 1
-    },
-    "@typescript-eslint/prefer-nullish-coalescing": {
-      "count": 1
-    }
-  },
-  "packages/seedless-onboarding-controller/tests/mocks/toprfEncryptor.ts": {
-    "@typescript-eslint/naming-convention": {
-      "count": 3
-    }
-  },
-  "packages/seedless-onboarding-controller/tests/mocks/vaultEncryptor.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 5
-    },
-    "@typescript-eslint/naming-convention": {
-      "count": 2
-    },
-    "@typescript-eslint/prefer-nullish-coalescing": {
-      "count": 2
-    }
-  },
   "packages/selected-network-controller/src/SelectedNetworkController.ts": {
     "@typescript-eslint/explicit-function-return-type": {
       "count": 4
@@ -3117,52 +3011,6 @@
       "count": 4
     }
   },
-  "packages/shield-controller/src/ShieldController.test.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 3
-    }
-  },
-  "packages/shield-controller/src/ShieldController.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 8
-    }
-  },
-  "packages/shield-controller/src/backend.test.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 1
-    }
-  },
-  "packages/shield-controller/src/backend.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 3
-    },
-    "@typescript-eslint/prefer-nullish-coalescing": {
-      "count": 1
-    }
-  },
-  "packages/shield-controller/src/polling-with-policy.test.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 1
-    }
-  },
-  "packages/shield-controller/src/polling-with-policy.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 4
-    },
-    "@typescript-eslint/unbound-method": {
-      "count": 1
-    }
-  },
-  "packages/shield-controller/tests/mocks/backend.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 1
-    }
-  },
-  "packages/shield-controller/tests/utils.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 2
-    }
-  },
   "packages/signature-controller/src/SignatureController.test.ts": {
     "@typescript-eslint/explicit-function-return-type": {
       "count": 5
@@ -3222,38 +3070,6 @@
       "count": 2
     }
   },
-  "packages/subscription-controller/src/SubscriptionController.test.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 4
-    }
-  },
-  "packages/subscription-controller/src/SubscriptionController.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 14
-    },
-    "id-length": {
-      "count": 13
-    }
-  },
-  "packages/subscription-controller/src/SubscriptionService.test.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 3
-    }
-  },
-  "packages/subscription-controller/src/SubscriptionService.ts": {
-    "@typescript-eslint/explicit-function-return-type": {
-      "count": 2
-    },
-    "@typescript-eslint/naming-convention": {
-      "count": 1
-    },
-    "@typescript-eslint/prefer-nullish-coalescing": {
-      "count": 1
-    },
-    "id-length": {
-      "count": 1
-    }
-  },
   "packages/token-search-discovery-controller/src/token-discovery-api-service/token-discovery-api-service.ts": {
     "@typescript-eslint/explicit-function-return-type": {
       "count": 1

packages/claims-controller/src/ClaimsController.test.ts

@@ -25,7 +25,7 @@ const mockClaimsServiceFetchClaimsConfigurations = jest.fn();
  */
 async function withController<ReturnValue>(
   ...args: WithControllerArgs<ReturnValue>
-) {
+): Promise<ReturnValue> {
   const [{ ...rest }, fn] = args.length === 2 ? args : [{}, args[0]];
   const { messenger, rootMessenger } = createMockClaimsControllerMessenger({
     mockClaimServiceRequestHeaders,

packages/claims-controller/src/ClaimsService.test.ts

@@ -21,7 +21,7 @@ const mockFetchFunction = jest.fn();
  * @param env - The environment to use for the mock claims service. Defaults to Env.DEV.
  * @returns A mock claims service.
  */
-function createMockClaimsService(env: Env = Env.DEV) {
+function createMockClaimsService(env: Env = Env.DEV): ClaimsService {
   const { messenger } = createMockClaimsServiceMessenger(
     mockAuthenticationControllerGetBearerToken,
   );

packages/claims-controller/src/constants.ts

@@ -16,8 +16,10 @@ export enum ClaimStatusEnum {
   // submitted to Intercom
   SUBMITTED = 'submitted',
   // in progress by Intercom
+  // eslint-disable-next-line @typescript-eslint/naming-convention -- to match the API response format
   IN_PROGRESS = 'in_progress',
   // waiting for customer reply
+  // eslint-disable-next-line @typescript-eslint/naming-convention -- to match the API response format
   WAITING_FOR_CUSTOMER = 'waiting_for_customer',
   // approved by Intercom
   APPROVED = 'approved',

packages/seedless-onboarding-controller/jest.environment.js

@@ -8,6 +8,7 @@ class CustomTestEnvironment extends NodeEnvironment {
   async setup() {
     await super.setup();
     if (typeof this.global.crypto === 'undefined') {
+      // eslint-disable-next-line n/no-unsupported-features/node-builtins -- this is a test environment
       this.global.crypto = require('crypto').webcrypto;
     }
   }

packages/seedless-onboarding-controller/src/SecretMetadata.ts

@@ -75,26 +75,26 @@ export class SecretMetadata<DataType extends SecretDataType = Uint8Array>
    * so that the first secret backup will have the oldest timestamp
    * and the last secret backup will have the newest timestamp.
    *
-   * @param data - The data to add metadata to.
-   * @param data.value - The SeedPhrase/PrivateKey to add metadata to.
-   * @param data.options - The options for the seed phrase metadata.
+   * @param batchData - The data to add metadata to.
+   * @param batchData.value - The SeedPhrase/PrivateKey to add metadata to.
+   * @param batchData.options - The options for the seed phrase metadata.
    * @returns The SecretMetadata instances.
    */
   static fromBatch<DataType extends SecretDataType = Uint8Array>(
-    data: {
+    batchData: {
       value: DataType;
       options?: Partial<SecretMetadataOptions>;
     }[],
   ): SecretMetadata<DataType>[] {
     const timestamp = Date.now();
-    return data.map((d, index) => {
+    return batchData.map((data, index) => {
       // To respect the order of the seed phrases, we add the index to the timestamp
       // so that the first seed phrase backup will have the oldest timestamp
       // and the last seed phrase backup will have the newest timestamp
-      const backupCreatedAt = d.options?.timestamp ?? timestamp + index * 5;
-      return new SecretMetadata(d.value, {
+      const backupCreatedAt = data.options?.timestamp ?? timestamp + index * 5;
+      return new SecretMetadata(data.value, {
         timestamp: backupCreatedAt,
-        type: d.options?.type,
+        type: data.options?.type,
       });
     });
   }
@@ -206,15 +206,15 @@ export class SecretMetadata<DataType extends SecretDataType = Uint8Array>
     return this.#data;
   }
 
-  get timestamp() {
+  get timestamp(): number {
     return this.#timestamp;
   }
 
-  get type() {
+  get type(): SecretType {
     return this.#type;
   }
 
-  get version() {
+  get version(): SecretMetadataVersion {
     return this.#version;
   }