nhle-api 0.5.4 → 0.6.0

package/lib/nhl-B7Hg7iMB.d.cts

@@ -0,0 +1,462 @@
+/**
+ * Cayenne Expression Query Builder
+ * A utility for constructing cayenneExp filter strings for the NHL Stats API
+ * Cayenne expressions are filter strings used in the NHL Stats API to filter results
+ *
+ * Syntax: condition1=value1 and condition2=value2
+ * Example: seasonId=20232024 and gameTypeId=2
+ */
+/**
+ * Represents a single condition in a Cayenne expression
+ */
+interface CayenneCondition {
+    field: string;
+    operator: '=' | '!=' | '<' | '>' | '<=' | '>=' | 'in' | 'like';
+    value: string | number | (string | number)[];
+    logicalOp?: 'and' | 'or';
+}
+/**
+ * Represents a grouped set of conditions
+ */
+interface CayenneGroup {
+    type: 'group';
+    conditions: (CayenneCondition | CayenneGroup)[];
+    logicalOp?: 'and' | 'or';
+}
+/**
+ * Type for items that can be in the conditions array
+ */
+type CayenneExpression = CayenneCondition | CayenneGroup;
+/**
+ * Cayenne Expression Query Builder
+ * Provides a fluent API for building complex filter strings
+ */
+declare class CayenneQueryBuilder {
+    private conditions;
+    private currentLogicalOp;
+    private groupStack;
+    /**
+     * Start a new logical group
+     * All subsequent conditions will be added to this group until endGroup() is called
+     * @returns This builder instance for chaining
+     * @example
+     * builder
+     *   .equals('field1', 'value1')
+     *   .group()
+     *   .equals('field2', 'value2')
+     *   .or()
+     *   .equals('field3', 'value3')
+     *   .endGroup()
+     *   // Generates: "field1=value1 and (field2=value2 or field3=value3)"
+     */
+    group(): this;
+    /**
+     * End the current logical group
+     * @returns This builder instance for chaining
+     * @throws Error if there's no open group
+     */
+    endGroup(): this;
+    /**
+     * Set the logical operator to AND for subsequent conditions
+     * @returns This builder instance for chaining
+     */
+    and(): this;
+    /**
+     * Set the logical operator to OR for subsequent conditions
+     * @returns This builder instance for chaining
+     */
+    or(): this;
+    /**
+     * Add an equality condition
+     * @param field - The field name to filter on
+     * @param value - The value to match
+     * @returns This builder instance for chaining
+     */
+    equals(field: string, value: string | number): this;
+    /**
+     * Add a not-equal condition
+     * @param field - The field name to filter on
+     * @param value - The value to exclude
+     * @returns This builder instance for chaining
+     */
+    notEquals(field: string, value: string | number): this;
+    /**
+     * Add a less-than condition
+     * @param field - The field name to filter on
+     * @param value - The upper bound (exclusive)
+     * @returns This builder instance for chaining
+     */
+    lessThan(field: string, value: number): this;
+    /**
+     * Add a greater-than condition
+     * @param field - The field name to filter on
+     * @param value - The lower bound (exclusive)
+     * @returns This builder instance for chaining
+     */
+    greaterThan(field: string, value: number): this;
+    /**
+     * Add a less-than-or-equal condition
+     * @param field - The field name to filter on
+     * @param value - The upper bound (inclusive)
+     * @returns This builder instance for chaining
+     */
+    lessThanOrEqual(field: string, value: number): this;
+    /**
+     * Add a greater-than-or-equal condition
+     * @param field - The field name to filter on
+     * @param value - The lower bound (inclusive)
+     * @returns This builder instance for chaining
+     */
+    greaterThanOrEqual(field: string, value: number): this;
+    /**
+     * Add an IN condition to match multiple values
+     * @param field - The field name to filter on
+     * @param values - Array of values to match against
+     * @returns This builder instance for chaining
+     * @example
+     * builder.in('playerId', [8476791, 8477933, 8478402])
+     * // Generates: "playerId in (8476791, 8477933, 8478402)"
+     */
+    in(field: string, values: (string | number)[]): this;
+    /**
+     * Add a LIKE condition for pattern matching
+     * @param field - The field name to filter on
+     * @param pattern - The pattern to match (supports % for wildcards)
+     * @returns This builder instance for chaining
+     * @example
+     * builder.like('playerName', '%McDavid%')
+     * // Generates: "playerName like '%McDavid%'"
+     */
+    like(field: string, pattern: string): this;
+    /**
+     * Add a raw condition string
+     * Useful for complex expressions or unsupported operators
+     * @param condition - The raw condition string (e.g., "playerId=8476791")
+     * @returns This builder instance for chaining
+     */
+    raw(condition: string): this;
+    /**
+     * Build the cayenneExp string
+     * @returns The formatted cayenneExp string ready for API consumption
+     */
+    build(): string;
+    /**
+     * Clear all conditions
+     * @returns This builder instance for chaining
+     */
+    clear(): this;
+    /**
+     * Get the number of conditions currently in the builder
+     */
+    count(): number;
+}
+/**
+ * Create a new CayenneQueryBuilder instance
+ * @returns A new builder instance
+ */
+declare function createCayenneQuery(): CayenneQueryBuilder;
+/**
+ * Quick helper to build a simple cayenneExp from an object
+ * @param filters - An object where keys are field names and values are expected values
+ * @returns The formatted cayenneExp string
+ * @example
+ * buildCayenneExp({ seasonId: '20232024', gameTypeId: 2 })
+ * // Returns: "seasonId=20232024 and gameTypeId=2"
+ */
+declare function buildCayenneExp(filters: Record<string, string | number>): string;
+
+/**
+ * All valid NHL team abbreviations and their corresponding team IDs.
+ */
+declare const TeamsEnum: {
+    /** Anaheim Ducks */
+    readonly ANA: 24;
+    /** Boston Bruins */
+    readonly BOS: 6;
+    /** Buffalo Sabres */
+    readonly BUF: 7;
+    /** Calgary Flames */
+    readonly CGY: 20;
+    /** Carolina Hurricanes */
+    readonly CAR: 12;
+    /** Chicago Blackhawks */
+    readonly CHI: 16;
+    /** Colorado Avalanche */
+    readonly COL: 21;
+    /** Columbus Blue Jackets */
+    readonly CBJ: 29;
+    /** Dallas Stars */
+    readonly DAL: 25;
+    /** Detroit Red Wings */
+    readonly DET: 17;
+    /** Edmonton Oilers */
+    readonly EDM: 22;
+    /** Florida Panthers */
+    readonly FLA: 13;
+    /** Los Angeles Kings */
+    readonly LAK: 26;
+    /** Minnesota Wild*/
+    readonly MIN: 30;
+    /** Montreal Canadiens */
+    readonly MTL: 8;
+    /** New Jersey Devils */
+    readonly NJD: 1;
+    /** Nashville Predators */
+    readonly NSH: 18;
+    /** New York Islanders */
+    readonly NYI: 2;
+    /** New York Rangers */
+    readonly NYR: 3;
+    /** Ottawa Senators */
+    readonly OTT: 9;
+    /** Philadelphia Flyers */
+    readonly PHI: 4;
+    /** Pittsburgh Penguins */
+    readonly PIT: 5;
+    /** San Jose Sharks */
+    readonly SJS: 28;
+    /** Seattle Kraken */
+    readonly SEA: 55;
+    /** St. Louis Blues */
+    readonly STL: 19;
+    /** Tampa Bay Lightning */
+    readonly TBL: 14;
+    /** Toronto Maple Leafs */
+    readonly TOR: 10;
+    /** Utah Hockey Club */
+    readonly UTA: 59;
+    /** Vancouver Canucks */
+    readonly VAN: 23;
+    /** Vegas Golden Knights */
+    readonly VGK: 54;
+    /** Winnipeg Jets */
+    readonly WPG: 52;
+    /** Washington Capitals */
+    readonly WSH: 15;
+};
+declare const TeamsReverseEnum: Record<(typeof TeamsEnum)[keyof typeof TeamsEnum], keyof typeof TeamsEnum>;
+/**
+ * All inactive NHL teams and their corresponding team IDs.
+ */
+declare const InactiveTeamsEnum: {
+    /** Atlanta Flames (not active) */
+    readonly AFM: 47;
+    /** Arizona Coyotes (not active) */
+    readonly ARI: 53;
+    /** Atlanta Thrashers (not active) */
+    readonly ATL: 11;
+    /**  Brooklyn Americans - (not active) */
+    readonly BRK: 51;
+    /** California Golden Seals (aka Bay Area Seals) - (not active) */
+    readonly CGS: 56;
+    /** Cleveland Barons - (not active) */
+    readonly CLE: 49;
+    /** Colorado Rockies - (not active) */
+    readonly CLR: 35;
+    /** Detroit Cougars - (not active) */
+    readonly DCG: 40;
+    /** Detroit Falcons - (not active) */
+    readonly DFL: 50;
+    /** Hamilton Tigers - (not active) */
+    readonly HAM: 37;
+    /** Hartford Whalers - (not active) */
+    readonly HFD: 34;
+    /** Kansas City Scouts - (not active) */
+    readonly KCS: 48;
+    /** Montreal Maroons - (not active) */
+    readonly MMR: 43;
+    /** Minnesota North Stars - (not active) */
+    readonly MNS: 31;
+    /** Montreal Wanderers - (not active) */
+    readonly MWN: 41;
+    /** New York Americans - (not active) */
+    readonly NYA: 44;
+    /** California Seals (aka Oakland Seals) - (not active) */
+    readonly OAK: 46;
+    /** Phoenix Coyotes - (not active) */
+    readonly PHX: 27;
+    /** Pittsburgh Pirates - (not active) */
+    readonly PIR: 38;
+    /** Quebec Bulldogs - (not active) */
+    readonly QBD: 42;
+    /** Philadelphia Quakers - (not active) */
+    readonly QUA: 39;
+    /** Quebec Nordiques - (not active) */
+    readonly QUE: 32;
+    /** Ottawa Senators (original franchise) - (not active) */
+    readonly SEN: 36;
+    /** St. Louis Eagles - (not active) */
+    readonly SLE: 45;
+    /** Toronto Hockey Club (aka Toronto Arenas) - (not active) */
+    readonly TAN: 57;
+    /** Toronto St. Patricks - (not active) */
+    readonly TSP: 58;
+    /** Winnipeg Jets (original franchise) - (not active) */
+    readonly WIN: 33;
+};
+declare const InactiveTeamsReverseEnum: Record<(typeof InactiveTeamsEnum)[keyof typeof InactiveTeamsEnum], keyof typeof InactiveTeamsEnum>;
+/**
+ * All valid NHL seasons in yyyyYYYY format.
+ */
+declare const SeasonsArray: readonly [19171918, 19181919, 19191920, 19201921, 19211922, 19221923, 19231924, 19241925, 19251926, 19261927, 19271928, 19281929, 19291930, 19301931, 19311932, 19321933, 19331934, 19341935, 19351936, 19361937, 19371938, 19381939, 19391940, 19401941, 19411942, 19421943, 19431944, 19441945, 19451946, 19461947, 19471948, 19481949, 19491950, 19501951, 19511952, 19521953, 19531954, 19541955, 19551956, 19561957, 19571958, 19581959, 19591960, 19601961, 19611962, 19621963, 19631964, 19641965, 19651966, 19661967, 19671968, 19681969, 19691970, 19701971, 19711972, 19721973, 19731974, 19741975, 19751976, 19761977, 19771978, 19781979, 19791980, 19801981, 19811982, 19821983, 19831984, 19841985, 19851986, 19861987, 19871988, 19881989, 19891990, 19901991, 19911992, 19921993, 19931994, 19941995, 19951996, 19961997, 19971998, 19981999, 19992000, 20002001, 20012002, 20022003, 20032004, 20052006, 20062007, 20072008, 20082009, 20092010, 20102011, 20112012, 20122013, 20132014, 20142015, 20152016, 20162017, 20172018, 20182019, 20192020, 20202021, 20212022, 20222023, 20232024, 20242025, 20252026];
+/**
+ * All valid NHL playoff series letters.
+ */
+declare const SeriesLetterEnum: {
+    /** Atlantic Division Round 1: D1 vs WC# */
+    readonly A: "A";
+    /** Atlantic Division Round 1: D2 vs D3 */
+    readonly B: "B";
+    /** Metropolitan Division Round 1: D1 vs WC# */
+    readonly C: "C";
+    /** Metropolitan Division Round 1: D2 vs D3 */
+    readonly D: "D";
+    /** Central Division Round 1: D1 vs WC# */
+    readonly E: "E";
+    /** Central Division Round 1: D2 vs D3 */
+    readonly F: "F";
+    /** Pacific Division Round 1: D1 vs WC# */
+    readonly G: "G";
+    /** Pacific Division Round 1: D2 vs D3 */
+    readonly H: "H";
+    /** Atlantic Division Round 2: Aw vs Bw */
+    readonly I: "I";
+    /** Metropolitan Division Round 2: Cw vs Dw */
+    readonly J: "J";
+    /** Central Division Round 2: Ew vs Fw */
+    readonly K: "K";
+    /** Pacific Division Round 2: Gw vs Hw */
+    readonly L: "L";
+    /** Eastern Conference Finals */
+    readonly M: "M";
+    /** Western Conference Finals*/
+    readonly N: "N";
+    /** Stanley Cup Finals */
+    readonly O: "O";
+};
+/**
+ * All valid NHL playoff series letters grouped by round.
+ */
+declare const SeriesLetterByRound: {
+    R1: string[];
+    R2: string[];
+    CF: string[];
+    SCF: string[];
+};
+/**
+ * All valid NHL playoff series letters mapped to human-readable names.
+ */
+declare const PlayoffSeriesEnum: {
+    Atlantic_R1_D1_vs_WC: string;
+    Atlantic_R1_D2_vs_D3: string;
+    Metropolitan_R1_D1_vs_WC: string;
+    Metropolitan_R1_D2_vs_D3: string;
+    Central_R1_D1_vs_WC: string;
+    Central_R1_D2_vs_D3: string;
+    Pacific_R1_D1_vs_WC: string;
+    Pacific_R1_D2_vs_D3: string;
+    Atlantic_R2_Aw_vs_Bw: string;
+    Metropolitan_R2_Cw_vs_Dw: string;
+    Central_R2_Ew_vs_Fw: string;
+    Pacific_R2_Gw_vs_Hw: string;
+    Eastern_Conference_Finals: string;
+    Western_Conference_Finals: string;
+    Stanley_Cup_Finals: string;
+};
+/**
+ * All valid NHL game states.
+ */
+declare const GameStateEnum: {
+    /** Future */
+    readonly FUT: "FUT";
+    /** Live */
+    readonly LIV: "LIV";
+    /** Finished */
+    readonly FIN: "FIN";
+};
+/**
+ * All valid NHL period types.
+ */
+declare const PeriodTypeEnum: {
+    /** Regulation */
+    readonly REG: "REG";
+    /** Overtime */
+    readonly OT: "OT";
+    /** Shootout */
+    readonly SO: "SO";
+};
+/**
+ * All valid NHL game types.
+ */
+declare const GameTypeEnum: {
+    /** Pre-season */
+    readonly PRE: 1;
+    /** Regular season */
+    readonly REG: 2;
+    /** Post-season (aka playoffs) */
+    readonly POST: 3;
+    /** All-Star Game (unconfirmed) */
+    readonly ASG: 4;
+    /** International (unconfirmed) */
+    readonly INTL: 19;
+};
+/**  */
+declare const SEASON_RANGE: {
+    START: number;
+    END: number;
+};
+/**  */
+declare const START_SEASON: number;
+/**  */
+declare const END_SEASON: number;
+/**  */
+declare const YEAR_RANGE: {
+    START: number;
+    END: number;
+};
+/**  */
+declare const START_YEAR: number;
+/**  */
+declare const END_YEAR: number;
+/**  */
+declare const CURRENT: {
+    /** The season for today's date, so the default never goes stale. */
+    SEASON: number;
+    YEAR: number;
+};
+/**  */
+declare const PLAYER_ID_RANGE: {
+    readonly MIN: 8444000;
+    readonly MAX: 8489999;
+};
+/**  */
+declare const TEAM_ID_RANGE: {
+    readonly MIN: 1;
+    readonly MAX: 59;
+};
+
+declare const nhl_CURRENT: typeof CURRENT;
+declare const nhl_END_SEASON: typeof END_SEASON;
+declare const nhl_END_YEAR: typeof END_YEAR;
+declare const nhl_GameStateEnum: typeof GameStateEnum;
+declare const nhl_GameTypeEnum: typeof GameTypeEnum;
+declare const nhl_InactiveTeamsEnum: typeof InactiveTeamsEnum;
+declare const nhl_InactiveTeamsReverseEnum: typeof InactiveTeamsReverseEnum;
+declare const nhl_PLAYER_ID_RANGE: typeof PLAYER_ID_RANGE;
+declare const nhl_PeriodTypeEnum: typeof PeriodTypeEnum;
+declare const nhl_PlayoffSeriesEnum: typeof PlayoffSeriesEnum;
+declare const nhl_SEASON_RANGE: typeof SEASON_RANGE;
+declare const nhl_START_SEASON: typeof START_SEASON;
+declare const nhl_START_YEAR: typeof START_YEAR;
+declare const nhl_SeasonsArray: typeof SeasonsArray;
+declare const nhl_SeriesLetterByRound: typeof SeriesLetterByRound;
+declare const nhl_SeriesLetterEnum: typeof SeriesLetterEnum;
+declare const nhl_TEAM_ID_RANGE: typeof TEAM_ID_RANGE;
+declare const nhl_TeamsEnum: typeof TeamsEnum;
+declare const nhl_TeamsReverseEnum: typeof TeamsReverseEnum;
+declare const nhl_YEAR_RANGE: typeof YEAR_RANGE;
+declare namespace nhl {
+  export { nhl_CURRENT as CURRENT, nhl_END_SEASON as END_SEASON, nhl_END_YEAR as END_YEAR, nhl_GameStateEnum as GameStateEnum, nhl_GameTypeEnum as GameTypeEnum, nhl_InactiveTeamsEnum as InactiveTeamsEnum, nhl_InactiveTeamsReverseEnum as InactiveTeamsReverseEnum, nhl_PLAYER_ID_RANGE as PLAYER_ID_RANGE, nhl_PeriodTypeEnum as PeriodTypeEnum, nhl_PlayoffSeriesEnum as PlayoffSeriesEnum, nhl_SEASON_RANGE as SEASON_RANGE, nhl_START_SEASON as START_SEASON, nhl_START_YEAR as START_YEAR, nhl_SeasonsArray as SeasonsArray, nhl_SeriesLetterByRound as SeriesLetterByRound, nhl_SeriesLetterEnum as SeriesLetterEnum, nhl_TEAM_ID_RANGE as TEAM_ID_RANGE, nhl_TeamsEnum as TeamsEnum, nhl_TeamsReverseEnum as TeamsReverseEnum, nhl_YEAR_RANGE as YEAR_RANGE };
+}
+
+export { CayenneQueryBuilder as C, TeamsEnum as T, type CayenneCondition as a, buildCayenneExp as b, type CayenneExpression as c, type CayenneGroup as d, createCayenneQuery as e, nhl as n };