@tribe-nest/media-protocol 1.0.0

package/build/frames.d.ts

@@ -0,0 +1,1291 @@
+import { z } from "zod";
+/**
+ * The client <-> node signalling wire.
+ *
+ * One envelope, stated once. Six phase plans independently invented four
+ * different ones (`m` / `type` / `method` / `action`, numeric versus string
+ * ids, `result` versus `data`), and every mismatch is a hard parse failure
+ * discovered at integration by a different pair of people.
+ *
+ * ## Shape
+ *
+ * Requests carry an `id` and get exactly one reply with the same `id`. Events
+ * carry no `id` and are never replied to. That is the whole protocol; anything
+ * needing more structure is a request that returns a handle.
+ *
+ * ## What is deliberately NOT here
+ *
+ * No pipe verb, no node id, no mesh address. A client cannot express "pipe this
+ * producer to that node", because piping is a side effect of `consume` and the
+ * only way to keep it lazy is for eager piping to be unsayable.
+ */
+export declare const requestFrameSchema: z.ZodDiscriminatedUnion<"method", [z.ZodObject<{
+    method: z.ZodLiteral<"join">;
+    id: z.ZodNumber;
+    protocolVersion: z.ZodNumber;
+    /** The token travels in the first frame, NEVER in the URL: a query string
+     * lands in load-balancer access logs, and a join ticket in a log is a join
+     * ticket for anyone who can read logs. */
+    token: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    method: "join";
+    id: number;
+    protocolVersion: number;
+    token: string;
+}, {
+    method: "join";
+    id: number;
+    protocolVersion: number;
+    token: string;
+}>, z.ZodObject<{
+    method: z.ZodLiteral<"createTransport">;
+    id: z.ZodNumber;
+    direction: z.ZodEnum<["send", "recv"]>;
+    /**
+     * Deliberately absent: which KIND of transport this is.
+     *
+     * The kind comes from the token's `transport` claim and from nowhere else.
+     * Letting a client ask would mean a browser holding a valid join token
+     * could request a PlainTransport pointed at an address of its choosing -
+     * an RTP reflector, plus an unauthenticated publish path into whatever room
+     * the token names. Three phases independently needed to refuse that and
+     * none could, because nothing carried the fact.
+     *
+     * So there is no field here to refuse. The claim decides.
+     */
+    sctp: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    method: "createTransport";
+    id: number;
+    direction: "send" | "recv";
+    sctp?: boolean | undefined;
+}, {
+    method: "createTransport";
+    id: number;
+    direction: "send" | "recv";
+    sctp?: boolean | undefined;
+}>, z.ZodObject<{
+    method: z.ZodLiteral<"connectTransport">;
+    id: z.ZodNumber;
+    transportId: z.ZodString;
+    /** WebRTC. */
+    dtlsParameters: z.ZodOptional<z.ZodUnknown>;
+    /**
+     * Plain and pipe transports have no DTLS handshake to carry the address, so
+     * a server-side participant names where its RTP comes from. This is the
+     * half the token claim cannot cover: the claim says WHO may create a plain
+     * transport, and `MEDIA_SERVER_PEER_CIDRS` says WHERE its media may be
+     * pointed. Both are required; either alone leaves a reflector.
+     */
+    ip: z.ZodOptional<z.ZodString>;
+    port: z.ZodOptional<z.ZodNumber>;
+    rtcpPort: z.ZodOptional<z.ZodNumber>;
+    srtpParameters: z.ZodOptional<z.ZodUnknown>;
+}, "strip", z.ZodTypeAny, {
+    method: "connectTransport";
+    id: number;
+    transportId: string;
+    dtlsParameters?: unknown;
+    ip?: string | undefined;
+    port?: number | undefined;
+    rtcpPort?: number | undefined;
+    srtpParameters?: unknown;
+}, {
+    method: "connectTransport";
+    id: number;
+    transportId: string;
+    dtlsParameters?: unknown;
+    ip?: string | undefined;
+    port?: number | undefined;
+    rtcpPort?: number | undefined;
+    srtpParameters?: unknown;
+}>, z.ZodObject<{
+    method: z.ZodLiteral<"produce">;
+    id: z.ZodNumber;
+    transportId: z.ZodString;
+    kind: z.ZodEnum<["audio", "video"]>;
+    /** Opaque to this package: only mediasoup interprets it. */
+    rtpParameters: z.ZodUnknown;
+    appData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    kind: "audio" | "video";
+    method: "produce";
+    id: number;
+    transportId: string;
+    rtpParameters?: unknown;
+    appData?: Record<string, unknown> | undefined;
+}, {
+    kind: "audio" | "video";
+    method: "produce";
+    id: number;
+    transportId: string;
+    rtpParameters?: unknown;
+    appData?: Record<string, unknown> | undefined;
+}>, z.ZodObject<{
+    method: z.ZodLiteral<"consume">;
+    id: z.ZodNumber;
+    transportId: z.ZodString;
+    producerId: z.ZodString;
+    rtpCapabilities: z.ZodUnknown;
+}, "strip", z.ZodTypeAny, {
+    method: "consume";
+    id: number;
+    transportId: string;
+    producerId: string;
+    rtpCapabilities?: unknown;
+}, {
+    method: "consume";
+    id: number;
+    transportId: string;
+    producerId: string;
+    rtpCapabilities?: unknown;
+}>, z.ZodObject<{
+    method: z.ZodLiteral<"pauseProducer">;
+    id: z.ZodNumber;
+    producerId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    method: "pauseProducer";
+    id: number;
+    producerId: string;
+}, {
+    method: "pauseProducer";
+    id: number;
+    producerId: string;
+}>, z.ZodObject<{
+    method: z.ZodLiteral<"resumeProducer">;
+    id: z.ZodNumber;
+    producerId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    method: "resumeProducer";
+    id: number;
+    producerId: string;
+}, {
+    method: "resumeProducer";
+    id: number;
+    producerId: string;
+}>, z.ZodObject<{
+    method: z.ZodLiteral<"resumeConsumer">;
+    id: z.ZodNumber;
+    consumerId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    method: "resumeConsumer";
+    id: number;
+    consumerId: string;
+}, {
+    method: "resumeConsumer";
+    id: number;
+    consumerId: string;
+}>, z.ZodObject<{
+    method: z.ZodLiteral<"closeConsumer">;
+    id: z.ZodNumber;
+    consumerId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    method: "closeConsumer";
+    id: number;
+    consumerId: string;
+}, {
+    method: "closeConsumer";
+    id: number;
+    consumerId: string;
+}>, z.ZodObject<{
+    method: z.ZodLiteral<"closeProducer">;
+    id: z.ZodNumber;
+    producerId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    method: "closeProducer";
+    id: number;
+    producerId: string;
+}, {
+    method: "closeProducer";
+    id: number;
+    producerId: string;
+}>, z.ZodObject<{
+    method: z.ZodLiteral<"requestKeyFrame">;
+    id: z.ZodNumber;
+    consumerId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    method: "requestKeyFrame";
+    id: number;
+    consumerId: string;
+}, {
+    method: "requestKeyFrame";
+    id: number;
+    consumerId: string;
+}>, z.ZodObject<{
+    method: z.ZodLiteral<"leave">;
+    id: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    method: "leave";
+    id: number;
+}, {
+    method: "leave";
+    id: number;
+}>]>;
+export type RequestFrame = z.infer<typeof requestFrameSchema>;
+export type RequestMethod = RequestFrame["method"];
+export declare const responseFrameSchema: z.ZodUnion<[z.ZodObject<{
+    id: z.ZodNumber;
+    ok: z.ZodLiteral<true>;
+    data: z.ZodUnknown;
+}, "strip", z.ZodTypeAny, {
+    id: number;
+    ok: true;
+    data?: unknown;
+}, {
+    id: number;
+    ok: true;
+    data?: unknown;
+}>, z.ZodObject<{
+    id: z.ZodNumber;
+    ok: z.ZodLiteral<false>;
+    /** The client sees a CODE, never why a token was refused. Telling a caller
+     * whether the signature or the room was wrong turns this into an oracle. */
+    code: z.ZodEnum<["unauthorized", "replayed", "protocol_version", "forbidden_transport", "forbidden", "not_subscribable", "subscription_limit", "room_closed", "no_such_room", "no_such_producer", "no_such_transport", "duplicate_identity", "node_draining", "capacity", "bad_request", "internal"]>;
+    message: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    code: "unauthorized" | "replayed" | "protocol_version" | "forbidden_transport" | "forbidden" | "not_subscribable" | "subscription_limit" | "room_closed" | "no_such_room" | "no_such_producer" | "no_such_transport" | "duplicate_identity" | "node_draining" | "capacity" | "bad_request" | "internal";
+    id: number;
+    ok: false;
+    message?: string | undefined;
+}, {
+    code: "unauthorized" | "replayed" | "protocol_version" | "forbidden_transport" | "forbidden" | "not_subscribable" | "subscription_limit" | "room_closed" | "no_such_room" | "no_such_producer" | "no_such_transport" | "duplicate_identity" | "node_draining" | "capacity" | "bad_request" | "internal";
+    id: number;
+    ok: false;
+    message?: string | undefined;
+}>]>;
+export type ResponseFrame = z.infer<typeof responseFrameSchema>;
+/** A participant as everyone else sees them. Grants are NOT included: what
+ * someone else is permitted to do is not the room's business. */
+export declare const peerSchema: z.ZodObject<{
+    identity: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    kind: z.ZodEnum<["human", "agent", "egress", "sip", "ingress"]>;
+}, "strip", z.ZodTypeAny, {
+    identity: string;
+    kind: "human" | "agent" | "egress" | "sip" | "ingress";
+    name?: string | undefined;
+}, {
+    identity: string;
+    kind: "human" | "agent" | "egress" | "sip" | "ingress";
+    name?: string | undefined;
+}>;
+export type Peer = z.infer<typeof peerSchema>;
+export declare const eventFrameSchema: z.ZodDiscriminatedUnion<"event", [z.ZodObject<{
+    event: z.ZodLiteral<"joined">;
+    identity: z.ZodString;
+    room: z.ZodString;
+    /** Everything the client needs to build its device before any transport. */
+    routerRtpCapabilities: z.ZodUnknown;
+    peers: z.ZodArray<z.ZodObject<{
+        identity: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        kind: z.ZodEnum<["human", "agent", "egress", "sip", "ingress"]>;
+    }, "strip", z.ZodTypeAny, {
+        identity: string;
+        kind: "human" | "agent" | "egress" | "sip" | "ingress";
+        name?: string | undefined;
+    }, {
+        identity: string;
+        kind: "human" | "agent" | "egress" | "sip" | "ingress";
+        name?: string | undefined;
+    }>, "many">;
+    /** Producers this participant is ALLOWED to see. The barrier is applied to
+     * the snapshot, not only at consume: an identity it may not receive must
+     * not be discoverable either. */
+    producers: z.ZodArray<z.ZodObject<{
+        producerId: z.ZodString;
+        identity: z.ZodString;
+        kind: z.ZodEnum<["audio", "video"]>;
+    }, "strip", z.ZodTypeAny, {
+        identity: string;
+        kind: "audio" | "video";
+        producerId: string;
+    }, {
+        identity: string;
+        kind: "audio" | "video";
+        producerId: string;
+    }>, "many">;
+    iceServers: z.ZodArray<z.ZodObject<{
+        urls: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+        username: z.ZodOptional<z.ZodString>;
+        credential: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        urls: string | string[];
+        username?: string | undefined;
+        credential?: string | undefined;
+    }, {
+        urls: string | string[];
+        username?: string | undefined;
+        credential?: string | undefined;
+    }>, "many">;
+    /** True while any `kind: "egress"` participant is present. A consent
+     * requirement, not a nicety. */
+    recording: z.ZodBoolean;
+    /**
+     * What this token was minted with, echoed back.
+     *
+     * The client already holds the token but must not parse it: a signed blob
+     * a client reads is a signed blob a client eventually trusts its own
+     * reading of. This is the node's understanding of the grants, which is the
+     * one that will actually be enforced, so a UI built from it cannot offer a
+     * control the node is about to refuse.
+     */
+    grants: z.ZodOptional<z.ZodObject<{
+        canPublish: z.ZodBoolean;
+        canSubscribe: z.ZodBoolean;
+        canPublishData: z.ZodBoolean;
+        subscribe: z.ZodOptional<z.ZodDiscriminatedUnion<"mode", [z.ZodObject<{
+            mode: z.ZodLiteral<"all">;
+        }, "strict", z.ZodTypeAny, {
+            mode: "all";
+        }, {
+            mode: "all";
+        }>, z.ZodObject<{
+            mode: z.ZodLiteral<"none">;
+        }, "strict", z.ZodTypeAny, {
+            mode: "none";
+        }, {
+            mode: "none";
+        }>, z.ZodObject<{
+            mode: z.ZodLiteral<"allow">;
+            identities: z.ZodArray<z.ZodString, "many">;
+        }, "strict", z.ZodTypeAny, {
+            mode: "allow";
+            identities: string[];
+        }, {
+            mode: "allow";
+            identities: string[];
+        }>, z.ZodObject<{
+            mode: z.ZodLiteral<"deny">;
+            identities: z.ZodArray<z.ZodString, "many">;
+        }, "strict", z.ZodTypeAny, {
+            mode: "deny";
+            identities: string[];
+        }, {
+            mode: "deny";
+            identities: string[];
+        }>]>>;
+        visibleTo: z.ZodOptional<z.ZodDiscriminatedUnion<"mode", [z.ZodObject<{
+            mode: z.ZodLiteral<"all">;
+        }, "strict", z.ZodTypeAny, {
+            mode: "all";
+        }, {
+            mode: "all";
+        }>, z.ZodObject<{
+            mode: z.ZodLiteral<"none">;
+        }, "strict", z.ZodTypeAny, {
+            mode: "none";
+        }, {
+            mode: "none";
+        }>, z.ZodObject<{
+            mode: z.ZodLiteral<"allow">;
+            identities: z.ZodArray<z.ZodString, "many">;
+        }, "strict", z.ZodTypeAny, {
+            mode: "allow";
+            identities: string[];
+        }, {
+            mode: "allow";
+            identities: string[];
+        }>, z.ZodObject<{
+            mode: z.ZodLiteral<"deny">;
+            identities: z.ZodArray<z.ZodString, "many">;
+        }, "strict", z.ZodTypeAny, {
+            mode: "deny";
+            identities: string[];
+        }, {
+            mode: "deny";
+            identities: string[];
+        }>]>>;
+        publishKinds: z.ZodOptional<z.ZodArray<z.ZodEnum<["audio", "video", "screen"]>, "many">>;
+        subscribeExempt: z.ZodOptional<z.ZodBoolean>;
+        maxSubscriptions: z.ZodOptional<z.ZodNumber>;
+    }, "strict", z.ZodTypeAny, {
+        canPublish: boolean;
+        canSubscribe: boolean;
+        canPublishData: boolean;
+        subscribe?: {
+            mode: "all";
+        } | {
+            mode: "none";
+        } | {
+            mode: "allow";
+            identities: string[];
+        } | {
+            mode: "deny";
+            identities: string[];
+        } | undefined;
+        visibleTo?: {
+            mode: "all";
+        } | {
+            mode: "none";
+        } | {
+            mode: "allow";
+            identities: string[];
+        } | {
+            mode: "deny";
+            identities: string[];
+        } | undefined;
+        publishKinds?: ("audio" | "video" | "screen")[] | undefined;
+        subscribeExempt?: boolean | undefined;
+        maxSubscriptions?: number | undefined;
+    }, {
+        canPublish: boolean;
+        canSubscribe: boolean;
+        canPublishData: boolean;
+        subscribe?: {
+            mode: "all";
+        } | {
+            mode: "none";
+        } | {
+            mode: "allow";
+            identities: string[];
+        } | {
+            mode: "deny";
+            identities: string[];
+        } | undefined;
+        visibleTo?: {
+            mode: "all";
+        } | {
+            mode: "none";
+        } | {
+            mode: "allow";
+            identities: string[];
+        } | {
+            mode: "deny";
+            identities: string[];
+        } | undefined;
+        publishKinds?: ("audio" | "video" | "screen")[] | undefined;
+        subscribeExempt?: boolean | undefined;
+        maxSubscriptions?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    room: string;
+    identity: string;
+    event: "joined";
+    peers: {
+        identity: string;
+        kind: "human" | "agent" | "egress" | "sip" | "ingress";
+        name?: string | undefined;
+    }[];
+    producers: {
+        identity: string;
+        kind: "audio" | "video";
+        producerId: string;
+    }[];
+    iceServers: {
+        urls: string | string[];
+        username?: string | undefined;
+        credential?: string | undefined;
+    }[];
+    recording: boolean;
+    grants?: {
+        canPublish: boolean;
+        canSubscribe: boolean;
+        canPublishData: boolean;
+        subscribe?: {
+            mode: "all";
+        } | {
+            mode: "none";
+        } | {
+            mode: "allow";
+            identities: string[];
+        } | {
+            mode: "deny";
+            identities: string[];
+        } | undefined;
+        visibleTo?: {
+            mode: "all";
+        } | {
+            mode: "none";
+        } | {
+            mode: "allow";
+            identities: string[];
+        } | {
+            mode: "deny";
+            identities: string[];
+        } | undefined;
+        publishKinds?: ("audio" | "video" | "screen")[] | undefined;
+        subscribeExempt?: boolean | undefined;
+        maxSubscriptions?: number | undefined;
+    } | undefined;
+    routerRtpCapabilities?: unknown;
+}, {
+    room: string;
+    identity: string;
+    event: "joined";
+    peers: {
+        identity: string;
+        kind: "human" | "agent" | "egress" | "sip" | "ingress";
+        name?: string | undefined;
+    }[];
+    producers: {
+        identity: string;
+        kind: "audio" | "video";
+        producerId: string;
+    }[];
+    iceServers: {
+        urls: string | string[];
+        username?: string | undefined;
+        credential?: string | undefined;
+    }[];
+    recording: boolean;
+    grants?: {
+        canPublish: boolean;
+        canSubscribe: boolean;
+        canPublishData: boolean;
+        subscribe?: {
+            mode: "all";
+        } | {
+            mode: "none";
+        } | {
+            mode: "allow";
+            identities: string[];
+        } | {
+            mode: "deny";
+            identities: string[];
+        } | undefined;
+        visibleTo?: {
+            mode: "all";
+        } | {
+            mode: "none";
+        } | {
+            mode: "allow";
+            identities: string[];
+        } | {
+            mode: "deny";
+            identities: string[];
+        } | undefined;
+        publishKinds?: ("audio" | "video" | "screen")[] | undefined;
+        subscribeExempt?: boolean | undefined;
+        maxSubscriptions?: number | undefined;
+    } | undefined;
+    routerRtpCapabilities?: unknown;
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"peerJoined">;
+    peer: z.ZodObject<{
+        identity: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        kind: z.ZodEnum<["human", "agent", "egress", "sip", "ingress"]>;
+    }, "strip", z.ZodTypeAny, {
+        identity: string;
+        kind: "human" | "agent" | "egress" | "sip" | "ingress";
+        name?: string | undefined;
+    }, {
+        identity: string;
+        kind: "human" | "agent" | "egress" | "sip" | "ingress";
+        name?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    event: "peerJoined";
+    peer: {
+        identity: string;
+        kind: "human" | "agent" | "egress" | "sip" | "ingress";
+        name?: string | undefined;
+    };
+}, {
+    event: "peerJoined";
+    peer: {
+        identity: string;
+        kind: "human" | "agent" | "egress" | "sip" | "ingress";
+        name?: string | undefined;
+    };
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"peerLeft">;
+    identity: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    identity: string;
+    event: "peerLeft";
+}, {
+    identity: string;
+    event: "peerLeft";
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"producerAppeared">;
+    producerId: z.ZodString;
+    identity: z.ZodString;
+    kind: z.ZodEnum<["audio", "video"]>;
+}, "strip", z.ZodTypeAny, {
+    identity: string;
+    kind: "audio" | "video";
+    producerId: string;
+    event: "producerAppeared";
+}, {
+    identity: string;
+    kind: "audio" | "video";
+    producerId: string;
+    event: "producerAppeared";
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"producerClosed">;
+    producerId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    producerId: string;
+    event: "producerClosed";
+}, {
+    producerId: string;
+    event: "producerClosed";
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"producerPaused">;
+    producerId: z.ZodString;
+    paused: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    producerId: string;
+    event: "producerPaused";
+    paused: boolean;
+}, {
+    producerId: string;
+    event: "producerPaused";
+    paused: boolean;
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"activeSpeakers">;
+    producerIds: z.ZodArray<z.ZodString, "many">;
+    audio: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    video: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    enforced: z.ZodOptional<z.ZodBoolean>;
+    speakers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        identity: z.ZodString;
+        producerId: z.ZodString;
+        volumeDb: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        identity: string;
+        producerId: string;
+        volumeDb: number;
+    }, {
+        identity: string;
+        producerId: string;
+        volumeDb: number;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    event: "activeSpeakers";
+    producerIds: string[];
+    audio?: string[] | undefined;
+    video?: string[] | undefined;
+    enforced?: boolean | undefined;
+    speakers?: {
+        identity: string;
+        producerId: string;
+        volumeDb: number;
+    }[] | undefined;
+}, {
+    event: "activeSpeakers";
+    producerIds: string[];
+    audio?: string[] | undefined;
+    video?: string[] | undefined;
+    enforced?: boolean | undefined;
+    speakers?: {
+        identity: string;
+        producerId: string;
+        volumeDb: number;
+    }[] | undefined;
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"recordingChanged">;
+    recording: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    event: "recordingChanged";
+    recording: boolean;
+}, {
+    event: "recordingChanged";
+    recording: boolean;
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"draining">;
+    reconnectAfterMs: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    event: "draining";
+    reconnectAfterMs: number;
+}, {
+    event: "draining";
+    reconnectAfterMs: number;
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"roomClosed">;
+    reason: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    event: "roomClosed";
+    reason: string;
+}, {
+    event: "roomClosed";
+    reason: string;
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"subscribeRuleChanged">;
+    subscribe: z.ZodDiscriminatedUnion<"mode", [z.ZodObject<{
+        mode: z.ZodLiteral<"all">;
+    }, "strict", z.ZodTypeAny, {
+        mode: "all";
+    }, {
+        mode: "all";
+    }>, z.ZodObject<{
+        mode: z.ZodLiteral<"none">;
+    }, "strict", z.ZodTypeAny, {
+        mode: "none";
+    }, {
+        mode: "none";
+    }>, z.ZodObject<{
+        mode: z.ZodLiteral<"allow">;
+        identities: z.ZodArray<z.ZodString, "many">;
+    }, "strict", z.ZodTypeAny, {
+        mode: "allow";
+        identities: string[];
+    }, {
+        mode: "allow";
+        identities: string[];
+    }>, z.ZodObject<{
+        mode: z.ZodLiteral<"deny">;
+        identities: z.ZodArray<z.ZodString, "many">;
+    }, "strict", z.ZodTypeAny, {
+        mode: "deny";
+        identities: string[];
+    }, {
+        mode: "deny";
+        identities: string[];
+    }>]>;
+}, "strip", z.ZodTypeAny, {
+    subscribe: {
+        mode: "all";
+    } | {
+        mode: "none";
+    } | {
+        mode: "allow";
+        identities: string[];
+    } | {
+        mode: "deny";
+        identities: string[];
+    };
+    event: "subscribeRuleChanged";
+}, {
+    subscribe: {
+        mode: "all";
+    } | {
+        mode: "none";
+    } | {
+        mode: "allow";
+        identities: string[];
+    } | {
+        mode: "deny";
+        identities: string[];
+    };
+    event: "subscribeRuleChanged";
+}>]>;
+export type EventFrame = z.infer<typeof eventFrameSchema>;
+export type EventName = EventFrame["event"];
+/** Anything arriving from a node. */
+export declare const serverFrameSchema: z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
+    id: z.ZodNumber;
+    ok: z.ZodLiteral<true>;
+    data: z.ZodUnknown;
+}, "strip", z.ZodTypeAny, {
+    id: number;
+    ok: true;
+    data?: unknown;
+}, {
+    id: number;
+    ok: true;
+    data?: unknown;
+}>, z.ZodObject<{
+    id: z.ZodNumber;
+    ok: z.ZodLiteral<false>;
+    /** The client sees a CODE, never why a token was refused. Telling a caller
+     * whether the signature or the room was wrong turns this into an oracle. */
+    code: z.ZodEnum<["unauthorized", "replayed", "protocol_version", "forbidden_transport", "forbidden", "not_subscribable", "subscription_limit", "room_closed", "no_such_room", "no_such_producer", "no_such_transport", "duplicate_identity", "node_draining", "capacity", "bad_request", "internal"]>;
+    message: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    code: "unauthorized" | "replayed" | "protocol_version" | "forbidden_transport" | "forbidden" | "not_subscribable" | "subscription_limit" | "room_closed" | "no_such_room" | "no_such_producer" | "no_such_transport" | "duplicate_identity" | "node_draining" | "capacity" | "bad_request" | "internal";
+    id: number;
+    ok: false;
+    message?: string | undefined;
+}, {
+    code: "unauthorized" | "replayed" | "protocol_version" | "forbidden_transport" | "forbidden" | "not_subscribable" | "subscription_limit" | "room_closed" | "no_such_room" | "no_such_producer" | "no_such_transport" | "duplicate_identity" | "node_draining" | "capacity" | "bad_request" | "internal";
+    id: number;
+    ok: false;
+    message?: string | undefined;
+}>]>, z.ZodDiscriminatedUnion<"event", [z.ZodObject<{
+    event: z.ZodLiteral<"joined">;
+    identity: z.ZodString;
+    room: z.ZodString;
+    /** Everything the client needs to build its device before any transport. */
+    routerRtpCapabilities: z.ZodUnknown;
+    peers: z.ZodArray<z.ZodObject<{
+        identity: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        kind: z.ZodEnum<["human", "agent", "egress", "sip", "ingress"]>;
+    }, "strip", z.ZodTypeAny, {
+        identity: string;
+        kind: "human" | "agent" | "egress" | "sip" | "ingress";
+        name?: string | undefined;
+    }, {
+        identity: string;
+        kind: "human" | "agent" | "egress" | "sip" | "ingress";
+        name?: string | undefined;
+    }>, "many">;
+    /** Producers this participant is ALLOWED to see. The barrier is applied to
+     * the snapshot, not only at consume: an identity it may not receive must
+     * not be discoverable either. */
+    producers: z.ZodArray<z.ZodObject<{
+        producerId: z.ZodString;
+        identity: z.ZodString;
+        kind: z.ZodEnum<["audio", "video"]>;
+    }, "strip", z.ZodTypeAny, {
+        identity: string;
+        kind: "audio" | "video";
+        producerId: string;
+    }, {
+        identity: string;
+        kind: "audio" | "video";
+        producerId: string;
+    }>, "many">;
+    iceServers: z.ZodArray<z.ZodObject<{
+        urls: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+        username: z.ZodOptional<z.ZodString>;
+        credential: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        urls: string | string[];
+        username?: string | undefined;
+        credential?: string | undefined;
+    }, {
+        urls: string | string[];
+        username?: string | undefined;
+        credential?: string | undefined;
+    }>, "many">;
+    /** True while any `kind: "egress"` participant is present. A consent
+     * requirement, not a nicety. */
+    recording: z.ZodBoolean;
+    /**
+     * What this token was minted with, echoed back.
+     *
+     * The client already holds the token but must not parse it: a signed blob
+     * a client reads is a signed blob a client eventually trusts its own
+     * reading of. This is the node's understanding of the grants, which is the
+     * one that will actually be enforced, so a UI built from it cannot offer a
+     * control the node is about to refuse.
+     */
+    grants: z.ZodOptional<z.ZodObject<{
+        canPublish: z.ZodBoolean;
+        canSubscribe: z.ZodBoolean;
+        canPublishData: z.ZodBoolean;
+        subscribe: z.ZodOptional<z.ZodDiscriminatedUnion<"mode", [z.ZodObject<{
+            mode: z.ZodLiteral<"all">;
+        }, "strict", z.ZodTypeAny, {
+            mode: "all";
+        }, {
+            mode: "all";
+        }>, z.ZodObject<{
+            mode: z.ZodLiteral<"none">;
+        }, "strict", z.ZodTypeAny, {
+            mode: "none";
+        }, {
+            mode: "none";
+        }>, z.ZodObject<{
+            mode: z.ZodLiteral<"allow">;
+            identities: z.ZodArray<z.ZodString, "many">;
+        }, "strict", z.ZodTypeAny, {
+            mode: "allow";
+            identities: string[];
+        }, {
+            mode: "allow";
+            identities: string[];
+        }>, z.ZodObject<{
+            mode: z.ZodLiteral<"deny">;
+            identities: z.ZodArray<z.ZodString, "many">;
+        }, "strict", z.ZodTypeAny, {
+            mode: "deny";
+            identities: string[];
+        }, {
+            mode: "deny";
+            identities: string[];
+        }>]>>;
+        visibleTo: z.ZodOptional<z.ZodDiscriminatedUnion<"mode", [z.ZodObject<{
+            mode: z.ZodLiteral<"all">;
+        }, "strict", z.ZodTypeAny, {
+            mode: "all";
+        }, {
+            mode: "all";
+        }>, z.ZodObject<{
+            mode: z.ZodLiteral<"none">;
+        }, "strict", z.ZodTypeAny, {
+            mode: "none";
+        }, {
+            mode: "none";
+        }>, z.ZodObject<{
+            mode: z.ZodLiteral<"allow">;
+            identities: z.ZodArray<z.ZodString, "many">;
+        }, "strict", z.ZodTypeAny, {
+            mode: "allow";
+            identities: string[];
+        }, {
+            mode: "allow";
+            identities: string[];
+        }>, z.ZodObject<{
+            mode: z.ZodLiteral<"deny">;
+            identities: z.ZodArray<z.ZodString, "many">;
+        }, "strict", z.ZodTypeAny, {
+            mode: "deny";
+            identities: string[];
+        }, {
+            mode: "deny";
+            identities: string[];
+        }>]>>;
+        publishKinds: z.ZodOptional<z.ZodArray<z.ZodEnum<["audio", "video", "screen"]>, "many">>;
+        subscribeExempt: z.ZodOptional<z.ZodBoolean>;
+        maxSubscriptions: z.ZodOptional<z.ZodNumber>;
+    }, "strict", z.ZodTypeAny, {
+        canPublish: boolean;
+        canSubscribe: boolean;
+        canPublishData: boolean;
+        subscribe?: {
+            mode: "all";
+        } | {
+            mode: "none";
+        } | {
+            mode: "allow";
+            identities: string[];
+        } | {
+            mode: "deny";
+            identities: string[];
+        } | undefined;
+        visibleTo?: {
+            mode: "all";
+        } | {
+            mode: "none";
+        } | {
+            mode: "allow";
+            identities: string[];
+        } | {
+            mode: "deny";
+            identities: string[];
+        } | undefined;
+        publishKinds?: ("audio" | "video" | "screen")[] | undefined;
+        subscribeExempt?: boolean | undefined;
+        maxSubscriptions?: number | undefined;
+    }, {
+        canPublish: boolean;
+        canSubscribe: boolean;
+        canPublishData: boolean;
+        subscribe?: {
+            mode: "all";
+        } | {
+            mode: "none";
+        } | {
+            mode: "allow";
+            identities: string[];
+        } | {
+            mode: "deny";
+            identities: string[];
+        } | undefined;
+        visibleTo?: {
+            mode: "all";
+        } | {
+            mode: "none";
+        } | {
+            mode: "allow";
+            identities: string[];
+        } | {
+            mode: "deny";
+            identities: string[];
+        } | undefined;
+        publishKinds?: ("audio" | "video" | "screen")[] | undefined;
+        subscribeExempt?: boolean | undefined;
+        maxSubscriptions?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    room: string;
+    identity: string;
+    event: "joined";
+    peers: {
+        identity: string;
+        kind: "human" | "agent" | "egress" | "sip" | "ingress";
+        name?: string | undefined;
+    }[];
+    producers: {
+        identity: string;
+        kind: "audio" | "video";
+        producerId: string;
+    }[];
+    iceServers: {
+        urls: string | string[];
+        username?: string | undefined;
+        credential?: string | undefined;
+    }[];
+    recording: boolean;
+    grants?: {
+        canPublish: boolean;
+        canSubscribe: boolean;
+        canPublishData: boolean;
+        subscribe?: {
+            mode: "all";
+        } | {
+            mode: "none";
+        } | {
+            mode: "allow";
+            identities: string[];
+        } | {
+            mode: "deny";
+            identities: string[];
+        } | undefined;
+        visibleTo?: {
+            mode: "all";
+        } | {
+            mode: "none";
+        } | {
+            mode: "allow";
+            identities: string[];
+        } | {
+            mode: "deny";
+            identities: string[];
+        } | undefined;
+        publishKinds?: ("audio" | "video" | "screen")[] | undefined;
+        subscribeExempt?: boolean | undefined;
+        maxSubscriptions?: number | undefined;
+    } | undefined;
+    routerRtpCapabilities?: unknown;
+}, {
+    room: string;
+    identity: string;
+    event: "joined";
+    peers: {
+        identity: string;
+        kind: "human" | "agent" | "egress" | "sip" | "ingress";
+        name?: string | undefined;
+    }[];
+    producers: {
+        identity: string;
+        kind: "audio" | "video";
+        producerId: string;
+    }[];
+    iceServers: {
+        urls: string | string[];
+        username?: string | undefined;
+        credential?: string | undefined;
+    }[];
+    recording: boolean;
+    grants?: {
+        canPublish: boolean;
+        canSubscribe: boolean;
+        canPublishData: boolean;
+        subscribe?: {
+            mode: "all";
+        } | {
+            mode: "none";
+        } | {
+            mode: "allow";
+            identities: string[];
+        } | {
+            mode: "deny";
+            identities: string[];
+        } | undefined;
+        visibleTo?: {
+            mode: "all";
+        } | {
+            mode: "none";
+        } | {
+            mode: "allow";
+            identities: string[];
+        } | {
+            mode: "deny";
+            identities: string[];
+        } | undefined;
+        publishKinds?: ("audio" | "video" | "screen")[] | undefined;
+        subscribeExempt?: boolean | undefined;
+        maxSubscriptions?: number | undefined;
+    } | undefined;
+    routerRtpCapabilities?: unknown;
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"peerJoined">;
+    peer: z.ZodObject<{
+        identity: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        kind: z.ZodEnum<["human", "agent", "egress", "sip", "ingress"]>;
+    }, "strip", z.ZodTypeAny, {
+        identity: string;
+        kind: "human" | "agent" | "egress" | "sip" | "ingress";
+        name?: string | undefined;
+    }, {
+        identity: string;
+        kind: "human" | "agent" | "egress" | "sip" | "ingress";
+        name?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    event: "peerJoined";
+    peer: {
+        identity: string;
+        kind: "human" | "agent" | "egress" | "sip" | "ingress";
+        name?: string | undefined;
+    };
+}, {
+    event: "peerJoined";
+    peer: {
+        identity: string;
+        kind: "human" | "agent" | "egress" | "sip" | "ingress";
+        name?: string | undefined;
+    };
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"peerLeft">;
+    identity: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    identity: string;
+    event: "peerLeft";
+}, {
+    identity: string;
+    event: "peerLeft";
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"producerAppeared">;
+    producerId: z.ZodString;
+    identity: z.ZodString;
+    kind: z.ZodEnum<["audio", "video"]>;
+}, "strip", z.ZodTypeAny, {
+    identity: string;
+    kind: "audio" | "video";
+    producerId: string;
+    event: "producerAppeared";
+}, {
+    identity: string;
+    kind: "audio" | "video";
+    producerId: string;
+    event: "producerAppeared";
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"producerClosed">;
+    producerId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    producerId: string;
+    event: "producerClosed";
+}, {
+    producerId: string;
+    event: "producerClosed";
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"producerPaused">;
+    producerId: z.ZodString;
+    paused: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    producerId: string;
+    event: "producerPaused";
+    paused: boolean;
+}, {
+    producerId: string;
+    event: "producerPaused";
+    paused: boolean;
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"activeSpeakers">;
+    producerIds: z.ZodArray<z.ZodString, "many">;
+    audio: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    video: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    enforced: z.ZodOptional<z.ZodBoolean>;
+    speakers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        identity: z.ZodString;
+        producerId: z.ZodString;
+        volumeDb: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        identity: string;
+        producerId: string;
+        volumeDb: number;
+    }, {
+        identity: string;
+        producerId: string;
+        volumeDb: number;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    event: "activeSpeakers";
+    producerIds: string[];
+    audio?: string[] | undefined;
+    video?: string[] | undefined;
+    enforced?: boolean | undefined;
+    speakers?: {
+        identity: string;
+        producerId: string;
+        volumeDb: number;
+    }[] | undefined;
+}, {
+    event: "activeSpeakers";
+    producerIds: string[];
+    audio?: string[] | undefined;
+    video?: string[] | undefined;
+    enforced?: boolean | undefined;
+    speakers?: {
+        identity: string;
+        producerId: string;
+        volumeDb: number;
+    }[] | undefined;
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"recordingChanged">;
+    recording: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    event: "recordingChanged";
+    recording: boolean;
+}, {
+    event: "recordingChanged";
+    recording: boolean;
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"draining">;
+    reconnectAfterMs: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    event: "draining";
+    reconnectAfterMs: number;
+}, {
+    event: "draining";
+    reconnectAfterMs: number;
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"roomClosed">;
+    reason: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    event: "roomClosed";
+    reason: string;
+}, {
+    event: "roomClosed";
+    reason: string;
+}>, z.ZodObject<{
+    event: z.ZodLiteral<"subscribeRuleChanged">;
+    subscribe: z.ZodDiscriminatedUnion<"mode", [z.ZodObject<{
+        mode: z.ZodLiteral<"all">;
+    }, "strict", z.ZodTypeAny, {
+        mode: "all";
+    }, {
+        mode: "all";
+    }>, z.ZodObject<{
+        mode: z.ZodLiteral<"none">;
+    }, "strict", z.ZodTypeAny, {
+        mode: "none";
+    }, {
+        mode: "none";
+    }>, z.ZodObject<{
+        mode: z.ZodLiteral<"allow">;
+        identities: z.ZodArray<z.ZodString, "many">;
+    }, "strict", z.ZodTypeAny, {
+        mode: "allow";
+        identities: string[];
+    }, {
+        mode: "allow";
+        identities: string[];
+    }>, z.ZodObject<{
+        mode: z.ZodLiteral<"deny">;
+        identities: z.ZodArray<z.ZodString, "many">;
+    }, "strict", z.ZodTypeAny, {
+        mode: "deny";
+        identities: string[];
+    }, {
+        mode: "deny";
+        identities: string[];
+    }>]>;
+}, "strip", z.ZodTypeAny, {
+    subscribe: {
+        mode: "all";
+    } | {
+        mode: "none";
+    } | {
+        mode: "allow";
+        identities: string[];
+    } | {
+        mode: "deny";
+        identities: string[];
+    };
+    event: "subscribeRuleChanged";
+}, {
+    subscribe: {
+        mode: "all";
+    } | {
+        mode: "none";
+    } | {
+        mode: "allow";
+        identities: string[];
+    } | {
+        mode: "deny";
+        identities: string[];
+    };
+    event: "subscribeRuleChanged";
+}>]>]>;
+export type ServerFrame = z.infer<typeof serverFrameSchema>;
+export declare const isEvent: (frame: ServerFrame) => frame is EventFrame;
+//# sourceMappingURL=frames.d.ts.map