haxball.js 2.2.2 → 2.3.0

package/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [mertushka]

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: mertushka
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. `npm install haxball.js` '...'
+2. ...
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+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]
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/.github/workflows/build.yml

@@ -0,0 +1,124 @@
+name: 🚀 Haxball.JS CI/CD
+
+on:
+  schedule:
+    - cron: "0 0 * * 0" # Run at 00:00 on Sunday
+  workflow_dispatch: # Allow manual triggers
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    name: 🛠️ Build Source
+    runs-on: ubuntu-latest
+    outputs:
+      hash: ${{ steps.nodeify.outputs.hash }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: 📦 Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+          cache: "npm"
+
+      - name: 📥 Install Dependencies
+        run: npm ci
+
+      - name: 🔨 Build Source Code
+        id: nodeify
+        run: |
+          OUTPUT=$(npm run build)
+          if [[ $OUTPUT =~ SUCCESS:([a-zA-Z0-9]+) ]]; then
+            HASH="${BASH_REMATCH[1]}"
+            echo "hash=$HASH" >> $GITHUB_OUTPUT
+            echo "🎉 Build successful with hash: $HASH"
+          else
+            echo "❌ Build failed: $OUTPUT"
+            exit 1
+          fi
+
+      - name: 📤 Upload Build Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: haxball-build
+          path: src/build.js
+          retention-days: 7
+
+  test:
+    needs: build
+    name: 🧪 Test (${{ matrix.os }}, Node ${{ matrix.node-version }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        node-version: [18.x, 20.x]
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: 📦 Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+
+      - name: 📥 Download Build
+        uses: actions/download-artifact@v3
+        with:
+          name: haxball-build
+          path: src
+
+      - name: 📥 Install Dependencies
+        run: npm ci
+
+      - name: 🧪 Run Core Tests
+        run: npm test
+        env:
+          TEST_PROXY: ""
+
+      - name: 🌐 Run Proxy Tests (Optional)
+        if: always()
+        continue-on-error: true
+        run: npm test
+        env:
+          TEST_PROXY: "1"
+
+  publish:
+    needs: build
+    name: 📢 Publish Build
+    if: github.event_name != 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: 📥 Download Build
+        uses: actions/download-artifact@v3
+        with:
+          name: haxball-build
+          path: src
+
+      - name: 🔄 Prepare Build
+        run: |
+          mv src/build.js src/index.js
+          echo "✨ Build prepared for publishing"
+
+      - name: 🚀 Commit and Push
+        run: |
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+
+          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
+          else
+            echo "📝 No changes to commit"
+          fi

package/.github/workflows/release.yml

@@ -1,22 +1,39 @@
-name: "🚀 release"
+name: 📦 NPM Release
 
 on:
-    release:
-        types: [published]
+  release:
+    types: [published]
 
 jobs:
-    release:
-        name: 🚀 release
-        runs-on: ubuntu-latest
-        steps:
-            - name: 📚 checkout
-              uses: actions/checkout@v2
-            - name: 🟢 node
-              uses: actions/setup-node@v2
-              with:
-                  node-version: 14
-                  registry-url: https://registry.npmjs.org
-            - name: 🚀 publish
-              run: npm publish --access public
-              env:
-                  NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}
+  release:
+    name: 🚀 Publish to NPM
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📚 Checkout Repository
+        uses: actions/checkout@v3
+
+      - name: 🟢 Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+          registry-url: https://registry.npmjs.org
+          cache: "npm"
+
+      - name: 📥 Install Dependencies
+        run: npm ci
+
+      - name: 🔨 Build Package
+        run: npm run build
+
+      - name: 🚀 Publish to NPM
+        run: |
+          echo "📦 Publishing version $(node -p "require('./package.json').version")"
+          npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+
+      - name: ✨ Post-Release Info
+        run: |
+          echo "🎉 Successfully published to NPM!"
+          echo "📊 Package: $(node -p "require('./package.json').name")"
+          echo "📌 Version: $(node -p "require('./package.json').version")"

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+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,
+  and learning from the experience
+* 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
+  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
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+contact@mertushka.pw.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+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
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+<h2 id="how-to-contribute">💡 How To Contribute</h2>
+
+- Make a fork of this repository
+- Clone to you machine and entry on respective paste
+- 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
+- Click to open and fill in the pull request information

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mario Carbajal & Mertushka
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -29,11 +29,9 @@
 npm install haxball.js
 ```
 
-#### 💻 Module Usage Example
+#### Module Usage Example
 
 ```js
-// room.js
-
 const HaxballJS = require("haxball.js");
 
 HaxballJS.then((HBInit) => {
@@ -56,9 +54,9 @@ HaxballJS.then((HBInit) => {
 });
 ```
 
-#### 💻 (Optional) Proxy
+#### (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.
+Haxball has a limit of 2 rooms per IP. Therefore, you can use proxy with adding `proxy: "http://<YOUR_PROXY_IP>"` in your `RoomConfig`.
 
 Example:
 
@@ -69,42 +67,53 @@ HBInit({
 });
 ```
 
-#### 💻 (Optional) TypeScript
+### 💻 TypeScript
 
-From v2.1.0, the package has basic typings included. Typings are automatically imported alongside `haxball.js` package.
+#### TypeScript Example
 
-Install TypeScript and ts-node in your project:
+```js
+import HaxballJS from "haxball.js";
 
-```bash
-npm install typescript --save-dev
-npm install ts-node --save-dev
-```
+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
+  });
 
-Name the file `room.ts` instead of `room.js` and use example room code from the previous section.
+  room.setDefaultStadium("Big");
+  room.setScoreLimit(5);
+  room.setTimeLimit(0);
 
-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`:
+  room.onRoomLink = function (link) {
+    console.log(link);
+  };
+});
+```
+
+#### 💻 (Optional, Highly Experimental!) Bun
 
-```json
-// package.json
+It's highly experimental and risky to use it in a production environment, but `haxball.js` is compatible with [Bun.JS](https://bun.sh/).
 
-//...
-  "scripts": {
-    "start": "ts-node run.ts"
-  }
-//...
+```bash
+bun install haxball.js
+bun index.ts
 ```
 
 ---
 
 <h2 id="technologies">🚀 Technologies</h2>
 
-- wrtc - WebRTC implementation for NodeJS
+- node-datachannel - WebRTC implementation for Node.JS
 - ws - Websocket Connection
 - json5 - JSON Helper Module
-- @peculiar/webcrypto - Webcrypto implementation for NodeJS
+- @peculiar/webcrypto - WebCrypto implementation for Node.JS
 - pako - ZLIB port for NodeJS
-- xhr2 - W3C XMLHttpRequest implementation for NodeJS
-- http-proxy-agent - Websocket Proxy Support
+- xhr2 - W3C XMLHttpRequest implementation for Node.JS
+- https-proxy-agent - Websocket Proxy Support
 - @types/haxball-headless-browser - Type definitions
 
 [Back To The Top](#title)
@@ -135,7 +144,8 @@ You may run the server with `ts-node room.ts` instead of `node room.js`. To make
 
 - Make a fork of this repository
 - Clone to you machine and entry on respective paste
-- Create a branch with your resource: `git checkout -b my-feature`
+- 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`
 - 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
@@ -167,12 +177,8 @@ You may run the server with `ts-node room.ts` instead of `node room.js`. To make
 
 <h2 id="license">🔏 License</h2>
 
-Copyright © 2023 [Mertushka <mertushka@proton.me>](https://github.com/mertushka)
+Copyright © 2023 mertushka & basro
 
 This project is licensed by [MIT License](https://api.github.com/licenses/mit).
 
 [Back To The Top](#title)
-
----
-
-_This README was generated with 💟 by [readme-template-generator](https://github.com/mertushka/readme-template-generator)_

package/SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 2.x.x   | :white_check_mark: |
+| 1.x.x   | :x:                |
+
+## Reporting a Vulnerability
+
+Contact [@basro](https://github.com/basro) or [@mertushka](https://github.com/mertushka) privately.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "haxball.js",
-  "version": "2.2.2",
+  "version": "2.3.0",
   "description": "A powerful library for interacting with the Haxball Headless API",
   "main": "src/index.js",
   "types": "types/index.d.ts",
@@ -21,10 +21,10 @@
   "license": "MIT",
   "dependencies": {
     "@peculiar/webcrypto": "^1.5.0",
-    "@roamhq/wrtc": "^0.8.0",
     "@types/haxball-headless-browser": ">=0.3.0",
     "https-proxy-agent": "^7.0.5",
     "json5": "^2.2.3",
+    "node-datachannel": "^0.23.0",
     "pako": "^2.1.0",
     "ws": "^8.18.0",
     "xhr2": "^0.2.1"
@@ -40,5 +40,8 @@
   "bugs": {
     "url": "https://github.com/mertushka/haxball.js/issues"
   },
-  "homepage": "https://github.com/mertushka/haxball.js#readme"
+  "homepage": "https://github.com/mertushka/haxball.js#readme",
+  "trustedDependencies": [
+    "node-datachannel"
+  ]
 }