qa-intelligence 1.0.0 → 1.1.0

package/README.md

@@ -18,9 +18,11 @@ Use it **without the framework template** — install the package into any exist
 npm install qa-intelligence @playwright/test
 ```
 
+npm automatically installs peer dependencies (`typescript`, `@types/node`) — no separate dev-deps step needed.
+
 ---
 
-## Quick setup (existing project)
+## Setup (existing Playwright project)
 
 ### 1. Environment (`.env`)
 
@@ -31,7 +33,26 @@ PW_WORKERS=2
 PW_RETRIES=1
 ```
 
-### 2. `playwright.config.ts`
+### 2. `tsconfig.json` (TypeScript projects)
+
+```json
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "Node16",
+    "moduleResolution": "Node16",
+    "strict": true,
+    "esModuleInterop": true,
+    "types": ["node"],
+    "skipLibCheck": true
+  },
+  "include": ["tests/**/*", "playwright.config.ts"]
+}
+```
+
+> `module` and `moduleResolution` must both be `"Node16"` so TypeScript resolves the package `exports` map.
+
+### 3. `playwright.config.ts`
 
 ```ts
 import { defineConfig } from "@playwright/test";
@@ -53,7 +74,7 @@ export default defineConfig({
 });
 ```
 
-### 3. Write tests
+### 4. Write tests
 
 Always import `test` from the package — **not** directly from Playwright:
 
@@ -73,7 +94,7 @@ import { step } from "qa-intelligence/playwright/steps";
 import { BasePage } from "qa-intelligence/playwright/basePage";
 ```
 
-### 4. What you provide
+### 5. What you provide
 
 | You write | Package provides |
 |-----------|------------------|
@@ -179,6 +200,12 @@ The template uses this package under the hood.
 
 ---
 
+## Author
+
+Built as the intelligence engine behind QA automation — Playwright hooks, AI failure analysis, and PR-aware CI. If you use this package, consider leaving a star or linking back—contributions are welcome.
+
+---
+
 ## License
 
 MIT

package/dist/ai/failureAnalyzer.d.ts

@@ -0,0 +1,2 @@
+export declare function analyzeFailureFile(jsonFilePath: string): Promise<string | null>;
+export declare function analyzeLatestFailure(): Promise<string | null>;

package/dist/cli/diff.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli/history.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+/**
+ * Enriches failure-diff with recurrence: first_seen, occurrence_count.
+ * Persists run history in a cache file for the next run.
+ */
+export {};

package/dist/cli/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli/postComment.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/config/env.d.ts

@@ -0,0 +1,7 @@
+export declare const env: {
+    ENV: "dev" | "staging" | "prod";
+    BASE_URL: string;
+    HEADLESS: boolean;
+    PW_WORKERS: number;
+    PW_RETRIES: number;
+};

package/dist/lib/computeDiff.d.ts

@@ -0,0 +1,14 @@
+export interface Failure {
+    file: string;
+    line: number;
+    failure_type: string;
+    severity: string;
+    confidence: number;
+    is_flaky_suspected?: boolean;
+}
+export declare function computeDiff(baselineDir: string, currentDir: string): {
+    newFailures: Failure[];
+    unchangedFailures: Failure[];
+    fixedFailures: Failure[];
+    blockingFailures: Failure[];
+};

package/dist/lib/failureReader.d.ts

@@ -0,0 +1,10 @@
+import { AiFailure, FailureKey } from "./types";
+export type ReadFailuresOptions = {
+    rootDir: string;
+};
+export declare function failureKey(f: AiFailure): FailureKey;
+export declare function readFailures(options: ReadFailuresOptions): {
+    failures: AiFailure[];
+    byKey: Map<FailureKey, AiFailure>;
+    sourceFiles: string[];
+};

package/dist/lib/format.d.ts

@@ -0,0 +1,3 @@
+import { DiffResult } from "./types";
+export declare function formatDiffComment(diff: DiffResult): string;
+export declare function hasFailureChanges(diff: DiffResult): boolean;

package/dist/lib/types.d.ts

@@ -0,0 +1,21 @@
+export type Severity = "low" | "medium" | "high";
+export type FailureType = "assertion_mismatch" | "selector_not_found" | "timeout" | "navigation_failure" | "environment_error" | "unknown";
+export type AiFailure = {
+    file: string;
+    line: number;
+    failure_type: FailureType | string;
+    expected?: number | string;
+    received?: number | string;
+    is_flaky_suspected?: boolean;
+    severity: Severity | string;
+    confidence: number;
+    first_seen?: string;
+    occurrence_count?: number;
+};
+export type FailureKey = string;
+export type DiffResult = {
+    newFailures: AiFailure[];
+    unchangedFailures: AiFailure[];
+    fixedFailures: AiFailure[];
+    blockingFailures?: AiFailure[];
+};

package/dist/playwright/basePage.d.ts

@@ -0,0 +1,6 @@
+import { Page } from "@playwright/test";
+export declare class BasePage {
+    protected page: Page;
+    constructor(page: Page);
+    protected navigate(path: string): Promise<void>;
+}

package/dist/playwright/baseTest.d.ts

@@ -0,0 +1,5 @@
+import { expect } from "@playwright/test";
+import { env } from "../config/env";
+import "./testHooks";
+export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+export { expect, env };

package/dist/playwright/globalSetup.d.ts

@@ -0,0 +1 @@
+export default function globalSetup(): Promise<void>;

package/dist/playwright/globalTeardown.d.ts

@@ -0,0 +1 @@
+export default function globalTeardown(): Promise<void>;

package/dist/playwright/steps.d.ts

@@ -0,0 +1 @@
+export declare function step<T>(name: string, fn: () => Promise<T>): Promise<T>;

package/dist/playwright/testHooks.d.ts

@@ -0,0 +1 @@
+export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;

package/dist/reporting/logger.d.ts

@@ -0,0 +1,7 @@
+export declare const logger: {
+    info: (msg: string) => void;
+    warn: (msg: string) => void;
+    error: (msg: string) => void;
+    debug: (msg: string) => void;
+};
+export declare function getLogFilePath(): string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "qa-intelligence",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "engines": {
         "node": ">=18"
     },
@@ -25,15 +25,35 @@
     "type": "commonjs",
     "main": "dist/index.js",
     "exports": {
-        "./playwright": "./dist/playwright/baseTest.js",
-        "./playwright/globalSetup": "./dist/playwright/globalSetup.js",
-        "./playwright/globalTeardown": "./dist/playwright/globalTeardown.js",
-        "./playwright/basePage": "./dist/playwright/basePage.js",
-        "./playwright/steps": "./dist/playwright/steps.js",
-        "./config/env": "./dist/config/env.js"
+        "./playwright": {
+            "types": "./dist/playwright/baseTest.d.ts",
+            "default": "./dist/playwright/baseTest.js"
+        },
+        "./playwright/globalSetup": {
+            "types": "./dist/playwright/globalSetup.d.ts",
+            "default": "./dist/playwright/globalSetup.js"
+        },
+        "./playwright/globalTeardown": {
+            "types": "./dist/playwright/globalTeardown.d.ts",
+            "default": "./dist/playwright/globalTeardown.js"
+        },
+        "./playwright/basePage": {
+            "types": "./dist/playwright/basePage.d.ts",
+            "default": "./dist/playwright/basePage.js"
+        },
+        "./playwright/steps": {
+            "types": "./dist/playwright/steps.d.ts",
+            "default": "./dist/playwright/steps.js"
+        },
+        "./config/env": {
+            "types": "./dist/config/env.d.ts",
+            "default": "./dist/config/env.js"
+        }
     },
     "peerDependencies": {
-        "@playwright/test": ">=1.40.0"
+        "@playwright/test": ">=1.40.0",
+        "typescript": ">=5.0.0",
+        "@types/node": ">=18.0.0"
     },
     "bin": {
         "qa-intelligence": "dist/cli/index.js",