dashcam 0.6.2 → 0.7.0

package/README.md

@@ -18,36 +18,46 @@ Options:
   -h, --help            display help for command
 
 Commands:
-  create [options]      Create a clip(capture/replay) and output the resulting url or markdown. Will launch desktop app for local editing before publishing.
-  record [options]      Start a recording terminal to be included in your dashcam video recording
-  pipe                  Pipe command output to dashcam to be included in recorded video
+  auth <api-key>    Authenticate the dashcam desktop using a team's apiKey
+  create [options]  Create a clip and output the resulting url or markdown. Will launch desktop app for local editing before publishing.
+  record [options]  Start a recording terminal to be included in your dashcam video recording
+  pipe              Pipe command output to dashcam to be included in recorded video
   track [options]  Add a logs config to Dashcam
-  start                 Start capture or start instant replay recording on dashcam
-  help [command]        display help for command
+  start             Start instant replay recording on dashcam
+  help [command]    display help for command
 ```
 
 ## Table of contents
 
-- [CLI](#cli)
-  - [Setup](#setup)
-  - [Record CLI](#record-cli)
-  - [Create a Dash](#create-a-replay)
-  - [Return a rich markdown link](#return-a-rich-markdown-link)
-  - [Set a Dash title](#set-a-replay-title)
-  - [Attach the last 20 CLI commands to the Dash](#attach-the-last-20-cli-commands-to-the-replay)
-  - [Attach a logfile to the replay](#attach-a-logfile-to-the-replay)
-- [Web SDK](#web)
-  - [Setup](#setup)
-  - [HTML Anchor Tag](#html-anchor-tag)
-  - [JS Error Handler](#js-error-handler)
-- [NodeJS SDK](#nodejs-sdk)
-  - [Setup](#setup)
-  - [Create a Dash](#create-a-replay)
-  - [Error Handler](#error-handler)
-- [GitHub CLI](#github-cli)
-  - [Create a GitHub issue with a Dash in the description](#create-a-github-issue-with-a-replay-in-the-description)
-  - [Create a GitHub pull request with a Dash in the description](#create-a-github-pull-request-with-a-replay-in-the-description)
-  - [Append a 30 second Dash to a commit](#append-a-30-second-replay-to-a-commit)
+- [Dashcam CLI](#dashcam-cli)
+- [Manual](#manual)
+  - [Table of contents](#table-of-contents)
+- [Examples](#examples)
+  - [CLI](#cli)
+    - [Setup](#setup)
+    - [Auth](#auth)
+    - [Record CLI](#record-cli)
+    - [Pipe command output into dashcam for recording](#pipe-command-output-into-dashcam-for-recording)
+    - [Create a Replay](#create-a-replay)
+    - [Return a rich markdown link](#return-a-rich-markdown-link)
+    - [Set a replay title](#set-a-replay-title)
+    - [Set a project to publish to](#set-a-project-to-publish-to)
+    - [Attach the last 20 CLI commands to the replay](#attach-the-last-20-cli-commands-to-the-replay)
+    - [Attach a logfile to the replay](#attach-a-logfile-to-the-replay)
+  - [GitHub CLI](#github-cli)
+    - [Create a github issue with a replay in the description](#create-a-github-issue-with-a-replay-in-the-description)
+    - [Create a github pull request with a replay in the description](#create-a-github-pull-request-with-a-replay-in-the-description)
+    - [Append a 30 second replay to a commit](#append-a-30-second-replay-to-a-commit)
+- [Advanced Usage](#advanced-usage)
+  - [Web](#web)
+    - [Setup](#setup-1)
+    - [HTML Anchor Tag](#html-anchor-tag)
+    - [JS Error Handler](#js-error-handler)
+  - [NodeJS SDK](#nodejs-sdk)
+    - [Setup](#setup-2)
+    - [Create a Replay](#create-a-replay-1)
+    - [Error Handler](#error-handler)
+  - [Ideas](#ideas)
 
 # Examples
 
@@ -61,7 +71,15 @@ Also see [the examples folder](https://github.com/replayableio/cli/tree/main/exa
 npm install dashcam -g
 ```
 
-## Record CLI
+### Auth
+
+To authenticate the Dashcam desktop app using a team's Api key, Use the following command
+
+```
+dashcam auth <Api-Key>
+```
+
+### Record CLI
 
 To record the CLI in the Dashcam app, use the following command
 
@@ -91,7 +109,7 @@ To record the output of a command in the Dashcam app (In this example the `ping
 ping 1.1.1.1 | dashcam pipe
 ```
 
-### Create a Replay
+## Create a Replay
 
 ```sh
 $ dashcam
@@ -114,6 +132,12 @@ Watch [Dashcam - New Replay](https://dashcam.io/replay/123?share=xyz) on Dashcam
 $ dashcam -t "My New Title"
 ```
 
+### Set a project to publish to
+
+```sh
+$ dashcam -k wef8we72h23012j
+```
+
 ### Attach the last 20 CLI commands to the replay
 
 ```sh

package/index.js

@@ -22,6 +22,17 @@ program
 
 program.showHelpAfterError();
 
+program
+  .command("auth")
+  .argument("<api-key>", "The team's ApiKey")
+  .description("Authenticate the dashcam desktop using a team's apiKey")
+  .action(async function (apiKey) {
+    await lib
+      .sendApiKey(apiKey)
+      .then(() => process.exit())
+      .catch(() => process.exit(1));
+  });
+
 program
   .command("create", { isDefault: true })
   .description(
@@ -41,6 +52,10 @@ program
     "-p, --publish",
     "Whether to publish the clip instantly after creation or not."
   )
+  .option(
+    "-k, --project [string]",
+    "The project id to which to publish the replay"
+  )
   .action(async function (str, options) {
     try {
       let description = this.opts().description;
@@ -51,11 +66,11 @@ program
       let result = await lib.createClip({
         title: this.opts().title,
         description,
-        private: this.opts().private,
         md: this.opts().md,
         publish: this.opts().publish,
         capture: !this.opts().replay,
         png: this.opts().png,
+        project: this.opts().project,
       });
       console.log(result);
     } catch (e) {

package/lib.js

@@ -12,10 +12,17 @@ const persistantIPC = new ipc.IPC();
 persistantIPC.config.retry = 500;
 persistantIPC.config.silent = true;
 
-const connectToIpc = function () {
+const connectToIpc = function (timeout) {
   return new Promise((resolve, reject) => {
+    let timeoutToClean;
     ipc.connectTo("dashcam");
-    ipc.of.dashcam.on("connect", resolve);
+    ipc.of.dashcam.on("connect", () => {
+      console.log(
+        clc.green("Connected to Dashcam!")
+      );
+      resolve();
+      if (timeoutToClean) clearTimeout(timeoutToClean);
+    });
     ipc.of.dashcam.on("error", (e) => {
       if (e.code === "ENOENT") {
         console.log(
@@ -26,11 +33,28 @@ const connectToIpc = function () {
             "You may need to download and install the app from https://bit.ly/3ipoQLJ"
           )
         );
+        reject();
+      } else {
+        console.log(e);
       }
     });
     ipc.of.dashcam.on("disconnect", function () {
-      console.log("Disconnected from Dashcam");
+      console.log(clc.red("Disconnected from Dashcam"));
+      reject();
     });
+    if (timeout && typeof timeout === "number") {
+      timeoutToClean = setTimeout(() => {
+        console.log(
+          clc.red("Could not connect to Dashcam Desktop App. Is it running?")
+        );
+        console.log(
+          clc.yellow(
+            "You may need to download and install the app from https://bit.ly/3ipoQLJ"
+          )
+        );
+        reject();
+      }, timeout);
+    }
   });
 };
 
@@ -54,17 +78,23 @@ const createClip = async function (options = {}) {
         }
       }
     );
+    
+
+    ipc.of.dashcam.on("error", (e) => {
+      console.log(e);
+    });
 
     setTimeout(() => {
       reject(
         "Dashcam Desktop App did not respond in time. Did you publish a clip?"
       );
-    }, 60000 * 5);
+    }, 60000 * 10);
 
     const replay = {
       title: options.title,
       description: options.description,
       publish: options.publish,
+      project: options.project,
       capture: options.capture,
     };
 
@@ -93,6 +123,25 @@ const startRecording = async function (isCapture = false) {
   });
 };
 
+const sendApiKey = async function (apiKey) {
+  return new Promise(async (resolve, reject) => {
+    await connectToIpc(5000).catch(reject);
+    ipc.of.dashcam.emit("auth", { apiKey });
+    ipc.of.dashcam.on("auth-state", ({success, user}) => {
+      if (success) {
+        console.log(clc.green(`Connected as: ${user?.sub}!`));
+        return resolve();
+      }
+      console.log(clc.red("Could not authenticate using the ApiKey"));
+      reject();
+    });
+    setTimeout(() => {
+      console.log(clc.red("Could not authenticate using the ApiKey"));
+      reject();
+    }, 10000);
+  });
+};
+
 let singleInstance = null;
 class PersistantDashcamIPC {
   #isConnected = false;
@@ -110,9 +159,11 @@ class PersistantDashcamIPC {
         this.onConnected();
     });
     persistantIPC.of.dashcam.on("disconnect", () => {
+      console.log('disconnected')
       this.#isConnected = false;
     });
-    persistantIPC.of.dashcam.on("error", () => {
+    persistantIPC.of.dashcam.on("error", (e) => {
+      console.log(e)
       this.#isConnected = false;
     });
   }
@@ -136,6 +187,7 @@ const addLogsConfig = async (options) => {
 };
 
 module.exports = {
+  sendApiKey,
   createClip,
   addLogsConfig,
   getLogFilePath,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dashcam",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "description": "Fix bugs, close pulls, and update your team with desktop instant replay.",
   "main": "index.js",
   "scripts": {
@@ -23,5 +23,8 @@
   },
   "devDependencies": {
     "husky": "^7.0.0"
+  },
+  "volta": {
+    "node": "16.20.2"
   }
 }