nhl-api-ts 0.2.1 → 0.3.0

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

@@ -108,6 +108,8 @@ export interface BoxscoreTeam {
     placeNameWithPreposition: LocalizedString;
     score?: number;
     sog?: number;
+    /** Only present while the game is live */
+    radioLink?: string;
 }
 export interface DailyScores {
     prevDate: string;
@@ -325,6 +327,8 @@ export interface GameLandingAwayTeam {
     record?: string;
     score?: number;
     sog?: number;
+    /** Only present while the game is live */
+    radioLink?: string;
 }
 export interface GameLandingMatchup {
     season: number;
@@ -370,6 +374,8 @@ export interface GameLandingSummary {
     scoring: GameLandingSummaryScoring[];
     threeStars: GameLandingSummaryThreeStar[];
     penalties: SummaryPenalty[];
+    /** Only present while the game is live */
+    iceSurface?: SummaryIceSurface;
     /** Only for games decided by a shootout */
     shootout?: SummaryShootout;
 }
@@ -432,6 +438,8 @@ export interface GameStoryAwayTeam {
     record?: string;
     score?: number;
     sog?: number;
+    /** Only present while the game is live */
+    radioLink?: string;
 }
 export interface PreGameMatchup {
     skatingLeaders: PreGameMatchupSkatingLeaders;
@@ -680,10 +688,13 @@ export interface PenaltyPlayer {
 }
 export interface PenaltyDetails {
     typeCode: string;
-    descKey: OpenUnion<'elbowing' | 'holding-obstruction' | 'high-sticking' | 'interference' | 'holding-the-stick' | 'slashing' | 'cross-checking' | 'roughing' | 'holding' | 'hooking' | 'fighting' | 'tripping'>;
+    descKey: OpenUnion<'elbowing' | 'holding-obstruction' | 'high-sticking' | 'interference' | 'holding-the-stick' | 'slashing' | 'cross-checking' | 'roughing' | 'holding' | 'hooking' | 'fighting' | 'tripping' | 'instigator' | 'instigator-misconduct'>;
     duration: number;
     committedByPlayerId: number;
-    drawnByPlayerId: number;
+    /** Absent for penalties nobody drew, e.g. misconducts */
+    drawnByPlayerId?: number;
+    /** Only when someone other than the committing player serves the penalty */
+    servedByPlayerId?: number;
     eventOwnerTeamId: number;
     xCoord?: number;
     yCoord?: number;
@@ -695,8 +706,11 @@ export interface PenaltyEntry {
     duration: number;
     committedByPlayer: PenaltyPlayer;
     teamAbbrev: LocalizedString;
-    drawnBy: PenaltyPlayer;
-    descKey: OpenUnion<'elbowing' | 'holding-obstruction' | 'high-sticking' | 'interference' | 'holding-the-stick' | 'slashing' | 'cross-checking' | 'roughing' | 'holding' | 'hooking' | 'fighting' | 'tripping'>;
+    /** Absent for penalties nobody drew, e.g. misconducts */
+    drawnBy?: PenaltyPlayer;
+    /** Name of the player serving the penalty, when not the one who committed it */
+    servedBy?: LocalizedString;
+    descKey: OpenUnion<'elbowing' | 'holding-obstruction' | 'high-sticking' | 'interference' | 'holding-the-stick' | 'slashing' | 'cross-checking' | 'roughing' | 'holding' | 'hooking' | 'fighting' | 'tripping' | 'instigator' | 'instigator-misconduct'>;
 }
 export interface PenaltyPlay {
     eventId: number;
@@ -781,8 +795,11 @@ export interface PlayByPlay {
     regPeriods: number;
     periodDescriptor?: PeriodDescriptor;
     gameOutcome?: GameOutcome;
-    /** Empty object in every sample seen. */
-    summary?: Record<string, never>;
+    summary?: PlayByPlaySummary;
+}
+export interface PlayByPlaySummary {
+    /** Only present while the game is live */
+    iceSurface?: SummaryIceSurface;
 }
 export interface PlayByPlayTeam {
     id: number;
@@ -794,6 +811,8 @@ export interface PlayByPlayTeam {
     placeName: LocalizedString;
     placeNameWithPreposition: LocalizedString;
     sog?: number;
+    /** Only present while the game is live */
+    radioLink?: string;
 }
 export interface PlayByPlayRosterSpot {
     teamId: number;
@@ -893,6 +912,8 @@ export interface RightRailSeasonSeries {
     periodDescriptor?: PeriodDescriptor;
     gameCenterLink: string;
     gameOutcome: GameOutcome;
+    /** Only present while the game is live */
+    clock?: GameClock;
 }
 export interface GameFullCoverageUrls {
     cs: string;
@@ -962,7 +983,7 @@ export interface ShiftEntry {
     duration: string | null;
     endTime: string;
     eventDescription: string | null;
-    eventNumber: number;
+    eventNumber: number | null;
     firstName: string;
     gameId: number;
     hexValue: string;
@@ -1031,7 +1052,7 @@ export interface ShotOnGoalPlay {
 export interface SeasonStatsSkater {
     playerId: number;
     teamId: number;
-    sweaterNumber: number;
+    sweaterNumber?: number;
     name: LocalizedString;
     position: string;
     gamesPlayed?: number;
@@ -1071,6 +1092,26 @@ export interface StoppagePlay {
     sortOrder: number;
     details: StoppageDetails;
 }
+/** The players on the ice right now, with their shift time on ice (`totalSOI`, seconds). */
+export interface SummaryIceSurface {
+    awayTeam: IceSurfaceTeam;
+    homeTeam: IceSurfaceTeam;
+}
+export interface IceSurfaceTeam {
+    forwards: IceSurfacePlayer[];
+    defensemen: IceSurfacePlayer[];
+    goalies: IceSurfacePlayer[];
+    /** Empty in every sample seen. */
+    penaltyBox: unknown[];
+}
+export interface IceSurfacePlayer {
+    playerId: number;
+    name: LocalizedString;
+    sweaterNumber: number;
+    positionCode: PositionCode;
+    headshot: string;
+    totalSOI: number;
+}
 export interface SummaryPenalty {
     periodDescriptor: PeriodDescriptor;
     penalties: PenaltyEntry[];
@@ -1135,3 +1176,177 @@ export interface TeamSeasonStats {
     goalsForPerGamePlayedRank: number;
     goalsAgainstPerGamePlayedRank: number;
 }
+export interface GameMeta {
+    teams: MetaTeam[];
+    seasonStates: GameMetaSeasonState;
+    gameState: GameState;
+}
+export interface GameMetaSeasonState {
+    date: string;
+    gameType: GameType;
+    season: number;
+}
+/** A team as `meta` endpoints describe it. */
+export interface MetaTeam {
+    name: LocalizedString;
+    tricode: string;
+    teamId: number;
+    teamSlug: string;
+}
+export interface PlayReplay {
+    id: number;
+    gameDate: string;
+    awayTeam: PlayReplayTeam;
+    homeTeam: PlayReplayTeam;
+    gameState: GameState;
+    gameType: GameType;
+    /** Only present when the event is a goal */
+    goal?: PlayReplayGoal;
+}
+export interface PlayReplayGoal {
+    periodDescriptor: PeriodDescriptor;
+    situationCode: string;
+    strength: string;
+    playerId: number;
+    firstName: LocalizedString;
+    lastName: LocalizedString;
+    name: LocalizedString;
+    teamAbbrev: LocalizedString;
+    headshot: string;
+    highlightClip: number;
+    logoUrl: string;
+    highlightClipSharingUrl: string;
+    goalsToDate: number;
+    sweaterNumber: number;
+    awayScore: number;
+    homeScore: number;
+    leadingTeamAbbrev: LocalizedString;
+    timeInPeriod: string;
+    shotType: ShotType;
+    goalModifier: string;
+    assists: GoalAssist[];
+    pptReplayUrl: string;
+    homeTeamDefendingSide: OpenUnion<'left' | 'right'>;
+    isHome: boolean;
+    eventId: number;
+}
+export interface PlayReplayTeam {
+    id: number;
+    name: LocalizedString;
+    abbrev: string;
+    placeName: LocalizedString;
+    placeNameWithPreposition: LocalizedString;
+    logo: string;
+    darkLogo: string;
+}
+export interface Scoreboard {
+    focusedDate: string;
+    focusedDateCount: number;
+    gamesByDate: ScoreboardDate[];
+}
+export interface ScoreboardDate {
+    date: string;
+    games: ScoreboardGame[];
+}
+export interface ScoreboardGame {
+    id: number;
+    season: number;
+    gameType: GameType;
+    gameDate: string;
+    gameCenterLink: string;
+    venue: LocalizedString;
+    startTimeUTC: string;
+    easternUTCOffset: string;
+    venueUTCOffset: string;
+    tvBroadcasts: DailyScoresTvBroadcast[];
+    gameState: GameState;
+    gameScheduleState: GameScheduleState;
+    awayTeam: ScoreboardTeam;
+    homeTeam: ScoreboardTeam;
+    /** Absent before the game starts */
+    period?: number;
+    /** Absent before the game starts */
+    periodDescriptor?: PeriodDescriptor;
+    /** Only present while the game is live */
+    clock?: GameClock;
+    /** Absent before the game is played */
+    threeMinRecap?: string;
+    /** Absent before the game is played */
+    threeMinRecapFr?: string;
+    /** Only present before the game starts */
+    ticketsLink?: string;
+    /** Only present before the game starts */
+    ticketsLinkFr?: string;
+    /** Playoff games only */
+    seriesStatus?: ScoreboardSeriesStatus;
+}
+export interface ScoreboardSeriesStatus {
+    round: number;
+    seriesAbbrev: string;
+    game: number;
+    topSeedTeamAbbrev: string;
+    topSeedWins: number;
+    bottomSeedTeamAbbrev: string;
+    bottomSeedWins: number;
+}
+export interface ScoreboardTeam {
+    id: number;
+    name: LocalizedString;
+    commonName: LocalizedString;
+    placeNameWithPreposition: LocalizedString;
+    abbrev: string;
+    /** Absent before the game starts */
+    score?: number;
+    /** Only present while the game is live */
+    sog?: number;
+    logo: string;
+    /** Only present before the game starts */
+    record?: string;
+}
+/** A play from `wsc/play-by-play`. Flat, unlike {@link Play}: event details sit on the play itself. */
+export interface WscPlay {
+    id: number;
+    eventId: number;
+    period: number;
+    timeInPeriod: string;
+    secondsRemaining: number;
+    typeCode: number;
+    typeDescKey: OpenUnion<'shot-on-goal' | 'penalty' | 'goal' | 'period-start' | 'faceoff' | 'giveaway' | 'missed-shot' | 'takeaway' | 'blocked-shot' | 'hit' | 'delayed-penalty' | 'period-end' | 'game-end'>;
+    sortOrder: number;
+    shotType?: ShotType;
+    shootingPlayerId?: number;
+    goalieInNetId?: number;
+    eventOwnerTeamId?: number;
+    awaySOG?: number;
+    homeSOG?: number;
+    penaltyTypeCode?: string;
+    descKey?: OpenUnion<'elbowing' | 'holding-obstruction' | 'high-sticking' | 'interference' | 'holding-the-stick' | 'slashing' | 'cross-checking' | 'roughing' | 'holding' | 'hooking' | 'fighting' | 'tripping'>;
+    duration?: number;
+    committedByPlayerId?: number;
+    drawnByPlayerId?: number;
+    goalModifier?: string;
+    strength?: string;
+    scoringPlayerId?: number;
+    assist1PlayerId?: number;
+    assist2PlayerId?: number;
+    awayScore?: number;
+    homeScore?: number;
+    strengthCode?: number;
+    goalCode?: number;
+    scoringPlayerTotal?: number;
+    assist1PlayerTotal?: number;
+    assist2PlayerTotal?: number;
+    situationCode?: string;
+    homeTeamDefendingSide?: OpenUnion<'left' | 'right'>;
+    utc?: string;
+    losingPlayerId?: number;
+    winningPlayerId?: number;
+    xCoord?: number;
+    yCoord?: number;
+    zoneCode?: ZoneCode;
+    playerId?: number;
+    reason?: OpenUnion<'hit-right-post' | 'wide-right' | 'blocked' | 'high-and-wide-right' | 'wide-left' | 'above-crossbar' | 'short' | 'high-and-wide-left' | 'teammate-blocked' | 'hit-crossbar' | 'hit-left-post'>;
+    blockingPlayerId?: number;
+    hittingPlayerId?: number;
+    hitteePlayerId?: number;
+}

package/dist/types/index.d.mts

@@ -1,4 +1,5 @@
 export type * from '#src/types/common.mjs';
+export type * from '#src/types/draft.mjs';
 export type * from '#src/types/edge.mjs';
 export type * from '#src/types/game-center.mjs';
 export type * from '#src/types/helpers.mjs';

package/dist/types/misc.d.mts

@@ -1,3 +1,11 @@
+import type { GameType, LocalizedString, OddsPartner, OpenUnion } from '#src/types/common.mjs';
+import type { MetaTeam } from '#src/types/game-center.mjs';
+export interface ComponentSeason {
+    id: string;
+    component: string;
+    gameTypeId: GameType;
+    seasonId: number;
+}
 export interface Country {
     id: string;
     country3Code: string;
@@ -16,6 +24,9 @@ export interface DraftYear {
     draftYear: number;
     rounds: number;
 }
+export interface GeoLocation {
+    country: string;
+}
 export interface GlossaryEntry {
     id: number;
     abbreviation: string;
@@ -25,6 +36,62 @@ export interface GlossaryEntry {
     languageCode: string;
     lastUpdated: string;
 }
+export interface Meta {
+    players: MetaPlayer[];
+    teams: MetaTeam[];
+    /** Empty in every observed response */
+    seasonStates: unknown[];
+}
+export interface MetaPlayer {
+    playerId: number;
+    playerSlug: string;
+    actionShot: string;
+    name: LocalizedString;
+    currentTeams: MetaPlayerTeam[];
+    isGoalie: boolean;
+}
+export interface MetaPlayerTeam {
+    teamId: number;
+    abbrev: string;
+    force: boolean;
+}
+export interface PartnerGameOdd {
+    description: OpenUnion<'MONEY_LINE_2_WAY' | 'MONEY_LINE_3_WAY' | 'OVER_UNDER' | 'PUCK_LINE'>;
+    value: number;
+    /** The line, e.g. "-1.5" or "O5.5"; "Draw" for the 3-way draw price; "" otherwise */
+    qualifier: string;
+}
+export interface PartnerGameOdds {
+    currentOddsDate: string;
+    lastUpdatedUTC: string;
+    bettingPartner: OddsPartner;
+    games: PartnerGameOddsGame[];
+}
+export interface PartnerGameOddsGame {
+    gameId: number;
+    gameType: GameType;
+    startTimeUTC: string;
+    homeTeam: PartnerGameOddsTeam;
+    awayTeam: PartnerGameOddsTeam;
+}
+export interface PartnerGameOddsTeam {
+    id: number;
+    name: LocalizedString;
+    abbrev: string;
+    logo: string;
+    odds: PartnerGameOdd[];
+}
+export interface PostalLookupTeam {
+    stateProvince: string;
+    teamName: LocalizedString;
+    postalCode: string;
+    country: string;
+    city: string;
+    /** Absent for Canadian postal codes */
+    networkType?: string;
+    /** Absent for Canadian postal codes */
+    county?: string;
+}
 export interface ReportColumns {
     displayItems: string[];
     resultFilters: string[];
@@ -66,3 +133,37 @@ export interface StatsConfig {
     aggregatedColumns: string[];
     individualColumns: string[];
 }
+/** One game of the stats API (`en/game`). */
+export interface StatsGame {
+    id: number;
+    easternStartTime: string;
+    gameDate: string;
+    gameNumber: number;
+    gameScheduleStateId: number;
+    gameStateId: number;
+    gameType: GameType;
+    homeScore: number;
+    homeTeamId: number;
+    period: number;
+    season: number;
+    visitingScore: number;
+    visitingTeamId: number;
+}
+export interface TvSchedule {
+    date: string;
+    startDate: string;
+    endDate: string;
+    broadcasts: TvScheduleBroadcast[];
+}
+export interface TvScheduleBroadcast {
+    startTime: string;
+    endTime: string;
+    durationSeconds: number;
+    title: string;
+    description: string;
+    houseNumber: string;
+    broadcastType: OpenUnion<'HD'>;
+    /** "LIVE" for live games, "" otherwise */
+    broadcastStatus: OpenUnion<'LIVE' | ''>;
+    broadcastImageUrl: string;
+}

package/dist/types/misc.mjs

@@ -1,2 +1 @@
-// Response types derived from live NHL API probing. See CONTRIBUTING.md.
 export {};

package/dist/types/players.d.mts

@@ -1,5 +1,17 @@
 import type { LocalizedString, PositionCode, ShootsCatches } from '#src/types/common.mjs';
 import type { RosterPlayer } from '#src/types/teams.mjs';
+export interface PlayerSpotlight {
+    playerId: number;
+    name: LocalizedString;
+    playerSlug: string;
+    position: PositionCode;
+    sweaterNumber: number;
+    teamId: number;
+    headshot: string;
+    teamTriCode: string;
+    teamLogo: string;
+    sortId: number;
+}
 export interface Prospects {
     forwards: ProspectsForward[];
     defensemen: RosterPlayer[];
@@ -39,3 +51,13 @@ export interface ProspectsGoalie {
     birthCity: LocalizedString;
     birthCountry: string;
 }
+/** One row of the stats API player search (`en/players`). */
+export interface StatsPlayer {
+    id: number;
+    currentTeamId: number | null;
+    firstName: string;
+    fullName: string;
+    lastName: string;
+    positionCode: PositionCode;
+    sweaterNumber: number | null;
+}

package/dist/types/schedule.d.mts

@@ -225,6 +225,20 @@ export interface PlayoffSeriesGameTeam {
     abbrev: string;
     score: number;
 }
+export interface PlayoffSeriesMeta {
+    seriesTitle: string;
+    teams: PlayoffSeriesMetaTeams;
+}
+export interface PlayoffSeriesMetaTeam {
+    name: LocalizedString;
+    commonName: LocalizedString;
+    tricode: string;
+    teamSlug: string;
+}
+export interface PlayoffSeriesMetaTeams {
+    topSeed: PlayoffSeriesMetaTeam;
+    bottomSeed: PlayoffSeriesMetaTeam;
+}
 export interface PlayoffSeriesStatus {
     topSeedWins: number;
     bottomSeedWins: number;
@@ -367,7 +381,9 @@ export interface SeasonScheduleSeriesStatus {
     seriesTitle: string;
     seriesLetter: string;
     neededToWin: number;
+    topSeedTeamAbbrev: string;
     topSeedWins: number;
+    bottomSeedTeamAbbrev: string;
     bottomSeedWins: number;
     gameNumberOfSeries: number;
 }