prowl-tools 0.1.3

package/dist/lib.js

@@ -0,0 +1,55 @@
+import {
+  DEFAULT_FLAKY_THRESHOLD,
+  analyzePage,
+  buildHealCandidates,
+  clusterFailures,
+  computeFlakeScore,
+  extractFailures,
+  extractSelectorIntent,
+  generateHunt,
+  healSelector,
+  interpolateHunt,
+  rankFlaky,
+  readHistory,
+  readHuntHistory,
+  runHunt,
+  runSuite,
+  updateBacklogFromSuite
+} from "./chunk-T7YLXF6X.js";
+import {
+  configSchema,
+  huntSchema,
+  listHunts,
+  loadConfig,
+  loadHunt,
+  loadHuntMeta,
+  loadHuntTags,
+  stepSchema
+} from "./chunk-NXXGJOBG.js";
+export {
+  DEFAULT_FLAKY_THRESHOLD,
+  analyzePage,
+  buildHealCandidates,
+  clusterFailures,
+  computeFlakeScore,
+  configSchema,
+  extractFailures,
+  extractSelectorIntent,
+  generateHunt,
+  healSelector,
+  huntSchema,
+  interpolateHunt,
+  listHunts,
+  loadConfig,
+  loadHunt,
+  loadHuntMeta,
+  loadHuntTags,
+  rankFlaky,
+  readHistory,
+  readHuntHistory,
+  runHunt,
+  runSuite,
+  stepSchema,
+  updateBacklogFromSuite
+};
+//# sourceMappingURL=lib.js.map

package/dist/lib.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/loader-5RDNTJHH.js

@@ -0,0 +1,27 @@
+import {
+  CONFIG_DIR,
+  LEGACY_CONFIG_DIR,
+  ensureAllowedDomain,
+  findConfigPath,
+  listHunts,
+  loadConfig,
+  loadHunt,
+  loadHuntMeta,
+  loadHuntTags,
+  resolveViewport,
+  warnLegacyConfigDir
+} from "./chunk-NXXGJOBG.js";
+export {
+  CONFIG_DIR,
+  LEGACY_CONFIG_DIR,
+  ensureAllowedDomain,
+  findConfigPath,
+  listHunts,
+  loadConfig,
+  loadHunt,
+  loadHuntMeta,
+  loadHuntTags,
+  resolveViewport,
+  warnLegacyConfigDir
+};
+//# sourceMappingURL=loader-5RDNTJHH.js.map

package/dist/loader-5RDNTJHH.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/visual-FSARM2JS.js

@@ -0,0 +1,46 @@
+// src/runner/visual.ts
+import fs from "fs";
+import path from "path";
+import { PNG } from "pngjs";
+import pixelmatch from "pixelmatch";
+async function compareScreenshots(baselinePath, currentPath, diffPath, threshold) {
+  const baselineData = PNG.sync.read(fs.readFileSync(baselinePath));
+  const currentData = PNG.sync.read(fs.readFileSync(currentPath));
+  const { width, height } = baselineData;
+  if (currentData.width !== width || currentData.height !== height) {
+    const diff2 = new PNG({ width, height });
+    fs.writeFileSync(diffPath, PNG.sync.write(diff2));
+    return {
+      match: false,
+      diffPercentage: 1,
+      diffImagePath: diffPath
+    };
+  }
+  const diff = new PNG({ width, height });
+  const diffPixels = pixelmatch(
+    baselineData.data,
+    currentData.data,
+    diff.data,
+    width,
+    height,
+    { threshold: 0.1 }
+  );
+  const totalPixels = width * height;
+  const diffPercentage = diffPixels / totalPixels;
+  fs.writeFileSync(diffPath, PNG.sync.write(diff));
+  return {
+    match: diffPercentage <= threshold,
+    diffPercentage,
+    diffImagePath: diffPath
+  };
+}
+function ensureBaselineDir(configDir) {
+  const baselineDir = path.join(configDir, "baselines");
+  fs.mkdirSync(baselineDir, { recursive: true });
+  return baselineDir;
+}
+export {
+  compareScreenshots,
+  ensureBaselineDir
+};
+//# sourceMappingURL=visual-FSARM2JS.js.map

package/dist/visual-FSARM2JS.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/runner/visual.ts"],"sourcesContent":["import fs from \"node:fs\";\nimport path from \"node:path\";\nimport { PNG } from \"pngjs\";\nimport pixelmatch from \"pixelmatch\";\n\nexport type ComparisonResult = {\n  match: boolean;\n  diffPercentage: number;\n  diffImagePath?: string;\n};\n\nexport async function compareScreenshots(\n  baselinePath: string,\n  currentPath: string,\n  diffPath: string,\n  threshold: number\n): Promise<ComparisonResult> {\n  const baselineData = PNG.sync.read(fs.readFileSync(baselinePath));\n  const currentData = PNG.sync.read(fs.readFileSync(currentPath));\n\n  const { width, height } = baselineData;\n\n  if (currentData.width !== width || currentData.height !== height) {\n    const diff = new PNG({ width, height });\n    fs.writeFileSync(diffPath, PNG.sync.write(diff));\n    return {\n      match: false,\n      diffPercentage: 1,\n      diffImagePath: diffPath\n    };\n  }\n\n  const diff = new PNG({ width, height });\n  const diffPixels = pixelmatch(\n    baselineData.data,\n    currentData.data,\n    diff.data,\n    width,\n    height,\n    { threshold: 0.1 }\n  );\n\n  const totalPixels = width * height;\n  const diffPercentage = diffPixels / totalPixels;\n\n  fs.writeFileSync(diffPath, PNG.sync.write(diff));\n\n  return {\n    match: diffPercentage <= threshold,\n    diffPercentage,\n    diffImagePath: diffPath\n  };\n}\n\nexport function ensureBaselineDir(configDir: string): string {\n  const baselineDir = path.join(configDir, \"baselines\");\n  fs.mkdirSync(baselineDir, { recursive: true });\n  return baselineDir;\n}\n"],"mappings":";AAAA,OAAO,QAAQ;AACf,OAAO,UAAU;AACjB,SAAS,WAAW;AACpB,OAAO,gBAAgB;AAQvB,eAAsB,mBACpB,cACA,aACA,UACA,WAC2B;AAC3B,QAAM,eAAe,IAAI,KAAK,KAAK,GAAG,aAAa,YAAY,CAAC;AAChE,QAAM,cAAc,IAAI,KAAK,KAAK,GAAG,aAAa,WAAW,CAAC;AAE9D,QAAM,EAAE,OAAO,OAAO,IAAI;AAE1B,MAAI,YAAY,UAAU,SAAS,YAAY,WAAW,QAAQ;AAChE,UAAMA,QAAO,IAAI,IAAI,EAAE,OAAO,OAAO,CAAC;AACtC,OAAG,cAAc,UAAU,IAAI,KAAK,MAAMA,KAAI,CAAC;AAC/C,WAAO;AAAA,MACL,OAAO;AAAA,MACP,gBAAgB;AAAA,MAChB,eAAe;AAAA,IACjB;AAAA,EACF;AAEA,QAAM,OAAO,IAAI,IAAI,EAAE,OAAO,OAAO,CAAC;AACtC,QAAM,aAAa;AAAA,IACjB,aAAa;AAAA,IACb,YAAY;AAAA,IACZ,KAAK;AAAA,IACL;AAAA,IACA;AAAA,IACA,EAAE,WAAW,IAAI;AAAA,EACnB;AAEA,QAAM,cAAc,QAAQ;AAC5B,QAAM,iBAAiB,aAAa;AAEpC,KAAG,cAAc,UAAU,IAAI,KAAK,MAAM,IAAI,CAAC;AAE/C,SAAO;AAAA,IACL,OAAO,kBAAkB;AAAA,IACzB;AAAA,IACA,eAAe;AAAA,EACjB;AACF;AAEO,SAAS,kBAAkB,WAA2B;AAC3D,QAAM,cAAc,KAAK,KAAK,WAAW,WAAW;AACpD,KAAG,UAAU,aAAa,EAAE,WAAW,KAAK,CAAC;AAC7C,SAAO;AACT;","names":["diff"]}

package/examples/config.yml

@@ -0,0 +1,41 @@
+# Prowl Configuration
+# This file controls how Prowl runs your hunts.
+# All options shown with their default values.
+
+# Target application — the base URL for all hunt navigation
+target:
+  url: "http://localhost:3000"
+
+# Browser settings
+browser:
+  headless: true       # Set to false or use --headed to see the browser
+  slowMo: 0            # Milliseconds to wait between actions (useful for debugging)
+  timeout: 30000       # Default timeout for page operations (30s)
+
+# Artifact generation — what gets saved per run
+artifacts:
+  screenshots: "on-failure"  # "on-failure" or "all" (screenshot every step)
+  networkHar: false          # Save network activity as HAR file
+  console: true              # Save browser console output
+
+# Hunt-level assertions — applied after every hunt's steps complete
+assertions:
+  noConsoleErrors: true      # Fail if browser console has errors
+  noNetworkErrors: true      # Fail if any HTTP response >= 400
+  maxTotalTimeMs: 30000      # Max total time for all steps (30s)
+  networkIgnorePatterns: []  # URL patterns to ignore for network error checks
+
+# Safety guardrails — prevent accidental damage
+guardrails:
+  maxSteps: 50               # Maximum steps per hunt
+  allowedDomains:            # Only navigate to these domains
+    - "localhost"
+    - "127.0.0.1"
+    - "0.0.0.0"
+  forbiddenSelectors:        # Selectors that steps cannot interact with
+    - "[data-danger]"
+    - ".delete-btn"
+
+# Auth state — captured by `prowl login`, used to skip login in hunts
+auth:
+  storageStatePath: ".prowl/auth-state.json"

package/examples/hunts/hello.yml

@@ -0,0 +1,20 @@
+# Hello Hunt — Your First Prowl Test
+# ---
+# This minimal hunt verifies your target app is running and the page loads.
+# Customize the URL path and expected text to match your app.
+#
+# Run it:  prowl run hello
+#
+# Browse more hunt templates at https://hub.prowl.tools
+
+name: hello
+description: Verify the target app loads successfully
+
+steps:
+  - navigate: "/"
+
+  - waitForNetworkIdle:
+      timeout: 5000
+
+assertions:
+  - noConsoleErrors: true

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "prowl-tools",
+  "version": "0.1.3",
+  "description": "CLI-first QA testing tool for deterministic Playwright flows.",
+  "type": "module",
+  "license": "Apache-2.0",
+  "author": "Michael Tookes",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/prowl-tools/prowl.git"
+  },
+  "homepage": "https://prowl.tools",
+  "bugs": {
+    "url": "https://github.com/prowl-tools/prowl/issues"
+  },
+  "keywords": [
+    "testing",
+    "qa",
+    "playwright",
+    "yaml",
+    "e2e",
+    "browser-testing",
+    "automation",
+    "web-testing",
+    "cli"
+  ],
+  "main": "dist/lib.cjs",
+  "module": "dist/lib.js",
+  "types": "dist/lib.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/lib.d.ts",
+        "default": "./dist/lib.js"
+      },
+      "require": {
+        "types": "./dist/lib.d.cts",
+        "default": "./dist/lib.cjs"
+      }
+    }
+  },
+  "bin": {
+    "prowl": "dist/index.js"
+  },
+  "files": [
+    "dist",
+    "examples",
+    "LICENSE",
+    "README.md",
+    "NOTICE"
+  ],
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.29.0",
+    "chalk": "^5.3.0",
+    "commander": "^12.1.0",
+    "dotenv": "^16.6.1",
+    "ora": "^8.1.1",
+    "pixelmatch": "^7.1.0",
+    "playwright": "^1.50.1",
+    "pngjs": "^7.0.0",
+    "yaml": "^2.6.1",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.1",
+    "@types/pngjs": "^6.0.5",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
+    "eslint": "^8.57.1",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.3",
+    "vitest": "^2.1.8"
+  }
+}