@stream-io/video-client 1.1.0 → 1.2.0

package/dist/src/Call.d.ts

@@ -7,7 +7,7 @@ import { VideoLayerSetting } from './gen/video/sfu/event/events';
 import { DynascaleManager } from './helpers/DynascaleManager';
 import { PermissionsContext } from './permissions';
 import { StreamClient } from './coordinator/connection/client';
-import { CallEventListener, Logger } from './coordinator/connection/types';
+import { CallEventListener, Logger, RejectReason } from './coordinator/connection/types';
 import { CameraManager, MicrophoneManager, ScreenShareManager, SpeakerManager } from './devices';
 /**
  * An object representation of a `Call`.
@@ -177,8 +177,10 @@ export declare class Call {
      * This method should be used only for "ringing" call flows.
      * {@link Call.leave} invokes this method automatically for you when you leave or reject this call.
      * Unless you are implementing a custom "ringing" flow, you should not use this method.
+     *
+     * @param reason the reason for rejecting the call.
      */
-    reject: () => Promise<RejectCallResponse>;
+    reject: (reason?: RejectReason) => Promise<RejectCallResponse>;
     /**
      * Will start to watch for call related WebSocket events and initiate a call session with the server.
      *

package/dist/src/coordinator/connection/types.d.ts

@@ -113,3 +113,5 @@ export type StreamClientOptions = Partial<AxiosRequestConfig> & {
 };
 export type TokenProvider = () => Promise<string>;
 export type TokenOrProvider = null | string | TokenProvider | undefined;
+export type BuiltInRejectReason = 'busy' | 'decline' | 'cancel';
+export type RejectReason = BuiltInRejectReason | string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "packageManager": "yarn@3.2.4",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",

package/src/Call.ts

@@ -119,6 +119,7 @@ import {
   AllCallEvents,
   CallEventListener,
   Logger,
+  RejectReason,
   StreamCallEvent,
 } from './coordinator/connection/types';
 import { getClientDetails } from './client-details';
@@ -680,10 +681,13 @@ export class Call {
    * This method should be used only for "ringing" call flows.
    * {@link Call.leave} invokes this method automatically for you when you leave or reject this call.
    * Unless you are implementing a custom "ringing" flow, you should not use this method.
+   *
+   * @param reason the reason for rejecting the call.
    */
-  reject = async () => {
+  reject = async (reason?: RejectReason): Promise<RejectCallResponse> => {
     return this.streamClient.post<RejectCallResponse>(
       `${this.streamClientBasePath}/reject`,
+      { reason: reason },
     );
   };
 

package/src/coordinator/connection/types.ts

@@ -142,3 +142,6 @@ export type StreamClientOptions = Partial<AxiosRequestConfig> & {
 
 export type TokenProvider = () => Promise<string>;
 export type TokenOrProvider = null | string | TokenProvider | undefined;
+
+export type BuiltInRejectReason = 'busy' | 'decline' | 'cancel';
+export type RejectReason = BuiltInRejectReason | string;

package/src/events/callEventHandlers.ts

@@ -29,7 +29,7 @@ import {
 
 type RingCallEvents = Extract<
   AllClientCallEvents,
-  'call.accepted' | 'call.rejected'
+  'call.accepted' | 'call.rejected' | 'call.missed'
 >;
 
 /**