@babblevoice/babble-drachtio-callmanager 2.3.28 → 3.0.0

package/index.js

@@ -13,7 +13,8 @@ const default_options = {
   "late": false,  /* Late negotiation */
   "registrar": false, /* our registrar object or falsey */
   "referauthrequired": true,
-  "ignoreipv6candidates": true /* ipv6 does not work in projectrtp */
+  "ignoreipv6candidates": true, /* ipv6 does not work in projectrtp */
+  "privacy": false
 }
 
 /**

package/lib/call.js

@@ -103,11 +103,24 @@ class SipError extends Error {
 
 /* Reverse codes - include inbound error codes.
 If not in this list we return REQUEST_TERMINATED during creation */
+/*
 const inboundsiperros = {
   486: hangupcodes.USER_BUSY,
   408: hangupcodes.REQUEST_TIMEOUT,
-  404: hangupcodes.UNALLOCATED_NUMBER
+  404: hangupcodes.UNALLOCATED_NUMBER,
+  603: hangupcodes.DECLINED
 }
+*/
+
+
+const inboundsiperros = {}
+const hangupcodeskeys = Object.keys( hangupcodes )
+for (let i = 0; i < hangupcodeskeys.length; i++) {
+  const key = hangupcodeskeys[ i ]
+  const value = hangupcodes[ key ]
+  inboundsiperros[ value.sip ] = value
+}
+
 
 let callmanager = {
   "options": {}
@@ -124,6 +137,8 @@ let callmanager = {
 
 class call {
 
+  #noack = false
+
   /**
   * Construct our call object with all defaults, including a default UUID.
   * @constructs call
@@ -138,8 +153,6 @@ class call {
     */
     this.type = "uac"
 
-    this.privacy = false
-
     /**
       @typedef { Object } callstate
       @property { boolean } trying
@@ -255,15 +268,6 @@ class call {
     */
     this._entity
 
-    /**
-    Override caller id or name.
-    @private
-    */
-    this._remote = {
-      "id": undefined,
-      "name": undefined
-    }
-
     /**
      * @summary contains network information regarding call
      */
@@ -327,25 +331,12 @@ class call {
     */
     this._em = new events.EventEmitter()
 
-    /**
-    * @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 { string } [ contactparams] 
-    * @property { number | true } [ autoanswer ] autoanswer true or delay
-    * @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 }
+     * @type { calloptions }
      */
     this.options = { ...callmanager.options }
+    this.options.headers = {}
 
     /**
     * @private
@@ -391,7 +382,7 @@ class call {
       const entitycalls = await callstore.getbyentity( this._entity.uri )
       let entitycallcount = 0
       if( false !== entitycalls ) entitycallcount = entitycalls.size
-  
+
       return {
         "username": this._entity.username,
         "realm": this._entity.realm,
@@ -412,7 +403,7 @@ class call {
     if(  !e.uri && !( e.username && e.realm )  ) return
     this._entity = e
 
-    this._entity.display = ""
+    if( !this._entity.display ) this._entity.display = ""
 
     if( this._entity.uri ) {
       if( !this._entity.username ) {
@@ -436,69 +427,6 @@ class call {
   @property { string } type - "callerid" | "calledid"
   */
 
-  /**
-   * Sets caller id
-   * @param { string } callerid
-   */
-  set callerid( callerid ) {
-    this._remote.id = callerid
-  }
-
-  /**
-   * Sets caller id name
-   * @param { string } calleridname
-   */
-  set calleridname( calleridname ) {
-    this._remote.name = calleridname
-  }
-
-  get callerid() {
-    return this._remote.id
-  }
-
-  get calleridname() {
-    return this._remote.name
-  }
-
-  /**
-   * 
-   * @returns { object }
-   */
-  #getremoteuac() {
-    /* "Display Name" <sip:0123456789@bling.babblevoice.com>;party=calling;screen=yes;privacy=off */
-    if( this._entity ) {
-      return {
-        "name": this._entity.display,
-        "uri": this._entity.uri,
-        "user": this._entity.username,
-        "host": this._entity.realm,
-        "privacy": this.privacy,
-        "type": "calledid"
-      }
-    }
-
-    if( this.options && this.options.contact ) {
-      const parseduri = parseuri( this.options.contact )
-      return {
-        "name": "",
-        "uri": this.options.contact,
-        "user": parseduri.user,
-        "host": parseduri.host,
-        "privacy": this.privacy,
-        "type": "calledid"
-      }
-    }
-
-    /* we shouldn't get here */
-    return {
-      "name": "",
-      "uri": "",
-      "user": "0000000000",
-      "host": "localhost.localdomain",
-      "privacy": this.privacy,
-      "type": "calledid"
-    }
-  }
 
   /**
    * 
@@ -531,47 +459,171 @@ class call {
   }
 
   /**
+   * Remember: this is from the perspective of us - not the phone. 
+   * The phone perspective is the opposite
+   * Inbound
+   * A call is received - i.e. we receive a SIP invite
    * 
-   * @returns { object }
+   * Outbound
+   * We make an outbound call. i.e. we send an INVITE
+   * 
+   * Exceptions
+   * clicktocall - we send an INVITE but that is an inbound call
+   * so the invite is i nthe opposie direction.
+   * @returns { "inbound" | "outbound" }
    */
-  // eslint-disable-next-line complexity
-  #getremoteuas() {
-    /* uas - inbound */
-    let parsed
-    if( this._entity ) {
-      return {
-        "name": this._remote.name?this._remote.name:(this._entity.display),
-        "uri": this._entity.uri,
-        "user": this._remote.id?this._remote.id:(this._entity.username),
-        "host": this._entity.realm,
-        "privacy": false,
-        "type": "callerid"
+  get direction() {
+    if( this.options.clicktocall ) return "inbound"
+    return "uas"==this.type?"inbound":"outbound"
+  }
+
+  /**
+   * Returns the called object. i.e.
+   * If we are inbound then this is the destination
+   * If we are outbound then this is the entity we are calling
+   * @returns { remoteid }
+   */
+  get calledid() {
+
+    const startingpoint = {
+      "name": "",
+      "uri": "",
+      "user": "0000000000",
+      "host": "localhost.localdomain",
+      "privacy": true === this.options.privacy,
+      "type": "calledid"
+    }
+
+    if( "outbound" === this.direction ) {
+      if( this.parent ) {
+        const dest = this.parent.destination
+        startingpoint.user = dest.user
+        startingpoint.host = dest.host
+      } else {
+        const dest = parseuri( this.options.contact )
+        startingpoint.user = dest.user
+        startingpoint.host = dest.host
+      }
+      
+    } else { /* inbound */
+      if( this.parent ) {
+        const dest = this.parent.destination
+        startingpoint.user = dest.user
+        startingpoint.host = dest.host
+      } else {
+        const dest = this.destination
+        startingpoint.user = dest.user
+        startingpoint.host = dest.host
       }
-    } else {
-      parsed = this.#getremotefromheaders()
     }
 
-    parsed = this.#fixparseduriobj( parsed )
+    startingpoint.privacy = this.options.privacy
 
-    return {
-      "name": this._remote.name?this._remote.name:( !parsed.name?"":parsed.name.replace( /['"]+/g, "" ) ),
-      "uri": parsed.uri,
-      "user": this._remote.id?this._remote.id:(parsed.user),
-      "host": parsed.host,
-      "privacy": "true" === parsed.params.privacy,
-      "type": "callerid"
+    if( this.options.calledid ) {
+      if( "number" in this.options.calledid ) {
+        startingpoint.user = this.options.calledid.number
+        startingpoint.uri = this.options.calledid.number + "@" + startingpoint.host
+      }
+      if( "name" in this.options.calledid ) startingpoint.name = this.options.calledid.name
     }
+
+    return startingpoint
   }
 
   /**
-  Returns the caller or called id, number, name and domains + privacy if set.
-  @returns { remoteid } remoteid
-  */
-  get remote() {
-    switch( this.type ) {
-    case "uac": return this.#getremoteuac()
-    default: return this.#getremoteuas()
+   * @returns { remoteid }
+   */
+  // eslint-disable-next-line complexity
+  get callerid() {
+
+    let startingpoint = {
+      "name": "",
+      "uri": "",
+      "user": "0000000000",
+      "host": "localhost.localdomain",
+      "privacy": true === this.options.privacy,
+      "type": "callerid"
+    }
+
+    if( "outbound" === this.direction ) {
+      if( this.parent ) {
+        startingpoint = this.parent.callerid
+      } else {
+        const parseduri = parseuri( this.options.contact )
+        if( parseduri.user ) {
+          startingpoint.uri = this.options.contact
+          startingpoint.user = parseduri.user
+          startingpoint.host = parseduri.host
+        }
+      }
+    } else { /* inbound */
+      if( this._entity ) {
+        startingpoint.name = this._entity.display
+        startingpoint.uri = this._entity.uri
+        startingpoint.user = this._entity.username
+        startingpoint.host = this._entity.realm
+      } else { 
+        let parsed = this.#getremotefromheaders()
+        parsed = this.#fixparseduriobj( parsed )
+
+        startingpoint.uri = parsed.uri
+        startingpoint.user = parsed.user
+        startingpoint.host = parsed.host
+      }
+    }
+
+    if( this.options.callerid ) {
+      if( "number" in this.options.callerid ) startingpoint.user = this.options.callerid.number
+      if( "name" in this.options.callerid ) startingpoint.name = this.options.callerid.name
+      if( "host" in this.options.callerid ) startingpoint.host = this.options.callerid.host
     }
+
+    return startingpoint
+  }
+
+  /**
+   * @param { string } c
+   */
+  set callerid( c ) {
+    if( !this.options.callerid ) this.options.callerid = {}
+    if( !this.options.callerid.number ) this.options.callerid.number = ""
+
+    this.options.callerid.number = c
+  }
+
+  /**
+   * @param { string } c
+   */
+  set calleridname( c ) {
+
+    if( !this.options.callerid ) this.options.callerid = {}
+    if( !this.options.callerid.name ) this.options.callerid.name = ""
+
+    this.options.callerid.name = c
+  }
+
+  /**
+   * @param { string } c
+   */
+  set calledid( c ) {
+
+    if( !this.options.calledid ) this.options.calledid = {}
+    if( !this.options.calledid.number ) this.options.calledid.number = ""
+    if( !this.options.calledid.name ) this.options.calledid.name = ""
+
+    this.options.calledid.number = c
+  }
+
+  /**
+   * @param { string } c
+   */
+  set calledidname( c ) {
+
+    if( !this.options.calledid ) this.options.calledid = {}
+    if( !this.options.calledid.number ) this.options.calledid.number = ""
+    if( !this.options.calledid.name ) this.options.calledid.name = ""
+
+    this.options.calledid.name = c
   }
 
   /**
@@ -845,6 +897,12 @@ class call {
   @type {call}
   */
 
+  /**
+  Emitted when a call is answered
+  @event call.updated
+  @type {call}
+  */
+
   /**
   Emitted when a call is mixed with another call (not after unhold as this has it's own event)
   @event call.mix
@@ -941,7 +999,7 @@ class call {
     this.children.add( other )
 
     /* maintain privacy */
-    other.privacy = this.privacy
+    other.options.privacy = this.options.privacy
 
     if( mix ) {
       this.channels.audio.mix( other.channels.audio )
@@ -1656,7 +1714,7 @@ class call {
    * @returns { Promise } resolves on timeout or when unmix happens
    * @private
    */
-  _hold( direction = "inactive" ) {
+  _hold( direction = "recvonly" ) {
 
     if( this.state.held ) return
     this.state.held = true
@@ -2356,13 +2414,16 @@ class call {
     /* Call outstanding resolves for promises - this will trigger out hangup promise also */
     resolves.forEach( r => r( this ) )
 
-    this._em.emit( "call.destroyed", this )
-    callmanager.options.em.emit( "call.destroyed", this )
-
-    this._em.emit( "call.reporting", this )
-    callmanager.options.em.emit( "call.reporting", this )
+    callstore.delete( this ).then( () => {
+      this._em.emit( "call.destroyed", this )
+      callmanager.options.em.emit( "call.destroyed", this )
+  
+      this._em.emit( "call.reporting", this )
+      callmanager.options.em.emit( "call.reporting", this )
 
-    this.removealllisteners()
+      this.removealllisteners()
+      return 0
+    } ).catch( () => {} )
   }
 
   /**
@@ -2392,8 +2453,6 @@ class call {
       await Promise.all( hangups )
     }
 
-    await callstore.delete( this )
-
     this._sethangupcause( src, reason )
 
     /* flag destroyed so when we receive our close event we know what to do */
@@ -2422,9 +2481,6 @@ class call {
       return
     }
     this._state._hangup = true
-
-    await callstore.delete( this )
-
     this._sethangupcause( "us", reason )
 
     if( this.state.established ) {
@@ -2468,10 +2524,15 @@ class call {
   /**
   * 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 ) {
+  async update() {
+
+    /* if we are asked to update it suggests we have received new information and overrides should go */
+    delete this.options.callerid
+    delete this.options.calledid
+
+    this._em.emit( "call.updated", this )
+    callmanager.options.em.emit( "call.updated", this )
 
     if( !this._dialog ) {
       console.trace( "Early update not currently supported" )
@@ -2488,77 +2549,23 @@ class call {
       requestoptions.body = this.sdp.local.toString()
     }
 
-    requestoptions.headers = {}
-    
-    let name = ""
-    let user = "0000000000"
-    let realm = "localhost.localdomain"
-
-    if( options && options.remote ) {
-      name = options.remote.display.replace( /[^\w\-\s']+/g, "" ) /* only allow alpa num whitespace and ' */
-      realm = options.remote.realm
-      user = options.remote.username
-    } else {
-      const other = this.other
-      if( other ) {
-        const remote = other.remote
-        name = remote.name.replace( /[^\w\-\s']+/g, "" ) /* only allow alpa num whitespace and ' */
-        realm = remote.host
-        user = remote.user
-      }
-    }
+    this.#configcalleridfornewuac()
 
-    /* RFC 3325 - should we also consider the P-Preferred-Identity header? */
-    const remoteid = `"${name}" <sip:${user}@${realm}>`
-    requestoptions.headers[ "P-Asserted-Identity" ] = remoteid
-    requestoptions.headers[ "FROM" ] = remoteid
+    this._dialog.request( { ...this.options, ...requestoptions } )
 
-    this._dialog.request( requestoptions )
     return true
   }
 
-  /**
-  @callback earlycallback
-  @param { call } call - our call object which is early
-  */
 
-  /**
-  @callback confirmcallback
-  @async
-  @param { call } call - our call object which is early
-  */
-
-  /**
-  @callback failcallback
-  @param { call } call - our call object which is early
-  */
 
   /**
-  @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 { 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 } [ 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
-  @param { failcallback } [ callbacks.fail ] - Called when child is terminated
-  @return { Promise< call | false > } - returns a promise which resolves to a new call object if a dialog has been confirmed. If none are confirmed ten return false. Each attempt is fed into callbacks.early.
-  */
+   * @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 { calloptions } [ options ] - Options object. See default_options in index.js for more details.
+   * @param { newuaccallbacks } [ callbacks ]
+   * @return { Promise< call | false > } - returns a promise which resolves to a new call object if a dialog has been confirmed. If none are confirmed ten return false. Each attempt is fed into callbacks.early.
+   */
   async newuac( options, callbacks = {} ) {
 
     /* If max-forwards is not specified then we decrement the parent and pass on */
@@ -2658,7 +2665,7 @@ class call {
         if( callbacks.confirm ) callbacks.confirm( c )
       }
     }
-    
+
     for( const contact of contactinfo.contacts ) {
       if( undefined === contact ) continue
       const newoptions = { ...options }
@@ -2728,7 +2735,7 @@ class call {
    */
   async #openchannelsfornewuac( channeldef = undefined ) {
     if( this.options.late ) {
-      this.options.noAck = true /* this is a MUST for late negotiation */
+      this.#noack = true /* this is a MUST for late negotiation */
     } else {
 
       await this.#openrelatedchannel( channeldef )
@@ -2749,9 +2756,6 @@ class call {
           .addicecandidates( this.channels.audio.local.address, this.channels.audio.local.port, this.channels.audio.local.icepwd )
           .rtcpmux()
       }
-
-      /* Create our SDP */
-      this.options.localSdp = this.sdp.local.toString()
     }
   }
 
@@ -2781,13 +2785,17 @@ class call {
 
     this.sip.tags.remote = this._dialog.sip.remoteTag
 
-    if( true === this.options.noAck ) {
+    if( true === this.#noack ) {
       await this._onlatebridge()
     } else {
       await this._onearlybridge()
     }
 
     if( callbacks.confirm ) await callbacks.confirm( this )
+
+    this._em.emit( "call.answered", this )
+    callmanager.options.em.emit( "call.answered", this )
+
     return this
   }
 
@@ -2810,55 +2818,26 @@ class call {
   }
 
   /**
-   * 
-   * @param { object } options 
+   * @returns { object }
    */
-  // eslint-disable-next-line complexity
-  #configcalleridfornewuac( options ) {
-    let name = ""
-    let user = "0000000000"
-    let realm = "localhost.localdomain"
-
-    if( options.parent ) {
-      const remote = options.parent.remote
-      if( remote ) {
-        name = remote.name.replace( /[^\w\-\s']+/g, "" ) /* only allow alpa num whitespace and ' */
-        realm = remote.host
-        user = remote.user
-      }
-      
-      if( this.parent.callerid ) {
-        if ( this.parent.callerid.number ) user = this.parent.callerid.number
-      }
+  #configcalleridfornewuac() {
 
-      if( this.parent.calleridname ) {
-        name = this.parent.calleridname
-      }
-    } else if( this._entity ) {
-      if( this._entity.username ) user = this._entity.username
-      if( this._entity.realm ) realm = this._entity.realm
-      if( this._entity.display ) name = this._entity.display
-    }
+    const callerid = this.callerid
+    const calleridstr = `"${callerid.name}" <sip:${callerid.user}@${callerid.host}>`
 
-    /* oveide caller id */
-    if( options.callerid ) {
-      if( options.callerid.number ) {
-        user = options.callerid.number
-        this.callerid = user
-      }
-
-      if( options.callerid.name ) {
-        name = options.callerid.name
-        this.calleridname = name
-      }
+    let privacy = ""
+    if( true === this.options.privacy ) {
+      privacy = ";privacy=full"
     }
 
-    const callerid = `"${name}" <sip:${user}@${realm}>`
-
-    this.options.headers[ "Remote-Party-ID" ] = callerid
-    this.options.headers[ "From" ] = callerid
+    /*
+      RFC 3325 - should we also consider the P-Preferred-Identity header?
+      P-Asserted-Identity?
+    */
+    this.options.headers[ "Remote-Party-ID" ] = calleridstr + ";party=calling;screen=yes" + privacy
+    this.options.headers[ "From" ] = calleridstr
 
-    return { user, realm }
+    return { user: callerid.user, realm: callerid.host }
   }
 
   /**
@@ -2869,6 +2848,8 @@ class call {
 
     const parts = parseuri( contactstr )
 
+    if( this.options.clicktocall ) this.options.autoanswer = true
+
     if( !this.options.contactparams ) this.options.contactparams = ""
     if( true === this.options.autoanswer ) {
       this.options.headers[ "Call-Info" ] = `<sip:${parts.host}>;answer-after=0`
@@ -2919,38 +2900,70 @@ class call {
   }
 
   /**
-  @summary Creates a new SIP dialog(s). 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 { call } [ options.parent ] - the parent call object
-  @param { string } [ options.contact ] - The contact string
-  @param { string } [ options.contactparams ] - additional params to add to the contact string in the invite
-  @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 { true | number } [ options.autoanswer ] - if true add call-info to auto answer, if number delay to add
-  @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 ]
-  @param { number } [ options.entity.max ] - if included no more than this number of calls for this entity (only if we look user up)
-  @param { number } [ options.entity.first ] - if multiple contacts for this entity use the first only
-  @param { object } [ options.callerid ]
-  @param { string } [ options.callerid.number ]
-  @param { string } [ options.callerid.name ]
-  @param { call  } [ options.bond ] - other channel to bond to for pottential channel pairing
-  @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
-  @param { failcallback } [ callbacks.fail ] - Called when child is terminated
-  @return { Promise< call | false > } - returns a promise which resolves to a new call object if a dialog has been confirmed. If none are confirmed then return false. Each attempt is fed into callbacks.early.
+   * @typedef { object } calloptions
+   * @property { call } [ parent ] - the parent call object
+   * @property { boolean } [ orphan ] - orphan this call once made
+   * @property { string } [ contact ] - The contact string
+   * @property { string } [ preferedcodecs ] as it says
+   * @property { boolean } [ rfc2833 ] if set to true enable 2833
+   * @property { string } [ contactparams ] - additional params to add to the contact string in the invite
+   * @property { object } [ auth ]
+   * @property { string } [ auth.username ] - If SIP auth required username
+   * @property { string } [ auth.password ] - If SIP auth required password
+   * @property { object } [ headers ] - Object containing extra sip headers required.
+   * @property { object } [ uactimeout ] - override the deault timeout
+   * @property { true | number } [ autoanswer ] - if true add call-info to auto answer, if number delay to add
+   * @property { boolean } [ clicktocall ] - if set to true, will set autoanswer to true and swap the source and desination on caller ID
+   * @property { boolean } [ late ] - late negotiation
+   * @property { boolean } [ privacy ] - sets the privacy
+   * @property { entity } [ entity ] - used to store this call against and look up a contact string if not supplied.
+   * @property { object } [ entity ]
+   * @property { string } [ entity.username ]
+   * @property { string } [ entity.realm ]
+   * @property { string } [ entity.uri ]
+   * @property { number } [ entity.max ] - if included no more than this number of calls for this entity (only if we look user up)
+   * @property { number } [ entity.first ] - if multiple contacts for this entity use the first only
+   * @property { object } [ callerid ]
+   * @property { string } [ callerid.number ]
+   * @property { string } [ callerid.name ]
+   * @property { string } [ callerid.host ]
+   * @property { object } [ calledid ]
+   * @property { string } [ calledid.number ]
+   * @property { string } [ calledid.name ]
+   * @property { call  } [ bond ] - other channel to bond to for pottential channel pairing
+   */
+
+  /**
+  * @callback earlycallback
+  * @param { call } call - our call object which is early
   */
+
+  /**
+   * @callback confirmcallback
+   * @async
+   * @param { call } call - our call object which is early
+   */
+
+  /**
+   * @callback failcallback
+   * @param { call } call - our call object which is early
+   */
+
+  /**
+   * @typedef { object } newuaccallbacks
+   * @property { earlycallback } [ early ] - callback to provide a call object with early call (pre dialog)
+   * @property { confirmcallback } [ 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
+   * @property { failcallback } [ fail ] - Called when child is terminated
+   */
+
+  /**
+   * @summary Creates a new SIP dialog(s). 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 { calloptions } [ options ] - Options object. See default_options in index.js for more details.
+   * @param { newuaccallbacks } [ callbacks ]
+   * @return { Promise< call | false > } - returns a promise which resolves to a new call object if a dialog has been confirmed. If none are confirmed then return false. Each attempt is fed into callbacks.early.
+   */
   static async newuac( options, callbacks = {} ) {
 
     if( !options.contact && !options.entity ) return false
@@ -2969,31 +2982,19 @@ class call {
 
     newcall.bond( options.bond )
 
-    newcall.options = {
-      headers: { ...options.headers }
-    }
-
     if( options.entity ) {
       newcall.entity = options.entity
       callstore.set( newcall )
     }
 
-    if( options.privacy ) this.privacy = true
-
-    newcall.#configcalleridfornewuac( options )
-
-    // Polycom
-    // Alert-Info: <https://www.babblevoice.com/polycom/LoudRing.wav>
-    // Vtech
-    // Alert-Info: <http://www.babblevoice.com>;info=ringer2
-    
-
     // spread is not recursive
+    newcall.options = { ...newcall.options, ...options }
     const tmpheaders =  { ...callmanager.options.headers, ...newcall.options.headers, ...options.headers }
-    newcall.options = { ...callmanager.options, ...newcall.options, ...options }
     newcall.options.headers = tmpheaders
+
+    newcall.#configcalleridfornewuac()
     newcall.import()
-    
+
     newcall.#configautoanswerfornewuac( options.contact )
 
     newcall.options.headers[ "Allow-Events" ] = "talk, hold, presence, as-feature-event, dialog, call-info, sla, include-session-description, message-summary, refer"
@@ -3005,56 +3006,59 @@ class call {
 
     let newdialog
     try {
-      newdialog = await callmanager.options.srf.createUAC( options.contact + newcall.options.contactparams, newcall.options, {
-        cbRequest: ( err, req ) => {
-
-          if( !req ) {
-            newcall.state.destroyed = true
-            newcall.hangup( hangupcodes.SERVER_ERROR )
-            console.trace( "No req object??", err )
-            return
-          }
-
-          /* set new uac timeout */
-          newcall.uactimeout = newcall.options.uactimeout
-
-          /* extend our parent ring timeout if necasary */
-          if( options.parent ) {
-            options.parent.uactimeout = Math.max( callmanager.options.uactimeout, newcall.options.uactimeout )
+      newdialog = await callmanager.options.srf.createUAC( 
+        options.contact + newcall.options.contactparams, 
+        { ...newcall.options, ...{ localSdp: newcall.sdp.local?newcall.sdp.local.toString():"" } }, {
+
+          cbRequest: ( err, req ) => {
+
+            if( !req ) {
+              newcall.state.destroyed = true
+              newcall.hangup( hangupcodes.SERVER_ERROR )
+              console.trace( "No req object??", err )
+              return
+            }
+
+            /* set new uac timeout */
+            newcall.uactimeout = newcall.options.uactimeout
+
+            /* extend our parent ring timeout if necasary */
+            if( options.parent ) {
+              options.parent.uactimeout = Math.max( callmanager.options.uactimeout, newcall.options.uactimeout )
+            }
+
+            newcall._req = req
+            newcall.state.trying = true
+
+            newcall.sip = {
+              "callid": req.getParsedHeader( "call-id" ),
+              "tags": {
+                "local": req.getParsedHeader( "from" ).params.tag,
+                "remote": ""
+              },
+              "contact": [ { "uri": options.contact } ]
+            }
+
+            callstore.set( newcall )
+            if( callbacks && callbacks.early ) callbacks.early( newcall )
+            callmanager.options.em.emit( "call.new", newcall )
+          },
+          cbProvisional: async ( res ) => {
+            newcall._res = res
+
+            newcall.parseallow( res )
+
+            if( 180 === res.status ) {
+              newcall._onring()
+            } else if( 183 === res.status ) {
+              await newcall._onearly()
+            }
+
+            if( newcall.canceled ) {
+              newcall.hangup()
+            }
           }
-
-          newcall._req = req
-          newcall.state.trying = true
-
-          newcall.sip = {
-            "callid": req.getParsedHeader( "call-id" ),
-            "tags": {
-              "local": req.getParsedHeader( "from" ).params.tag,
-              "remote": ""
-            },
-            "contact": [ { "uri": options.contact } ]
-          }
-
-          callstore.set( newcall )
-          if( callbacks && callbacks.early ) callbacks.early( newcall )
-          callmanager.options.em.emit( "call.new", newcall )
-        },
-        cbProvisional: async ( res ) => {
-          newcall._res = res
-
-          newcall.parseallow( res )
-
-          if( 180 === res.status ) {
-            newcall._onring()
-          } else if( 183 === res.status ) {
-            await newcall._onearly()
-          }
-
-          if( newcall.canceled ) {
-            newcall.hangup()
-          }
-        }
-      } )
+        } )
     } catch ( err ) {
       newcall.#onnewuaccatch( err )
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@babblevoice/babble-drachtio-callmanager",
-  "version": "2.3.28",
+  "version": "3.0.0",
   "description": "Call processing to create a PBX",
   "main": "index.js",
   "scripts": {

package/test/interface/call.js

@@ -786,7 +786,7 @@ describe( "call object", function() {
     await call.newuac( options, { "early": ( c ) => c.hangup() } )
 
     expect( createuacoptions.headers[ "Remote-Party-ID" ] ).to.equal( "\"\" <sip:0000000000@localhost.localdomain>" )
-    expect( createuacoptions.noAck ).to.be.true
+    expect( createuacoptions.late ).to.be.true
   } )
 
   it( "uas.newuac - early callback is called", async function() {

package/test/mock/srf.js

@@ -7,7 +7,7 @@ const events = require( "events" )
 const call = require( "../../lib/call.js" )
 const callmanager = require( "../../index.js" )
 
-let possiblesdp = [
+const possiblesdp = [
   `v=0
 o=Z 1610744131900 1 IN IP4 127.0.0.1
 s=Z
@@ -23,7 +23,7 @@ a=fmtp:101 0-16
 a=rtpmap:18 G729/8000
 a=fmtp:18 annexb=no
 a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n"),
-`v=0
+  `v=0
 o=- 1608235282228 0 IN IP4 127.0.0.1
 s=
 c=IN IP4 192.168.0.141
@@ -32,7 +32,7 @@ m=audio 20000 RTP/AVP 8 101
 a=rtpmap:101 telephone-event/8000
 a=fmtp:101 0-16
 a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n"),
-`v=0
+  `v=0
 o=- 1608235282228 0 IN IP4 127.0.0.1
 s=
 c=IN IP4 192.168.0.141
@@ -41,7 +41,7 @@ m=audio 20000 RTP/AVP 0 101
 a=rtpmap:101 telephone-event/8000
 a=fmtp:101 0-16
 a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n"),
-`v=0
+  `v=0
 o=- 1608235282228 0 IN IP4 127.0.0.1
 s=
 c=IN IP4 192.168.0.141
@@ -52,7 +52,7 @@ a=rtpmap:101 telephone-event/8000
 a=fmtp:101 0-16
 a=fmtp:97 mode=20
 a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n"),
-`v=0
+  `v=0
 o=Z 1610744131900 1 IN IP4 127.0.0.1
 s=Z
 c=IN IP4 192.168.0.200
@@ -67,7 +67,7 @@ a=fmtp:101 0-16
 a=rtpmap:18 G729/8000
 a=fmtp:18 annexb=no
 a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n"),
-`v=0
+  `v=0
 o=Z 1610744131900 1 IN IP4 127.0.0.1
 s=Z
 c=IN IP4 192.168.0.200
@@ -86,7 +86,7 @@ a=fmtp:97 mode=20
 a=sendrecv`.replace(/(\r\n|\n|\r)/gm, "\r\n")
 ]
 
-let possiblesavpsdp = [
+const possiblesavpsdp = [
   `v=0
 o=- 6278233949897424941 2 IN IP4 127.0.0.1
 s=-
@@ -130,7 +130,7 @@ a=rtpmap:113 telephone-event/16000
 a=rtpmap:126 telephone-event/8000
 a=ssrc:3789235955 cname:k129XMgcWznC/heR
 a=ssrc:3789235955 msid:Aq3uReW2RJFKkrlg942QblHcszboGZx9dhvK eaa81692-2187-4303-8e59-ed1bcb9591ee`.replace(/(\r\n|\n|\r)/gm, "\r\n"),
-`v=0
+  `v=0
 o=- 6278233949897424941 2 IN IP4 127.0.0.1
 s=-
 t=0 0
@@ -218,8 +218,8 @@ class req {
 
     /* copied object structure from srf */
     this.setparsedheader( "from", {
-    "uri": "sip:1000@dummy.com;transport=UDP",
-    "params": {
+      "uri": "sip:1000@dummy.com;transport=UDP",
+      "params": {
         "tag": crypto.randomBytes( 5 ).toString( "hex" )
       }
     } )
@@ -306,7 +306,7 @@ class dialog {
 
     let fromtag = ""
     if( req ) {
-      let from = req.getParsedHeader( "from" )
+      const from = req.getParsedHeader( "from" )
       fromtag = from.params.tag
     }
 
@@ -392,7 +392,7 @@ class srf {
 
   async createUAC( contact, options, callbacks ) {
     this._createuaccount++
-    let _req = new req()
+    const _req = new req()
 
     /* create a default */
     callbacks.cbRequest( {}, _req )
@@ -401,7 +401,7 @@ class srf {
       return this.callbacks.createuac( contact, options, callbacks )
     }
 
-    if( this.newuactimeout > 0 ) {
+    if( 0 < this.newuactimeout ) {
       await new Promise( ( resolve ) => { setTimeout( () => resolve(), this.newuactimeout ) } )
     }
 
@@ -432,7 +432,7 @@ class srfscenario {
       "call": false
     }
 
-    let defaultoptions = {
+    const defaultoptions = {
       "method": "invite",
       "uacsdp": possiblesdp[ 0 ],
       "uassdp": possiblesdp[ 1 ]

package/test/unit/call.js

@@ -22,8 +22,8 @@ describe( "call.js", function() {
 
     // TODO we set the remote id using "setremoteid", but getter returns it as "user" 
     // the names mismatch and can be confusing, we might consider some polishing here?
-    expect(call.remote.name).equals("foo")
-    expect(call.remote.user).equals("123456789")
+    expect(call.callerid.name).equals("foo")
+    expect(call.callerid.user).equals("123456789")
     expect( newcallcalled ).to.be.true
 
     await call.hangup()