nhl-api-ts 0.2.0 → 0.3.0

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[];
@@ -19,7 +31,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 +40,6 @@ export interface ProspectsGoalie {
     headshot: string;
     firstName: LocalizedString;
     lastName: LocalizedString;
-    /** Low sample count */
     sweaterNumber?: number;
     positionCode: PositionCode;
     shootsCatches: ShootsCatches;
@@ -40,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

@@ -35,24 +35,24 @@ export interface ClubScheduleGame {
     awayTeam: ClubScheduleGameAwayTeam;
     homeTeam: ScheduleHomeTeam;
     periodDescriptor: PeriodDescriptor;
-    /** Absent when team=BUF,week=now; team=TOR,week=now; team=UTA,week=now */
+    /** Absent before the game is played */
     gameOutcome?: GameOutcome;
-    /** Absent when team=BUF,week=now; team=TOR,week=now; team=UTA,week=now */
+    /** Absent before the game is played */
     winningGoalie?: WinningGoalie;
-    /** Absent when team=BUF,week=now; team=TOR,week=now; team=UTA,week=now */
+    /** Absent before the game is played */
     winningGoalScorer?: WinningGoalie;
-    /** Absent when team=BUF,week=now; team=TOR,week=now; team=UTA,week=now */
+    /** Absent before the game is played */
     threeMinRecap?: string;
-    /** Absent when team=BUF,week=now; team=TOR,week=now; team=UTA,week=now */
+    /** Absent before the game is played */
     condensedGame?: string;
     gameCenterLink: string;
-    /** Absent when team=BUF,week=2024-02-10; team=BUF,week=now; team=TOR,week=now; team=UTA,week=now */
+    /** Absent before the game is played */
     threeMinRecapFr?: string;
-    /** Absent when team=TOR,month=now; team=BUF,week=2024-02-10; team=BUF,week=now; team=TOR,week=now; team=UTA,week=now. Low sample count */
+    /** Absent before the game is played */
     condensedGameFr?: string;
-    /** Absent when team=BUF,week=2024-02-10 */
+    /** Only present before the game starts */
     ticketsLink?: string;
-    /** Absent when team=BUF,week=2024-02-10 */
+    /** Only present before the game starts */
     ticketsLinkFr?: string;
 }
 export interface ClubScheduleGameAwayTeam {
@@ -64,21 +64,14 @@ export interface ClubScheduleGameAwayTeam {
     logo: string;
     darkLogo: string;
     awaySplitSquad: boolean;
-    /** Absent when team=BUF,week=now; team=TOR,week=now; team=UTA,week=now */
+    /** Absent before the game is played */
     score?: number;
-    /** Absent when team=BUF,week=now */
     airlineLink?: string;
-    /** Absent when team=BUF,week=now */
     airlineDesc?: string;
-    /** Absent when team=BUF,week=now */
     hotelLink?: string;
-    /** Absent when team=BUF,week=now */
     hotelDesc?: string;
-    /** Absent when team=BUF,week=2024-02-10 */
     radioLink?: string;
-    /** Absent when team=BUF,week=2024-02-10; team=BUF,week=now; team=TOR,week=now */
     promoLink?: string;
-    /** Absent when team=BUF,week=2024-02-10; team=BUF,week=now; team=TOR,week=now */
     promoDesc?: string;
 }
 export interface ScheduleHomeTeam {
@@ -90,27 +83,19 @@ export interface ScheduleHomeTeam {
     logo: string;
     darkLogo: string;
     homeSplitSquad: boolean;
-    /** Absent when team=BUF,week=now; team=TOR,week=now; team=UTA,week=now */
+    /** Absent before the game is played */
     score?: number;
-    /** Absent when team=BUF,week=2024-02-10; team=BUF,week=now */
     hotelLink?: string;
-    /** Absent when team=BUF,week=2024-02-10; team=BUF,week=now */
     hotelDesc?: string;
-    /** Absent when team=BUF,week=2024-02-10; team=BUF,week=now; team=TOR,week=now */
     airlineLink?: string;
-    /** Absent when team=BUF,week=2024-02-10; team=BUF,week=now; team=TOR,week=now */
     airlineDesc?: string;
-    /** Absent when team=BUF,week=2024-02-10 */
     radioLink?: string;
-    /** Absent when team=BUF,week=2024-02-10; team=BUF,week=now; team=TOR,week=now */
     promoLink?: string;
-    /** Absent when team=BUF,week=2024-02-10; team=BUF,week=now; team=TOR,week=now */
     promoDesc?: string;
 }
 export interface SpecialEvent {
     parentId: number;
     name: LocalizedString;
-    /** Low sample count */
     lightLogoUrl?: LocalizedString;
 }
 export interface GameWeekDay {
@@ -197,9 +182,7 @@ export interface PlayoffSeriesSchedule {
     topSeedTeam: PlayoffSeriesTeam;
     games: PlayoffSeriesScheduleGame[];
     fullCoverageUrl: PlayoffFullCoverageUrls;
-    /** Absent when season=20232024,series=o. Low sample count */
     conferenceAbbrev?: string;
-    /** Absent when season=20232024,series=o. Low sample count */
     conferenceName?: string;
 }
 export interface PlayoffFullCoverageUrls {
@@ -242,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;
@@ -289,34 +286,33 @@ export interface ScheduleGame {
     awayTeam: WeeklyScheduleGameAwayTeam;
     homeTeam: WeeklyScheduleGameHomeTeam;
     periodDescriptor: WeeklySchedulePeriodDescriptor;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     gameOutcome?: GameOutcome;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     winningGoalie?: WinningGoalie;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     winningGoalScorer?: WinningGoalie;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     threeMinRecap?: string;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     threeMinRecapFr?: string;
     gameCenterLink: string;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     condensedGame?: string;
-    /** Absent when date=now; date=playoff; date=regular. Low sample count */
     specialEvent?: SpecialEvent;
-    /** 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=regular. Low sample count */
+    /** Playoff games only */
     seriesStatus?: SeriesStatus;
-    /** Absent when date=regular. Low sample count */
+    /** Playoff games only */
     seriesUrl?: string;
 }
 export interface TeamSeasonSchedule {
     previousSeason: number;
     currentSeason: number;
-    /** Absent when team=BUF,season=now; team=TOR,season=now; team=UTA,season=now */
+    /** Absent for the current season */
     nextSeason?: number;
     clubTimezone: string;
     clubUTCOffset: string;
@@ -341,26 +337,24 @@ export interface TeamSeasonScheduleGame {
     periodDescriptor: PeriodDescriptor;
     gameOutcome?: GameOutcome;
     winningGoalie?: WinningGoalie;
-    /** Absent when team=BUF,season=19992000 */
+    /** Absent before the game is played and for older seasons (for example, 1999-2000) */
     winningGoalScorer?: WinningGoalie;
-    /** Absent when team=BUF,season=19992000; team=BUF,season=now; team=TOR,season=now */
     specialEvent?: SpecialEvent;
     gameCenterLink: string;
-    /** Absent when team=BUF,season=19992000 */
+    /** Absent before the game is played and for older seasons (for example, 1999-2000) */
     threeMinRecap?: string;
-    /** Absent when team=BUF,season=19992000 */
+    /** Absent before the game is played and for older seasons (for example, 1999-2000) */
     condensedGame?: string;
-    /** Absent when team=BUF,season=19992000 */
+    /** Absent before the game is played and for older seasons (for example, 1999-2000) */
     threeMinRecapFr?: string;
-    /** Absent when team=BUF,season=20232024; team=BUF,season=now; team=SEA,season=20232024; team=TOR,season=now; team=UTA,season=now. Low sample count */
+    /** Playoff games only */
     seriesStatus?: SeasonScheduleSeriesStatus;
-    /** Absent when team=BUF,season=20232024; team=BUF,season=now; team=SEA,season=20232024; team=TOR,season=now; team=UTA,season=now. Low sample count */
+    /** Playoff games only */
     seriesUrl?: string;
-    /** Absent when team=SEA,season=20232024 */
     condensedGameFr?: string;
-    /** Absent when team=SEA,season=20232024 */
+    /** Only present before the game starts */
     ticketsLink?: string;
-    /** Absent when team=SEA,season=20232024 */
+    /** Only present before the game starts */
     ticketsLinkFr?: string;
 }
 export interface TeamSeasonScheduleGameAwayTeam {
@@ -373,19 +367,12 @@ export interface TeamSeasonScheduleGameAwayTeam {
     darkLogo: string;
     awaySplitSquad: boolean;
     score?: number;
-    /** Absent when team=BUF,season=19992000 */
     hotelLink?: string;
-    /** Absent when team=BUF,season=19992000 */
     hotelDesc?: string;
-    /** Absent when team=BUF,season=19992000 */
     airlineLink?: string;
-    /** Absent when team=BUF,season=19992000 */
     airlineDesc?: string;
-    /** Absent when team=SEA,season=20232024 */
     radioLink?: string;
-    /** Absent when team=SEA,season=20232024 */
     promoLink?: string;
-    /** Absent when team=SEA,season=20232024 */
     promoDesc?: string;
 }
 export interface SeasonScheduleSeriesStatus {
@@ -394,7 +381,9 @@ export interface SeasonScheduleSeriesStatus {
     seriesTitle: string;
     seriesLetter: string;
     neededToWin: number;
+    topSeedTeamAbbrev: string;
     topSeedWins: number;
+    bottomSeedTeamAbbrev: string;
     bottomSeedWins: number;
     gameNumberOfSeries: number;
 }
@@ -419,9 +408,9 @@ export interface WeeklyScheduleGameAwayTeam {
     logo: string;
     darkLogo: string;
     awaySplitSquad: boolean;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     score?: number;
-    /** Absent when date=playoff; date=regular. Low sample count */
+    /** Only present before the game starts */
     radioLink?: string;
     /** Present only while odds are published for the game. */
     odds?: TeamOdd[];
@@ -435,9 +424,9 @@ export interface WeeklyScheduleGameHomeTeam {
     logo: string;
     darkLogo: string;
     homeSplitSquad: boolean;
-    /** Absent when date=now */
+    /** Absent before the game is played */
     score?: number;
-    /** Absent when date=playoff; date=regular. Low sample count */
+    /** Only present before the game starts */
     radioLink?: string;
     /** Present only while odds are published for the game. */
     odds?: TeamOdd[];
@@ -446,7 +435,6 @@ export interface WeeklySchedulePeriodDescriptor {
     number: number;
     periodType: PeriodType;
     maxRegulationPeriods: number;
-    /** Absent when date=regular. Low sample count */
     otPeriods?: number;
 }
 export interface WinningGoalie {

package/dist/types/standings.d.mts

@@ -2,7 +2,7 @@ import type { GameType, LocalizedString } from '#src/types/common.mjs';
 export interface LeagueStandings {
     wildCardIndicator: boolean;
     standings: StandingsEntry[];
-    /** Absent when variant=season-2005; variant=season. Low sample count */
+    /** Only present for the current standings */
     standingsDateTimeUtc?: string;
 }
 export interface StandingsEntry {
@@ -87,7 +87,6 @@ export interface StandingsEntry {
     conferenceName?: string;
     divisionAbbrev?: string;
     divisionName?: string;
-    /** Low sample count */
     clinchIndicator?: string;
 }
 export interface StandingsSeason {