nhl-api-ts 0.0.0-stage → 0.1.0

package/dist/nhl-client.d.mts

@@ -0,0 +1,97 @@
+import { type ClientOptions } from '#src/config.mjs';
+import type { Context } from '#src/context.mjs';
+type Bound<Module> = {
+    [Method in keyof Module]: Module[Method] extends (ctx: Context, ...args: infer Args) => infer MethodResponse ? (...args: Args) => MethodResponse : never;
+};
+/**
+ * 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: Bound<{
+        readonly gametypesPerSeasonDirectoryByTeam: typeof import("#src/api/stats.mjs").gametypesPerSeasonDirectoryByTeam;
+        readonly playerCareerStats: typeof import("#src/api/stats.mjs").playerCareerStats;
+        readonly playerGameLog: typeof import("#src/api/stats.mjs").playerGameLog;
+        readonly teamSummary: typeof import("#src/api/stats.mjs").teamSummary;
+        readonly skaterStatsSummary: typeof import("#src/api/stats.mjs").skaterStatsSummary;
+        readonly skaterStatsWithQueryContext: typeof import("#src/api/stats.mjs").skaterStatsWithQueryContext;
+        readonly goalieStatsSummary: typeof import("#src/api/stats.mjs").goalieStatsSummary;
+    }>;
+    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/utils.d.mts

@@ -0,0 +1,5 @@
+/** Identifiers accepted by the API: player ids, game ids, seasons, etc. */
+export type Id = string | number;
+export type JsonObject = Record<string, any>;
+/** Sleeps for the given number of seconds. */
+export declare const sleep: (seconds: number) => Promise<void>;

package/dist/utils.mjs

@@ -0,0 +1,3 @@
+import { setTimeout as delay } from 'node:timers/promises';
+/** Sleeps for the given number of seconds. */
+export const sleep = (seconds) => delay(seconds * 1000);

package/package.json

@@ -1,6 +1,80 @@
 {
   "name": "nhl-api-ts",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "TypeScript SDK and CLI for the NHL API and NHL EDGE stats.",
+  "keywords": [
+    "nhl",
+    "api",
+    "hockey",
+    "sports",
+    "edge",
+    "stats",
+    "sdk",
+    "cli"
+  ],
+  "author": "andrewangelle@gmail.com",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/andrewangelle/nhl-api-ts.git"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "main": "dist/index.mjs",
+  "types": "dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "imports": {
+    "#src/*.mjs": {
+      "source": "./src/*.mts",
+      "types": "./dist/*.d.mts",
+      "default": "./dist/*.mjs"
+    }
+  },
+  "bin": {
+    "nhl-api-ts": "dist/cli.mjs"
+  },
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@biomejs/biome": "^2.5.15",
+    "@changesets/changelog-github": "^1.0.1",
+    "@changesets/cli": "^3.0.3",
+    "@microsoft/api-extractor": "^7.59.4",
+    "@types/node": "^26.2.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^17.3.0",
+    "typescript": "^7.0.2"
+  },
+  "lint-staged": {
+    "*.{ts,tsx,js,jsx,mts,mjs}": [
+      "pnpm lint:fix",
+      "pnpm format"
+    ]
+  },
+  "scripts": {
+    "build": "pnpm exec tsc",
+    "test": "node --conditions=source --test \"test/**/*.test.mts\"",
+    "test:update-snapshots": "node --conditions=source --test --test-update-snapshots \"test/**/*.test.mts\"",
+    "lint:fix": "pnpm exec biome check . --write",
+    "lint:check": "pnpm exec biome check .",
+    "format": "pnpm exec biome format . --write",
+    "pre-commit": "lint-staged",
+    "changeset": "changeset",
+    "version-packages": "changeset version",
+    "release": "pnpm build && changeset publish",
+    "typecheck": "pnpm exec tsc --noEmit",
+    "typecheck:examples": "pnpm exec tsc -p examples",
+    "api:report": "pnpm build && mkdir -p node_modules/.api-extractor && pnpm exec api-extractor run --local && cp node_modules/.api-extractor/nhl-api-ts.api.md api-report.md",
+    "docs:llms": "node scripts/build-llms-full.mts"
+  }
 }