Include forwardedRefs in autogenerated component docs (#887)

livekit · Jun 6, 2024 · 589ed63 · 589ed63
1 parent ce90dd1
commit 589ed63
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 12 deletions.
diff --git a/packages/react/etc/components-react.api.md b/packages/react/etc/components-react.api.md
@@ -868,7 +868,7 @@ export interface UseMediaDeviceSelectProps {
 }
 
 // @alpha
-export const useMultibandTrackVolume: (trackOrTrackReference?: LocalAudioTrack | RemoteAudioTrack | TrackReferenceOrPlaceholder, options?: MultiBandTrackVolumeOptions) => number[];
+export function useMultibandTrackVolume(trackOrTrackReference?: LocalAudioTrack | RemoteAudioTrack | TrackReferenceOrPlaceholder, options?: MultiBandTrackVolumeOptions): number[];
 
 // @alpha
 export function usePagination(itemPerPage: number, trackReferences: TrackReferenceOrPlaceholder[]): {
@@ -1121,7 +1121,7 @@ export function useTrackTranscription(trackRef: TrackReferenceOrPlaceholder, opt
 };
 
 // @alpha
-export const useTrackVolume: (trackOrTrackReference?: LocalAudioTrack | RemoteAudioTrack | TrackReference, options?: AudioAnalyserOptions) => number;
+export function useTrackVolume(trackOrTrackReference?: LocalAudioTrack | RemoteAudioTrack | TrackReference, options?: AudioAnalyserOptions): number;
 
 // @public
 export function useVisualStableUpdate(

diff --git a/packages/react/src/hooks/useTrackVolume.ts b/packages/react/src/hooks/useTrackVolume.ts
@@ -11,10 +11,10 @@ import {
  * @alpha
  * Hook for tracking the volume of an audio track using the Web Audio API.
  */
-export const useTrackVolume = (
+export function useTrackVolume(
   trackOrTrackReference?: LocalAudioTrack | RemoteAudioTrack | TrackReference,
   options: AudioAnalyserOptions = { fftSize: 32, smoothingTimeConstant: 0 },
-) => {
+) {
   const track = isTrackReference(trackOrTrackReference)
     ? <LocalAudioTrack | RemoteAudioTrack | undefined>trackOrTrackReference.publication.track
     : trackOrTrackReference;
@@ -48,7 +48,7 @@ export const useTrackVolume = (
   }, [track, track?.mediaStream, JSON.stringify(options)]);
 
   return volume;
-};
+}
 
 const normalizeFrequencies = (frequencies: Float32Array) => {
   const normalizeDb = (value: number) => {
@@ -104,10 +104,10 @@ const multibandDefaults = {
  * Hook for tracking the volume of an audio track across multiple frequency bands using the Web Audio API.
  * @alpha
  */
-export const useMultibandTrackVolume = (
+export function useMultibandTrackVolume(
   trackOrTrackReference?: LocalAudioTrack | RemoteAudioTrack | TrackReferenceOrPlaceholder,
   options: MultiBandTrackVolumeOptions = {},
-) => {
+) {
   const track =
     trackOrTrackReference instanceof Track
       ? trackOrTrackReference
@@ -153,4 +153,4 @@ export const useMultibandTrackVolume = (
   }, [track, track?.mediaStream, JSON.stringify(options)]);
 
   return frequencyBands;
-};
+}
diff --git a/tooling/api-documenter/src/documenters/MarkdownDocumenter.ts b/tooling/api-documenter/src/documenters/MarkdownDocumenter.ts
@@ -181,7 +181,7 @@ export class MarkdownDocumenter {
         pageTitle = `${scopedName} type`;
         break;
       case ApiItemKind.Variable:
-        pageTitle = `${scopedName} variable`;
+        pageTitle = `${scopedName}`;
         break;
       default:
         throw new Error('Unsupported API item kind: ' + apiItem.kind);

diff --git a/tooling/api-documenter/src/livekitUtils/classifiers.ts b/tooling/api-documenter/src/livekitUtils/classifiers.ts
@@ -1,4 +1,9 @@
-import { ApiFunction, ApiItem } from '@microsoft/api-extractor-model';
+import {
+  ApiFunction,
+  ApiItem,
+  ApiVariable,
+  ExcerptTokenKind,
+} from '@microsoft/api-extractor-model';
 
 export type LkType = 'component' | 'hook' | 'prefab' | undefined;
 function isHook(apiItem: ApiItem): boolean {
@@ -13,11 +18,30 @@ function isPrefab(apiItem: ApiItem): boolean {
   }
   return false;
 }
+
+function isConstDeclarationComponent(apiItem: ApiItem): boolean {
+  return (
+    apiItem instanceof ApiVariable &&
+    apiItem.isReadonly &&
+    apiItem.excerptTokens.some(
+      (token) =>
+        token.kind === ExcerptTokenKind.Reference &&
+        ['React.ReactNode', 'React.Context'].includes(token.text),
+    )
+  );
+}
+
 function isComponent(apiItem: ApiItem): boolean {
-  if (apiItem instanceof ApiFunction) {
+  if (
+    apiItem instanceof ApiFunction ||
+    (apiItem instanceof ApiVariable && isConstDeclarationComponent(apiItem))
+  ) {
     return (
       isComponentReactPackage(apiItem) &&
-      !!apiItem.fileUrlPath?.startsWith('src/components/') &&
+      !!(
+        apiItem.fileUrlPath?.startsWith('src/components/') ||
+        apiItem.fileUrlPath?.startsWith('src/context/')
+      ) &&
       startsWithCapitalLetter(apiItem.displayName)
     );
   }