@t2000/engine 0.32.0 → 0.33.1

package/dist/index.d.ts

@@ -5,6 +5,141 @@ import { Tool as Tool$1 } from '@modelcontextprotocol/sdk/types.js';
 import * as _t2000_sdk from '@t2000/sdk';
 import { T2000 } from '@t2000/sdk';
 
+/** Rough token count for a message array. */
+declare function estimateTokens(messages: Message[]): number;
+interface CompactOptions {
+    /** Max token budget for the conversation. Default 100_000. */
+    maxTokens?: number;
+    /** Number of recent messages to always keep uncompacted. Default 8. */
+    keepRecentCount?: number;
+    /** System prompt token estimate (subtracted from budget). Default 500. */
+    systemPromptTokens?: number;
+    /** LLM-based summarizer for old turns. When provided, replaces old turns with a summary. */
+    summarizer?: (messages: Message[]) => Promise<string>;
+}
+interface ContextBudgetConfig {
+    /** Total context window size in tokens. Default 200_000 (Sonnet 4.6). */
+    contextLimit?: number;
+    /** Trigger compaction at this fraction of contextLimit. Default 0.85. */
+    compactThreshold?: number;
+    /** Emit a warning at this fraction of contextLimit. Default 0.70. */
+    warnThreshold?: number;
+}
+declare class ContextBudget {
+    private estimatedTokens;
+    private readonly contextLimit;
+    private readonly compactThreshold;
+    private readonly warnThreshold;
+    constructor(config?: ContextBudgetConfig);
+    /** Update with actual input_tokens from the API usage event. */
+    update(inputTokens: number): void;
+    /** True when the session should be compacted (at 85% of context limit). */
+    shouldCompact(): boolean;
+    /** True when nearing the limit (at 70% of context limit). */
+    shouldWarn(): boolean;
+    /** Current token count. */
+    get tokens(): number;
+    /** Remaining tokens before compaction triggers. */
+    get remaining(): number;
+    /** Usage ratio (0..1). */
+    get usage(): number;
+    reset(): void;
+}
+/**
+ * Compact a conversation that exceeds the token budget.
+ *
+ * Strategy:
+ * 1. Always preserve the most recent `keepRecentCount` messages (the active context).
+ * 2. If an LLM `summarizer` is provided, summarize old turns into a brief recap and
+ *    replace them with a synthetic summary turn pair.
+ * 3. For older messages, summarise tool_result content to a brief one-liner.
+ * 4. If still over budget, drop the oldest messages (keeping the first user message
+ *    for context continuity).
+ *
+ * Returns a new array — does not mutate the input.
+ */
+declare function compactMessages(messages: readonly Message[], opts?: CompactOptions): Promise<Message[]>;
+
+interface RecipeStepRequirement {
+    step?: string;
+    field?: string;
+    confirmation?: boolean;
+}
+interface RecipeStepOnError {
+    action: 'abort' | 'refuse' | 'report' | 'retry';
+    message: string;
+    suggest?: string;
+}
+interface RecipePrerequisite {
+    field: string;
+    prompt: string;
+}
+interface RecipeStep {
+    name: string;
+    tool?: string;
+    service?: string;
+    purpose: string;
+    cost?: string;
+    output?: {
+        type: string;
+        key: string;
+    };
+    gate?: 'none' | 'preview' | 'review' | 'estimate';
+    gate_prompt?: string;
+    requires?: RecipeStepRequirement[];
+    rules?: string[];
+    condition?: string;
+    notes?: string;
+    flags?: Partial<ToolFlags>;
+    on_error?: RecipeStepOnError;
+    input_template?: Record<string, string>;
+    cost_per_unit?: string;
+}
+interface Recipe {
+    name: string;
+    description: string;
+    triggers: string[];
+    services?: string[];
+    prerequisites?: RecipePrerequisite[];
+    steps: RecipeStep[];
+}
+
+/**
+ * Stores loaded recipes and matches user messages to the most specific recipe
+ * using longest-trigger-match-wins.
+ */
+declare class RecipeRegistry {
+    private recipes;
+    /** Load all recipes from a directory of YAML files. */
+    loadDir(yamlDir: string): void;
+    /** Register a single recipe from a YAML string. */
+    loadYaml(yamlContent: string): void;
+    /** Register a pre-parsed Recipe object. */
+    register(recipe: Recipe): void;
+    /** All loaded recipes. */
+    all(): readonly Recipe[];
+    /**
+     * Match a user message to the most specific recipe.
+     * Longest trigger phrase match wins. Returns null if no match.
+     */
+    match(userMessage: string): Recipe | null;
+    /**
+     * Format a matched recipe as a compact context block for the system prompt.
+     * Injected dynamically — only when the recipe matches.
+     */
+    toPromptContext(recipe: Recipe): string;
+}
+
+/**
+ * Load all recipe YAML files from a directory.
+ * Throws on validation errors — recipes should fail at load time, not runtime.
+ */
+declare function loadRecipes(yamlDir: string): Recipe[];
+/**
+ * Parse a single recipe from a YAML string (useful for embedded/bundled recipes).
+ */
+declare function parseRecipe(yamlContent: string): Recipe;
+
 interface PendingToolCall {
     id: string;
     name: string;
@@ -328,6 +463,12 @@ interface EngineConfig {
     };
     /** Guard runner configuration (RE-2.2). Omit to disable guards. */
     guards?: GuardConfig;
+    /** Recipe registry for multi-step workflow guidance (RE-3.1). */
+    recipes?: RecipeRegistry;
+    /** Context budget tracking configuration (RE-3.3). */
+    contextBudget?: ContextBudgetConfig;
+    /** LLM-based summarizer for context compaction (RE-3.3). */
+    contextSummarizer?: (messages: Message[]) => Promise<string>;
 }
 interface LLMProvider {
     chat(params: ChatParams): AsyncGenerator<ProviderEvent>;
@@ -445,6 +586,10 @@ declare class QueryEngine {
     private readonly costTracker;
     private readonly guardConfig;
     private readonly guardState;
+    private readonly recipes;
+    private readonly contextBudget;
+    private readonly contextSummarizer;
+    private matchedRecipe;
     private messages;
     private abortController;
     private guardEvents;
@@ -467,6 +612,8 @@ declare class QueryEngine {
     resumeWithToolResult(action: PendingAction, response: PermissionResponse): AsyncGenerator<EngineEvent>;
     interrupt(): void;
     getMessages(): readonly Message[];
+    getMatchedRecipe(): Recipe | null;
+    getContextBudget(): ContextBudget;
     reset(): void;
     getGuardEvents(): readonly GuardEvent[];
     loadMessages(messages: Message[]): void;
@@ -619,10 +766,6 @@ declare function applyToolFlags<T extends Tool>(tools: T[]): T[];
  */
 declare function getToolFlags(name: string): ToolFlags;
 
-interface Recipe {
-    name: string;
-    steps: unknown[];
-}
 /**
  * Routes each turn to the appropriate thinking effort level based on
  * message content, matched recipe, and session write history.
@@ -718,29 +861,6 @@ interface ConversationStateStore {
 }
 declare function buildStateContext(state: ConversationState): string;
 
-/** Rough token count for a message array. */
-declare function estimateTokens(messages: Message[]): number;
-interface CompactOptions {
-    /** Max token budget for the conversation. Default 100_000. */
-    maxTokens?: number;
-    /** Number of recent messages to always keep uncompacted. Default 6. */
-    keepRecentCount?: number;
-    /** System prompt token estimate (subtracted from budget). Default 500. */
-    systemPromptTokens?: number;
-}
-/**
- * Compact a conversation that exceeds the token budget.
- *
- * Strategy:
- * 1. Always preserve the most recent `keepRecentCount` messages (the active context).
- * 2. For older messages, summarise tool_result content to a brief one-liner.
- * 3. If still over budget, drop the oldest messages (keeping the first user message
- *    for context continuity).
- *
- * Returns a new array — does not mutate the input.
- */
-declare function compactMessages(messages: readonly Message[], opts?: CompactOptions): Message[];
-
 interface McpToolDescriptor {
     name: string;
     description: string;
@@ -1546,4 +1666,4 @@ declare function clearPriceCache(): void;
 
 declare const DEFAULT_SYSTEM_PROMPT = "You are a financial agent on Sui. You manage money and access paid APIs via MPP micropayments.\n\n## Response rules\n- 1-2 sentences max. No bullet lists unless asked. No preambles.\n- Never say \"Would you like me to...\", \"Sure!\", \"Great question!\", \"Absolutely!\" \u2014 just do it or say you can't.\n- Lead with the result. After tool calls, state the outcome with real numbers. Done.\n- Present amounts as $1,234.56 and rates as X.XX% APY.\n- Show top 3 results unless asked for more. Summarize totals in one line.\n\n## Execution rule\nOnly offer to execute actions you have tools for. If you retrieved a quote, data, or information but have no tool to act on it, give the user the result and tell them where to execute manually \u2014 in one sentence. Never say \"Would you like me to proceed?\" unless you have a tool that can actually proceed.\n\n## Before acting\n- ALWAYS call a read tool first before any write tool \u2014 balance_check before save/send/borrow, savings_info before withdraw.\n- Show real numbers from tools \u2014 never fabricate rates, amounts, or balances.\n- When user says \"all\" or an imprecise amount, call the read tool first to get the exact number.\n\n## Tool usage\n- Use tools proactively \u2014 don't refuse requests you can handle.\n- For real-world questions (weather, search, news, prices), use pay_api. Tell the user the cost first.\n- For broad market data (yields across protocols, token prices, TVL, protocol comparisons), use defillama_* tools.\n- To discover Sui protocols, use defillama_sui_protocols first, then defillama_protocol_info with the slug.\n- Run multiple read-only tools in parallel when you need several data points.\n- If a tool errors, say what went wrong and what to try instead. One sentence.\n\n## Savings = USDC only (critical)\n- save_deposit accepts ONLY USDC. No other token can be deposited into savings.\n- When asked \"how much can I save?\", report only the user's USDC wallet balance (saveableUsdc field from balance_check). Other tokens like GOLD, SUI, USDT are NOT saveable and NOT savings positions \u2014 they are just wallet holdings.\n- NEVER say a non-USDC token is \"in savings\" or \"earning APY in savings\" unless it appears in the savings_info positions list. Wallet holdings \u2260 savings.\n- If user wants to save non-USDC tokens, tell them to swap to USDC first. Do NOT auto-chain swap + deposit.\n\n## Multi-step flows\n- \"How much X for Y?\": swap_quote first, then swap_execute if user confirms.\n- \"Swap then save\": swap_execute \u2192 balance_check \u2192 save_deposit. Confirm each step.\n- \"Buy $X of token\": defillama_token_prices \u2192 calculate amount \u2192 swap_execute.\n- \"Best yield on SUI\": compare rates_info (NAVI lending) + defillama_yield_pools (broader) + volo_stats.\n- withdraw supports legacy positions: USDC, USDe, USDsui, SUI. Pass asset param to withdraw a specific token.\n- \"Deposit SUI to earn yield\": volo_stake for SUI liquid staking. save_deposit is USDC only.\n- \"What protocols are on Sui?\": defillama_sui_protocols \u2192 defillama_protocol_info for details.\n\n## Safety\n- Never encourage risky financial behavior.\n- Warn when health factor < 1.5.\n- All amounts in USDC unless stated otherwise.";
 
-export { AnthropicProvider, type AnthropicProviderConfig, type BalancePrices, type BalanceResult, BalanceTracker, type BuildToolOptions, CANVAS_TEMPLATES, type CanvasTemplate, type ChatParams, type CompactOptions, type ContentBlock, type ConversationState, type ConversationStateStore, type CostSnapshot, CostTracker, type CostTrackerConfig, DEFAULT_GUARD_CONFIG, DEFAULT_SYSTEM_PROMPT, type EngineConfig, type EngineEvent, type GuardCheckResult, type GuardConfig, type GuardEvent, type GuardInjection, type GuardResult, type GuardRunnerState, type GuardTier, type GuardVerdict, type HealthFactorResult, type LLMProvider, type McpCallResult, McpClientManager, McpResponseCache, type McpServerConfig, type McpServerConnection, type McpToolAdapterConfig, type McpToolDescriptor, MemorySessionStore, type Message, NAVI_MCP_CONFIG, NAVI_MCP_URL, NAVI_SERVER_NAME, type NaviRawCoin, type NaviRawHealthFactor, type NaviRawPool, type NaviRawPosition, type NaviRawPositionsResponse, type NaviRawProtocolStats, type NaviRawRewardsResponse, type NaviReadOptions, NaviTools, type OutputConfig, type PendingAction, type PendingReward, type PendingToolCall, type PermissionLevel, type PermissionResponse, type PositionEntry, type PreflightResult, type ProtocolStats, type ProviderEvent, QueryEngine, READ_TOOLS, type RatesResult, RetryTracker, type SSEEvent, type SavingsResult, type ServerPositionData, type SessionData, type SessionStore, type StateType, type StopReason, type SuiCoinBalance, type SystemBlock, type SystemPrompt, TOOL_FLAGS, type ThinkingConfig, type ThinkingEffort, type Tool, type ToolChoice, type ToolContext, type ToolDefinition, type ToolFlags, type ToolJsonSchema, type ToolResult, TxMutex, type UserFinancialProfile, WRITE_TOOLS, type WalletCoin, activitySummaryTool, adaptAllMcpTools, adaptAllServerTools, adaptMcpTool, applyToolFlags, balanceCheckTool, borrowTool, buildCachedSystemPrompt, buildMcpTools, buildProactivenessInstructions, buildProfileContext, buildSelfEvaluationInstruction, buildStateContext, buildTool, claimRewardsTool, classifyEffort, clearPriceCache, compactMessages, createGuardRunnerState, defillamaChainTvlTool, defillamaPriceChangeTool, defillamaProtocolFeesTool, defillamaProtocolInfoTool, defillamaSuiProtocolsTool, defillamaTokenPricesTool, defillamaYieldPoolsTool, engineToSSE, estimateTokens, explainTxTool, extractConversationText, extractMcpText, fetchAvailableRewards, fetchBalance, fetchHealthFactor, fetchPositions, fetchProtocolStats, fetchRates, fetchSavings, fetchTokenPrices, fetchWalletCoins, findTool, getDefaultTools, getMcpManager, getToolFlags, getWalletAddress, guardArtifactPreview, guardStaleData, hasNaviMcp, healthCheckTool, mppServicesTool, parseMcpJson, parseSSE, payApiTool, portfolioAnalysisTool, protocolDeepDiveTool, ratesInfoTool, registerEngineTools, renderCanvasTool, repayDebtTool, requireAgent, runGuards, runTools, saveContactTool, saveDepositTool, savingsInfoTool, sendTransferTool, serializeSSE, spendingAnalyticsTool, swapExecuteTool, swapQuoteTool, toolsToDefinitions, transactionHistoryTool, transformBalance, transformHealthFactor, transformPositions, transformRates, transformRewards, transformSavings, updateGuardStateAfterToolResult, validateHistory, voloStakeTool, voloStatsTool, voloUnstakeTool, webSearchTool, withdrawTool, yieldSummaryTool };
+export { AnthropicProvider, type AnthropicProviderConfig, type BalancePrices, type BalanceResult, BalanceTracker, type BuildToolOptions, CANVAS_TEMPLATES, type CanvasTemplate, type ChatParams, type CompactOptions, type ContentBlock, ContextBudget, type ContextBudgetConfig, type ConversationState, type ConversationStateStore, type CostSnapshot, CostTracker, type CostTrackerConfig, DEFAULT_GUARD_CONFIG, DEFAULT_SYSTEM_PROMPT, type EngineConfig, type EngineEvent, type GuardCheckResult, type GuardConfig, type GuardEvent, type GuardInjection, type GuardResult, type GuardRunnerState, type GuardTier, type GuardVerdict, type HealthFactorResult, type LLMProvider, type McpCallResult, McpClientManager, McpResponseCache, type McpServerConfig, type McpServerConnection, type McpToolAdapterConfig, type McpToolDescriptor, MemorySessionStore, type Message, NAVI_MCP_CONFIG, NAVI_MCP_URL, NAVI_SERVER_NAME, type NaviRawCoin, type NaviRawHealthFactor, type NaviRawPool, type NaviRawPosition, type NaviRawPositionsResponse, type NaviRawProtocolStats, type NaviRawRewardsResponse, type NaviReadOptions, NaviTools, type OutputConfig, type PendingAction, type PendingReward, type PendingToolCall, type PermissionLevel, type PermissionResponse, type PositionEntry, type PreflightResult, type ProtocolStats, type ProviderEvent, QueryEngine, READ_TOOLS, type RatesResult, type Recipe, type RecipePrerequisite, RecipeRegistry, type RecipeStep, type RecipeStepOnError, RetryTracker, type SSEEvent, type SavingsResult, type ServerPositionData, type SessionData, type SessionStore, type StateType, type StopReason, type SuiCoinBalance, type SystemBlock, type SystemPrompt, TOOL_FLAGS, type ThinkingConfig, type ThinkingEffort, type Tool, type ToolChoice, type ToolContext, type ToolDefinition, type ToolFlags, type ToolJsonSchema, type ToolResult, TxMutex, type UserFinancialProfile, WRITE_TOOLS, type WalletCoin, activitySummaryTool, adaptAllMcpTools, adaptAllServerTools, adaptMcpTool, applyToolFlags, balanceCheckTool, borrowTool, buildCachedSystemPrompt, buildMcpTools, buildProactivenessInstructions, buildProfileContext, buildSelfEvaluationInstruction, buildStateContext, buildTool, claimRewardsTool, classifyEffort, clearPriceCache, compactMessages, createGuardRunnerState, defillamaChainTvlTool, defillamaPriceChangeTool, defillamaProtocolFeesTool, defillamaProtocolInfoTool, defillamaSuiProtocolsTool, defillamaTokenPricesTool, defillamaYieldPoolsTool, engineToSSE, estimateTokens, explainTxTool, extractConversationText, extractMcpText, fetchAvailableRewards, fetchBalance, fetchHealthFactor, fetchPositions, fetchProtocolStats, fetchRates, fetchSavings, fetchTokenPrices, fetchWalletCoins, findTool, getDefaultTools, getMcpManager, getToolFlags, getWalletAddress, guardArtifactPreview, guardStaleData, hasNaviMcp, healthCheckTool, loadRecipes, mppServicesTool, parseMcpJson, parseRecipe, parseSSE, payApiTool, portfolioAnalysisTool, protocolDeepDiveTool, ratesInfoTool, registerEngineTools, renderCanvasTool, repayDebtTool, requireAgent, runGuards, runTools, saveContactTool, saveDepositTool, savingsInfoTool, sendTransferTool, serializeSSE, spendingAnalyticsTool, swapExecuteTool, swapQuoteTool, toolsToDefinitions, transactionHistoryTool, transformBalance, transformHealthFactor, transformPositions, transformRates, transformRewards, transformSavings, updateGuardStateAfterToolResult, validateHistory, voloStakeTool, voloStatsTool, voloUnstakeTool, webSearchTool, withdrawTool, yieldSummaryTool };