haxball.js 2.0.1 → 2.1.0

package/README.md

@@ -32,16 +32,18 @@ npm install haxball.js
 #### 💻 Module Usage Example
 
 ```js
+// room.js
+
 const HaxballJS = require("haxball.js");
 
 HaxballJS.then((HBInit) => {
-  // All is same as Haxball Headless Host Documentation
+  // Same as in Haxball Headless Host Documentation
   const room = HBInit({
     roomName: "Haxball.JS",
     maxPlayers: 16,
     public: true,
     noPlayer: true,
-    token: "TOKEN", // Required
+    token: "YOUR_TOKEN_HERE", // Required
   });
 
   room.setDefaultStadium("Big");
@@ -54,6 +56,61 @@ HaxballJS.then((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. 
+
+You may run the server with `ts-node room.ts` instead of `node room.js`.
+
+#### 💻 (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>
@@ -83,6 +140,7 @@ HaxballJS.then((HBInit) => {
 - [x] Promise based
 - [x] Synchronous
 - [x] Performant
+- [x] Strongly Typed
 
 [Back To The Top](#title)
 
@@ -114,6 +172,7 @@ HaxballJS.then((HBInit) => {
 <p>
 
 <a href="https://github.com/mertushka"><img width="60" src="https://avatars1.githubusercontent.com/u/34413473?v=4"/>
+<a href="https://github.com/jakjus"><img width="60" src="https://avatars.githubusercontent.com/u/43467994?v=4"/>
 
 </p>
 

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "haxball.js",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "A powerful library for interacting with the Haxball Headless API",
   "main": "src/index.js",
+  "types": "types/index.d.ts",
   "scripts": {
     "test": "mocha --recursive --exit"
   },
@@ -15,15 +16,16 @@
   "author": "mertushka",
   "license": "MIT",
   "dependencies": {
+    "@koush/wrtc": "^0.5.3",
     "@peculiar/webcrypto": "^1.3.3",
     "json5": "^2.2.1",
     "node-fetch": "^2.6.6",
     "pako": "^2.0.4",
-    "wrtc": "^0.4.7",
     "ws": "^8.5.0"
   },
   "devDependencies": {
     "@mapbox/node-pre-gyp": "^1.0.9",
+    "@types/haxball-headless-browser": "^0.1.0",
     "mocha": "^9.2.2"
   },
   "repository": {

package/src/index.js

@@ -1,9 +1,10 @@
-const wrtc = require("wrtc");
+const wrtc = require("@koush/wrtc");
 const fetch = require("node-fetch");
 const WebSocket = require("ws");
 const JSON5 = require("json5");
 const pako = require("pako");
 const { Crypto } = require("@peculiar/webcrypto");
+const { performance } = require("perf_hooks");
 const crypto = new Crypto();
 const headless = new Promise((resolve) => {
   (function (cb) {

package/test/room.js

@@ -10,7 +10,7 @@ describe("HBInit Tests", function () {
           maxPlayers: 16,
           public: true,
           noPlayer: true,
-          token: "thr1.AAAAAGJVxGsy3lwLOjNVRg.Qx-FC-EH8ZA", // Make sure update here before testing
+          token: "thr1.AAAAAGLmYKJ3LdGsopf1Mw.BWMK36G23Ys", // Make sure update here before testing
         });
       } catch (error) {
         done(error);

package/types/index.d.ts

@@ -0,0 +1,6 @@
+import "haxball-headless-browser";
+
+export declare type Headless = (RoomConfig: RoomConfigObject) => RoomObject;
+
+declare const HaxballJS: Promise<Headless>
+export default HaxballJS