#77: Support Custom WebSocket URL (#78)

* #77: add custom websocket URL to listener config

* #77: build

* #77: bump version in doc

* #77: update jsdoc default value

* 1.0.2

* update README version

Author: mitchwadair

README.md

@@ -23,7 +23,7 @@ npm install tesjs
 ```
 Or in browsers through a CDN
 ```html
-<script src="https://cdn.jsdelivr.net/gh/mitchwadair/tesjs@v1.0.1/dist/tes.min.js"></script>
+<script src="https://cdn.jsdelivr.net/gh/mitchwadair/tesjs@v1.0.2/dist/tes.min.js"></script>
 ```
 
 # Basic Usage
@@ -64,7 +64,7 @@ tes.subscribe("channel.update", { broadcaster_user_id: "1337" })
 # Browser
 TESjs supports WebSocket transport, and can be used in a browser environment
 ```html
-<script src="https://cdn.jsdelivr.net/gh/mitchwadair/tesjs@v1.0.1/dist/tes.min.js"></script>
+<script src="https://cdn.jsdelivr.net/gh/mitchwadair/tesjs@v1.0.2/dist/tes.min.js"></script>
 <script>
     const config = {
         identity: {

dist/tes.min.js

@@ -8,7 +8,7 @@ npm install tesjs
 ```
 Or in browsers through a CDN
 ```html
-<script src="https://cdn.jsdelivr.net/gh/mitchwadair/tesjs@v1.0.1/dist/tes.min.js"></script>
+<script src="https://cdn.jsdelivr.net/gh/mitchwadair/tesjs@v1.0.2/dist/tes.min.js"></script>
 ```
 
 # Quick Links

dist/tes.min.js.map

@@ -347,6 +347,7 @@ Listener configuration
 | --- | --- | --- | --- |
 | type | <code>&quot;webhook&quot;</code> \| <code>&quot;websocket&quot;</code> |  | The type of transport to use |
 | [baseURL] | <code>string</code> |  | Required for `webhook` transport. The base URL where your app is     hosted. See [Twitch doc](https://dev.twitch.tv/docs/eventsub) for details on local development |
+| [websocketURL] | <code>string</code> | <code>&quot;wss://eventsub.wss.twitch.tv/ws&quot;</code> | A custom websocket URL to use for `websocket` transport. Useful for     local testing with [Twitch CLI](https://dev.twitch.tv/docs/cli/) |
 | [secret] | <code>string</code> |  | Required for `webhook` transport. The secret to use for your `webhook`     subscriptions. Should be different from your client secret |
 | [server] | <code>Express</code> |  | The Express app object. Use if integrating with an existing Express app |
 | [port] | <code>number</code> | <code>process.env.PORT,8080</code> | A custom port to use |

doc/README.md

@@ -62,6 +62,8 @@ const SUBS_API_URL = "https://api.twitch.tv/helix/eventsub/subscriptions";
  * @param {"webhook"|"websocket"} type The type of transport to use
  * @param {string} [baseURL] Required for `webhook` transport. The base URL where your app is
  *     hosted. See [Twitch doc](https://dev.twitch.tv/docs/eventsub) for details on local development
+ * @param {string} [websocketURL=wss://eventsub.wss.twitch.tv/ws] A custom websocket URL to use for `websocket` transport. Useful for
+ *     local testing with [Twitch CLI](https://dev.twitch.tv/docs/cli/)
  * @param {string} [secret] Required for `webhook` transport. The secret to use for your `webhook`
  *     subscriptions. Should be different from your client secret
  * @param {Express} [server] The Express app object. Use if integrating with an existing Express app
@@ -123,7 +125,16 @@ class TES {
 
         const {
             identity: { id, secret, onAuthenticationFailure, accessToken, refreshToken },
-            listener: { type, baseURL, secret: whSecret, port, ignoreDuplicateMessages, ignoreOldMessages, server },
+            listener: {
+                type,
+                baseURL,
+                secret: whSecret,
+                port,
+                ignoreDuplicateMessages,
+                ignoreOldMessages,
+                server,
+                websocketURL,
+            },
         } = config;
 
         if (!type || (type !== "webhook" && type !== "websocket")) {
@@ -161,7 +172,7 @@ class TES {
             this.whserver = whserver(server, whSecret, serverConfig);
             this._whserverlistener = server ? null : this.whserver.listen(this.port);
         } else {
-            this.wsclient = new WebSocketClient();
+            this.wsclient = new WebSocketClient(websocketURL);
         }
 
         config.options = config.options || {};

doc/tesjs.md

@@ -12,12 +12,14 @@ const { objectShallowEquals } = require("./utils");
 const WS_URL = "wss://eventsub.wss.twitch.tv/ws";
 
 class WebSocketClient {
-    constructor() {
+    constructor(wsURL) {
         // singleton
         if (WebSocketClient._instance) return WebSocketClient._instance;
         WebSocketClient._instance = this;
 
         this._connections = {};
+
+        this._wsURL = wsURL || WS_URL;
     }
 
     /**
@@ -83,7 +85,7 @@ class WebSocketClient {
         }
     }
 
-    _addConnection(onWelcome, url = WS_URL) {
+    _addConnection(onWelcome, url = this._wsURL) {
         const ws = new WebSocket(url);
         ws.onmessage = (event) => {
             const {

lib/tes.js

@@ -1,6 +1,6 @@
 {
   "name": "tesjs",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A module to streamline the use of Twitch EventSub in Node.js and Web applications",
   "repository": {
     "type": "git",