@checkly/playwright-reporter 0.1.5 → 0.1.7

package/dist/index.d.ts

@@ -0,0 +1,213 @@
+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
+ */
+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;
+}
+/**
+ * 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
+     */
+    message: string;
+}
+/**
+ * Checkly-specific extensions added to JSONReportTestResult
+ */
+interface ChecklyTestResultExtensions {
+    /**
+     * Warnings about the test result (e.g., missing traces)
+     */
+    warnings?: ChecklyWarning[];
+}
+/**
+ * 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[];
+};
+
+/**
+ * Checkly Playwright Reporter
+ *
+ * Creates a ZIP archive containing the JSON report and all test assets.
+ * Designed to work alongside Playwright's built-in JSONReporter.
+ *
+ * @example
+ * // playwright.config.ts
+ * 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,
+ *     }]
+ *   ]
+ * });
+ */
+declare class ChecklyReporter implements Reporter {
+    private options;
+    private assetCollector;
+    private zipper;
+    private testResults?;
+    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
+     */
+    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;
+    /**
+     * 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
+     */
+    private uploadResults;
+    /**
+     * Called when a global error occurs
+     */
+    onError(error: TestError): void;
+}
+
+export { ChecklyReporter, type ChecklyReporterOptions, type ChecklyTestResultExtensions, type ChecklyWarning, type ChecklyWarningType, type JSONReport, type JSONReportSpec, type JSONReportSuite, type JSONReportTest, type JSONReportTestResult, ChecklyReporter as default };