bbdata-cli 0.1.0

package/dist/src/index.d.ts

@@ -0,0 +1,347 @@
+import { z } from 'zod';
+
+type OutputFormat = 'json' | 'table' | 'csv' | 'markdown';
+
+interface QueryOptions {
+    template: string;
+    player?: string;
+    players?: string;
+    team?: string;
+    season?: number;
+    stat?: string;
+    pitchType?: string;
+    minPa?: number;
+    minIp?: number;
+    top?: number;
+    seasons?: string;
+    format?: OutputFormat;
+    source?: string;
+    cache?: boolean;
+}
+interface QueryResult {
+    data: Record<string, unknown>[];
+    formatted: string;
+    meta: {
+        template: string;
+        source: string;
+        cached: boolean;
+        rowCount: number;
+        season: number;
+    };
+}
+/**
+ * Programmatic API — skills and agents call this directly.
+ */
+declare function query(options: QueryOptions): Promise<QueryResult>;
+
+type Audience = 'coach' | 'gm' | 'scout' | 'analyst';
+
+interface ReportOptions {
+    template: string;
+    player?: string;
+    team?: string;
+    season?: number;
+    audience?: Audience;
+    format?: 'markdown' | 'json';
+    validate?: boolean;
+}
+interface ReportResult {
+    content: string;
+    formatted: string;
+    validation?: ValidationResult;
+    meta: {
+        template: string;
+        player: string;
+        audience: Audience;
+        season: number;
+        dataSources: string[];
+    };
+}
+interface ValidationResult {
+    passed: boolean;
+    issues: {
+        severity: 'error' | 'warning';
+        message: string;
+    }[];
+}
+/**
+ * Programmatic API — skills and agents call this directly.
+ */
+declare function report(options: ReportOptions): Promise<ReportResult>;
+
+declare const ConfigSchema: z.ZodObject<{
+    defaultTeam: z.ZodOptional<z.ZodString>;
+    defaultFormat: z.ZodDefault<z.ZodEnum<["json", "table", "csv", "markdown"]>>;
+    defaultAudience: z.ZodDefault<z.ZodEnum<["coach", "gm", "scout", "analyst"]>>;
+    cache: z.ZodDefault<z.ZodObject<{
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        maxAgeDays: z.ZodDefault<z.ZodNumber>;
+        directory: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        enabled: boolean;
+        maxAgeDays: number;
+        directory: string;
+    }, {
+        enabled?: boolean | undefined;
+        maxAgeDays?: number | undefined;
+        directory?: string | undefined;
+    }>>;
+    templates: z.ZodDefault<z.ZodObject<{
+        directory: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        directory: string;
+    }, {
+        directory?: string | undefined;
+    }>>;
+    sources: z.ZodDefault<z.ZodObject<{
+        savant: z.ZodDefault<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            enabled: boolean;
+        }, {
+            enabled?: boolean | undefined;
+        }>>;
+        fangraphs: z.ZodDefault<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            enabled: boolean;
+        }, {
+            enabled?: boolean | undefined;
+        }>>;
+        mlbStatsApi: z.ZodDefault<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            enabled: boolean;
+        }, {
+            enabled?: boolean | undefined;
+        }>>;
+        baseballReference: z.ZodDefault<z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            enabled: boolean;
+        }, {
+            enabled?: boolean | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        savant: {
+            enabled: boolean;
+        };
+        fangraphs: {
+            enabled: boolean;
+        };
+        mlbStatsApi: {
+            enabled: boolean;
+        };
+        baseballReference: {
+            enabled: boolean;
+        };
+    }, {
+        savant?: {
+            enabled?: boolean | undefined;
+        } | undefined;
+        fangraphs?: {
+            enabled?: boolean | undefined;
+        } | undefined;
+        mlbStatsApi?: {
+            enabled?: boolean | undefined;
+        } | undefined;
+        baseballReference?: {
+            enabled?: boolean | undefined;
+        } | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    defaultFormat: "json" | "table" | "csv" | "markdown";
+    defaultAudience: "coach" | "gm" | "scout" | "analyst";
+    cache: {
+        enabled: boolean;
+        maxAgeDays: number;
+        directory: string;
+    };
+    templates: {
+        directory: string;
+    };
+    sources: {
+        savant: {
+            enabled: boolean;
+        };
+        fangraphs: {
+            enabled: boolean;
+        };
+        mlbStatsApi: {
+            enabled: boolean;
+        };
+        baseballReference: {
+            enabled: boolean;
+        };
+    };
+    defaultTeam?: string | undefined;
+}, {
+    defaultTeam?: string | undefined;
+    defaultFormat?: "json" | "table" | "csv" | "markdown" | undefined;
+    defaultAudience?: "coach" | "gm" | "scout" | "analyst" | undefined;
+    cache?: {
+        enabled?: boolean | undefined;
+        maxAgeDays?: number | undefined;
+        directory?: string | undefined;
+    } | undefined;
+    templates?: {
+        directory?: string | undefined;
+    } | undefined;
+    sources?: {
+        savant?: {
+            enabled?: boolean | undefined;
+        } | undefined;
+        fangraphs?: {
+            enabled?: boolean | undefined;
+        } | undefined;
+        mlbStatsApi?: {
+            enabled?: boolean | undefined;
+        } | undefined;
+        baseballReference?: {
+            enabled?: boolean | undefined;
+        } | undefined;
+    } | undefined;
+}>;
+type BbdataConfig = z.infer<typeof ConfigSchema>;
+
+declare function getConfig(): BbdataConfig;
+declare function setConfig(updates: Partial<BbdataConfig>): BbdataConfig;
+
+type DataSource = 'savant' | 'fangraphs' | 'mlb-stats-api' | 'baseball-reference';
+declare const PitchDataSchema: z.ZodObject<{
+    pitcher_id: z.ZodString;
+    pitcher_name: z.ZodString;
+    batter_id: z.ZodString;
+    batter_name: z.ZodString;
+    game_date: z.ZodString;
+    pitch_type: z.ZodString;
+    release_speed: z.ZodNumber;
+    release_spin_rate: z.ZodNumber;
+    pfx_x: z.ZodNumber;
+    pfx_z: z.ZodNumber;
+    plate_x: z.ZodNumber;
+    plate_z: z.ZodNumber;
+    launch_speed: z.ZodNullable<z.ZodNumber>;
+    launch_angle: z.ZodNullable<z.ZodNumber>;
+    description: z.ZodString;
+    events: z.ZodNullable<z.ZodString>;
+    bb_type: z.ZodNullable<z.ZodString>;
+    stand: z.ZodEnum<["L", "R"]>;
+    p_throws: z.ZodEnum<["L", "R"]>;
+    estimated_ba: z.ZodNullable<z.ZodNumber>;
+    estimated_woba: z.ZodNullable<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    pitcher_id: string;
+    pitcher_name: string;
+    batter_id: string;
+    batter_name: string;
+    game_date: string;
+    pitch_type: string;
+    release_speed: number;
+    release_spin_rate: number;
+    pfx_x: number;
+    pfx_z: number;
+    plate_x: number;
+    plate_z: number;
+    launch_speed: number | null;
+    launch_angle: number | null;
+    description: string;
+    events: string | null;
+    bb_type: string | null;
+    stand: "L" | "R";
+    p_throws: "L" | "R";
+    estimated_ba: number | null;
+    estimated_woba: number | null;
+}, {
+    pitcher_id: string;
+    pitcher_name: string;
+    batter_id: string;
+    batter_name: string;
+    game_date: string;
+    pitch_type: string;
+    release_speed: number;
+    release_spin_rate: number;
+    pfx_x: number;
+    pfx_z: number;
+    plate_x: number;
+    plate_z: number;
+    launch_speed: number | null;
+    launch_angle: number | null;
+    description: string;
+    events: string | null;
+    bb_type: string | null;
+    stand: "L" | "R";
+    p_throws: "L" | "R";
+    estimated_ba: number | null;
+    estimated_woba: number | null;
+}>;
+type PitchData = z.infer<typeof PitchDataSchema>;
+declare const PlayerStatsSchema: z.ZodObject<{
+    player_id: z.ZodString;
+    player_name: z.ZodString;
+    team: z.ZodString;
+    season: z.ZodNumber;
+    stat_type: z.ZodEnum<["batting", "pitching", "fielding"]>;
+    stats: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodNull]>>;
+}, "strip", z.ZodTypeAny, {
+    player_id: string;
+    player_name: string;
+    team: string;
+    season: number;
+    stat_type: "batting" | "pitching" | "fielding";
+    stats: Record<string, string | number | null>;
+}, {
+    player_id: string;
+    player_name: string;
+    team: string;
+    season: number;
+    stat_type: "batting" | "pitching" | "fielding";
+    stats: Record<string, string | number | null>;
+}>;
+type PlayerStats = z.infer<typeof PlayerStatsSchema>;
+interface PlayerId {
+    mlbam_id: string;
+    fangraphs_id?: string;
+    bbref_id?: string;
+    name: string;
+    team?: string;
+    position?: string;
+}
+interface AdapterQuery {
+    player_name?: string;
+    player_id?: string;
+    team?: string;
+    season: number;
+    start_date?: string;
+    end_date?: string;
+    stat_type: 'batting' | 'pitching' | 'fielding';
+    pitch_type?: string[];
+    min_pa?: number;
+    min_ip?: number;
+    metrics?: string[];
+}
+interface AdapterResult<T = PitchData[] | PlayerStats[]> {
+    data: T;
+    source: DataSource;
+    cached: boolean;
+    fetchedAt: string;
+    meta: {
+        rowCount: number;
+        season: number;
+        query: AdapterQuery;
+    };
+}
+interface DataAdapter {
+    readonly source: DataSource;
+    readonly description: string;
+    /** Can this adapter service this query type? */
+    supports(query: AdapterQuery): boolean;
+    /** Fetch data, checking cache first */
+    fetch(query: AdapterQuery, options?: {
+        bypassCache?: boolean;
+    }): Promise<AdapterResult>;
+    /** Resolve a player name to this source's ID */
+    resolvePlayer(name: string): Promise<PlayerId | null>;
+}
+
+export { type AdapterQuery, type BbdataConfig, type DataAdapter, type OutputFormat, type PitchData, type PlayerStats, type QueryOptions, type QueryResult, type ReportOptions, type ReportResult, getConfig, query, report, setConfig };