ue-softphone-sdk 2.2.3 → 2.2.4

package/src/grammar/grammar.ts

@@ -0,0 +1,55 @@
+/* eslint-disable @typescript-eslint/no-namespace */
+/* eslint-disable no-inner-declarations */
+import * as pegGrammar from "./pegjs/dist/grammar";
+
+import { NameAddrHeader } from "./name-addr-header";
+import { URI } from "./uri";
+
+/**
+ * Grammar.
+ * @internal
+ */
+export namespace Grammar {
+
+  /**
+   * Parse.
+   * @param input -
+   * @param startRule -
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  export function parse(input: string, startRule: string): any {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const options: any = {startRule};
+
+    try {
+      pegGrammar.parse(input, options);
+    } catch (e) {
+      options.data = -1;
+    }
+    return options.data;
+  }
+
+  /**
+   * Parse the given string and returns a SIP.NameAddrHeader instance or undefined if
+   * it is an invalid NameAddrHeader.
+   * @param name_addr_header -
+   */
+  export function nameAddrHeaderParse(nameAddrHeader: string): NameAddrHeader | undefined {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const parsedNameAddrHeader: any = Grammar.parse(nameAddrHeader, "Name_Addr_Header");
+
+    return parsedNameAddrHeader !== -1 ? (parsedNameAddrHeader as NameAddrHeader) : undefined;
+  }
+
+  /**
+   * Parse the given string and returns a SIP.URI instance or undefined if
+   * it is an invalid URI.
+   * @param uri -
+   */
+  export function URIParse(uri: string): URI | undefined {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const parsedUri: any = Grammar.parse(uri, "SIP_URI");
+
+    return parsedUri !== -1 ? (parsedUri as URI) : undefined;
+  }
+}

package/src/grammar/index.ts

@@ -0,0 +1,4 @@
+export * from "./grammar";
+export * from "./name-addr-header";
+export * from "./parameters";
+export * from "./uri";

package/src/grammar/name-addr-header.ts

@@ -0,0 +1,58 @@
+import { Parameters } from "./parameters";
+import { URI } from "./uri";
+
+/**
+ * Name Address SIP header.
+ * @public
+ */
+export class NameAddrHeader extends Parameters {
+  public uri: URI;
+
+  private _displayName: string;
+
+  /**
+   * Constructor
+   * @param uri -
+   * @param displayName -
+   * @param parameters -
+   */
+  constructor(uri: URI, displayName: string, parameters: { [name: string]: string }) {
+    super(parameters);
+    this.uri = uri;
+    this._displayName = displayName;
+  }
+
+  get friendlyName(): string {
+    return this.displayName || this.uri.aor;
+  }
+
+  get displayName(): string { return this._displayName; }
+  set displayName(value: string) {
+    this._displayName = value;
+  }
+
+  public clone(): NameAddrHeader {
+    return new NameAddrHeader(
+      this.uri.clone(),
+      this._displayName,
+      JSON.parse(JSON.stringify(this.parameters)));
+  }
+
+  public toString(): string {
+    let body: string = (this.displayName || this.displayName === "0") ? '"' + this.displayName + '" ' : "";
+    body += "<" + this.uri.toString() + ">";
+
+    for (const parameter in this.parameters) {
+      // eslint-disable-next-line no-prototype-builtins
+      if (this.parameters.hasOwnProperty(parameter)) {
+        body += ";" + parameter;
+
+        if (this.parameters[parameter] !== null) {
+          body += "=" + this.parameters[parameter];
+        }
+      }
+    }
+
+    return body;
+  }
+}

package/src/grammar/parameters.ts

@@ -0,0 +1,45 @@
+/**
+ * @internal
+ */
+export class Parameters {
+  public parameters: {[name: string]: string | null} = {};
+
+  constructor(parameters: {[name: string]: string | number | null | undefined}) {
+    // for in is required here as the Grammar parser is adding to the prototype chain
+    for (const param in parameters) {
+      // eslint-disable-next-line no-prototype-builtins
+      if (parameters.hasOwnProperty(param)) {
+        this.setParam(param, parameters[param]);
+      }
+    }
+  }
+
+  public setParam(key: string, value: string | number | null | undefined): void {
+    if (key) {
+      this.parameters[key.toLowerCase()] = (typeof value === "undefined" || value === null) ? null : value.toString();
+    }
+  }
+
+  public getParam(key: string): string | null | undefined {
+    if (key) {
+      return this.parameters[key.toLowerCase()];
+    }
+  }
+
+  public hasParam(key: string): boolean {
+    return !!(key && this.parameters[key.toLowerCase()] !== undefined);
+  }
+
+  public deleteParam(key: string): string | null | undefined {
+    key = key.toLowerCase();
+    if (this.hasParam(key)) {
+      const value = this.parameters[key];
+      delete this.parameters[key];
+      return value;
+    }
+  }
+
+  public clearParams(): void {
+    this.parameters = {};
+  }
+}

package/src/grammar/pegjs/README.md

@@ -0,0 +1,9 @@
+## SIP Parser Grammar
+
+SIP,js uses [PEG.js](https://github.com/dmajda/pegjs) to build its parser grammar, a PEG based parser generator for JavaScript.
+
+The grammar source is defined in PEG format in `src/Grammar.pegjs` file. It must be converted to JavaScript by using PEG.js
+
+### Compiling SIP Grammar
+
+`npm run build` in the SIP.js root directory