@acarmisc/backstage-plugin-litellm 0.23.0 → 0.24.0

package/dist/budget.d.ts

@@ -45,6 +45,28 @@ export interface BudgetSummary {
  * team falls back to the owner's personal budget.
  */
 export declare function buildBudgetSummary(user: UserInfo | null, teams: TeamInfo[], keys: VirtualKey[], maxKeys?: number): BudgetSummary;
+/** One gauge in the condensed homepage card — a single enforcement level. */
+export interface BudgetGauge {
+    kind: 'key' | 'user' | 'team';
+    /**
+     * The limit of this level nearest its cap, or undefined when the user has
+     * no cap at this level (render an empty gauge).
+     */
+    limit?: BudgetLimit;
+    /** How many limits apply at this level (1 for a personal budget). */
+    count: number;
+}
+/**
+ * Collapses a `BudgetSummary` to exactly one gauge per enforcement level —
+ * key, user, team — carrying the limit nearest its cap and how many limits
+ * that level holds. Every level is always returned, with `limit` undefined
+ * when the user has no cap there, so the caller can render a stable row.
+ *
+ * Pass a summary built with a large `maxKeys` (e.g. `keys.length`) so the
+ * nearest key is present even when it falls outside the display cap; a key
+ * count hidden by that cap is still reflected in `count`.
+ */
+export declare function buildBudgetGauges(summary: BudgetSummary): BudgetGauge[];
 /**
  * One-line summary of a `BudgetSummary`, for a collapsed/compact header:
  * how many concrete limits the user is subject to, and the one closest to

package/dist/components/LiteLLMBudgetGauges.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Condensed budget card for a homepage column: one ring gauge per
+ * enforcement level (key → personal → team), each showing the limit nearest
+ * its cap. Where the full `LiteLLMBudgetWidget` lists every limit as a
+ * spend-vs-cap meter, this trades detail for density — a single row of rings
+ * with a label and spend figure under each.
+ *
+ * Gauges are always rendered in the same order, with an empty ring when the
+ * user has no cap at that level, so the card keeps a stable shape as data
+ * loads and across users. When a level holds several limits, the ring shows
+ * the one closest to its cap and a "+N more" link counts the rest.
+ */
+import React from 'react';
+export interface LiteLLMBudgetGaugesProps {
+    /** Optional title override. Defaults to 'Budget'. */
+    title?: string;
+    /** Ring diameter in px. Defaults to 72. */
+    size?: number;
+    /** Where the "+N more" key link points. Defaults to the Keys tab. */
+    keysHref?: string;
+    /**
+     * Node rendered at the card bottom, below a divider — e.g. a "create key"
+     * button.
+     */
+    action?: React.ReactNode;
+}
+export declare const LiteLLMBudgetGauges: React.FC<LiteLLMBudgetGaugesProps>;

package/dist/components/ui.d.ts

@@ -156,6 +156,26 @@ export declare const Meter: React.FC<{
     tone?: Tone;
     height?: number;
 }>;
+/**
+ * Ring gauge for at-a-glance ratios. Hand-drawn SVG rather than MUI's
+ * `CircularProgress`: the track has to stay a neutral hairline (MUI tints it
+ * from the bar colour, so an empty ring reads as full), and the value may
+ * legitimately exceed 100% — the arc clamps at a full turn while the centre
+ * label keeps the real number.
+ */
+export declare const Gauge: React.FC<{
+    /** Share consumed, 0..100+ (unclamped for the label). */
+    value: number;
+    tone?: Tone;
+    /** Outer diameter in px. */
+    size?: number;
+    /** Ring thickness in px. */
+    thickness?: number;
+    /** Centre content; defaults to the rounded percentage. */
+    label?: React.ReactNode;
+    /** Small caption under the value, inside the ring. */
+    caption?: React.ReactNode;
+}>;
 /**
  * Secondary navigation inside a card. Hand-rolled rather than a second set of
  * `Tabs` so it reads as subordinate to the page tabs instead of competing

package/dist/index.cjs.js

@@ -335,7 +335,7 @@ function SegmentedControl({
     })
   );
 }
-var import_react, import_Box, import_ButtonBase, import_Paper, import_Typography, import_styles, MONTHS, fmtDateShort, fmtCompact, fmtUsdCompact, CHART_COLORS, SERIES, OTHER_COLOR, ChartTooltip, SeriesLegend, StatusPill, TagChip, SectionCard, ChartCard, MetricStrip, Stat, Meter, dataTableSx, quietIconButtonSx, EmptyState;
+var import_react, import_Box, import_ButtonBase, import_Paper, import_Typography, import_styles, MONTHS, fmtDateShort, fmtCompact, fmtUsdCompact, CHART_COLORS, SERIES, OTHER_COLOR, ChartTooltip, SeriesLegend, StatusPill, TagChip, SectionCard, ChartCard, MetricStrip, Stat, Meter, Gauge, dataTableSx, quietIconButtonSx, EmptyState;
 var init_ui = __esm({
   "src/components/ui.tsx"() {
     "use strict";
@@ -705,6 +705,102 @@ var init_ui = __esm({
         }
       )
     );
+    Gauge = ({ value, tone = "accent", size = 72, thickness = 6, label, caption }) => {
+      const clamped = Math.max(0, Math.min(100, value ?? 0));
+      const r = (size - thickness) / 2;
+      const c = 2 * Math.PI * r;
+      const dash = clamped / 100 * c;
+      return /* @__PURE__ */ import_react.default.createElement(
+        import_Box.default,
+        {
+          sx: (theme) => ({
+            position: "relative",
+            width: size,
+            height: size,
+            flexShrink: 0,
+            color: toneColor(theme, tone)
+          })
+        },
+        /* @__PURE__ */ import_react.default.createElement(
+          import_Box.default,
+          {
+            component: "svg",
+            viewBox: `0 0 ${size} ${size}`,
+            width: size,
+            height: size,
+            sx: { display: "block", transform: "rotate(-90deg)" }
+          },
+          /* @__PURE__ */ import_react.default.createElement(
+            import_Box.default,
+            {
+              component: "circle",
+              cx: size / 2,
+              cy: size / 2,
+              r,
+              fill: "none",
+              strokeWidth: thickness,
+              sx: (theme) => ({
+                stroke: (0, import_styles.alpha)(
+                  theme.palette.text.primary,
+                  theme.palette.mode === "dark" ? 0.14 : 0.09
+                )
+              })
+            }
+          ),
+          /* @__PURE__ */ import_react.default.createElement(
+            import_Box.default,
+            {
+              component: "circle",
+              cx: size / 2,
+              cy: size / 2,
+              r,
+              fill: "none",
+              strokeWidth: thickness,
+              strokeLinecap: "round",
+              strokeDasharray: `${dash} ${c - dash}`,
+              sx: (theme) => ({
+                stroke: "currentColor",
+                transition: theme.transitions.create("stroke-dasharray")
+              })
+            }
+          )
+        ),
+        /* @__PURE__ */ import_react.default.createElement(
+          import_Box.default,
+          {
+            sx: {
+              position: "absolute",
+              inset: 0,
+              display: "flex",
+              flexDirection: "column",
+              alignItems: "center",
+              justifyContent: "center",
+              lineHeight: 1
+            }
+          },
+          /* @__PURE__ */ import_react.default.createElement(
+            import_Typography.default,
+            {
+              sx: {
+                fontSize: size <= 64 ? 15 : 18,
+                fontWeight: 700,
+                fontVariantNumeric: "tabular-nums",
+                color: "text.primary"
+              }
+            },
+            label ?? `${Math.round(value)}%`
+          ),
+          caption && /* @__PURE__ */ import_react.default.createElement(
+            import_Typography.default,
+            {
+              variant: "caption",
+              sx: { fontSize: 9.5, color: "text.secondary", mt: 0.25 }
+            },
+            caption
+          )
+        )
+      );
+    };
     dataTableSx = (theme) => ({
       // Element selectors, not `.MuiTableCell-head`: host apps may set a MUI
       // classname prefix (Backstage ships `v5-`), which breaks global class targeting.
@@ -2835,6 +2931,22 @@ function buildBudgetSummary(user, teams, keys, maxKeys = 3) {
     teams: teamLimits
   };
 }
+function buildBudgetGauges(summary) {
+  const byLevel = {
+    key: summary.keys,
+    user: summary.user ? [summary.user] : [],
+    team: summary.teams
+  };
+  return GAUGE_KINDS.map((kind) => {
+    const limits = byLevel[kind];
+    const count = kind === "key" ? limits.length + summary.hiddenBudgetedKeys : limits.length;
+    return {
+      kind,
+      count,
+      limit: limits.length ? limits.reduce((a, b) => b.pct > a.pct ? b : a) : void 0
+    };
+  });
+}
 function budgetHeadline(summary) {
   const all = [
     ...summary.keys,
@@ -2861,9 +2973,11 @@ function budgetTone2(pct) {
   if (pct >= 80) return "warning";
   return "accent";
 }
+var GAUGE_KINDS;
 var init_budget = __esm({
   "src/budget.ts"() {
     "use strict";
+    GAUGE_KINDS = ["key", "user", "team"];
   }
 });
 
@@ -4379,6 +4493,7 @@ __export(index_exports, {
   DashboardHeader: () => DashboardHeader,
   GenerateKeyDialog: () => GenerateKeyDialog,
   KeysTable: () => KeysTable,
+  LiteLLMBudgetGauges: () => LiteLLMBudgetGauges,
   LiteLLMBudgetWidget: () => LiteLLMBudgetWidget,
   LiteLLMHomeWidget: () => LiteLLMHomeWidget,
   LiteLLMPage: () => LiteLLMPage,
@@ -4533,6 +4648,201 @@ var LiteLLMHomeWidget = ({
 
 // src/index.ts
 init_LiteLLMBudgetWidget();
+
+// src/components/LiteLLMBudgetGauges.tsx
+var import_react14 = __toESM(require("react"));
+var import_Paper9 = __toESM(require("@mui/material/Paper"));
+var import_Box13 = __toESM(require("@mui/material/Box"));
+var import_Typography13 = __toESM(require("@mui/material/Typography"));
+var import_CircularProgress8 = __toESM(require("@mui/material/CircularProgress"));
+var import_Alert8 = __toESM(require("@mui/material/Alert"));
+var import_core_plugin_api6 = require("@backstage/core-plugin-api");
+var import_core_components2 = require("@backstage/core-components");
+init_api();
+init_format();
+init_ui();
+init_budget();
+var DEFAULT_KEYS_HREF = "/litellm?tab=keys";
+var LEVEL = {
+  key: { name: "Key", none: "No key budget" },
+  user: { name: "User", none: "No personal budget" },
+  team: { name: "Team", none: "No team budget" }
+};
+function fmtUsdShort(n) {
+  const v = n ?? 0;
+  if (v >= 100 && Number.isInteger(v)) return `$${v}`;
+  return fmtUsd(v);
+}
+function spendCaption(limit) {
+  if (limit.hidden) return "hidden by admin";
+  return `${fmtUsdShort(limit.spend)} / ${fmtUsdShort(limit.budget)}`;
+}
+function resetLabel(limit) {
+  const window2 = fmtBudgetDuration(limit.budgetDuration);
+  return window2 ? `resets ${window2}` : "never resets";
+}
+var LevelGauge = ({
+  gauge,
+  size,
+  keysHref
+}) => {
+  const { name, none } = LEVEL[gauge.kind];
+  const limit = gauge.limit;
+  const tone = limit ? budgetTone2(limit.pct) : "neutral";
+  const extra = gauge.kind === "key" ? Math.max(0, gauge.count - 1) : 0;
+  return /* @__PURE__ */ import_react14.default.createElement(
+    import_Box13.default,
+    {
+      sx: {
+        display: "flex",
+        flexDirection: "column",
+        alignItems: "center",
+        minWidth: 0,
+        flex: 1
+      }
+    },
+    /* @__PURE__ */ import_react14.default.createElement(
+      Gauge,
+      {
+        value: limit?.pct ?? 0,
+        tone,
+        size,
+        label: limit ? `${Math.round(limit.pct)}%` : "\u2014"
+      }
+    ),
+    /* @__PURE__ */ import_react14.default.createElement(
+      import_Typography13.default,
+      {
+        sx: (theme) => ({
+          mt: 0.75,
+          fontSize: 10.5,
+          fontWeight: 700,
+          letterSpacing: "0.08em",
+          textTransform: "uppercase",
+          color: tone === "neutral" ? theme.palette.text.secondary : void 0
+        })
+      },
+      name
+    ),
+    limit ? /* @__PURE__ */ import_react14.default.createElement(import_react14.default.Fragment, null, /* @__PURE__ */ import_react14.default.createElement(
+      import_Typography13.default,
+      {
+        variant: "caption",
+        title: limit.sublabel ? `${limit.label} \xB7 ${limit.sublabel}` : limit.label,
+        sx: {
+          mt: 0.25,
+          fontSize: 11,
+          fontWeight: 600,
+          maxWidth: "100%",
+          overflow: "hidden",
+          textOverflow: "ellipsis",
+          whiteSpace: "nowrap"
+        }
+      },
+      limit.label
+    ), /* @__PURE__ */ import_react14.default.createElement(
+      import_Typography13.default,
+      {
+        variant: "caption",
+        color: "text.secondary",
+        sx: {
+          fontSize: 10.5,
+          fontVariantNumeric: "tabular-nums",
+          textAlign: "center"
+        }
+      },
+      spendCaption(limit)
+    ), extra > 0 ? /* @__PURE__ */ import_react14.default.createElement(
+      import_Typography13.default,
+      {
+        component: import_core_components2.Link,
+        to: keysHref,
+        variant: "caption",
+        sx: {
+          fontSize: 10.5,
+          color: "primary.main",
+          textDecoration: "none",
+          "&:hover": { textDecoration: "underline" }
+        }
+      },
+      "+",
+      extra,
+      " more"
+    ) : /* @__PURE__ */ import_react14.default.createElement(import_Typography13.default, { variant: "caption", color: "text.secondary", sx: { fontSize: 10.5 } }, resetLabel(limit))) : /* @__PURE__ */ import_react14.default.createElement(
+      import_Typography13.default,
+      {
+        variant: "caption",
+        color: "text.secondary",
+        sx: { mt: 0.25, fontSize: 10.5, textAlign: "center" }
+      },
+      none
+    )
+  );
+};
+var LiteLLMBudgetGauges = ({
+  title = "Budget",
+  size = 72,
+  keysHref = DEFAULT_KEYS_HREF,
+  action
+}) => {
+  const api = (0, import_core_plugin_api6.useApi)(liteLlmApiRef);
+  const [loading, setLoading] = (0, import_react14.useState)(true);
+  const [error, setError] = (0, import_react14.useState)(null);
+  const [user, setUser] = (0, import_react14.useState)(null);
+  const [teams, setTeams] = (0, import_react14.useState)([]);
+  const [keys, setKeys] = (0, import_react14.useState)([]);
+  (0, import_react14.useEffect)(() => {
+    let cancelled = false;
+    setLoading(true);
+    setError(null);
+    Promise.allSettled([api.getUserInfo(), api.getTeams(), api.listKeys()]).then(
+      ([userResult, teamsResult, keysResult]) => {
+        if (cancelled) return;
+        if (userResult.status === "fulfilled") {
+          setUser(userResult.value);
+        } else {
+          setUser(null);
+          setError(
+            userResult.reason?.message ?? "Failed to load your LiteLLM profile"
+          );
+        }
+        setTeams(teamsResult.status === "fulfilled" ? teamsResult.value : []);
+        setKeys(keysResult.status === "fulfilled" ? keysResult.value : []);
+        setLoading(false);
+      }
+    );
+    return () => {
+      cancelled = true;
+    };
+  }, [api]);
+  const summary = (0, import_react14.useMemo)(
+    () => buildBudgetSummary(user, teams, keys, keys.length),
+    [user, teams, keys]
+  );
+  const gauges = (0, import_react14.useMemo)(() => buildBudgetGauges(summary), [summary]);
+  const headline = (0, import_react14.useMemo)(() => budgetHeadline(summary), [summary]);
+  const summaryText = headline.count === 0 ? "no limits apply" : `${headline.count} limit${headline.count === 1 ? "" : "s"}`;
+  return /* @__PURE__ */ import_react14.default.createElement(import_Paper9.default, { sx: { p: 2 } }, /* @__PURE__ */ import_react14.default.createElement(import_Box13.default, { sx: { display: "flex", alignItems: "center", gap: 1, mb: 1.5, minWidth: 0 } }, /* @__PURE__ */ import_react14.default.createElement(import_Typography13.default, { variant: "h6", lineHeight: 1.2, sx: { minWidth: 0, flex: 1 } }, title), !loading && !error && /* @__PURE__ */ import_react14.default.createElement(
+    StatusPill,
+    {
+      label: summaryText,
+      tone: budgetTone2(headline.closest?.pct ?? 0),
+      dot: headline.count > 0
+    }
+  )), loading && /* @__PURE__ */ import_react14.default.createElement(import_Box13.default, { display: "flex", justifyContent: "center", alignItems: "center", minHeight: 110 }, /* @__PURE__ */ import_react14.default.createElement(import_CircularProgress8.default, { size: 28 })), !loading && error && /* @__PURE__ */ import_react14.default.createElement(import_Alert8.default, { severity: "error", sx: { mt: 0.5 } }, error), !loading && !error && /* @__PURE__ */ import_react14.default.createElement(import_Box13.default, { sx: { display: "flex", alignItems: "flex-start", gap: 1 } }, gauges.map((gauge) => /* @__PURE__ */ import_react14.default.createElement(LevelGauge, { key: gauge.kind, gauge, size, keysHref }))), action && /* @__PURE__ */ import_react14.default.createElement(
+    import_Box13.default,
+    {
+      sx: (theme) => ({
+        mt: 2,
+        pt: 2,
+        borderTop: `1px solid ${theme.palette.divider}`
+      })
+    },
+    action
+  ));
+};
+
+// src/index.ts
 init_GenerateKeyDialog();
 init_ManageTeamDialog();
 init_api();