node-datachannel 0.4.2 → 0.5.0-dev

package/node_modules/wrappy/package.json

@@ -1,62 +1,29 @@
 {
-  "_args": [
-    [
-      "wrappy@1.0.2",
-      "/home/runner/work/node-datachannel/node-datachannel"
-    ]
-  ],
-  "_from": "wrappy@1.0.2",
-  "_id": "wrappy@1.0.2",
-  "_inBundle": false,
-  "_integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=",
-  "_location": "/wrappy",
-  "_phantomChildren": {},
-  "_requested": {
-    "type": "version",
-    "registry": true,
-    "raw": "wrappy@1.0.2",
-    "name": "wrappy",
-    "escapedName": "wrappy",
-    "rawSpec": "1.0.2",
-    "saveSpec": null,
-    "fetchSpec": "1.0.2"
-  },
-  "_requiredBy": [
-    "/inflight",
-    "/once"
+  "name": "wrappy",
+  "version": "1.0.2",
+  "description": "Callback wrapping utility",
+  "main": "wrappy.js",
+  "files": [
+    "wrappy.js"
   ],
-  "_resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
-  "_spec": "1.0.2",
-  "_where": "/home/runner/work/node-datachannel/node-datachannel",
-  "author": {
-    "name": "Isaac Z. Schlueter",
-    "email": "i@izs.me",
-    "url": "http://blog.izs.me/"
-  },
-  "bugs": {
-    "url": "https://github.com/npm/wrappy/issues"
+  "directories": {
+    "test": "test"
   },
   "dependencies": {},
-  "description": "Callback wrapping utility",
   "devDependencies": {
     "tap": "^2.3.1"
   },
-  "directories": {
-    "test": "test"
+  "scripts": {
+    "test": "tap --coverage test/*.js"
   },
-  "files": [
-    "wrappy.js"
-  ],
-  "homepage": "https://github.com/npm/wrappy",
-  "license": "ISC",
-  "main": "wrappy.js",
-  "name": "wrappy",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/npm/wrappy.git"
+    "url": "https://github.com/npm/wrappy"
   },
-  "scripts": {
-    "test": "tap --coverage test/*.js"
+  "author": "Isaac Z. Schlueter <i@izs.me> (http://blog.izs.me/)",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/npm/wrappy/issues"
   },
-  "version": "1.0.2"
+  "homepage": "https://github.com/npm/wrappy"
 }

package/package.json

@@ -1,72 +1,89 @@
 {
-  "name": "node-datachannel",
-  "version": "0.4.2",
-  "description": "libdatachannel node bindings",
-  "main": "lib/index.js",
-  "typings": "lib/index.d.ts",
-  "directories": {
-    "lib": "lib",
-    "test": "test"
-  },
-  "_from": "node-datachannel@latest",
-  "scripts": {
-    "install": "prebuild-install || (npm install --ignore-scripts --production=false && npm run _prebuild)",
-    "install-nice": "npm run clean && cmake-js build --CDUSE_NICE=1",
-    "build": "cmake-js build",
-    "build:debug": "cmake-js build -D",
-    "_prebuild": "prebuild --backend cmake-js",
-    "clean": "cmake-js clean",
-    "lint": "eslint lib/**/* test/**/*",
-    "test": "jest"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/murat-dogan/node-datachannel.git"
-  },
-  "keywords": [
-    "libdatachannel",
-    "webrtc",
-    "p2p",
-    "peer-to-peer",
-    "datachannel",
-    "data channel"
-  ],
-  "contributors": [
-    {
-      "name": "Murat Doğan",
-      "url": "https://github.com/murat-dogan"
+    "name": "node-datachannel",
+    "version": "0.5.0-dev",
+    "description": "libdatachannel node bindings",
+    "type": "module",
+    "exports": {
+        ".": {
+            "import": "./lib/index.js"
+        },
+        "./polyfill": {
+            "import": "./polyfill/index.js"
+        }
     },
-    {
-      "name": "Paul-Louis Ageneau",
-      "url": "https://github.com/paullouisageneau"
+    "typings": "lib/index.d.ts",
+    "engines": {
+        "node": ">=16.0.0"
+    },
+    "directories": {
+        "lib": "lib",
+        "test": "test"
+    },
+    "_from": "node-datachannel@latest",
+    "scripts": {
+        "install": "prebuild-install -r napi || (npm install --ignore-scripts --production=false && npm run _prebuild)",
+        "install-nice": "npm run clean && npm install --ignore-scripts --production=false && cmake-js build --CDUSE_NICE=1",
+        "install-gnu-tls": "npm run clean && npm install --ignore-scripts --production=false && cmake-js build --CDUSE_GNUTLS=1",
+        "build": "cmake-js build",
+        "build:debug": "cmake-js build -D",
+        "_prebuild": "prebuild -r napi --backend cmake-js",
+        "clean": "cmake-js clean",
+        "lint": "eslint lib/**/* test/**/*",
+        "test": "NODE_OPTIONS=--experimental-vm-modules jest",
+        "wpt-test": "node test/wpt.js"
+    },
+    "binary": {
+        "napi_versions": [
+            8
+        ]
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/murat-dogan/node-datachannel.git"
+    },
+    "keywords": [
+        "libdatachannel",
+        "webrtc",
+        "p2p",
+        "peer-to-peer",
+        "datachannel",
+        "data channel"
+    ],
+    "contributors": [
+        {
+            "name": "Murat Doğan",
+            "url": "https://github.com/murat-dogan"
+        },
+        {
+            "name": "Paul-Louis Ageneau",
+            "url": "https://github.com/paullouisageneau"
+        }
+    ],
+    "license": "MPL 2.0",
+    "gypfile": true,
+    "bugs": {
+        "url": "https://github.com/murat-dogan/node-datachannel/issues"
+    },
+    "homepage": "https://github.com/murat-dogan/node-datachannel#readme",
+    "devDependencies": {
+        "@types/node": "^20.6.1",
+        "@typescript-eslint/eslint-plugin": "^5.62.0",
+        "@typescript-eslint/parser": "^5.62.0",
+        "cmake-js": "^6.3.2",
+        "eslint": "^8.49.0",
+        "eslint-config-prettier": "^8.10.0",
+        "eslint-plugin-prettier": "^4.2.1",
+        "jest": "^29.7.0",
+        "node-addon-api": "^7.0.0",
+        "prebuild": "^12.0.0",
+        "prettier": "^2.8.8",
+        "typescript": "^4.6.3"
+    },
+    "bundledDependencies": [
+        "prebuild-install"
+    ],
+    "dependencies": {
+        "node-domexception": "^2.0.1",
+        "prebuild-install": "^7.0.1"
     }
-  ],
-  "license": "MPL 2.0",
-  "gypfile": true,
-  "bugs": {
-    "url": "https://github.com/murat-dogan/node-datachannel/issues"
-  },
-  "homepage": "https://github.com/murat-dogan/node-datachannel#readme",
-  "devDependencies": {
-    "@types/node": "^17.0.23",
-    "@typescript-eslint/eslint-plugin": "^5.18.0",
-    "@typescript-eslint/parser": "^5.18.0",
-    "cmake-js": "^6.3.0",
-    "eslint": "^8.12.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^27.5.1",
-    "nan": "^2.15.0",
-    "napi-thread-safe-callback-cancellable": "^0.0.7",
-    "node-addon-api": "^4.3.0",
-    "prebuild": "^11.0.3",
-    "prettier": "^2.6.2",
-    "typescript": "^4.6.3"
-  },
-  "bundledDependencies": [
-    "prebuild-install"
-  ],
-  "dependencies": {
-    "prebuild-install": "^7.0.1"
-  }
 }

package/polyfill/Events.d.ts

@@ -0,0 +1,9 @@
+/// <reference lib="dom" />
+
+export class RTCPeerConnectionIceEvent extends Event {
+    readonly candidate: RTCIceCandidate | null;
+}
+
+export class RTCDataChannelEvent extends Event {
+    readonly channel: RTCDataChannel | null;
+}

package/polyfill/Events.js

@@ -0,0 +1,27 @@
+export class RTCPeerConnectionIceEvent extends Event {
+    #candidate;
+
+    constructor(candidate) {
+        super('icecandidate');
+
+        this.#candidate = candidate;
+    }
+
+    get candidate() {
+        return this.#candidate;
+    }
+}
+
+export class RTCDataChannelEvent extends Event {
+    #channel;
+
+    constructor(channel) {
+        super('datachannel');
+
+        this.#channel = channel;
+    }
+
+    get channel() {
+        return this.#channel;
+    }
+}

package/polyfill/README.md

@@ -0,0 +1,41 @@
+# WebRTC Polyfills
+
+> This part is ongoing work and is considered to be in beta phase.
+
+> Any feedback and contributions are welcomed.
+
+WebRTC polyfills to be used for libraries like `simple-peer`.
+
+## Example Usage
+
+> For a native usage example please check test folder.
+
+`simple-peer` usage example
+
+```js
+import Peer from 'simple-peer';
+import nodeDatachannelPolyfill from 'node-datachannel/polyfill';
+
+var peer1 = new Peer({ initiator: true, wrtc: nodeDatachannelPolyfill });
+var peer2 = new Peer({ wrtc: nodeDatachannelPolyfill });
+
+peer1.on('signal', (data) => {
+    // when peer1 has signaling data, give it to peer2 somehow
+    peer2.signal(data);
+});
+
+peer2.on('signal', (data) => {
+    // when peer2 has signaling data, give it to peer1 somehow
+    peer1.signal(data);
+});
+
+peer1.on('connect', () => {
+    // wait for 'connect' event before using the data channel
+    peer1.send('hey peer2, how is it going?');
+});
+
+peer2.on('data', (data) => {
+    // got a data channel message
+    console.log('got a message from peer1: ' + data);
+});
+```

package/polyfill/RTCCertificate.d.ts

@@ -0,0 +1,7 @@
+/// <reference lib="dom" />
+
+export default class RTCCertificate implements RTCCertificate {
+    constructor();
+    readonly expires: number;
+    getFingerprints(): RTCDtlsFingerprint[];
+}

package/polyfill/RTCCertificate.js

@@ -0,0 +1,17 @@
+export default class RTCCertificate {
+    #expires;
+    #fingerprints;
+
+    constructor() {
+        this.#expires = null;
+        this.#fingerprints = [];
+    }
+
+    get expires() {
+        return this.#expires;
+    }
+
+    getFingerprints() {
+        return this.#fingerprints;
+    }
+}

package/polyfill/RTCDataChannel.d.ts

@@ -0,0 +1,35 @@
+/// <reference lib="dom" />
+
+import NodeDataChannel from '../lib';
+
+export default class _RTCDataChannel extends EventTarget implements RTCDataChannel {
+    constructor(dataChannel: NodeDataChannel.DataChannel, opts: RTCDataChannelInit);
+
+    // events
+    onbufferedamountlow: ((this: RTCDataChannel, ev: Event) => any) | null;
+    onclose: ((this: RTCDataChannel, ev: Event) => any) | null;
+    onclosing: ((this: RTCDataChannel, ev: Event) => any) | null;
+    onerror: ((this: RTCDataChannel, ev: Event) => any) | null;
+    onmessage: ((this: RTCDataChannel, ev: MessageEvent) => any) | null;
+    onopen: ((this: RTCDataChannel, ev: Event) => any) | null;
+
+    // props
+    binaryType: BinaryType;
+    bufferedAmountLowThreshold: number;
+    readonly bufferedAmount: number;
+    readonly id: number | null;
+    readonly label: string;
+    readonly maxPacketLifeTime: number | null;
+    readonly maxRetransmits: number | null;
+    readonly negotiated: boolean;
+    readonly ordered: boolean;
+    readonly protocol: string;
+    readonly readyState: RTCDataChannelState;
+
+    // methods
+    close(): void;
+    send(data: string): void;
+    send(data: ArrayBuffer): void;
+    send(data: ArrayBufferView): void;
+    send(data: Blob): void;
+}

package/polyfill/RTCDataChannel.js

@@ -0,0 +1,175 @@
+import DOMException from 'node-domexception';
+
+export default class _RTCDataChannel extends EventTarget {
+    #dataChannel;
+    #readyState;
+    #bufferedAmountLowThreshold;
+    #binaryType;
+    #maxPacketLifeTime;
+    #maxRetransmits;
+    #negotiated;
+    #ordered;
+
+    onbufferedamountlow;
+    onclose;
+    onclosing;
+    onerror;
+    onmessage;
+    onopen;
+
+    constructor(dataChannel, opts = {}) {
+        super();
+
+        this.#dataChannel = dataChannel;
+        this.#binaryType = 'arraybuffer';
+        this.#readyState = this.#dataChannel.isOpen() ? 'open' : 'connecting';
+        this.#bufferedAmountLowThreshold = 0;
+        this.#maxPacketLifeTime = opts.maxPacketLifeTime || null;
+        this.#maxRetransmits = opts.maxRetransmits || null;
+        this.#negotiated = opts.negotiated || false;
+        this.#ordered = opts.ordered || true;
+
+        // forward dataChannel events
+        this.#dataChannel.onOpen(() => {
+            this.#readyState = 'open';
+            this.dispatchEvent(new Event('open'));
+        });
+
+        this.#dataChannel.onClosed(() => {
+            this.#readyState = 'closed';
+            this.dispatchEvent(new Event('close'));
+        });
+
+        this.#dataChannel.onError((msg) => {
+            this.dispatchEvent(
+                new RTCErrorEvent('error', {
+                    error: new RTCError(
+                        {
+                            errorDetail: 'data-channel-failure',
+                        },
+                        msg,
+                    ),
+                }),
+            );
+        });
+
+        this.#dataChannel.onBufferedAmountLow(() => {
+            this.dispatchEvent(new Event('bufferedamountlow'));
+        });
+
+        this.#dataChannel.onMessage((data) => {
+            if (ArrayBuffer.isView(data)) {
+                data = data.buffer;
+            }
+
+            this.dispatchEvent(new MessageEvent('message', { data }));
+        });
+
+        // forward events to properties
+        this.addEventListener('message', (e) => {
+            if (this.onmessage) this.onmessage(e);
+        });
+        this.addEventListener('bufferedamountlow', (e) => {
+            if (this.onbufferedamountlow) this.onbufferedamountlow(e);
+        });
+        this.addEventListener('error', (e) => {
+            if (this.onerror) this.onerror(e);
+        });
+        this.addEventListener('close', (e) => {
+            if (this.onclose) this.onclose(e);
+        });
+        this.addEventListener('closing', (e) => {
+            if (this.onclosing) this.onclosing(e);
+        });
+        this.addEventListener('open', (e) => {
+            if (this.onopen) this.onopen(e);
+        });
+    }
+
+    set binaryType(type) {
+        if (type !== 'blob' && type !== 'arraybuffer') {
+            throw new DOMException(
+                "Failed to set the 'binaryType' property on 'RTCDataChannel': Unknown binary type : " + type,
+                'TypeMismatchError',
+            );
+        }
+        this.#binaryType = type;
+    }
+
+    get binaryType() {
+        return this.#binaryType;
+    }
+
+    get bufferedAmount() {
+        return this.#dataChannel.bufferedAmount();
+    }
+
+    get bufferedAmountLowThreshold() {
+        return this.#bufferedAmountLowThreshold;
+    }
+
+    set bufferedAmountLowThreshold(value) {
+        const number = Number(value) || 0;
+        this.#bufferedAmountLowThreshold = number;
+        this.#dataChannel.setBufferedAmountLowThreshold(number);
+    }
+
+    get id() {
+        return this.#dataChannel.getId();
+    }
+
+    get label() {
+        return this.#dataChannel.getLabel();
+    }
+
+    get maxPacketLifeTime() {
+        return this.#maxPacketLifeTime;
+    }
+
+    get maxRetransmits() {
+        return this.#maxRetransmits;
+    }
+
+    get negotiated() {
+        return this.#negotiated;
+    }
+
+    get ordered() {
+        return this.#ordered;
+    }
+
+    get protocol() {
+        return this.#dataChannel.getProtocol();
+    }
+
+    get readyState() {
+        return this.#readyState;
+    }
+
+    send(data) {
+        if (this.#readyState !== 'open') {
+            throw new DOMException(
+                "Failed to execute 'send' on 'RTCDataChannel': RTCDataChannel.readyState is not 'open'",
+                'InvalidStateError',
+            );
+        }
+
+        // Needs network error, type error implemented
+        if (typeof data === 'string') {
+            this.#dataChannel.sendMessage(data);
+        } else if (data instanceof Blob) {
+            data.arrayBuffer().then((ab) => {
+                this.#dataChannel.sendMessageBinary(new Uint8Array(ab));
+            });
+        } else {
+            this.#dataChannel.sendMessageBinary(new Uint8Array(data));
+        }
+    }
+
+    close() {
+        this.#readyState = 'closing';
+        this.dispatchEvent(new Event('closing'));
+
+        this.#dataChannel.close();
+    }
+}

package/polyfill/RTCDtlsTransport.d.ts

@@ -0,0 +1,10 @@
+/// <reference lib="dom" />
+
+export default class _RTCDtlsTransport extends EventTarget implements RTCDtlsTransport {
+    readonly iceTransport: RTCIceTransport;
+    readonly state: RTCDtlsTransportState;
+    getRemoteCertificates(): ArrayBuffer[];
+
+    onstatechange: ((this: RTCDtlsTransport, ev: Event) => any) | null;
+    onerror: ((this: RTCDtlsTransport, ev: Event) => any) | null;
+}

package/polyfill/RTCDtlsTransport.js

@@ -0,0 +1,29 @@
+export default class _RTCDtlsTransport extends EventTarget {
+    #iceTransport = null;
+    #state = null;
+
+    onerror = createEmptyFunction();
+    onstatechange = createEmptyFunction();
+
+    constructor() {
+        super();
+    }
+
+    get iceTransport() {
+        return this.#iceTransport;
+    }
+
+    get state() {
+        return this.#state;
+    }
+
+    getRemoteCertificates() {
+        /** */
+    }
+}
+
+function createEmptyFunction() {
+    return () => {
+        /** */
+    };
+}

package/polyfill/RTCIceCandidate.d.ts

@@ -0,0 +1,20 @@
+/// <reference lib="dom" />
+
+export default class _RTCIceCandidate implements RTCIceCandidate {
+    constructor(init: RTCIceCandidateInit);
+    readonly address: string | null;
+    readonly candidate: string;
+    readonly component: RTCIceComponent | null;
+    readonly foundation: string | null;
+    readonly port: number | null;
+    readonly priority: number | null;
+    readonly protocol: RTCIceProtocol | null;
+    readonly relatedAddress: string | null;
+    readonly relatedPort: number | null;
+    readonly sdpMLineIndex: number | null;
+    readonly sdpMid: string | null;
+    readonly tcpType: RTCIceTcpCandidateType | null;
+    readonly type: RTCIceCandidateType | null;
+    readonly usernameFragment: string | null;
+    toJSON(): RTCIceCandidateInit;
+}