@socketsecurity/cli 0.11.0 → 0.12.0

package/lib/commands/report/index.js

@@ -1,24 +0,0 @@
-import { create } from './create.js'
-import { view } from './view.js'
-import { meowWithSubcommands } from '../../utils/meow-with-subcommands.js'
-
-const description = 'Project report related commands'
-
-/** @type {import('../../utils/meow-with-subcommands.js').CliSubcommand} */
-export const report = {
-  description,
-  run: async (argv, importMeta, { parentName }) => {
-    await meowWithSubcommands(
-      {
-        create,
-        view,
-      },
-      {
-        argv,
-        description,
-        importMeta,
-        name: parentName + ' report',
-      }
-    )
-  }
-}

package/lib/commands/report/view.js

@@ -1,176 +0,0 @@
-/* eslint-disable no-console */
-
-import chalk from 'chalk'
-import meow from 'meow'
-import ora from 'ora'
-import { ErrorWithCause } from 'pony-cause'
-
-import { outputFlags, validationFlags } from '../../flags/index.js'
-import { handleApiCall, handleUnsuccessfulApiResponse } from '../../utils/api-helpers.js'
-import { ChalkOrMarkdown } from '../../utils/chalk-markdown.js'
-import { InputError } from '../../utils/errors.js'
-import { getSeverityCount, formatSeverityCount } from '../../utils/format-issues.js'
-import { printFlagList } from '../../utils/formatting.js'
-import { setupSdk } from '../../utils/sdk.js'
-
-/** @type {import('../../utils/meow-with-subcommands.js').CliSubcommand} */
-export const view = {
-  description: 'View a project report',
-  async run (argv, importMeta, { parentName }) {
-    const name = parentName + ' view'
-
-    const input = setupCommand(name, view.description, argv, importMeta)
-    const result = input && await fetchReportData(input.reportId, input)
-
-    if (result) {
-      formatReportDataOutput(result, { name, ...input })
-    }
-  }
-}
-
-// Internal functions
-
-/**
- * @typedef CommandContext
- * @property {boolean} includeAllIssues
- * @property {boolean} outputJson
- * @property {boolean} outputMarkdown
- * @property {string} reportId
- * @property {boolean} strict
- */
-
-/**
- * @param {string} name
- * @param {string} description
- * @param {readonly string[]} argv
- * @param {ImportMeta} importMeta
- * @returns {void|CommandContext}
- */
-function setupCommand (name, description, argv, importMeta) {
-  const flags = {
-    ...outputFlags,
-    ...validationFlags,
-  }
-
-  const cli = meow(`
-    Usage
-      $ ${name} <report-identifier>
-
-    Options
-      ${printFlagList(flags, 6)}
-
-    Examples
-      $ ${name} QXU8PmK7LfH608RAwfIKdbcHgwEd_ZeWJ9QEGv05FJUQ
-  `, {
-    argv,
-    description,
-    importMeta,
-    flags,
-  })
-
-  // Extract the input
-
-  const {
-    all: includeAllIssues,
-    json: outputJson,
-    markdown: outputMarkdown,
-    strict,
-  } = cli.flags
-
-  const [reportId, ...extraInput] = cli.input
-
-  if (!reportId) {
-    cli.showHelp()
-    return
-  }
-
-  // Validate the input
-
-  if (extraInput.length) {
-    throw new InputError(`Can only handle a single report ID at a time, but got ${cli.input.length} report ID:s: ${cli.input.join(', ')}`)
-  }
-
-  return {
-    includeAllIssues,
-    outputJson,
-    outputMarkdown,
-    reportId,
-    strict,
-  }
-}
-
-/**
- * @typedef {import('@socketsecurity/sdk').SocketSdkReturnType<'getReport'>["data"]} ReportData
- */
-
-const MAX_TIMEOUT_RETRY = 5
-
-/**
- * @param {string} reportId
- * @param {Pick<CommandContext, 'includeAllIssues' | 'strict'>} context
- * @returns {Promise<void|ReportData>}
- */
-export async function fetchReportData (reportId, { includeAllIssues, strict }) {
-  // Do the API call
-
-  const socketSdk = await setupSdk()
-  const spinner = ora(`Fetching report with ID ${reportId} (this could take a while)`).start()
-  /** @type {import('@socketsecurity/sdk').SocketSdkResultType<'getReport'> | undefined} */
-  let result
-  for (let retry = 1; !result; ++retry) {
-    try {
-      result = await handleApiCall(socketSdk.getReport(reportId), 'fetching report')
-    } catch (err) {
-      if (
-        retry >= MAX_TIMEOUT_RETRY ||
-        !(err instanceof ErrorWithCause) ||
-        err.cause?.cause?.response?.statusCode !== 524
-      ) {
-        throw err
-      }
-    }
-  }
-
-  if (result.success === false) {
-    return handleUnsuccessfulApiResponse('getReport', result, spinner)
-  }
-
-  // Conclude the status of the API call
-
-  if (strict) {
-    if (result.data.healthy) {
-      spinner.succeed('Report result is healthy and great!')
-    } else {
-      spinner.fail('Report result deemed unhealthy for project')
-    }
-  } else if (result.data.healthy === false) {
-    const severityCount = getSeverityCount(result.data.issues, includeAllIssues ? undefined : 'high')
-    const issueSummary = formatSeverityCount(severityCount)
-    spinner.succeed(`Report has these issues: ${issueSummary}`)
-  } else {
-    spinner.succeed('Report has no issues')
-  }
-
-  return result.data
-}
-
-/**
- * @param {ReportData} data
- * @param {{ name: string } & CommandContext} context
- * @returns {void}
- */
-export function formatReportDataOutput (data, { name, outputJson, outputMarkdown, reportId, strict }) {
-  if (outputJson) {
-    console.log(JSON.stringify(data, undefined, 2))
-  } else {
-    const format = new ChalkOrMarkdown(!!outputMarkdown)
-    console.log('\nDetailed info on socket.dev: ' + format.hyperlink(reportId, data.url, { fallbackToUrl: true }))
-    if (!outputMarkdown) {
-      console.log(chalk.dim('\nOr rerun', chalk.italic(name), 'using the', chalk.italic('--json'), 'flag to get full JSON output'))
-    }
-  }
-
-  if (strict && data.healthy === false) {
-    process.exit(1)
-  }
-}

package/lib/commands/repos/create.js

@@ -1,166 +0,0 @@
-/* eslint-disable no-console */
-
-import chalk from 'chalk'
-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 create = {
-  description: 'Create a repository in an organization',
-  async run (argv, importMeta, { parentName }) {
-    const name = parentName + ' create'
-
-    const input = setupCommand(name, create.description, argv, importMeta)
-    if (input) {
-      const spinnerText = 'Creating repository... \n'
-      const spinner = ora(spinnerText).start()
-      await createRepo(input.orgSlug, input, spinner)
-    }
-  }
-}
-
-const repositoryCreationFlags = prepareFlags({
-  repoName: {
-    type: 'string',
-    shortFlag: 'n',
-    default: '',
-    description: 'Repository name',
-  },
-  repoDescription: {
-    type: 'string',
-    shortFlag: 'd',
-    default: '',
-    description: 'Repository description',
-  },
-  homepage: {
-    type: 'string',
-    shortFlag: 'h',
-    default: '',
-    description: 'Repository url',
-  },
-  defaultBranch: {
-    type: 'string',
-    shortFlag: 'b',
-    default: 'main',
-    description: 'Repository default branch',
-  },
-  visibility: {
-    type: 'string',
-    shortFlag: 'v',
-    default: 'private',
-    description: 'Repository visibility (Default Private)',
-  }
-})
-
-// Internal functions
-
-/**
- * @typedef CommandContext
- * @property {boolean} outputJson
- * @property {boolean} outputMarkdown
- * @property {string} orgSlug
- * @property {string} name
- * @property {string} description
- * @property {string} homepage
- * @property {string} default_branch
- * @property {string} visibility
- */
-
-/**
- * @param {string} name
- * @param {string} description
- * @param {readonly string[]} argv
- * @param {ImportMeta} importMeta
- * @returns {void|CommandContext}
- */
-function setupCommand (name, description, argv, importMeta) {
-  const flags = {
-    ...outputFlags,
-    ...repositoryCreationFlags
-  }
-
-  const cli = meow(`
-    Usage
-      $ ${name} <org slug>
-
-    Options
-      ${printFlagList(flags, 6)}
-
-    Examples
-      $ ${name} FakeOrg --repoName=test-repo
-  `, {
-    argv,
-    description,
-    importMeta,
-    flags
-  })
-
-  const {
-    json: outputJson,
-    markdown: outputMarkdown,
-    repoName,
-    repoDescription,
-    homepage,
-    defaultBranch,
-    visibility
-  } = cli.flags
-
-  const [orgSlug = ''] = cli.input
-
-  if (!orgSlug) {
-    console.error(`${chalk.bgRed('Input error')}: Please provide an organization slug \n`)
-    cli.showHelp()
-    return
-  }
-
-  if (!repoName) {
-    console.error(`${chalk.bgRed('Input error')}: Repository name is required. \n`)
-    cli.showHelp()
-    return
-  }
-
-  return {
-    outputJson,
-    outputMarkdown,
-    orgSlug,
-    name: repoName,
-    description: repoDescription,
-    homepage,
-    default_branch: defaultBranch,
-    visibility
-  }
-}
-
-/**
- * @typedef RepositoryData
- * @property {import('@socketsecurity/sdk').SocketSdkReturnType<'createOrgRepo'>["data"]} data
- */
-
-/**
- * @param {string} orgSlug
- * @param {CommandContext} input
- * @param {import('ora').Ora} spinner
- * @returns {Promise<void|RepositoryData>}
- */
-async function createRepo (orgSlug, input, spinner) {
-  const socketSdk = await setupSdk(getDefaultKey())
-  const result = await handleApiCall(socketSdk.createOrgRepo(orgSlug, input), 'creating repository')
-
-  if (!result.success) {
-    return handleUnsuccessfulApiResponse('createOrgRepo', result, spinner)
-  }
-
-  spinner.stop()
-
-  console.log('\n✅ Repository created successfully \n')
-
-  return {
-    data: result.data
-  }
-}

package/lib/commands/repos/delete.js

@@ -1,93 +0,0 @@
-/* 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 del = {
-  description: 'Delete a repository in an organization',
-  async run (argv, importMeta, { parentName }) {
-    const name = parentName + ' del'
-
-    const input = setupCommand(name, del.description, argv, importMeta)
-    if (input) {
-      const spinnerText = 'Deleting repository... \n'
-      const spinner = ora(spinnerText).start()
-      await deleteRepository(input.orgSlug, input.repoName, spinner)
-    }
-  }
-}
-
-// Internal functions
-
-/**
- * @typedef CommandContext
- * @property {string} orgSlug
- * @property {string} repoName
- */
-
-/**
- * @param {string} name
- * @param {string} description
- * @param {readonly string[]} argv
- * @param {ImportMeta} importMeta
- * @returns {void|CommandContext}
- */
-function setupCommand (name, description, argv, importMeta) {
-  const cli = meow(`
-    Usage
-      $ ${name} <org slug> <repo slug>
-
-    Examples
-      $ ${name} FakeOrg test-repo
-  `, {
-    argv,
-    description,
-    importMeta
-  })
-
-  const [orgSlug = '', repoName = ''] = cli.input
-
-  if (!orgSlug || !repoName) {
-    console.error(`${chalk.bgRed('Input error')}: Please provide an organization slug and repository slug \n`)
-    cli.showHelp()
-    return
-  }
-
-  return {
-    orgSlug,
-    repoName
-  }
-}
-
-/**
- * @typedef RepositoryData
- * @property {import('@socketsecurity/sdk').SocketSdkReturnType<'deleteOrgRepo'>["data"]} data
- */
-
-/**
- * @param {string} orgSlug
- * @param {string} repoName
- * @param {import('ora').Ora} spinner
- * @returns {Promise<void|RepositoryData>}
- */
-async function deleteRepository (orgSlug, repoName, spinner) {
-  const socketSdk = await setupSdk(getDefaultKey())
-  const result = await handleApiCall(socketSdk.deleteOrgRepo(orgSlug, repoName), 'deleting repository')
-
-  if (!result.success) {
-    return handleUnsuccessfulApiResponse('deleteOrgRepo', result, spinner)
-  }
-
-  spinner.stop()
-
-  console.log('\n✅ Repository deleted successfully \n')
-
-  return {
-    data: result.data
-  }
-}

package/lib/commands/repos/index.js

@@ -1,30 +0,0 @@
-import { create } from './create.js'
-import { del } from './delete.js'
-import { list } from './list.js'
-import { update } from './update.js'
-import { view } from './view.js'
-import { meowWithSubcommands } from '../../utils/meow-with-subcommands.js'
-
-const description = 'Repositories related commands'
-
-/** @type {import('../../utils/meow-with-subcommands.js').CliSubcommand} */
-export const repo = {
-  description,
-  run: async (argv, importMeta, { parentName }) => {
-    await meowWithSubcommands(
-      {
-        create,
-        view,
-        list,
-        del,
-        update
-      },
-      {
-        argv,
-        description,
-        importMeta,
-        name: parentName + ' repo',
-      }
-    )
-  }
-}

package/lib/commands/repos/list.js

@@ -1,170 +0,0 @@
-/* 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 list = {
-  description: 'List repositories in an organization',
-  async run (argv, importMeta, { parentName }) {
-    const name = parentName + ' list'
-
-    const input = setupCommand(name, list.description, argv, importMeta)
-    if (input) {
-      const spinnerText = 'Listing repositories... \n'
-      const spinner = ora(spinnerText).start()
-      await listOrgRepos(input.orgSlug, input, spinner)
-    }
-  }
-}
-
-const listRepoFlags = prepareFlags({
-  sort: {
-    type: 'string',
-    shortFlag: 's',
-    default: 'created_at',
-    description: 'Sorting option',
-  },
-  direction: {
-    type: 'string',
-    default: 'desc',
-    description: 'Direction option',
-  },
-  perPage: {
-    type: 'number',
-    shortFlag: 'pp',
-    default: 30,
-    description: 'Number of results per page'
-  },
-  page: {
-    type: 'number',
-    shortFlag: 'p',
-    default: 1,
-    description: 'Page number'
-  },
-})
-
-// Internal functions
-
-/**
- * @typedef CommandContext
- * @property {boolean} outputJson
- * @property {boolean} outputMarkdown
- * @property {string} orgSlug
- * @property {string} sort
- * @property {string} direction
- * @property {number} per_page
- * @property {number} page
- */
-
-/**
- * @param {string} name
- * @param {string} description
- * @param {readonly string[]} argv
- * @param {ImportMeta} importMeta
- * @returns {void|CommandContext}
- */
-function setupCommand (name, description, argv, importMeta) {
-  const flags = {
-    ...outputFlags,
-    ...listRepoFlags
-  }
-
-  const cli = meow(`
-    Usage
-      $ ${name} <org slug>
-
-    Options
-      ${printFlagList(flags, 6)}
-
-    Examples
-      $ ${name} FakeOrg
-  `, {
-    argv,
-    description,
-    importMeta,
-    flags
-  })
-
-  const {
-    json: outputJson,
-    markdown: outputMarkdown,
-    perPage,
-    sort,
-    direction,
-    page
-  } = cli.flags
-
-  if (!cli.input[0]) {
-    console.error(`${chalk.bgRed('Input error')}: Please provide an organization slug \n`)
-    cli.showHelp()
-    return
-  }
-
-  const [orgSlug = ''] = cli.input
-
-  return {
-    outputJson,
-    outputMarkdown,
-    orgSlug,
-    sort,
-    direction,
-    page,
-    per_page: perPage
-  }
-}
-
-/**
- * @typedef RepositoryData
- * @property {import('@socketsecurity/sdk').SocketSdkReturnType<'getOrgRepoList'>["data"]} data
- */
-
-/**
- * @param {string} orgSlug
- * @param {CommandContext} input
- * @param {import('ora').Ora} spinner
- * @returns {Promise<void|RepositoryData>}
- */
-async function listOrgRepos (orgSlug, input, spinner) {
-  const socketSdk = await setupSdk(getDefaultKey())
-  const result = await handleApiCall(socketSdk.getOrgRepoList(orgSlug, input), 'listing repositories')
-
-  if (!result.success) {
-    return handleUnsuccessfulApiResponse('getOrgRepoList', result, spinner)
-  }
-
-  spinner.stop()
-
-  const options = {
-    columns: [
-      { field: 'id', name: chalk.magenta('ID') },
-      { field: 'name', name: chalk.magenta('Name') },
-      { field: 'visibility', name: chalk.magenta('Visibility') },
-      { field: 'default_branch', name: chalk.magenta('Default branch') },
-      { field: 'archived', name: chalk.magenta('Archived') }
-    ]
-  }
-
-  const formattedResults = result.data.results.map(d => {
-    return {
-      ...d
-    }
-  })
-
-  const table = chalkTable(options, formattedResults)
-
-  console.log(table, '\n')
-
-  return {
-    data: result.data
-  }
-}