@acarmisc/backstage-plugin-litellm 0.19.0 → 0.21.0

package/dist/budget.d.ts

@@ -0,0 +1,54 @@
+import { UserInfo, TeamInfo, VirtualKey } from './types';
+import { Tone } from './components/ui';
+/** One concrete budget limit the signed-in user is subject to. */
+export interface BudgetLimit {
+    kind: 'key' | 'user' | 'team';
+    /** Display name: key_alias / "Personal budget" / team_alias. */
+    label: string;
+    /** Secondary identifier: masked key, team_id, etc. */
+    sublabel?: string;
+    /** Spend cap in USD (> 0 when a cap exists). */
+    budget: number;
+    /** Spend so far in the current window. */
+    spend: number;
+    /** Reset window, e.g. "30d". Missing means the budget never resets. */
+    budgetDuration?: string;
+    /** User-facing warning threshold (soft limit). */
+    softLimit?: number;
+    /** Share of the cap spent, 0..100+ (unclamped). */
+    pct: number;
+}
+/** The budgets that apply to the current user, grouped by enforcement level. */
+export interface BudgetSummary {
+    /** Budgeted keys, capped at `maxKeys`, closest to the cap first. */
+    keys: BudgetLimit[];
+    /** Budgeted keys hidden by the cap. */
+    hiddenBudgetedKeys: number;
+    /** Every key owned by the user (budgeted or not). */
+    totalKeyCount: number;
+    /** Personal budget, when one is set (undefined otherwise). */
+    user?: BudgetLimit;
+    /** Team budgets shared by the user's teams. */
+    teams: BudgetLimit[];
+}
+/**
+ * Collapses the current user's data into the budget limits that LiteLLM
+ * actually enforces for them: key budgets (top `maxKeys`, closest to the cap
+ * first), then the personal budget (when set), then each team budget. Team
+ * budgets are enforced for every key bound to that team; a key *without* a
+ * team falls back to the owner's personal budget.
+ */
+export declare function buildBudgetSummary(user: UserInfo | null, teams: TeamInfo[], keys: VirtualKey[], maxKeys?: number): BudgetSummary;
+/**
+ * One-line summary of a `BudgetSummary`, for a collapsed/compact header:
+ * how many concrete limits the user is subject to, and how close the
+ * closest one is to its cap. `closestPct` is null when there are no limits.
+ */
+export declare function budgetHeadline(summary: BudgetSummary): {
+    count: number;
+    closestPct: number | null;
+};
+/** "30d" → "every 30 days"; "1d" → "daily". Returns null when duration is unset. */
+export declare function fmtBudgetDuration(duration?: string): string | null;
+/** status pill tone + meter tone for a budget at `pct`. */
+export declare function budgetTone(pct: number): Tone;

package/dist/budget.test.d.ts

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

package/dist/components/LiteLLMBudgetWidget.d.ts

@@ -0,0 +1,44 @@
+/**
+ * LiteLLM budget-policy widget. Renders the enforcement hierarchy as a
+ * numbered flow — key → personal → team → global — and, against each level
+ * the signed-in user actually has a limit on, a live meter showing how close
+ * they are to the cap. Intended for at-a-glance use on a homepage card next
+ * to `LiteLLMHomeWidget`, but works anywhere.
+ *
+ * The policy text mirrors the LiteLLM proxy behaviour:
+ *   - every request is checked against stacked limits, in order;
+ *   - a key bound to a team is capped by the team budgets, not the owner's
+ *     personal budget;
+ *   - a limit with a `budget_duration` resets its spend when the window
+ *     closes; without one it never resets.
+ *
+ * Two knobs shrink it for use as a secondary column:
+ *   - `compact` drops the numbered rail and the policy footnote, showing
+ *     only the limits the user actually has as a tight tagged meter list;
+ *   - `collapsible` folds the body under a one-line summary header.
+ * `action` renders a host-supplied node (e.g. a button) pinned to the card
+ * bottom, always visible.
+ */
+import React from 'react';
+export interface LiteLLMBudgetWidgetProps {
+    /** Optional title override. Defaults to 'Budget Policy'. */
+    title?: string;
+    /** Max key budgets to show, closest to the cap first. Defaults to 3. */
+    maxKeys?: number;
+    /**
+     * Drop the numbered key→personal→team→global rail and the policy
+     * footnote; show only the limits the user actually has. Defaults to false.
+     */
+    compact?: boolean;
+    /** Fold the body under a clickable one-line summary header. Defaults to false. */
+    collapsible?: boolean;
+    /** Initial expanded state when `collapsible`. Defaults to true. */
+    defaultExpanded?: boolean;
+    /**
+     * Node rendered at the card bottom, below a divider and outside the
+     * collapsible region so it stays visible when collapsed — e.g. a
+     * "create key" button.
+     */
+    action?: React.ReactNode;
+}
+export declare const LiteLLMBudgetWidget: React.FC<LiteLLMBudgetWidgetProps>;