@alca/rocket-league-stats-api 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jacob Foster
+
+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/README.md

@@ -0,0 +1,35 @@
+# @alca/rocket-league-stats-api
+
+Connect to the Rocket League's Stats API over WebSocket.
+
+# Install
+
+```bash
+npm i @alca/rocket-league-stats-api
+```
+
+# Usage
+
+```ts
+import RocketLeagueStatsApiClient from '@alca/rocket-league-stats-api';
+
+const client = new RocketLeagueStatsApiClient();
+
+client.connect();
+
+client.onSocketOpen = () => console.log('Connected!');
+
+client.onGoalScored = data => {
+	console.log(`${data.Scorer.Name} scored! ${data.Assister ? `(${data.Assister.Name} assisted)` : ''}`);
+};
+```
+
+## Configuration
+
+See the [configuration section](https://www.rocketleague.com/developer/stats-api#configuration) of the official documentation. The "WebPort" port value (`49124` by default) is what is used for the WebSocket connection. The port can be changed but will need to be passed to the client constructor or changed in the options property before connecting.
+
+# Notes
+
+## Duplicate StatfeedEvent for local bots and splitscreen
+
+If you play an offline Exhibition or play with a splitscreen player, you will receive multiple events to `onStatfeedEvent`. Some care should be taken to throttle duplicate data.

package/dist/index.d.ts

@@ -0,0 +1,550 @@
+export declare namespace Commands {
+	namespace ChangePov {
+		type Focus = "Ball" | `${number}`;
+		type Perspective = "Fly" | "SoftAttach" | "HardAttach" | "PlayerView" | "AutoCam" | "Camera_Director";
+	}
+}
+export interface BaseMessage {
+	Event: Events.AllEventNames;
+	Data: string;
+}
+export interface Vector {
+	X: number;
+	Y: number;
+	Z: number;
+}
+export interface Player {
+	/** Display name. */
+	Name: string;
+	/** Platform identifier in the format Platform|Uid|Splitscreen (e.g. "Steam|123|0", "Epic|456|0"). */
+	PrimaryId: string;
+	/** Spectator shortcut number. */
+	Shortcut: number;
+	/** Team index (0 = Blue, 1 = Orange). */
+	TeamNum: number;
+	/** Total match score. */
+	Score: number;
+	/** Goals scored this match. */
+	Goals: number;
+	/** Shot attempts this match. */
+	Shots: number;
+	/** Assists earned this match. */
+	Assists: number;
+	/** Saves made this match. */
+	Saves: number;
+	/** Total ball touches. */
+	Touches: number;
+	/** Touches by the car body (not ball). */
+	CarTouches: number;
+	/** Demolitions inflicted. */
+	Demos: number;
+	/** Asset names of the equipped loadout for the player's current team sorted by product slot. */
+	Loadout: string[];
+	/**
+	 * True if the player currently has a vehicle.
+	 * @SPECTATOR
+	 */
+	bHasCar: boolean;
+	/**
+	 * Vehicle speed in Unreal Units/second.
+	 * @SPECTATOR
+	 */
+	Speed: number;
+	/**
+	 * Boost amount 0–100.
+	 * @SPECTATOR
+	 */
+	Boost: number;
+	/**
+	 * True if the player is currently boosting.
+	 * @SPECTATOR
+	 */
+	bBoosting?: boolean;
+	/**
+	 * True if at least 3 wheels are touching the world.
+	 * @SPECTATOR
+	 */
+	bOnGround?: boolean;
+	/**
+	 * True if the vehicle is on a wall.
+	 * @SPECTATOR
+	 */
+	bOnWall?: boolean;
+	/**
+	 * True if the player is holding handbrake.
+	 * @SPECTATOR
+	 */
+	bPowersliding?: boolean;
+	/**
+	 * True if the vehicle is currently destroyed.
+	 * @SPECTATOR
+	 */
+	bDemolished?: boolean;
+	/**
+	 * True if the vehicle is at supersonic speed.
+	 * @SPECTATOR
+	 */
+	bSupersonic?: boolean;
+	/**
+	 * Class name of the player's currently available Rumble pickup. Omitted when not playing with rumble powerups.
+	 * @SPECTATOR
+	 */
+	PickupClass?: string;
+	/**
+	 * The player who demolished this player. Present only when demolished.
+	 */
+	Attacker?: PlayerRef;
+}
+export type PlayerRef = Pick<Player, "Name" | "Shortcut" | "TeamNum">;
+export interface BallLastTouch {
+	/** The player who made the last touch. */
+	Player: PlayerRef;
+	/** Speed of the ball resulting from this hit. */
+	Speed: number;
+}
+export declare namespace Events {
+	export type AllEventNames = "UpdateState" | "BallHit" | "BoostPickup" | "ClockUpdatedSeconds" | "CountdownBegin" | "CrossbarHit" | "GoalReplayStart" | "GoalReplayWillEnd" | "GoalReplayEnd" | "GoalScored" | "MatchCreated" | "MatchInitialized" | "MatchPaused" | "MatchUnpaused" | "MatchEnded" | "MatchDestroyed" | "PlayerJoined" | "PlayerLeft" | "PodiumStart" | "ReplayCreated" | "RoundStarted" | "StatfeedEvent";
+	interface EventBase {
+		/** Only set for online or LAN matches. */
+		MatchGuid: string;
+	}
+	export namespace Partials_UpdateState {
+		interface GameTeam {
+			/** Team name. */
+			Name: string;
+			/** Team index. */
+			TeamNum: number;
+			/** Team goal count. */
+			Score: number;
+			/**
+			 * Hex color code (no #) for the team’s primary color.
+			 * @example "FF9F00"
+			 */
+			ColorPrimary: string;
+			/** Hex color code for the team’s secondary color.
+			 * @example "E5E5E5"
+			 */
+			ColorSecondary: string;
+		}
+		interface GameBall {
+			/** Current ball speed in Unreal Units/second. */
+			Speed: number;
+			/** Index of the last team to touch the ball. `255` if the ball has not been touched. */
+			TeamNum: number;
+		}
+		/**
+		 * Match metadata.
+		 */
+		interface Game {
+			/** One entry per team, ordered by TeamNum. */
+			Teams: GameTeam[];
+			/** Playlist Id of the current match. */
+			PlaylistId: number;
+			/** Seconds remaining in the match. */
+			TimeSeconds: number;
+			/** True if the match is in overtime. */
+			bOvertime: boolean;
+			/** Current ball state. */
+			Ball: GameBall;
+			/** True if a goal replay or history replay is active. */
+			bReplay: boolean;
+			/** True if a team has won. */
+			bHasWinner: boolean;
+			/** Name of the winning team. Empty string if no winner yet. */
+			Winner: string;
+			/** Asset name of the current map (e.g. "Stadium_P").
+			 * @example "Wasteland_GRS_P"
+			 */
+			Arena: string;
+			/** True if the client is currently viewing a specific vehicle. */
+			bHasTarget: boolean;
+			/** Player currently being viewed. Members are an empty string or 0 if the player does not have a spectator target. */
+			Target?: PlayerRef;
+			/** Current frame number if a replay is active. */
+			Frame?: number;
+			/** Seconds elapsed since game start if a replay is active. */
+			Elapsed?: number;
+		}
+	}
+	/**
+	 * Sent X amount of times per second based on the player's PacketSendRate preference.
+	 */
+	export interface Event_UpdateState extends EventBase {
+		/** One entry per player in the match. */
+		Players: Player[];
+		/** Match metadata. */
+		Game: Partials_UpdateState.Game;
+	}
+	export namespace Partials_BallHit {
+		interface Ball {
+			/** Ball speed before the hit (Unreal Units/second). */
+			PreHitSpeed: number;
+			/** Ball speed after the hit (Unreal Units/second). */
+			PostHitSpeed: number;
+			/** World position of the ball at impact. */
+			Location: Vector;
+		}
+	}
+	export interface Event_BallHit extends EventBase {
+		/** Players that hit the ball that frame. */
+		Players: PlayerRef[];
+		/** Ball state at the moment of the hit. */
+		Ball: Partials_BallHit.Ball;
+	}
+	export interface Event_BoostPickup extends EventBase {
+		/** The player who collected the boost. */
+		Player: PlayerRef;
+		/** World location of the pickup. */
+		Location: Vector;
+		/** Amount of boost granted by the pickup. */
+		BoostAmount: number;
+		/** Pickup class: BoostType_Pad (small pad), BoostType_Pill (full/big boost). */
+		BoostType: "BoostType_Pad" | "BoostType_Pill";
+		/** True if the pickup occurred during replay playback. */
+		bReplay: boolean;
+	}
+	export interface Event_ClockUpdatedSeconds extends EventBase {
+		/** Seconds remaining in the match. */
+		TimeSeconds: number;
+		/** True if the game is in overtime. */
+		bOvertime: boolean;
+	}
+	export interface Event_CountdownBegin extends EventBase {
+	}
+	export interface Event_CrossbarHit extends EventBase {
+		/** Ball speed on impact. */
+		BallSpeed: number;
+		/** Impact force of the ball relative to the crossbar normal. */
+		ImpactForce: number;
+		/** The last touch of the ball before the crossbar hit. */
+		BallLastTouch: BallLastTouch;
+		/** World position of the ball when the impact occurred. */
+		BallLocation: Vector;
+	}
+	export interface Event_GoalReplayStart extends EventBase {
+	}
+	export interface Event_GoalReplayWillEnd extends EventBase {
+	}
+	export interface Event_GoalReplayEnd extends EventBase {
+	}
+	export interface Event_GoalScored extends EventBase {
+		/** Speed of the ball (Unreal Units/second) when it crossed the goal line. */
+		GoalSpeed: number;
+		/** Length of the previous round in seconds. */
+		GoalTime: number;
+		/** World position of the ball when the goal was scored. */
+		ImpactLocation: Vector;
+		/** The player who scored the goal. */
+		Scorer: PlayerRef;
+		/** The last touch of the ball before the goal. */
+		BallLastTouch: BallLastTouch;
+		/** Present only when an assist was recorded. */
+		Assister?: PlayerRef;
+	}
+	export interface Event_MatchCreated extends EventBase {
+	}
+	export interface Event_MatchInitialized extends EventBase {
+	}
+	export interface Event_MatchPaused extends EventBase {
+	}
+	export interface Event_MatchUnpaused extends EventBase {
+	}
+	export interface Event_MatchEnded extends EventBase {
+		/** Team index of the winning team. */
+		WinnerTeamNum: number;
+	}
+	export interface Event_MatchDestroyed extends EventBase {
+	}
+	export interface Event_PlayerJoined extends EventBase {
+		/** Display name of the player who joined. */
+		PlayerName: string;
+		/** Platform identifier in the format Platform|Uid|Splitscreen (e.g. "Steam|123|0", "Epic|456|0"). */
+		PrimaryId: string;
+	}
+	export interface Event_PlayerLeft extends EventBase {
+		/** Display name of the player who left. */
+		PlayerName: string;
+		/** Platform identifier in the format Platform|Uid|Splitscreen (e.g. "Steam|123|0", "Epic|456|0"). */
+		PrimaryId: string;
+	}
+	export interface Event_PodiumStart extends EventBase {
+	}
+	export interface Event_ReplayCreated extends EventBase {
+		/** File name of the replay. */
+		FileName: string;
+		/** Timestamp the replay was created. */
+		Date: string;
+	}
+	export interface Event_RoundStarted extends EventBase {
+	}
+	export interface Event_StatfeedEvent extends EventBase {
+		/**
+		 * Asset name of the StatEvent (e.g. "Demolish", "Save").
+		 */
+		EventName: "Demolish" | "Demolition" | "Goal" | "Win" | "MVP" | "AerialGoal" | "BackwardsGoal" | "BicycleGoal" | "LongGoal" | "TurtleGoal" | "PoolShot" | "OvertimeGoal" | "HatTrick" | "Assist" | "Playmaker" | "Save" | "EpicSave" | "Savior" | "Shot" | "Center" | "Clear" | "FirstTouch" | "BreakoutDamage" | "BreakoutDamageLarge" | "LowFive" | "HighFive" | "HoopsSwishGoal" | "BicycleHit" | "OwnGoal" | "FlipReset";
+		/**
+		 * Localized display label for the stat (e.g. "Demolition").
+		 */
+		Type: string;
+		/** Player who earned the stat. */
+		MainTarget: PlayerRef;
+		/** Player involved in the stat (e.g. the demolished player). */
+		SecondaryTarget?: PlayerRef;
+	}
+	export {};
+}
+export declare class ConnectionError extends Error {
+}
+export declare class Connection {
+	ws: WebSocket;
+	onOpen?: (e: Event) => void;
+	onMessage?: (event: Events.AllEventNames, dataStr: string) => void;
+	onClose?: (e: CloseEvent) => void;
+	onError?: (err: ConnectionError) => void;
+	constructor(host: string, port: number, secure: boolean);
+	handleMessage(e: MessageEvent): void;
+	protected handleError(error: Error): void;
+	protected handleError(message: string, errorOptions?: ErrorOptions): void;
+	removeListeners(): void;
+	close(): void;
+	isConnected(): boolean;
+	send(message: object): void;
+}
+export declare class ClientError extends Error {
+}
+export interface ClientOptions {
+	/**
+	 * Hostname to connect to the Rocket League client.
+	 * @default '127.0.0.1'
+	 */
+	host: string;
+	/**
+	 * Port to connect to the Rocket League client.
+	 * @default 49124
+	 */
+	port: number;
+	/**
+	 * Whether to use the wss: (true) or ws: (false) protocol.
+	 * @default false
+	 */
+	secure: boolean;
+}
+/**
+ * @see https://www.rocketleague.com/developer/stats-api
+ */
+declare class Client {
+	/**
+	 * Client options to use when connecting, etc. Recommended to configure with the constructor initially.
+	 */
+	options: ClientOptions;
+	socket?: Connection;
+	protected reconnectAttempts: number;
+	protected reconnectTimeout: Parameters<typeof clearTimeout>[0];
+	protected wasCloseCalled: boolean;
+	/**
+	 * A lifecycle event for when the socket is successfully connected.
+	 */
+	onSocketConnected?: () => void;
+	/**
+	 * A lifecycle event for when the socket is closed.
+	 */
+	onSocketClosed?: (event: {
+		wasCloseCalled: boolean;
+	}) => void;
+	/** Emitted for any internal errors. */
+	onError?: (err: Error) => void;
+	/** All events received on the socket except for UpdateState (tick event). */
+	onEvent?: (event: Events.AllEventNames, data: object) => void;
+	/**
+	 * Sent X amount of times per second based on the player's PacketSendRate preference.
+	 * @see https://www.rocketleague.com/developer/stats-api#UpdateState
+	 */
+	onUpdateState?: (data: Events.Event_UpdateState) => void;
+	/**
+	 * Sent one frame after the ball is hit.
+	 * @see https://www.rocketleague.com/developer/stats-api#BallHit
+	 */
+	onBallHit?: (data: Events.Event_BallHit) => void;
+	/**
+	 * Sent when a vehicle collects a boost pad or pill.
+	 * @SPECTATOR
+	 * @see https://www.rocketleague.com/developer/stats-api#BoostPickup
+	 */
+	onBoostPickup?: (data: Events.Event_BoostPickup) => void;
+	/**
+	 * Sent when the in-game clock has changed.
+	 * @SPECTATOR
+	 * @see https://www.rocketleague.com/developer/stats-api#ClockUpdatedSeconds
+	 */
+	onClockUpdatedSeconds?: (data: Events.Event_ClockUpdatedSeconds) => void;
+	/**
+	 * Sent at the start of each round when the countdown starts.
+	 * @see https://www.rocketleague.com/developer/stats-api#CountdownBegin
+	 */
+	onCountdownBegin?: (data: Events.Event_CountdownBegin) => void;
+	/**
+	 * Sent when the ball hits a crossbar.
+	 * @see https://www.rocketleague.com/developer/stats-api#CrossbarHit
+	 */
+	onCrossbarHit?: (data: Events.Event_CrossbarHit) => void;
+	/**
+	 * Sent when a goal replay starts.
+	 * @see https://www.rocketleague.com/developer/stats-api#GoalReplayStart
+	 */
+	onGoalReplayStart?: (data: Events.Event_GoalReplayStart) => void;
+	/**
+	 * Sent when a goal replay ends.
+	 * @see https://www.rocketleague.com/developer/stats-api#GoalReplayWillEnd
+	 */
+	onGoalReplayWillEnd?: (data: Events.Event_GoalReplayWillEnd) => void;
+	/**
+	 * Sent when the ball explodes during a goal replay. If the replay is skipped this event will not fire.
+	 * @see https://www.rocketleague.com/developer/stats-api#GoalReplayEnd
+	 */
+	onGoalReplayEnd?: (data: Events.Event_GoalReplayEnd) => void;
+	/**
+	 * Sent when a goal is scored.
+	 * @see https://www.rocketleague.com/developer/stats-api#GoalScored
+	 */
+	onGoalScored?: (data: Events.Event_GoalScored) => void;
+	/**
+	 * Sent when all teams are created and replicated.
+	 * @see https://www.rocketleague.com/developer/stats-api#MatchCreated
+	 */
+	onMatchCreated?: (data: Events.Event_MatchCreated) => void;
+	/**
+	 * Sent when the first countdown starts.
+	 * @see https://www.rocketleague.com/developer/stats-api#MatchInitialized
+	 */
+	onMatchInitialized?: (data: Events.Event_MatchInitialized) => void;
+	/**
+	 * Sent when the game is paused by a match admin.
+	 * @see https://www.rocketleague.com/developer/stats-api#MatchPaused
+	 */
+	onMatchPaused?: (data: Events.Event_MatchPaused) => void;
+	/**
+	 * Sent when the game is unpaused by a match admin.
+	 * @see https://www.rocketleague.com/developer/stats-api#MatchUnpaused
+	 */
+	onMatchUnpaused?: (data: Events.Event_MatchUnpaused) => void;
+	/**
+	 * Sent when the match ends and a winner is chosen.
+	 * @see https://www.rocketleague.com/developer/stats-api#MatchUnpaused
+	 */
+	onMatchEnded?: (data: Events.Event_MatchEnded) => void;
+	/**
+	 * Sent when leaving the game.
+	 * @see https://www.rocketleague.com/developer/stats-api#MatchDestroyed
+	 */
+	onMatchDestroyed?: (data: Events.Event_MatchDestroyed) => void;
+	/**
+	 * Sent when a player is added to the current match.
+	 * @see https://www.rocketleague.com/developer/stats-api#PlayerJoined
+	 */
+	onPlayerJoined?: (data: Events.Event_PlayerJoined) => void;
+	/**
+	 * Sent when a player is removed from the current match.
+	 * @see https://www.rocketleague.com/developer/stats-api#PlayerLeft
+	 */
+	onPlayerLeft?: (data: Events.Event_PlayerLeft) => void;
+	/**
+	 * Sent when the game enters the podium state after the match ends.
+	 * @see https://www.rocketleague.com/developer/stats-api#PodiumStart
+	 */
+	onPodiumStart?: (data: Events.Event_PodiumStart) => void;
+	/**
+	 * Sent when a replay is initialized. Does not pertain to goal replays,
+	 * only replays you load via the Match History menu.
+	 * @see https://www.rocketleague.com/developer/stats-api#ReplayCreated
+	 */
+	onReplayCreated?: (data: Events.Event_ReplayCreated) => void;
+	/**
+	 * Sent when the game enters the active state (after the countdown finishes).
+	 * @see https://www.rocketleague.com/developer/stats-api#RoundStarted
+	 */
+	onRoundStarted?: (data: Events.Event_RoundStarted) => void;
+	/**
+	 * Sent when someone earns a stat.
+	 * @see https://www.rocketleague.com/developer/stats-api#StatfeedEvent
+	 */
+	onStatfeedEvent?: (data: Events.Event_StatfeedEvent) => void;
+	constructor(opts?: Partial<ClientOptions>);
+	protected handleOpen(): void;
+	protected handleClose(): void;
+	protected handleError(error: Error): void;
+	protected handleError(message: string, errorOptions?: ErrorOptions): void;
+	protected handleMessage(event: Events.AllEventNames, dataStr: string): void;
+	protected sendCommand(command: string, data: object): void;
+	/**
+	 * Connect to the Rocket League client. Will ignore subsequent calls to connect if already connected.
+	 */
+	connect(): void;
+	/**
+	 * Close to connection to the Rocket League client. Will ignore subsequent calls to close.
+	 */
+	close(): void;
+	/**
+	 * Tests if the client has a socket that is open.
+	 */
+	isConnected(): this is {
+		socket: Connection;
+	};
+	/**
+	 * Changes the spectator/replay viewpoint. At least one of Focus or Perspective must be supplied; both may be combined.
+	 * @SPECTATOR
+	 * @REPLAY
+	 * @param opts.focus What to look at -- the ball or a specific player.
+	 * @param opts.perspective Camera mode to switch to.
+	 * @see https://www.rocketleague.com/developer/stats-api#ChangePOV
+	 */
+	changePov(opts: Partial<{
+		focus: Commands.ChangePov.Focus;
+		perspective: Commands.ChangePov.Perspective;
+	}>): void;
+	/**
+	 * Loads and begins playback of a replay by file name or by file path.
+	 * @param opts.fileName Name of the replay file to play. Takes precedence over Path when both are set.
+	 * @param opts.path File path of a replay to play. Used when FileName is empty.
+	 * @see https://www.rocketleague.com/developer/stats-api#LoadReplay
+	 */
+	loadReplay(opts: Partial<{
+		fileName: string;
+		path: string;
+	}>): void;
+	/**
+	 * Jumps replay playback to a target frame or time.
+	 * @REPLAY
+	 * @param opts.frame Target frame number. Takes precedence over timeSeconds when set.
+	 * @param opts.timeSeconds Target time in seconds.
+	 * @see https://www.rocketleague.com/developer/stats-api#SeekReplay
+	 */
+	seekReplay(opts: Partial<{
+		frame: number;
+		timeSeconds: number;
+	}>): void;
+	/**
+	 * Sets replay playback speed.
+	 * @REPLAY
+	 * @param speed Playback multiplier. 1.0 = normal, 0.5 = half speed, 2.0 = double. Must be ≥ 0.
+	 * @see https://www.rocketleague.com/developer/stats-api#SetGameSpeed
+	 */
+	setGameSpeed(speed: number): void;
+	/**
+	 * Shows or hides the in-game HUD.
+	 * @param visible true shows the HUD; false hides it.
+	 * @see https://www.rocketleague.com/developer/stats-api#SetHUDVisibility
+	 */
+	setHudVisibility(visible: boolean): void;
+	/**
+	 * Pauses or unpauses the current match or replay.
+	 * @param paused true pauses; false resumes.
+	 * @see https://www.rocketleague.com/developer/stats-api#SetMatchPaused
+	 */
+	setMatchPaused(paused: boolean): void;
+}
+
+export {
+	Client as default,
+};
+
+export {};

package/dist/index.js

@@ -0,0 +1,2 @@
+var ConnectionError=class extends Error{},Connection=class{ws;onOpen;onMessage;onClose;onError;constructor(host,port,secure){let url=new URL(`ws://${host}`);url.port=port.toString(),url.protocol=secure?"wss:":"ws:",this.ws=new WebSocket(url),this.ws.onopen=e=>this.onOpen?.(e),this.ws.onclose=e=>this.onClose?.(e),this.ws.onmessage=e=>this.handleMessage(e)}handleMessage(e){try{let{Event:event,Data:dataStr}=JSON.parse(e.data);this.onMessage?.(event,dataStr)}catch(err){this.handleError("Failed to parse WebSocket message data",{cause:err});return}}handleError(msg,errorOptions){let err;if(typeof msg=="string")err=new ConnectionError(msg,errorOptions);else if(msg instanceof Error)msg instanceof ConnectionError?err=msg:err=new ConnectionError("Unhandled error",{cause:msg});else throw new TypeError("Error is not a string or Error instance");if(!this.onError)throw err;this.onError(err)}removeListeners(){this.onOpen=void 0,this.onMessage=void 0,this.onClose=void 0,this.onError=void 0}close(){this.ws.close()}isConnected(){return this.ws.readyState===WebSocket.OPEN}send(message){this.ws.send(JSON.stringify(message))}};var ClientError=class extends Error{},Client=class{options;socket;reconnectAttempts=0;reconnectTimeout=void 0;wasCloseCalled=!1;onSocketConnected;onSocketClosed;onError;onEvent;onUpdateState;onBallHit;onBoostPickup;onClockUpdatedSeconds;onCountdownBegin;onCrossbarHit;onGoalReplayStart;onGoalReplayWillEnd;onGoalReplayEnd;onGoalScored;onMatchCreated;onMatchInitialized;onMatchPaused;onMatchUnpaused;onMatchEnded;onMatchDestroyed;onPlayerJoined;onPlayerLeft;onPodiumStart;onReplayCreated;onRoundStarted;onStatfeedEvent;constructor(opts={}){this.options={host:opts.host??"127.0.0.1",port:opts.port??49124,secure:opts.secure??!1}}handleOpen(){this.reconnectAttempts=0,clearTimeout(this.reconnectTimeout),this.onSocketConnected?.()}handleClose(){if(this.socket?.removeListeners(),this.socket=void 0,this.onSocketClosed?.({wasCloseCalled:this.wasCloseCalled}),this.wasCloseCalled)return;this.reconnectAttempts++;let jitter=Math.random()*.8+.2,minDelay=128,maxDelay=8192,t=Math.min(2**this.reconnectAttempts,maxDelay)/maxDelay,range=maxDelay-minDelay,delay=Math.floor(minDelay+jitter*t*range);this.reconnectTimeout=setTimeout(()=>this.connect(),delay)}handleError(msg,errorOptions){let err;if(typeof msg=="string")err=new ClientError(msg,errorOptions);else if(msg instanceof Error)msg instanceof ConnectionError?err=new ClientError(`Connection error: ${msg.message}`,{cause:msg}):msg instanceof ClientError?err=msg:err=new ClientError(`Unhandled error: [${msg.name}] ${msg.message}`,{cause:msg});else throw new TypeError("Error is not a string or Error instance",{cause:msg});if(!this.onError)throw err;this.onError(err)}handleMessage(event,dataStr){let data;try{data=JSON.parse(dataStr)}catch(err){this.handleError("Failed to parse event data",{cause:err});return}if(!data||typeof data!="object"){this.handleError("Data did not parse as an object",{cause:{data}});return}switch(event!=="UpdateState"&&this.onEvent?.(event,data),event){case"UpdateState":{this.onUpdateState?.(data);break}case"ClockUpdatedSeconds":{this.onClockUpdatedSeconds?.(data);break}case"BallHit":{this.onBallHit?.(data);break}case"StatfeedEvent":{this.onStatfeedEvent?.(data);break}case"CrossbarHit":{this.onCrossbarHit?.(data);break}case"GoalScored":{this.onGoalScored?.(data);break}case"BoostPickup":{this.onBoostPickup?.(data);break}case"GoalReplayStart":{this.onGoalReplayStart?.(data);break}case"GoalReplayWillEnd":{this.onGoalReplayWillEnd?.(data);break}case"GoalReplayEnd":{this.onGoalReplayEnd?.(data);break}case"PlayerJoined":{this.onPlayerJoined?.(data);break}case"PlayerLeft":{this.onPlayerLeft?.(data);break}case"RoundStarted":{this.onRoundStarted?.(data);break}case"CountdownBegin":{this.onCountdownBegin?.(data);break}case"PodiumStart":{this.onPodiumStart?.(data);break}case"MatchCreated":{this.onMatchCreated?.(data);break}case"MatchInitialized":{this.onMatchInitialized?.(data);break}case"MatchPaused":{this.onMatchPaused?.(data);break}case"MatchUnpaused":{this.onMatchUnpaused?.(data);break}case"MatchEnded":{this.onMatchEnded?.(data);break}case"MatchDestroyed":{this.onMatchDestroyed?.(data);break}case"ReplayCreated":{this.onReplayCreated?.(data);break}default:throw new Error(`Unhandled event "${event}"`)}}sendCommand(command,data){if(!this.isConnected())throw new ClientError("Not connected");return this.socket.send({Command:command,Data:data})}connect(){this.socket||(clearTimeout(this.reconnectTimeout),this.wasCloseCalled=!1,this.socket=new Connection(this.options.host,this.options.port,this.options.secure),this.socket.onOpen=()=>this.handleOpen(),this.socket.onClose=_e=>this.handleClose(),this.socket.onError=err=>this.handleError(err),this.socket.onMessage=(event,dataStr)=>this.handleMessage(event,dataStr))}close(){clearTimeout(this.reconnectTimeout),this.wasCloseCalled=!0,this.socket?.close(),this.socket=void 0}isConnected(){return this.socket?.isConnected()??!1}changePov(opts){return this.sendCommand("ChangePOV",{Focus:opts.focus,Perspective:opts.perspective})}loadReplay(opts){return this.sendCommand("LoadReplay",{FileName:opts.fileName,Path:opts.path})}seekReplay(opts){return this.sendCommand("SeekReplay",{Frame:opts.frame,TimeSeconds:opts.timeSeconds})}setGameSpeed(speed){return this.sendCommand("SetGameSpeed",{Speed:speed})}setHudVisibility(visible){return this.sendCommand("SetHUDVisibility",{bVisible:visible})}setMatchPaused(paused){return this.sendCommand("SetMatchPaused",{bPaused:paused})}};export{ClientError,Connection,ConnectionError,Client as default};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../src/Connection.ts", "../src/Client.ts"],
+  "mappings": "AAEO,IAAM,gBAAN,cAA8B,KAAM,CAAC,EAEvB,WAArB,KAAgC,CAC/B,GACA,OACA,UACA,QACA,QACA,YAAY,KAAc,KAAc,OAAiB,CACxD,IAAM,IAAM,IAAI,IAAI,QAAQ,IAAI,EAAE,EAClC,IAAI,KAAO,KAAK,SAAS,EACzB,IAAI,SAAW,OAAS,OAAS,MACjC,KAAK,GAAK,IAAI,UAAU,GAAG,EAC3B,KAAK,GAAG,OAAS,GAAK,KAAK,SAAS,CAAC,EACrC,KAAK,GAAG,QAAU,GAAK,KAAK,UAAU,CAAC,EAEvC,KAAK,GAAG,UAAY,GAAK,KAAK,cAAc,CAAC,CAC9C,CACA,cAAc,EAAiB,CAC9B,GAAI,CACH,GAAM,CAAE,MAAO,MAAO,KAAM,OAAQ,EAAI,KAAK,MAAM,EAAE,IAAI,EACzD,KAAK,YAAY,MAAO,OAAO,CAChC,OAAQ,IAAK,CACZ,KAAK,YAAY,yCAA0C,CAAE,MAAO,GAAI,CAAC,EACzE,MACD,CACD,CAGU,YAAY,IAAqB,aAA6B,CACvE,IAAI,IACJ,GAAG,OAAO,KAAQ,SACjB,IAAM,IAAI,gBAAgB,IAAK,YAAY,UAEpC,eAAe,MACnB,eAAe,gBAIjB,IAAM,IAHN,IAAM,IAAI,gBAAgB,kBAAmB,CAAE,MAAO,GAAI,CAAC,MAO5D,OAAM,IAAI,UAAU,yCAAyC,EAE9D,GAAG,CAAC,KAAK,QACR,MAAM,IAEP,KAAK,QAAQ,GAAG,CACjB,CACA,iBAAkB,CACjB,KAAK,OAAS,OACd,KAAK,UAAY,OACjB,KAAK,QAAU,OACf,KAAK,QAAU,MAChB,CACA,OAAQ,CACP,KAAK,GAAG,MAAM,CACf,CACA,aAAuB,CACtB,OAAO,KAAK,GAAG,aAAe,UAAU,IACzC,CACA,KAAK,QAAiB,CACrB,KAAK,GAAG,KAAK,KAAK,UAAU,OAAO,CAAC,CACrC,CACD,EChEO,IAAM,YAAN,cAA0B,KAAM,CAAC,EAuBnB,OAArB,KAA4B,CAI3B,QACA,OACU,kBAAoB,EACpB,iBAAuD,OACvD,eAAiB,GAI3B,kBAIA,eAEA,QAEA,QAKA,cAKA,UAMA,cAMA,sBAKA,iBAKA,cAKA,kBAKA,oBAKA,gBAKA,aAKA,eAKA,mBAKA,cAKA,gBAKA,aAKA,iBAKA,eAKA,aAKA,cAMA,gBAKA,eAKA,gBAEA,YAAY,KAA+B,CAAC,EAAG,CAC9C,KAAK,QAAU,CACd,KAAM,KAAK,MAAQ,YACnB,KAAM,KAAK,MAAQ,MACnB,OAAQ,KAAK,QAAU,EACxB,CACD,CACU,YAAa,CACtB,KAAK,kBAAoB,EACzB,aAAa,KAAK,gBAAgB,EAClC,KAAK,oBAAoB,CAC1B,CACU,aAAc,CAIvB,GAHA,KAAK,QAAQ,gBAAgB,EAC7B,KAAK,OAAS,OACd,KAAK,iBAAiB,CAAE,eAAgB,KAAK,cAAe,CAAC,EAC1D,KAAK,eACP,OAED,KAAK,oBACL,IAAM,OAAS,KAAK,OAAO,EAAI,GAAM,GAC/B,SAAW,IACX,SAAW,KACX,EAAI,KAAK,IAAI,GAAK,KAAK,kBAAmB,QAAQ,EAAI,SACtD,MAAQ,SAAW,SACnB,MAAQ,KAAK,MAAM,SAAW,OAAS,EAAI,KAAK,EACtD,KAAK,iBAAmB,WAAW,IAAM,KAAK,QAAQ,EAAG,KAAK,CAC/D,CAGU,YAAY,IAAqB,aAA6B,CACvE,IAAI,IACJ,GAAG,OAAO,KAAQ,SACjB,IAAM,IAAI,YAAY,IAAK,YAAY,UAEhC,eAAe,MACnB,eAAe,gBACjB,IAAM,IAAI,YAAY,qBAAqB,IAAI,OAAO,GAAI,CAAE,MAAO,GAAI,CAAC,EAEjE,eAAe,YAItB,IAAM,IAHN,IAAM,IAAI,YAAY,qBAAqB,IAAI,IAAI,KAAK,IAAI,OAAO,GAAI,CAAE,MAAO,GAAI,CAAC,MAOtF,OAAM,IAAI,UAAU,0CAA2C,CAAE,MAAO,GAAI,CAAC,EAE9E,GAAG,CAAC,KAAK,QACR,MAAM,IAEP,KAAK,QAAQ,GAAG,CACjB,CACU,cAAc,MAA6B,QAAiB,CACrE,IAAI,KACJ,GAAI,CACH,KAAO,KAAK,MAAM,OAAO,CAC1B,OAAQ,IAAK,CACZ,KAAK,YAAY,6BAA8B,CAAE,MAAO,GAAI,CAAC,EAC7D,MACD,CACA,GAAG,CAAC,MAAQ,OAAO,MAAS,SAAU,CACrC,KAAK,YAAY,kCAAmC,CAAE,MAAO,CAAE,IAAK,CAAE,CAAC,EACvE,MACD,CAIA,OAHG,QAAU,eACZ,KAAK,UAAU,MAAO,IAAI,EAEpB,MAAO,CACb,IAAK,cAAe,CAAE,KAAK,gBAAgB,IAAW,EAAG,KAAO,CAChE,IAAK,sBAAuB,CAAE,KAAK,wBAAwB,IAAW,EAAG,KAAO,CAEhF,IAAK,UAAW,CAAE,KAAK,YAAY,IAAW,EAAG,KAAO,CAExD,IAAK,gBAAiB,CAAE,KAAK,kBAAkB,IAAW,EAAG,KAAO,CAEpE,IAAK,cAAe,CAAE,KAAK,gBAAgB,IAAW,EAAG,KAAO,CAChE,IAAK,aAAc,CAAE,KAAK,eAAe,IAAW,EAAG,KAAO,CAE9D,IAAK,cAAe,CAAE,KAAK,gBAAgB,IAAW,EAAG,KAAO,CAEhE,IAAK,kBAAmB,CAAE,KAAK,oBAAoB,IAAW,EAAG,KAAO,CACxE,IAAK,oBAAqB,CAAE,KAAK,sBAAsB,IAAW,EAAG,KAAO,CAC5E,IAAK,gBAAiB,CAAE,KAAK,kBAAkB,IAAW,EAAG,KAAO,CAEpE,IAAK,eAAgB,CAAE,KAAK,iBAAiB,IAAW,EAAG,KAAO,CAClE,IAAK,aAAc,CAAE,KAAK,eAAe,IAAW,EAAG,KAAO,CAE9D,IAAK,eAAgB,CAAE,KAAK,iBAAiB,IAAW,EAAG,KAAO,CAClE,IAAK,iBAAkB,CAAE,KAAK,mBAAmB,IAAW,EAAG,KAAO,CACtE,IAAK,cAAe,CAAE,KAAK,gBAAgB,IAAW,EAAG,KAAO,CAEhE,IAAK,eAAgB,CAAE,KAAK,iBAAiB,IAAW,EAAG,KAAO,CAClE,IAAK,mBAAoB,CAAE,KAAK,qBAAqB,IAAW,EAAG,KAAO,CAC1E,IAAK,cAAe,CAAE,KAAK,gBAAgB,IAAW,EAAG,KAAO,CAChE,IAAK,gBAAiB,CAAE,KAAK,kBAAkB,IAAW,EAAG,KAAO,CACpE,IAAK,aAAc,CAAE,KAAK,eAAe,IAAW,EAAG,KAAO,CAC9D,IAAK,iBAAkB,CAAE,KAAK,mBAAmB,IAAW,EAAG,KAAO,CAEtE,IAAK,gBAAiB,CAAE,KAAK,kBAAkB,IAAW,EAAG,KAAO,CAEpE,QAAW,MAAM,IAAI,MAAM,oBAAoB,KAAK,GAAG,CACxD,CACD,CACU,YAAY,QAAiB,KAAc,CACpD,GAAG,CAAC,KAAK,YAAY,EACpB,MAAM,IAAI,YAAY,eAAe,EAEtC,OAAO,KAAK,OAAO,KAAK,CACvB,QAAS,QACT,KAAM,IACP,CAAC,CACF,CAIA,SAAU,CACN,KAAK,SAGR,aAAa,KAAK,gBAAgB,EAClC,KAAK,eAAiB,GACtB,KAAK,OAAS,IAAI,WAAW,KAAK,QAAQ,KAAM,KAAK,QAAQ,KAAM,KAAK,QAAQ,MAAM,EACtF,KAAK,OAAO,OAAS,IAAM,KAAK,WAAW,EAC3C,KAAK,OAAO,QAAU,IAAM,KAAK,YAAY,EAC7C,KAAK,OAAO,QAAU,KAAO,KAAK,YAAY,GAAG,EACjD,KAAK,OAAO,UAAY,CAAC,MAAO,UAAY,KAAK,cAAc,MAAO,OAAO,EAC9E,CAIA,OAAQ,CACP,aAAa,KAAK,gBAAgB,EAClC,KAAK,eAAiB,GACtB,KAAK,QAAQ,MAAM,EACnB,KAAK,OAAS,MACf,CAIA,aAA+C,CAC9C,OAAO,KAAK,QAAQ,YAAY,GAAK,EACtC,CAYA,UAAU,KAAkG,CAC3G,OAAO,KAAK,YAAY,YAAa,CACpC,MAAO,KAAK,MACZ,YAAa,KAAK,WACnB,CAAC,CACF,CAOA,WAAW,KAAoD,CAC9D,OAAO,KAAK,YAAY,aAAc,CACrC,SAAU,KAAK,SACf,KAAM,KAAK,IACZ,CAAC,CACF,CAQA,WAAW,KAAwD,CAClE,OAAO,KAAK,YAAY,aAAc,CACrC,MAAO,KAAK,MACZ,YAAa,KAAK,WACnB,CAAC,CACF,CAOA,aAAa,MAAe,CAC3B,OAAO,KAAK,YAAY,eAAgB,CACvC,MAAO,KACR,CAAC,CACF,CAMA,iBAAiB,QAAkB,CAClC,OAAO,KAAK,YAAY,mBAAoB,CAC3C,SAAU,OACX,CAAC,CACF,CAMA,eAAe,OAAiB,CAC/B,OAAO,KAAK,YAAY,iBAAkB,CACzC,QAAS,MACV,CAAC,CACF,CACD",
+  "names": []
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@alca/rocket-league-stats-api",
+  "version": "0.1.0",
+  "description": "Connect to the Rocket League's Stats API over WebSocket",
+  "keywords": [
+    "rocket-league",
+    "stats-api",
+    "typescript",
+    "websocket"
+  ],
+  "license": "MIT",
+  "author": "Alca <jacob@alca.tv>",
+  "homepage": "https://github.com/alcadesign/rocket-league-stats-api#readme",
+  "repository": {
+	"type": "git",
+	"url": "git+https://github.com/alcadesign/rocket-league-stats-api.git"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+	".": {
+		"import": "./dist/index.js",
+		"types": "./dist/index.d.ts"
+	}
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "node scripts/build.ts && dts-bundle-generator -o dist/index.d.ts src/index.ts --no-banner --silent"
+  },
+  "devDependencies": {
+    "dts-bundle-generator": "^9.5.1",
+    "esbuild": "^0.28.2",
+    "typescript": "^6.0.3"
+  },
+  "allowScripts": {
+    "esbuild@0.28.2": true
+  },
+  "files": [
+	"dist"
+  ]
+}