cfbd 5.0.0-alpha.0 → 5.0.16-alpha.0

package/.github/FUNDING.yml

@@ -0,0 +1 @@
+patreon: collegefootballdata

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,30 @@
+name: Upload TypeScript Package
+
+on:
+  push:
+    branches: 
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build and package
+        run: |
+          yarn build
+          npm pack
+      - name: Publish to npm
+        run: npm publish --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/README.md

@@ -0,0 +1,82 @@
+# cfbd
+This API is in limited Beta for Patreon subscribers. It may have bugs and is subject to changes. API keys can be acquired from the CollegeFootballData.com website.
+
+This TypeScript package is automatically generated by the [Hey API](https://heyapi.vercel.app/) project:
+
+- API version: 5.0.10
+- Package version: 5.0.10-alpha.0
+
+## Requirements.
+
+Node 18+
+
+## Installation
+### npm install
+
+```sh
+npm install cfbd
+```
+
+### yarn install
+
+```sh
+yarn add cfbd
+```
+
+### pnpm install
+
+```sh
+pnpm add cfbd
+```
+
+## Usage
+
+### Authorization
+
+To authorize requests, use the `setConfig` method to set the `Authorization` header using your personal API key. API keys can be acquired from the CollegeFootballData.com website.
+
+```typescript
+import { client } from 'cfbd';
+
+client.setConfig({
+    headers: {
+        'Authorization': 'Bearer YOUR_API_KEY',
+    }
+});
+
+```
+
+### Example Usage
+
+All API operations can be imported from the `cfbd` package and used as shown below.
+
+```typescript
+import { client, getGames } from 'cfbd';
+
+// Set up the client with your API key
+client.setConfig({
+    headers: {
+        'Authorization': 'Bearer YOUR_API_KEY',
+    }
+});
+
+// Call the getGames endpoint
+const games = await getGames({
+    query: {
+        year: 2023,
+        classification: 'fbs',
+    },
+});
+
+for (const game of games.data ?? []) {
+    // Do something with the game data
+    // For example:
+    console.log(`${game.awayTeam} vs ${game.homeTeam} - ${game.excitementIndex}`);
+}
+```
+
+## Author
+
+admin@collegefootballdata.com
+
+

package/dist/schemas.gen.d.ts

@@ -3303,7 +3303,6 @@ export declare const $Game: {
             };
             readonly type: "array";
             readonly nullable: true;
-            readonly minItems: 4;
         };
         readonly homePostgameWinProbability: {
             readonly type: "number";
@@ -3349,7 +3348,6 @@ export declare const $Game: {
             };
             readonly type: "array";
             readonly nullable: true;
-            readonly minItems: 4;
         };
         readonly awayPostgameWinProbability: {
             readonly type: "number";
@@ -4305,7 +4303,7 @@ export declare const $Coach: {
         };
         readonly hireDate: {
             readonly type: "string";
-            readonly format: "date";
+            readonly format: "date-time";
             readonly nullable: true;
         };
         readonly seasons: {

package/dist/schemas.gen.js

@@ -3322,8 +3322,7 @@ exports.$Game = {
                 format: 'double'
             },
             type: 'array',
-            nullable: true,
-            minItems: 4
+            nullable: true
         },
         homePostgameWinProbability: {
             type: 'number',
@@ -3370,8 +3369,7 @@ exports.$Game = {
                 format: 'double'
             },
             type: 'array',
-            nullable: true,
-            minItems: 4
+            nullable: true
         },
         awayPostgameWinProbability: {
             type: 'number',
@@ -4333,7 +4331,7 @@ exports.$Coach = {
         },
         hireDate: {
             type: 'string',
-            format: 'date',
+            format: 'date-time',
             nullable: true
         },
         seasons: {

package/dist/services.gen.js

@@ -15,7 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDraftTeams = exports.getDrives = exports.getScoreboard = exports.getCalendar = exports.getRecords = exports.getWeather = exports.getMedia = exports.getGamePlayerStats = exports.getGameTeamStats = exports.getGames = exports.getLines = exports.getLivePlays = exports.getFieldGoalExpectedPoints = exports.getPregameWinProbabilities = exports.getWinProbability = exports.getPredictedPointsAddedByPlayerSeason = exports.getPredictedPointsAddedByPlayerGame = exports.getPredictedPointsAddedByGame = exports.getPredictedPointsAddedByTeam = exports.getPredictedPoints = exports.getTransferPortal = exports.getReturningProduction = exports.getPlayerUsage = exports.searchPlayers = exports.getPlayStatTypes = exports.getPlayStats = exports.getPlayTypes = exports.getPlays = exports.getRankings = exports.getFpi = exports.getElo = exports.getSrs = exports.getConferenceSp = exports.getSp = exports.getAggregatedTeamRecruitingRatings = exports.getTeamRecruitingRankings = exports.getRecruits = exports.getAdvancedGameStats = exports.getAdvancedSeasonStats = exports.getCategories = exports.getTeamStats = exports.getPlayerSeasonStats = exports.getVenues = exports.getTalent = exports.getConferences = exports.getRoster = exports.getMatchup = exports.getFbsTeams = exports.getTeams = exports.client = void 0;
 exports.getAdvancedBoxScore = exports.getCoaches = exports.getDraftPicks = exports.getDraftPositions = void 0;
 var client_fetch_1 = require("@hey-api/client-fetch");
-exports.client = (0, client_fetch_1.createClient)((0, client_fetch_1.createConfig)());
+exports.client = (0, client_fetch_1.createClient)((0, client_fetch_1.createConfig)({ baseUrl: 'https://apinext.collegefootballdata.com' }));
 /**
  * Retrieves team information
  */

package/package.json

@@ -1,6 +1,19 @@
 {
   "name": "cfbd",
-  "version": "5.0.0-alpha.0",
+  "version": "5.0.16-alpha.0",
+  "description": "This API is in limited Beta for Patreon subscribers. It may have bugs and is subject to changes. API keys can be acquired from the CollegeFootballData.com website.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/CFBD/cfbd-typescript.git"
+  },
+  "author": "BlueSCar",
+  "keywords": [
+    "football",
+    "cfb",
+    "ncaaf",
+    "data",
+    "statistics"
+  ],
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -11,6 +24,7 @@
     "@hey-api/client-fetch": "^0.2.4"
   },
   "devDependencies": {
+    "@hey-api/openapi-ts": "^0.52.9",
     "@types/node": "^22.5.0",
     "typescript": "^5.5.4"
   }

package/src/schemas.gen.ts

@@ -3368,8 +3368,7 @@ export const $Game = {
                 format: 'double'
             },
             type: 'array',
-            nullable: true,
-            minItems: 4
+            nullable: true
         },
         homePostgameWinProbability: {
             type: 'number',
@@ -3416,8 +3415,7 @@ export const $Game = {
                 format: 'double'
             },
             type: 'array',
-            nullable: true,
-            minItems: 4
+            nullable: true
         },
         awayPostgameWinProbability: {
             type: 'number',
@@ -4401,7 +4399,7 @@ export const $Coach = {
         },
         hireDate: {
             type: 'string',
-            format: 'date',
+            format: 'date-time',
             nullable: true
         },
         seasons: {

package/src/services.gen.ts

@@ -3,7 +3,7 @@
 import { createClient, createConfig, type Options } from '@hey-api/client-fetch';
 import type { GetTeamsData, GetTeamsError, GetTeamsResponse, GetFbsTeamsData, GetFbsTeamsError, GetFbsTeamsResponse, GetMatchupData, GetMatchupError, GetMatchupResponse, GetRosterData, GetRosterError, GetRosterResponse, GetConferencesError, GetConferencesResponse, GetTalentData, GetTalentError, GetTalentResponse, GetVenuesError, GetVenuesResponse, GetPlayerSeasonStatsData, GetPlayerSeasonStatsError, GetPlayerSeasonStatsResponse, GetTeamStatsData, GetTeamStatsError, GetTeamStatsResponse, GetCategoriesError, GetCategoriesResponse, GetAdvancedSeasonStatsData, GetAdvancedSeasonStatsError, GetAdvancedSeasonStatsResponse, GetAdvancedGameStatsData, GetAdvancedGameStatsError, GetAdvancedGameStatsResponse, GetRecruitsData, GetRecruitsError, GetRecruitsResponse, GetTeamRecruitingRankingsData, GetTeamRecruitingRankingsError, GetTeamRecruitingRankingsResponse, GetAggregatedTeamRecruitingRatingsData, GetAggregatedTeamRecruitingRatingsError, GetAggregatedTeamRecruitingRatingsResponse, GetSpData, GetSpError, GetSpResponse, GetConferenceSpData, GetConferenceSpError, GetConferenceSpResponse, GetSrsData, GetSrsError, GetSrsResponse, GetEloData, GetEloError, GetEloResponse, GetFpiData, GetFpiError, GetFpiResponse, GetRankingsData, GetRankingsError, GetRankingsResponse, GetPlaysData, GetPlaysError, GetPlaysResponse, GetPlayTypesError, GetPlayTypesResponse, GetPlayStatsData, GetPlayStatsError, GetPlayStatsResponse, GetPlayStatTypesError, GetPlayStatTypesResponse, SearchPlayersData, SearchPlayersError, SearchPlayersResponse, GetPlayerUsageData, GetPlayerUsageError, GetPlayerUsageResponse, GetReturningProductionData, GetReturningProductionError, GetReturningProductionResponse, GetTransferPortalData, GetTransferPortalError, GetTransferPortalResponse, GetPredictedPointsData, GetPredictedPointsError, GetPredictedPointsResponse, GetPredictedPointsAddedByTeamData, GetPredictedPointsAddedByTeamError, GetPredictedPointsAddedByTeamResponse, GetPredictedPointsAddedByGameData, GetPredictedPointsAddedByGameError, GetPredictedPointsAddedByGameResponse, GetPredictedPointsAddedByPlayerGameData, GetPredictedPointsAddedByPlayerGameError, GetPredictedPointsAddedByPlayerGameResponse, GetPredictedPointsAddedByPlayerSeasonData, GetPredictedPointsAddedByPlayerSeasonError, GetPredictedPointsAddedByPlayerSeasonResponse, GetWinProbabilityData, GetWinProbabilityError, GetWinProbabilityResponse, GetPregameWinProbabilitiesData, GetPregameWinProbabilitiesError, GetPregameWinProbabilitiesResponse, GetFieldGoalExpectedPointsError, GetFieldGoalExpectedPointsResponse, GetLivePlaysData, GetLivePlaysError, GetLivePlaysResponse, GetLinesData, GetLinesError, GetLinesResponse, GetGamesData, GetGamesError, GetGamesResponse, GetGameTeamStatsData, GetGameTeamStatsError, GetGameTeamStatsResponse, GetGamePlayerStatsData, GetGamePlayerStatsError, GetGamePlayerStatsResponse, GetMediaData, GetMediaError, GetMediaResponse, GetWeatherData, GetWeatherError, GetWeatherResponse, GetRecordsData, GetRecordsError, GetRecordsResponse, GetCalendarData, GetCalendarError, GetCalendarResponse, GetScoreboardData, GetScoreboardError, GetScoreboardResponse, GetDrivesData, GetDrivesError, GetDrivesResponse, GetDraftTeamsError, GetDraftTeamsResponse, GetDraftPositionsError, GetDraftPositionsResponse, GetDraftPicksData, GetDraftPicksError, GetDraftPicksResponse, GetCoachesData, GetCoachesError, GetCoachesResponse, GetAdvancedBoxScoreData, GetAdvancedBoxScoreError, GetAdvancedBoxScoreResponse } from './types.gen';
 
-export const client = createClient(createConfig());
+export const client = createClient(createConfig({ baseUrl: 'https://apinext.collegefootballdata.com' }));
 
 /**
  * Retrieves team information

package/dist/src/index.d.ts

@@ -1,3 +0,0 @@
-export * from './schemas.gen';
-export * from './services.gen';
-export * from './types.gen';

package/dist/src/index.js

@@ -1,20 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-// This file is auto-generated by @hey-api/openapi-ts
-__exportStar(require("./schemas.gen"), exports);
-__exportStar(require("./services.gen"), exports);
-__exportStar(require("./types.gen"), exports);