Expose kind and attributes in AccessToken

packages/livekit-server-sdk/src/AccessToken.test.ts

@@ -4,7 +4,7 @@
 import * as jose from 'jose';
 import { describe, expect, it } from 'vitest';
 import { AccessToken, TokenVerifier } from './AccessToken';
-import { ClaimGrants } from './grants';
+import type { ClaimGrants } from './grants';
 
 const testApiKey = 'abcdefg';
 const testSecret = 'abababa';
@@ -63,14 +63,18 @@ describe('verify token is valid', () => {
   it('can decode encoded token', async () => {
     const t = new AccessToken(testApiKey, testSecret);
     t.sha256 = 'abcdefg';
+    t.kind = 'agent';
     t.addGrant({ roomCreate: true });
+    t.attributes = { foo: 'bar', live: 'kit' };
 
     const v = new TokenVerifier(testApiKey, testSecret);
     const decoded = await v.verify(await t.toJwt());
 
     expect(decoded).not.toBe(undefined);
     expect(decoded.sha256).toEqual('abcdefg');
     expect(decoded.video?.roomCreate).toBeTruthy();
+    expect(decoded.kind).toEqual('agent');
+    expect(decoded.attributes).toEqual(t.attributes);
   });
 });
 

packages/livekit-server-sdk/src/AccessToken.ts

@@ -2,7 +2,8 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 import * as jose from 'jose';
-import { ClaimGrants, VideoGrant, claimsToJwtPayload } from './grants.js';
+import type { ClaimGrants, VideoGrant } from './grants.js';
+import { claimsToJwtPayload } from './grants.js';
 
 // 6 hours
 const defaultTTL = `6h`;
@@ -44,8 +45,8 @@
 
   /**
    * Creates a new AccessToken
    * @param apiKey API Key, can be set in env LIVEKIT_API_KEY
    * @param apiSecret Secret, can be set in env LIVEKIT_API_SECRET
    */
   constructor(apiKey?: string, apiSecret?: string, options?: AccessTokenOptions) {
     if (!apiKey) {
@@ -82,21 +83,45 @@
 
   /**
    * Adds a video grant to this token.
-   * @param grant
+   * @param grant -
    */
   addGrant(grant: VideoGrant) {
     this.grants.video = { ...(this.grants.video ?? {}), ...grant };
   }
 
+  get name(): string | undefined {
+    return this.grants.name;
+  }
+
+  set name(name: string) {
+    this.grants.name = name;
+  }
+
+  get metadata(): string | undefined {
+    return this.grants.metadata;
+  }
+
   /**
    * Set metadata to be passed to the Participant, used only when joining the room
    */
   set metadata(md: string) {
     this.grants.metadata = md;
   }
 
-  set name(name: string) {
-    this.grants.name = name;
+  get attributes(): Record<string, string> | undefined {
+    return this.grants.attributes;
+  }
+
+  set attributes(attrs: Record<string, string>) {
+    this.grants.attributes = attrs;
+  }
+
+  get kind(): string | undefined {
+    return this.grants.kind;
+  }
+
+  set kind(kind: string) {
+    this.grants.kind = kind;
   }
 
   get sha256(): string | undefined {

packages/livekit-server-sdk/src/grants.ts

@@ -2,7 +2,7 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 import { TrackSource } from '@livekit/protocol';
-import { JWTPayload } from 'jose';
+import type { JWTPayload } from 'jose';
 
 export function trackSourceToString(source: TrackSource) {
   switch (source) {
@@ -83,14 +83,16 @@ export interface VideoGrant {
   /** participant is recording the room, when set, allows room to indicate it's being recorded */
   recorder?: boolean;
 
-  /** participant acts as a server side participant/bot/agent */
+  /** participant allowed to connect to LiveKit as Agent Framework worker */
   agent?: boolean;
 }
 
 /** @internal */
 export interface ClaimGrants extends JWTPayload {
   name?: string;
   video?: VideoGrant;
+  kind?: string;
   metadata?: string;
+  attributes?: Record<string, string>;
   sha256?: string;
 }