openclaw
Version:
Multi-channel AI gateway with extensible messaging integrations
35,856 lines • 1.5 MB
TypeScript
import { A as McpServerToolFilterConfig, At as TtsModelOverrideConfig, B as TalkProviderConfig, C as ThinkingBudgets, Cn as ModelCatalogContextWindowOption, D as Transport, Dt as TtsAutoMode, E as ToolResultMessage, En as UnifiedModelCatalogKind, Et as ResolvedTtsPersona, Ft as GroupToolPolicyConfig, Gt as MentionPatternsMode, Ht as SafeBinProfileFixture, I as GatewayTailscaleMode, It as ToolLoopDetectionConfig, J as SubagentDelegationMode, Kt as MentionPatternsPolicyConfig, L as GatewayTrustedProxyConfig, Lt as ToolProfileId, M as GatewayAuthConfig, N as GatewayAuthRateLimitConfig, Nt as TtsProvider, Ot as TtsConfig, Rt as ToolsConfig, S as TextContent, Tn as UnifiedModelCatalogEntry, Y as AgentRuntimePolicyConfig, Zt as AcpRuntimeSessionMode, a as ModelDefinitionConfig, b as SimpleStreamOptions, c as ModelProviderConfig, cn as PluginManifestControlUi, d as AssistantMessage$1, dn as PluginManifestDashboardDataBinding, en as PluginBundleFormat, f as AssistantMessageEvent, fn as PluginManifestMcpServer, g as ImageContent$1, h as Context, i as ModelCompatConfig, j as PluginInstallRecord, k as McpCodexToolApprovalMode, kt as TtsMode, l as ModelApi, ln as PluginManifestDashboard, m as CompleteSimpleFn, mn as PluginManifestNativeSessionCatalogSetup, nn as PluginDiagnostic, o as ModelMediaInputConfig, p as AssistantMessageEventStreamContract, r as OpenClawConfig, rn as PluginFormat, s as ModelProviderAuthMode, sn as PluginManifestContracts, t as ConfigFileSnapshot, tn as PluginConfigUiHint, u as Api, un as PluginManifestDashboardActionVerb, v as Message, vn as PluginKind, x as StreamFn, y as Model, zt as MemoryCitationsMode } from "./types.openclaw-B-tbtohD.js";
import { d as JsonSchemaObject, l as ChannelConfigSchema } from "./zod-schema.implicit-mentions-CP3tNlpK.js";
import { C as SessionConfig, E as SessionScope, S as ReplyToMode, T as SessionResetConfig, _ as HumanDelayConfig, d as ContextVisibilityMode, m as DmScope, x as MarkdownTableMode } from "./types.base-CO3vBS33.js";
import { d as SecretInput, f as SecretRef } from "./types.secrets-DxQuXa9f.js";
import { d as MemoryReadResult, f as MemorySearchManager, i as InternalSessionTranscriptUpdate, m as MemorySearchDeadlineControlOptions, n as resolveSessionStorePathCore, o as onSessionTranscriptUpdate, p as MemorySearchResult, s as LegacyMemoryReadResult, u as MemoryOriginClass } from "./paths-UINMFCfh.js";
import { $ as InboundSourceModality, $t as ExecutionIdentityAdmissionToken, At as AGENT_RUN_RESTART_ABORT_STOP_REASON, B as CronToolsAllowExecTargetRequirement, C as ProviderReviewAcknowledgment, D as InternalSessionEntry, Dt as TranscriptTurnAdmission, E as GroupKeyResolution, Et as TranscriptEntryAnchor, F as SessionToolOverrides, Ft as CommandTurnContext, G as TranscriptEvent, H as SessionTranscriptReadScope, Ht as InputProvenance, I as SessionSystemPromptReport, It as CommandTurnKind, J as ResolvedSessionMaintenanceConfigInput, Jt as InboundEventKind, K as TranscriptMessageAppendOptions, Kn as GATEWAY_CLIENT_IDS, Kt as PromptImageOrderEntry, L as CronScheduledToolCallerOrigin, M as SessionOrigin, Mt as AgentRunTimeoutPhase, N as SessionPluginJsonValue, O as SessionChatType, Ot as TranscriptTurnBoundary, P as SessionScope$1, Q as FinalizedRuntimeMsgContext, Qt as AgentRunDelegatedAuthority, R as CronScheduledToolPolicy, S as PluginGatewayAccessPolicy, T as CliSessionBinding, U as SessionTranscriptRuntimeTarget, V as SessionTranscriptAccessScope, W as SessionTranscriptWriteScope, Wt as PluginHookChannelContext, Xn as ProviderRefusalReview, Xt as SessionCreatedVia, Y as CanonicalInboundText, Yt as SessionCreatedActor, Z as FinalizedMsgContext, Zt as HookExternalContentSource, _ as OperationalRunInstanceRef, _t as UserTurnTranscriptRecorder, at as SupplementalContextFacts, b as GatewayAccessGrantRef, ct as BlockReplyContext, dn as SourceReplyDeliveryMode, dt as TaskSuggestionDeliveryMode, en as ReplyMediaAttachment, et as MentionSource, ft as TurnAdoptionLifecycle, g as AdmittedRunOperatorAuthority, gn as AgentPlanStep, gt as UserTurnTranscriptAnnotation, h as AdmittedRunContext, ht as UserTurnTranscriptAdmissionReceipt, i as SessionWriterDeliveryAuthority, it as SessionTranscriptContext, j as SessionEntry$1, jt as AGENT_RUN_SUPERSEDED_STOP_REASON, k as SessionContextBudgetStatus, kt as AGENT_RUN_ABORTED_STOP_REASON, ln as DeliveryContext, lt as GetReplyOptions, m as CommandOwnerAssertion, mt as UserTurnInput, nt as OriginatingChannelType, ot as TemplateContext, pt as PersistedUserTurnMessage, q as TranscriptMessageAppendResult, qn as GatewayClientCap, qt as GatewayUiCommandTarget, r as ReplyMediaFailure, tn as ReplyPayload, tt as MsgContext, un as ChannelRouteRef, ut as PartialReplyPayload, v as PreparedAgentRunAdmission, vt as TranscriptSenderIdentity, w as AmbientTranscriptWatermark, x as PluginGatewayAccessAuthority, y as admitted_run_context_d_exports, yt as OutboundPayloadPlan, z as CronToolsAllowExecTarget } from "./reply-payload-DRFubeid.js";
import { C as PluginCompatCode, S as DeclaredProviderOwnerIndex, _ as ConfigMutationBase, b as PluginMetadataSnapshot, l as ConfigWriteAfterWrite, x as PluginMetadataSnapshotOwnerMaps, y as PluginMetadataRegistryView } from "./io-B-toJNHw.js";
import { t as SandboxDockerSettings } from "./types-DATmzouh.js";
import { n as RuntimeEnv } from "./runtime-DlqUc5_p.js";
import { a as PluginDependencyStatus, i as PluginDiscoveryResult, n as PluginManifestRegistry, r as PluginTrust, t as PluginManifestRecord } from "./manifest-registry-BfeWy5EV.js";
import { t as PluginOrigin$1 } from "./plugin-origin.types-DOQEvsWL.js";
import { t as Result$1 } from "./result-VHVNeWs6.js";
import { r as LogLevel, t as SubsystemLogger } from "./subsystem-RmDRaRJV.js";
import { a as SqliteWalMaintenance, i as OpenClawStateDatabaseOptions, n as OpenClawStateDatabaseReadAdmission, r as OpenClawStateDatabase, t as OpenClawDatabaseMaintenanceScope } from "./openclaw-state-db-C-0605Y_.js";
import { t as ConfigReplaceResult } from "./config-2r9-SkRY.js";
import { t as resolveStateDir } from "./state-dir-CrCP_VLr.js";
import "./paths-Tf7t-9Le.js";
import "./index-3Gqagsxj.js";
import { a as AgentState, c as AgentToolUpdateCallback, d as PrepareNextTurnContext, f as QueueMode, g as ToolLoopWarning, h as ToolExecutionMode, i as AgentMessage, l as BashExecutionMessage, m as ThinkingLevel, n as AgentLoopConfig, o as AgentTool, p as StreamFn$1, r as AgentLoopTurnUpdate, s as AgentToolResult, t as AgentEvent, u as CustomMessage } from "./types-D-00GTEw.js";
import { c as SessionApprovalReplay, n as ApprovalPresentation, s as ApprovalTerminalReason, t as ApprovalDecision } from "./approvals-B-zk4kd_.js";
import { A as ExecApprovalDecision, B as ExecAsk, E as ApprovalScope, H as ExecMode, M as ExecApprovalRequestPayload, N as ExecApprovalResolved, U as ExecSecurity, V as ExecHost, W as ExecTarget, _ as PluginApprovalRequestPayload, c as SystemAgentApprovalResolved, et as resolveExecModePolicy, g as PluginApprovalRequest$1, j as ExecApprovalRequest, o as SystemAgentApprovalRequest, r as ChannelApprovalKind, s as SystemAgentApprovalRequestPayload } from "./approval-types-C2jV80E7.js";
import { f as MessagePresentation, j as ReplyPayloadDelivery, o as LegacyInteractiveReply } from "./payload-BORcq8uU.js";
import { t as ProviderModelRef } from "./model-catalog-refs-Phyl1k6H.js";
import { a as SkillsLibraryReadResult, i as SkillsLibraryListResult, n as SkillLibrarySelection, o as SkillsLibraryReceipt, r as SkillsLibraryActivateResult, t as SkillLibraryFile } from "./skill-library-DVzEZ7Hi.js";
import { $ as UsersListAuthLinksResult, A as QuestionRecord, At as SessionActivitySummary, B as DesktopObserveResult, Bt as WorkerInferenceCancelResult, C as PresenceEntry, D as SessionsCompanionStateResult, Dt as SessionsCatalogReadResult, E as SessionObserverDigest, Et as SessionsCatalogReadParams, F as QueueMode$1, G as SystemAgentWizardCancel, Gt as WorkerInferenceStartResult, H as CronJob$1, Ht as WorkerInferenceEventFrame, J as UsersAuthConnectStartResult, Jt as ModelChoice, K as PersonalGitHubStatus, Kt as WorkerInferenceTerminalFrame, L as MentionsListResult, Lt as WorkerComputerParams, M as QuestionResolvedEvent, N as QuestionWaitAnswerResult, Nt as SessionPermissionMode, O as Question, P as AgentActivityItem, Q as UsersLinkAuthProfileResult, Qt as SessionGitHubPublishParams, R as UsersMentionableParams, Rt as WorkerComputerResult, S as TerminalUploadResult$1, St as SessionsCatalogContinueParams, T as SessionCompanionExchange, U as CronUpdateParams, Ut as WorkerInferenceEventParams, V as ScopeUpgradeResult, Vt as WorkerInferenceErrorReason, W as SystemAgentChatQuestion, Wt as WorkerInferenceStartParams, X as UsersGitHubAuthorizePollResult, Xt as GitHubPublicationPublisher, Y as UsersAuthConnectStatusResult, Yt as ModelsListResult, Z as UsersGitHubAuthorizeStartResult, Zt as SessionGitHubPublicationResult, _ as WizardNextResult$1, a as WorkerLiveEventParams, b as PortalSummary, bt as SessionsCatalogArchiveParams, c as WorkerPresenceParams, cn as SessionPlacementMachine, ct as ToolsGitHubAuthorizeStartResult, d as WorkerSessionsSendParams, dn as SessionsReclaimParams, en as ConnectParams, et as UsersListModelAccountsResult, f as WorkerSessionsSpawnParams, g as WizardAnswer, h as WorkerTranscriptCommitResult, i as WorkerLiveEventErrorDetails, in as RequestFrame, it as DecisionReceiptV1, j as QuestionResolveResult, k as QuestionAnswers, l as WorkerProtocolCloseReason, ln as SessionPlacementRunner, lt as AgentParamsSchema, m as WorkerTranscriptCommitParams, mt as SessionCatalogHost, n as WorkerAdmissionHandshake, nt as UsersUnlinkAuthProfileResult, o as WorkerLiveEventResult, on as SessionMoveTarget, ot as SkillsProposalRecordResult, p as WorkerTranscriptCommitErrorReason, q as UsersAuthConnectCatalogResult, qt as WorkerInferenceTerminalOutcome, r as WorkerConnectParams, rt as ChatAccountSelection, s as WorkerPortalParams, sn as SessionPlacementDiskSpace, st as ToolsGitHubAuthorizePollResult, t as WorkerAdmissionFailureReason, tn as ErrorShape, tt as UsersSelectModelAccountResult, u as WorkerSessionToolResult, un as SessionPlacementWorkerRuntimeInstall, ut as AgentWaitParams, v as WizardStep$1, vt as SessionCatalogShareRoute, w as Snapshot, x as TerminalUploadPathStyle, y as PortalOpenResult, z as UsersMentionableResult, zt as WorkerInferenceCancelParams } from "./index-D_aAxq5-.js";
import { C as AuthProfileCredential, D as OAuthCredential$1, E as AuthProfileStore, O as OAuthProvider, S as AuthProfileBlockedSource, T as AuthProfileFailureReason, k as RuntimeAuthProfileStore, l as MediaUnderstandingProvider, w as AuthProfileCredentialSource, x as ApiKeyCredential$1 } from "./types-BopH1kpP.js";
import { a as mediaKindFromMime } from "./constants-BCpSHoXd.js";
import { n as MediaFact, t as LegacyMediaContextKey } from "./media-facts-BUTxYH1x.js";
import { n as HistoryMediaEntry, t as HistoryEntry } from "./history.types-gAzBXfec.js";
import { t as FastMode } from "./string-coerce-DjUc69CC.js";
import { c as WorkerTunnelStatus, i as DesktopAvailability, n as NodePluginToolDescriptor, o as WorkerEnvironmentState, r as NodeSkillDescriptor, t as NodeHostStatsPayload } from "./nodes-BW-GgLXh.js";
import { t as ChatType } from "./chat-type-B6XXSSnm.js";
import { n as PathMetadata, r as SourceInfo, t as Skill } from "./skill-contract-B-d775sU.js";
import { i as VerboseLevel, n as ThinkLevel, r as ThinkingCatalogEntry, t as ReasoningLevel } from "./thinking.shared-CS1qF_24.js";
import { t as WorkerEnvironments } from "./openclaw-state-db.generated-DU3vSkaz.js";
import { t as OutboundMediaAccess } from "./load-options-v9K2x1AC.js";
import { C as ChannelOutboundTargetMode, D as ChannelSecurityDmPolicy, I as ConversationReadInvocationOrigin, N as ChannelThreadingToolContext, S as ChannelOutboundSessionRoute, T as ChannelPollResult, b as ChannelMessagingAdapter, h as ChannelMessageActionAdapter, j as ChannelThreadingAdapter, o as ChannelAgentTool, r as ChannelAccountSnapshot, x as ChannelMeta } from "./types.core-CuY7f6gy.js";
import { A as OutboundSendDeps, D as OutboundReplyFacts, E as MessageSendContext, O as RenderedMessageBatch, S as MessageReceipt, k as RenderedMessageBatchPlan, m as ChannelMessageUnknownSendReconciliationResult, v as DurableMessageSendIntent, x as MessageDurabilityPolicy, y as LiveMessageState } from "./types-w3LVMdJc.js";
import { n as ChatChannelId, t as ChannelId$1 } from "./channel-id.types-CjcGKHk0.js";
import { A as ChannelPairingAdapter, D as ChannelSecurityAdapter, L as SecurityAuditFinding } from "./types.adapters-BO35QcPm.js";
import "./utils-DhaCU8ER.js";
import { c as SkillTelemetrySource, l as SkillUsagePath, r as SkillEligibilityContext, s as SkillSnapshot, t as ExplicitSkillSelection } from "./types-GPumK0qC.js";
import { c as ComputerUseV2ActionName, o as ComputerUseCapabilityDescriptor } from "./computer-use-contract-BPlT6ZSo.js";
import "./approval-handler-runtime-types-CaqkaDj8.js";
import { a as buildAgentSessionKey, s as resolveAgentRoute } from "./resolve-route-BDac_430.js";
import { n as ChannelRuntimeContextRegistry } from "./channel-runtime-surface.types-W_EoSebH.js";
import { a as OutboundPayloadDeliverySuppressionReason, i as OutboundPayloadDeliveryOutcome, n as OutboundDeliveryQueuePolicy, r as OutboundDeliveryResult, s as PlatformSendRoute, t as OutboundDeliveryError } from "./deliver-types-B6rIUmR3.js";
import { d as chunkMarkdownText, f as chunkMarkdownTextWithMode, g as resolveTextChunkLimit, h as resolveChunkMode, l as chunkByNewline, m as chunkTextWithMode, n as ChannelOutboundAdapter, o as OutboundIdentity, p as chunkText, s as OutboundDeliveryFormattingOptions, t as ChannelDeliveryCapabilities } from "./outbound.types-DjHzlueC.js";
import { n as OperatorScope, t as ChannelPlugin$3 } from "./types.plugin-BmmXapqg.js";
import { m as WizardPrompter } from "./setup-wizard-types-BsfwWNbZ.js";
import "./types.public-Bht1LzOM.js";
import { n as NodeWorkerBundleStatus, r as NodeHostStats, t as NodeListNode } from "./node-list-types-zvXv7lDk.js";
import { o as SessionBindingRecord } from "./session-binding.types-CHb9gl-M.js";
import { n as PinnedDispatcherPolicy, o as SsrFPolicy, t as LookupFn } from "./ssrf-CkjpArdF.js";
import { $t as TalkTransport, Jt as InternalDiagnosticEventInterest, Yt as EmbeddedAgentExecutionPhase, a as DiagnosticEventPayload, i as DiagnosticEventMetadata, o as DiagnosticEventPrivateData, r as DiagnosticEventInput, xt as DiagnosticToolTerminalReason } from "./diagnostic-events-5PMgeIeB.js";
import { B as PluginNextTurnInjection, C as PluginHookRegistrationOptions, Et as PluginJsonValue, F as PluginToolMatcher, M as PluginHookToolInputKind, N as PluginHookToolKind, O as PluginHookReplyPayloadSendingContext, P as PluginHookToolRequesterContext, S as PluginHookRegistration$1, St as NormalizedUsage, V as PluginNextTurnInjectionEnqueueResult, _ as PluginHookHandlerMap, _t as ReplyDispatchReceipt, a as HookEntry, b as PluginHookLlmOutputEvent, bt as ReplyFollowupAdmissionBarrierTimeoutPolicy, c as InternalHookHandler, dt as PluginApprovalResolution, f as PluginSubagentRequesterContext, ft as PluginHookBeforeToolCallResult, g as PluginHookBeforeToolCallEvent, gt as ReplyDispatchKind, h as PluginHookBeforeAgentFinalizeEvent, ht as ReplyDispatchBeforeDeliverOptions, i as HookRunner, j as PluginHookToolContext, l as ensureAgentWorkspace, m as PluginHookAgentEndEvent, mt as ReplyDispatchBeforeDeliver, p as PluginHookAgentContext, pt as PrepareAssistantTranscriptMessage, t as getGlobalHookRunner, u as WorkspaceBootstrapFile, ut as PluginHookGatewayCronService, vt as ReplyDispatchRuntimeInfo, x as PluginHookName, xt as NormalizeReplySkipReason, y as PluginHookLlmInputEvent, yt as ReplyDispatcher } from "./hook-runner-global-DOmDU6Jh.js";
import "./websocket-DbnFnlN8.js";
import "./fs-safe-BPoG_Ac0.js";
import "./staged-inputs-GVpqI5Pd.js";
import { n as AnyAgentTool } from "./common-CXaMD1Ub.js";
import { _ as ProviderCatalogOutcome, a as resolveAllowedModelRefCore, b as ProviderThinkingProfile, d as FallbackAttempt, f as ModelFallbackAttemptProvenance, g as ModelCatalogSnapshot, h as ModelCatalogEntry, m as FailoverReason, p as ModelFallbackRouteResolution, u as resolveDefaultModelForAgent, v as ProviderDefaultThinkingPolicyContext, x as ProviderThinkingRegistry } from "./model-selection-CPNZ4mjv.js";
import { n as EmbeddingBatchOptions, r as EmbeddingProviderBatchRuntime, t as EmbeddingBatchChunk } from "./embedding-provider-runtime-types-Ct-D7DaJ.js";
import { B as implicitMentionKindWhen, C as ResolvedChannelMessageIngress, N as InboundImplicitMentionKind, S as ResolveStableChannelMessageIngressParams, V as resolveInboundMentionDecision, b as CreateChannelIngressResolverParams, h as ChannelIngressResolver, i as UpsertChannelPairingRequestForAccount, n as ReadChannelAllowFromStoreForAccount, o as ChannelIngressCommandAccess, r as RemoveChannelAllowFromStoreEntryForAccount, v as ChannelIngressRouteDescriptor, x as ResolveChannelMessageIngressParams } from "./pairing-store.types-E7QdE_SO.js";
import { n as GatewayScheduler, t as GatewayScheduledJob } from "./diagnostic-run-activity-6vJLJLyY.js";
import { n as redactSensitiveText } from "./redact-CwfI4AYn.js";
import { l as resolveAgentDir, n as ModelFallbackAvailability, u as resolveAgentWorkspaceDir } from "./agent-scope-BuqaqJkY.js";
import { i as ControlUiLinkReaderMetadata } from "./control-ui-link-reader-BCcH9hHx.js";
import { t as DiagnosticTraceContext } from "./diagnostic-trace-context-DIVmGNEt.js";
import { a as PluginConversationBindingResolvedEvent$1, n as PluginConversationBindingRequestParams, r as PluginConversationBindingRequestResult, t as PluginConversationBinding } from "./conversation-binding.types-_NFv1lJM.js";
import { i as shouldLogVerbose, o as warn, u as RetryOptions } from "./globals-BkKO3lYj.js";
import { s as GuardedFetchOptions, u as fetchWithSsrFGuard } from "./net-D3TvDe-t.js";
import { r as OpenClawPluginNodeWorkspace, t as OpenClawPluginNodeHostCommand } from "./types.node-host-DP7EJHT6.js";
import { b as maxAsk, x as minSecurity } from "./exec-approvals-CwepMf1g.js";
import { i as McpCodexToolAnnotations, t as PluginToolMcpMeta } from "./tool-metadata-gyS0XWFc.js";
import { S as resolveDebugProxySettings, i as captureWsEventAsync, r as captureWsEvent, x as createDebugProxyWebSocketAgent } from "./kysely-sync-BeAtpnbh.js";
import { t as formatErrorMessage } from "./errors-tVUA4ubo.js";
import { a as DecisionOutcome, c as DecisionRuntimeV1, f as UnavailableReason, n as DecisionBatch, o as DecisionProviderV1 } from "./types-CB02460N.js";
import { a as removeAckReactionAfterReply, d as resolveHumanDelayConfig, i as createAckReactionHandle, l as resolveAgentIdentity, o as removeAckReactionHandleAfterReply, s as shouldAckReaction, u as resolveEffectiveMessagesConfig } from "./ack-reactions-BHoYAs2o.js";
import { n as loadWebMedia, s as getImageMetadata, u as resizeToJpeg } from "./web-media-Cy5rLeK4.js";
import { t as detectMime } from "./mime-DQ7_7W8X.js";
import { a as MediaUnderstandingRuntime } from "./runtime-types-MShxPzCI.js";
import { n as PluginActivationSource } from "./config-activation-shared-BIz277Uz.js";
import { n as InboundLastRouteUpdate, r as RecordInboundSession$1, t as buildPairingReply } from "./pairing-messages-CRtK33ig.js";
import { i as shouldComputeCommandAuthorized, r as isControlCommandMessage, t as hasControlCommand } from "./command-detection-DCu9-Oak.js";
import { t as convertMarkdownTables } from "./tables-BAppoNmX.js";
import { o as resolveEnvelopeFormatOptions, r as formatAgentEnvelope } from "./envelope-D9O9ngOv.js";
import { s as saveMediaBuffer, t as SavedMedia } from "./store-DTMYuThs.js";
import { n as resolveChannelGroupPolicy, r as resolveChannelGroupRequireMention } from "./group-policy-6ZNr3EhF.js";
import { n as createInboundDebouncer, r as resolveInboundDebounceMs } from "./inbound-debounce-BdL855zp.js";
import { n as ChannelDeliveryResult } from "./delivery-outcome-DBEkbB4Y.js";
import { n as shouldHandleTextCommands } from "./commands-text-routing-lNSBe7Kk.js";
import "./reply-payload-3AoiLY6q.js";
import "./config-schema-MpDk-AfL.js";
import "./setup-helpers-xUpeGrEH.js";
import "./config-helpers-CSloNEEf.js";
import "./helpers-CR-HZbL7.js";
import "./date-time-BHGsvIVL.js";
import "./secret-file-Ca0i4dBQ.js";
import "./channel-contract-NE6kbQ_Q.js";
import { r as GatewayConnectionDetails } from "./client-BgkkQfqS.js";
import "./agent-scope-runtime-CdwMCzNM.js";
import { Static, TSchema, Type as Type$1 } from "typebox";
import { ZodTypeAny, z } from "zod";
import { DatabaseSync } from "node:sqlite";
import { Selectable } from "kysely";
import { MessagePort } from "node:worker_threads";
import { execSync } from "node:child_process";
import { Socket } from "node:net";
import "execa";
import { Duplex, Readable, Writable } from "node:stream";
import { WebSocket } from "ws";
import { Root } from "@openclaw/fs-safe/root";
import "@openclaw/ai/validation";
import { IncomingMessage, ServerResponse } from "node:http";
import { AutocompleteItem, AutocompleteProvider, Component, EditorComponent, EditorTheme, KeyId, KeybindingsConfig, KeybindingsManager, OverlayHandle, OverlayOptions, TUI, TUI_KEYBINDINGS } from "@earendil-works/pi-tui";
import "@openclaw/ai";
import "@openclaw/ai/internal/runtime";
import "@openclaw/ai/internal/shared";
import "typebox/error";
import { CallToolResult, GetPromptResult, ListResourceTemplatesResult, ListToolsResult } from "@modelcontextprotocol/sdk/types.js";
import "@openclaw/fs-safe/file-lock";
import { Command } from "commander";
import { RuntimeToolInputSchemaJson, RuntimeToolInputSchemaProjection, projectRuntimeToolInputSchema } from "@openclaw/ai/internal/tool-schema";
//#region src/infra/sqlite-worker-state-context.d.ts
/** Resolved host facts for the canonical shared-state owner, never authority. */
type SqliteWorkerStateContext = {
environment: NodeJS.ProcessEnv & {
OPENCLAW_STATE_DIR: string;
OPENCLAW_SUPERVISOR_MODE?: "external";
};
/** Selected config inputs for native shared-state initialization, not command environment. */
initializationEnvironment?: NodeJS.ProcessEnv;
/** Known agent paths preserve deletion-history uncertainty during native initialization. */
initializationAgentPaths?: readonly string[];
existingSchemaPath?: string;
};
//#endregion
//#region src/state/openclaw-state-worker-context.types.d.ts
type OpenClawStateWorkerContext = Omit<SqliteWorkerStateContext, "environment"> & {
environment: {
OPENCLAW_STATE_DIR: string;
OPENCLAW_SUPERVISOR_MODE?: "external";
};
admission: OpenClawStateDatabaseReadAdmission;
/** Host-only captured scope; reentry never extends the original admission lifetime. */
runInCapturedSchemaScope?: <T>(operation: () => T) => T;
/** Host-only ownership; workers request live schema grants through their job admission. */
maintenanceScope?: OpenClawDatabaseMaintenanceScope;
};
//#endregion
//#region src/agents/agent-run-terminal-outcome.d.ts
type AgentRunAttemptFailureSource = "prompt" | "compaction" | "precheck" | "hook:before_agent_run";
type AgentRunAttemptFailure = {
source: AgentRunAttemptFailureSource;
error: unknown;
};
type AgentRunAttemptTimeoutObservation = "compaction" | "tool_execution";
type AgentRunAttemptTimeoutSource = "runtime" | "run_budget" | "idle" | "external";
type AgentRunAttemptSettlementWarning = {
pendingStage: string;
elapsedMs: number;
timeoutMs: number;
};
type AgentRunAttemptTerminal = {
kind: "ok";
settlementWarning?: AgentRunAttemptSettlementWarning;
} | {
kind: "aborted";
source: "runtime" | "external" | "yield_cleanup";
failure?: AgentRunAttemptFailure;
timeoutObservation?: AgentRunAttemptTimeoutObservation;
} | {
kind: "timeout";
/** Non-terminal observations preserve timeout detail without interrupting the attempt. */
phase: AgentRunAttemptTimeoutObservation;
source: "observation";
failure?: AgentRunAttemptFailure;
} | {
kind: "timeout";
phase: "prompt" | AgentRunAttemptTimeoutObservation;
source: AgentRunAttemptTimeoutSource;
/** Present only when timeout handling also aborted the live harness run. */
aborted?: true;
failure?: AgentRunAttemptFailure;
} | {
kind: "failed";
source: AgentRunAttemptFailureSource;
error: unknown;
timeoutObservation?: AgentRunAttemptTimeoutObservation;
};
type LegacyAgentRunAttemptTerminalInput = {
settlementWarning?: AgentRunAttemptSettlementWarning;
aborted?: boolean;
externalAbort?: boolean;
idleTimedOut?: boolean;
promptError?: unknown;
promptErrorSource?: AgentRunAttemptFailureSource | null;
timedOut?: boolean;
timedOutByRunBudget?: boolean;
timedOutDuringCompaction?: boolean;
timedOutDuringToolExecution?: boolean;
};
/** Replaces attempt failure detail without changing a stronger interruption. */
declare function setAgentRunAttemptTerminalFailure(terminal: AgentRunAttemptTerminal, failure: AgentRunAttemptFailure | null): AgentRunAttemptTerminal;
/** Merges attempt observations while keeping terminal precedence in one owner. */
declare function mergeAgentRunAttemptTerminal(current: AgentRunAttemptTerminal, incoming: AgentRunAttemptTerminal): AgentRunAttemptTerminal;
/** Normalizes the shipped harness result shape at the Plugin SDK boundary. */
declare function normalizeAgentRunAttemptTerminal(input: LegacyAgentRunAttemptTerminalInput): AgentRunAttemptTerminal;
/** Projects the closed attempt terminal into legacy event/meta fields. */
declare function projectAgentRunAttemptTerminal(terminal: AgentRunAttemptTerminal): {
settlementWarning?: AgentRunAttemptSettlementWarning | undefined;
aborted: boolean;
cleanupYieldAborted: boolean;
externalAbort: boolean;
failed: boolean;
idleTimedOut: boolean;
interrupted: boolean;
promptError: unknown;
promptErrorSource: AgentRunAttemptFailureSource | null;
timedOut: boolean;
timedOutByRunBudget: boolean;
timedOutDuringCompaction: boolean;
timedOutDuringToolExecution: boolean;
};
//#endregion
//#region src/state/openclaw-agent-db-contract.d.ts
/** Open per-agent SQLite database handle plus lifecycle maintenance. */
type OpenClawAgentDatabase = {
agentId: string;
db: DatabaseSync;
path: string;
walMaintenance: SqliteWalMaintenance;
};
/** Options for resolving and opening one agent database. */
type OpenClawAgentDatabaseOptions = OpenClawStateDatabaseOptions & {
agentId: string;
};
//#endregion
//#region src/auto-reply/reply/reply-dispatch-outcome.types.d.ts
type ReplyDispatchDeliveryOutcome = "delivered" | "delivered-not-visible" | "channel-transform" | "cancelled" | "failed-before-deliver" | "recovery-owned" | "failed-deliver";
//#endregion
//#region src/gateway/agent-runtime-session-spawn-context.d.ts
/** Automatic intent bound to the complete request before creation resolves aliases. */
type AgentRuntimeSpawnModelAutoSelection = {
model: string;
/** Self-origin distinguishes configured selection from legacy fallback residue. */
hasFallbackOrigin: boolean;
};
type AgentRuntimeSessionSpawnContext = {
/** Host-verified human requester; inherited ownership still requires a matching parent owner. */
requesterProfileId?: string;
completionOwnerSessionKey?: string;
resolvedModel?: ProviderModelRef;
inheritedPermissionMode?: SessionPermissionMode;
inheritedToolPolicy: {
version: 1;
allow: string[];
deny: string[];
};
spawnModelAutoSelection?: AgentRuntimeSpawnModelAutoSelection;
};
//#endregion
//#region src/gateway/cron-creator-authority-grant.types.d.ts
type CronCreatorAuthorityGrant = Readonly<{
runId: string;
token: string;
}>;
/** Private native sender fact shared by creator grants and the stored job envelope. */
type CronAuthenticatedChannelRequester = {
version: 1;
channel: string;
accountId: string;
senderId: string;
};
//#endregion
//#region src/agents/scheduled-tool-policy.d.ts
/** Trusted runtime context for a scheduled run with a server-stamped tool cap. */
type ScheduledToolPolicyContext = (Extract<CronScheduledToolPolicy, {
mode: "trusted";
}> | (Extract<CronScheduledToolPolicy, {
mode: "account";
}> & {
/** Missing legacy runtime contexts are treated as unknown and fail closed. */
ownerOrigin?: CronScheduledToolCallerOrigin;
})) & {
/** Restrict-only policy for the rebuilt exec tool; absence keeps baseline exec. */
execTarget?: {
host: "gateway";
ask?: "always";
};
};
//#endregion
//#region src/channels/threading-tool-context-internal.d.ts
/** Host-only turn correlation carried beside the plugin-facing threading contract. */
type InternalChannelThreadingToolContext = ChannelThreadingToolContext & {
currentSourceTurnId?: string;
};
//#endregion
//#region src/gateway/message-action-turn-capability.d.ts
/** Private handoff from authenticated dashboard admission to the exact reply run. */
type DashboardMessageReadAdmission = Readonly<{
agentId: string;
runId: string;
sessionKey: string;
sessionId?: string;
assertCurrent: () => void;
}>;
type MessageActionRequesterIdentity = {
requesterAccountId?: string;
requesterSenderId?: string;
requesterSenderName?: string;
requesterSenderUsername?: string;
requesterSenderE164?: string;
};
type AgentRuntimeMessageActionContextBase = MessageActionRequesterIdentity & {
expiresAtMs: number;
/** Process-local owner reference revalidated before privileged Gateway use. */
turnCapability?: string;
sessionId?: string;
/** Durable session entry that owns restart-recovery receipt state. */
sourceReplySessionKey?: string;
toolContext?: InternalChannelThreadingToolContext;
};
type AgentRuntimeMessageActionContext = AgentRuntimeMessageActionContextBase & ({
sourceReplyFinal: true;
sourceReplyToolCallId: string;
} | {
sourceReplyFinal?: false;
sourceReplyToolCallId?: string;
});
//#endregion
//#region src/gateway/worker-environments/placement-state.d.ts
declare const WORKER_SESSION_PLACEMENT_STATES: readonly ["local", "requested", "provisioning", "syncing", "starting", "active", "draining", "reconciling", "reclaimed", "failed"];
type WorkerSessionPlacementState = (typeof WORKER_SESSION_PLACEMENT_STATES)[number];
//#endregion
//#region src/gateway/worker-environments/workspace-conflicts.d.ts
type WorkerWorkspaceResultConflict = {
paths: string[];
stagedResultRef: string;
totalCount?: number;
};
//#endregion
//#region src/gateway/worker-environments/placement-record.d.ts
type WorkerSessionPlacementIdentity = {
sessionId: string;
agentId: string;
sessionKey: string;
};
type WorkerSessionPlacementChangeSnapshot = WorkerSessionPlacementIdentity & {
state: WorkerSessionPlacementState;
generation: number;
updatedAtMs: number;
};
type WorkerPlacementExecutionMode = "worker-turn" | "remote-exec";
type WorkerSessionPlacementDispatchIdentity = WorkerSessionPlacementIdentity & {
executionMode?: WorkerPlacementExecutionMode;
expectedPlacement?: Pick<WorkerSessionPlacementRecord, "state" | "generation" | "environmentId" | "activeOwnerEpoch">;
};
type WorkerSessionTurnOwner = {
kind: "local";
environmentId?: string;
ownerEpoch?: number;
} | {
kind: "worker";
environmentId: string;
ownerEpoch: number;
};
type WorkerTurnClaimInput = WorkerSessionPlacementIdentity & {
owner: WorkerSessionTurnOwner;
claimId: string;
runId: string;
};
type WorkerSessionTurnClaim = {
sessionId: string;
claimId: string;
runId: string;
placementGeneration: number;
owner: WorkerSessionTurnOwner;
};
type PersistedTurnClaim = {
owner: "local";
claimId: string;
runId: string;
generation: number;
ownerEpoch: null;
} | {
owner: "worker";
claimId: string;
runId: string;
generation: number;
ownerEpoch: number;
};
type PersistedLocalTurnClaim = Extract<PersistedTurnClaim, {
owner: "local";
}>;
type PlacementRecordBase<TurnClaim extends PersistedTurnClaim | null> = WorkerSessionPlacementIdentity & {
generation: number;
executionMode: WorkerPlacementExecutionMode;
turnClaim: TurnClaim;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
/** Process-local UI projection; deliberately absent from SQLite. */
workspaceResultConflict?: WorkerWorkspaceResultConflict;
};
type UnclaimedPlacementRecordBase = PlacementRecordBase<null>;
type LocalClaimablePlacementRecordBase = PlacementRecordBase<PersistedLocalTurnClaim | null>;
type EmptyWorkerPlacementMetadata = {
environmentId: null;
activeOwnerEpoch: null;
workspaceBaseManifestRef: null;
remoteWorkspaceDir: null;
workerBundleHash: null;
lastTranscriptAckCursor: null;
lastLiveEventAckCursor: null;
recoveryError: null;
terminalReason: null;
terminalAtMs: null;
};
type ProvisioningPlacementMetadata = Omit<EmptyWorkerPlacementMetadata, "environmentId"> & {
environmentId: string | null;
};
type SyncingPlacementMetadata = Omit<EmptyWorkerPlacementMetadata, "environmentId" | "workerBundleHash"> & {
environmentId: string;
workerBundleHash: string;
};
type StartingPlacementMetadata = Omit<SyncingPlacementMetadata, "workspaceBaseManifestRef" | "remoteWorkspaceDir"> & {
workspaceBaseManifestRef: string;
remoteWorkspaceDir: string;
};
type OwnedWorkerPlacementMetadata = Omit<StartingPlacementMetadata, "activeOwnerEpoch" | "lastTranscriptAckCursor" | "lastLiveEventAckCursor"> & {
activeOwnerEpoch: number;
lastTranscriptAckCursor: number | null;
lastLiveEventAckCursor: number | null;
};
type TerminalPlacementMetadata = {
environmentId: string | null;
activeOwnerEpoch: number | null;
workspaceBaseManifestRef: string | null;
remoteWorkspaceDir: string | null;
workerBundleHash: string | null;
lastTranscriptAckCursor: number | null;
lastLiveEventAckCursor: number | null;
terminalReason: string | null;
terminalAtMs: number | null;
};
type PlacementRecordsByState = {
local: LocalClaimablePlacementRecordBase & EmptyWorkerPlacementMetadata;
requested: LocalClaimablePlacementRecordBase & EmptyWorkerPlacementMetadata;
provisioning: UnclaimedPlacementRecordBase & ProvisioningPlacementMetadata;
syncing: UnclaimedPlacementRecordBase & SyncingPlacementMetadata;
starting: UnclaimedPlacementRecordBase & StartingPlacementMetadata;
active: PlacementRecordBase<PersistedTurnClaim | null> & OwnedWorkerPlacementMetadata;
draining: PlacementRecordBase<PersistedTurnClaim | null> & OwnedWorkerPlacementMetadata;
reconciling: UnclaimedPlacementRecordBase & OwnedWorkerPlacementMetadata;
reclaimed: UnclaimedPlacementRecordBase & Omit<OwnedWorkerPlacementMetadata, "terminalReason" | "terminalAtMs"> & TerminalPlacementMetadata;
failed: LocalClaimablePlacementRecordBase & TerminalPlacementMetadata & {
recoveryError: string;
};
};
type WorkerSessionPlacementRecord = { [State in WorkerSessionPlacementState]: PlacementRecordsByState[State] & {
state: State;
}; }[WorkerSessionPlacementState];
type WorkerSessionPlacementTransitionPatch = {
environmentId?: string | null;
activeOwnerEpoch?: number | null;
workspaceBaseManifestRef?: string | null;
remoteWorkspaceDir?: string | null;
workerBundleHash?: string | null;
lastTranscriptAckCursor?: number | null;
lastLiveEventAckCursor?: number | null;
recoveryError?: string | null;
terminalReason?: string | null;
};
//#endregion
//#region src/gateway/agent-runtime-identity-token.d.ts
type AgentRuntimeCronSelfManagementContext = {
jobId: string;
expiresAtMs: number;
};
type AgentRuntimeIdentity = {
kind: "agentRuntime";
agentId: string;
sessionKey: string;
operationalRunInstance: OperationalRunInstanceRef;
delegatedAuthority: AgentRuntimeDelegatedAuthority;
approvalOwnerPluginId?: string;
executionIdentity?: ExecutionIdentityAdmissionToken;
turnSourceChannel?: string;
/** Explicit admission fact; omission is unknown, never inferred from session routing. */
turnSourceLocal?: true;
turnSourceTo?: string;
turnSourceAccountId?: string;
turnSourceThreadId?: string | number;
gatewayUiCommandTarget?: GatewayUiCommandTarget;
messageActionContext?: AgentRuntimeMessageActionContext;
cronSelfManagementContext?: AgentRuntimeCronSelfManagementContext;
cronToolsAllowCapture?: "final-executable-surface";
cronExecToolTarget?: {
host: "gateway";
ask?: "always";
};
cronCreatorAuthorityGrant?: CronCreatorAuthorityGrant;
cronManagementGrant?: CronCreatorAuthorityGrant;
sessionSpawnContext?: AgentRuntimeSessionSpawnContext;
};
type AgentRuntimeDelegatedAuthority = AgentRunDelegatedAuthority & ({
kind: "local";
} | {
kind: "worker";
turnClaim: WorkerSessionTurnClaim;
});
//#endregion
//#region src/agents/tools/gateway.d.ts
/** Optional gateway connection overrides accepted by agent tools. */
type GatewayCallOptions = {
gatewayUrl?: string;
gatewayToken?: string;
timeoutMs?: number;
};
/** Presentation hint from the admitted operator source; RPC admission remains authoritative. */
declare function readGatewayToolOperatorScopes(): readonly string[] | undefined;
/**
* Calls a gateway method as the agent-tool backend client with least-privilege scopes.
*/
declare function callGatewayTool<T = Record<string, unknown>>(method: string, opts: GatewayCallOptions, params?: unknown, extra?: {
expectFinal?: boolean;
scopes?: OperatorScope[];
requireAgentRuntimeIdentity?: boolean;
signal?: AbortSignal;
dispatchAuthority?: {
version: 2;
kind: "run" | "source-bound";
assertCurrent: () => void;
};
}): Promise<T>;
//#endregion
//#region src/agents/tools/computer-tool-gateway.d.ts
type GatewayComputerStatus$1 = {
configured: false;
available: false;
} | {
configured: true;
available: false;
error?: string;
} | {
configured: true;
available: true;
computerUse: ComputerUseCapabilityDescriptor;
};
//#endregion
//#region src/agents/tools/computer-tool-shared.d.ts
declare const COMPUTER_ACT_COMMAND = "computer.act";
declare const SCREEN_SNAPSHOT_COMMAND = "screen.snapshot";
/** The owner binds the execution target and revalidates its authority before every dispatch. */
type ComputerToolTransport = {
readonly computerUse?: ComputerUseCapabilityDescriptor;
resolveNode: (query?: string, signal?: AbortSignal) => Promise<{
nodeId: string;
computerUse?: ComputerUseCapabilityDescriptor;
}>;
invoke: (params: {
nodeId: string;
command: typeof COMPUTER_ACT_COMMAND | typeof SCREEN_SNAPSHOT_COMMAND;
commandParams: Record<string, unknown>;
timeoutMs?: number;
idempotencyKey?: string;
signal?: AbortSignal;
}) => Promise<unknown>;
};
//#endregion
//#region src/agents/tools/nodes-utils.d.ts
type DefaultNodeFallback = "none" | "first";
type DefaultNodeSelectionOptions = {
capability?: string;
fallback?: DefaultNodeFallback;
preferLocalMac?: boolean;
};
/** Selects the implicit node target when a tool call omits an explicit node query. */
declare function selectDefaultNodeFromList(nodes: NodeListNode[], options?: DefaultNodeSelectionOptions): NodeListNode | null;
/** Lists the Gateway node inventory. */
declare function listNodes(opts: GatewayCallOptions, signal?: AbortSignal): Promise<NodeListNode[]>;
/** Resolves a node id from an already-loaded node list using shared node matching rules. */
declare function resolveNodeIdFromList(nodes: NodeListNode[], query?: string, allowDefault?: boolean, options?: {
allowCompactDisplayName?: boolean;
}): string;
//#endregion
//#region src/agents/computer-use-node-capabilities.d.ts
type PreparedPairedComputerUse = {
actions: readonly ComputerUseV2ActionName[];
guidanceCapabilities?: ComputerUseCapabilityDescriptor;
gateway?: GatewayComputerStatus$1;
};
//#endregion
//#region src/plugins/runtime/tool-grant.d.ts
/** Owner-scoped additive plugin tools for one trusted agent run. */
type RuntimePluginToolGrant = {
pluginId: string;
toolNames: readonly string[];
};
//#endregion
//#region src/agents/tool-policy-shared.d.ts
/** Expands named tool groups into concrete tool ids. */
declare function expandToolGroups(list?: string[]): string[];
//#endregion
//#region src/agents/agent-roles.d.ts
declare const AGENT_ROLES: readonly ["coordinator", "researcher", "writer", "reviewer"];
type AgentRoleId = (typeof AGENT_ROLES)[number];
//#endregion
//#region src/system-agent/operation-types.d.ts
/** Parsed OpenClaw operation before approval/execution. */
type SystemAgentOperation = {
kind: "none";
message: string;
} | {
kind: "overview";
} | {
kind: "doctor";
} | {
kind: "doctor-fix";
} | {
kind: "status";
} | {
kind: "health";
} | {
kind: "config-validate";
} | {
kind: "config-get";
path: string;
} | {
kind: "config-schema";
path?: string;
} | {
kind: "config-unset";
path: string;
} | {
kind: "config-set";
path: string;
value: string;
} | {
kind: "config-set-ref";
path: string;
source: "env" | "file" | "exec" | "store";
id: string;
provider?: string;
/** Value the owner supplied; stored as secret-store entry `id` before the ref is written. */
secret?: string;
} | {
kind: "setup";
workspace?: string;
model?: string;
agentName?: string;
} | SystemAgentNavigationOperation | {
kind: "channel-list";
} | {
kind: "channel-info";
channel: string;
} | {
kind: "gateway-status";
} | {
kind: "gateway-start";
} | {
kind: "gateway-stop";
} | {
kind: "gateway-restart";
} | {
kind: "agents";
} | {
kind: "models";
} | {
kind: "plugin-list";
} | {
kind: "plugin-search";
query: string;
} | {
kind: "plugin-install";
spec: string;
} | {
kind: "plugin-activate-artifact";
path: string;
sha256: string;
} | {
kind: "plugin-uninstall";
pluginId: string;
} | {
kind: "audit";
} | {
kind: "create-agent";
agentId: string;
name?: string;
purpose?: string;
role?: AgentRoleId;
workspace?: string;
model?: string;
requesterAgentId?: string;
} | {
kind: "create-team";
coordinatorId?: string;
prefix?: string;
workspaceRoot?: string;
} | {
kind: "set-default-model";
model: string;
agentId?: string;
};
/** Interactive actions owned by the host chat, never by delegated model turns. */
type SystemAgentNavigationOperation = {
kind: "model-setup";
workspace?: string;
} | {
kind: "model-accounts";
} | {
kind: "channel-setup";
channel: string;
} | {
kind: "skills-setup";
} | {
kind: "search-setup";
} | {
kind: "gateway-config-setup";
} | {
kind: "memory-import";
} | {
kind: "open-setup";
target: "guided" | "classic" | "channels" | "search" | "gateway";
channel?: string;
} | {
kind: "open-tui";
agentId?: string;
workspace?: string;
agentDraft?: "hatch";
};
//#endregion
//#region src/acp/persistent-bindings.types.d.ts
type ConfiguredAcpBindingChannel = ChannelId$1;
/** Normalized configured binding that maps one channel conversation to one ACP session. */
type ConfiguredAcpBindingSpec = {
channel: ConfiguredAcpBindingChannel;
accountId: string;
conversationId: string;
parentConversationId?: string;
/** Owning OpenClaw agent id (used for session identity/storage). */
agentId: string;
/** ACP harness agent id override (falls back to agentId when omitted). */
acpAgentId?: string;
mode: AcpRuntimeSessionMode;
model?: string;
/** Owner agent's effective thinking default, forwarded as the ACP session's thinking runtime option. */
thinking?: string;
cwd?: string;
backend?: string;
label?: string;
};
type ResolvedConfiguredAcpBinding = {
spec: ConfiguredAcpBindingSpec;
record: SessionBindingRecord;
};
//#endregion
//#region src/plugins/plugin-command-dispatch-contract.d.ts
/** Lightweight reply-option contract for prepared plugin command ownership. */
declare const PLUGIN_COMMAND_DISPATCH: unique symbol;
type PluginCommandReplyOptions = Readonly<{
[PLUGIN_COMMAND_DISPATCH]?: Readonly<{
kind: "plugin" | "non-plugin";
}>;
}>;
//#endregion
//#region packages/media-generation-core/src/normalization.d.ts
/** Primitive value types reported in media generation normalization metadata. */
type MediaNormalizationValue = string | number | boolean;
/** Requested/applied value pair plus provenance for a normalized media option. */
type MediaNormalizationEntry<TValue extends MediaNormalizationValue> = {
requested?: TValue;
applied?: TValue;
derivedFrom?: string;
supportedValues?: readonly TValue[];
};
//#endregion
//#region src/image-generation/types.d.ts
/** Non-empty binary image asset returned by an image-generation provider. */
type GeneratedImageAsset = {
buffer: Buffer;
mimeType: string;
fileName?: string;
revisedPrompt?: string;
metadata?: Record<string, unknown>;
};
type ImageGenerationResolution = "1K" | "2K" | "4K";
type ImageGenerationQuality = "low" | "medium" | "high" | "xhigh" | "max" | "auto";
type ImageGenerationOutputFormat = "png" | "jpeg" | "webp";
type ImageGenerationBackground = "transparent" | "opaque" | "auto";
type ImageGenerationOpenAIBackground = ImageGenerationBackground;
type ImageGenerationOpenAIModeration = "low" | "auto";
type ImageGenerationOpenAIOptions = {
background?: ImageGenerationOpenAIBackground;
moderation?: ImageGenerationOpenAIModeration;
outputCompression?: number;
user?: string;
};
type ImageGenerationProviderOptions = Record<string, unknown> & {
openai?: ImageGenerationOpenAIOptions;
};
type ImageGenerationIgnoredOverrideKey = "size" | "aspectRatio" | "resolution" | "quality" | "outputFormat" | "background";
type ImageGenerationIgnoredOverride = {
key: ImageGenerationIgnoredOverrideKey;
value: string;
};
type ImageGenerationSourceImage = {
buffer: Buffer;
mimeType: string;
fileName?: string;
metadata?: Record<string, unknown>;
};
type ImageGenerationProviderConfiguredContext = {
cfg?: OpenClawConfig;
agentDir?: string;
};
/** Runtime request passed to an image-generation provider implementation. */
type ImageGenerationRequest = {
provider: string;
model: string;
prompt: string;
cfg: OpenClawConfig;
agentDir?: string;
authStore?: AuthProfileStore;
timeoutMs?: number;
count?: number;
size?: string;
aspectRatio?: string;
resolution?: ImageGenerationResolution;
quality?: ImageGenerationQuality;
outputFormat?: ImageGenerationOutputFormat;
background?: ImageGenerationBackground;
inputImages?: ImageGenerationSourceImage[];
providerOptions?: ImageGenerationProviderOptions;
ssrfPolicy?: SsrFPolicy;
};
type ImageGenerationResult = {
images: GeneratedImageAsset[];
model?: string;
metadata?: Record<string, unknown>;
};
type ImageGenerationModeCapabilities = {
maxCount?: number;
supportsSize?: boolean;
supportsAspectRatio?: boolean;
supportsResolution?: boolean;
};
type ImageGenerationEditCapabilities = ImageGenerationModeCapabilities & {
enabled: boolean;
maxInputImages?: number;
maxInputImagesByModel?: Readonly<Record<string, number>>;
maxInputImagesByModelPrefix?: Readonly<Record<string, number>>;
};
type ImageGenerationGeometryCapabilities = {
sizes?: string[];
sizesByModel?: Record<string, string[]>;
aspectRatios?: string[];
aspectRatiosByModel?: Record<string, string[]>;
resolutions?: ImageGenerationResolution[];
resolutionsByModel?: Record<string, ImageGenerationResolution[]>;
};
type ImageGenerationOutputCapabilities = {
qualities?: ImageGenerationQuality[];
qualitiesByModel?: Record<string, ImageGenerationQuality[]>;
formats?: ImageGenerationOutputFormat[];
formatsByModel?: Record<string, ImageGenerationOutputFormat[]>;
backgrounds?: ImageGenerationBackground[];
backgroundsByModel?: Record<string, ImageGenerationBackground[]>;
};
type ImageGenerationNormalization = {
size?: MediaNormalizationEntry<string>;
aspectRatio?: MediaNormalizationEntry<string>;
resolution?: MediaNormalizationEntry<ImageGenerationResolution>;
};
type ImageGenerationProviderCapabilities = {
generate: ImageGenerationModeCapabilities;
edit: ImageGenerationEditCapabilities;
geometry?: ImageGenerationGeometryCapabilities;
output?: ImageGenerationOutputCapabilities;
};
type ImageGenerationProvider = {
id: string;
aliases?: string[];
label?: string;
defaultModel?: string;
/** Default provider operation timeout in milliseconds when caller/config omit timeoutMs. */
defaultTimeoutMs?: number;
models?: string[];
capabilities: ImageGenerationProviderCapabilities;
isConfigured?: (ctx: ImageGenerationProviderConfiguredContext) => boolean;
generateImage: (req: ImageGenerationRequest) => Promise<ImageGenerationResult>;
};
//#endregion
//#region src/music-generation/types.d.ts
/**
* Public music generation provider contracts.
*
* Providers implement these request/result/capability shapes so the core
* runtime can normalize prompts, options, assets, and fallback diagnostics.
*/
/** Audio output formats currently understood by music generation providers. */
type MusicGenerationOutputFormat = "mp3" | "wav";
/** Non-empty in-memory audio asset returned from a music generation provider. */
type GeneratedMusicAsset = {
buffer: Buffer;
mimeType: string;
fileName?: string;
metadata?: Record<string, unknown>;
};
/** Optional source image passed to image-conditioned music edit models. */
type MusicGenerationSourceImage = {
url?: string;
buffer?: Buffer;
mimeType?: string;
fileName?: string;
metadata?: Record<string, unknown>;
};
type MusicGenerationProviderConfiguredContext = {
cfg?: OpenClawConfig;
agentDir?: string;
};
/** Provider request after runtime fallback and override normalization. */
type MusicGenerationRequest = {
provider: string;
model: string;
prompt: string;
cfg: OpenClawConfig;
agentDir?: string;
authStore?: AuthProfileStore;
timeoutMs?: number;
lyrics?: string;
instrumental?: boolean;
durationSeconds?: number;
format?: MusicGenerationOutputFormat;
inputImages?: MusicGenerationSourceImage[];
};
/** Provider result before runtime fallback metadata is attached. */
type MusicGenerationResult = {
tracks: GeneratedMusicAsset[];
model?: string;
lyrics?: string[];
metadata?: Record<string, unknown>;
};
/** Caller override dropped because the selected provider/model does not support it. */
type MusicGenerationIgnoredOverride = {
key: "lyrics" | "instrumental" | "durationSeconds" | "format";
value: string | boolean | number;
};
/** Capability block for prompt-only music generation. */
type MusicGenerationModeCapabilities = {
maxTracks?: number;
maxDurationSeconds?: number;
supportsLyrics?: boolean;
supportsLyricsByModel?: Readonly<Record<string, boolean>>;
supportsInstrumental?: boolean;
supportsInstrumentalByModel?: Readonly<Record<string, boolean>>;
supportsDuration?: boolean;
supportsFormat?: boolean;
supportedFormats?: readonly MusicGenerationOutputFormat[];
supportedFormatsByModel?: Readonly<Record<string, readonly MusicGenerationOutputFormat[]>>;
};
/** Capability block for image-conditioned music generation. */
type MusicGenerationEditCapabilities = MusicGenerationModeCapabilities & {
enabled: boolean;
maxInputImages?: number;
};
/** Provider capability declaration, including optional mode-specific overrides. */
type MusicGenerationProviderCapabilities = MusicGenerationModeCapabilities & {
maxInputImages?: number;
generate?: MusicGenerationModeCapabilities;
edit?: MusicGenerationEditCapabilities;
};
/** Normalization metadata attached to runtime results. */
type MusicGenerationNormalization = {
durationSeconds?: MediaNormalizationEntry<number>;
};
/** Provider implementation contract consumed by the music generation runtime. */
type MusicGenerationProvider = {
id: string;
aliases?: string[];
label?: string;
defaultModel?: string;
models?: string[];
capabilities: MusicGenerationProviderCapabilities;
isConfigured?: (ctx: MusicGenerationProviderConfiguredContext) => boolean;
generateMusic: (req: MusicGenerationRequest) => Promise<MusicGenerationResult>;
};
//#endregion
//#region src/realtime-transcription/provider-types.d.ts
type RealtimeTranscriptionProviderId = string;
type RealtimeTranscriptionProviderConfig = Record<string, unknown>;
type RealtimeTranscriptionProviderResolveConfigContext = {
cfg: OpenClawConfig;
rawConfig: RealtimeTranscriptionProviderConfig;
};
type RealtimeTranscriptionProviderConfiguredContext = {
cfg?: OpenClawConfig;
providerConfig: RealtimeTranscriptionProviderConfig;
};
/** Callback hooks emitted by realtime transcription sessions. */
type RealtimeTranscriptionSessionCallbacks = {
onPartial?: (partial: string) => void;
onTranscript?: (transcript: string) => void;
onSpeechStart?: () => void;
onError?: (error: Error) => void;
};
/** Inputs passed to a provider when creating a transcription session. */
type RealtimeTranscriptionSessionCreateRequest = RealtimeTranscriptionSessionCallbacks & {
cfg?: OpenClawConfig;
providerConfig: RealtimeTranscriptionProviderConfig;
};
/** Runtime control surface for a realtime transcription session. */
type RealtimeTranscriptionSession = {
connect(): Promise<void>;
sendAudio(audio: Buffer): void;
close(): void;
isConnected(): boolean;
};
//#endregion
//#region src/talk/audio-output-port.d.ts
/** A call-bound mono PCM16/24kHz sink. Transfer port; share state, never transfer it.
* The first Int32 is a close fence: zero permits audio, one permanently revokes it.
* The receiver checks it before playback and acknowledges each accepted audio message.
*/
type RealtimeVoiceAudioOutputPort = {
port: MessagePort;
state: SharedArrayBuffer;
};
//#endregion
//#region src/talk/provider-types.d.ts
type RealtimeVoiceProviderId = string;
type RealtimeVoiceRole = "user" | "assistant";
type RealtimeVoiceCloseReason = "completed" | "error";
type RealtimeVoiceAudioFormat = {
encoding: "g711_ulaw";
sampleRateHz: 8000;
channels: 1;
} | {
encoding: "pcm16";
sampleRateHz: 24000;
channels: 1;
};
type RealtimeVoiceTool = {
type: "function";
name: string;
description: string;
parameters: {
type: "object";
properties: Record<string, unknown>;
required?: string[];
};
};
type RealtimeVoiceToolCallEvent = {
itemId: string;
callId: string;
name: string;
args: unknown;
};
type RealtimeVoiceToolResultOptions = {
/**
* Submit the tool result without prompting the realtime provider to generate a new assistant
* response. Use when another channel has already delivered the user-visible answer.
*/
suppressResponse?: boolean;
willContinue?: boolean;
};
type RealtimeVoiceCloseDisposition = "abort" | "detach";
type RealtimeVoiceCloseOptions = {
/** Whether closing the transport also cancels work already accepted by the host. */
disposition?: RealtimeVoiceCloseDisposition;
};
type RealtimeVoiceBridgeEvent = {
direction: "client" | "server";
type: string;
detail?: string;
itemId?: string;
responseId?: string;
};
type RealtimeVoiceResponseError = {
code?: string;
message?: string;
type?: string;
};
type RealtimeVoiceResponseOutcomeBase = {
responseId?: string;
};
type RealtimeVoiceResponseOutcome = (RealtimeVoiceResponseOutcomeBase & {
status: "completed";
}) | (RealtimeVoiceResponseOutcomeBase & {
status: "cancelled";
reason?: string;
}) | (RealtimeVoiceResponseOutcomeBase & {
status: "failed" | "incomplete";
reason?: string;
error?: RealtimeVoiceResponseError;
message: string;
});
type RealtimeVoiceAudioClearReason = "barge-in";
type RealtimeVoiceAudioChunkMetadata = {
itemId: string;
};
type RealtimeVoicePlaybackItem = {
itemId: string;
audioEndMs: number;
};
type RealtimeVoiceBridgeCallbacks = {
onAudio: (audio: Buffer, metadata?: RealtimeVoiceAudioChunkMetadata) => void;
/** Retained native items in playback order; queued items have zero consumed duration.
* An empty snapshot is authoritative. Omit when the transport cannot measure playback.
*/
getPlaybackState?: () => readonly RealtimeVoicePlaybackItem[];
onClearAudio: (reason?: RealtimeVoiceAudioClearReason) => void;
/** Scoped acknowledgments are valid only for the provider connection that emitted the mark. */
onMark?: (markName: string, acknowledge?: () => void) => void;
/** Snapshot metadata replaces provisional text; omission retains incremental deltas. */
onTranscript?: (role: RealtimeVoiceRole, text: string, isFinal: boolean, metadata?: {
textMode: "snapshot";
}) => void;
/** Synchronously admits native control; only consult permits task fallthrough. Respond is call-bound. */
handleDelegationInput?: (text: string, respond: (message: string) => void) => "control" | "consult";
/** Diagnostic observation; returning from this callback cannot veto an event. */
onEvent?: (event: RealtimeVoiceBridgeEvent) => void;
onResponseDone?: (outcome: RealtimeVoiceResponseOutcome) => void;
onToolCall?: (event: RealtimeVoiceToolCallEvent) => void;
onReady?: () => void;
onError?: (error: Error) => void;
onClose?: (reason: RealtimeVoiceCloseReason) => void;
};
type RealtimeVoiceProviderConfig = Record<string, unknown>;
type RealtimeVoiceProviderCapabilities = {
transports: TalkTransport[];
inputAudioFormats: RealtimeVoiceAudioFormat[];
outputAudioFormats: RealtimeVoiceAudioFormat[];
supportsBrowserSession?: boolean;
supportsBargeIn?: boolean;
/** True when the provider owns interruption from incoming audio. */
handlesInputAudioBargeIn?: boolean;
supportsToolCalls?: boolean;
/** True when user transcripts are reliable enough to gate responses on a leading wake name. */
supportsActivationNameGating?: boolean;
supportsVideoFrames?: boolean;
supportsSessionResumption?: boolean;
};
type RealtimeVoiceProviderResolveConfigContext = {
cfg: OpenClawConfig;
rawConfig: RealtimeVoiceProviderConfig;
/** Host-selected agent scope for account-aware defaults. */
agentId?: string;
/** Runtime surface whose defaults are being resolved; omission retains bridge behavior. */
surface?: "browser-session" | "gateway-relay" | "bridge";
/** False when the host needs to control when audio input receives a response. */
autoRespondToAudio?: boolean;
/** Session requirements used to choose a compatible default model. */
requiredCapabilities?: Pick<RealtimeVoiceProviderCapabilities, "supportsVideoFrames">;
};
type RealtimeVoiceProviderConfiguredContext = {
cfg?: OpenClawConfig;
/** Host-selected agent scope for provider auth readiness. */
agentId?: string;
providerConfig: RealtimeVoiceProviderConfig;
};
type RealtimeVoiceAgentConsultRunner = (params: {
prompt: string;
signal?: AbortSignal;
}) => Promise<{
text: string;
}>;
type RealtimeVoiceBridgeCreateRequest = RealtimeVoiceBridgeCallbacks & {
cfg?: OpenClawConfig;
/** Host-selected agent scope for provider auth and agent-owned bridge state. */
agentId?: string;
providerConfig: RealtimeVoiceProviderConfig;
audioFormat?: RealtimeVoiceAudioFormat;
instructions?: string;
language?: string;
autoRespondToAudio?: boolean;
interruptResponseOnInputAudio?: boolean;
tools?: RealtimeVoiceTool[];
/** Host-injected agent delegation runner for provider-owned realtime control channels. */
runAgentConsult?: RealtimeVoiceAgentConsultRunner;
};
type RealtimeVoiceBrowserSessionCreateRequest = {
cfg?: OpenClawConfig;
providerConfig: RealtimeVoiceProviderConfig;
instructions?: string;
tools?: RealtimeVoiceTool[];
model?: string;
voice?: string;
vadThreshold?: number;
silenceDurationMs?: number;
prefixPaddingMs?: number;
reasoningEffort?: string;
/** Host-injected agent delegation runner for provider-owned realtime control channels. */
runAgentConsult?: RealtimeVoiceAgentConsultRunner;
} & ({
clientControl?: undefined;
gatewayControl?: RealtimeVoiceGatewayControl;
} | {
/** Explicit ownership requires command binding; lifecycle callbacks alone do not select it. */
clientControl: {
owner: "gateway";
};
gatewayControl: RealtimeVoiceGatewayControl & Required<Pick<RealtimeVoiceGatewayControl, "bindControl">>;
});
/** Narrow host/plugin seam for Gateway-owned control of a client-owned media session. */
type RealtimeVoiceGatewayControl = Omit<RealtimeVoiceBridgeCallbacks, "onAudio" | "onClearAudio" | "onMark" | "getPlaybackState"> & {
/** Bind only supported sideband commands; client-owned media needs no audio bridge. */
bindControl?: (control: Partial<Pick<RealtimeVoiceBridge, "submitToolResult" | "sendUserMessage">>) => void;
/** @deprecated Stable 2026.8.1 SDK contract; remove only with a versioned SDK break. */
bindBridge: (bridge: RealtimeVoiceBridge) => void;
};
type RealtimeVoiceBrowserAudioContract = {
inputEncoding: "pcm16" | "g711_ulaw";
inputSampleRateHz: number;
outputEncoding: "pcm16" | "g711_ulaw";
outputSampleRateHz: number;
};
type RealtimeVoiceBrowserSessionBase = {
provider: RealtimeVoiceProviderId;
model?: string;
voice?: string;
expiresAt?: number;
};
type RealtimeVoiceBrowserWebRtcSdpSession = RealtimeVoiceBrowserSessionBase & {
transport: "webrtc";
clientSecret: string;
offerUrl?: string;
offerHeaders?: Record<string, string>;
offerResponseMaxBytes?: number;
};
type RealtimeVoiceBrowserJsonPcmWebSocketSession = RealtimeVoiceBrowserSessionBase & {
transport: "provider-websocket";
protocol: string;
clientSecret: string;
websocketUrl: string;
audio: RealtimeVoiceBrowserAudioContract;
initialMessage?: unknown;
};
type RealtimeVoiceBrowserGatewayRelaySession = RealtimeVoiceBrowserSessionBase & {
transport: "gateway-relay";
relaySessionId: string;
audio: RealtimeVoiceBrowserAudioContract;
};
type RealtimeVoiceBrowserManagedRoomSession = RealtimeVoiceBrowserSessionBase & {
transport: "managed-room";
roomUrl: string;
token?: string;
};
type RealtimeVoiceBrowserSession = RealtimeVoiceBrowserWebRtcSdpSession | RealtimeVoiceBrowserJsonPcmWebSocketSession | RealtimeVoiceBrowserGatewayRelaySession | RealtimeVoiceBrowserManagedRoomSession;
type RealtimeVoiceBridge = {
/** Bind before connect: continuous PCM and interruption go to this call-bound worker sink,
* not onAudio/onClearAudio. Transcripts, delegation and lifecycle stay on the host. */
setAudioOutputPort?(output: RealtimeVoiceAudioOutputPort): void;
/** Continuous audio has no response boundaries; the provider owns interruption. */
outputAudioMode?: "response" | "continuous";
/** Buffers input at its sample rate and supplies silence between microphone writes. */
pacesInputAudio?: boolean;
supportsToolResultContinuation?: boolean;
/** False when the provider cannot accept a tool result without starting a response. */
supportsToolResultSuppression?: boolean;
/** Per-session override for provider-confirmed input-audio barge-in handling. */
handlesInputAudioBargeIn?: boolean;
connect(): Promise<void>;
sendAudio(audio: Buffer): void;
setMediaTimestamp(ts: number): void;
sendUserMessage?(text: string, options?: {
toolChoice?: {
type: "function";
name: string;
};
}): void;
triggerGreeting?(instructions?: string): void;
handleBargeIn?(options?: RealtimeVoiceBargeInOptions): void;
/**
* Returns void when submission completes synchronously, or a Promise that resolves at the
* asynchronous completion boundary exposed by the provider and rejects on submission failure.
*/
submitToolResult(callId: string, result: unknown, options?: RealtimeVoiceToolResultOptions): void | Promise<void>;
acknowledgeMark(markName?: string): void;
/** Stops admission immediately; an optional promise completes after final transcripts and cleanup. */
close(options?: RealtimeVoiceCloseOptions): void | Promise<void>;
isConnected(): boolean;
};
type RealtimeVoiceBargeInOptions = {
/**
* The caller has already confirmed assistant audio is still playing in its output sink.
* This lets providers interrupt output even when the sink cannot provide real playback marks.
*/
audioPlaybackActive?: boolean;
/** Interrupt even when normal barge-in audio-duration guards would treat the event as echo. */
force?: boolean;
};
//#endregion
//#region src/transcripts/provider-types.d.ts
/**
* Public contracts for transcript source providers.
*
* Providers can stream live utterances, import post-hoc transcript text, expose
* status, and stop active sessions using shared session/source descriptors.
*/
/** Supported source families for transcript providers. */
type TranscriptSourceKind = "live-audio" | "live-caption" | "posthoc-transcript" | "recording-stt";
/** Provider-specific locator for a live, recorded, or imported transcript source. */
type TranscriptSourceLocator = {
providerId: string;
kind?: TranscriptSourceKind;
accountId?: string;
guildId?: string;
channelId?: string;
meetingUrl?: string;
threadTs?: string;
fileId?: string;
[key: string]: string | undefined;
};
/** Speaker/participant identity attached to an utterance. */
type TranscriptParticipant = {
id?: string;
label: string;
};
/** One captured or imported transcript utterance. */
type TranscriptUtterance = {
id?: string;
sessionId?: string;
startedAt?: string;
endedAt?: string;
speaker?: TranscriptParticipant;
text: string;
final?: boolean;
metadata?: Record<string, unknown>;
};
/** Durable transcript session metadata. */
type TranscriptSessionDescriptor = {
sessionId: string;
title?: string;
source: TranscriptSourceLocator;
startedAt: string;
stoppedAt?: string;
metadata?: Record<string, unknown>;
};
/** Request passed to providers that can start live transcript capture. */
type TranscriptStartRequest = {
cfg?: OpenClawConfig;
session: TranscriptSessionDescriptor;
abortSignal?: AbortSignal;
startupWaitMs?: number;
onUtterance: (utterance: TranscriptUtterance) => void | Promise<void>;
/**
* `active: false` permanently ends this exact capture subscription, including
* replacement or detach; transient transport disconnects must not emit it.
* Deliver final utterances first. Callback payload ids/source are descriptive;
* consumers retain their admitted session identity and ownership metadata.
*/
onStatus?: (status: TranscriptSourceStatus) => void | Promise<void>;
};
/** Request to watch whether a live source currently has human participants. */
type TranscriptOccupancyWatchRequest = {
cfg?: OpenClawConfig;
source: TranscriptSourceLocator;
abortSignal?: AbortSignal;
startupWaitMs?: number;
/** Emitted on 0 -> >0 humans, and once on subscription if already occupied. */
onOccupied: () => void;
/** Emitted on >0 -> 0 humans. Bots never count; callbacks preserve observed order. */
onEmpty: () => void;
};
type TranscriptOccupancyWatchHandle = {
stop: () => void | Promise<void>;
};
/**
* Result from starting a transcript source provider.
*
* Providers retain cleanup ownership until they return `ok: true`. A failed or
* rejected start must release any partial capture before it settles.
*/
type TranscriptsStartResult = {
ok: true;
session: TranscriptSessionDescriptor;
} | {
ok: false;
error: string;
};
/** Request passed to providers that can stop live transcript capture. */
type TranscriptStopRequest = {
cfg?: OpenClawConfig;
sessionId: string;
source: TranscriptSourceLocator;
reason?: string;
};
/** Failure does not prove release; only success or a terminal onStatus ends cleanup custody. */
type TranscriptsStopResult = {
ok: true;
sessionId: string;
stoppedAt?: string;
} | {
ok: false;
error: string;
};
/** Runtime status reported by transcript source providers. */
type TranscriptSourceStatus = {
sessionId?: string;
active: boolean;
message?: string;
source?: TranscriptSourceLocator;
};
/** Request passed to providers that import post-hoc transcript text. */
type TranscriptImportRequest = {
cfg?: OpenClawConfig;
session: TranscriptSessionDescriptor;
text: string;
speakerLabel?: string;
};
/** Trusted caller facts projected by core; never accepted from tool arguments. */
type TranscriptToolCaller = {
kind: "operator";
source: "channel-owner" | "local" | "scheduled";
} | {
kind: "channel";
channel: string;
accountId?: string;
senderId: string;
groupId?: string;
groupSpace?: string;
roleIds: readonly string[];
};
type TranscriptToolAction = "import" | "start" | "status" | "stop" | "summarize" | "list" | "show";
type TranscriptSourceAccessControl = {
/** Ingress channel whose trusted account owns this provider's account namespace. */
channelId: string;
/** Resolve and validate the canonical account before persistence. */
resolveAccountId: (params: {
cfg?: OpenClawConfig;
source: TranscriptSourceLocator;
}) => Result$1<string | undefined, string>;
/** Apply the provider's native access policy to the resolved source. */
authorize: (params: {
action: TranscriptToolAction;
caller: TranscriptToolCaller;
cfg?: OpenClawConfig;
source: TranscriptSourceLocator;
}) => Promise<Result$1<void, string>>;
};
/** Provider contract for transcript capture/import integrations. */
type TranscriptSourceProvider$2 = {
id: string;
aliases?: readonly string[];
/** Closed access contract for providers sharing one inbound channel namespace. */
accessControl?: TranscriptSourceAccessControl;
name: string;
sourceKinds: readonly TranscriptSourceKind[];
start?: (request: TranscriptStartRequest) => Promise<TranscriptsStartResult>;
watchOccupancy?: (request: TranscriptOccupancyWatchRequest) => Promise<Result$1<TranscriptOccupancyWatchHandle, string>>;
stop?: (request: TranscriptStopRequest) => Promise<TranscriptsStopResult>;
status?: (source: TranscriptSourceLocator, cfg?: OpenClawConfig) => Promise<TranscriptSourceStatus[]>;
importTranscript?: (request: TranscriptImportRequest) => Promise<TranscriptUtterance[]>;
};
//#endregion
//#region src/tts/provider-types.d.ts
/** Canonical speech provider identifier after provider registry normalization. */
type SpeechProviderId = string;
/** Output context requested from a speech provider. */
type SpeechSynthesisTarget = "audio-file" | "voice-note" | "telephony";
/** Provider-owned normalized config map. */
type SpeechProviderConfig = Record<string, unknown>;
/** Provider-owned per-request directive/persona overrides. */
type SpeechProviderOverrides = Record<string, unknown>;
/** Policy controlling which [[tts:*]] directive fields can affect synthesis. */
type SpeechModelOverridePolicy = {
enabled: boolean;
allowText: boolean;
allowProvider: boolean;
allowVoice: boolean;
allowModelId: boolean;
allowVoiceSettings: boolean;
allowNormalization: boolean;
allowSeed: boolean;
};
/** Parsed directive overrides grouped by provider. */
type TtsDirectiveOverrides = {
ttsText?: string;
provider?: SpeechProviderId;
providerOverrides?: Record<string, SpeechProviderOverrides>;
};
/** Result of parsing TTS directives from message text. */
type TtsDirectiveParseResult = {
cleanedText: string;
ttsText?: string;
hasDirective: boolean;
overrides: TtsDirectiveOverrides;
warnings: string[];
};
/** Context for checking whether a provider has enough config to synthesize. */
type SpeechProviderConfiguredContext = {
cfg?: OpenClawConfig;
providerConfig: SpeechProviderConfig;
timeoutMs: number;
};
/** Request for buffered speech synthesis. */
type SpeechSynthesisRequest = {
text: string;
cfg: OpenClawConfig;
providerConfig: SpeechProviderConfig;
target: SpeechSynthesisTarget;
providerOverrides?: SpeechProviderOverrides;
timeoutMs: number;
};
/** Buffered speech synthesis result plus file/voice-note compatibility metadata. */
type SpeechSynthesisResult = {
audioBuffer: Buffer;
outputFormat: string;
fileExtension: string;
voiceCompatible: boolean;
};
type SpeechSynthesisStreamRequest = SpeechSynthesisRequest;
/** Streaming speech synthesis result; release frees provider transport resources. */
type SpeechSynthesisStreamResult = {
audioStream: ReadableStream<Uint8Array>;
outputFormat: string;
fileExtension: string;
voiceCompatible: boolean;
release?: () => Promise<void>;
};
/** Telephony synthesis request for provider output that needs a fixed sample rate. */
type SpeechTelephonySynthesisRequest = {
text: string;
cfg: OpenClawConfig;
providerConfig: SpeechProviderConfig;
providerOverrides?: SpeechProviderOverrides;
timeoutMs: number;
};
/** Telephony synthesis result with sample-rate metadata for call transports. */
type SpeechTelephonySynthesisResult = {
audioBuffer: Buffer;
outputFormat: string;
sampleRate: number;
};
/** Provider hook input for applying persona/config before synthesis. */
type SpeechProviderPrepareSynthesisContext = {
text: string;
cfg: OpenClawConfig;
providerConfig: SpeechProviderConfig;
providerOverrides?: SpeechProviderOverrides;
persona?: ResolvedTtsPersona;
personaProviderConfig?: SpeechProviderConfig;
target: SpeechSynthesisTarget;
timeoutMs: number;
};
/** Optional provider-prepared synthesis overrides. */
type SpeechProviderPreparedSynthesis = {
text?: string;
providerConfig?: SpeechProviderConfig;
providerOverrides?: SpeechProviderOverrides;
};
/** Voice metadata returned by provider list-voices hooks. */
type SpeechVoiceOption = {
id: string;
name?: string;
category?: string;
description?: string;
locale?: string;
gender?: string;
personalities?: string[];
};
/** Provider voice-listing request with optional direct auth/URL overrides. */
type SpeechListVoicesRequest = {
cfg?: OpenClawConfig;
providerConfig?: SpeechProviderConfig;
apiKey?: string;
baseUrl?: string;
/** Core-resolved request timeout after config and provider defaults. */
timeoutMs?: number;
};
/** Provider hook input for resolving normalized config from raw OpenClaw config. */
type SpeechProviderResolveConfigContext = {
cfg: OpenClawConfig;
rawConfig: Record<string, unknown>;
timeoutMs: number;
};
/** One parsed directive key/value plus current provider override state. */
type SpeechDirectiveTokenParseContext = {
key: string;
value: string;
policy: SpeechModelOverridePolicy;
selectedProvider?: SpeechProviderId;
providerConfig?: SpeechProviderConfig;
currentOverrides?: SpeechProviderOverrides;
};
/** Provider directive parser result. */
type SpeechDirectiveTokenParseResult = {
handled: boolean;
overrides?: SpeechProviderOverrides;
warnings?: string[];
};
/** Provider hook input for resolving talk-command speech config. */
type SpeechProviderResolveTalkConfigContext = {
cfg: OpenClawConfig;
baseTtsConfig: Record<string, unknown>;
talkProviderConfig: TalkProviderConfig;
timeoutMs: number;
};
/** Provider hook input for per-call talk-command overrides. */
type SpeechProviderResolveTalkOverridesContext = {
talkProviderConfig: TalkProviderConfig;
params: Record<string, unknown>;
};
//#endregion
//#region src/video-generation/types.d.ts
/** Video asset returned by a provider after generation or transformation. */
type GeneratedVideoAsset = {
/** Non-empty raw video bytes; may accompany url as a delivery fallback. */
buffer?: Buffer;
/** Provider-hosted URL returned instead of bytes or alongside them as a delivery fallback.
* When buffer is absent, callers can forward or download without materializing the video. */
url?: string;
mimeType: string;
fileName?: string;
metadata?: Record<string, unknown>;
};
/** Resolution label accepted by video generation providers. */
type VideoGenerationResolution = "360P" | "480P" | "540P" | "720P" | "768P" | "1080P" | (string & {});
/**
* Canonical semantic role hints for reference assets (first/last frame,
* reference image/video/audio). Providers may accept additional role strings;
* the asset.role type accepts both canonical values and arbitrary strings.
*/
type VideoGenerationAssetRole = "first_frame" | "last_frame" | "reference_image" | "reference_video" | "reference_audio";
/** Source media asset supplied to image/video/audio-to-video providers. */
type VideoGenerationSourceAsset = {
url?: string;
buffer?: Buffer;
mimeType?: string;
fileName?: string;
/**
* Optional semantic role hint forwarded to the provider. Canonical values
* come from `VideoGenerationAssetRole`; plain strings are accepted for
* provider-specific extensions.
*/
role?: VideoGenerationAssetRole | (string & {});
metadata?: Record<string, unknown>;
};
/** Context passed when checking whether a video provider is configured. */
type VideoGenerationProviderConfiguredContext = {
cfg?: OpenClawConfig;
agentDir?: string;
};
/** Context passed when resolving model-specific video generation capabilities. */
type VideoGenerationModelCapabilitiesContext = {
provider: string;
model: string;
cfg: OpenClawConfig;
agentDir?: string;
authStore?: AuthProfileStore;
timeoutMs?: number;
};
/** Normalized request object passed to a selected video generation provider. */
type VideoGenerationRequest = {
provider: string;
model: string;
prompt: string;
cfg: OpenClawConfig;
agentDir?: string;
authStore?: AuthProfileStore;
timeoutMs?: number;
size?: string;
aspectRatio?: string;
resolution?: VideoGenerationResolution;
durationSeconds?: number;
audio?: boolean;
watermark?: boolean;
inputImages?: VideoGenerationSourceAsset[];
inputVideos?: VideoGenerationSourceAsset[];
/** Reference audio assets (e.g. background music) forwarded to the provider. */
inputAudios?: VideoGenerationSourceAsset[];
/** Arbitrary provider-specific parameters forwarded as-is (e.g. seed, draft, camerafixed). */
providerOptions?: Record<string, unknown>;
};
/** Provider video generation response returned to the runtime. */
type VideoGenerationResult = {
videos: GeneratedVideoAsset[];
model?: string;
metadata?: Record<string, unknown>;
};
/** Supported high-level video generation operation modes. */
type VideoGenerationMode = "generate" | "imageToVideo" | "videoToVideo";
/**
* Primitive type tag for a declared `providerOptions` key. Keep narrow —
* plugins that need richer shapes should leave them out of the typed contract
* and interpret the forwarded opaque value inside their own provider code.
*/
type VideoGenerationProviderOptionType = "number" | "boolean" | "string";
/** Capability limits and supported options for one video generation mode. */
type VideoGenerationModeCapabilities = {
maxVideos?: number;
maxInputImages?: number;
maxInputImagesByModel?: Readonly<Record<string, number>>;
maxInputVideos?: number;
maxInputVideosByModel?: Readonly<Record<string, number>>;
/** Max number of reference audio assets the provider accepts (e.g. background music, voice reference). */
maxInputAudios?: number;
maxInputAudiosByModel?: Readonly<Record<string, number>>;
maxDurationSeconds?: number;
supportedDurationSeconds?: readonly number[];
supportedDurationSecondsByModel?: Readonly<Record<string, readonly number[]>>;
sizes?: readonly string[];
aspectRatios?: readonly string[];
resolutions?: readonly VideoGenerationResolution[];
supportsSize?: boolean;
supportsAspectRatio?: boolean;
supportsResolution?: boolean;
supportsAudio?: boolean;
supportsWatermark?: boolean;
/**
* Declared typed schema for `VideoGenerationRequest.providerOptions`. Keys
* listed here are accepted and validated against the declared primitive
* type before forwarding; unknown keys or type mismatches skip the
* candidate provider at runtime so mis-typed or provider-specific options
* never silently reach the wrong provider.
*/
providerOptions?: Readonly<Record<string, VideoGenerationProviderOptionType>>;
};
/** Capability block for transform modes that may be independently enabled. */
type VideoGenerationTransformCapabilities = VideoGenerationModeCapabilities & {
enabled: boolean;
};
/** Full provider capability map including base and transform mode overrides. */
type VideoGenerationProviderCapabilities = VideoGenerationModeCapabilities & {
generate?: VideoGenerationModeCapabilities;
imageToVideo?: VideoGenerationTransformCapabilities;
videoToVideo?: VideoGenerationTransformCapabilities;
};
/** Static catalog metadata that overrides provider defaults for one video model. */
type VideoGenerationCatalogModelEntry = {
capabilities?: VideoGenerationProviderCapabilities;
modes?: readonly VideoGenerationMode[];
};
/** Video generation provider contract implemented by provider plugins. */
type VideoGenerationProvider = {
id: string;
aliases?: string[];
label?: string;
defaultModel?: string;
/** Default provider operation timeout in milliseconds when caller/config omit timeoutMs. */
defaultTimeoutMs?: number;
models?: string[];
capabilities: VideoGenerationProviderCapabilities;
catalogByModel?: Readonly<Record<string, VideoGenerationCatalogModelEntry>>;
isConfigured?: (ctx: VideoGenerationProviderConfiguredContext) => boolean;
resolveModelCapabilities?: (ctx: VideoGenerationModelCapabilitiesContext) => VideoGenerationProviderCapabilities | undefined | Promise<VideoGenerationProviderCapabilities | undefined>;
generateVideo: (req: VideoGenerationRequest) => Promise<VideoGenerationResult>;
};
type VideoGenerationIgnoredOverride = {
key: "size" | "aspectRatio" | "resolution" | "audio" | "watermark";
value: string | boolean;
};
type VideoGenerationNormalization = {
size?: MediaNormalizationEntry<string>;
aspectRatio?: MediaNormalizationEntry<string>;
resolution?: MediaNormalizationEntry<VideoGenerationResolution>;
durationSeconds?: MediaNormalizationEntry<number>;
};
//#endregion
//#region src/plugins/capability-provider.types.d.ts
/** JSON-compatible provider settings for one configured worker profile. */
type WorkerProfile = Readonly<Record<string, PluginJsonValue>>;
/** Provider-authored picker metadata for one machine class or exact machine type. */
type WorkerMachineOption = Readonly<{
id: string;
label: string;
os?: string;
cpu?: number;
memoryGb?: number;
default?: boolean;
}>;
/** Provider-owned operating system choices for one configured worker profile. */
type WorkerOperatingSystem = Readonly<{
id: string;
label: string;
default?: boolean;
/** Why this advertised target cannot currently be selected, including a repair hint. */
disabledReason?: string;
}>;
/** SSH endpoint material returned by a worker provider after provisioning. */
type WorkerSshEndpoint = {
host: string;
port: number;
/**
* Up to 10 ordered unique integer ports (1..65535) after `port`; excludes the primary.
* Core rotates only for idempotent probes, content-addressed transfers, receipt/lock-guarded
* artifact installation, convergent managed-worktree mirroring, and tunnel reconnects.
* Ambiguous unguarded stateful commands fail closed and are not replayed.
*/
fallbackPorts?: readonly number[];
user: string;
/** OpenSSH public host-key line obtained from trusted provisioning output. */
hostKey: string;
/** Secret reference only; providers must never return plaintext key material. */
keyRef: SecretRef;
};
/** Resolved SSH client identity. Providers may return a local path or ephemeral material. */
type WorkerSshIdentity = {
kind: "path";
path: string;
} | {
kind: "material";
contents: string;
};
/** Durable context supplied when a worker provider resolves the identity it minted. */
type WorkerSshIdentityRequest = {
/** Optional live invocation guard; core supplies it for identity resolution. */
assertCurrent?: () => void;
leaseId: string;
profile: WorkerProfile;
keyRef: SecretRef;
};
/** Closed set of applications installed and launchable on a provisioned worker desktop. */
type WorkerDesktopApp = {
id: "browser";
executablePath: string;
/** Fixed provider-owned arguments, passed directly without a shell. */
args?: string[];
cdpPort: number;
} | {
id: "terminal";
executablePath: string;
args?: string[];
};
/** Optional interactive desktop endpoint provisioned with the lease (warm-time capability). */
type WorkerDesktopEndpoint = {
/** Desktop service protocol on the worker loopback; "rfb" is the only phase-1 value. */
protocol: "rfb";
/** Loopback port on the worker (e.g. 5900). */
port: number;
/** Absolute on-box path to the per-lease password file; read by the owning transport, never persisted as plaintext. */
passwordFilePath?: string;
/** Managed desktop account for ARD authentication; its password stays in passwordFilePath. */
username?: string;
/** False restricts a native desktop from the provider-wide virtual display resize capability. */
allowsResize?: boolean;
/** Closed application metadata advertised by the provider for this desktop. */
apps?: WorkerDesktopApp[];
};
/** Placement execution modes a worker provider can carry. */
type WorkerExecutionMode = "worker-turn" | "remote-exec";
/** Grant-free identity of the runtime bytes a provider may retain in a prepared image. */
type WorkerNodeRuntimeIdentity = {
nodeBootstrapSha256: string;
executionMode: WorkerExecutionMode;
/** Present only when project preparation retains the independent worker archive. */
workerBundleSha256?: string;
};
type WorkerNodeBootstrapAccess = {
/** Core-owned command window for downloading and installing this grant's artifacts. */
bootstrapTimeoutMs?: number;
/** Immutable node distribution prepared by the Gateway for this provision operation. */
nodeBootstrap: {
url: string;
token: string;
sha256: string;
bytes: number;
openclawVersion: string;
enabledPluginIds: readonly string[];
tlsFingerprint?: string;
};
/** Runtime/enrollment closure, including shutdown; provision's separate signal identifies explicit Stop. */
signal?: AbortSignal;
};
/** Operation-bound immutable artifacts without a node identity or enrollment credential. */
type WorkerNodeRuntimePreparation = WorkerNodeBootstrapAccess & {
workerBundle: {
url: string;
token: string;
sha256: string;
bytes: number;
tlsFingerprint?: string;
/** Core-owned location within the installed node package, outside dist and enrollment state. */
packageRelativePath: string;
};
};
/** Replay-safe node enrollment prepared only after a provider has allocated its machine. */
type WorkerNodeEnrollment = WorkerNodeBootstrapAccess & {
openclawVersion: string;
displayName: string;
waitForDeviceId: () => Promise<string>;
} & ({
mode: "connect";
setupCode: string;
setupId: string;
} | {
mode: "resume";
deviceId: string;
});
/** Durable lease identity and endpoint returned by a successful provision operation. */
type WorkerLease = {
leaseId: string;
/** The SSH account also owns processes unrelated to this worker lease. */
sharedHost?: boolean;
desktop?: WorkerDesktopEndpoint;
} & ({
ssh: WorkerSshEndpoint;
node?: never;
} | {
node: {
deviceId: string;
};
ssh?: never;
});
/** Authoritative inspection result for an already-known worker lease. */
type WorkerLeaseStatus = {
status: "active";
/** Explicit provider fact used to reconcile leases persisted before this metadata existed. */
sharedHost?: boolean;
} | {
status: "dormant";
} | {
status: "destroyed";
} | {
status: "unknown";
};
/** Provision failed after allocation and the provider could not prove cleanup completed. */
declare class WorkerProvisionCleanupError extends AggregateError {
readonly provisionError: unknown;
readonly cleanupError: unknown;
readonly code = "cleanup_indeterminate";
readonly leaseId: string;
constructor(leaseId: string, provisionError: unknown, cleanupError: unknown);
}
/** Provision failed after allocation and the provider confirmed cleanup completed. */
declare class WorkerProvisionCleanupCompleteError extends Error {
readonly provisionError: unknown;
readonly code = "cleanup_complete";
readonly leaseId: string;
constructor(leaseId: string, provisionError: unknown);
}
/** Permanent provider rejection recorded as a terminal worker failure. */
declare class WorkerProviderError extends Error {
readonly code = "invalid_profile";
constructor(message: string);
static cleanupComplete(leaseId: string, provisionError: unknown): WorkerProvisionCleanupCompleteError;
static isCleanupComplete(error: unknown): error is WorkerProvisionCleanupCompleteError;
static cleanupIndeterminate(leaseId: string, provisionError: unknown, cleanupError: unknown): WorkerProvisionCleanupError;
static isCleanupIndeterminate(error: unknown): error is WorkerProvisionCleanupError;
}
/** Cloud-worker lifecycle capability shared by plugin and internal providers. */
type WorkerProvider$1 = {
id: string;
/**
* Nonsecret backend display ID, never a routing or allocation identity.
* Synchronous local presentation only: no commands, network, or credential reads.
* Return 1–64 lowercase ASCII letters/digits/hyphens, starting with a letter.
* Omission, invalid values, and exceptions retain generic provider presentation.
*/
resolveDisplayId?: (profile: WorkerProfile) => string | undefined;
/** Safe to request virtual desktop resizing; the RFB server still negotiates support. */
allowsDesktopResize?: boolean;
/** Process-stable choices available for this profile; omit the hook to hide machine selection. */
listMachineOptions?: (profile: WorkerProfile) => Promise<readonly WorkerMachineOption[]>;
listOperatingSystems?: (profile: WorkerProfile) => Promise<readonly WorkerOperatingSystem[]>;
/** Omission advertises no placement support; multiple modes use their canonical order. */
supportedExecutionModes?: readonly [WorkerExecutionMode] | readonly ["worker-turn", "remote-exec"];
/**
* Provision before preparing an installation when the lease transport decides whether an
* installation is needed. Defaults to false so SSH providers retain prepare-before-allocation.
*/
provisionBeforeInstallation?: boolean;
/** Provider allocates a node host through the environment-owned enrollment callback. */
requiresNodeEnrollment?: boolean;
/** Prepare a pristine project before enrollment so it can be included in a reusable image. */
supportsProjectPreparation?: (profile: WorkerProfile, machineClass?: string, os?: string) => boolean;
/** Immutable target resolved before project preparation or allocation. */
resolvePreparationTarget?: (profile: WorkerProfile, machineClass?: string, os?: string) => {
machineClass: string;
platform: string;
arch?: string;
} | undefined;
/** Maximum unused ready-worker lifetime, measured from the original session demand. */
resolvePreparedIdleTimeoutMs?: (profile: WorkerProfile) => number | undefined;
/** Record successful demand in metadata only; must not allocate, capture, or renew reserves. */
notePreparedDemand?: (lease: {
leaseId: string;
profile: WorkerProfile;
}, demand: {
preparationKey: string;
demandAtMs: number;
}) => Promise<void>;
/**
* Resolve the exact cleanup handle for this operation, even if no machine was created.
* Must not provision, start, renew, run setup, enroll, or wait for transport readiness.
* Identity is not existence/readiness proof; destroy still owns teardown confirmation.
*/
resolveAllocation: (profile: WorkerProfile, operationId: string) => Promise<{
leaseId: string;
sharedHost: boolean;
}>;
/**
* Provision or adopt the lease for this operation id.
* Repeating the same operation id must be idempotent across gateway restarts.
*/
provision: (profile: WorkerProfile, operationId: string, options?: {
/** Configured profile id for display; settings and operation id own allocation identity. */
profileId?: string;
/** Cancel this attempt; settle its active commands before rejecting. Cleanup proves release separately. */
signal?: AbortSignal;
/** Modern hosts supply authority; legacy optionality is source compatibility only. */
assertCurrent?: () => void;
executionMode?: WorkerExecutionMode;
machineClass?: string;
os?: string;
nodeRuntimeIdentity?: WorkerNodeRuntimeIdentity;
/** Upper bound per runtime preparation/enrollment phase, including the node connection wait. */
nodeBootstrapTimeoutMs?: number;
prepareNodeRuntime?: () => Promise<WorkerNodeRuntimePreparation>;
beginNodeEnrollment?: () => Promise<WorkerNodeEnrollment>;
project?: {
key: string;
baseCommit: string;
label?: string;
/** Gateway-local checkout root for display and explicit rebuild requests. */
root?: string;
preparation?: {
key: string;
cacheKey: string;
purpose: "session" | "reserve";
demandAtMs: number;
};
signal: AbortSignal;
assertCurrent: () => void;
/** Verify an already enrolled allocation without transferring, running setup, or capturing it. */
inspectPreparedWorkspace?: (transport: {
runScript: (script: string, signal: AbortSignal) => Promise<string>;
}) => Promise<void>;
/** Bound to this provision attempt; retained callbacks reject after it closes. */
prepare: (transport: {
runScript: (script: string, signal: AbortSignal) => Promise<string>;
/** Render using this provider command's remaining budget before repository code runs. */
runScriptWithBudget?: (createScript: (timeoutMs: number) => string, signal: AbortSignal) => Promise<string>;
upload: (localPath: string, remotePath: string, signal: AbortSignal) => Promise<void>;
}) => Promise<{
seedKey: string;
cacheHit: boolean;
/** New completed setup must enter the reusable image before enrollment. */
captureRequired?: true;
preparedWorkspace?: {
preparationKey: string;
cacheKey: string;
workspaceDir: string;
homeDir: string;
sourceManifestRef: string;
preparedManifestRef: string;
};
}>;
};
}) => Promise<WorkerLease>;
/**
* Prepare without allocating, renewing, enrolling, or changing a provider resource. The
* returned operation carries prepared facts; core records allocation intent before calling it.
* Replay preparation cannot attest that an earlier operation allocated nothing.
*/
prepareProvision?: (...args: Parameters<WorkerProvider$1["provision"]>) => Promise<() => Promise<WorkerLease>>;
/** Maximum core wait for one provision attempt, including provider-owned setup and cleanup. */
resolveProvisionTimeoutMs?: (profile: WorkerProfile, options?: {
nodeBootstrapTimeoutMs?: number;
}) => number;
/**
* Throws on transient/indeterminate observation failures. `unknown` means the provider no
* longer recognizes a usable lease; core fences it and requests destroy. Only `destroyed`
* proves teardown complete and lets core skip destroy.
*/
inspect: (lease: {
leaseId: string;
profile: WorkerProfile;
}) => Promise<WorkerLeaseStatus>;
/**
* Resolves provider-owned dynamic identities. When absent, the gateway uses its generic
* SecretRef resolver; when present, failures are authoritative and never fall back.
*/
resolveSshIdentity?: (request: WorkerSshIdentityRequest) => Promise<WorkerSshIdentity>;
renew?: (leaseId: string) => Promise<void>;
/**
* Bounded cleanup for configured profiles, including when no leases remain. Core schedules
* one pass at a time without blocking allocation. Check authority before external effects
* and after awaits before persistence; settle only after all owned commands have stopped.
*/
maintain?: (context: {
profiles: readonly WorkerProfile[];
signal: AbortSignal;
assertCurrent: () => void;
}) => Promise<void>;
/** Idempotent; resolves only after the provider can prove teardown. */
destroy: (lease: {
leaseId: string;
profile: WorkerProfile;
}) => Promise<void>;
/** Maximum core wait for teardown, including provider-owned checkpointing and cleanup. */
resolveDestroyTimeoutMs?: (profile: WorkerProfile) => number;
};
/** Speech capability registered by a plugin. */
type SpeechProviderPlugin$1 = {
id: SpeechProviderId;
label: string;
aliases?: string[];
autoSelectOrder?: number;
/** Default provider operation timeout in milliseconds when caller/config omit timeoutMs. */
defaultTimeoutMs?: number;
defaultModel?: string;
models?: readonly string[];
voices?: readonly string[];
resolveConfig?: (ctx: SpeechProviderResolveConfigContext) => SpeechProviderConfig;
parseDirectiveToken?: (ctx: SpeechDirectiveTokenParseContext) => SpeechDirectiveTokenParseResult;
resolveTalkConfig?: (ctx: SpeechProviderResolveTalkConfigContext) => SpeechProviderConfig;
resolveTalkOverrides?: (ctx: SpeechProviderResolveTalkOverridesContext) => SpeechProviderConfig | undefined;
prepareSynthesis?: (ctx: SpeechProviderPrepareSynthesisContext) => SpeechProviderPreparedSynthesis | undefined | Promise<SpeechProviderPreparedSynthesis | undefined>;
isConfigured: (ctx: SpeechProviderConfiguredContext) => boolean;
synthesize: (req: SpeechSynthesisRequest) => Promise<SpeechSynthesisResult>;
streamSynthesize?: (req: SpeechSynthesisStreamRequest) => Promise<SpeechSynthesisStreamResult>;
synthesizeTelephony?: (req: SpeechTelephonySynthesisRequest) => Promise<SpeechTelephonySynthesisResult>;
listVoices?: (req: SpeechListVoicesRequest) => Promise<SpeechVoiceOption[]>;
};
/** Realtime transcription capability registered by a plugin. */
type RealtimeTranscriptionProviderPlugin$1 = {
id: RealtimeTranscriptionProviderId;
label: string;
aliases?: string[];
defaultModel?: string;
models?: readonly string[];
autoSelectOrder?: number;
resolveConfig?: (ctx: RealtimeTranscriptionProviderResolveConfigContext) => RealtimeTranscriptionProviderConfig;
isConfigured: (ctx: RealtimeTranscriptionProviderConfiguredContext) => boolean;
createSession: (req: RealtimeTranscriptionSessionCreateRequest) => RealtimeTranscriptionSession;
};
/** Transcript source capability registered by a channel or meeting plugin. */
type TranscriptSourceProvider$1 = TranscriptSourceProvider$2;
/** Realtime voice capability registered by a plugin. */
type RealtimeVoiceProviderPlugin$1 = {
id: RealtimeVoiceProviderId;
label: string;
aliases?: string[];
defaultModel?: string;
models?: readonly string[];
/** Known speaker voices for pickers; providers still accept free-form values. */
voices?: readonly string[];
autoSelectOrder?: number;
capabilities?: RealtimeVoiceProviderCapabilities;
resolveConfig?: (ctx: RealtimeVoiceProviderResolveConfigContext) => RealtimeVoiceProviderConfig;
isConfigured: (ctx: RealtimeVoiceProviderConfiguredContext) => boolean;
createBridge: (req: RealtimeVoiceBridgeCreateRequest) => RealtimeVoiceBridge;
createBrowserSession?: (req: RealtimeVoiceBrowserSessionCreateRequest) => Promise<RealtimeVoiceBrowserSession>;
};
type MediaUnderstandingProviderPlugin$1 = MediaUnderstandingProvider;
type ImageGenerationProviderPlugin$1 = ImageGenerationProvider;
type VideoGenerationProviderPlugin$1 = VideoGenerationProvider;
type MusicGenerationProviderPlugin$1 = MusicGenerationProvider;
//#endregion
//#region src/gateway/worker-environments/state.d.ts
type WorkerEnvironmentUnleasedState = "requested" | "provisioning" | "failed";
type WorkerEnvironmentLeasedState = Exclude<WorkerEnvironmentState, WorkerEnvironmentUnleasedState>;
//#endregion
//#region src/gateway/worker-environments/environment-record.d.ts
type WorkerEnvironmentBootstrapReceipt = WorkerAdmissionHandshake & {
/** Provenance only; admission authority remains the exact stored build identity. */
installKind?: "bundle" | "local";
};
type WorkerEnvironmentTeardownTerminalState = "destroyed" | "failed";
type WorkerEnvironmentPreparation = {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
};
type WorkerEnvironmentPreparationIntent = Omit<WorkerEnvironmentPreparation, "consumedAtMs">;
type PreparedEnvironmentPlacementBinding = WorkerSessionPlacementDispatchIdentity & {
generation: number;
preparationKey: string;
assertCurrent: () => void;
};
type PreparedEnvironmentSelection = WorkerSessionPlacementDispatchIdentity & {
expectedGeneration: number;
environmentId: string;
ownerEpoch: number;
providerId: string;
profileId: string;
preparationKey: string;
nodeDeviceId: string;
leaseId: string;
bundleHash: string;
assertCurrent: () => void;
};
type RecordIdentity = {
environmentId: string;
providerId: string;
profileId: string;
};
type RecordBase = RecordIdentity & {
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
} & {
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
} & {
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
};
type UnleasedRecord = {
state: WorkerEnvironmentUnleasedState;
leaseId: null;
sshEndpoint: null;
};
type LeasedRecord = {
state: WorkerEnvironmentLeasedState;
leaseId: string;
sshEndpoint: WorkerSshEndpoint | null;
};
type WorkerEnvironmentRecord = RecordBase & (UnleasedRecord | LeasedRecord);
type WorkerEnvironmentIntentInput = RecordIdentity & {
preparation?: WorkerEnvironmentPreparationIntent;
profileSnapshot: WorkerProfile;
provisionOperationId: string;
};
//#endregion
//#region src/gateway/worker-environments/placement-move-intent.d.ts
type WorkerPlacementMoveTarget = SessionMoveTarget;
type WorkerPlacementMoveSource = {
generation: number;
environmentId: string;
ownerEpoch: number;
};
type WorkerPlacementMoveIntent = {
operationId: string;
sessionId: string;
source: WorkerPlacementMoveSource;
target: WorkerPlacementMoveTarget;
abandonSource: boolean;
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
};
//#endregion
//#region src/gateway/worker-environments/placement-workspace-result.types.d.ts
type WorkerWorkspacePendingResult = {
sessionId: string;
environmentId: string;
ownerEpoch: number;
placementGeneration: number;
claimId: string;
runId: string;
gatewayInstanceId: string;
recoveryRequestedAtMs: number | null;
workspaceAcceptedAtMs: number | null;
stagedResultRef: string | null;
repositoryWorkspaceId?: string;
};
//#endregion
//#region src/gateway/worker-environments/placement-read-projection.types.d.ts
type WorkerEnvironmentPlacementFacts = Pick<WorkerEnvironmentRecord, "environmentId" | "providerId" | "profileId" | "profileSnapshot" | "state" | "leaseId" | "ownerEpoch" | "nodeDeviceId" | "attachedSessionIds">;
type WorkerSessionPlacementProjection = {
placements: ReadonlyMap<string, WorkerSessionPlacementRecord>;
moves: ReadonlyMap<string, WorkerPlacementMoveIntent>;
pendingResults: ReadonlyMap<string, WorkerWorkspacePendingResult>;
workspaceJournalOwnerSessionIds: ReadonlySet<string>;
workspaceResultReconcilingSessionIds: ReadonlySet<string>;
workspaceRecoveryPendingSessionIds: ReadonlySet<string>;
environments: ReadonlyMap<string, WorkerEnvironmentPlacementFacts>;
};
type WorkerPlacementRecoveryCandidate = {
sessionId: string;
environmentId: string | null;
state?: WorkerSessionPlacementState;
moveSourceEnvironmentId?: string;
};
//#endregion
//#region src/gateway/worker-environments/workspace-manifest.d.ts
type WorkerWorkspaceManifestEntry = {
path: string;
type: "file";
mode: number;
size: number;
sha256: string;
} | {
path: string;
type: "symlink";
mode: number;
target: string;
};
type WorkerWorkspaceManifest = {
version: 1;
baseCommit: string | null;
entries: WorkerWorkspaceManifestEntry[];
directories?: string[];
};
type WorkerWorkspaceReconciliationJournal = {
version: 1;
temporaryNonce: string;
baseManifestRef: string;
currentManifestRef: string;
baseEntries: WorkerWorkspaceManifestEntry[];
appliedEntries: WorkerWorkspaceManifestEntry[];
baseDirectories?: string[];
appliedDirectories?: string[];
appliedManifestRef?: string;
baseTree: string;
basePackSha256: string;
basePack: Uint8Array;
};
type WorkerWorkspaceReconciliationJournalAdapter = {
load(): WorkerWorkspaceReconciliationJournal | undefined;
begin(journal: WorkerWorkspaceReconciliationJournal): void;
commit(manifestRef: string): void;
abort(): void;
};
//#endregion
//#region src/infra/startup-maintenance-required.d.ts
declare const maintenanceReasons: {
readonly "state-migrations": "state migration";
readonly "newer-schema": "a newer OpenClaw build";
readonly "agent-media": "offline media migration";
readonly "agent-databases-composite-primary-key": "state database schema migration";
readonly "audit-events-v2": "state database schema migration";
readonly "legacy-workshop-review-index": "state database schema migration";
readonly "legacy-cron-run-logs": "cron run history migration";
readonly "legacy-workspace": "workspace setup state migration";
readonly "legacy-session-store": "session store migration";
};
declare class StartupMaintenanceRequiredError extends Error {
readonly kind: keyof typeof maintenanceReasons;
readonly code = "gateway.maintenance_required";
constructor(kind: keyof typeof maintenanceReasons, message: string, options?: ErrorOptions);
get reason(): string;
}
//#endregion
//#region src/plugin-state/plugin-blob-store.types.d.ts
type PluginBlobEntryInfo<TMetadata> = {
key: string;
metadata: TMetadata;
sizeBytes: number;
createdAt: number;
expiresAt?: number;
};
type PluginBlobEntry<TMetadata> = PluginBlobEntryInfo<TMetadata> & {
bytes: Uint8Array;
};
type PluginBlobStore<TMetadata> = {
register(key: string, bytes: Uint8Array, metadata: TMetadata, opts?: {
ttlMs?: number;
}): Promise<void>;
registerIfAbsent(key: string, bytes: Uint8Array, metadata: TMetadata, opts?: {
ttlMs?: number;
}): Promise<boolean>;
lookup(key: string): Promise<PluginBlobEntry<TMetadata> | undefined>;
entries(): Promise<PluginBlobEntryInfo<TMetadata>[]>;
delete(key: string): Promise<boolean>;
deleteExpiredKey(key: string): Promise<PluginBlobEntryInfo<TMetadata> | undefined>;
deleteExpired(): Promise<PluginBlobEntryInfo<TMetadata>[]>;
clear(): Promise<void>;
};
type PluginBlobOverflowPolicy = "evict-oldest" | "reject-new";
type OpenBlobStoreOptions = {
namespace: string;
maxEntries: number;
maxBytesPerEntry: number;
maxBytesPerNamespace: number;
overflowPolicy?: PluginBlobOverflowPolicy;
defaultTtlMs?: number;
};
type PluginBlobStoreErrorCode = "PLUGIN_BLOB_OPEN_FAILED" | "PLUGIN_BLOB_WRITE_FAILED" | "PLUGIN_BLOB_READ_FAILED" | "PLUGIN_BLOB_CORRUPT" | "PLUGIN_BLOB_LIMIT_EXCEEDED" | "PLUGIN_BLOB_INVALID_INPUT";
type PluginBlobStoreOperation = "open" | "register" | "lookup" | "delete" | "entries" | "clear" | "sweep";
declare class PluginBlobStoreError extends Error {
readonly code: PluginBlobStoreErrorCode;
readonly operation: PluginBlobStoreOperation;
readonly path?: string;
constructor(message: string, options: {
code: PluginBlobStoreErrorCode;
operation: PluginBlobStoreOperation;
path?: string;
cause?: unknown;
});
}
//#endregion
//#region src/state/openclaw-state-db-schema-migration-required.d.ts
type OpenClawStateDatabaseSchemaMigrationRequiredKind = "agent-databases-composite-primary-key" | "audit-events-v2" | "legacy-cron-run-logs" | "legacy-workshop-review-index";
declare class OpenClawStateDatabaseSchemaMigrationRequiredError extends StartupMaintenanceRequiredError {
readonly kind: OpenClawStateDatabaseSchemaMigrationRequiredKind;
readonly pathname: string;
constructor(kind: OpenClawStateDatabaseSchemaMigrationRequiredKind, pathname: string);
}
//#endregion
//#region src/state/openclaw-state-lease-error.d.ts
declare const leaseErrorCodes: readonly ["OPENCLAW_STATE_LEASE_INVALID_INPUT", "OPENCLAW_STATE_LEASE_HELD", "OPENCLAW_STATE_LEASE_ABORTED", "OPENCLAW_STATE_LEASE_LOST", "OPENCLAW_STATE_LEASE_STORAGE_FAILED"];
type OpenClawStateLeaseErrorCode = (typeof leaseErrorCodes)[number];
//#endregion
//#region src/state/session-metadata-unavailable-error.d.ts
declare class SessionMetadataUnavailableError extends Error {
readonly reason: "schema-missing" | "table-missing";
readonly missingTables: readonly string[];
constructor(reason: "schema-missing" | "table-missing", options?: ErrorOptions, missingTables?: readonly string[]);
}
//#endregion
//#region src/state/openclaw-state-worker-error-identity.d.ts
type MaintenanceKind = ConstructorParameters<typeof StartupMaintenanceRequiredError>[0];
type StateMigrationKind = ConstructorParameters<typeof OpenClawStateDatabaseSchemaMigrationRequiredError>[0];
type ErrorIdentity = {
type: "worker-session-already-attached";
sessionId: string;
environmentId: string;
} | {
type: "workspace-alias-repointed";
aliasPath: string;
storedWorkspacePath: string;
currentWorkspacePath: string;
} | {
type: "error" | "aggregate" | "ownership" | "newer-schema" | "coordinator" | "range-error" | "syntax-error" | "type-error" | "skill-upload-request" | "mcp-oauth-corruption";
} | {
type: "state-owner-contention";
databasePath: string;
} | {
type: "ownership-metadata";
databasePath: string;
} | {
type: "external-ownership";
databasePath: string;
managerId: string;
} | {
type: "state-lease";
leaseCode: OpenClawStateLeaseErrorCode;
} | {
type: "plugin-blob";
blobCode: PluginBlobStoreError["code"];
operation: PluginBlobStoreError["operation"];
path?: string;
} | {
type: "maintenance";
kind: MaintenanceKind;
} | {
type: "state-migration";
kind: StateMigrationKind;
pathname: string;
} | {
type: "session-metadata";
reason: SessionMetadataUnavailableError["reason"];
missingTables: readonly string[];
} | {
type: "agent-media-migration";
pathname: string;
schemaVersion: number;
};
//#endregion
//#region src/state/openclaw-state-worker-error.d.ts
type ErrorValue = {
ref: number;
} | {
value: string | number | boolean | null;
} | {
undefined: true;
};
type ErrorNode = ErrorIdentity & {
name: string;
message: string;
code?: string | number;
errcode?: number;
errno?: number;
nativeOpen?: true;
stateDatabasePath?: string;
cause?: ErrorValue;
errors?: ErrorValue[];
};
/** A closed error graph; references preserve shared causes and cyclic aggregates. */
type OpenClawStateWorkerErrorPayload = {
version: 1;
root: number;
nodes: ErrorNode[];
};
//#endregion
//#region src/gateway/worker-environments/placement-turn-claims.worker-contract.d.ts
type PlacementTurnClaimReceipt = {
placement?: WorkerSessionPlacementRecord;
claim?: WorkerSessionTurnClaim;
};
type PlacementTurnClaimWorkerOperations = {
"placementTurns.claim": {
input: {
claim: WorkerTurnClaimInput;
nowMs?: number;
};
output: PlacementTurnClaimReceipt;
};
"placementTurns.release": {
input: {
claim: WorkerSessionTurnClaim;
nowMs?: number;
};
output: PlacementTurnClaimReceipt;
};
"placementTurns.releaseIfOwned": {
input: {
claim: WorkerSessionTurnClaim;
nowMs?: number;
};
output: PlacementTurnClaimReceipt;
};
"placementTurns.recoverWorkspace": {
input: {
claim: WorkerSessionTurnClaim;
gatewayInstanceId: string;
nowMs?: number;
};
output: PlacementTurnClaimReceipt;
};
"placementTurns.handoffRuntimeRefreshResult": {
input: {
claim: WorkerSessionTurnClaim;
expectedGeneration: number;
gatewayInstanceId: string;
nowMs: number;
};
output: PlacementTurnClaimReceipt;
};
};
//#endregion
//#region src/gateway/worker-environments/placement-turn-authority.d.ts
type PlacementTurnClaimAuthority = {
readonly claim: WorkerSessionTurnClaim;
readonly identity: Readonly<{
agentId: string;
sessionKey: string;
}>;
isCurrent: () => boolean;
onRevoked: (listener: () => void) => () => void;
release: () => void;
};
//#endregion
//#region src/gateway/worker-environments/credential.d.ts
type WorkerCredentialRecord = {
environmentId: string;
credentialHash: string;
bundleHash: string;
sessionId: string | null;
rpcSetVersion: number;
ownerEpoch: number;
expiresAtMs: number;
deliveredAtMs: number | null;
};
type MintedWorkerCredential = Omit<WorkerCredentialRecord, "credentialHash" | "deliveredAtMs"> & {
credential: string;
deliveryId: string;
turnClaim?: WorkerSessionTurnClaim;
};
type WorkerCredentialBinding = Pick<WorkerCredentialRecord, "environmentId" | "ownerEpoch" | "sessionId">;
//#endregion
//#region src/gateway/worker-environments/session-attachment.d.ts
type WorkerEnvironmentSessionIdentity = {
sessionId: string;
sessionKey: string;
agentId: string;
sessionLifecycleRevision?: string;
};
/** A secondary machine owned by a conversation, independent of its execution placement. */
type WorkerEnvironmentAttachment = WorkerEnvironmentSessionIdentity & {
environmentId: string;
ownerEpoch: number;
generation: number;
};
type WorkerEnvironmentAttachmentRecord = Omit<WorkerEnvironmentAttachment, "ownerEpoch"> & {
createdAtMs: number;
lastUsedAtMs: number;
closedAtMs: number | null;
};
type WorkerEnvironmentSessionCreateRequest = WorkerEnvironmentSessionIdentity & {
profileId: string;
idempotencyKey: string;
machineClass?: string;
os?: string;
};
/** Requester presentation must succeed before a newly reserved machine can be allocated. */
type WorkerEnvironmentSessionReservationHandler = (reservation: {
environmentId: string;
reused: boolean;
}) => Promise<void>;
//#endregion
//#region src/gateway/worker-environments/store-write-types.d.ts
type WorkerEnvironmentTransitionPatch = {
leaseId?: string | null;
nodeDeviceId?: string | null;
sshEndpoint?: WorkerSshEndpoint | null;
sharedHost?: boolean;
desktop?: WorkerDesktopEndpoint | null;
bootstrapReceipt?: WorkerEnvironmentBootstrapReceipt;
attachedSessionIds?: readonly string[];
lastError?: string | null;
credential?: CredentialInput;
};
type CredentialInput = {
credentialHash: string;
sessionId: string | null;
rpcSetVersion: number;
expiresAtMs: number;
};
type CredentialRevocationInput = {
environmentId: string;
expectedOwnerEpoch?: number;
};
type TransitionInput = {
assertCurrent?: () => void;
environmentId: string;
from: WorkerEnvironmentState;
to: WorkerEnvironmentState;
expectedOwnerEpoch?: number;
placementBinding?: PreparedEnvironmentPlacementBinding;
patch?: WorkerEnvironmentTransitionPatch;
};
type BootstrapRefreshInput = {
environmentId: string;
expectedOwnerEpoch: number;
expectedNodeDeviceId: string | null;
expectedBootstrapReceipt: WorkerEnvironmentBootstrapReceipt;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt;
assertCurrent: () => void;
} & ({
expectedState: "attached";
expectedPlacementGeneration: number;
expectedReclaimResult?: WorkerWorkspacePendingResult;
} | {
expectedState: "ready" | "idle";
expectedPlacementGeneration?: never;
});
type WorkerEnvironmentPruneInput = {
nowMs?: number;
limit?: number;
canPruneDemand?: (record: WorkerEnvironmentRecord, nowMs: number) => boolean;
};
//#endregion
//#region src/gateway/worker-environments/store-worker-contract.d.ts
type WorkerEnvironmentPruneObservation = Selectable<WorkerEnvironments>;
/** Native mutation signatures own the host callbacks and the worker's serializable contract. */
type WorkerEnvironmentMutationMethods = {
createIntent(input: WorkerEnvironmentIntentInput): WorkerEnvironmentRecord;
ensureNodeEnrollment(environmentId: string): WorkerEnvironmentRecord;
revokeEnvironmentCredential(input: CredentialRevocationInput): void;
reconcileSharedHost(input: {
environmentId: string;
state: WorkerEnvironmentState;
leaseId: string;
sharedHost: boolean;
}): WorkerEnvironmentRecord;
adoptProvisionCleanupFailure(input: {
environmentId: string;
leaseId: string;
lastError: string;
}): WorkerEnvironmentRecord;
requestDestroy(input: {
environmentId: string;
state: WorkerEnvironmentState;
terminalState?: WorkerEnvironmentTeardownTerminalState;
assertCurrent?: () => void;
lastError?: string;
}): WorkerEnvironmentRecord;
refreshBootstrapReceipt(input: BootstrapRefreshInput): WorkerEnvironmentRecord;
transition(input: TransitionInput): WorkerEnvironmentRecord;
renewCredential(input: CredentialInput & {
environmentId: string;
expectedOwnerEpoch: number;
assertCurrent?: () => void;
}): WorkerCredentialRecord;
markCredentialDelivered(input: {
environmentId: string;
credentialHash: string;
ownerEpoch: number;
sessionId: string | null;
deliveredAtMs: number;
assertCurrent?: () => void;
}): void;
recordError(input: {
environmentId: string;
state: WorkerEnvironmentState;
error: string;
assertCurrent?: () => void;
}): WorkerEnvironmentRecord;
ensurePreparedIntent(input: {
intent: WorkerEnvironmentIntentInput & {
preparation: WorkerEnvironmentPreparationIntent;
};
projectKey: string;
target: number;
maxTotal: number;
assertCurrent: () => void;
}): WorkerEnvironmentRecord | undefined;
requestPreparedDestroy(input: {
environmentId: string;
ownerEpoch: number;
preparationKey: string;
reason: "expired" | "invalidated";
assertCurrent: () => void;
}): WorkerEnvironmentRecord | undefined;
createSessionAttachmentIntent(input: WorkerEnvironmentIntentInput & WorkerEnvironmentSessionIdentity, assertCurrent: () => void): {
attachment: WorkerEnvironmentAttachmentRecord;
environment: WorkerEnvironmentRecord;
};
closeSessionAttachment(sessionId: string, assertCurrent?: () => void): WorkerEnvironmentAttachmentRecord | undefined;
cancelSessionAttachmentReservation(record: WorkerEnvironmentAttachmentRecord): void;
touchSessionAttachment(record: WorkerEnvironmentAttachmentRecord, assertCurrent: () => void): void;
pruneTerminalEnvironments(input: {
approved: WorkerEnvironmentPruneObservation[];
}): number;
};
//#endregion
//#region src/gateway/worker-environments/prepared-environment-store.d.ts
type PreparedReservationCandidate = Pick<WorkerEnvironmentRecord, "environmentId" | "profileId" | "profileSnapshot" | "leaseId" | "state" | "preparation" | "destroyRequestedAtMs" | "createdAtMs">;
declare function selectPreparedEnvironmentReservations(records: readonly PreparedReservationCandidate[]): {
environmentId: string;
profileId: string;
leaseId: string | null;
cleanupOrder: number;
state: WorkerEnvironmentLeasedState | WorkerEnvironmentUnleasedState;
purpose: "build" | "reserve";
projectKey: string;
createdAtMs: number;
}[];
type Reservations = ReturnType<typeof selectPreparedEnvironmentReservations>;
declare function preparedCapacityFromReservations(reserved: Reservations, input: {
profileId: string;
projectKey: string;
target: number;
maxTotal: number;
}): number;
declare function isPreparedReservationWithinCapacity(reservations: Reservations, input: {
environmentId: string;
target: number;
maxTotal: number;
}): boolean;
//#endregion
//#region src/gateway/worker-environments/store.d.ts
type Input<Method extends keyof WorkerEnvironmentMutationMethods> = Parameters<WorkerEnvironmentMutationMethods[Method]>[0];
declare function createWorkerEnvironmentStore(options?: {
database?: OpenClawStateDatabase;
now?: () => number;
}): Promise<{
close: () => Promise<void>;
ready: () => Promise<void>;
hasSessionAttachment(environmentId: string): Promise<boolean>;
inventoryVersion: () => number;
get: (id: string) => WorkerEnvironmentRecord | undefined;
list: () => WorkerEnvironmentRecord[];
listForReconcile: () => WorkerEnvironmentRecord[];
getCredential: (id: string) => WorkerCredentialRecord | undefined;
findCredentialByHash: (hash: string) => WorkerCredentialRecord | undefined;
getTransferOwner: (id: string) => {
environment: {
ownerEpoch: number;
attachedSessionIds: string[];
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentLeasedState | WorkerEnvironmentUnleasedState;
};
credential: {
ownerEpoch: number;
expiresAtMs: number;
sessionId: string | null;
} | undefined;
} | undefined;
hasNodeEnrollmentOwner: (nodeId: string) => boolean;
hasPendingNodeEnrollmentSetup: (setup: string, device: string) => boolean;
preparedCapacity: (input: Parameters<typeof preparedCapacityFromReservations>[1]) => number;
preparedReservationEnvironmentIds: () => string[];
isPreparedIntentWithinCapacity: (input: Parameters<typeof isPreparedReservationWithinCapacity>[1]) => boolean;
getSessionAttachmentRecord: (id: string) => WorkerEnvironmentAttachmentRecord | undefined;
listSessionAttachmentRecords: () => WorkerEnvironmentAttachmentRecord[];
findSessionAttachmentRecord(input: Pick<WorkerEnvironmentSessionIdentity, "agentId" | "sessionKey">): WorkerEnvironmentAttachmentRecord | undefined;
onCredentialRevoked(listener: (id: string) => void): () => void;
createIntent: (input: Input<"createIntent">, assertCurrent?: () => void) => Promise<WorkerEnvironmentRecord>;
ensureNodeEnrollment: (input: string) => Promise<WorkerEnvironmentRecord>;
revokeEnvironmentCredential(input: string, opts?: {
fenceWorkspaceTransfers?: boolean;
expectedOwnerEpoch?: number;
assertCurrent?: () => void;
}): Promise<void>;
reconcileSharedHost: (input: Input<"reconcileSharedHost">) => Promise<WorkerEnvironmentRecord>;
adoptProvisionCleanupFailure: (input: Input<"adoptProvisionCleanupFailure">) => Promise<WorkerEnvironmentRecord>;
requestDestroy({ assertCurrent, ...input }: Input<"requestDestroy">): Promise<WorkerEnvironmentRecord>;
refreshBootstrapReceipt({ assertCurrent, ...input }: Input<"refreshBootstrapReceipt">): Promise<WorkerEnvironmentRecord>;
transition({ assertCurrent, placementBinding, ...input }: Input<"transition">): Promise<WorkerEnvironmentRecord>;
renewCredential({ assertCurrent, ...input }: Input<"renewCredential">): Promise<WorkerCredentialRecord>;
markCredentialDelivered({ assertCurrent, ...input }: Input<"markCredentialDelivered">): Promise<void>;
recordError({ assertCurrent, ...input }: Input<"recordError">): Promise<WorkerEnvironmentRecord>;
ensurePreparedIntent({ assertCurrent, ...input }: Input<"ensurePreparedIntent">): Promise<WorkerEnvironmentRecord | undefined>;
requestPreparedDestroy({ assertCurrent, ...input }: Input<"requestPreparedDestroy">): Promise<WorkerEnvironmentRecord | undefined>;
createSessionAttachmentIntent(input: Input<"createSessionAttachmentIntent">, assertCurrent: () => void): Promise<{
attachment: WorkerEnvironmentAttachmentRecord;
environment: WorkerEnvironmentRecord;
}>;
closeSessionAttachment(input: string, assertCurrent?: () => void): Promise<WorkerEnvironmentAttachmentRecord | undefined>;
cancelSessionAttachmentReservation(input: Input<"cancelSessionAttachmentReservation">): Promise<void>;
touchSessionAttachment(input: Input<"touchSessionAttachment">, assertCurrent: () => void): Promise<void>;
pruneTerminalEnvironments(input?: WorkerEnvironmentPruneInput): Promise<number>;
}>;
type WorkerEnvironmentStore = Awaited<ReturnType<typeof createWorkerEnvironmentStore>>;
//#endregion
//#region src/gateway/worker-environments/placement-store.d.ts
declare const RETIRABLE_PLACEMENT_STATES: readonly ["local", "requested", "reclaimed", "failed"];
type WorkerSessionPlacementRetirement = {
sessionId: string;
expectedState: (typeof RETIRABLE_PLACEMENT_STATES)[number];
expectedGeneration: number;
};
declare function createWorkerSessionPlacementStore(options?: {
database?: OpenClawStateDatabase;
now?: () => number;
}): {
getWorkspaceReconciliationPlacement(owner: {
sessionId: string;
environmentId: string;
ownerEpoch: number;
placementGeneration: number;
}): (WorkerSessionPlacementIdentity & {
generation: number;
executionMode: WorkerPlacementExecutionMode;
turnClaim: PersistedTurnClaim | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
workspaceResultConflict?: WorkerWorkspaceResultConflict;
} & Omit<Omit<Omit<{
environmentId: null;
activeOwnerEpoch: null;
workspaceBaseManifestRef: null;
remoteWorkspaceDir: null;
workerBundleHash: null;
lastTranscriptAckCursor: null;
lastLiveEventAckCursor: null;
recoveryError: null;
terminalReason: null;
terminalAtMs: null;
}, "environmentId" | "workerBundleHash"> & {
environmentId: string;
workerBundleHash: string;
}, "remoteWorkspaceDir" | "workspaceBaseManifestRef"> & {
workspaceBaseManifestRef: string;
remoteWorkspaceDir: string;
}, "activeOwnerEpoch" | "lastLiveEventAckCursor" | "lastTranscriptAckCursor"> & {
activeOwnerEpoch: number;
lastTranscriptAckCursor: number | null;
lastLiveEventAckCursor: number | null;
} & {
state: "active";
}) | (WorkerSessionPlacementIdentity & {
generation: number;
executionMode: WorkerPlacementExecutionMode;
turnClaim: PersistedTurnClaim | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
workspaceResultConflict?: WorkerWorkspaceResultConflict;
} & Omit<Omit<Omit<{
environmentId: null;
activeOwnerEpoch: null;
workspaceBaseManifestRef: null;
remoteWorkspaceDir: null;
workerBundleHash: null;
lastTranscriptAckCursor: null;
lastLiveEventAckCursor: null;
recoveryError: null;
terminalReason: null;
terminalAtMs: null;
}, "environmentId" | "workerBundleHash"> & {
environmentId: string;
workerBundleHash: string;
}, "remoteWorkspaceDir" | "workspaceBaseManifestRef"> & {
workspaceBaseManifestRef: string;
remoteWorkspaceDir: string;
}, "activeOwnerEpoch" | "lastLiveEventAckCursor" | "lastTranscriptAckCursor"> & {
activeOwnerEpoch: number;
lastTranscriptAckCursor: number | null;
lastLiveEventAckCursor: number | null;
} & {
state: "draining";
}) | undefined;
listWorkspaceReconciliationOwners(): {
sessionId: string;
environmentId: string;
ownerEpoch: number;
placementGeneration: number;
}[];
pruneOrphanedWorkspaceReconciliations(options: {
retainFailedOwner: (recoveryError: string) => boolean;
}): {
sessionId: string;
environmentId: string;
ownerEpoch: number;
placementGeneration: number;
}[];
loadWorkspaceReconciliation(owner: {
sessionId: string;
environmentId: string;
ownerEpoch: number;
placementGeneration: number;
}, options?: {
allowFailedOwner?: boolean;
}): WorkerWorkspaceReconciliationJournal | undefined;
beginWorkspaceReconciliation(owner: {
sessionId: string;
environmentId: string;
ownerEpoch: number;
placementGeneration: number;
}, journal: WorkerWorkspaceReconciliationJournal): void;
abortWorkspaceReconciliation(owner: {
sessionId: string;
environmentId: string;
ownerEpoch: number;
placementGeneration: number;
}, options?: {
force?: boolean;
}): void;
workspaceResultInstanceId(): string;
validateWorkspaceResultClaim(claim: WorkerSessionTurnClaim): boolean;
listPendingWorkspaceResults(sessionId?: string): WorkerWorkspacePendingResult[];
markWorkspaceResultPending(claim: WorkerSessionTurnClaim): void;
recordStagedWorkspaceResult(claim: WorkerSessionTurnClaim, stagedResultRef: string, repositoryWorkspaceId?: string): void;
acceptWorkspaceResult(claim: WorkerSessionTurnClaim): void;
handoffWorkspaceResultRecovery(claim: WorkerSessionTurnClaim): void;
abandonWorkspaceResult(pending: WorkerWorkspacePendingResult): void;
getPlacementMove(sessionId: string): WorkerPlacementMoveIntent | undefined;
beginPlacementMove(input: {
sessionId: string;
source: WorkerPlacementMoveSource;
target: WorkerPlacementMoveTarget;
abandonSource?: true;
}): {
intent: WorkerPlacementMoveIntent;
placement: WorkerSessionPlacementRecord;
joined: boolean;
};
recordPlacementMoveError(input: {
operationId: string;
sessionId: string;
error: string;
}): boolean;
cancelPlacementMove(input: {
operationId: string;
sessionId: string;
}): void;
completePlacementMoveSourceToLocal(input: {
operationId: string;
sessionId: string;
expectedGeneration: number;
}): WorkerSessionPlacementRecord;
completeAbandonedPlacementMoveSourceToLocal(input: {
operationId: string;
sessionId: string;
expectedGeneration: number;
expectedRecoveryError: string;
}): WorkerSessionPlacementRecord;
completePlacementMoveToWorker(input: {
operationId: string;
sessionId: string;
expectedGeneration: number;
environmentId: string;
ownerEpoch: number;
}): WorkerSessionPlacementRecord;
authorizeWorkerTurnTools(claim: WorkerSessionTurnClaim, toolNames: readonly string[]): void;
isWorkerTurnToolAuthorized(claim: WorkerSessionTurnClaim, toolName: string): boolean;
closeWorkerTurnToolAdmission(claim: WorkerSessionTurnClaim): void;
closeWorkerTurnToolState(claim: WorkerSessionTurnClaim): Promise<void>;
beginWorkerSessionToolOperation(params: {
claim: WorkerSessionTurnClaim;
toolName: "sessions_spawn" | "sessions_send";
toolCallId: string;
requestDigest: string;
childSessionKey?: string;
}): {
kind: "execute";
operationSeed: string;
childSessionKey?: string;
} | {
kind: "in-progress";
} | {
kind: "completed";
resultJson: string;
} | {
kind: "unknown";
} | {
kind: "capacity";
} | {
kind: "conflict";
} | {
kind: "unauthorized";
};
bindWorkerSessionToolOperationChild(params: {
sourceSessionId: string;
sourceClaimId: string;
toolCallId: string;
requestDigest: string;
} & {
childSessionKey: string;
}): boolean;
completeWorkerSessionToolOperation(params: {
sourceSessionId: string;
sourceClaimId: string;
toolCallId: string;
requestDigest: string;
} & {
resultJson: string;
failed?: boolean;
}): boolean;
abandonWorkerSessionToolOperation(params: {
sourceSessionId: string;
sourceClaimId: string;
toolCallId: string;
requestDigest: string;
}): boolean;
recoverWorkerSessionToolOperationsAfterRestart(): number;
failWorkspaceResultAndReleaseTurn(pending: WorkerWorkspacePendingResult, error: unknown): WorkerSessionPlacementRecord;
withWorkspaceExclusion: <T>(sessionId: string, run: (assertOwned: () => void) => Promise<T>) => Promise<T>;
withLocalWorkspaceReservation: <T>(identity: WorkerSessionPlacementIdentity, run: (assertCurrent: () => void) => Promise<T>) => Promise<T>;
withRepositoryWorkspaceReservation: <T>(identity: WorkerSessionPlacementIdentity, run: (assertCurrent: () => void) => Promise<T>) => Promise<T>;
claimReclaimWorkspaceResult(input: WorkerTurnClaimInput, beforePublish?: (claim: WorkerSessionTurnClaim) => void): WorkerSessionTurnClaim;
claimWorkspaceMutationResult(input: Omit<WorkerTurnClaimInput, "runId">): WorkerSessionTurnClaim;
completeWorkspaceResultAndReleaseTurn(claim: WorkerSessionTurnClaim): WorkerSessionPlacementRecord;
cancelWorkspaceResultAndReleaseTurn(claim: WorkerSessionTurnClaim, options?: {
reason: "node-disconnect";
}): WorkerSessionPlacementRecord;
clearLocalTurnClaimsAfterRestart(): number;
waitForTurnClaimRelease(sessionIdInput: string, waitOptions: {
timeoutMs?: number;
signal?: AbortSignal;
}): Promise<void>;
validateTurnClaim(claim: WorkerSessionTurnClaim): boolean;
updateAckCursors(input: {
claim: WorkerSessionTurnClaim;
transcript?: number;
liveEvent?: number;
}): WorkerSessionPlacementRecord;
updateWorkspaceBaseManifest(input: {
claim: WorkerSessionTurnClaim;
manifestRef: string;
}): WorkerSessionPlacementRecord;
retainInterruptedTurnWorkspace(claim: Parameters<(claim: WorkerSessionTurnClaim) => WorkerSessionPlacementRecord>[0], assertCurrent: () => void): Promise<void>;
handoffRuntimeRefreshResult(input: Omit<PlacementTurnClaimWorkerOperations["placementTurns.handoffRuntimeRefreshResult"]["input"], "nowMs">, assertCurrent?: () => void): Promise<WorkerSessionPlacementRecord>;
claimTurn(input: Parameters<(input: WorkerTurnClaimInput) => WorkerSessionTurnClaim>[0], assertCurrent?: () => void): Promise<WorkerSessionTurnClaim>;
releaseTurn(claim: Parameters<(claim: WorkerSessionTurnClaim) => WorkerSessionPlacementRecord>[0], assertCurrent?: () => void): Promise<WorkerSessionPlacementRecord>;
releaseTurnIfOwned(claim: Parameters<(claim: WorkerSessionTurnClaim) => WorkerSessionPlacementRecord>[0]): Promise<void>;
registerTurnClaimClosedHandler(handler: (claim: WorkerSessionTurnClaim) => void): () => void;
get(sessionId: string): WorkerSessionPlacementRecord | undefined;
prepareTurnClaimAuthority(claim: WorkerSessionTurnClaim): Promise<PlacementTurnClaimAuthority>;
prepareRuntimeRefresh(sessionIdInput: string): Promise<{
assertCurrent(this: void): void;
release(this: void): void;
placement: WorkerSessionPlacementRecord | undefined;
move: WorkerPlacementMoveIntent | undefined;
pendingResult: WorkerWorkspacePendingResult | undefined;
}>;
readProjection(sessionIds: readonly string[], readOptions?: {
current?: boolean;
}): Promise<WorkerSessionPlacementProjection>;
readRecoveryCandidates(): Promise<WorkerPlacementRecoveryCandidate[]>;
getMany(sessionIds: readonly string[]): ReadonlyMap<string, WorkerSessionPlacementRecord>;
getWorkspaceResultReconcilingSessionIds(sessionIds: readonly string[]): ReadonlySet<string>;
retireSessionPlacement(input: WorkerSessionPlacementRetirement): void;
recordWorkspaceResultConflict(claim: WorkerSessionTurnClaim, conflict: WorkerWorkspaceResultConflict | undefined): void;
bindPreparedEnvironment(input: PreparedEnvironmentSelection): WorkerSessionPlacementRecord | undefined;
startDispatch(input: WorkerSessionPlacementDispatchIdentity, dispatchOptions?: {
assertCurrent?: () => void;
}): Promise<WorkerSessionPlacementRecord>;
transition(input: {
sessionId: string;
from: WorkerSessionPlacementState;
to: WorkerSessionPlacementState;
expectedGeneration: number;
patch?: WorkerSessionPlacementTransitionPatch;
}): WorkerSessionPlacementRecord;
startDrain(input: {
sessionId: string;
environmentId: string;
ownerEpoch: number;
expectedGeneration: number;
workspaceBaseManifestRef?: string;
}): WorkerSessionPlacementRecord;
startWorkspaceResultDrain(claim: WorkerSessionTurnClaim): WorkerSessionPlacementRecord;
startReconcile(input: {
sessionId: string;
environmentId: string;
ownerEpoch: number;
expectedGeneration: number;
forceLocalClaim?: true;
}): WorkerSessionPlacementRecord;
fail(input: {
sessionId: string;
recoveryError: string;
expectedGeneration?: number;
}): WorkerSessionPlacementRecord;
adoptActive(input: {
sessionId: string;
environmentId: string;
ownerEpoch: number;
expectedGeneration?: number;
}): WorkerSessionPlacementRecord;
listForReconcile(sessionKey?: string): WorkerSessionPlacementRecord[];
list(): WorkerSessionPlacementRecord[];
readChangeSnapshot(profileIds?: readonly string[]): Promise<WorkerSessionPlacementChangeSnapshot[]>;
};
type WorkerSessionPlacementStore = ReturnType<typeof createWorkerSessionPlacementStore>;
type WorkerSessionPlacementRetirementService = Pick<WorkerSessionPlacementStore, "retireSessionPlacement">;
//#endregion
//#region src/process/exec-output.d.ts
type CommandOutputCaptureMode = "head" | "tail" | "discard";
type CommandOutputStream = "stdout" | "stderr";
type CommandOutputCaptureOption = CommandOutputCaptureMode | {
stdout?: CommandOutputCaptureMode;
stderr?: CommandOutputCaptureMode;
};
type CommandOutputLimitOption = boolean | {
stdout?: boolean;
stderr?: boolean;
combined?: boolean;
};
type CommandOutputErrorOption = boolean | {
stdout?: boolean;
stderr?: boolean;
};
type PreserveOutputLine = (line: string, stream: CommandOutputStream) => boolean;
//#endregion
//#region src/process/exec-result.d.ts
type SpawnResult = {
pid?: number;
stdout: string;
stderr: string;
stdoutTruncatedBytes?: number;
stderrTruncatedBytes?: number;
preservedStdoutLines?: string[];
preservedStderrLines?: string[];
code: number | null;
signal: NodeJS.Signals | null;
killed: boolean;
/** The runner accepted cancellation and requested termination, independent of the OS signal. */
killIssuedByAbort?: boolean;
/** Completion of this invocation's cleanup; never an escaped-descendant inventory. */
cleanup?: "normal" | "cooperative" | "forced" | "uncertain";
termination: "exit" | "timeout" | "no-output-timeout" | "signal";
noOutputTimedOut?: boolean;
outputLimitExceeded?: boolean;
outputErrorStream?: "stdout" | "stderr";
};
//#endregion
//#region src/process/exec-runner.d.ts
type CommandOptions = {
timeoutMs?: number;
cwd?: string;
input?: string | Uint8Array;
/** Borrow a caller-owned descriptor as stdin without buffering or piping its bytes. */
stdinFileDescriptor?: number;
/** Synchronous admission with the spawned PID and argv, before input is released. */
beforeInput?: (pid: number, argv?: readonly string[]) => void;
baseEnv?: NodeJS.ProcessEnv;
env?: NodeJS.ProcessEnv;
windowsVerbatimArguments?: boolean;
noOutputTimeoutMs?: number;
signal?: AbortSignal;
maxOutputBytes?: number | {
stdout?: number;
stderr?: number;
};
maxCombinedOutputBytes?: number;
outputCapture?: CommandOutputCaptureOption;
/** Observe raw output without owning child lifecycle. Return false to stop the command. */
onOutputChunk?: (chunk: Buffer, stream: CommandOutputStream) => boolean | void;
/** Accept a successful exit when only the selected diagnostic output stream failed. */
tolerateOutputError?: {
stdout?: boolean;
stderr?: boolean;
};
/** Terminate when the selected output stream emits an error. */
terminateOnOutputError?: CommandOutputErrorOption;
terminateOnOutputLimit?: CommandOutputLimitOption;
maxPreservedOutputLines?: number;
preserveOutputLine?: PreserveOutputLine;
killProcessTree?: boolean;
/** Join owned descendants even after a successful root exits. */
requireProcessTreeExtinction?: boolean;
/** Initial signal for direct-child and graceful process-group cancellation. */
killSignal?: NodeJS.Signals | number;
/** Grace between graceful termination and the force-kill fallback. */
killGraceMs?: number;
};
declare function runCommandWithTimeout(argv: string[], optionsOrTimeout: number | CommandOptions): Promise<SpawnResult>;
//#endregion
//#region src/worker/tool-authority.d.ts
/** Gateway-proxied tools exposed through the closed worker protocol. */
declare const WORKER_SESSION_TOOL_NAMES: readonly ["skill_workshop", "sessions_spawn", "sessions_send", "portal", "presence"];
declare const WORKER_TOOL_NAMES: readonly ["read", "write", "edit", "apply_patch", "exec", "process", "browser", "computer", "skill_workshop", "sessions_spawn", "sessions_send", "portal", "presence"];
type WorkerSessionToolName = (typeof WORKER_SESSION_TOOL_NAMES)[number];
type WorkerToolName = (typeof WORKER_TOOL_NAMES)[number];
type WorkerExecAuthority = {
security: ExecSecurity;
ask: ExecAsk;
/** No host-specific approvals or default safe bins may be reconstructed remotely. */
safeBins?: [];
} & ({
host: Exclude<ExecHost, "node">;
node?: never;
} | {
host: "node";
node?: string;
});
type WorkerToolAuthority = {
allowedToolNames: WorkerToolName[];
/**
* Effective exec policy resolved at the Gateway. Optional for protocol compatibility only;
* consumers must treat an absent value as denied rather than re-deriving it worker-side.
*/
exec?: WorkerExecAuthority;
};
//#endregion
//#region src/worker/launch-descriptor.d.ts
type WorkerLaunchPermissionContext = {
permissionMode: SessionPermissionMode;
workerContainmentRoot: string;
} | {
permissionMode?: never;
workerContainmentRoot?: never;
};
type WorkerComputerLaunchDescriptor = z.infer<typeof ComputerLaunchSchema>;
type WorkerLaunchAssignment = Omit<z.infer<typeof AssignmentSchema>, "permissionMode" | "workerContainmentRoot"> & WorkerLaunchPermissionContext;
type WorkerLaunchAdmission = Omit<WorkerConnectParams["admission"], "runId"> & {
sessionId: string;
};
type WorkerLaunchPlan = {
version: 4;
admission: WorkerLaunchAdmission;
assignment: WorkerLaunchAssignment;
};
declare const ComputerLaunchSchema: z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
nodeId: z.ZodString;
computerUse: z.ZodCustom<{
contractVersion: 2;
provider: {
id: string;
label: string;
generation: string;
};
actions: ("bring_to_front" | "browser_click" | "browser_dialog" | "browser_download" | "browser_navigate" | "browser_pointer" | "browser_prepare" | "browser_set_input_files" | "browser_type" | "double_click" | "escalate_scope" | "get_accessibility_tree" | "get_browser_state" | "get_cursor_position" | "get_recording_state" | "get_window_state" | "hold_key" | "invoke_menu" | "key" | "kill_app" | "launch_app" | "left_click" | "left_click_drag" | "left_mouse_down" | "left_mouse_up" | "list_apps" | "list_windows" | "middle_click" | "mouse_move" | "replay_trajectory" | "right_click" | "screenshot" | "scroll" | "set_value" | "start_recording" | "stop_recording" | "triple_click" | "type" | "wait" | "zoom")[];
targets: ("browser" | "element" | "screen" | "window")[];
deliveryModes: ("background" | "foreground")[];
observations: ("accessibility" | "browser" | "image")[];
features: {
recording: boolean;
agentCursor: boolean;
multiDisplay: boolean;
};
}, {
contractVersion: 2;
provider: {
id: string;
label: string;
generation: string;
};
actions: ("bring_to_front" | "browser_click" | "browser_dialog" | "browser_download" | "browser_navigate" | "browser_pointer" | "browser_prepare" | "browser_set_input_files" | "browser_type" | "double_click" | "escalate_scope" | "get_accessibility_tree" | "get_browser_state" | "get_cursor_position" | "get_recording_state" | "get_window_state" | "hold_key" | "invoke_menu" | "key" | "kill_app" | "launch_app" | "left_click" | "left_click_drag" | "left_mouse_down" | "left_mouse_up" | "list_apps" | "list_windows" | "middle_click" | "mouse_move" | "replay_trajectory" | "right_click" | "screenshot" | "scroll" | "set_value" | "start_recording" | "stop_recording" | "triple_click" | "type" | "wait" | "zoom")[];
targets: ("browser" | "element" | "screen" | "window")[];
deliveryModes: ("background" | "foreground")[];
observations: ("accessibility" | "browser" | "image")[];
features: {
recording: boolean;
agentCursor: boolean;
multiDisplay: boolean;
};
}>;
}, z.core.$strip>>;
declare const AssignmentSchema: z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
skillAuthoring: z.ZodOptional<z.ZodCustom<{
multipleProfiles: boolean;
}, {
multipleProfiles: boolean;
}>>;
skillResources: z.ZodOptional<z.ZodCustom<{
version: 1;
skills: {
sourcePath?: string | undefined;
modelVisible?: boolean | undefined;
name: string;
displayName?: string | undefined;
description: string;
revision: string;
files: {
path: string;
content: string;
encoding?: "base64" | "utf8" | undefined;
executable?: boolean | undefined;
}[];
}[];
}, {
version: 1;
skills: {
sourcePath?: string | undefined;
modelVisible?: boolean | undefined;
name: string;
displayName?: string | undefined;
description: string;
revision: string;
files: {
path: string;
content: string;
encoding?: "base64" | "utf8" | undefined;
executable?: boolean | undefined;
}[];
}[];
}>>;
agentId: z.ZodString;
operationalRunInstance: z.ZodReadonly<z.ZodObject<{
instanceId: z.ZodString;
runId: z.ZodString;
}, z.core.$strip>>;
agentRuntimeIdentityToken: z.ZodString;
runId: z.ZodString;
turnId: z.ZodString;
prompt: z.ZodCustom<string | ({
type: "text";
text: string;
textSignature?: string | undefined;
} | {
type: "image";
data: string;
mimeType: string;
})[], string | ({
type: "text";
text: string;
textSignature?: string | undefined;
} | {
type: "image";
data: string;
mimeType: string;
})[]>;
suppressPromptTranscript: z.ZodBoolean;
workspaceDir: z.ZodString;
modelRef: z.ZodCustom<{
readonly provider: string;
readonly model: string;
}, {
readonly provider: string;
readonly model: string;
}>;
inferenceOptions: z.ZodCustom<{
readonly temperature?: number | undefined;
readonly maxTokens?: number | undefined;
readonly reasoning?: "adaptive" | "high" | "low" | "max" | "medium" | "minimal" | "off" | "xhigh" | undefined;
readonly thinkingBudgets?: {
readonly minimal?: number | undefined;
readonly low?: number | undefined;
readonly medium?: number | undefined;
readonly high?: number | undefined;
readonly max?: number | undefined;
} | undefined;
}, {
readonly temperature?: number | undefined;
readonly maxTokens?: number | undefined;
readonly reasoning?: "adaptive" | "high" | "low" | "max" | "medium" | "minimal" | "off" | "xhigh" | undefined;
readonly thinkingBudgets?: {
readonly minimal?: number | undefined;
readonly low?: number | undefined;
readonly medium?: number | undefined;
readonly high?: number | undefined;
readonly max?: number | undefined;
} | undefined;
}>;
systemPrompt: z.ZodOptional<z.ZodString>;
initialMessages: z.ZodCustom<({
role: "user";
content: ({
type: "text";
text: string;
textSignature?: string | undefined;
} | {
type: "image";
data: string;
mimeType: string;
})[];
timestamp: number;
} | {
role: "assistant";
content: ({
type: "text";
text: string;
textSignature?: string | undefined;
} | {
type: "thinking";
thinking: string;
thinkingSignature?: string | undefined;
redacted?: boolean | undefined;
} | {
type: "toolCall";
id: string;
name: string;
arguments: Record<string, unknown>;
thoughtSignature?: string | undefined;
executionMode?: "parallel" | "sequential" | undefined;
})[];
api: string;
provider: string;
model: string;
responseModel?: string | undefined;
responseId?: string | undefined;
providerReplay?: {
v: 1;
type: string;
id?: string | undefined;
data: string;
replayIndex?: number | undefined;
provider: string;
api: string;
model: string;
baseUrlHash?: string | undefined;
sessionHash?: string | undefined;
authProfileHash?: string | undefined;
} | undefined;
diagnostics?: {
type: string;
timestamp: number;
error?: {
name?: string | undefined;
message: string;
stack?: string | undefined;
code?: string | number | undefined;
} | undefined;
details?: Record<string, unknown> | undefined;
}[] | undefined;
usage: {
input: number;
output: number;
cacheRead: number;
cacheWrite: number;
contextUsage?: {
state: "available";
promptTokens: number;
totalTokens: number;
} | {
state: "unavailable";
} | undefined;
totalTokens: number;
cost: {
input: number;
output: number;
cacheRead: number;
cacheWrite: number;
total: number;
totalOrigin?: "provider-billed" | undefined;
};
};
stopReason: "aborted" | "error" | "length" | "stop" | "toolUse";
errorMessage?: string | undefined;
errorCode?: string | undefined;
errorType?: string | undefined;
errorBody?: string | undefined;
timestamp: number;
} | {
role: "toolResult";
toolCallId: string;
toolName: string;
content: ({
type: "text";
text: string;
textSignature?: string | undefined;
} | {
type: "image";
data: string;
mimeType: string;
})[];
details?: unknown;
isError: boolean;
timestamp: number;
})[], ({
role: "user";
content: ({
type: "text";
text: string;
textSignature?: string | undefined;
} | {
type: "image";
data: string;
mimeType: string;
})[];
timestamp: number;
} | {
role: "assistant";
content: ({
type: "text";
text: string;
textSignature?: string | undefined;
} | {
type: "thinking";
thinking: string;
thinkingSignature?: string | undefined;
redacted?: boolean | undefined;
} | {
type: "toolCall";
id: string;
name: string;
arguments: Record<string, unknown>;
thoughtSignature?: string | undefined;
executionMode?: "parallel" | "sequential" | undefined;
})[];
api: string;
provider: string;
model: string;
responseModel?: string | undefined;
responseId?: string | undefined;
providerReplay?: {
v: 1;
type: string;
id?: string | undefined;
data: string;
replayIndex?: number | undefined;
provider: string;
api: string;
model: string;
baseUrlHash?: string | undefined;
sessionHash?: string | undefined;
authProfileHash?: string | undefined;
} | undefined;
diagnostics?: {
type: string;
timestamp: number;
error?: {
name?: string | undefined;
message: string;
stack?: string | undefined;
code?: string | number | undefined;
} | undefined;
details?: Record<string, unknown> | undefined;
}[] | undefined;
usage: {
input: number;
output: number;
cacheRead: number;
cacheWrite: number;
contextUsage?: {
state: "available";
promptTokens: number;
totalTokens: number;
} | {
state: "unavailable";
} | undefined;
totalTokens: number;
cost: {
input: number;
output: number;
cacheRead: number;
cacheWrite: number;
total: number;
totalOrigin?: "provider-billed" | undefined;
};
};
stopReason: "aborted" | "error" | "length" | "stop" | "toolUse";
errorMessage?: string | undefined;
errorCode?: string | undefined;
errorType?: string | undefined;
errorBody?: string | undefined;
timestamp: number;
} | {
role: "toolResult";
toolCallId: string;
toolName: string;
content: ({
type: "text";
text: string;
textSignature?: string | undefined;
} | {
type: "image";
data: string;
mimeType: string;
})[];
details?: unknown;
isError: boolean;
timestamp: number;
})[]>;
transcript: z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
baseLeafId: z.ZodNullable<z.ZodString>;
nextSeq: z.ZodNumber;
}, z.core.$strip>>;
liveEvents: z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
ackedSeq: z.ZodNumber;
nextSeq: z.ZodNumber;
}, z.core.$strip>>;
toolAuthority: z.ZodPipe<z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
allowedToolNames: z.ZodPipe<z.ZodCustom<("apply_patch" | "browser" | "computer" | "edit" | "exec" | "portal" | "presence" | "process" | "read" | "sessions_send" | "sessions_spawn" | "skill_workshop" | "write")[], ("apply_patch" | "browser" | "computer" | "edit" | "exec" | "portal" | "presence" | "process" | "read" | "sessions_send" | "sessions_spawn" | "skill_workshop" | "write")[]>, z.ZodTransform<("apply_patch" | "browser" | "computer" | "edit" | "exec" | "portal" | "presence" | "process" | "read" | "sessions_send" | "sessions_spawn" | "skill_workshop" | "write")[], ("apply_patch" | "browser" | "computer" | "edit" | "exec" | "portal" | "presence" | "process" | "read" | "sessions_send" | "sessions_spawn" | "skill_workshop" | "write")[]>>;
exec: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodUnknown, z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
security: z.ZodEnum<{
allowlist: "allowlist";
deny: "deny";
full: "full";
}>;
ask: z.ZodEnum<{
always: "always";
off: "off";
"on-miss": "on-miss";
}>;
safeBins: z.ZodOptional<z.ZodTuple<[], null>>;
host: z.ZodEnum<{
gateway: "gateway";
sandbox: "sandbox";
}>;
}, z.core.$strip>>>, z.ZodPipe<z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
security: z.ZodEnum<{
allowlist: "allowlist";
deny: "deny";
full: "full";
}>;
ask: z.ZodEnum<{
always: "always";
off: "off";
"on-miss": "on-miss";
}>;
safeBins: z.ZodOptional<z.ZodTuple<[], null>>;
host: z.ZodLiteral<"node">;
node: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>, z.ZodTransform<{
security: "allowlist" | "deny" | "full";
ask: "always" | "off" | "on-miss";
safeBins?: [] | undefined;
host: "node";
} | {
security: "allowlist" | "deny" | "full";
ask: "always" | "off" | "on-miss";
safeBins?: [] | undefined;
host: "node";
node: string;
}, {
security: "allowlist" | "deny" | "full";
ask: "always" | "off" | "on-miss";
safeBins?: [] | undefined;
host: "node";
node?: string | undefined;
}>>]>>;
}, z.core.$strip>>, z.ZodTransform<WorkerToolAuthority, {
allowedToolNames: ("apply_patch" | "browser" | "computer" | "edit" | "exec" | "portal" | "presence" | "process" | "read" | "sessions_send" | "sessions_spawn" | "skill_workshop" | "write")[];
exec?: {
security: "allowlist" | "deny" | "full";
ask: "always" | "off" | "on-miss";
safeBins?: [] | undefined;
host: "gateway" | "sandbox";
} | {
security: "allowlist" | "deny" | "full";
ask: "always" | "off" | "on-miss";
safeBins?: [] | undefined;
host: "node";
} | {
security: "allowlist" | "deny" | "full";
ask: "always" | "off" | "on-miss";
safeBins?: [] | undefined;
host: "node";
node: string;
} | undefined;
}>>;
browser: z.ZodOptional<z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
cdpUrl: z.ZodString;
launcherPath: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
launcherArgs: z.ZodOptional<z.ZodCustom<string[], string[]>>;
}, z.core.$strip>>>;
computer: z.ZodOptional<z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
nodeId: z.ZodString;
computerUse: z.ZodCustom<{
contractVersion: 2;
provider: {
id: string;
label: string;
generation: string;
};
actions: ("bring_to_front" | "browser_click" | "browser_dialog" | "browser_download" | "browser_navigate" | "browser_pointer" | "browser_prepare" | "browser_set_input_files" | "browser_type" | "double_click" | "escalate_scope" | "get_accessibility_tree" | "get_browser_state" | "get_cursor_position" | "get_recording_state" | "get_window_state" | "hold_key" | "invoke_menu" | "key" | "kill_app" | "launch_app" | "left_click" | "left_click_drag" | "left_mouse_down" | "left_mouse_up" | "list_apps" | "list_windows" | "middle_click" | "mouse_move" | "replay_trajectory" | "right_click" | "screenshot" | "scroll" | "set_value" | "start_recording" | "stop_recording" | "triple_click" | "type" | "wait" | "zoom")[];
targets: ("browser" | "element" | "screen" | "window")[];
deliveryModes: ("background" | "foreground")[];
observations: ("accessibility" | "browser" | "image")[];
features: {
recording: boolean;
agentCursor: boolean;
multiDisplay: boolean;
};
}, {
contractVersion: 2;
provider: {
id: string;
label: string;
generation: string;
};
actions: ("bring_to_front" | "browser_click" | "browser_dialog" | "browser_download" | "browser_navigate" | "browser_pointer" | "browser_prepare" | "browser_set_input_files" | "browser_type" | "double_click" | "escalate_scope" | "get_accessibility_tree" | "get_browser_state" | "get_cursor_position" | "get_recording_state" | "get_window_state" | "hold_key" | "invoke_menu" | "key" | "kill_app" | "launch_app" | "left_click" | "left_click_drag" | "left_mouse_down" | "left_mouse_up" | "list_apps" | "list_windows" | "middle_click" | "mouse_move" | "replay_trajectory" | "right_click" | "screenshot" | "scroll" | "set_value" | "start_recording" | "stop_recording" | "triple_click" | "type" | "wait" | "zoom")[];
targets: ("browser" | "element" | "screen" | "window")[];
deliveryModes: ("background" | "foreground")[];
observations: ("accessibility" | "browser" | "image")[];
features: {
recording: boolean;
agentCursor: boolean;
multiDisplay: boolean;
};
}>;
}, z.core.$strip>>>;
github: z.ZodOptional<z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
token: z.ZodString;
login: z.ZodString;
branch: z.ZodString;
remoteUrl: z.ZodOptional<z.ZodString>;
gitAuthor: z.ZodOptional<z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
name: z.ZodOptional<z.ZodString>;
email: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
permissionMode: z.ZodOptional<z.ZodCustom<"full" | "guarded" | "read-only" | "workspace", "full" | "guarded" | "read-only" | "workspace">>;
workerContainmentRoot: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
//#endregion
//#region src/worker/node-workspace-protocol.d.ts
declare const WorkspaceProcess: z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
action: z.ZodEnum<{
start: "start";
status: "status";
stop: "stop";
}>;
processId: z.ZodString;
}, z.core.$strip>>;
type NodeWorkerWorkspaceProcessInput = z.infer<typeof WorkspaceProcess>;
type NodeWorkerWorkspaceProcessResult = {
processId: string;
state: "running" | "exited";
};
declare const SeedInput: z.ZodUnion<readonly [z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
action: z.ZodLiteral<"apply">;
key: z.ZodString;
}, z.core.$strip>>, z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
action: z.ZodLiteral<"store">;
key: z.ZodString;
maxAgeMs: z.ZodNumber;
}, z.core.$strip>>]>;
type NodeWorkerWorkspaceSeedInput = z.infer<typeof SeedInput>;
type NodeWorkerWorkspaceExecResult = SpawnResult & {
workspaceDir: string;
process?: NodeWorkerWorkspaceProcessResult;
};
//#endregion
//#region src/worker/node-workspace-transfer-protocol.d.ts
declare const NodeWorkerWorkspaceTransferInputSchema: z.ZodUnion<readonly [z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
direction: z.ZodLiteral<"download">;
token: z.ZodString;
manifestRef: z.ZodString;
seedKey: z.ZodOptional<z.ZodString>;
attachments: z.ZodOptional<z.ZodLiteral<true>>;
checkpointBaseManifestRef: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>, z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
direction: z.ZodLiteral<"upload">;
token: z.ZodString;
baseManifestRef: z.ZodString;
referenceManifestRef: z.ZodString;
publicationBaseCommit: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>]>;
type NodeWorkerWorkspaceTransferInput = z.infer<typeof NodeWorkerWorkspaceTransferInputSchema>;
//#endregion
//#region src/gateway/worker-environments/workspace-hash-memo.d.ts
declare const { workspaceStatIdentity, selectWorkerWorkspaceHashMemoEntries }: {
workspaceStatIdentity: (owner: "gateway" | "worker", stats: {
dev: bigint;
ino: bigint;
size: bigint;
mtimeNs: bigint;
ctimeNs: bigint;
}) => string;
selectWorkerWorkspaceHashMemoEntries: (memo: ReadonlyMap<string, string>, maxEntries: number, maxBytes: number) => Array<[string, string]>;
};
//#endregion
//#region src/infra/git-read-operations.d.ts
type GitCheckoutContext = {
owner: string;
repo: string;
branch: string | null;
root?: string;
defaultBranch?: string;
};
//#endregion
//#region src/gateway/worker-environments/workspace-reconcile-core.d.ts
type WorkerWorkspaceApplyResult = {
manifestRef: string;
manifest: WorkerWorkspaceManifest;
conflictPaths: string[];
verifyLocalStable(): Promise<void>;
};
//#endregion
//#region src/gateway/worker-environments/tunnel-contract.d.ts
type WorkerTunnelRequest = {
environmentId: string;
ownerEpoch: number;
/** Initiating-operation authority; established tunnel custody is independent. */
authorize?: () => void;
};
/** Provider teardown fences local work first; only its confirmed result releases physical ownership. */
type WorkerTunnelStopReason = "provider-destroying" | "provider-destroyed";
type WorkerWorkspaceCommand = {
argv: readonly string[];
transportRetry: "idempotent" | "never";
/** Local owner guard revalidated after transport awaits, immediately before dispatch. */
assertCurrent?: () => void;
onDispatchReady?: () => void;
input?: string;
timeoutMs?: number;
signal?: AbortSignal;
transfer?: NodeWorkerWorkspaceTransferInput;
seed?: NodeWorkerWorkspaceSeedInput;
process?: NodeWorkerWorkspaceProcessInput;
};
type WorkerRepositoryCheckpointPayload = {
stagingRoot: string;
baseManifestRaw: string;
currentManifestRaw: string;
baseManifestRef: string;
currentManifestRef: string;
publicationStagingRoot?: string;
publicationDigest?: string;
};
type WorkerRepositoryCheckpointPreparation = {
verify(): Promise<void>;
publish(): Promise<unknown>;
discard(): Promise<void>;
};
/** Attested by the dedicated node's one-use workspace binding. */
type PreparedRepositoryWorkspace = {
baseCommit: string;
workspaceDir: string;
sourceManifestRef: string;
preparedManifestRef: string;
};
type WorkerRepositoryWorkspaceSource = {
kind: "repository";
/** Owner-held result of binding this exact dedicated prepared workspace. */
prepared?: PreparedRepositoryWorkspace;
url: string;
ref?: string;
branch: string;
baseCommit?: string;
gitToken?: string;
runSetupScript?: boolean;
checkpoint?: Pick<WorkerRepositoryCheckpointPayload, "stagingRoot" | "baseManifestRaw" | "currentManifestRaw" | "publicationStagingRoot" | "publicationDigest">;
};
type WorkerWorkspaceSyncRequest = {
/** Live initiating operation; retained workspace custody uses its independent owner. */
authorize?: () => void;
sessionId: string;
sessionKey?: string;
generation: number;
gitAuthor?: {
name?: string;
email?: string;
};
source: {
kind: "local";
path: string;
projectKey?: string;
} | WorkerRepositoryWorkspaceSource;
};
type WorkerWorkspaceSyncResult = {
mode: "git" | "plain";
remoteWorkspaceDir: string;
manifestRef: string;
} | {
mode: "repository";
remoteWorkspaceDir: string;
manifestRef: string;
baseCommit: string;
baseManifestRef: string;
};
type WorkerLocalWorkspaceReconcileRequest = {
localPath: string;
remoteWorkspaceDir: string;
baseManifestRef: string;
journal: WorkerWorkspaceReconciliationJournalAdapter;
assertCurrent?: () => void;
stagedResult: {
ref: string;
record(ref: string): void;
};
};
type WorkerWorkspaceReconcileRequest = {
remoteWorkspaceDir: string;
baseManifestRef: string;
source: {
kind: "local";
path: string;
journal: WorkerWorkspaceReconciliationJournalAdapter;
assertCurrent?: () => void;
stagedResult: WorkerLocalWorkspaceReconcileRequest["stagedResult"];
} | {
kind: "repository";
authorize?: () => void;
referenceManifestRef: string;
prepareCheckpoint(payload: WorkerRepositoryCheckpointPayload): Promise<WorkerRepositoryCheckpointPreparation>;
};
};
type WorkerWorkspaceReconcileResult = {
manifestRef: string;
changed: boolean;
/** Re-read the remote workspace after local acceptance, immediately before teardown. */
verifyStable(): Promise<void>;
/** Re-read the accepted local result after the remote stability fence. */
verifyLocalStable(): Promise<void>;
/** Apply the prepared candidate locally without making it restart-authoritative. */
applyPreparedStagedResult?(): Promise<void>;
/** Reverify and accept an exact local/base match without mutating either workspace. */
acceptUnchangedStagedResult?: () => Promise<void>;
/** Return the accepted local manifest and any keep-local conflicts after apply. */
getAppliedWorkspaceResult?(): WorkerWorkspaceApplyResult | undefined;
/** Publish the verified candidate for restart recovery. */
publishStagedResult(): Promise<void>;
discardPreparedStagedResult(): Promise<void>;
};
type WorkerWorkspaceQuiescence = {
/** Prove the watchdog lease still owns stopped processes and extend it through teardown. */
assertActive(): Promise<void>;
/** Resume only the remote processes stopped by this quiescence owner. */
resume(): Promise<void>;
};
type WorkerTurnLaunchRequest = {
plan: WorkerLaunchPlan;
turnClaim: WorkerSessionTurnClaim;
timeoutMs?: number;
credentialExpiresAtMs?: number;
signal?: AbortSignal;
onDispatchReady?: () => void;
};
type WorkerWorkspaceTunnelHandle = {
environmentId: string;
ownerEpoch: number;
launchTurn?: never;
measureLaunchTurn?: never;
readLaunchToolNames?: never;
runWorkspaceCommand(command: WorkerWorkspaceCommand): Promise<SpawnResult>;
stageAttachments?(request: {
localPath: string;
isAuthorized: () => boolean;
signal: AbortSignal;
}): Promise<void>;
quiesceWorkspace(remoteWorkspaceDir: string): Promise<WorkerWorkspaceQuiescence>;
syncWorkspace(request: WorkerWorkspaceSyncRequest): Promise<WorkerWorkspaceSyncResult>;
reconcileWorkspace(request: WorkerWorkspaceReconcileRequest): Promise<WorkerWorkspaceReconcileResult>;
stop(): Promise<void>;
};
type WorkerTurnTunnelHandle = Omit<WorkerWorkspaceTunnelHandle, "launchTurn" | "measureLaunchTurn" | "readLaunchToolNames"> & {
measureLaunchTurn(plan: WorkerLaunchPlan, claim: WorkerSessionTurnClaim): number;
/** Worker tool names the destination's installed supervisor admits in launch descriptors. */
readLaunchToolNames(): Promise<readonly WorkerToolName[]>;
launchTurn(request: WorkerTurnLaunchRequest): Promise<SpawnResult>;
};
type WorkerTunnelHandle = WorkerWorkspaceTunnelHandle | WorkerTurnTunnelHandle;
//#endregion
//#region packages/agent-core/src/runtime-deps.d.ts
/** Runtime functions injected by host packages so agent-core stays provider-agnostic. */
interface AgentCoreRuntimeDeps {
/** Streaming completion implementation used for normal agent turns. */
streamSimple: StreamFn;
/** Non-streaming completion implementation used by summarization helpers. */
completeSimple: CompleteSimpleFn;
/** Keep host stream ownership through iteration and decorated terminal work. */
runStream?: <T>(stream: ReturnType<StreamFn>, consume: () => T) => T;
}
/** Runtime dependency subset required by streaming agent loops. */
type AgentCoreStreamRuntimeDeps = Pick<AgentCoreRuntimeDeps, "streamSimple" | "runStream">;
//#endregion
//#region packages/agent-core/src/agent.d.ts
/** Options for constructing an {@link Agent}. */
interface AgentOptions {
/** Initial transcript, tools, model, and prompt state. */
initialState?: Partial<Omit<AgentState, "pendingToolCalls" | "isStreaming" | "streamingMessage" | "errorMessage">>;
/** Convert agent-owned transcript messages into provider-facing messages. */
convertToLlm?: AgentLoopConfig["convertToLlm"];
/** Optionally rewrite context before each provider request. */
transformContext?: NonNullable<AgentLoopConfig["transformContext"]>;
/** Injected stream runtime used when streamFn is not supplied. */
runtime?: AgentCoreStreamRuntimeDeps;
/** Explicit stream implementation, preferred over runtime.streamSimple. */
streamFn?: StreamFn$1;
/** Resolve provider API keys at request time. */
getApiKey?: NonNullable<AgentLoopConfig["getApiKey"]>;
/** Inspect the provider payload before it is sent. */
onPayload?: SimpleStreamOptions["onPayload"];
/** Inspect the provider response after it returns. */
onResponse?: SimpleStreamOptions["onResponse"];
/** Hook that may short-circuit or alter a tool call before execution. */
beforeToolCall?: NonNullable<AgentLoopConfig["beforeToolCall"]>;
/** Hook that may hydrate a deferred authorized tool call into an executable tool. */
resolveDeferredTool?: AgentLoopConfig["resolveDeferredTool"];
/** Hook that may alter a tool result after execution. */
afterToolCall?: NonNullable<AgentLoopConfig["afterToolCall"]>;
/** Hook that may alter any finalized tool outcome, including pre-execution failures. */
afterToolOutcome?: NonNullable<AgentLoopConfig["afterToolOutcome"]>;
/** Hook that may update model, reasoning, or context after a turn. */
prepareNextTurn?: (signal?: AbortSignal) => Promise<AgentLoopTurnUpdate | undefined> | AgentLoopTurnUpdate | undefined;
/** Context-aware turn hook. Takes precedence over `prepareNextTurn` when both are provided. */
prepareNextTurnWithContext?: (context: PrepareNextTurnContext, signal?: AbortSignal) => Promise<AgentLoopTurnUpdate | undefined> | AgentLoopTurnUpdate | undefined;
/** Queue drain mode for steering messages applied before the next unstarted tool or model turn. */
steeringMode?: QueueMode;
/** Queue drain mode for follow-up messages injected after the agent would otherwise stop. */
followUpMode?: QueueMode;
/** Session identifier forwarded to cache-aware providers. */
sessionId?: string;
/** Optional per-thinking-level token budgets forwarded to providers. */
thinkingBudgets?: ThinkingBudgets;
/** Preferred provider transport. */
transport?: Transport;
/** Optional cap for provider-requested retry delays. */
maxRetryDelayMs?: number;
/** Default strategy for executing multiple tool calls in one assistant message. */
toolExecution?: ToolExecutionMode;
}
/**
* Stateful wrapper around the low-level agent loop.
*
* `Agent` owns the current transcript, emits lifecycle events, executes tools,
* and exposes queueing APIs for steering and follow-up messages.
*/
declare class Agent$2 {
private mutableState;
private readonly listeners;
private readonly steeringQueue;
private readonly followUpQueue;
private readonly toolLoopRecoveryState;
convertToLlm: NonNullable<AgentOptions["convertToLlm"]>;
transformContext?: NonNullable<AgentOptions["transformContext"]>;
runtime?: AgentCoreStreamRuntimeDeps;
streamFn: StreamFn$1;
getApiKey?: NonNullable<AgentOptions["getApiKey"]>;
onPayload?: AgentOptions["onPayload"];
onResponse?: AgentOptions["onResponse"];
beforeToolCall?: NonNullable<AgentOptions["beforeToolCall"]>;
resolveDeferredTool?: AgentOptions["resolveDeferredTool"];
afterToolCall?: NonNullable<AgentOptions["afterToolCall"]>;
afterToolOutcome?: NonNullable<AgentOptions["afterToolOutcome"]>;
prepareNextTurn?: NonNullable<AgentOptions["prepareNextTurn"]>;
prepareNextTurnWithContext?: NonNullable<AgentOptions["prepareNextTurnWithContext"]>;
private activeRun?;
/** Session identifier forwarded to providers for cache-aware backends. */
sessionId?: string;
/** Optional per-level thinking token budgets forwarded to the stream function. */
thinkingBudgets?: ThinkingBudgets;
/** Preferred transport forwarded to the stream function. */
transport: Transport;
/** Optional cap for provider-requested retry delays. */
maxRetryDelayMs?: number;
/** Tool execution strategy for assistant messages that contain multiple tool calls. */
toolExecution: ToolExecutionMode;
constructor(options?: AgentOptions);
/**
* Subscribe to agent lifecycle events.
*
* Listener promises are awaited in subscription order and are included in
* the current run's settlement. Listeners also receive the active abort
* signal for the current run.
*
* `agent_end` is the final emitted event for a run, but the agent does not
* become idle until all awaited listeners for that event have settled.
*/
subscribe(listener: (event: AgentEvent, signal: AbortSignal) => Promise<void> | void): () => void;
/**
* Current agent state.
*
* Assigning `state.tools` or `state.messages` copies the provided top-level array.
*/
get state(): AgentState;
/** Controls how queued steering messages are drained. */
set steeringMode(mode: QueueMode);
get steeringMode(): QueueMode;
/** Controls how queued follow-up messages are drained. */
set followUpMode(mode: QueueMode);
get followUpMode(): QueueMode;
/**
* Queue a message for the active run. Running tools finish, while sequential
* tail calls or a parallel batch that has not launched yet are skipped.
*/
steer(message: AgentMessage): void;
/** Cancel queued input unless a live provider response may already have admitted it. */
cancelSteeringMessage(predicate: (message: AgentMessage) => boolean): AgentMessage | undefined;
/** Queue a message to run only after the agent would otherwise stop. */
followUp(message: AgentMessage): void;
/** Remove queued steering messages that have not been submitted to a live response. */
clearSteeringQueue(): void;
/** Remove all queued follow-up messages. */
clearFollowUpQueue(): void;
/** Remove all queued steering and follow-up messages. */
clearAllQueues(): void;
/** Returns true when either queue still contains pending messages. */
hasQueuedMessages(): boolean;
/** Active abort signal for the current run, if any. */
get signal(): AbortSignal | undefined;
/** Abort the current run, if one is active. */
abort(reason?: unknown): void;
/**
* Resolve when the current run and all awaited event listeners have finished.
*
* This resolves after `agent_end` listeners settle.
*/
waitForIdle(): Promise<void>;
/** Clear transcript state, runtime state, and queued messages. */
reset(): void;
/** Start a new prompt from text, a single message, or a batch of messages. */
prompt(message: AgentMessage | AgentMessage[]): Promise<void>;
prompt(input: string, images?: ImageContent$1[]): Promise<void>;
/** Continue from the current transcript. The last message must be a user or tool-result message. */
continue(): Promise<void>;
private normalizePromptInput;
private runPromptMessages;
private runContinuation;
private createContextSnapshot;
private createLoopConfig;
private runWithLifecycle;
private handleRunFailure;
private finishRun;
/**
* Reduce internal state for a loop event, then await listeners.
*
* `agent_end` only means no further loop events will be emitted. The run is
* considered idle later, after all awaited listeners for `agent_end` finish
* and `finishRun()` clears runtime-owned state.
*/
private processEvents;
}
//#endregion
//#region src/plugins/plugin-instance.types.d.ts
/** Disposal and admission shared by instance resources and registry handles. */
type PluginInstanceLifecycle = {
readonly signal: AbortSignal;
onDispose: (dispose: () => void | Promise<void>) => () => void;
};
/** Execution and host cleanup retain the same instance admission. */
type PluginInstanceExecution = {
run<T>(run: () => T): T;
runCleanup<T>(run: () => T): T;
};
type PluginInstanceAdmission = {
readonly lifecycle: PluginInstanceLifecycle;
run<T>(run: () => T): T;
};
/** Known disposal faults are reported outcomes, never new-call admission failures. */
type PluginInstanceDisposalResult = {
errors: readonly unknown[];
/** Errors seen only in host cleanup, eligible for its named-hook reporting. */
hostCleanupErrors?: readonly unknown[];
};
/** A host-owned logical consumer retains only its exact instance's admitted operations. */
type PluginInstanceConsumer = {
wrap<T>(value: T): T;
run<T>(run: () => T): T;
close(cleanup: () => void | Promise<void>): Promise<void>;
release(): void;
};
/** Inventory custody owns retirement without depending on registry contributions. */
interface PluginInstanceResource {
readonly pluginId: string;
quiesce(): boolean;
dispose(beforeCleanup?: () => void | Promise<void>): Promise<PluginInstanceDisposalResult>;
}
/** Captured code custody survives retiring a runtime until recovery consumes or releases it. */
type PluginModuleLoaderRecovery = {
bind(instance: PluginModuleLoaderOwner): void;
dispose(): void;
};
/** Runtime and setup loaders use the same instance-owned captured source. */
interface PluginModuleLoaderOwner extends PluginInstanceResource, PluginInstanceAdmission {
controlPlaneInitialized: boolean;
sourceDigest?: string;
onModuleDispose(cleanup: () => void | Promise<void>): void;
bindModuleLoader(load: (source: string) => unknown, hasSource?: (source: string) => boolean): void;
loadModule(source: string): unknown;
hasModuleSource(source: string): boolean | undefined;
bindModuleLoaderRecovery(capture: () => PluginModuleLoaderRecovery): void;
captureModuleLoaderRecovery(): PluginModuleLoaderRecovery;
}
/** Current-call helpers retain the instance itself, not a registry or plugin-id lookup. */
interface PluginInvocationInstance extends PluginModuleLoaderOwner {
readonly slots: Map<string | symbol, {
runtime: unknown;
}>;
wrap<T>(value: T): T;
}
//#endregion
//#region src/agents/agent-runtime-id.d.ts
type EmbeddedAgentRuntime = "openclaw" | "auto" | (string & {});
//#endregion
//#region src/auto-reply/reply/reply-media-paths.d.ts
type PreparedReplyMediaSource = {
mediaUrl: string;
trustedLocalMedia: boolean;
fileName?: string;
mimeType?: string;
};
/** Delivery facts only; contains no live reader or transcript changes. */
type PreparedReplyMedia = readonly {
source: string;
outcome: PreparedReplyMediaSource | {
failure: ReplyMediaFailure;
};
}[];
//#endregion
//#region src/auto-reply/heartbeat-tool-response.d.ts
/** Tool name used by heartbeat runs to report visible or silent progress. */
declare const HEARTBEAT_RESPONSE_TOOL_NAME = "heartbeat_respond";
/** Allowed heartbeat response outcomes. */
declare const HEARTBEAT_TOOL_OUTCOMES: readonly ["no_change", "progress", "done", "blocked", "needs_attention"];
type HeartbeatToolOutcome = (typeof HEARTBEAT_TOOL_OUTCOMES)[number];
/** Allowed heartbeat notification priorities. */
declare const HEARTBEAT_TOOL_PRIORITIES: readonly ["low", "normal", "high"];
type HeartbeatToolPriority = (typeof HEARTBEAT_TOOL_PRIORITIES)[number];
/** Normalized response emitted by the heartbeat response tool. */
type HeartbeatToolResponse = {
outcome: HeartbeatToolOutcome;
notify: boolean;
summary: string;
notificationText?: string;
reason?: string;
priority?: HeartbeatToolPriority;
nextCheck?: string;
/** Complete replacement for the current heartbeat monitor's private scratch. */
scratch?: string;
};
/** Validate and normalize unknown heartbeat tool output. */
declare function normalizeHeartbeatToolResponse(value: unknown): HeartbeatToolResponse | undefined;
//#endregion
//#region src/tts/directives.d.ts
type ParseTtsDirectiveOptions = {
cfg?: OpenClawConfig;
providers?: readonly SpeechProviderPlugin$1[];
providerConfigs?: Record<string, SpeechProviderConfig>;
preferredProviderId?: string;
};
/** Parse TTS directives from final message text, leaving markdown code spans unchanged. */
declare function parseTtsDirectives(text: string, policy: SpeechModelOverridePolicy, options?: ParseTtsDirectiveOptions): TtsDirectiveParseResult;
//#endregion
//#region src/agents/auth-profiles/credential-state.d.ts
/** Reason code for why a stored auth credential can or cannot be used. */
type AuthCredentialReasonCode = "ok" | "setup_inactive" | "missing_credential" | "invalid_expires" | "expired" | "unresolved_ref" | "malformed_api_key";
/** Default OAuth access-token refresh margin before expiry. */
declare const DEFAULT_OAUTH_REFRESH_MARGIN_MS: number;
/** Returns true when an OAuth credential has a non-expiring access token. */
declare function hasUsableOAuthCredential(credential: OAuthCredential$1 | undefined, opts?: {
now?: number;
refreshMarginMs?: number;
}): boolean;
//#endregion
//#region src/agents/provider-auth-aliases.d.ts
/** Inputs that control plugin metadata and trust scope for auth alias lookup. */
type ProviderAuthAliasLookupParams = {
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
includeUntrustedWorkspacePlugins?: boolean;
/** Stored credentials keep their provider realm when a model route changes endpoint. */
storedCredential?: boolean;
metadataSnapshot?: Pick<PluginMetadataSnapshot, "plugins"> & {
owners?: Pick<PluginMetadataSnapshot["owners"], "providerAuthAliases">;
};
};
/** Resolve the provider ID that should be used for credential lookup. */
declare function resolveProviderIdForAuth(provider: string, params?: ProviderAuthAliasLookupParams): string;
//#endregion
//#region src/agents/auth-profiles/order.d.ts
/** Reason a profile is or is not eligible for provider auth. */
type AuthProfileEligibilityReasonCode = AuthCredentialReasonCode | "profile_missing" | "provider_mismatch" | "mode_mismatch";
/** Eligibility decision for one auth profile candidate. */
type AuthProfileEligibility = {
eligible: boolean;
reasonCode: AuthProfileEligibilityReasonCode;
};
/** Resolves whether a profile can be used for a provider right now. */
declare function resolveAuthProfileEligibility(params: {
cfg?: OpenClawConfig;
authAliasLookupParams?: ProviderAuthAliasLookupParams;
store: AuthProfileStore;
provider: string;
profileId: string;
now?: number;
/** Runtime resolvers may observe a durable pending refresh through settlement. */
includePendingOAuthRefresh?: boolean;
}): AuthProfileEligibility;
type ResolveAuthProfileOrderParams = {
cfg?: OpenClawConfig;
store: AuthProfileStore;
provider: string;
/** Exact prepared metadata for request paths that must not rediscover plugin aliases. */
authAliasLookupParams?: ProviderAuthAliasLookupParams;
preferredProfile?: string;
/** Model that will consume the profile, for model-scoped cooldowns. */
forModel?: string;
/** Account-wide selection ignores windows limited to one model. */
cooldownScope?: "all-models";
/** Read-only status keeps unresolved refs ordered so availability remains unknown. */
readinessMode?: "execution" | "read-only";
/** Runtime resolvers may observe a durable pending refresh through settlement. */
includePendingOAuthRefresh?: boolean;
};
/** Resolves ordered usable auth profile ids for a provider. */
declare function resolveAuthProfileOrder(params: ResolveAuthProfileOrderParams): string[];
//#endregion
//#region src/agents/auth-profiles/external-cli-discovery.d.ts
/** External CLI auth discovery mode used while loading auth profile stores. */
type ExternalCliAuthDiscovery = {
mode: "none";
allowKeychainPrompt?: false;
config?: OpenClawConfig;
} | {
mode: "existing";
allowKeychainPrompt?: boolean;
config?: OpenClawConfig;
} | {
mode: "scoped";
allowKeychainPrompt?: boolean;
config?: OpenClawConfig;
providerIds?: Iterable<string>;
profileIds?: Iterable<string>;
};
//#endregion
//#region src/agents/auth-profiles/oauth.d.ts
type ResolveApiKeyForProfileResult = {
apiKey: string;
provider: string;
email?: string;
profileId: string;
profileType: AuthProfileCredential["type"];
credential?: AuthProfileCredential;
};
type ResolveApiKeyForProfileParams = {
cfg?: OpenClawConfig;
store: AuthProfileStore;
profileId: string;
agentDir?: string;
forceRefresh?: boolean;
allowProfileFallback?: boolean;
signal?: AbortSignal;
/** Reject an OAuth credential before the resolver persists, adopts, or returns it. */
validateOAuthCredential?: (credential: OAuthCredential$1) => void;
};
/** Refresh one OAuth credential and merge provider-returned token fields. */
declare function refreshOAuthCredentialForRuntime(params: {
credential: OAuthCredential$1;
cfg?: OpenClawConfig;
}): Promise<OAuthCredential$1 | null>;
/** Resolve a selected auth profile into the provider API key string. */
declare function resolveApiKeyForProfile(params: ResolveApiKeyForProfileParams): Promise<ResolveApiKeyForProfileResult | null>;
//#endregion
//#region src/agents/auth-profiles/path-resolve.d.ts
type SharedAuthStoreOwnership = {
location: "legacy-main";
} | {
location: "state-db";
};
/** Pure producer facts; capturing a supplied runtime snapshot must not open SQLite. */
type AuthProfileOwnerScope = {
stateDir: string;
sharedMainDir: string;
};
//#endregion
//#region src/agents/auth-profiles/profile-list.d.ts
/** Lists auth profile ids whose credential provider matches the requested provider. */
declare function listProfilesForProvider(store: AuthProfileStore, provider: string): string[];
//#endregion
//#region src/agents/auth-profiles/profiles.d.ts
/** Upserts an auth profile immediately into the local store. */
declare function upsertAuthProfile(params: {
profileId: string;
credential: AuthProfileCredential;
agentDir?: string;
}): void;
/** Removes auth profiles and related state for a provider, optionally narrowed to exact IDs. */
declare function removeProviderAuthProfilesWithLock(params: {
cfg?: OpenClawConfig;
provider: string;
agentDir?: string;
profileIds?: readonly string[];
}): Promise<AuthProfileStore | null>;
//#endregion
//#region src/plugins/provider-auth-types.d.ts
/** Provider secret input modes: inline plaintext or external secret reference. */
type SecretInputMode = "plaintext" | "ref";
//#endregion
//#region src/plugins/provider-external-auth.types.d.ts
type ProviderAuthOptionBag = {
token?: string;
tokenProvider?: string;
secretInputMode?: SecretInputMode;
[key: string]: unknown;
};
/** Context for resolving synthetic provider credentials from config. */
type ProviderResolveSyntheticAuthContext = {
config?: OpenClawConfig;
provider: string;
providerConfig?: ModelProviderConfig;
};
/** Synthetic provider credential returned by plugin auth helpers. */
type ProviderSyntheticAuthResult = {
apiKey: string;
source: string;
mode: Exclude<ModelProviderAuthMode, "aws-sdk">;
expiresAt?: number;
/** Native presence authorizes only this runtime, never a provider bearer request. */
nativeAuth?: {
runtime: string;
mode: "api-key" | "oauth" | "token";
};
};
/** Context for resolving external provider auth profiles. */
type ProviderResolveExternalAuthProfilesContext = {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
env: NodeJS.ProcessEnv;
store: AuthProfileStore;
};
/** External auth profile credential resolved for a provider. */
type ProviderExternalAuthProfile = {
profileId: string;
credential: OAuthCredential$1;
persistence?: "runtime-only" | "persisted";
};
/** Internal synchronous resolver shared by provider hooks and auth-store overlays. */
type ProviderExternalAuthProfileResolver = (params: {
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
context: ProviderResolveExternalAuthProfilesContext;
}) => ProviderExternalAuthProfile[];
//#endregion
//#region src/agents/auth-profiles/legacy-source-files.d.ts
type LegacyAuthProfileSourceKind = "auth-profiles" | "auth-state" | "legacy-auth" | "legacy-oauth";
type LegacyAuthProfileSource = {
kind: LegacyAuthProfileSourceKind;
path: string;
};
//#endregion
//#region src/state/openclaw-agent-db-validation-cache.d.ts
type OpenClawAgentDatabaseValidation = {
agentId: string;
identity: string;
/** Shared with admitted workers so owner invalidation revokes borrowed proof. */
valid: SharedArrayBuffer;
/** First full canonical proof; subsequent changes remain visible through the pending table. */
canonicalReady: SharedArrayBuffer;
};
//#endregion
//#region src/state/openclaw-agent-db-admission.d.ts
/** Denial still invokes run under admission, with a throwing authority check, to permit cleanup. */
type OpenClawAgentDatabaseWriteAdmission = <T>(run: (assertCurrent: () => void, validation?: OpenClawAgentDatabaseValidation) => T | Promise<T>) => Promise<T>;
//#endregion
//#region src/state/openclaw-agent-db.d.ts
declare const { withOpenClawAgentDatabaseAsync, withOpenClawAgentDatabaseAdmission }: {
withOpenClawAgentDatabaseAsync: <T>(inputOptions: OpenClawAgentDatabaseOptions, operation: (database: OpenClawAgentDatabase) => T | Promise<T>, assertCurrent?: () => void, signal?: AbortSignal) => Promise<T>;
withOpenClawAgentDatabaseAdmission: <T>(inputOptions: OpenClawAgentDatabaseOptions, withAdmission: OpenClawAgentDatabaseWriteAdmission, operation: (database: OpenClawAgentDatabase) => T | Promise<T>) => Promise<T>;
};
//#endregion
//#region src/agents/auth-profiles/sqlite.d.ts
type AuthProfileDatabase = OpenClawAgentDatabase | OpenClawStateDatabase;
/** Internal prepared ownership, carried through commit publication and compensation. */
type AuthProfileStoreOwner = {
databasePath: string;
sharedDatabasePath: string;
location: SharedAuthStoreOwnership["location"];
};
type PreparedAuthProfileStoreOwner = AuthProfileStoreOwner & {
env: NodeJS.ProcessEnv;
};
//#endregion
//#region src/agents/auth-profiles/runtime-read.d.ts
type LoadAuthProfileStoreOptions = {
/** Limit a credential-read refusal to the provider being resolved; writes stay owner-wide. */
migrationProvider?: string;
deferScopedMigrationRefusals?: boolean;
onReadOwner?: (owner: AuthProfileReadOwner) => void;
/** Materialize only this explicitly selected personal account into the returned view. */
profileId?: string;
allowKeychainPrompt?: boolean;
config?: OpenClawConfig;
database?: AuthProfileDatabase;
externalCli?: ExternalCliAuthDiscovery;
inheritedAuthDir?: string;
readOnly?: boolean;
syncExternalCli?: boolean;
externalCliProviderIds?: Iterable<string>;
externalCliProfileIds?: Iterable<string>;
};
type AuthProfileReadOwner = {
databasePath: string;
candidates: LegacyAuthProfileSource[];
readStore: () => AuthProfileStore | null;
};
//#endregion
//#region src/agents/auth-profiles/runtime-snapshot-owner.d.ts
type RuntimeAuthProfileLegacyCandidates = {
local: LegacyAuthProfileSource[];
shared: LegacyAuthProfileSource[];
};
/** Core lifecycle receipt; the public SDK snapshot shape intentionally stays unchanged. */
type OwnedRuntimeAuthProfileStoreSnapshotEntry = {
databasePath: string;
agentDir: string;
store: RuntimeAuthProfileStore;
owner: RuntimeAuthSharedOwner;
legacyCandidates?: RuntimeAuthProfileLegacyCandidates;
};
type RuntimeAuthSharedOwner = ({
kind: "resolved";
} & Pick<AuthProfileStoreOwner, "sharedDatabasePath" | "location">) | {
kind: "unresolved";
scope: AuthProfileOwnerScope;
};
//#endregion
//#region src/agents/auth-profiles/runtime-snapshots.d.ts
/** Replaces all runtime auth profile snapshots with cloned entries. */
declare function replaceRuntimeAuthProfileStoreSnapshots(entries: Array<{
databasePath?: string;
agentDir?: string;
store: AuthProfileStore;
}>): void;
/** Clears all runtime auth profile snapshots. */
declare function clearRuntimeAuthProfileStoreSnapshots(): void;
//#endregion
//#region src/agents/auth-profiles/store.d.ts
/** Find a persisted credential in the scoped store, falling back to the main store. */
declare function findPersistedAuthProfileCredential(params: {
agentDir?: string;
profileId: string;
}): AuthProfileStore["profiles"][string] | undefined;
/** Resolve which agent dir owns a persisted profile, accounting for inherited OAuth. */
declare function resolvePersistedAuthProfileOwnerAgentDir(params: {
agentDir?: string;
profileId: string;
}): string | undefined;
//#endregion
//#region src/agents/auth-profiles/store-runtime.d.ts
declare const { createAuthProfileStoreReadScope, updateAuthProfileStoreWithLock, loadAuthProfileStore, loadAuthProfileStoreForRuntime, loadAuthProfileStoreForRuntimeAsync, loadAuthProfileStoreForSecretsRuntime, loadAuthProfileStoreWithoutExternalProfiles, ensureAuthProfileStore, ensureAuthProfileStoreWithoutExternalProfiles, ensureAuthProfileStoreForLocalUpdate, saveAuthProfileStore, saveAuthProfileStoreWithPreparedOwner, saveAuthProfileStoreIfPersistenceSnapshotMatches }: Readonly<{
createAuthProfileStoreReadScope: (agentDir: string, config: OpenClawConfig | undefined) => {
agentDir: string;
store: AuthProfileStore;
read: () => AuthProfileStore;
getRuntimeSnapshots: () => RuntimeAuthProfileStore[];
assertCredentialReady: (source: AuthProfileCredentialSource, baseUrl?: string) => void;
assertProviderReady: (provider?: string, baseUrl?: string) => void;
};
updateAuthProfileStoreWithLock: (params: {
agentDir?: string;
profileId?: string;
sharedStoreWrite?: boolean;
stateDir?: string;
saveOptions?: {
filterExternalAuthProfiles?: boolean;
preserveOrderProfileIds?: Iterable<string>;
preserveStateProfileIds?: Iterable<string>;
pruneOrderProfileIds?: Iterable<string>;
sharedStoreWrite?: boolean;
syncExternalCli?: boolean;
};
updater: (store: AuthProfileStore, owner?: PreparedAuthProfileStoreOwner) => boolean;
}) => Promise<AuthProfileStore | null>;
loadAuthProfileStore: () => AuthProfileStore;
loadAuthProfileStoreForRuntime: (agentDir?: string, options?: LoadAuthProfileStoreOptions, env?: NodeJS.ProcessEnv) => AuthProfileStore;
loadAuthProfileStoreForRuntimeAsync: (agentDir?: string, options?: Omit<LoadAuthProfileStoreOptions, "database" | "onReadOwner" | "syncExternalCli">) => Promise<AuthProfileStore>;
loadAuthProfileStoreForSecretsRuntime: (agentDir?: string, options?: Pick<LoadAuthProfileStoreOptions, "config" | "profileId" | "externalCli" | "externalCliProviderIds" | "externalCliProfileIds" | "inheritedAuthDir">) => AuthProfileStore;
loadAuthProfileStoreWithoutExternalProfiles: (agentDir?: string, loadOptions?: Pick<LoadAuthProfileStoreOptions, "allowKeychainPrompt" | "inheritedAuthDir" | "profileId">) => AuthProfileStore;
ensureAuthProfileStore: (agentDir?: string, options?: {
migrationProvider?: string;
profileId?: string;
allowKeychainPrompt?: boolean;
config?: OpenClawConfig;
externalCli?: ExternalCliAuthDiscovery;
externalCliProviderIds?: Iterable<string>;
externalCliProfileIds?: Iterable<string>;
inheritedAuthDir?: string;
readOnly?: boolean;
syncExternalCli?: boolean;
}) => AuthProfileStore;
ensureAuthProfileStoreWithoutExternalProfiles: (agentDir?: string, options?: {
migrationProvider?: string;
config?: OpenClawConfig;
profileId?: string;
allowKeychainPrompt?: boolean;
inheritedAuthDir?: string;
readOnly?: boolean;
syncExternalCli?: boolean;
}) => AuthProfileStore;
ensureAuthProfileStoreForLocalUpdate: (agentDir?: string) => AuthProfileStore;
saveAuthProfileStore: (store: AuthProfileStore, agentDir?: string, options?: {
filterExternalAuthProfiles?: boolean;
preserveOrderProfileIds?: Iterable<string>;
preserveStateProfileIds?: Iterable<string>;
pruneOrderProfileIds?: Iterable<string>;
sharedStoreWrite?: boolean;
syncExternalCli?: boolean;
}, database?: AuthProfileDatabase) => void;
saveAuthProfileStoreWithPreparedOwner: (store: AuthProfileStore, agentDir: string | undefined, options: {
filterExternalAuthProfiles?: boolean;
preserveOrderProfileIds?: Iterable<string>;
preserveStateProfileIds?: Iterable<string>;
pruneOrderProfileIds?: Iterable<string>;
sharedStoreWrite?: boolean;
syncExternalCli?: boolean;
} | undefined, database: AuthProfileDatabase, owner: AuthProfileStoreOwner | PreparedAuthProfileStoreOwner) => void;
saveAuthProfileStoreIfPersistenceSnapshotMatches: (params: {
store: AuthProfileStore;
snapshot: {
owner: PreparedAuthProfileStoreOwner;
credentialsRaw: unknown;
stateRaw: unknown;
runtimeCaptured: boolean;
runtimeRevision?: number;
runtimeRevisionAtSaveEdge?: number;
runtimeRevisionBeforePublication?: number;
runtimeEntry?: OwnedRuntimeAuthProfileStoreSnapshotEntry;
derivedRuntimeStores?: Array<OwnedRuntimeAuthProfileStoreSnapshotEntry & {
runtimeRevision: number;
}>;
derivedRuntimeRevisionsAtSaveEdge?: Array<{
databasePath: string;
agentDir: string;
runtimeRevision: number;
}>;
derivedRuntimeRevisionsBeforePublication?: Array<{
databasePath: string;
agentDir: string;
runtimeRevision: number;
}>;
};
agentDir?: string;
options?: {
filterExternalAuthProfiles?: boolean;
preserveOrderProfileIds?: Iterable<string>;
preserveStateProfileIds?: Iterable<string>;
pruneOrderProfileIds?: Iterable<string>;
sharedStoreWrite?: boolean;
syncExternalCli?: boolean;
};
stateDir?: string;
}) => {
owned: {
owner: PreparedAuthProfileStoreOwner;
credentialsRaw: unknown;
stateRaw: unknown;
runtimeCaptured: boolean;
runtimeRevision?: number;
runtimeRevisionAtSaveEdge?: number;
runtimeRevisionBeforePublication?: number;
runtimeEntry?: OwnedRuntimeAuthProfileStoreSnapshotEntry;
derivedRuntimeStores?: Array<OwnedRuntimeAuthProfileStoreSnapshotEntry & {
runtimeRevision: number;
}>;
derivedRuntimeRevisionsAtSaveEdge?: Array<{
databasePath: string;
agentDir: string;
runtimeRevision: number;
}>;
derivedRuntimeRevisionsBeforePublication?: Array<{
databasePath: string;
agentDir: string;
runtimeRevision: number;
}>;
};
publishRuntimeSnapshots: () => boolean;
};
findPersistedAuthProfileCredential: typeof findPersistedAuthProfileCredential;
}>;
//#endregion
//#region src/agents/auth-profiles/usage-state.d.ts
/**
* Check if a profile is currently in cooldown (due to rate limits, overload, or other transient failures).
*/
declare function isProfileInCooldown(store: AuthProfileStore, profileId: string, now?: number, forModel?: string | null): boolean;
/** Clear each expired window in memory; the next store write persists it. */
declare function clearExpiredCooldowns(store: AuthProfileStore, now?: number): boolean;
/**
* Infer the most likely reason all candidate profiles are currently unavailable.
*
* We prefer explicit active `disabledReason` values (for example billing/auth)
* over generic cooldown buckets, then fall back to failure-count signals.
*/
declare function resolveProfilesUnavailableReason(params: {
store: AuthProfileStore;
profileIds: string[];
now?: number;
}): AuthProfileFailureReason | null;
/** Resolves the display-facing unusable timestamp, honoring provider bypasses. */
declare function resolveProfileUnusableUntilForDisplay(store: AuthProfileStore, profileId: string): number | null;
//#endregion
//#region src/agents/auth-profiles/usage.d.ts
/** Marks a profile blocked until a provider-reported reset timestamp. */
declare function markAuthProfileBlockedUntil(params: {
store: AuthProfileStore;
profileId: string;
blockedUntil: number;
source: AuthProfileBlockedSource;
agentDir?: string;
runId?: string;
modelId?: string;
}): Promise<void>;
//#endregion
//#region src/secrets/provider-env-vars.d.ts
type ProviderEnvVarLookupParams = {
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
includeUntrustedWorkspacePlugins?: boolean;
metadataSnapshot?: PluginMetadataSnapshot;
};
/** Manifest-provided evidence that a provider auth credential exists outside config. */
type ProviderAuthEvidence = {
type: "local-file-with-env";
fileEnvVar?: string;
fallbackPaths?: readonly string[];
requiresAnyEnv?: readonly string[];
requiresAllEnv?: readonly string[];
credentialMarker: string;
source?: string;
};
/** Returns a copy of an env object with denied keys removed case-insensitively. */
declare function omitEnvKeysCaseInsensitive(baseEnv: NodeJS.ProcessEnv, keys: Iterable<string>): NodeJS.ProcessEnv;
//#endregion
//#region src/agents/model-auth-env.d.ts
type EnvApiKeyResult = {
apiKey: string;
source: string;
};
type EnvApiKeyLookupOptions = {
config?: OpenClawConfig;
workspaceDir?: string;
aliasMap?: Readonly<Record<string, string>>;
candidateMap?: Readonly<Record<string, readonly string[]>>;
authEvidenceMap?: Readonly<Record<string, readonly ProviderAuthEvidence[]>>;
setupProviderFallbackRefs?: readonly string[];
skipSetupProviderFallback?: boolean;
};
/** Resolve an API key or auth-evidence marker for a provider from environment state. */
declare function resolveEnvApiKey(provider: string, env?: NodeJS.ProcessEnv, options?: EnvApiKeyLookupOptions): EnvApiKeyResult | null;
//#endregion
//#region src/agents/model-auth-runtime-shared.d.ts
/** Resolved credential material and provenance for one provider request. */
type ResolvedProviderAuth = {
apiKey?: string;
profileId?: string;
source: string;
mode: "api-key" | "oauth" | "token" | "aws-sdk";
/** Provider-owned OAuth grant family; distinct from credential renewal mode. */
authFlow?: string;
};
/** Require a normalized API key or throw a provider-auth error. */
declare function requireApiKey(auth: ResolvedProviderAuth, provider: string): string;
//#endregion
//#region src/agents/model-auth-provider.d.ts
type ProviderCredentialPrecedence = "profile-first" | "env-first";
/** Resolves the credential that should be used for one provider request. */
declare function resolveApiKeyForProviderCore(input: {
provider: string;
cfg?: OpenClawConfig;
profileId?: string;
preferredProfile?: string;
store?: AuthProfileStore;
agentDir?: string;
workspaceDir?: string;
/** Cancels this credential lookup, not an independently owned OAuth refresh. */
signal?: AbortSignal;
/** When true, treat profileId as a user-locked selection that must not be
* silently replaced by another profile or env/config credentials. */
lockedProfile?: boolean;
forceRefresh?: boolean;
credentialPrecedence?: ProviderCredentialPrecedence;
/** Skip implicit profile discovery for a prepared env/config fallback attempt. */
allowAuthProfileFallback?: boolean;
/** Skip plugin setup fallback when the prepared route already excludes it. */
skipSetupProviderFallback?: boolean;
modelId?: string;
modelApi?: string;
modelBaseUrl?: string;
capability?: string;
/** Keep SecretRef-backed model credentials opaque until a sentinel-aware transport boundary. */
secretSentinels?: boolean;
}): Promise<ResolvedProviderAuth>;
//#endregion
//#region src/agents/model-auth-model.d.ts
type ModelAuthMode = "api-key" | "oauth" | "token" | "mixed" | "aws-sdk" | "unknown";
/** Reports the strongest configured auth mode for provider-list UI and diagnostics. */
declare function resolveModelAuthMode(provider?: string, cfg?: OpenClawConfig, store?: AuthProfileStore, options?: {
workspaceDir?: string;
}): ModelAuthMode | undefined;
//#endregion
//#region src/plugins/prepared-message-tool-catalog.d.ts
type PreparedMessageToolCatalogEntry = Readonly<{
id: string;
actions?: ChannelMessageActionAdapter;
reconcilesUnknownSend: boolean;
}>;
type PreparedMessageToolCatalog = Readonly<{
version: number;
channels: readonly PreparedMessageToolCatalogEntry[];
getChannel: (id: string) => PreparedMessageToolCatalogEntry | undefined;
}>;
//#endregion
//#region src/plugins/embedding-provider-types.d.ts
/** Input accepted by embedding providers, including multimodal inline-data parts. */
type EmbeddingInput$1 = string | {
text: string;
parts?: Array<{
type: "text";
text: string;
} | {
type: "inline-data";
mimeType: string;
data: string;
}>;
};
/** Per-call options passed to embedding provider calls. */
type EmbeddingProviderCallOptions = {
signal?: AbortSignal;
inputType?: "query" | "document" | "semantic" | "classification" | "clustering";
} & MemorySearchDeadlineControlOptions;
/** Runtime metadata returned with a created embedding provider. */
type EmbeddingProviderRuntime = {
id: string;
cacheKeyData?: Record<string, unknown>;
/** Prior persisted model/cache identities that are equivalent to the current identity. */
indexIdentityAliases?: Array<{
model: string;
cacheKeyData: Record<string, unknown>;
}>;
inlineQueryTimeoutMs?: number;
inlineBatchTimeoutMs?: number;
} & Partial<EmbeddingProviderBatchRuntime>;
/** Provider-owned canonical identity and exact aliases for persisted indexes. */
type EmbeddingProviderIndexIdentity = {
model: string;
cacheKeyData: Record<string, unknown>;
aliases?: Array<{
model: string;
cacheKeyData: Record<string, unknown>;
}>;
};
/** Created embedding provider instance used by memory/search callers. */
type EmbeddingProvider = {
id: string;
model: string;
dimensions?: number;
maxInputTokens?: number;
embed: (input: EmbeddingInput$1, options?: EmbeddingProviderCallOptions) => Promise<number[]>;
embedBatch: (inputs: EmbeddingInput$1[], options?: EmbeddingProviderCallOptions) => Promise<number[][]>;
close?: () => Promise<void> | void;
};
/** Options passed to embedding provider adapters when creating providers. */
type EmbeddingProviderCreateOptions = {
config: OpenClawConfig;
agentDir?: string;
provider?: string;
remote?: {
baseUrl?: string;
apiKey?: SecretInput;
headers?: Record<string, string>;
};
model: string;
inputType?: string;
queryInputType?: string;
documentInputType?: string;
local?: {
modelPath?: string;
modelCacheDir?: string;
};
dimensions?: number;
taskType?: string;
};
/** Result returned by an embedding provider adapter create call. */
type EmbeddingProviderCreateResult = {
provider: EmbeddingProvider | null;
runtime?: EmbeddingProviderRuntime;
};
/** Adapter contract registered by core or plugin embedding providers. */
type EmbeddingProviderAdapter = {
id: string;
defaultModel?: string;
transport?: "local" | "remote";
authProviderId?: string;
/** Canonical model from config only: synchronous, without auth or network access. */
normalizeModel?: (options: EmbeddingProviderCreateOptions) => string;
resolveIndexIdentity?: (options: EmbeddingProviderCreateOptions) => EmbeddingProviderIndexIdentity;
create: (options: EmbeddingProviderCreateOptions) => Promise<EmbeddingProviderCreateResult>;
formatSetupError?: (err: unknown) => string;
};
//#endregion
//#region src/plugins/logger-types.d.ts
/** Logger passed into plugin registration, services, and CLI surfaces. */
type PluginLogger$1 = {
debug?: (message: string) => void;
info: (message: string) => void;
warn: (message: string) => void;
error: (message: string) => void;
};
//#endregion
//#region src/wizard/session.d.ts
type WizardStep = WizardStep$1;
type WizardSessionStatus = NonNullable<WizardNextResult$1["status"]>;
type WizardNextResult = WizardNextResult$1 & {
status: WizardSessionStatus;
};
declare class WizardSession {
private runner;
private readonly abortController;
private readonly expiryTimer;
private readonly runnerPromise;
private currentStep;
private progressSteps;
private deliveredProgressStepIds;
private stepDeferred;
private cancellationLocked;
private inputClosedError;
private preparationCancellationLocked;
private expiryPending;
private settled;
private pendingExternalUrl;
private devicePresentation;
private externalUrlImmediate;
private answerDeferred;
private status;
private error;
private configuredAccounts;
private preparedModelRef;
private modelActivation;
private activationRejection;
constructor(runner: (prompter: WizardPrompter, signal: AbortSignal, session: WizardSession) => Promise<void>, options?: {
timeoutMs?: number;
});
next(): Promise<WizardNextResult>;
/** A non-consuming view for polling clients; retired prompts are never replayed. */
getCurrentStep(): WizardStep | undefined;
private terminalResult;
/** Record what the channels flow actually configured (channels flow only). */
setConfiguredAccounts(accounts: ReadonlyArray<{
channel: string;
accountId: string;
}>): void;
/** Record the exact provider-owned model prepared by a setup flow. */
setPreparedModelRef(modelRef: string): void;
/** Record the live activation result, distinct from provider preparation. */
setModelActivation(activation: NonNullable<WizardNextResult$1["modelActivation"]>): void;
/** Only the activation owner can distinguish rejection from possibly committed failure. */
setActivationRejection(rejection: NonNullable<WizardNextResult$1["activationRejection"]>): void;
answer(stepId: string, value: unknown): Promise<string | undefined>;
cancel(): boolean;
/** Close client input without interrupting an operation past its commit point. */
close(error: Error): void;
/** The underlying mutation crossed its durable commit point and must finish. */
lockCancellation(): void;
/** A retained write callback cannot outlive the runner that owns setup. */
assertPersistentEffectCurrent(): void;
/** Protect preparation until the next client checkpoint or final commit. */
lockCancellationForPreparation(): void;
/** Resume cancellation after preparation, before more input or verification. */
finishPreparation(): void;
get signal(): AbortSignal;
pushStep(step: WizardStep): void;
pushProgress(message: string, presentation?: Pick<WizardStep, "title" | "deviceCode">): void;
private rememberDeliveredProgressStep;
queueExternalUrl(url: string): void;
consumeExternalUrl(retain?: boolean): string | undefined;
private run;
private rejectPendingAnswers;
awaitAnswer(step: WizardStep, validate?: (value: string) => string | undefined, signal?: AbortSignal): Promise<unknown>;
private resolveStep;
getStatus(): WizardSessionStatus;
/** Whether the runner has stopped and can no longer mutate setup state. */
isSettled(): boolean;
/** Resolves after the runner can no longer mutate setup state. */
whenSettled(): Promise<void>;
getError(): string | undefined;
}
//#endregion
//#region src/auto-reply/command-auth.d.ts
type CommandAuthorization = {
providerId?: ChannelId$1;
ownerList: string[];
senderId?: string;
senderIsOwner: boolean;
/** Rechecks the host-admitted owner capability after awaited work, when one is present. */
assertOwnerCurrent?: () => void;
isAuthorizedSender: boolean;
from?: string;
to?: string;
};
type CommandAuthorizationParams = {
ctx: MsgContext;
cfg: OpenClawConfig;
commandAuthorized: boolean;
};
declare function resolveCommandAuthorization(params: CommandAuthorizationParams): CommandAuthorization;
//#endregion
//#region src/channels/message-access/admission-evidence.d.ts
declare class ChannelAdmissionAudit {
#private;
constructor(params: {
enabled: boolean;
decisionSink?: (receipt: DecisionReceiptV1) => boolean;
});
get enabled(): boolean;
configure(enabled: boolean): void;
captureCurrent(): () => boolean;
recordDecision(receipt: DecisionReceiptV1): boolean;
close(): void;
}
//#endregion
//#region src/agents/utility-model.d.ts
/**
* The utility model ref to use for the agent, or undefined when utility
* routing is disabled or no default exists. Callers with a session-specific
* selection pass both primary fields so automatic routing keeps that session's
* provider and auth owner.
*/
declare function resolveUtilityModelRefForAgent(params: {
cfg: OpenClawConfig;
agentId: string;
/** Pass when the caller already resolved the primary provider. */
primaryProvider?: string;
/** Pass with primaryProvider to carry a session-specific auth profile. */
primaryModelRef?: string;
metadataSnapshot?: Pick<PluginMetadataSnapshot, "plugins">;
}): string | undefined;
//#endregion
//#region src/gateway/chat-attachments.d.ts
type ChatAttachment = {
type?: string;
mimeType?: string;
fileName?: string;
origin?: MediaFact["origin"];
content?: unknown;
sizeBytes?: number;
durationMs?: number;
width?: number;
height?: number;
};
//#endregion
//#region src/gateway/session-companion-state.d.ts
type SessionCompanionContextMessage = {
role: "assistant" | "user";
text: string;
ts: number;
};
type SessionCompanionPreparedContext = {
empty: boolean;
messages: SessionCompanionContextMessage[];
sessionId: string;
};
type SessionCompanionThread = {
context: SessionCompanionPreparedContext;
digestText: string;
exchanges: SessionCompanionExchange[];
lastNoteSequence: number;
busy: boolean;
lastUsedAt: number;
};
//#endregion
//#region src/gateway/session-companion-context.d.ts
type SessionCompanionContextReadResult = {
kind: "ready";
context: SessionCompanionPreparedContext;
} | {
kind: "missing";
} | {
kind: "unavailable";
};
type SessionCompanionContextReader = {
currentSessionId: (params: {
agentId: string;
sessionKey: string;
}) => string | undefined;
read: (params: {
agentId: string;
sessionKey: string;
signal?: AbortSignal;
}) => Promise<SessionCompanionContextReadResult>;
};
//#endregion
//#region src/infra/agent-events.d.ts
/** Payload for approval requests and their later resolution events. */
type AgentApprovalEventData = {
phase: "requested" | "resolved";
kind: "exec" | "plugin" | "unknown";
status: "pending" | "unavailable" | "approved" | "denied" | "failed";
title: string;
itemId?: string;
toolCallId?: string;
approvalId?: string;
approvalSlug?: string;
command?: string;
host?: string;
reason?: string;
scope?: "turn" | "session";
message?: string;
};
/** Stream name for agent events delivered to gateway listeners and plugin host hooks. */
type AgentEventStream = "lifecycle" | "tool" | "assistant" | "usage" | "error" | "item" | "plan" | "approval" | "command_output" | "patch" | "compaction" | "thinking" | (string & {});
/** Enriched event delivered to subscribers after sequencing and context stamping. */
type AgentEventPayload = {
runId: string;
seq: number;
stream: AgentEventStream;
ts: number;
data: Record<string, unknown>;
/** Internal, non-enumerable gateway lifecycle generation that owns this run. */
lifecycleGeneration?: string;
sessionKey?: string;
/**
* sessionId the run was bound to when it started. Lifecycle persistence uses
* this to reject terminal events from a pre-`sessions.reset` run that would
* otherwise clobber the rotated session row resolved by the shared sessionKey.
*/
sessionId?: string;
agentId?: string;
};
/** Emits an agent event after assigning per-run sequence, timestamp, and context metadata. */
declare function emitAgentEvent(event: Omit<AgentEventPayload, "seq" | "ts">): void;
/** Subscribes to sequenced agent events; returns an unsubscribe callback. */
declare function onAgentEvent(listener: (evt: AgentEventPayload) => void): () => void;
/** Clears agent event state; test suites with a live Gateway can preserve its listeners. */
declare function resetAgentEventsForTest(options?: {
preserveListeners?: boolean;
}): void;
//#endregion
//#region src/gateway/session-observer-contract.d.ts
type SessionObserverEvent = AgentEventPayload;
type SessionObserverCompanionSnapshot = {
agentId: string;
runId?: string;
digest?: SessionObserverDigest;
notes: Array<{
sequence: number;
text: string;
}>;
};
type SessionObserverService = {
handleEvent: (event: SessionObserverEvent) => void;
setConnectionVisibility: (connId: string, visible: boolean) => void;
removeConnection: (connId: string) => void;
getCompanionSnapshot: (sessionKey: string, agentId?: string) => SessionObserverCompanionSnapshot;
dispose: () => void;
};
//#endregion
//#region src/gateway/session-companion-prompt.d.ts
type SessionCompanionPromptMessage = {
role: "user" | "assistant";
content: string;
ts: number;
};
//#endregion
//#region src/gateway/session-companion-ask.d.ts
type SessionCompanionRunParams = {
cfg: OpenClawConfig;
agentId: string;
modelRef: string;
sessionKey: string;
workspaceDir: string;
systemPrompt: string;
messages: SessionCompanionPromptMessage[];
images?: ImageContent$1[];
operatorAuthority?: AdmittedRunOperatorAuthority;
assertSourceCurrent?: () => void;
assertInputCurrent?: () => void;
signal: AbortSignal;
};
type SessionCompanionAskDeps = {
getConfig: () => OpenClawConfig;
sessionObserver: {
getCompanionSnapshot: (sessionKey: string, agentId?: string) => SessionObserverCompanionSnapshot;
};
resolveUtilityModelRef?: typeof resolveUtilityModelRefForAgent;
contextReader: SessionCompanionContextReader;
run?: (params: SessionCompanionRunParams) => Promise<string>;
now?: () => number;
};
type SessionCompanionAskRuntimeParams = SessionCompanionAskDeps & {
threads: Map<string, SessionCompanionThread>;
now: () => number;
isDisposed: () => boolean;
};
type SessionCompanionCancellationKind = "backing-session-revoked" | "disposed" | "explicit-reset" | "request-aborted" | "timeout";
declare function createSessionCompanionAskRuntime(params: SessionCompanionAskRuntimeParams): {
ask: (request: {
agentId: string;
sessionKey: string;
question: string;
selectionContext?: string;
attachments?: ChatAttachment[];
connId: string;
operatorAuthority?: AdmittedRunOperatorAuthority;
assertSourceCurrent?: () => void;
assertInputCurrent?: () => void;
signal?: AbortSignal;
}) => Promise<{
answer: string;
ts: number;
}>;
cancel(sessionKey: string, agentId: string, cancellation: Extract<SessionCompanionCancellationKind, "backing-session-revoked" | "explicit-reset">): void;
dispose(): void;
};
//#endregion
//#region src/gateway/session-companion.d.ts
type SessionCompanionTarget = {
sessionKey: string;
agentId: string;
};
type SessionCompanionService = {
ask: ReturnType<typeof createSessionCompanionAskRuntime>["ask"];
state: (target: SessionCompanionTarget) => SessionsCompanionStateResult;
reset: (target: SessionCompanionTarget) => void;
dispose: () => void;
};
//#endregion
//#region src/sessions/session-lifecycle-events.d.ts
type SessionLifecycleEvent = {
sessionKey: string;
agentId?: string;
parentSessionKey?: string;
label?: string;
displayName?: string;
/** Runtime events preserve stored rows; entry events preserve worker placement facts. */
scope?: "runtime" | "session-entry";
/** The committed change affects model, account, or runtime catalog projection. */
catalogChanged?: true;
} & ({
reason: string;
swarmGroupId?: never;
kind?: never;
text?: never;
} | {
reason: "swarm-note";
swarmGroupId: string;
kind: "phase" | "log";
text: string;
});
type SessionIdentityMutationTarget = {
sessionId?: string;
sessionKeys: readonly string[];
};
type SessionIdentityMutation = {
/** Physical source captured by the committing database owner. */
databaseIdentity: string | symbol;
/** Resolved operation scope for bare keys; qualified keys retain their own agent. */
agentId: string;
} & ({
kind: "create" | "move" | "replace" | "reset";
previous: SessionIdentityMutationTarget;
current: SessionIdentityMutationTarget;
} | {
kind: "delete";
previous: SessionIdentityMutationTarget;
});
//#endregion
//#region src/config/sessions/runtime-types.d.ts
type RecordInboundSessionMetaParams = {
/** Set false to only patch existing entries; missing sessions stay absent. */
createIfMissing?: boolean;
/** Inbound message context whose stable metadata is derived and persisted. */
ctx: MsgContext;
/** Group routing resolution for group-owned session keys. */
groupResolution?: GroupKeyResolution | null;
/** Canonical or alias session key for the inbound conversation. */
sessionKey: string;
/** Explicit store target for file-backed stores and SQLite migration adapters. */
storePath: string;
};
type UpdateSessionLastRouteParams = Omit<RecordInboundSessionMetaParams, "ctx"> & {
/** Account owning the delivery route when the channel is multi-account. */
accountId?: string;
/** Delivery channel id persisted as the last route channel. */
channel?: string;
/** Optional inbound context whose session metadata is derived alongside the route. */
ctx?: MsgContext;
/** Explicit delivery context merged over the persisted session fallback. */
deliveryContext?: DeliveryContext;
/** Canonical channel route persisted as the session route slot. */
route?: ChannelRouteRef;
/** Thread/topic id for the delivery route, when the transport has one. */
threadId?: string | number;
/** Delivery target persisted as the last route recipient. */
to?: string;
};
/** Runtime hook for reading a session store entry timestamp. */
type ReadSessionUpdatedAt = (params: {
storePath: string;
sessionKey: string;
}) => number | undefined;
type RecordSessionMetaFromInbound = (params: RecordInboundSessionMetaParams) => Promise<SessionEntry$1 | null>;
type UpdateLastRoute = (params: UpdateSessionLastRouteParams) => Promise<SessionEntry$1 | null>;
//#endregion
//#region src/config/sessions/session-accessor.sqlite-contract.d.ts
type SessionTranscriptContextVersion = {
generation: string | null;
rawSeq: number | null;
updatedAt: number | null;
};
type TranscriptEventAppendOptions = {
appendIntent?: "active-branch";
/** Synchronous authority check run inside the append transaction. */
beforeCommitInTransaction?: () => void;
/** Reject the append when the transcript changed since the caller loaded it. */
expectedMutationAt?: number | null;
};
type TranscriptAppendRefusal = {
actualSessionIdHash: string;
agentIdHash: string;
code: "session-rebound";
expectedSessionIdHash: string;
sessionKeyHash: string;
} | {
agentIdHash: string;
code: "session-entry-missing";
expectedSessionIdHash: string;
sessionKeyHash: string;
};
//#endregion
//#region src/config/sessions/session-accessor.sqlite-scope.d.ts
type ResolvedSqliteScope = {
agentId: string;
databaseAgentId?: string;
env?: NodeJS.ProcessEnv;
ownerStorePath?: string;
path?: string;
sessionKey: string;
};
type ResolvedSqliteReadScope = Omit<ResolvedSqliteScope, "sessionKey"> & {
sessionKey?: string;
};
type ResolvedTranscriptReadScope = ResolvedSqliteReadScope & {
sessionId: string;
};
//#endregion
//#region src/agents/sessions/session-manager-types.d.ts
interface SessionHeader {
type: "session";
version?: number;
id: string;
timestamp: string;
cwd: string;
parentSession?: string;
}
interface NewSessionOptions {
id?: string;
parentSession?: string;
}
interface SessionEntryBase {
type: string;
id: string;
parentId: string | null;
timestamp: string;
/** This row consumes the raw side cursor instead of the visible leaf. */
appendMode?: "side";
}
interface SessionMessageEntry extends SessionEntryBase {
type: "message";
message: AgentMessage;
}
interface ThinkingLevelChangeEntry extends SessionEntryBase {
type: "thinking_level_change";
thinkingLevel: string;
}
interface ModelChangeEntry extends SessionEntryBase {
type: "model_change";
provider: string;
modelId: string;
}
interface CompactionEntry<T = unknown> extends SessionEntryBase {
type: "compaction";
__openclaw?: {
runId?: string;
itemId?: string;
};
summary: string;
firstKeptEntryId: string;
tokensBefore: number;
/** Context estimate after compaction, retained with its ordinary transcript marker. */
tokensAfter?: number;
/** Extension-specific data, such as artifact indexes or version markers. */
details?: T;
/** True for extension-generated compaction entries. */
fromHook?: boolean;
}
type ResetReason = "new" | "reset" | "idle" | "daily" | "cron-stale";
interface ResetEntry extends SessionEntryBase {
type: "reset";
reason: ResetReason;
firstKeptEntryId?: string;
}
interface BranchSummaryEntry<T = unknown> extends SessionEntryBase {
type: "branch_summary";
fromId: string;
summary: string;
/** Extension-specific data that is not sent to the model. */
details?: T;
/** True for extension-generated branch summaries. */
fromHook?: boolean;
}
/** Extension state that is persisted but excluded from model context. */
interface CustomEntry<T = unknown> extends SessionEntryBase {
type: "custom";
customType: string;
data?: T;
}
interface LabelEntry extends SessionEntryBase {
type: "label";
targetId: string;
label: string | undefined;
}
interface SessionInfoEntry extends SessionEntryBase {
type: "session_info";
name?: string;
}
/** Extension message that participates in model context. */
interface CustomMessageEntry<T = unknown> extends SessionEntryBase {
type: "custom_message";
customType: string;
content: string | (TextContent | ImageContent$1)[];
details?: T;
display: boolean;
}
type SessionEntry = SessionMessageEntry | ThinkingLevelChangeEntry | ModelChangeEntry | CompactionEntry | ResetEntry | BranchSummaryEntry | CustomEntry | CustomMessageEntry | LabelEntry | SessionInfoEntry;
type FileEntry = SessionHeader | SessionEntry;
type AppendPersistenceOptions = {
appendIntent?: "active-branch";
/** Synchronous fresh SQLite message assertion; never serialized into an entry. */
beforeFreshMessageCommit?: () => void;
config?: OpenClawConfig;
idempotencyLookup?: "scan" | "scan-assistant" | "caller-checked";
invalidateSerializedPrefixCache?: boolean;
};
interface SessionTreeNode {
entry: SessionEntry;
children: SessionTreeNode[];
label?: string;
labelTimestamp?: string;
}
interface SessionContext {
messages: AgentMessage[];
thinkingLevel: string;
model: {
provider: string;
modelId: string;
} | null;
}
type PreservedOpaqueFileEntry = {
index: number;
record: unknown;
};
type SessionLeafControl = {
type: "leaf";
id: string;
parentId: string | null;
timestamp: string;
targetId: string | null;
appendParentId?: string | null;
appendMode?: "side";
};
//#endregion
//#region src/config/sessions/transcript-target-binding.d.ts
type StorageEnvironment = Readonly<SqliteWorkerStateContext["environment"]>;
type SessionTranscriptTargetBinding = SessionTranscriptRuntimeTarget & {
env?: StorageEnvironment;
};
//#endregion
//#region src/config/sessions/transcript-write-context.d.ts
type SessionTranscriptWriterFence = Readonly<{
expectedLifecycleRevision: string | undefined;
expectedWriterRunId: string;
}>;
//#endregion
//#region src/config/sessions/session-accessor.sqlite-initial-entry.d.ts
type InitialSessionEntryCommit = {
owned: boolean;
fence?: SessionTranscriptWriterFence;
identity?: {
previous: Map<string, InternalSessionEntry>;
current: Map<string, InternalSessionEntry>;
};
};
//#endregion
//#region src/config/sessions/session-accessor.sqlite-entry.d.ts
/** Resolves the persisted session key for a SQLite transcript session id. */
declare function resolveSessionKeyBySessionId(scope: Pick<SessionTranscriptReadScope, "agentId" | "env" | "sessionId" | "storePath">): string | undefined;
declare function recordInboundSessionMeta(params: RecordInboundSessionMetaParams): Promise<InternalSessionEntry | null>;
/** Updates last-route/delivery metadata without refreshing activity timestamps. */
declare function updateSessionLastRoute(params: UpdateSessionLastRouteParams & {
assertCommitAllowed?: () => void;
}): Promise<InternalSessionEntry | null>;
//#endregion
//#region src/config/sessions/session-accessor.sqlite-read.d.ts
/** Pair loaded bytes with the watermark that also fences opaque navigation edits. */
declare function loadTranscriptReadSnapshotSync(scope: SessionTranscriptReadScope, options?: {
readOnly?: boolean;
resolvedScope?: ResolvedTranscriptReadScope;
}): {
events: TranscriptEvent[];
version: SessionTranscriptContextVersion;
};
//#endregion
//#region src/config/sessions/transcript-payload.d.ts
type TranscriptPayloadRecord = {
event_json: string | null;
event_zstd: Uint8Array | null;
event_utf8_bytes: number | null;
navigation_json: string | null;
};
type PreparedTranscriptPayload = {
eventJson: string;
storageEncoding: string;
payload: TranscriptPayloadRecord;
};
//#endregion
//#region src/config/sessions/session-accessor.sqlite-transcript-message-append.d.ts
type PreparedTranscriptMessageAppend<TMessage> = {
messageJson: string;
persistedMessage: TMessage;
physicalPayload?: PreparedTranscriptPayload;
};
//#endregion
//#region src/config/sessions/session-accessor.sqlite-transcript-write-snapshot.d.ts
type TranscriptWriteSnapshot<T> = {
result: T;
lifecycleRevision?: string;
before: SessionTranscriptContextVersion;
after: SessionTranscriptContextVersion;
};
type TranscriptWriteViewGuard = {
assertCurrent: () => void;
onPendingTransaction: (database: DatabaseSync) => void;
};
//#endregion
//#region src/config/sessions/session-accessor.sqlite-transcript-write.d.ts
type TranscriptMessageWriteSnapshot<TMessage> = TranscriptWriteSnapshot<TranscriptMessageAppendResult<TMessage> | undefined> & {
visibleTail: {
entryId: string | null;
generation: string | null;
};
};
type TranscriptEventAppendResult = {
appended: false;
} | {
appended: true;
effectiveParentId?: string | null;
};
/** Appends one raw transcript event to the additive SQLite transcript store. */
declare function appendTranscriptEvent(scope: SessionTranscriptAccessScope, event: TranscriptEvent, options?: TranscriptEventAppendOptions): Promise<void>;
declare function appendTranscriptEventSnapshotSync(scope: SessionTranscriptWriteScope, event: TranscriptEvent, options?: TranscriptEventAppendOptions, projection?: {
scheduleProjectionReconcile: false;
onProjectionReconcileNeeded: () => void;
}, view?: TranscriptWriteViewGuard): Result$1<TranscriptWriteSnapshot<TranscriptEventAppendResult>, TranscriptAppendRefusal>;
declare function appendTranscriptMessageSnapshotSync<TMessage>(scope: SessionTranscriptWriteScope, options: TranscriptMessageAppendOptions<TMessage>, preparedMessage?: PreparedTranscriptMessageAppend<TMessage>, workerOptions?: {
messageAlreadyRedacted?: true;
scheduleProjectionReconcile?: boolean;
onProjectionReconcileNeeded?: () => void;
}, view?: TranscriptWriteViewGuard): Result$1<TranscriptMessageWriteSnapshot<TMessage>, TranscriptAppendRefusal>;
//#endregion
//#region packages/agent-core/src/harness/types.d.ts
interface FileOperations {
read: Set<string>;
written: Set<string>;
edited: Set<string>;
}
//#endregion
//#region packages/agent-core/src/harness/compaction/compaction.d.ts
/** File-operation details stored on generated compaction entries. */
interface CompactionDetails {
/** Files read in the compacted history. */
readFiles: string[];
/** Files modified in the compacted history. */
modifiedFiles: string[];
/** Run-owned request that remains active across another compaction generation. */
latestUnresolvedUserRequest?: string;
}
/** Generated compaction data ready to be persisted as a compaction entry. */
interface CompactionResult<T = unknown> {
/** Summary text that replaces compacted history in future context. */
summary: string;
/** Entry id where retained history starts. */
firstKeptEntryId: string;
/** Estimated context tokens before compaction. */
tokensBefore: number;
/** Optional implementation-specific details stored with the compaction entry. */
details?: T;
}
/** Compaction thresholds and retention settings. */
interface CompactionSettings$1 {
/** Enable automatic compaction decisions. */
enabled: boolean;
/** Tokens reserved for summary prompt and output. */
reserveTokens: number;
/** Approximate recent-context tokens to keep after compaction. */
keepRecentTokens: number;
}
/** Prepared inputs for a compaction run. */
interface CompactionPreparation {
/** Remaining foreground summary tokens, independent of the summarizer's context window. */
summaryTokenBudget?: number;
/** Entry id where retained history starts. */
firstKeptEntryId: string;
/** Messages summarized into the history summary. */
messagesToSummarize: AgentMessage[];
/** Prefix messages summarized separately when compaction splits a turn. */
turnPrefixMessages: AgentMessage[];
/** Whether compaction splits a turn. */
isSplitTurn: boolean;
/** Bounded request that the run owner will resume after compaction. */
latestUnresolvedUserRequest?: string;
/** Estimated context tokens before compaction. */
tokensBefore: number;
/** Previous compaction summary used for iterative updates. */
previousSummary?: string;
/** File metadata already appended to the previous compaction summary. */
previousSummaryDetails?: CompactionDetails;
/** File operations extracted from summarized history. */
fileOps: FileOperations;
/** Settings used to prepare compaction. */
settings: CompactionSettings$1;
}
//#endregion
//#region packages/agent-core/src/harness/utils/truncate.d.ts
/** Result metadata for content truncated by line count, byte count, or both. */
interface TruncationResult {
/** The truncated content */
content: string;
/** Whether truncation occurred */
truncated: boolean;
/** Which limit was hit: "lines", "bytes", or null if not truncated */
truncatedBy: "lines" | "bytes" | null;
/** Total number of lines in the original content */
totalLines: number;
/** Total number of bytes in the original content */
totalBytes: number;
/** Number of complete lines in the truncated output */
outputLines: number;
/** Number of bytes in the truncated output */
outputBytes: number;
/** Whether the last line was partially truncated (only for tail truncation edge case) */
lastLinePartial: boolean;
/** Whether the first line exceeded the byte limit (for head truncation) */
firstLineExceedsLimit: boolean;
/** The max lines limit that was applied */
maxLines: number;
/** The max bytes limit that was applied */
maxBytes: number;
}
//#endregion
//#region src/config/sessions/session-accessor.sqlite-model-context.d.ts
type SessionModelContextLimits = {
maxBytes: number;
maxEvents: number;
/** Detached model views may omit result bodies; evidence and fork readers remain strict. */
toolResultOverflow?: "omit";
};
//#endregion
//#region src/agents/internal-runtime-context.d.ts
/** Provenance assigned by the context producer, never inferred from its text. */
type RuntimeContextFragment = {
kind: "runtime-instruction" | "conversation-data" | "heartbeat-outcome";
text: string;
};
type CurrentInboundPromptContext = {
text: string;
/** Producer-owned fragments for model projection; text remains the legacy rendering. */
fragments?: RuntimeContextFragment[];
resumableText?: string;
promptJoiner?: "\n\n" | "\n" | " ";
/** Generated goal blocks owned by inbound-context assembly, never user text. */
injectedGoalContexts?: string[];
};
/** Identifies hidden runtime context independently of its queue or transcript owner. */
declare function isOpenClawRuntimeContextCustomMessage(message: unknown): boolean;
//#endregion
//#region src/config/sessions/main-session.d.ts
/** Canonicalizes main-session aliases to the current scoped session key. */
declare function canonicalizeMainSessionAlias(params: {
cfg?: {
session?: {
scope?: SessionScope$1;
mainKey?: string;
};
};
agentId: string;
sessionKey: string;
}): string;
//#endregion
//#region src/config/sessions/ambient-transcript-watermark.d.ts
type AmbientTranscriptWatermarkScope = {
channel: string;
accountId?: string;
conversationId: string;
threadId?: string | number;
};
declare function resolveAmbientTranscriptWatermarkKey(scope: AmbientTranscriptWatermarkScope): string;
declare function updateAmbientTranscriptWatermark(params: {
storePath: string;
sessionKey: string;
key: string;
messageId: string;
timestampMs?: number;
expectedSessionId?: string;
}): Promise<SessionEntry$1 | null>;
//#endregion
//#region src/plugin-sdk/session-store-runtime-internal.d.ts
type SessionStoreReadParams = {
agentId?: string;
env?: NodeJS.ProcessEnv;
hydrateSkillPromptRefs?: boolean;
readConsistency?: "latest";
sessionKey: string;
storePath?: string;
};
//#endregion
//#region src/config/sessions/session-accessor.sqlite-active-context.d.ts
type SessionTranscriptBoundedActiveContext = {
activeLeafEntryId: string | null;
version: SessionTranscriptContextVersion;
opaqueParents: Map<string, string | null>;
parents: Map<string, string | null>;
firstKeptRanges: Map<string, {
startIndex: number;
endIndex: number;
}>;
persistedSuffixStartSeq: number;
boundaryCount: number;
events: TranscriptEvent[];
serializedBytes: number;
totalEvents: number;
transcriptMutationAt: number | null;
truncated: boolean;
};
//#endregion
//#region src/agents/sessions/session-manager-view-types.d.ts
type SessionManagerPersistenceTarget = SessionTranscriptTargetBinding;
type SessionManagerBoundedContextLimits = {
maxBytes: number;
maxEvents: number;
};
type PreparedSessionTranscriptReload = PreparedSessionTranscriptHydration;
type SessionManagerBoundedContext = Pick<SessionTranscriptBoundedActiveContext, "activeLeafEntryId" | "version" | "opaqueParents" | "parents" | "firstKeptRanges" | "persistedSuffixStartSeq" | "boundaryCount" | "transcriptMutationAt"> & {
limits: SessionManagerBoundedContextLimits;
};
//#endregion
//#region src/agents/sessions/session-manager-current-turn.d.ts
/** @internal Replay preparation is not part of the public SessionManager API. */
declare const sessionManagerPrepareCurrentTurnReplay: unique symbol;
/** @internal Runtime model history is not the raw persistence/navigation window. */
declare const sessionManagerReadInitialContext: unique symbol;
type CurrentTurnReplayWitness = {
anchor: TranscriptEntryAnchor;
version: SessionTranscriptContextVersion;
};
//#endregion
//#region src/config/sessions/session-entry-codec.d.ts
declare function parseOpaqueLeafEntry(record: unknown): {
id: string;
parentId: string | null;
targetId: string | null;
appendParentId?: string | null;
appendMode?: "side";
} | undefined;
//#endregion
//#region src/config/sessions/session-entry-navigation.d.ts
type SessionNavigationEntry = Pick<SessionEntryBase, "id" | "parentId"> & {
timestamp?: string;
appendMode?: unknown;
} & ({
type: "label";
targetId: string;
label?: string;
} | {
type: Exclude<SessionEntry["type"], "label">;
});
/** One navigation owner for runtime sessions and streaming transcript operations. */
declare class SessionEntryNavigation<T extends SessionNavigationEntry> {
protected byId: Map<string, T>;
protected opaqueParentsById: Map<string, string | null>;
protected logicalParentsById: Map<string, string | null>;
protected invalidLeafControlIds: Set<string>;
protected labelsById: Map<string, string>;
protected labelTimestampsById: Map<string, T["timestamp"]>;
protected leafId: string | null;
protected appendParentId: string | null;
protected appendMode: "side" | undefined;
private latestResetId;
private resetDescendantIds;
protected clearNavigation(): void;
protected finishNavigation(): void;
protected resolveOpaqueLeafTargetId(targetId: string | null): string | null;
protected resolveOpaqueAppendParentId(parentId: string | null): string | null;
protected resolveOpaqueLeafControl(leafEntry: ReturnType<typeof parseOpaqueLeafEntry>): {
leafId: string | null;
appendParentId: string | null;
appendMode?: "side";
} | undefined;
protected appendOpaqueNavigationRecord(opaqueRecord: unknown): void;
protected appendCanonicalNavigationEntry(entry: T, hasParentId?: boolean): void;
protected resolveCanonicalParentId(parentId: string | null): string | null;
protected resolveEntryParentId(entry: T): string | null;
protected normalizeEntryParent(entry: T): T;
getBranch(fromId?: string): T[];
}
//#endregion
//#region src/agents/sessions/session-manager-core.d.ts
declare class SessionManagerCore extends SessionEntryNavigation<SessionEntry> {
migrated: boolean;
protected sessionId: string;
protected transcriptVersion: SessionTranscriptContextVersion | undefined;
private transcriptViewFailure;
private hydrationRevision;
protected cwd: string;
protected fileEntries: FileEntry[];
protected opaqueFileEntries: PreservedOpaqueFileEntry[];
protected boundedParentIds: Map<string, string | null>;
private boundedFirstKeptById;
protected pendingDeliberateAppend: boolean;
protected persistenceTarget: SessionManagerPersistenceTarget | undefined;
protected persistenceHeaderPending: boolean;
protected boundedContextLimits: SessionManagerBoundedContextLimits | undefined;
protected boundedContextIncomplete: boolean;
protected persistedBoundaryCount: number | undefined;
protected persistedSuffixStartSeq: number | undefined;
protected transcriptMutationAt: number | null | undefined;
constructor(cwd: string, persistenceTarget?: SessionManagerPersistenceTarget, loadedEntries?: readonly unknown[], boundedContext?: SessionManagerBoundedContext, transcriptMutationAt?: number | null, version?: SessionTranscriptContextVersion);
/** @deprecated Runtime callers should await setSessionTargetAsync. */
setSessionTarget(target: SessionTranscriptRuntimeTarget): void;
/** Prepare off-thread and publish the entire view only while this manager is unchanged. */
setSessionTargetAsync(target: SessionTranscriptRuntimeTarget, signal?: AbortSignal): Promise<void>;
private hydrateSessionTarget;
/** Reload an existing view without changing the runtime working directory. */
reloadPersistedTranscriptAsync(signal?: AbortSignal): Promise<void>;
/** Active-only loads can omit sibling rows even when they fit the context limits. */
protected ensureCompletePersistedHistory(): void;
protected setLoadedSessionTarget(target: SessionManagerPersistenceTarget | undefined, entries: readonly unknown[], bounded?: Pick<SessionTranscriptBoundedActiveContext, "activeLeafEntryId" | "version" | "opaqueParents" | "parents" | "firstKeptRanges">, version?: SessionTranscriptContextVersion): void;
protected adoptSelectedTranscriptPath(appendParentId: string | null, parents: Iterable<readonly [string, string | null]>): void;
/** The loaded view only: bounded managers must never hydrate inactive history for a rewrite. */
protected captureTranscriptView(copy?: boolean): {
sessionId: string;
transcriptVersion: SessionTranscriptContextVersion | undefined;
persistenceHeaderPending: boolean;
migrated: boolean;
fileEntries: FileEntry[];
opaqueFileEntries: PreservedOpaqueFileEntry[];
byId: Map<string, SessionEntry>;
opaqueParentsById: Map<string, string | null>;
logicalParentsById: Map<string, string | null>;
invalidLeafControlIds: Set<string>;
labelsById: Map<string, string>;
labelTimestampsById: Map<string, string>;
boundedFirstKeptById: Map<string, string>;
boundedParentIds: Map<string, string | null>;
boundedContextIncomplete: boolean;
boundedContextLimits: SessionManagerBoundedContextLimits | undefined;
persistedBoundaryCount: number | undefined;
persistedSuffixStartSeq: number | undefined;
transcriptMutationAt: number | null | undefined;
leafId: string | null;
appendParentId: string | null;
appendMode: "side" | undefined;
pendingDeliberateAppend: boolean;
};
/** @deprecated Runtime callers should await reloadPersistedTranscriptAsync. */
reloadPersistedTranscript(): void;
/** Reloads a committed append without adopting a later user turn. */
protected reloadPersistedTranscriptAfterAppend(expectedMutationAt: number | null, expectedEntryId: string, admittedUserId: string): void;
/** Adopt owner-prepared bytes without reading SQLite again on the receiving thread. */
protected adoptPreparedTranscriptReload(prepared: PreparedSessionTranscriptReload, append?: {
expectedMutationAt: number | null;
expectedEntryId: string;
admittedUserId: string;
}): void;
newSession(options?: NewSessionOptions): string | undefined;
private initializeSession;
protected buildIndex(): void;
protected normalizeEntryParent(entry: SessionEntry): SessionEntry;
protected resolveBranchTargetId(branchFromId: string): string | null | undefined;
protected clampOpaqueFileEntryIndexes(): void;
protected createLeafControl(parentId: string | null, appendParentId?: string | null, appendMode?: "side"): SessionLeafControl;
protected rememberLeafControl(leafEntry: SessionLeafControl): void;
getSessionName(): string | undefined;
getChildren(parentId: string): SessionEntry[];
getLabel(id: string): string | undefined;
getBoundaryCount(): number;
getHeader(): SessionHeader | null;
getEntries(): SessionEntry[];
getTree(): SessionTreeNode[];
getLeafId(): string | null;
getLeafEntry(): SessionEntry | undefined;
getEntry(id: string): SessionEntry | undefined;
getAppendParentId(): string | null;
getAppendMode(): "side" | undefined;
protected getPersistedFileEntries(leafAppendParentId?: string | null, leafAppendMode?: "side"): unknown[];
getPersistedEntries(): unknown[];
clearPreservedOpaqueFileEntries(): void;
protected invalidateTranscriptView(error: Error): void;
protected assertTranscriptViewAvailable(): void;
getBranch(fromId?: string): SessionEntry[];
isPersisted(): boolean;
getCwd(): string;
getSessionId(): string;
getSessionTarget(): SessionManagerPersistenceTarget | undefined;
}
//#endregion
//#region src/agents/sessions/session-manager-metadata.worker.d.ts
type MetadataTarget = Omit<SessionTranscriptWriteScope, "env"> & SessionTranscriptRuntimeTarget;
type SessionMetadataOperations = {
"session.transcript.appendMessage": {
input: {
scope: MetadataTarget;
message: CustomMessage;
cwd: string;
};
output: {
snapshot: ReturnType<typeof appendTranscriptMessageSnapshotSync<CustomMessage>>;
projectionNeedsReconcile: boolean;
};
};
"session.metadata.initialize": {
input: {
scope: MetadataTarget;
entry: InternalSessionEntry;
initialWriterRunId?: string;
};
output: InitialSessionEntryCommit;
};
"session.metadata.append": {
input: {
scope: MetadataTarget;
event: SessionHeader | ModelChangeEntry | ThinkingLevelChangeEntry | SessionMessageEntry;
message?: {
prepared: PreparedTranscriptMessageAppend<SessionMessageEntry["message"]>;
cwd: string;
validateTurn: boolean;
idempotencyLookup?: "scan" | "scan-assistant" | "caller-checked";
};
options: Pick<NonNullable<Parameters<typeof appendTranscriptEventSnapshotSync>[2]>, "appendIntent" | "expectedMutationAt">;
view?: {
loadedVersion?: SessionTranscriptContextVersion;
limits?: SessionManagerBoundedContextLimits;
admission?: UserTurnTranscriptAdmissionReceipt;
};
};
output: {
snapshot: Result$1<TranscriptWriteSnapshot<TranscriptEventAppendResult | TranscriptMessageAppendResult<SessionMessageEntry["message"]> | undefined>, TranscriptAppendRefusal>;
projectionNeedsReconcile: boolean;
reload?: Result$1<PreparedSessionTranscriptReload, OpenClawStateWorkerErrorPayload | undefined>;
};
};
"session.metadata.mutation": {
input: {
scope: MetadataTarget;
};
output: number | null;
};
};
type SessionMetadataWorkerOperations = { [Key in keyof SessionMetadataOperations]: {
input: SessionMetadataOperations[Key]["input"];
output: {
ok: true;
value: SessionMetadataOperations[Key]["output"];
} | {
ok: false;
refusal?: TranscriptAppendRefusal;
};
}; };
//#endregion
//#region src/agents/sessions/session-manager-write-admission.d.ts
type SessionManagerWriteAdmission = {
database: OpenClawAgentDatabase;
options: OpenClawAgentDatabaseOptions;
};
//#endregion
//#region src/agents/sessions/session-manager-persistence.d.ts
type PersistRecordResult = undefined | {
anchor?: TranscriptEntryAnchor;
lifecycleRevision?: string;
appended: boolean;
adoptedMessageId?: string;
effectiveParentId: string | null;
reloadAfterAppend?: boolean;
};
type PersistWorkerRecordResult = {
result: PersistRecordResult;
reload?: PreparedSessionTranscriptReload;
committedVersion: SessionTranscriptContextVersion;
viewFailure?: Error;
};
type PersistRecordOptions = AppendPersistenceOptions & {
/** Retry fence captured from the durable snapshot that passed validation. */
expectedMutationAt?: number | null;
};
declare class SessionManagerPersistence extends SessionManagerCore {
#private;
protected retainTranscriptWriter(): void;
protected assertTranscriptWriteActive(): void;
protected hasNewerPublishedTranscriptView(version: SessionTranscriptContextVersion): boolean;
protected persistWorkerRecord(entry: ModelChangeEntry | ThinkingLevelChangeEntry | SessionMessageEntry, appendIntent: "active-branch" | undefined, writeAdmission: SessionManagerWriteAdmission, message?: NonNullable<SessionMetadataWorkerOperations["session.metadata.append"]["input"]["message"]>): Promise<PersistWorkerRecordResult>;
protected persistRecord(entry: unknown, options?: PersistRecordOptions, preparedMessage?: PreparedTranscriptMessageAppend<AgentMessage>): PersistRecordResult;
persist(entry: SessionEntry, options?: PersistRecordOptions): PersistRecordResult;
private persistSqliteRecord;
}
//#endregion
//#region src/agents/sessions/session-manager-suffix-persistence.d.ts
declare class SessionManagerSuffixPersistence extends SessionManagerPersistence {
removeTrailingEntries(predicate: (entry: SessionEntry) => boolean, options?: {
preserveTrailing?: (entry: SessionEntry) => boolean;
}): number;
}
//#endregion
//#region src/agents/sessions/session-manager-entries.d.ts
declare class SessionManagerEntries extends SessionManagerSuffixPersistence {
protected appendEntry<T extends SessionEntry>(entry: T, options?: AppendPersistenceOptions): {
entry: T;
anchor?: TranscriptEntryAnchor;
lifecycleRevision?: string;
appended: boolean;
};
protected adoptWorkerCommittedEntry<T extends SessionEntry>(entry: T, committed: PersistWorkerRecordResult, admittedUserId?: string): {
entry: T;
anchor?: TranscriptEntryAnchor;
lifecycleRevision?: string;
appended: boolean;
viewWasSuperseded?: true;
};
protected adoptPersistedEntry<T extends SessionEntry>(canonicalEntry: T, persistenceResult: PersistRecordResult, admittedUserId?: string, preparedReload?: PreparedSessionTranscriptReload): {
entry: T;
anchor?: TranscriptEntryAnchor;
lifecycleRevision?: string;
appended: boolean;
};
private createTranscriptMutationConflictError;
resolveCurrentTurnEntryId(isInterruptedTail?: (entry: SessionEntry) => boolean, options?: {
includeOmittedCustomMessages?: boolean;
}): string | null;
[sessionManagerPrepareCurrentTurnReplay](isInterruptedTail: (entry: SessionEntry) => boolean, matchesUser: (entry: SessionEntry | undefined) => boolean, signal?: AbortSignal): Promise<CurrentTurnReplayWitness | undefined>;
appendMessage(message: Message | CustomMessage | BashExecutionMessage, options?: AppendPersistenceOptions): string;
appendMessageAsync(message: Message | CustomMessage | BashExecutionMessage, options?: AppendPersistenceOptions): Promise<string | undefined>;
appendMessageWithTranscriptAnchorAsync(message: Message | CustomMessage | BashExecutionMessage, options?: AppendPersistenceOptions): Promise<ReturnType<SessionManagerEntries["appendMessageWithTranscriptAnchor"]> & {
viewWasSuperseded?: true;
}>;
appendMessageWithTranscriptAnchor(message: Message | CustomMessage | BashExecutionMessage, options?: AppendPersistenceOptions): {
entryId: string;
message: SessionMessageEntry["message"];
anchor?: TranscriptEntryAnchor;
lifecycleRevision?: string;
appended: boolean;
};
appendCompaction(summary: string, firstKeptEntryId: string, tokensBefore: number, details?: unknown, fromHook?: boolean, metadata?: CompactionEntry["__openclaw"], tokensAfter?: number): string;
appendResetBoundary(reason: ResetReason, firstKeptEntryId?: string): string;
appendCustomEntry(customType: string, data?: unknown): string;
appendSessionInfo(name: string): string;
appendCustomMessageEntry(customType: string, content: string | (TextContent | ImageContent$1)[], display: boolean, details?: unknown): string;
appendLeafControl(params: {
targetId: string | null;
appendParentId: string | null;
appendMode?: "side";
}): SessionLeafControl;
appendLabelChange(targetId: string, label: string | undefined): string;
buildSessionContext(): SessionContext;
branch(branchFromId: string): void;
resetLeaf(): void;
branchWithSummary(branchFromId: string | null, summary: string, details?: unknown, fromHook?: boolean): string;
}
//#endregion
//#region src/agents/sessions/session-manager-metadata.d.ts
declare class SessionManagerMetadata extends SessionManagerEntries {
private appendMetadataEntry;
private publishMetadataCommit;
appendThinkingLevelChange(thinkingLevel: string): Promise<string>;
appendModelChange(provider: string, modelId: string): Promise<string>;
}
//#endregion
//#region src/agents/sessions/session-manager-branching.d.ts
declare class SessionManagerBranching extends SessionManagerMetadata {
private collectBranchedSessionPath;
createBranchedSession(leafId: string): Promise<string | undefined>;
}
//#endregion
//#region src/agents/sessions/session-manager.d.ts
declare class SessionManager extends SessionManagerBranching {
private constructor();
[sessionManagerReadInitialContext](): Promise<SessionContext>;
/** No buffered writes remain here; asynchronous metadata methods own their settlement. */
flushPendingPersistence(): void;
appendMessage(message: Message | CustomMessage | BashExecutionMessage, options?: AppendPersistenceOptions): string;
appendMessageWithTranscriptAnchor(message: Message | CustomMessage | BashExecutionMessage, options?: AppendPersistenceOptions): {
entryId: string;
message: SessionMessageEntry["message"];
anchor?: TranscriptEntryAnchor;
lifecycleRevision?: string;
appended: boolean;
};
/** Prepare off-store; publish the suffix and adopt memory at the same outer commit edge. */
prepareTranscriptRewrite(): {
sessionManager: SessionManager;
commit: (rewrittenEntryIds: ReadonlyMap<string, string>) => void;
};
/** Opens an existing store off-thread; empty transcripts keep lazy header initialization. */
static openAsync(target: SessionTranscriptRuntimeTarget, cwdOverride?: string, contextLimits?: SessionManagerBoundedContextLimits, signal?: AbortSignal): Promise<SessionManager>;
/** @deprecated Runtime callers should await openAsync. */
static open(target: SessionTranscriptRuntimeTarget, cwdOverride?: string, contextLimits?: SessionManagerBoundedContextLimits): SessionManager;
/** @deprecated Runtime callers should await openBoundedAsync. */
static openBounded(target: SessionTranscriptRuntimeTarget, options: SessionManagerBoundedContextLimits & {
cwd?: string;
onTruncated?: () => void;
}): SessionManager;
/** Reads an existing store's bounded view under the history worker's database custody. */
static openBoundedAsync(target: SessionTranscriptRuntimeTarget, options: SessionManagerBoundedContextLimits & {
cwd?: string;
onTruncated?: () => void;
signal?: AbortSignal;
}): Promise<SessionManager>;
/** Detach the prepared bounded branch without retaining database custody. */
static openDetachedBoundedAsync(target: SessionTranscriptRuntimeTarget, options: Parameters<typeof SessionManager.openBoundedAsync>[1]): Promise<SessionManager>;
/** @deprecated Runtime callers should await openDetachedBoundedAsync. */
static openDetachedBounded(target: SessionTranscriptRuntimeTarget, options: Parameters<typeof SessionManager.openBounded>[1]): SessionManager;
/** Detached model view: selected payloads plus lightweight ancestry, never raw replay evidence. */
static openModelContext(target: SessionTranscriptRuntimeTarget, options?: {
cwd?: string;
admission?: UserTurnTranscriptAdmissionReceipt;
through?: TranscriptEntryAnchor;
limits?: SessionModelContextLimits;
}): SessionManager;
/** The same detached model view, with durable transcript scanning off the event loop. */
static openModelContextAsync(target: SessionTranscriptRuntimeTarget, options?: {
cwd?: string;
admission?: UserTurnTranscriptAdmissionReceipt;
signal?: AbortSignal;
through?: TranscriptEntryAnchor;
limits?: SessionModelContextLimits;
}): Promise<SessionManager>;
private static fromSelectedEntries;
/** Synchronously consumes full-fidelity context; its iterator closes with the read snapshot. */
static readSessionContext<T>(target: SessionTranscriptRuntimeTarget, read: (messages: Iterable<AgentMessage>, header: unknown) => T, options?: {
admission?: UserTurnTranscriptAdmissionReceipt;
}): T;
/**
* @deprecated Retained for the v2026.9.5 plugin SDK contract.
* Removal requires a versioned SDK replacement and plugin migration window.
*/
static appendMessageToTranscript(target: SessionTranscriptRuntimeTarget, message: Message | CustomMessage | BashExecutionMessage, options?: Pick<AppendPersistenceOptions, "config">): string;
static inMemory(cwd?: string): SessionManager;
static fromEntries(entries: readonly unknown[], cwdOverride?: string): SessionManager;
}
type ReadonlySessionManager = Pick<SessionManager, "getCwd" | "getSessionId" | "getSessionTarget" | "getLeafId" | "getAppendParentId" | "getAppendMode" | "getLeafEntry" | "getEntry" | "getLabel" | "getBranch" | "getHeader" | "getEntries" | "getTree" | "getSessionName">;
//#endregion
//#region src/config/sessions/transcript.d.ts
type SessionTranscriptDeliveryMirror = {
kind: "channel-final";
sourceMessageId?: string;
} | {
kind: "channel-final-suppressed";
reason: "stale-foreground";
sourceMessageId?: string;
};
type SessionRecentConversationText = {
id?: string;
role: "user" | "assistant";
text: string;
timestamp?: number;
sourceChannel?: string;
};
type ReadRecentSessionConversationTextOptions = {
beforeTimestampMs?: number;
includeCronDirectDeliveryContext?: boolean;
limit?: number;
minTimestampMs?: number;
role?: "user" | "assistant";
preferUpstreamUserText?: boolean;
};
type ReadRecentSessionConversationTextParams = ReadRecentSessionConversationTextOptions & {
agentId: string;
sessionKey: string;
storePath?: string;
};
declare function readRecentUserAssistantTextForSession(params: ReadRecentSessionConversationTextParams): Promise<SessionRecentConversationText[]>;
//#endregion
//#region src/plugin-sdk/session-transcript-runtime.d.ts
type SessionTranscriptEvent = unknown;
//#endregion
//#region src/utils/delivery-context.read.d.ts
/** Reads only the canonical persisted delivery record. */
declare function deliveryContextFromSession(entry?: Pick<SessionEntry$1, "delivery">): DeliveryContext | undefined;
declare function sessionDeliveryRoute(entry?: Pick<SessionEntry$1, "delivery">): ChannelRouteRef | undefined;
declare function sessionDeliveryOrigin(entry?: Pick<SessionEntry$1, "delivery">): SessionOrigin | undefined;
declare function sessionDeliveryChannel(entry?: Pick<SessionEntry$1, "delivery">): string | undefined;
//#endregion
//#region src/config/sessions/legacy-sqlite-marker.d.ts
type SqliteSessionFileMarker = {
agentId: string;
sessionId: string;
storePath: string;
};
declare function formatSqliteSessionFileMarker(marker: SqliteSessionFileMarker): string;
declare function parseSqliteSessionFileMarker(sessionFile: string | undefined): SqliteSessionFileMarker | undefined;
declare function sqliteSessionFileMarkerMatchesSession(sessionFile: string | undefined, sessionId: string): boolean;
//#endregion
//#region src/config/sessions/session-key.d.ts
/**
* Resolves the persisted session-store key for an inbound message.
*
* Explicit session keys pass through the compatibility normalizer, direct chats collapse to the
* agent's canonical main bucket, and group/channel sessions stay isolated under the same agent.
*/
declare function resolveSessionKey(scope: SessionScope$1, ctx: MsgContext, mainKey?: string, agentId?: string): string;
//#endregion
//#region src/config/sessions/group.d.ts
/**
* Resolves channel/group chat context into the persisted group session key.
*
* Provider-prefixed ids use channel-owned normalization, while legacy plugin resolvers remain a
* fallback for older channel surfaces that cannot yet express the generic route shape.
*/
declare function resolveGroupSessionKey(ctx: MsgContext): GroupKeyResolution | null;
//#endregion
//#region src/config/sessions/store-writer-state.d.ts
/** Clears session writer queues and prompt-blob caches for tests. */
declare function clearSessionStoreCacheForTest(): void;
//#endregion
//#region src/sessions/agent-harness-session-key.d.ts
type AgentHarnessSessionStoreEntry = {
agentHarnessId?: unknown;
modelSelectionLocked?: unknown;
pluginOwnerId?: unknown;
sessionId?: unknown;
};
/** True for any valid durable harness lock, including supported ordinary-key rows. */
declare function isValidAgentHarnessSessionStoreEntry(sessionKey: string, entry: AgentHarnessSessionStoreEntry): boolean;
//#endregion
//#region src/config/sessions/reset-policy.d.ts
type SessionResetMode = "none" | "daily" | "idle";
type SessionStaleReason = Exclude<SessionResetMode, "none">;
type SessionResetType = "direct" | "group" | "thread";
type SessionResetPolicy = {
mode: SessionResetMode;
atHour: number;
idleMinutes?: number;
configured?: boolean;
};
type SessionFreshness = {
fresh: boolean;
dailyResetAt?: number;
idleExpiresAt?: number;
staleReason?: SessionStaleReason;
};
/** Resolves the effective reset policy for direct, group, or thread sessions. */
declare function resolveSessionResetPolicy(params: {
sessionCfg?: SessionConfig;
resetType: SessionResetType;
resetOverride?: SessionResetConfig;
}): SessionResetPolicy;
/** Evaluates whether a persisted session is still fresh under the resolved reset policy. */
declare function evaluateSessionFreshness(params: {
updatedAt: number;
sessionStartedAt?: number;
lastInteractionAt?: number;
now: number;
policy: SessionResetPolicy;
}): SessionFreshness;
//#endregion
//#region src/config/sessions/reset.d.ts
declare function resolveSessionResetType(params: {
sessionKey?: string | null;
isGroup?: boolean;
isThread?: boolean;
}): SessionResetType;
declare function resolveThreadFlag(params: {
sessionKey?: string | null;
messageThreadId?: string | number | null;
threadLabel?: string | null;
threadStarterBody?: string | null;
parentSessionKey?: string | null;
}): boolean;
declare function resolveChannelResetConfig(params: {
sessionCfg?: SessionConfig;
channel?: string | null;
}): SessionResetConfig | undefined;
//#endregion
//#region src/plugins/session-catalog.d.ts
type SessionCatalogListProviderParams = {
/** Gateway always supplies this; optional only for pre-existing external provider types. */
agentId?: string;
/** False when Gateway-local scans must not inherit a root from process HOME. */
allowProcessHomeFallback?: boolean;
/** Trimmed, non-empty search capped at 500 UTF-16 code units by the gateway. */
search?: string;
limitPerHost?: number;
hostIds?: string[];
cursors?: Record<string, string>;
/** Never mutate these entries; release after `list` settles or the list operation closes. */
sessionEntries?: SessionCatalogEntrySnapshot;
/** Lazily lists nodes once; release after `list` settles or the list operation closes. */
listNodes?: () => ReturnType<PluginRuntime["nodes"]["list"]>;
/** Publishes completed hosts without waiting for slower machines in the same list. */
onHost?: (host: SessionCatalogHost) => void;
/** True when the caller accepts retained/pending hosts and later authoritative onHost updates. */
allowPartialResults?: boolean;
/** Register host publication before the logical list settles; includes the onHost callback. */
waitUntil?: (completion: Promise<void>) => void;
/** Catalog owner retirement, independent of the requesting connection's lifetime. */
signal?: AbortSignal;
};
type SessionCatalogReadProviderParams = Omit<SessionsCatalogReadParams, "catalogId"> & {
/** Gateway always supplies this; optional only for pre-existing external provider types. */
agentId?: string;
/** False when Gateway-local reads must not inherit a root from process HOME. */
allowProcessHomeFallback?: boolean;
};
type SessionCatalogContinueProviderParams = Omit<SessionsCatalogContinueParams, "catalogId"> & {
/** Gateway always supplies this; optional only for pre-existing external provider types. */
agentId?: string;
/** False when Gateway-local continuation must not inherit a root from process HOME. */
allowProcessHomeFallback?: boolean;
/** Caller's gateway scopes so providers can gate high-authority continues up front. */
clientScopes?: readonly string[];
};
type SessionCatalogArchiveProviderParams = Omit<SessionsCatalogArchiveParams, "catalogId"> & {
/** Gateway always supplies this; optional only for pre-existing external provider types. */
agentId?: string;
/** False when Gateway-local archive must not inherit a root from process HOME. */
allowProcessHomeFallback?: boolean;
};
type SessionCatalogStartTerminalProviderParams = {
/** False when Gateway-local terminal start must not inherit process HOME. */
allowProcessHomeFallback?: boolean;
agentId: string;
cwd: string;
initialMessage?: string;
/** Present only when the caller selected a catalog host backed by this node. */
nodeId?: string;
/** Selected local catalog source; node ownership is carried by nodeId. */
hostId?: string;
};
type SessionCatalogTerminalPlan = {
kind: "local";
argv: string[];
cwd?: string;
title?: string;
/** Bounded command-specific environment overrides. */
env?: Record<string, string>;
/** PATH that resolved argv[0], needed by env-based script interpreters. */
pathEnv?: string;
} | {
kind: "node";
nodeId: string;
command: string;
paramsJSON: string;
cwd?: string;
title?: string;
/** Opt in only for native CLI text input, never for a shell receiver. */
uploadPathStyle?: TerminalUploadPathStyle;
};
type SessionCatalogCreateTarget = {
model: string;
/** Concrete runtime pinned onto the created session so config reloads cannot retarget it. */
agentRuntime: string;
};
interface SessionCatalogEntrySummary {
sessionKey: string;
entry: SessionEntry$1;
}
/** Shared, logically frozen store state for one request; copy locally before mutating. */
type SessionCatalogEntrySnapshot = {
/** Opaque immutable-entry revision, including config and selection scope. Cache only derived
* facts by this token; release entry references when the list closes. Not live authority. */
revision?: object;
entriesForAgent: (agentId: string) => readonly SessionCatalogEntrySummary[];
/** Request-wide flatten; optional for compatibility with pre-flatten plugin hosts. */
entriesForCatalog?: () => SessionCatalogAgentEntry[];
};
type SessionCatalogAgentEntry = SessionCatalogEntrySummary & {
agentId: string;
};
type SessionUpstreamJsonValue = null | boolean | number | string | SessionUpstreamJsonValue[] | {
[key: string]: SessionUpstreamJsonValue;
};
type SessionUpstreamKind = "claude-cli" | "codex-app-server" | "opencode-cli" | "pi-cli";
type SessionUpstreamProbe = {
sessionKey: string;
agentId: string;
threadId: string;
hostId: string;
upstreamKind: SessionUpstreamKind;
upstreamRef: SessionUpstreamJsonValue;
marker: SessionUpstreamJsonValue | null;
ownRecentUserTexts: string[];
};
declare function normalizeUserText(text: string): string;
declare function isExternalUserText(probe: SessionUpstreamProbe, text: string | undefined): boolean;
type SessionUpstreamActivity = {
kind: "activity";
sessionKey: string;
humanTurns: number;
nextMarker: SessionUpstreamJsonValue;
occurredAt?: number;
dedupeId?: string;
} | {
kind: "missing";
sessionKey: string;
};
type SessionCatalogContinueProviderResult = {
sessionKey: string;
/** Plugin binding installed for this authenticated Control UI session. */
conversationBinding?: {
summary?: string;
detachHint?: string;
data?: Record<string, unknown>;
};
/** Publishes provider state only after the requested binding is durable. */
afterConversationBound?: () => Promise<void>;
/** Upstream link seed so the monitor can detect direct external activity. */
upstream?: {
kind: SessionUpstreamKind;
ref: SessionUpstreamJsonValue;
marker: SessionUpstreamJsonValue;
};
};
type SessionCatalogProvider = {
id: string;
label: string;
/** Gateway artifacts are shared with all operators; remote publications follow session-viewing roles. */
audience?: "gateway-operators" | "session-viewers";
/** Closed plugin-owned route contract; invalid or colliding declarations are not projected. */
shareRoute?: SessionCatalogShareRoute;
/** Declares that every HOME-sensitive action honors the host isolation policy. */
supportsProcessHomeIsolation?: true;
/** Config-derived target; the Gateway memoizes it for one runtime-config object identity. */
resolveCreateSession?: (params: {
/** Agent whose model/runtime policy must authorize the catalog target. */
agentId?: string;
}) => SessionCatalogCreateTarget | undefined;
list: (params: SessionCatalogListProviderParams) => Promise<SessionCatalogHost[]>;
/** Optional inert factory; each settled step leaves no foreground work running. */
createListOperation?: (params: SessionCatalogListProviderParams) => {
next: () => Promise<{
done: false;
} | {
done: true;
hosts: SessionCatalogHost[];
}>;
/** Synchronous cleanup, called once after the last active step settles. */
close: () => void;
};
/** Items are newest-first by source order; nextCursor continues to older items. */
read: (params: SessionCatalogReadProviderParams) => Promise<SessionsCatalogReadResult>;
continueSession?: (params: SessionCatalogContinueProviderParams) => Promise<SessionCatalogContinueProviderResult>;
/** Copy catalog history into a new ordinary Gateway-owned session. */
copyToGatewaySession?: (params: SessionCatalogContinueProviderParams) => Promise<{
displayName?: string;
preferredModel?: string;
}>;
checkUpstreamActivity?: (probes: SessionUpstreamProbe[], policy?: {
allowProcessHomeFallback?: boolean;
}) => Promise<SessionUpstreamActivity[]>;
archive?: (params: SessionCatalogArchiveProviderParams) => Promise<{
ok: true;
}>;
openTerminal?: (request: {
allowProcessHomeFallback?: boolean;
/** Gateway always supplies this; optional only for pre-existing external provider types. */
agentId?: string;
hostId: string;
threadId: string;
sourceHomeId?: string;
}) => Promise<SessionCatalogTerminalPlan>;
startTerminalSession?: (request: SessionCatalogStartTerminalProviderParams) => Promise<SessionCatalogTerminalPlan>;
};
declare function listSessionCatalogEntries(params: {
agentId?: string;
config: OpenClawConfig;
runtime: PluginRuntime;
sessionEntries?: SessionCatalogEntrySnapshot;
}): SessionCatalogAgentEntry[];
declare function sessionCatalogAdoptedSourceKey(hostId: string, threadId: string): string;
declare function sessionCatalogAdoptedSessionKey(prefix: string, source: string): string;
declare function listAdoptedSessionCatalogSessions(params: {
agentId?: string;
config: OpenClawConfig;
pluginId: string;
runtime: PluginRuntime;
sessionEntries?: SessionCatalogEntrySnapshot;
sourceFromEntry: (entry: SessionEntry$1) => {
hostId: string;
threadId: string;
} | undefined;
}): Map<string, string>;
declare function createSessionCatalogAdoptionCoordinator<TResult extends {
sessionKey: string;
}>(): (params: {
sourceKey: string;
findExisting: () => string | undefined | Promise<string | undefined>;
create: () => Promise<{
sessionKey: string;
}>;
complete: (continued: {
sessionKey: string;
}) => Promise<TResult>;
}) => Promise<TResult>;
//#endregion
//#region src/sessions/session-upstream-links.kernel.d.ts
type SessionUpstreamLink = {
sessionKey: string;
agentId: string;
catalogId: string;
hostId: string;
threadId: string;
upstreamKind: SessionUpstreamKind;
upstreamRef: SessionUpstreamJsonValue;
marker: SessionUpstreamJsonValue | null;
lastScannedAt?: number;
createdAt: number;
updatedAt: number;
};
//#endregion
//#region src/sessions/send-policy.d.ts
/** Session send-policy decision after config and per-session overrides are evaluated. */
type SessionSendPolicyDecision = "allow" | "deny";
/** Resolves whether a session send is allowed by entry override and config rules. */
declare function resolveSendPolicy(params: {
cfg: OpenClawConfig;
entry?: SessionEntry$1;
sessionKey?: string;
channel?: string;
chatType?: SessionChatType;
}): SessionSendPolicyDecision;
//#endregion
//#region src/plugin-sdk/session-store-runtime.d.ts
type SessionStoreListParams = Partial<Omit<SessionStoreReadParams, "sessionKey">>;
type SessionStoreEntrySummary = {
sessionKey: string;
entry: SessionEntry$1;
};
type LoadSessionStoreOptions = {
skipCache?: boolean;
hydrateSkillPromptRefs?: boolean;
};
type UpdateSessionStoreOptions<T> = {
activeSessionKey?: string;
skipMaintenance?: boolean;
skipSaveWhenResult?: (result: T) => boolean;
};
type SessionStoreTranscriptEvent = SessionTranscriptEvent;
type SessionStoreEntryUpdate = (entry: SessionEntry$1) => Promise<Partial<SessionEntry$1> | null> | Partial<SessionEntry$1> | null;
type SessionStoreEntryPatch = (entry: SessionEntry$1, context: {
existingEntry?: SessionEntry$1;
}) => Promise<Partial<SessionEntry$1> | null> | Partial<SessionEntry$1> | null;
type PatchSessionEntryParams = SessionStoreReadParams & {
/** Synchronous final ownership check executed inside the commit transaction. */
assertCommitAllowed?: () => void;
fallbackEntry?: SessionEntry$1;
maintenanceConfig?: ResolvedSessionMaintenanceConfigInput;
preserveActivity?: boolean;
requireWriteSuccess?: boolean;
replaceEntry?: boolean;
skipMaintenance?: boolean;
update: SessionStoreEntryPatch;
};
type UpdateSessionStoreEntryParams = {
storePath: string;
sessionKey: string;
update: SessionStoreEntryUpdate;
skipMaintenance?: boolean;
takeCacheOwnership?: boolean;
requireWriteSuccess?: boolean;
};
type UpsertSessionEntryParams = SessionStoreReadParams & {
entry: SessionEntry$1;
};
type ReadAmbientTranscriptWatermarkParams = SessionStoreReadParams & {
key: string;
};
type DeleteSessionEntryParams = SessionStoreReadParams & {
archiveTranscript?: boolean;
expectedSessionId?: string | null;
expectedUpdatedAt?: number;
};
type SessionLifecycleArtifactsCleanupParams = {
agentId?: string;
archiveRemovedEntryTranscripts?: boolean;
env?: NodeJS.ProcessEnv;
orphanTranscriptMinAgeMs: number;
pluginOwnerId?: string;
sessionStore?: string;
sessionKeySegmentPrefix: string;
storePath?: string;
transcriptContentMarker: string;
nowMs?: number;
};
type SessionLifecycleArtifactsCleanupResult = {
archivedTranscriptArtifacts: number;
removedEntries: number;
};
/**
* @deprecated Use getSessionEntry or listSessionEntries.
*
* Official plugins released with v2026.7.1-beta.5 import this symbol. Keep the
* compatibility projection through 2026-10-12, then remove it only after the
* minimum supported plugin version excludes that release.
*/
declare function loadSessionStore(storePath: string, options?: LoadSessionStoreOptions): Record<string, SessionEntry$1>;
/**
* @deprecated Use patchSessionEntry, upsertSessionEntry, or deleteSessionEntry.
*
* Official plugins released with v2026.7.1-beta.5 import this symbol. Keep the
* compatibility bridge through 2026-10-12. The callback mutates a detached
* projection; the resulting row diff commits through the SQLite accessor.
* Beta.5 memory-core already uses cleanupSessionLifecycleArtifacts; this
* whole-store callback remains only for Feishu doctor's explicit repair flow.
*/
declare function updateSessionStore<T>(storePath: string, mutator: (store: Record<string, SessionEntry$1>) => Promise<T> | T, options?: UpdateSessionStoreOptions<T>): Promise<T>;
/**
* @deprecated Resolve transcript identities with loadTranscriptEventsSync.
*
* Beta.5 Feishu doctor still inspects JSONL paths synchronously. SQLite
* markers therefore materialize a bounded export at the canonical legacy path
* rather than making the old doctor classify every healthy transcript as
* missing. These files are durable because beta.5 renames repaired transcripts
* to recovery archives; remove this bridge only after beta.5 is unsupported.
*/
declare function resolveSessionFilePath(sessionId: string, entry?: {
sessionFile?: string;
}, options?: {
agentId?: string;
sessionsDir?: string;
}): string;
/**
* Resolves the configured session store path.
*
* Beta.5 resolves a configured path with an agent id, then passes only the
* path to loadSessionStore/updateSessionStore. Its shipped callers either
* consume the selection synchronously or dedupe by path, so retaining the
* latest selection preserves that bounded compatibility contract.
*/
declare function resolveStorePath(store?: string, options?: {
agentId?: string;
env?: NodeJS.ProcessEnv;
}): string;
/**
* @deprecated Use getSessionEntry with a storage-neutral session identity.
*
* Official plugins released with v2026.7.1-beta.5 import this whole-store
* lookup helper. Keep it through 2026-10-12 with the other beta.5 bridge.
*/
declare function resolveSessionStoreEntry(params: {
store: Record<string, SessionEntry$1>;
sessionKey: string;
}): {
normalizedKey: string;
existing: SessionEntry$1 | undefined;
legacyKeys: string[];
};
/** Loads one session entry by agent/session identity. */
declare function getSessionEntry(params: SessionStoreReadParams): SessionEntry$1 | undefined;
/** Reads the current session binding of one canonical transport address. */
declare function getConversationSession(params: {
agentId: string;
env?: NodeJS.ProcessEnv;
storePath?: string;
channel: string;
accountId: string;
kind: "channel" | "direct" | "group";
peerId: string;
threadId?: string;
}): {
sessionKey: string;
sessionId: string;
} | undefined;
/**
* Lists session entries for one agent. `readOnly` reads without joining the
* agent database writable lifecycle (no create/register/migrate) — required
* for detection/introspection paths that may run across the whole fleet.
* One flagged entry instead of a second export keeps the SDK surface budget flat.
*/
declare function listSessionEntries(params?: SessionStoreListParams & {
readOnly?: boolean;
}): SessionStoreEntrySummary[];
/** Reads transcript events for a live SQLite-backed session identity. */
declare const loadTranscriptEventsSync: (params: {
agentId?: string;
env?: NodeJS.ProcessEnv;
sessionId: string;
sessionKey?: string;
storePath?: string;
}) => SessionStoreTranscriptEvent[];
/** Reads transcript freshness and byte size without materializing event rows. */
declare const readTranscriptStatsSync: (params: {
agentId?: string;
env?: NodeJS.ProcessEnv;
sessionId: string;
sessionKey?: string;
storePath?: string;
}) => {
eventCount: number;
maxSeq: number;
sizeBytes: number;
};
/** Patches one session entry by agent/session identity. */
declare function patchSessionEntry(params: PatchSessionEntryParams): Promise<SessionEntry$1 | null>;
/** Reads the last activity timestamp for one session entry. */
declare function readSessionUpdatedAt(params: SessionStoreReadParams): number | undefined;
declare function readAmbientTranscriptWatermark(params: ReadAmbientTranscriptWatermarkParams): AmbientTranscriptWatermark | undefined;
/** Updates an existing session entry by store path and session key. */
declare function updateSessionStoreEntry(params: UpdateSessionStoreEntryParams): Promise<SessionEntry$1 | null>;
/** Replaces or creates one session entry by agent/session identity. */
declare function upsertSessionEntry(params: UpsertSessionEntryParams): Promise<void>;
/** Deletes one session entry by agent/session identity. */
declare function deleteSessionEntry(params: DeleteSessionEntryParams): Promise<boolean>;
/** Resolves the file artifacts that should be backed up before mutating a session store. */
declare function resolveSessionStoreBackupPaths(params: {
agentId?: string;
storePath: string;
}): string[];
/** Cleans stale lifecycle-owned session entries and orphan transcripts for one agent store. */
declare function cleanupSessionLifecycleArtifacts(params: SessionLifecycleArtifactsCleanupParams): Promise<SessionLifecycleArtifactsCleanupResult>;
//#endregion
//#region src/agents/sticky-model-selection.d.ts
type StickyModelSelectionDispatchOutcome = "requested" | "skipped-immutable";
//#endregion
//#region src/plugins/host-hooks.d.ts
/** Reason passed to plugin cleanup callbacks when host-owned state changes. */
type PluginHostCleanupReason = "disable" | "reset" | "delete" | "restart";
type PluginSessionExtensionProjectionContext = {
sessionKey: string;
sessionId?: string;
state: PluginJsonValue | undefined;
};
/** Session extension registration owned by a plugin namespace. */
type PluginSessionExtensionRegistration = {
namespace: string;
description: string;
project?: (ctx: PluginSessionExtensionProjectionContext) => PluginJsonValue | undefined;
cleanup?: (ctx: {
reason: PluginHostCleanupReason;
sessionKey?: string;
}) => void | Promise<void>;
/**
* When set, after every successful `patchSessionExtension` the projected
* value is mirrored to `SessionEntry[<slotKey>]` so non-plugin readers
* can consume the typed slot without reaching into
* `pluginExtensions[pluginId][namespace]`.
*
* The slot is a read-only mirror: writes always go through
* `patchSessionExtension`; the host overwrites the slot value on every
* subsequent patch.
*/
sessionEntrySlotKey?: string;
/**
* Optional JSON-compatible schema describing the projected slot value.
* Purely informational at this layer; clients may use it to validate the
* mirrored slot against a contract.
*/
sessionEntrySlotSchema?: PluginJsonValue;
};
type PluginSessionExtensionProjection = {
pluginId: string;
namespace: string;
value: PluginJsonValue;
};
type PluginToolPolicyDecision = PluginHookBeforeToolCallResult | {
allow?: boolean;
reason?: string;
};
type PluginTrustedToolPolicyRegistration = {
id: string;
description: string;
matcher?: PluginToolMatcher;
evaluate: (event: PluginHookBeforeToolCallEvent, ctx: PluginHookToolContext) => PluginToolPolicyDecision | void | Promise<PluginToolPolicyDecision | void>;
};
type PluginToolMetadataRegistration = {
toolName: string;
displayName?: string;
description?: string;
risk?: "low" | "medium" | "high";
tags?: string[];
};
type PluginControlUiTabGroup = "control" | "agent";
type PluginControlUiDescriptor = {
id: string;
/** "tab" adds a sidebar tab; "widget" advertises a trusted dashboard renderer. */
surface: "session" | "tool" | "run" | "settings" | "tab" | "widget" | "link-reader";
/** Required for link-reader surfaces; passive models rendered by the host, never plugin JS. */
linkReader?: ControlUiLinkReaderMetadata;
label: string;
description?: string;
/** Bundled plugins may claim their matching native route as `route:<pluginId>`. */
placement?: string;
/** Optional single-segment Control UI address for a tab; does not register an HTTP route. */
slug?: string;
schema?: PluginJsonValue;
requiredScopes?: OperatorScope[];
/** Icon name hint for tab descriptors; unknown names fall back to a generic icon. */
icon?: string;
/**
* Gateway HTTP path (e.g. /plugins/<id>/panel) rendered in a sandboxed frame
* when the Control UI has no bundled view for this tab.
*/
path?: string;
/** Sidebar group for tab descriptors; defaults to "control". */
group?: PluginControlUiTabGroup;
/** Sort order among plugin tabs; lower renders first. */
order?: number;
};
type PluginSessionActionContext = {
pluginId: string;
actionId: string;
sessionKey?: string;
agentId?: string;
payload?: PluginJsonValue;
client?: {
connId?: string;
scopes: string[];
};
};
type PluginSessionActionResult = {
ok?: true;
result?: PluginJsonValue;
reply?: PluginJsonValue;
continueAgent?: boolean;
} | {
ok: false;
error: string;
code?: string;
details?: PluginJsonValue;
};
type PluginSessionActionRegistration = {
id: string;
description?: string;
schema?: PluginJsonValue;
requiredScopes?: OperatorScope[];
handler: (ctx: PluginSessionActionContext) => PluginSessionActionResult | void | Promise<PluginSessionActionResult | void>;
};
type PluginRuntimeLifecycleRegistration = {
id: string;
description?: string;
/**
* Releases this registration's resources after an owned inspection or ephemeral prepared runtime.
* Raw loaders do not invoke this callback. Host cleanup notifications stay separate.
*/
dispose?: () => void | Promise<void>;
cleanup?: (ctx: {
reason: PluginHostCleanupReason;
sessionKey?: string;
runId?: string;
}) => void | Promise<void>;
};
type PluginAgentEventSubscriptionRegistration = {
id: string;
description?: string;
streams?: AgentEventStream[];
handle: (event: AgentEventPayload, ctx: {
getRunContext: <T extends PluginJsonValue = PluginJsonValue>(namespace: string) => T | undefined;
setRunContext: (namespace: string, value: PluginJsonValue) => void;
clearRunContext: (namespace?: string) => void;
}) => void | Promise<void>;
};
type PluginAgentEventEmitParams = {
runId: string;
stream: AgentEventStream;
data: PluginJsonValue;
sessionKey?: string;
};
type PluginAgentEventEmitResult = {
emitted: true;
stream: AgentEventStream;
} | {
emitted: false;
reason: string;
};
type PluginRunContextPatch = {
runId: string;
namespace: string;
value?: PluginJsonValue;
unset?: boolean;
};
type PluginRunContextGetParams = {
runId: string;
namespace: string;
};
type PluginSessionSchedulerJobRegistration = {
id: string;
sessionKey: string;
kind: string;
description?: string;
cleanup?: (ctx: {
reason: PluginHostCleanupReason;
sessionKey: string;
jobId: string;
}) => void | Promise<void>;
};
type PluginSessionSchedulerJobHandle = {
id: string;
pluginId: string;
sessionKey: string;
kind: string;
};
type PluginSessionAttachmentFile = {
path: string;
};
type PluginAttachmentChannelHints = {
parseMode?: "HTML";
silent?: boolean;
/** Require host detection to match this MIME before forcing document delivery. */
forceDocumentMime?: string;
threadId?: string | number;
/** @deprecated Put portable attachment hints directly on `channelHints`. */
telegram?: {
parseMode?: "HTML";
disableNotification?: boolean;
/**
* Require host-side detection to match this MIME before forcing document delivery.
* Mismatched files are rejected before the outbound adapter is called.
*/
forceDocumentMime?: string;
};
/** @deprecated Use `channelHints.threadId`. */
slack?: {
threadTs?: string;
};
};
type PluginSessionAttachmentCaptionFormat = "plain" | "html" | "markdown";
type PluginSessionAttachmentParams = {
sessionKey: string;
files: PluginSessionAttachmentFile[];
text?: string;
threadId?: string | number;
forceDocument?: boolean;
maxBytes?: number;
captionFormat?: PluginSessionAttachmentCaptionFormat;
channelHints?: PluginAttachmentChannelHints;
};
type PluginSessionAttachmentResult = {
ok: true;
channel: string;
deliveredTo: string;
count: number;
} | {
ok: false;
error: string;
};
type PluginSessionTurnScheduleCommonParams = {
sessionKey: string;
message: string;
agentId?: string;
deliveryMode?: "none" | "announce";
name?: string;
/** Optional cleanup tag. Reserved cron-name delimiters like `:` are rejected. */
tag?: string;
};
type PluginSessionTurnScheduleParams = ({
at: string | number | Date;
deleteAfterRun?: boolean;
} & PluginSessionTurnScheduleCommonParams) | ({
delayMs: number;
deleteAfterRun?: boolean;
} & PluginSessionTurnScheduleCommonParams) | ({
cron: string;
tz?: string;
deleteAfterRun?: false;
} & PluginSessionTurnScheduleCommonParams);
type PluginSessionTurnUnscheduleByTagParams = {
sessionKey: string;
tag: string;
};
type PluginSessionTurnUnscheduleByTagResult = {
removed: number;
failed: number;
};
//#endregion
//#region src/shared/fast-mode.d.ts
type FastModeSource = "session" | "agent" | "config" | "default";
type FastModeAutoProgressState = {
offAnnounced: boolean;
resetAnnounced: boolean;
};
declare function resolveFastModeForElapsed(params: {
mode?: FastMode;
startedAtMs: number;
fastAutoOnSeconds?: number;
nowMs?: number;
}): {
mode: FastMode | undefined;
enabled: boolean;
elapsedSeconds: number;
fastAutoOnSeconds: number;
};
declare function formatFastModeAutoProgressText(params: {
enabled: boolean;
elapsedSeconds: number;
fastAutoOnSeconds?: number;
}): string;
declare function formatFastModeStatusValue(params: {
mode: FastMode | undefined;
fastAutoOnSeconds?: number;
}): string;
declare function formatFastModeCommandOptions(params?: {
fastAutoOnSeconds?: number;
}): string;
declare function formatFastModeSourceSuffix(source: FastModeSource | undefined): string;
declare function formatFastModeCurrentStatus(params: {
mode: FastMode | undefined;
source?: FastModeSource;
fastAutoOnSeconds?: number;
label?: string;
}): string;
//#endregion
//#region src/gateway/server-model-catalog.types.d.ts
/** Catalog entries and policy come from the same completed prepared generation. */
type PreparedGatewayModelCatalog = {
entries: ModelCatalogEntry[];
routeVariants?: ModelCatalogEntry[];
pluginRegistry?: ProviderThinkingRegistry;
};
type PreparedGatewayModelCatalogReadResult = PromiseSettledResult<PreparedGatewayModelCatalog | undefined>;
type GatewayModelCatalogSnapshot = ModelCatalogSnapshot & {
agentId: string;
agentDir: string;
catalogComplete: boolean;
workspaceDir: string;
config: OpenClawConfig;
};
//#endregion
//#region src/infra/agent-activity-events.d.ts
type AgentItemEventStatus = NonNullable<AgentActivityItem["status"]>;
/** Live producers retain a known status and may attach additional telemetry. */
type AgentItemEventData = AgentActivityItem & Record<string, unknown> & {
status: AgentItemEventStatus;
};
/** Incremental command output payload associated with an item/tool call. */
type AgentCommandOutputEventFields = {
itemId: string;
phase: "delta" | "end";
title: string;
toolCallId: string;
name?: string;
output?: string;
status?: AgentItemEventStatus | "running";
exitCode?: number | null;
durationMs?: number;
cwd?: string;
};
type ToolActivityInput = {
toolCallId: string;
name: string;
phase: "start" | "update" | "result";
args?: unknown;
result?: unknown;
meta?: string;
status?: AgentItemEventStatus | "unknown";
isError?: boolean;
hideFromChannelProgress?: boolean;
nativeOperation?: "wait" | "process.poll";
};
declare function projectAgentToolActivity(tool: ToolActivityInput & ({
phase: "start" | "update";
} | {
status: AgentItemEventStatus;
})): AgentItemEventData;
declare function projectAgentToolActivity(tool: ToolActivityInput): AgentActivityItem;
//#endregion
//#region src/config/sessions/session-transcript-worker.types.d.ts
type PreparedSessionTranscriptHydration = {
kind: "full";
snapshot: ReturnType<typeof loadTranscriptReadSnapshotSync>;
} | {
kind: "bounded";
snapshot: SessionTranscriptBoundedActiveContext;
};
//#endregion
//#region src/gateway/session-activity-summary-state.d.ts
type ActivitySummaryTarget = {
key: string;
agentId: string;
};
//#endregion
//#region src/agents/agent-run-terminal-reply.types.d.ts
type AgentRunTerminalReplySnapshot = {
disposition: "visible";
text: string;
modelRouteChange?: string;
} | {
disposition: "silent";
} | {
disposition: "empty";
code?: "message-tool-not-called";
};
//#endregion
//#region src/gateway/agent-event-assistant-text.d.ts
type AssistantTextInput = {
text?: string;
delta?: string;
itemId?: string;
replace?: boolean;
replaceable?: boolean;
managedMediaUrls?: string[];
};
type AssistantTextSnapshot = {
text: string;
scope?: {
itemId: string;
prefix: string;
boundaryNewlines: number;
separatorLength: number;
};
};
type AssistantTextMerge = AssistantTextSnapshot & {
/** Present only when this merge proves an append to its input snapshot. */
appendedText?: string;
};
/** Merge item snapshots without imposing a transport's display or wire limit. */
declare function mergeAssistantText(previous: AssistantTextSnapshot, input: AssistantTextInput, unkeyed: "live" | "append-only"): AssistantTextMerge;
//#endregion
//#region src/chat/canvas-render.d.ts
type CanvasSurface = "assistant_message" | "node_panel";
type CanvasSandbox = "strict" | "scripts";
type McpAppPreviewDescriptor = {
viewId: string;
serverName?: string;
toolName?: string;
uiResourceUri?: string;
toolCallId?: string;
originSessionKey?: string;
resultMetaState?: "unavailable";
};
type CanvasPreview = {
kind: "canvas";
surface: CanvasSurface;
render: "url";
title?: string;
preferredHeight?: number;
url?: string;
viewId?: string;
className?: string;
style?: string;
sandbox?: CanvasSandbox;
boardWidgetName?: string;
mcpApp?: McpAppPreviewDescriptor;
};
/** Extracts a canvas preview from a JSON-shaped tool or assistant payload. */
declare function extractCanvasFromText(outputText: string | undefined, _toolName?: string): CanvasPreview | undefined;
//#endregion
//#region src/gateway/chat-display-projection.canvas.d.ts
type ChatCanvasPreview = {
preview: NonNullable<ReturnType<typeof extractCanvasFromText>>;
rawText: string | null;
};
type ChatCanvasBlock = ChatCanvasPreview & {
type: "canvas";
};
//#endregion
//#region src/gateway/live-chat-projector.d.ts
/** One run-owned display chain; replacements rebuild every syntax and visibility probe. */
declare function createLiveAssistantTextProjection(options?: {
managedMediaUrls?: readonly string[];
final?: boolean;
}): {
readonly source: string;
append: (delta: string, preparedSource?: string) => {
text: string;
delta: string | null;
suppress: boolean;
pendingLeadFragment: boolean;
};
replace: (text: string) => {
text: string;
delta: string | null;
suppress: boolean;
pendingLeadFragment: boolean;
};
};
//#endregion
//#region src/gateway/server-chat-progress-snapshot.d.ts
type ChatRunProgressSnapshot = {
events: AgentEventPayload[];
byteLength: number;
lastSeq: number;
};
//#endregion
//#region src/gateway/server-chat-state.d.ts
type ChatRunTiming = {
ackedAtMs: number;
connId: string;
dispatchStartedAtMs?: number;
firstAssistantEventSent?: boolean;
receivedAtMs: number;
};
type ChatRunRegistration = {
sessionKey: string;
agentId?: string;
clientRunId: string;
chatSendTiming?: ChatRunTiming;
};
type ChatRunEntry = ChatRunRegistration & {
registeredSequence: number;
};
type ChatAbortMarker = {
abortedAtMs: number;
sequence: number;
};
type BufferedAgentEvent = {
sessionKey?: string;
agentId?: string;
controlUiVisible?: boolean;
isCurrent?: () => boolean;
payload: AgentEventPayload & {
spawnedBy?: string;
};
};
type ChatRunPlanSnapshot = {
steps: AgentPlanStep[];
explanation?: string;
};
type ChatRunAgentTextState = {
lastSentAt?: number;
bufferedEvent?: BufferedAgentEvent;
snapshot?: {
text: string;
itemId?: string;
};
};
type ChatRunToolRecipientState = {
connIds: Set<string>;
updatedAt: number;
finalizedAt?: number;
};
type PendingLiveTextFlush = {
timer: NodeJS.Timeout;
flush: () => void;
};
type LiveDisplayState = {
projector: ReturnType<typeof createLiveAssistantTextProjection>;
current: ReturnType<ReturnType<typeof createLiveAssistantTextProjection>["replace"]>;
pendingRawDelta?: string | null;
reset?: boolean;
unsentDelta: string | null;
sentText?: string;
};
type ChatRunRecord = {
lastActivityAt: number;
registrations?: ChatRunEntry[];
rawBuffer?: string;
buffer?: string;
bufferIsCurrent?: () => boolean;
/** Retire queued connection snapshots when this buffering generation is cleared. */
liveTextGroup?: AbortController;
liveTextEpoch?: object;
display?: LiveDisplayState;
planSnapshot?: ChatRunPlanSnapshot;
progressSnapshot?: ChatRunProgressSnapshot;
canvasBlocks?: ChatCanvasBlock[];
deltaSentAt?: number;
assistantScope?: AssistantTextSnapshot["scope"];
managedMediaUrls?: Set<string>;
agentText?: Partial<Record<"assistant" | "thinking" | "preamble" | "answer_candidate", ChatRunAgentTextState>>;
abortMarker?: ChatAbortMarker;
toolRecipient?: ChatRunToolRecipientState;
/** Fixed-deadline trailing wake-up owned by this run's buffered state. */
pendingTextFlushes?: Partial<Record<"chat" | "agent", PendingLiveTextFlush>>;
};
type ChatRunRegistry = {
add: (sessionId: string, entry: ChatRunRegistration) => void;
peek: (sessionId: string) => ChatRunEntry | undefined;
shift: (sessionId: string) => ChatRunEntry | undefined;
remove: (sessionId: string, clientRunId: string, sessionKey?: string) => ChatRunEntry | undefined;
};
type ChatRunState = {
runs: Map<string, ChatRunRecord>;
registry: ChatRunRegistry;
toolEventRecipients: ToolEventRecipientRegistry;
/** Acquire mutable state and record activity; readers use runs.get. */
getOrCreate: (runId: string) => ChatRunRecord;
resolveBuffer: (runId: string, options?: {
final?: boolean;
}) => {
text: string;
suppress: boolean;
};
updateBuffer: (runId: string, input: Parameters<typeof mergeAssistantText>[1]) => string;
takeBufferDelta: (runId: string, text: string) => {
deltaText: string;
replace?: true;
} | undefined;
flushPendingText: (runId: string) => void;
hasAbortMarker: (runId: string) => boolean;
deleteAbortMarker: (runId: string) => void;
recordProgressEvent: (runId: string, event: AgentEventPayload, mode?: "full" | "summary") => void;
clearRun: (runId: string) => void;
clear: () => void;
};
type ToolEventRecipientRegistry = {
add: (runId: string, connId: string) => void;
get: (runId: string) => ReadonlySet<string> | undefined;
markFinal: (runId: string) => void;
pruneExpired: (now?: number) => void;
};
type SessionMessageSubscriberRegistry = {
subscribe: (connId: string, sessionKey: string, opts?: {
includeApprovals?: boolean;
provisional?: boolean;
mode?: "narration";
subscriptionId?: string;
}) => SessionMessageSubscription | undefined;
unsubscribe: (connId: string, sessionKey: string, subscriptionId?: string) => void;
unsubscribeAll: (connId: string) => void;
get: (sessionKey: string) => ReadonlySet<string>;
getApprovals: (sessionKey: string) => ReadonlySet<string>;
getNarration: (sessionKey: string) => ReadonlySet<string>;
onChange: (listener: (sessionKey: string, connId: string) => void) => () => void;
};
type SessionMessageSubscription = (() => void) & {
commit: () => void;
};
//#endregion
//#region src/agents/model-catalog-lookup.d.ts
type ModelThinkingCompat = {
thinkingFormat?: ModelCompatConfig["thinkingFormat"];
supportedReasoningEfforts?: readonly string[] | null;
};
type PreparedModelThinkingCapability = Readonly<{
provider: string;
modelId: string;
agentRuntime: string;
/** Present only when the capability came from a physical provider route. */
route?: Readonly<{
api: string;
baseUrl: string;
}>;
compat: ModelThinkingCompat;
}>;
/** Prefers canonical identity; the shipped SDK's case-insensitive fallback must be unique. */
declare function findModelInCatalog<T extends Pick<ModelCatalogEntry, "provider" | "id">>(catalog: readonly T[], provider: string, modelId: string): T | undefined;
//#endregion
//#region src/plugin-sdk/provider-model-types.d.ts
/** Private selected-request facts; omission means the host cannot establish applicability. */
type ProviderFastModePolicyContext = {
provider: string;
modelId: string;
api?: string;
baseUrl?: string;
authMode?: string;
runtimeId?: string;
modelParams?: Record<string, unknown>;
params?: Record<string, unknown>;
requestCapabilities: {
endpointClass: string;
allowsAnthropicServiceTier: boolean;
};
};
type ProviderModelRouteSource = {
api?: ModelApi | null;
baseUrl?: unknown;
};
/** A concrete provider route. Order expresses provider default, never credential precedence. */
type ProviderModelRouteAuthRequirement = "api-key" | "subscription";
type ProviderRouteOverridePresence = "none" | "present";
type ProviderModelRouteRuntimePolicy = {
/** Agent runtime ids that can reproduce this route without losing transport behavior. */
compatibleIds: readonly string[];
};
type ProviderResolveModelRoutesContext = {
provider: string;
modelId?: string;
/** Effective secret-free request behavior for this provider/model pair. */
requestTransportOverrides?: ProviderRouteOverridePresence;
configuredModel?: ProviderModelRouteSource;
configuredProvider?: ProviderModelRouteSource;
/** Prepared consumer intent; credentials and runtime compatibility remain independently owned. */
routeIntent?: {
runtimeId?: string;
authRequirement?: ProviderModelRouteAuthRequirement;
source: "explicit" | "inherited";
};
/** Environment view; the provider owns interpretation of its variables. */
env?: Readonly<Record<string, string | undefined>>;
/** Physical route facts for one logical model; input order is not preference. */
observedRoutes?: readonly ProviderModelRouteSource[];
};
/** Provider-owned default for one resolved inference route; never an authored config setting. */
type ProviderToolSearchPolicyContext = {
provider: string;
modelId: string;
api: string;
baseUrl?: string;
};
//#endregion
//#region src/agents/agent-auth-credential-modes.d.ts
/** Secret-free credential modes captured by a prepared agent runtime. */
type PreparedAgentCredentialMode = "api_key" | "oauth" | "token" | Readonly<{
source: "native";
mode: "api_key" | "oauth" | "token";
}>;
type PreparedAgentCredentialModes = Readonly<Record<string, PreparedAgentCredentialMode>>;
//#endregion
//#region src/agents/provider-model-auth-source-plan.d.ts
type ProviderModelAuthEvidence = "aws-sdk" | "environment" | "none" | "profile" | "provider-config" | "runtime" | "synthetic";
/**
* Whether config authorizes this credential, as opposed to where it was found.
*
* `evidence` is provenance and is reported as such by status/probe surfaces; it
* cannot carry authorization, because a *declared* credential can legitimately
* be discovered in the environment (a `${VAR}` marker or a SecretRef naming a
* canonical variable). `"ambient"` means the opposite: the credential appears in
* neither the provider entry nor `auth.profiles`/`auth.order`, so nothing in
* config points at it and it may bill an account the operator never named here.
*/
type ProviderModelAuthAuthorization = "declared" | "ambient";
/** Secret-free credential-source fact safe to carry across request boundaries. */
type ProviderModelAuthSourceClassification = {
kind: "profile";
} | {
kind: "direct";
evidence: ProviderModelAuthEvidence;
authorization: ProviderModelAuthAuthorization;
};
//#endregion
//#region src/agents/session-model-ref.d.ts
type SessionModelEntry = SessionEntry$1 | Pick<SessionEntry$1, "model" | "modelProvider" | "modelOverride" | "providerOverride" | "modelOverrideRouteResolution" | "modelOverrideFallbackOriginProvider" | "modelOverrideFallbackOriginModel">;
/** Keep prepared host metadata outside the published session-model resolver contract. */
declare function resolveSessionModelRef(cfg: OpenClawConfig, entry?: SessionModelEntry, agentId?: string, options?: {
allowPluginNormalization?: boolean;
}): {
provider: string;
model: string;
};
//#endregion
//#region src/agents/run-session-target.types.d.ts
/** Identifies a run transcript target without naming the current storage artifact. */
type AgentRunSessionTarget = {
agentId?: string;
sessionId?: string;
sessionKey?: string;
storePath?: string;
threadId?: string | number;
/** Internal admission fence paired with sessionId for run-owned transcript writes. */
expectedLifecycleRevision?: string;
/** Internal durable writer claim installed after session-lane admission. */
expectedWriterRunId?: string;
};
type BoundAgentRunSessionTarget = Required<Pick<AgentRunSessionTarget, "agentId" | "sessionId" | "sessionKey" | "storePath">> & Pick<AgentRunSessionTarget, "expectedLifecycleRevision" | "expectedWriterRunId">;
//#endregion
//#region src/gateway/worker-environments/placement-projector.d.ts
type WorkerSessionPlacementReader = {
getMany(sessionIds: readonly string[]): ReadonlyMap<string, WorkerSessionPlacementRecord>;
getWorkspaceResultReconcilingSessionIds?(sessionIds: readonly string[]): ReadonlySet<string>;
listPendingWorkspaceResults?(sessionId?: string): WorkerWorkspacePendingResult[];
/** Runtime consumers may cancel work when the exact captured turn claim closes. */
registerTurnClaimClosedHandler?: (handler: (claim: WorkerSessionTurnClaim) => void) => () => void;
};
type WorkerPlacementDiskSpaceReader = {
read(record: WorkerSessionPlacementRecord): SessionPlacementDiskSpace | undefined;
version(): number;
};
type WorkerPlacementRunnerAvailabilityReader = {
read(record: WorkerSessionPlacementRecord, environment?: Pick<WorkerEnvironmentPlacementFacts, "providerId" | "state" | "ownerEpoch" | "attachedSessionIds" | "nodeDeviceId"> | null): SessionPlacementRunner | undefined;
version(): number;
};
type WorkerPlacementRuntimeInstallReader = {
read(record: WorkerSessionPlacementRecord, environment?: Pick<WorkerEnvironmentPlacementFacts, "nodeDeviceId"> | null): SessionPlacementWorkerRuntimeInstall | undefined;
version(): number;
};
//#endregion
//#region src/sessions/stored-model-overrides.d.ts
/** Model override loaded from the current session or its parent session. */
type StoredModelOverride = {
provider?: string;
model: string;
source: "session" | "parent";
routeResolution: ModelFallbackRouteResolution;
};
/** Keep prepared host metadata outside the published command resolver contract. */
declare function resolveStoredModelOverride(params: {
loadSessionEntry?: (sessionKey: string) => SessionEntry$1 | undefined;
sessionEntry?: SessionEntry$1;
sessionStore?: Record<string, SessionEntry$1>;
sessionKey?: string;
parentSessionKey?: string;
defaultProvider: string;
allowPluginNormalization?: boolean;
}): StoredModelOverride | null;
//#endregion
//#region src/agents/sessions/event-bus.d.ts
/** Minimal publish/subscribe interface used by session components. */
interface EventBus {
emit(channel: string, data: unknown): void;
on(channel: string, handler: (data: unknown) => void): () => void;
}
//#endregion
//#region src/llm/stream.d.ts
declare function completeSimple<TApi extends Api>(model: Model<TApi>, context: Context, options?: SimpleStreamOptions, assertCurrent?: () => void): Promise<AssistantMessage$1>;
//#endregion
//#region src/plugin-sdk/provider-oauth-runtime.d.ts
/** Normalized OAuth credential bundle persisted by provider auth profiles. */
type OAuthCredentials = {
/** Refresh token or provider-equivalent long-lived credential. */
refresh: string;
/** Access token or provider-equivalent bearer credential. */
access: string;
/** Absolute epoch milliseconds when the access token should be considered expired. */
expires: number;
[key: string]: unknown;
};
/** Stable provider id used by OAuth credential and config routing. */
type OAuthProviderId = string;
/** Manual input prompt shown during OAuth login flows. */
type OAuthPrompt$1 = {
/** Prompt text shown to the operator. */
message: string;
/** Optional placeholder for manual text entry. */
placeholder?: string;
/** Whether empty input should be accepted instead of reprompting. */
allowEmpty?: boolean;
};
/** Authorization URL and optional instructions shown before OAuth completion. */
type OAuthAuthInfo = {
/** Provider authorization URL shown to the user. */
url: string;
/** Optional provider-specific instruction text for manual flows. */
instructions?: string;
};
/** One selectable OAuth login option. */
type OAuthSelectOption = {
/** Stable option id returned when the operator selects this entry. */
id: string;
/** Human-readable option label shown in the selector. */
label: string;
};
/** Selector prompt used when a provider offers multiple OAuth login choices. */
type OAuthSelectPrompt = {
/** Prompt text shown above the selectable options. */
message: string;
/** Options available for the operator to choose from. */
options: OAuthSelectOption[];
};
/** UI/runtime callbacks used by provider OAuth login implementations. */
interface OAuthLoginCallbacks$1 {
/** Emits authorization URL/instructions to the UI before waiting for completion. */
onAuth: (info: OAuthAuthInfo) => void;
/** Prompts for manual input such as pasted callback URLs or authorization codes. */
onPrompt: (prompt: OAuthPrompt$1) => Promise<string>;
/** Reports human-readable login progress without exposing secrets. */
onProgress?: (message: string) => void;
/** Optional direct manual-code entry hook used when callback-server flows cannot complete. */
onManualCodeInput?: () => Promise<string>;
/** Show an interactive selector and return the selected option id, or undefined on cancel. */
onSelect?: (prompt: OAuthSelectPrompt) => Promise<string | undefined>;
/** Cancels pending OAuth waits and prompts when aborted. */
signal?: AbortSignal;
}
/** Provider OAuth contract implemented by provider plugins. */
interface OAuthProviderInterface {
/** Stable provider id used for credential and config routing. */
readonly id: OAuthProviderId;
/** Human-readable provider name shown in login flows. */
readonly name: string;
/** Run the login flow and return credentials to persist. */
login(callbacks: OAuthLoginCallbacks$1): Promise<OAuthCredentials>;
/** Whether login uses a local callback server and supports manual code input. */
usesCallbackServer?: boolean;
/** Refresh expired credentials and return updated credentials to persist. */
refreshToken(credentials: OAuthCredentials): Promise<OAuthCredentials>;
/** Convert credentials to an API key string for the provider. */
getApiKey(credentials: OAuthCredentials): string;
/** Optionally adjust models for this provider, such as updating baseUrl. */
modifyModels?(models: Model[], credentials: OAuthCredentials): Model[];
}
//#endregion
//#region src/agents/modes/interactive/theme/theme.d.ts
declare const ThemeJsonSchema: Type$1.TObject<{
$schema: Type$1.TOptional<Type$1.TString>;
name: Type$1.TString;
vars: Type$1.TOptional<Type$1.TRecord<"^.*$", Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>>>;
colors: Type$1.TObject<{
accent: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
border: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
borderAccent: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
borderMuted: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
success: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
error: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
warning: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
muted: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
dim: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
text: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
thinkingText: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
selectedBg: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
userMessageBg: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
userMessageText: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
customMessageBg: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
customMessageText: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
customMessageLabel: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
toolPendingBg: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
toolSuccessBg: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
toolErrorBg: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
toolTitle: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
toolOutput: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
mdHeading: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
mdLink: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
mdLinkUrl: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
mdCode: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
mdCodeBlock: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
mdCodeBlockBorder: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
mdQuote: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
mdQuoteBorder: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
mdHr: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
mdListBullet: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
toolDiffAdded: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
toolDiffRemoved: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
toolDiffContext: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
syntaxComment: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
syntaxKeyword: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
syntaxFunction: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
syntaxVariable: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
syntaxString: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
syntaxNumber: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
syntaxType: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
syntaxOperator: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
syntaxPunctuation: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
thinkingOff: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
thinkingMinimal: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
thinkingLow: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
thinkingMedium: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
thinkingHigh: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
thinkingXhigh: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
bashMode: Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>;
}>;
export: Type$1.TOptional<Type$1.TObject<{
pageBg: Type$1.TOptional<Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>>;
cardBg: Type$1.TOptional<Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>>;
infoBg: Type$1.TOptional<Type$1.TUnion<[Type$1.TString, Type$1.TInteger]>>;
}>>;
}>;
type ThemeJson = Static<typeof ThemeJsonSchema>;
type ThemeColor = Exclude<keyof ThemeJson["colors"], ThemeBg>;
type ThemeBg = "selectedBg" | "userMessageBg" | "customMessageBg" | "toolPendingBg" | "toolSuccessBg" | "toolErrorBg";
type ColorMode = "truecolor" | "256color";
declare class Theme {
readonly name?: string;
readonly sourcePath?: string;
sourceInfo?: SourceInfo;
private fgColors;
private bgColors;
private mode;
constructor(fgColors: Record<ThemeColor, string | number>, bgColors: Record<ThemeBg, string | number>, mode: ColorMode, options?: {
name?: string;
sourcePath?: string;
sourceInfo?: SourceInfo;
});
fg(color: ThemeColor, text: string): string;
bg(color: ThemeBg, text: string): string;
bold(text: string): string;
italic(text: string): string;
underline(text: string): string;
inverse(text: string): string;
strikethrough(text: string): string;
getFgAnsi(color: ThemeColor): string;
getBgAnsi(color: ThemeBg): string;
getColorMode(): ColorMode;
getThinkingBorderColor(level: "off" | "minimal" | "low" | "medium" | "high" | "xhigh"): (str: string) => string;
getBashModeBorderColor(): (str: string) => string;
}
//#endregion
//#region src/agents/sessions/tools/bash-operations.d.ts
/**
* Minimal shell execution interface injected into bash session tools.
*/
interface BashOperations {
exec: (command: string, cwd: string, options: {
/**
* stdout and stderr are independent pipes, so each needs its own decode
* state; tag chunks to keep them apart. Untagged chunks share one lane,
* preserving behavior for operations that cannot distinguish streams.
*/
onData: (data: Buffer, stream?: "stdout" | "stderr") => void;
signal?: AbortSignal;
timeout?: number;
env?: NodeJS.ProcessEnv;
}) => Promise<{
exitCode: number | null;
}>;
}
//#endregion
//#region src/agents/sessions/bash-executor.d.ts
interface BashResult {
/** Combined stdout + stderr output (sanitized, possibly truncated) */
output: string;
/** Process exit code (undefined if killed/cancelled) */
exitCode: number | undefined;
/** Whether the command was cancelled via signal */
cancelled: boolean;
/** Whether the output was truncated */
truncated: boolean;
/** Path to temp file containing full output (if output exceeded truncation threshold) */
fullOutputPath?: string;
}
//#endregion
//#region src/agents/sessions/exec.d.ts
interface ExecOptions {
/** AbortSignal to cancel the command */
signal?: AbortSignal;
/** Timeout in milliseconds */
timeout?: number;
/** Working directory */
cwd?: string;
/** Optional maximum retained stdout/stderr characters per stream. */
maxOutputChars?: number;
}
interface ExecResult {
stdout: string;
stderr: string;
stdoutTruncatedChars?: number;
stderrTruncatedChars?: number;
outputLimitExceeded?: "stdout" | "stderr";
code: number;
killed: boolean;
}
//#endregion
//#region src/agents/sessions/footer-data-provider.d.ts
/** Read-only footer data supplied to session extensions. */
interface ReadonlyFooterDataProvider {
/** Current git branch, null if not in repo, "detached" if detached HEAD */
getGitBranch(): string | null;
/** Extension status texts set via ctx.ui.setStatus() */
getExtensionStatuses(): ReadonlyMap<string, string>;
/** Number of unique providers with available models (for footer display) */
getAvailableProviderCount(): number;
/** Subscribe to git branch changes. Returns unsubscribe function. */
onBranchChange(callback: () => void): () => void;
}
//#endregion
//#region src/agents/sessions/keybindings.d.ts
/** OpenClaw-specific key ids added to the shared pi-tui keybinding registry. */
type AppKeybindings = Record<Exclude<keyof typeof KEYBINDINGS, keyof typeof TUI_KEYBINDINGS>, true>;
declare module "@earendil-works/pi-tui" {
interface Keybindings extends AppKeybindings {}
}
/** Complete keybinding definition map consumed by the TUI keybinding manager. */
declare const KEYBINDINGS: {
readonly "tui.editor.cursorUp": {
readonly defaultKeys: "up";
readonly description: "Move cursor up";
};
readonly "tui.editor.cursorDown": {
readonly defaultKeys: "down";
readonly description: "Move cursor down";
};
readonly "tui.editor.historyPrevious": {
readonly defaultKeys: [];
readonly description: "Select previous prompt history entry";
};
readonly "tui.editor.historyNext": {
readonly defaultKeys: [];
readonly description: "Select next prompt history entry";
};
readonly "tui.editor.cursorLeft": {
readonly defaultKeys: ["left", "ctrl+b"];
readonly description: "Move cursor left";
};
readonly "tui.editor.cursorRight": {
readonly defaultKeys: ["right", "ctrl+f"];
readonly description: "Move cursor right";
};
readonly "tui.editor.cursorWordLeft": {
readonly defaultKeys: ["alt+left", "ctrl+left", "alt+b"];
readonly description: "Move cursor word left";
};
readonly "tui.editor.cursorWordRight": {
readonly defaultKeys: ["alt+right", "ctrl+right", "alt+f"];
readonly description: "Move cursor word right";
};
readonly "tui.editor.cursorLineStart": {
readonly defaultKeys: ["home", "ctrl+home", "ctrl+a"];
readonly description: "Move to line start";
};
readonly "tui.editor.cursorLineEnd": {
readonly defaultKeys: ["end", "ctrl+end", "ctrl+e"];
readonly description: "Move to line end";
};
readonly "tui.editor.jumpForward": {
readonly defaultKeys: "ctrl+]";
readonly description: "Jump forward to character";
};
readonly "tui.editor.jumpBackward": {
readonly defaultKeys: "ctrl+alt+]";
readonly description: "Jump backward to character";
};
readonly "tui.editor.pageUp": {
readonly defaultKeys: ["pageUp", "ctrl+pageUp"];
readonly description: "Page up";
};
readonly "tui.editor.pageDown": {
readonly defaultKeys: ["pageDown", "ctrl+pageDown"];
readonly description: "Page down";
};
readonly "tui.editor.deleteCharBackward": {
readonly defaultKeys: "backspace";
readonly description: "Delete character backward";
};
readonly "tui.editor.deleteCharForward": {
readonly defaultKeys: ["delete", "ctrl+d"];
readonly description: "Delete character forward";
};
readonly "tui.editor.deleteWordBackward": {
readonly defaultKeys: ["ctrl+w", "alt+backspace"];
readonly description: "Delete word backward";
};
readonly "tui.editor.deleteWordForward": {
readonly defaultKeys: ["alt+d", "alt+delete"];
readonly description: "Delete word forward";
};
readonly "tui.editor.deleteToLineStart": {
readonly defaultKeys: "ctrl+u";
readonly description: "Delete to line start";
};
readonly "tui.editor.deleteToLineEnd": {
readonly defaultKeys: "ctrl+k";
readonly description: "Delete to line end";
};
readonly "tui.editor.yank": {
readonly defaultKeys: "ctrl+y";
readonly description: "Yank";
};
readonly "tui.editor.yankPop": {
readonly defaultKeys: "alt+y";
readonly description: "Yank pop";
};
readonly "tui.editor.undo": {
readonly defaultKeys: "ctrl+-";
readonly description: "Undo";
};
readonly "tui.input.newLine": {
readonly defaultKeys: ["shift+enter", "ctrl+j"];
readonly description: "Insert newline";
};
readonly "tui.input.submit": {
readonly defaultKeys: "enter";
readonly description: "Submit input";
};
readonly "tui.input.tab": {
readonly defaultKeys: "tab";
readonly description: "Tab / autocomplete";
};
readonly "tui.input.copy": {
readonly defaultKeys: "ctrl+c";
readonly description: "Copy selection";
};
readonly "tui.select.up": {
readonly defaultKeys: "up";
readonly description: "Move selection up";
};
readonly "tui.select.down": {
readonly defaultKeys: "down";
readonly description: "Move selection down";
};
readonly "tui.select.pageUp": {
readonly defaultKeys: "pageUp";
readonly description: "Selection page up";
};
readonly "tui.select.pageDown": {
readonly defaultKeys: "pageDown";
readonly description: "Selection page down";
};
readonly "tui.select.confirm": {
readonly defaultKeys: "enter";
readonly description: "Confirm selection";
};
readonly "tui.select.cancel": {
readonly defaultKeys: ["escape", "ctrl+c"];
readonly description: "Cancel selection";
};
readonly "tui.altScreen.pageUp": {
readonly defaultKeys: "pageUp";
readonly description: "Scroll viewport up one page";
};
readonly "tui.altScreen.pageDown": {
readonly defaultKeys: "pageDown";
readonly description: "Scroll viewport down one page";
};
readonly "tui.altScreen.halfPageUp": {
readonly defaultKeys: [];
readonly description: "Scroll viewport up half a page";
};
readonly "tui.altScreen.halfPageDown": {
readonly defaultKeys: [];
readonly description: "Scroll viewport down half a page";
};
readonly "tui.altScreen.lineUp": {
readonly defaultKeys: [];
readonly description: "Scroll viewport up one line";
};
readonly "tui.altScreen.lineDown": {
readonly defaultKeys: [];
readonly description: "Scroll viewport down one line";
};
readonly "tui.altScreen.previousPrompt": {
readonly defaultKeys: ["ctrl+shift+up", "ctrl+up"];
readonly description: "Jump to previous semantic prompt";
};
readonly "tui.altScreen.nextPrompt": {
readonly defaultKeys: ["ctrl+shift+down", "ctrl+down"];
readonly description: "Jump to next semantic prompt";
};
readonly "tui.altScreen.search": {
readonly defaultKeys: "ctrl+shift+f";
readonly description: "Search the primary scroll view";
};
readonly "tui.altScreen.searchNext": {
readonly defaultKeys: ["enter", "ctrl+g"];
readonly description: "Select the next search match";
};
readonly "tui.altScreen.searchPrevious": {
readonly defaultKeys: ["shift+enter", "ctrl+shift+g"];
readonly description: "Select the previous search match";
};
readonly "tui.altScreen.searchClose": {
readonly defaultKeys: "escape";
readonly description: "Close transcript search";
};
readonly "tui.altScreen.top": {
readonly defaultKeys: "home";
readonly description: "Scroll viewport to top";
};
readonly "tui.altScreen.bottom": {
readonly defaultKeys: "end";
readonly description: "Scroll viewport to bottom";
};
readonly "app.interrupt": {
readonly defaultKeys: "escape";
readonly description: "Cancel or abort";
};
readonly "app.clear": {
readonly defaultKeys: "ctrl+c";
readonly description: "Clear editor";
};
readonly "app.exit": {
readonly defaultKeys: "ctrl+d";
readonly description: "Exit when editor is empty";
};
readonly "app.suspend": {
readonly defaultKeys: "ctrl+z" | never[];
readonly description: "Suspend to background";
};
readonly "app.thinking.cycle": {
readonly defaultKeys: "shift+tab";
readonly description: "Cycle thinking level";
};
readonly "app.model.cycleForward": {
readonly defaultKeys: "ctrl+p";
readonly description: "Cycle to next model";
};
readonly "app.model.cycleBackward": {
readonly defaultKeys: "shift+ctrl+p";
readonly description: "Cycle to previous model";
};
readonly "app.model.select": {
readonly defaultKeys: "ctrl+l";
readonly description: "Open model selector";
};
readonly "app.tools.expand": {
readonly defaultKeys: "ctrl+o";
readonly description: "Toggle tool output";
};
readonly "app.thinking.toggle": {
readonly defaultKeys: "ctrl+t";
readonly description: "Toggle thinking blocks";
};
readonly "app.session.toggleNamedFilter": {
readonly defaultKeys: "ctrl+n";
readonly description: "Toggle named session filter";
};
readonly "app.editor.external": {
readonly defaultKeys: "ctrl+g";
readonly description: "Open external editor";
};
readonly "app.message.followUp": {
readonly defaultKeys: "alt+enter";
readonly description: "Queue follow-up message";
};
readonly "app.message.dequeue": {
readonly defaultKeys: "alt+up";
readonly description: "Restore queued messages";
};
readonly "app.clipboard.pasteImage": {
readonly defaultKeys: "alt+v" | "ctrl+v";
readonly description: "Paste image from clipboard";
};
readonly "app.session.new": {
readonly defaultKeys: [];
readonly description: "Start a new session";
};
readonly "app.session.tree": {
readonly defaultKeys: [];
readonly description: "Open session tree";
};
readonly "app.session.fork": {
readonly defaultKeys: [];
readonly description: "Fork current session";
};
readonly "app.session.resume": {
readonly defaultKeys: [];
readonly description: "Resume a session";
};
readonly "app.tree.foldOrUp": {
readonly defaultKeys: ["ctrl+left", "alt+left"];
readonly description: "Fold tree branch or move up";
};
readonly "app.tree.unfoldOrDown": {
readonly defaultKeys: ["ctrl+right", "alt+right"];
readonly description: "Unfold tree branch or move down";
};
readonly "app.tree.editLabel": {
readonly defaultKeys: "shift+l";
readonly description: "Edit tree label";
};
readonly "app.tree.toggleLabelTimestamp": {
readonly defaultKeys: "shift+t";
readonly description: "Toggle tree label timestamps";
};
readonly "app.session.togglePath": {
readonly defaultKeys: "ctrl+p";
readonly description: "Toggle session path display";
};
readonly "app.session.toggleSort": {
readonly defaultKeys: "ctrl+s";
readonly description: "Toggle session sort mode";
};
readonly "app.session.rename": {
readonly defaultKeys: "ctrl+r";
readonly description: "Rename session";
};
readonly "app.session.delete": {
readonly defaultKeys: "ctrl+d";
readonly description: "Delete session";
};
readonly "app.session.deleteNoninvasive": {
readonly defaultKeys: "ctrl+backspace";
readonly description: "Delete session when query is empty";
};
readonly "app.models.save": {
readonly defaultKeys: "ctrl+s";
readonly description: "Save model selection";
};
readonly "app.models.enableAll": {
readonly defaultKeys: "ctrl+a";
readonly description: "Enable all models";
};
readonly "app.models.clearAll": {
readonly defaultKeys: "ctrl+x";
readonly description: "Clear all models";
};
readonly "app.models.toggleProvider": {
readonly defaultKeys: "ctrl+p";
readonly description: "Toggle all models for provider";
};
readonly "app.models.reorderUp": {
readonly defaultKeys: "alt+up";
readonly description: "Move model up in order";
};
readonly "app.models.reorderDown": {
readonly defaultKeys: "alt+down";
readonly description: "Move model down in order";
};
readonly "app.tree.filter.default": {
readonly defaultKeys: "ctrl+d";
readonly description: "Tree filter: default view";
};
readonly "app.tree.filter.noTools": {
readonly defaultKeys: "ctrl+t";
readonly description: "Tree filter: hide tool results";
};
readonly "app.tree.filter.userOnly": {
readonly defaultKeys: "ctrl+u";
readonly description: "Tree filter: user messages only";
};
readonly "app.tree.filter.labeledOnly": {
readonly defaultKeys: "ctrl+l";
readonly description: "Tree filter: labeled entries only";
};
readonly "app.tree.filter.all": {
readonly defaultKeys: "ctrl+a";
readonly description: "Tree filter: show all entries";
};
readonly "app.tree.filter.cycleForward": {
readonly defaultKeys: "ctrl+o";
readonly description: "Tree filter: cycle forward";
};
readonly "app.tree.filter.cycleBackward": {
readonly defaultKeys: "shift+ctrl+o";
readonly description: "Tree filter: cycle backward";
};
};
/** Keybinding manager that loads OpenClaw defaults plus optional user overrides. */
declare class KeybindingsManager$1 extends KeybindingsManager {
private configPath;
constructor(userBindings?: KeybindingsConfig, configPath?: string);
/** Creates a manager from the agent keybindings.json file. */
static create(agentDir?: string): KeybindingsManager$1;
/** Reloads user overrides from disk when this manager was created with a config path. */
reload(): void;
/** Returns the currently resolved keybinding map after defaults and overrides. */
getEffectiveConfig(): KeybindingsConfig;
private static loadFromFile;
}
//#endregion
//#region src/agents/plugin-model-catalog.d.ts
type PersistedPluginModelCatalog = {
pluginId: string;
contents: string;
};
type PluginModelCatalogMetadataSnapshot = Pick<PluginMetadataSnapshot, "owners"> & {
manifestRegistry?: Pick<PluginMetadataSnapshot["manifestRegistry"], "plugins">;
index?: {
plugins: ReadonlyArray<{
enabled: boolean;
pluginId: string;
}>;
};
normalizePluginId?: (pluginId: string) => string;
};
//#endregion
//#region src/agents/sessions/auth-storage-types.d.ts
type ApiKeyCredential = {
type: "api_key";
key: string;
/** Secret-free native presence carried only by in-memory discovery credentials. */
nativeAuth?: {
runtime: string;
mode: "api-key" | "oauth" | "token";
};
};
type OAuthCredential = {
type: "oauth";
} & OAuthCredentials;
type TokenCredential = {
type: "token";
token: string;
expires?: number;
};
type AuthCredential = ApiKeyCredential | OAuthCredential | TokenCredential;
type AuthStorageData = Record<string, AuthCredential>;
type LockResult<T> = {
result: T;
next?: string;
};
interface AuthStorageBackend {
read?(): string | undefined;
assertProviderReady?(provider?: string, baseUrl?: string): void;
getCredentialSource?(provider: string): AuthProfileCredentialSource | undefined;
assertCredentialReady?(source: AuthProfileCredentialSource, baseUrl?: string): void;
withLock<T>(fn: (current: string | undefined) => LockResult<T>): T;
withLockAsync<T>(fn: (current: string | undefined) => Promise<LockResult<T>>): Promise<T>;
}
//#endregion
//#region src/agents/sessions/auth-storage.d.ts
type AuthStatus = {
configured: boolean;
source?: "stored" | "runtime" | "environment" | "fallback" | "models_json_key" | "models_json_command";
label?: string;
};
/**
* Provider-keyed credential facade backed by the canonical auth-profile store.
*/
declare class AuthStorage {
private data;
private credentialSources;
private runtimeOverrides;
private fallbackResolver?;
private loadError;
private errors;
private storage;
private constructor();
static forAgent(agentDir?: string, config?: OpenClawConfig): AuthStorage;
/**
* @deprecated Use AuthStorage.forAgent(agentDir). The path-taking compatibility
* form is eligible for removal after 2026-10-01 and a clean published-plugin
* reader sweep; it no longer reads or writes JSON.
*/
static create(authPath?: string): AuthStorage;
static fromStorage(storage: AuthStorageBackend): AuthStorage;
static inMemory(data?: AuthStorageData): AuthStorage;
/**
* Set a runtime API key override (not persisted to disk).
* Used for CLI --api-key flag.
*/
setRuntimeApiKey(provider: string, apiKey: string): void;
/**
* Remove a runtime API key override.
*/
removeRuntimeApiKey(provider: string): void;
/**
* Set a fallback resolver for API keys not found in auth.json or env vars.
* Used for custom provider keys from models.json.
*/
setFallbackResolver(resolver: (provider: string) => string | undefined): void;
private recordError;
private getCanonicalLoadError;
private parseStorageData;
private setData;
/**
* Reload credentials from storage.
*/
reload(): void;
private persistProviderChange;
/**
* Get credential for a provider.
*/
get(provider: string): AuthCredential | undefined;
/**
* Set credential for a provider.
*/
set(provider: string, credential: AuthCredential): void;
/**
* Remove credential for a provider.
*/
remove(provider: string): void;
/**
* List all providers with credentials.
*/
list(): string[];
/**
* Check if credentials exist for a provider in auth.json.
*/
has(provider: string): boolean;
/**
* Check if any form of auth is configured for a provider.
* Unlike getApiKey(), this doesn't refresh OAuth tokens.
*/
hasAuth(provider: string): boolean;
/**
* Return auth status without exposing credential values or refreshing tokens.
*/
getAuthStatus(provider: string): AuthStatus;
/**
* Get all credentials (for passing to getOAuthApiKey).
*/
getAll(): AuthStorageData;
drainErrors(): Error[];
/**
* Login to an OAuth provider.
*/
login(providerId: OAuthProviderId, callbacks: OAuthLoginCallbacks$1): Promise<void>;
/**
* Logout from a provider.
*/
logout(provider: string): void;
/**
* Refresh OAuth token with backend locking to prevent race conditions.
* Multiple agent sessions may try to refresh simultaneously when tokens expire.
*/
private refreshOAuthTokenWithLock;
/**
* Get API key for a provider.
* Priority:
* 1. Runtime override (CLI --api-key)
* 2. API key from auth.json
* 3. OAuth token from auth.json (auto-refreshed with locking)
* 4. Environment variable
* 5. Fallback resolver (models.json custom providers)
*/
getApiKey(providerId: string, options?: {
includeFallback?: boolean;
baseUrl?: string;
}): Promise<string | undefined>;
private resolveStoredOrFallbackApiKey;
/**
* Get all OAuth providers registered for this auth/session runtime.
*/
getOAuthProviders(): OAuthProviderInterface[];
}
//#endregion
//#region src/agents/sessions/model-registry-schema.d.ts
declare const ProviderAuthModeSchema: Type$1.TUnion<[Type$1.TLiteral<"api-key">, Type$1.TLiteral<"aws-sdk">, Type$1.TLiteral<"oauth">, Type$1.TLiteral<"token">]>;
type ProviderAuthMode = Static<typeof ProviderAuthModeSchema>;
//#endregion
//#region src/agents/sessions/provider-config.d.ts
/** Shared fields accepted by extension and registry provider registration. */
interface ProviderConfigBase {
/** Display name for the provider in UI. */
name?: string;
/** Base URL for the API endpoint. Required when defining models. */
baseUrl?: string;
/** API key or environment variable name. Required when defining models (unless oauth provided). */
apiKey?: string;
/** API type. Required at provider or model level when defining models. */
api?: Api;
/** Optional streamSimple handler for custom APIs. */
streamSimple?: (model: Model, context: Context, options?: SimpleStreamOptions) => AssistantMessageEventStreamContract;
/** Custom headers to include in requests. */
headers?: Record<string, string>;
/** If true, adds Authorization: Bearer header with the resolved API key. */
authHeader?: boolean;
}
/** Configuration for a model within a provider. */
interface ProviderModelConfig {
/** Model ID (e.g., "claude-sonnet-4-20250514"). */
id: string;
/** Display name (e.g., "Claude 4 Sonnet"). */
name: string;
/** API type override for this model. */
api?: Api;
/** API endpoint URL override for this model. */
baseUrl?: string;
/** Whether the model supports extended thinking. */
reasoning: boolean;
/** Maps OpenClaw thinking levels to provider/model-specific values; null marks a level unsupported. */
thinkingLevelMap?: Model["thinkingLevelMap"];
/** Supported input types. */
input: ("text" | "image")[];
/** Cost per token (for tracking, can be 0). */
cost: {
input: number;
output: number;
cacheRead: number;
cacheWrite: number;
};
/** Maximum context window size in tokens. */
contextWindow: number;
/** Maximum output tokens. */
maxTokens: number;
/** Custom headers for this model. */
headers?: Record<string, string>;
/** OpenAI compatibility settings. */
compat?: Model["compat"];
}
//#endregion
//#region src/agents/sessions/model-registry.d.ts
type ResolvedRequestAuth = {
ok: true;
apiKey?: string;
headers?: Record<string, string>;
} | {
ok: false;
error: string;
};
type ModelRegistryOptions = {
config?: OpenClawConfig;
includePluginCatalogs?: boolean;
modelsJsonContents?: string | null;
pluginCatalogs?: readonly PersistedPluginModelCatalog[];
staticProviderConfigs?: Readonly<Record<string, ModelProviderConfig>>;
pluginMetadataSnapshot?: PluginModelCatalogMetadataSnapshot;
sourceSnapshot?: ModelRegistry$1;
workspaceDir?: string;
};
/**
* Model registry - loads and manages models, resolves API keys via AuthStorage.
*/
declare class ModelRegistry$1 {
private models;
private config;
private providerRequestConfigs;
private modelRequestHeaders;
private registeredProviders;
private loadError;
readonly authStorage: AuthStorage;
private modelsJsonPath;
private modelsJsonContents;
private pluginCatalogs;
private staticProviderConfigs;
private pluginMetadataSnapshot;
private includePluginCatalogs;
private baseCatalogSnapshot;
private sourceSnapshot;
private constructor();
private captureCatalogSnapshot;
private restoreSourceCatalog;
static create(authStorage: AuthStorage, modelsJsonPath?: string, options?: ModelRegistryOptions): ModelRegistry$1;
static inMemory(authStorage: AuthStorage): ModelRegistry$1;
/** Creates a request-isolated registry from this lifecycle-owned catalog snapshot. */
fork(authStorage: AuthStorage, publishedModels?: ReadonlyMap<string, readonly Model[]>): ModelRegistry$1;
/**
* Reload models from disk (models.json).
*/
refresh(): void;
/** Get any root or generated plugin catalog load error. */
getError(): string | undefined;
/** Returns the exact plugin metadata generation captured with this registry. */
getProviderMetadataOwners(): PluginMetadataSnapshotOwnerMaps | undefined;
private loadModels;
private mergeProviderSources;
private loadCapturedPluginCatalogs;
private loadCustomModels;
private validateConfig;
private parseModels;
getAll(): Model[];
/**
* Get only models that have auth configured.
* This is a fast check that doesn't refresh OAuth tokens.
*/
getAvailable(): Model[];
find(provider: string, modelId: string): Model | undefined;
hasConfiguredAuth(model: Model): boolean;
private getModelProviderRequestConfig;
private getModelRequestKey;
private storeProviderRequestConfig;
private storeModelHeaders;
getApiKeyAndHeaders(model: Model): Promise<ResolvedRequestAuth>;
/**
* Return auth status for a provider, including request auth configured in models.json.
* This intentionally does not execute command-backed config values.
*/
getProviderAuthStatus(provider: string): AuthStatus;
getProviderDisplayName(provider: string): string;
getApiKeyForProvider(provider: string): Promise<string | undefined>;
/**
* Check if a model is using OAuth credentials (subscription).
*/
isUsingOAuth(model: Model): boolean;
/**
* Register a provider dynamically (from extensions).
*
* If provider has models: replaces all existing models for this provider.
* Provider-level request settings are stored for already-known models but
* never create implicit model rows.
* If provider has oauth: registers OAuth provider for /login support.
*/
registerProvider(providerName: string, config: ProviderConfigInput): void;
/**
* Unregister a previously registered provider.
*
* Removes the provider from the registry and reloads models from disk.
* Also resets dynamic OAuth and API stream registrations before reapplying
* remaining dynamic providers.
* Has no effect if the provider was never registered.
*/
unregisterProvider(providerName: string): void;
/**
* Upsert a provider config into registeredProviders.
* If the provider is already registered, defined values in the incoming config
* override existing ones; undefined values are preserved from the stored config.
* If the provider is not registered, the incoming config is stored as-is.
*/
private upsertRegisteredProvider;
private validateProviderConfig;
private applyProviderConfig;
}
/**
* Input type for registerProvider API.
*/
interface ProviderConfigInput extends ProviderConfigBase {
auth?: ProviderAuthMode;
/** OAuth provider for /login support */
oauth?: Omit<OAuthProviderInterface, "id">;
models?: Array<ProviderModelConfig & {
contextTokens?: number;
contextWindows?: ModelCatalogContextWindowOption[];
contextWindowDefault?: string;
params?: Record<string, unknown>;
}>;
}
//#endregion
//#region src/agents/sessions/slash-commands.d.ts
type SlashCommandSource = "extension" | "prompt" | "skill";
interface SlashCommandInfo {
name: string;
description?: string;
source: SlashCommandSource;
sourceInfo: SourceInfo;
}
//#endregion
//#region src/agents/sessions/diagnostics.d.ts
interface ResourceCollision {
resourceType: "extension" | "skill" | "prompt" | "theme";
name: string;
winnerPath: string;
loserPath: string;
winnerSource?: string;
loserSource?: string;
}
interface ResourceDiagnostic {
type: "warning" | "error" | "collision";
message: string;
path?: string;
collision?: ResourceCollision;
}
//#endregion
//#region src/agents/sessions/system-prompt.d.ts
interface BuildSystemPromptOptions {
/** Custom system prompt (replaces default). */
customPrompt?: string;
/** Tools to include in prompt. Default: [read, bash, edit, write] */
selectedTools?: string[];
/** Optional one-line tool snippets keyed by tool name. */
toolSnippets?: Record<string, string>;
/** Additional guideline bullets appended to the default system prompt guidelines. */
promptGuidelines?: string[];
/** Text to append to system prompt. */
appendSystemPrompt?: string;
/** Working directory. */
cwd: string;
/** Pre-loaded context files. */
contextFiles?: Array<{
path: string;
content: string;
}>;
/** Pre-loaded skills. */
skills?: Skill[];
}
//#endregion
//#region src/agents/sessions/tools/tool-schemas.d.ts
declare const bashSchema: Type$1.TObject<{
title: Type$1.TOptional<Type$1.TString>;
command: Type$1.TString;
timeout: Type$1.TOptional<Type$1.TNumber>;
}>;
declare const editSchema: Type$1.TObject<{
path: Type$1.TString;
edits: Type$1.TArray<Type$1.TObject<{
oldText: Type$1.TString;
newText: Type$1.TString;
}>>;
}>;
declare const EditToolOutputSchema: Type$1.TUnion<[Type$1.TObject<{
changed: Type$1.TLiteral<false>;
}>, Type$1.TObject<{
changed: Type$1.TLiteral<true>;
diff: Type$1.TString;
patch: Type$1.TString;
firstChangedLine: Type$1.TOptional<Type$1.TInteger>;
}>]>;
declare const findSchema: Type$1.TObject<{
pattern: Type$1.TString;
path: Type$1.TOptional<Type$1.TString>;
limit: Type$1.TOptional<Type$1.TInteger>;
}>;
declare const grepSchema: Type$1.TObject<{
pattern: Type$1.TString;
path: Type$1.TOptional<Type$1.TString>;
glob: Type$1.TOptional<Type$1.TString>;
ignoreCase: Type$1.TOptional<Type$1.TBoolean>;
literal: Type$1.TOptional<Type$1.TBoolean>;
context: Type$1.TOptional<Type$1.TNumber>;
limit: Type$1.TOptional<Type$1.TNumber>;
}>;
declare const lsSchema: Type$1.TObject<{
path: Type$1.TOptional<Type$1.TString>;
limit: Type$1.TOptional<Type$1.TNumber>;
after: Type$1.TOptional<Type$1.TString>;
}>;
declare const readToolInputSchema: Type$1.TObject<{
path: Type$1.TString;
offset: Type$1.TOptional<Type$1.TInteger>;
limit: Type$1.TOptional<Type$1.TNumber>;
cursor: Type$1.TOptional<Type$1.TInteger>;
optional: Type$1.TOptional<Type$1.TLiteral<true>>;
}>;
declare const readToolOutputSchema: Type$1.TUnion<[Type$1.TObject<{
kind: Type$1.TLiteral<"text">;
content: Type$1.TString;
}>, Type$1.TObject<{
kind: Type$1.TLiteral<"image">;
content: Type$1.TString;
mimeType: Type$1.TString;
}>, Type$1.TObject<{
kind: Type$1.TLiteral<"truncated">;
content: Type$1.TString;
truncation: Type$1.TObject<{
truncated: Type$1.TLiteral<true>;
truncatedBy: Type$1.TUnion<[Type$1.TLiteral<"lines">, Type$1.TLiteral<"bytes">]>;
totalLines: Type$1.TInteger;
totalBytes: Type$1.TInteger;
outputLines: Type$1.TInteger;
outputBytes: Type$1.TInteger;
lastLinePartial: Type$1.TBoolean;
firstLineExceedsLimit: Type$1.TBoolean;
maxLines: Type$1.TInteger;
maxBytes: Type$1.TInteger;
}>;
continuation: Type$1.TUnion<[Type$1.TObject<{
offset: Type$1.TInteger;
limit: Type$1.TOptional<Type$1.TInteger>;
kind: Type$1.TLiteral<"line">;
}>, Type$1.TObject<{
offset: Type$1.TInteger;
limit: Type$1.TOptional<Type$1.TInteger>;
kind: Type$1.TLiteral<"cursor">;
cursor: Type$1.TInteger;
}>]>;
}>, Type$1.TObject<{
kind: Type$1.TLiteral<"not_found">;
status: Type$1.TLiteral<"not_found">;
path: Type$1.TString;
optional: Type$1.TLiteral<true>;
}>]>;
declare const writeSchema: Type$1.TObject<{
path: Type$1.TString;
content: Type$1.TString;
}>;
//#endregion
//#region src/agents/sessions/tools/tool-contracts.d.ts
type BashToolInput = Static<typeof bashSchema>;
interface BashToolDetails {
truncation?: TruncationResult;
fullOutputPath?: string;
}
type EditToolInput = Static<typeof editSchema>;
type EditToolDetails = Static<typeof EditToolOutputSchema>;
type FindToolInput = Static<typeof findSchema>;
interface FindToolDetails {
content: string;
truncation?: Omit<TruncationResult, "content">;
resultLimitReached?: number;
}
type GrepToolInput = Static<typeof grepSchema>;
interface GrepToolDetails {
content: string;
truncation?: Omit<TruncationResult, "content">;
matchLimitReached?: number;
linesTruncated?: boolean;
}
type LsToolInput = Static<typeof lsSchema>;
interface LsToolDetails {
content: string;
nextAfter?: string;
}
type ReadToolInput = Static<typeof readToolInputSchema>;
type ReadToolDetails = Static<typeof readToolOutputSchema>;
type WriteToolInput = Static<typeof writeSchema>;
//#endregion
//#region src/agents/sessions/extensions/types.d.ts
interface OAuthLoginCallbacks extends OAuthLoginCallbacks$1 {}
/** Options for extension UI dialogs. */
interface ExtensionUIDialogOptions {
/** AbortSignal to programmatically dismiss the dialog. */
signal?: AbortSignal;
/** Timeout in milliseconds. Dialog auto-dismisses with live countdown display. */
timeout?: number;
}
/** Placement for extension widgets. */
type WidgetPlacement = "aboveEditor" | "belowEditor";
/** Options for extension widgets. */
interface ExtensionWidgetOptions {
/** Where the widget is rendered. Defaults to "aboveEditor". */
placement?: WidgetPlacement;
}
/** Raw terminal input listener for extensions. */
type TerminalInputHandler = (data: string) => {
consume?: boolean;
data?: string;
} | undefined;
/** Working indicator configuration for the interactive streaming loader. */
interface WorkingIndicatorOptions {
/** Animation frames. Use an empty array to hide the indicator entirely. Custom frames are rendered verbatim. */
frames?: string[];
/** Frame interval in milliseconds for animated indicators. */
intervalMs?: number;
}
/** Wrap the current autocomplete provider with additional behavior. */
type AutocompleteProviderFactory = (current: AutocompleteProvider) => AutocompleteProvider;
type EditorFactory = (tui: TUI, theme: EditorTheme, keybindings: KeybindingsManager$1) => EditorComponent;
/**
* UI context for extensions to request interactive UI.
* Each mode (interactive, RPC, print) provides its own implementation.
*/
interface ExtensionUIContext {
/** Show a selector and return the user's choice. */
select(title: string, options: string[], opts?: ExtensionUIDialogOptions): Promise<string | undefined>;
/** Show a confirmation dialog. */
confirm(title: string, message: string, opts?: ExtensionUIDialogOptions): Promise<boolean>;
/** Show a text input dialog. */
input(title: string, placeholder?: string, opts?: ExtensionUIDialogOptions): Promise<string | undefined>;
/** Show a notification to the user. */
notify(message: string, type?: "info" | "warning" | "error"): void;
/** Listen to raw terminal input (interactive mode only). Returns an unsubscribe function. */
onTerminalInput(handler: TerminalInputHandler): () => void;
/** Set status text in the footer/status bar. Pass undefined to clear. */
setStatus(key: string, text: string | undefined): void;
/** Set the working/loading message shown during streaming. Call with no argument to restore default. */
setWorkingMessage(message?: string): void;
/** Show or hide the built-in interactive working loader row during streaming. */
setWorkingVisible(visible: boolean): void;
/**
* Configure the interactive working indicator shown during streaming.
*
* - Omit the argument to restore the default animated spinner.
* - Use `frames: ["●"]` for a static indicator.
* - Use `frames: []` to hide the indicator entirely.
* - Custom frames are rendered as provided, so extensions must add their own colors.
*/
setWorkingIndicator(options?: WorkingIndicatorOptions): void;
/** Set the label shown for hidden thinking blocks. Call with no argument to restore default. */
setHiddenThinkingLabel(label?: string): void;
/** Set a widget to display above or below the editor. Accepts string array or component factory. */
setWidget(key: string, content: string[] | undefined, options?: ExtensionWidgetOptions): void;
setWidget(key: string, content: ((tui: TUI, theme: Theme) => Component & {
dispose?(): void;
}) | undefined, options?: ExtensionWidgetOptions): void;
/** Set a custom footer component, or undefined to restore the built-in footer.
*
* The factory receives a FooterDataProvider for data not otherwise accessible:
* git branch and extension statuses from setStatus(). Token stats, model info,
* etc. are available via ctx.sessionManager and ctx.model.
*/
setFooter(factory: ((tui: TUI, theme: Theme, footerData: ReadonlyFooterDataProvider) => Component & {
dispose?(): void;
}) | undefined): void;
/** Set a custom header component (shown at startup, above chat), or undefined to restore the built-in header. */
setHeader(factory: ((tui: TUI, theme: Theme) => Component & {
dispose?(): void;
}) | undefined): void;
/** Set the terminal window/tab title. */
setTitle(title: string): void;
/** Show a custom component with keyboard focus. */
custom<T>(factory: (tui: TUI, theme: Theme, keybindings: KeybindingsManager$1, done: (result: T) => void) => (Component & {
dispose?(): void;
}) | Promise<Component & {
dispose?(): void;
}>, options?: {
overlay?: boolean;
/** Overlay positioning/sizing options. Can be static or a function for dynamic updates. */
overlayOptions?: OverlayOptions | (() => OverlayOptions);
/** Called with the overlay handle after the overlay is shown. Use to control visibility. */
onHandle?: (handle: OverlayHandle) => void;
}): Promise<T>;
/** Paste text into the editor, triggering paste handling (collapse for large content). */
pasteToEditor(text: string): void;
/** Set the text in the core input editor. */
setEditorText(text: string): void;
/** Get the current text from the core input editor. */
getEditorText(): string;
/** Show a multi-line editor for text editing. */
editor(title: string, prefill?: string): Promise<string | undefined>;
/** Stack additional autocomplete behavior on top of the built-in provider. */
addAutocompleteProvider(factory: AutocompleteProviderFactory): void;
/**
* Set a custom editor component via factory function.
* Pass undefined to restore the default editor.
*
* The factory receives:
* - `theme`: EditorTheme for styling borders and autocomplete
* - `keybindings`: KeybindingsManager for app-level keybindings
*
* For full app keybinding support (escape, ctrl+d, model switching, etc.),
* extend `CustomEditor` from `openclaw/plugin-sdk/agent-sessions` and call
* `super.handleInput(data)` for keys you don't handle.
*
* @example
* ```ts
* import { CustomEditor } from "openclaw/plugin-sdk/agent-sessions";
*
* class VimEditor extends CustomEditor {
* private mode: "normal" | "insert" = "insert";
*
* handleInput(data: string): void {
* if (this.mode === "normal") {
* // Handle vim normal mode keys...
* if (data === "i") { this.mode = "insert"; return; }
* }
* super.handleInput(data); // App keybindings + text editing
* }
* }
*
* ctx.ui.setEditorComponent((tui, theme, keybindings) =>
* new VimEditor(tui, theme, keybindings)
* );
* ```
*/
setEditorComponent(factory: EditorFactory | undefined): void;
/** Get the currently configured custom editor factory, or undefined when using the default editor. */
getEditorComponent(): EditorFactory | undefined;
/** Get the current theme for styling. */
readonly theme: Theme;
/** Get all available themes with their names and file paths. */
getAllThemes(): {
name: string;
path: string | undefined;
}[];
/** Load a theme by name without switching to it. Returns undefined if not found. */
getTheme(name: string): Theme | undefined;
/** Set the current theme by name or Theme object. */
setTheme(theme: string | Theme): {
success: boolean;
error?: string;
};
/** Get current tool output expansion state. */
getToolsExpanded(): boolean;
/** Set tool output expansion state. */
setToolsExpanded(expanded: boolean): void;
}
interface ContextUsage {
/** Estimated context tokens, or null if any (e.g. right after compaction, before next LLM response). */
tokens: number | null;
contextWindow: number;
/** Context usage as percentage of context window, or null if tokens is unknown. */
percent: number | null;
}
interface CompactOptions {
customInstructions?: string;
onComplete?: (result: CompactionResult) => void;
onError?: (error: Error) => void;
}
/**
* Context passed to extension event handlers.
*/
interface ExtensionContext {
/** UI methods for user interaction */
ui: ExtensionUIContext;
/** Whether UI is available (false in print/RPC mode) */
hasUI: boolean;
/** Current working directory */
cwd: string;
/** Session manager (read-only) */
sessionManager: ReadonlySessionManager;
/** Model registry for API key resolution */
modelRegistry: ModelRegistry$1;
/** Current model (may be undefined) */
model: Model | undefined;
/** Whether the agent is idle (not streaming) */
isIdle(): boolean;
/** The current abort signal, or undefined when the agent is not streaming. */
signal: AbortSignal | undefined;
/** Abort the current agent operation */
abort(): void;
/** Whether there are queued messages waiting */
hasPendingMessages(): boolean;
/** Gracefully shut down OpenClaw and exit. Available in all contexts. */
shutdown(): void;
/** Get current context usage for the active model. */
getContextUsage(): ContextUsage | undefined;
/** Trigger compaction without awaiting completion. */
compact(options?: CompactOptions): void;
/** Get the current effective system prompt. */
getSystemPrompt(): string;
}
/**
* Extended context for command handlers.
* Includes session control methods only safe in user-initiated commands.
*/
interface ExtensionCommandContext extends ExtensionContext {
/** Wait for the agent to finish streaming */
waitForIdle(): Promise<void>;
/** Start a new session, optionally with initialization. */
newSession(options?: {
parentSession?: string;
setup?: (sessionManager: SessionManager) => Promise<void>;
withSession?: (ctx: ReplacedSessionContext) => Promise<void>;
}): Promise<{
cancelled: boolean;
}>;
/** Fork from a specific entry, creating a new session file. */
fork(entryId: string, options?: {
position?: "before" | "at";
withSession?: (ctx: ReplacedSessionContext) => Promise<void>;
}): Promise<{
cancelled: boolean;
}>;
/** Navigate to a different point in the session tree. */
navigateTree(targetId: string, options?: {
summarize?: boolean;
customInstructions?: string;
replaceInstructions?: boolean;
label?: string;
}): Promise<{
cancelled: boolean;
}>;
/** Switch to a different session file. */
switchSession(sessionPath: string, options?: {
withSession?: (ctx: ReplacedSessionContext) => Promise<void>;
}): Promise<{
cancelled: boolean;
}>;
/** Reload extensions, skills, prompts, and themes. */
reload(): Promise<void>;
}
/**
* Fresh command-capable context bound to the replacement session after a session switch.
*
* This is passed to `withSession()` callbacks on `newSession()`, `fork()`, and `switchSession()`.
*/
interface ReplacedSessionContext extends ExtensionCommandContext {
sendMessage<T = unknown>(message: Pick<CustomMessage<T>, "customType" | "content" | "display" | "details">, options?: {
triggerTurn?: boolean;
deliverAs?: "steer" | "followUp" | "nextTurn";
}): Promise<void>;
sendUserMessage(content: string | (TextContent | ImageContent$1)[], options?: {
deliverAs?: "steer" | "followUp";
}): Promise<void>;
}
/** Rendering options for tool results */
interface ToolRenderResultOptions {
/** Whether the result view is expanded */
expanded: boolean;
/** Whether this is a partial/streaming result */
isPartial: boolean;
}
/** Context passed to tool renderers. */
interface ToolRenderContext<TState = unknown, TArgs = unknown> {
/** Current tool call arguments. Shared across call/result renders for the same tool call. */
args: TArgs;
/** Unique id for this tool execution. Stable across call/result renders for the same tool call. */
toolCallId: string;
/** Invalidate just this tool execution component for redraw. */
invalidate: () => void;
/** Previously returned component for this render slot, if any. */
lastComponent: Component | undefined;
/** Shared renderer state for this tool row. Initialized by tool-execution.ts. */
state: TState;
/** Working directory for this tool execution. */
cwd: string;
/** Whether the tool execution has started. */
executionStarted: boolean;
/** Whether the tool call arguments are complete. */
argsComplete: boolean;
/** Whether the tool result is partial/streaming. */
isPartial: boolean;
/** Whether the result view is expanded. */
expanded: boolean;
/** Whether inline images are currently shown in the TUI. */
showImages: boolean;
/** Whether the current result is an error. */
isError: boolean;
}
type BivariantCallback<TArgs extends unknown[], TResult> = {
bivarianceHack(...args: TArgs): TResult;
}["bivarianceHack"];
/**
* Tool definition for registerTool().
*/
interface ToolDefinition$1<TParams extends TSchema = TSchema, TDetails = unknown, TState = unknown> {
/** Tool name (used in LLM tool calls) */
name: string;
/** Human-readable label for UI */
label: string;
/** Preserve lifecycle telemetry without rendering transient channel progress. */
hideFromChannelProgress?: boolean;
/** Tool results contain externally controlled network content. */
resultContentSource?: AgentTool["resultContentSource"];
/** Description for LLM */
description: string;
/** Optional one-line snippet for the Available tools section in the default system prompt. Custom tools are omitted from that section when this is not provided. */
promptSnippet?: string;
/** Optional guideline bullets appended to the default system prompt Guidelines section when this tool is active. */
promptGuidelines?: string[];
/** Parameter schema (TypeBox) */
parameters: TParams;
/** Exact schema for the structured value returned in AgentToolResult.details. */
outputSchema?: TSchema;
/** Controls whether ToolExecutionComponent renders the standard colored shell or the tool renders its own framing. */
renderShell?: "default" | "self";
/** Optional compatibility shim to prepare raw tool call arguments before schema validation. Must return an object conforming to TParams. */
prepareArguments?: (args: unknown) => Static<TParams>;
/**
* Per-tool execution mode override.
* - "sequential": this tool must execute one at a time with other tool calls.
* - "parallel": this tool can execute concurrently with other tool calls.
*
* If omitted, the default execution mode applies.
*/
executionMode?: ToolExecutionMode;
/** Execute the tool. */
execute(toolCallId: string, params: Static<TParams>, signal: AbortSignal | undefined, onUpdate: AgentToolUpdateCallback<TDetails> | undefined, ctx: ExtensionContext): Promise<AgentToolResult<TDetails>>;
/** Custom rendering for tool call display */
renderCall?: BivariantCallback<[args: Static<TParams>, theme: Theme, context: ToolRenderContext<TState, Static<TParams>>], Component>;
/** Custom rendering for tool result display */
renderResult?: BivariantCallback<[result: AgentToolResult<TDetails>, options: ToolRenderResultOptions, theme: Theme, context: ToolRenderContext<TState, Static<TParams>>], Component>;
}
/** Fired after session_start to allow extensions to provide additional resource paths. */
interface ResourcesDiscoverEvent {
type: "resources_discover";
cwd: string;
reason: "startup" | "reload";
}
/** Result from resources_discover event handler */
interface ResourcesDiscoverResult {
skillPaths?: string[];
promptPaths?: string[];
themePaths?: string[];
}
/** Fired when a session is started, loaded, or reloaded */
interface SessionStartEvent {
type: "session_start";
/** Why this session start happened. */
reason: "startup" | "reload" | "new" | "resume" | "fork";
/** Previously active session file. Present for "new", "resume", and "fork". */
previousSessionFile?: string;
}
/** Fired before switching to another session (can be cancelled) */
interface SessionBeforeSwitchEvent {
type: "session_before_switch";
reason: "new" | "resume";
targetSessionFile?: string;
}
/** Fired before forking a session (can be cancelled) */
interface SessionBeforeForkEvent {
type: "session_before_fork";
entryId: string;
position: "before" | "at";
}
/** Fired before context compaction (can be cancelled or customized) */
interface SessionBeforeCompactEvent {
type: "session_before_compact";
preparation: CompactionPreparation;
branchEntries: SessionEntry[];
customInstructions?: string;
signal: AbortSignal;
/** Prepared reasoning level for extension-owned summarization. */
thinkingLevel?: ThinkingLevel;
/** Prepared provider stream for extension-owned summarization. */
streamFn?: StreamFn$1;
}
/** Fired after context compaction */
interface SessionCompactEvent {
type: "session_compact";
compactionEntry: CompactionEntry;
fromExtension: boolean;
}
/** Fired before an extension runtime is torn down due to quit, reload, or session replacement. */
interface SessionShutdownEvent {
type: "session_shutdown";
reason: "quit" | "reload" | "new" | "resume" | "fork";
/** Destination session file when shutting down due to session replacement. */
targetSessionFile?: string;
}
/** Preparation data for tree navigation */
interface TreePreparation {
targetId: string;
oldLeafId: string | null;
commonAncestorId: string | null;
entriesToSummarize: SessionEntry[];
userWantsSummary: boolean;
/** Custom instructions for summarization */
customInstructions?: string;
/** If true, customInstructions replaces the default prompt instead of being appended */
replaceInstructions?: boolean;
/** Label to attach to the branch summary entry */
label?: string;
}
/** Fired before navigating in the session tree (can be cancelled) */
interface SessionBeforeTreeEvent {
type: "session_before_tree";
preparation: TreePreparation;
signal: AbortSignal;
}
/** Fired after navigating in the session tree */
interface SessionTreeEvent {
type: "session_tree";
newLeafId: string | null;
oldLeafId: string | null;
summaryEntry?: BranchSummaryEntry;
fromExtension?: boolean;
}
type SessionEvent = SessionStartEvent | SessionBeforeSwitchEvent | SessionBeforeForkEvent | SessionBeforeCompactEvent | SessionCompactEvent | SessionShutdownEvent | SessionBeforeTreeEvent | SessionTreeEvent;
/** Fired before each LLM call. Can modify messages. */
interface ContextEvent {
type: "context";
messages: AgentMessage[];
}
/** Fired before a provider request is sent. Can replace the payload. */
interface BeforeProviderRequestEvent {
type: "before_provider_request";
payload: unknown;
}
/** Fired after a provider response is received and before the response stream is consumed. */
interface AfterProviderResponseEvent {
type: "after_provider_response";
status: number;
headers: Record<string, string>;
}
/** Fired after user submits prompt but before agent loop. */
interface BeforeAgentStartEvent {
type: "before_agent_start";
/** The raw user prompt text (after expansion). */
prompt: string;
/** Images attached to the user prompt, if any. */
images?: ImageContent$1[];
/** The fully assembled system prompt string. */
systemPrompt: string;
/** Structured options used to build the system prompt. Extensions can inspect this without re-discovering resources. */
systemPromptOptions: BuildSystemPromptOptions;
}
/** Fired when an agent loop starts */
interface AgentStartEvent {
type: "agent_start";
}
/** Fired when an agent loop ends */
interface AgentEndEvent {
type: "agent_end";
messages: AgentMessage[];
}
/** Fired once the session has no automatic retry, compaction, or queued continuation left. */
interface AgentSettledEvent {
type: "agent_settled";
}
/** Fired at the start of each turn */
interface TurnStartEvent {
type: "turn_start";
turnIndex: number;
timestamp: number;
}
/** Fired at the end of each turn */
interface TurnEndEvent {
type: "turn_end";
turnIndex: number;
message: AgentMessage;
toolResults: ToolResultMessage[];
}
/** Fired when a message starts (user, assistant, or toolResult) */
interface MessageStartEvent {
type: "message_start";
message: AgentMessage;
}
/** Fired during assistant message streaming with token-by-token updates */
interface MessageUpdateEvent {
type: "message_update";
message: AgentMessage;
assistantMessageEvent: AssistantMessageEvent;
}
/** Fired when a message ends */
interface MessageEndEvent {
type: "message_end";
message: AgentMessage;
}
/** Fired when a tool starts executing */
interface ToolExecutionStartEvent {
type: "tool_execution_start";
toolCallId: string;
toolName: string;
args: unknown;
}
/** Fired during tool execution with partial/streaming output */
interface ToolExecutionUpdateEvent {
type: "tool_execution_update";
toolCallId: string;
toolName: string;
args: unknown;
partialResult: unknown;
}
/** Fired when a tool finishes executing */
interface ToolExecutionEndEvent {
type: "tool_execution_end";
toolCallId: string;
toolName: string;
result: unknown;
isError: boolean;
}
type ModelSelectSource = "set" | "cycle" | "restore";
/** Fired when a new model is selected */
interface ModelSelectEvent {
type: "model_select";
model: Model;
previousModel: Model | undefined;
source: ModelSelectSource;
}
/** Fired when a new thinking level is selected */
interface ThinkingLevelSelectEvent {
type: "thinking_level_select";
level: ThinkingLevel;
previousLevel: ThinkingLevel;
}
/** Fired when user executes a bash command via ! or !! prefix */
interface UserBashEvent {
type: "user_bash";
/** The command to execute */
command: string;
/** True if !! prefix was used (excluded from LLM context) */
excludeFromContext: boolean;
/** Current working directory */
cwd: string;
}
/** Source of user input */
type InputSource = "interactive" | "rpc" | "extension";
/** Fired when user input is received, before agent processing */
interface InputEvent {
type: "input";
/** The input text */
text: string;
/** Attached images, if any */
images?: ImageContent$1[];
/** Where the input came from */
source: InputSource;
}
/** Result from input event handler */
type InputEventResult = {
action: "continue";
} | {
action: "transform";
text: string;
images?: ImageContent$1[];
} | {
action: "handled";
};
interface ToolCallEventBase<TName extends string, TInput> {
type: "tool_call";
toolCallId: string;
toolName: TName;
input: TInput;
}
type BashToolCallEvent = ToolCallEventBase<"bash", BashToolInput>;
type ReadToolCallEvent = ToolCallEventBase<"read", ReadToolInput>;
type EditToolCallEvent = ToolCallEventBase<"edit", EditToolInput>;
type WriteToolCallEvent = ToolCallEventBase<"write", WriteToolInput>;
type GrepToolCallEvent = ToolCallEventBase<"grep", GrepToolInput>;
type FindToolCallEvent = ToolCallEventBase<"find", FindToolInput>;
type LsToolCallEvent = ToolCallEventBase<"ls", LsToolInput>;
type CustomToolCallEvent = ToolCallEventBase<string, Record<string, unknown>>;
/**
* Fired before a tool executes. Can block.
*
* `event.input` is mutable. Mutate it in place to patch tool arguments before execution.
* Later `tool_call` handlers see earlier mutations. No re-validation is performed after mutation.
*/
type ToolCallEvent = BashToolCallEvent | ReadToolCallEvent | EditToolCallEvent | WriteToolCallEvent | GrepToolCallEvent | FindToolCallEvent | LsToolCallEvent | CustomToolCallEvent;
interface ToolResultEventBase<TName extends string, TDetails> {
type: "tool_result";
toolCallId: string;
toolName: TName;
input: Record<string, unknown>;
content: (TextContent | ImageContent$1)[];
details: TDetails;
isError: boolean;
terminate?: boolean;
}
type BashToolResultEvent = ToolResultEventBase<"bash", BashToolDetails | undefined>;
type ReadToolResultEvent = ToolResultEventBase<"read", ReadToolDetails | undefined>;
type EditToolResultEvent = ToolResultEventBase<"edit", EditToolDetails | undefined>;
type WriteToolResultEvent = ToolResultEventBase<"write", undefined>;
type GrepToolResultEvent = ToolResultEventBase<"grep", GrepToolDetails | undefined>;
type FindToolResultEvent = ToolResultEventBase<"find", FindToolDetails | undefined>;
type LsToolResultEvent = ToolResultEventBase<"ls", LsToolDetails | undefined>;
type CustomToolResultEvent = ToolResultEventBase<string, unknown>;
/** Fired after a tool executes. Can modify result. */
type ToolResultEvent = BashToolResultEvent | ReadToolResultEvent | EditToolResultEvent | WriteToolResultEvent | GrepToolResultEvent | FindToolResultEvent | LsToolResultEvent | CustomToolResultEvent;
/** Union of all event types */
type ExtensionEvent = ResourcesDiscoverEvent | SessionEvent | ContextEvent | BeforeProviderRequestEvent | AfterProviderResponseEvent | BeforeAgentStartEvent | AgentStartEvent | AgentEndEvent | AgentSettledEvent | TurnStartEvent | TurnEndEvent | MessageStartEvent | MessageUpdateEvent | MessageEndEvent | ToolExecutionStartEvent | ToolExecutionUpdateEvent | ToolExecutionEndEvent | ModelSelectEvent | ThinkingLevelSelectEvent | UserBashEvent | InputEvent | ToolCallEvent | ToolResultEvent;
interface ContextEventResult {
messages?: AgentMessage[];
}
interface ToolCallEventResult {
/** Block tool execution. To modify arguments, mutate `event.input` in place instead. */
block?: boolean;
reason?: string;
}
/** Result from user_bash event handler */
interface UserBashEventResult {
/** Custom operations to use for execution */
operations?: BashOperations;
/** Full replacement: extension handled execution, use this result */
result?: BashResult;
}
interface ToolResultEventResult {
content?: (TextContent | ImageContent$1)[];
details?: unknown;
isError?: boolean;
terminate?: boolean;
}
interface MessageEndEventResult {
/** Replace the finalized message. The replacement must keep the original message role. */
message?: AgentMessage;
}
interface BeforeAgentStartEventResult {
message?: Pick<CustomMessage, "customType" | "content" | "display" | "details">;
/** Replace the system prompt for this turn. If multiple extensions return this, they are chained. */
systemPrompt?: string;
}
interface SessionBeforeSwitchResult {
cancel?: boolean;
}
interface SessionBeforeForkResult {
cancel?: boolean;
skipConversationRestore?: boolean;
}
interface SessionBeforeCompactResult {
cancel?: boolean;
compaction?: CompactionResult;
}
interface SessionBeforeTreeResult {
cancel?: boolean;
summary?: {
summary: string;
details?: unknown;
};
/** Override custom instructions for summarization */
customInstructions?: string;
/** Override whether customInstructions replaces the default prompt */
replaceInstructions?: boolean;
/** Override label to attach to the branch summary entry */
label?: string;
}
interface MessageRenderOptions {
expanded: boolean;
}
type MessageRenderer<T = unknown> = (message: CustomMessage<T>, options: MessageRenderOptions, theme: Theme) => Component | undefined;
interface RegisteredCommand {
name: string;
sourceInfo: SourceInfo;
description?: string;
getArgumentCompletions?: (argumentPrefix: string) => AutocompleteItem[] | null | Promise<AutocompleteItem[] | null>;
handler: (args: string, ctx: ExtensionCommandContext) => Promise<void>;
}
interface ResolvedCommand extends RegisteredCommand {
invocationName: string;
}
/** Handler function type for events */
type ExtensionHandler<E, R = undefined> = (event: E, ctx: ExtensionContext) => Promise<R | void> | R | void;
/**
* ExtensionAPI passed to extension factory functions.
*/
interface ExtensionAPI {
on(event: "resources_discover", handler: ExtensionHandler<ResourcesDiscoverEvent, ResourcesDiscoverResult>): void;
on(event: "session_start", handler: ExtensionHandler<SessionStartEvent>): void;
on(event: "session_before_switch", handler: ExtensionHandler<SessionBeforeSwitchEvent, SessionBeforeSwitchResult>): void;
on(event: "session_before_fork", handler: ExtensionHandler<SessionBeforeForkEvent, SessionBeforeForkResult>): void;
on(event: "session_before_compact", handler: ExtensionHandler<SessionBeforeCompactEvent, SessionBeforeCompactResult>): void;
on(event: "session_compact", handler: ExtensionHandler<SessionCompactEvent>): void;
on(event: "session_shutdown", handler: ExtensionHandler<SessionShutdownEvent>): void;
on(event: "session_before_tree", handler: ExtensionHandler<SessionBeforeTreeEvent, SessionBeforeTreeResult>): void;
on(event: "session_tree", handler: ExtensionHandler<SessionTreeEvent>): void;
on(event: "context", handler: ExtensionHandler<ContextEvent, ContextEventResult>): void;
on(event: "before_provider_request", handler: ExtensionHandler<BeforeProviderRequestEvent, unknown>): void;
on(event: "after_provider_response", handler: ExtensionHandler<AfterProviderResponseEvent>): void;
on(event: "before_agent_start", handler: ExtensionHandler<BeforeAgentStartEvent, BeforeAgentStartEventResult>): void;
on(event: "agent_start", handler: ExtensionHandler<AgentStartEvent>): void;
on(event: "agent_end", handler: ExtensionHandler<AgentEndEvent>): void;
on(event: "agent_settled", handler: ExtensionHandler<AgentSettledEvent>): void;
on(event: "turn_start", handler: ExtensionHandler<TurnStartEvent>): void;
on(event: "turn_end", handler: ExtensionHandler<TurnEndEvent>): void;
on(event: "message_start", handler: ExtensionHandler<MessageStartEvent>): void;
on(event: "message_update", handler: ExtensionHandler<MessageUpdateEvent>): void;
on(event: "message_end", handler: ExtensionHandler<MessageEndEvent, MessageEndEventResult>): void;
on(event: "tool_execution_start", handler: ExtensionHandler<ToolExecutionStartEvent>): void;
on(event: "tool_execution_update", handler: ExtensionHandler<ToolExecutionUpdateEvent>): void;
on(event: "tool_execution_end", handler: ExtensionHandler<ToolExecutionEndEvent>): void;
on(event: "model_select", handler: ExtensionHandler<ModelSelectEvent>): void;
on(event: "thinking_level_select", handler: ExtensionHandler<ThinkingLevelSelectEvent>): void;
on(event: "tool_call", handler: ExtensionHandler<ToolCallEvent, ToolCallEventResult>): void;
on(event: "tool_result", handler: ExtensionHandler<ToolResultEvent, ToolResultEventResult>): void;
on(event: "user_bash", handler: ExtensionHandler<UserBashEvent, UserBashEventResult>): void;
on(event: "input", handler: ExtensionHandler<InputEvent, InputEventResult>): void;
/** Register a tool that the LLM can call. */
registerTool<TParams extends TSchema = TSchema, TDetails = unknown, TState = unknown>(tool: ToolDefinition$1<TParams, TDetails, TState>): void;
/** Register a custom command. */
registerCommand(name: string, options: Omit<RegisteredCommand, "name" | "sourceInfo">): void;
/** Register a keyboard shortcut. */
registerShortcut(shortcut: KeyId, options: {
description?: string;
handler: (ctx: ExtensionContext) => Promise<void> | void;
}): void;
/** Register a CLI flag. */
registerFlag(name: string, options: {
description?: string;
type: "boolean" | "string";
default?: boolean | string;
}): void;
/** Get the value of a registered CLI flag. */
getFlag(name: string): boolean | string | undefined;
/** Register a custom renderer for CustomMessageEntry. */
registerMessageRenderer<T = unknown>(customType: string, renderer: MessageRenderer<T>): void;
/** Send a custom message to the session. */
sendMessage<T = unknown>(message: Pick<CustomMessage<T>, "customType" | "content" | "display" | "details">, options?: {
triggerTurn?: boolean;
deliverAs?: "steer" | "followUp" | "nextTurn";
}): void;
/**
* Send a user message to the agent. Always triggers a turn.
* When the agent is streaming, use deliverAs to specify how to queue the message.
*/
sendUserMessage(content: string | (TextContent | ImageContent$1)[], options?: {
deliverAs?: "steer" | "followUp";
}): void;
/** Append a custom entry to the session for state persistence (not sent to LLM). */
appendEntry(customType: string, data?: unknown): void;
/** Set the session display name (shown in session selector). */
setSessionName(name: string): void;
/** Get the current session name, if set. */
getSessionName(): string | undefined;
/** Set or clear a label on an entry. Labels are user-defined markers for bookmarking/navigation. */
setLabel(entryId: string, label: string | undefined): void;
/** Execute a shell command. */
exec(command: string, args: string[], options?: ExecOptions): Promise<ExecResult>;
/** Get the list of currently active tool names. */
getActiveTools(): string[];
/** Get all configured tools with parameter schema and source metadata. */
getAllTools(): ToolInfo[];
/** Set the active tools by name. */
setActiveTools(toolNames: string[]): void;
/** Get available slash commands in the current session. */
getCommands(): SlashCommandInfo[];
/** Set the current model. Returns false if no API key available. */
setModel(model: Model): Promise<boolean>;
/** Get current thinking level. */
getThinkingLevel(): ThinkingLevel;
/** Set thinking level (clamped to model capabilities). */
setThinkingLevel(level: ThinkingLevel): Promise<void>;
/**
* Register a model provider.
*
* If `models` is provided: replaces all existing models for this provider.
* If `oauth` is provided: registers OAuth provider for /login support.
* If `streamSimple` is provided: registers a custom API stream handler.
*
* During initial extension load this call is queued and applied once the
* runner has bound its context. After that it takes effect immediately, so
* it is safe to call from command handlers or event callbacks without
* requiring a `/reload`.
*
* @example
* // Register a new provider with custom models
* api.registerProvider("my-proxy", {
* baseUrl: "https://proxy.example.com",
* apiKey: "PROXY_API_KEY",
* api: "anthropic-messages",
* models: [
* {
* id: "claude-sonnet-4-20250514",
* name: "Claude 4 Sonnet (proxy)",
* reasoning: false,
* input: ["text", "image"],
* cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
* contextWindow: 200000,
* maxTokens: 16384
* }
* ]
* });
*
* @example
* // Override baseUrl for an existing provider
* api.registerProvider("anthropic", {
* baseUrl: "https://proxy.example.com"
* });
*
* @example
* // Register provider with OAuth support
* api.registerProvider("corporate-ai", {
* baseUrl: "https://ai.corp.com",
* api: "openai-responses",
* models: [...],
* oauth: {
* name: "Corporate AI (SSO)",
* async login(callbacks) { ... },
* async refreshToken(credentials) { ... },
* getApiKey(credentials) { return credentials.access; }
* }
* });
*/
registerProvider(name: string, config: ProviderConfig): void;
/**
* Unregister a previously registered provider.
*
* Removes all models belonging to the named provider and reloads the configured
* model registry. Has no effect if the provider is not currently registered.
*
* Like `registerProvider`, this takes effect immediately when called after
* the initial load phase.
*
* @example
* api.unregisterProvider("my-proxy");
*/
unregisterProvider(name: string): void;
/** Shared event bus for extension communication. */
events: EventBus;
}
/** Configuration for registering a provider via api.registerProvider(). */
interface ProviderConfig extends ProviderConfigBase {
/** Models to register. If provided, replaces all existing models for this provider. */
models?: ProviderModelConfig[];
/** OAuth provider for /login support. The `id` is set automatically from the provider name. */
oauth?: {
/** Display name for the provider in login UI. */
name: string;
/** Run the login flow, return credentials to persist. */
login(callbacks: OAuthLoginCallbacks): Promise<OAuthCredentials>;
/** Refresh expired credentials, return updated credentials to persist. */
refreshToken(credentials: OAuthCredentials): Promise<OAuthCredentials>;
/** Convert credentials to API key string for the provider. */
getApiKey(credentials: OAuthCredentials): string;
/** Optional: modify models for this provider (e.g., update baseUrl based on credentials). */
modifyModels?(models: Model[], credentials: OAuthCredentials): Model[];
};
}
interface RegisteredTool {
definition: ToolDefinition$1;
sourceInfo: SourceInfo;
}
interface ExtensionFlag {
name: string;
description?: string;
type: "boolean" | "string";
default?: boolean | string;
extensionPath: string;
}
interface ExtensionShortcut {
shortcut: KeyId;
description?: string;
handler: (ctx: ExtensionContext) => Promise<void> | void;
extensionPath: string;
}
type HandlerFn = (...args: unknown[]) => Promise<unknown>;
type RefreshToolsHandler = () => void;
/** Tool info with name, description, parameter schema, and source metadata */
type ToolInfo = Pick<ToolDefinition$1, "name" | "description" | "parameters"> & {
sourceInfo: SourceInfo;
};
/**
* Shared state created by loader, used during registration and runtime.
* Contains flag values (defaults set during registration, CLI values set after).
*/
interface ExtensionRuntimeState {
flagValues: Map<string, boolean | string>;
/** Provider registrations queued during extension loading, processed when runner binds */
pendingProviderRegistrations: Array<{
name: string;
config: ProviderConfig;
extensionPath: string;
}>;
/** Throws when this extension instance is stale after runtime replacement. */
assertActive: () => void;
/** Marks this extension instance as stale after runtime replacement or reload. */
invalidate: (message?: string) => void;
/**
* Register or unregister a provider.
*
* Before bindCore(): queues registrations / removes from queue.
* After bindCore(): calls ModelRegistry directly for immediate effect.
*/
registerProvider: (name: string, config: ProviderConfig, extensionPath?: string) => void;
unregisterProvider: (name: string, extensionPath?: string) => void;
}
/**
* Action implementations for ExtensionAPI methods.
* Provided to runner.initialize(), copied into the shared runtime.
*/
interface ExtensionActions extends Pick<ExtensionAPI, "sendMessage" | "sendUserMessage" | "appendEntry" | "setSessionName" | "getSessionName" | "setLabel" | "getActiveTools" | "getAllTools" | "setActiveTools" | "getCommands" | "setModel" | "getThinkingLevel" | "setThinkingLevel"> {
refreshTools: RefreshToolsHandler;
}
/** Actions for the live extension context, supplied by each runtime mode. */
interface ExtensionContextActions extends Pick<ExtensionContext, "isIdle" | "abort" | "hasPendingMessages" | "shutdown" | "getContextUsage" | "compact" | "getSystemPrompt"> {
getModel: () => ExtensionContext["model"];
getSignal: () => ExtensionContext["signal"];
}
/** Session controls provided by modes that support extension commands. */
interface ExtensionCommandContextActions extends Pick<ExtensionCommandContext, "waitForIdle" | "newSession" | "fork" | "navigateTree" | "switchSession" | "reload"> {}
/**
* Full runtime = state + actions.
* Created by loader with throwing action stubs, completed by runner.initialize().
*/
interface ExtensionRuntime extends ExtensionRuntimeState, ExtensionActions {}
/** Loaded extension with all registered items. */
interface Extension {
path: string;
resolvedPath: string;
sourceInfo: SourceInfo;
handlers: Map<string, HandlerFn[]>;
tools: Map<string, RegisteredTool>;
messageRenderers: Map<string, MessageRenderer>;
commands: Map<string, RegisteredCommand>;
flags: Map<string, ExtensionFlag>;
shortcuts: Map<KeyId, ExtensionShortcut>;
}
/** Result of loading extensions. */
interface LoadExtensionsResult {
extensions: Extension[];
errors: Array<{
path: string;
error: string;
}>;
/** Shared runtime - actions are throwing stubs until runner.initialize() */
runtime: ExtensionRuntime;
}
interface ExtensionError {
extensionPath: string;
event: string;
error: string;
stack?: string;
}
//#endregion
//#region src/agents/sessions/extensions/runner.d.ts
/** Combined result from all before_agent_start handlers */
interface BeforeAgentStartCombinedResult {
messages?: NonNullable<BeforeAgentStartEventResult["message"]>[];
systemPrompt?: string;
}
/**
* Events handled by the generic emit() method.
* Events with dedicated emitXxx() methods are excluded for stronger type safety.
*/
type RunnerEmitEvent = Exclude<ExtensionEvent, ToolCallEvent | ToolResultEvent | UserBashEvent | ContextEvent | BeforeProviderRequestEvent | BeforeAgentStartEvent | MessageEndEvent | ResourcesDiscoverEvent | InputEvent>;
type RunnerEmitResult<TEvent extends RunnerEmitEvent> = TEvent extends {
type: "session_before_switch";
} ? SessionBeforeSwitchResult | undefined : TEvent extends {
type: "session_before_fork";
} ? SessionBeforeForkResult | undefined : TEvent extends {
type: "session_before_compact";
} ? SessionBeforeCompactResult | undefined : TEvent extends {
type: "session_before_tree";
} ? SessionBeforeTreeResult | undefined : undefined;
type ExtensionErrorListener = (error: ExtensionError) => void;
type ShutdownHandler = () => void;
declare class ExtensionRunner {
private extensions;
private runtime;
private cwd;
private sessionManager;
private modelRegistry;
private uiContext;
private errorListeners;
private getModel;
private isIdleFn;
private getSignalFn;
private waitForIdleFn;
private abortFn;
private hasPendingMessagesFn;
private getContextUsageFn;
private compactFn;
private getSystemPromptFn;
private newSessionHandler;
private forkHandler;
private navigateTreeHandler;
private switchSessionHandler;
private reloadHandler;
private shutdownHandler;
private shortcutDiagnostics;
private commandDiagnostics;
private staleMessage;
constructor(extensions: Extension[], runtime: ExtensionRuntime, cwd: string, sessionManager: SessionManager, modelRegistry: ModelRegistry$1);
bindCore(actions: ExtensionActions, contextActions: ExtensionContextActions, providerActions?: {
registerProvider?: (name: string, config: ProviderConfig) => void;
unregisterProvider?: (name: string) => void;
}): void;
bindCommandContext(actions?: ExtensionCommandContextActions): void;
setUIContext(uiContext?: ExtensionUIContext): void;
getUIContext(): ExtensionUIContext;
hasUI(): boolean;
getExtensionPaths(): string[];
/** Get all registered tools from all extensions (first registration per name wins). */
getAllRegisteredTools(): RegisteredTool[];
/** Get a tool definition by name. Returns undefined if not found. */
getToolDefinition(toolName: string): RegisteredTool["definition"] | undefined;
getFlags(): Map<string, ExtensionFlag>;
setFlagValue(name: string, value: boolean | string): void;
getFlagValues(): Map<string, boolean | string>;
getShortcuts(resolvedKeybindings: KeybindingsConfig): Map<KeyId, ExtensionShortcut>;
getShortcutDiagnostics(): ResourceDiagnostic[];
invalidate(message?: string): void;
private requireActive;
onError(listener: ExtensionErrorListener): () => void;
emitError(error: ExtensionError): void;
hasHandlers(eventType: string): boolean;
getMessageRenderer(customType: string): MessageRenderer | undefined;
private resolveRegisteredCommands;
getRegisteredCommands(): ResolvedCommand[];
getCommandDiagnostics(): ResourceDiagnostic[];
getCommand(name: string): ResolvedCommand | undefined;
/**
* Request a graceful shutdown. Called by extension tools and event handlers.
* The actual shutdown behavior is provided by the mode via bindExtensions().
*/
shutdown(): void;
/**
* Create an ExtensionContext for use in event handlers and tool execution.
* Context values are resolved at call time, so changes via bindCore/bindUI are reflected.
*/
createContext(): ExtensionContext;
createCommandContext(): ExtensionCommandContext;
private isSessionBeforeEvent;
private dispatchHandlers;
emit<TEvent extends RunnerEmitEvent>(event: TEvent): Promise<RunnerEmitResult<TEvent>>;
emitMessageEnd(event: MessageEndEvent): Promise<AgentMessage | undefined>;
emitToolResult(event: ToolResultEvent): Promise<ToolResultEventResult | undefined>;
emitToolCall(event: ToolCallEvent): Promise<ToolCallEventResult | undefined>;
emitUserBash(event: UserBashEvent): Promise<UserBashEventResult | undefined>;
emitContext(messages: AgentMessage[]): Promise<AgentMessage[]>;
emitBeforeProviderRequest(payload: unknown): Promise<unknown>;
emitBeforeAgentStart(prompt: string, images: ImageContent$1[] | undefined, systemPrompt: string, systemPromptOptions: BuildSystemPromptOptions): Promise<BeforeAgentStartCombinedResult | undefined>;
emitResourcesDiscover(cwd: string, reason: ResourcesDiscoverEvent["reason"]): Promise<{
skillPaths: Array<{
path: string;
extensionPath: string;
}>;
promptPaths: Array<{
path: string;
extensionPath: string;
}>;
themePaths: Array<{
path: string;
extensionPath: string;
}>;
}>;
/** Emit input event. Transforms chain, "handled" short-circuits. */
emitInput(text: string, images: ImageContent$1[] | undefined, source: InputSource): Promise<InputEventResult>;
}
//#endregion
//#region src/agents/sessions/prompt-templates.d.ts
/**
* Represents a prompt template loaded from a markdown file
*/
interface PromptTemplate {
name: string;
description: string;
argumentHint?: string;
content: string;
sourceInfo: SourceInfo;
filePath: string;
}
//#endregion
//#region src/agents/sessions/settings-storage.d.ts
interface CompactionSettings {
enabled?: boolean;
reserveTokens?: number;
keepRecentTokens?: number;
}
interface BranchSummarySettings {
reserveTokens?: number;
skipPrompt?: boolean;
}
interface ProviderRetrySettings {
timeoutMs?: number;
maxRetries?: number;
maxRetryDelayMs?: number;
}
interface RetrySettings {
enabled?: boolean;
maxRetries?: number;
baseDelayMs?: number;
provider?: ProviderRetrySettings;
}
interface TerminalSettings {
showImages?: boolean;
imageWidthCells?: number;
clearOnShrink?: boolean;
showTerminalProgress?: boolean;
}
interface ImageSettings {
autoResize?: boolean;
blockImages?: boolean;
}
interface ThinkingBudgetsSettings {
minimal?: number;
low?: number;
medium?: number;
high?: number;
max?: number;
}
interface MarkdownSettings {
codeBlockIndent?: string;
}
interface WarningSettings {
anthropicExtraUsage?: boolean;
}
type TransportSetting = Transport;
/**
* Package source for npm/git packages.
* - String form: load all resources from the package
* - Object form: filter which resources to load
*/
type PackageSource = string | {
source: string;
extensions?: string[];
skills?: string[];
prompts?: string[];
themes?: string[];
};
interface Settings {
lastChangelogVersion?: string;
defaultProvider?: string;
defaultModel?: string;
defaultThinkingLevel?: "off" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max";
transport?: TransportSetting;
steeringMode?: "all" | "one-at-a-time";
followUpMode?: "all" | "one-at-a-time";
theme?: string;
compaction?: CompactionSettings;
branchSummary?: BranchSummarySettings;
retry?: RetrySettings;
hideThinkingBlock?: boolean;
shellPath?: string;
quietStartup?: boolean;
shellCommandPrefix?: string;
npmCommand?: string[];
collapseChangelog?: boolean;
enableInstallTelemetry?: boolean;
packages?: PackageSource[];
extensions?: string[];
skills?: string[];
prompts?: string[];
themes?: string[];
enableSkillCommands?: boolean;
terminal?: TerminalSettings;
images?: ImageSettings;
enabledModels?: string[];
doubleEscapeAction?: "fork" | "tree" | "none";
treeFilterMode?: "default" | "no-tools" | "user-only" | "labeled-only" | "all";
thinkingBudgets?: ThinkingBudgetsSettings;
editorPaddingX?: number;
autocompleteMaxVisible?: number;
showHardwareCursor?: boolean;
markdown?: MarkdownSettings;
warnings?: WarningSettings;
sessionDir?: string;
httpIdleTimeoutMs?: number;
}
type SettingsScope = "global" | "project";
interface SettingsStorage {
/** Pure scope reads; existing custom backends may serve reads through withLock. */
readSettingsScope?(scope: SettingsScope): string | undefined;
withLock(scope: SettingsScope, fn: (current: string | undefined) => string | undefined): void;
}
interface SettingsError {
scope: SettingsScope;
error: Error;
}
//#endregion
//#region src/agents/sessions/settings-manager.d.ts
declare class SettingsManager {
private storage;
private scopes;
private settings;
private runtimeOverrides;
private writeQueue;
private errors;
private constructor();
/** Create a SettingsManager that loads from files */
static create(cwd: string, agentDir?: string): SettingsManager;
/** Create a SettingsManager from an arbitrary storage backend */
static fromStorage(storage: SettingsStorage): SettingsManager;
/** Create an in-memory SettingsManager (no file I/O) */
static inMemory(settings?: Partial<Settings>): SettingsManager;
private static loadScope;
private static createScopeState;
/** Migrate old settings format to new format */
private static migrateSettings;
getGlobalSettings(): Settings;
getProjectSettings(): Settings;
private recomputeSettings;
reload(): Promise<void>;
/** Apply non-persisted overrides on top of global/project settings. */
applyOverrides(overrides: Partial<Settings>): void;
private markModified;
private recordError;
private enqueueWrite;
private persistScopedSettings;
private save;
private setScopedSetting;
private setGlobalNestedSetting;
flush(): Promise<void>;
drainErrors(): SettingsError[];
getLastChangelogVersion(): string | undefined;
setLastChangelogVersion(version: string): void;
getSessionDir(): string | undefined;
getDefaultProvider(): string | undefined;
getDefaultModel(): string | undefined;
setDefaultProvider(provider: string): void;
setDefaultModel(modelId: string): void;
setDefaultModelAndProvider(provider: string, modelId: string): void;
getSteeringMode(): "all" | "one-at-a-time";
setSteeringMode(mode: "all" | "one-at-a-time"): void;
getFollowUpMode(): "all" | "one-at-a-time";
setFollowUpMode(mode: "all" | "one-at-a-time"): void;
getTheme(): string | undefined;
setTheme(theme: string): void;
getDefaultThinkingLevel(): Settings["defaultThinkingLevel"];
setDefaultThinkingLevel(level: NonNullable<Settings["defaultThinkingLevel"]>): void;
getTransport(): TransportSetting;
setTransport(transport: TransportSetting): void;
getCompactionEnabled(): boolean;
setCompactionEnabled(enabled: boolean): void;
getCompactionReserveTokens(): number;
getCompactionKeepRecentTokens(): number;
getCompactionSettings(): {
enabled: boolean;
reserveTokens: number;
keepRecentTokens: number;
};
getBranchSummarySettings(): {
reserveTokens: number;
skipPrompt: boolean;
};
getBranchSummarySkipPrompt(): boolean;
getRetryEnabled(): boolean;
setRetryEnabled(enabled: boolean): void;
getRetrySettings(): {
enabled: boolean;
maxRetries: number;
baseDelayMs: number;
};
getHttpIdleTimeoutMs(): number;
setHttpIdleTimeoutMs(timeoutMs: number): void;
getProviderRetrySettings(): {
timeoutMs?: number;
maxRetries?: number;
maxRetryDelayMs: number;
};
getHideThinkingBlock(): boolean;
setHideThinkingBlock(hide: boolean): void;
getShellPath(): string | undefined;
setShellPath(path: string | undefined): void;
getQuietStartup(): boolean;
setQuietStartup(quiet: boolean): void;
getShellCommandPrefix(): string | undefined;
setShellCommandPrefix(prefix: string | undefined): void;
getNpmCommand(): string[] | undefined;
setNpmCommand(command: string[] | undefined): void;
getCollapseChangelog(): boolean;
setCollapseChangelog(collapse: boolean): void;
getEnableInstallTelemetry(): boolean;
setEnableInstallTelemetry(enabled: boolean): void;
getPackages(): PackageSource[];
setPackages(packages: PackageSource[]): void;
setProjectPackages(packages: PackageSource[]): void;
getExtensionPaths(): string[];
setExtensionPaths(paths: string[]): void;
setProjectExtensionPaths(paths: string[]): void;
getSkillPaths(): string[];
setSkillPaths(paths: string[]): void;
setProjectSkillPaths(paths: string[]): void;
getPromptTemplatePaths(): string[];
setPromptTemplatePaths(paths: string[]): void;
setProjectPromptTemplatePaths(paths: string[]): void;
getThemePaths(): string[];
setThemePaths(paths: string[]): void;
setProjectThemePaths(paths: string[]): void;
getEnableSkillCommands(): boolean;
setEnableSkillCommands(enabled: boolean): void;
getThinkingBudgets(): ThinkingBudgetsSettings | undefined;
getShowImages(): boolean;
setShowImages(show: boolean): void;
getImageWidthCells(): number;
setImageWidthCells(width: number): void;
getClearOnShrink(): boolean;
setClearOnShrink(enabled: boolean): void;
getShowTerminalProgress(): boolean;
setShowTerminalProgress(enabled: boolean): void;
getImageAutoResize(): boolean;
setImageAutoResize(enabled: boolean): void;
getBlockImages(): boolean;
setBlockImages(blocked: boolean): void;
getEnabledModels(): string[] | undefined;
setEnabledModels(patterns: string[] | undefined): void;
getDoubleEscapeAction(): "fork" | "tree" | "none";
setDoubleEscapeAction(action: "fork" | "tree" | "none"): void;
getTreeFilterMode(): "default" | "no-tools" | "user-only" | "labeled-only" | "all";
setTreeFilterMode(mode: "default" | "no-tools" | "user-only" | "labeled-only" | "all"): void;
getShowHardwareCursor(): boolean;
setShowHardwareCursor(enabled: boolean): void;
getEditorPaddingX(): number;
setEditorPaddingX(padding: number): void;
getAutocompleteMaxVisible(): number;
setAutocompleteMaxVisible(maxVisible: number): void;
getCodeBlockIndent(): string;
getWarnings(): WarningSettings;
setWarnings(warnings: WarningSettings): void;
}
//#endregion
//#region src/agents/sessions/resource-loader.d.ts
interface ResourceExtensionPaths {
skillPaths?: Array<{
path: string;
metadata: PathMetadata;
}>;
promptPaths?: Array<{
path: string;
metadata: PathMetadata;
}>;
themePaths?: Array<{
path: string;
metadata: PathMetadata;
}>;
}
interface ResourceLoader {
getExtensions(): LoadExtensionsResult;
getSkills(): {
skills: Skill[];
diagnostics: ResourceDiagnostic[];
};
getPrompts(): {
prompts: PromptTemplate[];
diagnostics: ResourceDiagnostic[];
};
getThemes(): {
themes: Theme[];
diagnostics: ResourceDiagnostic[];
};
getAgentsFiles(): {
agentsFiles: Array<{
path: string;
content: string;
}>;
};
getSystemPrompt(): string | undefined;
getAppendSystemPrompt(): string[];
extendResources(paths: ResourceExtensionPaths): void;
reload(): Promise<void>;
}
//#endregion
//#region src/agents/sessions/agent-session-types.d.ts
type AgentSessionCompactionOutcome = {
status: "completed";
tokensBefore: number;
tokensAfter: number;
willRetry: boolean;
} | {
status: "skipped";
reason: string;
} | {
status: "failed";
reason: string;
} | {
status: "aborted";
};
type AgentSessionCompactionEndEvent = {
type: "compaction_end";
itemId?: string;
reason: "manual" | "threshold" | "overflow";
outcome: AgentSessionCompactionOutcome;
};
type AgentSessionEvent = Exclude<AgentEvent, {
type: "agent_end";
}> | {
type: "agent_end";
messages: AgentMessage[];
willRetry: boolean;
assistantEntryId?: string;
} | {
type: "queue_update";
steering: readonly string[];
followUp: readonly string[];
} | {
type: "agent_settled";
} | {
type: "agent_handoff";
} | {
type: "compaction_start";
reason: "manual" | "threshold" | "overflow";
itemId?: string;
} | {
type: "session_info_changed";
name: string | undefined;
} | {
type: "thinking_level_changed";
level: ThinkingLevel;
} | AgentSessionCompactionEndEvent | {
type: "auto_retry_start";
attempt: number;
maxAttempts: number;
delayMs: number;
errorMessage: string;
} | {
type: "auto_retry_end";
success: boolean;
attempt: number;
finalError?: string;
};
type AgentSessionEventListener = (event: AgentSessionEvent) => unknown;
type AgentSessionWriteSettlementRunner = <T>(run: () => Promise<T> | T) => Promise<T>;
interface AgentSessionConfig {
agent: Agent$1;
sessionManager: SessionManager;
settingsManager: SettingsManager;
cwd: string;
/** Resource loader for skills, prompts, themes, context files, and system prompt. */
resourceLoader: ResourceLoader;
/** SDK custom tools registered outside extensions. */
customTools?: ToolDefinition$1[];
/** Model registry for API key resolution and model discovery. */
modelRegistry: ModelRegistry$1;
/** Initial active built-in tool names. Defaults to read, bash, edit, and write. */
initialActiveToolNames?: string[];
/** Optional tool allowlist. */
allowedToolNames?: string[];
/** Exclude built-in shell and filesystem tools from the registry. */
disableBuiltInTools?: boolean;
/** Override base tools for custom runtimes. */
baseToolsOverride?: Record<string, AgentTool>;
/** Mutable reference used by Agent to access the current extension runner. */
extensionRunnerRef?: {
current?: ExtensionRunner;
};
/** Session start metadata emitted when extensions bind to this runtime. */
sessionStartEvent?: SessionStartEvent;
/** Settlement boundary for session writes and write-capable hooks. */
withSessionWriteSettlement?: AgentSessionWriteSettlementRunner;
/** Owner of reactive context-overflow recovery. Defaults to the session. */
contextOverflowRecoveryOwner?: "session" | "caller";
/** Whether disposing this object ends the durable provider session. Defaults to true. */
cleanupProviderSessionResourcesOnDispose?: boolean;
}
interface ExtensionBindings {
uiContext?: ExtensionUIContext;
commandContextActions?: ExtensionCommandContextActions;
abortHandler?: () => void;
shutdownHandler?: ShutdownHandler;
onError?: ExtensionErrorListener;
}
interface PromptOptions {
/** Expand file-based prompt templates. Defaults to true. */
expandPromptTemplates?: boolean;
/** Image attachments. */
images?: ImageContent$1[];
/** Queue behavior when an agent is already streaming. */
streamingBehavior?: "steer" | "followUp";
/** Source of input for extension input handlers. Defaults to interactive. */
source?: InputSource;
/** Internal RPC hook for prompt preflight acceptance or rejection. */
preflightResult?: (success: boolean) => void;
/** Internal identity for a current user turn that is already durable. */
persistedUserIdempotencyKey?: string;
}
//#endregion
//#region src/agents/sessions/compaction/request-budget.d.ts
/** Ephemeral foreground facts; a separately routed summarizer cannot reconstruct these. */
type CompactionRequestBudget = Readonly<{
contextWindow: number;
reserveTokens: number;
fixedTokens: number;
pendingTokens: number;
/** Known queue reservation, replaced by the SDK's projected queue at submission. */
pendingQueuedContextTokens?: number;
/** Overlap credit applies only to the user body, never newly added context. */
pendingUserTokens?: number;
pendingUserIdempotencyKey?: string;
}>;
/** Input preservation exists before the foreground prompt can supply a token budget. */
type CompactionRequestConstraints = Readonly<{
requestBudget?: CompactionRequestBudget;
pendingUserEntryId?: string;
}>;
//#endregion
//#region src/agents/sessions/agent-session-base.d.ts
interface ToolDefinitionEntry {
definition: ToolDefinition$1;
sourceInfo: SourceInfo;
}
type ActiveToolPromptMetadata = {
validToolNames: string[];
toolSnippets: Record<string, string>;
promptGuidelines: string[];
};
declare abstract class AgentSessionBase {
readonly agent: Agent$1;
readonly sessionManager: SessionManager;
readonly settingsManager: SettingsManager;
protected unsubscribeAgent?: () => void;
private eventListeners;
/** Tracks pending steering messages for UI display. Removed when delivered. */
protected steeringMessages: Array<{
text: string;
}>;
/** Tracks pending follow-up messages for UI display. Removed when delivered. */
protected followUpMessages: Array<{
text: string;
}>;
/** Messages queued to be included with the next user prompt as context ("asides"). */
protected pendingNextTurnMessages: CustomMessage[];
protected compactionAbortController: AbortController | undefined;
protected autoCompactionAbortController: AbortController | undefined;
protected overflowRecoveryAttempts: number;
protected contextOverflowRecoveryOwner: "session" | "caller";
protected branchSummaryAbortController: AbortController | undefined;
private extensionModifiedToolResultIds;
protected retryAbortController: AbortController | undefined;
protected retryCount: number;
protected currentExtensionRunner: ExtensionRunner;
private turnIndex;
protected sessionResourceLoader: ResourceLoader;
protected customTools: ToolDefinition$1[];
protected baseToolDefinitions: Map<string, ToolDefinition$1>;
protected cwd: string;
protected extensionRunnerRef?: {
current?: ExtensionRunner;
};
protected initialActiveToolNames?: string[];
protected allowedToolNames?: Set<string>;
protected disableBuiltInTools: boolean;
protected baseToolsOverride?: Record<string, AgentTool>;
protected sessionStartEvent: SessionStartEvent;
protected withExternalSessionWriteSettlement?: AgentSessionWriteSettlementRunner;
protected extensionUIContext?: ExtensionUIContext;
protected extensionCommandContextActions?: ExtensionCommandContextActions;
protected extensionAbortHandler?: () => void;
protected extensionShutdownHandler?: ShutdownHandler;
protected extensionErrorListener?: ExtensionErrorListener;
protected extensionErrorUnsubscriber?: () => void;
private readonly cleanupProviderSessionResourcesOnDispose;
protected sessionModelRegistry: ModelRegistry$1;
protected toolRegistry: Map<string, AgentTool>;
protected toolDefinitions: Map<string, ToolDefinitionEntry>;
protected toolPromptSnippets: Map<string, string>;
protected toolPromptGuidelines: Map<string, string[]>;
protected baseSystemPrompt: string;
protected baseSystemPromptOptions: BuildSystemPromptOptions;
protected exactBaseSystemPrompt: string | undefined;
protected systemPromptOverride: string | undefined;
constructor(config: AgentSessionConfig);
/** Model registry for API key resolution and model discovery */
get modelRegistry(): ModelRegistry$1;
protected getRequiredRequestAuth(model: Model): Promise<{
apiKey: string;
headers?: Record<string, string>;
}>;
protected getCompactionRequestAuth(model: Model): Promise<{
apiKey?: string;
headers?: Record<string, string>;
}>;
protected runWithSessionWriteSettlement<T>(run: () => Promise<T> | T): Promise<T>;
private eventMayWriteSession;
/**
* Install tool hooks once on the Agent instance.
*
* The callbacks read `this.currentExtensionRunner` at execution time, so extension reload swaps in the
* new runner without reinstalling hooks. Extension-specific tool wrappers are still used to adapt
* registered tool execution to the extension context. Tool call and tool result interception now
* happens here instead of in wrappers.
*/
protected installAgentToolHooks(): void;
/** Copy-on-write listener registration keeps dispatch stable without per-event snapshots. */
protected emit(event: AgentSessionEvent): void;
/** Terminal listeners form a barrier before retry, compaction, or queue draining. */
private emitTerminal;
protected emitQueueUpdate(): void;
protected trackQueuedUserMessage(message: AgentMessage, owner: "steering" | "followUp", text: string): void;
protected lastAssistantMessage: AssistantMessage$1 | undefined;
private lastAssistantEntryId;
protected lastRunEndedForTurnHandoff: boolean;
/** Internal handler for agent events - shared by subscribe and reconnect */
protected handleAgentEvent: (event: AgentEvent, signal?: AbortSignal) => Promise<void>;
private handleAgentEventUnlocked;
private willRetryAfterAgentEnd;
/** Find the last assistant message in agent state (including aborted ones) */
protected findLastAssistantMessage(): AssistantMessage$1 | undefined;
/** Emit extension events based on agent events */
private emitExtensionEvent;
/**
* Subscribe to agent events.
* Session persistence is handled internally (saves messages on message_end).
* Multiple listeners can be added. Returns unsubscribe function for this listener.
*/
subscribe(listener: AgentSessionEventListener): () => void;
/**
* Temporarily disconnect from agent events.
* User listeners are preserved and will receive events again after resubscribe().
* Used internally during operations that need to pause event processing.
*/
protected disconnectFromAgent(): void;
/**
* Reconnect to agent events after disconnectFromAgent().
* Preserves all existing listeners.
*/
protected reconnectToAgent(): void;
/**
* Remove all listeners and disconnect from agent.
* Call this when completely done with the session.
*/
dispose(): void;
/** Full agent state */
get state(): AgentState;
/** Current model (may be undefined if not yet selected) */
get model(): Model | undefined;
/** Current thinking level */
get thinkingLevel(): ThinkingLevel;
/** Whether agent is currently streaming a response */
get isStreaming(): boolean;
/** Current effective system prompt (includes any per-turn extension modifications) */
get systemPrompt(): string;
/** Current retry attempt (0 if not retrying) */
get retryAttempt(): number;
/**
* Get the names of currently active tools.
* Returns the names of tools currently set on the agent.
*/
getActiveToolNames(): string[];
/**
* Get all configured tools with name, description, parameter schema, and source metadata.
*/
getAllTools(): ToolInfo[];
getToolDefinition(name: string): ToolDefinition$1 | undefined;
/**
* Set active tools by name.
* Only tools in the registry can be enabled. Unknown tool names are ignored.
* Also rebuilds the system prompt to reflect the new tool set.
* Changes take effect on the next agent turn.
*/
setActiveToolsByName(toolNames: string[]): void;
/** Set an exact base prompt owned by the current runtime. */
setBaseSystemPrompt(systemPrompt: string): void;
/** Whether compaction or branch summarization is currently running */
get isCompacting(): boolean;
/** All messages including custom types like BashExecutionMessage */
get messages(): AgentMessage[];
/** Current steering mode */
get steeringMode(): "all" | "one-at-a-time";
/** Current follow-up mode */
get followUpMode(): "all" | "one-at-a-time";
/** Current persisted transcript target, or undefined for in-memory sessions. */
get sessionTarget(): SessionTranscriptTargetBinding | undefined;
/** Current persisted session key, or undefined for in-memory sessions. */
get sessionKey(): string | undefined;
/** @deprecated Compatibility token; returns the session key, not a file path. */
get sessionFile(): string | undefined;
/** Current session ID */
get sessionId(): string;
/** Current session display name, if set */
get sessionName(): string | undefined;
/** File-based prompt templates */
get promptTemplates(): ReadonlyArray<PromptTemplate>;
protected normalizePromptSnippet(text: string | undefined): string | undefined;
protected normalizePromptGuidelines(guidelines: string[] | undefined): string[];
protected collectActiveToolPromptMetadata(toolNames: string[]): ActiveToolPromptMetadata;
protected rebuildSystemPrompt(toolNames: string[]): string;
protected abstract isRetryableError(message: AssistantMessage$1): boolean;
protected abstract prepareRetry(message: AssistantMessage$1): Promise<boolean>;
protected abstract checkCompaction(assistantMessage: AssistantMessage$1, skipAbortedCheck?: boolean, requestBudget?: CompactionRequestBudget): Promise<boolean>;
abstract abortRetry(): void;
abstract abortCompaction(): void;
abstract abortBranchSummary(): void;
}
//#endregion
//#region src/agents/sessions/agent-session-prompting.d.ts
/** @internal Host preparation runs after SDK prompt hooks and owns its run cancellation. */
declare const agentSessionSetPromptPreparation: unique symbol;
/** @internal Queue prompt-owned context with cleanup for preflight exits. */
declare const agentSessionQueuePromptContext: unique symbol;
declare abstract class AgentSessionPrompting extends AgentSessionBase {
private logicalPromptActive;
private promptPreparation?;
[agentSessionQueuePromptContext](message: CustomMessage): () => void;
[agentSessionSetPromptPreparation](prepare: (() => Promise<void | (() => void)>) | undefined): void;
dispose(): void;
private runAgentPrompt;
private runPreparedAgentLoop;
private handlePostAgentRun;
private createUserMessage;
/**
* Send a prompt to the agent.
* - Handles extension commands immediately, even during streaming
* - Expands file-based prompt templates by default
* - During streaming, queues via steer() or followUp() based on streamingBehavior option
* - Validates model and API key before sending (when not streaming)
* @throws Error if streaming and no streamingBehavior specified
* @throws Error if no model selected or no API key available (when not streaming)
*/
prompt(text: string, options?: PromptOptions): Promise<void>;
/**
* Try to execute an extension command. Returns true if command was found and executed.
*/
private tryExecuteExtensionCommand;
/**
* Expand skill commands (/skill:name args) to their full content.
* Returns the expanded text, or the original text if not a skill command or skill not found.
* Emits errors via extension runner if file read fails.
*/
private expandSkillCommand;
private expandPrompt;
/**
* Queue a steering message while the agent is running.
* Delivered before the next unstarted tool launch or model call. Running tools
* continue; suppressed calls receive paired synthetic results.
* Expands skill commands and prompt templates. Errors on extension commands.
* @param images Optional image attachments to include with the message
* @param userTurnTranscriptRecorder Prepared channel fields for transcript-only persistence
* @param currentInboundContext This turn's runtime facts, separate from its command and transcript
* @throws Error if text is an extension command
*/
steer(text: string, images?: ImageContent$1[], userTurnTranscriptRecorder?: UserTurnTranscriptRecorder, media?: MediaFact[], imageOrder?: PromptImageOrderEntry[], queueIdentity?: string, canInject?: () => boolean, currentInboundContext?: CurrentInboundPromptContext): Promise<void>;
/**
* Queue a follow-up message to be processed after the agent finishes.
* Delivered only when agent has no more tool calls or steering messages.
* Expands skill commands and prompt templates. Errors on extension commands.
* @param images Optional image attachments to include with the message
* @throws Error if text is an extension command
*/
followUp(text: string, images?: ImageContent$1[]): Promise<void>;
/**
* Internal: Queue a steering message (already expanded, no extension command check).
*/
private queueSteer;
/**
* Internal: Queue a follow-up message (already expanded, no extension command check).
*/
private queueFollowUp;
/**
* Throw an error if the text is an extension command.
*/
private throwIfExtensionCommand;
/**
* Send a custom message to the session. Creates a CustomMessageEntry.
*
* Handles three cases:
* - Streaming: queues message, processed when loop pulls from queue
* - Not streaming + triggerTurn: appends to state/session, starts new turn
* - Not streaming + no trigger: appends to state/session, no turn
*
* @param message Custom message with customType, content, display, details
* @param options.triggerTurn If true and not streaming, triggers a new LLM turn
* @param options.deliverAs Delivery mode: "steer", "followUp", or "nextTurn"
*/
sendCustomMessage<T = unknown>(message: Pick<CustomMessage<T>, "customType" | "content" | "display" | "details">, options?: {
triggerTurn?: boolean;
deliverAs?: "steer" | "followUp" | "nextTurn";
}): Promise<void>;
/**
* Send a user message to the agent. Always triggers a turn.
* When the agent is streaming, use deliverAs to specify how to queue the message.
*
* @param content User message content (string or content array)
* @param options.deliverAs Delivery mode when streaming: "steer" or "followUp"
*/
sendUserMessage(content: string | (TextContent | ImageContent$1)[], options?: {
deliverAs?: "steer" | "followUp";
}): Promise<void>;
/**
* Clear all queued messages and return them.
* Useful for restoring to editor when user aborts.
* @returns Object with steering and followUp arrays
*/
clearQueue(): {
steering: string[];
followUp: string[];
};
/** Number of pending messages (includes both steering and follow-up) */
get pendingMessageCount(): number;
/** Get pending steering messages (read-only) */
getSteeringMessages(): readonly string[];
/** Get pending follow-up messages (read-only) */
getFollowUpMessages(): readonly string[];
get resourceLoader(): ResourceLoader;
/** Abort the current run; yield callers pass a turnHandoff reason to skip interruption guidance. */
abort(reason?: unknown): Promise<void>;
}
//#endregion
//#region src/agents/sessions/agent-session-models.d.ts
declare abstract class AgentSessionModels extends AgentSessionPrompting {
private emitModelSelect;
/** Set the model after validating its current auth at write admission. */
setModel(model: Model): Promise<void>;
/**
* Set thinking level.
* Clamps to model capabilities based on available thinking levels.
* Saves to session and settings only if the level actually changes.
*/
setThinkingLevel(level: ThinkingLevel): Promise<void>;
private planThinkingLevel;
private appendThinkingSelection;
private emitThinkingLevelSelect;
private failAfterMetadataCommit;
private captureMetadataOwner;
/**
* Get available thinking levels for current model.
* The provider will clamp to what the specific model supports internally.
*/
getAvailableThinkingLevels(): ThinkingLevel[];
/**
* Check if current model supports thinking/reasoning.
*/
supportsThinking(): boolean;
private getThinkingLevelForModelSwitch;
/**
* Set steering message mode.
* Saves to settings.
*/
setSteeringMode(mode: "all" | "one-at-a-time"): void;
/**
* Set follow-up message mode.
* Saves to settings.
*/
setFollowUpMode(mode: "all" | "one-at-a-time"): void;
}
//#endregion
//#region src/agents/sessions/agent-session-inspection.d.ts
declare abstract class AgentSessionInspection extends AgentSessionModels {
/**
* Set a display name for the current session.
*/
setSessionName(name: string): void;
getContextUsage(): ContextUsage | undefined;
/**
* Export the current session branch to a JSONL file.
* Writes the session header followed by all entries on the current branch path.
* @param outputPath Target file path. If omitted, generates a timestamped file in cwd.
* @returns The resolved output file path.
*/
exportToJsonl(outputPath?: string): string;
/**
* Get text content of last assistant message.
* Useful for /copy command.
* @returns Text content, or undefined if no assistant message exists
*/
getLastAssistantText(): string | undefined;
}
//#endregion
//#region src/agents/sessions/agent-session-compaction.d.ts
type CompactionRequestState = "unresolved";
type SummaryOutputPolicy = "none" | "retry-invalid-once";
type CompactionWorkOutcome = {
status: "completed";
result: CompactionResult;
tokensAfter: number;
} | {
status: "aborted";
} | {
status: "skipped";
reason: string;
};
type SettledCompactionWorkOutcome = Exclude<CompactionWorkOutcome, {
status: "aborted";
}>;
/** @internal */
declare const agentSessionAutomaticCompaction: unique symbol;
/** Installs a synchronous callback for model-context replacement during compaction. */
declare const agentSessionSetContextReplacementHook: unique symbol;
declare abstract class AgentSessionCompaction extends AgentSessionInspection {
private onContextReplaced?;
private assertContextReplacementActive?;
[agentSessionSetContextReplacementHook](callback: ((tokensAfter: number, tokensBefore: number) => void) | undefined, assertActive?: () => void): void;
/**
* Manually compact the session context.
* Aborts current agent operation first.
* @param customInstructions Optional instructions for the compaction summary
*/
compact(customInstructions?: string): Promise<CompactionResult>;
[agentSessionAutomaticCompaction](customInstructions?: string, requestState?: CompactionRequestState, summaryOutputPolicy?: SummaryOutputPolicy, constraints?: CompactionRequestConstraints): Promise<SettledCompactionWorkOutcome>;
private compactWithSessionWriteSettlement;
/**
* Cancel in-progress compaction (manual or auto).
*/
abortCompaction(): void;
/**
* Cancel in-progress branch summarization.
*/
abortBranchSummary(): void;
private runCompactionWork;
/**
* Check if compaction is needed and run it.
* Called after agent_end and before prompt submission.
*
* Two cases:
* 1. Overflow: LLM returned context overflow error, remove error message from agent state, compact, auto-retry
* 2. Threshold: Context over threshold, compact, NO auto-retry (user continues manually)
*
* @param assistantMessage The assistant message to check
* @param skipAbortedCheck If false, include aborted messages (for pre-prompt check). Default: true
*/
protected checkCompaction(assistantMessage: AssistantMessage$1, skipAbortedCheck?: boolean, requestBudget?: CompactionRequestBudget): Promise<boolean>;
/**
* Internal: Run auto-compaction with events.
*/
private runAutoCompaction;
/**
* Toggle auto-compaction setting.
*/
setAutoCompactionEnabled(enabled: boolean): void;
/** Whether auto-compaction is enabled */
get autoCompactionEnabled(): boolean;
}
//#endregion
//#region src/agents/sessions/agent-session-extensions.d.ts
declare abstract class AgentSessionExtensions extends AgentSessionCompaction {
bindExtensions(bindings: ExtensionBindings): Promise<void>;
private extendResourcesFromExtensions;
private buildExtensionResourcePaths;
private getExtensionSourceLabel;
private applyExtensionBindings;
private refreshCurrentModelFromRegistry;
private bindExtensionCore;
/** Replace a runtime-owned tool surface without restarting its active agent loop. */
replaceCustomTools(customTools: ToolDefinition$1[], activeToolNames: string[]): void;
private refreshToolRegistry;
protected buildRuntime(options: {
activeToolNames?: string[];
flagValues?: Map<string, boolean | string>;
includeAllExtensionTools?: boolean;
}): void;
reload(): Promise<void>;
}
//#endregion
//#region src/agents/sessions/agent-session-execution.d.ts
declare abstract class AgentSessionExecution extends AgentSessionExtensions {
/**
* Check if an error is retryable (overloaded, rate limit, server errors).
* Context overflow errors are NOT retryable (handled by compaction instead).
*/
protected isRetryableError(message: AssistantMessage$1): boolean;
/**
* Prepare a retryable error for continuation with exponential backoff.
* @returns true if the caller should continue the agent, false otherwise
*/
protected prepareRetry(message: AssistantMessage$1): Promise<boolean>;
/**
* Cancel in-progress retry.
*/
abortRetry(): void;
/** Whether auto-retry is currently in progress */
get isRetrying(): boolean;
/** Whether auto-retry is enabled */
get autoRetryEnabled(): boolean;
/**
* Toggle auto-retry setting.
*/
setAutoRetryEnabled(enabled: boolean): void;
}
//#endregion
//#region src/agents/sessions/agent-session-tree.d.ts
declare abstract class AgentSessionTree extends AgentSessionExecution {
/**
* Navigate to a different node in the session tree.
* Unlike fork() which creates a new session file, this stays in the same file.
*
* @param targetId The entry ID to navigate to
* @param options.summarize Whether user wants to summarize abandoned branch
* @param options.customInstructions Custom instructions for summarizer
* @param options.replaceInstructions If true, customInstructions replaces the default prompt
* @param options.label Label to attach to the branch summary entry
* @returns Result with editorText (if user message) and cancelled status
*/
navigateTree(targetId: string, options?: {
summarize?: boolean;
customInstructions?: string;
replaceInstructions?: boolean;
label?: string;
}): Promise<{
editorText?: string;
cancelled: boolean;
aborted?: boolean;
summaryEntry?: BranchSummaryEntry;
}>;
/**
* Get all user messages from session for fork selector.
*/
getUserMessagesForForking(): Array<{
entryId: string;
text: string;
}>;
createReplacedSessionContext(): ReplacedSessionContext;
/**
* Check if extensions have handlers for a specific event type.
*/
hasExtensionHandlers(eventType: string): boolean;
/**
* Get the extension runner (for setting UI context and error handlers).
*/
get extensionRunner(): ExtensionRunner;
}
//#endregion
//#region src/agents/sessions/agent-session.d.ts
/**
* Core abstraction for agent lifecycle and session management.
*
* Shared by interactive, print, and RPC modes. Mode-specific I/O stays above
* this class while the feature layers below own session behavior.
*/
declare class AgentSession extends AgentSessionTree {
constructor(config: AgentSessionConfig);
}
//#endregion
//#region src/infra/directory-entries.d.ts
type DirectoryEntry = {
name: string;
isDirectory: boolean;
/** Optional no-follow metadata from the same directory listing. */
isFile?: boolean;
size?: number;
mtimeMs?: number;
};
//#endregion
//#region src/agents/model-catalog.d.ts
/**
* Check if a model supports image input based on its catalog entry.
*/
declare function modelSupportsVision(entry: ModelCatalogEntry | undefined): boolean;
//#endregion
//#region src/gateway/session-activity-summaries.d.ts
type SessionActivitySummaryService = {
ensure: (target: ActivitySummaryTarget) => SessionActivitySummary;
handleEvent: (event: SessionObserverEvent) => void;
handleTranscript: (event: InternalSessionTranscriptUpdate) => void;
handleLifecycle: (event: SessionLifecycleEvent) => void;
dispose: () => Promise<void>;
};
//#endregion
//#region src/gateway/chat-abort-diagnostics.d.ts
type ChatAbortDiagnosticReason = "rpc" | "stop" | "timeout" | "restart" | "archive" | "delete" | "authority-revoked" | "superseded" | "aborted";
//#endregion
//#region src/gateway/chat-queued-turns.d.ts
type QueuedChatTurnEntry = {
controller: AbortController;
sessionId: string;
sessionKey: string;
/** False once collect-mode transfers cancellation to the aggregate owner. */
abortable?: boolean;
abortListener?: () => void;
agentId?: string;
ownerConnId?: string;
ownerDeviceId?: string;
abortDiagnosticReason?: ChatAbortDiagnosticReason;
/** Hold this source's adoption while its explicit withdrawal is committed. */
holdPendingInputWithdrawal?: () => (() => void) | undefined;
};
//#endregion
//#region src/commands/daemon-runtime.d.ts
type GatewayDaemonRuntime = "bun" | "node";
//#endregion
//#region src/commands/onboard-types.d.ts
type OnboardMode = "local" | "remote";
/**
* Auth choices are plugin-owned contract ids plus a few legacy aliases that
* are normalized elsewhere (for example `oauth` -> `setup-token`).
*/
type BuiltInAuthChoice =
/** @deprecated Use `setup-token`. */
"oauth" | "setup-token" | "token" | "apiKey" | "custom-api-key" | "skip";
type AuthChoice = BuiltInAuthChoice | (string & {});
type GatewayAuthChoice = "token" | "password";
type ResetScope = "config" | "config+creds+sessions" | "full";
type GatewayBind = "loopback" | "lan" | "auto" | "custom" | "tailnet";
type TailscaleMode = "off" | "serve" | "funnel";
declare const NODE_MANAGER_CHOICES: readonly ["npm", "pnpm", "bun"];
type NodeManagerChoice = (typeof NODE_MANAGER_CHOICES)[number];
declare const ONBOARD_FLOWS: readonly ["quickstart", "advanced", "manual", "import"];
type OnboardFlow = (typeof ONBOARD_FLOWS)[number];
type OnboardDynamicProviderOptions = {
/**
* Provider-specific non-interactive auth flags are plugin-owned and keyed by
* manifest `providerAuthChoices[].optionKey` values.
*/
[optionKey: string]: unknown;
};
/** Parsed options accepted by `openclaw onboard`. */
type OnboardOptions = OnboardDynamicProviderOptions & {
mode?: OnboardMode;
/** "manual" is an alias for "advanced". */
flow?: OnboardFlow;
/** Force the classic multi-step interactive wizard instead of guided setup. */
classic?: boolean;
/** Force the terminal hatch instead of the guided browser handoff. */
tui?: boolean;
workspace?: string;
/** Name for the first persisted agent; defaults to `main` in non-interactive setup. */
agentName?: string;
/** Create the bundled coordinator and specialists on a fresh install. */
team?: boolean;
nonInteractive?: boolean;
/** Required for non-interactive setup; skips the interactive risk prompt when true. */
acceptRisk?: boolean;
reset?: boolean;
resetScope?: ResetScope;
authChoice?: AuthChoice;
/** Used when `authChoice=token` in non-interactive mode. */
tokenProvider?: string;
/** Used when `authChoice=token` in non-interactive mode. */
token?: string;
/** Used when `authChoice=token` in non-interactive mode. */
tokenProfileId?: string;
/** Used when `authChoice=token` in non-interactive mode. */
tokenExpiresIn?: string;
/** API key persistence mode for setup flows (default: plaintext). */
secretInputMode?: SecretInputMode;
arceeaiApiKey?: string;
cloudflareAiGatewayAccountId?: string;
cloudflareAiGatewayGatewayId?: string;
customBaseUrl?: string;
customApiKey?: string;
lmstudioApiKey?: string;
customModelId?: string;
customProviderId?: string;
customCompatibility?: "openai" | "openai-responses" | "anthropic";
customImageInput?: boolean;
gatewayPort?: number;
gatewayBind?: GatewayBind;
gatewayAuth?: GatewayAuthChoice;
gatewayToken?: string;
gatewayTokenRefEnv?: string;
gatewayPassword?: string;
tailscale?: TailscaleMode;
installDaemon?: boolean;
daemonRuntime?: GatewayDaemonRuntime;
skipChannels?: boolean;
skipSkills?: boolean;
skipBootstrap?: boolean;
skipSearch?: boolean;
skipHealth?: boolean;
skipUi?: boolean;
suppressGatewayTokenOutput?: boolean;
skipHooks?: boolean;
nodeManager?: NodeManagerChoice;
remoteUrl?: string;
remoteToken?: string;
remotePassword?: string;
importFrom?: string;
importSource?: string;
importSecrets?: boolean;
json?: boolean;
};
//#endregion
//#region src/gateway/server-methods/wizard.d.ts
type ChannelSetupWizardRunner = (opts: {
channel?: string;
onConfigured?: (accounts: Array<{
channel: string;
accountId: string;
}>) => void;
beforePersistentEffect?: () => Promise<void>;
assertPersistentEffectCurrent?: () => void;
}, runtime: RuntimeEnv, prompter: WizardPrompter) => Promise<void>;
//#endregion
//#region src/gateway/methods/descriptor.d.ts
/** Scope marker for methods that only authenticated node clients may call. */
declare const NODE_GATEWAY_METHOD_SCOPE: "node";
/** Scope marker for methods whose handler derives the required operator scope at runtime. */
declare const DYNAMIC_GATEWAY_METHOD_SCOPE: "dynamic";
/** Authorization scope attached to a gateway method descriptor. */
type GatewayMethodScope = OperatorScope | typeof NODE_GATEWAY_METHOD_SCOPE | typeof DYNAMIC_GATEWAY_METHOD_SCOPE;
/** Owner metadata used to keep core, plugin, channel, and auxiliary methods distinguishable. */
type GatewayMethodOwner = {
kind: "core";
area: string;
} | {
kind: "plugin";
pluginId: string;
} | {
kind: "channel";
channelId: string;
} | {
kind: "aux";
area: string;
};
/** Startup availability flag exposed to clients as retryable startup-unavailable errors. */
type GatewayMethodStartupAvailability = "available" | "unavailable-until-sidecars";
type GatewayMethodProfileAccess = "independent" | "required";
/** A plugin operation addresses one existing session through the shared participation policy. */
type GatewayMethodSessionAccess = {
mode: "write";
allowOwnSessionScope?: boolean;
/** Reuse the complete effective session tool policy for this capability. */
requiredTool?: string;
};
type GatewayMethodHandler = (opts: never) => unknown;
/** Complete metadata for one dispatchable gateway method. */
type GatewayMethodDescriptor = {
name: string;
handler: GatewayMethodHandler;
scope: GatewayMethodScope;
owner: GatewayMethodOwner;
profileAccess: GatewayMethodProfileAccess;
sessionAccess?: GatewayMethodSessionAccess;
since?: string;
startup?: GatewayMethodStartupAvailability;
/** Observes another owner's result; cancelled on requester disconnect and restart drain. */
lifetime?: "observation";
controlPlaneWrite?: boolean;
advertise?: boolean;
description?: string;
};
/** Read-only method registry view used by request dispatch and method listing. */
type GatewayMethodRegistryView = {
/** Opaque registry handle carried into request scope by the gateway composition root. */
pluginRegistry?: object;
getHandler: (name: string) => GatewayMethodHandler | undefined;
listMethods: () => string[];
listAdvertisedMethods: () => string[];
getScope: (name: string) => GatewayMethodScope | undefined;
getSessionAccess?: (name: string) => GatewayMethodSessionAccess | undefined;
isStartupUnavailable: (name: string) => boolean;
isObservation: (name: string) => boolean;
isControlPlaneWrite: (name: string) => boolean;
requiresAuthenticatedProfile: (name: string) => boolean;
descriptors: () => readonly GatewayMethodDescriptor[];
};
//#endregion
//#region src/gateway/methods/registry.d.ts
type GatewayMethodRegistry = GatewayMethodRegistryView;
//#endregion
//#region src/gateway/control-ui-contract.d.ts
type ControlUiSessionPullRequestChecks = {
state: "pending" | "passing" | "failing";
passed: number;
failed: number;
skipped: number;
/** Queued/in-progress runs plus stale conclusions GitHub invalidated. */
running: number;
};
/** A pull request associated with the session's working branch. */
type ControlUiSessionPullRequest = {
number: number;
/** Login-only to avoid browser avatar requests; absent for deleted accounts. */
author?: {
login: string;
};
owner: string;
repo: string;
branch: string;
title: string;
url: string;
state: "open" | "draft" | "merged" | "closed";
additions?: number;
deletions?: number;
changedFiles?: number;
/** Latest check-run rollup for the head commit; absent when no checks ran. */
checks?: ControlUiSessionPullRequestChecks;
checksUrl?: string;
/** Head binding for on-demand CI details; not a client-selected repository revision. */
headSha?: string;
};
/** Local Git facts stay available while GitHub quota is exhausted. */
type ControlUiSessionBranch = {
owner: string;
repo: string;
branch: string;
/** Working-tree diff vs the merge base with the remote default branch. */
additions?: number;
deletions?: number;
changedFiles?: number;
/** Absent while the branch is unpushed or has nothing to compare. */
createUrl?: string;
};
type ControlUiSessionPullRequests = {
pullRequests: ControlUiSessionPullRequest[];
/** GitHub remote identity, independent of whether a PR or branch row exists. */
repository?: {
owner: string;
repo: string;
};
/** Non-default branch with a creatable PR or local changed files. */
branch?: ControlUiSessionBranch;
/** GitHub quota exhausted; entries may be stale until the limit resets. */
rateLimited: boolean;
/** A failed PR lookup may still carry independently resolved repository facts. */
status?: "ready" | "rate-limited" | "unavailable";
};
//#endregion
//#region src/gateway/control-ui-session-pr-read.d.ts
type ControlUiSessionPrTarget = {
params: {
sessionKey: string;
agentId: string;
};
identity: string;
readSource: {
agentId: string;
path: string;
};
source: string | GitCheckoutContext | null;
assertCurrent?: () => void;
};
type ControlUiSessionPrReadContext = {
target: ControlUiSessionPrTarget;
sourceIdentity: string;
assertCurrent: () => void;
};
type ControlUiSessionPrRead = () => Promise<ControlUiSessionPrTarget | undefined>;
//#endregion
//#region src/gateway/control-ui-session-prs.d.ts
type ControlUiSessionPullRequestsParams = {
sessionKey: string;
agentId?: string;
refresh?: boolean;
};
//#endregion
//#region src/gateway/live-text-continuity.d.ts
type LiveTextProjectionText = {
snapshot: string;
delta: string;
};
//#endregion
//#region src/gateway/auth-resolve.d.ts
/** Authentication modes after config, override, and credential inputs are combined. */
type ResolvedGatewayAuthMode = "none" | "token" | "password" | "trusted-proxy";
/** Records which input selected the effective Gateway auth mode. */
type ResolvedGatewayAuthModeSource = "override" | "config" | "password" | "token" | "default";
/** Fully resolved Gateway auth policy before startup validates required secrets. */
type ResolvedGatewayAuth = {
mode: ResolvedGatewayAuthMode;
modeSource?: ResolvedGatewayAuthModeSource;
token?: string;
password?: string;
allowTailscale: boolean;
trustedProxy?: GatewayTrustedProxyConfig;
};
/** Resolve Gateway auth mode, credentials, trusted-proxy policy, and Tailscale allowance. */
declare function resolveGatewayAuth(params: {
authConfig?: GatewayAuthConfig | null;
authOverride?: GatewayAuthConfig | null;
env?: NodeJS.ProcessEnv;
tailscaleMode?: GatewayTailscaleMode;
}): ResolvedGatewayAuth;
//#endregion
//#region src/gateway/auth-rate-limit.d.ts
interface RateLimitConfig extends GatewayAuthRateLimitConfig {
/** Background prune interval in milliseconds; set <= 0 to disable auto-prune. @default 60_000 */
pruneIntervalMs?: number;
/** Maximum tracked client identities before old unlocked entries are evicted. @default 10_000 */
maxEntries?: number;
}
interface RateLimitCheckResult {
/** Whether the request is allowed to proceed. */
allowed: boolean;
/** Number of remaining attempts before the limit is reached. */
remaining: number;
/** Milliseconds until the lockout expires (0 when not locked). */
retryAfterMs: number;
}
interface AuthRateLimiter {
/** Check whether `ip` is currently allowed to attempt authentication. */
check(ip: string | undefined, scope?: string): RateLimitCheckResult;
/** Record a failed authentication attempt for `ip`. */
recordFailure(ip: string | undefined, scope?: string): void;
/**
* Record a failed attempt and await any loopback penalty delay.
*
* Deliberately post-verification: it prices repeated guessing from one loopback
* source without ever gating a request before its credentials are checked.
* Gating earlier would stop parallel fan-out, but would also let a bad local
* peer stall the operator's own correct-credential CLI, which loopback must
* never do. Fan-out from loopback is out of scope for this limiter by design.
*/
recordFailureAndDelay(ip: string | undefined, scope?: string): Promise<void>;
/** Reset the rate-limit state for `ip` (e.g. after a successful login). */
reset(ip: string | undefined, scope?: string): void;
/** Return the current number of tracked IPs (useful for diagnostics). */
size(): number;
/** Remove expired entries and release memory. */
prune(): void;
/** Dispose the limiter and cancel periodic cleanup timers. */
dispose(): void;
}
//#endregion
//#region src/gateway/ingress-attribution.d.ts
type VerifiedTailscaleIngressIdentity = {
login: string;
name: string;
profilePic?: string;
};
//#endregion
//#region src/gateway/auth.d.ts
/** Normalized outcome for gateway shared-secret, Tailscale, device, and proxy auth. */
type GatewayAuthResult = {
ok: boolean;
method?: "none" | "token" | "password" | "tailscale" | "device-token" | "bootstrap-token" | "trusted-proxy";
user?: string;
/** Full verified Tailscale identity; present only after header + WhoIs agreement. */
tailscaleIdentity?: VerifiedTailscaleIdentity;
reason?: string;
/** Present when the request was blocked by the rate limiter. */
rateLimited?: boolean;
/** Milliseconds the client should wait before retrying (when rate-limited). */
retryAfterMs?: number;
};
type VerifiedTailscaleIdentity = VerifiedTailscaleIngressIdentity;
//#endregion
//#region src/gateway/server/client-identity-types.d.ts
/** Server-attested identity facts shared by RPC and transport client records. */
type GatewayWsBrowserOrigin = {
requestHost?: string;
origin?: string;
isLocalClient?: boolean;
};
type PreparedSessionProfile = {
profileId: string;
aliases: ReadonlySet<string>;
role: string | null;
};
//#endregion
//#region src/gateway/auth-policy.types.d.ts
type GatewayAuthPolicy = Readonly<{
/** Transport admission policy; changes require a fresh handshake. */
generation: string;
/** The original principal's access, independent of transport admission. */
grantGeneration: string;
role?: string;
authMethod?: GatewayAuthResult["method"];
/** Fixed startup mode attested by the auth resolver, independent of file-mode edits. */
authModeOverride?: ResolvedGatewayAuth["mode"];
/** Only operator WebSocket admission consumes identity grants. */
verifiedIdentity?: string;
/** Handshake-attested origin facts remain authoritative after transport retirement. */
browserOrigin?: Readonly<GatewayWsBrowserOrigin>;
}>;
//#endregion
//#region src/gateway/github-user-identity.types.d.ts
/** Connection-held identity synchronization contract, independent of its transport. */
type AuthenticatedGitHubIdentitySyncResult = {
profileId: string;
updatedAt: number;
};
type AuthenticatedGitHubIdentitySync = () => Promise<AuthenticatedGitHubIdentitySyncResult>;
//#endregion
//#region src/gateway/operator-access-policy.types.d.ts
type GatewayOperatorAccessAuthority = PluginGatewayAccessAuthority & {
readonly gatewayAccessGrant?: GatewayAccessGrantRef;
};
//#endregion
//#region src/gateway/operator-role-actor.d.ts
/** Host-minted role authority; never accepted from Gateway wire params.
Leaf contract: both ws-types and server-methods/shared-types embed it in
client `internal` state, so it must not import either hub. */
type GatewayOperatorRoleActor = {
kind: "system";
} | {
kind: "operator";
profileId: string;
};
//#endregion
//#region src/gateway/server-methods/response-types.d.ts
/** Callback used by method handlers to emit one protocol response frame. */
type RespondFn = (ok: boolean, payload?: unknown, error?: ErrorShape, meta?: Record<string, unknown>) => void;
//#endregion
//#region src/gateway/plugin-node-capability.d.ts
/** Path marker used to scope plugin-hosted node URLs with one-time capabilities. */
declare const PLUGIN_NODE_CAPABILITY_PATH_PREFIX = "/__openclaw__/cap";
declare const DEFAULT_PLUGIN_NODE_CAPABILITY_TTL_MS: number;
type PluginNodeCapabilitySurface = {
surface: string;
ttlMs?: number;
scopeKey?: string;
};
type PluginNodeCapabilityClient = {
/** Retired clients cannot back HTTP capability auth or its renewal while close is pending. */
invalidated?: boolean;
/** Handshake-resolved host, retained so newly enabled surfaces need no reconnect. */
pluginSurfaceBaseUrl?: string;
pluginSurfaceUrls?: Record<string, string>;
pluginNodeCapabilitySurfaces?: Record<string, PluginNodeCapabilitySurface>;
pluginNodeCapabilities?: Record<string, {
capability: string;
expiresAtMs: number;
}>;
};
type NormalizedPluginNodeCapabilityUrl = {
pathname: string;
capability?: string;
rewrittenUrl?: string;
scopedPath: boolean;
malformedScopedPath: boolean;
};
declare function mintPluginNodeCapabilityToken(): string;
declare function buildPluginNodeCapabilityScopedHostUrl(baseUrl: string, capability: string): string | undefined;
/** Parse and rewrite scoped capability URLs into canonical paths plus query tokens. */
declare function normalizePluginNodeCapabilityScopedUrl(rawUrl: string): NormalizedPluginNodeCapabilityUrl;
//#endregion
//#region src/gateway/server-methods/session-creation-provenance.d.ts
type TrustedSessionCreation = {
skillLibrarySelections?: SkillLibrarySelection[];
via: SessionCreatedVia;
actor?: SessionCreatedActor;
/** Creator-owned isolation requirement resolved only by the trusted Gateway boundary. */
sandbox?: "required";
/** Exact spawning session retained separately from the stable actor identity. */
requesterSessionKey?: string;
/** Host-verified human requester; never accepted from model-authored parameters. */
requesterProfileId?: string;
/** Immutable completion recipient for a spawn-owned visible session. */
completionOwnerSessionKey?: string;
/** Prepared parent selection; never accepted from public creation parameters. */
resolvedModel?: ProviderModelRef;
/** Effective host-prepared permission mode, not a public permission-change request. */
inheritedPermissionMode?: SessionPermissionMode;
/** Effective caller tool-policy snapshot for an in-process visible spawn. */
inheritedToolPolicy?: {
version: 1;
allow: string[];
deny: string[];
};
/** Config-selected model provenance from the trusted spawning tool. */
spawnModelAutoSelection?: AgentRuntimeSpawnModelAutoSelection;
};
//#endregion
//#region src/gateway/server-methods/client-types.d.ts
/** Trusted in-process spawn control plane that already owns this run's task row.
Gateway CLI tracking only covers runs nobody else records, so a marked run
must never get a second row. */
type GatewayAgentRunTaskOwner = "plugin_subagent" | "native_subagent";
/** Caller identity captured by a built-in agent tool before trusted in-process dispatch. */
type TrustedAgentToolCaller = Readonly<{
agentId: string;
sessionKey: string;
/** Exact admitted requester lifetime; identity alone does not establish live authority. */
assertCurrent?: () => void;
}>;
/** Closure-bound streaming hooks attached only to trusted plugin-owned synthetic clients. */
type GatewayNodeInvokeStream = {
onProgress: (chunk: string) => void;
onDispatchReady: (invokeId: string) => void;
idleTimeoutMs?: number;
isRuntimeCurrent: () => boolean;
};
/** Per-connection client metadata captured after the gateway handshake. */
type GatewayClient = {
connect: ConnectParams;
authPolicy?: GatewayAuthPolicy;
/** Transport-owned revocation marker; retained callers have no authority after invalidation. */
invalidated?: boolean;
/** Host-owned transport retirement notification; does not cancel ordinary admitted RPCs. */
connectionSignal?: AbortSignal;
/** Server-attested browser origin captured during the WebSocket handshake. */
browserOrigin?: GatewayWsBrowserOrigin;
connId?: string;
presenceKey?: string;
clientIp?: string;
/** Client id verified against the server-approved device pairing record. */
pairedClientId?: string;
authenticatedUserId?: string;
/** Verified Tailscale provider identity; generic proxy identities must not infer this. */
authenticatedUserIsTailscaleProvider?: boolean;
authenticatedGitHubIdentitySync?: AuthenticatedGitHubIdentitySync;
/** Prepared at identity admission and profile publication, before session reads or events. */
preparedSessionProfile?: PreparedSessionProfile;
authenticatedUserProfile?: {
profileId: string;
displayName: string | null;
avatarRevision?: string;
hasAvatar: boolean;
updatedAt: number;
};
pluginSurfaceUrls?: Record<string, string>;
pluginNodeCapabilitySurfaces?: Record<string, PluginNodeCapabilitySurface>;
pluginNodeCapabilities?: Record<string, {
capability: string;
expiresAtMs: number;
}>;
isDeviceTokenAuth?: boolean;
internal?: {
/** Handshake-attested direct-local transport; never accepted from wire params. */
isLocalClient?: true;
/** Authenticated operator transport ingress; never accepted from wire params. */
authenticatedOperator?: true;
/** Authenticated Control UI operator ingress; never accepted from wire params. */
authenticatedControlUi?: true;
/** Authenticated Control UI admin admission; never accepted from wire params. */
controlUiAdmin?: true;
/** Marks the server-constructed client used by trusted in-process dispatch. */
syntheticClient?: true;
/** Host-owned role authority retained separately from an autonomous run principal. */
operatorRoleActor?: GatewayOperatorRoleActor;
/** Original source restriction carried only by trusted in-process run admission. */
operatorRunAuthority?: AdmittedRunOperatorAuthority;
/** Closure-bound access captured by the authenticated ingress, never wire data. */
operatorAccessAuthority?: GatewayOperatorAccessAuthority | null;
/** Overrides persisted sender attribution without changing the authorizing client identity. */
senderAttribution?: {
id: string;
name?: string;
identity?: TranscriptSenderIdentity;
};
/** Trusted session creation provenance; never accepted from Gateway wire params. */
sessionCreation?: TrustedSessionCreation;
/** Trusted built-in agent tool caller; never accepted from Gateway wire params. */
agentToolCaller?: TrustedAgentToolCaller;
allowModelOverride?: boolean;
approvalRuntime?: boolean;
cronRunContinuation?: boolean;
agentRuntimeIdentity?: AgentRuntimeIdentity;
pluginRuntimeOwnerId?: string;
/** Host-attested session provenance for a trusted official plugin node invocation. */
nodeInvokeApprovalSessionKey?: string;
/** Plugin-owned in-process invoke hooks; never accepted from Gateway wire params. */
nodeInvokeStream?: GatewayNodeInvokeStream;
agentRunTracking?: GatewayAgentRunTaskOwner;
/** Host-captured requester lineage for opt-in plugin subagent completion delivery. */
pluginSubagentRequester?: PluginSubagentRequesterContext;
/** Host-owned exact media set for a scoped automatic recovery delivery. */
internalDeliveryMediaUrls?: string[];
runtimeContextFragments?: RuntimeContextFragment[];
internalDeliverySuppressText?: boolean;
/** Plugin-owned tools authorized for this internal subagent run. */
runtimePluginToolGrant?: RuntimePluginToolGrant;
/** Host-owned exact tool cap for a tracked plugin subagent run. */
pluginSubagentToolsAllow?: string[];
/** Opaque in-process subagent-completion capability; never accepted from wire params. */
delegatedToolPolicyHandoffId?: string;
};
};
//#endregion
//#region src/gateway/server-broadcast-types.d.ts
type GatewayBroadcastStateVersion = {
presence?: number;
health?: number;
};
/** Options for gateway websocket broadcasts. */
type GatewayBroadcastOpts = {
/** Agent scope for agent-relative keys such as `global`. */
agentId?: string;
dropIfSlow?: boolean;
/** Omit a redundant projection for clients that advertise this capability. */
excludeClientCapability?: GatewayClientCap;
/** Canonical subscription keys for session-scoped delivery. */
sessionKeys?: readonly string[];
/** Target recipients were selected from subscriptions at ingress. */
sessionSubscriptionVerified?: boolean;
/** Question owner authorizes ordinary own-run recipients without a broad question grant. */
questionRecipient?: (client: GatewayClient) => boolean;
stateVersion?: GatewayBroadcastStateVersion;
/** Private live-text ownership; omitting coalesce flushes this group's progress. */
liveText?: {
group: AbortSignal;
/** Source continuity changes without revoking already queued publications. */
sourceEpoch?: object;
/** Accepted terminal barrier; drain current queued text before retiring its group. */
settle?: true;
isCurrent?: () => boolean;
coalesce?: {
key: string;
merge: (previous: unknown, next: unknown) => unknown;
};
/** Full internal payloads become append-only only after this socket has a baseline. */
projection?: {
key: string;
delta: (payload: unknown) => unknown;
/** Upper bound for encoded full payload bytes, without encoding cumulative text. */
snapshotBytes?: (payload: unknown, deltaPayloadBytes: number) => number;
version?: unknown;
snapshot?: boolean;
/** Verify transformed snapshots against the prior publication before omitting them. */
text?: LiveTextProjectionText;
};
};
};
/** Broadcast function signature for all connected clients. */
type GatewayBroadcastFn = (event: string, payload: unknown, opts?: GatewayBroadcastOpts) => void;
/** Broadcast function signature for targeted connection ids. */
type GatewayBroadcastToConnIdsFn = (event: string, payload: unknown, connIds: ReadonlySet<string>, opts?: GatewayBroadcastOpts) => void;
//#endregion
//#region src/gateway/control-ui-session-pr-subscriptions.d.ts
type LoadSessionPullRequests = (params: ControlUiSessionPullRequestsParams, cacheSignal: AbortSignal | undefined, read: ControlUiSessionPrReadContext) => Promise<ControlUiSessionPullRequests>;
type SubscriptionDeps = {
broadcastToConnIds: GatewayBroadcastToConnIdsFn;
prepareRead: (connId: string, session: Pick<ControlUiSessionPullRequestsParams, "sessionKey" | "agentId">) => Promise<ControlUiSessionPrRead | undefined>;
isConnectionActive?: (connId: string) => boolean;
load?: LoadSessionPullRequests;
scheduler: GatewayScheduler;
};
type ControlUiSessionPullRequestSubscriptions = {
replace: (connId: string, sessionKeys: readonly string[], refreshSessionKeys?: ReadonlySet<string>, onAdmitted?: () => void) => Promise<void>;
unsubscribe: (connId: string) => void;
pollNow: () => Promise<void>;
stop: () => Promise<void>;
};
/**
* Owns the union of connection replace-sets. Only this union drives GitHub
* refreshes, so hidden/disconnected clients cannot leave orphan polling work.
*/
declare function createControlUiSessionPullRequestSubscriptions(deps: SubscriptionDeps): ControlUiSessionPullRequestSubscriptions;
//#endregion
//#region src/gateway/worker-environments/connection-identity.d.ts
/** Hash-only worker identity retained after admission. */
type WorkerConnectionIdentity = {
environmentId: string;
credentialHash: string;
bundleHash: string;
sessionId: string | null;
runId: string | null;
turnClaim: WorkerSessionTurnClaim | null;
ownerEpoch: number;
rpcSetVersion: number;
protocolFeatures: string[];
credentialExpiresAtMs: number;
};
//#endregion
//#region src/gateway/server/connection-transport.d.ts
type GatewayConnectionFrame = Buffer | ArrayBuffer | Buffer[];
/** Ordered frames and transport retirement, independent of the physical connection. */
type GatewayConnectionTransport = {
/** Uses the WebSocket ready-state values; 1 means open. */
readonly readyState: number;
readonly bufferedAmount: number;
/**
* Accept JSON text frames in order, including byte-backed text. The optional callback settles after transport
* delivery or with an error; it is not a peer acknowledgement.
*/
send(frame: string, callback?: (error?: Error) => void): void;
send(frame: Buffer, options: {
binary: false;
}, callback?: (error?: Error) => void): void;
close(code?: number, reason?: string): void;
terminate(): void;
on(event: "message", listener: (data: GatewayConnectionFrame) => void): unknown;
off(event: "message", listener: (data: GatewayConnectionFrame) => void): unknown;
off(event: "close", listener: (code: number, reason: Buffer) => void): unknown;
once(event: "message", listener: (data: GatewayConnectionFrame) => void): unknown;
once(event: "close", listener: (code: number, reason: Buffer) => void): unknown;
};
//#endregion
//#region src/gateway/server/ws-types.d.ts
type GatewayWsConnectionKind = "gateway" | "worker";
/**
* Runtime WebSocket client state tracked by the gateway server.
*/
type GatewayWsClient = PluginNodeCapabilityClient & {
socket: GatewayConnectionTransport;
/** Physical WS liveness capability; absent on transports without ping/pong. */
webSocket?: Pick<WebSocket, "ping" | "once" | "off">;
connect: ConnectParams;
connId: string;
/** Host-owned transport retirement notification; never accepted from wire params. */
connectionSignal?: AbortSignal;
connectionKind?: GatewayWsConnectionKind;
worker?: WorkerConnectionIdentity;
isDeviceTokenAuth?: boolean;
/** Client id verified against the server-approved device pairing record. */
pairedClientId?: string;
usesSharedGatewayAuth: boolean;
sharedGatewaySessionGeneration?: string;
authPolicy?: GatewayAuthPolicy;
presenceKey?: string;
/** Connection-owned timing facts, reconciled across live peers independently of the TTL cache. */
personPresence?: {
onlineSince: number;
lastActivityAt?: number;
};
/** Accepted interaction on this exact connection, never copied from another client. */
connectionLastActivityAt?: number;
authenticatedUserId?: string;
/** Verified Tailscale provider identity; generic proxy identities must not infer this. */
authenticatedUserIsTailscaleProvider?: boolean;
authenticatedGitHubIdentitySync?: AuthenticatedGitHubIdentitySync;
/** Lifecycle-prepared canonical recipient; never a scope or authorization grant. */
preparedRecipientProfileId?: string;
preparedSessionProfile?: PreparedSessionProfile;
authenticatedUserProfile?: {
profileId: string;
displayName: string | null;
avatarRevision: string;
hasAvatar: boolean;
updatedAt: number;
};
clientIp?: string;
/** Server-attested inputs for rechecking browser-origin policy after config publication. */
browserOrigin?: GatewayWsBrowserOrigin;
internal?: {
/** Handshake-attested direct-local transport; never accepted from wire params. */
isLocalClient?: true;
/** Authenticated Control UI operator ingress; never accepted from wire params. */
authenticatedControlUi?: true;
/** Authenticated Control UI admin admission; never accepted from wire params. */
controlUiAdmin?: true;
approvalRuntime?: boolean;
agentRuntimeIdentity?: AgentRuntimeIdentity;
/** Server-attested role-policy actor; never accepted from WebSocket wire params. */
operatorRoleActor?: GatewayOperatorRoleActor;
/** Additional access captured at authenticated admission; independent of socket lifetime. */
operatorAccessAuthority?: GatewayOperatorAccessAuthority | null;
};
invalidatedReason?: string;
};
//#endregion
//#region src/gateway/server/client-registry.d.ts
declare class GatewayClientRegistry extends Set<GatewayWsClient> {
#private;
get authorityClients(): Iterable<GatewayWsClient>;
retainRequest(client: GatewayWsClient): () => void;
constructor(clients?: Iterable<GatewayWsClient>, onRemove?: (client: GatewayWsClient) => void);
add(client: GatewayWsClient): this;
delete(client: GatewayWsClient): boolean;
clear(): void;
getByConnectionId(connId: string): GatewayWsClient | undefined;
getByConnectionIds(connIds: ReadonlySet<string>): GatewayWsClient[];
}
//#endregion
//#region src/gateway/session-viewer-presence.d.ts
type SessionViewerPresenceDeclarationsDeps = {
clients: GatewayClientRegistry;
publishPresence: () => void;
};
type SessionViewerPresenceDeclarations = {
replace: (connId: string, sessionKeys: readonly string[]) => readonly string[];
unsubscribe: (connId: string) => void;
stop: () => void;
};
/** Owns one replace-set per websocket connection until empty declaration or disconnect. */
declare function createSessionViewerPresenceDeclarations(deps: SessionViewerPresenceDeclarationsDeps): SessionViewerPresenceDeclarations;
//#endregion
//#region src/plugins/config-schema.d.ts
type BuildPluginConfigSchemaOptions = {
/** @deprecated Declare top-level `uiHints` in `openclaw.plugin.json`. */
uiHints?: Record<string, PluginConfigUiHint>;
safeParse?: OpenClawPluginConfigSchema["safeParse"];
};
type BuildJsonPluginConfigSchemaOptions = BuildPluginConfigSchemaOptions & {
cacheKey?: string;
};
/** Build a plugin config schema from JSON Schema with runtime validation/default support. */
declare function buildJsonPluginConfigSchema(schema: JsonSchemaObject, options?: BuildJsonPluginConfigSchemaOptions): OpenClawPluginConfigSchema;
/** Build a plugin config schema from Zod, exporting JSON Schema when the Zod runtime supports it. */
declare function buildPluginConfigSchema(schema: ZodTypeAny, options?: BuildPluginConfigSchemaOptions): OpenClawPluginConfigSchema;
/** Return a schema for plugins that intentionally accept no config keys. */
declare function emptyPluginConfigSchema(): OpenClawPluginConfigSchema;
//#endregion
//#region src/plugins/memory-state.d.ts
declare function registerMemoryCorpusSupplement(requestedPluginId: string, supplement: MemoryCorpusSupplement): void;
declare function registerMemoryCapability(requestedPluginId: string, capability: MemoryPluginCapability): void;
declare function getMemoryCapabilityRegistration(): MemoryPluginCapabilityRegistration | undefined;
declare function buildMemoryPromptSection(params: MemoryPromptSectionParams, prepared?: PreparedMemoryPromptSection): string[];
declare function listActiveMemoryPublicArtifacts(params: {
cfg: OpenClawConfig;
}): Promise<MemoryPluginPublicArtifact[]>;
declare function clearMemoryPluginState(): void;
//#endregion
//#region src/infra/http-response-body.d.ts
type ReadResponseTextPrefixOptions = {
signal?: AbortSignal;
chunkTimeoutMs?: number;
onIdleTimeout?: (params: {
chunkTimeoutMs: number;
}) => Error;
/** Static timeout or lazy resolver evaluated immediately before body consumption. */
timeoutMs?: number | (() => number);
onTimeout?: (params: {
timeoutMs: number;
}) => Error;
};
/** Reads a response body under byte, idle, and overall timeout bounds. */
declare function readResponseWithLimit(response: Response, maxBytes: number, options?: ReadResponseTextPrefixOptions & {
onOverflow?: (params: {
size: number;
maxBytes: number;
res: Response;
}) => Error;
}): Promise<Buffer>;
/** Reads a small collapsed text prefix from a response body for diagnostics/errors. */
declare function readResponseTextSnippet(response: Response, options?: ReadResponseTextPrefixOptions & {
maxBytes?: number;
maxChars?: number;
}): Promise<string | undefined>;
//#endregion
//#region src/version.d.ts
declare const VERSION: string;
//#endregion
//#region src/agents/provider-attribution.d.ts
/** Transport family used when resolving provider-specific request policy. */
type ProviderRequestTransport = "stream" | "websocket" | "http" | "media-understanding";
/** Capability family used when endpoint rules differ by media or LLM request type. */
type ProviderRequestCapability = "llm" | "audio" | "image" | "video" | "other";
//#endregion
//#region src/agents/provider-request-config.d.ts
type RequestApi = Api | ModelDefinitionConfig["api"];
/** Auth override accepted from sanitized provider/model request config. */
type ProviderRequestAuthOverride = {
mode: "provider-default";
} | {
mode: "authorization-bearer";
token: string;
} | {
mode: "header";
headerName: string;
value: string;
prefix?: string;
};
/** TLS override accepted from sanitized provider/model request config. */
type ProviderRequestTlsOverride = {
ca?: string;
cert?: string;
key?: string;
passphrase?: string;
serverName?: string;
insecureSkipVerify?: boolean;
};
/** Proxy override accepted from sanitized provider/model request config. */
type ProviderRequestProxyOverride = {
mode: "env-proxy";
tls?: ProviderRequestTlsOverride;
} | {
mode: "explicit-proxy";
url: string;
tls?: ProviderRequestTlsOverride;
};
/** Transport override block shared by provider and model request config. */
type ProviderRequestTransportOverrides = {
headers?: Record<string, string>;
auth?: ProviderRequestAuthOverride;
proxy?: ProviderRequestProxyOverride;
tls?: ProviderRequestTlsOverride;
};
/** Model-scoped transport overrides, including private-network policy. */
type ModelProviderRequestTransportOverrides$1 = ProviderRequestTransportOverrides & {
allowPrivateNetwork?: boolean;
};
type ProviderRequestHeaderPrecedence = "caller-wins" | "defaults-win";
/** Resolves final headers for one provider request route. */
declare function resolveProviderRequestHeaders(params: {
provider: string;
api?: RequestApi;
baseUrl?: string;
capability?: ProviderRequestCapability;
transport?: ProviderRequestTransport;
callerHeaders?: Record<string, string>;
defaultHeaders?: Record<string, string>;
precedence?: ProviderRequestHeaderPrecedence;
request?: ProviderRequestTransportOverrides;
}): Record<string, string> | undefined;
/** Attaches model-scoped provider request transport metadata without mutating the model. */
declare function attachModelProviderRequestTransport<TModel extends object>(model: TModel, request: ModelProviderRequestTransportOverrides$1 | undefined): TModel;
/** Reads provider request transport metadata attached to a model definition. */
declare function getModelProviderRequestTransport(model: object): ModelProviderRequestTransportOverrides$1 | undefined;
//#endregion
//#region src/agents/provider-http-errors.d.ts
/** Shared timeout and byte-limit options for provider response consumption. */
type ProviderResponseReadOptions = ReadResponseTextPrefixOptions & {
maxBytes?: number;
onOverflow?: (params: {
size: number;
maxBytes: number;
res: Response;
}) => Error;
/** Credentials that must not appear in malformed-response diagnostics. */
requestHeaders?: HeadersInit;
};
/** Options for bounded provider error-body normalization. */
type ProviderHttpErrorOptions = {
statusPrefix?: string;
signal?: AbortSignal;
maxBodyBytes?: number;
bodyTimeoutMs?: ReadResponseTextPrefixOptions["timeoutMs"];
onBodyTimeout?: NonNullable<ReadResponseTextPrefixOptions["onTimeout"]>;
/** Scrub reflected request credentials before retaining response diagnostics. */
requestHeaders?: HeadersInit;
};
/** Reads a successful provider text response under a byte cap. */
declare function readProviderTextResponse(response: Response, label: string, opts?: ProviderResponseReadOptions): Promise<string>;
/** Error type carrying normalized provider status, request id, code, type, and body metadata. */
declare class ProviderHttpError extends Error {
readonly status: number;
readonly statusCode: number;
retryAfterMs?: number;
readonly code?: string;
readonly errorCode?: string;
readonly errorType?: string;
readonly errorBody?: string;
readonly requestId?: string;
constructor(message: string, params: {
status: number;
code?: string;
type?: string;
body?: string;
requestId?: string;
retryAfterMs?: number;
});
}
/** Creates a normalized provider HTTP error from a failed response. */
declare function createProviderHttpError(response: Response, label: string, options?: ProviderHttpErrorOptions): Promise<ProviderHttpError>;
/**
* Parses a provider JSON response under a byte cap and wraps malformed JSON with the caller's label.
*
* The body is read through the same bounded reader as binary responses so a provider that streams an
* unbounded JSON body cannot force the runtime to buffer the whole payload before parsing.
*/
declare function readProviderJsonResponse<T>(response: Response, label: string, opts?: ProviderResponseReadOptions): Promise<T>;
//#endregion
//#region packages/memory-host-sdk/src/host/embedding-inputs.d.ts
/** Text part passed through embedding providers that support structured input. */
type EmbeddingInputTextPart = {
type: "text";
text: string;
};
/** Inline binary payload encoded for providers with multimodal embedding support. */
type EmbeddingInputInlineDataPart = {
type: "inline-data";
mimeType: string;
data: string;
};
/** Single structured embedding input part. */
type EmbeddingInputPart = EmbeddingInputTextPart | EmbeddingInputInlineDataPart;
/** Provider-facing input while preserving the plain text fallback. */
type EmbeddingInput = {
text: string;
parts?: EmbeddingInputPart[];
};
//#endregion
//#region src/plugins/registry-contribution-types.d.ts
type ContextEngineFactoryContext = {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
};
type ContextEngineFactory = (ctx: ContextEngineFactoryContext) => ContextEngine | Promise<ContextEngine>;
type ContextEngineRegistrationLifecycle = "runtime" | "readOnlyDiscovery";
type ContextEngineRegistration = {
factory: ContextEngineFactory;
owner: string;
lifecycle: ContextEngineRegistrationLifecycle;
};
type CompactionProviderSummarizationInstructions = {
identifierPolicy?: "strict" | "off" | "custom";
identifierInstructions?: string;
};
interface CompactionProvider {
id: string;
label: string;
summarize(params: {
messages: unknown[];
signal?: AbortSignal;
compressionRatio?: number;
customInstructions?: string;
summarizationInstructions?: CompactionProviderSummarizationInstructions;
previousSummary?: string;
}): Promise<string>;
}
type RegisteredCompactionProvider = {
provider: CompactionProvider;
ownerPluginId?: string;
};
type MemoryEmbeddingBatchChunk = EmbeddingBatchChunk & {
embeddingInput?: EmbeddingInput;
};
type MemoryEmbeddingBatchOptions = Omit<EmbeddingBatchOptions, "chunks"> & {
chunks: MemoryEmbeddingBatchChunk[];
};
type MemoryEmbeddingProviderRuntime = Omit<EmbeddingProviderRuntime, "batchEmbed"> & {
batchEmbed?: (options: MemoryEmbeddingBatchOptions) => Promise<number[][] | null>;
};
type MemoryEmbeddingProviderCreateOptions = Omit<EmbeddingProviderCreateOptions, "local"> & {
fallback?: string;
local?: NonNullable<EmbeddingProviderCreateOptions["local"]> & {
contextSize?: number | "auto";
};
};
type MemoryEmbeddingProviderCreateResult = Omit<EmbeddingProviderCreateResult, "runtime"> & {
runtime?: MemoryEmbeddingProviderRuntime;
};
type MemoryEmbeddingProviderAdapter = Omit<EmbeddingProviderAdapter, "create"> & {
autoSelectPriority?: number;
allowExplicitWhenConfiguredAuto?: boolean;
supportsMultimodalEmbeddings?: (params: {
model: string;
}) => boolean;
create: (options: MemoryEmbeddingProviderCreateOptions) => Promise<MemoryEmbeddingProviderCreateResult>;
shouldContinueAutoSelection?: (err: unknown) => boolean;
};
type MemoryPromptSectionParams = {
availableTools: Set<string>;
citationsMode?: MemoryCitationsMode;
agentId?: string;
agentSessionKey?: string;
sandboxed?: boolean;
};
type MemoryPromptSectionBuilder = (params: MemoryPromptSectionParams) => string[];
type MemoryPromptSectionPreparer = (params: MemoryPromptSectionParams) => Promise<readonly string[]>;
type PreparedMemoryPromptSection = Readonly<{
context: Readonly<{
availableTools: readonly string[];
citationsMode?: MemoryCitationsMode;
agentId?: string;
agentSessionKey?: string;
sandboxed: boolean;
}>;
lines: readonly string[];
}>;
type MemoryCorpusSearchResult = {
corpus: string;
path: string;
title?: string;
kind?: string;
score: number;
snippet: string;
id?: string;
startLine?: number;
endLine?: number;
citation?: string;
source?: string;
provenanceLabel?: string;
sourceType?: string;
sourcePath?: string;
updatedAt?: string;
};
type MemoryCorpusGetResult = {
corpus: string;
path: string;
title?: string;
kind?: string;
content: string;
fromLine: number;
lineCount: number;
id?: string;
provenanceLabel?: string;
sourceType?: string;
sourcePath?: string;
updatedAt?: string;
};
type MemoryCorpusSupplement = {
search(params: {
query: string;
maxResults?: number;
agentId?: string;
agentSessionKey?: string;
sandboxed?: boolean;
}): Promise<MemoryCorpusSearchResult[]>;
get(params: {
lookup: string;
fromLine?: number;
lineCount?: number;
agentId?: string;
agentSessionKey?: string;
sandboxed?: boolean;
}): Promise<MemoryCorpusGetResult | null>;
};
type MemoryCorpusSupplementRegistration = {
pluginId: string;
supplement: MemoryCorpusSupplement;
};
type MemoryPromptSupplementRegistration = {
pluginId: string;
builder: MemoryPromptSectionBuilder;
};
type MemoryPromptPreparationRegistration = {
pluginId: string;
prepare: MemoryPromptSectionPreparer;
};
type MemoryFlushPlan = {
softThresholdTokens: number;
forceFlushTranscriptBytes: number;
reserveTokensFloor: number;
model?: string;
prompt: string;
systemPrompt: string;
relativePath: string;
};
type MemoryFlushPlanResolver = (params: {
cfg?: OpenClawConfig;
nowMs?: number;
contextWindowTokens?: number;
}) => MemoryFlushPlan | null;
type RegisteredMemorySearchManager = Omit<MemorySearchManager, "readFile"> & {
readFile(params: Parameters<MemorySearchManager["readFile"]>[0]): Promise<LegacyMemoryReadResult | MemoryReadResult>;
};
type MemoryRuntimeBackendConfig = {
backend: "builtin";
};
type MemoryPluginRuntime = {
getMemorySearchManager(params: {
cfg: OpenClawConfig;
agentId: string;
purpose?: "default" | "status" | "cli";
/** Request a read-only source freshness scan; runtimes may ignore unsupported diagnostics. */
inspectSources?: boolean;
}): Promise<{
manager: RegisteredMemorySearchManager | null;
debug?: {
backend?: "builtin";
purpose?: "default" | "status" | "cli";
managerMs?: number;
};
error?: string;
}>;
resolveMemoryBackendConfig(params: {
cfg: OpenClawConfig;
agentId: string;
}): MemoryRuntimeBackendConfig;
/** Authorize raw hits before caller-visible use; absent runtimes must not expose session hits. */
authorizeSearchHits?(params: {
cfg: OpenClawConfig;
agentId: string;
requesterSessionKey: string | undefined;
sandboxed: boolean;
hits: MemorySearchResult[];
}): Promise<MemorySearchResult[]>;
/** The classifier consumes pinned read sources without probing Gateway-local paths. */
supportsWorkspaceMemoryReadSources?: true;
classifyWorkspaceMemoryPaths?(params: {
cfg: OpenClawConfig;
agentId: string;
workspaceDir: string;
relativePaths: string[];
/** Already-read remote files; an absent canonical path must remain untrusted. */
readSources?: readonly {
relativePath: string;
canonicalRelativePath?: string;
}[];
}): Promise<Array<{
relativePath: string;
originClass: MemoryOriginClass;
}>>;
/** Fence and drain managers consuming these exact retiring capability objects. */
prepareReload?(change: {
retireRuntime: boolean;
retiringEmbeddingProviders: readonly MemoryEmbeddingProviderAdapter[];
}): {
drain(): Promise<void | {
errors: readonly unknown[];
}>;
resume(): void;
};
closeMemorySearchManager?(params: {
cfg: OpenClawConfig;
agentId: string;
}): Promise<void>;
closeAllMemorySearchManagers?(): Promise<void>;
};
type MemoryPluginPublicArtifactContentType = "markdown" | "json" | "text";
type MemoryPluginPublicArtifact = {
kind: string;
workspaceDir: string;
relativePath: string;
absolutePath: string;
agentIds: string[];
contentType: MemoryPluginPublicArtifactContentType;
};
type MemoryPluginPublicArtifactsProvider = {
listArtifacts(params: {
cfg: OpenClawConfig;
}): Promise<MemoryPluginPublicArtifact[]>;
};
type MemoryPluginCapability = {
promptBuilder?: MemoryPromptSectionBuilder;
flushPlanResolver?: MemoryFlushPlanResolver;
runtime?: MemoryPluginRuntime;
publicArtifacts?: MemoryPluginPublicArtifactsProvider;
/** Local deterministic recall tool required by provider-owned direct lookup. */
deterministicRecallToolName?: string;
/** Whether recall may read protected same-agent private session transcripts. */
supportsPrivateTranscriptRecall?: boolean;
};
type MemoryPluginCapabilityRegistration = {
pluginId: string;
capability: MemoryPluginCapability;
/**
* Registrar-provided memory slot ownership. Only the slot owner may displace
* earlier fields during resolution; undeclared registrations contribute what
* the owner lacks but never take over its runtime or consolidation surface.
*/
memorySlotSelected?: boolean;
};
type SessionDiscussionState = "none" | "available" | "open";
type SessionDiscussionInfo = {
state: SessionDiscussionState;
embedUrl?: string;
openUrl?: string;
};
type SessionDiscussionProvider = {
id: string;
info(params: {
sessionKey: string;
agentId: string;
}): Promise<SessionDiscussionInfo>;
open(params: {
sessionKey: string;
agentId: string;
}): Promise<SessionDiscussionInfo>;
};
type ResolvedPluginRuntimeArtifact = {
source: string;
rootDir: string;
};
//#endregion
//#region src/shared/async-work-scope.d.ts
/** Outside a managed scope, the returned promise remains the caller's responsibility. */
declare function trackAsyncWork<T>(run: () => T | Promise<T>): Promise<T>;
//#endregion
//#region src/plugins/capability-catalog.types.d.ts
/** Default export of capabilityCatalogEntry. Each present family is complete, even when empty. */
type PluginCapabilityCatalog = {
speechProviders?: readonly SpeechProviderPlugin$1[];
realtimeTranscriptionProviders?: readonly RealtimeTranscriptionProviderPlugin$1[];
realtimeVoiceProviders?: readonly RealtimeVoiceProviderPlugin$1[];
};
//#endregion
//#region src/plugins/provider-config-context.types.d.ts
/**
* Provider-owned config normalization for `models.providers.<id>` entries.
*
* Use this for provider-specific config cleanup that should stay with the
* plugin rather than in core config-policy tables.
*/
type ProviderNormalizeConfigContext = {
provider: string;
providerConfig: ModelProviderConfig;
};
/**
* Provider-owned env/config auth marker resolution for `models.providers`.
*
* Use this when a provider resolves auth from env vars that do not follow the
* generic API-key conventions.
*/
type ProviderResolveConfigApiKeyContext = {
provider: string;
env: NodeJS.ProcessEnv;
};
/**
* Provider-owned config-default application input.
*
* Use this when a provider needs to add global config defaults that depend on
* provider auth mode or provider-specific model families.
*/
type ProviderApplyConfigDefaultsContext = {
provider: string;
config: OpenClawConfig;
env: NodeJS.ProcessEnv;
};
//#endregion
//#region src/plugins/provider-runtime-model.types.d.ts
/**
* Fully-resolved runtime model shape used after provider/plugin-owned
* discovery, overrides, and compat normalization.
*/
type ProviderRuntimeModel = Omit<Model, "compat"> & {
compat?: ModelCompatConfig;
contextWindows?: ModelCatalogContextWindowOption[];
contextWindowDefault?: string;
contextTokens?: number;
/** Host-resolved provenance for the top-level wire output cap. */
maxTokensSource?: "configured" | "discovered";
params?: Record<string, unknown>;
requestTimeoutMs?: number;
/** Provider/host-prepared tool discovery preference for this attempt; never persisted. */
toolSearchMode?: "tools" | false;
/** Provider-prepared default for embedded compaction; explicit compaction config wins. */
compactionThinkingDefault?: NonNullable<ProviderThinkingProfile["defaultLevel"]>;
mediaInput?: ModelMediaInputConfig;
};
//#endregion
//#region src/plugins/runtime/gateway-request-scope.types.d.ts
type PluginRuntimeGatewayRequestScope = {
/** Recheck the admitted HTTP device or cookie grant before effects/disclosure; rejection sends HTTP 401 and throws. */
revalidate?: () => Promise<void>;
/** Exact placement owner captured before the local harness begins. */
assertNodeExecutionCurrent?: (request: {
runId: string;
agentId: string;
nodeId: string;
workspace: OpenClawPluginNodeWorkspace;
}) => void;
/** In-process admitted owner only; never projected into RPC parameters. */
invokeWithSessionNodeAuthority?: <T>(request: {
pluginId: string;
command: string;
source: "session-full" | "human-approved";
nodeId: string;
workspace: OpenClawPluginNodeWorkspace;
}, invoke: (assertCurrent: () => void, signal: AbortSignal) => Promise<T>) => Promise<T | undefined>;
/** Closure-bound admitted owner used to validate placement grant bindings. */
nodePlacementGrantAuthority?: {
agentId: string;
sessionKey: string;
runId: string;
assertCurrent: (request: {
pluginId: string;
command: string;
nodeId: string;
workspace: OpenClawPluginNodeWorkspace;
}) => void;
};
context?: GatewayRequestContext;
resolveGatewayContext?: GatewayContextResolver;
client?: GatewayRequestOptions["client"];
/** Original request-owned cancellation and live transport authority, never wire data. */
signal?: GatewayRequestOptions["signal"];
hasCurrentClientAuthority?: GatewayRequestOptions["hasCurrentClientAuthority"];
isWebchatConnect: GatewayRequestOptions["isWebchatConnect"];
pluginId?: string;
pluginSource?: string;
pluginOrigin?: PluginOrigin$1;
pluginTrustedOfficialInstall?: boolean;
gatewayMethodDispatchAllowed?: boolean;
pluginRegistry?: PluginRegistry;
declaredProviderOwners?: DeclaredProviderOwnerIndex;
};
//#endregion
//#region src/plugins/runtime/gateway-request-scope.d.ts
declare function getPluginRuntimeGatewayRequestScope(): PluginRuntimeGatewayRequestScope | undefined;
//#endregion
//#region src/plugins/lifecycle.d.ts
/** A receipt describes the published runtime, never authority to invoke it. */
type PluginRuntimeApplication = {
operationId: string;
generation: number;
pluginIds: string[];
sourceDigests?: Record<string, string>;
selectedEntries?: Record<string, string>;
/** Registration applied, but process-shared code needs a Gateway restart. */
restartRequired?: boolean;
warnings?: string[];
};
type PluginLifecycleReason = "install" | "enable" | "disable" | "uninstall" | "reload" | "metadata";
type PluginLifecycleRuntimeApply = (params: {
config: OpenClawConfig;
write?: Pick<ConfigReplaceResult, "persistedHash" | "persistedSourceConfig">;
pluginIds: readonly string[];
reason: PluginLifecycleReason;
/** Explicit reload admission wait; cancellation never owns recovery or published cleanup. */
waitForDrain?: boolean;
drainSignal?: AbortSignal;
expectedSourceDigests?: Readonly<Record<string, string>>;
/** Canonical install owners whose committed contents may already be running. */
expectedInstallHashes?: Readonly<Record<string, string>>;
/** Private invoker authority; never part of the published runtime receipt. */
assertInvokerOwned?: () => void;
}) => Promise<PluginRuntimeApplication>;
//#endregion
//#region src/gateway/desktop/attachment.d.ts
type RfbAttachment = {
kind: "unix-socket";
socketPath: string;
} | {
kind: "tcp";
host: "127.0.0.1";
port: number;
};
/** One already-connected RFB transport published by a remote desktop source. */
type RfbStreamAttachment = {
kind: "stream";
streamId: string;
};
type DesktopRfbAttachment = RfbAttachment | RfbStreamAttachment;
//#endregion
//#region src/process/supervisor/types.d.ts
type TerminationReason = "manual-cancel" | "overall-timeout" | "no-output-timeout" | "spawn-error" | "signal" | "exit";
type ProcessCleanupResult = {
readonly reason: "forced-relay-exit";
readonly signalRequested: "SIGKILL";
readonly signalError?: Error;
readonly exit: {
readonly code: number | null;
readonly signal: NodeJS.Signals | null;
};
readonly durationMs: number;
readonly escalationAfterMs: number;
};
//#endregion
//#region src/gateway/desktop/managed-linux-audio.d.ts
/** Raw interleaved PCM s16le, 48000 Hz, stereo. No microphone or host mix. */
type DesktopAudioSource = {
start(signal: AbortSignal, assertAuthority?: () => void): Promise<{
stream: Readable;
stop(): Promise<void>;
}>;
};
//#endregion
//#region src/gateway/desktop/managed-linux.d.ts
type DesktopComputerLease = {
env: NodeJS.ProcessEnv;
isCurrent(): boolean;
release(): void;
};
type ManagedLinuxDesktopStatus = {
state: "not-started";
} | {
state: "starting";
display?: number;
port?: number;
} | {
state: "running";
display: number;
port: number;
} | {
state: "failed";
error: string;
display?: number;
port?: number;
};
//#endregion
//#region src/gateway/desktop/observe-requester.d.ts
type DesktopObserveRequester = {
connId?: string;
/** Display identity from authenticated Gateway metadata, never wire-supplied client labels. */
operatorName?: string;
signal?: AbortSignal;
isCurrent: () => boolean;
};
//#endregion
//#region src/gateway/desktop/session-registry.d.ts
type DesktopSessionObserver = {
control: boolean;
operatorName?: string;
/** Epoch the observer token was minted against; a stale token must not reach a newer entry. */
ownerEpoch: number;
close(code: number, reason: string): void;
};
type DesktopSessionAcquireResult = {
attachment: DesktopRfbAttachment;
auth?: "vnc-password" | "ard-account";
vncPassword?: string;
resolveAudio?: () => DesktopAudioSource | undefined;
/** Internal setup detail; project only a fixed availability code to viewers. */
readonly audioUnavailableReason?: string;
};
type DesktopSessionAcquireRequest = {
sourceKey: string;
ownerEpoch: number;
/** Lifecycle events stop this exact owner; the stop promise joins initialization. */
start: (isCurrent: () => boolean, stop: () => Promise<void>) => Promise<DesktopSessionAcquireResult>;
teardown?: () => Promise<void>;
/** Release source resources only after initialization and transport teardown have joined. */
dispose?: () => Promise<void>;
};
type DesktopSessionActivateRequest = Omit<DesktopSessionAcquireRequest, "start">;
/** Owns per-source desktop sessions and their connected observer lifetimes. */
declare function createDesktopSessionRegistry(deps?: {
lingerMs?: number;
}): {
acquire: (request: DesktopSessionAcquireRequest) => Promise<DesktopSessionAcquireResult>;
activate: (request: DesktopSessionActivateRequest) => Promise<void>;
attachObserver: (sourceKey: string, observer: DesktopSessionObserver) => {
release(): void;
} | undefined;
takeControl: (sourceKey: string, ownerEpoch: number) => void;
claimStream: (sourceKey: string, attachment: {
kind: "stream";
streamId: string;
}) => Duplex | undefined;
createStream: (params: {
sourceKey: string;
ownerEpoch: number;
onStopped(): void;
}) => {
signal: AbortSignal;
readonly stopped: boolean;
reserve(): boolean;
connect<T extends {
stream: Duplex;
}>(pending: {
attached: Promise<T>;
cancel(): void;
}, invoke: () => Promise<{
error?: {
message?: string;
} | null;
}>): Promise<T>;
publish(): {
readonly kind: "stream";
readonly streamId: `${string}-${string}-${string}-${string}-${string}`;
} | undefined;
expireAt(expiresAtMs: number): void;
stop: () => Promise<void>;
};
retainActivity: (sourceKey: string, ownerEpoch: number) => {
isCurrent: () => boolean;
release(): void;
} | undefined;
hasActivity: (sourceKey: string, ownerEpoch: number) => boolean;
hasController: (sourceKey: string, ownerEpoch: number) => boolean;
onControlChanged: (sourceKey: string, ownerEpoch: number, changed: (controlled: boolean) => void) => () => void;
claimOwnerEpoch: (sourceKey: string, ownerEpoch: number) => boolean;
isOwnerEpochCurrent: (sourceKey: string, ownerEpoch: number) => boolean;
stop: (sourceKey: string, ownerEpoch?: number) => Promise<void>;
stopSuperseded: (sourceKey: string, ownerEpoch: number) => Promise<void>;
stopAll: () => Promise<void>;
};
type DesktopSessionRegistry = ReturnType<typeof createDesktopSessionRegistry>;
//#endregion
//#region src/gateway/desktop/host-source.d.ts
type HostDesktopStatus = {
enabled: false;
state: "disabled";
port: number;
} | {
enabled: true;
state: "attached";
port: number;
security: string;
} | {
enabled: true;
state: "unavailable";
port: number;
security?: string;
} | {
enabled: true;
state: "managed";
managedState: ManagedLinuxDesktopStatus["state"] | "unknown";
port: number;
display?: number;
error?: string;
security?: "VncAuth";
};
type HostDesktopService = {
observe(params: {
control: boolean;
requester?: DesktopObserveRequester;
credentials?: {
username?: string;
password?: string;
};
}): Promise<{
transport: "rfb";
wsPath: string;
expiresAtMs: number;
control: boolean;
auth: "vnc-password" | "ard-account";
vncPassword?: string;
audio?: DesktopObserveResult["audio"];
audioUnavailableReason?: DesktopObserveResult["audioUnavailableReason"];
preauthenticated?: boolean;
}>;
acquireComputer(params: {
onStop(): Promise<void>;
}): Promise<DesktopComputerLease>;
status(): Promise<HostDesktopStatus>;
reconcileRuntimePolicy(): Promise<void>;
};
//#endregion
//#region src/gateway/desktop/computer-protocol.d.ts
declare const command: z.ZodEnum<{
"computer.act": "computer.act";
"screen.snapshot": "screen.snapshot";
}>;
type ComputerHostCommand = z.infer<typeof command>;
//#endregion
//#region src/gateway/desktop/computer-service.d.ts
type GatewayComputerStatus = {
configured: boolean;
available: boolean;
computerUse?: ComputerUseCapabilityDescriptor;
error?: string;
};
type ComputerInvokeRequest = {
command: ComputerHostCommand;
params: Record<string, unknown>;
generation: string;
owner: string;
signal?: AbortSignal;
ownerSignal?: AbortSignal;
assertCurrent(): void;
timeoutMs?: number;
idempotencyKey: string;
};
type GatewayComputerService = {
status(): Promise<GatewayComputerStatus>;
invoke(request: ComputerInvokeRequest): Promise<unknown>;
reconcileRuntimePolicy(): Promise<void>;
close(): Promise<void>;
revokeRunAuthority(authority: AgentRunDelegatedAuthority): void;
preparePluginReload: (params: {
changedPluginIds: ReadonlySet<string>;
}) => {
drain: () => Promise<void>;
resume: () => void;
};
};
//#endregion
//#region src/worker/worker-build-identity.d.ts
type ExpectedWorkerBuild = {
bundleHash: WorkerAdmissionHandshake["bundleHash"];
openclawVersion: WorkerAdmissionHandshake["openclawVersion"];
protocolFeatures: readonly string[];
};
//#endregion
//#region src/gateway/worker-environments/bundle.d.ts
type WorkerBundleArtifact = ExpectedWorkerBuild & {
install: "bundle";
tarballBytes: number;
tarballSha256: string;
tarballPath: string;
};
type WorkerNpmArtifact = ExpectedWorkerBuild & {
install: "npm";
packageIntegrity: string;
packageSpec: string;
};
type WorkerInstallationArtifact = WorkerBundleArtifact | WorkerNpmArtifact;
//#endregion
//#region src/worker/node-workspace-prepared-protocol.d.ts
declare const Result: z.ZodObject<{
gatewayNamespace: z.ZodString;
environmentId: z.ZodString;
preparationKey: z.ZodString;
cacheKey: z.ZodString;
workspaceDir: z.ZodString;
homeDir: z.ZodString;
sourceManifestRef: z.ZodString;
preparedManifestRef: z.ZodString;
}, z.core.$strict>;
type NodeWorkerPreparedWorkspaceResult = z.infer<typeof Result>;
//#endregion
//#region src/gateway/worker-environments/placement-turn-claim-events.d.ts
type WorkerTurnExecutionIdentity = Readonly<{
agentId: string;
delegatedAuthority: AgentRunDelegatedAuthority;
executionIdentityToken?: ExecutionIdentityAdmissionToken;
operationalRunInstance: OperationalRunInstanceRef;
operatorAuthority?: AdmittedRunOperatorAuthority;
/** Original presence reader, retained on the Gateway without a worker-writable claim. */
assertPresenceSourceCurrent?: () => void;
receiptAuthority: () => void;
sessionKey: string;
sessionTarget: Readonly<BoundAgentRunSessionTarget>;
turnClaim: WorkerSessionTurnClaim;
}>;
type WorkerTurnTranscriptSource = Pick<WorkerTurnExecutionIdentity, "sessionTarget" | "receiptAuthority">;
type WorkerTurnExecutionIdentityCapability = WorkerTurnTranscriptSource & Readonly<{
run<T>(callback: (identity: WorkerTurnExecutionIdentity) => Promise<T> | T): Promise<T>;
}>;
//#endregion
//#region src/agents/execution-auth-binding.d.ts
/** Ephemeral proof of the credential or opaque runtime that completed one agent run. */
type AgentExecutionAuthBinding = {
authProfileId?: string;
/** Exact embedded harness that completed the successful turn, including openclaw. */
agentHarnessId?: string;
/** Exact model selected by the successful embedded run. */
modelId?: string;
/** Exact transport used to select that run's credential. */
modelApi?: string;
/** Non-reversible identity hash; credential material never leaves the runner. */
authFingerprint?: string;
/** Runtime-owned principal/session shape used when credentials are intentionally opaque. */
runtimeOwnerFingerprint?: string;
/** Exact opaque owner, or plugin harness carrying a credential-backed turn. */
runtimeOwnerKind?: OpaqueRuntimeOwnerKind;
/** Exact backend/harness id that owned the successful turn. */
runtimeOwnerId?: string;
/** Exact CLI or plugin-harness implementation used by the successful turn. */
runtimeArtifactFingerprint?: string;
runtimeArtifactId?: string;
/** The prepared CLI bridge used only the selected profile, not ambient CLI auth. */
skipLocalCredential?: true;
};
type OpaqueRuntimeOwnerKind = "cli-runtime" | "plugin-harness" | "aws-sdk";
/** Fingerprint a profile after materializing its selected SecretRef value. */
declare function fingerprintResolvedAuthProfileCredential(params: {
profileId: string;
credential: AuthProfileCredential;
resolvedAuth: ResolvedProviderAuth | null | undefined;
}): string | undefined;
//#endregion
//#region src/infra/diagnostic-model-request-provenance.d.ts
type CoreModelRequestOwnerGeneration = object;
type DiagnosticEmbeddedRunOwner = Readonly<{
generation: CoreModelRequestOwnerGeneration;
runId?: string;
sessionId: string;
sessionKey?: string;
workKey: string;
}>;
//#endregion
//#region src/agents/embedded-agent-runner/run/deferred-lifecycle-owner.d.ts
type DeferredEmbeddedRunLifecycleOwner = {
beginRetryWait: (deadlineAtMs: number, signal: AbortSignal) => ((completed?: boolean) => void) | undefined;
complete: () => Promise<void>;
discard: () => void;
};
//#endregion
//#region src/cron/runtime-authority.d.ts
type CronRuntimeAuthority = Readonly<{
version: 1;
/** Concrete harness runtime that alone may consume this opaque authority. */
runtimeId: string;
/** Runtime-owned payload discriminator; core never interprets its value. */
namespace: string;
payload: Readonly<Record<string, unknown>>;
}>;
//#endregion
//#region src/process/command-queue.types.d.ts
/**
* Public enqueue knobs shared by command-lane callers and narrower injection
* points that should not import the full queue implementation.
*/
type CommandQueueTaskDeadline = {
kind: "bounded";
deadlineAtMs: number;
} | {
kind: "unlimited";
};
type CommandQueueEnqueueOptions = {
/** Enqueue-time provenance for diagnostics only; never used for admission. */
taskIdentity?: Readonly<{
taskKind: string;
sessionKey?: string;
runId?: string;
requesterSessionKey?: string;
}>;
/** Owner-resolved capacity, installed atomically with this enqueue. */
maxConcurrent?: number;
/** Cancels queued admission; the task owns cancellation after it starts. */
abortSignal?: AbortSignal;
/** Called only when this entry remains queued after immediate lane admission. */
onQueued?: () => void;
warnAfterMs?: number;
onWait?: (waitMs: number, queuedAhead: number) => void;
taskTimeoutMs?: number;
taskTimeoutProgressAtMs?: () => number | undefined;
/** Replaces idle timing with an owner deadline; undefined restores idle timing. */
taskTimeoutSubscribe?: (onDeadline: (deadline: CommandQueueTaskDeadline | undefined) => void) => () => void;
taskTimeoutAbortSignal?: AbortSignal;
taskTimeoutAbortGraceMs?: number;
/** Ends the task after a caller-owned timeout cleanup grace has already elapsed. */
taskTimeoutReleaseSignal?: AbortSignal;
priority?: "foreground" | "normal" | "background";
};
/** Minimal queue function contract used by code that only needs to schedule work. */
type CommandQueueEnqueueFn = <T>(task: () => Promise<T>, opts?: CommandQueueEnqueueOptions) => Promise<T>;
//#endregion
//#region src/skills/library/authoring.d.ts
type SkillLibraryAuthoringInput = {
action: "list" | "read" | "create" | "update" | "share" | "unshare" | "transfer" | "activate" | "remove" | "rollback";
skillId?: string;
expectedRevision?: string;
revision?: string;
slug?: string;
content?: string;
files?: SkillLibraryFile[];
deleteFiles?: string[];
};
/** Host-held namespace capability; never persisted or reconstructed from session attribution. */
type SkillLibraryAuthoringCapability = {
target: "personal";
defaultTarget: "workspace" | "personal";
multipleProfiles: boolean;
assertWorkspaceCurrent?: () => void;
bind: (context: AdmittedRunContext) => void;
invoke: (params: SkillLibraryAuthoringInput) => Promise<SkillsLibraryReceipt | SkillsLibraryReadResult | SkillsLibraryActivateResult | SkillsLibraryListResult>;
};
//#endregion
//#region src/skills/workshop/types.d.ts
type ProtocolSkillProposalRecord = SkillsProposalRecordResult;
type SkillProposalOrigin = NonNullable<ProtocolSkillProposalRecord["origin"]>;
type SkillWorkshopPreparedPatch = {
skillFile: string;
contentHash: string;
oldString: string;
};
/** Run-scoped budget shared by every workshop tool instance created across runner retries. */
type SkillWorkshopProposalMutationBudget = {
remaining: number;
/** Run-local identity set used to keep idea counts distinct. */
mutatedProposalIds?: Set<string>;
/** Content hash per live skill read this run; autonomous updates require a matching receipt. */
readSkillHashes?: Map<string, string>;
/** Single-use exact-span patch authority prepared from authoritative live content. */
preparedSkillPatches?: Map<string, SkillWorkshopPreparedPatch>;
};
/** Exact proposal revision an operator reviewed before requesting an agent-authored revision. */
type SkillWorkshopProposalRevisionConstraint = {
readonly agentId: string;
readonly workspaceDir: string;
readonly proposalId: string;
readonly expectedRevisionHash: string;
};
type SkillWorkshopRunOptions = {
libraryAuthoring?: SkillLibraryAuthoringCapability;
env?: NodeJS.ProcessEnv;
proposalOnly?: boolean;
updateProposals?: boolean;
autonomousCapture?: boolean;
origin?: SkillProposalOrigin;
proposalMutationBudget?: SkillWorkshopProposalMutationBudget;
proposalRevision?: SkillWorkshopProposalRevisionConstraint;
};
//#endregion
//#region src/agents/assistant-error-transcript.d.ts
type AssistantMessage = Extract<AgentMessage, {
role: "assistant";
}>;
type TranscriptTarget = NonNullable<ReturnType<SessionManager["getSessionTarget"]>>;
/** Holds attempt failures until the logical run decides whether recovery succeeded. */
declare function createAssistantErrorTranscript(params: {
runId: string;
config?: OpenClawConfig;
}): {
clear: () => void;
bindStream(source: AgentMessage, replaceStream: (visible: boolean) => void): void;
snapshot(): {
message: AssistantMessage;
source: AgentMessage;
target: TranscriptTarget;
assertActive: () => void;
replaceStream?: (visible: boolean) => void;
} | undefined;
restore(snapshot: {
message: AssistantMessage;
source: AgentMessage;
target: TranscriptTarget;
assertActive: () => void;
replaceStream?: (visible: boolean) => void;
} | undefined): void;
record(message: AssistantMessage, target: TranscriptTarget, source?: AgentMessage): AssistantMessage | undefined;
settle(failed: boolean): Promise<void>;
};
type AssistantErrorTranscript = ReturnType<typeof createAssistantErrorTranscript>;
//#endregion
//#region src/infra/exec-auto-review.d.ts
/** Risk level returned by exec auto-reviewers for approval routing decisions. */
type ExecAutoReviewRisk = "unknown" | "low" | "medium" | "high";
/**
* Auto-review outcome: `allow-once` with low/medium risk permits one execution;
* `ask` requests human approval. Plugin consumers must handle `deny` explicitly:
* do not run, return the rationale and rejection guidance to the agent, and never
* escalate that denial to human approval. The configured exec reviewer maps
* provider failures, timeouts, and invalid responses to `ask`; detected
* reviewer-directed prompt injection maps to `deny` with high risk.
*/
type ExecAutoReviewDecision = {
decision: "allow-once";
rationale: string;
risk: "low" | "medium";
userAuthorization?: ExecAutoReviewRisk;
} | {
decision: "deny";
rationale: string;
risk: ExecAutoReviewRisk;
userAuthorization?: ExecAutoReviewRisk;
} | {
decision: "ask";
rationale: string;
risk: ExecAutoReviewRisk;
userAuthorization?: ExecAutoReviewRisk;
};
/** Execution host whose command policy context is being reviewed. */
type ExecAutoReviewHost = "gateway" | "node" | "codex-app-server";
type ExecAutoReviewTranscriptEntry = {
kind: "user" | "assistant" | "tool_call" | "tool_result";
text: string;
toolName?: string;
toolCallId?: string;
origin?: "operator" | "channel" | "inter_session" | "internal_system" | "unknown";
truncated?: boolean;
};
type ExecAutoReviewTranscript = {
entries: readonly ExecAutoReviewTranscriptEntry[];
omittedEntries: number;
truncated: boolean;
};
/** Command and policy facts supplied to an exec auto-reviewer. */
type ExecAutoReviewInput = {
transcript?: ExecAutoReviewTranscript;
command: string;
argv?: readonly string[];
resolvedPath?: string | null;
cwd?: string | null;
envKeys?: readonly string[];
host: ExecAutoReviewHost;
reason: "approval-required" | "allowlist-miss" | "strict-inline-eval" | "heredoc" | "execution-plan-miss";
analysis: {
parsed: boolean;
allowlistMatched: boolean;
safeBinMatched?: boolean;
durableApprovalMatched?: boolean;
inlineEval: boolean;
heredoc?: boolean;
shellWrapper?: boolean;
};
agent?: {
id?: string | null;
sessionKey?: string | null;
};
};
/** Reviewer function used by gateway/node exec paths before human approval fallback. */
type ExecAutoReviewer = (input: ExecAutoReviewInput) => Promise<ExecAutoReviewDecision> | ExecAutoReviewDecision;
//#endregion
//#region src/infra/event-session-routing.d.ts
/** Routing policy derived from config and the source session for an event. */
type EventSessionRoutingPolicy = {
mainKey?: string;
sessionScope?: SessionScope;
dmScope?: string | null;
allowFrom?: ReadonlyArray<string | number> | null;
channel?: string | null;
accountId?: string | null;
preserveSessionKey?: boolean;
};
//#endregion
//#region src/agents/sandbox/fs-bridge.types.d.ts
/** Resolved sandbox path with host, relative, and container views. */
type SandboxResolvedPath = {
hostPath?: string;
relativePath: string;
containerPath: string;
};
/** Minimal file stat shape returned by sandbox fs bridge implementations. */
type SandboxFsStat = {
type: "file" | "directory" | "other";
size: number;
mtimeMs: number;
};
/** Filesystem operations exposed across the sandbox boundary. */
type SandboxFsBridge = {
/**
* Backend-owned runtime roots and their local policy projections, in mount
* precedence order for equal roots. These do not grant access: bridge methods
* still enforce visibility, read-only rules and physical path safety.
* Omit only for pre-descriptor SDK implementations; an empty list admits nothing.
*/
readonly pathMappings?: readonly {
readonly hostRoot: string;
readonly containerRoot: string;
}[];
resolvePath(params: {
filePath: string;
cwd?: string;
}): SandboxResolvedPath;
/**
* Resolves the canonical mutation destination before caller authorization.
*
* Returns two views of the same destination:
* - `policyPath`: the destination in the caller's policy namespace. Path
* grants, read-only carveouts, and protected-path policies must be
* evaluated against this path.
* - `pinnedPath`: the canonical mutation target in the bridge's runtime
* namespace. Pass it back as `pinnedPath` on the mutation so the pinned
* operation lands on exactly the authorized location.
*
* The two paths differ when the runtime resolves sandbox aliases onto
* different host roots. Pinned mutations walk their path without following
* symlinks, so any component swapped after resolution fails the mutation
* instead of redirecting it.
*
* Directory semantics: for `mkdir` both paths describe the directory
* itself (which an existing alias may rename); for file-backed actions
* (`write`, `create`, `remove`, `copy-destination`) both paths describe the
* canonical parent plus the requested basename, so the basename never
* changes.
*/
resolvePinnedMutationTarget?(params: {
filePath: string;
cwd?: string;
action: "write" | "create" | "mkdir" | "remove" | "copy-destination";
signal?: AbortSignal;
}): Promise<{
policyPath: string;
pinnedPath: string;
}>;
/** Directory metadata only; callers paginate it without activating file contents. */
readDirectory?(params: {
filePath: string;
cwd?: string;
signal?: AbortSignal;
}): Promise<DirectoryEntry[]>;
/** Reads a safely opened regular file, rejecting growth beyond an optional byte limit. */
readFile(params: {
filePath: string;
cwd?: string;
signal?: AbortSignal;
maxBytes?: number;
}): Promise<Buffer>;
/**
* Returns the canonical runtime path pinned by the successful read itself.
* This identifies directory aliases, not inode equivalence across renames.
* Consumers that filter protected sources must require this capability;
* a separate path lookup cannot establish the source of the returned bytes.
*/
readFileWithSource?(params: Parameters<SandboxFsBridge["readFile"]>[0]): Promise<{
data: Buffer;
canonicalPath: string;
/** Canonical POSIX path within the workspace mount; absent for other mounts. */
workspaceRelativePath?: string;
}>;
/** Streams a regular file within the sandbox when the backend supports native copying. */
copyFile?(params: {
sourcePath: string;
destinationPath: string;
cwd?: string;
mkdir?: boolean;
/** Pre-authorized canonical destination from resolvePinnedMutationTarget. */
pinnedPath?: string;
signal?: AbortSignal;
}): Promise<void>;
writeFile(params: {
filePath: string;
cwd?: string;
data: Buffer | string;
encoding?: BufferEncoding;
mkdir?: boolean;
/** Pre-authorized canonical mutation target from resolvePinnedMutationTarget. */
pinnedPath?: string;
signal?: AbortSignal;
}): Promise<void>;
/**
* Atomically creates a file only when no entry already exists at the path.
* Backends without this capability must omit it rather than emulate it with
* a check followed by writeFile.
*/
createFileExclusive?(params: Parameters<SandboxFsBridge["writeFile"]>[0]): Promise<"created" | "exists">;
mkdirp(params: {
filePath: string;
cwd?: string;
/** Pre-authorized canonical destination from resolvePinnedMutationTarget. */
pinnedPath?: string;
signal?: AbortSignal;
}): Promise<void>;
remove(params: {
filePath: string;
cwd?: string;
recursive?: boolean;
force?: boolean;
/** Pre-authorized canonical destination from resolvePinnedMutationTarget. */
pinnedPath?: string;
signal?: AbortSignal;
}): Promise<void>;
rename(params: {
from: string;
to: string;
cwd?: string;
signal?: AbortSignal;
}): Promise<void>;
stat(params: {
filePath: string;
cwd?: string;
signal?: AbortSignal;
}): Promise<SandboxFsStat | null>;
};
//#endregion
//#region src/agents/sandbox/backend-handle.types.d.ts
/**
* Backend-neutral sandbox runtime handles used by Docker, SSH, and future sandbox providers.
*/
type SandboxBackendId = string;
/** Shell exec specification prepared by a sandbox backend for process launch. */
type SandboxBackendExecSpec = {
argv: string[];
env: NodeJS.ProcessEnv;
/** Local transport cwd, independent of the remote command's workdir. */
cwd?: string;
stdinMode: "pipe-open" | "pipe-closed";
/** Synchronously revalidate runtime authority at deferred process admission. */
assertCurrent?: () => void;
finalizeToken?: unknown;
};
type SandboxBackendWorkdirValidation = "host" | "backend";
type SandboxBackendWorkdirValidator = (workdir: string) => Promise<string | null>;
type SandboxBackendPreparedWorkdirDiscarder = (workdir: string) => void;
/** Parameters for backend-managed shell commands used by fs bridges and probes. */
type SandboxBackendCommandParams = {
script: string;
args?: string[];
stdin?: Buffer | string;
allowFailure?: boolean;
signal?: AbortSignal;
};
/** Buffered command result returned by sandbox backend shell helpers. */
type SandboxBackendCommandResult = {
stdout: Buffer;
stderr: Buffer;
code: number;
};
/** Runtime context passed to backend-provided filesystem bridge factories. */
type SandboxFsBridgeContext = {
workspaceDir: string;
agentWorkspaceDir: string;
skillsWorkspaceDir?: string;
readOnlyResourceMounts?: Array<{
hostPath: string;
containerPath: string;
}>;
workspaceAccess: "none" | "ro" | "rw";
containerName: string;
containerWorkdir: string;
docker: {
binds?: string[];
tmpfs?: string[];
};
backend?: {
runShellCommand(params: SandboxBackendCommandParams): Promise<SandboxBackendCommandResult>;
};
};
/** Live sandbox backend handle for command execution, cleanup, and optional fs bridge creation. */
type SandboxBackendHandle = {
id: SandboxBackendId;
runtimeId: string;
runtimeLabel: string;
workdir: string;
env?: Record<string, string>;
configLabel?: string;
configLabelKind?: string;
/**
* Remote backends own cwd existence checks because valid runtime paths may
* not exist in the local workspace mirror. Backend validation must be paired
* with validateWorkdir so cwd is proved after before_tool_call adjustments
* and before env resolution, approval, preflight, and launch.
*/
workdirValidation?: SandboxBackendWorkdirValidation;
validateWorkdir?: SandboxBackendWorkdirValidator;
/** Discard one-shot state created while validating a backend-owned cwd. */
discardPreparedWorkdir?: SandboxBackendPreparedWorkdirDiscarder;
/** Remote cwd roots managed by backend validation. Defaults to workdir. */
workdirRoots?: readonly string[];
capabilities?: {
browser?: boolean;
readOnlyResourceMounts?: boolean;
};
buildExecSpec(params: {
command: string;
workdir?: string;
env: Record<string, string>;
usePty: boolean;
}): Promise<SandboxBackendExecSpec>;
finalizeExec?: (params: {
status: "completed" | "failed";
exitCode: number | null;
timedOut: boolean;
token?: unknown;
}) => Promise<void>;
/** Mint termination-only custody while execution is admitted; retained cleanup cannot run arbitrary commands. */
prepareProcessCleanup?: (env: Record<string, string>) => {
env: Record<string, string>;
terminate: () => Promise<void>;
/** Interrupt may run guest signal handlers, so it retains ordinary live execution checks. */
interrupt: (timeoutMs: number) => Promise<boolean>;
};
runShellCommand(params: SandboxBackendCommandParams): Promise<SandboxBackendCommandResult>;
createFsBridge?: (params: {
sandbox: SandboxFsBridgeContext;
}) => SandboxFsBridge;
};
//#endregion
//#region src/agents/bash-tools.shared.d.ts
/** Sandbox metadata needed to map host workspaces into container exec calls. */
type BashSandboxWorkdirMount = {
hostPath: string;
containerPath: string;
};
type BashSandboxConfig = {
containerName: string;
workspaceDir: string;
containerWorkdir: string;
workdirValidation?: SandboxBackendWorkdirValidation;
validateWorkdir?: SandboxBackendWorkdirValidator;
discardPreparedWorkdir?: (workdir: string) => void;
workdirRoots?: readonly string[];
/** Approved read-only skill mounts that may be selected as an exec workdir. */
readOnlyWorkspaceSkillMounts?: readonly BashSandboxWorkdirMount[];
env?: Record<string, string>;
prepareProcessCleanup?: SandboxBackendHandle["prepareProcessCleanup"];
buildExecSpec?: (params: {
command: string;
workdir?: string;
env: Record<string, string>;
usePty: boolean;
}) => Promise<SandboxBackendExecSpec>;
finalizeExec?: (params: {
status: "completed" | "failed";
exitCode: number | null;
timedOut: boolean;
token?: unknown;
}) => Promise<void>;
};
//#endregion
//#region src/agents/accepted-session-spawn.d.ts
type AcceptedSessionSpawn = {
runId: string;
childSessionKey: string;
sessionUrl?: string;
label?: string;
/** True only when this child owns a terminal completion for its requester. */
expectsCompletionMessage?: boolean;
};
//#endregion
//#region src/agents/agent-run-terminal-receipt.d.ts
type AgentRunTerminalModelRef = {
provider: string;
model: string;
};
type AgentRunTerminalReceipt = {
runId: string;
sessionId: string;
turnId: string;
requested: AgentRunTerminalModelRef;
effective: AgentRunTerminalModelRef & {
responseModel: string;
};
successfulToolNames: string[];
/** Exact saved assistant occurrence, independent of attempt terminal ownership. */
assistantTranscriptIdempotencyKey?: string;
/** A final reply was delivered to the external source conversation. */
sourceReplyDelivered?: true;
rerouted: boolean;
terminalDisposition: "visible" | "not-visible";
};
//#endregion
//#region src/agents/embedded-agent-messaging.types.d.ts
type MessagingToolSend = {
tool: string;
provider: string;
accountId?: string;
to?: string;
threadId?: string;
threadImplicit?: boolean;
threadSuppressed?: boolean;
text?: string;
mediaUrls?: string[];
hasRichContent?: true;
/** Current-source progress (`false`) or completed reply (`true`). */
sourceReplyFinal?: boolean;
};
type MessagingToolSourceReplyPayload = Pick<ReplyPayload, "audioAsVoice" | "attachments" | "channelData" | "interactive" | "mediaUrl" | "mediaUrls" | "presentation" | "text" | "trustedLocalMedia"> & {
idempotencyKey?: string;
transcriptOwner?: true;
/** Current-source progress (`false`) or completed reply (`true`). */
sourceReplyFinal?: boolean;
};
//#endregion
//#region src/agents/mcp-connect-action.d.ts
type McpConnectAction = {
serverName: string;
authorizationUrl: string;
};
//#endregion
//#region src/agents/agent-bundle-mcp-types.d.ts
/** Catalog metadata for one configured MCP server. */
type McpServerCatalog = {
serverName: string;
safeServerName?: string;
launchSummary: string;
toolCount: number;
resources?: {
listChanged?: boolean;
};
prompts?: {
listChanged?: boolean;
};
tools?: {
listChanged?: boolean;
filteredCount?: number;
};
requestTimeoutMs?: number;
supportsParallelToolCalls?: boolean;
toolFilter?: McpServerToolFilterConfig;
deniedToolNames?: string[];
codexApprovalMode?: McpCodexToolApprovalMode;
};
/** MCP tool entry after server-name sanitization and schema normalization. */
type McpCatalogTool = {
serverName: string;
safeServerName: string;
toolName: string;
title?: string;
description?: string;
inputSchema: TSchema;
fallbackDescription: string;
uiResourceUri?: string;
uiVisibility?: Array<"app" | "model">;
/** Listed by the server but excluded from OpenClaw's callable tool catalog. */
excludedFromOpenClawCatalog?: true;
deniedBySession?: true;
codexAnnotations?: McpCodexToolAnnotations;
/** Trusted requester OAuth sign-in bootstrap; never dispatches into the server's tools. */
oauthConnectBootstrap?: true;
};
/** Complete tool catalog for a session-scoped MCP runtime. */
type McpToolCatalog = {
version: number;
generatedAt: number;
servers: Record<string, McpServerCatalog>;
tools: McpCatalogTool[];
/** Complete raw catalog used to project policy into native MCP clients. */
policyTools?: McpCatalogTool[];
/** Listed tools hidden only by the session override, retained for read-only inventory. */
sessionDeniedTools?: McpCatalogTool[];
diagnostics?: readonly McpToolCatalogDiagnostic[];
};
/** Transient requester sign-in surface kept outside the remembered live catalog. */
type RequesterMcpConnect = {
catalog: McpToolCatalog;
authorizedServerNames: readonly string[];
configFingerprint: string;
createExecute: (serverName: string) => AnyAgentTool["execute"] | undefined;
};
type McpToolCatalogDiagnostic = {
serverName: string;
safeServerName: string;
launchSummary: string;
message: string;
};
type McpRequestOptions = {
failureBackoff?: "track" | "ignore";
};
/** Trusted requester identity used to scope per-user MCP connections. */
type SessionMcpRequesterScope = {
requesterSenderId: string;
agentAccountId?: string;
messageChannel?: string;
};
/** Live MCP runtime bound to one session/workspace. */
type SessionMcpRuntime = {
sessionId: string;
sessionKey?: string;
workspaceDir: string;
agentDir?: string;
configFingerprint: string;
/** Present when this runtime is keyed by requester-scoped connection identity. */
requesterScope?: SessionMcpRequesterScope;
requesterConnect?: RequesterMcpConnect;
/**
* True when the named server's connection is requester-scoped. App views for
* such servers stay fail-closed: views outlive the requester-authenticated
* run and the gateway view boundary carries no requester identity.
*/
isRequesterScopedServer?: (serverName: string) => boolean;
mcpAppsEnabled?: boolean;
/** Latest non-persisted App context, owned by the exact live view that supplied it. */
pendingMcpAppModelContext?: {
owner: object;
text: string;
leased?: boolean;
};
/** Blocks a deferred-retirement view from restoring context across reset. */
mcpAppModelContextRevoked?: boolean;
createdAt: number;
lastUsedAt: number;
activeLeases?: number;
acquireLease?: () => () => void;
/** Terminal server outcome recorded at retirement, with no callable tools. */
readonly retiredCatalog?: McpToolCatalog;
/** Lists tools if needed and may connect MCP transports. */
getCatalog: () => Promise<McpToolCatalog>;
/** Returns the cached catalog only; must not start runtimes, connect transports, or issue tools/list. */
peekCatalog: () => McpToolCatalog | null;
/** Returns the configured request timeout for a server from the connected session, without touching the catalog. */
getServerRequestTimeoutMs?: (serverName: string) => number | undefined;
markUsed: () => void;
callTool: (serverName: string, toolName: string, input: unknown) => Promise<CallToolResult>;
listTools?: (serverName: string, params?: {
cursor?: string;
}) => Promise<ListToolsResult>;
listResources?: (serverName: string, options?: McpRequestOptions) => Promise<unknown>;
readResource?: (serverName: string, uri: string, options?: McpRequestOptions) => Promise<unknown>;
listResourceTemplates?: (serverName: string, params?: {
cursor?: string;
}) => Promise<ListResourceTemplatesResult>;
listPrompts?: (serverName: string) => Promise<unknown>;
getPrompt?: (serverName: string, name: string, args?: Record<string, string>) => Promise<GetPromptResult>;
/** Joins cleanup already owned by this runtime, without closing live shared peers.
* Rejects when an earlier retirement or disposal could not confirm closure. */
joinCleanup?: () => Promise<void>;
dispose: () => Promise<void>;
};
//#endregion
//#region src/agents/mcp-ui-resource.d.ts
type McpAppChannelView = {
viewId: string;
};
//#endregion
//#region src/agents/run-trigger.d.ts
type EmbeddedRunTrigger = "cron" | "heartbeat" | "manual" | "memory" | "overflow" | "user";
//#endregion
//#region src/agents/reply-completion.d.ts
type ReplyExpectation = "required" | "optional";
type ReplyDeliveryState = "delivered" | "pending" | "missing";
type ReplyDeliveryObserver = (minimumAssistantMessageIndex?: number) => Promise<ReplyDeliveryState>;
type ReplyCompletionEvidence = "ready" | "delivered" | "pending" | "blocked" | "empty";
/** Model output cannot waive a required reply. Only the input owner selects expectation. */
type ReplyCompletion = {
readonly expectation: "required";
readonly outcome: Exclude<ReplyCompletionEvidence, "empty"> | "missing";
} | {
readonly expectation: "optional";
readonly outcome: Exclude<ReplyCompletionEvidence, "empty"> | "silent";
};
//#endregion
//#region src/agents/embedded-agent-helpers/context-file.d.ts
/** Context file passed into embedded agents as preloaded workspace content. */
type EmbeddedContextFile = {
path: string;
content: string;
/** Preserved from authenticated bootstrap selection across workspace remapping. */
personalUser?: true;
};
//#endregion
//#region src/agents/failover/provider-patterns.d.ts
type ProviderSpecificErrorContext = {
provider?: string;
modelId?: string;
errorMessage: string;
status?: number;
code?: string;
errorType?: string;
providerPlugin?: PreparedProviderFailoverOwner | null;
};
type PreparedProviderFailoverOwner = {
id: string;
matchesContextOverflowError?: (ctx: ProviderSpecificErrorContext) => boolean | undefined;
classifyFailoverReason?: (ctx: ProviderSpecificErrorContext) => FailoverReason | null | undefined;
};
//#endregion
//#region src/plugins/provider-auth-availability.d.ts
declare const { isProviderApiKeyConfigured, listUsableProviderAuthProfileIds, isProviderAuthProfileConfigured, resolveProviderAuthProfileApiKey }: Readonly<{
isProviderApiKeyConfigured: (params: {
provider: string;
cfg?: OpenClawConfig;
agentDir?: string;
profileTypes?: readonly AuthProfileCredential["type"][];
capability?: string;
acceptsApiKey?: (apiKey: string) => boolean;
}) => boolean;
listUsableProviderAuthProfileIds: (params: {
provider: string;
cfg?: OpenClawConfig;
agentDir?: string;
profileTypes?: readonly AuthProfileCredential["type"][];
capability?: string;
allowKeychainPrompt?: boolean;
includeExternalCliAuth?: boolean;
}) => {
agentDir: string;
profileIds: string[];
};
isProviderAuthProfileConfigured: (params: {
provider: string;
cfg?: OpenClawConfig;
agentDir?: string;
profileTypes?: readonly AuthProfileCredential["type"][];
capability?: string;
allowKeychainPrompt?: boolean;
includeExternalCliAuth?: boolean;
}) => boolean;
resolveProviderAuthProfileApiKey: (params: {
provider: string;
cfg?: OpenClawConfig;
agentDir?: string;
profileTypes?: readonly AuthProfileCredential["type"][];
capability?: string;
allowKeychainPrompt?: boolean;
includeExternalCliAuth?: boolean;
}) => Promise<string | undefined>;
}>;
//#endregion
//#region src/realtime-transcription/websocket-session.d.ts
type RealtimeTranscriptionWebSocketTransport = {
readonly callbacks: RealtimeTranscriptionSessionCallbacks;
closeNow(): void;
failConnect(error: Error): void;
isOpen(): boolean;
isReady(): boolean;
markReady(): void;
sendBinary(payload: Buffer): boolean;
sendJson(payload: unknown): boolean;
};
/** Provider-specific hooks for creating a websocket transcription session. */
type RealtimeTranscriptionWebSocketSessionOptions<Event = unknown> = {
callbacks: RealtimeTranscriptionSessionCallbacks;
connectClosedBeforeReadyMessage?: string;
connectTimeoutMessage?: string;
connectTimeoutMs?: number;
closeTimeoutMs?: number;
headers?: Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>);
maxQueuedBytes?: number;
maxReconnectAttempts?: number;
onClose?: (transport: RealtimeTranscriptionWebSocketTransport) => void;
onMessage?: (event: Event, transport: RealtimeTranscriptionWebSocketTransport) => void;
onOpen?: (transport: RealtimeTranscriptionWebSocketTransport) => void;
parseMessage?: (payload: Buffer) => Event;
providerId: string;
readyOnOpen?: boolean;
reconnectDelayMs?: number;
reconnectLimitMessage?: string;
sendAudio: (audio: Buffer, transport: RealtimeTranscriptionWebSocketTransport) => void;
url: string | (() => string | Promise<string>);
};
/** Creates a reusable websocket session wrapper for a provider implementation. */
declare function createRealtimeTranscriptionWebSocketSession<Event = unknown>(options: RealtimeTranscriptionWebSocketSessionOptions<Event>): RealtimeTranscriptionSession;
//#endregion
//#region src/plugins/runtime/model-auth-types.d.ts
/**
* Runtime-ready auth result exposed to native plugins and context engines.
*
* `source`, `mode`, and `profileId` describe how the original credential was
* resolved. `apiKey` is the request-ready credential after any provider-owned
* runtime exchange, so it may differ from the stored/raw credential.
*/
type ResolvedProviderRuntimeAuth = Omit<ResolvedProviderAuth, "apiKey"> & {
apiKey?: string;
baseUrl?: string;
request?: ModelProviderRequestTransportOverrides$1;
expiresAt?: number;
};
//#endregion
//#region src/plugins/capability-catalog-context.types.d.ts
/** Host operations stay native; catalog construction must not start sessions or read stores. */
type PluginCapabilityCatalogContext = {
isProviderApiKeyConfigured: typeof isProviderApiKeyConfigured;
isProviderAuthProfileConfigured: typeof isProviderAuthProfileConfigured;
resolveAgentDir: typeof resolveAgentDir;
createRealtimeTranscriptionWebSocketSession: typeof createRealtimeTranscriptionWebSocketSession;
resolveProviderRequestHeaders: typeof resolveProviderRequestHeaders;
resolveProviderAuthProfileApiKey: typeof resolveProviderAuthProfileApiKey;
resolveApiKeyForProvider: typeof resolveApiKeyForProviderCore;
/** @deprecated Use the host context's captureWsEventAsync; retained for shipped plugins. */
captureWsEvent: typeof captureWsEvent;
createDebugProxyWebSocketAgent: typeof createDebugProxyWebSocketAgent;
resolveDebugProxySettings: typeof resolveDebugProxySettings;
fetchWithSsrFGuard: typeof fetchWithSsrFGuard;
createProviderHttpError: typeof createProviderHttpError;
readProviderJsonResponse: typeof readProviderJsonResponse;
readProviderTextResponse: typeof readProviderTextResponse;
formatErrorMessage: typeof formatErrorMessage;
warn: typeof warn;
redactSensitiveText: typeof redactSensitiveText;
};
type PluginCapabilityCatalogEntry = PluginCapabilityCatalog | ((context: PluginCapabilityCatalogContext) => PluginCapabilityCatalog);
/** Native hosts supply asynchronous capture while preserving the legacy plugin context. */
type PluginCapabilityCatalogHostContext = PluginCapabilityCatalogContext & {
captureWsEventAsync: typeof captureWsEventAsync;
};
type PluginCapabilityCatalogHostEntry = PluginCapabilityCatalog | ((context: PluginCapabilityCatalogHostContext) => PluginCapabilityCatalog);
//#endregion
//#region src/plugins/plugin-runtime-artifact-selection.d.ts
type PluginRuntimeArtifact = {
source: string;
rootDir: string;
};
//#endregion
//#region src/plugins/sdk-alias.d.ts
type PluginSdkResolutionPreference = "auto" | "dist" | "src";
//#endregion
//#region src/plugins/loader-types.d.ts
type ChannelPluginLoadIntent = "full" | "setup";
/** Host-owned recovery of one previously admitted runtime, never current package discovery. */
type PluginRuntimeRecovery = {
module: PluginModuleLoaderRecovery;
runtimeEntry: PluginRuntimeArtifact;
setupEntry?: PluginRuntimeArtifact;
};
/** Inputs shared by runtime, snapshot, and CLI-metadata plugin loading. */
type PluginLoadOptions = {
config?: OpenClawConfig;
/** Provider lookup config before activation copies; only captured generations may share. */
registrationConfigOrigin?: OpenClawConfig;
activationSourceConfig?: OpenClawConfig;
autoEnabledReasons?: Readonly<Record<string, string[]>>;
workspaceDir?: string;
installRecords?: Record<string, PluginInstallRecord>;
/** Resolve plugin roots and load paths against an explicit environment. */
env?: NodeJS.ProcessEnv;
/** Apply the config IO env-substitution pass to direct raw-config callers. */
resolveRawConfigEnvVars?: boolean;
logger?: PluginLogger$1;
coreGatewayHandlers?: Record<string, GatewayRequestHandler>;
coreGatewayMethodNames?: readonly string[];
/** Registry-construction fact supplied by the process composition root. */
allowProcessHomeSessionCatalogs?: boolean;
hostServices?: PluginRegistryParams["hostServices"];
runtimeOptions?: CreatePluginRuntimeOptions;
startupTrace?: {
detail: (name: string, metrics: ReadonlyArray<readonly [string, number | string]>) => void;
};
pluginSdkResolution?: PluginSdkResolutionPreference;
cache?: boolean;
mode?: "full" | "validate" | "cli-metadata";
onlyPluginIds?: string[];
includeSetupOnlyChannelPlugins?: boolean;
forceSetupOnlyChannelPlugins?: boolean;
/** Select full runtime registration or the lightweight unconfigured-channel setup path. */
channelPluginLoadIntent?: ChannelPluginLoadIntent;
/** Built hosts prefer canonical checkout artifacts by default; false retains source execution. */
preferBuiltPluginArtifacts?: boolean;
toolDiscovery?: boolean;
/** Native host operations supplied by a runtime composition root. */
capabilityCatalogContext?: PluginCapabilityCatalogHostContext;
/** Resolve declared descriptors for this family without full runtime registration. */
capabilityCatalog?: {
family: keyof PluginCapabilityCatalog;
context: PluginCapabilityCatalogHostContext;
};
activate?: boolean;
/** Staged Gateway candidates expose runtime APIs only after publication or owner preparation. */
runtimeSideEffects?: boolean;
previousRegistry?: PluginRegistry;
/**
* Live runtime registry whose unchanged records a non-activating load lists without
* loading its own copies. The lender keeps custody and retirement of those instances.
*/
borrowRegistry?: PluginRegistry;
replacePluginIds?: readonly string[];
moduleRecoveries?: ReadonlyMap<string, PluginRuntimeRecovery>;
/** Preserve host cleanup hooks before failed registration removes its contributions. */
prepareRegistrationFailureCleanup?: (registry: PluginRegistry, record: PluginRecord) => void;
/** Validate captured source before evaluation; this never grants plugin authority. */
expectedSourceDigests?: Readonly<Record<string, string>>;
loadModules?: boolean;
throwOnLoadError?: boolean;
manifestRegistry?: PluginManifestRegistry;
discovery?: PluginDiscoveryResult;
};
//#endregion
//#region src/plugins/provider-hook-runtime-core.d.ts
type ProviderRuntimePluginLookupParams = {
provider: string;
providerOwner?: string;
modelId?: string | null;
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
applyAutoEnable?: boolean;
pluginMetadataSnapshot?: PluginMetadataRegistryView;
};
type ProviderRuntimePluginHandle = ProviderRuntimePluginLookupParams & {
plugin?: ProviderPlugin;
};
//#endregion
//#region src/agents/system-prompt-contribution.d.ts
/**
* Provider-owned system prompt contribution types.
* Separates cache-stable prefixes, dynamic suffixes, and section overrides for
* runtime prompt assembly.
*/
/** Core system-prompt sections that providers may replace. */
type ProviderSystemPromptSectionId = "interaction_style" | "tool_call_style" | "execution_bias";
/** Provider guidance merged into the assembled agent system prompt. */
type ProviderSystemPromptContribution = {
/**
* Cache-stable provider guidance inserted above the system-prompt cache boundary.
*
* Use this for static provider/model-family instructions that should preserve
* KV cache reuse across turns.
*/
stablePrefix?: string;
/**
* Provider guidance inserted below the cache boundary.
*
* Use this only for genuinely dynamic text that is expected to vary across
* runs or sessions.
*/
dynamicSuffix?: string;
/**
* Whole-section replacements for selected core prompt sections.
*
* Values should contain the complete rendered section, including any desired
* heading such as `## Tool Call Style`.
*/
sectionOverrides?: Partial<Record<ProviderSystemPromptSectionId, string>>;
};
//#endregion
//#region src/infra/provider-usage.types.d.ts
/** One quota window reported by a provider usage endpoint. */
type UsageWindow = {
label: string;
groupLabel?: string;
usedPercent: number;
resetAt?: number;
};
/** Provider-reported monetary or credit facts. Units may be ISO currencies or provider credits. */
type ProviderUsageBilling = {
type: "balance";
label?: string;
amount: number;
unit: string;
} | {
type: "spend";
label?: string;
amount: number;
unit: string;
period?: string;
resetAt?: number;
} | {
type: "budget";
label?: string;
used: number;
limit: number;
unit: string;
period?: string;
resetAt?: number;
};
/** Provider-reported daily cost and token totals. Costs are actual provider billing, not estimates. */
type ProviderUsageCostDaily = {
date: string;
amount: number;
requests?: number;
inputTokens: number;
cacheReadTokens: number;
cacheWriteTokens: number;
outputTokens: number;
totalTokens: number;
};
/** Aggregate model activity for the provider history window. */
type ProviderUsageModelBreakdown = Omit<ProviderUsageCostDaily, "date" | "amount"> & {
name: string;
};
/** Aggregate provider billing category for the history window. */
type ProviderUsageCostBreakdown = {
name: string;
amount: number;
};
/** Provider-reported cost history and attribution for one bounded UTC window. */
type ProviderUsageCostHistory = {
unit: string;
periodDays: number;
scope?: string;
daily: ProviderUsageCostDaily[];
models: ProviderUsageModelBreakdown[];
categories: ProviderUsageCostBreakdown[];
};
type ProviderUsageSnapshot = {
provider: UsageProviderId;
displayName: string;
windows: UsageWindow[];
billing?: ProviderUsageBilling[];
costHistory?: ProviderUsageCostHistory;
summary?: string;
plan?: string;
/** Account identity (email) the usage was fetched under, when known. */
accountEmail?: string;
error?: string;
};
/** Normalized provider id. Usage providers are discovered from plugin hooks at runtime. */
type UsageProviderId = string;
//#endregion
//#region src/plugins/cli-backend.types.d.ts
type CliBackendNoOutputWatchdog = {
/** Fraction of overall timeout used when fixed timeout is not set. */
noOutputTimeoutRatio?: number;
/** Lower bound for computed watchdog timeout. */
minMs?: number;
/** Upper bound for computed watchdog timeout. */
maxMs?: number;
};
/** Static command adapter owned by a CLI backend plugin registration. */
type CliBackendConfig = {
/** CLI command to execute (absolute path or on PATH). */
command: string;
/** Base args applied to every invocation. */
args?: string[];
/** Output parsing mode (default: json). */
output?: "json" | "text" | "jsonl";
/** Output parsing mode when resuming a CLI session. */
resumeOutput?: "json" | "text" | "jsonl";
/** JSONL event dialect for CLIs with provider-specific stream formats. */
jsonlDialect?: "claude-stream-json" | "gemini-stream-json";
/** Long-lived CLI process mode. */
liveSession?: "claude-stdio";
/** Prompt input mode (default: arg). */
input?: "arg" | "stdin";
/** Max prompt length for arg mode (if exceeded, stdin is used). */
maxPromptArgChars?: number;
/** Extra env vars injected for this CLI. */
env?: Record<string, string>;
/** Env vars to remove before launching this CLI. */
clearEnv?: string[];
/** Flag used to pass model id (e.g. --model). */
modelArg?: string;
/** Model aliases mapping (OpenClaw model id → CLI model id). */
modelAliases?: Record<string, string>;
/** Args used to pass a session id (use {sessionId} placeholder). */
sessionArgs?: string[];
/** Alternate args to use when resuming a session (use {sessionId} placeholder). */
resumeArgs?: string[];
/** Argument appended to one explicitly forked resume invocation. */
forkArg?: string;
/** Argument followed by an assistant checkpoint id to bound one resumed fork. */
resumeAtArg?: string;
/** When to pass session ids. */
sessionMode?: "always" | "existing" | "none";
/** JSON fields to read session id from (in order). */
sessionIdFields?: string[];
/** Flag used to pass system prompt. */
systemPromptArg?: string;
/** Flag used to pass a system prompt file. */
systemPromptFileArg?: string;
/** Config override flag used to pass a system prompt file (e.g. -c). */
systemPromptFileConfigArg?: string;
/** Config override key used to pass a system prompt file. */
systemPromptFileConfigKey?: string;
/** System prompt behavior (append vs replace). */
systemPromptMode?: "append" | "replace";
/** When to send system prompt. */
systemPromptWhen?: "first" | "always" | "never";
/** Flag used to pass image paths. */
imageArg?: string;
/** How to pass multiple images. */
imageMode?: "repeat" | "list";
/** Where staged image files should live before handing them to the CLI. */
imagePathScope?: "temp" | "workspace";
/** Serialize runs for this CLI. */
serialize?: boolean;
/** Opt in to bounded raw transcript reseed before compaction for safe session resets. */
reseedFromRawTranscriptWhenUncompacted?: boolean;
/**
* Controls fresh recovery after a recoverable resumed-session failure.
*
* Undefined and `replace-binding` preserve the legacy clear-and-reseed behavior.
* `invalidated-only` retries fresh only when the failure proves the binding expired.
*/
freshSessionRecovery?: "replace-binding" | "invalidated-only";
/** Runtime reliability tuning for this backend's process lifecycle. */
reliability?: {
/** No-output watchdog tuning (fresh vs resumed runs). */
watchdog?: {
/** Fresh/new sessions (non-resume). */
fresh?: CliBackendNoOutputWatchdog;
/** Resume sessions. */
resume?: CliBackendNoOutputWatchdog;
};
};
};
type PluginTextReplacement = {
from: string | RegExp;
to: string;
};
type PluginTextTransforms = {
/** Rewrites applied to outbound prompt text before provider/CLI transport. */
input?: PluginTextReplacement[];
/** Rewrites applied to inbound assistant text before OpenClaw consumes it. */
output?: PluginTextReplacement[];
};
type CliBundleMcpMode = "claude-config-file" | "codex-config-overrides" | "gemini-system-settings";
type CliBackendPrepareExecutionContext = {
config?: OpenClawConfig;
workspaceDir: string;
agentDir?: string;
provider: string;
modelId: string;
/** Effective catalog context-window option selected for this run. */
contextWindow?: string;
/** Effective OpenClaw context budget selected for this run. */
contextTokenBudget?: number;
/** Effective OpenClaw thinking level selected for this run. */
thinkingLevel?: CliBackendThinkingLevel;
authProfileId?: string;
executionMode?: CliBackendExecutionMode;
/** Exact runtime tool surface the backend must enforce for this run. */
toolAvailability?: CliBackendToolAvailability;
/** Core-prepared environment, including any bundled MCP settings path. */
env?: Readonly<Record<string, string>>;
};
type CliBackendPreparedExecution = {
env?: Record<string, string>;
clearEnv?: string[];
/**
* Backend-owned staging that must run after the core CLI queue admits the turn.
* Use this for mutable per-profile CLI homes that the launched process also owns.
*/
beforeExecution?: () => Promise<void>;
cleanup?: () => Promise<void>;
/** Positive acknowledgement for `prepare-execution` tool enforcement. */
toolAvailabilityEnforced?: true;
/** Optional plugin-owned execution transport for this prepared local run. */
execute?: CliBackendExecute;
};
type CliBackendThinkingLevel = "off" | "minimal" | "low" | "medium" | "high" | "xhigh" | "adaptive" | "max";
type CliBackendExecutionMode = "agent" | "side-question";
/** Exact backend-native plus canonical OpenClaw tool surface for one CLI run. */
type CliBackendToolAvailability = {
native: readonly string[];
/** Canonical OpenClaw tool names served through the host-isolated transport. */
openClaw: readonly string[];
};
/** Native action a plugin-owned runtime asks the admitted host run to authorize. */
type CliBackendToolPermissionRequest = {
/** Actual working directory reported by the native permission hook. */
cwd?: string;
toolName: string;
toolInput: Record<string, unknown>;
toolCallId?: string;
abortSignal?: AbortSignal;
};
/** Host-owned native action decision; plugins never acquire approval authority. */
type CliBackendToolPermissionResult = {
behavior: "allow";
updatedInput: Record<string, unknown>;
} | {
behavior: "deny";
message: string;
};
type CliBackendUserInputOption = {
label: string;
description?: string;
};
type CliBackendUserInputQuestion = {
id: string;
header: string;
question: string;
multiSelect?: boolean;
isOther?: boolean;
options?: readonly CliBackendUserInputOption[] | null;
};
/** Structured operator input requested by a plugin-owned native runtime. */
type CliBackendUserInputRequest = {
toolName: string;
questions: readonly CliBackendUserInputQuestion[];
intro?: string;
toolCallId?: string;
abortSignal?: AbortSignal;
};
type CliBackendUserInputResult = {
status: "answered";
answers: Record<string, string[]>;
} | {
status: "cancelled";
message: string;
};
/** Lifecycle reasons accepted by a plugin-owned reusable execution process. */
type CliBackendLiveSessionCloseReason = "idle" | "restart" | "abort" | "mcp-capture-rotation";
/** Plugin-owned process lifecycle registered with the generic host owner. */
type CliBackendLiveSessionHandle = {
generation: string;
fingerprint: string;
isIdle(): boolean;
close(reason: CliBackendLiveSessionCloseReason, error?: unknown): void;
waitForExit(): Promise<void>;
};
/** Closure-bound host capability for one admitted reusable-runtime turn. */
type CliBackendLiveSessionCapability = {
fingerprint: string;
current(): CliBackendLiveSessionHandle | undefined;
/** Retires the current process and awaits host-owned cleanup before replacement. */
restart(): Promise<void>;
register(handle: CliBackendLiveSessionHandle): void;
/** Rebinds this exact admitted turn to the registered process's stable capture. */
activate(handle: CliBackendLiveSessionHandle): void;
remove(handle: CliBackendLiveSessionHandle): void;
};
/** Turn-only context that must not become an operator-authored native transcript row. */
type CliBackendPromptContext = {
prependContext?: string;
appendContext?: string;
};
/** Exact prepared local process facts consumed by a plugin-owned execution transport. */
type CliBackendExecuteContext = {
command: string;
/** Preserve a verified invocation name when command resolves through a PATH shim. */
argv0?: string;
args: readonly string[];
cwd: string;
env: Record<string, string>;
prompt: string;
promptContext?: CliBackendPromptContext;
modelId: string;
systemPrompt: string;
sessionId?: string;
useResume: boolean;
abortSignal?: AbortSignal;
/** Revalidate the host-owned run and caller before deferred credential use or dispatch. */
assertCurrent?: () => void;
timeoutMs: number;
executionMode?: CliBackendExecutionMode;
toolAvailability?: CliBackendToolAvailability;
/** Exact host-owned reusable process lifecycle and current-turn admission. */
liveSession?: CliBackendLiveSessionCapability;
/** Closure-bound approval capability; retained copies fail after the run closes. */
requestToolPermission: (request: CliBackendToolPermissionRequest) => Promise<CliBackendToolPermissionResult>;
/** Closure-bound structured-input capability; retained copies fail after the run closes. */
requestUserInput: (request: CliBackendUserInputRequest) => Promise<CliBackendUserInputResult>;
};
/** Plugin-owned runtime yielding the backend's existing structured stream records. */
type CliBackendExecute = (context: CliBackendExecuteContext) => AsyncIterable<Record<string, unknown>>;
type CliBackendResolveExecutionArgsContext = {
config?: OpenClawConfig;
workspaceDir: string;
provider: string;
modelId: string;
authProfileId?: string;
thinkingLevel?: CliBackendThinkingLevel;
/** Effective fast mode at spawn, after queue admission and backend preparation. */
fastMode?: boolean;
executionMode?: CliBackendExecutionMode;
toolAvailability?: CliBackendToolAvailability;
useResume: boolean;
baseArgs: readonly string[];
};
type CliBackendResolveExecutionArgs = (ctx: CliBackendResolveExecutionArgsContext) => readonly string[] | null | undefined;
type CliBackendResolveModelIdContext = {
modelId: string;
contextWindow?: string;
};
type CliBackendJsonlUsage = {
input?: number;
output?: number;
cacheRead?: number;
cacheWrite?: number;
total?: number;
};
type CliBackendParsedJsonlEvent = {
kind: "text";
text: string;
} | {
kind: "thinking";
text: string;
} | {
kind: "toolStart";
toolCallId: string;
name: string;
args?: Record<string, unknown>;
} | {
kind: "toolResult";
toolCallId: string;
name?: string;
isError?: boolean;
result?: unknown;
} | {
kind: "result";
text?: string;
sessionId?: string;
usage?: CliBackendJsonlUsage;
errorText?: string;
} | {
kind: "sessionId";
sessionId: string;
};
type CliBackendParseJsonlEventContext = {
backendId: string;
backend: Readonly<CliBackendConfig>;
};
type CliBackendParseJsonlEvent = (line: string, ctx: CliBackendParseJsonlEventContext) => CliBackendParsedJsonlEvent | readonly CliBackendParsedJsonlEvent[] | null | undefined;
type CliBackendParsedJsonlLifecycleEvent = {
kind: "compaction";
phase: "start";
} | {
kind: "compaction";
phase: "end";
completed: boolean;
};
type CliBackendParseJsonlLifecycleEvent = (line: string, ctx: CliBackendParseJsonlEventContext) => CliBackendParsedJsonlLifecycleEvent | readonly CliBackendParsedJsonlLifecycleEvent[] | null | undefined;
type CliBackendAuthEpochMode = "combined" | "profile-only";
type CliBackendNativeToolMode = "none" | "always-on" | "selectable";
/** Backend-owned mechanism that enforces exact per-run tool availability. */
type CliBackendToolAvailabilityEnforcement = "execution-args" | "prepare-execution";
type CliBackendSideQuestionToolMode = "disabled";
type CliBackendExactToolAvailabilityVersionPolicy = Readonly<{
/** Inclusive floor for stable package releases. */
stableMinimum: string;
/** Inclusive floors keyed by the first SemVer prerelease identifier. */
prereleaseMinimums?: Readonly<Record<string, string>>;
}>;
type CliBackendNormalizeConfigContext = {
config?: OpenClawConfig;
backendId: string;
agentId?: string;
};
/** Backend-owned implementation boundary for script-backed CLI executables. */
type CliBackendRuntimeArtifactPolicy = Readonly<{
kind: "bundled-package-tree";
/** Exact package.json name whose complete installed tree owns inference. */
packageName: string;
/** Only the command itself may be the package entrypoint. */
entrypoint: "command";
/** Supported package release lines when a run requests exact tool availability. */
exactToolAvailabilityVersionPolicy?: CliBackendExactToolAvailabilityVersionPolicy;
/** Canonical basenames allowed when this backend ships a self-contained native build. */
nativeExecutableNames?: readonly string[];
}>;
/** Complete backend-owned contract for in-place native session compaction. */
type CliBackendManualCompaction = Readonly<{
/** Builds the exact backend command for the resumed native session. */
buildPrompt: (customInstructions?: string) => string;
/** Prompt transport required by the backend control command. */
input: "arg" | "stdin";
/** Positively confirms that a successful process exit performed compaction. */
validateOutput: (rawOutput: string) => {
ok: true;
} | {
ok: false;
reason: string;
};
}>;
/** Plugin-owned CLI backend defaults used by the text-only CLI runner. */
type CliBackendPluginBase = {
/** Provider id used in model refs, for example `claude-cli/opus`. */
id: string;
/** Canonical model provider whose models this CLI backend can execute. */
modelProvider?: string;
/** Static command adapter owned by this plugin. */
config: CliBackendConfig;
/**
* Context-engine host capabilities provided by this backend when it is
* driven through the generic CLI runner.
*/
contextEngineHostCapabilities?: readonly ContextEngineHostCapability[];
/**
* Whether embedded runs opted into `cliBackendDispatch: "subscription-auth"`
* execute through this backend when the selected credential is
* subscription-scoped (oauth/token) or unresolvable.
*
* Set only when this backend's model provider rejects or meters direct API
* calls on subscription tokens, so the passthrough would fail or silently
* bill outside plan limits. API-key credentials always keep the passthrough.
*/
subscriptionAuthDispatch?: boolean;
/**
* Optional live-smoke metadata owned by the backend plugin.
*
* Keep provider-specific test wiring here instead of scattering it across
* Docker wrappers, docs, and gateway live tests.
*/
liveTest?: {
defaultModelRef?: string;
defaultImageProbe?: boolean;
defaultMcpProbe?: boolean;
docker?: {
npmPackage?: string;
binaryName?: string;
};
};
/** Required whenever this backend can become a verified inference owner. */
runtimeArtifact?: CliBackendRuntimeArtifactPolicy;
/**
* Whether OpenClaw should inject bundle MCP config for this backend.
*
* Keep this opt-in. Only backends that explicitly consume OpenClaw's bundle
* MCP bridge should enable it.
*/
bundleMcp?: boolean;
/**
* Provider-owned bundle MCP integration strategy.
*
* Different CLIs wire MCP through different surfaces:
* - Claude: `--strict-mcp-config --mcp-config`
* - Codex: `-c mcp_servers=...`
* - Gemini: system-level `settings.json`
*/
bundleMcpMode?: CliBundleMcpMode;
/**
* Optional config normalizer applied to the registered adapter.
*/
normalizeConfig?: (config: CliBackendConfig, context?: CliBackendNormalizeConfigContext) => CliBackendConfig;
/**
* Backend-owned final system-prompt transform.
*
* Use this for tiny CLI-specific compatibility rewrites without replacing
* the generic CLI runner or prompt builder.
*/
transformSystemPrompt?: (ctx: {
config?: OpenClawConfig;
workspaceDir?: string;
provider: string;
modelId: string;
modelDisplay: string;
agentId?: string;
systemPrompt: string;
}) => string | null | undefined;
/**
* Backend-owned bidirectional text replacements.
*
* `input` applies to the system prompt and user prompt passed to the CLI.
* `output` applies to parsed/streamed assistant text from the CLI.
*/
textTransforms?: PluginTextTransforms;
/**
* Preferred auth-profile id when the caller did not explicitly lock one.
*
* Use this when the backend should consume a canonical OpenClaw auth profile
* rather than ambient host auth by default.
*/
defaultAuthProfileId?: string;
/**
* Session/auth epoch source policy.
*
* `combined` keeps the legacy "host credential + auth profile" fingerprint.
* `profile-only` treats the selected OpenClaw auth profile as the sole auth
* owner for session invalidation when one is present.
*/
authEpochMode?: CliBackendAuthEpochMode;
/**
* Whether `prepareExecution` may auto-select a configured auth profile.
*
* Defaults to true for auth bridges. Set false for environment/config-only
* hooks that do not consume OpenClaw auth profiles.
*/
autoSelectAuthProfile?: boolean;
/**
* Backend-owned execution bridge.
*
* Use this on async run paths when the backend needs a generated auth/config
* bridge (for example a private CLI home directory) without teaching the core
* runner about provider-specific file formats.
*/
prepareExecution?: (ctx: CliBackendPrepareExecutionContext) => Promise<CliBackendPreparedExecution | null | undefined> | CliBackendPreparedExecution | null | undefined;
/**
* Backend-owned per-run argv rewrite.
*
* Use this for request-scoped CLI dialect flags that should not be modeled
* as static config, such as mapping OpenClaw thinking levels to a backend's
* native effort flag.
*/
resolveExecutionArgs?: CliBackendResolveExecutionArgs;
/** Backend-owned native model id selected from validated session metadata. */
resolveModelId?: (ctx: CliBackendResolveModelIdContext) => string;
/** How this backend enforces an exact per-run `toolAvailability` contract. */
toolAvailabilityEnforcement?: CliBackendToolAvailabilityEnforcement;
/**
* Exact-tool execution suppresses ambient instruction files, skills, hooks,
* and plugins so the host-prepared instruction snapshot remains authoritative.
* Required for rooted runs; omission keeps those runs unavailable.
*/
isolatesInstructionsWithExactTools?: true;
/**
* Maps the observed native list, intersected with the host selection, to equivalent
* cron capabilities: read/write/edit/apply_patch/exec/process/web_search/web_fetch.
* Never infer capabilities decided by unobserved model or sandbox settings.
* Core rejects other names before grant/capture and excludes node/tool-disabled runs.
*/
projectNativeToolAuthority?: (nativeTools: readonly string[]) => readonly string[];
/**
* Backend-owned JSONL line parser for provider-specific stream formats.
*
* Tool events report execution already performed by the backend. OpenClaw
* renders them but does not treat them as host tool execution or delivery evidence.
*/
parseJsonlEvent?: CliBackendParseJsonlEvent;
/**
* Optional lifecycle parser kept separate from the legacy JSONL event union.
* Existing plugins can continue exhaustively matching `parseJsonlEvent` results.
*/
parseJsonlLifecycleEvent?: CliBackendParseJsonlLifecycleEvent;
/**
* Whether this CLI backend can expose native tools outside OpenClaw's tool
* catalog. Exact restricted runs require `selectable` plus a declared
* `toolAvailabilityEnforcement`; `always-on` backends fail closed.
*/
nativeToolMode?: CliBackendNativeToolMode;
/**
* Side-question native tool behavior.
*
* Set to `disabled` only when `executionMode: "side-question"` reliably
* launches the CLI without native tools, even if normal agent turns expose
* backend-owned tools.
*/
sideQuestionToolMode?: CliBackendSideQuestionToolMode;
};
type CliBackendNativeCompactionContract = {
/** Backend-owned compaction for a persisted resumable CLI transcript. */
ownsNativeCompaction: true;
/** Optional control operation for explicit manual compaction. */
manualCompaction?: CliBackendManualCompaction;
} | {
/** Boolean-compatible ownership for existing plugins without manual compaction. */
ownsNativeCompaction?: boolean;
manualCompaction?: never;
};
/** Plugin-owned CLI backend defaults used by the text-only CLI runner. */
type CliBackendPlugin$1 = CliBackendPluginBase & CliBackendNativeCompactionContract;
//#endregion
//#region src/agents/system-prompt.types.d.ts
type PromptMode = "full" | "minimal" | "none";
type SilentReplyPromptMode = "generic" | "none";
//#endregion
//#region src/plugins/provider-oauth-flow.d.ts
/** Prompt payload used when OAuth flow code entry needs user input. */
type OAuthPrompt = {
message: string;
placeholder?: string;
};
/** Creates OAuth callbacks that use local browser auth locally and manual code entry on VPS hosts. */
declare function createVpsAwareOAuthHandlers(params: {
isRemote: boolean;
prompter: WizardPrompter;
runtime: RuntimeEnv;
spin: ReturnType<WizardPrompter["progress"]>;
openUrl: (url: string) => Promise<unknown>;
localBrowserMessage: string;
manualPromptMessage?: string;
manualPromptSignal?: AbortSignal;
}): {
onAuth: (event: {
url: string;
}) => Promise<void>;
onPrompt: (prompt: OAuthPrompt) => Promise<string>;
};
//#endregion
//#region src/plugins/provider-authentication.types.d.ts
type ProviderAuthKind = "oauth" | "api_key" | "token" | "device_code" | "custom";
type ProviderAuthSecretStorage = {
/** Final persistence target. The inline credential remains available for staged validation. */
kind: "store";
/** Environment-style prefix used for the host-owned secret-store entry. */
namePrefix: string;
};
type ProviderAuthProfile = {
profileId: string;
credential: AuthProfileCredential;
/** Request host-owned SecretRef materialization at the final persistence boundary. */
secretStorage?: ProviderAuthSecretStorage;
};
/** Standard result payload returned by provider auth methods. */
type ProviderAuthResult = {
profiles: ProviderAuthProfile[];
/**
* Optional config patch to merge after credentials are written.
*
* Use this for provider-owned onboarding defaults such as
* `models.providers.<id>` entries, default aliases, or agent model helpers.
* The caller still persists auth-profile bindings separately.
*/
configPatch?: Partial<OpenClawConfig>;
defaultModel?: string;
notes?: string[];
/**
* Opt in to replace `agents.defaults.models` wholesale with the patch map.
* Default behavior merges the map so other providers' entries survive.
* Set only from migrations that intentionally rename/remove model keys.
*/
replaceDefaultModels?: boolean;
};
/** Interactive auth context passed to provider login/setup methods. */
type ProviderAuthContext = {
config: OpenClawConfig;
/** Host-authorized profiles available for reconnect; personal flows supply only their owner's selection. */
existingProfiles?: readonly ProviderAuthProfile[];
/** Save connection credentials without discovering or selecting a starter model. */
credentialOnly?: boolean;
env?: NodeJS.ProcessEnv;
agentDir?: string;
workspaceDir?: string;
prompter: WizardPrompter;
runtime: RuntimeEnv;
/** Cancels browser callbacks, device polling, and other app-owned auth work. */
signal?: AbortSignal;
/** Personal-account methods must recheck live caller authority immediately before external effects. */
assertCurrent?: () => void;
/**
* Optional onboarding CLI options that triggered this auth flow.
*
* Present for setup/configure/auth-choice flows so provider methods can
* honor preseeded flags like `--openai-api-key` or generic
* `--token/--token-provider` pairs. Direct `models auth login` usually
* leaves this undefined.
*/
opts?: ProviderAuthOptionBag;
/**
* Onboarding secret persistence preference.
*
* Interactive wizard flows set this when the caller explicitly requested
* plaintext or env/file/exec/store ref storage. Ad-hoc `models auth login` flows
* usually leave it undefined.
*/
secretInputMode?: SecretInputMode;
/**
* Whether the provider auth flow should offer the onboarding secret-storage
* mode picker when `secretInputMode` is unset.
*
* This is true for onboarding/configure flows and false for direct
* `models auth` commands, which should keep a tighter, provider-owned prompt
* surface.
*/
allowSecretRefPrompt?: boolean;
isRemote: boolean;
openUrl: (url: string) => Promise<void>;
oauth: {
createVpsAwareHandlers: typeof createVpsAwareOAuthHandlers;
authorize?: (params: {
state: string;
timeoutMs: number;
buildAuthorizationUrl: (redirectUrl: string) => string;
}) => Promise<{
code: string;
state: string;
}>;
};
};
type ProviderNonInteractiveApiKeyResult = {
key: string;
source: "profile" | "env" | "flag";
envVarName?: string;
};
type ProviderResolveNonInteractiveApiKeyParams = {
provider: string;
flagValue?: string;
flagName: `--${string}`;
envVar: string;
envVarName?: string;
allowProfile?: boolean;
required?: boolean;
};
type ProviderNonInteractiveApiKeyCredentialParams = {
provider: string;
resolved: ProviderNonInteractiveApiKeyResult;
email?: string;
metadata?: Record<string, string>;
};
type ProviderAuthMethodNonInteractiveContext = {
authChoice: string;
config: OpenClawConfig;
baseConfig: OpenClawConfig;
opts: ProviderAuthOptionBag;
runtime: RuntimeEnv;
agentDir?: string;
workspaceDir?: string;
resolveApiKey: (params: ProviderResolveNonInteractiveApiKeyParams) => Promise<ProviderNonInteractiveApiKeyResult | null>;
toApiKeyCredential: (params: ProviderNonInteractiveApiKeyCredentialParams) => ApiKeyCredential$1 | null;
};
type ProviderAuthMethodNonInteractiveValidationContext = Omit<ProviderAuthMethodNonInteractiveContext, "toApiKeyCredential">;
/** Read-only context for app-guided discovery of already available inference. */
type ProviderAppGuidedSetupContext = {
config: OpenClawConfig;
env: NodeJS.ProcessEnv;
workspaceDir?: string;
signal?: AbortSignal;
};
type ProviderAppGuidedSetupCandidate = {
/** Canonical provider/model reference returned unchanged during activation. */
modelRef: string;
/** Optional provider-owned detail shown beside the auth-choice label. */
detail?: string;
};
type ProviderAppGuidedSetup = {
/**
* Report whether the provider's local service is reachable, even when no
* model is suitable for automatic activation. This probe must be read-only.
*/
detectAvailability?: (ctx: ProviderAppGuidedSetupContext) => Promise<boolean>;
/** Detection is read-only: no model pull, download, login, or config write. */
detect: (ctx: ProviderAppGuidedSetupContext) => Promise<ProviderAppGuidedSetupCandidate | null>;
/** Recheck one detected model and return the config required for a live probe. */
prepare: (ctx: ProviderAppGuidedSetupContext & {
modelRef: string;
}) => Promise<ProviderAuthResult | null>;
};
type ProviderAuthMethod = {
id: string;
label: string;
hint?: string;
kind: ProviderAuthKind;
/** Provider-owned model used to validate app-guided secret setup. */
starterModel?: string;
/** One-time import attempted only after the user starts this login method. */
credentialImport?: {
migrationProviderId: string;
itemId: string;
credentialKind: "oauth" | "api_key" | "token";
};
/**
* Optional wizard/onboarding metadata for this specific auth method.
*
* Use this when one provider exposes multiple setup entries (for example API
* key + OAuth, or region-specific login flows). OpenClaw uses this to expose
* method-specific auth choices while keeping the provider id stable.
*/
wizard?: ProviderPluginWizardSetup;
/** Proven provider identity for reconnecting an owned personal account; absent means a new slot. */
matchesPersonalAccount?: (credential: AuthProfileCredential, existing: AuthProfileCredential) => boolean;
run: (ctx: ProviderAuthContext) => Promise<ProviderAuthResult>;
runNonInteractive?: (ctx: ProviderAuthMethodNonInteractiveContext) => Promise<OpenClawConfig | null>;
/** Side-effect-free prerequisite validation used before destructive reset handling. */
validateNonInteractive?: (ctx: ProviderAuthMethodNonInteractiveValidationContext) => Promise<boolean>;
/** Provider-owned local model discovery for the shared guided setup ladder. */
appGuidedSetup?: ProviderAppGuidedSetup;
};
type ProviderPluginWizardSetup = {
modelTarget?: "utility";
choiceId?: string;
choiceLabel?: string;
choiceHint?: string;
assistantPriority?: number;
assistantVisibility?: "visible" | "manual-only" | "detected-only";
onboardingFeatured?: boolean;
groupId?: string;
groupLabel?: string;
groupHint?: string;
methodId?: string;
/**
* Interactive onboarding surfaces where this auth choice should appear.
* Defaults to `["text-inference"]` when omitted.
*/
onboardingScopes?: Array<"text-inference" | "image-generation" | "music-generation">;
/**
* Optional model-allowlist prompt policy applied after this auth choice is
* selected in configure/onboarding flows.
*
* Keep this UI-facing and static. Provider logic that needs runtime state
* should stay in `run`/`runNonInteractive`.
*/
modelAllowlist?: {
allowedKeys?: string[];
initialSelections?: string[];
loadCatalog?: boolean;
message?: string;
};
/**
* Optional default-model prompt policy for this auth/setup choice.
*
* Use this when selecting the auth choice should still force a model picker
* even if the choice was preseeded via CLI/configure, or when "keep current"
* would skip required provider-owned post-selection work.
*/
modelSelection?: {
promptWhenAuthChoiceProvided?: boolean;
allowKeepCurrent?: boolean;
};
};
/** Optional model-picker metadata shown in interactive provider selection flows. */
type ProviderPluginWizardModelPicker = {
label?: string;
hint?: string;
methodId?: string;
};
/** UI metadata that lets provider plugins appear in onboarding and configure flows. */
type ProviderPluginWizard = {
setup?: ProviderPluginWizardSetup;
modelPicker?: ProviderPluginWizardModelPicker;
};
type ProviderOAuthProfileIdRepair = {
/**
* Legacy OAuth profile id to migrate away from.
*
* When omitted, OpenClaw falls back to `<provider>:default`.
*/
legacyProfileId?: string;
/**
* Optional custom doctor prompt label.
*
* Defaults to the provider label when omitted.
*/
promptLabel?: string;
};
type ProviderModelSelectedContext = {
config: OpenClawConfig;
model: string;
prompter: WizardPrompter;
agentDir?: string;
workspaceDir?: string;
};
type ProviderDeferSyntheticProfileAuthContext = {
config?: OpenClawConfig;
provider: string;
providerConfig?: ModelProviderConfig;
resolvedApiKey?: string;
};
type ProviderSystemPromptContributionContext = {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
provider: string;
modelId: string;
promptMode: PromptMode;
runtimeChannel?: string;
runtimeCapabilities?: string[];
agentId?: string;
trigger?: "cron" | "heartbeat" | "manual" | "memory" | "overflow" | "user";
};
type ProviderTransformSystemPromptContext = ProviderSystemPromptContributionContext & {
systemPrompt: string;
};
//#endregion
//#region src/plugins/provider-catalog.types.d.ts
type ProviderCatalogOrder = "simple" | "profile" | "paired" | "late";
type ProviderCatalogContext = {
/** Acquisition lifetime; release awaited work and join its cleanup when aborted. */
signal?: AbortSignal;
config: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
env: NodeJS.ProcessEnv;
/** Normalized provider identities selected for this catalog owner; absent means the full catalog. */
providerIds?: readonly string[];
resolveProviderApiKey: (providerId?: string) => {
apiKey: string | undefined;
discoveryApiKey?: string;
profileId?: string;
/** Credential kind from this lookup when known; never infer it from another selection. */
mode?: "api_key" | "oauth" | "token";
};
resolveProviderAuth: (providerId?: string, options?: {
oauthMarker?: string;
}) => {
apiKey: string | undefined;
discoveryApiKey?: string;
mode: "api_key" | "aws-sdk" | "oauth" | "token" | "none";
source: "env" | "profile" | "none";
profileId?: string;
/** Credential preparation exhausted its candidates; not an unconfigured provider. */
preparationFailed?: boolean;
authFlow?: string;
};
};
type ProviderCatalogResult = {
provider: ModelProviderConfig;
outcomes?: readonly ProviderCatalogOutcome[];
} | {
providers: Record<string, ModelProviderConfig>;
outcomes?: readonly ProviderCatalogOutcome[];
} | null | undefined;
type ProviderPluginCatalog = {
order?: ProviderCatalogOrder;
run: (ctx: ProviderCatalogContext) => Promise<ProviderCatalogResult>;
};
type UnifiedModelCatalogProviderContext = ProviderCatalogContext & {
includeLive?: boolean;
timeoutMs?: number;
};
type UnifiedModelCatalogProviderPlugin$1 = {
provider: string;
kinds: readonly UnifiedModelCatalogKind[];
staticCatalog?: (ctx: UnifiedModelCatalogProviderContext) => readonly UnifiedModelCatalogEntry[] | Promise<readonly UnifiedModelCatalogEntry[] | null | undefined> | null | undefined;
liveCatalog?: (ctx: UnifiedModelCatalogProviderContext) => readonly UnifiedModelCatalogEntry[] | Promise<readonly UnifiedModelCatalogEntry[] | null | undefined> | null | undefined;
};
/**
* Built-in model suppression hook context.
*
* @deprecated Use manifest `modelCatalog.suppressions`. Runtime suppression
* hooks are no longer called by model resolution.
*/
type ProviderBuiltInModelSuppressionContext$1 = {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
env: NodeJS.ProcessEnv;
provider: string;
modelId: string;
baseUrl?: string;
};
type ProviderBuiltInModelSuppressionResult = {
suppress: boolean;
errorMessage?: string;
};
/**
* Provider-owned "modern model" policy input.
*
* Live smoke/model-profile selection uses this to keep provider-specific
* inclusion/exclusion rules out of core.
*/
type ProviderModernModelPolicyContext = {
provider: string;
modelId: string;
};
/**
* Final catalog augmentation hook.
*
* Runs after OpenClaw loads the discovered model catalog and merges configured
* opt-in providers. Use this for forward-compat rows or vendor-owned synthetic
* entries that should appear in `models list` and model pickers even when the
* upstream registry has not caught up yet.
*/
type ProviderAugmentModelCatalogContext = {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
env: NodeJS.ProcessEnv;
resolveProviderApiKey?: ProviderCatalogContext["resolveProviderApiKey"];
entries: ModelCatalogEntry[];
};
//#endregion
//#region src/plugins/provider-replay.types.d.ts
type ProviderReplaySanitizeMode = "full" | "images-only";
type ProviderReplayToolCallIdMode = "strict" | "strict9";
type ProviderReasoningOutputMode = "native" | "tagged";
/**
* Provider-owned replay/compaction transcript policy.
*
* These values are consumed by shared history replay and compaction logic.
* Return only the fields the provider wants to override; core fills the rest
* with its default policy.
*/
type ProviderReplayPolicy = {
sanitizeMode?: ProviderReplaySanitizeMode;
sanitizeToolCallIds?: boolean;
toolCallIdMode?: ProviderReplayToolCallIdMode;
duplicateToolCallIdStyle?: "openai";
preserveNativeAnthropicToolUseIds?: boolean;
preserveSignatures?: boolean;
/** Keep per-turn runtime context in place to preserve signed thinking prefixes. */
appendOnlyRuntimeContext?: boolean;
sanitizeThoughtSignatures?: {
allowBase64Only?: boolean;
includeCamelCase?: boolean;
};
dropThinkingBlocks?: boolean;
dropReasoningFromHistory?: boolean;
repairToolUseResultPairing?: boolean;
applyAssistantFirstOrderingFix?: boolean;
validateGeminiTurns?: boolean;
validateAnthropicTurns?: boolean;
allowSyntheticToolResults?: boolean;
};
/**
* Provider-owned replay/compaction policy input.
*
* Use this when transcript replay rules depend on provider/model transport
* behavior and should stay with the provider plugin instead of core tables.
*/
type ProviderReplayPolicyContext = {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
provider: string;
modelId?: string;
modelApi?: string | null;
model?: ProviderRuntimeModel;
};
type ProviderReplaySessionEntry = {
customType: string;
data?: unknown;
};
type ProviderReplaySessionState = {
getCustomEntries(): ProviderReplaySessionEntry[];
appendCustomEntry(customType: string, data: unknown): void;
};
/**
* Provider-owned replay-history sanitization input.
*
* Runs after core applies generic transcript cleanup so plugins can make
* provider-specific replay rewrites without owning the whole compaction flow.
*/
type ProviderSanitizeReplayHistoryContext = ProviderReplayPolicyContext & {
sessionId: string;
messages: AgentMessage[];
allowedToolNames?: Iterable<string>;
sessionState?: ProviderReplaySessionState;
};
/**
* Provider-owned final replay-turn validation input.
*
* Use this for providers that require strict turn ordering or additional
* replay-time transcript validation beyond generic sanitation.
*/
type ProviderValidateReplayTurnsContext = ProviderReplayPolicyContext & {
sessionId?: string;
messages: AgentMessage[];
sessionState?: ProviderReplaySessionState;
};
/**
* Provider-owned tool-schema normalization input.
*
* Runs before tool registration for replay/compaction/inference so providers
* can rewrite schema keywords that their transport family does not support.
*/
type ProviderNormalizeToolSchemasContext = ProviderReplayPolicyContext & {
tools: AnyAgentTool[];
};
type ProviderToolSchemaDiagnostic = {
toolName: string;
toolIndex?: number;
violations: string[];
};
/**
* Provider-owned reasoning output mode input.
*
* Use this when a provider requires a specific reasoning-output contract, such
* as text tags instead of native structured reasoning fields.
*/
type ProviderReasoningOutputModeContext = ProviderReplayPolicyContext;
//#endregion
//#region src/llm/model-registry.d.ts
/** Registry abstraction used by model pickers and provider availability checks. */
type ModelRegistry = {
getAll(): Model[];
getAvailable(): Model[];
find(provider: string, modelId: string): Model | undefined;
hasConfiguredAuth(model: Model): boolean;
};
//#endregion
//#region src/plugins/provider-runtime.types.d.ts
type ModelProviderRequestTransportOverrides = ModelProviderRequestTransportOverrides$1;
type ProviderRuntimeProviderConfig = {
baseUrl?: string;
api?: ModelProviderConfig["api"];
auth?: ModelProviderConfig["auth"];
models?: ModelProviderConfig["models"];
headers?: unknown;
};
/**
* Sync hook for provider-owned model ids that are not present in the local
* registry/catalog yet.
*
* Use this for pass-through providers or provider-specific forward-compat
* behavior. The hook should be cheap and side-effect free; async refreshes
* belong in `prepareDynamicModel`.
*/
type ProviderResolveDynamicModelContext = {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
agentRuntimeId?: string;
provider: string;
modelId: string;
modelRegistry: ModelRegistry;
providerConfig?: ProviderRuntimeProviderConfig;
authProfileId?: string;
authProfileMode?: AuthProfileCredential["type"] | "aws-sdk";
};
/**
* Optional async preparation for dynamic model resolution.
*
* Called only from async model resolution paths. Providers can return the
* requested model directly or refresh reusable metadata before the sync retry.
*/
type ProviderPrepareDynamicModelContext = ProviderResolveDynamicModelContext;
type ProviderPreferRuntimeResolvedModelContext = {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
provider: string;
modelId: string;
};
/**
* Last-chance rewrite hook for provider-owned transport normalization.
*
* Runs after OpenClaw resolves an explicit/discovered/dynamic model and before
* the embedded runner uses it. Typical uses: swap API ids, fix base URLs, or
* patch provider-specific compat bits.
*/
type ProviderNormalizeResolvedModelContext = {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
provider: string;
modelId: string;
model: ProviderRuntimeModel;
};
/**
* Provider-owned model-id normalization before config/runtime lookup.
*
* Use this for provider-specific alias cleanup that should stay with the
* plugin rather than in core string tables.
*/
type ProviderNormalizeModelIdContext = {
provider: string;
modelId: string;
};
/**
* Provider-owned transport normalization for arbitrary provider/model config.
*
* Use this when transport cleanup depends on API/baseUrl rather than the
* owning provider id, for example custom providers that still target a
* plugin-owned transport family.
*/
type ProviderNormalizeTransportContext = {
config?: OpenClawConfig;
workspaceDir?: string;
provider: string;
modelId?: string;
api?: string | null;
baseUrl?: string;
};
/**
* Runtime auth input for providers that need an extra exchange step before
* inference. The incoming `apiKey` is the raw credential resolved from auth
* profiles/env/config. The returned value should be the actual token/key to use
* for the request.
*/
type ProviderPrepareRuntimeAuthContext = {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
env: NodeJS.ProcessEnv;
provider: string;
modelId: string;
model: ProviderRuntimeModel;
apiKey: string;
authMode: string;
profileId?: string;
};
/**
* Result of `prepareRuntimeAuth`.
*
* `apiKey` is required and becomes the runtime credential stored in auth
* storage. `baseUrl` is optional and lets providers like GitHub Copilot swap to
* an entitlement-specific endpoint at request time. `expiresAt` enables generic
* background refresh in long-running turns.
*/
type ProviderPreparedRuntimeAuth = {
apiKey: string;
baseUrl?: string;
request?: ModelProviderRequestTransportOverrides;
expiresAt?: number;
};
/**
* Usage/billing auth input for providers that expose quota/usage endpoints.
*
* This hook is intentionally separate from `prepareRuntimeAuth`: usage
* snapshots often need a different credential source than live inference
* requests, and they run outside the embedded runner.
*
* The helper methods cover the common OpenClaw auth resolution paths:
*
* - `resolveApiKeyFromConfigAndStore`: env/config/plain token/api_key profiles
* - `resolveOAuthToken`: oauth/token profiles resolved through the auth store,
* optionally for an explicit provider override
*
* Plugins can still do extra provider-specific work on top (for example parse a
* token blob, read a legacy credential file, or pick between aliases).
*/
type ProviderResolveUsageAuthContext = {
/** Cancel provider-owned work when the usage collection deadline expires. */
signal?: AbortSignal;
config: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
env: NodeJS.ProcessEnv;
provider: string;
resolveApiKeyFromConfigAndStore: (params?: {
providerIds?: string[];
envDirect?: Array<string | undefined>;
}) => string | undefined;
/** Ordered API-key/token candidates, including resolved SecretRefs, for credential classification. */
resolveApiKeyCandidatesFromConfigAndStore?: (params?: {
providerIds?: string[];
envDirect?: Array<string | undefined>;
}) => Promise<string[]>;
resolveOAuthToken: (params?: {
provider?: string;
excludeProfileIds?: string[];
}) => Promise<ProviderUsageAuthToken | null>;
};
type ProviderUsageAuthToken = {
token: string;
/** Provider-owned grant family used to authorize the usage endpoint. */
authFlow?: string;
accountId?: string;
/** Non-secret plan metadata from the resolved credential (e.g. Claude "max"). */
subscriptionType?: string;
rateLimitTier?: string;
/** Account email captured on the resolved credential, when known. */
email?: string;
};
/**
* Result of `resolveUsageAuth`.
*
* Two shapes are supported:
* - `{ token: string; accountId?: string }` — use this token for provider usage endpoints.
* - `{ handled: true }` — this provider handled the request but has no usable
* usage token; core must skip further fallback (generic API-key/OAuth fallback
* must not run).
*
* Returning `null` or `undefined` means "not handled by this provider"; core
* proceeds to generic fallback resolution.
*/
type ProviderResolvedUsageAuth = ProviderUsageAuthToken | {
handled: true;
};
/**
* Usage/quota snapshot input for providers that own their usage endpoint
* fetch/parsing behavior.
*
* This hook runs after `resolveUsageAuth` succeeds. Core still owns summary
* fan-out, timeout wrapping, filtering, and formatting; the provider plugin
* owns the provider-specific HTTP request + response normalization.
*/
type ProviderFetchUsageSnapshotContext = {
/** Custom transports must preserve this signal; fetchFn already includes it. */
signal?: AbortSignal;
config: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
env: NodeJS.ProcessEnv;
provider: string;
token: string;
authFlow?: string;
accountId?: string;
authProfileId?: string;
/** Non-secret plan metadata from the resolved credential (e.g. Claude "max"). */
subscriptionType?: string;
rateLimitTier?: string;
/** Account email captured on the resolved credential, when known. */
email?: string;
timeoutMs: number;
fetchFn: typeof fetch;
};
/**
* Provider-owned auth-doctor hint input.
*
* Called when OAuth refresh fails and OpenClaw wants a provider-specific repair
* hint to append to the generic re-auth message. Use this for legacy profile-id
* migrations or other provider-owned auth-store cleanup guidance.
*/
type ProviderAuthDoctorHintContext = {
config?: OpenClawConfig;
store: AuthProfileStore;
provider: string;
profileId?: string;
};
/**
* Provider-owned extra-param normalization before OpenClaw builds its generic
* stream option wrapper.
*
* Use this to set provider defaults or rewrite provider-specific config keys
* into the merged `extraParams` object. Return the full next extraParams object.
*/
/** Provider-facing effort after OpenClaw lowers orchestration-only modes. */
type ProviderTransportThinkingLevel = Exclude<ThinkLevel, "ultra">;
type ProviderPrepareExtraParamsContext = {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
agentId?: string;
/** Selected credential facts; excludes credential material. */
auth?: {
mode: string;
authFlow?: string;
};
nativeWebSearchAllowedByToolPolicy?: boolean;
provider: string;
modelId: string;
model?: ProviderRuntimeModel;
extraParams?: Record<string, unknown>;
thinkingLevel?: ProviderTransportThinkingLevel;
};
type ProviderExtraParamsForTransportContext = Omit<ProviderPrepareExtraParamsContext, "extraParams"> & {
model?: ProviderRuntimeModel;
transport?: "sse" | "websocket" | "websocket-cached" | "auto";
extraParams: Record<string, unknown>;
};
type ProviderExtraParamsForTransportResult = {
patch?: Record<string, unknown> | null;
};
type ProviderResolvePromptOverlayContext = ProviderSystemPromptContributionContext & {
baseOverlay?: ProviderSystemPromptContribution;
};
type ProviderFollowupFallbackRouteContext = {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
provider: string;
modelId: string;
payload: ReplyPayload;
originatingChannel?: string;
originatingTo?: string;
originRoutable: boolean;
dispatcherAvailable: boolean;
};
type ProviderFollowupFallbackRouteResult = {
route?: "origin" | "dispatcher" | "drop";
reason?: string;
};
type ProviderResolveAuthProfileIdContext = {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
provider: string;
modelId: string;
preferredProfileId?: string;
lockedProfileId?: string;
profileOrder: string[];
authStore: AuthProfileStore;
};
//#endregion
//#region src/agents/provider-local-service-reconcile.d.ts
type ProviderLocalServiceReconcileContext = {
baseUrl: string;
signal?: AbortSignal;
};
//#endregion
//#region src/plugins/provider-transport.types.d.ts
/**
* Provider-owned transport creation.
*
* Use this when the provider needs to replace shared model runtime's default transport with a
* custom StreamFn (for example a native API transport that cannot be expressed
* as a wrapper around `streamSimple`).
*/
type ProviderCreateStreamFnContext = {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
provider: string;
modelId: string;
model: ProviderRuntimeModel;
};
/**
* Provider-owned stream wrapper hook after OpenClaw applies its generic
* transport-independent wrappers.
*
* Use this for provider-specific payload/header/model mutations that still run
* through the normal `shared model runtime` stream path.
*/
type ProviderWrapStreamFnContext = ProviderPrepareExtraParamsContext & {
model?: ProviderRuntimeModel;
/** Wire-format API before simple completion projects an internal transport alias. */
sourceApi?: ProviderRuntimeModel["api"];
streamFn?: StreamFn$1;
};
/** Healthy local service boundary before the provider request is sent. */
type ProviderReconcileLocalServiceContext = ProviderLocalServiceReconcileContext;
/**
* Provider-owned WebSocket session policy.
*/
type ProviderWebSocketSessionPolicy = {
headers?: Record<string, string>;
degradeCooldownMs?: number;
};
/**
* Provider-owned transport turn state.
*
* Use this for provider-native request headers or metadata that should stay
* stable across retries while still being attached by generic core transports.
*/
type ProviderTransportTurnState = {
headers?: Record<string, string>;
metadata?: Record<string, string>;
websocket?: ProviderWebSocketSessionPolicy;
};
/**
* Provider-owned request identity for transport turns.
*
* Use this when the provider exposes native request/session metadata that must
* be attached by both HTTP and WebSocket transports.
*/
type ProviderResolveTransportTurnStateContext = {
provider: string;
modelId: string;
model?: ProviderRuntimeModel;
sessionId?: string;
turnId: string;
attempt: number;
transport: "stream" | "websocket";
};
/**
* Provider-owned WebSocket session policy input.
*/
type ProviderResolveWebSocketSessionPolicyContext = {
provider: string;
modelId: string;
model?: ProviderRuntimeModel;
sessionId?: string;
};
/**
* Provider-owned failover error classification input.
*
* Use this when provider-specific transport or API errors need classification
* hints that generic string matching cannot express safely.
*/
type ProviderFailoverErrorContext = {
provider?: string;
modelId?: string;
errorMessage: string;
status?: number;
code?: string;
errorType?: string;
};
/**
* Generic embedding provider shape returned by provider plugins.
*
* Keep this aligned with the memory embedding contract without forcing the
* plugin system to import memory internals directly.
*/
type PluginEmbeddingProvider = {
id: string;
model: string;
maxInputTokens?: number;
embedQuery: (text: string, options?: {
signal?: AbortSignal;
}) => Promise<number[]>;
embedBatch: (texts: string[], options?: {
signal?: AbortSignal;
}) => Promise<number[][]>;
embedBatchInputs?: (inputs: unknown[], options?: {
signal?: AbortSignal;
}) => Promise<number[][]>;
client?: unknown;
};
/**
* Provider-owned embedding transport creation.
*
* Use this when a provider wants memory embeddings to live with the provider
* plugin instead of the core memory switchboard.
*/
type ProviderCreateEmbeddingProviderContext = {
config: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
provider: string;
model: string;
remote?: {
baseUrl?: string;
apiKey?: unknown;
headers?: Record<string, string>;
};
providerApiKey?: string;
inputType?: string;
queryInputType?: string;
documentInputType?: string;
outputDimensionality?: number;
taskType?: string;
};
/**
* Provider-owned prompt-cache eligibility.
*
* Return `true` or `false` to override OpenClaw's built-in provider cache TTL
* detection for this provider. Return `undefined` to fall back to core rules.
*/
type ProviderCacheTtlEligibilityContext = {
provider: string;
modelId: string;
modelApi?: string;
baseUrl?: string;
supportsPromptCacheKey?: boolean;
};
/**
* Provider-owned missing-auth message override.
*
* Runs only after OpenClaw exhausts normal env/profile/config auth resolution
* for the requested provider. Return a custom message to replace the generic
* "No API key found" error.
*/
type ProviderBuildMissingAuthMessageContext = {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
env: NodeJS.ProcessEnv;
provider: string;
listProfileIds: (providerId: string) => string[];
};
/**
* Provider-owned unknown-model hint override.
*
* Runs after catalog/runtime lookup misses for the requested provider. Return a
* hint suffix that OpenClaw should append to the generic `Unknown model`
* error.
*/
type ProviderBuildUnknownModelHintContext = {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
env: NodeJS.ProcessEnv;
provider: string;
modelId: string;
baseUrl?: string;
};
//#endregion
//#region src/plugins/provider-plugin.types.d.ts
type ProviderPlugin = {
id: string;
pluginId?: string;
/** Loader-owned dependency root, shared by lightweight and full registration. */
pluginRoot?: string;
label: string;
docsPath?: string;
aliases?: string[];
/**
* Internal-only aliases used for runtime/config hook lookup.
*
* Unlike `aliases`, these values are not treated as user-facing provider ids
* for auth/setup surfaces. Use them for legacy config keys or compat-only
* hook routing.
*/
hookAliases?: string[];
/**
* Provider-related env vars shown in setup/search/help surfaces.
*
* Keep entries in preferred display order. This can include direct auth env
* vars or setup inputs such as OAuth client id/secret vars.
*/
envVars?: string[];
auth: ProviderAuthMethod[];
/**
* Legacy text-provider catalog hook.
*
* @deprecated New catalog/control-plane surfaces should use
* `api.registerModelCatalogProvider`. This hook remains the text runtime
* source until the unified loader fully replaces it.
* Returns provider config/model definitions that merge into models.providers.
*/
catalog?: ProviderPluginCatalog;
/**
* Legacy offline text-provider catalog hook for display-only surfaces.
*
* @deprecated New static rows should be registered with
* `api.registerModelCatalogProvider`.
*
* Unlike `catalog`, this hook must not perform network I/O or require real
* credentials. Use it for bundled/static rows that can be shown before auth is
* configured.
*/
staticCatalog?: ProviderPluginCatalog;
/**
* Show catalog row labels as the literal `<provider>/<entry.id>`
* composition instead of the canonical (deduped) key.
*
* `modelKey` strips a duplicate `<provider>/` prefix so storage and
* lookups stay stable. This flag only changes the picker label — the
* option value and persisted config remain canonical.
*
* Set when the leading `<provider>/` segment in the native model id is
* a meaningful vendor namespace (e.g. NVIDIA's `nvidia/nemotron-...`
* alongside `moonshotai/kimi-k2.5`).
*/
preserveLiteralProviderPrefix?: boolean;
/**
* Sync runtime fallback for model ids not present in the local catalog.
*
* Hook order:
* 1. discovered/static model lookup
* 2. plugin `resolveDynamicModel`
* 3. core fallback heuristics
* 4. generic provider-config fallback
*
* Keep this hook cheap and deterministic. Async model discovery belongs in
* `prepareDynamicModel`, which can return the prepared model directly.
*/
resolveDynamicModel?: (ctx: ProviderResolveDynamicModelContext) => ProviderRuntimeModel | null | undefined;
/**
* Optional async preparation for dynamic model resolution.
*
* OpenClaw calls this only from async model resolution paths. Return the
* requested model directly, or return nothing to retry `resolveDynamicModel`.
*/
prepareDynamicModel?: (ctx: ProviderPrepareDynamicModelContext) => Promise<ProviderRuntimeModel | void>;
/**
* Lets a provider plugin opt exact configured models into a runtime
* metadata comparison pass before the embedded runner returns the explicit
* entry unchanged.
*/
preferRuntimeResolvedModel?: (ctx: ProviderPreferRuntimeResolvedModelContext) => boolean;
/**
* Provider-owned transport normalization.
*
* Use this to rewrite a resolved model without forking the generic runner:
* swap API ids, update base URLs, or adjust compat flags for a provider's
* transport quirks.
*/
normalizeResolvedModel?: (ctx: ProviderNormalizeResolvedModelContext) => ProviderRuntimeModel | null | undefined;
/**
* Provider-owned model-id normalization.
*
* Runs before model lookup/canonicalization. Use this for alias cleanup such
* as provider-owned preview/legacy model ids.
*/
normalizeModelId?: (ctx: ProviderNormalizeModelIdContext) => string | null | undefined;
/**
* Provider-owned transport-family normalization before generic model
* assembly.
*
* Use this for API/baseUrl cleanup that may apply to custom provider ids
* which still target the provider's transport family.
*/
normalizeTransport?: (ctx: ProviderNormalizeTransportContext) => {
api?: string | null;
baseUrl?: string;
} | null | undefined;
/**
* Provider-owned config normalization for `models.providers.<id>`.
*
* Use this for provider-specific baseUrl/model-id cleanup that should stay
* with the plugin rather than in core config-policy tables.
*/
normalizeConfig?: (ctx: ProviderNormalizeConfigContext) => ModelProviderConfig | null | undefined;
/**
* Provider-owned final native-streaming compat pass for config providers.
*
* Use this when a provider opts specific native base URLs into
* `supportsUsageInStreaming` or similar transport compatibility flags.
*/
applyNativeStreamingUsageCompat?: (ctx: ProviderNormalizeConfigContext) => ModelProviderConfig | null | undefined;
/**
* Provider-owned config apiKey/env marker resolution.
*
* Use this when a provider resolves auth from env vars such as AWS/GCP
* markers rather than a normal API-key env var.
*/
resolveConfigApiKey?: (ctx: ProviderResolveConfigApiKeyContext) => string | null | undefined;
/**
* Provider-owned replay/compaction policy override.
*
* Use this when transcript replay or compaction should follow provider-owned
* rules that are more expressive than the static `capabilities` bag.
*/
buildReplayPolicy?: (ctx: ProviderReplayPolicyContext) => ProviderReplayPolicy | null | undefined;
/**
* Provider-owned replay-history sanitization.
*
* Runs after OpenClaw performs generic transcript cleanup. Use this for
* provider-specific replay rewrites that should stay with the provider
* plugin rather than in shared core compaction helpers.
*/
sanitizeReplayHistory?: (ctx: ProviderSanitizeReplayHistoryContext) => Promise<AgentMessage[] | null | undefined> | AgentMessage[] | null | undefined;
/**
* Provider-owned final replay-turn validation.
*
* Use this when provider transports need stricter replay-time validation or
* turn reshaping after generic sanitation. Returning a non-null value
* replaces the built-in replay validators rather than composing with them.
*/
validateReplayTurns?: (ctx: ProviderValidateReplayTurnsContext) => Promise<AgentMessage[] | null | undefined> | AgentMessage[] | null | undefined;
/**
* Provider-owned tool-schema normalization.
*
* Use this for transport-family schema cleanup before OpenClaw registers
* tools with the embedded runner.
*/
normalizeToolSchemas?: (ctx: ProviderNormalizeToolSchemasContext) => AnyAgentTool[] | null | undefined;
/**
* Provider-owned tool-schema diagnostics after normalization.
*
* Use this when a provider wants to surface transport-specific schema
* warnings without teaching core about provider-specific keyword rules.
*/
inspectToolSchemas?: (ctx: ProviderNormalizeToolSchemasContext) => ProviderToolSchemaDiagnostic[] | null | undefined;
/**
* Provider-owned reasoning output mode.
*
* Use this when a provider requires tagged reasoning/final output instead of
* native structured reasoning fields.
*/
resolveReasoningOutputMode?: (ctx: ProviderReasoningOutputModeContext) => ProviderReasoningOutputMode | null | undefined;
/**
* Provider-owned extra-param normalization before generic stream option
* wrapping.
*
* Typical uses: set provider-default `transport`, map provider-specific
* config aliases, or inject extra request metadata sourced from
* `agents.defaults.models.<provider>/<model>.params`.
*/
prepareExtraParams?: (ctx: ProviderPrepareExtraParamsContext) => Record<string, unknown> | null | undefined;
/**
* Provider-owned request params after transport/model resolution.
*
* Use this for transport-family request knobs that should be keyed by the
* resolved model API/transport rather than a hardcoded core allowlist.
*/
extraParamsForTransport?: (ctx: ProviderExtraParamsForTransportContext) => ProviderExtraParamsForTransportResult | null | undefined;
/**
* Provider-owned transport factory.
*
* Use this when the provider needs a fully custom StreamFn instead of a
* wrapper around the normal `streamSimple` path.
*/
createStreamFn?: (ctx: ProviderCreateStreamFnContext) => StreamFn$1 | null | undefined;
/**
* Opt custom streams into the internal stable/dynamic system-prompt boundary.
* The transport must consume the boundary before sending its provider payload.
* Otherwise the host strips it before invoking the custom stream.
*/
supportsSystemPromptCacheBoundary?: boolean;
/**
* Provider-owned stream wrapper applied after generic OpenClaw wrappers.
*
* Typical uses: provider attribution headers, request-body rewrites, or
* provider-specific compat payload patches that do not justify a separate
* transport implementation.
*/
wrapStreamFn?: (ctx: ProviderWrapStreamFnContext) => StreamFn$1 | null | undefined;
/**
* Provider-owned wrapper for direct `completeSimple` callers.
*
* Opt in only when the provider must enforce the same wire contract outside
* the embedded agent runtime.
* The factory runs once per prepared model; its returned stream retains
* wrapper-local state and reads per-request options on each invocation.
*/
wrapSimpleCompletionStreamFn?: (ctx: ProviderWrapStreamFnContext) => StreamFn$1 | null | undefined;
/** Cheap, idempotent provider repair after local-service health and before each request. */
reconcileLocalService?: (ctx: ProviderReconcileLocalServiceContext) => Promise<void>;
/**
* Provider-owned native transport turn identity.
*
* Use this when a provider wants generic transports to attach provider-native
* request headers or metadata on each turn without hardcoding vendor logic in
* core.
*/
resolveTransportTurnState?: (ctx: ProviderResolveTransportTurnStateContext) => ProviderTransportTurnState | null | undefined;
/**
* Provider-owned WebSocket session policy.
*
* @deprecated Return `websocket` from `resolveTransportTurnState`. When both
* hooks provide a field, the new hook takes precedence.
*/
resolveWebSocketSessionPolicy?: (ctx: ProviderResolveWebSocketSessionPolicyContext) => ProviderWebSocketSessionPolicy | null | undefined;
/**
* Provider-owned embedding provider factory.
*
* Use this when memory embedding behavior belongs with the provider plugin
* rather than the core embedding switchboard.
*/
createEmbeddingProvider?: (ctx: ProviderCreateEmbeddingProviderContext) => Promise<PluginEmbeddingProvider | null | undefined> | PluginEmbeddingProvider | null | undefined;
/**
* Runtime auth exchange hook.
*
* Called after OpenClaw resolves the raw configured credential but before the
* runner stores it in runtime auth storage. This lets plugins exchange a
* source credential (for example a GitHub token) into a short-lived runtime
* token plus optional base URL override.
*/
prepareRuntimeAuth?: (ctx: ProviderPrepareRuntimeAuthContext) => Promise<ProviderPreparedRuntimeAuth | null | undefined>;
/**
* Usage/billing auth resolution hook.
*
* Called by provider-usage surfaces (`/usage`, status snapshots, reporting).
* Use this when a provider's usage endpoint needs provider-owned token
* extraction, blob parsing, or alias handling.
*/
resolveUsageAuth?: (ctx: ProviderResolveUsageAuthContext) => Promise<ProviderResolvedUsageAuth | null | undefined> | ProviderResolvedUsageAuth | null | undefined;
/**
* Usage/quota snapshot fetch hook.
*
* Called after `resolveUsageAuth` by `/usage` and related reporting surfaces.
* Use this when the provider's usage endpoint or payload shape is
* provider-specific and you want that logic to live with the provider plugin
* instead of the core switchboard.
*/
fetchUsageSnapshot?: (ctx: ProviderFetchUsageSnapshotContext) => Promise<ProviderUsageSnapshot | null | undefined> | ProviderUsageSnapshot | null | undefined;
/**
* Provider-owned failover context-overflow matcher.
*
* Return true when the provider recognizes the raw error as a context-window
* overflow shape that generic heuristics would miss.
*/
matchesContextOverflowError?: (ctx: ProviderFailoverErrorContext) => boolean | undefined;
/**
* Provider-owned failover error classification.
*
* Return a failover reason when the provider recognizes a provider-specific
* raw error shape. Return undefined to fall back to generic classification.
*/
classifyFailoverReason?: (ctx: ProviderFailoverErrorContext) => FailoverReason | null | undefined;
/**
* Provider-owned cache TTL eligibility.
*
* Use this when a proxy provider supports Anthropic-style prompt caching for
* only a subset of upstream models.
*/
isCacheTtlEligible?: (ctx: ProviderCacheTtlEligibilityContext) => boolean | undefined;
/**
* Provider-owned missing-auth message override.
*
* Return a custom message when the provider wants a more specific recovery
* hint than OpenClaw's generic auth-store guidance.
*/
buildMissingAuthMessage?: (ctx: ProviderBuildMissingAuthMessageContext) => string | null | undefined;
/**
* Provider-owned unknown-model hint override.
*
* Return a suffix when the provider wants a more specific recovery hint than
* OpenClaw's generic `Unknown model` error after catalog/runtime lookup
* fails.
*/
buildUnknownModelHint?: (ctx: ProviderBuildUnknownModelHintContext) => string | null | undefined;
/**
* Provider-owned built-in model suppression.
*
* Return `{ suppress: true }` to hide a stale upstream row. Include
* `errorMessage` when OpenClaw should surface a provider-specific hint for
* direct model resolution failures.
*
* @deprecated Use manifest `modelCatalog.suppressions`. Runtime suppression
* hooks are no longer called by model resolution.
*/
suppressBuiltInModel?: (ctx: ProviderBuiltInModelSuppressionContext$1) => ProviderBuiltInModelSuppressionResult | null | undefined;
/**
* Provider-owned final catalog augmentation.
*
* @deprecated Use `api.registerModelCatalogProvider` for supplemental catalog
* rows. This hook is kept only for existing text-provider runtime
* compatibility during the migration window.
*
* Return extra rows to append to the final catalog after discovery/config
* merging. OpenClaw deduplicates by `provider/id`, so plugins only need to
* describe the desired supplemental rows.
*/
augmentModelCatalog?: (ctx: ProviderAugmentModelCatalogContext) => Array<ModelCatalogEntry> | ReadonlyArray<ModelCatalogEntry> | Promise<Array<ModelCatalogEntry> | ReadonlyArray<ModelCatalogEntry> | null | undefined> | null | undefined;
/**
* Provider-owned thinking level profile.
*
* Prefer this over the individual thinking capability hooks when a provider
* or model exposes a custom set of thinking levels. OpenClaw stores the
* canonical `id`, shows `label` when provided, and downgrades stale stored
* values by profile rank.
*/
resolveThinkingProfile?: (ctx: ProviderDefaultThinkingPolicyContext) => ProviderThinkingProfile | null | undefined;
/** Whether Fast can affect this selected request; undefined retains existing unknown behavior. */
resolveFastModeSupport?: (ctx: ProviderFastModePolicyContext) => boolean | undefined;
/**
* Provider-owned system-prompt contribution.
*
* Use this when a provider/model family needs cache-aware prompt tuning
* without replacing the full OpenClaw-owned system prompt.
*/
resolveSystemPromptContribution?: (ctx: ProviderSystemPromptContributionContext) => ProviderSystemPromptContribution | null | undefined;
/**
* Provider-owned GPT/model prompt overlay seam.
*
* Runs after OpenClaw's built-in overlay is resolved and before the
* provider's regular system-prompt contribution is merged.
*/
resolvePromptOverlay?: (ctx: ProviderResolvePromptOverlayContext) => ProviderSystemPromptContribution | null | undefined;
/**
* Provider-owned fallback route override for model/profile failure handling.
*
* Return undefined/null to keep OpenClaw's default fallback policy.
*/
followupFallbackRoute?: (ctx: ProviderFollowupFallbackRouteContext) => ProviderFollowupFallbackRouteResult | null | undefined;
/**
* Provider-owned auth profile resolver.
*
* Return a profile id from the supplied order to prefer it for this attempt;
* invalid or missing ids are ignored by core.
*/
resolveAuthProfileId?: (ctx: ProviderResolveAuthProfileIdContext) => string | null | undefined;
/**
* Provider-owned final system-prompt transform.
*
* Use this sparingly when a provider transport needs small compatibility
* rewrites after OpenClaw has assembled the complete prompt. Return
* `undefined`/`null` to leave the prompt unchanged.
*/
transformSystemPrompt?: (ctx: ProviderTransformSystemPromptContext) => string | null | undefined;
/**
* Provider-owned bidirectional text replacements.
*
* `input` applies to system prompts and text message content before transport.
* `output` applies to assistant text deltas/final text before OpenClaw handles
* its own control markers or channel delivery.
*/
textTransforms?: PluginTextTransforms;
/**
* Provider-owned global config defaults.
*
* Use this when config materialization needs provider-specific defaults that
* depend on auth mode, env, or provider model-family semantics.
*/
applyConfigDefaults?: (ctx: ProviderApplyConfigDefaultsContext) => OpenClawConfig | null | undefined;
/**
* Provider-owned "modern model" matcher used by live profile/smoke filters.
*
* Return true when the given provider/model ref should be treated as a
* preferred modern model candidate.
*/
isModernModelRef?: (ctx: ProviderModernModelPolicyContext) => boolean | undefined;
wizard?: ProviderPluginWizard;
/**
* Provider-owned auth-profile API-key formatter.
*
* OpenClaw uses this when a stored auth profile is already valid and needs to
* be converted into the runtime `apiKey` string expected by the provider. Use
* this for providers whose auth profile stores extra metadata alongside the
* bearer token (for example Gemini CLI's `{ token, projectId }` payload).
*/
formatApiKey?: (cred: AuthProfileCredential) => string;
/**
* Provider-owned OAuth login adapter for the session SDK AuthStorage API.
*
* This keeps the public callback-based login contract usable without seeding
* provider implementations into core. Modern setup flows should use `auth`.
*/
loginOAuth?: (callbacks: OAuthLoginCallbacks$1) => Promise<OAuthCredentials>;
/**
* Legacy auth-profile ids that generic auth must ignore and `openclaw doctor` should remove.
*
* Use this when a provider plugin replaces an older core-managed profile id
* and wants cleanup/migration messaging to live with the provider instead of
* in hardcoded doctor tables. A runtime-only external CLI profile remains usable by its exact
* provider when it intentionally reuses a retired id.
*/
deprecatedProfileIds?: string[];
/**
* Legacy OAuth profile-id migrations that `openclaw doctor` should offer.
*
* Use this when a provider moved from a legacy default OAuth profile id to a
* newer identity-based id and wants doctor to own the config rewrite without
* another core-specific migration branch.
*/
oauthProfileIdRepairs?: ProviderOAuthProfileIdRepair[];
/**
* Provider-owned OAuth refresh.
*
* OpenClaw calls this before falling back to the shared `shared model runtime` OAuth
* refreshers. Use it when the provider has a custom refresh endpoint, or when
* the provider needs custom refresh-failure behavior that should stay out of
* core auth-profile code.
*/
refreshOAuth?: (cred: OAuthCredential$1) => Promise<OAuthCredential$1>;
/**
* Provider-owned auth-doctor hint.
*
* Return a multiline repair hint when OAuth refresh fails and the provider
* wants to steer users toward a specific auth-profile migration or recovery
* path. Return nothing to keep OpenClaw's generic error text.
*/
buildAuthDoctorHint?: (ctx: ProviderAuthDoctorHintContext) => string | Promise<string | null | undefined> | null | undefined;
/**
* Provider-owned config-backed auth resolution.
*
* Providers own any provider-specific fallback secret rules here so core
* auth/discovery code can stay generic and avoid parsing provider-private
* config layouts.
*
* The returned `apiKey` may be:
* - a real credential from the active runtime snapshot, suitable for runtime use
* - a non-secret marker (for example a managed SecretRef marker), suitable only
* for discovery/bootstrap callers
*
* Runtime callers must not treat non-secret markers as runnable credentials;
* they should retry against the active runtime snapshot when available.
*
* Use this when the provider can operate without a real secret for certain
* configured local/self-hosted cases and wants auth resolution to treat that
* config as available.
*/
resolveSyntheticAuth?: (ctx: ProviderResolveSyntheticAuthContext) => ProviderSyntheticAuthResult | null | undefined;
/**
* Prepare external availability before synchronous synthetic-auth reads.
* Keep process/network I/O here; OpenClaw publishes the completed result for this generation.
*/
prepareSyntheticAuth?: (ctx: ProviderResolveSyntheticAuthContext & {
env?: NodeJS.ProcessEnv;
signal?: AbortSignal;
pluginRoot?: string;
}) => Promise<ProviderSyntheticAuthResult | null | undefined>;
/**
* Provider-owned external auth profile discovery.
*
* Use this when credentials are managed by an external tool and should be visible
* to runtime auth resolution without being written back into `auth-profiles.json`
* by core.
*/
resolveExternalAuthProfiles?: (ctx: ProviderResolveExternalAuthProfilesContext) => Array<ProviderExternalAuthProfile> | ReadonlyArray<ProviderExternalAuthProfile> | null | undefined;
/**
* Provider-owned precedence rule for stored synthetic auth profiles.
*
* Return true when a stored profile API key is only a provider-owned
* synthetic placeholder and should yield to env/config-backed auth before
* OpenClaw falls back to that stored profile.
*/
shouldDeferSyntheticProfileAuth?: (ctx: ProviderDeferSyntheticProfileAuthContext) => boolean | undefined;
onModelSelected?: (ctx: ProviderModelSelectedContext) => Promise<void>;
};
/** Provider runtime registered with its owning plugin and source. */
type PluginProviderRegistration = {
pluginId: string;
pluginName?: string;
provider: ProviderPlugin;
source: string;
rootDir?: string;
};
//#endregion
//#region src/plugins/provider-hook-runtime.d.ts
declare const { attachModelProviderRuntimePluginHandle, getModelProviderRuntimePluginHandle, resolveLoadedProviderPluginsForHooks, resolveProviderPluginsForHooks, resolveProviderRuntimePlugin, resolveLoadedProviderRuntimePlugin, resolveProviderHookPlugin, resolveProviderRuntimePluginHandle, ensureProviderRuntimePluginHandle, resolveProviderAuthProfileId, resolveProviderFollowupFallbackRoute, wrapProviderSimpleCompletionStreamFn }: Readonly<{
attachModelProviderRuntimePluginHandle: <TModel extends object>(model: TModel, runtimeHandle: ProviderRuntimePluginHandle) => TModel;
getModelProviderRuntimePluginHandle: (model: object | undefined) => ProviderRuntimePluginHandle | undefined;
resolveLoadedProviderPluginsForHooks: (params: {
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
onlyPluginIds?: string[];
providerRefs?: readonly string[];
modelRefs?: readonly string[];
applyAutoEnable?: boolean;
pluginMetadataSnapshot?: PluginMetadataRegistryView;
}) => ProviderPlugin[] | undefined;
resolveProviderPluginsForHooks: (params: Parameters<(params: {
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
onlyPluginIds?: string[];
providerRefs?: readonly string[];
modelRefs?: readonly string[];
applyAutoEnable?: boolean;
pluginMetadataSnapshot?: PluginMetadataRegistryView;
}) => ProviderPlugin[] | undefined>[0]) => ProviderPlugin[];
resolveProviderRuntimePlugin: (params: {
provider: string;
providerOwner?: string;
modelId?: string | null;
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
applyAutoEnable?: boolean;
pluginMetadataSnapshot?: PluginMetadataRegistryView;
}) => ProviderPlugin | undefined;
resolveLoadedProviderRuntimePlugin: (params: {
provider: string;
providerOwner?: string;
modelId?: string | null;
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
applyAutoEnable?: boolean;
pluginMetadataSnapshot?: PluginMetadataRegistryView;
}) => ProviderPlugin | undefined;
resolveProviderHookPlugin: (params: {
provider: string;
modelId?: string | null;
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
}) => ProviderPlugin | undefined;
resolveProviderRuntimePluginHandle: (params: {
provider: string;
providerOwner?: string;
modelId?: string | null;
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
applyAutoEnable?: boolean;
pluginMetadataSnapshot?: PluginMetadataRegistryView;
}) => ProviderRuntimePluginHandle;
ensureProviderRuntimePluginHandle: (params: {
provider: string;
providerOwner?: string;
modelId?: string | null;
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
applyAutoEnable?: boolean;
pluginMetadataSnapshot?: PluginMetadataRegistryView;
} & {
runtimeHandle?: ProviderRuntimePluginHandle;
}) => ProviderRuntimePluginHandle;
resolveProviderAuthProfileId: (params: {
provider: string;
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
runtimeHandle?: ProviderRuntimePluginHandle;
context: ProviderResolveAuthProfileIdContext;
}) => string | undefined;
resolveProviderFollowupFallbackRoute: (params: {
provider: string;
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
runtimeHandle?: ProviderRuntimePluginHandle;
context: ProviderFollowupFallbackRouteContext;
}) => ProviderFollowupFallbackRouteResult | undefined;
wrapProviderSimpleCompletionStreamFn: (params: {
provider: string;
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
runtimeHandle?: ProviderRuntimePluginHandle;
context: ProviderWrapStreamFnContext;
}) => StreamFn | undefined;
}>;
//#endregion
//#region src/agents/model-fallback-attempt.d.ts
type ModelFallbackResultClassification = {
message: string;
reason?: FailoverReason;
status?: number;
code?: string;
rawError?: string;
preserveResultOnExhaustion?: boolean;
preserveResultPriority?: number;
} | {
error: unknown;
} | null | undefined;
//#endregion
//#region src/agents/runtime-plan/types.d.ts
/** Runtime transport selected for one model attempt. */
type AgentRuntimeTransport = "sse" | "websocket" | "websocket-cached" | "auto";
/** Thinking levels accepted by runtime-plan extra-param preparation. */
type AgentRuntimeThinkLevel = "off" | "minimal" | "low" | "medium" | "high" | "xhigh" | "adaptive" | "max";
/** System prompt rendering mode selected for one attempt. */
type AgentRuntimePromptMode = "full" | "minimal" | "none";
/** Trigger source that can alter provider system prompt contributions. */
type AgentRuntimePromptTrigger = "cron" | "heartbeat" | "manual" | "memory" | "overflow" | "user";
/** Provider model descriptor consumed by runtime-plan hooks. */
type AgentRuntimeModel = {
id?: string;
name?: string;
api?: string;
provider?: string;
baseUrl?: string;
reasoning?: boolean;
input?: readonly string[];
cost?: {
input: number;
output: number;
cacheRead: number;
cacheWrite: number;
};
contextWindow?: number;
maxTokens?: number;
contextTokens?: number;
compat?: unknown;
};
/** Text replacement rule used by provider input/output transforms. */
type AgentRuntimeTextReplacement = {
from: string | RegExp;
to: string;
};
/** Provider text transforms applied around model calls. */
type AgentRuntimeTextTransforms = {
input?: AgentRuntimeTextReplacement[];
output?: AgentRuntimeTextReplacement[];
};
/** Resolved provider runtime handle forwarded to plugin-owned hooks. */
type AgentRuntimeProviderHandle = {
provider: string;
modelId?: string | null;
config?: unknown;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
applyAutoEnable?: boolean;
};
type PreparedAgentRuntimeProviderHandle = AgentRuntimeProviderHandle & {
modelId: string | null;
prepared: true;
};
/** Stable section IDs for provider system prompt overrides. */
type AgentRuntimeSystemPromptSectionId = "interaction_style" | "tool_call_style" | "execution_bias";
/** Provider-owned system prompt contribution and section overrides. */
type AgentRuntimeSystemPromptContribution = {
stablePrefix?: string;
dynamicSuffix?: string;
sectionOverrides?: Partial<Record<AgentRuntimeSystemPromptSectionId, string>>;
};
/** Context passed when resolving provider system prompt contributions. */
type AgentRuntimeSystemPromptContributionContext = {
config?: unknown;
agentDir?: string;
workspaceDir?: string;
provider: string;
modelId: string;
promptMode: AgentRuntimePromptMode;
runtimeChannel?: string;
runtimeCapabilities?: string[];
agentId?: string;
trigger?: AgentRuntimePromptTrigger;
};
/** Provider fallback route decision for follow-up delivery. */
type AgentRuntimeFollowupFallbackRouteResult = {
route?: "origin" | "dispatcher" | "drop";
reason?: string;
};
/** Tool-call id sanitizer mode for provider transcript policy. */
type AgentRuntimeToolCallIdMode = "strict" | "strict9";
/** Provider transcript sanitation, repair, and validation policy. */
type AgentRuntimeTranscriptPolicy = {
sanitizeMode: "full" | "images-only";
sanitizeToolCallIds: boolean;
toolCallIdMode?: AgentRuntimeToolCallIdMode;
duplicateToolCallIdStyle?: "openai";
preserveNativeAnthropicToolUseIds: boolean;
repairToolUseResultPairing: boolean;
preserveSignatures: boolean;
sanitizeThoughtSignatures?: {
allowBase64Only?: boolean;
includeCamelCase?: boolean;
};
dropThinkingBlocks: boolean;
dropReasoningFromHistory?: boolean;
applyGoogleTurnOrdering: boolean;
validateGeminiTurns: boolean;
validateAnthropicTurns: boolean;
allowSyntheticToolResults: boolean;
};
/** Runtime hook that classifies run results for model fallback. */
type AgentRuntimeOutcomeClassifier = (params: {
provider: string;
model: string;
result: unknown;
hasDirectlySentBlockReply?: boolean;
hasBlockReplyPipelineOutput?: boolean;
}) => ModelFallbackResultClassification;
/** Resolved provider/model/harness/transport reference for an attempt. */
type AgentRuntimeResolvedRef = {
provider: string;
modelId: string;
modelApi?: string;
harnessId?: string;
transport?: AgentRuntimeTransport;
};
/** Concrete provider-owned route selected for one runtime attempt. */
type AgentRuntimeAuthModelRoute = {
provider: string;
modelId: string;
api: ModelApi;
baseUrl: string;
authRequirement: "api-key" | "subscription";
/** Secret-free request behavior that the selected runtime must reproduce. */
requestTransportOverrides: ProviderRouteOverridePresence;
/** Provider-owned native-runtime compatibility for this concrete route. */
runtimePolicy?: ProviderModelRouteRuntimePolicy;
};
/** Common native-runtime support proven across every route left to the harness. */
type AgentRuntimeAuthDeferredRouteSupport = {
requestTransportOverrides: ProviderRouteOverridePresence;
runtimePolicy: ProviderModelRouteRuntimePolicy;
};
/** Auth forwarding decision for one runtime attempt. */
type AgentRuntimeCredentialSource = ProviderModelAuthSourceClassification | {
kind: "none";
};
/** Actual provider/model/source tuple owned by one physical model attempt. */
type AgentRuntimeModelAttempt = {
provider: string;
model: string;
credentialSource: AgentRuntimeCredentialSource;
};
type AgentRuntimeAuthPlan = {
providerForAuth: string;
/** Model whose order, cooldown, and route facts produced this plan. */
modelId?: string;
authProfileProviderForAuth: string;
harnessAuthProvider?: string;
/** Preferred or user-locked profile; automatic selection may not have resolved its secret yet. */
forwardedAuthProfileId?: string;
forwardedAuthProfileSource?: "auto" | "user";
/** Ordered exhaustive candidates for the selected route; a singleton is terminal. */
forwardedAuthProfileCandidateIds?: string[];
/** Exact selected credential/config mode; secret-free route materialization input. */
selectedAuthMode?: string;
selectedAuthFlow?: string;
/** Concrete provider-owned route selected before runtime dispatch. */
modelRoute?: AgentRuntimeAuthModelRoute;
/** Secret-free support shared by every route deferred to harness-owned auth. */
deferredRouteSupport?: AgentRuntimeAuthDeferredRouteSupport;
/** Redacted source selected for this concrete physical attempt. */
credentialSource?: AgentRuntimeCredentialSource;
};
/** Prompt transforms and provider contribution hooks for one runtime attempt. */
type AgentRuntimePromptPlan = {
provider: string;
modelId: string;
textTransforms?: AgentRuntimeTextTransforms;
resolveSystemPromptContribution(context: AgentRuntimeSystemPromptContributionContext): AgentRuntimeSystemPromptContribution | undefined;
transformSystemPrompt(context: AgentRuntimeSystemPromptContributionContext & {
systemPrompt: string;
}): string;
};
/** Prepared plugin metadata snapshot kept opaque to runtime-plan consumers. */
type AgentRuntimePreparedMetadataSnapshot = object;
/** Prepared metadata loader used by tool planning without eager manifest reads. */
type PreparedOpenClawToolPlanning = {
metadataSnapshot?: AgentRuntimePreparedMetadataSnapshot;
};
type AgentRuntimeModelOverrides = {
workspaceDir?: string;
modelApi?: string;
model?: AgentRuntimeModel;
};
/** Tool normalization and diagnostics hooks for one runtime attempt. */
type AgentRuntimeToolPlan = {
preparedPlanning?: PreparedOpenClawToolPlanning;
normalize<TSchemaType extends TSchema = TSchema, TResult = unknown>(tools: AgentTool<TSchemaType, TResult>[], params?: AgentRuntimeModelOverrides): AgentTool<TSchemaType, TResult>[];
logDiagnostics(tools: AgentTool[], params?: AgentRuntimeModelOverrides): void;
};
/** Delivery behavior hooks for one runtime attempt. */
type AgentRuntimeDeliveryPlan = {
isSilentPayload(payload: Pick<ReplyPayload, "text" | "mediaUrl" | "mediaUrls" | "presentation" | "interactive" | "channelData">): boolean;
resolveFollowupRoute(params: {
payload: ReplyPayload;
originatingChannel?: string;
originatingTo?: string;
originRoutable: boolean;
dispatcherAvailable: boolean;
}): AgentRuntimeFollowupFallbackRouteResult | undefined;
};
/** Extra transport parameter plan for one runtime attempt. */
type AgentRuntimeTransportPlan = {
extraParams: Record<string, unknown>;
resolveExtraParams(params?: {
extraParamsOverride?: Record<string, unknown>;
thinkingLevel?: AgentRuntimeThinkLevel;
agentId?: string;
workspaceDir?: string;
model?: AgentRuntimeModel;
resolvedTransport?: AgentRuntimeTransport;
}): Record<string, unknown>;
};
/** Complete prepared runtime plan consumed by embedded-agent attempts. */
type AgentRuntimePlan = {
resolvedRef: AgentRuntimeResolvedRef;
providerRuntimeHandle?: PreparedAgentRuntimeProviderHandle;
auth: AgentRuntimeAuthPlan;
prompt: AgentRuntimePromptPlan;
tools: AgentRuntimeToolPlan;
transcript: {
policy: AgentRuntimeTranscriptPolicy;
resolvePolicy(params?: AgentRuntimeModelOverrides): AgentRuntimeTranscriptPolicy;
};
delivery: AgentRuntimeDeliveryPlan;
outcome: {
classifyRunResult: AgentRuntimeOutcomeClassifier;
};
transport: AgentRuntimeTransportPlan;
observability: AgentRuntimeResolvedRef & {
resolvedRef: string;
authProfileId?: string;
};
};
/** Inputs needed to build delivery-only runtime decisions. */
type BuildAgentRuntimeDeliveryPlanParams = {
config?: unknown;
workspaceDir?: string;
agentDir?: string;
provider: string;
modelId: string;
providerRuntimeHandle?: PreparedAgentRuntimeProviderHandle;
};
/** Inputs needed to build the full prepared runtime plan. */
type BuildAgentRuntimePlanParams = BuildAgentRuntimeDeliveryPlanParams & {
model?: AgentRuntimeModel;
modelApi?: string | null;
harnessId?: string;
harnessRuntime?: string;
allowHarnessAuthProfileForwarding?: boolean;
/** Canonical route/auth decision prepared before attempt orchestration. */
preparedAuthPlan?: AgentRuntimeAuthPlan;
authProfileProvider?: string;
authProfileMode?: string;
sessionAuthProfileId?: string;
sessionAuthProfileSource?: "auto" | "user" | "user-link";
sessionAuthProfileCandidateIds?: string[];
authProfileStore?: AuthProfileStore;
modelRoute?: AgentRuntimeAuthModelRoute;
agentId?: string;
thinkingLevel?: AgentRuntimeThinkLevel;
extraParamsOverride?: Record<string, unknown>;
resolvedTransport?: AgentRuntimeTransport;
/** Omit only when a standalone caller intentionally resolves provider hooks lazily. */
providerRuntimeHandle?: PreparedAgentRuntimeProviderHandle;
/** Lifecycle-owned plugin metadata prepared before the attempt starts. */
metadataSnapshot?: AgentRuntimePreparedMetadataSnapshot;
};
//#endregion
//#region src/agents/embedded-agent-runner/types.d.ts
type BlockReplyFlushContext = {
/** Boundary that requested the flush. */
reason: "message_end" | "terminal";
} | {
/** Tool boundary separating pre-tool narration from the eventual answer. */
reason: "tool_start";
assistantMessageIndex: number;
} | {
/** Pre-compaction delivery is safe only for a completed assistant attempt. */
reason: "pre_compaction";
attemptAccepted: boolean;
};
type EmbeddedAgentUsage = Omit<NormalizedUsage, "contextUsage">;
type EmbeddedAgentMeta = {
sessionId: string;
sessionFile?: string;
provider: string;
model: string;
contextTokens?: number;
contextTokensSource?: "runtime" | "runtime-configured" | "resolved";
agentHarnessId?: string;
/** Sanitized provider-policy refusal attached to this physical attempt. */
providerRefusal?: {
provider?: string;
category?: string;
review?: ProviderRefusalReview;
nativeThreadId?: string;
nativeTurnId?: string;
};
/** Runtime-owned selection, independent of the final response or credential source. */
runtimeModelSelection?: ProviderModelRef;
/** Redacted credential source selected for the terminal physical model attempt. */
credentialSource?: AgentRuntimeCredentialSource;
fallbackAttempts?: FallbackAttempt[];
cliSessionBinding?: CliSessionBinding;
clearCliSessionBinding?: boolean;
compactionCount?: number;
/**
* Token count estimate after the most recent successful auto-compaction.
* Used as the freshest context snapshot when the follow-up model call omits
* usage metadata.
*/
compactionTokensAfter?: number;
/**
* Prompt/context snapshot from the latest model request. Prefer this for
* context-window utilization because provider usage totals can include cached
* and completion tokens that are useful for billing but noisy as live context.
*/
promptTokens?: number;
usage?: EmbeddedAgentUsage;
/** Terminal cumulative usage reserved for turn-level diagnostics. */
diagnosticUsage?: EmbeddedAgentUsage;
/**
* Usage from the last individual API call (not accumulated across tool-use
* loops or compaction retries). Used for context-window utilization display
* (`totalTokens` in sessions.json) because the accumulated `usage.input`
* sums input tokens from every API call in the run, which overstates the
* actual context size.
*/
lastCallUsage?: NormalizedUsage;
contextBudgetStatus?: SessionContextBudgetStatus;
/**
* True when code mode owned the model tool surface for this run. Config
* alone is not proof: the "auto" tier engages per model capability, raw
* model runs and plugin-harness surfaces can decline engagement, and the
* shell tool is also named `exec`, so consumers must read this flag
* instead of config or tool names.
*/
codeModeEngaged?: boolean;
/** Completed assistant/provider round trips accumulated across run attempts. */
assistantTurns?: number;
/**
* Code-mode/tool-search inner bridge calls for the run's catalog. These are
* invisible to the provider; `toolSummary.calls` stays the outer count.
*/
bridgeCalls?: {
search: number;
describe: number;
call: number;
};
/** Estimated USD cost of the run's accumulated usage. Omitted when the model has no cost data. */
costUsd?: number;
terminalReceipt?: Omit<AgentRunTerminalReceipt, "terminalDisposition">;
};
type TraceAttempt = {
provider: string;
model: string;
result: "success" | "timeout" | "surface_error" | "candidate_failed" | "rotate_profile" | "same_model_transient" | "fallback_model" | "aborted" | "error";
reason?: string;
stage?: "prompt" | "assistant";
elapsedMs?: number;
status?: number;
};
type ExecutionTrace = {
winnerProvider?: string;
winnerModel?: string;
attempts?: TraceAttempt[];
fallbackUsed?: boolean;
runner?: "embedded" | "cli";
providerPolicyRetry?: {
category: "cyber";
provider: string;
model: string;
};
};
type RequestShapingTrace = {
authMode?: string;
thinking?: string;
reasoning?: string;
verbose?: string;
trace?: string;
fallbackEligible?: boolean;
blockStreaming?: string;
};
type PromptSegmentTrace = {
key: string;
chars: number;
};
type ToolSummaryTrace = {
calls: number;
tools: string[];
failures?: number;
/** Latest tool failure not cleared by same-tool success, independent of reply presentation. */
unresolvedError?: {
toolName: string;
};
totalToolTimeMs?: number;
};
type CompletionTrace = {
finishReason?: string;
stopReason?: string;
refusal?: boolean;
};
type ContextManagementTrace = {
sessionCompactions?: number;
lastTurnCompactions?: number;
preflightCompactionApplied?: boolean;
postCompactionContextInjected?: boolean;
};
type EmbeddedRunLivenessState = "working" | "paused" | "blocked" | "abandoned";
type EmbeddedRunFailureSignal = {
kind: "execution_denied";
source: "tool";
toolName?: string;
code: "SYSTEM_RUN_DENIED" | "INVALID_REQUEST";
message: string;
fatalForCron: true;
};
type EmbeddedRunTerminalToolFailure = {
source: "tool";
toolName: "exec" | "wait";
code: "UNKNOWN_TOOL_ID";
};
type EmbeddedAgentRunMeta = {
durationMs: number;
agentMeta?: EmbeddedAgentMeta;
aborted?: boolean;
systemPromptReport?: SessionSystemPromptReport;
finalPromptText?: string;
finalAssistantVisibleText?: string;
finalAssistantRawText?: string;
replayInvalid?: boolean;
livenessState?: EmbeddedRunLivenessState;
timeoutPhase?: AgentRunTimeoutPhase;
providerStarted?: boolean;
/** Producer-owned terminal cause; the fallback owner decides whether a chain was stopped. */
modelFallbackStopReason?: "agent_run_terminal_timeout" | "idle_timeout_circuit_breaker" | "provider_review_continuation";
agentHarnessResultClassification?: "empty" | "reasoning-only" | "planning-only";
terminalReplyKind?: "silent-empty";
/** An exact, successfully settled tool batch intentionally completed the turn without a reply. */
intentionalTerminalCompletion?: "tool-batch";
terminalReply?: AgentRunTerminalReplySnapshot;
yielded?: boolean;
/** Explicit user-facing waiting status supplied to sessions_yield. */
yieldAcknowledgment?: string;
/** A visible parent delegated its otherwise-empty result to completion children. */
continuationPending?: true;
error?: {
kind: "context_overflow" | "compaction_failure" | "compaction_replay_refresh_required" | "role_ordering" | "image_size" | "retry_limit" | "incomplete_turn" | "hook_block";
message: string;
/** True only when model fallback can retry this terminal error without repeating side effects. */
fallbackSafe?: boolean;
/** True when the payload includes a trusted structured terminal tool summary. */
terminalPresentation?: boolean;
};
failureSignal?: EmbeddedRunFailureSignal;
/** Bounded, sanitized unresolved Code Mode failure for operator diagnostics. */
terminalToolFailure?: EmbeddedRunTerminalToolFailure;
/** Stop reason for the agent run (e.g., "completed", "tool_calls"). */
stopReason?: string;
/** Pending tool calls when stopReason is "tool_calls". */
pendingToolCalls?: Array<{
id: string;
name: string;
arguments: string;
}>;
executionTrace?: ExecutionTrace;
requestShaping?: RequestShapingTrace;
promptSegments?: PromptSegmentTrace[];
toolSummary?: ToolSummaryTrace;
completion?: CompletionTrace;
contextManagement?: ContextManagementTrace;
};
type EmbeddedAgentRunResult = {
latestMcpAppChannelView?: McpAppChannelView;
latestMcpConnectAction?: McpConnectAction;
payloads?: Array<{
text?: string;
mediaUrl?: string;
mediaUrls?: string[];
replyToId?: string;
isError?: boolean;
isReasoning?: boolean;
/** Marks pre-tool commentary (💬) — a display lane, suppressed unless the channel opts in. */
isCommentary?: boolean;
audioAsVoice?: boolean;
trustedLocalMedia?: boolean;
channelData?: Record<string, unknown>;
}>;
meta: EmbeddedAgentRunMeta;
diagnosticTrace?: DiagnosticTraceContext;
didSendViaMessagingTool?: boolean;
didDeliverSourceReplyViaMessageTool?: boolean;
sourceReplyDelivered?: true;
/** Current-input custody; unlike aggregate sends, this is reset when another input is admitted. */
sourceReplyDeliveryState?: ReplyDeliveryState;
didSendDeterministicApprovalPrompt?: boolean;
messagingToolSentTexts?: string[];
messagingToolSentMediaUrls?: string[];
messagingToolSentTargets?: MessagingToolSend[];
messagingToolSourceReplyPayloads?: MessagingToolSourceReplyPayload[];
acceptedSessionSpawns?: AcceptedSessionSpawn[];
/** An asynchronous tool task started during this run; its owner tracks completion. */
asyncWorkStarted?: true;
/** Completed core yield settlement, not a requester-visible final reply. */
requesterContinuationSettled?: true;
heartbeatToolResponse?: HeartbeatToolResponse;
successfulCronAdds?: number;
};
type EmbeddedAgentCompactResult = {
ok: boolean;
compacted: boolean;
compactionKind?: "context-engine" | "native-harness" | "server-endpoint";
reason?: string;
/** Structured failure metadata used by model fallback classification. */
failure?: {
reason?: string;
status?: number;
code?: string;
rawError?: string;
};
result?: {
/** Identifies summaryless provider compaction in RPC and UI consumers. */
kind?: "server-endpoint";
sessionTarget?: ContextEngineSessionTarget;
/** Server-endpoint compaction has no transcript summary or first-kept entry. */
summary?: string;
firstKeptEntryId?: string;
tokensBefore: number;
tokensAfter?: number;
details?: unknown;
sessionId?: string;
sessionFile?: string;
};
};
type EmbeddedFullAccessBlockedReason = "sandbox" | "host-policy" | "channel" | "runtime";
//#endregion
//#region src/agents/exec-auto-reviewer.d.ts
/** Config for the optional model-backed exec reviewer. */
type ExecReviewerConfig = NonNullable<NonNullable<ToolsConfig["exec"]>["reviewer"]>;
//#endregion
//#region src/agents/github-tool-identity.d.ts
type PreparedGitHubToolEnvironment = Readonly<{
credentialScrubEnv: Readonly<Record<string, string>>;
localIdentityEnv: Readonly<Record<string, string>>;
excludedStoreNames: readonly string[];
/** A local process must retain the host-selected profile and author identity. */
managedLocalIdentity: boolean;
}>;
//#endregion
//#region src/agents/bash-tools.exec-types.d.ts
/** Runtime defaults passed into exec/process tool factories. */
type ExecToolDefaults = {
hasCronTool?: boolean;
host?: ExecTarget;
mode?: ExecMode;
bypassHostApprovalFloors?: boolean;
security?: ExecSecurity;
ask?: ExecAsk;
trigger?: string;
node?: string;
/** Default working directory for node-host execution only. */
nodeCwd?: string;
pathPrepend?: string[];
safeBins?: string[];
strictInlineEval?: boolean;
commandHighlighting?: boolean;
safeBinTrustedDirs?: string[];
safeBinProfiles?: Record<string, SafeBinProfileFixture>;
reviewer?: ExecReviewerConfig;
config?: OpenClawConfig;
/** Host-prepared non-secret environment and store projection exclusions. */
preparedRunEnvironment?: PreparedGitHubToolEnvironment;
autoReviewer?: ExecAutoReviewer;
/** Reads current attempt context only when a command needs review. */
reviewTranscript?: () => ExecAutoReviewTranscript | undefined;
agentId?: string;
backgroundMs?: number;
cleanupMs?: number;
timeoutSec?: number;
approvalWarningText?: string;
approvalFollowupText?: string;
approvalFollowup?: ExecApprovalFollowupFactory;
approvalFollowupMode?: "agent" | "direct";
approvalRunningNoticeMs?: number;
sandbox?: BashSandboxConfig;
/** Immutable session policy that forbids execution outside its provisioned sandbox. */
sandboxRequired?: boolean;
elevated?: ExecElevatedDefaults;
allowBackground?: boolean;
/** Final run-local availability of the process continuation tool. */
processToolAvailabilityRef?: {
value?: boolean;
};
scopeKey?: string;
sessionKey?: string;
/** Executing session when tool policy is borrowed from a different session. */
runSessionKey?: string;
/** Stable agent run that owns any approval created by this tool. */
runId?: string;
/** Exact admitted execution instance that owns secret-egress proxy access. */
operationalRunInstance?: OperationalRunInstanceRef;
/** Durable session that receives detached exec completion events and approval followups. */
notifySessionKey?: string;
/** Ephemeral session UUID active when this exec tool was built. Regenerated
* on `/new` and `/reset`, so it pins exec-approval followups to the original
* session instance and lets stale followups drop after a session rebind. */
sessionId?: string;
/** `session.store` template from the runtime config. Lets the direct/denied
* exec approval followup path resolve the session key's current sessionId and
* drop the followup when the key was rebound by `/new` or `/reset`. */
sessionStore?: string;
/** @deprecated SDK declaration compatibility; coding-tool routing comes from config. */
mainKey?: string;
/** @deprecated SDK declaration compatibility; coding-tool routing comes from config. */
sessionScope?: "per-sender" | "global";
/** Start-time routing policy for detached exec system events. */
eventRouting?: EventSessionRoutingPolicy;
messageProvider?: string;
currentChannelId?: string;
currentThreadTs?: string;
/** Channel-owned sender/chat metadata. Exec subprocesses receive only sender/chat IDs. */
channelContext?: PluginHookChannelContext;
accountId?: string;
approvalReviewerDeviceId?: string;
/** Deny approval-requiring commands without creating operator approval events. */
nonInteractiveApproval?: boolean;
notifyOnExit?: boolean;
notifyOnExitEmptySuccess?: boolean;
cwd?: string;
};
/** Outcome passed to approval follow-up factories after approved async exec. */
type ExecApprovalFollowupOutcome = {
status: "completed" | "failed";
exitCode: number | null;
exitReason?: TerminationReason;
timedOut: boolean;
aggregated: string;
reason?: string;
};
type ExecApprovalFollowupContext = {
approvalId: string;
sessionId: string;
trigger?: string;
outcome: ExecApprovalFollowupOutcome;
};
/** Hook that can append domain-specific text to approval follow-up messages. */
type ExecApprovalFollowupFactory = (context: ExecApprovalFollowupContext) => string | undefined | Promise<string | undefined>;
/** Effective elevated-exec defaults derived from config/runtime policy. */
type ExecElevatedDefaults = {
enabled: boolean;
allowed: boolean;
defaultLevel: "on" | "off" | "ask" | "full";
fullAccessAvailable?: boolean;
fullAccessBlockedReason?: EmbeddedFullAccessBlockedReason;
};
//#endregion
//#region src/agents/bash-tools.exec-approval-output.d.ts
type ExecApprovalContinuationPromptRange = {
start: number;
end: number;
};
//#endregion
//#region src/agents/internal-event-contract.d.ts
declare const AGENT_INTERNAL_EVENT_TYPE_TASK_COMPLETION: "task_completion";
declare const AGENT_INTERNAL_EVENT_SOURCES: readonly ["subagent", "cron", "image_generation", "video_generation", "music_generation"];
declare const AGENT_INTERNAL_EVENT_STATUSES: readonly ["ok", "timeout", "error", "unknown"];
type AgentInternalEventSource = (typeof AGENT_INTERNAL_EVENT_SOURCES)[number];
type AgentInternalEventStatus = (typeof AGENT_INTERNAL_EVENT_STATUSES)[number];
//#endregion
//#region src/agents/generated-attachments.d.ts
type AgentGeneratedAttachment = Omit<ReplyMediaAttachment, "trustedLocalMedia">;
//#endregion
//#region src/agents/internal-events.d.ts
type AgentTaskCompletionInternalEvent = {
type: typeof AGENT_INTERNAL_EVENT_TYPE_TASK_COMPLETION;
source: AgentInternalEventSource;
childSessionKey: string;
childSessionId?: string;
announceType: string;
taskLabel: string;
status: AgentInternalEventStatus;
statusLabel: string;
result: string;
/** True only when the producer substituted placeholder text for an absent result. */
noVisibleResult?: boolean;
modelRouteChange?: string;
attachments?: AgentGeneratedAttachment[];
mediaUrls?: string[];
statsLine?: string;
replyInstruction: string;
};
/** Internal event variants that can be rendered into agent prompt context. */
type AgentInternalEvent = AgentTaskCompletionInternalEvent;
//#endregion
//#region src/agents/subagents/announce/subagent-announce-handoff.d.ts
type SubagentSettleToolPolicyBatch = {
sourceSessionKeys: readonly string[];
/** The settle owner retains batch, requester-incarnation, and revocation authority. */
isCurrent: () => boolean;
};
type TrustedSubagentCompletionHandoff = {
kind: "subagent-completion";
sourceSessionKey: string;
sourceSessionId?: string;
targetSessionKey: string;
targetSessionId: string;
provider: string;
model: string;
settleBatch?: SubagentSettleToolPolicyBatch;
};
type SubagentCompletionToolHandoffRegistration = {
sourceSessionKey: string;
sourceSessionId?: string;
targetSessionKey: string;
targetSessionId: string;
idempotencyKey: string;
settleBatch?: SubagentSettleToolPolicyBatch;
};
declare namespace reply_run_finalization_lease_d_exports {
export { ReplyOperationStaleReason$1 as ReplyOperationStaleReason, beginReplyOperationFinalizationWork, createReplyRunFinalizationLease, createReplyRunSettleTimer, formatReplyOperationResult, resetReplyRunSettleTimersForTesting };
}
type ReplyOperationStaleReason$1 = "terminal_unreleased" | "finalization_stalled" | "no_activity" | "stuck_recovery";
declare function formatReplyOperationResult(result: {
kind: "completed";
} | {
kind: string;
code: string;
} | null): string;
type FinalizationLease = {
begin(): void;
beginWork(timeoutMs: number): () => void;
clear(): void;
recordActivity(): void;
};
type ReplyRunSettleTimer = {
clear(): void;
renew(timeoutMs: number): void;
scheduleOnce(timeoutMs: number): void;
};
declare function createReplyRunSettleTimer(params: {
canExpire: () => boolean;
onExpire: () => void;
}): ReplyRunSettleTimer;
declare function createReplyRunFinalizationLease(params: {
owner: object;
canExpire: () => boolean;
onActivity: () => void;
onExpire: () => void;
onFinalizationProgress: () => void;
}): FinalizationLease;
declare function beginReplyOperationFinalizationWork(owner: object, timeoutMs: number): () => void;
declare function resetReplyRunSettleTimersForTesting(): void;
//#endregion
//#region src/auto-reply/reply/reply-run-registry.contracts.d.ts
type ReplyRunKey = string;
type ReplyBackendKind = "embedded" | "cli";
type ReplyBackendCancelReason = "user_abort" | "restart" | "superseded";
type ReplyTurnKind = "visible" | "heartbeat" | "queued_followup";
type ReplyBackendQueueMessageOptions = {
/** Prepared context for this queue item, separate from its transcript and answer text. */
currentInboundContext?: CurrentInboundPromptContext;
steeringMode?: "all";
/** True when this queue item came from the channel's current user turn. */
isInboundUserMessage?: boolean;
terminalReplyExpectation?: ReplyExpectation;
/** Exact tool authority resolved for an inbound user turn before steering. */
toolAuthorityFingerprint?: string;
/** Internal proof that a mismatched route recomputes to the active run's full authority. */
pendingInputAuthorityFingerprint?: string;
debounceMs?: number;
/** Ordered current-turn images to inject with the steering text. */
images?: ImageContent$1[];
imageOrder?: PromptImageOrderEntry[];
/** Ordered facts represented by attachment text in this steering prompt. */
media?: MediaFact[];
deliveryTimeoutMs?: number;
waitForTranscriptCommit?: boolean;
/** Stable source identity for exact queued-message commit/cancellation matching. */
queueIdentity?: string;
abortSignal?: AbortSignal;
/** Releases arrival ordering once the runtime has actually accepted this queue item. */
onQueueAccepted?: (accepted: boolean) => void;
sourceReplyDeliveryMode?: SourceReplyDeliveryMode;
taskSuggestionDeliveryMode?: TaskSuggestionDeliveryMode;
/** Prepared channel turn to merge only at transcript persistence. */
userTurnTranscriptRecorder?: UserTurnTranscriptRecorder;
};
type ReplyToolAuthorityRoute = Readonly<{
provider: string;
model: string;
}>;
/** Per-message authority facts projected against an active run's frozen owner state. */
type ReplyToolAuthorityOverlay = Readonly<{
operatorAuthority?: AdmittedRunOperatorAuthority;
permissionMode?: SessionEntry$1["permissionMode"];
toolOverrides?: SessionEntry$1["toolOverrides"];
originatingChannel?: OriginatingChannelType;
messageProvider?: string;
chatType?: ChatType;
agentAccountId?: string;
conversationToolPolicy?: GroupToolPolicyConfig;
groupId?: string;
groupChannel?: string;
groupSpace?: string;
memberRoleIds?: string[];
spawnedBy?: string;
senderId?: string;
senderName?: string;
senderUsername?: string;
senderE164?: string;
senderIsOwner: boolean;
inputProvenance?: InputProvenance;
trustedInternalHandoff?: TrustedSubagentCompletionHandoff;
scheduledToolPolicy?: ScheduledToolPolicyContext;
runtimePluginToolGrant?: RuntimePluginToolGrant;
toolsAllow?: string[];
disableTools: boolean;
traceAuthorized: boolean;
approvalReviewerDeviceId?: string;
clientCaps?: string[];
gatewayUiCommandTarget?: GatewayUiCommandTarget;
toolBindings?: Readonly<Record<string, unknown>>;
}>;
type ReplyTurnParticipantInput = Pick<ReplyToolAuthorityOverlay, "operatorAuthority" | "senderId" | "senderName" | "gatewayUiCommandTarget">;
type ReplyToolAuthoritySnapshot = Readonly<{
personalToolOwner?: ReplyTurnParticipantInput;
/** Selection admitted before runtime fallback or hooks choose a concrete model. */
requestedRoute?: ReplyToolAuthorityRoute;
fingerprint(route?: ReplyToolAuthorityRoute): string;
project: (overlay: ReplyToolAuthorityOverlay, route: ReplyToolAuthorityRoute) => string;
}>;
type ReplyTurnParticipant = Readonly<{
profileId: string;
senderId: string;
name: string;
gatewayUiCommandTarget?: GatewayUiCommandTarget;
assertCurrent: () => void;
}>;
type ReplyTurnParticipants = {
accept(participant: ReplyTurnParticipantInput): void;
resolve(this: void, user?: string): ReplyTurnParticipant | undefined;
close(): void;
};
type ReplyBackendQueueMessageResult = {
/** Input is non-replayable, but its delivery or commitment could not be confirmed. */
transcriptCommit: "unconfirmed";
errorMessage: string;
};
type ReplyBackendMessageInjection = {
/** Runtime-owned admission state; independent from token streaming. */
isAvailable(): boolean;
queueMessage(text: string, options?: ReplyBackendQueueMessageOptions): Promise<void | ReplyBackendQueueMessageResult>;
};
/** V2 sinks invoke the host-owned, per-injection assertion at their final effect. */
type ReplyBackendMessageInjectionV2 = {
readonly version: 2;
isAvailable(): boolean;
queueMessage(text: string, options: ReplyBackendQueueMessageOptions | undefined, assertCurrent: () => void, authorityKind: "run" | "source-bound"): Promise<void | ReplyBackendQueueMessageResult>;
claimPendingUserInputAnswer?(text: string, options: ReplyBackendQueueMessageOptions | undefined, assertCurrent: () => void, authorityKind: "run" | "source-bound"): Promise<boolean>;
cancelPendingUserInput?(resolvedBy: string, assertCurrent: () => void, authorityKind: "run" | "source-bound"): Promise<boolean>;
};
type ReplyBackendHandle = {
readonly kind: ReplyBackendKind;
readonly runId?: string;
/** Exact authority of this concrete backend attempt, after fallback selection. */
readonly toolAuthorityFingerprint?: string;
readonly sourceReplyDeliveryMode?: SourceReplyDeliveryMode;
readonly terminalReplyExpectation?: ReplyExpectation;
readonly taskSuggestionDeliveryMode?: TaskSuggestionDeliveryMode;
/** True only when queueMessage preserves images supplied in its options. */
readonly supportsQueueMessageImages?: boolean;
claimPendingUserInputAnswer?: (text: string, options?: ReplyBackendQueueMessageOptions) => Promise<boolean>;
cancelPendingUserInput?: (resolvedBy: string) => Promise<boolean>;
cancel(reason?: ReplyBackendCancelReason): void;
readonly messageInjection?: ReplyBackendMessageInjection;
/** V1 remains compatible with v2026.8.1; source-bound input requires V2. */
readonly messageInjectionV2?: ReplyBackendMessageInjectionV2;
/** @deprecated Compatibility for shipped embedded handles. Use messageInjection. */
isStreaming?: () => boolean;
isStopped?: () => boolean;
isAbortable?: () => boolean;
/** @deprecated Compatibility for shipped embedded handles. Use messageInjection. */
queueMessage?: (text: string, options?: ReplyBackendQueueMessageOptions) => Promise<void | ReplyBackendQueueMessageResult>;
/**
* Compatibility-only hook so legacy "abort compacting runs" paths can still
* find embedded runs that are compacting during the main run phase.
*/
isCompacting?: () => boolean;
};
type ReplyOperationPhase = "queued" | "waiting_for_deferred_maintenance" | "waiting_for_global_lane" | "preflight_compacting" | "memory_flushing" | "running" | "completed" | "failed" | "aborted";
type ReplyOperationFailureCode = "gateway_draining" | "command_lane_cleared" | "aborted_by_user" | "session_corruption_reset" | "run_stalled" | "run_failed";
type ReplyOperationAbortCode = "aborted_by_user" | "aborted_for_restart" | "aborted_for_supersession";
type ReplyOperationResult = {
kind: "completed";
} | {
kind: "failed";
code: ReplyOperationFailureCode;
cause?: unknown;
} | {
kind: "aborted";
code: ReplyOperationAbortCode;
};
type ReplyOperation = {
readonly personalToolParticipants?: ReplyTurnParticipants;
readonly key: ReplyRunKey;
readonly sessionId: string;
/** Captured logical owner for session activity, including raw global keys. */
readonly agentId?: string;
readonly turnKind: ReplyTurnKind;
/** Gateway lifecycle that admitted this process-local owner. */
readonly lifecycleGeneration?: string;
readonly routeThreadId?: string | number;
/** Transcript branch leaf from which this operation was admitted. */
readonly originatingLeafEntryId?: string | null;
readonly abortSignal: AbortSignal;
readonly resetTriggered: boolean;
/**
* True when this operation was admitted to recover a terminal session (a
* leftover failed/timeout/killed run). Concurrent visible turns reading the
* same terminal store snapshot must NOT force-clear such an operation: it is a
* sibling recovery already in flight, not the proven stale leftover.
*/
readonly terminalRecovery: boolean;
/**
* Sticky fact for audio accepted into this operation after its originating turn.
* Final delivery reads it because the original dispatch context cannot change.
*/
readonly acceptedSteeredInboundAudio: boolean;
/** Immutable tool authority accepted by the active backend for steered user turns. */
readonly toolAuthorityFingerprint?: string;
/** Initial selected model; a concrete attempt must not replace user intent. */
readonly requestedToolAuthorityRoute?: ReplyToolAuthorityRoute;
/** Current candidate proven automatic by the fallback owner; identity marks its attempt. */
readonly automaticFallbackRoute?: ReplyToolAuthorityRoute;
/** Concrete provider/model route currently selected for this operation. */
readonly toolAuthorityRoute?: ReplyToolAuthorityRoute;
readonly phase: ReplyOperationPhase;
readonly result: ReplyOperationResult | null;
/** Set when a stale-watchdog expiry forced this operation's run_stalled result. */
readonly staleExpiryReason?: ReplyOperationStaleReason;
readonly startedAtMs: number;
readonly lastActivityAtMs: number;
/** True when this operation has owned the supplied session ID. */
hasOwnedSessionId(sessionId: string): boolean;
/** Capture lineage before a pending barrier outlives this operation's lane. */
captureOwnedSessionIds(): Set<string>;
recordActivity(): void;
setPhase(next: "queued" | "waiting_for_deferred_maintenance" | "waiting_for_global_lane" | "preflight_compacting" | "memory_flushing" | "running"): void;
/** Mark this operation as waiting on prior same-session maintenance. */
markWaitingForDeferredMaintenance(): void;
/** Return a maintenance-waiting operation to queued if the run has not started. */
markDeferredMaintenanceWaitEnded(): void;
/** Mark this operation as waiting for process-global run capacity. */
markWaitingForGlobalLane(): void;
/** Return a global-lane-waiting operation to queued once capacity is granted. */
markGlobalLaneWaitEnded(): void;
/** Mark this operation as an in-flight terminal-session recovery. */
markTerminalRecovery(): void;
markAcceptedSteeredInboundAudio(): void;
/** Freeze the complete caller policy before a concrete backend attempt attaches. */
bindToolAuthoritySnapshot(snapshot: ReplyToolAuthoritySnapshot): void;
setAutomaticFallbackRoute(route: ReplyToolAuthorityRoute | undefined): void;
/** Project an inbound turn through the current concrete route; settled owners fail closed. */
projectToolAuthorityFingerprint(overlay: ReplyToolAuthorityOverlay): string | undefined;
/** Prepare fingerprint and projection together for the final concrete attempt route. */
bindToolAuthorityRoute(route: ReplyToolAuthorityRoute): string;
updateSessionId(nextSessionId: string): void;
/**
* Move this queued operation to another session key's run slot. Native command
* turns admit under the slash SOURCE key; when the command continues into a full
* agent turn it must own the TARGET session's slot so concurrent target inbounds
* queue/steer instead of double-admitting. Throws ReplyRunAlreadyActiveError when
* the target slot is owned. Capture the selected agent even when a raw key stays unchanged.
*/
updateSessionKey(nextSessionKey: string, agentId?: string): void;
attachBackend(handle: ReplyBackendHandle): void;
detachBackend(handle: ReplyBackendHandle): void;
/** Reject later aborts after the backend has committed its terminal outcome. */
freezeAbort(): void;
/**
* Keep a failed operation active until complete() releases the session lane.
* Dispatch uses this while a user-visible failure payload still needs delivery.
*/
retainFailureUntilComplete(): void;
/** Settles after the lifecycle owner's final delivery/persistence barrier. */
readonly ownerSettlement?: Promise<void>;
complete(): void;
/**
* Complete the operation, clear active-run state, then run follow-up work.
* Use when the follow-up can create another ReplyOperation for this session.
*/
completeThen(afterClear: () => void): void;
/**
* Clear active-run state immediately, but delay registered after-clear work
* until delivery or another external barrier settles.
*/
completeWithAfterClearBarrier(barrier: PromiseLike<unknown>, timeout?: number | ReplyFollowupAdmissionBarrierTimeoutPolicy): void;
fail(code: Exclude<ReplyOperationFailureCode, "aborted_by_user">, cause?: unknown): void;
abortByUser(): boolean;
abortForRestart(): boolean;
supersede(beforeSupersede?: () => void): boolean;
};
type ReplyOperationStaleReason = ReplyOperationStaleReason$1;
//#endregion
//#region src/process/lanes.d.ts
type CommandLaneConfiguration = {
readonly lane: string;
readonly maxConcurrent: number;
};
//#endregion
//#region src/agents/bootstrap-mode.d.ts
type BootstrapContextRunKind = "default" | "heartbeat" | "cron";
//#endregion
//#region src/agents/embedded-agent-payloads.d.ts
/**
* Channel-facing reply payload emitted by embedded agents. Keep this type
* small: channel adapters decide how to render text, media, and reply targets.
*/
type BlockReplyPayload = {
text?: string;
mediaUrls?: string[];
attachments?: ReplyMediaAttachment[];
audioAsVoice?: boolean;
trustedLocalMedia?: boolean;
sensitiveMedia?: boolean;
isReasoning?: boolean;
/** Marks pre-tool commentary (💬) — a display lane, suppressed unless the channel opts in. */
isCommentary?: boolean;
replyToId?: string;
replyToTag?: boolean;
replyToCurrent?: boolean;
/** Portable controls attached to a harness-owned blocking prompt. */
presentation?: MessagePresentation;
/** Runtime-authored text is the fallback for the portable presentation. */
presentationTextMode?: "fallback";
/** Channel-specific routing metadata for runtime-owned interactions. */
channelData?: Record<string, unknown>;
};
//#endregion
//#region src/agents/fast-mode.d.ts
type FastModeState = {
mode: FastMode;
enabled: boolean;
source: FastModeSource;
fastAutoOnSeconds: number;
};
/** Resolve the effective fast-mode setting and its source. */
declare function resolveFastModeState(params: {
cfg: OpenClawConfig | undefined;
provider: string;
model: string;
agentId?: string;
sessionEntry?: Pick<SessionEntry$1, "fastMode"> | undefined;
}): FastModeState;
//#endregion
//#region src/context-engine/host-compat.d.ts
type ContextEngineHostSupport = {
id: string;
label: string;
capabilities: readonly ContextEngineHostCapability[];
};
declare const CODEX_APP_SERVER_CONTEXT_ENGINE_HOST: {
readonly id: "codex-app-server";
readonly label: "Codex app-server harness";
readonly capabilities: readonly ["bootstrap", "assemble-before-prompt", "after-turn", "maintain", "compact", "runtime-llm-complete", "thread-bootstrap-projection"];
};
/** Assert that a context engine can safely run under the supplied host. */
declare function assertContextEngineHostSupport(params: {
contextEngine: ContextEngine;
operation: ContextEngineOperation;
host: ContextEngineHostSupport;
}): void;
//#endregion
//#region src/agents/harness/context-engine-logical-turn.d.ts
type EffectiveContextEngineRef = Readonly<{
engine: ContextEngine;
registeredId: string;
ownerPluginId?: string;
mode: "configured" | "legacy-degraded";
reason?: string;
}>;
type ContextEngineLogicalTurnLease = {
/** Compatibility getter for internal callers while the single context object is threaded. */
readonly engine: ContextEngine;
readonly effectiveEngine: ContextEngine;
readonly effectiveEngineId: string;
readonly effectiveEnginePluginId?: string;
readonly degraded: boolean;
readonly degradedReason?: string;
selectForHost: (params: {
host: ContextEngineHostSupport;
operation: ContextEngineOperation;
requiresDurableCommit: boolean;
}) => EffectiveContextEngineRef;
degradeBeforeStart: (reason: string) => EffectiveContextEngineRef;
begin: () => EffectiveContextEngineRef;
deferDisposalUntil: (promise: Promise<unknown>) => void;
dispose: () => Promise<void>;
};
//#endregion
//#region src/agents/harness/context-engine-turn-outbox.d.ts
/** Persist only resolved model facts, never live capabilities or credential-bearing config. */
type ContextEngineTurnRuntimeContext = Readonly<{
provider?: string;
modelId?: string;
modelContextWindow?: number;
tokenBudget?: number;
}>;
//#endregion
//#region src/agents/harness/context-engine-turn-attempt.d.ts
type ContextEngineTurnAttemptFacts = {
boundary: TranscriptTurnBoundary;
sessionIdUsed: string;
sessionKey?: string;
sessionTarget?: ContextEngineSessionTarget;
promptError: boolean;
aborted: boolean;
yieldAborted: boolean;
isHeartbeat?: boolean;
runtimeContext?: ContextEngineTurnRuntimeContext;
};
//#endregion
//#region src/agents/command/shared-types.d.ts
/** Best-effort provider stream parameter overrides for an agent command. */
type AgentStreamParams = {
/** Provider stream params override (best-effort). */
temperature?: number;
topP?: number;
maxTokens?: number;
/** Stop sequences forwarded to the provider (best-effort). */
stop?: string[];
/** Provider fast-mode override (best-effort). */
fastMode?: boolean;
responseFormat?: Record<string, unknown>;
frequencyPenalty?: number;
presencePenalty?: number;
seed?: number;
};
/** Simplified tool definition for client-provided OpenResponses hosted tools. */
type ClientToolDefinition = {
type: "function";
function: {
name: string;
description?: string;
parameters?: Record<string, unknown>;
/** Strict argument enforcement (Responses API). Propagated from the request. */
strict?: boolean;
};
};
type AgentRunClientContext = {
/** Profile selected from the session's assigned human owner or authenticated human creator, never its latest sender. */
bootstrapUserProfileId?: string;
/** Capabilities declared by the gateway client that originated this run. */
clientCaps?: string[];
gatewayUiCommandTarget?: GatewayUiCommandTarget;
/** Host-admitted dashboard authoring without an originating inline renderer. */
pinnedWidgetAuthoring?: boolean;
};
type AgentRunMessageContext = {
agentAccountId?: string;
/** Opaque host-issued capability for current-turn channel message actions. */
messageActionTurnCapability?: string;
/** Trusted sender identity bit for command/channel-action auth. */
senderIsOwner?: boolean;
/** Current channel ID for auto-threading (Slack). */
currentChannelId?: string;
/** Current thread timestamp for auto-threading (Slack). */
currentThreadTs?: string;
/** Current inbound message id for action fallbacks (e.g. Telegram react). */
currentMessageId?: string | number;
/** True when the current inbound turn carried audio media. */
currentInboundAudio?: boolean;
/** Reply-to mode for Slack auto-threading. */
replyToMode?: "off" | "first" | "all" | "batched";
/** Visible source replies must use the message tool when set to message_tool_only. */
sourceReplyDeliveryMode?: SourceReplyDeliveryMode;
/** Action sink available for model-proposed follow-up tasks. */
taskSuggestionDeliveryMode?: TaskSuggestionDeliveryMode;
/** Require explicit message tool targets (no implicit last-route sends). */
requireExplicitMessageTarget?: boolean;
};
type AgentRunChannelContext = {
/** Canonical transport channel when it differs from the tool-policy provider. */
messageChannel?: string;
messageProvider?: string;
chatType?: ChatType;
/** Channel-specific identity metadata surfaced to plugin hooks. */
channelContext?: PluginHookChannelContext;
senderId?: string | null;
senderName?: string | null;
senderUsername?: string | null;
senderE164?: string | null;
/** Group id for channel-level tool policy resolution. */
groupId?: string | null;
/** Group channel label (e.g. #general) for channel-level tool policy resolution. */
groupChannel?: string | null;
/** Group space label (e.g. guild/team id) for channel-level tool policy resolution. */
groupSpace?: string | null;
/** Parent session key for subagent policy inheritance. */
spawnedBy?: string | null;
/** Device-scoped operator session allowed to review approvals initiated by this run. */
approvalReviewerDeviceId?: string;
};
type AgentRunModelOptions = {
/** Vision capability resolved by the run owner from its prepared model catalog. */
modelHasVision?: boolean;
/** Session-selected context-window option id carried by the run owner. */
contextWindow?: string;
model?: string;
/** Outer model-fallback owner facts for this admitted attempt. */
modelRoutingProvenance?: ModelFallbackAttemptProvenance;
thinkLevel?: ThinkLevel;
fastMode?: FastMode;
/** Stable outer-run start time for auto fast-mode cutoff across retries/fallbacks. */
fastModeStartedAtMs?: number;
/** Effective auto fast-mode cutoff for this run, in seconds. */
fastModeAutoOnSeconds?: number;
/** Shared notification state for nested harnesses that can observe the same tool boundary. */
fastModeAutoProgressState?: FastModeAutoProgressState;
/** True when the outer model fallback loop has reached its final candidate. */
isFinalFallbackAttempt?: boolean;
authProfileId?: string;
};
type AgentRunInputContext = {
workspaceDir: string;
/** Canonical agent workspace used for bootstrap files when execution runs elsewhere. */
bootstrapWorkspaceDir?: string;
agentDir?: string;
/** Task working directory for tool/runtime execution. Defaults to workspaceDir. */
cwd?: string;
/**
* Run config consumed by core paths (model selection, tools, plugin
* activation). Plugin harnesses resolve `plugins.entries.<id>.config` from
* the live global config, NOT from this object — per-run plugin-config
* overrides are unsupported; use an explicit run param instead.
*/
config?: OpenClawConfig;
toolOverrides?: SessionToolOverrides;
prompt: string;
/** User-visible prompt body to submit and persist; runtime context travels separately. */
transcriptPrompt?: string;
currentInboundEventKind?: InboundEventKind;
inputProvenance?: InputProvenance;
extraSystemPrompt?: string;
images?: ImageContent$1[];
imageOrder?: PromptImageOrderEntry[];
/** Ordered facts represented by attachment text in the current prompt. */
media?: MediaFact[];
skillsSnapshot?: SkillSnapshot;
ownerNumbers?: string[];
/** Seen bootstrap truncation warning signatures for this session (once mode dedupe). */
bootstrapPromptWarningSignaturesSeen?: string[];
/** Last shown bootstrap truncation warning signature for this session. */
bootstrapPromptWarningSignature?: string;
/** Run kind hint for context mode behavior. */
bootstrapContextRunKind?: BootstrapContextRunKind;
};
type AgentRunTranscriptContext = {
/** Caller-owned in-memory transcript for ephemeral helper runs. */
sessionManager?: SessionManager;
sessionId: string;
sessionKey?: string;
prepareAssistantTranscriptMessage?: PrepareAssistantTranscriptMessage;
userTurnTranscriptRecorder?: UserTurnTranscriptRecorder;
/** Context engine resolved once by the outer logical-turn owner. */
contextEngineLogicalTurnLease?: ContextEngineLogicalTurnLease;
/** Emits immutable attempt facts for selection by the outer logical-turn owner. */
onContextEngineTurnCandidate?: (facts: ContextEngineTurnAttemptFacts) => void;
suppressNextUserMessagePersistence?: boolean;
onUserMessagePersisted?: (message: Extract<AgentMessage, {
role: "user";
}>) => void;
};
type AgentRunLifecycle = {
providerReviewAcknowledgment?: ProviderReviewAcknowledgment;
/** Already-admitted internal execution; mutually exclusive with preparedRunAdmission. */
admittedRunContext?: AdmittedRunContext;
/** Host-only post-prepare continuation, removed before plugin invocation. */
preparedRunAdmission?: PreparedAgentRunAdmission;
agentId?: string;
timeoutMs: number;
/** Explicit timeout override; equality with the configured default does not imply inheritance. */
runTimeoutOverrideMs?: number;
runId: string;
/** Exact attempt authority attached to the active steering backend. */
toolAuthorityFingerprint?: string;
/** Immutable gateway lifecycle ownership captured when this execution was admitted. */
lifecycleGeneration?: string;
lane?: string;
swarmExecutionLane?: CommandLaneConfiguration;
/** Stable cron job identifier populated for cron-triggered runs. */
jobId?: string;
/** Trusted server-stamped authority for an explicitly capped scheduled run. */
scheduledToolPolicy?: ScheduledToolPolicyContext;
/** Disable built-in tools for this run (LLM-only mode). */
disableTools?: boolean;
abortSignal?: AbortSignal;
onPartialReply?: (payload: PartialReplyPayload) => boolean | void | Promise<boolean | void>;
onBlockReply?: (payload: BlockReplyPayload, context?: BlockReplyContext) => void | Promise<void>;
replyOperation?: ReplyOperation;
/**
* Dispose bundled MCP runtimes when the overall run ends instead of preserving
* the session-scoped cache. Intended for one-shot local CLI runs that must
* exit promptly after emitting the final JSON result.
*/
cleanupBundleMcpOnRunEnd?: boolean;
/** Mark explicit one-shot local CLI runs so plugin tools can release resources promptly. */
oneShotCliRun?: boolean;
};
//#endregion
//#region src/agents/conversation-recall.types.d.ts
type ConversationRecallContext = {
/** Private conversation that requested this bounded recall pass. */
anchorSessionKey: string;
/** Only same-agent private transcript hits may pass. */
scope: "same-agent-private";
/** Product-only recall searches sessions; advanced recall keeps configured corpora. */
corpus: "sessions" | "configured";
};
//#endregion
//#region src/gateway/cron-creator-authority-grant.d.ts
/** Admission fact, independent of a run lifetime so an authorized yield can transfer it. */
type CronManagementEntitlement = Readonly<{
source: "control-ui-admin";
}> | Readonly<{
source: "channel-owner";
isCurrent: () => boolean;
}>;
type CronCreatorAuthorityRunScope = {
readonly runId: string;
readonly callerOrigin: CronScheduledToolCallerOrigin;
readonly signal: AbortSignal;
readonly grantTokens: Set<string>;
readonly managementEntitlement?: CronManagementEntitlement;
/** Separately admitted channel-owner identity, not implied by automation management rights. */
readonly requesterOwner?: Readonly<{
isCurrent: () => boolean;
senderId?: string;
channel?: string;
accountId?: string;
}>;
/** Fresh admission only; never transferred with a management continuation. */
readonly callerScopedCreation?: true;
/** @deprecated Read managementEntitlement. Harness source compatibility lasts through 2026-10-12. */
readonly controlUiAdmin?: true;
readonly isCurrent?: () => boolean;
active: boolean;
abort: () => void;
};
//#endregion
//#region src/agents/tools/cron-tool.types.d.ts
type CronCreatorToolAllowlistEntry = string | {
/** Canonical policy name persisted into toolsAllow caps. */
name: string;
pluginId?: string;
/** Runtime-specific alias the creator surface presented for this tool. */
aliasName?: string;
/** Restrict-only execution policy carried by a host-created alias projection. */
execTarget?: {
host: "gateway";
ask?: "always";
};
};
type CronToolsAllowCaptureProvenance = {
version: 1;
source: "final-executable-surface";
};
type CronToolsAllowCaptureRef = {
value?: CronToolsAllowCaptureProvenance;
};
type CronCreatorToolAuthorityMaterialization = {
tools: readonly CronCreatorToolAllowlistEntry[];
provenance: CronToolsAllowCaptureProvenance;
/** Opaque runtime-owned authority captured with the same exact executable surface. */
runtimeAuthority?: CronRuntimeAuthority;
};
type CronCreatorToolAuthoritySnapshot = Omit<CronCreatorToolAuthorityMaterialization, "runtimeAuthority"> & {
/** Gateway-process one-shot proof consumed only at the matching cron write. */
grant: CronCreatorAuthorityGrant;
};
type CronToolOptions = {
agentSessionKey?: string;
agentId?: string;
/** Authenticated source account; authority must not be inferred from delivery. */
agentAccountId?: string;
/**
* Resolved config for the calling context. Shapes the advertised schema and
* description: when cron.triggers.enabled is off, trigger-gated surfaces
* (trigger, script payloads, stream schedules) are not advertised. Omitting
* config keeps the full surface for config-less callers.
*/
config?: OpenClawConfig;
currentDeliveryContext?: DeliveryContext;
/**
* Effective tool surface visible to the caller that created or edited a cron job.
* Cron agent turns and trigger scripts use fresh runtimes, so agent-origin jobs
* need this cap persisted before the original session policy is lost.
*/
creatorToolAllowlist?: CronCreatorToolAllowlistEntry[];
/** Host-owned proof that creatorToolAllowlist reached the final executable surface. */
creatorToolAllowlistCaptureRef?: CronToolsAllowCaptureRef;
/** Attempt-cached authority resolved only when a mutation changes its tool cap. */
resolveCreatorToolAuthority?: (options?: {
signal?: AbortSignal;
}) => Promise<CronCreatorToolAuthoritySnapshot>;
/** Visible fail-closed reason when a queued local turn cannot retain fresh MCP authority. */
creatorAuthorityUnavailableReason?: "queued-local-operator-configured-mcp";
selfRemoveOnlyJobId?: string;
runId?: string;
};
//#endregion
//#region src/agents/cron-creator-authority-context.d.ts
/** Opaque in-process capability minted only by an admitted exact run. */
type CronCreatorAuthorityCapability = CronCreatorAuthorityRunScope;
//#endregion
//#region src/agents/embedded-agent-block-chunker.d.ts
/**
* Splits streamed embedded-agent replies into Markdown-safe message chunks.
*/
type BlockReplyChunking = {
minChars: number;
maxChars: number;
breakPreference?: "paragraph" | "newline" | "sentence";
/** When true, prefer \n\n paragraph boundaries once minChars has been satisfied. */
flushOnParagraph?: boolean;
};
type BlockChunkMetadata = {
sourceText: string;
sourceGeneration: number;
reconciledSourceBreak?: true;
sourceStart: number;
sourceEnd: number;
startsAtLineStart: boolean;
};
type BlockChunkDrain = {
force: boolean;
emit: (chunk: string, options?: BlockChunkMetadata) => void;
};
declare class EmbeddedBlockChunker {
#private;
constructor(chunking?: BlockReplyChunking);
/** Add streamed text to the pending chunk buffer. */
append(text: string): void;
/** Start a new source scope without emitting pending text. */
reset(sourceBreaks?: readonly number[], sourceOffset?: number): void;
/** UTF-16 source positions exclude synthetic fences and include skipped whitespace. */
get consumedLength(): number;
/** Prepared source boundaries are not evidence that a recipient received a chunk. */
get preparedSourceBreaks(): readonly number[];
get sourceLength(): number;
/** Replace pending source; the snapshot owner can attest that the consumed prefix is unchanged. */
replace(text: string, sourceOffset?: number, prefixRetained?: boolean): boolean;
/** Return the currently buffered text for tests and flush logic. */
get bufferedText(): string;
/** Return true when there is pending text to drain. */
hasBuffered(): boolean;
/** Emit safe chunks according to size and Markdown fence constraints. */
drain(params: BlockChunkDrain): void;
}
//#endregion
//#region src/agents/embedded-agent-subscribe.shared-types.d.ts
/** Rendering mode for completed tool results in subscribed replies. */
type ToolResultFormat = "markdown" | "plain";
/** Detail level for in-flight tool progress messages. */
type ToolProgressDetailMode$1 = "explain" | "raw";
type EmbeddedAgentEvent = {
stream: string;
data: Record<string, unknown> & Omit<Partial<AgentCommandOutputEventFields>, "phase" | "status"> & {
phase?: string;
status?: string;
args?: Record<string, unknown>;
summary?: string;
commandBearing?: boolean;
isError?: boolean;
};
sessionKey?: string;
};
//#endregion
//#region src/agents/sandbox/types.docker.d.ts
type RequiredDockerConfigKeys = "image" | "containerPrefix" | "workdir" | "readOnlyRoot" | "tmpfs" | "network" | "capDrop";
type SandboxDockerConfig = Omit<SandboxDockerSettings, RequiredDockerConfigKeys> & Required<Pick<SandboxDockerSettings, RequiredDockerConfigKeys>>;
//#endregion
//#region src/agents/sandbox/types.d.ts
type SandboxToolPolicy = {
allow?: string[];
deny?: string[];
};
type SandboxToolPolicySource = {
source: "agent" | "global" | "default";
/**
* Config key path hint for humans.
* (Keyed agent entries use `agents.entries.*.…` form.)
*/
key: string;
};
type SandboxToolPolicyResolved = {
allow: string[];
deny: string[];
sources: {
allow: SandboxToolPolicySource;
deny: SandboxToolPolicySource;
};
};
type SandboxWorkspaceAccess = "none" | "ro" | "rw";
/** Prepared resource ownership; only proven profiles retain cross-session workspaces. */
type SandboxIsolationSubject = {
kind: "profile";
profileId: string;
} | {
kind: "session";
sessionKey: string;
};
type SandboxBrowserConfig = {
enabled: boolean;
image: string;
containerPrefix: string;
network: string;
cdpPort: number;
cdpSourceRange?: string;
vncPort: number;
noVncPort: number;
headless: boolean;
noVncEnabled: boolean;
allowHostControl: boolean;
autoStart: boolean;
autoStartTimeoutMs: number;
binds?: string[];
};
type SandboxPruneConfig = {
idleHours: number;
maxAgeDays: number;
};
type SandboxSshConfig = {
target?: string;
command: string;
workspaceRoot: string;
strictHostKeyChecking: boolean;
updateHostKeys: boolean;
identityFile?: string;
certificateFile?: string;
knownHostsFile?: string;
identityData?: string;
certificateData?: string;
knownHostsData?: string;
};
type SandboxScope = "session" | "agent" | "shared";
type SandboxConfig = {
mode: "off" | "non-main" | "all";
backend: SandboxBackendId;
scope: SandboxScope;
workspaceAccess: SandboxWorkspaceAccess;
workspaceRoot: string;
dockerTmpfsSource: "default" | "configured";
docker: SandboxDockerConfig;
ssh: SandboxSshConfig;
browser: SandboxBrowserConfig;
tools: SandboxToolPolicy;
prune: SandboxPruneConfig;
};
type SandboxBrowserContext = {
bridgeUrl: string;
noVncUrl?: string;
containerName: string;
};
type SandboxContext = {
enabled: boolean;
/** Immutable creator policy: this session may never escape to a host execution target. */
required?: true;
/** Core-prepared execution projection; ordinary rw sandboxes retain the requested workspace. */
workspaceSource?: "managed-worktree";
/** Selected repository subdirectory within the full private projection. */
workspaceCwd?: string;
backendId: SandboxBackendId;
sessionKey: string;
workspaceDir: string;
agentWorkspaceDir: string;
skillsWorkspaceDir?: string;
skillsEligibility?: SkillEligibilityContext;
skillUsagePaths?: SkillUsagePath[];
readOnlyResourceMounts?: Array<{
hostPath: string;
containerPath: string;
}>;
workspaceAccess: SandboxWorkspaceAccess;
runtimeId: string;
runtimeLabel: string;
containerName: string;
containerWorkdir: string;
docker: SandboxDockerConfig;
tools: SandboxToolPolicy;
browserAllowHostControl: boolean;
browser?: SandboxBrowserContext;
fsBridge?: SandboxFsBridge;
backend?: SandboxBackendHandle;
};
//#endregion
//#region src/agents/sandbox/runtime-status.d.ts
type SandboxRuntimeIsolation = {
sandboxRequired: false;
isolationSubject?: never;
createdActor?: never;
workspaceAccess?: never;
} | {
sandboxRequired: true;
isolationSubject: SandboxIsolationSubject;
createdActor?: SessionCreatedActor;
workspaceAccess: SandboxWorkspaceAccess;
};
type SandboxRuntimeStatusParams = {
cfg?: OpenClawConfig;
sessionKey?: string;
agentId?: string;
/** Independent execution identity used for sandbox mode and policy classification. */
classificationSessionKey?: string;
classificationAgentId?: string;
/** Trusted canonical candidate for the classification identity; null means no stored entry. */
preparedSessionEntry?: Pick<SessionEntry$1, "sandbox" | "sandboxMode" | "createdActor"> | null;
};
/** Resolves sandbox mode, effective session scope, and tool policy for a session. */
declare function resolveSandboxRuntimeStatus(params: SandboxRuntimeStatusParams): {
agentId: string;
sessionKey: string;
classificationAgentId: string;
classificationSessionKey: string;
mainSessionKey: string;
mode: SandboxConfig["mode"];
sandboxed: boolean;
toolPolicy: SandboxToolPolicyResolved;
} & SandboxRuntimeIsolation;
//#endregion
//#region src/agents/exec-defaults.d.ts
/** Session-scoped exec fields that may be carried across an isolated runtime boundary. */
type ExecSessionDefaults = Pick<SessionEntry$1, "execHost" | "execNode" | "execCwd" | "permissionMode" | "sandbox">;
type ExecPolicyOverrides = {
host?: ExecTarget;
mode?: ExecMode;
security?: ExecSecurity;
ask?: ExecAsk;
node?: string;
};
//#endregion
//#region src/agents/harness/runtime-artifact.types.d.ts
/** Harness-owned binding to a local implementation or configured remote service. */
type AgentHarnessRuntimeArtifactBinding = Readonly<{
id: string;
fingerprint: string;
}>;
/** Runtime artifact a verified continuation must keep using. */
type ExpectedAgentHarnessRuntimeArtifact = Readonly<{
harnessId: string;
artifact: AgentHarnessRuntimeArtifactBinding;
}>;
//#endregion
//#region src/agents/embedded-agent-runner/run/auth-profile-failure-policy.types.d.ts
/**
* Scope used when classifying auth-profile failures for retry/fallback decisions.
*/
type AuthProfileFailurePolicy = "shared" | "local" | "local_transient";
//#endregion
//#region src/agents/embedded-agent-runner/run/params.d.ts
type ResolvedToolPromptFinalizer = (params: {
prompt: string;
messageToolAvailable: boolean;
}) => string;
type ReasoningStreamPayload$1 = Pick<ReplyPayload, "text" | "mediaUrls" | "isReasoning" | "isReasoningSnapshot"> & {
requiresReasoningProgressOptIn?: boolean;
};
type RunEmbeddedAgentParams = {
/** Detached runs may read session identity but never write its durable transcript or metadata. */
sessionPersistence?: "durable" | "detached";
/** Storage-neutral transcript/session target. Defaults to sessionId/sessionKey/agentId. */
sessionTarget?: AgentRunSessionTarget;
/** Provider prompt-cache affinity key; distinct from transcript/session identity. */
promptCacheKey?: string;
/** Session-like key for sandbox and tool-policy resolution. Defaults to sessionKey. */
sandboxSessionKey?: string;
/** Explicit sandbox and tool-policy owner when the policy session key is unscoped. */
sandboxAgentId?: string;
/** Out-of-band plugin bindings attached by the run initiator. */
toolBindings?: Readonly<Record<string, unknown>>;
/** Raw peer observed by the inbound routing owner, before identity linking. */
conversationRoutePeerId?: string;
/** What initiated this agent run: "user", "heartbeat", "cron", "memory", "overflow", or "manual". */
trigger?: EmbeddedRunTrigger;
/** Store-private runtime authority forwarded only by the cron execution owner. */
scheduledRuntimeAuthority?: CronRuntimeAuthority;
/** A known runtime-specific authority envelope was explicitly cleared. */
scheduledRuntimeAuthorityRecoveryRequired?: boolean;
/** Relative workspace path that memory-triggered writes are allowed to append to. */
memoryFlushWritePath?: string;
/** Sticky source-turn taint inherited by an internal maintenance run. */
initialTurnTainted?: boolean;
/** Delivery target for topic/thread routing. */
messageTo?: string;
/** Thread/topic identifier for routing replies to the originating thread. */
messageThreadId?: string | number;
/** Trusted channel-configured policy for the admitted conversation turn. */
conversationToolPolicy?: GroupToolPolicyConfig;
/** Trusted provider role ids for the requester in this group turn. */
memberRoleIds?: string[];
/** Whether workspaceDir points at the canonical agent workspace for bootstrap purposes. */
isCanonicalWorkspace?: boolean;
/** Transport-native chat/conversation ID for hook identity context. */
chatId?: string;
/** Routable target for the current conversation when it differs from the native channel ID. */
currentMessagingTarget?: string;
/** Mutable ref to track if a reply was sent (for "first" mode). */
hasRepliedRef?: {
value: boolean;
};
/** If true, omit the message tool from the tool list. */
disableMessageTool?: boolean;
swarmCollector?: boolean;
swarmOutputSchema?: Record<string, unknown>;
/** Restrict this reconstructed run to restart-safe tools. */
forceRestartSafeTools?: boolean;
/** Preserve Code Mode controls for a replay-safe restart recovery turn. */
forceCodeModeTools?: boolean;
/** Invocation-owned Code Mode activation; limits still come from config. */
codeModeOverride?: boolean | "auto";
/** Internal one-shot model probe mode: no tools, no workspace/chat prompt policy. */
modelRun?: boolean;
/** Setup can reject unavailable endpoints without spending the session retry budget. */
retryConnectionErrors?: boolean;
/** Disable trajectory persistence for auxiliary runs with no durable session owner. */
disableTrajectory?: boolean;
/** Restrict Skill Workshop to a bounded pending-proposal budget for an internal review run. */
skillWorkshopProposalOnly?: boolean;
/** Mark proposals created by this internal review as autonomous captures. */
skillWorkshopAutonomousCapture?: boolean;
skillWorkshopUpdateProposals?: boolean;
/** Preserve the foreground run as proposal provenance for an internal review run. */
skillWorkshopOrigin?: SkillProposalOrigin;
/** Run-scoped mutation budget shared across internal runner attempts. */
skillWorkshopProposalMutationBudget?: SkillWorkshopProposalMutationBudget;
/** Optional state environment for isolated Skill Workshop proposal persistence. */
skillWorkshopProposalEnv?: NodeJS.ProcessEnv;
/** Bind an operator-requested revision turn to the exact proposal revision they reviewed. */
skillWorkshopProposalRevision?: SkillWorkshopRunOptions["proposalRevision"];
skillLibraryAuthoring?: SkillWorkshopRunOptions["libraryAuthoring"];
/** Explicit system prompt mode override for trusted callers. */
promptMode?: PromptMode;
/** Keep the message tool available even when a narrow profile would omit it. */
forceMessageTool?: boolean;
/** Include the heartbeat response tool for structured heartbeat outcomes. */
enableHeartbeatTool?: boolean;
/** Keep the heartbeat response tool available even when a narrow profile would omit it. */
forceHeartbeatTool?: boolean;
/** Allow runtime plugins for this run to late-bind the gateway subagent. */
allowGatewaySubagentBinding?: boolean;
/** @deprecated Use sessionTarget plus sessionId/sessionKey/agentId for runtime identity. */
sessionFile?: string;
/** Require file tools to stay within the task workspace without changing exec policy. */
requireWorkspaceOnly?: true;
/** Refuse an enabled sandbox that would redirect a review away from its workspace. */
requireWritableSandbox?: true;
permissionMode?: SessionEntry$1["permissionMode"];
sessionRoot?: string;
/** Context supplied by internal producers, separate from inbound prompt text. */
runtimeContextFragments?: RuntimeContextFragment[];
/** Finalizes caller-owned guidance after the submitted tool surface is known. */
finalizePromptForResolvedTools?: ResolvedToolPromptFinalizer;
currentInboundContext?: CurrentInboundPromptContext;
explicitSkillSelections?: ExplicitSkillSelection[];
/** Optional client-provided tools (OpenResponses hosted tools). */
clientTools?: ClientToolDefinition[];
provider?: string;
/** Caller-owned upper bound for this run's effective context budget. */
contextTokenBudget?: number;
/** Route-bound thinking capability resolved from the selected prepared catalog row. */
modelThinkingCapability?: PreparedModelThinkingCapability;
/** Effective model fallback chain for this session attempt. Undefined uses config defaults. */
modelFallbacksOverride?: string[];
/** Prepared fallback availability fact shared by selection and failure reporting. */
modelFallbackAvailability?: ModelFallbackAvailability;
/** Session-pinned embedded harness id. Prevents runtime hot-switching. */
agentHarnessId?: string;
/** Locks the selected model against hooks and fallbacks; does not imply native model ownership. */
modelSelectionLocked?: boolean;
/** Explicit runtime override selected for this turn. Unlike agentHarnessId, this may force OpenClaw. */
agentHarnessRuntimeOverride?: string;
/** Verified setup continuation: pin both the harness and its local implementation. */
expectedAgentHarnessRuntimeArtifact?: ExpectedAgentHarnessRuntimeArtifact;
authProfileIdSource?: "auto" | "user";
/** Disable fallback from the user-selected auth profile for a verification run. */
allowAuthProfileFallback?: boolean;
verboseLevel?: VerboseLevel;
reasoningLevel?: ReasoningLevel;
toolResultFormat?: ToolResultFormat;
toolProgressDetail?: ToolProgressDetailMode$1;
/** Bootstrap context mode for workspace file injection. */
bootstrapContextMode?: "full" | "lightweight";
/** Optional tool allow-list; when set, only these tools are sent to the model. */
toolsAllow?: string[];
/** Preserve the visible tool schemas while allowing execution only for these names. */
toolExecutionAllow?: readonly string[];
/** Owner-scoped plugin tool grant; normal policy and deny rules still apply. */
runtimePluginToolGrant?: RuntimePluginToolGrant;
/** Consumed in-process subagent-completion capability; never derived from public input. */
trustedInternalHandoff?: TrustedSubagentCompletionHandoff;
/** Host-stamped exact-run capability for late Codex creator-authority capture. */
cronCreatorAuthorityCapability?: CronCreatorAuthorityCapability;
/** Ephemeral reason fresh local-operator cron authority cannot survive this queued turn. */
cronCreatorAuthorityUnavailableReason?: "queued-local-operator";
/** Canonical persisted exec policy for this session. */
execSession?: ExecSessionDefaults;
execOverrides?: Pick<ExecToolDefaults, "host" | "mode" | "security" | "ask" | "node" | "nodeCwd" | "notifyOnExit" | "notifyOnExitEmptySuccess">;
bashElevated?: ExecElevatedDefaults;
/** Trusted approved-exec runtime prompt span awaiting the resolved attempt cap. */
execApprovalContinuationPromptRange?: ExecApprovalContinuationPromptRange;
/** Corresponding span in the undecorated transcript prompt. */
execApprovalContinuationTranscriptPromptRange?: ExecApprovalContinuationPromptRange;
/** Trusted runtime-only authorization for one bounded cross-conversation recall pass. */
conversationRecall?: ConversationRecallContext;
onExecutionStarted?: (info?: {
lifecycleGeneration?: string;
}) => unknown;
onExecutionPhase?: (info: {
phase: EmbeddedAgentExecutionPhase;
provider?: string;
model?: string;
backend?: string;
source?: string;
tool?: string;
toolCallId?: string;
itemId?: string;
firstModelCallStarted?: boolean;
}) => void;
onLaneWait?: (info: {
waitMs: number;
queuedAhead: number;
waiting?: boolean;
}) => void;
onRunProgress?: (info: {
reason: string;
provider?: string;
model?: string;
backend?: string;
}) => void;
onSessionIdChanged?: (sessionId: string) => void;
shouldEmitToolResult?: () => boolean;
shouldEmitToolOutput?: () => boolean;
onAssistantMessageStart?: () => void | Promise<void>;
onBlockReplyFlush?: (context: BlockReplyFlushContext) => void | Promise<void>;
/** Source-owned final receipt/custody for this input, never mere callback or preview acceptance. */
resolveReplyDelivery?: ReplyDeliveryObserver;
blockReplyBreak?: "text_end" | "message_end";
blockReplyChunking?: BlockReplyChunking;
onReasoningStream?: (payload: ReasoningStreamPayload$1) => void | Promise<void>;
streamReasoningInNonStreamModes?: boolean;
onReasoningEnd?: () => void | Promise<void>;
onToolResult?: (payload: ReplyPayload) => void | Promise<void>;
/** Synchronous private observer for the sanitized per-tool result. */
onAgentToolResult?: (event: {
toolName: string;
result: unknown;
isError: boolean;
}) => void;
/** Reports a committed generic recovery compaction before its retry starts. */
onAutoCompactionSucceeded?: (count: number) => void;
onAgentEvent?: (evt: EmbeddedAgentEvent) => void | Promise<void>;
onToolStreamBoundary?: () => void | Promise<void>;
/**
* Emit lifecycle "finishing" when the attempt ends; the caller owns the
* final lifecycle "end" or "error" after fallback and post-turn work settle.
*/
deferTerminalLifecycle?: boolean;
/** @deprecated Use deferTerminalLifecycle. */
deferTerminalLifecycleEnd?: boolean;
enqueue?: CommandQueueEnqueueFn;
gitCoauthorPrompt?: string;
silentReplyPromptMode?: SilentReplyPromptMode;
internalEvents?: AgentInternalEvent[];
streamParams?: AgentStreamParams;
enforceFinalTag?: boolean;
silentExpected?: boolean;
/** Skip per-chunk live visible-text parsing when no live stream consumer exists (e.g. subagents). */
suppressLiveStreamOutput?: boolean;
/**
* Legacy default for callers without terminalReplyExpectation.
* An explicit required reply cannot be waived by this flag or model output.
*/
allowEmptyAssistantReplyAsSilent?: boolean;
/**
* Host-owned reply requirement for this input, independent of model output.
* Confirmed source delivery and pending custody prevent duplicate recovery.
*/
terminalReplyExpectation?: ReplyExpectation;
authProfileFailurePolicy?: AuthProfileFailurePolicy;
/**
* Use the provider's subscription CLI for one-shot helpers within plan limits.
* Direct Anthropic OAuth passthrough uses metered extra usage and fails without balance.
* `toolsAllow` bounds both backend-visible tools and server-side loopback MCP grants;
* native and non-allowlisted tools, including a disabled message tool, stay unavailable.
* Unset retains direct-API passthrough.
*/
cliBackendDispatch?: "subscription-auth";
/**
* Probe one transiently cooled profile when sibling models may still be available.
*/
allowTransientCooldownProbe?: boolean;
suppressTranscriptOnlyAssistantPersistence?: boolean;
assistantErrorTranscript?: AssistantErrorTranscript;
/** Keep an internal continuation prompt from being replaced by the original prepared turn. */
skipPreparedUserTurnMessage?: boolean;
onUserMessagePersistenceInvalidated?: () => void;
} & AgentRunClientContext & AgentRunMessageContext & AgentRunChannelContext & AgentRunModelOptions & AgentRunInputContext & AgentRunTranscriptContext & AgentRunLifecycle;
type EmbeddedForegroundPromptContext = Pick<RunEmbeddedAgentParams, "agentDir" | "sandboxAgentId" | "promptCacheKey" | "reasoningLevel" | "messageChannel" | "messageProvider" | "clientCaps" | "gatewayUiCommandTarget" | "toolBindings" | "chatType" | "agentAccountId" | "trigger" | "messageTo" | "messageThreadId" | "conversationToolPolicy" | "groupId" | "groupChannel" | "groupSpace" | "memberRoleIds" | "messageActionTurnCapability" | "spawnedBy" | "isCanonicalWorkspace" | "senderId" | "senderName" | "senderUsername" | "senderE164" | "senderIsOwner" | "approvalReviewerDeviceId" | "currentChannelId" | "chatId" | "channelContext" | "currentMessagingTarget" | "currentThreadTs" | "currentMessageId" | "currentInboundAudio" | "replyToMode" | "requireExplicitMessageTarget" | "disableMessageTool" | "conversationRecall" | "toolOverrides" | "permissionMode" | "execOverrides" | "skillsSnapshot" | "currentInboundEventKind" | "clientTools" | "disableTools" | "contextWindow" | "promptMode" | "forceMessageTool" | "enableHeartbeatTool" | "forceHeartbeatTool" | "allowGatewaySubagentBinding" | "extraSystemPrompt" | "gitCoauthorPrompt" | "sourceReplyDeliveryMode" | "taskSuggestionDeliveryMode" | "silentReplyPromptMode" | "ownerNumbers" | "toolsAllow" | "runtimePluginToolGrant" | "inputProvenance" | "scheduledToolPolicy" | "modelThinkingCapability" | "modelFallbacksOverride"> & {
/** SDK observation of the completed attempt; new runs recheck publication availability. */
githubPublicationAvailable?: boolean;
agentId: string;
workspaceDir: string;
cwd?: string;
sandboxSessionKey: string;
cronCreatorCallerOrigin?: CronScheduledToolCallerOrigin;
};
//#endregion
//#region src/agents/embedded-agent-runner/run/terminal-retry-state.d.ts
type EmbeddedRunCompletionCheck = {
unfinishedPlan: boolean;
checked: boolean;
};
//#endregion
//#region src/agents/embedded-agent-runner/run/internal-params.d.ts
type CompactionAccountingTarget = Readonly<SessionTranscriptRuntimeTarget & Pick<InternalSessionEntry, "lifecycleRevision" | "activeWriterRunId">>;
/** Ordered producer observations; unknown context never borrows an older request's usage. */
type EmbeddedContextAccountingEvent = Readonly<{
kind: "compaction";
tokensAfter: number | undefined;
} | {
kind: "model";
contextTokens: number | undefined;
successful: boolean;
}>;
/** Writer custody is independent of telemetry; an absent snapshot is not observed unknown context. */
type CompactionAccountingFact = Readonly<{
count: number;
currentContextSnapshot?: {
tokens: number | undefined;
};
} & ({
kind: "durable";
target: CompactionAccountingTarget;
/** Present only when the host committed a successor session rotation. */
previousSessionId?: string;
} | {
kind: "presentation-only";
})>;
type RunEmbeddedAgentInternalParams = RunEmbeddedAgentParams & {
/** Fail-closed caller input admission against the actual prepared model, before dispatch. */
assertModelInput?: (model: Pick<Model, "input">) => void;
/** Reset deferred terminal facts when the host admits a new attempt, before preparation. */
onAttemptStart?: () => void;
/** Keep a bounded auxiliary tool set directly visible after runtime admission. */
disableToolSearch?: true;
/** Restrict history/search to an explicitly observed session, not this run's store key. */
sessionReadScopeKey?: string;
/** Candidate producers have already resolved the model against their captured metadata. */
requestedRouteResolution?: ModelFallbackRouteResolution;
onCompactionRequestBudget?: (budget: CompactionRequestBudget | undefined) => void;
onCompactionAccounting?: (fact: CompactionAccountingFact | undefined) => void;
/** Attempt-local context observer, installed by the host loop before dispatch. */
onContextAccountingEvent?: (event: EmbeddedContextAccountingEvent) => void;
onSuccessfulAuthBinding?: (binding: AgentExecutionAuthBinding) => void;
/** Maintenance needs the winning profile, not native runtime artifact capture. */
onSuccessfulAuthProfile?: (profileId: string | undefined) => void;
authProfileStateMode?: "read-write" | "read-only";
/** Prepare only the requested candidate with this runtime; fallbacks keep their own policy. */
agentHarnessRuntimePreparationHint?: string;
/** Keep staged setup config and credentials outside configured Gateway ownership. */
preparedModelRuntimeMode?: "isolated-read-only";
/** Ring-zero tool override, supplied only by the OpenClaw orchestrator. */
systemAgentTool?: SystemAgentToolOptions;
/** Gateway-private lifecycle generation selected before command admission. */
pluginGeneration?: PreparedModelRuntimePluginGeneration;
/** Re-admit from the committed transcript without persisting the original prompt again. */
pluginRuntimeRefreshContinuation?: true;
pluginRuntimeRefreshMessages?: EmbeddedRunAttemptParams$1["pluginRuntimeRefreshMessages"];
/** Host-only transfer of attempt terminal resources to the logical turn. */
onDeferredLifecycleOwner?: (owner: DeferredEmbeddedRunLifecycleOwner) => void;
/** Aborts the logical turn when its retained embedded handle is cancelled. */
onDeferredLifecycleAbort?: (reason?: "user_abort" | "restart" | "superseded") => void;
/** Protects an admitted provider wait through the retained logical-turn owner. */
onRetryWait?: (deadlineAtMs: number, signal?: AbortSignal) => ((completed?: boolean) => void) | undefined;
};
type EmbeddedRunAttemptInternalParams = EmbeddedRunAttemptParams$1 & Pick<RunEmbeddedAgentInternalParams, "onContextAccountingEvent" | "onCompactionRequestBudget"> & {
compactionCountOwner?: "subscription" | "caller";
/** Current-run committed plan facts; retained across attempts, never loaded from history. */
completionCheck?: EmbeddedRunCompletionCheck;
};
//#endregion
//#region src/gateway/worker-environments/live-event-window.d.ts
type WorkerLiveCredentialRotation = Readonly<{
credentialHash: string;
environmentId: string;
previousCredentialHash: string;
runEpoch: number;
sessionId: string;
} & ({
newProcessTurn: true;
ackedSeq: number;
} | {
newProcessTurn?: false;
})>;
//#endregion
//#region src/gateway/worker-environments/live-events.d.ts
type WorkerLiveEventApplicationResult = {
ok: true;
result: WorkerLiveEventResult;
} | {
ok: false;
details: WorkerLiveEventErrorDetails;
};
type WorkerLiveEventReceiverOptions = {
maxActiveRuns?: number;
maxPendingBytes?: number;
maxSessions?: number;
windowSize?: number;
};
declare function createWorkerLiveEventReceiver(options?: WorkerLiveEventReceiverOptions): {
apply: (params: {
identity: WorkerConnectionIdentity;
request: WorkerLiveEventParams;
source: WorkerTurnTranscriptSource;
readAckedSeq: () => number;
}) => Promise<WorkerLiveEventApplicationResult>;
clear: () => void;
clearEnvironment: (environmentId: string, ownerEpoch: number) => void;
rotateCredential: (rotation: WorkerLiveCredentialRotation) => boolean;
};
type WorkerLiveEventReceiver = ReturnType<typeof createWorkerLiveEventReceiver>;
//#endregion
//#region src/gateway/worker-environments/placement-worker-gate.d.ts
type WorkerPlacementBinding = Readonly<{
sessionId: string;
environmentId: string;
ownerEpoch: number;
}>;
type WorkerSessionPlacementGate = {
fenceWorkerTurnForRecovery: (claim: WorkerSessionTurnClaim) => void;
/** Refresh runtime bytes without changing the retained workspace's owner epoch. */
prepareWorkerRuntimeRefresh(binding: WorkerPlacementBinding): Promise<{
generation: number;
reclaimResult?: WorkerWorkspacePendingResult;
assertCurrent: () => void;
release: () => void;
}>;
/** Credential verification only; this does not grant operational worker authority. */
readWorkerTurnClaim(binding: WorkerPlacementBinding): WorkerSessionTurnClaim | undefined;
getExecutionIdentityCapability?(claim: WorkerSessionTurnClaim): WorkerTurnExecutionIdentityCapability | undefined;
readWorkerTurnLiveAckCursor(claim: WorkerSessionTurnClaim): number;
validateWorkerTurn(claim: WorkerSessionTurnClaim): boolean;
isWorkerTurnToolAuthorized(claim: WorkerSessionTurnClaim, toolName: string): boolean;
updateAckCursors(input: {
claim: WorkerSessionTurnClaim;
transcriptSeq?: number;
liveSeq?: number;
}): void;
prepareWorkspaceResultOwnerRevocation(binding: WorkerPlacementBinding, error: Error): void;
registerTurnClaimClosedHandler(handler: (claim: WorkerSessionTurnClaim) => void): () => void;
};
//#endregion
//#region src/gateway/worker-environments/ssh.d.ts
type WorkerSshIdentityResolver = (keyRef: WorkerSshEndpoint["keyRef"], context: {
assertCurrent: () => void;
}) => Promise<WorkerSshIdentity>;
//#endregion
//#region src/gateway/worker-environments/tunnel-ssh-runner.d.ts
type WorkerSshProcessExit = {
code: number | null;
signal: NodeJS.Signals | null;
stderrTail?: string;
};
type WorkerSshProcess = {
ready: Promise<void>;
exited: Promise<WorkerSshProcessExit>;
stop(): Promise<void>;
};
type WorkerSshRunner = {
start(argv: string[], options: CommandOptions): WorkerSshProcess;
run(argv: string[], options: CommandOptions): Promise<SpawnResult>;
};
//#endregion
//#region src/gateway/worker-environments/tunnel.d.ts
type WorkerTunnelStartRequest = WorkerTunnelRequest & {
bundleHash: string;
ssh: WorkerSshEndpoint;
sharedHost?: boolean;
resolveIdentity: WorkerSshIdentityResolver;
};
type WorkerTunnelManagerOptions = {
runner?: WorkerSshRunner;
desktopSessionRegistry?: DesktopSessionRegistry;
};
/** Owns SSH workspace state for remote-exec environments and fences replacement epochs. */
declare function createWorkerTunnelManager(options?: WorkerTunnelManagerOptions): {
desktop: {
acquire: (request: {
environmentId: string;
ownerEpoch: number;
ssh: WorkerSshEndpoint;
desktop: WorkerDesktopEndpoint;
resolveIdentity: WorkerSshIdentityResolver;
}) => Promise<{
attachment: DesktopRfbAttachment;
auth?: "vnc-password" | "ard-account";
vncPassword?: string;
resolveAudio?: () => DesktopAudioSource | undefined;
readonly audioUnavailableReason?: string;
}>;
attachObserver: (sourceKey: string, observer: {
control: boolean;
operatorName?: string;
ownerEpoch: number;
close(code: number, reason: string): void;
}) => {
release(): void;
} | undefined;
launchApp: (request: {
environmentId: string;
ownerEpoch: number;
ssh: WorkerSshEndpoint;
app: WorkerDesktopApp;
resolveIdentity: WorkerSshIdentityResolver;
}) => Promise<void>;
stop: (environmentId: string, ownerEpoch?: number) => Promise<void>;
stopAll: () => Promise<void>;
};
start: (request: WorkerTunnelStartRequest) => Promise<WorkerTunnelHandle>;
stop: (environmentId: string, ownerEpoch?: number) => Promise<void>;
stopAll: () => Promise<void>;
status(environmentId: string): WorkerTunnelStatus;
};
type WorkerTunnelManager = ReturnType<typeof createWorkerTunnelManager>;
//#endregion
//#region src/worker/node-bundle-install-protocol.d.ts
type NodeWorkerBundleInstallResult = WorkerAdmissionHandshake;
//#endregion
//#region src/infra/node-commands.d.ts
declare const NODE_WORKER_PRIVATE_COMMANDS: readonly ["worker.bundle.install.v1", "worker.launch.v1", "worker.status.v1", "worker.cancel.v1", "worker.environment.stop.v1", "worker.workspace.exec.v1", "worker.workspace.prepare.v1", "worker.workspace.retain.v1", "worker.desktop.stream.v1", "worker.desktop.launch.v1", "worker.desktop.computer.v1", "worker.portal.stream.v1"];
//#endregion
//#region src/infra/node-runner-inventory.d.ts
declare const NODE_WORKER_SUPERVISOR_PROTOCOL_FEATURE = "node-worker-supervisor-v6";
declare const NODE_RUNNER_UPDATE_REQUIRED_ISSUE: {
readonly code: "update-required";
readonly action: "update-and-reconnect";
readonly updateCommand: "openclaw update";
readonly headlessReconnectCommand: "openclaw node restart";
};
type NodeRunnerInventoryIssue = typeof NODE_RUNNER_UPDATE_REQUIRED_ISSUE | {
code: "worker-host-unavailable";
message: string;
};
declare const WorkerHost: z.ZodPipe<z.ZodUnion<readonly [z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
enabled: z.ZodLiteral<false>;
reason: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>, z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
enabled: z.ZodLiteral<true>;
capacity: z.ZodTransform<{
total: number;
available: number;
reclaimableIdle?: number | undefined;
}, unknown>;
bundlePrewarm: z.ZodOptional<z.ZodLiteral<1>>;
bundleRetention: z.ZodOptional<z.ZodLiteral<1>>;
bundleStatus: z.ZodOptional<z.ZodLiteral<1>>;
portalStream: z.ZodOptional<z.ZodLiteral<1>>;
environmentSession: z.ZodOptional<z.ZodLiteral<1>>;
statusWait: z.ZodOptional<z.ZodLiteral<1>>;
preparedWorkspace: z.ZodOptional<z.ZodLiteral<1>>;
capturedExecPolicy: z.ZodOptional<z.ZodLiteral<true>>;
launchToolNames: z.ZodOptional<z.ZodPipe<z.ZodArray<z.ZodString>, z.ZodTransform<readonly ("apply_patch" | "browser" | "computer" | "edit" | "exec" | "portal" | "presence" | "process" | "read" | "sessions_send" | "sessions_spawn" | "skill_workshop" | "write")[], string[]>>>;
idleRetention: z.ZodOptional<z.ZodLiteral<true>>;
}, z.core.$strip>>]>, z.ZodTransform<{
enabled: false;
reason?: string | undefined;
} | {
enabled: true;
capacity: {
total: number;
available: number;
reclaimableIdle?: number | undefined;
};
bundlePrewarm?: 1 | undefined;
bundleRetention?: 1 | undefined;
bundleStatus?: 1 | undefined;
portalStream?: 1 | undefined;
environmentSession?: 1 | undefined;
statusWait?: 1 | undefined;
preparedWorkspace?: 1 | undefined;
capturedExecPolicy?: true | undefined;
launchToolNames?: readonly ("apply_patch" | "browser" | "computer" | "edit" | "exec" | "portal" | "presence" | "process" | "read" | "sessions_send" | "sessions_spawn" | "skill_workshop" | "write")[] | undefined;
idleRetention?: true | undefined;
}, {
enabled: false;
reason?: string | undefined;
} | {
enabled: true;
capacity: {
total: number;
available: number;
reclaimableIdle?: number | undefined;
};
bundlePrewarm?: 1 | undefined;
bundleRetention?: 1 | undefined;
bundleStatus?: 1 | undefined;
portalStream?: 1 | undefined;
environmentSession?: 1 | undefined;
statusWait?: 1 | undefined;
preparedWorkspace?: 1 | undefined;
capturedExecPolicy?: true | undefined;
launchToolNames?: readonly ("apply_patch" | "browser" | "computer" | "edit" | "exec" | "portal" | "presence" | "process" | "read" | "sessions_send" | "sessions_spawn" | "skill_workshop" | "write")[] | undefined;
idleRetention?: true | undefined;
}>>;
type NodeWorkerHostDeclaration = z.infer<typeof WorkerHost>;
//#endregion
//#region src/gateway/node-invoke.types.d.ts
type NodeInvokeParams = {
nodeId: string;
expectedConnId?: string;
expectedPairingGeneration?: string;
command: string;
params?: unknown;
timeoutMs?: number;
/** Process-local monotonic deadline inherited from invocation admission. */
deadlineAtMs?: number;
/** Inactivity deadline reset by each ordered progress chunk. */
idleTimeoutMs?: number;
onProgress?: (chunk: string) => void;
signal?: AbortSignal;
idempotencyKey?: string;
sessionKey?: string;
/** Receives the id and armed hard deadline after a successful dispatch. */
onDispatchReady?: (invokeId: string, deadlineAtMs?: number) => void;
/** Revalidates caller authority at the registry-owned transport handoff. */
isDispatchAuthorized?: () => boolean;
};
/** Result payload returned from node.invoke. */
type NodeInvokeResult = {
ok: boolean;
payload?: unknown;
payloadJSON?: string | null;
error?: {
code?: string;
message?: string;
} | null;
};
//#endregion
//#region src/process/gateway-work-admission.d.ts
type GatewayRootWorkAdmissionContinuationScope = {
release: () => void;
run: <T>(run: () => Promise<T>) => Promise<T>;
/** Synchronous producers transfer accepted work to its own drain before returning. */
runSync: <T>(run: () => T) => T;
};
//#endregion
//#region src/gateway/node-registry.invoke-stream.d.ts
type NodeInvokeProgressParams = {
invokeId: string;
nodeId: string;
connId: string | undefined;
seq: number;
chunk: string;
};
type NodeInvokeResultParams = {
id: string;
nodeId: string;
connId: string | undefined;
ok: boolean;
payload?: unknown;
payloadJSON?: string | null;
error?: {
code?: string;
message?: string;
} | null;
};
//#endregion
//#region src/gateway/node-runner-inventory-runtime.d.ts
type NodeWorkerHostClientId = typeof GATEWAY_CLIENT_IDS.NODE_HOST | typeof GATEWAY_CLIENT_IDS.MACOS_APP;
type NodeWorkerBundleStatusObservation = {
bundleHash: string;
status: NodeWorkerBundleStatus;
};
type NodeWorkerSupervisorNodeProof = {
nodeId: string;
connId: string;
pairingIdentity: string;
pairingGeneration: string;
clientId: NodeWorkerHostClientId;
clientMode: "node";
protocolFeature: typeof NODE_WORKER_SUPERVISOR_PROTOCOL_FEATURE;
workerHost: Extract<NodeWorkerHostDeclaration, {
enabled: true;
}>;
commands: readonly string[];
};
//#endregion
//#region src/gateway/node-registry-private.d.ts
type NodeWorkerPrivateCommand = (typeof NODE_WORKER_PRIVATE_COMMANDS)[number];
type NodeWorkerSupervisorTransport = {
getCurrentNode(nodeId: string): Promise<NodeWorkerSupervisorNodeProof | undefined>;
listCurrentNodes(): Promise<readonly NodeWorkerSupervisorNodeProof[]>;
hasCurrentRunner(nodeId: string): boolean;
/** Diagnostic connection presence, independent of session-host eligibility. */
isConnected?(nodeId: string): boolean;
getIssue?(nodeId: string): NodeRunnerInventoryIssue | undefined;
getBundleStatus?(nodeId: string): NodeWorkerBundleStatusObservation | undefined;
acceptBundleStatus?(node: NodeWorkerSupervisorNodeProof, observation: NodeWorkerBundleStatusObservation | undefined): boolean;
isCurrent(node: NodeWorkerSupervisorNodeProof, requireLaunchEligibility?: boolean, requiredCommands?: readonly string[], requireCapturedExecPolicy?: boolean): boolean;
invoke(params: {
node: NodeWorkerSupervisorNodeProof;
command: NodeWorkerPrivateCommand;
params?: unknown;
timeoutMs?: number;
signal?: AbortSignal;
idempotencyKey?: string;
isDispatchAuthorized: () => boolean;
onDispatchReady?: (invokeId: string) => void;
}): Promise<NodeInvokeResult>;
};
//#endregion
//#region src/gateway/worker-environments/node-worker-bundle-installer.d.ts
type GatewayNodeWorkerBundleInstall = (params: {
deviceId: string;
environmentId: string;
artifact: Extract<WorkerInstallationArtifact, {
install: "bundle";
}>;
prewarm: boolean;
reason: "provision" | "refresh";
signal?: AbortSignal;
assertCurrent?: () => void;
onProgress?: () => void;
}) => Promise<NodeWorkerBundleInstallResult>;
//#endregion
//#region src/gateway/worker-environments/repository-project-source.d.ts
declare const RepositoryProject: z.ZodObject<{
key: z.ZodString;
baseCommit: z.ZodString;
source: z.ZodObject<{
kind: z.ZodLiteral<"repository">;
url: z.ZodString;
repositoryId: z.ZodString;
owner: z.ZodObject<{
agent: z.ZodObject<{
agentId: z.ZodString;
provenance: z.ZodNullable<z.ZodObject<{
agentId: z.ZodString;
createdVia: z.ZodEnum<{
agent: "agent";
claw: "claw";
operator: "operator";
}>;
creatorAgentId: z.ZodNullable<z.ZodString>;
createdAtMs: z.ZodNumber;
}, z.core.$strict>>;
}, z.core.$strict>;
identity: z.ZodDiscriminatedUnion<[z.ZodObject<{
source: z.ZodLiteral<"anonymous">;
}, z.core.$strict>, z.ZodObject<{
source: z.ZodLiteral<"system-detected">;
accountId: z.ZodNumber;
}, z.core.$strict>, z.ZodObject<{
source: z.ZodLiteral<"system-configured">;
profileId: z.ZodString;
accountId: z.ZodNumber;
}, z.core.$strict>, z.ZodObject<{
source: z.ZodLiteral<"agent-override">;
profileId: z.ZodString;
accountId: z.ZodNumber;
}, z.core.$strict>], "source">;
}, z.core.$strict>;
}, z.core.$strict>;
}, z.core.$strip>;
type RepositoryWorkerProjectSnapshot = z.infer<typeof RepositoryProject>;
//#endregion
//#region src/gateway/worker-environments/workspace-git-base.d.ts
type WorkerLocalProjectSnapshot = {
key: string;
root: string;
baseCommit: string;
label?: string;
};
type WorkerProjectSnapshot = WorkerLocalProjectSnapshot | RepositoryWorkerProjectSnapshot;
//#endregion
//#region src/gateway/worker-environments/preparation-identity.d.ts
declare const Artifacts: z.ZodObject<{
nodeBootstrapSha256: z.ZodString;
enabledPluginIds: z.ZodArray<z.ZodString>;
workerBundleHash: z.ZodString;
workerArchiveSha256: z.ZodString;
openclawVersion: z.ZodString;
protocolFeatures: z.ZodArray<z.ZodString>;
}, z.core.$strict>;
type WorkerPreparationArtifacts = z.infer<typeof Artifacts>;
type WorkerProviderPreparedIntent = {
providerId: string;
profileSnapshot: WorkerProfile;
preparationKey?: string;
};
//#endregion
//#region src/gateway/worker-environments/project-preparation.d.ts
type ProjectPreparation = NonNullable<NonNullable<Parameters<WorkerProvider$1["provision"]>[2]>["project"]>;
type PreparationResult = Awaited<ReturnType<ProjectPreparation["prepare"]>>;
declare function createWorkerProjectPreparation(params: {
project: WorkerProjectSnapshot;
namespace: string;
preparation?: {
key: string;
cacheKey: string;
purpose: "session" | "reserve";
demandAtMs: number;
setupRecipe?: string;
runSetupScript?: boolean;
};
setupAuthorized?: boolean;
revalidateRepositorySource?: (signal: AbortSignal) => Promise<void>;
prepareRepositoryGitPack?: (input: {
temporaryRoot: string;
signal: AbortSignal;
}) => Promise<string>;
requireCurrent: () => void;
signal?: AbortSignal;
}): {
project: ProjectPreparation;
getPreparedWorkspace: () => PreparationResult["preparedWorkspace"];
close: () => void;
};
//#endregion
//#region src/gateway/worker-environments/provider-lifecycle.types.d.ts
type WorkerEnvironmentAbandonment = {
sessionId: string;
ownerEpoch: number;
authorize?: () => void;
};
type WorkerProviderLifecycleInputOptions = {
store: WorkerEnvironmentStore;
getConfig: () => OpenClawConfig;
resolveProvider: (providerId: string) => WorkerProvider$1 | undefined;
prepareInstallation: (install: WorkerInstallationArtifact["install"]) => Promise<WorkerInstallationArtifact>;
bootstrapWorker: (params: {
operationId: string;
sshEndpoint: WorkerSshEndpoint;
installation: WorkerInstallationArtifact;
resolveIdentity: WorkerSshIdentityResolver;
signal: AbortSignal;
assertCurrent?: () => void;
}) => Promise<WorkerAdmissionHandshake>;
resolveSshIdentity?: (params: {
provider: WorkerProvider$1;
leaseId: string;
profile: WorkerProfile;
keyRef: SecretRef;
assertAuthorized: () => void;
}) => Promise<WorkerSshIdentity>;
ensureNodeWorkerBundle?: GatewayNodeWorkerBundleInstall;
prepareNodeBootstrap?: (record: WorkerEnvironmentRecord, signal?: AbortSignal) => Promise<string>;
prepareNodeRuntime?: (record: WorkerEnvironmentRecord, bundle: Extract<WorkerInstallationArtifact, {
install: "bundle";
}>, signal?: AbortSignal) => Promise<WorkerNodeRuntimePreparation>;
closeNodeRuntime?: (preparation: WorkerNodeRuntimePreparation) => void;
prepareNodeArtifacts?: (profileSnapshot: WorkerProfile, signal?: AbortSignal) => Promise<{
artifacts: WorkerPreparationArtifacts;
assertCurrent: () => void;
}>;
registerPreparedWorkspace?: (params: {
record: WorkerEnvironmentRecord;
deviceId: string;
workspace: NonNullable<ReturnType<ReturnType<typeof createWorkerProjectPreparation>["getPreparedWorkspace"]>>;
assertCurrent: () => void;
signal?: AbortSignal;
}) => Promise<void>;
bindPreparedWorkspace?: (params: {
environmentId: string;
ownerEpoch: number;
sessionId: string;
sessionKey: string;
preparationKey: string;
cacheKey: string;
signal?: AbortSignal;
assertCurrent: () => void;
}) => Promise<NodeWorkerPreparedWorkspaceResult>;
prepareNodeEnrollment?: (record: WorkerEnvironmentRecord, signal?: AbortSignal) => Promise<WorkerNodeEnrollment>;
closeNodeEnrollment?: (enrollment: WorkerNodeEnrollment) => void;
retireNodeEnrollment?: (record: WorkerEnvironmentRecord) => Promise<void>;
projectNamespace?: string;
placementStore?: WorkerSessionPlacementGate;
providerCallTimeoutMs?: number;
now?: () => number;
};
//#endregion
//#region src/gateway/worker-environments/provider-runtime-refresh.d.ts
type WorkerRuntimeRefreshInFlight = {
/** Settles after the refresh finishes or fails; never rejects. */
readonly settled: Promise<void>;
/** Observe real install progress until the returned function unsubscribes. */
onProgress(listener: () => void): () => void;
};
//#endregion
//#region src/gateway/worker-environments/transcript-commit-store.d.ts
type WorkerTranscriptCommitOutcome = {
ok: true;
result: WorkerTranscriptCommitResult;
} | {
ok: false;
reason: WorkerTranscriptCommitErrorReason;
};
//#endregion
//#region packages/gateway-protocol/src/schema/worker-skill-workshop.d.ts
declare const WorkerSkillWorkshopParamsSchema: Type$1.TObject<{
toolCallId: Type$1.TString;
arguments: Type$1.TObject<{
action: Type$1.TEnum<["list", "read", "create", "update", "share", "unshare", "transfer", "activate", "remove", "rollback"]>;
target: Type$1.TOptional<Type$1.TLiteral<"personal">>;
skill_id: Type$1.TOptional<Type$1.TString>;
expected_revision: Type$1.TOptional<Type$1.TString>;
revision: Type$1.TOptional<Type$1.TString>;
name: Type$1.TOptional<Type$1.TString>;
proposal_content: Type$1.TOptional<Type$1.TString>;
artifact_path: Type$1.TOptional<Type$1.TString>;
files: Type$1.TOptional<Type$1.TArray<Type$1.TObject<{
path: Type$1.TString;
encoding: Type$1.TOptional<Type$1.TUnion<[Type$1.TLiteral<"utf8">, Type$1.TLiteral<"base64">]>>;
executable: Type$1.TOptional<Type$1.TBoolean>;
content: Type$1.TString;
}>>>;
delete_files: Type$1.TOptional<Type$1.TArray<Type$1.TString>>;
}>;
}>;
type WorkerSkillWorkshopParams = Static<typeof WorkerSkillWorkshopParamsSchema>;
//#endregion
//#region src/gateway/worker-environments/worker-session-tool-result.d.ts
type WorkerSessionToolRequest = {
identity: WorkerConnectionIdentity;
signal?: AbortSignal;
} & ({
toolName: "sessions_spawn";
request: WorkerSessionsSpawnParams;
} | {
toolName: "sessions_send";
request: WorkerSessionsSendParams;
} | {
toolName: "portal";
request: WorkerPortalParams;
} | {
toolName: "presence";
request: WorkerPresenceParams;
} | {
toolName: "skill_workshop";
request: WorkerSkillWorkshopParams;
});
type WorkerSessionToolExecutor = (request: WorkerSessionToolRequest) => Promise<WorkerSessionToolResult>;
//#endregion
//#region src/gateway/worker-environments/inference-store.kernel.d.ts
type WorkerInferenceTurnInput = {
environmentId: string;
sessionId: string;
runEpoch: number;
runId: string;
turnId: string;
requestHash: string;
};
type WorkerInferenceTurnBeginResult = {
kind: "claimed";
} | {
kind: "recover";
} | {
kind: "replay";
outcome: WorkerInferenceTerminalOutcome;
} | {
kind: "rejected";
reason: "conflict";
};
type WorkerInferenceRetentionPolicy = {
maxAgeMs: number;
maxRows: number;
maxBytes: number;
};
/** The shared-state worker supplies the already-admitted transaction connection. */
declare function createWorkerInferenceStoreKernel(options: {
db: DatabaseSync;
now: () => number;
retention?: Partial<WorkerInferenceRetentionPolicy>;
}): {
begin: (rawInput: WorkerInferenceTurnInput) => WorkerInferenceTurnBeginResult;
cancelPending: (params: {
environmentId: string;
sessionId: string;
runEpoch: number;
runId: string;
turnId: string;
outcome: WorkerInferenceTerminalOutcome;
}) => void;
complete: (rawInput: WorkerInferenceTurnInput & {
outcome: WorkerInferenceTerminalOutcome;
}) => WorkerInferenceTerminalOutcome;
recoverPending: (outcome: WorkerInferenceTerminalOutcome) => void;
};
//#endregion
//#region src/gateway/worker-environments/inference-store.d.ts
type Kernel = ReturnType<typeof createWorkerInferenceStoreKernel>;
declare function createWorkerInferenceStore(options?: {
path?: string;
env?: NodeJS.ProcessEnv;
now?: () => number;
retention?: Partial<WorkerInferenceRetentionPolicy>;
}): {
begin: (input: Parameters<Kernel["begin"]>[0], assertCurrent?: () => void) => Promise<{
kind: "claimed";
} | {
kind: "recover";
} | {
kind: "replay";
outcome: WorkerInferenceTerminalOutcome;
} | {
kind: "rejected";
reason: "conflict";
}>;
complete: (input: Parameters<Kernel["complete"]>[0], assertCurrent?: () => void) => Promise<{
readonly type: "done";
readonly message: {
readonly role: "assistant";
readonly content: ({
readonly type: "text";
readonly text: string;
readonly textSignature?: string | undefined;
} | {
readonly type: "thinking";
readonly thinking: string;
readonly thinkingSignature?: string | undefined;
readonly redacted?: boolean | undefined;
} | {
readonly type: "toolCall";
readonly id: string;
readonly name: string;
readonly arguments: Record<string, unknown>;
readonly thoughtSignature?: string | undefined;
readonly executionMode?: "parallel" | "sequential" | undefined;
})[];
readonly api: string;
readonly provider: string;
readonly model: string;
readonly responseModel?: string | undefined;
readonly responseId?: string | undefined;
readonly providerReplay?: {
v: 1;
type: string;
id?: string | undefined;
data: string;
replayIndex?: number | undefined;
provider: string;
api: string;
model: string;
baseUrlHash?: string | undefined;
sessionHash?: string | undefined;
authProfileHash?: string | undefined;
} | undefined;
readonly usage: {
input: number;
output: number;
cacheRead: number;
cacheWrite: number;
contextUsage?: {
state: "available";
promptTokens: number;
totalTokens: number;
} | {
state: "unavailable";
} | undefined;
totalTokens: number;
cost: {
input: number;
output: number;
cacheRead: number;
cacheWrite: number;
total: number;
totalOrigin?: "provider-billed" | undefined;
};
};
readonly timestamp: number;
readonly stopReason: "length" | "stop" | "toolUse";
};
} | {
readonly type: "error";
readonly reason: "cancelled" | "epoch-mismatch" | "invalid-context" | "model-not-approved" | "provider-error" | "session-not-attached";
readonly message: string;
readonly usage?: {
input: number;
output: number;
cacheRead: number;
cacheWrite: number;
contextUsage?: {
state: "available";
promptTokens: number;
totalTokens: number;
} | {
state: "unavailable";
} | undefined;
totalTokens: number;
cost: {
input: number;
output: number;
cacheRead: number;
cacheWrite: number;
total: number;
totalOrigin?: "provider-billed" | undefined;
};
} | undefined;
}>;
cancelPending: (input: Parameters<Kernel["cancelPending"]>[0], assertCurrent?: () => void) => Promise<void>;
recoverPending: (input: Parameters<Kernel["recoverPending"]>[0], assertCurrent?: () => void) => Promise<void>;
};
type WorkerInferenceStore = ReturnType<typeof createWorkerInferenceStore>;
//#endregion
//#region src/gateway/worker-environments/inference.types.d.ts
type WorkerInferenceFenceReason = Extract<WorkerInferenceErrorReason, "epoch-mismatch" | "session-not-attached">;
type WorkerInferenceSink = {
connectionId: string;
send(frame: WorkerInferenceEventFrame | WorkerInferenceTerminalFrame): void;
};
type WorkerInferenceExecutor = (params: {
identity: WorkerConnectionIdentity;
request: WorkerInferenceStartParams;
signal: AbortSignal;
emit: (event: WorkerInferenceEventParams["event"]) => void;
isCurrent(): boolean;
sessionTarget: BoundAgentRunSessionTarget;
config?: OpenClawConfig;
}) => Promise<WorkerInferenceTerminalOutcome>;
type RevalidateInference = () => WorkerInferenceFenceReason | null;
type WorkerInferenceStartApplicationResult = {
ok: true;
result: WorkerInferenceStartResult;
launch(): void;
} | {
ok: false;
reason: WorkerInferenceErrorReason;
};
type WorkerInferenceCancelApplicationResult = {
ok: true;
result: WorkerInferenceCancelResult;
} | {
ok: false;
reason: WorkerInferenceErrorReason;
};
type WorkerInferenceManagerOptions = {
execute: WorkerInferenceExecutor;
store?: WorkerInferenceStore;
getConfig?: () => OpenClawConfig;
requestMaxBytes?: number;
streamMaxBytes?: number;
};
//#endregion
//#region src/gateway/worker-environments/worker-turn-computer-rpc.d.ts
type WorkerComputerExecutor = (params: {
identity: WorkerConnectionIdentity;
request: WorkerComputerParams;
signal?: AbortSignal;
assertCurrent: () => void;
}) => Promise<WorkerComputerResult>;
//#endregion
//#region src/shared/device-bootstrap-profile.d.ts
/** Closed purpose codes carried by specialized bootstrap tokens. */
type DeviceBootstrapPurpose = "control-ui" | "control-ui-owner" | "mobile-full" | "voice-node" | "cloud-worker";
/** Normalized roles/scopes carried by a bootstrap token during device handoff. */
type DeviceBootstrapProfile = {
roles: string[];
scopes: string[];
purpose?: DeviceBootstrapPurpose;
};
/** Caller-provided bootstrap profile before role/scope normalization and bounding. */
type DeviceBootstrapProfileInput = {
roles?: readonly string[];
scopes?: readonly string[];
purpose?: DeviceBootstrapPurpose;
};
type PairingSetupAccess = "full" | "limited" | "node";
/** Operator scopes allowed to cross the short-lived bootstrap handoff boundary. */
declare const BOOTSTRAP_HANDOFF_OPERATOR_SCOPES: readonly ["operator.approvals", "operator.questions", "operator.read", "operator.talk.secrets", "operator.write"];
/** Existing least-privilege setup-code/QR profile. */
declare const PAIRING_SETUP_BOOTSTRAP_PROFILE: DeviceBootstrapProfile;
/** Normalize caller-provided bootstrap roles/scopes without applying handoff bounds. */
declare function normalizeDeviceBootstrapProfile(input: DeviceBootstrapProfileInput | undefined): DeviceBootstrapProfile;
//#endregion
//#region src/infra/device-pairing.types.d.ts
/** Pending device pairing request awaiting owner approval. */
type DevicePairingPendingRequest = {
requestId: string;
deviceId: string;
publicKey: string;
displayName?: string;
platform?: string;
deviceFamily?: string;
clientId?: string;
clientMode?: string;
browserOrigin?: string;
role?: string;
roles?: string[];
scopes?: string[];
remoteIp?: string;
silent?: boolean;
isRepair?: boolean;
ts: number;
};
/** Bearer token issued to one paired device role. */
type DeviceAuthToken = {
token: string;
role: string;
scopes: string[];
issuer?: {
kind: "shared-gateway-auth";
generation: string;
};
createdAtMs: number;
rotatedAtMs?: number;
revokedAtMs?: number;
lastUsedAtMs?: number;
};
/**
* How the latest pairing approval was granted. "silent" is a same-host local
* policy approval and the only prune-eligible kind: local clients re-pair
* silently and cannot collide with another machine's records. "trusted-cidr"
* and "ssh-verified" are also non-interactive but cross hosts, so they are
* never pruned automatically (display metadata is not a machine identity).
* "trusted-proxy" records were approved from an authenticated proxy identity.
* "owner" and "bootstrap" approvals required a user action. None of these
* cross-host or interactive approval kinds are pruned automatically.
*/
type PairedDeviceApprovalKind = "owner" | "silent" | "trusted-cidr" | "trusted-proxy" | "ssh-verified" | "bootstrap";
/**
* Approved node capability surface for a node-role device. Device pairing
* grants connection auth; this grants command/capability exposure (node
* command gating). displayName here is the operator-facing node name set at
* approval or via node.rename; it must not be clobbered by reconnect
* metadata refreshes, which is why it lives apart from the device fields.
*/
type PairedDeviceNodeSurface = {
displayName?: string;
version?: string;
coreVersion?: string;
uiVersion?: string;
modelIdentifier?: string;
caps?: string[];
commands?: string[];
permissions?: Record<string, boolean>;
bins?: string[];
/** Last current-generation runner publication explicitly enabled session hosting. */
sessionHost?: boolean;
createdAtMs: number;
approvedAtMs: number;
lastConnectedAtMs?: number;
lastDisconnectedAtMs?: number;
lastHostStats?: NodeHostStats;
};
/**
* Pending node-surface approval awaiting an operator decision (one per
* device). Carries its own metadata snapshot so approval UIs can show what
* the node declared at request time. `revision` guards the reconnect-vs-
* approve race: reconnect cleanup only deletes the revision it observed, so
* a refreshed request survives concurrent approval flows.
*/
type PairedDevicePendingNodeSurface = {
requestId: string;
revision: string;
displayName?: string;
platform?: string;
version?: string;
coreVersion?: string;
uiVersion?: string;
clientId?: string;
clientMode?: string;
deviceFamily?: string;
modelIdentifier?: string;
caps?: string[];
commands?: string[];
permissions?: Record<string, boolean>;
remoteIp?: string;
silent?: boolean;
ts: number;
};
/** Persisted approved device record, including durable approval and active role tokens. */
type PairedDevice = {
deviceId: string;
publicKey: string;
displayName?: string;
operatorLabel?: string;
platform?: string;
deviceFamily?: string;
clientId?: string;
clientMode?: string;
browserOrigin?: string;
role?: string;
roles?: string[];
scopes?: string[];
approvedScopes?: string[];
remoteIp?: string;
tokens?: Record<string, DeviceAuthToken>;
approvedVia?: PairedDeviceApprovalKind;
nodeSurface?: PairedDeviceNodeSurface;
pendingNodeSurface?: PairedDevicePendingNodeSurface;
createdAtMs: number;
approvedAtMs: number;
lastSeenAtMs?: number;
lastSeenReason?: string;
};
/** Persisted bootstrap token state, including binding and role/scope redemption progress. */
type DeviceBootstrapTokenRecord = {
token: string;
setupId?: string;
ts: number;
deviceId?: string;
publicKey?: string;
profile?: DeviceBootstrapProfile;
redeemedProfile?: DeviceBootstrapProfile;
pendingProfile?: DeviceBootstrapProfile;
issuedAtMs: number;
lastUsedAtMs?: number;
};
/**
* Durable terminal outcome for one setup credential. Redemption deletes the
* bootstrap row, so this record is what lets a presenting client answer
* "did my setup code succeed?" without having received the broadcast.
*/
type DevicePairSetupCompletionRecord = {
setupId: string;
deviceId: string;
deviceName?: string;
access: PairingSetupAccess;
completedAtMs: number;
deliveryState: "uncertain" | "confirmed";
retainUntilMs: number;
};
//#endregion
//#region src/infra/device-bootstrap.worker-types.d.ts
type DeviceBootstrapBoundContextInput = {
token: string;
deviceId: string;
publicKey: string;
nowMs: number;
};
type DeviceBootstrapOperations = {
"bootstrap.issue": {
input: {
profile: DeviceBootstrapProfile;
setupId?: string;
nowMs: number;
};
output: {
token: string;
expiresAtMs: number;
};
};
"bootstrap.ensure": {
input: {
profile: DeviceBootstrapProfileInput;
setupId: string;
nowMs: number;
};
output: {
status: "pending";
token: string;
expiresAtMs: number;
setupId: string;
} | {
status: "completed";
setupId: string;
deviceId: string;
};
};
"bootstrap.consume": {
input: {
token: string;
deviceId: string;
completedAtMs: number;
nowMs: number;
};
output: {
record: DeviceBootstrapTokenRecord;
completion?: DevicePairSetupCompletionRecord;
} | null;
};
"bootstrap.confirm": {
input: {
setupId: string;
deviceId: string;
nowMs: number;
};
output: DevicePairSetupCompletionRecord | null;
};
"bootstrap.readCompletion": {
input: {
setupId: string;
nowMs: number;
};
output: DevicePairSetupCompletionRecord | null;
};
"bootstrap.prune": {
input: {
nowMs: number;
};
output: number;
};
"bootstrap.clear": {
input: {
nowMs: number;
};
output: {
removed: number;
};
};
"bootstrap.revoke": {
input: {
token: string;
nowMs: number;
};
output: {
removed: boolean;
record?: DeviceBootstrapTokenRecord;
};
};
"bootstrap.restore": {
input: {
record: DeviceBootstrapTokenRecord;
nowMs: number;
};
output: boolean;
};
"bootstrap.redeem": {
input: {
token: string;
role: string;
scopes: readonly string[];
nowMs: number;
};
output: {
recorded: boolean;
fullyRedeemed: boolean;
};
};
"bootstrap.verify": {
input: DeviceBootstrapBoundContextInput & {
role: string;
scopes: readonly string[];
};
output: {
ok: true;
} | {
ok: false;
reason: string;
};
};
};
//#endregion
//#region src/infra/device-pairing-read.types.d.ts
type DevicePairingBinding = {
identity: string;
generation?: string;
};
//#endregion
//#region src/infra/device-pairing-core.types.d.ts
/** Paired-device access metadata refreshed when an existing device reconnects. */
type DevicePairingAccessMetadata = Pick<PairedDevice, "displayName" | "remoteIp" | "lastSeenAtMs" | "lastSeenReason">;
/** Authorization failure categories for owner approval and bootstrap approval flows. */
type DevicePairingForbiddenReason = "caller-scopes-required" | "caller-missing-scope" | "scope-outside-requested-roles" | "approval-policy-changed" | "bootstrap-role-not-allowed" | "bootstrap-scope-not-allowed";
/** Structured forbidden result with the missing/disallowed role or scope when known. */
type DevicePairingForbiddenResult = {
status: "forbidden";
reason: DevicePairingForbiddenReason;
scope?: string;
role?: string;
};
/** Pairing approval outcome: approved, forbidden with reason, or request not found. */
type ApproveDevicePairingResult = {
status: "approved";
requestId: string;
device: PairedDevice;
/** Existing connected node transports must be retired before success is returned. */
nodePairingGenerationChanged?: true;
} | DevicePairingForbiddenResult | null;
type DevicePairingApprovalOptions = {
callerScopes?: readonly string[];
accessMetadata?: DevicePairingAccessMetadata;
approvedVia?: Extract<PairedDeviceApprovalKind, "owner" | "silent" | "trusted-cidr" | "trusted-proxy" | "ssh-verified">;
/** Revalidate automatic approval against current policy after all pairing-lock awaits. */
isApprovalCurrent?: (state: {
pending: Readonly<DevicePairingPendingRequest>;
existing: Readonly<PairedDevice> | undefined;
}) => boolean;
/**
* Replace pending scopes for a new operator device, or a trusted-proxy
* same-key upgrade. The live role set is rechecked under the pairing lock.
*/
autoApproveNewDeviceScopes?: readonly string[];
};
//#endregion
//#region src/infra/device-pairing.d.ts
declare function listDevicePairing(baseDir?: string): Promise<{
pending: DevicePairingPendingRequest[];
paired: PairedDevice[];
}>;
//#endregion
//#region src/infra/node-pairing-surface.d.ts
type NodeApprovalSurface = {
caps: string[];
commands: string[];
permissions?: Record<string, boolean>;
};
//#endregion
//#region src/infra/device-pairing-node-state.d.ts
/** Registry projection of a paired device's authenticated node-role state. */
type PairedDeviceNodeBinding = DevicePairingBinding;
//#endregion
//#region src/gateway/node-event-payload.d.ts
declare const SERIALIZED_EVENT_PAYLOAD: unique symbol;
type SerializedEventPayload = {
readonly json: string;
readonly [SERIALIZED_EVENT_PAYLOAD]: true;
};
//#endregion
//#region src/gateway/node-plugin-tool-snapshot.d.ts
type RegisteredNodePluginToolCommand = {
pluginId: string;
command: {
command?: string;
agentTool?: {
name?: string;
description?: string;
parameters?: unknown;
mcp?: {
server?: string;
tool?: string;
};
};
};
};
//#endregion
//#region src/gateway/node-session.types.d.ts
/** Connected node session advertised over Gateway websocket. */
type NodeSession = {
nodeId: string;
connId: string;
/** Persistent device key and node-token identity authenticated for this connection. */
pairingIdentity?: string;
/** Persistent pairing generation authenticated before this session was registered. */
pairingGeneration?: string;
client: GatewayWsClient;
clientId?: string;
clientMode?: string;
displayName?: string;
platform?: string;
version?: string;
coreVersion?: string;
uiVersion?: string;
deviceFamily?: string;
modelIdentifier?: string;
remoteIp?: string;
declaredCaps: string[];
sessionCapsCeiling?: string[];
caps: string[];
declaredCommands: string[];
sessionCommandsCeiling?: string[];
commands: string[];
declaredComputerUse?: ComputerUseCapabilityDescriptor;
computerUse?: ComputerUseCapabilityDescriptor;
declaredNodePluginTools: NodePluginToolDescriptor[];
nodePluginTools: NodePluginToolDescriptor[];
nodeSkills: NodeSkillDescriptor[];
declaredPermissions?: Record<string, boolean>;
permissions?: Record<string, boolean>;
pathEnv?: string;
connectedAtMs: number;
lastActiveAtMs?: number;
presenceUpdatedAtMs?: number;
/** Source of the current connection's activity sample; reset with that sample. */
presenceActivitySource?: "app" | "system";
hostStats?: NodeHostStats;
desktopAvailability?: DesktopAvailability;
};
//#endregion
//#region src/gateway/node-registry.presence.d.ts
type NodePresenceActivityUpdate = {
nodeId: string;
connId?: string;
idleSeconds: number;
source?: "app" | "system";
saturated?: boolean;
observedAtMs?: number;
};
//#endregion
//#region src/gateway/node-registry.d.ts
type NodeEventPayloadPreparation = (connId: string) => {
payloadJSON: SerializedEventPayload | null;
onSent?: () => void;
} | undefined;
type PairingBoundNodeSession = NodeSession & {
pairingIdentity: string;
};
/** Connectivity probe result for a registered node. */
type NodeConnectivityResult = {
ok: true;
} | {
ok: false;
error: {
code: string;
message: string;
};
};
/** Event transport for nodes that cannot keep a WebSocket open, such as watchOS. */
type NodeEventTransport = {
send: (event: string, payload: unknown) => boolean;
sendRaw: (event: string, payloadJSON?: SerializedEventPayload | null) => boolean;
checkConnectivity?: (timeoutMs: number) => Promise<NodeConnectivityResult>;
};
type NodeSessionRegistrationOptions = {
remoteIp?: string | undefined;
pairingIdentity: string;
pairingGeneration?: string | undefined;
approvedSurface?: NodeApprovalSurface;
};
type NodeRegistryOptions = {
listRegisteredNodePluginToolCommands?: (() => readonly RegisteredNodePluginToolCommand[] | undefined) | undefined;
getConfig?: () => OpenClawConfig;
resolveCurrentPairingState?: (nodeId: string) => Promise<PairedDeviceNodeBinding | undefined>;
isPairingStateCurrent?: (nodeId: string, expected: PairedDeviceNodeBinding) => boolean;
onPairingGenerationChanged?: (params: {
nodeId: string;
previousPairingGeneration: string;
nextPairingGeneration: string;
preserveSessionState: boolean;
}) => void;
onPairingInvalidated?: (params: {
nodeId: string;
connId: string;
}) => void;
onDesktopAvailabilityChanged?: (nodeId: string) => void;
};
/** Registry of currently connected Gateway nodes. */
declare class NodeRegistry {
private readonly options;
private nodesById;
private nodesByConn;
private eventTransportsByConn;
private pendingInvokes;
private invokeStreams;
private authorizedSystemRunEvents;
private pairingGenerationEventChains;
private committedConfig;
constructor(options?: NodeRegistryOptions);
private listConnectedSessions;
private capturePairingLease;
private currentSessionForLease;
private settlePairingLease;
private resolvePairingLease;
private refreshSessionPolicy;
private isCommandAllowed;
refreshRuntimePolicy(config?: OpenClawConfig | undefined): NodeSession[];
/** Register a websocket client as the current connection for its node id. */
register(client: GatewayWsClient, opts: NodeSessionRegistrationOptions): PairingBoundNodeSession;
/** Register a node whose events are delivered by an HTTP polling transport. */
registerTransport(client: GatewayWsClient, opts: NodeSessionRegistrationOptions, transport: NodeEventTransport): PairingBoundNodeSession;
private registerSession;
/** Unregister one connection and reject invokes tied to that connection. */
unregister(connId: string): string | null;
/** List connected node sessions. */
listConnected(): NodeSession[];
/** Filter connected sessions against an already-loaded pairing-state snapshot. */
listConnectedForPairingStates(currentPairingStates: ReadonlyMap<string, PairedDeviceNodeBinding>): NodeSession[];
/** Reconcile connected sessions against the pairing owner's committed publication. */
listCurrentConnectedSync(): NodeSession[];
/** Resolve persistent pairing state before projecting connected sessions. */
listCurrentConnected(): Promise<NodeSession[]>;
getCurrentConnected(nodeId: string): Promise<NodeSession | undefined>;
private resolveCurrentConnectedSessions;
private projectPairingLeaseResolutions;
private invalidateSessionForPairingChange;
/** Immediately retires one exact transport after its persisted pairing authority changes. */
invalidateConnectionForPairingChange(connId: string, reason?: string): boolean;
/** Return a connected node session by node id. */
get(nodeId: string): NodeSession | undefined;
private getRegisteredSession;
/** Return only the session authenticated for the requested persistent pairing generation. */
getForPairingGeneration(nodeId: string, pairingGeneration: string): NodeSession | undefined;
private getRegisteredSessionForPairingGeneration;
/** Revalidates that one inbound node connection still owns its persisted pairing state. */
isConnectionCurrentPairingState(connId: string): Promise<boolean>;
private clearDesktopAvailability;
/** Records operational state without publishing activity or retaining it across connections. */
updateDesktopAvailability(params: {
nodeId: string;
connId?: string;
availability: DesktopAvailability;
}): boolean | null;
/** Stores the latest resource snapshot for the exact authenticated node connection. */
updateHostStats(params: {
nodeId: string;
connId?: string;
stats: NodeHostStatsPayload;
observedAtMs?: number;
}): NodeHostStats | null;
/** Updates recent input activity for the exact authenticated node connection. */
updatePresenceActivity(params: NodePresenceActivityUpdate): NodeSession | null;
/** Clears recent input activity for the exact authenticated node connection. */
clearPresenceActivity(params: {
nodeId: string;
connId?: string;
}): boolean | null;
/** Returns the connected node with the freshest reported local input. */
getActiveNode(connectedNodes?: readonly NodeSession[]): NodeSession | undefined;
private publishActiveNodeContext;
/** Probe websocket liveness with ping/pong when the socket supports it. */
checkConnectivity(nodeId: string, timeoutMs?: number): Promise<NodeConnectivityResult>;
updateNodePluginTools(nodeId: string, connId: string | undefined, tools: readonly NodePluginToolDescriptor[]): NodeSession | null;
updateNodeSkills(nodeId: string, connId: string | undefined, skills: readonly NodeSkillDescriptor[]): NodeSession | null;
updateSurface(nodeId: string, surface: {
caps?: readonly string[];
commands: readonly string[];
permissions?: Record<string, boolean> | undefined;
}, generationTransition?: {
expectedConnId: string;
expectedPairingIdentity: string;
expectedPairingGeneration?: string;
nextPairingGeneration: string;
}): NodeSession | null;
invoke(params: NodeInvokeParams): Promise<NodeInvokeResult>;
/** Internal cleanup retains its owner through replies without admitting new root work. */
invokeLifecycle(params: NodeInvokeParams & {
isDispatchAuthorized: () => boolean;
}): Promise<NodeInvokeResult>;
/** Send one ordered input frame to a pending streaming invoke. */
sendInvokeInput(invokeId: string, payload: unknown): void;
/** Synchronous effect fence for callbacks retained across awaited host work. */
isInvokeCurrent(invokeId: string, nodeId: string, connId: string): boolean;
handleInvokeProgress(params: NodeInvokeProgressParams): boolean;
/** Continues only the exact live owner of a pending node invocation. */
runPendingInvokeContinuation<T>(params: {
invokeId: string;
nodeId: string;
connId: string | undefined;
run: () => Promise<T>;
}): Promise<T> | null;
/** Authorize an inbound system.run event against a recently issued node invoke. */
authorizeSystemRunEvent(params: {
nodeId: string;
connId?: string;
runId?: string;
sessionKey: string;
terminal: boolean;
}): boolean;
private rememberAuthorizedSystemRunEvent;
private forgetAuthorizedSystemRunEvent;
private authorizedSystemRunEventExpiresAt;
private matchAuthorizedSystemRunEvent;
private allowsLegacyMacRunIdFallback;
private pruneAuthorizedSystemRunEvents;
private authorizedSystemRunEventKey;
handleInvokeResult(params: NodeInvokeResultParams): boolean;
sendEvent(nodeId: string, event: string, payload?: unknown): boolean;
sendEventRaw(nodeId: string, event: string, payloadJSON?: SerializedEventPayload | null): boolean;
/** Sends command-free events only to the exact authenticated pairing connection. */
sendEventForPairingIdentity(params: {
nodeId: string;
connId: string;
pairingIdentity: string;
event: string;
payload?: unknown;
}): Promise<boolean>;
/** Sends only to a session that still owns the requested persistent pairing generation. */
sendEventRawForPairingGeneration(nodeId: string, pairingGeneration: string, event: string, payloadJSON?: SerializedEventPayload | null, preparePayload?: NodeEventPayloadPreparation): Promise<boolean>;
private sendEventRawForPairingGenerationNow;
private sendEventInternal;
private sendEventRawInternal;
private sendEventToSession;
private observeEventSend;
}
//#endregion
//#region src/gateway/desktop/node-stream-broker.d.ts
type NodeDesktopStreamMetadata = {
auth: "vnc-password" | "ard-account";
/** Managed RFB password for VncAuth or ARD; never returned to a browser. */
vncPassword?: string;
};
type AttachedNodeDesktopStream = NodeDesktopStreamMetadata & {
stream: Duplex;
};
type AttachedNodePortalStream = {
stream: Duplex;
};
type NodeDesktopStreamBinding = {
nodeId: string;
connId: string;
pairingGeneration: string;
};
type TicketNodeRegistry = Pick<NodeRegistry, "getForPairingGeneration" | "isConnectionCurrentPairingState">;
/** Owns one-time node stream tickets and pairs authenticated desktop or portal duplexes. */
declare function createNodeDesktopStreamBroker(deps?: {
ttlMs?: number;
now?: () => number;
}): {
mint: (binding: NodeDesktopStreamBinding) => {
ticket: string;
attachPath: string;
expiresAtMs: number;
attached: Promise<AttachedNodeDesktopStream>;
cancel(): void;
};
mintPortal: (binding: NodeDesktopStreamBinding) => {
ticket: string;
attachPath: string;
expiresAtMs: number;
attached: Promise<AttachedNodePortalStream>;
cancel(): void;
};
handleUpgrade: (req: IncomingMessage, socket: Duplex, head: Buffer, registry: TicketNodeRegistry) => Promise<boolean>;
};
type NodeDesktopStreamBroker = ReturnType<typeof createNodeDesktopStreamBroker>;
//#endregion
//#region src/gateway/worker-environments/node-carrier-binding.d.ts
type WorkerNodeCarrierRuntime = {
transport: NodeWorkerSupervisorTransport;
streamBroker: NodeDesktopStreamBroker;
};
//#endregion
//#region src/gateway/worker-environments/portal-node-carrier.d.ts
/** Opens one ticketed node connection per request while its durable portal owner remains current. */
declare function createWorkerNodePortalCarrier(options: {
store: Pick<WorkerEnvironmentStore, "get">;
}): {
bindRuntime(next: WorkerNodeCarrierRuntime): void;
supports(environmentId: string, ownerEpoch: number): Promise<boolean>;
open(request: {
environmentId: string;
ownerEpoch: number;
remotePort: number;
}): Promise<{
connect: (assertCurrent?: () => void, touch?: () => Promise<void>) => Promise<Duplex>;
close: () => Promise<void>;
}>;
stop(environmentId: string, ownerEpoch?: number): Promise<void>;
stopAll(): Promise<void>;
};
type WorkerNodePortalCarrier = ReturnType<typeof createWorkerNodePortalCarrier>;
//#endregion
//#region src/gateway/worker-environments/node-desktop-carrier.d.ts
type WorkerNodeDesktopCarrierOptions = {
store: Pick<WorkerEnvironmentStore, "get">;
desktopRegistry: DesktopSessionRegistry;
};
/** Carries one durable worker environment's desktop over its private node connection. */
declare function createWorkerNodeDesktopCarrier(options: WorkerNodeDesktopCarrierOptions): {
bindRuntime(next: WorkerNodeCarrierRuntime): void;
launchApp: (request: {
record: WorkerEnvironmentRecord;
app: WorkerDesktopApp;
}) => Promise<void>;
observe: (request: {
record: WorkerEnvironmentRecord;
control: boolean;
requester?: DesktopObserveRequester;
}) => Promise<WorkerDesktopObserveResult>;
stop: (environmentId: string, ownerEpoch?: number) => Promise<void>;
stopAll: () => Promise<void>;
};
type WorkerNodeDesktopCarrier = ReturnType<typeof createWorkerNodeDesktopCarrier>;
//#endregion
//#region src/worker/node-supervisor-protocol.d.ts
declare const LaunchInput: z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
environmentSession: z.ZodLiteral<1>;
sessionKey: z.ZodOptional<z.ZodCustom<string, string>>;
idleRetention: z.ZodOptional<z.ZodLiteral<true>>;
launchId: z.ZodCustom<string, string>;
gatewayNamespace: z.ZodCustom<string, string>;
expectedBundleHash: z.ZodCustom<string, string>;
descriptor: z.ZodTransform<WorkerLaunchPlan, unknown>;
placementGeneration: z.ZodCustom<number, number>;
}, z.core.$strip>>;
declare const Receipt: z.ZodUnion<readonly [z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
launchId: z.ZodCustom<string, string>;
planHash: z.ZodCustom<string, string>;
environmentId: z.ZodCustom<string, string>;
sessionId: z.ZodCustom<string, string>;
ownerEpoch: z.ZodCustom<number, number>;
placementGeneration: z.ZodCustom<number, number>;
runId: z.ZodCustom<string, string>;
state: z.ZodEnum<{
pending: "pending";
running: "running";
}>;
}, z.core.$strip>>, z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
launchId: z.ZodCustom<string, string>;
planHash: z.ZodCustom<string, string>;
environmentId: z.ZodCustom<string, string>;
sessionId: z.ZodCustom<string, string>;
ownerEpoch: z.ZodCustom<number, number>;
placementGeneration: z.ZodCustom<number, number>;
runId: z.ZodCustom<string, string>;
state: z.ZodLiteral<"completed">;
resultJson: z.ZodCustom<string, string>;
}, z.core.$strip>>, z.ZodPipe<z.ZodCustom<Record<string, unknown>, Record<string, unknown>>, z.ZodObject<{
launchId: z.ZodCustom<string, string>;
planHash: z.ZodCustom<string, string>;
environmentId: z.ZodCustom<string, string>;
sessionId: z.ZodCustom<string, string>;
ownerEpoch: z.ZodCustom<number, number>;
placementGeneration: z.ZodCustom<number, number>;
runId: z.ZodCustom<string, string>;
state: z.ZodEnum<{
cancelled: "cancelled";
failed: "failed";
interrupted: "interrupted";
}>;
errorText: z.ZodCustom<string, string>;
}, z.core.$strip>>]>;
type NodeWorkerLaunchInput = z.infer<typeof LaunchInput>;
type NodeWorkerSupervisorReceipt = z.infer<typeof Receipt>;
//#endregion
//#region src/gateway/worker-environments/node-launch-adapter.d.ts
type TerminalNodeWorkerSupervisorReceipt = Extract<NodeWorkerSupervisorReceipt, {
state: "completed" | "failed" | "interrupted" | "cancelled";
}>;
type DeviceWorkerLaunchRequest = {
deviceId: string;
input: NodeWorkerLaunchInput;
isDispatchAuthorized: () => boolean;
isCancellationAuthorized: () => boolean;
timeoutMs: number;
credentialExpiresAtMs?: number;
signal?: AbortSignal;
onDispatchReady?: () => void;
};
type NodeWorkerLaunchAdapterOptions = {
getTransport: () => NodeWorkerSupervisorTransport | undefined;
now?: () => number;
sleep?: (ms: number, signal?: AbortSignal) => Promise<void>;
rpcTimeoutMs?: number;
pollIntervalMs?: number;
cancellationTimeoutMs?: number;
};
declare function createNodeWorkerLaunchAdapter(options: NodeWorkerLaunchAdapterOptions): {
launch: (request: DeviceWorkerLaunchRequest) => Promise<TerminalNodeWorkerSupervisorReceipt>;
};
//#endregion
//#region src/gateway/worker-environments/node-workspace-transfer-http-contract.d.ts
type NodeWorkspaceTransferHttpRoute = {
kind: "manifest" | "pack";
direction: "download";
environmentId: string;
manifestRef: string;
} | {
kind: "blob";
direction: "download";
environmentId: string;
sha256: string;
} | {
kind: "reconcile";
direction: "upload";
environmentId: string;
baseManifestRef: string;
};
//#endregion
//#region src/gateway/worker-environments/node-workspace-transfer-owner.d.ts
type NodeWorkspaceTransferOwner = {
credential: {
ownerEpoch: number;
sessionId: string | null;
} | undefined;
environment: {
ownerEpoch: number;
attachedSessionIds: string[];
destroyRequestedAtMs: number | null;
state: string;
};
};
//#endregion
//#region src/gateway/worker-environments/node-workspace-transfer-snapshot.d.ts
type NodeWorkspaceTransferSnapshot = {
manifest: WorkerWorkspaceManifest;
manifestRef: string;
rawManifest: string;
root: string;
/** Sparse checkpoint payloads contain only these paths from the complete manifest. */
blobPaths?: ReadonlySet<string>;
};
//#endregion
//#region src/gateway/worker-environments/node-workspace-upload-reader.d.ts
type NodeWorkspaceTransferUpload = {
base: WorkerWorkspaceManifest;
baseManifestRef: string;
baseRaw: string;
current: WorkerWorkspaceManifest;
currentManifestRef: string;
currentRaw: string;
stagingRoot: string;
};
//#endregion
//#region src/gateway/worker-environments/node-workspace-transfer-service.d.ts
type DownloadCapability = {
direction: "download";
token: string;
environmentId: string;
ownerEpoch: number;
sessionId: string;
generation: number;
manifestRef: string;
expiresAtMs: number;
isAuthorized?: () => boolean;
signal?: AbortSignal;
};
type UploadOperation = {
direction: "upload";
token: string;
environmentId: string;
ownerEpoch: number;
sessionId: string;
generation: number;
baseManifestRef: string;
expiresAtMs: number;
state: "ready" | "receiving" | "completed";
isAuthorized?: () => boolean;
uploaded?: NodeWorkspaceTransferUpload;
abortController: AbortController;
receiving?: {
result: Promise<{
manifestRef: string;
}>;
signal: AbortSignal;
};
disposal?: Promise<void>;
};
type TransferContext = {
environmentId: string;
ownerEpoch: number;
sessionId: string;
generation: number;
localPath?: string;
temporaryRoot: string;
currentManifestRef: string;
snapshots: Map<string, NodeWorkspaceTransferSnapshot>;
baseCommit: string | null;
pack?: Promise<string>;
downloads: Map<string, DownloadCapability>;
upload?: UploadOperation;
abortController: AbortController;
stopWatchingOwnerSignal?: () => void;
isAuthorized: () => boolean;
};
type TransferAuthorization = {
context: TransferContext;
capability: DownloadCapability | UploadOperation;
route: NodeWorkspaceTransferHttpRoute;
};
type TransferPreparation = Pick<TransferContext, "environmentId" | "ownerEpoch" | "sessionId" | "generation" | "isAuthorized"> & {
signal?: AbortSignal;
authorize?: () => void;
};
type RepositoryPreparation = TransferPreparation & {
baseCommit: string;
baseManifestRef: string;
};
type SyncPreparation = TransferPreparation & {
localPath: string;
};
declare function createNodeWorkspaceTransferService(options: {
getOwner: (environmentId: string) => NodeWorkspaceTransferOwner | undefined;
now?: () => number;
temporaryRoot?: string;
}): {
initialize: () => Promise<void>;
prepareAttachments(params: {
environmentId: string;
localPath: string;
isAuthorized: () => boolean;
signal: AbortSignal;
}): Promise<{
snapshot: {
manifest: WorkerWorkspaceManifest;
manifestRef: string;
rawManifest: string;
root: string;
};
token: string;
}>;
prepareRepository: (params: RepositoryPreparation) => Promise<void>;
prepareSync: (params: SyncPreparation) => Promise<{
snapshot: NodeWorkspaceTransferSnapshot;
token: string;
}>;
prepareUpload(environmentId: string, baseManifestRef: string, authorize?: () => void): string;
takeUpload(environmentId: string, baseManifestRef: string): NodeWorkspaceTransferUpload;
discardUpload(environmentId: string, token: string): Promise<void>;
getSnapshot(environmentId: string, manifestRef: string): NodeWorkspaceTransferSnapshot | undefined;
publishSnapshot(environmentId: string, snapshot: NodeWorkspaceTransferSnapshot, authorize?: () => void): string;
revoke(environmentId: string, token: string): Promise<void>;
authorize(params: {
route: NodeWorkspaceTransferHttpRoute;
token: string;
}): TransferAuthorization | undefined;
isAuthorizationCurrent: (authorization: TransferAuthorization) => boolean;
authorizationSignal(authorization: TransferAuthorization): AbortSignal;
snapshot(authorization: TransferAuthorization): NodeWorkspaceTransferSnapshot | undefined;
pack(authorization: TransferAuthorization): Promise<string | undefined>;
blob(authorization: TransferAuthorization): {
path: string;
size: number;
sha256: string;
} | undefined;
receiveUpload(params: {
authorization: TransferAuthorization;
request: IncomingMessage;
signal: AbortSignal;
}): Promise<{
manifestRef: string;
}>;
verifyBlob(params: {
path: string;
size: number;
sha256: string;
}): Promise<boolean>;
fenceEnvironment(environmentId: string, reason?: Error): void;
close: (environmentId: string) => Promise<void>;
closeAll(): Promise<void>;
};
type NodeWorkspaceTransferService = ReturnType<typeof createNodeWorkspaceTransferService>;
//#endregion
//#region src/gateway/worker-environments/node-worker-workspace-actions.d.ts
type NodeWorkerWorkspaceBinding = {
source: {
kind: "local";
path: string;
} | {
kind: "repository";
baseCommit: string;
baseManifestRef: string;
};
manifestRef: string;
remoteWorkspaceDir: string;
sessionKey?: string;
};
//#endregion
//#region src/gateway/worker-environments/node-worker-tunnel.d.ts
type NodeWorkerWorkspaceBindingResolver = (binding: {
environmentId: string;
ownerEpoch: number;
sessionId: string;
}) => Promise<NodeWorkerWorkspaceBinding | undefined>;
type NodeWorkerTunnelManagerOptions = {
gatewayDeviceId: string;
getEnvironment: (environmentId: string) => WorkerEnvironmentRecord | undefined;
listEnvironments: () => readonly WorkerEnvironmentRecord[];
getTransport: () => NodeWorkerSupervisorTransport | undefined;
launchNodeWorker: ReturnType<typeof createNodeWorkerLaunchAdapter>["launch"];
validateWorkerTurn: (claim: WorkerSessionTurnClaim) => boolean;
workspaceTransfer: NodeWorkspaceTransferService;
};
type NodeWorkerTunnelStartRequest = {
executionMode: "worker-turn" | "remote-exec";
environmentId: string;
ownerEpoch: number;
deviceId: string;
sessionId: string;
expectedBuild: WorkerAdmissionHandshake;
authorize?: () => void;
};
/** Owns node-channel handles without treating the persistent machine as a disposable lease. */
declare function createNodeWorkerTunnelManager(options: NodeWorkerTunnelManagerOptions): {
runSessionCommand(binding: {
environmentId: string;
ownerEpoch: number;
sessionId: string;
sessionKey: string;
}, command: WorkerWorkspaceCommand): Promise<NodeWorkerWorkspaceExecResult>;
bindWorkspaceBindingResolver(resolver: NodeWorkerWorkspaceBindingResolver): void;
start(request: NodeWorkerTunnelStartRequest): Promise<WorkerTurnTunnelHandle>;
stop: (environmentId: string, ownerEpoch?: number, reason?: WorkerTunnelStopReason) => Promise<void>;
stopAll(): Promise<void>;
status(environmentId: string): WorkerTunnelStatus;
};
type NodeWorkerTunnelManager = ReturnType<typeof createNodeWorkerTunnelManager>;
//#endregion
//#region src/gateway/worker-environments/environment-access.d.ts
type WorkerEnvironmentNodeTunnel = Pick<NodeWorkerTunnelManager, "status" | "start" | "stop" | "stopAll">;
//#endregion
//#region src/gateway/worker-environments/inference-control-internal.d.ts
type WorkerInferenceSessionDrain = {
drained: Promise<void>;
hasWork(): boolean;
release(): void;
};
type AcceptedWorkerInferenceSessionDrain = WorkerInferenceSessionDrain & {
start(): void;
};
type WorkerInferenceCancellation = {
readonly runIds: readonly string[];
cancel(control?: {
assertCurrent?: () => void;
onCancelled?: (runId: string) => void;
}): Promise<string[]>;
};
//#endregion
//#region src/gateway/worker-environments/inference.d.ts
declare function createWorkerInferenceManager(options: WorkerInferenceManagerOptions): {
ready: () => Promise<void>;
start: (params: {
identity: WorkerConnectionIdentity;
request: WorkerInferenceStartParams;
sink: WorkerInferenceSink;
sessionTarget: BoundAgentRunSessionTarget;
assertSourceCurrent?: () => void;
revalidate?: RevalidateInference;
}) => Promise<WorkerInferenceStartApplicationResult>;
cancel: (params: Parameters<(params: {
identity: WorkerConnectionIdentity;
request: WorkerInferenceCancelParams;
revalidate?: RevalidateInference;
}) => Promise<WorkerInferenceCancelApplicationResult>>[0]) => Promise<WorkerInferenceCancelApplicationResult>;
cancelEnvironment: (environmentId: string, reason?: WorkerInferenceErrorReason) => Promise<void>;
cancelClaim: (claim: WorkerSessionTurnClaim) => Promise<void>;
cancelSession: (sessionId: string, runId?: string) => Promise<string[]>;
captureSessionCancellation: (sessionId: string, runId?: string) => WorkerInferenceCancellation;
reserveSessionDrain: (sessionId: string) => {
assertReserved(): void;
accept(): AcceptedWorkerInferenceSessionDrain;
release(): void;
};
hasSession: (sessionId: string, runId?: string) => boolean;
resolveSessionTargetForRunId: (runId: string) => BoundAgentRunSessionTarget | undefined;
stop: () => Promise<void>;
};
//#endregion
//#region src/gateway/worker-environments/session-attachment-service.d.ts
type WorkerEnvironmentSessionAttachmentOptions = {
prepareAttachedComputer?: (authority: WorkerEnvironmentComputerAuthority) => Promise<PreparedWorkerComputer | undefined>;
closeEnvironmentComputers?: (environmentId: string, ownerEpoch?: number) => Promise<void>;
hasAttachedEnvironmentActivity?: (environmentId: string, ownerEpoch: number) => boolean;
runSessionEnvironmentCommand?: NodeWorkerTunnelManager["runSessionCommand"];
};
//#endregion
//#region src/gateway/worker-environments/transcript-commit.d.ts
type WorkerTranscriptCommitApplication = (params: {
identity: WorkerConnectionIdentity;
request: WorkerTranscriptCommitParams;
sessionTarget: BoundAgentRunSessionTarget;
assertCurrent: () => undefined;
}) => Promise<WorkerTranscriptCommitOutcome>;
//#endregion
//#region src/gateway/worker-environments/worker-turn-rpc.d.ts
type WorkerTranscriptCommitServiceResult = WorkerTranscriptCommitOutcome | {
ok: false;
closeReason: WorkerProtocolCloseReason;
};
type WorkerLiveEventServiceResult = WorkerLiveEventApplicationResult | {
ok: false;
closeReason: WorkerProtocolCloseReason;
};
type WorkerInferenceStartServiceResult = WorkerInferenceStartApplicationResult | {
ok: false;
closeReason: WorkerProtocolCloseReason;
};
type WorkerInferenceCancelServiceResult = WorkerInferenceCancelApplicationResult | {
ok: false;
closeReason: WorkerProtocolCloseReason;
};
type WorkerTurnRpcOptions = {
store: WorkerEnvironmentStore;
prepareInstallation: (install: WorkerInstallationArtifact["install"]) => Promise<WorkerInstallationArtifact>;
applyTranscriptCommit?: WorkerTranscriptCommitApplication;
liveEvents?: Pick<WorkerLiveEventReceiver, "apply">;
placementStore?: WorkerSessionPlacementGate;
executeComputer?: WorkerComputerExecutor;
executeSessionTool?: WorkerSessionToolExecutor;
inference: ReturnType<typeof createWorkerInferenceManager>;
isStopping: () => boolean;
now: () => number;
withLock: <T>(environmentId: string, task: () => Promise<T>) => Promise<T>;
};
declare function createWorkerTurnRpc(options: WorkerTurnRpcOptions): {
admitWorker: (admission: WorkerConnectParams["admission"]) => Promise<{
ok: true;
identity: WorkerConnectionIdentity;
} | {
ok: false;
reason: WorkerAdmissionFailureReason;
} | {
readonly ok: false;
readonly reason: "environment-unavailable";
} | {
readonly ok: false;
readonly reason: "credential-expired" | "placement-mismatch";
}>;
validateWorkerConnection: (identity: WorkerConnectionIdentity) => "admission-rejected" | "bundle-mismatch" | "credential-expired" | "credential-replaced" | "environment-mismatch" | "environment-unavailable" | "gateway-shutdown" | "gateway-unavailable" | "invalid-credential" | "invalid-frame" | "invalid-handshake" | "invalid-heartbeat" | "method-not-allowed" | "owner-epoch-mismatch" | "placement-mismatch" | "protocol-features-mismatch" | "protocol-mismatch" | "rpc-set-mismatch" | "session-mismatch" | "slow-consumer" | "version-mismatch" | null;
commitTranscript: (identity: WorkerConnectionIdentity, request: WorkerTranscriptCommitParams) => Promise<WorkerTranscriptCommitServiceResult>;
pushLiveEvent: (identity: WorkerConnectionIdentity, request: WorkerLiveEventParams) => Promise<WorkerLiveEventServiceResult>;
executeSessionTool: (identity: WorkerConnectionIdentity, toolName: WorkerSessionToolName, request: WorkerSessionToolRequest["request"], signal?: AbortSignal) => Promise<{
ok: true;
result: WorkerSessionToolResult;
} | {
ok: false;
closeReason: WorkerProtocolCloseReason;
} | {
ok: false;
reason: WorkerProtocolCloseReason;
}>;
executeComputer: (identity: WorkerConnectionIdentity, request: WorkerComputerParams, signal?: AbortSignal) => Promise<{
ok: true;
result: WorkerComputerResult;
} | {
ok: false;
closeReason: WorkerProtocolCloseReason;
} | {
ok: false;
reason: WorkerProtocolCloseReason;
message?: string;
}>;
startInference: (identity: WorkerConnectionIdentity, request: WorkerInferenceStartParams, sink: WorkerInferenceSink) => Promise<WorkerInferenceStartServiceResult>;
cancelInference: (identity: WorkerConnectionIdentity, request: WorkerInferenceCancelParams) => Promise<WorkerInferenceCancelServiceResult>;
cancelInferenceForSession: (params: {
sessionId: string;
runId?: string;
}) => Promise<string[]>;
hasInferenceForSession: (sessionId: string, runId?: string) => boolean;
clear: () => void;
};
//#endregion
//#region src/gateway/worker-environments/service.types.d.ts
type WorkerEnvironmentCreateRequest = {
profileId: string;
idempotencyKey: string;
machineClass?: string;
executionMode?: WorkerExecutionMode;
projectPath?: string;
signal?: AbortSignal;
os?: string;
runSetupScript?: boolean;
inheritedProfile?: {
providerId: string;
profileSnapshot: WorkerProfile;
};
admittedIntent?: WorkerProviderPreparedIntent;
};
type WorkerEnvironmentServiceOptions = WorkerProviderLifecycleInputOptions & WorkerEnvironmentSessionAttachmentOptions & {
prepareComputer?: (claim: WorkerSessionTurnClaim) => Promise<PreparedWorkerComputer | undefined>;
executeComputer?: WorkerComputerExecutor;
closeComputers?: () => Promise<void>;
tunnelManager?: WorkerTunnelManager;
nodeTunnelManager?: WorkerEnvironmentNodeTunnel;
nodeDesktopCarrier?: WorkerNodeDesktopCarrier;
nodePortalCarrier?: WorkerNodePortalCarrier;
closeWorkerPortals?: (environmentId: string, ownerEpoch?: number) => Promise<void>;
stopNodeEnrollmentWaits?: () => void;
closeNodeBootstrapArtifacts?: () => Promise<void>;
stopNodeWorkerBundleTransfers?: () => void | Promise<void>;
maintainProviders?: (signal: AbortSignal) => Promise<void>;
scheduler: GatewayScheduler;
reconcileIntervalMs?: number;
bootstrapCallTimeoutMs?: number;
workerCredentialTtlMs?: number;
generateWorkerCredential?: (bytes: number) => string;
now?: () => number;
logger?: {
warn: (message: string) => void;
};
applyTranscriptCommit?: WorkerTranscriptCommitApplication;
liveEvents?: Pick<WorkerLiveEventReceiver, "apply" | "clear" | "clearEnvironment" | "rotateCredential">;
executeInference: WorkerInferenceExecutor;
inferenceStore?: WorkerInferenceStore;
placementStore?: WorkerSessionPlacementGate;
executeSessionTool?: Parameters<typeof createWorkerTurnRpc>[0]["executeSessionTool"];
};
type WorkerEnvironmentReconcileCore = (signal?: AbortSignal, retainProviderSettlement?: (settled: Promise<void>) => void) => Promise<void>;
type WorkerEnvironmentReconcileGuard = (environmentId: string, reconcileCore: WorkerEnvironmentReconcileCore) => Promise<void>;
//#endregion
//#region src/gateway/worker-environments/service.d.ts
declare function createWorkerEnvironmentService(options: WorkerEnvironmentServiceOptions): {
getCleanupError: (record: WorkerEnvironmentRecord) => string | undefined;
captureSessionAttachment(identity: WorkerEnvironmentSessionIdentity): {
binding: WorkerEnvironmentAttachment;
assertCurrent: () => void;
touch: () => Promise<void>;
};
cancelSessionAttachmentCreations(): void;
getSessionAttachment: (sessionId: string) => WorkerEnvironmentAttachment | undefined;
findSessionAttachment: (identity: Pick<WorkerEnvironmentSessionIdentity, "agentId" | "sessionKey">) => WorkerEnvironmentAttachment | undefined;
getSessionAttachmentStatus(sessionId: string): {
attachment: {
sessionId: string;
sessionKey: string;
agentId: string;
sessionLifecycleRevision?: string;
environmentId: string;
generation: number;
createdAtMs: number;
lastUsedAtMs: number;
closedAtMs: number | null;
ownerEpoch: number;
};
environment: {
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentLeasedState;
leaseId: string;
sshEndpoint: WorkerSshEndpoint | null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
} | {
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentUnleasedState;
leaseId: null;
sshEndpoint: null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
};
} | undefined;
assertSessionAttachment: (binding: WorkerEnvironmentAttachment, prepared?: WorkerEnvironmentSessionIdentity) => void;
touchSessionAttachment: (binding: WorkerEnvironmentAttachment) => Promise<void>;
destroySessionAttachment(request: {
sessionId: string;
environmentId?: string;
}, authorize: () => void): Promise<{
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentLeasedState;
leaseId: string;
sshEndpoint: WorkerSshEndpoint | null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
} | {
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentUnleasedState;
leaseId: null;
sshEndpoint: null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
} | undefined>;
reconcileSessionAttachments(): Promise<void>;
retireSessionIdentityMutation(mutation: SessionIdentityMutation): void;
createSessionAttachment: (...args: Parameters<(input: WorkerEnvironmentSessionCreateRequest, authorize: () => void, callerSignal?: AbortSignal, onReserved?: WorkerEnvironmentSessionReservationHandler) => Promise<{
attachment: {
sessionId: string;
sessionKey: string;
agentId: string;
sessionLifecycleRevision?: string;
environmentId: string;
generation: number;
createdAtMs: number;
lastUsedAtMs: number;
closedAtMs: number | null;
ownerEpoch: number;
};
environment: {
environmentId: string;
providerId: string;
profileId: string;
} & {
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
} & {
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
} & {
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
} & {
state: WorkerEnvironmentLeasedState;
leaseId: string;
sshEndpoint: WorkerSshEndpoint | null;
};
reused: boolean;
}>>) => Promise<{
attachment: {
sessionId: string;
sessionKey: string;
agentId: string;
sessionLifecycleRevision?: string;
environmentId: string;
generation: number;
createdAtMs: number;
lastUsedAtMs: number;
closedAtMs: number | null;
ownerEpoch: number;
};
reused: boolean;
environment: {
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentLeasedState;
leaseId: string;
sshEndpoint: WorkerSshEndpoint | null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
} | {
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentUnleasedState;
leaseId: null;
sshEndpoint: null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
};
}>;
prepareAttachedComputer: ((authority: WorkerEnvironmentComputerAuthority) => Promise<PreparedWorkerComputer | undefined>) | undefined;
execSessionAttachment: (binding: WorkerEnvironmentAttachment, command: WorkerWorkspaceCommand) => Promise<NodeWorkerWorkspaceExecResult>;
openNodePortal: (request: {
environmentId: string;
ownerEpoch: number;
remotePort: number;
}) => Promise<{
connect: (assertCurrent?: () => void, touch?: () => Promise<void>) => Promise<import("node:stream").Duplex>;
close: () => Promise<void>;
}>;
prepare: (request: {
profileId: string;
projectPath: string;
}, authorize?: () => void) => Promise<{
environmentId: string;
preparationKey: string;
reused: boolean;
}>;
isStopping: () => boolean;
recordError: (record: WorkerEnvironmentRecord, error: unknown, assertCurrent?: () => void) => Promise<WorkerEnvironmentRecord>;
list: () => ({
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentLeasedState;
leaseId: string;
sshEndpoint: WorkerSshEndpoint | null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
} | {
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentUnleasedState;
leaseId: null;
sshEndpoint: null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
})[];
readPreparedPoolSummary: () => {
maxTotal: number;
reservedEnvironmentIds: string[];
};
readReadyWorkerTarget: (profileId: string) => number;
readRuntimeRefresh: (environmentId: string) => WorkerRuntimeRefreshInFlight | undefined;
supportsProviderExecutionMode: (providerId: string, mode: WorkerExecutionMode) => boolean;
supportsExecutionMode: (profileId: string, mode: WorkerExecutionMode) => boolean;
requiresNodeEnrollment: (profileId: string, providerId?: string) => boolean;
get: (environmentId: string) => {
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentLeasedState;
leaseId: string;
sshEndpoint: WorkerSshEndpoint | null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
} | {
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentUnleasedState;
leaseId: null;
sshEndpoint: null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
} | undefined;
getDedicatedNodeLeaseSignal: (environmentId: string) => AbortSignal | undefined;
prepareProjectIntent: (...args: Parameters<(profileId: string, createOptions?: {
inherited?: {
providerId: string;
profileSnapshot: WorkerProfile;
};
machineClass?: string;
os?: string;
executionMode?: WorkerExecutionMode;
projectPath?: string;
projectCommit?: string;
repository?: {
agentId: string;
url: string;
ref?: string;
baseCommit?: string;
};
projectRepository?: RepositoryWorkerProjectSnapshot;
runSetupScript?: boolean;
signal?: AbortSignal;
setupAuthorized?: boolean;
}) => Promise<WorkerProviderPreparedIntent>>) => Promise<WorkerProviderPreparedIntent>;
assertPreparedIntentCurrent: (profileId: string, intent: WorkerProviderPreparedIntent) => void;
getPreparedCandidates: (intent: WorkerProviderPreparedIntent) => ({
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentLeasedState;
leaseId: string;
sshEndpoint: WorkerSshEndpoint | null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
} | {
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentUnleasedState;
leaseId: null;
sshEndpoint: null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
})[];
schedulePreparedRefill: (environmentId?: string) => undefined;
inventoryVersion: () => number;
machineShapeVersion: () => number;
subscribeMachineShapeChanged: (listener: (profileId: string) => void) => () => void;
readMachineShape: (environmentId: string, prepared?: WorkerEnvironmentPlacementFacts) => {
class?: string | undefined;
os?: string | undefined;
osLabel?: string | undefined;
cpu?: number | undefined;
memoryGb?: number | undefined;
} | undefined;
supportsNodePortal: (environmentId: string, ownerEpoch: number) => Promise<boolean>;
hasPendingNodeEnrollmentSetup: (setup: string, device: string) => boolean;
readProviderDisplayId: (profileId: string) => string | undefined;
listMachineOptions: (profileId: string) => Promise<readonly Readonly<{
id: string;
label: string;
os?: string;
cpu?: number;
memoryGb?: number;
default?: boolean;
}>[] | undefined>;
listOperatingSystems: (profileId: string) => Promise<readonly Readonly<{
id: string;
label: string;
default?: boolean;
disabledReason?: string;
}>[] | undefined>;
bindPreparedWorkspace: (request: Parameters<NonNullable<((params: {
environmentId: string;
ownerEpoch: number;
sessionId: string;
sessionKey: string;
preparationKey: string;
cacheKey: string;
signal?: AbortSignal;
assertCurrent: () => void;
}) => Promise<NodeWorkerPreparedWorkspaceResult>) | undefined>>[0]) => Promise<{
gatewayNamespace: string;
environmentId: string;
preparationKey: string;
cacheKey: string;
workspaceDir: string;
homeDir: string;
sourceManifestRef: string;
preparedManifestRef: string;
}>;
createWithRequest: ({ profileId, idempotencyKey, inheritedProfile, admittedIntent, machineClass, executionMode, projectPath, signal, os, runSetupScript }: WorkerEnvironmentCreateRequest) => Promise<{
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentLeasedState;
leaseId: string;
sshEndpoint: WorkerSshEndpoint | null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
} | {
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentUnleasedState;
leaseId: null;
sshEndpoint: null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
}>;
create: (...args: Parameters<WorkerEnvironmentServiceContract["create"]>) => Promise<{
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentLeasedState;
leaseId: string;
sshEndpoint: WorkerSshEndpoint | null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
} | {
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentUnleasedState;
leaseId: null;
sshEndpoint: null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
}>;
destroy: (environmentId: string, abandonment?: WorkerEnvironmentAbandonment, forceAbandon?: () => Promise<void>) => Promise<{
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentLeasedState;
leaseId: string;
sshEndpoint: WorkerSshEndpoint | null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
} | {
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentUnleasedState;
leaseId: null;
sshEndpoint: null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
}>;
requestDestroy: (environmentId: string) => Promise<{
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentLeasedState;
leaseId: string;
sshEndpoint: WorkerSshEndpoint | null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
} | {
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentUnleasedState;
leaseId: null;
sshEndpoint: null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
}>;
destroyUnattached: (environmentId: string) => Promise<{
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentLeasedState;
leaseId: string;
sshEndpoint: WorkerSshEndpoint | null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
} | {
environmentId: string;
providerId: string;
profileId: string;
profileSnapshot: WorkerProfile;
preparation: WorkerEnvironmentPreparation | {
purpose: "reserve" | "build";
key: string;
demandAtMs: number;
expiresAtMs: number;
consumedAtMs: number | null;
project: {
label?: string | undefined;
baseCommit: string;
};
} | null;
provisionOperationId: string;
nodeSetupId: string | null;
nodeDeviceId: string | null;
sharedHost: boolean | null;
desktop: WorkerDesktopEndpoint | null;
bootstrapReceipt: WorkerEnvironmentBootstrapReceipt | null;
ownerEpoch: number;
teardownTerminalState: WorkerEnvironmentTeardownTerminalState | null;
attachedSessionIds: string[];
lastError: string | null;
createdAtMs: number;
updatedAtMs: number;
stateChangedAtMs: number;
lastActivatedAtMs: number | null;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
state: WorkerEnvironmentUnleasedState;
leaseId: null;
sshEndpoint: null;
error?: string | undefined;
desktopAvailable: boolean;
desktopApps: ("browser" | "terminal")[];
tunnelStatus: "connected" | "connecting" | "reconnecting" | "stopped";
}>;
observeDesktop: (request: {
environmentId: string;
control: boolean;
requester?: DesktopObserveRequester;
}) => Promise<WorkerDesktopObserveResult>;
launchDesktopApp: (request: {
environmentId: string;
app: "browser" | "terminal";
}) => Promise<WorkerDesktopLaunchResult>;
reconcileDesktopPolicy: () => Promise<void>;
admitWorker: (admission: WorkerConnectParams["admission"]) => Promise<{
ok: true;
identity: WorkerConnectionIdentity;
} | {
ok: false;
reason: WorkerAdmissionFailureReason;
} | {
readonly ok: false;
readonly reason: "environment-unavailable";
} | {
readonly ok: false;
readonly reason: "credential-expired" | "placement-mismatch";
}>;
fenceWorkerTurnForRecovery: (claim: WorkerSessionTurnClaim) => void;
validateWorkerConnection: (identity: WorkerConnectionIdentity) => "admission-rejected" | "bundle-mismatch" | "credential-expired" | "credential-replaced" | "environment-mismatch" | "environment-unavailable" | "gateway-shutdown" | "gateway-unavailable" | "invalid-credential" | "invalid-frame" | "invalid-handshake" | "invalid-heartbeat" | "method-not-allowed" | "owner-epoch-mismatch" | "placement-mismatch" | "protocol-features-mismatch" | "protocol-mismatch" | "rpc-set-mismatch" | "session-mismatch" | "slow-consumer" | "version-mismatch" | null;
commitTranscript: (identity: WorkerConnectionIdentity, request: WorkerTranscriptCommitParams) => Promise<{
ok: false;
closeReason: WorkerProtocolCloseReason;
} | WorkerTranscriptCommitOutcome>;
pushLiveEvent: (identity: WorkerConnectionIdentity, request: WorkerLiveEventParams) => Promise<{
ok: false;
closeReason: WorkerProtocolCloseReason;
} | WorkerLiveEventApplicationResult>;
executeSessionTool: (identity: WorkerConnectionIdentity, toolName: WorkerSessionToolName, request: WorkerSessionToolRequest["request"], signal?: AbortSignal) => Promise<{
ok: true;
result: WorkerSessionToolResult;
} | {
ok: false;
closeReason: WorkerProtocolCloseReason;
} | {
ok: false;
reason: WorkerProtocolCloseReason;
}>;
executeComputer: (identity: WorkerConnectionIdentity, request: WorkerComputerParams, signal?: AbortSignal) => Promise<{
ok: true;
result: WorkerComputerResult;
} | {
ok: false;
closeReason: WorkerProtocolCloseReason;
} | {
ok: false;
reason: WorkerProtocolCloseReason;
message?: string;
}>;
prepareComputer: ((claim: WorkerSessionTurnClaim) => Promise<PreparedWorkerComputer | undefined>) | undefined;
startInference: (identity: WorkerConnectionIdentity, request: WorkerInferenceStartParams, sink: WorkerInferenceSink) => Promise<{
ok: false;
closeReason: WorkerProtocolCloseReason;
} | WorkerInferenceStartApplicationResult>;
cancelInference: (identity: WorkerConnectionIdentity, request: WorkerInferenceCancelParams) => Promise<{
ok: false;
closeReason: WorkerProtocolCloseReason;
} | WorkerInferenceCancelApplicationResult>;
cancelInferenceForSession: (params: {
sessionId: string;
runId?: string;
}) => Promise<string[]>;
hasInferenceForSession: (sessionId: string, runId?: string) => boolean;
resolveSshIdentity: (environmentId: string) => Promise<WorkerSshIdentity>;
attachSession: (request: WorkerCredentialBinding & {
sessionId: string;
placementBinding?: PreparedEnvironmentPlacementBinding;
}) => Promise<MintedWorkerCredential>;
takeMintedCredential: (binding: WorkerCredentialBinding) => MintedWorkerCredential | undefined;
acquireTurnCredential: (claim: WorkerSessionTurnClaim) => Promise<MintedWorkerCredential>;
acknowledgeCredentialDelivery: (grant: MintedWorkerCredential) => Promise<boolean>;
startTunnel: (request: WorkerTunnelRequest) => Promise<WorkerTunnelHandle>;
stopTunnel: (environmentId: string, ownerEpoch?: number) => Promise<void>;
stopNodeEnrollmentWaits: (() => void) | undefined;
installReconcileEnvironmentGuard: (guard: WorkerEnvironmentReconcileGuard) => () => Promise<void>;
reconcileEnvironment: (environmentId: string) => Promise<void>;
reconcileOnce: (environmentId?: string) => Promise<void>;
ready: () => Promise<void>;
start: () => void;
stop: () => Promise<void>;
};
type WorkerEnvironmentService = ReturnType<typeof createWorkerEnvironmentService>;
//#endregion
//#region src/state/session-repository-workspaces.types.d.ts
type SessionRepositoryWorkspaceRecord = {
workspaceId: string;
agentId: string;
sessionKey: string;
url: string;
requestedRef: string | null;
runSetupScript: boolean;
baseCommit: string | null;
baseManifestHash: string | null;
branch: string;
checkpointRef: string | null;
manifestHash: string | null;
revision: number;
createdAtMs: number;
updatedAtMs: number;
};
//#endregion
//#region src/gateway/worker-environments/session-workspace.d.ts
/** Durable session workspace ownership is independent of its current worker placement. */
type WorkerSessionWorkspace = {
kind: "local";
path: string;
} | {
kind: "repository";
repository: SessionRepositoryWorkspaceRecord;
};
//#endregion
//#region src/gateway/worker-environments/workspace-operation-coordinator.d.ts
type WorkerWorkspaceOperationCoordinator = {
run<T>(environmentId: string, operation: () => Promise<T>): Promise<T>;
};
//#endregion
//#region src/gateway/worker-environments/repository-workspace-mutation.d.ts
declare function createRepositoryWorkspaceMutationService(options: {
placements: WorkerSessionPlacementStore;
environments: Pick<WorkerEnvironmentService, "get" | "startTunnel">;
workspaceOperations: WorkerWorkspaceOperationCoordinator;
resolveWorkspace: (identity: WorkerSessionPlacementIdentity) => Promise<WorkerSessionWorkspace>;
}): {
mutate<T>(params: WorkerSessionPlacementIdentity & {
assertCurrent: () => void;
mutate: (assertCurrent: () => void) => Promise<{
changed: boolean;
value: T;
}>;
}): Promise<T>;
};
//#endregion
//#region src/gateway/github-publication-availability.d.ts
type PublicationSessionIdentity = {
sessionId: string;
sessionKey: string;
agentId: string;
lifecycleRevision?: string | null;
};
//#endregion
//#region src/state/github-publication-requester.d.ts
declare const requesterSchema: z.ZodObject<{
version: z.ZodLiteral<1>;
actor: z.ZodDiscriminatedUnion<[z.ZodObject<{
kind: z.ZodLiteral<"operator">;
profileId: z.ZodString;
}, z.core.$strict>, z.ZodObject<{
kind: z.ZodLiteral<"system">;
}, z.core.$strict>], "kind">;
scopes: z.ZodArray<z.ZodString>;
grant: z.ZodNullable<z.ZodObject<{
pluginId: z.ZodString;
grantId: z.ZodUUID;
aliasBindingIds: z.ZodArray<z.ZodUUID>;
}, z.core.$strict>>;
}, z.core.$strict>;
type RequesterData = z.infer<typeof requesterSchema>;
type GitHubPublicationRequesterSnapshot = Readonly<Omit<RequesterData, "actor" | "scopes" | "grant"> & {
actor: Readonly<RequesterData["actor"]>;
scopes: readonly string[];
grant: Readonly<Omit<NonNullable<RequesterData["grant"]>, "aliasBindingIds"> & {
aliasBindingIds: readonly string[];
}> | null;
}>;
//#endregion
//#region src/gateway/github-publication-requester.d.ts
type GitHubPublicationRequesterPolicy = Readonly<{
snapshot: GitHubPublicationRequesterSnapshot;
assertCurrent: () => void;
}>;
type GitHubPublicationRequester = GitHubPublicationRequesterPolicy & Readonly<{
/** An accepted row keeps its own policy while the current invocation retains its fences. */
assertInvocationCurrent: () => void;
}>;
//#endregion
//#region src/gateway/github-publication-coordinator-methods.d.ts
type GitHubPublicationClaimRequest = {
claim: WorkerSessionTurnClaim;
sessionKey: string;
agentId: string;
idempotencyKey: string;
title?: string;
body?: string;
requester: GitHubPublicationRequester;
expectedPublisher?: GitHubPublicationPublisher;
};
type GitHubPublicationSessionRequest = SessionGitHubPublishParams & {
agentId: string;
expectedRunId?: string;
requester: GitHubPublicationRequester;
};
//#endregion
//#region src/gateway/github-personal-oauth.d.ts
type PersonalGitHubAction = {
owner: string;
assertCurrent: () => void;
};
//#endregion
//#region src/gateway/github-personal-publication.d.ts
type PersonalGitHubSessionAction = PersonalGitHubAction & {
sessionId: string;
sessionKey: string;
agentId: string;
lifecycleRevision: string | null;
};
//#endregion
//#region src/gateway/github-publication.d.ts
type GitHubPublicationCoordinator = ReturnType<typeof createGitHubPublicationCoordinator>;
declare function createGitHubPublicationCoordinator(params: {
placements: WorkerSessionPlacementStore;
getCommittedRuntimeConfig: () => OpenClawConfig;
}): {
requestForClaim: (request: GitHubPublicationClaimRequest) => Promise<{
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "requested";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "publishing";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "published";
url: string;
repository: string;
branch: string;
headCommit: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "failed";
code: "github_rejected" | "identity_changed" | "identity_unavailable" | "no_changes" | "not_git" | "not_github" | "push_rejected" | "session_changed" | "unavailable" | "workspace_changed";
message: string;
nextAction: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "needs_confirmation";
message: string;
}>;
prepareClaimWorkspace(claim: WorkerSessionTurnClaim): Promise<void>;
deferClaimPreparation(claim: WorkerSessionTurnClaim): void;
requestForSession(input: Parameters<(input: GitHubPublicationSessionRequest) => Promise<SessionGitHubPublicationResult>>[0]): Promise<{
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "requested";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "publishing";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "published";
url: string;
repository: string;
branch: string;
headCommit: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "failed";
code: "github_rejected" | "identity_changed" | "identity_unavailable" | "no_changes" | "not_git" | "not_github" | "push_rejected" | "session_changed" | "unavailable" | "workspace_changed";
message: string;
nextAction: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "needs_confirmation";
message: string;
}>;
requestPersonalForSession(input: {
sessionKey?: string | undefined;
agentId?: string | undefined;
idempotencyKey: string;
title?: string | undefined;
body?: string | undefined;
selection?: {
source: "shared";
expected?: {
accountId: number;
login: string;
source: "agent-override" | "system-configured" | "system-detected";
} | undefined;
} | {
source: "personal";
generation: string;
account: {
accountId: number;
login: string;
};
} | undefined;
}, action: PersonalGitHubSessionAction): Promise<{
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "requested";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "publishing";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "published";
url: string;
repository: string;
branch: string;
headCommit: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "failed";
code: "github_rejected" | "identity_changed" | "identity_unavailable" | "no_changes" | "not_git" | "not_github" | "push_rejected" | "session_changed" | "unavailable" | "workspace_changed";
message: string;
nextAction: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "needs_confirmation";
message: string;
}>;
sharedStatus(session: PublicationSessionIdentity, requestId: string): {
result: {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "requested";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "publishing";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "published";
url: string;
repository: string;
branch: string;
headCommit: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "failed";
code: "github_rejected" | "identity_changed" | "identity_unavailable" | "no_changes" | "not_git" | "not_github" | "push_rejected" | "session_changed" | "unavailable" | "workspace_changed";
message: string;
nextAction: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "needs_confirmation";
message: string;
};
confirmation: {
requestDigest: string;
generation: string;
account: {
accountId: number;
login: string;
};
pushRepository: string;
repository: string;
branch: string;
baseBranch: string;
sourceHeadCommit: string;
sourceIndexTree: string;
workspaceTree: string;
} | null;
} | undefined;
latestShared(session: PublicationSessionIdentity, idempotencyKey?: string | undefined): {
result: {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "requested";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "publishing";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "published";
url: string;
repository: string;
branch: string;
headCommit: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "failed";
code: "github_rejected" | "identity_changed" | "identity_unavailable" | "no_changes" | "not_git" | "not_github" | "push_rejected" | "session_changed" | "unavailable" | "workspace_changed";
message: string;
nextAction: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "needs_confirmation";
message: string;
};
confirmation: {
requestDigest: string;
generation: string;
account: {
accountId: number;
login: string;
};
pushRepository: string;
repository: string;
branch: string;
baseBranch: string;
sourceHeadCommit: string;
sourceIndexTree: string;
workspaceTree: string;
} | null;
} | null;
personalStatus(action: PersonalGitHubAction, session: {
sessionKey: string;
agentId: string;
sessionId: string;
lifecycleRevision?: string | null;
}, requestId: string): {
result: {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "requested";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "publishing";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "published";
url: string;
repository: string;
branch: string;
headCommit: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "failed";
code: "github_rejected" | "identity_changed" | "identity_unavailable" | "no_changes" | "not_git" | "not_github" | "push_rejected" | "session_changed" | "unavailable" | "workspace_changed";
message: string;
nextAction: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "needs_confirmation";
message: string;
};
confirmation: {
requestDigest: string;
generation: string;
account: {
accountId: number;
login: string;
};
pushRepository: string;
repository: string;
branch: string;
baseBranch: string;
sourceHeadCommit: string;
sourceIndexTree: string;
workspaceTree: string;
} | null;
};
personalPending(action: PersonalGitHubAction, session: {
sessionKey: string;
agentId: string;
sessionId: string;
lifecycleRevision?: string | null;
}): Promise<{
result: {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "requested";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "publishing";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "published";
url: string;
repository: string;
branch: string;
headCommit: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "failed";
code: "github_rejected" | "identity_changed" | "identity_unavailable" | "no_changes" | "not_git" | "not_github" | "push_rejected" | "session_changed" | "unavailable" | "workspace_changed";
message: string;
nextAction: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "needs_confirmation";
message: string;
};
confirmation: {
requestDigest: string;
generation: string;
account: {
accountId: number;
login: string;
};
pushRepository: string;
repository: string;
branch: string;
baseBranch: string;
sourceHeadCommit: string;
sourceIndexTree: string;
workspaceTree: string;
} | null;
} | null>;
confirmPersonal(input: {
sessionKey: string;
agentId?: string | undefined;
requestId: string;
generation: string;
account: {
accountId: number;
login: string;
};
requestDigest: string;
}, action: PersonalGitHubSessionAction): Promise<{
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "requested";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "publishing";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "published";
url: string;
repository: string;
branch: string;
headCommit: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "failed";
code: "github_rejected" | "identity_changed" | "identity_unavailable" | "no_changes" | "not_git" | "not_github" | "push_rejected" | "session_changed" | "unavailable" | "workspace_changed";
message: string;
nextAction: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "needs_confirmation";
message: string;
}>;
processClaim(claim: WorkerSessionTurnClaim): Promise<({
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "requested";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "publishing";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "published";
url: string;
repository: string;
branch: string;
headCommit: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "failed";
code: "github_rejected" | "identity_changed" | "identity_unavailable" | "no_changes" | "not_git" | "not_github" | "push_rejected" | "session_changed" | "unavailable" | "workspace_changed";
message: string;
nextAction: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "needs_confirmation";
message: string;
})[]>;
resumeSessionRequests(): Promise<void>;
deferOrphanedRequests(): void;
listUnreportedResults(): {
sessionId: string;
sessionKey: string;
agentId: string;
result: SessionGitHubPublicationResult;
}[];
read(requestId: string): {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "requested";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "publishing";
message: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "published";
url: string;
repository: string;
branch: string;
headCommit: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "failed";
code: "github_rejected" | "identity_changed" | "identity_unavailable" | "no_changes" | "not_git" | "not_github" | "push_rejected" | "session_changed" | "unavailable" | "workspace_changed";
message: string;
nextAction: string;
} | {
requestId: string;
publisher?: {
accountId: number;
login: string;
source: "agent-override" | "personal" | "system-configured" | "system-detected";
} | undefined;
effect?: {
kind: "pull_request" | "push";
status: "dispatched" | "observed";
headCommit?: string | undefined;
url?: string | undefined;
} | undefined;
status: "needs_confirmation";
message: string;
} | undefined;
markReported(requestId: string): void;
};
//#endregion
//#region src/agents/github-oauth-records.d.ts
declare const scope: z.ZodEnum<{
agent: "agent";
system: "system";
}>;
type GitHubIdentityScope = z.infer<typeof scope>;
//#endregion
//#region src/gateway/github-oauth-lifecycle.d.ts
declare function createGitHubOAuthLifecycle(params: {
getConfig: () => OpenClawConfig;
getPersistedConfig?: () => OpenClawConfig;
warn: (message: string) => void;
scheduler: GatewayScheduler;
}): {
personal: {
status: (action: PersonalGitHubAction) => Promise<PersonalGitHubStatus>;
revalidateStatus: (action: PersonalGitHubAction, prepared: PersonalGitHubStatus) => PersonalGitHubStatus;
startAuthorization(action: PersonalGitHubAction): Promise<UsersGitHubAuthorizeStartResult>;
pollAuthorization(action: PersonalGitHubAction, requestId: string): Promise<UsersGitHubAuthorizePollResult>;
cancelAuthorization(action: PersonalGitHubAction, requestId: string): boolean;
disconnect(action: PersonalGitHubAction): void;
refresh: (owner: string) => Promise<void>;
maintain(): Promise<void>;
stop(): Promise<void>;
};
startAuthorization: (input: {
scope: GitHubIdentityScope;
agentId: string;
}) => Promise<ToolsGitHubAuthorizeStartResult>;
pollAuthorization: (requestId: string) => Promise<ToolsGitHubAuthorizePollResult>;
cancelAuthorization: (requestId: string) => boolean;
status: (agentId: string, selectedScope: GitHubIdentityScope) => Promise<{
agentId: string;
selectedScope: "agent" | "system";
selected: {
scope: "agent" | "system";
configured: boolean;
identity: {
source: "agent-override" | "system-configured" | "system-detected";
credentialKind: "managed-oauth" | "managed-pat" | "native";
credentialState: "available" | "configured_unavailable" | "rate_limited" | "unavailable" | "unverified";
account: {
login: string;
} | null;
gitAuthor: {
name: string | null;
email: string | null;
};
evidence: "github-api" | "none" | "rate-limited" | "unverified";
accessExpiresAtMs: number | null;
refreshState: "available" | "expired" | "failed" | "not_applicable" | "refreshing" | "unavailable";
oauthScopes: string[];
repositoryGrants: "unknown";
} | null;
};
effective: {
source: "agent-override" | "system-configured" | "system-detected";
credentialKind: "managed-oauth" | "managed-pat" | "native";
credentialState: "available" | "configured_unavailable" | "rate_limited" | "unavailable" | "unverified";
account: {
login: string;
} | null;
gitAuthor: {
name: string | null;
email: string | null;
};
evidence: "github-api" | "none" | "rate-limited" | "unverified";
accessExpiresAtMs: number | null;
refreshState: "available" | "expired" | "failed" | "not_applicable" | "refreshing" | "unavailable";
oauthScopes: string[];
repositoryGrants: "unknown";
};
}>;
retireProfile: (profileId: string) => void;
refreshEffectiveIdentity: (agentId: string) => Promise<void>;
maintain: () => Promise<void>;
start: () => void;
stop: () => Promise<void>;
};
//#endregion
//#region src/gateway/model-account-authority.d.ts
/** In-process account authority shared by connect and selection owners; never serialized. */
type ModelAccountConnectAction = {
owner: string;
assertCurrent: () => void;
};
type UserModelAccountSelection = ModelAccountConnectAction & {
authProfileId: string;
};
//#endregion
//#region src/gateway/model-account-connect.d.ts
/** One Gateway lifetime owns sign-in steps and authority; provider methods only stage credentials. */
declare function createModelAccountConnectService(options: {
getConfig: () => OpenClawConfig;
onChanged?: () => void;
}): {
listLinks(action: ModelAccountConnectAction): UsersListAuthLinksResult;
link(action: ModelAccountConnectAction, authProfileId: string): UsersLinkAuthProfileResult;
unlink(action: ModelAccountConnectAction, provider: string): UsersUnlinkAuthProfileResult;
list(action: ModelAccountConnectAction, cursor?: string): UsersListModelAccountsResult;
catalog(action: ModelAccountConnectAction): UsersAuthConnectCatalogResult;
select(action: ModelAccountConnectAction, authProfileId: string): UsersSelectModelAccountResult;
start(action: ModelAccountConnectAction, provider: string, methodId: string): Promise<UsersAuthConnectStartResult>;
status(action: ModelAccountConnectAction, connectId: string): UsersAuthConnectStatusResult;
answer(action: ModelAccountConnectAction, connectId: string, stepId: string, value?: unknown): Promise<UsersAuthConnectStatusResult>;
cancel(action: ModelAccountConnectAction, connectId: string): UsersAuthConnectStatusResult;
supersede: (owner: string, provider: string) => void;
stop(): Promise<void>;
};
//#endregion
//#region src/infra/voicewake-routing.d.ts
type VoiceWakeRouteTarget = {
mode: "current";
agentId?: undefined;
sessionKey?: undefined;
} | {
agentId: string;
sessionKey?: undefined;
mode?: undefined;
} | {
sessionKey: string;
agentId?: undefined;
mode?: undefined;
};
type VoiceWakeRouteRule = {
trigger: string;
target: VoiceWakeRouteTarget;
};
type VoiceWakeRoutingConfig = {
version: 1;
defaultTarget: VoiceWakeRouteTarget;
routes: VoiceWakeRouteRule[];
updatedAtMs: number;
};
//#endregion
//#region src/infra/gateway-suspend-coordinator.d.ts
/** Private identity of one live process-owning host iteration, never a wire token. */
type GatewaySuspendHandoffOwner = {
isCurrent: () => boolean;
};
//#endregion
//#region src/plugins/types.mcp-connection.d.ts
/** Plugin-owned MCP server connection resolver contracts. */
/**
* Trusted runtime identity for per-requester MCP connection resolution.
* Only host-provided fields; plugins must not invent sender identity.
* Future trusted fields (for example cron/subagent user context) can be added additively.
*/
type McpServerConnectionResolveContext = {
/** Trusted message sender id. Required; runs without one fail closed. */
requesterSenderId: string;
/** Channel account id that received the message. */
agentAccountId?: string;
/** Message channel id (for example telegram or slack). */
messageChannel?: string;
};
/** Transport connection resolved for one requester-scoped MCP server. */
type McpServerConnectionResolved = {
url: string;
/** Per-user credentials; never logged, fingerprinted, or persisted by core. */
headers?: Record<string, string>;
};
/**
* Plugin-owned connection resolver for a statically declared MCP server.
* Server name/tool surface stay static; only the transport is requester-bound.
*/
type OpenClawPluginMcpServerConnectionResolver = {
/** Server name matching `mcp.servers` / bundle MCP declaration. */
serverName: string;
resolve: (ctx: McpServerConnectionResolveContext) => McpServerConnectionResolved | null | Promise<McpServerConnectionResolved | null>;
};
/** Registry entry for a plugin MCP server connection resolver. */
type PluginMcpServerConnectionResolverRegistration = {
pluginId: string;
pluginName?: string;
resolver: OpenClawPluginMcpServerConnectionResolver;
source: string;
rootDir?: string;
};
//#endregion
//#region src/plugins/agent-tool-result-middleware-types.d.ts
type OpenClawAgentToolResult<TResult = unknown> = AgentToolResult<TResult>;
type AgentToolResultMiddlewareRuntime = "openclaw" | "codex" | "agentsapi";
type AgentToolResultMiddlewareEvent = {
threadId?: string;
turnId?: string;
toolCallId: string;
toolName: string;
args: Record<string, unknown>;
cwd?: string;
isError?: boolean;
result: OpenClawAgentToolResult;
};
type AgentToolResultMiddlewareContext = {
runtime: AgentToolResultMiddlewareRuntime;
agentId?: string;
sessionId?: string;
sessionKey?: string;
runId?: string;
};
type AgentToolResultMiddlewareResult = {
result: OpenClawAgentToolResult;
};
type AgentToolResultMiddleware = (event: AgentToolResultMiddlewareEvent, ctx: AgentToolResultMiddlewareContext) => Promise<AgentToolResultMiddlewareResult | void> | AgentToolResultMiddlewareResult | void;
type AgentToolResultMiddlewareOptions = {
matcher?: PluginToolMatcher;
/** Defaults to the plugin's contracts.agentToolResultMiddleware declaration. */
runtimes?: AgentToolResultMiddlewareRuntime[];
};
type AgentToolResultMiddlewareScope = {
matcher?: PluginToolMatcher;
runtimes: AgentToolResultMiddlewareRuntime[];
};
//#endregion
//#region src/plugins/board-widget-content-kind.types.d.ts
/** Plugin-owned source kind rendered through the board's sandboxed document host. */
type PluginBoardWidgetContentKind = {
/** Agent-facing kind, for example `diagram`. Must be globally unique. */
kind: string;
/** Short label shown in dashboard chrome. */
label: string;
/** Capability-scoped static resources used by the composed document. */
resources: {
surface: string;
paths: string[];
/**
* Public static renderer bytes served without Gateway credentials.
* Declaring this reader reserves every path globally across content kinds,
* including registrations without a public reader.
* Public paths must be canonical URL pathnames and cannot use `/mcp-app-sandbox`.
*/
readPublicResource?: (path: string) => Promise<{
body: Uint8Array;
contentType: string;
} | undefined>;
};
/** Reject malformed or unsupported source before it reaches persistent storage. */
validateSource: (source: string) => void;
/** Build the untrusted document body; core adds the canonical bridge and CSP shell. */
composeDocument: (params: {
source: string;
title: string;
resourceUrls: Readonly<Record<string, string>>;
promptGranted: boolean;
}) => string;
};
//#endregion
//#region src/plugins/codex-app-server-extension-types.d.ts
/** Tool-result event emitted to Codex app-server plugin extensions. */
type CodexAppServerToolResultEvent = {
threadId: string;
turnId: string;
toolCallId: string;
toolName: string;
args: Record<string, unknown>;
result: AgentToolResult<unknown>;
};
/** Session context passed with Codex app-server extension events. */
type CodexAppServerExtensionContext = {
agentId?: string;
sessionId?: string;
sessionKey?: string;
runId?: string;
};
/** Optional replacement result returned by a Codex app-server extension handler. */
type CodexAppServerToolResultHandlerResult = {
result: AgentToolResult<unknown>;
};
/** Runtime event surface exposed to Codex app-server extension factories. */
type CodexAppServerExtensionRuntime = {
on: (event: "tool_result", handler: (event: CodexAppServerToolResultEvent, ctx: CodexAppServerExtensionContext) => Promise<CodexAppServerToolResultHandlerResult | void> | CodexAppServerToolResultHandlerResult | void) => void;
};
/** Factory signature for Codex app-server plugin extensions. */
type CodexAppServerExtensionFactory = (runtime: CodexAppServerExtensionRuntime) => Promise<void> | void;
//#endregion
//#region src/plugins/migration-provider.types.d.ts
type PluginConfigMigration = (config: OpenClawConfig) => {
config: OpenClawConfig;
changes: string[];
} | null | undefined;
type MigrationItemStatus = "planned" | "migrated" | "skipped" | "warning" | "conflict" | "error";
type MigrationItemKind = "auth" | "config" | "secret" | "memory" | "skill" | "workspace" | "session" | "file" | "archive" | "manual";
type MigrationItemAction = "copy" | "create" | "update" | "merge" | "append" | "archive" | "skip" | "manual";
type MigrationApplyPhase = "before-promotion" | "after-promotion";
/** Provider guarantee required before onboarding defers non-rollbackable effects. */
type MigrationDeferredApplyContract = {
retrySafe: true;
};
type MigrationItem = {
id: string;
kind: MigrationItemKind | (string & {});
action: MigrationItemAction | (string & {});
status: MigrationItemStatus;
source?: string;
target?: string;
message?: string;
reason?: string;
sensitive?: boolean;
/** Onboarding may defer non-rollbackable effects only for retry-safe providers. */
applyPhase?: MigrationApplyPhase;
/** Retry-safe deferred apply may report a non-mutating already-satisfied terminal result. */
deferredCompletion?: true;
/** Core-owned source revision bound by reviewed embedded migration flows. */
sourceRevision?: {
algorithm: "sha256";
digest: string;
};
details?: Record<string, unknown>;
};
type MigrationSummary = {
total: number;
planned: number;
migrated: number;
skipped: number;
conflicts: number;
errors: number;
sensitive: number;
};
type MigrationDetection = {
found: boolean;
source?: string;
label?: string;
confidence?: "low" | "medium" | "high";
message?: string;
};
type MigrationPlan = {
providerId: string;
source: string;
target?: string;
summary: MigrationSummary;
items: MigrationItem[];
warnings?: string[];
nextSteps?: string[];
metadata?: Record<string, unknown>;
};
type MigrationApplyResult = MigrationPlan & {
backupPath?: string;
reportDir?: string;
};
type MigrationProviderPreparation = {
dispose?: () => void | Promise<void>;
};
type MigrationConfigRuntime = Pick<NonNullable<PluginRuntime["config"]>, "current" | "mutateConfigFile">;
type MigrationProviderContext = {
config: OpenClawConfig;
runtime?: PluginRuntime;
/** Host-owned config mutation target for isolated embedded migration flows. */
configRuntime?: MigrationConfigRuntime;
logger: PluginLogger$1;
stateDir: string;
/** Explicit destination agent for embedded migration surfaces such as Control UI. */
targetAgentId?: string;
/** Optional item-kind scope used by embedded migration surfaces to avoid unrelated discovery. */
itemKinds?: readonly string[];
source?: string;
includeSecrets?: boolean;
overwrite?: boolean;
providerOptions?: Record<string, unknown>;
backupPath?: string;
reportDir?: string;
signal?: AbortSignal;
};
/** Migration source implemented by a plugin and orchestrated by `openclaw migrate`. */
type MigrationProviderPlugin$1 = {
id: string;
label: string;
description?: string;
/** Item kinds this provider can expose without requiring a full plan. */
supportedItemKinds?: readonly string[];
/** Required when this provider plans items for `after-promotion`. */
deferredApply?: MigrationDeferredApplyContract;
detect?: (ctx: MigrationProviderContext) => MigrationDetection | Promise<MigrationDetection>;
prepareApply?: (ctx: MigrationProviderContext) => MigrationProviderPreparation | Promise<MigrationProviderPreparation | undefined> | undefined;
plan: (ctx: MigrationProviderContext) => MigrationPlan | Promise<MigrationPlan>;
apply: (ctx: MigrationProviderContext, plan?: MigrationPlan) => MigrationApplyResult | Promise<MigrationApplyResult>;
};
type PluginSetupAutoEnableContext = {
config: OpenClawConfig;
env: NodeJS.ProcessEnv;
};
type PluginSetupAutoEnableProbe = (ctx: PluginSetupAutoEnableContext) => string | string[] | null | undefined;
//#endregion
//#region src/plugins/plugin-command.types.d.ts
type ChannelId = ChannelId$1;
type PluginCommandSessionTarget = {
agentId: string;
sessionId: string;
sessionKey: string;
storePath: string;
};
type PluginCommandDiagnosticsSession = {
/** Stable host session key when available. */
sessionKey?: string;
/** Ephemeral OpenClaw session id when available. */
sessionId?: string;
/** Canonical SQLite identity for active transcript access. */
sessionTarget?: PluginCommandSessionTarget;
/**
* Deprecated transcript locator for this OpenClaw session when available.
*
* SQLite-backed sessions use a `sqlite:<agentId>:<sessionId>:<storePath>`
* marker, not a filesystem path. Use session id/key plus transcript-runtime
* helpers for active transcript reads.
*
* @deprecated Use session identity fields with `plugin-sdk/session-transcript-runtime`.
*/
sessionFile?: string;
/** Embedded agent harness selected for this session. */
agentHarnessId?: string;
/** Channel/provider for this session when available. */
channel?: string;
/** Provider channel id when available. */
channelId?: ChannelId;
/** Account id for multi-account channels when available. */
accountId?: string;
/** Thread/topic id when available. */
messageThreadId?: string | number;
/** Parent conversation id for thread-capable channels when available. */
threadParentId?: string;
};
type PluginCommandContext = {
/** The sender's identifier (for example a channel-scoped user ID) */
senderId?: string;
/** The channel/surface (for example "chat" or "team-chat") */
channel: string;
/** Provider channel id */
channelId?: ChannelId;
/** Whether the sender is on the allowlist */
isAuthorizedSender: boolean;
/** Whether the sender is an owner for owner-only command surfaces. */
senderIsOwner?: boolean;
/** Revalidate admitted owner authority before privileged effects, after awaited preparation. */
assertOwnerCurrent?: () => void;
/** Gateway client scopes for internal control-plane callers */
gatewayClientScopes?: string[];
/** Host-resolved agent that owns the active session. */
agentId?: string;
/** Stable host session key for the active conversation when available. */
sessionKey?: string;
/** Ephemeral host session id for the active conversation when available. */
sessionId?: string;
/** Canonical SQLite identity for active transcript access. */
sessionTarget?: PluginCommandSessionTarget;
/**
* Deprecated transcript locator for the active OpenClaw session when available.
*
* SQLite-backed sessions use a `sqlite:<agentId>:<sessionId>:<storePath>`
* marker, not a filesystem path. Use session id/key plus transcript-runtime
* helpers for active transcript reads.
*
* @deprecated Use session identity fields with `plugin-sdk/session-transcript-runtime`.
*/
sessionFile?: string;
/** Raw command arguments after the command name */
args?: string;
/** The full normalized command body */
commandBody: string;
/** Current OpenClaw configuration */
config: OpenClawConfig;
/** Raw "From" value (channel-scoped id) */
from?: string;
/** Raw "To" value (channel-scoped id) */
to?: string;
/** Account id for multi-account channels */
accountId?: string;
/** Thread/topic id if available */
messageThreadId?: string | number;
/** Parent conversation id for thread-capable channels */
threadParentId?: string;
/** Sensitive diagnostics-only session inventory for owner-gated commands. */
diagnosticsSessions?: PluginCommandDiagnosticsSession[];
/** Host-bound runtime capabilities scoped to this command invocation. */
runtimeContext?: {
llm?: Pick<PluginRuntimeCore["llm"], "complete">;
compactCurrent?: () => Promise<{
compacted: boolean;
reason?: string;
tokensBefore?: number;
tokensAfter?: number;
}>;
};
/** Internal diagnostics-only marker that exec approval already authorized upload. */
diagnosticsUploadApproved?: boolean;
/** Internal diagnostics-only marker to preview upload effects without exposing ids. */
diagnosticsPreviewOnly?: boolean;
/** Internal diagnostics-only marker for owner-private routed confirmations. */
diagnosticsPrivateRouted?: boolean;
requestConversationBinding: (params?: PluginConversationBindingRequestParams) => Promise<PluginConversationBindingRequestResult>;
detachConversationBinding: () => Promise<{
removed: boolean;
}>;
getCurrentConversationBinding: () => Promise<PluginConversationBinding | null>;
};
type PluginCommandResult = ReplyPayload & {
/** Allows the agent session to continue processing after the command. */
continueAgent?: boolean;
/** Suppresses channel fallback replies when the handler already delivered a response. */
suppressReply?: boolean;
};
type PluginCommandHandler = (ctx: PluginCommandContext) => PluginCommandResult | Promise<PluginCommandResult>;
declare const AGENT_PROMPT_SURFACE_KINDS: readonly ["openclaw_main",
/** @deprecated Use openclaw_main. */
"pi_main", "codex_app_server", "cli_backend", "acp_backend", "subagent"];
type AgentPromptSurfaceKind = (typeof AGENT_PROMPT_SURFACE_KINDS)[number];
type AgentPromptGuidanceEntry = {
text: string;
surfaces?: readonly AgentPromptSurfaceKind[];
};
type AgentPromptGuidance = string | AgentPromptGuidanceEntry;
type OpenClawPluginCommandDefinition$1 = {
/** Command name without leading slash (e.g., "tts") */
name: string;
/**
* Optional native-command aliases for slash/menu surfaces.
* `default` applies to all native providers unless a provider-specific
* override exists (for example `{ default: "talkvoice", teamChat: "voice2" }`).
*/
nativeNames?: Partial<Record<string, string>> & {
default?: string;
};
/**
* Optional native progress placeholder text for native command surfaces.
* `default` applies to all native providers unless a provider-specific
* override exists.
*/
nativeProgressMessages?: Partial<Record<string, string>> & {
default?: string;
};
/** Description shown in /help and command menus */
description: string;
/** Localized descriptions for native command surfaces that support them. */
descriptionLocalizations?: Record<string, string>;
/**
* Optional channel ids this command belongs to.
* Omit to keep the command available on every channel surface.
*/
channels?: readonly string[];
/** Optional system-prompt guidance for agents when this command is registered. */
agentPromptGuidance?: readonly AgentPromptGuidance[];
/** Whether this command accepts arguments */
acceptsArgs?: boolean;
/** Optional bounded presentation for clients that explicitly support it. */
clientPresentation?: {
/** Parsed invocation shape eligible for client handling. */
when: "no-arguments";
action: {
kind: "device-pairing";
};
};
/** Whether only authorized senders can use this command (default: true) */
requireAuth?: boolean;
/** Operator scopes required by gateway clients; command owners may satisfy this on chat surfaces. */
requiredScopes?: OperatorScope[];
/** Whether a trusted bundled handler needs owner status for subcommand-level authorization. */
exposeSenderIsOwner?: boolean;
/**
* Allows a bundled plugin to claim a command name that is otherwise reserved
* by core. External plugins cannot use this field.
*/
ownership?: "plugin" | "reserved";
handler: PluginCommandHandler;
};
//#endregion
//#region src/infra/heartbeat-wake-contracts.d.ts
type HeartbeatRunResult = {
status: "ran";
durationMs: number;
} | {
status: "skipped";
reason: string;
retryAtMs?: number;
} | {
status: "failed";
reason: string;
};
type HeartbeatWakeIntent = "scheduled" | "task" | "event" | "immediate" | "manual";
type HeartbeatWakeSource = "interval" | "manual" | "exec-event" | "notifications-event" | "cron" | "hook" | "background-task" | "background-task-blocked" | "acp-spawn" | "session-state" | "cli-watchdog" | "restart-sentinel" | "retry" | "other";
type HeartbeatWakeOverride = {
target?: string;
to?: string | undefined;
accountId?: string | undefined;
};
/** Cron-owned periodic work carried directly into a guarded heartbeat turn. */
type HeartbeatScheduledTask = {
jobId: string;
name: string;
prompt: string;
};
type HeartbeatWakeRequest = {
source: HeartbeatWakeSource;
intent: HeartbeatWakeIntent;
reason?: string;
agentId?: string;
sessionKey?: string;
sessionStorePath?: string | null;
heartbeat?: HeartbeatWakeOverride;
/** Persisted cron monitor cadence carried with a scheduled heartbeat tick. */
scheduledEveryMs?: number;
tasks?: readonly HeartbeatScheduledTask[];
/** Internal marker for work retained after a spacing/cooldown deferral. */
retainedWork?: boolean;
};
//#endregion
//#region src/infra/session-event-wake.d.ts
type SessionEventWakeResult = HeartbeatRunResult;
type SessionEventWakeRequest = HeartbeatWakeRequest;
type WakeHandler = (request: SessionEventWakeRequest, signal: AbortSignal) => Promise<SessionEventWakeResult>;
type SessionEventWakeWaitOptions = {
abortSignal?: AbortSignal;
/** Called when the queue starts an attempt for this waiter. */
onAttemptStarted?: () => void;
/** Called whenever this waiter enters the queue, including retained retries. */
onQueued?: () => void;
/** Detach this waiter while the queue retains the wake at its retry deadline. */
stopWaitingOnRetry?: (result: Extract<SessionEventWakeResult, {
status: "skipped";
}>, retryAtMs: number) => boolean;
};
type RequestOptions = Omit<SessionEventWakeRequest, "retainedWork"> & {
coalesceMs?: number;
};
declare const { setSessionEventWakeHandler, requestSessionEventWake, requestSessionEventWakeAndWait, getSessionEventWakeAbortSignal, markSessionEventWakeWorkStarted, deferSessionEventWakePoll, isSessionEventWakePollDeferred, areSessionEventWakesEnabled, setSessionEventWakesEnabled }: {
setSessionEventWakeHandler: (next: WakeHandler | null) => () => void;
requestSessionEventWake: (options: RequestOptions) => void;
requestSessionEventWakeAndWait: (options: RequestOptions, lifecycle?: SessionEventWakeWaitOptions) => Promise<SessionEventWakeResult>;
getSessionEventWakeAbortSignal: () => AbortSignal | undefined;
markSessionEventWakeWorkStarted: () => void;
deferSessionEventWakePoll: () => boolean;
isSessionEventWakePollDeferred: () => boolean;
areSessionEventWakesEnabled: () => boolean;
setSessionEventWakesEnabled: (value: boolean) => void;
};
//#endregion
//#region src/cron/types-shared.d.ts
/** Optional dynamic-cadence bounds for one cron job. */
type CronPacing = {
min?: string;
max?: string;
};
/** Shared persisted cron job envelope used by runtime and external config shapes. */
type CronJobBase<TSchedule, TSessionTarget, TWakeMode, TPayload, TDelivery, TFailureAlert> = {
id: string;
agentId?: string;
sessionKey?: string;
name: string;
description?: string;
enabled: boolean;
deleteAfterRun?: boolean;
createdAtMs: number;
updatedAtMs: number;
schedule: TSchedule;
pacing?: CronPacing;
sessionTarget: TSessionTarget;
wakeMode: TWakeMode;
payload: TPayload;
delivery?: TDelivery;
failureAlert?: TFailureAlert;
};
//#endregion
//#region src/cron/types.d.ts
/** Supported schedule forms persisted in cron job specs. */
type CronSchedule = CronJob$1["schedule"];
/** Runtime target that decides whether a job joins main, isolated, or a named session. */
type CronSessionTarget = "main" | "isolated" | "current" | `session:${string}`;
/** Wake policy for main-session jobs waiting on heartbeat/user activity. */
type CronWakeMode$1 = "next-heartbeat" | "now";
/** Messaging channel id accepted by cron delivery settings. */
type CronMessageChannel = ChannelId$1;
/** Delivery mode for job completion output. */
type CronDeliveryMode = "none" | "announce" | "webhook";
/** Completion delivery configuration for cron job output. */
type CronDelivery = {
mode: CronDeliveryMode;
channel?: CronMessageChannel;
to?: string;
/** Explicit thread/topic id for channels that support threaded delivery. */
threadId?: string | number;
/** Explicit channel account id for multi-account setups (e.g. multiple Telegram bots). */
accountId?: string;
bestEffort?: boolean;
/** Additional webhook destination used when a job must keep chat delivery. */
completionDestination?: CronCompletionDestination;
/** Separate destination for failure notifications. */
failureDestination?: CronFailureDestination;
};
/** Webhook completion destination used alongside chat delivery. */
type CronCompletionDestination = {
mode: "webhook";
to?: string;
};
/** Destination override for failed-run notifications. */
type CronFailureDestination = {
channel?: CronMessageChannel;
to?: string;
accountId?: string;
mode?: "announce" | "webhook";
};
/** Partial failure-destination update shape; null clears individual override fields. */
type CronFailureDestinationPatch = { [K in keyof CronFailureDestination]?: CronFailureDestination[K] | null; };
/** Partial delivery update shape; null clears optional delivery destinations or fields. */
type CronDeliveryPatch = Partial<Pick<CronDelivery, "mode" | "bestEffort">> & {
channel?: CronMessageChannel | null;
to?: string | null;
threadId?: string | number | null;
accountId?: string | null;
completionDestination?: CronCompletionDestination | null;
failureDestination?: CronFailureDestinationPatch | null;
};
/** Execution outcome, separate from delivery outcome. */
type CronRunStatus = "ok" | "error" | "skipped";
/** Failure alert policy persisted on a cron job. */
type CronFailureAlert = Exclude<NonNullable<CronJob$1["failureAlert"]>, false>;
/** Partial failure-alert update; null clears an inherited field override. */
type CronFailureAlertPatch = { [K in keyof CronFailureAlert]?: CronFailureAlert[K] | null; };
/** Payload variants cron can execute in main-session or detached modes. */
type CronPayload = Exclude<CronJob$1["payload"], {
kind: "agentTurn" | "heartbeat";
}> | (Extract<CronJob$1["payload"], {
kind: "agentTurn";
}> & CronExternalContent) | ({
kind: "heartbeat";
} & CronPayloadToolAllow);
/** Partial payload update shape used by cron patch/edit flows. */
type CronPayloadPatch = Exclude<CronPayloadPatchWire, {
kind: "agentTurn";
}> | (Extract<CronPayloadPatchWire, {
kind: "agentTurn";
}> & CronExternalContent) | ({
kind: "heartbeat";
} & CronPayloadToolAllowPatch);
type CronPayloadToolAllow = {
/** Restricts agentTurn execution, or the trigger runtime for other payload kinds. */
toolsAllow?: string[];
/** Server-managed marker for auto-stamped defaults; explicit restrictions omit it. */
toolsAllowIsDefault?: boolean;
};
type CronPayloadToolAllowPatch = {
toolsAllow?: string[] | null;
toolsAllowIsDefault?: boolean;
};
type CronPayloadPatchWire = NonNullable<CronUpdateParams["patch"]["payload"]>;
type CronExternalContent = {
/** Immutable external hook provenance for async dispatch. */
externalContentSource?: HookExternalContentSource;
};
/** Mutable runtime state persisted beside the immutable cron job spec. */
type CronJobState = Omit<CronJob$1["state"], "deliverySuppressionReason" | "lastStatus"> & {
/** Exact startup catch-up slot protected from future-slot repair across restarts. */
startupCatchupAtMs?: number;
/** Exact paced completion slot protected from future-slot repair until consumed. */
pacedNextRunAtMs?: number;
/** Exact occurrence retained across a manual run; authored one-shots survive pause. */
forcePreservedNextRunAtMs?: number;
/** Durable pre-admission reservation. Cleared on restart without recording a run. */
queuedAtMs?: number;
/** Exact receipt awaiting scheduler reconciliation, even after execution authority closes. */
runningReceiptId?: string;
/** Nonce for a committed schedule edit during the pending run. */
runningScheduleChangeId?: string;
/** Unresolved recovery scope and last notified signature, when an alert was requested. */
failureAlertIncident?: {
signature?: string;
scope: "run" | "trigger";
};
/** Fences notification settlement when multiple cycles share a timestamp. */
lastFailureNotificationId?: string;
/** Number of consecutive schedule computation errors. Auto-disables job after threshold. */
scheduleErrorCount?: number;
/** @deprecated Use lastRunStatus. */
lastStatus?: "ok" | "error" | "skipped";
/** Intentional non-delivery reason for the last run, when recorded by the dispatcher. */
deliverySuppressionReason?: NormalizeReplySkipReason;
};
type CronTrigger = {
script: string;
once?: boolean;
};
/** Public cron job contract with spec fields and mutable run state. */
type CronJob = CronJobBase<CronSchedule, CronSessionTarget, CronWakeMode$1, CronPayload, CronDelivery, CronFailureAlert | false> & {
declarationKey?: string;
displayName?: string;
owner?: {
agentId?: string;
sessionKey?: string;
/** Authenticated account that created this scheduled authority envelope. */
accountId?: string;
};
/** Server-authored provenance for requester-scoped scheduled tool authority. */
scheduledToolPolicy?: CronScheduledToolPolicy;
trigger?: CronTrigger;
state: CronJobState;
};
/** Store-only proof omitted from public Gateway results and the CronJob wire/type contract. */
type CronToolsAllowProvenance = {
version: 1;
source: "final-executable-surface";
/** Store-private creator origin; missing legacy facts normalize to unknown. */
callerOrigin?: CronScheduledToolCallerOrigin;
channelRequester?: CronAuthenticatedChannelRequester;
} | ({
version: 1;
source: "authenticated-requester";
} & ({
/** Authenticated creator origin captured independently of the tool surface. */
callerOrigin: CronScheduledToolCallerOrigin;
channelRequester?: CronAuthenticatedChannelRequester;
} | {
callerOrigin?: never;
channelRequester: CronAuthenticatedChannelRequester;
}));
/** Persisted row shape; public Gateway and wire contracts use CronJob. */
type CronStoredJob = CronJob & {
/** Immutable revisions inherited from the authorized creator session, never human mutation authority. */
skillLibrarySelections?: SessionEntry$1["skillLibrarySelections"];
/** Immutable creator provenance stamped by the trusted cron creation seam. */
createdActor?: SessionCreatedActor;
toolsAllowProvenance?: CronToolsAllowProvenance;
toolsAllowExecTarget?: CronToolsAllowExecTarget;
/** Exact expected pin for jobs created from a verified host-owned exec projection. */
toolsAllowExecTargetRequirement?: CronToolsAllowExecTargetRequirement;
/** Runtime-private authority omitted from public Gateway and wire contracts. */
runtimeAuthority?: CronRuntimeAuthority;
/** Authority was explicitly cleared and must be reauthorized before app reuse. */
runtimeAuthorityRecoveryRequired?: true;
};
/** Versioned cron store file shape. */
type CronStoreFile = {
version: 1;
jobs: CronStoredJob[];
};
type CronJobStateInput = Partial<Omit<CronJobState, "autoDisabled" | "scheduleActivatedAtMs" | "streamSourceIdentity" | "runningReceiptId" | "runningScheduleChangeId">>;
/** Create input accepted by cron APIs before id/timestamps/state are assigned. */
type CronJobCreate = Omit<CronJob, "id" | "createdAtMs" | "updatedAtMs" | "state" | "scheduledToolPolicy"> & {
/** Internal callers can reserve a durable id before creation; public cron.add omits this. */
id?: string;
state?: CronJobStateInput;
};
/** Patch input accepted by cron APIs without allowing immutable identity fields. */
type CronJobPatch = Partial<Omit<CronJob, "id" | "createdAtMs" | "state" | "payload" | "delivery" | "failureAlert" | "declarationKey" | "displayName" | "owner" | "scheduledToolPolicy" | "pacing" | "trigger">> & {
displayName?: string | null;
pacing?: CronPacing | null;
trigger?: CronTrigger | null;
payload?: CronPayloadPatch;
delivery?: CronDeliveryPatch;
failureAlert?: CronFailureAlertPatch | false | null;
state?: CronJobStateInput;
};
//#endregion
//#region src/cron/service/list-page-types.d.ts
/** Enabled-state filter accepted by paginated cron listing. */
type CronJobsEnabledFilter = "all" | "enabled" | "disabled";
/** Schedule-kind filter accepted by paginated cron listing. */
type CronJobsScheduleKindFilter = "all" | "at" | "every" | "cron" | "on-exit" | "stream";
/** Last-run status filter, including jobs that have not produced a status yet. */
type CronJobsLastRunStatusFilter = "all" | CronRunStatus | "unknown";
/** Condition-trigger filter accepted by paginated cron listing. */
type CronJobsTriggerFilter = "all" | "conditional" | "unconditional";
/** Stable sort keys supported by paginated cron listing. */
type CronJobsSortBy = "nextRunAtMs" | "updatedAtMs" | "name";
/** Sort direction for paginated cron listing. */
type CronSortDir = "asc" | "desc";
/** Input contract for filtered, sorted, offset-based cron job pages. */
type CronListPageOptions = {
includeDisabled?: boolean;
limit?: number;
offset?: number;
query?: string;
enabled?: CronJobsEnabledFilter;
scheduleKind?: CronJobsScheduleKindFilter;
lastRunStatus?: CronJobsLastRunStatusFilter;
trigger?: CronJobsTriggerFilter;
sortBy?: CronJobsSortBy;
sortDir?: CronSortDir;
agentId?: string;
};
/** Offset-page result returned by cron listPage callers. */
type CronListPageResult<TJobs extends readonly CronJob[] = CronJob[]> = {
jobs: TJobs;
/** Opaque revision for the complete filtered, sorted result set. */
snapshotRevision: string;
total: number;
offset: number;
limit: number;
hasMore: boolean;
nextOffset: number | null;
};
//#endregion
//#region src/cron/service/state.d.ts
/** Direct-run mode: respect due time, force execution, or run immediately while enabled. */
type CronRunMode = "due" | "force" | "if-enabled";
/** Main-session wake strategy used after enqueuing cron text. */
type CronWakeMode = "now" | "next-heartbeat";
type CronStatusSummary = {
enabled: boolean;
triggersEnabled: boolean;
/** @deprecated Alias for `sqlitePath`. */
storePath: string;
storage: "sqlite";
/** Resolved path to the shared state SQLite database. */
sqlitePath: string;
jobs: number;
nextWakeAtMs: number | null;
};
type CronRunResult = {
ok: true;
ran: true;
} | {
ok: true;
enqueued: true;
runId: string;
} | {
ok: true;
ran: false;
reason: "disabled";
} | {
ok: true;
ran: false;
reason: "not-due";
} | {
ok: true;
ran: false;
reason: "already-running";
} | {
ok: true;
ran: false;
reason: "invalid-spec";
} | {
ok: true;
ran: false;
reason: "stopped";
} | {
ok: true;
ran: false;
reason: "ownerless";
} | {
ok: false;
};
/** Remove result, including deferred base-session cleanup after durable deletion. */
type CronRemoveResult = {
ok: true;
removed: boolean;
sessionCleanup?: "pending";
} | {
ok: false;
removed: false;
};
type CronDeclarativeAddResult = CronStoredJob & {
created: boolean;
updated?: boolean;
job: CronStoredJob;
};
type CronAddResult = CronStoredJob | CronDeclarativeAddResult;
type CronUpdateResult = CronJob;
type CronListResult = CronJob[];
type CronAddInput = CronJobCreate;
/** Caller-specific declaration-key visibility and explicit enablement metadata. */
type CronAddOptions = {
/** Selected revisions captured from a validated caller session, never public input. */
skillLibrarySelections?: CronStoredJob["skillLibrarySelections"];
matchesExisting?: (job: CronJob) => boolean;
enabledExplicit?: boolean;
/** Gateway/doctor-owned heartbeat jobs require this opt-in at service creation. */
systemOwned?: boolean;
/** Trusted creator provenance persisted with new jobs; never accepted from public input. */
createdActor?: SessionCreatedActor;
/** Authenticated caller provenance stamped by the service, never public input. */
scheduledToolPolicy?: CronScheduledToolPolicy;
/** Private proof from an authenticated agent-runtime caller. */
toolsAllowProvenance?: CronToolsAllowProvenance;
/** Restrict-only exec pin from the signed creator-turn identity. */
toolsAllowExecTarget?: CronToolsAllowExecTarget;
/** Synchronous Gateway-owned liveness guard consumed immediately before mutation. */
commitGuard?: () => void;
/** One-use fresh capture; callback presence means fresh even when it returns undefined. */
captureRuntimeAuthority?: () => CronRuntimeAuthority | undefined;
};
type CronUpdateInput = CronJobPatch;
/** Authenticated caller provenance used only when a tool policy is explicitly adopted. */
type CronUpdateOptions = Pick<CronAddOptions, "toolsAllowProvenance" | "toolsAllowExecTarget" | "commitGuard" | "captureRuntimeAuthority"> & {
/** Null forbids policy adoption; undefined retains in-process operator defaults. */
scheduledToolPolicy?: CronScheduledToolPolicy | null;
};
type CronCommitGuardOptions = {
/** Synchronous Gateway-owned guard consumed at the mutation owner. */
commitGuard?: () => void;
};
/** Cron-store-locked guard evaluated against the current job before an update applies. */
type CronUpdatePrecondition = (job: CronJob, nowMs: number) => void | Promise<void>;
//#endregion
//#region src/cron/service-contract.d.ts
type CronWakeResult = {
ok: true;
} | {
ok: false;
reason?: "unwakeable-session-key";
};
/** Result shape for direct/queued cron runs. */
type CronServiceRunResult = CronRunResult;
type CronServiceRunOptions = {
payload?: CronPayload;
/** Internal event-source runs keep their persisted trigger on force execution. */
evaluateTrigger?: boolean;
/** Current stream batch exposed to trigger scripts as trigger.streamBatch. */
streamBatch?: string;
/** Source schedule identity checked under the cron store lock before admission. */
streamScheduleKey?: string;
/** Logical source identity; rejects retired batches under same-schedule ABA. */
streamSourceIdentity?: string;
onTriggerDisposition?: (disposition: "fired" | "dropped" | "busy" | "error") => void;
/** Synchronous caller-authority guard consumed before run reservation. */
commitGuard?: () => void;
};
/** Public cron service facade used by gateway, plugin SDK, and tests. */
interface CronServiceContract {
start(): Promise<void>;
stop(): void;
status(): Promise<CronStatusSummary>;
list(opts?: {
includeDisabled?: boolean;
}): Promise<CronListResult>;
/** The in-process predicate runs under the store lock and must not mutate borrowed jobs. */
listPage(opts?: CronListPageOptions, matchesJob?: (job: CronJob) => boolean): Promise<CronListPageResult>;
add(input: CronAddInput, opts?: CronAddOptions): Promise<CronAddResult>;
update(id: string, patch: CronUpdateInput, opts?: CronUpdateOptions): Promise<CronUpdateResult>;
updateWithPrecondition(id: string, patch: CronUpdateInput, precondition: CronUpdatePrecondition, opts?: CronUpdateOptions): Promise<CronUpdateResult>;
remove(id: string, opts?: {
systemOwned?: boolean;
} & CronCommitGuardOptions): Promise<CronRemoveResult>;
run(id: string, mode?: CronRunMode, opts?: CronServiceRunOptions): Promise<CronServiceRunResult>;
enqueueRun(id: string, mode?: CronRunMode, opts?: CronCommitGuardOptions): Promise<CronServiceRunResult>;
getJob(id: string): CronJob | undefined;
readJob(id: string): Promise<CronJob | undefined>;
getDefaultAgentId(): string | undefined;
wake(opts: {
mode: CronWakeMode;
text: string;
sessionKey?: string;
agentId?: string;
}): CronWakeResult;
}
//#endregion
//#region src/plugins/gateway-events.d.ts
type OpenClawPluginGatewayEventScope = "operator.read" | "operator.write" | "operator.admin";
type OpenClawPluginSessionsChangedEvent = {
sessionKey: string;
agentId?: string;
label?: string;
displayName?: string;
reason?: string;
phase?: string;
};
type OpenClawPluginGatewayEvents = {
emit: (event: string, payload: PluginJsonValue, opts: {
scope: OpenClawPluginGatewayEventScope;
}) => void;
/**
* Native plugins can already read full session entries through the injected runtime;
* this notice only avoids polling and does not widen session access.
*/
onSessionsChanged: (handler: (event: OpenClawPluginSessionsChangedEvent) => void) => () => void;
};
//#endregion
//#region src/infra/diagnostic-trace-propagation.d.ts
type DiagnosticTracePropagationBridge$1<TEvent, TMetadata> = Readonly<{
/** Selects events that need synchronous exporter preparation. */
shouldPrepareEvent?: (event: TEvent) => boolean;
/** Prepares exporter-owned state before an outbound caller can resolve it. */
prepareEvent?: (event: TEvent, metadata: TMetadata) => void;
/** Translates a diagnostic correlation context to an exporter-owned context. */
resolveTraceContext: (traceContext: DiagnosticTraceContext) => DiagnosticTraceContext | undefined;
}>;
//#endregion
//#region src/plugins/plugin-registration.types.d.ts
type ChannelPlugin$2 = ChannelPlugin$3;
type DiagnosticTracePropagationBridge = DiagnosticTracePropagationBridge$1<DiagnosticEventPayload, DiagnosticEventMetadata>;
type PluginInteractiveHandlerResult = {
handled?: boolean;
} | void;
type PluginInteractiveRegistration<TContext = unknown, TChannel extends string = string, TResult = PluginInteractiveHandlerResult> = {
channel: TChannel;
namespace: string;
handler: (ctx: TContext) => Promise<TResult> | TResult;
};
type PluginInteractiveHandlerRegistration$1 = PluginInteractiveRegistration;
type OpenClawPluginHttpRouteAuth = "gateway" | "plugin";
type OpenClawPluginHttpRouteMatch$1 = "exact" | "prefix";
type OpenClawPluginGatewayRuntimeScopeSurface = "write-default" | "trusted-operator";
type OpenClawPluginHttpRouteHandler$1 = (req: IncomingMessage, res: ServerResponse) => Promise<boolean | void> | boolean | void;
type OpenClawPluginHttpRouteUpgradeHandler = (req: IncomingMessage, socket: Duplex, head: Buffer) => Promise<boolean | void> | boolean | void;
type OpenClawPluginHttpRouteParams = {
path: string;
handler: OpenClawPluginHttpRouteHandler$1;
handleUpgrade?: OpenClawPluginHttpRouteUpgradeHandler;
auth: OpenClawPluginHttpRouteAuth;
match?: OpenClawPluginHttpRouteMatch$1;
gatewayRuntimeScopeSurface?: OpenClawPluginGatewayRuntimeScopeSurface;
nodeCapability?: {
surface: string;
ttlMs?: number;
};
replaceExisting?: boolean;
};
type OpenClawPluginHostedMediaResolver$1 = (mediaUrl: string) => string | null | undefined | Promise<string | null | undefined>;
type WidgetPresenterContext = Readonly<{
messageChannel?: string;
accountId?: string;
deliveryContext?: Readonly<DeliveryContext>;
nativeChannelId?: string;
currentChannelId?: string;
currentMessagingTarget?: string;
sessionKey?: string;
}>;
type WidgetPresenterDocument = Readonly<{
kind: "html";
html: string;
hostedUrl?: string;
}>;
type WidgetPresentationError = {
code: "no_eligible_node";
message: string;
} | {
code: "node_error";
message: string;
nodeId?: string;
} | {
code: "unavailable";
message: string;
} | {
code: "presentation_error";
message: string;
};
type WidgetPresentationSuccess = {
kind: "node";
nodeId: string;
nodeName?: string;
} | {
kind: "message";
receipt: MessageReceipt;
};
type WidgetPresenterBase = {
description: string;
availability: (context: WidgetPresenterContext) => Promise<Result$1<{
available: true;
}, WidgetPresentationError>>;
present: (params: {
document: WidgetPresenterDocument;
title: string;
context: WidgetPresenterContext;
}) => Promise<Result$1<WidgetPresentationSuccess, WidgetPresentationError>>;
};
type WidgetPresenter = WidgetPresenterBase & ({
target: "node_panel";
match?: never;
capabilities?: never;
} | {
target: "current_channel";
match: (context: WidgetPresenterContext) => boolean;
capabilities: Readonly<{
sourceKinds: readonly string[];
maxSourceBytes?: number;
}>;
});
type OpenClawPluginCliContext = {
/**
* Command object where this plugin should register its commands.
*
* For root CLI registrations this is the root `openclaw` program. For nested
* registrations it is the resolved parent command from `parentPath`.
*/
program: Command;
parentPath: readonly string[];
config: OpenClawConfig;
workspaceDir?: string;
logger: PluginLogger$1;
};
type OpenClawPluginCliRegistrar$1 = (ctx: OpenClawPluginCliContext) => void | Promise<void>;
/**
* Top-level CLI metadata for plugin-owned commands.
*
* Descriptors are the parse-time contract for lazy plugin CLI registration.
* If you want OpenClaw to keep a plugin command lazy-loaded while still
* advertising it at the root CLI level, provide descriptors that cover every
* top-level command root registered by that plugin CLI surface.
*/
type OpenClawPluginCliCommandDescriptor = {
name: string;
description: string;
hasSubcommands: boolean;
};
/** Root-command metadata that is available before a plugin registrar is activated. */
type OpenClawPluginCliRootCommandDescriptor$1 = OpenClawPluginCliCommandDescriptor & {
machineOutput?: (params: {
argv: readonly string[];
stdoutIsTTY: boolean;
}) => boolean;
};
type OpenClawPluginRootCliRegistrationOptions = {
/** Omit or pass an empty path for root commands. */
parentPath?: readonly [];
commands?: readonly string[];
descriptors?: readonly OpenClawPluginCliRootCommandDescriptor$1[];
};
/** Backward-compatible registration shape for dynamic root or nested paths. */
type OpenClawPluginLegacyCliRegistrationOptions = {
parentPath?: readonly string[];
commands?: readonly string[];
descriptors?: readonly OpenClawPluginCliCommandDescriptor[];
};
type OpenClawPluginCliRegistrationOptions = OpenClawPluginRootCliRegistrationOptions | OpenClawPluginLegacyCliRegistrationOptions;
type OpenClawPluginNodeCliFeatureOptions = {
/** Explicit node feature command names owned under `openclaw nodes`. */
commands?: string[];
/**
* Parse-time command descriptors for lazy node feature CLI registration.
*
* Descriptors are registered under `openclaw nodes`, so a descriptor named
* `"camera"` exposes `openclaw nodes camera`.
*/
descriptors?: OpenClawPluginCliCommandDescriptor[];
};
type OpenClawPluginReloadRegistration$1 = {
restartPrefixes?: string[];
hotPrefixes?: string[];
noopPrefixes?: string[];
};
type OpenClawPluginNodeInvokeTransportResult = {
ok: true;
payload?: unknown;
payloadJSON?: string | null;
} | {
ok: false;
code?: string;
message: string;
details?: Record<string, unknown>;
};
type OpenClawPluginNodeInvokeApprovalDecision = "allow-once" | "allow-always" | "deny";
type OpenClawPluginNodeInvokePolicyApprovalRuntime = {
request: (input: {
title: string;
description: string;
scope?: ApprovalScope;
severity?: "info" | "warning" | "critical";
toolName?: string;
toolCallId?: string;
agentId?: string;
sessionKey?: string;
allowedDecisions?: readonly OpenClawPluginNodeInvokeApprovalDecision[];
timeoutMs?: number;
}) => Promise<{
id?: string;
decision?: OpenClawPluginNodeInvokeApprovalDecision | null;
}>;
};
type OpenClawPluginNodeInvokePolicyContext = {
nodeId: string;
command: string;
params: unknown;
timeoutMs?: number;
idempotencyKey?: string;
config: OpenClawConfig;
pluginConfig?: Record<string, unknown>;
node?: {
nodeId: string;
displayName?: string;
platform?: string;
deviceFamily?: string;
caps?: string[];
commands?: string[];
};
client?: {
connId?: string;
scopes?: string[];
} | null;
risk?: {
level: "ordinary" | "high";
/** Stable, content-free family name; never include user or action arguments. */
family: string;
};
approvals?: OpenClawPluginNodeInvokePolicyApprovalRuntime;
/** Full covers only the selected harness's declared node commands; undefined requires a human decision. */
invokeNodeWithSessionFull?: (input: {
workspace: OpenClawPluginNodeWorkspace;
/** Called only after the host authorizes this exact admitted Full launch. */
createParams: () => unknown;
}) => Promise<OpenClawPluginNodeInvokeTransportResult | undefined>;
invokeNode: (input?: {
params?: unknown;
/** Bind an approved launch to its admitted managed workspace, when present. */
workspace?: OpenClawPluginNodeWorkspace;
timeoutMs?: number;
idempotencyKey?: string;
}) => Promise<OpenClawPluginNodeInvokeTransportResult>;
};
type OpenClawPluginNodeInvokePolicyResult = {
ok: true;
payload?: unknown;
payloadJSON?: string | null;
} | {
ok: false;
message: string;
code?: string;
details?: Record<string, unknown>;
unavailable?: boolean;
};
type OpenClawPluginNodeInvokePolicy = {
commands: string[];
/**
* Platforms where these node-handled commands should be allowlisted by default.
* Omit for commands that require explicit `gateway.nodes.commands.allow`.
*/
defaultPlatforms?: Array<"ios" | "android" | "macos" | "windows" | "linux" | "unknown">;
/**
* Dangerous policy commands are filtered out of default allowlists unless
* explicitly allowed by config.
*/
dangerous?: boolean;
/**
* Explicitly permits one approval to cover later launches on the same managed placement.
* The scope is a stable semantic capability key, never user or action arguments.
*/
standingApproval?: {
kind: "placement";
scope: string;
};
/**
* iOS foreground-restricted commands should be queued for foreground delivery
* when an iOS node reports BACKGROUND_UNAVAILABLE.
*/
foregroundRestrictedOnIos?: boolean;
/**
* Classify exact command arguments before the policy handler or node transport runs.
* Throwing rejects the invocation before dispatch.
*/
classifyRisk?: (ctx: Pick<OpenClawPluginNodeInvokePolicyContext, "command" | "params">) => NonNullable<OpenClawPluginNodeInvokePolicyContext["risk"]>;
handle: (ctx: OpenClawPluginNodeInvokePolicyContext) => Promise<OpenClawPluginNodeInvokePolicyResult> | OpenClawPluginNodeInvokePolicyResult;
};
type OpenClawPluginSecurityAuditContext = {
config: OpenClawConfig;
sourceConfig: OpenClawConfig;
env: NodeJS.ProcessEnv;
stateDir: string;
configPath: string;
};
type OpenClawPluginSecurityAuditCollector$1 = (ctx: OpenClawPluginSecurityAuditContext) => SecurityAuditFinding[] | Promise<SecurityAuditFinding[]>;
type OpenClawGatewayDiscoveryAdvertiseContext = {
machineDisplayName: string;
gatewayPort: number;
gatewayTlsEnabled: boolean;
gatewayTlsFingerprintSha256?: string;
gatewayDirectReachable: boolean;
tailnetDns?: string;
sshPort?: number;
cliPath?: string;
minimal: boolean;
};
type OpenClawGatewayDiscoveryService$1 = {
id: string;
advertise: (ctx: OpenClawGatewayDiscoveryAdvertiseContext) => void | Promise<void | {
stop?: () => void | Promise<void>;
}>;
};
/** Context passed to long-lived plugin services. */
type OpenClawPluginServiceHealth = {
reportFailure: (error: unknown) => void;
clearFailure: () => void;
};
type OpenClawPluginServiceContext = {
config: OpenClawConfig;
workspaceDir?: string;
stateDir: string;
logger: PluginLogger$1;
serviceHealth?: OpenClawPluginServiceHealth;
/** Gateway-owned scheduler access, revoked when this service stops. */
getCron?: () => (PluginHookGatewayCronService & {
/** Admit service-owned work through the scheduler's normal run queue. */
enqueueRun?: (id: string, mode?: CronRunMode) => Promise<CronServiceRunResult>;
}) | undefined;
/** Service-owned node calls for this plugin's commands; normal node policy still applies. */
invokeNode?: (params: Omit<Parameters<PluginRuntime["nodes"]["invoke"]>[0], "scopes">) => Promise<unknown>;
/** Service-owned binary transport for this plugin's duplex node commands. */
openNodeDuplex?: (params: Omit<Parameters<PluginRuntime["nodes"]["openDuplex"]>[0], "scopes"> & {
assertCurrent?: () => void;
}) => ReturnType<PluginRuntime["nodes"]["openDuplex"]>;
gatewayEvents?: OpenClawPluginGatewayEvents;
startupTrace?: {
detail?: (name: string, metrics: ReadonlyArray<readonly [string, number | string]>) => void;
measure: <T>(name: string, run: () => T | Promise<T>) => Promise<T>;
};
internalDiagnostics?: {
/** Identity of the hosting process, available only while this service is active. */
getRuntimeIdentity?: () => {
processInstanceId: string;
buildId?: string;
};
emit: (event: DiagnosticEventInput, privateData?: DiagnosticEventPrivateData) => void;
onEvent: (listener: (event: DiagnosticEventPayload, metadata: DiagnosticEventMetadata, privateData: DiagnosticEventPrivateData) => void, filter?: InternalDiagnosticEventInterest<DiagnosticEventPayload["type"]>,
/** Defaults to true; false skips private payload copies and passes a frozen empty object. */
options?: {
includePrivateData?: boolean;
}) => () => void;
registerTracePropagationBridge?: (bridge: DiagnosticTracePropagationBridge) => () => void;
};
};
/** Background service registered by a plugin during `register(api)`. */
type OpenClawPluginService$1 = {
id: string;
/** Restart this service with committed config when one of these paths changes. */
reload?: {
configPrefixes: readonly string[];
};
start: (ctx: OpenClawPluginServiceContext) => void | Promise<void>;
stop?: (ctx: OpenClawPluginServiceContext) => void | Promise<void>;
};
type OpenClawPluginChannelRegistration = {
plugin: ChannelPlugin$2;
};
/**
* Public label exposed to plugin `register(api)` calls.
*
* Keep this as a compatibility signal for plugin authors. Loader internals
* should derive explicit capability booleans from the mode instead of branching
* on raw strings throughout the code path.
*
* - `full`: live runtime activation; long-lived side effects may start.
* - `discovery`: read-only capability discovery; skip sockets/workers/clients.
* - `tool-discovery`: capability discovery for executable tools; skip channel runtime hydration.
* - `setup-only`: lightweight channel setup entry only.
* - `setup-runtime`: setup flow that also needs the runtime channel entry.
* - `cli-metadata`: CLI command metadata collection.
*/
type PluginRegistrationMode = "full" | "discovery" | "tool-discovery" | "setup-only" | "setup-runtime" | "cli-metadata";
//#endregion
//#region src/agents/tool-fs-policy.types.d.ts
type PreparedSessionPermissionPolicy = Readonly<{
root: string;
mode: SessionPermissionMode;
}>;
/** Filesystem policy for agent tools that can touch local paths. */
type ToolFsPolicy = {
workspaceOnly: boolean;
root?: string;
/** Host-owned roots that read-only tools may consume outside the workspace. */
readOnlyRoots?: string[];
};
//#endregion
//#region src/plugins/tool-types.d.ts
type OpenClawPluginActiveModelContext = {
provider?: string;
modelId?: string;
modelRef?: string;
};
/** Current-turn outbound delivery capability bound to the host-selected route and media policy. */
type OpenClawPluginToolDelivery = {
send: (params: {
text?: string;
mediaUrl?: string;
}) => Promise<void>;
};
/** Trusted execution context passed to plugin-owned agent tool factories. */
type OpenClawPluginToolContextBase = {
config?: OpenClawConfig;
/** Active runtime-resolved config snapshot when one is available. */
runtimeConfig?: OpenClawConfig;
/** Returns the latest runtime-resolved config snapshot for long-lived tool definitions. */
getRuntimeConfig?: () => OpenClawConfig | undefined;
/** Effective filesystem policy for the active tool run. */
fsPolicy?: ToolFsPolicy;
workspaceDir?: string;
agentDir?: string;
agentId?: string;
sessionKey?: string;
/** Ephemeral session UUID - regenerated on /new and /reset. Use for per-conversation isolation. */
sessionId?: string;
/** Out-of-band plugin-owned bindings attached by the current run initiator. */
toolBindings?: Readonly<Record<string, unknown>>;
/** Host-prepared repository identities for project-aware tool behavior. */
activeProjectKeys?: readonly string[];
/** Trusted runtime-only authorization for one bounded cross-conversation recall pass. */
conversationRecall?: ConversationRecallContext;
/**
* Runtime-supplied active model metadata for informational use, diagnostics,
* and plugin-owned policy decisions. This is not a security boundary against
* the local operator, installed plugin code, or a modified OpenClaw runtime.
*/
activeModel?: OpenClawPluginActiveModelContext;
browser?: {
sandboxBridgeUrl?: string;
allowHostControl?: boolean;
};
messageChannel?: string;
agentAccountId?: string;
/** Trusted provider auth availability from the active auth profile store. */
hasAuthForProvider?: (providerId: string) => boolean;
/** Resolves an API key from the active auth profile store when available. */
resolveApiKeyForProvider?: (providerId: string) => Promise<string | undefined>;
/** Trusted ambient delivery route for the active agent/session. */
deliveryContext?: DeliveryContext;
/** Host-bound current-route delivery. Retained copies fail after the owning turn closes. */
delivery?: OpenClawPluginToolDelivery;
/** Trusted platform-native conversation id for the active inbound turn. */
nativeChannelId?: string;
/** Trusted sender id from inbound context (runtime-provided, not tool args). */
requesterSenderId?: string;
/** Trusted owner bit from inbound context (runtime-provided, not tool args). */
senderIsOwner?: boolean;
/** Live host-bound authority. Recheck inside the final synchronous effect/write guard. */
assertInvocationCurrent?: () => void;
/**
* Host-bound client-input policy. Pure synchronous guard for final storage admission;
* performs no database reads and grants no invocation or mutation authority.
* Omitted for agent-generated input. Do not apply to accepted results or cleanup.
*/
assertInputCommitAllowed?: () => void;
/**
* Server-owned origin for this operation. Missing values are delegated.
* Plugins must use it only for conversation-read visibility policy.
*/
conversationReadOrigin?: ConversationReadInvocationOrigin;
sandboxed?: boolean;
/**
* True for explicit one-shot local CLI runs that must release plugin-owned
* process resources before the command exits.
*/
oneShotCliRun?: boolean;
};
/** Version 1 is the source-compatible direct-turn context; version 2 requires final-effect authority. */
type OpenClawPluginToolContext<Version extends 1 | 2 = 1> = Version extends 2 ? OpenClawPluginToolContextBase & {
assertInvocationCurrent: () => void;
} : OpenClawPluginToolContextBase;
/** A version 2 descriptor explicitly opts into owner-authorized continuations. */
type OpenClawPluginToolFactory$1<Version extends 1 | 2 = 1> = Version extends 2 ? {
contextVersion: 2;
create: (ctx: OpenClawPluginToolContext<2>) => ReturnType<OpenClawPluginToolFactory$1>;
} : (ctx: OpenClawPluginToolContext) => AnyAgentTool | AnyAgentTool[] | null | undefined;
type OpenClawPluginToolOptions = {
name?: string;
names?: string[];
optional?: boolean;
};
type OpenClawPluginHookOptions = {
entry?: HookEntry;
name?: string;
description?: string;
register?: boolean;
};
//#endregion
//#region src/secrets/runtime-web-tools.types.d.ts
/** Diagnostic codes emitted while selecting runtime web search/fetch providers. */
type RuntimeWebDiagnosticCode = "WEB_SEARCH_PROVIDER_INVALID_AUTODETECT" | "WEB_SEARCH_AUTODETECT_SELECTED" | "WEB_SEARCH_KEY_UNRESOLVED_FALLBACK_USED" | "WEB_SEARCH_KEY_UNRESOLVED_NO_FALLBACK" | "WEB_FETCH_PROVIDER_INVALID_AUTODETECT" | "WEB_FETCH_AUTODETECT_SELECTED" | "WEB_FETCH_PROVIDER_KEY_UNRESOLVED_FALLBACK_USED" | "WEB_FETCH_PROVIDER_KEY_UNRESOLVED_NO_FALLBACK";
/** User-facing diagnostic attached to runtime web-tool metadata. */
type RuntimeWebDiagnostic = {
code: RuntimeWebDiagnosticCode;
message: string;
path?: string;
};
/** Runtime selection metadata for the web search tool. */
type RuntimeWebSearchMetadata = {
/** Provider explicitly configured in source config, before auto-detect fallback. */
providerConfigured?: string;
providerSource: "configured" | "auto-detect" | "none";
/** Provider that runtime calls should use after config validation and credential lookup. */
selectedProvider?: string;
/** Source that supplied the selected provider credential, or why it is unavailable. */
selectedProviderKeySource?: "config" | "secretRef" | "env" | "missing";
/** Perplexity transport chosen from provider config or runtime default. */
perplexityTransport?: "search_api" | "chat_completions";
diagnostics: RuntimeWebDiagnostic[];
};
/** Runtime selection metadata for the web fetch tool. */
type RuntimeWebFetchMetadata = {
/** Provider explicitly configured in source config, before auto-detect fallback. */
providerConfigured?: string;
providerSource: "configured" | "auto-detect" | "none";
/** Provider that runtime calls should use after config validation and credential lookup. */
selectedProvider?: string;
/** Source that supplied the selected provider credential, or why it is unavailable. */
selectedProviderKeySource?: "config" | "secretRef" | "env" | "missing";
diagnostics: RuntimeWebDiagnostic[];
};
//#endregion
//#region src/plugins/web-provider-types.d.ts
type WebSearchProviderToolDefinition = {
description: string;
parameters: TSchema;
execute: (args: Record<string, unknown>, context?: WebSearchProviderToolExecutionContext) => Promise<Record<string, unknown>>;
};
type WebFetchProviderToolDefinition = {
description: string;
parameters: TSchema;
execute: (args: Record<string, unknown>, context?: {
signal?: AbortSignal;
}) => Promise<Record<string, unknown>>;
};
type WebSearchProviderContext = {
config?: OpenClawConfig;
searchConfig?: Record<string, unknown>;
runtimeMetadata?: RuntimeWebSearchMetadata;
agentDir?: string;
};
type WebSearchProviderToolExecutionContext = {
signal?: AbortSignal;
/** Synchronous caller fence; non-HTTP transports must invoke it before each side effect. */
assertCurrent?: () => void;
};
type WebFetchProviderContext = {
config?: OpenClawConfig;
fetchConfig?: Record<string, unknown>;
runtimeMetadata?: RuntimeWebFetchMetadata;
};
type WebSearchCredentialResolutionSource = "config" | "secretRef" | "env" | "missing";
type WebProviderConfiguredCredentialFallback = {
path: string;
value: unknown;
};
type WebSearchRuntimeMetadataContext = {
config?: OpenClawConfig;
searchConfig?: Record<string, unknown>;
runtimeMetadata?: RuntimeWebSearchMetadata;
resolvedCredential?: {
value?: string;
source: WebSearchCredentialResolutionSource;
fallbackEnvVar?: string;
};
};
type WebSearchProviderSetupContext = {
config: OpenClawConfig;
runtime: RuntimeEnv;
prompter: WizardPrompter;
quickstartDefaults?: boolean;
secretInputMode?: SecretInputMode;
};
type WebFetchCredentialResolutionSource = "config" | "secretRef" | "env" | "missing";
type WebFetchRuntimeMetadataContext = {
config?: OpenClawConfig;
fetchConfig?: Record<string, unknown>;
runtimeMetadata?: RuntimeWebFetchMetadata;
resolvedCredential?: {
value?: string;
source: WebFetchCredentialResolutionSource;
fallbackEnvVar?: string;
};
};
type WebProviderPluginBase = {
id: string;
label: string;
hint: string;
requiresCredential?: boolean;
credentialLabel?: string;
envVars: string[];
placeholder: string;
signupUrl: string;
docsUrl?: string;
autoDetectOrder?: number;
credentialPath: string;
inactiveSecretPaths?: string[];
getCredentialValue: (config?: Record<string, unknown>) => unknown;
setCredentialValue: (configTarget: Record<string, unknown>, value: unknown) => void;
getConfiguredCredentialValue?: (config?: OpenClawConfig) => unknown;
setConfiguredCredentialValue?: (configTarget: OpenClawConfig, value: unknown) => void;
getConfiguredCredentialFallback?: (config?: OpenClawConfig) => WebProviderConfiguredCredentialFallback | undefined;
applySelectionConfig?: (config: OpenClawConfig) => OpenClawConfig;
};
type WebSearchProviderPlugin$1 = WebProviderPluginBase & {
/** Settings subtree relative to this plugin's config; null hides inline settings. Defaults to ["webSearch"]. */
configPath?: readonly string[] | null;
onboardingScopes?: readonly "text-inference"[];
/** Optional model-provider auth profile id that can satisfy this web provider without a tool-specific API key. */
authProviderId?: string;
/** Optional note shown before credential collection for provider-specific prerequisites. */
credentialNote?: string;
runSetup?: (ctx: WebSearchProviderSetupContext) => OpenClawConfig | Promise<OpenClawConfig>;
resolveRuntimeMetadata?: (ctx: WebSearchRuntimeMetadataContext) => Partial<RuntimeWebSearchMetadata> | Promise<Partial<RuntimeWebSearchMetadata>>;
createTool: (ctx: WebSearchProviderContext) => WebSearchProviderToolDefinition | null;
};
type PluginWebSearchProviderEntry = WebSearchProviderPlugin$1 & {
pluginId: string;
};
type WebFetchProviderPlugin$1 = WebProviderPluginBase & {
resolveRuntimeMetadata?: (ctx: WebFetchRuntimeMetadataContext) => Partial<RuntimeWebFetchMetadata> | Promise<Partial<RuntimeWebFetchMetadata>>;
createTool: (ctx: WebFetchProviderContext) => WebFetchProviderToolDefinition | null;
};
//#endregion
//#region src/plugins/plugin-api.types.d.ts
type ChannelPlugin$1 = ChannelPlugin$3;
type PluginTextTransformRegistration$1 = PluginTextTransforms;
type OpenClawPluginSessionStateApi = {
/** Register plugin-owned session state projected into Gateway session rows. */
registerSessionExtension: (extension: PluginSessionExtensionRegistration) => void;
};
type OpenClawPluginSessionWorkflowApi = {
/** Queue one plugin-owned context injection for the next agent turn in a session. */
enqueueNextTurnInjection: (injection: PluginNextTurnInjection) => Promise<PluginNextTurnInjectionEnqueueResult>;
/**
* Register cleanup metadata for a plugin-owned session scheduler job.
* This does not schedule work or create task records; it only lets the host
* clean external scheduler state during reset/delete/disable.
*/
registerSessionSchedulerJob: (job: PluginSessionSchedulerJobRegistration) => PluginSessionSchedulerJobHandle | undefined;
/** Send host-validated files to the active direct-outbound route for a session. */
sendSessionAttachment: (params: PluginSessionAttachmentParams) => Promise<PluginSessionAttachmentResult>;
/**
* Schedule a future agent turn in a session through Cron.
* Cron owns timing and records the run history when the turn runs.
*/
scheduleSessionTurn: (params: PluginSessionTurnScheduleParams) => Promise<PluginSessionSchedulerJobHandle | undefined>;
/** Remove Cron-backed scheduled session turns that share a plugin-owned tag. */
unscheduleSessionTurnsByTag: (params: PluginSessionTurnUnscheduleByTagParams) => Promise<PluginSessionTurnUnscheduleByTagResult>;
};
type OpenClawPluginSessionControlsApi = {
/** Register a typed session action that clients can dispatch through the Gateway. */
registerSessionAction: (action: PluginSessionActionRegistration) => void;
/** Register a generic Control UI contribution descriptor. */
registerControlUiDescriptor: (descriptor: PluginControlUiDescriptor) => void;
};
type OpenClawPluginSessionApi = {
state: OpenClawPluginSessionStateApi;
workflow: OpenClawPluginSessionWorkflowApi;
controls: OpenClawPluginSessionControlsApi;
};
type OpenClawPluginAgentEventsApi = {
/** Subscribe to sanitized agent events through the host-owned plugin lifecycle. */
registerAgentEventSubscription: (subscription: PluginAgentEventSubscriptionRegistration) => void;
/** Emit a host-routed, plugin-attributed event for workflow/UI subscribers. */
emitAgentEvent: (params: PluginAgentEventEmitParams) => PluginAgentEventEmitResult;
};
type OpenClawPluginAgentApi = {
events: OpenClawPluginAgentEventsApi;
};
type OpenClawPluginRunContextApi = {
/** Store namespaced, JSON-compatible data for the active run. Cleared on run end/error. */
setRunContext: (patch: PluginRunContextPatch) => boolean;
/** Read namespaced plugin data for a run. */
getRunContext: (params: PluginRunContextGetParams) => PluginJsonValue | undefined;
/** Clear one namespace or all namespaces this plugin owns for a run. */
clearRunContext: (params: {
runId: string;
namespace?: string;
}) => void;
};
type OpenClawPluginLifecycleApi = Partial<PluginInstanceLifecycle> & {
/** Register cleanup hooks for plugin-owned host state and background work. */
registerRuntimeLifecycle: (lifecycle: PluginRuntimeLifecycleRegistration) => void;
};
/**
* Main registration API injected into native plugin entry files.
* @experimental All plugin APIs are experimental. Pin and test OpenClaw host versions.
* @see https://docs.openclaw.ai/plugins/sdk-overview#api-stability
*/
type OpenClawPluginApi = {
id: string;
name: string;
version?: string;
description?: string;
source: string;
/** Selected runtime entrypoint, independent of setup; absent without runtime artifact selection. */
readonly runtimeSource?: string;
rootDir?: string;
registrationMode: PluginRegistrationMode;
config: OpenClawConfig;
pluginConfig?: Record<string, unknown>;
/**
* In-process runtime helpers for trusted native plugins.
*
* This surface is broader than hooks. Prefer hooks for third-party
* automation/integration unless you need native registry integration.
*/
runtime: PluginRuntime;
logger: PluginLogger$1;
/**
* Grouped facade over the existing flat session-related plugin API.
* Flat methods remain supported for compatibility.
*/
session: OpenClawPluginSessionApi;
/** Grouped facade for agent-event workflow seams. */
agent: OpenClawPluginAgentApi;
/** Grouped facade for run-scoped plugin scratch state. */
runContext: OpenClawPluginRunContextApi;
/** Grouped facade for plugin-owned lifecycle cleanup hooks. */
lifecycle: OpenClawPluginLifecycleApi;
registerTool: (tool: AnyAgentTool | OpenClawPluginToolFactory$1 | OpenClawPluginToolFactory$1<2>, opts?: OpenClawPluginToolOptions) => void;
registerHook: (events: string | string[], handler: InternalHookHandler, opts?: OpenClawPluginHookOptions) => void;
registerHttpRoute: (params: OpenClawPluginHttpRouteParams) => void;
/** Register a plugin-owned resolver for browser-style hosted media URLs. */
registerHostedMediaResolver: (resolver: OpenClawPluginHostedMediaResolver$1) => void;
/** Register a plugin-owned destination for presenting hosted widget documents. */
registerWidgetPresenter: (presenter: WidgetPresenter) => void;
/** Bind a declared MCP server's transport to the trusted message requester. */ registerMcpServerConnectionResolver: (resolver: OpenClawPluginMcpServerConnectionResolver) => void;
/** Register a native messaging channel plugin (channel capability). */
registerChannel: (registration: OpenClawPluginChannelRegistration | ChannelPlugin$1) => void;
/**
* Register a gateway RPC method for this plugin.
*
* Reserved core admin namespaces (`config.*`, `exec.approvals.*`,
* `wizard.*`, `update.*`) always normalize to `operator.admin` even if a
* narrower scope is requested.
*/
registerGatewayMethod: (method: string, handler: GatewayRequestHandler, opts?: {
scope?: OperatorScope;
profileAccess?: "independent" | "required";
/** Require a top-level sessionKey (and optional agentId) naming an existing session. */
sessionAccess?: GatewayMethodSessionAccess;
}) => void;
/** Add a plugin-owned lifetime requirement to authenticated person admission. */
registerGatewayAccessPolicy: (policy: PluginGatewayAccessPolicy) => void;
/** Register a sandboxed board widget source kind owned by this plugin. */
registerBoardWidgetContentKind: (definition: PluginBoardWidgetContentKind) => void;
/** Register a read-only external-session catalog with optional native adoption actions. */
registerSessionCatalog: (provider: SessionCatalogProvider) => void;
registerCli: (registrar: OpenClawPluginCliRegistrar$1, opts?: OpenClawPluginCliRegistrationOptions) => void;
/**
* Register a plugin-owned node feature command group under `openclaw nodes`.
*
* This is equivalent to `registerCli(registrar, { parentPath: ["nodes"], ... })`
* and is intended for paired-node capabilities such as camera, screen, or Canvas.
*/
registerNodeCliFeature: (registrar: OpenClawPluginCliRegistrar$1, opts?: OpenClawPluginNodeCliFeatureOptions) => void;
registerReload: (registration: OpenClawPluginReloadRegistration$1) => void;
registerNodeHostCommand: (command: OpenClawPluginNodeHostCommand) => void;
registerNodeInvokePolicy: (policy: OpenClawPluginNodeInvokePolicy) => void;
registerSecurityAuditCollector: (collector: OpenClawPluginSecurityAuditCollector$1) => void;
registerService: (service: OpenClawPluginService$1) => void;
/** Register a local gateway discovery advertiser such as mDNS/Bonjour. */
registerGatewayDiscoveryService: (service: OpenClawGatewayDiscoveryService$1) => void;
/** Register a text-only CLI backend used by the local CLI runner. */
registerCliBackend: (backend: CliBackendPlugin$1) => void;
/** Register plugin-owned prompt/message compatibility text transforms. */
registerTextTransforms: (transforms: PluginTextTransformRegistration$1) => void;
/** Register a lightweight config migration that can run before plugin runtime loads. */
registerConfigMigration: (migrate: PluginConfigMigration) => void;
/** Register an importer for `openclaw migrate` (migration capability). */
registerMigrationProvider: (provider: MigrationProviderPlugin$1) => void;
/** Register a lightweight config probe that can auto-enable this plugin generically. */
registerAutoEnableProbe: (probe: PluginSetupAutoEnableProbe) => void;
/** Register a native model/provider plugin (text inference capability). */
registerProvider: (provider: ProviderPlugin) => void;
/** Register a cloud-worker lifecycle provider. */
registerWorkerProvider: (provider: WorkerProvider$1) => void;
/** Register provider-owned model catalog rows for text and media generation. */
registerModelCatalogProvider: (provider: UnifiedModelCatalogProviderPlugin$1) => void;
/** Register a general embedding provider (embedding capability). */
registerEmbeddingProvider: (adapter: EmbeddingProviderAdapter) => void;
/** Register a speech descriptor or synchronous factory bound to native host operations. */
registerSpeechProvider: (provider: SpeechProviderPlugin$1 | ((context: PluginCapabilityCatalogHostContext) => SpeechProviderPlugin$1)) => void;
/** Register a transcription descriptor or synchronous factory bound to native host operations. */
registerRealtimeTranscriptionProvider: (provider: RealtimeTranscriptionProviderPlugin$1 | ((context: PluginCapabilityCatalogHostContext) => RealtimeTranscriptionProviderPlugin$1)) => void;
/** Register a voice descriptor or synchronous factory bound to native host operations. */
registerRealtimeVoiceProvider: (provider: RealtimeVoiceProviderPlugin$1 | ((context: PluginCapabilityCatalogHostContext) => RealtimeVoiceProviderPlugin$1)) => void;
/** Register a media understanding provider (media understanding capability). */
registerMediaUnderstandingProvider: (provider: MediaUnderstandingProviderPlugin$1) => void;
/** Register a transcripts source provider (live or imported meeting transcript capability). */
registerTranscriptSourceProvider: (provider: TranscriptSourceProvider$1) => void;
/** Register an image generation provider (image generation capability). */
registerImageGenerationProvider: (provider: ImageGenerationProviderPlugin$1) => void;
/** Register a video generation provider (video generation capability). */
registerVideoGenerationProvider: (provider: VideoGenerationProviderPlugin$1) => void;
/** Register a music generation provider (music generation capability). */
registerMusicGenerationProvider: (provider: MusicGenerationProviderPlugin$1) => void;
/** Register a web fetch provider (web fetch capability). */
registerWebFetchProvider: (provider: WebFetchProviderPlugin$1) => void;
/** Register a web search provider (web search capability). */
registerWebSearchProvider: (provider: WebSearchProviderPlugin$1) => void;
registerInteractiveHandler: (registration: PluginInteractiveHandlerRegistration$1) => void;
onConversationBindingResolved: (handler: (event: PluginConversationBindingResolvedEvent$1) => void | Promise<void>) => void;
/**
* Register a custom command that bypasses the LLM agent.
* Plugin commands are processed before built-in commands and before agent invocation.
* Use this for simple state-toggling or status commands that don't need AI reasoning.
*/
registerCommand: (command: OpenClawPluginCommandDefinition$1) => void;
/** Register a context engine implementation (exclusive slot - only one active at a time). */
registerContextEngine: (id: string, factory: ContextEngineFactory) => void;
/** Register one version 1 typed decision provider declared in the manifest. */
registerDecisionProvider: (provider: DecisionProviderV1) => void;
/** Register a compaction provider (pluggable summarization backend). */
registerCompactionProvider: (provider: CompactionProvider) => void;
/** Register an agent harness implementation. */
registerAgentHarness: (harness: AgentHarness, options?: AgentHarnessRegistrationOptions) => void;
/**
* Register a Codex app-server extension factory for Codex harness tool-result
* middleware. Only bundled plugins may use this seam, and
* `contracts.embeddedExtensionFactories` must include `"codex-app-server"`.
*/
registerCodexAppServerExtensionFactory: (factory: CodexAppServerExtensionFactory) => void;
/**
* Register runtime-neutral tool-result middleware. Declare
* `contracts.agentToolResultMiddleware` for every targeted runtime.
*/
registerAgentToolResultMiddleware: (handler: AgentToolResultMiddleware, options?: AgentToolResultMiddlewareOptions) => void;
/**
* Register plugin-owned session state that can be projected into Gateway session rows.
* @deprecated Use `api.session.state.registerSessionExtension(...)`.
*/
registerSessionExtension: OpenClawPluginSessionStateApi["registerSessionExtension"];
/**
* Queue one plugin-owned context injection for the next agent turn in a session.
* @deprecated Use `api.session.workflow.enqueueNextTurnInjection(...)`.
*/
enqueueNextTurnInjection: OpenClawPluginSessionWorkflowApi["enqueueNextTurnInjection"];
/**
* Register a trusted pre-tool policy. Installed plugins must declare the
* policy id in `contracts.trustedToolPolicies`.
*/
registerTrustedToolPolicy: (policy: PluginTrustedToolPolicyRegistration) => void;
/**
* Register display/policy metadata for a plugin-owned tool. Metadata is
* scoped to the (pluginId, toolName) pair at projection time, so plugins
* cannot decorate other plugins' tools or core tools through this surface.
*/
registerToolMetadata: (metadata: PluginToolMetadataRegistration) => void;
/**
* Register a generic Control UI contribution descriptor.
* @deprecated Use `api.session.controls.registerControlUiDescriptor(...)`.
*/
registerControlUiDescriptor: OpenClawPluginSessionControlsApi["registerControlUiDescriptor"];
/**
* Register cleanup hooks for plugin-owned host state and background work.
* @deprecated Use `api.lifecycle.registerRuntimeLifecycle(...)`.
*/
registerRuntimeLifecycle: OpenClawPluginLifecycleApi["registerRuntimeLifecycle"];
/**
* Subscribe to sanitized agent events through the host-owned plugin lifecycle.
* @deprecated Use `api.agent.events.registerAgentEventSubscription(...)`.
*/
registerAgentEventSubscription: OpenClawPluginAgentEventsApi["registerAgentEventSubscription"];
/**
* Emit a host-routed, plugin-attributed agent event for workflow/UI subscribers.
* @deprecated Use `api.agent.events.emitAgentEvent(...)`.
*/
emitAgentEvent: OpenClawPluginAgentEventsApi["emitAgentEvent"];
/**
* Store namespaced, JSON-compatible data for the active run. Cleared on run end/error.
* @deprecated Use `api.runContext.setRunContext(...)`.
*/
setRunContext: OpenClawPluginRunContextApi["setRunContext"];
/**
* Read namespaced plugin data for a run.
* @deprecated Use `api.runContext.getRunContext(...)`.
*/
getRunContext: OpenClawPluginRunContextApi["getRunContext"];
/**
* Clear one namespace or all namespaces this plugin owns for a run.
* @deprecated Use `api.runContext.clearRunContext(...)`.
*/
clearRunContext: OpenClawPluginRunContextApi["clearRunContext"];
/**
* Register cleanup metadata for a plugin-owned session scheduler job.
* This does not schedule work or create task records; it only lets the host
* clean external scheduler state during reset/delete/disable.
*
* @deprecated Use `api.session.workflow.registerSessionSchedulerJob(...)`.
*/
registerSessionSchedulerJob: OpenClawPluginSessionWorkflowApi["registerSessionSchedulerJob"];
/**
* Register a typed session action that clients can dispatch through the Gateway.
* @deprecated Use `api.session.controls.registerSessionAction(...)`.
*/
registerSessionAction: OpenClawPluginSessionControlsApi["registerSessionAction"];
/**
* Send one or more host-validated files to the active direct-outbound channel for a session.
*
* This API is intended for bundled plugins running with the host channel/session
* integration available. Calls may resolve to `{ ok: false }` instead of attaching
* files when global side effects are disabled or when the required plugin/channel
* runtime is not loaded, so callers must handle rejection via the returned result.
*
* @deprecated Use `api.session.workflow.sendSessionAttachment(...)`.
*/
sendSessionAttachment: OpenClawPluginSessionWorkflowApi["sendSessionAttachment"];
/**
* Schedule a future agent turn in a session through Cron.
* Cron owns timing and records the run history when the turn runs.
* Bundled plugins only; workspace plugins receive undefined.
*
* @deprecated Use `api.session.workflow.scheduleSessionTurn(...)`.
*/
scheduleSessionTurn: OpenClawPluginSessionWorkflowApi["scheduleSessionTurn"];
/**
* Remove Cron-backed scheduled session turns that share the same plugin-owned tag.
* Bundled plugins only; workspace plugins receive a zero-count result.
*
* @deprecated Use `api.session.workflow.unscheduleSessionTurnsByTag(...)`.
*/
unscheduleSessionTurnsByTag: OpenClawPluginSessionWorkflowApi["unscheduleSessionTurnsByTag"];
/** Register the active memory capability for this memory plugin (exclusive slot). */
registerMemoryCapability: (capability: MemoryPluginCapability) => void;
/** Register an additive memory-adjacent prompt section (non-exclusive). */
registerMemoryPromptSupplement: (builder: MemoryPromptSectionBuilder) => void;
/** Register an async memory prompt preparation step (non-exclusive). */
registerMemoryPromptPreparation: (prepare: (params: MemoryPromptSectionParams) => Promise<readonly string[]>) => void;
/** Register an additive memory-adjacent search/read corpus supplement (non-exclusive). */
registerMemoryCorpusSupplement: (supplement: MemoryCorpusSupplement) => void;
resolvePath: (input: string) => string;
/** Register a lifecycle hook handler */
on: <K extends PluginHookName>(hookName: K, handler: PluginHookHandlerMap[K], opts?: PluginHookRegistrationOptions<K>) => void;
};
//#endregion
//#region src/gateway/server-channel-runtime.types.d.ts
type ChannelRuntimeSnapshotOptions = {
channelId?: ChannelId$1;
/** Controls read recorded state without invoking fallible diagnostic inspectors. */
inspectAccounts?: boolean;
};
/** Snapshot of channel runtime state keyed by channel and account id. */
type ChannelRuntimeSnapshot = {
/** Host admission is paused; status must use captured facts without invoking plugin callbacks. */
reloadingChannels?: ReadonlyMap<ChannelId$1, string | undefined>;
channels: Partial<Record<ChannelId$1, ChannelAccountSnapshot>>;
channelAccounts: Partial<Record<ChannelId$1, Record<string, ChannelAccountSnapshot>>>;
};
/** The lifecycle owner's decision for one requested account start, separate from connectivity. */
type ChannelAccountStartOutcome = {
status: "handed-off";
} | {
status: "retry";
reason: "stop-in-flight" | "task-owned";
} | {
status: "skipped";
reason: "unsupported" | "autostart-suppressed" | "ambient-suppressed" | "disabled" | "unconfigured" | "secret-unavailable" | "unlinked" | "manual-stop";
};
type StartChannelOptions = {
preserveRestartAttempts?: boolean;
preserveManualStop?: boolean;
/** Reload leaves snapshot-cold accounts stopped without bypassing credential-file reinspection. */
skipUnavailableAccounts?: boolean;
deferAccountStartUntil?: Promise<void>;
manual?: boolean;
};
//#endregion
//#region src/gateway/server-public.d.ts
type GatewayShutdownBudget = {
timeoutMs: number;
reserveMs: number;
nativeStopBudget: boolean;
};
/** A capability for one host iteration; native completion belongs to the host. */
type GatewayHostLifecycle = {
/** Present only when this host owns process exit; the identity never crosses RPC. */
externalRestart?: GatewaySuspendHandoffOwner;
getShutdownBudget?(): GatewayShutdownBudget | undefined;
request(action: "start" | "stop" | "restart", assertCaller: () => void): Promise<Result$1<{
outcome: "already-running" | "scheduled";
}, string>>;
};
//#endregion
//#region src/gateway/server-request-entry.d.ts
type RequestEntryOptions = Pick<GatewayRequestOptions, "client" | "context"> & {
req: Pick<GatewayRequestOptions["req"], "method" | "params">;
};
type GatewayRequestEntry = {
assertOpen: () => void;
release: () => void;
};
/** One Gateway's preparation leases; handler execution belongs to its existing runtime owner. */
declare class GatewayRequestEntryLifetime {
private readonly stopping;
private readonly active;
private sealed;
readonly signal: AbortSignal;
enter(options: RequestEntryOptions): GatewayRequestEntry;
beginClose(): void;
waitForPendingEntries(): Promise<void>;
sealAndJoin(): Promise<void>;
}
//#endregion
//#region src/gateway/expected-profile.d.ts
/** Request-local selection precondition, independent of socket and accepted-run lifetime. */
declare function createExpectedProfileBinding(expectedProfileId: string | undefined, client: GatewayClient | null, assertRequestCurrent?: () => void): Promise<{
assertCurrent: () => void;
/** Compare a profile resolved by the storage owner on its transaction connection. */
assertMatchesResolvedProfile: (profileId: string | undefined) => void;
markInvoked: () => void;
guardResponse: (respond: RespondFn) => RespondFn;
} | undefined>;
type ExpectedProfileBinding = NonNullable<Awaited<ReturnType<typeof createExpectedProfileBinding>>>;
//#endregion
//#region src/gateway/talk/session-target.types.d.ts
type PreparedTalkSessionTarget = Readonly<{
agentId: string;
/** Voice records and close/resume retain the client's exact key, not its storage alias. */
sessionKey: string;
canonicalKey: string;
storePath: string;
}>;
//#endregion
//#region src/gateway/session-access-authority.d.ts
type RetainedGatewaySessionAccess = {
readonly signal: AbortSignal;
assertCurrent: () => void;
release: () => void;
};
type GatewaySessionAccessAuthority = {
readonly target: Readonly<{
agentId: string;
sessionKey: string;
sessionId: string;
lifecycleRevision?: string;
}>;
readonly sandboxRequired: boolean;
/** Invocation guard, including the admitted model turn when applicable. */
assertCurrent: () => void;
/** Retain original actor, grant, sharing and tool policy for a viewer or accepted operation. */
retain: () => RetainedGatewaySessionAccess;
/** Session resource lifetime only. Revoking one collaborator must not destroy shared state. */
retainSession: () => RetainedGatewaySessionAccess;
/** Router-owned preparation hold; each service borrow has its own release. */
release: () => void;
};
//#endregion
//#region src/cli/outbound-send-mapping.d.ts
type CliOutboundSendSource = {
[channelId: string]: unknown;
};
//#endregion
//#region src/cli/deps.types.d.ts
/** CLI dependency bag currently used by outbound send command plumbing. */
type CliDeps = CliOutboundSendSource;
//#endregion
//#region src/gateway/agent-runtime-approval-authority.d.ts
type AgentRuntimeApprovalAuthorityValidator = (identity: AgentRuntimeIdentity) => boolean;
//#endregion
//#region src/gateway/server-in-process-dispatch.types.d.ts
type GatewayMethodDispatchResponse = {
ok: boolean;
payload?: unknown;
error?: ErrorShape;
meta?: Record<string, unknown>;
};
//#endregion
//#region src/gateway/server-methods/agent-request-types.d.ts
type AgentRunRequest = Omit<Static<typeof AgentParamsSchema>, "attachments" | "internalEvents" | "inputProvenance"> & {
attachments?: Array<{
type?: string;
mimeType?: string;
fileName?: string;
content?: unknown;
}>;
internalEvents?: AgentInternalEvent[];
inputProvenance?: InputProvenance;
workspaceDir?: string;
};
//#endregion
//#region src/gateway/agent-turn/internal-facade.types.d.ts
type InternalAgentTurnPrincipalOptions = {
assertContextCurrent?: () => void;
client: GatewayClient;
isWebchatConnect?: (params: ConnectParams | null | undefined) => boolean;
};
type AgentTurnStartOwner = {
observe: () => {
executionStarted: boolean;
expiresAtMs: number;
} | undefined;
abort: () => boolean;
};
/** A live frozen settle cohort may identify an already accepted legacy source. */
type RequesterSettleWakeReplay = {
sourceSessionKeys: readonly string[];
assertCurrent: () => void;
};
type InternalAgentTurnDispatchOptions = {
/** Internal completion delivery owns its hidden input and durable processing receipt. */
privateCompletion?: true;
settleWakeReplay?: RequesterSettleWakeReplay;
assertAdmissionCurrent?: () => void;
cancelOnDeadline?: boolean;
expectFinal?: boolean;
onAccepted?: (payload: unknown) => void;
onStartOwner?: (owner: AgentTurnStartOwner) => void;
onExecutionStarted?: () => void;
onSignalAbort?: () => Promise<void> | void;
signal?: AbortSignal;
timeoutMs?: number;
};
type InternalAgentTurnFacade = {
dispatch: <T = unknown>(request: AgentRunRequest, options?: InternalAgentTurnDispatchOptions | number) => Promise<T>;
dispatchRaw: (request: AgentRunRequest, options?: InternalAgentTurnDispatchOptions) => Promise<GatewayMethodDispatchResponse>;
wait: <T = unknown>(params: AgentWaitParams, timeoutMs?: number, signal?: AbortSignal, onSignalAbort?: () => Promise<void> | void) => Promise<T>;
};
type InternalAgentTurnFacadeFactory = (principal: InternalAgentTurnPrincipalOptions) => InternalAgentTurnFacade | Promise<InternalAgentTurnFacade>;
//#endregion
//#region src/gateway/chat-abort.types.d.ts
type ChatTerminalProducer = {
sessionId: string;
sessionKey: string;
handoff: (settle: (producerCompleted: Promise<void>) => Promise<void>) => boolean;
};
type ChatAbortControllerEntry = {
controller: AbortController;
/** Captures this run's canonical producer before cancellation releases its live slot. */
resolveTerminalProducer?: () => ChatTerminalProducer | undefined;
sessionId: string;
sessionKey: string;
lifecycleGeneration?: string;
/** Exact operational instance created by this controller registration. */
operationalRunInstance?: OperationalRunInstanceRef;
/** Exact approval lease captured when this controller's execution was admitted. */
agentRunDelegatedAuthority?: AgentRunDelegatedAuthority;
agentId?: string;
startedAtMs: number;
/** False until lane admission reaches the execution boundary. */
executionStarted?: boolean;
expiresAtMs: number;
ownerConnId?: string;
ownerDeviceId?: string;
providerId?: string;
authProviderId?: string;
abortStopReason?: string;
/** Owner-recorded diagnostic cause; does not change terminal lifecycle semantics. */
abortDiagnosticReason?: ChatAbortDiagnosticReason;
/** Latest argument-free validation diagnostic for operator-initiated aborts. */
toolErrorSummary?: string;
/**
* False for backend/internal agent runs that may share a session key but must
* not be projected into operator chat surfaces.
*/
controlUiVisible?: boolean;
/**
* Controls only the sessions.list active-run projection. Terminal lifecycle
* clears this before chat.send settles, while the entry stays as the retry
* idempotency guard until normal cleanup removes it.
*/
projectSessionActive?: boolean;
/** True after the terminal session-store update has completed. */
projectSessionTerminalPersisted?: boolean;
/** A terminal lifecycle event was observed and is awaiting persistence. */
projectSessionTerminalPending?: boolean;
/** Store timestamp expected from the observed terminal lifecycle event. */
projectSessionTerminalObservedAt?: number;
/** In-flight terminal session-store update used by restart shutdown. */
projectSessionTerminalPersistence?: Promise<void>;
/** Caller completion requested cleanup before terminal lifecycle persistence settled. */
registrationCleanupRequested?: boolean;
/** Bounded private timeout settlement while the aborted producer unwinds. */
pendingTimeoutCompletion?: {
expiresAtMs: number;
settle: () => void;
};
/** False after the owning reply run commits a terminal outcome. */
isAbortable?: (entry: ChatAbortControllerEntry) => boolean;
/** Runs once when this registration is actually removed. */
onRemoved?: () => void;
/**
* Which RPC owns this registration. Absent (undefined) is treated as
* `"chat-send"` so pre-existing callers that constructed entries without
* a kind keep their behavior. Consumers that need "chat.send specifically
* is active" must check `kind !== "agent"`, not just `.has(runId)`.
*/
kind?: "chat-send" | "agent";
/** Side questions stay independent from main-turn TUI session stops. */
turnKind?: "main" | "btw";
};
//#endregion
//#region src/gateway/config-reload-status.types.d.ts
type GatewayHotReloadStatus = "active" | "disabled";
/** Channel reload work currently waiting for active Gateway work to drain. */
type GatewayDeferredChannelReload = {
channel: string;
/** False when plugin publication committed before newly activated channels wait to start. */
publicationPending: boolean;
};
//#endregion
//#region src/gateway/config-revision-token.d.ts
type GatewayConfigRevisionProjector = {
projectRawHash: (hash: string) => string;
projectResolvedHash: (hash: string) => string;
hashResponseSessionBearer: (bearer: string) => string;
};
//#endregion
//#region src/gateway/device-scope-upgrade.d.ts
type UpgradeOwner = {
deviceId: string;
publicKey: string;
};
/** Coordinates live device scope-upgrade waiters with the durable pairing store. */
declare class ScopeUpgradeCoordinator {
private readonly scheduler;
private readonly entries;
private readonly work;
private lifetimeBound;
constructor(scheduler: GatewayScheduler);
private bindGatewayLifetime;
close(): Promise<void>;
register(params: {
requestId: string;
expiresAtMs: number;
owner: UpgradeOwner;
requestedScopes: string[];
initialToken?: string;
initialApprovedAtMs?: number;
}): boolean;
notify(requestId: string, resolution: "approved" | "rejected"): void;
wait(requestId: string, owner: UpgradeOwner): Promise<ScopeUpgradeResult | null>;
private waitForResult;
private readDurableResult;
private retainTerminal;
}
//#endregion
//#region src/gateway/operator-approval-placement-grants.d.ts
type PlacementStandingGrantMintSpec = NonNullable<PluginApprovalRequestPayload["placementGrant"]>;
type PlacementStandingGrantRecord = PlacementStandingGrantMintSpec & {
mintedByApprovalId: string;
expiresAtMs: number;
};
type ConsumePlacementStandingGrantResult = {
outcome: "consumed";
grant: PlacementStandingGrantRecord;
} | {
outcome: "no-grant" | "expired" | "approval-missing" | "approval-not-allow-always" | "placement-missing" | "placement-changed" | "node-changed" | "pairing-changed";
};
type PlacementGrantResolutionInput = Pick<PlacementStandingGrantMintSpec, "pluginId" | "command" | "approvalScope" | "agentId" | "sessionKey" | "nodeId" | "pairingGeneration">;
type PlacementStandingGrantRuntime = {
resolveBinding: (input: PlacementGrantResolutionInput) => PlacementStandingGrantMintSpec | null;
retain: (grant: PlacementStandingGrantMintSpec & {
approvalId: string;
nowMs: number;
expiresAtMs: number | null;
}) => boolean;
validate: (binding: PlacementStandingGrantMintSpec) => ConsumePlacementStandingGrantResult;
consume: (binding: PlacementStandingGrantMintSpec) => ConsumePlacementStandingGrantResult;
};
//#endregion
//#region src/gateway/operator-approval-standing-grants.types.d.ts
/** Cron identity plus exact operation binding recorded at approval creation. */
type CronStandingGrantMintSpec = {
agentId: string;
cronJobId: string;
jobConfigRevision: string;
operationBinding: string;
};
//#endregion
//#region src/gateway/operator-approval-store.types.d.ts
type OperatorApprovalKind = "exec" | "plugin" | "system-agent";
type OperatorApprovalStatus = "pending" | "allowed" | "denied" | "expired" | "cancelled";
type OperatorApprovalDecision = "allow-once" | "allow-always" | "deny";
type OperatorApprovalTerminalReason = "user" | "timeout" | "malformed-verdict" | "no-route" | "run-aborted" | "gateway-restart" | "storage-corrupt";
type OperatorApprovalResolverKind = "device" | "channel" | "runtime" | "system";
type OperatorApprovalRequester = {
deviceId: string | null;
clientId: string | null;
deviceTokenAuth: boolean;
};
type OperatorApprovalSource = {
agentId: string | null;
sessionKey: string | null;
sessionId: string | null;
runId: string | null;
toolCallId: string | null;
toolName: string | null;
};
type OperatorApprovalResolver = {
kind: OperatorApprovalResolverKind;
id: string | null;
};
type OperatorApprovalRecord = {
id: string;
resolutionRef: string;
kind: OperatorApprovalKind;
status: OperatorApprovalStatus;
presentation: ApprovalPresentation;
requester: OperatorApprovalRequester;
reviewerDeviceIds: string[];
source: OperatorApprovalSource;
audienceSessionKeys: string[];
runtimeEpoch: string;
createdAtMs: number;
expiresAtMs: number;
updatedAtMs: number;
decision: OperatorApprovalDecision | null;
terminalReason: OperatorApprovalTerminalReason | null;
resolvedAtMs: number | null;
resolver: OperatorApprovalResolver | null;
consumedAtMs: number | null;
consumedBy: string | null;
};
type ResolveOperatorApprovalResult = {
outcome: "resolved";
record: OperatorApprovalRecord;
} | {
outcome: "expired";
record: OperatorApprovalRecord;
} | {
outcome: "already-resolved";
retry: "same" | "conflict";
record: OperatorApprovalRecord;
} | {
outcome: "decision-not-allowed";
record: OperatorApprovalRecord;
} | {
outcome: "not-found";
} | {
outcome: "corrupt";
};
type ForceDenyOperatorApprovalResult = {
outcome: "denied";
record: OperatorApprovalRecord;
} | {
outcome: "expired";
record: OperatorApprovalRecord;
} | {
outcome: "not-due";
record: OperatorApprovalRecord;
} | {
outcome: "already-terminal";
record: OperatorApprovalRecord;
} | {
outcome: "not-found";
} | {
outcome: "corrupt";
};
/** Opaque v2026.9.4 SDK guards require a native commit boundary. */
type OperatorApprovalStoreGuard = {
family: "worker" | "native-compatibility";
assertCurrent: () => void;
};
//#endregion
//#region src/gateway/exec-approval-manager.types.d.ts
type ExecApprovalReadAuthority = {
assertCurrent: () => void;
guard: OperatorApprovalStoreGuard;
};
type ExecApprovalResolveOptions = {
/** Explicit grant expiry override; undefined defers to the configured default. */
grantExpiresAtMs?: number | null;
assertCurrent?: () => void;
guard?: OperatorApprovalStoreGuard;
};
type ExecApprovalResolutionSource = "operator" | "auto-review";
type ExecApprovalRecord<TPayload = ExecApprovalRequestPayload> = {
id: string;
request: TPayload;
createdAtMs: number;
expiresAtMs: number;
requestedByConnId?: string | null;
requestedByDeviceId?: string | null;
requestedByClientId?: string | null;
requestedByDeviceTokenAuth?: boolean;
approvalReviewerDeviceIds?: string[];
resolvedAtMs?: number;
decision?: ExecApprovalDecision;
consumedDecision?: ExecApprovalDecision;
resolutionSource?: ExecApprovalResolutionSource;
askFallbackConsumed?: boolean;
resolvedBy?: string | null;
status?: OperatorApprovalStatus;
terminalReason?: OperatorApprovalTerminalReason | null;
runtimeEpoch?: string;
resolverKind?: OperatorApprovalResolver["kind"] | null;
consumedAtMs?: number | null;
consumedBy?: string | null;
executionIdentityToken?: ExecutionIdentityAdmissionToken;
/** Exact source authority retained only for use-time liveness validation. */
agentRuntimeDelegatedAuthority?: AgentRuntimeDelegatedAuthority;
/** Closure-bound authority for approvals created by in-process delegated tools. */
approvalAuthority?: () => boolean | void;
approvalSignals?: readonly AbortSignal[];
/** Process-local persistence proof; never serialized with approval presentation. */
mcpToolApprovalActive?: () => boolean;
};
type OperatorApprovalLifecycleEvent = {
phase: "pending" | "terminal";
record: OperatorApprovalRecord;
};
type OperatorStandingGrantMintSpec = ({
kind: "cron";
} & CronStandingGrantMintSpec) | {
kind: "mcp-tool";
agentId: string;
server: string;
tool: string;
} | ({
kind: "placement";
} & PlacementStandingGrantMintSpec);
type ExecApprovalManagerOptions<TPayload> = {
scheduler: GatewayScheduler;
approvalKind?: OperatorApprovalKind;
persistence: {
runtimeEpoch: string;
databaseOptions?: OpenClawStateDatabaseOptions;
};
resolveAllowedDecisions?: (request: TPayload) => readonly ExecApprovalDecision[];
/** Gateway may await lineage preparation; absence seeds only the requesting session. */
resolveAudienceSessionKeys?: (sourceSessionKey: string, sourceAgentId?: string | null) => string[] | Promise<string[]>;
onError?: (error: Error, context: {
approvalId: string;
approvalKind: OperatorApprovalKind;
operation: "expire";
}) => void;
onLifecycle?: (event: OperatorApprovalLifecycleEvent) => void;
/** Eligible allow-always requests derive one scoped grant, or return null. */
resolveStandingGrantMint?: (request: TPayload) => OperatorStandingGrantMintSpec | null;
/** Installs a placement grant after the durable approval CAS succeeds. */
retainPlacementStandingGrant?: PlacementStandingGrantRuntime["retain"];
resolveStandingGrantExpiresAtMs?: (nowMs: number) => number | null;
/** Timer, lookup, and replay expiry must all release the same local waiter. */
onExpired?: (record: OperatorApprovalRecord, liveRecord: ExecApprovalRecord<TPayload>) => void;
validateAgentRuntimeDelegatedAuthority?: (authority: AgentRuntimeDelegatedAuthority) => boolean;
};
type WithLiveRecord<TResult, TPayload> = TResult extends {
record: OperatorApprovalRecord;
} ? TResult & {
liveRecord?: ExecApprovalRecord<TPayload>;
} : TResult;
type ExecApprovalResolveResult<TPayload = ExecApprovalRequestPayload> = WithLiveRecord<ResolveOperatorApprovalResult, TPayload>;
type ExecApprovalForceDenyResult<TPayload = ExecApprovalRequestPayload> = WithLiveRecord<ForceDenyOperatorApprovalResult, TPayload>;
type ExecApprovalDurableLookup = {
outcome: "found";
record: OperatorApprovalRecord;
} | {
outcome: "missing" | "corrupt";
id: string;
};
type ExecApprovalIdLookupResult = {
kind: "exact" | "prefix";
id: string;
} | {
kind: "ambiguous";
ids: string[];
} | {
kind: "none";
};
//#endregion
//#region src/gateway/exec-approval-recovery.d.ts
type ExecApprovalMutationPersistence = ExecApprovalManagerOptions<unknown>["persistence"] & {
workerContext?: OpenClawStateWorkerContext;
};
//#endregion
//#region src/gateway/exec-approval-lifecycle.d.ts
type DecisionHandoff = {
start: (decision: ExecApprovalDecision | null) => void;
cancel: () => void;
};
type PendingEntry<TPayload> = {
record: ExecApprovalRecord<TPayload>;
resolve: (decision: ExecApprovalDecision | null) => void;
expiryJob: GatewayScheduledJob | null;
cleanupJob: GatewayScheduledJob | null;
handoffRetainCount: number;
handoffReleasedAtMs: number | null;
retainForManagerLifetime: boolean;
promise: Promise<ExecApprovalDecision | null>;
handoffs: Set<DecisionHandoff>;
admissionContinuation: GatewayRootWorkAdmissionContinuationScope | null;
mutation?: Promise<void>;
expiryPersistence?: ExecApprovalMutationPersistence;
expiryRefusals?: number;
uncertainVerdict?: {
assertCurrent: () => void;
autoReview?: {
committedResolutionKey?: string;
};
};
terminalPublication?: Pick<OperatorApprovalRecord, "kind" | "runtimeEpoch" | "status" | "decision" | "terminalReason" | "resolvedAtMs" | "updatedAtMs">;
};
/** Owns local observations and genuine decision effects, never durable decision policy. */
declare abstract class ExecApprovalLifecycle<TPayload> {
protected readonly scheduler: GatewayScheduler;
protected readonly pending: Map<string, PendingEntry<TPayload>>;
protected retired: boolean;
private observingClosed;
private readonly observers;
private readonly work;
private draining;
constructor(scheduler: GatewayScheduler);
abstract get runtimeEpoch(): string;
protected abstract expireDue(recordId: string, authority?: ExecApprovalReadAuthority): Promise<boolean>;
abstract get approvalKind(): OperatorApprovalKind;
protected abstract readonly options: Pick<ExecApprovalManagerOptions<TPayload>, "onError" | "onExpired" | "onLifecycle">;
protected emitLifecycle(event: OperatorApprovalLifecycleEvent): void;
protected retainUncertainVerdict(record: ExecApprovalRecord<TPayload> | undefined, uncertainty: NonNullable<PendingEntry<TPayload>["uncertainVerdict"]>): void;
protected assertPendingPersistenceCurrent(entry: PendingEntry<TPayload> | undefined): void;
protected clearUncommittedVerdict(record: ExecApprovalRecord<TPayload>): void;
protected settleLocalStorageFailure(recordId: string): void;
protected settleLocalFromStore(record: OperatorApprovalRecord, localDecision?: ExecApprovalDecision | null, localResolvedBy?: string | null, localResolutionSource?: ExecApprovalResolutionSource): boolean;
/** Settle one durable terminal transition and report whether this manager published it. */
reconcileDurableTerminal(record: OperatorApprovalRecord): Promise<boolean>;
protected reportError(error: unknown, context: {
approvalId: string;
operation: "expire";
}): void;
beginClose(): void;
retire(): void;
drain(): Promise<void>;
trackActiveWork<T>(run: () => T | Promise<T>): Promise<T>;
/** Accepted mutations retain their result and any committed handoff through retirement. */
protected trackMutation<T>(run: () => Promise<T>, recordId?: string): Promise<T>;
/** Native readers cannot publish ahead of the accepted winner's process-local provenance. */
protected waitForMutations(recordId: string): Promise<boolean>;
/** Keep publication identity with the waiter, including durable storage-repair outcomes. */
protected recordLifecyclePublication(event: OperatorApprovalLifecycleEvent, hasPublisher: boolean): void;
protected wasTerminalPublished(record: OperatorApprovalRecord): boolean;
protected canUseRetainedBinding(): boolean;
protected assertNotRetired(): void;
protected registerEntry(record: ExecApprovalRecord<TPayload>): Promise<ExecApprovalDecision | null>;
/** Registers the real effect before an observer can leave or a synchronous verdict can win. */
registerDecisionHandoff(recordId: string, run: (decision: ExecApprovalDecision | null) => Promise<void>): {
observation: Promise<void>;
abandon: () => void;
};
protected observeEntry<T>(entry: PendingEntry<TPayload>, completion: Promise<T>): Promise<T>;
protected settleLocalEntry(params: {
recordId: string;
decision: ExecApprovalDecision | null;
resolvedAtMs: number;
resolvedBy: string | null;
resolverKind: OperatorApprovalResolver["kind"] | null;
status: OperatorApprovalStatus;
terminalReason: OperatorApprovalTerminalReason | null;
consumedAtMs?: number | null;
consumedBy?: string | null;
resolutionSource?: ExecApprovalResolutionSource;
retainForManagerLifetime?: boolean;
}): boolean;
private scheduleResolvedCleanup;
protected resolvedGraceAnchorMs(entry: PendingEntry<TPayload>, nowMs: number): number | null;
/** Final release starts a fresh grace only while the manager still owns its lifecycle. */
retainForHandoff(recordId: string): (() => void) | null;
protected abstract scheduleExpiry(entry: PendingEntry<TPayload>, delayMs?: number): void;
getSnapshot(recordId: string, authority?: ExecApprovalReadAuthority): Promise<ExecApprovalRecord<TPayload> | null>;
/** Pure binding lookup for synchronous resource authorization; never grants a decision. */
getLocalSnapshot(recordId: string): ExecApprovalRecord<TPayload> | null;
/** Reads a live local binding without entering durable storage or mutating expiry. */
getLiveSnapshot(recordId: string): ExecApprovalRecord<TPayload> | null;
/**
* One-shot ask-fallback re-admission for a timed-out approval. This is
* pre-gate policy on the process-local record only: the durable row stays
* `expired` and no execution authority is minted here. The shipped askFallback
* policy (docs/tools/exec-approvals.md) still applies; system.run replay
* uses this flag to keep re-admission single-use.
*/
consumeAskFallback(recordId: string): boolean;
/** Re-enters only the pending approval's exact original root. */
runPendingContinuation<T>(recordId: string, run: () => Promise<T>): Promise<T> | null;
listPendingRecords(authority?: ExecApprovalReadAuthority): Promise<ExecApprovalRecord<TPayload>[]>;
/** Closure callbacks revoke these bindings synchronously before awaiting persistence. */
listLocalPendingRecords(): ExecApprovalRecord<TPayload>[];
lookupApprovalId(input: string, opts?: {
includeResolved?: boolean;
authority?: ExecApprovalReadAuthority;
filter?: (record: ExecApprovalRecord<TPayload>) => boolean;
}): Promise<ExecApprovalIdLookupResult>;
lookupLocalApprovalId(input: string, opts?: {
includeResolved?: boolean;
filter?: (record: ExecApprovalRecord<TPayload>) => boolean;
}): ExecApprovalIdLookupResult;
}
//#endregion
//#region src/gateway/exec-approval-expiry.d.ts
/** The existing pending entry owns its deadline and any definite-refusal retry. */
declare abstract class ExecApprovalExpiry<TPayload> extends ExecApprovalLifecycle<TPayload> {
protected abstract readonly options: Pick<ExecApprovalManagerOptions<TPayload>, "persistence" | "onError" | "onExpired" | "onLifecycle">;
abstract forceDenyDetailed(recordId: string, reason: OperatorApprovalTerminalReason, resolver: OperatorApprovalResolver, status?: "denied" | "expired" | "cancelled", localDecision?: ExecApprovalDecision | null, requireDue?: boolean, localResolvedBy?: string | null, assertResolverCurrent?: () => void, callerGuard?: OperatorApprovalStoreGuard): Promise<ExecApprovalForceDenyResult<TPayload>>;
protected scheduleExpiry(entry: PendingEntry<TPayload>, delayMs?: number): void;
protected expireDue(recordId: string, authority?: ExecApprovalReadAuthority): Promise<boolean>;
}
//#endregion
//#region src/gateway/exec-approval-manager.d.ts
/** Approval creation and persistence precede every local wait or delivery handoff. */
declare class ExecApprovalManager<TPayload = ExecApprovalRequestPayload> extends ExecApprovalExpiry<TPayload> {
protected readonly options: ExecApprovalManagerOptions<TPayload>;
constructor(options: ExecApprovalManagerOptions<TPayload>);
get approvalKind(): OperatorApprovalKind;
get runtimeEpoch(): string;
create(request: TPayload, timeoutMs: number, id?: string | null): ExecApprovalRecord<TPayload>;
/** Persist registration before exposing its separate decision promise to delivery. */
register(record: ExecApprovalRecord<TPayload>, _timeoutMs: number): Promise<{
decision: Promise<ExecApprovalDecision | null>;
}>;
private scheduleAuthorityClosure;
/** Persist the first verdict, then release the process-local waiter. */
resolveDetailed(recordId: string, decision: ExecApprovalDecision, resolver: OperatorApprovalResolver, localResolvedBy?: string | null, localResolutionSource?: ExecApprovalResolutionSource, options?: ExecApprovalResolveOptions): Promise<ExecApprovalResolveResult<TPayload>>;
/** Persist a fail-closed terminal state, then release the local waiter. */
forceDenyDetailed(recordId: string, reason: OperatorApprovalTerminalReason, resolver: OperatorApprovalResolver, status?: "denied" | "expired" | "cancelled", localDecision?: ExecApprovalDecision | null, requireDue?: boolean, localResolvedBy?: string | null, assertResolverCurrent?: () => void, callerGuard?: OperatorApprovalStoreGuard): Promise<ExecApprovalForceDenyResult<TPayload>>;
private recoverUnknownVerdict;
/** Reconciles durable truth with an existing waiter without rehydrating its request. */
reconcileDurableLookup(initialLookup: ExecApprovalDurableLookup, localResolvedBy?: string | null, authority?: ExecApprovalReadAuthority): Promise<OperatorApprovalRecord | null>;
private persistStorageCorruptDeny;
resolve(recordId: string, decision: ExecApprovalDecision, resolvedBy?: string | null, options?: ExecApprovalResolveOptions): Promise<boolean>;
/**
* Trusted auto-review resolution (identity-matched approval runtime).
* Always allow-once; system.run replay validation treats the resulting
* record more strictly than an operator decision (see #103515).
*/
resolveAutoReview(recordId: string, resolvedBy?: string | null, assertCurrent?: () => void, guard?: OperatorApprovalStoreGuard): Promise<boolean>;
expire(recordId: string, resolvedBy?: string | null): Promise<boolean>;
consumeAllowOnce(recordId: string, consumerId?: string): Promise<boolean>;
/** Observes a registered decision; Gateway closure rejects the wait, not the approval. */
awaitDecision(recordId: string): Promise<ExecApprovalDecision | null> | null;
/** Projects an allowed decision only while its exact runtime authority is live. */
projectDecisionIfActive(recordId: string, decision: ExecApprovalDecision | null): ExecApprovalDecision | null;
/** Atomically closes a live approval whose exact runtime owner is gone. */
forceDenyIfRuntimeAuthorityClosed(recordId: string): Promise<ExecApprovalForceDenyResult<TPayload> | null>;
}
//#endregion
//#region src/plugins/runtime-degraded-state.d.ts
type PluginVerificationFailureReason = "missing-install-path" | "missing-package-dir" | "missing-package-json" | "unreadable-package-json" | "invalid-package-json" | "missing-bundle-manifest" | "invalid-bundle-manifest" | "missing-main-entry" | "missing-extension-entry" | "missing-openclaw-peer-link";
//#endregion
//#region src/agents/prepared-model-runtime.startup-status.d.ts
type PreparedModelRuntimeStartupStatus = Readonly<{
degraded: boolean;
pendingAgents: readonly string[];
stage?: string;
}>;
//#endregion
//#region src/gateway/health/types.d.ts
type ProtocolHealth = Snapshot["health"];
type ProtocolPlugin = NonNullable<ProtocolHealth["plugins"]>;
type UnavailablePlugin = NonNullable<ProtocolPlugin["unavailable"]>[number];
/** Health snapshot for one configured channel account. */
type ChannelAccountHealthSummary = ChannelAccountSnapshot & {
authAgeMs?: number | null;
[key: string]: unknown;
};
/** Channel-level health summary with optional per-account details. */
type ChannelHealthSummary = ChannelAccountHealthSummary & {
accounts?: Record<string, ChannelAccountHealthSummary>;
};
type AgentHealthSummary = NonNullable<ProtocolHealth["agents"]>[number];
/** Plugin registry health summary. */
type PluginHealthSummary = Omit<ProtocolPlugin, "unavailable"> & {
unavailable?: Array<Omit<UnavailablePlugin, "diagnostic"> & {
diagnostic: Omit<UnavailablePlugin["diagnostic"], "reason"> & {
reason: PluginVerificationFailureReason;
};
}>;
};
/** Full gateway health payload consumed by `openclaw health`. */
type HealthSummary = ProtocolHealth & {
modelRuntime?: PreparedModelRuntimeStartupStatus;
ok: true;
ts: number;
durationMs: number;
plugins?: PluginHealthSummary;
channels: Record<string, ChannelHealthSummary>;
channelOrder: string[];
channelLabels: Record<string, string>;
heartbeatSeconds: number;
agents: AgentHealthSummary[];
sessions: NonNullable<ProtocolHealth["sessions"]>;
};
//#endregion
//#region src/gateway/mention-inbox.types.d.ts
type MentionCommittedInput = {
sourceId: string;
committedSource: {
generation: string;
sequence: number;
timestamp: number;
};
sessionKey: string;
agentId?: string;
sessionId: string;
messageId: string;
senderProfileId: string;
recipientProfileIds: readonly string[];
excerpt?: string;
};
/** Keep the Gateway context independent of its context-consuming Inbox implementation. */
type MentionInbox = {
mentionable: (client: GatewayClient | null, input: UsersMentionableParams, publish: (result: Result$1<UsersMentionableResult, ErrorShape>) => undefined) => Promise<void>;
validateRecipients: (client: GatewayClient | null, input: UsersMentionableParams, profileIds: readonly string[]) => Result$1<readonly string[], ErrorShape>;
list: (client: GatewayClient | null) => Result$1<MentionsListResult, ErrorShape>;
dismiss: (client: GatewayClient | null, ids: readonly string[]) => Result$1<MentionsListResult, ErrorShape>;
recordCommittedInput: (input: MentionCommittedInput) => void;
invalidate: (sessionKey?: string) => void;
dispose: () => void;
};
//#endregion
//#region src/gateway/portals/portal-http-proxy.d.ts
type PortalTarget = {
kind: "local";
port: number;
} | {
kind: "worker";
environmentId: string;
ownerEpoch: number;
remotePort: number;
connect: () => Promise<Duplex>;
};
//#endregion
//#region src/gateway/portals/portal-service.d.ts
type GatewayPortalOpenParams = {
targetPort: number;
target?: PortalTarget;
/** Revalidated before metadata mutation or publication after asynchronous listener startup. */
assertCurrent?: () => void;
/** Resource lifetime, independent of the operation or actor that created the link. */
ownerSignal?: AbortSignal;
/** Internal resource identity; scoped resources must not adopt a global portal's lifetime. */
resourceOwnerKey?: string;
/** Ownership transfers to open; unused targets are released even when it rejects or reuses a portal. */
onClose?: () => Promise<void> | void;
origin?: string;
title?: string;
description?: string;
path?: string;
};
type GatewayPortalService = {
open: (params: GatewayPortalOpenParams) => Promise<PortalOpenResult>;
list: () => PortalSummary[];
listWorkerPortals: (environmentId: string, ownerEpoch: number, resourceOwnerKey?: string) => PortalSummary[];
close: (id: string, assertCurrent?: () => void) => Promise<void>;
closeWorkerPortals: (environmentId: string, ownerEpoch?: number) => Promise<void>;
closeAll: () => Promise<void>;
};
//#endregion
//#region src/gateway/question-session-access.types.d.ts
type QuestionSessionCurrentRead = {
readonly target: {
agentId: string;
canonicalKey: string;
storePath: string;
entry: {
sessionId: string;
lifecycleRevision?: string;
incognito?: boolean;
};
} | null;
readonly read: {
database: {
path: string;
};
result: {
databaseIdentity?: {
identity: string;
birthtime?: string;
};
};
};
assertCurrent: () => void;
};
/** Original source and database generation survive until the manager retires this entry. */
type QuestionSessionAccess = {
readonly agentId: string;
readonly sessionKey: string;
/** Pure original-person selection, before session reads or liveness transitions. */
canSelect: (client: GatewayClient | null) => boolean;
assertSourceCurrent: () => void;
assertCurrent: (read: QuestionSessionCurrentRead) => void;
release: () => void;
};
//#endregion
//#region src/gateway/question-manager.d.ts
type QuestionManagerRequest = {
id?: string;
questions: Question[];
agentId?: string;
sessionKey?: string;
runId?: string;
timeoutMs: number;
onResolved?: ((event: QuestionResolvedEvent, observation: QuestionObservation) => void) | ((event: QuestionResolvedEvent, observation: QuestionObservation) => Promise<void>);
sessionAccess?: QuestionSessionAccess;
isRequesterActive?: () => boolean;
requesterRun?: OperationalRunInstanceRef;
/** Trusted handler binds the run; the manager owns expiry and terminal release. */
registerHumanInputWait?: (isPending: () => boolean) => ((resolved: boolean) => void) | undefined;
};
/** Private entry identity. Never reselect a successor by its public question id. */
type QuestionObservation = {
readonly record: QuestionRecord;
readonly ordinary: boolean;
readonly sessionAccess?: QuestionSessionAccess;
isCurrent: () => boolean;
refreshRequester: () => void;
};
/** Process-local lifecycle owner for pending questions. */
declare class QuestionManager {
private readonly scheduler;
private readonly onPublicationError?;
private readonly entries;
private closed;
private readonly publications;
private readonly scheduleId;
constructor(scheduler: GatewayScheduler, onPublicationError?: (() => void) | undefined);
drain(): Promise<void>;
request(params: QuestionManagerRequest): QuestionRecord;
get(id: string): QuestionRecord | null;
/** Observation only: unlike get(), this cannot expire or cancel and recursively broadcast. */
observe(id: string, expectedRecord?: QuestionRecord): QuestionObservation | null;
private observeEntry;
private refreshRequester;
/** Called by the Gateway's existing authority-close observer. */
cancelClosedAuthorities(closedRun?: {
runId: string;
instanceId?: string;
}): void;
list(include?: (record: QuestionRecord) => boolean): QuestionRecord[];
/** Re-enters only the still-pending question's original admitted root. */
runPendingContinuation<T>(id: string, run: () => Promise<T>): Promise<T> | null;
waitAnswer(id: string, timeoutMs?: number, includeResolutionId?: boolean): Promise<QuestionWaitAnswerResult>;
resolve(id: string, answers: QuestionAnswers, resolvedBy?: string, options?: {
commit?: () => void;
resolutionId?: string;
}): QuestionResolveResult;
cancel(id: string, resolvedBy?: string): QuestionResolveResult;
private cancelEntry;
/** Retires this Gateway's owner only after received mutations have joined. */
close(): void;
/** Reusable on open owners (v2026.8.1 SDK context); never reopens a closed owner. */
reset(): void;
private requireEntry;
private requirePendingEntry;
/** Validates answers against stored questions and returns them in canonical form. */
private validateAnswers;
private invalidAnswer;
private notFound;
private expire;
private finish;
}
//#endregion
//#region src/cron/scratch-store.d.ts
type CronJobScratch = {
content: string;
revision: number;
sourceSha256?: string;
updatedAtMs: number;
};
/**
* Present scratch content plus the persisted revision. An unset scratch keeps a
* tombstone row so `currentRevision` stays monotonic across unset/recreate and
* stale compare-and-swap writers cannot resurrect old content.
*/
type CronJobScratchState = {
currentRevision: number;
scratch?: CronJobScratch;
};
type CronJobScratchWriteResult = {
ok: true;
currentRevision: number;
scratch?: CronJobScratch;
} | {
ok: false;
reason: "revision-conflict";
currentRevision: number;
};
//#endregion
//#region src/gateway/server-cron-contract.d.ts
type GatewayCronServiceContract = CronServiceContract & {
/** Cancel exact current definitions under the serving scheduler's operation lock. */
quiesceJobs(jobs: readonly {
id: string;
revision: string;
}[], commitGuard: () => void): Promise<void>;
/** Remove an owned declarative job family from obsolete SQLite store partitions. */
removeStaleJobFamily(family: {
declarationKey: string;
name: string;
ownerPluginTag: string;
}, opts?: {
commitGuard?: () => void;
}): Promise<number>;
readScratch(id: string): Promise<CronJobScratchState>;
writeScratch(id: string, params: {
content: string | null;
expectedRevision?: number;
sourceSha256?: string;
commitGuard?: () => void;
}): Promise<CronJobScratchWriteResult>;
/** Serialize agent-job removal with the roster commit and restore on failure. */
removeAgentJobsTransactional<T>(agentId: string, commit: () => Promise<T>): Promise<T>;
/** Temporarily disarm ticks without running startup recovery on resume. */
pauseScheduling(): void;
resumeScheduling(): void;
/** Scheduler-owned work not represented by active cron run markers. */
getSuspensionBlockerCount?(): number;
/** Materialize lazy cron dependencies before a synchronous operator wake. */
prepareWake?(): Promise<void>;
/** Stop cron and await scheduler-owned child process teardown. */
stopAndDrain?(): Promise<void>;
};
//#endregion
//#region src/gateway/server-instance-runtime.types.d.ts
type GatewayInstanceAgentDispatchOptions = {
assertAdmissionCurrent?: () => void;
allowModelOverride?: boolean;
allowSyntheticModelOverride?: boolean;
allowSyntheticCronRunContinuation?: boolean;
delegatedToolPolicyHandoff?: SubagentCompletionToolHandoffRegistration;
expectFinal?: boolean;
/** Instance-owned dispatch always uses a synthetic client. */
forceSyntheticClient?: boolean;
internalDeliveryMediaUrls?: string[];
runtimeContextFragments?: RuntimeContextFragment[];
internalDeliverySuppressText?: boolean;
onAccepted?: (payload: unknown) => void;
onStartOwner?: (owner: AgentTurnStartOwner) => void;
onExecutionStarted?: () => void;
onSignalAbort?: () => Promise<void> | void;
scopes?: string[];
signal?: AbortSignal;
syntheticScopes?: string[];
};
type GatewayApprovalEventPublisher = {
publishRequested: (kind: ChannelApprovalKind, request: unknown) => number;
publishResolved: (kind: ChannelApprovalKind, resolved: unknown) => void;
};
type GatewayRecoverySessionMethod = "chat.history" | "chat.abort" | "sessions.delete";
type GatewayRecoveryTypingParams = {
agentId?: string;
runId: string;
channel: string;
to: string;
accountId?: string;
threadId?: string | number;
isCurrent: (cfg: OpenClawConfig) => boolean;
};
type GatewayRecoveryRuntime = {
dispatchSessionMethod: <T = unknown>(method: GatewayRecoverySessionMethod, params: unknown, options?: {
timeoutMs?: number;
signal?: AbortSignal;
assertCurrent?: () => void;
}) => Promise<T>;
startRecoveryTyping?: (params: GatewayRecoveryTypingParams) => () => void;
dispatchAgent: <T = unknown>(params: AgentRunRequest, timeoutMs?: number, options?: GatewayInstanceAgentDispatchOptions) => Promise<T>;
waitForAgent: <T = unknown>(params: AgentWaitParams, timeoutMs?: number, signal?: AbortSignal) => Promise<T>;
sendRecoveryNotice: (params: {
channel: string;
to: string;
accountId?: string;
threadId?: string | number;
text: string;
idempotencyKey: string;
} & ({
/** Main-session announcements cannot outlive their process-local owner. */
liveOnly: true;
isCurrent: (cfg: OpenClawConfig) => boolean;
} | {
/** Existing callers retain durable retry and deduplication by default. */
liveOnly?: false;
isCurrent?: (cfg: OpenClawConfig) => boolean;
})) => Promise<{
/** True when delivery produced zero platform results (policy/channel suppression). */
suppressed: boolean;
}>;
};
//#endregion
//#region src/gateway/server-shared.d.ts
type DedupeEntry = {
ts: number;
ok: boolean;
/** Optional effectful-request fingerprint for methods with caller-supplied operation ids. */
requestIdentity?: string;
/** Retain source privacy for diagnostic replay after the live session binding is gone. */
incognito?: true;
payload?: unknown;
error?: ErrorShape;
};
//#endregion
//#region src/gateway/server/event-loop-health.d.ts
type GatewayEventLoopHealthReason = "event_loop_delay" | "event_loop_utilization" | "cpu";
type GatewayEventLoopHealth = {
degraded: boolean;
degradedSinceMs: number | null;
reasons: GatewayEventLoopHealthReason[];
intervalMs: number;
delayP99Ms: number;
delayMaxMs: number;
utilization: number;
cpuCoreRatio: number;
cpuBreakdown?: {
mainThreadCoreRatio?: number;
workerCoreRatio?: number;
otherThreadsCoreRatio?: number;
hostUtilization?: number;
hostCpuCount?: number;
};
};
//#endregion
//#region src/gateway/terminal/launch.d.ts
type TerminalLaunchBlock = {
kind: "disabled";
} | {
kind: "owner-required";
message: string;
} | {
kind: "unknown-agent";
agentId: string;
} | {
kind: "sandboxed";
agentId: string;
mode: "all";
};
type TerminalLaunchPlan = {
agentId: string;
cwd: string;
shell: string;
args: string[];
initialCommand?: string[];
cwdOverride?: string;
};
type TerminalLaunchResolution = {
ok: true;
plan: TerminalLaunchPlan;
} | {
ok: false;
block: TerminalLaunchBlock;
};
//#endregion
//#region src/infra/terminal-file-upload.d.ts
type TerminalUploadFile = {
name: string;
contentBase64: string;
/** Host-only client policy, carried unchanged through the terminal staging adapter. */
assertCommitAllowed?: () => void;
};
type TerminalUploadResult = TerminalUploadResult$1;
//#endregion
//#region src/process/terminal-pty.d.ts
/** Live PTY handle shared by gateway terminals and node-host commands. */
type TerminalPtySubscription = {
dispose(): void;
};
type TerminalPtyHandle = {
pid: number;
write(data: string | Buffer): void;
resize(cols: number, rows: number): void;
pause(): void;
resume(): void;
onData(listener: (chunk: string) => void): TerminalPtySubscription | void;
onExit(listener: (event: {
exitCode: number;
signal?: number;
}) => void): TerminalPtySubscription | void;
kill(signal?: string): void;
};
type TerminalPtySpawnParams = {
file: string;
args: string[];
cwd?: string;
env?: Record<string, string>;
name?: string;
cols: number;
rows: number;
};
declare function spawnTerminalPty(params: TerminalPtySpawnParams, lifecycle?: {
abortSignal?: AbortSignal;
assertCurrent?: () => void;
}): Promise<TerminalPtyHandle>;
//#endregion
//#region src/gateway/terminal/backend.d.ts
type TerminalBackendExit = {
exitCode?: number;
signal?: number;
error?: string;
};
interface TerminalBackend {
write(data: string): void;
resize(cols: number, rows: number): void;
pause(): void;
resume(): void;
kill(): void;
onData(callback: (data: string) => void): void;
onExit(callback: (exit: TerminalBackendExit) => void): void;
}
//#endregion
//#region src/gateway/terminal/session-manager.types.d.ts
type TerminalEventSink = (connId: string, event: string, payload: unknown) => void;
type AgentTerminalOwner = {
kind: "agent";
agentSessionKey: string;
agentSessionId: string;
agentId: string;
};
type TerminalOwner = {
kind: "conn";
connId: string;
} | AgentTerminalOwner;
type AgentTerminalSessionDrain = {
drained: Promise<void>;
hasWork(): boolean;
release(): void;
};
type TerminalSessionManagerOptions = {
emit: TerminalEventSink;
getBufferedAmount?: (connId: string) => number | undefined;
spawn?: typeof spawnTerminalPty;
maxSessions?: number;
env?: NodeJS.ProcessEnv;
/** Detach grace; 0 preserves kill-on-disconnect. Gateway wiring owns its default. */
detachGraceMs?: number;
maxDetachedSessions?: number;
scrollbackChars?: number;
};
type TerminalOpenRequest = {
owner: TerminalOwner;
/** Operator connection initially viewing an agent-owned session. */
viewerConnId?: string;
agentId: string;
cwd: string;
shell: string;
title?: string;
args: string[];
cols: number;
rows: number;
env: Record<string, string>;
/** Request-scoped cancellation; a late backend is killed before registration. */
signal?: AbortSignal;
createBackend?: () => Promise<TerminalBackend>;
stageUpload?: (file: TerminalUploadFile) => Promise<TerminalUploadResult>;
};
type TerminalOpenOutcome = {
ok: true;
sessionId: string;
agentId: string;
cwd: string;
shell: string;
} | {
ok: false;
code: "limit" | "spawn_failed" | "closed";
message: string;
};
type TerminalAgentActionOutcome = {
ok: true;
} | {
ok: false;
code: "session_unavailable" | "backend_failed";
};
//#endregion
//#region src/gateway/terminal/session-types.d.ts
type TerminalSessionSummary = {
sessionId: string;
agentId: string;
shell: string;
title?: string;
cwd: string;
attached: boolean;
owner: "conn" | `agent:${string}`;
createdAtMs: number;
};
type TerminalAttachSummary = Omit<TerminalSessionSummary, "attached" | "createdAtMs"> & {
buffer: string;
seq: number;
};
//#endregion
//#region src/gateway/terminal/session-manager.d.ts
/** Owns PTYs and indexes their connections for bounded disconnect cleanup. */
declare class TerminalSessionManager {
private readonly sessions;
private readonly pendingOpens;
private readonly agentSessionDrain;
private readonly connections;
private readonly emit;
private readonly getBufferedAmount;
private readonly spawn;
private readonly maxSessions;
private detachGraceMs;
private readonly maxDetachedSessions;
private readonly scrollbackChars;
private opening;
private spawning;
constructor(options: TerminalSessionManagerOptions);
get size(): number;
open(request: TerminalOpenRequest): Promise<TerminalOpenOutcome>;
write(connId: string, sessionId: string, data: string): boolean;
/** Writes agent input after proving exact agent-session ownership. */
writeAgent(owner: AgentTerminalOwner, sessionId: string, data: string): TerminalAgentActionOutcome;
private writeSession;
resize(connId: string, sessionId: string, cols: number, rows: number): boolean;
/** Resizes an agent-owned PTY after proving exact agent-session ownership. */
resizeAgent(owner: AgentTerminalOwner, sessionId: string, cols: number, rows: number): TerminalAgentActionOutcome;
private resizeSession;
/** Stages a file on the same host as an owned terminal session. */
upload(connId: string, sessionId: string, file: TerminalUploadFile): Promise<TerminalUploadResult | undefined>;
close(connId: string, sessionId: string): boolean;
/** Closes an agent-owned PTY after proving session-key ownership. */
closeAgent(owner: AgentTerminalOwner, sessionId: string): TerminalAgentActionOutcome;
/** Fences and closes one durable agent-session incarnation through archive commit. */
beginAgentSessionDrain(owner: AgentTerminalOwner): AgentTerminalSessionDrain;
/**
* Rebinds a connection-owned session, or co-attaches a viewer to an
* agent-owned session. Operator-to-operator attach remains take-over; only
* agent-owned sessions gain shared viewers.
*/
attach(connId: string, sessionId: string): TerminalAttachSummary | undefined;
/** Every live session, oldest first; all admin connections see the same list. */
list(): TerminalSessionSummary[];
snapshot(sessionId: string): string | undefined;
/** Raw buffer for an agent-owned session, guarded by the caller session key. */
snapshotAgent(owner: AgentTerminalOwner, sessionId: string): string | undefined;
listAgent(owner: AgentTerminalOwner): TerminalSessionSummary[];
private trackPendingOpen;
private hasAgentSessionWork;
private resolveAgentSessionDrainIfIdle;
private openAbortMessage;
private untrackPendingOpen;
/**
* Handles a dropped connection: detaches its sessions for later reattach
* when a grace period is configured, otherwise kills them (legacy behavior,
* still selected by detachedSessionTimeoutSeconds: 0).
*/
handleDisconnect(connId: string): void;
/** Closes live and pending sessions whose agent no longer permits a host shell. */
closeDisallowedAgents(isAllowed: (agentId: string) => boolean): void;
/** Parks a session ownerless with a reaper; PTY output keeps buffering. */
private detach;
updateDetachGraceMs(graceMs: number): void;
private scheduleDetachedExpiry;
private enforceDetachedCap;
/** Tears down all sessions silently on Gateway shutdown; their sockets are closing too. */
disposeAll(): void;
/** Viewer-free agent PTYs may be evicted; concurrent opens claim distinct victims. */
private claimLongestIdleAgentSession;
private removeViewer;
private interactiveSession;
/** Agents may operate only PTYs created by their exact trusted session key. */
private agentOwnedSession;
private finalize;
}
//#endregion
//#region src/gateway/server-methods/chat-metadata-contract.d.ts
declare const chatMetadataSessionFields: readonly ["sessionId", "lifecycleRevision", "sessionStartedAt", "acp", "agentHarnessId", "agentRuntimeOverride", "modelSelectionLocked", "pluginOwnerId", "providerOverride", "modelOverride", "modelOverrideRouteResolution", "modelOverrideFallbackOriginProvider", "modelOverrideFallbackOriginModel", "authProfileOverride", "authProfileOverrideSource", "authProfileOverrideCompactionCount"];
type ChatMetadataSessionEntry = Partial<Pick<SessionEntry$1, (typeof chatMetadataSessionFields)[number]>>;
type ChatMetadataReadParams = {
agentId: string;
sessionKey?: string;
storePath?: string;
requesterProfileId?: string;
sessionEntry?: ChatMetadataSessionEntry;
/** Saved reads retain their selected row and physical store until response settlement. */
isCurrent?: () => boolean;
assertCurrent?: () => void;
release?: () => void;
draftAccountSelection?: UserModelAccountSelection;
};
type ChatMetadataResult = {
commands?: unknown[];
models?: ModelChoice[];
modelSelectionPolicy?: ModelsListResult["modelSelectionPolicy"];
swarmEnabled: boolean;
runtimeSelectionLocked?: boolean;
accountSelection?: ChatAccountSelection;
};
//#endregion
//#region src/gateway/server-methods/chat-startup-projection-contract.d.ts
type ChatStartupProjectionReadParams = {
agentId: string;
/** Startup reads this after metadata preparation yields; the profile owner tracks merges. */
readRequesterProfileId?: () => string | undefined;
sessionKey?: string;
sessionEntry?: ChatMetadataSessionEntry;
readPolicy?: "current" | "ready";
};
type ChatStartupProjectionResult = {
metadata?: ChatMetadataResult;
sessionModelCatalog: ModelCatalogEntry[];
defaultModelCatalog: ModelCatalogEntry[];
};
//#endregion
//#region src/gateway/server-methods/shared-types.d.ts
type PreparedSessionApprovalReplay = {
replay: SessionApprovalReplay;
/** Check in the response frame; a publication may race promise delivery. */
isCurrent: () => boolean;
/** Retain publication fencing through the response, then release the replay scope. */
release: () => void;
};
/**
* Structural mirror of the engine's SystemAgentAssistantTurn. Kept local as a
* leaf contract: importing the assistant module here closes a madge cycle
* through the agents/config cluster.
*/
type SystemAgentHistoryTurn = {
role: "user" | "assistant";
text: string;
};
type SystemAgentReply = {
text: string;
action: "none" | "exit" | "open-tui" | "open-setup";
sensitive?: boolean;
question?: SystemAgentChatQuestion;
};
/** Minimal hosted OpenClaw contract retained by the gateway request router. */
type GatewaySystemAgentSession = {
engine: {
handle: (message: string, options?: {
uiContext?: {
page: string;
};
}) => Promise<SystemAgentReply>;
answerWizard: (answer: WizardAnswer) => Promise<SystemAgentReply>;
cancelWizard: (cancel: SystemAgentWizardCancel) => Promise<SystemAgentReply>;
decorateRejoinReply: (reply: {
text: string;
action: "none";
}) => SystemAgentReply & {
wizardInputPending?: boolean;
step?: WizardStep;
};
noteAssistantMessage: (text: string) => void;
seedHistory: (turns: readonly SystemAgentHistoryTurn[]) => void;
historyLength: () => number;
historySince: (index: number) => SystemAgentHistoryTurn[];
getPendingOperatorProposal: () => {
operation: SystemAgentOperation;
hash: string;
} | null;
resolveOperatorApproval: (decision: "allow-once" | "allow-always" | "deny" | null, proposalHash: string, beforePersistentApply?: () => void, terminalStatus?: "expired" | "cancelled") => Promise<{
text: string;
action: "none" | "exit" | "open-tui" | "open-setup";
applied?: boolean;
} | null>;
dispose: () => Promise<void>;
};
welcome: string;
/** Recorded with the welcome; external-edit notices and setup are not optional. */
optionalWelcome?: boolean;
/** Passive creation entry, retained so reconnects do not append duplicate history. */
newAgentWelcome?: string;
welcomeQuestion?: SystemAgentChatQuestion;
/** Audit cursor captured with the pending caretaker welcome; cleared after delivery. */
welcomeAuditSequence?: number;
lastUsedAt: number;
ownerKey: string;
pendingApproval?: {
id: string;
proposalHash: string;
completion: Promise<NonNullable<Awaited<ReturnType<GatewaySystemAgentSession["engine"]["resolveOperatorApproval"]>>>>;
};
};
/** Kernel-owned services and state that can be constructed without binding sockets. */
type GatewayKernelContext = {
deps: CliDeps;
/** Host-bound plugin ingress; the transport owns its shared hook dispatch queue. */
dispatchHookAgentTurn?: (pluginId: string, params: Parameters<PluginRuntimeCore["hooks"]["dispatchHookAgentTurn"]>[0]) => ReturnType<PluginRuntimeCore["hooks"]["dispatchHookAgentTurn"]>;
configRevisionProjector: GatewayConfigRevisionProjector;
cron: GatewayCronServiceContract;
cronStorePath: string;
getRuntimeConfig: () => OpenClawConfig;
channelAdmissionAudit?: ChannelAdmissionAudit;
/** Last serving policy committed by this Gateway, excluding tentative secret activation. */
getCommittedRuntimeConfig?: () => OpenClawConfig;
sessionRowProjectionOwner?: object;
ensureSessionRowProjection?: () => Promise<void>;
/** Live reload owner, including same-config restart work and shutdown. */
isConfigReloadSettled: () => boolean;
/** Prepared listener certificate pin; undefined when Gateway TLS is disabled. */
gatewayTlsFingerprint?: string;
sessionCompanion?: SessionCompanionService;
sessionObserver?: SessionObserverService;
sessionActivitySummaries?: SessionActivitySummaryService;
/** Temporary profile-owned mentions for this exact Gateway lifetime. */
mentionInbox?: MentionInbox;
resolveTerminalLaunchPolicy: (agentId?: string) => TerminalLaunchResolution;
isTerminalEnabled: () => boolean;
execApprovalManager?: ExecApprovalManager;
questionManager?: QuestionManager;
scopeUpgradeCoordinator?: ScopeUpgradeCoordinator;
/** Exact authority cancels bound approvals; legacy run ids cancel only unbound exec requests. */
cancelRunBoundApprovals?: (target: string | AgentRunDelegatedAuthority) => Promise<number>;
pluginApprovalManager?: ExecApprovalManager<PluginApprovalRequestPayload>;
placementStandingGrants?: PlacementStandingGrantRuntime;
systemAgentApprovalManager?: ExecApprovalManager<SystemAgentApprovalRequestPayload>;
forwardPluginApprovalRequest?: (request: PluginApprovalRequest$1) => Promise<boolean>;
forwardExecApprovalRequest?: (request: ExecApprovalRequest) => Promise<boolean>;
forwardSystemAgentApprovalRequest?: (request: SystemAgentApprovalRequest) => Promise<boolean>;
forwardSystemAgentApprovalResolved?: (resolved: SystemAgentApprovalResolved) => Promise<void>;
execApprovalIosPushDelivery?: {
handleRequested?: (request: ExecApprovalRequest, opts?: {
isTargetVisible?: (target: {
deviceId: string;
scopes: readonly string[];
}) => boolean;
}) => Promise<boolean>;
handleResolved?: (resolved: ExecApprovalResolved) => Promise<void>;
handleExpired?: (request: ExecApprovalRequest) => Promise<void>;
};
approvalWebPushDelivery?: {
handleRequested: <TPayload>(record: ExecApprovalRecord<TPayload>) => boolean | Promise<boolean>;
handleResolved: (resolved: {
id: string;
}) => Promise<void>;
handleExpired: (request: {
id: string;
}) => Promise<void>;
};
pluginApprovalIosPushDelivery?: {
handleRequested?: (request: PluginApprovalRequest$1, opts?: {
isTargetVisible?: (target: {
deviceId: string;
scopes: readonly string[];
}) => boolean;
}) => Promise<boolean>;
handleExpired?: (request: PluginApprovalRequest$1) => Promise<void>;
};
listSessionPendingApprovals?: (sessionKey: string, client: GatewayClient | null) => Promise<PreparedSessionApprovalReplay>;
loadGatewayModelCatalog: (params?: {
agentId?: string;
agentDir?: string;
readOnly?: boolean;
workspaceDir?: string;
}) => Promise<ModelCatalogEntry[]>;
loadGatewayModelCatalogSnapshot: (params?: {
agentId?: string;
agentDir?: string;
readOnly?: boolean;
workspaceDir?: string;
}) => Promise<GatewayModelCatalogSnapshot>;
readPreparedGatewayModelCatalog?: (params?: {
agentId?: string;
agentDir?: string;
workspaceDir?: string;
}) => Promise<PreparedGatewayModelCatalog | undefined>;
readPreparedGatewayModelCatalogBatch?: (agentIds: readonly string[]) => Promise<PreparedGatewayModelCatalogReadResult[]>;
readChatMetadata: (params: ChatMetadataReadParams) => Promise<ChatMetadataResult>;
readChatStartupProjection?: (params: ChatStartupProjectionReadParams) => Promise<ChatStartupProjectionResult | undefined>;
getHealthCache: () => HealthSummary | null;
logHealth: {
error: (message: string) => void;
};
logGateway: SubsystemLogger;
publishPresence: () => void;
/** Current live transports, independent of the bounded legacy beacon cache. */
getPresenceSnapshot: () => PresenceEntry[];
/** Instance-local native approval subscribers; never derived from a network client. */
approvalEvents?: GatewayApprovalEventPublisher;
recoveryRuntime?: GatewayRecoveryRuntime;
/** Uses the lifecycle owner's module graph for plugin and detached agent turns. */
createAgentTurnFacade?: InternalAgentTurnFacadeFactory;
enforceSharedGatewayAuthGenerationForConfigWrite?: (nextConfig: OpenClawConfig, previousConfig: OpenClawConfig) => void;
nodeRegistry: NodeRegistry;
agentRunSeq: Map<string, number>;
chatAbortControllers: Map<string, ChatAbortControllerEntry>;
/** Cancel identities for turns waiting in the followup/collect queue. */
chatQueuedTurns: Map<string, QueuedChatTurnEntry>;
chatRunState: ChatRunState;
addChatRun: (sessionId: string, entry: ChatRunRegistration) => void;
removeChatRun: (sessionId: string, clientRunId: string, sessionKey?: string) => ChatRunEntry | undefined;
dedupe: Map<string, DedupeEntry>;
wizardSessions: Map<string, WizardSession>;
systemAgentSessions: Map<string, GatewaySystemAgentSession>;
findRunningWizard: () => string | null;
purgeWizardSession: (id: string) => void;
wizardRunner: (opts: OnboardOptions, runtime: RuntimeEnv, prompter: WizardPrompter) => Promise<void>;
channelWizardRunner: ChannelSetupWizardRunner;
unavailableGatewayMethods?: ReadonlySet<string>;
};
/** Socket-bound services and connection state supplied by the Gateway transports. */
type GatewayTransportContext = {
portalService?: GatewayPortalService;
getMcpAppSandboxPort?: () => number | undefined;
ensureSandboxHostPort?: () => Promise<number>;
broadcast: GatewayBroadcastFn;
broadcastToConnIds: GatewayBroadcastToConnIdsFn;
getClientConnIds?: (filter?: (client: GatewayClient) => boolean) => ReadonlySet<string>;
nodeSendToSession: (sessionKey: string, event: string, payload: unknown, opts?: GatewayBroadcastOpts) => void;
nodeSendToAllSubscribed: (event: string, payload: unknown) => void;
nodeSubscribe: (nodeId: string, sessionKey: string, connId?: string) => void;
nodeUnsubscribe: (nodeId: string, sessionKey: string, connId?: string) => void;
nodeUnsubscribeAll: (nodeId: string) => void;
hasConnectedTalkNode: () => Promise<boolean>;
isConnectionActive?: (connId: string) => boolean;
/** Server-stamped activity from an accepted request on the exact live person connection. */
recordClientActivity?: (client: GatewayClient | null) => void;
hasExecApprovalClients?: (excludeConnId?: string) => boolean;
getApprovalClientConnIds?: <TPayload>(params?: {
approvalKind?: "exec" | "plugin" | "system-agent";
excludeConnId?: string;
filter?: (client: GatewayClient, record?: ExecApprovalRecord<TPayload>) => boolean;
record?: ExecApprovalRecord<TPayload>;
}) => ReadonlySet<string>;
disconnectClientsForDevice?: (deviceId: string, opts?: {
role?: string;
}) => void;
disconnectClientsForUserProfile?: (profileId: string) => void;
invalidateClientsForDevice?: (deviceId: string, opts?: {
role?: string;
reason?: string;
}) => void;
hasConnectedClientsForDevice?: (deviceId: string) => boolean;
refreshConnectedUserProfile?: (profile?: {
id: string;
displayName: string | null;
avatarRevision: string;
hasAvatar: boolean;
updatedAt: number;
}) => void;
disconnectClientsUsingSharedGatewayAuth?: () => void;
terminalSessions?: TerminalSessionManager;
subscribeSessionEvents: (connId: string) => void;
unsubscribeSessionEvents: (connId: string) => void;
forgetConnectionAncestors: (connId: string) => void;
subscribeSessionMessageEvents: SessionMessageSubscriberRegistry["subscribe"];
unsubscribeSessionMessageEvents: SessionMessageSubscriberRegistry["unsubscribe"];
unsubscribeAllSessionEvents: (connId: string) => void;
getSessionEventSubscriberConnIds: () => ReadonlySet<string>;
registerToolEventRecipient: (runId: string, connId: string) => void;
};
/** Resident-owned services bridged into request handling by the server lifecycle. */
type GatewayResidentBridgeContext = {
getGatewayMethodRegistry?: () => GatewayMethodRegistry;
controlUiSessionPullRequests?: ReturnType<typeof createControlUiSessionPullRequestSubscriptions>;
sessionViewerPresence?: ReturnType<typeof createSessionViewerPresenceDeclarations>;
applyPluginLifecycleChange?: PluginLifecycleRuntimeApply;
refreshHealthSnapshot: (opts?: {
probe?: boolean;
includeSensitive?: boolean;
}) => Promise<HealthSummary>;
/** Durable cloud-worker lifecycle; absent from lightweight in-process contexts. */
workerEnvironmentService?: WorkerEnvironmentServiceContract;
/** Gateway-host desktop acquisition and observation; present only after enabled startup. */
hostDesktopService?: HostDesktopService;
/** Local computer provider shared with the node host, owned by this Gateway lifetime. */
gatewayComputerService?: GatewayComputerService;
/** Durable per-session worker placement; absent only from lightweight in-process contexts. */
workerSessionPlacementService?: WorkerSessionPlacementReader & Partial<WorkerSessionPlacementRetirementService>;
/** Process-local health samples fenced to the exact active placement owner. */
workerPlacementDiskSpaceReader?: WorkerPlacementDiskSpaceReader;
/** Process-current paired-device runner proof for active placement projection. */
workerPlacementRunnerAvailabilityReader?: WorkerPlacementRunnerAvailabilityReader;
/** Process-local installation progress for the placement's session-host node. */
workerPlacementRuntimeInstallReader?: WorkerPlacementRuntimeInstallReader;
/** Use-time approval authority validation over the live run/worker owners. */
validateAgentRuntimeApprovalAuthority?: AgentRuntimeApprovalAuthorityValidator;
/** One-way local-to-worker dispatch; absent when cloud workers are disabled. */
workerPlacementDispatchService?: WorkerPlacementDispatchContract;
workerRepositoryWorkspaceMutationService?: ReturnType<typeof createRepositoryWorkspaceMutationService>;
githubPublicationService?: GitHubPublicationCoordinator;
githubOAuthService?: ReturnType<typeof createGitHubOAuthLifecycle>;
modelAccountConnectService?: ReturnType<typeof createModelAccountConnectService>;
getRuntimeSnapshot: (options?: ChannelRuntimeSnapshotOptions) => ChannelRuntimeSnapshot;
getEventLoopHealth?: () => GatewayEventLoopHealth | undefined;
getConfigReloaderHotReloadStatus?: () => GatewayHotReloadStatus | undefined;
getDeferredChannelReloads?: () => readonly GatewayDeferredChannelReload[];
startChannel: (channel: ChannelId$1, accountId?: string, opts?: StartChannelOptions) => Promise<ReadonlyMap<string, ChannelAccountStartOutcome>>;
stopChannel: (channel: ChannelId$1, accountId?: string) => Promise<void>;
markChannelLoggedOut: (channelId: ChannelId$1, cleared: boolean, accountId?: string) => void;
broadcastVoiceWakeChanged: (triggers: string[]) => void;
broadcastVoiceWakeRoutingChanged: (config: VoiceWakeRoutingConfig) => void;
};
/** Complete runtime context available to gateway request handlers. */
type GatewayContextResolver = () => GatewayRequestContext | undefined;
type GatewayRequestContext = GatewayKernelContext & GatewayTransportContext & GatewayResidentBridgeContext & {
/** Retains original execution while callers may receive an early response. */
trackExecution: typeof trackAsyncWork;
/** Local commands can dispatch methods without owning a Gateway server. */
localEmbedded?: true;
/** Live instance routing only; never authorization or wire state. */
resolveGatewayContext?: GatewayContextResolver;
hostLifecycle?: GatewayHostLifecycle;
/** Entry-only access; the kernel owns closure. Absent in embedded-only contexts. */
requestEntryLifetime?: Pick<GatewayRequestEntryLifetime, "enter" | "signal">;
};
/** Full dispatch context for raw request frames before params are normalized. */
type GatewayRequestOptions = {
/** Transport can forward trusted worker JSON without materializing it. */
acceptsSerializedJson?: boolean;
req: RequestFrame;
client: GatewayClient | null;
isWebchatConnect: (params: ConnectParams | null | undefined) => boolean;
respond: RespondFn;
context: GatewayRequestContext;
methodRegistry?: GatewayMethodRegistryView;
/** Shared entry/publication precondition; never retained as accepted-run authority. */
expectedProfileBinding?: ExpectedProfileBinding;
/** In-process Gateway lifetime guard composed into durable session mutations. */
sessionMutationCommitGuard?: () => void;
/** In-process caller lifetime; never serialized into a Gateway request frame. */
signal?: AbortSignal;
/** Live transport authority; in-process only and never derived from request data. */
hasCurrentClientAuthority?: () => boolean;
};
/** Commit-time guard captured by the pre-dispatch session participation check. */
type SessionMutationAuthorization = {
talkSessionTarget?: PreparedTalkSessionTarget;
/** Original materialized target; Stop must match producer facts, not a later row lookup. */
admittedTarget?: Readonly<{
agentId: string;
sessionKey: string;
sessionId: string;
}>;
assertCurrent: () => void;
/** Original host/session authority for committed input custody, without the selection precondition. */
assertAdmittedInputCurrent?: () => void;
/** Creation-owner notification after COMMIT; binds only this request's previously absent row. */
recordCreatedSession?: (target: {
agentId: string;
sessionKey: string;
storePath: string;
sessionId: string;
lifecycleRevision?: string;
}) => void;
assertTargetCurrent: (target: {
sessionKey: string;
agentId?: string;
/** Internal ensure result: may materialize a previously id-less Talk target, never replace it. */
ensuredSessionId?: string;
}) => void;
};
/** Normalized method invocation options passed to registered handlers. */
type GatewayRequestHandlerOptions = Omit<GatewayRequestOptions, "methodRegistry" | "expectedProfileBinding"> & {
params: Record<string, unknown>;
sessionMutationAuthorization?: SessionMutationAuthorization;
/** Host-prepared session resource authority; services explicitly retain their own borrow. */
sessionAccessAuthority?: GatewaySessionAccessAuthority;
};
/** Single gateway method implementation. */
type GatewayRequestHandler = (opts: GatewayRequestHandlerOptions) => Promise<void> | void;
/** Registry fragment keyed by gateway protocol method name. */
type GatewayRequestHandlers = Record<string, GatewayRequestHandler>;
//#endregion
//#region src/plugins/plugin-invocation-scope.d.ts
/** Finite execution custody for one host-selected registry and its exact instances. */
declare class PluginInvocationScope {
readonly registry: PluginRegistry;
private readonly bindings;
private readonly consumers;
private closed;
private readonly consumerKind;
constructor(registry: PluginRegistry, instances: Iterable<PluginInstanceHandle>, options?: {
retained?: boolean;
parent?: PluginInvocationScope;
kind?: "work" | "custody";
});
private consumer;
private assertOpen;
lookup(instance: PluginInstanceHandle): PluginInvocationBinding | undefined;
run<T>(run: () => T): T;
wrap<T>(value: T): T;
/** Transfer custody before revoking callbacks captured by ordinary engine operations. */
beginCleanup(): {
scope: PluginInvocationScope;
release: () => Promise<void>;
};
release(): void;
}
//#endregion
//#region src/plugins/registry-registration-resources.d.ts
type RegistrationDisposer = {
id: string;
dispose: () => void | Promise<void>;
};
type RegistrationCleanup = (run: () => Promise<void>) => Promise<void>;
//#endregion
//#region src/plugins/registry-inspection-resources.d.ts
/** Owns only an explicitly acquired, uncached inspection's registration resources. */
declare class PluginRegistryInspectionResources {
#private;
private readonly retire;
constructor(retire: (registry: PluginRegistry | undefined, rollbackInstances: ReadonlySet<object>) => Promise<void>);
attach(registry: PluginRegistry): void;
register(pluginId: string, disposer: RegistrationDisposer): void;
runRegistration(pluginId: string, run: () => void, runCleanup?: RegistrationCleanup): void;
trackRegistration(pending: Promise<unknown>): void;
rollback(pluginId: string, retire?: () => Promise<void>, instance?: object): void;
/** Copied callbacks keep their source through this inspection's final disposer. */
retainDependency(dependency: PluginRegistryInspectionResources): void;
/** Adopt executable donor custody before the acquired view can escape to a caller. */
adoptInvocations(registry: PluginRegistry, donor: PluginRegistry | undefined): void;
wrapAdoptedValue<T>(value: T): T;
/** Logical use owns its execution consumers separately from this inspection's physical claims. */
createInvocationScope(registry: PluginRegistry, instances?: Iterable<PluginInstanceHandle>): PluginInvocationScope;
/** Recorded coverage survives retirement; retain() still checks this inspection's lifetime. */
coversSource(source: PluginRegistryInspectionResources): boolean;
/** Retains physical resources without extending this inspection's authority. */
retain(): {
release: () => Promise<void>;
};
release(): Promise<void>;
}
//#endregion
//#region src/plugins/capability-provider-runtime.d.ts
declare function prepareMediaCapabilityProviders(params: {
cfg?: OpenClawConfig;
pluginMetadataSnapshot: Pick<PluginMetadataSnapshot, "index" | "plugins">;
registry?: PluginRegistry;
}): Readonly<{
mediaUnderstandingProviders: readonly MediaUnderstandingProvider[] | undefined;
imageGenerationProviders: readonly ImageGenerationProvider[] | undefined;
videoGenerationProviders: readonly VideoGenerationProvider[] | undefined;
musicGenerationProviders: readonly MusicGenerationProvider[] | undefined;
}>;
//#endregion
//#region src/plugins/provider-discovery.d.ts
type PreparedProviderStaticCatalogEntry = Readonly<{
provider: ProviderPlugin;
result: Awaited<ReturnType<typeof runProviderStaticCatalog>>;
providerConfigs: Readonly<Record<string, ModelProviderConfig>>;
}>;
type PreparedProviderStaticCatalog = Readonly<{
/** Provider handles captured for this config/workspace generation. */
providers?: readonly ProviderPlugin[];
entries: readonly PreparedProviderStaticCatalogEntry[];
}>;
declare function runProviderStaticCatalog(params: {
provider: ProviderPlugin;
signal?: AbortSignal;
}): Promise<ProviderCatalogResult> | undefined;
//#endregion
//#region src/agents/embedded-agent-runner/model.inline-provider.d.ts
/**
* Normalizes inline `models.providers` config into runtime model entries.
*/
type InlineModelEntry = Omit<ModelDefinitionConfig, "api" | "contextWindow"> & {
api?: Api;
contextWindow?: number;
provider: string;
baseUrl?: string;
headers?: Record<string, string>;
};
//#endregion
//#region src/agents/prepared-model-catalog.types.d.ts
type PublishedModelCatalogOwnerCandidate = Readonly<{
/** Captured during preparation; undefined is a known-unbound runtime. */
catalogOwner: Readonly<{
agentId: string;
workspaceDir: string;
}> | undefined;
agentId?: string;
agentDir: string;
workspaceDir?: string;
config: OpenClawConfig;
observationConfig: OpenClawConfig;
authModes: PreparedAgentCredentialModes;
authStore?: AuthProfileStore;
metadataSnapshot: PluginMetadataSnapshot;
/** Registry owned by this prepared generation; omitted from read-only builds. */
pluginRegistry?: PluginRegistry;
/** Reports whether this exact lifecycle generation is still published. */
isCurrent: () => boolean;
modelCatalog: ModelCatalogSnapshot;
}>;
//#endregion
//#region src/agents/prepared-model-runtime.types.d.ts
type PreparedConfiguredRuntimeModel = Readonly<{
provider: string;
modelId: string;
model: ProviderRuntimeModel;
}>;
type PreparedModelCatalogRefreshOptions = {
refresh?: boolean;
providerIds?: readonly string[];
changedOnly?: boolean;
};
type PreparedNativeModelSelection = {
provider: string;
modelId: string;
runtime: string;
};
type PreparedMediaCapabilityProviderSource = Readonly<{
registry: PluginRegistry;
resources: Pick<PluginRegistryInspectionResources, "retain" | "createInvocationScope">;
}>;
type PreparedMediaCapabilityProviderAcquisition = Readonly<{
providers: ReturnType<typeof prepareMediaCapabilityProviders>;
assertOpen: () => void;
release: () => Promise<void>;
}>;
type PreparedModelRuntimePluginGeneration = Readonly<{
pluginMetadataSnapshot: PluginMetadataSnapshot;
messageToolCatalog?: PreparedMessageToolCatalog;
mediaCapabilityProviders?: ReturnType<typeof prepareMediaCapabilityProviders>;
mediaCapabilityProviderSource?: PreparedMediaCapabilityProviderSource;
preparedStaticProviderCatalog?: PreparedProviderStaticCatalog;
/** Captured static rows; cleared when catalog discovery expands the provider registry. */
providerStaticModels?: readonly ProviderRuntimeModel[];
inlineProviderModels: readonly InlineModelEntry[];
configuredCatalogEntries: readonly ModelCatalogEntry[];
pluginRegistry?: PluginRegistry;
inboundPluginRegistry?: PluginRegistry;
/** Immutable artifact choice for every registry reuse in this generation. */
preferBuiltPluginArtifacts?: boolean;
}>;
type PreparedModelRuntimeSnapshot = Readonly<{
catalogOwner: PublishedModelCatalogOwnerCandidate["catalogOwner"];
agentId?: string;
agentDir: string;
inheritedAuthDir?: string;
workspaceDir?: string;
/** Run-prepared repository root; null means discovery completed without a match. */
repoRoot?: string | null;
/** Stable identity derived from repoRoot; null means the run is outside a repository. */
projectKey?: string | null;
/** Session active project set, ordered most-recent first; empty before run binding. */
activeProjectKeys: readonly string[];
config: OpenClawConfig;
/** Native observations retain preparation identity across model-neutral config publications. */
observationConfig: OpenClawConfig;
isCurrent: () => boolean;
/** Secret-free usable auth modes captured by this exact lifecycle generation. */
authModes: PreparedAgentCredentialModes;
metadataSnapshot: PluginMetadataSnapshot;
messageToolCatalog?: PreparedMessageToolCatalog;
mediaCapabilityProviders?: ReturnType<typeof prepareMediaCapabilityProviders>;
/** Borrows an inspected source; raw prepared hosts retain their existing external ownership. */
acquireMediaCapabilityProviders?: () => PreparedMediaCapabilityProviderAcquisition;
/** Registry value owned by this generation; omitted from read-only builds. */
pluginRegistry?: PluginRegistry;
allowGatewaySubagentBinding: boolean;
/**
* Configured model projection used by turn admission and synchronous callers.
* Full inventory discovery is deliberately outside the startup publication boundary.
*/
modelCatalog: ModelCatalogSnapshot;
/** Reads accepted inventory without scheduling discovery or expiry renewal. */
readFullModelCatalog?: () => ModelCatalogSnapshot | undefined;
/** Inventory demand may renew expired providers without waiting or replacing saved rows. */
refreshExpiredModelCatalog?: () => void;
/** Reads validated executable rows from this owner's accepted provider publication. */
readPublishedModels?: () => ReadonlyMap<string, readonly Model[]> | undefined;
/** Builds this generation's full control-plane catalog without replacing turn facts. */
loadFullModelCatalog?: (options?: PreparedModelCatalogRefreshOptions) => Promise<ModelCatalogSnapshot>;
/** Acquires the selected runtime's native facts before host model resolution. */
loadNativeModelCatalog?: (selection: PreparedNativeModelSelection) => Promise<ModelCatalogSnapshot>;
/** Full static models for configured refs, resolved once at the lifecycle boundary. */
configuredRuntimeModels: readonly PreparedConfiguredRuntimeModel[];
/** Exact logical IDs precede static equivalence within this policy generation. */
findConfiguredRuntimeModel: (provider: string, modelId: string) => ProviderRuntimeModel | undefined;
/** Supported aliases for this immutable turn generation, separate from catalog metadata. */
configuredModelAliases?: readonly Readonly<{
alias: string;
provider: string;
model: string;
}>[];
/** Inline provider projection prepared once for all resolutions owned by this snapshot. */
inlineProviderModels: readonly InlineModelEntry[];
createStores: () => PreparedModelRuntimeStores;
/** Bounded metadata shared by runs; replacing the model/auth generation drops the memo. */
routeModelResolutionMemo?: Map<string, Promise<Model>>;
}>;
type PreparedModelRuntimeStores = {
authStorage: AuthStorage;
modelRegistry: ModelRegistry$1;
};
//#endregion
//#region src/plugins/provider-external-auth.d.ts
declare const { resolveExternalAuthProfilesWithPlugins }: Readonly<{
resolveExternalAuthProfilesWithPlugins: (params: Parameters<ProviderExternalAuthProfileResolver>[0]) => ReturnType<ProviderExternalAuthProfileResolver>;
}>;
//#endregion
//#region src/plugins/provider-runtime.d.ts
type ProviderRuntimeLookup = Pick<Parameters<typeof resolveProviderRuntimePlugin>[0], "provider" | "config" | "workspaceDir" | "env">;
declare const runProviderDynamicModel: (params: ProviderRuntimeLookup & {
context: ProviderResolveDynamicModelContext;
}) => (Omit<Model<Api>, "compat"> & {
compat?: ModelCompatConfig;
contextWindows?: ModelCatalogContextWindowOption[];
contextWindowDefault?: string;
contextTokens?: number;
maxTokensSource?: "configured" | "discovered";
params?: Record<string, unknown>;
requestTimeoutMs?: number;
toolSearchMode?: "tools" | false;
compactionThinkingDefault?: NonNullable<ProviderThinkingProfile["defaultLevel"]>;
mediaInput?: ModelMediaInputConfig;
}) | undefined;
declare const prepareProviderDynamicModel: (params: ProviderRuntimeLookup & {
context: ProviderResolveDynamicModelContext;
}) => Promise<void | ProviderRuntimeModel | undefined>;
declare function shouldPreferProviderRuntimeResolvedModel(params: ProviderRuntimeLookup & {
context: ProviderPreferRuntimeResolvedModelContext;
}): boolean;
declare function normalizeProviderResolvedModelWithPlugin(params: ProviderRuntimeLookup & {
modelId?: string | null;
pluginMetadataSnapshot?: PluginMetadataRegistryView;
context: ProviderNormalizeResolvedModelContext;
}): ProviderRuntimeModel | undefined;
declare function applyProviderResolvedTransportWithPlugin(params: ProviderRuntimeLookup & {
modelId?: string | null;
context: ProviderNormalizeResolvedModelContext;
}): ProviderRuntimeModel | undefined;
declare function normalizeProviderTransportWithPlugin(params: ProviderRuntimeLookup & {
modelId?: string | null;
context: ProviderNormalizeTransportContext;
}): {
api?: string | null;
baseUrl?: string;
} | undefined;
declare const buildProviderUnknownModelHintWithPlugin: (params: ProviderRuntimeLookup & {
context: ProviderBuildUnknownModelHintContext;
}) => string | undefined;
declare function augmentModelCatalogWithProviderPlugins(params: {
providerIds?: readonly string[];
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
metadataSnapshot?: PluginMetadataSnapshot;
context: ProviderAugmentModelCatalogContext;
}): Promise<ModelCatalogEntry[]>;
//#endregion
//#region src/agents/embedded-agent-runner/model.provider-hooks.types.d.ts
type ProviderRuntimeHooks = {
resolveToolSearchMode?: (context: ProviderToolSearchPolicyContext) => "tools" | false | undefined;
applyProviderResolvedTransportWithPlugin?: (params: Parameters<typeof applyProviderResolvedTransportWithPlugin>[0]) => unknown;
buildProviderUnknownModelHintWithPlugin: typeof buildProviderUnknownModelHintWithPlugin;
prepareProviderDynamicModel: typeof prepareProviderDynamicModel;
runProviderDynamicModel: (params: Parameters<typeof runProviderDynamicModel>[0]) => unknown;
shouldPreferProviderRuntimeResolvedModel?: typeof shouldPreferProviderRuntimeResolvedModel;
normalizeProviderResolvedModelWithPlugin: (params: Parameters<typeof normalizeProviderResolvedModelWithPlugin>[0]) => unknown;
normalizeProviderTransportWithPlugin: typeof normalizeProviderTransportWithPlugin;
};
//#endregion
//#region src/agents/embedded-agent-runner/model.d.ts
type CommonModelResolutionOptions = {
assertCurrent?: () => void;
authStorage?: AuthStorage;
modelRegistry?: ModelRegistry$1;
agentId?: string;
runtimeHooks?: ProviderRuntimeHooks;
skipProviderRuntimeHooks?: boolean;
workspaceDir?: string;
authProfileId?: string;
authProfileMode?: AuthProfileCredential["type"] | "aws-sdk";
preferredProfile?: string;
};
type AsyncModelResolutionOptions = CommonModelResolutionOptions & {
abortSignal?: AbortSignal;
/** Selected executable IDs must not pass through input aliases again. */
modelIdSource?: "input" | "selected";
allowBundledStaticCatalogFallback?: boolean;
/** Only harness-owned execution may replace configured transport with catalog defaults. */
preferBundledStaticCatalogTransport?: boolean;
agentRuntimeId?: string;
skipAgentDiscovery?: boolean;
preparedModelRuntime?: PreparedModelRuntimeSnapshot;
/** Resolve local provider facts without starting asynchronous catalog discovery. */
deferProviderDynamicModelPreparation?: boolean;
};
type ModelResolution = {
authStorage: AuthStorage;
modelRegistry: ModelRegistry$1;
} & ({
model: Model;
logicalRef: Readonly<ProviderModelRef>;
error?: undefined;
} | {
model?: undefined;
error: string;
/** Local preparation exhausted its facts without invoking the provider's async model owner. */
deferred?: "provider-dynamic-model";
});
declare function resolveModelAsync(provider: string, modelId: string, agentDir?: string, cfg?: OpenClawConfig, options?: AsyncModelResolutionOptions): Promise<ModelResolution>;
//#endregion
//#region src/agents/simple-completion-scope.d.ts
/** Shipped SDK resolver callbacks do not supply core-owned logical reference facts. */
type SimpleCompletionModelResolver = (...args: Parameters<typeof resolveModelAsync>) => Promise<Omit<Awaited<ReturnType<typeof resolveModelAsync>>, "logicalRef">>;
//#endregion
//#region src/agents/simple-completion.types.d.ts
type PreparedSimpleCompletionModel = {
model: Model;
auth: ResolvedProviderAuth;
/** Non-reversible owner proof captured from the same auth snapshot. */
sourceAuthFingerprint?: string;
} | {
error: string;
auth?: ResolvedProviderAuth;
};
//#endregion
//#region src/agents/simple-completion-execution.d.ts
type SimpleCompletionModelOptions = {
headers?: Record<string, string>;
sessionId?: string;
maxTokens?: number;
temperature?: number;
serviceTier?: SimpleStreamOptions["serviceTier"];
reasoning?: ThinkLevel;
strictReasoningTags?: boolean;
signal?: AbortSignal;
};
type PreparedCompletionParams = {
assertCurrent?: () => void;
model: Model;
auth: ResolvedProviderAuth;
context: Parameters<typeof completeSimple>[1];
cfg?: OpenClawConfig;
options?: SimpleCompletionModelOptions;
};
declare function completeWithPreparedSimpleCompletionModel(params: PreparedCompletionParams): Promise<AssistantMessage$1>;
//#endregion
//#region src/agents/simple-completion-runtime.d.ts
type AllowedMissingApiKeyMode = ResolvedProviderAuth["mode"];
type PrepareSimpleCompletionModelParams = {
cfg: OpenClawConfig | undefined;
agentId?: string;
provider: string;
modelId: string;
modelIdSource?: "input" | "selected";
agentDir?: string;
profileId?: string;
preferredProfile?: string;
allowMissingApiKeyModes?: ReadonlyArray<AllowedMissingApiKeyMode>;
allowBundledStaticCatalogFallback?: boolean;
skipAgentDiscovery?: boolean;
bindAuthOwner?: boolean;
modelResolver?: SimpleCompletionModelResolver;
signal?: AbortSignal;
/** Internal caller-owned generation. Public plugin callers use the agent helper below. */
preparedModelRuntime?: PreparedModelRuntimeSnapshot;
workspaceDir?: string;
agentRuntimeId?: string;
};
/** Prepares a model within the exact generation already held by its caller. */
declare function prepareSimpleCompletionModel(params: PrepareSimpleCompletionModelParams & {
preparedModelRuntime: PreparedModelRuntimeSnapshot;
}, assertCurrent?: () => void): Promise<PreparedSimpleCompletionModel>;
//#endregion
//#region src/tts/tts-types.d.ts
/** Resolved directive override policy after config defaults are applied. */
type ResolvedTtsModelOverrides = SpeechModelOverridePolicy;
/** Fully resolved TTS runtime config consumed by synthesis and status paths. */
type ResolvedTtsConfig = {
auto: TtsAutoMode;
mode: TtsMode;
provider: TtsProvider;
providerSource: "config" | "default";
persona?: string;
personas: Record<string, ResolvedTtsPersona>;
summaryModel?: string;
modelOverrides: ResolvedTtsModelOverrides;
providerConfigs: Record<string, SpeechProviderConfig>;
prefsPath?: string;
maxTextLength: number;
timeoutMs: number;
timeoutMsSource?: "config" | "default";
rawConfig?: TtsConfig;
sourceConfig?: OpenClawConfig;
};
//#endregion
//#region src/tts/tts-core.d.ts
type SummarizeTextDeps = {
completeWithPreparedSimpleCompletionModel: typeof completeWithPreparedSimpleCompletionModel;
prepareSimpleCompletionModel: (params: PrepareSimpleCompletionModelParams) => ReturnType<typeof prepareSimpleCompletionModel>;
requireApiKey: typeof requireApiKey;
};
type SummarizeResult = {
summary: string;
latencyMs: number;
inputLength: number;
outputLength: number;
};
/** Summarize long text before synthesis using the configured summary model. */
declare function summarizeText(params: {
text: string;
targetLength: number;
cfg: OpenClawConfig;
config: ResolvedTtsConfig;
timeoutMs: number;
agentId?: string;
}, deps?: SummarizeTextDeps): Promise<SummarizeResult>;
//#endregion
//#region src/tts/tts-auto-mode.d.ts
/** Normalize an unknown value into a supported TTS auto mode. */
declare function normalizeTtsAutoMode(value: unknown): TtsAutoMode | undefined;
//#endregion
//#region src/tts/tts-config.d.ts
/** Routing context used to layer global, agent, channel, and account TTS config. */
type TtsConfigResolutionContext = {
agentId?: string;
channelId?: string;
accountId?: string;
};
/** Resolve effective TTS config after applying global, agent, channel, and account layers. */
declare function resolveEffectiveTtsConfig(cfg: OpenClawConfig, contextOrAgentId?: string | TtsConfigResolutionContext): TtsConfig;
//#endregion
//#region src/tts/provider-registry-core.d.ts
/** Normalize user/provider IDs into the canonical speech provider ID shape. */
declare function normalizeSpeechProviderId(providerId: string | undefined): SpeechProviderId | undefined;
//#endregion
//#region src/tts/tts-settings.d.ts
declare function setTtsMachinePrefsPathResolver(resolver?: () => string | undefined): void;
declare function resolveModelOverridePolicy(overrides: TtsModelOverrideConfig | undefined): ResolvedTtsModelOverrides;
declare function resolveTtsConfig(cfgInput: OpenClawConfig, contextOrAgentId?: string | TtsConfigResolutionContext): ResolvedTtsConfig;
declare function resolveTtsPrefsPath(config: ResolvedTtsConfig): string;
declare function resolveTtsAutoMode(params: {
config: ResolvedTtsConfig;
prefsPath: string;
sessionAuto?: string;
}): TtsAutoMode;
declare function buildTtsSystemPromptHint(cfg: OpenClawConfig, agentId?: string, options?: {
messageToolOnly?: boolean;
}): string | undefined;
declare function isTtsEnabled(config: ResolvedTtsConfig, prefsPath: string, sessionAuto?: string): boolean;
declare function getTtsPersona(config: ResolvedTtsConfig, prefsPath: string): ResolvedTtsPersona | undefined;
declare function listTtsPersonas(config: ResolvedTtsConfig): ResolvedTtsPersona[];
declare function getTtsMaxLength(prefsPath: string): number;
declare function isSummarizationEnabled(prefsPath: string): boolean;
//#endregion
//#region src/tts/tts-provider-resolution.d.ts
declare function getResolvedSpeechProviderConfig(config: ResolvedTtsConfig, providerId: string, cfg?: OpenClawConfig): SpeechProviderConfig;
declare function resolveTtsProviderOrder(primary: TtsProvider, cfg?: OpenClawConfig, providers?: readonly SpeechProviderPlugin$1[]): TtsProvider[];
declare function isTtsProviderConfigured(config: ResolvedTtsConfig, provider: TtsProvider | SpeechProviderPlugin$1, cfg?: OpenClawConfig): boolean;
//#endregion
//#region src/tts/tts-runtime-types.d.ts
type TtsAttemptReasonCode = "success" | "no_provider_registered" | "not_configured" | "unsupported_for_streaming" | "unsupported_for_telephony" | "timeout" | "provider_error";
type TtsProviderAttempt = {
provider: string;
outcome: "success" | "skipped" | "failed";
reasonCode: TtsAttemptReasonCode;
persona?: string;
personaBinding?: "applied" | "missing" | "none";
latencyMs?: number;
error?: string;
};
type TtsAttemptOutcome = {
success: boolean;
error?: string;
latencyMs?: number;
provider?: string;
persona?: string;
fallbackFrom?: string;
attemptedProviders?: string[];
attempts?: TtsProviderAttempt[];
};
type TtsMediaOutcome = TtsAttemptOutcome & {
outputFormat?: string;
};
type TtsProviderMediaOutcome = TtsMediaOutcome & {
providerModel?: string;
providerVoice?: string;
};
type TtsVoiceMediaOutcome = TtsProviderMediaOutcome & {
voiceCompatible?: boolean;
fileExtension?: string;
target?: "audio-file" | "voice-note";
};
type TtsResult = TtsMediaOutcome & {
audioPath?: string;
voiceCompatible?: boolean;
audioAsVoice?: boolean;
target?: "audio-file" | "voice-note";
};
type TtsSynthesisResult = TtsVoiceMediaOutcome & {
audioBuffer?: Buffer;
};
type TtsStreamResult = TtsVoiceMediaOutcome & {
audioStream?: ReadableStream<Uint8Array>;
release?: () => Promise<void>;
};
type TtsSynthesisStreamResult = TtsStreamResult;
type TtsTelephonyResult = TtsProviderMediaOutcome & {
audioBuffer?: Buffer;
sampleRate?: number;
};
type TtsStatusEntry = TtsAttemptOutcome & {
timestamp: number;
textLength: number;
summarized: boolean;
};
//#endregion
//#region src/tts/tts-synthesis-support.d.ts
declare function formatTtsProviderError(provider: TtsProvider, err: unknown): string;
declare function sanitizeTtsErrorForLog(err: unknown): string;
//#endregion
//#region src/tts/tts-synthesis.d.ts
type TtsAudioPersistence = (params: {
audioBuffer: Buffer;
cfg: OpenClawConfig;
fileExtension: string;
outputFormat?: string;
}) => Promise<string>;
declare function supportsNativeVoiceNoteTts(channel: string | undefined): boolean;
declare function supportsTranscodedVoiceNoteTts(channel: string | undefined): boolean;
declare function resolveTtsSynthesisTarget(channel: string | undefined): "audio-file" | "voice-note";
declare function shouldDeliverTtsAsVoice(params: {
channel: string | undefined;
target: "audio-file" | "voice-note" | undefined;
voiceCompatible: boolean | undefined;
fileExtension?: string;
outputFormat?: string;
}): boolean;
declare function textToSpeechCore(params: SpeechSynthesisParams$1, persistTtsAudio: TtsAudioPersistence): Promise<TtsResult>;
type SpeechSynthesisParams$1 = {
text: string;
cfg: OpenClawConfig;
prefsPath?: string;
channel?: string;
overrides?: TtsDirectiveOverrides;
disableFallback?: boolean;
timeoutMs?: number;
agentId?: string;
accountId?: string;
};
declare function synthesizeSpeech(params: SpeechSynthesisParams$1): Promise<TtsSynthesisResult>;
//#endregion
//#region src/tts/runtime-availability.d.ts
/** Host-owned availability guard shared by every speech runtime entrypoint. */
/** Installs the process-lifecycle availability guard owned by the OpenClaw host. */
declare function setSpeechRuntimeAvailabilityGuard(guard: (() => void) | undefined): void;
//#endregion
//#region src/tts/tts-settings-writes.d.ts
declare function setTtsAutoMode(prefsPath: string, mode: TtsAutoMode): void;
declare function setTtsEnabled(prefsPath: string, enabled: boolean): void;
declare function setTtsPersona(prefsPath: string, persona: string | null | undefined): void;
declare function setTtsProvider(prefsPath: string, provider: TtsProvider): void;
declare function setTtsMaxLength(prefsPath: string, maxLength: number): void;
declare function setSummarizationEnabled(prefsPath: string, enabled: boolean): void;
//#endregion
//#region src/tts/tts-payload.d.ts
declare function getLastTtsAttempt(): TtsStatusEntry | undefined;
declare function setLastTtsAttempt(entry: TtsStatusEntry | undefined): void;
declare function listSpeechVoices(params: {
provider: string;
cfg?: OpenClawConfig;
config?: ResolvedTtsConfig;
apiKey?: string;
baseUrl?: string;
}): Promise<SpeechVoiceOption[]>;
//#endregion
//#region src/tts/tts-request.d.ts
type PreparedTtsRequest = {
cfg: OpenClawConfig;
directives: TtsDirectiveParseResult;
};
/** Merge a surface TTS override and resolve its inline synthesis directives. */
declare function prepareTtsRequest(params: {
cfg: OpenClawConfig;
override?: TtsConfig;
text: string;
}): Promise<PreparedTtsRequest>;
declare function resolveExplicitTtsOverrides(params: {
cfg: OpenClawConfig;
prefsPath?: string;
provider?: string;
modelId?: string;
voiceId?: string;
agentId?: string;
channelId?: string;
accountId?: string;
}): TtsDirectiveOverrides;
//#endregion
//#region src/tts/tts-streaming.d.ts
type SpeechSynthesisParams = Parameters<typeof synthesizeSpeech>[0];
declare function streamSpeech(params: SpeechSynthesisParams): Promise<TtsSynthesisStreamResult>;
declare function textToSpeechStream(params: SpeechSynthesisParams): Promise<TtsStreamResult>;
//#endregion
//#region src/tts/tts-telephony.d.ts
declare function textToSpeechTelephony(params: {
text: string;
cfg: OpenClawConfig;
prefsPath?: string;
overrides?: TtsDirectiveOverrides;
timeoutMs?: number;
}): Promise<TtsTelephonyResult>;
declare namespace runtime_api_d_exports {
export { ResolvedTtsConfig, ResolvedTtsModelOverrides, TtsDirectiveOverrides, TtsDirectiveParseResult, TtsStreamResult, TtsSynthesisResult, TtsSynthesisStreamResult, TtsTelephonyResult, buildTtsSystemPromptHint, getLastTtsAttempt, getResolvedSpeechProviderConfig, getTtsMaxLength, getTtsPersona, getTtsProvider, isSummarizationEnabled, isTtsEnabled, isTtsProviderConfigured, listSpeechVoices, listTtsPersonas, prepareTtsRequest, resolveExplicitTtsOverrides, resolveTtsAutoMode, resolveTtsConfig, resolveTtsPrefsPath, resolveTtsProviderOrder, setLastTtsAttempt, setSpeechRuntimeAvailabilityGuard, setSummarizationEnabled, setTtsAutoMode, setTtsEnabled, setTtsMachinePrefsPathResolver, setTtsMaxLength, setTtsPersona, setTtsProvider, streamSpeech, synthesizeSpeech, testApi, textToSpeechStream, textToSpeechTelephony };
}
declare function getTtsProvider(config: ResolvedTtsConfig, prefsPath: string): TtsProvider;
declare const testApi: {
parseTtsDirectives: typeof parseTtsDirectives;
resolveModelOverridePolicy: typeof resolveModelOverridePolicy;
supportsNativeVoiceNoteTts: typeof supportsNativeVoiceNoteTts;
supportsTranscodedVoiceNoteTts: typeof supportsTranscodedVoiceNoteTts;
resolveTtsSynthesisTarget: typeof resolveTtsSynthesisTarget;
shouldDeliverTtsAsVoice: typeof shouldDeliverTtsAsVoice;
summarizeText: typeof summarizeText;
getResolvedSpeechProviderConfig: typeof getResolvedSpeechProviderConfig;
formatTtsProviderError: typeof formatTtsProviderError;
sanitizeTtsErrorForLog: typeof sanitizeTtsErrorForLog;
};
//#endregion
//#region src/tts/tts.d.ts
declare function textToSpeech(params: Parameters<typeof textToSpeechCore>[0]): Promise<TtsResult>;
//#endregion
//#region src/sessions/session-initialization.d.ts
/** Creation-only authority. Copied fields never identify an initializer to the host. */
type SessionInitialization = {
assertCurrent: () => void;
assertRollbackCurrent: () => void;
/** Prepares child policy data without constructing tools or acquiring run authority. */
prepareNativeToolPolicy?: (model: SessionNativeToolModel) => Promise<Readonly<{
webSearchAllowed: boolean;
}>>;
};
/** Native model selection data; the creation owner fixes every authority-bearing input. */
type SessionNativeToolModel = Readonly<{
provider: string;
runtimeProvider?: string;
id: string;
}>;
//#endregion
//#region src/agents/defaults.d.ts
declare const DEFAULT_PROVIDER = "openai";
declare const DEFAULT_MODEL = "gpt-6-astra";
//#endregion
//#region src/plugins/runtime/runtime-agent-session-catalog.d.ts
type RuntimeSessionCatalogCreateTargetParams = {
config: OpenClawConfig;
requestedAgentId?: string;
provider: string;
modelIds: readonly string[];
agentRuntime: string;
};
/**
* Resolve a synchronous catalog create target through the same model/runtime
* policy used by agent turns, without making plugins import that policy graph.
*/
declare function resolveAgentCatalogCreateTarget(params: RuntimeSessionCatalogCreateTargetParams): SessionCatalogCreateTarget | undefined;
//#endregion
//#region src/agents/spawned-context.d.ts
type SpawnedRunMetadata = {
spawnedBy?: string | null;
groupId?: string | null;
groupChannel?: string | null;
groupSpace?: string | null;
workspaceDir?: string | null;
};
type SpawnedToolContext = {
agentGroupId?: string | null;
agentGroupChannel?: string | null;
agentGroupSpace?: string | null;
agentMemberRoleIds?: string[];
workspaceDir?: string;
/** Effective parent-turn level, including one-shot overrides, for child inheritance. */
requesterThinkingLevel?: ThinkLevel;
/** Effective parent-turn model; saved preferences may describe a later turn. */
requesterModel?: ProviderModelRef;
sessionPermissionPolicy?: PreparedSessionPermissionPolicy;
inheritedToolAllowlist?: string[];
inheritedToolDenylist?: string[];
};
//#endregion
//#region src/agents/bootstrap-files.d.ts
type BootstrapContextMode = "full" | "lightweight";
/** Resolves hook-adjusted, session-filtered bootstrap files for a run. */
type BootstrapFileResolutionParams = {
bootstrapUserProfileId?: string;
workspaceDir: string;
config?: OpenClawConfig;
sessionKey?: string;
sessionId?: string;
chatType?: ChatType;
agentId?: string;
warn?: (message: string) => void;
contextMode?: BootstrapContextMode;
runKind?: BootstrapContextRunKind;
readOnlyState?: boolean;
};
declare function resolveBootstrapFilesForRun(params: BootstrapFileResolutionParams): Promise<WorkspaceBootstrapFile[]>;
/** Resolves both raw bootstrap metadata and bounded context files for a run. */
declare function resolveBootstrapContextForRun(params: BootstrapFileResolutionParams): Promise<{
bootstrapFiles: WorkspaceBootstrapFile[];
contextFiles: EmbeddedContextFile[];
}>;
/** Builds bounded context files from already-resolved bootstrap file metadata. */
declare function buildBootstrapContextForFiles(bootstrapFiles: WorkspaceBootstrapFile[], params: {
config?: OpenClawConfig;
agentId?: string | null;
warn?: (message: string) => void;
}): EmbeddedContextFile[];
//#endregion
//#region src/agents/context-window-guard.d.ts
type ContextWindowSource = "model" | "modelsConfig" | "agentContextTokens" | "default";
type ContextWindowInfo = {
tokens: number;
referenceTokens?: number;
source: ContextWindowSource;
};
//#endregion
//#region src/agents/sandbox/context.d.ts
type ResolveSandboxContextParams = {
config?: OpenClawConfig;
agentId?: string;
execOverrides?: ExecPolicyOverrides;
requireCurrentConfig?: boolean;
assertCurrent?: () => void;
admittedRunContext?: AdmittedRunContext;
sessionKey?: string;
skillsSnapshot?: SkillSnapshot;
workspaceDir?: string;
/** Classification already prepared for this session's workspace setup. */
preparedRuntimeStatus?: ReturnType<typeof resolveSandboxRuntimeStatus>;
};
declare function resolveSandboxContext(params: ResolveSandboxContextParams): Promise<SandboxContext | null>;
//#endregion
//#region src/plugins/bundle-mcp.d.ts
type BundleMcpDiagnostic = {
pluginId: string;
message: string;
};
//#endregion
//#region src/agents/subagents/spawn/subagent-session-store.d.ts
type PersistedSessionCapabilityEntry = Pick<SessionEntry$1, "sessionId" | "spawnDepth" | "subagentRole" | "subagentControlScope" | "spawnedBy" | "completionOwnerSessionKey" | "inheritedToolPolicyVersion" | "inheritedToolAllow" | "inheritedToolDeny">;
type SessionCapabilityEntry = { [Key in keyof PersistedSessionCapabilityEntry]?: unknown; };
/** A complete store view; reads are memoized only for the current synchronous resolution. */
type SessionCapabilityLookup = {
/** Cross-agent owner projection: missing rows are authoritative, never a database fallback. */
authoritative?: true;
/** Reuse this memo when depth fallback revisits the same logical store. */
scope?: {
storePath: string;
agentId: string;
};
get: (sessionKey: string) => SessionCapabilityEntry | undefined;
getById: (sessionId: string) => SessionCapabilityEntry | undefined;
};
type SessionCapabilityStore = Record<string, SessionCapabilityEntry> | SessionCapabilityLookup;
/** Facts from an owning read in the same synchronous policy resolution. */
type PreparedSessionCapabilityEntry = {
sessionKey: string;
entry: SessionCapabilityEntry;
};
//#endregion
//#region src/agents/conversation-capability-profile.d.ts
type ConversationCapabilityScope = "direct" | "shared" | "unknown";
type ConversationCapabilityProfileParams = {
config?: OpenClawConfig;
sessionKey?: string;
/** Live conversation key when a sandbox/policy key is used for tool filtering. */
runSessionKey?: string;
/** Session key used for subagent capability inheritance when it differs from sessionKey. */
sandboxSessionKey?: string;
/** Owner-read session metadata consumed synchronously during policy preparation. */
preparedSessionEntry?: PreparedSessionCapabilityEntry;
/** Complete owner-prepared lineage; no database reads during policy projection. */
preparedSessionCapabilityStore?: SessionCapabilityStore;
sessionId?: string;
runId?: string;
agentId?: string;
agentDir?: string;
agentAccountId?: string | null;
messageProvider?: string | null;
messageChannel?: string | null;
chatType?: string;
messageTo?: string | null;
messageThreadId?: string | number | null;
conversationToolPolicy?: GroupToolPolicyConfig;
currentChannelId?: string | null;
currentMessagingTarget?: string | null;
currentThreadTs?: string | null;
currentMessageId?: string | number | null;
groupId?: string | null;
groupChannel?: string | null;
groupSpace?: string | null;
memberRoleIds?: readonly string[];
spawnedBy?: string | null;
senderId?: string | null;
senderName?: string | null;
senderUsername?: string | null;
senderE164?: string | null;
senderIsOwner?: boolean;
modelProvider?: string;
modelId?: string;
modelApi?: string;
modelContextWindowTokens?: number;
modelHasVision?: boolean;
workspaceDir?: string;
cwd?: string;
spawnWorkspaceDir?: string;
isCanonicalWorkspace?: boolean;
promptMode?: PromptMode;
skillsSnapshot?: SkillSnapshot;
sandboxToolPolicy?: SandboxToolPolicy;
runtimeToolAllowlist?: string[];
/** Persist the runtime allowlist as real parent authority on spawned children. */
inheritRuntimeToolAllowlist?: boolean;
runtimePluginToolGrant?: RuntimePluginToolGrant;
pluginMetadataSnapshot?: Pick<PluginMetadataSnapshot, "plugins">;
inputProvenance?: InputProvenance;
/** Consumed in-process completion capability; public callers cannot set this fact. */
trustedInternalHandoff?: TrustedSubagentCompletionHandoff;
/** Trusted server-stamped authority for an explicitly capped scheduled run. */
scheduledToolPolicy?: ScheduledToolPolicyContext;
};
declare function resolveConversationCapabilityProfile(params: ConversationCapabilityProfileParams): {
agentId: string | undefined;
serviceIdentity: {
agentId: string | undefined;
agentDir: string | undefined;
accountId: string | null | undefined;
runId: string | undefined;
sessionId: string | undefined;
};
model: {
provider: string | undefined;
id: string | undefined;
api: string | undefined;
contextWindowTokens: number | undefined;
hasVision: boolean | undefined;
};
conversation: {
scope: ConversationCapabilityScope;
chatType: ChatType | undefined;
sessionKey: string | undefined;
policySessionKey: string | undefined;
runSessionKey: string | undefined;
sessionId: string | undefined;
messageProvider: string | null | undefined;
messageChannel: string | null | undefined;
messageTo: string | null | undefined;
messageThreadId: string | number | null | undefined;
currentChannelId: string | null | undefined;
currentMessagingTarget: string | null | undefined;
currentThreadTs: string | null | undefined;
currentMessageId: string | number | null | undefined;
groupId: string | null | undefined;
groupChannel: string | null | undefined;
groupSpace: string | null | undefined;
memberRoleIds: readonly string[] | undefined;
spawnedBy: string | null | undefined;
};
sender: {
id: string | null | undefined;
name: string | null | undefined;
username: string | null | undefined;
e164: string | null | undefined;
isOwner: boolean | undefined;
};
workspace: {
workspaceDir: string | undefined;
cwd: string | undefined;
spawnWorkspaceDir: string | undefined;
workspaceRoot: string;
runtimeRoot: string;
spawnWorkspaceRoot: string | undefined;
instructionRoot: string | undefined;
isCanonicalWorkspace: boolean | undefined;
};
instructions: {
agentDir: string | undefined;
workspaceDir: string | undefined;
promptMode: PromptMode | undefined;
isCanonicalWorkspace: boolean | undefined;
};
skills: {
snapshot: SkillSnapshot | undefined;
};
policy: {
agentId: string | undefined;
sessionKey: string | undefined;
subagentSessionKey: string | undefined;
trustedGroup: {
groupId: string | null | undefined;
dropped: boolean;
};
profile: "coding" | "full" | "messaging" | "minimal" | undefined;
providerProfile: ToolProfileId | undefined;
sources: Partial<Record<"agent" | "agentProvider" | "global" | "globalProvider" | "profile" | "providerProfile", {
kind: "profile" | "config" | "session" | "runtime";
path?: string;
profile?: string;
alsoAllowPath?: string;
}>>;
profiles: {
profile: "coding" | "full" | "messaging" | "minimal";
source: string;
active: boolean;
}[];
gatewayConfigReadAllowed: boolean;
profilePolicy: {
allow?: string[];
deny?: string[];
} | undefined;
providerProfilePolicy: {
allow?: string[];
deny?: string[];
} | undefined;
profileAlsoAllow: string[] | undefined;
providerProfileAlsoAllow: string[] | undefined;
globalPolicy: SandboxToolPolicy | undefined;
globalProviderPolicy: SandboxToolPolicy | undefined;
agentPolicy: SandboxToolPolicy | undefined;
agentProviderPolicy: SandboxToolPolicy | undefined;
groupPolicy: SandboxToolPolicy | undefined;
senderPolicy: SandboxToolPolicy | undefined;
sandboxPolicy: SandboxToolPolicy | undefined;
subagentPolicy: SandboxToolPolicy | undefined;
inheritedToolPolicy: SandboxToolPolicy | undefined;
delegated: boolean;
requesterPolicySource: "completion-handoff" | "current-request" | "persisted-child";
runtimeToolPolicyForInheritance: {
allow: string[];
} | undefined;
inheritancePolicies: (SandboxToolPolicy | {
allow: string[];
} | undefined)[];
explicitToolAllowlist: string[];
explicitToolOverrideAllowlist: string[];
explicitToolDenylist: string[];
runtimePluginToolGrant: RuntimePluginToolGrant | undefined;
};
};
type ResolvedConversationCapabilityProfile = ReturnType<typeof resolveConversationCapabilityProfile>;
//#endregion
//#region src/agents/cli-runner/types.d.ts
type CliSessionBindingFacts = {
extraSystemPromptStatic?: string;
sourceReplyDeliveryMode?: SourceReplyDeliveryMode;
requireExplicitMessageTarget?: boolean;
};
//#endregion
//#region src/agents/main-session-recovery/main-session-recovery-types.d.ts
type MainSessionRecoveryOwnerClaim = {
cycleId: string;
lifecycleGeneration: string;
claimId: string;
sessionId: string;
sessionKey: string;
runId?: string;
};
//#endregion
//#region src/agents/main-session-recovery/main-session-recovery-store.d.ts
type MainSessionRecoveryStoreTarget = {
agentId?: string;
sessionKey: string;
storePath: string;
};
type MainSessionRecoveryOwnerLease = MainSessionRecoveryOwnerClaim & MainSessionRecoveryStoreTarget;
//#endregion
//#region src/agents/command/types.d.ts
type ImageContent = Pick<ImageContent$1, "type" | "data" | "mimeType">;
/** Channel/account/thread context carried into an agent run. */
type AgentRunContext = {
messageChannel?: string;
accountId?: string;
groupId?: string | null;
groupChannel?: string | null;
groupSpace?: string | null;
currentChannelId?: string;
/** Transport-native chat/conversation ID for plugin hook identity context. */
chatId?: string;
/** Channel-specific sender/chat metadata for plugin hook identity context. */
channelContext?: PluginHookChannelContext;
currentThreadTs?: string;
currentInboundAudio?: boolean;
senderId?: string | null;
replyToMode?: "off" | "first" | "all" | "batched";
hasRepliedRef?: {
value: boolean;
};
};
/** Full trusted option surface for running an agent command. */
type AgentCommandOpts = {
message: string;
/** User-visible transcript body; defaults to message and excludes runtime-only context. */
transcriptMessage?: string;
/** Durable media metadata for the user-visible transcript turn. */
transcriptMedia?: UserTurnInput["media"];
/** Optional image attachments for multimodal messages. */
images?: ImageContent[];
/** Original inline/offloaded attachment order for inbound images. */
imageOrder?: PromptImageOrderEntry[];
/** Ordered facts represented by attachment text in this prompt. */
media?: MediaFact[];
/** Optional client-provided tools (OpenResponses hosted tools). */
clientTools?: ClientToolDefinition[];
/** Agent id override (must exist in config). */
agentId?: string;
/** Per-run provider override. */
provider?: string;
/** Per-run model override. */
model?: string;
/** Explicit ordered fallback chain for this run. Undefined uses normal selection policy. */
modelFallbacksOverride?: string[];
to?: string;
sessionId?: string;
sessionKey?: string;
thinking?: string;
thinkingOnce?: string;
verbose?: string;
json?: boolean;
timeout?: string;
deliver?: boolean;
/** Override delivery target (separate from session routing). */
replyTo?: string;
/** Override delivery channel (separate from session routing). */
replyChannel?: string;
/** Override delivery account id (separate from session routing). */
replyAccountId?: string;
/** Override delivery thread/topic id (separate from session routing). */
threadId?: string | number;
/** Message channel context. */
messageChannel?: string;
/** Tool-policy/output surface context. Defaults to messageChannel. */
messageProvider?: string;
/** Delivery channel. */
channel?: string;
/** Account ID for multi-account channel routing. */
accountId?: string;
/** Context for embedded run routing (channel/account/thread). */
runContext?: AgentRunContext;
/** Client capabilities captured by trusted Gateway ingress. */
clientCaps?: string[];
/** Exact Control UI destination captured by trusted Gateway ingress. */
gatewayUiCommandTarget?: GatewayUiCommandTarget;
/** Tool bindings admitted by the originating Gateway request. */
toolBindings?: Readonly<Record<string, unknown>>;
/** Follow-up task action sink admitted by the originating Gateway client. */
taskSuggestionDeliveryMode?: TaskSuggestionDeliveryMode;
/** Device-scoped operator session allowed to review approvals initiated by this run. */
approvalReviewerDeviceId?: string;
/** Internal trusted exec approval follow-up elevated defaults. */
bashElevated?: ExecElevatedDefaults;
/** Trusted span whose final cap is resolved with the selected model. */
execApprovalContinuationPromptRange?: ExecApprovalContinuationPromptRange;
/** Corresponding span in the undecorated transcript message. */
execApprovalContinuationTranscriptPromptRange?: ExecApprovalContinuationPromptRange;
/** Trusted sender identity bit for command/channel-action auth; defaults true for local CLI calls. */
senderIsOwner?: boolean;
/** Whether this caller is authorized to use provider/model per-run overrides. */
allowModelOverride?: boolean;
/** Optional runtime tool allow-list; when set, only these tools are exposed for this run. */
toolsAllow?: string[];
/** Trusted owner-scoped plugin tool grant; normal policy and deny rules still apply. */
runtimePluginToolGrant?: RuntimePluginToolGrant;
/** Consumed in-process subagent-completion capability; never accepted from public RPC params. */
trustedInternalHandoff?: TrustedSubagentCompletionHandoff;
/** Internal marker identifying a server-managed default cap. */
toolsAllowIsDefault?: boolean;
/** Trusted server-stamped authority for an explicitly capped scheduled run. */
scheduledToolPolicy?: ScheduledToolPolicyContext;
/** Host-authorized dashboard authoring without an originating inline renderer. */
pinnedWidgetAuthoring?: boolean;
/** Preserve the originating run's message-tool policy across internal continuation turns. */
requireExplicitMessageTarget?: boolean;
cliSessionBindingFacts?: CliSessionBindingFacts;
/** Group/spawn metadata for subagent policy inheritance and routing context. */
groupId?: SpawnedRunMetadata["groupId"];
groupChannel?: SpawnedRunMetadata["groupChannel"];
groupSpace?: SpawnedRunMetadata["groupSpace"];
spawnedBy?: SpawnedRunMetadata["spawnedBy"];
deliveryTargetMode?: ChannelOutboundTargetMode;
bestEffortDeliver?: boolean;
abortSignal?: AbortSignal;
/** Private source-owner fence; cancellation alone does not establish current authority. */
assertSourceCurrent?: CommandOwnerAssertion;
/** Original operator restriction; host-only and never accepted from public ingress. */
operatorAuthority?: AdmittedRunOperatorAuthority;
lane?: string;
swarmExecutionLane?: CommandLaneConfiguration;
runId?: string;
/** Immutable gateway lifecycle ownership captured when this run was admitted. */
lifecycleGeneration?: string;
/** Startup awaits returned work; incidental synchronous return values are ignored. */
onExecutionStarted?: () => unknown;
extraSystemPrompt?: string;
/** Bootstrap workspace context injection mode for this run. */
bootstrapContextMode?: "full" | "lightweight";
/** Run kind hint for bootstrap context behavior. */
bootstrapContextRunKind?: BootstrapContextRunKind;
internalEvents?: AgentInternalEvent[];
runtimeContextFragments?: RuntimeContextFragment[];
inputProvenance?: InputProvenance;
/** Internal runs can execute against a session without updating visible status/model/usage. */
sessionEffects?: "visible" | "internal";
/** Internal handoffs can write transcript turns without changing user-facing model/usage state. */
preserveUserFacingSessionModelState?: boolean;
/** Admitted private completion owes an internal result regardless of its channel origin. */
privateCompletion?: true;
/** Visible source replies must be sent through the message tool when set. */
sourceReplyDeliveryMode?: SourceReplyDeliveryMode;
/** Internal runs can omit the channel message tool entirely. */
disableMessageTool?: boolean;
/** Collector children fail closed instead of emitting operator approval requests. */
swarmCollector?: boolean;
/** Synthetic structured_output input schema for collector children. */
swarmOutputSchema?: Record<string, unknown>;
/** Restrict this reconstructed run to restart-safe tools. */
forceRestartSafeTools?: boolean;
forceCodeModeTools?: boolean;
/** Invocation-owned Code Mode activation; limits still come from config. */
codeModeOverride?: boolean | "auto";
/** Host-owned exact media set for a scoped automatic recovery delivery. */
internalDeliveryMediaUrls?: string[];
internalDeliverySuppressText?: boolean;
/** Gateway ingress that already persisted visible activity can skip the duplicate pre-run touch. */
skipInitialSessionTouch?: boolean;
/** Per-call stream param overrides (best-effort). */
streamParams?: AgentStreamParams;
/** Resolved per-run fast mode from channel/directive handling. */
fastMode?: FastMode;
/** Resolved per-run auto cutoff seconds for fast mode. */
fastModeAutoOnSeconds?: number;
/** Explicit workspace directory override (for subagents to inherit parent workspace). */
workspaceDir?: SpawnedRunMetadata["workspaceDir"];
/** Explicit task working directory for this run. Bootstrap still uses workspaceDir. */
cwd?: string;
/** Force bundled MCP teardown when a one-shot local run completes. */
cleanupBundleMcpOnRunEnd?: boolean;
/** Force long-lived CLI live session teardown when a one-shot local run completes. */
cleanupCliLiveSessionOnRunEnd?: boolean;
/** Mark explicit one-shot local CLI runs so plugin tools can release resources promptly. */
oneShotCliRun?: boolean;
/** Gateway-owned runs can late-bind plugin subagent and node runtime helpers. */
allowGatewaySubagentBinding?: boolean;
/** Opaque foreground fence transferred by Gateway after atomic session admission. */
mainRestartRecoveryOwnerLease?: MainSessionRecoveryOwnerLease;
/** Gateway already consumed this automatic recovery run's durable reservation. */
mainRestartRecoveryAdmitted?: boolean;
/** Exact durable recovery attempt allowed to bind post-admission execution identity. */
mainRestartRecoveryAttempt?: number;
/** Private recovery correlation; public ingress callers cannot author identity evidence. */
executionIdentityAdmission?: ReturnType<(typeof admitted_run_context_d_exports)["createExecutionIdentityRecoveryAdmission"]>;
/** Gateway-owned exact operational instance shared with its abort controller. */
operationalRunInstance?: OperationalRunInstanceRef;
skillLibraryAuthoring?: SkillLibraryAuthoringCapability;
/** Gateway-minted exact-run capability for late Codex creator-authority capture. */
cronCreatorAuthorityCapability?: CronCreatorAuthorityCapability;
/** Private exact-instance binding hook invoked after delegated authority admission. */
onAdmittedRunContext?: (context: AdmittedRunContext) => void | Promise<void>;
/** Private owner binding hook invoked only after exact admission has resolved. */
onPostAdmittedRunContext?: (context: AdmittedRunContext) => void | Promise<void>;
/** Gateway joins terminal transcript writes before delivery or failed-command cleanup. */
beforeTerminalDelivery?: () => Promise<void>;
/** Called when the actual run model is selected, including fallback retries. */
onActiveModelSelected?: (ctx: {
provider: string;
model: string;
}) => void | Promise<void>;
/** Called when every candidate in the run's model fallback chain failed. */
onModelFallbackExhausted?: () => void;
/** Called before delivery projection when the raw run contains an error payload. */
onResultErrorPayload?: (message?: string) => void;
/** Called when compaction rotates the active run onto a successor session. */
onSessionIdChanged?: (sessionId: string) => void;
/** Internal one-shot model probe mode: no tools, no workspace/chat prompt policy. */
modelRun?: boolean;
/** Internal prompt-mode override for trusted local/gateway callsites. */
promptMode?: PromptMode;
/** Internal ACP-ready session turn source. Manual spawn turns bypass only the dispatch gate. */
acpTurnSource?: "manual_spawn";
/** Internal handoffs can feed the model without writing the synthetic prompt to transcript. */
suppressPromptPersistence?: boolean;
/** Gateway/channel ingress can provide a canonical user-turn persistence owner. */
userTurnTranscriptRecorder?: UserTurnTranscriptRecorder;
};
type AgentCommandGatewayOnlyKey = "clientCaps" | "gatewayUiCommandTarget" | "toolBindings" | "taskSuggestionDeliveryMode" | "runtimeContextFragments" | "mainRestartRecoveryOwnerLease" | "mainRestartRecoveryAdmitted" | "mainRestartRecoveryAttempt" | "pinnedWidgetAuthoring" | "executionIdentityAdmission" | "operationalRunInstance" | "operatorAuthority" | "privateCompletion" | "assertSourceCurrent" | "skillLibraryAuthoring" | "cronCreatorAuthorityCapability" | "onAdmittedRunContext" | "onPostAdmittedRunContext" | "beforeTerminalDelivery";
/** Restricted option surface for external ingress callsites. */
type AgentCommandIngressOpts = Omit<AgentCommandOpts, AgentCommandGatewayOnlyKey | "senderIsOwner" | "allowModelOverride"> & {
/** @deprecated Public ingress ignores owner claims; use the host-injected channel runtime. */
senderIsOwner?: boolean;
/** Ingress callsites must always pass explicit model-override authorization state. */
allowModelOverride: boolean;
};
//#endregion
//#region src/config/sessions/session-delivery-generation.types.d.ts
type SessionDeliveryGeneration = Readonly<{
agentId: string;
storePath: string;
sessionKey: string;
sessionId: string;
lifecycleRevision: string | null;
}>;
//#endregion
//#region src/infra/delivery-queue-state-context.d.ts
type DeliveryQueueStateContext = {
stateDir: string;
workerContext: OpenClawStateWorkerContext;
supervisorMode?: "external";
};
//#endregion
//#region src/shared/silent-reply-policy.d.ts
type SilentReplyConversationType = "direct" | "group" | "internal";
//#endregion
//#region src/infra/outbound/payloads.d.ts
/** Runtime-ready outbound payload after text/media/rich-content normalization. */
type NormalizedOutboundPayload = {
text: string;
mediaUrls: string[];
audioAsVoice?: boolean;
presentation?: MessagePresentation;
presentationTextMode?: ReplyPayload["presentationTextMode"];
delivery?: ReplyPayloadDelivery;
interactive?: LegacyInteractiveReply;
channelData?: Record<string, unknown>;
location?: ReplyPayload["location"];
/** Hook-only content for audio-only TTS payloads. Never used as channel text/caption. */
hookContent?: string;
/** Preserves the status/answer distinction through delivery hooks. */
isStatusNotice?: boolean;
};
/** JSON-safe outbound payload projection used for envelopes and diagnostics. */
type OutboundPayloadJson = {
text: string;
isError?: boolean;
mediaUrl: string | null;
mediaUrls?: string[];
audioAsVoice?: boolean;
presentation?: MessagePresentation;
presentationTextMode?: ReplyPayload["presentationTextMode"];
delivery?: ReplyPayloadDelivery;
interactive?: LegacyInteractiveReply;
channelData?: Record<string, unknown>;
location?: ReplyPayload["location"];
};
type OutboundPayloadPlanContext = {
cfg?: OpenClawConfig;
sessionKey?: string;
surface?: string;
conversationType?: SilentReplyConversationType;
extractMarkdownImages?: boolean;
};
/** Parses raw reply text before building the canonical outbound payload plan. */
declare function createOutboundPayloadPlan(payloads: readonly ReplyPayload[], context?: OutboundPayloadPlanContext): OutboundPayloadPlan[];
/** Plans admitted payload fields without reapplying lane policy or interpreting text directives. */
declare function createStructuredOutboundPayloadPlan(payloads: readonly ReplyPayload[]): OutboundPayloadPlan[];
/** Projects a payload plan back to normalized reply payloads for delivery. */
declare function projectOutboundPayloadPlanForDelivery(plan: readonly OutboundPayloadPlan[]): ReplyPayload[];
/** Projects a payload plan into JSON-safe envelope/debug payloads. */
declare function projectOutboundPayloadPlanForJson(plan: readonly OutboundPayloadPlan[]): OutboundPayloadJson[];
//#endregion
//#region src/infra/delivery-queue-sqlite.types.d.ts
type DeliveryQueueCompletionRetention = "permanent" | Readonly<{
idPrefix: string;
maxAgeMs: number;
maxEntries: number;
}>;
//#endregion
//#region src/infra/outbound/delivery-completion.d.ts
/** Serializable owner callback for a durable queue entry. */
type DurableDeliveryCompletion = {
kind: "conversation";
agentId: string;
operationId: string;
storePath?: string;
/** Present on Gateway-owned conversation intents created with route authorization. */
routeFingerprint?: string;
} | {
kind: "pending-final";
/** Null means an owner was admitted without recoverable authority; fail closed. */
commandOwnerReference?: CommandOwnerAssertion["recoveryReference"];
/** Older queue records retain the canonical locator's original owner selection. */
agentId?: string;
deliveryId: string;
intentId: string;
sessionId: string;
sessionKey: string;
storePath: string;
sessionWriterDeliveryAuthority?: SessionWriterDeliveryAuthority;
};
//#endregion
//#region src/infra/outbound/delivery-queue-settlement.types.d.ts
type AckDeliveryOptions = {
/** Caller holds a GC-visible recovery lease until its active adapter settles. */
retainSpoolArtifacts?: boolean;
/** An intentionally suppressed pre-send batch must not become a success receipt. */
suppressCompletionReceipt?: boolean;
/** Prevent an older provider attempt from settling a replacement owner. */
expectedPlatformSendAttemptId?: string | null;
};
//#endregion
//#region src/infra/outbound/identity.d.ts
/** Trims outbound identity fields and drops empty identity payloads. */
declare function normalizeOutboundIdentity(identity?: OutboundIdentity | null): OutboundIdentity | undefined;
/** Resolves an agent's configured identity into channel-safe outbound metadata. */
declare function resolveAgentOutboundIdentity(cfg: OpenClawConfig, agentId: string): OutboundIdentity | undefined;
//#endregion
//#region src/infra/outbound/mirror.d.ts
/**
* Transcript append data emitted after an outbound send completes.
*/
type OutboundMirror = {
sessionKey: string;
agentId?: string;
text?: string;
mediaUrls?: string[];
idempotencyKey?: string;
expectedSessionId?: string;
deliveryMirror?: SessionTranscriptDeliveryMirror;
};
/**
* Delivery-layer mirror data with optional group/channel correlation metadata.
*/
type DeliveryMirror = OutboundMirror & {
/** Whether this message is being sent in a group/channel context */
isGroup?: boolean;
/** Group or channel identifier for correlation with received events */
groupId?: string;
};
//#endregion
//#region src/audit/audit-event-types.d.ts
type AuditMessageDeliveryKind = "text" | "media" | "other";
type AuditMessageFailureStage = "platform_send" | "queue" | "unknown";
declare const AUDIT_OUTBOUND_MESSAGE_SUPPRESSED_REASONS: readonly ["cancelled_by_message_sending_hook", "cancelled_by_reply_payload_sending_hook", "empty_after_message_sending_hook", "empty_after_reply_payload_sending_hook", "no_visible_payload"];
type AuditOutboundMessageSuppressedReasonCode = (typeof AUDIT_OUTBOUND_MESSAGE_SUPPRESSED_REASONS)[number];
//#endregion
//#region src/infra/outbound/session-context.d.ts
type OutboundSessionContext = {
/**
* Canonical session key used for internal hook dispatch.
*
* MUST equal the agent runtime's `params.sessionKey` for the run that
* produced the payload being delivered. Plugins observing both
* `agent_end`/`llm_input`/`llm_output`/`before_tool_call`/`after_tool_call`
* and `message_sending`/`message_sent` rely on this equality to correlate
* per-turn state across the agent-loop and delivery boundaries.
*
* Callers populating this field should use the same value the agent runner
* received as its sessionKey — in the chat path that is
* `targetSessionKey || ctx.SessionKey` (see
* `auto-reply/reply/get-reply.ts`). Followup, ACP, command, and cron
* delivery paths each have their own canonical value to forward; consult
* the relevant runner.
*/
key?: string;
/**
* Session key used for policy resolution when delivery differs from the
* control session. Used to look up silent-reply policy, send rate limits,
* agent-scoped channel preferences, etc., for the chat the reply is being
* delivered into. May equal `key` when there is no redirect; otherwise
* `policyKey` describes the *delivery target*'s session while `key`
* describes the *control session* whose hooks fire.
*/
policyKey?: string;
/** Explicit conversation type for policy resolution when a session key is generic. */
conversationType?: SilentReplyConversationType;
/**
* Caller-declared destination conversation kind for metadata-only audit
* projection. Never derived from session-key parsing: policy keys can name
* an acted-on session that is not the delivery destination, and a wrong
* "direct" here over-collects under audit.messages="direct".
*/
conversationKind?: "direct" | "group" | "channel";
/** Active agent id used for workspace-scoped media roots. */
agentId?: string;
/** Originating account id used for requester-scoped group policy resolution. */
requesterAccountId?: string;
/** Originating sender id used for sender-scoped outbound media policy. */
requesterSenderId?: string;
/** Originating sender display name for name-keyed sender policy matching. */
requesterSenderName?: string;
/** Originating sender username for username-keyed sender policy matching. */
requesterSenderUsername?: string;
/** Originating sender E.164 phone number for e164-keyed sender policy matching. */
requesterSenderE164?: string;
};
/** Builds the outbound delivery session context, omitting empty policy fields. */
declare function buildOutboundSessionContext(params: {
cfg: OpenClawConfig;
sessionKey?: string | null;
policySessionKey?: string | null;
conversationType?: string | null;
isGroup?: boolean | null;
agentId?: string | null;
requesterAccountId?: string | null;
requesterSenderId?: string | null;
requesterSenderName?: string | null;
requesterSenderUsername?: string | null;
requesterSenderE164?: string | null;
}): OutboundSessionContext | undefined;
//#endregion
//#region src/infra/outbound/outbound-audit.d.ts
type OutboundAuditTerminal = {
outcome: "sent";
results: readonly OutboundDeliveryResult[];
deliveryKind?: AuditMessageDeliveryKind;
} | {
outcome: "suppressed";
reasonCode: AuditOutboundMessageSuppressedReasonCode;
results?: readonly OutboundDeliveryResult[];
} | {
outcome: "failed";
failureStage: AuditMessageFailureStage;
results?: readonly OutboundDeliveryResult[];
sentBeforeError?: boolean;
deliveryKind?: AuditMessageDeliveryKind;
} | {
outcome: "unknown";
failureStage: AuditMessageFailureStage;
results?: readonly OutboundDeliveryResult[];
sentBeforeError?: boolean;
};
type IndexedOutboundAuditTerminal = {
payloadIndex: number;
terminal: OutboundAuditTerminal;
};
//#endregion
//#region src/infra/outbound/prepared-batch.d.ts
declare const PREPARED_OUTBOUND_BATCH_SCHEMA_VERSION: 1;
type PreparedOutboundAcceptedEntry = {
sourceIndex: number;
status: "accepted";
payload: ReplyPayload;
replyHookChanged: boolean;
messageHookChanged: boolean;
preparedMediaCount: number;
};
type PreparedOutboundSuppressedEntry = {
sourceIndex: number;
status: "suppressed";
reason: OutboundPayloadDeliverySuppressionReason;
hookEffect?: {
cancelReason?: string;
metadata?: Record<string, unknown>;
};
};
type PreparedOutboundBatchEntry = PreparedOutboundAcceptedEntry | PreparedOutboundSuppressedEntry;
/** Canonical post-policy payload custody persisted by the durable outbound queue. */
type PreparedOutboundBatch = {
schemaVersion: typeof PREPARED_OUTBOUND_BATCH_SCHEMA_VERSION;
sourcePayloadCount: number;
/** True only when accepted payloads already passed post-policy channel normalization. */
channelNormalized?: true;
runId?: string;
executionIdentityToken?: ExecutionIdentityAdmissionToken;
entries: PreparedOutboundBatchEntry[];
};
//#endregion
//#region src/infra/outbound/delivery-queue-types.d.ts
type QueuedRenderedMessageBatchPlan = RenderedMessageBatchPlan;
type QueuedReplyPayloadSendingHook = {
kind: ReplyDispatchKind;
channel?: string;
sessionKey?: string;
runId?: string;
context: PluginHookReplyPayloadSendingContext;
};
type QueuedDeliveryPayload = {
sessionGeneration?: SessionDeliveryGeneration;
channel: string;
to: string;
accountId?: string;
queuePolicy?: "required" | "best_effort";
requireUnknownSendReconciliation?: boolean;
requiresProducerClaim?: boolean;
preparedBatch?: PreparedOutboundBatch;
payloads?: ReplyPayload[];
renderedBatchPlan?: QueuedRenderedMessageBatchPlan;
threadId?: string | number | null;
reply?: OutboundReplyFacts;
formatting?: OutboundDeliveryFormattingOptions;
identity?: OutboundIdentity;
bestEffort?: boolean;
gifPlayback?: boolean;
forceDocument?: boolean;
silent?: boolean;
mirror?: DeliveryMirror;
session?: OutboundSessionContext;
gatewayClientScopes?: readonly string[];
preparedMessageId?: string;
deliveryCompletion?: DurableDeliveryCompletion;
completionRetention?: DeliveryQueueCompletionRetention;
legacyUnknownSendReconciliation?: Exclude<ChannelMessageUnknownSendReconciliationResult, {
status: "unresolved";
}>;
legacyPreparedContentUnavailable?: true;
maxRetries?: number;
};
type DeliveryFailureSettlement = {
error: string;
unknownSendCleanup?: true;
terminals?: readonly IndexedOutboundAuditTerminal[];
} & ({
outcome: "unknown";
} | {
outcome: "failed";
rejectionError?: string;
});
type QueuedDelivery = Omit<QueuedDeliveryPayload, "preparedBatch" | "payloads"> & {
preparedBatch: PreparedOutboundBatch;
id: string;
enqueuedAt: number;
retryCount: number;
attemptCount: number;
availableAt?: number;
producerClaimId?: string;
lastAttemptAt?: number;
lastError?: string;
platformSendAttemptId?: string;
platformSendStartedAt?: number;
effectiveReplyToId?: string | null;
recoveryState?: "producer_claimed" | "send_attempt_started" | "unknown_after_send" | "settlement_pending";
settlement?: DeliveryFailureSettlement;
retainOnFailure?: true;
};
//#endregion
//#region src/infra/outbound/delivery-queue-ack.kernel.d.ts
/** Retires an unsent live claim while its adapter preparation still owns resources. */
declare function retireUnsentDeliveryInDatabase(database: OpenClawStateDatabase, params: {
id: string;
producerClaimId: string;
stateDir?: string;
}, terminalOutcome?: "failed"): {
spoolPaths: string[];
retention?: string;
} | undefined;
//#endregion
//#region src/infra/outbound/delivery-queue-ack.d.ts
/** Retires an unsent live claim while its adapter preparation still owns resources. */
declare function retireUnsentDelivery(params: Parameters<typeof retireUnsentDeliveryInDatabase>[1], context?: DeliveryQueueStateContext, terminalOutcome?: "failed"): Promise<(() => Promise<void>) | undefined>;
/** Remove a successfully delivered entry, or retain its producer-owned receipt. */
declare function ackDelivery(id: string, requestedStateDir?: string, options?: AckDeliveryOptions, context?: DeliveryQueueStateContext): Promise<void>;
//#endregion
//#region src/infra/outbound/deliver-queue-state.d.ts
type QueuedDeliveryFailureRecorder = (id: string, error: string, stateDir?: string, expectedPlatformSendAttemptId?: string | null) => Promise<void>;
/** Keeps live and recovered queue transitions on the same producer claim. */
declare function createQueuedDeliveryOwner(params: {
queueId: string;
stateDir?: string;
expectedPlatformSendAttemptId?: string | null;
signal?: AbortSignal;
}, context?: DeliveryQueueStateContext): {
queueId: string;
stateDir: string | undefined;
claimId: string | null | undefined;
signal: AbortSignal | undefined;
readonly custody: "held" | "released";
project(error: unknown, evidence?: Omit<ConstructorParameters<typeof OutboundDeliveryError>[1], "cause">): OutboundDeliveryError;
retireUnsent(terminalOutcome?: "failed"): ReturnType<typeof retireUnsentDelivery>;
ack(options?: Parameters<typeof ackDelivery>[2]): Promise<void>;
finalizeFailure(entry: QueuedDelivery): Promise<boolean>;
fail(record: QueuedDeliveryFailureRecorder, error: string): Promise<void>;
retire(): Promise<void>;
};
type QueuedDeliveryOwner = ReturnType<typeof createQueuedDeliveryOwner>;
//#endregion
//#region src/infra/outbound/reply-policy.d.ts
/** Resolved reply target plus whether it came from payload or ambient context. */
type ReplyToResolution = {
replyToId?: string;
source?: "explicit" | "implicit";
};
/** Creates a reply-to supplier that consumes implicit single-use reply ids once. */
declare function createReplyToFanout(params: {
replyToId?: string | null;
replyToMode?: ReplyToMode;
replyToIdSource?: ReplyToResolution["source"];
}): () => string | undefined;
//#endregion
//#region src/infra/outbound/message-sent-hook.d.ts
type MessageSentEvent = {
success: boolean;
content: string;
error?: string;
messageId?: string;
};
//#endregion
//#region src/infra/outbound/deliver-contracts.d.ts
type ConversationDeliveryAttemptAuthority = Omit<Extract<DurableDeliveryCompletion, {
kind: "conversation";
}>, "kind">;
type OutboundDeliveryIntent = {
id: string;
channel: string;
to: string;
accountId?: string;
queuePolicy: OutboundDeliveryQueuePolicy;
};
type DurableFinalDeliveryRequirement = keyof NonNullable<ChannelDeliveryCapabilities["durableFinal"]>;
type DurableFinalDeliveryRequirements = Partial<Record<DurableFinalDeliveryRequirement, boolean>>;
type DeliverOutboundPayloadsCoreParams = {
cfg: OpenClawConfig;
channel: string;
to: string;
accountId?: string;
payloads: ReplyPayload[];
/** Admitted run correlation copied into the prepared durable batch. */
runId?: string;
/** @internal Exact admitted execution provenance copied into durable custody. */
executionIdentityToken?: ExecutionIdentityAdmissionToken;
/** @internal Canonical post-policy batch used by queue recovery and physical delivery. */
preparedBatch?: PreparedOutboundBatch;
reply?: OutboundReplyFacts;
formatting?: OutboundDeliveryFormattingOptions;
threadId?: string | number | null;
identity?: OutboundIdentity;
deps?: OutboundSendDeps;
mediaAccess?: OutboundMediaAccess;
gifPlayback?: boolean;
forceDocument?: boolean;
replyPayloadSendingHook?: QueuedReplyPayloadSendingHook;
abortSignal?: AbortSignal;
bestEffort?: boolean;
onError?: (err: unknown, payload: NormalizedOutboundPayload) => void;
onPayload?: (payload: NormalizedOutboundPayload) => void;
/** @internal Reports the effective payload only after an identified platform send. */
onDeliveredPayload?: (payload: NormalizedOutboundPayload) => void;
onPayloadDeliveryOutcome?: (outcome: OutboundPayloadDeliveryOutcome) => void;
/** @internal Runs after each identified platform result, before further fallible work. */
onDeliveryResult?: (result: OutboundDeliveryResult) => Promise<void> | void;
/** @internal Reports a settled native payload for post-terminal message_sent observation. */
onMessageSentEvent?: (event: MessageSentEvent, sourceIndex: number) => void;
/** @internal Persists ambiguous-send state immediately before platform I/O. */
onPlatformSendStart?: (route: PlatformSendRoute, sourceIndex?: number) => Promise<void>;
/** @internal Opaque durable intent id forwarded to provider reconciliation hooks. */
deliveryQueueId?: string;
/** @internal Stable producer id used to make queue creation idempotent across crashes. */
deliveryIntentId?: string;
/** @internal Retain the completed receipt for a producer-owned replayable intent. */
completionRetention?: DeliveryQueueCompletionRetention;
/** @internal Producer-specific durable recovery attempt budget. */
maxRetries?: number;
/** @internal Retry this producer's pending intent only when no platform send began. */
reusePendingDeliveryIntent?: boolean;
/** @internal Serializable owner state finalized after live or recovered delivery. */
deliveryCompletion?: DurableDeliveryCompletion;
/** @internal The caller resends proven-not-sent payloads itself, so recovery must not. */
deliveryRetryOwner?: "caller";
/** @internal Ephemeral route authority for a recovered attempt; never owns completion. */
conversationDeliveryAttemptAuthority?: ConversationDeliveryAttemptAuthority;
/** @internal Revalidates authority once per durable queue execution, before adapter fanout. */
onDeliveryAttempt?: () => Promise<void>;
/** @internal Channel-valid id reserved before a correlated conversation turn is sent. */
preparedMessageId?: string;
/** @internal Recheck the concrete post-hook send shape before platform I/O. */
requiredUnknownSendReconciliation?: boolean;
/** @internal Caller preflight explicitly required provider unknown-send reconciliation. */
requireUnknownSendReconciliation?: boolean;
/** @internal Revalidate caller authority before direct adapter code can run. */
onDirectAdapterHandoff?: () => Promise<void>;
/** @internal Synchronously fence authority at the final adapter invocation. */
assertDirectAdapterHandoff?: () => void;
/** @internal Refresh durable timing before recipient-visible or finalizing platform I/O. */
onPlatformSendDispatch?: () => Promise<void>;
/** Session/agent context used for hooks and media local-root scoping. */
session?: OutboundSessionContext;
mirror?: DeliveryMirror;
silent?: boolean;
gatewayClientScopes?: readonly string[];
conversationReadOrigin?: "delegated" | "direct-operator";
};
/**
* @deprecated Direct outbound delivery is compatibility/runtime substrate.
* New message lifecycle code should use `sendDurableMessageBatch` from
* `src/channels/message/send.ts` or `deliverInboundReplyWithMessageSendContext`
* from `src/channels/turn/durable-delivery.ts`. Keep direct use only for
* outbound substrate, recovery, and compatibility paths.
*/
type DeliverOutboundPayloadsParams = DeliverOutboundPayloadsCoreParams & {
replyToId?: string | null;
replyToMode?: ReplyToMode;
/** @internal Skip write-ahead queue (used by crash-recovery to avoid re-enqueueing). */
skipQueue?: boolean;
/** @internal Fence recovery ownership at the same provider boundary as live sends. */
deliveryProducerClaimId?: string;
deliveryQueueOwner?: QueuedDeliveryOwner;
/** @internal Keep the exact live producer claim alive during platform preparation. */
deliveryProducerLeaseRequired?: boolean;
/** @internal Recovery already ran provider admission after its pending-row re-read. */
deferredDeliveryAdmissionPassed?: true;
/** @internal State directory that owns the existing recovery queue entry. */
deliveryQueueStateDir?: string;
/** @internal Let recovery run commit hooks after it has acked the recovered queue entry. */
deferCommitHooks?: boolean;
queuePolicy?: OutboundDeliveryQueuePolicy;
renderedBatchPlan?: QueuedRenderedMessageBatchPlan;
onDeliveryIntent?: (intent: OutboundDeliveryIntent) => void;
};
//#endregion
//#region src/channels/message/send.d.ts
type DurableMessageBatchSendParams = Omit<DeliverOutboundPayloadsParams, "abortSignal" | "onDeliveryIntent" | "payloads" | "queuePolicy"> & {
payloads: ReplyPayload[];
attempt?: number;
signal?: AbortSignal;
/** @deprecated Use `signal`. */
abortSignal?: AbortSignal;
previousReceipt?: MessageReceipt;
};
type DurableMessageSuppressionReason = OutboundPayloadDeliverySuppressionReason | "no_visible_result";
type DurableMessageFailureStage = "platform_send" | "queue" | "unknown";
type DurableMessagePayloadDeliveryOutcome = Exclude<OutboundPayloadDeliveryOutcome, {
status: "suppressed";
}> | (Omit<Extract<OutboundPayloadDeliveryOutcome, {
status: "suppressed";
}>, "reason"> & {
reason: DurableMessageSuppressionReason;
});
type DurableMessageBatchSendResult = {
status: "sent";
results: OutboundDeliveryResult[];
receipt: MessageReceipt;
deliveryIntent?: OutboundDeliveryIntent;
payloadOutcomes?: DurableMessagePayloadDeliveryOutcome[];
} | {
status: "suppressed";
results: [];
receipt: MessageReceipt;
deliveryIntent?: OutboundDeliveryIntent;
reason: DurableMessageSuppressionReason;
payloadOutcomes?: DurableMessagePayloadDeliveryOutcome[];
} | {
status: "partial_failed";
results: OutboundDeliveryResult[];
receipt: MessageReceipt;
error: unknown;
sentBeforeError: true;
deliveryIntent?: OutboundDeliveryIntent;
payloadOutcomes?: DurableMessagePayloadDeliveryOutcome[];
} | {
status: "failed";
error: unknown;
stage?: DurableMessageFailureStage;
payloadOutcomes?: DurableMessagePayloadDeliveryOutcome[];
};
type SerializedDurableMessagePayloadOutcome = {
index: number;
status: "sent";
resultCount: number;
} | {
index: number;
status: "suppressed";
reason: DurableMessageSuppressionReason;
hookEffect?: {
cancelReason?: string;
metadata?: Record<string, unknown>;
};
} | {
index: number;
status: "failed";
error: string;
sentBeforeError: boolean;
stage: DurableMessageFailureStage;
};
type DurableMessageSendContextParams = DurableMessageBatchSendParams & {
durability?: Exclude<MessageDurabilityPolicy, "disabled">;
/** Runs after the durable queue intent exists and before platform delivery starts. */
onDeliveryIntent?: (intent: DurableMessageSendIntent) => void;
preview?: LiveMessageState<ReplyPayload>;
onPreviewUpdate?: (rendered: RenderedMessageBatch<ReplyPayload>, state: LiveMessageState<ReplyPayload>) => Promise<LiveMessageState<ReplyPayload>> | LiveMessageState<ReplyPayload>;
onEditReceipt?: (receipt: MessageReceipt, rendered: RenderedMessageBatch<ReplyPayload>) => Promise<MessageReceipt> | MessageReceipt;
onDeleteReceipt?: (receipt: MessageReceipt) => Promise<void> | void;
onCommitReceipt?: (receipt: MessageReceipt) => Promise<void> | void;
onSendFailure?: (error: unknown) => Promise<void> | void;
};
type DurableMessageSendContext = MessageSendContext<ReplyPayload, DurableMessageBatchSendResult>;
//#endregion
//#region src/agents/command/delivery-result.d.ts
type AgentCommandDeliveryStatus = {
requested: true;
attempted: boolean;
status: "sent" | "suppressed" | "partial_failed" | "failed";
/** `partial` means at least one payload was sent before a later payload failed. */
succeeded: true | false | "partial";
error?: true;
errorMessage?: string;
/** Free-form lowercase_snake reason from durable delivery or preflight validation. */
reason?: string;
resultCount?: number;
sentBeforeError?: true;
payloadOutcomes?: SerializedDurableMessagePayloadOutcome[];
};
type AgentCommandDeliveryResult = Pick<EmbeddedAgentRunResult, "didDeliverSourceReplyViaMessageTool" | "sourceReplyDelivered" | "sourceReplyDeliveryState" | "messagingToolSourceReplyPayloads"> & {
payloads: ReturnType<typeof projectOutboundPayloadPlanForJson>;
meta: EmbeddedAgentRunMeta;
didSendViaMessagingTool?: boolean;
messagingToolSentTexts?: string[];
messagingToolSentMediaUrls?: string[];
messagingToolSentTargets?: MessagingToolSend[];
didSendDeterministicApprovalPrompt?: true;
acceptedSessionSpawns?: NonNullable<EmbeddedAgentRunResult["acceptedSessionSpawns"]>;
requesterContinuationSettled?: true;
successfulCronAdds?: number;
deliverySucceeded?: boolean;
deliveryStatus?: AgentCommandDeliveryStatus;
};
//#endregion
//#region src/agents/agent-command.d.ts
/** Runs an agent turn from an inbound channel/gateway ingress context. */
declare function agentCommandFromIngress(opts: AgentCommandIngressOpts, runtime?: RuntimeEnv, deps?: CliDeps): Promise<AgentCommandDeliveryResult>;
//#endregion
//#region src/agents/timeout.d.ts
declare function resolveAgentTimeoutMs(opts: {
cfg?: OpenClawConfig;
overrideMs?: number | null;
overrideSeconds?: number | null;
minMs?: number;
}): number;
//#endregion
//#region src/agents/embedded-agent-runner/cli-backend-dispatch-eligibility.d.ts
type EmbeddedCliBackendDispatchEligibilityParams = {
provider?: string;
model?: string;
agentId?: string;
/** Explicitly pinned auth profile for the run; decisive when it resolves. */
authProfileId?: string;
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
};
/**
* Decides whether an opted-in embedded run would execute through the CLI
* backend. Resolution stays on stored credential metadata — no credential
* materialization, refresh locks, or network calls on this per-turn path.
*/
declare function resolveEmbeddedCliBackendDispatchEligibility(params: EmbeddedCliBackendDispatchEligibilityParams): {
provider: string;
} | undefined;
declare namespace system_events_d_exports {
export { SystemEvent, consumeSelectedSystemEventEntries, drainSystemEventEntries, drainSystemEvents, enqueueSystemEvent, enqueueSystemEventEntry, enqueueSystemEventWithReceipt, hasSystemEvents, isSystemEventContextChanged, peekSystemEventEntries, peekSystemEvents, resetSystemEventsForTest, resolveSystemEventDeliveryContext };
}
type SystemEvent = {
/**
* OpenClaw-assigned opaque identity for one queued occurrence. Preserve it when returning a
* snapshot to consume. It changes on replacement or re-enqueue; optional only for legacy
* ID-less compatibility.
*/
id?: string;
text: string;
ts: number;
contextKey?: string | null;
deliveryContext?: DeliveryContext;
sessionStorePath?: string | null;
};
type SystemEventOptions = {
sessionKey: string;
sessionStorePath?: string | null;
contextKey?: string | null;
deliveryContext?: DeliveryContext;
/** Replace the pending event for this context and delivery route. Requires contextKey. */
replace?: boolean;
};
type ReceiptOptions = {
allowDuplicate?: boolean;
};
declare function isSystemEventContextChanged(sessionKey: string, contextKey?: string | null): boolean;
declare function enqueueSystemEventEntry(text: string, options: SystemEventOptions): SystemEvent | null;
declare function enqueueSystemEvent(text: string, options: SystemEventOptions): boolean;
/** Enqueues one occurrence and returns one-use removal ownership for its UUID. */
declare function enqueueSystemEventWithReceipt(text: string, options: SystemEventOptions, receiptOptions?: ReceiptOptions): (() => boolean) | null;
declare function drainSystemEventEntries(sessionKey: string): SystemEvent[];
declare function consumeSelectedSystemEventEntries(sessionKey: string, consumedEntries: readonly SystemEvent[]): SystemEvent[];
declare function drainSystemEvents(sessionKey: string): string[];
declare function peekSystemEventEntries(sessionKey: string): SystemEvent[];
declare function peekSystemEvents(sessionKey: string): string[];
declare function hasSystemEvents(sessionKey: string): boolean;
declare function resolveSystemEventDeliveryContext(events: readonly SystemEvent[]): DeliveryContext | undefined;
declare function resetSystemEventsForTest(): void;
//#endregion
//#region src/plugins/runtime/system-events.d.ts
declare const enqueueSystemEventFromSdk: (text: string, { agentId, ...options }: Parameters<typeof enqueueSystemEvent>[1] & {
agentId?: string;
}) => boolean;
declare const enqueueSystemEventEntryFromSdk: typeof enqueueSystemEventEntry;
declare const consumeSelectedSystemEventEntriesFromSdk: typeof consumeSelectedSystemEventEntries;
declare const drainSystemEventEntriesFromSdk: typeof drainSystemEventEntries;
declare const drainSystemEventsFromSdk: typeof drainSystemEvents;
declare const hasSystemEventsFromSdk: typeof hasSystemEvents;
declare const isSystemEventContextChangedFromSdk: typeof isSystemEventContextChanged;
declare function peekSystemEventEntriesFromSdk(key: string, agentId?: string): SystemEvent[];
declare const peekSystemEventsFromSdk: typeof peekSystemEvents;
//#endregion
//#region src/plugins/runtime/native-deps.d.ts
type NativeDependencyHintParams = {
packageName: string;
manager?: "pnpm" | "npm" | "yarn";
rebuildCommand?: string;
approveBuildsCommand?: string;
downloadCommand?: string;
};
declare function formatNativeDependencyHint(params: NativeDependencyHintParams): string;
//#endregion
//#region src/media/audio.d.ts
/** Checks whether MIME type or filename is compatible with voice-message delivery. */
declare function isVoiceMessageCompatibleAudio(opts: {
contentType?: string | null;
fileName?: string | null;
}): boolean;
//#endregion
//#region src/image-generation/runtime-types.d.ts
type GenerateImageParams = Omit<ImageGenerationRequest, "provider" | "model"> & {
modelOverride?: string;
/** Resolution inferred from reference images; omitted for incompatible fallback models. */
inferredResolution?: ImageGenerationResolution;
autoProviderFallback?: boolean;
};
type GenerateImageRuntimeResult = Omit<ImageGenerationResult, "model"> & {
provider: string;
model: string;
attempts: FallbackAttempt[];
appliedResolution?: ImageGenerationResolution;
normalization?: ImageGenerationNormalization;
ignoredOverrides: ImageGenerationIgnoredOverride[];
};
//#endregion
//#region src/video-generation/runtime-types.d.ts
type GenerateVideoParams = Omit<VideoGenerationRequest, "provider" | "model"> & {
modelOverride?: string;
autoProviderFallback?: boolean;
};
type GenerateVideoRuntimeResult = Omit<VideoGenerationResult, "model"> & {
provider: string;
model: string;
attempts: FallbackAttempt[];
normalization?: VideoGenerationNormalization;
ignoredOverrides: VideoGenerationIgnoredOverride[];
};
//#endregion
//#region src/music-generation/runtime-types.d.ts
/** Parameters accepted by the core music generation runtime. */
type GenerateMusicParams = Omit<MusicGenerationRequest, "provider" | "model"> & {
modelOverride?: string;
autoProviderFallback?: boolean;
};
/** Result returned after a successful runtime provider attempt. */
type GenerateMusicRuntimeResult = Omit<MusicGenerationResult, "model"> & {
provider: string;
model: string;
attempts: FallbackAttempt[];
normalization?: MusicGenerationNormalization;
ignoredOverrides: MusicGenerationIgnoredOverride[];
};
//#endregion
//#region src/web-search/runtime-types.d.ts
/** Provider/tool resolution inputs for web_search. */
type ResolveWebSearchDefinitionParams = {
config?: OpenClawConfig;
agentDir?: string;
sandboxed?: boolean;
runtimeWebSearch?: RuntimeWebSearchMetadata;
providerId?: string;
preferRuntimeProviders?: boolean;
preferInputConfig?: boolean;
};
/** Inputs for executing a web_search request through the selected provider. */
type RunWebSearchParams = ResolveWebSearchDefinitionParams & {
args: Record<string, unknown>;
signal?: AbortSignal;
/** Caller-owned synchronous authority check, repeated immediately before external requests. */
assertCurrent?: () => void;
};
/** Normalized execution result that records which provider answered. */
type RunWebSearchResult = {
provider: string;
result: Record<string, unknown>;
};
//#endregion
//#region src/plugin-state/plugin-state-store.types.d.ts
type PluginStateEntry<T> = {
key: string;
value: T;
createdAt: number;
expiresAt?: number;
};
/** An opaque comparison of one store/key's live value and storage metadata, not ownership. */
type PluginStateObservation<T> = {
value: T | undefined;
comparison: string;
};
type PluginStateCompareIntent<T> = {
operation: "update";
action: "set";
value: T;
ttlMs?: number;
} | {
operation: "update" | "delete";
action: "keep";
} | {
operation: "delete";
action: "delete";
};
type PluginStateCompareResult<T> = {
status: "applied" | "unchanged";
} | {
status: "conflict";
current: PluginStateObservation<T>;
};
type PluginStateKeyRange = {
keyStartInclusive: string;
keyEndExclusive: string;
limit: number;
order?: "asc" | "desc";
};
type PluginStateMoveEntries = {
/** Bounded logical source namespace belonging to the same plugin. */
namespace: string;
entries: Array<{
sourceKey: string;
targetKey: string;
}>;
};
type PluginStateKeyedStoreBase<T> = {
/** Prepares a mutation observation through canonical writable admission; may create state. */
observe?: (key: string) => Promise<PluginStateObservation<T>>;
/** Compares the observed row before applying prepared data; only explicit conflicts may retry. */
compareAndApply?: (key: string, comparison: string, intent: PluginStateCompareIntent<T>) => Promise<PluginStateCompareResult<T>>;
register(key: string, value: T, opts?: {
ttlMs?: number;
assertCurrent?: () => void;
}): Promise<void>;
registerIfAbsent(key: string, value: T, opts?: {
ttlMs?: number;
}): Promise<boolean>;
/**
* The updater runs synchronously in the transaction; undefined leaves the entry unchanged.
* @deprecated This callback blocks the main thread. Use data-only operations when they preserve
* the complete atomic change. Retained through the next Plugin SDK major.
*/
update?: (key: string, updateValue: (current: T | undefined) => T | undefined, opts?: {
ttlMs?: number;
}) => Promise<boolean>;
/**
* The synchronous predicate and conditional deletion run in one transaction.
* @deprecated This callback blocks the main thread. Use deleteIfEqual for scalar comparisons;
* other atomic predicates remain supported through the next Plugin SDK major.
*/
deleteIf?: (key: string, predicate: (current: T) => boolean) => Promise<boolean>;
/** Atomically deletes a live entry equal to the supplied JSON scalar, without a callback. */
deleteIfEqual?: (key: string, expected: string | number | boolean | null) => Promise<boolean>;
lookup(key: string): Promise<T | undefined>;
/** Positional outcomes for at most 10,000 keys; missing/expired values are undefined. */
lookupMany?: (keys: readonly string[]) => Promise<Array<Result$1<T | undefined, PluginStateStoreError>>>;
consume(key: string): Promise<T | undefined>;
delete(key: string, opts?: {
assertCurrent?: () => void;
}): Promise<boolean>;
entries(): Promise<PluginStateEntry<T>[]>;
/** Reads a lexical key range with ordering and limit applied by storage. */
entriesInKeyRange?: (range: PluginStateKeyRange) => Promise<PluginStateEntry<T>[]>;
/**
* Atomically settles at most 10,000 bounded source rows into this retained store.
* Existing targets win; live expiring sources reject the entire operation.
*/
moveEntriesFrom?: (source: PluginStateMoveEntries) => Promise<number>;
/** Counts live stored rows without decoding values; absent on older hosts and adapters. */
count?: () => Promise<number>;
clear(): Promise<void>;
};
/** Version 2 is an action-bound, data-only view; legacy stores remain source-compatible. */
type PluginStateKeyedStore<T, Version extends 1 | 2 = 1> = Version extends 2 ? Required<Omit<PluginStateKeyedStoreBase<T>, "update" | "deleteIf">> : PluginStateKeyedStoreBase<T> & {
/** Bind current action authority through read completion and final write admission. */
withCurrent?: (authority: {
assertCurrent: () => void;
}) => PluginStateKeyedStore<T, 2>;
};
/**
* Synchronous plugin-state compatibility contract.
* @deprecated Use PluginStateKeyedStore from api.runtime.state.openKeyedStore
* and await its operations. Retained through the next Plugin SDK major.
*/
type PluginStateSyncKeyedStore<T> = {
register(key: string, value: T, opts?: {
ttlMs?: number;
}): void;
registerIfAbsent(key: string, value: T, opts?: {
ttlMs?: number;
}): boolean;
/** Expiry options are consumed after the synchronous updater returns. */
update?: (key: string, updateValue: (current: T | undefined) => T | undefined, opts?: {
ttlMs?: number;
}) => boolean;
/** Atomically deletes an existing entry when its current value matches. */
deleteIf?: (key: string, predicate: (current: T) => boolean) => boolean;
lookup(key: string): T | undefined;
/** Positional outcomes for at most 10,000 keys; missing/expired values are undefined. */
lookupMany?: (keys: readonly string[]) => Array<Result$1<T | undefined, PluginStateStoreError>>;
consume(key: string): T | undefined;
delete(key: string): boolean;
entries(): PluginStateEntry<T>[];
/** Counts live stored rows without decoding values; absent on older hosts and adapters. */
count?: () => number;
clear(): void;
};
/** Options for opening a keyed plugin-state namespace. */
type PluginStateOverflowPolicy = "evict-oldest" | "reject-new";
/** Published bounded-store options; also used by sync stores, imports, and journals. */
type OpenKeyedStoreOptions = {
namespace: string;
maxEntries: number;
retention?: "bounded";
overflowPolicy?: PluginStateOverflowPolicy;
defaultTtlMs?: number;
env?: NodeJS.ProcessEnv;
};
/** Retained stores are available only through asynchronous keyed-store openers. */
type OpenRetainedKeyedStoreOptions = {
namespace: string;
retention: "retained";
maxEntries?: never;
overflowPolicy?: never;
defaultTtlMs?: never;
env?: NodeJS.ProcessEnv;
};
type OpenAsyncKeyedStoreOptions = OpenKeyedStoreOptions | OpenRetainedKeyedStoreOptions;
type PluginStateStoreErrorCode = "PLUGIN_STATE_SQLITE_UNAVAILABLE" | "PLUGIN_STATE_OPEN_FAILED" | "PLUGIN_STATE_WRITE_FAILED" | "PLUGIN_STATE_READ_FAILED" | "PLUGIN_STATE_CORRUPT" | "PLUGIN_STATE_LIMIT_EXCEEDED" | "PLUGIN_STATE_INVALID_INPUT";
type PluginStateStoreOperation = "load-sqlite" | "open" | "ensure-schema" | "register" | "lookup" | "consume" | "delete" | "entries" | "count" | "clear" | "sweep" | "probe" | "close";
type PluginStateStoreErrorOptions = {
code: PluginStateStoreErrorCode;
operation: PluginStateStoreOperation;
path?: string;
cause?: unknown;
owner?: {
pid: number;
threadId: number;
version: string;
};
};
/** Typed error thrown for plugin-state validation and sqlite failures. */
declare class PluginStateStoreError extends Error {
readonly code: PluginStateStoreErrorCode;
readonly operation: PluginStateStoreOperation;
readonly path?: string;
readonly owner: {
pid: number;
threadId: number;
version: string;
};
constructor(message: string, options: PluginStateStoreErrorOptions);
toJSON(): Record<string, unknown>;
}
//#endregion
//#region src/channels/message/ingress-queue.types.d.ts
/** Pending or retryable inbound channel event stored in the durable ingress queue. */
type ChannelIngressQueueRecord<TPayload, TMetadata = unknown> = {
id: string;
channelId: string;
accountId: string;
queueName: string;
payload: TPayload;
metadata?: TMetadata;
receivedAt: number;
updatedAt: number;
laneKey?: string;
attempts: number;
lastAttemptAt?: number;
lastError?: string;
};
/** Pending ingress event currently claimed by a worker. */
type ChannelIngressQueueClaim<TPayload, TMetadata = unknown> = ChannelIngressQueueRecord<TPayload, TMetadata> & {
claim: {
token: string;
ownerId: string;
claimedAt: number;
};
};
/** Minimal claim reference used to guard completion/release/failure with a claim token. */
type ChannelIngressQueueClaimRef = {
id: string;
claim: {
token: string;
};
};
/** Claim identity available when a stale row's payload cannot be decoded. */
type ChannelIngressQueueCorruptClaim = {
id: string;
channelId: string;
accountId: string;
queueName: string;
laneKey?: string;
reason: "corrupt_payload";
claim: {
token: string;
ownerId: string;
claimedAt: number;
};
};
/** Completed ingress event tombstone retained for duplicate detection. */
type ChannelIngressQueueCompletedRecord<TCompletedMetadata = unknown> = {
id: string;
channelId: string;
accountId: string;
queueName: string;
completedAt: number;
metadata?: TCompletedMetadata;
};
/** Retention options for pending, completed, and failed ingress queue rows. */
type ChannelIngressQueuePruneOptions = {
pendingTtlMs?: number;
completedTtlMs?: number;
failedTtlMs?: number;
pendingMaxEntries?: number;
completedMaxEntries?: number;
failedMaxEntries?: number;
protectIds?: Iterable<string>;
now?: number;
};
/** Failed ingress event tombstone retained for duplicate detection. */
type ChannelIngressQueueFailedRecord = {
id: string;
channelId: string;
accountId: string;
queueName: string;
failedAt: number;
reason: string;
message?: string;
};
/** Rich failed ingress event retained for diagnostics and operator recovery. */
type ChannelIngressQueueDeadLetterRecord<TPayload = unknown, TMetadata = unknown> = ChannelIngressQueueFailedRecord & {
payload?: TPayload;
metadata?: TMetadata;
receivedAt: number;
updatedAt: number;
laneKey?: string;
attempts: number;
lastAttemptAt?: number;
};
/** Outcome of asking a channel/account queue to re-enqueue one failed event. */
type ChannelIngressQueueResubmitResult<TPayload, TMetadata = unknown, TCompletedMetadata = unknown> = {
kind: "resubmitted";
record: ChannelIngressQueueRecord<TPayload, TMetadata>;
previous: ChannelIngressQueueDeadLetterRecord<TPayload, TMetadata>;
} | {
kind: "not-found";
} | {
kind: "completed";
record: ChannelIngressQueueCompletedRecord<TCompletedMetadata>;
} | {
kind: "active";
status: "pending" | "claimed";
} | {
kind: "unrecoverable";
record: ChannelIngressQueueDeadLetterRecord<TPayload, TMetadata>;
};
/** Result of enqueueing a possibly duplicate ingress event id. */
type ChannelIngressQueueEnqueueResult<TPayload, TMetadata, TCompletedMetadata> = {
kind: "accepted";
duplicate: false;
record: ChannelIngressQueueRecord<TPayload, TMetadata>;
} | {
kind: "pending";
duplicate: true;
record: ChannelIngressQueueRecord<TPayload, TMetadata>;
} | {
kind: "claimed";
duplicate: true;
record: ChannelIngressQueueClaim<TPayload, TMetadata>;
} | {
kind: "completed";
duplicate: true;
record: ChannelIngressQueueCompletedRecord<TCompletedMetadata>;
} | {
kind: "failed";
duplicate: true;
record: ChannelIngressQueueFailedRecord;
};
/** Durable FIFO-ish ingress queue with claims, duplicate detection, and retention pruning. */
type ChannelIngressQueue<TPayload, TMetadata = unknown, TCompletedMetadata = unknown> = {
enqueue(id: string, payload: TPayload, options?: {
metadata?: TMetadata;
receivedAt?: number;
laneKey?: string;
}): Promise<ChannelIngressQueueEnqueueResult<TPayload, TMetadata, TCompletedMetadata>>;
listPending(options?: {
limit?: number | "all";
orderBy?: "received" | "id";
}): Promise<Array<ChannelIngressQueueRecord<TPayload, TMetadata>>>;
listClaims(): Promise<Array<ChannelIngressQueueClaim<TPayload, TMetadata>>>;
/** Coherent lane state; optional for existing external queue implementations. */
listUnsettled?(options?: {
orderBy?: "received" | "id";
}): Promise<{
pending: Array<ChannelIngressQueueRecord<TPayload, TMetadata>>;
claims: Array<ChannelIngressQueueClaim<TPayload, TMetadata>>;
}>;
/** Additive SDK seam; optional so existing external queue test doubles remain compatible. */
listFailed?(options?: {
limit?: number | "all";
}): Promise<Array<ChannelIngressQueueDeadLetterRecord<TPayload, TMetadata>>>;
claimNext(options?: {
ownerId?: string;
blockedLaneKeys?: Iterable<string>;
staleMs?: number;
orderBy?: "received" | "id";
scanLimit?: number;
candidateIds?: Iterable<string>;
deriveLaneKey?: (record: ChannelIngressQueueRecord<TPayload, TMetadata>) => string | undefined;
/** Authorize a changed durable lane before the atomic pending-to-claimed transition. */
reconcileStoredLaneKey?: (record: ChannelIngressQueueRecord<TPayload, TMetadata>, storedLaneKey: string, derivedLaneKey: string) => boolean;
}): Promise<ChannelIngressQueueClaim<TPayload, TMetadata> | null>;
claim(id: string, options?: {
ownerId?: string;
}): Promise<ChannelIngressQueueClaim<TPayload, TMetadata> | null>;
refreshClaim?(claim: ChannelIngressQueueClaimRef, options?: {
refreshedAt?: number;
}): Promise<boolean>;
complete(idOrClaim: string | ChannelIngressQueueClaimRef, options?: {
metadata?: TCompletedMetadata;
completedAt?: number;
}): Promise<boolean>;
release(idOrClaim: string | ChannelIngressQueueClaimRef, options?: {
lastError?: string;
releasedAt?: number;
recordAttempt?: boolean;
}): Promise<boolean>;
fail(idOrClaim: string | ChannelIngressQueueClaimRef, options: {
reason: string;
message?: string;
failedAt?: number;
}): Promise<boolean>;
/** Additive SDK seam; actual runtime queues support operator resubmission. */
resubmit?(id: string, options?: {
resubmittedAt?: number;
}): Promise<ChannelIngressQueueResubmitResult<TPayload, TMetadata, TCompletedMetadata>>;
delete(idOrClaim: string | ChannelIngressQueueRecord<TPayload, TMetadata> | ChannelIngressQueueClaimRef): Promise<boolean>;
recoverStaleClaims(options?: {
staleMs?: number;
now?: number;
shouldRecover?: (claim: ChannelIngressQueueClaim<TPayload, TMetadata>) => boolean | Promise<boolean>;
shouldRecoverCorrupt?: (claim: ChannelIngressQueueCorruptClaim) => boolean | Promise<boolean>;
}): Promise<number>;
prune(options?: ChannelIngressQueuePruneOptions): Promise<number>;
/**
* Delete all rows after callers stop the account's producers and drain.
* Optional for existing plugin-supplied queue inputs; core queues implement it.
* Cancellation before commit admission preserves every row.
*/
purge?(options?: {
signal?: AbortSignal;
}): Promise<number>;
};
/** Construction options for a channel/account-scoped ingress queue. */
type CreateChannelIngressQueueOptions = {
channelId: string;
accountId?: string;
stateDir?: string;
now?: () => number;
/**
* Read-only inspection never creates, migrates, chmods, or configures the shared
* state file. Read-write listings retain canonical database admission.
*/
access?: "read-write" | "read-only";
};
//#endregion
//#region src/channels/message/ingress-drain-lifecycle.d.ts
/** Full pre-adoption -> adoption ownership lifecycle for one claimed event. */
type ChannelIngressDispatchLifecycle = {
/** Pre-adoption only. After adopt the drain treats this signal as inert. */
abortSignal: AbortSignal;
/**
* Fires when recovery-relevant session/run state is durable.
* Drain completes (tombstones) the claim here -- never at settle.
*/
onAdopted: () => void | Promise<void>;
/**
* Turn ownership deferred to reply-lane admission (queued followup).
* Claim remains held until adopted or abandoned.
*/
onDeferred: () => void;
/** Pre-adoption liveness while waiting for reply-lane admission or preflight compaction. */
onDeferredHeartbeat?: () => void;
deferredHeartbeatIntervalMs?: number;
/**
* Durable adoption finalization is in progress (e.g. settlement hold while
* committing dedupe). Clears the pre-adoption stall watchdog so a timeout
* settlement cannot race and dead-letter an about-to-complete claim.
* Claim stays held until onAdopted / onAbandoned / fail.
*/
onAdoptionFinalizing: () => void;
/** Deferred work terminally failed after dispatch returned. */
onFailed?: (error: unknown) => void | Promise<void>;
/** Explicit cancellation before adoption; releases without consuming retry budget. */
onCancelled?: () => void | Promise<void>;
/**
* Deferred turn finished without ever owning the reply lane.
* Drain releases the claim for retry.
*/
onAbandoned: () => void | Promise<void>;
};
/** Maps a drain lifecycle onto the reply-lane ownership surface. */
declare function bindIngressLifecycleToReplyOptions(lifecycle: ChannelIngressDispatchLifecycle): {
turnAdoptionLifecycle: Omit<ChannelIngressDispatchLifecycle, "onAdoptionFinalizing" | "onFailed" | "onCancelled"> & {
admission: "exclusive";
};
};
//#endregion
//#region src/channels/message/ingress-drain-state.d.ts
type ChannelIngressDrainDispatchResult = {
kind: "completed";
} | {
kind: "deferred";
} | {
kind: "failed-retryable";
error: unknown;
};
//#endregion
//#region src/channels/message/ingress-drain-supersede.d.ts
type IngressSupersedeDecision = boolean | (() => boolean);
//#endregion
//#region src/channels/message/ingress-retry-policy.d.ts
declare const DEFAULT_INGRESS_RETRY_MAX_ATTEMPTS = 8;
declare const DEFAULT_INGRESS_RETRY_DEAD_LETTER_MIN_AGE_MS: number;
type IngressRetryPolicyConfig = {
maxAttempts?: number;
deadLetterMinAgeMs?: number;
baseMs?: number;
maxMs?: number;
};
type IngressNonRetryableFailure = {
reason: string;
message: string;
};
//#endregion
//#region src/channels/message/ingress-drain.d.ts
/** Default claim→adoption stall before applying the shared retry disposition. */
declare const DEFAULT_INGRESS_ADOPTION_STALL_MS: number;
type DeferredLaneOccupancy = "hold" | "release";
type CreateChannelIngressDrainOptions<TPayload, TMetadata = unknown, TCompletedMetadata = unknown> = {
queue: ChannelIngressQueue<TPayload, TMetadata, TCompletedMetadata>;
/**
* Dispatch a claimed event. Wire lifecycle into reply options (see
* bindIngressLifecycleToReplyOptions). Return deferred when ownership will
* transfer at reply-lane admission; otherwise complete or throw.
*/
dispatchClaimedEvent: (event: ChannelIngressQueueClaim<TPayload, TMetadata>, lifecycle: ChannelIngressDispatchLifecycle) => Promise<ChannelIngressDrainDispatchResult | void> | ChannelIngressDrainDispatchResult | void;
resolveNonRetryableFailure?: (err: unknown) => IngressNonRetryableFailure | null;
/** A returned guard is checked synchronously before cancelling pre-adoption work. */
shouldSupersedePending?: (newEvent: ChannelIngressQueueRecord<TPayload, TMetadata> | ChannelIngressQueueClaim<TPayload, TMetadata>, pendingEvent: ChannelIngressQueueClaim<TPayload, TMetadata>) => IngressSupersedeDecision | Promise<IngressSupersedeDecision>;
deriveLaneKey?: (record: ChannelIngressQueueRecord<TPayload, TMetadata>) => string | undefined;
reconcileStoredLaneKey?: (record: ChannelIngressQueueRecord<TPayload, TMetadata>, storedLaneKey: string, derivedLaneKey: string) => boolean;
ownerId?: string;
adoptionStallTimeoutMs?: number;
claimLeaseMs?: number;
/**
* Whether a claimed event keeps occupying its ingress serialization lane after
* dispatch hands ownership to deferred work. Default "hold" (current behavior).
*/
deferredLaneOccupancy?: DeferredLaneOccupancy;
retryPolicy?: IngressRetryPolicyConfig;
now?: () => number;
formatError?: (err: unknown) => string;
onLog?: (message: string) => void;
abortSignal?: AbortSignal;
orderBy?: "received" | "id";
scanLimit?: number;
startLimit?: number;
};
type ChannelIngressDrain = {
recoverStaleClaims: () => Promise<number>;
drainOnce: (options?: {
shouldStop?: () => boolean;
}) => Promise<{
started: number;
}>;
activeLaneKeys: () => ReadonlySet<string>;
waitForIdle: () => Promise<void>;
dispose: () => void;
};
type OwnedChannelIngressDrain = ChannelIngressDrain & {
dispose(options: {
waitForSettlements: true;
}): Promise<void>;
};
/** Creates a channel-agnostic durable ingress drain over an existing queue. */
declare function createChannelIngressDrain<TPayload, TMetadata = unknown, TCompletedMetadata = unknown>(options: CreateChannelIngressDrainOptions<TPayload, TMetadata, TCompletedMetadata>, retainOwnerUntilDispose?: boolean): OwnedChannelIngressDrain;
//#endregion
//#region src/agents/model-runtime-policy.d.ts
/** A stored-row owner is already selected; request hints still require normal admission. */
type AgentRuntimePolicyScope = {
sessionKey?: string;
} & ({
agentId?: string;
agentScope?: never;
} | {
agentId?: never;
agentScope: {
kind: "prepared";
agentId: string;
};
});
/** Config surface that supplied a resolved model runtime policy. */
type ModelRuntimePolicySource = "model" | "provider";
/** Runtime policy plus the config surface that supplied it. */
type ResolvedModelRuntimePolicy = {
policy?: AgentRuntimePolicyConfig;
source?: ModelRuntimePolicySource;
matchedProvider?: string;
forcedByEnvironment?: true;
};
/** Resolves the effective runtime policy for an agent/model/provider selection. */
declare function resolveModelRuntimePolicy(params: {
config?: OpenClawConfig;
provider?: string;
modelId?: string;
} & AgentRuntimePolicyScope): ResolvedModelRuntimePolicy;
//#endregion
//#region src/plugins/runtime/types-core.d.ts
type TtsRuntimeApi = typeof runtime_api_d_exports;
type ListSpeechVoices = TtsRuntimeApi["listSpeechVoices"];
type PrepareTtsRequest = TtsRuntimeApi["prepareTtsRequest"];
type TextToSpeech = typeof textToSpeech;
type TextToSpeechStream = TtsRuntimeApi["textToSpeechStream"];
type TextToSpeechTelephony = TtsRuntimeApi["textToSpeechTelephony"];
type RuntimeRequestHeartbeatOptions = Parameters<typeof requestSessionEventWake>[0];
type RuntimeRequestHeartbeatNowOptions = Omit<RuntimeRequestHeartbeatOptions, "source" | "intent"> & Partial<Pick<RuntimeRequestHeartbeatOptions, "source" | "intent">>;
type RuntimeWriteConfigOptions = {
/** Revalidate caller authority at guarded publication; accepted writes still settle. */
assertCurrent?: () => void;
envSnapshotForRestore?: Record<string, string | undefined>;
expectedConfigPath?: string;
unsetPaths?: string[][];
};
type DeepReadonly<T> = T extends ((...args: never[]) => unknown) ? T : T extends readonly (infer U)[] ? ReadonlyArray<DeepReadonly<U>> : T extends object ? { readonly [K in keyof T]: DeepReadonly<T[K]>; } : T;
type RuntimeConfigAfterWrite = ConfigWriteAfterWrite;
type RuntimeConfigReplaceResult = ConfigReplaceResult;
type RuntimeProviderListParams = {
config?: OpenClawConfig;
};
type RuntimeConfigMutationContext = {
snapshot: ConfigFileSnapshot;
previousHash: string | null;
};
type RuntimeMutateConfigFileParams<T = void> = {
base?: ConfigMutationBase;
baseHash?: string;
afterWrite: RuntimeConfigAfterWrite;
writeOptions?: RuntimeWriteConfigOptions;
mutate: (draft: OpenClawConfig, context: RuntimeConfigMutationContext) => Promise<T | void> | T | void;
};
type RuntimeReplaceConfigFileParams = {
nextConfig: OpenClawConfig;
baseHash?: string;
afterWrite: RuntimeConfigAfterWrite;
writeOptions?: RuntimeWriteConfigOptions;
};
type RuntimeSessionEntry = SessionEntry$1;
type RuntimeSessionPluginExtensions = Record<string, Record<string, SessionPluginJsonValue>> | undefined;
type RuntimeSessionStoreReadParams = {
agentId?: string;
env?: NodeJS.ProcessEnv;
hydrateSkillPromptRefs?: boolean;
sessionKey: string;
readConsistency?: "latest";
storePath?: string;
};
type RuntimeSessionStoreListParams = Partial<Omit<RuntimeSessionStoreReadParams, "sessionKey">> & {
readOnly?: boolean;
};
type RuntimeSessionStoreEntrySummary = {
sessionKey: string;
entry: RuntimeSessionEntry;
};
type RuntimeCreateSessionEntryResult = {
key: string;
agentId: string;
sessionId: string;
entry: RuntimeSessionEntry;
};
type RuntimeCreateSessionEntryContext = RuntimeCreateSessionEntryResult & {
/** Host creation authority; runtimes that cannot supply it must leave it absent. */
initialization?: SessionInitialization;
};
type RuntimeCreateSessionEntryFinalPatch = {
pluginExtensions: RuntimeSessionPluginExtensions;
};
type RuntimeCreateSessionEntryBaseParams = {
cfg: OpenClawConfig;
key: string;
agentId?: string;
label?: string;
/** Create-only title snapshot: trimmed, capped at 500 UTF-16 units without splitting pairs; not a unique label. */
displayName?: string;
spawnedCwd?: string;
sessionRoot?: string;
permissionMode?: RuntimeSessionEntry["permissionMode"];
/** Bind the created session's CLI execution to this paired node. */
execNode?: string;
/** Working directory interpreted only by execNode. */
execCwd?: string;
initialEntry: {
agentHarnessId: string;
color?: string;
modelSelectionLocked?: true;
pluginExtensions?: RuntimeSessionPluginExtensions;
} | {
cliBackendId: string;
color?: string;
model: string;
cliSessionBinding: CliSessionBinding;
modelSelectionLocked: true;
pluginExtensions?: RuntimeSessionPluginExtensions;
/** Registry-injected owner; plugin callers cannot select another owner. */
pluginOwnerId?: string;
} | {
acpBackendId: string;
color?: string;
acpSessionBinding: {
acpAgentId: string;
agentSessionId: string;
};
modelSelectionLocked?: true;
pluginExtensions?: RuntimeSessionPluginExtensions;
/** Registry-injected owner; plugin callers cannot select another owner. */
pluginOwnerId?: string;
};
};
type RuntimeCreateSessionEntryParams = RuntimeCreateSessionEntryBaseParams & ({
/** Retry an interrupted initializer only when persisted trusted state matches exactly. */
recoverMatchingInitialEntry: true;
afterCreate: (created: RuntimeCreateSessionEntryContext) => Promise<RuntimeCreateSessionEntryFinalPatch>;
} | {
recoverMatchingInitialEntry?: never;
afterCreate?: (created: RuntimeCreateSessionEntryContext) => Promise<RuntimeCreateSessionEntryFinalPatch | void>;
});
type RuntimeSessionStoreEntryPatchParams = RuntimeSessionStoreReadParams & {
/** Synchronous final ownership check executed inside the commit transaction. */
assertCommitAllowed?: () => void;
fallbackEntry?: RuntimeSessionEntry;
maintenanceConfig?: ResolvedSessionMaintenanceConfigInput;
preserveActivity?: boolean;
replaceEntry?: boolean;
update: (entry: RuntimeSessionEntry, context: {
existingEntry?: RuntimeSessionEntry;
}) => Promise<Partial<RuntimeSessionEntry> | null> | Partial<RuntimeSessionEntry> | null;
};
type RuntimeUpsertSessionEntryParams = RuntimeSessionStoreReadParams & {
entry: RuntimeSessionEntry;
};
type RuntimeSessionWorkAdmissionParams = {
storePath: string;
sessionKey: string;
signal?: AbortSignal;
};
type RuntimeSessionStoreEntryUpdateParams = {
storePath: string;
sessionKey: string;
update: (entry: RuntimeSessionEntry) => Promise<Partial<RuntimeSessionEntry> | null> | Partial<RuntimeSessionEntry> | null;
skipMaintenance?: boolean;
takeCacheOwnership?: boolean;
requireWriteSuccess?: boolean;
};
/** @public Part of the PluginRuntime declaration contract. */
type PluginRuntimeThinkingPolicyRequest = {
provider?: string | null;
model?: string | null;
catalog?: ThinkingCatalogEntry[];
agentRuntime?: string | null;
};
/** @public Part of the PluginRuntime declaration contract. */
type PluginRuntimeThinkingPolicyLevel = {
id: ThinkLevel;
label: string;
};
/** @public Part of the PluginRuntime declaration contract. */
type PluginRuntimeThinkingPolicy = {
levels: PluginRuntimeThinkingPolicyLevel[];
defaultLevel?: ThinkLevel | null;
};
/** Structured logger surface injected into runtime-backed plugin helpers. */
type RuntimeLogger = {
debug?: (message: string, meta?: Record<string, unknown>) => void;
info: (message: string, meta?: Record<string, unknown>) => void;
warn: (message: string, meta?: Record<string, unknown>) => void;
error: (message: string, meta?: Record<string, unknown>) => void;
};
type RunHeartbeatOnceOptions = {
reason?: string;
agentId?: string;
sessionKey?: string;
/** Override heartbeat config (e.g. `{ target: "last" }` to deliver to the last active channel). */
heartbeat?: {
target?: string;
};
};
type LlmCompleteMessage = {
role: "system" | "user" | "assistant";
content: string;
};
type LlmCompleteCaller = {
kind: "plugin" | "context-engine" | "host" | "unknown";
id?: string;
name?: string;
};
type LlmCompleteUsage = {
inputTokens?: number;
outputTokens?: number;
cacheReadTokens?: number;
cacheWriteTokens?: number;
totalTokens?: number;
costUsd?: number;
};
type LlmCompleteCommonParams = {
/** Model ref (e.g. "anthropic/claude-sonnet-4-6"); defaults to the target agent's configured model. */
model?: string;
/** Advisory output limit; runtime owners without an equivalent control may ignore it. */
maxTokens?: number;
/** Advisory sampling hint; runtime owners without an equivalent control may ignore it. */
temperature?: number;
/** Requested reasoning effort; the host normalizes it for the selected model. */
reasoning?: ThinkLevel;
systemPrompt?: string;
signal?: AbortSignal;
/** Human-readable reason for audit/debug output. */
purpose?: string;
/** Agent whose model/credentials to use. Session-bound capabilities may disallow overrides. */
agentId?: string;
};
type LlmDirectCompleteParams = LlmCompleteCommonParams & {
messages: LlmCompleteMessage[];
/** Provider-native constrained-output request. Unsupported transports may ignore it. */
responseFormat?: Record<string, unknown>;
/** Fail before dispatch unless the exact selected credential has this host-resolved mode. */
requiredAuthMode?: "oauth";
execution?: undefined;
};
type LlmIsolatedAgentRuntimeCompleteParams = LlmCompleteCommonParams & {
/** Isolated runtimes currently accept one fresh user prompt, not a replayed chat history. */
messages: [{
role: "user";
content: string;
}];
execution: {
/**
* Fresh completion through the configured agent runtime with no supplied tools.
* Agents API may retain service-owned helpers; it cannot guarantee zero tools.
*/
mode: "isolated-agent-runtime";
/** Exact credential owner. Requires host-granted plugin policy. */
authProfileId?: string;
timeoutMs?: number;
};
};
type LlmCompleteParams = LlmDirectCompleteParams | LlmIsolatedAgentRuntimeCompleteParams;
type LlmCompleteExecution = {
mode: "direct-provider";
owner: {
kind: "provider";
id: string;
};
} | {
mode: "isolated-agent-runtime";
owner: {
kind: "cli" | "harness";
id: string;
};
};
type LlmCompleteResult = {
text: string;
provider: string;
model: string;
/** Concrete model identity returned by the provider, when available. */
responseModel?: string;
/** Provider terminal reason for direct completions, when available. */
stopReason?: "stop" | "length" | "toolUse" | "error" | "aborted";
agentId: string;
usage: LlmCompleteUsage;
execution: LlmCompleteExecution;
audit: {
caller: LlmCompleteCaller;
purpose?: string;
sessionKey?: string;
};
};
type RuntimeRunEmbeddedAgentParams = Omit<RunEmbeddedAgentParams, "admittedRunContext" | "preparedRunAdmission"> & {
/** @deprecated Ignored; the host derives availability. Retained until the next Plugin SDK major. */
githubPublicationAvailable?: boolean;
};
type RuntimeRunEmbeddedAgent = (params: RuntimeRunEmbeddedAgentParams) => Promise<EmbeddedAgentRunResult>;
/** Core runtime helpers exposed to trusted native plugins. */
type PluginRuntimeCore = {
version: string;
decisions: DecisionRuntimeV1;
config: {
/** Current process runtime config snapshot. Prefer config passed into the active call path. */
current: () => DeepReadonly<OpenClawConfig>;
/**
* Persist a focused config mutation. Callers must choose the post-write
* behavior explicitly so the gateway can hot-reload, restart, or defer.
*/
mutateConfigFile: <T = void>(params: RuntimeMutateConfigFileParams<T>) => Promise<RuntimeConfigReplaceResult & {
result: T | undefined;
}>;
/**
* Persist a full config replacement. Callers must choose the post-write
* behavior explicitly so the gateway can hot-reload, restart, or defer.
*/
replaceConfigFile: (params: RuntimeReplaceConfigFileParams) => Promise<RuntimeConfigReplaceResult>;
};
agent: {
defaults: {
model: typeof DEFAULT_MODEL;
provider: typeof DEFAULT_PROVIDER;
};
resolveAgentDir: typeof resolveAgentDir;
resolveAgentWorkspaceDir: typeof resolveAgentWorkspaceDir;
resolveAgentIdentity: typeof resolveAgentIdentity;
/** Resolve an allowed catalog create target through canonical agent model/runtime policy. */
resolveSessionCatalogCreateTarget: typeof resolveAgentCatalogCreateTarget;
resolveThinkingDefault: (params: {
cfg: OpenClawConfig;
provider: string;
model: string;
catalog?: ModelCatalogEntry[];
}) => ThinkLevel;
normalizeThinkingLevel: (raw?: string | null) => ThinkLevel | undefined;
resolveThinkingPolicy: (params: PluginRuntimeThinkingPolicyRequest) => PluginRuntimeThinkingPolicy;
/** Admit a turn for this exact trusted channel plugin and its authenticated sender. */
runCommandFromIngress: (opts: AgentCommandIngressOpts, runtime: RuntimeEnv) => ReturnType<typeof agentCommandFromIngress>;
runEmbeddedAgent: RuntimeRunEmbeddedAgent;
resolveAgentTimeoutMs: typeof resolveAgentTimeoutMs;
/**
* Shares the embedded runner's CLI-backend dispatch eligibility (route,
* registered backend, stored credential mode) so opted-in callers can
* budget timeouts for the run that will actually execute.
*/
resolveCliBackendDispatchEligibility: typeof resolveEmbeddedCliBackendDispatchEligibility;
ensureAgentWorkspace: typeof ensureAgentWorkspace;
session: {
resolveStorePath: typeof resolveSessionStorePathCore;
createSessionEntry: (params: RuntimeCreateSessionEntryParams) => Promise<RuntimeCreateSessionEntryResult>;
getSessionEntry: (params: RuntimeSessionStoreReadParams) => RuntimeSessionEntry | undefined;
listSessionEntries: (params?: RuntimeSessionStoreListParams) => RuntimeSessionStoreEntrySummary[];
patchSessionEntry: (params: RuntimeSessionStoreEntryPatchParams) => Promise<RuntimeSessionEntry | null>;
upsertSessionEntry: (params: RuntimeUpsertSessionEntryParams) => Promise<void>;
runWithWorkAdmission: <T>(params: RuntimeSessionWorkAdmissionParams, run: (signal: AbortSignal) => Promise<T>) => Promise<T>;
updateSessionStoreEntry: (params: RuntimeSessionStoreEntryUpdateParams) => Promise<RuntimeSessionEntry | null>;
};
};
hooks: {
/** Dispatch untrusted external content through an isolated, contained hook agent turn. */
dispatchHookAgentTurn: (params: {
name: string;
agentId: string;
sessionKey: string;
message: string;
externalContentSource: "email";
deliver: boolean;
model?: string;
thinking?: ThinkLevel;
timeoutSeconds?: number;
idempotencyKey?: string;
}) => Promise<{
ok: true;
runId: string;
} | {
ok: false;
reason: string;
}>;
};
system: {
enqueueSystemEvent: typeof enqueueSystemEventFromSdk;
requestHeartbeat: typeof requestSessionEventWake;
/**
* @deprecated Use `requestHeartbeat({ source, intent, reason })` so wake producers declare
* scheduler intent explicitly.
*/
requestHeartbeatNow: (opts?: RuntimeRequestHeartbeatNowOptions) => void;
/**
* Run a single heartbeat cycle immediately (bypassing the coalesce timer).
* Accepts an optional `heartbeat` config override so callers can choose
* an explicit destination or opt into internal-only `target: "none"` runs.
*/
runHeartbeatOnce: (opts?: RunHeartbeatOnceOptions) => Promise<HeartbeatRunResult>;
runCommandWithTimeout: typeof runCommandWithTimeout;
formatNativeDependencyHint: typeof formatNativeDependencyHint;
};
media: {
loadWebMedia: typeof loadWebMedia;
detectMime: typeof detectMime;
mediaKindFromMime: typeof mediaKindFromMime;
isVoiceCompatibleAudio: typeof isVoiceMessageCompatibleAudio;
getImageMetadata: typeof getImageMetadata;
resizeToJpeg: typeof resizeToJpeg;
};
tts: {
prepareTtsRequest: PrepareTtsRequest;
textToSpeech: TextToSpeech;
textToSpeechStream: TextToSpeechStream;
textToSpeechTelephony: TextToSpeechTelephony;
listVoices: ListSpeechVoices;
};
mediaUnderstanding: {
resolveAudioInputBudget: MediaUnderstandingRuntime["resolveAudioInputBudget"];
runFile: MediaUnderstandingRuntime["runMediaUnderstandingFile"];
describeImageFile: MediaUnderstandingRuntime["describeImageFile"];
describeImageFileWithModel: MediaUnderstandingRuntime["describeImageFileWithModel"];
extractStructuredWithModel: MediaUnderstandingRuntime["extractStructuredWithModel"];
describeVideoFile: MediaUnderstandingRuntime["describeVideoFile"];
transcribeAudioFile: MediaUnderstandingRuntime["transcribeAudioFile"];
};
imageGeneration: {
generate: (params: GenerateImageParams) => Promise<GenerateImageRuntimeResult>;
listProviders: (params?: RuntimeProviderListParams) => ImageGenerationProvider[];
};
videoGeneration: {
generate: (params: GenerateVideoParams) => Promise<GenerateVideoRuntimeResult>;
listProviders: (params?: RuntimeProviderListParams) => VideoGenerationProvider[];
};
musicGeneration: {
generate: (params: GenerateMusicParams) => Promise<GenerateMusicRuntimeResult>;
listProviders: (params?: RuntimeProviderListParams) => MusicGenerationProvider[];
};
webSearch: {
listProviders: (params?: RuntimeProviderListParams) => PluginWebSearchProviderEntry[];
search: (params: RunWebSearchParams) => Promise<RunWebSearchResult>;
};
events: {
onAgentEvent: typeof onAgentEvent;
onSessionTranscriptUpdate: typeof onSessionTranscriptUpdate;
};
logging: {
shouldLogVerbose: typeof shouldLogVerbose;
getChildLogger: (bindings?: Record<string, unknown>, opts?: {
level?: LogLevel;
}) => RuntimeLogger;
};
state: {
resolveStateDir: typeof resolveStateDir;
openBlobStore: <TMetadata>(options: OpenBlobStoreOptions) => PluginBlobStore<TMetadata>;
openKeyedStore: <T>(options: OpenAsyncKeyedStoreOptions) => PluginStateKeyedStore<T>;
/**
* @deprecated Use openKeyedStore and await its operations. The synchronous
* compatibility adapter remains through the next Plugin SDK major.
*/
openSyncKeyedStore: <T>(options: OpenKeyedStoreOptions) => PluginStateSyncKeyedStore<T>;
openChannelIngressQueue: <TPayload, TMetadata = unknown, TCompletedMetadata = unknown>(options?: Omit<CreateChannelIngressQueueOptions, "channelId">) => ChannelIngressQueue<TPayload, TMetadata, TCompletedMetadata>;
openChannelIngressDrain: <TPayload, TMetadata = unknown, TCompletedMetadata = unknown>(options: Omit<CreateChannelIngressDrainOptions<TPayload, TMetadata, TCompletedMetadata>, "queue"> & {
queue?: ChannelIngressQueue<TPayload, TMetadata, TCompletedMetadata>;
accountId?: string;
stateDir?: string;
}) => ChannelIngressDrain;
};
llm: {
complete: (params: LlmCompleteParams) => Promise<LlmCompleteResult>;
acquireLocalService: (target: {
providerId: string;
baseUrl: string;
headers?: HeadersInit;
reconcile?: ProviderPlugin["reconcileLocalService"];
}, signal?: AbortSignal | null) => Promise<{
release: () => void;
} | undefined>;
};
modelConfig: {
/** Read-only model selection; no session mutation or harness execution authority. */
resolveDefaultModelForAgent: typeof resolveDefaultModelForAgent;
resolveAllowedModelRef: typeof resolveAllowedModelRefCore;
/** Read authored model/provider runtime policy without projecting runtime availability. */
resolveModelRuntimePolicy: typeof resolveModelRuntimePolicy;
};
modelAuth: {
/** Existing synchronous SDK operations, composed by the native host. */
resolveProviderIdForAuth: typeof resolveProviderIdForAuth;
ensureAuthProfileStore: typeof ensureAuthProfileStore;
resolveAuthProfileOrder: typeof resolveAuthProfileOrder;
listProfilesForProvider: typeof listProfilesForProvider;
isProviderApiKeyConfigured: typeof isProviderApiKeyConfigured;
/** Resolve auth for a model. Only provider/model, optional cfg, and workspaceDir are used. */
getApiKeyForModel: (params: {
model: Model<Api>;
cfg?: OpenClawConfig;
workspaceDir?: string;
}) => Promise<ResolvedProviderAuth>;
/** Resolve request-ready auth for a model, including provider runtime exchanges. */
getRuntimeAuthForModel: (params: {
model: Model<Api>;
cfg?: OpenClawConfig;
workspaceDir?: string;
}) => Promise<ResolvedProviderRuntimeAuth>;
/** Resolve auth for a provider by name. Only provider, optional cfg, and workspaceDir are used. */
resolveApiKeyForProvider: (params: {
provider: string;
cfg?: OpenClawConfig;
workspaceDir?: string;
}) => Promise<ResolvedProviderAuth>;
};
};
//#endregion
//#region src/context-engine/types.d.ts
type AssembleResult = {
/** Ordered messages to use as model context */
messages: AgentMessage[];
/** Estimated total tokens in assembled context */
estimatedTokens: number;
/**
* Controls which token estimate the runner treats as authoritative for
* preemptive overflow prechecks. The returned `messages` are always the
* prompt sent to the model; this only affects the precheck's token comparison.
*
* - "assembled": the generic precheck uses only the assembled prompt's estimate
* unless the engine owns compaction; owning engines manage prompt admission.
* - "preassembly_may_overflow": the precheck takes the maximum of the
* assembled estimate and the pre-assembly (unwindowed) session-history
* estimate. Engines opt into this when their assembled view can hide an
* overflow that would still affect the underlying transcript. This opt-in
* keeps the generic precheck active even for engines that own compaction.
*
* Defaults to "assembled".
*/
promptAuthority?: "assembled" | "preassembly_may_overflow";
/** Optional context-engine-provided instructions prepended to the runtime system prompt */
systemPromptAddition?: string;
/**
* Optional projection lifecycle for hosts with persistent backend threads.
*
* Context engines that return `thread_bootstrap` ask the host to inject the
* assembled context once for the supplied epoch, then reuse the backend
* thread until the epoch changes. Engines that omit this field retain the
* legacy per-turn projection behavior.
*/
contextProjection?: ContextEngineProjection;
};
type ContextEngineProjection = {
/** How the assembled context should be projected into the backend runtime. */
mode: "per_turn" | "thread_bootstrap";
/** Stable context epoch. Changing this tells persistent backends to rotate. */
epoch?: string;
/** Optional diagnostic fingerprint for the projected context payload. */
fingerprint?: string;
};
type ContextEngineOperation = "agent-run" | "manual-compact" | "subagent-spawn";
type ContextEngineRuntimeMode = "normal" | "fallback" | "degraded";
type ContextEngineSelectionSource = "configured" | "default" | "unknown";
type ContextEngineRuntimeReasonCode = "provider_timeout" | "provider_unavailable" | "rate_limited" | "context_overflow" | "runtime_unavailable" | "unknown";
type ContextEngineHostCapability = "bootstrap" | "assemble-before-prompt" | "after-turn" | "maintain" | "compact" | "runtime-llm-complete" | "thread-bootstrap-projection";
type ContextEngineHostRequirements = {
/** Host capabilities required before the engine can safely serve this operation. */
requiredCapabilities: ContextEngineHostCapability[];
/** Optional engine-authored guidance appended to the host compatibility error. */
unsupportedMessage?: string;
};
type ContextEngineRuntimeSettings = {
schemaVersion: 1;
runtime: {
host: "openclaw";
mode: ContextEngineRuntimeMode;
harnessId: string | null;
runtimeId: string | null;
};
model: {
requested: string | null;
resolved: string | null;
provider: string | null;
family: string | null;
};
contextEngineSelection: {
selectedId: string | null;
source: ContextEngineSelectionSource;
};
executionHost: {
id: string | null;
label: string | null;
};
limits: {
promptTokenBudget: number | null;
maxOutputTokens: number | null;
};
diagnostics: {
fallbackReason: ContextEngineRuntimeReasonCode | null;
degradedReason: ContextEngineRuntimeReasonCode | null;
};
};
type CompactResult = {
ok: boolean;
compacted: boolean;
reason?: string;
result?: {
summary?: string;
firstKeptEntryId?: string;
tokensBefore: number;
tokensAfter?: number;
details?: unknown;
/** Session id after compaction, when the runtime rotated transcripts. */
sessionId?: string;
/** Typed post-compaction live session target; successor when the runtime rotated transcripts. */
sessionTarget?: ContextEngineSessionTarget;
/**
* Raw session file path after compaction.
*
* @deprecated Use `sessionTarget`. Shipped plugin-sdk contract: released
* third-party context engines (v2026.6.x and earlier) report rotated
* transcripts through this field. Remove once typed session targets are
* the only successor contract.
*/
sessionFile?: string;
};
};
type IngestResult = {
/** Whether the message was ingested (false if duplicate or no-op) */
ingested: boolean;
};
type IngestBatchResult = {
/** Number of messages ingested from the supplied batch */
ingestedCount: number;
};
type BootstrapResult = {
/** Whether bootstrap ran and initialized the engine's store */
bootstrapped: boolean;
/** Number of historical messages imported (if applicable) */
importedMessages?: number;
/** Optional reason when bootstrap was skipped */
reason?: string;
};
type ContextEngineInfo = {
id: string;
name: string;
version?: string;
acceptedHostParams?: string[];
transcriptSemantics?: {
currentTurnFence?: "before-current-turn-entry-v1";
turnAdvancementIdempotency?: "atomic-idempotent-v1";
};
/** True when the engine manages its own compaction lifecycle. */
ownsCompaction?: boolean;
/**
* Controls how turn-triggered maintenance should be executed.
*
* Engines remain compatible by default unless the host explicitly opts into
* background turn maintenance.
*/
turnMaintenanceMode?: "foreground" | "background";
/**
* Host capability requirements for operations where using an unsupported
* runtime would silently degrade or corrupt the engine's behavior.
*/
hostRequirements?: Partial<Record<ContextEngineOperation, ContextEngineHostRequirements>>;
};
type SubagentSpawnPreparation = {
/** Roll back pre-spawn setup when subagent launch fails. */
rollback: () => void | Promise<void>;
};
type SubagentEndReason = "deleted" | "completed" | "swept" | "released";
type TranscriptRewriteReplacement = {
/** Existing transcript entry id to replace on the active branch. */
entryId: string;
/** Replacement message content for that entry. */
message: AgentMessage;
};
type TranscriptRewriteRequest = {
/** Message entry replacements to apply in one branch-and-reappend pass. */
replacements: TranscriptRewriteReplacement[];
/** Optional entry-id set that must cover every active-branch entry from the first replacement onward. */
allowedRewriteSuffixEntryIds?: string[];
};
type TranscriptRewriteResult = {
/** Whether the active branch changed. */
changed: boolean;
/** Estimated bytes removed from the active branch message payloads. */
bytesFreed: number;
/** Number of transcript message entries rewritten. */
rewrittenEntries: number;
/** Optional reason when no rewrite occurred. */
reason?: string;
};
type ContextEngineMaintenanceResult = TranscriptRewriteResult;
type ContextEnginePromptCacheRetention = "none" | "short" | "long" | "in_memory" | "24h";
type ContextEnginePromptCacheUsage = {
input?: number;
output?: number;
cacheRead?: number;
cacheWrite?: number;
contextUsage?: {
state: "available";
promptTokens: number;
totalTokens: number;
} | {
state: "unavailable";
};
total?: number;
};
type ContextEnginePromptCacheObservationChangeCode = "aggregateToolResultTruncation" | "cacheRetention" | "model" | "streamStrategy" | "systemPrompt" | "systemPromptSuffix" | "tools" | "transport";
type ContextEnginePromptCacheObservationChange = {
code: ContextEnginePromptCacheObservationChangeCode;
detail: string;
};
type ContextEnginePromptCacheObservation = {
broke: boolean;
previousCacheRead?: number;
cacheRead?: number;
changes?: ContextEnginePromptCacheObservationChange[];
};
type ContextEnginePromptCacheInfo = {
/** Runtime-resolved retention for the actual provider/model/request path. */
retention?: ContextEnginePromptCacheRetention;
/** Usage from the most recent API call, not accumulated retry/tool-loop totals. */
lastCallUsage?: ContextEnginePromptCacheUsage;
/** Result from the runtime's prompt-cache observability heuristic. */
observation?: ContextEnginePromptCacheObservation;
/** Last known cache-touch timestamp from runtime-managed cache-TTL bookkeeping. */
lastCacheTouchAt?: number;
/** Known cache expiry time when the runtime can source it confidently. */
expiresAt?: number;
};
type ContextEngineTranscriptStorageInfo = {
/**
* Authoritative transcript backend for this runtime turn.
*
* Hosts may still pass legacy locator fields such as `sessionFile` for older
* plugin contracts, but context engines should use this field to decide
* whether that locator is a live transcript source.
*/
kind: "sqlite";
};
type ContextEngineSessionTarget = {
/** Agent that owns the session in the runtime store. */
agentId?: string;
/** Runtime session id to compact. */
sessionId?: string;
/** Stable session key used for aliases, policy, and store resolution. */
sessionKey?: string;
/** Session store path that scopes the SQLite-backed runtime session. */
storePath?: string;
/** Optional transport thread identity for session target resolution. */
threadId?: string | number;
};
type ContextEngineRuntimeContext = Record<string, unknown> & {
/** Runtime task working directory; workspaceDir remains the agent bootstrap workspace. */
cwd?: string;
/**
* True when the host has explicitly opted this maintenance run into
* consuming deferred compaction debt.
*/
allowDeferredCompactionExecution?: boolean;
/** Runtime-resolved context window budget for the active model call. */
tokenBudget?: number;
/** Selected agent harness id when compaction delegates back to the runtime. */
agentHarnessId?: string;
/** Best-effort current prompt/context token estimate for this turn. */
currentTokenCount?: number;
/** Optional prompt-cache telemetry for cache-aware engines. */
promptCache?: ContextEnginePromptCacheInfo;
/** Authoritative transcript backend for this turn. */
transcriptStorage?: ContextEngineTranscriptStorageInfo;
/** Storage-neutral runtime session target for compaction delegation. */
sessionTarget?: ContextEngineSessionTarget;
/**
* Safe transcript rewrite helper implemented by the runtime.
*
* Engines decide what is safe to rewrite; the runtime owns how the session
* DAG is updated on disk.
*/
rewriteTranscriptEntries?: (request: TranscriptRewriteRequest) => Promise<TranscriptRewriteResult>;
/** LLM completion capability for engines that need model inference. */
llm?: {
complete: (params: LlmCompleteParams) => Promise<LlmCompleteResult>;
};
};
/**
* ContextEngine defines the pluggable contract for context management.
*
* Required methods define a generic lifecycle; optional methods allow engines
* to provide additional capabilities (retrieval, lineage, etc.).
*/
interface ContextEngine {
/** Engine identifier and metadata */
readonly info: ContextEngineInfo;
/**
* Initialize engine state for a session, optionally importing historical context.
*/
bootstrap?(params: {
sessionId: string;
sessionKey?: string;
/** Storage-neutral runtime session target for transcript/session SDK helpers. */
sessionTarget?: ContextEngineSessionTarget;
sessionFile: string;
runtimeSettings?: ContextEngineRuntimeSettings;
runtimeContext?: ContextEngineRuntimeContext;
}): Promise<BootstrapResult>;
/**
* Run transcript maintenance after bootstrap, successful turns, or compaction.
*
* Engines can use runtimeContext.rewriteTranscriptEntries() to request safe
* branch-and-reappend transcript rewrites without depending on runner internals.
*/
maintain?(params: {
sessionId: string;
sessionKey?: string;
/** Storage-neutral runtime session target for transcript/session SDK helpers. */
sessionTarget?: ContextEngineSessionTarget;
sessionFile: string;
runtimeSettings?: ContextEngineRuntimeSettings;
runtimeContext?: ContextEngineRuntimeContext;
/**
* Optional caller cancellation for maintenance work that may block.
* Engines should reject promptly when this signal aborts.
*/
abortSignal?: AbortSignal;
}): Promise<ContextEngineMaintenanceResult>;
/**
* Ingest a single message into the engine's store.
*/
ingest(params: {
sessionId: string;
sessionKey?: string;
message: AgentMessage;
/** True when the message belongs to a heartbeat run. */
isHeartbeat?: boolean;
}): Promise<IngestResult>;
/**
* Ingest a completed turn batch as a single unit.
*/
ingestBatch?(params: {
sessionId: string;
sessionKey?: string;
messages: AgentMessage[];
/** True when the batch belongs to a heartbeat run. */
isHeartbeat?: boolean;
}): Promise<IngestBatchResult>;
/**
* Execute optional post-turn lifecycle work after a run attempt completes.
* Engines can use this to persist canonical context and trigger background
* compaction decisions.
*/
afterTurn?(params: {
sessionId: string;
sessionKey?: string;
/** Storage-neutral runtime session target for transcript/session SDK helpers. */
sessionTarget?: ContextEngineSessionTarget;
sessionFile: string;
messages: AgentMessage[];
/** Number of messages that existed before the prompt was sent. */
prePromptMessageCount: number;
/** Optional auto-compaction summary emitted by the runtime. */
autoCompactionSummary?: string;
/** True when this turn belongs to a heartbeat run. */
isHeartbeat?: boolean;
/** Optional model context token budget for proactive compaction. */
tokenBudget?: number;
/** Optional runtime-owned context for engines that need caller state. */
runtimeSettings?: ContextEngineRuntimeSettings;
runtimeContext?: ContextEngineRuntimeContext;
}): Promise<void>;
/**
* Atomically and idempotently commit one accepted durable transcript turn.
* Messages span the admitted user entry through the accepted terminal entry.
* Hosts may retry the same advancement key after process or plugin failure.
*/
commitTurn?(params: {
advancementKey: string;
admission: TranscriptTurnAdmission;
terminal: TranscriptEntryAnchor;
messages: AgentMessage[];
sessionId: string;
sessionKey?: string;
sessionTarget?: ContextEngineSessionTarget;
runtimeSettings?: ContextEngineRuntimeSettings;
runtimeContext?: ContextEngineRuntimeContext;
isHeartbeat?: boolean;
}): Promise<{
status: "committed" | "duplicate";
}>;
/**
* Assemble model context under a token budget.
* Returns an ordered set of messages ready for the model.
*/
assemble(params: {
sessionId: string;
sessionKey?: string;
messages: AgentMessage[];
tokenBudget?: number;
/** Tool names available for this run so engines can align prompt guidance with runtime tool access. */
availableTools?: Set<string>;
/** Active memory citation mode when engines want to mirror memory prompt guidance. */
citationsMode?: MemoryCitationsMode;
/** Current model identifier (e.g. "claude-opus-4", "gpt-4o", "qwen2.5-7b").
* Allows context engine plugins to adapt formatting per model. */
model?: string;
/** The incoming user prompt for this turn (useful for retrieval-oriented engines). */
prompt?: string;
runtimeSettings?: ContextEngineRuntimeSettings;
runtimeContext?: ContextEngineRuntimeContext;
}): Promise<AssembleResult>;
/**
* Compact context to reduce token usage.
* May create summaries, prune old turns, etc.
*
* The host always bounds this call with a finite safety timeout (the same
* one that protects native runtime compaction). Engines that run long
* operations SHOULD additionally honor `abortSignal` so an in-flight
* compaction can be canceled promptly on run abort or host timeout instead
* of running to completion in the background.
*/
compact(params: {
sessionId: string;
sessionKey: string;
/** Caller-resolved owner agent for global session aliases. */
agentId?: string;
/** Storage-neutral runtime session target for delegated compaction. */
sessionTarget?: ContextEngineSessionTarget;
tokenBudget?: number;
/** Force compaction even below the default trigger threshold. */
force?: boolean;
/** Optional live token estimate from the caller's active context. */
currentTokenCount?: number;
/** Controls convergence target; defaults to budget. */
compactionTarget?: "budget" | "threshold";
customInstructions?: string;
/** Optional runtime-owned context for engines that need caller state. */
runtimeSettings?: ContextEngineRuntimeSettings;
runtimeContext?: ContextEngineRuntimeContext;
/**
* Optional abort signal honored before and during compaction. The host
* aborts it on run-level abort or when its compaction safety timeout
* fires; engines should stop work and reject promptly when it aborts.
*/
abortSignal?: AbortSignal;
}): Promise<CompactResult>;
/**
* Prepare context-engine-managed subagent state before the child run starts.
*
* Implementations can return a rollback handle that is invoked when spawn
* fails after preparation succeeds.
*/
prepareSubagentSpawn?(params: {
parentSessionKey: string;
childSessionKey: string;
contextMode?: "isolated" | "fork";
parentSessionId?: string;
parentSessionFile?: string;
childSessionId?: string;
childSessionFile?: string;
ttlMs?: number;
}): Promise<SubagentSpawnPreparation | undefined>;
/**
* Notify the context engine that a subagent lifecycle ended.
*/
onSubagentEnded?(params: {
childSessionKey: string;
reason: SubagentEndReason;
}): Promise<void>;
/**
* Dispose of any resources held by the engine.
*/
dispose?(): Promise<void>;
}
//#endregion
//#region src/agents/agent-harness-completion-scope.d.ts
type AgentHarnessCompletionScope = {
readonly requesterSessionKey: string;
readonly requesterAgentId: string;
readonly requesterOrigin?: DeliveryContext;
};
//#endregion
//#region src/agents/agent-tools.before-tool-call.types.d.ts
type ToolOutcomeObservation = {
toolName: string;
argsHash: string;
resultHash: string;
resultContentSource?: AgentTool["resultContentSource"];
/** Monotonic model-call order within the owning embedded run. */
toolCallOrdinal?: number;
terminalPresentation?: string;
presentationOnly?: boolean;
};
type ToolOutcomeObserver = (observation: ToolOutcomeObservation) => void;
type HookContext = {
agentId?: string;
config?: OpenClawConfig;
/** Selected tool registration owner; independent of the hook requesting approval. */
toolOwnerPluginId?: string;
/** Tool execution cwd for host-derived path facts. */
cwd?: string;
/** Host workspace used to resolve relative tool params for diagnostics only. */
workspaceDir?: string;
sessionKey?: string;
/** Ephemeral session UUID — regenerated on /new and /reset. */
sessionId?: string;
runId?: string;
/** What initiated this run, used to reject approvals on unattended surfaces. */
trigger?: string;
/** Device-scoped operator session allowed to review approvals initiated by this run. */
approvalReviewerDeviceId?: string;
trace?: DiagnosticTraceContext;
channelId?: string;
/** Host-derived message requester for sender-aware tool hooks. */
requester?: PluginHookToolRequesterContext;
/** Originating channel for approval delivery routing; mirrors exec approval turn-source fields. */
turnSourceChannel?: string;
turnSourceTo?: string;
turnSourceAccountId?: string;
turnSourceThreadId?: string | number;
loopDetection?: ToolLoopDetectionConfig;
onToolOutcome?: ToolOutcomeObserver;
allocateToolOutcomeOrdinal?: (toolCallId?: string) => number;
skillsSnapshot?: SkillSnapshot;
skillUsagePaths?: SkillUsagePath[];
skillCommand?: {
commandName: string;
skillFile?: string;
skillName: string;
skillSource?: SkillTelemetrySource;
toolName?: string;
};
sandbox?: {
root: string;
bridge: SandboxFsBridge;
};
};
type BeforeToolCallFailureDisposition = "blocked" | DiagnosticToolTerminalReason;
type PluginApprovalRequest = NonNullable<PluginHookBeforeToolCallResult["requireApproval"]>;
type DeferredPluginToolApproval = {
approval: PluginApprovalRequest;
toolName: string;
toolCallId?: string;
ctx?: HookContext;
baseParams: unknown;
overrideParams?: unknown;
};
type BeforeToolCallPolicyDiagnosticState = {
hasBeforeToolCallHook: boolean;
trustedToolPolicies: Array<{
id: string;
pluginId: string;
pluginName?: string;
}>;
};
type HookBlockedReason = "client-voice-confirmation" | "plugin-before-tool-call" | "plugin-approval" | "plugin-approval-unavailable" | "tool-loop";
type HookBlockedOutcome = {
blocked: true;
deniedReason?: HookBlockedReason;
reason: string;
params?: unknown;
};
type HookOutcome = (HookBlockedOutcome & {
kind: "veto";
genericDecision?: true;
}) | (HookBlockedOutcome & {
kind: "failure";
disposition: BeforeToolCallFailureDisposition;
}) | {
blocked: false;
params: unknown;
ownerDecision?: true;
approvalResolution?: PluginApprovalResolution;
deferredApproval?: DeferredPluginToolApproval;
loopWarning?: ToolLoopWarning;
};
//#endregion
//#region src/agents/delegation-capability.d.ts
type DelegationCapability = "full" | "report_only";
//#endregion
//#region src/agents/tool-effect-receipt.d.ts
/** Host-owned effect provenance for one completed tool lifecycle. */
type ToolEffectReceipt = Readonly<{
state: "not_started" | "read_completed" | "failed_no_effect" | "mutation_committed" | "uncertain";
}>;
//#endregion
//#region src/agents/tool-error-summary.d.ts
type ProcessTerminalDiagnostic = {
kind: "process";
sessionId: string;
reason: {
kind: "exit";
exitCode: number;
} | {
kind: "signal";
signal: string | number;
} | {
kind: "timeout";
timeoutKind?: "overall-timeout" | "no-output-timeout";
};
};
type ToolErrorSummary = {
toolName: string;
executionStarted?: boolean;
meta?: string;
errorCode?: string;
error?: string;
validationErrorSummary?: string;
timedOut?: boolean;
middlewareError?: boolean;
mutatingAction?: boolean;
terminalDiagnostic?: ProcessTerminalDiagnostic | {
kind: "timeout";
timeoutMs: number;
partialResults?: number;
};
};
//#endregion
//#region src/agents/embedded-agent-runner/replay-state.d.ts
type EmbeddedRunReplayState = {
replayInvalid: boolean;
hadPotentialSideEffects: boolean;
};
/** Serializable replay metadata stored with run results. */
type EmbeddedRunReplayMetadata = {
hadPotentialSideEffects: boolean;
replaySafe: boolean;
};
//#endregion
//#region src/agents/embedded-agent-runner/run/preemptive-compaction.types.d.ts
/**
* Route chosen before a model call when context pressure may require compaction or truncation.
*/
type PreemptiveCompactionRoute = "fits" | "compact_only" | "truncate_tool_results_only" | "compact_then_truncate";
//#endregion
//#region src/agents/embedded-agent-runner/run/types.d.ts
type EmbeddedRunAttemptBase = Omit<RunEmbeddedAgentParams, "provider" | "model" | "authProfileId" | "authProfileIdSource" | "thinkLevel" | "fastMode" | "lane" | "enqueue" | "sessionFile" | "preparedRunAdmission" | "admittedRunContext">;
type EmbeddedRunFastModeParam = boolean | (() => boolean | undefined);
type EmbeddedRunAttemptOperation = "attempt" | "settled-tool-finalization";
type EmbeddedRunAttemptToolTerminalObservation = {
toolCallId?: string;
toolName: string;
arguments?: unknown;
/** Original host result or error; public fields cannot supply effect provenance. */
result?: unknown;
meta?: string;
executionStarted?: boolean;
/** Exact-instance replay classification resolved by the host tool catalog. */
replaySafe?: boolean;
outcome: "success" | "failure";
failure?: Omit<ToolErrorSummary, "toolName" | "meta" | "mutatingAction">;
/** Protocol-owned mutation facts for native tools that do not use OpenClaw definitions. */
nativeMutation?: {
mutatingAction: boolean;
replaySafe: boolean;
};
/** Concrete plugin owner; the terminal observer derives mutation facts from executed args. */
ownerMutation?: {
ownerKey: string;
};
};
type EmbeddedRunAttemptToolTerminalResolution = {
lastToolError?: ToolErrorSummary;
executionStarted: boolean;
executedArguments?: Record<string, unknown>;
sideEffectEvidence: boolean;
effectReceipt: ToolEffectReceipt;
};
type EmbeddedRunAttemptToolTerminalObserver = (observation: EmbeddedRunAttemptToolTerminalObservation) => EmbeddedRunAttemptToolTerminalResolution;
/** Host-owned trajectory recorder supplied to plugin harnesses for attempt-local runtime events. */
type EmbeddedRunAttemptTrajectoryRecorder = {
recordEvent: (type: string, data?: Record<string, unknown>) => void;
flush: () => Promise<void>;
};
type EmbeddedRunAttemptParams$1 = EmbeddedRunAttemptBase & {
/** Recomputed by the host for this attempt; never inherited from the requesting turn. */
githubPublicationAvailable?: boolean;
disableToolSearch?: true;
sessionReadScopeKey?: string;
admittedRunContext: NonNullable<RunEmbeddedAgentParams["admittedRunContext"]>;
/**
* Run-owned start timestamp captured by the embedded-run orchestrator before
* admission. Flows onto the queue handle so recovery can project the active
* run's authoritative start time instead of the session's subagent first-run.
*/
startedAtMs?: number;
/** Explicit session owner captured before fallback agent resolution. */
contextEngineAgentId?: string;
/** Host-resolved sandbox snapshot for plugin harness tool construction. */
sandbox?: SandboxContext | null;
/** Host-created authority available only after harness selection. */
hostCapabilities?: AgentHarnessHostCapabilities;
/** Sticky operation identity used to suppress ordinary retry and hook policy. */
operation?: EmbeddedRunAttemptOperation;
/** Core-prepared fact that explicit requester/config policy restricts plugin-native tools. */
pluginHarnessToolPolicyRestricted?: boolean;
/** Audited exact denies that the plugin harness must enforce against native equivalents. */
pluginHarnessToolPolicySafeDeniedTools?: readonly string[];
preparedModelRuntime?: PreparedModelRuntimeSnapshot;
/** Active file-backed artifact target resolved by the run/session target seam. */
sessionFile: string;
initialReplayState?: EmbeddedRunReplayState;
/** Pluggable context engine for ingest/assemble/compact lifecycle. */
contextEngine?: ContextEngine;
/** Resolved model context window in tokens for assemble/compact budgeting. */
contextTokenBudget?: number;
/** Native model context window before session or operator caps are applied. */
modelContextWindow?: number;
/** Per-model contextTokens cap authored by the operator; absent when none was authored. */
authoredContextTokenCap?: number;
/** Source metadata for the resolved model context budget. */
contextWindowInfo?: ContextWindowInfo;
/** Resolved API key for this run when runtime auth did not replace it. */
resolvedApiKey?: string;
/** Auth profile resolved for this attempt's provider/model call. */
authProfileId?: string;
/** Source for the resolved auth profile (user-locked or automatic). */
authProfileIdSource?: "auto" | "user";
provider: string;
modelId: string;
/** Operator-requested or initial model id before any fallback resolution. */
requestedModelId?: string | null;
/** True when this attempt is running after a model fallback decision. */
fallbackActive?: boolean;
/** Concrete fallback reason that selected this attempt, when known. */
fallbackReason?: string | null;
/** Whether this attempt may start or redirect work to another agent/task. */
delegationCapability?: DelegationCapability;
/** Concrete degraded-runtime reason for this attempt, when known. */
degradedReason?: string | null;
/** Final prepared harness for this attempt; not evidence of native session/model ownership. */
agentHarnessId?: string;
/** Non-authorizing expectation; the harness must verify its current private binding. */
expectedSessionRuntimeOwnership?: {
model: "native";
auth: "native" | "host";
/** Host-prepared credentials must still target this exact native tuple at inference. */
modelRef?: ProviderModelRef;
};
/** Capture a local harness implementation only for setup/verified continuations. */
captureRuntimeArtifact?: boolean;
/** Exact implementation that must own the attempt before it creates a native thread. */
expectedRuntimeArtifact?: AgentHarnessRuntimeArtifactBinding;
/** OpenClaw-owned runtime policy prepared by the orchestrator for this attempt. */
runtimePlan?: AgentRuntimePlan;
/** Reports terminal tool facts to the host-owned attempt outcome accumulator. */
observeToolTerminal?: EmbeddedRunAttemptToolTerminalObserver;
/** Host-issued scope for harness-owned child completion. */
agentHarnessCompletionScope?: AgentHarnessCompletionScope;
/** Host-only originals retained across native image projection. */
inputAttachmentMedia?: RunEmbeddedAgentParams["media"];
/** Storage-aware trajectory recorder owned by the OpenClaw host. */
trajectoryRecorder?: EmbeddedRunAttemptTrajectoryRecorder | null;
/** Live observer called after wrapped tool outcomes are recorded. */
onToolOutcome?: ToolOutcomeObserver;
/** Reads the sticky untrusted-content flag for the current user turn. */
isTurnTainted?: () => boolean;
/** Shipped harness notification; core uses onAttemptDeadlineChanged for queue ownership. */
onAttemptTimeoutArmed?: () => void;
/** Hands the lane an authoritative deadline, never a progress-idle estimate. */
onAttemptDeadlineChanged?: (deadline: CommandQueueTaskDeadline) => void;
/** Signals that this attempt's timeout has fired and must unwind promptly. */
onAttemptTimeout?: (reason: Error) => void;
/** Signals an explicit cancellation through the active native run handle. */
onAttemptAbort?: () => void;
onDeferredLifecycleOwner?: (owner: DeferredEmbeddedRunLifecycleOwner) => void;
onDeferredLifecycleAbort?: (reason?: "user_abort" | "restart" | "superseded") => void;
/** Host-requested runtime replacement takes effect after the current tool batch is persisted. */
pluginRuntimeRefreshPending?: () => boolean;
/** Registers the exact attempt owner able to stop before another model request. */
registerPluginRuntimeRefreshConsumer?: (isCurrent: () => boolean) => void;
/** Completed native attempt results excluded by the original admission read fence. */
pluginRuntimeRefreshMessages?: AgentMessage[];
/** Run-owned permission changes survive native attempt replacement, never user cancellation. */
permissionChange?: {
readonly owner: object;
readonly baseExecOverrides: Readonly<NonNullable<RunEmbeddedAgentParams["execOverrides"]>>;
readonly notice?: string;
request: (mode: NonNullable<RunEmbeddedAgentParams["permissionMode"]> | null) => Promise<boolean>;
/** False means a newer permission request superseded this prepared attempt. */
applied: () => boolean;
recordApplied: (mode: NonNullable<RunEmbeddedAgentParams["permissionMode"]> | null) => void;
};
/** Supplies run-global model-call ordering for parallel tool outcomes. */
allocateToolOutcomeOrdinal?: (toolCallId?: string) => number;
model: Model;
authStorage: AuthStorage;
/** Auth profile store already resolved during startup for this attempt. */
authProfileStore: AuthProfileStore;
/**
* Full auth profile store for OpenClaw tool availability.
* Plugin-owned harnesses may scope `authProfileStore` to model transport credentials.
*/
toolAuthProfileStore?: AuthProfileStore;
modelRegistry: ModelRegistry$1;
thinkLevel: ThinkLevel;
fastMode?: EmbeddedRunFastModeParam;
/** True when this attempt is running the auto fast-mode policy. */
fastModeAuto?: boolean;
beforeAgentFinalizeRevisionAttempts?: number;
maxBeforeAgentFinalizeRevisions?: number;
};
type EmbeddedRunAttemptResult = {
terminal: AgentRunAttemptTerminal;
/** True when the runtime made the authoritative final-assistant transcript decision. */
assistantTranscriptOwned?: boolean;
/** Exact idempotency key for the runtime-owned final-assistant transcript row. */
assistantTranscriptIdempotencyKey?: string;
/** Host-private terminal identity used to close the accepted transcript turn. */
contextEngineTerminalAnchor?: TranscriptEntryAnchor;
preflightRecovery?: {
route: Exclude<PreemptiveCompactionRoute, "fits">;
source?: "mid-turn";
estimatedPromptTokens?: number;
promptBudgetBeforeReserve?: number;
overflowTokens?: number;
handled: true;
truncatedCount?: number;
} | {
route: Exclude<PreemptiveCompactionRoute, "fits">;
source?: "mid-turn";
estimatedPromptTokens?: number;
promptBudgetBeforeReserve?: number;
overflowTokens?: number;
handled?: false;
};
sessionIdUsed: string;
sessionFileUsed?: string;
diagnosticTrace?: DiagnosticTraceContext;
agentHarnessId?: string;
/** Current physical model attempt; replaced from the prepared runtime plan at the boundary. */
modelAttempt?: AgentRuntimeModelAttempt;
/** Native owner's selected tuple, distinct from response/billing model attribution. */
runtimeModelSelection?: ProviderModelRef;
/** Exact credential material fingerprint reported by a harness-owned auth boundary. */
authBindingFingerprint?: string;
/** Exact local implementation used by a plugin-owned harness attempt. */
runtimeArtifact?: AgentHarnessRuntimeArtifactBinding;
agentHarnessResultClassification?: "empty" | "reasoning-only" | "planning-only";
promptTimeoutOutcome?: {
message?: string;
replayInvalid?: boolean;
livenessState?: EmbeddedRunLivenessState;
timeoutPhase?: AgentRunTimeoutPhase;
providerStarted?: boolean;
};
codexAppServerFailure?: {
kind: "client_closed_before_turn_completed" | "turn_settlement_timeout" | "turn_completion_idle_timeout";
turnWatchTimeoutKind?: "progress" | "completion" | "terminal";
transport: "stdio" | "unix" | "websocket";
threadId?: string;
turnId?: string;
replaySafe: boolean;
replayBlockedReason?: "assistant_output" | "tool_activity" | "potential_side_effect" | "active_item";
diagnostics?: {
transportError?: string;
idleMs?: number;
timeoutMs?: number;
lastActivityReason?: string;
lastNotificationMethod?: string;
lastNotificationItemId?: string;
lastNotificationItemType?: string;
lastNotificationItemRole?: string;
lastAssistantTextPreview?: string;
activeAppServerTurnRequests?: number;
activeTurnItemCount?: number;
terminalTurnNotificationQueued?: boolean;
completionIdleWatchArmed?: boolean;
assistantCompletionIdleWatchArmed?: boolean;
terminalIdleWatchArmed?: boolean;
};
};
bootstrapPromptWarningSignaturesSeen?: string[];
bootstrapPromptWarningSignature?: string;
systemPromptReport?: SessionSystemPromptReport;
finalPromptText?: string;
/** Exact provider-response count when the harness can observe model iterations directly. */
modelIterations?: number;
/** Saved provider retry setting resolved by the prepared session owner. */
providerRetryMaxRetries?: number;
/** Saved retry.provider.maxRetryDelayMs from the same owner; 0 disables the cap. */
providerRetryMaxDelayMs?: number;
messagesSnapshot: AgentMessage[];
pluginRuntimeRefreshMessages?: AgentMessage[];
/** Owner-eligible settled finalization, with frozen evidence or an unavailable projection. */
settledTurnFinalizationContext?: {
readonly source: "openclaw-transcript";
readonly messages: readonly AgentMessage[];
} | {
readonly source: "harness";
readonly data: unknown;
} | {
readonly source: "unavailable";
};
beforeAgentFinalizeRevisionReason?: string;
assistantTexts: string[];
/** Immutable delivery facts prepared before a remote harness releases its file reader. */
preparedReplyMedia?: PreparedReplyMedia;
latestMcpAppChannelView?: McpAppChannelView;
latestMcpConnectAction?: McpConnectAction;
lastAssistantTextMessageIndex?: number;
toolMetas: Array<{
toolName: string;
toolCallId?: string;
meta?: string;
replaySafe?: boolean;
isError?: boolean;
terminate?: boolean;
asyncStarted?: boolean;
asyncTaskRunId?: string;
asyncTaskId?: string;
/** Producer-recorded: this exec result parked a Code Mode run (status "waiting"). */
codeModeSuspended?: boolean;
}>;
acceptedSessionSpawns?: AcceptedSessionSpawn[];
/** Core successfully settled this requester's explicit yield in the registry. */
requesterContinuationSettled?: true;
/** This attempt accepted work whose future output has a runtime-owned delivery path. */
runtimeContinuationStarted?: boolean;
lastAssistant: AssistantMessage$1 | undefined;
/**
* Omission preserves the legacy `lastAssistant` fallback; explicit `undefined`
* means this attempt produced no assistant response.
*/
currentAttemptAssistant?: AssistantMessage$1 | undefined;
/** Completed message_end snapshot owned by this model attempt. */
currentAttemptCompletedAssistant?: AssistantMessage$1 | undefined;
/** A real model response completed successfully during this attempt, before any later failure. */
hasSuccessfulModelResponse?: boolean;
lastToolError?: ToolErrorSummary;
didSendViaMessagingTool: boolean;
didDeliverSourceReplyViaMessageTool?: boolean;
sourceReplyDelivered?: true;
sourceReplyDeliveryState?: ReplyDeliveryState;
didSendDeterministicApprovalPrompt?: boolean;
messagingToolSentTexts: string[];
messagingToolSentMediaUrls: string[];
messagingToolSentTargets: MessagingToolSend[];
messagingToolSourceReplyPayloads?: MessagingToolSourceReplyPayload[];
heartbeatToolResponse?: HeartbeatToolResponse;
toolMediaUrls?: string[];
/**
* Native artifacts produced and owned by the harness, never model-selected
* dynamic-tool output. Core validates this as a subset of toolMediaUrls.
*/
hostOwnedToolMediaUrls?: string[];
toolAudioAsVoice?: boolean;
toolTrustedLocalMedia?: boolean;
hasToolMediaBlockReply?: boolean;
successfulCronAdds?: number;
cloudCodeAssistFormatError: boolean;
/** Effective context window reported by the harness during this attempt. */
contextTokens?: number;
/** Whether the harness observed the window or carried prepared resolution forward. */
contextTokensSource?: "runtime" | "runtime-configured" | "resolved";
attemptUsage?: NormalizedUsage;
promptCache?: ContextEnginePromptCacheInfo;
contextBudgetStatus?: SessionContextBudgetStatus;
compactionCount?: number;
compactionTokensAfter?: number;
/**
* Client tool calls detected during this attempt (OpenResponses hosted
* tools), in the order the underlying LLM emitted them. Field is
* `undefined` when no client tools were called so existing truthiness
* checks across the runner pipeline (`attempt.clientToolCalls ? ...`)
* keep their meaning. When set, the array always has at least one entry.
*/
clientToolCalls?: Array<{
name: string;
params: Record<string, unknown>;
}>;
/** True when sessions_yield tool was called during this attempt. */
yieldDetected?: boolean;
/** Explicit user-facing waiting status supplied to sessions_yield. */
yieldAcknowledgment?: string;
/**
* True when code mode owned this attempt's model tool surface. Absent means
* the harness did not report engagement (treated as not engaged), which is
* how config-enabled code mode stays visible as a no-op on harness routes.
*/
codeModeEngaged?: boolean;
/** Completed assistant round trips observed during this attempt. */
assistantTurns?: number;
/** Inner bridge call counts from this attempt's tool-search/code-mode catalog. */
bridgeCalls?: {
search: number;
describe: number;
call: number;
};
replayMetadata: EmbeddedRunReplayMetadata;
/**
* Replay metadata for this attempt before prior session state is accumulated.
* Older harnesses may omit it and retain conservative cumulative retry gating.
*/
currentAttemptReplayMetadata?: EmbeddedRunReplayMetadata;
itemLifecycle: {
startedCount: number;
completedCount: number;
activeCount: number;
};
setTerminalLifecycleMeta?: (meta: {
replayInvalid?: boolean;
livenessState?: EmbeddedRunLivenessState;
stopReason?: string;
yielded?: boolean;
timeoutPhase?: AgentRunTimeoutPhase;
providerStarted?: boolean;
aborted?: boolean;
}) => void;
};
//#endregion
//#region src/agents/embedded-agent-runner/compact.types.d.ts
type CompactEmbeddedAgentSessionParams = Pick<RunEmbeddedAgentParams, "requireWorkspaceOnly" | "requireWritableSandbox" | "sessionTarget" | "sessionId" | "sessionKey" | "agentId" | "sandboxSessionKey" | "sandboxAgentId" | "messageChannel" | "messageProvider" | "clientCaps" | "pinnedWidgetAuthoring" | "chatType" | "agentAccountId" | "conversationRoutePeerId" | "conversationToolPolicy" | "currentChannelId" | "currentThreadTs" | "currentMessageId" | "authProfileId" | "authProfileIdSource" | "groupId" | "groupChannel" | "groupSpace" | "memberRoleIds" | "spawnedBy" | "inputProvenance" | "trustedInternalHandoff" | "toolsAllow" | "disableTools" | "runtimePluginToolGrant" | "scheduledToolPolicy" | "workspaceDir" | "bootstrapWorkspaceDir" | "cwd" | "permissionMode" | "sessionRoot" | "agentDir" | "config" | "toolOverrides" | "skillsSnapshot" | "senderIsOwner" | "provider" | "model" | "modelFallbacksOverride" | "contextTokenBudget" | "agentHarnessId" | "modelSelectionLocked" | "thinkLevel" | "reasoningLevel" | "bashElevated" | "lane" | "enqueue" | "extraSystemPrompt" | "sourceReplyDeliveryMode" | "ownerNumbers" | "abortSignal" | "allowGatewaySubagentBinding" | "oneShotCliRun"> & {
/** Explicit session owner captured before fallback agent resolution. */
contextEngineAgentId?: string;
runId?: string;
/** Trusted sender id from inbound context for scoped message-tool discovery. */
senderId?: string;
senderName?: string;
senderUsername?: string;
senderE164?: string;
/** Host-resolved provider credential for native harness compaction. */
resolvedApiKey?: string;
/** Host-resolved ambient native-tool boundary for this compaction operation. */
nativeToolSurface?: "unrestricted" | "host-isolated";
sessionFile: string;
/** Optional caller-observed live prompt tokens used for compaction diagnostics. */
currentTokenCount?: number;
/** Caller-resolved model/provider shape used by native harness compactors. */
runtimeModel?: Model;
/** Optional caller-resolved context engine for harness-owned compaction. */
contextEngine?: ContextEngine;
/** Optional caller-resolved runtime context for harness-owned context-engine compaction. */
contextEngineRuntimeContext?: ContextEngineRuntimeContext;
/** Resumable native CLI session targeted by an explicit manual compaction. */
cliSessionId?: string;
/** Complete persisted CLI binding targeted by an explicit manual compaction. */
cliSessionBinding?: CliSessionBinding;
/** Owning session facts required for placement and runtime preparation. */
sessionEntry?: SessionEntry$1;
/** OpenClaw-owned runtime policy prepared for this compaction path. */
runtimePlan?: AgentRuntimePlan;
/** Host-prepared route and credential selection for native harness compaction. */
runtimeAuthPlan?: AgentRuntimeAuthPlan;
execOverrides?: Pick<ExecToolDefaults, "host" | "mode" | "security" | "ask" | "node" | "nodeCwd">;
customInstructions?: string;
tokenBudget?: number;
force?: boolean;
/** Force compaction because the caller already determined this turn must compact before prompt submission. */
forcePreflight?: boolean;
/** Alias for forcePreflight used by preflight budget gates. */
preflightRequired?: boolean;
/** Diagnostic trigger that made preflight compaction mandatory. */
preflightCompactionTrigger?: "tokens" | "transcript_bytes";
trigger?: "budget" | "overflow" | "manual";
/**
* Preflight callers can allow native/current-session harness compaction but
* move plugin-owned budget compaction onto background turn maintenance.
*/
deferOwningContextEngineCompaction?: boolean;
diagId?: string;
attempt?: number;
maxAttempts?: number;
/** @internal Refreshes the host watchdog when delegated native compaction makes progress. */
compactionTimeoutReset?: () => void;
onCompactionHookMessages?: (payload: {
phase: "before" | "after";
messages: string[];
sessionId: string;
sessionKey: string;
}) => void | Promise<void>;
};
//#endregion
//#region src/agents/harness/types.d.ts
/** Private native ownership, not execution authority or credential readiness. */
type AgentHarnessSessionRuntimeOwnership = {
model: "native";
auth: "native" | "host";
/** Actual native selection, only when both facts are known from the same binding. */
modelRef?: ProviderModelRef;
};
type AgentHarnessPreparedAuthSupport = {
source: "profile" | "direct" | "harness" | "none";
mode?: string;
requirement?: ProviderModelRouteAuthRequirement;
};
type AgentHarnessSupportContext = {
provider: string;
modelId?: string;
modelProvider?: {
api?: string;
baseUrl?: string;
azureApiVersion?: string;
/** Secret-free projection of request behavior a native harness must reproduce. */
requestTransportOverrides?: ProviderRouteOverridePresence;
/** Authored endpoints that a native runtime must reproduce. */
endpointOverrides?: ProviderRouteOverridePresence;
/** Provider-owned native-runtime compatibility for the prepared route. */
runtimePolicy?: ProviderModelRouteRuntimePolicy;
/** Secret-free auth source the native runtime must reproduce for this attempt. */
preparedAuth?: AgentHarnessPreparedAuthSupport;
request?: {
auth?: {
mode?: unknown;
};
proxy?: unknown;
tls?: unknown;
allowPrivateNetwork?: unknown;
};
};
requestedRuntime: EmbeddedAgentRuntime;
providerOwnerStatus?: "unowned" | "owned" | "ambiguous";
providerOwnerPluginIds?: readonly string[];
};
type AgentHarnessSupport = {
supported: true;
priority?: number;
reason?: string;
} | {
supported: false;
reason?: string;
/** Lossless host fallback when this harness cannot reproduce the prepared request. */
fallbackRuntime?: "openclaw";
};
type InternalEmbeddedRunAttemptParams = EmbeddedRunAttemptParams$1;
/** @deprecated Read `terminal` instead. Remove no earlier than the 2026.9 stable release. */
type AgentHarnessDeprecatedAttemptTerminalFields = {
aborted?: boolean;
externalAbort?: boolean;
timedOut?: boolean;
idleTimedOut?: boolean;
timedOutDuringCompaction?: boolean;
timedOutDuringToolExecution?: boolean;
timedOutByRunBudget?: boolean;
promptError?: unknown;
promptErrorSource?: AgentRunAttemptFailureSource | null;
};
type AgentHarnessCanonicalAttemptResult = Omit<EmbeddedRunAttemptResult, "contextEngineTerminalAnchor"> & AgentHarnessDeprecatedAttemptTerminalFields;
/** @deprecated Return `terminal` instead. Remove no earlier than the 2026.9 stable release. */
type AgentHarnessLegacyAttemptResult = Omit<AgentHarnessCanonicalAttemptResult, "terminal"> & Required<Omit<AgentHarnessDeprecatedAttemptTerminalFields, "timedOutDuringToolExecution" | "timedOutByRunBudget">>;
type AgentHarnessAttemptParamsBase = Omit<InternalEmbeddedRunAttemptParams, "admittedRunContext" | "disableToolSearch" | "sessionReadScopeKey" | "assistantErrorTranscript" | "contextEngineLogicalTurnLease" | "onContextEngineTurnCandidate" | "trajectoryRecorder" | "inputAttachmentMedia">;
/**
* @deprecated Use AgentHarnessAttemptParamsV2. The optional capability keeps
* existing harness source compatible through 2026-10-12.
*/
type AgentHarnessAttemptParams = AgentHarnessAttemptParamsBase & {
hostCapabilities?: AgentHarnessHostCapabilities;
};
/** Current host-prepared attempt contract for agent harnesses. */
type AgentHarnessAttemptParamsV2 = AgentHarnessAttemptParamsBase & {
hostCapabilities: AgentHarnessHostCapabilities;
};
type AgentHarnessAttemptResult = AgentHarnessCanonicalAttemptResult | AgentHarnessLegacyAttemptResult;
type AgentHarnessSettledTurnFinalizationAttemptParams<TAttemptParams extends AgentHarnessAttemptParams = AgentHarnessAttemptParams> = Omit<TAttemptParams, "hostCapabilities"> & {
hostCapabilities?: never;
};
type AgentHarnessSettledTurnFinalizationParams<TAttemptParams extends AgentHarnessAttemptParams = AgentHarnessAttemptParams> = {
/** Fully prepared attempt context for the isolated finalization operation. */
attempt: AgentHarnessSettledTurnFinalizationAttemptParams<TAttemptParams>;
/** Settled result whose completed tool transcript needs a final visible answer. */
settledAttempt: AgentHarnessCanonicalAttemptResult;
};
type AgentHarnessSettledTurnFinalizationResult = {
/** The single completed assistant answer produced by the isolated operation. */
assistant: AssistantMessage$1;
/** Normalized usage for the finalization model call only. */
usage?: NormalizedUsage;
/** True when the harness already persisted the assistant into the application transcript. */
assistantTranscriptOwned?: boolean;
/** Exact idempotency key for the harness-owned assistant transcript row. */
assistantTranscriptIdempotencyKey?: string;
/** Assistant stream generation index used to correlate final reply delivery. */
assistantMessageIndex?: number;
diagnosticTrace?: DiagnosticTraceContext;
};
/** @deprecated Use AgentHarnessIsolatedCompletionParamsV2. Remove after 2026-10-12. */
type AgentHarnessIsolatedCompletionParams = {
/** Logical provider selected by the caller before harness dispatch. */
provider: string;
/** Logical model id selected by the caller before harness dispatch. */
modelId: string;
/** Exact prepared transport model; harnesses must not resolve another route. */
model: Model;
/** Exact prepared credential; harnesses must not rotate or substitute it. */
auth: ResolvedProviderAuth;
/** Non-reversible proof of the prepared credential owner when available. */
sourceAuthFingerprint?: string;
config: OpenClawConfig;
agentId: string;
agentDir: string;
workspaceDir: string;
systemPrompt: string;
prompt: string;
timeoutMs: number;
abortSignal?: AbortSignal;
/** Revalidate after preparation and before credential or inference I/O, including retries. */
assertCurrent?: () => void;
thinkLevel?: ThinkLevel;
/** Do not recover ambiguous reasoning as visible text; an empty visible result is valid. */
outputTextPolicy?: "strict-visible";
streamParams?: {
maxTokens?: number;
temperature?: number;
};
};
type AgentHarnessIsolatedCompletionAuthorization = {
/** OpenClaw resolved the exact transport model and credential before handoff. */
owner: "host";
model: Model;
auth: ResolvedProviderAuth;
/** Non-reversible proof of the prepared credential owner when available. */
sourceAuthFingerprint?: string;
} | {
/** The selected harness owns credential resolution for this prepared route. */
owner: "harness";
plan: AgentRuntimeAuthPlan;
/** Credential snapshot restricted to the single profile selected for this call. */
authProfileStore: AuthProfileStore;
};
type AgentHarnessIsolatedCompletionParamsV2 = Omit<AgentHarnessIsolatedCompletionParams, "model" | "auth" | "sourceAuthFingerprint"> & {
authorization: AgentHarnessIsolatedCompletionAuthorization;
};
type AgentHarnessIsolatedCompletionResult = {
/** The single assistant completion. Core rejects tool-shaped or failed results. */
assistant: AssistantMessage$1;
};
type AgentHarnessAuthBindingFingerprintParams = {
authProfileId: string;
authProfileStore: AuthProfileStore;
agentDir: string;
config?: OpenClawConfig;
};
/**
* @deprecated Use {@link AgentHarnessSideQuestionParamsV2}. This compatibility
* contract is retained through 2026-10-12.
*/
type AgentHarnessSideQuestionParams = {
/** Host-bound authority for this admitted side execution; contains no public token fields. */
hostCapabilities?: AgentHarnessHostCapabilities;
/** Host-resolved sandbox snapshot for this side execution. */
sandbox?: SandboxContext | null;
/** Prepared plugin/model generation that owns this side execution. */
preparedModelRuntime?: PreparedModelRuntimeSnapshot;
cfg: OpenClawConfig;
agentDir: string;
provider: string;
model: string;
runtimeModel?: Model<Api>;
/** One atomic route/profile/store snapshot prepared before native dispatch. */
preparedRuntimeAuth: {
plan: AgentRuntimeAuthPlan;
authProfileStore: AuthProfileStore;
authStorage: AuthStorage;
modelRegistry: ModelRegistry$1;
/** Resolved host credential for an immutable API-key route only. */
resolvedApiKey?: string;
};
question: string;
images?: ImageContent$1[];
sessionEntry: SessionEntry$1;
sessionStore?: Record<string, SessionEntry$1>;
sessionKey?: string;
storePath?: string;
resolvedThinkLevel?: ThinkLevel;
resolvedReasoningLevel: ReasoningLevel;
blockReplyChunking?: BlockReplyChunking;
resolvedBlockStreamingBreak?: "text_end" | "message_end";
opts?: GetReplyOptions;
isNewSession: boolean;
sessionId: string;
sessionFile: string;
sandboxSessionKey?: string;
agentId?: string;
workspaceDir?: string;
messageChannel?: string;
messageProvider?: string;
chatType?: ChatType;
agentAccountId?: string;
messageTo?: string;
messageThreadId?: string | number;
chatId?: string;
messageActionTurnCapability?: string;
groupId?: string | null;
groupChannel?: string | null;
groupSpace?: string | null;
memberRoleIds?: string[];
spawnedBy?: string | null;
senderId?: string | null;
senderName?: string | null;
senderUsername?: string | null;
senderE164?: string | null;
senderIsOwner?: boolean;
currentChannelId?: string;
toolsAllow?: string[];
authProfileId?: string;
authProfileIdSource?: "auto" | "user";
};
/** Current side-question contract for hosts that always provide closure-bound authority. */
type AgentHarnessSideQuestionParamsV2 = AgentHarnessSideQuestionParams & {
hostCapabilities: AgentHarnessHostCapabilities;
};
type AgentHarnessSideQuestionResult = {
text: string;
/** Aggregate billed usage for the side question, including native tool-loop calls. */
usage?: NormalizedUsage;
};
type LegacyAgentHarnessCompactParams = CompactEmbeddedAgentSessionParams;
/** Select version 2 for required host authority; the default preserves registered legacy callbacks. */
type AgentHarnessCompactParams<Version extends 1 | 2 = 1> = Version extends 2 ? LegacyAgentHarnessCompactParams & {
hostCapabilities: Readonly<Pick<AgentHarnessHostCapabilities, "kind" | "version" | "assertActive"> & Required<Pick<AgentHarnessHostCapabilities, "retainSourceAuthority">>>;
} : LegacyAgentHarnessCompactParams;
type AgentHarnessCompactResult = EmbeddedAgentCompactResult;
type AgentHarnessNativeCompactionRequest = "after_context_engine" | "required_preflight";
type AgentHarnessNativeCompactionParams<Version extends 1 | 2 = 1> = AgentHarnessCompactParams<Version> & {
nativeCompactionRequest: AgentHarnessNativeCompactionRequest;
};
type AgentHarnessNativeCompaction = (params: AgentHarnessNativeCompactionParams) => Promise<AgentHarnessCompactResult | undefined>;
type AgentHarnessRegistrationOptions = {
/**
* Registers the Codex-only native preflight bridge in host-owned registry
* metadata. Arbitrary properties on the public harness never grant it.
*/
nativeCompaction?: AgentHarnessNativeCompaction;
};
type AgentHarnessResetParams = {
agentId?: string;
sessionId?: string;
sessionKey?: string;
sessionFile?: string;
reason?: "new" | "reset" | "idle" | "daily" | "compaction" | "deleted" | "unknown";
};
type AgentHarnessSessionForkFailureCode = "steer-message" | "in-progress-turn" | "drift-mismatch" | "upstream-unavailable";
type AgentHarnessSessionForkParams = {
targetKey: string;
/** Creator-owned isolation floor resolved by the trusted Gateway request. */
sandbox?: "required";
source: {
agentId: string;
sessionId: string;
sessionKey: string;
storePath: string;
entryId: string;
};
upstream: {
catalogId: string;
hostId: string;
kind: SessionUpstreamKind;
threadId: string;
ref: SessionUpstreamJsonValue;
};
};
/** Current fork contract for harnesses that can fence native side effects. */
type AgentHarnessSessionForkParamsV2 = AgentHarnessSessionForkParams & {
/** Revalidate immediately before native side effects; this authority closes when fork settles. */
assertCurrent: () => void;
};
type AgentHarnessSessionForkResult = {
status: "created";
key: string;
editorText?: string;
} | {
status: "failed";
code: AgentHarnessSessionForkFailureCode;
message: string;
};
type AgentHarnessResultClassification = "ok" | NonNullable<AgentHarnessAttemptResult["agentHarnessResultClassification"]>;
type AgentHarnessDeliveryDefaults = {
/** Default visible-reply policy when config does not override the harness. */
visibleReplies?: "automatic" | "message_tool";
/**
* @deprecated Use visibleReplies. Kept for existing harness plugins.
*/
sourceVisibleReplies?: "automatic" | "message_tool";
};
/** Exact node authority and worker capacity required by one paired-device runtime. */
type DevicePlacementRequirement = {
requiredNodeCommands: readonly string[];
consumesWorkerSlot: boolean;
};
type AgentHarnessRunCapability<TAttemptParams extends AgentHarnessAttemptParams = AgentHarnessAttemptParams> = {
id: string;
label: string;
pluginId?: string;
/**
* Exhaustive provider ids eligible for automatic selection. Omitting this hint preserves
* dynamic probing; an empty list marks an explicit-only harness.
*/
autoSelection?: {
providerIds: readonly string[];
};
/** Declares host-owned remote execution and its exact paired-device requirements. */
cloudPlacement?: {
mode: "remote-exec";
devicePlacement?: DevicePlacementRequirement;
};
/**
* Plugin ids this harness owner permits to execute its locked sessions.
* Delegates receive work admission and execution only; session mutation stays owner-only.
*/
delegatedExecutionPluginIds?: readonly string[];
/**
* Context-engine host capabilities provided by this harness during agent
* runs. Harnesses that omit this are unsupported for engines that declare
* host requirements.
*/
contextEngineHostCapabilities?: readonly ContextEngineHostCapability[];
deliveryDefaults?: AgentHarnessDeliveryDefaults;
/** Core must reject containment this runtime cannot implement before invoking it. */
executionEnvironment?: "host-only";
/** Certifies exact runAttempt enforcement; direct-policy-restricted channel side questions fail in core. */
conversationToolPolicySupport?: "exact";
/** Certifies binding the actual native model through the host before every inference dispatch. */
nativeModelPolicySupport?: "exact";
/**
* Canonical OpenClaw tool names whose exact denies the harness can also enforce
* against native equivalents. Every other deny remains fail-closed.
*/
conversationToolPolicySafeDenyTools?: readonly string[];
/** OpenClaw tool capabilities an indivisible native surface requires from effective profiles. */
conversationToolPolicyNativeTools?: readonly string[];
supports(ctx: AgentHarnessSupportContext): AgentHarnessSupport;
/** Synchronous private ownership read; no discovery, auth loading, or native connection setup. */
resolveSessionRuntimeOwnership?(params: {
config?: OpenClawConfig;
agentId?: string;
sessionId: string;
sessionKey?: string;
storePath?: string;
/** Latest predecessor of this exact physical session; valid only during this invocation. */
readPreviousSessionId?: () => string | undefined;
assertCurrent: () => void;
}): AgentHarnessSessionRuntimeOwnership | undefined;
/** Lets this harness resolve forwarded profiles or its own native credentials. */
authBootstrap?: "harness";
runAttempt(params: TAttemptParams): Promise<AgentHarnessAttemptResult>;
/**
* Produces one final answer from a settled tool transcript without exposing
* capabilities that can repeat or extend the completed work.
*/
finalizeSettledTurn?(params: AgentHarnessSettledTurnFinalizationParams<TAttemptParams>): Promise<AgentHarnessSettledTurnFinalizationResult>;
/** @deprecated Implement runIsolatedCompletionV2. Remove after 2026-10-12. */
runIsolatedCompletion?(params: AgentHarnessIsolatedCompletionParams): Promise<AgentHarnessIsolatedCompletionResult>;
/**
* Runs one fresh prompt-only completion with a literal zero-tool model surface.
* The harness must fail closed when it cannot enforce that native boundary.
* Agents API is the documented exception: its restricted sessions may retain
* service-owned helpers. Callers requiring zero tools must use another runtime.
*/
runIsolatedCompletionV2?(params: AgentHarnessIsolatedCompletionParamsV2): Promise<AgentHarnessIsolatedCompletionResult>;
};
type AgentHarnessSideQuestionCapability<TSideQuestionParams extends AgentHarnessSideQuestionParams = AgentHarnessSideQuestionParams> = {
runSideQuestion?(params: TSideQuestionParams): Promise<AgentHarnessSideQuestionResult>;
};
type AgentHarnessClassificationCapability<TAttemptParams extends AgentHarnessAttemptParams = AgentHarnessAttemptParams> = {
classify?(result: AgentHarnessAttemptResult, ctx: TAttemptParams): AgentHarnessResultClassification | undefined;
};
type AgentHarnessCompactionCapability = {
compact?(params: AgentHarnessCompactParams): Promise<AgentHarnessCompactResult | undefined>;
};
type AgentHarnessSessionDeletionParams = {
/** Present only during the exact host initializer's guarded rollback. */
initialization?: SessionInitialization;
agentId: string;
sessionKey: string;
sessionId: string;
lifecycleRevision?: string;
/** Revalidate the captured registry, harness, and operation before each side effect. */
assertCurrent: () => void;
};
type AgentHarnessSessionDeletionMutation = {
/** Synchronously remove only the prepared owner's state at the session commit edge. */
commit: () => void;
/** Restore only that removal when the authoritative session transaction rolls back. */
rollback: () => void;
};
type AgentHarnessSessionContextResetParams = Omit<AgentHarnessSessionDeletionParams, "initialization"> & {
/** Exact recorded predecessor may still own native context after interrupted compaction. */
previousSessionId?: string;
};
type AgentHarnessSessionLifecycleCapability = {
reset?(params: AgentHarnessResetParams): Promise<void> | void;
/** Invalidate native context only when a same-key history cut commits; preserve compaction. */
withSessionContextReset?<T>(this: void, params: AgentHarnessSessionContextResetParams, run: (mutation: AgentHarnessSessionDeletionMutation) => Promise<T>): Promise<T>;
/** Prepare outside the session writer; release native resources after its commit completes. */
withSessionDeletion?<T>(this: void, params: AgentHarnessSessionDeletionParams, run: (mutation: AgentHarnessSessionDeletionMutation) => Promise<T>): Promise<T>;
dispose?(): Promise<void> | void;
};
type AgentHarnessSessionForkCapability = {
/**
* @deprecated Use sessionForkV2. This legacy fork contract remains
* source-compatible through 2026-10-12.
*/
sessionFork?: {
upstreamKinds: readonly SessionUpstreamKind[];
fork(params: AgentHarnessSessionForkParams): Promise<AgentHarnessSessionForkResult>;
};
sessionForkV2?: {
/** Declares fork initialization that can execute work on the Gateway host. */
executionEnvironment?: "host-only";
upstreamKinds: readonly SessionUpstreamKind[];
fork(params: AgentHarnessSessionForkParamsV2): Promise<AgentHarnessSessionForkResult>;
};
};
type AgentHarnessRuntimeArtifactCapability = {
/** Revalidate an artifact only at setup and persistent-operation boundaries. */
runtimeArtifact?: {
validate(binding: AgentHarnessRuntimeArtifactBinding): Promise<boolean>;
};
};
type AgentHarnessAuthBindingCapability = {
/** Recomputes the exact credential fingerprint at persistent trust boundaries. */
authBinding?: {
fingerprint(params: AgentHarnessAuthBindingFingerprintParams): Promise<string | undefined>;
};
};
type AgentHarnessProviderUsageCapability = {
/**
* Contributes runtime-owned quota data without registering a text provider.
* Provider usage hooks remain authoritative when both surfaces exist.
*/
fetchUsageSnapshot?: (ctx: ProviderFetchUsageSnapshotContext) => Promise<ProviderUsageSnapshot | null | undefined> | ProviderUsageSnapshot | null | undefined;
};
type AgentHarnessMcpCatalogParams = {
config: OpenClawConfig;
agentId: string;
sessionId: string;
sessionKey: string;
workspaceDir: string;
/** OpenClaw-configured servers whose session policy this harness can enforce. */
mcpServerNames: readonly string[];
toolOverrides?: Pick<SessionToolOverrides, "mcpServers" | "mcpToolsDeny">;
};
type AgentHarnessMcpCatalogCapability = {
/** Lists the MCP tools owned by this session's native runtime, if it is already bound. */
loadMcpToolCatalog?(params: AgentHarnessMcpCatalogParams): Promise<McpToolCatalog | undefined>;
};
type AgentHarnessModelCatalogParams = {
config: OpenClawConfig;
agentId: string;
agentDir: string;
workspaceDir: string;
configuredModelRefs?: readonly ProviderModelRef[];
};
type AgentHarnessModelCatalogResult = readonly ModelCatalogEntry[] | {
entries: readonly ModelCatalogEntry[];
outcomes?: readonly ProviderCatalogOutcome[];
};
type AgentHarnessModelCatalogCapability = {
/** Lists account-scoped models owned by this native runtime. */
loadModelCatalog?(params: AgentHarnessModelCatalogParams): Promise<AgentHarnessModelCatalogResult>;
/**
* Reads current, secret-free native account evidence for this exact catalog scope/model.
* No I/O or discovery here. Missing/stale/disposed evidence returns undefined; this is
* picker metadata only, never execution authorization or a host-route credential.
* When known, authMode describes this same account observation.
*/
readModelCatalogReadiness?(params: AgentHarnessModelCatalogParams & {
provider: string;
modelId: string;
}): {
accountType: string;
authMode?: string;
} | undefined;
};
type AgentHarnessSharedCapabilities = AgentHarnessCompactionCapability & AgentHarnessRuntimeArtifactCapability & AgentHarnessAuthBindingCapability & AgentHarnessProviderUsageCapability & AgentHarnessModelCatalogCapability & AgentHarnessMcpCatalogCapability & AgentHarnessSessionForkCapability & AgentHarnessSessionLifecycleCapability;
/**
* @deprecated Implement AgentHarnessV2. This registration contract remains
* source-compatible for existing plugins through 2026-10-12.
*/
type AgentHarness = AgentHarnessRunCapability & AgentHarnessSideQuestionCapability & AgentHarnessClassificationCapability & AgentHarnessSharedCapabilities;
/** Current harness contract for hosts that always supply versioned capabilities. */
type AgentHarnessV2 = AgentHarnessRunCapability<AgentHarnessAttemptParamsV2> & AgentHarnessSideQuestionCapability<AgentHarnessSideQuestionParamsV2> & AgentHarnessClassificationCapability<AgentHarnessAttemptParamsV2> & AgentHarnessSharedCapabilities;
//#endregion
//#region src/plugins/plugin-config-schema.types.d.ts
type PluginConfigValidation = {
ok: true;
value?: unknown;
} | {
ok: false;
errors: string[];
};
/**
* Config schema contract accepted by plugin manifests and runtime registration.
*
* Plugins can provide a Zod-like parser, a lightweight `validate(...)`
* function, or both. `jsonSchema` is optional runtime schema metadata.
*/
type OpenClawPluginConfigSchema = {
safeParse?: (value: unknown) => {
success: boolean;
data?: unknown;
error?: {
issues?: Array<{
path: Array<string | number>;
message: string;
}>;
};
};
parse?: (value: unknown) => unknown;
validate?: (value: unknown) => PluginConfigValidation;
/**
* @deprecated Declare config presentation metadata in the plugin's
* `openclaw.plugin.json` manifest via top-level `uiHints`. The host reads
* manifest hints and does not consume runtime config-schema hints.
*/
uiHints?: Record<string, PluginConfigUiHint>;
jsonSchema?: JsonSchemaObject;
};
//#endregion
//#region src/plugins/plugin-definition.types.d.ts
/** Module-level plugin definition loaded from a native plugin entry file. */
type OpenClawPluginDefinition = {
id?: string;
name?: string;
description?: string;
version?: string;
/**
* @deprecated Declare exclusive plugin kind in `openclaw.plugin.json` via
* manifest `kind`. Runtime-exported `kind` is kept as a compatibility
* fallback for older plugins and may require loading plugin runtime on
* metadata-only command paths.
*/
kind?: PluginKind | PluginKind[];
configSchema?: OpenClawPluginConfigSchema;
reload?: OpenClawPluginReloadRegistration$1;
nodeHostCommands?: OpenClawPluginNodeHostCommand[];
securityAuditCollectors?: OpenClawPluginSecurityAuditCollector$1[];
register?: (api: OpenClawPluginApi) => void;
};
//#endregion
//#region src/decisions/provider-host.d.ts
type Options = Parameters<DecisionRuntimeV1["evaluate"]>[1];
/** Provider-owned admission and health. */
declare class DecisionProviderHost {
readonly provider: DecisionProviderV1;
readonly record: PluginRecord;
private retired;
private reloadPause?;
private health?;
private readonly pending;
private readonly reasons;
private successCount;
private totalLatencyMs;
private inputTokens;
private outputTokens;
constructor(provider: DecisionProviderV1, record: PluginRecord);
private generation;
unavailable(reason: UnavailableReason): DecisionOutcome;
/** Close only capability admission before reversible native reload preparation. */
pauseForReload(changedConsumerIds?: ReadonlySet<string>): {
settled: Promise<void[]>;
assertResumable: () => void;
resume: () => void;
};
/** Native service stop/disposal is irreversible; rollback must not reopen it. */
retire(): void;
cancelConsumer(pluginId: string): void;
stop(): Promise<void>;
private ready;
inspect(config: OpenClawConfig): {
providerId: string;
pluginId: string;
configured: boolean;
credentialReady: boolean;
callable: boolean;
runtimeGeneration: string;
recentSuccessAt: number | undefined;
activeRequests: number;
successCount: number;
totalLatencyMs: number;
usage: {
inputTokens: number;
outputTokens: number;
};
reasons: {
authentication?: number | undefined;
"circuit-open"?: number | undefined;
"credentials-unavailable"?: number | undefined;
deadline?: number | undefined;
disabled?: number | undefined;
"invalid-response"?: number | undefined;
"not-configured"?: number | undefined;
overloaded?: number | undefined;
"rate-limited"?: number | undefined;
retiring?: number | undefined;
transport?: number | undefined;
"unsupported-input"?: number | undefined;
};
};
evaluate(submitted: DecisionBatch, options: Options, model: string, config: OpenClawConfig, registry: PluginRegistry, consumerId?: string): Promise<DecisionOutcome>;
private evaluateRequest;
private fail;
}
//#endregion
//#region src/plugins/registry-types.d.ts
type ChannelPlugin = ChannelPlugin$3;
type CliBackendPlugin = CliBackendPlugin$1;
type ImageGenerationProviderPlugin = ImageGenerationProviderPlugin$1;
type MediaUnderstandingProviderPlugin = MediaUnderstandingProviderPlugin$1;
type TranscriptSourceProvider = TranscriptSourceProvider$1;
type MusicGenerationProviderPlugin = MusicGenerationProviderPlugin$1;
type OpenClawPluginCliRootCommandDescriptor = OpenClawPluginCliRootCommandDescriptor$1;
type OpenClawPluginCliRegistrar = OpenClawPluginCliRegistrar$1;
type OpenClawPluginCommandDefinition = OpenClawPluginCommandDefinition$1;
type PluginInteractiveHandlerRegistration = PluginInteractiveHandlerRegistration$1;
type OpenClawGatewayDiscoveryService = OpenClawGatewayDiscoveryService$1;
type OpenClawPluginHttpRouteHandler = OpenClawPluginHttpRouteHandler$1;
type OpenClawPluginHttpRouteMatch = OpenClawPluginHttpRouteMatch$1;
type OpenClawPluginHostedMediaResolver = OpenClawPluginHostedMediaResolver$1;
type OpenClawPluginReloadRegistration = OpenClawPluginReloadRegistration$1;
type OpenClawPluginSecurityAuditCollector = OpenClawPluginSecurityAuditCollector$1;
type OpenClawPluginService = OpenClawPluginService$1;
type OpenClawPluginToolFactory = OpenClawPluginToolFactory$1;
type PluginConversationBindingResolvedEvent = PluginConversationBindingResolvedEvent$1;
type TypedPluginHookRegistration = PluginHookRegistration$1;
type PluginLogger = PluginLogger$1;
type PluginOrigin = PluginOrigin$1;
type PluginTextTransformRegistration = PluginTextTransformRegistration$1;
type MigrationProviderPlugin = MigrationProviderPlugin$1;
type RealtimeTranscriptionProviderPlugin = RealtimeTranscriptionProviderPlugin$1;
type RealtimeVoiceProviderPlugin = RealtimeVoiceProviderPlugin$1;
type SpeechProviderPlugin = SpeechProviderPlugin$1;
type VideoGenerationProviderPlugin = VideoGenerationProviderPlugin$1;
type WebFetchProviderPlugin = WebFetchProviderPlugin$1;
type WebSearchProviderPlugin = WebSearchProviderPlugin$1;
type WorkerProvider = WorkerProvider$1;
type UnifiedModelCatalogProviderPlugin = UnifiedModelCatalogProviderPlugin$1;
/** Registration provenance; this shape carries no execution or resource authority. */
type PluginRegistrationOwner = {
pluginId: string;
pluginName?: string;
source: string;
rootDir?: string;
};
/** Agent tool factory registered by one plugin runtime. */
type PluginToolRegistration = PluginRegistrationOwner & {
factory: OpenClawPluginToolFactory;
/** Explicitly registered required-authority context, never inferred from plugin identity. */
contextVersion?: 2;
names: string[];
declaredNames?: ReadonlySet<string>;
optional: boolean;
/** Loader-owned provenance. Missing values are conservative legacy registrations. */
origin?: PluginOrigin;
};
type PluginCliRegistration = PluginRegistrationOwner & {
register: OpenClawPluginCliRegistrar;
parentPath: string[];
commands: string[];
descriptors: OpenClawPluginCliRootCommandDescriptor[];
};
/** Gateway HTTP route registered by a plugin runtime. */
type PluginHttpRouteRegistration = {
/** Retired ingress awaiting a lifecycle replacement; responds with Retry-After. */
handoff?: true;
/** Compatibility endpoints retained by live holders or route handoffs. */
legacyListeners?: readonly {
port: number;
host?: string;
/** Shipped listener-liveness response: exact raw path, status 200, body "ok". */
health?: {
path: string;
contentType?: string;
};
/** Shipped Node HTTP deadlines in milliseconds; omission keeps Node defaults. */
timeouts?: {
headers: number;
request: number;
socket: number;
};
}[];
/** Endpoints retained only by a handoff, without a live holder. */
legacyListenerHandoffs?: PluginHttpRouteRegistration["legacyListeners"];
pluginId?: string;
path: string;
handler: OpenClawPluginHttpRouteHandler;
handleUpgrade?: OpenClawPluginHttpRouteUpgradeHandler;
auth: OpenClawPluginHttpRouteAuth;
match: OpenClawPluginHttpRouteMatch;
gatewayRuntimeScopeSurface?: OpenClawPluginGatewayRuntimeScopeSurface;
gatewayMethodDispatchAllowed?: boolean;
nodeCapability?: {
surface: string;
ttlMs?: number;
};
source?: string;
};
type PluginHostedMediaResolverRegistration = PluginRegistrationOwner & {
resolver: OpenClawPluginHostedMediaResolver;
};
type PluginChannelRegistration = PluginRegistrationOwner & {
plugin: ChannelPlugin;
/** Prepared views retain the exact transport donor in addition to their local admission. */
borrowedRuntimeRecord?: PluginRecord;
/** Exact record-bound runtime resolver captured when the active plugin registered the channel. */
resolveChannelRuntime?: () => PluginRuntime["channel"];
/** Loader-owned provenance. Missing values are conservative legacy registrations. */
origin?: PluginOrigin;
/** Host-owned capture of the exact verified official channel registration. */
captureReadAuthority?: () => (() => boolean) | undefined;
};
type PluginChannelSetupRegistration = PluginRegistrationOwner & {
plugin: ChannelPlugin;
/** Loader-owned provenance. Missing values are conservative legacy registrations. */
origin?: PluginOrigin;
enabled: boolean;
};
type PluginDashboardDataBindingRegistration = PluginManifestDashboardDataBinding & {
pluginId: string;
capabilityId: string;
handler: GatewayRequestHandlers[string];
};
type PluginDashboardActionVerbRegistration = PluginManifestDashboardActionVerb & {
pluginId: string;
capabilityId: string;
handler: GatewayRequestHandlers[string];
};
type PluginBoardWidgetContentKindRegistration = {
pluginId: string;
pluginKind: string;
definition: PluginBoardWidgetContentKind;
};
type PluginCliBackendRegistration = PluginRegistrationOwner & {
builtWithOpenClawVersion?: string;
backend: CliBackendPlugin;
};
type PluginTextTransformsRegistration = PluginRegistrationOwner & {
transforms: PluginTextTransformRegistration;
};
type PluginOwnedProviderRegistration<T> = PluginRegistrationOwner & {
provider: T;
};
type PluginCodexAppServerExtensionFactoryRegistration = PluginRegistrationOwner & {
rawFactory: CodexAppServerExtensionFactory;
factory: CodexAppServerExtensionFactory;
};
type PluginAgentToolResultMiddlewareRegistration = PluginRegistrationOwner & {
rawHandler: AgentToolResultMiddleware;
handler: AgentToolResultMiddleware;
runtimes: AgentToolResultMiddlewareRuntime[];
scopes?: AgentToolResultMiddlewareScope[];
};
type PluginAgentToolResultMiddlewareOwner = {
pluginId: string;
runtimes: AgentToolResultMiddlewareRuntime[];
manifest: PluginManifestRecord;
};
type PluginAgentHarnessRegistration = PluginRegistrationOwner & {
harness: AgentHarness;
nativeCompaction?: AgentHarnessNativeCompaction;
};
type PluginHookRegistration = {
pluginId: string;
entry: HookEntry;
events: string[];
source: string;
rootDir?: string;
};
type PluginServiceRegistration = PluginRegistrationOwner & {
readonly id: string;
service: OpenClawPluginService;
origin: PluginOrigin;
trustedOfficialInstall?: boolean;
};
type PluginGatewayDiscoveryServiceRegistration = PluginRegistrationOwner & {
readonly id: string;
service: OpenClawGatewayDiscoveryService;
instance?: PluginInstanceExecution;
};
type PluginReloadRegistration = PluginRegistrationOwner & {
registration: OpenClawPluginReloadRegistration;
};
type PluginNodeHostCommandRegistration = PluginRegistrationOwner & {
command: OpenClawPluginNodeHostCommand;
};
type PluginNodeInvokePolicyRegistration = PluginRegistrationOwner & {
policy: OpenClawPluginNodeInvokePolicy;
pluginConfig?: Record<string, unknown>;
};
type PluginGatewayAccessPolicyRegistration = PluginRegistrationOwner & {
policy: PluginGatewayAccessPolicy;
};
type PluginWidgetPresenterRegistration = PluginRegistrationOwner & {
presenter: WidgetPresenter;
};
type PluginSecurityAuditCollectorRegistration = PluginRegistrationOwner & {
collector: OpenClawPluginSecurityAuditCollector;
};
type PluginCommandRegistration = PluginRegistrationOwner & {
command: OpenClawPluginCommandDefinition;
trustedOwnerStatusExposure?: true;
};
type PluginLegacyInternalHookRegistration = {
pluginId: string;
name: string;
event: string;
handler: InternalHookHandler;
};
type PluginSessionDiscussionRegistration = {
pluginId: string;
provider: SessionDiscussionProvider;
};
type PluginInteractiveHandlerRegistryRegistration = PluginInteractiveHandlerRegistration & {
pluginId: string;
pluginName?: string;
pluginRoot?: string;
};
type PluginSessionExtensionRegistryRegistration = PluginRegistrationOwner & {
extension: PluginSessionExtensionRegistration;
};
type PluginTrustedToolPolicyRegistryRegistration = PluginRegistrationOwner & {
policy: PluginTrustedToolPolicyRegistration;
origin?: PluginRecord["origin"];
};
type PluginToolMetadataRegistryRegistration = PluginRegistrationOwner & {
metadata: PluginToolMetadataRegistration;
};
type PluginControlUiDescriptorRegistryRegistration = PluginRegistrationOwner & {
descriptor: PluginControlUiDescriptor;
};
type PluginRuntimeLifecycleRegistryRegistration = PluginRegistrationOwner & {
lifecycle: PluginRuntimeLifecycleRegistration;
};
type PluginAgentEventSubscriptionRegistryRegistration = PluginRegistrationOwner & {
subscription: PluginAgentEventSubscriptionRegistration;
};
type PluginSessionSchedulerJobRegistryRegistration = PluginRegistrationOwner & {
job: PluginSessionSchedulerJobRegistration;
generation?: number;
};
type PluginSessionActionRegistryRegistration = PluginRegistrationOwner & {
action: PluginSessionActionRegistration;
};
type PluginConversationBindingResolvedHandlerRegistration = PluginRegistrationOwner & {
pluginRoot?: string;
handler: (event: PluginConversationBindingResolvedEvent) => void | Promise<void>;
};
type PluginRecord = {
id: string;
nativeSessionCatalog?: PluginManifestNativeSessionCatalogSetup;
name: string;
packageVersion?: string;
version?: string;
builtWithOpenClawVersion?: string;
packageName?: string;
description?: string;
format?: PluginFormat;
bundleFormat?: PluginBundleFormat;
bundleCapabilities?: string[];
kind?: PluginKind | PluginKind[];
source: string;
rootDir?: string;
origin: PluginOrigin;
workspaceDir?: string;
trustedOfficialInstall?: boolean;
trust?: PluginTrust;
enabled: boolean;
explicitlyEnabled?: boolean;
activated?: boolean;
imported?: boolean;
/** Families authoritatively supplied by a descriptor entry, including empty collections. */
capabilityCatalog?: Array<keyof PluginCapabilityCatalog>;
compat?: readonly PluginCompatCode[];
activationSource?: PluginActivationSource;
activationReason?: string;
status: "loaded" | "disabled" | "error";
error?: string;
failedAt?: Date;
failurePhase?: "validation" | "load" | "register";
toolNames: string[];
hookNames: string[];
channelIds: string[];
cliBackendIds: string[];
providerIds: string[];
syntheticAuthRefs?: string[];
embeddingProviderIds: string[];
speechProviderIds: string[];
realtimeTranscriptionProviderIds: string[];
realtimeVoiceProviderIds: string[];
mediaUnderstandingProviderIds: string[];
transcriptSourceProviderIds: string[];
imageGenerationProviderIds: string[];
videoGenerationProviderIds: string[];
musicGenerationProviderIds: string[];
webFetchProviderIds: string[];
webSearchProviderIds: string[];
migrationProviderIds: string[];
contextEngineIds?: string[];
agentHarnessIds: string[];
cliCommands: string[];
services: string[];
gatewayDiscoveryServiceIds: string[];
commands: string[];
commandAliases?: PluginManifestRecord["commandAliases"];
httpRoutes: number;
hookCount: number;
configSchema: boolean;
configUiHints?: Record<string, PluginConfigUiHint>;
configJsonSchema?: JsonSchemaObject;
contracts?: PluginManifestContracts;
dashboard?: PluginManifestDashboard;
controlUi?: PluginManifestControlUi;
uiCapabilities?: PluginManifestRecord["uiCapabilities"];
mcpServers?: Record<string, PluginManifestMcpServer>;
memorySlotSelected?: boolean;
dependencyStatus?: PluginDependencyStatus;
};
type PluginRegistry = {
plugins: PluginRecord[];
tools: PluginToolRegistration[];
hooks: PluginHookRegistration[];
typedHooks: TypedPluginHookRegistration[];
channels: PluginChannelRegistration[];
channelSetups: PluginChannelSetupRegistration[];
providers: PluginProviderRegistration[];
modelCatalogProviders: PluginOwnedProviderRegistration<UnifiedModelCatalogProviderPlugin>[];
sessionCatalogs: PluginOwnedProviderRegistration<SessionCatalogProvider>[];
cliBackends: PluginCliBackendRegistration[];
textTransforms: PluginTextTransformsRegistration[];
embeddingProviders: PluginOwnedProviderRegistration<EmbeddingProviderAdapter>[];
speechProviders: PluginOwnedProviderRegistration<SpeechProviderPlugin>[];
realtimeTranscriptionProviders: PluginOwnedProviderRegistration<RealtimeTranscriptionProviderPlugin>[];
realtimeVoiceProviders: PluginOwnedProviderRegistration<RealtimeVoiceProviderPlugin>[];
mediaUnderstandingProviders: PluginOwnedProviderRegistration<MediaUnderstandingProviderPlugin>[];
transcriptSourceProviders: PluginOwnedProviderRegistration<TranscriptSourceProvider>[];
imageGenerationProviders: PluginOwnedProviderRegistration<ImageGenerationProviderPlugin>[];
videoGenerationProviders: PluginOwnedProviderRegistration<VideoGenerationProviderPlugin>[];
musicGenerationProviders: PluginOwnedProviderRegistration<MusicGenerationProviderPlugin>[];
webFetchProviders: PluginOwnedProviderRegistration<WebFetchProviderPlugin>[];
webSearchProviders: PluginOwnedProviderRegistration<WebSearchProviderPlugin>[];
workerProviders: Map<string, PluginOwnedProviderRegistration<WorkerProvider>>;
migrationProviders: PluginOwnedProviderRegistration<MigrationProviderPlugin>[];
codexAppServerExtensionFactories: PluginCodexAppServerExtensionFactoryRegistration[];
agentToolResultMiddlewareOwners: PluginAgentToolResultMiddlewareOwner[];
agentToolResultMiddlewares: PluginAgentToolResultMiddlewareRegistration[];
agentHarnesses: PluginAgentHarnessRegistration[];
pluginRuntimeArtifacts: Map<string, ResolvedPluginRuntimeArtifact>;
compactionProviders: RegisteredCompactionProvider[];
decisionProviders: Array<{
pluginId: string;
host: DecisionProviderHost;
}>;
legacyInternalHooks: PluginLegacyInternalHookRegistration[];
memoryCapabilities: MemoryPluginCapabilityRegistration[];
memoryCorpusSupplements: MemoryCorpusSupplementRegistration[];
memoryPromptPreparations: MemoryPromptPreparationRegistration[];
memoryPromptSupplements: MemoryPromptSupplementRegistration[];
sessionDiscussionProviders: Map<string, PluginSessionDiscussionRegistration>;
contextEngines: Map<string, ContextEngineRegistration>;
gatewayHandlers: GatewayRequestHandlers;
gatewayMethodDescriptors: GatewayMethodDescriptor[];
dashboardDataBindings: Map<string, PluginDashboardDataBindingRegistration>;
dashboardActionVerbs: Map<string, PluginDashboardActionVerbRegistration>;
boardWidgetContentKinds: Map<string, PluginBoardWidgetContentKindRegistration>;
coreGatewayMethodNames: string[];
httpRoutes: PluginHttpRouteRegistration[];
hostedMediaResolvers: PluginHostedMediaResolverRegistration[];
widgetPresenters: PluginWidgetPresenterRegistration[];
mcpServerConnectionResolvers: PluginMcpServerConnectionResolverRegistration[];
cliRegistrars: PluginCliRegistration[];
reloads: PluginReloadRegistration[];
nodeHostCommands: PluginNodeHostCommandRegistration[];
nodeInvokePolicies: PluginNodeInvokePolicyRegistration[];
gatewayAccessPolicies: PluginGatewayAccessPolicyRegistration[];
securityAuditCollectors: PluginSecurityAuditCollectorRegistration[];
services: PluginServiceRegistration[];
gatewayDiscoveryServices: PluginGatewayDiscoveryServiceRegistration[];
commands: PluginCommandRegistration[];
interactiveHandlers: PluginInteractiveHandlerRegistryRegistration[];
sessionExtensions: PluginSessionExtensionRegistryRegistration[];
trustedToolPolicies: PluginTrustedToolPolicyRegistryRegistration[];
toolMetadata: PluginToolMetadataRegistryRegistration[];
controlUiDescriptors: PluginControlUiDescriptorRegistryRegistration[];
runtimeLifecycles: PluginRuntimeLifecycleRegistryRegistration[];
agentEventSubscriptions: PluginAgentEventSubscriptionRegistryRegistration[];
sessionSchedulerJobs: PluginSessionSchedulerJobRegistryRegistration[];
sessionActions: PluginSessionActionRegistryRegistration[];
conversationBindingResolvedHandlers: PluginConversationBindingResolvedHandlerRegistration[];
diagnostics: PluginDiagnostic[];
};
type PluginRegistryParams = {
logger: PluginLogger;
coreGatewayHandlers?: GatewayRequestHandlers;
coreGatewayMethodNames?: readonly string[];
runtime: PluginRuntime;
/** Synchronous factory binding supplied by loaders or direct registry composition roots. */
resolveCapabilityCatalogContext?: () => PluginCapabilityCatalogHostContext;
/** Process-owner policy for registering catalogs that may fall back to HOME. */
allowProcessHomeSessionCatalogs?: boolean;
hostServices?: {
/** May be a live accessor; plugin APIs must read it at call time. */
cron?: CronServiceContract;
};
activateGlobalSideEffects?: boolean;
};
//#endregion
//#region src/plugins/plugin-instance-scope.d.ts
/** Runtime consumers retain capabilities, never the concrete loader implementation. */
interface PluginInstanceHandle extends PluginInvocationInstance, PluginInstanceExecution {
readonly disposing: boolean;
readonly hasActiveCall: boolean;
readonly acceptingCalls: boolean;
readonly hasRetainedConsumers: boolean;
readonly owner?: PluginInstanceOwner;
toolRegistrationComplete: boolean;
runConsumer<T>(consume: () => T): T;
adopt<T>(value: T): T;
retainWork(): () => void;
readonly retainedWorkCount: number;
waitForRetainedWork(signal: AbortSignal, includeConsumers?: boolean): Promise<void>;
reserveReplacement(): () => void;
retainConsumer(invoke?: <T>(run: () => T) => T, registry?: PluginRegistry, kind?: "work" | "custody"): PluginInstanceConsumer;
runInRegistry<T>(registry: PluginRegistry, run: () => T, options?: {
joinDisposal?: boolean;
}): T;
createRegistryView(registry: PluginRegistry, invoke: <T>(run: () => T) => T): <T>(value: T) => T;
drain(options?: {
includeConsumers?: boolean;
signal?: AbortSignal;
}): Promise<PluginInstanceDisposalResult>;
resume(): void;
}
type PluginInvocationBinding = {
run: <T>(run: () => T) => T;
wrap: <T>(value: T) => T;
};
type PluginInstanceOwner = {
record: PluginRecord;
registry: PluginRegistry;
revoked: boolean;
instance?: PluginInstanceHandle;
};
//#endregion
//#region src/plugin-sdk/agent-core.d.ts
/** Agent-core class preconfigured with OpenClaw runtime dependencies. */
declare class Agent$1 extends Agent$2 {
constructor(options?: AgentOptions);
}
//#endregion
//#region src/gateway/worker-environments/computer-transport.d.ts
type WorkerComputerTransport = Omit<ComputerToolTransport, "invoke"> & {
invoke(request: Parameters<ComputerToolTransport["invoke"]>[0], assertAuthorized?: () => void): Promise<unknown>;
};
type PreparedWorkerComputer = {
descriptor: WorkerComputerLaunchDescriptor;
bind(operationalRunInstance: OperationalRunInstanceRef, workerSource?: {
authority: AgentRunDelegatedAuthority;
assertCurrent: () => void;
}): WorkerComputerTransport;
close(reason: string): Promise<void>;
};
type WorkerEnvironmentComputerAuthority = {
environmentId: string;
ownerEpoch: number;
sessionId: string;
sessionKey: string;
agentId: string;
runId: string;
assertCurrent(): void;
turnClaim?: WorkerSessionTurnClaim;
};
//#endregion
//#region src/gateway/worker-environments/service-contract.d.ts
/** Non-secret worker projection available to Gateway request handlers. */
type WorkerEnvironmentServiceRecord = {
environmentId: string;
providerId: string;
profileId: string;
leaseId: string | null;
nodeDeviceId?: string | null;
sharedHost: boolean | null;
state: WorkerEnvironmentState;
ownerEpoch: number;
createdAtMs: number;
idleSinceAtMs: number | null;
destroyRequestedAtMs: number | null;
attachedSessionIds: readonly string[];
desktopAvailable: boolean;
desktopApps: readonly WorkerDesktopApp["id"][];
tunnelStatus: WorkerTunnelStatus;
preparation?: (WorkerEnvironmentPreparation & {
project?: {
label?: string;
baseCommit: string;
};
}) | null;
error?: string;
};
type WorkerDesktopObserveResult = {
transport: "rfb";
wsPath: string;
expiresAtMs: number;
control: boolean;
/** Provider permission to request resizing, not negotiated RFB support. */
canResize?: boolean;
vncPassword?: string;
};
type WorkerDesktopLaunchResult = {
app: WorkerDesktopApp["id"];
status: "ready";
};
/** Request-facing lifecycle methods, kept separate from persistence and provider internals. */
type WorkerEnvironmentServiceContract = {
/** Current explicit provider attestation, never the persisted legacy default. */
getDedicatedNodeLeaseSignal(environmentId: string): AbortSignal | undefined;
captureSessionAttachment(identity: WorkerEnvironmentSessionIdentity): {
binding: WorkerEnvironmentAttachment;
assertCurrent(): void;
touch(): Promise<void>;
};
getSessionAttachment(sessionId: string): WorkerEnvironmentAttachment | undefined;
findSessionAttachment(identity: Pick<WorkerEnvironmentSessionIdentity, "agentId" | "sessionKey">): WorkerEnvironmentAttachment | undefined;
getSessionAttachmentStatus(sessionId: string): {
attachment: WorkerEnvironmentAttachmentRecord & {
ownerEpoch: number;
};
environment: WorkerEnvironmentServiceRecord;
} | undefined;
assertSessionAttachment(binding: WorkerEnvironmentAttachment): void;
touchSessionAttachment(binding: WorkerEnvironmentAttachment): Promise<void>;
execSessionAttachment(binding: WorkerEnvironmentAttachment, command: WorkerWorkspaceCommand): Promise<NodeWorkerWorkspaceExecResult>;
createSessionAttachment(request: WorkerEnvironmentSessionCreateRequest, authorize: () => void, signal?: AbortSignal, onReserved?: WorkerEnvironmentSessionReservationHandler): Promise<{
attachment: WorkerEnvironmentAttachmentRecord & {
ownerEpoch: number;
};
environment: WorkerEnvironmentServiceRecord;
reused: boolean;
}>;
destroySessionAttachment(request: {
sessionId: string;
environmentId?: string;
}, authorize: () => void): Promise<WorkerEnvironmentServiceRecord | undefined>;
prepareAttachedComputer?: (authority: WorkerEnvironmentComputerAuthority) => Promise<PreparedWorkerComputer | undefined>;
openNodePortal(request: {
environmentId: string;
ownerEpoch: number;
remotePort: number;
}): Promise<{
connect: (assertCurrent?: () => void, touch?: () => Promise<void>) => Promise<import("node:stream").Duplex>;
close: () => Promise<void>;
}>;
list(): WorkerEnvironmentServiceRecord[];
readPreparedPoolSummary(): {
maxTotal: number;
reservedEnvironmentIds: string[];
};
readReadyWorkerTarget(profileId: string): number;
get(environmentId: string): WorkerEnvironmentServiceRecord | undefined;
inventoryVersion(): number;
readMachineShape(environmentId: string, prepared?: WorkerEnvironmentPlacementFacts): SessionPlacementMachine | undefined;
machineShapeVersion(): number;
supportsExecutionMode(profileId: string, mode: WorkerPlacementExecutionMode): boolean;
readProviderDisplayId(profileId: string): string | undefined;
listMachineOptions(profileId: string): Promise<readonly WorkerMachineOption[] | undefined>;
listOperatingSystems(profileId: string): Promise<readonly WorkerOperatingSystem[] | undefined>;
prepare(request: {
profileId: string;
projectPath: string;
}, authorize?: () => void): Promise<{
environmentId: string;
preparationKey: string;
reused: boolean;
}>;
create(profileId: string, idempotencyKey: string, machineClass?: string, executionMode?: WorkerPlacementExecutionMode, projectPath?: string, signal?: AbortSignal, os?: string, runSetupScript?: boolean): Promise<WorkerEnvironmentServiceRecord>;
destroy(environmentId: string): Promise<WorkerEnvironmentServiceRecord>;
destroyUnattached(environmentId: string): Promise<WorkerEnvironmentServiceRecord>;
observeDesktop(request: {
environmentId: string;
control: boolean;
requester?: DesktopObserveRequester;
}): Promise<WorkerDesktopObserveResult>;
launchDesktopApp(request: {
environmentId: string;
app: WorkerDesktopApp["id"];
}): Promise<WorkerDesktopLaunchResult>;
startTunnel(request: WorkerTunnelRequest): Promise<WorkerTunnelHandle>;
stopTunnel(environmentId: string, ownerEpoch?: number): Promise<void>;
};
type WorkerPlacementDispatchRequest = {
sessionId: string;
sessionKey: string;
agentId: string;
profileId: string;
executionMode: WorkerPlacementExecutionMode;
expectedPlacement?: Pick<WorkerSessionPlacementRecord, "state" | "generation" | "environmentId" | "activeOwnerEpoch">;
/** Current dispatch caller's setup authority; never inherited by a new caller. */
runSetupScript?: boolean;
devicePlacement?: DevicePlacementRequirement;
idempotencyKey?: string;
deviceId?: string;
machineClass?: string;
os?: string;
inheritedProfile?: {
providerId: string;
profileSnapshot: WorkerProfile;
};
};
type WorkerPlacementReclaimRequest = {
sessionId: string;
sessionKey: string;
agentId: string;
recoverToGateway?: SessionsReclaimParams["recoverToGateway"];
};
type WorkerPlacementMoveRequest = Pick<WorkerPlacementReclaimRequest, "sessionId" | "sessionKey" | "agentId"> & {
source: WorkerPlacementMoveSource;
target: WorkerPlacementMoveTarget;
abandonSource?: true;
};
/** Closure-bound request authority; in-process only and never part of durable placement intent. */
type WorkerPlacementAuthorization = () => void;
type WorkerPlacementCancellationTarget = Readonly<Pick<WorkerSessionPlacementRecord, "state" | "generation" | "environmentId" | "activeOwnerEpoch">>;
/** Exact source eligibility may follow only transitions published by captured predecessors. */
type WorkerPlacementReclaimSourceCheck = (predecessor?: WorkerPlacementCancellationTarget) => void;
type WorkerPlacementDispatchContract = {
getPendingDeviceDispatchCount?(deviceId: string, excludeSessionId?: string): number;
getAdmittedDeviceSessionCounts?(excludeSessionId?: string): ReadonlyMap<string, number>;
dispatch(request: WorkerPlacementDispatchRequest, onTransition?: (placement: WorkerSessionPlacementRecord) => void, authorize?: WorkerPlacementAuthorization, callerSignal?: AbortSignal): Promise<Extract<WorkerSessionPlacementRecord, {
state: "active";
}>>;
move?(request: WorkerPlacementMoveRequest, onTransition?: (placement: WorkerSessionPlacementRecord) => void, authorize?: WorkerPlacementAuthorization): Promise<Extract<WorkerSessionPlacementRecord, {
state: "local" | "active";
}>>;
reclaim?(request: WorkerPlacementReclaimRequest, authorize?: WorkerPlacementAuthorization, beforeDrain?: WorkerPlacementReclaimSourceCheck): Promise<Extract<WorkerSessionPlacementRecord, {
state: "local" | "reclaimed";
}>>;
forceDestroyEnvironment?(environmentId: string, onCleanupError?: (error: unknown) => void): Promise<WorkerEnvironmentServiceRecord>;
reconcileActive?(environmentId?: string): Promise<void>;
};
//#endregion
//#region src/gateway/worker-environments/session-placement-lifecycle.d.ts
type SessionWorkerPlacementContext = {
workerEnvironmentService?: Pick<WorkerEnvironmentServiceContract, "get">;
workerPlacementDispatchService?: Pick<WorkerPlacementDispatchContract, "reclaim">;
workerSessionPlacementService?: Pick<WorkerSessionPlacementStore, "getMany"> & Partial<Pick<WorkerSessionPlacementStore, "retireSessionPlacement" | "listForReconcile">>;
};
//#endregion
//#region src/auto-reply/reply/abort.d.ts
type FastAbortRequestParams = {
ctx: FinalizedRuntimeMsgContext;
cfg: OpenClawConfig;
isCommandTargetCurrent?: () => boolean;
};
type FastAbortResult = {
handled: boolean;
aborted: boolean;
rejectionReason?: "finalizing";
stoppedSubagents?: number;
failedSubagents?: number;
};
declare function formatAbortReplyText(stoppedSubagents?: number, rejectionReason?: "finalizing", failedSubagents?: number): string;
declare function tryFastAbortFromMessage(params: FastAbortRequestParams): Promise<FastAbortResult>;
//#endregion
//#region src/auto-reply/reply/abort.runtime-types.d.ts
type TryFastAbortFromMessage = typeof tryFastAbortFromMessage;
type FormatAbortReplyText = typeof formatAbortReplyText;
//#endregion
//#region src/auto-reply/reply/command-session-metadata.d.ts
type CommandSessionMetadataChange = {
sessionKey: string;
agentId?: string;
reason: "command-metadata";
};
//#endregion
//#region src/media-understanding/extracted-file-images.d.ts
type ExtractedFileImage = ImageContent$1 & {
attachmentIndex: number;
};
//#endregion
//#region src/auto-reply/reply/prompt-session-context.d.ts
type ReplyConversationFields = Pick<TemplateContext, "Provider" | "Surface" | "ChatType" | "OriginatingChannel" | "OriginatingTo" | "AccountId" | "MessageThreadId" | "GroupSubject" | "GroupChannel" | "GroupSpace">;
type PreparedReplyConversation = {
fields: ReplyConversationFields;
group: {
channel?: string;
groupId?: string;
groupChannel?: string;
groupSpace?: string;
accountId?: string;
};
activation?: SessionEntry$1["groupActivation"];
};
//#endregion
//#region src/agents/bash-tools.process.d.ts
/** Defaults injected by tests, agent scopes, and scoped process registries. */
type ProcessToolDefaults = {
hasCronTool?: boolean;
inputWaitIdleMs?: number;
scopeKey?: string;
};
//#endregion
//#region src/auto-reply/reply/agent-runner-execution-status.d.ts
/** Projects closed execution independently of later reply delivery. */
declare function resolveAgentTurnExecutionStatus(outcome?: {
kind: "aborted" | "rejected";
} | {
kind: "settled";
status: "ok" | "failed";
}): "cancelled" | "failed" | "ok";
//#endregion
//#region src/auto-reply/reply/reply-operation-run-state.d.ts
type ReplyOperationAdmissionSnapshot = {
status: "owned";
} | {
status: "accepted";
mode: "steer" | "followup";
} | {
status: "skipped";
reason: "active-run" | "aborted" | "lifecycle-invalidated" | "queue-cap" | "question-response-indeterminate" | "question-response-refused" | "question-response-rejected";
};
type ReplyPreRunRejectionCode = "model-scope-conflict" | "model-scope-not-authorized" | "model-selection-locked" | "model-runtime-invalid" | "model-selection-rejected" | "model-selection-conflict" | "session-directive-rejected";
type ReplyOperationRunState = {
replyCompletion?: ReplyCompletion;
heartbeat?: {
prepareReply: (replyResult: ReplyPayload | ReplyPayload[] | undefined, runState: ReplyOperationRunState) => Promise<{
reply?: ReplyPayload;
settle?: (outcome: ReplyDispatchDeliveryOutcome) => Promise<void>;
}>;
};
admission?: ReplyOperationAdmissionSnapshot;
/** The Gateway accepted this question answer or rejected its values before commitment. */
questionInputHandled?: true;
messageInjectionAborted?: true;
agentTurn?: ReturnType<typeof resolveAgentTurnExecutionStatus>;
agentTurnOwner?: ReplyOperation;
messagingToolSentTargets?: MessagingToolSend[];
backgroundWorkStarted?: boolean;
preRunRejection?: ReplyPreRunRejectionCode;
};
declare const REPLY_OPERATION_RUN_STATE: unique symbol;
type ReplyOptionsWithOperationRunState = {
[REPLY_OPERATION_RUN_STATE]?: ReplyOperationRunState;
};
//#endregion
//#region src/auto-reply/reply/queue/types.d.ts
type FollowupQueueDisposition = "queue-cap" | "queue-cap-old" | "queue-cap-new";
type QueuedFollowupReplyBatch = {
kind: "queued-followup";
runId: string;
originatingChannel: string | undefined;
payloads: ReplyPayload[];
completion: {
kind: "progress";
} | {
kind: "completed";
stopReason?: string;
allowCanvasOnly?: true;
} | {
kind: "failed";
error: string;
stopReason?: string;
errorKind?: "timeout";
} | {
kind: "aborted";
stopReason?: string;
};
};
type QueuedFollowupReplyDelivery = ((batch: QueuedFollowupReplyBatch) => Promise<void> | void) & {
ownsCompletion?: (originatingChannel: string | undefined) => boolean;
createSourceRetry?: () => QueuedFollowupReplyDelivery;
};
//#endregion
//#region src/shared/keyed-fifo-lease.d.ts
type KeyedFifoLease = {
wait(signal?: AbortSignal): Promise<boolean>;
release(): void;
};
//#endregion
//#region src/auto-reply/reply/reply-admission-ticket.d.ts
declare const REPLY_ADMISSION_TICKET: unique symbol;
type ReplyAdmissionTicket = KeyedFifoLease;
type ReplyOptionsWithAdmissionTicket = {
[REPLY_ADMISSION_TICKET]?: ReplyAdmissionTicket;
};
//#endregion
//#region src/auto-reply/reply/get-reply.types.d.ts
type ReplySessionBinding = {
sessionKey?: string;
sessionId: string;
lifecycleRevision?: string;
storePath?: string;
};
type PendingContinuationSettlement = {
settle: (statusDelivered: boolean) => Promise<void>;
};
type ReplyRunVerbosity = {
verboseLevelOverride?: VerboseLevel;
resolvedVerboseLevel: VerboseLevel;
};
type InternalReplySessionOptions = {
/** Host-minted original operator authority; never restored from session metadata. */
operatorAuthority?: AdmittedRunOperatorAuthority;
extractedFileImages?: ExtractedFileImage[];
/** Rechecks the live Gateway caller before a chat login has a durable effect. */
assertProviderLoginAuthority?: () => void;
getProviderLoginConfig?: () => OpenClawConfig;
/** Invocation-owned conversation facts; never execution or sender authority. */
replyConversation?: PreparedReplyConversation;
prepareAssistantTranscriptMessage?: PrepareAssistantTranscriptMessage;
/** Internal delivery owner that stages reply media using current Gateway session policy. */
mediaNormalizationOwner?: "gateway";
/** Exact authority-bearing settings captured by Gateway chat admission. */
admittedSessionSettings?: Readonly<Pick<SessionEntry$1, "permissionMode" | "toolOverrides">>;
/** Host-stamped exact-run capability for late Codex creator-authority capture. */
cronCreatorAuthorityCapability?: CronCreatorAuthorityCapability;
/** Current external dashboard turn only; never persisted or inherited by another run. */
dashboardReadAdmission?: DashboardMessageReadAdmission;
expectedExistingSessionId?: string;
/** Retained predecessor evidence; reply admission must verify its session lineage and store. */
expectedActiveReplyOperation?: ReplyOperation;
/** First dispatch only: admission created this exact pinned session before reply initialization. */
newlyCreatedSessionId?: string;
onDeliberateSilentTerminalReply?: () => void;
/** Source-specific final delivery, e.g. a committed answer in the current WebChat history. */
resolveReplyDelivery?: ReplyDeliveryObserver;
/** Retire the run's bundle MCP runtime at settlement. Set by one-shot isolated runs (isolated heartbeats) whose session ID is never reused. */
cleanupBundleMcpOnRunEnd?: boolean;
/** Defers the child-completion wake until the visible waiting status is delivered. */
onPendingContinuation?: (settlement?: PendingContinuationSettlement) => void;
onSessionPrepared?: (binding: ReplySessionBinding) => void;
onSessionMetadataChanges?: (changes: CommandSessionMetadataChange[]) => void;
/** Publishes each executing turn's preferences without persisting them to its session. */
onRunVerbosityResolved?: (settings: ReplyRunVerbosity) => void;
/** Prevent implicit rollover after a caller has durably admitted this exact session. */
pinExpectedExistingSession?: boolean;
requestedSessionId?: string;
resumeRequestedSession?: boolean;
sessionPromptSourceReplyDeliveryMode?: GetReplyOptions["sourceReplyDeliveryMode"];
/** Receives terminal queue-cap outcomes without widening the public reply API. */
onFollowupQueueDisposition?: (disposition: FollowupQueueDisposition) => void;
/** Delivers queued replies only through their originating Gateway admission. */
onQueuedFollowupReplyBatch?: QueuedFollowupReplyDelivery;
/** Overrides persisted queue mode for this reply only. */
queueModeOverride?: QueueMode$1;
/** Dispatch-owned operation used to defer hooks until durable run admission. */
replyOperation?: ReplyOperation;
skillOverrides?: SessionToolOverrides["skills"];
/** Gateway-private optimistic-concurrency constraint for an operator-requested proposal revision. */
skillWorkshopProposalRevision?: SkillWorkshopProposalRevisionConstraint;
skillLibraryAuthoring?: SkillLibraryAuthoringCapability;
};
type InternalGetReplyOptions = GetReplyOptions & PluginCommandReplyOptions & InternalReplySessionOptions & ReplyOptionsWithOperationRunState & ReplyOptionsWithAdmissionTicket;
/** Reply resolver signature used by dispatchers and tests for dependency injection. */
type GetReplyFromConfig = (ctx: MsgContext, opts?: GetReplyOptions, configOverride?: OpenClawConfig) => Promise<ReplyPayload | ReplyPayload[] | undefined>;
type InternalGetReplyFromConfig = (ctx: MsgContext, opts?: InternalGetReplyOptions, configOverride?: OpenClawConfig) => Promise<ReplyPayload | ReplyPayload[] | undefined>;
//#endregion
//#region src/auto-reply/reply/dispatch-from-config.types.d.ts
type DispatchFromConfigResult = {
queuedFinal: boolean;
counts: Record<ReplyDispatchKind, number>;
failedCounts?: Partial<Record<ReplyDispatchKind, number>>;
settledReceipt?: ReplyDispatchReceipt;
sourceReplyDeliveryMode?: SourceReplyDeliveryMode;
sendPolicyDenied?: boolean;
observedReplyDelivery?: boolean;
deferredToActiveRun?: "steer" | "followup";
noVisibleReplyFallbackEligible?: boolean;
noVisibleReplyFallbackDelivered?: boolean;
deliberateSilentTerminalReply?: true;
beforeAgentRunBlocked?: boolean;
sessionMetadataChanges?: CommandSessionMetadataChange[];
};
type DispatchFromConfigParams = {
ctx: FinalizedMsgContext;
/** Full runtime config captured by the channel; reply resolution refreshes it per turn. */
cfg: OpenClawConfig;
dispatcher: ReplyDispatcher;
replyOptions?: Omit<InternalGetReplyOptions, "onBlockReply" | "onPreparedBlockReply">;
replyResolver?: InternalGetReplyFromConfig;
onSessionMetadataChanges?: (changes: CommandSessionMetadataChange[]) => void;
fastAbortResolver?: TryFastAbortFromMessage;
formatAbortReplyTextResolver?: FormatAbortReplyText;
/** Optional patch applied to the current runtime config before reply resolution. */
configOverride?: OpenClawConfig;
/** Gateway-owned worker services for archive recovery outside a request scope. */
sessionWorkerPlacementContext?: SessionWorkerPlacementContext;
/** @deprecated Always enabled in the Gateway; remove in the next Plugin SDK major. */
usePublishedModelRuntime?: boolean;
};
type DispatchReplyFromConfig = (params: DispatchFromConfigParams) => Promise<DispatchFromConfigResult>;
//#endregion
//#region src/channels/typing.d.ts
type TypingCallbacks = {
onReplyStart: () => Promise<void>;
onIdle?: () => void;
/** Called when the typing controller is cleaned up (e.g. on NO_REPLY). */
onCleanup?: () => void;
};
type CreateTypingCallbacksParams = {
start: () => Promise<void>;
stop?: () => Promise<void>;
onStartError: (err: unknown) => void;
onStopError?: (err: unknown) => void;
keepaliveIntervalMs?: number;
/** Stop keepalive after this many consecutive start() failures. Default: 2 */
maxConsecutiveFailures?: number;
/** Maximum duration for typing indicator before auto-cleanup (safety TTL). Default: 60s */
maxDurationMs?: number;
};
declare function createTypingCallbacks(params: CreateTypingCallbacksParams): TypingCallbacks;
//#endregion
//#region src/auto-reply/reply/response-prefix-template.d.ts
type ResponsePrefixContext = {
/** Short model name (e.g., "gpt-5.4", "claude-opus-4-6") */
model?: string;
/** Full model ID including provider. */
modelFull?: string;
/** Provider name (e.g., "openai", "anthropic") */
provider?: string;
/** Current thinking level (e.g., "high", "low", "off") */
thinkingLevel?: string;
/** Agent identity name */
identityName?: string;
};
//#endregion
//#region src/auto-reply/reply/reply-dispatcher.d.ts
type ReplyDispatchErrorHandler = (err: unknown, info: ReplyDispatchRuntimeInfo) => Promise<void> | void;
type ReplyDispatchSkipHandler = (payload: ReplyPayload, info: ReplyDispatchRuntimeInfo & {
reason: NormalizeReplySkipReason;
}) => void;
type ReplyDispatchCancelHandler = (payload: ReplyPayload, info: ReplyDispatchRuntimeInfo) => Promise<void> | void;
type ReplyDispatchDeliverer = (payload: ReplyPayload, info: ReplyDispatchRuntimeInfo) => Promise<unknown>;
type ReplyDispatcherOptions = {
deliver: ReplyDispatchDeliverer;
/**
* Receives a fresh plan after normalization and modifiers. When omitted, prepared
* sends fall back to deliver(payload, info), retaining that adapter's raw contract.
*/
deliverPrepared?: (plan: OutboundPayloadPlan, info: ReplyDispatchRuntimeInfo) => Promise<unknown>;
silentReplyContext?: {
cfg?: OpenClawConfig;
sessionKey?: string;
surface?: string;
conversationType?: SilentReplyConversationType;
};
responsePrefix?: string;
transformReplyPayload?: (payload: ReplyPayload) => ReplyPayload | null;
/** Static context for response prefix template interpolation. */
responsePrefixContext?: ResponsePrefixContext;
/** Dynamic context provider for response prefix template interpolation.
* Called at normalization time, after model selection is complete. */
responsePrefixContextProvider?: () => ResponsePrefixContext;
onHeartbeatStrip?: () => void;
onIdle?: () => Promise<void> | void;
onError?: ReplyDispatchErrorHandler;
/** Let ingress retry proven-unsent work only when outbound recovery holds no delivery. */
propagateRetryableNoSendFailure?: boolean;
onSkip?: ReplyDispatchSkipHandler;
/** Human-like delay between block replies for natural rhythm. */
humanDelay?: HumanDelayConfig;
beforeDeliver?: ReplyDispatchBeforeDeliver;
/** Owner-declared deadline for the constructor before-delivery callback. */
beforeDeliverOptions?: ReplyDispatchBeforeDeliverOptions;
onBeforeDeliverCancelled?: ReplyDispatchCancelHandler;
/** Observe each queued payload settling, including cancellation and delivery failure. */
onDeliverySettled?: (info: ReplyDispatchRuntimeInfo) => void;
/** Resolve an owner activity policy for holding queued follow-ups behind delivery. */
resolveFollowupAdmissionBarrierTimeoutPolicy?: (context: {
queuedCounts: Readonly<Record<ReplyDispatchKind, number>>;
humanDelayBudgetMs: number;
}) => ReplyFollowupAdmissionBarrierTimeoutPolicy | undefined;
};
type ReplyDispatcherWithTypingOptions = Omit<ReplyDispatcherOptions, "onIdle"> & {
typingCallbacks?: TypingCallbacks;
onReplyStart?: () => Promise<void> | void;
onIdle?: () => Promise<void> | void;
onSettled?: () => unknown;
onFreshSettledDelivery?: () => unknown;
/** Called when the typing controller is cleaned up (e.g., on NO_REPLY). */
onCleanup?: () => void;
};
type ReplyDispatcherWithTypingResult = {
dispatcher: ReturnType<typeof createReplyDispatcher>;
replyOptions: Pick<GetReplyOptions, "onReplyStart" | "onTypingController" | "onTypingCleanup">;
markDispatchIdle: () => void;
/** Signal that the model run is complete so the typing controller can stop. */
markRunComplete: () => void;
};
declare function createReplyDispatcher(options: ReplyDispatcherOptions): ReplyDispatcher & Required<Pick<ReplyDispatcher, "sendPreparedReply">>;
declare function createReplyDispatcherWithTyping(options: ReplyDispatcherWithTypingOptions): ReplyDispatcherWithTypingResult;
//#endregion
//#region src/auto-reply/reply/provider-dispatcher.types.d.ts
type DispatchReplyContext = MsgContext | FinalizedMsgContext;
type DispatchReplyOptions = Omit<GetReplyOptions, "onBlockReply" | "onPreparedBlockReply"> & PluginCommandReplyOptions;
/** Buffered block dispatcher entry point used by provider reply flows. */
type DispatchReplyWithBufferedBlockDispatcher$1 = (params: {
ctx: DispatchReplyContext;
cfg: OpenClawConfig;
dispatcherOptions: ReplyDispatcherWithTypingOptions;
toolsAllow?: string[];
replyOptions?: DispatchReplyOptions;
replyResolver?: GetReplyFromConfig;
dispatchReplyFromConfig?: DispatchReplyFromConfig;
}) => Promise<DispatchFromConfigResult>;
/** Plain dispatcher entry point used when block buffering is not needed. */
type DispatchReplyWithDispatcher = (params: {
ctx: DispatchReplyContext;
cfg: OpenClawConfig;
dispatcherOptions: ReplyDispatcherOptions;
toolsAllow?: string[];
replyOptions?: DispatchReplyOptions;
replyResolver?: GetReplyFromConfig;
}) => Promise<DispatchFromConfigResult>;
//#endregion
//#region src/auto-reply/dispatch-dispatcher.d.ts
/** Mark a dispatcher complete, wait for pending work, then run optional cleanup. */
declare function settleReplyDispatcher(params: {
dispatcher: ReplyDispatcher;
onSettled?: () => void | Promise<void>;
}): Promise<ReplyDispatchReceipt | undefined>;
/** Run work with a dispatcher and always drain it before returning or throwing. */
declare function withReplyDispatcher<T>(params: {
dispatcher: ReplyDispatcher;
run: () => Promise<T>;
onSettled?: () => void | Promise<void>;
onSettledReceipt?: (receipt: ReplyDispatchReceipt | undefined) => void;
}): Promise<T>;
//#endregion
//#region src/auto-reply/reply/inbound-context.d.ts
type FinalizeInboundContextOptions = {
forceBodyForAgent?: boolean;
forceBodyForCommands?: boolean;
forceChatType?: boolean;
};
declare function finalizeInboundContext<T extends Record<string, unknown>>(ctx: T, opts?: FinalizeInboundContextOptions): Omit<T, LegacyMediaContextKey> & FinalizedRuntimeMsgContext;
/** Keeps the shipped Plugin SDK return type while internal callers use the stricter type above. */
declare function finalizeInboundContextForSdk<T extends Record<string, unknown>>(ctx: T, opts?: FinalizeInboundContextOptions): T & FinalizedMsgContext & CanonicalInboundText;
//#endregion
//#region src/media/fetch.d.ts
/** Remote media bytes plus metadata before they are persisted to the media store. */
type FetchMediaResult = {
buffer: Buffer;
contentType?: string;
fileName?: string;
};
/** Saved media record enriched with the best remote filename candidate. */
type SavedRemoteMedia = SavedMedia & {
fileName?: string;
};
/** Closed error classes callers can use for retry and diagnostic policy. */
type MediaFetchErrorCode = "max_bytes" | "http_error" | "fetch_failed";
/** Retry policy applied around the complete guarded fetch and body read/save operation. */
type MediaFetchRetryOptions = RetryOptions;
/** Structured fetch error used for retry decisions and caller-facing diagnostics. */
declare class MediaFetchError extends Error {
readonly code: MediaFetchErrorCode;
readonly status?: number;
constructor(code: MediaFetchErrorCode, message: string, options?: {
cause?: unknown;
status?: number;
});
}
/** Fetch-compatible injection point used by tests and guarded network callers. */
type FetchLike = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
/** Alternate dispatcher/lookup pair tried inside a single guarded fetch attempt. */
type FetchDispatcherAttempt = {
dispatcherPolicy?: PinnedDispatcherPolicy;
lookupFn?: LookupFn;
};
type FetchMediaOptions = {
url: string;
fetchImpl?: FetchLike;
/** Final synchronous check repeated for every media attempt and redirect. */
beforeRequest?: GuardedFetchOptions["beforeRequest"];
requestInit?: RequestInit;
filePathHint?: string;
maxBytes?: number;
maxRedirects?: number;
/** Require HTTPS for the initial URL and every redirect target. */
requireHttps?: boolean;
/** Abort the complete guarded fetch and body operation after this deadline (ms). */
timeoutMs?: number;
/** Abort if final response headers have not arrived by this deadline (ms). */
responseHeaderTimeoutMs?: number;
/** Abort if the response body stops yielding data for this long (ms). */
readIdleTimeoutMs?: number;
ssrfPolicy?: SsrFPolicy;
lookupFn?: LookupFn;
dispatcherPolicy?: PinnedDispatcherPolicy;
dispatcherAttempts?: FetchDispatcherAttempt[];
shouldRetryFetchError?: (error: unknown) => boolean;
/**
* Retries the complete guarded fetch/read-or-save operation. Dispatcher
* attempts still run inside each retry attempt.
*/
retry?: MediaFetchRetryOptions;
/**
* Allow an operator-configured explicit proxy to resolve target DNS after
* hostname-policy checks instead of forcing local pinned-DNS first.
*/
trustExplicitProxyDns?: boolean;
};
/** Options for validating and saving an existing Response body into the media store. */
type SaveResponseMediaOptions = {
sourceUrl?: string;
filePathHint?: string;
maxBytes?: number;
readIdleTimeoutMs?: number;
fallbackContentType?: string;
subdir?: string;
originalFilename?: string;
};
/** Options for guarded URL fetches that are saved directly into the media store. */
type SaveRemoteMediaOptions = FetchMediaOptions & {
/** Revalidate caller-owned read authority through transport and file publication. */
assertCurrent?: () => void;
fallbackContentType?: string;
subdir?: string;
originalFilename?: string;
};
/** Validates and saves a caller-provided response without performing a new fetch. */
declare function saveResponseMedia(res: Response, options?: SaveResponseMediaOptions): Promise<SavedRemoteMedia>;
/** Fetches media through SSRF guards and saves the body into the media store. */
declare function saveRemoteMedia(options: SaveRemoteMediaOptions): Promise<SavedRemoteMedia>;
/** Fetches media through SSRF guards and returns the bounded response body as a buffer. */
declare function readRemoteMediaBuffer(options: FetchMediaOptions): Promise<FetchMediaResult>;
/** @deprecated Use `readRemoteMediaBuffer` for buffer reads or `saveRemoteMedia` for URL-to-store. */
declare const fetchRemoteMedia: typeof readRemoteMediaBuffer;
//#endregion
//#region src/infra/channel-activity.d.ts
/** Direction of the last observed activity for a channel/account pair. */
type ChannelDirection = "inbound" | "outbound";
type ActivityEntry = {
inboundAt: number | null;
outboundAt: number | null;
};
/** Records the latest inbound or outbound activity timestamp for a channel/account. */
declare function recordChannelActivity(params: {
channel: ChannelId$1;
accountId?: string | null;
direction: ChannelDirection;
at?: number;
}): void;
/** Returns the latest known inbound/outbound activity timestamps for a channel/account. */
declare function getChannelActivity(params: {
channel: ChannelId$1;
accountId?: string | null;
}): ActivityEntry;
//#endregion
//#region src/channels/command-gating.d.ts
/**
* Shared text-control command authorization policy for channel runtimes.
*
* These helpers are re-exported through the plugin SDK so built-in and external
* channels make the same access-groups decisions for native command text.
*/
/** One channel-specific authorization source for text control commands. */
type CommandAuthorizer = {
/** True when this channel/user identity has an access-group rule configured. */
configured: boolean;
/** True when the configured rule permits the command. Ignored when unconfigured. */
allowed: boolean;
};
/** Fallback policy for channels that have access groups globally disabled. */
type CommandGatingModeWhenAccessGroupsOff = "allow" | "deny" | "configured";
/** Resolves whether any configured authorizer permits a control command. */
declare function resolveCommandAuthorizedFromAuthorizers(params: {
/** Global access-group switch for the channel/runtime. */
useAccessGroups: boolean;
/** Independent authorization sources, such as sender id and actor id. */
authorizers: CommandAuthorizer[];
/** Policy used only when `useAccessGroups` is false. Defaults to open. */
modeWhenAccessGroupsOff?: CommandGatingModeWhenAccessGroupsOff;
}): boolean;
/** Resolves command authorization and whether the current text command should be blocked. */
declare function resolveControlCommandGate(params: Parameters<typeof resolveCommandAuthorizedFromAuthorizers>[0] & {
/** Channel setting that enables text commands as an input surface. */
allowTextCommands: boolean;
/** True when the current inbound message parsed as a control command. */
hasControlCommand: boolean;
}): {
commandAuthorized: boolean;
shouldBlock: boolean;
};
/** Convenience gate for channels that check primary and secondary text command identities. */
declare function resolveDualTextControlCommandGate(params: {
/** Global access-group switch for the channel/runtime. */
useAccessGroups: boolean;
/** Whether the primary identity has an access-group rule. */
primaryConfigured: boolean;
/** Whether the primary configured rule permits the command. */
primaryAllowed: boolean;
/** Whether the secondary identity has an access-group rule. */
secondaryConfigured: boolean;
/** Whether the secondary configured rule permits the command. */
secondaryAllowed: boolean;
/** True when the current inbound message parsed as a control command. */
hasControlCommand: boolean;
/** Policy used only when `useAccessGroups` is false. Defaults to open. */
modeWhenAccessGroupsOff?: CommandGatingModeWhenAccessGroupsOff;
}): {
commandAuthorized: boolean;
shouldBlock: boolean;
};
//#endregion
//#region src/channels/message-access/runtime-routes.d.ts
/**
* Collect optional route descriptors while dropping false, null, and undefined
* entries.
*/
declare function channelIngressRoutes(...routes: Array<ChannelIngressRouteDescriptor | false | null | undefined>): ChannelIngressRouteDescriptor[];
//#endregion
//#region src/channels/message-access/runtime.d.ts
/** Evaluate policy without admitting a host participant. */
declare function createChannelIngressPolicyResolver(base: CreateChannelIngressResolverParams): ChannelIngressResolver;
/**
* Resolve one inbound event using a simple stable subject identity descriptor.
*/
declare function resolveStableChannelIngressPolicy(params: ResolveStableChannelMessageIngressParams): Promise<ResolvedChannelMessageIngress>;
/**
* Resolve sender, route, command, event, and activation gates for one inbound
* channel event.
*/
declare function resolveChannelIngressPolicy(params: ResolveChannelMessageIngressParams): Promise<ResolvedChannelMessageIngress>;
//#endregion
//#region src/auto-reply/reply/source-reply-delivery-mode.d.ts
/** Minimal inbound context needed for source-reply delivery decisions. */
type SourceReplyDeliveryModeContext = {
ChatType?: string;
SessionKey?: string;
InboundEventKind?: InboundEventKind;
Provider?: string;
Surface?: string;
ExplicitDeliverRoute?: boolean;
CommandAuthorized?: boolean;
CommandBody?: string;
CommandSource?: "text" | "native";
CommandTurn?: CommandTurnContext;
BotUsername?: string;
WasMentioned?: boolean;
InputProvenance?: InputProvenance;
};
//#endregion
//#region src/channels/reply-prefix.d.ts
type ModelSelectionContext = Parameters<NonNullable<GetReplyOptions["onModelSelected"]>>[0];
/**
* Mutable response-prefix state shared between reply setup and model selection callbacks.
*/
type ReplyPrefixContextBundle = {
prefixContext: ResponsePrefixContext;
responsePrefix?: string;
responsePrefixContextProvider: () => ResponsePrefixContext;
onModelSelected: (ctx: ModelSelectionContext) => void;
};
/**
* Reply option subset consumed by channel reply dispatchers.
*/
type ReplyPrefixOptions = Pick<ReplyPrefixContextBundle, "responsePrefix" | "responsePrefixContextProvider" | "onModelSelected">;
/**
* Creates response-prefix options and a live context provider for the selected model.
*/
declare function createReplyPrefixContext(params: {
cfg: OpenClawConfig;
agentId: string;
channel?: string;
accountId?: string;
}): ReplyPrefixContextBundle;
/**
* Creates the reply-prefix options object expected by `getReply` call sites.
*/
declare function createReplyPrefixOptions(params: Parameters<typeof createReplyPrefixContext>[0]): ReplyPrefixOptions;
//#endregion
//#region src/channels/message/reply-pipeline.d.ts
type ReplyPrefixContext = ReplyPrefixContextBundle["prefixContext"];
/** Resolves whether a channel reply should use source delivery, message tools, or direct sending. */
declare function resolveChannelSourceReplyDeliveryMode(params: {
/** Full config used to inspect source-reply delivery settings. */
cfg: OpenClawConfig;
/** Reply delivery context from the current channel turn. */
ctx: SourceReplyDeliveryModeContext;
/** Caller-requested delivery mode override. */
requested?: SourceReplyDeliveryMode;
/** Whether the message-send tool is available for this turn. */
messageToolAvailable?: boolean;
}): SourceReplyDeliveryMode;
/** Reply pipeline options shared by core channel turns and plugin SDK callers. */
type ChannelReplyPipeline = ReplyPrefixOptions & {
/** Resolves a response prefix against the pipeline's live selected-model context. */
resolveResponsePrefix?: () => string | undefined;
/** Optional typing lifecycle callbacks for reply generation. */
typingCallbacks?: TypingCallbacks;
/** Optional payload transform applied before channel delivery. */
transformReplyPayload?: (payload: ReplyPayload) => ReplyPayload | null;
};
/** Parameters for building a channel reply pipeline with prefix, typing, and payload transforms. */
type CreateChannelReplyPipelineParams = {
/** Full config used for reply prefix and channel plugin transform resolution. */
cfg: Parameters<typeof createReplyPrefixOptions>[0]["cfg"];
/** Agent id used in reply prefix context. */
agentId: string;
/** Optional channel id for prefix context and plugin transform lookup. */
channel?: string;
/** Optional channel account id for prefix context and plugin transform lookup. */
accountId?: string;
/** Typing callback factory input. */
typing?: CreateTypingCallbacksParams;
/** Prebuilt typing callbacks that take precedence over `typing`. */
typingCallbacks?: TypingCallbacks;
/** Explicit payload transform; avoids channel plugin lookup when provided. */
transformReplyPayload?: (payload: ReplyPayload) => ReplyPayload | null;
};
/** Builds the reply pipeline used by channel turns and plugin SDK reply helpers. */
declare function createChannelReplyPipeline(params: CreateChannelReplyPipelineParams): ChannelReplyPipeline;
//#endregion
//#region src/plugin-sdk/pair-loop-guard-runtime.d.ts
/** User-facing pair-loop guard config accepted by channel plugins. */
type PairLoopGuardConfig = {
/** Enables or disables loop protection for the channel/account scope. */
enabled?: boolean;
/** Number of pair events allowed before cooldown starts. */
maxEventsPerWindow?: number;
/** Rolling event window size in seconds for config files. */
windowSeconds?: number;
/** Suppression duration in seconds for config files. */
cooldownSeconds?: number;
};
/** Result of recording one pair interaction against the loop guard. */
type PairLoopGuardResult = {
suppressed: false;
} | {
suppressed: true;
cooldownUntilMs: number;
};
//#endregion
//#region src/channels/turn/bot-loop-protection.d.ts
/** Facts used to detect repeated bot-to-bot channel reply loops. */
type ChannelBotLoopProtectionFacts = {
scopeId: string;
conversationId: string;
senderId: string;
receiverId: string;
eventId?: string;
config?: PairLoopGuardConfig;
defaultsConfig?: PairLoopGuardConfig;
defaultEnabled: boolean;
nowMs?: number;
};
/** Records a bot pair interaction and returns whether the loop guard should suppress it. */
declare function recordChannelBotPairLoopAndCheckSuppression(params: ChannelBotLoopProtectionFacts): PairLoopGuardResult;
//#endregion
//#region src/channels/turn/types.d.ts
/** Admission decision for an inbound channel event before agent dispatch. */
type ChannelTurnAdmission = {
kind: "dispatch";
reason?: string;
} | {
kind: "observeOnly";
reason: string;
} | {
kind: "handled";
reason: string;
} | {
kind: "drop";
reason: string;
recordHistory?: boolean;
};
/** Coarse event classification used to decide whether an event can start an agent turn. */
type ChannelEventClass = {
kind: "message" | "command" | "interaction" | "reaction" | "lifecycle" | "unknown";
canStartAgentTurn: boolean;
requiresImmediateAck?: boolean;
};
/** Normalized inbound event text and raw payload after channel-specific ingestion. */
type NormalizedTurnInput = {
id: string;
timestamp?: number;
rawText: string;
textForAgent?: string;
textForCommands?: string;
raw?: unknown;
};
/** Sender identity facts projected into channel access, routing, and prompt context. */
type SenderFacts = {
id?: string;
name?: string;
username?: string;
tag?: string;
roles?: string[];
isBot?: boolean;
isSelf?: boolean;
displayLabel?: string;
};
/** Conversation identity and threading facts for a channel turn. */
type ConversationFacts = {
kind: "direct" | "group" | "channel";
id: string;
label?: string;
spaceId?: string;
parentId?: string;
threadId?: string;
nativeChannelId?: string;
avatar?: string;
routePeer?: {
kind: "direct" | "group" | "channel";
id: string;
};
};
/** Session routing facts derived before dispatch. */
type RouteFacts = {
agentId: string;
dmScope?: DmScope;
accountId?: string;
routeSessionKey: string;
dispatchSessionKey?: string;
persistedSessionKey?: string;
parentSessionKey?: string;
modelParentSessionKey?: string;
mainSessionKey?: string;
createIfMissing?: boolean;
};
/** Reply target and source-delivery facts for a channel turn. */
type ReplyPlanFacts = {
to: string;
originatingTo?: string;
nativeChannelId?: string;
replyTarget?: string;
deliveryTarget?: string;
replyToId?: string;
replyToIdFull?: string;
messageThreadId?: string | number;
threadParentId?: string;
sourceReplyDeliveryMode?: "thread" | "reply" | "channel" | "direct" | "none";
};
/** Message text/history facts passed into templating and dispatch. */
type MessageFacts = {
inboundEventKind?: InboundEventKind;
body?: string;
rawBody: string;
bodyForAgent?: string;
commandBody?: string;
envelopeFrom?: string;
senderLabel?: string;
preview?: string;
inboundHistory?: HistoryEntry[];
sourceModality?: InboundSourceModality;
};
/** Parsed command facts for command-like channel turns. */
type CommandFacts = {
kind: CommandTurnKind;
body?: string;
name?: string;
authorized?: boolean;
};
/** Inbound media facts supplied to the agent context. */
type InboundMediaFacts = Omit<MediaFact, "staged" | "workspaceDir">;
type MaybePromise$2<T> = T | Promise<T>;
/** Adapter preflight output assembled before turn resolution. */
type PreflightFacts = {
admission?: ChannelTurnAdmission;
command?: CommandFacts;
message?: Partial<MessageFacts>;
media?: readonly InboundMediaFacts[] | (() => MaybePromise$2<readonly InboundMediaFacts[] | readonly HistoryMediaEntry[] | null | undefined>);
supplemental?: SupplementalContextFacts;
history?: ChannelTurnDroppedHistoryOptions;
};
/** Delivery metadata for one reply payload dispatch. */
type ChannelDeliveryInfo = ReplyDispatchRuntimeInfo;
type ChannelCoreManagedDeliveryInfo = Omit<ChannelDeliveryInfo, "assertPlatformSendAuthorized" | "bindPendingFinalDelivery" | "onPlatformSendDispatch">;
type ChannelProviderOwnedDeliveryInfo = ChannelDeliveryInfo & {
assertPlatformSendAuthorized: () => void;
onPlatformSendDispatch: () => Promise<void>;
};
/** Durable outbound delivery options available to channel turn delivery adapters. */
type ChannelTurnDurableDeliveryOptions = Pick<DeliverOutboundPayloadsParams, "deps" | "formatting" | "identity" | "mediaAccess" | "replyToMode" | "silent" | "threadId"> & {
to?: string | null;
replyToId?: string | null;
requiredCapabilities?: DurableFinalDeliveryRequirements;
};
type ChannelDeliveryAdapterBase = {
/** Return null when channel policy intentionally suppresses this logical payload. */
preparePayload?: (payload: ReplyPayload, info: ChannelDeliveryInfo) => MaybePromise$2<ReplyPayload | null>;
onDelivered?: (payload: ReplyPayload, info: ChannelDeliveryInfo, result: ChannelDeliveryResult | void) => Promise<void> | void;
/** Let core emit the one canonical `message_sent` after non-durable provider settlement. */
observeMessageSent?: true;
onError?: (err: unknown, info: {
kind: string;
}) => void;
};
type ChannelCoreManagedTurnDeliveryAdapter = ChannelDeliveryAdapterBase & {
deliver: (payload: ReplyPayload, info: ChannelCoreManagedDeliveryInfo) => Promise<ChannelDeliveryResult | void>;
/** Receives an explicitly prepared plan without interpreting its text as directives. */
deliverPrepared?: (plan: OutboundPayloadPlan, info: ChannelCoreManagedDeliveryInfo) => Promise<ChannelDeliveryResult | void>;
durable?: false | ChannelTurnDurableDeliveryOptions | ((payload: ReplyPayload, info: ChannelDeliveryInfo) => false | ChannelTurnDurableDeliveryOptions | Promise<false | ChannelTurnDurableDeliveryOptions>);
};
/** Delivery adapter used by legacy caller-assembled channel turns. */
type ChannelEventDeliveryAdapter = ChannelCoreManagedTurnDeliveryAdapter;
type ChannelProviderOwnedMessageSendingDeliveryAdapter = ChannelDeliveryAdapterBase & {
/**
* Provider funnel that owns `message_sending` after its native payload preparation.
* Use only when delivery cannot declare its durable/direct branch before entering the
* provider funnel; core still owns `reply_payload_sending` for this routed turn.
*/
deliverWithProviderMessageSending: (payload: ReplyPayload, info: ChannelProviderOwnedDeliveryInfo) => Promise<ChannelDeliveryResult | void>;
deliverPreparedWithProviderMessageSending?: (plan: OutboundPayloadPlan, info: ChannelProviderOwnedDeliveryInfo) => Promise<ChannelDeliveryResult | void>;
deliver?: never;
deliverPrepared?: never;
durable?: never;
};
/** Delivery adapter used by modern routed channel turns. */
type ChannelTurnDeliveryAdapter = (ChannelCoreManagedTurnDeliveryAdapter & {
deliverWithProviderMessageSending?: never;
deliverPreparedWithProviderMessageSending?: never;
}) | ChannelProviderOwnedMessageSendingDeliveryAdapter;
/** Options for recording inbound session route state around a turn. */
type ChannelTurnRecordOptions = {
/**
* Override the session used for metadata and transcript context.
* Must be non-empty and contain no surrounding whitespace.
*/
sessionKey?: string;
groupResolution?: GroupKeyResolution | null;
createIfMissing?: boolean;
updateLastRoute?: InboundLastRouteUpdate;
onRecordError?: (err: unknown) => void;
trackSessionMetaTask?: (task: Promise<unknown>) => void;
};
/** Options for finalizing visible conversation history after dispatch. */
type ChannelTurnHistoryFinalizeOptions = {
isGroup?: boolean;
historyKey?: string;
historyMap?: Map<string, HistoryEntry[]>;
limit?: number;
};
/** Options for recording history when an inbound event is dropped before dispatch. */
type ChannelTurnDroppedHistoryOptions = {
key: string;
limit: number;
historyMap: Map<string, HistoryEntry[]>;
recordOnDrop?: boolean;
mediaLimit?: number;
shouldRecord?: () => boolean;
};
/** Dispatcher options excluding delivery hooks owned by the channel turn adapter. */
type ChannelTurnDispatcherOptions = Omit<ReplyDispatcherWithTypingOptions, "deliver" | "deliverPrepared" | "onError">;
/** Reply options plus the opaque native command ownership decision carried by channel turns. */
type ChannelTurnReplyOptions = Omit<GetReplyOptions, "onBlockReply" | "onPreparedBlockReply"> & PluginCommandReplyOptions;
/** Reply pipeline options excluding cfg/agent/channel identity supplied by the turn. */
type ChannelTurnReplyPipelineOptions = Omit<CreateChannelReplyPipelineParams, "cfg" | "agentId" | "channel" | "accountId">;
type ChannelTurnContext = {
channel: string;
accountId?: string;
routeSessionKey: string;
storePath: string;
ctxPayload: FinalizedMsgContext;
recordInboundSession: RecordInboundSession$1;
afterRecord?: () => void | Promise<void>;
record?: ChannelTurnRecordOptions;
history?: ChannelTurnHistoryFinalizeOptions;
admission?: Extract<ChannelTurnAdmission, {
kind: "dispatch" | "observeOnly";
}>;
botLoopProtection?: ChannelBotLoopProtectionFacts;
/** Transport-defined outbound source identity, such as a webhook id. */
outboundEchoSourceId?: string;
log?: (event: ChannelTurnLogEvent) => void;
messageId?: string;
};
/** Fully assembled channel turn ready to build the dispatch runner. */
type AssembledChannelTurn = ChannelTurnContext & {
cfg: OpenClawConfig;
agentId: string;
dispatchReplyWithBufferedBlockDispatcher: DispatchReplyWithBufferedBlockDispatcher$1;
delivery: ChannelEventDeliveryAdapter;
replyPipeline?: ChannelTurnReplyPipelineOptions;
dispatcherOptions?: ChannelTurnDispatcherOptions;
toolsAllow?: string[];
replyOptions?: ChannelTurnReplyOptions;
replyResolver?: GetReplyFromConfig;
/** Instance-bound reply dispatcher supplied by the owning plugin runtime. */
dispatchReplyFromConfig?: DispatchReplyFromConfig;
sessionInitRetry?: {
delaysMs: readonly number[];
signal?: AbortSignal;
sleep?: (ms: number, signal?: AbortSignal) => Promise<void>;
};
/** Canonical adoption lifecycle threaded into replyOptions. */
turnAdoptionLifecycle?: TurnAdoptionLifecycle;
};
type PreparedChannelTurnDispatchSkipReason = "botLoopProtection" | "observeOnly" | "outboundEcho";
/** Lifecycle ownership declared alongside an already-prepared dispatch runner. */
type PreparedChannelTurnDispatchLifecycle = {
/** Exact adoption lifecycle captured by runDispatch, or undefined for non-durable turns. */
turnAdoptionLifecycle: TurnAdoptionLifecycle | undefined;
/** Releases resources that runDispatch would otherwise settle when dispatch is skipped. */
onDispatchSkipped: (reason: PreparedChannelTurnDispatchSkipReason) => void | Promise<void>;
};
/** Channel turn with dispatch runner already prepared. */
type PreparedChannelTurn<TDispatchResult = DispatchFromConfigResult> = ChannelTurnContext & {
onPreDispatchFailure?: (err: unknown) => void | Promise<void>;
runDispatch: () => Promise<TDispatchResult>;
/** Optional for the legacy direct prepared runner; inbound adapters use the stricter type. */
runDispatchLifecycle?: PreparedChannelTurnDispatchLifecycle;
observeOnlyDispatchResult?: TDispatchResult;
};
type ChannelTurnRoute = {
agentId: string;
dmScope?: DmScope;
sessionKey: string;
};
type RoutedChannelTurn<T> = Omit<T, "routeSessionKey" | "storePath" | "recordInboundSession"> & {
route: ChannelTurnRoute;
};
type InboundPreparedChannelTurn<TDispatchResult = DispatchFromConfigResult> = PreparedChannelTurn<TDispatchResult> & {
runDispatchLifecycle: PreparedChannelTurnDispatchLifecycle;
};
type ChannelTurnPlan<TDelivery extends ChannelTurnDeliveryAdapter = ChannelCoreManagedTurnDeliveryAdapter> = RoutedChannelTurn<Omit<AssembledChannelTurn, "agentId" | "delivery" | "dispatchReplyWithBufferedBlockDispatcher"> & {
delivery: TDelivery;
}>;
type PreparedChannelTurnPlan<TDispatchResult = DispatchFromConfigResult> = RoutedChannelTurn<InboundPreparedChannelTurn<TDispatchResult>> & {
cfg: OpenClawConfig;
};
/** Resolved turn shape returned by adapters before final run/dispatch handling. */
type ChannelTurnResolved<TDispatchResult = DispatchFromConfigResult, TDelivery extends ChannelTurnDeliveryAdapter = ChannelCoreManagedTurnDeliveryAdapter> = ChannelTurnPlan<TDelivery> | PreparedChannelTurnPlan<TDispatchResult> | AssembledChannelTurn | InboundPreparedChannelTurn<TDispatchResult>;
/** Ordered lifecycle stage names emitted to channel turn log hooks. */
type ChannelTurnStage = "ingest" | "classify" | "preflight" | "resolve" | "authorize" | "assemble" | "record" | "dispatch" | "finalize";
/** Structured channel turn log event. */
type ChannelTurnLogEvent = {
stage: ChannelTurnStage;
event: "start" | "done" | "drop" | "handled" | "error" | "warning";
channel: string;
accountId?: string;
messageId?: string;
sessionKey?: string;
admission?: ChannelTurnAdmission["kind"];
reason?: string;
error?: unknown;
};
/** Final result for a channel turn, dispatched or admitted without dispatch. */
type ChannelTurnResult<TDispatchResult = DispatchFromConfigResult> = DispatchedChannelTurnResult<TDispatchResult> | {
admission: ChannelTurnAdmission;
dispatched: false;
ctxPayload?: MsgContext;
routeSessionKey?: string;
};
/** Successful dispatch result for a channel turn. */
type DispatchedChannelTurnResult<TDispatchResult = DispatchFromConfigResult> = {
admission: Extract<ChannelTurnAdmission, {
kind: "dispatch" | "observeOnly";
}>;
dispatched: true;
ctxPayload: MsgContext;
routeSessionKey: string;
dispatchResult: TDispatchResult;
};
/** Adapter contract for ingesting, classifying, resolving, and finalizing raw channel events. */
type ChannelTurnAdapter<TRaw, TDispatchResult = DispatchFromConfigResult, TDelivery extends ChannelTurnDeliveryAdapter = ChannelCoreManagedTurnDeliveryAdapter> = {
ingest: (raw: TRaw) => MaybePromise$2<NormalizedTurnInput | null>;
classify?: (input: NormalizedTurnInput) => MaybePromise$2<ChannelEventClass>;
preflight?: (input: NormalizedTurnInput, eventClass: ChannelEventClass) => MaybePromise$2<PreflightFacts | ChannelTurnAdmission | null | undefined>;
resolveTurn: (input: NormalizedTurnInput, eventClass: ChannelEventClass, preflight: PreflightFacts) => MaybePromise$2<ChannelTurnResolved<TDispatchResult, TDelivery>>;
onFinalize?: (result: ChannelTurnResult<TDispatchResult>) => Promise<void> | void;
};
/** Parameters for running one raw channel event through the turn kernel. */
type RunChannelTurnParams<TRaw, TDispatchResult = DispatchFromConfigResult, TDelivery extends ChannelTurnDeliveryAdapter = ChannelCoreManagedTurnDeliveryAdapter> = {
channel: string;
accountId?: string;
raw: TRaw;
adapter: ChannelTurnAdapter<TRaw, TDispatchResult, TDelivery>;
log?: (event: ChannelTurnLogEvent) => void;
/** Canonical adoption lifecycle for this turn. */
turnAdoptionLifecycle?: TurnAdoptionLifecycle;
};
//#endregion
//#region src/channels/inbound-event/context.d.ts
type MaybePromise$1<T> = T | Promise<T>;
type ChannelInboundSupplementalMediaResolver = () => MaybePromise$1<readonly InboundMediaFacts[] | null | undefined>;
type ChannelInboundSupplementalQuoteFacts = NonNullable<SupplementalContextFacts["quote"]> & {
isSelf?: boolean;
media?: readonly InboundMediaFacts[] | ChannelInboundSupplementalMediaResolver;
};
type ChannelInboundSupplementalFacts = Omit<SupplementalContextFacts, "quote"> & {
quote?: ChannelInboundSupplementalQuoteFacts;
};
/**
* @deprecated Prefer passing `resolveSupplementalMedia: true` directly to
* `buildChannelInboundEventContext` without naming this compatibility type.
*/
type ChannelInboundSupplementalResolutionOptions = {
resolveSupplementalMedia: true;
suppressSelfQuoteBody?: boolean;
suppressSelfQuoteMedia?: boolean;
};
type BuildChannelInboundEventAccess = {
commands?: Pick<ChannelIngressCommandAccess, "authorized">;
/** Channel-configured policy resolved at the trusted ingress boundary. */
toolPolicy?: GroupToolPolicyConfig;
mentions?: {
canDetectMention: boolean;
wasMentioned: boolean;
hasAnyMention?: boolean;
explicitlyMentionedBot?: boolean;
mentionedUserIds?: string[];
mentionedSubteamIds?: string[];
mentionSource?: MentionSource;
implicitMentionKinds?: readonly InboundImplicitMentionKind[];
requireMention?: boolean;
effectiveWasMentioned?: boolean;
};
};
type BuildChannelInboundEventContextParams = {
channel: string;
accountId?: string;
provider?: string;
surface?: string;
messageId?: string;
messageIdFull?: string;
timestamp?: number;
from: string;
sender: SenderFacts;
conversation: ConversationFacts;
route: RouteFacts;
reply: ReplyPlanFacts;
message: MessageFacts;
sessionTranscript?: SessionTranscriptContext;
access?: BuildChannelInboundEventAccess;
command?: CommandFacts;
commandTurn?: CommandTurnContext;
media?: InboundMediaFacts[];
supplemental?: ChannelInboundSupplementalFacts;
channelContext?: PluginHookChannelContext;
contextVisibility?: ContextVisibilityMode;
finalize?: FinalizeInboundContextFn;
finalizeOptions?: FinalizeInboundContextOptions;
extra?: Record<string, unknown>;
/** Exact host-resolved ingress result, or an explicit unsupported adapter marker. */
channelIngress?: ResolvedChannelMessageIngress | readonly ResolvedChannelMessageIngress[] | "unsupported";
};
/**
* @deprecated Prefer `BuildChannelInboundEventContextParams` with
* `resolveSupplementalMedia: true` at call sites that need lazy quote media.
*/
type BuildChannelInboundEventContextAsyncParams = BuildChannelInboundEventContextParams & ChannelInboundSupplementalResolutionOptions;
type BuiltChannelInboundEventContext = FinalizedMsgContext & {
Body: string;
BodyForAgent: string;
BodyForCommands: string;
ChatType: ConversationFacts["kind"];
CommandAuthorized: boolean;
CommandBody: string;
From: string;
RawBody: string;
SessionKey: string;
To: string;
InboundEventKind: InboundEventKind;
};
type FinalizeInboundContextFn = (ctx: Record<string, unknown>, opts?: FinalizeInboundContextOptions) => unknown;
/**
* @deprecated Used by deprecated `finalizeChannelInboundContext`; new channel
* code should pass facts to `buildChannelInboundEventContext`.
*/
type FinalizeChannelInboundContextParams<T extends Record<string, unknown>> = {
context: T;
supplemental?: SupplementalContextFacts | ChannelInboundSupplementalFacts;
contextVisibility?: ContextVisibilityMode;
media?: readonly InboundMediaFacts[];
finalize?: FinalizeInboundContextFn;
finalizeOptions?: FinalizeInboundContextOptions;
};
/**
* @deprecated Prefer `FinalizeChannelInboundContextParams<T>` with
* `resolveSupplementalMedia: true` when lazy quote media must be resolved.
*/
type FinalizeChannelInboundContextAsyncParams<T extends Record<string, unknown>> = FinalizeChannelInboundContextParams<T> & {
resolveSupplementalMedia: true;
} & Pick<ChannelInboundSupplementalResolutionOptions, "suppressSelfQuoteBody" | "suppressSelfQuoteMedia">;
/**
* @deprecated Result type for deprecated `finalizeChannelInboundContext`.
*/
type FinalizeChannelInboundContextResult<T extends Record<string, unknown>> = {
context: T & FinalizedMsgContext;
supplemental?: SupplementalContextFacts;
quoteHidden: boolean;
forwardedHidden: boolean;
threadHidden: boolean;
};
declare function filterChannelInboundSupplementalContext(params: {
supplemental?: SupplementalContextFacts;
contextVisibility?: ContextVisibilityMode;
}): SupplementalContextFacts | undefined;
/** Resolves whether a supplemental-context sender passes the active group policy. */
declare function resolveInboundSupplementalSenderAllowed<TAllowFrom>(params: {
isGroup: boolean;
groupPolicy: string;
allowFrom: readonly TAllowFrom[];
isSenderAllowed: (allowFrom: readonly TAllowFrom[]) => boolean;
}): boolean;
declare function filterChannelInboundQuoteContext(contextVisibility: ContextVisibilityMode | undefined, quote: SupplementalContextFacts["quote"] | undefined): SupplementalContextFacts["quote"] | undefined;
/**
* @deprecated Public compatibility for callers that already prepared legacy
* prompt fields. New channel code should use `buildChannelInboundEventContext`.
*/
declare function finalizeChannelInboundContext<T extends Record<string, unknown>>(params: FinalizeChannelInboundContextAsyncParams<T>): Promise<FinalizeChannelInboundContextResult<T>>;
declare function finalizeChannelInboundContext<T extends Record<string, unknown>>(params: FinalizeChannelInboundContextParams<T>): FinalizeChannelInboundContextResult<T>;
declare function buildChannelInboundEventContext(params: BuildChannelInboundEventContextAsyncParams): Promise<BuiltChannelInboundEventContext>;
declare function buildChannelInboundEventContext(params: BuildChannelInboundEventContextParams): BuiltChannelInboundEventContext;
//#endregion
//#region src/channels/turn/run-channel-turn.d.ts
declare function recordDroppedChannelTurnHistory(params: {
input: NormalizedTurnInput;
preflight: PreflightFacts;
admission?: ChannelTurnAdmission;
}): Promise<void>;
declare function runChannelTurn<TRaw, TDispatchResult = DispatchedChannelTurnResult["dispatchResult"]>(params: RunChannelTurnParams<TRaw, TDispatchResult, ChannelProviderOwnedMessageSendingDeliveryAdapter>): Promise<ChannelTurnResult<TDispatchResult>>;
declare function runChannelTurn<TRaw, TDispatchResult = DispatchedChannelTurnResult["dispatchResult"]>(params: RunChannelTurnParams<TRaw, TDispatchResult>): Promise<ChannelTurnResult<TDispatchResult>>;
//#endregion
//#region src/channels/turn/execution.d.ts
declare function runPreparedChannelTurn<TDispatchResult = DispatchedChannelTurnResult["dispatchResult"]>(params: PreparedChannelTurn<TDispatchResult>): Promise<ChannelTurnResult<TDispatchResult>>;
//#endregion
//#region src/channels/turn/lifecycle.d.ts
declare function dispatchAssembledChannelTurn(params: AssembledChannelTurn): Promise<ChannelTurnResult>;
declare function dispatchRoutedChannelTurn(params: ChannelTurnPlan<ChannelTurnDeliveryAdapter>): Promise<ChannelTurnResult>;
declare function dispatchRoutedChannelTurn(params: ChannelTurnPlan<ChannelProviderOwnedMessageSendingDeliveryAdapter>): Promise<ChannelTurnResult>;
declare function dispatchRoutedChannelTurn(params: ChannelTurnPlan): Promise<ChannelTurnResult>;
//#endregion
//#region src/auto-reply/command-detection.runtime-types.d.ts
/** Runtime-injected predicate for deciding whether visible text is an OpenClaw command. */
type IsControlCommandMessage = typeof isControlCommandMessage;
/** Runtime-injected predicate for deciding whether command authorization must be computed. */
type ShouldComputeCommandAuthorized = typeof shouldComputeCommandAuthorized;
//#endregion
//#region src/auto-reply/commands-registry.runtime-types.d.ts
/** Runtime-injected policy hook for whether text slash commands should be honored. */
type ShouldHandleTextCommands = typeof shouldHandleTextCommands;
//#endregion
//#region src/channels/mention-pattern-policy.d.ts
/**
* Inputs for resolving whether mention-pattern matching is enabled in a conversation.
*/
type ResolveMentionPatternPolicyParams = {
cfg?: OpenClawConfig;
provider?: string;
conversationId?: string | null;
providerPolicy?: MentionPatternsPolicyConfig;
agentId?: string;
};
/**
* Effective mention-pattern policy after provider and conversation allow/deny rules.
*/
type ResolvedMentionPatternPolicy = {
effectiveMode: MentionPatternsMode;
allowMatched: boolean;
denyMatched: boolean;
enabled: boolean;
};
/**
* Resolves provider-scoped mention-pattern policy for a single conversation.
*/
declare function resolveMentionPatternPolicy(params: ResolveMentionPatternPolicyParams): ResolvedMentionPatternPolicy;
//#endregion
//#region src/auto-reply/reply/mentions.types.d.ts
/** Options for building mention regexes without binding config/agent id. */
type BuildMentionRegexesOptions = Omit<ResolveMentionPatternPolicyParams, "cfg" | "agentId">;
/** Builds mention regexes for the current config and agent. */
type BuildMentionRegexes = (cfg: OpenClawConfig | undefined, agentId?: string, options?: BuildMentionRegexesOptions) => RegExp[];
/** Tests plain text against mention regexes. */
type MatchesMentionPatterns = (text: string, mentionRegexes: RegExp[]) => boolean;
/** Explicit mention metadata supplied by channel adapters. */
type ExplicitMentionSignal = {
hasAnyMention: boolean;
isExplicitlyMentioned: boolean;
canResolveExplicit: boolean;
};
/** Tests mention state using regexes plus explicit channel mention metadata. */
type MatchesMentionWithExplicit = (params: {
text: string;
mentionRegexes: RegExp[];
explicit?: ExplicitMentionSignal;
transcript?: string;
}) => boolean;
//#endregion
//#region src/auto-reply/reply/reply-dispatcher.runtime-types.d.ts
/** Type of the lazy reply dispatcher factory used by runtime dispatch paths. */
type CreateReplyDispatcherWithTyping = typeof createReplyDispatcherWithTyping;
//#endregion
//#region src/channels/plugins/outbound/load.d.ts
declare const loadChannelOutboundAdapter: (id: ChannelId$1) => Promise<ChannelOutboundAdapter | undefined>;
//#endregion
//#region src/channels/plugins/outbound/load.types.d.ts
type LoadChannelOutboundAdapter = typeof loadChannelOutboundAdapter;
//#endregion
//#region src/config/markdown-tables.types.d.ts
/** Parameters for resolving markdown table rendering per config and channel. */
type ResolveMarkdownTableModeParams = {
cfg?: Partial<OpenClawConfig>;
channel?: string | null;
accountId?: string | null;
supportsBlockTables?: boolean;
};
type ResolveMarkdownTableMode = (params: ResolveMarkdownTableModeParams) => MarkdownTableMode;
//#endregion
//#region src/plugins/runtime/types-channel.d.ts
type DispatchReplyWithBufferedBlockDispatcher = DispatchReplyWithBufferedBlockDispatcher$1;
type RecordInboundSession = RecordInboundSession$1;
type RuntimeThreadBindingLifecycleRecord = SessionBindingRecord | {
boundAt: number;
lastActivityAt: number;
idleTimeoutMs?: number;
maxAgeMs?: number;
};
type PluginRuntimeChannel$1 = {
text: {
chunkByNewline: typeof chunkByNewline;
chunkMarkdownText: typeof chunkMarkdownText;
chunkMarkdownTextWithMode: typeof chunkMarkdownTextWithMode;
chunkText: typeof chunkText;
chunkTextWithMode: typeof chunkTextWithMode;
resolveChunkMode: typeof resolveChunkMode;
resolveTextChunkLimit: typeof resolveTextChunkLimit;
hasControlCommand: typeof hasControlCommand;
resolveMarkdownTableMode: ResolveMarkdownTableMode;
convertMarkdownTables: typeof convertMarkdownTables;
};
reply: {
dispatchReplyWithBufferedBlockDispatcher: DispatchReplyWithBufferedBlockDispatcher;
/**
* @deprecated Prefer `openclaw/plugin-sdk/channel-outbound` adapters plus
* `dispatchReplyWithBufferedBlockDispatcher` or channel turn helpers.
* This is a low-level legacy dispatcher escape hatch.
*/
createReplyDispatcherWithTyping: CreateReplyDispatcherWithTyping;
resolveEffectiveMessagesConfig: typeof resolveEffectiveMessagesConfig;
/**
* @deprecated Prefer the channel-message reply pipeline helpers. This is
* tied to the low-level legacy dispatcher path.
*/
resolveHumanDelayConfig: typeof resolveHumanDelayConfig;
/**
* @deprecated Prefer `dispatchReplyWithBufferedBlockDispatcher` with a
* channel-message adapter or the channel turn helpers. Direct use must
* manually preserve source reply delivery metadata such as
* `sourceReplyDeliveryMode`.
*/
dispatchReplyFromConfig: DispatchReplyFromConfig;
withReplyDispatcher: typeof withReplyDispatcher;
settleReplyDispatcher: typeof settleReplyDispatcher;
/**
* @deprecated Prefer `buildChannelInboundEventContext` from
* `openclaw/plugin-sdk/channel-inbound` so inbound event metadata is
* carried into reply dispatch.
*/
finalizeInboundContext: typeof finalizeInboundContext;
formatAgentEnvelope: typeof formatAgentEnvelope;
resolveEnvelopeFormatOptions: typeof resolveEnvelopeFormatOptions;
};
routing: {
buildAgentSessionKey: typeof buildAgentSessionKey;
resolveAgentRoute: typeof resolveAgentRoute;
};
pairing: {
buildPairingReply: typeof buildPairingReply;
readAllowFromStore: ReadChannelAllowFromStoreForAccount;
removeAllowFromStoreEntry: RemoveChannelAllowFromStoreEntryForAccount;
upsertPairingRequest: UpsertChannelPairingRequestForAccount;
};
media: {
readRemoteMediaBuffer: typeof readRemoteMediaBuffer;
/** @deprecated Use `readRemoteMediaBuffer`. */
fetchRemoteMedia: typeof fetchRemoteMedia;
saveRemoteMedia: typeof saveRemoteMedia;
saveResponseMedia: typeof saveResponseMedia;
saveMediaBuffer: typeof saveMediaBuffer;
};
activity: {
record: typeof recordChannelActivity;
get: typeof getChannelActivity;
};
session: {
/** @deprecated Prefer channel turn helpers that record inbound sessions as part of dispatch. */
resolveStorePath: typeof resolveSessionStorePathCore;
readSessionUpdatedAt: ReadSessionUpdatedAt;
recordSessionMetaFromInbound: RecordSessionMetaFromInbound;
/** @deprecated Prefer channel turn helpers that record inbound sessions as part of dispatch. */
recordInboundSession: RecordInboundSession;
updateLastRoute: UpdateLastRoute;
};
mentions: {
buildMentionRegexes: BuildMentionRegexes;
matchesMentionPatterns: MatchesMentionPatterns;
matchesMentionWithExplicit: MatchesMentionWithExplicit;
implicitMentionKindWhen: typeof implicitMentionKindWhen;
resolveInboundMentionDecision: typeof resolveInboundMentionDecision;
};
reactions: {
createAckReactionHandle: typeof createAckReactionHandle;
shouldAckReaction: typeof shouldAckReaction;
removeAckReactionAfterReply: typeof removeAckReactionAfterReply;
removeAckReactionHandleAfterReply: typeof removeAckReactionHandleAfterReply;
};
groups: {
resolveGroupPolicy: typeof resolveChannelGroupPolicy;
resolveRequireMention: typeof resolveChannelGroupRequireMention;
};
debounce: {
createInboundDebouncer: typeof createInboundDebouncer;
resolveInboundDebounceMs: typeof resolveInboundDebounceMs;
};
commands: {
resolveCommandAuthorizedFromAuthorizers: typeof resolveCommandAuthorizedFromAuthorizers;
isControlCommandMessage: IsControlCommandMessage;
shouldComputeCommandAuthorized: ShouldComputeCommandAuthorized;
shouldHandleTextCommands: ShouldHandleTextCommands;
};
outbound: {
loadAdapter: LoadChannelOutboundAdapter;
};
inbound: {
/** Ingress policy and identity handoff bound to this channel's host instance. */
ingress: {
createResolver: typeof createChannelIngressPolicyResolver;
resolve: typeof resolveChannelIngressPolicy;
resolveStable: typeof resolveStableChannelIngressPolicy;
};
buildContext: typeof buildChannelInboundEventContext;
run: typeof runChannelTurn;
/** @deprecated Prefer `run` for raw inbound events or `dispatchReply` for assembled contexts. */
runPreparedReply: typeof runPreparedChannelTurn;
dispatch: typeof dispatchRoutedChannelTurn;
/** Compatibility escape hatch; prefer `dispatch`, which keeps session wiring in core. */
dispatchReply: typeof dispatchAssembledChannelTurn;
};
/** @deprecated Compatibility for shipped plugins; use `channel.inbound`. */
turn: PluginRuntimeChannel$1["inbound"];
threadBindings: {
setIdleTimeoutBySessionKeyAsync: (params: Parameters<PluginRuntimeChannel$1["threadBindings"]["setIdleTimeoutBySessionKey"]>[0]) => Promise<RuntimeThreadBindingLifecycleRecord[]>;
setMaxAgeBySessionKeyAsync: (params: Parameters<PluginRuntimeChannel$1["threadBindings"]["setMaxAgeBySessionKey"]>[0]) => Promise<RuntimeThreadBindingLifecycleRecord[]>;
/** @deprecated Use setIdleTimeoutBySessionKeyAsync. Retained through the next Plugin SDK major. */
setIdleTimeoutBySessionKey: (params: {
channelId: string;
targetSessionKey: string;
accountId?: string;
idleTimeoutMs: number;
}) => RuntimeThreadBindingLifecycleRecord[];
/** @deprecated Use setMaxAgeBySessionKeyAsync. Retained through the next Plugin SDK major. */
setMaxAgeBySessionKey: (params: {
channelId: string;
targetSessionKey: string;
accountId?: string;
maxAgeMs: number;
}) => RuntimeThreadBindingLifecycleRecord[];
};
runtimeContexts: ChannelRuntimeContextRegistry;
};
//#endregion
//#region src/agents/run-wait.types.d.ts
/** Normalized terminal or pending state returned by `agent.wait`. */
type AgentWaitResult = {
status: "ok" | "timeout" | "error" | "pending";
error?: string;
/** Set locally when the wait RPC fails; terminal run text is never retry evidence. */
retryableTransportError?: true;
startedAt?: number;
endedAt?: number;
stopReason?: string;
livenessState?: string;
yielded?: boolean;
pendingError?: boolean;
timeoutPhase?: AgentRunTimeoutPhase;
providerStarted?: boolean;
terminalReply?: AgentRunTerminalReplySnapshot;
sourceReplyDelivered?: true;
};
//#endregion
//#region src/plugins/runtime/types.d.ts
type PluginRuntimeChannel = PluginRuntimeChannel$1;
type SubagentRunParams = {
/** Revalidate command authority at the host's run admission boundary. */
assertCurrent?: () => void;
sessionKey: string;
message: string;
/** Run with an exact empty tool surface. */
disableTools?: boolean;
/** Add exact tools registered by the calling plugin to the worker's normal tool surface. */
toolsAlsoAllow?: string[];
provider?: string;
model?: string;
extraSystemPrompt?: string;
/** Use the bounded subagent prompt instead of the full conversation prompt. */
promptMode?: "minimal";
lane?: string;
lightContext?: boolean;
deliver?: boolean;
/** Deliver the completion to the authenticated requester of the current hook invocation. */
completionDelivery?: "current-requester";
idempotencyKey?: string;
cwd?: string;
};
type SubagentCompleteParams = {
agentId: string;
message: string;
extraSystemPrompt?: string;
model?: string;
timeoutMs?: number;
signal?: AbortSignal;
};
type PluginManagedWorktree = {
id: string;
path: string;
branch: string;
};
type SubagentRunResult = {
runId: string;
/** Canonical accepted session identity. Optional for explicit/custom runtimes. */
sessionKey?: string;
runtime?: {
harness: string;
provider: string;
model: string;
};
};
type SubagentWaitParams = {
runId: string;
timeoutMs?: number;
};
type SubagentGetSessionMessagesParams = {
sessionKey: string;
limit?: number;
};
type SubagentGetSessionMessagesResult = {
messages: unknown[];
};
type SubagentDeleteSessionParams = {
sessionKey: string;
deleteTranscript?: boolean;
};
type RuntimeNodeListParams = {
connected?: boolean;
};
type RuntimeNodeListResult = {
nodes: Array<{
nodeId: string;
displayName?: string;
platform?: string;
clientId?: string;
remoteIp?: string;
connected?: boolean;
connectedAtMs?: number;
lastSeenAtMs?: number;
caps?: string[];
commands?: string[];
/** True only for the node host installed alongside this Gateway. */
gatewayLocal?: boolean;
/** Advertised commands currently permitted by Gateway node-command policy. */
invocableCommands?: string[];
nodePluginTools?: NodePluginToolDescriptor[];
}>;
};
type RuntimeNodeInvokeParams = {
nodeId: string;
command: string;
params?: unknown;
timeoutMs?: number;
idempotencyKey?: string;
sessionKey?: string;
/** Cancel the invocation and any work already dispatched to a first-party node. */
signal?: AbortSignal;
/** Requested Gateway scopes. Honored only for bundled or trusted official plugins. */
scopes?: OperatorScope[];
};
/** A lifecycle-bound, complete-message binary channel for one node invocation. */
type RuntimeNodeDuplexChannel = {
send: (message: Uint8Array) => Promise<void>;
onMessage: (listener: (message: Uint8Array) => void | Promise<void>) => () => void;
closed: Promise<unknown>;
close: () => void;
};
type RuntimeGatewayRequestOptions = {
timeoutMs?: number;
/** Requested Gateway scopes. Honored only for bundled or trusted official plugins. */
scopes?: OperatorScope[];
};
/** Trusted in-process runtime surface injected into native plugins. */
type PluginRuntime = PluginRuntimeCore & {
gateway: {
/** Whether this process owns an active Gateway request context. */
isAvailable: () => Promise<boolean>;
/** Dispatch a Gateway method as the current trusted plugin. */
request: <T = unknown>(method: string, params?: Record<string, unknown>, options?: RuntimeGatewayRequestOptions) => Promise<T>;
};
subagent: {
/** Fresh, tool-free background inference under the existing subagent model policy. */
complete: (params: SubagentCompleteParams) => Promise<{
text: string;
}>;
run: (params: SubagentRunParams) => Promise<SubagentRunResult>;
waitForRun: (params: SubagentWaitParams) => Promise<AgentWaitResult>;
getSessionMessages: (params: SubagentGetSessionMessagesParams) => Promise<SubagentGetSessionMessagesResult>;
deleteSession: (params: SubagentDeleteSessionParams) => Promise<void>;
};
nodes: {
list: (params?: RuntimeNodeListParams) => Promise<RuntimeNodeListResult>;
invoke: (params: RuntimeNodeInvokeParams) => Promise<unknown>;
/** Open a connection-scoped binary node command inside the trusted Gateway runtime. */
openDuplex: (params: RuntimeNodeInvokeParams & {
maxMessageBytes?: number;
maxOutstandingDeliveryBytes?: number;
}) => Promise<RuntimeNodeDuplexChannel>;
};
sandbox: {
resolveWorkspaceAuthority: (params: {
config: OpenClawConfig;
agentId?: string;
confinedToolNames?: readonly string[];
requiredToolNames?: readonly string[];
modelProvider?: string;
modelId?: string;
sessionKey: string;
}) => {
sandboxed: boolean;
workspaceAccess: "none" | "ro" | "rw";
confinementError?: string;
};
prepareWorkspaceAuthority: (params: {
config: OpenClawConfig;
agentId?: string;
confinedToolNames?: readonly string[];
requiredToolNames?: readonly string[];
modelProvider?: string;
modelId?: string;
sessionKey: string;
workspaceDir: string;
}) => Promise<{
sandboxed: boolean;
workspaceAccess: "none" | "ro" | "rw";
confinementError?: string;
}>;
};
worktrees: {
resolveCheckoutRoot: (params: {
path: string;
}) => Promise<string | undefined>;
hasSelfContainedCheckoutMetadata?: (params: {
path: string;
}) => Promise<boolean>;
create: (params: {
repoRoot: string;
name: string;
baseRef?: string;
ownerKind: "workboard";
ownerId: string;
commitGuard?: () => void;
}) => Promise<PluginManagedWorktree>;
release: (params: {
path: string;
}) => Promise<void>;
removeIfLossless: (params: {
path: string;
ownerKind: "workboard";
ownerId: string;
}) => Promise<boolean>;
};
channel: PluginRuntimeChannel;
};
type CreatePluginRuntimeOptions = {
dispatchReplyFromConfig?: PluginRuntime["channel"]["reply"]["dispatchReplyFromConfig"];
gateway?: PluginRuntime["gateway"];
hooks?: PluginRuntime["hooks"];
subagent?: PluginRuntime["subagent"];
nodes?: PluginRuntime["nodes"];
/** Native policy facades avoid re-evaluating SDK dependencies during registration. */
modelAuth?: PluginRuntime["modelAuth"];
modelConfig?: PluginRuntime["modelConfig"];
allowGatewaySubagentBinding?: boolean;
};
//#endregion
//#region src/plugin-sdk/channel-send-result.d.ts
/**
* Legacy raw send result shape accepted from channel SDK adapters.
* @deprecated Return `OutboundDeliveryResult` and use
* `createAttachedChannelResultAdapter`. Removal with the next plugin-SDK major.
*/
type ChannelSendRawResult = {
/** Whether the channel send operation succeeded. */
ok: boolean;
/** Platform message id; null/undefined normalizes to the empty-id sentinel. */
messageId?: string | null;
/** Legacy error text converted to an Error for outbound callers. */
error?: string | null;
};
/** Attaches the channel id to a single outbound send result. */
declare function attachChannelToResult<T extends object>(
/** Channel id to stamp onto the returned delivery result. */
channel: string,
/** Delivery-shaped result without channel metadata. */
result: T): T & {
channel: string;
};
/** Attaches the channel id to each outbound send result in order. */
declare function attachChannelToResults<T extends object>(
/** Channel id to stamp onto every returned delivery result. */
channel: string,
/** Ordered delivery-shaped results without channel metadata. */
results: readonly T[]): (T & {
channel: string;
})[];
/** Creates an empty outbound delivery result for send paths that produced no platform id. */
declare function createEmptyChannelResult(
/** Channel id attached to the synthetic empty result. */
channel: string,
/** Additional delivery metadata to preserve alongside the empty message id. */
result?: Partial<Omit<OutboundDeliveryResult, "channel" | "messageId">> & {
messageId?: string;
}): OutboundDeliveryResult;
type MaybePromise<T> = T | Promise<T>;
type SendTextParams = Parameters<NonNullable<ChannelOutboundAdapter["sendText"]>>[0];
type SendMediaParams = Parameters<NonNullable<ChannelOutboundAdapter["sendMedia"]>>[0];
type SendPollParams = Parameters<NonNullable<ChannelOutboundAdapter["sendPoll"]>>[0];
/** Wraps outbound send methods that already return delivery-shaped results without channel ids. */
declare function createAttachedChannelResultAdapter(params: {
/** Channel id attached to every wrapped send result. */
channel: string;
/** Text sender that returns an outbound result without channel metadata. */
sendText?: (ctx: SendTextParams) => MaybePromise<Omit<OutboundDeliveryResult, "channel">>;
/** Media sender that returns an outbound result without channel metadata. */
sendMedia?: (ctx: SendMediaParams) => MaybePromise<Omit<OutboundDeliveryResult, "channel">>;
/** Poll sender that returns a poll result without channel metadata. */
sendPoll?: (ctx: SendPollParams) => MaybePromise<Omit<ChannelPollResult, "channel">>;
}): Pick<ChannelOutboundAdapter, "sendText" | "sendMedia" | "sendPoll">;
/** Wraps legacy raw text/media send methods and normalizes their results. */
declare function createRawChannelSendResultAdapter(params: {
/** Channel id attached to every normalized legacy send result. */
channel: string;
/** Legacy text sender that returns ok/messageId/error fields. */
sendText?: (ctx: SendTextParams) => MaybePromise<ChannelSendRawResult>;
/** Legacy media sender that returns ok/messageId/error fields. */
sendMedia?: (ctx: SendMediaParams) => MaybePromise<ChannelSendRawResult>;
}): Pick<ChannelOutboundAdapter, "sendText" | "sendMedia">;
/** Normalize raw channel send results into the shape shared outbound callers expect. */
declare function buildChannelSendResult(
/** Channel id attached to the normalized delivery result. */
channel: string,
/** Legacy raw channel result to normalize. */
result: ChannelSendRawResult): {
channel: string;
ok: boolean;
messageId: string;
error: Error | undefined;
};
//#endregion
//#region src/plugin-sdk/plugin-entry.d.ts
type ProviderBuiltInModelSuppressionContext = ProviderBuiltInModelSuppressionContext$1;
/** Options for a plugin entry that registers providers, tools, commands, or services. */
type DefinePluginEntryOptions = {
id: string;
name: string;
description: string;
/**
* @deprecated Declare exclusive plugin kind in `openclaw.plugin.json` via
* manifest `kind`. Runtime-entry `kind` remains only as a compatibility
* fallback for older plugins.
*/
kind?: OpenClawPluginDefinition["kind"];
configSchema?: OpenClawPluginConfigSchema | (() => OpenClawPluginConfigSchema);
reload?: OpenClawPluginDefinition["reload"];
nodeHostCommands?: OpenClawPluginDefinition["nodeHostCommands"];
securityAuditCollectors?: OpenClawPluginDefinition["securityAuditCollectors"];
register: NonNullable<OpenClawPluginDefinition["register"]>;
};
/** Normalized object shape that OpenClaw loads from a plugin entry module. */
type DefinedPluginEntry = Omit<DefinePluginEntryOptions, "configSchema"> & {
configSchema: OpenClawPluginConfigSchema;
};
/**
* Canonical entry helper for non-channel plugins.
*
* Use this for provider, tool, command, service, memory, and context-engine
* plugins. Channel plugins should use `defineChannelPluginEntry(...)` from
* `openclaw/plugin-sdk/core` so they inherit the channel capability wiring.
*
* @experimental Pin and test OpenClaw host versions; existing compatibility windows still apply.
*/
declare function definePluginEntry({ id, name, description, kind, configSchema, reload, nodeHostCommands, securityAuditCollectors, register }: DefinePluginEntryOptions): DefinedPluginEntry;
//#endregion
//#region src/plugin-sdk/keyed-async-queue.d.ts
/** Optional lifecycle hooks fired around each queued task. */
type KeyedAsyncQueueHooks = {
onEnqueue?: () => void;
onSettle?: () => void;
};
/** Serialize async work per key while allowing unrelated keys to run concurrently. */
declare function enqueueKeyedTask<T>(params: {
tails: Map<string, Promise<void>>;
key: string;
task: () => Promise<T>;
hooks?: KeyedAsyncQueueHooks;
}): Promise<T>;
/** Small per-key async queue wrapper for plugin runtimes that need serialized work. */
declare class KeyedAsyncQueue {
private readonly tails;
/**
* @deprecated Retained for shipped Plugin SDK compatibility. New callers must
* not depend on queue storage; remove in a declared Plugin SDK breaking window.
*/
getTailMapForTesting(): Map<string, Promise<void>>;
enqueue<T>(key: string, task: () => Promise<T>, hooks?: KeyedAsyncQueueHooks): Promise<T>;
}
//#endregion
//#region src/infra/dedupe.d.ts
/** Small in-memory TTL/LRU-style cache for replay and duplicate suppression. */
type DedupeCache = {
/** Returns true for a recent duplicate; records the key and optional owner when absent. */
check: (key: string | undefined | null, now?: number, ownerToken?: object) => boolean;
/** Returns true for a recent duplicate without refreshing or recording the key. */
peek: (key: string | undefined | null, now?: number) => boolean;
delete: (key: string | undefined | null, ownerToken?: object) => void;
clear: () => void;
size: () => number;
};
/** Dedupe cache bounds; ttlMs <= 0 disables expiry, maxSize <= 0 disables storage. */
type DedupeCacheOptions = {
ttlMs: number;
maxSize: number;
};
/** Creates a bounded in-memory dedupe cache with optional TTL expiry. */
declare function createDedupeCache(options: DedupeCacheOptions): DedupeCache;
/** Resolves a process-global dedupe cache for hot paths that can load this module twice. */
declare function resolveGlobalDedupeCache(key: symbol, options: DedupeCacheOptions): DedupeCache;
//#endregion
//#region src/infra/secure-random.d.ts
/** Generates a cryptographically secure UUID for runtime ids and cache keys. */
declare function generateSecureUuid(): string;
/** Generates a URL-safe cryptographic token from the requested byte count. */
declare function generateSecureToken(options: {
bytes?: number;
redact: true;
}): string;
declare function generateSecureToken(bytes?: number): string;
/** Generates a hex-encoded cryptographic token from the requested byte count. */
declare function generateSecureHex(bytes?: number): string;
/** Returns a cryptographically secure fraction in the range [0, 1). */
declare function generateSecureFraction(): number;
/** Generates a cryptographically secure integer in `[0, maxExclusive)`. */
declare function generateSecureInt(maxExclusive: number): number;
/** Generates a cryptographically secure integer in `[minInclusive, maxExclusive)`. */
declare function generateSecureInt(minInclusive: number, maxExclusive: number): number;
//#endregion
//#region src/shared/tailscale-status.d.ts
type TailscaleStatusCommandResult = {
code: number | null;
stdout: string;
};
type TailscaleStatusCommandRunner = (argv: string[], opts: {
timeoutMs: number;
}) => Promise<TailscaleStatusCommandResult>;
/** Resolves the host published to clients for tailnet or Tailscale Serve gateway modes. */
declare function resolveTailscalePublishedHost(params: {
tailscaleMode: string;
tailnetHost: string | null;
/** @deprecated Managed Gateway ingress no longer supports named Services. */
serviceName?: string | null;
}): string | null;
/** Runs known Tailscale status commands and returns the first DNS name or tailnet IP found. */
declare function resolveTailnetHostWithRunner(runCommandWithTimeout?: TailscaleStatusCommandRunner): Promise<string | null>;
/** Finds persistent HTTPS Serve routes whose root proxy targets this gateway port. */
declare function resolveTailscaleServeGatewayUrlsWithRunner(gatewayPort: number, runCommandWithTimeout?: TailscaleStatusCommandRunner): Promise<string[]>;
//#endregion
//#region src/context-engine/delegate.d.ts
/**
* Delegate a context-engine compaction request to OpenClaw's built-in runtime compaction path.
*
* This is the same bridge used by the legacy context engine. Third-party
* engines can call it from their own `compact()` implementations when they do
* not own the compaction algorithm but still need `/compact` and overflow
* recovery to use the stock runtime behavior.
*
* Note: `compactionTarget` is part of the public `compact()` contract, but the
* built-in runtime compaction path does not expose that knob. This helper
* ignores it to preserve legacy behavior; engines that need target-specific
* compaction should implement their own `compact()` algorithm.
*/
declare function delegateCompactionToRuntime(params: Parameters<ContextEngine["compact"]>[0]): Promise<CompactResult>;
declare function buildMemorySystemPromptAddition(params: MemoryPromptSectionParams): string | undefined;
/** Prepare memory state asynchronously, then render it without prompt-path I/O. */
declare function prepareMemorySystemPromptAddition(params: MemoryPromptSectionParams): Promise<string | undefined>;
//#endregion
//#region src/shared/gateway-bind-url.d.ts
type GatewayBindUrlResult = {
url: string;
source: "gateway.bind=custom" | "gateway.bind=tailnet" | "gateway.bind=lan";
} | {
error: string;
} | null;
/** Resolves the externally advertised gateway URL for non-loopback bind modes. */
declare function resolveGatewayBindUrl(params: {
bind?: string;
customBindHost?: string;
scheme: "ws" | "wss";
port: number;
pickTailnetHost: () => string | null;
pickLanHost: () => string | null;
}): GatewayBindUrlResult;
//#endregion
//#region src/infra/format-time/format-datetime.d.ts
type FormatTimestampOptions = {
/** Include seconds in the output. Default: false */
displaySeconds?: boolean;
};
type FormatZonedTimestampOptions = FormatTimestampOptions & {
/** IANA timezone string (e.g., 'America/New_York'). Default: system timezone */
timeZone?: string;
/** Include an abbreviated weekday before the date. Default: false */
displayWeekday?: boolean;
};
/**
* Format a Date with timezone display using Intl.DateTimeFormat.
*
* Without seconds: `2024-01-15 14:30 EST`
* With seconds: `2024-01-15 14:30:05 EST`
*
* Returns undefined if Intl formatting fails.
*/
declare function formatZonedTimestamp(date: Date, options?: FormatZonedTimestampOptions): string | undefined;
//#endregion
//#region src/acp/persistent-bindings.resolve.d.ts
/** Resolves a configured ACP binding for a concrete channel conversation. */
declare function resolveConfiguredAcpBindingRecord(params: {
cfg: OpenClawConfig;
channel: string;
accountId: string;
conversationId: string;
parentConversationId?: string;
}): ResolvedConfiguredAcpBinding | null;
//#endregion
//#region src/plugin-sdk/core.d.ts
/** Ensure a configured ACP binding has live runtime state before channel delivery uses it. */
declare function ensureConfiguredAcpBindingReady(params: {
cfg: OpenClawConfig;
configuredBinding: ResolvedConfiguredAcpBinding | null;
}): Promise<{
ok: true;
} | {
ok: false;
error: string;
}>;
/** Params passed to a channel adapter when resolving outbound session routing. */
type ChannelOutboundSessionRouteParams = Parameters<NonNullable<ChannelMessagingAdapter["resolveOutboundSessionRoute"]>>[0];
declare function getChatChannelMetaForSdk(id: ChatChannelId): ChannelMeta;
/** Remove one of the known provider prefixes from a free-form target string. */
declare function stripChannelTargetPrefix(raw: string, ...providers: string[]): string;
/** Remove generic target-kind prefixes such as `user:` or `group:`. */
declare function stripTargetKindPrefix(raw: string): string;
/**
* Build the canonical outbound session route payload returned by channel
* message adapters.
*/
declare function buildChannelOutboundSessionRoute(params: {
cfg: OpenClawConfig;
agentId: string;
channel: string;
accountId?: string | null;
recipientSessionExact?: boolean | "direct-alias" | "delivery-identity";
peer: {
kind: "direct" | "group" | "channel";
id: string;
};
chatType: "direct" | "group" | "channel";
from: string;
to: string;
threadId?: string | number;
}): ChannelOutboundSessionRoute;
/** Candidate source used when choosing a thread id for outbound session routing. */
type ThreadAwareOutboundSessionRouteThreadSource = "replyToId" | "threadId" | "currentSession";
/** Recovery context passed before reusing the current session thread id. */
type ThreadAwareOutboundSessionRouteRecoveryContext = {
route: ChannelOutboundSessionRoute;
currentBaseSessionKey: string;
currentThreadId: string;
};
/** Recover the current thread id when the current session belongs to the same base route. */
declare function recoverCurrentThreadSessionId(params: {
route: ChannelOutboundSessionRoute;
currentSessionKey?: string | null;
canRecover?: (context: ThreadAwareOutboundSessionRouteRecoveryContext) => boolean;
}): string | undefined;
/** Add thread-aware session keys and route thread ids to an outbound channel route. */
declare function buildThreadAwareOutboundSessionRoute(params: {
route: ChannelOutboundSessionRoute;
replyToId?: string | number | null;
threadId?: string | number | null;
currentSessionKey?: string | null;
precedence?: readonly ThreadAwareOutboundSessionRouteThreadSource[];
useSuffix?: boolean;
parentSessionKey?: string;
normalizeThreadId?: (threadId: string) => string;
canRecoverCurrentThread?: (context: ThreadAwareOutboundSessionRouteRecoveryContext) => boolean;
}): ChannelOutboundSessionRoute;
/** Options for a channel plugin entry that should register a channel capability. */
type ChannelEntryConfigSchema<TPlugin> = TPlugin extends ChannelPlugin$3<unknown> ? NonNullable<TPlugin["configSchema"]> : ChannelConfigSchema;
type DefineChannelPluginEntryOptions<TPlugin = ChannelPlugin$3> = {
id: string;
name: string;
description: string;
plugin: TPlugin;
configSchema?: ChannelEntryConfigSchema<TPlugin> | (() => ChannelEntryConfigSchema<TPlugin>);
setRuntime?: (runtime: PluginRuntime) => void;
registerCliMetadata?: (api: OpenClawPluginApi) => void;
registerFull?: (api: OpenClawPluginApi) => void;
registerCapabilities?: (api: OpenClawPluginApi) => void;
};
type DefinedChannelPluginEntry<TPlugin> = {
id: string;
name: string;
description: string;
configSchema: ChannelConfigSchema;
register: (api: OpenClawPluginApi) => void;
channelPlugin: TPlugin;
setChannelRuntime?: (runtime: PluginRuntime) => void;
};
type CreateChannelPluginBaseOptions<TResolvedAccount> = {
id: ChannelPlugin$3<TResolvedAccount>["id"];
meta?: Partial<NonNullable<ChannelPlugin$3<TResolvedAccount>["meta"]>>;
setupWizard?: NonNullable<ChannelPlugin$3<TResolvedAccount>["setupWizard"]>;
capabilities?: ChannelPlugin$3<TResolvedAccount>["capabilities"];
commands?: ChannelPlugin$3<TResolvedAccount>["commands"];
doctor?: ChannelPlugin$3<TResolvedAccount>["doctor"];
agentPrompt?: ChannelPlugin$3<TResolvedAccount>["agentPrompt"];
streaming?: ChannelPlugin$3<TResolvedAccount>["streaming"];
reload?: ChannelPlugin$3<TResolvedAccount>["reload"];
gatewayMethods?: ChannelPlugin$3<TResolvedAccount>["gatewayMethods"];
gatewayMethodDescriptors?: ChannelPlugin$3<TResolvedAccount>["gatewayMethodDescriptors"];
configSchema?: ChannelPlugin$3<TResolvedAccount>["configSchema"];
config?: ChannelPlugin$3<TResolvedAccount>["config"];
security?: ChannelPlugin$3<TResolvedAccount>["security"];
setup?: NonNullable<ChannelPlugin$3<TResolvedAccount>["setup"]>;
setupContract?: NonNullable<ChannelPlugin$3<TResolvedAccount>["setupContract"]>;
groups?: ChannelPlugin$3<TResolvedAccount>["groups"];
};
type CreatedChannelPluginBase<TResolvedAccount> = Pick<ChannelPlugin$3<TResolvedAccount>, "id" | "meta"> & Partial<Pick<ChannelPlugin$3<TResolvedAccount>, Exclude<keyof CreateChannelPluginBaseOptions<TResolvedAccount>, "id" | "meta">>>;
/**
* Canonical entry helper for channel plugins.
*
* Registers the channel capability and optionally exposes full-runtime hooks
* such as tools or gateway handlers outside setup-only registration modes.
*/
declare function defineChannelPluginEntry<TPlugin>({ id, name, description, plugin, configSchema, setRuntime, registerCliMetadata, registerFull, registerCapabilities }: DefineChannelPluginEntryOptions<TPlugin>): DefinedChannelPluginEntry<TPlugin>;
/**
* Minimal setup-entry helper for channels that ship a separate `setup-entry.ts`.
*
* The setup entry only needs to export `{ plugin }`, but using this helper
* keeps the shape explicit in examples and generated typings.
*/
declare function defineSetupPluginEntry<TPlugin>(plugin: TPlugin): {
plugin: TPlugin;
};
type ChatChannelPluginBase<TResolvedAccount, Probe, Audit> = Omit<ChannelPlugin$3<TResolvedAccount, Probe, Audit>, "capabilities" | "security" | "pairing" | "threading" | "outbound"> & Partial<Pick<ChannelPlugin$3<TResolvedAccount, Probe, Audit>, "capabilities" | "security" | "pairing" | "threading" | "outbound">>;
type ChatChannelSecurityOptions<TResolvedAccount extends {
accountId?: string | null;
}> = {
dm: {
channelKey: string;
resolvePolicy: (account: TResolvedAccount) => string | null | undefined;
resolveAllowFrom: (account: TResolvedAccount) => Array<string | number> | null | undefined;
resolveFallbackAccountId?: (account: TResolvedAccount) => string | null | undefined;
defaultPolicy?: string;
allowFromPathSuffix?: string;
policyPathSuffix?: string;
approveChannelId?: string;
approveHint?: string;
normalizeEntry?: (raw: string) => string;
classifyEntryAuthentication?: ChannelSecurityDmPolicy["classifyEntryAuthentication"];
inheritSharedDefaultsFromDefaultAccount?: boolean;
};
dmRouting?: ChannelSecurityAdapter<TResolvedAccount>["dmRouting"];
collectWarnings?: ChannelSecurityAdapter<TResolvedAccount>["collectWarnings"];
collectAuditFindings?: ChannelSecurityAdapter<TResolvedAccount>["collectAuditFindings"];
};
type ChatChannelPairingOptions = {
text: {
idLabel: string;
message: string;
normalizeAllowEntry?: ChannelPairingAdapter["normalizeAllowEntry"];
notify: (params: Parameters<NonNullable<ChannelPairingAdapter["notifyApproval"]>>[0] & {
message: string;
}) => Promise<void> | void;
};
};
type ChatChannelThreadingReplyModeOptions<TResolvedAccount> = {
topLevelReplyToMode: string;
} | {
scopedAccountReplyToMode: {
resolveAccount: (cfg: OpenClawConfig, accountId?: string | null) => TResolvedAccount;
resolveReplyToMode: (account: TResolvedAccount, chatType?: string | null) => ReplyToMode | null | undefined;
fallback?: ReplyToMode;
};
} | {
resolveReplyToMode: NonNullable<ChannelThreadingAdapter["resolveReplyToMode"]>;
};
type ChatChannelThreadingOptions<TResolvedAccount> = ChatChannelThreadingReplyModeOptions<TResolvedAccount> & Omit<ChannelThreadingAdapter, "resolveReplyToMode">;
type ChatChannelAttachedOutboundOptions = {
base: Omit<ChannelOutboundAdapter, "sendText" | "sendMedia" | "sendPoll">;
attachedResults: Parameters<typeof createAttachedChannelResultAdapter>[0];
};
/**
* Build a chat-style channel plugin by composing common security, pairing,
* threading, and outbound adapters around a channel-specific base.
*/
declare function createChatChannelPlugin<TResolvedAccount extends {
accountId?: string | null;
}, Probe = unknown, Audit = unknown>(params: {
base: ChatChannelPluginBase<TResolvedAccount, Probe, Audit>;
security?: ChannelSecurityAdapter<TResolvedAccount> | ChatChannelSecurityOptions<TResolvedAccount>;
pairing?: ChannelPairingAdapter | ChatChannelPairingOptions;
threading?: ChannelThreadingAdapter | ChatChannelThreadingOptions<TResolvedAccount>;
outbound?: ChannelOutboundAdapter | ChatChannelAttachedOutboundOptions;
}): ChannelPlugin$3<TResolvedAccount, Probe, Audit>;
/** Create the shared base object for channel plugins that override only selected surfaces. */
declare function createChannelPluginBase<TResolvedAccount>(params: CreateChannelPluginBaseOptions<TResolvedAccount>): CreatedChannelPluginBase<TResolvedAccount>;
//#endregion
//#region src/agents/embedded-agent-runner/active-run-projections.d.ts
/** Resolves the current session id for an active run after resets or compaction. */
declare function resolveActiveEmbeddedRunSessionId(sessionKey: string): string | undefined;
//#endregion
//#region src/agents/embedded-agent-runner/run-state.d.ts
type EmbeddedAgentQueueHandle = {
kind?: "embedded";
runId?: string;
/** Exact process-local diagnostic lifecycle shared with this handle's model wrapper. */
readonly diagnosticOwner?: DiagnosticEmbeddedRunOwner;
/** Synchronously closes diagnostic authority before this handle is evicted. */
readonly closeDiagnostics?: () => void;
/** Core run start time used by live recovery projections. */
startedAtMs?: number;
/** Exact authority of the concrete provider/model attempt behind this handle. */
toolAuthorityFingerprint?: string;
/** Shared outer-run owner survives an intentional native-turn replacement. */
permissionChangeOwner?: object;
/** Fences prior tools, revokes their approvals, then acknowledges installed permissions. */
applyPermissionMode?: (mode: SessionPermissionMode | null, revokeApprovals: () => void) => Promise<boolean>;
/** Atomically consumes one plain-text answer for this run's pending user-input request. */
claimPendingUserInputAnswer?: (text: string, options?: EmbeddedAgentQueueMessageOptions) => Promise<boolean>;
/** Cancels this run's pending user-input request before an image is queued as a later turn. */
cancelPendingUserInput?: (resolvedBy: string) => Promise<boolean>;
/** Exact heartbeat owner retained after its reply-operation registration clears. */
readonly preemptByVisibleTurn?: () => boolean;
queueMessage: (text: string, options?: EmbeddedAgentQueueMessageOptions) => Promise<void | EmbeddedAgentQueueMessageResult>;
messageInjection?: ReplyBackendMessageInjection;
messageInjectionV2?: ReplyBackendMessageInjectionV2;
isStreaming: () => boolean;
isStopped?: () => boolean;
/** True after this handle has accepted an abort, even while cleanup retains it. */
isAborted?: () => boolean;
/** True only while this exact runtime owns a live wait, not unresolved host work or cleanup. */
ownsLiveness?: () => boolean;
isAbortable?: () => boolean;
isCompacting: () => boolean;
supportsTranscriptCommitWait?: boolean;
/** True only when queueMessage preserves images supplied in its options. */
supportsQueueMessageImages?: boolean;
cancel?: (reason?: "user_abort" | "restart" | "superseded") => void;
abort: (reason?: "restart") => void;
sourceReplyDeliveryMode?: SourceReplyDeliveryMode;
terminalReplyExpectation?: ReplyExpectation;
taskSuggestionDeliveryMode?: TaskSuggestionDeliveryMode;
};
type EmbeddedAgentQueueMessageOptions = ReplyBackendQueueMessageOptions;
type EmbeddedAgentQueueMessageResult = ReplyBackendQueueMessageResult;
//#endregion
//#region src/agents/embedded-agent-runner/runs.d.ts
/**
* Abort embedded OpenClaw runs.
*
* - With a sessionId, aborts that single run.
* - With no sessionId, supports targeted abort modes (for example, compacting runs only).
*/
declare function abortEmbeddedAgentRun(sessionId: string): boolean;
declare function abortEmbeddedAgentRun(sessionId: undefined, opts: {
mode: "all" | "compacting";
reason?: "restart";
}): boolean;
type AbortAndDrainEmbeddedAgentRunResult = {
aborted: boolean;
drained: boolean;
forceCleared: boolean;
};
declare function abortAndDrainEmbeddedAgentRun(params: {
sessionId: string;
sessionKey?: string;
settleMs?: number;
forceClear?: boolean;
reason?: string;
}): Promise<AbortAndDrainEmbeddedAgentRunResult>;
declare function setActiveEmbeddedRun(sessionId: string, handle: EmbeddedAgentQueueHandle, sessionKey?: string, sessionFile?: string, agentId?: string): void;
declare function clearActiveEmbeddedRun(sessionId: string, handle: EmbeddedAgentQueueHandle, sessionKey?: string, sessionFile?: string, reason?: string): void;
//#endregion
//#region src/agents/cli-credentials.d.ts
/** Credential shape parsed from Codex CLI storage. */
type CodexCliCredential = {
type: "oauth";
provider: OAuthProvider;
access: string;
refresh: string;
expires: number;
accountId?: string;
idToken?: string;
};
type ExecSyncFn = typeof execSync;
/** Reads Codex CLI credentials with optional short-lived cache and file fingerprinting. */
declare function readCodexCliCredentialsCached(options?: {
codexHome?: string;
allowKeychainPrompt?: boolean;
ttlMs?: number;
platform?: NodeJS.Platform;
execSync?: ExecSyncFn;
}): CodexCliCredential | null;
//#endregion
//#region src/plugins/providers.runtime.d.ts
declare const { isPluginProvidersLoadInFlight, resolvePluginProviderRegistryCore, resolvePluginProvidersCore }: Readonly<{
isPluginProvidersLoadInFlight: (params: Parameters<(params: Parameters<(params: {
config?: PluginLoadOptions["config"];
workspaceDir?: string;
env?: PluginLoadOptions["env"];
bundledProviderVitestCompat?: boolean;
onlyPluginIds?: string[];
providerRefs?: readonly string[];
modelRefs?: readonly string[];
activate?: boolean;
cache?: boolean;
applyAutoEnable?: boolean;
pluginSdkResolution?: PluginLoadOptions["pluginSdkResolution"];
mode?: "runtime" | "setup";
includeUntrustedWorkspacePlugins?: boolean;
pluginMetadataSnapshot?: PluginMetadataRegistryView;
skipIfLoadInFlight?: boolean;
registryScope?: "exact" | "loaded";
}) => ReturnType<(registry: PluginRegistry, base: ReturnType<(params: {
config?: PluginLoadOptions["config"];
workspaceDir?: string;
env?: PluginLoadOptions["env"];
bundledProviderVitestCompat?: boolean;
onlyPluginIds?: string[];
providerRefs?: readonly string[];
modelRefs?: readonly string[];
activate?: boolean;
cache?: boolean;
applyAutoEnable?: boolean;
pluginSdkResolution?: PluginLoadOptions["pluginSdkResolution"];
mode?: "runtime" | "setup";
includeUntrustedWorkspacePlugins?: boolean;
pluginMetadataSnapshot?: PluginMetadataRegistryView;
skipIfLoadInFlight?: boolean;
registryScope?: "exact" | "loaded";
} & {
env: NodeJS.ProcessEnv;
}, manifestRegistry?: PluginLoadOptions["manifestRegistry"], declaredProviderOwners?: DeclaredProviderOwnerIndex, retained?: boolean) => {
pluginIds: string[] | undefined;
workspaceDir: string | undefined;
manifestRegistry: PluginManifestRegistry | undefined;
onlyPluginIds: string[] | undefined;
providerRefs: readonly string[] | undefined;
projectedPluginIds: string[] | undefined;
declaredProviderOwners: DeclaredProviderOwnerIndex;
providerOwners: {
provider: string;
ownerPluginIds: string[];
providerPluginIds: string[];
runtimePluginIds: string[];
}[];
providerRegistrationPluginIds: Set<string> | undefined;
runtimeRegistrationPluginIds: Set<string> | undefined;
unownedProviderRefs: readonly string[];
explicitOwnerPluginIds: string[];
}>, onlyPluginIds?: readonly string[]) => {
registry: PluginRegistry;
workspaceDir: string | undefined;
onlyPluginIds: readonly string[] | undefined;
isProviderOwnerEligible: (pluginId: string, provider: string) => boolean;
}> | undefined>[0], onSelectedRegistry?: (registry: PluginRegistry) => ((provider: ProviderPlugin, pluginId: string) => ProviderPlugin) | undefined) => ProviderPlugin[]>[0]) => boolean;
resolvePluginProviderRegistryCore: (params: {
config?: PluginLoadOptions["config"];
workspaceDir?: string;
env?: PluginLoadOptions["env"];
bundledProviderVitestCompat?: boolean;
onlyPluginIds?: string[];
providerRefs?: readonly string[];
modelRefs?: readonly string[];
activate?: boolean;
cache?: boolean;
applyAutoEnable?: boolean;
pluginSdkResolution?: PluginLoadOptions["pluginSdkResolution"];
mode?: "runtime" | "setup";
includeUntrustedWorkspacePlugins?: boolean;
pluginMetadataSnapshot?: PluginMetadataRegistryView;
skipIfLoadInFlight?: boolean;
registryScope?: "exact" | "loaded";
}) => ReturnType<(registry: PluginRegistry, base: ReturnType<(params: {
config?: PluginLoadOptions["config"];
workspaceDir?: string;
env?: PluginLoadOptions["env"];
bundledProviderVitestCompat?: boolean;
onlyPluginIds?: string[];
providerRefs?: readonly string[];
modelRefs?: readonly string[];
activate?: boolean;
cache?: boolean;
applyAutoEnable?: boolean;
pluginSdkResolution?: PluginLoadOptions["pluginSdkResolution"];
mode?: "runtime" | "setup";
includeUntrustedWorkspacePlugins?: boolean;
pluginMetadataSnapshot?: PluginMetadataRegistryView;
skipIfLoadInFlight?: boolean;
registryScope?: "exact" | "loaded";
} & {
env: NodeJS.ProcessEnv;
}, manifestRegistry?: PluginLoadOptions["manifestRegistry"], declaredProviderOwners?: DeclaredProviderOwnerIndex, retained?: boolean) => {
pluginIds: string[] | undefined;
workspaceDir: string | undefined;
manifestRegistry: PluginManifestRegistry | undefined;
onlyPluginIds: string[] | undefined;
providerRefs: readonly string[] | undefined;
projectedPluginIds: string[] | undefined;
declaredProviderOwners: DeclaredProviderOwnerIndex;
providerOwners: {
provider: string;
ownerPluginIds: string[];
providerPluginIds: string[];
runtimePluginIds: string[];
}[];
providerRegistrationPluginIds: Set<string> | undefined;
runtimeRegistrationPluginIds: Set<string> | undefined;
unownedProviderRefs: readonly string[];
explicitOwnerPluginIds: string[];
}>, onlyPluginIds?: readonly string[]) => {
registry: PluginRegistry;
workspaceDir: string | undefined;
onlyPluginIds: readonly string[] | undefined;
isProviderOwnerEligible: (pluginId: string, provider: string) => boolean;
}> | undefined;
resolvePluginProvidersCore: (params: Parameters<(params: {
config?: PluginLoadOptions["config"];
workspaceDir?: string;
env?: PluginLoadOptions["env"];
bundledProviderVitestCompat?: boolean;
onlyPluginIds?: string[];
providerRefs?: readonly string[];
modelRefs?: readonly string[];
activate?: boolean;
cache?: boolean;
applyAutoEnable?: boolean;
pluginSdkResolution?: PluginLoadOptions["pluginSdkResolution"];
mode?: "runtime" | "setup";
includeUntrustedWorkspacePlugins?: boolean;
pluginMetadataSnapshot?: PluginMetadataRegistryView;
skipIfLoadInFlight?: boolean;
registryScope?: "exact" | "loaded";
}) => ReturnType<(registry: PluginRegistry, base: ReturnType<(params: {
config?: PluginLoadOptions["config"];
workspaceDir?: string;
env?: PluginLoadOptions["env"];
bundledProviderVitestCompat?: boolean;
onlyPluginIds?: string[];
providerRefs?: readonly string[];
modelRefs?: readonly string[];
activate?: boolean;
cache?: boolean;
applyAutoEnable?: boolean;
pluginSdkResolution?: PluginLoadOptions["pluginSdkResolution"];
mode?: "runtime" | "setup";
includeUntrustedWorkspacePlugins?: boolean;
pluginMetadataSnapshot?: PluginMetadataRegistryView;
skipIfLoadInFlight?: boolean;
registryScope?: "exact" | "loaded";
} & {
env: NodeJS.ProcessEnv;
}, manifestRegistry?: PluginLoadOptions["manifestRegistry"], declaredProviderOwners?: DeclaredProviderOwnerIndex, retained?: boolean) => {
pluginIds: string[] | undefined;
workspaceDir: string | undefined;
manifestRegistry: PluginManifestRegistry | undefined;
onlyPluginIds: string[] | undefined;
providerRefs: readonly string[] | undefined;
projectedPluginIds: string[] | undefined;
declaredProviderOwners: DeclaredProviderOwnerIndex;
providerOwners: {
provider: string;
ownerPluginIds: string[];
providerPluginIds: string[];
runtimePluginIds: string[];
}[];
providerRegistrationPluginIds: Set<string> | undefined;
runtimeRegistrationPluginIds: Set<string> | undefined;
unownedProviderRefs: readonly string[];
explicitOwnerPluginIds: string[];
}>, onlyPluginIds?: readonly string[]) => {
registry: PluginRegistry;
workspaceDir: string | undefined;
onlyPluginIds: readonly string[] | undefined;
isProviderOwnerEligible: (pluginId: string, provider: string) => boolean;
}> | undefined>[0], onSelectedRegistry?: (registry: PluginRegistry) => ((provider: ProviderPlugin, pluginId: string) => ProviderPlugin) | undefined) => ProviderPlugin[];
}>;
//#endregion
//#region src/system-agent/operator-approval.d.ts
type SystemAgentProposalRef = {
current?: string;
operation?: SystemAgentOperation;
};
//#endregion
//#region src/agents/tools/system-agent-tool.d.ts
type SystemAgentToolOptions = {
/** Verified inference owner, distinct from the internal OpenClaw execution agent. */
agentId?: string;
/** Where setup side effects run; the gateway surface never manages its own daemon. */
surface: "cli" | "gateway";
/** The host resolves delegated proposals under session policy, never a chat reply. */
operatorApprovalOnly?: boolean;
/**
* Host-verified consent for THIS turn: true only when the host judged the
* user's actual message to be an explicit approval. The model-supplied
* `approved` argument alone must never authorize a mutation (prompt
* injection, model error).
*/
approvalArmed?: boolean;
/**
* Approval is scoped to one exact operation: a denied mutating call records
* its canonical hash here (host-owned, survives turns), and an armed turn
* may execute only a call matching that hash. Cleared after use.
*/
proposalRef?: SystemAgentProposalRef;
/**
* Host handoff channel for actions the tool cannot perform itself
* (interactive channel setup, external onboarding guidance, opening the
* agent TUI). The engine reads it after the turn; CLI MCP hosts mirror it
* from tool events.
*/
directiveRef?: {
current?: SystemAgentToolDirective;
};
};
/** Host directives the hosting chat engine handles after the turn. */
type SystemAgentToolDirective = SystemAgentNavigationOperation | {
kind: "approved-operation";
operation: SystemAgentOperation;
};
//#endregion
//#region src/agents/agent-tools.before-tool-call.state.d.ts
/** Consume and remove hook-adjusted params for a completed tool call. */
declare function consumeAdjustedParamsForToolCall(toolCallId: string, runId?: string): unknown;
/** Snapshot hook-adjusted params without consuming later outcome bookkeeping. */
declare function peekAdjustedParamsForToolCall(toolCallId: string, runId?: string): unknown;
/** Consume whether policy prevented the target tool from starting. */
declare function consumePreExecutionBlockedToolCall(toolCallId: string, runId?: string): boolean;
//#endregion
//#region src/agents/before-tool-call-metadata.d.ts
type BeforeToolCallDiagnosticOptions = {
emitDiagnostics: boolean;
protectNetworkErrors?: boolean;
approvalMode?: "request" | "report" | "deny";
};
/** Return true when a tool already carries the before_tool_call wrapper state. */
declare function isToolWrappedWithBeforeToolCallHook(tool: AnyAgentTool): boolean;
/** Toggle diagnostic event emission on an existing before_tool_call wrapper. */
declare function setBeforeToolCallDiagnosticsEnabled(tool: AnyAgentTool, enabled: boolean): void;
//#endregion
//#region src/agents/agent-tools.before-tool-call.diagnostics.d.ts
/** Finalizes a trusted terminal summary after harness result middleware. */
declare function finalizeToolTerminalPresentation(params: {
toolCallId: string;
runId?: string;
result: Awaited<ReturnType<AnyAgentTool["execute"]>>;
isError: boolean;
observer?: ToolOutcomeObserver;
toolName?: string;
toolCallOrdinal?: number;
}): void;
//#endregion
//#region src/agents/agent-tools.before-tool-call.approval.d.ts
/** Resolve a deferred plugin approval request at the later execution boundary. */
declare function requestDeferredPluginToolApproval(params: {
deferredApproval: DeferredPluginToolApproval;
signal?: AbortSignal;
}): Promise<HookOutcome>;
/** Notify plugin approval callbacks that a deferred approval was cancelled. */
declare function cancelDeferredPluginToolApproval(deferredApproval: DeferredPluginToolApproval): void;
//#endregion
//#region src/agents/agent-tools.before-tool-call.policy.d.ts
declare function getBeforeToolCallPolicyDiagnosticState(): BeforeToolCallPolicyDiagnosticState;
/** Return true when any before_tool_call policy could affect tool execution. */
declare function hasBeforeToolCallPolicy(): boolean;
declare function runBeforeToolCallHook(args: {
toolName: string;
params: unknown;
toolKind?: PluginHookToolKind;
toolInputKind?: PluginHookToolInputKind;
toolCallId?: string;
ctx?: HookContext;
signal?: AbortSignal;
approvalMode?: "request" | "report" | "deny" | "defer";
}): Promise<HookOutcome>;
//#endregion
//#region src/agents/agent-tools.before-tool-call.wrapper.d.ts
/** Return the closed terminal disposition carried by a before-tool failure. */
declare function getBeforeToolCallFailureDisposition(error: unknown): BeforeToolCallFailureDisposition | undefined;
/** Remember hook-adjusted params for later adapter-side execution. */
declare function recordAdjustedParamsForToolCall(toolCallId: string | undefined, params: unknown, runId?: string): void;
/** Record that one concrete core-owned tool call may use structured replay classification. */
declare function recordStructuredReplayTrustForToolCall(toolCallId: string | undefined, tool: AnyAgentTool, runId?: string): void;
declare function isPreExecutionBlockedToolResult(result: unknown): boolean;
/** Build the standard terminal result for vetoed tool calls. */
declare function buildBlockedToolResult(params: {
reason: string;
deniedReason?: HookBlockedReason;
toolCallId?: string;
runId?: string;
}): {
content: {
type: "text";
text: string;
}[];
details: {
status: string;
deniedReason: HookBlockedReason;
reason: string;
};
};
declare function wrapToolWithBeforeToolCallHook(tool: AnyAgentTool, ctx?: HookContext, options?: Partial<BeforeToolCallDiagnosticOptions>): AnyAgentTool;
/** Rebuild a before_tool_call wrapper while preserving the original source tool. */
declare function rewrapToolWithBeforeToolCallHook(tool: AnyAgentTool, ctx?: HookContext, options?: Partial<BeforeToolCallDiagnosticOptions>): AnyAgentTool;
declare namespace agent_tools_before_tool_call_d_exports {
export { BeforeToolCallFailureDisposition, BeforeToolCallPolicyDiagnosticState, DeferredPluginToolApproval, HookContext, ToolOutcomeObservation, ToolOutcomeObserver, buildBlockedToolResult, cancelDeferredPluginToolApproval, consumeAdjustedParamsForToolCall, consumePreExecutionBlockedToolCall, finalizeToolTerminalPresentation, getBeforeToolCallFailureDisposition, getBeforeToolCallPolicyDiagnosticState, hasBeforeToolCallPolicy, isPreExecutionBlockedToolResult, isToolWrappedWithBeforeToolCallHook, peekAdjustedParamsForToolCall, recordAdjustedParamsForToolCall, recordStructuredReplayTrustForToolCall, requestDeferredPluginToolApproval, rewrapToolWithBeforeToolCallHook, runBeforeToolCallHook, setBeforeToolCallDiagnosticsEnabled, wrapToolWithBeforeToolCallHook };
}
//#endregion
//#region src/agents/agent-tools.read.d.ts
type SkillInstructionDeliveryCache = Map<string, Promise<boolean>>;
//#endregion
//#region src/agents/core-tool-factory-descriptors.d.ts
type OpenClawCodingToolConstructionPlan = {
includeBaseCodingTools: boolean;
includeShellTools: boolean;
includeChannelTools: boolean;
includeOpenClawTools: boolean;
includePluginTools: boolean;
};
//#endregion
//#region src/agents/tools/question-prompt-send.d.ts
/** Publishes one prompt into the originating conversation. */
type QuestionPromptSend = (payload: ReplyPayload, options?: {
signal?: AbortSignal;
}) => void | Promise<void>;
/** A run's own way to show a question prompt, plus the channel it would appear in. */
type QuestionPromptDelivery = {
send: QuestionPromptSend;
messageChannel?: string;
};
//#endregion
//#region src/agents/openclaw-tools.types.d.ts
/** Options shared by the coding-tool factory and its OpenClaw tool surface. */
type OpenClawSharedToolsOptions = {
/**
* Overrides the originating-channel sender for blocking questions. An actual
* harness prompt reservation retains delivery ownership.
*/
questionPrompt?: QuestionPromptDelivery;
toolBindings?: Readonly<Record<string, unknown>>;
/** Trusted runtime-only authorization for one bounded cross-conversation recall pass. */
conversationRecall?: ConversationRecallContext;
/** Trusted platform-native conversation id for the active inbound turn. */
nativeChannelId?: string;
/** Producer-authored bare upload handles mapped to exact sandbox paths. */
stagedMediaPaths?: ReadonlyMap<string, string>;
/** Durable store key when it differs from the sandbox/policy session key. */
runSessionKey?: string;
/** Ephemeral session UUID — regenerated on /new and /reset. */
sessionId?: string;
/** One-shot local CLI runs release plugin-owned resources after their result. */
oneShotCliRun?: boolean;
runId?: string;
computerTransport?: ComputerToolTransport | null;
/** Current runtime directory used as the default project for follow-up suggestions. */
cwd?: string;
/**
* Workspace directory to pass to spawned subagents for inheritance.
* Defaults to workspaceDir. Use this to pass the actual agent workspace when the
* session itself is running in a copied-workspace sandbox (`ro` or `none`) so
* subagents inherit the real workspace path instead of the sandbox copy.
*/
spawnWorkspaceDir?: string;
config?: OpenClawConfig;
/** Gateway-owned session policy follows runtime updates; explicit overrides stay pinned. */
sessionConfigSource?: "runtime" | "pinned";
/** Host-bound history/search scope; does not change mutation or execution identity. */
sessionReadScopeKey?: string;
/**
* Wrap returned tools with the before_tool_call hook at construction time.
* Defaults to true; callers that already enforce the hook at a later shared
* boundary should opt out explicitly.
*/
wrapBeforeToolCallHook?: boolean;
/** Internal review-run restrictions and proposal provenance. */
skillWorkshop?: SkillWorkshopRunOptions;
webFetchHostnameAllowlistRef?: {
value?: string[];
};
webSearchEnabled?: boolean;
/** Routable target for the current conversation when it differs from the native channel ID. */
currentMessagingTarget?: string;
/** Dynamic audio state for runs that can accept steered input after tool creation. */
hasCurrentInboundAudio?: () => boolean;
/** Mutable ref to track if a reply was sent (for "first" mode). */
hasRepliedRef?: {
value: boolean;
};
/** Allow plugin tools for this tool set to late-bind the gateway subagent. */
allowGatewaySubagentBinding?: boolean;
runtimeToolAllowlist?: string[];
/** Host-prepared proof that this exact session can request Gateway publication. */
githubPublicationAvailable?: boolean;
cronCreatorAuthorityUnavailableReason?: CronToolOptions["creatorAuthorityUnavailableReason"];
/** Mutable model-context generation used to expire screenshot coordinate frames. */
computerContextEpoch?: {
value: number;
};
/** Registers run-owned cleanup for tools that hold node resources. */
registerRunCleanup?: (cleanup: (reason: string) => Promise<void>) => void;
inboundEventKind?: InboundEventKind;
/** If true, omit the message tool from the tool list. */
disableMessageTool?: boolean;
swarmCollector?: boolean;
swarmOutputSchema?: Record<string, unknown>;
/** If true, include the heartbeat response tool for structured heartbeat outcomes. */
enableHeartbeatTool?: boolean;
/** Host-only observation after a canonical progress-card replacement commits. */
onProgressCardPlanSaved?: (unfinished: boolean) => void;
onYield?: (message: string, acknowledgment?: string) => Promise<void> | void;
claimYieldCompletion?: () => boolean | Promise<boolean>;
/** Records hot-path tool-prep stages for reply startup diagnostics. */
recordToolPrepStage?: (name: string) => void;
};
//#endregion
//#region src/agents/code-mode-skills.d.ts
type CodeModeSkill = {
name: string;
description: string;
location: string;
source: Pick<Skill, "filePath" | "readContent">;
reader?: CodeModeSkillReader;
};
type CodeModeSkillReader = (params: {
location: string;
signal?: AbortSignal;
}) => Promise<string>;
//#endregion
//#region src/agents/tool-search-types.d.ts
type CatalogSource = "openclaw" | "mcp" | "client";
type CatalogTool = AnyAgentTool | ToolDefinition$1;
type ToolSearchCatalogToolExecutor = (params: {
tool: CatalogTool;
toolName: string;
source: CatalogSource;
sourceName?: string;
toolCallId: string;
parentToolCallId?: string;
/** Exact registered-instance classification resolved by the catalog owner. */
replaySafe?: boolean;
input: unknown;
signal?: AbortSignal;
onUpdate?: AgentToolUpdateCallback;
acceptResultBeforeProjection: (result: AgentToolResult<unknown>) => Promise<AgentToolResult<unknown>>;
}) => Promise<AgentToolResult<unknown>>;
/** Per-run/session context used by Tool Search control tools. */
type ToolSearchToolContext = {
config?: OpenClawConfig;
runtimeConfig?: OpenClawConfig;
agentId?: string;
sessionKey?: string;
sessionId?: string;
runId?: string;
catalogRef?: ToolSearchCatalogRef;
abortSignal?: AbortSignal;
executeTool?: ToolSearchCatalogToolExecutor;
forceRestartSafeTools?: boolean;
/** Set when the run executes only these tools; swarm globals gate on `sessions_spawn`. */
toolExecutionAllow?: readonly string[];
codeModeSkills?: readonly CodeModeSkill[];
};
/** Catalog entry retained behind compacted Tool Search control tools. */
type ToolSearchCatalogEntry = {
id: string;
source: CatalogSource;
sourceName?: string;
mcp?: PluginToolMcpMeta;
name: string;
label?: string;
description: string;
/** Recorded when the catalog owner also exposes this tool in the native surface. */
directVisible?: boolean;
parameters?: unknown;
outputSchema?: TSchema;
tool: CatalogTool;
};
type ToolSearchCatalogSession = {
entries: ToolSearchCatalogEntry[];
counterScope: string;
searchCount: number;
describeCount: number;
callCount: number;
};
type ToolSearchCatalogTelemetry = Omit<ToolSearchCatalogSession, "entries"> & {
catalogSize: number;
sources: Record<CatalogSource, number>;
};
type ToolSearchCatalogRef = {
current?: ToolSearchCatalogSession;
directOnlyToolNames?: ReadonlySet<string>;
baselineDirectOnlyToolNames?: ReadonlySet<string>;
closedTelemetry?: ToolSearchCatalogTelemetry;
onChange?: () => void;
disposeObserver?: () => void;
onDispose?: Set<() => void>;
};
//#endregion
//#region src/agents/agent-tools.options.d.ts
/** Public options for building one plugin-owned agent tool surface. */
type OpenClawCodingToolsOptions = {
agentId?: string;
/** Retained policy owner; execution identity remains agentId/runSessionKey. */
policyAgentId?: string;
exec?: ExecToolDefaults & ProcessToolDefaults;
/** Specific ingress provider used only for transport tool availability. */
toolPolicyMessageProvider?: string;
messageTo?: string;
messageThreadId?: string | number;
sandbox?: SandboxContext | null;
sessionKey?: string;
requesterThinkingLevel?: ThinkLevel;
requesterModel?: SpawnedToolContext["requesterModel"];
/** Exact admitted run instance for lifecycle-bound subprocess capabilities. */
operationalRunInstance?: OperationalRunInstanceRef;
/** Host-prepared effective paired-node Computer Use surface. */
pairedNodeComputerUse?: PreparedPairedComputerUse;
/** Diagnostic trace context for hook/log correlation during this run. */
trace?: DiagnosticTraceContext;
/** What initiated this run (for trigger-specific tool restrictions). */
trigger?: string;
/** Stable cron job identifier populated for cron-triggered runs. */
jobId?: string;
/** Relative workspace path that memory-triggered writes may append to. */
memoryFlushWritePath?: string;
agentDir?: string;
preparedModelRuntime?: PreparedModelRuntimeSnapshot;
workspaceDir?: string;
/** Additional containment for a trusted scheduled workspace; never weakens configured policy. */
requireWorkspaceOnly?: true;
sessionPermissionPolicy?: PreparedSessionPermissionPolicy;
abortSignal?: AbortSignal;
/** Disable hook-owned diagnostics when an outer runtime owns tool diagnostics. */
emitBeforeToolCallDiagnostics?: boolean;
/**
* Provider of the currently selected model (used for provider-specific tool quirks).
* Example: "anthropic", "openai", "google", "openai".
*/
modelProvider?: string;
/** Model id for the current provider (used for model-specific tool gating). */
modelId?: string;
/** Attempt-local authority to start or redirect delegated work. */
delegationCapability?: DelegationCapability;
/** Model API for the current provider (used for provider-native tool arbitration). */
modelApi?: string;
/** Resolved endpoint for provider-native tool eligibility. */
modelBaseUrl?: string;
/** Model context window in tokens (used to scale read-tool output budget). */
modelContextWindowTokens?: number;
/** Resolved runtime model compatibility hints. */
modelCompat?: ModelCompatConfig;
/** If false, keep OpenClaw web_search even when a provider-native search tool is active. */
suppressManagedWebSearch?: boolean;
/**
* Auth mode for the current provider. We only need this for Anthropic OAuth
* tool-name blocking quirks.
*/
modelAuthMode?: ModelAuthMode;
/** Normalized conversation id exposed to tool hooks. Defaults to currentChannelId. */
hookChannelId?: string;
/** Trusted provider role ids for the requester in this group turn. */
memberRoleIds?: string[];
/** True when runtimeToolAllowlist is real parent authority that child sessions inherit. */
inheritRuntimeToolAllowlist?: boolean;
/** Plugin-owned optional tools granted to this run (e.g. subagent toolsAlsoAllow). */
runtimePluginToolGrant?: RuntimePluginToolGrant;
/** Mutable spawn capability snapshot refreshed after late-bound runtime tools are authorized. */
inheritedToolAllowlistRef?: string[];
/** Mutable cron creator cap ref for callers that append final runtime tools later. */
cronCreatorToolAllowlistRef?: CronCreatorToolAllowlistEntry[];
/** Mutable proof that the cron cap reached the final executable surface. */
cronCreatorToolAllowlistCaptureRef?: CronToolsAllowCaptureRef;
/** If true, the model has native vision capability */
modelHasVision?: boolean;
/** Attempt-local full skill reads that remain visible in the model context. */
skillInstructionDeliveryCache?: SkillInstructionDeliveryCache;
/** Keep the message tool available even when the selected profile omits it. */
forceMessageTool?: boolean;
/** Keep the heartbeat response tool available even when the selected profile omits it. */
forceHeartbeatTool?: boolean;
/** If false, build plugin tools only while preserving the shared policy pipeline. */
includeCoreTools?: boolean;
/** Include Tool Search control tools when enabled for this run. */
includeToolSearchControls?: boolean;
/** Executes cataloged tools through the active agent run lifecycle. */
toolSearchCatalogExecutor?: ToolSearchCatalogToolExecutor;
/** Runtime-local Tool Search catalog ref shared with attempt compaction. */
toolSearchCatalogRef?: ToolSearchCatalogRef;
/** Already-admitted skill locations for mistaken tool-id recovery. */
codeModeSkills?: ToolSearchToolContext["codeModeSkills"];
/** Limits which tool families are materialized before the shared policy pipeline runs. */
toolConstructionPlan?: OpenClawCodingToolConstructionPlan;
/** Ring-zero OpenClaw tool; set only by the OpenClaw agent runner. */
systemAgentTool?: SystemAgentToolOptions;
/** Auth profiles already loaded for this run; used for prompt-time tool availability. */
authProfileStore?: AuthProfileStore;
/** Live observer called after wrapped tool outcomes are recorded. */
onToolOutcome?: ToolOutcomeObserver;
/** Reads the sticky untrusted-content flag for the current user turn. */
isTurnTainted?: () => boolean;
/** Supplies run-global model-call ordering for parallel tool outcomes. */
allocateToolOutcomeOrdinal?: (toolCallId?: string) => number;
/** Runtime-only resolved skill paths that the read tool may load under workspaceOnly. */
skillsSnapshot?: SkillSnapshot;
/** Original identities for sandbox-materialized skill instruction paths. */
skillUsagePaths?: SkillUsagePath[];
/** Prepared conversation-scoped facts for callers that already resolved this run context. */
conversationCapabilityProfile?: ResolvedConversationCapabilityProfile;
/** Trusted conversation policy prepared at channel ingress. */
conversationToolPolicy?: GroupToolPolicyConfig;
inputProvenance?: InputProvenance;
/** Consumed in-process completion capability; never derived from model-facing input. */
trustedInternalHandoff?: TrustedSubagentCompletionHandoff;
/** Trusted server-stamped authority for an explicitly capped scheduled run. */
scheduledToolPolicy?: ScheduledToolPolicyContext;
} & OpenClawSharedToolsOptions & AgentRunClientContext & AgentRunMessageContext & AgentRunChannelContext;
//#endregion
//#region src/agents/sandbox-tool-policy.d.ts
/** Provenance marker for wildcard allowlists created from `alsoAllow`. */
declare const IMPLICIT_ALLOW_ALL_FROM_ALSO_ALLOW: unique symbol;
//#endregion
//#region src/agents/tool-policy.d.ts
/** Tool allow/deny policy shape accepted by agent and sandbox config. */
type ToolPolicyLike = {
allow?: string[];
deny?: string[];
[IMPLICIT_ALLOW_ALL_FROM_ALSO_ALLOW]?: true;
};
//#endregion
//#region src/agents/tool-policy-pipeline.d.ts
/** Provenance travels with the decision; consumers never infer it from log labels. */
type ToolPolicySource = {
kind: "profile" | "config" | "session" | "runtime";
path?: string;
profile?: string;
alsoAllowPath?: string;
};
/** One named policy layer in the effective runtime tool policy pipeline. */
type ToolPolicyPipelineStep = {
policy: ToolPolicyLike | undefined;
label: string;
source?: ToolPolicySource;
stripPluginOnlyAllowlist?: boolean;
suppressUnavailableCoreToolWarning?: boolean;
suppressUnavailableCoreToolWarningAllowlist?: string[];
unavailableCoreToolReason?: string;
};
/** One policy application, exposed for diagnostics that need exclusion provenance. */
type ToolPolicyFilterEvent<TTool extends {
name: string;
} = AnyAgentTool> = {
step: ToolPolicyPipelineStep;
policy: ToolPolicyLike;
before: readonly TTool[];
after: readonly TTool[];
};
//#endregion
//#region src/agents/tool-loop-detection-config.d.ts
/** Resolves effective tool loop-detection config by overlaying agent settings on globals. */
declare function resolveToolLoopDetectionConfig(params: {
cfg?: OpenClawConfig;
agentId?: string;
}): ToolLoopDetectionConfig | undefined;
declare namespace agent_tools_d_exports {
export { createOpenClawCodingTools, createOpenClawCodingToolsInternal, resolveToolLoopDetectionConfig };
}
/** Internal preparation data stays outside the public harness factory options. */
declare function createOpenClawCodingToolsInternal(options?: OpenClawCodingToolsOptions, skillReadResources?: SkillSnapshot["resolvedSkills"], onPolicyFilter?: (event: ToolPolicyFilterEvent) => void): AnyAgentTool[];
/** Build the SDK tool list without exposing core-only read scope or completion observations. */
declare function createOpenClawCodingTools(options?: Omit<OpenClawCodingToolsOptions, "sessionReadScopeKey" | "onProgressCardPlanSaved">): AnyAgentTool[];
//#endregion
//#region src/agents/embedded-agent-subscribe.types.d.ts
type ReasoningStreamPayload = Pick<ReplyPayload, "text" | "mediaUrls" | "isReasoning" | "isReasoningSnapshot"> & {
requiresReasoningProgressOptIn?: boolean;
};
type SubscribeEmbeddedAgentSessionParams = {
session: AgentSession;
runId: string;
/** Immutable gateway lifecycle ownership for this execution. */
lifecycleGeneration?: string;
/** Originating message channel used for subsystem log attribution. */
messageChannel?: string;
initialReplayState?: EmbeddedRunReplayState;
assistantErrorTranscript?: EmbeddedRunAttemptParams$1["assistantErrorTranscript"];
hookRunner?: HookRunner;
verboseLevel?: VerboseLevel;
reasoningMode?: ReasoningLevel;
thinkingLevel?: ThinkLevel;
toolResultFormat?: ToolResultFormat;
toolProgressDetail?: ToolProgressDetailMode$1;
shouldEmitToolResult?: () => boolean;
shouldEmitToolOutput?: () => boolean;
sourceReplyDeliveryMode?: SourceReplyDeliveryMode;
/** Attempt-owned delivery proof for message-tool-only source replies. */
hasDeliveredMessageToolOnlySourceReply?: () => boolean;
/** Reports source delivery observed through bridged tool lifecycle events. */
onDeliveredMessageToolOnlySourceReply?: () => void;
onToolResult?: (payload: ReplyPayload) => void | Promise<void>;
onAgentToolResult?: (event: {
toolName: string;
result: unknown;
isError: boolean;
}) => void;
observeToolTerminal?: EmbeddedRunAttemptParams$1["observeToolTerminal"];
/** Attempt-scoped trajectory recorder for runtime tool audit events. */
trajectoryRecorder?: EmbeddedRunAttemptParams$1["trajectoryRecorder"];
onReasoningStream?: (payload: ReasoningStreamPayload) => void | Promise<void>;
/** Expands window reasoning beyond "stream" mode for callers with their own display gate. */
streamReasoningInNonStreamModes?: boolean;
/** Called when a thinking/reasoning block ends (</think> tag processed). */
onReasoningEnd?: () => void | Promise<void>;
onBlockReply?: (payload: BlockReplyPayload, context?: BlockReplyContext) => void | Promise<void>;
/** Flush pending block replies and identify the boundary that requested it. */
onBlockReplyFlush?: (context: BlockReplyFlushContext) => void | Promise<void>;
blockReplyBreak?: "text_end" | "message_end";
blockReplyChunking?: BlockReplyChunking;
onPartialReply?: (payload: PartialReplyPayload) => boolean | void | Promise<boolean | void>;
onAssistantMessageStart?: () => void | Promise<void>;
/** Assistant fragment usage before queued delivery; fragments may be intermediate. */
onModelUsage?: (usage: NormalizedUsage | undefined) => void;
onExecutionPhase?: (info: {
phase: "tool_execution_started";
tool?: string;
toolCallId?: string;
source?: string;
}) => void;
onAgentEvent?: (evt: EmbeddedAgentEvent) => void | Promise<void>;
onToolStreamBoundary?: () => void | Promise<void>;
onHeartbeatToolResponse?: (response: HeartbeatToolResponse) => void | Promise<void>;
/** "finishing" defers both success and error terminal ownership to the caller. */
terminalLifecyclePhase?: "end" | "finishing";
/** Read immediately before terminal lifecycle emission. */
isTerminalAborted?: () => boolean | undefined;
/** Override the terminal stop reason from the current abort owner. */
resolveTerminalStopReason?: () => string | undefined;
/** Same-prompt checks can retain ordinary streaming instead of buffering a draft. */
deferTerminalDelivery?: boolean;
/** Gate final block delivery/lifecycle after the natural answer is known. */
onBeforeTerminalDelivery?: (event: {
messages: AgentMessage[];
willRetry: boolean;
assistantEntryId?: string;
lastAssistant?: AgentMessage;
assistantTexts: readonly string[];
hasAssistantVisibleText: boolean;
isError: boolean;
incompleteTerminalAssistant: boolean;
hadDeterministicSideEffect: boolean;
hasPendingContinuation: boolean;
}) => void | Promise<void | {
suppressTerminalDelivery?: boolean;
continueCurrentTurn?: boolean;
}>;
/** Best-effort hook invoked immediately before the terminal lifecycle event is emitted. */
onBeforeLifecycleTerminal?: () => void | Promise<void>;
enforceFinalTag?: boolean;
silentExpected?: boolean;
/**
* Skip per-chunk live visible-text parsing in handleMessageUpdate. Set for runs
* with no live stream consumer — notably subagents, whose result is read back
* from the final message_end path. Suppressing intermediate passes does not
* change final output.
*/
suppressLiveStreamOutput?: boolean;
config?: OpenClawConfig;
/** Prepared endpoint ownership can differ from the assistant's provider route ID. */
providerOwner?: PreparedProviderFailoverOwner;
compactionCountOwner?: EmbeddedRunAttemptInternalParams["compactionCountOwner"];
onContextAccountingEvent?: EmbeddedRunAttemptInternalParams["onContextAccountingEvent"];
sessionPersistence?: EmbeddedRunAttemptParams$1["sessionPersistence"];
sessionKey?: string;
/** Current transport channel resolved for this run. */
currentChannelId?: string;
/** Routable target for the current conversation when it differs from the native channel ID. */
currentMessagingTarget?: string;
currentAccountId?: string;
/** Current transport thread resolved for this run. */
currentThreadId?: string;
/** Current inbound message id used to distinguish child replies from explicit roots. */
currentMessageId?: string | number;
/** Reply mode used by transport auto-threading. */
replyToMode?: "off" | "first" | "all" | "batched";
/** Shared one-shot reply state used by first/batched modes. */
hasRepliedRef?: {
value: boolean;
};
/** Ephemeral session UUID — regenerated on /new and /reset. */
sessionId?: string;
/** Agent identity for hook context — resolved from session config in attempt.ts. */
agentId?: string;
/**
* Exact raw names of OpenClaw tools registered for this run.
*/
builtinToolNames?: ReadonlySet<string>;
/** Exact raw names of core-owned tools registered for this run. */
coreBuiltinToolNames?: ReadonlySet<string>;
/** Exact registered tool names whose concrete instances are safe to replay. */
replaySafeToolNames?: ReadonlySet<string>;
/** Exact names of the marked Code Mode `exec` control tool(s) registered for this run. */
codeModeExecToolNames?: ReadonlySet<string>;
/** Canonical owner keys for unique plugin tools that can change durable state. */
sideEffectToolOwners?: ReadonlyMap<string, string>;
/**
* Exact raw names allowed to emit local media paths for this run.
* Includes core trusted tools plus bundled plugin tools proven from the
* startup metadata snapshot.
*/
trustedLocalMediaToolNames?: ReadonlySet<string>;
internalEvents?: AgentInternalEvent[];
};
//#endregion
//#region src/agents/embedded-agent-subscribe.d.ts
declare function subscribeEmbeddedAgentSession(params: SubscribeEmbeddedAgentSessionParams): {
assistantTexts: string[];
answerSegments: {
textEnd: number;
messageEnd: number;
finalMessageStart: number;
lastAssistant: AssistantMessage$1;
}[];
getCurrentAttemptAssistant: () => AssistantMessage$1 | undefined;
hasSuccessfulModelResponse: () => boolean;
getLastAssistantTextMessageIndex: () => number | undefined;
toolMetas: {
toolName?: string;
toolCallId?: string;
parentToolCallId?: string;
activity?: AgentItemEventData;
meta?: string;
replaySafe?: boolean;
isError?: boolean;
terminate?: boolean;
asyncStarted?: boolean;
asyncTaskRunId?: string;
asyncTaskId?: string;
codeModeSuspended?: boolean;
}[];
getAcceptedSessionSpawns: () => AcceptedSessionSpawn[];
getLatestMcpAppChannelView: () => {
viewId: string;
} | undefined;
getLatestMcpConnectAction: () => {
serverName: string;
authorizationUrl: string;
} | undefined;
runToolLifecycle: <T>(toolParams: {
toolName: string;
toolCallId: string;
parentToolCallId?: string;
args: unknown;
replaySafe?: boolean;
hideFromChannelProgress?: boolean;
execute: (onImplementationStart: () => void) => Promise<T>;
onTerminal?: (terminal: {
result: unknown;
isError: boolean;
executedArguments: unknown;
effectReceipt: ToolEffectReceipt;
}) => void | Promise<void>;
}) => Promise<T>;
unsubscribe: () => void;
setTerminalLifecycleMeta: (meta: {
replayInvalid?: boolean;
livenessState?: EmbeddedRunLivenessState;
stopReason?: string;
yielded?: boolean;
timeoutPhase?: AgentRunTimeoutPhase;
providerStarted?: boolean;
aborted?: boolean;
}) => void;
isCompacting: () => boolean;
isCompactionInFlight: () => boolean;
getMessagingToolSentTexts: () => string[];
getMessagingToolSentMediaUrls: () => string[];
getMessagingToolSentTargets: () => MessagingToolSend[];
getMessagingToolSourceReplyPayloads: () => MessagingToolSourceReplyPayload[];
getSourceReplyDelivered: () => true | undefined;
getSourceReplyDeliveryState: () => ReplyDeliveryState | undefined;
getHeartbeatToolResponse: () => {
outcome: "blocked" | "done" | "needs_attention" | "no_change" | "progress";
notify: boolean;
summary: string;
notificationText?: string;
reason?: string;
priority?: "high" | "low" | "normal";
nextCheck?: string;
scratch?: string;
} | undefined;
getPendingToolMediaReply: () => BlockReplyPayload | null;
getToolAutoDeliveryMediaUrls: () => string[];
hasToolMediaBlockReply: () => boolean;
getVisibleBlockReplyCount: () => number;
getSuccessfulCronAdds: () => number;
getReplayState: () => {
replayInvalid: boolean;
hadPotentialSideEffects: boolean;
};
didSendViaMessagingTool: () => boolean;
didSendDeterministicApprovalPrompt: () => boolean;
getLastToolError: () => {
toolName: string;
executionStarted?: boolean;
meta?: string;
errorCode?: string;
error?: string;
validationErrorSummary?: string;
timedOut?: boolean;
middlewareError?: boolean;
mutatingAction?: boolean;
terminalDiagnostic?: ProcessTerminalDiagnostic | {
kind: "timeout";
timeoutMs: number;
partialResults?: number;
};
} | undefined;
getUsageTotals: () => NormalizedUsage | undefined;
getLastAssistantUsage: () => NormalizedUsage | undefined;
getCompactionCount: () => number;
getLastCompactionTokensAfter: () => number | undefined;
getAssistantTurnCount: () => number;
waitForPendingEvents: (options?: {
includePartialReplies?: boolean;
}) => Promise<void>;
flushPartialAssistantText: () => void;
getItemLifecycle: () => {
startedCount: number;
completedCount: number;
activeCount: number;
};
waitForCompactionRetry: () => Promise<void>;
};
//#endregion
//#region src/sessions/user-turn-transcript.metadata.d.ts
/**
* Runtime hooks may rewrite roles and redact display/transport fields. Restore only
* operational facts here; canonical admission preparation deliberately protects more.
*/
declare function restorePreparedUserTurnOperationalMetaForRuntime<TMessage extends AgentMessage>(params: {
runtimeMessage: TMessage;
preparedMessage?: PersistedUserTurnMessage;
}): TMessage;
//#endregion
//#region src/agents/tool-schema-projection.d.ts
/** Diagnostic for one incompatible runtime tool schema. */
type RuntimeToolSchemaDiagnostic = {
readonly toolName: string;
readonly toolIndex: number;
readonly violations: readonly string[];
};
/** Runtime tool list split into compatible tools and schema diagnostics. */
type RuntimeToolSchemaInspection<TTool extends Pick<AnyAgentTool, "name" | "parameters">> = {
readonly tools: TTool[];
readonly diagnostics: readonly RuntimeToolSchemaDiagnostic[];
};
/** Inspects runtime tool schemas and returns diagnostics without filtering tools. */
declare function inspectRuntimeToolInputSchemas(tools: readonly Pick<AnyAgentTool, "name" | "parameters">[]): RuntimeToolSchemaDiagnostic[];
/** Filters tools to those that providers can normalize before dispatch. */
declare function filterProviderNormalizableTools<TTool extends Pick<AnyAgentTool, "name" | "parameters">>(tools: readonly TTool[]): RuntimeToolSchemaInspection<TTool>;
//#endregion
//#region src/agents/ui-presentation-prompt.d.ts
/** Tool eligibility and results own surface support; do not infer it from channel names. */
declare function buildUiPresentationPrompt(params: {
screenToolName?: string;
showWidgetToolName?: string;
dashboardToolName?: string;
portalToolName?: string;
messageTool?: {
name: string;
parameters: unknown;
};
}): string;
//#endregion
//#region src/agents/tool-replay-safety.d.ts
/**
* Tool names are not ownership boundaries. Callers must reject plugin/channel
* instances before using this audited core-tool allowlist.
*/
declare function isAgentToolReplaySafe(tool: {
name?: string;
}, options?: {
declaredReplaySafe?: (tool: {
name?: string;
}) => boolean | undefined;
}): boolean;
//#endregion
//#region src/agents/embedded-agent-runner/run/attempt-result.d.ts
type EmbeddedAttemptSubscription = ReturnType<typeof subscribeEmbeddedAgentSession>;
type EmbeddedRunAttemptWithReceiptEvidence = EmbeddedRunAttemptResult & {
answerSegments?: EmbeddedAttemptSubscription["answerSegments"];
successfulNestedToolNames?: string[];
};
//#endregion
//#region src/agents/harness/host-capability-types.d.ts
type AgentHarnessHostApprovalResult = Readonly<{
decision: ApprovalDecision | null | undefined;
terminalReason: ApprovalTerminalReason | null | undefined;
}>;
type AgentHarnessPreparedEnvironment = Readonly<{
credentialScrubEnv: Readonly<Record<string, string>>;
localIdentityEnv: Readonly<Record<string, string>>;
/** Local child destination facts; must not be projected into a remote or sandbox process. */
localProcessEnv?: Readonly<Record<string, string>>;
/** Tool lookup on an owned local process; omit for remote, socket, or sandbox placement. */
localToolEnv?: Readonly<Record<string, string>>;
/** Prefix intent for runtimes with an explicitly authored native shell PATH. */
localToolPathPrepend?: readonly string[];
/** Non-secret fact used to select the local GitHub identity overlay. */
managedLocalIdentity: boolean;
}>;
type AgentHarnessToolSurfaceOptions = Omit<NonNullable<Parameters<(typeof agent_tools_d_exports)["createOpenClawCodingTools"]>[0]>, "operationalRunInstance">;
type AgentHarnessModelExecutionBinder = (model: ProviderModelRef | undefined) => Readonly<{
signal: AbortSignal;
assertCurrent: () => void;
release: () => void;
}> | undefined;
type AgentHarnessHostCapabilities = Readonly<{
kind: "agent-harness-host-capability";
version: 1;
/** Fails closed unless this exact admitted run capability remains active. */
assertActive: () => void;
/** Binds the actual native model; returns undefined only for runs without an operator source. */
bindModelExecution?: AgentHarnessModelExecutionBinder;
/** Retains the original source for already-admitted work beyond foreground completion. */
retainSourceAuthority?: () => Readonly<{
assertCurrent: () => void;
signal?: AbortSignal;
/** Live preflight fact; absence means unknown, not an unrestricted source. */
modelPolicyRequired?: boolean;
/** Opaque equality for compatible active input; never authority by itself. */
sourceIdentity?: object;
/** Binds later dispatches while this retained work remains active. */
bindModelExecution?: AgentHarnessModelExecutionBinder;
release: () => void;
}> | undefined;
/** Reports one completed model call's output tokens to this admitted run's live total. */
reportOutputTokens?: (outputTokens: number) => void;
/** Adds native provenance only to this host's exact current admitted prompt. */
annotateCurrentUserTurn?: (annotation: UserTurnTranscriptAnnotation) => Promise<void>;
/** Execution-only document paths after the harness confirms unsandboxed local placement. */
prepareInputAttachments?: (request: {
placement: "local-host";
maxChars: number;
/** Omit for the admitted input; supply the current input for steering. */
turn?: Pick<EmbeddedRunAttemptParams$1, "media" | "userTurnTranscriptRecorder">;
assertCurrent: () => void;
signal?: AbortSignal;
}) => Promise<string | undefined>;
/** Rebuilds retained attachments under this host's captured media policy and run authority. */
prepareContextMedia?: (request: {
message: AgentMessage;
maxChars: number;
}) => Promise<{
text?: string;
images: ImageContent$1[];
}>;
/** Stages reply attachments under captured policy and live run authority. */
prepareReplyMedia?: (request: {
/** Additional native session or transport authority, retained through publication. */
assertCurrent?: () => void;
signal?: AbortSignal;
} & (({
workspaceRoot?: string;
readWorkspaceFile: (relativePath: string, options: {
maxBytes: number;
signal: AbortSignal;
}) => Promise<Buffer>;
} & ({
kind: "attempt";
attempt: EmbeddedRunAttemptWithReceiptEvidence;
} | {
kind: "payload";
payload: ReplyPayload;
})) | {
/** Already-admitted provider bytes, not permission to read a host path. */
kind: "artifact";
buffer: Buffer;
fileName: string;
assertCurrent: () => void;
})) => Promise<{
kind: "attempt";
preparedMedia: PreparedReplyMedia;
} | {
kind: "payload";
payload: ReplyPayload;
}>;
/** Closure-bound event sink backed by the host-owned trajectory recorder. */
trajectory?: Readonly<{
recordEvent: (type: string, data?: Record<string, unknown>) => void;
flush: () => Promise<void>;
}>;
/** Closure-bound non-secret maps prepared before harness placement. */
preparedEnvironment?: () => AgentHarnessPreparedEnvironment;
/** Current bounded presence hint; physical activity does not identify the message source. */
activeComputerContext?: () => string;
/** Applies the exact host caller binding to a plugin-built tool surface. */
bindToolSurface: (tools: AnyAgentTool[], options?: Readonly<{
cwd?: string;
}>) => AnyAgentTool[];
/** Creates and binds core tools without exposing admitted-run correlation to the plugin. */
createToolSurface?: (options: AgentHarnessToolSurfaceOptions, bindingOptions?: Readonly<{
cwd?: string;
}>) => AnyAgentTool[];
/** Core-owned byte binding for a native command approval, scoped to this admitted run. */
prepareMutableFileApproval?: (request: {
command: string;
cwd?: string;
}) => Promise<{
ok: true;
requiresOneShot: boolean;
revalidate: () => Promise<{
ok: true;
} | {
ok: false;
message: string;
}>;
} | {
ok: false;
message: string;
}>;
/** Runs policy with host-fixed HookContext; callers provide only the native action tuple. */
runBeforeToolCall: (request: Omit<Parameters<(typeof agent_tools_before_tool_call_d_exports)["runBeforeToolCallHook"]>[0], "approvalMode" | "ctx"> & {
/** Native relays may defer approval for a correlated app-server callback. */
approvalMode?: "request" | "defer";
/** Action-local facts from the native runtime; host authority remains closure-bound. */
nativeOperation?: Readonly<{
cwd?: string;
}>;
}) => ReturnType<(typeof agent_tools_before_tool_call_d_exports)["runBeforeToolCallHook"]>;
requestApproval: (request: {
signal?: AbortSignal;
title: string;
description: string;
/** Full action evidence for authenticated reviewer surfaces, not channel messages. */
detail?: string;
severity: "info" | "warning";
toolName: string;
toolCallId?: string;
mcpTool?: {
server: string;
tool: string;
};
/** Persistence-only proof; loss of correlation does not cancel a one-shot approval. */
isMcpToolApprovalActive?: () => boolean;
allowedDecisions?: ApprovalDecision[];
timeoutMs: number;
transportTimeoutMs?: number;
}) => Promise<{
id?: string;
decision?: ApprovalDecision | null;
} | undefined>;
waitForApproval: (request: {
approvalId: string;
timeoutMs: number;
transportTimeoutMs?: number;
signal?: AbortSignal;
}) => Promise<AgentHarnessHostApprovalResult | undefined>;
}>;
//#endregion
//#region src/agents/mcp-stdio-client.d.ts
type McpStdioClientParams = {
command: string;
args?: string[];
/** Exact child environment; nothing is inherited. */
env: NodeJS.ProcessEnv;
clientInfo: {
name: string;
version: string;
};
/** The server must answer initialize with exactly this version. */
protocolVersion: string;
startupTimeoutMs: number;
maxPendingRequests: number;
maxFrameBytes: number;
errors: {
/** Process, lifecycle, admission, deadline, and cancellation failures. */
unavailable: (message: string, cause?: unknown) => Error;
/** Malformed frames, JSON-RPC errors, and handshake contract violations. */
protocol: (message: string, cause?: unknown) => Error;
};
};
type McpStdioClient = {
isAvailable(): boolean;
readonly cleanupResult?: ProcessCleanupResult;
request(method: string, params: Record<string, unknown>, options: {
timeoutMs: number;
signal?: AbortSignal;
}): Promise<Record<string, unknown>>;
stop(): Promise<void>;
};
/**
* A strict client for a caller-owned stdio MCP proxy process fronting a stateful driver.
* Any connection anomaly retires the whole connection; the caller supplies the error taxonomy.
*/
declare function createMcpStdioClient(params: McpStdioClientParams): McpStdioClient;
//#endregion
//#region src/agents/codex-mcp-config.types.d.ts
/** Codex app-server `mcp_servers` config map. */
type CodexMcpServersConfig = Record<string, Record<string, unknown>>;
/** Loaded Codex thread-config patch plus diagnostics and cache metadata. */
type CodexBundleMcpThreadConfig = {
configPatch?: {
mcp_servers: CodexMcpServersConfig;
};
diagnostics: BundleMcpDiagnostic[];
evaluated: boolean;
fingerprint?: string;
/** Enabled static servers across bundle defaults and owner config. */
staticServerNames: string[];
/** Enabled static servers originating from owner `mcp.servers` config. */
userStaticServerNames: string[];
};
/** Inputs used to load a Codex bundle-MCP thread config patch. */
type LoadCodexBundleMcpThreadConfigParams = {
workspaceDir: string;
agentId?: string;
/** Read-only initialization cannot provision data directories or requester transports. */
preparationOnly?: true;
cfg?: OpenClawConfig;
toolsEnabled?: boolean;
disableTools?: boolean;
toolsAllow?: string[];
manifestRegistry?: Pick<PluginManifestRegistry, "plugins">;
toolOverrides?: Pick<SessionToolOverrides, "mcpServers" | "mcpToolsDeny">;
};
//#endregion
//#region src/agents/agent-bundle-mcp-harness.d.ts
type RequesterScopedHarnessMcpTools = {
/** Executable tools for this turn (live binding or not-connected stubs). */
tools: AnyAgentTool[];
/**
* Session-stable advertised tool surface for dynamic-tool fingerprints.
* Identical for every sender once the session has observed a scoped catalog.
*/
advertisedTools: AnyAgentTool[];
dispose: () => Promise<void>;
};
type InteractiveConfiguredMcpApprovalRequest = {
signal?: AbortSignal;
safeToolName: string;
toolCallId: string;
serverName: string;
toolName: string;
mode: "auto" | "prompt";
isActive: () => boolean;
};
type MaterializeRequesterScopedMcpToolsForHarnessRunParams = {
sessionId: string;
sessionKey?: string;
agentId?: string;
workspaceDir: string;
agentDir?: string;
cfg?: OpenClawConfig;
manifestRegistry?: Pick<PluginManifestRegistry, "plugins">;
toolOverrides?: Pick<SessionToolOverrides, "mcpServers" | "mcpToolsDeny">;
requesterSenderId?: string | null;
agentAccountId?: string | null;
messageChannel?: string | null;
reservedToolNames?: Iterable<string>;
toolsAllow?: string[];
/** When set, applies the same final effective tool policy as the embedded runner. */
conversationCapabilityProfile?: ResolvedConversationCapabilityProfile;
/** Builds a capability profile when conversationCapabilityProfile is omitted. */
policyContext?: Omit<ConversationCapabilityProfileParams, "runtimeToolAllowlist">;
/** Exact established Codex yolo predicate; no other profile bypasses approval metadata. */
autoApproveCodexAppServerApprovals?: boolean;
/** Interactive turns request approval before the original MCP executor runs. */
requestInteractiveCodexApproval?: (params: InteractiveConfiguredMcpApprovalRequest) => Promise<void>;
warn?: (message: string) => void;
};
/**
* Materialize requester-scoped MCP tools for a harness run (e.g. Codex dynamic tools).
* Updates the session advertised-catalog cache when a requester resolves a catalog.
* Before any requester resolves in the session, returns undefined (nothing to advertise).
*/
declare function materializeRequesterScopedMcpToolsForHarnessRunCore(params: MaterializeRequesterScopedMcpToolsForHarnessRunParams): Promise<RequesterScopedHarnessMcpTools | undefined>;
//#endregion
//#region src/agents/harness/user-input-types.d.ts
type AgentHarnessUserInputOption = {
label: string;
description?: string;
};
type AgentHarnessUserInputQuestion = {
id: string;
header: string;
question: string;
/** External step to open without answering the question. */
url?: string;
multiSelect?: boolean;
isOther?: boolean;
isSecret?: boolean;
options?: readonly AgentHarnessUserInputOption[] | null;
};
type AgentHarnessUserInputAnswers = {
answers: Record<string, {
answers: string[];
}>;
};
//#endregion
//#region src/agents/harness/gateway-question-dispatch.d.ts
type AgentHarnessQuestionGatewayCall = (method: string, opts: {
timeoutMs?: number;
}, params?: unknown, extra?: {
signal?: AbortSignal;
}) => Promise<unknown>;
type QuestionDispatchAuthority = {
kind: "unscoped";
} | {
kind: "source-bound";
assertCurrent: () => void;
};
/** Custom transports opt into enforcing authority after preparation, immediately before I/O. */
type AgentQuestionDispatcher = {
version: 2;
call: (request: {
method: string;
options: {
timeoutMs?: number;
};
params?: unknown;
signal?: AbortSignal;
authority: QuestionDispatchAuthority;
}) => Promise<unknown>;
};
//#endregion
//#region src/agents/harness/user-input-bridge.d.ts
type AgentHarnessUserInputPromptOptions = {
intro?: string;
formatText?: (text: string) => string;
secretWarning?: string;
otherLabel?: string;
presentation?: MessagePresentation;
};
type PromptDeliveryParams = Pick<EmbeddedRunAttemptParams$1, "onBlockReply" | "onPartialReply">;
declare function emptyAgentHarnessUserInputAnswers(): AgentHarnessUserInputAnswers;
declare function formatAgentHarnessUserInputPrompt(questions: readonly AgentHarnessUserInputQuestion[], options?: AgentHarnessUserInputPromptOptions): string;
declare function deliverAgentHarnessUserInputPrompt(params: PromptDeliveryParams, questions: readonly AgentHarnessUserInputQuestion[], options?: AgentHarnessUserInputPromptOptions): Promise<void>;
declare function buildAgentHarnessUserInputAnswers(questions: readonly AgentHarnessUserInputQuestion[], inputText: string): AgentHarnessUserInputAnswers;
declare function normalizeAgentHarnessUserInputAnswer(answer: string, question: AgentHarnessUserInputQuestion): string | undefined;
//#endregion
//#region src/agents/harness/gateway-question.d.ts
type QuestionInputAuthority = {
kind: "run" | "source-bound";
assertCurrent: () => void;
};
/** Owns reservation and persistence; absent questions return before checking caller authority. */
declare function claimPendingAgentQuestionAnswer(params: {
sessionKey?: string;
text: string;
persist?: () => Promise<void>;
sourceRecorder?: UserTurnTranscriptRecorder;
authority?: QuestionInputAuthority;
}): Promise<boolean>;
/** Cancels a question before the same inbound message takes another route. */
declare function cancelPendingAgentQuestionForSession(params: {
sessionKey?: string;
resolvedBy: string;
authority?: QuestionInputAuthority;
}): Promise<boolean>;
type RunAgentHarnessGatewayQuestionParams = {
questions: readonly AgentHarnessUserInputQuestion[];
sessionKey: string;
agentId?: string;
runId?: string;
timeoutMs: number;
gatewayCall?: AgentHarnessQuestionGatewayCall | AgentQuestionDispatcher;
delivery: Pick<EmbeddedRunAttemptParams$1, "onBlockReply" | "onPartialReply"> & {
hostCapabilities?: AgentHarnessHostCapabilities;
};
promptOptions?: AgentHarnessUserInputPromptOptions;
signal?: AbortSignal;
questionId?: string;
};
/** Registers, presents, and waits for one harness-owned gateway question record. */
declare function runAgentHarnessGatewayQuestion(params: RunAgentHarnessGatewayQuestionParams): Promise<QuestionWaitAnswerResult>;
//#endregion
//#region src/agents/harness/structured-input-boundary.d.ts
type StructuredInputScalar = string | number | boolean | null;
type StructuredInputValue = StructuredInputScalar | StructuredInputValue[] | StructuredInputRecord;
type StructuredInputRecord = {
[key: string]: StructuredInputValue;
};
type StructuredInputAnswerValue = string | number | boolean | string[];
type StructuredInputDecodeResult = {
kind: "absent";
} | {
kind: "invalid";
message: string;
} | {
kind: "present";
entries: Array<[string, StructuredInputAnswerValue]>;
};
type StructuredInputField = {
question: AgentHarnessUserInputQuestion;
decode: (values: readonly string[]) => StructuredInputDecodeResult;
};
type StructuredInputPlan = {
kind: "form";
intro: string;
fields: StructuredInputField[];
} | {
kind: "url";
question: AgentHarnessUserInputQuestion;
};
type StructuredInputCompileResult = {
kind: "ready";
plan: StructuredInputPlan;
} | {
kind: "unsupported";
message: string;
};
type StructuredInputCompilerOptions = {
protocolName: string;
allowEmptyForm?: boolean;
minimumChoiceCount?: 1 | 2;
allowEnumNames?: boolean;
allowImagePicker?: boolean;
booleanLabels?: readonly [string, string];
metadata?: {
secretPath?: readonly string[];
otherAnswerPath?: readonly string[];
otherQuestionIdPath?: readonly string[];
};
};
/** Copies only bounded, enumerable own data properties without invoking accessors. */
declare function snapshotStructuredInput(value: unknown): StructuredInputValue | undefined;
declare function isStructuredInputRecord(value: unknown): value is StructuredInputRecord;
//#endregion
//#region src/agents/harness/structured-input.d.ts
/** Wraps already bounded protocol questions in the shared execution plan. */
declare function compileStructuredInputQuestions(params: {
questions: readonly AgentHarnessUserInputQuestion[];
intro: string;
}): StructuredInputCompileResult;
/** Compiles a bounded object schema into Gateway questions plus answer decoders. */
declare function compileStructuredInputForm(params: {
schema: unknown;
message: string | undefined;
fallbackMessage: string;
options: StructuredInputCompilerOptions;
}): StructuredInputCompileResult;
/** Keeps browser navigation separate from confirmation that the external step is complete. */
declare function compileStructuredInputUrl(params: {
url: unknown;
elicitationId: unknown;
message: unknown;
fallbackMessage: string;
protocolName: string;
}): StructuredInputCompileResult;
//#endregion
//#region src/agents/harness/structured-input-execution.d.ts
type StructuredInputExecutionResult = {
status: "answered";
answers: Record<string, string[]>;
content: Record<string, StructuredInputAnswerValue>;
} | {
status: "declined";
message?: string;
} | {
status: "cancelled";
message?: string;
} | {
status: "unsupported";
message: string;
};
type StructuredInputExecutionParams = {
input: StructuredInputCompileResult;
sessionKey: string;
agentId?: string;
runId?: string;
timeoutMs: number;
gatewayCall?: Parameters<typeof runAgentHarnessGatewayQuestion>[0]["gatewayCall"];
delivery: Parameters<typeof runAgentHarnessGatewayQuestion>[0]["delivery"];
signal?: AbortSignal;
isActive?: () => boolean;
questionId?: (batch: number) => string | undefined;
promptOptions?: AgentHarnessUserInputPromptOptions & {
unsupportedIntro?: string;
urlIntro?: string;
};
};
/** Executes one compiled form or URL with shared batching, secret, and fencing semantics. */
declare function runStructuredInput(params: StructuredInputExecutionParams): Promise<StructuredInputExecutionResult>;
//#endregion
//#region src/agents/tool-policy-match.d.ts
/** Snapshot one synchronous filtering operation; execution checks must prepare current policy. */
declare function createToolPolicyMatcher(policy?: SandboxToolPolicy, writeAllowsApplyPatch?: boolean): (name: string) => boolean;
//#endregion
//#region src/agents/agent-activity-presentation.d.ts
declare function projectAgentActivityItem<Item extends {
kind?: string;
name?: string;
status?: string;
phase?: string;
hideFromChannelProgress?: boolean;
}>(item: Item, facts?: {
args?: unknown;
result?: unknown;
nativeOperation?: "wait" | "process.poll";
}): Item & {
hideFromChannelProgress?: boolean;
};
declare function isCompleteAgentPreamble(item: {
phase?: string;
progressText?: string;
}): boolean;
//#endregion
//#region src/agents/harness/projection-tool-output.d.ts
declare const TOOL_PROGRESS_OUTPUT_MAX_CHARS = 8000;
/**
* Prepare verbose tool output for user-facing progress messages.
*/
declare function formatToolProgressOutput(output: string, options?: {
maxChars?: number;
}): string | undefined;
//#endregion
//#region src/session-cards/progress-card-channel-summary.d.ts
/** Projects checklist counts or readable notes through the shared Markdown owner. */
declare function projectProgressCardChannelUpdate(input: unknown): {
steps: {
step: string;
status: "completed" | "in_progress" | "pending";
}[];
explanation?: string | undefined;
explanationFormat?: "plain" | undefined;
} | undefined;
//#endregion
//#region src/agents/embedded-agent-message-tool-source-reply.d.ts
declare function isDeliveredMessagingToolResult(params: {
toolName?: string;
args?: unknown;
result?: unknown;
hookResult?: unknown;
isError?: boolean;
requirePluginDeliveryId?: boolean;
}): boolean;
declare function isDeliveredMessageToolOnlySourceReplyResult(params: {
sourceReplyDeliveryMode?: SourceReplyDeliveryMode;
toolName: string;
args?: unknown;
result?: unknown;
hookResult?: unknown;
isError?: boolean;
allowExplicitSourceRoute?: boolean;
deliveryConfirmed?: boolean;
}): boolean;
//#endregion
//#region src/agents/harness/errors.d.ts
/** A harness lost ownership of the session generation before the attempt could start. */
declare class AgentHarnessSessionSupersededError extends Error {
constructor(message: string, options?: ErrorOptions);
}
/** A model-independent harness preflight failed before an attempt could start. */
declare class AgentHarnessPreflightError extends Error {
/** Opts fallback into skipping only candidates owned by the selected harness. */
readonly scope?: "harness";
/** Owner-authored public explanation; message and cause remain diagnostic. */
readonly userMessage?: string;
constructor(message: string, options?: ErrorOptions & {
scope?: "harness";
userMessage?: string;
});
}
//#endregion
//#region src/agents/harness/settled-turn-finalization-result.d.ts
/**
* Projects a harness-owned full attempt engine into the narrow finalization
* contract, rejecting canonical failure or capability evidence first.
*/
declare function projectSettledTurnFinalizationAttemptResult(result: AgentHarnessAttemptResult): AgentHarnessSettledTurnFinalizationResult;
//#endregion
//#region src/agents/harness/transcript-visibility.d.ts
/**
* Keep internal messages in the audit/model transcript without
* projecting them into user-facing chat history.
*/
declare function projectAgentHarnessTranscriptMessageForDisplay<T extends AgentMessage>(params: {
hidden: boolean;
inputProvenance?: InputProvenance;
message: T;
}): T;
//#endregion
//#region src/agents/harness/native-hook-relay-types.d.ts
type NativeHookRelayApprovalContext = Pick<HookContext, "approvalReviewerDeviceId" | "trigger" | "turnSourceAccountId" | "turnSourceChannel" | "turnSourceThreadId" | "turnSourceTo">;
type JsonValue = null | boolean | number | string | JsonValue[] | {
[key: string]: JsonValue;
};
declare const NATIVE_HOOK_RELAY_EVENTS: readonly ["pre_tool_use", "post_tool_use", "permission_request", "before_agent_finalize"];
declare const NATIVE_HOOK_RELAY_PROVIDERS: readonly ["codex"];
type NativeHookRelayEvent = (typeof NATIVE_HOOK_RELAY_EVENTS)[number];
type NativeHookRelayProvider = (typeof NATIVE_HOOK_RELAY_PROVIDERS)[number];
type NativeHookRelayInvocation = {
provider: NativeHookRelayProvider;
relayId: string;
event: NativeHookRelayEvent;
nativeEventName?: string;
agentId?: string;
sessionId: string;
sessionKey?: string;
runId: string;
cwd?: string;
model?: string;
turnId?: string;
transcriptPath?: string;
permissionMode?: string;
stopHookActive?: boolean;
lastAssistantMessage?: string;
toolName?: string;
toolUseId?: string;
rawPayload: JsonValue;
receivedAt: string;
};
type NativeHookRelayProcessResponse = {
stdout: string;
stderr: string;
exitCode: number;
failureDisposition?: Exclude<BeforeToolCallFailureDisposition, "blocked">;
};
type NativeHookRelayRegistration = {
relayId: string;
provider: NativeHookRelayProvider;
generationMismatchGraceExpiresAtMs?: number;
generationMismatchGraceAcceptedGeneration?: string;
agentId?: string;
sessionId: string;
sessionKey?: string;
config?: OpenClawConfig;
deferMcpToolApprovals?: boolean;
runId: string;
channelId?: string;
requester?: PluginHookToolRequesterContext;
approvalContext?: NativeHookRelayApprovalContext;
allowedEvents: readonly NativeHookRelayEvent[];
expiresAtMs: number;
signal?: AbortSignal;
/** Exact host policy capability for authority-bearing native callbacks. */
runBeforeToolCall?: AgentHarnessHostCapabilities["runBeforeToolCall"];
/** Foreground-only approval authority supplied by the admitted bundled host. */
approvalHost?: Pick<AgentHarnessHostCapabilities, "requestApproval" | "waitForApproval">;
/** Revalidates the exact admitted owner after authority-bearing awaits. */
assertActive?: AgentHarnessHostCapabilities["assertActive"];
onPreToolUseFailure?: (failure: {
toolName: string;
toolCallId: string;
disposition: Exclude<BeforeToolCallFailureDisposition, "blocked">;
durationMs: number;
}) => void | Promise<void>;
};
type NativeHookRelayRegistrationHandle = NativeHookRelayRegistration & {
generation?: string;
shouldRelayEvent: (event: NativeHookRelayEvent) => boolean;
toolMatcherForEvent: (event: NativeHookRelayEvent) => readonly string[] | undefined;
commandForEvent: (event: NativeHookRelayEvent, options?: NativeHookRelayCommandForEventOptions) => string;
renew: (ttlMs?: number) => void;
unregister: () => void;
};
type RegisterNativeHookRelayParams = {
provider: NativeHookRelayProvider;
relayId?: string;
generation?: string;
generationMismatchGraceMs?: number;
agentId?: string;
sessionId: string;
sessionKey?: string;
config?: OpenClawConfig;
autoApproveMcpTools?: boolean;
projectedMcpServers?: CodexMcpServersConfig;
runId: string;
channelId?: string;
requester?: PluginHookToolRequesterContext;
approvalContext?: NativeHookRelayApprovalContext;
allowedEvents?: readonly NativeHookRelayEvent[];
/** Whether this relay should run OpenClaw loop detection from native PreToolUse hooks. */
preToolUseLoopDetection?: boolean;
ttlMs?: number;
command?: NativeHookRelayCommandOptions;
signal?: AbortSignal;
runBeforeToolCall?: NativeHookRelayRegistration["runBeforeToolCall"];
assertActive?: NativeHookRelayRegistration["assertActive"];
onPreToolUseFailure?: NativeHookRelayRegistration["onPreToolUseFailure"];
};
type NativeHookRelayCommandOptions = {
executable?: string;
nice?: number | false;
nodeExecutable?: string;
timeoutMs?: number;
};
type NativeHookRelayCommandForEventOptions = {
timeoutMs?: number;
};
type InvokeNativeHookRelayParams = {
provider: unknown;
relayId: unknown;
generation?: unknown;
event: unknown;
rawPayload: unknown;
requireGeneration?: boolean;
};
type NativeHookRelayPermissionDecision = "allow" | "deny";
type NativeHookRelayPermissionApprovalResult = NativeHookRelayPermissionDecision | "allow-always" | "timed-out" | "defer";
type ActiveNativeHookRelayRegistrationHandle = NativeHookRelayRegistrationHandle & {
generation: string;
};
type NativeHookRelayPermissionApprovalRequest = {
provider: NativeHookRelayProvider;
agentId?: string;
sessionId: string;
sessionKey?: string;
runId: string;
toolName: string;
toolCallId?: string;
cwd?: string;
model?: string;
toolInput: Record<string, JsonValue>;
signal?: AbortSignal;
};
type NativeHookRelayPermissionApprovalRequester = (request: NativeHookRelayPermissionApprovalRequest) => Promise<NativeHookRelayPermissionApprovalResult>;
type NativeHookRelayDeferredApprovalOutcome = {
handled: true;
outcome: "approved-once";
} | {
handled: true;
outcome: "denied";
reason: string;
failureDisposition?: Exclude<BeforeToolCallFailureDisposition, "blocked">;
};
//#endregion
//#region src/agents/harness/native-hook-relay-approval-presentation.d.ts
declare function formatPermissionApprovalDescription(request: NativeHookRelayPermissionApprovalRequest): string;
//#endregion
//#region src/agents/harness/native-hook-relay-permissions.d.ts
type NativeHookRelayDeferredToolApprovalRequester = typeof requestDeferredPluginToolApproval;
declare function resolveNativeHookRelayDeferredToolApproval(params: {
relayId: string;
toolUseId?: string;
signal?: AbortSignal;
}): Promise<NativeHookRelayDeferredApprovalOutcome | undefined>;
declare function permissionRequestToolInputKeyFingerprint(toolInput: Record<string, unknown>): string;
declare function permissionRequestContentFingerprint(request: NativeHookRelayPermissionApprovalRequest): string;
declare function setNativeHookRelayPermissionApprovalRequesterForTests(requester: NativeHookRelayPermissionApprovalRequester): void;
declare function setNativeHookRelayDeferredToolApprovalRequesterForTests(requester: NativeHookRelayDeferredToolApprovalRequester): void;
//#endregion
//#region src/agents/harness/native-hook-relay-command.d.ts
declare function buildNativeHookRelayCommand(params: Omit<Parameters<typeof buildNativeHookRelayCommandWithStateDatabase>[0], "stateDbPath">): string;
declare function buildNativeHookRelayCommandWithStateDatabase(params: {
provider: NativeHookRelayProvider;
relayId: string;
stateDbPath?: string;
generation?: string;
event: NativeHookRelayEvent;
preToolUseUnavailable?: "noop";
timeoutMs?: number;
executable?: string;
nice?: number | false;
nodeExecutable?: string;
}): string;
//#endregion
//#region src/agents/harness/native-hook-relay.d.ts
declare function registerNativeHookRelay(params: RegisterNativeHookRelayParams): ActiveNativeHookRelayRegistrationHandle;
declare function invokeNativeHookRelay(params: InvokeNativeHookRelayParams, invocationSignal?: AbortSignal): Promise<NativeHookRelayProcessResponse>;
declare function hasNativeHookRelayInvocation(params: {
relayId: string;
event: NativeHookRelayEvent;
toolUseId?: string;
}): boolean;
declare const testing: {
readonly clearNativeHookRelaysForTests: () => Promise<void>;
readonly getNativeHookRelayInvocationsForTests: () => NativeHookRelayInvocation[];
readonly getNativeHookRelayRegistrationForTests: (relayId: string) => NativeHookRelayRegistration | undefined;
readonly getNativeHookRelayBridgeDirForTests: () => string;
readonly getNativeHookRelayBridgeRegistryPathForTests: (relayId: string) => string;
readonly getNativeHookRelayBridgeRecordForTests: (relayId: string) => Promise<Record<string, unknown> | undefined>;
readonly isNativeHookRelayBridgeLookupRetryableForTests: (error: unknown, elapsedMs?: number) => boolean;
readonly formatPermissionApprovalDescriptionForTests: typeof formatPermissionApprovalDescription;
readonly permissionRequestContentFingerprintForTests: typeof permissionRequestContentFingerprint;
readonly permissionRequestToolInputKeyFingerprintForTests: typeof permissionRequestToolInputKeyFingerprint;
readonly setNativeHookRelayPermissionApprovalRequesterForTests: typeof setNativeHookRelayPermissionApprovalRequesterForTests;
readonly setNativeHookRelayDeferredToolApprovalRequesterForTests: typeof setNativeHookRelayDeferredToolApprovalRequesterForTests;
};
//#endregion
//#region src/infra/approval-display-paths.d.ts
/** Formats user-home paths compactly for approval prompts without normalizing unsafe paths. */
declare function formatApprovalDisplayPath(value: string): string;
//#endregion
//#region src/plugins/hook-agent-context.d.ts
/** Builds channel/provider fields for plugin agent hook context. */
declare function buildAgentHookContextChannelFields(params: {
sessionKey?: string | null;
messageChannel?: string | null;
messageProvider?: string | null;
currentChannelId?: string | null;
messageTo?: string | null;
senderId?: string | null;
agentAccountId?: string | null;
}): Pick<PluginHookAgentContext, "accountId" | "channel" | "channelId" | "chatId" | "messageProvider" | "senderId">;
//#endregion
//#region src/agents/run-cleanup-timeout.d.ts
type AgentCleanupLogger = {
warn: (message: string) => void;
};
type AgentCleanupStepParams = {
runId: string;
sessionId: string;
step: string;
cleanup: () => Promise<void>;
getTimeoutDetails?: () => string | undefined;
log: AgentCleanupLogger;
env?: NodeJS.ProcessEnv;
timeoutMs?: number;
};
/** Run one cleanup step with timeout logging and late-rejection handling. */
declare function runAgentCleanupStep(params: AgentCleanupStepParams): Promise<void>;
//#endregion
//#region src/agents/run-termination.d.ts
declare function resolveAgentRunAbortLifecycleFields(signal: AbortSignal | undefined): {
aborted?: true;
stopReason?: typeof AGENT_RUN_ABORTED_STOP_REASON | typeof AGENT_RUN_RESTART_ABORT_STOP_REASON | typeof AGENT_RUN_SUPERSEDED_STOP_REASON | "timeout";
};
//#endregion
//#region src/agents/agent-tools.ring-zero-context.d.ts
/**
* Read a host-owned tool fact for the current run. This does not activate or
* grant a tool; only the host can bind executable authority to the run scope.
*/
declare function isHostScopedAgentToolActive(toolName: string): boolean;
//#endregion
//#region src/agents/embedded-agent-runner/logger.d.ts
/**
* Shared logger for embedded-agent runner internals.
*/
declare const log: SubsystemLogger;
//#endregion
//#region src/agents/runtime-plan/build.d.ts
/** Build the complete runtime plan for an embedded agent attempt. */
declare function buildAgentRuntimePlan(params: BuildAgentRuntimePlanParams): AgentRuntimePlan;
//#endregion
//#region src/agents/runtime-plan/prepare-auth.d.ts
type PrepareAgentRuntimeAuthPlanParams = {
provider: string;
modelId: string;
modelApi?: string | null;
modelBaseUrl?: unknown;
requestTransportOverrides?: ProviderRouteOverridePresence;
config?: OpenClawConfig;
agentId?: string;
routeIntent?: ProviderResolveModelRoutesContext["routeIntent"];
env?: NodeJS.ProcessEnv;
agentDir?: string;
workspaceDir?: string;
metadataSnapshot?: PluginMetadataSnapshot;
authProfileStore?: AuthProfileStore;
sessionAuthProfileId?: string;
sessionAuthProfileSource?: "auto" | "user" | "user-link";
allowAuthProfileFallback?: boolean;
harnessId?: string;
harnessRuntime?: string;
harnessAuthBootstrap?: "harness";
allowHarnessAuthProfileForwarding?: boolean;
allowTransientCooldownProbe?: boolean;
resolveProviderPreferredProfileId?(context: {
config?: OpenClawConfig;
agentDir?: string;
workspaceDir?: string;
provider: string;
modelId: string;
preferredProfileId?: string;
lockedProfileId?: string;
profileOrder: string[];
authStore: AuthProfileStore;
}): string | undefined;
};
type PreparedAgentRuntimeAuthAttempt = {
kind: "profile";
plan: AgentRuntimeAuthPlan;
profileId: string;
allowAuthProfileFallback?: never;
requiresPriorProfileAttempt?: never;
} | {
kind: "direct";
plan: AgentRuntimeAuthPlan;
profileId?: never;
/** Direct lookup cannot re-enter automatic profile discovery. */
allowAuthProfileFallback: false;
/** Fail closed when every prepared profile became cooldown-blocked before dispatch. */
requiresPriorProfileAttempt: boolean;
} | {
kind: "implicit";
plan: AgentRuntimeAuthPlan;
profileId?: never;
allowAuthProfileFallback?: never;
requiresPriorProfileAttempt?: never;
};
type PreparedAgentRuntimeAuth = {
plan: AgentRuntimeAuthPlan;
/** Ordered physical attempts; every route/profile tuple was selected by this planner. */
attempts: readonly PreparedAgentRuntimeAuthAttempt[];
};
/** Selects concrete provider routes and ordered credentials as one immutable preparation. */
declare function prepareAgentRuntimeAuth(input: PrepareAgentRuntimeAuthPlanParams): PreparedAgentRuntimeAuth;
//#endregion
//#region src/agents/embedded-agent-runner/result-fallback-classifier.d.ts
/** Delivered output, deliberate silence, hook blocks, and aborts must not trigger another model. */
declare function classifyEmbeddedAgentRunResultForModelFallback(params: {
provider: string;
model: string;
result: unknown;
hasDirectlySentBlockReply?: boolean;
hasBlockReplyPipelineOutput?: boolean;
}): ModelFallbackResultClassification;
//#endregion
//#region src/infra/device-identity-store.d.ts
type DeviceIdentity = {
deviceId: string;
publicKeyPem: string;
privateKeyPem: string;
};
//#endregion
//#region src/gateway/transport-error.d.ts
type GatewayTransportErrorKind = "closed" | "timeout";
declare class GatewayTransportError extends Error {
readonly kind: GatewayTransportErrorKind;
readonly connectionDetails: GatewayConnectionDetails;
readonly code?: number;
readonly reason?: string;
readonly timeoutMs?: number;
readonly requestDispatched?: boolean;
constructor(params: {
kind: GatewayTransportErrorKind;
message: string;
connectionDetails: GatewayConnectionDetails;
code?: number;
reason?: string;
timeoutMs?: number;
requestDispatched?: boolean;
});
}
declare function isGatewayTransportError(value: unknown): value is GatewayTransportError;
//#endregion
//#region src/gateway/call.d.ts
declare function isGatewayClientRequestError(value: unknown): value is Error & {
gatewayCode: string;
details?: unknown;
retryable: boolean;
retryAfterMs?: number;
};
//#endregion
//#region src/agents/tools/in-process-gateway.d.ts
/** Whether Gateway routing belongs to this caller or the hosting process. */
declare function hasGatewayToolRoutingContext(): boolean;
//#endregion
//#region src/auto-reply/tool-meta.d.ts
type ToolAggregateOptions = {
markdown?: boolean;
};
/** Formats one grouped tool-progress label from a tool name and metadata entries. */
declare function formatToolAggregate(toolName?: string, metas?: string[], options?: ToolAggregateOptions): string;
//#endregion
//#region src/agents/embedded-agent-messaging.d.ts
/** Return true for core or channel-plugin messaging tool names. */
declare function isMessagingTool(toolName: string): boolean;
/** Return true when the specific tool invocation is an outbound send. */
declare function isMessagingToolSendAction(toolName: string, args: Record<string, unknown>): boolean;
//#endregion
//#region src/agents/embedded-agent-message-delivery.d.ts
type EmbeddedMessageDeliveryFact = {
status: "settled" | "suppressed" | "dryRun" | "failed";
sourceReplyDelivered?: true;
primaryPlatformMessageId?: string;
deliveredTargets?: string[];
partialDelivery: boolean;
createdThreadIds: string[];
};
declare function projectPluginMessageDeliveryFact(value: unknown): EmbeddedMessageDeliveryFact | undefined;
declare function readEmbeddedMessageDeliveryFact(value: unknown): EmbeddedMessageDeliveryFact | undefined;
//#endregion
//#region src/agents/embedded-agent-messaging-extraction.d.ts
declare function extractMessagingToolSourceReplyPayload(result: unknown): MessagingToolSourceReplyPayload | undefined;
declare function extractMessagingToolSend(toolName: string, args: Record<string, unknown>, options?: {
config?: OpenClawConfig;
currentChannelId?: string;
currentMessagingTarget?: string;
currentThreadId?: string;
currentMessageId?: string | number;
replyToMode?: "off" | "first" | "all" | "batched";
hasRepliedRef?: {
value: boolean;
};
}): MessagingToolSend | undefined;
/** Reconciles pending send evidence with the provider's successful action result. */
declare function extractMessagingToolSendResult(pending: MessagingToolSend, result: unknown): MessagingToolSend;
declare function isDeliveredMessagingToolSendToCurrentSource(params: {
send: MessagingToolSend | undefined;
config?: OpenClawConfig;
currentProvider?: string;
currentAccountId?: string;
currentChannelId?: string;
currentMessagingTarget?: string;
currentThreadId?: string;
sessionKey?: string;
deliveredPayload?: unknown;
}): boolean;
//#endregion
//#region src/agents/embedded-agent-tool-media.d.ts
declare function filterToolResultMediaUrls(toolName: string | undefined, mediaUrls: string[], result?: unknown, trustedLocalMediaToolNames?: ReadonlySet<string>): string[];
type ToolResultMediaArtifact = {
mediaUrls: string[];
attachments?: ReplyMediaAttachment[];
audioAsVoice?: boolean;
trustedLocalMedia?: boolean;
};
declare function extractToolResultMediaArtifact(result: unknown): ToolResultMediaArtifact | undefined;
//#endregion
//#region src/agents/embedded-agent-tool-results.d.ts
declare function sanitizeToolArgs(args: unknown): unknown;
/** A string result keeps its string type: only model-visible redaction is applied to it. */
declare function sanitizeToolResult(result: string): string;
declare function sanitizeToolResult(result: unknown): unknown;
declare function extractToolErrorMessage(result: unknown): string | undefined;
//#endregion
//#region src/agents/tool-result-error.d.ts
declare function isToolResultError(result: unknown): boolean;
type ToolResultFailureKind = "blocked" | "cancelled" | "failed" | "timed_out";
/** Classify a thrown tool error without inferring cancellation from message text. */
declare function resolveToolExecutionErrorKind(error: unknown): "failed" | "timed_out";
/** Format a redacted tool error without allowing hostile getters to escape observability. */
declare function formatToolExecutionErrorMessage(error: unknown, fallback: string): string;
/** Classify a resolved structured tool result through the shared terminal contract. */
declare function resolveToolResultFailureKind(result: unknown): ToolResultFailureKind | undefined;
//#endregion
//#region src/agents/tool-operator-hint.d.ts
/** Read operator-facing remediation text from a tool failure, when one was attached. */
declare function readToolOperatorHint(error: unknown): string | undefined;
//#endregion
//#region src/agents/model-tool-support.d.ts
/** Returns whether a catalog model should be offered tool calls. */
declare function supportsModelTools(model: {
compat?: unknown;
}): boolean;
//#endregion
//#region src/agents/channel-tool-metadata.d.ts
type ChannelAgentToolMeta = {
channelId: string;
};
/** Read channel metadata attached to a channel-owned agent tool. */
declare function getChannelAgentToolMeta(tool: ChannelAgentTool): ChannelAgentToolMeta | undefined;
//#endregion
//#region src/agents/skill-workshop-prompt.d.ts
/**
* System-prompt contribution for routing durable skill edits through the
* Skill Workshop tool, while edits the user asks for in skills they own stay
* ordinary file work.
*/
declare const SKILL_WORKSHOP_TOOL_NAME = "skill_workshop";
/** Build the system-prompt section for Skill Workshop routing rules. */
declare function buildSkillWorkshopPromptSection(): string[];
//#endregion
//#region src/agents/delegation-guidance.d.ts
declare function resolveMainSessionDelegationMode(params: {
config?: OpenClawConfig;
agentId?: string;
sessionKey?: string;
}): SubagentDelegationMode;
declare function buildDelegationGuidanceSection(params: {
mode: SubagentDelegationMode;
isMinimal: boolean;
hiddenDelegationTool: string;
hasVisibleSessionSpawn: boolean;
hasSessionsYield: boolean;
hasSubagentsList: boolean;
hasSessionsSend: boolean;
}): string[];
//#endregion
//#region src/auto-reply/source-reply-delivery-mode.d.ts
declare function buildHarnessVisibleReplyGuidance(params: {
sourceReplyDeliveryMode?: string;
messageToolAvailable: boolean;
requireExplicitMessageTarget?: boolean;
uiPresentation?: Parameters<typeof buildUiPresentationPrompt>[0];
}): string;
//#endregion
//#region src/agents/credential-safety-prompt.d.ts
type CredentialSafetyPromptOptions = {
controlToolsAvailable?: boolean;
};
declare function buildCredentialSafetyPrompt(
/**
* @deprecated The legacy string argument is ignored and supported through
* 2026-11-30. Use the options object `{ controlToolsAvailable }` instead.
*/
input?: string | CredentialSafetyPromptOptions): string;
//#endregion
//#region src/agents/tools/ask-user-tool-normalization.d.ts
/** Shared human-question wait contract, including credential entry and harness watchdogs. */
declare function normalizeQuestionTimeoutSeconds(rawTimeoutSeconds: unknown): number;
//#endregion
//#region src/agents/embedded-agent-runner/run/attempt-prompt-helpers.d.ts
declare function resolveAttemptFsWorkspaceOnly(params: {
config?: OpenClawConfig;
sessionAgentId: string;
}): boolean;
type AfterTurnRuntimeContextAttempt = Pick<EmbeddedRunAttemptParams$1, "sessionTarget" | "contextEngineAgentId" | "sessionKey" | "sandboxSessionKey" | "sandboxAgentId" | "messageChannel" | "messageProvider" | "agentAccountId" | "currentChannelId" | "currentThreadTs" | "currentMessageId" | "config" | "skillsSnapshot" | "toolsAllow" | "senderId" | "provider" | "modelId" | "agentHarnessId" | "modelSelectionLocked" | "thinkLevel" | "reasoningLevel" | "bashElevated" | "extraSystemPrompt" | "ownerNumbers" | "authProfileId" | "authProfileIdSource" | "runtimePlan" | "userTurnTranscriptRecorder"> & {
sessionId?: EmbeddedRunAttemptParams$1["sessionId"];
};
/** Build runtime context passed into context-engine afterTurn hooks. */
declare function buildAfterTurnRuntimeContext(params: {
attempt: AfterTurnRuntimeContextAttempt;
workspaceDir: string;
cwd?: string;
agentDir: string;
activeAgentId?: string;
contextEnginePluginId?: string;
tokenBudget?: number;
currentTokenCount?: number;
promptCache?: ContextEnginePromptCacheInfo;
}): ContextEngineRuntimeContext;
declare function buildAfterTurnRuntimeContextFromUsage(params: Omit<Parameters<typeof buildAfterTurnRuntimeContext>[0], "currentTokenCount"> & {
lastCallUsage?: NormalizedUsage;
}): ContextEngineRuntimeContext;
//#endregion
//#region src/agents/embedded-agent-runner/run/attempt-thread-helpers.d.ts
/**
* Returns the workspace path that must be mounted for sandboxed spawn attempts.
* Read-only sandbox modes need the resolved workspace explicitly; full rw
* access uses the normal workspace wiring.
*/
declare function resolveAttemptSpawnWorkspaceDir(params: {
sandbox?: {
enabled?: boolean;
workspaceAccess?: string;
} | null;
resolvedWorkspace: string;
}): string | undefined;
//#endregion
//#region src/agents/embedded-agent-runner/run/attempt-tool-run-context.d.ts
type AttemptToolRunFacts = Pick<RunEmbeddedAgentParams, "clientCaps" | "gatewayUiCommandTarget" | "pinnedWidgetAuthoring" | "toolBindings" | "chatType" | "agentAccountId" | "messageTo" | "messageThreadId" | "chatId" | "messageActionTurnCapability" | "groupId" | "groupChannel" | "groupSpace" | "memberRoleIds" | "spawnedBy" | "senderId" | "senderName" | "senderUsername" | "senderE164" | "senderIsOwner" | "scheduledToolPolicy" | "approvalReviewerDeviceId" | "currentChannelId" | "currentMessagingTarget" | "currentThreadTs" | "currentMessageId" | "replyToMode" | "hasRepliedRef" | "sourceReplyDeliveryMode" | "taskSuggestionDeliveryMode">;
/**
* Builds the shared tool-run context for embedded and plugin harness attempts.
*/
declare function buildEmbeddedAttemptToolRunContext(params: AttemptToolRunFacts & {
model?: Pick<EmbeddedRunAttemptParams$1["model"], "provider" | "id">;
thinkLevel?: ThinkLevel;
trigger?: EmbeddedRunTrigger;
jobId?: string;
memoryFlushWritePath?: string;
toolsAllow?: string[];
forceMessageTool?: boolean;
swarmCollector?: boolean;
swarmOutputSchema?: Record<string, unknown>;
conversationToolPolicy?: GroupToolPolicyConfig;
trace?: DiagnosticTraceContext;
currentInboundAudio?: boolean;
replyOperation?: {
readonly acceptedSteeredInboundAudio: boolean;
};
}): {
clientCaps: string[] | undefined;
gatewayUiCommandTarget: Readonly<{
connId: string;
profileId?: string;
}> | undefined;
pinnedWidgetAuthoring: boolean | undefined;
toolBindings: Readonly<Record<string, unknown>> | undefined;
chatType: ChatType | undefined;
agentAccountId: string | undefined;
messageTo: string | undefined;
messageThreadId: string | number | undefined;
nativeChannelId: string | undefined;
messageActionTurnCapability: string | undefined;
groupId: string | null | undefined;
groupChannel: string | null | undefined;
groupSpace: string | null | undefined;
memberRoleIds: string[] | undefined;
spawnedBy: string | null | undefined;
senderId: string | null | undefined;
senderName: string | null | undefined;
senderUsername: string | null | undefined;
senderE164: string | null | undefined;
senderIsOwner: boolean | undefined;
scheduledToolPolicy: ScheduledToolPolicyContext | undefined;
approvalReviewerDeviceId: string | undefined;
currentChannelId: string | undefined;
currentMessagingTarget: string | undefined;
currentThreadTs: string | undefined;
currentMessageId: string | number | undefined;
replyToMode: "all" | "batched" | "first" | "off" | undefined;
hasRepliedRef: {
value: boolean;
} | undefined;
sourceReplyDeliveryMode: SourceReplyDeliveryMode | undefined;
taskSuggestionDeliveryMode: "gateway" | undefined;
requesterThinkingLevel: "adaptive" | "high" | "low" | "max" | "medium" | "minimal" | "off" | "ultra" | "xhigh" | undefined;
requesterModel: {
provider: string;
model: string;
} | undefined;
trigger: EmbeddedRunTrigger | undefined;
jobId: string | undefined;
memoryFlushWritePath: string | undefined;
swarmCollector: boolean | undefined;
swarmOutputSchema: Record<string, unknown> | undefined;
currentInboundAudio: boolean | undefined;
hasCurrentInboundAudio: () => boolean;
runtimeToolAllowlist?: string[] | undefined;
conversationToolPolicy?: {
allow?: string[] | undefined;
alsoAllow?: string[] | undefined;
deny?: string[] | undefined;
} | undefined;
trace?: DiagnosticTraceContext | undefined;
};
//#endregion
//#region src/agents/embedded-agent-runner/run/attempt-tool-construction-plan.d.ts
/**
* Applies a runtime allowlist to a concrete tool list after expanding tool and
* plugin groups. Undefined allowlists keep all tools; an explicit empty list
* intentionally disables all runtime tools.
*/
declare function applyEmbeddedAttemptToolsAllow<T extends {
name: string;
}>(tools: T[], toolsAllow?: string[], options?: {
toolMeta?: (tool: T) => {
pluginId: string;
} | undefined;
toolAliases?: (tool: T) => readonly string[];
}): T[];
/**
* Decides which tool families need to be constructed for an embedded attempt.
* This keeps allowlisted plugin/channel tools available without forcing every
* local core tool factory to run for narrow plugin-only configurations.
*/
declare function resolveEmbeddedAttemptToolConstructionPlan(params: {
disableTools?: boolean;
isRawModelRun?: boolean;
toolsEnabled?: boolean;
toolsAllow?: string[];
forceMessageTool?: boolean;
}): {
constructTools: boolean;
includeCoreTools: boolean;
runtimeToolAllowlist?: string[];
codingToolConstructionPlan: OpenClawCodingToolConstructionPlan;
};
//#endregion
//#region src/agents/agent-tool-availability.d.ts
type ToolDefinition = Pick<AnyAgentTool, "name" | "parameters" | "description">;
/** Finalize owner-controlled affordances after filtering; never rebind or grant tools. */
declare function finalizeAgentToolAvailability<T extends ToolDefinition>(tools: readonly T[], options?: {
toolExecutionAllow?: readonly string[];
onPrepared?: (tool: T) => void;
}): T[];
//#endregion
//#region src/agents/harness/registry.d.ts
/** Calls each registered harness dispose hook during registry shutdown or reload. */
declare function disposeRegisteredAgentHarnesses(): Promise<void>;
//#endregion
//#region src/agents/runtime-plan/tools.d.ts
type AgentRuntimeToolPolicyParams<TSchemaType extends TSchema = TSchema, TResult = unknown> = {
runtimePlan?: AgentRuntimePlan;
tools: AgentTool<TSchemaType, TResult>[];
provider: string;
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
modelId?: string;
modelApi?: string | null;
model?: ProviderRuntimeModel;
runtimeHandle?: ProviderRuntimePluginHandle;
allowProviderRuntimePluginLoad?: boolean;
/**
* Invoked on every normalization, including with an empty list, so
* consumers can observe the all-clear and retire stale quarantine state.
*/
onPreNormalizationSchemaDiagnostics?: (diagnostics: readonly RuntimeToolSchemaDiagnostic[], tools: readonly AgentTool<TSchemaType, TResult>[]) => void;
};
/** Normalizes tool schemas through a runtime plan or provider fallback policy. */
declare function normalizeAgentRuntimeTools<TSchemaType extends TSchema = TSchema, TResult = unknown>(params: Omit<AgentRuntimeToolPolicyParams<TSchemaType, TResult>, "tools"> & {
tools: readonly AgentTool<TSchemaType, TResult>[];
}): AgentTool<TSchemaType, TResult>[];
/** Emits runtime-plan or provider fallback diagnostics for normalized tools. */
declare function logAgentRuntimeToolDiagnostics(params: AgentRuntimeToolPolicyParams): void;
//#endregion
//#region src/agents/embedded-agent-runner/tool-schema-runtime.d.ts
type ProviderToolSchemaParams<TSchemaType extends TSchema = TSchema, TResult = unknown> = {
tools: AgentTool<TSchemaType, TResult>[];
provider: string;
config?: OpenClawConfig;
workspaceDir?: string;
env?: NodeJS.ProcessEnv;
modelId?: string;
modelApi?: string | null;
model?: ProviderRuntimeModel;
runtimeHandle?: ProviderRuntimePluginHandle;
allowRuntimePluginLoad?: boolean;
};
/**
* Runs provider-owned tool-schema normalization without encoding provider
* families in the embedded runner.
*/
declare function normalizeProviderToolSchemas<TSchemaType extends TSchema = TSchema, TResult = unknown>(params: ProviderToolSchemaParams<TSchemaType, TResult>): AgentTool<TSchemaType, TResult>[];
//#endregion
//#region src/agents/agent-bundle-mcp-names.d.ts
/**
* Assign safe server names from the full declared set in declaration order,
* independent of which servers resolve for a requester. Declaration order
* preserves legacy collision-suffix ownership for existing static configs;
* sorting here would silently swap safe names between colliding servers.
*/
declare function assignSafeServerNames(serverNames: Iterable<string>): Map<string, string>;
//#endregion
//#region src/agents/sandbox/bind-spec.d.ts
/**
* Parser for Docker-style host:container[:options] bind specs.
*/
type SplitBindSpec = {
host: string;
container: string;
options: string;
};
/** Splits a bind spec while preserving Windows drive-letter prefixes in host paths. */
declare function splitSandboxBindSpec(spec: string, options?: {
allowWindowsContainerPath?: boolean;
}): SplitBindSpec | null;
//#endregion
//#region src/agents/sandbox/fs-paths.d.ts
declare function resolveWritableSandboxBindHostRoots(binds: readonly string[] | undefined): string[];
declare function hasSandboxBindContainerPathAliases(binds: readonly string[] | undefined): boolean;
declare function hasSandboxBindReadonlyHostShadows(binds: readonly string[] | undefined): boolean;
//#endregion
//#region src/agents/harness/workspace-instructions.d.ts
/** Projects already-bounded agent instructions without changing bootstrap budgets. */
declare function buildAgentWorkspaceInstructionSnapshot(contextFiles: readonly EmbeddedContextFile[], workspaceDir: string): {
files: EmbeddedContextFile[];
instructions: string;
};
//#endregion
//#region src/agents/harness/workspace-context.d.ts
type BootstrapFile = Awaited<ReturnType<typeof resolveBootstrapFilesForRun>>[number];
type AgentWorkspaceContextParams = Parameters<typeof resolveBootstrapFilesForRun>[0] & {
scope: "full" | "instructions-only";
memoryToolRouted?: boolean;
memoryTools?: {
/** Complete policy-admitted tool set available to the active memory prompt builder. */
toolNames: readonly string[];
citationsMode?: Parameters<typeof prepareMemorySystemPromptAddition>[0]["citationsMode"];
sandboxed?: boolean;
};
projectPath?: (filePath: string) => string;
nativeProjectDocBasenames?: ReadonlySet<string>;
contextFileOrder?: ReadonlyMap<string, number>;
promptMemoryWorkspaceDir?: string;
onMemoryPreparationError?: (error: unknown) => void;
};
type AgentWorkspaceContext = {
bootstrapFiles: BootstrapFile[];
contextFiles: EmbeddedContextFile[];
instructionSnapshot: ReturnType<typeof buildAgentWorkspaceInstructionSnapshot>;
personaFiles: EmbeddedContextFile[];
personaInstructions?: string;
promptContextFiles: EmbeddedContextFile[];
memoryReferenceFiles: EmbeddedContextFile[];
memoryToolRoutedBootstrapFiles: BootstrapFile[];
memoryRecallInstructions?: string;
};
/** Prepares Gateway workspace facts; the harness owns their native carriers and lifetime. */
declare function prepareAgentWorkspaceContext(params: AgentWorkspaceContextParams): Promise<AgentWorkspaceContext>;
//#endregion
//#region src/plugin-sdk/session-write-lock-runtime.d.ts
/**
* @deprecated Session write leases were removed. This compatibility type is scheduled for
* removal in the 2026.10 release train; use the session lane and durable writer claim/fence.
*/
type SessionWriteLockAcquireTimeoutConfig = OpenClawConfig;
type LockParams = {
sessionFile: string;
timeoutMs?: number;
staleMs?: number;
maxHoldMs?: number;
signal?: AbortSignal;
} & ({
targetKind: "session-key";
allowReentrant?: boolean;
reentrantOwner?: never;
} | {
targetKind?: "file";
reentrantOwner?: string;
allowReentrant?: never;
});
/**
* @deprecated Session write leases were removed. This compatibility stub is scheduled for
* removal in the 2026.10 release train; use the session lane and durable writer claim/fence.
*/
declare function resolveSessionWriteLockAcquireTimeoutMs(_config?: SessionWriteLockAcquireTimeoutConfig, _env?: NodeJS.ProcessEnv): number;
/**
* @deprecated Session write leases were removed. This compatibility stub is scheduled for
* removal in the 2026.10 release train; use the session lane and durable writer claim/fence.
*/
declare function resolveSessionWriteLockOptions(_config?: SessionWriteLockAcquireTimeoutConfig, _params?: {
env?: NodeJS.ProcessEnv;
maxHoldMsFallback?: number;
}): {
timeoutMs: number;
staleMs: number;
maxHoldMs: number;
};
/**
* @deprecated Session write leases were removed. This no-op compatibility stub is scheduled
* for removal in the 2026.10 release train; use the session lane and durable writer claim/fence.
*/
declare function acquireSessionWriteLock(_params: LockParams): Promise<{
assertOwned: () => void;
release: () => Promise<void>;
}>;
//#endregion
//#region src/agents/tool-mutation.d.ts
/** Return true only for tool calls whose structured contract proves replay safety. */
declare function isReplaySafeToolCall(toolName: string, args: unknown): boolean;
//#endregion
//#region src/agents/harness/hook-context.d.ts
/**
* Input facts used to build the agent portion of plugin hook events.
*
* Only stable run/session/model facts are forwarded to plugin hooks; config remains a local
* construction input so hooks do not accidentally depend on mutable raw configuration.
*/
type AgentHarnessHookContext = Omit<PluginHookAgentContext, "activeProjectKeys" | "senderExternalId" | "toolAuthority" | "hookInvocation"> & {
config?: OpenClawConfig;
};
//#endregion
//#region src/agents/harness/prompt-compaction-hook-helpers.d.ts
/** Prompt/developer-instruction pair after harness prompt-build hooks run. */
type AgentHarnessPromptBuildResult = {
prompt: string;
developerInstructions: string;
/** Optional per-turn tool restriction requested by before_prompt_build hooks. */
toolsAllow?: string[];
/** Span within prompt containing the original prompt input. */
promptInputRange?: {
start: number;
end: number;
};
};
type AgentHarnessDeveloperInstructionBuilder = {
build: (params: {
toolsAllow?: string[];
hasToolRestrictions: boolean;
}) => string | undefined;
};
/** Runs before-prompt hooks and returns the adjusted prompt fields. */
declare function resolveAgentHarnessBeforePromptBuildResult(params: {
prompt: string;
currentInboundContext?: CurrentInboundPromptContext;
currentUserMessage?: string | Pick<PersistedUserTurnMessage, "content" | "idempotencyKey">;
currentUserMessageId?: string;
developerInstructions: string | AgentHarnessDeveloperInstructionBuilder;
messages: unknown[] | (() => Promise<unknown[]>);
ctx: AgentHarnessHookContext;
bootstrapContextRunKind?: BootstrapContextRunKind;
toolAuthority?: {
fingerprint?: string;
activeToolNames: () => readonly string[];
assertActive: () => void;
};
}): Promise<AgentHarnessPromptBuildResult>;
/** Runs best-effort before-compaction hooks for a harness session. */
declare function runAgentHarnessBeforeCompactionHook(params: {
sessionFile: string;
messages?: AgentMessage[];
ctx: AgentHarnessHookContext;
}): Promise<void>;
/** Runs best-effort after-compaction hooks for a harness session. */
declare function runAgentHarnessAfterCompactionHook(params: {
sessionFile: string;
messages?: AgentMessage[];
ctx: AgentHarnessHookContext;
compactedCount: number;
}): Promise<void>;
//#endregion
//#region src/agents/harness/codex-app-server-extensions.d.ts
/** Creates a runner that applies registered Codex app-server tool-result extensions. */
declare function createCodexAppServerToolResultExtensionRunner(ctx: CodexAppServerExtensionContext, factories?: CodexAppServerExtensionFactory[]): {
applyToolResultExtensions(event: CodexAppServerToolResultEvent): Promise<AgentToolResult<unknown>>;
};
//#endregion
//#region src/agents/harness/tool-result-middleware.d.ts
declare function createAgentToolResultMiddlewareRunner(ctx: AgentToolResultMiddlewareContext, handlers?: AgentToolResultMiddleware[]): {
applyToolResultMiddleware(event: AgentToolResultMiddlewareEvent): Promise<OpenClawAgentToolResult>;
};
//#endregion
//#region src/agents/harness/context-engine-lifecycle.d.ts
type HarnessRuntimeSettingsParams = {
runtimeSettings?: ContextEngineRuntimeSettings;
contextEngineHostSupport?: ContextEngineHostSupport;
harnessId?: string | null;
runtimeId?: string | null;
providerId?: string | null;
requestedModelId?: string | null;
modelId?: string | null;
modelFamily?: string | null;
tokenBudget?: number | null;
maxOutputTokens?: number | null;
fallbackReason?: string | null;
degradedReason?: string | null;
contextEngine?: ContextEngine;
};
declare function bootstrapHarnessContextEngine(params: Omit<HarnessRuntimeSettingsParams, "modelFamily" | "tokenBudget"> & {
hadSessionFile: boolean;
sessionId: string;
sessionKey?: string;
sessionTarget?: ContextEngineSessionTarget;
sessionFile: string;
sessionManager?: unknown;
runtimeContext?: ContextEngineRuntimeContext;
transcriptReadFence?: UserTurnTranscriptAdmissionReceipt;
runMaintenance?: typeof runHarnessContextEngineMaintenance;
config?: OpenClawConfig;
warn: (message: string) => void;
}): Promise<void>;
declare function assembleHarnessContextEngine(params: Omit<HarnessRuntimeSettingsParams, "modelId" | "tokenBudget"> & {
sessionId: string;
sessionKey?: string;
agentId?: string;
appendOnlyRuntimeContext?: boolean;
messages: AgentMessage[];
tokenBudget?: number;
availableTools?: Set<string>;
citationsMode?: MemoryCitationsMode;
sandboxed?: boolean;
modelId: string;
prompt?: string;
runtimeContext?: ContextEngineRuntimeContext;
transcriptReadFence?: UserTurnTranscriptAdmissionReceipt;
}): Promise<AssembleResult | undefined>;
declare function finalizeHarnessContextEngineTurn(params: Omit<HarnessRuntimeSettingsParams, "modelFamily" | "tokenBudget"> & {
promptError: boolean;
aborted: boolean;
yieldAborted: boolean;
sessionIdUsed: string;
sessionKey?: string;
sessionTarget?: ContextEngineSessionTarget;
sessionFile: string;
messagesSnapshot: AgentMessage[];
prePromptMessageCount: number;
tokenBudget?: number;
runtimeContext?: ContextEngineRuntimeContext;
runMaintenance?: typeof runHarnessContextEngineMaintenance;
sessionManager?: unknown;
config?: OpenClawConfig;
warn: (message: string) => void;
/** True when this turn belongs to a heartbeat run. */
isHeartbeat?: boolean;
}): Promise<{
postTurnFinalizationSucceeded: boolean;
}>;
declare function runHarnessContextEngineMaintenance(params: Omit<HarnessRuntimeSettingsParams, "modelFamily"> & {
sessionId: string;
sessionKey?: string;
sessionTarget?: ContextEngineSessionTarget;
sessionFile: string;
reason: "bootstrap" | "compaction" | "turn";
sessionManager?: unknown;
runtimeContext?: ContextEngineRuntimeContext;
executionMode?: "foreground" | "background";
onDeferredMaintenance?: (promise: Promise<void>) => void;
withSessionManagerRewriteLock?: <T>(operation: () => Promise<T> | T) => Promise<T>;
config?: OpenClawConfig;
}): Promise<TranscriptRewriteResult | undefined>;
declare function isActiveHarnessContextEngine(contextEngine: ContextEngine | undefined): contextEngine is ContextEngine;
//#endregion
//#region src/agents/embedded-agent-runner/compaction-safety-timeout.d.ts
declare function resolveCompactionTimeoutMs(cfg?: OpenClawConfig): number;
declare function compactWithSafetyTimeout<T>(compact: (abortSignal: AbortSignal | undefined, resetTimeout: () => void) => Promise<T>, timeoutMs?: number, opts?: {
abortSignal?: AbortSignal;
onCancel?: () => void;
}): Promise<T>;
type ContextEngineCompactParams = Parameters<ContextEngine["compact"]>[0];
/**
* Only the built-in delegate can refresh the watchdog on progress. Every engine
* stays host-bounded and receives the composed timeout/caller cancellation signal.
*/
declare function compactContextEngineWithSafetyTimeout(contextEngine: Pick<ContextEngine, "compact" | "info">, params: ContextEngineCompactParams, timeoutMs?: number, abortSignal?: AbortSignal): Promise<CompactResult>;
//#endregion
//#region src/agents/embedded-agent-runner/run/preemptive-compaction.d.ts
declare const PREEMPTIVE_OVERFLOW_ERROR_TEXT = "Context overflow: prompt too large for the model (precheck).";
type CompactionPressureDecision = {
route: PreemptiveCompactionRoute;
shouldCompact: boolean;
estimatedPromptTokens: number;
pressureSource?: string;
promptBudgetBeforeReserve: number;
overflowTokens: number;
toolResultReducibleChars: number;
effectiveReserveTokens: number;
};
/** Diagnostic maximum plus the independently selected outgoing checkpoint's budget. */
type PreemptiveCompactionDecision = CompactionPressureDecision & {
compactionReplay?: CompactionPressureDecision;
};
type CompactionReplayPressureContext = {
model: Model;
sessionId?: string;
authProfileId?: string;
enabled?: boolean;
};
/** Token pressure reported by the rendered provider-boundary prompt when available. */
type LlmBoundaryTokenPressure = {
estimatedPromptTokens: number;
source: string;
renderedChars?: number;
};
/** Estimates only the rendered prompt/system portion when history has already been accounted for. */
declare function estimateRenderedLlmBoundaryTokenPressure(params: {
systemPrompt?: string;
prompt: string;
}): number;
/**
* Decides whether a run should compact before submitting the prompt, and
* whether reducible tool results can avoid or follow compaction. Rendered LLM
* boundary pressure wins over local transcript estimates when supplied.
*/
declare function shouldPreemptivelyCompactBeforePrompt(params: {
messages: AgentMessage[];
unwindowedMessages?: AgentMessage[];
systemPrompt?: string;
prompt: string;
contextTokenBudget: number;
reserveTokens: number;
toolResultMaxChars?: number;
toolSchemaTokens?: number;
llmBoundaryTokenPressure?: LlmBoundaryTokenPressure;
replay?: CompactionReplayPressureContext;
}): PreemptiveCompactionDecision;
declare function formatPrePromptPrecheckLog(params: {
result: PreemptiveCompactionDecision;
sessionKey?: string;
sessionId?: string;
provider: string;
modelId: string;
messageCount: number;
unwindowedMessageCount?: number;
contextTokenBudget: number;
reserveTokens: number;
sessionFile?: string;
}): string;
//#endregion
//#region src/context-engine/registry.d.ts
/**
* Return the trusted plugin id that registered a resolved context engine.
* Downgraded engines intentionally report no plugin owner.
*/
declare function resolveContextEngineOwnerPluginId(engine: ContextEngine | undefined | null): string | undefined;
//#endregion
//#region src/agents/harness/hook-helpers.d.ts
/** Runs best-effort after-tool-call hooks for a completed tool invocation. */
declare function runAgentHarnessAfterToolCallHook(params: {
toolName: string;
toolCallId: string;
runId?: string;
agentId?: string;
sessionId?: string;
sessionKey?: string;
channelId?: string;
startArgs: Record<string, unknown>;
result?: unknown;
error?: string;
startedAt?: number;
}): Promise<void>;
/** Runs before-message-write hooks and returns the possibly rewritten message. */
declare function runAgentHarnessBeforeMessageWriteHook(params: {
message: AgentMessage;
agentId?: string;
sessionKey?: string;
prepareAssistantTranscriptMessage?: PrepareAssistantTranscriptMessage;
skipBeforeMessageWriteHooks?: boolean;
}): AgentMessage | null;
//#endregion
//#region src/agents/harness/lifecycle-hook-helpers.d.ts
type AgentHarnessHookRunner = ReturnType<typeof getGlobalHookRunner>;
type AgentHarnessHookParams<Event> = {
event: Event;
ctx: AgentHarnessHookContext;
hookRunner?: AgentHarnessHookRunner;
};
/** Returns the current global hook runner for harness lifecycle hooks. */
declare function getAgentHarnessHookRunner(): AgentHarnessHookRunner;
/** Dispatches best-effort LLM input hooks for a harness attempt. */
declare function runAgentHarnessLlmInputHook(params: AgentHarnessHookParams<PluginHookLlmInputEvent>): void;
/** Dispatches best-effort LLM output hooks for a harness attempt. */
declare function runAgentHarnessLlmOutputHook(params: AgentHarnessHookParams<PluginHookLlmOutputEvent>): void;
/** Starts agent_end hooks with unref timeout behavior. */
declare function runAgentHarnessAgentEndHook(params: AgentHarnessHookParams<PluginHookAgentEndEvent>): void;
/** Runs agent_end hooks and waits for completion. */
declare function awaitAgentHarnessAgentEndHook(params: AgentHarnessHookParams<PluginHookAgentEndEvent>): Promise<void>;
/** Normalized before-finalize hook decision consumed by harness loops. */
type AgentHarnessBeforeAgentFinalizeOutcome = {
action: "continue";
} | {
action: "revise";
reason: string;
} | {
action: "finalize";
reason?: string;
};
/** Runs before-finalize hooks and normalizes finalize/revise/continue decisions. */
declare function runAgentHarnessBeforeAgentFinalizeHook(params: AgentHarnessHookParams<PluginHookBeforeAgentFinalizeEvent>): Promise<AgentHarnessBeforeAgentFinalizeOutcome>;
//#endregion
//#region src/agents/harness/agent-end-side-effects.d.ts
type BaseAgentEndSideEffectsParams = Parameters<typeof runAgentHarnessAgentEndHook>[0];
type AgentEndSideEffectsParams = Omit<BaseAgentEndSideEffectsParams, "ctx"> & {
/** Exact completed-turn boundary; context loading stays off the foreground path. */
skillExperienceReviewSource?: Pick<TranscriptEntryAnchor, "agentId" | "sessionId" | "sessionKey" | "storePath" | "entryId">;
ctx: BaseAgentEndSideEffectsParams["ctx"] & {
authProfileId?: string;
modelIterations?: number;
modelContextWindowTokens?: number;
skillWorkshopAvailable?: boolean;
compacted?: boolean;
foregroundPromptContext?: EmbeddedForegroundPromptContext;
};
};
/** Starts agent-end side effects without waiting for completion. */
declare function runAgentEndSideEffects(params: AgentEndSideEffectsParams): void;
/** Runs agent-end side effects and waits for plugin/core completion. */
declare function awaitAgentEndSideEffects(params: AgentEndSideEffectsParams): Promise<void>;
//#endregion
//#region src/agents/embedded-agent-runner/run/agent-end-context.d.ts
type EmbeddedForegroundPromptContextRun = Pick<EmbeddedRunAttemptParams$1, Exclude<keyof EmbeddedForegroundPromptContext, "agentDir" | "agentId" | "cronCreatorCallerOrigin">> & Pick<EmbeddedRunAttemptParams$1, "cronCreatorAuthorityCapability" | "sessionId" | "sessionKey"> & {
agentId: string;
};
declare function buildEmbeddedForegroundPromptContext(run: EmbeddedForegroundPromptContextRun, agentDir: string): EmbeddedForegroundPromptContext;
//#endregion
//#region src/agents/tool-display-exec.d.ts
type ToolDetailMode = "explain" | "raw";
//#endregion
//#region src/agents/tool-display.d.ts
/** Infers compact display metadata for a tool invocation from its arguments. */
declare function inferToolMetaFromArgsCore(toolName: string, args: unknown, options?: {
detailMode?: ToolDetailMode;
}): string | undefined;
//#endregion
//#region src/plugin-sdk/agent-harness-runtime.d.ts
/** Core exec mode algebra for plugin-owned policy adapters. */
declare const execPolicy: Readonly<{
resolveExecModePolicy: typeof resolveExecModePolicy;
minSecurity: typeof minSecurity;
maxAsk: typeof maxAsk;
}>;
/**
* Renders the Watched Sessions prompt block for plugin-owned harness prompts.
* Harness runtimes that assemble their own instruction layers (e.g. Codex)
* must surface the same watched-session facts as the embedded prompt, or the
* model keeps refusing cross-session questions on those runtimes (openclaw#114797).
*/
declare function buildWatchedSessionsHarnessContext(params: {
config?: OpenClawConfig;
sessionKey?: string;
sandboxed?: boolean;
toolNames: Iterable<string>;
capabilityToolNames?: Iterable<string>;
}): string | undefined;
declare const agentHarnessAttemptTerminal: {
merge: typeof mergeAgentRunAttemptTerminal;
normalize: typeof normalizeAgentRunAttemptTerminal;
project: typeof projectAgentRunAttemptTerminal;
setFailure: typeof setAgentRunAttemptTerminalFailure;
};
type EmbeddedRunAttemptParamsBase = Omit<EmbeddedRunAttemptParams$1, "admittedRunContext" | "disableToolSearch" | "sessionReadScopeKey" | "authoredContextTokenCap" | "contextEngineLogicalTurnLease" | "onContextEngineTurnCandidate" | "pluginHarnessToolPolicySafeDeniedTools" | "trajectoryRecorder"> & {
/** Per-model context cap authored by the operator and forwarded to harness runtimes. */
authoredContextTokenCap?: number;
/** Audited exact denies that the plugin harness must enforce against native equivalents. */
pluginHarnessToolPolicySafeDeniedTools?: readonly string[];
};
/**
* @deprecated Use EmbeddedRunAttemptParamsV2. The optional capability keeps
* existing harness source compatible through 2026-10-12.
*/
type EmbeddedRunAttemptParams = EmbeddedRunAttemptParamsBase & {
hostCapabilities?: AgentHarnessHostCapabilities;
};
/** Current host-prepared attempt contract for agent harnesses. */
type EmbeddedRunAttemptParamsV2 = EmbeddedRunAttemptParamsBase & {
hostCapabilities: AgentHarnessHostCapabilities;
};
/** Bounded structured-input compilation and execution for native agent harnesses. */
declare const agentHarnessStructuredInput: Readonly<{
compileForm: typeof compileStructuredInputForm;
compileQuestions: typeof compileStructuredInputQuestions;
compileUrl: typeof compileStructuredInputUrl;
isRecord: typeof isStructuredInputRecord;
run: typeof runStructuredInput;
snapshot: typeof snapshotStructuredInput;
}>;
/**
* @deprecated Active-run queueing is an internal runtime concern. This legacy
* boolean API only reports immediate queue eligibility and cannot observe async
* runtime rejection; runtime-owned delivery paths should use acceptance-aware
* steering instead of public SDK queueing.
*/
declare function queueAgentHarnessMessage(sessionId: string, text: string, options?: EmbeddedAgentQueueMessageOptions): boolean;
/** Detect prompt image references and load them through the same limits used by embedded runs. */
declare function detectAndLoadAgentHarnessPromptImages(params: {
prompt: string;
userTurnTranscriptRecorder?: EmbeddedAgentQueueMessageOptions["userTurnTranscriptRecorder"];
workspaceDir: string;
agentWorkspaceDir?: string;
model: {
input?: string[];
};
existingImages?: ImageContent$1[];
imageOrder?: PromptImageOrderEntry[];
media?: MediaFact[];
config?: OpenClawConfig;
workspaceOnly?: boolean;
localRoots?: readonly string[];
sandbox?: {
root: string;
bridge: SandboxFsBridge;
};
}): Promise<{
images: ImageContent$1[];
imageFactIndexes: Array<number | null>;
detectedRefs: Array<{
raw: string;
resolved: string;
type: "path" | "media-uri";
}>;
loadedCount: number;
skippedCount: number;
failedMediaCount: number;
}>;
/** Load Codex bundle MCP thread config without forcing the heavy config module into SDK imports. */
declare function loadCodexBundleMcpThreadConfig(params: LoadCodexBundleMcpThreadConfigParams): Promise<CodexBundleMcpThreadConfig>;
/** Lazily load the strict MCP proxy client with core-owned framing, startup, and shutdown. */
declare const mcpStdioRuntime: Readonly<{
load(): Promise<{
createMcpStdioClient: typeof createMcpStdioClient;
}>;
}>;
/**
* Materialize an MCP App view for a tool executed by a harness-native MCP client.
* The harness supplies a runtime adapter so the view keeps using that exact connection.
*/
declare function prepareHarnessNativeMcpAppPreview(params: {
runtime: SessionMcpRuntime;
agentId?: string;
serverName: string;
toolName: string;
uiResourceUri: string;
toolCallId: string;
toolInput: unknown;
toolResult: import("@modelcontextprotocol/sdk/types.js").CallToolResult;
allowedAppToolNames: ReadonlySet<string>;
resultMetaState?: "unavailable";
}): Promise<{
mcpAppPreview: unknown;
} | undefined>;
/**
* Materialize requester-scoped MCP tools for a harness run (dynamic tools, not
* harness-native MCP config). Lazy-loaded so harness plugins avoid the MCP manager graph.
*/
declare function materializeRequesterScopedMcpToolsForHarnessRun(params: Parameters<typeof materializeRequesterScopedMcpToolsForHarnessRunCore>[0]): Promise<Awaited<ReturnType<typeof materializeRequesterScopedMcpToolsForHarnessRunCore>>>;
/**
* Derive the same compact user-facing tool detail that embedded OpenClaw uses for progress logs.
*/
type ToolProgressDetailMode = "explain" | "raw";
/** Inputs used to classify a finished harness turn with little or no visible assistant output. */
type AgentHarnessTerminalOutcomeInput = {
assistantTexts: readonly string[];
reasoningText?: string | null;
planText?: string | null;
promptError?: unknown;
turnCompleted: boolean;
};
/** Terminal fallback classification emitted by agent harness adapters. */
type AgentHarnessTerminalOutcomeClassification = NonNullable<EmbeddedRunAttemptResult["agentHarnessResultClassification"]>;
/**
* Classify terminal harness turns that completed without assistant output that
* should advance fallback. Deliberate silent replies such as NO_REPLY count as
* intentional output, while whitespace-only text remains fallback-eligible.
*/
declare function classifyAgentHarnessTerminalOutcome(params: AgentHarnessTerminalOutcomeInput): AgentHarnessTerminalOutcomeClassification | undefined;
declare const toolPolicy: Readonly<{
createToolPolicyMatcher: typeof createToolPolicyMatcher;
expandToolGroups: typeof expandToolGroups;
}>;
//#endregion
export { resolveSessionWriteLockAcquireTimeoutMs as $, AgentHarnessSessionForkFailureCode as $a, ProviderCacheTtlEligibilityContext as $c, resolveStorePath as $d, resolveSessionKeyBySessionId as $f, createReplyPrefixOptions as $i, PluginCapabilityCatalogHostEntry as $l, createOpenClawCodingTools as $n, DurableMessageBatchSendResult as $o, WorkerLeaseStatus as $p, resolveGlobalDedupeCache as $r, OpenClawPluginSessionsChangedEvent as $s, classifyEmbeddedAgentRunResultForModelFallback as $t, modelSupportsVision as $u, resolveContextEngineOwnerPluginId as A, InternalGetReplyOptions as Aa, DeviceBootstrapOperations as Ac, PluginSessionTurnScheduleParams as Ad, evaluateSessionFreshness as Af, resolveInboundSupplementalSenderAllowed as Ai, ProviderAugmentModelCatalogContext as Al, claimPendingAgentQuestionAnswer as An, ChannelIngressQueue as Ao, SecretInputMode as Ap, recoverCurrentThreadSessionId as Ar, augmentModelCatalogWithProviderPlugins as As, ToolResultFailureKind as At, VERSION as Au, assembleHarnessContextEngine as B, AgentHarnessAuthBindingFingerprintParams as Ba, ExecSessionDefaults as Bc, deleteSessionEntry as Bd, deliveryContextFromSession as Bf, ConversationFacts as Bi, ProviderAuthContext as Bl, AgentHarnessUserInputOption as Bn, consumeSelectedSystemEventEntriesFromSdk as Bo, DEFAULT_OAUTH_REFRESH_MARGIN_MS as Bp, TailscaleStatusCommandResult as Br, OpenClawPluginHttpRouteHandler$1 as Bs, extractMessagingToolSend as Bt, buildPluginConfigSchema as Bu, getAgentHarnessHookRunner as C, createReplyDispatcherWithTyping as Ca, AgentToolResultMiddlewareResult as Cc, PluginSessionActionResult as Cd, normalizeUserText as Cf, FinalizeChannelInboundContextAsyncParams as Ci, ProviderReplayPolicy as Cl, PluginCommandReplyOptions as Cm, isDeliveredMessagingToolResult as Cn, DEFAULT_INGRESS_ADOPTION_STALL_MS as Co, loadAuthProfileStoreWithoutExternalProfiles as Cp, buildThreadAwareOutboundSessionRoute as Cr, resolveTtsPrefsPath as Cs, buildDelegationGuidanceSection as Ct, MemoryPromptSectionBuilder as Cu, runAgentHarnessLlmOutputHook as D, DispatchFromConfigResult as Da, listDevicePairing as Dc, PluginSessionExtensionRegistration as Dd, resolveSessionResetType as Df, filterChannelInboundQuoteContext as Di, ProviderSanitizeReplayHistoryContext as Dl, callGatewayTool as Dm, isCompleteAgentPreamble as Dn, ChannelIngressDrainDispatchResult as Do, resolvePersistedAuthProfileOwnerAgentDir as Dp, defineSetupPluginEntry as Dr, normalizeTtsAutoMode as Ds, getChannelAgentToolMeta as Dt, EmbeddingInput as Du, runAgentHarnessLlmInputHook as E, createTypingCallbacks as Ea, NodeSession as Ec, PluginSessionExtensionProjection as Ed, resolveChannelResetConfig as Ef, buildChannelInboundEventContext as Ei, ProviderReplaySessionState as El, selectDefaultNodeFromList as Em, formatToolProgressOutput as En, DEFAULT_INGRESS_RETRY_MAX_ATTEMPTS as Eo, findPersistedAuthProfileCredential as Ep, defineChannelPluginEntry as Er, resolveEffectiveTtsConfig as Es, buildSkillWorkshopPromptSection as Et, SessionDiscussionState as Eu, formatPrePromptPrecheckLog as F, OpenClawPluginConfigSchema as Fa, PAIRING_SETUP_BOOTSTRAP_PROFILE as Fc, StickyModelSelectionDispatchOutcome as Fd, resolveSessionKey as Ff, ChannelTurnDroppedHistoryOptions as Fi, UnifiedModelCatalogProviderContext as Fl, emptyAgentHarnessUserInputAnswers as Fn, ChannelIngressQueuePruneOptions as Fo, resolveApiKeyForProfile as Fp, GatewayBindUrlResult as Fr, OpenClawPluginToolContext as Fs, extractToolErrorMessage as Ft, getMemoryCapabilityRegistration as Fu, createAgentToolResultMiddlewareRunner as G, AgentHarnessNativeCompaction as Ga, CODEX_APP_SERVER_CONTEXT_ENGINE_HOST as Gc, loadTranscriptEventsSync as Gd, readRecentUserAssistantTextForSession as Gf, recordChannelBotPairLoopAndCheckSuppression as Gi, ProviderPluginWizardSetup as Gl, buildUiPresentationPrompt as Gn, hasSystemEventsFromSdk as Go, MediaUnderstandingProviderPlugin$1 as Gp, generateSecureFraction as Gr, OpenClawPluginSecurityAuditCollector$1 as Gs, readEmbeddedMessageDeliveryFact as Gt, buildPluginNodeCapabilityScopedHostUrl as Gu, finalizeHarnessContextEngineTurn as H, AgentHarnessCompactResult as Ha, SandboxToolPolicy as Hc, getSessionEntry as Hd, sessionDeliveryOrigin as Hf, PreparedChannelTurn as Hi, ProviderAuthMethodNonInteractiveContext as Hl, CodexBundleMcpThreadConfig as Hn, drainSystemEventsFromSdk as Ho, HEARTBEAT_RESPONSE_TOOL_NAME as Hp, resolveTailnetHostWithRunner as Hr, OpenClawPluginNodeInvokePolicyContext as Hs, extractMessagingToolSourceReplyPayload as Ht, DEFAULT_PLUGIN_NODE_CAPABILITY_TTL_MS as Hu, shouldPreemptivelyCompactBeforePrompt as I, AgentHarness as Ia, normalizeDeviceBootstrapProfile as Ic, LoadSessionStoreOptions as Id, SqliteSessionFileMarker as If, ChannelTurnPlan as Ii, UnifiedModelCatalogProviderPlugin$1 as Il, formatAgentHarnessUserInputPrompt as In, ChannelIngressQueueRecord as Io, resolveAuthProfileEligibility as Ip, resolveGatewayBindUrl as Ir, OpenClawPluginToolFactory$1 as Is, sanitizeToolArgs as It, listActiveMemoryPublicArtifacts as Iu, runAgentHarnessAfterCompactionHook as J, AgentHarnessRegistrationOptions as Ja, TrustedSubagentCompletionHandoff as Jc, readSessionUpdatedAt as Jd, updateAmbientTranscriptWatermark as Jf, createChannelReplyPipeline as Ji, UsageWindow as Jl, RuntimeToolSchemaDiagnostic as Jn, peekSystemEventsFromSdk as Jo, SpeechProviderPlugin$1 as Jp, generateSecureToken as Jr, OpenClawPluginServiceContext as Js, formatToolAggregate as Jt, RespondFn as Ju, createCodexAppServerToolResultExtensionRunner as K, AgentHarnessNativeCompactionParams as Ka, assertContextEngineHostSupport as Kc, patchSessionEntry as Kd, AmbientTranscriptWatermarkScope as Kf, ChannelReplyPipeline as Ki, ProviderUsageSnapshot as Kl, RuntimeToolInputSchemaJson as Kn, isSystemEventContextChangedFromSdk as Ko, RealtimeTranscriptionProviderPlugin$1 as Kp, generateSecureHex as Kr, OpenClawPluginSecurityAuditContext as Ks, isMessagingTool as Kt, mintPluginNodeCapabilityToken as Ku, compactContextEngineWithSafetyTimeout as L, AgentHarnessAttemptParams as La, EmbeddedForegroundPromptContext as Lc, SessionStoreTranscriptEvent as Ld, formatSqliteSessionFileMarker as Lf, ChannelTurnRecordOptions as Li, ProviderAppGuidedSetup as Ll, normalizeAgentHarnessUserInputAnswer as Ln, OpenKeyedStoreOptions as Lo, resolveAuthProfileOrder as Lp, buildMemorySystemPromptAddition as Lr, OpenClawGatewayDiscoveryAdvertiseContext as Ls, sanitizeToolResult as Lt, registerMemoryCapability as Lu, PREEMPTIVE_OVERFLOW_ERROR_TEXT as M, PluginHttpRouteRegistration as Ma, DeviceBootstrapProfile as Mc, PluginSessionTurnUnscheduleByTagResult as Md, isValidAgentHarnessSessionStoreEntry as Mf, ChannelCoreManagedTurnDeliveryAdapter as Mi, ProviderCatalogContext as Ml, AgentHarnessUserInputPromptOptions as Mn, ChannelIngressQueueClaimRef as Mo, upsertAuthProfile as Mp, stripTargetKindPrefix as Mr, GatewayRequestHandlers as Ms, isToolResultError as Mt, readResponseWithLimit as Mu, PreemptiveCompactionDecision as N, PluginRegistry as Na, DeviceBootstrapProfileInput as Nc, PluginToolMetadataRegistration as Nd, clearSessionStoreCacheForTest as Nf, ChannelDeliveryInfo as Ni, ProviderCatalogResult as Nl, buildAgentHarnessUserInputAnswers as Nn, ChannelIngressQueueCompletedRecord as No, listProfilesForProvider as Np, resolveConfiguredAcpBindingRecord as Nr, OpenClawPluginApi as Ns, resolveToolExecutionErrorKind as Nt, buildMemoryPromptSection as Nu, runAgentHarnessAfterToolCallHook as O, DispatchReplyFromConfig as Oa, ApproveDevicePairingResult as Oc, PluginSessionSchedulerJobHandle as Od, resolveThreadFlag as Of, filterChannelInboundSupplementalContext as Oi, ProviderToolSchemaDiagnostic as Ol, readGatewayToolOperatorScopes as Om, projectAgentActivityItem as On, ChannelIngressDispatchLifecycle as Oo, clearRuntimeAuthProfileStoreSnapshots as Op, ensureConfiguredAcpBindingReady as Or, ResolvedTtsConfig as Os, supportsModelTools as Ot, attachModelProviderRequestTransport as Ou, estimateRenderedLlmBoundaryTokenPressure as P, OpenClawPluginDefinition as Pa, DeviceBootstrapPurpose as Pc, PluginTrustedToolPolicyRegistration as Pd, resolveGroupSessionKey as Pf, ChannelProviderOwnedMessageSendingDeliveryAdapter as Pi, ProviderModernModelPolicyContext as Pl, deliverAgentHarnessUserInputPrompt as Pn, ChannelIngressQueueCorruptClaim as Po, refreshOAuthCredentialForRuntime as Pp, formatZonedTimestamp as Pr, OpenClawPluginActiveModelContext as Ps, resolveToolResultFailureKind as Pt, clearMemoryPluginState as Pu, acquireSessionWriteLock as Q, AgentHarnessSessionDeletionParams as Qa, ProviderBuildUnknownModelHintContext as Qc, resolveSessionStoreEntry as Qd, recordInboundSessionMeta as Qf, createReplyPrefixContext as Qi, PluginCapabilityCatalogHostContext as Ql, restorePreparedUserTurnOperationalMetaForRuntime as Qn, agentCommandFromIngress as Qo, WorkerLease as Qp, createDedupeCache as Qr, OpenClawPluginGatewayEvents as Qs, DeviceIdentity as Qt, resolveGatewayAuth as Qu, compactWithSafetyTimeout as R, AgentHarnessAttemptParamsV2 as Ra, AgentHarnessRuntimeArtifactBinding as Rc, UpdateSessionStoreOptions as Rd, parseSqliteSessionFileMarker as Rf, ChannelTurnResult as Ri, ProviderAppGuidedSetupCandidate as Rl, AgentHarnessQuestionGatewayCall as Rn, PluginStateKeyedStore as Ro, ProviderAuthAliasLookupParams as Rp, delegateCompactionToRuntime as Rr, OpenClawGatewayDiscoveryService$1 as Rs, extractToolResultMediaArtifact as Rt, registerMemoryCorpusSupplement as Ru, awaitAgentHarnessAgentEndHook as S, createReplyDispatcher as Sa, AgentToolResultMiddlewareOptions as Sc, PluginSessionActionRegistration as Sd, listSessionCatalogEntries as Sf, ChannelInboundSupplementalResolutionOptions as Si, ProviderReasoningOutputModeContext as Sl, PLUGIN_COMMAND_DISPATCH as Sm, isDeliveredMessageToolOnlySourceReplyResult as Sn, CreateChannelIngressDrainOptions as So, loadAuthProfileStoreForSecretsRuntime as Sp, buildChannelOutboundSessionRoute as Sr, resolveTtsConfig as Ss, buildHarnessVisibleReplyGuidance as St, MemoryPluginPublicArtifactsProvider as Su, runAgentHarnessBeforeAgentFinalizeHook as T, TypingCallbacks as Ta, OpenClawAgentToolResult as Tc, PluginSessionAttachmentResult as Td, sessionCatalogAdoptedSourceKey as Tf, FinalizeChannelInboundContextResult as Ti, ProviderReplaySessionEntry as Tl, resolveNodeIdFromList as Tm, TOOL_PROGRESS_OUTPUT_MAX_CHARS as Tn, DEFAULT_INGRESS_RETRY_DEAD_LETTER_MIN_AGE_MS as To, updateAuthProfileStoreWithLock as Tp, createChatChannelPlugin as Tr, TtsConfigResolutionContext as Ts, SKILL_WORKSHOP_TOOL_NAME as Tt, SessionDiscussionProvider as Tu, isActiveHarnessContextEngine as U, AgentHarnessDeliveryDefaults as Ua, SandboxWorkspaceAccess as Uc, listSessionEntries as Ud, sessionDeliveryRoute as Uf, RunChannelTurnParams as Ui, ProviderAuthResult as Ul, LoadCodexBundleMcpThreadConfigParams as Un, enqueueSystemEventEntryFromSdk as Uo, HeartbeatToolResponse as Up, resolveTailscalePublishedHost as Ur, OpenClawPluginNodeInvokePolicyResult as Us, isDeliveredMessagingToolSendToCurrentSource as Ut, NormalizedPluginNodeCapabilityUrl as Uu, bootstrapHarnessContextEngine as V, AgentHarnessCompactParams as Va, SandboxContext as Vc, getConversationSession as Vd, sessionDeliveryChannel as Vf, InboundMediaFacts as Vi, ProviderAuthMethod as Vl, AgentHarnessUserInputQuestion as Vn, drainSystemEventEntriesFromSdk as Vo, hasUsableOAuthCredential as Vp, TailscaleStatusCommandRunner as Vr, OpenClawPluginNodeInvokePolicy as Vs, extractMessagingToolSendResult as Vt, emptyPluginConfigSchema as Vu, runHarnessContextEngineMaintenance as W, AgentHarnessModelCatalogParams as Wa, EmbeddedBlockChunker as Wc, loadSessionStore as Wd, SessionRecentConversationText as Wf, ChannelBotLoopProtectionFacts as Wi, ProviderDeferSyntheticProfileAuthContext as Wl, isAgentToolReplaySafe as Wn, enqueueSystemEventFromSdk as Wo, normalizeHeartbeatToolResponse as Wp, resolveTailscaleServeGatewayUrlsWithRunner as Wr, OpenClawPluginReloadRegistration$1 as Ws, projectPluginMessageDeliveryFact as Wt, PLUGIN_NODE_CAPABILITY_PATH_PREFIX as Wu, isReplaySafeToolCall as X, AgentHarnessResultClassification as Xa, ProviderPlugin as Xc, resolveSessionFilePath as Xd, isOpenClawRuntimeContextCustomMessage as Xf, ReplyPrefixContextBundle as Xi, PluginCapabilityCatalogContext as Xl, inspectRuntimeToolInputSchemas as Xn, resetSystemEventsForTest as Xo, WorkerDesktopApp as Xp, DedupeCache as Xr, PluginInteractiveRegistration as Xs, isGatewayClientRequestError as Xt, RateLimitConfig as Xu, runAgentHarnessBeforeCompactionHook as Y, AgentHarnessResetParams as Ya, EmbeddedAgentCompactResult as Yc, readTranscriptStatsSync as Yd, canonicalizeMainSessionAlias as Yf, resolveChannelSourceReplyDeliveryMode as Yi, PluginLoadOptions as Yl, filterProviderNormalizableTools as Yn, SystemEvent as Yo, TranscriptSourceProvider$1 as Yp, generateSecureUuid as Yr, PluginInteractiveHandlerRegistration$1 as Ys, hasGatewayToolRoutingContext as Yt, AuthRateLimiter as Yu, SessionWriteLockAcquireTimeoutConfig as Z, AgentHarnessSessionDeletionMutation as Za, ProviderBuildMissingAuthMessageContext as Zc, resolveSessionStoreBackupPaths as Zd, appendTranscriptEvent as Zf, ReplyPrefixOptions as Zi, PluginCapabilityCatalogEntry as Zl, projectRuntimeToolInputSchema as Zn, resolveSystemEventDeliveryContext as Zo, WorkerDesktopEndpoint as Zp, DedupeCacheOptions as Zr, OpenClawPluginGatewayEventScope as Zs, isGatewayTransportError as Zt, ResolvedGatewayAuth as Zu, toolPolicy as _, settleReplyDispatcher as _a, CodexAppServerToolResultEvent as _c, PluginControlUiDescriptor as _d, SessionUpstreamKind as _f, resolveMentionPatternPolicy as _i, ProviderResolveUsageAuthContext as _l, RealtimeVoiceProviderCapabilities as _m, NativeHookRelayRegistrationHandle as _n, ContextEngineProjection as _o, resolveProfileUnusableUntilForDisplay as _p, setActiveEmbeddedRun as _r, buildBootstrapContextForFiles as _s, buildAfterTurnRuntimeContext as _t, ProviderNormalizeConfigContext as _u, ToolProgressDetailMode as a, resolveDualTextControlCommandGate as aa, PluginCommandContext as ac, AgentItemEventData as ad, SessionCatalogArchiveProviderParams as af, attachChannelToResult as ai, ProviderWebSocketSessionPolicy as al, WorkerSshIdentity as am, runAgentCleanupStep as an, AgentHarnessSideQuestionResult as ao, resetAgentEventsForTest as ap, requestDeferredPluginToolApproval as ar, ReplyToResolution as as, resolveWritableSandboxBindHostRoots as at, McpToolCatalog as au, awaitAgentEndSideEffects as b, ReplyDispatcherOptions as ba, AgentToolResultMiddlewareContext as bc, PluginRuntimeLifecycleRegistration as bd, isExternalUserText as bf, BuildChannelInboundEventContextParams as bi, ProviderNormalizeToolSchemasContext as bl, RealtimeVoiceTool as bm, AgentHarnessPreflightError as bn, AgentRuntimePolicyScope as bo, ensureAuthProfileStoreForLocalUpdate as bp, ThreadAwareOutboundSessionRouteRecoveryContext as br, DEFAULT_PROVIDER as bs, normalizeQuestionTimeoutSeconds as bt, MemoryPluginCapability as bu, buildWatchedSessionsHarnessContext as c, recordChannelActivity as ca, MigrationDetection as cc, formatFastModeAutoProgressText as cd, SessionCatalogEntrySnapshot as cf, createAttachedChannelResultAdapter as ci, ProviderFetchUsageSnapshotContext as cl, TranscriptStopRequest as cm, hasNativeHookRelayInvocation as cn, AgentHarnessV2 as co, PluginLogger$1 as cp, setBeforeToolCallDiagnosticsEnabled as cr, OutboundSessionContext as cs, normalizeProviderToolSchemas as ct, MessagingToolSourceReplyPayload as cu, execPolicy as d, SavedRemoteMedia as da, MigrationProviderContext as dc, formatFastModeSourceSuffix as dd, SessionCatalogProvider as df, PluginRuntime as di, ProviderNormalizeTransportContext as dl, RealtimeVoiceAudioClearReason as dm, testing as dn, BeforeToolCallFailureDisposition as do, resolveEnvApiKey as dp, isPluginProvidersLoadInFlight as dr, resolveAgentOutboundIdentity as ds, disposeRegisteredAgentHarnesses as dt, ExecAutoReviewInput as du, channelIngressRoutes as ea, CronStoreFile as ec, OAuthCredentials as ed, updateSessionStore as ef, KeyedAsyncQueue as ei, ProviderFailoverErrorContext as el, WorkerMachineOption as em, prepareAgentRuntimeAuth as en, AgentHarnessSessionForkParams as eo, updateSessionLastRoute as ep, getBeforeToolCallFailureDisposition as er, DurableMessageSendContext as es, resolveSessionWriteLockOptions as et, isProviderApiKeyConfigured as eu, loadCodexBundleMcpThreadConfig as f, fetchRemoteMedia as fa, MigrationProviderPlugin$1 as fc, formatFastModeStatusValue as fd, SessionCatalogReadProviderParams as ff, ResolveMarkdownTableModeParams as fi, ProviderPrepareDynamicModelContext as fl, RealtimeVoiceBargeInOptions as fm, buildNativeHookRelayCommand as fn, BeforeToolCallPolicyDiagnosticState as fo, ProviderEnvVarLookupParams as fp, resolvePluginProvidersCore as fr, createOutboundPayloadPlan as fs, finalizeAgentToolAvailability as ft, ExecAutoReviewer as fu, queueAgentHarnessMessage as g, finalizeInboundContextForSdk as ga, CodexAppServerExtensionRuntime as gc, PluginAgentEventSubscriptionRegistration as gd, SessionUpstreamJsonValue as gf, ResolvedMentionPatternPolicy as gi, ProviderResolveDynamicModelContext as gl, RealtimeVoiceBridgeEvent as gm, NativeHookRelayProvider as gn, ContextEngineOperation as go, isProfileInCooldown as gp, clearActiveEmbeddedRun as gr, resolveSandboxContext as gs, resolveAttemptSpawnWorkspaceDir as gt, ProviderApplyConfigDefaultsContext as gu, prepareHarnessNativeMcpAppPreview as h, saveResponseMedia as ha, CodexAppServerExtensionFactory as hc, PluginAgentEventEmitResult as hd, SessionUpstreamActivity as hf, ResolveMentionPatternPolicyParams as hi, ProviderPreparedRuntimeAuth as hl, RealtimeVoiceBridgeCreateRequest as hm, NativeHookRelayProcessResponse as hn, ContextEngineHostCapability as ho, clearExpiredCooldowns as hp, abortEmbeddedAgentRun as hr, DeliveryQueueStateContext as hs, buildEmbeddedAttemptToolRunContext as ht, ProviderRuntimeModel as hu, EmbeddedRunAttemptParamsV2 as i, resolveControlCommandGate as ia, OpenClawPluginCommandDefinition$1 as ic, findModelInCatalog as id, SessionUpstreamLink as if, ChannelSendRawResult as ii, ProviderTransportTurnState as il, WorkerSshEndpoint as im, resolveAgentRunAbortLifecycleFields as in, AgentHarnessSideQuestionParamsV2 as io, onAgentEvent as ip, runBeforeToolCallHook as ir, DurableFinalDeliveryRequirements as is, hasSandboxBindReadonlyHostShadows as it, EmbeddedContextFile as iu, LlmBoundaryTokenPressure as j, CommandSessionMetadataChange as ja, BOOTSTRAP_HANDOFF_OPERATOR_SCOPES as jc, PluginSessionTurnUnscheduleByTagParams as jd, resolveSessionResetPolicy as jf, AssembledChannelTurn as ji, ProviderBuiltInModelSuppressionResult as jl, runAgentHarnessGatewayQuestion as jn, ChannelIngressQueueClaim as jo, removeProviderAuthProfilesWithLock as jp, stripChannelTargetPrefix as jr, GatewayRequestHandlerOptions as js, formatToolExecutionErrorMessage as jt, readResponseTextSnippet as ju, runAgentHarnessBeforeMessageWriteHook as k, InternalGetReplyFromConfig as ka, DevicePairingApprovalOptions as kc, PluginSessionSchedulerJobRegistration as kd, SessionResetMode as kf, finalizeChannelInboundContext as ki, ProviderValidateReplayTurnsContext as kl, ScheduledToolPolicyContext as km, cancelPendingAgentQuestionForSession as kn, bindIngressLifecycleToReplyOptions as ko, replaceRuntimeAuthProfileStoreSnapshots as kp, getChatChannelMetaForSdk as kr, ResolvedTtsModelOverrides as ks, readToolOperatorHint as kt, getModelProviderRequestTransport as ku, classifyAgentHarnessTerminalOutcome as l, FetchLike as la, MigrationItem as lc, formatFastModeCommandOptions as ld, SessionCatalogEntrySummary as lf, createEmptyChannelResult as li, ProviderNormalizeModelIdContext as ll, TranscriptsStartResult as lm, invokeNativeHookRelay as ln, CompactEmbeddedAgentSessionParams as lo, resolveModelAuthMode as lp, consumeAdjustedParamsForToolCall as lr, buildOutboundSessionContext as ls, logAgentRuntimeToolDiagnostics as lt, SandboxFsBridge as lu, mcpStdioRuntime as m, saveRemoteMedia as ma, CodexAppServerExtensionContext as mc, PluginAgentEventEmitParams as md, SessionCatalogTerminalPlan as mf, ExplicitMentionSignal as mi, ProviderPrepareRuntimeAuthContext as ml, RealtimeVoiceBridgeCallbacks as mm, NativeHookRelayEvent as mn, ContextEngine as mo, markAuthProfileBlockedUntil as mp, abortAndDrainEmbeddedAgentRun as mr, projectOutboundPayloadPlanForDelivery as ms, resolveEmbeddedAttemptToolConstructionPlan as mt, getPluginRuntimeGatewayRequestScope as mu, AgentHarnessTerminalOutcomeInput as n, CommandGatingModeWhenAccessGroupsOff as na, AgentPromptGuidanceEntry as nc, resolveStoredModelOverride as nd, upsertSessionEntry as nf, ProviderBuiltInModelSuppressionContext as ni, ProviderResolveTransportTurnStateContext as nl, WorkerProvider$1 as nm, log as nn, AgentHarnessSettledTurnFinalizationResult as no, AgentEventPayload as np, getBeforeToolCallPolicyDiagnosticState as nr, DeliverOutboundPayloadsParams as ns, buildAgentWorkspaceInstructionSnapshot as nt, listUsableProviderAuthProfileIds as nu, agentHarnessAttemptTerminal as o, ChannelDirection as oa, PluginCommandResult as oc, projectAgentToolActivity as od, SessionCatalogContinueProviderParams as of, attachChannelToResults as oi, ProviderWrapStreamFnContext as ol, WorkerSshIdentityRequest as om, buildAgentHookContextChannelFields as on, AgentHarnessSupport as oo, CommandAuthorization as op, finalizeToolTerminalPresentation as or, createReplyToFanout as os, splitSandboxBindSpec as ot, SessionMcpRuntime as ou, materializeRequesterScopedMcpToolsForHarnessRun as p, readRemoteMediaBuffer as pa, MigrationSummary as pc, resolveFastModeForElapsed as pd, SessionCatalogStartTerminalProviderParams as pf, BuildMentionRegexesOptions as pi, ProviderPrepareExtraParamsContext as pl, RealtimeVoiceBridge as pm, resolveNativeHookRelayDeferredToolApproval as pn, DeferredPluginToolApproval as po, omitEnvKeysCaseInsensitive as pp, readCodexCliCredentialsCached as pr, createStructuredOutboundPayloadPlan as ps, applyEmbeddedAttemptToolsAllow as pt, fingerprintResolvedAuthProfileCredential as pu, resolveAgentHarnessBeforePromptBuildResult as q, AgentHarnessNativeCompactionRequest as qa, resolveFastModeState as qc, readAmbientTranscriptWatermark as qd, resolveAmbientTranscriptWatermarkKey as qf, ReplyPrefixContext as qi, UsageProviderId as ql, RuntimeToolInputSchemaProjection as qn, peekSystemEventEntriesFromSdk as qo, RealtimeVoiceProviderPlugin$1 as qp, generateSecureInt as qr, OpenClawPluginService$1 as qs, isMessagingToolSendAction as qt, normalizePluginNodeCapabilityScopedUrl as qu, EmbeddedRunAttemptParams as r, resolveCommandAuthorizedFromAuthorizers as ra, AgentPromptSurfaceKind as rc, resolveSessionModelRef as rd, resolveSendPolicy as rf, definePluginEntry as ri, ProviderResolveWebSocketSessionPolicyContext as rl, WorkerProviderError as rm, isHostScopedAgentToolActive as rn, AgentHarnessSideQuestionParams as ro, emitAgentEvent as rp, hasBeforeToolCallPolicy as rr, DurableFinalDeliveryRequirement as rs, hasSandboxBindContainerPathAliases as rt, resolveProviderAuthProfileApiKey as ru, agentHarnessStructuredInput as s, getChannelActivity as sa, MigrationApplyResult as sc, FastModeAutoProgressState as sd, SessionCatalogContinueProviderResult as sf, buildChannelSendResult as si, ProviderAuthDoctorHintContext as sl, TranscriptStartRequest as sm, formatApprovalDisplayPath as sn, AgentHarnessSupportContext as so, resolveCommandAuthorization as sp, isToolWrappedWithBeforeToolCallHook as sr, QueuedDelivery as ss, assignSafeServerNames as st, MessagingToolSend as su, AgentHarnessTerminalOutcomeClassification as t, CommandAuthorizer as ta, AgentPromptGuidance as tc, StoredModelOverride as td, updateSessionStoreEntry as tf, enqueueKeyedTask as ti, ProviderReconcileLocalServiceContext as tl, WorkerProfile as tm, buildAgentRuntimePlan as tn, AgentHarnessSessionForkResult as to, AgentApprovalEventData as tp, wrapToolWithBeforeToolCallHook as tr, DurableMessageSendContextParams as ts, prepareAgentWorkspaceContext as tt, isProviderAuthProfileConfigured as tu, detectAndLoadAgentHarnessPromptImages as u, MediaFetchError as ua, MigrationPlan as uc, formatFastModeCurrentStatus as ud, SessionCatalogListProviderParams as uf, createRawChannelSendResultAdapter as ui, ProviderNormalizeResolvedModelContext as ul, TranscriptsStopResult as um, registerNativeHookRelay as un, EmbeddedRunAttemptResult as uo, resolveApiKeyForProviderCore as up, consumePreExecutionBlockedToolCall as ur, normalizeOutboundIdentity as us, normalizeAgentRuntimeTools as ut, ExecAutoReviewDecision as uu, inferToolMetaFromArgsCore as v, DispatchReplyWithBufferedBlockDispatcher$1 as va, CodexAppServerToolResultHandlerResult as vc, PluginRunContextGetParams as vd, SessionUpstreamProbe as vf, recordDroppedChannelTurnHistory as vi, ProviderResolvedUsageAuth as vl, RealtimeVoiceResponseOutcome as vm, projectAgentHarnessTranscriptMessageForDisplay as vn, ContextEngineSessionTarget as vo, resolveProfilesUnavailableReason as vp, resolveActiveEmbeddedRunSessionId as vr, resolveBootstrapContextForRun as vs, buildAfterTurnRuntimeContextFromUsage as vt, ProviderResolveConfigApiKeyContext as vu, runAgentHarnessAgentEndHook as w, CreateTypingCallbacksParams as wa, AgentToolResultMiddlewareRuntime as wc, PluginSessionAttachmentParams as wd, sessionCatalogAdoptedSessionKey as wf, FinalizeChannelInboundContextParams as wi, ProviderReplayPolicyContext as wl, listNodes as wm, projectProgressCardChannelUpdate as wn, createChannelIngressDrain as wo, saveAuthProfileStore as wp, createChannelPluginBase as wr, normalizeSpeechProviderId as ws, resolveMainSessionDelegationMode as wt, SessionDiscussionInfo as wu, runAgentEndSideEffects as x, ReplyDispatcherWithTypingOptions as xa, AgentToolResultMiddlewareEvent as xc, PluginSessionActionContext as xd, listAdoptedSessionCatalogSessions as xf, BuiltChannelInboundEventContext as xi, ProviderReasoningOutputMode as xl, RealtimeVoiceToolCallEvent as xm, AgentHarnessSessionSupersededError as xn, ChannelIngressDrain as xo, loadAuthProfileStoreForRuntime as xp, ThreadAwareOutboundSessionRouteThreadSource as xr, getTtsProvider as xs, buildCredentialSafetyPrompt as xt, MemoryPluginPublicArtifact as xu, buildEmbeddedForegroundPromptContext as y, DispatchReplyWithDispatcher as ya, AgentToolResultMiddleware as yc, PluginRunContextPatch as yd, createSessionCatalogAdoptionCoordinator as yf, BuildChannelInboundEventContextAsyncParams as yi, ProviderUsageAuthToken as yl, RealtimeVoiceRole as ym, projectSettledTurnFinalizationAttemptResult as yn, RuntimeLogger as yo, ensureAuthProfileStore as yp, ChannelOutboundSessionRouteParams as yr, resolveBootstrapFilesForRun as ys, resolveAttemptFsWorkspaceOnly as yt, PluginCapabilityCatalog as yu, resolveCompactionTimeoutMs as z, AgentHarnessAttemptResult as za, ExecPolicyOverrides as zc, cleanupSessionLifecycleArtifacts as zd, sqliteSessionFileMarkerMatchesSession as zf, CommandFacts as zi, ProviderAppGuidedSetupContext as zl, AgentHarnessUserInputAnswers as zn, isVoiceMessageCompatibleAudio as zo, resolveProviderIdForAuth as zp, prepareMemorySystemPromptAddition as zr, OpenClawPluginCliRootCommandDescriptor$1 as zs, filterToolResultMediaUrls as zt, buildJsonPluginConfigSchema as zu };