@checkly/playwright-reporter 0.1.10 → 1.1.0

package/dist/index.d.ts

@@ -1,308 +1,64 @@
-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';
+import { JSONReportTestResult as JSONReportTestResult$1, Reporter } from '@playwright/test/reporter';
+export { JSONReport, JSONReportError, JSONReportSTDIOEntry, JSONReportSpec, JSONReportSuite, JSONReportTest, JSONReportTestStep } from '@playwright/test/reporter';
 
-/**
- * Checkly environment for API endpoints
- */
-type ChecklyEnvironment = 'local' | 'development' | 'staging' | 'production';
-/**
- * Context passed to sessionName callback function
- */
-interface SessionNameContext {
-    /**
-     * The directory name where tests are running
-     */
-    directoryName: string;
-    /**
-     * Playwright's full configuration object
-     */
-    config: FullConfig;
-    /**
-     * The root test suite containing all tests
-     */
-    suite: Suite;
-}
-/**
- * Session name can be a static string or a function that returns a string
- */
-type SessionNameOption = string | ((context: SessionNameContext) => string);
-/**
- * Configuration options for ChecklyReporter
- */
-interface ChecklyReporterOptions {
-    /**
-     * Checkly account ID for uploading test results
-     * Required for Phase 2 (upload functionality)
-     */
-    accountId?: string;
-    /**
-     * Checkly API key for authentication
-     * Required for Phase 2 (upload functionality)
-     */
-    apiKey?: string;
-    /**
-     * Checkly environment to use
-     * Can also be set via CHECKLY_ENV environment variable
-     * @default 'production'
-     */
-    environment?: ChecklyEnvironment;
-    /**
-     * Output path for the generated ZIP file (for testing/debugging)
-     * @default 'checkly-report.zip'
-     * @internal
-     */
-    outputPath?: string;
-    /**
-     * Path to the JSON report file generated by Playwright's json reporter
-     * @default 'test-results/playwright-test-report.json'
-     * @internal
-     */
-    jsonReportPath?: string;
-    /**
-     * Directory containing test results and assets
-     * @default 'test-results'
-     * @internal
-     */
-    testResultsDir?: string;
-    /**
-     * Dry run mode - skips API calls and only creates local ZIP file
-     * @default false
-     */
-    dryRun?: boolean;
-    /**
-     * Custom name for the test session
-     * Can be a string or a callback function for dynamic names
-     * @default 'Playwright Test Session: {directoryName}'
-     * @example
-     * // Static string
-     * sessionName: 'My E2E Tests'
-     *
-     * // Dynamic with callback
-     * sessionName: ({ directoryName, config }) => `E2E: ${directoryName} (${config.projects.length} projects)`
-     */
-    sessionName?: SessionNameOption;
-    /**
-     * Enable verbose logging for debugging
-     * Logs detailed information about each phase of report generation
-     * Can also be enabled via CHECKLY_REPORTER_VERBOSE=true environment variable
-     * @default false
-     */
-    verbose?: boolean;
-}
-/**
- * Warning types that can be attached to test results
- */
-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 warning for programmatic handling
-     */
-    type: ChecklyWarningType;
-    /**
-     * Human-readable warning message
-     */
+interface ChecklyConsoleLog {
+    type: 'log' | 'warn' | 'error' | 'info' | 'debug';
     message: string;
+    timestamp: string;
 }
-/**
- * Console message type matching the webapp's CheckRunNavigationTracePage.console type
- */
-type ConsoleMessageType = 'debug' | 'error' | 'info' | 'log' | 'warning';
-/**
- * Location of a console message in source code
- */
-interface ConsoleMessageLocation {
+interface ChecklyNetworkRequest {
     url: string;
-    columnNumber: number;
-    lineNumber: number;
+    method: string;
+    status?: number;
+    duration?: number;
+    timestamp: string;
 }
-/**
- * Console message extracted from Playwright trace
- * Matches the webapp's CheckRunNavigationTracePage.console array item type
- */
-interface ConsoleMessage {
-    /**
-     * Unique identifier for the console message
-     */
-    id: string;
-    /**
-     * Source location where the console message was triggered
-     */
-    location: ConsoleMessageLocation;
-    /**
-     * The text content of the console message
-     */
-    text: string;
-    /**
-     * Timestamp when the message was logged (milliseconds)
-     */
-    timestamp: number;
-    /**
-     * Type of console message
-     */
-    type: ConsoleMessageType;
+interface ChecklyData {
+    consoleLogs?: ChecklyConsoleLog[];
+    networkRequests?: ChecklyNetworkRequest[];
 }
-/**
- * Network request extracted from Playwright trace
- * Matches the webapp's CheckRunNavigationTraceNetworkEntry type
- */
-interface NetworkRequest {
-    id: string;
-    url: string;
-    domain: string;
-    method: string;
-    resourceType: string;
-    statusCode: number;
-    statusText: string;
-    start: number;
-    startedAt: number;
-    finishedAt: number;
-    time: number;
-    hasFinished: boolean;
-    hasSucceeded: boolean;
-    requestHeaders: Record<string, string>;
-    responseHeaders: Record<string, string>;
-    transferBytes?: number;
-    resourceBytes?: number;
+interface JSONReportTestResult extends JSONReportTestResult$1 {
+    _checkly?: ChecklyData;
 }
+
 /**
- * Checkly-specific extensions added to JSONReportTestResult
+ * Configuration options for the Checkly Playwright Reporter.
  */
-interface ChecklyTestResultExtensions {
-    /**
-     * Warnings about the test result (e.g., missing traces)
-     */
-    warnings?: ChecklyWarning[];
-    /**
-     * Console messages extracted from the Playwright trace
-     */
-    console?: ConsoleMessage[];
-    /**
-     * Network requests extracted from the Playwright trace
-     */
-    network?: NetworkRequest[];
+interface ChecklyReporterOptions {
+    /** Directory for report output. Defaults to Playwright's outputDir. */
+    outputDir?: string;
+    /** Enable verbose logging. */
+    verbose?: boolean;
+    /** Checkly API key. Can also be set via CHECKLY_API_KEY env var. */
+    apiKey?: string;
+    /** Checkly account ID. Can also be set via CHECKLY_ACCOUNT_ID env var. */
+    accountId?: string;
+    /** Session name for the test run. Can be a string or a function. */
+    sessionName?: string | ((context: {
+        directoryName: string;
+        config: unknown;
+        suite: unknown;
+    }) => string);
+    /** Dry run mode - generate report but don't upload. */
+    dryRun?: boolean;
 }
-/**
- * Extended JSONReportTestResult with Checkly-specific data
- */
-type JSONReportTestResult = JSONReportTestResult$1 & {
-    _checkly?: ChecklyTestResultExtensions;
-};
-/**
- * Extended JSONReportTest with Checkly-extended results
- */
-type JSONReportTest = Omit<JSONReportTest$1, 'results'> & {
-    results: JSONReportTestResult[];
-};
-/**
- * Extended JSONReportSpec with Checkly-extended tests
- */
-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[];
-};
+type ChecklyReporterClass = new (options?: ChecklyReporterOptions) => Reporter;
+declare const _default: ChecklyReporterClass;
 
 /**
- * Checkly Playwright Reporter
+ * Create a Checkly reporter configuration with full intellisense support.
  *
- * Creates a ZIP archive containing the JSON report and all test assets.
- * Designed to work alongside Playwright's built-in JSONReporter.
+ * Use this instead of the array-based syntax for better IDE experience.
  *
  * @example
- * // playwright.config.ts
+ * import { createChecklyReporter } from '@checkly/playwright-reporter'
+ *
  * export default defineConfig({
  *   reporter: [
- *     ['json', { outputFile: 'test-results/playwright-test-report.json' }],
- *     ['@checkly/playwright-reporter', {
- *       apiKey: process.env.CHECKLY_API_KEY,
- *       accountId: process.env.CHECKLY_ACCOUNT_ID,
- *     }]
- *   ]
- * });
+ *     createChecklyReporter({ outputDir: 'test-results' }),
+ *   ],
+ * })
  */
-declare class ChecklyReporter implements Reporter {
-    private options;
-    private assetCollector;
-    private zipper;
-    private testResults?;
-    private testSession?;
-    private startTime?;
-    private testCounts;
-    private stepsMap;
-    private warningsMap;
-    private tracePathsMap;
-    private consoleMessagesMap;
-    private networkRequestsMap;
-    /**
-     * Log a message if verbose mode is enabled
-     */
-    private log;
-    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
-     * Also captures trace file path for later console message extraction
-     * 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
-     */
-    onBegin(config: FullConfig, suite: Suite): void;
-    /**
-     * Called for each test when it completes
-     * Captures steps and warnings, tracks test results for final status calculation
-     */
-    onTestEnd(test: TestCase, result: TestResult): void;
-    /**
-     * Called after all tests have completed
-     * This is where we create the ZIP archive and upload results
-     */
-    onEnd(): Promise<void>;
-    private printSummary;
-    /**
-     * Extracts console messages and network requests from all captured traces
-     * Called before injecting data into the report
-     */
-    private extractDataFromTraces;
-    /**
-     * Injects captured steps, warnings, console messages, and network requests into the JSON report
-     * Traverses the report structure and matches by test ID + retry
-     */
-    private injectDataIntoReport;
-    /**
-     * Reconstructs config.projects and test.projectId from test data
-     * This is necessary for blob merge scenarios where Playwright's JSON reporter
-     * doesn't populate projects array or projectId fields
-     */
-    private reconstructProjectsFromTests;
-    /**
-     * Uploads test results to Checkly API
-     */
-    private uploadResults;
-    /**
-     * Called when a global error occurs
-     */
-    onError(error: TestError): void;
-}
+declare function createChecklyReporter(options?: ChecklyReporterOptions): ['@checkly/playwright-reporter', ChecklyReporterOptions];
 
-export { ChecklyReporter, type ChecklyReporterOptions, type ChecklyTestResultExtensions, type ChecklyWarning, type ChecklyWarningType, type ConsoleMessage, type ConsoleMessageLocation, type ConsoleMessageType, type JSONReport, type JSONReportSpec, type JSONReportSuite, type JSONReportTest, type JSONReportTestResult, type NetworkRequest, ChecklyReporter as default };
+export { type ChecklyConsoleLog, type ChecklyData, type ChecklyNetworkRequest, type ChecklyReporterOptions, type JSONReportTestResult, createChecklyReporter, _default as default };