react-sip-kit 0.5.20 → 0.5.21

package/dist/manager.d.ts

@@ -3,11 +3,17 @@ import { SipManagerConfig } from './types';
 export declare class SipManager {
     private instances;
     /**
-     * Create and initialize a SIP session for an account
+     * Create and initialize a SIP session for an account.
+     *
+     * @param {SipManagerConfig} config - SIP account configuration (account, transport, registration, etc.)
+     * @returns {Promise<void>} Resolves when initialization is complete.
      */
     add(config: SipManagerConfig): Promise<void>;
     /**
-     * Get an existing SIP methods by username
+     * Get session methods (dial, answer, hold, etc.) for a given username.
+     *
+     * @param {string} username - The SIP account username.
+     * @returns {ReturnType<typeof sessionMethods>} Object containing call/session methods.
      */
     methods(username: string): {
         receiveSession: (invitation: import("./store/types").SipInvitationType) => void;
@@ -19,44 +25,77 @@ export declare class SipManager {
         toggleShareScreen: (lineNumber: LineType["lineNumber"]) => Promise<void>;
         rejectSession: (lineNumber: LineType["lineNumber"]) => void;
         dialByNumber: (type: Extract<import("./types").CallType, "audio" | "video">, dialNumber: string, extraHeaders?: Array<string>) => void;
-        makeConferenceSession: (lineObj: LineType, extraHeaders?: Array<string>) => void;
         endSession: (lineNumber: LineType["lineNumber"]) => void;
         recordSession: (lineNumber: LineType["lineNumber"]) => {
             start: () => Promise<void>;
             stop: () => void;
         };
         toggleMuteSession: (lineNumber: LineType["lineNumber"]) => void;
-        toggleHoldSession: (lineNumber: LineType["lineNumber"], forcedValue?: boolean) => Promise<void>;
+        toggleHoldSession: (lineNumber: LineType["lineNumber"], forcedValue?: boolean) => void;
+        makeTransferSession: (lineNumber: LineType["lineNumber"], transferLineNumber: LineType["lineNumber"]) => void;
+        cancelTransferSession: (lineNumber: LineType["lineNumber"], transferLineNumber: LineType["lineNumber"]) => void;
         cancelSession: (lineNumber: LineType["lineNumber"]) => void;
-        startTransferSession: (lineNumber: LineType["lineNumber"]) => void;
-        cancelTransferSession: (lineNumber: LineType["lineNumber"]) => void;
-        attendedTransferSession: (baseLine: LineType, transferLineNumber: LineType["lineNumber"]) => void;
-        cancelAttendedTransferSession: (baseLine: LineType, transferLineNumber: LineType["lineNumber"]) => void;
         teardownSession: typeof import("./methods/session").teardownSession;
     };
     /**
-     * Get an existing SIP by username
+     * Get SIP account state by username.
+     *
+     * @param {string} username - The SIP account username.
+     * @returns {{
+     *   status: SipUserAgentStatus;
+     *   lines: LineType[];
+     *   watch: ReturnType<typeof useSipManager>;
+     * }} An object with account status, active lines, and a reactive watcher hook.
      */
     get(username: string): {
         status: SipUserAgentStatus;
         lines: LineType[];
         watch: () => {
-            status: SipUserAgentStatus | undefined;
+            status: SipUserAgentStatus;
             lines: LineType[];
         };
     };
     /**
-     * Check the existance of SIP instance by username
+     * Check if a SIP instance already exists for the username.
+     *
+     * @param {string} username - The SIP account username.
+     * @returns {boolean} True if the instance exists, false otherwise.
      */
     has(username: string): boolean;
     /**
-     * Stop and remove a SIP session
+     * Attempt to reconnect the SIP transport for a given username.
+     *
+     * @param {string} username - The SIP account username.
+     * @returns {void}
+     */
+    reconnect(username: string): void;
+    /**
+     * Stop and remove a SIP session for a username.
+     * Also cleans up from the global store.
+     *
+     * @param {string} username - The SIP account username.
+     * @returns {Promise<void>} Resolves when the session is stopped and removed.
      */
     stop(username: string): Promise<void>;
     /**
-     * Stop and clear all SIP sessions
+     * Stop and clear ALL SIP sessions.
+     * Useful on logout or app shutdown.
+     *
+     * @returns {Promise<void>} Resolves when all sessions are stopped and cleared.
      */
     stopAll(): Promise<void>;
+    /**
+     * Find the username associated with a specific line number.
+     *
+     * @param {LineType['lineNumber']} lineNumber - The line number to look up.
+     * @returns {string | undefined} The username if found, otherwise undefined.
+     */
     getUsernameByNumber(lineNumber: LineType['lineNumber']): string | null;
+    /**
+     * Find the SIP session associated with a specific line number.
+     *
+     * @param {LineType['lineNumber']} lineNumber - The line number to look up.
+     * @returns {any} The SIP session object if found, otherwise undefined.
+     */
     getSessionByNumber(lineNumber: LineType['lineNumber']): import("./store/types").SipInvitationType | import("./store/types").SipInviterType | null;
 }

package/dist/methods/session/index.d.ts

@@ -14,19 +14,16 @@ export declare const sessionMethods: ({ username }: {
     toggleShareScreen: (lineNumber: LineType["lineNumber"]) => Promise<void>;
     rejectSession: (lineNumber: LineType["lineNumber"]) => void;
     dialByNumber: (type: Extract<CallType, "audio" | "video">, dialNumber: string, extraHeaders?: Array<string>) => void;
-    makeConferenceSession: (lineObj: LineType, extraHeaders?: Array<string>) => void;
     endSession: (lineNumber: LineType["lineNumber"]) => void;
     recordSession: (lineNumber: LineType["lineNumber"]) => {
         start: () => Promise<void>;
         stop: () => void;
     };
     toggleMuteSession: (lineNumber: LineType["lineNumber"]) => void;
-    toggleHoldSession: (lineNumber: LineType["lineNumber"], forcedValue?: boolean) => Promise<void>;
+    toggleHoldSession: (lineNumber: LineType["lineNumber"], forcedValue?: boolean) => void;
+    makeTransferSession: (lineNumber: LineType["lineNumber"], transferLineNumber: LineType["lineNumber"]) => void;
+    cancelTransferSession: (lineNumber: LineType["lineNumber"], transferLineNumber: LineType["lineNumber"]) => void;
     cancelSession: (lineNumber: LineType["lineNumber"]) => void;
-    startTransferSession: (lineNumber: LineType["lineNumber"]) => void;
-    cancelTransferSession: (lineNumber: LineType["lineNumber"]) => void;
-    attendedTransferSession: (baseLine: LineType, transferLineNumber: LineType["lineNumber"]) => void;
-    cancelAttendedTransferSession: (baseLine: LineType, transferLineNumber: LineType["lineNumber"]) => void;
     teardownSession: typeof teardownSession;
 };
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-sip-kit",
   "private": false,
-  "version": "0.5.20",
+  "version": "0.5.21",
   "type": "module",
   "author": {
     "name": "Shervin Ghajar",