@whereby.com/browser-sdk 2.0.0-beta1 → 2.0.0-beta3

package/dist/react/index.d.ts

@@ -1,6 +1,397 @@
-export { default as VideoView } from "./VideoView";
-export { default as useLocalMedia } from "./useLocalMedia";
-export { useRoomConnection } from "./useRoomConnection";
-export type { LocalMediaRef as UseLocalMediaResult } from "./useLocalMedia";
-export type { ChatMessageState as ChatMessage, LocalParticipantState as LocalParticipant, RemoteParticipantState as RemoteParticipant, RoomConnectionState as RoomConnection, ScreenshareState as Screenshare, WaitingParticipantState as WaitingParticipant, } from "./useRoomConnection";
-export { sdkVersion } from "../version";
+import React from 'react';
+import RtcManager from '@whereby/jslib-media/src/webrtc/RtcManager';
+import { ChatMessage as ChatMessage$1 } from '@whereby/jslib-media/src/utils/ServerSocket';
+
+interface VideoViewSelfProps {
+    stream: MediaStream;
+    muted?: boolean;
+    mirror?: boolean;
+    style?: React.CSSProperties;
+    onResize?: ({ width, height, stream }: {
+        width: number;
+        height: number;
+        stream: MediaStream;
+    }) => void;
+}
+type VideoViewProps = VideoViewSelfProps & React.DetailedHTMLProps<React.VideoHTMLAttributes<HTMLVideoElement>, HTMLVideoElement>;
+declare const _default: ({ muted, mirror, stream, onResize, ...rest }: VideoViewProps) => React.JSX.Element;
+
+type CameraEnabledEvent = {
+    enabled: boolean;
+};
+type MicrophoneEnabledEvent = {
+    enabled: boolean;
+};
+type DeviceListUpdatedEvent = {
+    cameraDevices: MediaDeviceInfo[];
+    microphoneDevices: MediaDeviceInfo[];
+    speakerDevices: MediaDeviceInfo[];
+};
+type DeviceListUpdateErrorEvent = {
+    error: unknown;
+};
+type StreamUpdatedEvent = {
+    stream: MediaStream;
+};
+type StopResumeVideoEvent = {
+    track: MediaStreamTrack;
+    enable: boolean;
+};
+interface LocalMediaEventsMap {
+    camera_enabled: CustomEvent<CameraEnabledEvent>;
+    device_list_updated: CustomEvent<DeviceListUpdatedEvent>;
+    device_list_update_error: CustomEvent<DeviceListUpdateErrorEvent>;
+    microphone_enabled: CustomEvent<MicrophoneEnabledEvent>;
+    stream_updated: CustomEvent<StreamUpdatedEvent>;
+    stopresumevideo: CustomEvent<StopResumeVideoEvent>;
+}
+interface LocalMediaEventTarget extends EventTarget {
+    addEventListener<K extends keyof LocalMediaEventsMap>(type: K, listener: (ev: LocalMediaEventsMap[K]) => void, options?: boolean | AddEventListenerOptions): void;
+    addEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: EventListenerOptions | boolean): void;
+}
+declare const TypedLocalMediaEventTarget: new () => LocalMediaEventTarget;
+interface LocalMediaOptions {
+    audio: boolean;
+    video: boolean;
+}
+declare class LocalMedia extends TypedLocalMediaEventTarget {
+    private _options;
+    _rtcManagers: RtcManager[];
+    private _devices;
+    stream: MediaStream;
+    screenshareStream?: MediaStream;
+    private _cameraEnabled;
+    private _currentCameraDeviceId;
+    private _isTogglingCameraEnabled;
+    private _microphoneEnabled;
+    private _currentMicrophoneDeviceId;
+    constructor(optionsOrStream: LocalMediaOptions | MediaStream);
+    addRtcManager(rtcManager: RtcManager): void;
+    removeRtcManager(rtcManager: RtcManager): void;
+    getCameraDeviceId(): string | undefined;
+    getMicrophoneDeviceId(): string | undefined;
+    isCameraEnabled(): boolean;
+    isMicrophoneEnabled(): boolean;
+    toggleCameraEnabled(enabled?: boolean): Promise<void>;
+    toggleMichrophoneEnabled(enabled?: boolean): void;
+    startScreenshare(): Promise<MediaStream>;
+    stopScreenshare(): void;
+    private _getConstraintsOptions;
+    private _setDevice;
+    setCameraDevice(deviceId: string): Promise<void>;
+    setMicrophoneDevice(deviceId: string): Promise<void>;
+    private _updateDeviceList;
+    start(): Promise<MediaStream>;
+    stop(): void;
+}
+
+interface LocalMediaState {
+    currentCameraDeviceId?: string;
+    currentMicrophoneDeviceId?: string;
+    cameraDeviceError: unknown;
+    cameraDevices: MediaDeviceInfo[];
+    isSettingCameraDevice: boolean;
+    isSettingMicrophoneDevice: boolean;
+    isStarting: boolean;
+    localStream?: MediaStream;
+    microphoneDeviceError: unknown;
+    microphoneDevices: MediaDeviceInfo[];
+    speakerDevices: MediaDeviceInfo[];
+    startError: unknown;
+}
+interface LocalMediaActions {
+    setCameraDevice: InstanceType<typeof LocalMedia>["setCameraDevice"];
+    setMicrophoneDevice: InstanceType<typeof LocalMedia>["setMicrophoneDevice"];
+    toggleCameraEnabled: InstanceType<typeof LocalMedia>["toggleCameraEnabled"];
+    toggleMicrophoneEnabled: InstanceType<typeof LocalMedia>["toggleMichrophoneEnabled"];
+}
+type LocalMediaRef = {
+    state: LocalMediaState;
+    actions: LocalMediaActions;
+    _ref: LocalMedia;
+};
+type UseLocalMediaOptions = LocalMediaOptions;
+declare function useLocalMedia(optionsOrStream?: UseLocalMediaOptions | MediaStream): LocalMediaRef;
+
+interface RoomParticipantData {
+    displayName: string;
+    id: string;
+    stream?: MediaStream;
+    isAudioEnabled: boolean;
+    isVideoEnabled: boolean;
+}
+declare class RoomParticipant {
+    readonly displayName: string;
+    readonly id: string;
+    readonly stream?: MediaStream;
+    readonly isAudioEnabled: boolean;
+    readonly isLocalParticipant: boolean;
+    readonly isVideoEnabled: boolean;
+    constructor({ displayName, id, stream, isAudioEnabled, isVideoEnabled }: RoomParticipantData);
+}
+interface RemoteParticipantData {
+    newJoiner: boolean;
+    streams: string[];
+}
+type StreamState = "new_accept" | "to_accept" | "old_accept" | "done_accept" | "to_unaccept" | "done_unaccept" | "auto";
+interface Stream {
+    id: string;
+    state: StreamState;
+}
+declare class RemoteParticipant extends RoomParticipant {
+    readonly newJoiner: boolean;
+    readonly streams: Stream[];
+    constructor({ displayName, id, newJoiner, streams, isAudioEnabled, isVideoEnabled, }: RoomParticipantData & RemoteParticipantData);
+    addStream(streamId: string, state: StreamState): void;
+    removeStream(streamId: string): void;
+    updateStreamState(streamId: string, state: StreamState): void;
+}
+declare class LocalParticipant extends RoomParticipant {
+    readonly isLocalParticipant = true;
+    constructor({ displayName, id, stream, isAudioEnabled, isVideoEnabled }: RoomParticipantData);
+}
+interface WaitingParticipant {
+    id: string;
+    displayName: string | null;
+}
+declare class Screenshare {
+    readonly participantId: string;
+    readonly id: string;
+    readonly hasAudioTrack: boolean;
+    readonly stream?: MediaStream;
+    readonly isLocal: boolean;
+    constructor({ participantId, id, hasAudioTrack, stream, isLocal }: Screenshare);
+}
+
+type Logger = Pick<Console, "debug" | "error" | "log" | "warn" | "info">;
+interface RoomConnectionOptions {
+    displayName?: string;
+    localMediaOptions?: LocalMediaOptions;
+    roomKey?: string;
+    logger?: Logger;
+    localMedia?: LocalMedia;
+    externalId?: string;
+}
+type ChatMessage = Pick<ChatMessage$1, "senderId" | "timestamp" | "text">;
+type ConnectionStatus = "initializing" | "connecting" | "connected" | "room_locked" | "knocking" | "disconnecting" | "disconnected" | "knock_rejected";
+type CloudRecordingState = {
+    error?: string;
+    status: "recording" | "requested" | "error";
+    startedAt?: number;
+};
+type LiveStreamState = {
+    status: "streaming";
+    startedAt: number;
+};
+type RoomJoinedEvent = {
+    localParticipant: LocalParticipant;
+    remoteParticipants: RemoteParticipant[];
+    waitingParticipants: WaitingParticipant[];
+};
+type ConnectionStatusChangedEvent = {
+    connectionStatus: ConnectionStatus;
+};
+type ParticipantJoinedEvent = {
+    remoteParticipant: RemoteParticipant;
+};
+type ParticipantLeftEvent = {
+    participantId: string;
+};
+type ParticipantStreamAddedEvent = {
+    participantId: string;
+    stream: MediaStream;
+    streamId: string;
+};
+type ParticipantAudioEnabledEvent = {
+    participantId: string;
+    isAudioEnabled: boolean;
+};
+type ParticipantVideoEnabledEvent = {
+    participantId: string;
+    isVideoEnabled: boolean;
+};
+type ParticipantMetadataChangedEvent = {
+    participantId: string;
+    displayName: string;
+};
+type ScreenshareStartedEvent = {
+    participantId: string;
+    id: string;
+    hasAudioTrack: boolean;
+    stream: MediaStream;
+    isLocal: boolean;
+};
+type ScreenshareStoppedEvent = {
+    participantId: string;
+    id: string;
+};
+type WaitingParticipantJoinedEvent = {
+    participantId: string;
+    displayName: string | null;
+};
+type WaitingParticipantLeftEvent = {
+    participantId: string;
+};
+type LocalCameraEnabledEvent = {
+    enabled: boolean;
+};
+type LocalMicrophoneEnabledEvent = {
+    enabled: boolean;
+};
+interface RoomEventsMap {
+    chat_message: (e: CustomEvent<ChatMessage>) => void;
+    cloud_recording_request_started: (e: CustomEvent<CloudRecordingState>) => void;
+    cloud_recording_started: (e: CustomEvent<CloudRecordingState>) => void;
+    cloud_recording_started_error: (e: CustomEvent<CloudRecordingState>) => void;
+    cloud_recording_stopped: (e: CustomEvent<CloudRecordingState>) => void;
+    local_camera_enabled: (e: CustomEvent<LocalCameraEnabledEvent>) => void;
+    local_microphone_enabled: (e: CustomEvent<LocalMicrophoneEnabledEvent>) => void;
+    participant_audio_enabled: (e: CustomEvent<ParticipantAudioEnabledEvent>) => void;
+    participant_joined: (e: CustomEvent<ParticipantJoinedEvent>) => void;
+    participant_left: (e: CustomEvent<ParticipantLeftEvent>) => void;
+    participant_metadata_changed: (e: CustomEvent<ParticipantMetadataChangedEvent>) => void;
+    participant_stream_added: (e: CustomEvent<ParticipantStreamAddedEvent>) => void;
+    participant_video_enabled: (e: CustomEvent<ParticipantVideoEnabledEvent>) => void;
+    connection_status_changed: (e: CustomEvent<ConnectionStatusChangedEvent>) => void;
+    room_joined: (e: CustomEvent<RoomJoinedEvent>) => void;
+    screenshare_started: (e: CustomEvent<ScreenshareStartedEvent>) => void;
+    screenshare_stopped: (e: CustomEvent<ScreenshareStoppedEvent>) => void;
+    streaming_started: (e: CustomEvent<LiveStreamState>) => void;
+    streaming_stopped: (e: CustomEvent<LiveStreamState>) => void;
+    waiting_participant_joined: (e: CustomEvent<WaitingParticipantJoinedEvent>) => void;
+    waiting_participant_left: (e: CustomEvent<WaitingParticipantLeftEvent>) => void;
+}
+interface RoomEventTarget extends EventTarget {
+    addEventListener<K extends keyof RoomEventsMap>(type: K, listener: RoomEventsMap[K], options?: boolean | AddEventListenerOptions): void;
+    addEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: EventListenerOptions | boolean): void;
+    removeEventListener<K extends keyof RoomEventsMap>(type: K, listener: RoomEventsMap[K], options?: boolean | EventListenerOptions): void;
+    removeEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: EventListenerOptions | boolean): void;
+}
+declare const TypedEventTarget: new () => RoomEventTarget;
+declare class RoomConnection extends TypedEventTarget {
+    localMedia: LocalMedia;
+    localParticipant?: LocalParticipant;
+    roomUrl: URL;
+    remoteParticipants: RemoteParticipant[];
+    screenshares: Screenshare[];
+    readonly localMediaConstraints?: MediaStreamConstraints;
+    readonly roomName: string;
+    private organizationId;
+    private credentialsService;
+    private apiClient;
+    private organizationService;
+    private organizationServiceCache;
+    private organizationApiClient;
+    private roomService;
+    private _deviceCredentials;
+    private signalSocket;
+    private signalSocketManager;
+    private rtcManagerDispatcher?;
+    private rtcManager?;
+    private connectionStatus;
+    private selfId;
+    private logger;
+    private _ownsLocalMedia;
+    private displayName?;
+    private externalId?;
+    private _roomKey;
+    constructor(roomUrl: string, { displayName, localMedia, localMediaOptions: localMediaConstraints, logger, roomKey, externalId, }: RoomConnectionOptions);
+    get roomKey(): string | null;
+    private _handleNewChatMessage;
+    private _handleCloudRecordingStarted;
+    private _handleRecorderClientJoined;
+    private _handleStreamingStarted;
+    private _handleNewClient;
+    private _handleClientLeft;
+    private _handleClientAudioEnabled;
+    private _handleClientVideoEnabled;
+    private _handleClientMetadataReceived;
+    private _handleKnockHandled;
+    private _handleKnockerLeft;
+    private _handleRoomJoined;
+    private _handleRoomKnocked;
+    private _handleReconnect;
+    private _handleDisconnect;
+    private _handleCloudRecordingStopped;
+    private _handleStreamingStopped;
+    private _handleScreenshareStarted;
+    private _handleScreenshareStopped;
+    private _handleRtcEvent;
+    private _handleRtcManagerCreated;
+    private _handleRtcManagerDestroyed;
+    private _handleAcceptStreams;
+    private _handleStreamAdded;
+    private _joinRoom;
+    join(): Promise<void>;
+    knock(): void;
+    leave(): void;
+    sendChatMessage(text: string): void;
+    setDisplayName(displayName: string): void;
+    acceptWaitingParticipant(participantId: string): void;
+    rejectWaitingParticipant(participantId: string): void;
+    updateStreamResolution({ streamId, width, height }: {
+        streamId?: string;
+        width: number;
+        height: number;
+    }): void;
+    startScreenshare(): Promise<void>;
+    stopScreenshare(): void;
+    startCloudRecording(): void;
+    stopCloudRecording(): void;
+}
+
+type RemoteParticipantState = Omit<RemoteParticipant, "updateStreamState" | "newJoiner" | "streams" | "addStream" | "removeStream">;
+type LocalParticipantState = LocalParticipant;
+interface WaitingParticipantState {
+    id: string;
+    displayName: string | null;
+}
+interface ChatMessageState {
+    senderId: string;
+    timestamp: string;
+    text: string;
+}
+type ScreenshareState = Screenshare;
+type LocalScreenshareStatus = "starting" | "active";
+interface RoomConnectionState {
+    chatMessages: ChatMessage[];
+    cloudRecording?: CloudRecordingState;
+    localScreenshareStatus?: LocalScreenshareStatus;
+    localParticipant?: LocalParticipantState;
+    remoteParticipants: RemoteParticipantState[];
+    screenshares: Screenshare[];
+    connectionStatus: ConnectionStatus;
+    liveStream?: LiveStreamState;
+    waitingParticipants: WaitingParticipantState[];
+}
+interface UseRoomConnectionOptions extends Omit<RoomConnectionOptions, "localMedia"> {
+    localMedia?: LocalMediaRef;
+}
+interface RoomConnectionActions {
+    sendChatMessage(text: string): void;
+    knock(): void;
+    setDisplayName(displayName: string): void;
+    toggleCamera(enabled?: boolean): void;
+    toggleMicrophone(enabled?: boolean): void;
+    acceptWaitingParticipant(participantId: string): void;
+    rejectWaitingParticipant(participantId: string): void;
+    startCloudRecording(): void;
+    startScreenshare(): void;
+    stopCloudRecording(): void;
+    stopScreenshare(): void;
+}
+type VideoViewComponentProps = Omit<React.ComponentProps<typeof _default>, "onResize">;
+interface RoomConnectionComponents {
+    VideoView: (props: VideoViewComponentProps) => ReturnType<typeof _default>;
+}
+type RoomConnectionRef = {
+    state: RoomConnectionState;
+    actions: RoomConnectionActions;
+    components: RoomConnectionComponents;
+    _ref: RoomConnection;
+};
+declare function useRoomConnection(roomUrl: string, roomConnectionOptions?: UseRoomConnectionOptions): RoomConnectionRef;
+
+declare const sdkVersion = "__SDK_VERSION__";
+
+export { type ChatMessageState as ChatMessage, type LocalParticipantState as LocalParticipant, type RemoteParticipantState as RemoteParticipant, type RoomConnectionState as RoomConnection, type ScreenshareState as Screenshare, type LocalMediaRef as UseLocalMediaResult, _default as VideoView, type WaitingParticipantState as WaitingParticipant, sdkVersion, useLocalMedia, useRoomConnection };