nhl-api-ts 0.1.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. package/README.md +31 -6
  2. package/dist/api/edge.d.mts +25 -24
  3. package/dist/api/edge.mjs +69 -23
  4. package/dist/api/game-center.d.mts +16 -15
  5. package/dist/api/game-center.mjs +20 -8
  6. package/dist/api/helpers.d.mts +8 -7
  7. package/dist/api/helpers.mjs +6 -6
  8. package/dist/api/misc.d.mts +6 -6
  9. package/dist/api/misc.mjs +15 -5
  10. package/dist/api/players.d.mts +6 -5
  11. package/dist/api/players.mjs +6 -2
  12. package/dist/api/query/builder.d.mts +2 -0
  13. package/dist/api/query/builder.mjs +3 -1
  14. package/dist/api/query/index.d.mts +2 -2
  15. package/dist/api/query/index.mjs +1 -1
  16. package/dist/api/query/sorting/goalie-sorts.d.mts +55 -0
  17. package/dist/api/query/sorting/goalie-sorts.mjs +43 -48
  18. package/dist/api/query/sorting/sorting-options.d.mts +125 -0
  19. package/dist/api/query/sorting/sorting-options.mjs +3 -2
  20. package/dist/api/schedule.d.mts +22 -21
  21. package/dist/api/schedule.mjs +26 -14
  22. package/dist/api/standings.d.mts +5 -4
  23. package/dist/api/standings.mjs +4 -4
  24. package/dist/api/stats.d.mts +22 -17
  25. package/dist/api/stats.mjs +38 -16
  26. package/dist/api/teams.d.mts +9 -8
  27. package/dist/api/teams.mjs +10 -6
  28. package/dist/cli/colors.d.mts +2 -2
  29. package/dist/cli/colors.mjs +6 -2
  30. package/dist/cli/commands.mjs +36 -26
  31. package/dist/cli/run.mjs +7 -5
  32. package/dist/http-client.mjs +2 -2
  33. package/dist/index.d.mts +2 -1
  34. package/dist/nhl-client.d.mts +14 -10
  35. package/dist/nhl-client.mjs +9 -7
  36. package/dist/types/common.d.mts +80 -0
  37. package/dist/types/common.mjs +2 -0
  38. package/dist/types/edge.d.mts +1024 -0
  39. package/dist/types/edge.mjs +1 -0
  40. package/dist/types/game-center.d.mts +1137 -0
  41. package/dist/types/game-center.mjs +1 -0
  42. package/dist/types/helpers.d.mts +17 -0
  43. package/dist/types/helpers.mjs +1 -0
  44. package/dist/types/index.d.mts +10 -0
  45. package/dist/types/index.mjs +1 -0
  46. package/dist/types/misc.d.mts +68 -0
  47. package/dist/types/misc.mjs +2 -0
  48. package/dist/types/players.d.mts +41 -0
  49. package/dist/types/players.mjs +1 -0
  50. package/dist/types/schedule.d.mts +428 -0
  51. package/dist/types/schedule.mjs +1 -0
  52. package/dist/types/standings.d.mts +103 -0
  53. package/dist/types/standings.mjs +1 -0
  54. package/dist/types/stats.d.mts +1082 -0
  55. package/dist/types/stats.mjs +1 -0
  56. package/dist/types/teams.d.mts +29 -0
  57. package/dist/types/teams.mjs +1 -0
  58. package/dist/utils.d.mts +1 -2
  59. package/dist/utils.mjs +3 -1
  60. package/package.json +7 -20
  61. package/dist/api/query/errors.d.mts +0 -3
  62. package/dist/api/query/errors.mjs +0 -6
  63. package/dist/api/query/filters/base.d.mts +0 -4
  64. package/dist/api/query/filters/base.mjs +0 -2
  65. package/dist/api/query/filters/decision.d.mts +0 -13
  66. package/dist/api/query/filters/decision.mjs +0 -26
  67. package/dist/api/query/filters/draft.d.mts +0 -15
  68. package/dist/api/query/filters/draft.mjs +0 -27
  69. package/dist/api/query/filters/experience.d.mts +0 -9
  70. package/dist/api/query/filters/experience.mjs +0 -17
  71. package/dist/api/query/filters/franchise.d.mts +0 -9
  72. package/dist/api/query/filters/franchise.mjs +0 -15
  73. package/dist/api/query/filters/game-type.d.mts +0 -10
  74. package/dist/api/query/filters/game-type.mjs +0 -16
  75. package/dist/api/query/filters/goalie-sorts.d.mts +0 -3
  76. package/dist/api/query/filters/goalie-sorts.mjs +0 -55
  77. package/dist/api/query/filters/home-road.d.mts +0 -9
  78. package/dist/api/query/filters/home-road.mjs +0 -16
  79. package/dist/api/query/filters/index.d.mts +0 -14
  80. package/dist/api/query/filters/index.mjs +0 -14
  81. package/dist/api/query/filters/nationality.d.mts +0 -12
  82. package/dist/api/query/filters/nationality.mjs +0 -19
  83. package/dist/api/query/filters/opponent.d.mts +0 -10
  84. package/dist/api/query/filters/opponent.mjs +0 -16
  85. package/dist/api/query/filters/position.d.mts +0 -16
  86. package/dist/api/query/filters/position.mjs +0 -28
  87. package/dist/api/query/filters/season.d.mts +0 -14
  88. package/dist/api/query/filters/season.mjs +0 -24
  89. package/dist/api/query/filters/shoot-catch.d.mts +0 -9
  90. package/dist/api/query/filters/shoot-catch.mjs +0 -16
  91. package/dist/api/query/filters/status.d.mts +0 -20
  92. package/dist/api/query/filters/status.mjs +0 -28
  93. package/dist/logging.d.mts +0 -14
  94. package/dist/logging.mjs +0 -13
@@ -0,0 +1,1082 @@
1
+ import type { GameType, LocalizedString, PositionCode, ShootsCatches } from '#src/types/common.mjs';
2
+ export interface AwardSeason {
3
+ /** Goalies only */
4
+ gaa?: number;
5
+ gameTypeId: GameType;
6
+ gamesPlayed: number;
7
+ /** Goalies only */
8
+ losses?: number;
9
+ /** Goalies only */
10
+ otLosses?: number;
11
+ /** Goalies only */
12
+ savePctg?: number;
13
+ seasonId: number;
14
+ /** Goalies only */
15
+ wins?: number;
16
+ assists?: number;
17
+ goals?: number;
18
+ pim?: number;
19
+ plusMinus?: number;
20
+ points?: number;
21
+ blockedShots?: number;
22
+ hits?: number;
23
+ }
24
+ export interface CareerTotalsRegularSeason {
25
+ assists: number;
26
+ gamesPlayed: number;
27
+ /** Goalies only */
28
+ gamesStarted?: number;
29
+ goals: number;
30
+ /** Goalies only */
31
+ goalsAgainst?: number;
32
+ /** Goalies only */
33
+ goalsAgainstAvg?: number;
34
+ /** Goalies only */
35
+ losses?: number;
36
+ /** Goalies only */
37
+ otLosses?: number;
38
+ pim: number;
39
+ /** Goalies only */
40
+ savePctg?: number;
41
+ /** Goalies only */
42
+ shotsAgainst?: number;
43
+ /** Goalies only */
44
+ shutouts?: number;
45
+ /** Goalies only */
46
+ timeOnIce?: string;
47
+ /** Goalies only */
48
+ wins?: number;
49
+ gameWinningGoals?: number;
50
+ otGoals?: number;
51
+ plusMinus?: number;
52
+ points?: number;
53
+ powerPlayGoals?: number;
54
+ powerPlayPoints?: number;
55
+ shootingPctg?: number;
56
+ shorthandedGoals?: number;
57
+ shorthandedPoints?: number;
58
+ shots?: number;
59
+ avgToi?: string;
60
+ faceoffWinningPctg?: number;
61
+ }
62
+ export interface ClubStatsSeason {
63
+ season: number;
64
+ gameTypes: GameType[];
65
+ }
66
+ export interface FeaturedRegularSeason {
67
+ subSeason: SeasonStatLine;
68
+ career: SeasonStatLine;
69
+ }
70
+ export interface GameLogEntry {
71
+ gameId: number;
72
+ teamAbbrev: string;
73
+ homeRoadFlag: string;
74
+ gameDate: string;
75
+ goals: number;
76
+ assists: number;
77
+ commonName: LocalizedString;
78
+ opponentCommonName: LocalizedString;
79
+ /** Goalies only */
80
+ gamesStarted?: number;
81
+ /** Goalies only */
82
+ decision?: string;
83
+ /** Goalies only */
84
+ shotsAgainst?: number;
85
+ /** Goalies only */
86
+ goalsAgainst?: number;
87
+ /** Goalies only */
88
+ savePctg?: number;
89
+ /** Goalies only */
90
+ shutouts?: number;
91
+ pim: number;
92
+ toi: string;
93
+ opponentAbbrev: string;
94
+ points?: number;
95
+ plusMinus?: number;
96
+ powerPlayGoals?: number;
97
+ powerPlayPoints?: number;
98
+ gameWinningGoals?: number;
99
+ otGoals?: number;
100
+ shots?: number;
101
+ shifts?: number;
102
+ shorthandedGoals?: number;
103
+ shorthandedPoints?: number;
104
+ }
105
+ export interface GoalieAdvancedRow {
106
+ completeGamePct: number;
107
+ completeGames: number;
108
+ gamesPlayed: number;
109
+ gamesStarted: number;
110
+ goalieFullName: string;
111
+ goalsAgainst: number;
112
+ goalsAgainstAverage: number;
113
+ goalsFor: number;
114
+ goalsForAverage: number;
115
+ incompleteGames: number;
116
+ lastName: string;
117
+ playerId: number;
118
+ qualityStart: number;
119
+ qualityStartsPct: number;
120
+ regulationLosses: number;
121
+ regulationWins: number;
122
+ savePct: number;
123
+ /** Absent when `aggregate: true` */
124
+ seasonId?: number;
125
+ shootsCatches: ShootsCatches;
126
+ shotsAgainstPer60: number;
127
+ /** Absent when `aggregate: true` */
128
+ teamAbbrevs?: string;
129
+ timeOnIce: number;
130
+ }
131
+ export interface GoalieBiosRow {
132
+ birthCity: string;
133
+ birthCountryCode: string;
134
+ birthDate: string;
135
+ birthStateProvinceCode: string | null;
136
+ /** Absent when `aggregate: true` */
137
+ currentTeamAbbrev?: string | null;
138
+ draftOverall: number | null;
139
+ draftRound: number | null;
140
+ draftYear: number | null;
141
+ firstSeasonForGameType: number;
142
+ gamesPlayed: number;
143
+ goalieFullName: string;
144
+ height: number;
145
+ isInHallOfFameYn: string;
146
+ lastName: string;
147
+ losses: number;
148
+ nationalityCode: string;
149
+ otLosses: number;
150
+ playerId: number;
151
+ shootsCatches: ShootsCatches;
152
+ shutouts: number;
153
+ ties: number | null;
154
+ weight: number;
155
+ wins: number;
156
+ }
157
+ export interface GoalieDaysRestRow {
158
+ gamesPlayed: number;
159
+ gamesPlayedDaysRest0: number;
160
+ gamesPlayedDaysRest1: number;
161
+ gamesPlayedDaysRest2: number;
162
+ gamesPlayedDaysRest3: number;
163
+ gamesPlayedDaysRest4Plus: number;
164
+ gamesStarted: number;
165
+ goalieFullName: string;
166
+ lastName: string;
167
+ losses: number;
168
+ otLosses: number;
169
+ playerId: number;
170
+ savePct: number;
171
+ savePctDaysRest0: number;
172
+ savePctDaysRest1: number;
173
+ savePctDaysRest2: number;
174
+ savePctDaysRest3: number;
175
+ savePctDaysRest4Plus: number;
176
+ /** Absent when `aggregate: true` */
177
+ seasonId?: number;
178
+ shootsCatches: ShootsCatches;
179
+ /** Absent when `aggregate: true` */
180
+ teamAbbrevs?: string;
181
+ ties: number | null;
182
+ wins: number;
183
+ }
184
+ export interface GoaliePenaltyShotsRow {
185
+ gamesPlayed: number;
186
+ goalieFullName: string;
187
+ goalsAgainst: number;
188
+ lastName: string;
189
+ penaltyShotSavePct: number;
190
+ penaltyShotsAgainst: number;
191
+ penaltyShotsGoalsAgainst: number;
192
+ penaltyShotsSaves: number;
193
+ playerId: number;
194
+ savePct: number;
195
+ saves: number;
196
+ /** Absent when `aggregate: true` */
197
+ seasonId?: number;
198
+ shootsCatches: ShootsCatches;
199
+ shotsAgainst: number;
200
+ /** Absent when `aggregate: true` */
201
+ teamAbbrevs?: string;
202
+ }
203
+ export interface GoalieSavesByStrengthRow {
204
+ evGoalsAgainst: number;
205
+ evSavePct: number;
206
+ evSaves: number;
207
+ evShotsAgainst: number;
208
+ gamesPlayed: number;
209
+ gamesStarted: number;
210
+ goalieFullName: string;
211
+ goalsAgainst: number;
212
+ lastName: string;
213
+ losses: number;
214
+ otLosses: number;
215
+ playerId: number;
216
+ ppGoalsAgainst: number;
217
+ ppSavePct: number;
218
+ ppSaves: number;
219
+ ppShotsAgainst: number;
220
+ savePct: number;
221
+ saves: number;
222
+ /** Absent when `aggregate: true` */
223
+ seasonId?: number;
224
+ shGoalsAgainst: number;
225
+ shSavePct: number;
226
+ shSaves: number;
227
+ shShotsAgainst: number;
228
+ shootsCatches: ShootsCatches;
229
+ shotsAgainst: number;
230
+ /** Absent when `aggregate: true` */
231
+ teamAbbrevs?: string;
232
+ ties: number | null;
233
+ wins: number;
234
+ }
235
+ export interface GoalieShootoutRow {
236
+ careerShootoutGamesPlayed: number;
237
+ careerShootoutGoalsAllowed: number;
238
+ careerShootoutLosses: number;
239
+ careerShootoutSavePct: number;
240
+ careerShootoutSaves: number;
241
+ careerShootoutShotsAgainst: number;
242
+ careerShootoutWins: number;
243
+ gamesPlayed: number;
244
+ goalieFullName: string;
245
+ lastName: string;
246
+ playerId: number;
247
+ /** Absent when `aggregate: true` */
248
+ seasonId?: number;
249
+ shootoutGoalsAgainst: number;
250
+ shootoutLosses: number;
251
+ shootoutSavePct: number;
252
+ shootoutSaves: number;
253
+ shootoutShotsAgainst: number;
254
+ shootoutWins: number;
255
+ shootsCatches: ShootsCatches;
256
+ /** Absent when `aggregate: true` */
257
+ teamAbbrevs?: string;
258
+ }
259
+ export interface GoalieStartedVsRelievedRow {
260
+ gamesPlayed: number;
261
+ gamesRelieved: number;
262
+ gamesRelievedGoalsAgainst: number;
263
+ gamesRelievedLosses: number;
264
+ gamesRelievedOtLosses: number;
265
+ gamesRelievedSavePct: number | null;
266
+ gamesRelievedSaves: number;
267
+ gamesRelievedShotsAgainst: number;
268
+ gamesRelievedTies: number | null;
269
+ gamesRelievedWins: number;
270
+ gamesStarted: number;
271
+ gamesStartedGoalsAgainst: number;
272
+ gamesStartedLosses: number;
273
+ gamesStartedOtLosses: number;
274
+ gamesStartedSavePct: number;
275
+ gamesStartedSaves: number;
276
+ gamesStartedShotsAgainst: number;
277
+ gamesStartedTies: number | null;
278
+ gamesStartedWins: number;
279
+ goalieFullName: string;
280
+ lastName: string;
281
+ losses: number;
282
+ otLosses: number;
283
+ playerId: number;
284
+ savePct: number;
285
+ /** Absent when `aggregate: true` */
286
+ seasonId?: number;
287
+ shootsCatches: ShootsCatches;
288
+ /** Absent when `aggregate: true` */
289
+ teamAbbrevs?: string;
290
+ ties: number | null;
291
+ wins: number;
292
+ }
293
+ export interface GoalieSummaryRow {
294
+ assists: number;
295
+ gamesPlayed: number;
296
+ gamesStarted: number;
297
+ goalieFullName: string;
298
+ goals: number;
299
+ goalsAgainst: number;
300
+ goalsAgainstAverage: number;
301
+ lastName: string;
302
+ losses: number;
303
+ otLosses: number;
304
+ penaltyMinutes: number;
305
+ playerId: number;
306
+ points: number;
307
+ savePct: number;
308
+ saves: number;
309
+ /** Absent when `aggregate: true` */
310
+ seasonId?: number;
311
+ shootsCatches: ShootsCatches;
312
+ shotsAgainst: number;
313
+ shutouts: number;
314
+ /** Absent when `aggregate: true` */
315
+ teamAbbrevs?: string;
316
+ ties: number | null;
317
+ timeOnIce: number;
318
+ wins: number;
319
+ }
320
+ export interface PlayerLanding {
321
+ playerId: number;
322
+ isActive: boolean;
323
+ /** Absent for inactive players (`isActive: false`) */
324
+ currentTeamId?: number;
325
+ /** Absent for inactive players (`isActive: false`) */
326
+ currentTeamAbbrev?: string;
327
+ /** Absent for inactive players (`isActive: false`) */
328
+ fullTeamName?: LocalizedString;
329
+ /** Absent for inactive players (`isActive: false`) */
330
+ teamCommonName?: LocalizedString;
331
+ /** Absent for inactive players (`isActive: false`) */
332
+ teamPlaceNameWithPreposition?: LocalizedString;
333
+ firstName: LocalizedString;
334
+ lastName: LocalizedString;
335
+ badges: PlayerLandingBadge[];
336
+ /** Absent for inactive players (`isActive: false`) */
337
+ teamLogo?: string;
338
+ sweaterNumber: number;
339
+ position: string;
340
+ headshot: string;
341
+ heroImage: string;
342
+ heightInInches: number;
343
+ heightInCentimeters: number;
344
+ weightInPounds: number;
345
+ weightInKilograms: number;
346
+ birthDate: string;
347
+ birthCity: LocalizedString;
348
+ /** Only for players born in the USA or Canada */
349
+ birthStateProvince?: LocalizedString;
350
+ birthCountry: string;
351
+ shootsCatches: ShootsCatches;
352
+ draftDetails: PlayerLandingDraftDetails;
353
+ playerSlug: string;
354
+ inTop100AllTime: number;
355
+ inHHOF: number;
356
+ featuredStats: PlayerLandingFeaturedStats;
357
+ careerTotals: PlayerLandingCareerTotals;
358
+ shopLink: string;
359
+ twitterLink: string;
360
+ watchLink: string;
361
+ last5Games: PlayerLandingLast5Game[];
362
+ seasonTotals: PlayerLandingSeasonTotal[];
363
+ awards: PlayerLandingAward[];
364
+ /** Absent for inactive players (`isActive: false`) */
365
+ currentTeamRoster?: PlayerLandingCurrentTeamRoster[];
366
+ }
367
+ export interface PlayerLandingAward {
368
+ trophy: LocalizedString;
369
+ seasons: AwardSeason[];
370
+ }
371
+ export interface PlayerLandingBadge {
372
+ logoUrl: LocalizedString;
373
+ title: LocalizedString;
374
+ }
375
+ export interface PlayerLandingCareerTotals {
376
+ regularSeason: CareerTotalsRegularSeason;
377
+ playoffs: CareerTotalsRegularSeason;
378
+ }
379
+ export interface PlayerLandingCurrentTeamRoster {
380
+ playerId: number;
381
+ lastName: LocalizedString;
382
+ firstName: LocalizedString;
383
+ playerSlug: string;
384
+ }
385
+ export interface PlayerLandingDraftDetails {
386
+ year: number;
387
+ teamAbbrev: string;
388
+ round: number;
389
+ pickInRound: number;
390
+ overallPick: number;
391
+ }
392
+ export interface PlayerLandingFeaturedStats {
393
+ season: number;
394
+ regularSeason: FeaturedRegularSeason;
395
+ }
396
+ export interface PlayerLandingLast5Game {
397
+ /** Goalies only */
398
+ decision?: string;
399
+ gameDate: string;
400
+ gameId: number;
401
+ gameTypeId: GameType;
402
+ /** Goalies only */
403
+ gamesStarted?: number;
404
+ /** Goalies only */
405
+ goalsAgainst?: number;
406
+ homeRoadFlag: string;
407
+ opponentAbbrev: string;
408
+ /** Goalies only */
409
+ penaltyMins?: number;
410
+ /** Goalies only */
411
+ savePctg?: number;
412
+ /** Goalies only */
413
+ shotsAgainst?: number;
414
+ teamAbbrev: string;
415
+ toi: string;
416
+ assists?: number;
417
+ goals?: number;
418
+ pim?: number;
419
+ plusMinus?: number;
420
+ points?: number;
421
+ powerPlayGoals?: number;
422
+ shifts?: number;
423
+ shorthandedGoals?: number;
424
+ shots?: number;
425
+ }
426
+ export interface PlayerLandingSeasonTotal {
427
+ gameTypeId: GameType;
428
+ gamesPlayed: number;
429
+ /** Goalies only */
430
+ goalsAgainstAvg?: number;
431
+ leagueAbbrev: string;
432
+ /** Goalies only */
433
+ savePctg?: number;
434
+ season: number;
435
+ sequence: number;
436
+ teamName: LocalizedString;
437
+ /** Goalies only */
438
+ goalsAgainst?: number;
439
+ /** Goalies only */
440
+ losses?: number;
441
+ /** Goalies only */
442
+ shutouts?: number;
443
+ /** Goalies only */
444
+ ties?: number;
445
+ /** Goalies only */
446
+ timeOnIce?: string;
447
+ /** Goalies only */
448
+ wins?: number;
449
+ /** Goalies only */
450
+ shotsAgainst?: number;
451
+ /** Goalies only */
452
+ otLosses?: number;
453
+ assists?: number;
454
+ /** Goalies only */
455
+ gamesStarted?: number;
456
+ goals?: number;
457
+ teamCommonName?: LocalizedString;
458
+ teamPlaceNameWithPreposition?: LocalizedString;
459
+ pim?: number;
460
+ points?: number;
461
+ gameWinningGoals?: number;
462
+ otGoals?: number;
463
+ plusMinus?: number;
464
+ powerPlayGoals?: number;
465
+ powerPlayPoints?: number;
466
+ shootingPctg?: number;
467
+ shorthandedGoals?: number;
468
+ shorthandedPoints?: number;
469
+ shots?: number;
470
+ avgToi?: string;
471
+ faceoffWinningPctg?: number;
472
+ }
473
+ export interface SeasonStatLine {
474
+ gamesPlayed: number;
475
+ /** Goalies only */
476
+ goalsAgainstAvg?: number;
477
+ /** Goalies only */
478
+ losses?: number;
479
+ /** Goalies only */
480
+ otLosses?: number;
481
+ /** Goalies only */
482
+ savePctg?: number;
483
+ /** Goalies only */
484
+ shutouts?: number;
485
+ /** Goalies only */
486
+ wins?: number;
487
+ assists?: number;
488
+ gameWinningGoals?: number;
489
+ goals?: number;
490
+ otGoals?: number;
491
+ pim?: number;
492
+ plusMinus?: number;
493
+ points?: number;
494
+ powerPlayGoals?: number;
495
+ powerPlayPoints?: number;
496
+ shootingPctg?: number;
497
+ shorthandedGoals?: number;
498
+ shorthandedPoints?: number;
499
+ shots?: number;
500
+ }
501
+ export interface SkaterBiosRow {
502
+ assists: number;
503
+ birthCity: string;
504
+ birthCountryCode: string;
505
+ birthDate: string;
506
+ birthStateProvinceCode: string | null;
507
+ /** Absent when `aggregate: true` */
508
+ currentTeamAbbrev?: string | null;
509
+ /** Absent when `aggregate: true` */
510
+ currentTeamName?: string | null;
511
+ draftOverall: number | null;
512
+ draftRound: number | null;
513
+ draftYear: number | null;
514
+ firstSeasonForGameType: number;
515
+ gamesPlayed: number;
516
+ goals: number;
517
+ height: number;
518
+ isInHallOfFameYn: string;
519
+ lastName: string;
520
+ nationalityCode: string;
521
+ playerId: number;
522
+ points: number;
523
+ positionCode: PositionCode;
524
+ shootsCatches: ShootsCatches;
525
+ skaterFullName: string;
526
+ weight: number;
527
+ }
528
+ export interface SkaterFaceoffPercentagesRow {
529
+ defensiveZoneFaceoffPct: number;
530
+ defensiveZoneFaceoffs: number;
531
+ evFaceoffPct: number;
532
+ evFaceoffs: number;
533
+ faceoffWinPct: number;
534
+ gamesPlayed: number;
535
+ lastName: string;
536
+ neutralZoneFaceoffPct: number;
537
+ neutralZoneFaceoffs: number;
538
+ offensiveZoneFaceoffPct: number;
539
+ offensiveZoneFaceoffs: number;
540
+ playerId: number;
541
+ positionCode: PositionCode;
542
+ ppFaceoffPct: number;
543
+ ppFaceoffs: number;
544
+ /** Absent when `aggregate: true` */
545
+ seasonId?: number;
546
+ shFaceoffPct: number;
547
+ shFaceoffs: number;
548
+ shootsCatches: ShootsCatches;
549
+ skaterFullName: string;
550
+ /** Absent when `aggregate: true` */
551
+ teamAbbrevs?: string;
552
+ timeOnIcePerGame: number;
553
+ totalFaceoffs: number;
554
+ }
555
+ export interface SkaterFaceoffWinsRow {
556
+ defensiveZoneFaceoffLosses: number;
557
+ defensiveZoneFaceoffWins: number;
558
+ defensiveZoneFaceoffs: number;
559
+ evFaceoffs: number;
560
+ evFaceoffsLost: number;
561
+ evFaceoffsWon: number;
562
+ faceoffWinPct: number;
563
+ gamesPlayed: number;
564
+ lastName: string;
565
+ neutralZoneFaceoffLosses: number;
566
+ neutralZoneFaceoffWins: number;
567
+ neutralZoneFaceoffs: number;
568
+ offensiveZoneFaceoffLosses: number;
569
+ offensiveZoneFaceoffWins: number;
570
+ offensiveZoneFaceoffs: number;
571
+ playerId: number;
572
+ positionCode: PositionCode;
573
+ ppFaceoffs: number;
574
+ ppFaceoffsLost: number;
575
+ ppFaceoffsWon: number;
576
+ /** Absent when `aggregate: true` */
577
+ seasonId?: number;
578
+ shFaceoffs: number;
579
+ shFaceoffsLost: number;
580
+ shFaceoffsWon: number;
581
+ skaterFullName: string;
582
+ /** Absent when `aggregate: true` */
583
+ teamAbbrevs?: string;
584
+ totalFaceoffLosses: number;
585
+ totalFaceoffWins: number;
586
+ totalFaceoffs: number;
587
+ }
588
+ export interface SkaterGoalsForAgainstRow {
589
+ assists: number;
590
+ evenStrengthGoalDifference: number;
591
+ evenStrengthGoalsAgainst: number;
592
+ evenStrengthGoalsFor: number;
593
+ evenStrengthGoalsForPct: number;
594
+ evenStrengthTimeOnIcePerGame: number;
595
+ gamesPlayed: number;
596
+ goals: number;
597
+ lastName: string;
598
+ playerId: number;
599
+ points: number;
600
+ positionCode: PositionCode;
601
+ powerPlayGoalFor: number;
602
+ powerPlayGoalsAgainst: number;
603
+ powerPlayTimeOnIcePerGame: number;
604
+ /** Absent when `aggregate: true` */
605
+ seasonId?: number;
606
+ shortHandedGoalsAgainst: number;
607
+ shortHandedGoalsFor: number;
608
+ shortHandedTimeOnIcePerGame: number;
609
+ skaterFullName: string;
610
+ /** Absent when `aggregate: true` */
611
+ teamAbbrevs?: string;
612
+ }
613
+ export interface SkaterPenaltiesRow {
614
+ assists: number;
615
+ gameMisconductPenalties: number;
616
+ gamesPlayed: number;
617
+ goals: number;
618
+ lastName: string;
619
+ majorPenalties: number;
620
+ matchPenalties: number;
621
+ minorPenalties: number;
622
+ misconductPenalties: number;
623
+ netPenalties: number;
624
+ netPenaltiesPer60: number;
625
+ penalties: number;
626
+ penaltiesDrawn: number;
627
+ penaltiesDrawnPer60: number;
628
+ penaltiesTakenPer60: number;
629
+ penaltyMinutes: number;
630
+ penaltyMinutesPerTimeOnIce: number;
631
+ penaltySecondsPerGame: number;
632
+ playerId: number;
633
+ points: number;
634
+ positionCode: PositionCode;
635
+ /** Absent when `aggregate: true` */
636
+ seasonId?: number;
637
+ skaterFullName: string;
638
+ /** Absent when `aggregate: true` */
639
+ teamAbbrevs?: string;
640
+ timeOnIcePerGame: number;
641
+ }
642
+ export interface SkaterPenaltyKillRow {
643
+ gamesPlayed: number;
644
+ lastName: string;
645
+ playerId: number;
646
+ positionCode: PositionCode;
647
+ ppGoalsAgainstPer60: number;
648
+ /** Absent when `aggregate: true` */
649
+ seasonId?: number;
650
+ shAssists: number;
651
+ shGoals: number;
652
+ shGoalsPer60: number;
653
+ shIndividualSatFor: number;
654
+ shIndividualSatForPer60: number;
655
+ shPoints: number;
656
+ shPointsPer60: number;
657
+ shPrimaryAssists: number;
658
+ shPrimaryAssistsPer60: number;
659
+ shSecondaryAssists: number;
660
+ shSecondaryAssistsPer60: number;
661
+ shShootingPct: number;
662
+ shShots: number;
663
+ shShotsPer60: number;
664
+ shTimeOnIce: number;
665
+ shTimeOnIcePctPerGame: number;
666
+ shTimeOnIcePerGame: number;
667
+ skaterFullName: string;
668
+ /** Absent when `aggregate: true` */
669
+ teamAbbrevs?: string;
670
+ }
671
+ export interface SkaterPenaltyShotsRow {
672
+ lastName: string;
673
+ penaltyShotAttempts: number;
674
+ penaltyShotShootingPct: number;
675
+ penaltyShotsFailed: number;
676
+ penaltyShotsGoals: number;
677
+ playerId: number;
678
+ positionCode: PositionCode;
679
+ /** Absent when `aggregate: true` */
680
+ seasonId?: number;
681
+ shootsCatches: ShootsCatches;
682
+ skaterFullName: string;
683
+ /** Absent when `aggregate: true` */
684
+ teamAbbrevs?: string;
685
+ }
686
+ export interface SkaterPercentagesRow {
687
+ gamesPlayed: number;
688
+ lastName: string;
689
+ playerId: number;
690
+ positionCode: PositionCode;
691
+ satPercentage: number;
692
+ satPercentageAhead: number | null;
693
+ satPercentageBehind: number | null;
694
+ satPercentageClose: number;
695
+ satPercentageTied: number | null;
696
+ satRelative: number;
697
+ /** Absent when `aggregate: true` */
698
+ seasonId?: number;
699
+ shootingPct5v5: number;
700
+ shootsCatches: ShootsCatches;
701
+ skaterFullName: string;
702
+ skaterSavePct5v5: number | null;
703
+ skaterShootingPlusSavePct5v5: number | null;
704
+ /** Absent when `aggregate: true` */
705
+ teamAbbrevs?: string;
706
+ timeOnIcePerGame5v5: number;
707
+ usatPercentage: number;
708
+ usatPercentageAhead: number | null;
709
+ usatPercentageBehind: number | null;
710
+ usatPercentageTied: number | null;
711
+ usatPrecentageClose: number;
712
+ usatRelative: number;
713
+ zoneStartPct5v5: number;
714
+ }
715
+ export interface SkaterPowerPlayRow {
716
+ gamesPlayed: number;
717
+ lastName: string;
718
+ playerId: number;
719
+ positionCode: PositionCode;
720
+ ppAssists: number;
721
+ ppGoals: number;
722
+ ppGoalsForPer60: number;
723
+ ppGoalsPer60: number;
724
+ ppIndividualSatFor: number;
725
+ ppIndividualSatForPer60: number;
726
+ ppPoints: number;
727
+ ppPointsPer60: number;
728
+ ppPrimaryAssists: number;
729
+ ppPrimaryAssistsPer60: number;
730
+ ppSecondaryAssists: number;
731
+ ppSecondaryAssistsPer60: number;
732
+ ppShootingPct: number;
733
+ ppShots: number;
734
+ ppShotsPer60: number;
735
+ ppTimeOnIce: number;
736
+ ppTimeOnIcePctPerGame: number;
737
+ ppTimeOnIcePerGame: number;
738
+ /** Absent when `aggregate: true` */
739
+ seasonId?: number;
740
+ skaterFullName: string;
741
+ /** Absent when `aggregate: true` */
742
+ teamAbbrevs?: string;
743
+ }
744
+ export interface SkaterPuckPossessionsRow {
745
+ defensiveZoneStartPct: number;
746
+ faceoffPct5v5: number | null;
747
+ gamesPlayed: number;
748
+ goalsPct: number | null;
749
+ individualSatForPer60: number;
750
+ individualShotsForPer60: number;
751
+ lastName: string;
752
+ neutralZoneStartPct: number;
753
+ offensiveZoneStartPct: number;
754
+ offensiveZoneStartRatio: number;
755
+ onIceShootingPct: number;
756
+ playerId: number;
757
+ positionCode: PositionCode;
758
+ satPct: number;
759
+ /** Absent when `aggregate: true` */
760
+ seasonId?: number;
761
+ shootsCatches: ShootsCatches;
762
+ skaterFullName: string;
763
+ /** Absent when `aggregate: true` */
764
+ teamAbbrevs?: string;
765
+ timeOnIcePerGame5v5: number;
766
+ usatPct: number;
767
+ }
768
+ export interface SkaterRealtimeRow {
769
+ blockedShots: number;
770
+ blockedShotsPer60: number;
771
+ emptyNetAssists: number;
772
+ emptyNetGoals: number;
773
+ emptyNetPoints: number;
774
+ firstGoals: number;
775
+ gamesPlayed: number;
776
+ giveaways: number;
777
+ giveawaysPer60: number;
778
+ hits: number;
779
+ hitsPer60: number;
780
+ lastName: string;
781
+ missedShotCrossbar: number;
782
+ missedShotFailedBankAttempt: number | null;
783
+ missedShotGoalpost: number;
784
+ missedShotOverNet: number;
785
+ missedShotShort: number | null;
786
+ missedShotWideOfNet: number;
787
+ missedShots: number;
788
+ otGoals: number;
789
+ playerId: number;
790
+ positionCode: PositionCode;
791
+ /** Absent when `aggregate: true` */
792
+ seasonId?: number;
793
+ shootsCatches: ShootsCatches;
794
+ shotAttemptsBlocked: number;
795
+ skaterFullName: string;
796
+ takeaways: number;
797
+ takeawaysPer60: number;
798
+ /** Absent when `aggregate: true` */
799
+ teamAbbrevs?: string;
800
+ timeOnIcePerGame: number;
801
+ totalShotAttempts: number;
802
+ }
803
+ export interface SkaterScoringPerGameRow {
804
+ assists: number;
805
+ assistsPerGame: number;
806
+ blockedShots: number;
807
+ blocksPerGame: number;
808
+ gamesPlayed: number;
809
+ goals: number;
810
+ goalsPerGame: number;
811
+ hits: number;
812
+ hitsPerGame: number;
813
+ lastName: string;
814
+ penaltyMinutes: number;
815
+ penaltyMinutesPerGame: number;
816
+ playerId: number;
817
+ points: number;
818
+ pointsPerGame: number;
819
+ positionCode: PositionCode;
820
+ primaryAssistsPerGame: number;
821
+ /** Absent when `aggregate: true` */
822
+ seasonId?: number;
823
+ secondaryAssistsPerGame: number;
824
+ shootsCatches: ShootsCatches;
825
+ shots: number;
826
+ shotsPerGame: number;
827
+ skaterFullName: string;
828
+ /** Absent when `aggregate: true` */
829
+ teamAbbrevs?: string;
830
+ timeOnIce: number;
831
+ timeOnIcePerGame: number;
832
+ totalPrimaryAssists: number;
833
+ totalSecondaryAssists: number;
834
+ }
835
+ export interface SkaterScoringRatesRow {
836
+ assists5v5: number;
837
+ assistsPer605v5: number;
838
+ gamesPlayed: number;
839
+ goals5v5: number;
840
+ goalsPer605v5: number;
841
+ lastName: string;
842
+ netMinorPenaltiesPer60: number;
843
+ offensiveZoneStartPct5v5: number;
844
+ onIceShootingPct5v5: number;
845
+ playerId: number;
846
+ points5v5: number;
847
+ pointsPer605v5: number;
848
+ positionCode: PositionCode;
849
+ primaryAssists5v5: number;
850
+ primaryAssistsPer605v5: number;
851
+ satPct: number;
852
+ satRelative5v5: number;
853
+ /** Absent when `aggregate: true` */
854
+ seasonId?: number;
855
+ secondaryAssists5v5: number;
856
+ secondaryAssistsPer605v5: number;
857
+ shootingPct5v5: number;
858
+ skaterFullName: string;
859
+ /** Absent when `aggregate: true` */
860
+ teamAbbrevs?: string;
861
+ timeOnIcePerGame5v5: number;
862
+ }
863
+ export interface SkaterShootoutRow {
864
+ careerShootoutGameDecidingGoals: number;
865
+ careerShootoutGamesPlayed: number;
866
+ careerShootoutGoals: number;
867
+ careerShootoutShootingPct: number;
868
+ careerShootoutShots: number;
869
+ lastName: string;
870
+ playerId: number;
871
+ positionCode: PositionCode;
872
+ /** Absent when `aggregate: true` */
873
+ seasonId?: number;
874
+ shootoutGameDecidingGoals: number;
875
+ shootoutGamesPlayed: number;
876
+ shootoutGoals: number;
877
+ shootoutShootingPct: number;
878
+ shootoutShots: number;
879
+ shootsCatches: ShootsCatches;
880
+ skaterFullName: string;
881
+ /** Absent when `aggregate: true` */
882
+ teamAbbrevs?: string;
883
+ }
884
+ export interface SkaterShotTypeRow {
885
+ gamesPlayed: number;
886
+ goals: number;
887
+ goalsBackhand: number;
888
+ goalsBat: number;
889
+ goalsBetweenLegs: number;
890
+ goalsCradle: number;
891
+ goalsDeflected: number;
892
+ goalsPoke: number;
893
+ goalsSlap: number;
894
+ goalsSnap: number;
895
+ goalsTipIn: number;
896
+ goalsWrapAround: number;
897
+ goalsWrist: number;
898
+ lastName: string;
899
+ playerId: number;
900
+ /** Absent when `aggregate: true` */
901
+ seasonId?: number;
902
+ shootingPct: number;
903
+ shootingPctBackhand: number | null;
904
+ shootingPctBat: number | null;
905
+ shootingPctBetweenLegs: number | null;
906
+ shootingPctCradle: number | null;
907
+ shootingPctDeflected: number | null;
908
+ shootingPctPoke: number | null;
909
+ shootingPctSlap: number | null;
910
+ shootingPctSnap: number | null;
911
+ shootingPctTipIn: number | null;
912
+ shootingPctWrapAround: number | null;
913
+ shootingPctWrist: number | null;
914
+ shotsOnNetBackhand: number;
915
+ shotsOnNetBat: number;
916
+ shotsOnNetBetweenLegs: number;
917
+ shotsOnNetCradle: number;
918
+ shotsOnNetDeflected: number;
919
+ shotsOnNetPoke: number;
920
+ shotsOnNetSlap: number;
921
+ shotsOnNetSnap: number;
922
+ shotsOnNetTipIn: number;
923
+ shotsOnNetWrapAround: number;
924
+ shotsOnNetWrist: number;
925
+ skaterFullName: string;
926
+ /** Absent when `aggregate: true` */
927
+ teamAbbrevs?: string;
928
+ }
929
+ export interface SkaterSummaryRow {
930
+ assists: number;
931
+ evGoals: number;
932
+ evPoints: number;
933
+ faceoffWinPct: number;
934
+ gameWinningGoals: number;
935
+ gamesPlayed: number;
936
+ goals: number;
937
+ lastName: string;
938
+ otGoals: number;
939
+ penaltyMinutes: number;
940
+ playerId: number;
941
+ plusMinus: number;
942
+ points: number;
943
+ pointsPerGame: number;
944
+ positionCode: PositionCode;
945
+ ppGoals: number;
946
+ ppPoints: number;
947
+ /** Absent when `aggregate: true` */
948
+ seasonId?: number;
949
+ shGoals: number;
950
+ shPoints: number;
951
+ shootingPct: number;
952
+ shootsCatches: ShootsCatches;
953
+ shots: number;
954
+ skaterFullName: string;
955
+ /** Absent when `aggregate: true` */
956
+ teamAbbrevs?: string;
957
+ timeOnIcePerGame: number;
958
+ }
959
+ export interface SkaterSummaryShootingRow {
960
+ gamesPlayed: number;
961
+ lastName: string;
962
+ playerId: number;
963
+ positionCode: PositionCode;
964
+ satAgainst: number;
965
+ satAhead: number;
966
+ satBehind: number;
967
+ satClose: number;
968
+ satFor: number;
969
+ satRelative: number;
970
+ satTied: number;
971
+ satTotal: number;
972
+ /** Absent when `aggregate: true` */
973
+ seasonId?: number;
974
+ shootsCatches: ShootsCatches;
975
+ skaterFullName: string;
976
+ /** Absent when `aggregate: true` */
977
+ teamAbbrevs?: string;
978
+ timeOnIcePerGame5v5: number;
979
+ usatAgainst: number;
980
+ usatAhead: number;
981
+ usatBehind: number;
982
+ usatClose: number;
983
+ usatFor: number;
984
+ usatRelative: number;
985
+ usatTied: number;
986
+ usatTotal: number;
987
+ }
988
+ export interface SkaterTimeOnIceRow {
989
+ evTimeOnIce: number;
990
+ evTimeOnIcePerGame: number;
991
+ gamesPlayed: number;
992
+ lastName: string;
993
+ otTimeOnIce: number;
994
+ otTimeOnIcePerOtGame: number;
995
+ playerId: number;
996
+ positionCode: PositionCode;
997
+ ppTimeOnIce: number;
998
+ ppTimeOnIcePerGame: number;
999
+ /** Absent when `aggregate: true` */
1000
+ seasonId?: number;
1001
+ shTimeOnIce: number;
1002
+ shTimeOnIcePerGame: number;
1003
+ shifts: number;
1004
+ shiftsPerGame: number;
1005
+ shootsCatches: ShootsCatches;
1006
+ skaterFullName: string;
1007
+ /** Absent when `aggregate: true` */
1008
+ teamAbbrevs?: string;
1009
+ timeOnIce: number;
1010
+ timeOnIcePerGame: number;
1011
+ timeOnIcePerShift: number;
1012
+ }
1013
+ export interface TeamSummaryRow {
1014
+ faceoffWinPct: number;
1015
+ gamesPlayed: number;
1016
+ goalsAgainst: number;
1017
+ goalsAgainstPerGame: number;
1018
+ goalsFor: number;
1019
+ goalsForPerGame: number;
1020
+ losses: number;
1021
+ otLosses: number;
1022
+ penaltyKillNetPct: number;
1023
+ penaltyKillPct: number;
1024
+ pointPct: number;
1025
+ points: number;
1026
+ powerPlayNetPct: number;
1027
+ powerPlayPct: number;
1028
+ regulationAndOtWins: number;
1029
+ /** Absent when `aggregate: true` */
1030
+ seasonId?: number;
1031
+ shotsAgainstPerGame: number;
1032
+ shotsForPerGame: number;
1033
+ /** Absent when `aggregate: true` */
1034
+ teamFullName?: string;
1035
+ /** Absent when `aggregate: true` */
1036
+ teamId?: number;
1037
+ teamShutouts: number;
1038
+ ties: number | null;
1039
+ wins: number;
1040
+ winsInRegulation: number;
1041
+ winsInShootout: number;
1042
+ franchiseId?: number;
1043
+ franchiseName?: string;
1044
+ }
1045
+ /**
1046
+ * Skater report rows keyed by report type (the `en/skater/<report>` path).
1047
+ * Augment this interface to add a report the SDK doesn't know about yet.
1048
+ */
1049
+ export interface SkaterReportRows {
1050
+ summary: SkaterSummaryRow;
1051
+ bios: SkaterBiosRow;
1052
+ faceoffpercentages: SkaterFaceoffPercentagesRow;
1053
+ faceoffwins: SkaterFaceoffWinsRow;
1054
+ goalsForAgainst: SkaterGoalsForAgainstRow;
1055
+ penalties: SkaterPenaltiesRow;
1056
+ penaltykill: SkaterPenaltyKillRow;
1057
+ penaltyShots: SkaterPenaltyShotsRow;
1058
+ percentages: SkaterPercentagesRow;
1059
+ powerplay: SkaterPowerPlayRow;
1060
+ puckPossessions: SkaterPuckPossessionsRow;
1061
+ realtime: SkaterRealtimeRow;
1062
+ scoringRates: SkaterScoringRatesRow;
1063
+ scoringpergame: SkaterScoringPerGameRow;
1064
+ shootout: SkaterShootoutRow;
1065
+ summaryshooting: SkaterSummaryShootingRow;
1066
+ shottype: SkaterShotTypeRow;
1067
+ timeonice: SkaterTimeOnIceRow;
1068
+ }
1069
+ /**
1070
+ * Goalie report rows keyed by report type (the `en/goalie/<report>` path).
1071
+ * Augment this interface to add a report the SDK doesn't know about yet.
1072
+ */
1073
+ export interface GoalieReportRows {
1074
+ summary: GoalieSummaryRow;
1075
+ advanced: GoalieAdvancedRow;
1076
+ bios: GoalieBiosRow;
1077
+ daysrest: GoalieDaysRestRow;
1078
+ penaltyShots: GoaliePenaltyShotsRow;
1079
+ savesByStrength: GoalieSavesByStrengthRow;
1080
+ shootout: GoalieShootoutRow;
1081
+ startedVsRelieved: GoalieStartedVsRelievedRow;
1082
+ }