@runwayml/avatars-react 0.4.0 → 0.6.0

package/dist/index.js

@@ -1,8 +1,8 @@
-import { LiveKitRoom, RoomAudioRenderer, useRoomContext, useConnectionState, useRemoteParticipants, useTracks, isTrackReference, VideoTrack, useLocalParticipant, useMediaDevices, TrackToggle } from '@livekit/components-react';
+import { LiveKitRoom, RoomAudioRenderer, useRoomContext, useConnectionState, useMaybeRoomContext, useRemoteParticipants, useTracks, isTrackReference, VideoTrack, useLocalParticipant, useMediaDevices, TrackToggle } from '@livekit/components-react';
 export { RoomAudioRenderer as AudioRenderer, VideoTrack } from '@livekit/components-react';
-import { createContext, useRef, useCallback, useContext, useEffect } from 'react';
+import { createContext, useRef, useCallback, useState, useEffect, useContext } from 'react';
 import { Track, ConnectionState } from 'livekit-client';
-import { jsxs, jsx, Fragment } from 'react/jsx-runtime';
+import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
 
 // src/api/config.ts
 var DEFAULT_BASE_URL = "https://api.dev.runwayml.com";
@@ -26,44 +26,15 @@ async function consumeSession(options) {
   }
   return response.json();
 }
-
-// src/utils/suspense-resource.ts
-function createSuspenseResource(promise) {
-  let status = "pending";
-  let result;
-  let error;
-  const suspender = promise.then(
-    (value) => {
-      status = "fulfilled";
-      result = value;
-    },
-    (err) => {
-      status = "rejected";
-      error = err;
-    }
-  );
-  return {
-    read() {
-      switch (status) {
-        case "pending":
-          throw suspender;
-        case "rejected":
-          throw error;
-        case "fulfilled":
-          return result;
-      }
-    }
-  };
+function useLatest(value) {
+  const ref = useRef(value);
+  useEffect(() => {
+    ref.current = value;
+  }, [value]);
+  return ref;
 }
 
 // src/hooks/useCredentials.ts
-var resourceCache = /* @__PURE__ */ new Map();
-function computeKey(options) {
-  if (options.credentials) return `direct:${options.credentials.sessionId}`;
-  if (options.sessionId && options.sessionKey)
-    return `session:${options.sessionId}`;
-  return `connect:${options.avatarId}:${options.connectUrl ?? "custom"}`;
-}
 async function fetchCredentials(options) {
   const { avatarId, sessionId, sessionKey, connectUrl, connect, baseUrl } = options;
   if (sessionId && sessionKey) {
@@ -94,28 +65,106 @@ async function fetchCredentials(options) {
   );
 }
 function useCredentials(options) {
-  const key = computeKey(options);
+  const {
+    credentials: directCredentials,
+    avatarId,
+    sessionId,
+    sessionKey,
+    connectUrl,
+    connect,
+    baseUrl,
+    onError
+  } = options;
+  const onErrorRef = useLatest(onError);
+  const [state, setState] = useState(() => {
+    if (directCredentials) {
+      return { status: "ready", credentials: directCredentials, error: null };
+    }
+    return { status: "loading", credentials: null, error: null };
+  });
   useEffect(() => {
+    if (directCredentials) {
+      setState({
+        status: "ready",
+        credentials: directCredentials,
+        error: null
+      });
+      return;
+    }
+    let cancelled = false;
+    setState({ status: "loading", credentials: null, error: null });
+    async function load() {
+      try {
+        const fetchOptions = {
+          avatarId,
+          sessionId,
+          sessionKey,
+          connectUrl,
+          connect,
+          baseUrl
+        };
+        const credentials = await fetchCredentials(fetchOptions);
+        if (!cancelled) {
+          setState({ status: "ready", credentials, error: null });
+        }
+      } catch (err) {
+        if (!cancelled) {
+          const error = err instanceof Error ? err : new Error(String(err));
+          setState({ status: "error", credentials: null, error });
+          onErrorRef.current?.(error);
+        }
+      }
+    }
+    load();
     return () => {
-      resourceCache.delete(key);
+      cancelled = true;
     };
-  }, [key]);
-  if (options.credentials) {
-    return options.credentials;
-  }
-  let resource = resourceCache.get(key);
-  if (!resource) {
-    resource = createSuspenseResource(fetchCredentials(options));
-    resourceCache.set(key, resource);
+  }, [
+    directCredentials,
+    avatarId,
+    sessionId,
+    sessionKey,
+    connectUrl,
+    connect,
+    baseUrl
+  ]);
+  return state;
+}
+async function hasMediaDevice(kind) {
+  try {
+    const devices = await navigator.mediaDevices.enumerateDevices();
+    return devices.some((device) => device.kind === kind);
+  } catch {
+    return false;
   }
-  return resource.read();
 }
-function useLatest(value) {
-  const ref = useRef(value);
+function useDeviceAvailability(requestAudio, requestVideo) {
+  const [state, setState] = useState({
+    audio: false,
+    video: false,
+    isChecking: true
+  });
   useEffect(() => {
-    ref.current = value;
-  }, [value]);
-  return ref;
+    let cancelled = false;
+    async function checkDevices() {
+      const [hasAudio, hasVideo] = await Promise.all([
+        requestAudio ? hasMediaDevice("audioinput") : Promise.resolve(false),
+        requestVideo ? hasMediaDevice("videoinput") : Promise.resolve(false)
+      ]);
+      if (!cancelled) {
+        setState({
+          audio: requestAudio && hasAudio,
+          video: requestVideo && hasVideo,
+          isChecking: false
+        });
+      }
+    }
+    checkDevices();
+    return () => {
+      cancelled = true;
+    };
+  }, [requestAudio, requestVideo]);
+  return state;
 }
 var DEFAULT_ROOM_OPTIONS = {
   adaptiveStream: false,
@@ -141,13 +190,14 @@ var AvatarSessionContext = createContext(
 function AvatarSession({
   credentials,
   children,
-  audio = true,
-  video = true,
+  audio: requestAudio = true,
+  video: requestVideo = true,
   onEnd,
   onError,
   __unstable_roomOptions
 }) {
   const errorRef = useRef(null);
+  const deviceAvailability = useDeviceAvailability(requestAudio, requestVideo);
   const handleError = (error) => {
     errorRef.current = error;
     onError?.(error);
@@ -156,14 +206,29 @@ function AvatarSession({
     ...DEFAULT_ROOM_OPTIONS,
     ...__unstable_roomOptions
   };
+  if (deviceAvailability.isChecking) {
+    return /* @__PURE__ */ jsx(
+      AvatarSessionContext.Provider,
+      {
+        value: {
+          state: "connecting",
+          sessionId: credentials.sessionId,
+          error: null,
+          end: async () => {
+          }
+        },
+        children
+      }
+    );
+  }
   return /* @__PURE__ */ jsxs(
     LiveKitRoom,
     {
       serverUrl: credentials.serverUrl,
       token: credentials.token,
       connect: true,
-      audio,
-      video,
+      audio: deviceAvailability.audio,
+      video: deviceAvailability.video,
       onDisconnected: () => onEnd?.(),
       onError: handleError,
       options: roomOptions,
@@ -222,14 +287,34 @@ function useAvatarSessionContext() {
   }
   return context;
 }
+function LoadingSessionProvider({
+  state,
+  error,
+  children
+}) {
+  const contextValue = {
+    state,
+    sessionId: "",
+    error,
+    end: async () => {
+    }
+  };
+  return /* @__PURE__ */ jsx(AvatarSessionContext.Provider, { value: contextValue, children });
+}
 function useAvatar() {
-  const remoteParticipants = useRemoteParticipants();
+  const room = useMaybeRoomContext();
+  const hasRoomContext = room !== void 0;
+  const remoteParticipants = useRemoteParticipants({ room });
   const avatarParticipant = remoteParticipants[0] ?? null;
   const videoTracks = useTracks(
     [{ source: Track.Source.Camera, withPlaceholder: true }],
-    { onlySubscribed: true, updateOnlyOn: [] }
+    {
+      onlySubscribed: true,
+      updateOnlyOn: [],
+      room: hasRoomContext ? room : void 0
+    }
   ).filter((ref) => !ref.participant.isLocal);
-  const videoTrackRef = videoTracks[0] ?? null;
+  const videoTrackRef = hasRoomContext ? videoTracks[0] ?? null : null;
   const hasVideo = videoTrackRef !== null && isTrackReference(videoTrackRef);
   return {
     participant: avatarParticipant,
@@ -271,40 +356,57 @@ function AvatarVideo({ children, ...props }) {
   if (children) {
     return /* @__PURE__ */ jsx(Fragment, { children: children(videoStatus) });
   }
-  return /* @__PURE__ */ jsx("div", { ...props, "data-avatar-video": "", "data-status": videoStatus.status, children: videoStatus.status === "ready" && isTrackReference(videoStatus.videoTrackRef) && /* @__PURE__ */ jsx(VideoTrack, { trackRef: videoStatus.videoTrackRef }) });
+  return /* @__PURE__ */ jsx(
+    "div",
+    {
+      ...props,
+      "data-avatar-video": "",
+      "data-avatar-status": videoStatus.status,
+      children: videoStatus.status === "ready" && isTrackReference(videoStatus.videoTrackRef) && /* @__PURE__ */ jsx(VideoTrack, { trackRef: videoStatus.videoTrackRef })
+    }
+  );
 }
 function useLocalMedia() {
-  const { localParticipant } = useLocalParticipant();
+  const room = useMaybeRoomContext();
+  const hasRoomContext = room !== void 0;
+  const { localParticipant } = useLocalParticipant({ room });
   const audioDevices = useMediaDevices({ kind: "audioinput" });
   const videoDevices = useMediaDevices({ kind: "videoinput" });
-  const hasMic = audioDevices.length > 0;
-  const hasCamera = videoDevices.length > 0;
+  const hasMic = audioDevices?.length > 0;
+  const hasCamera = videoDevices?.length > 0;
   const isMicEnabled = localParticipant?.isMicrophoneEnabled ?? false;
   const isCameraEnabled = localParticipant?.isCameraEnabled ?? false;
   const isScreenShareEnabled = localParticipant?.isScreenShareEnabled ?? false;
   const isMicEnabledRef = useLatest(isMicEnabled);
   const isCameraEnabledRef = useLatest(isCameraEnabled);
   const isScreenShareEnabledRef = useLatest(isScreenShareEnabled);
+  const hasMicRef = useLatest(hasMic);
+  const hasCameraRef = useLatest(hasCamera);
   const toggleMic = useCallback(() => {
-    localParticipant?.setMicrophoneEnabled(!isMicEnabledRef.current);
-  }, [localParticipant, isMicEnabledRef]);
+    if (hasMicRef.current || isMicEnabledRef.current) {
+      localParticipant?.setMicrophoneEnabled(!isMicEnabledRef.current);
+    }
+  }, [localParticipant]);
   const toggleCamera = useCallback(() => {
-    localParticipant?.setCameraEnabled(!isCameraEnabledRef.current);
-  }, [localParticipant, isCameraEnabledRef]);
+    if (hasCameraRef.current || isCameraEnabledRef.current) {
+      localParticipant?.setCameraEnabled(!isCameraEnabledRef.current);
+    }
+  }, [localParticipant]);
   const toggleScreenShare = useCallback(() => {
     localParticipant?.setScreenShareEnabled(!isScreenShareEnabledRef.current);
-  }, [localParticipant, isScreenShareEnabledRef]);
+  }, [localParticipant]);
   const tracks = useTracks(
     [{ source: Track.Source.Camera, withPlaceholder: true }],
     {
       onlySubscribed: false,
-      updateOnlyOn: []
+      updateOnlyOn: [],
+      room: hasRoomContext ? room : void 0
     }
   );
   const localIdentity = localParticipant?.identity;
-  const localVideoTrackRef = tracks.find(
+  const localVideoTrackRef = hasRoomContext ? tracks.find(
     (trackRef) => trackRef.participant.identity === localIdentity && trackRef.source === Track.Source.Camera
-  ) ?? null;
+  ) ?? null : null;
   return {
     hasMic,
     hasCamera,
@@ -326,13 +428,22 @@ function ControlBar({
   ...props
 }) {
   const session = useAvatarSession();
-  const { isMicEnabled, isCameraEnabled, toggleMic, toggleCamera } = useLocalMedia();
+  const {
+    isMicEnabled,
+    isCameraEnabled,
+    isScreenShareEnabled,
+    toggleMic,
+    toggleCamera,
+    toggleScreenShare
+  } = useLocalMedia();
   const isActive = session.state === "active";
   const state = {
     isMicEnabled,
     isCameraEnabled,
+    isScreenShareEnabled,
     toggleMic,
     toggleCamera,
+    toggleScreenShare,
     endCall: session.end,
     isActive
   };
@@ -342,14 +453,14 @@ function ControlBar({
   if (!isActive) {
     return null;
   }
-  return /* @__PURE__ */ jsxs("div", { ...props, "data-active": isActive, children: [
+  return /* @__PURE__ */ jsxs("div", { ...props, "data-avatar-control-bar": "", "data-avatar-active": isActive, children: [
     showMicrophone && /* @__PURE__ */ jsx(
       "button",
       {
         type: "button",
         onClick: toggleMic,
-        "data-control": "microphone",
-        "data-enabled": isMicEnabled,
+        "data-avatar-control": "microphone",
+        "data-avatar-enabled": isMicEnabled,
         "aria-label": isMicEnabled ? "Mute microphone" : "Unmute microphone",
         children: microphoneIcon
       }
@@ -359,8 +470,8 @@ function ControlBar({
       {
         type: "button",
         onClick: toggleCamera,
-        "data-control": "camera",
-        "data-enabled": isCameraEnabled,
+        "data-avatar-control": "camera",
+        "data-avatar-enabled": isCameraEnabled,
         "aria-label": isCameraEnabled ? "Turn off camera" : "Turn on camera",
         children: cameraIcon
       }
@@ -370,7 +481,8 @@ function ControlBar({
       {
         source: Track.Source.ScreenShare,
         showIcon: false,
-        "data-control": "screen-share",
+        "data-avatar-control": "screen-share",
+        "data-avatar-enabled": isScreenShareEnabled,
         "aria-label": "Toggle screen share",
         children: screenShareIcon
       }
@@ -380,7 +492,8 @@ function ControlBar({
       {
         type: "button",
         onClick: session.end,
-        "data-control": "end-call",
+        "data-avatar-control": "end-call",
+        "data-avatar-enabled": true,
         "aria-label": "End call",
         children: phoneIcon
       }
@@ -454,7 +567,11 @@ var phoneIcon = /* @__PURE__ */ jsx(
     children: /* @__PURE__ */ jsx("path", { d: "M12.8429 22.5693L11.4018 21.0986C11.2675 20.9626 11.1625 20.7995 11.0935 20.6197C11.0245 20.4399 10.9931 20.2474 11.0013 20.0545C11.0094 19.8616 11.0569 19.6726 11.1408 19.4995C11.2247 19.3265 11.343 19.1732 11.4883 19.0495C13.127 17.7049 15.0519 16.7714 17.1083 16.3239C19.0064 15.892 20.9744 15.892 22.8725 16.3239C24.9374 16.7743 26.8693 17.7147 28.5117 19.0691C28.6565 19.1924 28.7746 19.3451 28.8585 19.5176C28.9423 19.69 28.99 19.8784 28.9986 20.0707C29.0072 20.263 28.9764 20.455 28.9083 20.6345C28.8402 20.814 28.7362 20.9771 28.603 21.1133L27.1619 22.584C26.9311 22.8242 26.6226 22.9706 26.2938 22.9959C25.9651 23.0211 25.6385 22.9235 25.3751 22.7212C24.8531 22.3127 24.2875 21.9657 23.689 21.6869C23.4525 21.5774 23.2517 21.4009 23.1103 21.1785C22.969 20.9561 22.8931 20.697 22.8917 20.4319V19.1867C21.0053 18.6573 19.0139 18.6573 17.1275 19.1867V20.4319C17.1261 20.697 17.0502 20.9561 16.9089 21.1785C16.7676 21.4009 16.5667 21.5774 16.3302 21.6869C15.7317 21.9657 15.1661 22.3127 14.6442 22.7212C14.3779 22.9258 14.0473 23.0233 13.7152 22.9953C13.383 22.9673 13.0726 22.8156 12.8429 22.5693Z" })
   }
 );
-function UserVideo({ children, mirror = true, ...props }) {
+function UserVideo({
+  children,
+  mirror = true,
+  ...props
+}) {
   const { localVideoTrackRef, isCameraEnabled } = useLocalMedia();
   const hasVideo = localVideoTrackRef !== null && isTrackReference(localVideoTrackRef);
   const state = {
@@ -469,9 +586,10 @@ function UserVideo({ children, mirror = true, ...props }) {
     "div",
     {
       ...props,
-      "data-has-video": hasVideo,
-      "data-camera-enabled": isCameraEnabled,
-      "data-mirror": mirror,
+      "data-avatar-user-video": "",
+      "data-avatar-has-video": hasVideo,
+      "data-avatar-camera-enabled": isCameraEnabled,
+      "data-avatar-mirror": mirror,
       children: hasVideo && localVideoTrackRef && isTrackReference(localVideoTrackRef) && /* @__PURE__ */ jsx(VideoTrack, { trackRef: localVideoTrackRef })
     }
   );
@@ -492,19 +610,44 @@ function AvatarCall({
   ...props
 }) {
   const onErrorRef = useLatest(onError);
-  const credentials = useCredentials({
+  const credentialsState = useCredentials({
     avatarId,
     sessionId,
     sessionKey,
     credentials: directCredentials,
     connectUrl,
     connect,
-    baseUrl
+    baseUrl,
+    onError: (err) => onErrorRef.current?.(err)
   });
   const handleSessionError = (err) => {
     onErrorRef.current?.(err);
   };
   const backgroundStyle = avatarImageUrl ? { "--avatar-image": `url(${avatarImageUrl})` } : void 0;
+  const defaultChildren = /* @__PURE__ */ jsxs(Fragment, { children: [
+    /* @__PURE__ */ jsx(AvatarVideo, {}),
+    /* @__PURE__ */ jsx(UserVideo, {}),
+    /* @__PURE__ */ jsx(ControlBar, {})
+  ] });
+  if (credentialsState.status !== "ready") {
+    return /* @__PURE__ */ jsx(
+      "div",
+      {
+        ...props,
+        "data-avatar-call": "",
+        "data-avatar-id": avatarId,
+        style: { ...props.style, ...backgroundStyle },
+        children: /* @__PURE__ */ jsx(
+          LoadingSessionProvider,
+          {
+            state: credentialsState.status === "error" ? "error" : "connecting",
+            error: credentialsState.error,
+            children: children ?? defaultChildren
+          }
+        )
+      }
+    );
+  }
   return /* @__PURE__ */ jsx(
     "div",
     {
@@ -515,30 +658,31 @@ function AvatarCall({
       children: /* @__PURE__ */ jsx(
         AvatarSession,
         {
-          credentials,
+          credentials: credentialsState.credentials,
           onEnd,
           onError: handleSessionError,
           __unstable_roomOptions,
-          children: children ?? /* @__PURE__ */ jsxs(Fragment, { children: [
-            /* @__PURE__ */ jsx(AvatarVideo, {}),
-            /* @__PURE__ */ jsx(UserVideo, {}),
-            /* @__PURE__ */ jsx(ControlBar, {})
-          ] })
+          children: children ?? defaultChildren
         }
       )
     }
   );
 }
-function ScreenShareVideo({ children, ...props }) {
-  const { localParticipant } = useLocalParticipant();
+function ScreenShareVideo({
+  children,
+  ...props
+}) {
+  const room = useMaybeRoomContext();
+  const hasRoomContext = room !== void 0;
+  const { localParticipant } = useLocalParticipant({ room });
   const tracks = useTracks(
     [{ source: Track.Source.ScreenShare, withPlaceholder: false }],
-    { onlySubscribed: false }
+    { onlySubscribed: false, room: hasRoomContext ? room : void 0 }
   );
   const localIdentity = localParticipant?.identity;
-  const screenShareTrackRef = tracks.find(
+  const screenShareTrackRef = hasRoomContext ? tracks.find(
     (trackRef) => trackRef.participant.identity === localIdentity && trackRef.source === Track.Source.ScreenShare
-  ) ?? null;
+  ) ?? null : null;
   const isSharing = screenShareTrackRef !== null && isTrackReference(screenShareTrackRef);
   const state = {
     isSharing,
@@ -550,7 +694,7 @@ function ScreenShareVideo({ children, ...props }) {
   if (!isSharing) {
     return null;
   }
-  return /* @__PURE__ */ jsx("div", { ...props, "data-sharing": isSharing, children: screenShareTrackRef && isTrackReference(screenShareTrackRef) && /* @__PURE__ */ jsx(VideoTrack, { trackRef: screenShareTrackRef }) });
+  return /* @__PURE__ */ jsx("div", { ...props, "data-avatar-screen-share": "", "data-avatar-sharing": isSharing, children: screenShareTrackRef && isTrackReference(screenShareTrackRef) && /* @__PURE__ */ jsx(VideoTrack, { trackRef: screenShareTrackRef }) });
 }
 
 export { AvatarCall, AvatarSession, AvatarVideo, ControlBar, ScreenShareVideo, UserVideo, useAvatar, useAvatarSession, useAvatarStatus, useLocalMedia };