Merge pull request #130 from SocketDev/cg/addDependenciesCommand

Add dependencies search command

Author: charliegerard

lib/commands/dependencies/index.js

@@ -0,0 +1,150 @@
+/* eslint-disable no-console */
+
+import chalk from 'chalk'
+// @ts-ignore
+import chalkTable from 'chalk-table'
+import meow from 'meow'
+import ora from 'ora'
+
+import { outputFlags } from '../../flags/index.js'
+import { handleApiCall, handleUnsuccessfulApiResponse } from '../../utils/api-helpers.js'
+import { prepareFlags } from '../../utils/flags.js'
+import { printFlagList } from '../../utils/formatting.js'
+import { getDefaultKey, setupSdk } from '../../utils/sdk.js'
+
+/** @type {import('../../utils/meow-with-subcommands.js').CliSubcommand} */
+export const dependencies = {
+  description: 'Search for any dependency that is being used in your organization',
+  async run (argv, importMeta, { parentName }) {
+    const name = parentName + ' dependencies'
+
+    const input = setupCommand(name, dependencies.description, argv, importMeta)
+    if (input) {
+      const spinnerText = 'Searching dependencies...'
+      const spinner = ora(spinnerText).start()
+      await searchDeps(input, spinner)
+    }
+  }
+}
+
+const dependenciesFlags = prepareFlags({
+    limit: {
+      type: 'number',
+      shortFlag: 'l',
+      default: 50,
+      description: 'Maximum number of dependencies returned',
+    },
+    offset: {
+      type: 'number',
+      shortFlag: 'o',
+      default: 0,
+      description: 'Page number',
+    }
+  })
+
+// Internal functions
+
+/**
+ * @typedef Command
+ * @property {boolean} outputJson
+ * @property {boolean} outputMarkdown
+ * @property {number} limit
+ * @property {number} offset
+ */
+
+/**
+ * @param {string} name
+ * @param {string} description
+ * @param {readonly string[]} argv
+ * @param {ImportMeta} importMeta
+ * @returns {void|Command}
+ */
+function setupCommand (name, description, argv, importMeta) {
+  const flags = {
+    ...outputFlags,
+    ...dependenciesFlags
+  }
+
+  const cli = meow(`
+    Usage
+      $ ${name}
+
+    Options
+      ${printFlagList(flags, 6)}
+
+    Examples
+      $ ${name}
+  `, {
+    argv,
+    description,
+    importMeta,
+    flags
+  })
+
+  const {
+    json: outputJson,
+    markdown: outputMarkdown,
+    limit,
+    offset
+  } = cli.flags
+
+  return {
+    outputJson,
+    outputMarkdown,
+    limit,
+    offset
+  }
+}
+
+/**
+ * @typedef DependenciesData
+ * @property {import('@socketsecurity/sdk').SocketSdkReturnType<'searchDependencies'>["data"]} data
+ */
+
+/**
+ * @param {Command} input
+ * @param {import('ora').Ora} spinner
+ * @returns {Promise<void|DependenciesData>}
+ */
+async function searchDeps ({ limit, offset, outputJson }, spinner) {
+  const socketSdk = await setupSdk(getDefaultKey())
+  const result = await handleApiCall(socketSdk.searchDependencies({ limit, offset }), 'Searching dependencies')
+
+  if (!result.success) {
+    return handleUnsuccessfulApiResponse('searchDependencies', result, spinner)
+  }
+
+  spinner.stop()
+
+  console.log('Organization dependencies: \n')
+
+  if (outputJson) {
+    return console.log(result.data)
+  }
+
+  const options = {
+    columns: [
+      { field: 'namespace', name: chalk.cyan('Namespace') },
+      { field: 'name', name: chalk.cyan('Name') },
+      { field: 'version', name: chalk.cyan('Version') },
+      { field: 'repository', name: chalk.cyan('Repository') },
+      { field: 'branch', name: chalk.cyan('Branch') },
+      { field: 'type', name: chalk.cyan('Type') },
+      { field: 'direct', name: chalk.cyan('Direct') }
+    ]
+  }
+
+  const formattedResults = result.data.rows.map((/** @type {{[key:string]: any}} */ d) => {
+    return {
+      ...d
+    }
+  })
+
+  const table = chalkTable(options, formattedResults)
+
+  console.log(table, '\n')
+
+  return {
+    data: result.data
+  }
+}

lib/commands/index.js

@@ -11,3 +11,4 @@ export * from './wrapper/index.js'
 export * from './scan/index.js'
 export * from './audit-log/index.js'
 export * from './repos/index.js'
+export * from './dependencies/index.js'