refactor

Author: charliegerard

lib/commands/audit-log/index.js

@@ -1,18 +1,18 @@
+// @ts-nocheck
 /* eslint-disable no-console */
+import { Separator } from '@inquirer/select'
 import chalk from 'chalk'
-// @ts-ignore
-import Table from 'cli-table3'
+import inquirer from 'inquirer'
 import meow from 'meow'
 import ora from 'ora'
 
 import { outputFlags } from '../../flags/index.js'
 import { handleApiCall, handleUnsuccessfulApiResponse } from '../../utils/api-helpers.js'
-import { InputError } from '../../utils/errors.js'
 import { prepareFlags } from '../../utils/flags.js'
 import { printFlagList } from '../../utils/formatting.js'
 import { FREE_API_KEY, getDefaultKey, setupSdk } from '../../utils/sdk.js'
 
-/** @type {import('../../utils/meow-with-subcommands').CliSubcommand} */
+/** @type {import('../../utils/meow-with-subcommands.js').CliSubcommand} */
 export const auditlog = {
   description: 'Look up the audit log for an organization',
   async run (argv, importMeta, { parentName }) {
@@ -50,13 +50,13 @@ const auditLogFlags = prepareFlags({
 // Internal functions
 
 /**
- * @typedef CommandContext
+ * @typedef CommandInput
  * @property {boolean} outputJson
  * @property {boolean} outputMarkdown
  * @property {string} orgSlug
  * @property {string} type
  * @property {number} page
- * @property {number} perPage
+ * @property {number} per_page
  */
 
 /**
@@ -94,27 +94,22 @@ function setupCommand (name, description, argv, importMeta) {
     type,
     page,
     perPage
-
   } = cli.flags
 
   if (cli.input.length < 1) {
-    throw new InputError('Please provide an organization slug')
-  }
-
-  const [orgSlug = ''] = cli.input
-
-  if (!orgSlug) {
+    console.error(`${chalk.bgRed('Input error')}: Please provide an organization slug \n`)
     cli.showHelp()
     return
   }
+  const [orgSlug = ''] = cli.input
 
   return {
     outputJson,
     outputMarkdown,
     orgSlug,
     type,
     page,
-    perPage
+    per_page: perPage
   }
 }
 
@@ -125,13 +120,12 @@ function setupCommand (name, description, argv, importMeta) {
 
 /**
  * @param {string} orgSlug
- * @param {CommandContext} input
+ * @param {CommandInput} input
  * @param {import('ora').Ora} spinner
  * @returns {Promise<void|AuditLogData>}
  */
 async function fetchOrgAuditLog (orgSlug, input, spinner) {
   const socketSdk = await setupSdk(getDefaultKey() || FREE_API_KEY)
-  console.log(input)
   // @ts-ignore
   const result = await handleApiCall(socketSdk.getAuditLogEvents(orgSlug, input), 'looking up package')
 
@@ -141,29 +135,29 @@ async function fetchOrgAuditLog (orgSlug, input, spinner) {
   }
   spinner.stop()
 
-  console.log(`\n Audit log for: ${orgSlug} \n`)
+  const /** @type {({name: string} | Separator)[]} */ data = []
+  const /** @type {{[key: string]: string}} */ logDetails = {}
 
-  const table = new Table({
-    chars: { 'top': '═', 'top-mid': '╤', 'top-left': '╔', 'top-right': '╗', 'bottom': '═', 'bottom-mid': '╧', 'bottom-left': '╚', 'bottom-right': '╝', 'left': '║', 'left-mid': '╟', 'mid': '─', 'mid-mid': '┼', 'right': '║', 'right-mid': '╢', 'middle': '│' },
-    colWidths: [11, 20],
-    style: { head: [], border: [] },
-    wordWrap: true
-  })
+  result.data.results.map(d => {
+    data.push({
+      name: `${d.created_at && new Date(d.created_at).toLocaleDateString('en-us', { year: 'numeric', month: 'numeric', day: 'numeric' })} - ${d.user_email} - ${d.type} - ${d.ip_address} - ${d.user_agent}`
+    }, new Separator())
 
-  table.push([chalk.magenta('Date'), chalk.magenta('User'), chalk.magenta('Type'), chalk.magenta('IP address'), chalk.magenta('User agent')])
-
-  result.data.results.map((/** @type {{ created_at: string | number | Date; user_email: any; type: any; ip_address: any; user_agent: string; }} */ d) => {
-    const data = [
-      d.created_at ? new Date(d.created_at).toLocaleDateString('en-us', { year: 'numeric', month: 'numeric', day: 'numeric' }) : '',
-      d.user_email,
-      d.type,
-      d.ip_address,
-      d.user_agent.split(';').join('\n')
-    ]
-    return table.push(data)
+    logDetails[`${d.created_at && new Date(d.created_at).toLocaleDateString('en-us', { year: 'numeric', month: 'numeric', day: 'numeric' })} - ${d.user_email} - ${d.type} - ${d.ip_address} - ${d.user_agent}`] = JSON.stringify(d.payload)
+    return data
   })
 
-  console.log(table.toString())
+  inquirer
+  .prompt(
+    {
+      type: 'list',
+      name: 'log',
+      message: `\n Audit log for: ${orgSlug} \n`,
+      choices: data,
+      pageSize: 30
+    }
+  )
+  .then((/** @type {{log: string}} */ answers) => console.log(logDetails[answers.log]))
 
   return {
     data: result.data

package.json

@@ -48,6 +48,7 @@
     "@tsconfig/node20": "^20.1.4",
     "@types/chai": "^4.3.16",
     "@types/chai-as-promised": "^7.1.8",
+    "@types/inquirer": "^9.0.7",
     "@types/micromatch": "^4.0.7",
     "@types/mocha": "^10.0.6",
     "@types/mock-fs": "^4.13.4",
@@ -84,6 +85,7 @@
   "dependencies": {
     "@apideck/better-ajv-errors": "^0.3.6",
     "@cyclonedx/cdxgen": "^10.5.2",
+    "@inquirer/select": "^2.3.5",
     "@socketsecurity/config": "^2.1.3",
     "@socketsecurity/sdk": "^1.0.1",
     "chalk": "^5.3.0",
@@ -93,6 +95,7 @@
     "hpagent": "^1.2.0",
     "ignore": "^5.3.1",
     "ignore-by-default": "^2.1.0",
+    "inquirer": "^9.2.23",
     "is-interactive": "^2.0.0",
     "is-unicode-supported": "^2.0.0",
     "meow": "^13.2.0",