react-jssip-kit 1.0.0 → 1.0.1

package/dist/index.d.cts

@@ -1,10 +1,13 @@
 import { UA } from 'jssip';
 export { WebSocketInterface } from 'jssip';
 import * as jssip_src_RTCSession from 'jssip/src/RTCSession';
-import { RTCSessionEventMap, TerminateOptions, AnswerOptions, DTMFOptions, ReferOptions, RTCSession } from 'jssip/src/RTCSession';
-export { AnswerOptions, DTMFOptions, RTCSession, RTCSessionEventMap, ReferOptions, TerminateOptions } from 'jssip/src/RTCSession';
+import { RTCSessionEventMap, ExtraHeaders, TerminateOptions, AnswerOptions, DTMFOptions, ReferOptions, RenegotiateOptions, RTCSession } from 'jssip/src/RTCSession';
+export { AnswerOptions, DTMFOptions, ExtraHeaders, RTCSession, RTCSessionEventMap, ReferOptions, RenegotiateOptions, TerminateOptions } from 'jssip/src/RTCSession';
+import * as jssip_src_Message from 'jssip/src/Message';
+import { MessageEventMap, SendMessageOptions } from 'jssip/src/Message';
+export { SendMessageOptions } from 'jssip/src/Message';
 import * as jssip_src_UA from 'jssip/src/UA';
-import { UAEventMap, IncomingRTCSessionEvent, UAConfiguration, CallOptions, RTCSessionEvent } from 'jssip/src/UA';
+import { UAEventMap, UAConfiguration, CallOptions, RTCSessionEvent } from 'jssip/src/UA';
 export { CallOptions } from 'jssip/src/UA';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
@@ -40,17 +43,16 @@ interface SipState {
     sipStatus: SipStatus;
     error: string | null;
     sessions: SipSessionState[];
+}
+interface InternalSipState extends SipState {
     sessionsById: Record<string, SipSessionState>;
     sessionIds: string[];
 }
 
-type UAExtraEvents = {
-    missed: IncomingRTCSessionEvent;
-};
-type UAEventName = keyof UAEventMap | keyof UAExtraEvents;
+type UAEventName = keyof UAEventMap;
 type SessionEventName = keyof RTCSessionEventMap;
 type JsSIPEventName = UAEventName | SessionEventName;
-type UAEventPayload<K extends UAEventName> = K extends keyof UAEventMap ? Parameters<UAEventMap[K]>[0] : K extends keyof UAExtraEvents ? UAExtraEvents[K] : never;
+type UAEventPayload<K extends UAEventName> = Parameters<UAEventMap[K]>[0];
 type SessionEventPayload<K extends SessionEventName> = K extends keyof RTCSessionEventMap ? Parameters<RTCSessionEventMap[K]>[0] : never;
 type JsSIPEventPayload<K extends JsSIPEventName> = K extends UAEventName ? UAEventPayload<K> : K extends SessionEventName ? SessionEventPayload<K> : never;
 type JsSIPEventHandler<K extends JsSIPEventName> = (payload?: JsSIPEventPayload<K>) => void;
@@ -64,6 +66,10 @@ interface SipEventManager {
 type JsSIPEventMap = {
     [K in JsSIPEventName]: JsSIPEventPayload<K>;
 };
+type SipSendOptionsOptions = ExtraHeaders & {
+    contentType?: string;
+    eventHandlers?: Partial<MessageEventMap>;
+};
 type SipConfiguration = Omit<UAConfiguration, "password" | "uri"> & {
     debug?: boolean | string;
     enableMicRecovery?: boolean;
@@ -95,26 +101,32 @@ declare class SipUserAgent {
     private clearSessionFlag;
 }
 
-type Listener<T = any> = (payload: T) => void;
-declare class EventTargetEmitter<Events extends Record<string, any> = any> {
+type Listener<T = unknown> = (payload: T) => void;
+declare class EventTargetEmitter<Events extends Record<string, unknown> = Record<string, unknown>> {
     private target;
     on<K extends keyof Events>(event: K, fn: Listener<Events[K]>): () => void;
     emit<K extends keyof Events>(event: K, payload?: Events[K]): void;
 }
 
-type SipStateListener = (state: SipState) => void;
+type SipStateListener = (state: InternalSipState) => void;
+type PublicSipStateListener = (state: SipState) => void;
 declare class SipStateStore {
     private state;
     private lastState;
+    private publicState;
     private listeners;
+    private publicListeners;
     private pendingState;
     private updateScheduled;
-    getState(): SipState;
+    getState(): InternalSipState;
+    getPublicState(): SipState;
     onChange(fn: SipStateListener): () => void;
-    subscribe(fn: SipStateListener): () => void;
-    setState(partial: Partial<SipState>): void;
-    batchSet(partial: Partial<SipState>): void;
-    reset(overrides?: Partial<SipState>): void;
+    onPublicChange(fn: PublicSipStateListener): () => void;
+    subscribe(fn: PublicSipStateListener): () => void;
+    subscribeInternal(fn: SipStateListener): () => void;
+    setState(partial: Partial<InternalSipState>): void;
+    batchSet(partial: Partial<InternalSipState>): void;
+    reset(overrides?: Partial<InternalSipState>): void;
     private emit;
 }
 
@@ -141,6 +153,8 @@ declare class SipClient extends EventTargetEmitter<JsSIPEventMap> {
     registerUA(): void;
     disconnect(): void;
     call(target: string, callOptions?: CallOptions): void;
+    sendMessage(target: string, body: string, options?: SendMessageOptions): boolean;
+    sendOptions(target: string, body?: string, options?: SipSendOptionsOptions): boolean;
     hangupAll(options?: TerminateOptions): boolean;
     onChange(fn: (s: SipState) => void): () => void;
     setDebug(debug?: boolean | string): void;
@@ -152,6 +166,9 @@ declare class SipClient extends EventTargetEmitter<JsSIPEventMap> {
     toggleHoldSession(sessionId?: string): boolean;
     sendDTMFSession(sessionId: string, tones: string | number, options?: DTMFOptions): boolean;
     transferSession(sessionId: string, target: string, options?: ReferOptions): boolean;
+    sendInfoSession(sessionId: string, contentType: string, body?: string, options?: ExtraHeaders): boolean;
+    updateSession(sessionId: string, options?: RenegotiateOptions): boolean;
+    reinviteSession(sessionId: string, options?: RenegotiateOptions): boolean;
     setSessionMedia(sessionId: string, stream: MediaStream): void;
     getSession(sessionId: string): RTCSession | null;
     getSessionIds(): string[];
@@ -187,6 +204,8 @@ interface SipKernel {
         register: () => void;
         setDebug: (debug?: boolean | string) => void;
         call: (target: string, options?: CallOptions) => void;
+        sendMessage: (target: string, body: string, options?: SendMessageOptions) => boolean;
+        sendOptions: (target: string, body?: string, options?: SipSendOptionsOptions) => boolean;
         answer: (sessionId: string, options?: AnswerOptions) => boolean;
         hangup: (sessionId: string, options?: TerminateOptions) => boolean;
         hangupAll: (options?: TerminateOptions) => boolean;
@@ -194,6 +213,9 @@ interface SipKernel {
         toggleHold: (sessionId?: string) => boolean;
         sendDTMF: (sessionId: string, tones: string | number, options?: DTMFOptions) => boolean;
         transfer: (sessionId: string, target: string, options?: ReferOptions) => boolean;
+        sendInfo: (sessionId: string, contentType: string, body?: string, options?: ExtraHeaders) => boolean;
+        update: (sessionId: string, options?: RenegotiateOptions) => boolean;
+        reinvite: (sessionId: string, options?: RenegotiateOptions) => boolean;
         getSession: SipClient["getSession"];
         getSessionIds: SipClient["getSessionIds"];
         getSessions: SipClient["getSessions"];
@@ -217,6 +239,8 @@ declare function useSipActions(): {
     register: () => void;
     setDebug: (debug?: boolean | string) => void;
     call: (target: string, options?: jssip_src_UA.CallOptions) => void;
+    sendMessage: (target: string, body: string, options?: jssip_src_Message.SendMessageOptions) => boolean;
+    sendOptions: (target: string, body?: string, options?: SipSendOptionsOptions) => boolean;
     answer: (sessionId: string, options?: jssip_src_RTCSession.AnswerOptions) => boolean;
     hangup: (sessionId: string, options?: jssip_src_RTCSession.TerminateOptions) => boolean;
     hangupAll: (options?: jssip_src_RTCSession.TerminateOptions) => boolean;
@@ -224,6 +248,9 @@ declare function useSipActions(): {
     toggleHold: (sessionId?: string) => boolean;
     sendDTMF: (sessionId: string, tones: string | number, options?: jssip_src_RTCSession.DTMFOptions) => boolean;
     transfer: (sessionId: string, target: string, options?: jssip_src_RTCSession.ReferOptions) => boolean;
+    sendInfo: (sessionId: string, contentType: string, body?: string, options?: jssip_src_RTCSession.ExtraHeaders) => boolean;
+    update: (sessionId: string, options?: jssip_src_RTCSession.RenegotiateOptions) => boolean;
+    reinvite: (sessionId: string, options?: jssip_src_RTCSession.RenegotiateOptions) => boolean;
     getSession: (sessionId: string) => jssip_src_RTCSession.RTCSession | null;
     getSessionIds: () => string[];
     getSessions: () => {
@@ -239,8 +266,6 @@ type SipSelector<TSelected> = (state: SipState) => TSelected;
 type SipSelectorEqualityFn<TSelected> = (prev: TSelected, next: TSelected) => boolean;
 declare function useSipSelector<TSelected>(selector: SipSelector<TSelected>, equalityFn?: SipSelectorEqualityFn<TSelected>): TSelected;
 
-declare function useActiveSipSession(): SipSessionState | null;
-
 declare function useSipSession(sessionId?: string): SipSessionState | null;
 
 declare function useSipSessions(): Pick<SipState, "sessions">;
@@ -260,4 +285,4 @@ type SipProviderProps = {
 };
 declare function SipProvider(props: SipProviderProps): react_jsx_runtime.JSX.Element;
 
-export { type CallDirection, type CallDirection as CallDirectionType, CallPlayer, CallStatus, CallStatus as CallStatusType, type JsSIPEventMap, type JsSIPEventName, type SessionEventName, type SessionEventPayload, type SipConfiguration, type SipEventHandlers, type SipEventManager, type SipKernel, SipProvider, type SipProviderProps, type SipSessionState, type SipState, SipStatus, SipStatus as SipStatusType, type UAEventName, type UAEventPayload, createSipClientInstance, createSipEventManager, createSipKernel, useActiveSipSession, useSessionMedia, useSipActions, useSipEvent, useSipKernel, useSipSelector, useSipSession, useSipSessionEvent, useSipSessions, useSipState };
+export { type CallDirection, type CallDirection as CallDirectionType, CallPlayer, CallStatus, CallStatus as CallStatusType, type JsSIPEventMap, type JsSIPEventName, type SessionEventName, type SessionEventPayload, type SipConfiguration, type SipEventHandlers, type SipEventManager, type SipKernel, SipProvider, type SipProviderProps, type SipSendOptionsOptions, type SipSessionState, type SipState, SipStatus, SipStatus as SipStatusType, type UAEventName, type UAEventPayload, createSipClientInstance, createSipEventManager, createSipKernel, useSessionMedia, useSipActions, useSipEvent, useSipKernel, useSipSelector, useSipSession, useSipSessionEvent, useSipSessions, useSipState };

package/dist/index.d.ts

@@ -1,10 +1,13 @@
 import { UA } from 'jssip';
 export { WebSocketInterface } from 'jssip';
 import * as jssip_src_RTCSession from 'jssip/src/RTCSession';
-import { RTCSessionEventMap, TerminateOptions, AnswerOptions, DTMFOptions, ReferOptions, RTCSession } from 'jssip/src/RTCSession';
-export { AnswerOptions, DTMFOptions, RTCSession, RTCSessionEventMap, ReferOptions, TerminateOptions } from 'jssip/src/RTCSession';
+import { RTCSessionEventMap, ExtraHeaders, TerminateOptions, AnswerOptions, DTMFOptions, ReferOptions, RenegotiateOptions, RTCSession } from 'jssip/src/RTCSession';
+export { AnswerOptions, DTMFOptions, ExtraHeaders, RTCSession, RTCSessionEventMap, ReferOptions, RenegotiateOptions, TerminateOptions } from 'jssip/src/RTCSession';
+import * as jssip_src_Message from 'jssip/src/Message';
+import { MessageEventMap, SendMessageOptions } from 'jssip/src/Message';
+export { SendMessageOptions } from 'jssip/src/Message';
 import * as jssip_src_UA from 'jssip/src/UA';
-import { UAEventMap, IncomingRTCSessionEvent, UAConfiguration, CallOptions, RTCSessionEvent } from 'jssip/src/UA';
+import { UAEventMap, UAConfiguration, CallOptions, RTCSessionEvent } from 'jssip/src/UA';
 export { CallOptions } from 'jssip/src/UA';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
@@ -40,17 +43,16 @@ interface SipState {
     sipStatus: SipStatus;
     error: string | null;
     sessions: SipSessionState[];
+}
+interface InternalSipState extends SipState {
     sessionsById: Record<string, SipSessionState>;
     sessionIds: string[];
 }
 
-type UAExtraEvents = {
-    missed: IncomingRTCSessionEvent;
-};
-type UAEventName = keyof UAEventMap | keyof UAExtraEvents;
+type UAEventName = keyof UAEventMap;
 type SessionEventName = keyof RTCSessionEventMap;
 type JsSIPEventName = UAEventName | SessionEventName;
-type UAEventPayload<K extends UAEventName> = K extends keyof UAEventMap ? Parameters<UAEventMap[K]>[0] : K extends keyof UAExtraEvents ? UAExtraEvents[K] : never;
+type UAEventPayload<K extends UAEventName> = Parameters<UAEventMap[K]>[0];
 type SessionEventPayload<K extends SessionEventName> = K extends keyof RTCSessionEventMap ? Parameters<RTCSessionEventMap[K]>[0] : never;
 type JsSIPEventPayload<K extends JsSIPEventName> = K extends UAEventName ? UAEventPayload<K> : K extends SessionEventName ? SessionEventPayload<K> : never;
 type JsSIPEventHandler<K extends JsSIPEventName> = (payload?: JsSIPEventPayload<K>) => void;
@@ -64,6 +66,10 @@ interface SipEventManager {
 type JsSIPEventMap = {
     [K in JsSIPEventName]: JsSIPEventPayload<K>;
 };
+type SipSendOptionsOptions = ExtraHeaders & {
+    contentType?: string;
+    eventHandlers?: Partial<MessageEventMap>;
+};
 type SipConfiguration = Omit<UAConfiguration, "password" | "uri"> & {
     debug?: boolean | string;
     enableMicRecovery?: boolean;
@@ -95,26 +101,32 @@ declare class SipUserAgent {
     private clearSessionFlag;
 }
 
-type Listener<T = any> = (payload: T) => void;
-declare class EventTargetEmitter<Events extends Record<string, any> = any> {
+type Listener<T = unknown> = (payload: T) => void;
+declare class EventTargetEmitter<Events extends Record<string, unknown> = Record<string, unknown>> {
     private target;
     on<K extends keyof Events>(event: K, fn: Listener<Events[K]>): () => void;
     emit<K extends keyof Events>(event: K, payload?: Events[K]): void;
 }
 
-type SipStateListener = (state: SipState) => void;
+type SipStateListener = (state: InternalSipState) => void;
+type PublicSipStateListener = (state: SipState) => void;
 declare class SipStateStore {
     private state;
     private lastState;
+    private publicState;
     private listeners;
+    private publicListeners;
     private pendingState;
     private updateScheduled;
-    getState(): SipState;
+    getState(): InternalSipState;
+    getPublicState(): SipState;
     onChange(fn: SipStateListener): () => void;
-    subscribe(fn: SipStateListener): () => void;
-    setState(partial: Partial<SipState>): void;
-    batchSet(partial: Partial<SipState>): void;
-    reset(overrides?: Partial<SipState>): void;
+    onPublicChange(fn: PublicSipStateListener): () => void;
+    subscribe(fn: PublicSipStateListener): () => void;
+    subscribeInternal(fn: SipStateListener): () => void;
+    setState(partial: Partial<InternalSipState>): void;
+    batchSet(partial: Partial<InternalSipState>): void;
+    reset(overrides?: Partial<InternalSipState>): void;
     private emit;
 }
 
@@ -141,6 +153,8 @@ declare class SipClient extends EventTargetEmitter<JsSIPEventMap> {
     registerUA(): void;
     disconnect(): void;
     call(target: string, callOptions?: CallOptions): void;
+    sendMessage(target: string, body: string, options?: SendMessageOptions): boolean;
+    sendOptions(target: string, body?: string, options?: SipSendOptionsOptions): boolean;
     hangupAll(options?: TerminateOptions): boolean;
     onChange(fn: (s: SipState) => void): () => void;
     setDebug(debug?: boolean | string): void;
@@ -152,6 +166,9 @@ declare class SipClient extends EventTargetEmitter<JsSIPEventMap> {
     toggleHoldSession(sessionId?: string): boolean;
     sendDTMFSession(sessionId: string, tones: string | number, options?: DTMFOptions): boolean;
     transferSession(sessionId: string, target: string, options?: ReferOptions): boolean;
+    sendInfoSession(sessionId: string, contentType: string, body?: string, options?: ExtraHeaders): boolean;
+    updateSession(sessionId: string, options?: RenegotiateOptions): boolean;
+    reinviteSession(sessionId: string, options?: RenegotiateOptions): boolean;
     setSessionMedia(sessionId: string, stream: MediaStream): void;
     getSession(sessionId: string): RTCSession | null;
     getSessionIds(): string[];
@@ -187,6 +204,8 @@ interface SipKernel {
         register: () => void;
         setDebug: (debug?: boolean | string) => void;
         call: (target: string, options?: CallOptions) => void;
+        sendMessage: (target: string, body: string, options?: SendMessageOptions) => boolean;
+        sendOptions: (target: string, body?: string, options?: SipSendOptionsOptions) => boolean;
         answer: (sessionId: string, options?: AnswerOptions) => boolean;
         hangup: (sessionId: string, options?: TerminateOptions) => boolean;
         hangupAll: (options?: TerminateOptions) => boolean;
@@ -194,6 +213,9 @@ interface SipKernel {
         toggleHold: (sessionId?: string) => boolean;
         sendDTMF: (sessionId: string, tones: string | number, options?: DTMFOptions) => boolean;
         transfer: (sessionId: string, target: string, options?: ReferOptions) => boolean;
+        sendInfo: (sessionId: string, contentType: string, body?: string, options?: ExtraHeaders) => boolean;
+        update: (sessionId: string, options?: RenegotiateOptions) => boolean;
+        reinvite: (sessionId: string, options?: RenegotiateOptions) => boolean;
         getSession: SipClient["getSession"];
         getSessionIds: SipClient["getSessionIds"];
         getSessions: SipClient["getSessions"];
@@ -217,6 +239,8 @@ declare function useSipActions(): {
     register: () => void;
     setDebug: (debug?: boolean | string) => void;
     call: (target: string, options?: jssip_src_UA.CallOptions) => void;
+    sendMessage: (target: string, body: string, options?: jssip_src_Message.SendMessageOptions) => boolean;
+    sendOptions: (target: string, body?: string, options?: SipSendOptionsOptions) => boolean;
     answer: (sessionId: string, options?: jssip_src_RTCSession.AnswerOptions) => boolean;
     hangup: (sessionId: string, options?: jssip_src_RTCSession.TerminateOptions) => boolean;
     hangupAll: (options?: jssip_src_RTCSession.TerminateOptions) => boolean;
@@ -224,6 +248,9 @@ declare function useSipActions(): {
     toggleHold: (sessionId?: string) => boolean;
     sendDTMF: (sessionId: string, tones: string | number, options?: jssip_src_RTCSession.DTMFOptions) => boolean;
     transfer: (sessionId: string, target: string, options?: jssip_src_RTCSession.ReferOptions) => boolean;
+    sendInfo: (sessionId: string, contentType: string, body?: string, options?: jssip_src_RTCSession.ExtraHeaders) => boolean;
+    update: (sessionId: string, options?: jssip_src_RTCSession.RenegotiateOptions) => boolean;
+    reinvite: (sessionId: string, options?: jssip_src_RTCSession.RenegotiateOptions) => boolean;
     getSession: (sessionId: string) => jssip_src_RTCSession.RTCSession | null;
     getSessionIds: () => string[];
     getSessions: () => {
@@ -239,8 +266,6 @@ type SipSelector<TSelected> = (state: SipState) => TSelected;
 type SipSelectorEqualityFn<TSelected> = (prev: TSelected, next: TSelected) => boolean;
 declare function useSipSelector<TSelected>(selector: SipSelector<TSelected>, equalityFn?: SipSelectorEqualityFn<TSelected>): TSelected;
 
-declare function useActiveSipSession(): SipSessionState | null;
-
 declare function useSipSession(sessionId?: string): SipSessionState | null;
 
 declare function useSipSessions(): Pick<SipState, "sessions">;
@@ -260,4 +285,4 @@ type SipProviderProps = {
 };
 declare function SipProvider(props: SipProviderProps): react_jsx_runtime.JSX.Element;
 
-export { type CallDirection, type CallDirection as CallDirectionType, CallPlayer, CallStatus, CallStatus as CallStatusType, type JsSIPEventMap, type JsSIPEventName, type SessionEventName, type SessionEventPayload, type SipConfiguration, type SipEventHandlers, type SipEventManager, type SipKernel, SipProvider, type SipProviderProps, type SipSessionState, type SipState, SipStatus, SipStatus as SipStatusType, type UAEventName, type UAEventPayload, createSipClientInstance, createSipEventManager, createSipKernel, useActiveSipSession, useSessionMedia, useSipActions, useSipEvent, useSipKernel, useSipSelector, useSipSession, useSipSessionEvent, useSipSessions, useSipState };
+export { type CallDirection, type CallDirection as CallDirectionType, CallPlayer, CallStatus, CallStatus as CallStatusType, type JsSIPEventMap, type JsSIPEventName, type SessionEventName, type SessionEventPayload, type SipConfiguration, type SipEventHandlers, type SipEventManager, type SipKernel, SipProvider, type SipProviderProps, type SipSendOptionsOptions, type SipSessionState, type SipState, SipStatus, SipStatus as SipStatusType, type UAEventName, type UAEventPayload, createSipClientInstance, createSipEventManager, createSipKernel, useSessionMedia, useSipActions, useSipEvent, useSipKernel, useSipSelector, useSipSession, useSipSessionEvent, useSipSessions, useSipState };