opensips-js 0.1.47 → 0.1.48

package/dist/index.d.ts

@@ -370,7 +370,7 @@ declare type changeActiveCallsListener = (event: { [key: string]: ICall }) => vo
 
 declare type changeActiveInputMediaDeviceListener = (event: string) => void
 
-declare type changeActiveMessagesListener = (event: { [key: string]: IMessage }) => void
+declare type changeActiveMessagesListener = (event: { [key: string]: IMessage_2 }) => void
 
 declare type changeActiveOutputMediaDeviceListener = (event: string) => void
 
@@ -394,7 +394,7 @@ declare type changeIsDNDListener = (value: boolean) => void
 
 declare type changeIsMutedListener = (value: boolean) => void
 
-declare type changeMsrpSessionListener = (session: IMessage | null) => void
+declare type changeMsrpSessionListener = (session: IMessage_2 | null) => void
 
 declare type changeMuteWhenJoinListener = (value: boolean) => void
 
@@ -402,7 +402,7 @@ declare type changeNoiseReductionStateListener = (event: boolean) => void
 
 declare type changeVideoStateListener = (state: boolean) => void
 
-declare type ChangeVolumeEventType = {
+export declare type ChangeVolumeEventType = {
     callId: string
     volume: number
 }
@@ -417,7 +417,7 @@ declare type connectionListener = (value: boolean) => void
 
 declare type connectionStateChangeListener = (event: ConnectionStateChangeType) => void
 
-declare type ConnectionStateChangeType = {
+export declare type ConnectionStateChangeType = {
     session: RTCSessionExtended,
     connectionState: string
 }
@@ -430,7 +430,7 @@ declare interface ConnectOptions {
     pcConfig?: object;
 }
 
-declare interface CustomLoggerType {
+export declare interface CustomLoggerType {
     log: CommonLogMethodType
     warn: CommonLogMethodType
     error: CommonLogMethodType
@@ -451,7 +451,7 @@ declare type ExactConstraints_2 = {
     video?: boolean;
 }
 
-declare interface ICall extends RTCSessionExtended {
+export declare interface ICall extends RTCSessionExtended {
     roomId?: number
     localMuted?: boolean
     localHold?: boolean
@@ -460,14 +460,14 @@ declare interface ICall extends RTCSessionExtended {
     putOnHoldTimestamp?: number
 }
 
-declare interface ICallStatus {
+export declare interface ICallStatus {
     isMoving: boolean
     isTransferring: boolean
     isMerging: boolean
     isTransferred: boolean
 }
 
-declare interface IMessage extends MSRPSessionExtended {
+export declare interface IMessage extends MSRPSessionExtended {
     roomId?: number
     localMuted?: boolean
     localHold?: boolean
@@ -475,6 +475,14 @@ declare interface IMessage extends MSRPSessionExtended {
     terminate(): void
 }
 
+declare interface IMessage_2 extends MSRPSessionExtended_2 {
+    roomId?: number
+    localMuted?: boolean
+    localHold?: boolean
+    audioTag?: StreamMediaType_2
+    terminate(): void
+}
+
 declare interface IncomingMSRPSessionEvent {
     originator: Originator.REMOTE;
     session: MSRPSession;
@@ -483,9 +491,9 @@ declare interface IncomingMSRPSessionEvent {
 
 declare type IncomingMSRPSessionListener = (event: IncomingMSRPSessionEvent) => void;
 
-declare type IOpenSIPSConfiguration = Omit<UAConfigurationExtended, 'sockets'>
+export declare type IOpenSIPSConfiguration = Omit<UAConfigurationExtended, 'sockets'>
 
-declare interface IOpenSIPSJSOptions {
+export declare interface IOpenSIPSJSOptions {
     configuration: IOpenSIPSConfiguration
     socketInterfaces: [ string ]
     sipDomain: string
@@ -500,7 +508,7 @@ declare interface IOpenSIPSJSOptions {
     msrpWs?: boolean
 }
 
-declare interface IRoom {
+export declare interface IRoom {
     started: Date
     incomingInProgress: boolean
     roomId: number
@@ -510,7 +518,7 @@ declare type IRoomUpdate = Omit<IRoom, 'started'> & {
     started?: Date
 }
 
-declare interface ITimeData {
+export declare interface ITimeData {
     callId: string
     hours: number
     minutes: number
@@ -562,9 +570,11 @@ declare type Listener_2 = (event: unknown) => void
 
 declare type Listener_3 = (event: unknown) => void
 
-declare type ListenerCallbackFnType<T extends ListenersKeyType> = OpenSIPSEventMap[T]
+export declare type ListenerCallbackFnType<T extends ListenersKeyType> = OpenSIPSEventMap[T]
+
+export declare type ListenerEventType = EndEvent | IncomingEvent | OutgoingEvent | IncomingAckEvent | OutgoingAckEvent
 
-declare type ListenerEventType = EndEvent | IncomingEvent | OutgoingEvent | IncomingAckEvent | OutgoingAckEvent
+declare type ListenerEventType_2 = EndEvent | IncomingEvent | OutgoingEvent | IncomingAckEvent | OutgoingAckEvent
 
 declare type ListenersKeyType = keyof OpenSIPSEventMap
 
@@ -589,51 +599,72 @@ declare const MODULES: {
 
 declare type Modules = AudioModuleName | VideoModuleName | MSRPModuleName
 
+export declare const MSRP_EVT: {
+    readonly CREATE: "m.conversation.create";
+    readonly MESSAGE: "m.conversation.message";
+    readonly MEMBER: "m.conversation.member";
+    readonly CLOSED: "m.conversation.closed";
+    readonly SYNC: "m.sync";
+    readonly UPLOAD_REQUEST: "m.upload.request";
+    readonly UPLOAD_RESPONSE: "m.upload.response";
+    readonly FILE_ACCESS_REQUEST: "m.file.access.request";
+    readonly FILE_ACCESS_RESPONSE: "m.file.access.response";
+    readonly REACTION: "m.reaction";
+    readonly TYPING: "m.typing";
+    readonly SENT: "m.sent";
+    readonly DELIVERED: "m.delivered";
+    readonly READ: "m.read";
+    readonly FAILED: "m.failed";
+    readonly SENDING: "m.sending";
+};
+
 declare type msrpConversationCreatedListener = (payload: {
     conversationKey: string
-    conversation: MSRPConversationState
+    conversation: MSRPConversationState_2
 }) => void
 
 declare type msrpConversationRemovedListener = (payload: { conversationKey: string }) => void
 
-/**
- * Protocol-level conversation state owned by MSRPModule.
- *
- * Intentionally does NOT carry a `messages` array - the module is a pure
- * pipe for chat history. Live messages are emitted via `msrpMessageAdded`
- * and historical messages from `m.sync` come through the
- * `messagesByConversation` field of the `msrpSyncCompleted` payload.
- * The consumer (e.g. a Vue composable) is responsible for collecting them
- * into whatever data structure it needs and for downstream concerns like
- * deduplication, reaction aggregation and receipt application.
- */
-declare interface MSRPConversationState {
-    conversationKey: string;
-    creator: string | null;
-    members: Set<string>;
-    memberRoles: Map<string, MSRPMemberRole>;
-    currentUserRole: MSRPMemberRole;
-    currentUserStatus: MSRPMembership | null;
-    state_events: {
-        [key: string]: {
-            [stateKey: string]: any;
-        };
-    };
-    created_at: number;
-    updated_at: number;
-    status?: string;
+export declare interface MSRPConversationState {
+    conversationKey: string
+    creator: string | null
+    members: Set<string>
+    memberRoles: Map<string, MSRPMemberRole>
+    currentUserRole: MSRPMemberRole
+    currentUserStatus: MSRPMembership | null
+    state_events: { [key: string]: { [stateKey: string]: any } }
+    created_at: number
+    updated_at: number
+    status?: string
+}
+
+declare interface MSRPConversationState_2 {
+    conversationKey: string
+    creator: string | null
+    members: Set<string>
+    memberRoles: Map<string, MSRPMemberRole_2>
+    currentUserRole: MSRPMemberRole_2
+    currentUserStatus: MSRPMembership_2 | null
+    state_events: { [key: string]: { [stateKey: string]: any } }
+    created_at: number
+    updated_at: number
+    status?: string
 }
 
 declare type msrpConversationUpdatedListener = (payload: {
     conversationKey: string
-    patch: Partial<MSRPConversationState>
+    patch: Partial<MSRPConversationState_2>
 }) => void
 
 declare type MSRPInitializingListener = (sessionId: string | undefined) => void
 
-declare type MSRPMemberRole = 'in_charge' | 'manager' | 'assigned';
+export declare type MSRPMemberRole = 'in_charge' | 'manager' | 'assigned'
 
-declare type MSRPMembership = 'join' | 'leave' | 'invite' | 'ban';
+declare type MSRPMemberRole_2 = 'in_charge' | 'manager' | 'assigned'
+
+export declare type MSRPMembership = 'join' | 'leave' | 'invite' | 'ban'
+
+declare type MSRPMembership_2 = 'join' | 'leave' | 'invite' | 'ban'
 
 declare class MSRPMessage {
     protocol: string
@@ -655,14 +686,16 @@ declare type msrpMessageAddedListener = (payload: {
     message: any
 }) => void
 
-declare type MSRPMessageEventType = {
+export declare type MSRPMessageEventType = {
     message: MSRPMessage,
-    session: MSRPSessionExtended
+    session: MSRPSessionExtended_2
 }
 
 declare type MSRPMessageListener = (event: MSRPMessageEventType) => void;
 
-declare type MSRPMessageStatus = 'pending' | 'sent' | 'delivered' | 'read' | 'failed';
+export declare type MSRPMessageStatus = 'pending' | 'sent' | 'delivered' | 'read' | 'failed'
+
+declare type MSRPMessageStatus_2 = 'pending' | 'sent' | 'delivered' | 'read' | 'failed'
 
 declare class MSRPModule {
     private context;
@@ -695,32 +728,13 @@ declare class MSRPModule {
     private newMSRPSessionCallback;
     private setIsMSRPInitializing;
     private getUserUri;
-    /**
-     * Open an MSRP session for the currently logged-in user. The SIP
-     * identity is resolved automatically from the OpenSIPSJS
-     * configuration, so the caller never has to pass it. Use this when
-     * the session is intended to act as a long-lived transport pipe and
-     * the first payload will be sent later through one of the higher-level
-     * actions (e.g. `sendCreateConversationMessage`).
-     */
     initMSRP(options?: any): void;
-    /**
-     * Open an MSRP session and push `body` as the first MSRP frame the
-     * moment the session goes active. Use this for the legacy
-     * "compose-and-send" flow where the first message is known at the
-     * time the session is opened.
-     */
     initMSRPAndSendMessage(target: string, body: string, options?: any): void;
-    /**
-     * Public raw send - kept for backward-compat with the old multi-session API.
-     * Ignores the passed callId/sessionId because we only ever hold one session.
-     */
     sendMSRP(_msrpSessionId: string, body: string): void;
     /**
      * Safe wrapper around session.sendMSRP. Returns true when the message was
      * handed off to the session; false when there is no active session or the
-     * underlying send threw. On failure the stored session is cleared so the
-     * next send attempt does not silently drop traffic on a half-dead session.
+     * underlying send threw.
      */
     safeSendMSRP(body: string): boolean;
     private buildCreateConversationEvent;
@@ -731,30 +745,13 @@ declare class MSRPModule {
     private buildReactionEvent;
     private buildTypingEvent;
     private buildReadReceiptEvent;
-    /**
-     * Create a new conversation by inviting one or more SIP URIs.
-     * Accepts plain numbers/usernames and rewrites them into full SIP URIs
-     * against the domain OpenSIPSJS was initialized with.
-     */
     sendCreateConversationMessage(targetSip: string | string[]): boolean;
     sendTextMessage(conversationKey: string, text: string): boolean;
     sendMediaMessage(conversationKey: string, uploadResult: MSRPUploadResult, caption?: string): boolean;
     sendReaction(conversationKey: string, targetEventId: string, emoji: string): boolean;
     sendTypingIndicator(conversationKey: string, isTyping: boolean): boolean;
-    /**
-     * Start an automatic typing keep-alive loop for `conversationKey`. While
-     * active, a typing=true event is re-sent every `typingKeepAliveIntervalMs`
-     * so the remote side does not time out the indicator. Calling this with a
-     * different conversationKey or calling `stopTypingKeepAlive()` cancels
-     * any in-flight loop.
-     */
     startTypingKeepAlive(conversationKey: string): void;
     stopTypingKeepAlive(sendStop?: boolean): void;
-    /**
-     * Send a read receipt for `lastEventId` in `conversationKey`. The
-     * caller is responsible for resolving which event_id represents the
-     * "last seen" message because the module no longer stores chat history.
-     */
     sendReadReceipt(conversationKey: string, lastEventId: string): boolean;
     /**
      * Close a conversation. Only callers with role 'in_charge' or 'manager'
@@ -786,11 +783,6 @@ declare class MSRPModule {
      * send the resulting media message into the conversation in one go.
      */
     uploadFile(conversationKey: string, file: File, caption?: string): Promise<MSRPUploadResult>;
-    /**
-     * Parse a raw MSRP `newMessage` payload and dispatch it to the right
-     * conversation-state mutator. Outgoing messages and non-JSON payloads
-     * are ignored so the rest of the pipeline stays pure.
-     */
     private processIncomingMSRPMessage;
     private handleIncomingEvent;
     private handleIncomingSync;
@@ -804,34 +796,11 @@ declare class MSRPModule {
     private handleIncomingUploadResponse;
     private handleIncomingFileAccessResponse;
     private upsertConversationState;
-    /**
-     * Make a shallow snapshot of a conversation that is safe to hand off
-     * to an external consumer (e.g. a Vue composable).
-     *
-     * The mutable top-level collections (members, memberRoles,
-     * state_events) are cloned so subsequent internal mutations by the
-     * module cannot leak into the consumer's state. There is no
-     * `messages` field - chat history is owned by the consumer.
-     */
     private snapshotConversation;
-    /**
-     * Snapshot the whole conversations map - used only for the bulk
-     * `msrpSyncCompleted` emit.
-     */
     private snapshotConversationsMap;
     isConversationClosed(conversation: MSRPConversationState | undefined | null): boolean;
-    /**
-     * Extract the conversationKey from either a string or an event/conversation object.
-     */
     private conversationKeyOf;
-    /**
-     * Extract the user-part of a SIP URI, e.g. sip:103@example.com -> 103.
-     */
     extractSipUser(sipUri: string | null | undefined): string | null;
-    /**
-     * Best-effort human-readable name for any URI we may encounter
-     * (SIP / WhatsApp / SMS / GreenAPI).
-     */
     extractDisplayName(uri: string | null | undefined): string;
 }
 
@@ -863,7 +832,7 @@ declare type msrpReactionChangedListener = (payload: {
 declare type msrpReceiptChangedListener = (payload: {
     conversationKey: string
     eventId: string
-    status: MSRPMessageStatus
+    status: MSRPMessageStatus_2
     updatedAt: number
 }) => void
 
@@ -1011,7 +980,30 @@ declare interface MSRPSessionEventMap_2 {
     'peerconnection:setremotedescriptionfailed': Listener_3;
 }
 
-declare interface MSRPSessionExtended extends MSRPSession_2 {
+export declare interface MSRPSessionExtended extends MSRPSession_2 {
+    id: string
+    status: string
+    start_time: Date
+    direction: SessionDirection
+    _id: string
+    _cancel_reason: string
+    _contact: string
+    _end_time: Date
+    _eventsCount: number
+    _from_tag: string
+    _is_canceled: boolean
+    _is_confirmed: boolean
+    _late_sdp: string
+    _status: number
+    _remote_identity: string
+    target_addr: Array<string>
+    answer(options?: any): void
+    _init_incomeing(): void
+    sendMSRP(body: string): void
+    on<T extends keyof MSRPSessionEventMap_2>(type: T, listener: MSRPSessionEventMap_2[T]): this;
+}
+
+declare interface MSRPSessionExtended_2 extends MSRPSession_2 {
     id: string
     status: string
     start_time: Date
@@ -1037,7 +1029,7 @@ declare interface MSRPSessionExtended extends MSRPSession_2 {
 declare type MSRPSessionListener = IncomingMSRPSessionListener | OutgoingMSRPSessionListener;
 
 declare type msrpSyncCompletedListener = (payload: {
-    conversations: { [key: string]: MSRPConversationState }
+    conversations: { [key: string]: MSRPConversationState_2 }
     messagesByConversation: { [key: string]: any[] }
 }) => void
 
@@ -1047,21 +1039,21 @@ declare type msrpTypingListener = (payload: {
     isTyping: boolean
 }) => void
 
-declare interface MSRPUploadResult {
-    upload_url: string;
-    expires_in?: number;
-    mime_type: string;
-    request_id: string;
-    filename?: string;
-    preview_url?: string;
-    icon_url?: string;
-    transcription?: string;
-    media_type?: string;
+export declare interface MSRPUploadResult {
+    upload_url: string
+    expires_in?: number
+    mime_type: string
+    request_id: string
+    filename?: string
+    preview_url?: string
+    icon_url?: string
+    transcription?: string
+    media_type?: string
 }
 
-declare type NoiseReductionMode = 'disabled' | 'enabled' | 'dynamic'
+export declare type NoiseReductionMode = 'disabled' | 'enabled' | 'dynamic'
 
-declare interface NoiseReductionOptions {
+export declare interface NoiseReductionOptions {
     mode: NoiseReductionMode,
     vadModule?: VADModule
     vadConfig?: Partial<VADOptions>
@@ -1082,11 +1074,11 @@ declare interface NoiseReductionOptions {
     onnxWASMBasePath?: string
 }
 
-declare type NoiseReductionOptionsWithoutVadModule = Omit<NoiseReductionOptions, 'vadModule'>
+export declare type NoiseReductionOptionsWithoutVadModule = Omit<NoiseReductionOptions, 'vadModule'>
 
 declare type OnTransportCallback = (parsed: object, message: string) => void
 
-declare interface OpenSIPSEventMap extends UAEventMap {
+export declare interface OpenSIPSEventMap extends UAEventMap {
     ready: readyListener
     connection: connectionListener
     reconnecting: reconnectionListener
@@ -1118,7 +1110,7 @@ declare interface OpenSIPSEventMap extends UAEventMap {
     connectionStateChange: connectionStateChangeListener
     newMSRPMessage: MSRPMessageListener
     newMSRPSession: MSRPSessionListener
-    // MSRP - granular conversation events
+    // MSRP events listeners
     changeMsrpSession: changeMsrpSessionListener
     msrpSyncCompleted: msrpSyncCompletedListener
     msrpConversationCreated: msrpConversationCreatedListener
@@ -1273,11 +1265,22 @@ declare interface StreamMediaType extends HTMLAudioElement {
     setSinkId (id: string): Promise<void>
 }
 
+declare interface StreamMediaType_2 extends HTMLAudioElement {
+    className: string
+    setSinkId (id: string): Promise<void>
+}
+
 declare type TestEventListener = (event: { test: string }) => void
 
 declare interface TriggerListenerOptions {
     listenerType: string
     session: RTCSessionExtended
+    event?:  ListenerEventType_2
+}
+
+export declare interface TriggerMSRPListenerOptions {
+    listenerType: string
+    session: MSRPSessionExtended
     event?:  ListenerEventType
 }
 
@@ -1411,7 +1414,7 @@ declare class VideoModule {
 
 declare type VideoModuleName = typeof MODULES.VIDEO
 
-declare interface WebrtcMetricsConfigType {
+export declare interface WebrtcMetricsConfigType {
     refreshEvery?: number
     startAfter?: number
     stopAfter?: number