refactor: rename useLensPerformanceMetrics to useLensFrameMetrics

Aligns with the SDK's ComputedFrameMetrics return type and is
more specific about what is being measured.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: msilivonik-sc

README.md

@@ -88,13 +88,13 @@ function Preview() {
 
 ### Performance Metrics
 
-Use `useLensPerformanceMetrics` to monitor lens rendering performance:
+Use `useLensFrameMetrics` to monitor lens rendering performance:
 
 ```tsx
-import { useLensPerformanceMetrics } from "@snap/react-camera-kit";
+import { useLensFrameMetrics } from "@snap/react-camera-kit";
 
 function PerformanceOverlay() {
-  const metrics = useLensPerformanceMetrics({ interval: 500 });
+  const metrics = useLensFrameMetrics({ interval: 500 });
 
   if (!metrics) return null;
 

src/index.ts

@@ -17,7 +17,7 @@ export { useApplyLens } from "./useApplyLens";
 export { useApplySource } from "./useApplySource";
 export { usePlaybackOptions } from "./usePlaybackOptions";
 export type { PlaybackOptions } from "./usePlaybackOptions";
-export { useLensPerformanceMetrics } from "./useLensPerformanceMetrics";
+export { useLensFrameMetrics } from "./useLensFrameMetrics";
 
 // Types
 export type {

src/useLensPerformanceMetrics.test.ts src/useLensFrameMetrics.test.tssrc/useLensPerformanceMetrics.test.ts renamed to src/useLensFrameMetrics.test.ts

@@ -1,7 +1,7 @@
 jest.mock("@snap/camera-kit", () => ({}));
 
 import { renderHook, act } from "@testing-library/react";
-import { useLensPerformanceMetrics } from "./useLensPerformanceMetrics";
+import { useLensFrameMetrics } from "./useLensFrameMetrics";
 import { useInternalCameraKit } from "./CameraKitProvider";
 import { ComputedFrameMetrics } from "@snap/camera-kit";
 
@@ -65,7 +65,7 @@ function setupContext(overrides: Partial<ReturnType<typeof useInternalCameraKit>
   return { measurement, session, mockGetLogger };
 }
 
-describe("useLensPerformanceMetrics", () => {
+describe("useLensFrameMetrics", () => {
   beforeEach(() => {
     jest.clearAllMocks();
     jest.useFakeTimers();
@@ -78,15 +78,15 @@ describe("useLensPerformanceMetrics", () => {
   it("returns undefined when no session is available", () => {
     setupContext({ currentSession: undefined, sdkStatus: "initializing" });
 
-    const { result } = renderHook(() => useLensPerformanceMetrics({ interval: 500 }));
+    const { result } = renderHook(() => useLensFrameMetrics({ interval: 500 }));
 
     expect(result.current).toBeUndefined();
   });
 
   it("calls beginMeasurement when session becomes available", () => {
     const { session } = setupContext();
 
-    renderHook(() => useLensPerformanceMetrics({ interval: 500 }));
+    renderHook(() => useLensFrameMetrics({ interval: 500 }));
 
     expect(session.metrics.beginMeasurement).toHaveBeenCalledTimes(1);
   });
@@ -96,7 +96,7 @@ describe("useLensPerformanceMetrics", () => {
     const metrics = createMockMetrics({ avgFps: 60 });
     measurement.measure.mockReturnValue(metrics);
 
-    const { result } = renderHook(() => useLensPerformanceMetrics({ interval: 500 }));
+    const { result } = renderHook(() => useLensFrameMetrics({ interval: 500 }));
 
     // No metrics yet before first interval tick
     expect(result.current).toBeUndefined();
@@ -113,7 +113,7 @@ describe("useLensPerformanceMetrics", () => {
   it("polls repeatedly at the interval", () => {
     const { measurement } = setupContext();
 
-    renderHook(() => useLensPerformanceMetrics({ interval: 200 }));
+    renderHook(() => useLensFrameMetrics({ interval: 200 }));
 
     act(() => {
       jest.advanceTimersByTime(600);
@@ -125,7 +125,7 @@ describe("useLensPerformanceMetrics", () => {
   it("calls reset() when lens changes", () => {
     const { measurement } = setupContext();
 
-    const { rerender } = renderHook(() => useLensPerformanceMetrics({ interval: 500 }));
+    const { rerender } = renderHook(() => useLensFrameMetrics({ interval: 500 }));
 
     // Change the lens
     mockUseInternalCameraKit.mockReturnValue({
@@ -149,7 +149,7 @@ describe("useLensPerformanceMetrics", () => {
   it("calls end() on unmount", () => {
     const { measurement } = setupContext();
 
-    const { unmount } = renderHook(() => useLensPerformanceMetrics({ interval: 500 }));
+    const { unmount } = renderHook(() => useLensFrameMetrics({ interval: 500 }));
 
     unmount();
 
@@ -159,7 +159,7 @@ describe("useLensPerformanceMetrics", () => {
   it("calls end() then beginMeasurement() when session changes", () => {
     const { measurement: measurement1 } = setupContext();
 
-    const { rerender } = renderHook(() => useLensPerformanceMetrics({ interval: 500 }));
+    const { rerender } = renderHook(() => useLensFrameMetrics({ interval: 500 }));
 
     expect(measurement1.end).not.toHaveBeenCalled();
 
@@ -181,7 +181,7 @@ describe("useLensPerformanceMetrics", () => {
   it("does not start measurement when enabled is false", () => {
     const { session } = setupContext();
 
-    const { result } = renderHook(() => useLensPerformanceMetrics({ interval: 500, enabled: false }));
+    const { result } = renderHook(() => useLensFrameMetrics({ interval: 500, enabled: false }));
 
     expect(session.metrics.beginMeasurement).not.toHaveBeenCalled();
     expect(result.current).toBeUndefined();
@@ -191,7 +191,7 @@ describe("useLensPerformanceMetrics", () => {
     const { measurement } = setupContext();
     measurement.measure.mockReturnValue(createMockMetrics({ avgFps: 60 }));
 
-    const { result, rerender } = renderHook(({ enabled }) => useLensPerformanceMetrics({ interval: 500, enabled }), {
+    const { result, rerender } = renderHook(({ enabled }) => useLensFrameMetrics({ interval: 500, enabled }), {
       initialProps: { enabled: true },
     });
 
@@ -210,7 +210,7 @@ describe("useLensPerformanceMetrics", () => {
   it("starts measurement when enabled changes to true", () => {
     const { session } = setupContext();
 
-    const { rerender } = renderHook(({ enabled }) => useLensPerformanceMetrics({ interval: 500, enabled }), {
+    const { rerender } = renderHook(({ enabled }) => useLensFrameMetrics({ interval: 500, enabled }), {
       initialProps: { enabled: false },
     });
 
@@ -225,7 +225,7 @@ describe("useLensPerformanceMetrics", () => {
     const { measurement } = setupContext();
     measurement.measure.mockReturnValue(createMockMetrics({ avgFps: 60 }));
 
-    const { result, rerender } = renderHook(() => useLensPerformanceMetrics({ interval: 500 }));
+    const { result, rerender } = renderHook(() => useLensFrameMetrics({ interval: 500 }));
 
     act(() => {
       jest.advanceTimersByTime(500);

src/useLensPerformanceMetrics.ts src/useLensFrameMetrics.tssrc/useLensPerformanceMetrics.ts renamed to src/useLensFrameMetrics.ts

@@ -2,7 +2,7 @@ import { useEffect, useRef, useState } from "react";
 import { ComputedFrameMetrics, LensPerformanceMeasurement } from "@snap/camera-kit";
 import { useInternalCameraKit } from "./CameraKitProvider";
 
-interface UseLensPerformanceMetricsOptions {
+interface UseLensFrameMetricsOptions {
   /** Polling interval in milliseconds. How often measurement.measure() is called to update state. */
   interval: number;
   /** Whether measurement is active. Defaults to true. When false, no measurement is started and the hook returns undefined. */
@@ -22,15 +22,15 @@ interface UseLensPerformanceMetricsOptions {
  * @example
  * ```tsx
  * function PerformanceOverlay() {
- *   const metrics = useLensPerformanceMetrics({ interval: 500 });
+ *   const metrics = useLensFrameMetrics({ interval: 500 });
  *
  *   if (!metrics) return null;
  *
  *   return <div>FPS: {metrics.avgFps.toFixed(1)}</div>;
  * }
  * ```
  */
-export function useLensPerformanceMetrics(options: UseLensPerformanceMetricsOptions): ComputedFrameMetrics | undefined {
+export function useLensFrameMetrics(options: UseLensFrameMetricsOptions): ComputedFrameMetrics | undefined {
   const { enabled = true } = options;
   const { currentSession, lens } = useInternalCameraKit();
   const [metrics, setMetrics] = useState<ComputedFrameMetrics | undefined>(undefined);