@corellium/corellium-cli 1.4.0 → 1.5.1

package/src/commands/webplayer/create.js

@@ -1,59 +1,66 @@
-const Webplayer = require('../../clients/Webplayer')
-const { displayTable } = require('../../table')
-const { validateNonEmpty } = require('../../utils')
-const { handleError } = require('../../error')
+const Webplayer = require('../../clients/Webplayer');
+const { displayTable } = require('../../table');
+const { validateNonEmpty } = require('../../utils');
+const { handleError } = require('../../error');
 
 async function builder (yargs) {
-  yargs.option('verbose', {
-    alias: 'v',
-    type: 'boolean',
-    describe: 'Console will receive verbose error output'
-  }).option('project', {
-    type: 'input',
-    describe: 'Project ID',
-    demandOption: true,
-    string: true,
-    validateNonEmpty
-  }).option('instance', {
-    type: 'input',
-    describe: 'Instance ID',
-    demandOption: true,
-    string: true,
-    validateNonEmpty
-  }).option('features', {
-    type: 'input',
-    describe: 'Enabled Feature Set',
-    demandOption: true,
-    string: true,
-    validateNonEmpty
-  }).option('permissions', {
-    type: 'input',
-    describe: 'Endpoint Permissions',
-    demandOption: false,
-    string: true,
-    validateNonEmpty
-  }).option('expiresIn', {
-    type: 'input',
-    describe: 'Token expiration in seconds',
-    demandOption: true,
-    string: true,
-    validateNonEmpty
-  }).option('format', {
-    type: 'input',
-    describe: 'Output format (default is json) e.g. table',
-    string: true,
-    choices: ['table', 'json', 'csv']
-  })
+  yargs
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output',
+    })
+    .option('project', {
+      type: 'input',
+      describe: 'Project ID',
+      demandOption: true,
+      string: true,
+      validateNonEmpty,
+    })
+    .option('instance', {
+      type: 'input',
+      describe: 'Instance ID',
+      demandOption: true,
+      string: true,
+      validateNonEmpty,
+    })
+    .option('features', {
+      type: 'input',
+      describe: 'Enabled Feature Set',
+      demandOption: true,
+      string: true,
+      validateNonEmpty,
+    })
+    .option('permissions', {
+      type: 'input',
+      describe: 'Endpoint Permissions',
+      demandOption: false,
+      string: true,
+      validateNonEmpty,
+    })
+    .option('expiresIn', {
+      type: 'input',
+      describe: 'Token expiration in seconds',
+      demandOption: true,
+      string: true,
+      validateNonEmpty,
+    })
+    .option('format', {
+      type: 'input',
+      describe: 'Output format (default is json) e.g. table',
+      string: true,
+      choices: ['table', 'json', 'csv'],
+    });
 }
 
 async function handler (argv) {
   try {
-    const webplayer = new Webplayer(argv)
-    const session = await webplayer.createSession()
+    const webplayer = new Webplayer(argv);
+    const session = await webplayer.createSession();
     // log.info('Created Webplayer session')
-    await displayTable(argv.format || 'json', [session], ['identifier', 'token', 'expiration', 'features'])
+    await displayTable(argv.format || 'json', [session], ['identifier', 'token', 'expiration', 'features']);
   } catch (err) {
-    handleError(err, 'Create Webplayer session failed', argv.verbose)
+    handleError(err, 'Create Webplayer session failed', argv.verbose);
   }
 }
 
@@ -61,5 +68,5 @@ module.exports = {
   builder,
   handler,
   command: 'create',
-  describe: 'Create a Webplayer session returning the URL and token'
-}
+  describe: 'Create a Webplayer session returning the URL and token',
+};

package/src/commands/webplayer/destroy.js

@@ -1,36 +1,39 @@
-const Webplayer = require('../../clients/Webplayer')
-const log = require('../../logging')
-const { validateNonEmpty } = require('../../utils')
-const { handleError } = require('../../error')
+const Webplayer = require('../../clients/Webplayer');
+const log = require('../../logging');
+const { validateNonEmpty } = require('../../utils');
+const { handleError } = require('../../error');
 
 async function builder (yargs) {
-  yargs.option('verbose', {
-    alias: 'v',
-    type: 'boolean',
-    describe: 'Console will receive verbose error output'
-  }).option('project', {
-    type: 'input',
-    describe: 'Project ID',
-    demandOption: true,
-    string: true,
-    validateNonEmpty
-  }).option('session', {
-    type: 'input',
-    describe: 'Webplayer Session ID',
-    demandOption: true,
-    string: true,
-    validateNonEmpty
-  })
+  yargs
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output',
+    })
+    .option('project', {
+      type: 'input',
+      describe: 'Project ID',
+      demandOption: true,
+      string: true,
+      validateNonEmpty,
+    })
+    .option('session', {
+      type: 'input',
+      describe: 'Webplayer Session ID',
+      demandOption: true,
+      string: true,
+      validateNonEmpty,
+    });
 }
 
 async function handler (argv) {
-  const { session: sessionId } = argv
+  const { session: sessionId } = argv;
   try {
-    const webplayer = new Webplayer(argv)
-    await webplayer.destroySession(sessionId)
-    log.info(`Destroyed Webplayer session ${sessionId}`)
+    const webplayer = new Webplayer(argv);
+    await webplayer.destroySession(sessionId);
+    log.info(`Destroyed Webplayer session ${sessionId}`);
   } catch (err) {
-    handleError(err, `Destroy Webplayer session ${sessionId} failed`, argv.verbose)
+    handleError(err, `Destroy Webplayer session ${sessionId} failed`, argv.verbose);
   }
 }
 
@@ -38,5 +41,5 @@ module.exports = {
   builder,
   handler,
   command: 'destroy',
-  describe: 'Destroy a Webplayer session'
-}
+  describe: 'Destroy a Webplayer session',
+};

package/src/commands/webplayer/index.js

@@ -1,15 +1,10 @@
-const subcommands = [
-  require('./create'),
-  require('./destroy'),
-  require('./list'),
-  require('./login')
-]
+const subcommands = [require('./create'), require('./destroy'), require('./list'), require('./login')];
 
-let _yargs
+let _yargs;
 
 module.exports = {
-  builder: yargs => (_yargs = yargs) && yargs.command(subcommands).scriptName(''),
-  handler: argv => !argv[1] && _yargs.showHelp(),
+  builder: (yargs) => (_yargs = yargs) && yargs.command(subcommands).scriptName(''),
+  handler: (argv) => !argv[1] && _yargs.showHelp(),
   command: 'webplayer',
-  describe: 'Webplayer related commands'
-}
+  describe: 'Webplayer related commands',
+};

package/src/commands/webplayer/list.js

@@ -1,56 +1,55 @@
-const Webplayer = require('../../clients/Webplayer')
-const { displayTable } = require('../../table')
-const { validateNonEmpty } = require('../../utils')
-const { handleError } = require('../../error')
+const Webplayer = require('../../clients/Webplayer');
+const { displayTable } = require('../../table');
+const { validateNonEmpty } = require('../../utils');
+const { handleError } = require('../../error');
 
 async function builder (yargs) {
-  yargs.option('verbose', {
-    alias: 'v',
-    type: 'boolean',
-    describe: 'Console will receive verbose error output'
-  }).option('project', {
-    type: 'input',
-    describe: 'Project ID',
-    demandOption: true,
-    string: true,
-    validateNonEmpty
-  }).option('session', {
-    type: 'input',
-    describe: 'Webplayer Session ID',
-    demandOption: false,
-    string: true
-  }).option('format', {
-    type: 'input',
-    describe: 'Output format (default is json) e.g. table',
-    string: true,
-    choices: ['table', 'json', 'csv']
-  })
+  yargs
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output',
+    })
+    .option('project', {
+      type: 'input',
+      describe: 'Project ID',
+      demandOption: true,
+      string: true,
+      validateNonEmpty,
+    })
+    .option('session', {
+      type: 'input',
+      describe: 'Webplayer Session ID',
+      demandOption: false,
+      string: true,
+    })
+    .option('format', {
+      type: 'input',
+      describe: 'Output format (default is json) e.g. table',
+      string: true,
+      choices: ['table', 'json', 'csv'],
+    });
 }
 
 async function handler (argv) {
   try {
-    const webplayer = new Webplayer(argv)
-    const result = await webplayer.listSessions(argv.session)
+    const webplayer = new Webplayer(argv);
+    const result = await webplayer.listSessions(argv.session);
     if (!result.length && argv.format !== 'json') {
-      console.error('Found no matching Webplayer sessions')
+      console.error('Found no matching Webplayer sessions');
     }
-    const sessions = (await webplayer.listSessions(argv.session)).map(s => {
-      const {
-        identifier,
-        token,
-        expiration,
-        features
-      } = s
+    const sessions = (await webplayer.listSessions(argv.session)).map((s) => {
+      const { identifier, token, expiration, features } = s;
       return {
         identifier,
         token,
         expiration,
-        features
-      }
-    })
-    await displayTable(argv.format, sessions, ['identifier', 'token', 'expiration', 'features'])
+        features,
+      };
+    });
+    await displayTable(argv.format, sessions, ['identifier', 'token', 'expiration', 'features']);
   } catch (err) {
-    handleError(err, 'List sessions failed', argv.verbose)
+    handleError(err, 'List sessions failed', argv.verbose);
   }
 }
 
@@ -58,5 +57,5 @@ module.exports = {
   builder,
   handler,
   command: 'list',
-  describe: 'List Webplayer sessions for a project'
-}
+  describe: 'List Webplayer sessions for a project',
+};

package/src/commands/webplayer/login.js

@@ -1,36 +1,39 @@
-const Webplayer = require('../../clients/Webplayer')
-const log = require('../../logging')
-const { validateNonEmpty } = require('../../utils')
-const { handleError } = require('../../error')
+const Webplayer = require('../../clients/Webplayer');
+const log = require('../../logging');
+const { validateNonEmpty } = require('../../utils');
+const { handleError } = require('../../error');
 
 async function builder (yargs) {
-  yargs.option('verbose', {
-    alias: 'v',
-    type: 'boolean',
-    describe: 'Console will receive verbose error output'
-  }).option('project', {
-    type: 'input',
-    describe: 'Project ID',
-    demandOption: true,
-    string: true,
-    validateNonEmpty
-  }).option('session', {
-    type: 'input',
-    describe: 'Webplayer Session ID',
-    demandOption: true,
-    string: true,
-    validateNonEmpty
-  })
+  yargs
+    .option('verbose', {
+      alias: 'v',
+      type: 'boolean',
+      describe: 'Console will receive verbose error output',
+    })
+    .option('project', {
+      type: 'input',
+      describe: 'Project ID',
+      demandOption: true,
+      string: true,
+      validateNonEmpty,
+    })
+    .option('session', {
+      type: 'input',
+      describe: 'Webplayer Session ID',
+      demandOption: true,
+      string: true,
+      validateNonEmpty,
+    });
 }
 
 async function handler (argv) {
-  const { session: sessionId } = argv
+  const { session: sessionId } = argv;
   try {
-    const webplayer = new Webplayer(argv)
-    await webplayer.login(sessionId)
-    log.info(`Login to Webplayer session ${sessionId} successful`)
+    const webplayer = new Webplayer(argv);
+    await webplayer.login(sessionId);
+    log.info(`Login to Webplayer session ${sessionId} successful`);
   } catch (err) {
-    handleError(err, `Login to Webplayer session ${sessionId} failed`, argv.verbose)
+    handleError(err, `Login to Webplayer session ${sessionId} failed`, argv.verbose);
   }
 }
 
@@ -38,5 +41,5 @@ module.exports = {
   builder,
   handler,
   command: 'login',
-  describe: 'Log CLI into a Webplayer session'
-}
+  describe: 'Log CLI into a Webplayer session',
+};

package/src/corellium-api.js

@@ -1,7 +1,7 @@
-const { Corellium } = require('@corellium/corellium-api')
-const { readProfile } = require('./profile')
+const { Corellium } = require('@corellium/corellium-api');
+const { readProfile } = require('./profile');
 
-let corellium
+let corellium;
 
 /**
  * Get an authenticated instance of @corellium/corellium-api
@@ -9,17 +9,17 @@ let corellium
  */
 async function getCorelliumApi () {
   if (!corellium) {
-    const profile = readProfile()
-    const { endpoint, token } = profile
-    const client = new Corellium({ endpoint, token: { token } })
-    await client.login()
+    const profile = readProfile();
+    const { endpoint, token } = profile;
+    const client = new Corellium({ endpoint, token: { token } });
+    await client.login();
 
-    corellium = client
+    corellium = client;
   }
 
-  return corellium
+  return corellium;
 }
 
 module.exports = {
-  getCorelliumApi
-}
+  getCorelliumApi,
+};

package/src/error.js

@@ -1,36 +1,38 @@
-const log = require('./logging')
+const log = require('./logging');
 function getUserErrorMessage (body) {
-  const keys = ['errorID', 'error']
+  const keys = ['errorID', 'error'];
   if (body && body.errorID === 'UserError') {
     const err = Object.keys(body)
-      .filter(key => !keys.includes(key))
+      .filter((key) => !keys.includes(key))
       .reduce((obj, key) => {
-        obj[key] = body[key]
-        return obj
-      }, {})
-    return JSON.stringify(err)
+        obj[key] = body[key];
+        return obj;
+      }, {});
+    return JSON.stringify(err);
   }
-  return ''
+  return '';
 }
 
 function getErrorMessage (error) {
-  const { body, response, error: errorObject } = error
+  const { body, response, error: errorObject } = error;
   if (body && body.error) {
-    return `${body.error} ${getUserErrorMessage(body)}`
+    return `${body.error} ${getUserErrorMessage(body)}`;
   } else if (response && response.data && response.data.error) {
-    return `${response.data.error} ${getUserErrorMessage(response.data)}`
+    return `${response.data.error} ${getUserErrorMessage(response.data)}`;
   } else if (errorObject && errorObject.message) {
-    return errorObject.message
+    return errorObject.message;
   } else {
-    return error.message
+    return error.message;
   }
 }
 
 function handleError (error, customMessage, detailed) {
-  const errorMessage = getErrorMessage(error)
-  console.error(`${customMessage}: ${errorMessage}`)
-  if (detailed) { log.error(JSON.stringify(error.body || error.response?.data || error.message, null, 2)) }
-  process.exit(1)
+  const errorMessage = getErrorMessage(error);
+  console.error(`${customMessage}: ${errorMessage}`);
+  if (detailed) {
+    log.error(JSON.stringify(error.body || error.response?.data || error.message, null, 2));
+  }
+  process.exit(1);
 }
 
-module.exports = { handleError }
+module.exports = { handleError };

package/src/logging.js

@@ -1,7 +1,7 @@
-const chalk = require('chalk')
+const chalk = require('chalk');
 
-const INFO_COLOR = 'green'
-const ERROR_COLOR = 'red'
+const INFO_COLOR = 'green';
+const ERROR_COLOR = 'red';
 
 /**
  * Logging
@@ -9,20 +9,20 @@ const ERROR_COLOR = 'red'
  */
 const log = {
   plain: (...args) => {
-    console.log.bind(console, ...args)()
+    console.log.bind(console, ...args)();
   },
   info: (...args) => {
-    args[0] = '\r' + args[0]
-    args.unshift(chalk[INFO_COLOR]._styler.open)
-    args.push(chalk[INFO_COLOR]._styler.close)
-    console.log.bind(console, ...args)()
+    args[0] = '\r' + args[0];
+    args.unshift(chalk[INFO_COLOR]._styler.open);
+    args.push(chalk[INFO_COLOR]._styler.close);
+    console.log.bind(console, ...args)();
   },
   error: (...args) => {
-    args[0] = '\r' + args[0]
-    args.unshift(chalk[ERROR_COLOR]._styler.open)
-    args.push(chalk[ERROR_COLOR]._styler.close)
-    console.error.bind(console, ...args)()
-  }
-}
+    args[0] = '\r' + args[0];
+    args.unshift(chalk[ERROR_COLOR]._styler.open);
+    args.push(chalk[ERROR_COLOR]._styler.close);
+    console.error.bind(console, ...args)();
+  },
+};
 
-module.exports = log
+module.exports = log;

package/src/profile.js

@@ -1,56 +1,56 @@
-const path = require('path')
-const fs = require('fs')
-const os = require('os')
-const fsp = fs.promises
+const path = require('path');
+const fs = require('fs');
+const os = require('os');
+const fsp = fs.promises;
 
-const homeDir = process.env.XDG_CONFIG_HOME ? process.env.XDG_CONFIG_HOME : os.homedir()
+const homeDir = process.env.XDG_CONFIG_HOME ? process.env.XDG_CONFIG_HOME : os.homedir();
 
-const profileDir = homeDir + path.sep + '.corellium'
-const profilePath = profileDir + path.sep + 'profile.json'
+const profileDir = homeDir + path.sep + '.corellium';
+const profilePath = profileDir + path.sep + 'profile.json';
 
-const trialPath = profileDir + path.sep + 'trial.json'
+const trialPath = profileDir + path.sep + 'trial.json';
 
 async function updateProfile (options) {
-  const currentProfile = {}
+  const currentProfile = {};
   try {
     // Load existing profile
-    Object.assign(currentProfile, JSON.parse(await fsp.readFile(profilePath, { encoding: 'utf8' })))
+    Object.assign(currentProfile, JSON.parse(await fsp.readFile(profilePath, { encoding: 'utf8' })));
   } catch (err) {
     if (err instanceof SyntaxError || err.code === 'ENOENT') {
       // reading json profile failed, make the new folder and file
-      await fsp.mkdir(profileDir, { recursive: true })
+      await fsp.mkdir(profileDir, { recursive: true });
     } else {
       // rethrow unhandled exceptions
-      throw err
+      throw err;
     }
   }
 
   // Write any new options, updating existing keys
-  await fsp.writeFile(profilePath, JSON.stringify({ ...currentProfile, ...options }))
+  await fsp.writeFile(profilePath, JSON.stringify({ ...currentProfile, ...options }));
 }
 
 function writeTrialConfig (config) {
-  fs.writeFileSync(trialPath, JSON.stringify(config))
+  fs.writeFileSync(trialPath, JSON.stringify(config));
 }
 
 function readTrialConfig () {
-  return JSON.parse(fs.readFileSync(trialPath))
+  return JSON.parse(fs.readFileSync(trialPath));
 }
 
 function readProfile () {
   if (!fs.existsSync(profilePath)) {
-    throw new Error(`Profile not found at ${profilePath}. Try to login with "corellium login"`)
+    throw new Error(`Profile not found at ${profilePath}. Try to login with "corellium login"`);
   }
-  return JSON.parse(fs.readFileSync(profilePath))
+  return JSON.parse(fs.readFileSync(profilePath));
 }
 
 async function deleteProfile () {
   if (!fs.existsSync(profilePath)) {
-    throw new Error(`Profile not found at ${profilePath}`)
+    throw new Error(`Profile not found at ${profilePath}`);
   }
 
-  await fs.promises.unlink(profilePath)
-  return profilePath
+  await fs.promises.unlink(profilePath);
+  return profilePath;
 }
 
 module.exports = {
@@ -59,5 +59,5 @@ module.exports = {
   readTrialConfig,
   writeTrialConfig,
   updateProfile,
-  profilePath
-}
+  profilePath,
+};

package/src/progress.js

@@ -1,5 +1,5 @@
-const cliProgress = require('cli-progress')
-const chalk = require('chalk')
+const cliProgress = require('cli-progress');
+const chalk = require('chalk');
 
 /**
  * Return a progress bar w/ defaulted format.
@@ -10,10 +10,10 @@ const chalk = require('chalk')
 function progressBar (opts) {
   return new cliProgress.SingleBar({
     format: `Upload Progress [${chalk.cyan('{bar}')}] {percentage}% || {value}/{total} Chunks || ETA: {eta}s`,
-    ...opts
-  })
+    ...opts,
+  });
 }
 
 module.exports = {
-  progressBar
-}
+  progressBar,
+};