dashcam 0.2.1

package/README.md

@@ -0,0 +1,160 @@
+<img src="https://user-images.githubusercontent.com/318295/204898620-922afee0-5415-46a9-a84f-ae6237001bf0.png" height="50" alt="Replayable"/>
+
+# CLI + SDK
+
+Why double-back when you can capture it the first time? Playback and share exactly what happened with Replayable's desktop replay buffer.
+
+This package allows you to control the Replayable desktop application from the CLI or SDK.
+
+You can easily embed desktop replays within git commits, pull requests, bug reports, jira tickets, and even within log files.
+
+Desktop replays are a great way to share context behind problems and document the application state within logs, tickets and more.
+
+<a href="https://www.loom.com/share/ea9c2831013a4b5eb996bd47f8178f4e">
+  <p>Capture bugs with replayable. - Watch Video</p>
+  <img style="max-width:300px;" src="https://cdn.loom.com/sessions/thumbnails/ea9c2831013a4b5eb996bd47f8178f4e-with-play.gif">
+</a>
+
+## Quick Setup
+
+### Install Replayable Desktop
+
+First, [install Replayable Desktop](https://replayable.io/?betacode=CLIENTRY). Replayable Desktop runs in the background giving you access to a buffer of video.
+
+### Install this package
+
+```sh
+npm install replayable -g
+```
+
+# Table of contents
+
+- [CLI + SDK](#cli--sdk)
+  - [Quick Setup](#quick-setup)
+- [Examples](#examples)
+  - [CLI](#cli)
+  - [GitHub CLI](#github-cli)
+  - [NodeJS SDK](#nodejs-sdk)
+  - [Javascript Integration](#javascript-integration)
+- [Advanced Usage](#advanced-usage)
+
+# Examples
+
+Also see the examples folder.
+
+## CLI
+
+### Create a Replay
+
+```sh
+$ replayable
+https://replayable.io/replay/123?share=xyz
+```
+
+### Return a rich markdown link
+
+```sh
+$ replayable --md
+
+[![Replayable - New Replay](https://replayable-api-production.herokuapp.com/replay/123/gif?shareKey=xyz)](https://replayable.io/replay/123?share=xyz)
+
+Watch [Replayable - New Replay](https://replayable.io/replay/123?share=xyz) on Replayable
+```
+
+### Set a replay title
+
+```sh
+$ replayable -t "My New Title"
+```
+
+### Attach the last 20 CLI commands to the replay
+
+```sh
+$ history -20 | replayable
+```
+
+### Attach a logfile to the replay
+
+This will attach the mac system log to the replay.
+
+```sh
+$ cat /var/log/system.log | replayable
+```
+
+## GitHub CLI
+
+The following examples depend on having the [GitHub CLI](https://cli.github.com/) installed.
+
+### Create a github issue with a replay in the description
+
+```sh
+$ gh issue create -w -t "Title" -b "`replayable --md`"
+```
+
+This is where it gets really cool. For example, this single command will create a GitHub issue with a video replay and the mac system logs.
+
+```
+gh issue create -w -t "Title" -b "`cat /var/log/system.log | replayable --md`"
+```
+
+### Create a github pull request with a replay in the description
+
+```sh
+$ gh pr create -w -t "Title" -b "`replayable --md`"
+```
+
+### Append a 30 second replay to a commit
+
+```sh
+$ git commit -am "`replayable`"
+```
+
+## NodeJS SDK
+
+```js
+const replayable = require("replayable");
+
+process.on("uncaughtException", async (err) => {
+  let replay = await replayable.createReplay({
+    title: "uncaughtException",
+    description: err,
+  });
+  console.log("Replayable", replay);
+});
+
+setTimeout(() => {
+  throw new Error("Throw makes it go boom!");
+}, 3000);
+```
+
+## Javascript Integration
+
+Note that this example does not require any library to be installed as the app exposes the protocol natively.
+
+```js
+window.onerror = function myErrorHandler() {
+  window.open("replayable://replay/create", "_blank");
+};
+
+setTimeout(() => {
+  throw new Error("Throw makes it go boom!");
+}, 3000);
+```
+
+# Advanced Usage
+
+```
+Usage: replayable create [options]
+
+Create a replay and output the resulting url or markdown. Will launch desktop app for local editing before publishing.
+
+Options:
+  -t, --title <string>      Title of the replay. Automatically generated if not supplied.
+  -d, --description [text]  Replay markdown body. This may also be piped in: `cat README.md | replayable create`
+  --md                      Returns code for a rich markdown image link.
+  -h, --help                display help for command
+```
+
+## Ideas
+
+It would be possible to string this along in [a git hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) to publish with every commit.

package/examples/crash-test.js

@@ -0,0 +1,11 @@
+const replayable = require("./index");
+
+process.on("uncaughtException", async (err) => {
+  console.error(err);
+  let replay = await replayable.createReplay();
+  console.log("Replayable", replay);
+});
+
+setTimeout(() => {
+  throw new Error("Throw makes it go boom!");
+}, 3000);

package/examples/github-issue.sh

@@ -0,0 +1 @@
+gh issue create -w -t "Title" -b "`replayable --md`"

package/examples/protocol.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <title></title>
+</head>
+<body>
+  <a href="replayable://replay/create" target="_blank">Create Replay</a>
+  <a href="#" onClick="causeError()">Throw an Error</a>
+  <script>
+    window.onerror = function myErrorHandler(errorMsg, url, lineNumber) {
+      console.log('onError', errorMsg)
+      window.location= "replayable://replay/create";
+    }
+
+    causeError = () => {
+      throw new Error("Throw makes it go boom!");
+    }
+    
+  </script>
+</body>
+</html>

package/index.js

@@ -0,0 +1,70 @@
+#!/usr/bin/env node
+
+const lib = require("./lib");
+const { program } = require("commander");
+
+let stdin = "";
+
+program
+  .name("replayable")
+  .description(
+    "Upgrade your bug reports, pulls, and readmes with clips from local development"
+  )
+  .version("0.0.9");
+
+program.showHelpAfterError();
+
+program
+  .command("create", { isDefault: true })
+  .description(
+    "Create a replay and output the resulting url or markdown. Will launch desktop app for local editing before publishing."
+  )
+  .option(
+    "-t, --title <string>",
+    "Title of the replay. Automatically generated if not supplied."
+  )
+  .option(
+    "-d, --description [text]",
+    "Replay markdown body. This may also be piped in: `cat README.md | replayable create`"
+  )
+  .option("--md", "Returns code for a rich markdown image link.")
+  .action(async function (str, options) {
+    try {
+      let description = this.opts().description;
+      if (stdin) {
+        description = stdin;
+      }
+
+      let result = await lib.createReplay({
+        title: this.opts().title,
+        description,
+        private: this.opts().private,
+        md: this.opts().md,
+        png: this.opts().png,
+      });
+      console.log(result);
+    } catch (e) {
+      console.log("Error: ", e);
+    }
+    process.exit(0);
+  });
+
+if (process.stdin.isTTY) {
+  program.parse(process.argv);
+} else {
+  process.stdin.on("error", function () {});
+  process.stdin.on("readable", function () {
+    var chunk = this.read();
+
+    if (chunk !== null) {
+      stdin += chunk;
+    }
+  });
+  process.stdin.on("end", function () {
+    program.parse(process.argv);
+  });
+}
+
+if (module.parent) {
+  module.exports = lib;
+}

package/lib.js

@@ -0,0 +1,64 @@
+const ipc = require("node-ipc").default;
+const clc = require("cli-color");
+
+ipc.config.id = "replayable-cli";
+ipc.config.retry = 1500;
+ipc.config.silent = true;
+ipc.config.maxRetries = 0;
+
+const connectToIpc = function () {
+  return new Promise((resolve, reject) => {
+    ipc.connectTo("replayable");
+    ipc.of.replayable.on("connect", resolve);
+    ipc.of.replayable.on("error", (e) => {
+      if (e.code === "ENOENT") {
+        console.log(
+          clc.red("Could not connect to Replayable Desktop App. Is it running?")
+        );
+        console.log(
+          clc.yellow(
+            "You may need to download and install the app from https://bit.ly/3ipoQLJ"
+          )
+        );
+      }
+    });
+    ipc.of.replayable.on("disconnect", function () {
+      console.log("Disconnected from Replayable");
+    });
+  });
+};
+
+const createReplay = async function (options = {}) {
+  options.md = options.md || false;
+
+  options.title = options.title || false;
+  options.description = options.description || null;
+
+  await connectToIpc();
+
+  return new Promise(async (resolve, reject) => {
+    ipc.of.replayable.on(
+      "upload", //any event or message type your server listens for
+      function (data) {
+        if (options.md) {
+          resolve(data.replay.markdown);
+        } else {
+          resolve(data.replay.shareLink);
+        }
+      }
+    );
+
+    setTimeout(() => {
+      reject(
+        "Replayable Desktop App did not respond in time. Did you publish a replay?"
+      );
+    }, 60000 * 5);
+
+    ipc.of.replayable.emit("create", {
+      title: options.title,
+      description: options.description,
+    });
+  });
+};
+
+module.exports = { createReplay };

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "dashcam",
+  "version": "0.2.1",
+  "description": "Fix bugs, close pulls, and update your team with desktop instant replay.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepare": "husky install"
+  },
+  "bin": {
+    "replayable": "index.js"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "cli-color": "^2.0.3",
+    "commander": "^9.4.0",
+    "husky": "^7.0.4",
+    "node-ipc": "^10.1.0",
+    "yargs": "^17.3.1"
+  },
+  "devDependencies": {
+    "husky": "^7.0.0"
+  }
+}