nhl-api-ts 0.0.0-stage → 0.2.0

package/dist/api/schedule.d.mts

@@ -0,0 +1,117 @@
+import type { Context } from '#src/context.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.
+ */
+export declare function normalizeDate(date: string): string;
+export interface DailySchedule {
+    nextStartDate: string | null;
+    previousStartDate: string | null;
+    date: string;
+    oddsPartners: OddsPartner[] | null;
+    games?: ScheduleGame[];
+    numberOfGames?: number;
+}
+/**
+ * Gets NHL schedule for a specific date.
+ *
+ * @param params.date Date in YYYY-MM-DD format. Defaults to today.
+ * @throws RangeError If the date is not a valid YYYY-MM-DD date
+ * @example await client.schedule.dailySchedule({ date: '2024-10-09' })
+ */
+export declare const dailySchedule: (ctx: Context, { date }?: {
+    date?: string;
+}) => Promise<DailySchedule>;
+/**
+ * Gets NHL schedule for a week starting from the specified date.
+ *
+ * @param params.date Date in YYYY-MM-DD format. Defaults to "now".
+ * @example https://api-web.nhle.com/v1/schedule/2024-10-09
+ */
+export declare const weeklySchedule: (ctx: Context, { date }?: {
+    date?: string;
+}) => Promise<WeeklySchedule>;
+/**
+ * Gets monthly schedule for a specified team.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @param params.month Month in YYYY-MM format. Defaults to "now".
+ * @example https://api-web.nhle.com/v1/club-schedule/BUF/month/2023-11
+ */
+export declare const teamMonthlySchedule: (ctx: Context, { teamAbbr, month }: {
+    teamAbbr: string;
+    month?: string;
+}) => Promise<ClubScheduleGame[]>;
+/**
+ * Gets weekly schedule for a specified team.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @param params.date Date in YYYY-MM-DD format. Defaults to "now".
+ * @example https://api-web.nhle.com/v1/club-schedule/BUF/week/2024-02-10
+ */
+export declare const teamWeeklySchedule: (ctx: Context, { teamAbbr, date }: {
+    teamAbbr: string;
+    date?: string;
+}) => Promise<ClubScheduleGame[]>;
+/**
+ * Gets the full season schedule for a specified team.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024
+ * @example https://api-web.nhle.com/v1/club-schedule-season/BUF/20232024
+ */
+export declare const teamSeasonSchedule: (ctx: Context, { teamAbbr, season }: {
+    teamAbbr: string;
+    season: Id;
+}) => Promise<TeamSeasonSchedule>;
+/**
+ * Gets the schedule in calendar format for a specified date.
+ *
+ * @param params.date Date in YYYY-MM-DD format
+ * @example https://api-web.nhle.com/v1/schedule-calendar/2023-11-08
+ */
+export declare const calendarSchedule: (ctx: Context, { date }: {
+    date: string;
+}) => Promise<CalendarSchedule>;
+/**
+ * Gets all playoff series information up to the current round.
+ *
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024
+ * @example https://api-web.nhle.com/v1/playoff-series/carousel/20232024
+ */
+export declare const playoffCarousel: (ctx: Context, { season }: {
+    season: Id;
+}) => Promise<PlayoffCarousel>;
+/**
+ * Returns the schedule and results for a specified playoff series matchup.
+ *
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024
+ * @param params.series Series letter, e.g. "a" (first round) through "o" (final)
+ * @example https://api-web.nhle.com/v1/schedule/playoff-series/20232024/a
+ */
+export declare const playoffSeriesSchedule: (ctx: Context, { season, series }: {
+    season: Id;
+    series: string;
+}) => Promise<PlayoffSeriesSchedule>;
+/**
+ * Returns the full playoff bracket for a given year.
+ *
+ * @param params.year Year the playoffs took place, e.g. 2024
+ * @example https://api-web.nhle.com/v1/playoff-bracket/2024
+ */
+export declare const playoffBracket: (ctx: Context, { year }: {
+    year: Id;
+}) => Promise<PlayoffBracket>;
+export declare const scheduleApi: {
+    readonly dailySchedule: typeof dailySchedule;
+    readonly weeklySchedule: typeof weeklySchedule;
+    readonly teamMonthlySchedule: typeof teamMonthlySchedule;
+    readonly teamWeeklySchedule: typeof teamWeeklySchedule;
+    readonly teamSeasonSchedule: typeof teamSeasonSchedule;
+    readonly calendarSchedule: typeof calendarSchedule;
+    readonly playoffCarousel: typeof playoffCarousel;
+    readonly playoffSeriesSchedule: typeof playoffSeriesSchedule;
+    readonly playoffBracket: typeof playoffBracket;
+};

package/dist/api/schedule.mjs

@@ -0,0 +1,131 @@
+import { Endpoint } from '#src/http-client.mjs';
+const pad = (value, width = 2) => String(value).padStart(width, '0');
+/** Today's date (local time) as YYYY-MM-DD. */
+function today() {
+    const now = new Date();
+    return `${pad(now.getFullYear(), 4)}-${pad(now.getMonth() + 1)}-${pad(now.getDate())}`;
+}
+/**
+ * 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.
+ */
+export function normalizeDate(date) {
+    const match = /^(\d{4})-(1[0-2]|0[1-9]|[1-9])-(3[01]|[12]\d|0[1-9]|[1-9]| [1-9])$/.exec(date);
+    if (!match) {
+        throw new RangeError('Invalid date format. Please use YYYY-MM-DD.');
+    }
+    const [year, month, day] = match.slice(1).map((part) => Number(part.trim()));
+    const parsed = new Date(0);
+    parsed.setUTCFullYear(year, month - 1, day);
+    if (parsed.getUTCMonth() !== month - 1 || parsed.getUTCDate() !== day) {
+        throw new RangeError('Invalid date format. Please use YYYY-MM-DD.');
+    }
+    return `${pad(year, 4)}-${pad(month)}-${pad(day)}`;
+}
+/**
+ * Gets NHL schedule for a specific date.
+ *
+ * @param params.date Date in YYYY-MM-DD format. Defaults to today.
+ * @throws RangeError If the date is not a valid YYYY-MM-DD date
+ * @example await client.schedule.dailySchedule({ date: '2024-10-09' })
+ */
+export const dailySchedule = async (ctx, { date } = {}) => {
+    const resolvedDate = date ? normalizeDate(date) : today();
+    const scheduleData = await (await ctx.get(Endpoint.API_WEB_V1, `schedule/${resolvedDate}`)).json();
+    const responsePayload = {
+        nextStartDate: scheduleData.nextStartDate ?? null,
+        previousStartDate: scheduleData.previousStartDate ?? null,
+        date: resolvedDate,
+        oddsPartners: scheduleData.oddsPartners ?? null,
+    };
+    const gameWeek = scheduleData.gameWeek ?? [];
+    const matchingDay = gameWeek.find((day) => day.date === resolvedDate);
+    if (matchingDay) {
+        const games = matchingDay.games ?? [];
+        responsePayload.games = games;
+        responsePayload.numberOfGames = games.length;
+    }
+    return responsePayload;
+};
+/**
+ * Gets NHL schedule for a week starting from the specified date.
+ *
+ * @param params.date Date in YYYY-MM-DD format. Defaults to "now".
+ * @example https://api-web.nhle.com/v1/schedule/2024-10-09
+ */
+export const weeklySchedule = async (ctx, { date } = {}) => {
+    const res = date ? date : 'now';
+    return (await ctx.get(Endpoint.API_WEB_V1, `schedule/${res}`)).json();
+};
+/**
+ * Gets monthly schedule for a specified team.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @param params.month Month in YYYY-MM format. Defaults to "now".
+ * @example https://api-web.nhle.com/v1/club-schedule/BUF/month/2023-11
+ */
+export const teamMonthlySchedule = async (ctx, { teamAbbr, month }) => {
+    const resource = `club-schedule/${teamAbbr}/month/${month ? month : 'now'}`;
+    const response = await (await ctx.get(Endpoint.API_WEB_V1, resource)).json();
+    return response.games ?? [];
+};
+/**
+ * Gets weekly schedule for a specified team.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @param params.date Date in YYYY-MM-DD format. Defaults to "now".
+ * @example https://api-web.nhle.com/v1/club-schedule/BUF/week/2024-02-10
+ */
+export const teamWeeklySchedule = async (ctx, { teamAbbr, date }) => {
+    const resource = `club-schedule/${teamAbbr}/week/${date ? date : 'now'}`;
+    const response = await (await ctx.get(Endpoint.API_WEB_V1, resource)).json();
+    return response.games ?? [];
+};
+/**
+ * Gets the full season schedule for a specified team.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024
+ * @example https://api-web.nhle.com/v1/club-schedule-season/BUF/20232024
+ */
+export const teamSeasonSchedule = async (ctx, { teamAbbr, season }) => (await ctx.get(Endpoint.API_WEB_V1, `club-schedule-season/${teamAbbr}/${season}`)).json();
+/**
+ * Gets the schedule in calendar format for a specified date.
+ *
+ * @param params.date Date in YYYY-MM-DD format
+ * @example https://api-web.nhle.com/v1/schedule-calendar/2023-11-08
+ */
+export const calendarSchedule = async (ctx, { date }) => (await ctx.get(Endpoint.API_WEB_V1, `schedule-calendar/${date}`)).json();
+/**
+ * Gets all playoff series information up to the current round.
+ *
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024
+ * @example https://api-web.nhle.com/v1/playoff-series/carousel/20232024
+ */
+export const playoffCarousel = async (ctx, { season }) => (await ctx.get(Endpoint.API_WEB_V1, `playoff-series/carousel/${season}`)).json();
+/**
+ * Returns the schedule and results for a specified playoff series matchup.
+ *
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024
+ * @param params.series Series letter, e.g. "a" (first round) through "o" (final)
+ * @example https://api-web.nhle.com/v1/schedule/playoff-series/20232024/a
+ */
+export const playoffSeriesSchedule = async (ctx, { season, series }) => (await ctx.get(Endpoint.API_WEB_V1, `schedule/playoff-series/${season}/${series}`)).json();
+/**
+ * Returns the full playoff bracket for a given year.
+ *
+ * @param params.year Year the playoffs took place, e.g. 2024
+ * @example https://api-web.nhle.com/v1/playoff-bracket/2024
+ */
+export const playoffBracket = async (ctx, { year }) => (await ctx.get(Endpoint.API_WEB_V1, `playoff-bracket/${year}`)).json();
+export const scheduleApi = {
+    dailySchedule,
+    weeklySchedule,
+    teamMonthlySchedule,
+    teamWeeklySchedule,
+    teamSeasonSchedule,
+    calendarSchedule,
+    playoffCarousel,
+    playoffSeriesSchedule,
+    playoffBracket,
+};

package/dist/api/standings.d.mts

@@ -0,0 +1,29 @@
+import type { Context } from '#src/context.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.
+ *
+ * If `season` is given, the standings from the end of that season are
+ * returned (overrides `date`). Otherwise standings for `date` or today.
+ *
+ * @param params.date Date in YYYY-MM-DD format
+ * @param params.season Season in YYYYYYYY format, e.g. 20222023
+ * @throws RangeError If the season id is not found in the standings manifest
+ * @example await client.standings.leagueStandings({ season: '20222023' })
+ */
+export declare const leagueStandings: (ctx: Context, { date, season }?: {
+    date?: string;
+    season?: Id;
+}) => 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<StandingsSeason[]>;
+export declare const standingsApi: {
+    readonly leagueStandings: typeof leagueStandings;
+    readonly seasonStandingManifest: typeof seasonStandingManifest;
+};

package/dist/api/standings.mjs

@@ -0,0 +1,38 @@
+import { Endpoint } from '#src/http-client.mjs';
+/**
+ * Gets NHL league standings for a specific date or season.
+ *
+ * If `season` is given, the standings from the end of that season are
+ * returned (overrides `date`). Otherwise standings for `date` or today.
+ *
+ * @param params.date Date in YYYY-MM-DD format
+ * @param params.season Season in YYYYYYYY format, e.g. 20222023
+ * @throws RangeError If the season id is not found in the standings manifest
+ * @example await client.standings.leagueStandings({ season: '20222023' })
+ */
+export const leagueStandings = async (ctx, { date, season } = {}) => {
+    if (season) {
+        const seasons = await seasonStandingManifest(ctx);
+        const seasonData = seasons.find((seasonEntry) => seasonEntry.id === Number(season));
+        if (!seasonData) {
+            throw new RangeError(`Invalid Season Id ${season}`);
+        }
+        date = seasonData.standingsEnd;
+    }
+    const res = date ? date : 'now';
+    return (await ctx.get(Endpoint.API_WEB_V1, `standings/${res}`)).json();
+};
+/**
+ * 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 const seasonStandingManifest = async (ctx) => {
+    const response = await (await ctx.get(Endpoint.API_WEB_V1, 'standings-season')).json();
+    return response.seasons ?? [];
+};
+export const standingsApi = {
+    leagueStandings,
+    seasonStandingManifest,
+};

package/dist/api/stats.d.mts

@@ -0,0 +1,153 @@
+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 { 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;
+    /** End season in YYYYYYYY format, e.g. 20232024 */
+    endSeason: Id;
+    /** 1=Preseason, 2=Regular season (default), 3=Playoffs */
+    gameTypeId?: number;
+    /** Game-level stats rather than season-level. Defaults to false. */
+    isGame?: boolean;
+    /** Aggregate stats across the selected seasons. Defaults to false. */
+    isAggregate?: boolean;
+    /** Custom sort. Defaults to points DESC, wins DESC, teamId ASC (franchiseId ASC when aggregating). */
+    sortExpr?: SortExpr[];
+    /** Pagination offset. Defaults to 0. */
+    start?: number;
+    /** Max results. Defaults to 50. */
+    limit?: number;
+    /** Base fact filter. Defaults to "gamesPlayed>1". */
+    factCayenneExp?: string;
+    /** Overrides the generated cayenneExp filter entirely. */
+    defaultCayenneExp?: string;
+}
+export interface SkaterStatsSummaryParams {
+    startSeason: Id;
+    endSeason: Id;
+    /** Limit results to a franchise. */
+    franchiseId?: Id;
+    gameTypeId?: number;
+    aggregate?: boolean;
+    /** Custom sort. Defaults to points DESC, gamesPlayed ASC, playerId ASC. */
+    sortExpr?: SortExpr[];
+    start?: number;
+    /** Max results. Defaults to 25. */
+    limit?: number;
+    /** Base fact filter. Defaults to "gamesPlayed>=1". */
+    factCayenneExp?: string;
+    defaultCayenneExp?: string;
+}
+export interface SkaterStatsWithQueryContextParams<Report extends keyof SkaterReportRows = keyof SkaterReportRows> {
+    /** Built with `buildQuery(filters)`. */
+    queryContext: QueryContext;
+    /**
+     * Report type, e.g. summary, bios, faceoffpercentages, faceoffwins,
+     * goalsForAgainst, realtime, penalties, penaltykill, penaltyShots,
+     * powerplay, puckPossessions, summaryshooting, percentages, scoringRates,
+     * scoringpergame, shootout, shottype, timeonice
+     */
+    reportType: Report;
+    /** Custom sort. Defaults to the report type's default sort. */
+    sortExpr?: SortExpr[];
+    aggregate?: boolean;
+    start?: number;
+    limit?: number;
+}
+export interface GoalieStatsSummaryParams<Report extends keyof GoalieReportRows = keyof GoalieReportRows> {
+    startSeason: Id;
+    /** Defaults to `startSeason`. */
+    endSeason?: Id;
+    /**
+     * Report type: summary (default), advanced, bios, daysrest, penaltyShots,
+     * savesByStrength, shootout, startedVsRelieved
+     */
+    statsType?: Report;
+    gameTypeId?: number;
+    franchiseId?: Id;
+    aggregate?: boolean;
+    sortExpr?: SortExpr[];
+    start?: number;
+    limit?: number;
+    factCayenneExp?: string;
+    defaultCayenneExp?: string;
+}
+/**
+ * Gets all game types played by a team throughout their history.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @example https://api-web.nhle.com/v1/club-stats-season/TOR
+ */
+export declare const gametypesPerSeasonDirectoryByTeam: (ctx: Context, { teamAbbr }: {
+    teamAbbr: string;
+}) => Promise<ClubStatsSeason[]>;
+/**
+ * Gets a player's career statistics and biographical information.
+ *
+ * @param params.playerId NHL player id, e.g. 8481528
+ * @example https://api-web.nhle.com/v1/player/8481528/landing
+ */
+export declare const playerCareerStats: (ctx: Context, { playerId }: {
+    playerId: Id;
+}) => Promise<PlayerLanding>;
+/**
+ * Gets a player's game log for a specific season and game type.
+ *
+ * @param params.playerId NHL player id, e.g. 8481528
+ * @param params.seasonId Season in YYYYYYYY format, e.g. 20232024
+ * @param params.gameType 1=Preseason, 2=Regular season, 3=Playoffs
+ * @example https://api-web.nhle.com/v1/player/8481528/game-log/20232024/2
+ */
+export declare const playerGameLog: (ctx: Context, { playerId, seasonId, gameType, }: {
+    playerId: Id;
+    seasonId: Id;
+    gameType: number;
+}) => 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<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<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'),
+ *   filter.position(PositionTypes.CENTER),
+ * ]);
+ * await client.stats.skaterStatsWithQueryContext({ queryContext: context, reportType: 'summary' });
+ */
+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: <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;
+    readonly playerGameLog: typeof playerGameLog;
+    readonly teamSummary: typeof teamSummary;
+    readonly skaterStatsSummary: typeof skaterStatsSummary;
+    readonly skaterStatsWithQueryContext: typeof skaterStatsWithQueryContext;
+    readonly goalieStatsSummary: typeof goalieStatsSummary;
+};

package/dist/api/stats.mjs

@@ -0,0 +1,166 @@
+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.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @example https://api-web.nhle.com/v1/club-stats-season/TOR
+ */
+export const gametypesPerSeasonDirectoryByTeam = async (ctx, { teamAbbr }) => (await ctx.get(Endpoint.API_WEB_V1, `club-stats-season/${teamAbbr}`)).json();
+/**
+ * Gets a player's career statistics and biographical information.
+ *
+ * @param params.playerId NHL player id, e.g. 8481528
+ * @example https://api-web.nhle.com/v1/player/8481528/landing
+ */
+export const playerCareerStats = async (ctx, { playerId }) => (await ctx.get(Endpoint.API_WEB_V1, `player/${playerId}/landing`)).json();
+/**
+ * Gets a player's game log for a specific season and game type.
+ *
+ * @param params.playerId NHL player id, e.g. 8481528
+ * @param params.seasonId Season in YYYYYYYY format, e.g. 20232024
+ * @param params.gameType 1=Preseason, 2=Regular season, 3=Playoffs
+ * @example https://api-web.nhle.com/v1/player/8481528/game-log/20232024/2
+ */
+export const playerGameLog = async (ctx, { playerId, seasonId, gameType, }) => {
+    const data = await (await ctx.get(Endpoint.API_WEB_V1, `player/${playerId}/game-log/${seasonId}/${gameType}`)).json();
+    return data.gameLog ?? [];
+};
+/**
+ * Retrieves team summary statistics across one or more seasons.
+ *
+ * @example await client.stats.teamSummary({ startSeason: '20232024', endSeason: '20232024' })
+ */
+export const teamSummary = async (ctx, { startSeason, endSeason, gameTypeId = 2, isGame = false, isAggregate = false, sortExpr, start = 0, limit = 50, factCayenneExp = 'gamesPlayed>1', defaultCayenneExp, }) => {
+    const effectiveSortExpr = sortExpr && sortExpr.length > 0
+        ? sortExpr
+        : [
+            { property: 'points', direction: 'DESC' },
+            { property: 'wins', direction: 'DESC' },
+            // 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}`;
+    const qParams = {
+        isAggregate,
+        isGame,
+        start,
+        limit,
+        factCayenneExp,
+        sort: JSON.stringify(effectiveSortExpr),
+        cayenneExp: effectiveCayenneExp,
+    };
+    const response = await (await ctx.get(Endpoint.API_STATS, 'en/team/summary', qParams)).json();
+    return response.data;
+};
+/**
+ * Gets simplified skater statistics summary for specified seasons and
+ * franchises.
+ *
+ * @example await client.stats.skaterStatsSummary({ startSeason: '20232024', endSeason: '20232024', franchiseId: 10 })
+ */
+export const skaterStatsSummary = async (ctx, { startSeason, endSeason, franchiseId, gameTypeId = 2, aggregate = false, sortExpr, start = 0, limit = 25, factCayenneExp = 'gamesPlayed>=1', defaultCayenneExp, }) => {
+    const effectiveSortExpr = sortExpr && sortExpr.length > 0
+        ? sortExpr
+        : [
+            { property: 'points', direction: 'DESC' },
+            { property: 'gamesPlayed', direction: 'ASC' },
+            { property: 'playerId', direction: 'ASC' },
+        ];
+    const baseCayenneExp = defaultCayenneExp ??
+        `gameTypeId=${gameTypeId} and seasonId<=${endSeason} and seasonId>=${startSeason}`;
+    const effectiveCayenneExp = !defaultCayenneExp && franchiseId
+        ? `franchiseId=${franchiseId} and ${baseCayenneExp}`
+        : baseCayenneExp;
+    const qParams = {
+        isAggregate: aggregate,
+        isGame: false,
+        start,
+        limit,
+        factCayenneExp,
+        sort: JSON.stringify(effectiveSortExpr),
+        cayenneExp: effectiveCayenneExp,
+    };
+    const response = await (await ctx.get(Endpoint.API_STATS, 'en/skater/summary', qParams)).json();
+    return response.data;
+};
+/**
+ * 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'),
+ *   filter.position(PositionTypes.CENTER),
+ * ]);
+ * await client.stats.skaterStatsWithQueryContext({ queryContext: context, reportType: 'summary' });
+ */
+export const skaterStatsWithQueryContext = async (ctx, { queryContext, reportType, sortExpr, aggregate = false, start = 0, limit = 25, }) => {
+    const effectiveSortExpr = sortExpr && sortExpr.length > 0
+        ? sortExpr
+        : defaultSortForReport(reportType);
+    const qParams = {
+        isAggregate: aggregate,
+        isGame: false,
+        start,
+        limit,
+        factCayenneExp: queryContext.factQuery === DEFAULT_FACT_QUERY &&
+            REPORTS_WITHOUT_GAMES_PLAYED.includes(reportType)
+            ? ''
+            : queryContext.factQuery,
+        sort: JSON.stringify(effectiveSortExpr),
+        cayenneExp: queryContext.query,
+    };
+    return (await ctx.get(Endpoint.API_STATS, `en/skater/${reportType}`, qParams)).json();
+};
+/**
+ * Retrieves goalie statistics with various filtering and aggregation
+ * options.
+ *
+ * @example await client.stats.goalieStatsSummary({ startSeason: '20232024', statsType: 'advanced' })
+ */
+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(report);
+    const baseCayenneExp = defaultCayenneExp ??
+        `gameTypeId=${gameTypeId} and seasonId<=${effectiveEndSeason} and seasonId>=${startSeason}`;
+    const effectiveCayenneExp = franchiseId
+        ? `franchiseId=${franchiseId} and ${baseCayenneExp}`
+        : baseCayenneExp;
+    const qParams = {
+        isAggregate: aggregate,
+        isGame: false,
+        start,
+        limit,
+        factCayenneExp,
+        sort: JSON.stringify(effectiveSortExpr),
+        cayenneExp: effectiveCayenneExp,
+    };
+    const response = await (await ctx.get(Endpoint.API_STATS, `en/goalie/${report}`, qParams)).json();
+    return response.data ?? [];
+};
+export const statsApi = {
+    gametypesPerSeasonDirectoryByTeam,
+    playerCareerStats,
+    playerGameLog,
+    teamSummary,
+    skaterStatsSummary,
+    skaterStatsWithQueryContext,
+    goalieStatsSummary,
+};