nhl-api-ts 0.1.0 → 0.2.1

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
@@ -270,21 +290,26 @@ nhl-api-ts teams teams --compact | jq -r '.[].abbr'
 
 ## Development
 
+This package lives in a pnpm workspace. Run these from the
+[repository root](https://github.com/andrewangelle/nhl-api-ts):
+
 ```bash
 pnpm install
 pnpm test         # node:test, runs the TypeScript sources directly
 pnpm typecheck
 pnpm lint:check
-pnpm build        # emits dist/
+pnpm build        # emits packages/nhl-api-ts/dist/
 ```
 
-See [CONTRIBUTING.md](CONTRIBUTING.md) for the full set of checks, and
-[AGENTS.md](AGENTS.md) for repository conventions.
+See [CONTRIBUTING.md](https://github.com/andrewangelle/nhl-api-ts/blob/main/CONTRIBUTING.md)
+for the full set of checks, and
+[AGENTS.md](https://github.com/andrewangelle/nhl-api-ts/blob/main/AGENTS.md) for
+repository conventions.
 
 Try the CLI from source:
 
 ```bash
-node --conditions=source src/cli.mts --help
+node --conditions=source packages/nhl-api-ts/src/cli.mts --help
 ```
 
 ## Credits

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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function 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 function teamSkatingSpeedDetail(ctx: Context, params: EdgeTeamParams): Promise<TeamSkatingSpeedDetail>;
 export declare const edgeApi: {
     readonly skaterDetail: typeof skaterDetail;
     readonly skaterShotSpeedDetail: typeof skaterShotSpeedDetail;

package/dist/api/edge.mjs

@@ -18,55 +18,73 @@ async function getEdge(ctx, path, id, params) {
  *
  * @example await client.edge.skaterDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export const skaterDetail = async (ctx, params) => getEdge(ctx, 'edge/skater-detail', params.playerId, params);
+export async function skaterDetail(ctx, params) {
+    return getEdge(ctx, 'edge/skater-detail', params.playerId, params);
+}
 /**
  * Get NHL EDGE shot speed details for a specific skater.
  *
  * @example await client.edge.skaterShotSpeedDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export const skaterShotSpeedDetail = async (ctx, params) => getEdge(ctx, 'edge/skater-shot-speed-detail', params.playerId, params);
+export async function skaterShotSpeedDetail(ctx, params) {
+    return getEdge(ctx, 'edge/skater-shot-speed-detail', params.playerId, params);
+}
 /**
  * Get NHL EDGE skating speed details for a specific skater.
  *
  * @example await client.edge.skaterSkatingSpeedDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export const skaterSkatingSpeedDetail = async (ctx, params) => getEdge(ctx, 'edge/skater-skating-speed-detail', params.playerId, params);
+export async function skaterSkatingSpeedDetail(ctx, params) {
+    return getEdge(ctx, 'edge/skater-skating-speed-detail', params.playerId, params);
+}
 /**
  * Get NHL EDGE shot location details for a specific skater.
  *
  * @example await client.edge.skaterShotLocationDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export const skaterShotLocationDetail = async (ctx, params) => getEdge(ctx, 'edge/skater-shot-location-detail', params.playerId, params);
+export async function skaterShotLocationDetail(ctx, params) {
+    return getEdge(ctx, 'edge/skater-shot-location-detail', params.playerId, params);
+}
 /**
  * Get NHL EDGE skating distance details for a specific skater.
  *
  * @example await client.edge.skaterSkatingDistanceDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export const skaterSkatingDistanceDetail = async (ctx, params) => getEdge(ctx, 'edge/skater-skating-distance-detail', params.playerId, params);
+export async function skaterSkatingDistanceDetail(ctx, params) {
+    return getEdge(ctx, 'edge/skater-skating-distance-detail', params.playerId, params);
+}
 /**
  * Get NHL EDGE comparison statistics for a specific skater.
  *
  * @example await client.edge.skaterComparison({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export const skaterComparison = async (ctx, params) => getEdge(ctx, 'edge/skater-comparison', params.playerId, params);
+export async function skaterComparison(ctx, params) {
+    return getEdge(ctx, 'edge/skater-comparison', params.playerId, params);
+}
 /**
  * Get NHL EDGE zone time details for a specific skater.
  *
  * @example await client.edge.skaterZoneTime({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export const skaterZoneTime = async (ctx, params) => getEdge(ctx, 'edge/skater-zone-time', params.playerId, params);
+export async function skaterZoneTime(ctx, params) {
+    return getEdge(ctx, 'edge/skater-zone-time', params.playerId, params);
+}
 /**
  * Get NHL EDGE skater landing page data.
  *
  * @example await client.edge.skaterLanding({ season: '20232024' })
  */
-export const skaterLanding = async (ctx, params = {}) => getEdge(ctx, 'edge/skater-landing', undefined, params);
+export async function skaterLanding(ctx, params = {}) {
+    return getEdge(ctx, 'edge/skater-landing', undefined, params);
+}
 /**
  * Get NHL CAT (Catch All Tracking) EDGE skater details.
  *
  * @example await client.edge.catSkaterDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export const catSkaterDetail = async (ctx, params) => getEdge(ctx, 'cat/edge/skater-detail', params.playerId, params);
+export async function catSkaterDetail(ctx, params) {
+    return getEdge(ctx, 'cat/edge/skater-detail', params.playerId, params);
+}
 // ========================
 // GOALIE ENDPOINTS
 // ========================
@@ -75,43 +93,57 @@ export const catSkaterDetail = async (ctx, params) => getEdge(ctx, 'cat/edge/ska
  *
  * @example await client.edge.goalieDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export const goalieDetail = async (ctx, params) => getEdge(ctx, 'edge/goalie-detail', params.playerId, params);
+export async function goalieDetail(ctx, params) {
+    return getEdge(ctx, 'edge/goalie-detail', params.playerId, params);
+}
 /**
  * Get NHL EDGE shot location details for a specific goalie.
  *
  * @example await client.edge.goalieShotLocationDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export const goalieShotLocationDetail = async (ctx, params) => getEdge(ctx, 'edge/goalie-shot-location-detail', params.playerId, params);
+export async function goalieShotLocationDetail(ctx, params) {
+    return getEdge(ctx, 'edge/goalie-shot-location-detail', params.playerId, params);
+}
 /**
  * Get NHL EDGE 5v5 performance details for a specific goalie.
  *
  * @example await client.edge.goalie5v5Detail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export const goalie5v5Detail = async (ctx, params) => getEdge(ctx, 'edge/goalie-5v5-detail', params.playerId, params);
+export async function goalie5v5Detail(ctx, params) {
+    return getEdge(ctx, 'edge/goalie-5v5-detail', params.playerId, params);
+}
 /**
  * Get NHL EDGE comparison statistics for a specific goalie.
  *
  * @example await client.edge.goalieComparison({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export const goalieComparison = async (ctx, params) => getEdge(ctx, 'edge/goalie-comparison', params.playerId, params);
+export async function goalieComparison(ctx, params) {
+    return getEdge(ctx, 'edge/goalie-comparison', params.playerId, params);
+}
 /**
  * Get NHL EDGE save percentage details for a specific goalie.
  *
  * @example await client.edge.goalieSavePercentageDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export const goalieSavePercentageDetail = async (ctx, params) => getEdge(ctx, 'edge/goalie-save-percentage-detail', params.playerId, params);
+export async function goalieSavePercentageDetail(ctx, params) {
+    return getEdge(ctx, 'edge/goalie-save-percentage-detail', params.playerId, params);
+}
 /**
  * Get NHL EDGE goalie landing page data.
  *
  * @example await client.edge.goalieLanding({ season: '20232024' })
  */
-export const goalieLanding = async (ctx, params = {}) => getEdge(ctx, 'edge/goalie-landing', undefined, params);
+export async function goalieLanding(ctx, params = {}) {
+    return getEdge(ctx, 'edge/goalie-landing', undefined, params);
+}
 /**
  * Get NHL CAT (Catch All Tracking) EDGE goalie details.
  *
  * @example await client.edge.catGoalieDetail({ playerId: 8478402, season: '20232024', gameType: 2 })
  */
-export const catGoalieDetail = async (ctx, params) => getEdge(ctx, 'cat/edge/goalie-detail', params.playerId, params);
+export async function catGoalieDetail(ctx, params) {
+    return getEdge(ctx, 'cat/edge/goalie-detail', params.playerId, params);
+}
 // ========================
 // TEAM ENDPOINTS
 // ========================
@@ -120,43 +152,57 @@ export const catGoalieDetail = async (ctx, params) => getEdge(ctx, 'cat/edge/goa
  *
  * @example await client.edge.teamDetail({ teamId: 10 })
  */
-export const teamDetail = async (ctx, params) => getEdge(ctx, 'edge/team-detail', params.teamId, params);
+export async function teamDetail(ctx, params) {
+    return getEdge(ctx, 'edge/team-detail', params.teamId, params);
+}
 /**
  * Get NHL EDGE skating distance details for a specific team.
  *
  * @example await client.edge.teamSkatingDistanceDetail({ teamId: 10 })
  */
-export const teamSkatingDistanceDetail = async (ctx, params) => getEdge(ctx, 'edge/team-skating-distance-detail', params.teamId, params);
+export async function teamSkatingDistanceDetail(ctx, params) {
+    return getEdge(ctx, 'edge/team-skating-distance-detail', params.teamId, params);
+}
 /**
  * Get NHL EDGE zone time details for a specific team.
  *
  * @example await client.edge.teamZoneTimeDetails({ teamId: 10 })
  */
-export const teamZoneTimeDetails = async (ctx, params) => getEdge(ctx, 'edge/team-zone-time-details', params.teamId, params);
+export async function teamZoneTimeDetails(ctx, params) {
+    return getEdge(ctx, 'edge/team-zone-time-details', params.teamId, params);
+}
 /**
  * Get NHL EDGE shot location details for a specific team.
  *
  * @example await client.edge.teamShotLocationDetail({ teamId: 10 })
  */
-export const teamShotLocationDetail = async (ctx, params) => getEdge(ctx, 'edge/team-shot-location-detail', params.teamId, params);
+export async function teamShotLocationDetail(ctx, params) {
+    return getEdge(ctx, 'edge/team-shot-location-detail', params.teamId, params);
+}
 /**
  * Get NHL EDGE team landing page data.
  *
  * @example await client.edge.teamLanding({ season: '20232024' })
  */
-export const teamLanding = async (ctx, params = {}) => getEdge(ctx, 'edge/team-landing', undefined, params);
+export async function teamLanding(ctx, params = {}) {
+    return getEdge(ctx, 'edge/team-landing', undefined, params);
+}
 /**
  * Get NHL EDGE shot speed details for a specific team.
  *
  * @example await client.edge.teamShotSpeedDetail({ teamId: 10 })
  */
-export const teamShotSpeedDetail = async (ctx, params) => getEdge(ctx, 'edge/team-shot-speed-detail', params.teamId, params);
+export async function teamShotSpeedDetail(ctx, params) {
+    return getEdge(ctx, 'edge/team-shot-speed-detail', params.teamId, params);
+}
 /**
  * Get NHL EDGE skating speed details for a specific team.
  *
  * @example await client.edge.teamSkatingSpeedDetail({ teamId: 10 })
  */
-export const teamSkatingSpeedDetail = async (ctx, params) => getEdge(ctx, 'edge/team-skating-speed-detail', params.teamId, params);
+export async function teamSkatingSpeedDetail(ctx, params) {
+    return getEdge(ctx, 'edge/team-skating-speed-detail', params.teamId, params);
+}
 export const edgeApi = {
     skaterDetail,
     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.
@@ -7,9 +8,9 @@ import type { Id, JsonObject } from '#src/utils.mjs';
  * @param params.gameId Game id, e.g. 2023020280
  * @example https://api-web.nhle.com/v1/gamecenter/2023020280/boxscore
  */
-export declare const boxscore: (ctx: Context, { gameId }: {
+export declare function 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...).
@@ -17,9 +18,9 @@ export declare const boxscore: (ctx: Context, { gameId }: {
  * @param params.gameId Game id, e.g. 2023020280
  * @example https://api-web.nhle.com/v1/gamecenter/2023020280/play-by-play
  */
-export declare const playByPlay: (ctx: Context, { gameId }: {
+export declare function 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.
@@ -27,9 +28,9 @@ export declare const playByPlay: (ctx: Context, { gameId }: {
  * @param params.gameId Game id, e.g. 2023020280
  * @example https://api-web.nhle.com/v1/gamecenter/2023020280/landing
  */
-export declare const matchUp: (ctx: Context, { gameId }: {
+export declare function 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.
@@ -37,9 +38,9 @@ export declare const matchUp: (ctx: Context, { gameId }: {
  * @param params.date Date in YYYY-MM-DD format. Defaults to "now".
  * @example https://api-web.nhle.com/v1/score/2023-10-15
  */
-export declare const dailyScores: (ctx: Context, { date }?: {
+export declare function 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.
@@ -48,10 +49,10 @@ export declare const dailyScores: (ctx: Context, { date }?: {
  * @param params.excludes Fields to exclude from the response. Defaults to ["eventDetails"].
  * @example https://api.nhle.com/stats/rest/en/shiftcharts?cayenneExp=gameId=2023020280 and ...
  */
-export declare const shiftChartData: (ctx: Context, { gameId, excludes }: {
+export declare function 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.
@@ -59,9 +60,9 @@ export declare const shiftChartData: (ctx: Context, { gameId, excludes }: {
  * @param params.gameId Game id, e.g. 2023020280
  * @example https://api-web.nhle.com/v1/gamecenter/2023020280/right-rail
  */
-export declare const seasonSeriesMatchup: (ctx: Context, { gameId }: {
+export declare function 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.
@@ -69,9 +70,9 @@ export declare const seasonSeriesMatchup: (ctx: Context, { gameId }: {
  * @param params.gameId Game id, e.g. 2023020280
  * @example https://api-web.nhle.com/v1/wsc/game-story/2023020280
  */
-export declare const gameStory: (ctx: Context, { gameId }: {
+export declare function 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/game-center.mjs

@@ -9,7 +9,9 @@ async function getWeb(ctx, resource) {
  * @param params.gameId Game id, e.g. 2023020280
  * @example https://api-web.nhle.com/v1/gamecenter/2023020280/boxscore
  */
-export const boxscore = async (ctx, { gameId }) => getWeb(ctx, `gamecenter/${gameId}/boxscore`);
+export async function boxscore(ctx, { gameId }) {
+    return getWeb(ctx, `gamecenter/${gameId}/boxscore`);
+}
 /**
  * Get the full play-by-play feed for a specific NHL game, containing every
  * recorded event (shots, hits, faceoffs, goals, penalties...).
@@ -17,7 +19,9 @@ export const boxscore = async (ctx, { gameId }) => getWeb(ctx, `gamecenter/${gam
  * @param params.gameId Game id, e.g. 2023020280
  * @example https://api-web.nhle.com/v1/gamecenter/2023020280/play-by-play
  */
-export const playByPlay = async (ctx, { gameId }) => getWeb(ctx, `gamecenter/${gameId}/play-by-play`);
+export async function playByPlay(ctx, { gameId }) {
+    return getWeb(ctx, `gamecenter/${gameId}/play-by-play`);
+}
 /**
  * Get the landing-page summary for a specific NHL game, including scoring by
  * period, three stars and penalties.
@@ -25,7 +29,9 @@ export const playByPlay = async (ctx, { gameId }) => getWeb(ctx, `gamecenter/${g
  * @param params.gameId Game id, e.g. 2023020280
  * @example https://api-web.nhle.com/v1/gamecenter/2023020280/landing
  */
-export const matchUp = async (ctx, { gameId }) => getWeb(ctx, `gamecenter/${gameId}/landing`);
+export async function matchUp(ctx, { gameId }) {
+    return getWeb(ctx, `gamecenter/${gameId}/landing`);
+}
 /**
  * Get scores and game states for all NHL games on a given date. Returns the
  * current day's scores when no date is supplied.
@@ -33,7 +39,9 @@ export const matchUp = async (ctx, { gameId }) => getWeb(ctx, `gamecenter/${game
  * @param params.date Date in YYYY-MM-DD format. Defaults to "now".
  * @example https://api-web.nhle.com/v1/score/2023-10-15
  */
-export const dailyScores = async (ctx, { date } = {}) => getWeb(ctx, `score/${date ? date : 'now'}`);
+export async function dailyScores(ctx, { date } = {}) {
+    return getWeb(ctx, `score/${date ? date : 'now'}`);
+}
 /**
  * Get individual player shift data for a specific game, including start/end
  * times and durations.
@@ -42,11 +50,11 @@ export const dailyScores = async (ctx, { date } = {}) => getWeb(ctx, `score/${da
  * @param params.excludes Fields to exclude from the response. Defaults to ["eventDetails"].
  * @example https://api.nhle.com/stats/rest/en/shiftcharts?cayenneExp=gameId=2023020280 and ...
  */
-export const shiftChartData = async (ctx, { gameId, excludes = ['eventDetails'] }) => {
+export async function shiftChartData(ctx, { gameId, excludes = ['eventDetails'] }) {
     const excludeP = excludes.join(',');
     const exprP = `gameId=${gameId} and ((duration != '00:00' and typeCode = 517) or typeCode != 517 )`;
     return (await ctx.get(Endpoint.API_STATS, `en/shiftcharts?cayenneExp=${exprP}&exclude=${excludeP}`)).json();
-};
+}
 /**
  * Get the season-series record and contextual stats for a specific game,
  * including team season stats and last games.
@@ -54,7 +62,9 @@ export const shiftChartData = async (ctx, { gameId, excludes = ['eventDetails']
  * @param params.gameId Game id, e.g. 2023020280
  * @example https://api-web.nhle.com/v1/gamecenter/2023020280/right-rail
  */
-export const seasonSeriesMatchup = async (ctx, { gameId }) => getWeb(ctx, `gamecenter/${gameId}/right-rail`);
+export async function seasonSeriesMatchup(ctx, { gameId }) {
+    return getWeb(ctx, `gamecenter/${gameId}/right-rail`);
+}
 /**
  * Get the narrative game story for a specific game, including scoring
  * summaries, three stars and team game stats.
@@ -62,7 +72,9 @@ export const seasonSeriesMatchup = async (ctx, { gameId }) => getWeb(ctx, `gamec
  * @param params.gameId Game id, e.g. 2023020280
  * @example https://api-web.nhle.com/v1/wsc/game-story/2023020280
  */
-export const gameStory = async (ctx, { gameId }) => getWeb(ctx, `wsc/game-story/${gameId}`);
+export async function gameStory(ctx, { gameId }) {
+    return getWeb(ctx, `wsc/game-story/${gameId}`);
+}
 export const gameCenterApi = {
     boxscore,
     playByPlay,