Spec compliance?

[achingbrain]

I'm trying to integrate this module with some isomorphic code that runs on node and in browsers but I've noticed some incompatibilities with the WebRTC types as supplied with TypeScript in lib.dom.d.ts.

• RTCPeerConnection

  • Missing properties
  • canTrickleIceCandidates
  • onicecandidateerror
  • oniceconnectionstatechange
  • onicegatheringstatechange
  • sctp
  • getConfiguration
  • getStats
  • restartIce
  • setConfiguration
  • dispatchEvent
  • generateCertificate
  • constructor arg iceServers is type IceServer but the IceServer.urls property is incompatible - it is string but it should be string | string[]

• RTCDataChannel

  • Missing properties
    • binaryType
    • onbufferedamountlow
    • dispatchEvent

• RTCSessionDescription

  • the constructor signature here expects two arguments, sdp: string and type: "offer" | "answer" - the spec says it should be one argument, a RTCSessionDescriptionInit dictionary with two keys type which is a value from RTCSdpType and sdp, a string

• RTCErrorEvent

  • Does not extend Event

• General

  • Uses EventTarget/Event polyfills instead of globals supplied by Node

These are just the errors tsc reported, there may be others.

[shinyoshiaki]

Spec compliance is planned in the roadmap, but no specific date has been set for when it will be implemented. https://github.com/shinyoshiaki/werift-webrtc?tab=readme-ov-file#road-map-towards-20

[achingbrain]

Sounds great. Would PRs that move this module closer to the spec be accepted?

[shinyoshiaki]

Acceptable, but be prepared to modify all existing test code if you are modifying an existing PeerConnection. It may be easier to first implement a new PeerConnection with a different name like W3CPeerConnection

[ris-work]

It could be also in the form of a polyfill like https://github.com/murat-dogan/node-datachannel/tree/master/polyfill. It has been very helpful. I am just sharing ideas. These make life much easier as we can share the same code among multiple implementations (browser, wrtc-M87, wrtc-M94, libdatachannel).