@checkly/playwright-reporter 0.1.6 → 0.1.8

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import { FullConfig, Suite, JSONReport, Reporter, TestCase, TestResult, TestError } from '@playwright/test/reporter';
+export { Asset, AssetCollector, ZipEntry, ZipResult, Zipper, ZipperOptions } from '@checkly/reporter-utils';
+import { FullConfig, Suite, JSONReport as JSONReport$1, JSONReportSuite as JSONReportSuite$1, JSONReportSpec as JSONReportSpec$1, JSONReportTest as JSONReportTest$1, JSONReportTestResult as JSONReportTestResult$1, Reporter, TestCase, TestResult, TestError } from '@playwright/test/reporter';
 
 /**
  * Checkly environment for API endpoints
@@ -82,112 +83,62 @@ interface ChecklyReporterOptions {
     sessionName?: SessionNameOption;
 }
 /**
- * Represents a test asset file to be included in the ZIP
+ * Warning types that can be attached to test results
  */
-interface Asset {
-    /**
-     * Absolute path to the asset file on disk
-     */
-    sourcePath: string;
-    /**
-     * Relative path within the ZIP archive
-     */
-    archivePath: string;
+type ChecklyWarningType = 'trace-off' | 'trace-retained-on-failure' | 'trace-first-retry-only' | 'trace-retries-only' | 'trace-retained-on-first-failure' | 'trace-missing';
+/**
+ * A warning attached to a test result
+ */
+interface ChecklyWarning {
     /**
-     * Type of asset
+     * Type of warning for programmatic handling
      */
-    type: 'screenshot' | 'video' | 'trace' | 'attachment' | 'other';
+    type: ChecklyWarningType;
     /**
-     * Content type / MIME type
+     * Human-readable warning message
      */
-    contentType: string;
+    message: string;
 }
 /**
- * Options for creating a ZIP archive
+ * Checkly-specific extensions added to JSONReportTestResult
  */
-interface ZipperOptions {
+interface ChecklyTestResultExtensions {
     /**
-     * Output path for the ZIP file
+     * Warnings about the test result (e.g., missing traces)
      */
-    outputPath: string;
+    warnings?: ChecklyWarning[];
 }
 /**
- * Result of ZIP creation
+ * Extended JSONReportTestResult with Checkly-specific data
  */
-interface ZipResult {
-    /**
-     * Path to the created ZIP file
-     */
-    zipPath: string;
-    /**
-     * Total size of ZIP file in bytes
-     */
-    size: number;
-    /**
-     * Number of entries in ZIP
-     */
-    entryCount: number;
-    /**
-     * Metadata about ZIP entries (for range-based access)
-     */
-    entries: ZipEntry[];
-}
+type JSONReportTestResult = JSONReportTestResult$1 & {
+    _checkly?: ChecklyTestResultExtensions;
+};
 /**
- * Metadata about a single entry in the ZIP archive
+ * Extended JSONReportTest with Checkly-extended results
  */
-interface ZipEntry {
-    /**
-     * Entry name (path within ZIP)
-     */
-    name: string;
-    /**
-     * Starting byte offset in ZIP file
-     */
-    start: number;
-    /**
-     * Ending byte offset in ZIP file
-     */
-    end: number;
-}
-
+type JSONReportTest = Omit<JSONReportTest$1, 'results'> & {
+    results: JSONReportTestResult[];
+};
 /**
- * Collects test assets from a directory for inclusion in ZIP archive
+ * Extended JSONReportSpec with Checkly-extended tests
  */
-declare class AssetCollector {
-    private testResultsDir;
-    constructor(testResultsDir: string);
-    /**
-     * Collects assets from test results directory
-     * Simply iterates through the test-results folder and collects all assets
-     * @param _report Optional Playwright JSONReport (not used, kept for compatibility)
-     * @returns Array of Asset objects with source and archive paths
-     */
-    collectAssets(_report?: JSONReport): Promise<Asset[]>;
-    /**
-     * Recursively traverses directories to collect assets
-     */
-    private collectAssetsRecursive;
-    /**
-     * Determines if a file should be skipped
-     */
-    private shouldSkipFile;
-    /**
-     * Creates an Asset object from file path
-     */
-    private createAsset;
-    /**
-     * Determines asset type and content type from file extension
-     */
-    private determineAssetType;
-    /**
-     * Gets content type for image files
-     */
-    private getImageContentType;
-    /**
-     * Gets content type for video files
-     */
-    private getVideoContentType;
-}
+type JSONReportSpec = Omit<JSONReportSpec$1, 'tests'> & {
+    tests: JSONReportTest[];
+};
+/**
+ * Extended JSONReportSuite with Checkly-extended specs and nested suites
+ */
+type JSONReportSuite = Omit<JSONReportSuite$1, 'suites' | 'specs'> & {
+    suites?: JSONReportSuite[];
+    specs: JSONReportSpec[];
+};
+/**
+ * Extended JSONReport with Checkly-extended suites
+ */
+type JSONReport = Omit<JSONReport$1, 'suites'> & {
+    suites: JSONReportSuite[];
+};
 
 /**
  * Checkly Playwright Reporter
@@ -215,12 +166,19 @@ declare class ChecklyReporter implements Reporter {
     private testSession?;
     private startTime?;
     private testCounts;
+    private stepsMap;
+    private warningsMap;
     constructor(options?: ChecklyReporterOptions);
     /**
      * Resolves the session name from options
      * Supports string, callback function, or falls back to default
      */
     private resolveSessionName;
+    /**
+     * Checks if test result has a trace attachment and adds context-aware warning if missing
+     * The warning type depends on the trace configuration and test result state
+     */
+    private checkTraceAttachment;
     /**
      * Called once before running tests
      * Creates test session in Checkly if credentials provided
@@ -228,7 +186,7 @@ declare class ChecklyReporter implements Reporter {
     onBegin(config: FullConfig, suite: Suite): void;
     /**
      * Called for each test when it completes
-     * Track test results for final status calculation
+     * Captures steps and warnings, tracks test results for final status calculation
      */
     onTestEnd(test: TestCase, result: TestResult): void;
     /**
@@ -237,6 +195,11 @@ declare class ChecklyReporter implements Reporter {
      */
     onEnd(): Promise<void>;
     private printSummary;
+    /**
+     * Injects captured steps and warnings into the JSON report
+     * Traverses the report structure and matches by test ID + retry
+     */
+    private injectDataIntoReport;
     /**
      * Uploads test results to Checkly API
      */
@@ -247,49 +210,4 @@ declare class ChecklyReporter implements Reporter {
     onError(error: TestError): void;
 }
 
-/**
- * Creates ZIP archives containing test reports and assets
- * Uses Checkly's fork of node-archiver with byte offset tracking
- */
-declare class Zipper {
-    private outputPath;
-    constructor(options: ZipperOptions);
-    /**
-     * Creates a ZIP archive containing the JSON report and assets
-     * @param reportPath - Path to the JSON report file
-     * @param assets - Array of assets to include in the ZIP
-     * @returns ZIP creation result with metadata
-     */
-    createZip(reportPath: string, assets: Asset[]): Promise<ZipResult>;
-    /**
-     * Transforms the JSON report to use relative paths for attachments
-     * This ensures the UI can map attachment paths to ZIP entries
-     * @param reportPath - Path to the original JSON report
-     * @returns Path to the transformed JSON report (in temp directory)
-     */
-    private transformJsonReport;
-    /**
-     * Recursively transforms attachment paths in the report structure
-     * Converts absolute paths to relative paths matching ZIP structure
-     * @param obj - Object to transform (mutated in place)
-     */
-    private transformAttachmentPaths;
-    /**
-     * Normalizes attachment paths by extracting the relevant snapshot directory portion.
-     * Supports Playwright's default and common custom snapshot directory patterns.
-     *
-     * Priority order (first match wins):
-     * 1. test-results/ (highest priority, existing behavior)
-     * 2. *-snapshots/ (Playwright default pattern)
-     * 3. __screenshots__/ (common custom pattern)
-     * 4. __snapshots__/ (common custom pattern)
-     * 5. screenshots/ (simple custom pattern)
-     * 6. snapshots/ (simple custom pattern)
-     *
-     * @param attachmentPath - Absolute or relative path to attachment
-     * @returns Normalized path starting from the matched directory, or original path if no match
-     */
-    private normalizeAttachmentPath;
-}
-
-export { type Asset, AssetCollector, ChecklyReporter, type ChecklyReporterOptions, type ZipEntry, type ZipResult, Zipper, type ZipperOptions, ChecklyReporter as default };
+export { ChecklyReporter, type ChecklyReporterOptions, type ChecklyTestResultExtensions, type ChecklyWarning, type ChecklyWarningType, type JSONReport, type JSONReportSpec, type JSONReportSuite, type JSONReportTest, type JSONReportTestResult, ChecklyReporter as default };