nhl-api-ts 0.1.0 → 0.2.0

package/README.md

@@ -6,7 +6,7 @@ Every SDK method is also available as a CLI command.
 
 - Zero runtime dependencies (uses the built-in `fetch`)
 - Node.js >= 24, ESM only
-- Fully typed
+- Fully typed: every response has a named interface you can [extend](docs/recipes/extending-response-types.md)
 
 ## Documentation
 
@@ -15,7 +15,8 @@ Every SDK method is also available as a CLI command.
 - [Recipes](docs/recipes/): [filtered stats](docs/recipes/filter-skater-stats.md),
   [pagination](docs/recipes/paginate-stats.md), [live scores](docs/recipes/live-scores.md),
   [season-wide data](docs/recipes/season-wide-data.md), [retries](docs/recipes/retries.md),
-  [CLI + jq](docs/recipes/cli-and-jq.md), [testing](docs/recipes/testing.md)
+  [CLI + jq](docs/recipes/cli-and-jq.md), [testing](docs/recipes/testing.md),
+  [extending response types](docs/recipes/extending-response-types.md)
 - [Examples](examples/): runnable scripts
 - [API report](api-report.md): the full public TypeScript API
 - [OpenAPI](openapi.yaml): every HTTP path the SDK calls
@@ -181,6 +182,25 @@ Skater report types: `summary`, `bios`, `faceoffpercentages`, `faceoffwins`,
 `powerplay`, `puckPossessions`, `summaryshooting`, `percentages`,
 `scoringRates`, `scoringpergame`, `shootout`, `shottype`, `timeonice`.
 
+## Extending the types
+
+Response types come from real API responses, and the NHL adds fields without
+notice. Every object type is an `interface`, so you can add what's missing with
+module augmentation:
+
+```ts
+declare module 'nhl-api-ts' {
+  interface Boxscore {
+    someNewField?: string;
+  }
+}
+```
+
+New play types and report types are added through registries (`PlayTypes`,
+`SkaterReportRows`, `GoalieReportRows`). See
+[Extending response types](docs/recipes/extending-response-types.md) for those
+and for the one-off cast.
+
 ## Errors
 
 HTTP failures throw exceptions that all extend `NHLApiException`, which has

package/dist/api/edge.d.mts

@@ -1,5 +1,6 @@
 import type { Context } from '#src/context.mjs';
-import type { Id, JsonObject } from '#src/utils.mjs';
+import type { CatGoalieDetail, CatSkaterDetail, Goalie5v5Detail, GoalieComparison, GoalieDetail, GoalieLanding, GoalieSavePercentageDetail, GoalieShotLocationDetail, SkaterComparison, SkaterDetail, SkaterLanding, SkaterShotLocationDetail, SkaterShotSpeedDetail, SkaterSkatingDistanceDetail, SkaterSkatingSpeedDetail, SkaterZoneTime, TeamDetail, TeamLanding, TeamShotLocationDetail, TeamShotSpeedDetail, TeamSkatingDistanceDetail, TeamSkatingSpeedDetail, TeamZoneTimeDetails } from '#src/types/index.mjs';
+import type { Id } from '#src/utils.mjs';
 export interface EdgeSeasonParams {
     /** Season in YYYYYYYY format, e.g. 20232024. Defaults to the current season ("now"). */
     season?: Id;
@@ -19,139 +20,139 @@ export interface EdgeTeamParams extends EdgeSeasonParams {
  *
  * @example await client.edge.skaterDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export declare const skaterDetail: (ctx: Context, params: EdgePlayerParams) => Promise<JsonObject>;
+export declare const skaterDetail: (ctx: Context, params: EdgePlayerParams) => Promise<SkaterDetail>;
 /**
  * Get NHL EDGE shot speed details for a specific skater.
  *
  * @example await client.edge.skaterShotSpeedDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export declare const skaterShotSpeedDetail: (ctx: Context, params: EdgePlayerParams) => Promise<JsonObject>;
+export declare const skaterShotSpeedDetail: (ctx: Context, params: EdgePlayerParams) => Promise<SkaterShotSpeedDetail>;
 /**
  * Get NHL EDGE skating speed details for a specific skater.
  *
  * @example await client.edge.skaterSkatingSpeedDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export declare const skaterSkatingSpeedDetail: (ctx: Context, params: EdgePlayerParams) => Promise<JsonObject>;
+export declare const skaterSkatingSpeedDetail: (ctx: Context, params: EdgePlayerParams) => Promise<SkaterSkatingSpeedDetail>;
 /**
  * Get NHL EDGE shot location details for a specific skater.
  *
  * @example await client.edge.skaterShotLocationDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export declare const skaterShotLocationDetail: (ctx: Context, params: EdgePlayerParams) => Promise<JsonObject>;
+export declare const skaterShotLocationDetail: (ctx: Context, params: EdgePlayerParams) => Promise<SkaterShotLocationDetail>;
 /**
  * Get NHL EDGE skating distance details for a specific skater.
  *
  * @example await client.edge.skaterSkatingDistanceDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export declare const skaterSkatingDistanceDetail: (ctx: Context, params: EdgePlayerParams) => Promise<JsonObject>;
+export declare const skaterSkatingDistanceDetail: (ctx: Context, params: EdgePlayerParams) => Promise<SkaterSkatingDistanceDetail>;
 /**
  * Get NHL EDGE comparison statistics for a specific skater.
  *
  * @example await client.edge.skaterComparison({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export declare const skaterComparison: (ctx: Context, params: EdgePlayerParams) => Promise<JsonObject>;
+export declare const skaterComparison: (ctx: Context, params: EdgePlayerParams) => Promise<SkaterComparison>;
 /**
  * Get NHL EDGE zone time details for a specific skater.
  *
  * @example await client.edge.skaterZoneTime({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export declare const skaterZoneTime: (ctx: Context, params: EdgePlayerParams) => Promise<JsonObject>;
+export declare const skaterZoneTime: (ctx: Context, params: EdgePlayerParams) => Promise<SkaterZoneTime>;
 /**
  * Get NHL EDGE skater landing page data.
  *
  * @example await client.edge.skaterLanding({ season: '20232024' })
  */
-export declare const skaterLanding: (ctx: Context, params?: EdgeSeasonParams) => Promise<JsonObject>;
+export declare const skaterLanding: (ctx: Context, params?: EdgeSeasonParams) => Promise<SkaterLanding>;
 /**
  * Get NHL CAT (Catch All Tracking) EDGE skater details.
  *
  * @example await client.edge.catSkaterDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export declare const catSkaterDetail: (ctx: Context, params: EdgePlayerParams) => Promise<JsonObject>;
+export declare const catSkaterDetail: (ctx: Context, params: EdgePlayerParams) => Promise<CatSkaterDetail>;
 /**
  * Get NHL EDGE goalie detail statistics for a specific player.
  *
  * @example await client.edge.goalieDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export declare const goalieDetail: (ctx: Context, params: EdgePlayerParams) => Promise<JsonObject>;
+export declare const goalieDetail: (ctx: Context, params: EdgePlayerParams) => Promise<GoalieDetail>;
 /**
  * Get NHL EDGE shot location details for a specific goalie.
  *
  * @example await client.edge.goalieShotLocationDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export declare const goalieShotLocationDetail: (ctx: Context, params: EdgePlayerParams) => Promise<JsonObject>;
+export declare const goalieShotLocationDetail: (ctx: Context, params: EdgePlayerParams) => Promise<GoalieShotLocationDetail>;
 /**
  * Get NHL EDGE 5v5 performance details for a specific goalie.
  *
  * @example await client.edge.goalie5v5Detail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export declare const goalie5v5Detail: (ctx: Context, params: EdgePlayerParams) => Promise<JsonObject>;
+export declare const goalie5v5Detail: (ctx: Context, params: EdgePlayerParams) => Promise<Goalie5v5Detail>;
 /**
  * Get NHL EDGE comparison statistics for a specific goalie.
  *
  * @example await client.edge.goalieComparison({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export declare const goalieComparison: (ctx: Context, params: EdgePlayerParams) => Promise<JsonObject>;
+export declare const goalieComparison: (ctx: Context, params: EdgePlayerParams) => Promise<GoalieComparison>;
 /**
  * Get NHL EDGE save percentage details for a specific goalie.
  *
  * @example await client.edge.goalieSavePercentageDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export declare const goalieSavePercentageDetail: (ctx: Context, params: EdgePlayerParams) => Promise<JsonObject>;
+export declare const goalieSavePercentageDetail: (ctx: Context, params: EdgePlayerParams) => Promise<GoalieSavePercentageDetail>;
 /**
  * Get NHL EDGE goalie landing page data.
  *
  * @example await client.edge.goalieLanding({ season: '20232024' })
  */
-export declare const goalieLanding: (ctx: Context, params?: EdgeSeasonParams) => Promise<JsonObject>;
+export declare const goalieLanding: (ctx: Context, params?: EdgeSeasonParams) => Promise<GoalieLanding>;
 /**
  * Get NHL CAT (Catch All Tracking) EDGE goalie details.
  *
  * @example await client.edge.catGoalieDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export declare const catGoalieDetail: (ctx: Context, params: EdgePlayerParams) => Promise<JsonObject>;
+export declare const catGoalieDetail: (ctx: Context, params: EdgePlayerParams) => Promise<CatGoalieDetail>;
 /**
  * Get NHL EDGE team detail statistics for a specific team.
  *
  * @example await client.edge.teamDetail({ teamId: 10 })
  */
-export declare const teamDetail: (ctx: Context, params: EdgeTeamParams) => Promise<JsonObject>;
+export declare const teamDetail: (ctx: Context, params: EdgeTeamParams) => Promise<TeamDetail>;
 /**
  * Get NHL EDGE skating distance details for a specific team.
  *
  * @example await client.edge.teamSkatingDistanceDetail({ teamId: 10 })
  */
-export declare const teamSkatingDistanceDetail: (ctx: Context, params: EdgeTeamParams) => Promise<JsonObject>;
+export declare const teamSkatingDistanceDetail: (ctx: Context, params: EdgeTeamParams) => Promise<TeamSkatingDistanceDetail>;
 /**
  * Get NHL EDGE zone time details for a specific team.
  *
  * @example await client.edge.teamZoneTimeDetails({ teamId: 10 })
  */
-export declare const teamZoneTimeDetails: (ctx: Context, params: EdgeTeamParams) => Promise<JsonObject>;
+export declare const teamZoneTimeDetails: (ctx: Context, params: EdgeTeamParams) => Promise<TeamZoneTimeDetails>;
 /**
  * Get NHL EDGE shot location details for a specific team.
  *
  * @example await client.edge.teamShotLocationDetail({ teamId: 10 })
  */
-export declare const teamShotLocationDetail: (ctx: Context, params: EdgeTeamParams) => Promise<JsonObject>;
+export declare const teamShotLocationDetail: (ctx: Context, params: EdgeTeamParams) => Promise<TeamShotLocationDetail>;
 /**
  * Get NHL EDGE team landing page data.
  *
  * @example await client.edge.teamLanding({ season: '20232024' })
  */
-export declare const teamLanding: (ctx: Context, params?: EdgeSeasonParams) => Promise<JsonObject>;
+export declare const teamLanding: (ctx: Context, params?: EdgeSeasonParams) => Promise<TeamLanding>;
 /**
  * Get NHL EDGE shot speed details for a specific team.
  *
  * @example await client.edge.teamShotSpeedDetail({ teamId: 10 })
  */
-export declare const teamShotSpeedDetail: (ctx: Context, params: EdgeTeamParams) => Promise<JsonObject>;
+export declare const teamShotSpeedDetail: (ctx: Context, params: EdgeTeamParams) => Promise<TeamShotSpeedDetail>;
 /**
  * Get NHL EDGE skating speed details for a specific team.
  *
  * @example await client.edge.teamSkatingSpeedDetail({ teamId: 10 })
  */
-export declare const teamSkatingSpeedDetail: (ctx: Context, params: EdgeTeamParams) => Promise<JsonObject>;
+export declare const teamSkatingSpeedDetail: (ctx: Context, params: EdgeTeamParams) => Promise<TeamSkatingSpeedDetail>;
 export declare const edgeApi: {
     readonly skaterDetail: typeof skaterDetail;
     readonly skaterShotSpeedDetail: typeof skaterShotSpeedDetail;

package/dist/api/game-center.d.mts

@@ -1,5 +1,6 @@
 import type { Context } from '#src/context.mjs';
-import type { Id, JsonObject } from '#src/utils.mjs';
+import type { Boxscore, DailyScores, GameLanding, GameStory, PlayByPlay, RightRail, ShiftChart } from '#src/types/index.mjs';
+import type { Id } from '#src/utils.mjs';
 /**
  * Get the full boxscore for a specific NHL game, including team scores,
  * shots on goal, and per-player stats.
@@ -9,7 +10,7 @@ import type { Id, JsonObject } from '#src/utils.mjs';
  */
 export declare const boxscore: (ctx: Context, { gameId }: {
     gameId: Id;
-}) => Promise<JsonObject>;
+}) => Promise<Boxscore>;
 /**
  * Get the full play-by-play feed for a specific NHL game, containing every
  * recorded event (shots, hits, faceoffs, goals, penalties...).
@@ -19,7 +20,7 @@ export declare const boxscore: (ctx: Context, { gameId }: {
  */
 export declare const playByPlay: (ctx: Context, { gameId }: {
     gameId: Id;
-}) => Promise<JsonObject>;
+}) => Promise<PlayByPlay>;
 /**
  * Get the landing-page summary for a specific NHL game, including scoring by
  * period, three stars and penalties.
@@ -29,7 +30,7 @@ export declare const playByPlay: (ctx: Context, { gameId }: {
  */
 export declare const matchUp: (ctx: Context, { gameId }: {
     gameId: Id;
-}) => Promise<JsonObject>;
+}) => Promise<GameLanding>;
 /**
  * Get scores and game states for all NHL games on a given date. Returns the
  * current day's scores when no date is supplied.
@@ -39,7 +40,7 @@ export declare const matchUp: (ctx: Context, { gameId }: {
  */
 export declare const dailyScores: (ctx: Context, { date }?: {
     date?: string;
-}) => Promise<JsonObject>;
+}) => Promise<DailyScores>;
 /**
  * Get individual player shift data for a specific game, including start/end
  * times and durations.
@@ -51,7 +52,7 @@ export declare const dailyScores: (ctx: Context, { date }?: {
 export declare const shiftChartData: (ctx: Context, { gameId, excludes }: {
     gameId: Id;
     excludes?: string[];
-}) => Promise<JsonObject>;
+}) => Promise<ShiftChart>;
 /**
  * Get the season-series record and contextual stats for a specific game,
  * including team season stats and last games.
@@ -61,7 +62,7 @@ export declare const shiftChartData: (ctx: Context, { gameId, excludes }: {
  */
 export declare const seasonSeriesMatchup: (ctx: Context, { gameId }: {
     gameId: Id;
-}) => Promise<JsonObject>;
+}) => Promise<RightRail>;
 /**
  * Get the narrative game story for a specific game, including scoring
  * summaries, three stars and team game stats.
@@ -71,7 +72,7 @@ export declare const seasonSeriesMatchup: (ctx: Context, { gameId }: {
  */
 export declare const gameStory: (ctx: Context, { gameId }: {
     gameId: Id;
-}) => Promise<JsonObject>;
+}) => Promise<GameStory>;
 export declare const gameCenterApi: {
     readonly boxscore: typeof boxscore;
     readonly playByPlay: typeof playByPlay;

package/dist/api/helpers.d.mts

@@ -1,5 +1,6 @@
 import type { Context } from '#src/context.mjs';
-import type { Id, JsonObject } from '#src/utils.mjs';
+import type { AllPlayersEntry, PlayerSummaryStatistics } from '#src/types/index.mjs';
+import type { Id } from '#src/utils.mjs';
 /**
  * Gets all game IDs for a specified season by querying every team's
  * schedule. Games appear once per participating team, so ids may repeat.
@@ -25,7 +26,7 @@ export declare const gameIdsBySeason: (ctx: Context, { season, gameTypes, apiSle
 export declare const allPlayers: (ctx: Context, { season, apiSleepRate }: {
     season: Id;
     apiSleepRate?: number;
-}) => Promise<JsonObject[]>;
+}) => Promise<AllPlayersEntry[]>;
 /**
  * Gets summary statistics for every skater in a given season, merged with
  * the roster info from `allPlayers` (stat fields win on key collisions).
@@ -38,7 +39,7 @@ export declare const allPlayers: (ctx: Context, { season, apiSleepRate }: {
 export declare const allPlayersSummaryStatistics: (ctx: Context, { season, apiSleepRate }: {
     season: Id;
     apiSleepRate?: number;
-}) => Promise<JsonObject[]>;
+}) => Promise<PlayerSummaryStatistics[]>;
 export declare const helpersApi: {
     readonly gameIdsBySeason: typeof gameIdsBySeason;
     readonly allPlayers: typeof allPlayers;

package/dist/api/misc.d.mts

@@ -1,36 +1,36 @@
 import type { Context } from '#src/context.mjs';
-import type { JsonObject } from '#src/utils.mjs';
+import type { Country, DraftYear, GlossaryEntry, SeasonRules, StatsConfig } from '#src/types/index.mjs';
 /**
  * Gets the full NHL glossary of statistical terms and abbreviations.
  *
  * @example https://api.nhle.com/stats/rest/en/glossary?sort=fullName
  */
-export declare const glossary: (ctx: Context) => Promise<JsonObject[]>;
+export declare const glossary: (ctx: Context) => Promise<GlossaryEntry[]>;
 /**
  * Gets the stats API configuration, including available report types and
  * filters.
  *
  * @example https://api.nhle.com/stats/rest/en/config
  */
-export declare const config: (ctx: Context) => Promise<JsonObject>;
+export declare const config: (ctx: Context) => Promise<StatsConfig>;
 /**
  * Gets the list of countries recognized by the NHL.
  *
  * @example https://api.nhle.com/stats/rest/en/country
  */
-export declare const countries: (ctx: Context) => Promise<JsonObject[]>;
+export declare const countries: (ctx: Context) => Promise<Country[]>;
 /**
  * Gets rules and metadata for every NHL season on record.
  *
  * @example https://api.nhle.com/stats/rest/en/season
  */
-export declare const seasonSpecificRulesAndInfo: (ctx: Context) => Promise<JsonObject[]>;
+export declare const seasonSpecificRulesAndInfo: (ctx: Context) => Promise<SeasonRules[]>;
 /**
  * Gets the number of rounds for each NHL draft year.
  *
  * @example https://api.nhle.com/stats/rest/en/draft
  */
-export declare const draftYearAndRounds: (ctx: Context) => Promise<JsonObject[]>;
+export declare const draftYearAndRounds: (ctx: Context) => Promise<DraftYear[]>;
 export declare const miscApi: {
     readonly glossary: typeof glossary;
     readonly config: typeof config;

package/dist/api/players.d.mts

@@ -1,5 +1,6 @@
 import type { Context } from '#src/context.mjs';
-import type { Id, JsonObject } from '#src/utils.mjs';
+import type { Prospects, Roster } from '#src/types/index.mjs';
+import type { Id } from '#src/utils.mjs';
 /**
  * Gets prospects for a specific team, grouped by position.
  *
@@ -8,7 +9,7 @@ import type { Id, JsonObject } from '#src/utils.mjs';
  */
 export declare const prospectsByTeam: (ctx: Context, { teamAbbr }: {
     teamAbbr: string;
-}) => Promise<JsonObject>;
+}) => Promise<Prospects>;
 /**
  * Gets the roster for a given team and season, grouped by position
  * (forwards, defensemen, goalies). Same data as `teams.teamRoster`.
@@ -20,7 +21,7 @@ export declare const prospectsByTeam: (ctx: Context, { teamAbbr }: {
 export declare const playersByTeam: (ctx: Context, { teamAbbr, season }: {
     teamAbbr: string;
     season: Id;
-}) => Promise<JsonObject>;
+}) => Promise<Roster>;
 export declare const playersApi: {
     readonly prospectsByTeam: typeof prospectsByTeam;
     readonly playersByTeam: typeof playersByTeam;

package/dist/api/query/builder.d.mts

@@ -15,6 +15,8 @@ export interface QueryContext {
  * filters are skipped and their errors collected; valid filters are joined
  * with " and ".
  */
+/** Fact filter `buildQuery` applies unless told otherwise. */
+export declare const DEFAULT_FACT_QUERY = "gamesPlayed>=1";
 export declare function buildQuery(filters: readonly Filter[], factQuery?: string): QueryContext;
 /** True if there are no validation errors. */
 export declare function isValidQuery(context: QueryContext): boolean;

package/dist/api/query/builder.mjs

@@ -4,7 +4,9 @@ import { toQuery, validateFilter } from '#src/api/query/filters.mjs';
  * filters are skipped and their errors collected; valid filters are joined
  * with " and ".
  */
-export function buildQuery(filters, factQuery = 'gamesPlayed>=1') {
+/** Fact filter `buildQuery` applies unless told otherwise. */
+export const DEFAULT_FACT_QUERY = 'gamesPlayed>=1';
+export function buildQuery(filters, factQuery = DEFAULT_FACT_QUERY) {
     const outputFilters = [];
     const errors = [];
     for (const filter of filters) {

package/dist/api/query/index.d.mts

@@ -1,4 +1,4 @@
 export { buildQuery, isValidQuery, type QueryContext, } from '#src/api/query/builder.mjs';
 export * from '#src/api/query/filters.mjs';
-export { goalieStatsSorts } from '#src/api/query/sorting/goalie-sorts.mjs';
-export { defaultSortForReport, SKATER_REPORT_TYPES, type SortExpr, } from '#src/api/query/sorting/sorting-options.mjs';
+export { type GoalieReportType, goalieStatsSorts, } from '#src/api/query/sorting/goalie-sorts.mjs';
+export { defaultSortForReport, SKATER_REPORT_TYPES, type SkaterReportType, type SortExpr, } from '#src/api/query/sorting/sorting-options.mjs';

package/dist/api/query/index.mjs

@@ -1,4 +1,4 @@
 export { buildQuery, isValidQuery, } from '#src/api/query/builder.mjs';
 export * from '#src/api/query/filters.mjs';
-export { goalieStatsSorts } from '#src/api/query/sorting/goalie-sorts.mjs';
+export { goalieStatsSorts, } from '#src/api/query/sorting/goalie-sorts.mjs';
 export { defaultSortForReport, SKATER_REPORT_TYPES, } from '#src/api/query/sorting/sorting-options.mjs';

package/dist/api/query/sorting/goalie-sorts.d.mts

@@ -1,4 +1,59 @@
 import type { SortExpr } from '#src/api/query/sorting/sorting-options.mjs';
+/** Default sort criteria per goalie report type. */
+export declare const goalieSortingByReport: {
+    summary: SortExpr[];
+    advanced: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    bios: ({
+        property: string;
+        direction: "ASC_CI";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    daysrest: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    penaltyShots: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    savesByStrength: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    shootout: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+    startedVsRelieved: ({
+        property: string;
+        direction: "DESC";
+    } | {
+        property: string;
+        direction: "ASC";
+    })[];
+};
+/** Goalie report types that have a default sort configured. */
+export type GoalieReportType = keyof typeof goalieSortingByReport;
 /**
  * Default sorting criteria for goalie stats reports. Falls back to the
  * goalie summary sort for unknown report types.

package/dist/api/query/sorting/goalie-sorts.mjs

@@ -3,57 +3,52 @@ const goalieSummaryDefaultSorting = [
     { property: 'gamesPlayed', direction: 'ASC' },
     { property: 'playerId', direction: 'ASC' },
 ];
+/** Default sort criteria per goalie report type. */
+export const goalieSortingByReport = {
+    summary: goalieSummaryDefaultSorting,
+    advanced: [
+        { property: 'qualityStart', direction: 'DESC' },
+        { property: 'goalsAgainstAverage', direction: 'ASC' },
+        { property: 'playerId', direction: 'ASC' },
+    ],
+    bios: [
+        { property: 'lastName', direction: 'ASC_CI' },
+        { property: 'goalieFullName', direction: 'ASC_CI' },
+        { property: 'playerId', direction: 'ASC' },
+    ],
+    daysrest: [
+        { property: 'wins', direction: 'DESC' },
+        { property: 'savePct', direction: 'DESC' },
+        { property: 'playerId', direction: 'ASC' },
+    ],
+    penaltyShots: [
+        { property: 'penaltyShotsSaves', direction: 'DESC' },
+        { property: 'penaltyShotSavePct', direction: 'DESC' },
+        { property: 'playerId', direction: 'ASC' },
+    ],
+    savesByStrength: [
+        { property: 'wins', direction: 'DESC' },
+        { property: 'savePct', direction: 'DESC' },
+        { property: 'playerId', direction: 'ASC' },
+    ],
+    shootout: [
+        { property: 'shootoutWins', direction: 'DESC' },
+        { property: 'shootoutSavePct', direction: 'DESC' },
+        { property: 'playerId', direction: 'ASC' },
+    ],
+    startedVsRelieved: [
+        { property: 'gamesStarted', direction: 'DESC' },
+        { property: 'gamesStartedSavePct', direction: 'DESC' },
+        { property: 'playerId', direction: 'ASC' },
+    ],
+};
+const sortingLookup = goalieSortingByReport;
 /**
  * Default sorting criteria for goalie stats reports. Falls back to the
  * goalie summary sort for unknown report types.
  */
 export function goalieStatsSorts(report) {
-    switch (report) {
-        case 'summary':
-            return goalieSummaryDefaultSorting;
-        case 'advanced':
-            return [
-                { property: 'qualityStart', direction: 'DESC' },
-                { property: 'goalsAgainstAverage', direction: 'ASC' },
-                { property: 'playerId', direction: 'ASC' },
-            ];
-        case 'bios':
-            return [
-                { property: 'lastName', direction: 'ASC_CI' },
-                { property: 'goalieFullName', direction: 'ASC_CI' },
-                { property: 'playerId', direction: 'ASC' },
-            ];
-        case 'daysrest':
-            return [
-                { property: 'wins', direction: 'DESC' },
-                { property: 'savePct', direction: 'DESC' },
-                { property: 'playerId', direction: 'ASC' },
-            ];
-        case 'penaltyShots':
-            return [
-                { property: 'penaltyShotsSaves', direction: 'DESC' },
-                { property: 'penaltyShotSavePct', direction: 'DESC' },
-                { property: 'playerId', direction: 'ASC' },
-            ];
-        case 'savesByStrength':
-            return [
-                { property: 'wins', direction: 'DESC' },
-                { property: 'savePct', direction: 'DESC' },
-                { property: 'playerId', direction: 'ASC' },
-            ];
-        case 'shootout':
-            return [
-                { property: 'shootoutWins', direction: 'DESC' },
-                { property: 'shootoutSavePct', direction: 'DESC' },
-                { property: 'playerId', direction: 'ASC' },
-            ];
-        case 'startedVsRelieved':
-            return [
-                { property: 'gamesStarted', direction: 'DESC' },
-                { property: 'gamesStartedSavePct', direction: 'DESC' },
-                { property: 'playerId', direction: 'ASC' },
-            ];
-        default:
-            return goalieSummaryDefaultSorting;
-    }
+    return ((Object.hasOwn(sortingLookup, report)
+        ? sortingLookup[report]
+        : undefined) ?? goalieSummaryDefaultSorting);
 }