Subscribe support

.eslintrc.js

@@ -139,6 +139,7 @@ module.exports =
 		'no-sparse-arrays': 2,
 		'no-this-before-super': 2,
 		'no-throw-literal': 2,
+		'no-trailing-spaces': 2,
 		'no-undef': 2,
 		'no-unexpected-multiline': 2,
 		'no-unmodified-loop-condition': 2,

CHANGELOG.md

@@ -3,7 +3,17 @@ CHANGELOG
 
 ### NEXT RELEASE
 
+* New UA config param register_from_tag_trail (#793). Credits to @kkozlik.
+
+
+### 3.10.1
+
 * TS: fix socket/transport types (#790).
+* Transport: Handle keep alive request from server (#791).
+* Prevent repeated ICE finish (#800). Credits to @pschichtel .
+* Use built-in MediaStreamConstraints type (#809). Credits to @edumt.
+* Add extra_headers as a modificable property (#825). Credits to @cesterlizi.
+* Fix type definitions to not import Listener from events #837. Credits to @jlaine.
 
 
 ### 3.10.0

dist/jssip.js

@@ -1,7 +1,7 @@
 /*
- * JsSIP v3.10.0
+ * JsSIP v3.10.1
  * the Javascript SIP library
- * Copyright: 2012-2022 
+ * Copyright: 2012-2023 
  * Homepage: https://jssip.net
  * License: MIT
  */
@@ -19049,6 +19049,10 @@ module.exports = /*#__PURE__*/function (_EventEmitter) {
           _this13._iceReady = false;
 
           var ready = function ready() {
+            if (finished) {
+              return;
+            }
+
             connection.removeEventListener('icecandidate', iceCandidateListener);
             connection.removeEventListener('icegatheringstatechange', iceGatheringStateListener);
             finished = true;
@@ -19075,12 +19079,12 @@ module.exports = /*#__PURE__*/function (_EventEmitter) {
                 candidate: candidate,
                 ready: ready
               });
-            } else if (!finished) {
+            } else {
               ready();
             }
           });
           connection.addEventListener('icegatheringstatechange', iceGatheringStateListener = function iceGatheringStateListener() {
-            if (connection.iceGatheringState === 'complete' && !finished) {
+            if (connection.iceGatheringState === 'complete') {
               ready();
             }
           });
@@ -23854,7 +23858,21 @@ module.exports = /*#__PURE__*/function () {
   }, {
     key: "_onData",
     value: function _onData(data) {
-      // CRLF Keep Alive response from server. Ignore it.
+      // CRLF Keep Alive request from server, reply.
+      if (data === '\r\n\r\n') {
+        logger.debug('received message with double-CRLF Keep Alive request');
+
+        try {
+          // Reply with single CRLF.
+          this.socket.send('\r\n');
+        } catch (error) {
+          logger.warn("error sending Keep Alive response: ".concat(error));
+        }
+
+        return;
+      } // CRLF Keep Alive response from server, ignore it.
+
+
       if (data === '\r\n') {
         logger.debug('received message with CRLF Keep Alive response');
         return;
@@ -24332,6 +24350,12 @@ module.exports = /*#__PURE__*/function (_EventEmitter) {
             break;
           }
 
+        case 'extra_headers':
+          {
+            this._configuration.extra_headers = value;
+            break;
+          }
+
         default:
           logger.warn('set() | cannot set "%s" parameter in runtime', parameter);
           return false;
@@ -24780,7 +24804,7 @@ module.exports = /*#__PURE__*/function (_EventEmitter) {
         }
       }; // Seal the configuration.
 
-      var writable_parameters = ['authorization_user', 'password', 'realm', 'ha1', 'authorization_jwt', 'display_name', 'register'];
+      var writable_parameters = ['authorization_user', 'password', 'realm', 'ha1', 'authorization_jwt', 'display_name', 'register', 'extra_headers'];
 
       for (var parameter in this._configuration) {
         if (Object.prototype.hasOwnProperty.call(this._configuration, parameter)) {
@@ -28340,7 +28364,7 @@ module.exports={
   "name": "jssip",
   "title": "JsSIP",
   "description": "the Javascript SIP library",
-  "version": "3.10.0",
+  "version": "3.10.1",
   "homepage": "https://jssip.net",
   "contributors": [
     "José Luis Millán <[email protected]> (https://github.com/jmillan)",

gulpfile.js

@@ -105,7 +105,8 @@ gulp.task('test', function()
     'test/test-parser.js',
     'test/test-properties.js',
     'test/test-UA-no-WebRTC.js',
-    'test/test-digestAuthentication.js'
+    'test/test-digestAuthentication.js',
+    'test/test-UA-subscriber-notifier.js'
   ];
 
   return gulp.src(src)

lib/Config.js

@@ -32,9 +32,10 @@ exports.settings = {
   no_answer_timeout              : 60,
 
   // Registration parameters.
-  register         : true,
-  register_expires : 600,
-  registrar_server : null,
+  register                : true,
+  register_expires        : 600,
+  register_from_tag_trail : '',
+  registrar_server        : null,
 
   // Connection options.
   sockets                          : null,
@@ -282,6 +283,16 @@ const checks = {
       }
     },
 
+    register_from_tag_trail(register_from_tag_trail)
+    {
+      if (typeof register_from_tag_trail === 'function')
+      {
+        return register_from_tag_trail;
+      }
+
+      return String(register_from_tag_trail);
+    },
+
     registrar_server(registrar_server)
     {
       if (!/^sip:/i.test(registrar_server))

lib/Constants.d.ts

@@ -57,7 +57,7 @@ export declare enum DTMF_TRANSPORT {
 }
 
 export const REASON_PHRASE: Record<number, string>
-export const ALLOWED_METHODS = 'INVITE,ACK,CANCEL,BYE,UPDATE,MESSAGE,OPTIONS,REFER,INFO,NOTIFY'
+export const ALLOWED_METHODS = 'INVITE,ACK,CANCEL,BYE,UPDATE,MESSAGE,OPTIONS,REFER,INFO,NOTIFY,SUBSCRIBE'
 export const ACCEPTED_BODY_TYPES = 'application/sdp, application/dtmf-relay'
 export const MAX_FORWARDS = 69
 export const SESSION_EXPIRES = 90

lib/Constants.js

@@ -149,7 +149,7 @@ module.exports = {
     606 : 'Not Acceptable'
   },
 
-  ALLOWED_METHODS                  : 'INVITE,ACK,CANCEL,BYE,UPDATE,MESSAGE,OPTIONS,REFER,INFO,NOTIFY',
+  ALLOWED_METHODS                  : 'INVITE,ACK,CANCEL,BYE,UPDATE,MESSAGE,OPTIONS,REFER,INFO,NOTIFY,SUBSCRIBE',
   ACCEPTED_BODY_TYPES              : 'application/sdp, application/dtmf-relay',
   MAX_FORWARDS                     : 69,
   SESSION_EXPIRES                  : 90,

lib/Notifier.d.ts

@@ -0,0 +1,24 @@
+import {EventEmitter} from 'events'
+import {SUBSCRIBE, NOTIFY} from './Constants'
+import * as Utils from './Utils'
+
+declare enum NotifierTerminatedCode {
+    NOTIFY_RESPONSE_TIMEOUT = 0, 
+    NOTIFY_TRANSPORT_ERROR = 1, 
+    NOTIFY_NON_OK_RESPONSE = 2, 
+    NOTIFY_FAILED_AUTHENTICATION = 3,
+    SEND_FINAL_NOTIFY = 4, 
+    RECEIVE_UNSUBSCRIBE = 5, 
+    SUBSCRIPTION_EXPIRED = 6  
+}
+
+export class Notifier extends EventEmitter {
+  start(): void;
+  setActiveState(): void;
+  notify(body?: string): void; 
+  terminate(body?: string, reason?: string): void; 
+  get state(): string;
+  get id(): string;
+  static get C(): typeof NotifierTerminatedCode;
+  get C(): typeof NotifierTerminatedCode;
+}