@arpanp/zen-reporter 0.10.1

package/dist/runHistory.d.ts

@@ -0,0 +1,21 @@
+import type { ResultSummary, TestCase } from './types';
+/**
+ * Exact ordered field list for a single history row (single source of truth
+ * for the JSONL row shape that DuckDB's read_json consumes).
+ */
+export declare const RUN_ROW_FIELDS: string[];
+/** Lowercase, trim, every non-alphanumeric run -> single '-', strip edge '-'. */
+export declare function slugify(name: string): string;
+/**
+ * Deterministic run identifier: ISO start time (colons/dots -> '-') + slugified
+ * test run name, plus a shard suffix when running sharded.
+ */
+export declare function buildRunId(startedAtIso: string, testRunName: string, shard: {
+    current: number;
+    total: number;
+} | null): string;
+/**
+ * One row per test case, each carrying the run-level fields plus the per-test
+ * fields, so DuckDB can group/join across runs on the uniform schema.
+ */
+export declare function flattenRunRows(runId: string, testRunName: string, projectName: string, summary: ResultSummary, endedAt: string, testCases: TestCase[]): Record<string, unknown>[];

package/dist/tagColors.d.ts

@@ -0,0 +1,19 @@
+export declare const TAG_COLORS: {
+    bg: string;
+    text: string;
+    ring: string;
+}[];
+/**
+ * Get color for a tag. First time a tag is seen, assigns the next available color.
+ * Once assigned, a tag always returns the same color.
+ * Colors cycle after 10 unique tags.
+ */
+export declare function getTagColor(tag: string): {
+    bg: string;
+    text: string;
+    ring: string;
+};
+/**
+ * Reset the global tag color assignment. Useful for testing or re-rendering.
+ */
+export declare function resetTagColors(): void;

package/dist/types.d.ts

@@ -0,0 +1,192 @@
+export interface TestError {
+    name: string;
+    message: string;
+    stack: string;
+    location: Location | null;
+    snippet: string;
+    cause: TestError | null;
+}
+export interface TestStep {
+    title: string;
+    subtitle?: string;
+    location?: Location | null;
+    snippet?: string;
+    params?: Record<string, unknown>;
+    duration: number;
+    status: 'passed' | 'failed' | 'skipped' | 'timedOut' | 'interrupted';
+    annotations: Annotation[];
+    attachments: Attachment[];
+    error: TestError | null;
+    subSteps?: TestStep[];
+}
+export interface TestCase {
+    title: string;
+    parent: string;
+    project: string;
+    fileName: string;
+    status: 'passed' | 'failed' | 'skipped' | 'timedOut' | 'interrupted';
+    duration: number;
+    steps?: TestStep[];
+    errors?: TestError[];
+    stdout?: string[];
+    stderr?: string[];
+    annotations?: Annotation[];
+    attachments?: Attachment[];
+    tags?: string[];
+    describePath?: string[];
+    attempts?: number;
+    failedAttempts?: FailedAttempt[];
+}
+export interface TestSuite {
+    title: string;
+    cases: TestCase[];
+    subSuites?: TestSuite[];
+}
+export interface ResultSummary {
+    total: number;
+    passed: number;
+    failed: number;
+    skipped: number;
+    timedOut: number;
+    interrupted?: number;
+    startTime: string;
+    endTime: string;
+    duration: number;
+    totalSequentialDuration?: number;
+    numberOfProjects: number;
+    workers?: number;
+}
+export interface TestRun {
+    summary: ResultSummary;
+    suites: TestSuite[];
+    projectName?: string;
+    testRunName?: string;
+    theme?: string;
+    darkMode?: boolean;
+    enableHistory?: 'auto' | boolean;
+    minimalReport?: boolean;
+}
+export interface ReportData {
+    testRun: TestRun;
+}
+export interface Annotation {
+    type: string;
+    description: string | null;
+    location: Location | null;
+}
+export interface Attachment {
+    name: string;
+    contentType: string;
+    path: string | null;
+    body: string | null;
+}
+export interface Location {
+    file: string;
+    line: number;
+    column: number;
+}
+export interface FailedAttempt {
+    status: 'failed' | 'timedOut' | 'interrupted';
+    duration: number;
+    error: TestError | null;
+    /** Full execution details of this attempt, so it can be rendered like the final attempt. */
+    steps?: TestStep[];
+    stdout?: string[];
+    stderr?: string[];
+    attachments?: Attachment[];
+}
+export interface ReporterConfig {
+    outputDir?: string;
+    packageManager?: string;
+    projectName?: string;
+    testRunName?: string;
+    singleSummaryFile?: boolean;
+    theme?: string;
+    darkMode?: boolean;
+    enableHistory?: 'auto' | boolean;
+    minimalReport?: boolean;
+}
+export interface HistoryRun {
+    run_id: string;
+    run_name: string;
+    started_at: string;
+    run_duration_ms: number;
+    run_sequential_duration_ms?: number | null;
+    run_workers?: number;
+    run_total: number;
+    run_passed: number;
+    run_failed: number;
+    run_skipped: number;
+    run_timed_out: number;
+    run_interrupted: number;
+    pass_rate: number | null;
+    project_durations?: Record<string, number>;
+}
+export interface HistoryFlakyRow {
+    suite: string;
+    file: string;
+    title: string;
+    project: string;
+    failed_runs: number;
+    passed_runs: number;
+    recovered_by_retry: number;
+    total_runs: number;
+}
+export interface HistoryRegressionRow {
+    regressed_in: string;
+    regressed_at: string;
+    last_status: string;
+    last_run_at: string;
+    suite: string;
+    file: string;
+    title: string;
+    project: string;
+}
+export interface HistorySlowRow {
+    suite: string;
+    file: string;
+    title: string;
+    project: string;
+    avg_duration_ms?: number;
+    max_duration_ms?: number;
+    last_duration_ms?: number;
+    avg_ms?: number;
+    max_ms?: number;
+    last_ms?: number;
+    runs: number;
+}
+export interface HistoryFileRow {
+    run_id?: string;
+    started_at: string;
+    file: string;
+    total: number;
+    passed: number;
+    failed: number;
+    timed_out: number;
+    interrupted: number;
+    skipped: number;
+}
+export interface HistoryTestRow {
+    run_id?: string;
+    started_at: string;
+    suite: string;
+    file: string;
+    title: string;
+    project: string;
+    total: number;
+    passed: number;
+    failed: number;
+    timed_out: number;
+    interrupted: number;
+    skipped: number;
+    avg_duration_ms?: number;
+}
+export interface HistoryData {
+    generated_at: string;
+    runs: HistoryRun[];
+    flaky: HistoryFlakyRow[];
+    regressions: HistoryRegressionRow[];
+    slowest: HistorySlowRow[];
+    files?: HistoryFileRow[];
+    tests?: HistoryTestRow[];
+}

package/dist/utils.d.ts

@@ -0,0 +1,126 @@
+import type { TestStep as PwTestStep } from '@playwright/test/reporter';
+import type { existsSync as fsExistsSync, readFileSync as fsReadFileSync } from 'fs';
+import type { Attachment, Location, ResultSummary, TestCase, TestError, TestStep, TestSuite } from './types';
+export interface FsModule {
+    existsSync: typeof fsExistsSync;
+    readFileSync: typeof fsReadFileSync;
+}
+export declare function setFsModule(fsInstance: FsModule | null): void;
+export declare function getStepCodeSnippet(location: Location | null | undefined, fsModule?: FsModule | null): string | undefined;
+export declare function highlightJsTokens(code: string): string;
+export declare function highlightCodeLine(codeLine: string, status?: string): string;
+export declare function highlightCodeSnippet(snippet: string, status?: string): string;
+export declare function convertPlaywrightSteps(pwSteps: PwTestStep[], fsModule?: FsModule | null): TestStep[];
+export declare function sanitizeAnsi(str: string): string;
+export declare function parseAnsiToHtml(str: string): string;
+export declare function highlightExpectedReceived(str: string): string;
+export declare function escapeHTML(html: string): string;
+export declare function buildHierarchyForFile(fileName: string, cases: TestCase[]): TestSuite;
+export declare function buildSuitesFromCases(testCases: TestCase[]): TestSuite[];
+export declare function formatDuration(ms: number): string;
+export declare function formatDurationVerbose(ms?: number | null): string;
+export declare function formatDate(iso: string): string;
+/**
+ * Format a start and end ISO timestamp into a smart, non-repetitive date-time range string.
+ * e.g., "Sep 20, 2026 • 05:38:12 AM – 05:40:26 AM IST" (for same-day runs)
+ */
+export declare function formatDateRange(startIso: string, endIso?: string): string;
+/**
+ * Split an ISO timestamp into a human-readable date line ("Sep 18, 2026")
+ * and an AM/PM time line ("04:57 AM"). No time zone, for two-line chart labels.
+ */
+export declare function formatDateParts(iso: string): [string, string];
+export interface FailedTest {
+    title: string;
+    suiteTitle: string;
+    fileName: string;
+    duration: number;
+    type: string;
+    tags?: string[];
+    errors: TestError[];
+    testCase: TestCase;
+}
+export declare function extractFailedTests(suites: TestSuite[]): FailedTest[];
+export declare function collectAllCases(suites: TestSuite[]): TestCase[];
+export interface ProjectStats {
+    name: string;
+    total: number;
+    passed: number;
+    failed: number;
+    skipped: number;
+    timedOut: number;
+    interrupted: number;
+    passRate: number;
+    flakyCount: number;
+    flakyRate: number;
+    totalDuration: number;
+    avgDuration: number;
+    p95Duration: number;
+    medianDuration: number;
+    minDuration: number;
+    maxDuration: number;
+    uniqueFiles: number;
+    uniqueTagsCount: number;
+    speedMultiplier: number;
+    cases: TestCase[];
+}
+export interface ProjectExecutiveKPIs {
+    totalProjects: number;
+    mostStableProject: {
+        name: string;
+        passRate: number;
+        total: number;
+    } | null;
+    slowestProject: {
+        name: string;
+        totalDuration: number;
+        avgDuration: number;
+    } | null;
+    passRateParityDelta: number;
+    totalFlakyCount: number;
+    overallAvgDuration: number;
+}
+export declare function computeProjectStats(allCases: TestCase[]): ProjectStats[];
+export declare function computeProjectExecutiveKPIs(projectStats: ProjectStats[]): ProjectExecutiveKPIs;
+export declare function computePassRate(summary: ResultSummary): number;
+export declare function computeSlowestTest(allCases: TestCase[]): number;
+export declare function computeFastestTest(allCases: TestCase[]): number;
+export declare function getTotalTags(allCases: TestCase[]): number;
+export interface FileStats {
+    fileName: string;
+    total: number;
+    passed: number;
+    failed: number;
+    skipped: number;
+    timedOut: number;
+    interrupted: number;
+    totalDuration: number;
+    avgDuration: number;
+    flakyCount: number;
+}
+export declare function computeFileStats(allCases: TestCase[]): FileStats[];
+export declare function truncateFileName(fileName: string, maxLength?: number): string;
+export declare function truncateMiddlePath(filePath: string): string;
+/**
+ * Normalizes error messages and stack traces by masking dynamic tokens (timestamps,
+ * pointers, line numbers, ports, durations) so identical failure causes yield the same signature.
+ */
+export declare function normalizeErrorText(message: string, stack: string): string;
+/**
+ * Synchronous SHA-256 hash generator for string inputs.
+ */
+export declare function sha256Sync(str: string): string;
+export interface ErrorSignatureDetails {
+    hash: string;
+    shortHash: string;
+    representativeMessage: string;
+}
+export declare function getErrorSignature(test: FailedTest): ErrorSignatureDetails;
+export interface VisualDiffPair {
+    actualUrl: string;
+    expectedUrl: string;
+    diffUrl?: string;
+    name?: string;
+}
+export declare function extractVisualDiffPairs(attachments: Attachment[], getAttachmentUrl: (att: Attachment) => string | null): VisualDiffPair[];
+export declare function generateTerminalSummaryTable(summary: ResultSummary, projectName?: string, testRunName?: string): string;

package/package.json

@@ -0,0 +1,102 @@
+{
+  "name": "@arpanp/zen-reporter",
+  "private": false,
+  "version": "0.10.1",
+  "type": "module",
+  "description": "Beautiful test execution reports for Playwright",
+  "bin": {
+    "zen-reporter": "bin/zen-reporter.js",
+    "zr": "bin/zen-reporter.js"
+  },
+  "main": "dist/reporter.cjs",
+  "module": "dist/reporter.js",
+  "types": "dist/reporter.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/reporter.d.ts",
+      "import": "./dist/reporter.js",
+      "require": "./dist/reporter.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "bin",
+    "dist"
+  ],
+  "author": {
+    "name": "Arpan Patelia",
+    "email": "arpan.is@gmail.com"
+  },
+  "license": "MIT",
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build && vite build --config vite.reporter.config.ts && tsc -p tsconfig.lib.json",
+    "preview": "vite preview",
+    "test": "npx playwright test",
+    "report": "npm run build && node scripts/generate_report.js",
+    "show": "node bin/zen-reporter.js show",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "typecheck": "tsc --noEmit",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "prepare": "husky",
+    "prepack": "npm run build",
+    "prepublish": "npm run build"
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx}": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "*.{json,css,md,yml,yaml,html}": [
+      "prettier --write"
+    ]
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "peerDependencies": {
+    "@playwright/test": ">=1.63.0",
+    "@duckdb/node-api": "1.5.5-r.5"
+  },
+  "peerDependenciesMeta": {
+    "@playwright/test": {
+      "optional": true
+    },
+    "@duckdb/node-api": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@eslint-react/eslint-plugin": "^5.20.8",
+    "@duckdb/node-api": "1.5.5-r.5",
+    "@eslint/js": "^10.0.1",
+    "@eslint/json": "^2.1.0",
+    "@eslint/markdown": "^8.0.3",
+    "@playwright/cli": "^0.1.21",
+    "@playwright/test": "^1.63.0",
+    "@tailwindcss/postcss": "^4.3.3",
+    "@types/node": "^26.6.2",
+    "@types/react": "^19.3.0",
+    "@types/react-dom": "^19.3.0",
+    "@vitejs/plugin-react": "^6.1.1",
+    "autoprefixer": "^10.6.1",
+    "eslint": "^10.11.0",
+    "eslint-config-prettier": "^10.1.8",
+    "globals": "^17.12.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^17.5.1",
+    "postcss": "^8.5.28",
+    "prettier": "^3.9.9",
+    "react": "^19.3.0",
+    "react-dom": "^19.3.0",
+    "react-is": "^19.3.0",
+    "recharts": "^3.10.1",
+    "tailwindcss": "^4.3.3",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.70.1",
+    "vite": "^8.3.1",
+    "vite-plugin-singlefile": "^2.3.3"
+  }
+}