react-sip-kit 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Shervin Ghajar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,107 @@
+# react-sip-kit
+
+A modern, modular, and type-safe SIP (Session Initiation Protocol) provider for React applications.  
+Built for real-time web telephony, this library offers a clean, scalable, and fully configurable SIP core, decoupled from UI and legacy global state.
+
+---
+
+## Features
+
+- 📞 **SIP Core**: Register, make, receive, and manage SIP calls (audio & video)
+- 🔄 **Transfer & Conference**: Supports call transfer and conferencing
+- 🎥 **Video Call Support**: Video call features with device selection
+- 🔔 **Ringtone & Notifications**: Customizable audio output for ringtones and notifications
+- 👥 **Buddy/Contact Management**: Manage contacts (buddies) and pass contact data across sessions
+- ⚙️ **Fully Configurable**: All settings (account, features, media, UI, etc.) are passed as props—no global state or localStorage dependencies
+- 🧩 **Type-Safe & Modular**: Strong TypeScript types, modular config, and easy to extend
+- 🧪 **Testable**: Stateless SIP core, easy to mock and test
+
+---
+
+## Installation
+
+```bash
+npm install react-sip-kit
+# or
+yarn add react-sip-kit
+```
+
+---
+
+## Usage
+
+```tsx
+import { SipProvider } from 'react-sip-kit';
+import { defaultSipConfigs } from 'react-sip-kit/configs';
+
+<SipProvider
+  configs={{
+    ...defaultSipConfigs,
+    account: {
+      username: 'user',
+      password: 'password',
+      domain: 'sip.example.com',
+      wssServer: 'wss.example.com',
+      webSocketPort: 7443,
+      serverPath: '/ws',
+    },
+    features: {
+      enableVideo: true,
+      enableRingtone: true,
+    },
+    // Add or override other config sections as needed
+  }}
+>
+  {/* Your app components */}
+</SipProvider>;
+```
+
+---
+
+## Configuration
+
+All configuration is passed via the `configs` prop.  
+See [`src/configs/types.ts`](src/configs/types.ts) for the full config structure.
+
+**Example config:**
+
+```ts
+{
+  account: { ... },
+  features: { ... },
+  media: { ... },
+  // ...other sections
+}
+```
+
+You can import and extend the default config:
+
+```ts
+import { defaultSipConfigs } from 'react-sip-kit/configs';
+```
+
+---
+
+## API
+
+- **`<SipProvider configs={...}>`**  
+  Provides SIP context and manages SIP sessions for your app.
+
+- **Context hooks**  
+  Use React context or custom hooks to access SIP state, session methods, and events.
+
+---
+
+## License
+
+MIT
+
+---
+
+## Author
+
+**Shervin Ghajar**  
+[GitHub](https://github.com/shervin-ghajar)  
+Email: ssghajar.work@gmail.com
+
+---

package/dist/components/audio/index.d.ts

@@ -0,0 +1,7 @@
+import { AudioHTMLAttributes } from 'react';
+interface AudioProps extends AudioHTMLAttributes<HTMLAudioElement> {
+    lineNumber: string | number;
+    type?: 'transfer' | 'conference';
+}
+export declare const Audio: ({ lineNumber, type, ...rest }: AudioProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/index.d.ts

@@ -0,0 +1,2 @@
+export * from './audio';
+export * from './video';

package/dist/components/video/index.d.ts

@@ -0,0 +1,13 @@
+import { HTMLAttributes, VideoHTMLAttributes } from 'react';
+interface DefaultVideoProps {
+    lineNumber: string | number;
+}
+interface LocalVideoProps extends VideoHTMLAttributes<HTMLVideoElement>, DefaultVideoProps {
+    type: 'local';
+}
+interface RemoteVidepProps extends HTMLAttributes<HTMLDivElement>, DefaultVideoProps {
+    type: 'remote';
+}
+type VideoProps = LocalVideoProps | RemoteVidepProps;
+export declare const Video: ({ lineNumber, ...rest }: VideoProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/configs/index.d.ts

@@ -0,0 +1,12 @@
+import { SipAccountConfig, SipAdvancedConfig, SipConfigs, SipFeaturesConfig, SipMediaConfig, SipPermissionsConfig, SipPolicyConfig, SipRecordingConfig, SipRegistrationConfig, SipStorageConfig, SipXmppConfig } from './types';
+export declare const defaultAccountConfig: SipAccountConfig;
+export declare const defaultFeaturesConfig: SipFeaturesConfig;
+export declare const defaultMediaConfig: SipMediaConfig;
+export declare const defaultPolicyConfig: SipPolicyConfig;
+export declare const defaultRegistrationConfig: SipRegistrationConfig;
+export declare const defaultStorageConfig: SipStorageConfig;
+export declare const defaultRecordingConfig: SipRecordingConfig;
+export declare const defaultAdvancedConfig: SipAdvancedConfig;
+export declare const defaultXmppConfig: SipXmppConfig;
+export declare const defaultPermissionsConfig: SipPermissionsConfig;
+export declare const defaultSipConfigs: SipConfigs;

package/dist/configs/types.d.ts

@@ -0,0 +1,111 @@
+export interface SipConfigs {
+    account: SipAccountConfig;
+    features: SipFeaturesConfig;
+    media: SipMediaConfig;
+    policy: SipPolicyConfig;
+    registration: SipRegistrationConfig;
+    storage: SipStorageConfig;
+    recording: SipRecordingConfig;
+    advanced: SipAdvancedConfig;
+    xmpp: SipXmppConfig;
+    permissions: SipPermissionsConfig;
+}
+export interface SipPermissionsConfig {
+    enableSendFiles: boolean;
+    enableSendImages: boolean;
+    enableAudioRecording: boolean;
+    enableVideoRecording: boolean;
+    enableSms: boolean;
+    enableFax: boolean;
+    enableEmail: boolean;
+}
+export interface SipXmppConfig {
+    server: string;
+    websocketPort: string;
+    websocketPath: string;
+    domain: string;
+    profileUser: string;
+    realm: string;
+    realmSeparator: string;
+    chatGroupService: string;
+}
+export interface SipAdvancedConfig {
+    didLength: number;
+    maxDidLength: number;
+    singleInstance: boolean;
+    chatEngine: string;
+}
+export interface SipRecordingConfig {
+    videoResampleSize: string;
+    recordingVideoSize: string;
+    recordingVideoFps: number;
+    recordingLayout: string;
+}
+export interface SipStorageConfig {
+    streamBuffer: number;
+    maxDataStoreDays: number;
+    posterJpegQuality: number;
+}
+export interface SipRegistrationConfig {
+    transportConnectionTimeout: number;
+    transportReconnectionAttempts: number;
+    transportReconnectionTimeout: number;
+    registerExpires: number;
+    registerExtraHeaders: string;
+    registerExtraContactParams: string;
+    registerContactParams: string;
+    wssInTransport: boolean;
+    ipInContact: boolean;
+    bundlePolicy: string;
+    iceStunServerJson: string;
+    iceStunCheckTimeout: number;
+    subscribeToYourself: boolean;
+    voiceMailSubscribe: boolean;
+    voicemailDid: string;
+    subscribeVoicemailExpires: number;
+    inviteExtraHeaders: string;
+    noAnswerTimeout: number;
+}
+export interface SipPolicyConfig {
+    autoAnswerPolicy: string;
+    doNotDisturbPolicy: string;
+    callWaitingPolicy: string;
+    callRecordingPolicy: string;
+    intercomPolicy: string;
+}
+export interface SipMediaConfig {
+    audioInputDeviceId: string;
+    audioOutputDeviceId: string;
+    videoInputDeviceId: string;
+    ringerOutputDeviceId: string;
+    maxFrameRate: number | string;
+    videoHeight: number | string;
+    videoAspectRatio: number | string;
+    autoGainControl: boolean;
+    echoCancellation: boolean;
+    noiseSuppression: boolean;
+    mirrorVideo: string;
+    maxVideoBandwidth: number;
+    startVideoFullScreen: boolean;
+}
+export interface SipFeaturesConfig {
+    enableVideo: boolean;
+    enableRingtone: boolean;
+    enableTextMessaging: boolean;
+    enableTransfer: boolean;
+    enableConference: boolean;
+    enableTextExpressions: boolean;
+    enableTextDictate: boolean;
+    enableAlphanumericDial: boolean;
+    enableAccountSettings: boolean;
+    enableAppearanceSettings: boolean;
+    enableNotificationSettings: boolean;
+}
+export interface SipAccountConfig {
+    username: string;
+    password: string;
+    domain: string;
+    wssServer: string;
+    webSocketPort: string | number;
+    serverPath: string;
+}

package/dist/constructors/audioBlobs.d.ts

@@ -0,0 +1,13 @@
+type AudioBlobsType = Record<'Alert' | 'Ringtone' | 'speech_orig' | 'Busy_UK' | 'Busy_US' | 'CallWaiting' | 'Congestion_UK' | 'Congestion_US' | 'EarlyMedia_Australia' | 'EarlyMedia_European' | 'EarlyMedia_Japan' | 'EarlyMedia_UK' | 'EarlyMedia_US', {
+    file: string;
+    url: string;
+    blob?: string | ArrayBuffer | null;
+}>;
+export declare class AudioBlobs {
+    private static instance;
+    private audioBlobs;
+    private constructor();
+    static getInstance(overwrite?: Partial<AudioBlobsType>): AudioBlobs;
+    getAudios(): AudioBlobsType;
+}
+export {};

package/dist/constructors/buddy.d.ts

@@ -0,0 +1,26 @@
+import { BuddyType } from '../store/types';
+export declare class Buddy implements BuddyType {
+    type: 'extension' | 'xmpp' | 'contact' | 'group';
+    identity: string;
+    CallerIDName: string;
+    ExtNo: string;
+    MobileNumber?: string;
+    ContactNumber1?: string;
+    ContactNumber2?: string;
+    lastActivity: string;
+    Desc: string;
+    Email: string;
+    jid?: string;
+    devState: string;
+    presence: string;
+    missed: number;
+    IsSelected: boolean;
+    imageObjectURL: string;
+    presenceText: string;
+    EnableDuringDnd: boolean;
+    EnableSubscribe: boolean;
+    SubscribeUser: string;
+    AllowAutoDelete: boolean;
+    Pinned: boolean;
+    constructor(type: 'extension' | 'xmpp' | 'contact' | 'group', identity: string, CallerIDName: string | undefined, ExtNo: string, MobileNumber?: string, ContactNumber1?: string, ContactNumber2?: string, lastActivity?: string, Desc?: string, Email?: string, jid?: string, EnableDuringDnd?: boolean, EnableSubscribe?: boolean, subscription?: string | null, AllowAutoDelete?: boolean, Pinned?: boolean);
+}

package/dist/constructors/index.d.ts

@@ -0,0 +1,3 @@
+export * from './line';
+export * from './buddy';
+export * from './audioBlobs';

package/dist/constructors/line.d.ts

@@ -0,0 +1,12 @@
+import { BuddyType, LineType, SipInvitationType } from '../store/types';
+export declare class Line implements LineType {
+    lineNumber: number;
+    DisplayName: string;
+    DisplayNumber: string;
+    BuddyObj: BuddyType | null;
+    sipSession: SipInvitationType | null;
+    LocalSoundMeter: any;
+    RemoteSoundMeter: any;
+    IsSelected: boolean;
+    constructor(lineNumber: number, displayName: string, displayNumber: string, buddyObj?: BuddyType | null, sipSession?: SipInvitationType | null);
+}

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

@@ -0,0 +1,15 @@
+import { SipUserAgent } from '../../types';
+/**
+ * Called when account is registered
+ */
+export declare function onRegistered(userAgent: SipUserAgent): void;
+/**
+ * Called if UserAgent can connect, but not register.
+ * @param {string} response Incoming request message
+ * @param {string} cause Cause message. Unused
+ **/
+export declare function onRegisterFailed(response: any, cause: any): void;
+/**
+ * Called when Unregister is requested
+ */
+export declare function onUnregistered(userAgent: SipUserAgent): void;

package/dist/events/transport/index.d.ts

@@ -0,0 +1,5 @@
+import { SipUserAgent } from '../../types';
+export declare function onTransportConnected(userAgent?: SipUserAgent): void;
+export declare function onTransportConnectError(error: any, userAgent?: SipUserAgent): void;
+export declare function onTransportDisconnected(userAgent: SipUserAgent): void;
+export declare function reconnectTransport(userAgent?: SipUserAgent): void;

package/dist/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useSessionMethods';
+export * from './useSessionEvents';

package/dist/hooks/useDetectDevices/index.d.ts

@@ -0,0 +1 @@
+export declare const useDetectDevices: () => void;

package/dist/hooks/useSessionEvents/index.d.ts

@@ -0,0 +1,18 @@
+import { LineType, SipSessionDescriptionHandler, SipSessionType } from '../../store/types';
+import { CallbackFunction } from '../../types';
+import { Bye, Message } from 'sip.js';
+import { IncomingRequestMessage, IncomingResponse } from 'sip.js/lib/core';
+export declare const useSessionEvents: () => {
+    onInviteCancel: (lineObj: LineType, response: IncomingRequestMessage, callback?: CallbackFunction<any>) => void;
+    onInviteAccepted: (lineObj: LineType, includeVideo: boolean, response?: IncomingResponse) => void;
+    onInviteTrying: (lineObj: LineType, response: IncomingResponse) => void;
+    onInviteProgress: (lineObj: LineType, response: IncomingResponse) => void;
+    onInviteRejected: (lineObj: LineType, response: IncomingResponse, callback?: CallbackFunction<any>) => void;
+    onInviteRedirected: (lineObj: LineType, response: IncomingResponse) => void;
+    onSessionReceivedBye: (lineObj: LineType, response: Bye, callback?: CallbackFunction<any>) => void;
+    onSessionReinvited: (lineObj: LineType, response: IncomingRequestMessage) => void;
+    onSessionReceivedMessage: (lineObj: LineType, response: Message) => void;
+    onSessionDescriptionHandlerCreated: (lineObj: LineType, sdh: SipSessionDescriptionHandler, provisional: boolean, includeVideo?: boolean) => void;
+    onTrackAddedEvent: (lineObj: LineType, includeVideo?: boolean) => void;
+    onTransferSessionDescriptionHandlerCreated: (lineObj: LineType, session: SipSessionType, sdh: SipSessionDescriptionHandler, includeVideo?: boolean) => void;
+};

package/dist/hooks/useSessionEvents/types.d.ts

@@ -0,0 +1,13 @@
+export interface SipMediaStream extends MediaStream {
+    trackId?: string;
+    mid?: string;
+}
+export interface MediaStreamTrackType extends MediaStreamTrack {
+    mid: RTCRtpTransceiver['mid'];
+    IsMixedTrack: boolean;
+}
+export interface RTCRtpTransceiverType extends RTCRtpTransceiver {
+    track: RTCRtpTransceiver['receiver']['track'] & {
+        mid: RTCRtpTransceiver['mid'];
+    };
+}

package/dist/hooks/useSessionMethods/index.d.ts

@@ -0,0 +1,21 @@
+import { BuddyType, LineType, SipInvitationType } from '../../store/types';
+export declare const useSessionMethods: () => {
+    receiveCall: (session: SipInvitationType) => void;
+    answerAudioSession: (lineNumber: LineType["lineNumber"]) => void;
+    answerVideoSession: (lineNumber: LineType["lineNumber"]) => void;
+    makeAudioSession: (lineObj: LineType, dialledNumber: string, extraHeaders?: Array<string>) => void;
+    makeVideoSession: (lineObj: LineType, dialledNumber: string, extraHeaders?: Array<string>) => void;
+    rejectCall: (lineNumber: LineType["lineNumber"]) => void;
+    dialByLine: (type: "audio" | "video", numToDial: string, buddy?: BuddyType, CallerID?: string, extraHeaders?: Array<string>) => void;
+    endSession: (lineNumber: LineType["lineNumber"]) => void;
+    holdSession: (lineNumber: LineType["lineNumber"]) => void;
+    unholdSession: (lineNumber: LineType["lineNumber"]) => void;
+    muteSession: (lineNumber: LineType["lineNumber"]) => void;
+    unmuteSession: (lineNumber: 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: (lineObj: LineType) => void;
+};

package/dist/hooks/useSessionMethods/types.d.ts

@@ -0,0 +1,31 @@
+import { useSessionMethods } from '.';
+export interface SessionDescriptionHandlerOptions {
+    constraints: {
+        audio: AudioSessionConstraints | boolean;
+        video: VideoSessionConstraints | boolean;
+    };
+}
+export type AudioSessionConstraints = {
+    deviceId: string | {
+        exact: string;
+    };
+    autoGainControl?: boolean;
+    echoCancellation?: boolean;
+    noiseSuppression?: boolean;
+};
+export type VideoSessionConstraints = {
+    deviceId: string | {
+        exact: string;
+    };
+    autoGainControl?: boolean;
+    echoCancellation?: boolean;
+    noiseSuppression?: boolean;
+    frameRate?: string | null;
+    height?: string | null;
+    aspectRatio?: string | null;
+};
+export type SPDOptionsType = Record<'sessionDescriptionHandlerOptions', SessionDescriptionHandlerOptions> & Partial<{
+    earlyMedia: boolean;
+    extraHeaders: string[];
+}>;
+export type SessionMethods = ReturnType<typeof useSessionMethods>;

package/dist/hooks/useSpdOptions/index.d.ts

@@ -0,0 +1,27 @@
+import { SPDOptionsType } from '../useSessionMethods/types';
+export declare const useSpdOptions: () => {
+    answerAudioSpdOptions: ({ option: defaultOption }?: {
+        option?: SPDOptionsType;
+    }) => SPDOptionsType | undefined;
+    makeAudioSpdOptions: ({ extraHeaders }: {
+        extraHeaders?: string[];
+    }) => Record<"sessionDescriptionHandlerOptions", import("../useSessionMethods/types").SessionDescriptionHandlerOptions> & Partial<{
+        earlyMedia: boolean;
+        extraHeaders: string[];
+    }> & {
+        earlyMedia: boolean;
+        extraHeaders?: string[];
+    };
+    answerVideoSpdOptions: ({ option: defaultOption }?: {
+        option?: SPDOptionsType;
+    }) => SPDOptionsType | undefined;
+    makeVideoSpdOptions: ({ extraHeaders }: {
+        extraHeaders?: string[];
+    }) => Record<"sessionDescriptionHandlerOptions", import("../useSessionMethods/types").SessionDescriptionHandlerOptions> & Partial<{
+        earlyMedia: boolean;
+        extraHeaders: string[];
+    }> & {
+        earlyMedia: boolean;
+        extraHeaders?: string[];
+    };
+};