@whereby.com/browser-sdk 2.0.0-alpha → 2.0.0-alpha10

package/dist/types.d.ts

@@ -0,0 +1,308 @@
+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 WherebyEmbedAttributes {
+    audio: string;
+    avatarUrl: string;
+    background: string;
+    cameraAccess: string;
+    chat: string;
+    displayName: string;
+    emptyRoomInvitation: string;
+    floatSelf: string;
+    help: string;
+    leaveButton: string;
+    logo: string;
+    people: string;
+    precallReview: string;
+    recording: string;
+    screenshare: string;
+    video: string;
+    virtualBackgroundUrl: string;
+    room: string;
+    style: {
+        [key: string]: string;
+    };
+}
+declare global {
+    namespace JSX {
+        interface IntrinsicElements {
+            ["whereby-embed"]: Partial<WherebyEmbedAttributes>;
+        }
+    }
+}
+
+interface VideoViewSelfProps {
+    stream: MediaStream;
+    style?: React.CSSProperties;
+}
+type VideoViewProps = VideoViewSelfProps & React.DetailedHTMLProps<React.VideoHTMLAttributes<HTMLVideoElement>, HTMLVideoElement>;
+declare const _default: ({ muted, stream, ...rest }: VideoViewProps) => 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;
+};
+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>;
+}
+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;
+declare class LocalMedia extends TypedLocalMediaEventTarget {
+    private _constraints;
+    _rtcManagers: RtcManager[];
+    stream: MediaStream;
+    constructor(constraints: MediaStreamConstraints);
+    addRtcManager(rtcManager: RtcManager): void;
+    removeRtcManager(rtcManager: RtcManager): void;
+    getCameraDeviceId(): string | undefined;
+    getMicrophoneDeviceId(): string | undefined;
+    isCameraEnabled(): boolean;
+    isMicrophoneEnabled(): boolean;
+    toggleCameraEnabled(enabled?: boolean): void;
+    toggleMichrophoneEnabled(enabled?: boolean): void;
+    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;
+};
+declare function useLocalMedia(constraints?: MediaStreamConstraints): 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);
+    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;
+}
+
+type Logger = Pick<Console, "debug" | "error" | "log" | "warn">;
+interface RoomConnectionOptions {
+    displayName?: string;
+    localMediaConstraints?: MediaStreamConstraints;
+    roomKey?: string;
+    logger?: Logger;
+    localMedia?: LocalMedia;
+}
+type ChatMessage = Pick<ChatMessage$1, "senderId" | "timestamp" | "text">;
+type RoomConnectionStatus = "" | "connecting" | "connected" | "room_locked" | "knocking" | "disconnected" | "accepted" | "rejected";
+type RoomJoinedEvent = {
+    localParticipant: LocalParticipant;
+    remoteParticipants: RemoteParticipant[];
+    waitingParticipants: WaitingParticipant[];
+};
+type RoomConnectionStatusChangedEvent = {
+    roomConnectionStatus: RoomConnectionStatus;
+};
+type ParticipantJoinedEvent = {
+    remoteParticipant: RemoteParticipant;
+};
+type ParticipantLeftEvent = {
+    participantId: string;
+};
+type ParticipantStreamAddedEvent = {
+    participantId: string;
+    stream: MediaStream;
+};
+type ParticipantAudioEnabledEvent = {
+    participantId: string;
+    isAudioEnabled: boolean;
+};
+type ParticipantVideoEnabledEvent = {
+    participantId: string;
+    isVideoEnabled: boolean;
+};
+type ParticipantMetadataChangedEvent = {
+    participantId: string;
+    displayName: string;
+};
+type WaitingParticipantJoinedEvent = {
+    participantId: string;
+    displayName: string | null;
+};
+type WaitingParticipantLeftEvent = {
+    participantId: string;
+};
+interface RoomEventsMap {
+    chat_message: CustomEvent<ChatMessage>;
+    participant_audio_enabled: CustomEvent<ParticipantAudioEnabledEvent>;
+    participant_joined: CustomEvent<ParticipantJoinedEvent>;
+    participant_left: CustomEvent<ParticipantLeftEvent>;
+    participant_metadata_changed: CustomEvent<ParticipantMetadataChangedEvent>;
+    participant_stream_added: CustomEvent<ParticipantStreamAddedEvent>;
+    participant_video_enabled: CustomEvent<ParticipantVideoEnabledEvent>;
+    room_connection_status_changed: CustomEvent<RoomConnectionStatusChangedEvent>;
+    room_joined: CustomEvent<RoomJoinedEvent>;
+    waiting_participant_joined: CustomEvent<WaitingParticipantJoinedEvent>;
+    waiting_participant_left: CustomEvent<WaitingParticipantLeftEvent>;
+}
+interface RoomEventTarget extends EventTarget {
+    addEventListener<K extends keyof RoomEventsMap>(type: K, listener: (ev: RoomEventsMap[K]) => void, options?: boolean | AddEventListenerOptions): void;
+    addEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: EventListenerOptions | boolean): void;
+}
+declare const TypedEventTarget: new () => RoomEventTarget;
+declare class RoomConnection extends TypedEventTarget {
+    localMedia: LocalMedia;
+    localParticipant: LocalParticipant | null;
+    roomUrl: URL;
+    remoteParticipants: RemoteParticipant[];
+    readonly localMediaConstraints?: MediaStreamConstraints;
+    readonly roomName: string;
+    private organizationId;
+    private credentialsService;
+    private apiClient;
+    private organizationService;
+    private organizationServiceCache;
+    private organizationApiClient;
+    private roomService;
+    private signalSocket;
+    private rtcManagerDispatcher?;
+    private rtcManager?;
+    private roomConnectionStatus;
+    private logger;
+    private _ownsLocalMedia;
+    private displayName?;
+    private _roomKey;
+    constructor(roomUrl: string, { displayName, localMedia, localMediaConstraints, logger, roomKey }: RoomConnectionOptions);
+    get roomKey(): string | null;
+    private _handleNewChatMessage;
+    private _handleNewClient;
+    private _handleClientLeft;
+    private _handleClientAudioEnabled;
+    private _handleClientVideoEnabled;
+    private _handleClientMetadataReceived;
+    private _handleKnockHandled;
+    private _handleKnockerLeft;
+    private _handleRoomJoined;
+    private _handleRoomKnocked;
+    private _handleRtcEvent;
+    private _handleRtcManagerCreated;
+    private _handleAcceptStreams;
+    private _handleStreamAdded;
+    private _joinRoom;
+    join(): Promise<void>;
+    knock(): void;
+    leave(): Promise<void>;
+    sendChatMessage(text: string): void;
+    setDisplayName(displayName: string): void;
+    acceptWaitingParticipant(participantId: string): void;
+    rejectWaitingParticipant(participantId: string): void;
+}
+
+type RemoteParticipantState = Omit<RemoteParticipant, "updateStreamState">;
+interface RoomConnectionState {
+    chatMessages: ChatMessage[];
+    isJoining: boolean;
+    joinError: unknown;
+    localParticipant?: LocalParticipant;
+    mostRecentChatMessage: ChatMessage | null;
+    roomConnectionStatus: RoomConnectionStatus;
+    remoteParticipants: RemoteParticipantState[];
+    waitingParticipants: WaitingParticipant[];
+}
+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;
+}
+interface RoomConnectionComponents {
+    VideoView: typeof _default;
+}
+type RoomConnectionRef = {
+    state: RoomConnectionState;
+    actions: RoomConnectionActions;
+    components: RoomConnectionComponents;
+    _ref: RoomConnection;
+};
+declare function useRoomConnection(roomUrl: string, roomConnectionOptions: UseRoomConnectionOptions): RoomConnectionRef;
+
+declare const sdkVersion = "2.0.0-alpha10";
+
+export { _default as VideoView, sdkVersion, useLocalMedia, useRoomConnection };