framework/dist/dashboard/quota.d.ts

The (AI) Framework: turnkey, zero-config AI orchestration that wraps a coding-agent CLI (Claude Code) as a black box and takes you from an idea to a running app. Vite for AI.

import { QuotaPoller } from '../quota-poller.js';
import { type QuotaBoundaryStatus } from '../quota-boundary.js';
import { type DriverQuotaUnavailableReason, type DriverQuotaWindow } from '../driver/index.js';
/**
 * Everything the dashboard needs to draw the usage panel (#533): the account's
 * own windows, and where they stand against the quota boundary (#879).
 */
export interface QuotaView {
    /**
     * The account's quota windows as the agent reported them (session, week, and
     * a week per model). Empty when we have no reading at all — check
     * {@link unavailable} before reading that as "nothing used".
     */
    windows: DriverQuotaWindow[];
    /** When the reading was taken, epoch ms. Absent when there has never been one. */
    readAt?: number;
    /**
     * Why there is no reading, when there isn't one. Present alongside stale
     * `windows` too: the last good reading is kept through a blip, and this says
     * the newest attempt failed, so the UI can mark it stale rather than blank it.
     */
    unavailable?: DriverQuotaUnavailableReason;
    /**
     * Where the account stands against its boundary (#879). Absent when there is no
     * reading, or when the week's reset could not be placed — which is "we don't
     * know", not "nothing is allowed".
     */
    boundary?: QuotaBoundaryStatus;
}
/** Where a dashboard reads the quota from. */
export interface QuotaSource {
    read(): Promise<QuotaView>;
    /**
     * Where the account stands once the model the work will run on is named (#1619).
     *
     * A different question from {@link QuotaView.boundary}, and deliberately a second method rather
     * than an argument to {@link QuotaSource.read}: the panel's boundary is about the account, this
     * one is about one impending run, and a shared entry point that answered both would leave the
     * panel's call looking like it had simply forgotten to pass a model — which is exactly how the
     * model's own week came to be filtered out of every gate for a year.
     *
     * Both are measured off the same reading and the same slider, so #960's one-source promise
     * holds: they cannot disagree about the account, only about a question the other never asked.
     *
     * No model given is the account's week alone. That is not a shortcut: with no model preference
     * set the driver picks, and a window we cannot name the model of must not stop work (#879).
     */
    boundaryFor(model?: string): Promise<QuotaBoundaryStatus | undefined>;
    /** Stop any polling behind it. */
    stop(): void;
}
/**
 * A {@link QuotaSource} backed by a live poller.
 *
 * Both questions are measured per call rather than captured: the boundary moves with the clock,
 * so a cached one would be stale the moment the week's day rolls over. Neither costs a reading —
 * the poller's last good windows are measured again, so asking per project is free.
 *
 * The panel's own boundary names no model on purpose: the bar is about the account, and a model's
 * own week only narrows the gate for a run that has chosen one (#879/#1619).
 */
export declare function pollerQuotaSource(poller: QuotaPoller, now?: () => number, 
/** The user's slider position, read per call so moving it takes effect without a restart (#960). */
limitOffset?: () => number | Promise<number>): QuotaSource;
/**
 * The daemon's own quota source: it polls for the whole life of the dashboard,
 * not just during an agent, because the panel has to show where the account stands
 * even when nothing is running.
 *
 * Separate from the per-agent guard on purpose — that one exists to pause an agent
 * and dies with it, this one exists to draw a bar.
 */
export declare function defaultQuotaSource(env?: NodeJS.ProcessEnv): QuotaSource;
//# sourceMappingURL=quota.d.ts.map