@rustwirebot/rustplus.js 2.5.2 → 2.6.0

package/README.md

@@ -1,4 +1,4 @@
-> **Note:** This is a maintained fork of [liamcottle/rustplus.js](https://github.com/liamcottle/rustplus.js), republished under the `@rustwire` npm scope by BotForge Studios so it can be installed/run as `npx @rustwirebot/rustplus.js <command>`. All credit for the original library and protobuf reverse-engineering goes to Liam Cottle. This fork is distributed under the same MIT license — see [LICENSE](./LICENSE). The `@liamcottle/push-receiver` dependency used by the `fcm-register`/`fcm-listen` CLI commands has also been vendored locally under [`vendor/push-receiver`](./vendor/push-receiver) (with its own attribution/NOTICE) so this package keeps working even if that upstream npm package is ever removed.
+> **Note:** This is a maintained fork of [liamcottle/rustplus.js](https://github.com/liamcottle/rustplus.js), republished under the `@rustwire` npm scope by BotForge Studios so it can be installed/run as `npx @rustwirebot/rustplus.js <command>`. All credit for the original library and protobuf reverse-engineering goes to Liam Cottle. This fork is distributed under the same MIT license — see [LICENSE](./LICENSE). The `@liamcottle/push-receiver` dependency used by the `fcm-register`/`fcm-listen` CLI commands has also been vendored locally under [`vendor/push-receiver`](./vendor/push-receiver) (with its own attribution/NOTICE) so this package keeps working even if that upstream npm package is ever removed. As of v2.6.0, every `required` field in `rustplus.proto` has been relaxed to `optional` — real-world Rust servers frequently omit fields (queue counts, blueprint flags, online status, etc.) that the original schema marked as mandatory, which crashed decoding entirely instead of just defaulting to a sensible zero-value. Verified by round-tripping all 56 message types with fully empty payloads.
 
 <p align="center">
 <img src="./rustplus.js.svg" width="400"></a>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rustwirebot/rustplus.js",
-  "version": "2.5.2",
+  "version": "2.6.0",
   "description": "NodeJS library for controlling Smart Switches and interacting with the Rust+ Companion API. Maintained fork of @liamcottle/rustplus.js, republished by BotForge Studios / RustWire.",
   "main": "rustplus.js",
   "bin": {

package/rustplus.proto

@@ -38,17 +38,17 @@ message Ray {
 }
 
 message ClanActionResult {
-	required int32 requestId = 1;
-	required int32 result = 2;
-	required bool hasClanInfo = 3;
+	optional int32 requestId = 1;
+	optional int32 result = 2;
+	optional bool hasClanInfo = 3;
 	optional ClanInfo clanInfo = 4;
 }
 
 message ClanInfo {
-	required int64 clanId = 1;
-	required string name = 2;
-	required int64 created = 3;
-	required uint64 creator = 4;
+	optional int64 clanId = 1;
+	optional string name = 2;
+	optional int64 created = 3;
+	optional uint64 creator = 4;
 	optional string motd = 5;
 	optional int64 motdTimestamp = 6;
 	optional uint64 motdAuthor = 7;
@@ -60,42 +60,42 @@ message ClanInfo {
 	optional int32 maxMemberCount = 13;
 
 	message Role {
-		required int32 roleId = 1;
-		required int32 rank = 2;
-		required string name = 3;
-		required bool canSetMotd = 4;
-		required bool canSetLogo = 5;
-		required bool canInvite = 6;
-		required bool canKick = 7;
-		required bool canPromote = 8;
-		required bool canDemote = 9;
-		required bool canSetPlayerNotes = 10;
-		required bool canAccessLogs = 11;
+		optional int32 roleId = 1;
+		optional int32 rank = 2;
+		optional string name = 3;
+		optional bool canSetMotd = 4;
+		optional bool canSetLogo = 5;
+		optional bool canInvite = 6;
+		optional bool canKick = 7;
+		optional bool canPromote = 8;
+		optional bool canDemote = 9;
+		optional bool canSetPlayerNotes = 10;
+		optional bool canAccessLogs = 11;
 	}
 
 	message Member {
-		required uint64 steamId = 1;
-		required int32 roleId = 2;
-		required int64 joined = 3;
-		required int64 lastSeen = 4;
+		optional uint64 steamId = 1;
+		optional int32 roleId = 2;
+		optional int64 joined = 3;
+		optional int64 lastSeen = 4;
 		optional string notes = 5;
 		optional bool online = 6;
 	}
 
 	message Invite {
-		required uint64 steamId = 1;
-		required uint64 recruiter = 2;
-		required int64 timestamp = 3;
+		optional uint64 steamId = 1;
+		optional uint64 recruiter = 2;
+		optional int64 timestamp = 3;
 	}
 }
 
 message ClanLog {
-	required int64 clanId = 1;
+	optional int64 clanId = 1;
 	repeated ClanLog.Entry logEntries = 2;
 
 	message Entry {
-		required int64 timestamp = 1;
-		required string eventKey = 2;
+		optional int64 timestamp = 1;
+		optional string eventKey = 2;
 		optional string arg1 = 3;
 		optional string arg2 = 4;
 		optional string arg3 = 5;
@@ -107,9 +107,9 @@ message ClanInvitations {
 	repeated ClanInvitations.Invitation invitations = 1;
 
 	message Invitation {
-		required int64 clanId = 1;
-		required uint64 recruiter = 2;
-		required int64 timestamp = 3;
+		optional int64 clanId = 1;
+		optional uint64 recruiter = 2;
+		optional int64 timestamp = 3;
 	}
 }
 
@@ -132,9 +132,9 @@ enum AppMarkerType {
 }
 
 message AppRequest {
-	required uint32 seq = 1;
-	required uint64 playerId = 2;
-	required int32 playerToken = 3;
+	optional uint32 seq = 1;
+	optional uint64 playerId = 2;
+	optional int32 playerToken = 3;
 	optional uint32 entityId = 4;
 	optional AppEmpty getInfo = 8;
 	optional AppEmpty getTime = 9;
@@ -164,7 +164,7 @@ message AppMessage {
 }
 
 message AppResponse {
-	required uint32 seq = 1;
+	optional uint32 seq = 1;
 	optional AppSuccess success = 4;
 	optional AppError error = 5;
 	optional AppInfo info = 6;
@@ -194,41 +194,41 @@ message AppEmpty {
 }
 
 message AppSendMessage {
-	required string message = 1;
+	optional string message = 1;
 }
 
 message AppSetEntityValue {
-	required bool value = 1;
+	optional bool value = 1;
 }
 
 message AppPromoteToLeader {
-	required uint64 steamId = 1;
+	optional uint64 steamId = 1;
 }
 
 message AppGetNexusAuth {
-	required string appKey = 1;
+	optional string appKey = 1;
 }
 
 message AppSuccess {
 }
 
 message AppError {
-	required string error = 1;
+	optional string error = 1;
 }
 
 message AppFlag {
-	required bool value = 1;
+	optional bool value = 1;
 }
 
 message AppInfo {
-	required string name = 1;
-	required string headerImage = 2;
-	required string url = 3;
-	required string map = 4;
-	required uint32 mapSize = 5;
-	required uint32 wipeTime = 6;
-	required uint32 players = 7;
-	required uint32 maxPlayers = 8;
+	optional string name = 1;
+	optional string headerImage = 2;
+	optional string url = 3;
+	optional string map = 4;
+	optional uint32 mapSize = 5;
+	optional uint32 wipeTime = 6;
+	optional uint32 players = 7;
+	optional uint32 maxPlayers = 8;
 	optional uint32 queuedPlayers = 9; // FIX: some real Rust servers omit this field entirely; was `required`, which crashed decoding with a ProtocolError instead of just defaulting to 0.
 	optional uint32 seed = 10;
 	optional uint32 salt = 11;
@@ -239,31 +239,31 @@ message AppInfo {
 }
 
 message AppTime {
-	required float dayLengthMinutes = 1;
-	required float timeScale = 2;
-	required float sunrise = 3;
-	required float sunset = 4;
-	required float time = 5;
+	optional float dayLengthMinutes = 1;
+	optional float timeScale = 2;
+	optional float sunrise = 3;
+	optional float sunset = 4;
+	optional float time = 5;
 }
 
 message AppMap {
-	required uint32 width = 1;
-	required uint32 height = 2;
-	required bytes jpgImage = 3;
-	required int32 oceanMargin = 4;
+	optional uint32 width = 1;
+	optional uint32 height = 2;
+	optional bytes jpgImage = 3;
+	optional int32 oceanMargin = 4;
 	repeated AppMap.Monument monuments = 5;
 	optional string background = 6;
 
 	message Monument {
-		required string token = 1;
-		required float x = 2;
-		required float y = 3;
+		optional string token = 1;
+		optional float x = 2;
+		optional float y = 3;
 	}
 }
 
 message AppEntityInfo {
-	required AppEntityType type = 1;
-	required AppEntityPayload payload = 3;
+	optional AppEntityType type = 1;
+	optional AppEntityPayload payload = 3;
 }
 
 message AppEntityPayload {
@@ -274,42 +274,42 @@ message AppEntityPayload {
 	optional uint32 protectionExpiry = 5;
 
 	message Item {
-		required int32 itemId = 1;
-		required int32 quantity = 2;
+		optional int32 itemId = 1;
+		optional int32 quantity = 2;
 		optional bool itemIsBlueprint = 3; // FIX: some servers omit this for non-blueprint items; was `required`
 	}
 }
 
 message AppTeamInfo {
-	required uint64 leaderSteamId = 1;
+	optional uint64 leaderSteamId = 1;
 	repeated AppTeamInfo.Member members = 2;
 	repeated AppTeamInfo.Note mapNotes = 3;
 	repeated AppTeamInfo.Note leaderMapNotes = 4;
 
 	message Member {
-		required uint64 steamId = 1;
-		required string name = 2;
-		required float x = 3;
-		required float y = 4;
-		required bool isOnline = 5;
-		required uint32 spawnTime = 6;
-		required bool isAlive = 7;
-		required uint32 deathTime = 8;
+		optional uint64 steamId = 1;
+		optional string name = 2;
+		optional float x = 3;
+		optional float y = 4;
+		optional bool isOnline = 5;
+		optional uint32 spawnTime = 6;
+		optional bool isAlive = 7;
+		optional uint32 deathTime = 8;
 	}
 
 	message Note {
-		required int32 type = 2;
-		required float x = 3;
-		required float y = 4;
+		optional int32 type = 2;
+		optional float x = 3;
+		optional float y = 4;
 	}
 }
 
 message AppTeamMessage {
-	required uint64 steamId = 1;
-	required string name = 2;
-	required string message = 3;
-	required string color = 4;
-	required uint32 time = 5;
+	optional uint64 steamId = 1;
+	optional string name = 2;
+	optional string message = 3;
+	optional string color = 4;
+	optional uint32 time = 5;
 }
 
 message AppTeamChat {
@@ -317,10 +317,10 @@ message AppTeamChat {
 }
 
 message AppMarker {
-	required uint32 id = 1;
-	required AppMarkerType type = 2;
-	required float x = 3;
-	required float y = 4;
+	optional uint32 id = 1;
+	optional AppMarkerType type = 2;
+	optional float x = 3;
+	optional float y = 4;
 	optional uint64 steamId = 5;
 	optional float rotation = 6;
 	optional float radius = 7;
@@ -332,11 +332,11 @@ message AppMarker {
 	repeated AppMarker.SellOrder sellOrders = 13;
 
 	message SellOrder {
-		required int32 itemId = 1;
-		required int32 quantity = 2;
-		required int32 currencyId = 3;
-		required int32 costPerItem = 4;
-		required int32 amountInStock = 5;
+		optional int32 itemId = 1;
+		optional int32 quantity = 2;
+		optional int32 currencyId = 3;
+		optional int32 costPerItem = 4;
+		optional int32 amountInStock = 5;
 		optional bool itemIsBlueprint = 6; // FIX: some servers omit this for non-blueprint items; was `required`
 		optional bool currencyIsBlueprint = 7; // FIX: same as above; was `required`
 		optional float itemCondition = 8;
@@ -353,10 +353,10 @@ message AppClanInfo {
 }
 
 message AppClanMessage {
-	required uint64 steamId = 1;
-	required string name = 2;
-	required string message = 3;
-	required int64 time = 4;
+	optional uint64 steamId = 1;
+	optional string name = 2;
+	optional string message = 3;
+	optional int64 time = 4;
 }
 
 message AppClanChat {
@@ -364,22 +364,22 @@ message AppClanChat {
 }
 
 message AppNexusAuth {
-	required string serverId = 1;
-	required int32 playerToken = 2;
+	optional string serverId = 1;
+	optional int32 playerToken = 2;
 }
 
 message AppTeamChanged {
-	required uint64 playerId = 1;
-	required AppTeamInfo teamInfo = 2;
+	optional uint64 playerId = 1;
+	optional AppTeamInfo teamInfo = 2;
 }
 
 message AppNewTeamMessage {
-	required AppTeamMessage message = 1;
+	optional AppTeamMessage message = 1;
 }
 
 message AppEntityChanged {
-	required uint32 entityId = 1;
-	required AppEntityPayload payload = 2;
+	optional uint32 entityId = 1;
+	optional AppEntityPayload payload = 2;
 }
 
 message AppClanChanged {
@@ -387,32 +387,32 @@ message AppClanChanged {
 }
 
 message AppNewClanMessage {
-	required int64 clanId = 1;
-	required AppClanMessage message = 2;
+	optional int64 clanId = 1;
+	optional AppClanMessage message = 2;
 }
 
 message AppCameraSubscribe {
-	required string cameraId = 1;
+	optional string cameraId = 1;
 }
 
 message AppCameraInput {
-	required int32 buttons = 1;
-	required Vector2 mouseDelta = 2;
+	optional int32 buttons = 1;
+	optional Vector2 mouseDelta = 2;
 }
 
 message AppCameraInfo {
-	required int32 width = 1;
-	required int32 height = 2;
-	required float nearPlane = 3;
-	required float farPlane = 4;
-	required int32 controlFlags = 5;
+	optional int32 width = 1;
+	optional int32 height = 2;
+	optional float nearPlane = 3;
+	optional float farPlane = 4;
+	optional int32 controlFlags = 5;
 }
 
 message AppCameraRays {
-	required float verticalFov = 1;
-	required int32 sampleOffset = 2;
-	required bytes rayData = 3;
-	required float distance = 4;
+	optional float verticalFov = 1;
+	optional int32 sampleOffset = 2;
+	optional bytes rayData = 3;
+	optional float distance = 4;
 	repeated AppCameraRays.Entity entities = 5;
 
 	enum EntityType {
@@ -421,11 +421,11 @@ message AppCameraRays {
 	}
 
 	message Entity {
-		required uint32 entityId = 1;
-		required EntityType type = 2;
-		required Vector3 position = 3;
-		required Vector3 rotation = 4;
-		required Vector3 size = 5;
+		optional uint32 entityId = 1;
+		optional EntityType type = 2;
+		optional Vector3 position = 3;
+		optional Vector3 rotation = 4;
+		optional Vector3 size = 5;
 		optional string name = 6;
 	}
 }