Expose protobuf TrackSource and map TrackSource claims to string (liv…

…ekit#145)

* Expose protobuf TrackSource and map TrackSource claims to string

* Create heavy-chefs-refuse.md

* Fix implementation and add unit test

.changeset/heavy-chefs-refuse.md

@@ -0,0 +1,5 @@
+---
+"livekit-server-sdk": minor
+---
+
+Expose protobuf TrackSource and map TrackSource claims to string

src/AccessToken.ts

@@ -1,5 +1,5 @@
 import * as jose from 'jose';
-import { ClaimGrants, VideoGrant } from './grants.js';
+import { ClaimGrants, VideoGrant, claimsToJwtPayload } from './grants.js';
 
 // 6 hours
 const defaultTTL = `6h`;
@@ -111,7 +111,8 @@ export class AccessToken {
     // TODO: check for video grant validity
 
     const secret = new TextEncoder().encode(this.apiSecret);
-    const jwt = new jose.SignJWT(this.grants)
+
+    const jwt = new jose.SignJWT(claimsToJwtPayload(this.grants))
       .setProtectedHeader({ alg: 'HS256' })
       .setIssuer(this.apiKey)
       .setExpirationTime(this.ttl)

src/grants.test.ts

@@ -0,0 +1,27 @@
+import { describe, expect, it } from 'vitest';
+import { ClaimGrants, VideoGrant, claimsToJwtPayload } from './grants';
+import { TrackSource } from './proto/livekit_models_pb';
+
+describe('ClaimGrants are parsed correctly', () => {
+  it('parses TrackSource correctly to strings', () => {
+    const grant: VideoGrant = {
+      canPublishSources: [
+        TrackSource.CAMERA,
+        TrackSource.MICROPHONE,
+        TrackSource.SCREEN_SHARE,
+        TrackSource.SCREEN_SHARE_AUDIO,
+      ],
+    };
+
+    const claim: ClaimGrants = { video: grant };
+
+    const jwtPayload = claimsToJwtPayload(claim);
+    expect(jwtPayload.video).toBeTypeOf('object');
+    expect(jwtPayload.video?.canPublishSources).toEqual([
+      'camera',
+      'microphone',
+      'screen_share',
+      'screen_share_audio',
+    ]);
+  });
+});

src/grants.ts

@@ -1,10 +1,30 @@
 import { JWTPayload } from 'jose';
+import { TrackSource } from './proto/livekit_models_pb';
+
+export function trackSourceToString(source: TrackSource) {
+  switch (source) {
+    case TrackSource.CAMERA:
+      return 'camera';
+    case TrackSource.MICROPHONE:
+      return 'microphone';
+    case TrackSource.SCREEN_SHARE:
+      return 'screen_share';
+    case TrackSource.SCREEN_SHARE_AUDIO:
+      return 'screen_share_audio';
+    default:
+      throw new TypeError(`Cannot convert TrackSource ${source} to string`);
+  }
+}
 
-export enum TrackSource {
-  CAMERA = 'camera',
-  MICROPHONE = 'microphone',
-  SCREEN_SHARE = 'screen_share',
-  SCREEN_SHARE_AUDIO = 'screen_share_audio',
+export function claimsToJwtPayload(
+  grant: ClaimGrants,
+): JWTPayload & { video?: Record<string, unknown> } {
+  const claim: Record<string, any> = { ...grant };
+  // eslint-disable-next-line no-restricted-syntax
+  if (Array.isArray(claim.video?.canPublishSources)) {
+    claim.video.canPublishSources = claim.video.canPublishSources.map(trackSourceToString);
+  }
+  return claim;
 }
 
 export interface VideoGrant {

src/index.ts

@@ -45,4 +45,5 @@ export {
   Room,
   TrackInfo,
   TrackType,
+  TrackSource,
 } from './proto/livekit_models_pb.js';