Merge pull request #114 from SocketDev/cg/listOrganizations

Add command to list organizations

Author: charliegerard

lib/commands/index.js

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

lib/commands/organizations/index.js

@@ -0,0 +1,81 @@
+/* eslint-disable no-console */
+
+import chalk from 'chalk'
+import meow from 'meow'
+import ora from 'ora'
+
+import { handleApiCall, handleUnsuccessfulApiResponse } from '../../utils/api-helpers.js'
+import { getDefaultKey, setupSdk } from '../../utils/sdk.js'
+
+/** @type {import('../../utils/meow-with-subcommands.js').CliSubcommand} */
+export const organizations = {
+  description: 'List organizations associated with the API key used',
+  async run (argv, importMeta, { parentName }) {
+    const name = parentName + ' organizations'
+
+    setupCommand(name, organizations.description, argv, importMeta)
+    await fetchOrganizations()
+  }
+}
+
+// Internal functions
+
+/**
+ * @param {string} name
+ * @param {string} description
+ * @param {readonly string[]} argv
+ * @param {ImportMeta} importMeta
+ * @returns {void}
+ */
+function setupCommand (name, description, argv, importMeta) {
+  meow(`
+    Usage
+      $ ${name}
+  `, {
+    argv,
+    description,
+    importMeta
+  })
+}
+
+/**
+ * @typedef OrganizationsData
+ * @property {import('@socketsecurity/sdk').SocketSdkReturnType<'getOrganizations'>["data"]} data
+ */
+
+/**
+ * @returns {Promise<void|OrganizationsData>}
+ */
+async function fetchOrganizations () {
+  const apiKey = getDefaultKey()
+  const socketSdk = await setupSdk(apiKey)
+  const spinner = ora('Fetching organizations...').start()
+
+  const result = await handleApiCall(socketSdk.getOrganizations(), 'looking up organizations')
+
+  if (result.success === false) {
+    return handleUnsuccessfulApiResponse('getOrganizations', result, spinner)
+  }
+
+  spinner.stop()
+
+  const organizations = Object.values(result.data.organizations)
+  if (apiKey) {
+    console.log(`List of organizations associated with your API key: ${chalk.italic(apiKey)}`)
+  } else {
+    console.log('List of organizations associated with your API key.')
+  }
+
+  organizations.map(o => {
+    console.log(`
+Name: ${o?.name}
+ID: ${o?.id}
+Plan: ${o?.plan}
+    `)
+    return o
+  })
+
+  return {
+    data: result.data
+  }
+}