nhl-api-ts 0.1.0 → 0.2.1

package/dist/types/game-center.mjs

@@ -0,0 +1 @@
+export {};

package/dist/types/helpers.d.mts

@@ -0,0 +1,17 @@
+import type { SkaterSummaryRow } from '#src/types/stats.mjs';
+import type { RosterPlayer } from '#src/types/teams.mjs';
+/**
+ * A rostered player as returned by `helpers.allPlayers`: the roster entry with
+ * a `team` abbreviation and the localized names flattened to plain strings.
+ */
+export interface AllPlayersEntry extends Omit<RosterPlayer, 'firstName' | 'lastName'> {
+    team: string;
+    firstName: string;
+    lastName: string;
+}
+/**
+ * A skater summary row from `helpers.allPlayersSummaryStatistics`, merged with
+ * the roster fields from `allPlayers` when the skater is on a roster.
+ */
+export interface PlayerSummaryStatistics extends SkaterSummaryRow, Partial<Omit<AllPlayersEntry, keyof SkaterSummaryRow>> {
+}

package/dist/types/helpers.mjs

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.mts

@@ -0,0 +1,10 @@
+export type * from '#src/types/common.mjs';
+export type * from '#src/types/edge.mjs';
+export type * from '#src/types/game-center.mjs';
+export type * from '#src/types/helpers.mjs';
+export type * from '#src/types/misc.mjs';
+export type * from '#src/types/players.mjs';
+export type * from '#src/types/schedule.mjs';
+export type * from '#src/types/standings.mjs';
+export type * from '#src/types/stats.mjs';
+export type * from '#src/types/teams.mjs';

package/dist/types/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/types/misc.d.mts

@@ -0,0 +1,68 @@
+export interface Country {
+    id: string;
+    country3Code: string;
+    countryCode: string;
+    countryName: string;
+    hasPlayerStats: number;
+    imageUrl: string | null;
+    iocCode: string;
+    isActive: number;
+    nationalityName: string;
+    olympicUrl: string | null;
+    thumbnailUrl: string | null;
+}
+export interface DraftYear {
+    id: number;
+    draftYear: number;
+    rounds: number;
+}
+export interface GlossaryEntry {
+    id: number;
+    abbreviation: string;
+    definition: string;
+    firstSeasonForStat: number | null;
+    fullName: string;
+    languageCode: string;
+    lastUpdated: string;
+}
+export interface ReportColumns {
+    displayItems: string[];
+    resultFilters: string[];
+    sortKeys: string[];
+}
+export interface ReportConfig {
+    game: ReportColumns;
+    season: ReportColumns;
+}
+export interface SeasonRules {
+    id: number;
+    allStarGameInUse: number;
+    conferencesInUse: number;
+    divisionsInUse: number;
+    endDate: string;
+    entryDraftInUse: number;
+    formattedSeasonId: string;
+    minimumPlayoffMinutesForGoalieStatsLeaders: number;
+    minimumRegularGamesForGoalieStatsLeaders: number;
+    nhlStanleyCupOwner: number;
+    numberOfGames: number;
+    olympicsParticipation: number;
+    pointForOTLossInUse: number;
+    preseasonStartdate: string | null;
+    regularSeasonEndDate: string;
+    rowInUse: number;
+    seasonOrdinal: number;
+    startDate: string;
+    supplementalDraftInUse: number;
+    tiesInUse: number;
+    totalPlayoffGames: number;
+    totalRegularSeasonGames: number;
+    wildcardInUse: number;
+}
+export interface StatsConfig {
+    playerReportData: Record<string, ReportConfig>;
+    goalieReportData: Record<string, ReportConfig>;
+    teamReportData: Record<string, ReportConfig>;
+    aggregatedColumns: string[];
+    individualColumns: string[];
+}

package/dist/types/misc.mjs

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

package/dist/types/players.d.mts

@@ -0,0 +1,41 @@
+import type { LocalizedString, PositionCode, ShootsCatches } from '#src/types/common.mjs';
+import type { RosterPlayer } from '#src/types/teams.mjs';
+export interface Prospects {
+    forwards: ProspectsForward[];
+    defensemen: RosterPlayer[];
+    goalies: ProspectsGoalie[];
+}
+export interface ProspectsForward {
+    id: number;
+    headshot: string;
+    firstName: LocalizedString;
+    lastName: LocalizedString;
+    positionCode: PositionCode;
+    shootsCatches: ShootsCatches;
+    heightInInches: number;
+    weightInPounds: number;
+    heightInCentimeters: number;
+    weightInKilograms: number;
+    birthDate: string;
+    birthCity: LocalizedString;
+    birthCountry: string;
+    /** Only for players born in the USA or Canada */
+    birthStateProvince?: LocalizedString;
+    sweaterNumber?: number;
+}
+export interface ProspectsGoalie {
+    id: number;
+    headshot: string;
+    firstName: LocalizedString;
+    lastName: LocalizedString;
+    sweaterNumber?: number;
+    positionCode: PositionCode;
+    shootsCatches: ShootsCatches;
+    heightInInches: number;
+    weightInPounds: number;
+    heightInCentimeters: number;
+    weightInKilograms: number;
+    birthDate: string;
+    birthCity: LocalizedString;
+    birthCountry: string;
+}

package/dist/types/players.mjs

@@ -0,0 +1 @@
+export {};

package/dist/types/schedule.d.mts

@@ -0,0 +1,428 @@
+import type { GameOutcome, GameScheduleState, GameState, GameType, LocalizedString, OddsPartner, PeriodDescriptor, PeriodType, SeriesStatus, TeamLogo, TeamOdd, TvBroadcast } from '#src/types/common.mjs';
+export interface CalendarSchedule {
+    endDate: string;
+    nextStartDate: string;
+    previousStartDate: string;
+    startDate: string;
+    teams: CalendarScheduleTeam[];
+}
+export interface CalendarScheduleTeam {
+    id: number;
+    seasonId: number;
+    commonName: LocalizedString;
+    abbrev: string;
+    name: LocalizedString;
+    placeNameWithPreposition: LocalizedString;
+    placeName: LocalizedString;
+    logo: string;
+    darkLogo: string;
+    french: boolean;
+}
+export interface ClubScheduleGame {
+    id: number;
+    season: number;
+    gameType: GameType;
+    gameDate: string;
+    venue: LocalizedString;
+    neutralSite: boolean;
+    startTimeUTC: string;
+    easternUTCOffset: string;
+    venueUTCOffset: string;
+    venueTimezone: string;
+    gameState: GameState;
+    gameScheduleState: GameScheduleState;
+    tvBroadcasts: TvBroadcast[];
+    awayTeam: ClubScheduleGameAwayTeam;
+    homeTeam: ScheduleHomeTeam;
+    periodDescriptor: PeriodDescriptor;
+    /** Absent before the game is played */
+    gameOutcome?: GameOutcome;
+    /** Absent before the game is played */
+    winningGoalie?: WinningGoalie;
+    /** Absent before the game is played */
+    winningGoalScorer?: WinningGoalie;
+    /** Absent before the game is played */
+    threeMinRecap?: string;
+    /** Absent before the game is played */
+    condensedGame?: string;
+    gameCenterLink: string;
+    /** Absent before the game is played */
+    threeMinRecapFr?: string;
+    /** Absent before the game is played */
+    condensedGameFr?: string;
+    /** Only present before the game starts */
+    ticketsLink?: string;
+    /** Only present before the game starts */
+    ticketsLinkFr?: string;
+}
+export interface ClubScheduleGameAwayTeam {
+    id: number;
+    commonName: LocalizedString;
+    placeName: LocalizedString;
+    placeNameWithPreposition: LocalizedString;
+    abbrev: string;
+    logo: string;
+    darkLogo: string;
+    awaySplitSquad: boolean;
+    /** Absent before the game is played */
+    score?: number;
+    airlineLink?: string;
+    airlineDesc?: string;
+    hotelLink?: string;
+    hotelDesc?: string;
+    radioLink?: string;
+    promoLink?: string;
+    promoDesc?: string;
+}
+export interface ScheduleHomeTeam {
+    id: number;
+    commonName: LocalizedString;
+    placeName: LocalizedString;
+    placeNameWithPreposition: LocalizedString;
+    abbrev: string;
+    logo: string;
+    darkLogo: string;
+    homeSplitSquad: boolean;
+    /** Absent before the game is played */
+    score?: number;
+    hotelLink?: string;
+    hotelDesc?: string;
+    airlineLink?: string;
+    airlineDesc?: string;
+    radioLink?: string;
+    promoLink?: string;
+    promoDesc?: string;
+}
+export interface SpecialEvent {
+    parentId: number;
+    name: LocalizedString;
+    lightLogoUrl?: LocalizedString;
+}
+export interface GameWeekDay {
+    date: string;
+    dayAbbrev: string;
+    numberOfGames: number;
+    datePromo: unknown[];
+    games: ScheduleGame[];
+}
+export interface PlayoffBracket {
+    bracketLogo: string;
+    bracketLogoFr: string;
+    series: PlayoffBracketSeries[];
+}
+export interface PlayoffBracketSeries {
+    seriesUrl: string;
+    seriesTitle: string;
+    seriesAbbrev: string;
+    seriesLetter: string;
+    playoffRound: number;
+    topSeedRank: number;
+    topSeedRankAbbrev: string;
+    topSeedWins: number;
+    bottomSeedRank: number;
+    bottomSeedRankAbbrev: string;
+    bottomSeedWins: number;
+    winningTeamId: number;
+    losingTeamId: number;
+    topSeedTeam: PlayoffBracketTeam;
+    bottomSeedTeam: PlayoffBracketTeam;
+    conferenceAbbrev?: string;
+    conferenceName?: string;
+    seriesLogo?: string;
+    seriesLogoFr?: string;
+}
+export interface PlayoffBracketTeam {
+    id: number;
+    abbrev: string;
+    name: LocalizedString;
+    commonName: LocalizedString;
+    placeNameWithPreposition: LocalizedString;
+    logo: string;
+    darkLogo: string;
+}
+export interface PlayoffCarousel {
+    seasonId: number;
+    currentRound: number;
+    rounds: PlayoffCarouselRound[];
+}
+export interface PlayoffCarouselRound {
+    roundNumber: number;
+    roundLabel: string;
+    roundAbbrev: string;
+    series: PlayoffCarouselSeries[];
+}
+export interface PlayoffCarouselSeed {
+    id: number;
+    abbrev: string;
+    wins: number;
+    logo: string;
+    darkLogo: string;
+}
+export interface PlayoffCarouselSeries {
+    seriesLetter: string;
+    roundNumber: number;
+    seriesLabel: string;
+    seriesLink: string;
+    bottomSeed: PlayoffCarouselSeed;
+    topSeed: PlayoffCarouselSeed;
+    neededToWin: number;
+    winningTeamId: number;
+    losingTeamId: number;
+}
+export interface PlayoffSeriesSchedule {
+    round: number;
+    roundAbbrev: string;
+    roundLabel: string;
+    seriesLetter: string;
+    seriesLogo: string;
+    seriesLogoFr: string;
+    neededToWin: number;
+    length: number;
+    bottomSeedTeam: PlayoffSeriesTeam;
+    topSeedTeam: PlayoffSeriesTeam;
+    games: PlayoffSeriesScheduleGame[];
+    fullCoverageUrl: PlayoffFullCoverageUrls;
+    conferenceAbbrev?: string;
+    conferenceName?: string;
+}
+export interface PlayoffFullCoverageUrls {
+    cs: string;
+    de: string;
+    sv: string;
+    fi: string;
+    sk: string;
+    en: string;
+    fr: string;
+    es: string;
+}
+export interface PlayoffSeriesScheduleGame {
+    id: number;
+    season: number;
+    gameType: GameType;
+    gameNumber: number;
+    ifNecessary: boolean;
+    venue: LocalizedString;
+    neutralSite: boolean;
+    startTimeUTC: string;
+    easternUTCOffset: string;
+    venueUTCOffset: string;
+    venueTimezone: string;
+    gameState: GameState;
+    gameScheduleState: GameScheduleState;
+    tvBroadcasts: PlayoffTvBroadcast[];
+    awayTeam: PlayoffSeriesGameTeam;
+    homeTeam: PlayoffSeriesGameTeam;
+    gameCenterLink: string;
+    periodDescriptor: PeriodDescriptor;
+    seriesStatus: PlayoffSeriesStatus;
+    gameOutcome: GameOutcome;
+}
+export interface PlayoffSeriesGameTeam {
+    id: number;
+    commonName: LocalizedString;
+    placeName: LocalizedString;
+    placeNameWithPreposition: LocalizedString;
+    abbrev: string;
+    score: number;
+}
+export interface PlayoffSeriesStatus {
+    topSeedWins: number;
+    bottomSeedWins: number;
+}
+export interface PlayoffTvBroadcast {
+    id: number;
+    market: string;
+    countryCode: string;
+    network: string;
+    sequenceNumber: number;
+    languageCode: string;
+    logoUrls?: TeamLogo;
+}
+export interface PlayoffSeriesTeam {
+    id: number;
+    name: LocalizedString;
+    abbrev: string;
+    placeName: LocalizedString;
+    placeNameWithPreposition: LocalizedString;
+    conference: PlayoffTeamConference;
+    record: string;
+    seriesWins: number;
+    divisionAbbrev: string;
+    seed: number;
+    logo: string;
+    darkLogo: string;
+}
+export interface PlayoffTeamConference {
+    name: string;
+    abbrev: string;
+}
+export interface ScheduleGame {
+    id: number;
+    season: number;
+    gameType: GameType;
+    venue: LocalizedString;
+    neutralSite: boolean;
+    startTimeUTC: string;
+    easternUTCOffset: string;
+    venueUTCOffset: string;
+    venueTimezone: string;
+    gameState: GameState;
+    gameScheduleState: GameScheduleState;
+    tvBroadcasts: TvBroadcast[];
+    awayTeam: WeeklyScheduleGameAwayTeam;
+    homeTeam: WeeklyScheduleGameHomeTeam;
+    periodDescriptor: WeeklySchedulePeriodDescriptor;
+    /** Absent before the game is played */
+    gameOutcome?: GameOutcome;
+    /** Absent before the game is played */
+    winningGoalie?: WinningGoalie;
+    /** Absent before the game is played */
+    winningGoalScorer?: WinningGoalie;
+    /** Absent before the game is played */
+    threeMinRecap?: string;
+    /** Absent before the game is played */
+    threeMinRecapFr?: string;
+    gameCenterLink: string;
+    /** Absent before the game is played */
+    condensedGame?: string;
+    specialEvent?: SpecialEvent;
+    /** Only present before the game starts */
+    ticketsLink?: string;
+    /** Only present before the game starts */
+    ticketsLinkFr?: string;
+    /** Playoff games only */
+    seriesStatus?: SeriesStatus;
+    /** Playoff games only */
+    seriesUrl?: string;
+}
+export interface TeamSeasonSchedule {
+    previousSeason: number;
+    currentSeason: number;
+    /** Absent for the current season */
+    nextSeason?: number;
+    clubTimezone: string;
+    clubUTCOffset: string;
+    games: TeamSeasonScheduleGame[];
+}
+export interface TeamSeasonScheduleGame {
+    id: number;
+    season: number;
+    gameType: GameType;
+    gameDate: string;
+    venue: LocalizedString;
+    neutralSite: boolean;
+    startTimeUTC: string;
+    easternUTCOffset: string;
+    venueUTCOffset: string;
+    venueTimezone: string;
+    gameState: GameState;
+    gameScheduleState: GameScheduleState;
+    tvBroadcasts: TvBroadcast[];
+    awayTeam: TeamSeasonScheduleGameAwayTeam;
+    homeTeam: ScheduleHomeTeam;
+    periodDescriptor: PeriodDescriptor;
+    gameOutcome?: GameOutcome;
+    winningGoalie?: WinningGoalie;
+    /** Absent before the game is played and for older seasons (for example, 1999-2000) */
+    winningGoalScorer?: WinningGoalie;
+    specialEvent?: SpecialEvent;
+    gameCenterLink: string;
+    /** Absent before the game is played and for older seasons (for example, 1999-2000) */
+    threeMinRecap?: string;
+    /** Absent before the game is played and for older seasons (for example, 1999-2000) */
+    condensedGame?: string;
+    /** Absent before the game is played and for older seasons (for example, 1999-2000) */
+    threeMinRecapFr?: string;
+    /** Playoff games only */
+    seriesStatus?: SeasonScheduleSeriesStatus;
+    /** Playoff games only */
+    seriesUrl?: string;
+    condensedGameFr?: string;
+    /** Only present before the game starts */
+    ticketsLink?: string;
+    /** Only present before the game starts */
+    ticketsLinkFr?: string;
+}
+export interface TeamSeasonScheduleGameAwayTeam {
+    id: number;
+    commonName: LocalizedString;
+    placeName: LocalizedString;
+    placeNameWithPreposition: LocalizedString;
+    abbrev: string;
+    logo: string;
+    darkLogo: string;
+    awaySplitSquad: boolean;
+    score?: number;
+    hotelLink?: string;
+    hotelDesc?: string;
+    airlineLink?: string;
+    airlineDesc?: string;
+    radioLink?: string;
+    promoLink?: string;
+    promoDesc?: string;
+}
+export interface SeasonScheduleSeriesStatus {
+    round: number;
+    seriesAbbrev: string;
+    seriesTitle: string;
+    seriesLetter: string;
+    neededToWin: number;
+    topSeedWins: number;
+    bottomSeedWins: number;
+    gameNumberOfSeries: number;
+}
+export interface WeeklySchedule {
+    nextStartDate: string;
+    previousStartDate: string;
+    gameWeek: GameWeekDay[];
+    preSeasonStartDate: string;
+    regularSeasonStartDate: string;
+    regularSeasonEndDate: string;
+    playoffEndDate: string;
+    numberOfGames: number;
+    /** Present only while odds are published. */
+    oddsPartners?: OddsPartner[];
+}
+export interface WeeklyScheduleGameAwayTeam {
+    id: number;
+    commonName: LocalizedString;
+    placeName: LocalizedString;
+    placeNameWithPreposition: LocalizedString;
+    abbrev: string;
+    logo: string;
+    darkLogo: string;
+    awaySplitSquad: boolean;
+    /** Absent before the game is played */
+    score?: number;
+    /** Only present before the game starts */
+    radioLink?: string;
+    /** Present only while odds are published for the game. */
+    odds?: TeamOdd[];
+}
+export interface WeeklyScheduleGameHomeTeam {
+    id: number;
+    commonName: LocalizedString;
+    placeName: LocalizedString;
+    placeNameWithPreposition: LocalizedString;
+    abbrev: string;
+    logo: string;
+    darkLogo: string;
+    homeSplitSquad: boolean;
+    /** Absent before the game is played */
+    score?: number;
+    /** Only present before the game starts */
+    radioLink?: string;
+    /** Present only while odds are published for the game. */
+    odds?: TeamOdd[];
+}
+export interface WeeklySchedulePeriodDescriptor {
+    number: number;
+    periodType: PeriodType;
+    maxRegulationPeriods: number;
+    otPeriods?: number;
+}
+export interface WinningGoalie {
+    playerId: number;
+    firstInitial: LocalizedString;
+    lastName: LocalizedString;
+}

package/dist/types/schedule.mjs

@@ -0,0 +1 @@
+export {};

package/dist/types/standings.d.mts

@@ -0,0 +1,103 @@
+import type { GameType, LocalizedString } from '#src/types/common.mjs';
+export interface LeagueStandings {
+    wildCardIndicator: boolean;
+    standings: StandingsEntry[];
+    /** Only present for the current standings */
+    standingsDateTimeUtc?: string;
+}
+export interface StandingsEntry {
+    conferenceHomeSequence: number;
+    conferenceL10Sequence: number;
+    conferenceRoadSequence: number;
+    conferenceSequence: number;
+    date: string;
+    divisionHomeSequence: number;
+    divisionL10Sequence: number;
+    divisionRoadSequence: number;
+    divisionSequence: number;
+    gameTypeId: GameType;
+    gamesPlayed: number;
+    goalDifferential: number;
+    goalDifferentialPctg: number;
+    goalAgainst: number;
+    goalFor: number;
+    goalsForPctg: number;
+    homeGamesPlayed: number;
+    homeGoalDifferential: number;
+    homeGoalsAgainst: number;
+    homeGoalsFor: number;
+    homeLosses: number;
+    homeOtLosses: number;
+    homePoints: number;
+    homeRegulationPlusOtWins: number;
+    homeRegulationWins: number;
+    homeTies: number;
+    homeWins: number;
+    l10GamesPlayed: number;
+    l10GoalDifferential: number;
+    l10GoalsAgainst: number;
+    l10GoalsFor: number;
+    l10Losses: number;
+    l10OtLosses: number;
+    l10Points: number;
+    l10RegulationPlusOtWins: number;
+    l10RegulationWins: number;
+    l10Ties: number;
+    l10Wins: number;
+    leagueHomeSequence: number;
+    leagueL10Sequence: number;
+    leagueRoadSequence: number;
+    leagueSequence: number;
+    losses: number;
+    otLosses: number;
+    placeName: LocalizedString;
+    pointPctg: number;
+    points: number;
+    regulationPlusOtWinPctg: number;
+    regulationPlusOtWins: number;
+    regulationWinPctg: number;
+    regulationWins: number;
+    roadGamesPlayed: number;
+    roadGoalDifferential: number;
+    roadGoalsAgainst: number;
+    roadGoalsFor: number;
+    roadLosses: number;
+    roadOtLosses: number;
+    roadPoints: number;
+    roadRegulationPlusOtWins: number;
+    roadRegulationWins: number;
+    roadTies: number;
+    roadWins: number;
+    seasonId: number;
+    shootoutLosses: number;
+    shootoutWins: number;
+    streakCode: string;
+    streakCount: number;
+    teamName: LocalizedString;
+    teamCommonName: LocalizedString;
+    teamAbbrev: LocalizedString;
+    teamLogo: string;
+    teamLogoDark: string;
+    ties: number;
+    waiversSequence: number;
+    wildcardSequence: number;
+    winPctg: number;
+    wins: number;
+    conferenceAbbrev?: string;
+    conferenceName?: string;
+    divisionAbbrev?: string;
+    divisionName?: string;
+    clinchIndicator?: string;
+}
+export interface StandingsSeason {
+    id: number;
+    conferencesInUse: boolean;
+    divisionsInUse: boolean;
+    pointForOTlossInUse: boolean;
+    regulationWinsInUse: boolean;
+    rowInUse: boolean;
+    standingsEnd: string;
+    standingsStart: string;
+    tiesInUse: boolean;
+    wildcardInUse: boolean;
+}

package/dist/types/standings.mjs

@@ -0,0 +1 @@
+export {};