node-rtc-connection 1.0.19 → 2.0.4

package/src/foundation/{RTCError.js → RTCError.ts}

@@ -1,13 +1,13 @@
 /**
- * @fileoverview RTCError - WebRTC-specific error types.
- * 
- * Ported from Chromium's WebRTC implementation:
- * chromium/src/third_party/blink/renderer/modules/peerconnection/rtc_error.{h,cc}
- * 
+ * @file RTCError - WebRTC-specific error types.
+ *
+ * Implements the W3C RTCError interface
+ * (https://www.w3.org/TR/webrtc/#rtcerror-interface).
+ *
  * Provides WebRTC-specific error types extending the standard Error class
  * with additional error detail types and metadata fields.
- * 
- * @license BSD-3-Clause
+ *
+ * @license MIT
  * @author nmhung1210
  */
 
@@ -16,7 +16,7 @@
 /**
  * RTCErrorDetailType enum - Standardized WebRTC error details.
  * Maps to RTCErrorDetailType from the WebRTC spec.
- * 
+ *
  * @readonly
  * @enum {string}
  */
@@ -32,18 +32,73 @@ const RTCErrorDetailType = Object.freeze({
   INVALID_STATE: 'invalid-state',
   INVALID_MODIFICATION: 'invalid-modification',
   INVALID_ACCESS_ERROR: 'invalid-access-error',
-  OPERATION_ERROR: 'operation-error'
-});
+  OPERATION_ERROR: 'operation-error',
+} as const);
+
+/**
+ * Error detail type string union.
+ */
+type RTCErrorDetail = typeof RTCErrorDetailType[keyof typeof RTCErrorDetailType];
+
+/**
+ * Error initialization dictionary.
+ */
+interface RTCErrorInit {
+  errorDetail?: string;
+  sdpLineNumber?: number | null;
+  httpRequestStatusCode?: number | null;
+  sctpCauseCode?: number | null;
+  receivedAlert?: number | null;
+  sentAlert?: number | null;
+}
+
+/**
+ * Native WebRTC error object shape.
+ */
+interface NativeRTCError {
+  error_detail?: string;
+  sctp_cause_code?: number;
+  message?: string;
+}
+
+/**
+ * JSON representation of an RTCError.
+ */
+interface RTCErrorJSON {
+  name: string;
+  message: string;
+  errorDetail: string;
+  sdpLineNumber?: number;
+  httpRequestStatusCode?: number;
+  sctpCauseCode?: number;
+  receivedAlert?: number;
+  sentAlert?: number;
+}
 
 /**
  * RTCError extends Error with WebRTC-specific error details.
- * 
+ *
  * @extends Error
  */
 class RTCError extends Error {
+  /** Export error detail types as static property */
+  static readonly DetailType = RTCErrorDetailType;
+
+  /**
+   * Specific error category.
+   * @private {string}
+   */
+  #errorDetail: string;
+
+  #sdpLineNumber: number | null;
+  #httpRequestStatusCode: number | null;
+  #sctpCauseCode: number | null;
+  #receivedAlert: number | null;
+  #sentAlert: number | null;
+
   /**
    * Creates a new RTCError.
-   * 
+   *
    * @param {RTCErrorInit} [init={}] - Error initialization dictionary
    * @param {string} [init.errorDetail='none'] - Error detail type
    * @param {number} [init.sdpLineNumber] - SDP line number where error occurred
@@ -53,11 +108,11 @@ class RTCError extends Error {
    * @param {number} [init.sentAlert] - TLS alert sent
    * @param {string} [message=''] - Error message
    */
-  constructor(init = {}, message = '') {
+  constructor(init: RTCErrorInit = {}, message = '') {
     super(message);
-    
+
     this.name = 'RTCError';
-    
+
     // Maintain stack trace in V8
     if (Error.captureStackTrace) {
       Error.captureStackTrace(this, RTCError);
@@ -68,19 +123,15 @@ class RTCError extends Error {
     if (typeof errorDetail !== 'string') {
       throw new TypeError('errorDetail must be a string');
     }
-    
-    /**
-     * Specific error category.
-     * @private {string}
-     */
-    this._errorDetail = errorDetail;
+
+    this.#errorDetail = errorDetail;
 
     // Optional numeric fields with validation
-    this._sdpLineNumber = this._validateInteger(init.sdpLineNumber, 'sdpLineNumber');
-    this._httpRequestStatusCode = this._validateInteger(init.httpRequestStatusCode, 'httpRequestStatusCode');
-    this._sctpCauseCode = this._validateInteger(init.sctpCauseCode, 'sctpCauseCode');
-    this._receivedAlert = this._validateUnsignedInteger(init.receivedAlert, 'receivedAlert');
-    this._sentAlert = this._validateUnsignedInteger(init.sentAlert, 'sentAlert');
+    this.#sdpLineNumber = this.#validateInteger(init.sdpLineNumber, 'sdpLineNumber');
+    this.#httpRequestStatusCode = this.#validateInteger(init.httpRequestStatusCode, 'httpRequestStatusCode');
+    this.#sctpCauseCode = this.#validateInteger(init.sctpCauseCode, 'sctpCauseCode');
+    this.#receivedAlert = this.#validateUnsignedInteger(init.receivedAlert, 'receivedAlert');
+    this.#sentAlert = this.#validateUnsignedInteger(init.sentAlert, 'sentAlert');
   }
 
   /**
@@ -91,7 +142,7 @@ class RTCError extends Error {
    * @returns {number|null}
    * @throws {TypeError} If value is not an integer
    */
-  _validateInteger(value, fieldName) {
+  #validateInteger(value: number | null | undefined, fieldName: string): number | null {
     if (value === undefined || value === null) {
       return null;
     }
@@ -110,7 +161,7 @@ class RTCError extends Error {
    * @returns {number|null}
    * @throws {TypeError} If value is not an unsigned integer
    */
-  _validateUnsignedInteger(value, fieldName) {
+  #validateUnsignedInteger(value: number | null | undefined, fieldName: string): number | null {
     if (value === undefined || value === null) {
       return null;
     }
@@ -125,75 +176,75 @@ class RTCError extends Error {
    * RTCErrorDetailType - specific error category.
    * @type {string}
    */
-  get errorDetail() {
-    return this._errorDetail;
+  get errorDetail(): string {
+    return this.#errorDetail;
   }
 
   /**
    * SDP line number where the error occurred (if applicable).
    * @type {number|null}
    */
-  get sdpLineNumber() {
-    return this._sdpLineNumber;
+  get sdpLineNumber(): number | null {
+    return this.#sdpLineNumber;
   }
 
   /**
    * HTTP request status code (if applicable).
    * @type {number|null}
    */
-  get httpRequestStatusCode() {
-    return this._httpRequestStatusCode;
+  get httpRequestStatusCode(): number | null {
+    return this.#httpRequestStatusCode;
   }
 
   /**
    * SCTP cause code (if applicable).
    * @type {number|null}
    */
-  get sctpCauseCode() {
-    return this._sctpCauseCode;
+  get sctpCauseCode(): number | null {
+    return this.#sctpCauseCode;
   }
 
   /**
    * TLS alert value received (if applicable).
    * @type {number|null}
    */
-  get receivedAlert() {
-    return this._receivedAlert;
+  get receivedAlert(): number | null {
+    return this.#receivedAlert;
   }
 
   /**
    * TLS alert value sent (if applicable).
    * @type {number|null}
    */
-  get sentAlert() {
-    return this._sentAlert;
+  get sentAlert(): number | null {
+    return this.#sentAlert;
   }
 
   /**
    * Converts error to JSON representation.
    * @returns {Object} JSON representation of the error
    */
-  toJSON() {
-    const json = {
+  toJSON(): RTCErrorJSON {
+    const json: RTCErrorJSON = {
       name: this.name,
       message: this.message,
-      errorDetail: this._errorDetail
+      errorDetail: this.#errorDetail,
     };
 
-    if (this._sdpLineNumber !== null) {
-      json.sdpLineNumber = this._sdpLineNumber;
+    if (this.#sdpLineNumber !== null) {
+      json.sdpLineNumber = this.#sdpLineNumber;
     }
-    if (this._httpRequestStatusCode !== null) {
-      json.httpRequestStatusCode = this._httpRequestStatusCode;
+    if (this.#httpRequestStatusCode !== null) {
+      json.httpRequestStatusCode = this.#httpRequestStatusCode;
     }
-    if (this._sctpCauseCode !== null) {
-      json.sctpCauseCode = this._sctpCauseCode;
+    if (this.#sctpCauseCode !== null) {
+      json.sctpCauseCode = this.#sctpCauseCode;
     }
-    if (this._receivedAlert !== null) {
-      json.receivedAlert = this._receivedAlert;
+    if (this.#receivedAlert !== null) {
+      json.receivedAlert = this.#receivedAlert;
     }
-    if (this._sentAlert !== null) {
-      json.sentAlert = this._sentAlert;
+    if (this.#sentAlert !== null) {
+      json.sentAlert = this.#sentAlert;
     }
 
     return json;
@@ -207,9 +258,9 @@ class RTCError extends Error {
    * @param {string} [nativeError.message] - Error message
    * @returns {RTCError}
    */
-  static fromNative(nativeError) {
-    const init = {
-      errorDetail: nativeError.error_detail || RTCErrorDetailType.NONE
+  static fromNative(nativeError: NativeRTCError): RTCError {
+    const init: RTCErrorInit = {
+      errorDetail: nativeError.error_detail || RTCErrorDetailType.NONE,
     };
 
     if (nativeError.sctp_cause_code !== undefined) {
@@ -220,7 +271,6 @@ class RTCError extends Error {
   }
 }
 
-// Export error detail types as static property
-RTCError.DetailType = RTCErrorDetailType;
-
-module.exports = RTCError;
+export default RTCError;
+export { RTCError, RTCErrorDetailType };
+export type { RTCErrorInit, RTCErrorDetail, NativeRTCError, RTCErrorJSON };