@mux/cli 0.6.2 → 0.7.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mux/cli",
   "description": "Your friendly neighborhood Mux CLI tool!",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "author": {
     "name": "Mux",
     "email": "devex@mux.com",
@@ -16,49 +16,49 @@
   },
   "bugs": "https://github.com/muxinc/cli/issues",
   "dependencies": {
-    "@mux/mux-node": "^3.1.0",
-    "@oclif/command": "^1.8.0",
-    "@oclif/config": "^1.17.0",
-    "@oclif/plugin-autocomplete": "^0.2.0",
-    "@oclif/plugin-commands": "^1.3.0",
-    "@oclif/plugin-help": "^3.2.0",
-    "@oclif/plugin-not-found": "^1.2.4",
-    "@oclif/plugin-plugins": "^1.9.4",
-    "@oclif/plugin-update": "^1.3.10",
-    "@oclif/plugin-warn-if-update-available": "^1.7.0",
-    "chalk": "^4.1.0",
+    "@mux/mux-node": "^4.0.0",
+    "@oclif/command": "^1.8.16",
+    "@oclif/config": "^1.18.2",
+    "@oclif/plugin-autocomplete": "^1.1.1",
+    "@oclif/plugin-commands": "^2.0.2",
+    "@oclif/plugin-help": "^5.1.10",
+    "@oclif/plugin-not-found": "^2.2.4",
+    "@oclif/plugin-plugins": "^2.0.12",
+    "@oclif/plugin-update": "^2.1.5",
+    "@oclif/plugin-warn-if-update-available": "^2.0.4",
+    "chalk": "4.1.2",
     "clipboardy": "^2.3.0",
     "dotenv": "^8.2.0",
-    "fs-extra": "^9.0.1",
-    "inquirer": "^7.3.3",
+    "fs-extra": "^10.0.0",
+    "inquirer": "^8.2.0",
     "listr": "^0.14.3",
     "request": "^2.88.2",
-    "runtypes": "^5.0.1",
-    "rxjs": "^6.6.3"
+    "runtypes": "^6.5.0",
+    "rxjs": "^7.5.2"
   },
   "devDependencies": {
-    "@oclif/dev-cli": "^1.24.3",
-    "@oclif/test": "^1.2.8",
+    "@oclif/dev-cli": "^1.26.10",
+    "@oclif/test": "^2.0.3",
     "@oclif/tslint": "^3",
-    "@types/chai": "^4.2.14",
-    "@types/fs-extra": "^9.0.4",
-    "@types/inquirer": "^7.3.1",
-    "@types/listr": "^0.14.2",
-    "@types/mocha": "^8.0.4",
-    "@types/node": "^14.14.37",
-    "@types/request": "^2.48.5",
-    "chai": "^4",
-    "globby": "^11.0.1",
-    "mocha": "^8.2.1",
+    "@types/chai": "^4.3.0",
+    "@types/fs-extra": "^9.0.13",
+    "@types/inquirer": "^8.1.3",
+    "@types/listr": "^0.14.4",
+    "@types/mocha": "^9.1.0",
+    "@types/node": "^17.0.12",
+    "@types/request": "^2.48.8",
+    "chai": "^4.3.6",
+    "globby": "11.0.4",
+    "mocha": "6.2.3",
     "nyc": "^15.1.0",
-    "oclif": "^1.16.1",
-    "ts-node": "^9.0.0",
+    "oclif": "^2.4.0",
+    "ts-node": "^10.4.0",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typescript": "^4.1.2"
+    "typescript": "^4.5.5"
   },
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=14.0.0"
   },
   "files": [
     "/bin",

package/src/command-bases/asset-base.ts

@@ -1,9 +1,14 @@
 import { Asset } from '@mux/mux-node';
 import { flags } from '@oclif/command';
+import * as Parser from '@oclif/parser';
 import CommandBase from './base';
 
+export type AssetBaseFlags = {
+  private: Parser.flags.IBooleanFlag<boolean>;
+};
+
 export default abstract class AssetCommandBase extends CommandBase {
-  static flags = {
+  static flags: AssetBaseFlags = {
     private: flags.boolean({
       char: 'p',
       description: 'add a private playback policy to the created asset',

package/src/command-bases/base.ts

@@ -12,13 +12,18 @@ export default abstract class CommandBase extends Command {
   configFile = path.join(this.config.configDir, 'config.json');
 
   MuxConfig!: MuxCliConfigV1;
+  Mux!: Mux;
   Video!: MuxVideo;
   Data!: MuxData;
   JWT: any;
 
   async readConfigV1(): Promise<MuxCliConfigV1 | null> {
+    const configAlreadyExists = await fs.pathExists(this.configFile);
     try {
-      const configRaw = await fs.readJSON(this.configFile);
+      const configRaw =
+        configAlreadyExists
+          ? await fs.readJSON(this.configFile)
+          : {};
 
       // Mux SDK configuration options
       configRaw.tokenId = process.env.MUX_TOKEN_ID ?? configRaw.tokenId;
@@ -29,33 +34,38 @@ export default abstract class CommandBase extends Command {
       // Mux CLI specific configuration options
       configRaw.configVersion = configRaw.configVersion ?? 1;
       configRaw.baseUrl = process.env.MUX_CLI_BASE_URL ?? configRaw.baseUrl ?? MUX_API_BASE_URL;
-
       return MuxCliConfigV1.check(configRaw);
     } catch (err) {
-      if (err.errno !== -2) {
-        this.error(err);
+      if (configAlreadyExists) {
+        // we have a bad config file, and should say so
+        this.log(
+          chalk`{bold.underline.red Invalid Mux configuration file found at {bold.underline.cyan ${this.configFile}}:}\n\n` +
+          Object.entries((err as any).details).map(tup => " - " + chalk`{cyan ${tup[0]}}` + `: ${tup[1]}`) +
+          chalk`\n\nPlease fix the file or run {bold.magenta mux init --force} to create a new one.`
+        )
+      } else {
+        this.log(
+          chalk`{bold.underline.red No Mux configuration file found!} If you'd like to create ` +
+          chalk`one, run the {bold.magenta init} command. Otherwise, make sure to have the ` +
+          chalk`{bold.yellow MUX_TOKEN_ID} and {bold.yellow MUX_TOKEN_SECRET} environment variables set. 👋`
+        );
       }
 
-      return null;
+      process.exit(1);
     }
   }
 
   async init() {
-    try {
-      const config = await this.readConfigV1();
-      const { Video, Data } = new Mux(config?.tokenId, config?.tokenSecret, {
-        baseUrl: config?.baseUrl,
-      });
-
-      this.Video = Video;
-      this.Data = Data;
-      this.JWT = Mux.JWT;
-    } catch {
-      if (this.id === 'init') return; // If we're initing we're trying to fix this, so don't yell :)
-
-      this.log(
-        chalk`{bold.underline.red No Mux config file found!} If you'd like to create one, run the {bold.magenta init} command. Otherwise, make sure to have the {bold.yellow MUX_TOKEN_ID} and {bold.yellow MUX_TOKEN_SECRET} environment variables set. 👋`
-      );
-    }
+    if (this.id === 'init') return; // If we're initing we don't want any of this!
+
+    const config = await this.readConfigV1();
+    const mux = new Mux(config?.tokenId, config?.tokenSecret, {
+      baseUrl: config?.baseUrl,
+    });
+
+    this.Mux = mux;
+    this.Video = this.Mux.Video;
+    this.Data = this.Mux.Data;
+    this.JWT = Mux.JWT;
   }
 }

package/src/commands/assets/create.ts

@@ -63,7 +63,12 @@ export default class AssetsCreate extends AssetCommandBase {
         "\n\n" +
         err
       );
-      this.error(err);
+
+      if (err instanceof Error) {
+        this.error(err);
+      } else {
+        throw err;
+      }
     }
   }
 }

package/src/commands/assets/upload.ts

@@ -8,9 +8,14 @@ import * as Listr from 'listr';
 import * as path from 'path';
 import * as request from 'request';
 
-import Command from '../../command-bases/asset-base';
+import AssetCommandBase, { AssetBaseFlags } from '../../command-bases/asset-base';
 
-export default class AssetsCreate extends Command {
+export type AssetCreateFlags = AssetBaseFlags & {
+  filter: flags.IOptionFlag<string | undefined>;
+  concurrent: flags.IOptionFlag<number>;
+};
+
+export default class AssetsCreate extends AssetCommandBase {
   static description = 'Create a new asset in Mux via a local file';
 
   static args = [
@@ -21,8 +26,8 @@ export default class AssetsCreate extends Command {
     },
   ];
 
-  static flags = {
-    ...Command.flags,
+  static flags: AssetCreateFlags = {
+    ...AssetCommandBase.flags,
     filter: flags.string({
       char: 'f',
       description:
@@ -33,6 +38,10 @@ export default class AssetsCreate extends Command {
       description: 'max number of files to upload at once',
       default: 3,
     }),
+    private: flags.boolean({
+      char: 'p',
+      default: false,
+    })
   };
 
   getFilePaths(filePath: string, filter = '') {
@@ -172,7 +181,12 @@ export default class AssetsCreate extends Command {
         "\n\n" +
         err
       );
-      this.error(err);
+
+      if (err instanceof Error) {
+        this.error(err);
+      } else {
+        throw err;
+      }
     }
   }
 }

package/src/commands/init.ts

@@ -1,4 +1,6 @@
 import Mux from '@mux/mux-node';
+import { flags } from '@oclif/command';
+import * as Parser from '@oclif/parser';
 import * as chalk from 'chalk';
 import * as dotenv from 'dotenv';
 import * as fs from 'fs-extra';
@@ -6,6 +8,11 @@ import * as inquirer from 'inquirer';
 import * as path from 'path';
 
 import MuxBase from '../command-bases/base';
+import { MuxCliConfigV1 } from '../config';
+
+export type InitFlags = {
+  force: Parser.flags.IBooleanFlag<boolean>;
+};
 
 export default class Init extends MuxBase {
   static description = 'set up a user-level config';
@@ -19,18 +26,22 @@ export default class Init extends MuxBase {
     },
   ];
 
+  static flags: InitFlags = {
+    force: flags.boolean({
+      name: 'force',
+      char: 'f',
+      description: 'Will initialize a new file even if one already exists.',
+      default: false,
+    }),
+  };
+
   Video: any;
   JWT: any;
 
-  muxConfig: {
-    tokenId?: string;
-    tokenSecret?: string;
-    signingKeyId?: string;
-    signingKeySecret?: string;
-  } = {};
+  muxConfig: Partial<MuxCliConfigV1> = {};
 
   async run() {
-    const { args } = this.parse(Init);
+    const { args, flags } = this.parse(Init);
 
     let prompts: {
       name: string;
@@ -70,7 +81,12 @@ export default class Init extends MuxBase {
       ];
     }
 
-    await this.readConfigV1();
+    if (!flags.force && (await fs.pathExists(this.configFile))) {
+      this.log(
+        chalk`{bold.underline.red You are attempting to initialize with an existing configuration file!} If this is intentional, please pass {bold.yellow --force}.`
+      );
+      process.exit(1);
+    }
 
     const signingKeyPrompt = {
       name: 'createSigningKey',
@@ -91,6 +107,7 @@ export default class Init extends MuxBase {
 
     // If the token was loaded from an env file they'll already be set in the appropriate environment variables and
     // the prompts themselves will be null.
+    this.muxConfig.configVersion = 1;
     this.muxConfig.tokenId = process.env.MUX_TOKEN_ID = tokenId || process.env.MUX_TOKEN_ID;
     this.muxConfig.tokenSecret = process.env.MUX_TOKEN_SECRET = tokenSecret || process.env.MUX_TOKEN_SECRET;
 
@@ -118,7 +135,12 @@ export default class Init extends MuxBase {
         'utf8'
       );
     } catch (err) {
-      this.error(err);
+      // TODO: improve error handling type safety here
+      if (err instanceof Error) {
+        this.error(err);
+      } else {
+        throw err;
+      }
     }
 
     this.log(

package/src/commands/live/complete.ts

@@ -52,7 +52,12 @@ export default class LiveComplete extends LiveCommandBase {
         "\n\n" +
         err
       );
-      this.error(err);
+
+      if (err instanceof Error) {
+        this.error(err);
+      } else {
+        throw err;
+      }
     }
   }
 }

package/src/commands/live/disable.ts

@@ -36,7 +36,12 @@ export default class LiveDisable extends LiveCommandBase {
         "\n\n" +
         err
       );
-      this.error(err);
+
+      if (err instanceof Error) {
+        this.error(err);
+      } else {
+        throw err;
+      }
     }
   }
 }

package/src/commands/live/enable.ts

@@ -36,7 +36,12 @@ export default class LiveEnable extends LiveCommandBase {
         "\n\n" +
         err
       );
-      this.error(err);
+
+      if (err instanceof Error) {
+        this.error(err);
+      } else {
+        throw err;
+      }
     }
   }
 }