playwright-api-logger 1.0.0 → 2.1.0

package/README.md

@@ -21,45 +21,45 @@
 ## How It Works
 
 ```mermaid
-flowchart TD
+flowchart LR
     subgraph T[Playwright Test]
         F[Fixture setup]
-        C[API Call (GET / POST)]
+        C[API Call GET/POST/PUT/DELETE]
     end
 
-    subgraph L[Logging & API layer]
-        AL[ApiLogger (per test)]
-        B[BaseApi Controller]
-        CG[Curl Generator]
+    subgraph P[playwright-api-logger]
+        W["withApiLogging(request, testInfo)"]
+        PR[Proxy over APIRequestContext]
+        AL[ApiLogger]
+        CG[CurlGenerator]
     end
 
-    subgraph FS[File system]
-        LOG[logs/TEST_*.log { request, response, curl, duration }]
+    subgraph O[Output]
+        LOG["logs/TEST_*.log<br/>request, response, curl, duration"]
         RC[Ready-to-use curl for Postman / terminal]
     end
 
-    %% test flow
-    F --> AL
-    C --> B
-
-    %% logging interaction
-    B --> AL
+    F -->|"1 line change"| W
+    W --> PR
+    C --> PR
+    PR --> AL
     AL --> LOG
-
-    %% curl generation
-    B --> CG
+    AL --> CG
     CG --> RC
 ```
 
-`API_LOGS=true`  → **Logging ON**  (files created in `logs/`)  
-`API_LOGS=false` → **Logging OFF** (zero overhead, default)
+```
+API_LOGS=true  → Logging ON   (files created in logs/)
+API_LOGS=false → Logging OFF  (zero overhead, default)
+```
 
 ## Features
 
-- **Full Logging** — method, URL, headers, request/response body, status, timing
+- **One-line integration** — just wrap `request` with `withApiLogging()`, zero changes to controllers/clients
+- **Structured logs** — one JSON document per test with `preconditions`, `steps`, and `teardown` sections
+- **Step descriptions** — describe what each API call does with `.describe()`
 - **Curl Export** — copy from log, paste into terminal or import into Postman
 - **Env Control** — `API_LOGS=true/false` (default: `false`, zero overhead when off)
-- **Context Tracking** — setup / test / teardown phases
 - **Token Masking** — Authorization headers are automatically masked
 - **Form Data** — JSON, URL-encoded, and multipart/form-data support
 - **Error Resilient** — logging never breaks your tests
@@ -72,58 +72,46 @@ npm install playwright-api-logger
 
 ## Quick Start
 
-### Step 1. Add logger to your fixture
+### One line in your fixture — that's it!
 
 ```typescript
-import { createApiLogger } from 'playwright-api-logger';
+import { withApiLogging } from 'playwright-api-logger';
 
 export const test = base.extend({
   apiClient: async ({ request }, use, testInfo) => {
-    const apiClient = new ApiClient(request);
-
-    if (process.env.API_LOGS === 'true') {
-      const logger = createApiLogger(testInfo.title, 'test');
-      apiClient.setApiLogger(logger);
-      await use(apiClient);
-      logger.finalize(testInfo.status === 'passed' ? 'PASSED' : 'FAILED');
-    } else {
-      await use(apiClient);
-    }
+    const loggedRequest = withApiLogging(request, testInfo);
+    const apiClient = new ApiClient(loggedRequest);
+    await use(apiClient);
+    loggedRequest.__logger.finalize(
+      testInfo.status === 'passed' ? 'PASSED' : 'FAILED'
+    );
   },
 });
 ```
 
-### Step 2. Add logging to your base API controller
-
-```typescript
-import { ApiLogger } from 'playwright-api-logger';
-
-class BaseApiController {
-  protected apiLogger: ApiLogger | null = null;
-
-  setApiLogger(logger: ApiLogger): void {
-    this.apiLogger = logger;
-  }
+No changes to your controllers, clients, or test files.
 
-  async get(url: string, headers?: Record<string, string>) {
-    const startTime = Date.now();
-    const response = await this.request.get(url, { headers });
-    const duration = Date.now() - startTime;
-
-    if (this.apiLogger?.isEnabled()) {
-      const body = await response.json().catch(() => response.text());
-      this.apiLogger.logApiCall(
-        'GET', url, headers, undefined,
-        response.status(), undefined, body, duration
-      );
-    }
+### With preconditions and step descriptions
 
-    return response;
-  }
-}
+```typescript
+test('GET Without token (401)', async ({ apiClient, request }) => {
+  const loggedRequest = (request as any).__logger as ApiLogger;
+
+  // Mark following calls as preconditions
+  loggedRequest.startPreconditions();
+  loggedRequest.describe('Get employee ID for test');
+  const employees = await apiClient.getEmployees({ page: 1, size: 1 });
+  const employeeId = employees.items[0].id;
+
+  // Switch to test steps
+  loggedRequest.startTest();
+  loggedRequest.describe('Get children without auth token');
+  const response = await apiClient.getChildrenWithoutAuth(employeeId);
+  expect(response.status).toBe(401);
+});
 ```
 
-### Step 3. Enable via environment variable
+### Enable via environment variable
 
 ```bash
 # .env
@@ -137,56 +125,93 @@ API_LOGS=true npx playwright test
 
 ## Log Output
 
-Logs are saved to `logs/` directory:
+One structured JSON document per test:
 
 ```
 logs/
-  TEST_my-test-name_2026-03-16T12-00-00.log
-  SETUP_auth-setup_2026-03-16T12-00-00.log
-  TEARDOWN_cleanup_2026-03-16T12-00-00.log
+  get-without-token-401_2026-03-16T18-33-03.log
+  create-employee_2026-03-16T18-35-10.log
 ```
 
-Each log entry is a JSON object:
+### Example log:
 
 ```json
 {
-  "timestamp": "2026-03-16T12:00:00.000Z",
-  "testName": "my-test-name",
-  "context": "test",
-  "request": {
-    "method": "POST",
-    "url": "https://api.example.com/users",
-    "headers": { "Content-Type": "application/json" },
-    "body": { "name": "John" }
-  },
-  "response": {
-    "status": 201,
-    "body": { "id": 1, "name": "John" }
+  "test": {
+    "name": "GET Without token (401)",
+    "file": "tests/api/employees/children.spec.ts",
+    "startedAt": "2026-03-16T18:33:03.654Z",
+    "finishedAt": "2026-03-16T18:33:04.300Z",
+    "duration": 646,
+    "result": "PASSED"
   },
-  "duration": 150,
-  "curl": "curl -X POST 'https://api.example.com/users' -H 'Content-Type: application/json' --data '{\"name\":\"John\"}'"
+  "preconditions": [
+    {
+      "step": 1,
+      "description": "Get employee ID for test",
+      "timestamp": "2026-03-16T18:33:04.174Z",
+      "request": {
+        "method": "GET",
+        "url": "https://api.example.com/employees?page=1&size=1"
+      },
+      "response": {
+        "status": 200,
+        "body": { "items": [{ "id": "abc-123" }], "total": 27 }
+      },
+      "duration": 501,
+      "curl": "curl -X GET 'https://api.example.com/employees?page=1&size=1' -H 'Accept: application/json'"
+    }
+  ],
+  "steps": [
+    {
+      "step": 1,
+      "description": "Get children without auth token",
+      "timestamp": "2026-03-16T18:33:04.242Z",
+      "request": {
+        "method": "GET",
+        "url": "https://api.example.com/employees/abc-123/children"
+      },
+      "response": {
+        "status": 401,
+        "body": { "detail": "Not authenticated" }
+      },
+      "duration": 67,
+      "curl": "curl -X GET 'https://api.example.com/employees/abc-123/children'"
+    }
+  ],
+  "teardown": [],
+  "summary": {
+    "totalRequests": 2,
+    "preconditions": 1,
+    "testSteps": 1,
+    "teardown": 0,
+    "totalDuration": 568
+  }
 }
 ```
 
 ## API Reference
 
-### Factory Functions
+### `withApiLogging(request, testInfoOrOptions?)` ⭐
 
-| Function | Description |
-|----------|-------------|
-| `createApiLogger(testName, context?)` | Create logger (context default: `'test'`) |
-| `createSetupLogger(testName)` | Create logger with `'setup'` context |
-| `createTeardownLogger(testName)` | Create logger with `'teardown'` context |
+Main integration point. Wraps `APIRequestContext` with a Proxy that logs all HTTP calls.
 
-### `ApiLogger`
+```typescript
+const loggedRequest = withApiLogging(request, testInfo);
+loggedRequest.__logger // access the ApiLogger instance
+```
+
+### `ApiLogger` — context & description
 
 | Method | Description |
 |--------|-------------|
-| `logApiCall(method, url, reqHeaders, reqBody, status, resHeaders, resBody, duration)` | Log complete request + response |
-| `logRequest(method, url, headers?, body?)` | Log request (pair with `logResponse`) |
-| `logResponse(status, headers?, body?)` | Log response (pair with `logRequest`) |
+| `describe(text)` | Set description for the **next** API call |
+| `startPreconditions()` | Following calls → `preconditions` section |
+| `startTest()` | Following calls → `steps` section |
+| `startTeardown()` | Following calls → `teardown` section |
+| `setContext(ctx)` | Set context directly (`'preconditions'` / `'test'` / `'teardown'`) |
+| `finalize(result, info?)` | Write structured JSON document to file |
 | `isEnabled()` | Check if logging is active |
-| `finalize(result, additionalInfo?)` | Write test result (`PASSED` / `FAILED` / `SKIPPED`) |
 | `getLogFilePath()` | Get current log file path |
 
 ### `CurlGenerator`
@@ -201,16 +226,31 @@ Each log entry is a JSON object:
 |-------------|---------|-------------|
 | `API_LOGS` | `false` | Set to `'true'` to enable logging |
 
+### `ApiLoggingOptions`
+
 ```typescript
-// LoggerConfig
 {
   testName?: string;        // Test name (default: 'unknown-test')
-  context?: LogContext;      // 'setup' | 'test' | 'teardown'
+  testFile?: string;        // Test file path
+  context?: LogContext;      // 'preconditions' | 'test' | 'teardown'
   logDirectory?: string;     // Custom log dir (default: 'logs/')
   maskAuthTokens?: boolean;  // Mask auth headers (default: true)
+  logger?: ApiLogger;        // Share logger across phases
 }
 ```
 
+## Migration from v1 → v2
+
+```diff
+- // v1: manual logger setup in controllers and clients
+- const logger = createApiLogger(testInfo.title);
+- apiClient.setApiLogger(logger);
+
++ // v2: one line, structured logs with sections
++ const loggedRequest = withApiLogging(request, testInfo);
++ const apiClient = new ApiClient(loggedRequest);
+```
+
 ## License
 
 MIT

package/dist/ApiLogger.d.ts

@@ -1,74 +1,83 @@
 /**
  * API Logger for capturing and logging HTTP requests/responses
+ * Produces a single structured test document with preconditions, steps, and teardown sections.
+ *
  * Features:
- * - Comprehensive request/response logging
+ * - Structured test document (one JSON per test)
+ * - Preconditions / Steps / Teardown sections
+ * - Step descriptions and numbering
  * - Curl command generation for manual testing
  * - Environment-based enable/disable via API_LOGS
- * - Automatic file logging with JSON format
- * - Test context tracking (setup/test/teardown)
+ * - Test context tracking and switching
  */
 import { LogContext, LoggerConfig } from './types';
 export declare class ApiLogger {
     private enabled;
     private testName;
-    private context;
+    private testFile?;
+    private currentContext;
     private logDirectory;
     private logFilePath;
     private maskAuthTokens;
-    private currentRequest;
-    private requestStartTime;
+    private startedAt;
+    private preconditions;
+    private steps;
+    private teardownSteps;
+    private nextDescription?;
     constructor(config?: LoggerConfig);
-    /**
-     * Get default log directory path
-     */
     private getDefaultLogDirectory;
-    /**
-     * Initialize log file and directory
-     */
     private initializeLogFile;
     /**
-     * Log an API call with request and response
+     * Set description for the next API call
+     * @example
+     * logger.describe('Get employee ID for testing');
+     * await apiClient.getEmployees(); // this call gets the description
      */
-    logApiCall(method: string, url: string, requestHeaders: Record<string, string | string[]> | undefined, requestBody: any, status: number, responseHeaders: Record<string, string> | undefined, responseBody: any, duration: number): void;
+    describe(description: string): void;
     /**
-     * Log just the request part (when response isn't available yet)
+     * Switch current context (preconditions → test → teardown)
+     * All subsequent API calls will be logged to the new context section
      */
-    logRequest(method: string, url: string, headers?: Record<string, string | string[]>, body?: any): void;
+    setContext(context: LogContext): void;
     /**
-     * Log just the response part (pairs with logRequest)
+     * Shortcut: switch to preconditions context
      */
-    logResponse(status: number, headers?: Record<string, string>, body?: any): void;
+    startPreconditions(): void;
     /**
-     * Write log entry to file
+     * Shortcut: switch to test steps context
      */
-    private writeLogEntry;
+    startTest(): void;
     /**
-     * Generate ISO timestamp for filenames
+     * Shortcut: switch to teardown context
      */
-    private generateTimestamp;
+    startTeardown(): void;
     /**
-     * Sanitize test name for use in filename
+     * Log an API call with request and response
      */
-    private sanitizeTestName;
+    logApiCall(method: string, url: string, requestHeaders: Record<string, string | string[]> | undefined, requestBody: any, status: number, responseHeaders: Record<string, string> | undefined, responseBody: any, duration: number): void;
     /**
-     * Get the current log file path
+     * Get the target array for current context
      */
-    getLogFilePath(): string | null;
+    private getTargetArray;
     /**
-     * Check if logger is enabled
+     * Finalize and write the structured test document to file
      */
-    isEnabled(): boolean;
+    finalize(result: 'PASSED' | 'FAILED' | 'SKIPPED', additionalInfo?: Record<string, any>): void;
     /**
-     * Finalize logging for test completion
+     * Write structured document to file
      */
-    finalize(result: 'PASSED' | 'FAILED' | 'SKIPPED', additionalInfo?: Record<string, any>): void;
+    private writeDocument;
+    private generateTimestamp;
+    private sanitizeTestName;
+    getLogFilePath(): string | null;
+    isEnabled(): boolean;
 }
 /**
  * Factory function for creating test-context loggers
  */
 export declare function createApiLogger(testName: string, context?: LogContext): ApiLogger;
 /**
- * Factory for setup context
+ * Factory for setup/preconditions context
  */
 export declare function createSetupLogger(testName: string): ApiLogger;
 /**

package/dist/ApiLogger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiLogger.d.ts","sourceRoot":"","sources":["../src/ApiLogger.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAKH,OAAO,EACL,UAAU,EACV,YAAY,EAIb,MAAM,SAAS,CAAC;AAEjB,qBAAa,SAAS;IACpB,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,OAAO,CAAa;IAC5B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,WAAW,CAAuB;IAC1C,OAAO,CAAC,cAAc,CAAU;IAChC,OAAO,CAAC,cAAc,CAA+B;IACrD,OAAO,CAAC,gBAAgB,CAAuB;gBAEnC,MAAM,GAAE,YAAiB;IAcrC;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAI9B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAoBzB;;OAEG;IACH,UAAU,CACR,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,SAAS,EAC7D,WAAW,EAAE,GAAG,EAChB,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,EACnD,YAAY,EAAE,GAAG,EACjB,QAAQ,EAAE,MAAM,GACf,IAAI;IAmDP;;OAEG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI;IAStG;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI;IAsB/E;;OAEG;IACH,OAAO,CAAC,aAAa;IAarB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IASzB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IASxB;;OAEG;IACH,cAAc,IAAI,MAAM,GAAG,IAAI;IAI/B;;OAEG;IACH,SAAS,IAAI,OAAO;IAIpB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI;CAuB9F;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,UAAmB,GAAG,SAAS,CAEzF;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAE7D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAEhE"}
+{"version":3,"file":"ApiLogger.d.ts","sourceRoot":"","sources":["../src/ApiLogger.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAKH,OAAO,EACL,UAAU,EACV,YAAY,EAKb,MAAM,SAAS,CAAC;AAEjB,qBAAa,SAAS;IACpB,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,QAAQ,CAAC,CAAS;IAC1B,OAAO,CAAC,cAAc,CAAa;IACnC,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,WAAW,CAAuB;IAC1C,OAAO,CAAC,cAAc,CAAU;IAChC,OAAO,CAAC,SAAS,CAAS;IAG1B,OAAO,CAAC,aAAa,CAAsB;IAC3C,OAAO,CAAC,KAAK,CAAsB;IACnC,OAAO,CAAC,aAAa,CAAsB;IAG3C,OAAO,CAAC,eAAe,CAAC,CAAS;gBAErB,MAAM,GAAE,YAAiB;IAerC,OAAO,CAAC,sBAAsB;IAI9B,OAAO,CAAC,iBAAiB;IAgBzB;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAInC;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,UAAU,GAAG,IAAI;IAIrC;;OAEG;IACH,kBAAkB,IAAI,IAAI;IAI1B;;OAEG;IACH,SAAS,IAAI,IAAI;IAIjB;;OAEG;IACH,aAAa,IAAI,IAAI;IAIrB;;OAEG;IACH,UAAU,CACR,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,SAAS,EAC7D,WAAW,EAAE,GAAG,EAChB,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,EACnD,YAAY,EAAE,GAAG,EACjB,QAAQ,EAAE,MAAM,GACf,IAAI;IAuDP;;OAEG;IACH,OAAO,CAAC,cAAc;IAYtB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI;IAyC7F;;OAEG;IACH,OAAO,CAAC,aAAa;IAWrB,OAAO,CAAC,iBAAiB;IAOzB,OAAO,CAAC,gBAAgB;IASxB,cAAc,IAAI,MAAM,GAAG,IAAI;IAI/B,SAAS,IAAI,OAAO;CAGrB;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,UAAmB,GAAG,SAAS,CAEzF;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAE7D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAEhE"}

package/dist/ApiLogger.js

@@ -1,12 +1,15 @@
 "use strict";
 /**
  * API Logger for capturing and logging HTTP requests/responses
+ * Produces a single structured test document with preconditions, steps, and teardown sections.
+ *
  * Features:
- * - Comprehensive request/response logging
+ * - Structured test document (one JSON per test)
+ * - Preconditions / Steps / Teardown sections
+ * - Step descriptions and numbering
  * - Curl command generation for manual testing
  * - Environment-based enable/disable via API_LOGS
- * - Automatic file logging with JSON format
- * - Test context tracking (setup/test/teardown)
+ * - Test context tracking and switching
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
@@ -22,27 +25,24 @@ const CurlGenerator_1 = require("./CurlGenerator");
 class ApiLogger {
     constructor(config = {}) {
         this.logFilePath = null;
-        this.currentRequest = null;
-        this.requestStartTime = null;
-        // Check if logging is enabled via environment variable
+        // Structured storage
+        this.preconditions = [];
+        this.steps = [];
+        this.teardownSteps = [];
         this.enabled = process.env.API_LOGS === 'true';
         this.testName = config.testName || 'unknown-test';
-        this.context = config.context || 'test';
+        this.testFile = config.testFile;
+        this.currentContext = config.context || 'test';
         this.logDirectory = config.logDirectory || this.getDefaultLogDirectory();
         this.maskAuthTokens = config.maskAuthTokens ?? true;
+        this.startedAt = new Date().toISOString();
         if (this.enabled) {
             this.initializeLogFile();
         }
     }
-    /**
-     * Get default log directory path
-     */
     getDefaultLogDirectory() {
         return path_1.default.join(process.cwd(), 'logs');
     }
-    /**
-     * Initialize log file and directory
-     */
     initializeLogFile() {
         try {
             if (!fs_1.default.existsSync(this.logDirectory)) {
@@ -50,17 +50,48 @@ class ApiLogger {
             }
             const timestamp = this.generateTimestamp();
             const sanitizedTestName = this.sanitizeTestName(this.testName);
-            const filename = `${this.context.toUpperCase()}_${sanitizedTestName}_${timestamp}.log`;
+            const filename = `${sanitizedTestName}_${timestamp}.log`;
             this.logFilePath = path_1.default.join(this.logDirectory, filename);
-            if (!fs_1.default.existsSync(this.logFilePath)) {
-                fs_1.default.writeFileSync(this.logFilePath, '');
-            }
         }
         catch (error) {
             console.warn('[ApiLogger] Failed to initialize log file:', error);
             this.logFilePath = null;
         }
     }
+    /**
+     * Set description for the next API call
+     * @example
+     * logger.describe('Get employee ID for testing');
+     * await apiClient.getEmployees(); // this call gets the description
+     */
+    describe(description) {
+        this.nextDescription = description;
+    }
+    /**
+     * Switch current context (preconditions → test → teardown)
+     * All subsequent API calls will be logged to the new context section
+     */
+    setContext(context) {
+        this.currentContext = context;
+    }
+    /**
+     * Shortcut: switch to preconditions context
+     */
+    startPreconditions() {
+        this.currentContext = 'preconditions';
+    }
+    /**
+     * Shortcut: switch to test steps context
+     */
+    startTest() {
+        this.currentContext = 'test';
+    }
+    /**
+     * Shortcut: switch to teardown context
+     */
+    startTeardown() {
+        this.currentContext = 'teardown';
+    }
     /**
      * Log an API call with request and response
      */
@@ -69,7 +100,6 @@ class ApiLogger {
             return;
         }
         try {
-            // Extract content type from headers
             let contentType;
             if (requestHeaders) {
                 for (const [key, value] of Object.entries(requestHeaders)) {
@@ -91,75 +121,101 @@ class ApiLogger {
                 headers: responseHeaders,
                 body: responseBody,
             };
-            // Generate curl command
             const curl = CurlGenerator_1.CurlGenerator.generate(requestData, this.maskAuthTokens);
-            // Create log entry
-            const logEntry = {
+            // Get target array and step number
+            const targetArray = this.getTargetArray();
+            const stepNumber = targetArray.length + 1;
+            const stepEntry = {
+                step: stepNumber,
+                description: this.nextDescription,
                 timestamp: new Date().toISOString(),
-                testName: this.testName,
-                context: this.context,
                 request: requestData,
                 response: responseData,
                 duration,
                 curl,
             };
-            this.writeLogEntry(logEntry);
+            // Clear description after use
+            this.nextDescription = undefined;
+            targetArray.push(stepEntry);
         }
         catch (error) {
             console.warn('[ApiLogger] Error logging API call:', error);
         }
     }
     /**
-     * Log just the request part (when response isn't available yet)
+     * Get the target array for current context
      */
-    logRequest(method, url, headers, body) {
-        if (!this.enabled) {
-            return;
+    getTargetArray() {
+        switch (this.currentContext) {
+            case 'preconditions':
+                return this.preconditions;
+            case 'teardown':
+                return this.teardownSteps;
+            case 'test':
+            default:
+                return this.steps;
         }
-        this.currentRequest = { method, url, headers, body };
-        this.requestStartTime = Date.now();
     }
     /**
-     * Log just the response part (pairs with logRequest)
+     * Finalize and write the structured test document to file
      */
-    logResponse(status, headers, body) {
-        if (!this.enabled || !this.currentRequest) {
+    finalize(result, additionalInfo) {
+        if (!this.enabled) {
             return;
         }
-        const duration = this.requestStartTime ? Date.now() - this.requestStartTime : 0;
-        this.logApiCall(this.currentRequest.method, this.currentRequest.url, this.currentRequest.headers, this.currentRequest.body, status, headers, body, duration);
-        this.currentRequest = null;
-        this.requestStartTime = null;
+        try {
+            const finishedAt = new Date().toISOString();
+            const startTime = new Date(this.startedAt).getTime();
+            const endTime = new Date(finishedAt).getTime();
+            // Calculate total API duration
+            const allSteps = [...this.preconditions, ...this.steps, ...this.teardownSteps];
+            const totalApiDuration = allSteps.reduce((sum, s) => sum + s.duration, 0);
+            const document = {
+                test: {
+                    name: this.testName,
+                    file: this.testFile || additionalInfo?.testFile,
+                    startedAt: this.startedAt,
+                    finishedAt,
+                    duration: endTime - startTime,
+                    result,
+                },
+                preconditions: this.preconditions,
+                steps: this.steps,
+                teardown: this.teardownSteps,
+                summary: {
+                    totalRequests: allSteps.length,
+                    preconditions: this.preconditions.length,
+                    testSteps: this.steps.length,
+                    teardown: this.teardownSteps.length,
+                    totalDuration: totalApiDuration,
+                },
+            };
+            this.writeDocument(document);
+        }
+        catch (error) {
+            console.warn('[ApiLogger] Error finalizing log:', error);
+        }
     }
     /**
-     * Write log entry to file
+     * Write structured document to file
      */
-    writeLogEntry(entry) {
+    writeDocument(document) {
         try {
             if (!this.logFilePath) {
                 return;
             }
-            const logLine = JSON.stringify(entry, null, 2);
-            fs_1.default.appendFileSync(this.logFilePath, logLine + '\n\n');
+            fs_1.default.writeFileSync(this.logFilePath, JSON.stringify(document, null, 2) + '\n');
         }
         catch (error) {
             console.warn('[ApiLogger] Failed to write log file:', error);
         }
     }
-    /**
-     * Generate ISO timestamp for filenames
-     */
     generateTimestamp() {
-        const now = new Date();
-        return now
+        return new Date()
             .toISOString()
             .replace(/[:.]/g, '-')
-            .replace('T', 'T')
             .split('.')[0];
     }
-    /**
-     * Sanitize test name for use in filename
-     */
     sanitizeTestName(name) {
         return name
             .toLowerCase()
@@ -168,43 +224,12 @@ class ApiLogger {
             .replace(/^-|-$/g, '')
             .substring(0, 80);
     }
-    /**
-     * Get the current log file path
-     */
     getLogFilePath() {
         return this.logFilePath;
     }
-    /**
-     * Check if logger is enabled
-     */
     isEnabled() {
         return this.enabled;
     }
-    /**
-     * Finalize logging for test completion
-     */
-    finalize(result, additionalInfo) {
-        if (!this.enabled) {
-            return;
-        }
-        try {
-            const finalizationEntry = {
-                timestamp: new Date().toISOString(),
-                step: 'TEST_FINALIZATION',
-                testName: this.testName,
-                context: this.context,
-                result,
-                logFilePath: this.logFilePath,
-                additionalInfo,
-            };
-            if (this.logFilePath) {
-                fs_1.default.appendFileSync(this.logFilePath, JSON.stringify(finalizationEntry, null, 2) + '\n\n');
-            }
-        }
-        catch (error) {
-            console.warn('[ApiLogger] Error finalizing log:', error);
-        }
-    }
 }
 exports.ApiLogger = ApiLogger;
 /**
@@ -214,10 +239,10 @@ function createApiLogger(testName, context = 'test') {
     return new ApiLogger({ testName, context });
 }
 /**
- * Factory for setup context
+ * Factory for setup/preconditions context
  */
 function createSetupLogger(testName) {
-    return new ApiLogger({ testName, context: 'setup' });
+    return new ApiLogger({ testName, context: 'preconditions' });
 }
 /**
  * Factory for teardown context

package/dist/ApiLogger.js.map

@@ -1 +1 @@
-{"version":3,"file":"ApiLogger.js","sourceRoot":"","sources":["../src/ApiLogger.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;;;;AA4PH,0CAEC;AAKD,8CAEC;AAKD,oDAEC;AA1QD,4CAAoB;AACpB,gDAAwB;AACxB,mDAAgD;AAShD,MAAa,SAAS;IAUpB,YAAY,SAAuB,EAAE;QAL7B,gBAAW,GAAkB,IAAI,CAAC;QAElC,mBAAc,GAA0B,IAAI,CAAC;QAC7C,qBAAgB,GAAkB,IAAI,CAAC;QAG7C,uDAAuD;QACvD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,CAAC;QAE/C,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,cAAc,CAAC;QAClD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;QACzE,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,IAAI,CAAC;QAEpD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;OAEG;IACK,sBAAsB;QAC5B,OAAO,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACK,iBAAiB;QACvB,IAAI,CAAC;YACH,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;gBACtC,YAAE,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACvD,CAAC;YAED,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3C,MAAM,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC/D,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,iBAAiB,IAAI,SAAS,MAAM,CAAC;YACvF,IAAI,CAAC,WAAW,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;YAE1D,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBACrC,YAAE,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE,KAAK,CAAC,CAAC;YAClE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;;OAEG;IACH,UAAU,CACR,MAAc,EACd,GAAW,EACX,cAA6D,EAC7D,WAAgB,EAChB,MAAc,EACd,eAAmD,EACnD,YAAiB,EACjB,QAAgB;QAEhB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,oCAAoC;YACpC,IAAI,WAA+B,CAAC;YACpC,IAAI,cAAc,EAAE,CAAC;gBACnB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;oBAC1D,IAAI,GAAG,CAAC,WAAW,EAAE,KAAK,cAAc,EAAE,CAAC;wBACzC,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;wBACtD,MAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;YAED,MAAM,WAAW,GAAmB;gBAClC,MAAM;gBACN,GAAG;gBACH,OAAO,EAAE,cAAc;gBACvB,IAAI,EAAE,WAAW;gBACjB,WAAW;aACZ,CAAC;YAEF,MAAM,YAAY,GAAoB;gBACpC,MAAM;gBACN,OAAO,EAAE,eAAe;gBACxB,IAAI,EAAE,YAAY;aACnB,CAAC;YAEF,wBAAwB;YACxB,MAAM,IAAI,GAAG,6BAAa,CAAC,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;YAEtE,mBAAmB;YACnB,MAAM,QAAQ,GAAa;gBACzB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACnC,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,OAAO,EAAE,WAAW;gBACpB,QAAQ,EAAE,YAAY;gBACtB,QAAQ;gBACR,IAAI;aACL,CAAC;YAEF,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAC/B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,KAAK,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,MAAc,EAAE,GAAW,EAAE,OAA2C,EAAE,IAAU;QAC7F,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,cAAc,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QACrD,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACrC,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAAc,EAAE,OAAgC,EAAE,IAAU;QACtE,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YAC1C,OAAO;QACT,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;QAEhF,IAAI,CAAC,UAAU,CACb,IAAI,CAAC,cAAc,CAAC,MAAM,EAC1B,IAAI,CAAC,cAAc,CAAC,GAAG,EACvB,IAAI,CAAC,cAAc,CAAC,OAAO,EAC3B,IAAI,CAAC,cAAc,CAAC,IAAI,EACxB,MAAM,EACN,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;QAEF,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC3B,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAC/B,CAAC;IAED;;OAEG;IACK,aAAa,CAAC,KAAe;QACnC,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;gBACtB,OAAO;YACT,CAAC;YAED,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAC/C,YAAE,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,GAAG,MAAM,CAAC,CAAC;QACxD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAED;;OAEG;IACK,iBAAiB;QACvB,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,OAAO,GAAG;aACP,WAAW,EAAE;aACb,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;aACrB,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC;aACjB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC;IAED;;OAEG;IACK,gBAAgB,CAAC,IAAY;QACnC,OAAO,IAAI;aACR,WAAW,EAAE;aACb,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;aAC3B,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;aACnB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;aACrB,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,MAAuC,EAAE,cAAoC;QACpF,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,MAAM,iBAAiB,GAAG;gBACxB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACnC,IAAI,EAAE,mBAAmB;gBACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,MAAM;gBACN,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,cAAc;aACf,CAAC;YAEF,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACrB,YAAE,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;YAC3F,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,mCAAmC,EAAE,KAAK,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;CACF;AA1OD,8BA0OC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,QAAgB,EAAE,UAAsB,MAAM;IAC5E,OAAO,IAAI,SAAS,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;AAC9C,CAAC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,QAAgB;IAChD,OAAO,IAAI,SAAS,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;AACvD,CAAC;AAED;;GAEG;AACH,SAAgB,oBAAoB,CAAC,QAAgB;IACnD,OAAO,IAAI,SAAS,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;AAC1D,CAAC"}
+{"version":3,"file":"ApiLogger.js","sourceRoot":"","sources":["../src/ApiLogger.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;AAkRH,0CAEC;AAKD,8CAEC;AAKD,oDAEC;AAhSD,4CAAoB;AACpB,gDAAwB;AACxB,mDAAgD;AAUhD,MAAa,SAAS;IAkBpB,YAAY,SAAuB,EAAE;QAZ7B,gBAAW,GAAkB,IAAI,CAAC;QAI1C,qBAAqB;QACb,kBAAa,GAAmB,EAAE,CAAC;QACnC,UAAK,GAAmB,EAAE,CAAC;QAC3B,kBAAa,GAAmB,EAAE,CAAC;QAMzC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,CAAC;QAE/C,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,cAAc,CAAC;QAClD,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAAC;QACzE,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,IAAI,CAAC;QACpD,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAE1C,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,CAAC;IACH,CAAC;IAEO,sBAAsB;QAC5B,OAAO,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;IAC1C,CAAC;IAEO,iBAAiB;QACvB,IAAI,CAAC;YACH,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;gBACtC,YAAE,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACvD,CAAC;YAED,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3C,MAAM,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC/D,MAAM,QAAQ,GAAG,GAAG,iBAAiB,IAAI,SAAS,MAAM,CAAC;YACzD,IAAI,CAAC,WAAW,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QAC5D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,4CAA4C,EAAE,KAAK,CAAC,CAAC;YAClE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,WAAmB;QAC1B,IAAI,CAAC,eAAe,GAAG,WAAW,CAAC;IACrC,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,OAAmB;QAC5B,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,IAAI,CAAC,cAAc,GAAG,eAAe,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,SAAS;QACP,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,aAAa;QACX,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,UAAU,CACR,MAAc,EACd,GAAW,EACX,cAA6D,EAC7D,WAAgB,EAChB,MAAc,EACd,eAAmD,EACnD,YAAiB,EACjB,QAAgB;QAEhB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,IAAI,WAA+B,CAAC;YACpC,IAAI,cAAc,EAAE,CAAC;gBACnB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;oBAC1D,IAAI,GAAG,CAAC,WAAW,EAAE,KAAK,cAAc,EAAE,CAAC;wBACzC,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;wBACtD,MAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;YAED,MAAM,WAAW,GAAmB;gBAClC,MAAM;gBACN,GAAG;gBACH,OAAO,EAAE,cAAc;gBACvB,IAAI,EAAE,WAAW;gBACjB,WAAW;aACZ,CAAC;YAEF,MAAM,YAAY,GAAoB;gBACpC,MAAM;gBACN,OAAO,EAAE,eAAe;gBACxB,IAAI,EAAE,YAAY;aACnB,CAAC;YAEF,MAAM,IAAI,GAAG,6BAAa,CAAC,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;YAEtE,mCAAmC;YACnC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;YAC1C,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;YAE1C,MAAM,SAAS,GAAiB;gBAC9B,IAAI,EAAE,UAAU;gBAChB,WAAW,EAAE,IAAI,CAAC,eAAe;gBACjC,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACnC,OAAO,EAAE,WAAW;gBACpB,QAAQ,EAAE,YAAY;gBACtB,QAAQ;gBACR,IAAI;aACL,CAAC;YAEF,8BAA8B;YAC9B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;YAEjC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,KAAK,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;IAED;;OAEG;IACK,cAAc;QACpB,QAAQ,IAAI,CAAC,cAAc,EAAE,CAAC;YAC5B,KAAK,eAAe;gBAClB,OAAO,IAAI,CAAC,aAAa,CAAC;YAC5B,KAAK,UAAU;gBACb,OAAO,IAAI,CAAC,aAAa,CAAC;YAC5B,KAAK,MAAM,CAAC;YACZ;gBACE,OAAO,IAAI,CAAC,KAAK,CAAC;QACtB,CAAC;IACH,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,MAAuC,EAAE,cAAoC;QACpF,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YAC5C,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;YACrD,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,CAAC;YAE/C,+BAA+B;YAC/B,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;YAC/E,MAAM,gBAAgB,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAE1E,MAAM,QAAQ,GAAoB;gBAChC,IAAI,EAAE;oBACJ,IAAI,EAAE,IAAI,CAAC,QAAQ;oBACnB,IAAI,EAAE,IAAI,CAAC,QAAQ,IAAI,cAAc,EAAE,QAAQ;oBAC/C,SAAS,EAAE,IAAI,CAAC,SAAS;oBACzB,UAAU;oBACV,QAAQ,EAAE,OAAO,GAAG,SAAS;oBAC7B,MAAM;iBACP;gBACD,aAAa,EAAE,IAAI,CAAC,aAAa;gBACjC,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,QAAQ,EAAE,IAAI,CAAC,aAAa;gBAC5B,OAAO,EAAE;oBACP,aAAa,EAAE,QAAQ,CAAC,MAAM;oBAC9B,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM;oBACxC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM;oBAC5B,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM;oBACnC,aAAa,EAAE,gBAAgB;iBAChC;aACF,CAAC;YAEF,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAC/B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,mCAAmC,EAAE,KAAK,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED;;OAEG;IACK,aAAa,CAAC,QAAyB;QAC7C,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;gBACtB,OAAO;YACT,CAAC;YACD,YAAE,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;QAC/E,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAEO,iBAAiB;QACvB,OAAO,IAAI,IAAI,EAAE;aACd,WAAW,EAAE;aACb,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;aACrB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC;IAEO,gBAAgB,CAAC,IAAY;QACnC,OAAO,IAAI;aACR,WAAW,EAAE;aACb,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;aAC3B,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;aACnB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;aACrB,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACtB,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AA/PD,8BA+PC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,QAAgB,EAAE,UAAsB,MAAM;IAC5E,OAAO,IAAI,SAAS,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;AAC9C,CAAC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,QAAgB;IAChD,OAAO,IAAI,SAAS,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;AAC/D,CAAC;AAED;;GAEG;AACH,SAAgB,oBAAoB,CAAC,QAAgB;IACnD,OAAO,IAAI,SAAS,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;AAC1D,CAAC"}

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 export { ApiLogger, createApiLogger, createSetupLogger, createTeardownLogger } from './ApiLogger';
 export { CurlGenerator } from './CurlGenerator';
-export type { LoggerConfig, RequestLogData, ResponseLogData, LogEntry, LogContext } from './types';
+export { withApiLogging } from './withApiLogging';
+export type { ApiLoggingOptions } from './withApiLogging';
+export type { LoggerConfig, RequestLogData, ResponseLogData, StepLogEntry, TestLogDocument, LogEntry, LogContext, } from './types';
 export type { RequestData } from './CurlGenerator';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAClG,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACnG,YAAY,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAClG,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,YAAY,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,YAAY,EACV,YAAY,EACZ,cAAc,EACd,eAAe,EACf,YAAY,EACZ,eAAe,EACf,QAAQ,EACR,UAAU,GACX,MAAM,SAAS,CAAC;AACjB,YAAY,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CurlGenerator = exports.createTeardownLogger = exports.createSetupLogger = exports.createApiLogger = exports.ApiLogger = void 0;
+exports.withApiLogging = exports.CurlGenerator = exports.createTeardownLogger = exports.createSetupLogger = exports.createApiLogger = exports.ApiLogger = void 0;
 var ApiLogger_1 = require("./ApiLogger");
 Object.defineProperty(exports, "ApiLogger", { enumerable: true, get: function () { return ApiLogger_1.ApiLogger; } });
 Object.defineProperty(exports, "createApiLogger", { enumerable: true, get: function () { return ApiLogger_1.createApiLogger; } });
@@ -8,4 +8,6 @@ Object.defineProperty(exports, "createSetupLogger", { enumerable: true, get: fun
 Object.defineProperty(exports, "createTeardownLogger", { enumerable: true, get: function () { return ApiLogger_1.createTeardownLogger; } });
 var CurlGenerator_1 = require("./CurlGenerator");
 Object.defineProperty(exports, "CurlGenerator", { enumerable: true, get: function () { return CurlGenerator_1.CurlGenerator; } });
+var withApiLogging_1 = require("./withApiLogging");
+Object.defineProperty(exports, "withApiLogging", { enumerable: true, get: function () { return withApiLogging_1.withApiLogging; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,yCAAkG;AAAzF,sGAAA,SAAS,OAAA;AAAE,4GAAA,eAAe,OAAA;AAAE,8GAAA,iBAAiB,OAAA;AAAE,iHAAA,oBAAoB,OAAA;AAC5E,iDAAgD;AAAvC,8GAAA,aAAa,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,yCAAkG;AAAzF,sGAAA,SAAS,OAAA;AAAE,4GAAA,eAAe,OAAA;AAAE,8GAAA,iBAAiB,OAAA;AAAE,iHAAA,oBAAoB,OAAA;AAC5E,iDAAgD;AAAvC,8GAAA,aAAa,OAAA;AACtB,mDAAkD;AAAzC,gHAAA,cAAc,OAAA"}

package/dist/types.d.ts

@@ -1,6 +1,7 @@
-export type LogContext = 'setup' | 'test' | 'teardown';
+export type LogContext = 'preconditions' | 'test' | 'teardown';
 export interface LoggerConfig {
     testName?: string;
+    testFile?: string;
     context?: LogContext;
     logDirectory?: string;
     maskAuthTokens?: boolean;
@@ -17,6 +18,36 @@ export interface ResponseLogData {
     headers?: Record<string, string>;
     body?: any;
 }
+export interface StepLogEntry {
+    step: number;
+    description?: string;
+    timestamp: string;
+    request: RequestLogData;
+    response: ResponseLogData;
+    duration: number;
+    curl: string;
+}
+export interface TestLogDocument {
+    test: {
+        name: string;
+        file?: string;
+        startedAt: string;
+        finishedAt?: string;
+        duration?: number;
+        result?: 'PASSED' | 'FAILED' | 'SKIPPED';
+    };
+    preconditions: StepLogEntry[];
+    steps: StepLogEntry[];
+    teardown: StepLogEntry[];
+    summary: {
+        totalRequests: number;
+        preconditions: number;
+        testSteps: number;
+        teardown: number;
+        totalDuration: number;
+    };
+}
+/** @deprecated Use StepLogEntry instead */
 export interface LogEntry {
     timestamp: string;
     testName: string;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,CAAC;AAEvD,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC;IAC5C,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ;AAED,MAAM,WAAW,QAAQ;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,UAAU,CAAC;IACpB,OAAO,EAAE,cAAc,CAAC;IACxB,QAAQ,EAAE,eAAe,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,eAAe,GAAG,MAAM,GAAG,UAAU,CAAC;AAE/D,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC;IAC5C,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,cAAc,CAAC;IACxB,QAAQ,EAAE,eAAe,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;KAC1C,CAAC;IACF,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,QAAQ,EAAE,YAAY,EAAE,CAAC;IACzB,OAAO,EAAE;QACP,aAAa,EAAE,MAAM,CAAC;QACtB,aAAa,EAAE,MAAM,CAAC;QACtB,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;CACH;AAED,2CAA2C;AAC3C,MAAM,WAAW,QAAQ;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,UAAU,CAAC;IACpB,OAAO,EAAE,cAAc,CAAC;IACxB,QAAQ,EAAE,eAAe,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd"}

package/dist/withApiLogging.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Proxy-based API logging wrapper for Playwright's APIRequestContext
+ * Zero changes to your controllers/clients — just wrap `request` in the fixture
+ */
+import type { APIRequestContext, TestInfo } from '@playwright/test';
+import { ApiLogger } from './ApiLogger';
+import { LogContext } from './types';
+export interface ApiLoggingOptions {
+    /** Test name for log filename (auto-detected from testInfo if provided) */
+    testName?: string;
+    /** Test file path (auto-detected from testInfo if provided) */
+    testFile?: string;
+    /** Log context: 'preconditions' | 'test' | 'teardown' (default: 'test') */
+    context?: LogContext;
+    /** Custom log directory (default: 'logs/') */
+    logDirectory?: string;
+    /** Mask Authorization headers (default: true) */
+    maskAuthTokens?: boolean;
+    /** Existing logger to share across setup/test/teardown phases */
+    logger?: ApiLogger;
+}
+/**
+ * Wrap Playwright's APIRequestContext with automatic logging.
+ * All HTTP calls (get, post, put, patch, delete, head, fetch) are intercepted and logged.
+ *
+ * @param request - Playwright APIRequestContext
+ * @param testInfoOrOptions - TestInfo object or ApiLoggingOptions
+ * @returns Proxied APIRequestContext with logging + logger reference via `__logger`
+ *
+ * @example
+ * // Minimal — just pass testInfo:
+ * const loggedRequest = withApiLogging(request, testInfo);
+ * const apiClient = new ApiClient(loggedRequest);
+ *
+ * @example
+ * // With preconditions and test steps:
+ * const loggedRequest = withApiLogging(request, testInfo);
+ * loggedRequest.__logger.startPreconditions();
+ * loggedRequest.__logger.describe('Get employee for test');
+ * await apiClient.getEmployees();
+ * loggedRequest.__logger.startTest();
+ * loggedRequest.__logger.describe('Try to access without token');
+ * await apiClient.getWithoutAuth();
+ * loggedRequest.__logger.finalize('PASSED');
+ */
+export declare function withApiLogging(request: APIRequestContext, testInfoOrOptions?: TestInfo | ApiLoggingOptions): APIRequestContext & {
+    __logger: ApiLogger;
+};
+//# sourceMappingURL=withApiLogging.d.ts.map

package/dist/withApiLogging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withApiLogging.d.ts","sourceRoot":"","sources":["../src/withApiLogging.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAe,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACjF,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,UAAU,EAAgB,MAAM,SAAS,CAAC;AAEnD,MAAM,WAAW,iBAAiB;IAChC,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2EAA2E;IAC3E,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,8CAA8C;IAC9C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iDAAiD;IACjD,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,iEAAiE;IACjE,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,cAAc,CAC5B,OAAO,EAAE,iBAAiB,EAC1B,iBAAiB,CAAC,EAAE,QAAQ,GAAG,iBAAiB,GAC/C,iBAAiB,GAAG;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,CAmG7C"}

package/dist/withApiLogging.js

@@ -0,0 +1,133 @@
+"use strict";
+/**
+ * Proxy-based API logging wrapper for Playwright's APIRequestContext
+ * Zero changes to your controllers/clients — just wrap `request` in the fixture
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withApiLogging = withApiLogging;
+const ApiLogger_1 = require("./ApiLogger");
+/**
+ * Wrap Playwright's APIRequestContext with automatic logging.
+ * All HTTP calls (get, post, put, patch, delete, head, fetch) are intercepted and logged.
+ *
+ * @param request - Playwright APIRequestContext
+ * @param testInfoOrOptions - TestInfo object or ApiLoggingOptions
+ * @returns Proxied APIRequestContext with logging + logger reference via `__logger`
+ *
+ * @example
+ * // Minimal — just pass testInfo:
+ * const loggedRequest = withApiLogging(request, testInfo);
+ * const apiClient = new ApiClient(loggedRequest);
+ *
+ * @example
+ * // With preconditions and test steps:
+ * const loggedRequest = withApiLogging(request, testInfo);
+ * loggedRequest.__logger.startPreconditions();
+ * loggedRequest.__logger.describe('Get employee for test');
+ * await apiClient.getEmployees();
+ * loggedRequest.__logger.startTest();
+ * loggedRequest.__logger.describe('Try to access without token');
+ * await apiClient.getWithoutAuth();
+ * loggedRequest.__logger.finalize('PASSED');
+ */
+function withApiLogging(request, testInfoOrOptions) {
+    let options;
+    if (testInfoOrOptions && 'title' in testInfoOrOptions) {
+        const testInfo = testInfoOrOptions;
+        options = {
+            testName: testInfo.title,
+            testFile: testInfo.file,
+            context: 'test',
+        };
+    }
+    else {
+        options = testInfoOrOptions || {};
+    }
+    // Use shared logger or create new
+    let logger;
+    if (options.logger) {
+        logger = options.logger;
+        if (options.context) {
+            logger.setContext(options.context);
+        }
+    }
+    else {
+        const config = {
+            testName: options.testName,
+            testFile: options.testFile,
+            context: options.context || 'test',
+            logDirectory: options.logDirectory,
+            maskAuthTokens: options.maskAuthTokens,
+        };
+        logger = new ApiLogger_1.ApiLogger(config);
+    }
+    // If logging is disabled, return original request with logger ref
+    if (!logger.isEnabled()) {
+        return Object.assign(request, { __logger: logger });
+    }
+    const HTTP_METHODS = ['get', 'post', 'put', 'patch', 'delete', 'head', 'fetch'];
+    const proxy = new Proxy(request, {
+        get(target, prop, receiver) {
+            const propName = typeof prop === 'string' ? prop : '';
+            if (propName === '__logger') {
+                return logger;
+            }
+            if (HTTP_METHODS.includes(propName)) {
+                return async (url, reqOptions) => {
+                    const method = propName === 'fetch' ? (reqOptions?.method || 'GET') : propName;
+                    const startTime = Date.now();
+                    const requestHeaders = reqOptions?.headers;
+                    const requestBody = extractBody(reqOptions);
+                    try {
+                        const response = await target[propName](url, reqOptions);
+                        const duration = Date.now() - startTime;
+                        const responseBody = await safeParseResponseBody(response);
+                        const responseHeaders = extractResponseHeaders(response);
+                        logger.logApiCall(method.toUpperCase(), response.url(), requestHeaders, requestBody, response.status(), responseHeaders, responseBody, duration);
+                        return response;
+                    }
+                    catch (error) {
+                        const duration = Date.now() - startTime;
+                        logger.logApiCall(method.toUpperCase(), url, requestHeaders, requestBody, 0, undefined, { error: String(error) }, duration);
+                        throw error;
+                    }
+                };
+            }
+            return Reflect.get(target, prop, receiver);
+        },
+    });
+    return Object.assign(proxy, { __logger: logger });
+}
+function extractBody(options) {
+    if (!options)
+        return undefined;
+    if (options.data)
+        return options.data;
+    if (options.form)
+        return options.form;
+    if (options.multipart)
+        return options.multipart;
+    return undefined;
+}
+async function safeParseResponseBody(response) {
+    try {
+        return await response.json();
+    }
+    catch {
+        try {
+            return await response.text();
+        }
+        catch {
+            return null;
+        }
+    }
+}
+function extractResponseHeaders(response) {
+    try {
+        return response.headers();
+    }
+    catch {
+        return undefined;
+    }
+}
+//# sourceMappingURL=withApiLogging.js.map

package/dist/withApiLogging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withApiLogging.js","sourceRoot":"","sources":["../src/withApiLogging.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AA6CH,wCAsGC;AAhJD,2CAAwC;AAkBxC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,cAAc,CAC5B,OAA0B,EAC1B,iBAAgD;IAEhD,IAAI,OAA0B,CAAC;IAE/B,IAAI,iBAAiB,IAAI,OAAO,IAAI,iBAAiB,EAAE,CAAC;QACtD,MAAM,QAAQ,GAAG,iBAA6B,CAAC;QAC/C,OAAO,GAAG;YACR,QAAQ,EAAE,QAAQ,CAAC,KAAK;YACxB,QAAQ,EAAE,QAAQ,CAAC,IAAI;YACvB,OAAO,EAAE,MAAM;SAChB,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,OAAO,GAAI,iBAAuC,IAAI,EAAE,CAAC;IAC3D,CAAC;IAED,kCAAkC;IAClC,IAAI,MAAiB,CAAC;IAEtB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QACxB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,MAAM,GAAiB;YAC3B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,MAAM;YAClC,YAAY,EAAE,OAAO,CAAC,YAAY;YAClC,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC,CAAC;QACF,MAAM,GAAG,IAAI,qBAAS,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,kEAAkE;IAClE,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC;QACxB,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IACtD,CAAC;IAED,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhF,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,EAAE;QAC/B,GAAG,CAAC,MAAyB,EAAE,IAAqB,EAAE,QAAa;YACjE,MAAM,QAAQ,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YAEtD,IAAI,QAAQ,KAAK,UAAU,EAAE,CAAC;gBAC5B,OAAO,MAAM,CAAC;YAChB,CAAC;YAED,IAAI,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACpC,OAAO,KAAK,EAAE,GAAW,EAAE,UAAgB,EAAE,EAAE;oBAC7C,MAAM,MAAM,GAAG,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;oBAC/E,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;oBAE7B,MAAM,cAAc,GAAG,UAAU,EAAE,OAAO,CAAC;oBAC3C,MAAM,WAAW,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;oBAE5C,IAAI,CAAC;wBACH,MAAM,QAAQ,GAAgB,MAAO,MAAc,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;wBAC/E,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;wBAExC,MAAM,YAAY,GAAG,MAAM,qBAAqB,CAAC,QAAQ,CAAC,CAAC;wBAC3D,MAAM,eAAe,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAC;wBAEzD,MAAM,CAAC,UAAU,CACf,MAAM,CAAC,WAAW,EAAE,EACpB,QAAQ,CAAC,GAAG,EAAE,EACd,cAAc,EACd,WAAW,EACX,QAAQ,CAAC,MAAM,EAAE,EACjB,eAAe,EACf,YAAY,EACZ,QAAQ,CACT,CAAC;wBAEF,OAAO,QAAQ,CAAC;oBAClB,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;wBAExC,MAAM,CAAC,UAAU,CACf,MAAM,CAAC,WAAW,EAAE,EACpB,GAAG,EACH,cAAc,EACd,WAAW,EACX,CAAC,EACD,SAAS,EACT,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,EACxB,QAAQ,CACT,CAAC;wBAEF,MAAM,KAAK,CAAC;oBACd,CAAC;gBACH,CAAC,CAAC;YACJ,CAAC;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC7C,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAgD,CAAC;AACnG,CAAC;AAED,SAAS,WAAW,CAAC,OAAa;IAChC,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IAC/B,IAAI,OAAO,CAAC,IAAI;QAAE,OAAO,OAAO,CAAC,IAAI,CAAC;IACtC,IAAI,OAAO,CAAC,IAAI;QAAE,OAAO,OAAO,CAAC,IAAI,CAAC;IACtC,IAAI,OAAO,CAAC,SAAS;QAAE,OAAO,OAAO,CAAC,SAAS,CAAC;IAChD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,qBAAqB,CAAC,QAAqB;IACxD,IAAI,CAAC;QACH,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,IAAI,CAAC;YACH,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC/B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,sBAAsB,CAAC,QAAqB;IACnD,IAAI,CAAC;QACH,OAAO,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC5B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playwright-api-logger",
-  "version": "1.0.0",
+  "version": "2.1.0",
   "description": "Comprehensive API request/response logger with curl export for Playwright tests",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",