@srating-io/types 2.0.0 → 2.0.1

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/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/audit.d.ts

@@ -0,0 +1,88 @@
+/**
+ * One row per distinct bug rather than per occurrence: `fingerprint` is derived server side, so a
+ * repeat bumps `occurrences` instead of inserting.
+ *
+ * `stack`, `state` and `json_context` are large and are only sent by `audit_gui.detail` -- the list
+ * endpoint leaves them out, which is why they are optional here.
+ */
+export interface AuditGui {
+    audit_gui_id: number;
+    fingerprint: string;
+    release: string;
+    source: string;
+    name: string | null;
+    message: string | null;
+    digest: string | null;
+    route: string | null;
+    stack?: string | null;
+    state?: string | null;
+    json_context?: string | null;
+    occurrences: number;
+    date_of_entry: string;
+    last_seen: string;
+    resolved: number;
+    deleted: number;
+}
+export type AuditGuis = {
+    [audit_gui_id: number]: AuditGui;
+};
+/**
+ * One row per request to the public api. Written only when the caller presented an api key, so
+ * nothing the gui does lands here.
+ */
+export interface AuditApi {
+    audit_api_id: number;
+    api_key_id: number | null;
+    class: string | null;
+    function: string | null;
+    arguments: string | null;
+    date_of_entry: string;
+    deleted: number;
+}
+export type AuditApis = {
+    [audit_api_id: number]: AuditApi;
+};
+/**
+ * A failure inside the api, one row per occurrence -- unlike `audit_gui` these are not grouped.
+ */
+export interface AuditError {
+    audit_error_id: number;
+    api_key_id: number | null;
+    class: string | null;
+    function: string | null;
+    arguments: string | null;
+    error: string | null;
+    date_of_entry: string;
+    deleted: number;
+}
+export type AuditErrors = {
+    [audit_error_id: number]: AuditError;
+};
+export interface AuditCreated {
+    audit_created_id: number;
+    api_key_id: number | null;
+    table: string | null;
+    id: string | null;
+    date_of_entry: string;
+    deleted: number;
+}
+export type AuditCreateds = {
+    [audit_created_id: number]: AuditCreated;
+};
+/**
+ * One row per *column* changed by a generic update, not one per update.
+ */
+export interface AuditUpdated {
+    audit_updated_id: number;
+    api_key_id: number | null;
+    table: string | null;
+    id: string | null;
+    column: string | null;
+    old_value: string | null;
+    new_value: string | null;
+    date_of_entry: string;
+    deleted: number;
+}
+export type AuditUpdateds = {
+    [audit_updated_id: number]: AuditUpdated;
+};

package/dist/auth.d.ts

@@ -3,6 +3,7 @@ export interface User {
     username: string;
     display_name: string | null;
     stripe_customer: string;
+    role_type_terminology_id: string | null;
     default_user_payment_token_id: string | null;
     date_of_entry: string;
     updated_at: string;

package/dist/index.d.ts

@@ -1,10 +1,12 @@
 export * as ApiKey from './api/api_key.ts';
+export * as AuditGui from './api/audit_gui.ts';
 export * as Billing from './api/billing.ts';
 export * as Boxscore from './api/boxscore.ts';
 export * as CoachStatisticRanking from './api/coach_statistic_ranking.ts';
 export * as Conference from './api/conference.ts';
 export * as ConferencePlayerStatisticRanking from './api/conference_player_statistic_ranking.ts';
 export * as ConferenceStatisticRanking from './api/conference_statistic_ranking.ts';
+export * as Dashboard from './api/dashboard.ts';
 export * as FantasyBracketSlot from './api/fantasy_bracket_slot.ts';
 export * as FantasyDraftOrder from './api/fantasy_draft_order.ts';
 export * as FantasyEntry from './api/fantasy_entry.ts';
@@ -30,6 +32,7 @@ export * as StatisticRanking from './api/statistic_ranking.ts';
 export * as Team from './api/team.ts';
 export * as User from './api/user.ts';
 export * as UserPaymentToken from './api/user_payment_token.ts';
+export * as Audit from './audit.ts';
 export * as Auth from './auth.ts';
 export * as Basketball from './basketball.ts';
 export * as Fantasy from './fantasy.ts';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@srating-io/types",
   "private": false,
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "srating.io shared TypeScript types for GUI and API",
   "type": "module",
   "main": "dist/index.js",