pw-sanitizer 0.1.0

package/README.md

@@ -0,0 +1,415 @@
+# playwright-sanitizer
+
+Post-process Playwright HTML reports and trace files to **redact secrets** and **remove noisy steps** before sharing or archiving.
+
+---
+
+## Why
+
+Playwright's HTML reports and `.zip` trace files can contain sensitive data — auth headers, API keys, tokens, passwords — embedded in network request logs, action parameters, and step metadata. `playwright-sanitizer` scans those files after your test run and replaces or strips the sensitive content so they are safe to store in CI artifacts, share with teammates, or upload to a dashboard.
+
+It also lets you delete repetitive or internal steps (e.g. health-check pings, internal logging actions) that create noise in the trace viewer.
+
+---
+
+## Features
+
+- Redact secrets in HTML reports and trace `.zip` files by key name, value pattern, or both
+- Remove entire steps from traces with configurable timestamp repair
+- Three output modes: `copy` (safe default), `in-place`, `side-by-side`
+- Zero built-in patterns — you declare exactly what gets touched, nothing else runs
+- Dry-run mode to preview changes without writing files
+- Integrates as a Playwright `globalTeardown` so it runs automatically after every test run
+- Programmatic API for custom pipelines
+- Summary table printed to the console (and optionally written as JSON)
+
+---
+
+## Requirements
+
+- Node.js >= 18
+
+---
+
+## Installation
+
+```bash
+npm install --save-dev playwright-sanitizer
+```
+
+Screenshot redaction inside trace files requires the optional `sharp` dependency:
+
+```bash
+npm install --save-dev sharp
+```
+
+---
+
+## Quick start
+
+### 1. Create a config file
+
+```ts
+// playwright-sanitizer.config.ts
+import type { SanitizerConfig } from 'playwright-sanitizer';
+
+const config: SanitizerConfig = {
+  redact: {
+    patterns: [
+      {
+        id: 'auth-header',
+        description: 'Authorization header value',
+        key: 'authorization',
+        severity: 'critical',
+      },
+      {
+        id: 'api-key',
+        key: /x-api-key/i,
+        severity: 'high',
+      },
+    ],
+  },
+  remove: {
+    rules: [
+      {
+        label: 'health-check pings',
+        url: /\/health$/,
+      },
+    ],
+  },
+};
+
+export default config;
+```
+
+### 2. Run the CLI
+
+```bash
+npx playwright-sanitizer
+```
+
+Sanitized files are written to `./sanitized-report` by default. Originals are untouched.
+
+---
+
+## Configuration
+
+Config is auto-discovered in this priority order:
+
+| Priority | Source |
+|----------|--------|
+| 1 | `--config <path>` CLI flag |
+| 2 | `playwright-sanitizer.config.ts` |
+| 3 | `playwright-sanitizer.config.js` |
+| 4 | `playwright-sanitizer.config.json` |
+| 5 | `sanitizer` key inside `playwright.config.ts` |
+
+### Full config reference
+
+```ts
+import type { SanitizerConfig } from 'playwright-sanitizer';
+
+const config: SanitizerConfig = {
+  redact: {
+    // Inline patterns (merged with patternFiles)
+    patterns: [
+      {
+        id: 'my-token',           // REQUIRED — unique identifier shown in summary
+        description: 'API token', // optional, shown in summary output
+        key: 'x-api-token',       // match field/header name (string = case-insensitive exact match)
+        valuePattern: /^ey/,      // match field value (RegExp) — when set alongside key, BOTH must match
+        severity: 'high',         // 'low' | 'medium' | 'high' | 'critical'  (informational only)
+      },
+    ],
+
+    // External pattern files (.ts, .js, or .json) — merged with inline patterns
+    patternFiles: ['./secrets/patterns.ts'],
+
+    // Replacement string. Default: '[REDACTED]'
+    placeholder: '[REDACTED]',
+
+    // Partial redaction: keep first N and last N characters, mask the middle with '***'
+    // Example: { prefix: 4, suffix: 4 } on 'Bearer eyJhbGci...' => 'Bear***..ci'
+    // Takes priority over placeholder when set.
+    partialRedaction: { prefix: 4, suffix: 4 },
+  },
+
+  remove: {
+    // Inline rules (merged with ruleFiles)
+    rules: [
+      {
+        label: 'noisy health checks',  // REQUIRED — shown in summary and dry-run log
+        stepName: /health/i,           // match step name shown in the HTML report
+        selector: '[data-testid="spinner"]', // match CSS selector or XPath locator
+        url: /\/internal\//,           // match network request URL
+        actionType: 'waitForTimeout',  // match Playwright internal action type
+
+        // Safety guard: only remove if this step appears at least N times
+        // consecutively within a test. Logs a warning and skips removal if not met.
+        minConsecutiveOccurrences: 3,
+      },
+    ],
+
+    // External rule files (.ts, .js, or .json) — merged with inline rules
+    ruleFiles: ['./rules/remove-rules.ts'],
+
+    // How to handle time after a step is deleted.
+    // 'absorb-into-prev' (default): preceding step absorbs the deleted duration
+    // 'absorb-into-next': following step's start time shifts back
+    // 'gap': no adjustment; a gap appears in the timeline
+    timestampStrategy: 'absorb-into-prev',
+
+    // What to do with child steps when a parent is removed.
+    // 'remove-children' (default): children are also removed
+    // 'keep-shell': parent is kept as an empty container
+    orphanStrategy: 'remove-children',
+
+    // Preview mode — log what would be removed but don't write any files
+    dryRun: false,
+  },
+
+  output: {
+    reportDir: './playwright-report', // where to find HTML reports. Default: './playwright-report'
+    traceDir: './test-results',       // where to find trace zips. Default: './test-results'
+
+    // Output mode:
+    // 'copy' (default): write sanitized files to dir, originals untouched
+    // 'in-place': overwrite original files (ensure they are version-controlled!)
+    // 'side-by-side': write '<name>.sanitized.<ext>' next to each original
+    mode: 'copy',
+
+    dir: './sanitized-report', // destination for 'copy' mode. Default: './sanitized-report'
+
+    processReports: true,        // set to false to skip HTML report processing
+    processTraces: true,         // set to false to skip trace file processing
+    redactScreenshots: false,    // redact screenshots in traces (requires 'sharp')
+  },
+
+  reporting: {
+    summary: true,                              // print summary table after processing. Default: true
+    summaryFile: './sanitization-summary.json', // optional — write summary as JSON to this path
+    logLevel: 'normal',                         // 'silent' | 'normal' | 'verbose'
+  },
+};
+
+export default config;
+```
+
+---
+
+## External pattern and rule files
+
+For large teams, keep patterns and rules in dedicated files so they can be versioned and shared across projects:
+
+```ts
+// secrets/patterns.ts
+import type { RedactPattern } from 'playwright-sanitizer';
+
+const patterns: RedactPattern[] = [
+  { id: 'auth-header', key: 'authorization', severity: 'critical' },
+  { id: 'cookie',      key: 'cookie',        severity: 'high' },
+  { id: 'set-cookie',  key: 'set-cookie',    severity: 'high' },
+];
+
+export default patterns;
+```
+
+```ts
+// playwright-sanitizer.config.ts
+export default {
+  redact: { patternFiles: ['./secrets/patterns.ts'] },
+};
+```
+
+JSON files are also supported. Note that RegExp is not available in JSON — strings are matched as case-insensitive exact key names:
+
+```json
+[
+  { "id": "auth-header", "key": "authorization", "severity": "critical" },
+  { "id": "api-key",     "key": "x-api-key",     "severity": "high" }
+]
+```
+
+---
+
+## CLI reference
+
+```
+Usage: playwright-sanitizer [options]
+
+Options:
+  -c, --config <path>          Path to config file
+  -r, --report <path>          HTML report directory (default: "./playwright-report")
+  -t, --traces <path>          Trace directory (default: "./test-results")
+  -o, --output <path>          Output directory (copy mode)
+      --in-place               Overwrite original files
+      --patterns <path...>     One or more pattern files
+      --placeholder <string>   Redaction placeholder (default: "[REDACTED]")
+      --dry-run                Log changes without writing files
+      --no-traces              Skip trace file processing
+      --no-reports             Skip HTML report processing
+      --summary-output <path>  Write JSON summary to file
+      --log-level <level>      silent | normal | verbose (default: "normal")
+  -V, --version                Display version number
+  -h, --help                   Display help
+```
+
+### Examples
+
+```bash
+# Auto-discover config and run with defaults
+npx playwright-sanitizer
+
+# Use a specific config file
+npx playwright-sanitizer --config ./ci/sanitizer.config.ts
+
+# Overwrite originals (ensure files are version-controlled)
+npx playwright-sanitizer --in-place
+
+# Preview without writing any files
+npx playwright-sanitizer --dry-run --log-level verbose
+
+# Point to non-default directories
+npx playwright-sanitizer --report ./reports --traces ./artifacts/traces --output ./sanitized
+
+# Write a machine-readable summary for CI artifact ingestion
+npx playwright-sanitizer --summary-output ./sanitization-summary.json
+```
+
+---
+
+## Playwright globalTeardown integration
+
+Register the sanitizer as a Playwright `globalTeardown` and it runs automatically after every test suite:
+
+```ts
+// playwright.config.ts
+import { defineConfig } from '@playwright/test';
+
+export default defineConfig({
+  globalTeardown: require.resolve('playwright-sanitizer/teardown'),
+  // ...rest of your config
+});
+```
+
+Config is auto-discovered as described above. Teardown failures are caught and logged — they will never mask your actual test results.
+
+### Embedding config in playwright.config.ts
+
+If you prefer a single config file, add a `sanitizer` key directly to your Playwright config:
+
+```ts
+// playwright.config.ts
+import { defineConfig } from '@playwright/test';
+import type { SanitizerConfig } from 'playwright-sanitizer';
+
+export default defineConfig({
+  globalTeardown: require.resolve('playwright-sanitizer/teardown'),
+
+  sanitizer: {
+    redact: {
+      patterns: [
+        { id: 'auth', key: 'authorization', severity: 'critical' },
+      ],
+    },
+    output: { mode: 'in-place' },
+  } satisfies SanitizerConfig,
+});
+```
+
+---
+
+## Programmatic API
+
+```ts
+import { sanitize, redactReport, redactTrace } from 'playwright-sanitizer';
+
+// Process all reports and traces using auto-discovered config
+const results = await sanitize();
+
+// Pass a config object directly (skips file discovery)
+const results = await sanitize({
+  redact: { patterns: [{ id: 'token', key: 'x-token' }] },
+  output: { mode: 'copy', dir: './out' },
+});
+
+// Process a single HTML report
+const result = await redactReport('./playwright-report/index.html', config);
+
+// Process a single trace zip
+const result = await redactTrace('./test-results/my-test/trace.zip', config);
+```
+
+Each call returns a `ProcessResult` (or an array of them for `sanitize()`):
+
+```ts
+interface ProcessResult {
+  file: string;
+  redactionsApplied: number;
+  stepsRemoved: number;
+  timestampRepairs: number;
+  redactionMatches: Array<{ keyPath: string; patternId: string }>;
+  removalMatches: Array<{ index: number; ruleLabel: string; event: TraceEvent }>;
+}
+```
+
+---
+
+## Output modes
+
+| Mode | Behaviour |
+|------|-----------|
+| `copy` (default) | Writes sanitized files to `output.dir` (`./sanitized-report`). Originals are never touched. |
+| `in-place` | Overwrites original files. A warning is printed. Use only with version control. |
+| `side-by-side` | Creates `<name>.sanitized.<ext>` next to each original file. |
+
+---
+
+## How redaction works
+
+Redaction walks every JSON structure inside the HTML report's embedded data and the trace file's event entries. For each field encountered, the declared patterns are checked:
+
+1. If `key` is a **string** — matched case-insensitively as an exact field name.
+2. If `key` is a **RegExp** — tested against the field name.
+3. If `valuePattern` is provided — both `key` and `valuePattern` must match (AND logic).
+4. The matched value is replaced with `placeholder`, or a partial redaction if `partialRedaction` is configured.
+
+No built-in patterns are ever applied. Only what you declare runs.
+
+---
+
+## How step removal works
+
+Step removal operates on the trace event tree inside each `.zip` file:
+
+1. Each event is tested against your declared rules (`stepName`, `selector`, `url`, `actionType`).
+2. Matching events are collected and removed from the event list.
+3. Timestamps of surrounding events are adjusted according to `timestampStrategy` to keep the timeline coherent.
+4. Child steps of removed parents are handled according to `orphanStrategy`.
+
+The `minConsecutiveOccurrences` safety guard prevents accidentally removing a step that only appears occasionally — if the actual consecutive count is below the threshold, the step is **not** removed and a warning is logged instead.
+
+---
+
+## CI integration example
+
+```yaml
+# .github/workflows/test.yml
+- name: Run Playwright tests
+  run: npx playwright test
+
+- name: Sanitize Playwright artifacts
+  run: npx playwright-sanitizer --summary-output sanitization-summary.json
+
+- name: Upload sanitized report
+  uses: actions/upload-artifact@v4
+  with:
+    name: playwright-report
+    path: sanitized-report/
+```
+
+---
+
+## License
+
+MIT

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,113 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const loader_js_1 = require("./config/loader.js");
+const index_js_1 = require("./index.js");
+const program = new commander_1.Command();
+program
+    .name('playwright-sanitizer')
+    .description('Post-process Playwright HTML reports and trace files to redact secrets and remove noisy steps')
+    .version('0.1.0')
+    .option('-c, --config <path>', 'Path to config file')
+    .option('-r, --report <path>', 'HTML report directory', './playwright-report')
+    .option('-t, --traces <path>', 'Trace directory', './test-results')
+    .option('-o, --output <path>', 'Output directory (for copy mode)')
+    .option('--in-place', 'Overwrite original files')
+    .option('--patterns <path...>', 'One or more pattern files (repeatable)')
+    .option('--placeholder <string>', 'Redaction placeholder', '[REDACTED]')
+    .option('--dry-run', 'Log changes without writing files')
+    .option('--no-traces', 'Skip trace file processing')
+    .option('--no-reports', 'Skip HTML report processing')
+    .option('--summary-output <path>', 'Write JSON summary to file')
+    .option('--log-level <level>', 'silent | normal | verbose', 'normal');
+program.action(async (opts) => {
+    try {
+        // Load config
+        const config = await (0, loader_js_1.loadConfig)(opts['config']);
+        // Apply CLI overrides
+        applyCliOverrides(config, opts);
+        await (0, index_js_1.sanitize)(config);
+        process.exit(0);
+    }
+    catch (err) {
+        if (err instanceof Error) {
+            console.error(`[FATAL] ${err.message}`);
+        }
+        else {
+            console.error(`[FATAL] ${String(err)}`);
+        }
+        process.exit(1);
+    }
+});
+/**
+ * Merges parsed CLI flag values into a {@link SanitizerConfig} object.
+ *
+ * CLI flags always take the highest priority — they overwrite any values
+ * that were loaded from a config file. Sections are created on-demand
+ * (e.g. `config.output` is initialised to `{}` if not already present).
+ *
+ * Flag → config field mapping:
+ * - `--report`         → `output.reportDir`
+ * - `--no-traces`      → `output.processTraces = false`
+ * - `--no-reports`     → `output.processReports = false`
+ * - `--output`         → `output.dir` + `output.mode = 'copy'`
+ * - `--in-place`       → `output.mode = 'in-place'`
+ * - `--patterns`       → `redact.patternFiles`
+ * - `--placeholder`    → `redact.placeholder`
+ * - `--dry-run`        → `remove.dryRun = true`
+ * - `--log-level`      → `reporting.logLevel`
+ * - `--summary-output` → `reporting.summaryFile`
+ *
+ * @param config - The config object to mutate (loaded from file or empty).
+ * @param opts   - Raw parsed options from Commander.js (`program.opts()`).
+ */
+function applyCliOverrides(config, opts) {
+    // Output overrides
+    if (!config.output)
+        config.output = {};
+    if (opts['report']) {
+        config.output.reportDir = opts['report'];
+    }
+    if (opts['traces'] === false) {
+        config.output.processTraces = false;
+    }
+    if (opts['reports'] === false) {
+        config.output.processReports = false;
+    }
+    if (opts['output']) {
+        config.output.dir = opts['output'];
+        config.output.mode = 'copy';
+    }
+    if (opts['inPlace']) {
+        config.output.mode = 'in-place';
+    }
+    // Redact overrides
+    if (opts['patterns']) {
+        if (!config.redact)
+            config.redact = {};
+        config.redact.patternFiles = opts['patterns'];
+    }
+    if (opts['placeholder']) {
+        if (!config.redact)
+            config.redact = {};
+        config.redact.placeholder = opts['placeholder'];
+    }
+    // Remove overrides
+    if (opts['dryRun']) {
+        if (!config.remove)
+            config.remove = {};
+        config.remove.dryRun = true;
+    }
+    // Reporting overrides
+    if (!config.reporting)
+        config.reporting = {};
+    if (opts['logLevel']) {
+        config.reporting.logLevel = opts['logLevel'];
+    }
+    if (opts['summaryOutput']) {
+        config.reporting.summaryFile = opts['summaryOutput'];
+    }
+}
+program.parse();
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;AAEA,yCAAoC;AAEpC,kDAAgD;AAChD,yCAAsC;AAEtC,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,sBAAsB,CAAC;KAC5B,WAAW,CACV,+FAA+F,CAChG;KACA,OAAO,CAAC,OAAO,CAAC;KAChB,MAAM,CAAC,qBAAqB,EAAE,qBAAqB,CAAC;KACpD,MAAM,CACL,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,CACtB;KACA,MAAM,CACL,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,CACjB;KACA,MAAM,CAAC,qBAAqB,EAAE,kCAAkC,CAAC;KACjE,MAAM,CAAC,YAAY,EAAE,0BAA0B,CAAC;KAChD,MAAM,CACL,sBAAsB,EACtB,wCAAwC,CACzC;KACA,MAAM,CACL,wBAAwB,EACxB,uBAAuB,EACvB,YAAY,CACb;KACA,MAAM,CAAC,WAAW,EAAE,mCAAmC,CAAC;KACxD,MAAM,CAAC,aAAa,EAAE,4BAA4B,CAAC;KACnD,MAAM,CAAC,cAAc,EAAE,6BAA6B,CAAC;KACrD,MAAM,CACL,yBAAyB,EACzB,4BAA4B,CAC7B;KACA,MAAM,CACL,qBAAqB,EACrB,2BAA2B,EAC3B,QAAQ,CACT,CAAC;AAEJ,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,IAA6B,EAAE,EAAE;IACrD,IAAI,CAAC;QACH,cAAc;QACd,MAAM,MAAM,GAAG,MAAM,IAAA,sBAAU,EAAC,IAAI,CAAC,QAAQ,CAAuB,CAAC,CAAC;QAEtE,sBAAsB;QACtB,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAEhC,MAAM,IAAA,mBAAQ,EAAC,MAAM,CAAC,CAAC;QAEvB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;YACzB,OAAO,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1C,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CAAC,WAAW,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC1C,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAS,iBAAiB,CACxB,MAAuB,EACvB,IAA6B;IAE7B,mBAAmB;IACnB,IAAI,CAAC,MAAM,CAAC,MAAM;QAAE,MAAM,CAAC,MAAM,GAAG,EAAE,CAAC;IAEvC,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnB,MAAM,CAAC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAW,CAAC;IACrD,CAAC;IACD,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,KAAK,EAAE,CAAC;QAC7B,MAAM,CAAC,MAAM,CAAC,aAAa,GAAG,KAAK,CAAC;IACtC,CAAC;IACD,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,KAAK,EAAE,CAAC;QAC9B,MAAM,CAAC,MAAM,CAAC,cAAc,GAAG,KAAK,CAAC;IACvC,CAAC;IACD,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnB,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAW,CAAC;QAC7C,MAAM,CAAC,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC;IAC9B,CAAC;IACD,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QACpB,MAAM,CAAC,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC;IAClC,CAAC;IAED,mBAAmB;IACnB,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,MAAM;YAAE,MAAM,CAAC,MAAM,GAAG,EAAE,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,UAAU,CAAa,CAAC;IAC5D,CAAC;IACD,IAAI,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,MAAM,CAAC,MAAM;YAAE,MAAM,CAAC,MAAM,GAAG,EAAE,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAW,CAAC;IAC5D,CAAC;IAED,mBAAmB;IACnB,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnB,IAAI,CAAC,MAAM,CAAC,MAAM;YAAE,MAAM,CAAC,MAAM,GAAG,EAAE,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;IAC9B,CAAC;IAED,sBAAsB;IACtB,IAAI,CAAC,MAAM,CAAC,SAAS;QAAE,MAAM,CAAC,SAAS,GAAG,EAAE,CAAC;IAC7C,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QACrB,MAAM,CAAC,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC,UAAU,CAG9B,CAAC;IAChB,CAAC;IACD,IAAI,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;QAC1B,MAAM,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,eAAe,CAAW,CAAC;IACjE,CAAC;AACH,CAAC;AAID,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/dist/config/loader.d.ts

@@ -0,0 +1,30 @@
+import type { SanitizerConfig } from './types.js';
+/**
+ * Resolves and loads the sanitizer configuration.
+ *
+ * Config discovery priority (first match wins):
+ * 1. Explicit `configPath` (from `--config` CLI flag or programmatic call)
+ * 2. `playwright-sanitizer.config.ts` in `cwd`
+ * 3. `playwright-sanitizer.config.js` in `cwd`
+ * 4. `playwright-sanitizer.config.json` in `cwd`
+ * 5. `sanitizer` key inside `playwright.config.ts` / `playwright.config.js`
+ *
+ * If none of the above are found, the function calls `logger.fatal` which
+ * throws an `Error` with an actionable message.
+ *
+ * @param configPath - Optional explicit path to a config file.
+ *   When provided, auto-discovery is skipped entirely.
+ * @returns The resolved {@link SanitizerConfig}.
+ * @throws Calls `logger.fatal` (which throws) when no config can be found or loaded.
+ *
+ * @example
+ * ```ts
+ * // Auto-discover config in cwd
+ * const config = await loadConfig();
+ *
+ * // Load from an explicit path
+ * const config = await loadConfig('./configs/sanitizer.config.ts');
+ * ```
+ */
+export declare function loadConfig(configPath?: string): Promise<SanitizerConfig>;
+//# sourceMappingURL=loader.d.ts.map

package/dist/config/loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../../src/config/loader.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AA+FlD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAsB,UAAU,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CA6B9E"}