mirror of
https://github.com/wu736139669/hapi.git
synced 2026-11-07 01:21:37 +00:00
* feat(shared): derive Claude model choices from the CLI catalog The choices are the rows of the claude CLI's own /model picker, in its order and with its display names. The stored value is what claude --model receives: an alias is resolved again each time the session's claude process starts, a full id stays on its model, so following and staying need no new field. Effort support is read per model so a model switch can drop an effort level the next model does not offer. * feat(cli): discover Claude models from the CLI's initialize response A machine RPC starts claude in stream-json mode, sends only an initialize control request and reads the models it reports, so no turn runs and no transcript is written. claude --print runs a directory's project hooks and .mcp.json servers without a trust prompt, so the probe starts from the home directory with user settings only, no MCP servers and hooks disabled. Successful catalogs are cached per claude executable for five minutes and concurrent requests share one probe; failures are not cached. * feat(hub): expose the Claude model catalog per machine GET /machines/:id/claude-models forwards to the runner's listClaudeModels RPC. A runner that predates the handler answers with the stable rpc_target_missing code so clients can keep their built-in list. * feat(web): offer the machine's Claude models in the model pickers The composer and the create-session form list the rows the machine's claude CLI shows in its own /model picker, as it shows them. Built-in presets the catalog does not list remain selectable after it. Until the catalog arrives, or on a runner without discovery, the built-in presets are shown as before. A saved Claude model is no longer reset to Default when the built-in list lacks it; the create-session form keeps it and marks it as no longer listed when the catalog dropped it. * feat(hub,web): keep Claude effort within what the selected model offers For Claude sessions the model endpoint accepts an optional effort, so a model switch and the effort it keeps reach the session as one config change. Other flavors are refused: Pi, for one, commits the model before its thinking level. When the machine's catalog says the next Claude model does not offer the current effort, the composer clears it in that same request. The create-session form drops such an effort however the model was set, including a restored preference or draft. Effort choices in both places narrow to the selected model's levels; without a catalog every level stays available as before. * fix(web): retry Claude model discovery after a failed probe The machine answers a failed probe with success:false over HTTP 200. The query cached that as an answer for its stale time, so a user who signed in and reopened a picker within a minute still saw only the built-in models. A failed probe is now a query error, which is not kept, and the next picker to mount asks the machine again. * fix(web): list only the Claude CLI's models once its catalog is known The built-in presets were kept after the catalog so that a partial list could not hide Opus. The catalog is the CLI's own /model list, though, not a partial one, and the presets added entries the CLI does not show (Sonnet 1M, Opus 1M, Fable 1M). With a catalog the list is now exactly its rows; a saved model it does not list stays as the current model, and New Session marks it as no longer listed. Without a catalog the built-in presets are shown as before. * fix(shared,web): list earlier Claude versions under Other models Claude Code's model sheet shows each family's newest model first and every earlier version under an "Other models" heading. The CLI's catalog lists models in that order but does not say where the split is, so the first row of each family is taken as its newest and later rows of the same family as earlier versions. The composer's model list and New Session's model select now show the same two groups, keeping the CLI order within each. Nothing is folded: every row stays one click away, as it does in Claude Code. * test(web): pin that Claude 1M variants come from the CLI catalog Claude Code 2.1.105, 2.1.200, 2.1.240 and 2.1.274 list a 1M choice as its own catalog row (opus[1m], claude-fable-5[1m]); 2.1.303 and 2.1.310 list none, and on 2.1.310 opus and sonnet run with a 1M context window. The catalog-only list therefore offers a 1M variant exactly when the CLI does. Pin that and record why the built-in [1m] presets are not appended.
1093 lines
34 KiB
TypeScript
1093 lines
34 KiB
TypeScript
import { z } from 'zod'
|
|
import {
|
|
AttachmentMetadataSchema,
|
|
CodexCollaborationModeSchema,
|
|
CopilotAgentModeSchema,
|
|
DecryptedMessageSchema,
|
|
MachineSchema,
|
|
PermissionModeSchema,
|
|
SessionSchema
|
|
} from './schemas'
|
|
import { AgentFlavorSchema } from './modes'
|
|
import type {
|
|
DecryptedMessage,
|
|
Machine,
|
|
Session
|
|
} from './schemas'
|
|
import type { SessionSummary } from './sessionSummary'
|
|
|
|
export const CreateOrLoadMachineRequestSchema = z.object({
|
|
id: z.string().min(1),
|
|
metadata: z.unknown(),
|
|
runnerState: z.unknown().nullable().optional()
|
|
})
|
|
|
|
export type CreateOrLoadMachineRequest = z.infer<typeof CreateOrLoadMachineRequestSchema>
|
|
|
|
export const CreateOrLoadSessionRequestSchema = z.object({
|
|
id: z.string().uuid().optional(),
|
|
/**
|
|
* When true with `id`, bind a hub-preallocated stub (overwrite tag/metadata)
|
|
* instead of create/getOrCreate. Rejects non-stub rows (#1911 adopt).
|
|
*/
|
|
adopt: z.boolean().optional(),
|
|
tag: z.string().min(1),
|
|
metadata: z.unknown(),
|
|
agentState: z.unknown().nullable().optional(),
|
|
model: z.string().optional(),
|
|
modelReasoningEffort: z.string().optional(),
|
|
effort: z.string().optional(),
|
|
machine: CreateOrLoadMachineRequestSchema.optional()
|
|
}).superRefine((value, ctx) => {
|
|
if (value.adopt === true && !value.id) {
|
|
ctx.addIssue({
|
|
code: z.ZodIssueCode.custom,
|
|
message: 'adopt requires id',
|
|
path: ['id'],
|
|
})
|
|
}
|
|
})
|
|
|
|
export type CreateOrLoadSessionRequest = z.infer<typeof CreateOrLoadSessionRequestSchema>
|
|
|
|
export const CliMessagesResponseSchema = z.object({
|
|
messages: z.array(z.object({
|
|
id: z.string(),
|
|
seq: z.number(),
|
|
createdAt: z.number(),
|
|
localId: z.string().nullable().optional(),
|
|
content: z.unknown()
|
|
}))
|
|
})
|
|
|
|
export type CliMessagesResponse = z.infer<typeof CliMessagesResponseSchema>
|
|
|
|
export const CreateSessionResponseSchema = z.object({
|
|
session: SessionSchema,
|
|
/** Hub opt-in for AGENT_NOTIFY_SUMMARY prompt injection (default off when omitted). */
|
|
sessionSummaryContract: z.boolean().optional()
|
|
})
|
|
|
|
export type CreateSessionResponse = z.infer<typeof CreateSessionResponseSchema>
|
|
|
|
export const HubSettingsResponseSchema = z.object({
|
|
sessionSummaryContract: z.boolean(),
|
|
/** Show compact AGENT_NOTIFY_SUMMARY in chat (default off / hide). */
|
|
sessionSummaryInChat: z.boolean()
|
|
})
|
|
|
|
export type HubSettingsResponse = z.infer<typeof HubSettingsResponseSchema>
|
|
|
|
export const UpdateHubSettingsRequestSchema = z
|
|
.object({
|
|
sessionSummaryContract: z.boolean().optional(),
|
|
sessionSummaryInChat: z.boolean().optional()
|
|
})
|
|
.refine(
|
|
(data) => data.sessionSummaryContract !== undefined || data.sessionSummaryInChat !== undefined,
|
|
{ message: 'At least one hub setting field is required' }
|
|
)
|
|
|
|
export type UpdateHubSettingsRequest = z.infer<typeof UpdateHubSettingsRequestSchema>
|
|
|
|
export const CreateMachineResponseSchema = z.object({
|
|
machine: MachineSchema
|
|
})
|
|
|
|
export type CreateMachineResponse = z.infer<typeof CreateMachineResponseSchema>
|
|
|
|
export const GetSessionResponseSchema = CreateSessionResponseSchema
|
|
export type GetSessionResponse = CreateSessionResponse
|
|
|
|
export const ClearOpencodeSessionResponseSchema = z.object({
|
|
ok: z.literal(true),
|
|
sessionId: z.string()
|
|
})
|
|
export type ClearOpencodeSessionResponse = z.infer<typeof ClearOpencodeSessionResponseSchema>
|
|
|
|
export const ClearOpencodeSessionCallbackRequestSchema = z.object({
|
|
replacementSessionId: z.string()
|
|
})
|
|
export type ClearOpencodeSessionCallbackRequest = z.infer<typeof ClearOpencodeSessionCallbackRequestSchema>
|
|
|
|
export type AuthResponse = {
|
|
token: string
|
|
user: {
|
|
id: number
|
|
username?: string
|
|
firstName?: string
|
|
lastName?: string
|
|
}
|
|
}
|
|
|
|
export type SessionsResponse = { sessions: SessionSummary[] }
|
|
export type SessionResponse = { session: Session }
|
|
export type MessagesResponse = {
|
|
messages: DecryptedMessage[]
|
|
page: {
|
|
direction: 'latest' | 'before' | 'after'
|
|
limit: number
|
|
epoch: number
|
|
reset: boolean
|
|
nextBeforeSeq: number | null
|
|
nextBeforeAt: number | null
|
|
nextAfterSeq: number | null
|
|
nextAfterAt: number | null
|
|
snapshotHeadSeq: number | null
|
|
snapshotHeadAt: number | null
|
|
hasMore: boolean
|
|
}
|
|
}
|
|
|
|
export type MachinesResponse = { machines: Machine[] }
|
|
|
|
export type SpawnResponse =
|
|
| { type: 'success'; sessionId: string }
|
|
| {
|
|
type: 'error'
|
|
message: string
|
|
code?: 'agent_unavailable' | 'runner_upgrade_required' | 'outside_workspace_roots'
|
|
agent?: z.infer<typeof AgentFlavorSchema>
|
|
}
|
|
|
|
export const SessionPermissionModeRequestSchema = z.object({
|
|
mode: PermissionModeSchema
|
|
})
|
|
|
|
export type SessionPermissionModeRequest = z.infer<typeof SessionPermissionModeRequestSchema>
|
|
|
|
export const ResumeSessionRequestSchema = z.object({
|
|
permissionMode: PermissionModeSchema.optional()
|
|
})
|
|
|
|
export type ResumeSessionRequest = z.infer<typeof ResumeSessionRequestSchema>
|
|
|
|
export const ReopenSessionResponseSchema = z.object({
|
|
ok: z.literal(true),
|
|
sessionId: z.string(),
|
|
resumed: z.boolean(),
|
|
cursorSessionProtocol: z.enum(['acp', 'stream-json']).optional()
|
|
})
|
|
|
|
export type ReopenSessionResponse = z.infer<typeof ReopenSessionResponseSchema>
|
|
|
|
export const ReopenSessionMissingMetadataResponseSchema = z.object({
|
|
error: z.string(),
|
|
missing: z.array(z.string()).nonempty()
|
|
})
|
|
|
|
export type ReopenSessionMissingMetadataResponse = z.infer<typeof ReopenSessionMissingMetadataResponseSchema>
|
|
|
|
export const CursorChatStoreStatusSchema = z.object({
|
|
onDisk: z.boolean(),
|
|
store: z.enum(['legacy', 'acp']).nullable()
|
|
})
|
|
|
|
export type CursorChatStoreStatus = z.infer<typeof CursorChatStoreStatusSchema>
|
|
|
|
export const CodexImportedMessageSchema = z.union([
|
|
z.object({
|
|
role: z.literal('user'),
|
|
content: z.object({ type: z.literal('text'), text: z.string() }),
|
|
meta: z.object({ sentFrom: z.literal('cli') })
|
|
}),
|
|
z.object({
|
|
role: z.literal('agent'),
|
|
content: z.object({ type: z.literal('codex'), data: z.unknown() }),
|
|
meta: z.object({ sentFrom: z.literal('cli') })
|
|
}),
|
|
z.object({
|
|
role: z.literal('agent'),
|
|
content: z.object({ type: z.literal('event'), data: z.unknown() }),
|
|
meta: z.object({ sentFrom: z.literal('cli') })
|
|
})
|
|
])
|
|
|
|
export const CodexLocalSessionSummarySchema = z.object({
|
|
id: z.string().min(1),
|
|
title: z.string(),
|
|
lastUserMessage: z.string().nullable().optional(),
|
|
cwd: z.string().nullable().optional(),
|
|
file: z.string().min(1),
|
|
modifiedAt: z.number(),
|
|
originator: z.string().nullable().optional(),
|
|
cliVersion: z.string().nullable().optional(),
|
|
source: z.string().nullable().optional(),
|
|
threadSource: z.string().nullable().optional(),
|
|
forkedFromId: z.string().nullable().optional()
|
|
})
|
|
|
|
export const CodexLocalSessionWithMessagesSchema = CodexLocalSessionSummarySchema.extend({
|
|
messages: z.array(CodexImportedMessageSchema)
|
|
})
|
|
|
|
export const ListCodexSessionsRpcRequestSchema = z.object({
|
|
cwd: z.string().nullable().optional(),
|
|
sessionIds: z.array(z.string().min(1)).optional()
|
|
})
|
|
|
|
export const ListCodexSessionsRpcResponseSchema = z.union([
|
|
z.object({ success: z.literal(true), sessions: z.array(z.union([CodexLocalSessionWithMessagesSchema, CodexLocalSessionSummarySchema])) }),
|
|
z.object({ success: z.literal(false), error: z.string() })
|
|
])
|
|
|
|
export const ArchiveCodexSessionRpcRequestSchema = z.object({ sessionId: z.string().min(1) })
|
|
export const ArchiveCodexSessionRpcResponseSchema = z.union([
|
|
z.object({ success: z.literal(true), archivedPath: z.string() }),
|
|
z.object({ success: z.literal(false), error: z.string() })
|
|
])
|
|
|
|
export type ListCodexSessionsRpcRequest = z.infer<typeof ListCodexSessionsRpcRequestSchema>
|
|
export type ListCodexSessionsRpcResponse = z.infer<typeof ListCodexSessionsRpcResponseSchema>
|
|
export type ArchiveCodexSessionRpcRequest = z.infer<typeof ArchiveCodexSessionRpcRequestSchema>
|
|
export type ArchiveCodexSessionRpcResponse = z.infer<typeof ArchiveCodexSessionRpcResponseSchema>
|
|
|
|
export const PiImportedMessageContentSchema = CodexImportedMessageSchema
|
|
|
|
export const PiImportedMessageSchema = z.object({
|
|
localId: z.string().min(1),
|
|
entryId: z.string().min(1),
|
|
parentEntryId: z.string().nullable().optional(),
|
|
createdAt: z.number(),
|
|
content: PiImportedMessageContentSchema
|
|
})
|
|
|
|
export const PiLocalSessionSummarySchema = z.object({
|
|
id: z.string().min(1),
|
|
title: z.string(),
|
|
lastUserMessage: z.string().nullable().optional(),
|
|
cwd: z.string().nullable().optional(),
|
|
file: z.string().min(1),
|
|
modifiedAt: z.number(),
|
|
model: z.string().nullable().optional(),
|
|
thinkingLevel: z.string().nullable().optional(),
|
|
leafEntryId: z.string().nullable().optional(),
|
|
messageCount: z.number().int().nonnegative()
|
|
})
|
|
|
|
export const PiLocalSessionWithMessagesSchema = PiLocalSessionSummarySchema.extend({
|
|
messages: z.array(PiImportedMessageSchema),
|
|
activeEntryIds: z.array(z.string().min(1))
|
|
})
|
|
|
|
export const ListPiSessionsRpcRequestSchema = z.object({
|
|
cwd: z.string().nullable().optional(),
|
|
sessionIds: z.array(z.string().min(1)).optional()
|
|
})
|
|
|
|
export const ListPiSessionsRpcResponseSchema = z.union([
|
|
z.object({ success: z.literal(true), sessions: z.array(z.union([PiLocalSessionWithMessagesSchema, PiLocalSessionSummarySchema])) }),
|
|
z.object({ success: z.literal(false), error: z.string() })
|
|
])
|
|
|
|
export type PiImportedMessageContent = z.infer<typeof PiImportedMessageContentSchema>
|
|
export type PiImportedMessage = z.infer<typeof PiImportedMessageSchema>
|
|
export type PiLocalSessionSummary = z.infer<typeof PiLocalSessionSummarySchema>
|
|
export type PiLocalSessionWithMessages = z.infer<typeof PiLocalSessionWithMessagesSchema>
|
|
export type ListPiSessionsRpcRequest = z.infer<typeof ListPiSessionsRpcRequestSchema>
|
|
export type ListPiSessionsRpcResponse = z.infer<typeof ListPiSessionsRpcResponseSchema>
|
|
|
|
export const SessionCollaborationModeRequestSchema = z.object({
|
|
mode: CodexCollaborationModeSchema
|
|
})
|
|
|
|
export type SessionCollaborationModeRequest = z.infer<typeof SessionCollaborationModeRequestSchema>
|
|
|
|
export const SessionCopilotAgentModeRequestSchema = z.object({
|
|
mode: CopilotAgentModeSchema
|
|
})
|
|
|
|
export type SessionCopilotAgentModeRequest = z.infer<typeof SessionCopilotAgentModeRequestSchema>
|
|
|
|
export const SessionModelRequestSchema = z.object({
|
|
model: z.union([
|
|
z.string().trim().min(1),
|
|
z.object({
|
|
provider: z.string().trim().min(1),
|
|
modelId: z.string().trim().min(1),
|
|
}),
|
|
]).nullable(),
|
|
/** Effort to apply together with the model, e.g. cleared when the new model does not offer it. */
|
|
effort: z.string().trim().min(1).nullable().optional()
|
|
})
|
|
|
|
export type SessionModelRequest = z.infer<typeof SessionModelRequestSchema>
|
|
|
|
export const SessionModelReasoningEffortRequestSchema = z.object({
|
|
modelReasoningEffort: z.string().trim().min(1).nullable()
|
|
})
|
|
|
|
export type SessionModelReasoningEffortRequest = z.infer<typeof SessionModelReasoningEffortRequestSchema>
|
|
|
|
export const SessionEffortRequestSchema = z.object({
|
|
effort: z.string().trim().min(1).nullable()
|
|
})
|
|
|
|
export type SessionEffortRequest = z.infer<typeof SessionEffortRequestSchema>
|
|
|
|
// Fast mode is an explicit two-way choice. `'standard'` (not `null`) is the
|
|
// stored sentinel for an explicit Fast-off so it stays distinct from
|
|
// "untouched" and survives restart/resume. Reject anything else so stray tier
|
|
// strings are never forwarded to the Codex app-server.
|
|
export const SessionServiceTierRequestSchema = z.object({
|
|
serviceTier: z.enum(['fast', 'standard'])
|
|
})
|
|
|
|
export type SessionServiceTierRequest = z.infer<typeof SessionServiceTierRequestSchema>
|
|
|
|
export const RenameSessionRequestSchema = z.object({
|
|
name: z.string().min(1).max(255)
|
|
})
|
|
|
|
export type RenameSessionRequest = z.infer<typeof RenameSessionRequestSchema>
|
|
|
|
export const UpdateSessionSummaryRequestSchema = z.object({
|
|
text: z.string().trim().min(1).max(255)
|
|
})
|
|
|
|
export type UpdateSessionSummaryRequest = z.infer<typeof UpdateSessionSummaryRequestSchema>
|
|
|
|
export const SessionTitleSuggestionResponseSchema = z.object({
|
|
title: z.string().min(1).max(255)
|
|
})
|
|
|
|
export type SessionTitleSuggestionResponse = z.infer<typeof SessionTitleSuggestionResponseSchema>
|
|
|
|
export const SetSessionPinnedRequestSchema = z.object({
|
|
mode: z.enum(['none', 'project', 'global'])
|
|
})
|
|
|
|
export type SetSessionPinnedRequest = z.infer<typeof SetSessionPinnedRequestSchema>
|
|
export type SessionPinMode = SetSessionPinnedRequest['mode']
|
|
|
|
/**
|
|
* An empty string clears the custom name, so unlike session rename there is no
|
|
* `min(1)`: the machine falls back to its hostname. The length ceiling is
|
|
* enforced after trimming, so it is not expressed here.
|
|
*/
|
|
export const RenameMachineRequestSchema = z.object({
|
|
displayName: z.string()
|
|
})
|
|
|
|
export type RenameMachineRequest = z.infer<typeof RenameMachineRequestSchema>
|
|
|
|
export const MACHINE_DISPLAY_NAME_MAX_LENGTH = 64
|
|
|
|
|
|
/**
|
|
* Scratchlist v2 (tiann/hapi#893) per-entry caps.
|
|
*
|
|
* `MAX_ENTRIES` (200) is a per-session ceiling: refuses to create entry
|
|
* 201 on the hub. Mirrors `SCRATCHLIST_MAX_ENTRIES` in
|
|
* `web/src/lib/scratchlist.ts` so the hub and web agree on the limit -
|
|
* the web side has UX for the cap (disabled add button + atCap hint),
|
|
* the hub side enforces it as a server-side guard against malicious /
|
|
* runaway clients writing arbitrary amounts.
|
|
*
|
|
* `MAX_TEXT_LENGTH` (10_000) is the per-entry text cap. Mirrors
|
|
* `SCRATCHLIST_MAX_TEXT_LENGTH`. The web side truncates rather than
|
|
* rejects; the hub-side schema allows up to this length and rejects
|
|
* anything longer with 400.
|
|
*/
|
|
export const SCRATCHLIST_MAX_ENTRIES = 200
|
|
export const SCRATCHLIST_MAX_TEXT_LENGTH = 10_000
|
|
/**
|
|
* Hard cap on client-supplied entry id length. The id is persisted as
|
|
* part of the SQLite primary key, so without a bound an authenticated
|
|
* client could grow the table and its index with arbitrarily large
|
|
* keys. 128 chars comfortably fits a UUID (36) plus any prefix scheme
|
|
* we might layer on later.
|
|
*/
|
|
export const SCRATCHLIST_MAX_ENTRY_ID_LENGTH = 128
|
|
|
|
import { ScratchlistAttachmentsArraySchema } from './scratchlistAttachments'
|
|
|
|
export const ScratchlistEntryCreateRequestSchema = z.object({
|
|
/**
|
|
* Optional client-supplied entry id. Lets the web client preserve its
|
|
* pre-v2 localStorage entry ids during migration so the optimistic-
|
|
* update path doesn't have to re-key entries already in the React
|
|
* tree. New entries created post-v2 can omit this and let the hub
|
|
* generate one.
|
|
*/
|
|
entryId: z.string().min(1).max(SCRATCHLIST_MAX_ENTRY_ID_LENGTH).optional(),
|
|
text: z.string().max(SCRATCHLIST_MAX_TEXT_LENGTH).default(''),
|
|
attachments: ScratchlistAttachmentsArraySchema.optional().default([]),
|
|
/**
|
|
* Optional client-supplied createdAt. Used by the migration path to
|
|
* preserve the original timestamps from localStorage. New entries
|
|
* omit this and let the hub stamp `Date.now()`.
|
|
*/
|
|
createdAt: z.number().int().nonnegative().optional()
|
|
}).refine(
|
|
(data) => data.text.trim().length > 0 || data.attachments.length > 0,
|
|
{ message: 'Scratchlist entry requires text or attachments', path: ['text'] }
|
|
)
|
|
|
|
export type ScratchlistEntryCreateRequest = z.infer<typeof ScratchlistEntryCreateRequestSchema>
|
|
|
|
export const ScratchlistEntryUpdateRequestSchema = z.object({
|
|
text: z.string().max(SCRATCHLIST_MAX_TEXT_LENGTH).optional(),
|
|
attachments: ScratchlistAttachmentsArraySchema.optional(),
|
|
}).refine(
|
|
(data) => data.text !== undefined || data.attachments !== undefined,
|
|
{ message: 'Update requires text and/or attachments', path: ['text'] }
|
|
).refine(
|
|
(data) => {
|
|
// Attachments-only patch may clear the list (`[]`) while keeping text.
|
|
if (data.text === undefined && data.attachments !== undefined) {
|
|
return true
|
|
}
|
|
if (data.text !== undefined && data.attachments === undefined) {
|
|
return data.text.trim().length > 0
|
|
}
|
|
if (data.text !== undefined && data.attachments !== undefined) {
|
|
return data.text.trim().length > 0 || data.attachments.length > 0
|
|
}
|
|
return true
|
|
},
|
|
{ message: 'Scratchlist entry requires non-empty text or attachments', path: ['text'] }
|
|
)
|
|
|
|
export type ScratchlistEntryUpdateRequest = z.infer<typeof ScratchlistEntryUpdateRequestSchema>
|
|
|
|
/** Per-session legacy stream-json → ACP migrator request. See tiann/hapi#824. */
|
|
export const CursorMigrateToAcpRequestSchema = z.object({
|
|
/** Skip removing the legacy ~/.cursor/chats source store.db even after verify passes. */
|
|
keepSource: z.boolean().optional(),
|
|
/** Allow migrating a session whose lifecycleState === 'running' by archiving it first. */
|
|
forceArchiveRunning: z.boolean().optional(),
|
|
/** Skip the verify-by-prompt step (session/load alone is run). */
|
|
skipVerify: z.boolean().optional()
|
|
})
|
|
|
|
export type CursorMigrateToAcpRequest = z.infer<typeof CursorMigrateToAcpRequestSchema>
|
|
|
|
export type CursorMigrateOutcome =
|
|
| { ok: true; sessionId: string; acpSessionId: string; replayNotifications: number; durationMs: number; lastUsedModelPreserved: string | null; sourceRemoved: boolean }
|
|
| { ok: false; sessionId: string; reason: CursorMigrateRefusalReason; message: string; durationMs: number }
|
|
|
|
export type CursorMigrateRefusalReason =
|
|
| 'not_cursor_session'
|
|
| 'already_acp'
|
|
| 'running_refused'
|
|
| 'no_cursor_session_id'
|
|
| 'no_legacy_store_on_disk'
|
|
| 'target_already_exists'
|
|
| 'verify_load_failed'
|
|
| 'verify_prompt_failed'
|
|
| 'metadata_write_failed'
|
|
| 'archive_failed'
|
|
| 'lock_release_timeout'
|
|
| 'acp_transport_active'
|
|
| 'session_resumed_during_migrate'
|
|
| 'legacy_store_modified_during_migrate'
|
|
| 'cross_host_session'
|
|
| 'ambiguous_legacy_store'
|
|
| 'size_mismatch'
|
|
| 'internal_error'
|
|
|
|
export const UploadFileRequestSchema = z.object({
|
|
filename: z.string().min(1).max(255),
|
|
content: z.string().min(1),
|
|
mimeType: z.string().min(1).max(255)
|
|
})
|
|
|
|
export type UploadFileRequest = z.infer<typeof UploadFileRequestSchema>
|
|
|
|
export const DeleteUploadRequestSchema = z.object({
|
|
path: z.string().min(1)
|
|
})
|
|
|
|
export type DeleteUploadRequest = z.infer<typeof DeleteUploadRequestSchema>
|
|
|
|
export const MessagesQuerySchema = z.object({
|
|
limit: z.coerce.number().int().min(1).max(200).optional(),
|
|
beforeSeq: z.coerce.number().int().min(1).optional(),
|
|
beforeAt: z.coerce.number().int().min(0).optional(),
|
|
afterSeq: z.coerce.number().int().min(1).optional(),
|
|
afterAt: z.coerce.number().int().min(0).optional(),
|
|
untilSeq: z.coerce.number().int().min(1).optional(),
|
|
untilAt: z.coerce.number().int().min(0).optional(),
|
|
epoch: z.coerce.number().int().min(0).optional(),
|
|
})
|
|
.refine((data) => (data.beforeAt === undefined) === (data.beforeSeq === undefined), {
|
|
message: 'beforeAt and beforeSeq must be provided together',
|
|
path: ['beforeAt'],
|
|
})
|
|
.refine((data) => (data.afterAt === undefined) === (data.afterSeq === undefined), {
|
|
message: 'afterAt and afterSeq must be provided together',
|
|
path: ['afterAt'],
|
|
})
|
|
.refine((data) => (data.untilAt === undefined) === (data.untilSeq === undefined), {
|
|
message: 'untilAt and untilSeq must be provided together',
|
|
path: ['untilAt'],
|
|
})
|
|
.refine((data) => data.beforeAt === undefined || data.afterAt === undefined, {
|
|
message: 'before and after cursors are mutually exclusive',
|
|
path: ['afterAt'],
|
|
})
|
|
.refine((data) => data.untilAt === undefined || data.afterAt !== undefined, {
|
|
message: 'until cursor requires an after cursor',
|
|
path: ['untilAt'],
|
|
})
|
|
.refine((data) => data.epoch === undefined || data.afterAt !== undefined, {
|
|
message: 'epoch requires an after cursor',
|
|
path: ['epoch'],
|
|
})
|
|
|
|
export type MessagesQuery = z.infer<typeof MessagesQuerySchema>
|
|
|
|
export const MessageDeliveryModeSchema = z.enum(['queue', 'steer'])
|
|
export type MessageDeliveryMode = z.infer<typeof MessageDeliveryModeSchema>
|
|
|
|
export const SendMessageRequestSchema = z.object({
|
|
text: z.string(),
|
|
localId: z.string().min(1).optional(),
|
|
attachments: z.array(AttachmentMetadataSchema).optional(),
|
|
scheduledAt: z.number().int().positive().nullable().optional(),
|
|
deliveryMode: MessageDeliveryModeSchema.optional()
|
|
}).refine(
|
|
(data) => data.scheduledAt == null || typeof data.localId === 'string',
|
|
{ message: 'scheduledAt requires localId', path: ['localId'] }
|
|
).refine(
|
|
(data) => data.scheduledAt == null || data.scheduledAt <= Date.now() + 7 * 24 * 60 * 60 * 1000,
|
|
{ message: 'scheduledAt must be within 7 days from now', path: ['scheduledAt'] }
|
|
).refine(
|
|
(data) => data.scheduledAt == null || !data.attachments?.length,
|
|
{ message: 'scheduled messages with attachments are not supported', path: ['attachments'] }
|
|
).refine(
|
|
(data) => data.scheduledAt == null || data.deliveryMode !== 'steer',
|
|
{ message: 'scheduled messages cannot use steer delivery', path: ['deliveryMode'] }
|
|
)
|
|
|
|
export type SendMessageRequest = z.infer<typeof SendMessageRequestSchema>
|
|
|
|
export const ForkConversationRequestSchema = z.object({
|
|
messageLocalId: z.string().min(1).optional()
|
|
})
|
|
|
|
export type ForkConversationRequest = z.infer<typeof ForkConversationRequestSchema>
|
|
|
|
export type ForkConversationResponse = {
|
|
sessionId: string
|
|
}
|
|
|
|
export const ImplementCodexPlanRequestSchema = z.object({
|
|
planId: z.string().min(1)
|
|
})
|
|
|
|
export type ImplementCodexPlanRequest = z.infer<typeof ImplementCodexPlanRequestSchema>
|
|
|
|
export type ImplementCodexPlanResult = { ok: true } | {
|
|
ok: false
|
|
code: 'stale_plan' | 'unavailable' | 'indeterminate' | 'failed'
|
|
error: string
|
|
}
|
|
|
|
export const RewindConversationRequestSchema = z.object({
|
|
messageLocalId: z.string().min(1)
|
|
})
|
|
|
|
export type RewindConversationRequest = z.infer<typeof RewindConversationRequestSchema>
|
|
|
|
export type RewindConversationResponse = {
|
|
success: true
|
|
}
|
|
|
|
/** CLI → hub RPC result for native fork (before HAPI child binding). */
|
|
export type ForkConversationRpcResult = {
|
|
nativeSessionId: string
|
|
/** Shared runtimes bind the child themselves; hub must not spawn another engine. */
|
|
sessionId?: string
|
|
/** When true, hub must spawn with --fork-session (Claude). */
|
|
forkSession?: boolean
|
|
}
|
|
|
|
/** Raw RPC response, including generic serialized handler failures. */
|
|
export type ForkConversationRpcResponse = ForkConversationRpcResult | {
|
|
/** Serialized CLI handler failure returned through the generic RPC layer. */
|
|
error: string
|
|
}
|
|
|
|
export type RewindConversationErrorCode =
|
|
| 'ambiguous_native_boundary'
|
|
| 'ambiguous_native_boundary_fork_safe'
|
|
|
|
export type RewindConversationRpcResult = {
|
|
success: true
|
|
/** Truncate HAPI transcript at/after this localId, then accept rehydrated history. */
|
|
truncateFromLocalId: string
|
|
messages?: Array<{
|
|
content: unknown
|
|
localId?: string | null
|
|
createdAt?: number
|
|
invokedAt?: number | null
|
|
}>
|
|
} | {
|
|
success: false
|
|
error: string
|
|
code?: RewindConversationErrorCode
|
|
/** Native state is unchanged, cancelled, or was restored exactly. */
|
|
outcome: 'rejected' | 'cancelled' | 'source_restored'
|
|
}
|
|
|
|
export const QueuedStateRequestSchema = z.object({
|
|
localIds: z.array(z.string().min(1)).max(1000)
|
|
})
|
|
|
|
export type QueuedStateRequest = z.infer<typeof QueuedStateRequestSchema>
|
|
|
|
export type QueuedStateResponse = {
|
|
queuedLocalIds: string[]
|
|
indeterminateLocalIds?: string[]
|
|
invokedLocalMessages: Array<{
|
|
localId: string
|
|
invokedAt: number
|
|
}>
|
|
}
|
|
|
|
export const SpawnSessionRequestSchema = z.object({
|
|
directory: z.string().min(1),
|
|
agent: AgentFlavorSchema.optional(),
|
|
model: z.string().optional(),
|
|
effort: z.string().optional(),
|
|
modelReasoningEffort: z.string().optional(),
|
|
yolo: z.boolean().optional(),
|
|
permissionMode: PermissionModeSchema.optional(),
|
|
sessionType: z.enum(['simple', 'worktree']).optional(),
|
|
worktreeName: z.string().optional(),
|
|
serviceTier: z.enum(['fast', 'standard']).optional(),
|
|
collaborationMode: CodexCollaborationModeSchema.optional(),
|
|
copilotAgentMode: CopilotAgentModeSchema.optional(),
|
|
startingMode: z.enum(['remote', 'pty']).optional()
|
|
})
|
|
|
|
export type SpawnSessionRequest = z.infer<typeof SpawnSessionRequestSchema>
|
|
|
|
export const MachineListDirectoryRequestSchema = z.object({
|
|
path: z.string().min(1),
|
|
includeHidden: z.boolean().optional()
|
|
})
|
|
|
|
export type MachineListDirectoryRequest = z.infer<typeof MachineListDirectoryRequestSchema>
|
|
|
|
export const MachinePathsExistsRequestSchema = z.object({
|
|
paths: z.array(z.string().min(1)).max(1000)
|
|
})
|
|
|
|
export type MachinePathsExistsRequest = z.infer<typeof MachinePathsExistsRequestSchema>
|
|
|
|
export const AgentAvailabilityReasonSchema = z.enum(['not_found', 'invalid_configuration'])
|
|
export type AgentAvailabilityReason = z.infer<typeof AgentAvailabilityReasonSchema>
|
|
|
|
export const AgentAvailabilityEntrySchema = z.object({
|
|
agent: AgentFlavorSchema,
|
|
available: z.boolean(),
|
|
reason: AgentAvailabilityReasonSchema.optional()
|
|
})
|
|
export type AgentAvailabilityEntry = z.infer<typeof AgentAvailabilityEntrySchema>
|
|
|
|
export const AgentAvailabilityResponseSchema = z.object({
|
|
agents: z.array(AgentAvailabilityEntrySchema)
|
|
})
|
|
export type AgentAvailabilityResponse = z.infer<typeof AgentAvailabilityResponseSchema>
|
|
|
|
export const AuthRequestSchema = z.union([
|
|
z.object({ initData: z.string() }),
|
|
z.object({ accessToken: z.string() })
|
|
])
|
|
|
|
export type AuthRequest = z.infer<typeof AuthRequestSchema>
|
|
|
|
export type CommandResponse = {
|
|
success: boolean
|
|
stdout?: string
|
|
stderr?: string
|
|
exitCode?: number
|
|
error?: string
|
|
}
|
|
|
|
export type GitCommandResponse = CommandResponse
|
|
|
|
export type FileReadResponse = {
|
|
success: boolean
|
|
content?: string
|
|
size?: number
|
|
modified?: number
|
|
error?: string
|
|
}
|
|
|
|
export type GeneratedImageResponse = {
|
|
success: boolean
|
|
content?: string
|
|
mimeType?: string
|
|
fileName?: string
|
|
error?: string
|
|
}
|
|
|
|
export type UploadFileResponse = {
|
|
success: boolean
|
|
path?: string
|
|
error?: string
|
|
}
|
|
|
|
export type DeleteUploadResponse = {
|
|
success: boolean
|
|
error?: string
|
|
}
|
|
|
|
export type DirectoryEntry = {
|
|
name: string
|
|
type: 'file' | 'directory' | 'other'
|
|
size?: number
|
|
modified?: number
|
|
}
|
|
|
|
export type ListDirectoryResponse = {
|
|
success: boolean
|
|
entries?: DirectoryEntry[]
|
|
error?: string
|
|
}
|
|
|
|
export type RpcListDirectoryResponse = ListDirectoryResponse
|
|
|
|
export type FileMetadataEntry = {
|
|
path: string
|
|
size?: number
|
|
modified?: number
|
|
}
|
|
|
|
export type StatFilesResponse = {
|
|
success: boolean
|
|
entries?: FileMetadataEntry[]
|
|
error?: string
|
|
}
|
|
|
|
export type MachineDirectoryEntry = DirectoryEntry & {
|
|
isGitRepo?: boolean
|
|
}
|
|
|
|
export type MachineListDirectoryResponse = {
|
|
success: boolean
|
|
entries?: MachineDirectoryEntry[]
|
|
error?: string
|
|
}
|
|
|
|
export type PathExistsResponse = {
|
|
exists: Record<string, boolean>
|
|
/** Requested paths rejected by the runner's configured workspace roots. */
|
|
outsideWorkspaceRoots?: string[]
|
|
}
|
|
|
|
export type MachinePathsExistsResponse = PathExistsResponse
|
|
|
|
/** Requests served by the long-lived runner for archived-session file access. */
|
|
export type WorkspaceReadFileRequest = {
|
|
cwd: string
|
|
path: string
|
|
}
|
|
|
|
export type WorkspaceListDirectoryRequest = {
|
|
cwd: string
|
|
path?: string
|
|
}
|
|
|
|
export type WorkspaceStatFilesRequest = {
|
|
cwd: string
|
|
paths: string[]
|
|
}
|
|
|
|
export type WorkspaceGitStatusRequest = {
|
|
cwd: string
|
|
timeout?: number
|
|
}
|
|
|
|
export type WorkspaceGitDiffNumstatRequest = {
|
|
cwd: string
|
|
staged?: boolean
|
|
timeout?: number
|
|
}
|
|
|
|
export type WorkspaceGitDiffFileRequest = {
|
|
cwd: string
|
|
filePath: string
|
|
staged?: boolean
|
|
timeout?: number
|
|
}
|
|
|
|
export type WorkspaceRipgrepRequest = {
|
|
cwd: string
|
|
args: string[]
|
|
fileSearch?: {
|
|
query: string
|
|
limit: number
|
|
}
|
|
}
|
|
|
|
export type CodexModelSummary = {
|
|
id: string
|
|
displayName: string
|
|
isDefault: boolean
|
|
defaultReasoningEffort?: string | null
|
|
defaultServiceTier?: string | null
|
|
supportedReasoningEfforts?: string[]
|
|
/** Service tier ids advertised for this model in the current auth/plan context (e.g. 'fast'). */
|
|
serviceTiers?: string[]
|
|
}
|
|
|
|
export type CodexModelsResponse = {
|
|
success: boolean
|
|
models?: CodexModelSummary[]
|
|
error?: string
|
|
}
|
|
|
|
export type ListCodexModelsResponse = CodexModelsResponse
|
|
|
|
export type OpencodeModelSummary = {
|
|
modelId: string
|
|
name?: string
|
|
}
|
|
|
|
export type OpencodeModelsResponse = {
|
|
success: boolean
|
|
availableModels?: OpencodeModelSummary[]
|
|
/** CLI `agent --list-models` skus grouped under ACP wire bases for variant pickers. */
|
|
cliModelSkus?: OpencodeModelSummary[]
|
|
currentModelId?: string | null
|
|
error?: string
|
|
}
|
|
|
|
export type ListOpencodeModelsResponse = OpencodeModelsResponse
|
|
|
|
/** Variant values keyed by `providerId/modelId` from the OpenCode server catalog. */
|
|
export type OpencodeModelVariantsResponse = {
|
|
success: boolean
|
|
variants?: Record<string, string[]>
|
|
error?: string
|
|
}
|
|
|
|
export type GrokModelSummary = {
|
|
modelId: string
|
|
name?: string
|
|
reasoningEfforts?: GrokReasoningEffortOption[]
|
|
}
|
|
|
|
export type DshModelSummary = {
|
|
modelId: string
|
|
name?: string
|
|
}
|
|
|
|
/**
|
|
* DeepSeek Harness model discovery. Model ids are opaque ACP config-option
|
|
* values — for dsh 0.2.x they are JSON-encoded `["provider","model"]` tuples —
|
|
* and must be sent back verbatim when switching.
|
|
*/
|
|
export type DshModelsResponse = {
|
|
success: boolean
|
|
availableModels?: DshModelSummary[]
|
|
currentModelId?: string | null
|
|
error?: string
|
|
}
|
|
export type ListDshModelsResponse = DshModelsResponse
|
|
|
|
export type GrokReasoningEffortOption = {
|
|
value: string
|
|
name?: string
|
|
isDefault?: boolean
|
|
}
|
|
|
|
export type GrokModelsResponse = {
|
|
success: boolean
|
|
availableModels?: GrokModelSummary[]
|
|
currentModelId?: string | null
|
|
autoPermissionModeSupported?: boolean
|
|
error?: string
|
|
}
|
|
export type ListGrokModelsResponse = GrokModelsResponse
|
|
|
|
export type CopilotModelSummary = {
|
|
modelId: string
|
|
name?: string
|
|
}
|
|
|
|
export type CopilotModelsResponse = {
|
|
success: boolean
|
|
availableModels?: CopilotModelSummary[]
|
|
currentModelId?: string | null
|
|
error?: string
|
|
}
|
|
|
|
export type ListCopilotModelsResponse = CopilotModelsResponse
|
|
|
|
export type KimiModelSummary = {
|
|
/** Kimi model alias as used by `--model` / `session/set_model`. */
|
|
modelId: string
|
|
name?: string
|
|
provider?: string
|
|
}
|
|
|
|
export type KimiModelsResponse = {
|
|
success: boolean
|
|
availableModels?: KimiModelSummary[]
|
|
currentModelId?: string | null
|
|
error?: string
|
|
}
|
|
|
|
export type ListKimiModelsResponse = KimiModelsResponse
|
|
|
|
export type GrokReasoningEffortResponse = {
|
|
success: boolean
|
|
options?: GrokReasoningEffortOption[]
|
|
currentValue?: string | null
|
|
error?: string
|
|
}
|
|
|
|
export type OpencodeReasoningEffortOption = {
|
|
value: string
|
|
name?: string
|
|
}
|
|
|
|
export type OpencodeReasoningEffortResponse = {
|
|
success: boolean
|
|
options?: OpencodeReasoningEffortOption[]
|
|
currentValue?: string | null
|
|
/** Backend-side model the options belong to — lets clients detect a pending model switch. */
|
|
currentModelId?: string | null
|
|
/** Concrete backend model requested by the session, including a resolved Default selection. */
|
|
targetModelId?: string | null
|
|
error?: string
|
|
}
|
|
|
|
export type AgyModelSummary = {
|
|
modelId: string
|
|
name?: string
|
|
}
|
|
|
|
export type AgyModelsResponse = {
|
|
success: boolean
|
|
availableModels?: AgyModelSummary[]
|
|
currentModelId?: string | null
|
|
error?: string
|
|
}
|
|
|
|
export type ListAgyModelsResponse = AgyModelsResponse
|
|
|
|
export type CursorModelSummary = OpencodeModelSummary
|
|
|
|
export type CursorModelsResponse = OpencodeModelsResponse & {
|
|
/**
|
|
* True when ACP advertised Cursor's parameterized model picker: bare model bases
|
|
* plus separate `fast` / `thought_level` config options. The ACP apply path
|
|
* expresses variant CLI skus through those options, so variant rows stay valid
|
|
* even when the catalog itself carries no bracket wire ids.
|
|
*/
|
|
parameterized?: boolean
|
|
}
|
|
|
|
export type ListCursorModelsResponse = CursorModelsResponse
|
|
|
|
/** Maps thinking levels to provider-specific values. null = unsupported. */
|
|
export type PiThinkingLevelMap = Partial<Record<string, string | null>>
|
|
|
|
export type PiModelSummary = {
|
|
provider: string
|
|
modelId: string
|
|
name?: string
|
|
contextWindow?: number
|
|
/** Whether the model supports reasoning/thinking */
|
|
reasoning?: boolean
|
|
/** Maps Pi thinking levels to provider values; null = unsupported level */
|
|
thinkingLevelMap?: PiThinkingLevelMap
|
|
}
|
|
|
|
export type PiModelsResponse = {
|
|
success: boolean
|
|
availableModels?: PiModelSummary[]
|
|
currentModelId?: string | null
|
|
error?: string
|
|
}
|
|
|
|
export type ListPiModelsResponse = PiModelsResponse
|
|
|
|
/** One row of the `claude` CLI's own model picker, as reported by its `initialize` control response. */
|
|
export type ClaudeModelSummary = {
|
|
/** What `claude --model` accepts: an alias that follows the family (`opus`) or a full model id. */
|
|
value: string
|
|
displayName?: string
|
|
/** Effort levels the model accepts: `[]` = no effort control, undefined = unknown. */
|
|
effortLevels?: string[]
|
|
}
|
|
|
|
export type ClaudeModelsResponse = {
|
|
success: boolean
|
|
availableModels?: ClaudeModelSummary[]
|
|
error?: string
|
|
}
|
|
|
|
export type PiCommandSummary = {
|
|
name: string
|
|
description?: string
|
|
source: 'extension' | 'prompt' | 'skill'
|
|
}
|
|
|
|
export type PiCommandsResponse = {
|
|
success: boolean
|
|
commands?: PiCommandSummary[]
|
|
error?: string
|
|
}
|
|
|
|
export type SlashCommand = {
|
|
name: string
|
|
description?: string
|
|
source: 'builtin' | 'user' | 'plugin' | 'project'
|
|
content?: string
|
|
pluginName?: string
|
|
}
|
|
|
|
export type SlashCommandsResponse = {
|
|
success: boolean
|
|
commands?: SlashCommand[]
|
|
error?: string
|
|
}
|
|
|
|
export type SqliteStorageUsageResponse = {
|
|
path: string
|
|
databaseBytes: number
|
|
walBytes: number
|
|
shmBytes: number
|
|
totalBytes: number
|
|
}
|
|
|
|
export type UsageSummaryBucket = {
|
|
key: string
|
|
inputTokens: number
|
|
outputTokens: number
|
|
cacheReadTokens: number
|
|
cacheCreationTokens: number
|
|
totalTokens: number
|
|
uncachedTokens: number
|
|
requests: number
|
|
}
|
|
|
|
export type UsageSummaryResponse = {
|
|
range: {
|
|
from: number | null
|
|
to: number | null
|
|
}
|
|
totals: {
|
|
inputTokens: number
|
|
outputTokens: number
|
|
cacheReadTokens: number
|
|
cacheCreationTokens: number
|
|
totalTokens: number
|
|
uncachedTokens: number
|
|
requests: number
|
|
sessions: number
|
|
}
|
|
daily: Array<UsageSummaryBucket & { key: string }>
|
|
byAgent: UsageSummaryBucket[]
|
|
byModel: UsageSummaryBucket[]
|
|
updatedAt: number
|
|
}
|