Skip to content

api-reference.md

Latest commit

 

History

History
118 lines (81 loc) · 6.43 KB

api-reference.md

File metadata and controls

118 lines (81 loc) · 6.43 KB
Raw

Package API index

This page maps every published package to its supported root API and detailed package documentation. The package's src/index.ts is authoritative; deep src/* or dist/* imports are unsupported.

The generated TypeDoc site covers the supported root exports of all ten public packages. This hand-curated index adds package purpose and entry-point guidance; each package section links directly to its generated module reference.

Core engines

@buzzr/dfs-engine

DFS validation, effective-dated compatibility/custom policies, stat providers, settlement, payout math, provenance, and audit records.

  • Primary runtime: createDfsEngine, defineStatProvider, defineBookPolicy, definePayoutTable, validateBookPolicyDefinition, validateDfsEntryInput, grading/payout helpers, league adapters, and migration adapters.
  • Primary contracts: DfsEntryInput, DfsLegInput, DfsSettlementContext, DfsSettlementResult, batch result/cache types, policy/table/source/verification types, and provider interfaces.
  • README
  • Root exports
  • Generated TypeDoc

@buzzr/bets-core

Sportsbook odds, value, bankroll, and history analytics.

  • Primary runtime: americanOddsToImpliedProbability, probabilityToAmericanOdds, calculateNoVigFairLine, combineAmericanOdds, calculateParlayProbability, calculateParlayFairValue, calculateExpectedValue, calculateKellyStake, calculateClosingLineValue, calculateBetRollup, calculateRollupByPeriod, calculateDrawdown, calculateStreaks, normalizeSportsbookSlug, and betRecordToDfsEntryInput.
  • README
  • Root exports
  • Generated TypeDoc

@buzzr/entertainment-engine

Transparent entertainment scoring, feature extraction/training, model diagnostics, reporting, and personalized recommendations.

  • Primary runtime: resolveBuzzScores, enrichGameRowWithBuzzScores, isMustWatch, predictGame, predictGameWithDiagnostics, trainSGD, validateModel, buildModelRunReport, rankGamesForUser, and explainRecommendation.
  • Primary constants/contracts: MUST_WATCH_THRESHOLD, model version/feature constants, score/model/report types, UserAffinityProfile, and recommendation types.
  • README
  • Root exports
  • Generated TypeDoc

Process boundaries

@buzzr/mcp

Local stdio MCP server exposing 11 tools across the three core engines.

  • Server API: createBuzzrMcpServer, registerBuzzrTool, allTools, SERVER_NAME, and SERVER_VERSION.
  • Tool groups: dfsTools, oddsTools, historyTools, and buzzTools, plus each named tool definition.
  • Embedding helpers: defineTool, jsonResult, errorResult, and public tool/result types.
  • Executables: mcp and buzzr-mcp.
  • README and 11-tool catalog
  • Root exports
  • Generated TypeDoc

@buzzr/dfs-cli

Filesystem wrapper for grading one entry JSON document against a leg-keyed game-log JSON document.

Integration helpers

@buzzr/dfs-react

Framework-neutral settlement display models; no React runtime dependency.

  • Runtime: getSlipDisplayModel, getStatusTone, formatLegLabel, and formatLegLine.
  • Contracts: SlipStatusTone, LegDisplayModel, and SlipDisplayModel.
  • README
  • Root exports
  • Generated TypeDoc

@buzzr/dfs-testkit

Fixture builders and injected mock providers for engine consumers.

@buzzr/dfs-provider-espn

Adapter from a consumer-owned ESPN-shaped game-log loader to StatProvider. It performs no network request itself.

@buzzr/dfs-provider-sportradar

Adapter from consumer-owned Sportradar-shaped basketball rows to PlayerGameLogEntryShape and StatProvider. It performs no network request itself.

  • Runtime: createSportradarStatProvider and sportradarRowToGameLog.
  • Contracts: SportradarBasketballStatLine, SportradarGameLogLoaderInput, and SportradarStatProviderOptions.
  • README
  • Root exports
  • Generated TypeDoc

@buzzr/dfs-engine-test-vectors

Versioned engine regression fixtures for the matching @buzzr/dfs-engine version. They are not official operator conformance.

Machine-readable and agent references