69 Commits

This Branch

This Branch

All Branches

Author	SHA1	Message	Date
Timofey Gelazoniya	c533bfe40d	chore: bump version to 1.7.0-beta.5	2025-06-25 13:27:27 +03:00
Timofey Gelazoniya	7222eeae3c	docs: overhaul README and provide new usage examples ... The README.md has been completely rewritten. Also the `example` directory has been renamed to `examples` and its content has been replaced with a more structured and practical set of scripts.	2025-06-25 13:18:38 +03:00
Timofey Gelazoniya	0bf30140b7	chore: bump version to 1.7.0-beta.4	2025-06-25 01:49:31 +03:00
Timofey Gelazoniya	371fb9daa7	feat: skip SRV lookup for IP addresses and localhost ... Performing DNS SRV lookups for hosts that are already direct IP addresses or special-case hostnames like 'localhost' is unnecessary. In addition, several related test suite improvements have been included: - A bug in the Bedrock mock packet creation was fixed where the magic GUID was being written to an incorrect buffer offset. - The DNS mocking strategy in the Java tests has been refactored for better accuracy by mocking the `dns.promises.Resolver` class. - An error test for the Bedrock pinger was corrected to properly handle a promise rejection instead of a synchronous throw.	2025-06-25 01:46:53 +03:00
Timofey Gelazoniya	1e6b5b3973	chore: bump version to 1.7.0-beta.3	2025-06-25 01:13:17 +03:00
Timofey Gelazoniya	23299a9a07	fix: add timeout to SRV record lookup ... The `dns.promises.resolveSrv` function used for SRV record lookups does not have a user-configurable timeout. This could cause the entire `pingJava` operation to hang for an extended period if the target's DNS server unresponsive. To make the SRV lookup more robust and respect the user-provided timeout, this commit switches to using the `dns.promises.Resolver` class.	2025-06-25 01:09:07 +03:00
Timofey Gelazoniya	2bd5d9c9bf	chore: bump version to 1.7.0-beta.2	2025-06-22 01:50:58 +03:00
Timofey Gelazoniya	7248a0096c	feat: add typescript declaration files ... Types are automatically generated from the existsing JSDoc comments in the js source code. Use `types:build` script from `package.json` to produce d.ts files.	2025-06-22 01:50:29 +03:00
Timofey Gelazoniya	a1b999ca4e	refactor: introduce typescript for static type checking ... We use JSDoc for documentation, but these annotations were not being validated. This meant that type information could become outdated or incorrect without any warning. This commit introduces the TypeScript compiler (`tsc`) as a static analysis tool to leverage our existing JSDoc comments. To support this, JSDoc annotations across the codebase have been improved for accuracy. Additionally, the `varint` module now uses a custom `VarIntError` class for better type inference and error handling. A new `typecheck` script has been added to `package.json` to run this validation.	2025-06-19 03:55:24 +03:00
Timofey Gelazoniya	7322034aba	feat: add debug logging ... Add debug logs using the `debug` library. To use this new feature, set the `DEBUG` environment variable: - `DEBUG=mineping:*` enables all logs from this library. - `DEBUG=mineping:java` enables logs for the Java module only. - `DEBUG=mineping:bedrock` enables logs for the Bedrock module only.	2025-06-19 02:14:04 +03:00
Timofey Gelazoniya	c7b99cb6db	feat: implement SRV record lookup and improve ping logic ... Add support for DNS SRV record lookups (`_minecraft._tcp`) to automatically resolve the correct server host and port, falling back to the provided address if no record is found. This makes server discovery compliant with standard Minecraft client behavior. The Java ping implementation has been refactored: - The `varint` module is rewritten to throw specific error codes and its `decodeVarInt` function now returns bytes read, which simplifies parsing logic. - The core ping logic is now promise-based and modular, breaking out packet creation and response processing into helper functions. - The TCP stream handler now robustly processes chunked data by catching recoverable decoder errors and waiting for more data, preventing crashes on incomplete packets. - Error handling is improved.	2025-06-19 01:45:27 +03:00
Timofey Gelazoniya	51b4771305	docs: add guide how to install beta version	2025-06-16 03:39:21 +03:00
Timofey Gelazoniya	3c2c049c19	refactor!: decouple Raknet MOTD parsing and response shaping ... The previous implementation of the RakNet ping was monolithic, mixing socket management, raw packet validation, and data transformation into a single, complex flow. This refactor introduces a clear, multi-stage processing pipeline that separates these concerns. The logic is now broken down into multi-stage pipeline: extracting the MOTD string from the raw pong packet -> parsing that string into a raw object -> transforming the raw data into a user-friendly response object. Additionally, the socket handling logic is improved with idempotent cleanup function to prevent resource leaks or race conditions. As part of this overhaul, external TypeScript definition (`.d.ts`) files have been removed in favor of rich JSDoc annotations. BREAKING CHANGE: The structure of the resolved `BedrockPingResponse` object has been significantly changed to improve clarity and consistency.	2025-06-16 03:36:26 +03:00
Timofey Gelazoniya	cbaa1a3e3e	docs: update email in security policy	2025-06-15 03:00:19 +03:00
Timofey Gelazoniya	435e59739c	test: implement tests using vitest framework	2025-06-15 02:56:07 +03:00
Timofey Gelazoniya	ef2bebe755	fix: only perform cleanup and fire the callback on the first error	2025-06-15 02:56:07 +03:00
Timofey Gelazoniya	27011d4091	fix: change minimum motd components to 5 and fix typos ... A valid motd message has at least 5 components, not 9	2025-06-14 23:26:11 +03:00
Timofey Gelazoniya	d8d4a9a467	chore: bump version to 1.6.1 v1.6.1	2025-02-07 08:57:18 +03:00
Timofey Gelazoniya	d90a916fa5	docs: update cli app example	2025-02-07 08:56:39 +03:00
Timofey Gelazoniya	0959403b1b	refactor: improve Bedrock error handling and validation	2025-02-07 08:48:04 +03:00
Timofey Gelazoniya	c71236f223	perf: optimize varint decoding ... docs: update type definitions	2025-02-07 08:35:21 +03:00
Timofey Gelazoniya	0b5c5e2938	chore: bump version to 1.6.0 v1.6.0	2025-02-07 08:02:26 +03:00
envizar	73a2fffe8b	feat: add virtualHost option (#6)	2025-02-07 08:01:12 +03:00
xzeldon	9469564736	docs: update references to wiki.vg ... wiki.vg has been shut down and is in the process of being merged into minecraft.wiki	2024-12-28 22:47:11 +03:00
xzeldon	838ffc497a	chore: bump version to 1.5.0 v1.5.0	2024-10-09 22:00:11 +03:00
xzeldon	502029869a	style: use "node:" prefix for imports	2024-10-09 21:59:16 +03:00
xzeldon	e3e7e293ed	fix: use vanilla ping format	2024-10-09 21:57:37 +03:00
xzeldon	88ad92e59d	chore: add example for single server ping	2024-10-09 21:55:01 +03:00
xzeldon	009f542c55	chore: bump version to 1.4.1	2024-03-31 02:02:08 +03:00
xzeldon	0b0bed4e71	docs: some clarifications in createUnconnectedPingFrame	2024-03-31 02:01:46 +03:00
xzeldon	fa4c34d896	chore: bump version to 1.4.0	2024-03-31 01:56:43 +03:00
xzeldon	296294ca96	refactor!: changes in bedrock protocol code ... BREAKING CHANGE: new bedrock ping response format	2024-03-31 01:56:03 +03:00
xzeldon	9d25aaf4ea	chore: bump version to 1.3.0	2024-03-30 16:42:44 +03:00
xzeldon	c735604c38	fix: #5 add gameVersion field for Bedrock ... Add gameVersion field in BedrockPingResponse Closes: #5	2024-03-30 16:41:42 +03:00
xzeldon	afdaa9eb3e	chore(package.json): bump version to 1.2.2	2023-12-12 00:44:41 +03:00
Timofey Gelazoniya	435899309f	Merge pull request #4 from sya-ri/fix-types/optional ... fix(types): Change options to optional	2023-12-12 00:44:20 +03:00
sya-ri	13e6b8c6ff	fix(types): Change options to optional	2023-12-09 22:38:37 +09:00
xzeldon	d7256eabe7	chore(package.json): bump version to 1.2.1	2023-12-09 12:58:53 +03:00
xzeldon	afa2c3025f	fix(bedrock.js): resolve UNCONNECTED_PING formation issue ... - Simplify UNCONNECTED_PING function - Address an issue where certain servers, particularly those based on Pocketmine, were unresponsive to Unconnected Ping requests	2023-12-09 12:57:43 +03:00
xzeldon	6c297d0b8c	chore(package.json): bump version to 1.2.0	2023-12-08 15:22:53 +03:00
Timofey Gelazoniya	283e9b32c6	Merge pull request #3 from inotflying/patch-1 ... feat(pingJava): The ability to set a specific protocol version in the parameters. According to https://wiki.vg/Server_List_Ping#:~:text=0x00-,Protocol%20Version,-VarInt	2023-12-08 15:22:07 +03:00
Egornya	354fa212a6	fix(javaPing): default protocolVersion value	2023-12-08 16:16:30 +04:00
Egornya	d9bf4cfb3f	feat(pingJava): add protocolVersion ... feat(types): `PingOptions` for Java fix(types): type names fix(types): type names	2023-12-08 16:04:35 +04:00
xzeldon	9dace3748b	docs(README.md): improve clarity and grammar in the project description	2023-10-22 22:49:53 +03:00
xzeldon	0aa73655b1	fix(parallel.js): add break statement to stop iterating over results if a promise is rejected	2023-10-22 21:38:34 +03:00
xzeldon	78ca03b004	chore(package.json): update version from 1.1.0 to 1.1.1 v1.1.1	2023-10-22 21:32:33 +03:00
xzeldon	910184bf5f	refactoring and comments ... fix(cli.js): refactor help and error handling logic for better readability and maintainability feat(cli.js): add support for custom port and timeout options fix(parallel.js): update list of hosts to ping fix(bedrock.js): add comments and improve error handling in ping function fix(java.js): add comments and improve error handling in ping function fix(varint.js): add comments to functions and improve readability fix(index.d.ts): export all functions from java.js and bedrock.js fix(lib/bedrock.d.ts): update source link fix(lib/java.d.ts): update source link	2023-10-22 21:32:00 +03:00
xzeldon	915edbec9c	update version from 1.0.4 to 1.1.0 v1.1.0	2023-10-22 02:29:54 +03:00
xzeldon	0fe675385f	bedrock.js refactoring, remove bytebuffer dependency ... add parallel.js file to demonstrate parallel pinging of multiple Bedrock servers	2023-10-22 02:29:20 +03:00
Timofey Gelazoniya	c3158ac925	Merge pull request #2 from sya-ri/update-java-ping-response-type ... Update outdated JavaPingResponse type	2023-10-22 00:39:14 +03:00