@whereby.com/browser-sdk 2.0.0-alpha23 → 2.0.0-alpha26

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.
Files changed (83) hide show
  1. package/README.md +14 -0
  2. package/dist/LocalMedia.d.ts +53 -0
  3. package/dist/LocalMedia.js +154 -0
  4. package/dist/RoomConnection.d.ts +174 -0
  5. package/dist/RoomConnection.js +617 -0
  6. package/dist/RoomParticipant.d.ts +50 -0
  7. package/dist/RoomParticipant.js +48 -0
  8. package/dist/api/ApiClient.d.ts +26 -0
  9. package/dist/api/ApiClient.js +63 -0
  10. package/dist/api/Credentials.d.ts +17 -0
  11. package/dist/api/Credentials.js +16 -0
  12. package/dist/api/HttpClient.d.ts +16 -0
  13. package/dist/api/HttpClient.js +53 -0
  14. package/dist/api/MultipartHttpClient.d.ts +10 -0
  15. package/dist/api/MultipartHttpClient.js +25 -0
  16. package/dist/api/OrganizationApiClient.d.ts +16 -0
  17. package/dist/api/OrganizationApiClient.js +30 -0
  18. package/dist/api/Response.d.ts +29 -0
  19. package/dist/api/Response.js +9 -0
  20. package/dist/api/credentialsService/index.d.ts +27 -0
  21. package/dist/api/credentialsService/index.js +90 -0
  22. package/dist/api/deviceService/index.d.ts +9 -0
  23. package/dist/api/deviceService/index.js +25 -0
  24. package/dist/api/extractUtils.d.ts +16 -0
  25. package/dist/api/extractUtils.js +51 -0
  26. package/dist/api/index.d.ts +7 -0
  27. package/dist/api/index.js +7 -0
  28. package/dist/api/localStorageWrapper/index.d.ts +2 -0
  29. package/dist/api/localStorageWrapper/index.js +15 -0
  30. package/dist/api/models/Account.d.ts +20 -0
  31. package/dist/api/models/Account.js +24 -0
  32. package/dist/api/models/Meeting.d.ts +12 -0
  33. package/dist/api/models/Meeting.js +29 -0
  34. package/dist/api/models/Organization.d.ts +102 -0
  35. package/dist/api/models/Organization.js +81 -0
  36. package/dist/api/models/Room.d.ts +4 -0
  37. package/dist/api/models/Room.js +38 -0
  38. package/dist/api/models/account/EmbeddedFreeTierStatus.d.ts +13 -0
  39. package/dist/api/models/account/EmbeddedFreeTierStatus.js +17 -0
  40. package/dist/api/modules/AbstractStore.d.ts +5 -0
  41. package/dist/api/modules/AbstractStore.js +1 -0
  42. package/dist/api/modules/ChromeStorageStore.d.ts +10 -0
  43. package/dist/api/modules/ChromeStorageStore.js +21 -0
  44. package/dist/api/modules/LocalStorageStore.d.ts +9 -0
  45. package/dist/api/modules/LocalStorageStore.js +35 -0
  46. package/dist/api/modules/tests/__mocks__/storage.d.ts +10 -0
  47. package/dist/api/modules/tests/__mocks__/storage.js +19 -0
  48. package/dist/api/organizationService/index.d.ts +46 -0
  49. package/dist/api/organizationService/index.js +159 -0
  50. package/dist/api/organizationServiceCache/index.d.ts +13 -0
  51. package/dist/api/organizationServiceCache/index.js +20 -0
  52. package/dist/api/parameterAssertUtils.d.ts +13 -0
  53. package/dist/api/parameterAssertUtils.js +64 -0
  54. package/dist/api/roomService/index.d.ts +54 -0
  55. package/dist/api/roomService/index.js +160 -0
  56. package/dist/api/test/helpers.d.ts +5 -0
  57. package/dist/api/test/helpers.js +32 -0
  58. package/dist/api/types.d.ts +5 -0
  59. package/dist/api/types.js +1 -0
  60. package/dist/embed/index.d.ts +31 -0
  61. package/dist/embed/index.js +123 -0
  62. package/dist/index.d.ts +5 -0
  63. package/dist/index.js +5 -0
  64. package/dist/react/VideoView.d.ts +15 -0
  65. package/dist/react/VideoView.js +37 -0
  66. package/dist/react/index.d.ts +3 -0
  67. package/dist/react/index.js +3 -0
  68. package/dist/react/useLocalMedia.d.ts +28 -0
  69. package/dist/react/useLocalMedia.js +109 -0
  70. package/dist/react/useRoomConnection.d.ts +47 -0
  71. package/dist/react/useRoomConnection.js +283 -0
  72. package/dist/utils/debounce.d.ts +9 -0
  73. package/dist/utils/debounce.js +20 -0
  74. package/dist/utils/fakeAudioStream.d.ts +1 -0
  75. package/dist/utils/fakeAudioStream.js +18 -0
  76. package/dist/utils/fakeWebcamFrame.d.ts +1 -0
  77. package/dist/utils/fakeWebcamFrame.js +49 -0
  78. package/dist/v2-alpha26.js +1993 -0
  79. package/package.json +24 -12
  80. package/dist/lib.cjs +0 -6200
  81. package/dist/lib.esm.js +0 -6182
  82. package/dist/types.d.ts +0 -382
  83. package/dist/v2-alpha23.js +0 -43
package/dist/types.d.ts DELETED
@@ -1,382 +0,0 @@
1
- import React from 'react';
2
- import RtcManager from '@whereby/jslib-media/src/webrtc/RtcManager';
3
- import { ChatMessage as ChatMessage$1 } from '@whereby/jslib-media/src/utils/ServerSocket';
4
-
5
- interface WherebyEmbedAttributes {
6
- audio: string;
7
- avatarUrl: string;
8
- background: string;
9
- cameraAccess: string;
10
- chat: string;
11
- displayName: string;
12
- emptyRoomInvitation: string;
13
- floatSelf: string;
14
- help: string;
15
- leaveButton: string;
16
- logo: string;
17
- people: string;
18
- precallReview: string;
19
- recording: string;
20
- screenshare: string;
21
- video: string;
22
- virtualBackgroundUrl: string;
23
- room: string;
24
- style: {
25
- [key: string]: string;
26
- };
27
- }
28
- declare global {
29
- namespace JSX {
30
- interface IntrinsicElements {
31
- ["whereby-embed"]: Partial<WherebyEmbedAttributes>;
32
- }
33
- }
34
- }
35
-
36
- interface VideoViewSelfProps {
37
- stream: MediaStream;
38
- muted?: boolean;
39
- style?: React.CSSProperties;
40
- onResize?: ({ width, height, stream }: {
41
- width: number;
42
- height: number;
43
- stream: MediaStream;
44
- }) => void;
45
- }
46
- type VideoViewProps = VideoViewSelfProps & React.DetailedHTMLProps<React.VideoHTMLAttributes<HTMLVideoElement>, HTMLVideoElement>;
47
- declare const _default: ({ muted, stream, onResize, ...rest }: VideoViewProps) => JSX.Element;
48
-
49
- type CameraEnabledEvent = {
50
- enabled: boolean;
51
- };
52
- type MicrophoneEnabledEvent = {
53
- enabled: boolean;
54
- };
55
- type DeviceListUpdatedEvent = {
56
- cameraDevices: MediaDeviceInfo[];
57
- microphoneDevices: MediaDeviceInfo[];
58
- speakerDevices: MediaDeviceInfo[];
59
- };
60
- type DeviceListUpdateErrorEvent = {
61
- error: unknown;
62
- };
63
- type StreamUpdatedEvent = {
64
- stream: MediaStream;
65
- };
66
- interface LocalMediaEventsMap {
67
- camera_enabled: CustomEvent<CameraEnabledEvent>;
68
- device_list_updated: CustomEvent<DeviceListUpdatedEvent>;
69
- device_list_update_error: CustomEvent<DeviceListUpdateErrorEvent>;
70
- microphone_enabled: CustomEvent<MicrophoneEnabledEvent>;
71
- stream_updated: CustomEvent<StreamUpdatedEvent>;
72
- }
73
- interface LocalMediaEventTarget extends EventTarget {
74
- addEventListener<K extends keyof LocalMediaEventsMap>(type: K, listener: (ev: LocalMediaEventsMap[K]) => void, options?: boolean | AddEventListenerOptions): void;
75
- addEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: EventListenerOptions | boolean): void;
76
- }
77
- declare const TypedLocalMediaEventTarget: new () => LocalMediaEventTarget;
78
- declare class LocalMedia extends TypedLocalMediaEventTarget {
79
- private _constraints;
80
- _rtcManagers: RtcManager[];
81
- stream: MediaStream;
82
- screenshareStream?: MediaStream;
83
- constructor(constraints: MediaStreamConstraints);
84
- addRtcManager(rtcManager: RtcManager): void;
85
- removeRtcManager(rtcManager: RtcManager): void;
86
- getCameraDeviceId(): string | undefined;
87
- getMicrophoneDeviceId(): string | undefined;
88
- isCameraEnabled(): boolean;
89
- isMicrophoneEnabled(): boolean;
90
- toggleCameraEnabled(enabled?: boolean): void;
91
- toggleMichrophoneEnabled(enabled?: boolean): void;
92
- startScreenshare(): Promise<MediaStream>;
93
- stopScreenshare(): void;
94
- setCameraDevice(deviceId: string): Promise<void>;
95
- setMicrophoneDevice(deviceId: string): Promise<void>;
96
- private _updateDeviceList;
97
- start(): Promise<MediaStream>;
98
- stop(): void;
99
- }
100
-
101
- interface LocalMediaState {
102
- currentCameraDeviceId?: string;
103
- currentMicrophoneDeviceId?: string;
104
- cameraDeviceError: unknown;
105
- cameraDevices: MediaDeviceInfo[];
106
- isSettingCameraDevice: boolean;
107
- isSettingMicrophoneDevice: boolean;
108
- isStarting: boolean;
109
- localStream?: MediaStream;
110
- microphoneDeviceError: unknown;
111
- microphoneDevices: MediaDeviceInfo[];
112
- speakerDevices: MediaDeviceInfo[];
113
- startError: unknown;
114
- }
115
- interface LocalMediaActions {
116
- setCameraDevice: InstanceType<typeof LocalMedia>["setCameraDevice"];
117
- setMicrophoneDevice: InstanceType<typeof LocalMedia>["setMicrophoneDevice"];
118
- toggleCameraEnabled: InstanceType<typeof LocalMedia>["toggleCameraEnabled"];
119
- toggleMicrophoneEnabled: InstanceType<typeof LocalMedia>["toggleMichrophoneEnabled"];
120
- }
121
- type LocalMediaRef = {
122
- state: LocalMediaState;
123
- actions: LocalMediaActions;
124
- _ref: LocalMedia;
125
- };
126
- declare function useLocalMedia(constraints?: MediaStreamConstraints): LocalMediaRef;
127
-
128
- interface RoomParticipantData {
129
- displayName: string;
130
- id: string;
131
- stream?: MediaStream;
132
- isAudioEnabled: boolean;
133
- isVideoEnabled: boolean;
134
- }
135
- declare class RoomParticipant {
136
- readonly displayName: string;
137
- readonly id: string;
138
- readonly stream?: MediaStream;
139
- readonly isAudioEnabled: boolean;
140
- readonly isLocalParticipant: boolean;
141
- readonly isVideoEnabled: boolean;
142
- constructor({ displayName, id, stream, isAudioEnabled, isVideoEnabled }: RoomParticipantData);
143
- }
144
- interface RemoteParticipantData {
145
- newJoiner: boolean;
146
- streams: string[];
147
- }
148
- type StreamState = "new_accept" | "to_accept" | "old_accept" | "done_accept" | "to_unaccept" | "done_unaccept" | "auto";
149
- interface Stream {
150
- id: string;
151
- state: StreamState;
152
- }
153
- declare class RemoteParticipant extends RoomParticipant {
154
- readonly newJoiner: boolean;
155
- readonly streams: Stream[];
156
- constructor({ displayName, id, newJoiner, streams, isAudioEnabled, isVideoEnabled, }: RoomParticipantData & RemoteParticipantData);
157
- addStream(streamId: string, state: StreamState): void;
158
- removeStream(streamId: string): void;
159
- updateStreamState(streamId: string, state: StreamState): void;
160
- }
161
- declare class LocalParticipant extends RoomParticipant {
162
- readonly isLocalParticipant = true;
163
- constructor({ displayName, id, stream, isAudioEnabled, isVideoEnabled }: RoomParticipantData);
164
- }
165
- interface WaitingParticipant {
166
- id: string;
167
- displayName: string | null;
168
- }
169
- declare class Screenshare {
170
- readonly participantId: string;
171
- readonly id: string;
172
- readonly hasAudioTrack: boolean;
173
- readonly stream?: MediaStream;
174
- readonly isLocal: boolean;
175
- constructor({ participantId, id, hasAudioTrack, stream, isLocal }: Screenshare);
176
- }
177
-
178
- type Logger = Pick<Console, "debug" | "error" | "log" | "warn">;
179
- interface RoomConnectionOptions {
180
- displayName?: string;
181
- localMediaConstraints?: MediaStreamConstraints;
182
- roomKey?: string;
183
- logger?: Logger;
184
- localMedia?: LocalMedia;
185
- }
186
- type ChatMessage = Pick<ChatMessage$1, "senderId" | "timestamp" | "text">;
187
- type RoomConnectionStatus = "" | "connecting" | "connected" | "room_locked" | "knocking" | "disconnecting" | "disconnected" | "accepted" | "rejected";
188
- type CloudRecordingState = {
189
- status: "" | "recording";
190
- startedAt: number | null;
191
- };
192
- type StreamingState = {
193
- status: "" | "streaming";
194
- startedAt: number | null;
195
- };
196
- type RoomJoinedEvent = {
197
- localParticipant: LocalParticipant;
198
- remoteParticipants: RemoteParticipant[];
199
- waitingParticipants: WaitingParticipant[];
200
- };
201
- type RoomConnectionStatusChangedEvent = {
202
- roomConnectionStatus: RoomConnectionStatus;
203
- };
204
- type ParticipantJoinedEvent = {
205
- remoteParticipant: RemoteParticipant;
206
- };
207
- type ParticipantLeftEvent = {
208
- participantId: string;
209
- };
210
- type ParticipantStreamAddedEvent = {
211
- participantId: string;
212
- stream: MediaStream;
213
- };
214
- type ParticipantAudioEnabledEvent = {
215
- participantId: string;
216
- isAudioEnabled: boolean;
217
- };
218
- type ParticipantVideoEnabledEvent = {
219
- participantId: string;
220
- isVideoEnabled: boolean;
221
- };
222
- type ParticipantMetadataChangedEvent = {
223
- participantId: string;
224
- displayName: string;
225
- };
226
- type ScreenshareStartedEvent = {
227
- participantId: string;
228
- id: string;
229
- hasAudioTrack: boolean;
230
- stream: MediaStream;
231
- isLocal: boolean;
232
- };
233
- type ScreenshareStoppedEvent = {
234
- participantId: string;
235
- id: string;
236
- };
237
- type WaitingParticipantJoinedEvent = {
238
- participantId: string;
239
- displayName: string | null;
240
- };
241
- type WaitingParticipantLeftEvent = {
242
- participantId: string;
243
- };
244
- interface RoomEventsMap {
245
- chat_message: (e: CustomEvent<ChatMessage>) => void;
246
- cloud_recording_started: (e: CustomEvent<CloudRecordingState>) => void;
247
- cloud_recording_stopped: (e: CustomEvent<CloudRecordingState>) => void;
248
- participant_audio_enabled: (e: CustomEvent<ParticipantAudioEnabledEvent>) => void;
249
- participant_joined: (e: CustomEvent<ParticipantJoinedEvent>) => void;
250
- participant_left: (e: CustomEvent<ParticipantLeftEvent>) => void;
251
- participant_metadata_changed: (e: CustomEvent<ParticipantMetadataChangedEvent>) => void;
252
- participant_stream_added: (e: CustomEvent<ParticipantStreamAddedEvent>) => void;
253
- participant_video_enabled: (e: CustomEvent<ParticipantVideoEnabledEvent>) => void;
254
- room_connection_status_changed: (e: CustomEvent<RoomConnectionStatusChangedEvent>) => void;
255
- room_joined: (e: CustomEvent<RoomJoinedEvent>) => void;
256
- screenshare_started: (e: CustomEvent<ScreenshareStartedEvent>) => void;
257
- screenshare_stopped: (e: CustomEvent<ScreenshareStoppedEvent>) => void;
258
- streaming_started: (e: CustomEvent<StreamingState>) => void;
259
- streaming_stopped: (e: CustomEvent<StreamingState>) => void;
260
- waiting_participant_joined: (e: CustomEvent<WaitingParticipantJoinedEvent>) => void;
261
- waiting_participant_left: (e: CustomEvent<WaitingParticipantLeftEvent>) => void;
262
- }
263
- interface RoomEventTarget extends EventTarget {
264
- addEventListener<K extends keyof RoomEventsMap>(type: K, listener: RoomEventsMap[K], options?: boolean | AddEventListenerOptions): void;
265
- addEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: EventListenerOptions | boolean): void;
266
- removeEventListener<K extends keyof RoomEventsMap>(type: K, listener: RoomEventsMap[K], options?: boolean | EventListenerOptions): void;
267
- removeEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: EventListenerOptions | boolean): void;
268
- }
269
- declare const TypedEventTarget: new () => RoomEventTarget;
270
- declare class RoomConnection extends TypedEventTarget {
271
- localMedia: LocalMedia;
272
- localParticipant: LocalParticipant | null;
273
- roomUrl: URL;
274
- remoteParticipants: RemoteParticipant[];
275
- screenshares: Screenshare[];
276
- readonly localMediaConstraints?: MediaStreamConstraints;
277
- readonly roomName: string;
278
- private organizationId;
279
- private credentialsService;
280
- private apiClient;
281
- private organizationService;
282
- private organizationServiceCache;
283
- private organizationApiClient;
284
- private roomService;
285
- private _deviceCredentials;
286
- private signalSocket;
287
- private signalSocketManager;
288
- private rtcManagerDispatcher?;
289
- private rtcManager?;
290
- private roomConnectionStatus;
291
- private selfId;
292
- private logger;
293
- private _ownsLocalMedia;
294
- private displayName?;
295
- private _roomKey;
296
- constructor(roomUrl: string, { displayName, localMedia, localMediaConstraints, logger, roomKey }: RoomConnectionOptions);
297
- get roomKey(): string | null;
298
- private _handleNewChatMessage;
299
- private _handleCloudRecordingStarted;
300
- private _handleStreamingStarted;
301
- private _handleNewClient;
302
- private _handleClientLeft;
303
- private _handleClientAudioEnabled;
304
- private _handleClientVideoEnabled;
305
- private _handleClientMetadataReceived;
306
- private _handleKnockHandled;
307
- private _handleKnockerLeft;
308
- private _handleRoomJoined;
309
- private _handleRoomKnocked;
310
- private _handleReconnect;
311
- private _handleDisconnect;
312
- private _handleCloudRecordingStopped;
313
- private _handleStreamingStopped;
314
- private _handleScreenshareStarted;
315
- private _handleScreenshareStopped;
316
- private _handleRtcEvent;
317
- private _handleRtcManagerCreated;
318
- private _handleRtcManagerDestroyed;
319
- private _handleAcceptStreams;
320
- private _handleStreamAdded;
321
- private _joinRoom;
322
- join(): Promise<void>;
323
- knock(): void;
324
- leave(): void;
325
- sendChatMessage(text: string): void;
326
- setDisplayName(displayName: string): void;
327
- acceptWaitingParticipant(participantId: string): void;
328
- rejectWaitingParticipant(participantId: string): void;
329
- updateStreamResolution({ streamId, width, height }: {
330
- streamId?: string;
331
- width: number;
332
- height: number;
333
- }): void;
334
- startScreenshare(): Promise<void>;
335
- stopScreenshare(): void;
336
- }
337
-
338
- type RemoteParticipantState = Omit<RemoteParticipant, "updateStreamState">;
339
- interface RoomConnectionState {
340
- chatMessages: ChatMessage[];
341
- cloudRecording: CloudRecordingState;
342
- isJoining: boolean;
343
- isStartingScreenshare: boolean;
344
- joinError: unknown;
345
- startScreenshareError: unknown;
346
- localParticipant?: LocalParticipant;
347
- mostRecentChatMessage: ChatMessage | null;
348
- remoteParticipants: RemoteParticipantState[];
349
- screenshares: Screenshare[];
350
- roomConnectionStatus: RoomConnectionStatus;
351
- streaming: StreamingState;
352
- waitingParticipants: WaitingParticipant[];
353
- }
354
- interface UseRoomConnectionOptions extends Omit<RoomConnectionOptions, "localMedia"> {
355
- localMedia?: LocalMediaRef;
356
- }
357
- interface RoomConnectionActions {
358
- sendChatMessage(text: string): void;
359
- knock(): void;
360
- setDisplayName(displayName: string): void;
361
- toggleCamera(enabled?: boolean): void;
362
- toggleMicrophone(enabled?: boolean): void;
363
- acceptWaitingParticipant(participantId: string): void;
364
- rejectWaitingParticipant(participantId: string): void;
365
- startScreenshare(): void;
366
- stopScreenshare(): void;
367
- }
368
- type VideoViewComponentProps = Omit<React.ComponentProps<typeof _default>, "onResize">;
369
- interface RoomConnectionComponents {
370
- VideoView: (props: VideoViewComponentProps) => ReturnType<typeof _default>;
371
- }
372
- type RoomConnectionRef = {
373
- state: RoomConnectionState;
374
- actions: RoomConnectionActions;
375
- components: RoomConnectionComponents;
376
- _ref: RoomConnection;
377
- };
378
- declare function useRoomConnection(roomUrl: string, roomConnectionOptions: UseRoomConnectionOptions): RoomConnectionRef;
379
-
380
- declare const sdkVersion = "2.0.0-alpha23";
381
-
382
- export { _default as VideoView, sdkVersion, useLocalMedia, useRoomConnection };