@poolse/react-native 2.9.0 → 2.10.1

package/dist/index.d.cts

@@ -1,9 +1,52 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { CallParticipant, Conversation, Uuid, Message, AttachmentUploadInput, Membership, Attachment, WebRtcAdapter, VoiceStatus, LiveKitModule, CallMedia } from '@poolse/sdk';
 import * as react from 'react';
 import { ReactNode, ReactElement } from 'react';
-import { Conversation, Uuid, Message, AttachmentUploadInput, Membership, Attachment, WebRtcAdapter, VoiceStatus } from '@poolse/sdk';
-import * as react_jsx_runtime from 'react/jsx-runtime';
 import { UseCalls } from '@poolse/react';
 
+/**
+ * The slice of `@livekit/react-native` this needs.
+ *
+ * Passed in by the app rather than imported, for the same reason
+ * `react-native-webrtc` is: tsup rewrites `require()` into
+ * `__require()`, which Metro cannot follow, so anything this package
+ * imports for itself never reaches a React Native bundle.
+ *
+ *     import * as livekitRN from '@livekit/react-native';
+ */
+interface LiveKitReactNativeModule {
+    /**
+     * The module's `VideoTrack` component.
+     *
+     * Typed as `unknown` on purpose. Its real props are far more specific
+     * than what this renders with, and React component props are
+     * contravariant — declaring the narrow shape here means the real
+     * component is not assignable to it and no app can pass the module in.
+     * It is narrowed to {@link CheckedVideoTrack} at the point of use.
+     */
+    VideoTrack: unknown;
+}
+interface CallVideoGridProps {
+    participants: CallParticipant[];
+    /** `@livekit/react-native`, imported by your app. */
+    livekitReactNative?: LiveKitReactNativeModule | null | undefined;
+    /** Resolves a user id to a display label. */
+    labelFor?: ((userId: string) => string) | undefined;
+}
+/**
+ * The video half of a call: one tile per participant.
+ *
+ * Someone with their camera off still gets a tile, showing their name
+ * and whether they're muted. Dropping them would make a five-person
+ * call with four cameras off look like a one-person call, and hide the
+ * fact that they are there and can hear you.
+ *
+ * Tiles are laid out in a simple grid that stays square-ish as the call
+ * grows. There is no active-speaker promotion yet — with the small
+ * calls an SFU mesh replacement is sized for, everyone fits on screen.
+ */
+declare function CallVideoGrid({ participants, livekitReactNative, labelFor }: CallVideoGridProps): react_jsx_runtime.JSX.Element | null;
+
 interface InboxUser {
     /** The user's external_id (the same id you mint JWTs with). */
     externalId: string;
@@ -1084,17 +1127,40 @@ interface CallScreenProps {
      */
     calls?: UseCalls;
     /**
-     * The `react-native-webrtc` module, imported by your app. Required for
-     * call audio; without it the screen still rings and connects but warns
-     * that there is no audio. See {@link VoiceRoomBarProps.webrtc}.
+     * The `react-native-webrtc` module (or `@livekit/react-native-webrtc`,
+     * which is API-compatible), imported by your app.
+     *
+     * Used for the peer-to-peer fallback when the deployment has no SFU.
+     * With an SFU configured, LiveKit owns the peer connection and this is
+     * only the safety net.
      */
     webrtc?: NativeWebRtcModule | null;
     /**
-     * Called whenever the call's audio connection state changes. Drive
+     * `livekit-client`, imported by your app. Enables SFU-backed calls,
+     * which is what makes video and the mid-call camera toggle possible.
+     * Omit it and calls fall back to the peer-to-peer mesh, audio only.
+     */
+    livekit?: LiveKitModule | null;
+    /**
+     * `@livekit/react-native`, imported by your app. Required to *render*
+     * video; without it a video call still connects and carries audio, and
+     * every tile shows a placeholder.
+     */
+    livekitReactNative?: LiveKitReactNativeModule | null;
+    /**
+     * Called whenever the call's media connection state changes. Drive
      * speakerphone and the proximity sensor from here — see
      * {@link VoiceRoomBarProps.onStatusChange}.
      */
     onStatusChange?: (status: VoiceStatus) => void;
+    /**
+     * Called when the call's video state changes.
+     *
+     * A video call belongs on the speaker with the proximity sensor OFF —
+     * otherwise the screen blanks the moment the phone comes near your
+     * face, which is exactly when you are looking at it.
+     */
+    onVideoChange?: (video: boolean) => void;
     /**
      * Hide this screen while a call is merely ringing in.
      *
@@ -1113,15 +1179,22 @@ interface CallScreenProps {
  * Mount it once, high in the tree, so a call can arrive on any screen:
  *
  *     <PoolseProvider config={config}>
- *       <CallScreen userId={me.id} />
+ *       <CallScreen userId={me.id} livekit={livekit} livekitReactNative={livekitRN} />
  *       <YourApp />
  *     </PoolseProvider>
  *
- * Placing a call is separate — `useCalls().call(conversationId)`, wired
- * to whatever button your UI wants. Pass the same instance in via
- * `calls` so both halves share one state machine.
+ * ## Two media paths
+ *
+ * With `livekit` supplied, media rides the SFU: one upload per
+ * participant regardless of call size, and the camera and microphone can
+ * be switched on and off at any point. Without it — or against a
+ * deployment that has no SFU configured — calls fall back to the
+ * peer-to-peer mesh, which is audio only.
+ *
+ * The fallback is automatic and silent by design. A deployment without
+ * an SFU is a supported configuration, not a broken one.
  */
-declare function CallScreen({ userId, labelFor, calls: external, webrtc, onStatusChange, nativeIncomingUi, }: CallScreenProps): react_jsx_runtime.JSX.Element;
+declare function CallScreen({ userId, labelFor, calls: callsProp, webrtc, livekit, livekitReactNative, onStatusChange, onVideoChange, nativeIncomingUi, }: CallScreenProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Bridges iOS PushKit + CallKit to poolse calls, and owns the incoming
@@ -1199,6 +1272,14 @@ interface VoipIncomingCall {
     conversationId: string;
     callerUserId: string;
     callerName: string;
+    /**
+     * What the call opened as.
+     *
+     * Carried by the push because CallKit fixes the answer button when the
+     * call is reported and cannot change it afterwards — waiting for the
+     * socket would mean answering a video call through an audio UI.
+     */
+    media: CallMedia;
 }
 interface UseVoipCallsOptions {
     voipPush: VoipPushModule;
@@ -1253,4 +1334,4 @@ declare function isStalePush(sentAt: number | undefined, now: number, staleAfter
  */
 declare function useVoipCalls({ voipPush, callKeep, calls, onAnswer, onDecline, appName, apnsEnvironment, staleAfterMs, }: UseVoipCallsOptions): void;
 
-export { AttachmentPicker, type AttachmentPickerProps, AttachmentPreview, type AttachmentPreviewProps, Avatar, type AvatarProps, type CallKeepModule, CallScreen, type CallScreenProps, ChatHeader, type ChatHeaderProps, ConversationList, type ConversationListProps, ConversationView, type ConversationViewProps, DaySeparator, type DaySeparatorProps, GroupDetailsSheet, type GroupDetailsSheetProps, type IconName, ImageMosaic, type ImageMosaicProps, type InboxUser, MemberList, type MemberListProps, MentionInput, type MentionInputProps, MessageActions, type MessageActionsProps, MessageBubble, type MessageBubbleProps, MessageComposer, type MessageComposerProps, MessageList, type MessageListItem, type MessageListProps, MessageRow, type MessageRowProps, type NativeWebRtcModule, PoolseIcon, type PoolseIconProps, PoolseInbox, type PoolseInboxHandle, type PoolseInboxProps, PoolseLogo, type PoolseLogoProps, type PoolseLogoVariant, type PoolseRNTheme, type PoolseRNThemeOverrides, PoolseTheme, type PoolseThemeProps, primitives as Primitives, ReactionPicker, type ReactionPickerProps, ReactionStrip, type ReactionStripProps, type ThemeColors, type ThemeRadii, type ThemeShadows, type ThemeSpacing, type ThemeType, ThreadView, type ThreadViewProps, TypingIndicator, type TypingIndicatorProps, UploadQueueStrip, type UseVoipCallsOptions, UserName, type UserNameProps, VoiceRoomBar, type VoiceRoomBarProps, type VoipIncomingCall, type VoipPushModule, createNativeWebRtcAdapter, defaultDarkTheme, defaultLightTheme, isNativeWebRtcAvailable, isStalePush, useAppStateLifecycle, useDisplayName, usePoolseTheme, useVoipCalls };
+export { AttachmentPicker, type AttachmentPickerProps, AttachmentPreview, type AttachmentPreviewProps, Avatar, type AvatarProps, type CallKeepModule, CallScreen, type CallScreenProps, CallVideoGrid, type CallVideoGridProps, ChatHeader, type ChatHeaderProps, ConversationList, type ConversationListProps, ConversationView, type ConversationViewProps, DaySeparator, type DaySeparatorProps, GroupDetailsSheet, type GroupDetailsSheetProps, type IconName, ImageMosaic, type ImageMosaicProps, type InboxUser, type LiveKitReactNativeModule, MemberList, type MemberListProps, MentionInput, type MentionInputProps, MessageActions, type MessageActionsProps, MessageBubble, type MessageBubbleProps, MessageComposer, type MessageComposerProps, MessageList, type MessageListItem, type MessageListProps, MessageRow, type MessageRowProps, type NativeWebRtcModule, PoolseIcon, type PoolseIconProps, PoolseInbox, type PoolseInboxHandle, type PoolseInboxProps, PoolseLogo, type PoolseLogoProps, type PoolseLogoVariant, type PoolseRNTheme, type PoolseRNThemeOverrides, PoolseTheme, type PoolseThemeProps, primitives as Primitives, ReactionPicker, type ReactionPickerProps, ReactionStrip, type ReactionStripProps, type ThemeColors, type ThemeRadii, type ThemeShadows, type ThemeSpacing, type ThemeType, ThreadView, type ThreadViewProps, TypingIndicator, type TypingIndicatorProps, UploadQueueStrip, type UseVoipCallsOptions, UserName, type UserNameProps, VoiceRoomBar, type VoiceRoomBarProps, type VoipIncomingCall, type VoipPushModule, createNativeWebRtcAdapter, defaultDarkTheme, defaultLightTheme, isNativeWebRtcAvailable, isStalePush, useAppStateLifecycle, useDisplayName, usePoolseTheme, useVoipCalls };

package/dist/index.d.ts

@@ -1,9 +1,52 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { CallParticipant, Conversation, Uuid, Message, AttachmentUploadInput, Membership, Attachment, WebRtcAdapter, VoiceStatus, LiveKitModule, CallMedia } from '@poolse/sdk';
 import * as react from 'react';
 import { ReactNode, ReactElement } from 'react';
-import { Conversation, Uuid, Message, AttachmentUploadInput, Membership, Attachment, WebRtcAdapter, VoiceStatus } from '@poolse/sdk';
-import * as react_jsx_runtime from 'react/jsx-runtime';
 import { UseCalls } from '@poolse/react';
 
+/**
+ * The slice of `@livekit/react-native` this needs.
+ *
+ * Passed in by the app rather than imported, for the same reason
+ * `react-native-webrtc` is: tsup rewrites `require()` into
+ * `__require()`, which Metro cannot follow, so anything this package
+ * imports for itself never reaches a React Native bundle.
+ *
+ *     import * as livekitRN from '@livekit/react-native';
+ */
+interface LiveKitReactNativeModule {
+    /**
+     * The module's `VideoTrack` component.
+     *
+     * Typed as `unknown` on purpose. Its real props are far more specific
+     * than what this renders with, and React component props are
+     * contravariant — declaring the narrow shape here means the real
+     * component is not assignable to it and no app can pass the module in.
+     * It is narrowed to {@link CheckedVideoTrack} at the point of use.
+     */
+    VideoTrack: unknown;
+}
+interface CallVideoGridProps {
+    participants: CallParticipant[];
+    /** `@livekit/react-native`, imported by your app. */
+    livekitReactNative?: LiveKitReactNativeModule | null | undefined;
+    /** Resolves a user id to a display label. */
+    labelFor?: ((userId: string) => string) | undefined;
+}
+/**
+ * The video half of a call: one tile per participant.
+ *
+ * Someone with their camera off still gets a tile, showing their name
+ * and whether they're muted. Dropping them would make a five-person
+ * call with four cameras off look like a one-person call, and hide the
+ * fact that they are there and can hear you.
+ *
+ * Tiles are laid out in a simple grid that stays square-ish as the call
+ * grows. There is no active-speaker promotion yet — with the small
+ * calls an SFU mesh replacement is sized for, everyone fits on screen.
+ */
+declare function CallVideoGrid({ participants, livekitReactNative, labelFor }: CallVideoGridProps): react_jsx_runtime.JSX.Element | null;
+
 interface InboxUser {
     /** The user's external_id (the same id you mint JWTs with). */
     externalId: string;
@@ -1084,17 +1127,40 @@ interface CallScreenProps {
      */
     calls?: UseCalls;
     /**
-     * The `react-native-webrtc` module, imported by your app. Required for
-     * call audio; without it the screen still rings and connects but warns
-     * that there is no audio. See {@link VoiceRoomBarProps.webrtc}.
+     * The `react-native-webrtc` module (or `@livekit/react-native-webrtc`,
+     * which is API-compatible), imported by your app.
+     *
+     * Used for the peer-to-peer fallback when the deployment has no SFU.
+     * With an SFU configured, LiveKit owns the peer connection and this is
+     * only the safety net.
      */
     webrtc?: NativeWebRtcModule | null;
     /**
-     * Called whenever the call's audio connection state changes. Drive
+     * `livekit-client`, imported by your app. Enables SFU-backed calls,
+     * which is what makes video and the mid-call camera toggle possible.
+     * Omit it and calls fall back to the peer-to-peer mesh, audio only.
+     */
+    livekit?: LiveKitModule | null;
+    /**
+     * `@livekit/react-native`, imported by your app. Required to *render*
+     * video; without it a video call still connects and carries audio, and
+     * every tile shows a placeholder.
+     */
+    livekitReactNative?: LiveKitReactNativeModule | null;
+    /**
+     * Called whenever the call's media connection state changes. Drive
      * speakerphone and the proximity sensor from here — see
      * {@link VoiceRoomBarProps.onStatusChange}.
      */
     onStatusChange?: (status: VoiceStatus) => void;
+    /**
+     * Called when the call's video state changes.
+     *
+     * A video call belongs on the speaker with the proximity sensor OFF —
+     * otherwise the screen blanks the moment the phone comes near your
+     * face, which is exactly when you are looking at it.
+     */
+    onVideoChange?: (video: boolean) => void;
     /**
      * Hide this screen while a call is merely ringing in.
      *
@@ -1113,15 +1179,22 @@ interface CallScreenProps {
  * Mount it once, high in the tree, so a call can arrive on any screen:
  *
  *     <PoolseProvider config={config}>
- *       <CallScreen userId={me.id} />
+ *       <CallScreen userId={me.id} livekit={livekit} livekitReactNative={livekitRN} />
  *       <YourApp />
  *     </PoolseProvider>
  *
- * Placing a call is separate — `useCalls().call(conversationId)`, wired
- * to whatever button your UI wants. Pass the same instance in via
- * `calls` so both halves share one state machine.
+ * ## Two media paths
+ *
+ * With `livekit` supplied, media rides the SFU: one upload per
+ * participant regardless of call size, and the camera and microphone can
+ * be switched on and off at any point. Without it — or against a
+ * deployment that has no SFU configured — calls fall back to the
+ * peer-to-peer mesh, which is audio only.
+ *
+ * The fallback is automatic and silent by design. A deployment without
+ * an SFU is a supported configuration, not a broken one.
  */
-declare function CallScreen({ userId, labelFor, calls: external, webrtc, onStatusChange, nativeIncomingUi, }: CallScreenProps): react_jsx_runtime.JSX.Element;
+declare function CallScreen({ userId, labelFor, calls: callsProp, webrtc, livekit, livekitReactNative, onStatusChange, onVideoChange, nativeIncomingUi, }: CallScreenProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Bridges iOS PushKit + CallKit to poolse calls, and owns the incoming
@@ -1199,6 +1272,14 @@ interface VoipIncomingCall {
     conversationId: string;
     callerUserId: string;
     callerName: string;
+    /**
+     * What the call opened as.
+     *
+     * Carried by the push because CallKit fixes the answer button when the
+     * call is reported and cannot change it afterwards — waiting for the
+     * socket would mean answering a video call through an audio UI.
+     */
+    media: CallMedia;
 }
 interface UseVoipCallsOptions {
     voipPush: VoipPushModule;
@@ -1253,4 +1334,4 @@ declare function isStalePush(sentAt: number | undefined, now: number, staleAfter
  */
 declare function useVoipCalls({ voipPush, callKeep, calls, onAnswer, onDecline, appName, apnsEnvironment, staleAfterMs, }: UseVoipCallsOptions): void;
 
-export { AttachmentPicker, type AttachmentPickerProps, AttachmentPreview, type AttachmentPreviewProps, Avatar, type AvatarProps, type CallKeepModule, CallScreen, type CallScreenProps, ChatHeader, type ChatHeaderProps, ConversationList, type ConversationListProps, ConversationView, type ConversationViewProps, DaySeparator, type DaySeparatorProps, GroupDetailsSheet, type GroupDetailsSheetProps, type IconName, ImageMosaic, type ImageMosaicProps, type InboxUser, MemberList, type MemberListProps, MentionInput, type MentionInputProps, MessageActions, type MessageActionsProps, MessageBubble, type MessageBubbleProps, MessageComposer, type MessageComposerProps, MessageList, type MessageListItem, type MessageListProps, MessageRow, type MessageRowProps, type NativeWebRtcModule, PoolseIcon, type PoolseIconProps, PoolseInbox, type PoolseInboxHandle, type PoolseInboxProps, PoolseLogo, type PoolseLogoProps, type PoolseLogoVariant, type PoolseRNTheme, type PoolseRNThemeOverrides, PoolseTheme, type PoolseThemeProps, primitives as Primitives, ReactionPicker, type ReactionPickerProps, ReactionStrip, type ReactionStripProps, type ThemeColors, type ThemeRadii, type ThemeShadows, type ThemeSpacing, type ThemeType, ThreadView, type ThreadViewProps, TypingIndicator, type TypingIndicatorProps, UploadQueueStrip, type UseVoipCallsOptions, UserName, type UserNameProps, VoiceRoomBar, type VoiceRoomBarProps, type VoipIncomingCall, type VoipPushModule, createNativeWebRtcAdapter, defaultDarkTheme, defaultLightTheme, isNativeWebRtcAvailable, isStalePush, useAppStateLifecycle, useDisplayName, usePoolseTheme, useVoipCalls };
+export { AttachmentPicker, type AttachmentPickerProps, AttachmentPreview, type AttachmentPreviewProps, Avatar, type AvatarProps, type CallKeepModule, CallScreen, type CallScreenProps, CallVideoGrid, type CallVideoGridProps, ChatHeader, type ChatHeaderProps, ConversationList, type ConversationListProps, ConversationView, type ConversationViewProps, DaySeparator, type DaySeparatorProps, GroupDetailsSheet, type GroupDetailsSheetProps, type IconName, ImageMosaic, type ImageMosaicProps, type InboxUser, type LiveKitReactNativeModule, MemberList, type MemberListProps, MentionInput, type MentionInputProps, MessageActions, type MessageActionsProps, MessageBubble, type MessageBubbleProps, MessageComposer, type MessageComposerProps, MessageList, type MessageListItem, type MessageListProps, MessageRow, type MessageRowProps, type NativeWebRtcModule, PoolseIcon, type PoolseIconProps, PoolseInbox, type PoolseInboxHandle, type PoolseInboxProps, PoolseLogo, type PoolseLogoProps, type PoolseLogoVariant, type PoolseRNTheme, type PoolseRNThemeOverrides, PoolseTheme, type PoolseThemeProps, primitives as Primitives, ReactionPicker, type ReactionPickerProps, ReactionStrip, type ReactionStripProps, type ThemeColors, type ThemeRadii, type ThemeShadows, type ThemeSpacing, type ThemeType, ThreadView, type ThreadViewProps, TypingIndicator, type TypingIndicatorProps, UploadQueueStrip, type UseVoipCallsOptions, UserName, type UserNameProps, VoiceRoomBar, type VoiceRoomBarProps, type VoipIncomingCall, type VoipPushModule, createNativeWebRtcAdapter, defaultDarkTheme, defaultLightTheme, isNativeWebRtcAvailable, isStalePush, useAppStateLifecycle, useDisplayName, usePoolseTheme, useVoipCalls };