tbarequest 0.0.1

package/dist/types/endpoints/teams.js

@@ -0,0 +1,139 @@
+import { z } from "zod";
+import { Award, Media, Team, Team_Robot, Team_Simple } from "../schemas/teams.js";
+import { Event, Event_Simple, Team_Event_Status } from "../schemas/events.js";
+import { District_List } from "../schemas/districts.js";
+import { Match, Match_Simple } from "../schemas/matches.js";
+export const teamEndpoints = {
+    "/teams/{page_num}": {
+        schema: z.array(Team),
+        arguments: z.tuple([z.number()]),
+    },
+    "/teams/{page_num}/simple": {
+        schema: z.array(Team_Simple),
+        arguments: z.tuple([z.number()]),
+    },
+    "/teams/{page_num}/keys": {
+        schema: z.array(z.string()),
+        arguments: z.tuple([z.number()]),
+    },
+    "/teams/{year}/{page_num}": {
+        schema: z.array(Team),
+        arguments: z.tuple([z.number(), z.number()]),
+    },
+    "/teams/{year}/{page_num}/simple": {
+        schema: z.array(Team_Simple),
+        arguments: z.tuple([z.number(), z.number()]),
+    },
+    "/teams/{year}/{page_num}/keys": {
+        schema: z.array(z.string()),
+        arguments: z.tuple([z.number(), z.number()]),
+    },
+    "/team/{team_key}": {
+        schema: Team,
+        arguments: z.tuple([z.string()]),
+    },
+    "/team/{team_key}/simple": {
+        schema: Team_Simple,
+        arguments: z.tuple([z.string()]),
+    },
+    "/team/{team_key}/history": {
+        schema: z.object({ events: z.array(Event), awards: z.array(Award) }),
+        arguments: z.tuple([z.string()]),
+    },
+    "/team/{team_key}/years_participated": {
+        schema: z.array(z.number()),
+        arguments: z.tuple([z.string()]),
+    },
+    "/team/{team_key}/districts": {
+        schema: z.array(District_List),
+        arguments: z.tuple([z.string()]),
+    },
+    "/team/{team_key}/robots": {
+        schema: z.array(Team_Robot),
+        arguments: z.tuple([z.string()]),
+    },
+    "/team/{team_key}/events": {
+        schema: z.array(Event),
+        arguments: z.tuple([z.string()]),
+    },
+    "/team/{team_key}/events/simple": {
+        schema: z.array(Event_Simple),
+        arguments: z.tuple([z.string()]),
+    },
+    "/team/{team_key}/events/keys": {
+        schema: z.array(z.string()),
+        arguments: z.tuple([z.string()]),
+    },
+    "/team/{team_key}/events/{year}": {
+        schema: z.array(Event),
+        arguments: z.tuple([z.string(), z.int()]),
+    },
+    "/team/{team_key}/events/{year}/simple": {
+        schema: z.array(Event_Simple),
+        arguments: z.tuple([z.string(), z.int()]),
+    },
+    "/team/{team_key}/events/{year}/keys": {
+        schema: z.array(z.string()),
+        arguments: z.tuple([z.string(), z.int()]),
+    },
+    "/team/{team_key}/events/{year}/statuses": {
+        schema: z.record(z.string(), Team_Event_Status.nullable()),
+        arguments: z.tuple([z.string(), z.int()]),
+    },
+    "/team/{team_key}/event/{event_key}/matches": {
+        schema: z.array(Match),
+        arguments: z.tuple([z.string(), z.string()]),
+    },
+    "/team/{team_key}/event/{event_key}/matches/simple": {
+        schema: z.array(Match_Simple),
+        arguments: z.tuple([z.string(), z.string()]),
+    },
+    "/team/{team_key}/event/{event_key}/matches/keys": {
+        schema: z.array(z.string()),
+        arguments: z.tuple([z.string(), z.string()]),
+    },
+    "/team/{team_key}/event/{event_key}/awards": {
+        schema: z.array(Award),
+        arguments: z.tuple([z.string(), z.string()]),
+    },
+    "/team/{team_key}/event/{event_key}/status": {
+        schema: Team_Event_Status.nullable(),
+        arguments: z.tuple([z.string(), z.string()]),
+    },
+    "/team/{team_key}/awards": {
+        schema: z.array(Award),
+        arguments: z.tuple([z.string()]),
+    },
+    "/team/{team_key}/awards/{year}": {
+        schema: z.array(Award),
+        arguments: z.tuple([z.string(), z.number()]),
+    },
+    "/team/{team_key}/matches/{year}": {
+        schema: z.array(Match),
+        arguments: z.tuple([z.string(), z.number()]),
+    },
+    "/team/{team_key}/matches/{year}/simple": {
+        schema: z.array(Match_Simple),
+        arguments: z.tuple([z.string(), z.number()]),
+    },
+    "/team/{team_key}/matches/{year}/keys": {
+        schema: z.array(z.string()),
+        arguments: z.tuple([z.string(), z.number()]),
+    },
+    "/team/{team_key}/media/{year}": {
+        schema: z.array(Media),
+        arguments: z.tuple([z.string(), z.number()]),
+    },
+    "/team/{team_key}/media/tag/{media_tag}": {
+        schema: z.array(Media),
+        arguments: z.tuple([z.string(), z.string()]),
+    },
+    "/team/{team_key}/media/tag/{media_tag}/{year}": {
+        schema: z.array(Media),
+        arguments: z.tuple([z.string(), z.string(), z.int()]),
+    },
+    "/team/{team_key}/social_media": {
+        schema: z.array(Media),
+        arguments: z.tuple([z.string()]),
+    },
+};

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+import { z } from "zod";
+export type Endpoints = {
+    [key: string]: {
+        schema: z.Schema;
+        arguments: z.Schema | null;
+    };
+};

package/dist/types/index.js

@@ -0,0 +1 @@
+export {};

package/dist/types/schemas/districts.d.ts

@@ -0,0 +1,26 @@
+import { z } from "zod";
+export declare const District_List: z.ZodObject<{
+    abbreviation: z.ZodString;
+    display_name: z.ZodString;
+    key: z.ZodString;
+    year: z.ZodInt;
+}, {}>;
+export declare const District_Ranking: z.ZodObject<{
+    team_key: z.ZodString;
+    rank: z.ZodInt;
+    rookie_bonus: z.ZodOptional<z.ZodInt>;
+    point_total: z.ZodNumber;
+    event_points: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        district_cmp: z.ZodBoolean;
+        total: z.ZodNumber;
+        alliance_points: z.ZodNumber;
+        elim_points: z.ZodNumber;
+        award_points: z.ZodNumber;
+        event_key: z.ZodString;
+        qual_points: z.ZodNumber;
+    }, {}>>>;
+}, {}>;
+export declare const District_Advancement: z.ZodObject<{
+    dcmp: z.ZodBoolean;
+    cmp: z.ZodBoolean;
+}, {}>;

package/dist/types/schemas/districts.js

@@ -0,0 +1,26 @@
+import { z } from "zod";
+export const District_List = z.object({
+    abbreviation: z.string(),
+    display_name: z.string(),
+    key: z.string(),
+    year: z.int(),
+});
+export const District_Ranking = z.object({
+    team_key: z.string(),
+    rank: z.int(),
+    rookie_bonus: z.int().optional(),
+    point_total: z.number(),
+    event_points: z.array(z.object({
+        district_cmp: z.boolean(),
+        total: z.number(),
+        alliance_points: z.number(),
+        elim_points: z.number(),
+        award_points: z.number(),
+        event_key: z.string(),
+        qual_points: z.number(),
+    })).optional(),
+});
+export const District_Advancement = z.object({
+    dcmp: z.boolean(),
+    cmp: z.boolean(),
+});

package/dist/types/schemas/events.d.ts

@@ -0,0 +1,233 @@
+import { z } from "zod";
+export declare const Webcast: z.ZodObject<{
+    type: z.ZodEnum<{
+        youtube: "youtube";
+        twitch: "twitch";
+        ustream: "ustream";
+        iframe: "iframe";
+        html5: "html5";
+        rtmp: "rtmp";
+        livestream: "livestream";
+        direct_link: "direct_link";
+        mms: "mms";
+        justin: "justin";
+        stemtv: "stemtv";
+        dacast: "dacast";
+    }>;
+    channel: z.ZodString;
+    date: z.ZodOptional<z.ZodNullable<z.coerce.ZodCoercedDate>>;
+    file: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, {}>;
+export declare const Event_Simple: z.ZodObject<{
+    key: z.ZodString;
+    name: z.ZodString;
+    event_code: z.ZodString;
+    event_type: z.ZodInt;
+    district: z.ZodNullable<z.ZodObject<{
+        abbreviation: z.ZodString;
+        display_name: z.ZodString;
+        key: z.ZodString;
+        year: z.ZodInt;
+    }, {}>>;
+    city: z.ZodNullable<z.ZodString>;
+    state_prov: z.ZodNullable<z.ZodString>;
+    country: z.ZodNullable<z.ZodString>;
+    start_date: z.coerce.ZodCoercedDate;
+    end_date: z.coerce.ZodCoercedDate;
+    year: z.ZodInt;
+}, {}>;
+export declare const Event: z.ZodObject<{
+    key: z.ZodString;
+    name: z.ZodString;
+    city: z.ZodNullable<z.ZodString>;
+    state_prov: z.ZodNullable<z.ZodString>;
+    country: z.ZodNullable<z.ZodString>;
+    postal_code: z.ZodNullable<z.ZodString>;
+    website: z.ZodNullable<z.ZodString>;
+    year: z.ZodInt;
+    event_code: z.ZodString;
+    event_type: z.ZodInt;
+    district: z.ZodNullable<z.ZodObject<{
+        abbreviation: z.ZodString;
+        display_name: z.ZodString;
+        key: z.ZodString;
+        year: z.ZodInt;
+    }, {}>>;
+    start_date: z.coerce.ZodCoercedDate;
+    end_date: z.coerce.ZodCoercedDate;
+    webcasts: z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<{
+            youtube: "youtube";
+            twitch: "twitch";
+            ustream: "ustream";
+            iframe: "iframe";
+            html5: "html5";
+            rtmp: "rtmp";
+            livestream: "livestream";
+            direct_link: "direct_link";
+            mms: "mms";
+            justin: "justin";
+            stemtv: "stemtv";
+            dacast: "dacast";
+        }>;
+        channel: z.ZodString;
+        date: z.ZodOptional<z.ZodNullable<z.coerce.ZodCoercedDate>>;
+        file: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, {}>>;
+    division_keys: z.ZodArray<z.ZodString>;
+    short_name: z.ZodNullable<z.ZodString>;
+    event_type_string: z.ZodString;
+    week: z.ZodNullable<z.ZodNumber>;
+    address: z.ZodNullable<z.ZodString>;
+    gmaps_place_id: z.ZodNullable<z.ZodString>;
+    gmaps_url: z.ZodNullable<z.ZodString>;
+    lat: z.ZodNullable<z.ZodNumber>;
+    lng: z.ZodNullable<z.ZodNumber>;
+    location_name: z.ZodNullable<z.ZodString>;
+    timezone: z.ZodNullable<z.ZodString>;
+    first_event_id: z.ZodNullable<z.ZodString>;
+    first_event_code: z.ZodNullable<z.ZodString>;
+    parent_event_key: z.ZodNullable<z.ZodString>;
+    playoff_type: z.ZodNullable<z.ZodInt>;
+    playoff_type_string: z.ZodNullable<z.ZodString>;
+}, {}>;
+export declare const WLT_Record: z.ZodObject<{
+    wins: z.ZodInt;
+    losses: z.ZodInt;
+    ties: z.ZodInt;
+}, {}>;
+export declare const Team_Event_Status_rank: z.ZodObject<{
+    num_teams: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    ranking: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+        matches_played: z.ZodNullable<z.ZodInt>;
+        qual_average: z.ZodNullable<z.ZodNullable<z.ZodNumber>>;
+        sort_orders: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+        rank: z.ZodNullable<z.ZodInt>;
+        dq: z.ZodNullable<z.ZodInt>;
+        team_key: z.ZodNullable<z.ZodString>;
+    }, {}>>>;
+    sort_order_info: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+        precision: z.ZodNullable<z.ZodInt>;
+        name: z.ZodNullable<z.ZodString>;
+    }, {}>>>>;
+    status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, {}>;
+export declare const Team_Event_Status_alliance_backup: z.ZodObject<{
+    in: z.ZodOptional<z.ZodString>;
+    out: z.ZodOptional<z.ZodString>;
+}, {}>;
+export declare const Team_Event_Status_alliance: z.ZodObject<{
+    name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    number: z.ZodInt;
+    backup: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        in: z.ZodOptional<z.ZodString>;
+        out: z.ZodOptional<z.ZodString>;
+    }, {}>>>;
+    pick: z.ZodInt;
+}, {}>;
+export declare const Team_Event_Status_playoff: z.ZodObject<{
+    level: z.ZodOptional<z.ZodEnum<{
+        qm: "qm";
+        ef: "ef";
+        qf: "qf";
+        sf: "sf";
+        f: "f";
+    }>>;
+    current_level_record: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        wins: z.ZodInt;
+        losses: z.ZodInt;
+        ties: z.ZodInt;
+    }, {}>>>;
+    record: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        wins: z.ZodInt;
+        losses: z.ZodInt;
+        ties: z.ZodInt;
+    }, {}>>>;
+    status: z.ZodOptional<z.ZodEnum<{
+        won: "won";
+        eliminated: "eliminated";
+        playing: "playing";
+    }>>;
+    playoff_average: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, {}>;
+export declare const Team_Event_Status: z.ZodObject<{
+    alliance_status_str: z.ZodOptional<z.ZodString>;
+    playoff_status_str: z.ZodOptional<z.ZodString>;
+    overall_status_str: z.ZodOptional<z.ZodString>;
+    next_match_key: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    last_match_key: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    qual: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        num_teams: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+        ranking: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+            matches_played: z.ZodNullable<z.ZodInt>;
+            qual_average: z.ZodNullable<z.ZodNullable<z.ZodNumber>>;
+            sort_orders: z.ZodNullable<z.ZodArray<z.ZodNumber>>;
+            rank: z.ZodNullable<z.ZodInt>;
+            dq: z.ZodNullable<z.ZodInt>;
+            team_key: z.ZodNullable<z.ZodString>;
+        }, {}>>>;
+        sort_order_info: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+            precision: z.ZodNullable<z.ZodInt>;
+            name: z.ZodNullable<z.ZodString>;
+        }, {}>>>>;
+        status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, {}>>>;
+    alliance: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        number: z.ZodInt;
+        backup: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            in: z.ZodOptional<z.ZodString>;
+            out: z.ZodOptional<z.ZodString>;
+        }, {}>>>;
+        pick: z.ZodInt;
+    }, {}>>>;
+    playoff: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        level: z.ZodOptional<z.ZodEnum<{
+            qm: "qm";
+            ef: "ef";
+            qf: "qf";
+            sf: "sf";
+            f: "f";
+        }>>;
+        current_level_record: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            wins: z.ZodInt;
+            losses: z.ZodInt;
+            ties: z.ZodInt;
+        }, {}>>>;
+        record: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            wins: z.ZodInt;
+            losses: z.ZodInt;
+            ties: z.ZodInt;
+        }, {}>>>;
+        status: z.ZodOptional<z.ZodEnum<{
+            won: "won";
+            eliminated: "eliminated";
+            playing: "playing";
+        }>>;
+        playoff_average: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, {}>>>;
+}, {}>;
+export declare const Elimination_Alliance: z.ZodObject<{
+    name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    backup: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        in: z.ZodString;
+        out: z.ZodString;
+    }, {}>>>;
+    declines: z.ZodArray<z.ZodString>;
+    picks: z.ZodArray<z.ZodString>;
+    status: z.ZodOptional<z.ZodObject<{
+        playoff_average: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        level: z.ZodOptional<z.ZodString>;
+        record: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            wins: z.ZodInt;
+            losses: z.ZodInt;
+            ties: z.ZodInt;
+        }, {}>>>;
+        current_level_record: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            wins: z.ZodInt;
+            losses: z.ZodInt;
+            ties: z.ZodInt;
+        }, {}>>>;
+        status: z.ZodOptional<z.ZodString>;
+    }, {}>>;
+}, {}>;

package/dist/types/schemas/events.js

@@ -0,0 +1,107 @@
+import { z } from "zod";
+import { District_List } from "./districts.js";
+export const Webcast = z.object({
+    type: z.enum(["youtube", "twitch", "ustream", "iframe", "html5", "rtmp", "livestream", "direct_link", "mms", "justin", "stemtv", "dacast"]),
+    channel: z.string(),
+    date: z.coerce.date().nullable().optional(),
+    file: z.string().nullable().optional(),
+});
+export const Event_Simple = z.object({
+    key: z.string(),
+    name: z.string(),
+    event_code: z.string(),
+    event_type: z.int(),
+    district: District_List.nullable(),
+    city: z.string().nullable(),
+    state_prov: z.string().nullable(),
+    country: z.string().nullable(),
+    start_date: z.coerce.date(),
+    end_date: z.coerce.date(),
+    year: z.int(),
+});
+export const Event = Event_Simple.extend({
+    short_name: z.string().nullable(),
+    event_type_string: z.string(),
+    week: z.number().nullable(),
+    address: z.string().nullable(),
+    postal_code: z.string().nullable(),
+    gmaps_place_id: z.string().nullable(),
+    gmaps_url: z.string().nullable(),
+    lat: z.number().nullable(),
+    lng: z.number().nullable(),
+    location_name: z.string().nullable(),
+    timezone: z.string().nullable(),
+    website: z.string().nullable(),
+    first_event_id: z.string().nullable(),
+    first_event_code: z.string().nullable(),
+    webcasts: z.array(Webcast),
+    division_keys: z.array(z.string()),
+    parent_event_key: z.string().nullable(),
+    playoff_type: z.int().nullable(),
+    playoff_type_string: z.string().nullable(),
+});
+export const WLT_Record = z.object({
+    wins: z.int(),
+    losses: z.int(),
+    ties: z.int(),
+});
+// Docs don't say it is nullable, but it has been null during testing
+export const Team_Event_Status_rank = z.object({
+    num_teams: z.int().nullable(),
+    ranking: z.object({
+        matches_played: z.int().nullable(),
+        qual_average: z.number().nullable().nullable(),
+        sort_orders: z.array(z.number()).nullable(),
+        rank: z.int().nullable(),
+        dq: z.int().nullable(),
+        team_key: z.string().nullable(),
+    }).optional(),
+    sort_order_info: z.array(z.object({
+        precision: z.int().nullable(),
+        name: z.string().nullable(),
+    })).nullable(),
+    status: z.string().nullable(),
+}).partial();
+export const Team_Event_Status_alliance_backup = z.object({
+    in: z.string().optional(),
+    out: z.string().optional(),
+});
+export const Team_Event_Status_alliance = z.object({
+    name: z.string().nullable().optional(),
+    number: z.int(),
+    backup: Team_Event_Status_alliance_backup.nullable().optional(),
+    pick: z.int().min(-1).max(3),
+});
+export const Team_Event_Status_playoff = z.object({
+    level: z.enum(["qm", "ef", "qf", "sf", "f"]).optional(),
+    current_level_record: WLT_Record.nullable().optional(),
+    record: WLT_Record.nullable().optional(),
+    status: z.enum(["won", "eliminated", "playing"]).optional(),
+    playoff_average: z.number().nullable().optional(),
+});
+export const Team_Event_Status = z.object({
+    alliance_status_str: z.string().optional(),
+    playoff_status_str: z.string().optional(),
+    overall_status_str: z.string().optional(),
+    next_match_key: z.string().nullable().optional(),
+    last_match_key: z.string().nullable().optional(),
+    qual: Team_Event_Status_rank.nullable().optional(),
+    alliance: Team_Event_Status_alliance.nullable().optional(),
+    playoff: Team_Event_Status_playoff.nullable().optional(),
+});
+export const Elimination_Alliance = z.object({
+    name: z.string().nullable().optional(),
+    backup: z.object({
+        in: z.string(),
+        out: z.string(),
+    }).nullable().optional(),
+    declines: z.array(z.string()),
+    picks: z.array(z.string()),
+    status: z.object({
+        playoff_average: z.number().nullable(),
+        level: z.string(),
+        record: WLT_Record.nullable(),
+        current_level_record: WLT_Record.nullable(),
+        status: z.string(),
+    }).partial().optional(),
+});

package/dist/types/schemas/insights.d.ts

@@ -0,0 +1,26 @@
+import { z } from "zod";
+export declare const LeaderboardInsights: z.ZodObject<{
+    data: z.ZodObject<{
+        rankings: z.ZodArray<z.ZodObject<{
+            value: z.ZodNumber;
+            keys: z.ZodArray<z.ZodString>;
+        }, {}>>;
+        key_type: z.ZodEnum<{
+            match: "match";
+            team: "team";
+            event: "event";
+        }>;
+    }, {}>;
+    name: z.ZodString;
+    year: z.ZodInt;
+}, {}>;
+export declare const NotablesInsight: z.ZodObject<{
+    data: z.ZodObject<{
+        entries: z.ZodArray<z.ZodObject<{
+            context: z.ZodArray<z.ZodString>;
+            team_key: z.ZodString;
+        }, {}>>;
+    }, {}>;
+    name: z.ZodString;
+    year: z.ZodInt;
+}, {}>;

package/dist/types/schemas/insights.js

@@ -0,0 +1,22 @@
+import { z } from "zod";
+export const LeaderboardInsights = z.object({
+    data: z.object({
+        rankings: z.array(z.object({
+            value: z.number(),
+            keys: z.array(z.string()),
+        })),
+        key_type: z.enum(["team", "event", "match"]),
+    }),
+    name: z.string(),
+    year: z.int(),
+});
+export const NotablesInsight = z.object({
+    data: z.object({
+        entries: z.array(z.object({
+            context: z.array(z.string()),
+            team_key: z.string(),
+        })),
+    }),
+    name: z.string(),
+    year: z.int(),
+});