@convex-dev/ai-budget 0.0.2-alpha.4 → 0.0.2-alpha.6

package/dist/client/index.d.ts

@@ -1,4 +1,4 @@
-import type { Expand, FunctionReference } from "convex/server";
+import { type Expand, type FunctionReference, type HttpRouter } from "convex/server";
 import { type GenericId } from "convex/values";
 import { type LanguageModel } from "ai";
 import type { api } from "../component/_generated/api";
@@ -21,22 +21,34 @@ export type Tag = {
     dimension: string;
     value: string;
 };
-/** Fired when a request is admitted over a *soft* limit. */
-export type SoftLimitInfo = {
+/** Common shape for budget-event callbacks. */
+export type BudgetEventInfo = {
     userId: string;
     action?: string;
     tags?: Tag[];
-    requestId: string;
+    requestId?: string;
+    /** soft-cap warnings (onSoftLimit) or approaching-cap notices (onThreshold). */
+    messages: string[];
+    /** rejection code/reason (onLimitReached only). */
+    code?: string;
+    reason?: string;
+};
+/** @deprecated use BudgetEventInfo */
+export type SoftLimitInfo = BudgetEventInfo & {
     warnings: string[];
 };
 export type AIBudgetOptions = {
     defaultModel?: string;
     /**
-     * Called when a soft limit is exceeded (the request is still allowed). Lets
-     * you surface budget warnings even on the languageModel/Agent path, where
-     * they can't be returned. Errors thrown here are swallowed.
+     * A *soft* limit was exceeded (request still allowed). Lets you surface budget
+     * warnings even on the languageModel/Agent path where they can't be returned.
+     * Errors thrown in any of these callbacks are swallowed.
      */
     onSoftLimit?: (info: SoftLimitInfo) => void | Promise<void>;
+    /** Usage crossed a bucket's warnAtPct threshold (approaching a cap). */
+    onThreshold?: (info: BudgetEventInfo) => void | Promise<void>;
+    /** A *hard* limit blocked the request (fires just before chat/model throws). */
+    onLimitReached?: (info: BudgetEventInfo) => void | Promise<void>;
 };
 type RunQueryCtx = {
     runQuery: <Query extends FunctionReference<"query", "internal">>(query: Query, args: Query["_args"]) => Promise<Query["_returnType"]>;
@@ -67,13 +79,39 @@ export type ChatResult = {
     cachedTokens: number;
     /** Soft-limit warnings raised at admission (empty unless a soft cap was hit). */
     warnings: string[];
+    /** Approaching-cap notices (empty unless a warnAtPct threshold was crossed). */
+    notices: string[];
+};
+/** Limits/controls settable on any budget bucket (user, action, or tag). */
+export type BucketLimits = {
+    requestsPerMinute?: number;
+    maxConcurrent?: number;
+    dailySpendLimitNanos?: number;
+    monthlySpendLimitNanos?: number;
+    lifetimeSpendLimitNanos?: number;
+    dailyTokenLimit?: number;
+    monthlyTokenLimit?: number;
+    lifetimeTokenLimit?: number;
+    /** Fire an approaching-limit alert at this fraction of a cap (e.g. 0.8). */
+    warnAtPct?: number;
+    enforcement?: "hard" | "soft";
+    blocked?: boolean;
+};
+/** One-time bump amounts, added on top of a standing cap. */
+export type BumpArgs = {
+    dailyNanos?: number;
+    monthlyNanos?: number;
+    lifetimeNanos?: number;
 };
 export declare class AIBudget {
     component: AIBudgetApi;
     defaultModel: string;
     private onSoftLimit?;
+    private onThreshold?;
+    private onLimitReached?;
     constructor(component: AIBudgetApi, options?: AIBudgetOptions);
-    private fireSoftLimit;
+    private fireBudgetEvents;
+    private fireLimitReached;
     /**
      * One-shot chat through the AI Gateway with tracking + limits.
      * Call from an action. `userId` defaults to the authenticated caller.
@@ -106,8 +144,11 @@ export declare class AIBudget {
     private rerunImpl;
     /** The request audit log, replay, and re-run lineage. */
     get requests(): {
+        /** Filter by userId, or by any {dimension, value} (incl. custom tags). */
         list: (ctx: RunQueryCtx, args?: {
             userId?: string;
+            dimension?: string;
+            value?: string;
             limit?: number;
         }) => Promise<{
             _id: string;
@@ -213,8 +254,8 @@ export declare class AIBudget {
      * generalization of `users`/`actions`. Give it any dimension name (team,
      * project, tenant, customer, env, feature, …) and set caps per value:
      *
-     *   ai.tag("customer").setLimits(ctx, { value: "acme", dailySpendLimitNanos });
-     *   ai.tag("customer").list(ctx);
+     *   ai.tag("customer").setLimits(ctx, { value: "acme", monthlySpendLimitNanos });
+     *   ai.tag("customer").history(ctx, { value: "acme", period: "day" });
      *
      * Attribute a call to it by passing `tags` to `chat`/`languageModel`.
      */
@@ -222,22 +263,33 @@ export declare class AIBudget {
         /** All buckets in this dimension. */
         list: (ctx: RunQueryCtx) => Promise<{
             spendTodayNanos: number;
+            spendThisMonthNanos: number;
             _id: string;
             _creationTime: number;
             requestsPerMinute?: number | undefined;
+            maxConcurrent?: number | undefined;
             dailySpendLimitNanos?: number | undefined;
+            monthlySpendLimitNanos?: number | undefined;
             lifetimeSpendLimitNanos?: number | undefined;
             dailyTokenLimit?: number | undefined;
+            monthlyTokenLimit?: number | undefined;
             lifetimeTokenLimit?: number | undefined;
             blocked?: boolean | undefined;
+            warnAtPct?: number | undefined;
             enforcement?: "hard" | "soft" | undefined;
             dailyBumpNanos?: number | undefined;
+            monthlyBumpNanos?: number | undefined;
             lifetimeBumpNanos?: number | undefined;
             bumpDayStamp?: string | undefined;
+            bumpMonthStamp?: string | undefined;
             tokensToday?: number | undefined;
+            monthStamp?: string | undefined;
+            tokensThisMonth?: number | undefined;
             reservedTodayNanos?: number | undefined;
+            reservedMonthNanos?: number | undefined;
             reservedTotalNanos?: number | undefined;
             reservedTodayTokens?: number | undefined;
+            reservedMonthTokens?: number | undefined;
             reservedTotalTokens?: number | undefined;
             pendingCount?: number | undefined;
             dimension: string;
@@ -252,22 +304,33 @@ export declare class AIBudget {
             value: string;
         }) => Promise<{
             spendTodayNanos: number;
+            spendThisMonthNanos: number;
             _id: string;
             _creationTime: number;
             requestsPerMinute?: number | undefined;
+            maxConcurrent?: number | undefined;
             dailySpendLimitNanos?: number | undefined;
+            monthlySpendLimitNanos?: number | undefined;
             lifetimeSpendLimitNanos?: number | undefined;
             dailyTokenLimit?: number | undefined;
+            monthlyTokenLimit?: number | undefined;
             lifetimeTokenLimit?: number | undefined;
             blocked?: boolean | undefined;
+            warnAtPct?: number | undefined;
             enforcement?: "hard" | "soft" | undefined;
             dailyBumpNanos?: number | undefined;
+            monthlyBumpNanos?: number | undefined;
             lifetimeBumpNanos?: number | undefined;
             bumpDayStamp?: string | undefined;
+            bumpMonthStamp?: string | undefined;
             tokensToday?: number | undefined;
+            monthStamp?: string | undefined;
+            tokensThisMonth?: number | undefined;
             reservedTodayNanos?: number | undefined;
+            reservedMonthNanos?: number | undefined;
             reservedTotalNanos?: number | undefined;
             reservedTodayTokens?: number | undefined;
+            reservedMonthTokens?: number | undefined;
             reservedTotalTokens?: number | undefined;
             pendingCount?: number | undefined;
             dimension: string;
@@ -279,20 +342,50 @@ export declare class AIBudget {
         } | null>;
         setLimits: (ctx: RunMutationCtx, args: {
             value: string;
-            requestsPerMinute?: number;
-            dailySpendLimitNanos?: number;
-            lifetimeSpendLimitNanos?: number;
-            dailyTokenLimit?: number;
-            lifetimeTokenLimit?: number;
-            enforcement?: "hard" | "soft";
-            blocked?: boolean;
-        }) => Promise<null>;
-        /** One-time "approve another $X" bump (daily is today-only). */
+        } & BucketLimits) => Promise<null>;
+        /** One-time "approve another $X" bump (daily/monthly reset with the window). */
         bump: (ctx: RunMutationCtx, args: {
             value: string;
-            dailyNanos?: number;
-            lifetimeNanos?: number;
+        } & BumpArgs) => Promise<null>;
+        /** Manually credit (negative) or debit (positive) this bucket. */
+        adjust: (ctx: RunMutationCtx, args: {
+            value: string;
+        } & {
+            deltaNanos: number;
+            tokens?: number;
+            reason?: string;
         }) => Promise<null>;
+        /** Durable spend history for this bucket (per day or per month). */
+        history: (ctx: RunQueryCtx, args: {
+            value: string;
+        } & {
+            period?: "day" | "month";
+            limit?: number;
+        }) => Promise<{
+            _id: string;
+            _creationTime: number;
+            dimension: string;
+            value: string;
+            period: "day" | "month";
+            stamp: string;
+            spendNanos: number;
+            tokens: number;
+            requests: number;
+        }[]>;
+        /** Manual-adjustment audit log for this bucket. */
+        adjustments: (ctx: RunQueryCtx, args: {
+            value: string;
+        } & {
+            limit?: number;
+        }) => Promise<{
+            _id: string;
+            _creationTime: number;
+            tokens?: number | undefined;
+            reason?: string | undefined;
+            dimension: string;
+            value: string;
+            deltaNanos: number;
+        }[]>;
         /** Delete the bucket (for "user", also its request rows). */
         delete: (ctx: RunMutationCtx, args: {
             value: string;
@@ -301,26 +394,39 @@ export declare class AIBudget {
             done: boolean;
         }>;
     };
+    private dimensionApi;
     /** Per-user budgets and controls — sugar over the "user" dimension. */
     get users(): {
+        /** All buckets in this dimension. */
         list: (ctx: RunQueryCtx) => Promise<{
             spendTodayNanos: number;
+            spendThisMonthNanos: number;
             _id: string;
             _creationTime: number;
             requestsPerMinute?: number | undefined;
+            maxConcurrent?: number | undefined;
             dailySpendLimitNanos?: number | undefined;
+            monthlySpendLimitNanos?: number | undefined;
             lifetimeSpendLimitNanos?: number | undefined;
             dailyTokenLimit?: number | undefined;
+            monthlyTokenLimit?: number | undefined;
             lifetimeTokenLimit?: number | undefined;
             blocked?: boolean | undefined;
+            warnAtPct?: number | undefined;
             enforcement?: "hard" | "soft" | undefined;
             dailyBumpNanos?: number | undefined;
+            monthlyBumpNanos?: number | undefined;
             lifetimeBumpNanos?: number | undefined;
             bumpDayStamp?: string | undefined;
+            bumpMonthStamp?: string | undefined;
             tokensToday?: number | undefined;
+            monthStamp?: string | undefined;
+            tokensThisMonth?: number | undefined;
             reservedTodayNanos?: number | undefined;
+            reservedMonthNanos?: number | undefined;
             reservedTotalNanos?: number | undefined;
             reservedTodayTokens?: number | undefined;
+            reservedMonthTokens?: number | undefined;
             reservedTotalTokens?: number | undefined;
             pendingCount?: number | undefined;
             dimension: string;
@@ -330,23 +436,94 @@ export declare class AIBudget {
             totalTokens: number;
             dayStamp: string;
         }[]>;
+        /** One bucket's limits + spend (null if it has none yet). */
+        get: (ctx: RunQueryCtx, args: {
+            userId: string;
+        }) => Promise<{
+            spendTodayNanos: number;
+            spendThisMonthNanos: number;
+            _id: string;
+            _creationTime: number;
+            requestsPerMinute?: number | undefined;
+            maxConcurrent?: number | undefined;
+            dailySpendLimitNanos?: number | undefined;
+            monthlySpendLimitNanos?: number | undefined;
+            lifetimeSpendLimitNanos?: number | undefined;
+            dailyTokenLimit?: number | undefined;
+            monthlyTokenLimit?: number | undefined;
+            lifetimeTokenLimit?: number | undefined;
+            blocked?: boolean | undefined;
+            warnAtPct?: number | undefined;
+            enforcement?: "hard" | "soft" | undefined;
+            dailyBumpNanos?: number | undefined;
+            monthlyBumpNanos?: number | undefined;
+            lifetimeBumpNanos?: number | undefined;
+            bumpDayStamp?: string | undefined;
+            bumpMonthStamp?: string | undefined;
+            tokensToday?: number | undefined;
+            monthStamp?: string | undefined;
+            tokensThisMonth?: number | undefined;
+            reservedTodayNanos?: number | undefined;
+            reservedMonthNanos?: number | undefined;
+            reservedTotalNanos?: number | undefined;
+            reservedTodayTokens?: number | undefined;
+            reservedMonthTokens?: number | undefined;
+            reservedTotalTokens?: number | undefined;
+            pendingCount?: number | undefined;
+            dimension: string;
+            value: string;
+            totalSpendNanos: number;
+            totalRequests: number;
+            totalTokens: number;
+            dayStamp: string;
+        } | null>;
         setLimits: (ctx: RunMutationCtx, args: {
             userId: string;
-            requestsPerMinute?: number;
-            dailySpendLimitNanos?: number;
-            lifetimeSpendLimitNanos?: number;
-            dailyTokenLimit?: number;
-            lifetimeTokenLimit?: number;
-            enforcement?: "hard" | "soft";
-            blocked?: boolean;
-        }) => Promise<null>;
-        /** One-time "approve another $X" bump (daily is today-only). */
+        } & BucketLimits) => Promise<null>;
+        /** One-time "approve another $X" bump (daily/monthly reset with the window). */
         bump: (ctx: RunMutationCtx, args: {
             userId: string;
-            dailyNanos?: number;
-            lifetimeNanos?: number;
+        } & BumpArgs) => Promise<null>;
+        /** Manually credit (negative) or debit (positive) this bucket. */
+        adjust: (ctx: RunMutationCtx, args: {
+            userId: string;
+        } & {
+            deltaNanos: number;
+            tokens?: number;
+            reason?: string;
         }) => Promise<null>;
-        /** Delete a user and all their request rows. */
+        /** Durable spend history for this bucket (per day or per month). */
+        history: (ctx: RunQueryCtx, args: {
+            userId: string;
+        } & {
+            period?: "day" | "month";
+            limit?: number;
+        }) => Promise<{
+            _id: string;
+            _creationTime: number;
+            dimension: string;
+            value: string;
+            period: "day" | "month";
+            stamp: string;
+            spendNanos: number;
+            tokens: number;
+            requests: number;
+        }[]>;
+        /** Manual-adjustment audit log for this bucket. */
+        adjustments: (ctx: RunQueryCtx, args: {
+            userId: string;
+        } & {
+            limit?: number;
+        }) => Promise<{
+            _id: string;
+            _creationTime: number;
+            tokens?: number | undefined;
+            reason?: string | undefined;
+            dimension: string;
+            value: string;
+            deltaNanos: number;
+        }[]>;
+        /** Delete the bucket (for "user", also its request rows). */
         delete: (ctx: RunMutationCtx, args: {
             userId: string;
         }) => Promise<{
@@ -356,24 +533,36 @@ export declare class AIBudget {
     };
     /** Per-action (per-feature) budgets — sugar over the "action" dimension. */
     get actions(): {
+        /** All buckets in this dimension. */
         list: (ctx: RunQueryCtx) => Promise<{
             spendTodayNanos: number;
+            spendThisMonthNanos: number;
             _id: string;
             _creationTime: number;
             requestsPerMinute?: number | undefined;
+            maxConcurrent?: number | undefined;
             dailySpendLimitNanos?: number | undefined;
+            monthlySpendLimitNanos?: number | undefined;
             lifetimeSpendLimitNanos?: number | undefined;
             dailyTokenLimit?: number | undefined;
+            monthlyTokenLimit?: number | undefined;
             lifetimeTokenLimit?: number | undefined;
             blocked?: boolean | undefined;
+            warnAtPct?: number | undefined;
             enforcement?: "hard" | "soft" | undefined;
             dailyBumpNanos?: number | undefined;
+            monthlyBumpNanos?: number | undefined;
             lifetimeBumpNanos?: number | undefined;
             bumpDayStamp?: string | undefined;
+            bumpMonthStamp?: string | undefined;
             tokensToday?: number | undefined;
+            monthStamp?: string | undefined;
+            tokensThisMonth?: number | undefined;
             reservedTodayNanos?: number | undefined;
+            reservedMonthNanos?: number | undefined;
             reservedTotalNanos?: number | undefined;
             reservedTodayTokens?: number | undefined;
+            reservedMonthTokens?: number | undefined;
             reservedTotalTokens?: number | undefined;
             pendingCount?: number | undefined;
             dimension: string;
@@ -383,23 +572,102 @@ export declare class AIBudget {
             totalTokens: number;
             dayStamp: string;
         }[]>;
+        /** One bucket's limits + spend (null if it has none yet). */
+        get: (ctx: RunQueryCtx, args: {
+            name: string;
+        }) => Promise<{
+            spendTodayNanos: number;
+            spendThisMonthNanos: number;
+            _id: string;
+            _creationTime: number;
+            requestsPerMinute?: number | undefined;
+            maxConcurrent?: number | undefined;
+            dailySpendLimitNanos?: number | undefined;
+            monthlySpendLimitNanos?: number | undefined;
+            lifetimeSpendLimitNanos?: number | undefined;
+            dailyTokenLimit?: number | undefined;
+            monthlyTokenLimit?: number | undefined;
+            lifetimeTokenLimit?: number | undefined;
+            blocked?: boolean | undefined;
+            warnAtPct?: number | undefined;
+            enforcement?: "hard" | "soft" | undefined;
+            dailyBumpNanos?: number | undefined;
+            monthlyBumpNanos?: number | undefined;
+            lifetimeBumpNanos?: number | undefined;
+            bumpDayStamp?: string | undefined;
+            bumpMonthStamp?: string | undefined;
+            tokensToday?: number | undefined;
+            monthStamp?: string | undefined;
+            tokensThisMonth?: number | undefined;
+            reservedTodayNanos?: number | undefined;
+            reservedMonthNanos?: number | undefined;
+            reservedTotalNanos?: number | undefined;
+            reservedTodayTokens?: number | undefined;
+            reservedMonthTokens?: number | undefined;
+            reservedTotalTokens?: number | undefined;
+            pendingCount?: number | undefined;
+            dimension: string;
+            value: string;
+            totalSpendNanos: number;
+            totalRequests: number;
+            totalTokens: number;
+            dayStamp: string;
+        } | null>;
         setLimits: (ctx: RunMutationCtx, args: {
             name: string;
-            dailySpendLimitNanos?: number;
-            lifetimeSpendLimitNanos?: number;
-            dailyTokenLimit?: number;
-            lifetimeTokenLimit?: number;
-            enforcement?: "hard" | "soft";
-            /** Hard-block this action (was `disabled`). */
-            blocked?: boolean;
-        }) => Promise<null>;
+        } & BucketLimits) => Promise<null>;
+        /** One-time "approve another $X" bump (daily/monthly reset with the window). */
         bump: (ctx: RunMutationCtx, args: {
             name: string;
-            dailyNanos?: number;
-            lifetimeNanos?: number;
+        } & BumpArgs) => Promise<null>;
+        /** Manually credit (negative) or debit (positive) this bucket. */
+        adjust: (ctx: RunMutationCtx, args: {
+            name: string;
+        } & {
+            deltaNanos: number;
+            tokens?: number;
+            reason?: string;
         }) => Promise<null>;
+        /** Durable spend history for this bucket (per day or per month). */
+        history: (ctx: RunQueryCtx, args: {
+            name: string;
+        } & {
+            period?: "day" | "month";
+            limit?: number;
+        }) => Promise<{
+            _id: string;
+            _creationTime: number;
+            dimension: string;
+            value: string;
+            period: "day" | "month";
+            stamp: string;
+            spendNanos: number;
+            tokens: number;
+            requests: number;
+        }[]>;
+        /** Manual-adjustment audit log for this bucket. */
+        adjustments: (ctx: RunQueryCtx, args: {
+            name: string;
+        } & {
+            limit?: number;
+        }) => Promise<{
+            _id: string;
+            _creationTime: number;
+            tokens?: number | undefined;
+            reason?: string | undefined;
+            dimension: string;
+            value: string;
+            deltaNanos: number;
+        }[]>;
+        /** Delete the bucket (for "user", also its request rows). */
+        delete: (ctx: RunMutationCtx, args: {
+            name: string;
+        }) => Promise<{
+            deletedThisBatch: number;
+            done: boolean;
+        }>;
     };
-    /** The deployment-wide budget and retention config. */
+    /** The deployment-wide budget, alerts, and retention config. */
     get global(): {
         /** Limits + spend today/total. */
         status: (ctx: RunQueryCtx) => Promise<{
@@ -408,6 +676,8 @@ export declare class AIBudget {
             enforcement: "hard" | "soft";
             spentTodayNanos: number;
             spentTotalNanos: number;
+            retentionMs: number | null;
+            defaultWarnAtPct: number | null;
         }>;
         /** A killswitch spend cap across all users/actions (enforced approximately). */
         setLimits: (ctx: RunMutationCtx, args: {
@@ -419,6 +689,10 @@ export declare class AIBudget {
             dailyNanos?: number;
             lifetimeNanos?: number;
         }) => Promise<null>;
+        /** Default approaching-limit alert threshold (fraction of a cap, e.g. 0.8). */
+        setAlertDefaults: (ctx: RunMutationCtx, args: {
+            warnAtPct?: number;
+        }) => Promise<null>;
         /** Request-row retention window in ms (default 1h; 0 disables). */
         setRetention: (ctx: RunMutationCtx, args: {
             retentionMs: number;
@@ -442,6 +716,7 @@ export declare class AIBudget {
             [x: string]: {
                 input: number;
                 output: number;
+                cached?: number | undefined;
                 overridden: boolean;
             };
         }>;
@@ -449,8 +724,36 @@ export declare class AIBudget {
             model: string;
             inputNanosPerMTok: number;
             outputNanosPerMTok: number;
+            /** Cache-read rate; defaults to a discount off input if omitted. */
+            cachedNanosPerMTok?: number;
         }) => Promise<null>;
     };
+    /**
+     * Mount the built-in admin dashboard on your app's HTTP router with one call.
+     * Serves a self-contained HTML dashboard (buckets, requests, usage history,
+     * settings) plus a small JSON API, all backed by the component — no extra
+     * queries to write.
+     *
+     *   // convex/http.ts
+     *   import { httpRouter } from "convex/server";
+     *   const http = httpRouter();
+     *   ai.registerRoutes(http, { authorize: async (ctx) =>
+     *     (await ctx.auth.getUserIdentity())?.role === "admin" });
+     *   export default http;
+     *
+     * It then lives at `https://<deployment>.convex.site/aibudget`.
+     *
+     * SECURITY: the endpoint is public on the internet. You MUST gate it — either
+     * pass `authorize` (recommended: check the caller is a deployment admin) or
+     * set the `AI_BUDGET_DASHBOARD_TOKEN` env var (a bearer token / `?token=`).
+     * With neither, every route returns 401.
+     */
+    registerRoutes(http: HttpRouter, opts?: {
+        /** Mount path (default "/aibudget"). */
+        path?: string;
+        /** Return true to allow the request. Runs on the HTML page and every API call. */
+        authorize?: (ctx: any, request: Request) => boolean | Promise<boolean>;
+    }): void;
 }
 /** @deprecated Renamed to `AIBudget`. */
 export declare const WorryFreeAI: typeof AIBudget;