@mininglamp-oss/octo-runtime-client 0.0.0-stage → 1.1.11

package/node_modules/@mininglamp-oss/octo-runtime-protocol/dist/generated/protocol-types.js

@@ -0,0 +1,6 @@
+/* eslint-disable */
+/**
+ * Generated by scripts/gen-types.mjs from schema/protocol.schema.json.
+ * Do not edit directly; update the schema and run `pnpm gen`.
+ */
+export {};

package/node_modules/@mininglamp-oss/octo-runtime-protocol/dist/index.d.ts

@@ -0,0 +1,124 @@
+export type { HostedAdapterMetadata } from "./adapter-metadata.js";
+export { assertAsyncQuestions, assertQuestionRequest, assertQuestionResponse, questionAnswerText } from "./questions.js";
+export type { AsyncUserInputQuestion, AsyncQuestionReplySnapshot, QuestionRequest, QuestionResponse } from "./generated/protocol-types.js";
+export { assertJsonByteLimit } from "./json-size.js";
+export { INVOKE_REQUEST_MAX_BYTES, assertInvokeRequestSize } from "./invoke-size.js";
+export * from "./stream-limits.js";
+export { assertKernelStatus, assertServiceProcessSnapshot } from "./service-processes.js";
+export * from "./run-protocol.js";
+export type { KernelLookupKey, KernelRunRef, KernelRunSnapshot, KernelStatus, ServiceProcessSnapshot } from "./generated/protocol-types.js";
+export * from "./invoke-input.js";
+export * from "./model-context.js";
+export * from "./execution-plan.js";
+export { contextHash } from "./context-hash.js";
+export { assertJsonValue } from "./context.js";
+export type { ToolAuthorization, IssuedToolAuthorization } from "./generated/protocol-types.js";
+export { PROVIDER_DIAGNOSTIC_MAX_BYTES } from "./experience.js";
+export { IMAGE_INPUT_LIMITS, IMAGE_INPUT_MIME_TYPES, assertModelInputParts, providerInputParts, hasImageInput, modelPartsFromInput } from "./multimodal.js";
+export { APPROVAL_MODES, CONTEXT_SCHEMA, CONTEXT_MAX_BYTES, CONTEXT_MAX_ITEMS, DEFAULT_RUN_TIMEOUT_MS, MAX_RUN_TIMEOUT_MS, RUNTIME_RUN_CONTRACT, assertAgentSource, assertApprovalMode, assertContextEnvelope, assertContextEnvs, assertMcpServers, assertContextMcp, assertResolvedExecutionPlan, canonicalContext, contextItem, mergeContext } from "./context.js";
+export { RUNTIME_SELECTION_SCHEMA, assertResolvedRuntimeSelection } from "./runtime-selection.js";
+export { CONTEXT_TYPE_CATALOG, contextTypeDefinition, findContextTypeDefinition } from "./context-catalog.js";
+export type { ContextTypeDefinition } from "./context-catalog.js";
+export { assertContextConfiguration, resolveContextConfiguration } from "./context-configuration.js";
+export { assertNotificationMessage } from "./notification.js";
+import type { ActivityStartedPayload, ActivityUpdatedPayload, ActivityFinishedPayload, PlanUpdatedPayload, ToolProgressPayload, RunNoticePayload, CanonicalEventPayload, ChannelContextAppend, ChannelContextDescriptor, ChannelMessageFact, ChannelScope, ContextSyncResult, InvokeRequestWire, RuntimeLimits, MessageChannel, MessageExposure, InteractionRequestedPayload, InteractionResolvedPayload, ModelStepFinishedPayload, ModelStepStartedPayload, ToolCallCreatePayload, ToolCallDeltaPayload, ToolCallUpdatePayload, FailureEnvelope } from "./generated/protocol-types.js";
+export type { AgentSource, NotificationMessage, ModelInputPart, ApprovalMode, ApprovalRequest, ApprovalOperation, ApprovalDisplayDetails, ContextItem, ContextInlinePayload, ContextReferencesPayload, ContextInlineEntry, ContextReferenceEntry, ContextEnvelope, ContextConfiguration, ContextPreparationReceipt, RunContextProjection, ContextAdapterPayload, ContextModelPayload, ContextActmodePayload, ExecutionEvidence, ContextReasoningPayload, ContextWorkspacePayload, ContextLimitsPayload, ContextEnvsPayload, ContextRuntimeSelectionPayload, ContextApprovalPolicyPayload, ContextSelectionEntry, ContextResourceEntry, ContextInstructionEntry, ContextInstructionsPayload, ContextContinuityPayload, ResolvedExecutionPlan, ResolvedRuntimeSelection, MessageChannel, MessageExposure, MessageProvenance, ProviderSession, AgentConfig, RuntimeLimits, ActivityInfo, ActivitySubject, ActivityStartedPayload, ActivityUpdatedPayload, ActivityFinishedPayload, PlanUpdatedPayload, ToolProgressPayload, RunNoticePayload, CanonicalEventPayload, InteractionRequestedPayload, InteractionResolvedPayload, ModelStepStartedPayload, ModelStepFinishedPayload, ToolCallCreatePayload, ToolCallDeltaPayload, ToolCallUpdatePayload, FailureAction, FailureSource, FailureCause, FailureEnvelope, ChannelScope, ChannelMessagePart, ChannelMessageSender, ChannelMessageFlags, ChannelMessageFact, ChannelContextAppend, ContextSyncRequest, ContextSyncResult, ChannelContextDescriptor, ContextCommitResult, McpStdioServer, McpStreamableHttpServer, McpServer, McpServers, RunIdentity, InvokeRequestWire } from "./generated/protocol-types.js";
+export { FAILURE_CATALOG, classifyFailure, isCodexLocalFailureReason, isCodexLocalFailure, failureMessage, failurePayload, isFailureEnvelope, type FailureClassificationContext, type FailureDomain, type PublicFailureCode } from "./failure.js";
+import type { RunIdentity } from "./generated/protocol-types.js";
+/**
+ * The three terminal states a Run may reach.
+ *
+ * `finished` means normal completion, `error` means execution failed, and
+ * `stopped` means an explicit cancellation or an aborted stream. The Adapter
+ * Host guarantees every invocation delivers exactly one of these upstream.
+ */
+export declare const PROTOCOL_VERSION: 2;
+export declare function canonicalTerminalStatus(value: unknown): "completed" | "failed" | "cancelled";
+export declare const TERMINAL_EVENT_TYPES: readonly ["run.completed", "run.failed", "run.cancelled"];
+export type TerminalEventType = (typeof TERMINAL_EVENT_TYPES)[number];
+/**
+ * The stable event set the Core can persist and upper-layer UIs can consume.
+ *
+ * Rough lifecycle: Run queued/running -> message, tool, surface and usage
+ * updates -> a Run terminal. Provider-native event names must be translated
+ * inside the adapter and must never leak through to this level.
+ */
+export { contextActmode, assertExecutionEvidence } from "./actmode.js";
+export declare const CANONICAL_EVENT_TYPES: readonly ["session.update", "execution.update", "usage.update", "model_step.started", "model_step.finished", "message.create", "message.delta", "message.update", "tool_call.create", "tool_call.delta", "tool_call.update", "activity.started", "activity.updated", "activity.finished", "plan.updated", "tool_call.progress", "run.notice", "interaction.requested", "interaction.resolved", "run.queued", "run.started", "run.completed", "run.failed", "run.cancelled"];
+/** canonical 模式下的统一事件类型；native-only Adapter 无须转换原生事件。 */
+export type CanonicalEventType = (typeof CANONICAL_EVENT_TYPES)[number];
+export type CanonicalPayloadFor<TType extends CanonicalEventType> = TType extends "activity.started" ? CanonicalEventPayload & ActivityStartedPayload : TType extends "activity.updated" ? CanonicalEventPayload & ActivityUpdatedPayload : TType extends "activity.finished" ? CanonicalEventPayload & ActivityFinishedPayload : TType extends "plan.updated" ? CanonicalEventPayload & PlanUpdatedPayload : TType extends "tool_call.progress" ? CanonicalEventPayload & ToolProgressPayload : TType extends "run.notice" ? CanonicalEventPayload & RunNoticePayload : TType extends "model_step.started" ? CanonicalEventPayload & ModelStepStartedPayload : TType extends "model_step.finished" ? CanonicalEventPayload & ModelStepFinishedPayload : TType extends "interaction.requested" ? CanonicalEventPayload & InteractionRequestedPayload : TType extends "interaction.resolved" ? CanonicalEventPayload & InteractionResolvedPayload : TType extends "tool_call.create" ? CanonicalEventPayload & ToolCallCreatePayload : TType extends "tool_call.delta" ? CanonicalEventPayload & ToolCallDeltaPayload : TType extends "tool_call.update" ? CanonicalEventPayload & ToolCallUpdatePayload : CanonicalEventPayload;
+/** Adapter 在 canonical 模式下输出的最小事件单元；工具生命周期的 payload 随类型收窄。 */
+export type CanonicalEvent<TType extends CanonicalEventType = CanonicalEventType> = TType extends CanonicalEventType ? {
+    protocolVersion: 2;
+    type: TType;
+    payload: CanonicalPayloadFor<TType>;
+} : never;
+/**
+ * A single execution request the Core sends to the Adapter Host.
+ *
+ * The serializable fields come from the generated {@link InvokeRequestWire};
+ * `signal` is a runtime object that cannot cross a process boundary, so it is
+ * mixed in here (for in-process calls only) rather than added to the schema.
+ */
+export interface InvokeRequest extends InvokeRequestWire {
+    /** Fired when the Host cancels the invocation; the adapter should propagate it to the subprocess or a protocol cancel. */
+    signal?: AbortSignal;
+}
+export declare const INTERACTION_RESPONSE_OUTCOMES: readonly ["accepted", "declined", "answered", "cancelled"];
+export type InteractionResponseOutcome = (typeof INTERACTION_RESPONSE_OUTCOMES)[number];
+/** Opaque answer carrier routed back to the provider request that emitted an interaction. */
+export interface InteractionResponse {
+    interactionId: string;
+    outcome: InteractionResponseOutcome;
+    value?: unknown;
+}
+/** Provider adapters must use this accessor so hidden context is sent exactly once when present. */
+export declare function providerInputText(request: InvokeRequest): string;
+/** Inject trusted instructions only when starting a provider session, including a fresh restart. */
+export declare function initialControlInstructions(request: InvokeRequest, freshSession?: boolean): string;
+/** Exact alternate input for a provider that could not resume its session. */
+export declare function freshFallbackInputText(request: InvokeRequest): string;
+/** Runtime validation at the Agent Work plugin boundary; JSON schema remains the wire source of truth. */
+export declare function assertChannelScope(value: unknown): asserts value is ChannelScope;
+export declare function assertChannelMessageFact(value: unknown): asserts value is ChannelMessageFact;
+export declare function assertChannelContextAppend(value: unknown): asserts value is ChannelContextAppend;
+export declare function assertContextSyncResult(value: unknown): asserts value is ContextSyncResult;
+export declare function assertChannelContextDescriptor(value: unknown): asserts value is ChannelContextDescriptor;
+/**
+ * The event record written to the Store.
+ * `seq` is monotonic only within a single run; consumers should order and
+ * dedupe on `(runId, seq)`.
+ */
+export type EventEnvelope<TType extends CanonicalEventType = CanonicalEventType> = CanonicalEvent<TType> & {
+    /** A globally random ID for each persisted event. */
+    id: string;
+    seq: number;
+    tsMs: number;
+    agentSessionId: string;
+    runId: string;
+};
+export declare const TERMINAL_EVENTS: ReadonlySet<CanonicalEventType>;
+export declare const EVENT_TYPES: ReadonlySet<CanonicalEventType>;
+export declare const MESSAGE_EXPOSURES: ReadonlySet<MessageExposure>;
+export declare const MESSAGE_CHANNELS: ReadonlySet<MessageChannel>;
+/**
+ * Validate an adapter event and stamp it with the ID, sequence, timestamp and
+ * Run ownership that persistence requires. Returns a frozen object so callers
+ * cannot mutate it after append.
+ */
+export declare function envelope<TType extends CanonicalEventType>(run: RunIdentity, seq: number, event: CanonicalEvent<TType>): Readonly<EventEnvelope<TType>>;
+/** Assert the minimal runtime shape of a canonical event at the dynamic adapter boundary. */
+export declare function assertCanonicalEvent(event: unknown): asserts event is CanonicalEvent;
+export declare function assertApprovalRequest(value: unknown): asserts value is Record<string, unknown>;
+/** Validate a response before it crosses the process or provider boundary. */
+export declare function assertInteractionResponse(value: unknown): asserts value is InteractionResponse;
+/** Validate a structured failure at the dynamic adapter boundary. */
+export declare function assertFailureEnvelope(value: unknown): asserts value is FailureEnvelope;
+/** Assert the execution identifiers and path fields that must be present before the Host calls an adapter. */
+export declare function assertInvokeRequest(request: unknown): asserts request is InvokeRequest;
+export declare function assertRuntimeLimits(value: unknown): asserts value is RuntimeLimits;
+/** Type guard: whether an event ends the current Run. */
+export declare function isTerminal(event: CanonicalEvent): event is CanonicalEvent<TerminalEventType>;
+/** Missing or malformed analysis metadata is never treated as public. */
+export declare function messageExposure(event: CanonicalEvent): MessageExposure;