nhl-api-ts 0.2.0 → 0.3.0

package/dist/types/stats.d.mts

@@ -1,17 +1,19 @@
-import type { GameType, LocalizedString, PositionCode, ShootsCatches } from '#src/types/common.mjs';
+import type { GameType, LocalizedString, OpenUnion, PositionCode, ShootsCatches } from '#src/types/common.mjs';
+import type { StatsPlayer } from '#src/types/players.mjs';
+import type { StatsTeamLogo } from '#src/types/teams.mjs';
 export interface AwardSeason {
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     gaa?: number;
     gameTypeId: GameType;
     gamesPlayed: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     losses?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     otLosses?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     savePctg?: number;
     seasonId: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     wins?: number;
     assists?: number;
     goals?: number;
@@ -24,27 +26,27 @@ export interface AwardSeason {
 export interface CareerTotalsRegularSeason {
     assists: number;
     gamesPlayed: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     gamesStarted?: number;
     goals: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     goalsAgainst?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     goalsAgainstAvg?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     losses?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     otLosses?: number;
     pim: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     savePctg?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     shotsAgainst?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     shutouts?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     timeOnIce?: string;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     wins?: number;
     gameWinningGoals?: number;
     otGoals?: number;
@@ -56,11 +58,63 @@ export interface CareerTotalsRegularSeason {
     shorthandedGoals?: number;
     shorthandedPoints?: number;
     shots?: number;
-    /** Low sample count */
     avgToi?: string;
-    /** Low sample count */
     faceoffWinningPctg?: number;
 }
+export interface ClubStats {
+    /** Season in YYYYYYYY format, as a string */
+    season: string;
+    gameType: GameType;
+    /** Empty when the team has no games of this type (e.g. missed the playoffs) */
+    skaters: ClubStatsSkater[];
+    goalies: ClubStatsGoalie[];
+}
+export interface ClubStatsSkater {
+    playerId: number;
+    headshot: string;
+    firstName: LocalizedString;
+    lastName: LocalizedString;
+    positionCode: PositionCode;
+    gamesPlayed: number;
+    goals: number;
+    assists: number;
+    points: number;
+    plusMinus: number;
+    penaltyMinutes: number;
+    powerPlayGoals: number;
+    shorthandedGoals: number;
+    gameWinningGoals: number;
+    overtimeGoals: number;
+    shots: number;
+    shootingPctg: number;
+    avgTimeOnIcePerGame: number;
+    avgShiftsPerGame: number;
+    faceoffWinPctg: number;
+}
+export interface ClubStatsGoalie {
+    playerId: number;
+    headshot: string;
+    firstName: LocalizedString;
+    lastName: LocalizedString;
+    gamesPlayed: number;
+    gamesStarted: number;
+    wins: number;
+    losses: number;
+    /** Only in seasons that had ties (before 2005-06) */
+    ties?: number;
+    goalsAgainstAverage: number;
+    savePercentage: number;
+    shotsAgainst: number;
+    saves: number;
+    goalsAgainst: number;
+    shutouts: number;
+    goals: number;
+    assists: number;
+    points: number;
+    penaltyMinutes?: number;
+    timeOnIce: number;
+    overtimeLosses?: number;
+}
 export interface ClubStatsSeason {
     season: number;
     gameTypes: GameType[];
@@ -78,17 +132,17 @@ export interface GameLogEntry {
     assists: number;
     commonName: LocalizedString;
     opponentCommonName: LocalizedString;
-    /** Absent when player=skater,gameType=2; player=skater,gameType=3; player=veteran,gameType=2; player=veteran,gameType=3. Low sample count */
+    /** Goalies only */
     gamesStarted?: number;
-    /** Absent when player=skater,gameType=2; player=skater,gameType=3; player=veteran,gameType=2; player=veteran,gameType=3. Low sample count */
+    /** Goalies only */
     decision?: string;
-    /** Absent when player=skater,gameType=2; player=skater,gameType=3; player=veteran,gameType=2; player=veteran,gameType=3. Low sample count */
+    /** Goalies only */
     shotsAgainst?: number;
-    /** Absent when player=skater,gameType=2; player=skater,gameType=3; player=veteran,gameType=2; player=veteran,gameType=3. Low sample count */
+    /** Goalies only */
     goalsAgainst?: number;
-    /** Absent when player=skater,gameType=2; player=skater,gameType=3; player=veteran,gameType=2; player=veteran,gameType=3. Low sample count */
+    /** Goalies only */
     savePctg?: number;
-    /** Absent when player=skater,gameType=2; player=skater,gameType=3; player=veteran,gameType=2; player=veteran,gameType=3. Low sample count */
+    /** Goalies only */
     shutouts?: number;
     pim: number;
     toi: string;
@@ -104,6 +158,44 @@ export interface GameLogEntry {
     shorthandedGoals?: number;
     shorthandedPoints?: number;
 }
+/** `categories` values accepted by `stats.skaterStatsLeaders`. */
+export type SkaterLeaderCategory = 'goals' | 'assists' | 'points' | 'plusMinus' | 'penaltyMins' | 'goalsPp' | 'goalsSh' | 'faceoffLeaders' | 'toi';
+/** `categories` values accepted by `stats.goalieStatsLeaders`. */
+export type GoalieLeaderCategory = 'wins' | 'shutouts' | 'savePctg' | 'goalsAgainstAverage';
+/** One row of a web stats-leaders category. */
+export interface StatsLeader {
+    id: number;
+    firstName: LocalizedString;
+    lastName: LocalizedString;
+    /** Absent for some players without a current number */
+    sweaterNumber?: number;
+    headshot: string;
+    teamAbbrev: string;
+    teamName: LocalizedString;
+    teamLogo: string;
+    position: PositionCode;
+    value: number;
+}
+/** Skater leaders keyed by category. A category is absent when `categories` leaves it out. */
+export interface SkaterStatsLeaders {
+    goals?: StatsLeader[];
+    assists?: StatsLeader[];
+    points?: StatsLeader[];
+    plusMinus?: StatsLeader[];
+    penaltyMins?: StatsLeader[];
+    goalsPp?: StatsLeader[];
+    goalsSh?: StatsLeader[];
+    faceoffLeaders?: StatsLeader[];
+    /** `value` is average time on ice per game, in seconds */
+    toi?: StatsLeader[];
+}
+/** Goalie leaders keyed by category. A category is absent when `categories` leaves it out. */
+export interface GoalieStatsLeaders {
+    wins?: StatsLeader[];
+    shutouts?: StatsLeader[];
+    savePctg?: StatsLeader[];
+    goalsAgainstAverage?: StatsLeader[];
+}
 export interface GoalieAdvancedRow {
     completeGamePct: number;
     completeGames: number;
@@ -122,11 +214,11 @@ export interface GoalieAdvancedRow {
     regulationLosses: number;
     regulationWins: number;
     savePct: number;
-    /** Absent when statsType=advanced,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shootsCatches: ShootsCatches;
     shotsAgainstPer60: number;
-    /** Absent when statsType=advanced,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
     timeOnIce: number;
 }
@@ -135,7 +227,7 @@ export interface GoalieBiosRow {
     birthCountryCode: string;
     birthDate: string;
     birthStateProvinceCode: string | null;
-    /** Absent when statsType=bios,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     currentTeamAbbrev?: string | null;
     draftOverall: number | null;
     draftRound: number | null;
@@ -175,10 +267,10 @@ export interface GoalieDaysRestRow {
     savePctDaysRest2: number;
     savePctDaysRest3: number;
     savePctDaysRest4Plus: number;
-    /** Absent when statsType=daysrest,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shootsCatches: ShootsCatches;
-    /** Absent when statsType=daysrest,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
     ties: number | null;
     wins: number;
@@ -195,11 +287,11 @@ export interface GoaliePenaltyShotsRow {
     playerId: number;
     savePct: number;
     saves: number;
-    /** Absent when statsType=penaltyShots,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shootsCatches: ShootsCatches;
     shotsAgainst: number;
-    /** Absent when statsType=penaltyShots,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
 }
 export interface GoalieSavesByStrengthRow {
@@ -221,7 +313,7 @@ export interface GoalieSavesByStrengthRow {
     ppShotsAgainst: number;
     savePct: number;
     saves: number;
-    /** Absent when statsType=savesByStrength,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shGoalsAgainst: number;
     shSavePct: number;
@@ -229,7 +321,7 @@ export interface GoalieSavesByStrengthRow {
     shShotsAgainst: number;
     shootsCatches: ShootsCatches;
     shotsAgainst: number;
-    /** Absent when statsType=savesByStrength,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
     ties: number | null;
     wins: number;
@@ -246,7 +338,7 @@ export interface GoalieShootoutRow {
     goalieFullName: string;
     lastName: string;
     playerId: number;
-    /** Absent when statsType=shootout,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shootoutGoalsAgainst: number;
     shootoutLosses: number;
@@ -255,7 +347,7 @@ export interface GoalieShootoutRow {
     shootoutShotsAgainst: number;
     shootoutWins: number;
     shootsCatches: ShootsCatches;
-    /** Absent when statsType=shootout,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
 }
 export interface GoalieStartedVsRelievedRow {
@@ -284,10 +376,10 @@ export interface GoalieStartedVsRelievedRow {
     otLosses: number;
     playerId: number;
     savePct: number;
-    /** Absent when statsType=startedVsRelieved,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shootsCatches: ShootsCatches;
-    /** Absent when statsType=startedVsRelieved,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
     ties: number | null;
     wins: number;
@@ -308,12 +400,12 @@ export interface GoalieSummaryRow {
     points: number;
     savePct: number;
     saves: number;
-    /** Absent when statsType=summary,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shootsCatches: ShootsCatches;
     shotsAgainst: number;
     shutouts: number;
-    /** Absent when statsType=summary,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
     ties: number | null;
     timeOnIce: number;
@@ -322,20 +414,20 @@ export interface GoalieSummaryRow {
 export interface PlayerLanding {
     playerId: number;
     isActive: boolean;
-    /** Absent when player=retired */
+    /** Absent for inactive players (`isActive: false`) */
     currentTeamId?: number;
-    /** Absent when player=retired */
+    /** Absent for inactive players (`isActive: false`) */
     currentTeamAbbrev?: string;
-    /** Absent when player=retired */
+    /** Absent for inactive players (`isActive: false`) */
     fullTeamName?: LocalizedString;
-    /** Absent when player=retired */
+    /** Absent for inactive players (`isActive: false`) */
     teamCommonName?: LocalizedString;
-    /** Absent when player=retired */
+    /** Absent for inactive players (`isActive: false`) */
     teamPlaceNameWithPreposition?: LocalizedString;
     firstName: LocalizedString;
     lastName: LocalizedString;
     badges: PlayerLandingBadge[];
-    /** Absent when player=retired */
+    /** Absent for inactive players (`isActive: false`) */
     teamLogo?: string;
     sweaterNumber: number;
     position: string;
@@ -347,7 +439,7 @@ export interface PlayerLanding {
     weightInKilograms: number;
     birthDate: string;
     birthCity: LocalizedString;
-    /** Absent when player=retired; player=veteran. Low sample count */
+    /** Only for players born in the USA or Canada */
     birthStateProvince?: LocalizedString;
     birthCountry: string;
     shootsCatches: ShootsCatches;
@@ -363,7 +455,7 @@ export interface PlayerLanding {
     last5Games: PlayerLandingLast5Game[];
     seasonTotals: PlayerLandingSeasonTotal[];
     awards: PlayerLandingAward[];
-    /** Absent when player=retired */
+    /** Absent for inactive players (`isActive: false`) */
     currentTeamRoster?: PlayerLandingCurrentTeamRoster[];
 }
 export interface PlayerLandingAward {
@@ -396,22 +488,22 @@ export interface PlayerLandingFeaturedStats {
     regularSeason: FeaturedRegularSeason;
 }
 export interface PlayerLandingLast5Game {
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     decision?: string;
     gameDate: string;
     gameId: number;
     gameTypeId: GameType;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     gamesStarted?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     goalsAgainst?: number;
     homeRoadFlag: string;
     opponentAbbrev: string;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     penaltyMins?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     savePctg?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     shotsAgainst?: number;
     teamAbbrev: string;
     toi: string;
@@ -428,32 +520,32 @@ export interface PlayerLandingLast5Game {
 export interface PlayerLandingSeasonTotal {
     gameTypeId: GameType;
     gamesPlayed: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     goalsAgainstAvg?: number;
     leagueAbbrev: string;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     savePctg?: number;
     season: number;
     sequence: number;
     teamName: LocalizedString;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     goalsAgainst?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     losses?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     shutouts?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     ties?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     timeOnIce?: string;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     wins?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     shotsAgainst?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     otLosses?: number;
     assists?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     gamesStarted?: number;
     goals?: number;
     teamCommonName?: LocalizedString;
@@ -474,17 +566,17 @@ export interface PlayerLandingSeasonTotal {
 }
 export interface SeasonStatLine {
     gamesPlayed: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     goalsAgainstAvg?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     losses?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     otLosses?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     savePctg?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     shutouts?: number;
-    /** Absent when player=retired; player=skater; player=veteran. Low sample count */
+    /** Goalies only */
     wins?: number;
     assists?: number;
     gameWinningGoals?: number;
@@ -506,9 +598,9 @@ export interface SkaterBiosRow {
     birthCountryCode: string;
     birthDate: string;
     birthStateProvinceCode: string | null;
-    /** Absent when reportType=bios,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     currentTeamAbbrev?: string | null;
-    /** Absent when reportType=bios,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     currentTeamName?: string | null;
     draftOverall: number | null;
     draftRound: number | null;
@@ -543,13 +635,13 @@ export interface SkaterFaceoffPercentagesRow {
     positionCode: PositionCode;
     ppFaceoffPct: number;
     ppFaceoffs: number;
-    /** Absent when reportType=faceoffpercentages,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shFaceoffPct: number;
     shFaceoffs: number;
     shootsCatches: ShootsCatches;
     skaterFullName: string;
-    /** Absent when reportType=faceoffpercentages,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
     timeOnIcePerGame: number;
     totalFaceoffs: number;
@@ -575,13 +667,13 @@ export interface SkaterFaceoffWinsRow {
     ppFaceoffs: number;
     ppFaceoffsLost: number;
     ppFaceoffsWon: number;
-    /** Absent when reportType=faceoffwins,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shFaceoffs: number;
     shFaceoffsLost: number;
     shFaceoffsWon: number;
     skaterFullName: string;
-    /** Absent when reportType=faceoffwins,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
     totalFaceoffLosses: number;
     totalFaceoffWins: number;
@@ -603,13 +695,13 @@ export interface SkaterGoalsForAgainstRow {
     powerPlayGoalFor: number;
     powerPlayGoalsAgainst: number;
     powerPlayTimeOnIcePerGame: number;
-    /** Absent when reportType=goalsForAgainst,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shortHandedGoalsAgainst: number;
     shortHandedGoalsFor: number;
     shortHandedTimeOnIcePerGame: number;
     skaterFullName: string;
-    /** Absent when reportType=goalsForAgainst,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
 }
 export interface SkaterPenaltiesRow {
@@ -634,10 +726,10 @@ export interface SkaterPenaltiesRow {
     playerId: number;
     points: number;
     positionCode: PositionCode;
-    /** Absent when reportType=penalties,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     skaterFullName: string;
-    /** Absent when reportType=penalties,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
     timeOnIcePerGame: number;
 }
@@ -647,7 +739,7 @@ export interface SkaterPenaltyKillRow {
     playerId: number;
     positionCode: PositionCode;
     ppGoalsAgainstPer60: number;
-    /** Absent when reportType=penaltykill,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shAssists: number;
     shGoals: number;
@@ -667,7 +759,7 @@ export interface SkaterPenaltyKillRow {
     shTimeOnIcePctPerGame: number;
     shTimeOnIcePerGame: number;
     skaterFullName: string;
-    /** Absent when reportType=penaltykill,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
 }
 export interface SkaterPenaltyShotsRow {
@@ -678,11 +770,11 @@ export interface SkaterPenaltyShotsRow {
     penaltyShotsGoals: number;
     playerId: number;
     positionCode: PositionCode;
-    /** Absent when reportType=penaltyShots,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shootsCatches: ShootsCatches;
     skaterFullName: string;
-    /** Absent when reportType=penaltyShots,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
 }
 export interface SkaterPercentagesRow {
@@ -696,14 +788,14 @@ export interface SkaterPercentagesRow {
     satPercentageClose: number;
     satPercentageTied: number | null;
     satRelative: number;
-    /** Absent when reportType=percentages,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shootingPct5v5: number;
     shootsCatches: ShootsCatches;
     skaterFullName: string;
     skaterSavePct5v5: number | null;
     skaterShootingPlusSavePct5v5: number | null;
-    /** Absent when reportType=percentages,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
     timeOnIcePerGame5v5: number;
     usatPercentage: number;
@@ -737,10 +829,10 @@ export interface SkaterPowerPlayRow {
     ppTimeOnIce: number;
     ppTimeOnIcePctPerGame: number;
     ppTimeOnIcePerGame: number;
-    /** Absent when reportType=powerplay,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     skaterFullName: string;
-    /** Absent when reportType=powerplay,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
 }
 export interface SkaterPuckPossessionsRow {
@@ -758,11 +850,11 @@ export interface SkaterPuckPossessionsRow {
     playerId: number;
     positionCode: PositionCode;
     satPct: number;
-    /** Absent when reportType=puckPossessions,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shootsCatches: ShootsCatches;
     skaterFullName: string;
-    /** Absent when reportType=puckPossessions,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
     timeOnIcePerGame5v5: number;
     usatPct: number;
@@ -790,14 +882,14 @@ export interface SkaterRealtimeRow {
     otGoals: number;
     playerId: number;
     positionCode: PositionCode;
-    /** Absent when reportType=realtime,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shootsCatches: ShootsCatches;
     shotAttemptsBlocked: number;
     skaterFullName: string;
     takeaways: number;
     takeawaysPer60: number;
-    /** Absent when reportType=realtime,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
     timeOnIcePerGame: number;
     totalShotAttempts: number;
@@ -820,14 +912,14 @@ export interface SkaterScoringPerGameRow {
     pointsPerGame: number;
     positionCode: PositionCode;
     primaryAssistsPerGame: number;
-    /** Absent when reportType=scoringpergame,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     secondaryAssistsPerGame: number;
     shootsCatches: ShootsCatches;
     shots: number;
     shotsPerGame: number;
     skaterFullName: string;
-    /** Absent when reportType=scoringpergame,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
     timeOnIce: number;
     timeOnIcePerGame: number;
@@ -852,13 +944,13 @@ export interface SkaterScoringRatesRow {
     primaryAssistsPer605v5: number;
     satPct: number;
     satRelative5v5: number;
-    /** Absent when reportType=scoringRates,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     secondaryAssists5v5: number;
     secondaryAssistsPer605v5: number;
     shootingPct5v5: number;
     skaterFullName: string;
-    /** Absent when reportType=scoringRates,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
     timeOnIcePerGame5v5: number;
 }
@@ -871,7 +963,7 @@ export interface SkaterShootoutRow {
     lastName: string;
     playerId: number;
     positionCode: PositionCode;
-    /** Absent when reportType=shootout,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shootoutGameDecidingGoals: number;
     shootoutGamesPlayed: number;
@@ -880,7 +972,7 @@ export interface SkaterShootoutRow {
     shootoutShots: number;
     shootsCatches: ShootsCatches;
     skaterFullName: string;
-    /** Absent when reportType=shootout,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
 }
 export interface SkaterShotTypeRow {
@@ -899,7 +991,7 @@ export interface SkaterShotTypeRow {
     goalsWrist: number;
     lastName: string;
     playerId: number;
-    /** Absent when reportType=shottype,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shootingPct: number;
     shootingPctBackhand: number | null;
@@ -925,7 +1017,7 @@ export interface SkaterShotTypeRow {
     shotsOnNetWrapAround: number;
     shotsOnNetWrist: number;
     skaterFullName: string;
-    /** Absent when reportType=shottype,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
 }
 export interface SkaterSummaryRow {
@@ -946,7 +1038,7 @@ export interface SkaterSummaryRow {
     positionCode: PositionCode;
     ppGoals: number;
     ppPoints: number;
-    /** Absent when aggregate=true; reportType=summary,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shGoals: number;
     shPoints: number;
@@ -954,7 +1046,7 @@ export interface SkaterSummaryRow {
     shootsCatches: ShootsCatches;
     shots: number;
     skaterFullName: string;
-    /** Absent when aggregate=true; reportType=summary,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
     timeOnIcePerGame: number;
 }
@@ -971,11 +1063,11 @@ export interface SkaterSummaryShootingRow {
     satRelative: number;
     satTied: number;
     satTotal: number;
-    /** Absent when reportType=summaryshooting,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shootsCatches: ShootsCatches;
     skaterFullName: string;
-    /** Absent when reportType=summaryshooting,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
     timeOnIcePerGame5v5: number;
     usatAgainst: number;
@@ -998,7 +1090,7 @@ export interface SkaterTimeOnIceRow {
     positionCode: PositionCode;
     ppTimeOnIce: number;
     ppTimeOnIcePerGame: number;
-    /** Absent when reportType=timeonice,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shTimeOnIce: number;
     shTimeOnIcePerGame: number;
@@ -1006,7 +1098,7 @@ export interface SkaterTimeOnIceRow {
     shiftsPerGame: number;
     shootsCatches: ShootsCatches;
     skaterFullName: string;
-    /** Absent when reportType=timeonice,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamAbbrevs?: string;
     timeOnIce: number;
     timeOnIcePerGame: number;
@@ -1028,22 +1120,20 @@ export interface TeamSummaryRow {
     powerPlayNetPct: number;
     powerPlayPct: number;
     regulationAndOtWins: number;
-    /** Absent when isGame=false,aggregate=true; isGame=true,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     seasonId?: number;
     shotsAgainstPerGame: number;
     shotsForPerGame: number;
-    /** Absent when isGame=false,aggregate=true; isGame=true,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamFullName?: string;
-    /** Absent when isGame=false,aggregate=true; isGame=true,aggregate=true. Low sample count */
+    /** Absent when `aggregate: true` */
     teamId?: number;
     teamShutouts: number;
     ties: number | null;
     wins: number;
     winsInRegulation: number;
     winsInShootout: number;
-    /** Low sample count */
     franchiseId?: number;
-    /** Low sample count */
     franchiseName?: string;
 }
 /**
@@ -1084,3 +1174,115 @@ export interface GoalieReportRows {
     shootout: GoalieShootoutRow;
     startedVsRelieved: GoalieStartedVsRelievedRow;
 }
+/** Team of a stats API leaders row: the `en/team` row plus its logo history. */
+export interface StatsLeaderTeam {
+    id: number;
+    franchiseId: number;
+    fullName: string;
+    leagueId: number;
+    logos: StatsTeamLogo[];
+    rawTricode: string;
+    triCode: string;
+}
+export interface SkaterPointsLeaderRow {
+    player: StatsPlayer;
+    team: StatsLeaderTeam;
+    points: number;
+}
+export interface SkaterGoalsLeaderRow {
+    player: StatsPlayer;
+    team: StatsLeaderTeam;
+    goals: number;
+}
+export interface SkaterAssistsLeaderRow {
+    player: StatsPlayer;
+    team: StatsLeaderTeam;
+    assists: number;
+}
+export interface SkaterGamesPlayedLeaderRow {
+    player: StatsPlayer;
+    team: StatsLeaderTeam;
+    gamesPlayed: number;
+}
+export interface GoalieGaaLeaderRow {
+    player: StatsPlayer;
+    team: StatsLeaderTeam;
+    /** `null` in every all-time row (no minimum games), set when filtered to a season */
+    gaa: number | null;
+}
+export interface GoalieSavePctgLeaderRow {
+    player: StatsPlayer;
+    team: StatsLeaderTeam;
+    savePctg: number;
+}
+export interface GoalieShutoutsLeaderRow {
+    player: StatsPlayer;
+    team: StatsLeaderTeam;
+    shutouts: number;
+}
+export interface GoalieTimeOnIceLeaderRow {
+    player: StatsPlayer;
+    team: StatsLeaderTeam;
+    /** Seconds */
+    timeOnIce: number;
+}
+export interface GoalieGamesPlayedLeaderRow {
+    player: StatsPlayer;
+    team: StatsLeaderTeam;
+    gamesPlayed: number;
+}
+/** Row type of `stats.skaterLeaders` for each `attribute`. */
+export interface SkaterLeaderRows {
+    points: SkaterPointsLeaderRow;
+    goals: SkaterGoalsLeaderRow;
+    assists: SkaterAssistsLeaderRow;
+    gamesPlayed: SkaterGamesPlayedLeaderRow;
+}
+/** Row type of `stats.goalieLeaders` for each `attribute`. */
+export interface GoalieLeaderRows {
+    gaa: GoalieGaaLeaderRow;
+    savePctg: GoalieSavePctgLeaderRow;
+    shutouts: GoalieShutoutsLeaderRow;
+    timeOnIce: GoalieTimeOnIceLeaderRow;
+    gamesPlayed: GoalieGamesPlayedLeaderRow;
+}
+/** A career milestone an active skater is approaching. */
+export interface SkaterMilestone {
+    id: number;
+    assists: number;
+    currentTeamId: number;
+    firstName: string;
+    gameTypeId: GameType;
+    gamesPlayed: number;
+    goals: number;
+    lastName: string;
+    milestone: OpenUnion<'Assists' | 'Games Played' | 'Goals' | 'Points'>;
+    milestoneAmount: number;
+    playerFullName: string;
+    playerId: number;
+    points: number;
+    teamAbbrev: string;
+    teamCommonName: string;
+    teamFullName: string;
+    teamPlaceName: string;
+}
+/** A career milestone an active goalie is approaching. */
+export interface GoalieMilestone {
+    id: number;
+    currentTeamId: number;
+    firstName: string;
+    gameTypeId: GameType;
+    gamesPlayed: number;
+    lastName: string;
+    milestone: OpenUnion<'Games Played' | 'Minutes Played' | 'Shutouts' | 'Wins'>;
+    milestoneAmount: number;
+    playerFullName: string;
+    playerId: number;
+    so: number;
+    teamAbbrev: string;
+    teamCommonName: string;
+    teamFullName: string;
+    teamPlaceName: string;
+    toiMinutes: number;
+    wins: number;
+}