@babblevoice/babble-drachtio-callmanager 2.3.7 → 2.3.9

package/jsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "module": "commonJS",
+    "target": "es6",
+    "moduleResolution": "node",
+    "checkJs": true
+  },
+  "include": [ "index.js", "babble/*.js", "babble/apps/*.js" ],
+  "exclude": [ "node_modules" ]
+}

package/lib/call.js

@@ -87,6 +87,20 @@ const hangupcodes = {
   REJECTED: { "reason": "REJECTED", "sip": 608 }
 }
 
+/**
+ * Ecapsulate a SIP exception
+ * @param { object } hangupcode
+ * @param { string } message
+ */
+class SipError extends Error {
+  constructor( hangupcode, message ) {
+    super( message )
+    this.code = hangupcode.sip
+    this.hangupcode = hangupcode
+    this.name = "SipError"
+  }
+}
+
 /* Reverse codes - include inbound error codes.
 If not in this list we return REQUEST_TERMINATED during creation */
 const inboundsiperros = {
@@ -99,19 +113,27 @@ let callmanager = {
   "options": {}
 }
 
-/** @class */
+/**
+* @typedef { object } entity
+* @property { string } uri full uri
+* @property { string } [ username ] username part
+* @property { string } [ realm ] realm (domain) part
+* @property { string } [ display ] how the user should be displayed
+* @property { number } [ ccc ] - Current Call Count
+*/
+
 class call {
 
   /**
-  Construct our call object with all defaults, including a default UUID.
-  @constructs call
-  @hideconstructor
+  * Construct our call object with all defaults, including a default UUID.
+  * @constructs call
+  * @hideconstructor
   */
   constructor() {
     this.uuid = uuidv4()
 
     /**
-    @enum {string} type "uas" | "uac"
+    @enum { string } type "uas" | "uac"
     @summary The type (uac or uas) from our perspective.
     */
     this.type = "uac"
@@ -149,7 +171,7 @@ class call {
     }
 
     /**
-     * @private
+     * Protected for this module
      */
     this._state = {
       "_onhangup": false,
@@ -157,42 +179,38 @@ class call {
     }
 
     /**
-    @member
-    @summary Channels which have been created
+    * @summary Channels which have been created
     */
     this.channels = {
-      "audio": false,
+      "audio": undefined,
       "closed": {
         "audio": []
       }
     }
 
     /**
-    @member
-    @summary Store our local and remote sdp objects
+    * @summary Store our local and remote sdp objects
     */
     this.sdp = {
-      "local": false,
-      "remote": false
+      "local": undefined,
+      "remote": undefined
     }
 
     /**
-    @member
-    @summary UACs we create
+    * @summary UACs we create
     */
     this.children = new Set()
     /**
-    @member
-    @summary Who created us
+    * @summary Who created us
     */
-    this.parent = false
+    this.parent = undefined
 
     /**
-      @typedef {Object} epochs
-      @property {number} startat UNIX timestamp of when the call was started (created)
-      @property {number} answerat UNIX timestamp of when the call was answered
-      @property {number} endat UNIX timestamp of when the call ended
-    */
+     * @typedef {Object} epochs
+     * @property {number} startat UNIX timestamp of when the call was started (created)
+     * @property {number} answerat UNIX timestamp of when the call was answered
+     * @property {number} endat UNIX timestamp of when the call ended
+     */
 
     /** @member {epochs} */
     this.epochs = {
@@ -203,13 +221,15 @@ class call {
     }
 
     /**
-      @typedef {Object} sipdialog
-      @property {object} tags
-      @property {string} tags.local
-      @property {string} tags.remote
-    */
-    /** @member {sipdialog} */
+     * @typedef { object } sipdialog
+     * @property { string } callid
+     * @property { object } tags
+     * @property { string } tags.local
+     * @property { string } tags.remote
+     */
+    /** @member { sipdialog } */
     this.sip = {
+      "callid": undefined,
       "tags": {
         "remote": "",
         "local": ""
@@ -217,32 +237,23 @@ class call {
     }
 
     /**
-    @typedef { Object } entity
-    @property { string } [ username ] username part
-    @property { string } [ realm ] realm (domain) part
-    @property { string } [ uri ] full uri
-    @property { string } [ display ] how the user should be displayed
-    */
-    /**
-    For inbound calls - this is discovered by authentication. For outbound
-    this is requested by the caller - i.e. the destination is the registered user.
-    @member { _entity }
-    @private
+    * For inbound calls - this is discovered by authentication. For outbound
+    * this is requested by the caller - i.e. the destination is the registered user.
+    * @type { entity }
+    * Protected for this module.
     */
     this._entity
 
     /**
     Override caller id or name.
-    @member { _remote }
     @private
     */
     this._remote = {
-      "id": false,
-      "name": false
+      "id": undefined,
+      "name": undefined
     }
 
     /**
-     * @member { object }
      * @summary contains network information regarding call
      */
     this.network = {
@@ -254,8 +265,7 @@ class call {
     }
 
     /**
-    @member {object}
-    @summary user definable object that allows other modules to store data in this call.
+    * @summary user definable object that allows other modules to store data in this call.
     */
     this.vars = {}
 
@@ -266,24 +276,23 @@ class call {
     this._receivedtelevents = ""
 
     /**
-    @member {object}
-    @private
+    * @private
     */
     this._promises = {
       "resolve": {
-        "auth": false,
-        "hangup": false,
-        "events": false,
-        "channelevent": false
+        "auth": undefined,
+        "hangup": undefined,
+        "events": undefined,
+        "channelevent": undefined
       },
       "reject": {
-        "auth": false,
-        "channelevent": false
+        "auth": undefined,
+        "channelevent": undefined
       },
       "promise": {
-        "hangup": false,
-        "events": false,
-        "channelevent": false
+        "hangup": undefined,
+        "events": undefined,
+        "channelevent": undefined
       }
     }
 
@@ -292,52 +301,61 @@ class call {
     } )
 
     /**
-    @member {object}
-    @private
+    * @private
     */
     this._timers = {
-      "auth": false,
-      "newuac": false,
-      "events": false,
-      "seinterval": false,
-      "anyevent": false
+      "auth": undefined,
+      "newuac": undefined,
+      "events": undefined,
+      "seinterval": undefined,
+      "anyevent": undefined
     }
 
     /**
-    @member {object}
-    @private
+    * @private
     */
     this._em = new events.EventEmitter()
 
-    /* copy default */
+    /**
+    * @typedef { Object } options
+    * @property { string } [ contact ] contact string
+    * @property { string } [ preferedcodecs ] as it says
+    * @property { boolean } [ rfc2833 ] if set to true enable 2833
+    * @property { string } [ display ] how the user should be displayed
+    * @property { Array } [ headers ]
+    * @property { number } [ uactimeout ] timeout in mS
+    * @property { boolean } [ late ] - do we use late negotiation
+    * @property { boolean } [ noAck ] do not use - converts our options into Drachtio options
+    * @property { string } [ localSdp ] do not use - what we pass into drachtio
+    */
+    /**
+     * copy default 
+     * @type { options }
+     */
     this.options = { ...callmanager.options }
 
     /**
-    @member
-    @private
+    * @private
     */
     this._auth = sipauth.create( callmanager.options.proxy )
 
     this.referauthrequired = callmanager.options.referauthrequired
 
     /**
-    Enable access for other modules.
+    * Enable access for other modules.
     */
     this.hangupcodes = hangupcodes
-  }
 
-  /**
-  @typedef entity
-  @property { string } username
-  @property { string } realm
-  @property { string } uri
-  @property { string } display
-  @property { number } ccc - Current Call Count
-  */
+    /**
+     * If the call is referred somewhere, this is the url we use
+     * @type { string }
+     */
+    this.referingtouri
+  }
 
   /**
-  Returns the entity if known (i.e. outbound or inbound authed).
-  @returns { Promise< entity > }
+  * Returns the entity if known (i.e. outbound or inbound authed).
+  * @returns { Promise< entity > }
   */
   get entity() {
 
@@ -381,7 +399,6 @@ class call {
     if(  !e.uri && !( e.username && e.realm )  ) return
     this._entity = e
 
-    this._entity.name = ""
     this._entity.display = ""
 
     if( this._entity.uri ) {
@@ -408,7 +425,7 @@ class call {
 
   /**
    * Sets caller id
-   * @param { callerid } rem
+   * @param { string } callerid
    */
   set callerid( callerid ) {
     this._remote.id = callerid
@@ -416,7 +433,7 @@ class call {
 
   /**
    * Sets caller id name
-   * @param { calleridname } rem
+   * @param { string } calleridname
    */
   set calleridname( calleridname ) {
     this._remote.name = calleridname
@@ -578,7 +595,7 @@ class call {
 
   /**
     hasmedia
-    @return {bool} - true if the call has media (i.e. is established on not held).
+    @return { boolean } - true if the call has media (i.e. is established on not held).
   */
   get hasmedia() {
     if( this.state.held ) return false
@@ -597,7 +614,7 @@ class call {
 
   /**
     trying
-    @return {bool} - true if the call has been trying.
+    @return { boolean } - true if the call has been trying.
   */
   get trying() {
     return this.state.trying
@@ -605,7 +622,7 @@ class call {
 
   /**
     ringing
-    @return {bool} - true if the call has been ringing.
+    @return { boolean } - true if the call has been ringing.
   */
   get ringing() {
     return this.state.ringing
@@ -620,7 +637,7 @@ class call {
 
   /**
     established - if the call isn't already established then set the answerat time.
-    @param {bool} s - true if the call has been established.
+    @param { boolean } s - true if the call has been established.
   */
   set established( s ) {
     if( this.state.established != s ) {
@@ -631,7 +648,7 @@ class call {
 
   /**
     established
-    @return {bool} - true if the call has been established.
+    @return { boolean } - true if the call has been established.
   */
   get established() {
     return this.state.established
@@ -639,7 +656,7 @@ class call {
 
   /**
     @summary canceled - if the call isn't already canceled then set the endat time.
-    @type {boolean}
+    @type { boolean }
   */
   set canceled( s ) {
     if( this.state.canceled != s ) {
@@ -658,7 +675,7 @@ class call {
 
   /**
     destroyed - if the call isn't already desroyed then set the endat time.
-    @param {bool} s - true if the call has been destroyed.
+    @param { boolean } s - true if the call has been destroyed.
   */
   set destroyed( s ) {
     if( this.state.destroyed != s ) {
@@ -669,7 +686,7 @@ class call {
 
   /**
     destroyed
-    @return {bool} - true if teh call has been destroyed.
+    @return { boolean } - true if teh call has been destroyed.
   */
   get destroyed() {
     return true == this.state.destroyed
@@ -681,7 +698,7 @@ class call {
 
   /**
     @summary the current state of the call as a string: trying|proceeding|early|confirmed|terminated
-    @return {string}
+    @return { string }
   */
   get statestr() {
     if( this.state.established ) {
@@ -705,54 +722,50 @@ class call {
 
   /**
     duration
-    @return {number} - the number of seconds between now (or endat if ended) and the time the call was started.
+    @return { number } - the number of seconds between now (or endat if ended) and the time the call was started.
   */
   get duration() {
-    if( 0 !== this.epochs.endat ) return parseInt( this.epochs.endat - this.epochs.startat )
-    return parseInt( Math.floor( +new Date() / 1000 ) - this.epochs.startat )
+    if( 0 !== this.epochs.endat ) return this.epochs.endat - this.epochs.startat
+    return Math.floor( +new Date() / 1000 ) - this.epochs.startat
   }
 
   /**
     Get the estrablished time.
-    @return {number} - the number of seconds between now (or endat if ended) and the time the call was answered.
+    @return { number } - the number of seconds between now (or endat if ended) and the time the call was answered.
   */
   get billingduration() {
     if( 0 === this.epochs.answerat ) return 0
-    if( 0 !== this.epochs.endat ) return parseInt( this.epochs.endat - this.epochs.answerat )
-    return parseInt( Math.floor( +new Date() / 1000 ) - this.epochs.answerat )
+    if( 0 !== this.epochs.endat ) return this.epochs.endat - this.epochs.answerat
+    return Math.floor( +new Date() / 1000 ) - this.epochs.answerat
   }
 
-  /**
-    Callback for events we pass back to inerested parties.
-    @callback call.event
-    @param {object} call - we pass *this back into the requester
-  */
 
   /**
-    Registers an event callback for this specific call. An event sink registered
-    on this member will receive events only for this call. We emit on call specific
-    emitter and a global emitter.
-    @param { string } ev - The contact string for registered or other sip contact
-    @param { call.event } cb
-  */
+   * Callback for events we pass back to inerested parties.
+   * Registers an event callback for this specific call. An event sink registered
+   * on this member will receive events only for this call. We emit on call specific
+   * emitter and a global emitter.
+   * @param { string } ev - The contact string for registered or other sip contact
+   * @param { (...args: any[] ) => void } cb
+   */
   on( ev, cb ) {
     this._em.on( ev, cb )
   }
 
   /**
-    See event emitter once
-    @param { string } ev - The contact string for registered or other sip contact
-    @param { call.event } cb
-  */
+   * See event emitter once
+   * @param { string } ev - The contact string for registered or other sip contact
+   * @param { (...args: any[] ) => void } cb
+   */
   once( ev, cb ) {
     this._em.once( ev, cb )
   }
 
   /**
-    See event emitter off
-    @param { string } ev - The contact string for registered or other sip contact
-    @param { call.event } cb
-  */
+   * See event emitter off
+   * @param { string } ev - The contact string for registered or other sip contact
+   * @param { (...args: any[] ) => void } cb
+   */
   off( ev, cb ) {
     if( !cb ) {
       this._em.removeAllListeners( ev )
@@ -763,9 +776,9 @@ class call {
   }
 
   /**
-    See event emitter removeAllListeners
-    @param { string } ev - The contact string for registered or other sip contact
-  */
+   * See event emitter removeAllListeners
+   * @param { string } [ ev ] - The contact string for registered or other sip contact
+   */
   removealllisteners( ev ) {
     if( !ev ) {
       const evnames = this._em.eventNames()
@@ -896,7 +909,7 @@ class call {
       child.parent = false
     }
 
-    this.parent = false
+    this.parent = undefined
     this.children.clear()
   }
 
@@ -931,7 +944,7 @@ class call {
   _onring() {
     if( this.state.ringing ) return
     this.state.ringing = true
-    if( false !== this.parent ) {
+    if( undefined !== this.parent ) {
       this.parent.ring()
     }
 
@@ -1134,18 +1147,20 @@ class call {
 
   /**
     Sometimes we don't care who if we are the parent or child - we just want the other party
-    @return { object|bool } returns call object or if none false
+    @return { object | boolean } returns call object or if none false
   */
   get other() {
     if( this.parent ) return this.parent
 
+    /* first established */
     for( const child of this.children ) {
       if( child.established ) {
         return child
       }
     }
 
-    if( 0 < this.children.length ) return this.children.values().next().value
+    /* or the first */
+    if( 0 < this.children.size ) return this.children.values().next().value
 
     return false
   }
@@ -1172,10 +1187,10 @@ class call {
     }
 
     this._timers.auth = setTimeout( () => {
-      this._promises.reject.auth()
-      this._promises.resolve.auth = false
-      this._promises.reject.auth = false
-      this._timers.auth = false
+      this._promises.reject.auth( new SipError( hangupcodes.REQUEST_TIMEOUT, "Auth timed out" ) )
+      this._promises.resolve.auth = undefined
+      this._promises.reject.auth = undefined
+      this._timers.auth = undefined
 
       this.hangup( hangupcodes.REQUEST_TIMEOUT )
 
@@ -1206,6 +1221,8 @@ class call {
     this._req = req
     this._res = res
 
+    req.on( "cancel", ( /*req*/ ) => this._oncanceled( /*req*/ ) )
+
     if( !this._auth.has( this._req ) ) return false
 
     const authorization = this._auth.parseauthheaders( this._req )
@@ -1228,14 +1245,14 @@ class call {
 
       await this.hangup( hangupcodes.FORBIDDEN )
 
-      const r = this._promises.reject.auth
-      this._promises.resolve.auth = false
-      this._promises.reject.auth = false
+      const reject = this._promises.reject.auth
+      this._promises.resolve.auth = undefined
+      this._promises.reject.auth = undefined
 
       clearTimeout( this._timers.auth )
-      this._timers.auth = false
+      this._timers.auth = undefined
 
-      if( r ) r()
+      if( reject ) reject( new SipError( hangupcodes.FORBIDDEN, "Bad Auth" ))
 
       return false
     }
@@ -1253,11 +1270,11 @@ class call {
     this.state.authed = true
     await callstore.set( this )
 
-    const r = this._promises.resolve.auth
-    this._promises.resolve.auth = false
-    this._promises.reject.auth = false
-    this._timers.auth = false
-    if( r ) r()
+    const resolve = this._promises.resolve.auth
+    this._promises.resolve.auth = undefined
+    this._promises.reject.auth = undefined
+    this._timers.auth = undefined
+    if( resolve ) resolve()
 
     this._em.emit( "call.authed", this )
     callmanager.options.em.emit( "call.authed", this )
@@ -1273,7 +1290,7 @@ class call {
     this.canceled = true
 
     for( const child of this.children ) {
-      child.hangup()
+      child.hangup( hangupcodes.ORIGINATOR_CANCEL )
     }
 
     this._onhangup( "wire", hangupcodes.ORIGINATOR_CANCEL )
@@ -1296,14 +1313,14 @@ class call {
         if( this._promises.resolve.events ) {
           const r = this._promises.resolve.events
           
-          this._promises.resolve.events = false
-          this._promises.promise.events = false
+          this._promises.resolve.events = undefined
+          this._promises.promise.events = undefined
           r( ourmatch[ 0 ] )
         }
 
         if( this._timers.events ) {
           clearTimeout( this._timers.events )
-          this._timers.events = false
+          this._timers.events = undefined
         }
       }
     }
@@ -1311,9 +1328,9 @@ class call {
 
   /**
     Called by our call plan to wait for events for auto attendant/IVR.
-    @param {string} [match] - reg exp matching what is required from the user.
-    @param {Int} [timeout] - time to wait before giving up.
-    @return {Promise} - the promise either resolves to a string if it matches or undefined if it times out..
+    @param { string | RegExp } [match] - reg exp matching what is required from the user.
+    @param { number } [timeout] - time to wait before giving up.
+    @return { Promise } - the promise either resolves to a string if it matches or undefined if it times out..
   */
   waitfortelevents( match = /[0-9A-D*#]/, timeout = 30000 ) {
 
@@ -1328,9 +1345,9 @@ class call {
           this._promises.resolve.events()
         }
 
-        this._promises.resolve.events = false
-        this._promises.promise.events = false
-        this._timers.events = false
+        this._promises.resolve.events = undefined
+        this._promises.promise.events = undefined
+        this._timers.events = undefined
         delete this.eventmatch
 
       }, timeout )
@@ -1415,7 +1432,7 @@ class call {
       /* we have already opened a channel (probably early now answering) */
       this.channels.audio.remote( channeldef.remote )
     } else {
-      
+
       await this.#openrelatedchannel( channeldef )
 
       this.sdp.local = sdpgen.create()
@@ -1435,10 +1452,12 @@ class call {
   }
 
   /**
-   * 
+   * @param { object } preferredcall - allow to specify a, not necessarily related call,
+   * that can be used to open the new channel's node.
+   *
    * @returns { Promise }
    */
-  async #choosecodecforanswer() {
+  async #choosecodecforanswer( preferredcall = undefined ) {
     if( this._req.msg && this._req.msg.body ) {
       this.selectedcodec = this.sdp.remote.intersection( this.options.preferedcodecs, true )
       if( !this.selectedcodec ) {
@@ -1465,6 +1484,8 @@ class call {
         channeldef.remote.icepwd = this.sdp.remote.sdp.media[ 0 ].icePwd
       }
 
+      channeldef.preferredcall = preferredcall
+
       /* We might have already opened our audio when we received 183 (early). */
       await this.#openchannelsforanswer( channeldef )
     }
@@ -1472,16 +1493,18 @@ class call {
 
   /**
    * Answer this (inbound) call and store a channel which can be used. This framework will catch and cleanup this call if this is rejected.
-   * @param { object } options
-   * @param { boolean } options.early - don't answer the channel (establish) but establish early media (respond to 183).
+   * @param { object } [ options ]
+   * @param { boolean } [ options.early ] - don't answer the channel (establish) but establish early media (respond to 183).
+   * @param { object } [ options.preferredcall ]
    *
    * @return {Promise} Returns a promise which resolves if the call is answered, otherwise rejects the promise.
   */
-  async answer( options = {} ) {
+  async answer( options = { early: false, preferredcall: undefined } ) {
 
     if( this.canceled || this.established ) return
 
-    await this.#choosecodecforanswer()
+    await this.#choosecodecforanswer( options.preferredcall )
+
     if( this.canceled ) return
 
     if( options.early ) {
@@ -1553,12 +1576,12 @@ class call {
     */
 
     if( this._timers.anyevent ) clearTimeout( this._timers.anyevent )
-    this._timers.anyevent = false
+    this._timers.anyevent = undefined
 
     const r = this._promises.resolve.channelevent
-    this._promises.resolve.channelevent = false
-    this._promises.reject.channelevent = false
-    this._promises.promise.channelevent = false
+    this._promises.resolve.channelevent = undefined
+    this._promises.reject.channelevent = undefined
+    this._promises.promise.channelevent = undefined
     if( r ) r( e )
   }
 
@@ -1595,7 +1618,7 @@ class call {
 
   A telephone event will resolve this promise as we typically need speech to be interupted
   by the user. Note, peeking a telephone-event (i.e. DTMF) will not clear it like waitfortelevents will.
-  @param { regex } constraints - event to filter for from our RTP server - excluding DTMF events - these will always return
+  @param { object } constraints - event to filter for from our RTP server - excluding DTMF events - these will always return
   */
   waitforanyevent( constraints, timeout = 500 ) {
 
@@ -1611,9 +1634,9 @@ class call {
 
     this._timers.anyevent = setTimeout( () => {
       const r = this._promises.resolve.channelevent
-      this._promises.promise.channelevent = false
-      this._promises.resolve.channelevent = false
-      this._promises.reject.channelevent = false
+      this._promises.promise.channelevent = undefined
+      this._promises.resolve.channelevent = undefined
+      this._promises.reject.channelevent = undefined
       if( r ) r( "timeout" )
     }, timeout * 1000 )
 
@@ -2193,8 +2216,8 @@ class call {
   @param { string } address - remote address (ip)
   @param { number } port - remote port
   @param { number } codec
-  @param { string } fingerprint - remote sha 256 fingerprint
-  @param { string } mode - "active"|"passive"
+  @param { string } [ fingerprint ] - remote sha 256 fingerprint
+  @param { string } [ mode ] - "active"|"passive"
   */
   static _createchannelremotedef( address, port, codec, fingerprint, mode /* active|passive */ ) {
     const chandef = {
@@ -2218,6 +2241,8 @@ class call {
 
   /**
   Sets our hangup cause correctly - if not already set.
+  @param { string } src
+  @param { object } [ reason ]
   @private
   */
   _sethangupcause( src, reason ) {
@@ -2248,24 +2273,24 @@ class call {
     /* Clean up promises (ensure they are resolved) and clear any timers */
     for ( const [ key, value ] of Object.entries( this._timers ) ) {
       if( value ) clearTimeout( value )
-      this._timers[ key ] = false
+      this._timers[ key ] = undefined
     }
 
     const authreject = this._promises.reject.auth
-    this._promises.reject.auth = false
-    this._promises.resolve.auth = false
-    if( authreject ) authreject( this )
+    this._promises.reject.auth = undefined
+    this._promises.resolve.auth = undefined
+    if( authreject ) authreject( new SipError( hangupcodes.REQUEST_TIMEOUT, "Auth timed out (cleanup)" ) )
 
     const chanev = this._promises.reject.channelevent
-    this._promises.resolve.channelevent = false
-    this._promises.reject.channelevent = false
-    this._promises.promise.channelevent = false
+    this._promises.resolve.channelevent = undefined
+    this._promises.reject.channelevent = undefined
+    this._promises.promise.channelevent = undefined
     if( chanev ) chanev( Error( "Call hungup" ) )
 
     const resolves = []
     for ( const [ key, value ] of Object.entries( this._promises.resolve ) ) {
       if( value ) resolves.push( value )
-      this._promises.resolve[ key ] = false
+      this._promises.resolve[ key ] = undefined
     }
 
     /* Call outstanding resolves for promises - this will trigger out hangup promise also */
@@ -2284,8 +2309,8 @@ class call {
    * Used by our frame to a) continue a hangup which has been initiated by either us or the network.
    * Complete the hangup, including hanging up all children and waiting for them to complete their
    * hangup.
-   * @param {string} [us] - "us"|"wire"
-   * @param {object} reason - one of the reasons from the hangupcodes enum - only used if we havn't alread set our reason
+   * @param { string } [ src ] - "us"|"wire"
+   * @param { object } [ reason ] - one of the reasons from the hangupcodes enum - only used if we havn't alread set our reason
    * @private
   */
   async _onhangup( src = "us", reason ) {
@@ -2375,16 +2400,16 @@ class call {
     }
 
     await this._promises.promise.hangup
-    this._promises.promise.hangup = false
-    this._promises.resolve.hangup = false
+    this._promises.promise.hangup = undefined
+    this._promises.resolve.hangup = undefined
 
   }
 
   /**
-  Send an UPDATE. Use to updated called id, caller id, sdp etc. Send in dialog - TODO look how to send
-  early as this is recomended in the RFC.
-  @param { Object } options
-  @param { remoteid } [ options.remote ] - if present update the remote called/caller id (display) - if not will get from other
+  * Send an UPDATE. Use to updated called id, caller id, sdp etc. Send in dialog - TODO look how to send
+  * early as this is recomended in the RFC.
+  * @param { object } options
+  * @param { entity } options.remote
   */
   async update( options ) {
 
@@ -2452,19 +2477,23 @@ class call {
   @summary Creates a new SIP dialog. Returns a promise which resolves
   when the dialog is either answered (or cancelled for some reason).
   The promise resolves to a new call is one is generated, or undefined if not.
-  @param { Object } [ options ] - Options object. See default_options in index.js for more details.
+  @param { object } [ options ] - Options object. See default_options in index.js for more details.
   @param { string } [ options.contact ] - The contact string
   @param { boolean } [ options.orphan ] - If present and true then orphan the new call
+  @param { object } [ options.auth ]
   @param { string } [ options.auth.username ] - If SIP auth required username
   @param { string } [ options.auth.password ] - If SIP auth required password
   @param { object } [ options.headers ] - Object containing extra sip headers required.
   @param { object } [ options.uactimeout ] - override the deault timeout
   @param { boolean } [ options.late ] - late negotiation
   @param { entity } [ options.entity ] - used to store this call against and look up a contact string if not supplied.
+  @param { object } [ options.entity ]
   @param { string } [ options.entity.username ]
   @param { string } [ options.entity.realm ]
   @param { string } [ options.entity.uri ]
   @param { number } [ options.entity.max ] - if included no more than this number of calls for this entity (only if we look user up)
+  @param { object } [ options.parent ] - the call we wish to become parent
+  @param { object } [ options.preferredcall ] another related call which we may want to use the rtp host on
   @param { object } [ callbacks ]
   @param { earlycallback } [ callbacks.early ] - callback to provide a call object with early call (pre dialog)
   @param { confirmcallback } [ callbacks.confirm ] - called when a dialog is confirmed but before it is bridged with a parent - this provides an opportunity for another call to adopt this call
@@ -2486,10 +2515,13 @@ class call {
 
     options.headers[ "Max-Forwards" ] = maxforwards
 
-    if( !options.orphan ) {
+    if( !options.orphan && !options.parent ) {
       options.parent = this
+
+      if ( !options.preferredcall )
+        options.preferredcall = options.parent.channels.audio
     }
-    
+
     return await call.newuac( options, callbacks )
   }
 
@@ -2598,13 +2630,17 @@ class call {
    * @param { object } [ channeldef ]
    */
   async #openrelatedchannel( channeldef ) {
-
     const relatedcall = this.other
-    if( relatedcall && relatedcall.channels.audio ) 
-      this.channels.audio = await relatedcall.channels.audio.openchannel( channeldef, this._handlechannelevents.bind( this ) )
-    else 
+    /* TODO: this is a hack. projectrtp has become too complicated with both a listen and connect 
+    mechanism. This is causing problems in code like this. There is no interface to 
+    detect which mode the channel is in - but the channels property will exist on a connect
+    style channel. projectrtp will get a rewrite to support only one. */
+    if( relatedcall && relatedcall.channels.audio && relatedcall.channels.audio.channels )
+      this.channels.audio = await this.other.channels.audio.openchannel( channeldef, this._handlechannelevents.bind( this ) )
+    else if ( channeldef && channeldef.preferredcall && channeldef.preferredcall.channels && channeldef.preferredcall.channels.audio )
+      this.channels.audio = await channeldef.preferredcall.channels.audio.openchannel( channeldef, this._handlechannelevents.bind( this ) )
+    else
       this.channels.audio = await projectrtp.openchannel( channeldef, this._handlechannelevents.bind( this ) )
-
   }
 
   /**
@@ -2624,12 +2660,12 @@ class call {
   /**
    * 
    */
-  async #openchannelsfornewuac() {
+  async #openchannelsfornewuac( channeldef = undefined ) {
     if( this.options.late ) {
       this.options.noAck = true /* this is a MUST for late negotiation */
     } else {
 
-      await this.#openrelatedchannel()
+      await this.#openrelatedchannel( channeldef )
 
       this.sdp.local = sdpgen.create().addcodecs( this.options.preferedcodecs )
       this.sdp.local.setaudioport( this.channels.audio.local.port )
@@ -2783,6 +2819,7 @@ class call {
   @param { object } [ options ] - Options object. See default_options in index.js for more details.
   @param { call } [ options.parent ] - the parent call object
   @param { string } [ options.contact ] - The contact string
+  @param { object } [ options.auth ]
   @param { string } [ options.auth.username ] - If SIP auth required username
   @param { string } [ options.auth.password ] - If SIP auth required password
   @param { object } [ options.headers ] - Object containing extra sip headers required.
@@ -2791,6 +2828,7 @@ class call {
   @param { boolean } [ options.late ] - late negotiation
   @param { boolean } [ options.privacy ] - sets the privacy
   @param { entity } [ options.entity ] - used to store this call against and look up a contact string if not supplied.
+  @param { object } [ options.entity ]}
   @param { string } [ options.entity.username ]
   @param { string } [ options.entity.realm ]
   @param { string } [ options.entity.uri ]
@@ -2799,6 +2837,7 @@ class call {
   @param { object } [ options.callerid ]
   @param { string } [ options.callerid.number ]
   @param { string } [ options.callerid.name ]
+  @param { object } [ options.preferredcall ] another related call which we may want to use the rtp host on
   @param { object } [ callbacks ]
   @param { earlycallback } [ callbacks.early ] - callback to provide a call object with early call (pre dialog)
   @param { confirmcallback } [ callbacks.confirm ] - called when a dialog is confirmed but before it is bridged with a parent - this provides an opportunity for another call to adopt this call
@@ -2847,7 +2886,7 @@ class call {
     newcall.options.headers = tmpheaders
 
     newcall.#confignetwork( options )
-    await newcall.#openchannelsfornewuac()
+    await newcall.#openchannelsfornewuac( { "preferredcall" : options.preferredcall } )
 
     let newdialog
     try {
@@ -2924,7 +2963,7 @@ class call {
    */
   #setdialog( d ) {
     clearTimeout( this._timers.newuac )
-    this._timers.newuac = false
+    this._timers.newuac = undefined
 
     if( this.destroyedcancelledorhungup ) return
 
@@ -2960,7 +2999,7 @@ class call {
   Create a new object when we receive an INVITE request.
 
   @param { object } req - req object from drachtio
-  @param { res } res - res object from drachtio
+  @param { object } res - res object from drachtio
   @returns { Promise< call > }
   */
   static async frominvite( req, res ) {
@@ -2988,7 +3027,7 @@ class call {
     @private
     */
     c._req = req
-    c._req.on( "cancel", ( req ) => c._oncanceled( req ) )
+    c._req.on( "cancel", ( /*req*/ ) => c._oncanceled( /*req*/ ) )
 
     /**
     @member
@@ -3022,13 +3061,11 @@ class call {
    */
   set uactimeout( ms ) {
     if( this.established ) return
-    const msi = parseInt( ms )
-    if( isNaN( msi ) ) return
 
     clearTimeout( this._timers.newuac )
     this._timers.newuac = setTimeout( () => {
       this.hangup( hangupcodes.REQUEST_TIMEOUT )
-    }, msi )
+    }, ms )
   }
 }
 

package/lib/callmanager.js

@@ -15,7 +15,6 @@ class callmanager {
   @param {object} options
   */
   constructor( options ) {
-    this.onnewcall = false
     this.options = options
 
     if( undefined === this.options.em  ) {
@@ -55,12 +54,16 @@ class callmanager {
     } catch( e ) {
       console.error( e )
     }
-    
 
-    if( false !== this.onnewcall ) {
+    if( this.onnewcall ) {
       try {
         await this.onnewcall( c )
       } catch( e ) {
+        /* auth failed or timed out excluded as this is noral(ish) */
+        if( 403 === e.code ) return
+        if( 408 === e.code ) return
+
+        console.trace( e )
         c.hangup( this.hangupcodes.SERVER_ERROR )
       }
     }
@@ -108,13 +111,14 @@ class callmanager {
 Is configured to use drachtio and registers emitter for presence.
 @return {callmanager}
 */
-let cm = false
+let cm
 module.exports.callmanager = ( options ) => {
-  if( false !== cm ) return cm
+  if( cm ) return cm
 
   assert( undefined !== options.srf )
   cm = new callmanager( options )
   call.setcallmanager( cm )
+  // @ts-ignore
   cm._use()
   return cm
 }

package/lib/sdp.js

@@ -82,8 +82,8 @@ const defaultaudiomedia = {
 
 /**
  * Takes a mixed input and outputs an array in the form [ "pcmu", "pcma" ]
- * @param { string | array<string|number> } codecarray
- * @return { array< string >}
+ * @param { string | Array<string|number> } codecarray
+ * @return { Array< string >}
  */
 function alltocodecname( codecarray ) {
 

package/lib/store.js

@@ -12,11 +12,6 @@ let storebyrealm = new Map()
  *  @param {string} c.uuid - uuid of the call
  *  @param {object} c.sip
  *  @param {string} c.sip.callid - the call id string
- *  @param {object} c.sip.tags - the local and remote tags
- *  @param {string} c.sip.tags.local - the local tag
- *  @param {string} c.sip.tags.remote - the remote tag
- *  @param {object} c.entity - entity object
- *  @param {object} c.entity.uri
  */
 function iscallobjectgood( c ) {
   if( "object" !== typeof c ) return false
@@ -67,8 +62,11 @@ function deletefromcallidset( c ) {
 
 /**
  * 
- * @param { object } c 
+ * @param { object } c
  * @param { object } c._entity
+ * @param { object } [ c._entity.uri ]
+ * @param { object } [ c._entity.username ]
+ * @param { object } [ c._entity.realm ]
  * @return { object | boolean } returns boolean if no further processing or entity object
  */
 function fixentity( c ) {
@@ -94,20 +92,21 @@ function fixentity( c ) {
 /**
  *  This can be called multiple times for the same call to store or update. Stores a
  *  call object in our store.
- *  @param {object} c - our call object.
- *  @param {string} c.uuid - uuid of the call
- *  @param {object} c.sip
- *  @param {string} c.sip.callid - the call id string
- *  @param {object} c.sip.tags - the local and remote tags
- *  @param {string} c.sip.tags.local - the local tag
- *  @param {string} c.sip.tags.remote - the remote tag
- *  @param {object} c.entity - entity object
- *  @param {object} c.entity.uri
- *  @param {object} c._entity
- *  @param {object} c.destination
- *  @param {object} [ c._state ]
- *  @param {boolean} [ c._state._hangup ]
- *  @return {Promise} - which resolves on completion (for future in case we support redis or similar)
+ *  @param { object } c - our call object.
+ *  @param { string } c.uuid - uuid of the call
+ *  @param { object } c.sip
+ *  @param { string } c.sip.callid - the call id string
+ *  @param { object } c.sip.tags - the local and remote tags
+ *  @param { string } c.sip.tags.local - the local tag
+ *  @param { string } c.sip.tags.remote - the remote tag
+ *  @param { object } c._entity
+ *  @param { object } [ c._entity.uri ]
+ *  @param { object } [ c._entity.username ]
+ *  @param { object } [ c._entity.realm ]
+ *  @param { object } c.destination
+ *  @param { object } [ c._state ]
+ *  @param { boolean } [ c._state._hangup ]
+ *  @return { Promise } - which resolves on completion (for future in case we support redis or similar)
  */
 module.exports.set = async ( c ) => {
   if( !iscallobjectgood( c ) ) return false
@@ -163,13 +162,14 @@ module.exports.getbyentity = async ( uri ) => {
  *  @param {string} realm - the entity realm
  *  @return {Promise} which resolves to either a set containing calls for this entity or undefined
  */
-module.exports.getbyrealm = async ( realm ) => {
+async function getbyrealm( realm ) {
   if( !storebyrealm.has( realm ) ) return false
   return storebyrealm.get( realm )
 }
 
 /* backwards compat - is now realm more generally */
-module.exports.getbyentityrealm = module.exports.getbyrealm
+module.exports.getbyrealm = getbyrealm
+module.exports.getbyentityrealm = getbyrealm
 
 /**
  *  Returns a unique call by call id and sip tags.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@babblevoice/babble-drachtio-callmanager",
-  "version": "2.3.7",
+  "version": "2.3.9",
   "description": "Call processing to create a PBX",
   "main": "index.js",
   "scripts": {
@@ -28,10 +28,15 @@
     "@babblevoice/projectrtp": "^2.3.7"
   },
   "devDependencies": {
-    "chai": "^4.3.4",
-    "eslint": "^8.42.0",
+    "@typescript-eslint/eslint-plugin": "^5.48.2",
+    "eslint": "^8.32.0",
+    "eslint-config-standard-with-typescript": "^30.0.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-n": "^15.6.1",
     "eslint-plugin-promise": "^6.1.1",
-    "mocha": "^9.2.2"
+    "mocha": "^9.2.2",
+    "chai": "^4.3.6",
+    "typescript": "^4.9.4"
   },
   "bugs": {
     "url": "https://github.com/tinpotnick/babble-drachtio-callmanager/issues"

package/test/interface/call.js

@@ -70,7 +70,7 @@ describe( "call object", function() {
     expect( call.state ).to.have.property( "destroyed" ).that.is.a( "boolean" ).to.be.true
 
     expect( call ).to.have.property( "children" ) // Set - how do you test?
-    expect( call ).to.have.property( "parent" ).that.is.a( "boolean" ).to.be.false
+    expect( call ).to.have.property( "parent" ).that.is.undefined
 
     expect( call ).to.have.property( "vars" ).that.is.a( "object" )
 
@@ -80,7 +80,7 @@ describe( "call object", function() {
     expect( call.epochs ).to.have.property( "endat" ).that.is.a( "number" )
 
     expect( call ).to.have.property( "channels" ).that.is.a( "object" )
-    expect( call.channels ).to.have.property( "audio" ).to.be.false
+    expect( call.channels ).to.have.property( "audio" ).to.be.undefined
 
     /* if uas */
     expect( call ).to.have.property( "network" ).that.is.a( "object" )
@@ -577,7 +577,7 @@ describe( "call object", function() {
       srfscenario.inbound()
     } )
 
-    c.on( "call.destroyed", ( c ) => {
+    c.on( "call.destroyed", ( /*c*/ ) => {
       eventhappened = true
     } )
 
@@ -597,7 +597,7 @@ describe( "call object", function() {
       eventhappened = true
     } )
 
-    srfscenario.options.em.on( "call.destroyed", ( c ) => {
+    srfscenario.options.em.on( "call.destroyed", ( /*c*/ ) => {
       eventhappened = false
     } )
 
@@ -650,7 +650,7 @@ describe( "call object", function() {
     c._req.msg.uri = "sip:bob@biloxi.com"
     c._req.setparsedheader( "from", { "params": { "tag": "767sf76wew" }, "uri": "sip:bob@biloxi.com", "host": "biloxi.com" } )
 
-    c._res.onsend( ( code, msg ) => {
+    c._res.onsend( ( code, /*msg*/ ) => {
 
       if( 407 == code ) {
 
@@ -773,7 +773,7 @@ describe( "call object", function() {
     const srfscenario = new srf.srfscenario( {} )
 
     let createuacoptions
-    srfscenario.oncreateUAC( ( contact, options, callbacks ) => {
+    srfscenario.oncreateUAC( ( contact, options, /*callbacks*/ ) => {
       createuacoptions = options
 
     } )
@@ -798,7 +798,7 @@ describe( "call object", function() {
     }
 
     let earlycallbackcalled = false
-    const c = await call.newuac( options, { "early": ( c ) => earlycallbackcalled = true } )
+    const c = await call.newuac( options, { "early": ( /*c*/ ) => earlycallbackcalled = true } )
 
     c.hangup()
 
@@ -814,7 +814,7 @@ describe( "call object", function() {
     }
 
     let earlycallbackcalled = false
-    const c = await call.newuac( options, { "confirm": ( c ) => earlycallbackcalled = true } )
+    const c = await call.newuac( options, { "confirm": ( /*c*/ ) => earlycallbackcalled = true } )
 
     c.hangup()