nhl-api-ts 0.2.1 → 0.3.0

package/dist/types/stats.d.mts

@@ -1,4 +1,6 @@
-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 {
     /** Goalies only */
     gaa?: number;
@@ -59,6 +61,60 @@ export interface CareerTotalsRegularSeason {
     avgToi?: string;
     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[];
@@ -102,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;
@@ -1080,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;
+}

package/dist/types/teams.d.mts

@@ -1,4 +1,5 @@
-import type { LocalizedString, PositionCode, ShootsCatches } from '#src/types/common.mjs';
+import type { LocalizedString, OpenUnion, PositionCode, ShootsCatches } from '#src/types/common.mjs';
+import type { ScoreboardDate } from '#src/types/game-center.mjs';
 export interface Franchise {
     id: number;
     fullName: string;
@@ -27,3 +28,30 @@ export interface RosterPlayer {
     birthCountry: string;
     birthStateProvince?: LocalizedString;
 }
+/** One team of the stats API (`en/team`), past or present. */
+export interface StatsTeam {
+    id: number;
+    /** `null` for the placeholder teams (TBD, NHL) */
+    franchiseId: number | null;
+    fullName: string;
+    leagueId: number;
+    rawTricode: string;
+    triCode: string;
+}
+export interface StatsTeamLogo {
+    id: number;
+    background: OpenUnion<'light' | 'dark' | 'alt' | 'black'>;
+    endSeason: number;
+    secureUrl: string;
+    startSeason: number;
+    teamId: number;
+    url: string;
+}
+export interface TeamScoreboard {
+    focusedDate: string;
+    focusedDateCount: number;
+    clubTimeZone: string;
+    clubUTCOffset: string;
+    clubScheduleLink: string;
+    gamesByDate: ScoreboardDate[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhl-api-ts",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "TypeScript SDK and CLI for the NHL API and NHL EDGE stats.",
   "keywords": [
     "nhl",