opensips-js 0.1.0

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "opensips-js",
+  "version": "0.1.0",
+  "description": "The JS package for opensips",
+  "default": "src/index.ts",
+  "jsdelivr": "dist/opensips-js.iife.js",
+  "main": "dist/opensips-js.cjs.js",
+  "module": "dist/opensips-js.es.js",
+  "unpkg": "dist/opensips-js.iife.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "dev": "vite",
+    "postpublish": "yarn upload-cdn",
+    "upload-cdn": "yarn build && node scripts/upload-cdn.js",
+    "build": "cross-env TARGET=lib vite build",
+    "demo-build": "cross-env TARGET=demo vite build",
+    "docs-dev": "cd docs && yarn && yarn run dev",
+    "docs-build": "cd docs && yarn && yarn run build",
+    "docs-publish": "yarn docs-genereate && node scripts/upload-doc.js",
+    "docs-genereate": "yarn build && yarn demo-build && cd docs && yarn && yarn run generate && cd ..",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "ts-check": "tsc --noEmit",
+    "lint": "eslint . --ext .js,.jsx,.cjs,.mjs,.ts --fix --ignore-path .gitignore"
+  },
+  "engines": {
+    "node": ">= 16",
+    "npm": "please-use-yarn",
+    "yarn": ">= 1.22.4"
+  },
+  "precommit": "ts-check, lint",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/VoicenterTeam/opensips-js.git"
+  },
+  "author": "Bohdan Konechnyi",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/VoicenterTeam/opensips-js/issues"
+  },
+  "homepage": "https://github.com/VoicenterTeam/opensips-js#readme",
+  "devDependencies": {
+    "@types/node": "^18.14.2",
+    "@typescript-eslint/eslint-plugin": "^5.53.0",
+    "@typescript-eslint/parser": "^5.53.0",
+    "@vitejs/plugin-vue": "^4.2.3",
+    "@voicenter-team/aws-uploader": "^1.0.10",
+    "@voicenter-team/eslint-config-ts": "^1.0.21",
+    "cross-env": "^7.0.3",
+    "dotenv": "^16.0.3",
+    "eslint": "^8.35.0",
+    "pre-commit": "^1.2.2",
+    "process": "^0.11.10",
+    "regenerator-runtime": "^0.13.11",
+    "tsc-alias": "^1.8.6",
+    "typescript": "^4.9.5",
+    "vite": "4.4.11",
+    "vite-plugin-dts": "3.5.3",
+    "vite-plugin-singlefile": "^0.13.5",
+    "vue": "3.2.25"
+  },
+  "dependencies": {
+    "@types/mime": "^3.0.1",
+    "generate-unique-id": "^2.0.1",
+    "jssip": "3.10.0",
+    "konva": "^9.3.16",
+    "loglevel": "^1.8.1",
+    "mime": "^3.0.0",
+    "p-iteration": "^1.1.8",
+    "sdp-transform": "2.14.1",
+    "uuid": "^10.0.0"
+  },
+  "files": [
+    "dist",
+    "src/types"
+  ],
+  "packageManager": "yarn@1.22.22+sha1.ac34549e6aa8e7ead463a7407e1c7390f61a6610"
+}

package/src/types/Dialog.d.ts

@@ -0,0 +1,7 @@
+declare module 'jssip/lib/Dialog' {
+    export namespace Dialog {
+        interface Dialog {
+            receiveRequest(arg1: string, arg2: number): void
+        }
+    }
+}

package/src/types/Socket.d.ts

@@ -0,0 +1,8 @@
+declare module 'jssip/lib/Socket' {
+    export class Socket {
+
+    }
+    export class WeightedSocket {
+
+    }
+}

package/src/types/Transactions.d.ts

@@ -0,0 +1,9 @@
+declare module 'jssip/lib/Transactions' {
+    export const checkTransaction
+    export class InviteServerTransaction {
+        constructor(ua, transport, request)
+    }
+    export class NonInviteServerTransaction {
+        constructor(ua, transport, request)
+    }
+}

package/src/types/UAExtended.d.ts

@@ -0,0 +1,82 @@
+import { Transport } from 'jssip/lib/Transport'
+import { MSRPSession, MSRPSessionEventMap, DialogType } from '@/lib/msrp/session'
+import { Socket, WeightedSocket } from 'jssip/lib/Socket'
+import { IncomingRequest } from 'jssip/lib/SIPMessage'
+import { AnswerOptions, RTCSession } from 'jssip/lib/RTCSession'
+import { CallOptionsExtended } from '@/types/rtc'
+
+declare module 'jssip' {
+    export class UA {
+        protected _transport: Transport
+        protected _sessions: any[]
+        protected _msrp_sessions: any[]
+        protected _registrator: any
+        protected _applicants: any[]
+        protected _dynConfiguration: object
+        protected _status: number
+        protected _closeTimer: any
+        protected _configuration: any
+        protected _contact: any
+
+        _findDialog(call_id: string, from: string, to: string): DialogType
+        receiveRequest(request): void
+        _findSession(request): MSRPSession
+        call(target: string, options: CallOptionsExtended): RTCSession
+    }
+
+    export class Message {
+        constructor(ua: UA)
+        init_incoming(request: IncomingRequest): void
+    }
+
+    export class Options {
+        constructor(ua: UA)
+        init_incoming(request: IncomingRequest): void
+    }
+
+    export interface MSRPOptions extends AnswerOptions {
+        eventHandlers?: Partial<MSRPSessionEventMap>;
+        anonymous?: boolean;
+        fromUserName?: string;
+        fromDisplayName?: string;
+    }
+    export interface UAConfiguration {
+        // mandatory parameters
+        sockets: Socket | Socket[] | WeightedSocket[] ;
+        uri: string;
+        // optional parameters
+        authorization_jwt?: string;
+        authorization_user?: string;
+        connection_recovery_max_interval?: number;
+        connection_recovery_min_interval?: number;
+        contact_uri?: string;
+        display_name?: string;
+        instance_id?: string;
+        no_answer_timeout?: number;
+        session_timers?: boolean;
+        session_timers_refresh_method?: string;
+        session_timers_force_refresher?: boolean;
+        password?: string;
+        realm?: string;
+        ha1?: string;
+        register?: boolean;
+        register_expires?: number;
+        registrar_server?: string;
+        use_preloaded_route?: boolean;
+        user_agent?: string;
+        extra_headers?: string[];
+    }
+
+    /*export class Dialog {
+
+    }*/
+}
+
+declare module 'jssip/lib/URI' {
+
+}
+
+/*declare module 'jssip/lib/Dialog' {
+    export class owner: object
+    receiveRequest (request: any): void
+}*/

package/src/types/declarations.d.ts

@@ -0,0 +1,6 @@
+// export {}
+// declare global {
+//     interface Window {
+//         webkitAudioContext: typeof AudioContext
+//     }
+// }

package/src/types/generic.d.ts

@@ -0,0 +1 @@
+export type Writeable<T> = { -readonly [P in keyof T]: T[P] }

package/src/types/listeners.d.ts

@@ -0,0 +1,104 @@
+import { UAEventMap } from 'jssip/lib/UA'
+
+import { IMessage, MSRPSessionExtended } from '@/types/msrp'
+import { ICall, RoomChangeEmitType, ICallStatus } from '@/types/rtc'
+import MSRPMessage from '@/lib/msrp/message'
+import { ITimeData } from '@/types/timer'
+import { IncomingMSRPSessionEvent, OutgoingMSRPSessionEvent } from '@/helpers/UA'
+
+export type MSRPMessageEventType = {
+    message: MSRPMessage,
+    session: MSRPSessionExtended
+}
+
+export type ChangeVolumeEventType = {
+    callId: string
+    volume: number
+}
+
+export type readyListener = (value: boolean) => void
+export type connectionListener = (value: boolean) => void
+export type reconnectionListener = (value: boolean) => void
+export type changeActiveCallsListener = (event: { [key: string]: ICall }) => void
+export type changeActiveMessagesListener = (event: { [key: string]: IMessage }) => void
+export type TestEventListener = (event: { test: string }) => void
+export type ActiveRoomListener = (event: number | undefined) => void
+export type CallAddingProgressListener = (callId: string | undefined) => void
+export type MSRPInitializingListener = (sessionId: string | undefined) => void
+export type RoomDeletedListener = (roomId: number) => void
+export type changeActiveInputMediaDeviceListener = (event: string) => void
+export type changeActiveOutputMediaDeviceListener = (event: string) => void
+export type changeAvailableDeviceListListener = (event: Array<MediaDeviceInfo>) => void
+export type changeMuteWhenJoinListener = (value: boolean) => void
+export type changeIsDNDListener = (value: boolean) => void
+export type changeIsCallWaitingListener = (value: boolean) => void
+export type changeIsMutedListener = (value: boolean) => void
+export type changeActiveStreamListener = (value: MediaStream) => void
+export type addRoomListener = (value: RoomChangeEmitType) => void
+export type updateRoomListener = (value: RoomChangeEmitType) => void
+export type removeRoomListener = (value: RoomChangeEmitType) => void
+export type IncomingMSRPSessionListener = (event: IncomingMSRPSessionEvent) => void;
+export type OutgoingMSRPSessionListener = (event: OutgoingMSRPSessionEvent) => void;
+export type MSRPSessionListener = IncomingMSRPSessionListener | OutgoingMSRPSessionListener;
+export type MSRPMessageListener = (event: MSRPMessageEventType) => void;
+export type changeCallStatusListener = (event: { [key: string]: ICallStatus }) => void
+export type changeCallTimeListener = (event: { [key: string]: ITimeData }) => void
+export type changeCallMetricsListener = (event: { [key: string]: any }) => void
+export type changeCallVolumeListener = (event: ChangeVolumeEventType) => void
+export type conferenceStartListener = () => void
+export type conferenceEndListener = (sessionId) => void
+export type changeMainVideoStreamListener = (event: { name: string, event: MediaStream }) => void
+export type startScreenShareListener = (event: MediaStream) => void
+export type stopScreenShareListener = () => void
+export type startBlurListener = () => void
+export type stopBlurListener = () => void
+export type memberJoinListener = (event: object) => void
+export type memberHangupListener = (event: object) => void
+export type changeAudioStateListener = (state: boolean) => void
+export type changeVideoStateListener = (state: boolean) => void
+
+export interface OpenSIPSEventMap extends UAEventMap {
+    ready: readyListener
+    connection: connectionListener
+    reconnecting: reconnectionListener
+    // JSSIP
+    changeActiveCalls: changeActiveCallsListener
+    changeActiveMessages: changeActiveMessagesListener
+    callConfirmed: TestEventListener
+    currentActiveRoomChanged: ActiveRoomListener
+    callAddingInProgressChanged: CallAddingProgressListener
+    isMSRPInitializingChanged: MSRPInitializingListener
+    roomDeleted: RoomDeletedListener
+    changeActiveInputMediaDevice: changeActiveInputMediaDeviceListener
+    changeActiveOutputMediaDevice: changeActiveOutputMediaDeviceListener
+    changeAvailableDeviceList: changeAvailableDeviceListListener
+    changeMuteWhenJoin: changeMuteWhenJoinListener
+    changeIsDND: changeIsDNDListener
+    changeIsCallWaiting: changeIsCallWaitingListener
+    changeIsMuted: changeIsMutedListener
+    changeActiveStream: changeActiveStreamListener
+    addRoom: addRoomListener
+    updateRoom: updateRoomListener
+    removeRoom: removeRoomListener
+    changeCallStatus: changeCallStatusListener
+    changeCallTime: changeCallTimeListener
+    changeCallMetrics: changeCallMetricsListener
+    changeCallVolume: changeCallVolumeListener
+    newMSRPMessage: MSRPMessageListener
+    newMSRPSession: MSRPSessionListener
+    // JANUS
+    conferenceStart: conferenceStartListener
+    conferenceEnd: conferenceEndListener
+    startScreenShare: startScreenShareListener
+    stopScreenShare: stopScreenShareListener
+    startBlur: startBlurListener
+    stopBlur: stopBlurListener
+    memberJoin: memberJoinListener
+    memberHangup: memberHangupListener
+    changeAudioState: changeAudioStateListener
+    changeVideoState: changeVideoStateListener
+}
+
+export type ListenersKeyType = keyof OpenSIPSEventMap
+export type ListenersCallbackFnType = OpenSIPSEventMap[ListenersKeyType]
+export type ListenerCallbackFnType<T extends ListenersKeyType> = OpenSIPSEventMap[T]

package/src/types/msrp.d.ts

@@ -0,0 +1,55 @@
+import {
+    MSRPSession,
+    MSRPSessionEventMap
+} from '@/lib/msrp/session'
+import { EndEvent,
+    IncomingAckEvent,
+    IncomingEvent,
+    OutgoingAckEvent,
+    OutgoingEvent,
+    SessionDirection } from 'jssip/lib/RTCSession'
+
+import { StreamMediaType } from '@/types/rtc'
+import MSRPMessage from '@/lib/msrp/message'
+
+export { MSRPMessage }
+
+export type ListenerEventType = EndEvent | IncomingEvent | OutgoingEvent | IncomingAckEvent | OutgoingAckEvent
+
+export interface IMessage extends MSRPSessionExtended {
+    roomId?: number
+    localMuted?: boolean
+    localHold?: boolean
+    audioTag?: StreamMediaType
+    terminate(): void
+}
+
+
+export interface MSRPSessionExtended extends MSRPSession {
+    id: string
+    status: string
+    start_time: Date
+    direction: SessionDirection
+    _id: string
+    _cancel_reason: string
+    _contact: string
+    _end_time: Date
+    _eventsCount: number
+    _from_tag: string
+    _is_canceled: boolean
+    _is_confirmed: boolean
+    _late_sdp: string
+    _status: number
+    _remote_identity: string
+    target_addr: Array<string>
+    answer(options?: any): void
+    _init_incomeing(): void
+    sendMSRP(body: string): void
+    on<T extends keyof MSRPSessionEventMap>(type: T, listener: MSRPSessionEventMap[T]): this;
+}
+
+export interface TriggerMSRPListenerOptions {
+    listenerType: string
+    session: MSRPSessionExtended
+    event?:  ListenerEventType
+}

package/src/types/rtc.d.ts

@@ -0,0 +1,179 @@
+import {
+    AnswerOptions,
+    EndEvent,
+    IncomingAckEvent,
+    IncomingEvent,
+    OutgoingAckEvent,
+    OutgoingEvent,
+    RTCSession,
+    RTCSessionEventMap,
+    MediaConstraints
+} from 'jssip/lib/RTCSession'
+import {
+    IncomingRequest
+} from 'jssip/lib/SIPMessage'
+import { UAConfiguration } from 'jssip/lib/UA'
+
+import { MODULES } from '@/enum/modules'
+
+import { ExtraContactParams } from 'jssip/lib/Registrator'
+
+export type IntervalType = ReturnType<typeof setInterval>
+
+export type ListenerEventType = EndEvent | IncomingEvent | OutgoingEvent | IncomingAckEvent | OutgoingAckEvent
+
+export type RTCBundlePolicy = 'balanced' | 'max-bundle' | 'max-compat'
+export type RTCIceTransportPolicy = 'all' | 'relay'
+export type RTCRtcpMuxPolicy = 'require'
+
+export interface RTCIceServer {
+    credential?: string;
+    urls: string | string[];
+    username?: string;
+}
+
+export interface RTCConfiguration {
+    bundlePolicy?: RTCBundlePolicy;
+    certificates?: RTCCertificate[];
+    iceCandidatePoolSize?: number;
+    iceServers?: RTCIceServer[];
+    iceTransportPolicy?: RTCIceTransportPolicy;
+    rtcpMuxPolicy?: RTCRtcpMuxPolicy;
+}
+
+export interface StreamMediaType extends HTMLAudioElement {
+    className: string
+    setSinkId (id: string): Promise<void>
+}
+
+type ExactConstraints = {
+    audio?: {
+        deviceId: {exact: string}
+    }
+    video?: boolean;
+}
+
+export interface AnswerOptionsExtended extends AnswerOptions {
+    mediaConstraints?: MediaConstraints | ExactConstraints
+}
+
+export interface RemoteIdentityCallType {
+    _display_name: string
+    _uri: {
+        _user: string
+    }
+}
+
+export interface RTCSessionExtended extends RTCSession {
+    id: string
+    _automaticHold: boolean
+    _id: string
+    _localHold: boolean
+    _audioMuted: boolean
+    _cancel_reason: string
+    _contact: string
+    _end_time: Date
+    _eventsCount: number
+    _from_tag: string
+    _is_canceled: boolean
+    _is_confirmed: boolean
+    _late_sdp: string
+    _videoMuted: boolean
+    _status: number
+    _remote_identity: RemoteIdentityCallType
+    answer(options?: AnswerOptionsExtended): void
+    init_icncoming(request: IncomingRequest): void
+}
+
+export interface ICall extends RTCSessionExtended {
+    roomId?: number
+    localMuted?: boolean
+    localHold?: boolean
+    audioTag?: StreamMediaType
+    autoAnswer?: boolean
+    putOnHoldTimestamp?: number
+}
+
+export type RoomChangeEmitType = {
+    room: IRoom
+    roomList: { [key: number]: IRoom }
+}
+
+export interface MediaEvent extends Event {
+    stream: MediaStream
+}
+
+export interface IRoom {
+    started: Date
+    incomingInProgress: boolean
+    roomId: number
+}
+
+export interface ICallStatus {
+    isMoving: boolean
+    isTransferring: boolean
+    isMerging: boolean
+    isTransferred: boolean
+}
+
+export interface ICallStatusUpdate {
+    callId: string
+    isMoving?: boolean
+    isTransferring?: boolean
+    isMerging?: boolean
+    isTransferred?: boolean
+}
+
+export type IRoomUpdate = Omit<IRoom, 'started'> & {
+    started?: Date
+}
+
+export type AudioModuleName = typeof MODULES.AUDIO
+export type VideoModuleName = typeof MODULES.VIDEO
+export type MSRPModuleName = typeof MODULES.MSRP
+
+export type Modules = AudioModuleName | VideoModuleName | MSRPModuleName
+
+export type OnTransportCallback = (parsed: object, message: string) => void
+
+type UAConfigurationExtended = UAConfiguration & {
+    overrideUserAgent?: (userAgent: string) => string
+    onTransportCallback?: OnTransportCallback
+}
+
+export type IOpenSIPSConfiguration = Omit<UAConfigurationExtended, 'sockets'>
+
+export interface IOpenSIPSJSOptions {
+    configuration: IOpenSIPSConfiguration
+    socketInterfaces: [ string ]
+    sipDomain: string
+    sipOptions: {
+        session_timers: boolean
+        extraHeaders: [ string ]
+        pcConfig: RTCConfiguration
+    },
+    modules: Array<Modules>
+    pnExtraHeaders?: ExtraContactParams
+}
+
+export interface TriggerListenerOptions {
+    listenerType: string
+    session: RTCSessionExtended
+    event?:  ListenerEventType
+}
+type CommonLogMethodType = (...args: unknown[]) => void
+
+export interface CustomLoggerType {
+    log: CommonLogMethodType
+    warn: CommonLogMethodType
+    error: CommonLogMethodType
+    debug: CommonLogMethodType
+}
+
+/* UA */
+export interface CallOptionsExtended extends AnswerOptionsExtended {
+    eventHandlers?: Partial<RTCSessionEventMap>;
+    anonymous?: boolean;
+    fromUserName?: string;
+    fromDisplayName?: string;
+}

package/src/types/timer.d.ts

@@ -0,0 +1,13 @@
+export interface ITimeData {
+  callId: string
+  hours: number
+  minutes: number
+  seconds: number
+  formatted: string
+}
+
+export type TempTimeData = Omit<ITimeData, 'callId'> & {
+  callId: string | undefined
+}
+
+export type CallTime = Record<string, TempTimeData>

package/src/types/webrtcmetrics.d.ts

@@ -0,0 +1,64 @@
+export interface WebrtcMetricsConfigType {
+    refreshEvery?: number
+    startAfter?: number
+    stopAfter?: number
+    verbose?: boolean
+    pname?: string
+    cid?: string
+    uid?: string
+    record?: boolean
+    ticket?: boolean
+}
+
+export type ProbeDirectionType = 'inbound' | 'outbound'
+
+export interface ProbeMetricInType {
+    level_in: number
+    codec_id_in: string
+    codec_in: { mime_type: null | number, clock_rate: null | number, sdp_fmtp_line: null | number }
+    delta_jitter_ms_in: number
+    percent_packets_lost_in: number
+    delta_packets_in: number
+    delta_packets_lost_in: number
+    total_packets_in: number
+    total_packets_lost_in: number
+    total_KBytes_in: number
+    delta_KBytes_in: number
+    delta_kbs_in: number,
+    mos_in: number
+    mos_emodel_in: number
+    ssrc: string
+    direction: ProbeDirectionType
+}
+export interface ProbeMetricOutType {
+    level_out: number
+    codec_id_out: string
+    codec_out: { mime_type: null | number, clock_rate: null | number, sdp_fmtp_line: null | number }
+    delta_jitter_ms_out: number
+    delta_rtt_ms_out: null | number
+    total_rtt_ms_out: number
+    total_rtt_measure_out: number
+    percent_packets_lost_out: number
+    delta_packets_out: number
+    delta_packets_lost_out: number
+    total_packets_out: number
+    total_packets_lost_out: number
+    total_KBytes_out: number
+    delta_KBytes_out: number
+    delta_kbs_out: number
+    timestamp_out: null | number
+    mos_out: number
+    mos_emodel_out: number
+    ssrc: string
+    direction: ProbeDirectionType
+}
+
+export interface Probe {
+    audio: { [key: string]: ProbeMetricInType | ProbeMetricOutType }
+}
+
+interface MetricAudioData extends ProbeMetricInType {
+    callId?: string
+}
+
+export type MediaDeviceType = 'input' | 'output'