@rustwirebot/rustplus.js 2.5.0

package/rustplus.js.svg

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg width="100%" height="100%" viewBox="0 0 119 26" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
+    <g transform="matrix(2.46772,0,0,2.46772,-90.2851,-41.164)">
+        <g transform="matrix(12,0,0,12,36.5865,27.181)">
+            <path d="M0.438,-0.438L0.438,-0.688L0.188,-0.688L0.188,-0.438L0.438,-0.438ZM0,-0L0,-0.875L0.625,-0.875L0.625,-0.25L0.438,-0.25L0.438,-0.188L0.625,-0.188L0.625,-0L0.25,-0L0.25,-0.25L0.188,-0.25L0.188,-0L0,-0Z" style="fill:rgb(211,19,0);fill-rule:nonzero;"/>
+        </g>
+        <g transform="matrix(12,0,0,12,44.8131,27.181)">
+            <path d="M0,-0L0,-0.875L0.188,-0.875L0.188,-0.188L0.438,-0.188L0.438,-0.875L0.625,-0.875L0.625,-0L0,-0Z" style="fill:rgb(211,19,0);fill-rule:nonzero;"/>
+        </g>
+        <g transform="matrix(12,0,0,12,53.0396,27.181)">
+            <path d="M0,-0L0,-0.188L0.438,-0.188L0.438,-0.375L0,-0.375L0,-0.875L0.625,-0.875L0.625,-0.688L0.188,-0.688L0.188,-0.563L0.625,-0.563L0.625,-0L0,-0Z" style="fill:rgb(211,19,0);fill-rule:nonzero;"/>
+        </g>
+        <g transform="matrix(12,0,0,12,61.2662,27.181)">
+            <path d="M0.188,-0L0.188,-0.688L0,-0.688L0,-0.875L0.563,-0.875L0.563,-0.688L0.375,-0.688L0.375,-0L0.188,-0Z" style="fill:rgb(211,19,0);fill-rule:nonzero;"/>
+        </g>
+    </g>
+    <g transform="matrix(1,0,0,1,-25.4858,7.58166)">
+        <g transform="matrix(29.6126,0,0,29.6126,101.035,13.9337)">
+            <path d="M0.361,-0L0.361,-0.253L0.108,-0.253L0.108,-0.325L0.361,-0.325L0.361,-0.578L0.434,-0.578L0.434,-0.325L0.687,-0.325L0.687,-0.253L0.434,-0.253L0.434,-0L0.361,-0Z" style="fill:rgb(211,19,0);fill-rule:nonzero;"/>
+        </g>
+    </g>
+    <g transform="matrix(1,0,0,1,-30.1812,9.51199)">
+        <g transform="matrix(14.8063,0,0,14.8063,126.06,16.399)">
+            <rect x="0" y="-0.188" width="0.188" height="0.188" style="fill-rule:nonzero;"/>
+        </g>
+        <g transform="matrix(14.8063,0,0,14.8063,129.733,16.399)">
+            <path d="M0,-0L0,-0.188L0.25,-0.188L0.375,-0.313L0.375,-0.688L0,-0.688L0,-0.875L0.563,-0.875L0.563,-0.188L0.375,-0L0,-0Z" style="fill-rule:nonzero;"/>
+        </g>
+        <g transform="matrix(14.8063,0,0,14.8063,138.958,16.399)">
+            <path d="M0,-0L0,-0.188L0.438,-0.188L0.438,-0.375L0,-0.375L0,-0.875L0.625,-0.875L0.625,-0.688L0.188,-0.688L0.188,-0.563L0.625,-0.563L0.625,-0L0,-0Z" style="fill-rule:nonzero;"/>
+        </g>
+    </g>
+</svg>

package/rustplus.proto

@@ -0,0 +1,431 @@
+syntax = "proto2";
+package rustplus;
+
+message Vector2 {
+	optional float x = 1;
+	optional float y = 2;
+}
+
+message Vector3 {
+	optional float x = 1;
+	optional float y = 2;
+	optional float z = 3;
+}
+
+message Vector4 {
+	optional float x = 1;
+	optional float y = 2;
+	optional float z = 3;
+	optional float w = 4;
+}
+
+message Half3 {
+	optional float x = 1;
+	optional float y = 2;
+	optional float z = 3;
+}
+
+message Color {
+	optional float r = 1;
+	optional float g = 2;
+	optional float b = 3;
+	optional float a = 4;
+}
+
+message Ray {
+	optional Vector3 origin = 1;
+	optional Vector3 direction = 2;
+}
+
+message ClanActionResult {
+	required int32 requestId = 1;
+	required int32 result = 2;
+	required 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 string motd = 5;
+	optional int64 motdTimestamp = 6;
+	optional uint64 motdAuthor = 7;
+	optional bytes logo = 8;
+	optional sint32 color = 9;
+	repeated ClanInfo.Role roles = 10;
+	repeated ClanInfo.Member members = 11;
+	repeated ClanInfo.Invite invites = 12;
+	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;
+	}
+
+	message Member {
+		required uint64 steamId = 1;
+		required int32 roleId = 2;
+		required int64 joined = 3;
+		required 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;
+	}
+}
+
+message ClanLog {
+	required int64 clanId = 1;
+	repeated ClanLog.Entry logEntries = 2;
+
+	message Entry {
+		required int64 timestamp = 1;
+		required string eventKey = 2;
+		optional string arg1 = 3;
+		optional string arg2 = 4;
+		optional string arg3 = 5;
+		optional string arg4 = 6;
+	}
+}
+
+message ClanInvitations {
+	repeated ClanInvitations.Invitation invitations = 1;
+
+	message Invitation {
+		required int64 clanId = 1;
+		required uint64 recruiter = 2;
+		required int64 timestamp = 3;
+	}
+}
+
+enum AppEntityType {
+	Switch = 1;
+	Alarm = 2;
+	StorageMonitor = 3;
+}
+
+enum AppMarkerType {
+	Undefined = 0;
+	Player = 1;
+	Explosion = 2;
+	VendingMachine = 3;
+	CH47 = 4;
+	CargoShip = 5;
+	Crate = 6;
+	GenericRadius = 7;
+	PatrolHelicopter = 8;
+}
+
+message AppRequest {
+	required uint32 seq = 1;
+	required uint64 playerId = 2;
+	required int32 playerToken = 3;
+	optional uint32 entityId = 4;
+	optional AppEmpty getInfo = 8;
+	optional AppEmpty getTime = 9;
+	optional AppEmpty getMap = 10;
+	optional AppEmpty getTeamInfo = 11;
+	optional AppEmpty getTeamChat = 12;
+	optional AppSendMessage sendTeamMessage = 13;
+	optional AppEmpty getEntityInfo = 14;
+	optional AppSetEntityValue setEntityValue = 15;
+	optional AppEmpty checkSubscription = 16;
+	optional AppFlag setSubscription = 17;
+	optional AppEmpty getMapMarkers = 18;
+	optional AppPromoteToLeader promoteToLeader = 20;
+	optional AppEmpty getClanInfo = 21;
+	optional AppSendMessage setClanMotd = 22;
+	optional AppEmpty getClanChat = 23;
+	optional AppSendMessage sendClanMessage = 24;
+	optional AppGetNexusAuth getNexusAuth = 25;
+	optional AppCameraSubscribe cameraSubscribe = 30;
+	optional AppEmpty cameraUnsubscribe = 31;
+	optional AppCameraInput cameraInput = 32;
+}
+
+message AppMessage {
+	optional AppResponse response = 1;
+	optional AppBroadcast broadcast = 2;
+}
+
+message AppResponse {
+	required uint32 seq = 1;
+	optional AppSuccess success = 4;
+	optional AppError error = 5;
+	optional AppInfo info = 6;
+	optional AppTime time = 7;
+	optional AppMap map = 8;
+	optional AppTeamInfo teamInfo = 9;
+	optional AppTeamChat teamChat = 10;
+	optional AppEntityInfo entityInfo = 11;
+	optional AppFlag flag = 12;
+	optional AppMapMarkers mapMarkers = 13;
+	optional AppClanInfo clanInfo = 15;
+	optional AppClanChat clanChat = 16;
+	optional AppNexusAuth nexusAuth = 17;
+	optional AppCameraInfo cameraSubscribeInfo = 20;
+}
+
+message AppBroadcast {
+	optional AppTeamChanged teamChanged = 4;
+	optional AppNewTeamMessage teamMessage = 5;
+	optional AppEntityChanged entityChanged = 6;
+	optional AppClanChanged clanChanged = 7;
+	optional AppNewClanMessage clanMessage = 8;
+	optional AppCameraRays cameraRays = 10;
+}
+
+message AppEmpty {
+}
+
+message AppSendMessage {
+	required string message = 1;
+}
+
+message AppSetEntityValue {
+	required bool value = 1;
+}
+
+message AppPromoteToLeader {
+	required uint64 steamId = 1;
+}
+
+message AppGetNexusAuth {
+	required string appKey = 1;
+}
+
+message AppSuccess {
+}
+
+message AppError {
+	required string error = 1;
+}
+
+message AppFlag {
+	required 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;
+	required uint32 queuedPlayers = 9;
+	optional uint32 seed = 10;
+	optional uint32 salt = 11;
+	optional string logoImage = 12;
+	optional string nexus = 13;
+	optional int32 nexusId = 14;
+	optional string nexusZone = 15;
+}
+
+message AppTime {
+	required float dayLengthMinutes = 1;
+	required float timeScale = 2;
+	required float sunrise = 3;
+	required float sunset = 4;
+	required float time = 5;
+}
+
+message AppMap {
+	required uint32 width = 1;
+	required uint32 height = 2;
+	required bytes jpgImage = 3;
+	required 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;
+	}
+}
+
+message AppEntityInfo {
+	required AppEntityType type = 1;
+	required AppEntityPayload payload = 3;
+}
+
+message AppEntityPayload {
+	optional bool value = 1;
+	repeated AppEntityPayload.Item items = 2;
+	optional int32 capacity = 3;
+	optional bool hasProtection = 4;
+	optional uint32 protectionExpiry = 5;
+
+	message Item {
+		required int32 itemId = 1;
+		required int32 quantity = 2;
+		required bool itemIsBlueprint = 3;
+	}
+}
+
+message AppTeamInfo {
+	required 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;
+	}
+
+	message Note {
+		required int32 type = 2;
+		required float x = 3;
+		required 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;
+}
+
+message AppTeamChat {
+	repeated AppTeamMessage messages = 1;
+}
+
+message AppMarker {
+	required uint32 id = 1;
+	required AppMarkerType type = 2;
+	required float x = 3;
+	required float y = 4;
+	optional uint64 steamId = 5;
+	optional float rotation = 6;
+	optional float radius = 7;
+	optional Vector4 color1 = 8;
+	optional Vector4 color2 = 9;
+	optional float alpha = 10;
+	optional string name = 11;
+	optional bool outOfStock = 12;
+	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;
+		required bool itemIsBlueprint = 6;
+		required bool currencyIsBlueprint = 7;
+		optional float itemCondition = 8;
+		optional float itemConditionMax = 9;
+	}
+}
+
+message AppMapMarkers {
+	repeated AppMarker markers = 1;
+}
+
+message AppClanInfo {
+	optional ClanInfo clanInfo = 1;
+}
+
+message AppClanMessage {
+	required uint64 steamId = 1;
+	required string name = 2;
+	required string message = 3;
+	required int64 time = 4;
+}
+
+message AppClanChat {
+	repeated AppClanMessage messages = 1;
+}
+
+message AppNexusAuth {
+	required string serverId = 1;
+	required int32 playerToken = 2;
+}
+
+message AppTeamChanged {
+	required uint64 playerId = 1;
+	required AppTeamInfo teamInfo = 2;
+}
+
+message AppNewTeamMessage {
+	required AppTeamMessage message = 1;
+}
+
+message AppEntityChanged {
+	required uint32 entityId = 1;
+	required AppEntityPayload payload = 2;
+}
+
+message AppClanChanged {
+	optional ClanInfo clanInfo = 1;
+}
+
+message AppNewClanMessage {
+	required int64 clanId = 1;
+	required AppClanMessage message = 2;
+}
+
+message AppCameraSubscribe {
+	required string cameraId = 1;
+}
+
+message AppCameraInput {
+	required int32 buttons = 1;
+	required 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;
+}
+
+message AppCameraRays {
+	required float verticalFov = 1;
+	required int32 sampleOffset = 2;
+	required bytes rayData = 3;
+	required float distance = 4;
+	repeated AppCameraRays.Entity entities = 5;
+
+	enum EntityType {
+		Tree = 1;
+		Player = 2;
+	}
+
+	message Entity {
+		required uint32 entityId = 1;
+		required EntityType type = 2;
+		required Vector3 position = 3;
+		required Vector3 rotation = 4;
+		required Vector3 size = 5;
+		optional string name = 6;
+	}
+}

package/vendor/push-receiver/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Matthieu Lemoine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/vendor/push-receiver/NOTICE.md

@@ -0,0 +1,32 @@
+# NOTICE — vendored dependency
+
+The code in this folder (`vendor/push-receiver`) is vendored directly into
+`@rustwirebot/rustplus.js` so that this package keeps working even if the
+upstream `@liamcottle/push-receiver` npm package is ever unpublished or
+its source repository becomes unavailable.
+
+Attribution chain (all under the MIT License, see ./LICENSE):
+
+1. Original project: **push-receiver** by Matthieu Lemoine (2017)
+   https://github.com/MatthieuLemoine/push-receiver
+2. Fork with Android FCM registration support: **@liamcottle/push-receiver**
+   by Liam Cottle
+   https://github.com/liamcottle/push-receiver
+3. Vendored copy maintained here as part of **@rustwirebot/rustplus.js**
+   by BotForge Studios, with the following compatibility/security fixes:
+   - `register/index.js` was updated from the removed `require('uuid/v4')`
+     subpath (uuid v3-style) to the current `uuid` named export
+     (`const { v4: uuidv4 } = require('uuid')`).
+   - The original `request` / `request-promise` HTTP clients (both
+     deprecated upstream and flagged with known critical vulnerabilities)
+     were replaced with a small `axios`-based wrapper,
+     [`utils/http-request`](./utils/http-request/index.js), that
+     reproduces the exact same call signature and return-value behaviour
+     (form-encoding, raw-Buffer responses via `encoding: null`, and
+     throwing on non-2xx responses) so no other code had to change.
+     This was verified against a local test HTTP server covering
+     form-encoding, binary responses, retry-on-failure, and error
+     handling — all matching the original behaviour.
+
+No other functional changes were made. All credit for the original
+implementation belongs to Matthieu Lemoine and Liam Cottle.

package/vendor/push-receiver/android/fcm.js

@@ -0,0 +1,134 @@
+const crypto = require("crypto");
+const { checkIn } = require("../gcm");
+const { waitFor } = require("../utils/timeout");
+const request = require("../utils/request");
+
+class AndroidFCM {
+
+    static async register(apiKey, projectId, gcmSenderId, gmsAppId, androidPackageName, androidPackageCert) {
+
+        // create firebase installation
+        const installationAuthToken = await this.installRequest(apiKey, projectId, gmsAppId, androidPackageName, androidPackageCert);
+
+        // checkin gcm
+        const checkInResponse = await checkIn();
+
+        // register gcm
+        const fcmToken = await this.registerRequest(checkInResponse.androidId, checkInResponse.securityToken, installationAuthToken, apiKey, gcmSenderId, gmsAppId, androidPackageName, androidPackageCert);
+
+        return {
+            gcm: {
+                androidId: checkInResponse.androidId,
+                securityToken: checkInResponse.securityToken,
+            },
+            fcm: {
+                token: fcmToken,
+            },
+        };
+
+    }
+
+    static async installRequest(apiKey, projectId, gmsAppId, androidPackage, androidCert) {
+
+        // send firebase installation request
+        const response = await request({
+            url: `https://firebaseinstallations.googleapis.com/v1/projects/${projectId}/installations`,
+            method: 'POST',
+            headers: {
+                "Accept": "application/json",
+                "Content-Type": "application/json",
+                "X-Android-Package": androidPackage,
+                "X-Android-Cert": androidCert,
+                "x-firebase-client": "android-min-sdk/23 fire-core/20.0.0 device-name/a21snnxx device-brand/samsung device-model/a21s android-installer/com.android.vending fire-android/30 fire-installations/17.0.0 fire-fcm/22.0.0 android-platform/ kotlin/1.9.23 android-target-sdk/34",
+                "x-firebase-client-log-type": "3",
+                "x-goog-api-key": apiKey,
+                "User-Agent": "Dalvik/2.1.0 (Linux; U; Android 11; SM-A217F Build/RP1A.200720.012)",
+            },
+            body: JSON.stringify({
+                "fid": this.generateFirebaseFID(),
+                "appId": gmsAppId,
+                "authVersion": "FIS_v2",
+                "sdkVersion": "a:17.0.0",
+            }),
+        });
+
+        // ensure auth token received
+        const data = JSON.parse(response);
+        if(!data || !data.authToken || !data.authToken.token){
+            throw new Error(`Failed to get Firebase installation AuthToken: ${data}`);
+        }
+
+        return data.authToken.token;
+
+    }
+
+    static async registerRequest(androidId, securityToken, installationAuthToken, apiKey, gcmSenderId, gmsAppId, androidPackageName, androidPackageCert, retry = 0) {
+
+        // register gcm
+        const response = await request({
+            url: "https://android.clients.google.com/c2dm/register3",
+            method: 'POST',
+            headers: {
+                "Authorization": `AidLogin ${androidId}:${securityToken}`,
+                "Content-Type": "application/x-www-form-urlencoded",
+            },
+            form: {
+                "device": androidId,
+                "app": androidPackageName,
+                "cert": androidPackageCert,
+                "app_ver": "1",
+                "X-subtype" : gcmSenderId,
+                "X-app_ver" : "1",
+                "X-osv" : "29",
+                "X-cliv" : "fiid-21.1.1",
+                "X-gmsv" : "220217001",
+                // "X-appid" : "",
+                "X-scope" : "*",
+                "X-Goog-Firebase-Installations-Auth" : installationAuthToken,
+                "X-gms_app_id" : gmsAppId,
+                "X-Firebase-Client" : "android-min-sdk/23 fire-core/20.0.0 device-name/a21snnxx device-brand/samsung device-model/a21s android-installer/com.android.vending fire-android/30 fire-installations/17.0.0 fire-fcm/22.0.0 android-platform/ kotlin/1.9.23 android-target-sdk/34",
+                // "X-firebase-app-name-hash" : "",
+                "X-Firebase-Client-Log-Type": "1",
+                "X-app_ver_name": "1",
+                "target_ver": "31",
+                "sender": gcmSenderId,
+            },
+        });
+
+        // retry a few times if needed
+        if(response.includes('Error')){
+            console.warn(`Register request has failed with ${response}`);
+            if(retry >= 5){
+                throw new Error('GCM register has failed');
+            }
+            console.warn(`Retry... ${retry + 1}`);
+            await waitFor(1000);
+            return this.registerRequest(androidId, securityToken, installationAuthToken, apiKey, gcmSenderId, gmsAppId, androidPackageName, androidPackageCert, retry + 1);
+        }
+
+        // extract fcm token from response
+        return response.split("=")[1];
+
+    }
+
+    /**
+     * Generates a Firebase ID
+     * https://github.com/firebase/firebase-js-sdk/blob/3670ab83c563dc96f2ad0120c551f46fe7d1bb7b/packages/installations/src/helpers/generate-fid.ts#L27
+     * https://github.com/rixcian/firebase-electron/blob/master/src/core/fcm/index.ts#L124
+     * @returns {string}
+     */
+    static generateFirebaseFID() {
+
+        const buf = crypto.randomBytes(17);
+
+        // replace the first 4 bits with the constant FID header of 0b0111
+        buf[0] = 0b01110000 | (buf[0] & 0b00001111);
+
+        // encode to base64 and remove padding
+        return buf.toString("base64").replace(/=/g, "");
+
+    }
+
+}
+
+module.exports = AndroidFCM;