ue-softphone-sdk 4.0.0 → 4.0.2

package/src/lib/sip.js/grammar/uri.ts

@@ -1,370 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { Parameters } from "./parameters";
-
-interface URIObject {
-  scheme: string;
-  user: string | undefined;
-  host: string;
-  port: number | undefined;
-}
-
-/**
- * URI.
- * @public
- */
-export class URI extends Parameters {
-  public headers: {[name: string]: Array<string>} = {};
-  private normal: URIObject;
-  private raw: URIObject;
-
-  /**
-   * Constructor
-   * @param scheme -
-   * @param user -
-   * @param host -
-   * @param port -
-   * @param parameters -
-   * @param headers -
-   */
-  constructor(
-    scheme = "sip",
-    user: string,
-    host: string,
-    port?: number,
-    parameters?: { [name: string]: string | number | null },
-    headers?: {[name: string]: Array<string>}
-  ) {
-    super(parameters || {});
-    // Checks
-    if (!host) {
-      throw new TypeError('missing or invalid "host" parameter');
-    }
-
-    for (const header in headers) {
-      // eslint-disable-next-line no-prototype-builtins
-      if (headers.hasOwnProperty(header)) {
-        this.setHeader(header, headers[header]);
-      }
-    }
-
-    // Raw URI
-    this.raw = {
-      scheme,
-      user,
-      host,
-      port
-    };
-
-    // Normalized URI
-    this.normal = {
-      scheme: scheme.toLowerCase(),
-      user,
-      host: host.toLowerCase(),
-      port
-    };
-  }
-
-  get scheme(): string { return this.normal.scheme; }
-  set scheme(value: string) {
-    this.raw.scheme = value;
-    this.normal.scheme = value.toLowerCase();
-  }
-
-  get user(): string | undefined { return this.normal.user; }
-  set user(value: string | undefined) {
-    this.normal.user = this.raw.user = value;
-  }
-
-  get host(): string { return this.normal.host; }
-  set host(value: string) {
-    this.raw.host = value;
-    this.normal.host = value.toLowerCase();
-  }
-
-  get aor(): string { return this.normal.user + "@" + this.normal.host; }
-
-  get port(): number | undefined { return this.normal.port; }
-  set port(value: number | undefined) {
-    this.normal.port = this.raw.port = value === 0 ? value : value;
-  }
-
-  public setHeader(name: string, value: Array<string> | string): void {
-    this.headers[this.headerize(name)] = (value instanceof Array) ? value : [value];
-  }
-
-  public getHeader(name: string): Array<string> | undefined {
-    if (name) {
-      return this.headers[this.headerize(name)];
-    }
-  }
-
-  public hasHeader(name: string): boolean {
-    // eslint-disable-next-line no-prototype-builtins
-    return !!name && !!this.headers.hasOwnProperty(this.headerize(name));
-  }
-
-  public deleteHeader(header: string): Array<string> | undefined {
-    header = this.headerize(header);
-
-    // eslint-disable-next-line no-prototype-builtins
-    if (this.headers.hasOwnProperty(header)) {
-      const value = this.headers[header];
-      delete this.headers[header];
-      return value;
-    }
-  }
-
-  public clearHeaders(): void {
-    this.headers = {};
-  }
-
-  public clone(): URI {
-    return new URI(
-      this._raw.scheme,
-      this._raw.user || "",
-      this._raw.host,
-      this._raw.port,
-      JSON.parse(JSON.stringify(this.parameters)),
-      JSON.parse(JSON.stringify(this.headers)));
-  }
-
-  public toRaw(): string {
-    return this._toString(this._raw);
-  }
-
-  public toString(): string {
-    return this._toString(this._normal);
-  }
-
-  private get _normal(): URIObject { return this.normal; }
-
-  private get _raw(): URIObject { return this.raw; }
-
-  private _toString(uri: any): string {
-    let uriString: string  = uri.scheme + ":";
-    // add slashes if it's not a sip(s) URI
-    if (!uri.scheme.toLowerCase().match("^sips?$")) {
-      uriString += "//";
-    }
-    if (uri.user) {
-      uriString += this.escapeUser(uri.user) + "@";
-    }
-    uriString += uri.host;
-    if (uri.port || uri.port === 0) {
-      uriString += ":" + uri.port;
-    }
-
-    for (const parameter in this.parameters) {
-      // eslint-disable-next-line no-prototype-builtins
-      if (this.parameters.hasOwnProperty(parameter)) {
-        uriString += ";" + parameter;
-
-        if (this.parameters[parameter] !== null) {
-          uriString += "=" + this.parameters[parameter];
-        }
-      }
-    }
-
-    const headers: Array<string> = [];
-    for (const header in this.headers) {
-      // eslint-disable-next-line no-prototype-builtins
-      if (this.headers.hasOwnProperty(header)) {
-        // eslint-disable-next-line @typescript-eslint/no-for-in-array
-        for (const idx in this.headers[header]) {
-          // eslint-disable-next-line no-prototype-builtins
-          if (this.headers[header].hasOwnProperty(idx)) {
-            headers.push(header + "=" + this.headers[header][idx]);
-          }
-        }
-      }
-    }
-
-    if (headers.length > 0) {
-      uriString += "?" + headers.join("&");
-    }
-
-    return uriString;
-  }
-
-  /*
-   * Hex-escape a SIP URI user.
-   * @private
-   * @param {String} user
-   */
-  private escapeUser(user: string): string {
-    let decodedUser: string;
-
-    // FIXME: This is called by toString above which should never throw, but
-    // decodeURIComponent can throw and I've seen one case in production where
-    // it did throw resulting in a cascading failure. This class should be
-    // fixed so that decodeURIComponent is not called at this point (in toString).
-    // The user should be decoded when the URI is constructor or some other
-    // place where we can catch the error before the URI is created or somesuch.
-    // eslint-disable-next-line no-useless-catch
-    try {
-      decodedUser = decodeURIComponent(user);
-    } catch (error) {
-      throw error;
-    }
-
-    // Don't hex-escape ':' (%3A), '+' (%2B), '?' (%3F"), '/' (%2F).
-    return encodeURIComponent(decodedUser)
-      .replace(/%3A/ig, ":")
-      .replace(/%2B/ig, "+")
-      .replace(/%3F/ig, "?")
-      .replace(/%2F/ig, "/");
-  }
-
-  private headerize(str: string): string {
-    const exceptions: any = {
-      "Call-Id": "Call-ID",
-      "Cseq": "CSeq",
-      "Min-Se": "Min-SE",
-      "Rack": "RAck",
-      "Rseq": "RSeq",
-      "Www-Authenticate": "WWW-Authenticate",
-    };
-    const name: Array<string> = str.toLowerCase().replace(/_/g, "-").split("-");
-    const parts: number = name.length;
-    let hname = "";
-
-    for (let part = 0; part < parts; part++) {
-      if (part !== 0) {
-        hname += "-";
-      }
-      hname += name[part].charAt(0).toUpperCase() + name[part].substring(1);
-    }
-    if (exceptions[hname]) {
-      hname = exceptions[hname];
-    }
-    return hname;
-  }
-}
-
-/**
- * Returns true if URIs are equivalent per RFC 3261 Section 19.1.4.
- * @param a URI to compare
- * @param b URI to compare
- *
- * @remarks
- * 19.1.4 URI Comparison
- * Some operations in this specification require determining whether two
- * SIP or SIPS URIs are equivalent.
- *
- * https://tools.ietf.org/html/rfc3261#section-19.1.4
- * @internal
- */
-export function equivalentURI(a: URI, b: URI): boolean {
-
-  // o  A SIP and SIPS URI are never equivalent.
-  if (a.scheme !== b.scheme) {
-    return false;
-  }
-
-  // o  Comparison of the userinfo of SIP and SIPS URIs is case-
-  //    sensitive.  This includes userinfo containing passwords or
-  //    formatted as telephone-subscribers.  Comparison of all other
-  //    components of the URI is case-insensitive unless explicitly
-  //    defined otherwise.
-  //
-  // o  The ordering of parameters and header fields is not significant
-  //    in comparing SIP and SIPS URIs.
-  //
-  // o  Characters other than those in the "reserved" set (see RFC 2396
-  //    [5]) are equivalent to their ""%" HEX HEX" encoding.
-  //
-  // o  An IP address that is the result of a DNS lookup of a host name
-  //    does not match that host name.
-  //
-  // o  For two URIs to be equal, the user, password, host, and port
-  //    components must match.
-  //
-  // A URI omitting the user component will not match a URI that
-  // includes one.  A URI omitting the password component will not
-  // match a URI that includes one.
-  //
-  // A URI omitting any component with a default value will not
-  // match a URI explicitly containing that component with its
-  // default value.  For instance, a URI omitting the optional port
-  // component will not match a URI explicitly declaring port 5060.
-  // The same is true for the transport-parameter, ttl-parameter,
-  // user-parameter, and method components.
-  //
-  // Defining sip:user@host to not be equivalent to
-  // sip:user@host:5060 is a change from RFC 2543.  When deriving
-  // addresses from URIs, equivalent addresses are expected from
-  // equivalent URIs.  The URI sip:user@host:5060 will always
-  // resolve to port 5060.  The URI sip:user@host may resolve to
-  // other ports through the DNS SRV mechanisms detailed in [4].
-
-  // FIXME: TODO:
-  // - character compared to hex encoding is not handled
-  // - password does not exist on URI currently
-  if (a.user !== b.user || a.host !== b.host || a.port !== b.port) {
-    return false;
-  }
-
-  // o  URI uri-parameter components are compared as follows:
-  function compareParameters(a: URI, b: URI): boolean {
-    //  -  Any uri-parameter appearing in both URIs must match.
-    const parameterKeysA = Object.keys(a.parameters);
-    const parameterKeysB = Object.keys(b.parameters);
-    const intersection = parameterKeysA.filter(x => parameterKeysB.includes(x));
-    if (!intersection.every(key => a.parameters[key] === b.parameters[key])) {
-      return false;
-    }
-
-    //  -  A user, ttl, or method uri-parameter appearing in only one
-    //     URI never matches, even if it contains the default value.
-    if (!["user", "ttl", "method", "transport"].every(key => a.hasParam(key) && b.hasParam(key) || !a.hasParam(key) && !b.hasParam(key))) {
-      return false;
-    }
-
-    //  -  A URI that includes an maddr parameter will not match a URI
-    //     that contains no maddr parameter.
-    if (!["maddr"].every(key => a.hasParam(key) && b.hasParam(key) || !a.hasParam(key) && !b.hasParam(key))) {
-      return false;
-    }
-
-    //  -  All other uri-parameters appearing in only one URI are
-    //     ignored when comparing the URIs.
-    return true;
-  }
-
-  if (!compareParameters(a, b)) {
-    return false;
-  }
-
-  // o  URI header components are never ignored.  Any present header
-  //    component MUST be present in both URIs and match for the URIs
-  //    to match.  The matching rules are defined for each header field
-  //    in Section 20.
-  const headerKeysA = Object.keys(a.headers);
-  const headerKeysB = Object.keys(b.headers);
-
-  // No need to check if no headers
-  if (headerKeysA.length !== 0 || headerKeysB.length !== 0) {
-
-    // Must have same number of headers
-    if (headerKeysA.length !== headerKeysB.length) {
-      return false;
-    }
-
-    // Must have same headers
-    const intersection = headerKeysA.filter(x => headerKeysB.includes(x));
-    if (intersection.length !== headerKeysB.length) {
-      return false;
-    }
-
-    // FIXME: Not to spec. But perhaps not worth fixing?
-    // Must have same header values
-    // It seems too much to consider multiple headers with same name.
-    // It seems too much to compare two header params according to the rule of each header.
-    // We'll assume a single header and compare them string to string...
-    if (!intersection.every(key => a.headers[key].length && b.headers[key].length && a.headers[key][0] === b.headers[key][0])) {
-      return false;
-    }
-  }
-
-  return true;
-}

package/src/lib/sip.js/index.ts

@@ -1,20 +0,0 @@
-
-// Helpful name and version exports
-import { LIBRARY_VERSION } from "./version";
-const version = LIBRARY_VERSION;
-const name = "sip.js";
-export { name, version };
-
-// Export api
-export * from "./api";
-
-// Export grammar
-export * from "./grammar";
-
-// Export namespaced core
-import * as Core from "./core";
-export { Core };
-
-// Export namespaced web
-import * as Web from "./platform/web";
-export { Web };

package/src/lib/sip.js/platform/react/README.md

@@ -1 +0,0 @@
-See [documentation](../.././../docs/react-native.md).

package/src/lib/sip.js/platform/web/index.ts

@@ -1,4 +0,0 @@
-export * from "./modifiers";
-export * from "./session-description-handler";
-export * from "./simple-user";
-export * from "./transport";

package/src/lib/sip.js/platform/web/modifiers/index.ts

@@ -1,5 +0,0 @@
-/**
- * SessionDescriptionHandlerModifer functions for web browsers.
- * @packageDocumentation
- */
-export * from "./modifiers";

package/src/lib/sip.js/platform/web/modifiers/modifiers.ts

@@ -1,180 +0,0 @@
-import { SessionDescriptionHandlerModifier } from "../../../api";
-
-const stripPayload = (sdp: string, payload: string): string => {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const mediaDescs: Array<any> = [];
-
-  const lines: Array<string> = sdp.split(/\r\n/);
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  let currentMediaDesc: any;
-  for (let i = 0; i < lines.length;) {
-    const line: string = lines[i];
-    if (/^m=(?:audio|video)/.test(line)) {
-      currentMediaDesc = {
-        index: i,
-        stripped: []
-      };
-      mediaDescs.push(currentMediaDesc);
-    } else if (currentMediaDesc) {
-      const rtpmap = /^a=rtpmap:(\d+) ([^/]+)\//.exec(line);
-      if (rtpmap && payload === rtpmap[2]) {
-        lines.splice(i, 1);
-        currentMediaDesc.stripped.push(rtpmap[1]);
-        continue; // Don't increment 'i'
-      }
-    }
-
-    i++;
-  }
-
-  for (const mediaDesc of mediaDescs) {
-    const mline: Array<string> = lines[mediaDesc.index].split(" ");
-
-    // Ignore the first 3 parameters of the mline. The codec information is after that
-    for (let j = 3; j < mline.length;) {
-      if (mediaDesc.stripped.indexOf(mline[j]) !== -1) {
-        mline.splice(j, 1);
-        continue;
-      }
-      j++;
-    }
-
-    lines[mediaDesc.index] = mline.join(" ");
-  }
-
-  return lines.join("\r\n");
-};
-
-const stripMediaDescription = (sdp: string, description: string): string => {
-  const descriptionRegExp = new RegExp("m=" + description + ".*$", "gm");
-  const groupRegExp = new RegExp("^a=group:.*$", "gm");
-
-  if (descriptionRegExp.test(sdp)) {
-    let midLineToRemove;
-    sdp = sdp.split(/^m=/gm).filter((section) => {
-      if (section.substr(0, description.length) === description) {
-        midLineToRemove = section.match(/^a=mid:.*$/gm);
-        if (midLineToRemove) {
-          const step = midLineToRemove[0].match(/:.+$/g);
-          if (step) {
-            midLineToRemove = step[0].substr(1);
-          }
-        }
-        return false;
-      }
-      return true;
-    }).join("m=");
-    const groupLine = sdp.match(groupRegExp);
-    if (groupLine && groupLine.length === 1) {
-      let groupLinePortion = groupLine[0];
-      // eslint-disable-next-line no-useless-escape
-      const groupRegExpReplace = new RegExp("\ *" + midLineToRemove + "[^\ ]*", "g");
-      groupLinePortion = groupLinePortion.replace(groupRegExpReplace, "");
-      sdp = sdp.split(groupRegExp).join(groupLinePortion);
-    }
-  }
-  return sdp;
-};
-
-/**
- * Modifier.
- * @public
- */
-export function stripTcpCandidates(description: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit> {
-  description.sdp = (description.sdp || "").replace(/^a=candidate:\d+ \d+ tcp .*?\r\n/img, "");
-  return Promise.resolve(description);
-}
-
-/**
- * Modifier.
- * @public
- */
-export function stripTelephoneEvent(description: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit> {
-  description.sdp = stripPayload(description.sdp || "", "telephone-event");
-  return Promise.resolve(description);
-}
-
-/**
- * Modifier.
- * @public
- */
-export function cleanJitsiSdpImageattr(description: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit> {
-  description.sdp = (description.sdp || "").replace(/^(a=imageattr:.*?)(x|y)=\[0-/gm, "$1$2=[1:");
-  return Promise.resolve(description);
-}
-
-/**
- * Modifier.
- * @public
- */
-export function stripG722(description: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit> {
-  description.sdp = stripPayload(description.sdp || "", "G722");
-  return Promise.resolve(description);
-}
-
-/**
- * Modifier.
- * @public
- */
-export function stripRtpPayload(payload: string): SessionDescriptionHandlerModifier {
-  return (description: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit> => {
-    description.sdp = stripPayload(description.sdp || "", payload);
-    return Promise.resolve(description);
-  };
-}
-
-/**
- * Modifier.
- * @public
- */
-export function stripVideo(description: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit> {
-  description.sdp = stripMediaDescription(description.sdp || "", "video");
-  return Promise.resolve(description);
-}
-
-/**
- * Modifier.
- * @public
- */
-export function addMidLines(description: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit> {
-  let sdp = description.sdp || "";
-  if (sdp.search(/^a=mid.*$/gm) === -1) {
-    const mlines = sdp.match(/^m=.*$/gm);
-    const sdpArray = sdp.split(/^m=.*$/gm);
-    if (mlines) {
-      mlines.forEach((elem, idx) => {
-        mlines[idx] = elem + "\na=mid:" + idx;
-      });
-    }
-    sdpArray.forEach((elem, idx) => {
-      if (mlines && mlines[idx]) {
-        sdpArray[idx] = elem + mlines[idx];
-      }
-    });
-    sdp = sdpArray.join("");
-    description.sdp = sdp;
-  }
-  return Promise.resolve(description);
-}
-
-/**
- * The modifier that should be used when the session would like to place the call on hold.
- * @param description - The description that will be modified.
- */
-export function holdModifier(description: RTCSessionDescriptionInit): Promise<RTCSessionDescriptionInit> {
-  if (!description.sdp || !description.type) {
-    throw new Error("Invalid SDP");
-  }
-  let sdp = description.sdp;
-  const type = description.type;
-  if (sdp) {
-    if (!/a=(sendrecv|sendonly|recvonly|inactive)/.test(sdp)) {
-      sdp = sdp.replace(/(m=[^\r]*\r\n)/g, "$1a=sendonly\r\n");
-    } else {
-      sdp = sdp.replace(/a=sendrecv\r\n/g, "a=sendonly\r\n");
-      sdp = sdp.replace(/a=recvonly\r\n/g, "a=inactive\r\n");
-    }
-  }
-  return Promise.resolve({ sdp, type });
-}