ue-softphone-sdk 2.2.2 → 2.2.4

package/src/platform/react/README.md

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

package/src/platform/web/index.ts

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

package/src/platform/web/modifiers/index.ts

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

package/src/platform/web/modifiers/modifiers.ts

@@ -0,0 +1,180 @@
+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 });
+}

package/src/platform/web/session-description-handler/api-extractor.json

@@ -0,0 +1,358 @@
+/**
+ * Config file for API Extractor.  For more info, please visit: https://api-extractor.com
+ */
+ {
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+
+  /**
+   * Optionally specifies another JSON config file that this file extends from.  This provides a way for
+   * standard settings to be shared across multiple projects.
+   *
+   * If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains
+   * the "extends" field.  Otherwise, the first path segment is interpreted as an NPM package name, and will be
+   * resolved using NodeJS require().
+   *
+   * SUPPORTED TOKENS: none
+   * DEFAULT VALUE: ""
+   */
+  // "extends": "./shared/api-extractor-base.json"
+  // "extends": "my-package/include/api-extractor-base.json"
+
+  /**
+   * Determines the "<projectFolder>" token that can be used with other config file settings.  The project folder
+   * typically contains the tsconfig.json and package.json config files, but the path is user-defined.
+   *
+   * The path is resolved relative to the folder of the config file that contains the setting.
+   *
+   * The default value for "projectFolder" is the token "<lookup>", which means the folder is determined by traversing
+   * parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder
+   * that contains a tsconfig.json file.  If a tsconfig.json file cannot be found in this way, then an error
+   * will be reported.
+   *
+   * SUPPORTED TOKENS: <lookup>
+   * DEFAULT VALUE: "<lookup>"
+   */
+  // "projectFolder": "..",
+  "projectFolder": "../../../..",
+
+  /**
+   * (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis.  API Extractor
+   * analyzes the symbols exported by this module.
+   *
+   * The file extension must be ".d.ts" and not ".ts".
+   *
+   * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+   * prepend a folder token such as "<projectFolder>".
+   *
+   * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+   */
+  "mainEntryPointFilePath": "<projectFolder>/lib/platform/web/session-description-handler/index.d.ts",
+
+  /**
+   * Determines how the TypeScript compiler engine will be invoked by API Extractor.
+   */
+  "compiler": {
+    /**
+     * Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * Note: This setting will be ignored if "overrideTsconfig" is used.
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/tsconfig.json"
+     */
+    // "tsconfigFilePath": "<projectFolder>/tsconfig.json",
+
+    /**
+     * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk.
+     * The object must conform to the TypeScript tsconfig schema:
+     *
+     * http://json.schemastore.org/tsconfig
+     *
+     * If omitted, then the tsconfig.json file will be read from the "projectFolder".
+     *
+     * DEFAULT VALUE: no overrideTsconfig section
+     */
+    "overrideTsconfig": {
+      "compilerOptions": {
+        "declaration": true,
+        "declarationMap": true,
+        "outDir": "../lib",
+        "strict": true,
+        "target": "es5",
+        "lib": [
+          "es2017",
+          "dom"
+        ]
+      },
+      "include": [
+        "**/*.ts"
+      ]
+    }
+    /**
+     * This option causes the compiler to be invoked with the --skipLibCheck option. This option is not recommended
+     * and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when
+     * dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses
+     * for its analysis.  Where possible, the underlying issue should be fixed rather than relying on skipLibCheck.
+     *
+     * DEFAULT VALUE: false
+     */
+    // "skipLibCheck": true,
+  },
+
+  /**
+   * Configures how the API report file (*.api.md) will be generated.
+   */
+  "apiReport": {
+    /**
+     * (REQUIRED) Whether to generate an API report.
+     */
+    "enabled": true,
+
+    /**
+     * The filename for the API report files.  It will be combined with "reportFolder" or "reportTempFolder" to produce
+     * a full file path.
+     *
+     * The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/".
+     *
+     * SUPPORTED TOKENS: <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<unscopedPackageName>.api.md"
+     */
+    // "reportFileName": "<unscopedPackageName>.api.md",
+
+    /**
+     * Specifies the folder where the API report file is written.  The file name portion is determined by
+     * the "reportFileName" setting.
+     *
+     * The API report file is normally tracked by Git.  Changes to it can be used to trigger a branch policy,
+     * e.g. for an API review.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/etc/"
+     */
+    "reportFolder": "<projectFolder>/etc/session-description-handler",
+
+    /**
+     * Specifies the folder where the temporary report file is written.  The file name portion is determined by
+     * the "reportFileName" setting.
+     *
+     * After the temporary file is written to disk, it is compared with the file in the "reportFolder".
+     * If they are different, a production build will fail.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/temp/"
+     */
+    "reportTempFolder": "<projectFolder>/temp/session-description-handler"
+  },
+
+  /**
+   * Configures how the doc model file (*.api.json) will be generated.
+   */
+  "docModel": {
+    /**
+     * (REQUIRED) Whether to generate a doc model file.
+     */
+    "enabled": true,
+
+    /**
+     * The output path for the doc model file.  The file extension should be ".api.json".
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json"
+     */
+    "apiJsonFilePath": "<projectFolder>/temp/session-description-handler/<unscopedPackageName>.api.json"
+  },
+
+  /**
+   * Configures how the .d.ts rollup file will be generated.
+   */
+  "dtsRollup": {
+    /**
+     * (REQUIRED) Whether to generate the .d.ts rollup file.
+     */
+    "enabled": false,
+
+    /**
+     * Specifies the output path for a .d.ts rollup file to be generated without any trimming.
+     * This file will include all declarations that are exported by the main entry point.
+     *
+     * If the path is an empty string, then this file will not be written.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/dist/<unscopedPackageName>.d.ts"
+     */
+    // "untrimmedFilePath": "<projectFolder>/dist/sip-platform-web.d.ts",
+
+    /**
+     * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release.
+     * This file will include only declarations that are marked as "@public" or "@beta".
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: ""
+     */
+    // "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-beta.d.ts",
+
+
+    /**
+     * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release.
+     * This file will include only declarations that are marked as "@public".
+     *
+     * If the path is an empty string, then this file will not be written.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: ""
+     */
+    // "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts",
+
+    /**
+     * When a declaration is trimmed, by default it will be replaced by a code comment such as
+     * "Excluded from this release type: exampleMember".  Set "omitTrimmingComments" to true to remove the
+     * declaration completely.
+     *
+     * DEFAULT VALUE: false
+     */
+    // "omitTrimmingComments": true
+  },
+
+  /**
+   * Configures how the tsdoc-metadata.json file will be generated.
+   */
+  "tsdocMetadata": {
+    /**
+     * Whether to generate the tsdoc-metadata.json file.
+     *
+     * DEFAULT VALUE: true
+     */
+    // "enabled": true,
+
+    /**
+     * Specifies where the TSDoc metadata file should be written.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * The default value is "<lookup>", which causes the path to be automatically inferred from the "tsdocMetadata",
+     * "typings" or "main" fields of the project's package.json.  If none of these fields are set, the lookup
+     * falls back to "tsdoc-metadata.json" in the package folder.
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<lookup>"
+     */
+    // "tsdocMetadataFilePath": "<projectFolder>/dist/tsdoc-metadata.json"
+  },
+
+  /**
+   * Configures how API Extractor reports error and warning messages produced during analysis.
+   *
+   * There are three sources of messages:  compiler messages, API Extractor messages, and TSDoc messages.
+   */
+  "messages": {
+    /**
+     * Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing
+     * the input .d.ts files.
+     *
+     * TypeScript message identifiers start with "TS" followed by an integer.  For example: "TS2551"
+     *
+     * DEFAULT VALUE:  A single "default" entry with logLevel=warning.
+     */
+    "compilerMessageReporting": {
+      /**
+       * Configures the default routing for messages that don't match an explicit rule in this table.
+       */
+      "default": {
+        /**
+         * Specifies whether the message should be written to the the tool's output log.  Note that
+         * the "addToApiReportFile" property may supersede this option.
+         *
+         * Possible values: "error", "warning", "none"
+         *
+         * Errors cause the build to fail and return a nonzero exit code.  Warnings cause a production build fail
+         * and return a nonzero exit code.  For a non-production build (e.g. when "api-extractor run" includes
+         * the "--local" option), the warning is displayed but the build will not fail.
+         *
+         * DEFAULT VALUE: "warning"
+         */
+        "logLevel": "warning",
+
+        /**
+         * When addToApiReportFile is true:  If API Extractor is configured to write an API report file (.api.md),
+         * then the message will be written inside that file; otherwise, the message is instead logged according to
+         * the "logLevel" option.
+         *
+         * DEFAULT VALUE: false
+         */
+        // "addToApiReportFile": false
+      },
+
+      // "TS2551": {
+      //   "logLevel": "warning",
+      //   "addToApiReportFile": true
+      // },
+      //
+      // . . .
+    },
+
+    /**
+     * Configures handling of messages reported by API Extractor during its analysis.
+     *
+     * API Extractor message identifiers start with "ae-".  For example: "ae-extra-release-tag"
+     *
+     * DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings
+     */
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning",
+        // "addToApiReportFile": false
+      },
+
+      // "ae-extra-release-tag": {
+      //   "logLevel": "warning",
+      //   "addToApiReportFile": true
+      // },
+      //
+      // . . .
+    },
+
+    /**
+     * Configures handling of messages reported by the TSDoc parser when analyzing code comments.
+     *
+     * TSDoc message identifiers start with "tsdoc-".  For example: "tsdoc-link-tag-unescaped-text"
+     *
+     * DEFAULT VALUE:  A single "default" entry with logLevel=warning.
+     */
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "warning",
+        // "addToApiReportFile": false
+      }
+
+      // "tsdoc-link-tag-unescaped-text": {
+      //   "logLevel": "warning",
+      //   "addToApiReportFile": true
+      // },
+      //
+      // . . .
+    }
+  }
+
+}

package/src/platform/web/session-description-handler/index.ts

@@ -0,0 +1,14 @@
+/**
+ * A SessionDescriptionHandler for web browsers.
+ * @packageDocumentation
+ */
+export * from "./media-stream-factory-default";
+export * from "./media-stream-factory";
+export * from "./peer-connection-configuration-default";
+export * from "./peer-connection-delegate";
+export * from "./session-description-handler-configuration";
+export * from "./session-description-handler-factory-default";
+export * from "./session-description-handler-factory-options";
+export * from "./session-description-handler-factory";
+export * from "./session-description-handler-options";
+export * from "./session-description-handler";

package/src/platform/web/session-description-handler/media-stream-factory-default.ts

@@ -0,0 +1,22 @@
+import { MediaStreamFactory } from "./media-stream-factory";
+
+/**
+ * Function which returns a MediaStreamFactory.
+ * @public
+ */
+export function defaultMediaStreamFactory(): MediaStreamFactory {
+  return (constraints: MediaStreamConstraints): Promise<MediaStream> => {
+    // if no audio or video, return a media stream without tracks
+    if (!constraints.audio && !constraints.video) {
+      return Promise.resolve(new MediaStream());
+    }
+    // getUserMedia() is a powerful feature which can only be used in secure contexts; in insecure contexts,
+    // navigator.mediaDevices is undefined, preventing access to getUserMedia(). A secure context is, in short,
+    // a page loaded using HTTPS or the file:/// URL scheme, or a page loaded from localhost.
+    // https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#Privacy_and_security
+    if (navigator.mediaDevices === undefined) {
+      return Promise.reject(new Error("Media devices not available in insecure contexts."));
+    }
+    return navigator.mediaDevices.getUserMedia.call(navigator.mediaDevices, constraints);
+  };
+}

package/src/platform/web/session-description-handler/media-stream-factory.ts

@@ -0,0 +1,10 @@
+import { SessionDescriptionHandler } from "./session-description-handler";
+
+/**
+ * Interface of factory function which produces a MediaStream.
+ * @public
+ */
+export type MediaStreamFactory = (
+  constraints: MediaStreamConstraints,
+  sessionDescriptionHandler: SessionDescriptionHandler
+) => Promise<MediaStream>;

package/src/platform/web/session-description-handler/peer-connection-configuration-default.ts

@@ -0,0 +1,17 @@
+// @ts-nocheck
+/**
+ * Function which returns an RTCConfiguration.
+ * @public
+ */
+export function defaultPeerConnectionConfiguration(): RTCConfiguration {
+  const configuration: RTCConfiguration = {
+    bundlePolicy: "balanced", // Note: max-bundle is not supported by the demo backend currently (5/15/17)
+    certificates: undefined,
+    iceCandidatePoolSize: 0,
+    iceServers: [{ urls: "stun:stun.l.google.com:19302" }], // TURN URL example: "turn:88.88.88.0:3478", "test", "test"
+    iceTransportPolicy: "all",
+    peerIdentity: undefined,
+    rtcpMuxPolicy: "require"
+  };
+  return configuration;
+}