fansunited-data-layer 0.16.0 → 0.17.2

package/types/canonical/sports-livescore.types.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Canonical types for the Fans United Sports API livescore endpoint.
+ *
+ * Returns events for a given date grouped by competition, optionally filtered
+ * by sport, competitions, match IDs, and event status.
+ */
+/**
+ * Sports the livescore endpoint currently supports. Treated as an open string
+ * so future additions don't force a library bump.
+ */
+export type FUSportsLivescoreSport = "FOOTBALL" | "BASKETBALL" | "TENNIS" | "AMERICAN_FOOTBALL" | "FORMULA_1" | "HOCKEY" | (string & {});
+/**
+ * Event status filter value accepted by the endpoint.
+ */
+export type FUSportsLivescoreEventStatus = "NOTSTARTED" | "LIVE" | "FINISHED";
+/**
+ * Status block on each livescore event. The API surfaces a high-level `type`
+ * plus a finer-grained `code`/`subType` pair (e.g. type="FINISHED",
+ * code="finished", subType="finished"; or type="SCHEDULED", code="scheduled",
+ * subType="not_started").
+ */
+export interface FUSportsLivescoreStatus {
+    type: string;
+    code: string;
+    subType: string;
+}
+/**
+ * A single score line for an event. Football emits `result`, `full_time`,
+ * `half_time`; basketball adds `q1`–`q4`; other sports will introduce their
+ * own keys. Values are kept as strings to match the source API verbatim.
+ */
+export interface FUSportsLivescoreScore {
+    key: string;
+    competitorOne: string;
+    competitorTwo: string;
+}
+/**
+ * Lightweight competitor identity attached to each event. `type` distinguishes
+ * teams from individuals ("team", "player", …).
+ */
+export interface FUSportsLivescoreCompetitor {
+    id: string;
+    type: string;
+}
+/**
+ * One match within a competition group.
+ *
+ * `score` is omitted for events that haven't started yet (SCHEDULED). For
+ * finished/live events it carries an ordered list of score lines whose keys
+ * vary by sport.
+ */
+export interface FUSportsLivescoreEvent {
+    id: string;
+    status: FUSportsLivescoreStatus;
+    score?: FUSportsLivescoreScore[];
+    competitorOne: FUSportsLivescoreCompetitor;
+    competitorTwo: FUSportsLivescoreCompetitor;
+    /** ISO-ish start time as returned by the API (e.g. "2026-06-11 17:00:00Z"). */
+    startTime: string;
+}
+/**
+ * Events for a given competition. Competitions are returned in the order
+ * dictated by the `competitionsOrder` option, with the remainder appended.
+ */
+export interface FUSportsLivescoreCompetitionGroup {
+    competitionId: string;
+    sport: FUSportsLivescoreSport;
+    events: FUSportsLivescoreEvent[];
+}
+/**
+ * Response-level totals.
+ */
+export interface FUSportsLivescoreMeta {
+    totalCompetitions: number;
+    totalEvents: number;
+}
+/**
+ * Full livescore payload returned by `GET /v1/livescore`.
+ */
+export interface FUSportsLivescore {
+    data: FUSportsLivescoreCompetitionGroup[];
+    meta: FUSportsLivescoreMeta;
+}
+//# sourceMappingURL=sports-livescore.types.d.ts.map

package/types/canonical/sports-livescore.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sports-livescore.types.d.ts","sourceRoot":"","sources":["../../../src/lib/types/canonical/sports-livescore.types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAC5B,UAAU,GACV,YAAY,GACZ,QAAQ,GACR,mBAAmB,GACnB,WAAW,GACX,QAAQ,GACR,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAEpB;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,YAAY,GAAG,MAAM,GAAG,UAAU,CAAC;AAE9E;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,uBAAuB,CAAC;IAChC,KAAK,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACjC,aAAa,EAAE,2BAA2B,CAAC;IAC3C,aAAa,EAAE,2BAA2B,CAAC;IAC3C,+EAA+E;IAC/E,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAC9C,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,sBAAsB,CAAC;IAC9B,MAAM,EAAE,sBAAsB,EAAE,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,iCAAiC,EAAE,CAAC;IAC1C,IAAI,EAAE,qBAAqB,CAAC;CAC/B"}