@stream-io/video-client 1.60.0 → 1.61.0

package/src/types.ts

@@ -458,7 +458,17 @@ type StreamRNVideoSDKEndCallReason =
   | 'unknown';
 
 type StreamRNVideoSDKCallingX = {
-  joinCall: (call: Call, activeCalls: Call[]) => Promise<void>;
+  /**
+   * @param isCancelled - polled around the bridge's waits: registration is
+   *   skipped, or undone, when it returns true. Supplied by the join attempt
+   *   because the call's own state cannot distinguish a fresh join starting
+   *   from `LEFT` from an abandoned one that reached `LEFT` while waiting.
+   */
+  joinCall: (
+    call: Call,
+    activeCalls: Call[],
+    isCancelled?: () => boolean,
+  ) => Promise<void>;
   endCall: (
     call: Call,
     reason?: StreamRNVideoSDKEndCallReason,
@@ -468,8 +478,34 @@ type StreamRNVideoSDKCallingX = {
   unwireAudioEngineSubscription: () => void;
 };
 
+/**
+ * React Native's preparation and cleanup for a ringing call's join.
+ *
+ * A ringing call is joined by the SDK rather than by app code, so there is no
+ * point at which the app holds the call and can still set it up. These are that
+ * point, and the matching release.
+ */
+type StreamRNVideoSDKRingingCallLifecycle = {
+  /**
+   * Runs the app's pre-join setup and resolves once it is done, bounded by a
+   * deadline. Rejecting fails the join closed rather than joining with nothing
+   * installed.
+   */
+  beforeJoin: (call: Call) => Promise<void>;
+
+  /**
+   * The join failed terminally. Ends the ringing flow and releases what the
+   * setup installed. Never rejects, so the original join error survives.
+   */
+  onJoinFailed: (call: Call) => Promise<void>;
+
+  /** The call has ended; release whatever the pre-join hook installed. */
+  onLeave: (call: Call) => void;
+};
+
 export type StreamRNVideoSDKGlobals = {
   callingX: StreamRNVideoSDKCallingX;
+  ringingCallLifecycle: StreamRNVideoSDKRingingCallLifecycle;
   callManager: {
     /**
      * Sets up the in call manager.