Merge branch 'master' into release

Author: James Criscuolo

package-lock.json

@@ -2,7 +2,7 @@
   "name": "sip.js",
   "title": "SIP.js",
   "description": "A simple, intuitive, and powerful JavaScript signaling library",
-  "version": "0.14.2",
+  "version": "0.14.3",
   "license": "MIT",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -47,7 +47,7 @@
     "ts-pegjs": "0.2.5",
     "tslint": "^5.17.0",
     "typescript": "^3.5.1",
-    "webpack": "^4.32.2",
+    "webpack": "^4.33.0",
     "webpack-cli": "^3.3.2"
   },
   "engines": {

package.json

@@ -1,19 +1,32 @@
 import { EventEmitter } from "events";
 
 import { C } from "./Constants";
-import { Body, IncomingResponseMessage, Logger, NameAddrHeader, OutgoingRequestMessage, URI } from "./core";
+import { Body, Grammar, IncomingResponseMessage, Logger, NameAddrHeader, OutgoingRequestMessage, URI } from "./core";
 import { TypeStrings } from "./Enums";
 import { BodyObj } from "./session-description-handler";
 import { UA } from "./UA";
 import { Utils } from "./Utils";
 
+export namespace ClientContext {
+  export interface Options {
+    body?: string;
+    contentType?: string;
+    extraHeaders?: Array<string>;
+    params?: {
+      fromUri?: string | URI;
+      toUri?: string | URI;
+      toDisplayName?: string;
+    };
+  }
+}
+
 export class ClientContext extends EventEmitter {
   public static initializer(
     objToConstruct: ClientContext,
     ua: UA,
     method: string,
     originalTarget: string | URI,
-    options?: any
+    options?: ClientContext.Options
   ): void {
     objToConstruct.type = TypeStrings.ClientContext;
 
@@ -30,6 +43,26 @@ export class ClientContext extends EventEmitter {
     if (!target) {
       throw new TypeError("Invalid target: " + originalTarget);
     }
+    let fromURI: URI | undefined = ua.userAgentCore.configuration.aor;
+    if (options && options.params && options.params.fromUri) {
+      fromURI =
+        (typeof options.params.fromUri === "string") ?
+          Grammar.URIParse(options.params.fromUri) :
+          options.params.fromUri;
+      if (!fromURI) {
+        throw new TypeError("Invalid from URI: " + options.params.fromUri);
+      }
+    }
+    let toURI: URI | undefined = target;
+    if (options && options.params && options.params.toUri) {
+      toURI =
+        (typeof options.params.toUri === "string") ?
+          Grammar.URIParse(options.params.toUri) :
+          options.params.toUri;
+      if (!toURI) {
+        throw new TypeError("Invalid to URI: " + options.params.toUri);
+      }
+    }
 
     /* Options
     * - extraHeaders
@@ -38,6 +71,7 @@ export class ClientContext extends EventEmitter {
     * - body
     */
     options = Object.create(options || Object.prototype);
+    options = options || {};
     const extraHeaders = (options.extraHeaders || []).slice();
     const params = options.params || {};
     let bodyObj: BodyObj | undefined;
@@ -57,8 +91,8 @@ export class ClientContext extends EventEmitter {
     objToConstruct.request = ua.userAgentCore.makeOutgoingRequestMessage(
       method,
       target,
-      params.fromUri ? params.fromUri : ua.userAgentCore.configuration.aor,
-      params.toUri ? params.toUri : target,
+      fromURI,
+      toURI,
       params,
       extraHeaders,
       body
@@ -86,7 +120,7 @@ export class ClientContext extends EventEmitter {
   public localIdentity!: NameAddrHeader;
   public remoteIdentity!: NameAddrHeader;
 
-  constructor(ua: UA, method: string, target: string | URI, options?: any) {
+  constructor(ua: UA, method: string, target: string | URI, options?: ClientContext.Options) {
     super();
 
     ClientContext.initializer(this, ua, method, target, options);

src/ClientContext.ts

@@ -1716,15 +1716,30 @@ export class InviteServerContext extends Session implements ServerContext {
 
 export namespace InviteClientContext {
   export interface Options {
+    /** Anonymous call if true. */
+    anonymous?: boolean;
+    /** Deprecated. */
+    body?: string;
+    /** Deprecated. */
+    contentType?: string;
     /** Array of extra headers added to the INVITE. */
     extraHeaders?: Array<string>;
     /** If true, send INVITE without SDP. */
     inviteWithoutSdp?: boolean;
-    /** Deprecated */
+    /** Deprecated. */
+    onInfo?: any;
+    /** Deprecated. */
     params?: {
-      toUri?: string;
-      toDisplayName: string;
+      fromDisplayName?: string;
+      fromTag?: string;
+      fromUri?: string | URI;
+      toDisplayName?: string;
+      toUri?: string | URI;
     };
+    /** Deprecated. */
+    renderbody?: string;
+    /** Deprecated. */
+    rendertype?: string;
     /** Options to pass to SessionDescriptionHandler's getDescription() and setDescription(). */
     sessionDescriptionHandlerOptions?: SessionDescriptionHandlerOptions;
   }
@@ -1743,7 +1758,12 @@ export class InviteClientContext extends Session implements ClientContext {
   private earlyMediaSessionDescriptionHandlers: Map<string, SessionDescriptionHandler>;
   private outgoingInviteRequest: OutgoingInviteRequest | undefined;
 
-  constructor(ua: UA, target: string | URI, options: any = {}, modifiers: any = []) {
+  constructor(
+    ua: UA,
+    target: string | URI,
+    options: InviteClientContext.Options = {},
+    modifiers: SessionDescriptionHandlerModifiers = []
+  ) {
     if (!ua.configuration.sessionDescriptionHandlerFactory) {
       ua.logger.warn("Can't build ISC without SDH Factory");
       throw new Error("ICC Constructor Failed");
@@ -1766,8 +1786,8 @@ export class InviteClientContext extends Session implements ClientContext {
 
     const extraHeaders: Array<string> = (options.extraHeaders || []).slice();
     if (anonymous && ua.configuration.uri) {
-      options.params.from_displayName = "Anonymous";
-      options.params.from_uri = "sip:[email protected]";
+      options.params.fromDisplayName = "Anonymous";
+      options.params.fromUri = "sip:[email protected]";
 
       extraHeaders.push("P-Preferred-Identity: " + ua.configuration.uri.toString());
       extraHeaders.push("Privacy: id");

src/Session.ts

@@ -150,7 +150,7 @@ export class UA extends EventEmitter {
       toString: (options?: any) => string
     };
   public status: UAStatus;
-  public transport: Transport | undefined;
+  public transport: Transport;
   public sessions: {[id: string]: InviteClientContext | InviteServerContext};
   public subscriptions: {[id: string]: Subscription};
   public data: any;
@@ -261,6 +261,14 @@ export class UA extends EventEmitter {
       throw e;
     }
 
+    if (!this.configuration.transportConstructor) {
+      throw new TransportError("Transport constructor not set");
+    }
+    this.transport = new this.configuration.transportConstructor(
+      this.getLogger("sip.transport"),
+      this.configuration.transportOptions
+    );
+
     const userAgentCoreConfiguration = makeUserAgentCoreConfigurationFromUA(this);
 
     // The Replaces header contains information used to match an existing
@@ -400,11 +408,9 @@ export class UA extends EventEmitter {
   public unregister(options?: any): this {
     this.configuration.register = false;
 
-    if (this.transport) {
-      this.transport.afterConnected(() => {
-        this.registerContext.unregister(options);
-      });
-    }
+    this.transport.afterConnected(() => {
+      this.registerContext.unregister(options);
+    });
 
     return this;
   }
@@ -432,20 +438,16 @@ export class UA extends EventEmitter {
     // Delay sending actual invite until the next 'tick' if we are already
     // connected, so that API consumers can register to events fired by the
     // the session.
-    if (this.transport) {
-      this.transport.afterConnected(() => {
-        context.invite();
-        this.emit("inviteSent", context);
-      });
-    }
+    this.transport.afterConnected(() => {
+      context.invite();
+      this.emit("inviteSent", context);
+    });
     return context;
   }
 
   public subscribe(target: string | URI, event: string, options: any): Subscription {
     const sub: Subscription = new Subscription(this, target, event, options);
-    if (this.transport) {
-      this.transport.afterConnected(() => sub.subscribe());
-    }
+    this.transport.afterConnected(() => sub.subscribe());
     return sub;
   }
 
@@ -462,11 +464,9 @@ export class UA extends EventEmitter {
   public publish(target: string | URI, event: string, body: string, options: any): PublishContext {
     const pub: PublishContext = new PublishContext(this, target, event, options);
 
-    if (this.transport) {
-      this.transport.afterConnected(() => {
-        pub.publish(body);
-      });
-    }
+    this.transport.afterConnected(() => {
+      pub.publish(body);
+    });
     return pub;
   }
 
@@ -494,9 +494,7 @@ export class UA extends EventEmitter {
   public request(method: string, target: string | URI, options?: any): ClientContext {
     const req: ClientContext = new ClientContext(this, method, target, options);
 
-    if (this.transport) {
-      this.transport.afterConnected(() => req.send());
-    }
+    this.transport.afterConnected(() => req.send());
     return req;
   }
 
@@ -549,9 +547,7 @@ export class UA extends EventEmitter {
     this.status = UAStatus.STATUS_USER_CLOSED;
 
     // Disconnect the transport and reset user agent core
-    if (this.transport) {
-      this.transport.disconnect();
-    }
+    this.transport.disconnect();
     this.userAgentCore.reset();
 
     if (typeof environment.removeEventListener === "function") {
@@ -574,24 +570,13 @@ export class UA extends EventEmitter {
     this.logger.log("user requested startup...");
     if (this.status === UAStatus.STATUS_INIT) {
       this.status = UAStatus.STATUS_STARTING;
-      if (!this.configuration.transportConstructor) {
-        throw new TransportError("Transport constructor not set");
-      }
-      this.transport = new this.configuration.transportConstructor(
-        this.getLogger("sip.transport"),
-        this.configuration.transportOptions
-      );
       this.setTransportListeners();
       this.emit("transportCreated", this.transport);
       this.transport.connect();
-
     } else if (this.status === UAStatus.STATUS_USER_CLOSED) {
       this.logger.log("resuming");
       this.status = UAStatus.STATUS_READY;
-      if (this.transport) {
-        this.transport.connect();
-      }
-
+      this.transport.connect();
     } else if (this.status === UAStatus.STATUS_STARTING) {
       this.logger.log("UA is in STARTING status, not opening new connection");
     } else if (this.status === UAStatus.STATUS_READY) {
@@ -701,11 +686,9 @@ export class UA extends EventEmitter {
    * Helper function. Sets transport listeners
    */
   private setTransportListeners(): void {
-    if (this.transport) {
-      this.transport.on("connected", () => this.onTransportConnected());
-      this.transport.on("message", (message: string) => this.onTransportReceiveMsg(message));
-      this.transport.on("transportError", () => this.onTransportError());
-    }
+    this.transport.on("connected", () => this.onTransportConnected());
+    this.transport.on("message", (message: string) => this.onTransportReceiveMsg(message));
+    this.transport.on("transportError", () => this.onTransportError());
   }
 
   /**
@@ -876,6 +859,8 @@ export class UA extends EventEmitter {
       transportConstructor: WebTransport,
       transportOptions: {},
 
+      usePreloadedRoute: false,
+
       // string to be inserted into User-Agent request header
       userAgentString: SIPConstants.USER_AGENT,
 
@@ -1236,6 +1221,12 @@ export class UA extends EventEmitter {
           }
         },
 
+        usePreloadedRoute: (usePreloadedRoute: boolean): boolean | undefined => {
+          if (typeof usePreloadedRoute === "boolean") {
+            return usePreloadedRoute;
+          }
+        },
+
         userAgentString: (userAgentString: string): string | undefined => {
           if (typeof userAgentString === "string") {
             return userAgentString;
@@ -1317,7 +1308,10 @@ export function makeUserAgentCoreConfigurationFromUA(ua: UA): UserAgentCoreConfi
   const contact = ua.contact;
   const displayName = ua.configuration.displayName ? ua.configuration.displayName : "";
   const hackViaTcp = ua.configuration.hackViaTcp ? true : false;
-  const routeSet = ua.configuration.usePreloadedRoute && ua.transport ? [ua.transport.server.sipUri] : [];
+  const routeSet =
+     ua.configuration.usePreloadedRoute && ua.transport.server && ua.transport.server.sipUri ?
+      [ua.transport.server.sipUri] :
+      [];
   const sipjsId = ua.configuration.sipjsId || Utils.createRandomToken(5);
 
   let supportedOptionTags: Array<string> = [];