nhl-api-ts 0.0.0-stage → 0.2.0

package/dist/nhl-client.d.mts

@@ -0,0 +1,101 @@
+import { type GoalieStatsSummaryParams, type SkaterStatsWithQueryContextParams, statsApi } from '#src/api/stats.mjs';
+import { type ClientOptions } from '#src/config.mjs';
+import type { Context } from '#src/context.mjs';
+import type { GoalieReportRows, SkaterReportRows, StatsApiPage } from '#src/types/index.mjs';
+type Bound<Module> = {
+    [Method in keyof Module]: Module[Method] extends (ctx: Context, ...args: infer Args) => infer MethodResponse ? (...args: Args) => MethodResponse : never;
+};
+/**
+ * `Bound` erases generic parameters, so the report-typed stats methods are
+ * spelled out here (without `ctx`) to keep `reportType` / `statsType`
+ * flowing into the row type.
+ */
+interface StatsGenericMethods {
+    skaterStatsWithQueryContext<Report extends keyof SkaterReportRows>(params: SkaterStatsWithQueryContextParams<Report>): Promise<StatsApiPage<SkaterReportRows[Report]>>;
+    goalieStatsSummary<Report extends keyof GoalieReportRows = 'summary'>(params: GoalieStatsSummaryParams<Report>): Promise<GoalieReportRows[Report][]>;
+}
+type StatsClient = Omit<Bound<typeof statsApi>, 'skaterStatsWithQueryContext' | 'goalieStatsSummary'> & StatsGenericMethods;
+/**
+ * Builds the main client used to access the NHL API.
+ *
+ * @example
+ * const client = createNHLClient();
+ * const client = createNHLClient({ debug: true }); // for a lil extra logging
+ * const teams = await client.teams.teams();
+ */
+export declare const createNHLClient: (options?: ClientOptions) => {
+    readonly config: Readonly<import("#src/config.mjs").Config>;
+    readonly teams: Bound<{
+        readonly teams: typeof import("#src/api/teams.mjs").teams;
+        readonly teamRoster: typeof import("#src/api/teams.mjs").teamRoster;
+        readonly franchises: typeof import("#src/api/teams.mjs").franchises;
+    }>;
+    readonly standings: Bound<{
+        readonly leagueStandings: typeof import("#src/api/standings.mjs").leagueStandings;
+        readonly seasonStandingManifest: typeof import("#src/api/standings.mjs").seasonStandingManifest;
+    }>;
+    readonly schedule: Bound<{
+        readonly dailySchedule: typeof import("#src/api/schedule.mjs").dailySchedule;
+        readonly weeklySchedule: typeof import("#src/api/schedule.mjs").weeklySchedule;
+        readonly teamMonthlySchedule: typeof import("#src/api/schedule.mjs").teamMonthlySchedule;
+        readonly teamWeeklySchedule: typeof import("#src/api/schedule.mjs").teamWeeklySchedule;
+        readonly teamSeasonSchedule: typeof import("#src/api/schedule.mjs").teamSeasonSchedule;
+        readonly calendarSchedule: typeof import("#src/api/schedule.mjs").calendarSchedule;
+        readonly playoffCarousel: typeof import("#src/api/schedule.mjs").playoffCarousel;
+        readonly playoffSeriesSchedule: typeof import("#src/api/schedule.mjs").playoffSeriesSchedule;
+        readonly playoffBracket: typeof import("#src/api/schedule.mjs").playoffBracket;
+    }>;
+    readonly gameCenter: Bound<{
+        readonly boxscore: typeof import("#src/api/game-center.mjs").boxscore;
+        readonly playByPlay: typeof import("#src/api/game-center.mjs").playByPlay;
+        readonly matchUp: typeof import("#src/api/game-center.mjs").matchUp;
+        readonly dailyScores: typeof import("#src/api/game-center.mjs").dailyScores;
+        readonly shiftChartData: typeof import("#src/api/game-center.mjs").shiftChartData;
+        readonly seasonSeriesMatchup: typeof import("#src/api/game-center.mjs").seasonSeriesMatchup;
+        readonly gameStory: typeof import("#src/api/game-center.mjs").gameStory;
+    }>;
+    readonly stats: StatsClient;
+    readonly misc: Bound<{
+        readonly glossary: typeof import("#src/api/misc.mjs").glossary;
+        readonly config: typeof import("#src/api/misc.mjs").config;
+        readonly countries: typeof import("#src/api/misc.mjs").countries;
+        readonly seasonSpecificRulesAndInfo: typeof import("#src/api/misc.mjs").seasonSpecificRulesAndInfo;
+        readonly draftYearAndRounds: typeof import("#src/api/misc.mjs").draftYearAndRounds;
+    }>;
+    readonly helpers: Bound<{
+        readonly gameIdsBySeason: typeof import("#src/api/helpers.mjs").gameIdsBySeason;
+        readonly allPlayers: typeof import("#src/api/helpers.mjs").allPlayers;
+        readonly allPlayersSummaryStatistics: typeof import("#src/api/helpers.mjs").allPlayersSummaryStatistics;
+    }>;
+    readonly players: Bound<{
+        readonly prospectsByTeam: typeof import("#src/api/players.mjs").prospectsByTeam;
+        readonly playersByTeam: typeof import("#src/api/players.mjs").playersByTeam;
+    }>;
+    readonly edge: Bound<{
+        readonly skaterDetail: typeof import("#src/api/edge.mjs").skaterDetail;
+        readonly skaterShotSpeedDetail: typeof import("#src/api/edge.mjs").skaterShotSpeedDetail;
+        readonly skaterSkatingSpeedDetail: typeof import("#src/api/edge.mjs").skaterSkatingSpeedDetail;
+        readonly skaterShotLocationDetail: typeof import("#src/api/edge.mjs").skaterShotLocationDetail;
+        readonly skaterSkatingDistanceDetail: typeof import("#src/api/edge.mjs").skaterSkatingDistanceDetail;
+        readonly skaterComparison: typeof import("#src/api/edge.mjs").skaterComparison;
+        readonly skaterZoneTime: typeof import("#src/api/edge.mjs").skaterZoneTime;
+        readonly skaterLanding: typeof import("#src/api/edge.mjs").skaterLanding;
+        readonly catSkaterDetail: typeof import("#src/api/edge.mjs").catSkaterDetail;
+        readonly goalieDetail: typeof import("#src/api/edge.mjs").goalieDetail;
+        readonly goalieShotLocationDetail: typeof import("#src/api/edge.mjs").goalieShotLocationDetail;
+        readonly goalie5v5Detail: typeof import("#src/api/edge.mjs").goalie5v5Detail;
+        readonly goalieComparison: typeof import("#src/api/edge.mjs").goalieComparison;
+        readonly goalieSavePercentageDetail: typeof import("#src/api/edge.mjs").goalieSavePercentageDetail;
+        readonly goalieLanding: typeof import("#src/api/edge.mjs").goalieLanding;
+        readonly catGoalieDetail: typeof import("#src/api/edge.mjs").catGoalieDetail;
+        readonly teamDetail: typeof import("#src/api/edge.mjs").teamDetail;
+        readonly teamSkatingDistanceDetail: typeof import("#src/api/edge.mjs").teamSkatingDistanceDetail;
+        readonly teamZoneTimeDetails: typeof import("#src/api/edge.mjs").teamZoneTimeDetails;
+        readonly teamShotLocationDetail: typeof import("#src/api/edge.mjs").teamShotLocationDetail;
+        readonly teamLanding: typeof import("#src/api/edge.mjs").teamLanding;
+        readonly teamShotSpeedDetail: typeof import("#src/api/edge.mjs").teamShotSpeedDetail;
+        readonly teamSkatingSpeedDetail: typeof import("#src/api/edge.mjs").teamSkatingSpeedDetail;
+    }>;
+};
+export type NHLClient = ReturnType<typeof createNHLClient>;
+export {};

package/dist/nhl-client.mjs

@@ -0,0 +1,40 @@
+import { edgeApi } from '#src/api/edge.mjs';
+import { gameCenterApi } from '#src/api/game-center.mjs';
+import { helpersApi } from '#src/api/helpers.mjs';
+import { miscApi } from '#src/api/misc.mjs';
+import { playersApi } from '#src/api/players.mjs';
+import { scheduleApi } from '#src/api/schedule.mjs';
+import { standingsApi } from '#src/api/standings.mjs';
+import { statsApi, } from '#src/api/stats.mjs';
+import { teamsApi } from '#src/api/teams.mjs';
+import { resolveConfig } from '#src/config.mjs';
+import { createGet } from '#src/http-client.mjs';
+import { sleep } from '#src/utils.mjs';
+const bind = (ctx, api) => Object.fromEntries(Object.entries(api).map(([key, fn]) => [
+    key,
+    (...args) => fn(ctx, ...args),
+]));
+/**
+ * Builds the main client used to access the NHL API.
+ *
+ * @example
+ * const client = createNHLClient();
+ * const client = createNHLClient({ debug: true }); // for a lil extra logging
+ * const teams = await client.teams.teams();
+ */
+export const createNHLClient = (options = {}) => {
+    const config = resolveConfig(options);
+    const ctx = { get: createGet(config), sleep };
+    return {
+        config,
+        teams: bind(ctx, teamsApi),
+        standings: bind(ctx, standingsApi),
+        schedule: bind(ctx, scheduleApi),
+        gameCenter: bind(ctx, gameCenterApi),
+        stats: bind(ctx, statsApi),
+        misc: bind(ctx, miscApi),
+        helpers: bind(ctx, helpersApi),
+        players: bind(ctx, playersApi),
+        edge: bind(ctx, edgeApi),
+    };
+};

package/dist/types/common.d.mts

@@ -0,0 +1,81 @@
+/**
+ * A string union that still accepts values the SDK doesn't know about yet.
+ * Autocomplete lists `Known`, but a new value from the NHL doesn't break
+ * consumers.
+ */
+export type OpenUnion<Known extends string> = Known | (string & {});
+/** A name or label with optional translations; `default` is always present. */
+export interface LocalizedString {
+    default: string;
+    cs?: string;
+    de?: string;
+    es?: string;
+    fi?: string;
+    fr?: string;
+    sk?: string;
+    sv?: string;
+}
+/** 1 = preseason, 2 = regular season, 3 = playoffs. Other codes (4 = all-star) exist. */
+export type GameType = 1 | 2 | 3 | (number & {});
+/** Season in YYYYYYYY form, e.g. 20232024. */
+export type SeasonId = number;
+export type GameState = OpenUnion<'FUT' | 'PRE' | 'LIVE' | 'CRIT' | 'FINAL' | 'OFF'>;
+export type GameScheduleState = OpenUnion<'OK' | 'PPD' | 'SUSP' | 'CNCL' | 'TBD'>;
+export type PeriodType = OpenUnion<'REG' | 'OT' | 'SO'>;
+export type PositionCode = OpenUnion<'C' | 'L' | 'R' | 'D' | 'G'>;
+export type ShootsCatches = OpenUnion<'L' | 'R'>;
+export type ZoneCode = OpenUnion<'O' | 'N' | 'D'>;
+export type ShotType = OpenUnion<'wrist' | 'snap' | 'slap' | 'backhand' | 'tip-in' | 'deflected' | 'wrap-around' | 'bat'>;
+/** Envelope of the stats API (`api.nhle.com/stats/rest`) for paged reports. */
+export interface StatsApiPage<Row> {
+    data: Row[];
+    total: number;
+}
+export interface GameOutcome {
+    lastPeriodType: PeriodType;
+    /** Low sample count */
+    otPeriods?: number;
+}
+export interface PeriodDescriptor {
+    number: number;
+    periodType: PeriodType;
+    maxRegulationPeriods: number;
+}
+export interface SeriesStatus {
+    round: number;
+    seriesAbbrev: string;
+    seriesTitle: string;
+    seriesLetter: string;
+    neededToWin: number;
+    topSeedTeamAbbrev: string;
+    topSeedWins: number;
+    bottomSeedTeamAbbrev: string;
+    bottomSeedWins: number;
+    gameNumberOfSeries: number;
+}
+export interface TeamLogo {
+    light: string;
+    dark: string;
+}
+export interface TvBroadcast {
+    id: number;
+    market: string;
+    countryCode: string;
+    network: string;
+    sequenceNumber: number;
+}
+export interface OddsPartner {
+    partnerId: number;
+    country: string;
+    name: string;
+    imageUrl: string;
+    siteUrl: string;
+    bgColor: string;
+    textColor: string;
+    accentColor: string;
+}
+/** A betting provider's price for one side of a game. */
+export interface TeamOdd {
+    providerId: number;
+    value: string;
+}

package/dist/types/common.mjs

@@ -0,0 +1,2 @@
+// Response types derived from live NHL API probing. See CONTRIBUTING.md.
+export {};