Release 1.0.0-BETA.4 (#8)

  - [BREAKING] Dropped support for all versions below Node.js v20.11.1  
- While the api may still work on older versions, the app itself can't
run on them anymore due to internal fs changes.

  - [BREAKING] Application register flow changed
- New websocket connections now register on the upgrade request, not
after the connection is established.
    - This simplifies the connection process and improves performance.

  - [BREAKING] Removed `isRegistered()` method from `ArunaClient`
    - This method became obsolete with the new registration flow.
  
  - [FEAT] Better docker support
- Enforce port to 3000 inside the container, regardless of the
configuration file.
- This allows easier deployment and avoids port conflicts, allowing the
user to map the port as needed in the docker itself.

Author: LoboMetalurgico

.github/workflows/test.yml

@@ -11,7 +11,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18, 20, 22]
+        node-version: [20, 22, 24]
 
     steps:
       - name: Checkout repository

CHANGELOG.md

@@ -1,4 +1,22 @@
-# v1.0.0-BETA.3
+# ArunaCore Changelog
+
+## v1.0.0-BETA.4
+
+  - [BREAKING] Dropped support for all versions below Node.js v20.11.1  
+    - While the api may still work on older versions, the app itself can't run on them anymore due to internal fs changes.
+
+  - [BREAKING] Application register flow changed
+    - New websocket connections now register on the upgrade request, not after the connection is established.
+    - This simplifies the connection process and improves performance.
+
+  - [BREAKING] Removed `isRegistered()` method from `ArunaClient`
+    - This method became obsolete with the new registration flow.
+  
+  - [FEAT] Better docker support
+    - Enforce port to 3000 inside the container, regardless of the configuration file.
+    - This allows easier deployment and avoids port conflicts, allowing the user to map the port as needed in the docker itself.
+
+## v1.0.0-BETA.3
 
 - [FIX] Dead WebSocket connections not being properly handled  
   - Now, when a connection is considered dead, all `'pong'` event listeners are removed and the promise resolves the correct state.
@@ -12,7 +30,7 @@
 - [NEW] Added typing for client-emitted events  
   - This improves developer experience and type safety when handling events emitted by clients.
 
-# v1.0.0-BETA.2
+## v1.0.0-BETA.2
 
 - [BREAKING] Removed deprecated methods from `WebSocketParser`  
   - These methods were deprecated in the previous version, so they were removed now.
@@ -22,7 +40,7 @@
 
 - [DOCS] Updated important JSDoc comments
 
-# v1.0.0-BETA.1
+## v1.0.0-BETA.1
 
 - [BREAKING] Dropped support for all versions below Node.js v18.8.0  
   - These versions are too old and can't be supported anymore.
@@ -33,9 +51,9 @@
 
 - [CHORE] Updated dependencies
 
-# v1.0.0-BETA.0
+## v1.0.0-BETA.0
 
-## Yes, we are finally in beta! 🎉
+### Yes, we are finally in beta! 🎉
 
 This release includes a lot of changes and improvements, so check the changelog to see what's new.
 
@@ -100,7 +118,7 @@ This release includes a lot of changes and improvements, so check the changelog
 - [CHORE] Created a changelog file to keep track of changes  
   - Probably includes all changes from previous versions.
 
-# v1.0.0-ALPHA.3
+## v1.0.0-ALPHA.3
 
 - [BREAKING] Switched to external log library  
   - Now we use [@promisepending/logger.js](https://www.npmjs.com/package/@promisepending/logger.js) and no longer provide a custom logger.
@@ -111,7 +129,7 @@ This release includes a lot of changes and improvements, so check the changelog
 
 - [CHORE] Updated dependencies
 
-# v1.0.0-ALPHA.2
+## v1.0.0-ALPHA.2
 
 - [NEW] Implemented secure mode
 
@@ -127,7 +145,7 @@ This release includes a lot of changes and improvements, so check the changelog
 
 - [CHORE] Updated dependencies
 
-# v1.0.0-ALPHA.1
+## v1.0.0-ALPHA.1
 
 - [FIXED] Some type errors
 
@@ -139,6 +157,6 @@ This release includes a lot of changes and improvements, so check the changelog
 
 - [CHORE] Updated dependencies
 
-# v1.0.0-ALPHA.0
+## v1.0.0-ALPHA.0
 
 - [NEW] Initial release

README.md

@@ -82,7 +82,7 @@ If you want to contribute to ArunaCore, please check our CONTRIBUTING.md file (*
 
 ## Authors
 
-ArunaCore is developed with 💜 by <a href="https://github.com/LoboMetalurgico">Lobo Metalurgico</a> and <a href="https://github.com/emanuelfranklyn">Space_Interprise</a>.
+ArunaCore is developed with 💜 by <a href="https://github.com/LoboMetalurgico">Lobo Metalurgico</a> and <a href="https://github.com/SpaceFox1">SpaceFox</a>.
 
 ## License
 

api/.npmignore

@@ -0,0 +1,3 @@
+node_modules/
+*.tgz
+tests/

api/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "arunacore-api",
-  "version": "1.0.0-BETA.3",
+  "version": "1.0.0-BETA.4",
   "description": "ArunaCore is an open source websocket server made with nodejs for intercomunication between applications.",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",
@@ -10,6 +10,7 @@
   "scripts": {
     "start": "npm run build && node build/",
     "build": "npx tsc -p .",
+    "postbuild": "node ./scripts/postBuild.cjs",
     "prepack": "npm run build",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -30,15 +31,15 @@
   ],
   "homepage": "https://github.com/ArunaBot/ArunaCore#readme",
   "engines": {
-    "node": ">=18.8.0"
+    "node": ">=20.11.1"
   },
   "dependencies": {
     "@promisepending/logger.js": "^1.1.1",
-    "ws": "^8.18.2"
+    "ws": "^8.18.3"
   },
   "devDependencies": {
     "@types/ws": "^8.18.1",
     "ts-project-bundle": "^0.0.12",
-    "typescript": "^5.8.3"
+    "typescript": "^5.9.3"
   }
 }

api/package.json

@@ -0,0 +1,15 @@
+const path = require('path');
+const fs = require('fs');
+
+const version = require('../package.json').version;
+
+const dest = path.resolve(__dirname, '..', 'build', 'src', 'resources');
+
+if (!fs.existsSync(dest)) {
+  fs.mkdirSync(dest, { recursive: true });
+}
+
+const versionFilePath = path.resolve(dest, 'version.js');
+const versionFileContent = fs.readFileSync(versionFilePath, 'utf-8').replace('REPLACE_ME', version);
+
+fs.writeFileSync(versionFilePath, versionFileContent, 'utf-8');

api/scripts/postBuild.cjs

@@ -0,0 +1 @@
+export const version = 'REPLACE_ME';

api/src/resources/version.ts

@@ -1,10 +1,10 @@
 import { IMessage, IWebsocketOptions } from '../interfaces';
 import { Logger } from '@promisepending/logger.js';
+import { version } from '../resources/version';
 import { WebSocketParser, utils } from '../';
 import { EventEmitter } from 'events';
 import ws from 'ws';
 
-
 interface ArunaEvents {
   'ready': [];
   'message': [IMessage];
@@ -15,7 +15,6 @@ interface ArunaEvents {
   [command: string]: [...any];
 }
 
-
 /**
  * Main class for the api client
  * @class ArunaClient
@@ -42,7 +41,6 @@ interface ArunaEvents {
 export class ArunaClient extends EventEmitter<ArunaEvents> {
   private finishTimeout: ReturnType<typeof setTimeout> | null = null;
   private secureKey: string | null = null;
-  private isRegistered = false;
   private ws: ws | null = null;
   private secureMode: boolean;
   private shardMode: boolean;
@@ -80,8 +78,14 @@ export class ArunaClient extends EventEmitter<ArunaEvents> {
       this.secureKey = secureKey;
       this.secureMode = true;
     }
+    this.ws = new ws(`ws://${this.host}:${this.port}`, {
+      headers: {
+        'Authorization': this.secureKey ?? '',
+        'ArunaCore-API-Version': version,
+        'Client-ID': this.id,
+      },
+    });
 
-    this.ws = new ws(`ws://${this.host}:${this.port}`);
     return new Promise((resolve, reject) => {
       this.ws!.on('message', (message) => { this.onMessage(message.toString()); });
 
@@ -91,15 +95,38 @@ export class ArunaClient extends EventEmitter<ArunaEvents> {
 
       this.ws!.on('open', () => {
         this.logger.debug('Connected to server!');
-        this.logger.debug('Registering client...');
-        this.register();
+        this.emit('ready');
         resolve();
       });
 
       this.ws!.on('error', (err) => {
         this.logger.error(err);
         reject(err);
       });
+
+      this.ws!.on('unexpected-response', (req, res) => {
+        if (res.statusCode === 401) {
+          this.logger.error('Unauthorized: Invalid secure key!');
+          this.ws?.close();
+          reject(new Error('Unauthorized: Invalid secure key!'));
+        } else if (res.statusCode === 409) {
+          this.logger.warn('Conflict: Client ID already connected! Randomizing a new one...');
+          this.id = this.id + utils.randomString(5);
+          this.connect().then(() => {
+            resolve();
+          }).catch((err) => {
+            reject(err);
+          });
+        } else if (res.statusCode === 412) {
+          this.logger.error('Precondition Failed: Unsupported API version!');
+          this.ws?.close();
+          reject(new Error('Precondition Failed: Unsupported API version!'));
+        } else {
+          this.logger.error(`Unexpected response: ${res.statusCode}`);
+          this.ws?.close();
+          reject(new Error(`Unexpected response: ${res.statusCode}`));
+        }
+      });
     });
   }
 
@@ -163,12 +190,7 @@ export class ArunaClient extends EventEmitter<ArunaEvents> {
 
     switch (parsedMessage.command) {
       case '000':
-        if (parsedMessage.content === 'register-success') {
-          this.isRegistered = true;
-          this.logger.debug('Client Registered!');
-          this.emit('ready');
-        } else if (parsedMessage.content === 'unregister-success') {
-          this.isRegistered = false;
+        if (parsedMessage.content === 'unregister-success') {
           this.logger.debug('Client Unregistered!');
           this.emit('finish');
         } else {
@@ -178,28 +200,13 @@ export class ArunaClient extends EventEmitter<ArunaEvents> {
       case '401':
         this.emit('unauthorized', parsedMessage);
         break;
-      case '403':
-        if (parsedMessage.type !== 'register') return;
-        this.id = this.id + utils.randomString(5);
-        this.register();
-        break;
       default:
         this.emit('message', parsedMessage);
         if (parsedMessage.command) this.emit(parsedMessage.command, parsedMessage);
         break;
     }
   }
 
-  /**
-   * Registers the client in the ArunaCore server
-   * @returns {void}
-   * @private
-   */
-  private register(): void {
-    if (this.isRegistered) return;
-    this.send('request-register', { command: '000', type: 'register' });
-  }
-
   /**
    * Pings the ArunaCore server
    * @returns {Promise<boolean>}
@@ -230,14 +237,6 @@ export class ArunaClient extends EventEmitter<ArunaEvents> {
     return this.id;
   }
 
-  /**
-   * Indicates if the client is registered in the ArunaCore server
-   * @returns {boolean}
-   */
-  public getIsRegistered(): boolean {
-    return this.isRegistered;
-  }
-
   /**
    * Closes the connection to the ArunaCore server
    * @returns {Promise<void>}