tbarequest 1.0.0 → 1.0.1

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import { Result } from "./utils.js";
+import { TBAEndpoint, TBAEndpoints } from "./types/endpoints/index.js";
+export declare function createTBACaller(api_key: string): <T extends TBAEndpoint>(endpoint: T, ...args: TBAEndpoints[T]["arguments"]["infer"]) => Promise<Result<TBAEndpoints[T]["schema"]["infer"]>>;

package/dist/index.js

@@ -0,0 +1,69 @@
+import { tryCatch } from "./utils.js";
+import { endpoints } from "./types/endpoints/index.js";
+import { ArkErrors } from "arktype";
+/*
+ * Creates a function that can call the TBA api.
+ * @see https://www.thebluealliance.com/apidocs/v3
+ * @param api_key The api key given to you from The Blue Alliance.
+ * @returns A function that can request from any endpoint in the TBA api. Go to the TBA api docs to see more information on endpoints and arguments required.
+ */
+export function createTBACaller(api_key) {
+    return async (endpoint, ...args) => await TBA(endpoint, api_key, ...args);
+}
+async function TBA(endpoint, api_key, ...args) {
+    let numArg = -1;
+    // Fills all the arguments that are needed.
+    const filledEndpoint = endpoint.replace(/{(.+?)}/g, () => {
+        numArg++;
+        return args[numArg].toString();
+    });
+    const result = await tryCatch(fetch(`https://www.thebluealliance.com/api/v3${filledEndpoint}`, {
+        headers: {
+            "X-TBA-Auth-Key": api_key,
+        },
+    }));
+    if (result.error)
+        return {
+            data: null, error: result.error,
+        };
+    if (result.data.status !== 200)
+        return {
+            data: null,
+            error: new Error(`${result.data.status} - ${result.data.statusText}`),
+        };
+    const json = await tryCatch(result.data.json());
+    if (json.error)
+        return {
+            data: null,
+            error: new Error(`JSON didn't parse for endpoint ${endpoint}. Please contact the developers of the TBArequest package with this error: ${json.error.message}`),
+        };
+    if ("transformMatch" in endpoints[endpoint]) {
+        let data;
+        switch (endpoint) {
+            case "/event/{event_key}/matches":
+            case "/match/{match_key}": {
+                data = { key: args[0] };
+                break;
+            }
+            case "/team/{team_key}/event/{event_key}/matches": {
+                data = { key: args[1] };
+                break;
+            }
+            case "/team/{team_key}/matches/{year}": {
+                data = { year: args[1] };
+                break;
+            }
+            default: {
+                data = {};
+            }
+        }
+        json.data = endpoints[endpoint].transformMatch(data, json.data);
+    }
+    let schema = endpoints[endpoint].schema(json.data);
+    if (schema instanceof ArkErrors)
+        return {
+            data: null,
+            error: new Error(`Schema for endpoint ${endpoint} didn't work. Please contact the developers of the TBArequest package with this error: ${schema}`),
+        };
+    return { data: schema, error: null };
+}

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

@@ -0,0 +1,161 @@
+export declare const districtEndpoints: {
+    "/districts/{year}": {
+        schema: import("arktype/internal/methods/array.ts").ArrayType<{
+            abbreviation: string;
+            display_name: string;
+            key: string;
+            year: number;
+        }[], {}>;
+        arguments: import("arktype/internal/methods/array.ts").ArrayType<[number], {}>;
+    };
+    "/district/{district_abbreviation}/history": {
+        schema: import("arktype/internal/methods/array.ts").ArrayType<{
+            abbreviation: string;
+            display_name: string;
+            key: string;
+            year: number;
+        }[], {}>;
+        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
+    };
+    "/district/{district_key}/events": {
+        schema: import("arktype/internal/methods/array.ts").ArrayType<{
+            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;
+        }[], {}>;
+        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
+    };
+    "/district/{district_key}/awards": {
+        schema: import("arktype/internal/methods/array.ts").ArrayType<{
+            name: string;
+            award_type: number;
+            event_key: string;
+            recipient_list: {
+                team_key: string | null;
+                awardee: string | null;
+            }[];
+            year: number;
+        }[], {}>;
+        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
+    };
+    "/district/{district_key}/events/simple": {
+        schema: import("arktype/internal/methods/array.ts").ArrayType<{
+            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;
+        }[], {}>;
+        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
+    };
+    "/district/{district_key}/events/keys": {
+        schema: import("arktype/internal/methods/array.ts").ArrayType<string[], {}>;
+        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
+    };
+    "/district/{district_key}/teams": {
+        schema: import("arktype/internal/methods/array.ts").ArrayType<{
+            key: string;
+            team_number: number;
+            nickname: string;
+            name: string;
+            city: string | null;
+            state_prov: string | null;
+            country: string | null;
+            postal_code: string | null;
+            rookie_year: number | null;
+            website?: string | null | undefined;
+        }[], {}>;
+        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
+    };
+    "/district/{district_key}/teams/simple": {
+        schema: import("arktype/internal/methods/array.ts").ArrayType<{
+            key: string;
+            team_number: number;
+            nickname: string;
+            name: string;
+            city: string | null;
+            state_prov: string | null;
+            country: string | null;
+        }[], {}>;
+        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
+    };
+    "/district/{district_key}/teams/keys": {
+        schema: import("arktype/internal/methods/array.ts").ArrayType<string[], {}>;
+        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
+    };
+    "/district/{district_key}/rankings": {
+        schema: import("arktype").BaseType<{
+            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;
+        }[] | null, {}>;
+        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
+    };
+    "/district/{district_key}/advancement": {
+        schema: import("arktype").BaseType<{
+            [x: string]: {
+                dcmp: boolean;
+                cmp: boolean;
+            };
+        } | null, {}>;
+        arguments: import("arktype/internal/methods/array.ts").ArrayType<[string], {}>;
+    };
+};

package/dist/types/endpoints/districts.js

@@ -0,0 +1,50 @@
+import { District_Advancement, District_List, District_Ranking, } from "../schemas/districts.js";
+import { Event, Event_Simple } from "../schemas/events.js";
+import { Award, Team, Team_Simple } from "../schemas/teams.js";
+import { type } from "arktype";
+export const districtEndpoints = {
+    "/districts/{year}": {
+        schema: District_List.array(),
+        arguments: type(["number"]),
+    },
+    "/district/{district_abbreviation}/history": {
+        schema: District_List.array(),
+        arguments: type(["string"]),
+    },
+    "/district/{district_key}/events": {
+        schema: Event.array(),
+        arguments: type(["string"]),
+    },
+    "/district/{district_key}/awards": {
+        schema: Award.array(),
+        arguments: type(["string"]),
+    },
+    "/district/{district_key}/events/simple": {
+        schema: Event_Simple.array(),
+        arguments: type(["string"]),
+    },
+    "/district/{district_key}/events/keys": {
+        schema: type("string[]"),
+        arguments: type(["string"]),
+    },
+    "/district/{district_key}/teams": {
+        schema: Team.array(),
+        arguments: type(["string"]),
+    },
+    "/district/{district_key}/teams/simple": {
+        schema: Team_Simple.array(),
+        arguments: type(["string"]),
+    },
+    "/district/{district_key}/teams/keys": {
+        schema: type("string[]"),
+        arguments: type(["string"]),
+    },
+    "/district/{district_key}/rankings": {
+        schema: type(District_Ranking.array(), "|", "null"),
+        arguments: type(["string"]),
+    },
+    "/district/{district_key}/advancement": {
+        schema: type({ "[string]": District_Advancement }, "|", "null"),
+        arguments: type(["string"]),
+    },
+};