Add event parameters, incorporate api_key parameter

Add an optional event parameter to the onClose and onOpen callbacks

Incorporates the api_key as a searchParam in the websocket URL

Author: anultravioletaurora

src/utils/url/websocket.ts

@@ -4,18 +4,19 @@ import { Api } from "../../api";
 
 /**
  * 
- * @param basePath The {@link Api.basePath} to connect to
+ * @param param0 The authenticated {@link Api} instance
  */
-export default function getWebSocketUrl(basePath: string) : URL {
+export default function getWebSocketUrl({ accessToken, basePath } : Api) : URL {
 
     let protocol;
 
     const baseUrl = parseUrl(basePath)
 
-    if (baseUrl.protocol.startsWith(HTTP_PROTOCOL)) 
-        protocol = WS_PROTOCOL
-    else 
-        protocol = WSS_PROTOCOL
+    if (baseUrl.protocol.startsWith(HTTP_PROTOCOL)) protocol = WS_PROTOCOL
+    else protocol = WSS_PROTOCOL
 
-    return new URL(`${protocol}//${baseUrl.host}`)
+    let url = new URL(`${protocol}//${baseUrl.host}/socket`)
+    url.searchParams.append("api_key", accessToken)
+
+    return url
 }

src/websocket/websocket-service.ts

@@ -28,17 +28,20 @@ export class WebSocketService {
      * Ensures a websocket connection to the server is active by establishing a new connection
      * if a connection doesn't already exist or the previous connection is closed.
      * 
-     * Depends on the {@link Api.basePath} and {@link Api.accessToken} being valid and
+     * Depends on the {@link Api.accessToken} being valid and
      * populated.
      * 
      * @param onOpen An optional callback to run when the socket is opened
      * @param onClose An optional callback to run when the socket is closed
      */
-    ensureWebSocket(onOpen?: () => Promise<void>, onClose?: () => Promise<void>) {
+    ensureWebSocket(
+        onOpen?: (e?: Event) => Promise<void>, 
+        onClose?: (e?: CloseEvent) => Promise<void>
+    ) {
 
         if (this.shouldOpenWebSocket(this.api.accessToken)) {
 
-            const webSocketUrl = getWebSocketUrl(this.api.basePath)
+            const webSocketUrl = getWebSocketUrl(this.api)
 
             this.socket = new WebSocket(webSocketUrl)
         }
@@ -48,6 +51,6 @@ export class WebSocketService {
     }
 
     sendMessage(message: SessionsMessage) {
-        
+        this.socket.send(JSON.stringify(message))
     } 
 }