@scoreboardmax/api-types 1.0.53 → 1.0.55

package/dist/index.cjs

@@ -7,7 +7,7 @@
  *
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorCode = exports.WrestlingStyle = exports.WrestlingPeriod = exports.WrestlingOvertimeType = exports.WrestlingMeetType = exports.WebsocketOperation = exports.MetaMessageType = exports.WebsocketMessageType = exports.VolleyballSet = exports.isWrestlingData = exports.isVolleyballData = exports.isSoccerData = exports.isFootballData = exports.isBasketballData = exports.isBaseballData = exports.BaseballInningSegment = exports.TemplateUseCase = exports.ScoreboardType = exports.SoccerGamePeriods = exports.SoccerPeriod = exports.SoccerPenaltyCardType = exports.ScoreboardCode = exports.OAuthProvider = exports.OAuthAction = exports.MagicLinkType = exports.FootballPeriod = exports.TalkingPointFocus = exports.FileType = exports.ContentType = exports.ExtraTimeLabel = exports.EventAction = exports.AppEntitlementRequirement = exports.TalkingPointEnergy = exports.DownAndDistanceDisplay = exports.DisplayConnectionStatus = exports.ClockType = exports.BasketballTimeoutAllocation = exports.BasketballGamePeriods = exports.BasketballPeriod = exports.PlanId = exports.AuthType = exports.AppType = exports.AppEntitlementType = exports.AppEntitlementGrantedBy = exports.ApiResource = exports.ApiAction = void 0;
+exports.ErrorCode = exports.WrestlingStyle = exports.WrestlingPeriod = exports.WrestlingOvertimeType = exports.WrestlingMeetType = exports.WebsocketOperation = exports.MetaMessageType = exports.WebsocketMessageType = exports.VolleyballSet = exports.isWrestlingData = exports.isVolleyballData = exports.isSoccerData = exports.isFootballData = exports.isBasketballData = exports.isBaseballData = exports.BaseballInningSegment = exports.TemplateUseCase = exports.ScoreboardType = exports.SoccerGamePeriods = exports.SoccerPeriod = exports.SoccerPenaltyCardType = exports.ScoreboardCode = exports.PlateAppearanceResult = exports.OAuthProvider = exports.OAuthAction = exports.MagicLinkType = exports.FootballPeriod = exports.TalkingPointFocus = exports.FileType = exports.ContentType = exports.ExtraTimeLabel = exports.EventAction = exports.AppEntitlementRequirement = exports.TalkingPointEnergy = exports.DownAndDistanceDisplay = exports.DisplayConnectionStatus = exports.ClockType = exports.BasketballTimeoutAllocation = exports.BasketballGamePeriods = exports.BasketballPeriod = exports.PlanId = exports.AuthType = exports.AppType = exports.AppEntitlementType = exports.AppEntitlementGrantedBy = exports.ApiResource = exports.ApiAction = void 0;
 /**
  * API action identifiers
  */
@@ -277,6 +277,20 @@ var OAuthProvider;
 (function (OAuthProvider) {
     OAuthProvider["Google"] = "google";
 })(OAuthProvider || (exports.OAuthProvider = OAuthProvider = {}));
+/**
+ * Plate appearance result type
+ */
+var PlateAppearanceResult;
+(function (PlateAppearanceResult) {
+    PlateAppearanceResult["Hit"] = "hit";
+    PlateAppearanceResult["Out"] = "out";
+    PlateAppearanceResult["NoAb"] = "noAb";
+    PlateAppearanceResult["Walk"] = "walk";
+    PlateAppearanceResult["HitByPitch"] = "hitByPitch";
+    PlateAppearanceResult["Sacrifice"] = "sacrifice";
+    PlateAppearanceResult["Error"] = "error";
+    PlateAppearanceResult["FieldersChoice"] = "fieldersChoice";
+})(PlateAppearanceResult || (exports.PlateAppearanceResult = PlateAppearanceResult = {}));
 /**
  * Short codes for sport types
  */

package/dist/index.d.ts

@@ -5,6 +5,15 @@
  * These types are automatically generated from the ScoreboardMax API source code.
  *
  */
+/**
+ * A single plate appearance with its result and optional count data.
+ * When the client records a result, it includes the ball/strike count at that moment.
+ */
+export interface PlateAppearance {
+    result: PlateAppearanceResult;
+    balls?: number;
+    strikes?: number;
+}
 /**
  * Account creation/update request
  */
@@ -331,6 +340,22 @@ export interface BaseballDataResponse {
     team2: BaseballScoreboardTeamResponse;
     settings: BaseballSettingsResponse;
 }
+/**
+ * Baseball game insight analytics response
+ */
+export interface BaseballInsightResponse {
+    team1: BaseballInsightTeamResponse;
+    team2: BaseballInsightTeamResponse;
+    inning: number;
+    inningSegment: BaseballInningSegment;
+    balls: number | null;
+    strikes: number | null;
+    outs: number | null;
+    final: boolean;
+    leadChanges: number;
+    ties: number;
+    innings: number;
+}
 /**
  * Baseball game settings model
  */
@@ -346,6 +371,34 @@ export interface BaseballSettings extends ScoreboardSettingsBase {
     enableClockAutomations: boolean;
     innings: number;
 }
+/**
+ * Baseball insight team statistics response
+ */
+export interface BaseballInsightTeam {
+    name: string;
+    abbreviation: string;
+    color: string;
+    logoUrl: string | null;
+    runs: number;
+    pitchCount: number;
+    balls: number;
+    strikes: number;
+    isHomeTeam: boolean;
+    reference: string;
+    largestLeadAmount: number | null;
+    largestLeadInning: number | null;
+    batter: BaseballBatterSummary | null;
+    onDeck: BaseballBatterSummary | null;
+    pitcher: BaseballPitcherSummary | null;
+    inningSummaries: BaseballInningSummary[];
+    batterSummaries: BaseballBatterSummary[];
+    pitcherSummaries: BaseballPitcherSummary[];
+}
+/**
+ * Baseball insight team statistics response
+ */
+export interface BaseballInsightTeamResponse extends BaseballInsightTeam {
+}
 /**
  * Baseball settings request
  */
@@ -364,12 +417,16 @@ export interface BaseballScoreboardTeamRequest extends ScoreboardTeamBaseRequest
     inningRuns: number[];
     hits: number;
     errors: number;
+    pitchCount?: number;
+    balls?: number;
+    strikes?: number;
     pitcher: PlayerSummaryRequest | null;
     pitcherStats: PitcherStatsRequest[];
     batter: PlayerSummaryRequest | null;
     battingRecord: BattingRecordRequest[];
     battingList: PlayerSummaryRequest[];
     isHomeTeam: boolean;
+    initialBattingListSize?: number;
 }
 /**
  * Baseball team response
@@ -379,12 +436,16 @@ export interface BaseballScoreboardTeamResponse extends ScoreboardTeamBaseRespon
     inningRuns: number[];
     hits: number;
     errors: number;
+    pitchCount?: number;
+    balls?: number;
+    strikes?: number;
     pitcher: PlayerSummaryResponse | null;
     pitcherStats: PitcherStatsResponse[];
     batter: PlayerSummaryResponse | null;
     battingRecord: BattingRecordResponse[];
     battingList: PlayerSummaryResponse[];
     isHomeTeam: boolean;
+    initialBattingListSize?: number;
 }
 /**
  * Basketball game data request
@@ -629,8 +690,8 @@ export declare enum BasketballTimeoutAllocation {
  * Batting record
  */
 export interface BattingRecord {
-    playerId: string;
-    results: (boolean | null)[];
+    playerReference: string;
+    plateAppearances: PlateAppearance[];
 }
 /**
  * Batting record request
@@ -981,7 +1042,7 @@ export interface InsightResponse {
     dateGameStart: string;
     dateGameEnd?: string;
     qualityScore: number;
-    data: BasketballInsightResponse;
+    data: BasketballInsightResponse | BaseballInsightResponse;
     talkingPoints: TalkingPointsResponse[];
 }
 /**
@@ -1244,6 +1305,76 @@ export interface UserListResponse {
     pageNext: string | null;
     data: UserResponse[];
 }
+/**
+ * Per-inning summary statistics
+ */
+export interface BaseballInningSummary {
+    inning: number;
+    isBattingComplete: boolean;
+    isPitchingComplete: boolean;
+    runs: number;
+    hits: number;
+    errors: number;
+    cumulativeRuns: number;
+    pitchCount: number;
+    strikeoutsAt: number[];
+    walksAt: number[];
+    runsAt: number[];
+    hitsAt: number[];
+    outsAt: number[];
+    pitcherChangedAt: number[];
+    runnerOnFirst: boolean;
+    runnerOnSecond: boolean;
+    runnerOnThird: boolean;
+    plateAppearances: BaseballPlateAppearance[];
+    pitchPerformanceScore: number[];
+}
+/**
+ * Per-pitcher game stats for the pitching overview visualization
+ */
+export interface BaseballPitcherSummary {
+    playerReference: string;
+    playerName: string;
+    playerNumber: string | null;
+    pitchCount: number;
+    strikeouts: number;
+    walks: number;
+    balls: number;
+    strikes: number;
+    hits: number;
+    /** Average pitches per completed plate appearance (null if no completed PAs) */
+    pitchesPerPlateAppearance: number | null;
+}
+/**
+ * Per-plate-appearance record within an inning
+ */
+export interface BaseballPlateAppearance {
+    /** Global sequence number for this PA (1..N) */
+    seq: number;
+    /** Batter identity */
+    playerReference: string;
+    playerName: string;
+    playerNumber: string | null;
+    /** Outcome of this plate appearance */
+    result: PlateAppearanceResult;
+    /** Number of pitches thrown during this PA */
+    pitchCount: number;
+    /** Whether this PA ended in a strikeout */
+    isStrikeout: boolean;
+    /** Number of balls thrown during this PA */
+    balls: number;
+    /** Number of strikes thrown during this PA */
+    strikes: number;
+}
+/**
+ * Per-player batting summary for the batting matrix visualization
+ */
+export interface BaseballBatterSummary {
+    playerReference: string;
+    playerName: string;
+    playerNumber: string | null;
+    plateAppearances: PlateAppearance[];
+}
 /**
  * Permission URI-to-actions mapping
  */
@@ -1254,7 +1385,7 @@ export type PermissionItem = {
  * Pitcher stats
  */
 export interface PitcherStats {
-    playerId: string;
+    playerReference: string;
     pitchCount?: number;
     strikeouts?: number;
     walks?: number;
@@ -1269,6 +1400,19 @@ export interface PitcherStatsRequest extends PitcherStats {
  */
 export interface PitcherStatsResponse extends PitcherStats {
 }
+/**
+ * Plate appearance result type
+ */
+export declare enum PlateAppearanceResult {
+    Hit = "hit",
+    Out = "out",
+    NoAb = "noAb",
+    Walk = "walk",
+    HitByPitch = "hitByPitch",
+    Sacrifice = "sacrifice",
+    Error = "error",
+    FieldersChoice = "fieldersChoice"
+}
 /**
  * Player creation/update request
  */

package/dist/index.mjs

@@ -274,6 +274,20 @@ export var OAuthProvider;
 (function (OAuthProvider) {
     OAuthProvider["Google"] = "google";
 })(OAuthProvider || (OAuthProvider = {}));
+/**
+ * Plate appearance result type
+ */
+export var PlateAppearanceResult;
+(function (PlateAppearanceResult) {
+    PlateAppearanceResult["Hit"] = "hit";
+    PlateAppearanceResult["Out"] = "out";
+    PlateAppearanceResult["NoAb"] = "noAb";
+    PlateAppearanceResult["Walk"] = "walk";
+    PlateAppearanceResult["HitByPitch"] = "hitByPitch";
+    PlateAppearanceResult["Sacrifice"] = "sacrifice";
+    PlateAppearanceResult["Error"] = "error";
+    PlateAppearanceResult["FieldersChoice"] = "fieldersChoice";
+})(PlateAppearanceResult || (PlateAppearanceResult = {}));
 /**
  * Short codes for sport types
  */

package/dist/internal.cjs

@@ -10,7 +10,8 @@
  *
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorCode = exports.WrestlingStyle = exports.WrestlingPeriod = exports.WrestlingOvertimeType = exports.WrestlingMeetType = exports.WebsocketOperation = exports.MetaMessageType = exports.WebsocketMessageType = exports.VolleyballSet = exports.isWrestlingData = exports.isVolleyballData = exports.isSoccerData = exports.isFootballData = exports.isBasketballData = exports.isBaseballData = exports.isUserResponseAdmin = exports.isUserListResponseAdmin = exports.isAuthResponseAdmin = exports.isAccountResponseAdmin = exports.BaseballInningSegment = exports.TemplateUseCase = exports.ScoreboardType = exports.SoccerGamePeriods = exports.SoccerPeriod = exports.SoccerPenaltyCardType = exports.ScoreboardCode = exports.OAuthProvider = exports.OAuthAction = exports.MagicLinkType = exports.FootballPeriod = exports.TalkingPointFocus = exports.FileType = exports.ContentType = exports.ExtraTimeLabel = exports.EventAction = exports.AppEntitlementRequirement = exports.TalkingPointEnergy = exports.DownAndDistanceDisplay = exports.DisplayConnectionStatus = exports.ClockType = exports.BasketballTimeoutAllocation = exports.BasketballGamePeriods = exports.BasketballPeriod = exports.PlanId = exports.AuthType = exports.AppType = exports.AppEntitlementType = exports.AppEntitlementGrantedBy = exports.ApiResource = exports.ApiAction = void 0;
+exports.WrestlingStyle = exports.WrestlingPeriod = exports.WrestlingOvertimeType = exports.WrestlingMeetType = exports.WebsocketOperation = exports.MetaMessageType = exports.WebsocketMessageType = exports.VolleyballSet = exports.isWrestlingData = exports.isVolleyballData = exports.isSoccerData = exports.isFootballData = exports.isBasketballData = exports.isBaseballData = exports.isUserResponseAdmin = exports.isUserListResponseAdmin = exports.isAuthResponseAdmin = exports.isAccountResponseAdmin = exports.BaseballInningSegment = exports.TemplateUseCase = exports.ScoreboardType = exports.SoccerGamePeriods = exports.SoccerPeriod = exports.SoccerPenaltyCardType = exports.ScoreboardCode = exports.PlateAppearanceResult = exports.OAuthProvider = exports.OAuthAction = exports.MagicLinkType = exports.FootballPeriod = exports.TalkingPointFocus = exports.FileType = exports.ContentType = exports.ExtraTimeLabel = exports.EventAction = exports.AppEntitlementRequirement = exports.TalkingPointEnergy = exports.DownAndDistanceDisplay = exports.DisplayConnectionStatus = exports.ClockType = exports.BasketballTimeoutAllocation = exports.BasketballGamePeriods = exports.BasketballPeriod = exports.PlanId = exports.AuthType = exports.AppType = exports.AppEntitlementType = exports.AppEntitlementGrantedBy = exports.ApiResource = exports.ApiAction = void 0;
+exports.ErrorCode = void 0;
 /**
  * API action identifiers
  */
@@ -280,6 +281,20 @@ var OAuthProvider;
 (function (OAuthProvider) {
     OAuthProvider["Google"] = "google";
 })(OAuthProvider || (exports.OAuthProvider = OAuthProvider = {}));
+/**
+ * Plate appearance result type
+ */
+var PlateAppearanceResult;
+(function (PlateAppearanceResult) {
+    PlateAppearanceResult["Hit"] = "hit";
+    PlateAppearanceResult["Out"] = "out";
+    PlateAppearanceResult["NoAb"] = "noAb";
+    PlateAppearanceResult["Walk"] = "walk";
+    PlateAppearanceResult["HitByPitch"] = "hitByPitch";
+    PlateAppearanceResult["Sacrifice"] = "sacrifice";
+    PlateAppearanceResult["Error"] = "error";
+    PlateAppearanceResult["FieldersChoice"] = "fieldersChoice";
+})(PlateAppearanceResult || (exports.PlateAppearanceResult = PlateAppearanceResult = {}));
 /**
  * Short codes for sport types
  */

package/dist/internal.d.ts

@@ -8,6 +8,15 @@
  * these interfaces will not be returned by the API to non-admin users.
  *
  */
+/**
+ * A single plate appearance with its result and optional count data.
+ * When the client records a result, it includes the ball/strike count at that moment.
+ */
+export interface PlateAppearance {
+    result: PlateAppearanceResult;
+    balls?: number;
+    strikes?: number;
+}
 /**
  * Account creation/update request
  */
@@ -354,6 +363,22 @@ export interface BaseballDataResponse {
     team2: BaseballScoreboardTeamResponse;
     settings: BaseballSettingsResponse;
 }
+/**
+ * Baseball game insight analytics response
+ */
+export interface BaseballInsightResponse {
+    team1: BaseballInsightTeamResponse;
+    team2: BaseballInsightTeamResponse;
+    inning: number;
+    inningSegment: BaseballInningSegment;
+    balls: number | null;
+    strikes: number | null;
+    outs: number | null;
+    final: boolean;
+    leadChanges: number;
+    ties: number;
+    innings: number;
+}
 /**
  * Baseball game settings model
  */
@@ -369,6 +394,34 @@ export interface BaseballSettings extends ScoreboardSettingsBase {
     enableClockAutomations: boolean;
     innings: number;
 }
+/**
+ * Baseball insight team statistics response
+ */
+export interface BaseballInsightTeam {
+    name: string;
+    abbreviation: string;
+    color: string;
+    logoUrl: string | null;
+    runs: number;
+    pitchCount: number;
+    balls: number;
+    strikes: number;
+    isHomeTeam: boolean;
+    reference: string;
+    largestLeadAmount: number | null;
+    largestLeadInning: number | null;
+    batter: BaseballBatterSummary | null;
+    onDeck: BaseballBatterSummary | null;
+    pitcher: BaseballPitcherSummary | null;
+    inningSummaries: BaseballInningSummary[];
+    batterSummaries: BaseballBatterSummary[];
+    pitcherSummaries: BaseballPitcherSummary[];
+}
+/**
+ * Baseball insight team statistics response
+ */
+export interface BaseballInsightTeamResponse extends BaseballInsightTeam {
+}
 /**
  * Baseball settings request
  */
@@ -387,12 +440,16 @@ export interface BaseballScoreboardTeamRequest extends ScoreboardTeamBaseRequest
     inningRuns: number[];
     hits: number;
     errors: number;
+    pitchCount?: number;
+    balls?: number;
+    strikes?: number;
     pitcher: PlayerSummaryRequest | null;
     pitcherStats: PitcherStatsRequest[];
     batter: PlayerSummaryRequest | null;
     battingRecord: BattingRecordRequest[];
     battingList: PlayerSummaryRequest[];
     isHomeTeam: boolean;
+    initialBattingListSize?: number;
 }
 /**
  * Baseball team response
@@ -402,12 +459,16 @@ export interface BaseballScoreboardTeamResponse extends ScoreboardTeamBaseRespon
     inningRuns: number[];
     hits: number;
     errors: number;
+    pitchCount?: number;
+    balls?: number;
+    strikes?: number;
     pitcher: PlayerSummaryResponse | null;
     pitcherStats: PitcherStatsResponse[];
     batter: PlayerSummaryResponse | null;
     battingRecord: BattingRecordResponse[];
     battingList: PlayerSummaryResponse[];
     isHomeTeam: boolean;
+    initialBattingListSize?: number;
 }
 /**
  * Basketball game data request
@@ -652,8 +713,8 @@ export declare enum BasketballTimeoutAllocation {
  * Batting record
  */
 export interface BattingRecord {
-    playerId: string;
-    results: (boolean | null)[];
+    playerReference: string;
+    plateAppearances: PlateAppearance[];
 }
 /**
  * Batting record request
@@ -1004,7 +1065,7 @@ export interface InsightResponse {
     dateGameStart: string;
     dateGameEnd?: string;
     qualityScore: number;
-    data: BasketballInsightResponse;
+    data: BasketballInsightResponse | BaseballInsightResponse;
     talkingPoints: TalkingPointsResponse[];
 }
 /**
@@ -1267,6 +1328,76 @@ export interface UserListResponse {
     pageNext: string | null;
     data: UserResponse[];
 }
+/**
+ * Per-inning summary statistics
+ */
+export interface BaseballInningSummary {
+    inning: number;
+    isBattingComplete: boolean;
+    isPitchingComplete: boolean;
+    runs: number;
+    hits: number;
+    errors: number;
+    cumulativeRuns: number;
+    pitchCount: number;
+    strikeoutsAt: number[];
+    walksAt: number[];
+    runsAt: number[];
+    hitsAt: number[];
+    outsAt: number[];
+    pitcherChangedAt: number[];
+    runnerOnFirst: boolean;
+    runnerOnSecond: boolean;
+    runnerOnThird: boolean;
+    plateAppearances: BaseballPlateAppearance[];
+    pitchPerformanceScore: number[];
+}
+/**
+ * Per-pitcher game stats for the pitching overview visualization
+ */
+export interface BaseballPitcherSummary {
+    playerReference: string;
+    playerName: string;
+    playerNumber: string | null;
+    pitchCount: number;
+    strikeouts: number;
+    walks: number;
+    balls: number;
+    strikes: number;
+    hits: number;
+    /** Average pitches per completed plate appearance (null if no completed PAs) */
+    pitchesPerPlateAppearance: number | null;
+}
+/**
+ * Per-plate-appearance record within an inning
+ */
+export interface BaseballPlateAppearance {
+    /** Global sequence number for this PA (1..N) */
+    seq: number;
+    /** Batter identity */
+    playerReference: string;
+    playerName: string;
+    playerNumber: string | null;
+    /** Outcome of this plate appearance */
+    result: PlateAppearanceResult;
+    /** Number of pitches thrown during this PA */
+    pitchCount: number;
+    /** Whether this PA ended in a strikeout */
+    isStrikeout: boolean;
+    /** Number of balls thrown during this PA */
+    balls: number;
+    /** Number of strikes thrown during this PA */
+    strikes: number;
+}
+/**
+ * Per-player batting summary for the batting matrix visualization
+ */
+export interface BaseballBatterSummary {
+    playerReference: string;
+    playerName: string;
+    playerNumber: string | null;
+    plateAppearances: PlateAppearance[];
+}
 /**
  * Permission URI-to-actions mapping
  */
@@ -1277,7 +1408,7 @@ export type PermissionItem = {
  * Pitcher stats
  */
 export interface PitcherStats {
-    playerId: string;
+    playerReference: string;
     pitchCount?: number;
     strikeouts?: number;
     walks?: number;
@@ -1292,6 +1423,19 @@ export interface PitcherStatsRequest extends PitcherStats {
  */
 export interface PitcherStatsResponse extends PitcherStats {
 }
+/**
+ * Plate appearance result type
+ */
+export declare enum PlateAppearanceResult {
+    Hit = "hit",
+    Out = "out",
+    NoAb = "noAb",
+    Walk = "walk",
+    HitByPitch = "hitByPitch",
+    Sacrifice = "sacrifice",
+    Error = "error",
+    FieldersChoice = "fieldersChoice"
+}
 /**
  * Player creation/update request
  */

package/dist/internal.mjs

@@ -277,6 +277,20 @@ export var OAuthProvider;
 (function (OAuthProvider) {
     OAuthProvider["Google"] = "google";
 })(OAuthProvider || (OAuthProvider = {}));
+/**
+ * Plate appearance result type
+ */
+export var PlateAppearanceResult;
+(function (PlateAppearanceResult) {
+    PlateAppearanceResult["Hit"] = "hit";
+    PlateAppearanceResult["Out"] = "out";
+    PlateAppearanceResult["NoAb"] = "noAb";
+    PlateAppearanceResult["Walk"] = "walk";
+    PlateAppearanceResult["HitByPitch"] = "hitByPitch";
+    PlateAppearanceResult["Sacrifice"] = "sacrifice";
+    PlateAppearanceResult["Error"] = "error";
+    PlateAppearanceResult["FieldersChoice"] = "fieldersChoice";
+})(PlateAppearanceResult || (PlateAppearanceResult = {}));
 /**
  * Short codes for sport types
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scoreboardmax/api-types",
-  "version": "1.0.53",
+  "version": "1.0.55",
   "description": "TypeScript definitions for ScoreboardMax API",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",