17 Commits

Author	SHA1	Message	Date
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	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	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	0959403b1b	refactor: improve Bedrock error handling and validation	2025-02-07 08:48:04 +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	e3e7e293ed	fix: use vanilla ping format	2024-10-09 21:57:37 +03:00
xzeldon	0b0bed4e71	docs: some clarifications in createUnconnectedPingFrame	2024-03-31 02:01:46 +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	c735604c38	fix: #5 add gameVersion field for Bedrock ... Add gameVersion field in BedrockPingResponse Closes: #5	2024-03-30 16:41:42 +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	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	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
Roman Alexander	af78a184db	Fix ping never firing an error when timeout occurs.	2023-10-08 16:22:18 -04:00
xzeldon	e9cd348935	initial commit	2022-01-10 23:21:47 +03:00