Add deployment to TokenSourceFetch options (#1971)

Author: lukasIO

.changeset/lazy-cougars-behave.md

@@ -0,0 +1,5 @@
+---
+"livekit-client": patch
+---
+
+Add deployment to TokenSourceFetch options

package.json

@@ -66,7 +66,7 @@
   },
   "dependencies": {
     "@livekit/mutex": "1.1.1",
-    "@livekit/protocol": "1.45.8",
+    "@livekit/protocol": "1.46.6",
     "events": "^3.3.0",
     "jose": "^6.1.0",
     "loglevel": "^1.9.2",

pnpm-lock.yaml

@@ -27,29 +27,7 @@ abstract class TokenSourceCached extends TokenSourceConfigurable {
       return false;
     }
 
-    for (const key of Object.keys(this.cachedFetchOptions) as Array<
-      keyof TokenSourceFetchOptions
-    >) {
-      switch (key) {
-        case 'roomName':
-        case 'participantName':
-        case 'participantIdentity':
-        case 'participantMetadata':
-        case 'participantAttributes':
-        case 'agentName':
-        case 'agentMetadata':
-          if (this.cachedFetchOptions[key] !== options[key]) {
-            return false;
-          }
-          break;
-        default:
-          // ref: https://stackoverflow.com/a/58009992
-          const exhaustiveCheckedKey: never = key;
-          throw new Error(`Options key ${exhaustiveCheckedKey} not being checked for equality!`);
-      }
-    }
-
-    return true;
+    return areTokenSourceFetchOptionsEqual(options, this.cachedFetchOptions);
   }
 
   private shouldReturnCachedValueFromFetch(fetchOptions: TokenSourceFetchOptions) {
@@ -191,6 +169,14 @@ class TokenSourceEndpoint extends TokenSourceCached {
           request.roomConfig.agents[0].metadata = options.agentMetadata!;
           break;
 
+        case 'deployment':
+          request.roomConfig = request.roomConfig ?? new RoomConfiguration();
+          if (request.roomConfig.agents.length === 0) {
+            request.roomConfig.agents.push(new RoomAgentDispatch());
+          }
+          request.roomConfig.agents[0].deployment = options.deployment!;
+          break;
+
         default:
           // ref: https://stackoverflow.com/a/58009992
           const exhaustiveCheckedKey: never = key;

src/room/token-source/TokenSource.ts

@@ -63,6 +63,7 @@ export type TokenSourceFetchOptions = {
 
   agentName?: string;
   agentMetadata?: string;
+  deployment?: string;
 };
 
 /** A Configurable TokenSource is a token source that takes a

src/room/token-source/types.ts

@@ -58,6 +58,7 @@ export function areTokenSourceFetchOptionsEqual(
       case 'participantAttributes':
       case 'agentName':
       case 'agentMetadata':
+      case 'deployment':
         if (a[key] !== b[key]) {
           return false;
         }