@cloudflare/realtimekit 2.0.3-staging.8 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -494,6 +494,10 @@ interface PeerJoinBroadcastResponse {
494
494
  * @generated from protobuf field: media.edge.RoomParticipants participant = 1;
495
495
  */
496
496
  participant?: RoomParticipants;
497
+ /**
498
+ * @generated from protobuf field: optional string producer_handover_from_peer_id = 2;
499
+ */
500
+ producerHandoverFromPeerId?: string;
497
501
  }
498
502
  /**
499
503
  * @generated MessageType for protobuf message media.edge.PeerJoinBroadcastResponse
@@ -1810,6 +1814,7 @@ declare class SocketService {
1810
1814
  get telemetry(): Telemetry;
1811
1815
  get logger(): Logger;
1812
1816
  get peerId(): string;
1817
+ get supersededLocalPeerIds(): string[];
1813
1818
  constructor(context: Context<ContextState>, { peerId, meetingId, authToken, capabilities, }: {
1814
1819
  peerId: string;
1815
1820
  meetingId: string;
@@ -2139,6 +2144,165 @@ declare class ClientMap<T extends (EventMap & WildCardEvent<T>), U extends {
2139
2144
  toArray(): U[];
2140
2145
  }
2141
2146
 
2147
+ type StageSocketMessage = GetStageRequestsResponse | GetStagePeersResponse | DenyStageAccessRequest | PeerStatusUpdate;
2148
+ declare class StageSocketHandler {
2149
+ constructor(socketService: SocketService);
2150
+ getStageRequests(): Promise<GetStageRequestsResponse>;
2151
+ requestAccess(): void;
2152
+ cancelRequestAccess(): void;
2153
+ grantAccess(userIds: string[]): Promise<void>;
2154
+ denyAccess(userIds: string[]): Promise<void>;
2155
+ joinStage(): Promise<{
2156
+ id: string;
2157
+ payload: Uint8Array;
2158
+ }>;
2159
+ leaveStage(userId: string): Promise<{
2160
+ id: string;
2161
+ payload: Uint8Array;
2162
+ }>;
2163
+ kick(userIds: string[]): Promise<{
2164
+ id: string;
2165
+ payload: Uint8Array;
2166
+ }>;
2167
+ on(event: number, handler: (socketMessage: StageSocketMessage, messageId?: string) => void): void;
2168
+ getPeerInfo(peerId: string): Promise<PeerInfoResponse>;
2169
+ }
2170
+
2171
+ type StageStatus = 'OFF_STAGE' | 'REQUESTED_TO_JOIN_STAGE' | 'ACCEPTED_TO_JOIN_STAGE' | 'ON_STAGE';
2172
+ interface StageRequestPayload {
2173
+ displayName: string;
2174
+ userId: string;
2175
+ peerId: string;
2176
+ }
2177
+ type StageEvents = {
2178
+ ['stageAccessRequestUpdate']: (requests?: StageRequestPayload[]) => void;
2179
+ ['stageStatusUpdate']: (status: StageStatus) => void;
2180
+ ['newStageRequest']: (payload: {
2181
+ count: number;
2182
+ }) => void;
2183
+ ['stageRequestApproved']: () => void;
2184
+ ['stageRequestRejected']: () => void;
2185
+ ['*']: (eventName: string, ...args: any[]) => void;
2186
+ };
2187
+ declare class Stage extends TypedEventEmitter<StageEvents> {
2188
+ get telemetry(): Telemetry;
2189
+ constructor(context: Context<ContextState>, self: Self, participants: Participants, stageSocketHandler: StageSocketHandler, roomSocketHandler: RoomSocketHandler);
2190
+ get status(): StageStatus;
2191
+ private setupEvents;
2192
+ getAccessRequests(): {
2193
+ stageRequests: StageRequestPayload[];
2194
+ };
2195
+ requestAccess(): Promise<void>;
2196
+ cancelRequestAccess(): Promise<void>;
2197
+ grantAccess(userIds: string[]): Promise<void>;
2198
+ denyAccess(userIds: string[]): Promise<void>;
2199
+ get peerId(): string;
2200
+ join(): Promise<void>;
2201
+ leave(): Promise<void>;
2202
+ kick(userIds: string[]): Promise<{
2203
+ id: string;
2204
+ payload: Uint8Array;
2205
+ }>;
2206
+ }
2207
+
2208
+ type ProducerHandoverPayload = {
2209
+ oldPeerId: string;
2210
+ newPeerId: string;
2211
+ producerIds: string[];
2212
+ };
2213
+ type RoomJoinAttemptStates = {
2214
+ wasSocketJoinAttempted: boolean;
2215
+ wasMediaJoinAttempted: boolean;
2216
+ };
2217
+ declare enum SessionEvents {
2218
+ NEW_PRODUCER = "NEW_PRODUCER",
2219
+ PRODUCER_HANDOVER = "PRODUCER_HANDOVER",
2220
+ ROOM_NODE_CONNECTION_ERROR = "ROOM_NODE_CONNECTION_ERROR",
2221
+ SOCKET_SERVICE_ROOM_JOINED = "SOCKET_SERVICE_ROOM_JOINED",
2222
+ SOCKET_SERVICE_RECONNECTED = "SOCKET_SERVICE_RECONNECTED",
2223
+ SOCKET_SERVICE_DISCONNECTED = "SOCKET_SERVICE_DISCONNECTED",
2224
+ SOCKET_SERVICE_FAILED = "SOCKET_SERVICE_FAILED",
2225
+ SOCKET_STATE_UPDATE = "SOCKET_STATE_UPDATE",
2226
+ ROOM_NODE_RECONNECTED = "ROOM_NODE_RECONNECTED",
2227
+ ROOM_NODE_DISCONNECTED = "ROOM_NODE_DISCONNECTED",
2228
+ ROOM_NODE_FAILED = "ROOM_NODE_FAILED",
2229
+ MEDIA_ROOM_JOIN_FAILED = "MEDIA_ROOM_JOIN_FAILED",
2230
+ TRANSPORT_STATE_UPDATE = "TRANSPORT_STATE_UPDATE",
2231
+ PRODUCER_SCORE_UPDATE = "PRODUCER_SCORE_UPDATE",
2232
+ CONSUMER_SCORE_UPDATE = "CONSUMER_SCORE_UPDATE",
2233
+ PRODUCER_STATUS_UPDATE = "PRODUCER_STATUS_UPDATE",
2234
+ CONSUMER_STATUS_UPDATE = "CONSUMER_STATUS_UPDATE",
2235
+ LOW_CONSUMER_SCORE = "LOW_CONSUMER_SCORE",
2236
+ MEDIA_PERMISSION_ERROR = "MEDIA_PERMISSION_ERROR",
2237
+ MEDIA_PERMISSION_UPDATE = "MEDIA_PERMISSION_UPDATE",
2238
+ MESSAGE = "websocket/message",
2239
+ ROOM_MESSAGE = "websocket/room-message",
2240
+ PEER_JOINED_INTERNAL = "peer/joined-internal",
2241
+ PEER_CLOSED = "websocket/peer-closed",
2242
+ CONSUMER_CLOSED = "websocket/consumer-closed",
2243
+ CONSUMER_PAUSED = "websocket/consumer-paused",
2244
+ CONSUMER_RESUMED = "websocket/consumer-resumed",
2245
+ NEW_CONSUMER_CREATED = "NEW_CONSUMER_CREATED",
2246
+ PRODUCER_CLOSED = "websocket/producer-closed",
2247
+ PRODUCER_SCORE = "websocket/producer-score",
2248
+ CONSUMER_SCORE = "websocket/consumer-score",
2249
+ PRODUCER_TOGGLE = "cf/producer-toggle",
2250
+ UPDATE_ACTIVE = "media/update-active",
2251
+ RESET_PRODUCER_STATE = "cf/reset-producer-state",
2252
+ ROOM_STATE = "sockethub/room-state",
2253
+ GET_STAGE_REQUESTS = "GET_STAGE_REQUESTS",
2254
+ UPDATE_STAGE_REQUESTS = "UPDATE_STAGE_REQUESTS",
2255
+ KICK_PEER = "KICK_PEER",
2256
+ UPDATE_PEER_STAGE_STATUS = "UPDATE_PEER_STAGE_STATUS",
2257
+ JOIN_MEDIA_ROOM = "JOIN_MEDIA_ROOM",
2258
+ LEAVE_MEDIA_ROOM = "LEAVE_MEDIA_ROOM",
2259
+ PIP_HANGUP = "PIP_HANGUP",
2260
+ E2EE_ACTIVE_PRODUCER = "E2EE_ACTIVE_PRODUCER",
2261
+ E2EE_INACTIVE_PRODUCER = "E2EE_INACTIVE_PRODUCER",
2262
+ E2EE_ACTIVE_CONSUMER = "E2EE_ACTIVE_CONSUMER",
2263
+ E2EE_INACTIVE_CONSUMER = "E2EE_INACTIVE_CONSUMER",
2264
+ ENABLE_E2EE_CRYPTOR_ON_NEW_CONSUMER = "ENABLE_E2EE_CRYPTOR_ON_NEW_CONSUMER",
2265
+ SOCKET_PEERS = "SOCKET_PEERS",
2266
+ UPDATE_PERMISSIONS = "UPDATE_PERMISSIONS",
2267
+ MAX_SPATIAL_LAYER_CHANGE = "MAX_SPATIAL_LAYER_CHANGE",
2268
+ MUTE_SELF = "MUTE_SELF",
2269
+ MUTE_SELF_VIDEO = "MUTE_SELF_VIDEO"
2270
+ }
2271
+ type AllEvents = {
2272
+ [key in SessionEvents]: (payload?: any) => void;
2273
+ };
2274
+ type TypedEvents = {
2275
+ [SessionEvents.SOCKET_SERVICE_RECONNECTED]: (payload: RoomJoinAttemptStates) => void;
2276
+ [SessionEvents.PRODUCER_HANDOVER]: (payload: ProducerHandoverPayload) => void;
2277
+ [SessionEvents.TRANSPORT_STATE_UPDATE]: (payload: MediaConnectionUpdate) => void;
2278
+ [SessionEvents.UPDATE_PERMISSIONS]: (p: PresetUpdates) => void;
2279
+ [SessionEvents.MAX_SPATIAL_LAYER_CHANGE]: (p: {
2280
+ peerId: string;
2281
+ maxSpatialLayer: number;
2282
+ }) => void;
2283
+ [SessionEvents.UPDATE_ACTIVE]: (p?: {
2284
+ viewMode?: ViewMode;
2285
+ page?: number;
2286
+ }) => void;
2287
+ [SessionEvents.PEER_JOINED_INTERNAL]: (p: Participant) => void;
2288
+ [SessionEvents.UPDATE_PEER_STAGE_STATUS]: (p: {
2289
+ id: string;
2290
+ status: string;
2291
+ }) => void;
2292
+ [SessionEvents.GET_STAGE_REQUESTS]: (stageRequests: StageRequest[]) => void;
2293
+ [SessionEvents.UPDATE_STAGE_REQUESTS]: (payload: {
2294
+ request: StageRequestPayload;
2295
+ add: boolean;
2296
+ }) => void;
2297
+ [SessionEvents.KICK_PEER]: (payload: {
2298
+ peerId: string;
2299
+ }) => void;
2300
+ [SessionEvents.JOIN_MEDIA_ROOM]: () => void;
2301
+ [SessionEvents.LEAVE_MEDIA_ROOM]: (state: LeaveRoomState) => void;
2302
+ };
2303
+ type UntypedEvents = Omit<AllEvents, keyof TypedEvents>;
2304
+ type SessionEventsType = TypedEvents & UntypedEvents;
2305
+
2142
2306
  interface ResponseStatus {
2143
2307
  success: boolean;
2144
2308
  message: string;
@@ -2543,9 +2707,13 @@ declare class SelfController {
2543
2707
  private waitlistedHandler;
2544
2708
  private waitlistAcceptHandler;
2545
2709
  private waitlistRejectedHandler;
2546
- resetSelf(shouldAutoJoin: boolean): Promise<void>;
2710
+ resetSelf(joinAttempts: RoomJoinAttemptStates): Promise<void>;
2547
2711
  private setupEvents;
2548
- joinRoom(reconnected?: boolean): Promise<void>;
2712
+ private joinSocketRoomWithRetry;
2713
+ joinRoom({ reconnected, joinAttempts, }?: {
2714
+ reconnected?: boolean;
2715
+ joinAttempts?: RoomJoinAttemptStates;
2716
+ }): Promise<void>;
2549
2717
  leaveRoom(state?: LeaveRoomState): Promise<void>;
2550
2718
  private joinMediaRoom;
2551
2719
  private leaveMediaRoom;
@@ -2663,67 +2831,6 @@ declare class Ai extends TypedEventEmitter<AiEvents> {
2663
2831
  onTranscript(transcript: TranscriptionData): Promise<void>;
2664
2832
  }
2665
2833
 
2666
- type StageSocketMessage = GetStageRequestsResponse | GetStagePeersResponse | DenyStageAccessRequest | PeerStatusUpdate;
2667
- declare class StageSocketHandler {
2668
- constructor(socketService: SocketService);
2669
- getStageRequests(): Promise<GetStageRequestsResponse>;
2670
- requestAccess(): void;
2671
- cancelRequestAccess(): void;
2672
- grantAccess(userIds: string[]): Promise<void>;
2673
- denyAccess(userIds: string[]): Promise<void>;
2674
- joinStage(): Promise<{
2675
- id: string;
2676
- payload: Uint8Array;
2677
- }>;
2678
- leaveStage(userId: string): Promise<{
2679
- id: string;
2680
- payload: Uint8Array;
2681
- }>;
2682
- kick(userIds: string[]): Promise<{
2683
- id: string;
2684
- payload: Uint8Array;
2685
- }>;
2686
- on(event: number, handler: (socketMessage: StageSocketMessage, messageId?: string) => void): void;
2687
- getPeerInfo(peerId: string): Promise<PeerInfoResponse>;
2688
- }
2689
-
2690
- type StageStatus = 'OFF_STAGE' | 'REQUESTED_TO_JOIN_STAGE' | 'ACCEPTED_TO_JOIN_STAGE' | 'ON_STAGE';
2691
- interface StageRequestPayload {
2692
- displayName: string;
2693
- userId: string;
2694
- peerId: string;
2695
- }
2696
- type StageEvents = {
2697
- ['stageAccessRequestUpdate']: (requests?: StageRequestPayload[]) => void;
2698
- ['stageStatusUpdate']: (status: StageStatus) => void;
2699
- ['newStageRequest']: (payload: {
2700
- count: number;
2701
- }) => void;
2702
- ['stageRequestApproved']: () => void;
2703
- ['stageRequestRejected']: () => void;
2704
- ['*']: (eventName: string, ...args: any[]) => void;
2705
- };
2706
- declare class Stage extends TypedEventEmitter<StageEvents> {
2707
- get telemetry(): Telemetry;
2708
- constructor(context: Context<ContextState>, self: Self, participants: Participants, stageSocketHandler: StageSocketHandler, roomSocketHandler: RoomSocketHandler);
2709
- get status(): StageStatus;
2710
- private setupEvents;
2711
- getAccessRequests(): {
2712
- stageRequests: StageRequestPayload[];
2713
- };
2714
- requestAccess(): Promise<void>;
2715
- cancelRequestAccess(): Promise<void>;
2716
- grantAccess(userIds: string[]): Promise<void>;
2717
- denyAccess(userIds: string[]): Promise<void>;
2718
- get peerId(): string;
2719
- join(): Promise<void>;
2720
- leave(): Promise<void>;
2721
- kick(userIds: string[]): Promise<{
2722
- id: string;
2723
- payload: Uint8Array;
2724
- }>;
2725
- }
2726
-
2727
2834
  declare class PollSocketHandler {
2728
2835
  get logger(): Logger;
2729
2836
  get telemetry(): Telemetry;
@@ -3957,7 +4064,7 @@ declare class MediaNodeClient {
3957
4064
  leaveRoom(): Promise<void>;
3958
4065
  activatePeers(producers: ProducerState[]): Promise<void>;
3959
4066
  createConsumers(producers: ProducerState[]): Promise<void>;
3960
- closeConsumers(producers: ProducerState[]): Promise<void>;
4067
+ removeClosedConsumers(consumerIds: string[]): string[];
3961
4068
  closeConsumersById(consumerIds: string[]): Promise<void>;
3962
4069
  _shareWebcam(videoTrack: MediaStreamTrack & {
3963
4070
  originalSettings?: {
@@ -4077,99 +4184,6 @@ interface TypedEventEmitter$1<Events extends EventMap$1> {
4077
4184
  reset(): void;
4078
4185
  }
4079
4186
 
4080
- type ProducerHandoverPayload = {
4081
- oldPeerId: string;
4082
- newPeerId: string;
4083
- producerIds: string[];
4084
- };
4085
- declare enum SessionEvents {
4086
- NEW_PRODUCER = "NEW_PRODUCER",
4087
- PRODUCER_HANDOVER = "PRODUCER_HANDOVER",
4088
- ROOM_NODE_CONNECTION_ERROR = "ROOM_NODE_CONNECTION_ERROR",
4089
- SOCKET_SERVICE_ROOM_JOINED = "SOCKET_SERVICE_ROOM_JOINED",
4090
- SOCKET_SERVICE_RECONNECTED = "SOCKET_SERVICE_RECONNECTED",
4091
- SOCKET_SERVICE_DISCONNECTED = "SOCKET_SERVICE_DISCONNECTED",
4092
- SOCKET_SERVICE_FAILED = "SOCKET_SERVICE_FAILED",
4093
- SOCKET_STATE_UPDATE = "SOCKET_STATE_UPDATE",
4094
- ROOM_NODE_RECONNECTED = "ROOM_NODE_RECONNECTED",
4095
- ROOM_NODE_DISCONNECTED = "ROOM_NODE_DISCONNECTED",
4096
- ROOM_NODE_FAILED = "ROOM_NODE_FAILED",
4097
- TRANSPORT_STATE_UPDATE = "TRANSPORT_STATE_UPDATE",
4098
- PRODUCER_SCORE_UPDATE = "PRODUCER_SCORE_UPDATE",
4099
- CONSUMER_SCORE_UPDATE = "CONSUMER_SCORE_UPDATE",
4100
- PRODUCER_STATUS_UPDATE = "PRODUCER_STATUS_UPDATE",
4101
- CONSUMER_STATUS_UPDATE = "CONSUMER_STATUS_UPDATE",
4102
- LOW_CONSUMER_SCORE = "LOW_CONSUMER_SCORE",
4103
- MEDIA_PERMISSION_ERROR = "MEDIA_PERMISSION_ERROR",
4104
- MEDIA_PERMISSION_UPDATE = "MEDIA_PERMISSION_UPDATE",
4105
- MESSAGE = "websocket/message",
4106
- ROOM_MESSAGE = "websocket/room-message",
4107
- PEER_JOINED_INTERNAL = "peer/joined-internal",
4108
- PEER_CLOSED = "websocket/peer-closed",
4109
- CONSUMER_CLOSED = "websocket/consumer-closed",
4110
- CONSUMER_PAUSED = "websocket/consumer-paused",
4111
- CONSUMER_RESUMED = "websocket/consumer-resumed",
4112
- NEW_CONSUMER_CREATED = "NEW_CONSUMER_CREATED",
4113
- PRODUCER_CLOSED = "websocket/producer-closed",
4114
- PRODUCER_SCORE = "websocket/producer-score",
4115
- CONSUMER_SCORE = "websocket/consumer-score",
4116
- PRODUCER_TOGGLE = "cf/producer-toggle",
4117
- UPDATE_ACTIVE = "media/update-active",
4118
- RESET_PRODUCER_STATE = "cf/reset-producer-state",
4119
- ROOM_STATE = "sockethub/room-state",
4120
- GET_STAGE_REQUESTS = "GET_STAGE_REQUESTS",
4121
- UPDATE_STAGE_REQUESTS = "UPDATE_STAGE_REQUESTS",
4122
- KICK_PEER = "KICK_PEER",
4123
- UPDATE_PEER_STAGE_STATUS = "UPDATE_PEER_STAGE_STATUS",
4124
- JOIN_MEDIA_ROOM = "JOIN_MEDIA_ROOM",
4125
- LEAVE_MEDIA_ROOM = "LEAVE_MEDIA_ROOM",
4126
- PIP_HANGUP = "PIP_HANGUP",
4127
- E2EE_ACTIVE_PRODUCER = "E2EE_ACTIVE_PRODUCER",
4128
- E2EE_INACTIVE_PRODUCER = "E2EE_INACTIVE_PRODUCER",
4129
- E2EE_ACTIVE_CONSUMER = "E2EE_ACTIVE_CONSUMER",
4130
- E2EE_INACTIVE_CONSUMER = "E2EE_INACTIVE_CONSUMER",
4131
- ENABLE_E2EE_CRYPTOR_ON_NEW_CONSUMER = "ENABLE_E2EE_CRYPTOR_ON_NEW_CONSUMER",
4132
- SOCKET_PEERS = "SOCKET_PEERS",
4133
- UPDATE_PERMISSIONS = "UPDATE_PERMISSIONS",
4134
- MAX_SPATIAL_LAYER_CHANGE = "MAX_SPATIAL_LAYER_CHANGE",
4135
- MUTE_SELF = "MUTE_SELF",
4136
- MUTE_SELF_VIDEO = "MUTE_SELF_VIDEO"
4137
- }
4138
- type AllEvents = {
4139
- [key in SessionEvents]: (payload?: any) => void;
4140
- };
4141
- type TypedEvents = {
4142
- [SessionEvents.PRODUCER_HANDOVER]: (payload: ProducerHandoverPayload) => void;
4143
- [SessionEvents.TRANSPORT_STATE_UPDATE]: (payload: MediaConnectionUpdate) => void;
4144
- [SessionEvents.UPDATE_PERMISSIONS]: (p: PresetUpdates) => void;
4145
- [SessionEvents.MAX_SPATIAL_LAYER_CHANGE]: (p: {
4146
- peerId: string;
4147
- maxSpatialLayer: number;
4148
- }) => void;
4149
- [SessionEvents.UPDATE_ACTIVE]: (p?: {
4150
- viewMode?: ViewMode;
4151
- page?: number;
4152
- createAllConsumers?: boolean;
4153
- }) => void;
4154
- [SessionEvents.PEER_JOINED_INTERNAL]: (p: Participant) => void;
4155
- [SessionEvents.UPDATE_PEER_STAGE_STATUS]: (p: {
4156
- id: string;
4157
- status: string;
4158
- }) => void;
4159
- [SessionEvents.GET_STAGE_REQUESTS]: (stageRequests: StageRequest[]) => void;
4160
- [SessionEvents.UPDATE_STAGE_REQUESTS]: (payload: {
4161
- request: StageRequestPayload;
4162
- add: boolean;
4163
- }) => void;
4164
- [SessionEvents.KICK_PEER]: (payload: {
4165
- peerId: string;
4166
- }) => void;
4167
- [SessionEvents.JOIN_MEDIA_ROOM]: () => void;
4168
- [SessionEvents.LEAVE_MEDIA_ROOM]: (state: LeaveRoomState) => void;
4169
- };
4170
- type UntypedEvents = Omit<AllEvents, keyof TypedEvents>;
4171
- type SessionEventsType = TypedEvents & UntypedEvents;
4172
-
4173
4187
  declare const ENVIRONMENTS: {
4174
4188
  readonly STAGING: "staging";
4175
4189
  readonly PROD: "prod";
@@ -4595,10 +4609,6 @@ type LogData$2 = {
4595
4609
  imageType?: string;
4596
4610
  messageType?: string;
4597
4611
  };
4598
- participant?: {
4599
- id: string;
4600
- maskedName?: string;
4601
- };
4602
4612
  actions?: {
4603
4613
  disableAllAudio?: {
4604
4614
  allowUnmute?: boolean;