@langwatch/scenario 0.2.2 → 0.2.9

package/dist/index.js

@@ -32,7 +32,9 @@ var index_exports = {};
 __export(index_exports, {
   AgentAdapter: () => AgentAdapter,
   AgentRole: () => AgentRole,
+  DEFAULT_MAX_TURNS: () => DEFAULT_MAX_TURNS,
   DEFAULT_TEMPERATURE: () => DEFAULT_TEMPERATURE,
+  DEFAULT_VERBOSE: () => DEFAULT_VERBOSE,
   JudgeAgentAdapter: () => JudgeAgentAdapter,
   ScenarioExecution: () => ScenarioExecution,
   ScenarioExecutionState: () => ScenarioExecutionState,
@@ -71,7 +73,9 @@ var domain_exports = {};
 __export(domain_exports, {
   AgentAdapter: () => AgentAdapter,
   AgentRole: () => AgentRole,
+  DEFAULT_MAX_TURNS: () => DEFAULT_MAX_TURNS,
   DEFAULT_TEMPERATURE: () => DEFAULT_TEMPERATURE,
+  DEFAULT_VERBOSE: () => DEFAULT_VERBOSE,
   JudgeAgentAdapter: () => JudgeAgentAdapter,
   UserSimulatorAgentAdapter: () => UserSimulatorAgentAdapter,
   allAgentRoles: () => allAgentRoles,
@@ -120,6 +124,10 @@ var JudgeAgentAdapter = class {
   }
 };
 
+// src/domain/scenarios/index.ts
+var DEFAULT_MAX_TURNS = 10;
+var DEFAULT_VERBOSE = false;
+
 // src/agents/utils.ts
 var toolMessageRole = "tool";
 var assistantMessageRole = "assistant";
@@ -175,6 +183,53 @@ var criterionToParamName = (criterion) => {
   return criterion.replace(/"/g, "").replace(/[^a-zA-Z0-9]/g, "_").replace(/ /g, "_").toLowerCase().substring(0, 70);
 };
 
+// src/config/env.ts
+var import_zod2 = require("zod");
+
+// src/config/log-levels.ts
+var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
+  LogLevel2["ERROR"] = "ERROR";
+  LogLevel2["WARN"] = "WARN";
+  LogLevel2["INFO"] = "INFO";
+  LogLevel2["DEBUG"] = "DEBUG";
+  return LogLevel2;
+})(LogLevel || {});
+
+// src/config/env.ts
+var envSchema = import_zod2.z.object({
+  /**
+   * LangWatch API key for event reporting.
+   * If not provided, events will not be sent to LangWatch.
+   */
+  LANGWATCH_API_KEY: import_zod2.z.string().optional(),
+  /**
+   * LangWatch endpoint URL for event reporting.
+   * Defaults to the production LangWatch endpoint.
+   */
+  LANGWATCH_ENDPOINT: import_zod2.z.string().url().default("https://app.langwatch.ai"),
+  /**
+   * Disables simulation report info messages when set to any truthy value.
+   * Useful for CI/CD environments or when you want cleaner output.
+   */
+  SCENARIO_DISABLE_SIMULATION_REPORT_INFO: import_zod2.z.string().optional().transform((val) => Boolean(val)),
+  /**
+   * Node environment - affects logging and behavior.
+   * Defaults to 'development' if not specified.
+   */
+  NODE_ENV: import_zod2.z.enum(["development", "production", "test"]).default("development"),
+  /**
+   * Log level for the scenario package.
+   * Defaults to 'info' if not specified.
+   */
+  LOG_LEVEL: import_zod2.z.nativeEnum(LogLevel).optional(),
+  /**
+   * Scenario batch run ID.
+   * If not provided, a random ID will be generated.
+   */
+  SCENARIO_BATCH_RUN_ID: import_zod2.z.string().optional()
+});
+var env = envSchema.parse(process.env);
+
 // src/config/load.ts
 var import_promises = __toESM(require("fs/promises"));
 var import_node_path = __toESM(require("path"));
@@ -220,7 +275,7 @@ var Logger = class _Logger {
     return new _Logger(context);
   }
   getLogLevel() {
-    return env.SCENARIO_LOG_LEVEL ?? "INFO" /* INFO */;
+    return env.LOG_LEVEL ?? "INFO" /* INFO */;
   }
   getLogLevelIndex(level) {
     return Object.values(LogLevel).indexOf(level);
@@ -278,54 +333,7 @@ var Logger = class _Logger {
   }
 };
 
-// src/config/env.ts
-var import_zod2 = require("zod");
-
-// src/config/log-levels.ts
-var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
-  LogLevel2["ERROR"] = "ERROR";
-  LogLevel2["WARN"] = "WARN";
-  LogLevel2["INFO"] = "INFO";
-  LogLevel2["DEBUG"] = "DEBUG";
-  return LogLevel2;
-})(LogLevel || {});
-
-// src/config/env.ts
-var envSchema = import_zod2.z.object({
-  /**
-   * LangWatch API key for event reporting.
-   * If not provided, events will not be sent to LangWatch.
-   */
-  LANGWATCH_API_KEY: import_zod2.z.string().optional(),
-  /**
-   * LangWatch endpoint URL for event reporting.
-   * Defaults to the production LangWatch endpoint.
-   */
-  LANGWATCH_ENDPOINT: import_zod2.z.string().url().default("https://app.langwatch.ai"),
-  /**
-   * Disables simulation report info messages when set to any truthy value.
-   * Useful for CI/CD environments or when you want cleaner output.
-   */
-  SCENARIO_DISABLE_SIMULATION_REPORT_INFO: import_zod2.z.string().optional().transform((val) => Boolean(val)),
-  /**
-   * Node environment - affects logging and behavior.
-   * Defaults to 'development' if not specified.
-   */
-  NODE_ENV: import_zod2.z.enum(["development", "production", "test"]).default("development"),
-  /**
-   * Log level for the scenario package.
-   * Defaults to 'info' if not specified.
-   */
-  SCENARIO_LOG_LEVEL: import_zod2.z.nativeEnum(LogLevel).optional(),
-  /**
-   * Scenario batch run ID.
-   * If not provided, a random ID will be generated.
-   */
-  SCENARIO_BATCH_RUN_ID: import_zod2.z.string().optional()
-});
-var env = envSchema.parse(process.env);
-
-// src/config/index.ts
+// src/config/get-project-config.ts
 var logger = new Logger("scenario.config");
 var configLoaded = false;
 var config = null;
@@ -340,7 +348,7 @@ async function loadProjectConfig() {
   configLoadPromise = (async () => {
     try {
       config = await loadScenarioProjectConfig();
-      logger.info("loaded scenario project config", { config });
+      logger.debug("loaded scenario project config", { config });
     } catch (error) {
       logger.error("error loading scenario project config", { error });
     } finally {
@@ -573,7 +581,10 @@ __export(execution_exports, {
 var import_rxjs = require("rxjs");
 
 // src/utils/ids.ts
+var import_node_crypto = __toESM(require("crypto"));
+var import_node_process = __toESM(require("process"));
 var import_xksuid = require("xksuid");
+var batchRunId;
 function generateThreadId() {
   return `thread_${(0, import_xksuid.generate)()}`;
 }
@@ -584,10 +595,31 @@ function generateScenarioId() {
   return `scenario_${(0, import_xksuid.generate)()}`;
 }
 function getBatchRunId() {
-  if (!env.SCENARIO_BATCH_RUN_ID) {
-    env.SCENARIO_BATCH_RUN_ID = `scenariobatchrun_${(0, import_xksuid.generate)()}`;
-  }
-  return env.SCENARIO_BATCH_RUN_ID;
+  if (batchRunId) {
+    return batchRunId;
+  }
+  if (import_node_process.default.env.SCENARIO_BATCH_RUN_ID) {
+    console.log("process.env.SCENARIO_BATCH_RUN_ID", import_node_process.default.env.SCENARIO_BATCH_RUN_ID);
+    return batchRunId = import_node_process.default.env.SCENARIO_BATCH_RUN_ID;
+  }
+  if (import_node_process.default.env.VITEST_WORKER_ID || import_node_process.default.env.JEST_WORKER_ID) {
+    const parentProcessId = import_node_process.default.ppid;
+    const now = /* @__PURE__ */ new Date();
+    const year = now.getUTCFullYear();
+    const week = String(getISOWeekNumber(now)).padStart(2, "0");
+    const raw = `${parentProcessId}_${year}_w${week}`;
+    const hash = import_node_crypto.default.createHash("sha256").update(raw).digest("hex").slice(0, 12);
+    return batchRunId = `scenariobatchrun_${hash}`;
+  }
+  return batchRunId = `scenariobatchrun_${(0, import_xksuid.generate)()}`;
+}
+function getISOWeekNumber(date) {
+  const tmp = new Date(Date.UTC(date.getUTCFullYear(), date.getUTCMonth(), date.getUTCDate()));
+  const dayNum = tmp.getUTCDay() || 7;
+  tmp.setUTCDate(tmp.getUTCDate() + 4 - dayNum);
+  const yearStart = new Date(Date.UTC(tmp.getUTCFullYear(), 0, 1));
+  const weekNo = Math.ceil(((tmp.getTime() - yearStart.getTime()) / 864e5 + 1) / 7);
+  return weekNo;
 }
 function generateMessageId() {
   return `scenariomsg_${(0, import_xksuid.generate)()}`;
@@ -643,6 +675,16 @@ var ScenarioExecutionState = class {
     }
     return lastMessage;
   }
+  lastAgentMessage() {
+    if (this._messages.length === 0) {
+      throw new Error("No messages in history");
+    }
+    const lastMessage = this._messages.findLast((message2) => message2.role === "assistant");
+    if (!lastMessage) {
+      throw new Error("No agent message in history");
+    }
+    return lastMessage;
+  }
   lastToolCall(toolName) {
     if (this._messages.length === 0) {
       throw new Error("No messages in history");
@@ -650,9 +692,6 @@ var ScenarioExecutionState = class {
     const lastMessage = this._messages.findLast((message2) => message2.role === "tool" && message2.content.find(
       (part) => part.type === "tool-result" && part.toolName === toolName
     ));
-    if (!lastMessage) {
-      throw new Error("No tool call message in history");
-    }
     return lastMessage;
   }
   hasToolCall(toolName) {
@@ -808,7 +847,6 @@ function convertCoreMessagesToAguiMessages(coreMessages) {
 var message_conversion_default = convertCoreMessagesToAguiMessages;
 
 // src/execution/scenario-execution.ts
-var batchRunId = getBatchRunId();
 var ScenarioExecution = class {
   state;
   eventSubject = new import_rxjs.Subject();
@@ -838,8 +876,8 @@ var ScenarioExecution = class {
       description: config2.description,
       agents: config2.agents,
       script,
-      verbose: config2.verbose ?? false,
-      maxTurns: config2.maxTurns ?? 10,
+      verbose: config2.verbose ?? DEFAULT_VERBOSE,
+      maxTurns: config2.maxTurns ?? DEFAULT_MAX_TURNS,
       threadId: config2.threadId ?? generateThreadId(),
       setId: config2.setId
     };
@@ -891,12 +929,14 @@ var ScenarioExecution = class {
         }
       }
       this.emitRunFinished({ scenarioRunId, status: "FAILED" /* FAILED */ });
-      return this.reachedMaxTurns([
-        "Reached end of script without conclusion, add one of the following to the end of the script:",
-        "- `Scenario.proceed()` to let the simulation continue to play out",
-        "- `Scenario.judge()` to force criteria judgement",
-        "- `Scenario.succeed()` or `Scenario.fail()` to end the test with an explicit result"
-      ].join("\n"));
+      return this.reachedMaxTurns(
+        [
+          "Reached end of script without conclusion, add one of the following to the end of the script:",
+          "- `Scenario.proceed()` to let the simulation continue to play out",
+          "- `Scenario.judge()` to force criteria judgement",
+          "- `Scenario.succeed()` or `Scenario.fail()` to end the test with an explicit result"
+        ].join("\n")
+      );
     } catch (error) {
       const errorResult = {
         success: false,
@@ -1031,8 +1071,7 @@ var ScenarioExecution = class {
     while (true) {
       const goToNextTurn = turns === void 0 || initialTurn === null || this.state.currentTurn != null && this.state.currentTurn + 1 < initialTurn + turns;
       const nextMessage = await this._step(goToNextTurn, onTurn);
-      if (initialTurn === null)
-        initialTurn = this.state.currentTurn;
+      if (initialTurn === null) initialTurn = this.state.currentTurn;
       if (nextMessage === null) {
         return null;
       }
@@ -1118,7 +1157,10 @@ var ScenarioExecution = class {
     agent2 = nextAgent.agent;
     this.removePendingAgent(agent2);
     if (content) {
-      const message2 = typeof content === "string" ? { role: role === "User" /* USER */ ? "user" : "assistant", content } : content;
+      const message2 = typeof content === "string" ? {
+        role: role === "User" /* USER */ ? "user" : "assistant",
+        content
+      } : content;
       this.state.addMessage(message2);
       this.broadcastMessage(message2, index);
       return null;
@@ -1191,7 +1233,9 @@ var ScenarioExecution = class {
   reachedMaxTurns(errorMessage) {
     var _a;
     const agentRoleAgentsIdx = this.agents.map((agent2, i) => ({ agent: agent2, idx: i })).filter(({ agent: agent2 }) => agent2.role === "Agent" /* AGENT */).map(({ idx }) => idx);
-    const agentTimes = agentRoleAgentsIdx.map((i) => this.agentTimes.get(i) || 0);
+    const agentTimes = agentRoleAgentsIdx.map(
+      (i) => this.agentTimes.get(i) || 0
+    );
     const totalAgentTime = agentTimes.reduce((sum, time) => sum + time, 0);
     return {
       success: false,
@@ -1220,7 +1264,7 @@ var ScenarioExecution = class {
       type: "placeholder",
       // This will be replaced by the specific event type
       timestamp: Date.now(),
-      batchRunId,
+      batchRunId: getBatchRunId(),
       scenarioId: this.config.id,
       scenarioRunId,
       scenarioSetId: this.config.setId
@@ -1293,10 +1337,8 @@ var ScenarioExecution = class {
 function convertAgentReturnTypesToMessages(response, role) {
   if (typeof response === "string")
     return [{ role, content: response }];
-  if (Array.isArray(response))
-    return response;
-  if (typeof response === "object" && "role" in response)
-    return [response];
+  if (Array.isArray(response)) return response;
+  if (typeof response === "object" && "role" in response) return [response];
   return [];
 }
 
@@ -1320,12 +1362,11 @@ var EventAlertMessageLogger = class _EventAlertMessageLogger {
     if (this.isGreetingDisabled()) {
       return;
     }
-    const batchRunId2 = getBatchRunId();
-    if (_EventAlertMessageLogger.shownBatchIds.has(batchRunId2)) {
+    if (_EventAlertMessageLogger.shownBatchIds.has(getBatchRunId())) {
       return;
     }
-    _EventAlertMessageLogger.shownBatchIds.add(batchRunId2);
-    this.displayGreeting(batchRunId2);
+    _EventAlertMessageLogger.shownBatchIds.add(getBatchRunId());
+    this.displayGreeting();
   }
   /**
    * Shows a fancy message about how to watch the simulation.
@@ -1340,7 +1381,7 @@ var EventAlertMessageLogger = class _EventAlertMessageLogger {
   isGreetingDisabled() {
     return env.SCENARIO_DISABLE_SIMULATION_REPORT_INFO === true;
   }
-  displayGreeting(batchRunId2) {
+  displayGreeting() {
     const separator = "\u2500".repeat(60);
     if (!env.LANGWATCH_API_KEY) {
       console.log(`
@@ -1354,7 +1395,10 @@ ${separator}`);
       console.log("   \u2022 Set LANGWATCH_API_KEY environment variable");
       console.log("   \u2022 Or configure apiKey in scenario.config.js");
       console.log("");
-      console.log(`\u{1F4E6} Batch Run ID: ${batchRunId2}`);
+      console.log(`\u{1F4E6} Batch Run ID: ${getBatchRunId()}`);
+      console.log("");
+      console.log("\u{1F507} To disable these messages:");
+      console.log("   \u2022 Set SCENARIO_DISABLE_SIMULATION_REPORT_INFO=true");
       console.log(`${separator}
 `);
     } else {
@@ -1368,7 +1412,10 @@ ${separator}`);
         `   API Key: ${env.LANGWATCH_API_KEY.length > 0 ? "Configured" : "Not configured"}`
       );
       console.log("");
-      console.log(`\u{1F4E6} Batch Run ID: ${batchRunId2}`);
+      console.log(`\u{1F4E6} Batch Run ID: ${getBatchRunId()}`);
+      console.log("");
+      console.log("\u{1F507} To disable these messages:");
+      console.log("   \u2022 Set SCENARIO_DISABLE_SIMULATION_REPORT_INFO=true");
       console.log(`${separator}
 `);
     }
@@ -1712,7 +1759,9 @@ var index_default = scenario;
 0 && (module.exports = {
   AgentAdapter,
   AgentRole,
+  DEFAULT_MAX_TURNS,
   DEFAULT_TEMPERATURE,
+  DEFAULT_VERBOSE,
   JudgeAgentAdapter,
   ScenarioExecution,
   ScenarioExecutionState,

package/dist/index.mjs

@@ -1,15 +1,15 @@
 import {
   AgentAdapter,
   AgentRole,
+  DEFAULT_MAX_TURNS,
   DEFAULT_TEMPERATURE,
+  DEFAULT_VERBOSE,
   EventBus,
   JudgeAgentAdapter,
-  Logger,
   UserSimulatorAgentAdapter,
   allAgentRoles,
   defineConfig,
   domain_exports,
-  env,
   generateMessageId,
   generateScenarioId,
   generateScenarioRunId,
@@ -17,7 +17,11 @@ import {
   getBatchRunId,
   getProjectConfig,
   scenarioProjectConfigSchema
-} from "./chunk-NUZZAQV2.mjs";
+} from "./chunk-7H6OGEQ5.mjs";
+import {
+  Logger,
+  env
+} from "./chunk-YPJZSK4J.mjs";
 import {
   __export
 } from "./chunk-7P6ASYW6.mjs";
@@ -356,6 +360,16 @@ var ScenarioExecutionState = class {
     }
     return lastMessage;
   }
+  lastAgentMessage() {
+    if (this._messages.length === 0) {
+      throw new Error("No messages in history");
+    }
+    const lastMessage = this._messages.findLast((message2) => message2.role === "assistant");
+    if (!lastMessage) {
+      throw new Error("No agent message in history");
+    }
+    return lastMessage;
+  }
   lastToolCall(toolName) {
     if (this._messages.length === 0) {
       throw new Error("No messages in history");
@@ -363,9 +377,6 @@ var ScenarioExecutionState = class {
     const lastMessage = this._messages.findLast((message2) => message2.role === "tool" && message2.content.find(
       (part) => part.type === "tool-result" && part.toolName === toolName
     ));
-    if (!lastMessage) {
-      throw new Error("No tool call message in history");
-    }
     return lastMessage;
   }
   hasToolCall(toolName) {
@@ -449,7 +460,6 @@ function convertCoreMessagesToAguiMessages(coreMessages) {
 var message_conversion_default = convertCoreMessagesToAguiMessages;
 
 // src/execution/scenario-execution.ts
-var batchRunId = getBatchRunId();
 var ScenarioExecution = class {
   state;
   eventSubject = new Subject();
@@ -479,8 +489,8 @@ var ScenarioExecution = class {
       description: config.description,
       agents: config.agents,
       script,
-      verbose: config.verbose ?? false,
-      maxTurns: config.maxTurns ?? 10,
+      verbose: config.verbose ?? DEFAULT_VERBOSE,
+      maxTurns: config.maxTurns ?? DEFAULT_MAX_TURNS,
       threadId: config.threadId ?? generateThreadId(),
       setId: config.setId
     };
@@ -532,12 +542,14 @@ var ScenarioExecution = class {
         }
       }
       this.emitRunFinished({ scenarioRunId, status: "FAILED" /* FAILED */ });
-      return this.reachedMaxTurns([
-        "Reached end of script without conclusion, add one of the following to the end of the script:",
-        "- `Scenario.proceed()` to let the simulation continue to play out",
-        "- `Scenario.judge()` to force criteria judgement",
-        "- `Scenario.succeed()` or `Scenario.fail()` to end the test with an explicit result"
-      ].join("\n"));
+      return this.reachedMaxTurns(
+        [
+          "Reached end of script without conclusion, add one of the following to the end of the script:",
+          "- `Scenario.proceed()` to let the simulation continue to play out",
+          "- `Scenario.judge()` to force criteria judgement",
+          "- `Scenario.succeed()` or `Scenario.fail()` to end the test with an explicit result"
+        ].join("\n")
+      );
     } catch (error) {
       const errorResult = {
         success: false,
@@ -672,8 +684,7 @@ var ScenarioExecution = class {
     while (true) {
       const goToNextTurn = turns === void 0 || initialTurn === null || this.state.currentTurn != null && this.state.currentTurn + 1 < initialTurn + turns;
       const nextMessage = await this._step(goToNextTurn, onTurn);
-      if (initialTurn === null)
-        initialTurn = this.state.currentTurn;
+      if (initialTurn === null) initialTurn = this.state.currentTurn;
       if (nextMessage === null) {
         return null;
       }
@@ -759,7 +770,10 @@ var ScenarioExecution = class {
     agent2 = nextAgent.agent;
     this.removePendingAgent(agent2);
     if (content) {
-      const message2 = typeof content === "string" ? { role: role === "User" /* USER */ ? "user" : "assistant", content } : content;
+      const message2 = typeof content === "string" ? {
+        role: role === "User" /* USER */ ? "user" : "assistant",
+        content
+      } : content;
       this.state.addMessage(message2);
       this.broadcastMessage(message2, index);
       return null;
@@ -832,7 +846,9 @@ var ScenarioExecution = class {
   reachedMaxTurns(errorMessage) {
     var _a;
     const agentRoleAgentsIdx = this.agents.map((agent2, i) => ({ agent: agent2, idx: i })).filter(({ agent: agent2 }) => agent2.role === "Agent" /* AGENT */).map(({ idx }) => idx);
-    const agentTimes = agentRoleAgentsIdx.map((i) => this.agentTimes.get(i) || 0);
+    const agentTimes = agentRoleAgentsIdx.map(
+      (i) => this.agentTimes.get(i) || 0
+    );
     const totalAgentTime = agentTimes.reduce((sum, time) => sum + time, 0);
     return {
       success: false,
@@ -861,7 +877,7 @@ var ScenarioExecution = class {
       type: "placeholder",
       // This will be replaced by the specific event type
       timestamp: Date.now(),
-      batchRunId,
+      batchRunId: getBatchRunId(),
       scenarioId: this.config.id,
       scenarioRunId,
       scenarioSetId: this.config.setId
@@ -934,10 +950,8 @@ var ScenarioExecution = class {
 function convertAgentReturnTypesToMessages(response, role) {
   if (typeof response === "string")
     return [{ role, content: response }];
-  if (Array.isArray(response))
-    return response;
-  if (typeof response === "object" && "role" in response)
-    return [response];
+  if (Array.isArray(response)) return response;
+  if (typeof response === "object" && "role" in response) return [response];
   return [];
 }
 
@@ -1087,7 +1101,9 @@ var index_default = scenario;
 export {
   AgentAdapter,
   AgentRole,
+  DEFAULT_MAX_TURNS,
   DEFAULT_TEMPERATURE,
+  DEFAULT_VERBOSE,
   JudgeAgentAdapter,
   ScenarioExecution,
   ScenarioExecutionState,

package/dist/integrations/vitest/config.d.mts

@@ -0,0 +1,5 @@
+import { ViteUserConfig } from 'vitest/config';
+
+declare function withScenario(config: ViteUserConfig): ViteUserConfig;
+
+export { withScenario };

package/dist/integrations/vitest/config.d.ts

@@ -0,0 +1,5 @@
+import { ViteUserConfig } from 'vitest/config';
+
+declare function withScenario(config: ViteUserConfig): ViteUserConfig;
+
+export { withScenario };