types: fix 13 @ts-expect-errors in build command (#7048)

serhalp · web-flow · commit b5a5c7525edd · 2025-02-20T11:33:37.000-05:00
diff --git a/src/commands/build/build.ts b/src/commands/build/build.ts
@@ -1,17 +1,12 @@
-import { OptionValues } from 'commander'
+import type { OptionValues } from 'commander'
 
-import { getBuildOptions, runBuild } from '../../lib/build.js'
+import { type BuildConfig, getBuildOptions, runBuild } from '../../lib/build.js'
 import { detectFrameworkSettings, getDefaultConfig } from '../../utils/build-info.js'
 import { error, exit, getToken } from '../../utils/command-helpers.js'
 import { getEnvelopeEnv } from '../../utils/env/index.js'
-import BaseCommand from '../base-command.js'
-
-/**
- * @param {import('../../lib/build.js').BuildConfig} options
- */
-// @ts-expect-error TS(7031) FIXME: Binding element 'token' implicitly has an 'any' ty... Remove this comment to see the full error message
-export const checkOptions = ({ cachedConfig: { siteInfo = {} }, token }) => {
-  // @ts-expect-error TS(2339) FIXME: Property 'id' does not exist on type '{}'.
+import type BaseCommand from '../base-command.js'
+
+export const checkOptions = ({ cachedConfig: { siteInfo }, token }: BuildConfig) => {
   if (!siteInfo.id) {
     error(
       'Could not find the site ID. If your site is not on Netlify, please run `netlify init` or `netlify deploy` first. If it is, please run `netlify link`.',
@@ -36,7 +31,6 @@ export const build = async (options: OptionValues, command: BaseCommand) => {
     packagePath: command.workspacePackage,
     currentDir: command.workingDir,
     token,
-    // @ts-expect-error TS(2740)
     options,
   })
 
diff --git a/src/commands/env/env-list.ts b/src/commands/env/env-list.ts
@@ -1,14 +1,14 @@
 import ansiEscapes from 'ansi-escapes'
 import AsciiTable from 'ascii-table'
 import { isCI } from 'ci-info'
-import { OptionValues } from 'commander'
+import type { OptionValues } from 'commander'
 import inquirer from 'inquirer'
 import logUpdate from 'log-update'
 
 import { chalk, log, logJson } from '../../utils/command-helpers.js'
 import { AVAILABLE_CONTEXTS, getEnvelopeEnv, getHumanReadableScopes } from '../../utils/env/index.js'
-import BaseCommand from '../base-command.js'
-import { EnvironmentVariables } from '../types.js'
+import type BaseCommand from '../base-command.js'
+import { EnvironmentVariables } from '../../utils/types.js'
 
 const MASK_LENGTH = 50
 const MASK = '*'.repeat(MASK_LENGTH)
diff --git a/src/commands/integration/deploy.ts b/src/commands/integration/deploy.ts
@@ -391,7 +391,6 @@ export const deploy = async (options: OptionValues, command: BaseCommand) => {
     packagePath: command.workspacePackage,
     currentDir: command.workingDir,
     token,
-    // @ts-expect-error TS(2740)
     options,
   })
 
diff --git a/src/commands/types.d.ts b/src/commands/types.d.ts
@@ -3,9 +3,9 @@ import type { NetlifyTOML } from '@netlify/build-info'
 import type { NetlifyAPI } from 'netlify'
 
 import type { FrameworksAPIPaths } from "../utils/frameworks-api.ts";
-import StateConfig from '../utils/state-config.js'
-import { Account } from "../utils/types.ts";
-
+import type StateConfig from '../utils/state-config.js'
+import type { Account } from "../utils/types.ts";
+import type { CachedConfig } from "../utils/build.js"
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type $TSFixMe = any;
@@ -49,10 +49,6 @@ type HTMLInjection = {
   html: string
 }
 
-type EnvironmentVariableScope = 'builds' | 'functions' | 'runtime' | 'post_processing'
-type EnvironmentVariableSource = 'account' | 'addons' | 'configFile' | 'general' |  'internal' | 'ui'
-
-export type EnvironmentVariables = Record<string, { sources: EnvironmentVariableSource[], value: string; scopes?: EnvironmentVariableScope[] }>
 
 /**
  * The netlify object inside each command with the state
@@ -70,7 +66,7 @@ export type NetlifyOptions = {
   site: NetlifySite
   siteInfo: $TSFixMe
   config: PatchedConfig
-  cachedConfig: Record<string, $TSFixMe> & { env: EnvironmentVariables }
+  cachedConfig: CachedConfig
   globalConfig: $TSFixMe
   state: StateConfig
   frameworksAPIPaths: FrameworksAPIPaths
diff --git a/src/lib/build.ts b/src/lib/build.ts
@@ -1,54 +1,79 @@
 import fs from 'fs'
 import process from 'process'
 
-import build from '@netlify/build'
+import build, { type OnEnd, type OnPostBuild } from '@netlify/build'
 // @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'toml... Remove this comment to see the full error message
 import tomlify from 'tomlify-j0.4'
+import type { OptionValues } from 'commander'
 
 import { getFeatureFlagsFromSiteInfo } from '../utils/feature-flags.js'
+import type { EnvironmentVariables } from '../utils/types.js'
 
 import { getBootstrapURL } from './edge-functions/bootstrap.js'
 import { featureFlags as edgeFunctionsFeatureFlags } from './edge-functions/consts.js'
 
-/**
- * The buildConfig + a missing cachedConfig
- * @typedef BuildConfig
- * @type {Parameters<import('@netlify/build/src/core/main.js')>[0] & {cachedConfig: any}}
- */
+export interface CachedConfig {
+  env: EnvironmentVariables
+  siteInfo: {
+    id?: string
+    account_id?: string
+    feature_flags?: Record<string, boolean | boolean | number>
+  }
+  // TODO(serhalp) Add remaining properties
+  [k: string]: unknown
+}
+
+interface DefaultConfig {
+  // TODO(serhalp) Add remaining properties
+  [k: string]: unknown
+}
+
+// TODO(serhalp) This is patching weak or missing properties from @netlify/build. Fix there instead.
+export type BuildConfig = Parameters<typeof build>[0] & {
+  cachedConfig: CachedConfig
+  defaultConfig: DefaultConfig
+  // It's possible this one is correct in @netlify/build. Remove and stop passing it if so.
+  accountId?: string
+  edgeFunctionsBootstrapURL: string
+}
+
+interface HandlerResult {
+  newEnvChanges?: Record<string, string>
+  configMutations?: Record<string, string>
+  status?: string
+}
+// The @netlify/build type incorrectly states a `void | Promise<void>` return type.
+type PatchedHandlerType<T extends (opts: any) => void | Promise<void>> = (
+  opts: Parameters<T>[0],
+) => HandlerResult | Promise<HandlerResult>
+
+type EventHandler<T extends (opts: any) => void | Promise<void>> = {
+  handler: PatchedHandlerType<T>
+  description: string
+}
 
 // We have already resolved the configuration using `@netlify/config`
 // This is stored as `netlify.cachedConfig` and can be passed to
 // `@netlify/build --cachedConfig`.
-/**
- *
- * @param {object} config
- * @param {*} config.cachedConfig
- * @param {string} [config.packagePath]
- * @param {string} config.currentDir
- * @param {string} config.token
- * @param {import('commander').OptionValues} config.options
- * @param {*} config.deployHandler
- * @returns {BuildConfig}
- */
 export const getBuildOptions = async ({
-  // @ts-expect-error TS(7031) FIXME: Binding element 'cachedConfig' implicitly has an '... Remove this comment to see the full error message
   cachedConfig,
-  // @ts-expect-error TS(7031) FIXME: Binding element 'currentDir' implicitly has an 'an... Remove this comment to see the full error message
   currentDir,
-  // @ts-expect-error TS(7031) FIXME: Binding element 'defaultConfig' implicitly has an '... Remove this comment to see the full error message
   defaultConfig,
-  // @ts-expect-error TS(7031) FIXME: Binding element 'deployHandler' implicitly has an ... Remove this comment to see the full error message
   deployHandler,
-  // @ts-expect-error TS(7031) FIXME: Binding element 'context' implicitly has an 'any' ... Remove this comment to see the full error message
   options: { context, cwd, debug, dry, json, offline, silent },
-  // @ts-expect-error TS(7031) FIXME: Binding element 'packagePath' implicitly has an 'a... Remove this comment to see the full error message
   packagePath,
-  // @ts-expect-error TS(7031) FIXME: Binding element 'token' implicitly has an 'any' ty... Remove this comment to see the full error message
   token,
-}) => {
-  const eventHandlers = {
+}: {
+  cachedConfig: CachedConfig
+  currentDir: string
+  defaultConfig?: DefaultConfig
+  deployHandler?: PatchedHandlerType<OnPostBuild>
+  options: OptionValues
+  packagePath?: string
+  token?: null | string
+}): Promise<BuildConfig> => {
+  const eventHandlers: { onEnd: EventHandler<OnEnd>; onPostBuild?: EventHandler<OnPostBuild> } = {
     onEnd: {
-      // @ts-expect-error TS(7031) FIXME: Binding element 'netlifyConfig' implicitly has an ... Remove this comment to see the full error message
       handler: ({ netlifyConfig }) => {
         const string = tomlify.toToml(netlifyConfig)
 
@@ -64,7 +89,6 @@ export const getBuildOptions = async ({
   }
 
   if (deployHandler) {
-    // @ts-expect-error TS(2339) FIXME: Property 'onPostBuild' does not exist on type '{ o... Remove this comment to see the full error message
     eventHandlers.onPostBuild = {
       handler: deployHandler,
       description: 'Deploy Site',
@@ -73,11 +97,11 @@ export const getBuildOptions = async ({
 
   return {
     cachedConfig,
-    defaultConfig,
+    defaultConfig: defaultConfig ?? {},
     siteId: cachedConfig.siteInfo.id,
     accountId: cachedConfig.siteInfo.account_id,
     packagePath,
-    token,
+    token: token ?? undefined,
     dry,
     debug,
     context,
@@ -92,18 +116,13 @@ export const getBuildOptions = async ({
       ...getFeatureFlagsFromSiteInfo(cachedConfig.siteInfo),
       functionsBundlingManifest: true,
     },
+    // @ts-expect-error(serhalp) -- TODO(serhalp) Upstream the type fixes above into @netlify/build
     eventHandlers,
     edgeFunctionsBootstrapURL: await getBootstrapURL(),
   }
 }
 
-/**
- * run the build command
- * @param {BuildConfig} options
- * @returns
- */
-// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
-export const runBuild = async (options) => {
+export const runBuild = async (options: BuildConfig) => {
   // If netlify NETLIFY_API_URL is set we need to pass this information to @netlify/build
   // TODO don't use testOpts, but add real properties to do this.
   if (process.env.NETLIFY_API_URL) {
@@ -112,6 +131,8 @@ export const runBuild = async (options) => {
       scheme: apiUrl.protocol.slice(0, -1),
       host: apiUrl.host,
     }
+    // @ts-expect-error(serhalp) -- I don't know what's going on here and I can't convince myself it even works as
+    // intended. TODO(serhalp) Investigate and fix types.
     options = { ...options, testOpts }
   }
 
diff --git a/src/utils/command-helpers.ts b/src/utils/command-helpers.ts
@@ -133,9 +133,9 @@ export const pollForToken = async ({
  * @returns {Promise<[null|string, 'flag' | 'env' |'config' |'not found']>}
  */
 
-export type tokenTuple = [string | null, TokenLocation]
+export type TokenTuple = [string | null, TokenLocation]
 
-export const getToken = async (tokenFromOptions?: string): Promise<tokenTuple> => {
+export const getToken = async (tokenFromOptions?: string): Promise<TokenTuple> => {
   // 1. First honor command flag --auth
   if (tokenFromOptions) {
     return [tokenFromOptions, 'flag']
diff --git a/src/utils/types.ts b/src/utils/types.ts
@@ -195,3 +195,11 @@ export interface Template {
   sourceCodeUrl: string
   slug: string
 }
+
+type EnvironmentVariableScope = 'builds' | 'functions' | 'runtime' | 'post_processing'
+type EnvironmentVariableSource = 'account' | 'addons' | 'configFile' | 'general' | 'internal' | 'ui'
+
+export type EnvironmentVariables = Record<
+  string,
+  { sources: EnvironmentVariableSource[]; value: string; scopes?: EnvironmentVariableScope[] }
+>
