@lng2004/node-datachannel 0.31.0-20251228

package/.clang-format

@@ -0,0 +1,17 @@
+BasedOnStyle: LLVM
+
+# Indentation
+NamespaceIndentation: All
+
+# Braces
+BreakBeforeBraces: Allman
+
+#include
+SortIncludes: false
+
+# Line Length
+ColumnLimit: 120
+
+# Line Breaks
+AlwaysBreakTemplateDeclarations: true
+LambdaBodyIndentation: OuterScope

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,8 @@
+node_modules
+build
+dist
+/**/*.js
+jest.config.ts
+rollup.config.mjs
+test/wpt-tests/
+examples

package/.eslintrc.json

@@ -0,0 +1,27 @@
+{
+  "env": {
+    "browser": false,
+    "es6": true,
+    "node": true
+  },
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": "tsconfig.json",
+    "sourceType": "module",
+    "ecmaVersion": 2020
+  },
+  "plugins": ["@typescript-eslint", "jest"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:jest/recommended",
+    "prettier"
+  ],
+  "rules": {
+    // The following rule is enabled only to supplement the inline suppression
+    // examples, and because it is not a recommended rule, you should either
+    // disable it, or understand what it enforces.
+    // https://typescript-eslint.io/rules/explicit-function-return-type/
+    "@typescript-eslint/explicit-function-return-type": "warn"
+  }
+}

package/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "test/wpt-tests/wpt"]
+	path = test/wpt-tests/wpt
+	url = https://github.com/web-platform-tests/wpt.git

package/.prettierignore

@@ -0,0 +1,7 @@
+test/wpt-tests/wpt
+vcpkg
+out
+.webpack
+build
+dist
+prebuilds

package/.prettierrc

@@ -0,0 +1,13 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 100,
+  "overrides": [
+    {
+      "files": ["*.ts", "*.mts"],
+      "options": {
+        "parser": "typescript"
+      }
+    }
+  ]
+}

package/API.md

@@ -0,0 +1,247 @@
+# API
+
+## PeerConnection Class
+
+**Constructor**
+
+let pc = new PeerConnection(peerName[,options])
+
+- peerName `<string>` Peer name to use for logs etc..
+- options `<Object>` WebRTC Config Options
+
+```
+export interface RtcConfig {
+    iceServers: (string | IceServer)[];
+    proxyServer?: ProxyServer;
+    bindAddress?: string;
+    enableIceTcp?: boolean;
+    enableIceUdpMux?: boolean;
+    disableAutoNegotiation?: boolean;
+    disableFingerprintVerification?: boolean;
+    disableAutoGathering?: boolean;
+    forceMediaTransport?: boolean;
+    portRangeBegin?: number;
+    portRangeEnd?: number;
+    maxMessageSize?: number;
+    mtu?: number;
+    iceTransportPolicy?: TransportPolicy;
+    disableFingerprintVerification?: boolean;
+    certificatePemFile?: string;
+    keyPemFile?: string;
+    keyPemPass?: string;
+}
+
+export const enum RelayType {
+    TurnUdp = 'TurnUdp',
+    TurnTcp = 'TurnTcp',
+    TurnTls = 'TurnTls'
+}
+
+export interface IceServer {
+    hostname: string;
+    port: number;
+    username?: string;
+    password?: string;
+    relayType?: RelayType;
+}
+
+export type TransportPolicy = 'all' | 'relay';
+
+"iceServers" option is an array of stun/turn server urls
+Examples;
+STUN Server Example          : stun:stun.l.google.com:19302
+TURN Server Example          : turn:USERNAME:PASSWORD@TURN_IP_OR_ADDRESS:PORT
+TURN Server Example (TCP)    : turn:USERNAME:PASSWORD@TURN_IP_OR_ADDRESS:PORT?transport=tcp
+TURN Server Example (TLS)    : turns:USERNAME:PASSWORD@TURN_IP_OR_ADDRESS:PORT
+
+```
+
+**close: () => void**
+
+Close Peer Connection
+
+**destroy: () => void**
+
+Close Peer Connection & Clear all callbacks
+
+**setRemoteDescription: (sdp: string, type: DescriptionType) => void**
+
+Set Remote Description
+
+```
+export const enum DescriptionType {
+    Unspec = 'Unspec',
+    Offer = 'Offer',
+    Answer = 'Answer'
+}
+```
+
+**setLocalDescription: (sdp: string, init?: LocalDescriptionInit) => void**
+
+Set Local Description and optionally the ICE ufrag/pwd to use. These should not
+be set as they will be generated automatically as per the spec.
+
+```
+export interface LocalDescriptionInit {
+    iceUfrag?: string;
+    icePwd?: string;
+}
+```
+
+**remoteFingerprint: () => CertificateFingerprint**
+
+Returns the certificate fingerprint used by the remote peer
+
+```
+export interface CertificateFingerprint {
+    value: string;
+    algorithm: 'sha-1' | 'sha-224' | 'sha-256' | 'sha-384' | 'sha-512' | 'md5' | 'md2';
+}
+```
+
+**addRemoteCandidate: (candidate: string, mid: string) => void**
+
+Add remote candidate info
+
+**createDataChannel: (label: string, config?: DataChannelInitConfig) => DataChannel**
+
+Create new data-channel
+
+- label `<string>` Data channel name
+- config `<Object>` Data channel options
+
+```
+export interface DataChannelInitConfig {
+    protocol?: string;
+    negotiated?: boolean;
+    id?: number;
+    unordered?: boolean; // Reliability
+    maxPacketLifeTime?: number; // Reliability
+    maxRetransmits?: number; // Reliability
+}
+```
+
+**state: () => string**
+
+Get current state
+
+**signalingState: () => string**
+
+Get current signaling state
+
+**gatheringState: () => string**
+
+Get current gathering state
+
+**onLocalDescription: (cb: (sdp: string, type: DescriptionType) => void) => void**
+
+Local Description Callback
+
+```
+export const enum DescriptionType {
+    Unspec = 'Unspec',
+    Offer = 'Offer',
+    Answer = 'Answer'
+}
+```
+
+**onLocalCandidate: (cb: (candidate: string, mid: string) => void) => void**
+
+Local Candidate Callback
+
+**onStateChange: (cb: (state: string) => void) => void**
+
+State Change Callback
+
+**onSignalingStateChange: (state: (sdp: string) => void) => void**
+
+Signaling State Change Callback
+
+**onGatheringStateChange: (state: (sdp: string) => void) => void**
+
+Gathering State Change Callback
+
+**onDataChannel: (cb: (dc: DataChannel) => void) => void**
+
+New Data Channel Callback
+
+**bytesSent: () => number**
+
+Get bytes sent stat
+
+**bytesReceived: () => number**
+
+Get bytes received stat
+
+**rtt: () => number**
+
+Get rtt stat
+
+**getSelectedCandidatePair: () => { local: SelectedCandidateInfo, remote: SelectedCandidateInfo }**
+
+Get info about selected candidate pair
+
+```
+export interface SelectedCandidateInfo {
+    address: string;
+    port: number;
+    type: string;
+    transportType: string;
+}
+```
+
+## DataChannel Class
+
+> You can create a new Datachannel instance by calling `PeerConnection.createDataChannel` function.
+
+**close: () => void**
+
+Close data channel
+
+**getLabel: () => string**
+
+Get label of data-channel
+
+**sendMessage: (msg: string) => boolean**
+
+Send Message as string
+
+**sendMessageBinary: (buffer: Buffer) => boolean**
+
+Send Message as binary
+
+**isOpen: () => boolean**
+
+Query data-channel
+
+**bufferedAmount: () => number**
+
+Get current buffered amount level
+
+**maxMessageSize: () => number**
+
+Get max message size of the data-channel, that could be sent
+
+**setBufferedAmountLowThreshold: (newSize: number) => void**
+
+Set buffer level of the `onBufferedAmountLow` callback
+
+**onOpen: (cb: () => void) => void**
+
+Open callback
+
+**onClosed: (cb: () => void) => void**
+
+Closed callback
+
+**onError: (cb: (err: string) => void) => void**
+
+Error callback
+
+**onBufferedAmountLow: (cb: () => void) => void**
+
+Buffer level low callback
+
+**onMessage: (cb: (msg: string | Buffer) => void) => void**
+
+New Message callback

package/BULDING.md

@@ -0,0 +1,33 @@
+# Build
+
+## Requirements
+
+- cmake >= V3.21
+- [libdatachannel dependencies](https://github.com/paullouisageneau/libdatachannel/blob/master/README.md#dependencies)
+
+## Building from source
+
+```sh
+> git clone https://github.com/murat-dogan/node-datachannel.git
+> cd node-datachannel
+> npm i
+```
+
+Other Options
+
+```sh
+# Use GnuTLS instead of OpenSSL (Default False)
+> npm run install-gnu-tls
+
+# Use libnice instead of libjuice (Default False)
+# libnice-dev packet should be installed. (eg. sudo apt install libnice-dev)
+> npm run install-nice
+```
+
+Compile without Media and Websocket
+
+```sh
+npx cmake-js clean
+npx cmake-js configure --CDNO_MEDIA=ON --CDNO_WEBSOCKET=ON
+npx cmake-js build
+```

package/CMakeLists.txt

@@ -0,0 +1,134 @@
+cmake_minimum_required(VERSION 3.15)
+cmake_policy(SET CMP0091 NEW)
+cmake_policy(SET CMP0042 NEW)
+
+project(node_datachannel VERSION 0.31.0)
+
+# compile_commands.json
+# -----------------------------------
+set(CMAKE_EXPORT_COMPILE_COMMANDS True)
+
+# -Dnapi_build_version=8
+add_definitions(-DNAPI_VERSION=8)
+
+include_directories(${CMAKE_JS_INC})
+
+if(WIN32)
+    set(OPENSSL_MSVC_STATIC_RT TRUE)
+    set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
+endif()
+
+if(CMAKE_HOST_SYSTEM_NAME STREQUAL "Android")
+    set(CMAKE_C_FLAGS "-Wno-error=unused-but-set-variable -Wno-error=strict-prototypes")
+endif()
+
+# Add -frtti only for Linux and macOS
+if (NOT CMAKE_SYSTEM_NAME STREQUAL "Windows")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -frtti")
+endif()
+
+set(OPENSSL_USE_STATIC_LIBS TRUE)
+find_package(OpenSSL REQUIRED)
+
+include(FetchContent)
+
+# Fetch libdatachannel
+FetchContent_Declare(
+    libdatachannel
+    GIT_REPOSITORY https://github.com/paullouisageneau/libdatachannel.git
+    GIT_TAG "v0.24.0"
+)
+
+option(NO_MEDIA "Disable media transport support in libdatachannel" OFF)
+option(NO_WEBSOCKET "Disable WebSocket support in libdatachannel" OFF)
+
+set(FETCHCONTENT_QUIET OFF)
+FetchContent_GetProperties(libdatachannel)
+
+if(NOT libdatachannel)
+    FetchContent_Populate(libdatachannel)
+    add_subdirectory(${libdatachannel_SOURCE_DIR} ${libdatachannel_BINARY_DIR} EXCLUDE_FROM_ALL)
+endif()
+
+# Create Source File List
+set(SRC_FILES
+   src/cpp/rtc-wrapper.cpp
+    src/cpp/data-channel-wrapper.cpp
+    src/cpp/ice-udp-mux-listener-wrapper.cpp
+    src/cpp/peer-connection-wrapper.cpp
+    src/cpp/thread-safe-callback.cpp
+    src/cpp/main.cpp
+    ${CMAKE_JS_SRC}
+)
+
+if(NOT NO_MEDIA)
+    list(APPEND SRC_FILES
+        src/cpp/media-av1packetization.cpp
+        src/cpp/media-av1rtppacketizer-wrapper.cpp
+        src/cpp/media-direction.cpp
+        src/cpp/media-h26xseparator.cpp
+        src/cpp/media-h264rtppacketizer-wrapper.cpp
+        src/cpp/media-h265rtppacketizer-wrapper.cpp
+        src/cpp/media-mediahandler-helper.cpp
+        src/cpp/media-pacinghandler-wrapper.cpp
+        src/cpp/media-rtcpnackresponder-wrapper.cpp
+        src/cpp/media-rtcpreceivingsession-wrapper.cpp
+        src/cpp/media-rtcpsrreporter-wrapper.cpp
+        src/cpp/media-rtppacketizationconfig-wrapper.cpp
+        src/cpp/media-rtppacketizer-wrapper.cpp
+        src/cpp/media-track-wrapper.cpp
+        src/cpp/media-audio-wrapper.cpp
+        src/cpp/media-video-wrapper.cpp
+    )
+endif()
+
+if(NOT NO_WEBSOCKET)
+    list(APPEND SRC_FILES
+        src/cpp/web-socket-wrapper.cpp
+        src/cpp/web-socket-server-wrapper.cpp
+    )
+endif()
+
+add_library(${PROJECT_NAME} SHARED ${SRC_FILES})
+
+set_target_properties(${PROJECT_NAME} PROPERTIES CXX_STANDARD 17)
+set_target_properties(${PROJECT_NAME} PROPERTIES PREFIX "" SUFFIX ".node")
+
+# Set the output directory for all build types
+# set_target_properties(${PROJECT_NAME} PROPERTIES
+#     RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/binary
+#     LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/binary
+#     ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/binary
+# )
+
+target_include_directories(${PROJECT_NAME} PRIVATE
+    ${CMAKE_SOURCE_DIR}/node_modules/node-addon-api
+    ${CMAKE_BINARY_DIR}/_deps/libdatachannel-src/include
+    ${CMAKE_BINARY_DIR}/_deps/libdatachannel-src/deps/plog
+)
+
+set(LINK_LIBRARIES
+    ${CMAKE_JS_LIB}
+    datachannel-static
+    plog::plog
+)
+
+if(APPLE)
+#
+elseif(CMAKE_HOST_SYSTEM_NAME STREQUAL "Android")
+    list(APPEND LINK_LIBRARIES -static-libgcc)
+elseif(UNIX)
+    list(APPEND LINK_LIBRARIES -static-libgcc -static-libstdc++)
+endif()
+
+if(WIN32)
+    SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /MT")
+    list(APPEND LINK_LIBRARIES crypt32.lib)
+endif()
+
+target_link_libraries(${PROJECT_NAME} PRIVATE ${LINK_LIBRARIES})
+
+if(MSVC AND CMAKE_JS_NODELIB_DEF AND CMAKE_JS_NODELIB_TARGET)
+  # Generate node.lib
+  execute_process(COMMAND ${CMAKE_AR} /def:${CMAKE_JS_NODELIB_DEF} /out:${CMAKE_JS_NODELIB_TARGET} ${CMAKE_STATIC_LINKER_FLAGS})
+endif()