livekit-server-sdk 2.0.2 → 2.0.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # livekit-server-sdk
 
+## 2.0.4
+
+### Patch Changes
+
+- Add agent field to VideoGrant - [#141](https://github.com/livekit/server-sdk-js/pull/141) ([@lukasIO](https://github.com/lukasIO))
+
+## 2.0.3
+
+### Patch Changes
+
+- Export types needed for Egress - [#137](https://github.com/livekit/server-sdk-js/pull/137) ([@davidzhao](https://github.com/davidzhao))
+
 ## 2.0.2
 
 ### Patch Changes

package/README.md

@@ -17,6 +17,8 @@
 
 ## Migrate from v1.x to v2.x
 
+### Token generation
+
 Because the `jsonwebtoken` lib got replaced with `jose`, there are a couple of APIs that are now async, that weren't before:
 
 ```typescript
@@ -46,6 +48,47 @@ app.post('/webhook-endpoint', async (req, res) => {
 });
 ```
 
+### Egress API
+
+Egress request types have been updated from interfaces to classes in the latest version. Additionally, `oneof` fields now require an explicit `case` field to specify the value type.
+
+For example, to create a RoomComposite Egress:
+
+```typescript
+// v1
+// const fileOutput = {
+//   fileType: EncodedFileType.MP4,
+//   filepath: 'livekit-demo/room-composite-test.mp4',
+//   s3: {
+//     accessKey: 'aws-access-key',
+//     secret: 'aws-access-secret',
+//     region: 'aws-region',
+//     bucket: 'my-bucket',
+//   },
+// };
+
+// const info = await egressClient.startRoomCompositeEgress('my-room', {
+//   file: fileOutput,
+// });
+
+// v2 - current
+const fileOutput = new EncodedFileOutput({
+  filepath: 'dz/davids-room-test.mp4',
+  output: {
+    case: 's3',
+    value: new S3Upload({
+      accessKey: 'aws-access-key',
+      secret: 'aws-access-secret',
+      bucket: 'my-bucket',
+    }),
+  },
+});
+
+const info = await egressClient.startRoomCompositeEgress('my-room', {
+  file: fileOutput,
+});
+```
+
 ## Installation
 
 ### Pnpm

package/dist/grants.d.ts

@@ -44,6 +44,8 @@ export interface VideoGrant {
     hidden?: boolean;
     /** 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 */
+    agent?: boolean;
 }
 /** @internal */
 export interface ClaimGrants extends JWTPayload {

package/dist/index.d.ts

@@ -4,6 +4,6 @@ export * from './IngressClient.js';
 export * from './RoomServiceClient.js';
 export * from './WebhookReceiver.js';
 export * from './grants.js';
-export { DirectFileOutput, EgressInfo, EncodedFileOutput, EncodedFileType, EncodingOptions, EncodingOptionsPreset, SegmentedFileOutput, SegmentedFileProtocol, StreamOutput, StreamProtocol, } from './proto/livekit_egress_pb.js';
+export { AliOSSUpload, AzureBlobUpload, DirectFileOutput, EgressInfo, EncodedFileOutput, EncodedFileType, EncodingOptions, EncodingOptionsPreset, GCPUpload, ParticipantEgressRequest, RoomCompositeEgressRequest, S3Upload, SegmentedFileOutput, SegmentedFileProtocol, StreamOutput, StreamProtocol, TrackCompositeEgressRequest, TrackEgressRequest, WebEgressRequest, } from './proto/livekit_egress_pb.js';
 export { IngressAudioEncodingOptions, IngressAudioEncodingPreset, IngressAudioOptions, IngressInfo, IngressInput, IngressState, IngressVideoEncodingOptions, IngressVideoEncodingPreset, IngressVideoOptions, } from './proto/livekit_ingress_pb.js';
 export { DataPacket_Kind, ParticipantInfo, ParticipantInfo_State, ParticipantPermission, Room, TrackInfo, TrackType, } from './proto/livekit_models_pb.js';

package/dist/index.js

@@ -4,7 +4,7 @@ export * from './IngressClient.js';
 export * from './RoomServiceClient.js';
 export * from './WebhookReceiver.js';
 export * from './grants.js';
-export { DirectFileOutput, EgressInfo, EncodedFileOutput, EncodedFileType, EncodingOptions, EncodingOptionsPreset, SegmentedFileOutput, SegmentedFileProtocol, StreamOutput, StreamProtocol, } from './proto/livekit_egress_pb.js';
+export { AliOSSUpload, AzureBlobUpload, DirectFileOutput, EgressInfo, EncodedFileOutput, EncodedFileType, EncodingOptions, EncodingOptionsPreset, GCPUpload, ParticipantEgressRequest, RoomCompositeEgressRequest, S3Upload, SegmentedFileOutput, SegmentedFileProtocol, StreamOutput, StreamProtocol, TrackCompositeEgressRequest, TrackEgressRequest, WebEgressRequest, } from './proto/livekit_egress_pb.js';
 export { IngressAudioEncodingOptions, IngressAudioEncodingPreset, IngressAudioOptions, IngressInfo, IngressInput, IngressState, IngressVideoEncodingOptions, IngressVideoEncodingPreset, IngressVideoOptions, } from './proto/livekit_ingress_pb.js';
 export { DataPacket_Kind, ParticipantInfo, ParticipantInfo_State, ParticipantPermission, Room, TrackInfo, TrackType, } from './proto/livekit_models_pb.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,OAAO,EACL,gBAAgB,EAChB,UAAU,EACV,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,EACrB,YAAY,EACZ,cAAc,GACf,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,2BAA2B,EAC3B,0BAA0B,EAC1B,mBAAmB,EACnB,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,2BAA2B,EAC3B,0BAA0B,EAC1B,mBAAmB,GACpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,eAAe,EACf,eAAe,EACf,qBAAqB,EACrB,qBAAqB,EACrB,IAAI,EACJ,SAAS,EACT,SAAS,GACV,MAAM,8BAA8B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,OAAO,EACL,YAAY,EACZ,eAAe,EACf,gBAAgB,EAChB,UAAU,EACV,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,qBAAqB,EACrB,SAAS,EACT,wBAAwB,EACxB,0BAA0B,EAC1B,QAAQ,EACR,mBAAmB,EACnB,qBAAqB,EACrB,YAAY,EACZ,cAAc,EACd,2BAA2B,EAC3B,kBAAkB,EAClB,gBAAgB,GACjB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,2BAA2B,EAC3B,0BAA0B,EAC1B,mBAAmB,EACnB,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,2BAA2B,EAC3B,0BAA0B,EAC1B,mBAAmB,GACpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,eAAe,EACf,eAAe,EACf,qBAAqB,EACrB,qBAAqB,EACrB,IAAI,EACJ,SAAS,EACT,SAAS,GACV,MAAM,8BAA8B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "livekit-server-sdk",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "Server-side SDK for LiveKit",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",