From 67d62ba3cb902d5b55fb553c1ab8480a12fb1d55 Mon Sep 17 00:00:00 2001 From: lukasIO Date: Tue, 7 Nov 2023 12:26:03 +0200 Subject: [PATCH] Deprecate showE2EE options on PreJoin (#693) --- .changeset/thin-zoos-tell.md | 6 ++++++ examples/nextjs/pages/e2ee.tsx | 3 +-- examples/nextjs/pages/minimal.tsx | 3 +-- examples/nextjs/pages/prejoin.tsx | 5 ++--- packages/react/etc/components-react.api.md | 9 +++++++-- packages/react/src/index.ts | 10 ++++++++++ packages/react/src/prefabs/PreJoin.tsx | 3 ++- packages/react/src/prefabs/index.ts | 8 -------- 8 files changed, 29 insertions(+), 18 deletions(-) create mode 100644 .changeset/thin-zoos-tell.md diff --git a/.changeset/thin-zoos-tell.md b/.changeset/thin-zoos-tell.md new file mode 100644 index 000000000..4c4de6f7c --- /dev/null +++ b/.changeset/thin-zoos-tell.md @@ -0,0 +1,6 @@ +--- +"@livekit/components-react": minor +"@livekit/component-example-next": minor +--- + +Deprecate showE2EE options on PreJoin diff --git a/examples/nextjs/pages/e2ee.tsx b/examples/nextjs/pages/e2ee.tsx index acbb3292e..21f2706c6 100644 --- a/examples/nextjs/pages/e2ee.tsx +++ b/examples/nextjs/pages/e2ee.tsx @@ -1,5 +1,4 @@ -import { setLogLevel } from '@livekit/components-core'; -import { LiveKitRoom, useToken, VideoConference } from '@livekit/components-react'; +import { LiveKitRoom, useToken, VideoConference, setLogLevel } from '@livekit/components-react'; import type { NextPage } from 'next'; import * as React from 'react'; import { Room, ExternalE2EEKeyProvider } from 'livekit-client'; diff --git a/examples/nextjs/pages/minimal.tsx b/examples/nextjs/pages/minimal.tsx index f800e45c1..e6b21557f 100644 --- a/examples/nextjs/pages/minimal.tsx +++ b/examples/nextjs/pages/minimal.tsx @@ -1,5 +1,4 @@ -import { setLogLevel } from '@livekit/components-core'; -import { LiveKitRoom, useToken, VideoConference } from '@livekit/components-react'; +import { LiveKitRoom, useToken, VideoConference, setLogLevel } from '@livekit/components-react'; import { RoomConnectOptions } from 'livekit-client'; import type { NextPage } from 'next'; import { generateRandomUserId } from '../lib/helper'; diff --git a/examples/nextjs/pages/prejoin.tsx b/examples/nextjs/pages/prejoin.tsx index 2e3243dee..23c01d468 100644 --- a/examples/nextjs/pages/prejoin.tsx +++ b/examples/nextjs/pages/prejoin.tsx @@ -1,6 +1,5 @@ import * as React from 'react'; -import { setLogLevel } from '@livekit/components-core'; -import { PreJoin } from '@livekit/components-react'; +import { PreJoin, setLogLevel } from '@livekit/components-react'; import type { NextPage } from 'next'; const PreJoinExample: NextPage = () => { @@ -8,7 +7,7 @@ const PreJoinExample: NextPage = () => { return (
- +
); }; diff --git a/packages/react/etc/components-react.api.md b/packages/react/etc/components-react.api.md index 651c5e0f0..ee5120f4c 100644 --- a/packages/react/etc/components-react.api.md +++ b/packages/react/etc/components-react.api.md @@ -38,6 +38,7 @@ import type { RoomConnectOptions } from 'livekit-client'; import type { RoomEvent } from 'livekit-client'; import type { RoomOptions } from 'livekit-client'; import type { ScreenShareCaptureOptions } from 'livekit-client'; +import { setLogLevel } from '@livekit/components-core'; import { SetMediaDeviceOptions } from '@livekit/components-core'; import type { SourcesArray } from '@livekit/components-core'; import type { ToggleSource } from '@livekit/components-core'; @@ -47,7 +48,7 @@ import { TrackPublication } from 'livekit-client'; import type { TrackReference } from '@livekit/components-core'; import { TrackReferenceOrPlaceholder } from '@livekit/components-core'; import type { TrackSourceWithOptions } from '@livekit/components-core'; -import type { UserChoices } from '@livekit/components-core'; +import { UserChoices } from '@livekit/components-core'; import type { VideoCaptureOptions } from 'livekit-client'; import type { VideoSource } from '@livekit/components-core'; import type { WidgetState } from '@livekit/components-core'; @@ -445,7 +446,7 @@ export interface PreJoinProps extends Omit boolean; // @alpha persistUserChoices?: boolean; - // (undocumented) + // @deprecated (undocumented) showE2EEOptions?: boolean; // (undocumented) userLabel?: string; @@ -475,6 +476,8 @@ export interface RoomNameProps extends React_2.HTMLAttributes { childrenPosition?: 'before' | 'after'; } +export { setLogLevel } + // @public export function StartAudio({ label, ...props }: AllowAudioPlaybackProps): React_2.JSX.Element; @@ -859,6 +862,8 @@ export function usePreviewDevice(en // @alpha (undocumented) export function usePreviewTracks(options: CreateLocalTracksOptions, onError?: (err: Error) => void): LocalTrack[] | undefined; +export { UserChoices } + // @public export function useRemoteParticipant(identity: string, options?: UseRemoteParticipantOptions): RemoteParticipant | undefined; diff --git a/packages/react/src/index.ts b/packages/react/src/index.ts index c2dd44920..937b15f7f 100644 --- a/packages/react/src/index.ts +++ b/packages/react/src/index.ts @@ -5,3 +5,13 @@ export * from './hooks'; export * from './prefabs'; export * from './context'; + +// Re-exports from core +export { setLogLevel } from '@livekit/components-core'; +export type { + ChatMessage, + ReceivedChatMessage, + MessageDecoder, + MessageEncoder, + UserChoices, +} from '@livekit/components-core'; diff --git a/packages/react/src/prefabs/PreJoin.tsx b/packages/react/src/prefabs/PreJoin.tsx index 87faebcb0..cdf8e369a 100644 --- a/packages/react/src/prefabs/PreJoin.tsx +++ b/packages/react/src/prefabs/PreJoin.tsx @@ -21,7 +21,7 @@ import { ParticipantPlaceholder } from '../assets/images'; import { useMediaDevices, usePersistentUserChoices } from '../hooks'; /** - * @deprecated Use `UserChoices` from `@livekit/components-core` instead. + * @deprecated Use `UserChoices` instead. * @public */ export type LocalUserChoices = { @@ -65,6 +65,7 @@ export interface PreJoinProps micLabel?: string; camLabel?: string; userLabel?: string; + /** @deprecated E2EE options will be removed from PreJoin in a future version **/ showE2EEOptions?: boolean; /** diff --git a/packages/react/src/prefabs/index.ts b/packages/react/src/prefabs/index.ts index a5ee88050..e63bfdd77 100644 --- a/packages/react/src/prefabs/index.ts +++ b/packages/react/src/prefabs/index.ts @@ -10,11 +10,3 @@ export { VideoConference, type VideoConferenceProps } from './VideoConference'; export { ControlBar, type ControlBarProps, type ControlBarControls } from './ControlBar'; export { MediaDeviceMenu, type MediaDeviceMenuProps } from './MediaDeviceMenu'; export { AudioConference, type AudioConferenceProps } from './AudioConference'; - -// Re-export types from core -export { - type ChatMessage, - type ReceivedChatMessage, - type MessageDecoder, - type MessageEncoder, -} from '@livekit/components-core';