@memberjunction/ai-agents 6.1.5 → 6.1.6

package/dist/base-agent.js

@@ -18,9 +18,9 @@ import { looksLikeLoopEnvelope } from './native-tools/dual-channel.js';
 import { Metadata, RunView, LogStatus, LogStatusEx, LogError, LogErrorEx, IsVerboseLoggingEnabled, DatabaseProviderBase } from '@memberjunction/core';
 import { AgentRunWatchdog } from './agent-run-watchdog.js';
 import { AIPromptRunner, GetToolCallingDecision } from '@memberjunction/ai-prompts';
-import { BaseRealtimeModel, GetAIAPIKey } from '@memberjunction/ai';
+import { BaseRealtimeModel, GetAIAPIKey, CredentialScopeAllows } from '@memberjunction/ai';
 import { BaseAgentType } from './agent-types/base-agent-type.js';
-import { CopyScalarsAndArrays, JSONValidator, MJGlobal, SafeExpressionEvaluator, UUIDsEqual, EscapeSQLString } from '@memberjunction/global';
+import { CopyScalarsAndArrays, JSONValidator, MJGlobal, SafeExpressionEvaluator, UUIDsEqual, EscapeSQLString, IsValidUUID } from '@memberjunction/global';
 // token optimization via @memberjunction/context-crush (SmartCrusher/CacheAligner-inspired)
 import { CrushJSON, DescribeCrush, PartitionStablePrefix } from '@memberjunction/context-crush';
 // AST-aware code reduction (CodeCompressor-inspired) — opt-in per agent type
@@ -1604,6 +1604,7 @@ export class BaseAgent {
             ? (params.data?.realtimeSelfNames).filter((n) => typeof n === 'string')
             : undefined;
         return {
+            CredentialScope: params.CredentialScope,
             CoAgent: params.agent,
             TargetAgentID: targetID,
             AgentSessionID: params.data?.agentSessionId ?? '',
@@ -1649,7 +1650,8 @@ export class BaseAgent {
             if (!vendor) {
                 continue;
             }
-            const apiKey = GetAIAPIKey(vendor.DriverClass);
+            // Realtime only ever uses the platform key here, so a scope that rules that out has no key.
+            const apiKey = CredentialScopeAllows(params.CredentialScope, 'Environment') ? GetAIAPIKey(vendor.DriverClass) : undefined;
             if (!apiKey) {
                 continue;
             }
@@ -1926,6 +1928,7 @@ export class BaseAgent {
                 parentDepth: this._depth,
                 configurationId: params.configurationId,
                 apiKeys: params.apiKeys,
+                CredentialScope: params.CredentialScope,
                 data: params.data,
                 verbose: params.verbose,
                 // Progress streams BOTH to the runner's narration consumer (request.OnProgress —
@@ -2449,6 +2452,13 @@ export class BaseAgent {
             this.logStatus(`🔄 Executing step ${stepCount + 1} for agent '${params.agent.Name}'`, true, params);
             const nextStep = await this.executeNextStep(params, config, currentNextStep, stepCount);
             stepCount++;
+            // A failed step cut short by a cancellation is not a failure: end the run as cancelled
+            // before the step is counted toward the consecutive-failure limit, which would end it as
+            // Failed. A step that finished is kept: a final answer the user stopped too late to
+            // prevent still completes the run.
+            if (nextStep.step === 'Failed' && params.cancellationToken?.aborted) {
+                throw new Error('Cancelled during execution');
+            }
             // Promote any media outputs from this step to the agent's outputs
             if (nextStep.promoteMediaOutputs && nextStep.promoteMediaOutputs.length > 0) {
                 this.promoteMediaOutputs(nextStep.promoteMediaOutputs);
@@ -3381,6 +3391,7 @@ export class BaseAgent {
             if (params.apiKeys && params.apiKeys.length > 0) {
                 childPromptParams.apiKeys = params.apiKeys;
             }
+            childPromptParams.CredentialScope = params.CredentialScope;
             // Pass through configurationId to both parent and child prompts if provided
             if (params.configurationId) {
                 promptParams.configurationId = params.configurationId;
@@ -3416,6 +3427,10 @@ export class BaseAgent {
             promptParams.apiKeys = params.apiKeys;
             this.logStatus(`🔑 Using ${params.apiKeys.length} API key(s) provided at runtime`, true, params);
         }
+        promptParams.CredentialScope = params.CredentialScope;
+        if (!CredentialScopeAllows(params.CredentialScope, 'Environment')) {
+            this.logStatus(`🔒 Credential scope is ${params.CredentialScope}: the platform's environment API keys will not be used`, true, params);
+        }
         // Thread the per-request provider so prompt run records are saved through the isolated provider
         promptParams.provider = params.provider || this._activeProvider;
         // Overlay scope-resolved run settings (model / vendor / configuration / effort / sampling
@@ -5318,10 +5333,10 @@ The context is now within limits. Please retry your request with the recovered c
                     throw new Error(`The '${BaseAgent.SummarizeRangePromptName}' system prompt is not present in this environment`);
                 }
                 const promptParams = new AIPromptParams();
+                Object.assign(promptParams, this.runPromptExecutionScope(params));
                 promptParams.prompt = prompt;
                 // Keys are the summarize-range.template.md contract ({{ lens }}, {{ messages }})
                 promptParams.data = { lens, messages: rangeText };
-                promptParams.contextUser = params.contextUser;
                 promptParams.agentId = params.agent.ID;
                 const result = await this._promptRunner.ExecutePrompt(promptParams);
                 const text = ExtractPromptResultText(result);
@@ -6187,7 +6202,10 @@ The context is now within limits. Please retry your request with the recovered c
                 ContextUser: contextUser,
                 Filters: [],
                 SkipActionLog: false,
-                Context: actionContext
+                Context: actionContext,
+                // AICredentialScope → actions-base's RuntimeCredentialScope mirror: a value added to the
+                // former and not the latter fails to compile here, so the two cannot drift apart.
+                CredentialScope: params.CredentialScope
             });
             if (result.Success) {
                 this.logStatus(`   ✅ Action '${action.name}' completed successfully`, true, params);
@@ -6418,6 +6436,7 @@ The context is now within limits. Please retry your request with the recovered c
                 configurationId: params.configurationId, // propagate configuration ID to sub-agent
                 effortLevel: params.effortLevel, // propagate effort level to sub-agent
                 apiKeys: params.apiKeys, // propagate API keys to sub-agent
+                CredentialScope: params.CredentialScope, // a sub-agent may not spend keys its parent could not
                 inputArtifacts: params.inputArtifacts, // propagate input artifacts so sub-agents inherit the parent's artifact manifest + tools (e.g. a Codesmith delegate can read a Data Snapshot the parent references)
                 data: {
                     ...params.data,
@@ -7068,6 +7087,16 @@ The context is now within limits. Please retry your request with the recovered c
         // For now, returning a placeholder
         return 'General';
     }
+    /**
+     * Throws unless `lastRunId` is absent or a UUID. The value can come from a client, and the run
+     * initialization places it in `ExtraFilter` clauses (the payload lookup, {@link validateRunChain}
+     * and {@link resolvePlanModeGate}).
+     */
+    assertLastRunIdIsUUID(lastRunId) {
+        if (lastRunId && !IsValidUUID(lastRunId)) {
+            throw new Error('Invalid lastRunId: expected the UUID of a prior AI Agent Run.');
+        }
+    }
     /**
      * Initializes the agent run tracking by creating MJAIAgentRunEntityExtended and setting up context.
      *
@@ -7075,6 +7104,7 @@ The context is now within limits. Please retry your request with the recovered c
      * @param {ExecuteAgentParams} params - The execution parameters
      */
     async initializeAgentRun(params) {
+        this.assertLastRunIdIsUUID(params.lastRunId);
         // Handle autoPopulateLastRunPayload if requested
         let modifiedParams = params;
         if (params.lastRunId && params.autoPopulateLastRunPayload) {
@@ -8040,6 +8070,23 @@ The context is now within limits. Please retry your request with the recovered c
             if (promptResult.modelSelectionInfo) {
                 this._lastModelSelectionInfo = promptResult.modelSelectionInfo;
             }
+            // Check for cancellation after prompt execution — before the failure check, because a prompt
+            // the caller cancelled comes back failed, and that is not a prompt failure. The step does not
+            // terminate the loop: a terminating step would finalize the run as Failed. The loop's own
+            // cancellation check, before the next step, ends the run as Cancelled.
+            if (params.cancellationToken?.aborted) {
+                if (stepEntity && payload) {
+                    stepEntity.PayloadAtEnd = this.serializePayloadAtEnd(payload);
+                }
+                await this.finalizeStepEntity(stepEntity, false, 'Cancelled during prompt execution');
+                return {
+                    errorMessage: 'Cancelled during prompt execution',
+                    step: 'Failed',
+                    terminate: false,
+                    previousPayload: payload,
+                    newPayload: payload
+                };
+            }
             // Check if prompt execution failed
             if (!promptResult.success) {
                 // CRITICAL FIX: Preserve payload before finalizing step
@@ -8068,22 +8115,6 @@ The context is now within limits. Please retry your request with the recovered c
                     newPayload: payload
                 };
             }
-            // Check for cancellation after prompt execution
-            if (params.cancellationToken?.aborted) {
-                // CRITICAL FIX: Preserve payload before finalizing step
-                if (stepEntity && payload) {
-                    stepEntity.PayloadAtEnd = this.serializePayloadAtEnd(payload);
-                }
-                await this.finalizeStepEntity(stepEntity, false, 'Cancelled during prompt execution');
-                const cancelledResult = await this.createCancelledResult('Cancelled during prompt execution', params.contextUser);
-                return {
-                    ...cancelledResult,
-                    terminate: true,
-                    step: 'Failed', // Cancelled is treated as failed
-                    previousPayload: cancelledResult.payload,
-                    newPayload: cancelledResult.payload // No changes, just return the same payload
-                };
-            }
             // Report decision processing progress
             this.safeOnProgress(params, {
                 step: 'decision_processing',
@@ -12340,6 +12371,21 @@ The context is now within limits. Please retry your request with the recovered c
             LogError(`Post-turn cross-turn compaction error (contained): ${error instanceof Error ? error.message : error}`);
         });
     }
+    /**
+     * The {@link AIPromptExecutionScope} of a prompt this run starts outside the agent's own turn —
+     * summarizing a range, compacting a message, compacting the conversation. Each built its params
+     * with only `contextUser`, so it ran on the platform's keys and default configuration inside a
+     * run on a customer's keys, and under a `'RuntimeOnly'` scope would have bypassed it.
+     */
+    runPromptExecutionScope(params) {
+        return {
+            contextUser: params.contextUser,
+            provider: params.provider || this._activeProvider,
+            configurationId: params.configurationId,
+            apiKeys: params.apiKeys,
+            CredentialScope: params.CredentialScope,
+        };
+    }
     /**
      * Runs one compaction pass and records it as a `StepType='Compaction'` run step —
      * TargetID = the summary prompt, TargetLogID = the summary AIPromptRun (the same ID
@@ -12358,6 +12404,7 @@ The context is now within limits. Please retry your request with the recovered c
             Budget: budget,
             ContextUser: params.contextUser,
             Provider: this.ProviderToUse,
+            ExecutionScope: this.runPromptExecutionScope(params),
             EstimateTokens: (messages) => this.estimateConversationTokens(messages),
             Verbose: params.verbose,
             // The in-flight agent-response placeholder row: a post-turn pass runs while
@@ -12582,6 +12629,7 @@ The context is now within limits. Please retry your request with the recovered c
                     const step = await this.createCompactionStep(prompt, message, params);
                     // Execute summarization prompt
                     const promptParams = new AIPromptParams();
+                    Object.assign(promptParams, this.runPromptExecutionScope(params));
                     promptParams.prompt = prompt;
                     promptParams.data = {
                         originalContent,
@@ -12590,7 +12638,6 @@ The context is now within limits. Please retry your request with the recovered c
                         messageType: message.metadata?.messageType || 'unknown',
                         turnAdded: message.metadata?.turnAdded || 0
                     };
-                    promptParams.contextUser = params.contextUser;
                     promptParams.agentId = params.agent.ID;
                     const runner = new AIPromptRunner();
                     const result = await runner.ExecutePrompt(promptParams);