adding initial websocket support

Author: anultravioletaurora

package-lock.json

@@ -12,6 +12,7 @@ import type { ClientInfo, DeviceInfo } from './models';
 import { getAuthorizationHeader } from './utils';
 import { getSessionApi } from './utils/api/session-api';
 import { getUserApi } from './utils/api/user-api';
+import { WebSocketService } from './websocket';
 
 /** The authorization header field name. */
 export const AUTHORIZATION_HEADER = 'Authorization';
@@ -26,6 +27,7 @@ export class Api {
 	deviceInfo;
 	accessToken;
 	axiosInstance;
+	webSocket;
 
 	constructor(
 		basePath: string,
@@ -40,6 +42,7 @@ export class Api {
 		this.deviceInfo = deviceInfo;
 		this.accessToken = accessToken;
 		this.axiosInstance = axiosInstance;
+		this.webSocket = new WebSocketService(this)
 	}
 
 	get configuration(): Configuration {

src/api.ts

@@ -10,6 +10,16 @@ export const HTTP_PROTOCOL = 'http:';
 /** The https protocol string. */
 export const HTTPS_PROTOCOL = 'https:';
 
+/**
+ * The websocket protocol string
+ */
+export const WS_PROTOCOL = 'ws:';
+
+/**
+ * The secure websocket protocol string
+ */
+export const WSS_PROTOCOL = 'wss:';
+
 /** The default port for the http protocol. */
 export const HTTP_PORT = 80;
 

src/utils/url/constants.ts

@@ -0,0 +1,21 @@
+import { HTTP_PROTOCOL, parseUrl, WS_PROTOCOL, WSS_PROTOCOL } from ".";
+import { Api } from "../../api";
+
+
+/**
+ * 
+ * @param basePath The {@link Api.basePath} to connect to
+ */
+export default function getWebSocketUrl(basePath: string) : URL {
+
+    let protocol;
+
+    const baseUrl = parseUrl(basePath)
+
+    if (baseUrl.protocol.startsWith(HTTP_PROTOCOL)) 
+        protocol = WS_PROTOCOL
+    else 
+        protocol = WSS_PROTOCOL
+
+    return new URL(`${protocol}//${baseUrl.host}`)
+}

src/utils/url/websocket.ts

@@ -0,0 +1,7 @@
+/**
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+export * from "./websocket-service";

src/websocket/index.ts

@@ -0,0 +1,53 @@
+import { Api } from "../api";
+import { SessionsMessage } from "../generated-client";
+import getWebSocketUrl from "../utils/url/websocket";
+
+
+/**
+ * A class used for managing the lifecycle of websocket connections
+ * to Jellyfin
+ */
+export class WebSocketService {
+    
+    private api;
+    private socket : WebSocket | undefined
+
+    constructor(api : Api) {
+        this.api = api
+    }
+
+    private shouldOpenWebSocket(accessToken : string) { 
+
+        const socketClosed = this.socket === undefined || this.socket.readyState === WebSocket.CLOSED
+
+        // TODO: Add validation around accessToken
+        return socketClosed && accessToken.length > 0
+    }
+
+    /**
+     * 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
+     * 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>) {
+
+        if (this.shouldOpenWebSocket(this.api.accessToken)) {
+
+            const webSocketUrl = getWebSocketUrl(this.api.basePath)
+            
+            this.socket = new WebSocket(webSocketUrl)
+        }
+
+        this.socket.onopen = onOpen
+        this.socket.onclose = onClose
+    }
+
+    sendMessage(message: SessionsMessage) {
+        
+    } 
+}