refactor: fix Account.capabilities and parseAllRemoteImages types (#7219)

* refactor: fix Account capabilities types

* refactor: fix parseAllRemoteImages type errors

Author: serhalp

src/lib/account.ts

@@ -1,14 +1,7 @@
-/**
- * @param {any} account
- * @param {string} capability
- * @returns {boolean}
- */
-// @ts-expect-error TS(7006) FIXME: Parameter 'account' implicitly has an 'any' type.
-const supportsBooleanCapability = (account, capability) => Boolean(account?.capabilities?.[capability]?.included)
+import type { Account, Capability } from '../utils/dev.js'
 
-/**
- * @param {any} account
- * @returns {boolean}
- */
-// @ts-expect-error TS(7006) FIXME: Parameter 'account' implicitly has an 'any' type.
-export const supportsBackgroundFunctions = (account) => supportsBooleanCapability(account, 'background_functions')
+const supportsBooleanCapability = (account: Account | undefined, capability: Capability) =>
+  Boolean(account?.capabilities?.[capability]?.included)
+
+export const supportsBackgroundFunctions = (account?: Account): boolean =>
+  supportsBooleanCapability(account, 'background_functions')

src/lib/functions/server.ts

@@ -262,7 +262,7 @@ interface GetFunctionsServerOptions {
   functionsRegistry: FunctionsRegistry
   siteUrl: string
   siteInfo?: SiteInfo
-  accountId: string
+  accountId?: string | undefined
   geoCountry: string
   offline: boolean
   state: CLIState

src/lib/images/proxy.ts

@@ -31,7 +31,7 @@ interface IpxParams {
   position?: string | null
 }
 
-export const parseAllRemoteImages = function (config: NormalizedCachedConfigConfig): {
+export const parseAllRemoteImages = function (config: Pick<NormalizedCachedConfigConfig, 'images'>): {
   errors: ErrorObject[]
   remotePatterns: RegExp[]
 } {

src/utils/dev.ts

@@ -2,11 +2,13 @@ import process from 'process'
 
 import getPort from 'get-port'
 import isEmpty from 'lodash/isEmpty.js'
+import type { NetlifyAPI } from 'netlify'
 
 import { supportsBackgroundFunctions } from '../lib/account.js'
 
 import { NETLIFYDEVLOG, chalk, logAndThrowError, log, warn, APIError } from './command-helpers.js'
 import { loadDotEnvFiles } from './dot-env.js'
+import type { SiteInfo } from './types.js'
 
 // Possible sources of environment variables. For the purpose of printing log messages only. Order does not matter.
 const ENV_VAR_SOURCES = {
@@ -48,8 +50,21 @@ const validateSiteInfo = ({ site, siteInfo }) => {
   }
 }
 
-// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
-const getAccounts = async ({ api }) => {
+type ApiAccount = Awaited<ReturnType<NetlifyAPI['listAccountsForUser']>>[number]
+type Capabilities = NonNullable<ApiAccount['capabilities']> & {
+  // FIXME(serhalp): `background_functions` is missing from Netlify API account capabilities type
+  background_functions?:
+    | {
+        included?: boolean | undefined
+      }
+    | undefined
+}
+export type Capability = keyof Capabilities
+export type Account = ApiAccount & {
+  capabilities?: Capabilities
+}
+
+const getAccounts = async ({ api }: { api: NetlifyAPI }) => {
   try {
     const accounts = await api.listAccountsForUser()
     return accounts
@@ -83,13 +98,11 @@ const getAddonsInformation = ({ addons, siteInfo }) => {
   return { urls, env }
 }
 
-// @ts-expect-error TS(7031) FIXME: Binding element 'accounts' implicitly has an 'any'... Remove this comment to see the full error message
-const getSiteAccount = ({ accounts, siteInfo }) => {
-  // @ts-expect-error TS(7006) FIXME: Parameter 'account' implicitly has an 'any' type.
+const getSiteAccount = ({ accounts, siteInfo }: { accounts: Account[]; siteInfo: SiteInfo }): Account | undefined => {
   const siteAccount = accounts.find((account) => account.slug === siteInfo.account_slug)
   if (!siteAccount) {
     warn(`Could not find account for site '${siteInfo.name}' with account slug '${siteInfo.account_slug}'`)
-    return {}
+    return undefined
   }
   return siteAccount
 }
@@ -121,7 +134,7 @@ export const getSiteInformation = async ({ api, offline, site, siteInfo }) => {
     return {
       addonsUrls,
       siteUrl: siteInfo.ssl_url,
-      accountId: account.id,
+      accountId: account?.id,
       capabilities: {
         backgroundFunctions: supportsBackgroundFunctions(account),
       },

src/utils/proxy-server.ts

@@ -63,7 +63,7 @@ export const startProxyServer = async ({
   siteInfo,
   state,
 }: {
-  accountId: string
+  accountId: string | undefined
   addonsUrls: $TSFixMe
   api?: NetlifyOptions['api']
   blobsContext?: BlobsContextWithEdgeAccess

tests/unit/lib/account.test.ts

@@ -4,7 +4,6 @@ import { supportsBackgroundFunctions } from '../../../src/lib/account.js'
 
 describe('supportsBackgroundFunctions', () => {
   test(`should return false if no account`, () => {
-    // @ts-expect-error TS(2554) FIXME: Expected 1 arguments, but got 0.
     expect(supportsBackgroundFunctions()).toEqual(false)
   })
 
@@ -25,6 +24,7 @@ describe('supportsBackgroundFunctions', () => {
   })
 
   test(`should return true if included property is truthy`, () => {
+    // @ts-expect-error Intentional incorrect type. TODO(serhalp): Remove this test? Can this happen?
     expect(supportsBackgroundFunctions({ capabilities: { background_functions: { included: 'string' } } })).toEqual(
       true,
     )

tests/unit/lib/images/proxy.test.ts

@@ -8,7 +8,6 @@ test('should parse all remote images correctly', () => {
       remote_images: ['https://example.com/*', 'https://test.com/*'],
     },
   }
-  // @ts-expect-error TS(2345) FIXME: Argument of type '{ images: { remote_images: strin... Remove this comment to see the full error message
   const { errors, remotePatterns } = parseAllRemoteImages(config)
   expect(errors).toEqual([])
   expect(remotePatterns).toEqual([/https:\/\/example.com\/*/, /https:\/\/test.com\/*/])
@@ -20,7 +19,6 @@ test('should report invalid remote images', () => {
       remote_images: ['*'],
     },
   }
-  // @ts-expect-error TS(2345) FIXME: Argument of type '{ images: { remote_images: strin... Remove this comment to see the full error message
   const { errors, remotePatterns } = parseAllRemoteImages(config)
   expect(errors).toEqual([
     {