Programmatic API

import { runWebGuard } from "@promise-inc/web-guard";

async function checkQuality() {
  const result = await runWebGuard("https://your-site.com", {
    preset: "recommended",
    device: "mobile",
  });

  if (!result.passed) {
    console.error("Quality check failed!");
    for (const pillar of result.pillarResults) {
      if (!pillar.passed) {
        console.error(`  ${pillar.pillar}: ${pillar.violations.length} violations`);
      }
    }
    process.exit(1);
  }

  console.log("All pillars passed! Score:", result.score);
}

checkQuality();

// Main API — audit a URL across all pillars
async function runWebGuard(
  url: string,
  options?: Partial<WebGuardConfig>
): Promise<WebGuardResult>;

// Load configuration from project directory
function loadConfig(
  cwd: string,
  overrides?: Partial<WebGuardConfig>
): WebGuardConfig;

// Resolve a preset by name
function resolvePreset(name: string): Partial<WebGuardConfig>;

// Run the full audit with a config
async function runAudit(config: WebGuardConfig): Promise<WebGuardResult>;

// Individual pillar checks
async function checkPerformance(config: WebGuardConfig): Promise<PillarResult>;
async function checkA11y(browser: BrowserInstance, config: WebGuardConfig): Promise<PillarResult>;
async function checkSeo(browser: BrowserInstance, config: WebGuardConfig): Promise<PillarResult>;
async function checkSchema(browser: BrowserInstance, config: WebGuardConfig): Promise<PillarResult>;
async function checkSecurity(config: WebGuardConfig): Promise<PillarResult>;
async function checkUx(browser: BrowserInstance, config: WebGuardConfig): Promise<PillarResult>;

interface WebGuardResult {
  passed: boolean;
  url: string;
  device: "mobile" | "desktop";
  score: number;
  pillarResults: PillarResult[];
  timestamp: string;
}

interface PillarResult {
  pillar: PillarName;
  passed: boolean;
  score: number;
  violations: Violation[];
}

interface Violation {
  rule: string;
  severity: "critical" | "serious" | "moderate" | "minor";
  message: string;
  element?: string;
  hint?: string;
}

type PillarName = "performance" | "a11y" | "seo" | "schema" | "security" | "ux";