Definitions#

These TypeScript definitions document server validation. check.object rejects unknown fields. Custom functions and refinements specify additional checks.

Imported definitions#

This module has no local contract dependencies.

INPUT_BYTES#

INPUT_BYTES = 65536

MAX_INPUT_BYTES#

MAX_INPUT_BYTES = 4 * 1024 * 1024

MAX_REVIEW_BYTES#

MAX_REVIEW_BYTES = 8 * 1024 * 1024

implementedRuntimes#

implementedRuntimes = ['codex', 'pi'] as const

DecisionOption#

export type DecisionOption = {
    id: string;
    label: string;
    description: string;
};

DecisionQuestion#

export type DecisionQuestion = {
    id: string;
    title: string;
    prompt: string;
    secret: boolean;
    allowText: boolean;
    options: DecisionOption[];
};

Related definitions:

DecisionCreation#

export type DecisionCreation = {
    id: string;
    runId: string;
    runtime: string;
    sessionId: string;
    requestId: string;
    turnId: string;
    itemId: string;
    kind: 'permission' | 'question';
    action: string;
    review: string;
    blocking: boolean;
    expiresAt: number | null;
    questions: DecisionQuestion[];
};

Related definitions:

DecisionStatus#

export type DecisionStatus = 'pending' | 'answered' | 'responded' | 'cancelled' | 'expired';

DecisionView#

export type DecisionView = DecisionCreation & {
    agentId: string;
    status: DecisionStatus;
    createdAt: number;
};

Related definitions:

DecisionSummary#

export type DecisionSummary = Omit<DecisionView, 'review' | 'questions'>;

Related definitions:

DecisionAnswer#

export type DecisionAnswer = {
    questionId: string;
    optionId: string | null;
    text: string | null;
};

RuntimeState#

export type RuntimeState = 'idle' | 'working' | 'waiting-approval' | 'waiting-answer' | 'failed' | 'unavailable' | 'sleeping' | 'waking';

RuntimeSetting#

export type RuntimeSetting = {
    name: string;
    configured: string | null;
    effective: string | null;
};

RuntimeObservation#

export type RuntimeObservation = {
    sessionId: string;
    roomId: string | null;
    runtime: string;
    state: RuntimeState;
    observedAt: number;
    lastActivityAt: number | null;
    historyAvailable: boolean | null;
    historyMode: 'shared' | 'per-room';
    maxInputBytes: number;
    settings: RuntimeSetting[];
    errorMessage: string | null;
};

Related definitions:

NativeRuntimeSummary#

export type NativeRuntimeSummary = Pick<RuntimeObservation, 'observedAt' | 'lastActivityAt' | 'historyAvailable'> & {
    state: RuntimeState | 'stopped';
};

Related definitions:

RuntimeObservationView#

export type RuntimeObservationView = RuntimeObservation & {
    runId: string;
};

Related definitions: