nhl-api-ts 0.2.0 → 0.2.1

package/dist/types/game-center.d.mts

@@ -4,7 +4,7 @@ export interface BoxscoreGoalie {
     sweaterNumber: number;
     name: LocalizedString;
     position: string;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games */
     starter?: boolean;
     evenStrengthShotsAgainst?: string;
     powerPlayShotsAgainst?: string;
@@ -14,7 +14,7 @@ export interface BoxscoreGoalie {
     evenStrengthGoalsAgainst?: number;
     powerPlayGoalsAgainst?: number;
     shorthandedGoalsAgainst?: number;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games */
     pim?: number;
     goalsAgainst?: number;
     toi?: string;
@@ -132,34 +132,35 @@ export interface DailyScoresGame {
     awayTeam: DailyScoresTeam;
     homeTeam: DailyScoresTeam;
     gameCenterLink: string;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     threeMinRecap?: string;
-    /** Absent when date=now; date=playoff. Low sample count */
+    /** Absent before the game is played */
     threeMinRecapFr?: string;
-    /** Absent when date=now; date=playoff; date=regular. Low sample count */
+    /** Absent before the game is played */
     condensedGame?: string;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     clock?: GameClock;
     neutralSite: boolean;
     venueTimezone: string;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     period?: number;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     periodDescriptor?: PeriodDescriptor;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     gameOutcome?: GameOutcome;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     goals?: GameGoal[];
-    /** Absent when date=playoff; date=regular. Low sample count */
+    /** Only present before the game starts */
     ticketsLink?: string;
-    /** Absent when date=playoff; date=regular. Low sample count */
+    /** Only present before the game starts */
     ticketsLinkFr?: string;
-    /** Absent when date=playoff; date=regular. Low sample count */
+    /** Only present before the game starts */
     teamLeaders?: GameTeamLeader[];
-    /** Absent when date=regular. Low sample count */
+    /** Playoff games only */
     seriesStatus?: SeriesStatus;
-    /** Absent when date=regular. Low sample count */
+    /** Playoff games only */
     seriesUrl?: string;
+    condensedGameFr?: string;
 }
 export interface DailyScoresGameWeek {
     date: string;
@@ -178,9 +179,7 @@ export interface DailyScoresTvBroadcast {
     network: string;
     sequenceNumber: number;
     logoUrls?: TeamLogo;
-    /** Absent when date=regular */
     parentId?: number;
-    /** Absent when date=regular. Low sample count */
     languageCode?: string;
 }
 export interface DelayedPenaltyDetails {
@@ -222,14 +221,14 @@ export interface DailyScoresTeam {
     id: number;
     name: LocalizedString;
     abbrev: string;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     score?: number;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     sog?: number;
     logo: string;
-    /** Absent when date=playoff; date=regular. Low sample count */
+    /** Only present before the game starts */
     record?: string;
-    /** Absent when date=playoff; date=regular. Low sample count */
+    /** Only present before the game starts */
     odds?: TeamOdd[];
 }
 export interface GameClock {
@@ -243,7 +242,6 @@ export interface GameEndPlay {
     periodDescriptor: PeriodDescriptor;
     timeInPeriod: string;
     timeRemaining: string;
-    /** Absent when game=preseason; game=shootout */
     situationCode?: OpenUnion<'0440' | '1551'>;
     homeTeamDefendingSide: OpenUnion<'right' | 'left'>;
     typeCode: number;
@@ -270,9 +268,7 @@ export interface GameGoal {
     highlightClipSharingUrlFr?: string;
     highlightClip?: number;
     highlightClipFr?: number;
-    /** Absent when date=regular. Low sample count */
     discreteClip?: number;
-    /** Absent when date=regular. Low sample count */
     discreteClipFr?: number;
     goalInGame?: number;
 }
@@ -302,16 +298,16 @@ export interface GameLanding {
     awayTeam: GameLandingAwayTeam;
     homeTeam: GameLandingAwayTeam;
     shootoutInUse: boolean;
-    /** Absent when game=playoff */
+    /** Absent for playoff games */
     maxPeriods?: number;
     regPeriods: number;
     otInUse: boolean;
     tiesInUse: boolean;
-    /** Absent when game=legacy; game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
+    /** Only present before the game starts */
     ticketsLink?: string;
-    /** Absent when game=legacy; game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
+    /** Only present before the game starts */
     ticketsLinkFr?: string;
-    /** Absent when game=legacy; game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
+    /** Only present before the game starts */
     matchup?: GameLandingMatchup;
     periodDescriptor?: PeriodDescriptor;
     summary?: GameLandingSummary;
@@ -325,7 +321,7 @@ export interface GameLandingAwayTeam {
     placeNameWithPreposition: LocalizedString;
     logo: string;
     darkLogo: string;
-    /** Absent when game=legacy; game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
+    /** Only present before the game starts */
     record?: string;
     score?: number;
     sog?: number;
@@ -357,29 +353,24 @@ export interface GameLandingScoringGoal {
     assists: GoalAssist[];
     isHome: boolean;
     situationCode?: OpenUnion<'1551' | '0651' | '1331' | '0101' | '1451'>;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games and older seasons */
     highlightClipSharingUrl?: string;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games and older seasons */
     highlightClip?: number;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games and older seasons */
     pptReplayUrl?: string;
     homeTeamDefendingSide?: OpenUnion<'left' | 'right'>;
-    /** Absent when game=playoff; game=preseason; game=shootout. Low sample count */
     goalInGame?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     discreteClip?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     discreteClipFr?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     highlightClipSharingUrlFr?: string;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     highlightClipFr?: number;
 }
 export interface GameLandingSummary {
     scoring: GameLandingSummaryScoring[];
     threeStars: GameLandingSummaryThreeStar[];
     penalties: SummaryPenalty[];
-    /** Absent when game=regular. Low sample count */
+    /** Only for games decided by a shootout */
     shootout?: SummaryShootout;
 }
 export interface GameLandingSummaryScoring {
@@ -397,9 +388,9 @@ export interface GameLandingSummaryThreeStar {
     goals?: number;
     assists?: number;
     points?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
+    /** Goalies only */
     goalsAgainstAverage?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
+    /** Goalies only */
     savePctg?: number;
 }
 export interface GameStory {
@@ -420,12 +411,12 @@ export interface GameStory {
     awayTeam: GameStoryAwayTeam;
     homeTeam: GameStoryAwayTeam;
     shootoutInUse: boolean;
-    /** Absent when game=playoff */
+    /** Absent for playoff games */
     maxPeriods?: number;
     regPeriods: number;
     otInUse: boolean;
     tiesInUse: boolean;
-    /** Absent when game=legacy; game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
+    /** Only present before the game starts */
     preGameMatchup?: PreGameMatchup;
     summary?: GameStorySummary;
     periodDescriptor?: PeriodDescriptor;
@@ -437,7 +428,7 @@ export interface GameStoryAwayTeam {
     abbrev: string;
     placeName: LocalizedString;
     logo: string;
-    /** Absent when game=legacy; game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
+    /** Only present before the game starts */
     record?: string;
     score?: number;
     sog?: number;
@@ -459,7 +450,6 @@ export interface GameStoryTvBroadcast {
     countryCode: string;
     network: string;
     sequenceNumber: number;
-    /** Absent when game=regular */
     logoUrls?: TeamLogo;
 }
 export interface GameTeamLeader {
@@ -503,37 +493,31 @@ export interface GoalAssist {
 export interface GoalDetails {
     shotType: ShotType;
     scoringPlayerId: number;
-    /** Absent when game=preseason; game=shootout */
     scoringPlayerTotal?: number;
-    /** Absent when game=preseason; game=regular; game=shootout */
+    /** Absent for unassisted goals */
     assist1PlayerId?: number;
-    /** Absent when game=preseason; game=regular; game=shootout */
+    /** Absent for unassisted goals */
     assist1PlayerTotal?: number;
-    /** Absent when game=overtime; game=playoff; game=preseason; game=regular; game=shootout */
+    /** Absent unless the goal had two assists */
     assist2PlayerId?: number;
-    /** Absent when game=overtime; game=playoff; game=preseason; game=regular; game=shootout */
+    /** Absent unless the goal had two assists */
     assist2PlayerTotal?: number;
     eventOwnerTeamId: number;
-    /** Absent when game=playoff */
+    /** Absent when the net was empty */
     goalieInNetId?: number;
     awayScore: number;
     homeScore: number;
     xCoord?: number;
     yCoord?: number;
     zoneCode?: ZoneCode;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games and older seasons */
     highlightClipSharingUrl?: string;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games and older seasons */
     highlightClip?: number;
-    /** Absent when game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
     goalInGame?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     discreteClip?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     discreteClipFr?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     highlightClipSharingUrlFr?: string;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     highlightClipFr?: number;
 }
 export interface GoalieComparisonTeam {
@@ -545,27 +529,16 @@ export interface SeasonStatsGoalie {
     teamId: number;
     sweaterNumber: number;
     name: LocalizedString;
-    /** Low sample count */
     gamesPlayed?: number;
-    /** Low sample count */
     wins?: number;
-    /** Low sample count */
     losses?: number;
-    /** Low sample count */
     otLosses?: number;
-    /** Low sample count */
     shotsAgainst?: number;
-    /** Low sample count */
     goalsAgainst?: number;
-    /** Low sample count */
     goalsAgainstAvg?: number;
-    /** Low sample count */
     savePctg?: number;
-    /** Low sample count */
     shutouts?: number;
-    /** Low sample count */
     saves?: number;
-    /** Low sample count */
     toi?: string;
 }
 export interface GoalPlay {
@@ -579,7 +552,7 @@ export interface GoalPlay {
     details: GoalDetails;
     situationCode?: OpenUnion<'1551' | '0651' | '1331' | '1010' | '0101' | '1451'>;
     homeTeamDefendingSide?: OpenUnion<'left' | 'right'>;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games and older seasons */
     pptReplayUrl?: string;
 }
 export interface HitDetails {
@@ -610,17 +583,11 @@ export interface GoalieLeader {
     sweaterNumber: number;
     headshot: string;
     positionCode: PositionCode;
-    /** Low sample count */
     gamesPlayed?: number;
-    /** Low sample count */
     seasonPoints?: number;
-    /** Low sample count */
     record?: string;
-    /** Low sample count */
     gaa?: number;
-    /** Low sample count */
     savePctg?: number;
-    /** Low sample count */
     shutouts?: number;
 }
 export interface GoalieTeamTotals {
@@ -807,7 +774,7 @@ export interface PlayByPlay {
     otInUse: boolean;
     clock: GameClock;
     displayPeriod: number;
-    /** Absent when game=playoff */
+    /** Absent for playoff games */
     maxPeriods?: number;
     plays: Play[];
     rosterSpots: PlayByPlayRosterSpot[];
@@ -862,17 +829,16 @@ export interface RightRail {
     seasonSeries: RightRailSeasonSeries[];
     seasonSeriesWins: RightRailSeasonSeriesWins;
     gameInfo: RightRailGameInfo;
-    /** Absent when game=legacy; game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
+    /** Only present before the game starts */
     teamSeasonStats?: RightRailTeamSeasonStats;
-    /** Absent when game=legacy; game=overtime; game=playoff; game=preseason; game=regular; game=shootout. Low sample count */
+    /** Only present before the game starts */
     last10Record?: RightRailLast10Record;
     linescore?: RightRailLinescore;
     shotsByPeriod?: LinescoreByPeriod[];
     teamGameStats?: SummaryTeamGameStat[];
     gameReports?: RightRailGameReports;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
+    /** Playoff games only */
     seasonSeriesFullCoverageUrl?: GameFullCoverageUrls;
-    /** Absent when game=preseason; game=shootout. Low sample count */
     gameVideo?: RightRailGameVideo;
 }
 export interface RightRailGameInfo {
@@ -889,16 +855,15 @@ export interface RightRailGameReports {
     faceoffComparison: string;
     rosters: string;
     shotSummary: string;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games */
     shiftChart?: string;
     toiAway: string;
     toiHome: string;
-    /** Absent when game=regular. Low sample count */
+    /** Only for games decided by a shootout */
     shootoutSummary?: string;
 }
 export interface RightRailGameVideo {
     threeMinRecap: number;
-    /** Low sample count */
     condensedGame?: number;
 }
 export interface RightRailLast10Record {
@@ -910,7 +875,7 @@ export interface RightRailLast10Record {
 export interface RightRailLinescore {
     byPeriod: LinescoreByPeriod[];
     totals: LinescoreTotals;
-    /** Absent when game=regular. Low sample count */
+    /** Only for games decided by a shootout */
     shootout?: LinescoreShootout;
 }
 export interface RightRailSeasonSeries {
@@ -942,7 +907,7 @@ export interface GameFullCoverageUrls {
 export interface RightRailSeasonSeriesWins {
     awayTeamWins: number;
     homeTeamWins: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
+    /** Playoff games only */
     neededToWin?: number;
 }
 export interface RightRailTeamSeasonStats {
@@ -970,20 +935,15 @@ export interface ScoringGoal {
     assists: GoalAssist[];
     isHome: boolean;
     situationCode?: OpenUnion<'1551' | '0651' | '1331' | '0101' | '1451'>;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games and older seasons */
     highlightClipSharingUrl?: string;
-    /** Absent when game=preseason; game=shootout */
+    /** Absent for preseason games and older seasons */
     highlightClip?: number;
     homeTeamDefendingSide?: OpenUnion<'left' | 'right'>;
-    /** Absent when game=playoff; game=preseason; game=shootout. Low sample count */
     goalInGame?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     discreteClip?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     discreteClipFr?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     highlightClipSharingUrlFr?: string;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
     highlightClipFr?: number;
 }
 export interface SeasonSeriesTeam {
@@ -1015,7 +975,6 @@ export interface ShiftEntry {
     teamId: number;
     teamName: string;
     typeCode: number;
-    /** Low sample count */
     eventDetails?: string | null;
 }
 export interface ShootoutCompletePlay {
@@ -1075,35 +1034,20 @@ export interface SeasonStatsSkater {
     sweaterNumber: number;
     name: LocalizedString;
     position: string;
-    /** Low sample count */
     gamesPlayed?: number;
-    /** Low sample count */
     goals?: number;
-    /** Low sample count */
     assists?: number;
-    /** Low sample count */
     points?: number;
-    /** Low sample count */
     plusMinus?: number;
-    /** Low sample count */
     pim?: number;
-    /** Low sample count */
     avgPoints?: number;
-    /** Low sample count */
     avgTimeOnIce?: string;
-    /** Low sample count */
     gameWinningGoals?: number;
-    /** Low sample count */
     shots?: number;
-    /** Low sample count */
     shootingPctg?: number;
-    /** Low sample count */
     faceoffWinningPctg?: number;
-    /** Low sample count */
     powerPlayGoals?: number;
-    /** Low sample count */
     blockedShots?: number;
-    /** Low sample count */
     hits?: number;
 }
 export interface SkatingLeadersLeader {
@@ -1113,7 +1057,6 @@ export interface SkatingLeadersLeader {
 }
 export interface StoppageDetails {
     reason: OpenUnion<'offside' | 'puck-frozen' | 'puck-in-netting' | 'goalie-stopped-after-sog' | 'puck-in-benches' | 'icing' | 'referee-or-linesman' | 'puck-in-crowd' | 'net-dislodged-offensive-skater' | 'tv-timeout' | 'hand-pass' | 'high-stick' | 'visitor-timeout' | 'objects-on-ice'>;
-    /** Absent when game=overtime; game=playoff; game=preseason; game=regular; game=shootout */
     secondaryReason?: OpenUnion<'tv-timeout' | 'visitor-timeout'>;
 }
 export interface StoppagePlay {
@@ -1156,9 +1099,9 @@ export interface SummaryThreeStar {
     goals?: number;
     assists?: number;
     points?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
+    /** Goalies only */
     goalsAgainstAverage?: number;
-    /** Absent when game=preseason; game=regular; game=shootout. Low sample count */
+    /** Goalies only */
     savePctg?: number;
 }
 export interface TakeawayDetails {

package/dist/types/players.d.mts

@@ -19,7 +19,7 @@ export interface ProspectsForward {
     birthDate: string;
     birthCity: LocalizedString;
     birthCountry: string;
-    /** Absent when team=TOR. Low sample count */
+    /** Only for players born in the USA or Canada */
     birthStateProvince?: LocalizedString;
     sweaterNumber?: number;
 }
@@ -28,7 +28,6 @@ export interface ProspectsGoalie {
     headshot: string;
     firstName: LocalizedString;
     lastName: LocalizedString;
-    /** Low sample count */
     sweaterNumber?: number;
     positionCode: PositionCode;
     shootsCatches: ShootsCatches;