node-datachannel 0.2.2 → 0.3.0

package/.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

package/.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+build

package/.eslintrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+    parser: '@typescript-eslint/parser',
+    plugins: ['@typescript-eslint'],
+    extends: ['plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended'],
+    env: {
+        node: true,
+    },
+};

package/.github/FUNDING.yml

@@ -0,0 +1,2 @@
+# These are supported funding model platforms
+open_collective: node-datachannel

package/.github/workflows/build-linux.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x]
+        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x]
 
     steps:
       - uses: actions/checkout@v2
@@ -40,11 +40,12 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x]
+        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x]
     steps:
       - uses: actions/checkout@v2
       - name: Prepare Cross Compile
         run: |
+          sudo apt update
           sudo apt install -y g++-arm-linux-gnueabihf gcc-arm-linux-gnueabihf
           mkdir sysroot && cd sysroot
           wget https://commondatastorage.googleapis.com/chrome-linux-sysroot/toolchain/ef5c4f84bcafb7a3796d36bb1db7826317dde51c/debian_sid_arm_sysroot.tar.xz        
@@ -67,11 +68,12 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x]
+        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x]
     steps:
       - uses: actions/checkout@v2
       - name: Prepare Cross Compile
         run: |
+          sudo apt update
           sudo apt install -y g++-aarch64-linux-gnu gcc-aarch64-linux-gnu
           mkdir sysroot && cd sysroot
           wget https://commondatastorage.googleapis.com/chrome-linux-sysroot/toolchain/953c2471bc7e71a788309f6c2d2003e8b703305d/debian_sid_arm64_sysroot.tar.xz        

package/.github/workflows/build-mac.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: macos-latest
     strategy:
       matrix:
-        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x]
+        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x]
 
     steps:
       - uses: actions/checkout@v2

package/.github/workflows/build-win.yml

@@ -11,10 +11,10 @@ env:
 
 jobs:
   build-windows-x64:
-    runs-on: windows-latest
+    runs-on: windows-2019
     strategy:
       matrix:
-        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x]
+        node-version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x]
 
     steps:
       - uses: actions/checkout@v2
@@ -39,16 +39,10 @@ jobs:
           CI: true
 
   build-windows-x86:
-    runs-on: windows-latest
+    runs-on: windows-2019
     strategy:
       matrix:
-        node_version:
-          - 10
-          - 11
-          - 12
-          - 13
-          - 14
-          - 15
+        node_version: [10.x, 11.x, 12.x, 13.x, 14.x, 15.x, 16.x, 17.x]
         node_arch:
           - x86
     steps:

package/.prettierrc.js

@@ -0,0 +1,7 @@
+module.exports =  {
+  semi:  true,
+  trailingComma:  'all',
+  singleQuote:  true,
+  printWidth:  120,
+  tabWidth:  4,
+};

package/CMakeLists.txt

@@ -1,6 +1,12 @@
 cmake_minimum_required(VERSION 3.15)
 cmake_policy(SET CMP0091 NEW)
-project(node_datachannel VERSION 0.2.2)
+project(node_datachannel VERSION 0.2.4)
+
+# Workaround for https://github.com/murat-dogan/node-datachannel/issues/65
+if( NODE_RUNTIMEVERSION VERSION_GREATER_EQUAL "17.0.0")
+    add_compile_definitions(OPENSSL_API_COMPAT=0x10100001L)
+    add_compile_definitions(OPENSSL_CONFIGURED_API=0x30000000L)    
+endif()
 
 include_directories(${CMAKE_JS_INC})
 
@@ -27,7 +33,7 @@ include(FetchContent)
 FetchContent_Declare(
     libdatachannel
     GIT_REPOSITORY https://github.com/paullouisageneau/libdatachannel.git
-    GIT_TAG "v0.16.4"
+    GIT_TAG "v0.17.0"
 )
 
 option(NO_MEDIA "Disable media transport support in libdatachannel" OFF)

package/README.md

@@ -118,7 +118,7 @@ export const enum RelayType {
 
 export interface IceServer {
     hostname: string;
-    port: Number;
+    port: number;
     username?: string;
     password?: string;
     relayType?: RelayType;
@@ -271,15 +271,15 @@ Send Message as binary
 
 Query data-channel
 
-**bufferedAmount: () => Number**
+**bufferedAmount: () => number**
 
 Get current buffered amount level
 
-**maxMessageSize: () => Number**
+**maxMessageSize: () => number**
 
 Get max message size of the data-channel, that could be sent
 
-**setBufferedAmountLowThreshold: (newSize: Number) => void**
+**setBufferedAmountLowThreshold: (newSize: number) => void**
 
 Set buffer level of the `onBufferedAmountLow` callback
 

package/lib/datachannel-stream.js

@@ -0,0 +1,97 @@
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const stream = require('stream');
+
+/**
+ * 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
+ * support for piping data elsewhere.
+ *
+ * Read & written data may be either UTF-8 strings or Buffers - this difference exists at
+ * the protocol level, and is preserved here throughout.
+ */
+module.exports = class DataChannelStream extends stream.Duplex {
+    constructor(rawChannel, streamOptions) {
+        super({
+            allowHalfOpen: false, // Default to autoclose on end().
+            ...streamOptions,
+            objectMode: true, // Preserve the string/buffer distinction (WebRTC treats them differently)
+        });
+
+        this._rawChannel = rawChannel;
+        this._readActive = true;
+
+        rawChannel.onMessage((msg) => {
+            if (!this._readActive) return; // If the buffer is full, drop messages.
+
+            // If the push is rejected, we pause reading until the next call to _read().
+            this._readActive = this.push(msg);
+        });
+
+        // When the DataChannel closes, the readable & writable ends close
+        rawChannel.onClosed(() => {
+            this.push(null);
+            this.destroy();
+        });
+
+        rawChannel.onError((errMsg) => {
+            this.destroy(new Error(`DataChannel error: ${errMsg}`));
+        });
+
+        // Buffer all writes until the DataChannel opens
+        if (!rawChannel.isOpen()) {
+            this.cork();
+            rawChannel.onOpen(() => this.uncork());
+        }
+    }
+
+    _read() {
+        // Stop dropping messages, if the buffer filling up meant we were doing so before.
+        this._readActive = true;
+    }
+
+    _write(chunk, encoding, callback) {
+        let sentOk;
+
+        try {
+            if (Buffer.isBuffer(chunk)) {
+                sentOk = this._rawChannel.sendMessageBinary(chunk);
+            } else if (typeof chunk === 'string') {
+                sentOk = this._rawChannel.sendMessage(chunk);
+            } else {
+                const typeName = chunk.constructor.name || typeof chunk;
+                throw new Error(`Cannot write ${typeName} to DataChannel stream`);
+            }
+        } catch (err) {
+            return callback(err);
+        }
+
+        if (sentOk) {
+            callback(null);
+        } else {
+            callback(new Error('Failed to write to DataChannel'));
+        }
+    }
+
+    _final(callback) {
+        if (!this.allowHalfOpen) this.destroy();
+        callback(null);
+    }
+
+    _destroy(maybeErr, callback) {
+        // When the stream is destroyed, we close the DataChannel.
+        this._rawChannel.close();
+        callback(maybeErr);
+    }
+
+    get label() {
+        return this._rawChannel.getLabel();
+    }
+
+    get id() {
+        return this._rawChannel.getId();
+    }
+
+    get protocol() {
+        return this._rawChannel.getProtocol();
+    }
+};

package/lib/index.d.ts

@@ -1,7 +1,9 @@
+import * as stream from 'stream';
+
 export as namespace NodeDataChannel;
 
 // Enum in d.ts is tricky
-export type LogLevel = "Verbose" | "Debug" | "Info" | "Warning" | "Error" | "Fatal";
+export type LogLevel = 'Verbose' | 'Debug' | 'Info' | 'Warning' | 'Error' | 'Fatal';
 
 // SCTP Settings
 export interface SctpSettings {
@@ -24,7 +26,7 @@ export type ProxyServerType = 'None' | 'Socks5' | 'Http';
 export interface ProxyServer {
     type: ProxyServerType;
     ip: string;
-    port: Number;
+    port: number;
     username?: string;
     password?: string;
 }
@@ -32,12 +34,12 @@ export interface ProxyServer {
 export const enum RelayType {
     TurnUdp = 'TurnUdp',
     TurnTcp = 'TurnTcp',
-    TurnTls = 'TurnTls'
+    TurnTls = 'TurnTls',
 }
 
 export interface IceServer {
     hostname: string;
-    port: Number;
+    port: number;
     username?: string;
     password?: string;
     relayType?: RelayType;
@@ -59,11 +61,13 @@ export const enum DescriptionType {
     Offer = 'Offer',
     Answer = 'Answer',
     Pranswer = 'Pranswer',
-    Rollback = 'Rollback'
+    Rollback = 'Rollback',
 }
 
 export const enum ReliabilityType {
-    Reliable = 0, Rexmit = 1, Timed = 2
+    Reliable = 0,
+    Rexmit = 1,
+    Timed = 2,
 }
 
 export interface DataChannelInitConfig {
@@ -79,7 +83,7 @@ export interface DataChannelInitConfig {
         type?: ReliabilityType;
         unordered?: boolean;
         rexmit?: number;
-    }
+    };
 }
 
 export interface SelectedCandidateInfo {
@@ -90,23 +94,23 @@ export interface SelectedCandidateInfo {
 }
 
 // Must be same as rtc enum class Direction
-export enum Direction {
+export const enum Direction {
     SendOnly = 'SendOnly',
     RecvOnly = 'RecvOnly',
     SendRecv = 'SendRecv',
     Inactive = 'Inactive',
-    Unknown = 'Unknown'
+    Unknown = 'Unknown',
 }
 
 export class RtcpReceivingSession {
-    requestBitrate: (bitRate: Number) => void;
+    requestBitrate: (bitRate: number) => void;
     requestKeyframe: () => boolean;
 }
 
 export class Audio {
     constructor(mid: string, dir: Direction);
-    addAudioCodec: (payloadType: Number, codec: string, profile?: string) => void;
-    addOpusCodec: (payloadType: Number, profile?: string) => string;
+    addAudioCodec: (payloadType: number, codec: string, profile?: string) => void;
+    addOpusCodec: (payloadType: number, profile?: string) => string;
 
     direction: () => Direction;
     generateSdp: (eol: string, addr: string, port: string) => string;
@@ -114,26 +118,26 @@ export class Audio {
     setDirection: (dir: Direction) => void;
     description: () => string;
     removeFormat: (fmt: string) => void;
-    addSSRC: (ssrc: Number, name?: string, msid?: string, trackID?: string) => void;
-    removeSSRC: (ssrc: Number) => void;
-    replaceSSRC: (oldSsrc: Number, ssrc: Number, name?: string, msid?: string, trackID?: string) => void;
-    hasSSRC: (ssrc: Number) => boolean;
-    getSSRCs: () => Number[];
-    getCNameForSsrc: (ssrc: Number) => string;
-    setBitrate: (bitRate: Number) => void;
-    getBitrate: () => Number;
-    hasPayloadType: (payloadType: Number) => boolean;
-    addRTXCodec: (payloadType: Number, originalPayloadType: Number, clockRate: Number) => void;
+    addSSRC: (ssrc: number, name?: string, msid?: string, trackID?: string) => void;
+    removeSSRC: (ssrc: number) => void;
+    replaceSSRC: (oldSsrc: number, ssrc: number, name?: string, msid?: string, trackID?: string) => void;
+    hasSSRC: (ssrc: number) => boolean;
+    getSSRCs: () => number[];
+    getCNameForSsrc: (ssrc: number) => string;
+    setBitrate: (bitRate: number) => void;
+    getBitrate: () => number;
+    hasPayloadType: (payloadType: number) => boolean;
+    addRTXCodec: (payloadType: number, originalPayloadType: number, clockRate: number) => void;
     addRTPMap: () => void;
     parseSdpLine: (line: string) => void;
 }
 
 export class Video {
     constructor(mid: string, dir: Direction);
-    addVideoCodec: (payloadType: Number, codec: string, profile?: string) => void;
-    addH264Codec: (payloadType: Number, profile?: string) => void;
-    addVP8Codec: (payloadType: Number) => void;
-    addVP9Codec: (payloadType: Number) => void;
+    addVideoCodec: (payloadType: number, codec: string, profile?: string) => void;
+    addH264Codec: (payloadType: number, profile?: string) => void;
+    addVP8Codec: (payloadType: number) => void;
+    addVP9Codec: (payloadType: number) => void;
 
     direction: () => Direction;
     generateSdp: (eol: string, addr: string, port: string) => string;
@@ -141,16 +145,16 @@ export class Video {
     setDirection: (dir: Direction) => void;
     description: () => string;
     removeFormat: (fmt: string) => void;
-    addSSRC: (ssrc: Number, name?: string, msid?: string, trackID?: string) => void;
-    removeSSRC: (ssrc: Number) => void;
-    replaceSSRC: (oldSsrc: Number, ssrc: Number, name?: string, msid?: string, trackID?: string) => void;
-    hasSSRC: (ssrc: Number) => boolean;
-    getSSRCs: () => Number[];
-    getCNameForSsrc: (ssrc: Number) => string;
-    setBitrate: (bitRate: Number) => void;
-    getBitrate: () => Number;
-    hasPayloadType: (payloadType: Number) => boolean;
-    addRTXCodec: (payloadType: Number, originalPayloadType: Number, clockRate: Number) => void;
+    addSSRC: (ssrc: number, name?: string, msid?: string, trackID?: string) => void;
+    removeSSRC: (ssrc: number) => void;
+    replaceSSRC: (oldSsrc: number, ssrc: number, name?: string, msid?: string, trackID?: string) => void;
+    hasSSRC: (ssrc: number) => boolean;
+    getSSRCs: () => number[];
+    getCNameForSsrc: (ssrc: number) => string;
+    setBitrate: (bitRate: number) => void;
+    getBitrate: () => number;
+    hasPayloadType: (payloadType: number) => boolean;
+    addRTXCodec: (payloadType: number, originalPayloadType: number, clockRate: number) => void;
     addRTPMap: () => void;
     parseSdpLine: (line: string) => void;
 }
@@ -158,39 +162,37 @@ export class Video {
 export class Track {
     direction: () => Direction;
     mid: () => string;
+    type: () => string;
     close: () => void;
     sendMessage: (msg: string) => boolean;
     sendMessageBinary: (buffer: Buffer) => boolean;
     isOpen: () => boolean;
     isClosed: () => boolean;
-    availableAmount: () => Number;
-    bufferedAmount: () => Number;
-    maxMessageSize: () => Number;
-    setBufferedAmountLowThreshold: (newSize: Number) => void;
+    bufferedAmount: () => number;
+    maxMessageSize: () => number;
+    setBufferedAmountLowThreshold: (newSize: number) => void;
     requestKeyframe: () => boolean;
-    setMediaHandler: (handler: RtcpReceivingSession) => void
+    setMediaHandler: (handler: RtcpReceivingSession) => void;
     onOpen: (cb: () => void) => void;
     onClosed: (cb: () => void) => void;
     onError: (cb: (err: string) => void) => void;
-    onAvailable: (cb: () => void) => void;
-    onBufferedAmountLow: (cb: () => void) => void;
-    onMessage: (cb: (msg: string | Buffer) => void) => void;
+    onMessage: (cb: (msg: Buffer) => void) => void;
 }
 
 export class DataChannel {
     close: () => void;
     getLabel: () => string;
+    getId: () => number;
+    getProtocol: () => string;
     sendMessage: (msg: string) => boolean;
     sendMessageBinary: (buffer: Buffer) => boolean;
     isOpen: () => boolean;
-    availableAmount: () => Number;
-    bufferedAmount: () => Number;
-    maxMessageSize: () => Number;
-    setBufferedAmountLowThreshold: (newSize: Number) => void;
+    bufferedAmount: () => number;
+    maxMessageSize: () => number;
+    setBufferedAmountLowThreshold: (newSize: number) => void;
     onOpen: (cb: () => void) => void;
     onClosed: (cb: () => void) => void;
     onError: (cb: (err: string) => void) => void;
-    onAvailable: (cb: () => void) => void;
     onBufferedAmountLow: (cb: () => void) => void;
     onMessage: (cb: (msg: string | Buffer) => void) => void;
 }
@@ -198,9 +200,9 @@ export class DataChannel {
 export class PeerConnection {
     constructor(peerName: string, config: RtcConfig);
     close: () => void;
-    setLocalDescription: (type: DescriptionType) => void;
+    setLocalDescription: (type?: DescriptionType) => void;
     setRemoteDescription: (sdp: string, type: DescriptionType) => void;
-    localDescription: () => { type: string, sdp: string };
+    localDescription: () => { type: string; sdp: string };
     addRemoteCandidate: (candidate: string, mid: string) => void;
     createDataChannel: (label: string, config?: DataChannelInitConfig) => DataChannel;
     addTrack: (media: Video | Audio) => Track;
@@ -214,9 +216,14 @@ export class PeerConnection {
     onSignalingStateChange: (state: (sdp: string) => void) => void;
     onGatheringStateChange: (state: (sdp: string) => void) => void;
     onDataChannel: (cb: (dc: DataChannel) => void) => void;
-    onTrack: () => Track;
+    onTrack: (cb: (track: Track) => void) => void;
     bytesSent: () => number;
     bytesReceived: () => number;
     rtt: () => number;
-    getSelectedCandidatePair: () => { local: SelectedCandidateInfo, remote: SelectedCandidateInfo } | null;
+    getSelectedCandidatePair: () => { local: SelectedCandidateInfo; remote: SelectedCandidateInfo } | null;
+}
+
+export class DataChannelStream extends stream.Duplex {
+    constructor(rawChannel: DataChannel, options?: Omit<stream.DuplexOptions, 'objectMode'>);
+    get label(): string;
 }

package/lib/index.js

@@ -1,2 +1,5 @@
-const nodeDataChannel = require("../build/Release/node_datachannel.node");
-module.exports = nodeDataChannel;
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const nodeDataChannel = require('../build/Release/node_datachannel.node');
+module.exports = nodeDataChannel;
+
+module.exports.DataChannelStream = require('./datachannel-stream');

package/node_modules/decompress-response/index.d.ts

@@ -1,29 +1,22 @@
 /// <reference types="node"/>
 import {IncomingMessage} from 'http';
 
-declare const decompressResponse: {
-	/**
-	Decompress a HTTP response if needed.
+/**
+Decompress a HTTP response if needed.
 
-	@param response - The HTTP incoming stream with compressed data.
-	@returns The decompressed HTTP response stream.
+@param response - The HTTP incoming stream with compressed data.
+@returns The decompressed HTTP response stream.
 
-	@example
-	```
-	import {http} from 'http';
-	import decompressResponse = require('decompress-response');
+@example
+```
+import {http} from 'http';
+import decompressResponse = require('decompress-response');
 
-	http.get('https://sindresorhus.com', response => {
-		response = decompressResponse(response);
-	});
-	```
-	*/
-	(response: IncomingMessage): IncomingMessage;
-
-	// TODO: remove this in the next major version, refactor the whole definition to:
-	// declare function decompressResponse(response: IncomingMessage): IncomingMessage;
-	// export = decompressResponse;
-	default: typeof decompressResponse;
-};
+http.get('https://sindresorhus.com', response => {
+	response = decompressResponse(response);
+});
+```
+*/
+declare function decompressResponse(response: IncomingMessage): IncomingMessage;
 
 export = decompressResponse;

package/node_modules/decompress-response/index.js

@@ -1,40 +1,58 @@
 'use strict';
-const {PassThrough: PassThroughStream} = require('stream');
+const {Transform, PassThrough} = require('stream');
 const zlib = require('zlib');
 const mimicResponse = require('mimic-response');
 
-const decompressResponse = response => {
+module.exports = response => {
 	const contentEncoding = (response.headers['content-encoding'] || '').toLowerCase();
 
 	if (!['gzip', 'deflate', 'br'].includes(contentEncoding)) {
 		return response;
 	}
 
+	// TODO: Remove this when targeting Node.js 12.
 	const isBrotli = contentEncoding === 'br';
 	if (isBrotli && typeof zlib.createBrotliDecompress !== 'function') {
+		response.destroy(new Error('Brotli is not supported on Node.js < 12'));
 		return response;
 	}
 
-	const decompress = isBrotli ? zlib.createBrotliDecompress() : zlib.createUnzip();
-	const stream = new PassThroughStream();
+	let isEmpty = true;
 
-	mimicResponse(response, stream);
+	const checker = new Transform({
+		transform(data, _encoding, callback) {
+			isEmpty = false;
 
-	decompress.on('error', error => {
-		// Ignore empty response
-		if (error.code === 'Z_BUF_ERROR') {
-			stream.end();
+			callback(null, data);
+		},
+
+		flush(callback) {
+			callback();
+		}
+	});
+
+	const finalStream = new PassThrough({
+		autoDestroy: false,
+		destroy(error, callback) {
+			response.destroy();
+
+			callback(error);
+		}
+	});
+
+	const decompressStream = isBrotli ? zlib.createBrotliDecompress() : zlib.createUnzip();
+
+	decompressStream.once('error', error => {
+		if (isEmpty && !response.readable) {
+			finalStream.end();
 			return;
 		}
 
-		stream.emit('error', error);
+		finalStream.destroy(error);
 	});
 
-	response.pipe(decompress).pipe(stream);
+	mimicResponse(response, finalStream);
+	response.pipe(checker).pipe(decompressStream).pipe(finalStream);
 
-	return stream;
+	return finalStream;
 };
-
-module.exports = decompressResponse;
-// TODO: remove this in the next major version
-module.exports.default = decompressResponse;

package/node_modules/decompress-response/license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: