haxball.js 2.3.0 → 2.3.1

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,7 +4,6 @@ about: Create a report to help us improve
 title: ''
 labels: bug
 assignees: mertushka
-
 ---
 
 **Describe the bug**
@@ -12,6 +11,7 @@ A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. `npm install haxball.js` '...'
 2. ...
 
@@ -22,8 +22,9 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Device (please complete the following information):**
- - OS: [e.g. W11]
- - Node.JS Version [e.g. 20.x LTS]
+
+- OS: [e.g. W11]
+- Node.JS Version [e.g. 20.x LTS]
 
 **Additional context**
 Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -4,7 +4,6 @@ about: Suggest an idea for this project
 title: ''
 labels: enhancement
 assignees: ''
-
 ---
 
 **Is your feature request related to a problem? Please describe.**

package/.github/workflows/build.yml

@@ -2,12 +2,20 @@ name: 🚀 Haxball.JS CI/CD
 
 on:
   schedule:
-    - cron: "0 0 * * 0" # Run at 00:00 on Sunday
+    - cron: '0 0 * * 0' # Run at 00:00 on Sunday
   workflow_dispatch: # Allow manual triggers
   push:
-    branches: [main, develop]
+    branches: [main]
+    paths:
+      - 'scripts/nodeify.js'
+      - 'package.json'
+      - 'package-lock.json'
   pull_request:
     branches: [main]
+    paths:
+      - 'scripts/nodeify.js'
+      - 'package.json'
+      - 'package-lock.json'
 
 jobs:
   build:
@@ -21,8 +29,8 @@ jobs:
       - name: 📦 Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 20.x
-          cache: "npm"
+          node-version: 22.x
+          cache: 'npm'
 
       - name: 📥 Install Dependencies
         run: npm ci
@@ -54,7 +62,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [18.x, 20.x]
+        node-version: [18.x, 22.x]
       fail-fast: false
 
     steps:
@@ -64,7 +72,7 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-          cache: "npm"
+          cache: 'npm'
 
       - name: 📥 Download Build
         uses: actions/download-artifact@v3
@@ -78,20 +86,24 @@ jobs:
       - name: 🧪 Run Core Tests
         run: npm test
         env:
-          TEST_PROXY: ""
+          CI_HB_HEADLESS_TOKEN: ${{ secrets.HEADLESS_TEST_TOKEN }}
 
       - name: 🌐 Run Proxy Tests (Optional)
         if: always()
         continue-on-error: true
         run: npm test
         env:
-          TEST_PROXY: "1"
+          CI_HB_PROXY: '1'
+          CI_HB_HEADLESS_TOKEN: ${{ secrets.HEADLESS_TEST_TOKEN }}
 
   publish:
-    needs: build
+    needs: [build, test]
     name: 📢 Publish Build
     if: github.event_name != 'pull_request'
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
     steps:
       - uses: actions/checkout@v3
 
@@ -106,19 +118,29 @@ jobs:
           mv src/build.js src/index.js
           echo "✨ Build prepared for publishing"
 
-      - name: 🚀 Commit and Push
+      - name: 🚀 Create Pull Request
         run: |
           git config --global user.name 'github-actions[bot]'
           git config --global user.email 'github-actions[bot]@users.noreply.github.com'
 
+          BRANCH_NAME="bot/update-haxball-$(date +%Y%m%d-%H%M%S)"
+          git checkout -b "$BRANCH_NAME"
+
           if [[ -n "$(git status --porcelain)" ]]; then
             git add src/index.js
-            git commit -m "🤖 Update Haxball.JS Build (${{ needs.build.outputs.hash }})
-
-            🔄 Auto-generated by GitHub Actions
-            🏷️ Build Hash: ${{ needs.build.outputs.hash }}
-            ⚡ Includes latest Haxball updates"
-            git push
+            git commit -m "🤖 Update Haxball Headless (Build: ${{ needs.build.outputs.hash }})"
+            git push origin "$BRANCH_NAME"
+
+            gh pr create \
+              --title "🤖 Update Haxball Headless (Build: ${{ needs.build.outputs.hash }})" \
+              --body "🔄 Auto-generated by GitHub Actions
+              
+              🏷️ Build Hash: ${{ needs.build.outputs.hash }}
+              ⚡ Includes latest Haxball Headless updates" \
+              --base main \
+              --head "$BRANCH_NAME"
           else
-            echo "📝 No changes to commit"
+            echo "📝 No changes to commit, build is up-to-date. 💫"
           fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/release.yml

@@ -15,9 +15,9 @@ jobs:
       - name: 🟢 Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 20.x
+          node-version: 22.x
           registry-url: https://registry.npmjs.org
-          cache: "npm"
+          cache: 'npm'
 
       - name: 📥 Install Dependencies
         run: npm ci

package/.prettierignore

@@ -0,0 +1,6 @@
+**/.git
+**/.svn
+**/.hg
+**/node_modules
+
+src/**/*.js

package/.prettierrc

@@ -0,0 +1,6 @@
+{
+    "printWidth": 80,
+    "tabWidth": 2,
+    "singleQuote": true,
+    "trailingComma": "es5"
+}

package/CODE_OF_CONDUCT.md

@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
+- Focusing on what is best not just for us as individuals, but for the
   overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
   advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
   address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within

package/README.md

@@ -32,19 +32,19 @@ npm install haxball.js
 #### Module Usage Example
 
 ```js
-const HaxballJS = require("haxball.js");
+const HaxballJS = require('haxball.js');
 
 HaxballJS.then((HBInit) => {
   // Same as in Haxball Headless Host Documentation
   const room = HBInit({
-    roomName: "Haxball.JS",
+    roomName: 'Haxball.JS',
     maxPlayers: 16,
     public: true,
     noPlayer: true,
-    token: "YOUR_TOKEN_HERE", // Required
+    token: 'YOUR_TOKEN_HERE', // Required
   });
 
-  room.setDefaultStadium("Big");
+  room.setDefaultStadium('Big');
   room.setScoreLimit(5);
   room.setTimeLimit(0);
 
@@ -72,19 +72,19 @@ HBInit({
 #### TypeScript Example
 
 ```js
-import HaxballJS from "haxball.js";
+import HaxballJS from 'haxball.js';
 
 HaxballJS.then((HBInit) => {
   // Same as in Haxball Headless Host Documentation
   const room = HBInit({
-    roomName: "Haxball.JS",
+    roomName: 'Haxball.JS',
     maxPlayers: 16,
     public: true,
     noPlayer: true,
-    token: "YOUR_TOKEN_HERE", // Required
+    token: 'YOUR_TOKEN_HERE', // Required
   });
 
-  room.setDefaultStadium("Big");
+  room.setDefaultStadium('Big');
   room.setScoreLimit(5);
   room.setTimeLimit(0);
 
@@ -144,8 +144,7 @@ bun index.ts
 
 - Make a fork of this repository
 - Clone to you machine and entry on respective paste
-- Make sure to update testing token on `test/room.js` with a valid one for Github Actions CI/CD (Important)
-- Create a branch from develop: `git checkout -b my-feature develop`
+- Create a branch with your resource: `git checkout -b my-feature`
 - Commit your changes: `git commit -m 'feat: My new feature'`
 - Push your branch: `git push origin my-feature`
 - A green button will appear at the beginning of this repository

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "haxball.js",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "description": "A powerful library for interacting with the Haxball Headless API",
   "main": "src/index.js",
   "types": "types/index.d.ts",
@@ -24,7 +24,7 @@
     "@types/haxball-headless-browser": ">=0.3.0",
     "https-proxy-agent": "^7.0.5",
     "json5": "^2.2.3",
-    "node-datachannel": "^0.23.0",
+    "node-datachannel": "^0.24.0",
     "pako": "^2.1.0",
     "ws": "^8.18.0",
     "xhr2": "^0.2.1"

package/scripts/nodeify.js

@@ -1,13 +1,13 @@
-const fs = require("fs").promises;
-const path = require("path");
+const fs = require('fs').promises;
+const path = require('path');
 
 async function nodeify() {
   try {
     // Fetch cache hash
-    const hashResponse = await fetch("https://www.haxball.com/cache_hash.json");
+    const hashResponse = await fetch('https://www.haxball.com/cache_hash.json');
     if (!hashResponse.ok)
       throw new Error(`Failed to fetch hash: ${hashResponse.status}`);
-    const hash = (await hashResponse.text()).replaceAll('"', "");
+    let hash = (await hashResponse.text()).replaceAll('"', '');
 
     // Fetch source
     const sourceUrl = `https://www.haxball.com/${hash}/__cache_static__/g/headless-min.js`;
@@ -16,11 +16,15 @@ async function nodeify() {
       throw new Error(`Failed to fetch source: ${sourceResponse.status}`);
     let source = await sourceResponse.text();
 
+    // Extract hash from source header comment
+    const hashMatch = source.match(/\/\*[\s\S]*?(\b[a-f0-9]{8}\b)/);
+    hash = hashMatch?.[1];
+
     // Process source code
     source = processSource(source);
 
     // Write output
-    const outputPath = path.join(__dirname, "../src/build.js");
+    const outputPath = path.join(__dirname, '../src/build.js');
     await writeOutputFile(outputPath, source);
 
     console.log(`SUCCESS:${hash}`); // Special format for GitHub Actions
@@ -47,12 +51,12 @@ function processSource(source) {
 
 function removeWindowReferences(source) {
   const replacements = {
-    "window.": "",
-    "parent.": "",
-    "document.": "",
-    ".innerHTML": "",
-    'getElementById("roomlink")': "null",
-    'getElementById("recaptcha")': "null",
+    'window.': '',
+    'parent.': '',
+    'document.': '',
+    '.innerHTML': '',
+    'getElementById("roomlink")': 'null',
+    'getElementById("recaptcha")': 'null',
   };
 
   return Object.entries(replacements).reduce(
@@ -64,7 +68,7 @@ function removeWindowReferences(source) {
 function applyRegexReplacements(source) {
   // HBInit replacement
   const hbInitMatch = source.match(/HBInit=.+?;/);
-  if (!hbInitMatch) throw new Error("Failed to find HBInit pattern");
+  if (!hbInitMatch) throw new Error('Failed to find HBInit pattern');
   source = source.replace(
     hbInitMatch[0],
     `promiseResolve(${hbInitMatch[0].substring(7, hbInitMatch[0].length - 1)});`
@@ -72,7 +76,7 @@ function applyRegexReplacements(source) {
 
   // WebSocket replacement
   const wsMatch = source.match(/new WebSocket\([^)]+\);/);
-  if (!wsMatch) throw new Error("Failed to find WebSocket pattern");
+  if (!wsMatch) throw new Error('Failed to find WebSocket pattern');
   source = source.replace(
     wsMatch[0],
     wsMatch[0].replace(
@@ -85,7 +89,7 @@ function applyRegexReplacements(source) {
   const wsErrorPattern =
     /([a-zA-Z]+)\.([a-zA-Z]+)\.onerror=function\(\){([a-zA-Z]+)\.([a-zA-Z]+)\(!0\)}/;
   const wsErrorMatch = source.match(wsErrorPattern);
-  if (!wsErrorMatch) throw new Error("Failed to find WebSocket error handler");
+  if (!wsErrorMatch) throw new Error('Failed to find WebSocket error handler');
 
   const [fullMatch, objName, wsProperty, methodObj, methodName] = wsErrorMatch;
   const debugCode = `${objName}.${wsProperty}.onerror=function(err){${methodObj}.${methodName}(!0);debug && console.error(err)};`;
@@ -95,7 +99,7 @@ function applyRegexReplacements(source) {
   const recaptchaMatch = source.match(
     /case "recaptcha":([a-zA-Z]+)\(([^)]+)\)/
   );
-  if (!recaptchaMatch) throw new Error("Failed to find Recaptcha pattern");
+  if (!recaptchaMatch) throw new Error('Failed to find Recaptcha pattern');
   source = source.replace(
     recaptchaMatch[0],
     'case "recaptcha":console.log(new Error("Invalid Token Provided!"))'
@@ -111,13 +115,13 @@ function addProxySupport(source) {
   const initMatch = source.match(initPattern);
 
   if (!initMatch) {
-    throw new Error("Could not find initialization pattern for proxy support");
+    throw new Error('Could not find initialization pattern for proxy support');
   }
 
   // Get the RoomConfigLookup function name
   const configLookupMatch = source.match(/(\w+)\("noPlayer",/);
   if (!configLookupMatch) {
-    throw new Error("Could not find RoomConfigLookup function");
+    throw new Error('Could not find RoomConfigLookup function');
   }
   const configFn = configLookupMatch[1];
 
@@ -168,7 +172,7 @@ const onHBLoaded = function (cb) {
 
 async function writeOutputFile(outputPath, content) {
   await fs.mkdir(path.dirname(outputPath), { recursive: true });
-  await fs.writeFile(outputPath, content, "utf8");
+  await fs.writeFile(outputPath, content, 'utf8');
 }
 
 nodeify();

package/test/room.js

@@ -5,26 +5,27 @@ function requireUncached(module) {
 
 const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
 
-const TOKEN = "thr1.AAAAAGd82uXE_qA2Ongrnw.6AWO8_UYHKA"; // Make sure update here before testing
-const PROXY = "http://1.1.1.1:2222"; // (Optional) http://ip:port
-
-describe("HBInit Tests", function () {
+describe('HBInit Tests', function () {
   this.timeout(10000);
 
   beforeEach(async function () {
-    await delay(2000);
+    await delay(5000);
   });
 
-  it("should create room", function (done) {
+  (process.env.CI_HB_HEADLESS_TOKEN || process.env.TEST_HB_HEADLESS_TOKEN
+    ? it
+    : it.skip)('should create room', function (done) {
     this.timeout(30000);
-    requireUncached("../src/build").then((HBInit) => {
-      var room = HBInit({
-        roomName: "Haxball.JS",
+    requireUncached('../src/build').then((HBInit) => {
+      let room = HBInit({
+        roomName: 'Haxball.JS',
         maxPlayers: 16,
         public: false,
         noPlayer: true,
         debug: true,
-        token: TOKEN,
+        token:
+          process.env.CI_HB_HEADLESS_TOKEN ||
+          process.env.TEST_HB_HEADLESS_TOKEN, // Fallback for local testing
       });
 
       room.onRoomLink = function () {
@@ -34,19 +35,24 @@ describe("HBInit Tests", function () {
   });
 
   // Optional proxy test
-  (process.env.TEST_PROXY ? it : it.skip)(
-    "should create room (proxy)",
+  (process.env.CI_HB_PROXY || process.env.TEST_HB_PROXY ? it : it.skip)(
+    'should create room (proxy)',
     function (done) {
       this.timeout(30000);
-      requireUncached("../src/build").then((HBInit) => {
-        var room = HBInit({
-          roomName: "Haxball.JS",
+
+      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) => {
+        let room = HBInit({
+          roomName: 'Haxball.JS',
           maxPlayers: 16,
           public: false,
           noPlayer: true,
           debug: true,
-          proxy: PROXY,
-          token: TOKEN,
+          proxy: process.env.CI_HB_PROXY || process.env.TEST_HB_PROXY, // Fallback for local testing
+          token:
+            process.env.CI_HB_HEADLESS_TOKEN ||
+            process.env.TEST_HB_HEADLESS_TOKEN, // Fallback for local testing
         });
 
         room.onRoomLink = function () {

package/types/index.d.ts

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