haxball.js 2.1.3 → 2.2.0

package/README.md

@@ -57,9 +57,11 @@ HaxballJS.then((HBInit) => {
 ```
 
 #### 💻 (Optional) Proxy
+
 Haxball has a limit of 2 rooms per IP. Therefore, you can use proxy with adding `proxy: "<YOUR_PROXY_IP>"` in your RoomConfig.
 
 Example:
+
 ```js
 HBInit({
     ...
@@ -68,17 +70,20 @@ HBInit({
 ```
 
 #### 💻 (Optional) TypeScript
+
 From v2.1.0, the package has basic typings included. Typings are automatically imported alongside `haxball.js` package.
 
 Install TypeScript and ts-node in your project:
+
 ```bash
 npm install typescript --save-dev
 npm install ts-node --save-dev
 ```
 
-Name the file `room.ts` instead of `room.js` and use example room code from the previous section. 
+Name the file `room.ts` instead of `room.js` and use example room code from the previous section.
 
 You may run the server with `ts-node room.ts` instead of `node room.js`. To make it runnable with `npm start`, add the alias to `package.json`:
+
 ```json
 // package.json
 
@@ -89,58 +94,18 @@ You may run the server with `ts-node room.ts` instead of `node room.js`. To make
 //...
 ```
 
-#### 💻 (Optional) Modularize Room Script
-You can build full room scripts as NPM packages, that export `roomBuilder` function. These functions can be easily imported by another packages (launchers, remote orchestrators, etc.).
-
-```ts
-// super-futsal-room/index.ts
-
-import { Headless } from "haxball.js"
-
-// Every user installing the package will have to
-// implement this interface in order to run it.
-interface RoomArgs {
-    token: string
-    timeLimit: number
-}
-
-const roomBuilder = (HBInit: Headless, args: RoomArgs) => {
-    let room = HBInit({
-        roomName: "Hello TypeScript!",
-        token: args.token
-    })
-
-    room.setTimeLimit(args.timeLimit)
-}
-
-export default roomBuilder;
-```
-
-```ts
-// room-launcher/index.ts
-
-// Local path as example, but may refer to installed npm package
-import roomBuilder from "../super-futsal-room";
-import HaxballJS from "haxball.js";
-
-HaxballJS.then((HBInit => roomBuilder(HBInit, {
-  // Interface for config arguments is provided by the room script author
-  // Not defining them results in TypeScript error
-  token: "YOUR_TOKEN_HERE",
-  timeLimit: 3
-})))
-```
-
 ---
 
 <h2 id="technologies">🚀 Technologies</h2>
 
 - wrtc - WebRTC implementation for NodeJS
 - ws - Websocket Connection
-- JSON5 - JSON Helper Module
+- json5 - JSON Helper Module
 - @peculiar/webcrypto - Webcrypto implementation for NodeJS
-- pako - ZLIP Port for NodeJS
-- node-fetch - HTTP Requests
+- pako - ZLIB port for NodeJS
+- xhr2 - W3C XMLHttpRequest implementation for NodeJS
+- http-proxy-agent - Websocket Proxy Support
+- @types/haxball-headless-browser - Type definitions
 
 [Back To The Top](#title)
 
@@ -149,7 +114,7 @@ HaxballJS.then((HBInit => roomBuilder(HBInit, {
 <h2 id="minimal-requirements">🌱 Minimal Requirements</h2>
 
 - NPM
-- NodeJs
+- NodeJS Version >=18
 
 [Back To The Top](#title)
 

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "haxball.js",
-  "version": "2.1.3",
+  "version": "2.2.0",
   "description": "A powerful library for interacting with the Haxball Headless API",
   "main": "src/index.js",
   "types": "types/index.d.ts",
+  "engines": {
+    "node": ">=18"
+  },
   "scripts": {
     "test": "mocha --recursive --exit",
     "build": "node scripts/nodeify.js"
@@ -17,18 +20,18 @@
   "author": "mertushka",
   "license": "MIT",
   "dependencies": {
-    "@koush/wrtc": "^0.5.3",
-    "@peculiar/webcrypto": "^1.3.3",
-    "@types/haxball-headless-browser": "^0.1.0",
-    "http-proxy-agent": "^5.0.0",
-    "json5": "^2.2.1",
-    "pako": "^2.0.4",
-    "ws": "^8.5.0",
+    "@peculiar/webcrypto": "^1.5.0",
+    "@roamhq/wrtc": "^0.8.0",
+    "@types/haxball-headless-browser": ">=0.3.0",
+    "http-proxy-agent": "^7.0.2",
+    "json5": "^2.2.3",
+    "pako": "^2.1.0",
+    "ws": "^8.18.0",
     "xhr2": "^0.2.1"
   },
   "devDependencies": {
-    "@mapbox/node-pre-gyp": "^1.0.9",
-    "mocha": "^9.2.2"
+    "@mapbox/node-pre-gyp": "^1.0.11",
+    "mocha": "^10.7.3"
   },
   "repository": {
     "type": "git",

package/scripts/nodeify.js

@@ -40,7 +40,7 @@ fetch("https://www.haxball.com/cache_hash.json")
       throw new Error("No HBInit matches found!");
     }
 
-    // Fix Websocket (Regex)
+    // Fix Websocket & Add Proxy Support (Regex)
 
     const WebsocketRegex = /new WebSocket\([^)]+\);/; // Match the pattern "new WebSocket(f+"?token="+e);"
     const WebsocketMatch = source.match(WebsocketRegex)[0];
@@ -72,25 +72,38 @@ fetch("https://www.haxball.com/cache_hash.json")
       throw new Error("No Recaptcha matches found!");
     }
 
+    console.log(
+      "RoomConfigLookup function:" + source.match(/(\w+)\("noPlayer",/)[1]
+    );
+
     // Add proxy support & other things manually because too hard to string manipulate with minified code
     // Also these things are not included in Headless Host Source originally so you can create ur own build without these things
     /* 
 
-    RoomConfigLookup: This is a example name for mimic minified function. 
+    RoomConfigLookup: This is an example name for mimic minified function. 
     
-    Example getting minified function: source.match(/(\w+)\("noPlayer",/)[1] -> this regex gets minified function's name from code
+    Example getting minified function: 
+    source.match(/(\w+)\("noPlayer",/)[1] -> this regex gets minified function's name from code
     k("noPlayer", !1) -> in this example regex gets function's name as "k"
-    
+
+
+    Implemented code to add proxy support to the module:
+
     proxyAgent = RoomConfigLookup("proxy", null)
     ? new HttpsProxyAgent(url.parse(RoomConfigLookup("proxy", null)))
     : null;
     debug = RoomConfigLookup("debug", null) == true;
+
+
+    
+    Websocket On Error Debug -> debug && console.error(e);
+
+    I will implement these manually with the help of the regex, as you can check manually added codes by searching @mertushka on the code 
     
     */
-    // Websocket On Error Debug -> debug && console.error(e);
 
     // Modules
-    target.write(`const wrtc = require("@koush/wrtc");
+    target.write(`const wrtc = require("@roamhq/wrtc");
 const XMLHttpRequest = require('xhr2');
 const WebSocket = require("ws");
 const url = require("url");

package/src/index.js

@@ -1,4 +1,4 @@
-const wrtc = require("@koush/wrtc");
+const wrtc = require("@roamhq/wrtc");
 const XMLHttpRequest = require("xhr2");
 const WebSocket = require("ws");
 const url = require("url");
@@ -206,6 +206,7 @@ const onHBLoaded = function (cb) {
       if (E.Gf) throw t.s("Can't init twice");
       E.Gf = !0;
 
+      // Manually added for proxy support by @mertushka
       proxyAgent = k("proxy", null)
         ? new HttpsProxyAgent(url.parse(k("proxy", null)))
         : null;
@@ -3510,7 +3511,9 @@ const onHBLoaded = function (cb) {
           d.Ed(4001 != g.code);
         };
         d.ua.onerror = function () {
+          // Manually added for proxy support by @mertushka
           debug && console.error(e);
+
           d.Ed(!0);
         };
         d.ua.onmessage = hb(d, d.dh);

package/test/build.js

@@ -9,7 +9,8 @@ describe("Build Tests", function () {
         maxPlayers: 16,
         public: true,
         noPlayer: true,
-        token: "thr1.AAAAAGUy-rw8ZuRUTuKCXA.WY0OtWrSz24", // Make sure update here before testing
+        debug: true,
+        token: "thr1.AAAAAGbJ6DKbFCpW73t1YQ.AcXcCi-Ak-w", // Make sure update here before testing
       });
 
       room.onRoomLink = function () {

package/test/room.js

@@ -9,7 +9,8 @@ describe("HBInit Tests", function () {
         maxPlayers: 16,
         public: true,
         noPlayer: true,
-        token: "thr1.AAAAAGUy-rw8ZuRUTuKCXA.WY0OtWrSz24", // Make sure update here before testing
+        debug: true,
+        token: "thr1.AAAAAGbJ6DKbFCpW73t1YQ.AcXcCi-Ak-w", // Make sure update here before testing
       });
 
       room.onRoomLink = function () {