nhl-api-ts 0.2.0 → 0.3.0

package/dist/api/stats.d.mts

@@ -1,7 +1,7 @@
 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 { ClubStats, ClubStatsSeason, GameLogEntry, GoalieLeaderCategory, GoalieLeaderRows, GoalieMilestone, GoalieReportRows, GoalieStatsLeaders, OpenUnion, PlayerLanding, SkaterLeaderCategory, SkaterLeaderRows, SkaterMilestone, SkaterReportRows, SkaterStatsLeaders, 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 */
@@ -81,44 +81,87 @@ export interface GoalieStatsSummaryParams<Report extends keyof GoalieReportRows
  * @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<ClubStatsSeason[]>;
+}): 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<PlayerLanding>;
+}): Promise<PlayerLanding>;
 /**
- * Gets a player's game log for a specific season and game type.
+ * Gets a player's game log for a 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
+ * @param params.seasonId Season in YYYYYYYY format, e.g. 20232024. Defaults to the current season ("now").
+ * @param params.gameType 1=Preseason, 2=Regular season (default), 3=Playoffs. Ignored when `seasonId` is omitted.
  * @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<GameLogEntry[]>;
+    seasonId?: Id;
+    gameType?: number;
+}): Promise<GameLogEntry[]>;
+export interface StatsLeadersParams<Category extends string> {
+    /** Season in YYYYYYYY format, e.g. 20232024. Defaults to the current season ("current"). */
+    season?: Id;
+    /** 2=Regular season (default), 3=Playoffs. Ignored when `season` is omitted. */
+    gameType?: number;
+    /** Categories to include. Defaults to every category. An unknown category is a 400. */
+    categories?: readonly Category[];
+    /** Rows per category. The API defaults to 5; -1 returns every player. */
+    limit?: number;
+}
+/**
+ * Gets the skater stats leaders for a season, keyed by category.
+ *
+ * @param params.season Season in YYYYYYYY format. Defaults to the current season.
+ * @param params.gameType 2=Regular season (default), 3=Playoffs. Ignored when `season` is omitted.
+ * @param params.categories Categories to include, e.g. ['goals', 'points']. Defaults to all.
+ * @param params.limit Rows per category. The API defaults to 5; -1 returns every player.
+ * @example https://api-web.nhle.com/v1/skater-stats-leaders/20232024/2?categories=goals,points&limit=10
+ */
+export declare function skaterStatsLeaders(ctx: Context, params?: StatsLeadersParams<OpenUnion<SkaterLeaderCategory>>): Promise<SkaterStatsLeaders>;
+/**
+ * Gets the goalie stats leaders for a season, keyed by category.
+ *
+ * @param params.season Season in YYYYYYYY format. Defaults to the current season.
+ * @param params.gameType 2=Regular season (default), 3=Playoffs. Ignored when `season` is omitted.
+ * @param params.categories Categories to include, e.g. ['wins', 'savePctg']. Defaults to all.
+ * @param params.limit Rows per category. The API defaults to 5; -1 returns every goalie.
+ * @example https://api-web.nhle.com/v1/goalie-stats-leaders/20232024/2?categories=wins&limit=10
+ */
+export declare function goalieStatsLeaders(ctx: Context, params?: StatsLeadersParams<OpenUnion<GoalieLeaderCategory>>): Promise<GoalieStatsLeaders>;
+/**
+ * Gets a team's skater and goalie stats for a season and game type.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024. Defaults to the current season ("now").
+ * @param params.gameType 2=Regular season (default), 3=Playoffs. Ignored when `season` is omitted.
+ * @example https://api-web.nhle.com/v1/club-stats/TOR/20232024/2
+ */
+export declare function clubStats(ctx: Context, { teamAbbr, season, gameType, }: {
+    teamAbbr: string;
+    season?: Id;
+    gameType?: number;
+}): Promise<ClubStats>;
 /**
  * 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[]>;
+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<SkaterReportRows['summary'][]>;
+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 }`).
@@ -134,20 +177,66 @@ export declare const skaterStatsSummary: (ctx: Context, { startSeason, endSeason
  * ]);
  * 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]>>;
+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: <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 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 interface StatsApiLeadersParams<Attribute extends string> {
+    /** Stat to rank by. An unknown attribute is a 500, not a 404. */
+    attribute: Attribute;
+    /** Season in YYYYYYYY format, e.g. 20232024. Defaults to every season on record. */
+    season?: Id;
+}
+/**
+ * Gets the top 10 single-season skater records for an attribute, e.g.
+ * Gretzky's 215 points, or the top 10 of one season.
+ *
+ * @param params.attribute points, goals, assists or gamesPlayed (case-sensitive)
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024. Defaults to every season.
+ * @example https://api.nhle.com/stats/rest/en/leaders/skaters/points?cayenneExp=season=20232024
+ */
+export declare function skaterLeaders<Attribute extends keyof SkaterLeaderRows>(ctx: Context, params: StatsApiLeadersParams<Attribute>): Promise<SkaterLeaderRows[Attribute][]>;
+/**
+ * Gets the top 10 single-season goalie records for an attribute, or the top
+ * 10 of one season. There is no minimum games played, so `gaa` / `savePctg`
+ * leaders are goalies with a few minutes.
+ *
+ * @param params.attribute gaa, savePctg, shutouts, timeOnIce or gamesPlayed (case-sensitive)
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024. Defaults to every season.
+ * @example https://api.nhle.com/stats/rest/en/leaders/goalies/gaa?cayenneExp=season=20232024
+ */
+export declare function goalieLeaders<Attribute extends keyof GoalieLeaderRows>(ctx: Context, params: StatsApiLeadersParams<Attribute>): Promise<GoalieLeaderRows[Attribute][]>;
+/**
+ * Gets the career milestones active skaters are closing in on (e.g. 200
+ * assists, 50 playoff points).
+ *
+ * @example https://api.nhle.com/stats/rest/en/milestones/skaters
+ */
+export declare function skaterMilestones(ctx: Context): Promise<SkaterMilestone[]>;
+/**
+ * Gets the career milestones active goalies are closing in on (e.g. 30
+ * shutouts, 50 playoff games).
+ *
+ * @example https://api.nhle.com/stats/rest/en/milestones/goalies
+ */
+export declare function goalieMilestones(ctx: Context): Promise<GoalieMilestone[]>;
 export declare const statsApi: {
     readonly gametypesPerSeasonDirectoryByTeam: typeof gametypesPerSeasonDirectoryByTeam;
     readonly playerCareerStats: typeof playerCareerStats;
     readonly playerGameLog: typeof playerGameLog;
+    readonly skaterStatsLeaders: typeof skaterStatsLeaders;
+    readonly goalieStatsLeaders: typeof goalieStatsLeaders;
+    readonly clubStats: typeof clubStats;
     readonly teamSummary: typeof teamSummary;
     readonly skaterStatsSummary: typeof skaterStatsSummary;
     readonly skaterStatsWithQueryContext: typeof skaterStatsWithQueryContext;
     readonly goalieStatsSummary: typeof goalieStatsSummary;
+    readonly skaterLeaders: typeof skaterLeaders;
+    readonly goalieLeaders: typeof goalieLeaders;
+    readonly skaterMilestones: typeof skaterMilestones;
+    readonly goalieMilestones: typeof goalieMilestones;
 };

package/dist/api/stats.mjs

@@ -1,7 +1,17 @@
 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 { defaultSortForReport, defaultSortForSkaterStatsSummary, defaultSortForTeamSummary, } from '#src/api/query/sorting/sorting-options.mjs';
 import { Endpoint } from '#src/http-client.mjs';
+/**
+ * "<season>/<gameType>", or the API's current-season segment when no season is
+ * given. Most endpoints take `now`; the stats-leaders ones only take `current`.
+ */
+function seasonGameTypeSegments(season, gameType, current) {
+    if (season === undefined || season === null) {
+        return current;
+    }
+    return `${season}/${gameType}`;
+}
 /** Skater reports whose rows have no `gamesPlayed`, so the API rejects the default fact filter. */
 const REPORTS_WITHOUT_GAMES_PLAYED = [
     'shootout',
@@ -13,46 +23,85 @@ const REPORTS_WITHOUT_GAMES_PLAYED = [
  * @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.
+ * Gets a player's game log for a 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
+ * @param params.seasonId Season in YYYYYYYY format, e.g. 20232024. Defaults to the current season ("now").
+ * @param params.gameType 1=Preseason, 2=Regular season (default), 3=Playoffs. Ignored when `seasonId` is omitted.
  * @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();
+export async function playerGameLog(ctx, { playerId, seasonId, gameType = 2, }) {
+    const data = await (await ctx.get(Endpoint.API_WEB_V1, `player/${playerId}/game-log/${seasonGameTypeSegments(seasonId, gameType, 'now')}`)).json();
     return data.gameLog ?? [];
-};
+}
+function statsLeadersQuery({ categories, limit, }) {
+    const query = {};
+    if (categories && categories.length > 0) {
+        query.categories = categories.join(',');
+    }
+    if (limit !== undefined) {
+        query.limit = limit;
+    }
+    return query;
+}
+/**
+ * Gets the skater stats leaders for a season, keyed by category.
+ *
+ * @param params.season Season in YYYYYYYY format. Defaults to the current season.
+ * @param params.gameType 2=Regular season (default), 3=Playoffs. Ignored when `season` is omitted.
+ * @param params.categories Categories to include, e.g. ['goals', 'points']. Defaults to all.
+ * @param params.limit Rows per category. The API defaults to 5; -1 returns every player.
+ * @example https://api-web.nhle.com/v1/skater-stats-leaders/20232024/2?categories=goals,points&limit=10
+ */
+export async function skaterStatsLeaders(ctx, params = {}) {
+    return (await ctx.get(Endpoint.API_WEB_V1, `skater-stats-leaders/${seasonGameTypeSegments(params.season, params.gameType ?? 2, 'current')}`, statsLeadersQuery(params))).json();
+}
+/**
+ * Gets the goalie stats leaders for a season, keyed by category.
+ *
+ * @param params.season Season in YYYYYYYY format. Defaults to the current season.
+ * @param params.gameType 2=Regular season (default), 3=Playoffs. Ignored when `season` is omitted.
+ * @param params.categories Categories to include, e.g. ['wins', 'savePctg']. Defaults to all.
+ * @param params.limit Rows per category. The API defaults to 5; -1 returns every goalie.
+ * @example https://api-web.nhle.com/v1/goalie-stats-leaders/20232024/2?categories=wins&limit=10
+ */
+export async function goalieStatsLeaders(ctx, params = {}) {
+    return (await ctx.get(Endpoint.API_WEB_V1, `goalie-stats-leaders/${seasonGameTypeSegments(params.season, params.gameType ?? 2, 'current')}`, statsLeadersQuery(params))).json();
+}
+/**
+ * Gets a team's skater and goalie stats for a season and game type.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024. Defaults to the current season ("now").
+ * @param params.gameType 2=Regular season (default), 3=Playoffs. Ignored when `season` is omitted.
+ * @example https://api-web.nhle.com/v1/club-stats/TOR/20232024/2
+ */
+export async function clubStats(ctx, { teamAbbr, season, gameType = 2, }) {
+    return (await ctx.get(Endpoint.API_WEB_V1, `club-stats/${teamAbbr}/${seasonGameTypeSegments(season, gameType, 'now')}`)).json();
+}
 /**
  * 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',
-            },
-        ];
+export async function teamSummary(ctx, { startSeason, endSeason, gameTypeId = 2, isGame = false, isAggregate = false, sortExpr, start = 0, limit = 50, factCayenneExp = 'gamesPlayed>1', defaultCayenneExp, }) {
+    const effectiveSortExpr = defaultSortForTeamSummary(sortExpr, isAggregate);
     const effectiveCayenneExp = defaultCayenneExp ??
         `gameTypeId=${gameTypeId} and seasonId<=${endSeason} and seasonId>=${startSeason}`;
-    const qParams = {
+    const queryParams = {
         isAggregate,
         isGame,
         start,
@@ -61,29 +110,23 @@ export const teamSummary = async (ctx, { startSeason, endSeason, gameTypeId = 2,
         sort: JSON.stringify(effectiveSortExpr),
         cayenneExp: effectiveCayenneExp,
     };
-    const response = await (await ctx.get(Endpoint.API_STATS, 'en/team/summary', qParams)).json();
+    const response = await (await ctx.get(Endpoint.API_STATS, 'en/team/summary', queryParams)).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' },
-        ];
+export async function skaterStatsSummary(ctx, { startSeason, endSeason, franchiseId, gameTypeId = 2, aggregate = false, sortExpr, start = 0, limit = 25, factCayenneExp = 'gamesPlayed>=1', defaultCayenneExp, }) {
+    const effectiveSortExpr = defaultSortForSkaterStatsSummary(sortExpr);
     const baseCayenneExp = defaultCayenneExp ??
         `gameTypeId=${gameTypeId} and seasonId<=${endSeason} and seasonId>=${startSeason}`;
     const effectiveCayenneExp = !defaultCayenneExp && franchiseId
         ? `franchiseId=${franchiseId} and ${baseCayenneExp}`
         : baseCayenneExp;
-    const qParams = {
+    const queryParams = {
         isAggregate: aggregate,
         isGame: false,
         start,
@@ -92,9 +135,9 @@ export const skaterStatsSummary = async (ctx, { startSeason, endSeason, franchis
         sort: JSON.stringify(effectiveSortExpr),
         cayenneExp: effectiveCayenneExp,
     };
-    const response = await (await ctx.get(Endpoint.API_STATS, 'en/skater/summary', qParams)).json();
+    const response = await (await ctx.get(Endpoint.API_STATS, 'en/skater/summary', queryParams)).json();
     return response.data;
-};
+}
 /**
  * Retrieves skater statistics using a query context and specified report
  * type. Returns the full response (`{ data, total }`).
@@ -110,7 +153,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);
@@ -127,14 +170,14 @@ export const skaterStatsWithQueryContext = async (ctx, { queryContext, reportTyp
         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, }) => {
+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(report);
@@ -143,7 +186,7 @@ export const goalieStatsSummary = async (ctx, { startSeason, endSeason, statsTyp
     const effectiveCayenneExp = franchiseId
         ? `franchiseId=${franchiseId} and ${baseCayenneExp}`
         : baseCayenneExp;
-    const qParams = {
+    const queryParams = {
         isAggregate: aggregate,
         isGame: false,
         start,
@@ -152,15 +195,76 @@ 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/${report}`, qParams)).json();
+    const response = await (await ctx.get(Endpoint.API_STATS, `en/goalie/${report}`, queryParams)).json();
     return response.data ?? [];
-};
+}
+async function getStatsData(ctx, resource, queryParams) {
+    const response = await (await ctx.get(Endpoint.API_STATS, resource, queryParams)).json();
+    return response.data ?? [];
+}
+/**
+ * The leaders endpoints only filter on `season` (`seasonId`, `gameTypeId` and
+ * the other report columns are a 400), so the SDK builds the filter itself.
+ */
+function getStatsLeaders(ctx, group, { attribute, season }) {
+    return getStatsData(ctx, `en/leaders/${group}/${attribute}`, season === undefined || season === null
+        ? undefined
+        : { cayenneExp: `season=${season}` });
+}
+/**
+ * Gets the top 10 single-season skater records for an attribute, e.g.
+ * Gretzky's 215 points, or the top 10 of one season.
+ *
+ * @param params.attribute points, goals, assists or gamesPlayed (case-sensitive)
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024. Defaults to every season.
+ * @example https://api.nhle.com/stats/rest/en/leaders/skaters/points?cayenneExp=season=20232024
+ */
+export async function skaterLeaders(ctx, params) {
+    return getStatsLeaders(ctx, 'skaters', params);
+}
+/**
+ * Gets the top 10 single-season goalie records for an attribute, or the top
+ * 10 of one season. There is no minimum games played, so `gaa` / `savePctg`
+ * leaders are goalies with a few minutes.
+ *
+ * @param params.attribute gaa, savePctg, shutouts, timeOnIce or gamesPlayed (case-sensitive)
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024. Defaults to every season.
+ * @example https://api.nhle.com/stats/rest/en/leaders/goalies/gaa?cayenneExp=season=20232024
+ */
+export async function goalieLeaders(ctx, params) {
+    return getStatsLeaders(ctx, 'goalies', params);
+}
+/**
+ * Gets the career milestones active skaters are closing in on (e.g. 200
+ * assists, 50 playoff points).
+ *
+ * @example https://api.nhle.com/stats/rest/en/milestones/skaters
+ */
+export async function skaterMilestones(ctx) {
+    return getStatsData(ctx, 'en/milestones/skaters');
+}
+/**
+ * Gets the career milestones active goalies are closing in on (e.g. 30
+ * shutouts, 50 playoff games).
+ *
+ * @example https://api.nhle.com/stats/rest/en/milestones/goalies
+ */
+export async function goalieMilestones(ctx) {
+    return getStatsData(ctx, 'en/milestones/goalies');
+}
 export const statsApi = {
     gametypesPerSeasonDirectoryByTeam,
     playerCareerStats,
     playerGameLog,
+    skaterStatsLeaders,
+    goalieStatsLeaders,
+    clubStats,
     teamSummary,
     skaterStatsSummary,
     skaterStatsWithQueryContext,
     goalieStatsSummary,
+    skaterLeaders,
+    goalieLeaders,
+    skaterMilestones,
+    goalieMilestones,
 };

package/dist/api/teams.d.mts

@@ -1,5 +1,5 @@
 import type { Context } from '#src/context.mjs';
-import type { Franchise, Roster, StandingsEntry } from '#src/types/index.mjs';
+import type { Franchise, Roster, SeasonId, StandingsEntry, StatsTeam, TeamScoreboard } from '#src/types/index.mjs';
 import type { Id } from '#src/utils.mjs';
 export interface Team {
     conference: {
@@ -32,28 +32,68 @@ 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.
  *
  * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
- * @param params.season Season in YYYYYYYY format, e.g. 20232024
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024. Defaults to
+ *   the current season (`current`; this endpoint has no `now` alias).
  * @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<Roster>;
+    season?: Id;
+}): Promise<Roster>;
+/**
+ * Get every season a team has a roster for.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @example https://api-web.nhle.com/v1/roster-season/TOR
+ */
+export declare function rosterSeasons(ctx: Context, { teamAbbr }: {
+    teamAbbr: string;
+}): Promise<SeasonId[]>;
+/**
+ * Get a team's recent and upcoming games, grouped by date.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @example https://api-web.nhle.com/v1/scoreboard/TOR/now
+ */
+export declare function teamScoreboard(ctx: Context, { teamAbbr }: {
+    teamAbbr: string;
+}): Promise<TeamScoreboard>;
 /**
  * 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<Franchise[]>;
+export declare function franchises(ctx: Context): Promise<Franchise[]>;
+/**
+ * Get every team in the stats API, past and present (62 rows), with its
+ * franchise id and tricode. Unlike `teams()`, this is the raw stats API row.
+ *
+ * @example https://api.nhle.com/stats/rest/en/team
+ */
+export declare function statsTeams(ctx: Context): Promise<StatsTeam[]>;
+/**
+ * Get one team from the stats API by its team id. An unknown id throws
+ * `ResourceNotFoundException`.
+ *
+ * @param params.teamId NHL team id, e.g. 10
+ * @example https://api.nhle.com/stats/rest/en/team/id/10
+ */
+export declare function teamById(ctx: Context, { teamId }: {
+    teamId: Id;
+}): Promise<StatsTeam>;
 export declare const teamsApi: {
     readonly teams: typeof teams;
     readonly teamRoster: typeof teamRoster;
+    readonly rosterSeasons: typeof rosterSeasons;
+    readonly teamScoreboard: typeof teamScoreboard;
     readonly franchises: typeof franchises;
+    readonly statsTeams: typeof statsTeams;
+    readonly teamById: typeof teamById;
 };

package/dist/api/teams.mjs

@@ -5,7 +5,9 @@ async function fetchStandingsData(ctx, date) {
 }
 /** Converts a raw standings entry into a `Team`. */
 export function toTeam(teamData) {
-    const nestedDefault = (key) => teamData[key]?.default ?? '';
+    function nestedDefault(key) {
+        return teamData[key]?.default ?? '';
+    }
     return {
         conference: {
             abbr: teamData.conferenceAbbrev ?? '',
@@ -66,26 +68,76 @@ export function withFranchiseIds(teams, franchises) {
  * @param params.date Date in YYYY-MM-DD format. Defaults to "now".
  * @example await client.teams.teams()
  */
-export const teams = async (ctx, { date = 'now' } = {}) => {
+export async function teams(ctx, { date = 'now' } = {}) {
     const standingsData = await fetchStandingsData(ctx, date);
     const franchiseData = await franchises(ctx);
     return withFranchiseIds(standingsData.map(toTeam), franchiseData);
-};
+}
 /**
  * Get the roster for the given team and season.
  *
  * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
- * @param params.season Season in YYYYYYYY format, e.g. 20232024
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024. Defaults to
+ *   the current season (`current`; this endpoint has no `now` alias).
  * @example https://api-web.nhle.com/v1/roster/BUF/20232024
  */
-export const teamRoster = async (ctx, { teamAbbr, season }) => (await ctx.get(Endpoint.API_WEB_V1, `roster/${teamAbbr}/${season}`)).json();
+export async function teamRoster(ctx, { teamAbbr, season }) {
+    return (await ctx.get(Endpoint.API_WEB_V1, `roster/${teamAbbr}/${season ?? 'current'}`)).json();
+}
+/**
+ * Get every season a team has a roster for.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @example https://api-web.nhle.com/v1/roster-season/TOR
+ */
+export async function rosterSeasons(ctx, { teamAbbr }) {
+    return (await ctx.get(Endpoint.API_WEB_V1, `roster-season/${teamAbbr}`)).json();
+}
+/**
+ * Get a team's recent and upcoming games, grouped by date.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @example https://api-web.nhle.com/v1/scoreboard/TOR/now
+ */
+export async function teamScoreboard(ctx, { teamAbbr }) {
+    return (await ctx.get(Endpoint.API_WEB_V1, `scoreboard/${teamAbbr}/now`)).json();
+}
 /**
  * Get a list of all past and current NHL franchises.
  *
  * @example https://api.nhle.com/stats/rest/en/franchise
  */
-export const franchises = async (ctx) => {
+export async function franchises(ctx) {
     const response = await (await ctx.get(Endpoint.API_STATS, 'en/franchise')).json();
     return response.data ?? [];
+}
+/**
+ * Get every team in the stats API, past and present (62 rows), with its
+ * franchise id and tricode. Unlike `teams()`, this is the raw stats API row.
+ *
+ * @example https://api.nhle.com/stats/rest/en/team
+ */
+export async function statsTeams(ctx) {
+    const response = await (await ctx.get(Endpoint.API_STATS, 'en/team')).json();
+    return response.data ?? [];
+}
+/**
+ * Get one team from the stats API by its team id. An unknown id throws
+ * `ResourceNotFoundException`.
+ *
+ * @param params.teamId NHL team id, e.g. 10
+ * @example https://api.nhle.com/stats/rest/en/team/id/10
+ */
+export async function teamById(ctx, { teamId }) {
+    const response = await (await ctx.get(Endpoint.API_STATS, `en/team/id/${teamId}`)).json();
+    return response.data[0];
+}
+export const teamsApi = {
+    teams,
+    teamRoster,
+    rosterSeasons,
+    teamScoreboard,
+    franchises,
+    statsTeams,
+    teamById,
 };
-export const teamsApi = { teams, teamRoster, franchises };

package/dist/cli/colors.d.mts

@@ -1,7 +1,7 @@
 import { styleText } from 'node:util';
 export type Style = Parameters<typeof styleText>[0];
-export declare const toStdout: (format: Style) => (text: string) => string;
-export declare const toStderr: (format: Style) => (text: string) => string;
+export declare function toStdout(format: Style): (text: string) => string;
+export declare function toStderr(format: Style): (text: string) => string;
 export declare const colors: {
     dim: (text: string) => string;
     pass: (text: string) => string;