chore(react): deprecate legacy useTrackTranscriptions (#1200)

Author: lukasIO

.changeset/slow-swans-invite.md

@@ -0,0 +1,6 @@
+---
+"@livekit/components-core": patch
+"@livekit/components-react": patch
+---
+
+chore(react): deprecate legacy useTrackTranscriptions

packages/core/etc/components-core.api.md

@@ -412,6 +412,8 @@ export type PinState = TrackReferenceOrPlaceholder[];
 
 // @public (undocumented)
 export interface ReceivedChatMessage extends ChatMessage {
+    // (undocumented)
+    attributes?: Record<string, string>;
     // (undocumented)
     from?: Participant;
 }

packages/react/etc/components-react.api.md

@@ -680,7 +680,7 @@ export interface TrackToggleProps<T extends ToggleSource> extends Omit<React_2.B
     source: T;
 }
 
-// @alpha (undocumented)
+// @alpha @deprecated (undocumented)
 export interface TrackTranscriptionOptions {
     bufferSize?: number;
     onTranscription?: (newSegments: TranscriptionSegment[]) => void;
@@ -1185,7 +1185,7 @@ export function useTrackToggle<T extends ToggleSource>({ source, onChange, initi
 export interface UseTrackToggleProps<T extends ToggleSource> extends Omit<TrackToggleProps<T>, 'showIcon'> {
 }
 
-// @alpha (undocumented)
+// @alpha @deprecated (undocumented)
 export function useTrackTranscription(trackRef: TrackReferenceOrPlaceholder | undefined, options?: TrackTranscriptionOptions): {
     segments: ReceivedTranscriptionSegment[];
 };

packages/react/src/hooks/useTrackSyncTime.ts

@@ -4,6 +4,7 @@ import { useObservableState } from './internal';
 
 /**
  * @internal
+ * @deprecated this is an internal hook that's only used by deprecated APIs
  */
 export function useTrackSyncTime(ref: TrackReferenceOrPlaceholder | undefined) {
   const observable = React.useMemo(

packages/react/src/hooks/useTrackTranscription.ts

@@ -14,6 +14,7 @@ import { useTrackSyncTime } from './useTrackSyncTime';
 
 /**
  * @alpha
+ * @deprecated Use useTranscription instead
  */
 export interface TrackTranscriptionOptions {
   /**
@@ -37,6 +38,7 @@ const TRACK_TRANSCRIPTION_DEFAULTS = {
 /**
  * @returns An object consisting of `segments` with maximum length of opts.bufferSize
  * @alpha
+ * @deprecated Use useTranscription instead
  */
 export function useTrackTranscription(
   trackRef: TrackReferenceOrPlaceholder | undefined,