react-sip-kit 0.6.2 → 0.7.0-beta

package/dist/initializer.d.ts

@@ -4,7 +4,8 @@ export declare class SipInitializer {
     private ua?;
     private configs;
     private username;
-    constructor(configs: SipConfigs);
+    private configKey;
+    constructor(configs: SipConfigs, key: string);
     init(): Promise<void>;
     private detectDevices;
     private createUserAgent;

package/dist/manager.d.ts

@@ -1,35 +1,51 @@
+import { SipConfigs } from './configs/types';
+import { useWatchSessionData } from './hooks';
 import { LineType, SipUserAgentStatus } from './store/types';
 import { GetAccountKey, GetMethodsKey, LineLookup, SipManagerConfig } from './types';
 export declare class SipManager {
+    /**
+     * Active SIP instances keyed by `configKey`.
+     *
+     * `configKey` defaults to `config.account.username` if not explicitly provided.
+     * Ensures multiple accounts (e.g., same username on different domains) can coexist.
+     */
     private instances;
+    /**
+     * Hook for reactively watching session data (delegates to Zustand store).
+     */
+    useWatchSessionData: typeof useWatchSessionData;
+    /**
+     * Hook for reactively watching added configs and line rendering (delegates to Zustand store).
+     *
+     * Recommended for rendering `Lines` with unique key(config.key)
+     */
+    useWatchConfigs: () => SipConfigs[];
     /**
      * Update the configuration for an existing SIP instance.
-     * - Updates both local instance map and global store.
-     * - Does NOT restart or reconnect automatically.
+     *
+     * - Replaces stored config in memory and global store.
+     * - Does **not** automatically reconnect or restart the UserAgent.
      *
      * Use `initilizeMediaStreams` or `reconnect()` if runtime behavior must change.
      *
-     * @param username - SIP account username
+     * @param configKey - Unique identifier of the SIP instance
      * @param config - Updated SIP configuration
      */
     private updateConfig;
     /**
-     * Add a new SIP account, or update an existing one if the config has changed.
+     * Add or update a SIP account.
      *
-     * - 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.
+     * - If identical config exists → ignored.
+     * - If same `configKey` but config changed → updates config + re-initializes media streams.
+     * - Otherwise → creates and initializes a new UserAgent instance.
      *
-     * @param config - SIP account configuration
+     * @param config - SIP account configuration (must contain account info, optional `key`)
      */
     add(config: SipManagerConfig): Promise<void>;
     /**
-     * Get session methods (dial, answer, hold, etc.) for a live session.
-     *
-     * Resolves the session by `username`, `lineKey`, or `remoteNumber`.
+     * Get high-level session methods (answer, dial, hold, transfer, etc.).
      *
-     * @param key - Identifier for session resolution
-     * @throws Error if no session could be resolved
+     * Resolves the SIP instance by `configKey`, `lineKey`, or `remoteNumber`.
      */
     getSessionMethodsBy(key: GetMethodsKey): {
         receiveSession: (invitation: import("./store/types").SipInvitationType) => void;
@@ -48,22 +64,16 @@ export declare class SipManager {
         };
         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;
+        makeTransferSession: (lineKey: LineType["lineKey"], transferNumber: LineType["lineKey"]) => void;
+        cancelTransferSession: (lineKey: LineType["lineKey"], transferNumber: LineType["lineKey"]) => void;
         cancelSession: (lineKey: LineType["lineKey"]) => void;
         teardownSession: typeof import("./methods/session").teardownSession;
     };
     /**
      * 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
+     * Resolves account by `configKey`, `lineKey`, or `remoteNumber`.
+     * Returns reactive account information and watcher hook.
      */
     getAccountBy(key: GetAccountKey): {
         status: SipUserAgentStatus;
@@ -73,43 +83,21 @@ export declare class SipManager {
             lines: LineType[];
         };
     };
+    /** Check if an instance exists for the given configKey. */
+    has(configKey: string): boolean;
+    /** Force reconnect transport for an existing SIP instance. */
+    reconnect(configKey: string): void;
     /**
-     * Check if an instance exists for the given username.
-     */
-    has(username: string): boolean;
-    /**
-     * 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 instances.
-     * Useful for logout or application shutdown.
+     * Stop and remove a SIP instance.
+     * Cleans up associated data from the global store.
      */
+    stop(configKey: string): Promise<void>;
+    /** Stop and clear all SIP instances (e.g., on logout). */
     stopAll(): Promise<void>;
-    /**
-     * Get a Line by either `lineKey` or `remoteNumber`.
-     *
-     * @param key - Lookup key (mutually exclusive)
-     * @returns Line if found, otherwise null
-     */
+    /** Lookup a line by `lineKey` or `remoteNumber`. */
     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
-     */
+    /** Lookup a session by `lineKey` or `remoteNumber`. */
     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;
+    /** Resolve the `configKey` for a given `lineKey` or `remoteNumber`. */
+    getConfigKeyBy(key: LineLookup): string | null;
 }

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

@@ -1,4 +1,4 @@
-import { SipAccountConfig } from '../../configs/types';
-export declare function register(username: SipAccountConfig['username'], userAgent?: import("../..").SipUserAgent | null): void;
-export declare function unregister(username: SipAccountConfig['username'], skipUnsubscribe?: boolean, userAgent?: import("../..").SipUserAgent | null): void;
-export declare function refreshRegistration(username: SipAccountConfig['username']): void;
+import { SipConfigs } from '../../configs/types';
+export declare function register(configKey: SipConfigs['key'], userAgent?: import("../..").SipUserAgent | null): void;
+export declare function unregister(configKey: SipConfigs['key'], skipUnsubscribe?: boolean, userAgent?: import("../..").SipUserAgent | null): void;
+export declare function refreshRegistration(configKey: SipConfigs['key']): void;

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

@@ -1,9 +1,9 @@
-import { SipAccountConfig } from '../../configs/types';
+import { SipConfigs } from '../../configs/types';
 import { LineType, SipInvitationType } from '../../store/types';
 import { CallType } from '../../types';
 import { SendMessageSessionEnum, SendMessageSessionValueType } from './types';
-export declare const sessionMethods: ({ username }: {
-    username: SipAccountConfig["username"];
+export declare const sessionMethods: ({ configKey }: {
+    configKey: SipConfigs["key"];
 }) => {
     receiveSession: (invitation: SipInvitationType) => void;
     answerAudioSession: (lineKey: LineType["lineKey"]) => void;
@@ -21,8 +21,8 @@ export declare const sessionMethods: ({ username }: {
     };
     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;
+    makeTransferSession: (lineKey: LineType["lineKey"], transferNumber: LineType["lineKey"]) => void;
+    cancelTransferSession: (lineKey: LineType["lineKey"], transferNumber: LineType["lineKey"]) => void;
     cancelSession: (lineKey: LineType["lineKey"]) => void;
     teardownSession: typeof teardownSession;
 };

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

@@ -1,7 +1,7 @@
-import { SipAccountConfig } from '../../../configs/types';
+import { SipConfigs } from '../../../configs/types';
 import { SPDOptionsType } from '../types';
-export declare const spdOptions: ({ username }: {
-    username: SipAccountConfig["username"];
+export declare const spdOptions: ({ configKey }: {
+    configKey: SipConfigs["key"];
 }) => {
     answerAudioSpdOptions: ({ option: defaultOption }?: {
         option?: SPDOptionsType;

package/dist/store/index.d.ts

@@ -1,4 +1,4 @@
-import { SipAccountConfig, SipConfigs } from '../configs/types';
+import { SipConfigs } from '../configs/types';
 import { SipUserAgent } from '../types';
 import { SipStoreStateType } from './types';
 export declare const useSipStore: import("zustand").UseBoundStore<import("zustand").StoreApi<SipStoreStateType>>;
@@ -16,12 +16,12 @@ export declare const getSipStore: () => SipStoreStateType;
  *
  * Get sip store userAgent for none functional components
  */
-export declare const getSipStoreUserAgent: (username: SipAccountConfig["username"]) => SipUserAgent | null;
+export declare const getSipStoreUserAgent: (configKey: SipConfigs["key"]) => SipUserAgent | null;
 /**
  *
  * Get sip store configs for none functional components
  */
-export declare const getSipUsernameConfigs: (username: SipAccountConfig["username"]) => SipConfigs | null;
+export declare const getSipUsernameConfigs: (configKey: SipConfigs["key"]) => SipConfigs | null;
 /**
  *
  * Init sip store for none functional components

package/dist/store/types.d.ts

@@ -3,36 +3,49 @@ import { CallbackFunction, CallType, SipUserAgent } from '../types';
 import { Invitation, Inviter, Session, SessionDescriptionHandler, SessionDescriptionHandlerOptions } from 'sip.js';
 import { IncomingInviteRequest } from 'sip.js/lib/core';
 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['lineKey'], LineType>>;
-    usernamesByLineKey: Record<LineType['lineKey'], SipAccountConfig['username']>;
-    lineKeyByRemoteNumber: Record<SipSessionDataType['remoteNumber'], LineType['lineKey']>;
+    configs: Record<SipConfigs['key'], SipConfigs> | null;
+    statuses: Record<SipConfigs['key'], SipUserAgentStatus> | null;
+    userAgents?: Record<SipConfigs['key'], SipUserAgent>;
+    lines: Record<SipConfigs['key'], Record<LineType['lineKey'], LineType>>;
+    configKeysByLineKey: Record<LineType['lineKey'], SipConfigs['key']>;
+    lineKeyByRemoteNumber_ConfigKey: 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;
+    setConfig: (key: SipConfigs['key'], userAgent: SipConfigs) => void;
+    setUserAgent: (key: SipConfigs['key'], userAgent: SipUserAgent) => void;
     addLine: (line: LineType) => void;
     updateLine: (line: LineType, callback?: CallbackFunction) => void;
     removeLine: (lineKey: LineType['lineKey']) => void;
-    remove: (username: SipAccountConfig['username']) => void;
+    remove: (key: SipConfigs['key']) => void;
     removeAll: () => void;
     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;
+    getConfigKeyByLineKey: (lineKey: LineType['lineKey']) => SipConfigs['key'] | null;
+    getConfigKeyByRemoteNumber_ConfigKey: ({ remoteNumber, configKey, }: {
+        remoteNumber: SipSessionDataType['remoteNumber'];
+        configKey: SipConfigs['key'];
+    }) => SipConfigs['key'] | null;
+    getLineKeyByRemoteNumber_ConfigKey: ({ remoteNumber, configKey, }: {
+        remoteNumber: SipSessionDataType['remoteNumber'];
+        configKey: SipConfigs['key'];
+    }) => LineType['lineKey'] | null;
+    getLineBy: ({ remoteNumber, configKey, }: {
+        remoteNumber: SipSessionDataType['remoteNumber'];
+        configKey: SipConfigs['key'];
+    }) => LineType | null;
+    remoteNumberConfigKeyResolver: ({ remoteNumber, configKey, }: {
+        remoteNumber: SipSessionDataType['remoteNumber'];
+        configKey: SipConfigs['key'];
+    }) => `${typeof remoteNumber}:${typeof configKey}`;
+    getNewLineKey: () => LineType['lineKey'];
 }
 export interface SipInvitationType extends Omit<Invitation, 'incomingInviteRequest' | 'sessionDescriptionHandler'> {
     data: Partial<SipSessionDataType>;
     incomingInviteRequest: IncomingInviteRequest;
     sessionDescriptionHandler: SipSessionDescriptionHandler;
     sessionDescriptionHandlerOptionsReInvite: SipSessionDescriptionHandlerOptions;
-    initiateLocalMediaStreams: (params: InitiateMediaStreamsParams) => void;
-    initiateRemoteMediaStreams: (params: InitiateMediaStreamsParams) => void;
+    initiateLocalMediaStreams: (params?: InitiateMediaStreamsParams) => void;
+    initiateRemoteMediaStreams: (params?: InitiateMediaStreamsParams) => void;
 }
 export interface InitiateMediaStreamsParams {
     videoEnabled?: boolean;
@@ -46,17 +59,17 @@ export interface SipInviterType extends Inviter {
     data: Partial<SipSessionDataType>;
     sessionDescriptionHandler: SipSessionDescriptionHandler;
     sessionDescriptionHandlerOptionsReInvite: SipSessionDescriptionHandlerOptions;
-    initiateLocalMediaStreams: (params: InitiateMediaStreamsParams) => void;
-    initiateRemoteMediaStreams: (params: InitiateMediaStreamsParams) => void;
+    initiateLocalMediaStreams: (params?: InitiateMediaStreamsParams) => void;
+    initiateRemoteMediaStreams: (params?: InitiateMediaStreamsParams) => void;
 }
 export interface SipSessionDescriptionHandler extends SessionDescriptionHandler {
     peerConnection: RTCPeerConnection;
     peerConnectionDelegate: any;
 }
 export interface LineType {
-    lineKey: number;
+    lineKey: string;
     remoteNumber: string;
-    username: SipAccountConfig['username'];
+    configKey: SipConfigs['key'];
     sipSession: SipInvitationType | SipInviterType | null;
     localSoundMeter: any;
     remoteSoundMeter: any;
@@ -65,7 +78,8 @@ export interface SipSessionType extends Session {
     data: SipSessionDataType;
 }
 export interface SipSessionDataType {
-    lineKey: number;
+    configKey: SipConfigs['key'];
+    lineKey: LineType['lineKey'];
     callDirection: 'inbound' | 'outbound';
     callType: CallType;
     terminateBy: string;
@@ -107,7 +121,7 @@ export interface SipSessionDataType {
 }
 export interface SipSessionTransferType {
     type: 'Attended' | 'Blind';
-    to: number;
+    to: LineType['remoteNumber'];
     transferTime: string;
     disposition: string;
     dispositionTime: string;

package/dist/types.d.ts

@@ -25,6 +25,17 @@ export interface SipUserAgent extends UserAgent {
     voicemailSub: Subscriber | null;
 }
 export type SipManagerConfig = {
+    /**
+     * Unique identifier for the SIP account instance.
+     *
+     * - Default: `account.username`
+     * - Useful when the same username can exist across multiple domains.
+     * - All internal maps and store entries use this key.
+     */
+    key?: SipConfigs['key'];
+    /**
+     * Core SIP account information (username, password, domain, etc.)
+     */
     account: SipConfigs['account'];
 } & {
     [P in Exclude<keyof SipConfigs, 'account'>]?: Partial<SipConfigs[P]>;
@@ -37,40 +48,48 @@ export interface SipContextTransportType {
 }
 export type CallbackFunction<T = any> = (value?: T) => void;
 export type CallType = 'audio' | 'video' | 'conferenceAudio' | 'conferenceVideo' | 'transferAudio' | 'transferVideo';
+/**
+ * Wrapper for a SIP account + its active UserAgent instance.
+ */
 export interface SipManagerInstance {
     config: SipManagerConfig;
     instance: SipInitializer;
 }
+/**
+ * Keys that can resolve an account:
+ * - `configKey` → explicit instance key
+ * - `lineKey` → active line identifier
+ */
 export type GetAccountKey = {
-    username: string;
+    configKey: SipManagerConfig['key'];
     lineKey?: never;
-    remoteNumber?: never;
 } | {
     lineKey: LineType['lineKey'];
-    username?: never;
-    remoteNumber?: never;
-} | {
-    remoteNumber: SipSessionDataType['remoteNumber'];
-    username?: never;
-    lineKey?: never;
+    configKey?: never;
 };
+/**
+ * Keys that can resolve session control methods:
+ * - `configKey` → explicit instance key
+ * - `lineKey` → active line identifier
+ */
 export type GetMethodsKey = {
-    username: string;
+    configKey: SipManagerConfig['key'];
     lineKey?: never;
-    remoteNumber?: never;
 } | {
     lineKey: LineType['lineKey'];
-    username?: never;
-    remoteNumber?: never;
-} | {
-    remoteNumber: SipSessionDataType['remoteNumber'];
-    username?: never;
-    lineKey?: never;
+    configKey?: never;
 };
+/**
+ * Keys for resolving lines/sessions (mutually exclusive).
+ * - `configKey` & `remoteNumber` → explicit instance key and peer phone number(aka remoteNumber)
+ * - `lineKey` → active line identifier
+ */
 export type LineLookup = {
     lineKey: LineType['lineKey'];
     remoteNumber?: never;
+    configKey?: never;
 } | {
+    configKey: SipConfigs['key'];
     remoteNumber: SipSessionDataType['remoteNumber'];
     lineKey?: never;
 };

package/dist/utils/generateUUID.d.ts

@@ -0,0 +1 @@
+export declare const generateUUID: () => string;

package/dist/utils/getMediaDevices/index.d.ts

@@ -1,5 +1,5 @@
-import { SipAccountConfig } from '../../configs/types';
-export declare const getMediaDevices: (username: SipAccountConfig["username"]) => Promise<{
+import { SipConfigs } from '../../configs/types';
+export declare const getMediaDevices: (configKey: SipConfigs["key"]) => Promise<{
     hasAudioDevice: boolean;
     audioInputDevices: MediaDeviceInfo[];
     hasSpeakerDevice: boolean;

package/dist/utils/index.d.ts

@@ -3,3 +3,4 @@ export * from './dayjs';
 export * from './deepMerge';
 export * from './utcDateNow';
 export * from './getMediaDevices';
+export * from './generateUUID';

package/package.json

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