@mux/cli 0.7.1 → 0.8.0

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @mux/cli
 $ mux COMMAND
 running command...
 $ mux (-v|--version|version)
-@mux/cli/0.7.1 darwin-x64 node-v14.17.5
+@mux/cli/0.8.0 linux-x64 node-v14.18.3
 $ mux --help [COMMAND]
 USAGE
   $ mux COMMAND
@@ -48,6 +48,7 @@ USAGE
 * [`mux plugins:uninstall PLUGIN...`](#mux-pluginsuninstall-plugin)
 * [`mux plugins:update`](#mux-pluginsupdate)
 * [`mux sign PLAYBACK-ID`](#mux-sign-playback-id)
+* [`mux spaces:sign SPACE-ID`](#mux-spacessign-space-id)
 * [`mux update [CHANNEL]`](#mux-update-channel)
 
 ## `mux assets:create INPUT`
@@ -65,7 +66,7 @@ OPTIONS
   -p, --private  add a private playback policy to the created asset
 ```
 
-_See code: [src/commands/assets/create.ts](https://github.com/muxinc/cli/blob/v0.7.1/src/commands/assets/create.ts)_
+_See code: [src/commands/assets/create.ts](https://github.com/muxinc/cli/blob/v0.8.0/src/commands/assets/create.ts)_
 
 ## `mux assets:upload PATH`
 
@@ -84,7 +85,7 @@ OPTIONS
   -p, --private
 ```
 
-_See code: [src/commands/assets/upload.ts](https://github.com/muxinc/cli/blob/v0.7.1/src/commands/assets/upload.ts)_
+_See code: [src/commands/assets/upload.ts](https://github.com/muxinc/cli/blob/v0.8.0/src/commands/assets/upload.ts)_
 
 ## `mux autocomplete [SHELL]`
 
@@ -135,20 +136,20 @@ _See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blo
 
 ## `mux help [COMMAND]`
 
-Display help for mux.
+display help for mux
 
 ```
 USAGE
   $ mux help [COMMAND]
 
 ARGUMENTS
-  COMMAND  Command to show help for.
+  COMMAND  command to show help for
 
 OPTIONS
-  -n, --nested-commands  Include all nested commands in the output.
+  --all  see all commands in CLI
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.10/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.18/src/commands/help.ts)_
 
 ## `mux init [ENVFILE]`
 
@@ -165,7 +166,7 @@ OPTIONS
   -f, --force  Will initialize a new file even if one already exists.
 ```
 
-_See code: [src/commands/init.ts](https://github.com/muxinc/cli/blob/v0.7.1/src/commands/init.ts)_
+_See code: [src/commands/init.ts](https://github.com/muxinc/cli/blob/v0.8.0/src/commands/init.ts)_
 
 ## `mux live:complete STREAMNAME`
 
@@ -183,7 +184,7 @@ OPTIONS
   -t, --streamId=stream-id      [default: stream-id] the type of the provided reference name
 ```
 
-_See code: [src/commands/live/complete.ts](https://github.com/muxinc/cli/blob/v0.7.1/src/commands/live/complete.ts)_
+_See code: [src/commands/live/complete.ts](https://github.com/muxinc/cli/blob/v0.8.0/src/commands/live/complete.ts)_
 
 ## `mux live:disable STREAMNAME`
 
@@ -200,7 +201,7 @@ OPTIONS
   -t, --streamId=stream-id  [default: stream-id] the type of the provided reference name
 ```
 
-_See code: [src/commands/live/disable.ts](https://github.com/muxinc/cli/blob/v0.7.1/src/commands/live/disable.ts)_
+_See code: [src/commands/live/disable.ts](https://github.com/muxinc/cli/blob/v0.8.0/src/commands/live/disable.ts)_
 
 ## `mux live:enable STREAMNAME`
 
@@ -217,7 +218,7 @@ OPTIONS
   -t, --streamId=stream-id  [default: stream-id] the type of the provided reference name
 ```
 
-_See code: [src/commands/live/enable.ts](https://github.com/muxinc/cli/blob/v0.7.1/src/commands/live/enable.ts)_
+_See code: [src/commands/live/enable.ts](https://github.com/muxinc/cli/blob/v0.8.0/src/commands/live/enable.ts)_
 
 ## `mux plugins`
 
@@ -372,10 +373,36 @@ OPTIONS
   -e, --expiresIn=expiresIn                  [default: 7d] How long the signature is valid for. If no unit is specified,
                                              milliseconds is assumed.
 
+  -r, --raw                                  If set, emits only the URL+JWT. Defaults to true for non-TTY.
+
   -t, --type=video|thumbnail|gif|storyboard  [default: video] What type of token this signature is for.
 ```
 
-_See code: [src/commands/sign.ts](https://github.com/muxinc/cli/blob/v0.7.1/src/commands/sign.ts)_
+_See code: [src/commands/sign.ts](https://github.com/muxinc/cli/blob/v0.8.0/src/commands/sign.ts)_
+
+## `mux spaces:sign SPACE-ID`
+
+Creates a new signed token for a Mux Space
+
+```
+USAGE
+  $ mux spaces:sign SPACE-ID
+
+ARGUMENTS
+  SPACE-ID  Space ID for which a token shall be generated.
+
+OPTIONS
+  -R, --role=role                    [default: publisher] One of 'publisher' or 'subscriber'.
+
+  -e, --expiresIn=expiresIn          [default: 7d] How long the signature is valid for. If no unit is specified,
+                                     milliseconds is assumed.
+
+  -p, --participantId=participantId  Optional, user-specified participant ID.
+
+  -r, --raw                          prints a raw JWT to stdout (default if not tty)
+```
+
+_See code: [src/commands/spaces/sign.ts](https://github.com/muxinc/cli/blob/v0.8.0/src/commands/spaces/sign.ts)_
 
 ## `mux update [CHANNEL]`
 

package/lib/command-bases/base.d.ts

@@ -1,4 +1,4 @@
-import Mux, { Video as MuxVideo, Data as MuxData } from '@mux/mux-node';
+import Mux, { Video as MuxVideo, Data as MuxData, JWT as MuxJWT } from '@mux/mux-node';
 import Command from '@oclif/command';
 import { MuxCliConfigV1 } from '../config';
 export declare const MUX_API_BASE_URL = "https://api.mux.com";
@@ -8,7 +8,7 @@ export default abstract class CommandBase extends Command {
     Mux: Mux;
     Video: MuxVideo;
     Data: MuxData;
-    JWT: any;
-    readConfigV1(): Promise<MuxCliConfigV1 | null>;
+    JWT: typeof MuxJWT;
+    readConfigV1(): Promise<MuxCliConfigV1>;
     init(): Promise<void>;
 }

package/lib/command-bases/base.js

@@ -53,6 +53,7 @@ class CommandBase extends command_1.default {
             baseUrl: config === null || config === void 0 ? void 0 : config.baseUrl,
         });
         this.Mux = mux;
+        this.MuxConfig = config;
         this.Video = this.Mux.Video;
         this.Data = this.Mux.Data;
         this.JWT = mux_node_1.default.JWT;

package/lib/commands/sign.d.ts

@@ -1,4 +1,3 @@
-import { flags } from '@oclif/command';
 import MuxBase from '../command-bases/base';
 export default class Sign extends MuxBase {
     static description: string;
@@ -7,9 +6,6 @@ export default class Sign extends MuxBase {
         description: string;
         required: boolean;
     }[];
-    static flags: {
-        expiresIn: flags.IOptionFlag<string>;
-        type: flags.IOptionFlag<string>;
-    };
+    static flags: any;
     run(): Promise<void>;
 }

package/lib/commands/sign.js

@@ -6,24 +6,36 @@ const clipboard = require("clipboardy");
 const base_1 = require("../command-bases/base");
 class Sign extends base_1.default {
     async run() {
-        const { args, flags } = this.parse(Sign);
+        const parsed = this.parse(Sign);
+        const args = parsed.args;
+        const flags = parsed.flags;
         const playbackId = args['playback-id'];
-        const options = { expiration: flags.expiresIn, type: flags.type };
+        const options = {
+            expiration: flags.expiresIn,
+            type: flags.type,
+            keyId: this.MuxConfig.signingKeyId,
+            keySecret: this.MuxConfig.signingKeySecret,
+        };
         const key = this.JWT.sign(playbackId, options);
         const url = `https://stream.mux.com/${playbackId}.m3u8?token=${key}`;
-        this.log(chalk `
+        if (flags.raw) {
+            console.log(url);
+        }
+        else {
+            this.log(chalk `
 🔑 {bold.underline Your Mux Signed Token}
 {blue ${key}}
 
 🌏 {bold.underline Full URL}
 {green ${url}}
-`);
-        try {
-            await clipboard.write(url);
-            this.log(`👉 Copied Full URL to your system clipboard`);
-        }
-        catch (_a) {
-            this.error('Unable to copy full url automatically');
+  `);
+            try {
+                await clipboard.write(url);
+                this.log(`👉 Copied Full URL to your system clipboard`);
+            }
+            catch (_a) {
+                this.error('Unable to copy full url automatically');
+            }
         }
     }
 }
@@ -47,5 +59,10 @@ Sign.flags = {
         description: 'What type of token this signature is for.',
         default: 'video',
         options: ['video', 'thumbnail', 'gif', 'storyboard'],
-    })
+    }),
+    raw: command_1.flags.boolean({
+        char: 'r',
+        description: 'If set, emits only the URL+JWT. Defaults to true for non-TTY.',
+        default: !process.stdin.isTTY,
+    }),
 };

package/lib/commands/spaces/sign.d.ts

@@ -0,0 +1,11 @@
+import MuxBase from '../../command-bases/base';
+export default class SignSpace extends MuxBase {
+    static description: string;
+    static args: {
+        name: string;
+        description: string;
+        required: boolean;
+    }[];
+    static flags: any;
+    run(): Promise<void>;
+}

package/lib/commands/spaces/sign.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_1 = require("@oclif/command");
+const JWT = require("jsonwebtoken");
+const chalk = require("chalk");
+const clipboard = require("clipboardy");
+const base_1 = require("../../command-bases/base");
+class SignSpace extends base_1.default {
+    async run() {
+        const parsed = this.parse(SignSpace);
+        const args = parsed.args;
+        const flags = parsed.flags;
+        const signingKeySecret = this.MuxConfig.signingKeySecret;
+        if (!signingKeySecret) {
+            throw new Error("No signing key found. Re-run `mux init` and generate one!");
+        }
+        // TODO: replace with mux-node-sdk signing when available
+        const payload = {
+            role: flags.role,
+            participant_id: flags.participantId,
+            kid: this.MuxConfig.signingKeyId,
+        };
+        const jwtOptions = {
+            audience: 'rt',
+            subject: args['space-id'],
+            algorithm: 'RS256',
+            noTimestamp: true,
+            expiresIn: flags.expiresIn,
+        };
+        const key = Buffer.from(signingKeySecret, 'base64');
+        const jwt = JWT.sign(payload, key, jwtOptions);
+        if (flags.raw) {
+            console.log(jwt);
+        }
+        else {
+            this.log(chalk `
+🔑 Your JWT for Mux Spaces
+{cyan ${jwt}}
+        `);
+            try {
+                await clipboard.write(jwt);
+                this.log(`👉 Copied your JWT to your system clipboard`);
+            }
+            catch (_a) {
+                this.error('Unable to copy JWT automatically');
+            }
+        }
+    }
+}
+exports.default = SignSpace;
+SignSpace.description = 'Creates a new signed token for a Mux Space';
+SignSpace.args = [
+    {
+        name: 'space-id',
+        description: 'Space ID for which a token shall be generated.',
+        required: true,
+    },
+];
+SignSpace.flags = {
+    raw: command_1.flags.boolean({
+        char: 'r',
+        description: "prints a raw JWT to stdout (default if not tty)",
+        default: !process.stdin.isTTY,
+    }),
+    participantId: command_1.flags.string({
+        char: 'p',
+        description: 'Optional, user-specified participant ID.',
+    }),
+    role: command_1.flags.string({
+        char: 'R',
+        description: 'One of \'publisher\' or \'subscriber\'.',
+        default: 'publisher',
+    }),
+    expiresIn: command_1.flags.string({
+        char: 'e',
+        description: 'How long the signature is valid for. If no unit is specified, milliseconds is assumed.',
+        default: '7d',
+    }),
+};

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.7.1","commands":{"init":{"id":"init","description":"set up a user-level config","pluginName":"@mux/cli","pluginType":"core","aliases":[],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"Will initialize a new file even if one already exists.","allowNo":false}},"args":[{"name":"envFile","description":"path to a Mux access token .env file","required":false}]},"sign":{"id":"sign","description":"Creates a new signed URL token for a playback ID","pluginName":"@mux/cli","pluginType":"core","aliases":[],"flags":{"expiresIn":{"name":"expiresIn","type":"option","char":"e","description":"How long the signature is valid for. If no unit is specified, milliseconds is assumed.","default":"7d"},"type":{"name":"type","type":"option","char":"t","description":"What type of token this signature is for.","options":["video","thumbnail","gif","storyboard"],"default":"video"}},"args":[{"name":"playback-id","description":"Playback ID to create a signed URL token for.","required":true}]},"assets:create":{"id":"assets:create","description":"Create a new asset in Mux using a file that's already available online","pluginName":"@mux/cli","pluginType":"core","aliases":[],"flags":{"private":{"name":"private","type":"boolean","char":"p","description":"add a private playback policy to the created asset","allowNo":false}},"args":[{"name":"input","description":"input URL for the file you'd like to create this asset from","required":true}]},"assets:upload":{"id":"assets:upload","description":"Create a new asset in Mux via a local file","pluginName":"@mux/cli","pluginType":"core","aliases":[],"flags":{"private":{"name":"private","type":"boolean","char":"p","allowNo":false},"filter":{"name":"filter","type":"option","char":"f","description":"regex that filters the selected destination if the provided path is a folder"},"concurrent":{"name":"concurrent","type":"option","char":"c","description":"max number of files to upload at once","default":3}},"args":[{"name":"path","description":"local path for the file (or folder) you'd like to upload","required":true}]},"live:complete":{"id":"live:complete","description":"Signal to Mux that a live stream has concluded and should be closed.","pluginName":"@mux/cli","pluginType":"core","aliases":[],"flags":{"streamId":{"name":"streamId","type":"option","char":"t","description":"the type of the provided reference name","options":["stream-id"],"default":"stream-id"},"disableAfterCompletion":{"name":"disableAfterCompletion","type":"boolean","char":"d","description":"If set, disables the stream upon completion.","allowNo":false}},"args":[{"name":"streamName","description":"the name (coupled with --reference-type) to look up in Mux to yield this livestream","required":true}]},"live:disable":{"id":"live:disable","description":"Disables a live stream and prevents encoders from streaming to it.","pluginName":"@mux/cli","pluginType":"core","aliases":[],"flags":{"streamId":{"name":"streamId","type":"option","char":"t","description":"the type of the provided reference name","options":["stream-id"],"default":"stream-id"}},"args":[{"name":"streamName","description":"the name (coupled with --reference-type) to look up in Mux to yield this livestream","required":true}]},"live:enable":{"id":"live:enable","description":"Enables a live stream, allowing encoders to streaming to it.","pluginName":"@mux/cli","pluginType":"core","aliases":[],"flags":{"streamId":{"name":"streamId","type":"option","char":"t","description":"the type of the provided reference name","options":["stream-id"],"default":"stream-id"}},"args":[{"name":"streamName","description":"the name (coupled with --reference-type) to look up in Mux to yield this livestream","required":true}]}}}
+{"version":"0.8.0","commands":{"init":{"id":"init","description":"set up a user-level config","pluginName":"@mux/cli","pluginType":"core","aliases":[],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"Will initialize a new file even if one already exists.","allowNo":false}},"args":[{"name":"envFile","description":"path to a Mux access token .env file","required":false}]},"sign":{"id":"sign","description":"Creates a new signed URL token for a playback ID","pluginName":"@mux/cli","pluginType":"core","aliases":[],"flags":{"expiresIn":{"name":"expiresIn","type":"option","char":"e","description":"How long the signature is valid for. If no unit is specified, milliseconds is assumed.","default":"7d"},"type":{"name":"type","type":"option","char":"t","description":"What type of token this signature is for.","options":["video","thumbnail","gif","storyboard"],"default":"video"},"raw":{"name":"raw","type":"boolean","char":"r","description":"If set, emits only the URL+JWT. Defaults to true for non-TTY.","allowNo":false}},"args":[{"name":"playback-id","description":"Playback ID to create a signed URL token for.","required":true}]},"assets:create":{"id":"assets:create","description":"Create a new asset in Mux using a file that's already available online","pluginName":"@mux/cli","pluginType":"core","aliases":[],"flags":{"private":{"name":"private","type":"boolean","char":"p","description":"add a private playback policy to the created asset","allowNo":false}},"args":[{"name":"input","description":"input URL for the file you'd like to create this asset from","required":true}]},"assets:upload":{"id":"assets:upload","description":"Create a new asset in Mux via a local file","pluginName":"@mux/cli","pluginType":"core","aliases":[],"flags":{"private":{"name":"private","type":"boolean","char":"p","allowNo":false},"filter":{"name":"filter","type":"option","char":"f","description":"regex that filters the selected destination if the provided path is a folder"},"concurrent":{"name":"concurrent","type":"option","char":"c","description":"max number of files to upload at once","default":3}},"args":[{"name":"path","description":"local path for the file (or folder) you'd like to upload","required":true}]},"live:complete":{"id":"live:complete","description":"Signal to Mux that a live stream has concluded and should be closed.","pluginName":"@mux/cli","pluginType":"core","aliases":[],"flags":{"streamId":{"name":"streamId","type":"option","char":"t","description":"the type of the provided reference name","options":["stream-id"],"default":"stream-id"},"disableAfterCompletion":{"name":"disableAfterCompletion","type":"boolean","char":"d","description":"If set, disables the stream upon completion.","allowNo":false}},"args":[{"name":"streamName","description":"the name (coupled with --reference-type) to look up in Mux to yield this livestream","required":true}]},"live:disable":{"id":"live:disable","description":"Disables a live stream and prevents encoders from streaming to it.","pluginName":"@mux/cli","pluginType":"core","aliases":[],"flags":{"streamId":{"name":"streamId","type":"option","char":"t","description":"the type of the provided reference name","options":["stream-id"],"default":"stream-id"}},"args":[{"name":"streamName","description":"the name (coupled with --reference-type) to look up in Mux to yield this livestream","required":true}]},"live:enable":{"id":"live:enable","description":"Enables a live stream, allowing encoders to streaming to it.","pluginName":"@mux/cli","pluginType":"core","aliases":[],"flags":{"streamId":{"name":"streamId","type":"option","char":"t","description":"the type of the provided reference name","options":["stream-id"],"default":"stream-id"}},"args":[{"name":"streamName","description":"the name (coupled with --reference-type) to look up in Mux to yield this livestream","required":true}]},"spaces:sign":{"id":"spaces:sign","description":"Creates a new signed token for a Mux Space","pluginName":"@mux/cli","pluginType":"core","aliases":[],"flags":{"raw":{"name":"raw","type":"boolean","char":"r","description":"prints a raw JWT to stdout (default if not tty)","allowNo":false},"participantId":{"name":"participantId","type":"option","char":"p","description":"Optional, user-specified participant ID."},"role":{"name":"role","type":"option","char":"R","description":"One of 'publisher' or 'subscriber'.","default":"publisher"},"expiresIn":{"name":"expiresIn","type":"option","char":"e","description":"How long the signature is valid for. If no unit is specified, milliseconds is assumed.","default":"7d"}},"args":[{"name":"space-id","description":"Space ID for which a token shall be generated.","required":true}]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mux/cli",
   "description": "Your friendly neighborhood Mux CLI tool!",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "author": {
     "name": "Mux",
     "email": "devex@mux.com",
@@ -31,6 +31,7 @@
     "dotenv": "^8.2.0",
     "fs-extra": "^10.0.0",
     "inquirer": "^8.2.0",
+    "jsonwebtoken": "^8.5.1",
     "listr": "^0.14.3",
     "request": "^2.88.2",
     "runtypes": "^6.5.0",
@@ -43,6 +44,7 @@
     "@types/chai": "^4.3.0",
     "@types/fs-extra": "^9.0.13",
     "@types/inquirer": "^8.1.3",
+    "@types/jsonwebtoken": "^8.5.8",
     "@types/listr": "^0.14.4",
     "@types/mocha": "^9.1.0",
     "@types/node": "^17.0.12",

package/src/command-bases/base.ts

@@ -1,4 +1,4 @@
-import Mux, { Video as MuxVideo, Data as MuxData } from '@mux/mux-node';
+import Mux, { Video as MuxVideo, Data as MuxData, JWT as MuxJWT } from '@mux/mux-node';
 import Command from '@oclif/command';
 import * as chalk from 'chalk';
 import * as fs from 'fs-extra';
@@ -15,9 +15,9 @@ export default abstract class CommandBase extends Command {
   Mux!: Mux;
   Video!: MuxVideo;
   Data!: MuxData;
-  JWT: any;
+  JWT!: typeof MuxJWT;
 
-  async readConfigV1(): Promise<MuxCliConfigV1 | null> {
+  async readConfigV1(): Promise<MuxCliConfigV1> {
     const configAlreadyExists = await fs.pathExists(this.configFile);
     try {
       const configRaw =
@@ -64,6 +64,7 @@ export default abstract class CommandBase extends Command {
     });
 
     this.Mux = mux;
+    this.MuxConfig = config;
     this.Video = this.Mux.Video;
     this.Data = this.Mux.Data;
     this.JWT = Mux.JWT;

package/src/commands/sign.ts

@@ -1,4 +1,6 @@
 import { flags } from '@oclif/command';
+// this is a load-bearing unused import due to oclif type issues
+import { IOptionFlag, IBooleanFlag } from '@oclif/parser/lib/flags';
 import * as chalk from 'chalk';
 import * as clipboard from 'clipboardy';
 
@@ -15,7 +17,7 @@ export default class Sign extends MuxBase {
     },
   ];
 
-  static flags = {
+  static flags: any = {
     expiresIn: flags.string({
       char: 'e',
       description: 'How long the signature is valid for. If no unit is specified, milliseconds is assumed.',
@@ -26,32 +28,49 @@ export default class Sign extends MuxBase {
       description: 'What type of token this signature is for.',
       default: 'video',
       options: ['video', 'thumbnail', 'gif', 'storyboard'],
-    })
+    }),
+    raw: flags.boolean({
+      char: 'r',
+      description: 'If set, emits only the URL+JWT. Defaults to true for non-TTY.',
+      default: !process.stdin.isTTY,
+    }),
   };
 
   async run() {
-    const { args, flags } = this.parse(Sign);
+    const parsed = this.parse(Sign);
+    const args = parsed.args;
+    const flags = parsed.flags as any;
+
     const playbackId = args['playback-id'];
 
-    const options = { expiration: flags.expiresIn, type: flags.type }
+    const options = {
+      expiration: flags.expiresIn,
+      type: flags.type as any, // TODO: is better checked in SDK, but this is ugly.
+      keyId: this.MuxConfig.signingKeyId,
+      keySecret: this.MuxConfig.signingKeySecret,
+    };
     const key = this.JWT.sign(playbackId, options);
     const url = `https://stream.mux.com/${playbackId}.m3u8?token=${key}`;
 
-    this.log(
-      chalk`
+    if (flags.raw) {
+      console.log(url);
+    } else {
+      this.log(
+        chalk`
 🔑 {bold.underline Your Mux Signed Token}
 {blue ${key}}
 
 🌏 {bold.underline Full URL}
 {green ${url}}
-`
-    );
-
-    try {
-      await clipboard.write(url);
-      this.log(`👉 Copied Full URL to your system clipboard`);
-    } catch {
-      this.error('Unable to copy full url automatically');
+  `
+      );
+
+      try {
+        await clipboard.write(url);
+        this.log(`👉 Copied Full URL to your system clipboard`);
+      } catch {
+        this.error('Unable to copy full url automatically');
+      }
     }
   }
 }

package/src/commands/spaces/sign.ts

@@ -0,0 +1,90 @@
+import { flags } from '@oclif/command';
+// this is a load-bearing unused import due to oclif type issues
+import { IOptionFlag, IBooleanFlag } from '@oclif/parser/lib/flags';
+import * as JWT from 'jsonwebtoken';
+import * as chalk from 'chalk';
+import * as clipboard from 'clipboardy';
+
+import MuxBase from '../../command-bases/base';
+
+export default class SignSpace extends MuxBase {
+  static description = 'Creates a new signed token for a Mux Space';
+
+  static args = [
+    {
+      name: 'space-id',
+      description: 'Space ID for which a token shall be generated.',
+      required: true,
+    },
+  ];
+
+  static flags: any = {
+    raw: flags.boolean({
+      char: 'r',
+      description: "prints a raw JWT to stdout (default if not tty)",
+      default: !process.stdin.isTTY,
+    }),
+    participantId: flags.string({
+      char: 'p',
+      description: 'Optional, user-specified participant ID.',
+    }),
+    role: flags.string({
+      char: 'R',
+      description: 'One of \'publisher\' or \'subscriber\'.',
+      default: 'publisher',
+    }),
+    expiresIn: flags.string({
+      char: 'e',
+      description: 'How long the signature is valid for. If no unit is specified, milliseconds is assumed.',
+      default: '7d',
+    }),
+  };
+
+  async run() {
+    const parsed = this.parse(SignSpace);
+    const args = parsed.args;
+    const flags = parsed.flags as any;
+
+    const signingKeySecret = this.MuxConfig.signingKeySecret;
+    if (!signingKeySecret) {
+      throw new Error("No signing key found. Re-run `mux init` and generate one!");
+    }
+
+    // TODO: replace with mux-node-sdk signing when available
+    const payload = {
+      role: flags.role,
+      participant_id: flags.participantId,
+      kid: this.MuxConfig.signingKeyId,
+    };
+
+    const jwtOptions: JWT.SignOptions = {
+      audience: 'rt',
+      subject: args['space-id'],
+      algorithm: 'RS256',
+      noTimestamp: true,
+      expiresIn: flags.expiresIn,
+    };
+
+    const key = Buffer.from(signingKeySecret, 'base64');
+    const jwt = JWT.sign(payload, key, jwtOptions);
+
+    if (flags.raw) {
+      console.log(jwt);
+    } else {
+
+      this.log(
+        chalk`
+🔑 Your JWT for Mux Spaces
+{cyan ${jwt}}
+        `
+      )
+
+      try {
+        await clipboard.write(jwt);
+        this.log(`👉 Copied your JWT to your system clipboard`);
+      } catch {
+        this.error('Unable to copy JWT automatically');
+      }
+    }
+  }
+}

package/yarn.lock

@@ -899,6 +899,13 @@
     "@types/through" "*"
     rxjs "^7.2.0"
 
+"@types/jsonwebtoken@^8.5.8":
+  version "8.5.8"
+  resolved "https://registry.yarnpkg.com/@types/jsonwebtoken/-/jsonwebtoken-8.5.8.tgz#01b39711eb844777b7af1d1f2b4cf22fda1c0c44"
+  integrity sha512-zm6xBQpFDIDM6o9r6HSgDeIcLy82TKWctCXEPbJJcXb5AKmi5BNNdLXneixK4lplX3PqIVcwLBCGE/kAGnlD4A==
+  dependencies:
+    "@types/node" "*"
+
 "@types/listr@^0.14.4":
   version "0.14.4"
   resolved "https://registry.yarnpkg.com/@types/listr/-/listr-0.14.4.tgz#6ba2a4206615cf80d79d10f9ba9701c303cd57b6"