@zest-pw/test 1.0.9 → 1.0.11

package/dist/config.d.ts

@@ -55,6 +55,11 @@ export interface ZestConfig {
          * @default false
          */
         saveToDisk?: boolean;
+        /**
+         * Capture full page screenshot (scrolls to capture entire page)
+         * @default true
+         */
+        fullPage?: boolean;
     };
     /**
      * Zephyr Scale integration settings

package/dist/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../config.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT;;;WAGG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;QAEzB;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;QAEzB;;;;WAIG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;;WAGG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;;WAGG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;;WAGG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IAEF;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,UAAU,CAoB9C,CAAC;AAOF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,CAiBzE;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,QAAQ,CAAC,UAAU,CAAC,CAEpD;AAED;;;GAGG;AACH,wBAAsB,cAAc,IAAI,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAcpE"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../config.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT;;;WAGG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;QAEzB;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,cAAc,CAAC,EAAE,OAAO,CAAC;QAEzB;;;;WAIG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;;WAGG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;;WAGG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;;WAGG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;;WAGG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB,CAAC;IAEF;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,UAAU,CAqB9C,CAAC;AAOF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,CAiBzE;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,QAAQ,CAAC,UAAU,CAAC,CAEpD;AAED;;;GAGG;AACH,wBAAsB,cAAc,IAAI,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAgBpE"}

package/dist/config.js

@@ -58,6 +58,7 @@ exports.defaultConfig = {
         includeInReport: true,
         onlyOnFailure: false,
         saveToDisk: false,
+        fullPage: true,
     },
     zephyr: {
         enabled: false,
@@ -129,7 +130,9 @@ async function loadZestConfig() {
         const configPath = process.cwd() + '/zest.config.ts';
         const userConfig = await Promise.resolve(`${configPath}`).then(s => __importStar(require(s)));
         if (userConfig.default) {
-            return userConfig.default;
+            // Update global loadedConfig so getZestConfig() returns the same values
+            loadedConfig = userConfig.default;
+            return loadedConfig;
         }
         return loadedConfig;
     }

package/dist/reporter/result-processor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"result-processor.d.ts","sourceRoot":"","sources":["../../reporter/result-processor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAUlF;;;;GAIG;AACH,wBAAsB,kBAAkB,CACtC,UAAU,EAAE,UAAU,EACtB,WAAW,EAAE,KAAK,CAAC;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,CAAC,iBAiD3D"}
+{"version":3,"file":"result-processor.d.ts","sourceRoot":"","sources":["../../reporter/result-processor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAUlF;;;;GAIG;AACH,wBAAsB,kBAAkB,CACtC,UAAU,EAAE,UAAU,EACtB,WAAW,EAAE,KAAK,CAAC;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,CAAC,iBAsD3D"}

package/dist/reporter/result-processor.js

@@ -23,10 +23,14 @@ async function processTestResults(fullResult, testResults) {
     const enrichedResults = (0, enrich_test_results_1.enrichTestResultsWithPlannedSteps)(transformedResults);
     // Add formatted file names to actualResult
     const finalResults = (0, add_file_names_1.addFileNamesToResults)(enrichedResults);
+    // Remove screenshot bodies from report if includeInReport is false
+    const resultsForReport = config.screenshots.includeInReport
+        ? finalResults
+        : removeScreenshotBodies(finalResults);
     // Save JSON report if enabled
     if (config.reporter.saveJsonReport) {
         try {
-            (0, save_json_report_1.saveTestResultsToJson)(finalResults, config.reporter.outputDir);
+            (0, save_json_report_1.saveTestResultsToJson)(resultsForReport, config.reporter.outputDir);
         }
         catch (error) {
             console.error('Error saving JSON report:', error);
@@ -60,3 +64,32 @@ async function processTestResults(fullResult, testResults) {
         }
     }
 }
+/**
+ * Removes screenshot bodies (base64 data) from test results while keeping metadata
+ * This is used when includeInReport is false to reduce JSON file size
+ * @param results - Test results object
+ * @returns Test results with screenshot bodies removed
+ */
+function removeScreenshotBodies(results) {
+    return {
+        ...results,
+        tests: results.tests.map((test) => ({
+            ...test,
+            steps: test.steps.map((step) => ({
+                ...step,
+                actualResult: step.actualResult?.map((att) => {
+                    // If it's a screenshot (image/png), remove the body but keep metadata
+                    if (att.image === 'image/png') {
+                        return {
+                            fileName: att.fileName,
+                            image: att.image,
+                            // body is omitted
+                        };
+                    }
+                    // For other attachments, keep as is
+                    return att;
+                }) || []
+            }))
+        }))
+    };
+}

package/dist/utils/take-screenshots.d.ts

@@ -3,16 +3,22 @@
  */
 import type { Page, TestInfo } from "@playwright/test";
 /**
- * Takes a screenshot after each test step (always, regardless of result)
+ * Takes a screenshot after each test step
+ *
+ * Screenshot behavior is controlled by configuration:
+ * - screenshots.enabled: If false, no screenshots are taken
+ * - screenshots.onlyOnFailure: If true, screenshots are only taken when step fails
+ * - screenshots.fullPage: Controls whether to capture full page or viewport only
  *
  * To save screenshots to disk (from base64 results):
  * 1. Add to .env file: SAVE_SCREENSHOTS=true
  * 2. Or pass via command: SAVE_SCREENSHOTS=true npx playwright test
+ * 3. Or set screenshots.saveToDisk: true in config
  *
  * @param page - Playwright Page object
- * @param stepInfo - Step information object
  * @param testInfo - Playwright TestInfo object for attaching screenshots
  * @param stepTitle - Optional step title for attachment name
+ * @param hasError - Whether the step failed (used for onlyOnFailure logic)
  */
-export declare function takeScreenshotAfterStep(page: Page, testInfo: TestInfo, stepTitle?: string): Promise<void>;
+export declare function takeScreenshotAfterStep(page: Page, testInfo: TestInfo, stepTitle?: string, hasError?: boolean): Promise<void>;
 //# sourceMappingURL=take-screenshots.d.ts.map

package/dist/utils/take-screenshots.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"take-screenshots.d.ts","sourceRoot":"","sources":["../../utils/take-screenshots.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEvD;;;;;;;;;;;GAWG;AACH,wBAAsB,uBAAuB,CAC3C,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,QAAQ,EAClB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CAaf"}
+{"version":3,"file":"take-screenshots.d.ts","sourceRoot":"","sources":["../../utils/take-screenshots.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAGvD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,uBAAuB,CAC3C,IAAI,EAAE,IAAI,EACV,QAAQ,EAAE,QAAQ,EAClB,SAAS,CAAC,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,OAAO,GACjB,OAAO,CAAC,IAAI,CAAC,CA4Bf"}

package/dist/utils/take-screenshots.js

@@ -4,22 +4,41 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.takeScreenshotAfterStep = takeScreenshotAfterStep;
+const config_1 = require("../config");
 /**
- * Takes a screenshot after each test step (always, regardless of result)
+ * Takes a screenshot after each test step
+ *
+ * Screenshot behavior is controlled by configuration:
+ * - screenshots.enabled: If false, no screenshots are taken
+ * - screenshots.onlyOnFailure: If true, screenshots are only taken when step fails
+ * - screenshots.fullPage: Controls whether to capture full page or viewport only
  *
  * To save screenshots to disk (from base64 results):
  * 1. Add to .env file: SAVE_SCREENSHOTS=true
  * 2. Or pass via command: SAVE_SCREENSHOTS=true npx playwright test
+ * 3. Or set screenshots.saveToDisk: true in config
  *
  * @param page - Playwright Page object
- * @param stepInfo - Step information object
  * @param testInfo - Playwright TestInfo object for attaching screenshots
  * @param stepTitle - Optional step title for attachment name
+ * @param hasError - Whether the step failed (used for onlyOnFailure logic)
  */
-async function takeScreenshotAfterStep(page, testInfo, stepTitle) {
+async function takeScreenshotAfterStep(page, testInfo, stepTitle, hasError) {
     try {
         if (page && testInfo) {
-            const screenshotBuffer = await page.screenshot({ fullPage: true });
+            const config = (0, config_1.getZestConfig)();
+            // Check if screenshots are enabled
+            if (!config.screenshots.enabled) {
+                return;
+            }
+            // Check if we should only take screenshots on failure
+            // If onlyOnFailure is true, only take screenshot when hasError is explicitly true
+            if (config.screenshots.onlyOnFailure && !hasError) {
+                return;
+            }
+            const screenshotBuffer = await page.screenshot({
+                fullPage: config.screenshots.fullPage
+            });
             await testInfo.attach(stepTitle || 'screenshot', {
                 body: screenshotBuffer,
                 contentType: 'image/png',

package/dist/utils/test-step-wrapper.js

@@ -10,10 +10,10 @@ const take_screenshots_1 = require("./take-screenshots");
 function wrapTestStepWithScreenshots(test, getCurrentContext) {
     const originalTestStep = test.step.bind(test);
     const originalTestStepSkip = test.step.skip.bind(test);
-    const takeScreenshot = async (title) => {
+    const takeScreenshot = async (title, hasError = false) => {
         const context = getCurrentContext();
         try {
-            await (0, take_screenshots_1.takeScreenshotAfterStep)(context.page, context.testInfo, title);
+            await (0, take_screenshots_1.takeScreenshotAfterStep)(context.page, context.testInfo, title, hasError);
         }
         catch (screenshotError) {
             console.error('Error taking screenshot after step error:', screenshotError);
@@ -23,11 +23,11 @@ function wrapTestStepWithScreenshots(test, getCurrentContext) {
         return originalTestStep(title, async (stepInfo) => {
             try {
                 const result = await body(stepInfo);
-                await takeScreenshot(title);
+                await takeScreenshot(title, false);
                 return result;
             }
             catch (error) {
-                await takeScreenshot(title);
+                await takeScreenshot(title, true);
                 throw error;
             }
         }, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zest-pw/test",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "Advanced Playwright test framework with automatic screenshots, custom reporting, and Zephyr Scale integration",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",