1.2.2: Fixed bug issue #4, added CommonJS export, bumped protocol version

- 🛠️ Fixed bug from issue #4 that caused incorrect parsing of status responses from modded servers.
- ⚙️ Added support for both CommonJS and ES module exports, and updated the module target to ESNext.
- ⚙️ Bumped the default protocol version from `767` (1.21.1) to `769` (1.21.4)

view CHANGELOG.md

Author: woodendoors7

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog!
 
+<h2>v1.2.2</h2>
+
+<sup>[NPM](https://www.npmjs.com/package/minecraftstatuspinger/v/1.2.2) | [JSR](https://jsr.io/@minecraft/[email protected])</sup>
+
+- 🛠️ Fixed bug from issue [#4](https://github.com/woodendoors7/MinecraftStatusPinger/issues/4) that caused incorrect parsing of status responses from modded servers.
+- ⚙️ Added support for both CommonJS and ES module exports, and updated the module target to ESNext.
+- ⚙️ Bumped the default protocol version from `767` (1.21.1) to `769` (1.21.4)
+
 <h2>v1.2.1</h2>
 
 <sup>[NPM](https://www.npmjs.com/package/minecraftstatuspinger/v/1.2.1) | [JSR](https://jsr.io/@minecraft/[email protected])</sup>

README.md

@@ -15,7 +15,7 @@
 ![TS Types](https://badgen.net/npm/types/minecraftstatuspinger)
 ![License](https://badgen.net/npm/license/minecraftstatuspinger)
 ![NPM Downloads](https://badgen.net/npm/dy/minecraftstatuspinger/?color=00a600)
-![Maintained?](https://badgen.net/static/Maintained%3F/Yes/00a600)
+![Maintained?](https://badgen.net/static/Maintained%3F/Yes!/00a600)
 
 ### What can this be used for?
 
@@ -28,8 +28,8 @@
 **And in general, checking the status of Minecraft servers!**
 ## Getting started
 ### Requirements
-- NodeJS or Deno (used to run JavaScript code)
-- NPM (used to install Node packages)
+- NodeJS, Deno or Bun (used to run JavaScript code)
+- NPM/JSR (used to install JavaScript packages)
 
 ### Installation
 ```bat
@@ -40,27 +40,28 @@ npm install minecraftstatuspinger
 ```typescript
 import mc from "minecraftstatuspinger";
 
-let result = await mc.lookup({ host: "mc.hypixel.net" })
+let result = await mc.lookup({ host: "mc.hypixel.net" });
 console.log(result);
 ``` 
 
-<details>
+<details open>
 <summary><h3>Advanced Example</h3></summary>
-<br>
 
 ```typescript
 import mc from "minecraftstatuspinger";
+//OR
+const mc = require("minecraftstatuspinger");
 
 let result = await mc.lookup({
-    host: "mc.hypixel.net",
-    port: 25565,
-    ping: true,
-    protocolVersion: 767,
-    timeout: 10000,
-    throwOnParseError: true,
-    SRVLookup: true,
-    JSONParse: true
-})
+    host: "mc.hypixel.net",  // A hostname, or an IP of your server. 
+    port: 25565,             // Port of the server.
+    ping: true,              // Whether to get the latency of the server, or skip that part.
+    protocolVersion: 769,    // Minecraft version - 769 is 1.21.4
+    timeout: 10000,          // Time in milliseconds to wait for a response before throwing an error.
+    throwOnParseError: true, // Whether to throw an error if parsing of the status response fails.
+    SRVLookup: true,         // Whether to do a SRV lookup before doing a normal lookup.
+    JSONParse: true          // Whether to skip parsing the JSON response entirely.
+});
 
 console.log(result);
 ```
@@ -74,49 +75,52 @@ console.log(result);
 * <b id="lookupOptions">.lookup(): </b>*`((options: ServerStatusOptions) => Promise<ServerStatus>)`*
   * **options:** ServerStatusOptions
     * <b>`host:`</b> string
-      > Either an IP, or a hostname of the server. (alias: hostname)
+      > An IP address or hostname of the server. (alias: hostname)
     * <b>`port?:`</b> number <i> `default: 25565`</i>
       > Port of the server. SRV lookup is disabled when using ports other than 25565.
     * <b>`timeout?:`</b> number <i>`default: 10000`</i>
-      > How long until an error is thrown if the transaction still hasn't finished. Default is 10 seconds.
+      > The time (in milliseconds) to wait for a response before throwing an error if the transaction isn’t completed. (Default: 10 seconds)
     * <b>`ping?:`</b> boolean <i>`default: true`</i>
       > Whether to send a payload at the end to measure the server latency. If false, the `latency` field will be null.
-    * <b>`protocolVersion?:`</b> number <i>`default: 767`</i>
-      > Protocol version to send to the server to simulate different Minecraft client versions. Here, you can see the [Protocol Version Numbers](https://wiki.vg/Protocol_version_numbers). The current default protocol version is for 1.21.1 (767) and will be irregularly updated to newer versions.
+    * <b>`protocolVersion?:`</b> number <i>`default: 769`</i>
+      > The protocol version sent to the server to simulate different Minecraft client versions. Refer to the [Protocol Version Numbers](https://wiki.vg/Protocol_version_numbers) for details. It is recommended to set this explicitly, as it will be updated periodically through minor version bumps. The default is 769 (Minecraft 1.21.4).
     * <b>`throwOnParseError?:`</b> boolean <i>`default: true`</i>
-      > Whether to throw an error if the status packet fails to parse the status field. The `statusRaw` field is always included.
+      > If true, an error will be thrown when the the status field fails to parse. The raw status response is always provided in the `statusRaw` field.
     * <b>`SRVLookup?:`</b> boolean <i>`default: true`</i>
-      > Whether to perform a SRV lookup on the provided hostname. Set to `true` in order to skip. Useful to disable when you're only looking up the basic DNS records and a server with a specific port.
+      > Whether to perform a SRV lookup on the provided hostname. Set to `false` to skip the lookup, which is useful when you're only looking for basic DNS records. It is automatically disabled when you define a port different from 25565.
     * <b>`JSONParse?:`</b> boolean <i>`default: true`</i>
       > Whether to parse the JSON `status` field. Useful to disable when you only need the raw plaintext response. If false, the `status` field will be null.
   * ServerStatus
     * <b>`latency?:`</b> number
       > The time it takes to receive back a response after sending a small payload to a server, in milliseconds. Will be null if the `ping` option is false.
     * <b>`status?:`</b> DynamicObject
-      > Parsed status response from the server. Will be null if the status fails to parse, or if disableJSONParse is true. <a href="https://pinger.floppa.hair/responses/">Example of a valid Status Response.</a>
+      > Parsed status response from the server. This field will be null if parsing fails or if `JSONParse` is false. <a href="https://pinger.floppa.hair/responses/">Example of a valid Status Response.</a>
     * <b>`statusRaw:`</b> string
       > Plaintext status response in the form of JSON. Useful when `status` fails to parse.
 
 * <b id="setDnsOptions">.setDnsServers(): `((serverArray: string[]) => Promise<boolean>)`</b>
-  > It wraps the `dns.setServers` function, useful for looking up SRV records through different DNS servers. <br>
+  > Wraps the `dns.setServers` function, useful for quicker lookups through different DNS servers. <br>
     The first IP in the array will always be used first, others will be tried if the first one is unreachable. <br><br>
-    Accepts an array of hostnames or IP addresses of DNS servers. It will either return true, or throw an error. 
-  
+    Accepts an array of hostnames or IP addresses of DNS servers. It will either return true, or throw an error, otherwise, it uses the default DNS servers of your computer.<br><br>
+    ❗ Changing the default DNS servers is recommended, if you're doing tons of lookups at once.
+    
 
+
   Usage:
   ```js
     // For example:
     mc.setDnsServers(["9.9.9.9", "1.1.1.1", "8.8.8.8"])
     // (Quad9, Cloudflare, Google)
-    // Cloudflare is usually the fastest for DNS queries.
+    // Note: Cloudflare is typically the fastest for DNS queries.
   ```
-  If you never changed the DNS settings of your computer, the default DNS server will be your ISP's.<br>
-  <code style="color : darkorange">❗ I recommend changing your default DNS servers if you're doing thousands of lookups, such as for mass scanning.</code><br>
+
+
+<hr>
 
 ### Changelog
 
    **[View Changelog](https://pinger.floppa.hair/changelog/)**,
-  Latest version: <b><i><code>v1.2.1</code></i></b>
+  Latest version: <b><i><code>v1.2.2</code></i></b>
 
 
 
@@ -130,12 +134,12 @@ If you have some questions, you can message me through Discord - **woodendoors7*
 
 
 ### To-do
-
 - [x] Do SRV lookups
 - [ ] Parse MOTDs 
 - [ ] Support versions less than 1.7. 
 - [ ] Support Bedrock
 
+(I plan to add these over summer!)
 
 ### License
 

jsr.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/minecraftstatuspinger",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "exports": "./src/index.ts",
   "compilerOptions": {
     "strictNullChecks": false

package.json

@@ -9,7 +9,7 @@
     "CHANGELOG.md",
     "README.md"
   ],
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "A modern library for pinging Minecraft servers and getting their status and playerlist, written in TypeScript with zero dependencies.",
   "keywords": [
     "minecraft status",
@@ -23,24 +23,23 @@
   "bugs": {
     "url": "https://github.com/woodendoors7/MinecraftStatusPinger/issues"
   },
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
   "scripts": {
-    "test": "cls && tsc && cd test && tsc --target ES2021 --strictNullChecks true --moduleResolution node test.ts && node test.js",
-    "start": "node dist/index.js",
-    "build": "tsc -p tsconfig.json",
-    "dev": "ts-node-dev src/index.ts"
+    "build:cjs": "tsc --module CommonJS --outDir ./dist/cjs",
+    "build:esm": "tsc --module ESNext --outDir ./dist/esm",
+    "build": "npm run build:cjs && npm run build:esm"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=14.0.0"
   },
   "license": "GPL-3.0-or-later",
-  "type": "module",
   "devDependencies": {
     "@types/express": "^4.17.16",
     "@types/node": "^18.11.18",
     "@types/varint": "^6.0.1",
     "typedoc": "^0.23.25",
-    "typescript": "^5.7.0-beta"
+    "typescript": "^5.8.2"
   }
 }

src/index.ts

@@ -16,7 +16,7 @@ import { promises as dns } from "node:dns";
  *    port: 25565,
  *    timeout: 10000,
  *    ping: true,
- *    protocolVersion: 767
+ *    protocolVersion: 769
  *    throwOnParseError: false,
  *    SRVLookup: true,
  *    JSONParse: true
@@ -34,7 +34,7 @@ export async function lookup(options?: ServerStatusOptions): Promise<ServerStatu
 
         let timeout = options.timeout != null ? options.timeout : 10000;
         let ping = options.ping != null ? options.ping : true;
-        let protocolVersion = options.protocolVersion != null ? options.protocolVersion : 767;
+        let protocolVersion = options.protocolVersion != null ? options.protocolVersion : 769;
         let throwOnParseError = options.throwOnParseError != null ? options.throwOnParseError : true;
         let SRVLookup = options.SRVLookup != null ? options.SRVLookup : true;
         let JSONParse = options.JSONParse != null ? options.JSONParse : true;
@@ -84,9 +84,10 @@ export async function lookup(options?: ServerStatusOptions): Promise<ServerStatu
                 return resolve(serverStatus);
             }
 
+
             /* 
-                If the handshake and status request were sent out and replied to,
-                generate the ping packet, log the time it was sent out on and send it.
+                If the handshake and status request have been successfully completed,
+                generate the ping packet, record the time it is sent, and then send it.
             */
 
             if (packet.status.handshakeBaked && !packet.status.pingSent) {
@@ -118,7 +119,7 @@ export async function lookup(options?: ServerStatusOptions): Promise<ServerStatu
     // Recommended servers
     mc.setDnsServers(["9.9.9.9", "1.1.1.1", "8.8.8.8"])
     // (Quad9, Cloudflare, Google)
-    // Cloudflare is the fastest for DNS queries in most of the world.
+    // Note: Cloudflare is typically the fastest for DNS queries.
 ```
  */
 export async function setDnsServers(serverArray: Array<string>): Promise<boolean> {
@@ -138,8 +139,8 @@ async function customLookup(hostname: string, options: DynamicObject, callback:
 
 async function processSRV(hostname: string, port: number) {
     /*
-     *  Tries to get a SRV record from the provided hostname, unless disabled with the disableSRV flag.
-     *  The hostname can't be localhostname, the port always has to be 25565, and the hostname cannot be an IP. 
+     *  Tries to get a SRV record from the provided hostname, unless disabled with the SRVLookup flag.
+     *  The hostname can't be a local one, the port has to always be 25565, and the hostname cannot be an IP. 
     */
 
 

src/packetDecoder.ts

@@ -40,7 +40,7 @@ async function craftData(packet: Packet) {
   // This crafts the first and only data field. It slices off the meta fields.
   packet.fieldsBuffer = packet.dataBuffer.slice(packet.meta.metaLength)
   let fieldLength = varint.decode(packet.fieldsBuffer)
-  packet.fieldsBuffer = packet.fieldsBuffer.slice(varint.encodingLength(fieldLength));
+  packet.fieldsBuffer = packet.fieldsBuffer.slice(varint.encodingLength(fieldLength), fieldLength + varint.encodingLength(fieldLength));
   packet.crafted.data = new TextDecoder().decode(packet.fieldsBuffer); 
   packet.status.handshakeBaked = true;
   return packet;

tsconfig.json

@@ -1,13 +1,14 @@
 {
   "compilerOptions": {
-    "target": "es2021",
-    "module": "ES2020",
+    "target": "ES2020",
+    "module": "ESNext",
     "rootDir": "./src",
     "moduleResolution": "node",
     "declaration": true,
     "declarationMap": true,
     "sourceMap": true,
     "outDir": "./dist",
+    "declarationDir":"./dist/types",
     "forceConsistentCasingInFileNames": true,
     "strict": true,
     "noImplicitAny": true,