Update types for optional things to be more consistent

Author: jdalton

src/commands/fix/git.mts

@@ -50,7 +50,7 @@ export function getSocketFixCommitMessage(
 
 export function getSocketFixPullRequestBody(
   ghsaIds: string[],
-  ghsaDetails?: Map<string, GhsaDetails>,
+  ghsaDetails?: Map<string, GhsaDetails> | undefined,
 ): string {
   const vulnCount = ghsaIds.length
   if (vulnCount === 1) {

src/commands/fix/pull-request.mts

@@ -198,7 +198,7 @@ export async function cleanupSocketFixPrs(
 
 export type PrAutoMergeState = {
   enabled: boolean
-  details?: string[]
+  details?: string[] | undefined
 }
 
 export type SocketPrsOptions = {

src/commands/login/cmd-login.mts

@@ -89,8 +89,8 @@ async function run(
   }
 
   const { apiBaseUrl, apiProxy } = cli.flags as {
-    apiBaseUrl?: string
-    apiProxy?: string
+    apiBaseUrl?: string | undefined
+    apiProxy?: string | undefined
   }
 
   await attemptLogin(apiBaseUrl, apiProxy)

src/constants.mts

@@ -167,7 +167,7 @@ export type IpcObject = Readonly<{
 }>
 
 export type ProcessEnv = {
-  [K in keyof ENV]?: string
+  [K in keyof ENV]?: string | undefined
 }
 
 const ALERT_TYPE_CRITICAL_CVE = 'criticalCVE'

src/flags.mts

@@ -18,7 +18,7 @@ export type NumberFlag = Flag<'number', number> | Flag<'number', number[], true>
 
 export type StringFlag = Flag<'string', string> | Flag<'string', string[], true>
 
-export type MeowFlag = AnyFlag & { description: string; hidden?: boolean }
+export type MeowFlag = AnyFlag & { description: string; hidden?: boolean | undefined }
 
 // We use this description in getFlagListOutput, meow doesn't care.
 export type MeowFlags = Record<string, MeowFlag>

src/shadow/npm/arborist/types.mts

@@ -14,8 +14,8 @@ import type {
 } from '@npmcli/arborist'
 
 export type ArboristOptions = BaseArboristOptions & {
-  npmCommand?: string
-  npmVersion?: string
+  npmCommand?: string | undefined
+  npmVersion?: string | undefined
 }
 
 export type ArboristClass = ArboristInstance & {
@@ -37,10 +37,10 @@ export type ArboristInstance = Omit<
   actualTree?: NodeClass | null | undefined
   diff: Diff | null
   idealTree?: NodeClass | null | undefined
-  buildIdealTree(options?: BuildIdealTreeOptions): Promise<NodeClass>
-  loadActual(options?: ArboristOptions): Promise<NodeClass>
-  loadVirtual(options?: ArboristOptions): Promise<NodeClass>
-  reify(options?: ArboristReifyOptions): Promise<NodeClass>
+  buildIdealTree(options?: BuildIdealTreeOptions | undefined): Promise<NodeClass>
+  loadActual(options?: ArboristOptions | undefined): Promise<NodeClass>
+  loadVirtual(options?: ArboristOptions | undefined): Promise<NodeClass>
+  reify(options?: ArboristReifyOptions | undefined): Promise<NodeClass>
 }
 
 export type ArboristReifyOptions = ReifyOptions & ArboristOptions
@@ -111,7 +111,7 @@ export type EdgeClass = Omit<
   get to(): NodeClass | null
   new (...args: any): EdgeClass
   detach(): void
-  reload(hard?: boolean): void
+  reload(hard?: boolean | undefined): void
   satisfiedBy(node: NodeClass): boolean
 }
 
@@ -178,9 +178,9 @@ export type NodeClass = Omit<
   new (...args: any): NodeClass
   addEdgeIn(edge: EdgeClass): void
   addEdgeOut(edge: EdgeClass): void
-  canDedupe(preferDedupe?: boolean): boolean
-  canReplace(node: NodeClass, ignorePeers?: string[]): boolean
-  canReplaceWith(node: NodeClass, ignorePeers?: string[]): boolean
+  canDedupe(preferDedupe?: boolean | undefined): boolean
+  canReplace(node: NodeClass, ignorePeers?: string[] | undefined): boolean
+  canReplaceWith(node: NodeClass, ignorePeers?: string[] | undefined): boolean
   deleteEdgeIn(edge: EdgeClass): void
   matches(node: NodeClass): boolean
   recalculateOutEdgesOverrides(): void

src/types.mts

@@ -11,20 +11,20 @@ export type CResult<T> =
       ok: true
       data: T
       // The message prop may contain warnings that we want to convey.
-      message?: string
+      message?: string | undefined
     }
   | {
       ok: false
       // This should be set to process.exitCode if this
       // payload is actually displayed to the user.
       // Defaults to 1 if not set.
-      code?: number
+      code?: number | undefined
       // Short message, for non-json this would show in
       // the red banner part of an error message.
       message: string
       // Full explanation. Shown after the red banner of
       // a non-json error message. Optional.
-      cause?: string
+      cause?: string | undefined
       // If set, this may conform to the actual payload.
-      data?: unknown
+      data?: unknown | undefined
     }

src/utils/alert/artifact.mts

@@ -41,7 +41,7 @@ export type ArtifactAlertUpgrade = Remap<
 >
 
 export type CveProps = {
-  firstPatchedVersionIdentifier?: string
+  firstPatchedVersionIdentifier?: string | undefined
   vulnerableVersionRange: string
   [key: string]: any
 }

src/utils/api.mts

@@ -21,15 +21,15 @@ import type {
 const NO_ERROR_MESSAGE = 'No error message returned'
 
 export type CommandRequirements = {
-  permissions?: string[]
-  quota?: number
+  permissions?: string[] | undefined
+  quota?: number | undefined
 }
 
 /**
  * Get command requirements from requirements.json based on command path.
  */
 function getCommandRequirements(
-  cmdPath?: string,
+  cmdPath?: string | undefined,
 ): CommandRequirements | undefined {
   if (!cmdPath) {
     return undefined
@@ -43,7 +43,7 @@ function getCommandRequirements(
 /**
  * Log required permissions for a command when encountering 403 errors.
  */
-function logPermissionsFor403(cmdPath?: string): void {
+function logPermissionsFor403(cmdPath?: string | undefined): void {
   const requirements = getCommandRequirements(cmdPath)
   if (!requirements?.permissions?.length) {
     return

src/utils/config.mts

@@ -20,10 +20,11 @@ export interface LocalConfig {
   apiKey?: string | null | undefined
   apiProxy?: string | null | undefined
   apiToken?: string | null | undefined
-  defaultOrg?: string
+  defaultOrg?: string | undefined
   enforcedOrgs?: string[] | readonly string[] | null | undefined
-  skipAskToPersistDefaultOrg?: boolean
-  org?: string // convenience alias for defaultOrg
+  skipAskToPersistDefaultOrg?: boolean | undefined
+  // Convenience alias for defaultOrg.
+  org?: string | undefined
 }
 
 const sensitiveConfigKeyLookup: Set<keyof LocalConfig> = new Set(['apiToken'])