@voltkit-rtc/client 0.2.0

package/dist/cjs/broadcast.js

@@ -0,0 +1,320 @@
+"use strict";
+/**
+ * Publishing a broadcast stream.
+ *
+ * A broadcast is one publisher and an audience of any size, delivered over
+ * LL-HLS and WebRTC. Publishing is WHIP: one HTTP exchange of SDP, then media
+ * straight to the media server. Viewers need nothing from this package -- they
+ * play the stream's LL-HLS URL in any HLS player.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BroadcastPublisher = exports.WhipError = void 0;
+exports.whipOffer = whipOffer;
+exports.whipEnd = whipEnd;
+const music_js_1 = require("./music.js");
+/** The media server refused, or could not be reached. */
+class WhipError extends Error {
+    status;
+    /**
+     * @param status HTTP status, or 0 when the request never got an answer.
+     */
+    constructor(status, message) {
+        super(message);
+        this.status = status;
+        this.name = 'WhipError';
+    }
+    /**
+     * The publish URL was not accepted: its token is missing, expired, for a
+     * different stream, or the account behind it cannot go on air. The same URL
+     * will be refused again -- get a new one from your backend.
+     */
+    get isRefused() {
+        return this.status === 401 || this.status === 403;
+    }
+}
+exports.WhipError = WhipError;
+const WHIP_TIMEOUT_MS = 15_000;
+/** A browser that never reports "complete" still publishes with what it has. */
+const ICE_GATHER_TIMEOUT_MS = 3_000;
+/** Helper formats that ride along with a codec. Not codecs in their own right. */
+const HELPER_FORMATS = new Set(['video/rtx', 'video/red', 'video/ulpfec', 'video/flexfec-03']);
+/**
+ * Send an SDP offer to a WHIP endpoint and return the answer, plus the session
+ * resource the server names for ending it.
+ */
+async function whipOffer(whipUrl, offerSdp, timeoutMs = WHIP_TIMEOUT_MS) {
+    let res;
+    try {
+        res = await fetch(whipUrl, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/sdp', Accept: 'application/sdp' },
+            body: offerSdp,
+            signal: AbortSignal.timeout(timeoutMs),
+        });
+    }
+    catch (err) {
+        // Never echo the URL: it carries the publish token.
+        const timedOut = err?.name === 'TimeoutError';
+        throw new WhipError(0, timedOut
+            ? 'the media server did not answer in time'
+            : 'could not reach the media server');
+    }
+    const body = await res.text();
+    if (res.status !== 201 && res.status !== 200) {
+        const line = body.split('\n')[0]?.trim().slice(0, 200);
+        throw new WhipError(res.status, line || 'the media server refused the stream');
+    }
+    const location = res.headers.get('Location');
+    // Location may be relative; it is relative to the URL that was posted to.
+    return { answerSdp: body, resource: location ? new URL(location, whipUrl).toString() : null };
+}
+/**
+ * Tell the server the session is over. Best effort: the media server also
+ * notices the connection going away, so a failure here is not an error.
+ */
+async function whipEnd(resource) {
+    try {
+        // keepalive lets it finish when called while the page is being closed.
+        await fetch(resource, { method: 'DELETE', keepalive: true, signal: AbortSignal.timeout(5_000) });
+    }
+    catch {
+        /* the session ends when the connection does */
+    }
+}
+/**
+ * Publishes camera and microphone to one broadcast stream.
+ *
+ * ```ts
+ * const publisher = new BroadcastPublisher(stream.publish.whipUrl);
+ * publisher.on('state', (s) => setState(s));
+ * const media = await publisher.start();
+ * video.srcObject = media;
+ * // ...
+ * await publisher.stop();
+ * ```
+ *
+ * The `whipUrl` comes from your backend (`POST /v1/streams`) and already
+ * carries the publish token. Treat it like a password.
+ */
+class BroadcastPublisher {
+    whipUrl;
+    pc = null;
+    media = null;
+    ownsMedia = false;
+    resource = null;
+    audioSender = null;
+    micTrack = null;
+    /** Present only while music is in use: the broadcast carries one audio track, so the two are mixed. */
+    mixer = null;
+    micOn = true;
+    current = 'idle';
+    listeners = new Map();
+    constructor(whipUrl) {
+        this.whipUrl = whipUrl;
+    }
+    get state() {
+        return this.current;
+    }
+    /** What is being published, for a local preview. */
+    get localStream() {
+        return this.media;
+    }
+    on(event, fn) {
+        let set = this.listeners.get(event);
+        if (!set) {
+            set = new Set();
+            this.listeners.set(event, set);
+        }
+        set.add(fn);
+        return () => set.delete(fn);
+    }
+    emit(event, ...args) {
+        for (const fn of this.listeners.get(event) ?? []) {
+            try {
+                fn(...args);
+            }
+            catch (err) {
+                console.error(`listener for ${event} threw`, err);
+            }
+        }
+    }
+    set(state) {
+        if (this.current === state)
+            return;
+        this.current = state;
+        this.emit('state', state);
+    }
+    /** Go on air. Resolves once the media server has accepted the stream. */
+    async start(options = {}) {
+        if (this.pc)
+            throw new Error('already publishing; call stop() first');
+        this.set('connecting');
+        try {
+            this.ownsMedia = !options.stream;
+            const media = options.stream ?? await navigator.mediaDevices.getUserMedia(options.constraints ?? { audio: true, video: { width: 1280, height: 720 } });
+            this.media = media;
+            const pc = new RTCPeerConnection();
+            this.pc = pc;
+            pc.addEventListener('connectionstatechange', () => {
+                if (this.pc !== pc)
+                    return;
+                if (pc.connectionState === 'connected')
+                    this.set('live');
+                else if (pc.connectionState === 'disconnected')
+                    this.set('interrupted');
+                else if (pc.connectionState === 'failed')
+                    this.set('failed');
+            });
+            this.micTrack = media.getAudioTracks()[0] ?? null;
+            if (options.music) {
+                this.mixer = new music_js_1.AudioMixer(this.micTrack);
+                this.mixer.setMusic(options.music, options.musicOptions);
+            }
+            for (const track of media.getVideoTracks()) {
+                this.preferH264(pc.addTransceiver(track, { direction: 'sendonly', streams: [media] }));
+            }
+            // Always an audio line, even with no microphone, so music can be added
+            // later without renegotiating with the media server.
+            const audio = this.mixer?.track ?? this.micTrack;
+            const transceiver = audio
+                ? pc.addTransceiver(audio, { direction: 'sendonly', streams: [media] })
+                : pc.addTransceiver('audio', { direction: 'sendonly' });
+            this.audioSender = transceiver.sender;
+            await pc.setLocalDescription(await pc.createOffer());
+            await iceGathered(pc);
+            const offerSdp = pc.localDescription?.sdp;
+            if (!offerSdp)
+                throw new WhipError(0, 'could not create an offer in this browser');
+            const answer = await whipOffer(this.whipUrl, offerSdp);
+            this.resource = answer.resource;
+            await pc.setRemoteDescription({ type: 'answer', sdp: answer.answerSdp });
+            return media;
+        }
+        catch (err) {
+            this.teardown();
+            this.set('failed');
+            throw err;
+        }
+    }
+    /**
+     * Put H.264 first, and offer nothing else for video.
+     *
+     * The media server repackages H.264 into HLS untouched. Any other codec
+     * makes it decode and re-encode every frame, which is the entire cost of a
+     * stream -- so a publisher that negotiates VP8 works, and quietly costs many
+     * times more.
+     */
+    preferH264(transceiver) {
+        try {
+            const all = RTCRtpSender.getCapabilities('video')?.codecs ?? [];
+            const h264 = all.filter((c) => c.mimeType.toLowerCase() === 'video/h264');
+            if (h264.length === 0) {
+                this.emit('warning', 'H.264 is not available in this browser; the stream will be transcoded');
+                return;
+            }
+            const helpers = all.filter((c) => HELPER_FORMATS.has(c.mimeType.toLowerCase()));
+            transceiver.setCodecPreferences([...h264, ...helpers]);
+        }
+        catch (err) {
+            this.emit('warning', `could not prefer H.264 (${err.message}); the stream may be transcoded`);
+        }
+    }
+    /** Mute or unmute the microphone without leaving the air. Music keeps playing. */
+    setMicEnabled(enabled) {
+        this.micOn = enabled;
+        if (this.mixer)
+            this.mixer.setMicEnabled(enabled);
+        else if (this.micTrack)
+            this.micTrack.enabled = enabled;
+    }
+    /**
+     * Put music from inside the page on air, mixed with the microphone.
+     *
+     * A broadcast carries a single audio track, so the two are mixed here, in
+     * the browser, before they are sent. The music never passes through the
+     * microphone, so the audience hears it clean, and each has its own switch:
+     * `setMusicEnabled` and `setMicEnabled`.
+     */
+    async setMusic(input, options) {
+        if (!this.pc || !this.audioSender)
+            throw new Error('start() the broadcast before adding music');
+        if (!this.mixer) {
+            this.mixer = new music_js_1.AudioMixer(this.micTrack);
+            // The raw track was being sent until now; its own switch no longer applies.
+            if (this.micTrack)
+                this.micTrack.enabled = true;
+            this.mixer.setMicEnabled(this.micOn);
+            await this.audioSender.replaceTrack(this.mixer.track);
+        }
+        this.mixer.setMusic(input, options);
+    }
+    /** Switch the music off or on for the audience. The microphone is untouched. */
+    setMusicEnabled(enabled) {
+        this.mixer?.setMusicEnabled(enabled);
+    }
+    /** 0 to 1, for the audience. */
+    setMusicVolume(volume) {
+        this.mixer?.setMusicVolume(volume);
+    }
+    /** Take the music off air. The microphone carries on. */
+    clearMusic() {
+        this.mixer?.clearMusic();
+    }
+    get musicEnabled() {
+        return this.mixer?.musicEnabled ?? false;
+    }
+    get micEnabled() {
+        return this.micOn && this.micTrack !== null;
+    }
+    /** Turn the camera on or off without leaving the air. */
+    setCamEnabled(enabled) {
+        for (const t of this.media?.getVideoTracks() ?? [])
+            t.enabled = enabled;
+    }
+    /** Go off air and release the camera and microphone. Idempotent. */
+    async stop() {
+        const resource = this.resource;
+        this.teardown();
+        if (resource)
+            await whipEnd(resource);
+        this.set('stopped');
+    }
+    teardown() {
+        const { pc, media } = this;
+        this.pc = null;
+        this.media = null;
+        this.resource = null;
+        this.audioSender = null;
+        this.micTrack = null;
+        this.mixer?.close();
+        this.mixer = null;
+        this.micOn = true;
+        pc?.close();
+        if (this.ownsMedia && media)
+            for (const t of media.getTracks())
+                t.stop();
+    }
+}
+exports.BroadcastPublisher = BroadcastPublisher;
+/**
+ * WHIP sends one complete offer, so the candidates have to be in it before it
+ * is sent.
+ */
+function iceGathered(pc) {
+    if (pc.iceGatheringState === 'complete')
+        return Promise.resolve();
+    return new Promise((resolve) => {
+        const done = () => {
+            clearTimeout(timer);
+            pc.removeEventListener('icegatheringstatechange', check);
+            resolve();
+        };
+        const check = () => {
+            if (pc.iceGatheringState === 'complete')
+                done();
+        };
+        const timer = setTimeout(done, ICE_GATHER_TIMEOUT_MS);
+        pc.addEventListener('icegatheringstatechange', check);
+    });
+}
+//# sourceMappingURL=broadcast.js.map

package/dist/cjs/broadcast.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"broadcast.js","sourceRoot":"","sources":["../../src/broadcast.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAiEH,8BA4BC;AAMD,0BAOC;AAxGD,yCAA4E;AAE5E,yDAAyD;AACzD,MAAa,SAAU,SAAQ,KAAK;IAIb;IAHrB;;OAEG;IACH,YAAqB,MAAc,EAAE,OAAe;QAClD,KAAK,CAAC,OAAO,CAAC,CAAC;QADI,WAAM,GAAN,MAAM,CAAQ;QAEjC,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,CAAC;IACpD,CAAC;CACF;AAjBD,8BAiBC;AAiCD,MAAM,eAAe,GAAG,MAAM,CAAC;AAC/B,gFAAgF;AAChF,MAAM,qBAAqB,GAAG,KAAK,CAAC;AACpC,kFAAkF;AAClF,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,kBAAkB,CAAC,CAAC,CAAC;AAE/F;;;GAGG;AACI,KAAK,UAAU,SAAS,CAC7B,OAAe,EACf,QAAgB,EAChB,SAAS,GAAG,eAAe;IAE3B,IAAI,GAAa,CAAC;IAClB,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE;YACzB,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,EAAE,iBAAiB,EAAE;YACzE,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC;SACvC,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,oDAAoD;QACpD,MAAM,QAAQ,GAAI,GAAa,EAAE,IAAI,KAAK,cAAc,CAAC;QACzD,MAAM,IAAI,SAAS,CAAC,CAAC,EAAE,QAAQ;YAC7B,CAAC,CAAC,yCAAyC;YAC3C,CAAC,CAAC,kCAAkC,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IAC9B,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QACvD,MAAM,IAAI,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,IAAI,qCAAqC,CAAC,CAAC;IACjF,CAAC;IACD,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC7C,0EAA0E;IAC1E,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAChG,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,OAAO,CAAC,QAAgB;IAC5C,IAAI,CAAC;QACH,uEAAuE;QACvE,MAAM,KAAK,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACnG,CAAC;IAAC,MAAM,CAAC;QACP,+CAA+C;IACjD,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,kBAAkB;IAaA;IAZrB,EAAE,GAA6B,IAAI,CAAC;IACpC,KAAK,GAAuB,IAAI,CAAC;IACjC,SAAS,GAAG,KAAK,CAAC;IAClB,QAAQ,GAAkB,IAAI,CAAC;IAC/B,WAAW,GAAwB,IAAI,CAAC;IACxC,QAAQ,GAA4B,IAAI,CAAC;IACjD,uGAAuG;IAC/F,KAAK,GAAsB,IAAI,CAAC;IAChC,KAAK,GAAG,IAAI,CAAC;IACb,OAAO,GAAmB,MAAM,CAAC;IACxB,SAAS,GAAG,IAAI,GAAG,EAAwB,CAAC;IAE7D,YAA6B,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAAG,CAAC;IAEhD,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,oDAAoD;IACpD,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,EAAE,CAAkC,KAAQ,EAAE,EAAsB;QAClE,IAAI,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;YAChB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QACjC,CAAC;QACD,GAAG,CAAC,GAAG,CAAC,EAAa,CAAC,CAAC;QACvB,OAAO,GAAG,EAAE,CAAC,GAAI,CAAC,MAAM,CAAC,EAAa,CAAC,CAAC;IAC1C,CAAC;IAEO,IAAI,CAAkC,KAAQ,EAAE,GAAG,IAAoC;QAC7F,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;YACjD,IAAI,CAAC;gBACF,EAAgC,CAAC,GAAG,IAAI,CAAC,CAAC;YAC7C,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,gBAAgB,KAAK,QAAQ,EAAE,GAAG,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;IACH,CAAC;IAEO,GAAG,CAAC,KAAqB;QAC/B,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK;YAAE,OAAO;QACnC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED,yEAAyE;IACzE,KAAK,CAAC,KAAK,CAAC,UAAiC,EAAE;QAC7C,IAAI,IAAI,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QACtE,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACvB,IAAI,CAAC;YACH,IAAI,CAAC,SAAS,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC;YACjC,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,IAAI,MAAM,SAAS,CAAC,YAAY,CAAC,YAAY,CACvE,OAAO,CAAC,WAAW,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAC5E,CAAC;YACF,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YAEnB,MAAM,EAAE,GAAG,IAAI,iBAAiB,EAAE,CAAC;YACnC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;YACb,EAAE,CAAC,gBAAgB,CAAC,uBAAuB,EAAE,GAAG,EAAE;gBAChD,IAAI,IAAI,CAAC,EAAE,KAAK,EAAE;oBAAE,OAAO;gBAC3B,IAAI,EAAE,CAAC,eAAe,KAAK,WAAW;oBAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;qBACpD,IAAI,EAAE,CAAC,eAAe,KAAK,cAAc;oBAAE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;qBACnE,IAAI,EAAE,CAAC,eAAe,KAAK,QAAQ;oBAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC/D,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;YAClD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;gBAClB,IAAI,CAAC,KAAK,GAAG,IAAI,qBAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC3C,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;YAC3D,CAAC;YACD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,cAAc,EAAE,EAAE,CAAC;gBAC3C,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,cAAc,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;YACzF,CAAC;YACD,uEAAuE;YACvE,qDAAqD;YACrD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC;YACjD,MAAM,WAAW,GAAG,KAAK;gBACvB,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvE,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC,CAAC;YAC1D,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC;YAEtC,MAAM,EAAE,CAAC,mBAAmB,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YACrD,MAAM,WAAW,CAAC,EAAE,CAAC,CAAC;YACtB,MAAM,QAAQ,GAAG,EAAE,CAAC,gBAAgB,EAAE,GAAG,CAAC;YAC1C,IAAI,CAAC,QAAQ;gBAAE,MAAM,IAAI,SAAS,CAAC,CAAC,EAAE,2CAA2C,CAAC,CAAC;YAEnF,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YACvD,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;YAChC,MAAM,EAAE,CAAC,oBAAoB,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;YACzE,OAAO,KAAK,CAAC;QACf,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACnB,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACK,UAAU,CAAC,WAA8B;QAC/C,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,YAAY,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,MAAM,IAAI,EAAE,CAAC;YAChE,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,YAAY,CAAC,CAAC;YAC1E,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACtB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,uEAAuE,CAAC,CAAC;gBAC9F,OAAO;YACT,CAAC;YACD,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;YAChF,WAAW,CAAC,mBAAmB,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;QACzD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,2BAA4B,GAAa,CAAC,OAAO,iCAAiC,CAAC,CAAC;QAC3G,CAAC;IACH,CAAC;IAED,kFAAkF;IAClF,aAAa,CAAC,OAAgB;QAC5B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC;QACrB,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;aAC7C,IAAI,IAAI,CAAC,QAAQ;YAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ,CAAC,KAAiB,EAAE,OAAsB;QACtD,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW;YAAE,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAChG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAChB,IAAI,CAAC,KAAK,GAAG,IAAI,qBAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC3C,4EAA4E;YAC5E,IAAI,IAAI,CAAC,QAAQ;gBAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;YAChD,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrC,MAAM,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;IAED,gFAAgF;IAChF,eAAe,CAAC,OAAgB;QAC9B,IAAI,CAAC,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,gCAAgC;IAChC,cAAc,CAAC,MAAc;QAC3B,IAAI,CAAC,KAAK,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED,yDAAyD;IACzD,UAAU;QACR,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,CAAC;IAC3B,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,KAAK,EAAE,YAAY,IAAI,KAAK,CAAC;IAC3C,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC;IAC9C,CAAC;IAED,yDAAyD;IACzD,aAAa,CAAC,OAAgB;QAC5B,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE;YAAE,CAAC,CAAC,OAAO,GAAG,OAAO,CAAC;IAC1E,CAAC;IAED,oEAAoE;IACpE,KAAK,CAAC,IAAI;QACR,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,IAAI,QAAQ;YAAE,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC;QACtC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACtB,CAAC;IAEO,QAAQ;QACd,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAC3B,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,EAAE,EAAE,KAAK,EAAE,CAAC;QACZ,IAAI,IAAI,CAAC,SAAS,IAAI,KAAK;YAAE,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,SAAS,EAAE;gBAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC3E,CAAC;CACF;AAzMD,gDAyMC;AAED;;;GAGG;AACH,SAAS,WAAW,CAAC,EAAqB;IACxC,IAAI,EAAE,CAAC,iBAAiB,KAAK,UAAU;QAAE,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAClE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,IAAI,GAAG,GAAG,EAAE;YAChB,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,EAAE,CAAC,mBAAmB,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;YACzD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACF,MAAM,KAAK,GAAG,GAAG,EAAE;YACjB,IAAI,EAAE,CAAC,iBAAiB,KAAK,UAAU;gBAAE,IAAI,EAAE,CAAC;QAClD,CAAC,CAAC;QACF,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;QACtD,EAAE,CAAC,gBAAgB,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/cjs/chat.d.ts

@@ -0,0 +1,138 @@
+/**
+ * Chat for the orchestrator's signaling protocol.
+ *
+ * A channel shares its name with the room of the same name, so there are two
+ * ways into one conversation: `StreamClient` carries chat over the socket it
+ * already holds for media, and `ChatClient` here opens a socket that carries
+ * nothing else -- for an audience that is watching a broadcast over a CDN and
+ * has no reason to be on an SFU.
+ */
+import type { Role } from './index.js';
+export interface ChatMessage {
+    /** Monotonic within a channel, so the oldest id held is a paging cursor. */
+    id: string;
+    channel: string;
+    from: string;
+    /** Present on a direct message, which only its two ends receive. */
+    to?: string;
+    /** "text" unless the sender said otherwise. Anything else is the app's own. */
+    type: string;
+    /**
+     * Delivered exactly as sent. Render it as text, never as HTML: escaping is
+     * the renderer's job and the server does not do it for you.
+     */
+    text?: string;
+    metadata?: unknown;
+    /** Echoed from the sender, to match an optimistic message to the real one. */
+    clientMsgId?: string;
+    ts: number;
+}
+export interface SendMessageOptions {
+    type?: string;
+    /** Make it a direct message to one identity. */
+    to?: string;
+    metadata?: unknown;
+    clientMsgId?: string;
+    /** Delivered and not stored: reactions, hearts, anything not worth replaying. */
+    ephemeral?: boolean;
+}
+export interface ChatState {
+    channel: string;
+    /** Distinct identities connected, in the room or only in its chat. */
+    members: number;
+    /** Whether a moderator has muted THIS identity. */
+    muted: boolean;
+    /** Only present for moderators. */
+    mutedIdentities?: string[];
+}
+export interface ChatJoinResult {
+    channel: string;
+    identity: string;
+    role: Role;
+    members: number;
+    muted: boolean;
+    /** The most recent messages, oldest first. */
+    messages: ChatMessage[];
+}
+export interface ChatEvents {
+    message: (m: ChatMessage) => void;
+    messageDeleted: (e: {
+        id: string;
+        by: string;
+    }) => void;
+    chatMuted: (e: {
+        identity: string;
+        muted: boolean;
+        by: string;
+    }) => void;
+    typing: (e: {
+        identity: string;
+        typing: boolean;
+    }) => void;
+}
+export interface ChatClientEvents extends ChatEvents {
+    connected: () => void;
+    disconnected: (reason: string) => void;
+    joined: (result: ChatJoinResult) => void;
+    error: (err: Error) => void;
+    /** The session ended and will not recover. Nothing further will be emitted. */
+    closed: (reason: 'gave-up' | 'left' | 'ended') => void;
+    /** The account behind this connection ran out; see StreamClient's event. */
+    usageLimit: (e: {
+        reason: string;
+        graceSeconds: number;
+        endsAt: number;
+    }) => void;
+}
+/** An error returned by the server, carrying its machine-readable code. */
+export declare class ChatRpcError extends Error {
+    readonly code: string;
+    constructor(code: string, message: string);
+}
+/**
+ * A chat-only connection. Takes the `wsUrl` and `token` returned by
+ * `POST /v1/chat/{channel}/tokens`.
+ */
+export declare class ChatClient {
+    private readonly wsUrl;
+    private ws;
+    private readonly pending;
+    private readonly listeners;
+    private nextId;
+    private token;
+    private joinResult;
+    private closedByUs;
+    private reconnecting;
+    private reconnectAttempt;
+    constructor(wsUrl: string, token: string);
+    on<K extends keyof ChatClientEvents>(event: K, fn: ChatClientEvents[K]): () => void;
+    private emit;
+    /** What join returned, including the history the channel had at that moment. */
+    get info(): ChatJoinResult | null;
+    connect(): Promise<ChatJoinResult>;
+    private openSocket;
+    private detachSocket;
+    /** Single-flight, with backoff: the same shape as the room client's. */
+    private scheduleReconnect;
+    close(): void;
+    private rpc;
+    private failAllPending;
+    private onMessage;
+    sendMessage(text: string, opts?: SendMessageOptions): Promise<{
+        id: string;
+        ts: number;
+    }>;
+    /** Older messages, oldest first. Pass the oldest id you hold as `before`. */
+    getMessages(opts?: {
+        limit?: number;
+        before?: string;
+    }): Promise<ChatMessage[]>;
+    /** Your own message, or anyone's if you are a moderator. */
+    deleteMessage(messageId: string): Promise<unknown>;
+    /** Moderators only. A mute outlasts the muted socket reconnecting. */
+    muteChat(identity: string, muted?: boolean): Promise<unknown>;
+    /** Advisory, and throttled by the server; safe to call on every keystroke. */
+    setTyping(typing: boolean): Promise<unknown>;
+    getChatState(): Promise<ChatState>;
+}
+//# sourceMappingURL=chat.d.ts.map

package/dist/cjs/chat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chat.d.ts","sourceRoot":"","sources":["../../src/chat.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAEvC,MAAM,WAAW,WAAW;IAC1B,4EAA4E;IAC5E,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,oEAAoE;IACpE,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,8EAA8E;IAC9E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gDAAgD;IAChD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iFAAiF;IACjF,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,sEAAsE;IACtE,OAAO,EAAE,MAAM,CAAC;IAChB,mDAAmD;IACnD,KAAK,EAAE,OAAO,CAAC;IACf,mCAAmC;IACnC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,IAAI,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,OAAO,CAAC;IACf,8CAA8C;IAC9C,QAAQ,EAAE,WAAW,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,CAAC,CAAC,EAAE,WAAW,KAAK,IAAI,CAAC;IAClC,cAAc,EAAE,CAAC,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IACxD,SAAS,EAAE,CAAC,CAAC,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,OAAO,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IACzE,MAAM,EAAE,CAAC,CAAC,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,CAAC;CAC5D;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACvC,MAAM,EAAE,CAAC,MAAM,EAAE,cAAc,KAAK,IAAI,CAAC;IACzC,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAI,CAAC;IAC5B,+EAA+E;IAC/E,MAAM,EAAE,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO,KAAK,IAAI,CAAC;IACvD,4EAA4E;IAC5E,UAAU,EAAE,CAAC,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;CACnF;AAED,2EAA2E;AAC3E,qBAAa,YAAa,SAAQ,KAAK;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM;gBAAZ,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAInD;AAyBD;;;GAGG;AACH,qBAAa,UAAU;IAWT,OAAO,CAAC,QAAQ,CAAC,KAAK;IAVlC,OAAO,CAAC,EAAE,CAA0B;IACpC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA8B;IACtD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAmC;IAC7D,OAAO,CAAC,MAAM,CAAK;IACnB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,UAAU,CAA+B;IACjD,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,gBAAgB,CAAK;gBAEA,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAIzD,EAAE,CAAC,CAAC,SAAS,MAAM,gBAAgB,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI;IAUnF,OAAO,CAAC,IAAI;IAUZ,gFAAgF;IAChF,IAAI,IAAI,IAAI,cAAc,GAAG,IAAI,CAEhC;IAEK,OAAO,IAAI,OAAO,CAAC,cAAc,CAAC;IAQxC,OAAO,CAAC,UAAU;IAoClB,OAAO,CAAC,YAAY;IAYpB,wEAAwE;YAC1D,iBAAiB;IAgC/B,KAAK,IAAI,IAAI;IASb,OAAO,CAAC,GAAG;IAgBX,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,SAAS;IA+CjB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,kBAAuB,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC;IAI7F,6EAA6E;IACvE,WAAW,CAAC,IAAI,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAKzF,4DAA4D;IAC5D,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlD,sEAAsE;IACtE,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,UAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAI1D,8EAA8E;IAC9E,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAI5C,YAAY,IAAI,OAAO,CAAC,SAAS,CAAC;CAGnC"}