nhl-api-ts 0.0.0-stage → 0.2.0

package/dist/api/teams.d.mts

@@ -0,0 +1,59 @@
+import type { Context } from '#src/context.mjs';
+import type { Franchise, Roster, StandingsEntry } from '#src/types/index.mjs';
+import type { Id } from '#src/utils.mjs';
+export interface Team {
+    conference: {
+        abbr: string;
+        name: string;
+    };
+    division: {
+        abbr: string;
+        name: string;
+    };
+    name: string;
+    common_name: string;
+    abbr: string;
+    logo: string;
+    franchise_id?: number;
+}
+/** Converts a raw standings entry into a `Team`. */
+export declare function toTeam(teamData: Partial<StandingsEntry>): Team;
+/**
+ * Adds a `franchise_id` to each team that has a matching franchise. Teams
+ * without a match are returned unchanged (no `franchise_id` key).
+ */
+export declare function withFranchiseIds(teams: readonly Team[], franchises: readonly Pick<Franchise, 'id' | 'fullName'>[]): Team[];
+/**
+ * Get a list of all NHL teams with conference, division, and franchise info.
+ *
+ * Team list is derived from the standings for the given date, then enriched
+ * with franchise ids.
+ *
+ * @param params.date Date in YYYY-MM-DD format. Defaults to "now".
+ * @example await client.teams.teams()
+ */
+export declare const teams: (ctx: Context, { date }?: {
+    date?: string;
+}) => Promise<Team[]>;
+/**
+ * Get the roster for the given team and season.
+ *
+ * @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 teamRoster: (ctx: Context, { teamAbbr, season }: {
+    teamAbbr: string;
+    season: Id;
+}) => Promise<Roster>;
+/**
+ * Get a list of all past and current NHL franchises.
+ *
+ * @example https://api.nhle.com/stats/rest/en/franchise
+ */
+export declare const franchises: (ctx: Context) => Promise<Franchise[]>;
+export declare const teamsApi: {
+    readonly teams: typeof teams;
+    readonly teamRoster: typeof teamRoster;
+    readonly franchises: typeof franchises;
+};

package/dist/api/teams.mjs

@@ -0,0 +1,91 @@
+import { Endpoint } from '#src/http-client.mjs';
+async function fetchStandingsData(ctx, date) {
+    const response = await (await ctx.get(Endpoint.API_WEB_V1, `standings/${date}`)).json();
+    return response.standings ?? [];
+}
+/** Converts a raw standings entry into a `Team`. */
+export function toTeam(teamData) {
+    const nestedDefault = (key) => teamData[key]?.default ?? '';
+    return {
+        conference: {
+            abbr: teamData.conferenceAbbrev ?? '',
+            name: teamData.conferenceName ?? '',
+        },
+        division: {
+            abbr: teamData.divisionAbbrev ?? '',
+            name: teamData.divisionName ?? '',
+        },
+        name: nestedDefault('teamName'),
+        common_name: nestedDefault('teamCommonName'),
+        abbr: nestedDefault('teamAbbrev'),
+        logo: teamData.teamLogo ?? '',
+    };
+}
+/** Find franchise ID for a team name, with fallbacks for known name mismatches. */
+function findFranchiseId(teamName, lookup) {
+    if (lookup.has(teamName)) {
+        return lookup.get(teamName);
+    }
+    // "Montreal Canadiens" vs "Montréal Canadiens", Utah's renames, etc.
+    for (const partial of ['Canadiens', 'Utah']) {
+        if (teamName.includes(partial)) {
+            for (const [franchiseName, franchiseId] of lookup) {
+                if (franchiseName.includes(partial)) {
+                    return franchiseId;
+                }
+            }
+            return undefined;
+        }
+    }
+    return undefined;
+}
+/**
+ * Adds a `franchise_id` to each team that has a matching franchise. Teams
+ * without a match are returned unchanged (no `franchise_id` key).
+ */
+export function withFranchiseIds(teams, franchises) {
+    const lookup = new Map();
+    for (const franchise of franchises) {
+        const fullName = franchise.fullName ?? '';
+        const franchiseId = franchise.id;
+        if (fullName && franchiseId) {
+            lookup.set(fullName, franchiseId);
+        }
+    }
+    return teams.map((team) => {
+        const franchiseId = findFranchiseId(team.name ?? '', lookup);
+        return franchiseId ? { ...team, franchise_id: franchiseId } : { ...team };
+    });
+}
+/**
+ * Get a list of all NHL teams with conference, division, and franchise info.
+ *
+ * Team list is derived from the standings for the given date, then enriched
+ * with franchise ids.
+ *
+ * @param params.date Date in YYYY-MM-DD format. Defaults to "now".
+ * @example await client.teams.teams()
+ */
+export const teams = async (ctx, { date = 'now' } = {}) => {
+    const standingsData = await fetchStandingsData(ctx, date);
+    const franchiseData = await franchises(ctx);
+    return withFranchiseIds(standingsData.map(toTeam), franchiseData);
+};
+/**
+ * Get the roster for the given team and season.
+ *
+ * @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 teamRoster = async (ctx, { teamAbbr, season }) => (await ctx.get(Endpoint.API_WEB_V1, `roster/${teamAbbr}/${season}`)).json();
+/**
+ * Get a list of all past and current NHL franchises.
+ *
+ * @example https://api.nhle.com/stats/rest/en/franchise
+ */
+export const franchises = async (ctx) => {
+    const response = await (await ctx.get(Endpoint.API_STATS, 'en/franchise')).json();
+    return response.data ?? [];
+};
+export const teamsApi = { teams, teamRoster, franchises };

package/dist/cli/colors.d.mts

@@ -0,0 +1,14 @@
+import { styleText } from 'node:util';
+export type Style = Parameters<typeof styleText>[0];
+export declare const toStdout: (format: Style) => (text: string) => string;
+export declare const toStderr: (format: Style) => (text: string) => string;
+export declare const colors: {
+    dim: (text: string) => string;
+    pass: (text: string) => string;
+    fail: (text: string) => string;
+    ok: (text: string) => string;
+    success: (text: string) => string;
+    error: (text: string) => string;
+    warn: (text: string) => string;
+    bold: (text: string) => string;
+};

package/dist/cli/colors.mjs

@@ -0,0 +1,13 @@
+import { styleText } from 'node:util';
+export const toStdout = (format) => (text) => styleText(format, text, { stream: process.stdout });
+export const toStderr = (format) => (text) => styleText(format, text, { stream: process.stderr });
+export const colors = {
+    dim: toStdout('dim'),
+    pass: toStdout(['bold', 'green']),
+    fail: toStdout(['bold', 'red']),
+    ok: toStdout('green'),
+    success: toStdout(['bold', 'green']),
+    error: toStderr('red'),
+    warn: toStderr('yellow'),
+    bold: toStderr('bold'),
+};

package/dist/cli/commands.d.mts

@@ -0,0 +1,27 @@
+import type { NHLClient } from '#src/nhl-client.mjs';
+export type ArgType = 'string' | 'int' | 'number' | 'boolean' | 'list' | 'int-list' | 'json';
+export interface ArgSpec {
+    /** SDK parameter name (camelCase). The CLI flag is its kebab-case form. */
+    name: string;
+    type: ArgType;
+    description: string;
+    required?: boolean;
+    /** Shown in help only; the SDK applies its own defaults. */
+    default?: string;
+    choices?: readonly string[];
+}
+export interface CommandSpec {
+    name: string;
+    description: string;
+    args: ArgSpec[];
+    run: (client: NHLClient, values: any) => Promise<unknown>;
+}
+export interface ModuleSpec {
+    name: string;
+    description: string;
+    commands: CommandSpec[];
+}
+/** Thrown for invalid command-line input (exit code 2). */
+export declare class UsageError extends Error {
+}
+export declare const MODULES: ModuleSpec[];