@srating-io/types 1.1.6 → 2.0.1

package/dist/api/api_key.d.ts

@@ -0,0 +1,5 @@
+import { ApiKey } from '../auth.ts';
+export type regenerateArguments = {
+    key: string;
+};
+export type regenerateResults = ApiKey | {};

package/dist/api/audit_gui.d.ts

@@ -0,0 +1,48 @@
+import { AuditGui } from '../audit.ts';
+export type listOrderBy = 'last_seen' | 'occurrences' | 'date_of_entry';
+export type listArguments = {
+    /** 0 or 1. Left out means both, which is what the "all" filter sends. */
+    resolved?: number;
+    release?: string;
+    source?: string;
+    route?: string;
+    /** Matched against `name` and `message`. */
+    search?: string;
+    order_by?: listOrderBy;
+    order?: 'asc' | 'desc';
+    limit?: number;
+    offset?: number;
+};
+/**
+ * `rows` is an array rather than the id-keyed map the generic `read` returns. `audit_gui_id` is an
+ * integer, and an object with integer-like keys is iterated in numeric order by every javascript
+ * engine -- which would silently throw away the sort the caller asked for.
+ *
+ * `release` and `source` are the distinct values present in the table, for populating the filters.
+ */
+export type listResults = {
+    error: string;
+} | {
+    rows: AuditGui[];
+    total: number;
+    release: string[];
+    source: string[];
+};
+export type detailArguments = {
+    audit_gui_id: number | string;
+};
+export type detailResults = {
+    error: string;
+} | {
+    row: AuditGui | null;
+};
+export type resolveArguments = {
+    audit_gui_id: number | string;
+    resolved: number | string;
+};
+export type resolveResults = {
+    error: string;
+} | {
+    audit_gui_id: number;
+    resolved: number;
+};

package/dist/api/billing.d.ts

@@ -0,0 +1,55 @@
+import { ApiKeys } from '../auth.ts';
+import { Subscription, Subscriptions, Pricings, UserPaymentTokens, PaymentRouter } from '../payments.ts';
+import { FantasyGroupUsers, FantasyGroups } from '../fantasy.ts';
+import { loadUserResults } from './user.ts';
+export type loadAccountResults = {} | {
+    subscription: Subscriptions;
+    pricing: Pricings;
+    api_key: ApiKeys;
+    user: loadUserResults;
+    fantasy_group_user: FantasyGroupUsers;
+    fantasy_group: FantasyGroups;
+    user_payment_token: UserPaymentTokens;
+};
+export type createFantasyGroupEntryArguments = {
+    fantasy_group_id: string;
+    name: string;
+};
+export type createFantasyGroupEntryResults = {
+    error: string;
+} | {
+    error: {
+        message: string;
+    };
+} | {
+    paymentIntent: unknown;
+    payment_router: PaymentRouter | null;
+    email: string;
+};
+export type createSubscriptionArguments = {
+    priceId: string;
+    email: string;
+};
+export type createSubscriptionResults = {
+    error: {
+        message: string;
+    };
+} | {
+    type: 'setup' | 'payment';
+    clientSecret: string | null | undefined;
+    session_id: string;
+};
+export type cancelSubscriptionArguments = {
+    subscription_id: string;
+};
+export type cancelSubscriptionResults = {} | Subscription;
+export type createTrialArguments = {
+    email: string;
+};
+export type createTrialResults = {
+    error: {
+        message: string;
+    };
+} | {
+    session_id: string | null;
+};

package/dist/api/boxscore.d.ts

@@ -0,0 +1,15 @@
+import { Boxscore } from '../general.ts';
+import * as Basketball from '../basketball.ts';
+import * as Football from '../football.ts';
+export type getBoxscoreArguments = {
+    organization_id: string;
+} & Partial<Boxscore>;
+export type getBoxscoreResults = Basketball.Boxscore | Football.Boxscore | {
+    error: string;
+};
+export type readBoxscoreArguments = {
+    organization_id: string;
+} & Partial<Boxscore>;
+export type readBoxscoreResults = Basketball.Boxscores | Football.Boxscores | {
+    error: string;
+};

package/dist/api/coach_statistic_ranking.d.ts

@@ -0,0 +1,7 @@
+import { CoachStatisticRanking } from '../general.ts';
+export type getStatsArguments = {
+    organization_id: string;
+} & Partial<CoachStatisticRanking>;
+export type getStatsResults = CoachStatisticRanking | {
+    error: string;
+};

package/dist/api/conference.d.ts

@@ -0,0 +1,12 @@
+import * as Basketball from '../basketball.ts';
+import * as Football from '../football.ts';
+export type getConferencePredictionArguments = {
+    organization_id: string;
+    conference_id: string;
+    season: string | number;
+};
+export type getConferencePredictionResults = {
+    error: string;
+} | ((Basketball.StatisticRankings | Football.StatisticRankings) & Record<string, {
+    hasAccess: boolean;
+}>);

package/dist/api/conference_player_statistic_ranking.d.ts

@@ -0,0 +1,9 @@
+import { ConferencePlayerStatisticRanking } from '../general.ts';
+import * as Basketball from '../basketball.ts';
+import * as Football from '../football.ts';
+export type getStatsArguments = {
+    organization_id: string;
+} & Partial<ConferencePlayerStatisticRanking>;
+export type getStatsResults = Basketball.ConferencePlayerStatisticRanking | Football.ConferencePlayerStatisticRanking | {
+    error: string;
+};

package/dist/api/conference_statistic_ranking.d.ts

@@ -0,0 +1,9 @@
+import { ConferenceStatisticRanking } from '../general.ts';
+import * as Basketball from '../basketball.ts';
+import * as Football from '../football.ts';
+export type getStatsArguments = {
+    organization_id: string;
+} & Partial<ConferenceStatisticRanking>;
+export type getStatsResults = Basketball.ConferenceStatisticRanking | Football.ConferenceStatisticRanking | {
+    error: string;
+};

package/dist/api/dashboard.d.ts

@@ -0,0 +1,136 @@
+import { AuditApi, AuditError } from '../audit.ts';
+import { Pricings } from '../payments.ts';
+/**
+ * Every endpoint on this class is admin only and answers `{ error }` to everyone else, so each
+ * result is a union with the refusal rather than an optional-everything object.
+ */
+export type overviewResults = {
+    error: string;
+} | {
+    audit_gui: {
+        unresolved: number;
+        /** Summed `occurrences` over the unresolved rows -- how much the open bugs are actually firing. */
+        occurrences: number;
+        last_24h: number;
+    };
+    audit_error: {
+        last_24h: number;
+        last_7d: number;
+    };
+    audit_api: {
+        last_24h: number;
+    };
+    subscription: {
+        active: number;
+        type_x_active: {
+            [type: string]: number;
+        };
+    };
+    user: {
+        total: number;
+        last_7d: number;
+    };
+    payment_router: {
+        unhandled: number;
+    };
+    api_key: {
+        total: number;
+        /** Keys at or past 80% of their `usage_limit`. */
+        near_limit: number;
+    };
+};
+/**
+ * A subscription with the few joined columns the dashboard shows beside it. Not the whole `user`
+ * row -- `username` is the only part worth seeing in a list, and the rest of that table has no
+ * business being shipped here.
+ */
+export interface RevenueSubscription {
+    subscription_id: string;
+    user_id: string | null;
+    username: string | null;
+    pricing_id: string | null;
+    pricing_name: string | null;
+    pricing_type: string | null;
+    stripe_subscription: string | null;
+    date_of_entry: string;
+    renewed: string | null;
+    expires: string | null;
+}
+export type revenueResults = {
+    error: string;
+} | {
+    pricing: Pricings;
+    type_x_active: {
+        [type: string]: number;
+    };
+    pricing_id_x_active: {
+        [pricing_id: string]: number;
+    };
+    /** Active subscriptions whose `expires` falls inside the next 30 days. */
+    renewals: RevenueSubscription[];
+    /** Active subscriptions on a `trial` plan. */
+    trials: RevenueSubscription[];
+    /** Subscriptions created per day over the trailing window, as `Y-m-d` keys. */
+    date_x_created: {
+        [date: string]: number;
+    };
+    unhandled_payment_routers: number;
+};
+export interface ApiErrorCount {
+    class: string | null;
+    function: string | null;
+    total: number;
+}
+export type apiTrafficArguments = {
+    /**
+     * How far back to look. Bounded server side, because `audit_api` is the largest table in the
+     * database and `date_of_entry` is the only index on it.
+     */
+    days?: number;
+};
+export type apiTrafficResults = {
+    error: string;
+} | {
+    days: number;
+    date_x_requests: {
+        [date: string]: number;
+    };
+    api_key_id_x_requests: {
+        [api_key_id: string]: number;
+    };
+    class_x_requests: {
+        [class_name: string]: number;
+    };
+    recent_requests: AuditApi[];
+    date_x_errors: {
+        [date: string]: number;
+    };
+    error_counts: ApiErrorCount[];
+    recent_errors: AuditError[];
+};
+/**
+ * An api key as the dashboard sees it. The `key` column itself is deliberately absent: it is the
+ * credential, and nothing on this page needs it to answer "who is near their limit".
+ */
+export interface DashboardApiKey {
+    api_key_id: number;
+    user_id: string | null;
+    username: string | null;
+    subscription_id: string | null;
+    pricing_name: string | null;
+    pricing_type: string | null;
+    usage: number | null;
+    usage_limit: number | null;
+    read: number;
+    write: number;
+    hidden_access: number;
+    rate_limiter: number;
+    expires: string | null;
+    last_reset: string | null;
+    deleted: number;
+}
+export type apiKeysResults = {
+    error: string;
+} | {
+    rows: DashboardApiKey[];
+};

package/dist/api/fantasy_bracket_slot.d.ts

@@ -0,0 +1,10 @@
+import { FantasyBracketSlots } from '../fantasy.ts';
+export type pickArguments = {
+    fantasy_bracket_slot_id: string;
+    team_id: string | null;
+};
+export type pickResults = {
+    error: string;
+} | {
+    fantasy_bracket_slots: FantasyBracketSlots;
+};

package/dist/api/fantasy_draft_order.d.ts

@@ -0,0 +1,15 @@
+import { PlayerTeamSeasons, Players } from '../general.ts';
+import { FantasyDraftOrders, FantasyEntryPlayers, FantasyGroup } from '../fantasy.ts';
+export type pickArguments = {
+    fantasy_draft_order_id: string;
+    player_team_season_id: string;
+};
+export type pickResults = {
+    error: string;
+} | {
+    fantasy_draft_orders: FantasyDraftOrders;
+    fantasy_entry_players: FantasyEntryPlayers;
+    player_team_seasons: PlayerTeamSeasons;
+    players: Players;
+    fantasy_group?: FantasyGroup;
+};

package/dist/api/fantasy_entry.d.ts

@@ -0,0 +1,37 @@
+import * as Basketball from '../basketball.ts';
+import * as Football from '../football.ts';
+import { BracketTeams, PlayerTeamSeasons, Players, Games, Teams } from '../general.ts';
+import { FantasyEntrys, FantasyGroupUsers, FantasyBracketSlots, FantasyEntryPlayers, FantasyEntryPlayerStatisticRanking } from '../fantasy.ts';
+export type createEntryArguments = {
+    fantasy_group_id: string;
+    name: string;
+};
+export type createEntryResults = {
+    error: string;
+} | {
+    fantasy_entrys: FantasyEntrys;
+    fantasy_group_users?: FantasyGroupUsers;
+};
+export type createBracketArguments = {
+    fantasy_entry_id: string;
+};
+export type createBracketResults = {
+    error: string;
+} | FantasyBracketSlots;
+export type loadArguments = {
+    fantasy_entry_id: string;
+};
+export type loadResults = {
+    error: string;
+} | {
+    fantasy_entry_players: FantasyEntryPlayers | {};
+    fantasy_bracket_slots: FantasyBracketSlots;
+    bracket_teams: BracketTeams;
+    player_team_seasons: PlayerTeamSeasons;
+    players: Players;
+    games: Games;
+    fantasy_entry_player_statistic_rankings: {
+        [fantasy_entry_player_statistic_ranking_id: string]: FantasyEntryPlayerStatisticRanking & (Basketball.PlayerStatisticRanking | Football.PlayerStatisticRanking);
+    };
+    teams: Teams;
+};

package/dist/api/fantasy_entry_player_statistic_ranking.d.ts

@@ -0,0 +1,9 @@
+import { FantasyEntryPlayerStatisticRanking } from '../fantasy.ts';
+import * as Basketball from '../basketball.ts';
+import * as Football from '../football.ts';
+export type getStatsArguments = {
+    organization_id: string;
+} & Partial<FantasyEntryPlayerStatisticRanking>;
+export type getStatsResults = (FantasyEntryPlayerStatisticRanking & (Basketball.PlayerStatisticRanking | Football.PlayerStatisticRanking)) | {
+    error: string;
+};

package/dist/api/fantasy_group.d.ts

@@ -0,0 +1,77 @@
+import * as Basketball from '../basketball.ts';
+import * as Football from '../football.ts';
+import { PlayerTeamSeasons, Players } from '../general.ts';
+import { FantasyGroup, FantasyGroups, FantasyGroupUsers, FantasyGroupInvites, FantasyGroupComments, FantasyEntrys, FantasyRankings, FantasyDraftOrders, FantasyEntryPlayers, FantasyEntryPlayerStatisticRanking } from '../fantasy.ts';
+export type createGroupArguments = Partial<Omit<FantasyGroup, 'fantasy_group_id' | 'owner_user_id' | 'guid' | 'deleted' | 'date_of_entry'>>;
+export type createGroupResults = {
+    error: string;
+} | FantasyGroup;
+export type sendInvitesArguments = {
+    fantasy_group_id: string;
+    emails: string;
+};
+export type sendInvitesResults = {
+    error: string;
+} | FantasyGroupInvites;
+export type leaveArguments = {
+    fantasy_group_id: string;
+};
+export type leaveResults = {
+    error: string;
+} | loadResults;
+export type removeArguments = {
+    fantasy_group_id: string;
+};
+export type removeResults = {
+    error: string;
+} | boolean;
+export type lockArguments = {
+    fantasy_group_id: string;
+};
+export type lockResults = {
+    error: string;
+} | {
+    fantasy_group: FantasyGroup;
+    fantasy_draft_orders: FantasyDraftOrders;
+};
+export type finishArguments = {
+    fantasy_group_id: string;
+};
+export type finishResults = {
+    error: string;
+} | {
+    fantasy_group: FantasyGroup;
+};
+export type loadArguments = {
+    fantasy_group_id: string;
+};
+export type loadResults = {
+    error: string;
+} | {
+    isOwner: boolean;
+    fantasy_group: FantasyGroup;
+    fantasy_group_users: FantasyGroupUsers;
+    fantasy_group_invites: FantasyGroupInvites;
+    fantasy_entrys: FantasyEntrys;
+    fantasy_rankings: FantasyRankings;
+    fantasy_group_comments: FantasyGroupComments;
+    fantasy_draft_orders: FantasyDraftOrders;
+    fantasy_entry_players: FantasyEntryPlayers;
+    player_team_seasons: PlayerTeamSeasons;
+    players: Players;
+    fantasy_entry_player_statistic_rankings: {
+        [fantasy_entry_player_statistic_ranking_id: string]: FantasyEntryPlayerStatisticRanking & (Basketball.PlayerStatisticRanking | Football.PlayerStatisticRanking);
+    };
+};
+export type loadHomeArguments = {
+    organization_id: string;
+    division_id: string;
+    season: number;
+};
+export type loadHomeResults = {
+    error: string;
+} | {
+    fantasy_groups: FantasyGroups;
+    fantasy_group_users: FantasyGroupUsers;
+    fantasy_entrys: FantasyEntrys;
+};

package/dist/api/fantasy_group_comment.d.ts

@@ -0,0 +1,10 @@
+import { FantasyGroupComment } from '../fantasy.ts';
+export type createCommentArguments = {
+    fantasy_group_id: string;
+    comment: string;
+};
+export type createCommentResults = {
+    error: string;
+} | {
+    [fantasy_group_comment_id: string]: FantasyGroupComment;
+};

package/dist/api/fantasy_group_invite.d.ts

@@ -0,0 +1,10 @@
+export type joinArguments = {
+    fantasy_group_invite_id: string;
+    code: string;
+};
+export type joinResults = {
+    error: string;
+} | {
+    fantasy_group_id: string;
+    session_id: string;
+};

package/dist/api/favorite.d.ts

@@ -0,0 +1,33 @@
+import * as Basketball from '../basketball.ts';
+import * as Football from '../football.ts';
+import { Players, PlayerTeamSeasons, Teams } from '../general.ts';
+import { getGamesResults } from './game.ts';
+export interface Favorite {
+    favorite_id: string;
+    user_id: string;
+    json_team_ids: string[];
+    json_player_ids: string[];
+    json_game_ids: string[];
+    guid: string;
+    deleted: number;
+}
+export type loadFavoriteDataArguments = {
+    season?: number;
+};
+export type loadFavoriteDataResults = {
+    schedule: {} | getGamesResults;
+    favorite: Partial<Favorite>;
+    teams: {} | Teams;
+    players: {} | Players;
+    gamelog: {} | Basketball.PlayerBoxscores | Football.PlayerBoxscores | {
+        error: string;
+    };
+    player_team_seasons: {} | PlayerTeamSeasons;
+};
+export type getFavoriteResults = Partial<Favorite>;
+export type updateFavoriteArguments = {
+    team_id?: string;
+    player_id?: string;
+    game_id?: string;
+};
+export type updateFavoriteResults = Partial<Favorite>;

package/dist/api/league_player_statistic_ranking.d.ts

@@ -0,0 +1,9 @@
+import { LeaguePlayerStatisticRanking } from '../general.ts';
+import * as Basketball from '../basketball.ts';
+import * as Football from '../football.ts';
+export type getStatsArguments = {
+    organization_id: string;
+} & Partial<LeaguePlayerStatisticRanking>;
+export type getStatsResults = Basketball.LeaguePlayerStatisticRanking | Football.LeaguePlayerStatisticRanking | {
+    error: string;
+};

package/dist/api/league_statistic_ranking.d.ts

@@ -0,0 +1,9 @@
+import { LeagueStatisticRanking } from '../general.ts';
+import * as Basketball from '../basketball.ts';
+import * as Football from '../football.ts';
+export type getStatsArguments = {
+    organization_id: string;
+} & Partial<LeagueStatisticRanking>;
+export type getStatsResults = Basketball.LeagueStatisticRanking | Football.LeagueStatisticRanking | {
+    error: string;
+};

package/dist/api/notification.d.ts

@@ -0,0 +1,7 @@
+import { Notifications } from '../auth.ts';
+export type clearArguments = {
+    notification_id: string[];
+};
+export type clearResults = Notifications | {
+    error: string;
+};

package/dist/api/play_by_play.d.ts

@@ -0,0 +1,17 @@
+import * as Basketball from '../basketball.ts';
+export type readPlaybyPlayArguments = {
+    game_id: string;
+    organization_id?: string;
+    division_id?: string;
+};
+export type readPlaybyPlayResults = Basketball.PlaybyPlays | {
+    error: string;
+};
+export type getPlaybyPlayArguments = {
+    game_id: string;
+    organization_id?: string;
+    division_id?: string;
+};
+export type getPlaybyPlayResults = Basketball.PlaybyPlay | {
+    error: string;
+};

package/dist/api/player.d.ts

@@ -0,0 +1,18 @@
+import * as Basketball from '../basketball.ts';
+import * as Football from '../football.ts';
+import { PlayerTeamSeasons } from '../general.ts';
+export type getSeasonsArguments = {
+    player_id: string;
+};
+export type getSeasonsResults = PlayerTeamSeasons | {
+    error: string;
+};
+export type getGameLogsArguments = {
+    organization_id: string;
+    division_id: string;
+    player_id: string;
+    season: number;
+};
+export type getGameLogsResults = Basketball.PlayerBoxscores | Football.PlayerBoxscores | {
+    error: string;
+};

package/dist/api/player_boxscore.d.ts

@@ -0,0 +1,15 @@
+import { PlayerBoxscore } from '../general.ts';
+import * as Basketball from '../basketball.ts';
+import * as Football from '../football.ts';
+export type getPlayerBoxscoreArguments = {
+    organization_id: string;
+} & Partial<PlayerBoxscore>;
+export type getPlayerBoxscoreResults = Basketball.PlayerBoxscore | Football.PlayerBoxscore | {
+    error: string;
+};
+export type readPlayerBoxscoreArguments = {
+    organization_id: string;
+} & Partial<PlayerBoxscore>;
+export type readPlayerBoxscoreResults = Basketball.PlayerBoxscores | Football.PlayerBoxscores | {
+    error: string;
+};

package/dist/api/player_statistic_ranking.d.ts

@@ -0,0 +1,9 @@
+import { PlayerStatisticRanking } from '../general.ts';
+import * as Basketball from '../basketball.ts';
+import * as Football from '../football.ts';
+export type getStatsArguments = {
+    organization_id: string;
+} & Partial<PlayerStatisticRanking>;
+export type getStatsResults = Basketball.PlayerStatisticRanking | Football.PlayerStatisticRanking | {
+    error: string;
+};

package/dist/api/prediction.d.ts

@@ -0,0 +1,17 @@
+export type compareArguments = {
+    organization_id: string;
+    division_id: string;
+    home_team_id: string;
+    away_team_id: string;
+    season: number;
+    neutral_site: boolean;
+};
+export interface PredictionRunResult {
+    home: number;
+    away: number;
+    home_score: number | null;
+    away_score: number | null;
+}
+export type compareResults = {
+    error: string;
+} | {} | PredictionRunResult;

package/dist/api/ranking.d.ts

@@ -0,0 +1,22 @@
+export type loadArguments = {
+    season: number;
+    organization_id: string;
+    division_id: string;
+    fxn: string;
+    career?: number;
+    career_active?: number;
+};
+export type loadResults = {
+    error: string;
+} | unknown;
+export type downloadArguments = {
+    season: number;
+    organization_id: string;
+    division_id: string;
+    view: string;
+    career?: number;
+    career_active?: number;
+};
+export type downloadResults = {
+    error: string;
+} | false | unknown;