@langwatch/scenario 0.2.9 → 0.2.12

package/README.md

@@ -2,7 +2,6 @@
 
 ![scenario](https://github.com/langwatch/scenario/raw/refs/heads/main/assets/scenario-wide.webp)
 
-
 [![npm version](https://badge.fury.io/js/%40langwatch%2Fscenario.svg)](https://badge.fury.io/js/%40langwatch%2Fscenario)
 
 A powerful TypeScript library for testing AI agents in realistic, scripted scenarios.
@@ -89,7 +88,8 @@ describe("Weather Agent", () => {
       parameters: z.object({
         city: z.string().describe("The city to get the weather for."),
       }),
-      execute: async ({ city }) => `The weather in ${city} is cloudy with a temperature of 24°C.`,
+      execute: async ({ city }) =>
+        `The weather in ${city} is cloudy with a temperature of 24°C.`,
     });
 
     // 2. Create an adapter for your agent
@@ -119,7 +119,8 @@ describe("Weather Agent", () => {
     // 3. Define and run your scenario
     const result = await scenario.run({
       name: "Checking the weather",
-      description: "The user asks for the weather in a specific city, and the agent should use the weather tool to find it.",
+      description:
+        "The user asks for the weather in a specific city, and the agent should use the weather tool to find it.",
       agents: [
         weatherAgent,
         scenario.userSimulatorAgent({ model: openai("gpt-4.1") }),
@@ -254,10 +255,7 @@ const result = await scenario.run({
   name: "my first scenario",
   description: "A simple test to see if the agent responds.",
   setId: "my-test-suite", // Group this scenario into a set
-  agents: [
-    myAgent,
-    scenario.userSimulatorAgent(),
-  ],
+  agents: [myAgent, scenario.userSimulatorAgent()],
 });
 ```
 
@@ -266,28 +264,64 @@ This will group all scenarios with the same `setId` together in the LangWatch UI
 - The `setupFiles` entry enables Scenario's event logging for each test.
 - The custom `VitestReporter` provides detailed scenario test reports in your test output.
 
-
 ## Vitest Integration
 
-To get rich scenario reporting and logging with Vitest, add the Scenario custom reporter and setup file to your `vitest.config.ts`:
+Scenario provides a convenient helper function to enhance your Vitest configuration with all the necessary setup files.
+
+### Using the withScenario Helper (Recommended)
+
+```typescript
+// vitest.config.ts
+import { defineConfig } from "vitest/config";
+import { withScenario } from "@langwatch/scenario/integrations/vitest/config";
+import VitestReporter from "@langwatch/scenario/integrations/vitest/reporter";
+
+export default withScenario(
+  defineConfig({
+    test: {
+      testTimeout: 180000, // 3 minutes, or however long you want to wait for the scenario to run
+      // Your existing setup files will be preserved and run after Scenario's setup
+      setupFiles: ["./my-custom-setup.ts"],
+      // Your existing global setup files will be preserved and run after Scenario's global setup
+      globalSetup: ["./my-global-setup.ts"],
+      // Optional: Add the Scenario reporter for detailed test reports
+      reporters: ["default", new VitestReporter()],
+    },
+  })
+);
+```
+
+The `withScenario` helper automatically:
+
+- Adds Scenario's setup files for event logging
+- Adds Scenario's global setup files
+- Preserves any existing setup configuration you have
+- Handles both string and array configurations for setup files
+
+### Manual Configuration
+
+If you prefer to configure Vitest manually, you can add the Scenario setup files directly:
 
 ```typescript
 // vitest.config.ts
 import { defineConfig } from "vitest/config";
-import VitestReporter from '@langwatch/scenario/integrations/vitest/reporter';
+import VitestReporter from "@langwatch/scenario/integrations/vitest/reporter";
 
 export default defineConfig({
   test: {
     testTimeout: 180000, // 3 minutes, or however long you want to wait for the scenario to run
-    setupFiles: ['@langwatch/scenario/integrations/vitest/setup'],
-    reporters: [
-      'default',
-      new VitestReporter(),
-    ],
+    setupFiles: ["@langwatch/scenario/integrations/vitest/setup"],
+    // Optional: Add the Scenario reporter for detailed test reports
+    reporters: ["default", new VitestReporter()],
   },
 });
 ```
 
+This configuration:
+
+- The `setupFiles` entry enables Scenario's event logging for each test
+- The custom `VitestReporter` provides detailed scenario test reports in your test output (optional)
+
 ## Development
 
 This project uses `pnpm` for package management.
@@ -314,6 +348,7 @@ MIT
 When running scenario tests, you can set the `SCENARIO_BATCH_RUN_ID` environment variable to uniquely identify a batch of test runs. This is especially useful for grouping results in reporting tools and CI pipelines.
 
 Example:
+
 ```bash
 SCENARIO_BATCH_RUN_ID=my-ci-run-123 pnpm test
 ```

package/dist/{chunk-7H6OGEQ5.mjs → chunk-7HLDX5EL.mjs}

@@ -1,7 +1,7 @@
 import {
   Logger,
-  env
-} from "./chunk-YPJZSK4J.mjs";
+  getEnv
+} from "./chunk-OL4RFXV4.mjs";
 import {
   __export
 } from "./chunk-7P6ASYW6.mjs";
@@ -27,24 +27,19 @@ var AgentRole = /* @__PURE__ */ ((AgentRole2) => {
   AgentRole2["JUDGE"] = "Judge";
   return AgentRole2;
 })(AgentRole || {});
-var allAgentRoles = ["User" /* USER */, "Agent" /* AGENT */, "Judge" /* JUDGE */];
+var allAgentRoles = [
+  "User" /* USER */,
+  "Agent" /* AGENT */,
+  "Judge" /* JUDGE */
+];
 var AgentAdapter = class {
   role = "Agent" /* AGENT */;
-  constructor(input) {
-    void input;
-  }
 };
 var UserSimulatorAgentAdapter = class {
   role = "User" /* USER */;
-  constructor(input) {
-    void input;
-  }
 };
 var JudgeAgentAdapter = class {
   role = "Judge" /* JUDGE */;
-  constructor(input) {
-    void input;
-  }
 };
 
 // src/domain/scenarios/index.ts
@@ -157,7 +152,6 @@ function getBatchRunId() {
     return batchRunId;
   }
   if (process2.env.SCENARIO_BATCH_RUN_ID) {
-    console.log("process.env.SCENARIO_BATCH_RUN_ID", process2.env.SCENARIO_BATCH_RUN_ID);
     return batchRunId = process2.env.SCENARIO_BATCH_RUN_ID;
   }
   if (process2.env.VITEST_WORKER_ID || process2.env.JEST_WORKER_ID) {
@@ -211,10 +205,11 @@ var EventAlertMessageLogger = class _EventAlertMessageLogger {
     this.displayWatchMessage(params);
   }
   isGreetingDisabled() {
-    return env.SCENARIO_DISABLE_SIMULATION_REPORT_INFO === true;
+    return getEnv().SCENARIO_DISABLE_SIMULATION_REPORT_INFO === true;
   }
   displayGreeting() {
     const separator = "\u2500".repeat(60);
+    const env = getEnv();
     if (!env.LANGWATCH_API_KEY) {
       console.log(`
 ${separator}`);

package/dist/{chunk-YPJZSK4J.mjs → chunk-OL4RFXV4.mjs}

@@ -9,6 +9,7 @@ var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
   LogLevel2["DEBUG"] = "DEBUG";
   return LogLevel2;
 })(LogLevel || {});
+var LOG_LEVELS = Object.values(LogLevel);
 
 // src/config/env.ts
 var envSchema = z.object({
@@ -21,7 +22,7 @@ var envSchema = z.object({
    * LangWatch endpoint URL for event reporting.
    * Defaults to the production LangWatch endpoint.
    */
-  LANGWATCH_ENDPOINT: z.string().url().default("https://app.langwatch.ai"),
+  LANGWATCH_ENDPOINT: z.string().url().optional().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.
@@ -33,17 +34,19 @@ var envSchema = z.object({
    */
   NODE_ENV: z.enum(["development", "production", "test"]).default("development"),
   /**
-   * Log level for the scenario package.
+   * Case-insensitive log level for the scenario package.
    * Defaults to 'info' if not specified.
    */
-  LOG_LEVEL: z.nativeEnum(LogLevel).optional(),
+  LOG_LEVEL: z.string().toUpperCase().pipe(z.nativeEnum(LogLevel)).optional().default("INFO" /* INFO */),
   /**
    * Scenario batch run ID.
    * If not provided, a random ID will be generated.
    */
   SCENARIO_BATCH_RUN_ID: z.string().optional()
 });
-var env = envSchema.parse(process.env);
+function getEnv() {
+  return envSchema.parse(process.env);
+}
 
 // src/utils/logger.ts
 var Logger = class _Logger {
@@ -56,18 +59,27 @@ var Logger = class _Logger {
   static create(context) {
     return new _Logger(context);
   }
-  getLogLevel() {
-    return env.LOG_LEVEL ?? "INFO" /* INFO */;
+  /**
+   * Returns the current log level from environment.
+   * Uses a getter for clarity and idiomatic usage.
+   */
+  get LOG_LEVEL() {
+    return getEnv().LOG_LEVEL;
   }
-  getLogLevelIndex(level) {
-    return Object.values(LogLevel).indexOf(level);
+  /**
+   * Returns the index of the given log level in the LOG_LEVELS array.
+   * @param level - The log level to get the index for.
+   * @returns The index of the log level in the LOG_LEVELS array.
+   */
+  getLogLevelIndexFor(level) {
+    return LOG_LEVELS.indexOf(level);
   }
   /**
    * Checks if logging should occur based on LOG_LEVEL env var
    */
   shouldLog(level) {
-    const currentLevelIndex = this.getLogLevelIndex(this.getLogLevel());
-    const requestedLevelIndex = this.getLogLevelIndex(level);
+    const currentLevelIndex = this.getLogLevelIndexFor(this.LOG_LEVEL);
+    const requestedLevelIndex = this.getLogLevelIndexFor(level);
     return currentLevelIndex >= 0 && requestedLevelIndex <= currentLevelIndex;
   }
   formatMessage(message) {
@@ -116,6 +128,6 @@ var Logger = class _Logger {
 };
 
 export {
-  env,
+  getEnv,
   Logger
 };