nhl-api-ts 0.1.0 → 0.2.0

package/dist/api/query/sorting/sorting-options.d.mts

@@ -2,6 +2,130 @@ export interface SortExpr {
     property: string;
     direction: 'ASC' | 'DESC' | 'ASC_CI' | 'DESC_CI' | (string & {});
 }
+declare const defaultSortingByReport: {
+    summary: SortExpr[];
+    bios: ({
+        property: string;
+        direction: "ASC_CI";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    faceoffpercentages: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    faceoffwins: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    goalsForAgainst: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    realtime: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    penalties: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    penaltykill: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    penaltyShots: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    powerplay: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    puckPossessions: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    summaryshooting: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    percentages: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    scoringRates: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    scoringpergame: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    shootout: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    shottype: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    timeonice: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+};
+/** Skater report types that have a default sort configured. */
+export type SkaterReportType = keyof typeof defaultSortingByReport;
 /** Skater report types that have a default sort configured. */
 export declare const SKATER_REPORT_TYPES: string[];
 /**
@@ -9,3 +133,4 @@ export declare const SKATER_REPORT_TYPES: string[];
  * summary sort for unknown report types.
  */
 export declare function defaultSortForReport(report: string): SortExpr[];
+export {};

package/dist/api/query/sorting/sorting-options.mjs

@@ -80,6 +80,7 @@ const defaultSortingByReport = {
         { property: 'playerId', direction: 'ASC' },
     ],
 };
+const sortingLookup = defaultSortingByReport;
 /** Skater report types that have a default sort configured. */
 export const SKATER_REPORT_TYPES = Object.keys(defaultSortingByReport);
 /**
@@ -87,7 +88,7 @@ export const SKATER_REPORT_TYPES = Object.keys(defaultSortingByReport);
  * summary sort for unknown report types.
  */
 export function defaultSortForReport(report) {
-    return ((Object.hasOwn(defaultSortingByReport, report)
-        ? defaultSortingByReport[report]
+    return ((Object.hasOwn(sortingLookup, report)
+        ? sortingLookup[report]
         : undefined) ?? skaterSummaryDefaultSorting);
 }

package/dist/api/schedule.d.mts

@@ -1,5 +1,6 @@
 import type { Context } from '#src/context.mjs';
-import type { Id, JsonObject } from '#src/utils.mjs';
+import type { CalendarSchedule, ClubScheduleGame, OddsPartner, PlayoffBracket, PlayoffCarousel, PlayoffSeriesSchedule, ScheduleGame, TeamSeasonSchedule, WeeklySchedule } from '#src/types/index.mjs';
+import type { Id } from '#src/utils.mjs';
 /**
  * Parses and normalizes a YYYY-MM-DD date: single-digit months/days are
  * accepted ("2024-10-9" -> "2024-10-09") and impossible dates are rejected.
@@ -9,8 +10,8 @@ export interface DailySchedule {
     nextStartDate: string | null;
     previousStartDate: string | null;
     date: string;
-    oddsPartners: JsonObject[] | null;
-    games?: JsonObject[];
+    oddsPartners: OddsPartner[] | null;
+    games?: ScheduleGame[];
     numberOfGames?: number;
 }
 /**
@@ -31,7 +32,7 @@ export declare const dailySchedule: (ctx: Context, { date }?: {
  */
 export declare const weeklySchedule: (ctx: Context, { date }?: {
     date?: string;
-}) => Promise<JsonObject>;
+}) => Promise<WeeklySchedule>;
 /**
  * Gets monthly schedule for a specified team.
  *
@@ -42,7 +43,7 @@ export declare const weeklySchedule: (ctx: Context, { date }?: {
 export declare const teamMonthlySchedule: (ctx: Context, { teamAbbr, month }: {
     teamAbbr: string;
     month?: string;
-}) => Promise<JsonObject[]>;
+}) => Promise<ClubScheduleGame[]>;
 /**
  * Gets weekly schedule for a specified team.
  *
@@ -53,7 +54,7 @@ export declare const teamMonthlySchedule: (ctx: Context, { teamAbbr, month }: {
 export declare const teamWeeklySchedule: (ctx: Context, { teamAbbr, date }: {
     teamAbbr: string;
     date?: string;
-}) => Promise<JsonObject[]>;
+}) => Promise<ClubScheduleGame[]>;
 /**
  * Gets the full season schedule for a specified team.
  *
@@ -64,7 +65,7 @@ export declare const teamWeeklySchedule: (ctx: Context, { teamAbbr, date }: {
 export declare const teamSeasonSchedule: (ctx: Context, { teamAbbr, season }: {
     teamAbbr: string;
     season: Id;
-}) => Promise<JsonObject>;
+}) => Promise<TeamSeasonSchedule>;
 /**
  * Gets the schedule in calendar format for a specified date.
  *
@@ -73,7 +74,7 @@ export declare const teamSeasonSchedule: (ctx: Context, { teamAbbr, season }: {
  */
 export declare const calendarSchedule: (ctx: Context, { date }: {
     date: string;
-}) => Promise<JsonObject>;
+}) => Promise<CalendarSchedule>;
 /**
  * Gets all playoff series information up to the current round.
  *
@@ -82,7 +83,7 @@ export declare const calendarSchedule: (ctx: Context, { date }: {
  */
 export declare const playoffCarousel: (ctx: Context, { season }: {
     season: Id;
-}) => Promise<JsonObject>;
+}) => Promise<PlayoffCarousel>;
 /**
  * Returns the schedule and results for a specified playoff series matchup.
  *
@@ -93,7 +94,7 @@ export declare const playoffCarousel: (ctx: Context, { season }: {
 export declare const playoffSeriesSchedule: (ctx: Context, { season, series }: {
     season: Id;
     series: string;
-}) => Promise<JsonObject>;
+}) => Promise<PlayoffSeriesSchedule>;
 /**
  * Returns the full playoff bracket for a given year.
  *
@@ -102,7 +103,7 @@ export declare const playoffSeriesSchedule: (ctx: Context, { season, series }: {
  */
 export declare const playoffBracket: (ctx: Context, { year }: {
     year: Id;
-}) => Promise<JsonObject>;
+}) => Promise<PlayoffBracket>;
 export declare const scheduleApi: {
     readonly dailySchedule: typeof dailySchedule;
     readonly weeklySchedule: typeof weeklySchedule;

package/dist/api/standings.d.mts

@@ -1,5 +1,6 @@
 import type { Context } from '#src/context.mjs';
-import type { Id, JsonObject } from '#src/utils.mjs';
+import type { LeagueStandings, StandingsSeason } from '#src/types/index.mjs';
+import type { Id } from '#src/utils.mjs';
 /**
  * Gets NHL league standings for a specific date or season.
  *
@@ -14,14 +15,14 @@ import type { Id, JsonObject } from '#src/utils.mjs';
 export declare const leagueStandings: (ctx: Context, { date, season }?: {
     date?: string;
     season?: Id;
-}) => Promise<JsonObject>;
+}) => Promise<LeagueStandings>;
 /**
  * Gets metadata for every historical NHL season: start/end dates and which
  * standings rules (conferences, divisions, wildcard, ties...) were in use.
  *
  * @example https://api-web.nhle.com/v1/standings-season
  */
-export declare const seasonStandingManifest: (ctx: Context) => Promise<JsonObject[]>;
+export declare const seasonStandingManifest: (ctx: Context) => Promise<StandingsSeason[]>;
 export declare const standingsApi: {
     readonly leagueStandings: typeof leagueStandings;
     readonly seasonStandingManifest: typeof seasonStandingManifest;

package/dist/api/stats.d.mts

@@ -1,7 +1,8 @@
-import type { QueryContext } from '#src/api/query/builder.mjs';
+import { type QueryContext } from '#src/api/query/builder.mjs';
 import { type SortExpr } from '#src/api/query/sorting/sorting-options.mjs';
 import type { Context } from '#src/context.mjs';
-import type { Id, JsonObject } from '#src/utils.mjs';
+import type { ClubStatsSeason, GameLogEntry, GoalieReportRows, PlayerLanding, SkaterReportRows, StatsApiPage, TeamSummaryRow } from '#src/types/index.mjs';
+import type { Id } from '#src/utils.mjs';
 export interface TeamSummaryParams {
     /** Start season in YYYYYYYY format, e.g. 20202021 */
     startSeason: Id;
@@ -13,7 +14,7 @@ export interface TeamSummaryParams {
     isGame?: boolean;
     /** Aggregate stats across the selected seasons. Defaults to false. */
     isAggregate?: boolean;
-    /** Custom sort. Defaults to points DESC, wins DESC, teamId ASC. */
+    /** Custom sort. Defaults to points DESC, wins DESC, teamId ASC (franchiseId ASC when aggregating). */
     sortExpr?: SortExpr[];
     /** Pagination offset. Defaults to 0. */
     start?: number;
@@ -40,7 +41,7 @@ export interface SkaterStatsSummaryParams {
     factCayenneExp?: string;
     defaultCayenneExp?: string;
 }
-export interface SkaterStatsWithQueryContextParams {
+export interface SkaterStatsWithQueryContextParams<Report extends keyof SkaterReportRows = keyof SkaterReportRows> {
     /** Built with `buildQuery(filters)`. */
     queryContext: QueryContext;
     /**
@@ -49,14 +50,14 @@ export interface SkaterStatsWithQueryContextParams {
      * powerplay, puckPossessions, summaryshooting, percentages, scoringRates,
      * scoringpergame, shootout, shottype, timeonice
      */
-    reportType: string;
+    reportType: Report;
     /** Custom sort. Defaults to the report type's default sort. */
     sortExpr?: SortExpr[];
     aggregate?: boolean;
     start?: number;
     limit?: number;
 }
-export interface GoalieStatsSummaryParams {
+export interface GoalieStatsSummaryParams<Report extends keyof GoalieReportRows = keyof GoalieReportRows> {
     startSeason: Id;
     /** Defaults to `startSeason`. */
     endSeason?: Id;
@@ -64,7 +65,7 @@ export interface GoalieStatsSummaryParams {
      * Report type: summary (default), advanced, bios, daysrest, penaltyShots,
      * savesByStrength, shootout, startedVsRelieved
      */
-    statsType?: string;
+    statsType?: Report;
     gameTypeId?: number;
     franchiseId?: Id;
     aggregate?: boolean;
@@ -82,7 +83,7 @@ export interface GoalieStatsSummaryParams {
  */
 export declare const gametypesPerSeasonDirectoryByTeam: (ctx: Context, { teamAbbr }: {
     teamAbbr: string;
-}) => Promise<JsonObject[]>;
+}) => Promise<ClubStatsSeason[]>;
 /**
  * Gets a player's career statistics and biographical information.
  *
@@ -91,7 +92,7 @@ export declare const gametypesPerSeasonDirectoryByTeam: (ctx: Context, { teamAbb
  */
 export declare const playerCareerStats: (ctx: Context, { playerId }: {
     playerId: Id;
-}) => Promise<JsonObject>;
+}) => Promise<PlayerLanding>;
 /**
  * Gets a player's game log for a specific season and game type.
  *
@@ -104,24 +105,28 @@ export declare const playerGameLog: (ctx: Context, { playerId, seasonId, gameTyp
     playerId: Id;
     seasonId: Id;
     gameType: number;
-}) => Promise<JsonObject[]>;
+}) => Promise<GameLogEntry[]>;
 /**
  * Retrieves team summary statistics across one or more seasons.
  *
  * @example await client.stats.teamSummary({ startSeason: '20232024', endSeason: '20232024' })
  */
-export declare const teamSummary: (ctx: Context, { startSeason, endSeason, gameTypeId, isGame, isAggregate, sortExpr, start, limit, factCayenneExp, defaultCayenneExp, }: TeamSummaryParams) => Promise<JsonObject[]>;
+export declare const teamSummary: (ctx: Context, { startSeason, endSeason, gameTypeId, isGame, isAggregate, sortExpr, start, limit, factCayenneExp, defaultCayenneExp, }: TeamSummaryParams) => Promise<TeamSummaryRow[]>;
 /**
  * Gets simplified skater statistics summary for specified seasons and
  * franchises.
  *
  * @example await client.stats.skaterStatsSummary({ startSeason: '20232024', endSeason: '20232024', franchiseId: 10 })
  */
-export declare const skaterStatsSummary: (ctx: Context, { startSeason, endSeason, franchiseId, gameTypeId, aggregate, sortExpr, start, limit, factCayenneExp, defaultCayenneExp, }: SkaterStatsSummaryParams) => Promise<JsonObject[]>;
+export declare const skaterStatsSummary: (ctx: Context, { startSeason, endSeason, franchiseId, gameTypeId, aggregate, sortExpr, start, limit, factCayenneExp, defaultCayenneExp, }: SkaterStatsSummaryParams) => Promise<SkaterReportRows['summary'][]>;
 /**
  * Retrieves skater statistics using a query context and specified report
  * type. Returns the full response (`{ data, total }`).
  *
+ * The default fact filter (`gamesPlayed>=1`) is dropped for the `shootout` and
+ * `penaltyShots` reports, which have no `gamesPlayed` column. A fact filter
+ * you pass to `buildQuery` is sent as given.
+ *
  * @example
  * const context = buildQuery([
  *   filter.season('20232024', '20232024'),
@@ -129,14 +134,14 @@ export declare const skaterStatsSummary: (ctx: Context, { startSeason, endSeason
  * ]);
  * await client.stats.skaterStatsWithQueryContext({ queryContext: context, reportType: 'summary' });
  */
-export declare const skaterStatsWithQueryContext: (ctx: Context, { queryContext, reportType, sortExpr, aggregate, start, limit, }: SkaterStatsWithQueryContextParams) => Promise<JsonObject>;
+export declare const skaterStatsWithQueryContext: <Report extends keyof SkaterReportRows>(ctx: Context, { queryContext, reportType, sortExpr, aggregate, start, limit, }: SkaterStatsWithQueryContextParams<Report>) => Promise<StatsApiPage<SkaterReportRows[Report]>>;
 /**
  * Retrieves goalie statistics with various filtering and aggregation
  * options.
  *
  * @example await client.stats.goalieStatsSummary({ startSeason: '20232024', statsType: 'advanced' })
  */
-export declare const goalieStatsSummary: (ctx: Context, { startSeason, endSeason, statsType, gameTypeId, franchiseId, aggregate, sortExpr, start, limit, factCayenneExp, defaultCayenneExp, }: GoalieStatsSummaryParams) => Promise<JsonObject[]>;
+export declare const goalieStatsSummary: <Report extends keyof GoalieReportRows = 'summary'>(ctx: Context, { startSeason, endSeason, statsType, gameTypeId, franchiseId, aggregate, sortExpr, start, limit, factCayenneExp, defaultCayenneExp, }: GoalieStatsSummaryParams<Report>) => Promise<GoalieReportRows[Report][]>;
 export declare const statsApi: {
     readonly gametypesPerSeasonDirectoryByTeam: typeof gametypesPerSeasonDirectoryByTeam;
     readonly playerCareerStats: typeof playerCareerStats;

package/dist/api/stats.mjs

@@ -1,6 +1,12 @@
+import { DEFAULT_FACT_QUERY, } from '#src/api/query/builder.mjs';
 import { goalieStatsSorts } from '#src/api/query/sorting/goalie-sorts.mjs';
 import { defaultSortForReport, } from '#src/api/query/sorting/sorting-options.mjs';
 import { Endpoint } from '#src/http-client.mjs';
+/** Skater reports whose rows have no `gamesPlayed`, so the API rejects the default fact filter. */
+const REPORTS_WITHOUT_GAMES_PLAYED = [
+    'shootout',
+    'penaltyShots',
+];
 /**
  * Gets all game types played by a team throughout their history.
  *
@@ -38,7 +44,11 @@ export const teamSummary = async (ctx, { startSeason, endSeason, gameTypeId = 2,
         : [
             { property: 'points', direction: 'DESC' },
             { property: 'wins', direction: 'DESC' },
-            { property: 'teamId', direction: 'ASC' },
+            // aggregated rows span seasons, so they have no teamId
+            {
+                property: isAggregate ? 'franchiseId' : 'teamId',
+                direction: 'ASC',
+            },
         ];
     const effectiveCayenneExp = defaultCayenneExp ??
         `gameTypeId=${gameTypeId} and seasonId<=${endSeason} and seasonId>=${startSeason}`;
@@ -89,6 +99,10 @@ export const skaterStatsSummary = async (ctx, { startSeason, endSeason, franchis
  * Retrieves skater statistics using a query context and specified report
  * type. Returns the full response (`{ data, total }`).
  *
+ * The default fact filter (`gamesPlayed>=1`) is dropped for the `shootout` and
+ * `penaltyShots` reports, which have no `gamesPlayed` column. A fact filter
+ * you pass to `buildQuery` is sent as given.
+ *
  * @example
  * const context = buildQuery([
  *   filter.season('20232024', '20232024'),
@@ -105,7 +119,10 @@ export const skaterStatsWithQueryContext = async (ctx, { queryContext, reportTyp
         isGame: false,
         start,
         limit,
-        factCayenneExp: queryContext.factQuery,
+        factCayenneExp: queryContext.factQuery === DEFAULT_FACT_QUERY &&
+            REPORTS_WITHOUT_GAMES_PLAYED.includes(reportType)
+            ? ''
+            : queryContext.factQuery,
         sort: JSON.stringify(effectiveSortExpr),
         cayenneExp: queryContext.query,
     };
@@ -117,9 +134,10 @@ export const skaterStatsWithQueryContext = async (ctx, { queryContext, reportTyp
  *
  * @example await client.stats.goalieStatsSummary({ startSeason: '20232024', statsType: 'advanced' })
  */
-export const goalieStatsSummary = async (ctx, { startSeason, endSeason, statsType = 'summary', gameTypeId = 2, franchiseId, aggregate = false, sortExpr, start = 0, limit = 25, factCayenneExp, defaultCayenneExp, }) => {
+export const goalieStatsSummary = async (ctx, { startSeason, endSeason, statsType, gameTypeId = 2, franchiseId, aggregate = false, sortExpr, start = 0, limit = 25, factCayenneExp, defaultCayenneExp, }) => {
+    const report = statsType ?? 'summary';
     const effectiveEndSeason = endSeason === undefined || endSeason === null ? startSeason : endSeason;
-    const effectiveSortExpr = sortExpr && sortExpr.length > 0 ? sortExpr : goalieStatsSorts(statsType);
+    const effectiveSortExpr = sortExpr && sortExpr.length > 0 ? sortExpr : goalieStatsSorts(report);
     const baseCayenneExp = defaultCayenneExp ??
         `gameTypeId=${gameTypeId} and seasonId<=${effectiveEndSeason} and seasonId>=${startSeason}`;
     const effectiveCayenneExp = franchiseId
@@ -134,7 +152,7 @@ export const goalieStatsSummary = async (ctx, { startSeason, endSeason, statsTyp
         sort: JSON.stringify(effectiveSortExpr),
         cayenneExp: effectiveCayenneExp,
     };
-    const response = await (await ctx.get(Endpoint.API_STATS, `en/goalie/${statsType}`, qParams)).json();
+    const response = await (await ctx.get(Endpoint.API_STATS, `en/goalie/${report}`, qParams)).json();
     return response.data ?? [];
 };
 export const statsApi = {

package/dist/api/teams.d.mts

@@ -1,5 +1,6 @@
 import type { Context } from '#src/context.mjs';
-import type { Id, JsonObject } from '#src/utils.mjs';
+import type { Franchise, Roster, StandingsEntry } from '#src/types/index.mjs';
+import type { Id } from '#src/utils.mjs';
 export interface Team {
     conference: {
         abbr: string;
@@ -16,12 +17,12 @@ export interface Team {
     franchise_id?: number;
 }
 /** Converts a raw standings entry into a `Team`. */
-export declare function toTeam(teamData: JsonObject): Team;
+export declare function toTeam(teamData: Partial<StandingsEntry>): Team;
 /**
  * Adds a `franchise_id` to each team that has a matching franchise. Teams
  * without a match are returned unchanged (no `franchise_id` key).
  */
-export declare function withFranchiseIds(teams: readonly Team[], franchises: readonly JsonObject[]): Team[];
+export declare function withFranchiseIds(teams: readonly Team[], franchises: readonly Pick<Franchise, 'id' | 'fullName'>[]): Team[];
 /**
  * Get a list of all NHL teams with conference, division, and franchise info.
  *
@@ -44,13 +45,13 @@ export declare const teams: (ctx: Context, { date }?: {
 export declare const teamRoster: (ctx: Context, { teamAbbr, season }: {
     teamAbbr: string;
     season: Id;
-}) => Promise<JsonObject>;
+}) => Promise<Roster>;
 /**
  * Get a list of all past and current NHL franchises.
  *
  * @example https://api.nhle.com/stats/rest/en/franchise
  */
-export declare const franchises: (ctx: Context) => Promise<JsonObject[]>;
+export declare const franchises: (ctx: Context) => Promise<Franchise[]>;
 export declare const teamsApi: {
     readonly teams: typeof teams;
     readonly teamRoster: typeof teamRoster;

package/dist/index.d.mts

@@ -18,4 +18,5 @@ export type { Context, Get } from '#src/context.mjs';
 export * from '#src/errors.mjs';
 export { buildUrl, createGet, Endpoint, type QueryParams, type QueryParamValue, } from '#src/http-client.mjs';
 export { createNHLClient, type NHLClient } from '#src/nhl-client.mjs';
-export type { Id, JsonObject } from '#src/utils.mjs';
+export type * from '#src/types/index.mjs';
+export type { Id } from '#src/utils.mjs';

package/dist/nhl-client.d.mts

@@ -1,8 +1,20 @@
+import { type GoalieStatsSummaryParams, type SkaterStatsWithQueryContextParams, statsApi } from '#src/api/stats.mjs';
 import { type ClientOptions } from '#src/config.mjs';
 import type { Context } from '#src/context.mjs';
+import type { GoalieReportRows, SkaterReportRows, StatsApiPage } from '#src/types/index.mjs';
 type Bound<Module> = {
     [Method in keyof Module]: Module[Method] extends (ctx: Context, ...args: infer Args) => infer MethodResponse ? (...args: Args) => MethodResponse : never;
 };
+/**
+ * `Bound` erases generic parameters, so the report-typed stats methods are
+ * spelled out here (without `ctx`) to keep `reportType` / `statsType`
+ * flowing into the row type.
+ */
+interface StatsGenericMethods {
+    skaterStatsWithQueryContext<Report extends keyof SkaterReportRows>(params: SkaterStatsWithQueryContextParams<Report>): Promise<StatsApiPage<SkaterReportRows[Report]>>;
+    goalieStatsSummary<Report extends keyof GoalieReportRows = 'summary'>(params: GoalieStatsSummaryParams<Report>): Promise<GoalieReportRows[Report][]>;
+}
+type StatsClient = Omit<Bound<typeof statsApi>, 'skaterStatsWithQueryContext' | 'goalieStatsSummary'> & StatsGenericMethods;
 /**
  * Builds the main client used to access the NHL API.
  *
@@ -42,15 +54,7 @@ export declare const createNHLClient: (options?: ClientOptions) => {
         readonly seasonSeriesMatchup: typeof import("#src/api/game-center.mjs").seasonSeriesMatchup;
         readonly gameStory: typeof import("#src/api/game-center.mjs").gameStory;
     }>;
-    readonly stats: Bound<{
-        readonly gametypesPerSeasonDirectoryByTeam: typeof import("#src/api/stats.mjs").gametypesPerSeasonDirectoryByTeam;
-        readonly playerCareerStats: typeof import("#src/api/stats.mjs").playerCareerStats;
-        readonly playerGameLog: typeof import("#src/api/stats.mjs").playerGameLog;
-        readonly teamSummary: typeof import("#src/api/stats.mjs").teamSummary;
-        readonly skaterStatsSummary: typeof import("#src/api/stats.mjs").skaterStatsSummary;
-        readonly skaterStatsWithQueryContext: typeof import("#src/api/stats.mjs").skaterStatsWithQueryContext;
-        readonly goalieStatsSummary: typeof import("#src/api/stats.mjs").goalieStatsSummary;
-    }>;
+    readonly stats: StatsClient;
     readonly misc: Bound<{
         readonly glossary: typeof import("#src/api/misc.mjs").glossary;
         readonly config: typeof import("#src/api/misc.mjs").config;

package/dist/nhl-client.mjs

@@ -5,7 +5,7 @@ import { miscApi } from '#src/api/misc.mjs';
 import { playersApi } from '#src/api/players.mjs';
 import { scheduleApi } from '#src/api/schedule.mjs';
 import { standingsApi } from '#src/api/standings.mjs';
-import { statsApi } from '#src/api/stats.mjs';
+import { statsApi, } from '#src/api/stats.mjs';
 import { teamsApi } from '#src/api/teams.mjs';
 import { resolveConfig } from '#src/config.mjs';
 import { createGet } from '#src/http-client.mjs';

package/dist/types/common.d.mts

@@ -0,0 +1,81 @@
+/**
+ * A string union that still accepts values the SDK doesn't know about yet.
+ * Autocomplete lists `Known`, but a new value from the NHL doesn't break
+ * consumers.
+ */
+export type OpenUnion<Known extends string> = Known | (string & {});
+/** A name or label with optional translations; `default` is always present. */
+export interface LocalizedString {
+    default: string;
+    cs?: string;
+    de?: string;
+    es?: string;
+    fi?: string;
+    fr?: string;
+    sk?: string;
+    sv?: string;
+}
+/** 1 = preseason, 2 = regular season, 3 = playoffs. Other codes (4 = all-star) exist. */
+export type GameType = 1 | 2 | 3 | (number & {});
+/** Season in YYYYYYYY form, e.g. 20232024. */
+export type SeasonId = number;
+export type GameState = OpenUnion<'FUT' | 'PRE' | 'LIVE' | 'CRIT' | 'FINAL' | 'OFF'>;
+export type GameScheduleState = OpenUnion<'OK' | 'PPD' | 'SUSP' | 'CNCL' | 'TBD'>;
+export type PeriodType = OpenUnion<'REG' | 'OT' | 'SO'>;
+export type PositionCode = OpenUnion<'C' | 'L' | 'R' | 'D' | 'G'>;
+export type ShootsCatches = OpenUnion<'L' | 'R'>;
+export type ZoneCode = OpenUnion<'O' | 'N' | 'D'>;
+export type ShotType = OpenUnion<'wrist' | 'snap' | 'slap' | 'backhand' | 'tip-in' | 'deflected' | 'wrap-around' | 'bat'>;
+/** Envelope of the stats API (`api.nhle.com/stats/rest`) for paged reports. */
+export interface StatsApiPage<Row> {
+    data: Row[];
+    total: number;
+}
+export interface GameOutcome {
+    lastPeriodType: PeriodType;
+    /** Low sample count */
+    otPeriods?: number;
+}
+export interface PeriodDescriptor {
+    number: number;
+    periodType: PeriodType;
+    maxRegulationPeriods: number;
+}
+export interface SeriesStatus {
+    round: number;
+    seriesAbbrev: string;
+    seriesTitle: string;
+    seriesLetter: string;
+    neededToWin: number;
+    topSeedTeamAbbrev: string;
+    topSeedWins: number;
+    bottomSeedTeamAbbrev: string;
+    bottomSeedWins: number;
+    gameNumberOfSeries: number;
+}
+export interface TeamLogo {
+    light: string;
+    dark: string;
+}
+export interface TvBroadcast {
+    id: number;
+    market: string;
+    countryCode: string;
+    network: string;
+    sequenceNumber: number;
+}
+export interface OddsPartner {
+    partnerId: number;
+    country: string;
+    name: string;
+    imageUrl: string;
+    siteUrl: string;
+    bgColor: string;
+    textColor: string;
+    accentColor: string;
+}
+/** A betting provider's price for one side of a game. */
+export interface TeamOdd {
+    providerId: number;
+    value: string;
+}

package/dist/types/common.mjs

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