livekit-server-sdk 1.1.3 → 1.2.0

package/dist/RoomServiceClient.js

@@ -0,0 +1,189 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RoomServiceClient = void 0;
+const livekit_models_1 = require("./proto/livekit_models");
+const livekit_room_1 = require("./proto/livekit_room");
+const ServiceBase_1 = __importDefault(require("./ServiceBase"));
+const TwirpRPC_1 = require("./TwirpRPC");
+const svc = 'RoomService';
+/**
+ * Client to access Room APIs
+ */
+class RoomServiceClient extends ServiceBase_1.default {
+    /**
+     *
+     * @param host hostname including protocol. i.e. 'https://cluster.livekit.io'
+     * @param apiKey API Key, can be set in env var LIVEKIT_API_KEY
+     * @param secret API Secret, can be set in env var LIVEKIT_API_SECRET
+     */
+    constructor(host, apiKey, secret) {
+        super(apiKey, secret);
+        this.rpc = new TwirpRPC_1.TwirpRpc(host, TwirpRPC_1.livekitPackage);
+    }
+    /**
+     * Creates a new room. Explicit room creation is not required, since rooms will
+     * be automatically created when the first participant joins. This method can be
+     * used to customize room settings.
+     * @param options
+     */
+    createRoom(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = yield this.rpc.request(svc, 'CreateRoom', livekit_room_1.CreateRoomRequest.toJSON(livekit_room_1.CreateRoomRequest.fromPartial(options)), this.authHeader({ roomCreate: true }));
+            return livekit_models_1.Room.fromJSON(data);
+        });
+    }
+    /**
+     * List active rooms
+     * @param names when undefined or empty, list all rooms.
+     *              otherwise returns rooms with matching names
+     * @returns
+     */
+    listRooms(names) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = yield this.rpc.request(svc, 'ListRooms', livekit_room_1.ListRoomsRequest.toJSON({ names: names !== null && names !== void 0 ? names : [] }), this.authHeader({ roomList: true }));
+            const res = livekit_room_1.ListRoomsResponse.fromJSON(data);
+            return (_a = res.rooms) !== null && _a !== void 0 ? _a : [];
+        });
+    }
+    deleteRoom(room) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.rpc.request(svc, 'DeleteRoom', livekit_room_1.DeleteRoomRequest.toJSON({ room }), this.authHeader({ roomCreate: true }));
+        });
+    }
+    /**
+     * Update metadata of a room
+     * @param room name of the room
+     * @param metadata the new metadata for the room
+     */
+    updateRoomMetadata(room, metadata) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = yield this.rpc.request(svc, 'UpdateRoomMetadata', livekit_room_1.UpdateRoomMetadataRequest.toJSON({ room, metadata }), this.authHeader({ roomAdmin: true, room }));
+            return livekit_models_1.Room.fromJSON(data);
+        });
+    }
+    /**
+     * List participants in a room
+     * @param room name of the room
+     */
+    listParticipants(room) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = yield this.rpc.request(svc, 'ListParticipants', livekit_room_1.ListParticipantsRequest.toJSON({ room }), this.authHeader({ roomAdmin: true, room }));
+            const res = livekit_room_1.ListParticipantsResponse.fromJSON(data);
+            return (_a = res.participants) !== null && _a !== void 0 ? _a : [];
+        });
+    }
+    /**
+     * Get information on a specific participant, including the tracks that participant
+     * has published
+     * @param room name of the room
+     * @param identity identity of the participant to return
+     */
+    getParticipant(room, identity) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = yield this.rpc.request(svc, 'GetParticipant', livekit_room_1.RoomParticipantIdentity.toJSON({ room, identity }), this.authHeader({ roomAdmin: true, room }));
+            return livekit_models_1.ParticipantInfo.fromJSON(data);
+        });
+    }
+    /**
+     * Removes a participant in the room. This will disconnect the participant
+     * and will emit a Disconnected event for that participant.
+     * Even after being removed, the participant can still re-join the room.
+     * @param room
+     * @param identity
+     */
+    removeParticipant(room, identity) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.rpc.request(svc, 'RemoveParticipant', livekit_room_1.RoomParticipantIdentity.toJSON({ room, identity }), this.authHeader({ roomAdmin: true, room }));
+        });
+    }
+    /**
+     * Mutes a track that the participant has published.
+     * @param room
+     * @param identity
+     * @param trackSid sid of the track to be muted
+     * @param muted true to mute, false to unmute
+     */
+    mutePublishedTrack(room, identity, trackSid, muted) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const req = livekit_room_1.MuteRoomTrackRequest.toJSON({
+                room,
+                identity,
+                trackSid,
+                muted,
+            });
+            const data = yield this.rpc.request(svc, 'MutePublishedTrack', req, this.authHeader({ roomAdmin: true, room }));
+            const res = livekit_room_1.MuteRoomTrackResponse.fromJSON(data);
+            return res.track;
+        });
+    }
+    /**
+     * Updates a participant's metadata or permissions
+     * @param room
+     * @param identity
+     * @param metadata optional, metadata to update
+     * @param permission optional, new permissions to assign to participant
+     * @param name optional, new name for participant
+     */
+    updateParticipant(room, identity, metadata, permission, name) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const req = {
+                room,
+                identity,
+                metadata: metadata || '',
+                permission,
+                name: name || '',
+            };
+            const data = yield this.rpc.request(svc, 'UpdateParticipant', livekit_room_1.UpdateParticipantRequest.toJSON(req), this.authHeader({ roomAdmin: true, room }));
+            return livekit_models_1.ParticipantInfo.fromJSON(data);
+        });
+    }
+    /**
+     * Updates a participant's subscription to tracks
+     * @param room
+     * @param identity
+     * @param trackSids
+     * @param subscribe true to subscribe, false to unsubscribe
+     */
+    updateSubscriptions(room, identity, trackSids, subscribe) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const req = livekit_room_1.UpdateSubscriptionsRequest.toJSON({
+                room,
+                identity,
+                trackSids,
+                subscribe,
+                participantTracks: [],
+            });
+            yield this.rpc.request(svc, 'UpdateSubscriptions', req, this.authHeader({ roomAdmin: true, room }));
+        });
+    }
+    sendData(room, data, kind, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const destinationSids = Array.isArray(options) ? options : options.destinationSids;
+            const topic = Array.isArray(options) ? undefined : options.topic;
+            const req = livekit_room_1.SendDataRequest.toJSON({
+                room,
+                data,
+                kind,
+                destinationSids: destinationSids !== null && destinationSids !== void 0 ? destinationSids : [],
+                topic,
+            });
+            yield this.rpc.request(svc, 'SendData', req, this.authHeader({ roomAdmin: true, room }));
+        });
+    }
+}
+exports.RoomServiceClient = RoomServiceClient;
+//# sourceMappingURL=RoomServiceClient.js.map

package/dist/RoomServiceClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RoomServiceClient.js","sourceRoot":"","sources":["../src/RoomServiceClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2DAMgC;AAChC,uDAe8B;AAC9B,gEAAwC;AACxC,yCAA2D;AAwC3D,MAAM,GAAG,GAAG,aAAa,CAAC;AAE1B;;GAEG;AACH,MAAa,iBAAkB,SAAQ,qBAAW;IAGhD;;;;;OAKG;IACH,YAAY,IAAY,EAAE,MAAe,EAAE,MAAe;QACxD,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACtB,IAAI,CAAC,GAAG,GAAG,IAAI,mBAAQ,CAAC,IAAI,EAAE,yBAAc,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACG,UAAU,CAAC,OAAsB;;YACrC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CACjC,GAAG,EACH,YAAY,EACZ,gCAAiB,CAAC,MAAM,CAAC,gCAAiB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,EAChE,IAAI,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CACtC,CAAC;YACF,OAAO,qBAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;KAAA;IAED;;;;;OAKG;IACG,SAAS,CAAC,KAAgB;;;YAC9B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CACjC,GAAG,EACH,WAAW,EACX,+BAAgB,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,EAAE,CAAC,EAC/C,IAAI,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CACpC,CAAC;YACF,MAAM,GAAG,GAAG,gCAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC7C,OAAO,MAAA,GAAG,CAAC,KAAK,mCAAI,EAAE,CAAC;;KACxB;IAEK,UAAU,CAAC,IAAY;;YAC3B,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CACpB,GAAG,EACH,YAAY,EACZ,gCAAiB,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,EAClC,IAAI,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CACtC,CAAC;QACJ,CAAC;KAAA;IAED;;;;OAIG;IACG,kBAAkB,CAAC,IAAY,EAAE,QAAgB;;YACrD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CACjC,GAAG,EACH,oBAAoB,EACpB,wCAAyB,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EACpD,IAAI,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAC3C,CAAC;YACF,OAAO,qBAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;KAAA;IAED;;;OAGG;IACG,gBAAgB,CAAC,IAAY;;;YACjC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CACjC,GAAG,EACH,kBAAkB,EAClB,sCAAuB,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,EACxC,IAAI,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAC3C,CAAC;YACF,MAAM,GAAG,GAAG,uCAAwB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACpD,OAAO,MAAA,GAAG,CAAC,YAAY,mCAAI,EAAE,CAAC;;KAC/B;IAED;;;;;OAKG;IACG,cAAc,CAAC,IAAY,EAAE,QAAgB;;YACjD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CACjC,GAAG,EACH,gBAAgB,EAChB,sCAAuB,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAClD,IAAI,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAC3C,CAAC;YAEF,OAAO,gCAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC;KAAA;IAED;;;;;;OAMG;IACG,iBAAiB,CAAC,IAAY,EAAE,QAAgB;;YACpD,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CACpB,GAAG,EACH,mBAAmB,EACnB,sCAAuB,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAClD,IAAI,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAC3C,CAAC;QACJ,CAAC;KAAA;IAED;;;;;;OAMG;IACG,kBAAkB,CACtB,IAAY,EACZ,QAAgB,EAChB,QAAgB,EAChB,KAAc;;YAEd,MAAM,GAAG,GAAG,mCAAoB,CAAC,MAAM,CAAC;gBACtC,IAAI;gBACJ,QAAQ;gBACR,QAAQ;gBACR,KAAK;aACN,CAAC,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CACjC,GAAG,EACH,oBAAoB,EACpB,GAAG,EACH,IAAI,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAC3C,CAAC;YACF,MAAM,GAAG,GAAG,oCAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACjD,OAAO,GAAG,CAAC,KAAM,CAAC;QACpB,CAAC;KAAA;IAED;;;;;;;OAOG;IACG,iBAAiB,CACrB,IAAY,EACZ,QAAgB,EAChB,QAAiB,EACjB,UAAkC,EAClC,IAAa;;YAEb,MAAM,GAAG,GAA6B;gBACpC,IAAI;gBACJ,QAAQ;gBACR,QAAQ,EAAE,QAAQ,IAAI,EAAE;gBACxB,UAAU;gBACV,IAAI,EAAE,IAAI,IAAI,EAAE;aACjB,CAAC;YACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CACjC,GAAG,EACH,mBAAmB,EACnB,uCAAwB,CAAC,MAAM,CAAC,GAAG,CAAC,EACpC,IAAI,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAC3C,CAAC;YACF,OAAO,gCAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC;KAAA;IAED;;;;;;OAMG;IACG,mBAAmB,CACvB,IAAY,EACZ,QAAgB,EAChB,SAAmB,EACnB,SAAkB;;YAElB,MAAM,GAAG,GAAG,yCAA0B,CAAC,MAAM,CAAC;gBAC5C,IAAI;gBACJ,QAAQ;gBACR,SAAS;gBACT,SAAS;gBACT,iBAAiB,EAAE,EAAE;aACtB,CAAC,CAAC;YACH,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CACpB,GAAG,EACH,qBAAqB,EACrB,GAAG,EACH,IAAI,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAC3C,CAAC;QACJ,CAAC;KAAA;IA4BK,QAAQ,CACZ,IAAY,EACZ,IAAgB,EAChB,IAAqB,EACrB,UAAsC,EAAE;;YAExC,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;YACnF,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;YACjE,MAAM,GAAG,GAAG,8BAAe,CAAC,MAAM,CAAC;gBACjC,IAAI;gBACJ,IAAI;gBACJ,IAAI;gBACJ,eAAe,EAAE,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,EAAE;gBACtC,KAAK;aACN,CAAC,CAAC;YACH,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC3F,CAAC;KAAA;CACF;AA1PD,8CA0PC"}

package/dist/ServiceBase.d.ts

@@ -0,0 +1,16 @@
+import { VideoGrant } from './grants';
+/**
+ * Utilities to handle authentication
+ */
+export default class ServiceBase {
+    private readonly apiKey?;
+    private readonly secret?;
+    private readonly ttl;
+    /**
+     * @param apiKey API Key.
+     * @param secret API Secret.
+     * @param ttl token TTL
+     */
+    constructor(apiKey?: string, secret?: string, ttl?: string);
+    authHeader(grant: VideoGrant): any;
+}

package/dist/ServiceBase.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const AccessToken_1 = require("./AccessToken");
+/**
+ * Utilities to handle authentication
+ */
+class ServiceBase {
+    /**
+     * @param apiKey API Key.
+     * @param secret API Secret.
+     * @param ttl token TTL
+     */
+    constructor(apiKey, secret, ttl) {
+        this.apiKey = apiKey;
+        this.secret = secret;
+        this.ttl = ttl || '10m';
+    }
+    authHeader(grant) {
+        const at = new AccessToken_1.AccessToken(this.apiKey, this.secret, { ttl: this.ttl });
+        at.addGrant(grant);
+        return {
+            Authorization: `Bearer ${at.toJwt()}`,
+        };
+    }
+}
+exports.default = ServiceBase;
+//# sourceMappingURL=ServiceBase.js.map

package/dist/ServiceBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServiceBase.js","sourceRoot":"","sources":["../src/ServiceBase.ts"],"names":[],"mappings":";;AAAA,+CAA4C;AAG5C;;GAEG;AACH,MAAqB,WAAW;IAO9B;;;;OAIG;IACH,YAAY,MAAe,EAAE,MAAe,EAAE,GAAY;QACxD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,IAAI,KAAK,CAAC;IAC1B,CAAC;IAED,UAAU,CAAC,KAAiB;QAC1B,MAAM,EAAE,GAAG,IAAI,yBAAW,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QACxE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACnB,OAAO;YACL,aAAa,EAAE,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;SACtC,CAAC;IACJ,CAAC;CACF;AAzBD,8BAyBC"}

package/dist/TwirpRPC.d.ts

@@ -0,0 +1,16 @@
+import { AxiosInstance } from 'axios';
+export declare const livekitPackage = "livekit";
+export interface Rpc {
+    request(service: string, method: string, data: any, headers?: any): Promise<string>;
+}
+/**
+ * JSON based Twirp V7 RPC
+ */
+export declare class TwirpRpc {
+    host: string;
+    pkg: string;
+    prefix: string;
+    instance: AxiosInstance;
+    constructor(host: string, pkg: string, prefix?: string);
+    request(service: string, method: string, data: any, headers?: any): Promise<any>;
+}

package/dist/TwirpRPC.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TwirpRpc = exports.livekitPackage = void 0;
+const axios_1 = __importDefault(require("axios"));
+const camelcase_keys_1 = __importDefault(require("camelcase-keys"));
+// twirp RPC adapter for client implementation
+const defaultPrefix = '/twirp';
+exports.livekitPackage = 'livekit';
+/**
+ * JSON based Twirp V7 RPC
+ */
+class TwirpRpc {
+    constructor(host, pkg, prefix) {
+        this.host = host;
+        this.pkg = pkg;
+        this.prefix = prefix || defaultPrefix;
+        this.instance = axios_1.default.create({
+            baseURL: host,
+        });
+    }
+    request(service, method, data, headers) {
+        return new Promise((resolve, reject) => {
+            const path = `${this.prefix}/${this.pkg}.${service}/${method}`;
+            this.instance
+                .post(path, data, { headers })
+                .then((res) => {
+                resolve(camelcase_keys_1.default(res.data, { deep: true }));
+            })
+                .catch(reject);
+        });
+    }
+}
+exports.TwirpRpc = TwirpRpc;
+//# sourceMappingURL=TwirpRPC.js.map

package/dist/TwirpRPC.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TwirpRPC.js","sourceRoot":"","sources":["../src/TwirpRPC.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA6C;AAC7C,oEAA2C;AAE3C,8CAA8C;AAE9C,MAAM,aAAa,GAAG,QAAQ,CAAC;AAElB,QAAA,cAAc,GAAG,SAAS,CAAC;AAKxC;;GAEG;AACH,MAAa,QAAQ;IASnB,YAAY,IAAY,EAAE,GAAW,EAAE,MAAe;QACpD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,aAAa,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,eAAK,CAAC,MAAM,CAAC;YAC3B,OAAO,EAAE,IAAI;SACd,CAAC,CAAC;IACL,CAAC;IAED,OAAO,CAAC,OAAe,EAAE,MAAc,EAAE,IAAS,EAAE,OAAa;QAC/D,OAAO,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1C,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,GAAG,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;YAC/D,IAAI,CAAC,QAAQ;iBACV,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC;iBAC7B,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;gBACZ,OAAO,CAAC,wBAAa,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YACnD,CAAC,CAAC;iBACD,KAAK,CAAC,MAAM,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA7BD,4BA6BC"}

package/dist/WebhookReceiver.d.ts

@@ -0,0 +1,14 @@
+import { WebhookEvent } from './proto/livekit_webhook';
+export declare const authorizeHeader = "Authorize";
+export declare class WebhookReceiver {
+    private verifier;
+    constructor(apiKey: string, apiSecret: string);
+    /**
+     *
+     * @param body string of the posted body
+     * @param authHeader `Authorization` header from the request
+     * @param skipAuth true to skip auth validation
+     * @returns
+     */
+    receive(body: string, authHeader?: string, skipAuth?: boolean): WebhookEvent;
+}

package/dist/WebhookReceiver.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookReceiver = exports.authorizeHeader = void 0;
+const crypto_1 = __importDefault(require("crypto"));
+const AccessToken_1 = require("./AccessToken");
+const livekit_webhook_1 = require("./proto/livekit_webhook");
+exports.authorizeHeader = 'Authorize';
+class WebhookReceiver {
+    constructor(apiKey, apiSecret) {
+        this.verifier = new AccessToken_1.TokenVerifier(apiKey, apiSecret);
+    }
+    /**
+     *
+     * @param body string of the posted body
+     * @param authHeader `Authorization` header from the request
+     * @param skipAuth true to skip auth validation
+     * @returns
+     */
+    receive(body, authHeader, skipAuth = false) {
+        // verify token
+        if (!skipAuth) {
+            if (!authHeader) {
+                throw new Error('authorization header is empty');
+            }
+            const claims = this.verifier.verify(authHeader);
+            // confirm sha
+            const hash = crypto_1.default.createHash('sha256');
+            hash.update(body);
+            if (claims.sha256 !== hash.digest('base64')) {
+                throw new Error('sha256 checksum of body does not match');
+            }
+        }
+        return livekit_webhook_1.WebhookEvent.fromJSON(JSON.parse(body));
+    }
+}
+exports.WebhookReceiver = WebhookReceiver;
+//# sourceMappingURL=WebhookReceiver.js.map

package/dist/WebhookReceiver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebhookReceiver.js","sourceRoot":"","sources":["../src/WebhookReceiver.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAC5B,+CAA8C;AAC9C,6DAAuD;AAE1C,QAAA,eAAe,GAAG,WAAW,CAAC;AAE3C,MAAa,eAAe;IAG1B,YAAY,MAAc,EAAE,SAAiB;QAC3C,IAAI,CAAC,QAAQ,GAAG,IAAI,2BAAa,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,IAAY,EAAE,UAAmB,EAAE,WAAoB,KAAK;QAClE,eAAe;QACf,IAAI,CAAC,QAAQ,EAAE;YACb,IAAI,CAAC,UAAU,EAAE;gBACf,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;aAClD;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAChD,cAAc;YACd,MAAM,IAAI,GAAG,gBAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YACzC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAElB,IAAI,MAAM,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;gBAC3C,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC3D;SACF;QAED,OAAO,8BAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACjD,CAAC;CACF;AAhCD,0CAgCC"}

package/dist/WebhookReceiver.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/WebhookReceiver.test.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const AccessToken_1 = require("./AccessToken");
+const livekit_webhook_1 = require("./proto/livekit_webhook");
+const WebhookReceiver_1 = require("./WebhookReceiver");
+const testApiKey = 'abcdefg';
+const testSecret = 'abababa';
+describe('webhook receiver', () => {
+    const body = '{"event":"room_started", "room":{"sid":"RM_TkVjUvAqgzKz", "name":"mytestroom", "emptyTimeout":300, "creationTime":"1628545903", "turnPassword":"ICkSr2rEeslkN6e9bXL4Ji5zzMD5Z7zzr6ulOaxMj6N", "enabledCodecs":[{"mime":"audio/opus"}, {"mime":"video/VP8"}]}}';
+    const sha = 'CoEQz1chqJ9bnZRcORddjplkvpjmPujmLTR42DbefYI=';
+    const t = new AccessToken_1.AccessToken(testApiKey, testSecret);
+    t.sha256 = sha;
+    const token = t.toJwt();
+    const receiver = new WebhookReceiver_1.WebhookReceiver(testApiKey, testSecret);
+    it('should receive and decode WebhookEvent', () => {
+        var _a;
+        const event = receiver.receive(body, token);
+        expect(event).toBeTruthy();
+        expect((_a = event.room) === null || _a === void 0 ? void 0 : _a.name).toBe('mytestroom');
+        expect(event.event).toBe('room_started');
+    });
+});
+describe('decoding json payload', () => {
+    it('should allow server to return extra fields', () => {
+        var _a;
+        const obj = {
+            type: 'room_started',
+            room: {
+                sid: 'RM_TkVjUvAqgzKz',
+                name: 'mytestroom',
+            },
+            extra: 'extra',
+        };
+        const event = livekit_webhook_1.WebhookEvent.fromJSON(obj);
+        expect(event).toBeTruthy();
+        expect((_a = event.room) === null || _a === void 0 ? void 0 : _a.name).toBe('mytestroom');
+    });
+});
+//# sourceMappingURL=WebhookReceiver.test.js.map

package/dist/WebhookReceiver.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebhookReceiver.test.js","sourceRoot":"","sources":["../src/WebhookReceiver.test.ts"],"names":[],"mappings":";;AAAA,+CAA4C;AAC5C,6DAAuD;AACvD,uDAAoD;AAEpD,MAAM,UAAU,GAAG,SAAS,CAAC;AAC7B,MAAM,UAAU,GAAG,SAAS,CAAC;AAE7B,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,MAAM,IAAI,GACR,+PAA+P,CAAC;IAClQ,MAAM,GAAG,GAAG,8CAA8C,CAAC;IAC3D,MAAM,CAAC,GAAG,IAAI,yBAAW,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAClD,CAAC,CAAC,MAAM,GAAG,GAAG,CAAC;IACf,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IACxB,MAAM,QAAQ,GAAG,IAAI,iCAAe,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAE7D,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;;QAChD,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC5C,MAAM,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC;QAC3B,MAAM,CAAC,MAAA,KAAK,CAAC,IAAI,0CAAE,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5C,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;;QACpD,MAAM,GAAG,GAAG;YACV,IAAI,EAAE,cAAc;YACpB,IAAI,EAAE;gBACJ,GAAG,EAAE,iBAAiB;gBACtB,IAAI,EAAE,YAAY;aACnB;YACD,KAAK,EAAE,OAAO;SACf,CAAC;QAEF,MAAM,KAAK,GAAG,8BAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC;QAC3B,MAAM,CAAC,MAAA,KAAK,CAAC,IAAI,0CAAE,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/grants.d.ts

@@ -0,0 +1,53 @@
+export declare enum TrackSource {
+    CAMERA = "camera",
+    MICROPHONE = "microphone",
+    SCREEN_SHARE = "screen_share",
+    SCREEN_SHARE_AUDIO = "screen_share_audio"
+}
+export interface VideoGrant {
+    /** permission to create a room */
+    roomCreate?: boolean;
+    /** permission to join a room as a participant, room must be set */
+    roomJoin?: boolean;
+    /** permission to list rooms */
+    roomList?: boolean;
+    /** permission to start a recording */
+    roomRecord?: boolean;
+    /** permission to control a specific room, room must be set */
+    roomAdmin?: boolean;
+    /** name of the room, must be set for admin or join permissions */
+    room?: string;
+    /** permissions to control ingress, not specific to any room or ingress */
+    ingressAdmin?: boolean;
+    /**
+     * allow participant to publish. If neither canPublish or canSubscribe is set,
+     * both publish and subscribe are enabled
+     */
+    canPublish?: boolean;
+    /**
+     * TrackSource types that the participant is allowed to publish
+     * When set, it supersedes CanPublish. Only sources explicitly set here can be published
+     */
+    canPublishSources?: TrackSource[];
+    /** allow participant to subscribe to other tracks */
+    canSubscribe?: boolean;
+    /**
+     * allow participants to publish data, defaults to true if not set
+     */
+    canPublishData?: boolean;
+    /**
+     * by default, a participant is not allowed to update its own metadata
+     */
+    canUpdateOwnMetadata?: boolean;
+    /** participant isn't visible to others */
+    hidden?: boolean;
+    /** participant is recording the room, when set, allows room to indicate it's being recorded */
+    recorder?: boolean;
+}
+/** @internal */
+export interface ClaimGrants {
+    name?: string;
+    video?: VideoGrant;
+    metadata?: string;
+    sha256?: string;
+}

package/dist/grants.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrackSource = void 0;
+var TrackSource;
+(function (TrackSource) {
+    TrackSource["CAMERA"] = "camera";
+    TrackSource["MICROPHONE"] = "microphone";
+    TrackSource["SCREEN_SHARE"] = "screen_share";
+    TrackSource["SCREEN_SHARE_AUDIO"] = "screen_share_audio";
+})(TrackSource = exports.TrackSource || (exports.TrackSource = {}));
+//# sourceMappingURL=grants.js.map

package/dist/grants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"grants.js","sourceRoot":"","sources":["../src/grants.ts"],"names":[],"mappings":";;;AAAA,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,gCAAiB,CAAA;IACjB,wCAAyB,CAAA;IACzB,4CAA6B,CAAA;IAC7B,wDAAyC,CAAA;AAC3C,CAAC,EALW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAKtB"}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export * from './AccessToken';
+export * from './EgressClient';
+export * from './IngressClient';
+export * from './RoomServiceClient';
+export * from './WebhookReceiver';
+export * from './grants';
+export { DirectFileOutput, EgressInfo, EncodedFileOutput, EncodedFileType, EncodingOptions, EncodingOptionsPreset, SegmentedFileOutput, SegmentedFileProtocol, StreamOutput, StreamProtocol, } from './proto/livekit_egress';
+export { IngressAudioEncodingOptions, IngressAudioEncodingPreset, IngressAudioOptions, IngressInfo, IngressInput, IngressState, IngressVideoEncodingOptions, IngressVideoEncodingPreset, IngressVideoOptions, } from './proto/livekit_ingress';
+export { DataPacket_Kind, ParticipantInfo, ParticipantInfo_State, ParticipantPermission, Room, TrackInfo, TrackSource, TrackType, } from './proto/livekit_models';

package/dist/index.js

@@ -0,0 +1,50 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrackType = exports.TrackSource = exports.TrackInfo = exports.Room = exports.ParticipantPermission = exports.ParticipantInfo_State = exports.ParticipantInfo = exports.DataPacket_Kind = exports.IngressVideoOptions = exports.IngressVideoEncodingPreset = exports.IngressVideoEncodingOptions = exports.IngressState = exports.IngressInput = exports.IngressInfo = exports.IngressAudioOptions = exports.IngressAudioEncodingPreset = exports.IngressAudioEncodingOptions = exports.StreamProtocol = exports.StreamOutput = exports.SegmentedFileProtocol = exports.SegmentedFileOutput = exports.EncodingOptionsPreset = exports.EncodingOptions = exports.EncodedFileType = exports.EncodedFileOutput = exports.EgressInfo = exports.DirectFileOutput = void 0;
+__exportStar(require("./AccessToken"), exports);
+__exportStar(require("./EgressClient"), exports);
+__exportStar(require("./IngressClient"), exports);
+__exportStar(require("./RoomServiceClient"), exports);
+__exportStar(require("./WebhookReceiver"), exports);
+__exportStar(require("./grants"), exports);
+var livekit_egress_1 = require("./proto/livekit_egress");
+Object.defineProperty(exports, "DirectFileOutput", { enumerable: true, get: function () { return livekit_egress_1.DirectFileOutput; } });
+Object.defineProperty(exports, "EgressInfo", { enumerable: true, get: function () { return livekit_egress_1.EgressInfo; } });
+Object.defineProperty(exports, "EncodedFileOutput", { enumerable: true, get: function () { return livekit_egress_1.EncodedFileOutput; } });
+Object.defineProperty(exports, "EncodedFileType", { enumerable: true, get: function () { return livekit_egress_1.EncodedFileType; } });
+Object.defineProperty(exports, "EncodingOptions", { enumerable: true, get: function () { return livekit_egress_1.EncodingOptions; } });
+Object.defineProperty(exports, "EncodingOptionsPreset", { enumerable: true, get: function () { return livekit_egress_1.EncodingOptionsPreset; } });
+Object.defineProperty(exports, "SegmentedFileOutput", { enumerable: true, get: function () { return livekit_egress_1.SegmentedFileOutput; } });
+Object.defineProperty(exports, "SegmentedFileProtocol", { enumerable: true, get: function () { return livekit_egress_1.SegmentedFileProtocol; } });
+Object.defineProperty(exports, "StreamOutput", { enumerable: true, get: function () { return livekit_egress_1.StreamOutput; } });
+Object.defineProperty(exports, "StreamProtocol", { enumerable: true, get: function () { return livekit_egress_1.StreamProtocol; } });
+var livekit_ingress_1 = require("./proto/livekit_ingress");
+Object.defineProperty(exports, "IngressAudioEncodingOptions", { enumerable: true, get: function () { return livekit_ingress_1.IngressAudioEncodingOptions; } });
+Object.defineProperty(exports, "IngressAudioEncodingPreset", { enumerable: true, get: function () { return livekit_ingress_1.IngressAudioEncodingPreset; } });
+Object.defineProperty(exports, "IngressAudioOptions", { enumerable: true, get: function () { return livekit_ingress_1.IngressAudioOptions; } });
+Object.defineProperty(exports, "IngressInfo", { enumerable: true, get: function () { return livekit_ingress_1.IngressInfo; } });
+Object.defineProperty(exports, "IngressInput", { enumerable: true, get: function () { return livekit_ingress_1.IngressInput; } });
+Object.defineProperty(exports, "IngressState", { enumerable: true, get: function () { return livekit_ingress_1.IngressState; } });
+Object.defineProperty(exports, "IngressVideoEncodingOptions", { enumerable: true, get: function () { return livekit_ingress_1.IngressVideoEncodingOptions; } });
+Object.defineProperty(exports, "IngressVideoEncodingPreset", { enumerable: true, get: function () { return livekit_ingress_1.IngressVideoEncodingPreset; } });
+Object.defineProperty(exports, "IngressVideoOptions", { enumerable: true, get: function () { return livekit_ingress_1.IngressVideoOptions; } });
+var livekit_models_1 = require("./proto/livekit_models");
+Object.defineProperty(exports, "DataPacket_Kind", { enumerable: true, get: function () { return livekit_models_1.DataPacket_Kind; } });
+Object.defineProperty(exports, "ParticipantInfo", { enumerable: true, get: function () { return livekit_models_1.ParticipantInfo; } });
+Object.defineProperty(exports, "ParticipantInfo_State", { enumerable: true, get: function () { return livekit_models_1.ParticipantInfo_State; } });
+Object.defineProperty(exports, "ParticipantPermission", { enumerable: true, get: function () { return livekit_models_1.ParticipantPermission; } });
+Object.defineProperty(exports, "Room", { enumerable: true, get: function () { return livekit_models_1.Room; } });
+Object.defineProperty(exports, "TrackInfo", { enumerable: true, get: function () { return livekit_models_1.TrackInfo; } });
+Object.defineProperty(exports, "TrackSource", { enumerable: true, get: function () { return livekit_models_1.TrackSource; } });
+Object.defineProperty(exports, "TrackType", { enumerable: true, get: function () { return livekit_models_1.TrackType; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,iDAA+B;AAC/B,kDAAgC;AAChC,sDAAoC;AACpC,oDAAkC;AAClC,2CAAyB;AACzB,yDAWgC;AAV9B,kHAAA,gBAAgB,OAAA;AAChB,4GAAA,UAAU,OAAA;AACV,mHAAA,iBAAiB,OAAA;AACjB,iHAAA,eAAe,OAAA;AACf,iHAAA,eAAe,OAAA;AACf,uHAAA,qBAAqB,OAAA;AACrB,qHAAA,mBAAmB,OAAA;AACnB,uHAAA,qBAAqB,OAAA;AACrB,8GAAA,YAAY,OAAA;AACZ,gHAAA,cAAc,OAAA;AAEhB,2DAUiC;AAT/B,8HAAA,2BAA2B,OAAA;AAC3B,6HAAA,0BAA0B,OAAA;AAC1B,sHAAA,mBAAmB,OAAA;AACnB,8GAAA,WAAW,OAAA;AACX,+GAAA,YAAY,OAAA;AACZ,+GAAA,YAAY,OAAA;AACZ,8HAAA,2BAA2B,OAAA;AAC3B,6HAAA,0BAA0B,OAAA;AAC1B,sHAAA,mBAAmB,OAAA;AAErB,yDASgC;AAR9B,iHAAA,eAAe,OAAA;AACf,iHAAA,eAAe,OAAA;AACf,uHAAA,qBAAqB,OAAA;AACrB,uHAAA,qBAAqB,OAAA;AACrB,sGAAA,IAAI,OAAA;AACJ,2GAAA,SAAS,OAAA;AACT,6GAAA,WAAW,OAAA;AACX,2GAAA,SAAS,OAAA"}