@bp1222/stats-api 0.0.1

package/Makefile

@@ -0,0 +1,26 @@
+# Colors
+RESET=\033[0m
+GREEN=\033[32m
+YELLOW=\033[33m
+CYAN=\033[36m
+
+.PHONY: all
+all: help
+
+# Cite: https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
+.PHONY: help
+help: ## Display this help page
+	@grep -E '^[a-zA-Z0-9/_-]+:.*?## .*$$' $(MAKEFILE_LIST) | 		\
+	sort | 															\
+	awk ' 															\
+		BEGIN {FS = ":.*?## "; print "${GREEN}mlb-season help:\n"} \
+		{printf "${CYAN}%-30s${RESET} %s\n", $$1, $$2} 				\
+	  	END {print "\n${YELLOW}See README.md for more information${RESET}\n"}'
+
+.PHONY: bundle
+bundle: ## Builds the yaml bundle
+	npx --yes @redocly/cli bundle -o bundle.yaml spec/openapi.yaml
+
+gen:
+	npx --yes @openapitools/openapi-generator-cli generate --generator-key v0-client
+

package/openapitools.json

@@ -0,0 +1,14 @@
+{
+	"$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+	"spaces": 2,
+	"generator-cli": {
+		"version": "7.7.0",
+		"generators": {
+			"v0-client": {
+				"generatorName": "typescript-fetch",
+				"inputSpec": "bundle.yaml",
+				"output": "src"
+			}
+		}
+	}
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@bp1222/stats-api",
+  "version": "0.0.1",
+  "main": "src/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts"
+  },
+  "keywords": ["mlb", "stats-api"],
+  "author": "Dave Walker",
+  "license": "ISC",
+  "description": "Library for Typescript Client to query MLB StatsAPI",
+  "devDependencies": {
+    "@openapitools/openapi-generator-cli": "^2.13.5",
+    "@redocly/cli": "^1.22.1",
+    "tsup": "^8.2.4",
+    "typescript": "^5.5.3"
+  }
+}

package/spec/components/parameters/parameters.yaml

@@ -0,0 +1,21 @@
+# ./query
+Date:
+  $ref: "./query/date.yaml"
+EndDate:
+  $ref: "./query/endDate.yaml"
+Fields:
+  $ref: "./query/fields.yaml"
+Hydrate:
+  $ref: "./query/hydrate.yaml"
+LeagueId:
+  $ref: "./query/leagueId.yaml"
+LeagueIds:
+  $ref: "./query/leagueIds.yaml"
+Season:
+  $ref: "./query/season.yaml"
+SportId:
+  $ref: "./query/sportId.yaml"
+StartDate:
+  $ref: "./query/startDate.yaml"
+TeamId:
+  $ref: "./query/teamId.yaml"

package/spec/components/parameters/query/date.yaml

@@ -0,0 +1,5 @@
+in: query
+name: date
+required: false
+schema:
+  type: string

package/spec/components/parameters/query/endDate.yaml

@@ -0,0 +1,5 @@
+in: query
+name: endDate
+required: false
+schema:
+  type: string

package/spec/components/parameters/query/eventTypes.yaml

@@ -0,0 +1,5 @@
+in: query
+name: teamId
+required: false
+schema:
+  type: number

package/spec/components/parameters/query/fields.yaml

@@ -0,0 +1,10 @@
+in: query
+name: fields
+required: false
+schema:
+  type: array
+  items:
+    type: string
+style: form
+explode: false
+

package/spec/components/parameters/query/gamePks.yaml

@@ -0,0 +1,5 @@
+in: query
+name: teamId
+required: false
+schema:
+  type: number

package/spec/components/parameters/query/gameTypes.yaml

@@ -0,0 +1,5 @@
+in: query
+name: teamId
+required: false
+schema:
+  type: number

package/spec/components/parameters/query/hydrate.yaml

@@ -0,0 +1,5 @@
+in: query
+name: hydrate 
+required: false
+schema:
+  type: string

package/spec/components/parameters/query/leagueId.yaml

@@ -0,0 +1,5 @@
+in: query
+name: leagueId
+required: true
+schema:
+  type: number

package/spec/components/parameters/query/leagueIds.yaml

@@ -0,0 +1,7 @@
+in: query
+name: leagueIds
+required: false
+schema:
+  type: array
+  items:
+    type: number

package/spec/components/parameters/query/opponentId.yaml

@@ -0,0 +1,5 @@
+in: query
+name: teamId
+required: false
+schema:
+  type: number

package/spec/components/parameters/query/scheduleType.yaml

@@ -0,0 +1,5 @@
+in: query
+name: teamId
+required: false
+schema:
+  type: number

package/spec/components/parameters/query/season.yaml

@@ -0,0 +1,5 @@
+in: query
+name: season 
+required: true
+schema:
+  type: string 

package/spec/components/parameters/query/sportId.yaml

@@ -0,0 +1,6 @@
+in: query
+name: sportId
+required: true
+schema:
+  type: number
+  default: 1

package/spec/components/parameters/query/startDate.yaml

@@ -0,0 +1,5 @@
+in: query
+name: startDate
+required: false
+schema:
+  type: string 

package/spec/components/parameters/query/teamId.yaml

@@ -0,0 +1,5 @@
+in: query
+name: teamId
+required: false
+schema:
+  type: number

package/spec/components/parameters/query/venueIds.yaml

@@ -0,0 +1,5 @@
+in: query
+name: teamId
+required: false
+schema:
+  type: number

package/spec/components/schemas/division.yaml

@@ -0,0 +1,32 @@
+title: MLBDivision
+description: >
+  Division 
+type: object
+required:
+  - id
+  - name
+properties:
+  id:
+    type: number
+  name:
+    type: string
+  season:
+    type: string
+  nameShort:
+    type: string
+  link:
+    type: string
+  abbreviation:
+    type: string
+  league:
+    $ref: ./schemas.yaml#/MLBLeague
+  sport:
+    $ref: ./schemas.yaml#/MLBSport
+  hasWildcard:
+    type: boolean 
+  sortOrder:
+    type: number
+  numPlayoffTeams:
+    type: number
+  active:
+    type: boolean

package/spec/components/schemas/game.yaml

@@ -0,0 +1,157 @@
+title: MLBGame
+description: >
+  Game
+type: object
+required:
+  - gamePk
+  - gameGuid
+  - gameType
+  - season
+  - gameDate
+  - officialDate
+  - status
+  - teams
+  - gameNumber
+  - gamesInSeries
+  - seriesGameNumber
+properties:
+  gamePk:
+    type: number
+  gameGuid:
+    type: string
+  link:
+    type: string
+  gameType:
+    type: string
+    enum:
+      - "E"
+      - "S"
+      - "R"
+      - "F"
+      - "D"
+      - "L"
+      - "W"
+    x-enum-varnames:
+      - Exhibition
+      - SpringTraining
+      - Regular
+      - WildCardSeries
+      - DivisionSeries
+      - LeagueChampionshipSeries
+      - WorldSeries
+    description: >
+      Game Type:
+        * `E` - Exhibition
+        * `S` - Spring Training
+        * `R` - Regular Season
+        * `F` - Wild Card Series
+        * `D` - Division Series
+        * `L` - League Championship Series
+        * `W` - World Series
+  season:
+    type: number
+  gameDate:
+    type: string
+  officialDate:
+    type: string
+  rescheduledTo:
+    type: number
+  rescheduledToDate:
+    type: string
+  rescheduledFrom:
+    type: number
+  rescheduledFromDate:
+    type: string
+  status:
+    title: MLBGameStatus
+    type: object
+    properties:
+      abstractGameState:
+        type: string
+      codedGameState:
+        type: string 
+        enum:
+          - "F"
+          - "D"
+          - "S"
+          - "I"
+          - "P"
+          - "O"
+        x-enum-varnames:
+          - Final
+          - Postponed
+          - Scheduled
+          - InProgress
+          - Pregame
+          - GameOver
+        description: >
+          Coded Game State
+            * `F` - Final
+            * `D` - Delayed/Postponed
+            * `S` - Scheduled
+            * `I` - In Progress
+            * `P` - Pregame
+            * `O` - Game Over
+      detailedState:
+        type: string
+      statusCode:
+        type: string
+      startTimeTBD:
+        type: boolean 
+      abstractGameCode:
+        type: string
+  teams:
+    type: object
+    required:
+      - away
+      - home
+    properties:
+      away:
+        $ref: ./schemas.yaml#/MLBGameTeam
+      home:
+        $ref: ./schemas.yaml#/MLBGameTeam
+  venue:
+    $ref: ./schemas.yaml#/MLBVenue
+  content: # What is this!?
+    type: object 
+    properties:
+      link:
+        type: string
+  isTie:
+    type: boolean
+  gameNumber:
+    type: number
+  publicFacing:
+    type: boolean 
+  doubleHeader:
+    type: string # enum?
+  gamedayType:
+    type: string # enum?
+  tiebreaker:
+    type: string # enum?
+  calendarEventID:
+    type: string
+  seasonDisplay:
+    type: string
+  dayNight:
+    type: string # enum?
+  description:
+    type: string
+  scheduledInnings:
+    type: number 
+  reverseHomeAwayStatus:
+    type: boolean 
+  inningBreakLength:
+    type: number 
+  gamesInSeries:
+    type: number 
+  seriesGameNumber:
+    type: number
+  seriesDescription:
+    type: string
+  recordSource:
+    type: string # enum
+  ifNecessary:
+    type: string # enum
+  ifNecessaryDescription:
+    type: string

package/spec/components/schemas/gameTeam.yaml

@@ -0,0 +1,30 @@
+title: MLBGameTeam
+description: >
+  Game Team
+type: object
+required:
+  - leagueReccord
+  - score
+  - isWinner
+  - team
+properties:
+  leagueRecord:
+    title: MLBTeamRecord
+    type: object
+    properties:
+      wins:
+        type: number
+      losses:
+        type: number
+      pct:
+        type: string
+  score:
+    type: number
+  team:
+    $ref: ./schemas.yaml#/MLBTeam
+  isWinner:
+    type: boolean
+  splitSquad:
+    type: boolean
+  seriesNumber:
+    type: number

package/spec/components/schemas/league.yaml

@@ -0,0 +1,62 @@
+title: MLBLeague
+description: >
+  League 
+type: object
+required:
+  - id
+  - name
+properties:
+  id:
+    type: number
+  name:
+    type: string
+  link:
+    type: string
+  abbreviation:
+    type: string
+  nameShort:
+    type: string
+  seasonState:
+    type: string
+  hasWildCard:
+    type: boolean 
+  hasSplitSeason:
+    type: boolean
+  hasPlayoffPoints:
+    type: boolean 
+  seasonDateInfo:
+    title: MLBLeagueDates
+    type: object
+    properties:
+      seasonId:
+        type: string 
+      preSeasonStartDate:
+        type: string 
+      preSeasonEndDate:
+        type: string 
+      seasonStartDate:
+        type: string 
+      springStartDate:
+        type: string 
+      springEndDate:
+        type: string 
+      offseasonStartDate:
+        type: string 
+      offseasonEndDate:
+        type: string 
+      seasonLevelGamedayType:
+        type: string 
+      gameLevelGamedayType:
+        type: string 
+  season:
+    type: string
+  orgCode:
+    type: string
+  conferencesInUse:
+    type: boolean
+  divisionsInUse:
+    type: boolean 
+  sortOrder:
+    type: number 
+  active:
+    type: boolean 

package/spec/components/schemas/record.yaml

@@ -0,0 +1,110 @@
+title: MLBRecord
+description: >
+  Record
+type: object
+required:
+  - team
+  - season
+  - streak
+  - divisionRank
+  - leagueRank
+  - gamesBack
+  - leagueRecord
+  - wins
+  - losses
+properties:
+  team:
+    $ref: ./schemas.yaml#/MLBTeam
+  season:
+    type: string
+  streak:
+    title: MLBStreak
+    type: object
+    properties:
+      streakType:
+        type: string
+        enum:
+          - "losses"
+          - "wins"
+        x-enum-varnames:
+          - Losing
+          - Winning
+        description: >
+          Streak Type:
+            * Losing Streak
+            * Winning Streak
+  divisionRank:
+    type: string
+  leagueRank:
+    type: string
+  sportRank:
+    type: string
+  gamesPlayed:
+    type: number 
+  gamesBack:
+    type: string
+  wildCardGamesBack:
+    type: string
+  leagueGamesBack:
+    type: string
+  sportGamesBack:
+    type: string
+  divisionGamesBack:
+    type: string
+  conferenceGamesBack:
+    type: string
+  leagueRecord:
+    title: MLBTeamRecord
+    type: object
+    required:
+      - wins
+      - losses
+      - ties
+      - pct
+    properties:
+      wins:
+        type: number
+      losses:
+        type: number
+      ties:
+        type: number
+      pct:
+        type: string
+  lastUpdated:
+    type: string
+  # records:  NEED TO FILL OUT MORE
+  #  type: object
+  runsAllowed:
+    type: number 
+  runsScored:
+    type: number 
+  divisionChamp:
+    type: boolean 
+  divisionLeader:
+    type: boolean 
+  hasWildcard:
+    type: boolean 
+  clinched:
+    type: boolean
+  eliminationNumber:
+    type: string 
+  eliminationNumberSport:
+    type: string 
+  eliminationNumberLeague:
+    type: string 
+  eliminationNumberDivision:
+    type: string 
+  eliminationNumberConference:
+    type: string 
+  wildCardEliminationNumber:
+    type: string 
+  magicNumber:
+    type: string 
+  wins:
+    type: number
+  losses:
+    type: number 
+  runDifferential:
+    type: number 
+  winningPercentage:
+    type: string 

package/spec/components/schemas/schedule.yaml

@@ -0,0 +1,41 @@
+title: MLBSchedule
+description: >
+  Schedule
+type: object
+required:
+  - totalItems
+  - totalEvents
+  - totalGames
+  - totalGamesInProgress
+  - dates
+properties:
+  totalItems:
+    type: number
+  totalEvents:
+    type: number
+  totalGames:
+    type: number
+  totalGamesInProgress:
+    type: number
+  dates:
+    type: array
+    items:
+      title: MLBScheduleDay
+      type: object
+      required:
+        - games
+      properties:
+        date:
+          type: string
+        totalItems:
+          type: number
+        totalEvents:
+          type: number
+        totalGames:
+          type: number
+        totalGamesInProgress:
+          type: number
+        games:
+          type: array
+          items:
+            $ref: ./schemas.yaml#/MLBGame

package/spec/components/schemas/schemas.yaml

@@ -0,0 +1,22 @@
+MLBDivision:
+  $ref: ./division.yaml
+MLBGame:
+  $ref: ./game.yaml
+MLBGameTeam:
+  $ref: ./gameTeam.yaml
+MLBLeague:
+  $ref: ./league.yaml
+MLBSeason:
+  $ref: ./season.yaml
+MLBSchedule:
+  $ref: ./schedule.yaml
+MLBSport:
+  $ref: ./sport.yaml
+MLBStandings:
+  $ref: ./standings.yaml
+MLBRecord:
+  $ref: ./record.yaml
+MLBTeam:
+  $ref: ./team.yaml
+MLBVenue:
+  $ref: ./venue.yaml