node-datachannel 0.10.1 → 0.12.0

package/examples/electron-demo/package.json

@@ -27,6 +27,7 @@
         "@electron-forge/plugin-webpack": "^6.4.2",
         "@electron/rebuild": "^3.3.0",
         "@vercel/webpack-asset-relocator-loader": "^1.7.3",
+        "copy-webpack-plugin": "^12.0.2",
         "css-loader": "^6.8.1",
         "electron": "26.2.4",
         "node-loader": "^2.0.0",
@@ -40,4 +41,4 @@
         "runtime": "electron",
         "runtimeVersion": "26.2.0"
     }
-}
+}

package/examples/electron-demo/webpack.main.config.js

@@ -1,3 +1,5 @@
+const CopyPlugin = require('copy-webpack-plugin');
+
 module.exports = {
     /**
      * This is the main entry point for your application, it's the first file
@@ -8,4 +10,12 @@ module.exports = {
     module: {
         rules: require('./webpack.rules'),
     },
+    externals: {
+        'node-datachannel': 'node-datachannel',
+    },
+    plugins: [
+        new CopyPlugin({
+            patterns: [{ from: 'node_modules/node-datachannel', to: 'node_modules/node-datachannel' }],
+        }),
+    ],
 };

package/examples/websocket/websocket-client.js

@@ -0,0 +1,20 @@
+import * as nodeDataChannel from '../../lib/index.js';
+
+const clientSocket = new nodeDataChannel.WebSocket();
+
+clientSocket.open('ws://127.0.0.1:3000');
+
+clientSocket.onOpen(() => {
+    console.log('Client socket opened');
+    clientSocket.sendMessage('Echo this!');
+});
+
+clientSocket.onMessage((message) => {
+    console.log('Message from server: ' + message);
+});
+
+clientSocket.onClosed(() => {
+    console.log('Client socket closed');
+});
+
+// clientSocket.close();

package/examples/websocket/websocket-server.js

@@ -0,0 +1,22 @@
+import * as nodeDataChannel from '../../lib/index.js';
+
+const ws = new nodeDataChannel.WebSocketServer({ bindAddress: '127.0.0.1', port: 3000 });
+
+ws.onClient((clientSocket) => {
+    clientSocket.onOpen(() => {
+        console.log('Client socket opened');
+        clientSocket.sendMessage('Hello from server');
+    });
+
+    clientSocket.onMessage((message) => {
+        console.log('Message from client: ' + message);
+        clientSocket.sendMessage(message);
+    });
+
+    clientSocket.onClosed(() => {
+        console.log('Client socket closed');
+    });
+});
+
+// When done, close the server
+// ws.stop();

package/jest.config.cjs

@@ -1,7 +1,7 @@
 /** @type {import('jest').Config} */
 const config = {
     verbose: true,
-    testPathIgnorePatterns: ['<rootDir>/node_modules/', 'multiple-run.test'],
+    testPathIgnorePatterns: ['node_modules', 'multiple-run.test', 'wpt-tests'],
 };
 
 module.exports = config;

package/lib/index.cjs

@@ -4,8 +4,14 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var module$1 = require('module');
 var stream = require('stream');
+var events = require('events');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
+// createRequire is native in node version >= 12
+const require$1 = module$1.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)));
+
+const nodeDataChannel = require$1('../build/Release/node_datachannel.node');
+
 /**
  * Turns a node-datachannel DataChannel into a real Node.js stream, complete with buffering,
  * backpressure (up to a point - if the buffer fills up, messages are dropped), and
@@ -101,10 +107,37 @@ class DataChannelStream extends stream.Duplex {
     }
 }
 
-// createRequire is native in node version >= 12
-const require$1 = module$1.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)));
+class WebSocketServer extends events.EventEmitter {
+    #server;
+    #clients = [];
 
-const nodeDataChannel = require$1('../build/Release/node_datachannel.node');
+    constructor(options) {
+        super();
+        this.#server = new nodeDataChannel.WebSocketServer(options);
+
+        this.#server.onClient((client) => {
+            this.emit('client', client);
+            this.#clients.push(client);
+        });
+    }
+
+    port() {
+        return this.#server?.port() || 0;
+    }
+
+    stop() {
+        this.#clients.forEach((client) => {
+            client?.close();
+        });
+        this.#server?.stop();
+        this.#server = null;
+        this.removeAllListeners();
+    }
+
+    onClient(cb) {
+        if (this.#server) this.on('client', cb);
+    }
+}
 
 const {
     initLogger,
@@ -118,14 +151,8 @@ const {
     DataChannel,
     PeerConnection,
     WebSocket,
-    WebSocketServer,
 } = nodeDataChannel;
 
-var index = {
-    ...nodeDataChannel,
-    DataChannelStream,
-};
-
 const DescriptionType = {
     Unspec: 'unspec',
     Offer: 'offer',
@@ -134,6 +161,22 @@ const DescriptionType = {
     Rollback: 'rollback',
 };
 
+var index = {
+    initLogger,
+    cleanup,
+    preload,
+    setSctpSettings,
+    RtcpReceivingSession,
+    Track,
+    Video,
+    Audio,
+    DataChannel,
+    PeerConnection,
+    WebSocket,
+    WebSocketServer,
+    DataChannelStream,
+};
+
 exports.Audio = Audio;
 exports.DataChannel = DataChannel;
 exports.DataChannelStream = DataChannelStream;

package/lib/index.js

@@ -1,9 +1,6 @@
-// createRequire is native in node version >= 12
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-
-const nodeDataChannel = require('../build/Release/node_datachannel.node');
+import nodeDataChannel from './node-datachannel.js';
 import DataChannelStream from './datachannel-stream.js';
+import WebSocketServer from './websocket-server.js';
 
 const {
     initLogger,
@@ -17,9 +14,16 @@ const {
     DataChannel,
     PeerConnection,
     WebSocket,
-    WebSocketServer,
 } = nodeDataChannel;
 
+export const DescriptionType = {
+    Unspec: 'unspec',
+    Offer: 'offer',
+    Answer: 'answer',
+    Pranswer: 'pranswer',
+    Rollback: 'rollback',
+};
+
 export {
     initLogger,
     cleanup,
@@ -38,14 +42,17 @@ export {
 };
 
 export default {
-    ...nodeDataChannel,
+    initLogger,
+    cleanup,
+    preload,
+    setSctpSettings,
+    RtcpReceivingSession,
+    Track,
+    Video,
+    Audio,
+    DataChannel,
+    PeerConnection,
+    WebSocket,
+    WebSocketServer,
     DataChannelStream,
 };
-
-export const DescriptionType = {
-    Unspec: 'unspec',
-    Offer: 'offer',
-    Answer: 'answer',
-    Pranswer: 'pranswer',
-    Rollback: 'rollback',
-};

package/lib/node-datachannel.js

@@ -0,0 +1,7 @@
+// createRequire is native in node version >= 12
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+
+const nodeDataChannel = require('../build/Release/node_datachannel.node');
+
+export default nodeDataChannel;

package/lib/websocket-server.js

@@ -0,0 +1,34 @@
+import { EventEmitter } from 'events';
+import nodeDataChannel from './node-datachannel.js';
+
+export default class WebSocketServer extends EventEmitter {
+    #server;
+    #clients = [];
+
+    constructor(options) {
+        super();
+        this.#server = new nodeDataChannel.WebSocketServer(options);
+
+        this.#server.onClient((client) => {
+            this.emit('client', client);
+            this.#clients.push(client);
+        });
+    }
+
+    port() {
+        return this.#server?.port() || 0;
+    }
+
+    stop() {
+        this.#clients.forEach((client) => {
+            client?.close();
+        });
+        this.#server?.stop();
+        this.#server = null;
+        this.removeAllListeners();
+    }
+
+    onClient(cb) {
+        if (this.#server) this.on('client', cb);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-datachannel",
-    "version": "0.10.1",
+    "version": "0.12.0",
     "description": "libdatachannel node bindings",
     "type": "module",
     "types": "./lib/index.d.ts",
@@ -93,8 +93,8 @@
         "node-addon-api": "^7.0.0",
         "prebuild": "^12.0.0",
         "prettier": "^2.8.8",
-        "typescript": "^5.3.2",
-        "rollup": "^4.14.1"
+        "rollup": "^4.14.1",
+        "typescript": "^5.3.2"
     },
     "dependencies": {
         "node-domexception": "^2.0.1",

package/polyfill/Events.js

@@ -15,10 +15,12 @@ export class RTCPeerConnectionIceEvent extends Event {
 export class RTCDataChannelEvent extends Event {
     #channel;
 
-    constructor(channel) {
-        super('datachannel');
+    constructor(type, eventInitDict) {
+        super(type);
 
-        this.#channel = channel;
+        if (type && !eventInitDict.channel) throw new TypeError('channel member is required');
+
+        this.#channel = eventInitDict?.channel;
     }
 
     get channel() {

package/polyfill/Exception.js

@@ -0,0 +1,23 @@
+export const InvalidStateError = (msg) => {
+    return new DOMException(msg, 'InvalidStateError');
+};
+
+export const InvalidAccessError = (msg) => {
+    return new DOMException(msg, 'InvalidAccessError');
+};
+
+export const NotFoundError = (msg) => {
+    return new DOMException(msg, 'NotFoundError');
+};
+
+export const OperationError = (msg) => {
+    return new DOMException(msg, 'OperationError');
+};
+
+export const TypeError = (msg) => {
+    return new DOMException(msg, 'TypeError');
+};
+
+export const SyntaxError = (msg) => {
+    return new DOMException(msg, 'SyntaxError');
+};

package/polyfill/README.md

@@ -2,6 +2,10 @@
 
 WebRTC polyfills to be used for libraries like `simple-peer`.
 
+# web-platform-tests
+
+Please check actual situation [here](/test/wpt-tests/)
+
 ## Example Usage
 
 > For a native usage example please check test folder.

package/polyfill/RTCDataChannel.js

@@ -1,4 +1,5 @@
-import DOMException from 'node-domexception';
+import 'node-domexception';
+import * as exceptions from './Exception.js';
 
 export default class _RTCDataChannel extends EventTarget {
     #dataChannel;
@@ -10,6 +11,8 @@ export default class _RTCDataChannel extends EventTarget {
     #negotiated;
     #ordered;
 
+    #closeRequested = false;
+
     onbufferedamountlow;
     onclose;
     onclosing;
@@ -32,12 +35,20 @@ export default class _RTCDataChannel extends EventTarget {
         // forward dataChannel events
         this.#dataChannel.onOpen(() => {
             this.#readyState = 'open';
-            this.dispatchEvent(new Event('open'));
+            this.dispatchEvent(new Event('open', { channel: this }));
         });
 
         this.#dataChannel.onClosed(() => {
-            this.#readyState = 'closed';
-            this.dispatchEvent(new Event('close'));
+            // Simulate closing event
+            if (!this.#closeRequested) {
+                this.#readyState = 'closing';
+                this.dispatchEvent(new Event('closing', { channel: this }));
+            }
+
+            setImmediate(() => {
+                this.#readyState = 'closed';
+                this.dispatchEvent(new Event('close', { channel: this }));
+            });
         });
 
         this.#dataChannel.onError((msg) => {
@@ -54,7 +65,7 @@ export default class _RTCDataChannel extends EventTarget {
         });
 
         this.#dataChannel.onBufferedAmountLow(() => {
-            this.dispatchEvent(new Event('bufferedamountlow'));
+            this.dispatchEvent(new Event('bufferedamountlow', { channel: this }));
         });
 
         this.#dataChannel.onMessage((data) => {
@@ -62,7 +73,7 @@ export default class _RTCDataChannel extends EventTarget {
                 data = data.buffer;
             }
 
-            this.dispatchEvent(new MessageEvent('message', { data }));
+            this.dispatchEvent(new MessageEvent('message', { data, channel: this }));
         });
 
         // forward events to properties
@@ -148,9 +159,8 @@ export default class _RTCDataChannel extends EventTarget {
 
     send(data) {
         if (this.#readyState !== 'open') {
-            throw new DOMException(
+            throw exceptions.InvalidStateError(
                 "Failed to execute 'send' on 'RTCDataChannel': RTCDataChannel.readyState is not 'open'",
-                'InvalidStateError',
             );
         }
 
@@ -167,9 +177,7 @@ export default class _RTCDataChannel extends EventTarget {
     }
 
     close() {
-        this.#readyState = 'closing';
-        this.dispatchEvent(new Event('closing'));
-
+        this.#closeRequested = true;
         this.#dataChannel.close();
     }
 }

package/polyfill/RTCError.d.ts

@@ -0,0 +1,11 @@
+/// <reference lib="dom" />
+
+export class _RTCError extends DOMException implements RTCError {
+    constructor(init: RTCErrorInit, message?: string);
+    // type RTCErrorDetailType = "data-channel-failure" | "dtls-failure" | "fingerprint-failure" | "hardware-encoder-error" | "hardware-encoder-not-available" | "sctp-failure" | "sdp-syntax-error";
+    readonly errorDetail: RTCErrorDetailType;
+    readonly receivedAlert: number | null;
+    readonly sctpCauseCode: number | null;
+    readonly sdpLineNumber: number | null;
+    readonly sentAlert: number | null;
+}

package/polyfill/RTCError.js

@@ -0,0 +1,65 @@
+export default class RTCError extends DOMException {
+    constructor(init, message = '') {
+        super(message, 'OperationError');
+
+        if (!init || !init.errorDetail) throw new TypeError('Cannot construct RTCError, errorDetail is required');
+        if (
+            [
+                'data-channel-failure',
+                'dtls-failure',
+                'fingerprint-failure',
+                'hardware-encoder-error',
+                'hardware-encoder-not-available',
+                'sctp-failure',
+                'sdp-syntax-error',
+            ].indexOf(init.errorDetail) === -1
+        )
+            throw new TypeError('Cannot construct RTCError, errorDetail is invalid');
+
+        this._errorDetail = init.errorDetail;
+        this._receivedAlert = init.receivedAlert ?? null;
+        this._sctpCauseCode = init.sctpCauseCode ?? null;
+        this._sdpLineNumber = init.sdpLineNumber ?? null;
+        this._sentAlert = init.sentAlert ?? null;
+    }
+
+    get errorDetail() {
+        return this._errorDetail;
+    }
+
+    set errorDetail(value) {
+        throw new TypeError('Cannot set errorDetail, it is read-only');
+    }
+
+    get receivedAlert() {
+        return this._receivedAlert;
+    }
+
+    set receivedAlert(value) {
+        throw new TypeError('Cannot set receivedAlert, it is read-only');
+    }
+
+    get sctpCauseCode() {
+        return this._sctpCauseCode;
+    }
+
+    set sctpCauseCode(value) {
+        throw new TypeError('Cannot set sctpCauseCode, it is read-only');
+    }
+
+    get sdpLineNumber() {
+        return this._sdpLineNumber;
+    }
+
+    set sdpLineNumber(value) {
+        throw new TypeError('Cannot set sdpLineNumber, it is read-only');
+    }
+
+    get sentAlert() {
+        return this._sentAlert;
+    }
+
+    set sentAlert(value) {
+        throw new TypeError('Cannot set sentAlert, it is read-only');
+    }
+}

package/polyfill/RTCIceCandidate.js

@@ -2,7 +2,7 @@
 //
 // Example: candidate:123456 1 UDP 123456 192.168.1.1 12345 typ host raddr=10.0.0.1 rport=54321 generation 0
 
-import DOMException from 'node-domexception';
+import 'node-domexception';
 
 export default class _RTCIceCandidate {
     #address;
@@ -19,41 +19,40 @@ export default class _RTCIceCandidate {
     #tcpType;
     #type;
     #usernameFragment;
-    #ip;
 
     constructor({ candidate, sdpMLineIndex, sdpMid, usernameFragment }) {
-        if (candidate == null) {
-            throw new DOMException('candidate must be specified');
-        }
+        if (sdpMLineIndex == null && sdpMid == null)
+            throw new TypeError('At least one of sdpMLineIndex or sdpMid must be specified');
 
-        this.#candidate = candidate;
-        this.#sdpMLineIndex = sdpMLineIndex || null;
-        this.#sdpMid = sdpMid || null;
-        this.#usernameFragment = usernameFragment || null;
+        this.#candidate = candidate === null ? 'null' : candidate ?? '';
+        this.#sdpMLineIndex = sdpMLineIndex ?? null;
+        this.#sdpMid = sdpMid ?? null;
+        this.#usernameFragment = usernameFragment ?? null;
 
         if (candidate) {
             const fields = candidate.split(' ');
-            this.#foundation = fields[0];
+            this.#foundation = fields[0].replace('candidate:', ''); // remove text candidate:
             this.#component = fields[1] == '1' ? 'rtp' : 'rtcp';
             this.#protocol = fields[2];
             this.#priority = parseInt(fields[3], 10);
-            this.#ip = fields[4];
+            this.#address = fields[4];
             this.#port = parseInt(fields[5], 10);
             this.#type = fields[7];
-            if (fields[6] === 'typ') {
-                this.#tcpType = null;
-            } else if (fields[6] === 'tcp') {
-                this.#tcpType = fields[7];
-                this.#type = fields[8];
-            }
+            this.#tcpType = null;
+            this.#relatedAddress = null;
+            this.#relatedPort = null;
 
             // Parse the candidate string to extract relatedPort and relatedAddress
-            for (let i = 9; i < fields.length; i++) {
+            for (let i = 8; i < fields.length; i++) {
                 const field = fields[i];
-                if (field.startsWith('raddr')) {
-                    this.#relatedAddress = field.split('=')[1];
-                } else if (field.startsWith('rport')) {
-                    this.#relatedPort = parseInt(field.split('=')[1], 10);
+                if (field === 'raddr') {
+                    this.#relatedAddress = fields[i + 1];
+                } else if (field === 'rport') {
+                    this.#relatedPort = parseInt(fields[i + 1], 10);
+                }
+
+                if (this.#protocol === 'tcp' && field === 'tcptype') {
+                    this.#tcpType = fields[i + 1];
                 }
             }
         }
@@ -64,7 +63,7 @@ export default class _RTCIceCandidate {
     }
 
     get candidate() {
-        return this.#candidate || '';
+        return this.#candidate;
     }
 
     get component() {