react-sip-kit 0.5.20 → 0.6.2

package/dist/manager.d.ts

@@ -1,62 +1,115 @@
 import { LineType, SipUserAgentStatus } from './store/types';
-import { SipManagerConfig } from './types';
+import { GetAccountKey, GetMethodsKey, LineLookup, SipManagerConfig } from './types';
 export declare class SipManager {
     private instances;
     /**
-     * Create and initialize a SIP session for an account
+     * Update the configuration for an existing SIP instance.
+     * - Updates both local instance map and global store.
+     * - Does NOT restart or reconnect automatically.
+     *
+     * Use `initilizeMediaStreams` or `reconnect()` if runtime behavior must change.
+     *
+     * @param username - SIP account username
+     * @param config - Updated SIP configuration
+     */
+    private updateConfig;
+    /**
+     * Add a new SIP account, or update an existing one if the config has changed.
+     *
+     * - If identical config already exists → ignored.
+     * - If username exists with a different config → re-initializes media streams.
+     * - Otherwise → creates and initializes a new SIP instance.
+     *
+     * @param config - SIP account configuration
      */
     add(config: SipManagerConfig): Promise<void>;
     /**
-     * Get an existing SIP methods by username
+     * Get session methods (dial, answer, hold, etc.) for a live session.
+     *
+     * Resolves the session by `username`, `lineKey`, or `remoteNumber`.
+     *
+     * @param key - Identifier for session resolution
+     * @throws Error if no session could be resolved
      */
-    methods(username: string): {
+    getSessionMethodsBy(key: GetMethodsKey): {
         receiveSession: (invitation: import("./store/types").SipInvitationType) => void;
-        answerAudioSession: (lineNumber: LineType["lineNumber"]) => void;
-        answerVideoSession: (lineNumber: LineType["lineNumber"], enableVideo?: boolean) => void;
+        answerAudioSession: (lineKey: LineType["lineKey"]) => void;
+        answerVideoSession: (lineKey: LineType["lineKey"], enableVideo?: boolean) => void;
         makeAudioSession: (lineObj: LineType, dialledNumber: string, extraHeaders?: Array<string>) => void;
         makeVideoSession: (lineObj: LineType, dialledNumber: string, extraHeaders?: Array<string>) => void;
-        toggleLocalVideoTrack: (lineNumber: LineType["lineNumber"]) => Promise<void>;
-        toggleShareScreen: (lineNumber: LineType["lineNumber"]) => Promise<void>;
-        rejectSession: (lineNumber: LineType["lineNumber"]) => void;
+        toggleLocalVideoTrack: (lineKey: LineType["lineKey"]) => Promise<void>;
+        toggleShareScreen: (lineKey: LineType["lineKey"]) => Promise<void>;
+        rejectSession: (lineKey: LineType["lineKey"]) => 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"]) => {
+        endSession: (lineKey: LineType["lineKey"]) => void;
+        recordSession: (lineKey: LineType["lineKey"]) => {
             start: () => Promise<void>;
             stop: () => void;
         };
-        toggleMuteSession: (lineNumber: LineType["lineNumber"]) => void;
-        toggleHoldSession: (lineNumber: LineType["lineNumber"], forcedValue?: boolean) => Promise<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;
+        toggleMuteSession: (lineKey: LineType["lineKey"]) => void;
+        toggleHoldSession: (lineKey: LineType["lineKey"], forcedValue?: boolean) => void;
+        makeTransferSession: (lineKey: LineType["lineKey"], transferLineKey: LineType["lineKey"]) => void;
+        cancelTransferSession: (lineKey: LineType["lineKey"], transferLineKey: LineType["lineKey"]) => void;
+        cancelSession: (lineKey: LineType["lineKey"]) => void;
         teardownSession: typeof import("./methods/session").teardownSession;
     };
     /**
-     * Get an existing SIP by username
+     * Get SIP account state.
+     *
+     * Resolves the account by `username`, `lineKey`, or `remoteNumber`.
+     *
+     * @param key - Identifier for account resolution
+     * @returns Object containing:
+     *   - `status` → UA status
+     *   - `lines` → all active lines
+     *   - `watch` → reactive watcher hook
+     * @throws Error if no username could be resolved
      */
-    get(username: string): {
+    getAccountBy(key: GetAccountKey): {
         status: SipUserAgentStatus;
         lines: LineType[];
         watch: () => {
-            status: SipUserAgentStatus | undefined;
+            status: SipUserAgentStatus;
             lines: LineType[];
         };
     };
     /**
-     * Check the existance of SIP instance by username
+     * Check if an instance exists for the given username.
      */
     has(username: string): boolean;
     /**
-     * Stop and remove a SIP session
+     * Reconnect transport for an existing SIP instance.
+     */
+    reconnect(username: string): void;
+    /**
+     * Stop and remove a SIP instance by username.
+     * Also removes related data from the global store.
      */
     stop(username: string): Promise<void>;
     /**
-     * Stop and clear all SIP sessions
+     * Stop and clear all SIP instances.
+     * Useful for logout or application shutdown.
      */
     stopAll(): Promise<void>;
-    getUsernameByNumber(lineNumber: LineType['lineNumber']): string | null;
-    getSessionByNumber(lineNumber: LineType['lineNumber']): import("./store/types").SipInvitationType | import("./store/types").SipInviterType | null;
+    /**
+     * Get a Line by either `lineKey` or `remoteNumber`.
+     *
+     * @param key - Lookup key (mutually exclusive)
+     * @returns Line if found, otherwise null
+     */
+    getLineBy(key: LineLookup): LineType | null;
+    /**
+     * Get a SIP session by either `lineKey` or `remoteNumber`.
+     *
+     * @param key - Lookup key (mutually exclusive)
+     * @returns SIP session if found, otherwise null
+     */
+    getSessionBy(key: LineLookup): import("./store/types").SipInvitationType | import("./store/types").SipInviterType | null;
+    /**
+     * Get a username by either `lineKey` or `remoteNumber`.
+     *
+     * @param key - Lookup key (mutually exclusive)
+     * @returns Username if found, otherwise null
+     */
+    getUsernameBy(key: LineLookup): string | null;
 }

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

@@ -6,27 +6,24 @@ export declare const sessionMethods: ({ username }: {
     username: SipAccountConfig["username"];
 }) => {
     receiveSession: (invitation: SipInvitationType) => void;
-    answerAudioSession: (lineNumber: LineType["lineNumber"]) => void;
-    answerVideoSession: (lineNumber: LineType["lineNumber"], enableVideo?: boolean) => void;
+    answerAudioSession: (lineKey: LineType["lineKey"]) => void;
+    answerVideoSession: (lineKey: LineType["lineKey"], enableVideo?: boolean) => void;
     makeAudioSession: (lineObj: LineType, dialledNumber: string, extraHeaders?: Array<string>) => void;
     makeVideoSession: (lineObj: LineType, dialledNumber: string, extraHeaders?: Array<string>) => void;
-    toggleLocalVideoTrack: (lineNumber: LineType["lineNumber"]) => Promise<void>;
-    toggleShareScreen: (lineNumber: LineType["lineNumber"]) => Promise<void>;
-    rejectSession: (lineNumber: LineType["lineNumber"]) => void;
+    toggleLocalVideoTrack: (lineKey: LineType["lineKey"]) => Promise<void>;
+    toggleShareScreen: (lineKey: LineType["lineKey"]) => Promise<void>;
+    rejectSession: (lineKey: LineType["lineKey"]) => 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"]) => {
+    endSession: (lineKey: LineType["lineKey"]) => void;
+    recordSession: (lineKey: LineType["lineKey"]) => {
         start: () => Promise<void>;
         stop: () => void;
     };
-    toggleMuteSession: (lineNumber: LineType["lineNumber"]) => void;
-    toggleHoldSession: (lineNumber: LineType["lineNumber"], forcedValue?: boolean) => Promise<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;
+    toggleMuteSession: (lineKey: LineType["lineKey"]) => void;
+    toggleHoldSession: (lineKey: LineType["lineKey"], forcedValue?: boolean) => void;
+    makeTransferSession: (lineKey: LineType["lineKey"], transferLineKey: LineType["lineKey"]) => void;
+    cancelTransferSession: (lineKey: LineType["lineKey"], transferLineKey: LineType["lineKey"]) => void;
+    cancelSession: (lineKey: LineType["lineKey"]) => void;
     teardownSession: typeof teardownSession;
 };
 /**
@@ -43,5 +40,3 @@ export declare function sendVideoActivationWithAckRetry(session: LineType['sipSe
     maxRetries?: number;
     delayMs?: number;
 }): Promise<void>;
-export declare const getUsernameByNumber: (lineNumber: LineType["lineNumber"]) => SipAccountConfig["username"] | null;
-export declare const getSessionByNumber: (lineNumber: LineType["lineNumber"]) => LineType["sipSession"] | null;

package/dist/store/types.d.ts

@@ -6,28 +6,31 @@ export interface SipStoreStateType {
     configs: Record<SipAccountConfig['username'], SipConfigs> | null;
     statuses: Record<SipAccountConfig['username'], SipUserAgentStatus> | null;
     userAgents?: Record<SipAccountConfig['username'], SipUserAgent>;
-    lines: Record<SipAccountConfig['username'], Record<LineType['lineNumber'], LineType>>;
-    usernamesByLineNumber: Record<LineType['lineNumber'], SipAccountConfig['username']>;
+    lines: Record<SipAccountConfig['username'], Record<LineType['lineKey'], LineType>>;
+    usernamesByLineKey: Record<LineType['lineKey'], SipAccountConfig['username']>;
+    lineKeyByRemoteNumber: Record<SipSessionDataType['remoteNumber'], LineType['lineKey']>;
     devicesInfo: DevicesInfoType;
     setSipStore: (state: Partial<SipStoreStateType>) => void;
     setConfig: (username: SipAccountConfig['username'], userAgent: SipConfigs) => void;
     setUserAgent: (username: SipAccountConfig['username'], userAgent: SipUserAgent) => void;
-    addLine: (username: SipAccountConfig['username'], line: LineType) => void;
+    addLine: (line: LineType) => void;
     updateLine: (line: LineType, callback?: CallbackFunction) => void;
-    removeLine: (lineNumber: LineType['lineNumber']) => void;
+    removeLine: (lineKey: LineType['lineKey']) => void;
     remove: (username: SipAccountConfig['username']) => void;
     removeAll: () => void;
-    findLineByNumber: (lineNumber: LineType['lineNumber']) => LineType | null;
-    getSessionByNumber: (lineNumber: LineType['lineNumber']) => LineType['sipSession'] | null;
-    getUsernameByNumber: (lineNumber: LineType['lineNumber']) => SipAccountConfig['username'] | null;
-    getNewLineNumber: () => number;
+    findLineByLineKey: (lineKey: LineType['lineKey']) => LineType | null;
+    getSessionByLineKey: (lineKey: LineType['lineKey']) => LineType['sipSession'] | null;
+    getUsernameByLineKey: (lineKey: LineType['lineKey']) => SipAccountConfig['username'] | null;
+    getUsernameByRemoteNumber: (remoteNumber: SipSessionDataType['remoteNumber']) => SipAccountConfig['username'] | null;
+    getLineKeyByRemoteNumber: (remoteNumber: SipSessionDataType['remoteNumber']) => LineType['lineKey'] | null;
+    getLineByRemoteNumber: (remoteNumber: SipSessionDataType['remoteNumber']) => LineType | null;
+    getNewLineKey: () => number;
 }
 export interface SipInvitationType extends Omit<Invitation, 'incomingInviteRequest' | 'sessionDescriptionHandler'> {
     data: Partial<SipSessionDataType>;
     incomingInviteRequest: IncomingInviteRequest;
     sessionDescriptionHandler: SipSessionDescriptionHandler;
     sessionDescriptionHandlerOptionsReInvite: SipSessionDescriptionHandlerOptions;
-    isOnHold: boolean;
     initiateLocalMediaStreams: (params: InitiateMediaStreamsParams) => void;
     initiateRemoteMediaStreams: (params: InitiateMediaStreamsParams) => void;
 }
@@ -43,7 +46,6 @@ export interface SipInviterType extends Inviter {
     data: Partial<SipSessionDataType>;
     sessionDescriptionHandler: SipSessionDescriptionHandler;
     sessionDescriptionHandlerOptionsReInvite: SipSessionDescriptionHandlerOptions;
-    isOnHold: boolean;
     initiateLocalMediaStreams: (params: InitiateMediaStreamsParams) => void;
     initiateRemoteMediaStreams: (params: InitiateMediaStreamsParams) => void;
 }
@@ -52,8 +54,9 @@ export interface SipSessionDescriptionHandler extends SessionDescriptionHandler
     peerConnectionDelegate: any;
 }
 export interface LineType {
-    lineNumber: number;
-    displayNumber: string;
+    lineKey: number;
+    remoteNumber: string;
+    username: SipAccountConfig['username'];
     sipSession: SipInvitationType | SipInviterType | null;
     localSoundMeter: any;
     remoteSoundMeter: any;
@@ -62,11 +65,12 @@ export interface SipSessionType extends Session {
     data: SipSessionDataType;
 }
 export interface SipSessionDataType {
-    line: number;
+    lineKey: number;
     callDirection: 'inbound' | 'outbound';
     callType: CallType;
     terminateBy: string;
     remoteNumber: string;
+    username: SipAccountConfig['username'];
     earlyReject: boolean;
     reasonCode: number;
     reasonText: string;

package/dist/types.d.ts

@@ -1,6 +1,7 @@
 import { SipConfigs } from './configs/types';
 import { reconnectTransport } from './events/transport';
-import { SipSessionType } from './store/types';
+import { SipInitializer } from './initializer';
+import { LineType, SipSessionDataType, SipSessionType } from './store/types';
 import { Registerer, Subscriber, UserAgent } from 'sip.js';
 export interface SipUserAgent extends UserAgent {
     isReRegister: boolean;
@@ -36,3 +37,40 @@ export interface SipContextTransportType {
 }
 export type CallbackFunction<T = any> = (value?: T) => void;
 export type CallType = 'audio' | 'video' | 'conferenceAudio' | 'conferenceVideo' | 'transferAudio' | 'transferVideo';
+export interface SipManagerInstance {
+    config: SipManagerConfig;
+    instance: SipInitializer;
+}
+export type GetAccountKey = {
+    username: string;
+    lineKey?: never;
+    remoteNumber?: never;
+} | {
+    lineKey: LineType['lineKey'];
+    username?: never;
+    remoteNumber?: never;
+} | {
+    remoteNumber: SipSessionDataType['remoteNumber'];
+    username?: never;
+    lineKey?: never;
+};
+export type GetMethodsKey = {
+    username: string;
+    lineKey?: never;
+    remoteNumber?: never;
+} | {
+    lineKey: LineType['lineKey'];
+    username?: never;
+    remoteNumber?: never;
+} | {
+    remoteNumber: SipSessionDataType['remoteNumber'];
+    username?: never;
+    lineKey?: never;
+};
+export type LineLookup = {
+    lineKey: LineType['lineKey'];
+    remoteNumber?: never;
+} | {
+    remoteNumber: SipSessionDataType['remoteNumber'];
+    lineKey?: never;
+};

package/package.json

@@ -1,99 +1,99 @@
-{
-  "name": "react-sip-kit",
-  "private": false,
-  "version": "0.5.20",
-  "type": "module",
-  "author": {
-    "name": "Shervin Ghajar",
-    "email": "ssghajar.work@gmail.com"
-  },
-  "homepage": "https://github.com/shervin-ghajar/react-sip-kit#readme",
-  "keywords": [
-    "react",
-    "sip",
-    "sipjs",
-    "jssip",
-    "voip",
-    "communication",
-    "webRTC",
-    "telephony",
-    "react-hooks",
-    "sip.js",
-    "react-sip",
-    "react-sip-provider",
-    "real-time",
-    "session-initiation-protocol",
-    "frontend",
-    "javascript",
-    "typescript",
-    "npm",
-    "library",
-    "utility",
-    "responsive",
-    "design",
-    "state-management",
-    "zustand"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/shervin-ghajar/react-sip-kit.git"
-  },
-  "license": "MIT",
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs",
-      "types": "./dist/index.d.ts"
-    }
-  },
-  "scripts": {
-    "build": "rollup -c",
-    "lint": "eslint .",
-    "format": "prettier --write --cache .  --plugin=prettier-plugin-organize-imports"
-  },
-  "dependencies": {
-    "dayjs": "^1.11.13",
-    "sip.js": "0.21.2",
-    "zustand": "^5.0.1",
-    "lodash.isequal": "^4.5.0"
-  },
-  "devDependencies": {
-    "@eslint/js": "9.13.0",
-    "@rollup/plugin-commonjs": "^28.0.3",
-    "@rollup/plugin-node-resolve": "^16.0.1",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^12.1.2",
-    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
-    "@types/lodash.isequal": "^4.5.8",
-    "@types/react": "18.3.12",
-    "@types/react-dom": "18.3.1",
-    "@typescript-eslint/eslint-plugin": "^8.15.0",
-    "@typescript-eslint/parser": "^8.15.0",
-    "eslint": "^9.15.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.2.1",
-    "eslint-plugin-react-hooks": "5.0.0",
-    "eslint-plugin-react-refresh": "0.4.14",
-    "globals": "15.11.0",
-    "prettier": "^3.3.3",
-    "prettier-plugin-organize-imports": "^4.1.0",
-    "rollup": "^4.41.1",
-    "rollup-plugin-delete": "^3.0.1",
-    "rollup-plugin-strip": "^1.2.2",
-    "tslib": "^2.8.1",
-    "typescript": "~5.6.2",
-    "typescript-eslint": "8.11.0"
-  },
-  "peerDependencies": {
-    "react": ">=17.0.0",
-    "react-dom": ">=17.0.0"
-  },
-  "files": [
-    "dist",
-    "README.md",
-    "LICENSE"
-  ]
-}
+{
+  "name": "react-sip-kit",
+  "private": false,
+  "version": "0.6.02",
+  "type": "module",
+  "author": {
+    "name": "Shervin Ghajar",
+    "email": "ssghajar.work@gmail.com"
+  },
+  "homepage": "https://github.com/shervin-ghajar/react-sip-kit#readme",
+  "keywords": [
+    "react",
+    "sip",
+    "sipjs",
+    "jssip",
+    "voip",
+    "communication",
+    "webRTC",
+    "telephony",
+    "react-hooks",
+    "sip.js",
+    "react-sip",
+    "react-sip-provider",
+    "real-time",
+    "session-initiation-protocol",
+    "frontend",
+    "javascript",
+    "typescript",
+    "npm",
+    "library",
+    "utility",
+    "responsive",
+    "design",
+    "state-management",
+    "zustand"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/shervin-ghajar/react-sip-kit.git"
+  },
+  "license": "MIT",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "rollup -c",
+    "lint": "eslint .",
+    "format": "prettier --write --cache .  --plugin=prettier-plugin-organize-imports"
+  },
+  "dependencies": {
+    "dayjs": "^1.11.13",
+    "sip.js": "0.21.2",
+    "zustand": "^5.0.1",
+    "lodash.isequal": "^4.5.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "9.13.0",
+    "@rollup/plugin-commonjs": "^28.0.3",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+    "@types/lodash.isequal": "^4.5.8",
+    "@types/react": "18.3.12",
+    "@types/react-dom": "18.3.1",
+    "@typescript-eslint/eslint-plugin": "^8.15.0",
+    "@typescript-eslint/parser": "^8.15.0",
+    "eslint": "^9.15.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-react-hooks": "5.0.0",
+    "eslint-plugin-react-refresh": "0.4.14",
+    "globals": "15.11.0",
+    "prettier": "^3.3.3",
+    "prettier-plugin-organize-imports": "^4.1.0",
+    "rollup": "^4.41.1",
+    "rollup-plugin-delete": "^3.0.1",
+    "rollup-plugin-strip": "^1.2.2",
+    "tslib": "^2.8.1",
+    "typescript": "~5.6.2",
+    "typescript-eslint": "8.11.0"
+  },
+  "peerDependencies": {
+    "react": ">=17.0.0",
+    "react-dom": ">=17.0.0"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ]
+}