@a1hvdy/cc-openclaw 0.8.0 → 0.9.1

package/dist/src/openai-compat/openai-compat.d.ts

@@ -6,6 +6,17 @@
  * as a drop-in backend. Stateful sessions maximize Anthropic prompt caching.
  */
 import * as http from 'node:http';
+import { type UserMessageBlock } from './message-extractor.js';
+export { isToolsPerMessageModeEnabled, isToolStreamMode } from './mode-flags.js';
+export { resolveSessionKey, sessionNameFromKey } from './session-key-resolver.js';
+export { noToolsSystemPrompt, buildSessionSystemPrompt, buildToolPromptBlock } from './prompts.js';
+export { parseToolCallsFromText, type ParsedToolCalls } from './tool-calls-parser.js';
+export { serializeToolResults, serializeToolResultsAsBlocks, type AnthropicToolResultBlock, } from './tool-results-serializer.js';
+export { extractUserMessage, type UserMessageBlock, type ExtractedMessage, } from './message-extractor.js';
+export { formatCompletionResponse, formatCompletionChunk } from './response-formatter.js';
+export { reportStatus, getToolDescription } from './status-reporter.js';
+export { handleNonStreaming } from './non-streaming-handler.js';
+export { handleStreaming } from './streaming-handler.js';
 export interface OpenAIChatMessage {
     role: 'system' | 'user' | 'assistant' | 'tool';
     content: string | Array<{
@@ -96,171 +107,10 @@ export interface OpenAIChatCompletionChunk {
         total_tokens: number;
     };
 }
-/**
- * Derive a session key from the request.
- * Priority: X-Session-Id header > user field > sha1(model + systemPrompt) > "default"
- *
- * The system-prompt-hash fallback prevents the bug where every caller without
- * X-Session-Id or `user` collapses onto a single shared "openai-default"
- * plugin session. In multi-caller setups (OpenClaw routing the main agent,
- * cron jobs, and subagents through the same gateway) that previously meant
- * every request serialized against every other and frequently picked up the
- * wrong session's appendSystemPrompt — also a privacy leak across callers.
- *
- * The model is mixed into the hash so that two callers with the same system
- * prompt but different requested models don't collide and silently get
- * responses from the wrong model. Originally diagnosed in PR #40 by
- * @megayounus786.
- */
-/**
- * When set (to '1', 'true', 'yes'), the proxy preserves the pre-fix behavior:
- *   - tools injected into every user message
- *   - session key NOT fingerprinted by tools (same session across tool changes)
- * Default (unset) is the new behavior: tools embedded in session system prompt
- * at create time + session key fingerprinted by tools. The new behavior
- * eliminates periodic latency spikes but does not support mutating the tool
- * list within a single session (a new session is created when tools change).
- */
-export declare function isToolsPerMessageModeEnabled(): boolean;
-/**
- * Phase 2 R5: tool-stream mode flag. When `CC_OPENCLAW_TOOL_STREAM=1` AND the
- * caller provides `tools[]`, cc-openclaw skips the defensive "no tools"
- * system prompt and does NOT clear `sessionConfig.tools`, allowing Claude
- * CLI's native tool_use events to flow through the new parser+translator
- * pipeline (Phase 4 Pillar 0.5). Default off; opt-in for the new path.
- */
-export declare function isToolStreamMode(): boolean;
-/**
- * Generate the "no built-in tools" system prompt preamble.
- * The `toolLocation` parameter controls how the model is told where to find
- * tool definitions — 'system' means "in the <available_tools> block below"
- * (tools baked into system prompt), 'user' means "in <available_tools> tags
- * in the user message" (legacy per-turn injection).
- */
-export declare function noToolsSystemPrompt(toolLocation: 'system' | 'user'): string;
-/**
- * Build the full session system prompt for a Claude Code session with tools.
- * Exported for testability — called from `handleChatCompletion`.
- *
- * - Default mode: tools are embedded in the system prompt (cacheable by Anthropic).
- * - Legacy mode (OPENAI_COMPAT_TOOLS_PER_MESSAGE=1): tools are NOT embedded;
- *   they'll be injected per-turn in the user message instead.
- */
-export declare function buildSessionSystemPrompt(tools: OpenAIChatCompletionRequest['tools'], callerSystemPrompt: string | undefined): string;
-export declare function resolveSessionKey(body: OpenAIChatCompletionRequest, headers: http.IncomingHttpHeaders): string;
-/** Build the full session name from a key */
-export declare function sessionNameFromKey(key: string): string;
-/**
- * Convert OpenAI tool definitions into a structured prompt block.
- * Injected into the user message so the CLI model sees tool definitions
- * and responds with <tool_calls> tags when it wants to invoke a function.
- */
-export declare function buildToolPromptBlock(tools: OpenAIChatCompletionRequest['tools']): string;
-export interface ParsedToolCalls {
-    textContent: string | null;
-    toolCalls: OpenAIToolCall[];
-}
-/**
- * Parse tool_calls from CLI text output.
- *
- * Looks for <tool_calls>[...]</tool_calls> tags in the response text.
- * Returns both the extracted text content (before/after tags) and any tool calls found.
- */
-export declare function parseToolCallsFromText(text: string): ParsedToolCalls;
-/**
- * Serialize tool result messages into a text block for the CLI model.
- * Converts OpenAI `tool` role messages into <tool_result> tags.
- *
- * Legacy path (CC_OPENCLAW_TOOL_STREAM=0). Used when the model receives
- * tool definitions via the system prompt's <available_tools> XML block
- * and emits <tool_calls> XML in response. Tool-stream mode (R4) uses
- * `serializeToolResultsAsBlocks()` instead, returning native Anthropic
- * `tool_result` content blocks that Claude CLI parses directly.
- */
-export declare function serializeToolResults(messages: OpenAIChatMessage[]): string;
-/**
- * Phase 2 R4: native Anthropic `tool_result` content blocks.
- *
- * In tool-stream mode (CC_OPENCLAW_TOOL_STREAM=1), this replaces
- * `serializeToolResults()` XML wrapping. Returns blocks shaped like:
- *
- *   { type: 'tool_result', tool_use_id: 'toolu_X', content: '...' }
- *
- * Claude CLI's stream-json input format accepts these as user-message
- * content arrays. The model then continues generation with the tool
- * result in context, emitting either more `tool_use` events or final
- * text — no XML round-tripping required.
- *
- * Wiring into the live request path lands with Phase 4 Pillar 0.5
- * tasks R1+R2 (parser+translator response-side integration), where
- * `extractUserMessage` produces structured content arrays in
- * tool-stream mode.
- */
-export interface AnthropicToolResultBlock {
-    type: 'tool_result';
-    tool_use_id: string;
-    content: string;
-}
-export declare function serializeToolResultsAsBlocks(messages: OpenAIChatMessage[]): AnthropicToolResultBlock[];
-/**
- * Phase 2 R4 wire-up: optional structured content for tool-stream mode.
- * When set, consumers should send this array to the subprocess instead of
- * the legacy XML-wrapped `userMessage` string. Each element is either a
- * native Anthropic `tool_result` block (for prior tool outputs) or a
- * `text` block (for the user's follow-up message).
- */
-export type UserMessageBlock = AnthropicToolResultBlock | {
-    type: 'text';
-    text: string;
-};
-export interface ExtractedMessage {
-    systemPrompt: string | undefined;
-    userMessage: string;
-    /**
-     * Populated only in tool-stream mode when the last non-system message
-     * is a tool-role result. Carries native Anthropic tool_result blocks
-     * + optional follow-up text. When undefined, consumers fall back to
-     * the string `userMessage` (legacy XML-wrapped path).
-     */
-    userMessageBlocks?: UserMessageBlock[];
-    isNewConversation: boolean;
-}
-/**
- * Extract the relevant parts from an OpenAI messages array.
- *
- * Sessions are stateful — we only need the last user message. The tricky
- * question is whether to start a fresh session or append to the existing one.
- *
- * Default mode (no env var): only honor an explicit `X-Session-Reset: 1`
- * header. This is correct for clients that maintain their own conversation
- * transcript and forward only the latest user turn (OpenClaw main agent
- * loop, cron jobs, subagents). The previous heuristic
- * (`nonSystemMessages.length <= 1`) fired on every such request, killing the
- * persistent CLI every turn and preventing Anthropic prompt caching from
- * ever warming. Originally diagnosed in PR #40 by @megayounus786.
- *
- * Legacy mode (`OPENAI_COMPAT_NEW_CONVO_HEURISTIC=1`): restore the old
- * `system + single user ⇒ new conversation` rule, for clients that re-send
- * the full transcript on every turn (ChatGPT-Next-Web, Open WebUI, data
- * labeling tools, etc). They use the transcript shape itself as their only
- * "start a new conversation" signal.
- *
- * The env var is read on every call so ops can flip it via launchctl setenv
- * without restarting the server.
- */
-export declare function extractUserMessage(messages: OpenAIChatMessage[], headers?: Record<string, string | string[] | undefined>): ExtractedMessage;
-export declare function formatCompletionResponse(id: string, model: string, text: string, tokensIn: number, tokensOut: number, toolCalls?: OpenAIToolCall[], 
-/** v0.7.0: when present + non-empty, attached as `choices[0].message.reasoning`
- *  (mirrors OpenAI o1/o3 schema). Caller must already be gated on
- *  `getSurfaceThinkingEnabled()` from `lib/config.ts` — this function does
- *  not re-check the flag. Pass empty string or undefined to omit. */
-reasoning?: string): OpenAIChatCompletionResponse;
-export declare function formatCompletionChunk(id: string, model: string, delta: {
-    role?: string;
-    content?: string;
-}, finishReason: string | null): OpenAIChatCompletionChunk;
-/** SessionManager-like interface to avoid circular imports */
-interface SessionManagerLike {
+/** SessionManager-like interface to avoid circular imports. Exported so
+ * the extracted handlers (non-streaming-handler.ts, streaming-handler.ts)
+ * can type their `manager` parameter from a single canonical definition. */
+export interface SessionManagerLike {
     startSession(config: Record<string, unknown>): Promise<{
         name: string;
     }>;
@@ -283,4 +133,3 @@ interface SessionManagerLike {
     compactSession(name: string): Promise<unknown>;
 }
 export declare function handleChatCompletion(manager: SessionManagerLike, body: Record<string, unknown>, headers: http.IncomingHttpHeaders, res: http.ServerResponse): Promise<void>;
-export {};

package/dist/src/openai-compat/openai-compat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai-compat.d.ts","sourceRoot":"","sources":["../../../src/openai-compat/openai-compat.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAoBlC,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,MAAM,CAAC;IAC/C,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;IACjE,UAAU,CAAC,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,UAAU,CAAC;QAAC,QAAQ,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC,CAAC;IACpG,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,2BAA2B;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,UAAU,CAAC;QAAC,QAAQ,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,WAAW,EAAE,MAAM,CAAC;YAAC,UAAU,EAAE,OAAO,CAAA;SAAE,CAAA;KAAE,CAAC,CAAC;CAC3G;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/C;AAED,MAAM,WAAW,4BAA4B;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,iBAAiB,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,KAAK,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE;YAAE,IAAI,EAAE,WAAW,CAAC;YAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;YAAC,UAAU,CAAC,EAAE,cAAc,EAAE,CAAA;SAAE,CAAC;QACtF,aAAa,EAAE,MAAM,GAAG,QAAQ,GAAG,YAAY,CAAC;KACjD,CAAC,CAAC;IACH,KAAK,EAAE;QACL,aAAa,EAAE,MAAM,CAAC;QACtB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,uBAAuB,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,KAAK,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE;YACL,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YACxB,UAAU,CAAC,EAAE,KAAK,CAAC;gBACjB,KAAK,EAAE,MAAM,CAAC;gBACd,EAAE,CAAC,EAAE,MAAM,CAAC;gBACZ,IAAI,CAAC,EAAE,UAAU,CAAC;gBAClB,QAAQ,CAAC,EAAE;oBAAE,IAAI,CAAC,EAAE,MAAM,CAAC;oBAAC,SAAS,CAAC,EAAE,MAAM,CAAA;iBAAE,CAAC;aAClD,CAAC,CAAC;SACJ,CAAC;QACF,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B,CAAC,CAAC;IACH,KAAK,CAAC,EAAE;QACN,aAAa,EAAE,MAAM,CAAC;QACtB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAID;;;;;;;;;;;;;;;GAeG;AACH;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,IAAI,OAAO,CAKtD;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,IAAI,OAAO,CAE1C;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,YAAY,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,CA+B3E;AAED;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CACtC,KAAK,EAAE,2BAA2B,CAAC,OAAO,CAAC,EAC3C,kBAAkB,EAAE,MAAM,GAAG,SAAS,GACrC,MAAM,CAgBR;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,2BAA2B,EAAE,OAAO,EAAE,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAyC9G;AAED,6CAA6C;AAC7C,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEtD;AAID;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,2BAA2B,CAAC,OAAO,CAAC,GAAG,MAAM,CAuBxF;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,EAAE,cAAc,EAAE,CAAC;CAC7B;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CA+DpE;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAY1E;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,aAAa,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,4BAA4B,CAC1C,QAAQ,EAAE,iBAAiB,EAAE,GAC5B,wBAAwB,EAAE,CAQ5B;AAID;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GACxB,wBAAwB,GACxB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnC,MAAM,WAAW,gBAAgB;IAC/B,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACvC,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,iBAAiB,EAAE,EAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,GACtD,gBAAgB,CAiFlB;AAID,wBAAgB,wBAAwB,CACtC,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,cAAc,EAAE,GAC3B,4BAA4B,CAwB9B;AAED,wBAAgB,qBAAqB,CACnC,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,MAAM,EACb,KAAK,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,EAC1C,YAAY,EAAE,MAAM,GAAG,IAAI,GAC1B,yBAAyB,CAQ3B;AAID,8DAA8D;AAC9D,UAAU,kBAAkB;IAC1B,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACzE,WAAW,CACT,IAAI,EAAE,MAAM,EAEZ,OAAO,EAAE,MAAM,GAAG,gBAAgB,EAAE,EACpC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,EAAE,CAAA;KAAE,CAAC,CAAC;IACtE,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,YAAY,IAAI,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACxC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG;QAAE,KAAK,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,MAAM,CAAC;YAAC,cAAc,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC;IACpG,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAChD;AAED,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,kBAAkB,EAC3B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,EAAE,IAAI,CAAC,mBAAmB,EACjC,GAAG,EAAE,IAAI,CAAC,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,CA0Mf"}