tbarequest 1.0.0 → 1.0.1

package/dist/types/endpoints/teams.js

@@ -0,0 +1,162 @@
+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";
+import { type } from "arktype";
+export const teamEndpoints = {
+    "/teams/{page_num}": {
+        schema: Team.array(),
+        arguments: type(["number"]),
+    },
+    "/teams/{page_num}/simple": {
+        schema: Team_Simple.array(),
+        arguments: type(["number"]),
+    },
+    "/teams/{page_num}/keys": {
+        schema: type("string[]"),
+        arguments: type(["number"]),
+    },
+    "/teams/{year}/{page_num}": {
+        schema: Team.array(),
+        arguments: type(["number", "number"]),
+    },
+    "/teams/{year}/{page_num}/simple": {
+        schema: Team_Simple.array(),
+        arguments: type(["number", "number"]),
+    },
+    "/teams/{year}/{page_num}/keys": {
+        schema: type("string[]"),
+        arguments: type(["number", "number"]),
+    },
+    "/team/{team_key}": {
+        schema: Team,
+        arguments: type(["string"]),
+    },
+    "/team/{team_key}/simple": {
+        schema: Team_Simple,
+        arguments: type(["string"]),
+    },
+    "/team/{team_key}/history": {
+        schema: type({ events: Event.array(), awards: Award.array() }),
+        arguments: type(["string"]),
+    },
+    "/team/{team_key}/years_participated": {
+        schema: type("number[]"),
+        arguments: type(["string"]),
+    },
+    "/team/{team_key}/districts": {
+        schema: District_List.array(),
+        arguments: type(["string"]),
+    },
+    "/team/{team_key}/robots": {
+        schema: Team_Robot.array(),
+        arguments: type(["string"]),
+    },
+    "/team/{team_key}/events": {
+        schema: Event.array(),
+        arguments: type(["string"]),
+    },
+    "/team/{team_key}/events/simple": {
+        schema: Event_Simple.array(),
+        arguments: type(["string"]),
+    },
+    "/team/{team_key}/events/keys": {
+        schema: type("string[]"),
+        arguments: type(["string"]),
+    },
+    "/team/{team_key}/events/{year}": {
+        schema: Event.array(),
+        arguments: type(["string", "number"]),
+    },
+    "/team/{team_key}/events/{year}/simple": {
+        schema: Event_Simple.array(),
+        arguments: type(["string", "number"]),
+    },
+    "/team/{team_key}/events/{year}/keys": {
+        schema: type("string[]"),
+        arguments: type(["string", "number"]),
+    },
+    "/team/{team_key}/events/{year}/statuses": {
+        schema: type({
+            "[string]": Team_Event_Status,
+        }),
+        arguments: type(["string", "number"]),
+    },
+    "/team/{team_key}/event/{event_key}/matches": {
+        schema: Match.array(),
+        arguments: type(["string", "string"]),
+        transformMatch: ({ key: eventKey }, schema) => {
+            if (eventKey &&
+                parseInt(eventKey.slice(0, 4)) &&
+                Array.isArray(schema) &&
+                schema.every((v) => v && typeof v === "object")) {
+                for (const member of schema) {
+                    member["score_breakdown"]["yearOfCompetition"] = parseInt(eventKey.slice(0, 4));
+                }
+            }
+            return schema;
+        },
+    },
+    "/team/{team_key}/event/{event_key}/matches/simple": {
+        schema: Match_Simple.array(),
+        arguments: type(["string", "string"]),
+    },
+    "/team/{team_key}/event/{event_key}/matches/keys": {
+        schema: type("string[]"),
+        arguments: type(["string", "string"]),
+    },
+    "/team/{team_key}/event/{event_key}/awards": {
+        schema: Award.array(),
+        arguments: type(["string", "string"]),
+    },
+    "/team/{team_key}/event/{event_key}/status": {
+        schema: type(Team_Event_Status, "|", "null"),
+        arguments: type(["string", "string"]),
+    },
+    "/team/{team_key}/awards": {
+        schema: Award.array(),
+        arguments: type(["string"]),
+    },
+    "/team/{team_key}/awards/{year}": {
+        schema: Award.array(),
+        arguments: type(["string", "number"]),
+    },
+    "/team/{team_key}/matches/{year}": {
+        schema: Match.array(),
+        arguments: type(["string", "number"]),
+        transformMatch: ({ year }, schema) => {
+            if (year &&
+                Array.isArray(schema) &&
+                schema.every((v) => v && typeof v === "object")) {
+                for (const member of schema) {
+                    member["score_breakdown"]["yearOfCompetition"] = year;
+                }
+            }
+            return schema;
+        },
+    },
+    "/team/{team_key}/matches/{year}/simple": {
+        schema: Match_Simple.array(),
+        arguments: type(["string", "number"]),
+    },
+    "/team/{team_key}/matches/{year}/keys": {
+        schema: type("string[]"),
+        arguments: type(["string", "number"]),
+    },
+    "/team/{team_key}/media/{year}": {
+        schema: Media.array(),
+        arguments: type(["string", "number"]),
+    },
+    "/team/{team_key}/media/tag/{media_tag}": {
+        schema: Media.array(),
+        arguments: type(["string", "string"]),
+    },
+    "/team/{team_key}/media/tag/{media_tag}/{year}": {
+        schema: Media.array(),
+        arguments: type(["string", "string", "number"]),
+    },
+    "/team/{team_key}/social_media": {
+        schema: Media.array(),
+        arguments: type(["string"]),
+    },
+};

package/dist/types/index.d.ts

@@ -0,0 +1,11 @@
+import { Type } from "arktype";
+export type Endpoints = {
+    [key: string]: {
+        schema: Type;
+        arguments: Type<[...unknown[]]>;
+        transformMatch?: (data: {
+            year?: number;
+            key?: string;
+        }, schema: unknown) => unknown;
+    };
+};

package/dist/types/index.js

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

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

@@ -0,0 +1,25 @@
+export declare const District_List: import("arktype/internal/methods/object.ts").ObjectType<{
+    abbreviation: string;
+    display_name: string;
+    key: string;
+    year: number;
+}, {}>;
+export declare const District_Ranking: import("arktype/internal/methods/object.ts").ObjectType<{
+    team_key: string;
+    rank: number;
+    point_total: number;
+    rookie_bonus?: number | undefined;
+    event_point?: {
+        district_cmp: boolean;
+        total: number;
+        alliance_points: number;
+        elim_points: number;
+        award_points: number;
+        event_key: string;
+        qual_points: number;
+    }[] | undefined;
+}, {}>;
+export declare const District_Advancement: import("arktype/internal/methods/object.ts").ObjectType<{
+    dcmp: boolean;
+    cmp: boolean;
+}, {}>;

package/dist/types/schemas/districts.js

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

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

@@ -0,0 +1,186 @@
+export declare const Webcast: import("arktype/internal/methods/object.ts").ObjectType<{
+    type: "youtube" | "twitch" | "ustream" | "iframe" | "html5" | "rtmp" | "livestream" | "direct_link" | "mms" | "justin" | "stemtv" | "dacast";
+    channel: string;
+    date?: string | null | undefined;
+    file?: string | null | undefined;
+}, {}>;
+export declare const Event_Simple: import("arktype/internal/methods/object.ts").ObjectType<{
+    key: string;
+    name: string;
+    event_code: string;
+    event_type: number;
+    district: {
+        abbreviation: string;
+        display_name: string;
+        key: string;
+        year: number;
+    } | null;
+    city: string | null;
+    state_prov: string | null;
+    country: string | null;
+    start_date: string;
+    end_date: string;
+    year: number;
+}, {}>;
+export declare const Event: import("arktype/internal/methods/object.ts").ObjectType<{
+    key: string;
+    name: string;
+    event_code: string;
+    event_type: number;
+    district: {
+        abbreviation: string;
+        display_name: string;
+        key: string;
+        year: number;
+    } | null;
+    city: string | null;
+    state_prov: string | null;
+    country: string | null;
+    start_date: string;
+    end_date: string;
+    year: number;
+    short_name: string | null;
+    event_type_string: string;
+    week: number | null;
+    address: string | null;
+    postal_code: string | null;
+    gmaps_place_id: string | null;
+    gmaps_url: string | null;
+    lat: number | null;
+    lng: number | null;
+    location_name: string | null;
+    timezone: string | null;
+    website: string | null;
+    first_event_id: string | null;
+    first_event_code: string | null;
+    webcasts: {
+        type: "youtube" | "twitch" | "ustream" | "iframe" | "html5" | "rtmp" | "livestream" | "direct_link" | "mms" | "justin" | "stemtv" | "dacast";
+        channel: string;
+        date?: string | null | undefined;
+        file?: string | null | undefined;
+    }[];
+    division_keys: string[];
+    parent_event_key: string | null;
+    playoff_type: number | null;
+    playoff_type_string: string | null;
+}, {}>;
+export declare const WLT_Record: import("arktype/internal/methods/object.ts").ObjectType<{
+    wins: number;
+    losses: number;
+    ties: number;
+}, {}>;
+export declare const Team_Event_Status_rank: import("arktype/internal/methods/object.ts").ObjectType<{
+    num_teams?: number | null | undefined;
+    sort_order_info?: ({
+        precision: number | null;
+        name: string | null;
+    } | null)[] | undefined;
+    status?: string | null | undefined;
+    ranking?: {
+        matches_played: number | null;
+        qual_average: number | null;
+        sort_orders: number[] | null;
+        rank: number | null;
+        dq: number | null;
+        team_key: string | null;
+    } | undefined;
+}, {}>;
+export declare const Team_Event_Status_alliance_backup: import("arktype/internal/methods/object.ts").ObjectType<{
+    in?: string | undefined;
+    out?: string | undefined;
+}, {}>;
+export declare const Team_Event_Status_alliance: import("arktype/internal/methods/object.ts").ObjectType<{
+    number: number;
+    pick: number;
+    name?: string | null | undefined;
+    backup?: {
+        in?: string | undefined;
+        out?: string | undefined;
+    } | null | undefined;
+}, {}>;
+export declare const Team_Event_Status_playoff: import("arktype/internal/methods/object.ts").ObjectType<{
+    level?: "f" | "qm" | "ef" | "qf" | "sf" | undefined;
+    current_level_record?: {
+        wins: number;
+        losses: number;
+        ties: number;
+    } | null | undefined;
+    record?: {
+        wins: number;
+        losses: number;
+        ties: number;
+    } | null | undefined;
+    status?: "won" | "eliminated" | "playing" | undefined;
+    playoff_average?: number | null | undefined;
+}, {}>;
+export declare const Team_Event_Status: import("arktype/internal/methods/object.ts").ObjectType<{
+    alliance_status_str?: string | undefined;
+    playoff_status_str?: string | undefined;
+    overall_status_str?: string | undefined;
+    next_match_key?: string | null | undefined;
+    last_match_key?: string | null | undefined;
+    playoff?: {
+        level?: "f" | "qm" | "ef" | "qf" | "sf" | undefined;
+        current_level_record?: {
+            wins: number;
+            losses: number;
+            ties: number;
+        } | null | undefined;
+        record?: {
+            wins: number;
+            losses: number;
+            ties: number;
+        } | null | undefined;
+        status?: "won" | "eliminated" | "playing" | undefined;
+        playoff_average?: number | null | undefined;
+    } | null | undefined;
+    qual?: {
+        num_teams?: number | null | undefined;
+        sort_order_info?: ({
+            precision: number | null;
+            name: string | null;
+        } | null)[] | undefined;
+        status?: string | null | undefined;
+        ranking?: {
+            matches_played: number | null;
+            qual_average: number | null;
+            sort_orders: number[] | null;
+            rank: number | null;
+            dq: number | null;
+            team_key: string | null;
+        } | undefined;
+    } | null | undefined;
+    alliance?: {
+        number: number;
+        pick: number;
+        name?: string | null | undefined;
+        backup?: {
+            in?: string | undefined;
+            out?: string | undefined;
+        } | null | undefined;
+    } | null | undefined;
+}, {}>;
+export declare const Elimination_Alliance: import("arktype/internal/methods/object.ts").ObjectType<{
+    declines: string[];
+    picks: string[];
+    name?: string | null | undefined;
+    backup?: {
+        in: string;
+        out: string;
+    } | null | undefined;
+    status?: {
+        playoff_average?: number | null | undefined;
+        level?: string | undefined;
+        record?: {
+            wins: number;
+            losses: number;
+            ties: number;
+        } | null | undefined;
+        current_level_record?: {
+            wins: number;
+            losses: number;
+            ties: number;
+        } | null | undefined;
+        status?: string | undefined;
+    } | undefined;
+}, {}>;

package/dist/types/schemas/events.js

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

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

@@ -0,0 +1,21 @@
+export declare const LeaderboardInsights: import("arktype/internal/methods/object.ts").ObjectType<{
+    data: {
+        rankings: {
+            value: number;
+            keys: string[];
+        }[];
+        key_type: "event" | "match" | "team";
+    };
+    name: string;
+    year: number;
+}, {}>;
+export declare const NotablesInsight: import("arktype/internal/methods/object.ts").ObjectType<{
+    data: {
+        entries: {
+            context: string[];
+            team_key: string;
+        }[];
+    };
+    name: string;
+    year: number;
+}, {}>;

package/dist/types/schemas/insights.js

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