update the stream functionality

Author: charliegerard

lib/commands/fullscans/stream.js

@@ -17,9 +17,9 @@ export const stream = {
 
     const input = setupCommand(name, stream.description, argv, importMeta)
     if (input) {
-      const spinnerText = 'Streaming full scan...'
+      const spinnerText = 'Streaming full scan... \n'
       const spinner = ora(spinnerText).start()
-      await getOrgFullScan(input.orgSlug, input.fullScanId, spinner)
+      await getOrgFullScan(input.orgSlug, input.fullScanId, input.file, spinner)
     }
   }
 }
@@ -32,6 +32,7 @@ export const stream = {
  * @property {boolean} outputMarkdown
  * @property {string} orgSlug
  * @property {string} fullScanId
+ * @property {string | undefined} file
  */
 
 /**
@@ -48,13 +49,13 @@ function setupCommand (name, description, argv, importMeta) {
 
   const cli = meow(`
     Usage
-      $ ${name} <org slug> <full scan ID>
+      $ ${name} <org slug> <full scan ID> <file>
 
     Options
       ${printFlagList(flags, 6)}
 
     Examples
-      $ ${name} FakeOrg 000aaaa1-0000-0a0a-00a0-00a0000000a0
+      $ ${name} FakeOrg 000aaaa1-0000-0a0a-00a0-00a0000000a0 ./stream.txt
   `, {
     argv,
     description,
@@ -73,12 +74,14 @@ function setupCommand (name, description, argv, importMeta) {
 
   const orgSlug = cli.input[0] || ''
   const fullScanId = cli.input[1] || ''
+  const file = cli.input[2]
 
   return {
     outputJson,
     outputMarkdown,
     orgSlug,
-    fullScanId
+    fullScanId,
+    file
   }
 }
 
@@ -90,21 +93,23 @@ function setupCommand (name, description, argv, importMeta) {
 /**
  * @param {string} orgSlug
  * @param {string} fullScanId
+ * @param {string|undefined} file
  * @param {import('ora').Ora} spinner
  * @returns {Promise<void|FullScanData>}
  */
-async function getOrgFullScan (orgSlug, fullScanId, spinner) {
+async function getOrgFullScan (orgSlug, fullScanId, file, spinner) {
   const socketSdk = await setupSdk(getDefaultKey())
-  const result = await handleApiCall(socketSdk.getOrgFullScan(orgSlug, fullScanId), 'Streaming a full scan')
+  // @ts-ignore
+  const result = await handleApiCall(socketSdk.getOrgFullScan(orgSlug, fullScanId, file), 'Streaming a full scan')
 
-  if (!result.success) {
+  if (!result?.success) {
     return handleUnsuccessfulApiResponse('getOrgFullScan', result, spinner)
   }
 
-  console.log('\n Full scan details: \n')
-
   spinner.stop()
 
+  console.log(file ? `\nFull scan details written to ${file} \n` : '\nFull scan details: \n')
+
   return {
     data: result.data
   }