react-sip-kit 0.2.0

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

@@ -0,0 +1,3 @@
+import { CallbackFunction } from '../../types';
+export declare function detectDevices(callback: CallbackFunction<MediaDeviceInfo[]>): void;
+export declare function getMediaPermissions(media?: 'audio' | 'video'): Promise<MediaStream>;

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

@@ -0,0 +1,3 @@
+import { SipUserAgent } from '../../types';
+export declare function Register(userAgent?: SipUserAgent): void;
+export declare function Unregister(skipUnsubscribe?: boolean, userAgent?: SipUserAgent): void;

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

@@ -0,0 +1,2 @@
+import { LineType } from '../../store/types';
+export declare function teardownSession(lineObj: LineType): void;

package/dist/provider.d.ts

@@ -0,0 +1,5 @@
+import { SipContextType, SipProviderProps } from './types';
+import React from 'react';
+export declare const SipContext: React.Context<SipContextType | undefined>;
+export declare const SipProvider: React.FC<SipProviderProps>;
+export declare const useSipProvider: () => SipContextType;

package/dist/store/index.d.ts

@@ -0,0 +1,28 @@
+import { SipConfigs } from '../configs/types';
+import { SipStoreStateType } from './types';
+export declare const useSipStore: import("zustand").UseBoundStore<import("zustand").StoreApi<SipStoreStateType>>;
+/**
+ *
+ * Set sip store for none functional components
+ */
+export declare const setSipStore: (state: Partial<SipStoreStateType>) => void;
+/**
+ *
+ * Get sip store for none functional components
+ */
+export declare const getSipStore: () => SipStoreStateType;
+/**
+ *
+ * Get sip store userAgent for none functional components
+ */
+export declare const getSipStoreUserAgent: () => SipStoreStateType["userAgent"];
+/**
+ *
+ * Get sip store configs for none functional components
+ */
+export declare const getSipStoreConfigs: () => SipConfigs;
+/**
+ *
+ * Init sip store for none functional components
+ */
+export declare const initSipStore: () => void;

package/dist/store/types.d.ts

@@ -0,0 +1,149 @@
+import { SipConfigs } from '../configs/types';
+import { AudioBlobs } from '../constructors';
+import { SipUserAgent } from '../types';
+import { Dayjs } from 'dayjs';
+import { Invitation, Inviter, Session, SessionDescriptionHandler, SessionDescriptionHandlerOptions } from 'sip.js';
+import { IncomingInviteRequest } from 'sip.js/lib/core';
+export interface SipStoreStateType {
+    configs: SipConfigs;
+    userAgent?: SipUserAgent;
+    buddies: Array<BuddyType>;
+    selectedBuddy: Array<any>;
+    selectedLine: Array<any>;
+    lines: Array<LineType>;
+    newLineNumber: number;
+    SipUsername: string;
+    SipDomain: string;
+    audioBlobs: AudioBlobs['audioBlobs'];
+    devicesInfo: DevicesInfoType;
+    setSipStore: (state: Partial<SipStoreStateType>) => void;
+    setUserAgent: (userAgent: SipStoreStateType['userAgent']) => void;
+    addLine: (line: LineType) => void;
+    updateLine: (line: LineType) => void;
+    removeLine: (lineNum: LineType['lineNumber']) => void;
+    addBuddy: (buddy: BuddyType) => void;
+    findBuddyByDid: (did: string) => BuddyType | null;
+    findBuddyByIdentity: (indentity: BuddyType['identity']) => BuddyType | null;
+    findLineByNumber: (lineNum: LineType['lineNumber']) => LineType | null;
+    getSession: (did: string) => SipSessionType | null;
+    getSessions: () => SipUserAgent['sessions'] | null;
+    countSessions: (id: string) => number;
+}
+export interface SipInvitationType extends Omit<Invitation, 'incomingInviteRequest' | 'sessionDescriptionHandler'> {
+    data: Partial<SipSessionDataType>;
+    incomingInviteRequest: IncomingInviteRequest;
+    sessionDescriptionHandler: SipSessionDescriptionHandler;
+    sessionDescriptionHandlerOptionsReInvite: SipSessionDescriptionHandlerOptions;
+    isOnHold: boolean;
+}
+export interface SipSessionDescriptionHandlerOptions extends SessionDescriptionHandlerOptions {
+    hold: boolean;
+}
+export interface SipInviterType extends Inviter {
+    data: Partial<SipSessionDataType>;
+    sessionDescriptionHandler: SipSessionDescriptionHandler;
+    sessionDescriptionHandlerOptionsReInvite: SipSessionDescriptionHandlerOptions;
+    isOnHold: boolean;
+}
+export interface SipSessionDescriptionHandler extends SessionDescriptionHandler {
+    peerConnection: RTCPeerConnection;
+    peerConnectionDelegate: any;
+}
+export interface LineType {
+    lineNumber: number;
+    DisplayName: string;
+    DisplayNumber: string;
+    IsSelected: boolean;
+    BuddyObj: BuddyType | null;
+    sipSession: SipInvitationType | SipInviterType | null;
+    LocalSoundMeter: any;
+    RemoteSoundMeter: any;
+}
+export interface SipSessionType extends Session {
+    data: SipSessionDataType;
+}
+export interface SipSessionDataType {
+    line: number;
+    calldirection: 'inbound' | 'outbound';
+    terminateby: string;
+    src: string;
+    buddyId: string;
+    callstart: string;
+    earlyReject: boolean;
+    withvideo: boolean;
+    reasonCode: number;
+    reasonText: string;
+    teardownComplete: boolean;
+    childsession: SipSessionType | null;
+    startTime: Dayjs;
+    started: boolean;
+    hold: Array<{
+        event: 'hold' | 'unhold';
+        eventTime: string;
+    }>;
+    isHold: boolean;
+    mute: Array<{
+        event: 'mute' | 'unmute';
+        eventTime: string;
+    }>;
+    isMute: boolean;
+    videoChannelNames: Array<Record<'mid' | 'channel', string>>;
+    dst: string;
+    transfer: Array<SipSessionTransferType>;
+    AudioSourceTrack: any;
+    earlyMedia: any;
+    ringerObj: {
+        [key: string]: any;
+    } | null;
+    ConfbridgeChannels: Array<any>;
+    ConfbridgeEvents: Array<any>;
+    videoSourceDevice: string | null;
+    audioSourceDevice: string | null;
+    audioOutputDevice: string | null;
+}
+export interface SipSessionTransferType {
+    type: 'Attended' | 'Blind';
+    to: number;
+    transferTime: string;
+    disposition: string;
+    dispositionTime: string;
+    accept: {
+        complete: boolean | null;
+        eventTime: string | null;
+        disposition: string;
+    };
+    onCancle?: Function;
+}
+export interface 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;
+}
+interface DevicesInfoType {
+    hasVideoDevice: boolean;
+    hasAudioDevice: boolean;
+    hasSpeakerDevice: boolean;
+    audioInputDevices: any[];
+    videoInputDevices: any[];
+    speakerDevices: any[];
+}
+export {};

package/dist/types.d.ts

@@ -0,0 +1,49 @@
+import { SipConfigs } from './configs/types';
+import { reconnectTransport } from './events/transport';
+import { useSessionMethods, useSessionEvents } from './hooks';
+import { SipSessionType, SipStoreStateType } from './store/types';
+import { UserAgent, Registerer, Subscriber } from 'sip.js';
+export interface SipUserAgent extends UserAgent {
+    isReRegister: boolean;
+    isRegistered: () => boolean;
+    registerer: Registerer;
+    sessions: {
+        [id: string]: SipSessionType;
+    };
+    _sessions: {
+        [id: string]: SipSessionType;
+    };
+    registrationCompleted: boolean;
+    registering: boolean;
+    transport: UserAgent['transport'] & {
+        ReconnectionAttempts: number;
+        attemptingReconnection: boolean;
+    };
+    BlfSubs: any[];
+    lastVoicemailCount: number;
+    selfSub: Subscriber | null;
+    voicemailSub: Subscriber | null;
+}
+type SipProviderConfigs<T extends SipConfigs> = {
+    account: T['account'];
+} & {
+    [P in Exclude<keyof T, 'account'>]?: Partial<T[P]>;
+};
+export interface SipProviderProps<T extends SipConfigs = SipConfigs> {
+    children: React.ReactNode;
+    configs: SipProviderConfigs<T>;
+}
+export interface SipContextType {
+    lines: SipStoreStateType['lines'];
+    session: SipContextSessionType;
+    transport: SipContextTransportType;
+}
+export interface SipContextSessionType {
+    methods: Omit<ReturnType<typeof useSessionMethods>, 'receiveCall'>;
+    events: ReturnType<typeof useSessionEvents>;
+}
+export interface SipContextTransportType {
+    reconnectTransport: typeof reconnectTransport;
+}
+export type CallbackFunction<T> = (value?: T) => void;
+export {};

package/dist/utils/dayjs.d.ts

@@ -0,0 +1,3 @@
+import dayjs from 'dayjs';
+declare const dayJs: typeof dayjs;
+export { dayJs };

package/dist/utils/deepMerge.d.ts

@@ -0,0 +1 @@
+export declare function deepMerge<T extends object>(target: T, source: Partial<T>): T;

package/dist/utils/formatDuration.d.ts

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

package/dist/utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from './formatDuration';
+export * from './dayjs';
+export * from './deepMerge';
+export * from './utcDateNow';

package/dist/utils/utcDateNow.d.ts

@@ -0,0 +1 @@
+export declare function utcDateNow(): string;

package/package.json

@@ -0,0 +1,98 @@
+{
+  "name": "react-sip-kit",
+  "private": false,
+  "version": "0.2.0",
+  "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": {
+    "clone": "^2.1.2",
+    "dayjs": "^1.11.13",
+    "sip.js": "0.21.2",
+    "uuid": "^11.0.3",
+    "zustand": "^5.0.1"
+  },
+  "devDependencies": {
+    "react-dom": "18.3.1",
+    "@eslint/js": "9.13.0",
+    "prettier-plugin-organize-imports": "^4.1.0",
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+    "@types/clone": "^2.1.4",
+    "@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",
+    "typescript": "~5.6.2",
+    "typescript-eslint": "8.11.0",
+    "@rollup/plugin-commonjs": "^28.0.3",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "rollup": "^4.41.1",
+    "rollup-plugin-delete": "^3.0.1",
+    "rollup-plugin-dts": "^6.2.1"
+  },
+  "peerDependencies": {
+    "react": ">=17.0.0"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ]
+}