haxball.js 2.3.2 → 3.0.0

package/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

package/.github/workflows/build.yml

@@ -24,10 +24,10 @@ jobs:
     outputs:
       hash: ${{ steps.nodeify.outputs.hash }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: 📦 Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 22.x
           cache: 'npm'
@@ -49,7 +49,7 @@ jobs:
           fi
 
       - name: 📤 Upload Build Artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: haxball-build
           path: src/build.js
@@ -66,16 +66,16 @@ jobs:
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: 📦 Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
 
       - name: 📥 Download Build
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: haxball-build
           path: src
@@ -105,10 +105,10 @@ jobs:
       contents: write
       pull-requests: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: 📥 Download Build
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: haxball-build
           path: src

package/README.md

@@ -34,7 +34,7 @@ npm install haxball.js
 ```js
 const HaxballJS = require('haxball.js');
 
-HaxballJS.then((HBInit) => {
+HaxballJS().then((HBInit) => {
   // Same as in Haxball Headless Host Documentation
   const room = HBInit({
     roomName: 'Haxball.JS',
@@ -54,6 +54,19 @@ HaxballJS.then((HBInit) => {
 });
 ```
 
+#### (Optional) Custom WebRTC Library
+
+Haxball.JS uses `node-datachannel` as the default WebRTC library. However, you can use a custom WebRTC implementation by specifying it in the HaxballJS promise using the `webrtc` option.
+
+Example:
+
+```js
+const HaxballJS = require('haxball.js');
+const WebRTC = require('webrtc');
+
+HaxballJS({ webrtc: WebRTC }).then((HBInit) => {...});
+```
+
 #### (Optional) Proxy
 
 Haxball has a limit of 2 rooms per IP. Therefore, you can use proxy with adding `proxy: "http://<YOUR_PROXY_IP>"` in your `RoomConfig`.
@@ -74,24 +87,7 @@ HBInit({
 ```js
 import HaxballJS from 'haxball.js';
 
-HaxballJS.then((HBInit) => {
-  // Same as in Haxball Headless Host Documentation
-  const room = HBInit({
-    roomName: 'Haxball.JS',
-    maxPlayers: 16,
-    public: true,
-    noPlayer: true,
-    token: 'YOUR_TOKEN_HERE', // Required
-  });
-
-  room.setDefaultStadium('Big');
-  room.setScoreLimit(5);
-  room.setTimeLimit(0);
-
-  room.onRoomLink = function (link) {
-    console.log(link);
-  };
-});
+HaxballJS().then((HBInit) => {...});
 ```
 
 #### 💻 (Optional, Highly Experimental!) Bun

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "haxball.js",
-  "version": "2.3.2",
+  "version": "3.0.0",
   "description": "A powerful library for interacting with the Haxball Headless API",
   "main": "src/index.js",
   "types": "types/index.d.ts",
@@ -21,17 +21,17 @@
   "license": "MIT",
   "dependencies": {
     "@peculiar/webcrypto": "^1.5.0",
-    "@types/haxball-headless-browser": ">=0.3.0",
+    "@types/haxball-headless-browser": "^0.4.0",
     "https-proxy-agent": "^7.0.6",
     "json5": "^2.2.3",
-    "node-datachannel": "^0.25.0",
+    "node-datachannel": "^0.26.0",
     "pako": "^2.1.0",
     "ws": "^8.18.0",
     "xhr2": "^0.2.1"
   },
   "devDependencies": {
-    "@mapbox/node-pre-gyp": "^1.0.11",
-    "mocha": "^10.7.3"
+    "@mapbox/node-pre-gyp": "^2.0.0",
+    "mocha": "^11.1.0"
   },
   "repository": {
     "type": "git",

package/scripts/nodeify.js

@@ -146,16 +146,24 @@ const pako = require("pako");
 const { HttpsProxyAgent } = require("https-proxy-agent");
 const { Crypto } = require("@peculiar/webcrypto");
 const { performance } = require("perf_hooks");
-const { RTCPeerConnection, RTCIceCandidate, RTCSessionDescription } = require("node-datachannel/polyfill");
 const crypto = new Crypto();
 
+let { RTCPeerConnection, RTCIceCandidate, RTCSessionDescription } = require("node-datachannel/polyfill");
+
 var promiseResolve;
 var proxyAgent;
 var debug = false;
 
-const HBLoaded = new Promise(function (resolve, reject) {
+const HBLoaded = (config) => {
+  if(config?.webrtc) {
+    RTCPeerConnection = config.webrtc.RTCPeerConnection;
+    RTCIceCandidate = config.webrtc.RTCIceCandidate;
+    RTCSessionDescription = config.webrtc.RTCSessionDescription;
+  }
+  return new Promise(function (resolve, reject) {
   promiseResolve = resolve;
-});
+  });
+}
 
 const onHBLoaded = function (cb) {
   return cb;

package/src/index.js

@@ -6,16 +6,24 @@ const pako = require("pako");
 const { HttpsProxyAgent } = require("https-proxy-agent");
 const { Crypto } = require("@peculiar/webcrypto");
 const { performance } = require("perf_hooks");
-const { RTCPeerConnection, RTCIceCandidate, RTCSessionDescription } = require("node-datachannel/polyfill");
 const crypto = new Crypto();
 
+let { RTCPeerConnection, RTCIceCandidate, RTCSessionDescription } = require("node-datachannel/polyfill");
+
 var promiseResolve;
 var proxyAgent;
 var debug = false;
 
-const HBLoaded = new Promise(function (resolve, reject) {
+const HBLoaded = (config) => {
+  if(config?.webrtc) {
+    RTCPeerConnection = config.webrtc.RTCPeerConnection;
+    RTCIceCandidate = config.webrtc.RTCIceCandidate;
+    RTCSessionDescription = config.webrtc.RTCSessionDescription;
+  }
+  return new Promise(function (resolve, reject) {
   promiseResolve = resolve;
-});
+  });
+}
 
 const onHBLoaded = function (cb) {
   return cb;

package/test/room.js

@@ -16,7 +16,7 @@ describe('HBInit Tests', function () {
     ? it
     : it.skip)('should create room', function (done) {
     this.timeout(30000);
-    requireUncached('../src/build').then((HBInit) => {
+    requireUncached('../src/build')().then((HBInit) => {
       let room = HBInit({
         roomName: 'Haxball.JS',
         maxPlayers: 16,
@@ -42,7 +42,7 @@ describe('HBInit Tests', function () {
 
       if (process.env.CI_HB_PROXY == '1') return done(); // Skip since testing proxy on GitHub Actions is not practical, test this locally instead
 
-      requireUncached('../src/build').then((HBInit) => {
+      requireUncached('../src/build')().then((HBInit) => {
         let room = HBInit({
           roomName: 'Haxball.JS',
           maxPlayers: 16,

package/types/index.d.ts

@@ -1,10 +1,16 @@
 import 'haxball-headless-browser';
 
+interface HaxballJSConfig {
+  webrtc?: any;
+}
+
 interface RoomConfigObjectM extends RoomConfigObject {
   proxy?: string;
   debug?: boolean;
 }
-export declare type Headless = (RoomConfig: RoomConfigObjectM) => RoomObject;
 
-declare const HaxballJS: Promise<Headless>;
+export type Headless = (roomConfig: RoomConfigObjectM) => RoomObject;
+
+declare function HaxballJS(config?: HaxballJSConfig): Promise<Headless>;
+
 export default HaxballJS;