@cloudflare/realtimekit 0.0.3 → 0.1.0

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.
package/dist/index.d.ts CHANGED
@@ -1978,8 +1978,6 @@ declare class ChatSocketHandler {
1978
1978
  }
1979
1979
 
1980
1980
  declare class RTKSelectedPeers {
1981
- private readonly _activeSpeakerPeers;
1982
- private readonly _compulsoryPeers;
1983
1981
  constructor();
1984
1982
  add(peerId: string, priority: number): number;
1985
1983
  delete(peerId: string): void;
@@ -1987,7 +1985,6 @@ declare class RTKSelectedPeers {
1987
1985
  get peers(): string[];
1988
1986
  get compulsoryPeers(): string[];
1989
1987
  get activeSpeakerPeers(): string[];
1990
- private _removeFromCompulsoryPeer;
1991
1988
  }
1992
1989
 
1993
1990
  type PipEvents = {
@@ -2001,40 +1998,15 @@ type PipEvents = {
2001
1998
  declare class RTKPip extends RTKTypedEventEmitter<PipEvents> {
2002
1999
  private constructor();
2003
2000
  static _init(context: Context<RTKContextState>, self: RTKSelf$1): Promise<RTKPip>;
2004
- private setupIcon;
2005
2001
  overrideIcon(icon: 'handRaise' | 'pin', value: string): Promise<void>;
2006
- private constructImage;
2007
- private createVideoContainer;
2008
- private setupEventListeners;
2009
- private cleanupEventListeners;
2010
- private enablePipMediaControls;
2011
- private onSelfVideoUpdateListener;
2012
- private onSelfAudioUpdateListener;
2013
- private handlePipMediaControls;
2014
- private createCanvas;
2015
- private eventCallback;
2016
- private setupMediaSessionEvents;
2017
- private mountAudioEvents;
2018
- private mountVideoEvents;
2019
- private unmountEvents;
2020
- private getSources;
2021
- private drawEmptyTile;
2022
- private drawIcons;
2023
- private drawTile;
2024
- private calcGridElemSize;
2025
- private paintCanvas;
2026
- private animate;
2027
2002
  isSupported(): boolean;
2028
2003
  get isActive(): boolean;
2029
- private cleanup;
2030
2004
  init({ height, width }?: {
2031
2005
  height?: number;
2032
2006
  width?: number;
2033
2007
  }): void;
2034
- private updateMediaSession;
2035
2008
  enableSource(source: string): void;
2036
2009
  disableSource(source: string): void;
2037
- private generateAvatar;
2038
2010
  addSource(id: string, element: HTMLVideoElement, enabled: boolean, pinned?: boolean, displayText?: string, imageUrl?: string, handRaised?: boolean): void;
2039
2011
  updateSource(id: string, source: any): void;
2040
2012
  removeSource(id: string): void;
@@ -2124,7 +2096,6 @@ declare class RoomSocketHandler {
2124
2096
  id: string;
2125
2097
  payload: Uint8Array;
2126
2098
  }>;
2127
- private handleSocketEvents;
2128
2099
  on(event: number, handler: (message: EventHandlerTypes) => void): void;
2129
2100
  getUserPermissions(userId: string): Promise<Pick<PresetTypeV2['permissions'], 'chat' | 'polls' | 'plugins'>>;
2130
2101
  }
@@ -2164,12 +2135,7 @@ interface HandlerSendResult extends GenericHandlerResult {
2164
2135
  mid: string;
2165
2136
  }
2166
2137
  declare abstract class HandlerInterface<TransportPromiseEvents> extends EnhancedEventEmitter<TransportPromiseEvents> {
2167
- protected _sendWebStream: MediaStream;
2168
- protected _sendScreenShareStream: MediaStream;
2169
- protected _direction?: 'send' | 'recv';
2170
2138
  pc: RTCPeerConnection;
2171
- protected _transportReady: boolean;
2172
- private readonly _mapMidTransceiver;
2173
2139
  enableHighBitrate: boolean;
2174
2140
  enableStereo: boolean;
2175
2141
  enableDtx: boolean;
@@ -2180,8 +2146,6 @@ declare abstract class HandlerInterface<TransportPromiseEvents> extends Enhanced
2180
2146
  init({ direction, iceServers, iceTransportPolicy, additionalSettings, proprietaryConstraints, onTrackHandler, }: HandlerRunOptions): void;
2181
2147
  connect(): Promise<GenericHandlerResult>;
2182
2148
  getTransportStats(): Promise<RTCStatsReport>;
2183
- protected _assertSendDirection(): void;
2184
- protected _assertRecvDirection(): void;
2185
2149
  getReceiverStats(localId: string): Promise<RTCStatsReport>;
2186
2150
  stopSending(localId: string): Promise<GenericHandlerResult>;
2187
2151
  abstract send(options: HandlerSendOptions): Promise<HandlerSendResult>;
@@ -2430,13 +2394,10 @@ declare class RTKParticipant$1 extends RTKTypedEventEmitter<ParticipantEvents> {
2430
2394
  supportsRemoteControl: boolean;
2431
2395
  presetName?: string;
2432
2396
  get stageStatus(): StageStatus;
2433
- private get mediaJoined();
2434
- private get socketJoined();
2435
2397
  constructor(context: Context<RTKContextState>, participant: Participant, self: RTKSelf, roomSocket: RoomSocketHandler);
2436
2398
  setVideoEnabled(videoEnabled: boolean, emitEvent?: boolean): void;
2437
2399
  setAudioEnabled(audioEnabled: boolean, emitEvent?: boolean): void;
2438
2400
  setScreenShareEnabled(screenShareEnabled: boolean, emitEvent?: boolean): void;
2439
- private setupEvents;
2440
2401
  pin(): Promise<void>;
2441
2402
  unpin(): Promise<void>;
2442
2403
  setIsPinned(isPinned: boolean, emitEvent?: boolean): void;
@@ -2448,7 +2409,6 @@ declare class RTKParticipant$1 extends RTKTypedEventEmitter<ParticipantEvents> {
2448
2409
  get isPinned(): boolean;
2449
2410
  registerVideoElement(videoElem: HTMLVideoElement): void;
2450
2411
  deregisterVideoElement(videoElem: HTMLVideoElement): void;
2451
- private updateVideo;
2452
2412
  }
2453
2413
 
2454
2414
  type TranscriptionData = {
@@ -2517,7 +2477,6 @@ declare class RTKMeta$1 extends RTKTypedEventEmitter<MetaEvents> {
2517
2477
  get meetingId(): string;
2518
2478
  setBroadcastTabChanges(broadcastTabChanges: boolean): void;
2519
2479
  setSelfActiveTab(spotlightTab: ActiveTab, tabChangeSource: TabChangeSource): void;
2520
- private assertActiveTabToRoom;
2521
2480
  }
2522
2481
 
2523
2482
  interface RTKMapEvents<T extends EventMap> {
@@ -2657,8 +2616,6 @@ declare class RTKParticipants$1 extends RTKTypedEventEmitter<ParticipantsEvents>
2657
2616
  readonly pinned: Readonly<RTKParticipantMap$1>;
2658
2617
  readonly all: Readonly<RTKBasicParticipantsMap>;
2659
2618
  get pip(): RTKPip;
2660
- private get socketJoined();
2661
- private get mediaJoined();
2662
2619
  rateLimitConfig: {
2663
2620
  maxInvocations: number;
2664
2621
  period: number;
@@ -2754,7 +2711,6 @@ declare class FetchClient {
2754
2711
  retryDelay: number;
2755
2712
  responseType?: string;
2756
2713
  });
2757
- private buildURL;
2758
2714
  request<T = any>(config: FetchRequestConfig): Promise<FetchResponse<T>>;
2759
2715
  get<T = any>(url: string, config?: FetchRequestConfig): Promise<FetchResponse<T>>;
2760
2716
  post<T = any>(url: string, data?: any, config?: FetchRequestConfig): Promise<FetchResponse<T>>;
@@ -2772,7 +2728,6 @@ declare class LocalMediaHandler extends RTKEventEmitter<LocalMediaEvents> {
2772
2728
  audioUpdateInProgress: boolean;
2773
2729
  videoUpdateInProgress: boolean;
2774
2730
  constructor(context: Context<RTKContextState>, mediaConstraints: MediaConstraints, isNonPreferredDevice?: (media: MediaDeviceInfo) => boolean, autoSwitchDevice?: boolean);
2775
- private onVisibilityChange;
2776
2731
  repopulateAvailableDevices(): Promise<boolean>;
2777
2732
  setupStreams({ audio, video, }: {
2778
2733
  audio: boolean;
@@ -2790,8 +2745,6 @@ declare class LocalMediaHandler extends RTKEventEmitter<LocalMediaEvents> {
2790
2745
  };
2791
2746
  getAllDevices(): Promise<InputDeviceInfo[]>;
2792
2747
  getDeviceById(deviceId: string, kind?: 'audioinput' | 'audiooutput' | 'videoinput'): Promise<MediaDeviceInfo>;
2793
- private onAudioTrackMuted;
2794
- private onAudioTrackChanged;
2795
2748
  get rawAudioTrack(): MediaStreamTrack;
2796
2749
  get audioTrack(): MediaStreamTrack;
2797
2750
  get audioEnabled(): boolean;
@@ -2801,8 +2754,6 @@ declare class LocalMediaHandler extends RTKEventEmitter<LocalMediaEvents> {
2801
2754
  setAudioDevice(device: MediaDeviceInfo): Promise<void>;
2802
2755
  setupSpeaker(): Promise<void>;
2803
2756
  setSpeakerDevice(device: MediaDeviceInfo): Promise<void>;
2804
- private onVideoTrackChanged;
2805
- private onVideoTrackEnded;
2806
2757
  get rawVideoTrack(): MediaStreamTrack;
2807
2758
  get videoTrack(): MediaStreamTrack;
2808
2759
  get videoEnabled(): boolean;
@@ -2811,7 +2762,6 @@ declare class LocalMediaHandler extends RTKEventEmitter<LocalMediaEvents> {
2811
2762
  getVideoDevices(devices?: MediaDeviceInfo[]): Promise<MediaDeviceInfo[]>;
2812
2763
  setVideoDevice(device: MediaDeviceInfo): Promise<void>;
2813
2764
  updateVideoConstraints(resolution: VideoQualityConstraints): Promise<void>;
2814
- private onScreenShareEnded;
2815
2765
  get screenShareTracks(): {
2816
2766
  audio: MediaStreamTrack;
2817
2767
  video: MediaStreamTrack;
@@ -3108,7 +3058,6 @@ type PermissionEvents = {
3108
3058
  };
3109
3059
  declare class RTKPermissionsPreset$1 extends RTKTypedEventEmitter<PermissionEvents> {
3110
3060
  private constructor();
3111
- private setupEvents;
3112
3061
  static fromResponse(response: PresetPermissions, viewType: ViewType, context: Context<RTKContextState>): RTKPermissionsPreset$1;
3113
3062
  static default(context: Context<RTKContextState>, viewType: ViewType): RTKPermissionsPreset$1;
3114
3063
  static init(context: Context<RTKContextState>, viewType: ViewType, response?: PresetPermissions): RTKPermissionsPreset$1;
@@ -3191,7 +3140,6 @@ declare class RTKLivestream$1 extends RTKTypedEventEmitter<LivestreamEvents> {
3191
3140
  viewerCount: number;
3192
3141
  constructor(self: RTKSelf);
3193
3142
  setLivestreamState(livestreamState: LivestreamState): void;
3194
- private emitCurrentLivestreamState;
3195
3143
  start(livestreamConfig?: StartLivestreamConfig): Promise<void>;
3196
3144
  stop(): Promise<void>;
3197
3145
  }
@@ -3339,12 +3287,7 @@ declare class RTKChat$1 extends RTKTypedEventEmitter<ChatEvents> {
3339
3287
  channels: ChatChannel[];
3340
3288
  maxTextLimit: number;
3341
3289
  setMaxTextLimit(limit: number): void;
3342
- private get socketJoined();
3343
3290
  constructor(context: Context<RTKContextState>, chatSocketHandler: ChatSocketHandler, chatChannelSocketHandler: ChatChannelSocketHandler, self: RTKSelf$1, participants: RTKParticipants$1);
3344
- private sendMessageInternal;
3345
- private sendTextMessageInternal;
3346
- private sendImageMessageInternal;
3347
- private sendFileMessageInternal;
3348
3291
  get rateLimits(): {
3349
3292
  maxInvocations: number;
3350
3293
  period: number;
@@ -3422,7 +3365,6 @@ type PollsEvents = {
3422
3365
  };
3423
3366
  declare class RTKPolls$1 extends RTKTypedEventEmitter<PollsEvents> {
3424
3367
  items: Poll[];
3425
- private get socketJoined();
3426
3368
  constructor(context: Context<RTKContextState>, self: RTKSelf$1, pollSocketHandler: PollSocketHandler);
3427
3369
  create(question: string, options: string[], anonymous?: boolean, hideVotes?: boolean): Promise<void>;
3428
3370
  vote(id: string, index: number): Promise<void>;
@@ -3486,12 +3428,6 @@ declare class PluginSocketHandler {
3486
3428
  }
3487
3429
 
3488
3430
  declare class RTKSelfMedia extends RTKTypedEventEmitter<SelfEvents> {
3489
- protected localMediaHandler: LocalMediaHandler;
3490
- protected updatePermission(): Promise<void>;
3491
- protected populateMediaPermissionsInCallstats({ message, kind, }: {
3492
- message: keyof typeof MediaPermission;
3493
- kind: 'audio' | 'video' | 'screenshare';
3494
- }): Promise<void>;
3495
3431
  init(options?: {
3496
3432
  video?: boolean;
3497
3433
  audio?: boolean;
@@ -3917,6 +3853,7 @@ type LogData$2 = {
3917
3853
  };
3918
3854
  peerIds?: string[];
3919
3855
  producers?: ProducerState[];
3856
+ sdp?: RTCSessionDescription['sdp'];
3920
3857
  };
3921
3858
 
3922
3859
  type EventSeverities = SupportedEventSeverities;
@@ -3984,14 +3921,12 @@ declare class RTKStore$1 {
3984
3921
  maxInvocations: number;
3985
3922
  period: number;
3986
3923
  };
3987
- private listeners;
3988
3924
  constructor({ name, socketHandler, meetingId }: {
3989
3925
  name: string;
3990
3926
  socketHandler: PluginSocketHandler;
3991
3927
  meetingId: string;
3992
3928
  });
3993
3929
  set(key: string, value: any, sync?: boolean, emit?: boolean): Promise<void>;
3994
- private remoteSet;
3995
3930
  bulkSet(data: {
3996
3931
  key: string;
3997
3932
  payload: any;
@@ -4034,7 +3969,6 @@ declare class MediaNodeClient {
4034
3969
  readonly context: Context<RTKContextState>;
4035
3970
  readonly authToken: string;
4036
3971
  readonly e2ee: boolean;
4037
- maxPreferredStreams: number;
4038
3972
  get peerId(): string;
4039
3973
  constructor(context: Context<RTKContextState>, nodeType: MediaNodeType, options: MediaNodeClientOptions);
4040
3974
  get mediaJoined(): boolean;
@@ -4047,11 +3981,8 @@ declare class MediaNodeClient {
4047
3981
  }, forceFullReset?: boolean, rejoining?: boolean): Promise<{
4048
3982
  roomJoined: boolean;
4049
3983
  }>;
4050
- private partialJoinRoomPromise;
4051
3984
  _partialJoinRoom(displayName: string, roomUuid: string, rejoining?: boolean, loc?: GeoLocation): Promise<void>;
4052
3985
  partialJoinRoom(displayName: string, roomUuid: string, rejoining?: boolean, loc?: GeoLocation): Promise<any>;
4053
- private _joinRoom;
4054
- private completeJoinRoom;
4055
3986
  leaveRoom(): Promise<void>;
4056
3987
  getConsumers(): Map<string, Consumer>;
4057
3988
  activatePeers(producers: ProducerState[]): Promise<void>;
@@ -4080,8 +4011,8 @@ declare class MediaNodeClient {
4080
4011
  unmuteSelf(): Promise<void>;
4081
4012
  resetVideoProducers(videoTrack: MediaStreamTrack, screenShareTrack?: MediaStreamTrack): Promise<void>;
4082
4013
  changeDisplayName(displayName: string, peerId?: string): Promise<void>;
4083
- kick(peerId: string): Promise<void>;
4084
- kickAll(): Promise<void>;
4014
+ kick(peerId: string): void;
4015
+ kickAll(): void;
4085
4016
  muteAll(_allowUnMute: boolean): Promise<void>;
4086
4017
  muteAllVideo(): Promise<void>;
4087
4018
  disableAudio(peerId: string): Promise<void>;
@@ -4318,7 +4249,6 @@ declare class SocketService {
4318
4249
  capabilities: SocketServiceCapabilities;
4319
4250
  });
4320
4251
  updateURL(peerID: string): void;
4321
- private static getSocketEdgeDomain;
4322
4252
  get url(): string;
4323
4253
  connect(): Promise<void>;
4324
4254
  disconnect(): Promise<void>;
@@ -4395,7 +4325,6 @@ type StageEvents = {
4395
4325
  declare class RTKStage extends RTKTypedEventEmitter<StageEvents> {
4396
4326
  constructor(context: Context<RTKContextState>, self: RTKSelf$1, participants: RTKParticipants, stageSocketHandler: StageSocketHandler, roomSocketHandler: RoomSocketHandler);
4397
4327
  get status(): StageStatus;
4398
- private setupEvents;
4399
4328
  getAccessRequests(): {
4400
4329
  stageRequests: StageRequestPayload[];
4401
4330
  };
@@ -4440,7 +4369,6 @@ declare class RTKSelf$1 extends RTKSelfMedia {
4440
4369
  private constructor();
4441
4370
  static __init__(context: Context<RTKContextState>, details: UserDetailsResponse, permissions: RTKPermissionsPreset$1, theme: RTKThemePreset$1, presetName: string, skipAwaits?: boolean): Promise<RTKSelf$1>;
4442
4371
  cleanupEvents(): void;
4443
- private setupEvents;
4444
4372
  get permissions(): RTKPermissionsPreset$1;
4445
4373
  get config(): RTKThemePreset$1;
4446
4374
  get roomJoined(): boolean;
@@ -4471,7 +4399,6 @@ declare class RTKSelf$1 extends RTKSelfMedia {
4471
4399
  cleanUpTracks(): void;
4472
4400
  registerVideoElement(videoElem: HTMLVideoElement, isPreview?: boolean): void;
4473
4401
  deregisterVideoElement(videoElem: HTMLVideoElement, isPreview?: boolean): void;
4474
- private updateVideo;
4475
4402
  }
4476
4403
 
4477
4404
  interface RTKPluginResponse {
@@ -4579,11 +4506,9 @@ declare class RTKPlugin$1 extends RTKEventEmitter<PluginEvents> {
4579
4506
  enabledBy: string;
4580
4507
  constructor(context: Context<RTKContextState>, { baseURL, createdAt, description, id, name, organizationId, picture, private: isPrivate, published, staggered, tags, type, updatedAt, }: RTKPluginResponse, pluginSocketHandler: PluginSocketHandler, self: RTKSelf$1, participants: RTKParticipants$1, chat: Readonly<RTKChat$1>, meetingTitle: string);
4581
4508
  sendIframeEvent(message: PluginIframeMessage): void;
4582
- private handleIframeMessage;
4583
4509
  sendData(payload: SendDataOptions): void;
4584
4510
  removePluginView(viewId?: string): void;
4585
4511
  addPluginView(iframe: HTMLIFrameElement | ReactNativeWebView, viewId?: string): void;
4586
- private setActive;
4587
4512
  activateForSelf(): Promise<void>;
4588
4513
  deactivateForSelf(): void;
4589
4514
  enable(): Promise<void>;
@@ -4615,16 +4540,6 @@ interface APIOptions {
4615
4540
  }
4616
4541
  declare class API {
4617
4542
  ipInfo: any;
4618
- protected fetchClient: FetchClient;
4619
- protected requests: FetchClient;
4620
- protected roomName: string;
4621
- protected roomUUID: string;
4622
- protected authToken: string;
4623
- protected organizationId: string;
4624
- protected iceServers: IceServerInformation[];
4625
- protected pluginInformation: RTKPluginResponse[];
4626
- protected userDetails: UserDetailsResponseV2;
4627
- protected roomDetails: RoomDetails;
4628
4543
  get peerId(): string;
4629
4544
  context: Context<RTKContextState>;
4630
4545
  constructor(context: Context<RTKContextState>, options?: APIOptions);
@@ -4666,7 +4581,6 @@ declare class RTKConnectedMeetings$1 extends RTKTypedEventEmitter<ConnectedMeeti
4666
4581
  get supportsConnectedMeetings(): boolean;
4667
4582
  get isActive(): boolean;
4668
4583
  get currentMeetingId(): string;
4669
- private validateConnectedMeetingsAction;
4670
4584
  getConnectedMeetings(): Promise<{
4671
4585
  parentMeeting: ConnectedMeeting;
4672
4586
  meetings: ConnectedMeeting[];
@@ -4701,7 +4615,6 @@ declare class RTKConnectedMeetings$1 extends RTKTypedEventEmitter<ConnectedMeeti
4701
4615
  success: boolean;
4702
4616
  error: any;
4703
4617
  }>;
4704
- private moveSuccessHandler;
4705
4618
  }
4706
4619
 
4707
4620
  interface Overrides {
@@ -4721,7 +4634,6 @@ interface RealtimeKitClientOptions {
4721
4634
  declare class RealtimeKitClient {
4722
4635
  private constructor();
4723
4636
  static init(options: RealtimeKitClientOptions): Promise<RealtimeKitClient>;
4724
- private static setupContext;
4725
4637
  join(): Promise<void>;
4726
4638
  leave(state?: LeaveRoomState): Promise<void>;
4727
4639
  get participants(): Readonly<RTKParticipants$1>;
@@ -4772,4 +4684,4 @@ declare global {
4772
4684
  }
4773
4685
  }
4774
4686
 
4775
- export { ActiveTab, ActiveTabType, AudioProducerScoreStats, ChatChannel, ChatUpdateParams, CustomMessage, DeviceConfig, RTKBasicParticipant, RealtimeKitClientOptions, RTKConnectedMeetings, RTKParticipant, RTKParticipantMap, RTKParticipants, RTKPermissionsPreset, RTKPlugin, RTKSelf, RTKSelfMedia, RTKThemePreset, FileMessage, ImageMessage, LivestreamState, MediaConnectionState, MediaKind$1 as MediaKind, Message, ProducerScoreStats, RecordingState, SocketConnectionState, StageStatus, TextMessage, VideoProducerScoreStats, RealtimeKitClient as default, LeaveRoomState as leaveRoomState };
4687
+ export { ActiveTab, ActiveTabType, AudioProducerScoreStats, ChatChannel, ChatUpdateParams, CustomMessage, DeviceConfig, RTKBasicParticipant, RealtimeKitClientOptions, RTKConnectedMeetings, RTKParticipant, RTKParticipantMap, RTKParticipants, RTKPermissionsPreset, RTKPlugin, RTKSelf, RTKThemePreset, FileMessage, ImageMessage, LivestreamState, MediaConnectionState, MediaKind$1 as MediaKind, Message, ProducerScoreStats, RTKSelfMedia as RTKSelfMedia, RecordingState, SocketConnectionState, StageStatus, TextMessage, VideoProducerScoreStats, RealtimeKitClient as default, LeaveRoomState as leaveRoomState };