nhl-api-ts 0.0.0-stage → 0.2.0

package/dist/api/edge.mjs

@@ -0,0 +1,184 @@
+import { Endpoint } from '#src/http-client.mjs';
+/** "<path>/<id>/now" when no season is given, else "<path>/<id>/<season>/<gameType>". */
+function edgeResource(path, id, { season, gameType = 2 }) {
+    const base = id === undefined ? path : `${path}/${id}`;
+    if (season === undefined || season === null) {
+        return `${base}/now`;
+    }
+    return `${base}/${season}/${gameType}`;
+}
+async function getEdge(ctx, path, id, params) {
+    return (await ctx.get(Endpoint.API_WEB_V1, edgeResource(path, id, params))).json();
+}
+// ========================
+// SKATER ENDPOINTS
+// ========================
+/**
+ * Get NHL EDGE skater detail statistics for a specific player.
+ *
+ * @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);
+/**
+ * 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);
+/**
+ * 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);
+/**
+ * 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);
+/**
+ * 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);
+/**
+ * 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);
+/**
+ * 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);
+/**
+ * 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);
+/**
+ * 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);
+// ========================
+// GOALIE ENDPOINTS
+// ========================
+/**
+ * Get NHL EDGE goalie detail statistics for a specific player.
+ *
+ * @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);
+/**
+ * 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);
+/**
+ * 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);
+/**
+ * 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);
+/**
+ * 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);
+/**
+ * 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);
+/**
+ * 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);
+// ========================
+// TEAM ENDPOINTS
+// ========================
+/**
+ * Get NHL EDGE team detail statistics for a specific team.
+ *
+ * @example await client.edge.teamDetail({ teamId: 10 })
+ */
+export const teamDetail = async (ctx, params) => 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);
+/**
+ * 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);
+/**
+ * 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);
+/**
+ * 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);
+/**
+ * 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);
+/**
+ * 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 const edgeApi = {
+    skaterDetail,
+    skaterShotSpeedDetail,
+    skaterSkatingSpeedDetail,
+    skaterShotLocationDetail,
+    skaterSkatingDistanceDetail,
+    skaterComparison,
+    skaterZoneTime,
+    skaterLanding,
+    catSkaterDetail,
+    goalieDetail,
+    goalieShotLocationDetail,
+    goalie5v5Detail,
+    goalieComparison,
+    goalieSavePercentageDetail,
+    goalieLanding,
+    catGoalieDetail,
+    teamDetail,
+    teamSkatingDistanceDetail,
+    teamZoneTimeDetails,
+    teamShotLocationDetail,
+    teamLanding,
+    teamShotSpeedDetail,
+    teamSkatingSpeedDetail,
+};

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

@@ -0,0 +1,84 @@
+import type { Context } from '#src/context.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.
+ *
+ * @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 }: {
+    gameId: Id;
+}) => Promise<Boxscore>;
+/**
+ * Get the full play-by-play feed for a specific NHL game, containing every
+ * recorded event (shots, hits, faceoffs, goals, penalties...).
+ *
+ * @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 }: {
+    gameId: Id;
+}) => Promise<PlayByPlay>;
+/**
+ * Get the landing-page summary for a specific NHL game, including scoring by
+ * period, three stars and penalties.
+ *
+ * @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 }: {
+    gameId: Id;
+}) => 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.
+ *
+ * @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 }?: {
+    date?: string;
+}) => Promise<DailyScores>;
+/**
+ * Get individual player shift data for a specific game, including start/end
+ * times and durations.
+ *
+ * @param params.gameId Game id, e.g. 2023020280
+ * @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 }: {
+    gameId: Id;
+    excludes?: string[];
+}) => Promise<ShiftChart>;
+/**
+ * Get the season-series record and contextual stats for a specific game,
+ * including team season stats and last games.
+ *
+ * @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 }: {
+    gameId: Id;
+}) => Promise<RightRail>;
+/**
+ * Get the narrative game story for a specific game, including scoring
+ * summaries, three stars and team game stats.
+ *
+ * @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 }: {
+    gameId: Id;
+}) => Promise<GameStory>;
+export declare const gameCenterApi: {
+    readonly boxscore: typeof boxscore;
+    readonly playByPlay: typeof playByPlay;
+    readonly matchUp: typeof matchUp;
+    readonly dailyScores: typeof dailyScores;
+    readonly shiftChartData: typeof shiftChartData;
+    readonly seasonSeriesMatchup: typeof seasonSeriesMatchup;
+    readonly gameStory: typeof gameStory;
+};

package/dist/api/game-center.mjs

@@ -0,0 +1,74 @@
+import { Endpoint } from '#src/http-client.mjs';
+async function getWeb(ctx, resource) {
+    return (await ctx.get(Endpoint.API_WEB_V1, resource)).json();
+}
+/**
+ * Get the full boxscore for a specific NHL game, including team scores,
+ * shots on goal, and per-player stats.
+ *
+ * @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`);
+/**
+ * Get the full play-by-play feed for a specific NHL game, containing every
+ * recorded event (shots, hits, faceoffs, goals, penalties...).
+ *
+ * @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`);
+/**
+ * Get the landing-page summary for a specific NHL game, including scoring by
+ * period, three stars and penalties.
+ *
+ * @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`);
+/**
+ * Get scores and game states for all NHL games on a given date. Returns the
+ * current day's scores when no date is supplied.
+ *
+ * @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'}`);
+/**
+ * Get individual player shift data for a specific game, including start/end
+ * times and durations.
+ *
+ * @param params.gameId Game id, e.g. 2023020280
+ * @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'] }) => {
+    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.
+ *
+ * @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`);
+/**
+ * Get the narrative game story for a specific game, including scoring
+ * summaries, three stars and team game stats.
+ *
+ * @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 const gameCenterApi = {
+    boxscore,
+    playByPlay,
+    matchUp,
+    dailyScores,
+    shiftChartData,
+    seasonSeriesMatchup,
+    gameStory,
+};

package/dist/api/helpers.d.mts

@@ -0,0 +1,47 @@
+import type { Context } from '#src/context.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.
+ *
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024
+ * @param params.gameTypes Only include these game types (1=Preseason, 2=Regular, 3=Playoffs). Defaults to all.
+ * @param params.apiSleepRate Seconds to sleep between team requests. Defaults to 1.
+ * @example await client.helpers.gameIdsBySeason({ season: '20232024', gameTypes: [2] })
+ */
+export declare const gameIdsBySeason: (ctx: Context, { season, gameTypes, apiSleepRate, }: {
+    season: Id;
+    gameTypes?: number[];
+    apiSleepRate?: number;
+}) => Promise<number[]>;
+/**
+ * Gets every rostered player across all NHL teams for a given season. Each
+ * player gets a `team` abbreviation and flattened `firstName` / `lastName`.
+ *
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024
+ * @param params.apiSleepRate Seconds to sleep between team requests. Defaults to 0.5.
+ * @example await client.helpers.allPlayers({ season: '20232024' })
+ */
+export declare const allPlayers: (ctx: Context, { season, apiSleepRate }: {
+    season: Id;
+    apiSleepRate?: number;
+}) => 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).
+ * Stat entries without a matching rostered player are included as-is.
+ *
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024
+ * @param params.apiSleepRate Seconds to sleep between team requests. Defaults to 1.
+ * @example await client.helpers.allPlayersSummaryStatistics({ season: '20232024' })
+ */
+export declare const allPlayersSummaryStatistics: (ctx: Context, { season, apiSleepRate }: {
+    season: Id;
+    apiSleepRate?: number;
+}) => Promise<PlayerSummaryStatistics[]>;
+export declare const helpersApi: {
+    readonly gameIdsBySeason: typeof gameIdsBySeason;
+    readonly allPlayers: typeof allPlayers;
+    readonly allPlayersSummaryStatistics: typeof allPlayersSummaryStatistics;
+};

package/dist/api/helpers.mjs

@@ -0,0 +1,106 @@
+import { buildQuery } from '#src/api/query/builder.mjs';
+import { filter } from '#src/api/query/filters.mjs';
+import { teamSeasonSchedule } from '#src/api/schedule.mjs';
+import { skaterStatsWithQueryContext } from '#src/api/stats.mjs';
+import { teams as fetchTeams, teamRoster } from '#src/api/teams.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.
+ *
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024
+ * @param params.gameTypes Only include these game types (1=Preseason, 2=Regular, 3=Playoffs). Defaults to all.
+ * @param params.apiSleepRate Seconds to sleep between team requests. Defaults to 1.
+ * @example await client.helpers.gameIdsBySeason({ season: '20232024', gameTypes: [2] })
+ */
+export const gameIdsBySeason = async (ctx, { season, gameTypes, apiSleepRate = 1, }) => {
+    const teams = await fetchTeams(ctx);
+    const gameIds = [];
+    for (const team of teams) {
+        const teamAbbr = team.abbr ?? '';
+        if (!teamAbbr) {
+            continue;
+        }
+        await ctx.sleep(apiSleepRate);
+        const schedule = await teamSeasonSchedule(ctx, { teamAbbr, season });
+        const games = schedule.games ?? [];
+        for (const game of games) {
+            const gameType = game.gameType;
+            const gameId = game.id;
+            if (gameId &&
+                (!gameTypes || gameTypes.length === 0 || gameTypes.includes(gameType))) {
+                gameIds.push(gameId);
+            }
+        }
+    }
+    return gameIds;
+};
+/**
+ * Gets every rostered player across all NHL teams for a given season. Each
+ * player gets a `team` abbreviation and flattened `firstName` / `lastName`.
+ *
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024
+ * @param params.apiSleepRate Seconds to sleep between team requests. Defaults to 0.5.
+ * @example await client.helpers.allPlayers({ season: '20232024' })
+ */
+export const allPlayers = async (ctx, { season, apiSleepRate = 0.5 }) => {
+    const teams = await fetchTeams(ctx);
+    console.error('Fetching all player base stats. This may take a while...');
+    const outData = [];
+    for (const team of teams) {
+        await ctx.sleep(apiSleepRate);
+        const players = await teamRoster(ctx, { teamAbbr: team.abbr, season });
+        for (const player of [
+            ...players.forwards,
+            ...players.defensemen,
+            ...players.goalies,
+        ]) {
+            outData.push({
+                ...player,
+                team: team.abbr,
+                firstName: player.firstName.default,
+                lastName: player.lastName.default,
+            });
+        }
+    }
+    return outData;
+};
+/**
+ * Gets summary statistics for every skater in a given season, merged with
+ * the roster info from `allPlayers` (stat fields win on key collisions).
+ * Stat entries without a matching rostered player are included as-is.
+ *
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024
+ * @param params.apiSleepRate Seconds to sleep between team requests. Defaults to 1.
+ * @example await client.helpers.allPlayersSummaryStatistics({ season: '20232024' })
+ */
+export const allPlayersSummaryStatistics = async (ctx, { season, apiSleepRate = 1 }) => {
+    console.error('WARNING: This method will take a while to run.  In the event of rate limiting, you may need to increase the api_sleep_rate.');
+    const players = await allPlayers(ctx, { season, apiSleepRate });
+    const teams = await fetchTeams(ctx);
+    const outData = [];
+    for (const team of teams) {
+        await ctx.sleep(apiSleepRate);
+        const context = buildQuery([
+            filter.franchise(team.franchise_id),
+            filter.season(season, season),
+        ]);
+        const data = await skaterStatsWithQueryContext(ctx, {
+            reportType: 'summary',
+            queryContext: context,
+            aggregate: true,
+        });
+        outData.push(...(data.data ?? []));
+    }
+    const playerById = new Map(players.map((player) => [player.id, player]));
+    return outData.map((statEntry) => {
+        const player = statEntry.playerId
+            ? playerById.get(statEntry.playerId)
+            : undefined;
+        return player ? { ...player, ...statEntry } : statEntry;
+    });
+};
+export const helpersApi = {
+    gameIdsBySeason,
+    allPlayers,
+    allPlayersSummaryStatistics,
+};

package/dist/api/misc.d.mts

@@ -0,0 +1,40 @@
+import type { Context } from '#src/context.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<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<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<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<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<DraftYear[]>;
+export declare const miscApi: {
+    readonly glossary: typeof glossary;
+    readonly config: typeof config;
+    readonly countries: typeof countries;
+    readonly seasonSpecificRulesAndInfo: typeof seasonSpecificRulesAndInfo;
+    readonly draftYearAndRounds: typeof draftYearAndRounds;
+};

package/dist/api/misc.mjs

@@ -0,0 +1,43 @@
+import { Endpoint } from '#src/http-client.mjs';
+async function getData(ctx, resource) {
+    const response = await (await ctx.get(Endpoint.API_CORE, resource)).json();
+    return response.data ?? [];
+}
+/**
+ * Gets the full NHL glossary of statistical terms and abbreviations.
+ *
+ * @example https://api.nhle.com/stats/rest/en/glossary?sort=fullName
+ */
+export const glossary = async (ctx) => getData(ctx, 'stats/rest/en/glossary?sort=fullName');
+/**
+ * Gets the stats API configuration, including available report types and
+ * filters.
+ *
+ * @example https://api.nhle.com/stats/rest/en/config
+ */
+export const config = async (ctx) => (await ctx.get(Endpoint.API_CORE, 'stats/rest/en/config')).json();
+/**
+ * Gets the list of countries recognized by the NHL.
+ *
+ * @example https://api.nhle.com/stats/rest/en/country
+ */
+export const countries = async (ctx) => getData(ctx, 'stats/rest/en/country');
+/**
+ * Gets rules and metadata for every NHL season on record.
+ *
+ * @example https://api.nhle.com/stats/rest/en/season
+ */
+export const seasonSpecificRulesAndInfo = async (ctx) => getData(ctx, 'stats/rest/en/season');
+/**
+ * Gets the number of rounds for each NHL draft year.
+ *
+ * @example https://api.nhle.com/stats/rest/en/draft
+ */
+export const draftYearAndRounds = async (ctx) => getData(ctx, 'stats/rest/en/draft');
+export const miscApi = {
+    glossary,
+    config,
+    countries,
+    seasonSpecificRulesAndInfo,
+    draftYearAndRounds,
+};

package/dist/api/players.d.mts

@@ -0,0 +1,28 @@
+import type { Context } from '#src/context.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.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @example https://api-web.nhle.com/v1/prospects/BUF
+ */
+export declare const prospectsByTeam: (ctx: Context, { teamAbbr }: {
+    teamAbbr: string;
+}) => Promise<Prospects>;
+/**
+ * Gets the roster for a given team and season, grouped by position
+ * (forwards, defensemen, goalies). Same data as `teams.teamRoster`.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024
+ * @example https://api-web.nhle.com/v1/roster/BUF/20232024
+ */
+export declare const playersByTeam: (ctx: Context, { teamAbbr, season }: {
+    teamAbbr: string;
+    season: Id;
+}) => Promise<Roster>;
+export declare const playersApi: {
+    readonly prospectsByTeam: typeof prospectsByTeam;
+    readonly playersByTeam: typeof playersByTeam;
+};

package/dist/api/players.mjs

@@ -0,0 +1,18 @@
+import { Endpoint } from '#src/http-client.mjs';
+/**
+ * Gets prospects for a specific team, grouped by position.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @example https://api-web.nhle.com/v1/prospects/BUF
+ */
+export const prospectsByTeam = async (ctx, { teamAbbr }) => (await ctx.get(Endpoint.API_WEB_V1, `prospects/${teamAbbr}`)).json();
+/**
+ * Gets the roster for a given team and season, grouped by position
+ * (forwards, defensemen, goalies). Same data as `teams.teamRoster`.
+ *
+ * @param params.teamAbbr Team abbreviation, e.g. BUF, TOR
+ * @param params.season Season in YYYYYYYY format, e.g. 20232024
+ * @example https://api-web.nhle.com/v1/roster/BUF/20232024
+ */
+export const playersByTeam = async (ctx, { teamAbbr, season }) => (await ctx.get(Endpoint.API_WEB_V1, `roster/${teamAbbr}/${season}`)).json();
+export const playersApi = { prospectsByTeam, playersByTeam };

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

@@ -0,0 +1,22 @@
+import type { Filter } from '#src/api/query/filters.mjs';
+/**
+ * A container for query information and validation state: the constructed
+ * query string, the original filters, any validation errors and a base fact
+ * query (defaults to "gamesPlayed>=1").
+ */
+export interface QueryContext {
+    readonly query: string;
+    readonly filters: readonly Filter[];
+    readonly errors: readonly string[];
+    readonly factQuery: string;
+}
+/**
+ * Builds and validates a query string from a list of filters. Invalid
+ * 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;