@arghajit/dummy/dist/types/index.d.ts

A Playwright reporter and dashboard for visualizing test results.

export type TestStatus = "passed" | "failed" | "skipped" | "expected-failure" | "unexpected-success" | "explicitly-skipped" | "flaky";
export interface TestStep {
    id: string;
    title: string;
    status: TestStatus;
    duration: number;
    startTime: Date;
    endTime: Date;
    browser: string;
    errorMessage?: string;
    stackTrace?: string;
    codeLocation?: string;
    codeSnippet?: string;
    isHook?: boolean;
    hookType?: "before" | "after";
    steps?: TestStep[];
}
export interface TestResult {
    id: string;
    describe?: string;
    spec_file?: string;
    name: string;
    status: TestStatus;
    duration: number;
    startTime: Date;
    endTime: Date;
    retries: number;
    steps: TestStep[];
    errorMessage?: string;
    stackTrace?: string;
    snippet?: string;
    codeSnippet?: string;
    tags?: string[];
    severity?: "Minor" | "Low" | "Medium" | "High" | "Critical";
    suiteName?: string;
    runId: string;
    browser: string;
    outcome?: string;
    final_status?: TestStatus;
    screenshots?: string[];
    videoPath?: string[];
    tracePath?: string;
    attachments?: {
        name: string;
        path: string;
        contentType: string;
    }[];
    stdout?: string[];
    stderr?: string[];
    workerId?: number;
    totalWorkers?: number;
    configFile?: string;
    metadata?: string;
    annotations?: {
        type: string;
        description?: string;
        location?: {
            file: string;
            line: number;
            column: number;
        };
    }[];
    retryHistory?: TestResult[];
}
export interface TestRun {
    id: string;
    timestamp: Date;
    totalTests: number;
    passed: number;
    failed: number;
    skipped: number;
    flaky?: number;
    duration: number;
    environment?: EnvDetails | EnvDetails[];
}
export interface TrendDataPoint {
    date: string;
    passed: number;
    failed: number;
    skipped: number;
    flaky?: number;
}
export interface PlaywrightPulseReporterOptions {
    /**
     * The name of the output JSON file. Kindly do not change.
     * @default "playwright-pulse-report.json"
     */
    outputFile?: string;
    /**
     * The directory where the report files will be generated.
     *
     * Mostly useful while using sharding
     *
     * @default "pulse-report"
     */
    outputDir?: string;
    /**
     * Whether to embed images directly as base64 strings in the report.
     * @default false
     */
    base64Images?: boolean;
    /**
     * Whether to reset the output directory before each run.
     *
     * Mostly useful while running multiple test suites in a single run with `&&` operator.
     *
     * example: `npx playwright test test1.spec.ts && npx playwright test test2.spec.ts`
     *
     * If `resetOnEachRun` is set to `false`, then the report of `test2.spec.ts` will be merged with `test1.spec.ts` report.
     *
     * @default true
     */
    resetOnEachRun?: boolean;
    /**
     * A custom description to embed or display in the report.
     *
     * If not added, the component will not appear in the html reports
     */
    reportDescription?: string;
    /**
     * Path to a custom logo image file to use in the report, which will be displayed in the header of the html report's logo and favicon.
     *
     * If not added, the default logo will be used.
     */
    logo?: string;
    /**
     * The subdirectory within `outputDir` where individual run reports are stored.
     * Only used when `resetOnEachRun` is `false`.
     *
     * @default "pulse-results"
     */
    individualReportsSubDir?: string;
}
export interface EnvDetails {
    host: string;
    os: string;
    cpu: {
        model: string;
        cores: number;
    };
    memory: string;
    node: string;
    v8: string;
    cwd: string;
}