nhl-api-ts 0.1.0 → 0.2.1

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;
 }
 /**
@@ -20,18 +21,18 @@ export interface DailySchedule {
  * @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 }?: {
+export declare function dailySchedule(ctx: Context, { date }?: {
     date?: string;
-}) => Promise<DailySchedule>;
+}): 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 }?: {
+export declare function weeklySchedule(ctx: Context, { date }?: {
     date?: string;
-}) => Promise<JsonObject>;
+}): Promise<WeeklySchedule>;
 /**
  * Gets monthly schedule for a specified team.
  *
@@ -39,10 +40,10 @@ export declare const weeklySchedule: (ctx: Context, { date }?: {
  * @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 }: {
+export declare function teamMonthlySchedule(ctx: Context, { teamAbbr, month }: {
     teamAbbr: string;
     month?: string;
-}) => Promise<JsonObject[]>;
+}): Promise<ClubScheduleGame[]>;
 /**
  * Gets weekly schedule for a specified team.
  *
@@ -50,10 +51,10 @@ export declare const teamMonthlySchedule: (ctx: Context, { teamAbbr, month }: {
  * @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 }: {
+export declare function teamWeeklySchedule(ctx: Context, { teamAbbr, date }: {
     teamAbbr: string;
     date?: string;
-}) => Promise<JsonObject[]>;
+}): Promise<ClubScheduleGame[]>;
 /**
  * Gets the full season schedule for a specified team.
  *
@@ -61,28 +62,28 @@ export declare const teamWeeklySchedule: (ctx: Context, { teamAbbr, date }: {
  * @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 }: {
+export declare function teamSeasonSchedule(ctx: Context, { teamAbbr, season }: {
     teamAbbr: string;
     season: Id;
-}) => Promise<JsonObject>;
+}): 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 }: {
+export declare function calendarSchedule(ctx: Context, { date }: {
     date: string;
-}) => Promise<JsonObject>;
+}): 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 }: {
+export declare function playoffCarousel(ctx: Context, { season }: {
     season: Id;
-}) => Promise<JsonObject>;
+}): Promise<PlayoffCarousel>;
 /**
  * Returns the schedule and results for a specified playoff series matchup.
  *
@@ -90,19 +91,19 @@ export declare const playoffCarousel: (ctx: Context, { season }: {
  * @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 }: {
+export declare function playoffSeriesSchedule(ctx: Context, { season, series }: {
     season: Id;
     series: string;
-}) => Promise<JsonObject>;
+}): 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 }: {
+export declare function 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/schedule.mjs

@@ -1,5 +1,7 @@
 import { Endpoint } from '#src/http-client.mjs';
-const pad = (value, width = 2) => String(value).padStart(width, '0');
+function pad(value, width = 2) {
+    return String(value).padStart(width, '0');
+}
 /** Today's date (local time) as YYYY-MM-DD. */
 function today() {
     const now = new Date();
@@ -29,7 +31,7 @@ export function normalizeDate(date) {
  * @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 } = {}) => {
+export async function dailySchedule(ctx, { date } = {}) {
     const resolvedDate = date ? normalizeDate(date) : today();
     const scheduleData = await (await ctx.get(Endpoint.API_WEB_V1, `schedule/${resolvedDate}`)).json();
     const responsePayload = {
@@ -46,17 +48,17 @@ export const dailySchedule = async (ctx, { date } = {}) => {
         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 } = {}) => {
+export async function weeklySchedule(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.
  *
@@ -64,11 +66,11 @@ export const weeklySchedule = async (ctx, { date } = {}) => {
  * @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 }) => {
+export async function teamMonthlySchedule(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.
  *
@@ -76,11 +78,11 @@ export const teamMonthlySchedule = async (ctx, { teamAbbr, month }) => {
  * @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 }) => {
+export async function teamWeeklySchedule(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.
  *
@@ -88,21 +90,27 @@ export const teamWeeklySchedule = async (ctx, { teamAbbr, date }) => {
  * @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();
+export async function teamSeasonSchedule(ctx, { teamAbbr, season }) {
+    return (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();
+export async function calendarSchedule(ctx, { date }) {
+    return (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();
+export async function playoffCarousel(ctx, { season }) {
+    return (await ctx.get(Endpoint.API_WEB_V1, `playoff-series/carousel/${season}`)).json();
+}
 /**
  * Returns the schedule and results for a specified playoff series matchup.
  *
@@ -110,14 +118,18 @@ export const playoffCarousel = async (ctx, { season }) => (await ctx.get(Endpoin
  * @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();
+export async function playoffSeriesSchedule(ctx, { season, series }) {
+    return (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 async function playoffBracket(ctx, { year }) {
+    return (await ctx.get(Endpoint.API_WEB_V1, `playoff-bracket/${year}`)).json();
+}
 export const scheduleApi = {
     dailySchedule,
     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.
  *
@@ -11,17 +12,17 @@ import type { Id, JsonObject } from '#src/utils.mjs';
  * @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 }?: {
+export declare function 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 function seasonStandingManifest(ctx: Context): Promise<StandingsSeason[]>;
 export declare const standingsApi: {
     readonly leagueStandings: typeof leagueStandings;
     readonly seasonStandingManifest: typeof seasonStandingManifest;

package/dist/api/standings.mjs

@@ -10,7 +10,7 @@ import { Endpoint } from '#src/http-client.mjs';
  * @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 } = {}) => {
+export async function leagueStandings(ctx, { date, season } = {}) {
     if (season) {
         const seasons = await seasonStandingManifest(ctx);
         const seasonData = seasons.find((seasonEntry) => seasonEntry.id === Number(season));
@@ -21,17 +21,17 @@ export const leagueStandings = async (ctx, { date, season } = {}) => {
     }
     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) => {
+export async function seasonStandingManifest(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

@@ -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;
@@ -80,18 +81,18 @@ export interface GoalieStatsSummaryParams {
  * @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 }: {
+export declare function gametypesPerSeasonDirectoryByTeam(ctx: Context, { teamAbbr }: {
     teamAbbr: string;
-}) => Promise<JsonObject[]>;
+}): 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 }: {
+export declare function playerCareerStats(ctx: Context, { playerId }: {
     playerId: Id;
-}) => Promise<JsonObject>;
+}): Promise<PlayerLanding>;
 /**
  * Gets a player's game log for a specific season and game type.
  *
@@ -100,28 +101,32 @@ export declare const playerCareerStats: (ctx: Context, { playerId }: {
  * @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, }: {
+export declare function playerGameLog(ctx: Context, { playerId, seasonId, gameType, }: {
     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 function 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 function 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 function 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 function 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,20 +1,30 @@
+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();
+export async function gametypesPerSeasonDirectoryByTeam(ctx, { teamAbbr }) {
+    return (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();
+export async function playerCareerStats(ctx, { playerId }) {
+    return (await ctx.get(Endpoint.API_WEB_V1, `player/${playerId}/landing`)).json();
+}
 /**
  * Gets a player's game log for a specific season and game type.
  *
@@ -23,22 +33,26 @@ export const playerCareerStats = async (ctx, { playerId }) => (await ctx.get(End
  * @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, }) => {
+export async function playerGameLog(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, }) => {
+export async function teamSummary(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' },
-            { 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}`;
@@ -53,14 +67,14 @@ export const teamSummary = async (ctx, { startSeason, endSeason, gameTypeId = 2,
     };
     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, }) => {
+export async function skaterStatsSummary(ctx, { startSeason, endSeason, franchiseId, gameTypeId = 2, aggregate = false, sortExpr, start = 0, limit = 25, factCayenneExp = 'gamesPlayed>=1', defaultCayenneExp, }) {
     const effectiveSortExpr = sortExpr && sortExpr.length > 0
         ? sortExpr
         : [
@@ -84,11 +98,15 @@ export const skaterStatsSummary = async (ctx, { startSeason, endSeason, franchis
     };
     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'),
@@ -96,7 +114,7 @@ export const skaterStatsSummary = async (ctx, { startSeason, endSeason, franchis
  * ]);
  * await client.stats.skaterStatsWithQueryContext({ queryContext: context, reportType: 'summary' });
  */
-export const skaterStatsWithQueryContext = async (ctx, { queryContext, reportType, sortExpr, aggregate = false, start = 0, limit = 25, }) => {
+export async function skaterStatsWithQueryContext(ctx, { queryContext, reportType, sortExpr, aggregate = false, start = 0, limit = 25, }) {
     const effectiveSortExpr = sortExpr && sortExpr.length > 0
         ? sortExpr
         : defaultSortForReport(reportType);
@@ -105,21 +123,25 @@ 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,
     };
     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 = 'summary', gameTypeId = 2, franchiseId, aggregate = false, sortExpr, start = 0, limit = 25, factCayenneExp, defaultCayenneExp, }) => {
+export async function goalieStatsSummary(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,9 +156,9 @@ 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 = {
     gametypesPerSeasonDirectoryByTeam,
     playerCareerStats,

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.
  *
@@ -31,9 +32,9 @@ export declare function withFranchiseIds(teams: readonly Team[], franchises: rea
  * @param params.date Date in YYYY-MM-DD format. Defaults to "now".
  * @example await client.teams.teams()
  */
-export declare const teams: (ctx: Context, { date }?: {
+export declare function teams(ctx: Context, { date }?: {
     date?: string;
-}) => Promise<Team[]>;
+}): Promise<Team[]>;
 /**
  * Get the roster for the given team and season.
  *
@@ -41,16 +42,16 @@ export declare const teams: (ctx: Context, { date }?: {
  * @param params.season Season in YYYYYYYY format, e.g. 20232024
  * @example https://api-web.nhle.com/v1/roster/BUF/20232024
  */
-export declare const teamRoster: (ctx: Context, { teamAbbr, season }: {
+export declare function 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 function franchises(ctx: Context): Promise<Franchise[]>;
 export declare const teamsApi: {
     readonly teams: typeof teams;
     readonly teamRoster: typeof teamRoster;