@vertaaux/cli 0.4.0 → 0.5.0

package/dist/commands/report.js

@@ -1,214 +0,0 @@
-/**
- * Report generation command for VertaaUX CLI.
- *
- * Generates consolidated multi-client reports by delegating
- * data aggregation to the server-side consolidated report API.
- * The CLI handles formatting only -- no data computation.
- *
- * Implements 46-06: CLI report command.
- */
-import chalk from "chalk";
-import fs from "fs";
-import { resolveApiBase, getApiKey, apiRequest } from "../utils/client.js";
-/**
- * Resolve API connection settings.
- */
-function resolveConnection() {
-    return {
-        base: resolveApiBase(),
-        apiKey: getApiKey(),
-    };
-}
-/**
- * Get a traffic-light status indicator for a client based on scores and policy.
- */
-function getStatusIndicator(client) {
-    // Red: any URL with score < 50 or policy violations
-    const hasLowScore = client.urls.some((u) => u.overall !== null && u.overall < 50);
-    if (hasLowScore || client.policyViolations > 0) {
-        return chalk.red("\u25cf");
-    }
-    // Yellow: some URLs below threshold (< 70)
-    const hasMediumScore = client.urls.some((u) => u.overall !== null && u.overall < 70);
-    if (hasMediumScore) {
-        return chalk.yellow("\u25cf");
-    }
-    // Green: all URLs passing or above 70
-    return chalk.green("\u25cf");
-}
-/**
- * Get trend arrow for display.
- */
-function getTrendArrow(trend) {
-    switch (trend) {
-        case "improving":
-            return chalk.green("\u2191");
-        case "declining":
-            return chalk.red("\u2193");
-        case "stable":
-            return chalk.dim("-");
-        default:
-            return chalk.dim("?");
-    }
-}
-/**
- * Pad a string to the right to a given width.
- */
-function padRight(str, width) {
-    if (str.length >= width)
-        return str;
-    return str + " ".repeat(width - str.length);
-}
-/**
- * Truncate a string to a maximum length with ellipsis.
- */
-function truncate(str, maxLen) {
-    if (str.length <= maxLen)
-        return str;
-    return str.slice(0, maxLen - 1) + "\u2026";
-}
-/**
- * Format the consolidated report as human-readable output.
- */
-function formatHumanReport(report) {
-    const lines = [];
-    // Header
-    lines.push("");
-    lines.push(chalk.bold(`Consolidated Report: ${report.orgName}`));
-    lines.push(chalk.dim(`Generated: ${new Date(report.generatedAt).toISOString().split("T")[0]}`));
-    lines.push("");
-    // Per-client sections
-    for (const client of report.clients) {
-        const indicator = getStatusIndicator(client);
-        const avgStr = client.averageScore !== null
-            ? String(client.averageScore)
-            : "n/a";
-        lines.push(`${indicator} ${chalk.bold(client.name)} (avg: ${avgStr})`);
-        // URL table
-        const urlWidth = 40;
-        const scoreWidth = 8;
-        const policyWidth = 10;
-        const trendWidth = 6;
-        const header = "  " +
-            padRight("URL", urlWidth) +
-            padRight("Score", scoreWidth) +
-            padRight("Policy", policyWidth) +
-            padRight("Trend", trendWidth);
-        lines.push(chalk.dim(header));
-        lines.push(chalk.dim("  " + "-".repeat(urlWidth + scoreWidth + policyWidth + trendWidth)));
-        for (const u of client.urls) {
-            const scoreStr = u.overall !== null ? String(u.overall) : "n/a";
-            const policyStr = u.policyStatus === "passing"
-                ? chalk.green("pass")
-                : u.policyStatus === "failing"
-                    ? chalk.red("fail")
-                    : chalk.dim("none");
-            const trendStr = getTrendArrow(u.trend);
-            const row = "  " +
-                padRight(truncate(u.url, urlWidth - 2), urlWidth) +
-                padRight(scoreStr, scoreWidth) +
-                padRight(policyStr, policyWidth) +
-                trendStr;
-            lines.push(row);
-        }
-        lines.push("");
-    }
-    // Summary
-    lines.push(chalk.bold("Summary"));
-    lines.push(`  Clients: ${report.summary.totalClients}  |  URLs: ${report.summary.totalUrls}  |  Avg Score: ${report.summary.averageScore ?? "n/a"}`);
-    lines.push(`  Policies: ${chalk.green(String(report.summary.passingPolicies) + " passing")}  ${chalk.red(String(report.summary.failingPolicies) + " failing")}`);
-    lines.push("");
-    return lines.join("\n");
-}
-/**
- * Format the consolidated report as CSV.
- */
-function formatCsvReport(report) {
-    const lines = [];
-    // Header
-    lines.push("Client,URL,Overall,Accessibility,Performance,UX,Policy,Trend");
-    // Data rows
-    for (const client of report.clients) {
-        for (const u of client.urls) {
-            const overall = u.overall !== null ? String(u.overall) : "";
-            const accessibility = u.scores.accessibility !== undefined
-                ? String(u.scores.accessibility)
-                : "";
-            const performance = u.scores.performance !== undefined
-                ? String(u.scores.performance)
-                : "";
-            const ux = u.scores.ux !== undefined ? String(u.scores.ux) : "";
-            const policy = u.policyStatus;
-            const trend = u.trend;
-            // Escape client name and URL for CSV (wrap in quotes if contains comma)
-            const escapeCsv = (s) => s.includes(",") || s.includes('"')
-                ? `"${s.replace(/"/g, '""')}"`
-                : s;
-            lines.push([
-                escapeCsv(client.name),
-                escapeCsv(u.url),
-                overall,
-                accessibility,
-                performance,
-                ux,
-                policy,
-                trend,
-            ].join(","));
-        }
-    }
-    return lines.join("\n") + "\n";
-}
-/**
- * Register the report command with the Commander program.
- */
-export function registerReportCommand(program) {
-    program
-        .command("report")
-        .description("Generate consolidated reports")
-        .option("--clients", "Generate multi-client consolidated report")
-        .option("--client <names>", "Comma-separated client names/slugs (default: all)")
-        .option("--format <format>", "Output format: human|json|csv", "human")
-        .option("--output <path>", "Write report to file instead of stdout")
-        .action(async (options) => {
-        try {
-            // Currently only consolidated client reports are supported
-            if (!options.clients) {
-                process.stderr.write(chalk.yellow("The report command requires --clients flag.\n"));
-                process.stderr.write(chalk.dim("Usage: vertaa report --clients [--client <names>] [--format human|json|csv]\n"));
-                process.exit(1);
-                return;
-            }
-            const { base, apiKey } = resolveConnection();
-            // Build API URL with optional client filter
-            let apiPath = "/reports/consolidated";
-            if (options.client) {
-                const encoded = encodeURIComponent(options.client);
-                apiPath += `?clients=${encoded}`;
-            }
-            const report = await apiRequest(base, apiPath, { method: "GET" }, apiKey);
-            // Format output
-            let output;
-            if (options.format === "json") {
-                output = JSON.stringify(report, null, 2) + "\n";
-            }
-            else if (options.format === "csv") {
-                output = formatCsvReport(report);
-            }
-            else {
-                output = formatHumanReport(report);
-            }
-            // Write to file or stdout
-            if (options.output) {
-                fs.writeFileSync(options.output, output, "utf-8");
-                process.stderr.write(chalk.green(`Report written to ${options.output}\n`));
-            }
-            else {
-                process.stdout.write(output);
-            }
-        }
-        catch (error) {
-            process.stderr.write(chalk.red(`Error: ${error instanceof Error ? error.message : String(error)}\n`));
-            process.exit(1);
-        }
-    });
-}

package/dist/policy/sync.d.ts

@@ -1,67 +0,0 @@
-/**
- * Policy push/pull sync module for VertaaUX CLI.
- *
- * Provides bidirectional sync between local policy files and the server API.
- * Uses the established CLI API patterns (resolveApiBase, getApiKey, apiRequest).
- *
- * Implements POL-10: Policy push/pull sync.
- */
-import type { PolicyFile } from "@vertaaux/quality-control";
-import type { VertaauxConfig } from "../config/schema.js";
-export interface SyncConfig {
-    apiBase: string;
-    apiKey: string;
-}
-/**
- * Build sync config from CLI config and environment.
- * Uses the established CLI pattern: resolveApiBase + getApiKey.
- */
-export declare function buildSyncConfig(cliConfig?: VertaauxConfig): SyncConfig;
-export interface PushResult {
-    success: boolean;
-    policyId: string;
-    version: number;
-    created: boolean;
-    error?: string;
-}
-export interface PullResult {
-    success: boolean;
-    policy?: PolicyFile;
-    policyId?: string;
-    version?: number;
-    name?: string;
-    error?: string;
-}
-/**
- * Push a local policy file to the server.
- *
- * If a policy with the given name already exists, updates it (with optional
- * optimistic locking via expectedVersion). Otherwise creates a new policy.
- *
- * @param policy - The policy content to push
- * @param config - API connection config
- * @param options - Push options (name, description, force, etc.)
- * @returns Push result with success status, policy ID, and version
- */
-export declare function pushPolicy(policy: PolicyFile, config: SyncConfig, options: {
-    name: string;
-    description?: string;
-    changeMessage?: string;
-    expectedVersion?: number;
-    force?: boolean;
-}): Promise<PushResult>;
-/**
- * Pull a policy from the server.
- *
- * Finds the policy by ID, name, or defaults to the default/first policy.
- * Returns the full policy content for writing to a local file.
- *
- * @param config - API connection config
- * @param options - Pull options (policyId or policyName)
- * @returns Pull result with policy content and metadata
- */
-export declare function pullPolicy(config: SyncConfig, options: {
-    policyId?: string;
-    policyName?: string;
-}): Promise<PullResult>;
-//# sourceMappingURL=sync.d.ts.map

package/dist/policy/sync.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sync.d.ts","sourceRoot":"","sources":["../../src/policy/sync.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAE5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,SAAS,CAAC,EAAE,cAAc,GAAG,UAAU,CAKtE;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AA4BD;;;;;;;;;;GAUG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE;IACP,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,GACA,OAAO,CAAC,UAAU,CAAC,CA+ErB;AAED;;;;;;;;;GASG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE;IACP,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,GACA,OAAO,CAAC,UAAU,CAAC,CAuDrB"}

package/dist/policy/sync.js

@@ -1,147 +0,0 @@
-/**
- * Policy push/pull sync module for VertaaUX CLI.
- *
- * Provides bidirectional sync between local policy files and the server API.
- * Uses the established CLI API patterns (resolveApiBase, getApiKey, apiRequest).
- *
- * Implements POL-10: Policy push/pull sync.
- */
-import { resolveApiBase, getApiKey, apiRequest } from "../utils/client.js";
-/**
- * Build sync config from CLI config and environment.
- * Uses the established CLI pattern: resolveApiBase + getApiKey.
- */
-export function buildSyncConfig(cliConfig) {
-    return {
-        apiBase: resolveApiBase(undefined, undefined),
-        apiKey: getApiKey(cliConfig?.apiKey),
-    };
-}
-/**
- * Push a local policy file to the server.
- *
- * If a policy with the given name already exists, updates it (with optional
- * optimistic locking via expectedVersion). Otherwise creates a new policy.
- *
- * @param policy - The policy content to push
- * @param config - API connection config
- * @param options - Push options (name, description, force, etc.)
- * @returns Push result with success status, policy ID, and version
- */
-export async function pushPolicy(policy, config, options) {
-    try {
-        // First, try to find existing policy by name
-        const listData = await apiRequest(config.apiBase, "/policies", { method: "GET" }, config.apiKey);
-        const existing = listData.policies?.find((p) => p.name === options.name);
-        if (existing) {
-            // Update existing policy
-            const body = {
-                content: policy,
-                changeMessage: options.changeMessage || "Pushed from CLI",
-            };
-            if (options.expectedVersion && !options.force) {
-                body.expectedVersion = options.expectedVersion;
-            }
-            try {
-                const updated = await apiRequest(config.apiBase, `/policies/${existing.id}`, { method: "PUT", body }, config.apiKey);
-                return {
-                    success: true,
-                    policyId: existing.id,
-                    version: updated.latestVersion || 0,
-                    created: false,
-                };
-            }
-            catch (err) {
-                const message = err instanceof Error ? err.message : String(err);
-                if (message.includes("409")) {
-                    return {
-                        success: false,
-                        policyId: existing.id,
-                        version: existing.latestVersion || 0,
-                        created: false,
-                        error: "Policy has been modified on server. Pull latest first, or use --force.",
-                    };
-                }
-                throw err;
-            }
-        }
-        else {
-            // Create new policy
-            const created = await apiRequest(config.apiBase, "/policies", {
-                method: "POST",
-                body: {
-                    name: options.name,
-                    description: options.description,
-                    content: policy,
-                },
-            }, config.apiKey);
-            return {
-                success: true,
-                policyId: created.id || "",
-                version: 1,
-                created: true,
-            };
-        }
-    }
-    catch (err) {
-        return {
-            success: false,
-            policyId: "",
-            version: 0,
-            created: false,
-            error: err instanceof Error ? err.message : String(err),
-        };
-    }
-}
-/**
- * Pull a policy from the server.
- *
- * Finds the policy by ID, name, or defaults to the default/first policy.
- * Returns the full policy content for writing to a local file.
- *
- * @param config - API connection config
- * @param options - Pull options (policyId or policyName)
- * @returns Pull result with policy content and metadata
- */
-export async function pullPolicy(config, options) {
-    try {
-        let policyId = options.policyId;
-        // If no ID, find by name or get default
-        if (!policyId) {
-            const listData = await apiRequest(config.apiBase, "/policies", { method: "GET" }, config.apiKey);
-            if (options.policyName) {
-                const found = listData.policies?.find((p) => p.name === options.policyName);
-                if (!found) {
-                    return {
-                        success: false,
-                        error: `Policy "${options.policyName}" not found on server`,
-                    };
-                }
-                policyId = found.id;
-            }
-            else {
-                const defaultPolicy = listData.policies?.find((p) => p.isDefault);
-                const target = defaultPolicy || listData.policies?.[0];
-                if (!target) {
-                    return { success: false, error: "No policies found on server" };
-                }
-                policyId = target.id;
-            }
-        }
-        // Fetch full policy with content
-        const data = await apiRequest(config.apiBase, `/policies/${policyId}`, { method: "GET" }, config.apiKey);
-        return {
-            success: true,
-            policy: data.content,
-            policyId: data.id || policyId,
-            version: data.latestVersion,
-            name: data.name,
-        };
-    }
-    catch (err) {
-        return {
-            success: false,
-            error: err instanceof Error ? err.message : String(err),
-        };
-    }
-}