Add Prettier and ESLint tooling (Refs #77)
This commit is contained in:
+59
-59
@@ -87,15 +87,15 @@ of inferring one. GUIDs stay strings.
|
||||
|
||||
## Recorded statistics
|
||||
|
||||
| Statistic | Meaning |
|
||||
| --- | --- |
|
||||
| Highest round | Highest round reported with that player present, including players who joined mid-game. |
|
||||
| Total kills, headshots, revives, downs | Sum of each player's highest reported counter in each game. Round snapshots are cumulative, so they are never added together within a game. |
|
||||
| Total rounds | Round progression during observed participation, added across games. A player observed at game start and then round 8 receives seven rounds. A player first seen at round 8 gets a highest-round record of 8, but zero total rounds; reaching round 9 then adds one. |
|
||||
| Games played | Completed games in which a stats report at round 2 or later contains the player, excluding players who left in the same round they joined. Staying through game end counts even without a round change. Legacy participation with an unknown joining round still counts. Start-only and round 1 participation do not count. |
|
||||
| Games completed | Games whose `game_end` roster contains the player. Disconnected players retain earlier stats without receiving completion credit. |
|
||||
| Best game kills | Highest kill count recorded in any one game. |
|
||||
| Highest reported score | Highest observed score balance. Spending points can lower the score, so this is not cumulative points earned. |
|
||||
| Statistic | Meaning |
|
||||
| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Highest round | Highest round reported with that player present, including players who joined mid-game. |
|
||||
| Total kills, headshots, revives, downs | Sum of each player's highest reported counter in each game. Round snapshots are cumulative, so they are never added together within a game. |
|
||||
| Total rounds | Round progression during observed participation, added across games. A player observed at game start and then round 8 receives seven rounds. A player first seen at round 8 gets a highest-round record of 8, but zero total rounds; reaching round 9 then adds one. |
|
||||
| Games played | Completed games in which a stats report at round 2 or later contains the player, excluding players who left in the same round they joined. Staying through game end counts even without a round change. Legacy participation with an unknown joining round still counts. Start-only and round 1 participation do not count. |
|
||||
| Games completed | Games whose `game_end` roster contains the player. Disconnected players retain earlier stats without receiving completion credit. |
|
||||
| Best game kills | Highest kill count recorded in any one game. |
|
||||
| Highest reported score | Highest observed score balance. Spending points can lower the score, so this is not cumulative points earned. |
|
||||
|
||||
Same-round departures retain their recorded stats, personal bests, and match
|
||||
history; only the games-played count excludes them. This also changes the game
|
||||
@@ -211,15 +211,15 @@ example above works for command-line or server-side clients. Successful response
|
||||
All parameters are optional. Names and enumerated values are case-sensitive.
|
||||
Use URL encoding for map keys and search text.
|
||||
|
||||
| Parameter | Default | Accepted values and behavior |
|
||||
| --- | --- | --- |
|
||||
| `game` | Both games | Exactly `t5` or `t6`. An empty value is invalid. |
|
||||
| `map` | All maps | Opaque `maps[].key`, at most 1024 characters. Empty means no map filter. An unknown key or a game/map mismatch returns an empty selection, not an error. |
|
||||
| `players` | All squad sizes | Exactly `1`, `2`, `3`, or `4`, matching the recorded starting player count. Unknown counts contribute only when this filter is absent. |
|
||||
| `metric` | `highestRound` | One of the metric keys below. An empty or unknown value is invalid. |
|
||||
| `q` | No search | At most 100 characters before trimming. Matches a literal substring of the current name or GUID, ignoring ASCII letter case. Surrounding whitespace is trimmed; whitespace-only input means no search. `%` and `_` are literal characters, not wildcards. |
|
||||
| `limit` | `50` | Integer from 1 to 100. |
|
||||
| `offset` | `0` | Integer from 0 to 1,000,000; counts matching entries to skip, not ranks or pages. |
|
||||
| Parameter | Default | Accepted values and behavior |
|
||||
| --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `game` | Both games | Exactly `t5` or `t6`. An empty value is invalid. |
|
||||
| `map` | All maps | Opaque `maps[].key`, at most 1024 characters. Empty means no map filter. An unknown key or a game/map mismatch returns an empty selection, not an error. |
|
||||
| `players` | All squad sizes | Exactly `1`, `2`, `3`, or `4`, matching the recorded starting player count. Unknown counts contribute only when this filter is absent. |
|
||||
| `metric` | `highestRound` | One of the metric keys below. An empty or unknown value is invalid. |
|
||||
| `q` | No search | At most 100 characters before trimming. Matches a literal substring of the current name or GUID, ignoring ASCII letter case. Surrounding whitespace is trimmed; whitespace-only input means no search. `%` and `_` are literal characters, not wildcards. |
|
||||
| `limit` | `50` | Integer from 1 to 100. |
|
||||
| `offset` | `0` | Integer from 0 to 1,000,000; counts matching entries to skip, not ranks or pages. |
|
||||
|
||||
`limit` and `offset` accept decimal digits only. Empty strings, signs, spaces,
|
||||
fractions and exponent notation are rejected rather than clamped. String
|
||||
@@ -235,40 +235,40 @@ Metric keys are `highestRound`, `kills`, `roundsSurvived`, `headshots`, `revives
|
||||
HTTP `200` returns the following top-level fields directly, with no `ok` or
|
||||
`data` wrapper:
|
||||
|
||||
| Field | Type | Meaning |
|
||||
| --- | --- | --- |
|
||||
| `entries` | Entry array | Requested page, ordered by the selected metric descending. |
|
||||
| `maps` | Map array | Available completed-match map options, filtered only by `game`, independent of `map`, `q`, metric qualification and pagination. |
|
||||
| `total` | number | Number of matching GUIDs after metric qualification and search, before pagination. |
|
||||
| `limit`, `offset` | number | Accepted pagination values. |
|
||||
| `metric` | string | Selected metric key, including the default when omitted. |
|
||||
| `summary` | object | Totals for all qualifying completed participation in the game/map scope, independent of `q`, metric qualification and pagination. |
|
||||
| Field | Type | Meaning |
|
||||
| ----------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `entries` | Entry array | Requested page, ordered by the selected metric descending. |
|
||||
| `maps` | Map array | Available completed-match map options, filtered only by `game`, independent of `map`, `q`, metric qualification and pagination. |
|
||||
| `total` | number | Number of matching GUIDs after metric qualification and search, before pagination. |
|
||||
| `limit`, `offset` | number | Accepted pagination values. |
|
||||
| `metric` | string | Selected metric key, including the default when omitted. |
|
||||
| `summary` | object | Totals for all qualifying completed participation in the game/map scope, independent of `q`, metric qualification and pagination. |
|
||||
|
||||
Each entry combines one GUID's qualifying participation across the selected
|
||||
games/maps. It contains all of these fields regardless of the selected metric:
|
||||
|
||||
| Entry field | Type | Meaning |
|
||||
| --- | --- | --- |
|
||||
| `guid` | string | Player identity. Preserve it as a string, including leading zeros. |
|
||||
| `name` | string | Latest reported name across both games, even if that report is outside the selected scope or from an unfinished match. |
|
||||
| `rank` | number | Rank within the scope after metric qualification, before search/pagination. Ties share rank and leave gaps: 1, 1, 3. |
|
||||
| `highestRound`, `kills`, `roundsSurvived`, `headshots`, `revives`, `downs`, `gamesPlayed`, `gamesCompleted`, `bestKills`, `bestScore` | number | The ten counters defined under [Recorded statistics](#recorded-statistics). |
|
||||
| `headshotRate`, `killsPerDown`, `averageKills`, `averageRounds`, `completionRate` | number or null | Ratios defined below; `null` if the denominator is zero. |
|
||||
| `lastSeen` | string | Latest player observation among the qualifying participation in this scope, not the latest global identity update. |
|
||||
| `records` | object | Personal-best evidence keyed by `highestRound`, `bestKills` and `bestScore`. |
|
||||
| Entry field | Type | Meaning |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
||||
| `guid` | string | Player identity. Preserve it as a string, including leading zeros. |
|
||||
| `name` | string | Latest reported name across both games, even if that report is outside the selected scope or from an unfinished match. |
|
||||
| `rank` | number | Rank within the scope after metric qualification, before search/pagination. Ties share rank and leave gaps: 1, 1, 3. |
|
||||
| `highestRound`, `kills`, `roundsSurvived`, `headshots`, `revives`, `downs`, `gamesPlayed`, `gamesCompleted`, `bestKills`, `bestScore` | number | The ten counters defined under [Recorded statistics](#recorded-statistics). |
|
||||
| `headshotRate`, `killsPerDown`, `averageKills`, `averageRounds`, `completionRate` | number or null | Ratios defined below; `null` if the denominator is zero. |
|
||||
| `lastSeen` | string | Latest player observation among the qualifying participation in this scope, not the latest global identity update. |
|
||||
| `records` | object | Personal-best evidence keyed by `highestRound`, `bestKills` and `bestScore`. |
|
||||
|
||||
Entries have no `game` field. Equal metric values are displayed in name order
|
||||
(ASCII case-insensitive, then exact name), then GUID order. `q` is a substring
|
||||
search, not an exact-GUID lookup; a tool looking up one GUID must check equality
|
||||
on returned `guid` values and account for pagination.
|
||||
|
||||
| Ratio | Calculation | Requirement to rank by this metric |
|
||||
| --- | --- | --- |
|
||||
| `headshotRate` | `headshots / kills` | `gamesPlayed >= 5` and `kills >= 100` |
|
||||
| `killsPerDown` | `kills / downs` | `gamesPlayed >= 5` and `downs >= 5` |
|
||||
| `averageKills` | `kills / gamesPlayed` | `gamesPlayed >= 5` |
|
||||
| `averageRounds` | `roundsSurvived / gamesPlayed` | `gamesPlayed >= 5` |
|
||||
| `completionRate` | `gamesCompleted / gamesPlayed` | `gamesPlayed >= 5` |
|
||||
| Ratio | Calculation | Requirement to rank by this metric |
|
||||
| ---------------- | ------------------------------ | ------------------------------------- |
|
||||
| `headshotRate` | `headshots / kills` | `gamesPlayed >= 5` and `kills >= 100` |
|
||||
| `killsPerDown` | `kills / downs` | `gamesPlayed >= 5` and `downs >= 5` |
|
||||
| `averageKills` | `kills / gamesPlayed` | `gamesPlayed >= 5` |
|
||||
| `averageRounds` | `roundsSurvived / gamesPlayed` | `gamesPlayed >= 5` |
|
||||
| `completionRate` | `gamesCompleted / gamesPlayed` | `gamesPlayed >= 5` |
|
||||
|
||||
These are unrounded ratios, not formatted strings. For `headshotRate` and
|
||||
`completionRate`, `0.5` means 50%. Requirements use the selected game/map scope
|
||||
@@ -283,14 +283,14 @@ engine map identifier; `name` is the display name. Pass `key` as the request's
|
||||
completed matches reaching round 2, so an option can exist without any qualifying
|
||||
players. Removed servers' maps remain available.
|
||||
|
||||
| Summary field | Type | Meaning |
|
||||
| --- | --- | --- |
|
||||
| `players` | number | Unique qualifying GUIDs, combined across games. |
|
||||
| `matches` | number | Distinct completed matches with qualifying player participation; not the sum of `gamesPlayed`. |
|
||||
| `kills`, `roundsSurvived` | number | Sums across qualifying players; rounds are player-rounds. |
|
||||
| `highestRound` | number | Highest qualifying player's recorded round. |
|
||||
| `firstTrackedAt` | string or null | Earliest match `startedAt` among those matches. |
|
||||
| `updatedAt` | string or null | Latest match report receipt time among those matches; not a response-generation time or a complete data-change token. |
|
||||
| Summary field | Type | Meaning |
|
||||
| ------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||
| `players` | number | Unique qualifying GUIDs, combined across games. |
|
||||
| `matches` | number | Distinct completed matches with qualifying player participation; not the sum of `gamesPlayed`. |
|
||||
| `kills`, `roundsSurvived` | number | Sums across qualifying players; rounds are player-rounds. |
|
||||
| `highestRound` | number | Highest qualifying player's recorded round. |
|
||||
| `firstTrackedAt` | string or null | Earliest match `startedAt` among those matches. |
|
||||
| `updatedAt` | string or null | Latest match report receipt time among those matches; not a response-generation time or a complete data-change token. |
|
||||
|
||||
For an empty scope, numeric summary fields are zero and both timestamps are
|
||||
`null`. A search with no results or an offset beyond `total` returns
|
||||
@@ -301,15 +301,15 @@ Each `records` value has the following fields. Evidence uses the same game/map
|
||||
scope as the entry, and ties choose the earliest completion, then lowest match
|
||||
ID. The three records can refer to different matches.
|
||||
|
||||
| Evidence field | Type | Meaning |
|
||||
| --- | --- | --- |
|
||||
| `matchId`, `value` | number | Completed match ID and that personal-best value. Link to `/matches/{matchId}` for its results page. |
|
||||
| `game`, `mapKey`, `mapName`, `server` | string | Recorded game, opaque map key, map display name and server name. |
|
||||
| `startedAt` | string | First recorded match observation; only the game start when `startObserved` is true. |
|
||||
| `endedAt` | string or null | Recorded completion time; can be unknown in older stored records. |
|
||||
| `startObserved` | boolean | Whether a `game_start` was received for the match. |
|
||||
| `presentAtStart` | boolean or null | Whether the player was first observed at the recorded start; `null` for unknown older participation. |
|
||||
| `firstObservedRound` | number or null | Round of the player's first observation, or unknown. This does not prove continuous survival. |
|
||||
| Evidence field | Type | Meaning |
|
||||
| ------------------------------------- | --------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `matchId`, `value` | number | Completed match ID and that personal-best value. Link to `/matches/{matchId}` for its results page. |
|
||||
| `game`, `mapKey`, `mapName`, `server` | string | Recorded game, opaque map key, map display name and server name. |
|
||||
| `startedAt` | string | First recorded match observation; only the game start when `startObserved` is true. |
|
||||
| `endedAt` | string or null | Recorded completion time; can be unknown in older stored records. |
|
||||
| `startObserved` | boolean | Whether a `game_start` was received for the match. |
|
||||
| `presentAtStart` | boolean or null | Whether the player was first observed at the recorded start; `null` for unknown older participation. |
|
||||
| `firstObservedRound` | number or null | Round of the player's first observation, or unknown. This does not prove continuous survival. |
|
||||
|
||||
Timestamps reflect controller receipt/observation times, normally ISO 8601 UTC
|
||||
strings such as `2026-10-05T12:00:00.000Z`, not reporter gameplay-clock times.
|
||||
|
||||
Reference in New Issue
Block a user