@azure/communication-react 1.5.1-beta.5 → 1.6.0

package/dist/dist-esm/calling-stateful-client/src/CallClientState.d.ts

@@ -1,9 +1,4 @@
 import { AudioDeviceInfo, CallDirection, CallEndReason, CallerInfo, CallState as CallStatus, DeviceAccess, DominantSpeakersInfo, LatestMediaDiagnostics, LatestNetworkDiagnostics, MediaStreamType, RemoteParticipantState as RemoteParticipantStatus, ScalingMode, VideoDeviceInfo } from '@azure/communication-calling';
-import { CaptionsResultType } from '@azure/communication-calling';
-import { VideoEffectName } from '@azure/communication-calling';
-import { CallKind } from '@azure/communication-calling';
-import { EnvironmentInfo } from '@azure/communication-calling';
-import { ParticipantRole } from '@azure/communication-calling';
 import { CommunicationUserKind, MicrosoftTeamsUserKind, PhoneNumberKind, UnknownIdentifierKind, CommunicationIdentifierKind } from '@azure/communication-common';
 /**
  * State only version of {@link @azure/communication-calling#CallAgent} except calls is moved to be a child directly of
@@ -19,68 +14,6 @@ export interface CallAgentState {
      */
     displayName?: string;
 }
-/**
- * @beta
- */
-export interface CaptionsInfo {
-    /**
-     * The state in which this caption data can be classified.
-     */
-    resultType: CaptionsResultType;
-    /**
-     * The information of the call participant who spoke the captioned text.
-     */
-    speaker: CallerInfo;
-    /**
-     * The language that the spoken words were interpretted as. Corresponds to the language specified in startCaptions / setSpokenLanguage.
-     */
-    spokenLanguage: string;
-    /**
-     * The caption text.
-     */
-    captionText: string;
-    /**
-     * Timestamp of when the captioned words were initially spoken.
-     */
-    timestamp: Date;
-    /**
-     * The language that the captions are presented in. Corresponds to the captionLanguage specified in startCaptions / setCaptionLanguage.
-     */
-    captionLanguage?: string;
-    /**
-     * The original spoken caption text prior to translating to subtitle language
-     */
-    spokenText?: string;
-}
-/**
- * @beta
- */
-export interface CaptionsCallFeatureState {
-    /**
-     * supported spoken languages
-     */
-    supportedSpokenLanguages: string[];
-    /**
-     * array of received captions
-     */
-    captions: CaptionsInfo[];
-    /**
-     * whether captions is on/off
-     */
-    isCaptionsFeatureActive: boolean;
-    /**
-     * supported caption languages
-     */
-    supportedCaptionLanguages: string[];
-    /**
-     * current spoken language
-     */
-    currentSpokenLanguage: string;
-    /**
-     * current caption language
-     */
-    currentCaptionLanguage: string;
-}
 /**
  * State only version of {@link @azure/communication-calling#TranscriptionCallFeature}. {@link StatefulCallClient} will
  * automatically listen for transcription state of the call and update the state exposed by {@link StatefulCallClient}
@@ -125,22 +58,6 @@ export interface LocalVideoStreamState {
      * API. This can be undefined if the stream has not yet been rendered and defined after createView creates the view.
      */
     view?: VideoStreamRendererViewState;
-    /**
-     * Stores the state of the video effects.
-     * @beta
-     */
-    videoEffects?: LocalVideoStreamVideoEffectsState;
-}
-/**
- * State only version of a LocalVideoStream's {@link @azure/communication-calling#VideoEffectsFeature}.
- *
- * @beta
- */
-export interface LocalVideoStreamVideoEffectsState {
-    /**
-     * List of effects if any are active.
-     */
-    activeEffects?: VideoEffectName[];
 }
 /**
  * State only version of {@link @azure/communication-calling#RemoteVideoStream}.
@@ -164,7 +81,6 @@ export interface RemoteVideoStreamState {
      * Proxy of {@link @azure/communication-calling#RemoteVideoStream.isReceiving}.
      * @beta
      */
-    isReceiving: boolean;
     /**
      * {@link VideoStreamRendererView} that is managed by createView/disposeView in {@link StatefulCallClient}
      * API. This can be undefined if the stream has not yet been rendered and defined after createView creates the view.
@@ -229,10 +145,6 @@ export interface RemoteParticipantState {
      * Proxy of {@link @azure/communication-calling#RemoteParticipant.isSpeaking}.
      */
     isSpeaking: boolean;
-    /**
-     * Proxy of {@link @azure/communication-calling#RemoteParticipant.role}.
-     */
-    role?: ParticipantRole;
 }
 /**
  * State only version of {@link @azure/communication-calling#Call}. {@link StatefulCallClient} will automatically
@@ -245,10 +157,6 @@ export interface CallState {
      * Proxy of {@link @azure/communication-calling#Call.id}.
      */
     id: string;
-    /**
-     * Type of the call.
-     */
-    kind: CallKind;
     /**
      * Proxy of {@link @azure/communication-calling#Call.callerInfo}.
      */
@@ -303,10 +211,6 @@ export interface CallState {
      * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature}.
      */
     transcription: TranscriptionCallFeatureState;
-    /**
-     * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature}.
-     */
-    captionsFeature: CaptionsCallFeatureState;
     /**
      * Proxy of {@link @azure/communication-calling#RecordingCallFeature}.
      */
@@ -335,14 +239,6 @@ export interface CallState {
      * Stores the latest call diagnostics.
      */
     diagnostics: DiagnosticsCallFeatureState;
-    /**
-     * Proxy of {@link @azure/communication-calling#Call.role}.
-     */
-    role?: ParticipantRole;
-    /**
-     * Proxy of {@link @azure/communication-calling#Call.totalParticipantCount}.
-     */
-    totalParticipantCount?: number;
 }
 /**
  * State only version of {@link @azure/communication-calling#IncomingCall}. {@link StatefulCallClient} will
@@ -492,16 +388,6 @@ export interface CallClientState {
      * See documentation of {@Link CallErrors} for details.
      */
     latestErrors: CallErrors;
-    /**
-     * A phone number in E.164 format that will be used to represent callers identity.
-     * For example, using the alternateCallerId to add a participant using PSTN, this number will
-     * be used as the caller id in the PSTN call.
-     */
-    alternateCallerId?: string;
-    /**
-     * state to track the environment that the stateful client was made in is supported
-     */
-    environmentInfo?: EnvironmentInfo;
 }
 /**
  * Errors teed from API calls to the Calling SDK.
@@ -544,7 +430,7 @@ export declare class CallError extends Error {
  *
  * @public
  */
-export declare type CallErrorTarget = 'Call.addParticipant' | 'Call.dispose' | 'Call.feature' | 'Call.hangUp' | 'Call.hold' | 'Call.mute' | 'Call.muteIncomingAudio' | 'Call.off' | 'Call.on' | 'Call.removeParticipant' | 'Call.resume' | 'Call.sendDtmf' | 'Call.startAudio' | 'Call.startScreenSharing' | 'Call.startVideo' | 'Call.stopScreenSharing' | 'Call.stopAudio' | 'Call.stopVideo' | 'Call.unmute' | 'Call.unmuteIncomingAudio' | 'CallAgent.dispose' | 'CallAgent.feature' | 'CallAgent.join' | 'CallAgent.off' | 'CallAgent.on' | 'CallAgent.startCall' | 'CallClient.createCallAgent' | 'CallClient.createTeamsCallAgent' | 'CallClient.feature' | 'CallClient.getDeviceManager' | /* @conditional-compile-remove(calling-beta-sdk) */ 'CallClient.getEnvironmentInfo' | 'DeviceManager.askDevicePermission' | 'DeviceManager.getCameras' | 'DeviceManager.getMicrophones' | 'DeviceManager.getSpeakers' | 'DeviceManager.off' | 'DeviceManager.on' | 'DeviceManager.selectMicrophone' | 'DeviceManager.selectSpeaker' | 'IncomingCall.accept' | 'IncomingCall.reject' | /* @conditional-compile-remove(calling-beta-sdk) */ /* @conditional-compile-remove(teams-identity-support) */ 'TeamsCall.addParticipant' | /* @conditional-compile-remove(video-background-effects) */ 'VideoEffectsFeature.startEffects' | /* @conditional-compile-remove(calling-beta-sdk) */ 'CallAgent.handlePushNotification' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.admit' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.rejectParticipant' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.admitAll';
+export declare type CallErrorTarget = 'Call.addParticipant' | 'Call.dispose' | 'Call.feature' | 'Call.hangUp' | 'Call.hold' | 'Call.mute' | 'Call.muteIncomingAudio' | 'Call.off' | 'Call.on' | 'Call.removeParticipant' | 'Call.resume' | 'Call.sendDtmf' | 'Call.startAudio' | 'Call.startScreenSharing' | 'Call.startVideo' | 'Call.stopScreenSharing' | 'Call.stopAudio' | 'Call.stopVideo' | 'Call.unmute' | 'Call.unmuteIncomingAudio' | 'CallAgent.dispose' | 'CallAgent.feature' | 'CallAgent.join' | 'CallAgent.off' | 'CallAgent.on' | 'CallAgent.startCall' | 'CallClient.createCallAgent' | 'CallClient.createTeamsCallAgent' | 'CallClient.feature' | 'CallClient.getDeviceManager' | 'DeviceManager.askDevicePermission' | 'DeviceManager.getCameras' | 'DeviceManager.getMicrophones' | 'DeviceManager.getSpeakers' | 'DeviceManager.off' | 'DeviceManager.on' | 'DeviceManager.selectMicrophone' | 'DeviceManager.selectSpeaker' | 'IncomingCall.accept' | 'IncomingCall.reject';
 /**
  * State only proxy for {@link @azure/communication-calling#DiagnosticsCallFeature}.
  *

package/dist/dist-esm/calling-stateful-client/src/CallClientState.js.map

@@ -1 +1 @@
-{"version":3,"file":"CallClientState.js","sourceRoot":"","sources":["../../../../preprocess-dist/calling-stateful-client/src/CallClientState.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AA4iBlC;;;;GAIG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAalC,YAAY,MAAuB,EAAE,UAAiB,EAAE,SAAgB;QACtE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,8EAA8E;QAC9E,IAAI,CAAC,SAAS,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,GAAG,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;IAC9D,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { AudioDeviceInfo, CallDirection, CallEndReason, CallerInfo, CallState as CallStatus, DeviceAccess, DominantSpeakersInfo, LatestMediaDiagnostics, LatestNetworkDiagnostics, MediaStreamType, RemoteParticipantState as RemoteParticipantStatus, ScalingMode, VideoDeviceInfo } from '@azure/communication-calling';\n/* @conditional-compile-remove(close-captions) */\nimport { CaptionsResultType } from '@azure/communication-calling';\n/* @conditional-compile-remove(video-background-effects) */\nimport { VideoEffectName } from '@azure/communication-calling';\n/* @conditional-compile-remove(teams-identity-support) */\nimport { CallKind } from '@azure/communication-calling';\n/* @conditional-compile-remove(unsupported-browser) */\nimport { EnvironmentInfo } from '@azure/communication-calling';\n/* @conditional-compile-remove(rooms) */\nimport { ParticipantRole } from '@azure/communication-calling';\nimport { CommunicationUserKind, MicrosoftTeamsUserKind, PhoneNumberKind, UnknownIdentifierKind, CommunicationIdentifierKind } from '@azure/communication-common';\n\n/**\n * State only version of {@link @azure/communication-calling#CallAgent} except calls is moved to be a child directly of\n * {@link CallClientState} and not included here. The reason to have CallAgent's state proxied is to provide access to\n * displayName. We don't flatten CallAgent.displayName and put it in CallClientState because it would be ambiguious that\n * displayName is actually reliant on the creation/existence of CallAgent to be available.\n *\n * @public\n */\nexport interface CallAgentState {\n  /**\n   * Proxy of {@link @azure/communication-calling#CallAgent.displayName}.\n   */\n  displayName?: string;\n}\n\n/* @conditional-compile-remove(close-captions) */\n/**\n * @beta\n */\nexport interface CaptionsInfo {\n  /**\n   * The state in which this caption data can be classified.\n   */\n  resultType: CaptionsResultType;\n  /**\n   * The information of the call participant who spoke the captioned text.\n   */\n  speaker: CallerInfo;\n  /**\n   * The language that the spoken words were interpretted as. Corresponds to the language specified in startCaptions / setSpokenLanguage.\n   */\n  spokenLanguage: string;\n  /**\n   * The caption text.\n   */\n  captionText: string;\n  /**\n   * Timestamp of when the captioned words were initially spoken.\n   */\n  timestamp: Date;\n  /**\n   * The language that the captions are presented in. Corresponds to the captionLanguage specified in startCaptions / setCaptionLanguage.\n   */\n  captionLanguage?: string;\n  /**\n   * The original spoken caption text prior to translating to subtitle language\n   */\n  spokenText?: string;\n}\n\n/* @conditional-compile-remove(close-captions) */\n/**\n * @beta\n */\nexport interface CaptionsCallFeatureState {\n  /**\n   * supported spoken languages\n   */\n  supportedSpokenLanguages: string[];\n  /**\n   * array of received captions\n   */\n  captions: CaptionsInfo[];\n  /**\n   * whether captions is on/off\n   */\n  isCaptionsFeatureActive: boolean;\n  /**\n   * supported caption languages\n   */\n  supportedCaptionLanguages: string[];\n  /**\n   * current spoken language\n   */\n  currentSpokenLanguage: string;\n  /**\n   * current caption language\n   */\n  currentCaptionLanguage: string;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#TranscriptionCallFeature}. {@link StatefulCallClient} will\n * automatically listen for transcription state of the call and update the state exposed by {@link StatefulCallClient}\n * accordingly.\n *\n * @public\n */\nexport interface TranscriptionCallFeatureState {\n  /**\n   * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature.isTranscriptionActive}.\n   */\n  isTranscriptionActive: boolean;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#RecordingCallFeature}. {@link StatefulCallClient} will\n * automatically listen for recording state of the call and update the state exposed by {@link StatefulCallClient} accordingly.\n *\n * @public\n */\nexport interface RecordingCallFeatureState {\n  /**\n   * Proxy of {@link @azure/communication-calling#RecordingCallFeature.isRecordingActive}.\n   */\n  isRecordingActive: boolean;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#LocalVideoStream}.\n *\n * @public\n */\nexport interface LocalVideoStreamState {\n  /**\n   * Proxy of {@link @azure/communication-calling#LocalVideoStream.source}.\n   */\n  source: VideoDeviceInfo;\n  /**\n   * Proxy of {@link @azure/communication-calling#LocalVideoStream.mediaStreamType}.\n   */\n  mediaStreamType: MediaStreamType;\n  /**\n   * {@link VideoStreamRendererView} that is managed by createView/disposeView in {@link StatefulCallClient}\n   * API. This can be undefined if the stream has not yet been rendered and defined after createView creates the view.\n   */\n  view?: VideoStreamRendererViewState;\n  /* @conditional-compile-remove(video-background-effects) */\n  /**\n   * Stores the state of the video effects.\n   * @beta\n   */\n  videoEffects?: LocalVideoStreamVideoEffectsState;\n}\n\n/* @conditional-compile-remove(video-background-effects) */\n/**\n * State only version of a LocalVideoStream's {@link @azure/communication-calling#VideoEffectsFeature}.\n *\n * @beta\n */\nexport interface LocalVideoStreamVideoEffectsState {\n  /**\n   * List of effects if any are active.\n   */\n  activeEffects?: VideoEffectName[];\n}\n\n/**\n * State only version of {@link @azure/communication-calling#RemoteVideoStream}.\n *\n * @public\n */\nexport interface RemoteVideoStreamState {\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.id}.\n   */\n  id: number;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.mediaStreamType}.\n   */\n  mediaStreamType: MediaStreamType;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.isAvailable}.\n   */\n  isAvailable: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.isReceiving}.\n   * @beta\n   */\n  /* @conditional-compile-remove(video-stream-is-receiving-flag) */\n  isReceiving: boolean;\n  /**\n   * {@link VideoStreamRendererView} that is managed by createView/disposeView in {@link StatefulCallClient}\n   * API. This can be undefined if the stream has not yet been rendered and defined after createView creates the view.\n   */\n  view?: VideoStreamRendererViewState;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#VideoStreamRendererView}. This property is added to the state exposed\n * by {@link StatefulCallClient} by {@link StatefulCallClient.createView} and removed by {@link StatefulCallClient.disposeView}.\n *\n * @public\n */\nexport interface VideoStreamRendererViewState {\n  /**\n   * Proxy of {@link @azure/communication-calling#VideoStreamRendererView.scalingMode}.\n   */\n  scalingMode: ScalingMode;\n  /**\n   * Proxy of {@link @azure/communication-calling#VideoStreamRendererView.isMirrored}.\n   */\n  isMirrored: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#VideoStreamRendererView.target}.\n   */\n  target: HTMLElement;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#RemoteParticipant}. {@link StatefulCallClient} will\n * automatically retrieve RemoteParticipants and add their state to the state exposed by {@link StatefulCallClient}.\n *\n * @public\n */\nexport interface RemoteParticipantState {\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.identifier}.\n   */\n  identifier: CommunicationUserKind | PhoneNumberKind | MicrosoftTeamsUserKind | UnknownIdentifierKind;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.displayName}.\n   */\n  displayName?: string;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.state}.\n   */\n  state: RemoteParticipantStatus;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.callEndReason}.\n   */\n  callEndReason?: CallEndReason;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.videoStreams} as an object with\n   * {@link RemoteVideoStream} fields keyed by {@link @azure/communication-calling#RemoteVideoStream.id}.\n   */\n  videoStreams: {\n    [key: number]: RemoteVideoStreamState;\n  };\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.isMuted}.\n   */\n  isMuted: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.isSpeaking}.\n   */\n  isSpeaking: boolean;\n  /* @conditional-compile-remove(rooms) */\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.role}.\n   */\n  role?: ParticipantRole;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#Call}. {@link StatefulCallClient} will automatically\n * retrieve Call's state and add it to the state exposed by {@link StatefulCallClient}.\n *\n * @public\n */\nexport interface CallState {\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.id}.\n   */\n  id: string;\n  /* @conditional-compile-remove(teams-identity-support) */\n  /**\n   * Type of the call.\n   */\n  kind: CallKind;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.callerInfo}.\n   */\n  callerInfo: CallerInfo;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.state}.\n   */\n  state: CallStatus;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.callEndReason}.\n   */\n  callEndReason?: CallEndReason;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.direction}.\n   */\n  direction: CallDirection;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.isMuted}.\n   */\n  isMuted: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.isScreenSharingOn}.\n   */\n  isScreenSharingOn: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#DominantSpeakersInfo }.\n   */\n  dominantSpeakers?: DominantSpeakersInfo;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.localVideoStreams}.\n   */\n  localVideoStreams: LocalVideoStreamState[];\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.remoteParticipants}.\n   * Object with {@link RemoteParticipant} fields keyed by flattened {@link RemoteParticipantState.identifier}.\n   * To obtain a flattened {@link RemoteParticipantState.identifier}, use\n   * {@link @azure/communication-react#toFlatCommunicationIdentifier}.\n   */\n  remoteParticipants: {\n    [keys: string]: RemoteParticipantState;\n  };\n  /**\n   * Stores remote participants that have left the call so that the callEndReason could be retrieved.\n   * Object with {@link RemoteParticipant} fields keyed by flattened {@link RemoteParticipantState.identifier}.\n   * To obtain a flattened {@link RemoteParticipantState.identifier}, use\n   * {@link @azure/communication-react#toFlatCommunicationIdentifier}.\n   */\n  remoteParticipantsEnded: {\n    [keys: string]: RemoteParticipantState;\n  };\n  /**\n   * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature}.\n   */\n  transcription: TranscriptionCallFeatureState;\n  /* @conditional-compile-remove(close-captions) */\n  /**\n   * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature}.\n   */\n  captionsFeature: CaptionsCallFeatureState;\n  /**\n   * Proxy of {@link @azure/communication-calling#RecordingCallFeature}.\n   */\n  recording: RecordingCallFeatureState;\n  /**\n   * Stores the currently active screenshare participant's key. If there is no screenshare active, then this will be\n   * undefined. You can use this key to access the remoteParticipant data in {@link CallState.remoteParticipants} object.\n   *\n   * Note this only applies to ScreenShare in RemoteParticipant. A local ScreenShare being active will not affect this\n   * property.\n   *\n   * This property is added by the stateful layer and is not a proxy of SDK state\n   */\n  screenShareRemoteParticipant?: string;\n  /**\n   * Stores the local date when the call started on the client. This property is added by the stateful layer and is not\n   * a proxy of SDK state.\n   */\n  startTime: Date;\n  /**\n   * Stores the local date when the call ended on the client. This property is added by the stateful layer and is not\n   * a proxy of SDK state.\n   */\n  endTime: Date | undefined;\n\n  /**\n   * Stores the latest call diagnostics.\n   */\n  diagnostics: DiagnosticsCallFeatureState;\n  /* @conditional-compile-remove(rooms) */\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.role}.\n   */\n  role?: ParticipantRole;\n\n  /* @conditional-compile-remove(total-participant-count) */\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.totalParticipantCount}.\n   */\n  totalParticipantCount?: number;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#IncomingCall}. {@link StatefulCallClient} will\n * automatically detect incoming calls and add their state to the state exposed by {@link StatefulCallClient}.\n *\n * @public\n */\nexport interface IncomingCallState {\n  /**\n   * Proxy of {@link @azure/communication-calling#IncomingCall.id}.\n   */\n  id: string;\n  /**\n   * Proxy of {@link @azure/communication-calling#IncomingCall.callerInfo}.\n   */\n  callerInfo: CallerInfo;\n  /**\n   * Set to the state returned by 'callEnded' event on {@link @azure/communication-calling#IncomingCall} when received.\n   * This property is added by the stateful layer and is not a proxy of SDK state.\n   */\n  callEndReason?: CallEndReason;\n  /**\n   * Stores the local date when the call started on the client. This property is added by the stateful layer and is not\n   * a proxy of SDK state.\n   */\n  startTime: Date;\n  /**\n   * Stores the local date when the call ended on the client. This property is added by the stateful layer and is not a\n   * proxy of SDK state. It is undefined if the call is not ended yet.\n   */\n  endTime?: Date;\n}\n\n/**\n * This type is meant to encapsulate all the state inside {@link @azure/communication-calling#DeviceManager}. For\n * optional parameters they may not be available until permission is granted by the user. The cameras, microphones,\n * speakers, and deviceAccess states will be empty until the corresponding\n * {@link @azure/communication-calling#DeviceManager}'s getCameras, getMicrophones, getSpeakers, and askDevicePermission\n * APIs are called and completed.\n *\n * @public\n */\nexport type DeviceManagerState = {\n  /**\n   * Proxy of {@link @azure/communication-calling#DeviceManager.isSpeakerSelectionAvailable}.\n   */\n  isSpeakerSelectionAvailable: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#DeviceManager.selectedMicrophone}.\n   */\n  selectedMicrophone?: AudioDeviceInfo;\n  /**\n   * Proxy of {@link @azure/communication-calling#DeviceManager.selectedSpeaker}.\n   */\n  selectedSpeaker?: AudioDeviceInfo;\n  /**\n   * Stores the selected camera device info. This is added by the stateful layer and does not exist in the Calling SDK.\n   * It is meant as a convenience to the developer. It must be explicitly set before it has any value and does not\n   * persist across instances of the {@link StatefulCallClient}. The developer controls entirely what this value holds\n   * at any time.\n   */\n  selectedCamera?: VideoDeviceInfo;\n  /**\n   * Stores any cameras data returned from {@link @azure/communication-calling#DeviceManager.getCameras}.\n   */\n  cameras: VideoDeviceInfo[];\n  /**\n   * Stores any microphones data returned from {@link @azure/communication-calling#DeviceManager.getMicrophones}.\n   */\n  microphones: AudioDeviceInfo[];\n  /**\n   * Stores any speakers data returned from {@link @azure/communication-calling#DeviceManager.getSpeakers}.\n   */\n  speakers: AudioDeviceInfo[];\n  /**\n   * Stores deviceAccess data returned from {@link @azure/communication-calling#DeviceManager.askDevicePermission}.\n   */\n  deviceAccess?: DeviceAccess;\n  /**\n   * Stores created views that are not associated with any CallState (when {@link StatefulCallClient.createView} is\n   * called with undefined callId, undefined participantId, and defined LocalVideoStream).\n   *\n   * The values in this array are generated internally when {@link StatefulCallClient.createView} is called and are\n   * considered immutable.\n   */\n  unparentedViews: LocalVideoStreamState[];\n};\n\n/**\n * Container for all of the state data proxied by {@link StatefulCallClient}. The calls, callsEnded, incomingCalls, and\n * incomingCallsEnded states will be automatically provided if a callAgent has been created. The deviceManager will be\n * empty initially until populated see {@link DeviceManagerState}. The userId state is provided as a convenience for the\n * developer and is completely controled and set by the developer.\n *\n * @public\n */\nexport interface CallClientState {\n  /**\n   * Proxy of {@link @azure/communication-calling#CallAgent.calls} as an object with CallState {@link CallState} fields.\n   * It is keyed by {@link @azure/communication-calling#Call.id}. Please note that\n   * {@link @azure/communication-calling#Call.id} could change. You should not cache the id itself but the entire\n   * {@link @azure/communication-calling#Call} and then use the id contained to look up data in this map.\n   */\n  calls: {\n    [key: string]: CallState;\n  };\n  /**\n   * Calls that have ended are stored here so the callEndReason could be checked.\n   * It is an object with {@link @azure/communication-calling#Call.id} keys and {@link CallState} values.\n   *\n   * Only {@link MAX_CALL_HISTORY_LENGTH} Calls are kept in the history. Oldest calls are evicted if required.\n   */\n  callsEnded: {\n    [key: string]: CallState;\n  };\n  /**\n   * Proxy of {@link @azure/communication-calling#IncomingCall} as an object with {@link IncomingCall} fields.\n   * It is keyed by {@link @azure/communication-calling#IncomingCall.id}.\n   */\n  incomingCalls: {\n    [key: string]: IncomingCallState;\n  };\n  /**\n   * Incoming Calls that have ended are stored here so the callEndReason could be checked.\n   * It is an as an object with {@link @azure/communication-calling#Call.id} keys and {@link IncomingCall} values.\n   *\n   * Only {@link MAX_CALL_HISTORY_LENGTH} Calls are kept in the history. Oldest calls are evicted if required.\n   */\n  incomingCallsEnded: {\n    [key: string]: IncomingCallState;\n  };\n  /**\n   * Proxy of {@link @azure/communication-calling#DeviceManager}. Please review {@link DeviceManagerState}.\n   */\n  deviceManager: DeviceManagerState;\n  /**\n   * Proxy of {@link @azure/communication-calling#CallAgent}. Please review {@link CallAgentState}.\n   */\n  callAgent?: CallAgentState;\n  /**\n   * Stores a userId. This is not used by the {@link StatefulCallClient} and is provided here as a convenience for the\n   * developer for easier access to userId. Must be passed in at initialization of the {@link StatefulCallClient}.\n   * Completely controlled by the developer.\n   */\n  userId: CommunicationIdentifierKind;\n  /**\n   * Stores the latest error for each API method.\n   *\n   * See documentation of {@Link CallErrors} for details.\n   */\n  latestErrors: CallErrors;\n  /* @conditional-compile-remove(PSTN-calls) */\n  /**\n   * A phone number in E.164 format that will be used to represent callers identity.\n   * For example, using the alternateCallerId to add a participant using PSTN, this number will\n   * be used as the caller id in the PSTN call.\n   */\n  alternateCallerId?: string;\n  /* @conditional-compile-remove(unsupported-browser) */\n  /**\n   * state to track the environment that the stateful client was made in is supported\n   */\n  environmentInfo?: EnvironmentInfo;\n}\n\n/**\n * Errors teed from API calls to the Calling SDK.\n *\n * Each property in the object stores the latest error for a particular SDK API method.\n *\n * Errors from this object can be cleared using the {@link newClearCallErrorsModifier}.\n * Additionally, errors are automatically cleared when:\n * - The state is cleared.\n * - Subsequent calls to related API methods succeed.\n * See documentation of individual stateful client methods for details on when errors may be automatically cleared.\n *\n * @public\n */\nexport type CallErrors = { [target in CallErrorTarget]: CallError };\n\n/**\n * Error thrown from failed stateful API methods.\n *\n * @public\n */\nexport class CallError extends Error {\n  /**\n   * The API method target that failed.\n   */\n  public target: CallErrorTarget;\n  /**\n   * Error thrown by the failed SDK method.\n   */\n  public innerError: Error;\n  /**\n   * Timestamp added to the error by the stateful layer.\n   */\n  public timestamp: Date;\n  constructor(target: CallErrorTarget, innerError: Error, timestamp?: Date) {\n    super();\n    this.target = target;\n    this.innerError = innerError;\n    // Testing note: It is easier to mock Date::now() than the Date() constructor.\n    this.timestamp = timestamp ?? new Date(Date.now());\n    this.name = 'CallError';\n    this.message = `${this.target}: ${this.innerError.message}`;\n  }\n}\n\n/**\n * String literal type for all permissible keys in {@Link CallErrors}.\n *\n * @public\n */\nexport type CallErrorTarget = 'Call.addParticipant' | 'Call.dispose' | 'Call.feature' | 'Call.hangUp' | 'Call.hold' | 'Call.mute' | 'Call.muteIncomingAudio' | 'Call.off' | 'Call.on' | 'Call.removeParticipant' | 'Call.resume' | 'Call.sendDtmf' | 'Call.startAudio' | 'Call.startScreenSharing' | 'Call.startVideo' | 'Call.stopScreenSharing' | 'Call.stopAudio' | 'Call.stopVideo' | 'Call.unmute' | 'Call.unmuteIncomingAudio' | 'CallAgent.dispose' | 'CallAgent.feature' | 'CallAgent.join' | 'CallAgent.off' | 'CallAgent.on' | 'CallAgent.startCall' | 'CallClient.createCallAgent' | 'CallClient.createTeamsCallAgent' | 'CallClient.feature' | 'CallClient.getDeviceManager' | /* @conditional-compile-remove(calling-beta-sdk) */'CallClient.getEnvironmentInfo' | 'DeviceManager.askDevicePermission' | 'DeviceManager.getCameras' | 'DeviceManager.getMicrophones' | 'DeviceManager.getSpeakers' | 'DeviceManager.off' | 'DeviceManager.on' | 'DeviceManager.selectMicrophone' | 'DeviceManager.selectSpeaker' | 'IncomingCall.accept' | 'IncomingCall.reject' | /* @conditional-compile-remove(calling-beta-sdk) */ /* @conditional-compile-remove(teams-identity-support) */'TeamsCall.addParticipant' | /* @conditional-compile-remove(video-background-effects) */'VideoEffectsFeature.startEffects' | /* @conditional-compile-remove(calling-beta-sdk) */'CallAgent.handlePushNotification' | /* @conditional-compile-remove(calling-beta-sdk) */'Call.admit' | /* @conditional-compile-remove(calling-beta-sdk) */'Call.rejectParticipant' | /* @conditional-compile-remove(calling-beta-sdk) */'Call.admitAll';\n\n/**\n * State only proxy for {@link @azure/communication-calling#DiagnosticsCallFeature}.\n *\n * @public\n */\nexport interface DiagnosticsCallFeatureState {\n  /**\n   * Stores diagnostics related to network conditions.\n   */\n  network: NetworkDiagnosticsState;\n\n  /**\n   * Stores diagnostics related to media quality.\n   */\n  media: MediaDiagnosticsState;\n}\n\n/**\n * State only proxy for {@link @azure/communication-calling#NetworkDiagnostics}.\n *\n * @public\n */\nexport interface NetworkDiagnosticsState {\n  latest: LatestNetworkDiagnostics;\n}\n\n/**\n * State only proxy for {@link @azure/communication-calling#MediaDiagnostics}.\n *\n * @public\n */\nexport interface MediaDiagnosticsState {\n  latest: LatestMediaDiagnostics;\n}"]}
+{"version":3,"file":"CallClientState.js","sourceRoot":"","sources":["../../../../preprocess-dist/calling-stateful-client/src/CallClientState.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAkalC;;;;GAIG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IAalC,YAAY,MAAuB,EAAE,UAAiB,EAAE,SAAgB;QACtE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,8EAA8E;QAC9E,IAAI,CAAC,SAAS,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,GAAG,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;IAC9D,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { AudioDeviceInfo, CallDirection, CallEndReason, CallerInfo, CallState as CallStatus, DeviceAccess, DominantSpeakersInfo, LatestMediaDiagnostics, LatestNetworkDiagnostics, MediaStreamType, RemoteParticipantState as RemoteParticipantStatus, ScalingMode, VideoDeviceInfo } from '@azure/communication-calling';\nimport { CommunicationUserKind, MicrosoftTeamsUserKind, PhoneNumberKind, UnknownIdentifierKind, CommunicationIdentifierKind } from '@azure/communication-common';\n\n/**\n * State only version of {@link @azure/communication-calling#CallAgent} except calls is moved to be a child directly of\n * {@link CallClientState} and not included here. The reason to have CallAgent's state proxied is to provide access to\n * displayName. We don't flatten CallAgent.displayName and put it in CallClientState because it would be ambiguious that\n * displayName is actually reliant on the creation/existence of CallAgent to be available.\n *\n * @public\n */\nexport interface CallAgentState {\n  /**\n   * Proxy of {@link @azure/communication-calling#CallAgent.displayName}.\n   */\n  displayName?: string;\n}\n/**\n * State only version of {@link @azure/communication-calling#TranscriptionCallFeature}. {@link StatefulCallClient} will\n * automatically listen for transcription state of the call and update the state exposed by {@link StatefulCallClient}\n * accordingly.\n *\n * @public\n */\nexport interface TranscriptionCallFeatureState {\n  /**\n   * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature.isTranscriptionActive}.\n   */\n  isTranscriptionActive: boolean;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#RecordingCallFeature}. {@link StatefulCallClient} will\n * automatically listen for recording state of the call and update the state exposed by {@link StatefulCallClient} accordingly.\n *\n * @public\n */\nexport interface RecordingCallFeatureState {\n  /**\n   * Proxy of {@link @azure/communication-calling#RecordingCallFeature.isRecordingActive}.\n   */\n  isRecordingActive: boolean;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#LocalVideoStream}.\n *\n * @public\n */\nexport interface LocalVideoStreamState {\n  /**\n   * Proxy of {@link @azure/communication-calling#LocalVideoStream.source}.\n   */\n  source: VideoDeviceInfo;\n  /**\n   * Proxy of {@link @azure/communication-calling#LocalVideoStream.mediaStreamType}.\n   */\n  mediaStreamType: MediaStreamType;\n  /**\n   * {@link VideoStreamRendererView} that is managed by createView/disposeView in {@link StatefulCallClient}\n   * API. This can be undefined if the stream has not yet been rendered and defined after createView creates the view.\n   */\n  view?: VideoStreamRendererViewState;\n}\n/**\n * State only version of {@link @azure/communication-calling#RemoteVideoStream}.\n *\n * @public\n */\nexport interface RemoteVideoStreamState {\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.id}.\n   */\n  id: number;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.mediaStreamType}.\n   */\n  mediaStreamType: MediaStreamType;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.isAvailable}.\n   */\n  isAvailable: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteVideoStream.isReceiving}.\n   * @beta\n   */\n  /**\n   * {@link VideoStreamRendererView} that is managed by createView/disposeView in {@link StatefulCallClient}\n   * API. This can be undefined if the stream has not yet been rendered and defined after createView creates the view.\n   */\n  view?: VideoStreamRendererViewState;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#VideoStreamRendererView}. This property is added to the state exposed\n * by {@link StatefulCallClient} by {@link StatefulCallClient.createView} and removed by {@link StatefulCallClient.disposeView}.\n *\n * @public\n */\nexport interface VideoStreamRendererViewState {\n  /**\n   * Proxy of {@link @azure/communication-calling#VideoStreamRendererView.scalingMode}.\n   */\n  scalingMode: ScalingMode;\n  /**\n   * Proxy of {@link @azure/communication-calling#VideoStreamRendererView.isMirrored}.\n   */\n  isMirrored: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#VideoStreamRendererView.target}.\n   */\n  target: HTMLElement;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#RemoteParticipant}. {@link StatefulCallClient} will\n * automatically retrieve RemoteParticipants and add their state to the state exposed by {@link StatefulCallClient}.\n *\n * @public\n */\nexport interface RemoteParticipantState {\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.identifier}.\n   */\n  identifier: CommunicationUserKind | PhoneNumberKind | MicrosoftTeamsUserKind | UnknownIdentifierKind;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.displayName}.\n   */\n  displayName?: string;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.state}.\n   */\n  state: RemoteParticipantStatus;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.callEndReason}.\n   */\n  callEndReason?: CallEndReason;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.videoStreams} as an object with\n   * {@link RemoteVideoStream} fields keyed by {@link @azure/communication-calling#RemoteVideoStream.id}.\n   */\n  videoStreams: {\n    [key: number]: RemoteVideoStreamState;\n  };\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.isMuted}.\n   */\n  isMuted: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#RemoteParticipant.isSpeaking}.\n   */\n  isSpeaking: boolean;\n}\n\n/**\n * State only version of {@link @azure/communication-calling#Call}. {@link StatefulCallClient} will automatically\n * retrieve Call's state and add it to the state exposed by {@link StatefulCallClient}.\n *\n * @public\n */\nexport interface CallState {\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.id}.\n   */\n  id: string;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.callerInfo}.\n   */\n  callerInfo: CallerInfo;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.state}.\n   */\n  state: CallStatus;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.callEndReason}.\n   */\n  callEndReason?: CallEndReason;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.direction}.\n   */\n  direction: CallDirection;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.isMuted}.\n   */\n  isMuted: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.isScreenSharingOn}.\n   */\n  isScreenSharingOn: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#DominantSpeakersInfo }.\n   */\n  dominantSpeakers?: DominantSpeakersInfo;\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.localVideoStreams}.\n   */\n  localVideoStreams: LocalVideoStreamState[];\n  /**\n   * Proxy of {@link @azure/communication-calling#Call.remoteParticipants}.\n   * Object with {@link RemoteParticipant} fields keyed by flattened {@link RemoteParticipantState.identifier}.\n   * To obtain a flattened {@link RemoteParticipantState.identifier}, use\n   * {@link @azure/communication-react#toFlatCommunicationIdentifier}.\n   */\n  remoteParticipants: {\n    [keys: string]: RemoteParticipantState;\n  };\n  /**\n   * Stores remote participants that have left the call so that the callEndReason could be retrieved.\n   * Object with {@link RemoteParticipant} fields keyed by flattened {@link RemoteParticipantState.identifier}.\n   * To obtain a flattened {@link RemoteParticipantState.identifier}, use\n   * {@link @azure/communication-react#toFlatCommunicationIdentifier}.\n   */\n  remoteParticipantsEnded: {\n    [keys: string]: RemoteParticipantState;\n  };\n  /**\n   * Proxy of {@link @azure/communication-calling#TranscriptionCallFeature}.\n   */\n  transcription: TranscriptionCallFeatureState;\n  /**\n   * Proxy of {@link @azure/communication-calling#RecordingCallFeature}.\n   */\n  recording: RecordingCallFeatureState;\n  /**\n   * Stores the currently active screenshare participant's key. If there is no screenshare active, then this will be\n   * undefined. You can use this key to access the remoteParticipant data in {@link CallState.remoteParticipants} object.\n   *\n   * Note this only applies to ScreenShare in RemoteParticipant. A local ScreenShare being active will not affect this\n   * property.\n   *\n   * This property is added by the stateful layer and is not a proxy of SDK state\n   */\n  screenShareRemoteParticipant?: string;\n  /**\n   * Stores the local date when the call started on the client. This property is added by the stateful layer and is not\n   * a proxy of SDK state.\n   */\n  startTime: Date;\n  /**\n   * Stores the local date when the call ended on the client. This property is added by the stateful layer and is not\n   * a proxy of SDK state.\n   */\n  endTime: Date | undefined;\n\n  /**\n   * Stores the latest call diagnostics.\n   */\n  diagnostics: DiagnosticsCallFeatureState;\n}\n/**\n * State only version of {@link @azure/communication-calling#IncomingCall}. {@link StatefulCallClient} will\n * automatically detect incoming calls and add their state to the state exposed by {@link StatefulCallClient}.\n *\n * @public\n */\nexport interface IncomingCallState {\n  /**\n   * Proxy of {@link @azure/communication-calling#IncomingCall.id}.\n   */\n  id: string;\n  /**\n   * Proxy of {@link @azure/communication-calling#IncomingCall.callerInfo}.\n   */\n  callerInfo: CallerInfo;\n  /**\n   * Set to the state returned by 'callEnded' event on {@link @azure/communication-calling#IncomingCall} when received.\n   * This property is added by the stateful layer and is not a proxy of SDK state.\n   */\n  callEndReason?: CallEndReason;\n  /**\n   * Stores the local date when the call started on the client. This property is added by the stateful layer and is not\n   * a proxy of SDK state.\n   */\n  startTime: Date;\n  /**\n   * Stores the local date when the call ended on the client. This property is added by the stateful layer and is not a\n   * proxy of SDK state. It is undefined if the call is not ended yet.\n   */\n  endTime?: Date;\n}\n\n/**\n * This type is meant to encapsulate all the state inside {@link @azure/communication-calling#DeviceManager}. For\n * optional parameters they may not be available until permission is granted by the user. The cameras, microphones,\n * speakers, and deviceAccess states will be empty until the corresponding\n * {@link @azure/communication-calling#DeviceManager}'s getCameras, getMicrophones, getSpeakers, and askDevicePermission\n * APIs are called and completed.\n *\n * @public\n */\nexport type DeviceManagerState = {\n  /**\n   * Proxy of {@link @azure/communication-calling#DeviceManager.isSpeakerSelectionAvailable}.\n   */\n  isSpeakerSelectionAvailable: boolean;\n  /**\n   * Proxy of {@link @azure/communication-calling#DeviceManager.selectedMicrophone}.\n   */\n  selectedMicrophone?: AudioDeviceInfo;\n  /**\n   * Proxy of {@link @azure/communication-calling#DeviceManager.selectedSpeaker}.\n   */\n  selectedSpeaker?: AudioDeviceInfo;\n  /**\n   * Stores the selected camera device info. This is added by the stateful layer and does not exist in the Calling SDK.\n   * It is meant as a convenience to the developer. It must be explicitly set before it has any value and does not\n   * persist across instances of the {@link StatefulCallClient}. The developer controls entirely what this value holds\n   * at any time.\n   */\n  selectedCamera?: VideoDeviceInfo;\n  /**\n   * Stores any cameras data returned from {@link @azure/communication-calling#DeviceManager.getCameras}.\n   */\n  cameras: VideoDeviceInfo[];\n  /**\n   * Stores any microphones data returned from {@link @azure/communication-calling#DeviceManager.getMicrophones}.\n   */\n  microphones: AudioDeviceInfo[];\n  /**\n   * Stores any speakers data returned from {@link @azure/communication-calling#DeviceManager.getSpeakers}.\n   */\n  speakers: AudioDeviceInfo[];\n  /**\n   * Stores deviceAccess data returned from {@link @azure/communication-calling#DeviceManager.askDevicePermission}.\n   */\n  deviceAccess?: DeviceAccess;\n  /**\n   * Stores created views that are not associated with any CallState (when {@link StatefulCallClient.createView} is\n   * called with undefined callId, undefined participantId, and defined LocalVideoStream).\n   *\n   * The values in this array are generated internally when {@link StatefulCallClient.createView} is called and are\n   * considered immutable.\n   */\n  unparentedViews: LocalVideoStreamState[];\n};\n\n/**\n * Container for all of the state data proxied by {@link StatefulCallClient}. The calls, callsEnded, incomingCalls, and\n * incomingCallsEnded states will be automatically provided if a callAgent has been created. The deviceManager will be\n * empty initially until populated see {@link DeviceManagerState}. The userId state is provided as a convenience for the\n * developer and is completely controled and set by the developer.\n *\n * @public\n */\nexport interface CallClientState {\n  /**\n   * Proxy of {@link @azure/communication-calling#CallAgent.calls} as an object with CallState {@link CallState} fields.\n   * It is keyed by {@link @azure/communication-calling#Call.id}. Please note that\n   * {@link @azure/communication-calling#Call.id} could change. You should not cache the id itself but the entire\n   * {@link @azure/communication-calling#Call} and then use the id contained to look up data in this map.\n   */\n  calls: {\n    [key: string]: CallState;\n  };\n  /**\n   * Calls that have ended are stored here so the callEndReason could be checked.\n   * It is an object with {@link @azure/communication-calling#Call.id} keys and {@link CallState} values.\n   *\n   * Only {@link MAX_CALL_HISTORY_LENGTH} Calls are kept in the history. Oldest calls are evicted if required.\n   */\n  callsEnded: {\n    [key: string]: CallState;\n  };\n  /**\n   * Proxy of {@link @azure/communication-calling#IncomingCall} as an object with {@link IncomingCall} fields.\n   * It is keyed by {@link @azure/communication-calling#IncomingCall.id}.\n   */\n  incomingCalls: {\n    [key: string]: IncomingCallState;\n  };\n  /**\n   * Incoming Calls that have ended are stored here so the callEndReason could be checked.\n   * It is an as an object with {@link @azure/communication-calling#Call.id} keys and {@link IncomingCall} values.\n   *\n   * Only {@link MAX_CALL_HISTORY_LENGTH} Calls are kept in the history. Oldest calls are evicted if required.\n   */\n  incomingCallsEnded: {\n    [key: string]: IncomingCallState;\n  };\n  /**\n   * Proxy of {@link @azure/communication-calling#DeviceManager}. Please review {@link DeviceManagerState}.\n   */\n  deviceManager: DeviceManagerState;\n  /**\n   * Proxy of {@link @azure/communication-calling#CallAgent}. Please review {@link CallAgentState}.\n   */\n  callAgent?: CallAgentState;\n  /**\n   * Stores a userId. This is not used by the {@link StatefulCallClient} and is provided here as a convenience for the\n   * developer for easier access to userId. Must be passed in at initialization of the {@link StatefulCallClient}.\n   * Completely controlled by the developer.\n   */\n  userId: CommunicationIdentifierKind;\n  /**\n   * Stores the latest error for each API method.\n   *\n   * See documentation of {@Link CallErrors} for details.\n   */\n  latestErrors: CallErrors;\n}\n\n/**\n * Errors teed from API calls to the Calling SDK.\n *\n * Each property in the object stores the latest error for a particular SDK API method.\n *\n * Errors from this object can be cleared using the {@link newClearCallErrorsModifier}.\n * Additionally, errors are automatically cleared when:\n * - The state is cleared.\n * - Subsequent calls to related API methods succeed.\n * See documentation of individual stateful client methods for details on when errors may be automatically cleared.\n *\n * @public\n */\nexport type CallErrors = { [target in CallErrorTarget]: CallError };\n\n/**\n * Error thrown from failed stateful API methods.\n *\n * @public\n */\nexport class CallError extends Error {\n  /**\n   * The API method target that failed.\n   */\n  public target: CallErrorTarget;\n  /**\n   * Error thrown by the failed SDK method.\n   */\n  public innerError: Error;\n  /**\n   * Timestamp added to the error by the stateful layer.\n   */\n  public timestamp: Date;\n  constructor(target: CallErrorTarget, innerError: Error, timestamp?: Date) {\n    super();\n    this.target = target;\n    this.innerError = innerError;\n    // Testing note: It is easier to mock Date::now() than the Date() constructor.\n    this.timestamp = timestamp ?? new Date(Date.now());\n    this.name = 'CallError';\n    this.message = `${this.target}: ${this.innerError.message}`;\n  }\n}\n\n/**\n * String literal type for all permissible keys in {@Link CallErrors}.\n *\n * @public\n */\nexport type CallErrorTarget = 'Call.addParticipant' | 'Call.dispose' | 'Call.feature' | 'Call.hangUp' | 'Call.hold' | 'Call.mute' | 'Call.muteIncomingAudio' | 'Call.off' | 'Call.on' | 'Call.removeParticipant' | 'Call.resume' | 'Call.sendDtmf' | 'Call.startAudio' | 'Call.startScreenSharing' | 'Call.startVideo' | 'Call.stopScreenSharing' | 'Call.stopAudio' | 'Call.stopVideo' | 'Call.unmute' | 'Call.unmuteIncomingAudio' | 'CallAgent.dispose' | 'CallAgent.feature' | 'CallAgent.join' | 'CallAgent.off' | 'CallAgent.on' | 'CallAgent.startCall' | 'CallClient.createCallAgent' | 'CallClient.createTeamsCallAgent' | 'CallClient.feature' | 'CallClient.getDeviceManager' | 'DeviceManager.askDevicePermission' | 'DeviceManager.getCameras' | 'DeviceManager.getMicrophones' | 'DeviceManager.getSpeakers' | 'DeviceManager.off' | 'DeviceManager.on' | 'DeviceManager.selectMicrophone' | 'DeviceManager.selectSpeaker' | 'IncomingCall.accept' | 'IncomingCall.reject';\n\n/**\n * State only proxy for {@link @azure/communication-calling#DiagnosticsCallFeature}.\n *\n * @public\n */\nexport interface DiagnosticsCallFeatureState {\n  /**\n   * Stores diagnostics related to network conditions.\n   */\n  network: NetworkDiagnosticsState;\n\n  /**\n   * Stores diagnostics related to media quality.\n   */\n  media: MediaDiagnosticsState;\n}\n\n/**\n * State only proxy for {@link @azure/communication-calling#NetworkDiagnostics}.\n *\n * @public\n */\nexport interface NetworkDiagnosticsState {\n  latest: LatestNetworkDiagnostics;\n}\n\n/**\n * State only proxy for {@link @azure/communication-calling#MediaDiagnostics}.\n *\n * @public\n */\nexport interface MediaDiagnosticsState {\n  latest: LatestMediaDiagnostics;\n}"]}

package/dist/dist-esm/calling-stateful-client/src/CallContext.d.ts

@@ -1,11 +1,7 @@
 import { CommunicationIdentifierKind } from '@azure/communication-common';
 import { AudioDeviceInfo, DeviceAccess, DominantSpeakersInfo, ScalingMode, VideoDeviceInfo } from '@azure/communication-calling';
-import { TeamsCaptionsInfo } from '@azure/communication-calling';
-import { EnvironmentInfo } from '@azure/communication-calling';
-import { ParticipantRole } from '@azure/communication-calling';
 import { CallEndReason, CallState as CallStatus, RemoteParticipantState as RemoteParticipantStatus } from '@azure/communication-calling';
 import { CallState, CallClientState, LocalVideoStreamState, RemoteParticipantState, RemoteVideoStreamState, IncomingCallState, VideoStreamRendererViewState, CallAgentState, CallErrorTarget } from './CallClientState';
-import { LocalVideoStreamVideoEffectsState } from './CallClientState';
 /**
  * @private
  */
@@ -19,7 +15,7 @@ export declare class CallContext {
     private _emitter;
     private _atomicId;
     private _callIdHistory;
-    constructor(userId: CommunicationIdentifierKind, maxListeners?: number, /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId?: string);
+    constructor(userId: CommunicationIdentifierKind, maxListeners?: number);
     getState(): CallClientState;
     modifyState(modifier: (draft: CallClientState) => void): void;
     onStateChange(handler: (state: CallClientState) => void): void;
@@ -31,15 +27,11 @@ export declare class CallContext {
     setCallEnded(callId: string, callEndReason: CallEndReason | undefined): void;
     setCallState(callId: string, state: CallStatus): void;
     setCallId(newCallId: string, oldCallId: string): void;
-    setEnvironmentInfo(envInfo: EnvironmentInfo): void;
     setCallIsScreenSharingOn(callId: string, isScreenSharingOn: boolean): void;
     setCallRemoteParticipants(callId: string, addRemoteParticipant: RemoteParticipantState[], removeRemoteParticipant: string[]): void;
     setCallRemoteParticipantsEnded(callId: string, addRemoteParticipant: RemoteParticipantState[], removeRemoteParticipant: string[]): void;
     setCallLocalVideoStream(callId: string, streams: LocalVideoStreamState[]): void;
-    setCallLocalVideoStreamVideoEffects(callId: string, videoEffects: LocalVideoStreamVideoEffectsState): void;
     setCallIsMicrophoneMuted(callId: string, isMicrophoneMuted: boolean): void;
-    setRole(callId: string, role: ParticipantRole): void;
-    setTotalParticipantCount(callId: string, totalParticipantCount: number): void;
     setCallDominantSpeakers(callId: string, dominantSpeakers: DominantSpeakersInfo): void;
     setCallRecordingActive(callId: string, isRecordingActive: boolean): void;
     setCallTranscriptionActive(callId: string, isTranscriptionActive: boolean): void;
@@ -47,12 +39,10 @@ export declare class CallContext {
     setLocalVideoStreamRendererView(callId: string, view: VideoStreamRendererViewState | undefined): void;
     setParticipantState(callId: string, participantKey: string, state: RemoteParticipantStatus): void;
     setParticipantIsMuted(callId: string, participantKey: string, muted: boolean): void;
-    setParticipantRole(callId: string, participantKey: string, role: ParticipantRole): void;
     setParticipantDisplayName(callId: string, participantKey: string, displayName: string): void;
     setParticipantIsSpeaking(callId: string, participantKey: string, isSpeaking: boolean): void;
     setParticipantVideoStream(callId: string, participantKey: string, stream: RemoteVideoStreamState): void;
     setRemoteVideoStreamIsAvailable(callId: string, participantKey: string, streamId: number, isAvailable: boolean): void;
-    setRemoteVideoStreamIsReceiving(callId: string, participantKey: string, streamId: number, isReceiving: boolean): void;
     setRemoteVideoStreams(callId: string, participantKey: string, addRemoteVideoStream: RemoteVideoStreamState[], removeRemoteVideoStream: number[]): void;
     setRemoteVideoStreamRendererView(callId: string, participantKey: string, streamId: number, view: VideoStreamRendererViewState | undefined): void;
     setRemoteVideoStreamViewScalingMode(callId: string, participantKey: string, streamId: number, scalingMode: ScalingMode): void;
@@ -69,15 +59,7 @@ export declare class CallContext {
     setDeviceManagerDeviceAccess(deviceAccess: DeviceAccess): void;
     setDeviceManagerUnparentedView(localVideoStream: LocalVideoStreamState, view: VideoStreamRendererViewState | undefined): void;
     deleteDeviceManagerUnparentedView(localVideoStream: LocalVideoStreamState): void;
-    setDeviceManagerUnparentedViewVideoEffects(localVideoStream: LocalVideoStreamState, videoEffects: LocalVideoStreamVideoEffectsState): void;
     getAndIncrementAtomicId(): number;
-    private processNewCaption;
-    addCaption(callId: string, caption: TeamsCaptionsInfo): void;
-    setIsCaptionActive(callId: string, isCaptionsActive: boolean): void;
-    setSelectedSpokenLanguage(callId: string, spokenLanguage: string): void;
-    setSelectedCaptionLanguage(callId: string, captionLanguage: string): void;
-    setAvailableCaptionLanguages(callId: string, captionLanguages: string[]): void;
-    setAvailableSpokenLanguages(callId: string, spokenLanguages: string[]): void;
     /**
      * Tees any errors encountered in an async function to the state.
      *

package/dist/dist-esm/calling-stateful-client/src/CallContext.js

@@ -16,8 +16,6 @@ import { _safeJSONStringify, toFlatCommunicationIdentifier } from "../../acs-ui-
 import { CallError } from './CallClientState';
 import { callingStatefulLogger } from './Logger';
 import { CallIdHistory } from './CallIdHistory';
-/* @conditional-compile-remove(close-captions) */
-import { convertFromSDKToCaptionInfoState } from './Converter';
 enableMapSet();
 // Needed to generate state diff for verbose logging.
 enablePatches();
@@ -30,7 +28,7 @@ export const MAX_CALL_HISTORY_LENGTH = 10;
  * @private
  */
 export class CallContext {
-    constructor(userId, maxListeners = 50, /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId) {
+    constructor(userId, maxListeners = 50) {
         this._callIdHistory = new CallIdHistory();
         /**
          * Tees direct errors to state.
@@ -61,8 +59,6 @@ export class CallContext {
             },
             callAgent: undefined,
             userId: userId,
-            /* @conditional-compile-remove(unsupported-browser) */ environmentInfo: undefined,
-            /* @conditional-compile-remove(PSTN-calls) */ alternateCallerId: alternateCallerId,
             latestErrors: {}
         };
         this._emitter = new EventEmitter();
@@ -120,16 +116,7 @@ export class CallContext {
                 existingCall.localVideoStreams = call.localVideoStreams;
                 existingCall.remoteParticipants = call.remoteParticipants;
                 existingCall.transcription.isTranscriptionActive = call.transcription.isTranscriptionActive;
-                existingCall.recording.isRecordingActive = call.recording.isRecordingActive;
-                /* @conditional-compile-remove(rooms) */
-                existingCall.role = call.role;
-                /* @conditional-compile-remove(total-participant-count) */
-                existingCall.totalParticipantCount = call.totalParticipantCount;
-                // We don't update the startTime and endTime if we are updating an existing active call
-                /* @conditional-compile-remove(close-captions) */
-                existingCall.captionsFeature.currentSpokenLanguage = call.captionsFeature.currentSpokenLanguage;
-                /* @conditional-compile-remove(close-captions) */
-                existingCall.captionsFeature.currentCaptionLanguage = call.captionsFeature.currentCaptionLanguage;
+                existingCall.recording.isRecordingActive = call.recording.isRecordingActive; // We don't update the startTime and endTime if we are updating an existing active call
             }
             else {
                 draft.calls[latestCallId] = call;
@@ -177,12 +164,6 @@ export class CallContext {
             }
         });
     }
-    /* @conditional-compile-remove(unsupported-browser) */
-    setEnvironmentInfo(envInfo) {
-        this.modifyState((draft) => {
-            draft.environmentInfo = envInfo;
-        });
-    }
     setCallIsScreenSharingOn(callId, isScreenSharingOn) {
         this.modifyState((draft) => {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
@@ -225,19 +206,6 @@ export class CallContext {
             }
         });
     }
-    /* @conditional-compile-remove(video-background-effects) */
-    setCallLocalVideoStreamVideoEffects(callId, videoEffects) {
-        this.modifyState((draft) => {
-            var _a;
-            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
-            if (call) {
-                const stream = (_a = call.localVideoStreams) === null || _a === void 0 ? void 0 : _a.find(i => i.mediaStreamType === 'Video');
-                if (stream) {
-                    stream.videoEffects = videoEffects;
-                }
-            }
-        });
-    }
     setCallIsMicrophoneMuted(callId, isMicrophoneMuted) {
         this.modifyState((draft) => {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
@@ -246,24 +214,6 @@ export class CallContext {
             }
         });
     }
-    /* @conditional-compile-remove(rooms) */
-    setRole(callId, role) {
-        this.modifyState((draft) => {
-            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
-            if (call) {
-                call.role = role;
-            }
-        });
-    }
-    /* @conditional-compile-remove(total-participant-count) */
-    setTotalParticipantCount(callId, totalParticipantCount) {
-        this.modifyState((draft) => {
-            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
-            if (call) {
-                call.totalParticipantCount = totalParticipantCount;
-            }
-        });
-    }
     setCallDominantSpeakers(callId, dominantSpeakers) {
         this.modifyState((draft) => {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
@@ -328,18 +278,6 @@ export class CallContext {
             }
         });
     }
-    /* @conditional-compile-remove(rooms) */
-    setParticipantRole(callId, participantKey, role) {
-        this.modifyState((draft) => {
-            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
-            if (call) {
-                const participant = call.remoteParticipants[participantKey];
-                if (participant) {
-                    participant.role = role;
-                }
-            }
-        });
-    }
     setParticipantDisplayName(callId, participantKey, displayName) {
         this.modifyState((draft) => {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
@@ -373,8 +311,6 @@ export class CallContext {
                     const existingStream = participant.videoStreams[stream.id];
                     if (existingStream) {
                         existingStream.isAvailable = stream.isAvailable;
-                        /* @conditional-compile-remove(video-stream-is-receiving-flag) */
-                        existingStream.isReceiving = stream.isReceiving;
                         existingStream.mediaStreamType = stream.mediaStreamType;
                     }
                     else {
@@ -398,21 +334,6 @@ export class CallContext {
             }
         });
     }
-    /* @conditional-compile-remove(video-stream-is-receiving-flag) */
-    setRemoteVideoStreamIsReceiving(callId, participantKey, streamId, isReceiving) {
-        this.modifyState((draft) => {
-            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
-            if (call) {
-                const participant = call.remoteParticipants[participantKey];
-                if (participant) {
-                    const stream = participant.videoStreams[streamId];
-                    if (stream) {
-                        stream.isReceiving = isReceiving;
-                    }
-                }
-            }
-        });
-    }
     setRemoteVideoStreams(callId, participantKey, addRemoteVideoStream, removeRemoteVideoStream) {
         this.modifyState((draft) => {
             const call = draft.calls[this._callIdHistory.latestCallId(callId)];
@@ -429,8 +350,6 @@ export class CallContext {
                         if (stream) {
                             stream.mediaStreamType = newStream.mediaStreamType;
                             stream.isAvailable = newStream.isAvailable;
-                            /* @conditional-compile-remove(video-stream-is-receiving-flag) */
-                            stream.isReceiving = newStream.isReceiving;
                         }
                         else {
                             participant.videoStreams[newStream.id] = newStream;
@@ -565,90 +484,11 @@ export class CallContext {
             }
         });
     }
-    /* @conditional-compile-remove(video-background-effects) */
-    setDeviceManagerUnparentedViewVideoEffects(localVideoStream, videoEffects) {
-        this.modifyState((draft) => {
-            const foundIndex = draft.deviceManager.unparentedViews.findIndex(stream => stream.source.id === localVideoStream.source.id && stream.mediaStreamType === localVideoStream.mediaStreamType);
-            if (foundIndex !== -1) {
-                draft.deviceManager.unparentedViews[foundIndex].videoEffects = videoEffects;
-            }
-        });
-    }
     getAndIncrementAtomicId() {
         const id = this._atomicId;
         this._atomicId++;
         return id;
     }
-    /* @conditional-compile-remove(close-captions) */
-    processNewCaption(captions, newCaption) {
-        // going through current captions to find the last caption said by the same speaker, remove that caption if it's partial and replace with the new caption
-        for (let index = captions.length - 1; index >= 0; index--) {
-            const currentCaption = captions[index];
-            if (currentCaption && currentCaption.resultType !== 'Final' && currentCaption.speaker.identifier && newCaption.speaker.identifier && toFlatCommunicationIdentifier(currentCaption.speaker.identifier) === toFlatCommunicationIdentifier(newCaption.speaker.identifier)) {
-                captions.splice(index, 1);
-                break;
-            }
-        }
-        captions.push(newCaption);
-        // If the array length exceeds 50, remove the oldest caption
-        if (captions.length > 50) {
-            captions.shift();
-        }
-    }
-    /* @conditional-compile-remove(close-captions) */
-    addCaption(callId, caption) {
-        this.modifyState((draft) => {
-            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
-            if (call) {
-                this.processNewCaption(call.captionsFeature.captions, convertFromSDKToCaptionInfoState(caption));
-            }
-        });
-    }
-    /* @conditional-compile-remove(close-captions) */
-    setIsCaptionActive(callId, isCaptionsActive) {
-        this.modifyState((draft) => {
-            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
-            if (call) {
-                call.captionsFeature.isCaptionsFeatureActive = isCaptionsActive;
-            }
-        });
-    }
-    /* @conditional-compile-remove(close-captions) */
-    setSelectedSpokenLanguage(callId, spokenLanguage) {
-        this.modifyState((draft) => {
-            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
-            if (call) {
-                call.captionsFeature.currentSpokenLanguage = spokenLanguage;
-            }
-        });
-    }
-    /* @conditional-compile-remove(close-captions) */
-    setSelectedCaptionLanguage(callId, captionLanguage) {
-        this.modifyState((draft) => {
-            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
-            if (call) {
-                call.captionsFeature.currentCaptionLanguage = captionLanguage;
-            }
-        });
-    }
-    /* @conditional-compile-remove(close-captions) */
-    setAvailableCaptionLanguages(callId, captionLanguages) {
-        this.modifyState((draft) => {
-            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
-            if (call) {
-                call.captionsFeature.supportedCaptionLanguages = captionLanguages;
-            }
-        });
-    }
-    /* @conditional-compile-remove(close-captions) */
-    setAvailableSpokenLanguages(callId, spokenLanguages) {
-        this.modifyState((draft) => {
-            const call = draft.calls[this._callIdHistory.latestCallId(callId)];
-            if (call) {
-                call.captionsFeature.supportedSpokenLanguages = spokenLanguages;
-            }
-        });
-    }
     /**
      * Tees any errors encountered in an async function to the state.
      *