@livekit/agents 0.1.0 → 0.2.0

package/dist/utils.js

@@ -1,7 +1,25 @@
-// SPDX-FileCopyrightText: 2024 LiveKit, Inc.
-//
-// SPDX-License-Identifier: Apache-2.0
-import { AudioFrame } from '@livekit/rtc-node';
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _Mutex_locking, _Mutex_locks, _Mutex_limit, _Queue_items, _Queue_limit, _Queue_events, _Future_await;
+import { AudioFrame, TrackSource } from '@livekit/rtc-node';
+import { EventEmitter, once } from 'events';
+/**
+ * Merge one or more {@link AudioFrame}s into a single one.
+ *
+ * @param buffer Either an {@link AudioFrame} or a list thereof
+ * @throws
+ * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError
+ * | TypeError} if sample rate or channel count are mismatched
+ */
 export const mergeFrames = (buffer) => {
     if (Array.isArray(buffer)) {
         buffer = buffer;
@@ -11,7 +29,7 @@ export const mergeFrames = (buffer) => {
         const sampleRate = buffer[0].sampleRate;
         const channels = buffer[0].channels;
         let samplesPerChannel = 0;
-        let data = new Uint16Array();
+        let data = new Int16Array();
         for (const frame of buffer) {
             if (frame.sampleRate !== sampleRate) {
                 throw new TypeError('sample rate mismatch');
@@ -19,11 +37,101 @@ export const mergeFrames = (buffer) => {
             if (frame.channels !== channels) {
                 throw new TypeError('channel count mismatch');
             }
-            data = new Uint16Array([...data, ...frame.data]);
+            data = new Int16Array([...data, ...frame.data]);
             samplesPerChannel += frame.samplesPerChannel;
         }
         return new AudioFrame(data, sampleRate, channels, samplesPerChannel);
     }
     return buffer;
 };
+export const findMicroTrackId = (room, identity) => {
+    var _a;
+    let p = room.remoteParticipants.get(identity);
+    if (identity === ((_a = room.localParticipant) === null || _a === void 0 ? void 0 : _a.identity)) {
+        p = room.localParticipant;
+    }
+    if (!p) {
+        throw new Error(`participant ${identity} not found`);
+    }
+    // find first micro track
+    let trackId;
+    p.trackPublications.forEach((track) => {
+        if (track.source === TrackSource.SOURCE_MICROPHONE) {
+            trackId = track.sid;
+            return;
+        }
+    });
+    if (!trackId) {
+        throw new Error(`participant ${identity} does not have a microphone track`);
+    }
+    return trackId;
+};
+/** @internal */
+export class Mutex {
+    constructor(limit = 1) {
+        _Mutex_locking.set(this, void 0);
+        _Mutex_locks.set(this, void 0);
+        _Mutex_limit.set(this, void 0);
+        __classPrivateFieldSet(this, _Mutex_locking, Promise.resolve(), "f");
+        __classPrivateFieldSet(this, _Mutex_locks, 0, "f");
+        __classPrivateFieldSet(this, _Mutex_limit, limit, "f");
+    }
+    isLocked() {
+        return __classPrivateFieldGet(this, _Mutex_locks, "f") >= __classPrivateFieldGet(this, _Mutex_limit, "f");
+    }
+    async lock() {
+        __classPrivateFieldSet(this, _Mutex_locks, __classPrivateFieldGet(this, _Mutex_locks, "f") + 1, "f");
+        let unlockNext;
+        const willLock = new Promise((resolve) => (unlockNext = () => {
+            __classPrivateFieldSet(this, _Mutex_locks, __classPrivateFieldGet(this, _Mutex_locks, "f") - 1, "f");
+            resolve();
+        }));
+        const willUnlock = __classPrivateFieldGet(this, _Mutex_locking, "f").then(() => unlockNext);
+        __classPrivateFieldSet(this, _Mutex_locking, __classPrivateFieldGet(this, _Mutex_locking, "f").then(() => willLock), "f");
+        return willUnlock;
+    }
+}
+_Mutex_locking = new WeakMap(), _Mutex_locks = new WeakMap(), _Mutex_limit = new WeakMap();
+/** @internal */
+export class Queue {
+    constructor(limit) {
+        _Queue_items.set(this, []);
+        _Queue_limit.set(this, void 0);
+        _Queue_events.set(this, new EventEmitter());
+        __classPrivateFieldSet(this, _Queue_limit, limit, "f");
+    }
+    async get() {
+        if (__classPrivateFieldGet(this, _Queue_items, "f").length === 0) {
+            await once(__classPrivateFieldGet(this, _Queue_events, "f"), 'put');
+        }
+        const item = __classPrivateFieldGet(this, _Queue_items, "f").shift();
+        __classPrivateFieldGet(this, _Queue_events, "f").emit('get');
+        return item;
+    }
+    async put(item) {
+        if (__classPrivateFieldGet(this, _Queue_limit, "f") && __classPrivateFieldGet(this, _Queue_items, "f").length >= __classPrivateFieldGet(this, _Queue_limit, "f")) {
+            await once(__classPrivateFieldGet(this, _Queue_events, "f"), 'get');
+        }
+        __classPrivateFieldGet(this, _Queue_items, "f").push(item);
+        __classPrivateFieldGet(this, _Queue_events, "f").emit('put');
+    }
+}
+_Queue_items = new WeakMap(), _Queue_limit = new WeakMap(), _Queue_events = new WeakMap();
+/** @internal */
+export class Future {
+    constructor() {
+        _Future_await.set(this, new Promise((resolve, reject) => {
+            this.resolve = resolve;
+            this.reject = reject;
+        }));
+    }
+    get await() {
+        return __classPrivateFieldGet(this, _Future_await, "f");
+    }
+    resolve() { }
+    reject(_) {
+        _;
+    }
+}
+_Future_await = new WeakMap();
 //# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,EAAE;AACF,sCAAsC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAI/C,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,MAAmB,EAAc,EAAE;IAC7D,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,MAAM,GAAG,MAAsB,CAAC;QAChC,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,SAAS,CAAC,iBAAiB,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;QACxC,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QACpC,IAAI,iBAAiB,GAAG,CAAC,CAAC;QAC1B,IAAI,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC;QAE7B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,KAAK,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;gBACpC,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,CAAC;YAC9C,CAAC;YAED,IAAI,KAAK,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAChC,MAAM,IAAI,SAAS,CAAC,wBAAwB,CAAC,CAAC;YAChD,CAAC;YAED,IAAI,GAAG,IAAI,WAAW,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;YACjD,iBAAiB,IAAI,KAAK,CAAC,iBAAiB,CAAC;QAC/C,CAAC;QAED,OAAO,IAAI,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IACvE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;;;;;;;AASA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAK5C;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,MAAmB,EAAc,EAAE;IAC7D,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,MAAM,GAAG,MAAsB,CAAC;QAChC,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,SAAS,CAAC,iBAAiB,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;QACxC,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QACpC,IAAI,iBAAiB,GAAG,CAAC,CAAC;QAC1B,IAAI,IAAI,GAAG,IAAI,UAAU,EAAE,CAAC;QAE5B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,KAAK,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;gBACpC,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,CAAC;YAC9C,CAAC;YAED,IAAI,KAAK,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAChC,MAAM,IAAI,SAAS,CAAC,wBAAwB,CAAC,CAAC;YAChD,CAAC;YAED,IAAI,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;YAChD,iBAAiB,IAAI,KAAK,CAAC,iBAAiB,CAAC;QAC/C,CAAC;QAED,OAAO,IAAI,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IACvE,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAAU,EAAE,QAAgB,EAAU,EAAE;;IACvE,IAAI,CAAC,GAAqD,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAEhG,IAAI,QAAQ,MAAK,MAAA,IAAI,CAAC,gBAAgB,0CAAE,QAAQ,CAAA,EAAE,CAAC;QACjD,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;IAC5B,CAAC;IAED,IAAI,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,eAAe,QAAQ,YAAY,CAAC,CAAC;IACvD,CAAC;IAED,yBAAyB;IACzB,IAAI,OAA2B,CAAC;IAChC,CAAC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,KAAuB,EAAE,EAAE;QACtD,IAAI,KAAK,CAAC,MAAM,KAAK,WAAW,CAAC,iBAAiB,EAAE,CAAC;YACnD,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC;YACpB,OAAO;QACT,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,eAAe,QAAQ,mCAAmC,CAAC,CAAC;IAC9E,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,gBAAgB;AAChB,MAAM,OAAO,KAAK;IAKhB,YAAY,KAAK,GAAG,CAAC;QAJrB,iCAAwB;QACxB,+BAAe;QACf,+BAAe;QAGb,uBAAA,IAAI,kBAAY,OAAO,CAAC,OAAO,EAAE,MAAA,CAAC;QAClC,uBAAA,IAAI,gBAAU,CAAC,MAAA,CAAC;QAChB,uBAAA,IAAI,gBAAU,KAAK,MAAA,CAAC;IACtB,CAAC;IAED,QAAQ;QACN,OAAO,uBAAA,IAAI,oBAAO,IAAI,uBAAA,IAAI,oBAAO,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,IAAI;QACR,6FAAe,CAAC,MAAA,CAAC;QAEjB,IAAI,UAAsB,CAAC;QAE3B,MAAM,QAAQ,GAAG,IAAI,OAAO,CAC1B,CAAC,OAAO,EAAE,EAAE,CACV,CAAC,UAAU,GAAG,GAAG,EAAE;YACjB,6FAAe,CAAC,MAAA,CAAC;YACjB,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CACL,CAAC;QAEF,MAAM,UAAU,GAAG,uBAAA,IAAI,sBAAS,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC;QACxD,uBAAA,IAAI,kBAAY,uBAAA,IAAI,sBAAS,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAA,CAAC;QACnD,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;;AAED,gBAAgB;AAChB,MAAM,OAAO,KAAK;IAKhB,YAAY,KAAc;QAJ1B,uBAAc,EAAE,EAAC;QACjB,+BAAgB;QAChB,wBAAU,IAAI,YAAY,EAAE,EAAC;QAG3B,uBAAA,IAAI,gBAAU,KAAK,MAAA,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,GAAG;QACP,IAAI,uBAAA,IAAI,oBAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,CAAC,uBAAA,IAAI,qBAAQ,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC;QACD,MAAM,IAAI,GAAG,uBAAA,IAAI,oBAAO,CAAC,KAAK,EAAG,CAAC;QAClC,uBAAA,IAAI,qBAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,IAAO;QACf,IAAI,uBAAA,IAAI,oBAAO,IAAI,uBAAA,IAAI,oBAAO,CAAC,MAAM,IAAI,uBAAA,IAAI,oBAAO,EAAE,CAAC;YACrD,MAAM,IAAI,CAAC,uBAAA,IAAI,qBAAQ,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC;QACD,uBAAA,IAAI,oBAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvB,uBAAA,IAAI,qBAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;CACF;;AAED,gBAAgB;AAChB,MAAM,OAAO,MAAM;IAAnB;QACE,wBAAS,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAA0B,EAAE,EAAE;YACjE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACvB,CAAC,CAAC,EAAC;IASL,CAAC;IAPC,IAAI,KAAK;QACP,OAAO,uBAAA,IAAI,qBAAO,CAAC;IACrB,CAAC;IACD,OAAO,KAAI,CAAC;IACZ,MAAM,CAAC,CAAQ;QACb,CAAC,CAAC;IACJ,CAAC;CACF"}

package/dist/vad.d.ts

@@ -6,16 +6,45 @@ export declare enum VADEventType {
 }
 export interface VADEvent {
     type: VADEventType;
+    /**
+     * Index of the samples of the event (when the event was fired)
+     */
     samplesIndex: number;
+    /**
+     * Duration of speech, in seconds
+     */
     duration: number;
     speech: AudioFrame[];
 }
 export declare abstract class VAD {
+    /**
+     * Returns a {@link VADStream} that can be used to push audio frames and receive VAD events.
+     *
+     * @param options
+     */
     abstract stream({ minSpeakingDuration, minSilenceDuration, paddingDuration, sampleRate, maxBufferedSpeech, }: {
+        /**
+         * Minimum duration of speech required to trigger a {@link VADEventType.START_OF_SPEECH} event
+         */
         minSpeakingDuration: number;
+        /**
+         * Milliseconds to wait before separating speech chunk.
+         * Not always precise, generally rounded to the nearest 40ms depending on VAD implementation
+         */
         minSilenceDuration: number;
+        /**
+         * Number of frames to pad the start and end of speech with
+         */
         paddingDuration: number;
+        /**
+         * Sample rate of inference/processing
+         */
         sampleRate: number;
+        /**
+         * Number of seconds the buffer may keep until {@link VADEventType.END_OF_SPEECH} is triggered.
+         * It is recommended to set this to a positive value, as zero may OOM if the user doesn't stop
+         * speaking.
+         */
         maxBufferedSpeech: number;
     }): VADStream;
 }

package/dist/vad.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vad.d.ts","sourceRoot":"","sources":["../src/vad.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,oBAAY,YAAY;IACtB,eAAe,IAAI;IACnB,QAAQ,IAAI;IACZ,aAAa,IAAI;CAClB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,YAAY,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,UAAU,EAAE,CAAC;CACtB;AAED,8BAAsB,GAAG;IACvB,QAAQ,CAAC,MAAM,CAAC,EACd,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,UAAU,EACV,iBAAiB,GAClB,EAAE;QACD,mBAAmB,EAAE,MAAM,CAAC;QAC5B,kBAAkB,EAAE,MAAM,CAAC;QAC3B,eAAe,EAAE,MAAM,CAAC;QACxB,UAAU,EAAE,MAAM,CAAC;QACnB,iBAAiB,EAAE,MAAM,CAAC;KAC3B,GAAG,SAAS;CACd;AAED,8BAAsB,SAAU,YAAW,gBAAgB,CAAC,QAAQ,CAAC;IACnE,QAAQ,CAAC,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAC3C,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAC5C,QAAQ,CAAC,IAAI,IAAI,cAAc,CAAC,QAAQ,CAAC;IACzC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAS;CAG/B"}
+{"version":3,"file":"vad.d.ts","sourceRoot":"","sources":["../src/vad.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,oBAAY,YAAY;IACtB,eAAe,IAAI;IACnB,QAAQ,IAAI;IACZ,aAAa,IAAI;CAClB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,YAAY,CAAC;IACnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,UAAU,EAAE,CAAC;CACtB;AAED,8BAAsB,GAAG;IACvB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EACd,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,UAAU,EACV,iBAAiB,GAClB,EAAE;QACD;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAC5B;;;WAGG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAC3B;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QACxB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QACnB;;;;WAIG;QACH,iBAAiB,EAAE,MAAM,CAAC;KAC3B,GAAG,SAAS;CACd;AAED,8BAAsB,SAAU,YAAW,gBAAgB,CAAC,QAAQ,CAAC;IACnE,QAAQ,CAAC,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAC3C,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAC5C,QAAQ,CAAC,IAAI,IAAI,cAAc,CAAC,QAAQ,CAAC;IACzC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,SAAS;CAG/B"}

package/dist/vad.js.map

@@ -1 +1 @@
-{"version":3,"file":"vad.js","sourceRoot":"","sources":["../src/vad.ts"],"names":[],"mappings":"AAKA,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,qEAAmB,CAAA;IACnB,uDAAY,CAAA;IACZ,iEAAiB,CAAA;AACnB,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AASD,MAAM,OAAgB,GAAG;CAcxB;AAED,MAAM,OAAgB,SAAS;IAI7B,CAAC,MAAM,CAAC,QAAQ,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}
+{"version":3,"file":"vad.js","sourceRoot":"","sources":["../src/vad.ts"],"names":[],"mappings":"AAKA,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,qEAAmB,CAAA;IACnB,uDAAY,CAAA;IACZ,iEAAiB,CAAA;AACnB,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AAeD,MAAM,OAAgB,GAAG;CAqCxB;AAED,MAAM,OAAgB,SAAS;IAI7B,CAAC,MAAM,CAAC,QAAQ,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/dist/worker.d.ts

@@ -1,24 +1,48 @@
-/// <reference types="node" resolution-mode="require"/>
-import { type AvailabilityRequest, type Job, type JobAssignment, JobType } from '@livekit/protocol';
+/// <reference types="node" />
+import type { TrackSource } from '@livekit/protocol';
+import { JobType } from '@livekit/protocol';
 import { EventEmitter } from 'events';
-import { WebSocket } from 'ws';
-import { HTTPServer } from './http_server.js';
-import { JobProcess } from './ipc/job_process.js';
-import { JobRequest } from './job_request.js';
-import type { AcceptData } from './job_request.js';
-declare class WorkerPermissions {
+import type { JobProcess, RunningJobInfo } from './job.js';
+import { JobRequest } from './job.js';
+/** Necessary credentials not provided and not found in an appropriate environmental variable. */
+export declare class MissingCredentialsError extends Error {
+    constructor(msg?: string);
+}
+/** Worker did not run as expected. */
+export declare class WorkerError extends Error {
+    constructor(msg?: string);
+}
+/** @internal */
+export declare const defaultInitializeProcessFunc: (_: JobProcess) => JobProcess;
+/** Participant permissions to pass to every agent spun up by this worker. */
+export declare class WorkerPermissions {
     canPublish: boolean;
     canSubscribe: boolean;
     canPublishData: boolean;
     canUpdateMetadata: boolean;
+    canPublishSources: TrackSource[];
     hidden: boolean;
-    constructor(canPublish?: boolean, canSubscribe?: boolean, canPublishData?: boolean, canUpdateMetadata?: boolean, hidden?: boolean);
+    constructor(canPublish?: boolean, canSubscribe?: boolean, canPublishData?: boolean, canUpdateMetadata?: boolean, canPublishSources?: TrackSource[], hidden?: boolean);
 }
+/**
+ * Data class describing worker behaviour.
+ *
+ * @remarks
+ * The Agents framework provides sane worker defaults, and works out-of-the-box with no tweaking
+ * necessary. The only mandatory parameter is `agent`, which points to the entry function.
+ *
+ * This class is mostly useful in conjunction with {@link cli.runApp}.
+ */
 export declare class WorkerOptions {
-    requestFunc: (arg: JobRequest) => Promise<void>;
-    cpuLoadFunc: () => number;
-    namespace: string;
+    agent: string;
+    requestFunc: (job: JobRequest) => Promise<void>;
+    loadFunc: () => Promise<number>;
+    loadThreshold: number;
+    numIdleProcesses: number;
+    shutdownProcessTimeout: number;
+    initializeProcessTimeout: number;
     permissions: WorkerPermissions;
+    agentName: string;
     workerType: JobType;
     maxRetry: number;
     wsURL: string;
@@ -26,11 +50,24 @@ export declare class WorkerOptions {
     apiSecret?: string;
     host: string;
     port: number;
-    constructor({ requestFunc, cpuLoadFunc, namespace, permissions, workerType, maxRetry, wsURL, apiKey, apiSecret, host, port, }: {
-        requestFunc: (arg: JobRequest) => Promise<void>;
-        cpuLoadFunc?: () => number;
-        namespace?: string;
+    logLevel: string;
+    /** @param options */
+    constructor({ agent, requestFunc, loadFunc, loadThreshold, numIdleProcesses, shutdownProcessTimeout, initializeProcessTimeout, permissions, agentName, workerType, maxRetry, wsURL, apiKey, apiSecret, host, port, logLevel, }: {
+        /**
+         * Path to a file that has {@link Agent} as a default export, dynamically imported later for
+         * entrypoint and prewarm functions
+         */
+        agent: string;
+        requestFunc?: (job: JobRequest) => Promise<void>;
+        /** Called to determine the current load of the worker. Should return a value between 0 and 1. */
+        loadFunc?: () => Promise<number>;
+        /** When the load exceeds this threshold, the worker will be marked as unavailable. */
+        loadThreshold?: number;
+        numIdleProcesses?: number;
+        shutdownProcessTimeout?: number;
+        initializeProcessTimeout?: number;
         permissions?: WorkerPermissions;
+        agentName?: string;
         workerType?: JobType;
         maxRetry?: number;
         wsURL?: string;
@@ -38,47 +75,27 @@ export declare class WorkerOptions {
         apiSecret?: string;
         host?: string;
         port?: number;
+        logLevel?: string;
     });
 }
-declare class ActiveJob {
-    job: Job;
-    acceptData: AcceptData;
-    constructor(job: Job, acceptData: AcceptData);
-}
-type AssignmentPair = {
-    raw: string;
-    asgn: JobAssignment;
-};
-declare class PendingAssignment {
-    promise: Promise<AssignmentPair>;
-    resolve(arg: AssignmentPair): void;
-}
+/**
+ * Central orchestrator for all processes and job requests.
+ *
+ * @remarks
+ * For most usecases, Worker should not be initialized or handled directly; you should instead call
+ * for its creation through {@link cli.runApp}. This could, however, be useful in situations where
+ * you don't have access to a command line, such as a headless program, or one that uses Agents
+ * behind a wrapper.
+ */
 export declare class Worker {
     #private;
-    opts: WorkerOptions;
-    session: WebSocket | undefined;
-    closed: boolean;
-    httpServer: HTTPServer;
-    logger: import("pino").default.Logger<never>;
     event: EventEmitter<[never]>;
-    pending: {
-        [id: string]: {
-            value: PendingAssignment;
-        };
-    };
-    processes: {
-        [id: string]: {
-            proc: JobProcess;
-            activeJob: ActiveJob;
-        };
-    };
     constructor(opts: WorkerOptions);
-    get id(): string;
     run(): Promise<void>;
-    startProcess(job: Job, acceptData: AcceptData, raw: string): void;
-    runWS(ws: WebSocket): void;
-    availability(msg: AvailabilityRequest): Promise<void>;
+    get id(): string;
+    get activeJobs(): RunningJobInfo[];
+    drain(timeout?: number): Promise<void>;
+    simulateJob(roomName: string, participantIdentity?: string): Promise<void>;
     close(): Promise<void>;
 }
-export {};
 //# sourceMappingURL=worker.d.ts.map

package/dist/worker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"worker.d.ts","sourceRoot":"","sources":["../src/worker.ts"],"names":[],"mappings":";AAGA,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,GAAG,EACR,KAAK,aAAa,EAClB,OAAO,EAIR,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,OAAO,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAiB,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAkBnD,cAAM,iBAAiB;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,OAAO,CAAC;IACxB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,MAAM,EAAE,OAAO,CAAC;gBAGd,UAAU,UAAO,EACjB,YAAY,UAAO,EACnB,cAAc,UAAO,EACrB,iBAAiB,UAAO,EACxB,MAAM,UAAQ;CAQjB;AAED,qBAAa,aAAa;IACxB,WAAW,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,WAAW,EAAE,MAAM,MAAM,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,iBAAiB,CAAC;IAC/B,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;gBAED,EACV,WAAW,EACX,WAAqB,EACrB,SAAqB,EACrB,WAAqC,EACrC,UAAiC,EACjC,QAAiC,EACjC,KAA6B,EAC7B,MAAkB,EAClB,SAAqB,EACrB,IAAkB,EAClB,IAAW,GACZ,EAAE;QACD,WAAW,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QAChD,WAAW,CAAC,EAAE,MAAM,MAAM,CAAC;QAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,WAAW,CAAC,EAAE,iBAAiB,CAAC;QAChC,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CAaF;AAED,cAAM,SAAS;IACb,GAAG,EAAE,GAAG,CAAC;IACT,UAAU,EAAE,UAAU,CAAC;gBAEX,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,UAAU;CAI7C;AAED,KAAK,cAAc,GAAG;IAGpB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC;AAEF,cAAM,iBAAiB;IACrB,OAAO,0BAEJ;IACH,OAAO,CAAC,GAAG,EAAE,cAAc;CAG5B;AAED,qBAAa,MAAM;;IACjB,IAAI,EAAE,aAAa,CAAC;IAEpB,OAAO,EAAE,SAAS,GAAG,SAAS,CAAa;IAC3C,MAAM,UAAS;IACf,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,uCAA0B;IAChC,KAAK,wBAAsB;IAC3B,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG;YAAE,KAAK,EAAE,iBAAiB,CAAA;SAAE,CAAA;KAAE,CAAM;IAC7D,SAAS,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG;YAAE,IAAI,EAAE,UAAU,CAAC;YAAC,SAAS,EAAE,SAAS,CAAA;SAAE,CAAA;KAAE,CAAM;gBAEjE,IAAI,EAAE,aAAa;IAS/B,IAAI,EAAE,IAAI,MAAM,CAEf;IAEK,GAAG;IAoDT,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM;IAc1D,KAAK,CAAC,EAAE,EAAE,SAAS;IA4Fb,YAAY,CAAC,GAAG,EAAE,mBAAmB;IAsDrC,KAAK;CAUZ"}
+{"version":3,"file":"worker.d.ts","sourceRoot":"","sources":["../src/worker.ts"],"names":[],"mappings":";AAGA,OAAO,KAAK,EAIV,WAAW,EACZ,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAEL,OAAO,EAKR,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAMtC,OAAO,KAAK,EAAsB,UAAU,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAStC,iGAAiG;AACjG,qBAAa,uBAAwB,SAAQ,KAAK;gBACpC,GAAG,CAAC,EAAE,MAAM;CAIzB;AAED,sCAAsC;AACtC,qBAAa,WAAY,SAAQ,KAAK;gBACxB,GAAG,CAAC,EAAE,MAAM;CAIzB;AAED,gBAAgB;AAChB,eAAO,MAAM,4BAA4B,MAAO,UAAU,eAAM,CAAC;AA+BjE,6EAA6E;AAC7E,qBAAa,iBAAiB;IAC5B,UAAU,EAAE,OAAO,CAAC;IACpB,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,OAAO,CAAC;IACxB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,iBAAiB,EAAE,WAAW,EAAE,CAAC;IACjC,MAAM,EAAE,OAAO,CAAC;gBAGd,UAAU,UAAO,EACjB,YAAY,UAAO,EACnB,cAAc,UAAO,EACrB,iBAAiB,UAAO,EACxB,iBAAiB,GAAE,WAAW,EAAO,EACrC,MAAM,UAAQ;CASjB;AAED;;;;;;;;GAQG;AACH,qBAAa,aAAa;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,QAAQ,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IAChC,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,wBAAwB,EAAE,MAAM,CAAC;IACjC,WAAW,EAAE,iBAAiB,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IAEjB,qBAAqB;gBACT,EACV,KAAK,EACL,WAAgC,EAChC,QAAyB,EACzB,aAAoB,EACpB,gBAAoB,EACpB,sBAAkC,EAClC,wBAAoC,EACpC,WAAqC,EACrC,SAAc,EACd,UAA4B,EAC5B,QAAiC,EACjC,KAA6B,EAC7B,MAAkB,EAClB,SAAqB,EACrB,IAAkB,EAClB,IAAW,EACX,QAAiB,GAClB,EAAE;QACD;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QACjD,iGAAiG;QACjG,QAAQ,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QACjC,sFAAsF;QACtF,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,sBAAsB,CAAC,EAAE,MAAM,CAAC;QAChC,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC,WAAW,CAAC,EAAE,iBAAiB,CAAC;QAChC,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CAmBF;AAWD;;;;;;;;GAQG;AACH,qBAAa,MAAM;;IAYjB,KAAK,wBAAsB;gBAMf,IAAI,EAAE,aAAa;IA0BzB,GAAG;IA0DT,IAAI,EAAE,IAAI,MAAM,CAEf;IAED,IAAI,UAAU,IAAI,cAAc,EAAE,CAIjC;IAGK,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM;IAwCtB,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,mBAAmB,CAAC,EAAE,MAAM;IAqP1D,KAAK;CAiBZ"}