@cloudflare/realtimekit 2.0.2 → 2.0.3-staging.10

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.
@@ -490,6 +490,10 @@ interface PeerJoinBroadcastResponse {
490
490
  * @generated from protobuf field: media.edge.RoomParticipants participant = 1;
491
491
  */
492
492
  participant?: RoomParticipants;
493
+ /**
494
+ * @generated from protobuf field: optional string producer_handover_from_peer_id = 2;
495
+ */
496
+ producerHandoverFromPeerId?: string;
493
497
  }
494
498
  /**
495
499
  * @generated MessageType for protobuf message media.edge.PeerJoinBroadcastResponse
@@ -1796,14 +1800,15 @@ declare class SocketService {
1796
1800
  readonly telemetry: Telemetry;
1797
1801
  readonly logger: Logger;
1798
1802
  readonly peerId: string;
1803
+ readonly replacedPeerIds: string[];
1799
1804
  constructor(context: Context<ContextState>, { peerId, meetingId, authToken, capabilities, }: {
1800
1805
  peerId: string;
1801
1806
  meetingId: string;
1802
1807
  authToken: string;
1803
1808
  capabilities: SocketServiceCapabilities;
1804
1809
  });
1810
+ updateCallstatsPeerId(peerID: string): void;
1805
1811
  updateURL(peerID: string): void;
1806
- private static getSocketEdgeDomain;
1807
1812
  readonly url: string;
1808
1813
  connect(): Promise<void>;
1809
1814
  disconnect(): void;
@@ -1875,6 +1880,7 @@ declare class SelectedPeers {
1875
1880
  constructor();
1876
1881
  add(peerId: string, priority: number, context: Context<ContextState>): number;
1877
1882
  delete(peerId: string, context: Context<ContextState>): void;
1883
+ reassignPeer(oldPeerId: string, newPeerId: string, context: Context<ContextState>): void;
1878
1884
  index(peerId: string): number;
1879
1885
  readonly peers: string[];
1880
1886
  readonly compulsoryPeers: string[];
@@ -1998,7 +2004,12 @@ declare class RoomSocketHandler {
1998
2004
  payload: Uint8Array;
1999
2005
  }>;
2000
2006
  broadcastToPeers(type: string, peerIds: string[], payload: BroadcastMessagePayload): Promise<boolean>;
2001
- leaveRoom(): Promise<void>;
2007
+ leaveRoom(peer: {
2008
+ peerId: string;
2009
+ userId: string;
2010
+ name: string;
2011
+ waitlistStatus: 'accepted' | 'waiting' | 'rejected' | 'none';
2012
+ }): boolean;
2002
2013
  kick(peerId: string): Promise<void>;
2003
2014
  kickAll(propagateKickAll?: boolean): Promise<void>;
2004
2015
  getWaitingRoomRequests(): void;
@@ -2506,9 +2517,6 @@ interface UserDetailsResponseV2 {
2506
2517
  meeting: {
2507
2518
  title: string;
2508
2519
  };
2509
- socket: {
2510
- baseUri: string;
2511
- };
2512
2520
  }
2513
2521
  type LeaveRoomState = 'kicked' | 'ended' | 'left' | 'rejected' | 'connected-meeting' | 'disconnected' | 'failed' | 'stageLeft';
2514
2522
  declare class SelfController {
@@ -3228,6 +3236,7 @@ declare class AudioPlayback {
3228
3236
  declare class AudioPlaybackManager extends AudioPlayback {
3229
3237
  constructor();
3230
3238
  addParticipantTrack(participantId: string, track: MediaStreamTrack): void;
3239
+ reassignParticipantTrack(oldParticipantId: string, newParticipantId: string): void;
3231
3240
  removeParticipantTrack(participantId: string): void;
3232
3241
  }
3233
3242
  declare class SelfMedia extends TypedEventEmitter<SelfEvents> {
@@ -3456,13 +3465,14 @@ declare class Consumer extends EnhancedEventEmitter<TransportPromiseEvents> {
3456
3465
  readonly producingTransportId: string;
3457
3466
  readonly mimeType: string;
3458
3467
  readonly track: MediaStreamTrack;
3459
- readonly peerId: string;
3468
+ peerId: string;
3460
3469
  readonly appData: Record<string, unknown>;
3461
3470
  readonly transceiver: RTCRtpTransceiver;
3462
3471
  constructor(context: Context<ContextState>, opts: ConsumerOptions);
3463
3472
  readonly closed: boolean;
3464
3473
  readonly kind: MediaKind$1;
3465
3474
  readonly paused: boolean;
3475
+ reassignPeer(peerId: string): void;
3466
3476
  close(reason?: string, closeTranscieverOnClose?: boolean): void;
3467
3477
  getStats(): Promise<RTCStatsReport>;
3468
3478
  pause(): void;
@@ -3601,7 +3611,7 @@ declare const modes: readonly [
3601
3611
  ];
3602
3612
  type ViewMode = (typeof modes)[number];
3603
3613
  interface BroadcastMessagePayload {
3604
- [key: string]: boolean | number | string | Date | ActiveTab;
3614
+ [key: string]: boolean | number | string | string[] | Date | ActiveTab;
3605
3615
  }
3606
3616
  interface PeerProducerConfig {
3607
3617
  audio: boolean;
@@ -3917,10 +3927,12 @@ declare class MediaNodeClient {
3917
3927
  initializeConnection(displayName: string, roomUuid: string, rejoining?: boolean, permissions?: MediaPermissions): Promise<void>;
3918
3928
  getConsumers(): Map<string, Consumer>;
3919
3929
  getProducers(): Map<string, Producer>;
3930
+ handoverPeerProducers(newPeerId: string, producerIds: string[]): Consumer[];
3920
3931
  leaveRoom(): Promise<void>;
3921
3932
  activatePeers(producers: ProducerState[]): Promise<void>;
3922
3933
  createConsumers(producers: ProducerState[]): Promise<void>;
3923
- closeConsumers(producers: ProducerState[]): Promise<void>;
3934
+ removeClosedConsumers(consumerIds: string[]): string[];
3935
+ closeConsumersById(consumerIds: string[]): Promise<void>;
3924
3936
  _shareWebcam(videoTrack: MediaStreamTrack & {
3925
3937
  originalSettings?: {
3926
3938
  width: number;
@@ -4035,8 +4047,14 @@ interface TypedEventEmitter$1<Events extends EventMap$1> {
4035
4047
  setMaxListeners(maxListeners: number): this;
4036
4048
  reset(): void;
4037
4049
  }
4050
+ type ProducerHandoverPayload = {
4051
+ oldPeerId: string;
4052
+ newPeerId: string;
4053
+ producerIds: string[];
4054
+ };
4038
4055
  declare enum SessionEvents {
4039
4056
  NEW_PRODUCER = "NEW_PRODUCER",
4057
+ PRODUCER_HANDOVER = "PRODUCER_HANDOVER",
4040
4058
  ROOM_NODE_CONNECTION_ERROR = "ROOM_NODE_CONNECTION_ERROR",
4041
4059
  SOCKET_SERVICE_ROOM_JOINED = "SOCKET_SERVICE_ROOM_JOINED",
4042
4060
  SOCKET_SERVICE_RECONNECTED = "SOCKET_SERVICE_RECONNECTED",
@@ -4061,8 +4079,8 @@ declare enum SessionEvents {
4061
4079
  CONSUMER_CLOSED = "websocket/consumer-closed",
4062
4080
  CONSUMER_PAUSED = "websocket/consumer-paused",
4063
4081
  CONSUMER_RESUMED = "websocket/consumer-resumed",
4082
+ NEW_CONSUMER_CREATED = "NEW_CONSUMER_CREATED",
4064
4083
  PRODUCER_CLOSED = "websocket/producer-closed",
4065
- NEW_CONSUMER = "websocket/new-consumer",
4066
4084
  PRODUCER_SCORE = "websocket/producer-score",
4067
4085
  CONSUMER_SCORE = "websocket/consumer-score",
4068
4086
  PRODUCER_TOGGLE = "cf/producer-toggle",
@@ -4080,6 +4098,7 @@ declare enum SessionEvents {
4080
4098
  E2EE_INACTIVE_PRODUCER = "E2EE_INACTIVE_PRODUCER",
4081
4099
  E2EE_ACTIVE_CONSUMER = "E2EE_ACTIVE_CONSUMER",
4082
4100
  E2EE_INACTIVE_CONSUMER = "E2EE_INACTIVE_CONSUMER",
4101
+ ENABLE_E2EE_CRYPTOR_ON_NEW_CONSUMER = "ENABLE_E2EE_CRYPTOR_ON_NEW_CONSUMER",
4083
4102
  SOCKET_PEERS = "SOCKET_PEERS",
4084
4103
  UPDATE_PERMISSIONS = "UPDATE_PERMISSIONS",
4085
4104
  MAX_SPATIAL_LAYER_CHANGE = "MAX_SPATIAL_LAYER_CHANGE",
@@ -4090,6 +4109,7 @@ type AllEvents = {
4090
4109
  [key in SessionEvents]: (payload?: any) => void;
4091
4110
  };
4092
4111
  type TypedEvents = {
4112
+ [SessionEvents.PRODUCER_HANDOVER]: (payload: ProducerHandoverPayload) => void;
4093
4113
  [SessionEvents.TRANSPORT_STATE_UPDATE]: (payload: MediaConnectionUpdate) => void;
4094
4114
  [SessionEvents.UPDATE_PERMISSIONS]: (p: PresetUpdates) => void;
4095
4115
  [SessionEvents.MAX_SPATIAL_LAYER_CHANGE]: (p: {
@@ -4128,7 +4148,6 @@ type ContextState = {
4128
4148
  peerId?: string;
4129
4149
  apiBase?: string;
4130
4150
  baseURI?: string;
4131
- socketBaseURI?: string;
4132
4151
  onError?: (error: ClientError) => void;
4133
4152
  stageStatus?: StageStatus;
4134
4153
  organizationId?: string;
@@ -461,6 +461,10 @@ interface PeerJoinBroadcastResponse {
461
461
  * @generated from protobuf field: media.edge.RoomParticipants participant = 1;
462
462
  */
463
463
  participant?: RoomParticipants;
464
+ /**
465
+ * @generated from protobuf field: optional string producer_handover_from_peer_id = 2;
466
+ */
467
+ producerHandoverFromPeerId?: string;
464
468
  }
465
469
  /**
466
470
  * @generated MessageType for protobuf message media.edge.PeerJoinBroadcastResponse
@@ -1767,14 +1771,15 @@ declare class SocketService {
1767
1771
  readonly telemetry: Telemetry;
1768
1772
  readonly logger: Logger;
1769
1773
  readonly peerId: string;
1774
+ readonly replacedPeerIds: string[];
1770
1775
  constructor(context: Context<ContextState>, { peerId, meetingId, authToken, capabilities, }: {
1771
1776
  peerId: string;
1772
1777
  meetingId: string;
1773
1778
  authToken: string;
1774
1779
  capabilities: SocketServiceCapabilities;
1775
1780
  });
1781
+ updateCallstatsPeerId(peerID: string): void;
1776
1782
  updateURL(peerID: string): void;
1777
- private static getSocketEdgeDomain;
1778
1783
  readonly url: string;
1779
1784
  connect(): Promise<void>;
1780
1785
  disconnect(): void;
@@ -1912,6 +1917,7 @@ declare class SelectedPeers {
1912
1917
  constructor();
1913
1918
  add(peerId: string, priority: number, context: Context<ContextState>): number;
1914
1919
  delete(peerId: string, context: Context<ContextState>): void;
1920
+ reassignPeer(oldPeerId: string, newPeerId: string, context: Context<ContextState>): void;
1915
1921
  index(peerId: string): number;
1916
1922
  readonly peers: string[];
1917
1923
  readonly compulsoryPeers: string[];
@@ -2035,7 +2041,12 @@ declare class RoomSocketHandler {
2035
2041
  payload: Uint8Array;
2036
2042
  }>;
2037
2043
  broadcastToPeers(type: string, peerIds: string[], payload: BroadcastMessagePayload): Promise<boolean>;
2038
- leaveRoom(): Promise<void>;
2044
+ leaveRoom(peer: {
2045
+ peerId: string;
2046
+ userId: string;
2047
+ name: string;
2048
+ waitlistStatus: 'accepted' | 'waiting' | 'rejected' | 'none';
2049
+ }): boolean;
2039
2050
  kick(peerId: string): Promise<void>;
2040
2051
  kickAll(propagateKickAll?: boolean): Promise<void>;
2041
2052
  getWaitingRoomRequests(): void;
@@ -2253,13 +2264,14 @@ declare class Consumer extends EnhancedEventEmitter<TransportPromiseEvents> {
2253
2264
  readonly producingTransportId: string;
2254
2265
  readonly mimeType: string;
2255
2266
  readonly track: MediaStreamTrack;
2256
- readonly peerId: string;
2267
+ peerId: string;
2257
2268
  readonly appData: Record<string, unknown>;
2258
2269
  readonly transceiver: RTCRtpTransceiver;
2259
2270
  constructor(context: Context<ContextState>, opts: ConsumerOptions);
2260
2271
  readonly closed: boolean;
2261
2272
  readonly kind: MediaKind$1;
2262
2273
  readonly paused: boolean;
2274
+ reassignPeer(peerId: string): void;
2263
2275
  close(reason?: string, closeTranscieverOnClose?: boolean): void;
2264
2276
  getStats(): Promise<RTCStatsReport>;
2265
2277
  pause(): void;
@@ -2446,7 +2458,7 @@ declare const modes: readonly [
2446
2458
  ];
2447
2459
  type ViewMode = (typeof modes)[number];
2448
2460
  interface BroadcastMessagePayload {
2449
- [key: string]: boolean | number | string | Date | ActiveTab;
2461
+ [key: string]: boolean | number | string | string[] | Date | ActiveTab;
2450
2462
  }
2451
2463
  interface PeerProducerConfig {
2452
2464
  audio: boolean;
@@ -3003,9 +3015,6 @@ interface UserDetailsResponseV2 {
3003
3015
  meeting: {
3004
3016
  title: string;
3005
3017
  };
3006
- socket: {
3007
- baseUri: string;
3008
- };
3009
3018
  }
3010
3019
  type LeaveRoomState = 'kicked' | 'ended' | 'left' | 'rejected' | 'connected-meeting' | 'disconnected' | 'failed' | 'stageLeft';
3011
3020
  declare class SelfController {
@@ -3642,10 +3651,12 @@ declare class MediaNodeClient {
3642
3651
  initializeConnection(displayName: string, roomUuid: string, rejoining?: boolean, permissions?: MediaPermissions): Promise<void>;
3643
3652
  getConsumers(): Map<string, Consumer>;
3644
3653
  getProducers(): Map<string, Producer>;
3654
+ handoverPeerProducers(newPeerId: string, producerIds: string[]): Consumer[];
3645
3655
  leaveRoom(): Promise<void>;
3646
3656
  activatePeers(producers: ProducerState[]): Promise<void>;
3647
3657
  createConsumers(producers: ProducerState[]): Promise<void>;
3648
- closeConsumers(producers: ProducerState[]): Promise<void>;
3658
+ removeClosedConsumers(consumerIds: string[]): string[];
3659
+ closeConsumersById(consumerIds: string[]): Promise<void>;
3649
3660
  _shareWebcam(videoTrack: MediaStreamTrack & {
3650
3661
  originalSettings?: {
3651
3662
  width: number;
@@ -3966,8 +3977,14 @@ interface TypedEventEmitter<Events extends EventMap> {
3966
3977
  setMaxListeners(maxListeners: number): this;
3967
3978
  reset(): void;
3968
3979
  }
3980
+ type ProducerHandoverPayload = {
3981
+ oldPeerId: string;
3982
+ newPeerId: string;
3983
+ producerIds: string[];
3984
+ };
3969
3985
  declare enum SessionEvents {
3970
3986
  NEW_PRODUCER = "NEW_PRODUCER",
3987
+ PRODUCER_HANDOVER = "PRODUCER_HANDOVER",
3971
3988
  ROOM_NODE_CONNECTION_ERROR = "ROOM_NODE_CONNECTION_ERROR",
3972
3989
  SOCKET_SERVICE_ROOM_JOINED = "SOCKET_SERVICE_ROOM_JOINED",
3973
3990
  SOCKET_SERVICE_RECONNECTED = "SOCKET_SERVICE_RECONNECTED",
@@ -3992,8 +4009,8 @@ declare enum SessionEvents {
3992
4009
  CONSUMER_CLOSED = "websocket/consumer-closed",
3993
4010
  CONSUMER_PAUSED = "websocket/consumer-paused",
3994
4011
  CONSUMER_RESUMED = "websocket/consumer-resumed",
4012
+ NEW_CONSUMER_CREATED = "NEW_CONSUMER_CREATED",
3995
4013
  PRODUCER_CLOSED = "websocket/producer-closed",
3996
- NEW_CONSUMER = "websocket/new-consumer",
3997
4014
  PRODUCER_SCORE = "websocket/producer-score",
3998
4015
  CONSUMER_SCORE = "websocket/consumer-score",
3999
4016
  PRODUCER_TOGGLE = "cf/producer-toggle",
@@ -4011,6 +4028,7 @@ declare enum SessionEvents {
4011
4028
  E2EE_INACTIVE_PRODUCER = "E2EE_INACTIVE_PRODUCER",
4012
4029
  E2EE_ACTIVE_CONSUMER = "E2EE_ACTIVE_CONSUMER",
4013
4030
  E2EE_INACTIVE_CONSUMER = "E2EE_INACTIVE_CONSUMER",
4031
+ ENABLE_E2EE_CRYPTOR_ON_NEW_CONSUMER = "ENABLE_E2EE_CRYPTOR_ON_NEW_CONSUMER",
4014
4032
  SOCKET_PEERS = "SOCKET_PEERS",
4015
4033
  UPDATE_PERMISSIONS = "UPDATE_PERMISSIONS",
4016
4034
  MAX_SPATIAL_LAYER_CHANGE = "MAX_SPATIAL_LAYER_CHANGE",
@@ -4021,6 +4039,7 @@ type AllEvents = {
4021
4039
  [key in SessionEvents]: (payload?: any) => void;
4022
4040
  };
4023
4041
  type TypedEvents = {
4042
+ [SessionEvents.PRODUCER_HANDOVER]: (payload: ProducerHandoverPayload) => void;
4024
4043
  [SessionEvents.TRANSPORT_STATE_UPDATE]: (payload: MediaConnectionUpdate) => void;
4025
4044
  [SessionEvents.UPDATE_PERMISSIONS]: (p: PresetUpdates) => void;
4026
4045
  [SessionEvents.MAX_SPATIAL_LAYER_CHANGE]: (p: {
@@ -4062,6 +4081,7 @@ declare class AudioPlayback {
4062
4081
  declare class AudioPlaybackManager extends AudioPlayback {
4063
4082
  constructor();
4064
4083
  addParticipantTrack(participantId: string, track: MediaStreamTrack): void;
4084
+ reassignParticipantTrack(oldParticipantId: string, newParticipantId: string): void;
4065
4085
  removeParticipantTrack(participantId: string): void;
4066
4086
  }
4067
4087
  declare const ENVIRONMENTS: {
@@ -4073,7 +4093,6 @@ type ContextState = {
4073
4093
  peerId?: string;
4074
4094
  apiBase?: string;
4075
4095
  baseURI?: string;
4076
- socketBaseURI?: string;
4077
4096
  onError?: (error: ClientError) => void;
4078
4097
  stageStatus?: StageStatus;
4079
4098
  organizationId?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cloudflare/realtimekit",
3
- "version": "2.0.2",
3
+ "version": "2.0.3-staging.10",
4
4
  "description": "A real-time video and audio SDK for building custom, collaborative communication experiences.",
5
5
  "main": "./dist/index.cjs.js",
6
6
  "module": "./dist/index.es.js",
@@ -86,8 +86,7 @@
86
86
  "worker-timers": "7.0.60"
87
87
  },
88
88
  "publishConfig": {
89
- "access": "public",
90
- "tag": "latest"
89
+ "tag": "staging"
91
90
  },
92
91
  "devDependencies": {
93
92
  "@types/events": "^3.0.0",
@@ -98,7 +97,7 @@
98
97
  "@types/uuid": "^8.3.4",
99
98
  "type-fest": "^2.12.1",
100
99
  "@cloudflare/realtimekit-callstats": "8.0.0",
101
- "@dyteinternals/proto-entities": "2.112.0",
100
+ "@cloudflare/realtimekit-proto-entities": "2.115.1",
102
101
  "@cloudflare/realtimekit-sockrates": "0.2.0",
103
102
  "@cloudflare/realtimekit-utils": "1.0.0"
104
103
  },