Refactor remaining commands

Author: pvdz

src/cli.ts

@@ -7,28 +7,28 @@ import { messageWithCauses, stackWithCauses } from 'pony-cause'
 import updateNotifier from 'tiny-updater'
 import colors from 'yoctocolors-cjs'
 
-import { cmdAction } from './commands/action/cmd-action.ts'
-import { cmdAnalytics } from './commands/analytics/cmd-analytics.ts'
-import { cmdAuditLog } from './commands/audit-log/cmd-audit-log.ts'
-import { cmdCdxgen } from './commands/cdxgen/cmd-cdxgen.ts'
-import { cmdScanCreate } from './commands/dependencies/cmd-dependencies.ts'
-import { cmdDiffScan } from './commands/diff-scan/cmd-diff-scan.ts'
-import { cmdFix } from './commands/fix/cmd-fix.ts'
-import { cmdInfo } from './commands/info/cmd-info.ts'
-import { loginCommand } from './commands/login'
-import { logoutCommand } from './commands/logout'
-import { cmdManifest } from './commands/manifest/cmd-manifest.ts'
-import { npmCommand } from './commands/npm'
-import { npxCommand } from './commands/npx'
-import { optimizeCommand } from './commands/optimize'
-import { organizationCommand } from './commands/organization'
-import { rawNpmCommand } from './commands/raw-npm'
-import { rawNpxCommand } from './commands/raw-npx'
-import { cmdReport } from './commands/report/cmd-report.ts'
-import { cmdRepos } from './commands/repos/cmd-repos.ts'
-import { cmdScan } from './commands/scan/cmd-scan.ts'
-import { threatFeedCommand } from './commands/threat-feed'
-import { wrapperCommand } from './commands/wrapper'
+import { cmdAction } from './commands/action/cmd-action'
+import { cmdAnalytics } from './commands/analytics/cmd-analytics'
+import { cmdAuditLog } from './commands/audit-log/cmd-audit-log'
+import { cmdCdxgen } from './commands/cdxgen/cmd-cdxgen'
+import { cmdScanCreate } from './commands/dependencies/cmd-dependencies'
+import { cmdDiffScan } from './commands/diff-scan/cmd-diff-scan'
+import { cmdFix } from './commands/fix/cmd-fix'
+import { cmdInfo } from './commands/info/cmd-info'
+import { cmdLogin } from './commands/login/cmd-login'
+import { cmdLogout } from './commands/logout/cmd-logout'
+import { cmdManifest } from './commands/manifest/cmd-manifest'
+import { cmdNpm } from './commands/npm/cmd-npm'
+import { cmdNpx } from './commands/npx/cmd-npx'
+import { cmdOptimize } from './commands/optimize/cmd-optimize'
+import { cmdOrganization } from './commands/organization/cmd-organization'
+import { cmdRawNpm } from './commands/raw-npm/cmd-raw-npm'
+import { cmdRawNpx } from './commands/raw-npx/cmd-raw-npx'
+import { cmdReport } from './commands/report/cmd-report'
+import { cmdRepos } from './commands/repos/cmd-repos'
+import { cmdScan } from './commands/scan/cmd-scan'
+import { cmdThreatFeed } from './commands/threat-feed/cmd-threat-feed'
+import { cmdWrapper } from './commands/wrapper/cmd-wrapper'
 import constants from './constants'
 import { AuthError, InputError } from './utils/errors'
 import { logSymbols } from './utils/logging'
@@ -51,23 +51,23 @@ void (async () => {
         cdxgen: cmdCdxgen,
         fix: cmdFix,
         info: cmdInfo,
-        login: loginCommand,
-        logout: logoutCommand,
-        npm: npmCommand,
-        npx: npxCommand,
-        optimize: optimizeCommand,
-        organization: organizationCommand,
-        'raw-npm': rawNpmCommand,
-        'raw-npx': rawNpxCommand,
+        login: cmdLogin,
+        logout: cmdLogout,
+        npm: cmdNpm,
+        npx: cmdNpx,
+        optimize: cmdOptimize,
+        organization: cmdOrganization,
+        'raw-npm': cmdRawNpm,
+        'raw-npx': cmdRawNpx,
         report: cmdReport,
-        wrapper: wrapperCommand,
+        wrapper: cmdWrapper,
         scan: cmdScan,
         'audit-log': cmdAuditLog,
         repos: cmdRepos,
         dependencies: cmdScanCreate,
         analytics: cmdAnalytics,
         'diff-scan': cmdDiffScan,
-        'threat-feed': threatFeedCommand,
+        'threat-feed': cmdThreatFeed,
         manifest: cmdManifest
       },
       {

src/commands/login.ts

@@ -0,0 +1,13 @@
+import { updateSetting } from '../../utils/settings.ts'
+
+export function applyLogin(
+  apiToken: string,
+  enforcedOrgs: Array<string>,
+  apiBaseUrl: string | undefined,
+  apiProxy: string | undefined
+) {
+  updateSetting('enforcedOrgs', enforcedOrgs)
+  updateSetting('apiToken', apiToken)
+  updateSetting('apiBaseUrl', apiBaseUrl)
+  updateSetting('apiProxy', apiProxy)
+}

src/commands/login/apply-login.ts

@@ -0,0 +1,104 @@
+import terminalLink from 'terminal-link'
+
+import {
+  type Separator,
+  confirm,
+  password,
+  select
+} from '@socketsecurity/registry/lib/prompts'
+import { Spinner } from '@socketsecurity/registry/lib/spinner'
+
+import { applyLogin } from './apply-login.ts'
+import constants from '../../constants.ts'
+import { AuthError } from '../../utils/errors.ts'
+import { setupSdk } from '../../utils/sdk.ts'
+import { getSetting } from '../../utils/settings.ts'
+
+import type { SocketSdkReturnType } from '@socketsecurity/sdk'
+
+// TODO: this type should come from a general Socket REST API type doc
+type Choice<Value> = {
+  value: Value
+  name?: string
+  description?: string
+  disabled?: boolean | string
+  type?: never
+}
+type OrgChoice = Choice<string>
+type OrgChoices = Array<Separator | OrgChoice>
+const { SOCKET_PUBLIC_API_TOKEN } = constants
+
+export async function attemptLogin(
+  apiBaseUrl: string | undefined,
+  apiProxy: string | undefined
+) {
+  const apiToken =
+    (await password({
+      message: `Enter your ${terminalLink(
+        'Socket.dev API key',
+        'https://docs.socket.dev/docs/api-keys'
+      )} (leave blank for a public key)`
+    })) || SOCKET_PUBLIC_API_TOKEN
+
+  apiBaseUrl ??= getSetting('apiBaseUrl') ?? undefined
+  apiProxy ??= getSetting('apiProxy') ?? undefined
+
+  const spinner = new Spinner({ text: 'Verifying API key...' }).start()
+
+  let orgs: SocketSdkReturnType<'getOrganizations'>['data']
+  try {
+    const sdk = await setupSdk(apiToken, apiBaseUrl, apiProxy)
+    const result = await sdk.getOrganizations()
+    if (!result.success) {
+      throw new AuthError()
+    }
+    orgs = result.data
+    spinner.success('API key verified')
+  } catch {
+    spinner.error('Invalid API key')
+    return
+  }
+
+  const enforcedChoices: OrgChoices = Object.values(orgs.organizations)
+    .filter(org => org?.plan === 'enterprise')
+    .map(org => ({
+      name: org.name,
+      value: org.id
+    }))
+
+  let enforcedOrgs: Array<string> = []
+
+  if (enforcedChoices.length > 1) {
+    const id = <string | null>await select({
+      message:
+        "Which organization's policies should Socket enforce system-wide?",
+      choices: enforcedChoices.concat({
+        name: 'None',
+        value: '',
+        description: 'Pick "None" if this is a personal device'
+      })
+    })
+    if (id) {
+      enforcedOrgs = [id]
+    }
+  } else if (enforcedChoices.length) {
+    const confirmOrg = await confirm({
+      message: `Should Socket enforce ${(enforcedChoices[0] as OrgChoice)?.name}'s security policies system-wide?`,
+      default: true
+    })
+    if (confirmOrg) {
+      const existing = <OrgChoice>enforcedChoices[0]
+      if (existing) {
+        enforcedOrgs = [existing.value]
+      }
+    }
+  }
+
+  const oldToken = getSetting('apiToken')
+  try {
+    applyLogin(apiToken, enforcedOrgs, apiBaseUrl, apiProxy)
+    spinner.success(`API credentials ${oldToken ? 'updated' : 'set'}`)
+  } catch {
+    spinner.error(`API login failed`)
+  }
+}