node-rtc-connection 1.0.18 → 2.0.4

package/src/ice/{RTCIceCandidate.js → RTCIceCandidate.ts}

@@ -1,28 +1,90 @@
 /**
- * @fileoverview RTCIceCandidate - ICE candidate representation.
- * 
- * Ported from Chromium's WebRTC implementation:
- * chromium/src/third_party/blink/renderer/modules/peerconnection/rtc_ice_candidate.{h,cc}
- * 
+ * @file RTCIceCandidate - ICE candidate representation.
+ *
+ * Implements the W3C RTCIceCandidate interface
+ * (https://www.w3.org/TR/webrtc/#rtcicecandidate-interface).
+ *
  * Represents an ICE (Interactive Connectivity Establishment) candidate that
  * describes a potential way to establish a connection with a peer.
- * 
- * @license BSD-3-Clause
+ *
+ * @license MIT
  * @author nmhung1210
  */
 
 'use strict';
 
+/**
+ * Initialization dictionary for RTCIceCandidate.
+ */
+interface RTCIceCandidateInit {
+  candidate?: string;
+  sdpMid?: string | null;
+  sdpMLineIndex?: number | null;
+  usernameFragment?: string | null;
+}
+
+/**
+ * Parsed attributes extracted from an ICE candidate string.
+ */
+interface ParsedCandidateAttributes {
+  foundation: string | null;
+  component: string | null;
+  protocol: string | null;
+  priority: number | null;
+  address: string | null;
+  port: number | null;
+  type: string | null;
+  tcpType: string | null;
+  relatedAddress: string | null;
+  relatedPort: number | null;
+}
+
+/**
+ * JSON representation of an RTCIceCandidate.
+ */
+interface RTCIceCandidateJSON {
+  candidate: string;
+  sdpMid: string | null;
+  sdpMLineIndex: number | null;
+  usernameFragment?: string;
+}
+
 /**
  * RTCIceCandidate represents a potential method for establishing connectivity.
- * 
+ *
  * ICE candidates are described using SDP (Session Description Protocol) syntax.
  * Each candidate describes a single address/port combination and transport protocol.
  */
 class RTCIceCandidate {
+  /**
+   * SDP candidate string.
+   * @private {string}
+   */
+  #candidate: string;
+
+  /**
+   * Media stream identification.
+   * @private {string|null}
+   */
+  #sdpMid: string | null;
+
+  /**
+   * Media line index (zero-based).
+   * @private {number|null}
+   */
+  #sdpMLineIndex: number | null;
+
+  /**
+   * ICE username fragment.
+   * @private {string|null}
+   */
+  #usernameFragment: string | null;
+
+  #parsedAttributes: ParsedCandidateAttributes;
+
   /**
    * Creates a new RTCIceCandidate.
-   * 
+   *
    * @param {RTCIceCandidateInit} [candidateInit={}] - Initialization dictionary
    * @param {string} [candidateInit.candidate=''] - SDP candidate string
    * @param {string|null} [candidateInit.sdpMid] - Media stream ID
@@ -30,51 +92,35 @@ class RTCIceCandidate {
    * @param {string} [candidateInit.usernameFragment] - ICE username fragment
    * @throws {TypeError} If both sdpMid and sdpMLineIndex are null
    */
-  constructor(candidateInit = {}) {
+  constructor(candidateInit: RTCIceCandidateInit = {}) {
     // Validate that at least one of sdpMid or sdpMLineIndex is present
     if (candidateInit.sdpMid === null && candidateInit.sdpMLineIndex === null) {
       throw new TypeError('sdpMid and sdpMLineIndex are both null');
     }
 
-    /**
-     * SDP candidate string.
-     * @private {string}
-     */
-    this._candidate = candidateInit.candidate || '';
-
-    /**
-     * Media stream identification.
-     * @private {string|null}
-     */
-    this._sdpMid = candidateInit.sdpMid !== undefined ? candidateInit.sdpMid : null;
-
-    /**
-     * Media line index (zero-based).
-     * @private {number|null}
-     */
-    this._sdpMLineIndex = candidateInit.sdpMLineIndex !== undefined ? 
+    this.#candidate = candidateInit.candidate || '';
+
+    this.#sdpMid = candidateInit.sdpMid !== undefined ? candidateInit.sdpMid : null;
+
+    this.#sdpMLineIndex = candidateInit.sdpMLineIndex !== undefined ?
       candidateInit.sdpMLineIndex : null;
 
-    /**
-     * ICE username fragment.
-     * @private {string|null}
-     */
-    this._usernameFragment = candidateInit.usernameFragment || null;
+    this.#usernameFragment = candidateInit.usernameFragment || null;
 
     // Parse candidate string for detailed attributes
-    this._parsedAttributes = this._parseCandidate(this._candidate);
+    this.#parsedAttributes = this.#parseCandidate(this.#candidate);
   }
 
   /**
    * Parses an ICE candidate string to extract attributes.
    * Format: "candidate:foundation component protocol priority address port typ type [raddr reladdr] [rport relport]"
-   * 
+   *
    * @private
    * @param {string} candidateStr - Candidate string to parse
    * @returns {Object} Parsed attributes
    */
-  _parseCandidate(candidateStr) {
-    const attrs = {
+  #parseCandidate(candidateStr: string): ParsedCandidateAttributes {
+    const attrs: ParsedCandidateAttributes = {
       foundation: null,
       component: null,
       protocol: null,
@@ -84,7 +130,7 @@ class RTCIceCandidate {
       type: null,
       tcpType: null,
       relatedAddress: null,
-      relatedPort: null
+      relatedPort: null,
     };
 
     if (!candidateStr || !candidateStr.startsWith('candidate:')) {
@@ -93,35 +139,35 @@ class RTCIceCandidate {
 
     // Remove "candidate:" prefix
     const parts = candidateStr.substring(10).trim().split(/\s+/);
-    
+
     if (parts.length < 8) {
       return attrs;
     }
 
     // Parse fixed fields
-    attrs.foundation = parts[0];
-    attrs.component = parts[1];
-    attrs.protocol = parts[2].toLowerCase();
-    attrs.priority = parseInt(parts[3], 10);
-    attrs.address = parts[4];
-    attrs.port = parseInt(parts[5], 10);
-    
+    attrs.foundation = parts[0]!;
+    attrs.component = parts[1]!;
+    attrs.protocol = parts[2]!.toLowerCase();
+    attrs.priority = parseInt(parts[3]!, 10);
+    attrs.address = parts[4]!;
+    attrs.port = parseInt(parts[5]!, 10);
+
     // parts[6] should be "typ"
     if (parts[6] === 'typ') {
-      attrs.type = parts[7];
+      attrs.type = parts[7]!;
     }
 
     // Parse optional attributes
     for (let i = 8; i < parts.length; i += 2) {
       const key = parts[i];
       const value = parts[i + 1];
-      
+
       if (key === 'raddr') {
-        attrs.relatedAddress = value;
+        attrs.relatedAddress = value!;
       } else if (key === 'rport') {
-        attrs.relatedPort = parseInt(value, 10);
+        attrs.relatedPort = parseInt(value!, 10);
       } else if (key === 'tcptype') {
-        attrs.tcpType = value;
+        attrs.tcpType = value!;
       }
     }
 
@@ -132,48 +178,48 @@ class RTCIceCandidate {
    * SDP candidate attribute containing the candidate description.
    * @type {string}
    */
-  get candidate() {
-    return this._candidate;
+  get candidate(): string {
+    return this.#candidate;
   }
 
   /**
    * Media stream identification tag.
    * @type {string|null}
    */
-  get sdpMid() {
-    return this._sdpMid;
+  get sdpMid(): string | null {
+    return this.#sdpMid;
   }
 
   /**
    * Index of the m-line in the SDP this candidate is associated with.
    * @type {number|null}
    */
-  get sdpMLineIndex() {
-    return this._sdpMLineIndex;
+  get sdpMLineIndex(): number | null {
+    return this.#sdpMLineIndex;
   }
 
   /**
    * ICE username fragment.
    * @type {string|null}
    */
-  get usernameFragment() {
-    return this._usernameFragment;
+  get usernameFragment(): string | null {
+    return this.#usernameFragment;
   }
 
   /**
    * Unique identifier for this candidate.
    * @type {string|null}
    */
-  get foundation() {
-    return this._parsedAttributes.foundation;
+  get foundation(): string | null {
+    return this.#parsedAttributes.foundation;
   }
 
   /**
    * Component identifier (rtp=1, rtcp=2).
    * @type {string|null}
    */
-  get component() {
-    return this._parsedAttributes.component;
+  get component(): string | null {
+    return this.#parsedAttributes.component;
   }
 
   /**
@@ -181,40 +227,40 @@ class RTCIceCandidate {
    * Higher priority candidates are preferred.
    * @type {number|null}
    */
-  get priority() {
-    return this._parsedAttributes.priority;
+  get priority(): number | null {
+    return this.#parsedAttributes.priority;
   }
 
   /**
    * IP address of this candidate.
    * @type {string|null}
    */
-  get address() {
-    return this._parsedAttributes.address;
+  get address(): string | null {
+    return this.#parsedAttributes.address;
   }
 
   /**
    * Transport protocol (udp/tcp).
    * @type {string|null}
    */
-  get protocol() {
-    return this._parsedAttributes.protocol;
+  get protocol(): string | null {
+    return this.#parsedAttributes.protocol;
   }
 
   /**
    * Port number.
    * @type {number|null}
    */
-  get port() {
-    return this._parsedAttributes.port;
+  get port(): number | null {
+    return this.#parsedAttributes.port;
   }
 
   /**
    * Type of candidate (host, srflx, prflx, relay).
    * @type {string|null}
    */
-  get type() {
-    return this._parsedAttributes.type;
+  get type(): string | null {
+    return this.#parsedAttributes.type;
   }
 
   /**
@@ -222,39 +268,39 @@ class RTCIceCandidate {
    * Only applicable for TCP candidates.
    * @type {string|null}
    */
-  get tcpType() {
-    return this._parsedAttributes.tcpType;
+  get tcpType(): string | null {
+    return this.#parsedAttributes.tcpType;
   }
 
   /**
    * Related address for reflexive/relay candidates.
    * @type {string|null}
    */
-  get relatedAddress() {
-    return this._parsedAttributes.relatedAddress;
+  get relatedAddress(): string | null {
+    return this.#parsedAttributes.relatedAddress;
   }
 
   /**
    * Related port for reflexive/relay candidates.
    * @type {number|null}
    */
-  get relatedPort() {
-    return this._parsedAttributes.relatedPort;
+  get relatedPort(): number | null {
+    return this.#parsedAttributes.relatedPort;
   }
 
   /**
    * Converts candidate to JSON representation.
    * @returns {Object} JSON representation
    */
-  toJSON() {
-    const json = {
-      candidate: this._candidate,
-      sdpMid: this._sdpMid,
-      sdpMLineIndex: this._sdpMLineIndex
+  toJSON(): RTCIceCandidateJSON {
+    const json: RTCIceCandidateJSON = {
+      candidate: this.#candidate,
+      sdpMid: this.#sdpMid,
+      sdpMLineIndex: this.#sdpMLineIndex,
     };
 
-    if (this._usernameFragment) {
-      json.usernameFragment = this._usernameFragment;
+    if (this.#usernameFragment) {
+      json.usernameFragment = this.#usernameFragment;
     }
 
     return json;
@@ -262,31 +308,31 @@ class RTCIceCandidate {
 
   /**
    * Creates an RTCIceCandidate from a candidate string.
-   * 
+   *
    * @param {string} candidateStr - ICE candidate string
    * @param {string|null} [sdpMid=null] - Media stream ID
    * @param {number|null} [sdpMLineIndex=0] - M-line index
    * @returns {RTCIceCandidate}
    */
-  static fromString(candidateStr, sdpMid = null, sdpMLineIndex = 0) {
+  static fromString(candidateStr: string, sdpMid: string | null = null, sdpMLineIndex: number | null = 0): RTCIceCandidate {
     return new RTCIceCandidate({
       candidate: candidateStr,
       sdpMid,
-      sdpMLineIndex
+      sdpMLineIndex,
     });
   }
 
   /**
    * Validates if a string is a valid candidate format.
-   * 
+   *
    * @param {string} candidateStr - String to validate
    * @returns {boolean} True if valid candidate format
    */
-  static isValid(candidateStr) {
+  static isValid(candidateStr: string): boolean {
     if (!candidateStr || typeof candidateStr !== 'string') {
       return false;
     }
-    
+
     // Must start with "candidate:"
     if (!candidateStr.startsWith('candidate:')) {
       return false;
@@ -298,4 +344,6 @@ class RTCIceCandidate {
   }
 }
 
-module.exports = RTCIceCandidate;
+export default RTCIceCandidate;
+export { RTCIceCandidate };
+export type { RTCIceCandidateInit, ParsedCandidateAttributes, RTCIceCandidateJSON };