@cloudflare/realtimekit 2.0.3-staging.15 → 2.0.3-staging.17

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.
@@ -2144,6 +2144,165 @@ declare class ClientMap<T extends (EventMap & WildCardEvent<T>), U extends {
2144
2144
  toArray(): U[];
2145
2145
  }
2146
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
+
2147
2306
  interface ResponseStatus {
2148
2307
  success: boolean;
2149
2308
  message: string;
@@ -2548,10 +2707,13 @@ declare class SelfController {
2548
2707
  private waitlistedHandler;
2549
2708
  private waitlistAcceptHandler;
2550
2709
  private waitlistRejectedHandler;
2551
- resetSelf(shouldAutoJoin: boolean): Promise<void>;
2710
+ resetSelf(joinAttempts: RoomJoinAttemptStates): Promise<void>;
2552
2711
  private setupEvents;
2553
2712
  private joinSocketRoomWithRetry;
2554
- joinRoom(reconnected?: boolean): Promise<void>;
2713
+ joinRoom({ reconnected, joinAttempts, }?: {
2714
+ reconnected?: boolean;
2715
+ joinAttempts?: RoomJoinAttemptStates;
2716
+ }): Promise<void>;
2555
2717
  leaveRoom(state?: LeaveRoomState): Promise<void>;
2556
2718
  private joinMediaRoom;
2557
2719
  private leaveMediaRoom;
@@ -2669,67 +2831,6 @@ declare class Ai extends TypedEventEmitter<AiEvents> {
2669
2831
  onTranscript(transcript: TranscriptionData): Promise<void>;
2670
2832
  }
2671
2833
 
2672
- type StageSocketMessage = GetStageRequestsResponse | GetStagePeersResponse | DenyStageAccessRequest | PeerStatusUpdate;
2673
- declare class StageSocketHandler {
2674
- constructor(socketService: SocketService);
2675
- getStageRequests(): Promise<GetStageRequestsResponse>;
2676
- requestAccess(): void;
2677
- cancelRequestAccess(): void;
2678
- grantAccess(userIds: string[]): Promise<void>;
2679
- denyAccess(userIds: string[]): Promise<void>;
2680
- joinStage(): Promise<{
2681
- id: string;
2682
- payload: Uint8Array;
2683
- }>;
2684
- leaveStage(userId: string): Promise<{
2685
- id: string;
2686
- payload: Uint8Array;
2687
- }>;
2688
- kick(userIds: string[]): Promise<{
2689
- id: string;
2690
- payload: Uint8Array;
2691
- }>;
2692
- on(event: number, handler: (socketMessage: StageSocketMessage, messageId?: string) => void): void;
2693
- getPeerInfo(peerId: string): Promise<PeerInfoResponse>;
2694
- }
2695
-
2696
- type StageStatus = 'OFF_STAGE' | 'REQUESTED_TO_JOIN_STAGE' | 'ACCEPTED_TO_JOIN_STAGE' | 'ON_STAGE';
2697
- interface StageRequestPayload {
2698
- displayName: string;
2699
- userId: string;
2700
- peerId: string;
2701
- }
2702
- type StageEvents = {
2703
- ['stageAccessRequestUpdate']: (requests?: StageRequestPayload[]) => void;
2704
- ['stageStatusUpdate']: (status: StageStatus) => void;
2705
- ['newStageRequest']: (payload: {
2706
- count: number;
2707
- }) => void;
2708
- ['stageRequestApproved']: () => void;
2709
- ['stageRequestRejected']: () => void;
2710
- ['*']: (eventName: string, ...args: any[]) => void;
2711
- };
2712
- declare class Stage extends TypedEventEmitter<StageEvents> {
2713
- get telemetry(): Telemetry;
2714
- constructor(context: Context<ContextState>, self: Self, participants: Participants, stageSocketHandler: StageSocketHandler, roomSocketHandler: RoomSocketHandler);
2715
- get status(): StageStatus;
2716
- private setupEvents;
2717
- getAccessRequests(): {
2718
- stageRequests: StageRequestPayload[];
2719
- };
2720
- requestAccess(): Promise<void>;
2721
- cancelRequestAccess(): Promise<void>;
2722
- grantAccess(userIds: string[]): Promise<void>;
2723
- denyAccess(userIds: string[]): Promise<void>;
2724
- get peerId(): string;
2725
- join(): Promise<void>;
2726
- leave(): Promise<void>;
2727
- kick(userIds: string[]): Promise<{
2728
- id: string;
2729
- payload: Uint8Array;
2730
- }>;
2731
- }
2732
-
2733
2834
  declare class PollSocketHandler {
2734
2835
  get logger(): Logger;
2735
2836
  get telemetry(): Telemetry;
@@ -4083,99 +4184,6 @@ interface TypedEventEmitter$1<Events extends EventMap$1> {
4083
4184
  reset(): void;
4084
4185
  }
4085
4186
 
4086
- type ProducerHandoverPayload = {
4087
- oldPeerId: string;
4088
- newPeerId: string;
4089
- producerIds: string[];
4090
- };
4091
- declare enum SessionEvents {
4092
- NEW_PRODUCER = "NEW_PRODUCER",
4093
- PRODUCER_HANDOVER = "PRODUCER_HANDOVER",
4094
- ROOM_NODE_CONNECTION_ERROR = "ROOM_NODE_CONNECTION_ERROR",
4095
- SOCKET_SERVICE_ROOM_JOINED = "SOCKET_SERVICE_ROOM_JOINED",
4096
- SOCKET_SERVICE_RECONNECTED = "SOCKET_SERVICE_RECONNECTED",
4097
- SOCKET_SERVICE_DISCONNECTED = "SOCKET_SERVICE_DISCONNECTED",
4098
- SOCKET_SERVICE_FAILED = "SOCKET_SERVICE_FAILED",
4099
- SOCKET_STATE_UPDATE = "SOCKET_STATE_UPDATE",
4100
- ROOM_NODE_RECONNECTED = "ROOM_NODE_RECONNECTED",
4101
- ROOM_NODE_DISCONNECTED = "ROOM_NODE_DISCONNECTED",
4102
- ROOM_NODE_FAILED = "ROOM_NODE_FAILED",
4103
- MEDIA_ROOM_JOIN_FAILED = "MEDIA_ROOM_JOIN_FAILED",
4104
- TRANSPORT_STATE_UPDATE = "TRANSPORT_STATE_UPDATE",
4105
- PRODUCER_SCORE_UPDATE = "PRODUCER_SCORE_UPDATE",
4106
- CONSUMER_SCORE_UPDATE = "CONSUMER_SCORE_UPDATE",
4107
- PRODUCER_STATUS_UPDATE = "PRODUCER_STATUS_UPDATE",
4108
- CONSUMER_STATUS_UPDATE = "CONSUMER_STATUS_UPDATE",
4109
- LOW_CONSUMER_SCORE = "LOW_CONSUMER_SCORE",
4110
- MEDIA_PERMISSION_ERROR = "MEDIA_PERMISSION_ERROR",
4111
- MEDIA_PERMISSION_UPDATE = "MEDIA_PERMISSION_UPDATE",
4112
- MESSAGE = "websocket/message",
4113
- ROOM_MESSAGE = "websocket/room-message",
4114
- PEER_JOINED_INTERNAL = "peer/joined-internal",
4115
- PEER_CLOSED = "websocket/peer-closed",
4116
- CONSUMER_CLOSED = "websocket/consumer-closed",
4117
- CONSUMER_PAUSED = "websocket/consumer-paused",
4118
- CONSUMER_RESUMED = "websocket/consumer-resumed",
4119
- NEW_CONSUMER_CREATED = "NEW_CONSUMER_CREATED",
4120
- PRODUCER_CLOSED = "websocket/producer-closed",
4121
- PRODUCER_SCORE = "websocket/producer-score",
4122
- CONSUMER_SCORE = "websocket/consumer-score",
4123
- PRODUCER_TOGGLE = "cf/producer-toggle",
4124
- UPDATE_ACTIVE = "media/update-active",
4125
- RESET_PRODUCER_STATE = "cf/reset-producer-state",
4126
- ROOM_STATE = "sockethub/room-state",
4127
- GET_STAGE_REQUESTS = "GET_STAGE_REQUESTS",
4128
- UPDATE_STAGE_REQUESTS = "UPDATE_STAGE_REQUESTS",
4129
- KICK_PEER = "KICK_PEER",
4130
- UPDATE_PEER_STAGE_STATUS = "UPDATE_PEER_STAGE_STATUS",
4131
- JOIN_MEDIA_ROOM = "JOIN_MEDIA_ROOM",
4132
- LEAVE_MEDIA_ROOM = "LEAVE_MEDIA_ROOM",
4133
- PIP_HANGUP = "PIP_HANGUP",
4134
- E2EE_ACTIVE_PRODUCER = "E2EE_ACTIVE_PRODUCER",
4135
- E2EE_INACTIVE_PRODUCER = "E2EE_INACTIVE_PRODUCER",
4136
- E2EE_ACTIVE_CONSUMER = "E2EE_ACTIVE_CONSUMER",
4137
- E2EE_INACTIVE_CONSUMER = "E2EE_INACTIVE_CONSUMER",
4138
- ENABLE_E2EE_CRYPTOR_ON_NEW_CONSUMER = "ENABLE_E2EE_CRYPTOR_ON_NEW_CONSUMER",
4139
- SOCKET_PEERS = "SOCKET_PEERS",
4140
- UPDATE_PERMISSIONS = "UPDATE_PERMISSIONS",
4141
- MAX_SPATIAL_LAYER_CHANGE = "MAX_SPATIAL_LAYER_CHANGE",
4142
- MUTE_SELF = "MUTE_SELF",
4143
- MUTE_SELF_VIDEO = "MUTE_SELF_VIDEO"
4144
- }
4145
- type AllEvents = {
4146
- [key in SessionEvents]: (payload?: any) => void;
4147
- };
4148
- type TypedEvents = {
4149
- [SessionEvents.PRODUCER_HANDOVER]: (payload: ProducerHandoverPayload) => void;
4150
- [SessionEvents.TRANSPORT_STATE_UPDATE]: (payload: MediaConnectionUpdate) => void;
4151
- [SessionEvents.UPDATE_PERMISSIONS]: (p: PresetUpdates) => void;
4152
- [SessionEvents.MAX_SPATIAL_LAYER_CHANGE]: (p: {
4153
- peerId: string;
4154
- maxSpatialLayer: number;
4155
- }) => void;
4156
- [SessionEvents.UPDATE_ACTIVE]: (p?: {
4157
- viewMode?: ViewMode;
4158
- page?: number;
4159
- }) => void;
4160
- [SessionEvents.PEER_JOINED_INTERNAL]: (p: Participant) => void;
4161
- [SessionEvents.UPDATE_PEER_STAGE_STATUS]: (p: {
4162
- id: string;
4163
- status: string;
4164
- }) => void;
4165
- [SessionEvents.GET_STAGE_REQUESTS]: (stageRequests: StageRequest[]) => void;
4166
- [SessionEvents.UPDATE_STAGE_REQUESTS]: (payload: {
4167
- request: StageRequestPayload;
4168
- add: boolean;
4169
- }) => void;
4170
- [SessionEvents.KICK_PEER]: (payload: {
4171
- peerId: string;
4172
- }) => void;
4173
- [SessionEvents.JOIN_MEDIA_ROOM]: () => void;
4174
- [SessionEvents.LEAVE_MEDIA_ROOM]: (state: LeaveRoomState) => void;
4175
- };
4176
- type UntypedEvents = Omit<AllEvents, keyof TypedEvents>;
4177
- type SessionEventsType = TypedEvents & UntypedEvents;
4178
-
4179
4187
  declare const ENVIRONMENTS: {
4180
4188
  readonly STAGING: "staging";
4181
4189
  readonly PROD: "prod";