@vertaaux/cli 0.2.0

package/dist/ci/gitlab-api.js

@@ -0,0 +1,180 @@
+/**
+ * GitLab API wrapper for MR note operations.
+ *
+ * Provides utilities for posting and updating MR notes (comments)
+ * with sticky note semantics (find existing by hidden header).
+ *
+ * Uses native fetch (Node 18+).
+ */
+/**
+ * Make an authenticated GitLab API request.
+ */
+async function gitlabRequest(method, url, token, body) {
+    const headers = {
+        Accept: "application/json",
+        "User-Agent": "VertaaUX-CLI",
+    };
+    // GitLab uses different header for job token vs personal access token
+    if (process.env.CI_JOB_TOKEN && token === process.env.CI_JOB_TOKEN) {
+        headers["JOB-TOKEN"] = token;
+    }
+    else {
+        headers["PRIVATE-TOKEN"] = token;
+    }
+    if (body) {
+        headers["Content-Type"] = "application/json";
+    }
+    const response = await fetch(url, {
+        method,
+        headers,
+        body: body ? JSON.stringify(body) : undefined,
+    });
+    if (!response.ok) {
+        const errorData = (await response.json().catch(() => ({})));
+        const errorMessage = Array.isArray(errorData.message)
+            ? errorData.message.join(", ")
+            : errorData.message || errorData.error || response.statusText;
+        throw new Error(`GitLab API error (${response.status}): ${errorMessage}`);
+    }
+    // Handle no content responses
+    if (response.status === 204) {
+        return {};
+    }
+    return response.json();
+}
+/**
+ * URL-encode a project path for GitLab API.
+ *
+ * Project ID can be numeric or a path like "group/project".
+ * Numeric IDs pass through unchanged, paths are URL-encoded.
+ *
+ * @param projectId - Project ID or path
+ * @returns URL-safe project identifier
+ */
+export function encodeProjectId(projectId) {
+    // Numeric IDs don't need encoding
+    if (/^\d+$/.test(projectId)) {
+        return projectId;
+    }
+    // URL-encode path (group/subgroup/project -> group%2Fsubgroup%2Fproject)
+    return encodeURIComponent(projectId);
+}
+/**
+ * Find existing note by hidden header identifier.
+ *
+ * Searches MR notes for `<!-- {header} -->` pattern in body.
+ * Handles pagination for MRs with many notes.
+ *
+ * @param options - Note search options
+ * @returns Note ID if found, null otherwise
+ */
+export async function findExistingNote(options) {
+    const { token, apiUrl, projectId, mrIid, header } = options;
+    const headerPattern = `<!-- ${header} -->`;
+    const encodedProjectId = encodeProjectId(projectId);
+    let page = 1;
+    const perPage = 100;
+    // Paginate through notes until we find one or run out
+    while (true) {
+        const url = `${apiUrl}/projects/${encodedProjectId}/merge_requests/${mrIid}/notes?page=${page}&per_page=${perPage}`;
+        const notes = await gitlabRequest("GET", url, token);
+        for (const note of notes) {
+            // Skip system notes (auto-generated by GitLab)
+            if (note.system)
+                continue;
+            if (note.body?.includes(headerPattern)) {
+                return note.id;
+            }
+        }
+        // No more pages
+        if (notes.length < perPage) {
+            break;
+        }
+        page++;
+    }
+    return null;
+}
+/**
+ * Post new note or update existing one.
+ *
+ * Uses header identifier to find existing note for update semantics.
+ * This prevents note spam and ensures only one VertaaUX note per MR.
+ *
+ * @param options - Note options
+ * @returns Created/updated note with ID and web URL
+ */
+export async function postOrUpdateGitLabNote(options) {
+    const { token, apiUrl, projectId, mrIid, body, header } = options;
+    const encodedProjectId = encodeProjectId(projectId);
+    // Try to find existing note
+    const existingId = await findExistingNote({
+        token,
+        apiUrl,
+        projectId,
+        mrIid,
+        header,
+    });
+    if (existingId) {
+        // Update existing note
+        const url = `${apiUrl}/projects/${encodedProjectId}/merge_requests/${mrIid}/notes/${existingId}`;
+        const note = await gitlabRequest("PUT", url, token, { body });
+        // GitLab doesn't return web_url for notes, construct it
+        const webUrl = constructNoteWebUrl(apiUrl, projectId, mrIid, note.id);
+        return { id: note.id, web_url: webUrl };
+    }
+    else {
+        // Create new note
+        const url = `${apiUrl}/projects/${encodedProjectId}/merge_requests/${mrIid}/notes`;
+        const note = await gitlabRequest("POST", url, token, { body });
+        const webUrl = constructNoteWebUrl(apiUrl, projectId, mrIid, note.id);
+        return { id: note.id, web_url: webUrl };
+    }
+}
+/**
+ * Construct web URL for a note.
+ *
+ * GitLab API doesn't return web_url for notes, so we construct it.
+ */
+function constructNoteWebUrl(apiUrl, projectId, mrIid, noteId) {
+    // Convert API URL to web URL
+    // https://gitlab.com/api/v4 -> https://gitlab.com
+    const webBase = apiUrl.replace(/\/api\/v\d+$/, "");
+    // Project path (decode if encoded)
+    const projectPath = /^\d+$/.test(projectId)
+        ? projectId
+        : decodeURIComponent(projectId);
+    return `${webBase}/${projectPath}/-/merge_requests/${mrIid}#note_${noteId}`;
+}
+/**
+ * Extract MR IID from GitLab CI environment.
+ *
+ * @returns MR IID or null if not in MR context
+ */
+export function extractMRIid() {
+    const mrIid = process.env.CI_MERGE_REQUEST_IID;
+    if (mrIid) {
+        const num = parseInt(mrIid, 10);
+        if (!isNaN(num))
+            return num;
+    }
+    return null;
+}
+/**
+ * Get GitLab API configuration from environment.
+ *
+ * @returns API configuration or null if not in GitLab CI
+ */
+export function getGitLabConfig() {
+    // Token: prefer GITLAB_TOKEN, fall back to CI_JOB_TOKEN
+    const token = process.env.GITLAB_TOKEN || process.env.CI_JOB_TOKEN;
+    if (!token)
+        return null;
+    // API URL: from CI or default to gitlab.com
+    const apiUrl = process.env.CI_API_V4_URL || "https://gitlab.com/api/v4";
+    // Project ID: prefer numeric ID, fall back to path
+    const projectId = process.env.CI_PROJECT_ID ||
+        process.env.CI_PROJECT_PATH;
+    if (!projectId)
+        return null;
+    return { token, apiUrl, projectId };
+}

package/dist/ci/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * CI integration utilities for VertaaUX CLI.
+ */
+export { getChangedRoutes, detectBaseBranch, filePathToRoute, BUDGET_MODES, getBudgetConfig, } from "./changed-routes.js";
+export type { ChangedRoutesOptions, ChangedRoutesResult, BudgetMode, } from "./changed-routes.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/ci/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ci/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,YAAY,EACZ,eAAe,GAChB,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EACV,oBAAoB,EACpB,mBAAmB,EACnB,UAAU,GACX,MAAM,qBAAqB,CAAC"}

package/dist/ci/index.js

@@ -0,0 +1,4 @@
+/**
+ * CI integration utilities for VertaaUX CLI.
+ */
+export { getChangedRoutes, detectBaseBranch, filePathToRoute, BUDGET_MODES, getBudgetConfig, } from "./changed-routes.js";

package/dist/commands/audit.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Audit command for VertaaUX CLI.
+ *
+ * Runs UX and accessibility audits on web pages.
+ * Supports various targets, output formats, and CI integration.
+ */
+import { Command } from "commander";
+export interface AuditCommandOptions {
+    url?: string;
+    repo?: string;
+    storybook?: string;
+    routes?: string;
+    authProfile?: string;
+    mode?: "basic" | "standard" | "deep";
+    wait?: boolean;
+    timeout?: number;
+    interval?: number;
+    format?: string;
+    output?: string;
+    groupBy?: "severity" | "category" | "route";
+    severity?: string;
+    category?: string;
+    failOn?: "error" | "warning" | "info" | "none";
+    threshold?: number;
+    maxNewErrors?: number;
+    maxNewWarnings?: number;
+    failOnExisting?: boolean;
+    bypassLabels?: string;
+    baseline?: string;
+    interactive?: boolean;
+    saveTrace?: boolean;
+    saveHar?: boolean;
+    screenshots?: boolean;
+    domSnapshots?: boolean;
+    concurrency?: number;
+    cache?: boolean;
+    uploadArtifacts?: boolean;
+    jobId?: string;
+    incremental?: boolean;
+    baseBranch?: string;
+    budget?: "quick" | "standard" | "full";
+    policy?: string;
+    workspace?: string;
+    allWorkspaces?: boolean;
+    parallel?: boolean;
+    detectMatrix?: boolean;
+    noCache?: boolean;
+    cacheDir?: string;
+    jsonLogs?: boolean;
+    base?: string;
+    quiet?: boolean;
+    machine?: boolean;
+}
+/**
+ * Register the audit command with the Commander program.
+ */
+export declare function registerAuditCommand(program: Command): void;
+//# sourceMappingURL=audit.d.ts.map

package/dist/commands/audit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit.d.ts","sourceRoot":"","sources":["../../src/commands/audit.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AA8EpC,MAAM,WAAW,mBAAmB;IAElC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IAGrB,IAAI,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,MAAM,CAAC;IACrC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAGlB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,OAAO,CAAC;IAG5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAGlB,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAGlB,WAAW,CAAC,EAAE,OAAO,CAAC;IAGtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,OAAO,CAAC;IAGvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,OAAO,CAAC;IAGhB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IAGf,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IAGpB,MAAM,CAAC,EAAE,OAAO,GAAG,UAAU,GAAG,MAAM,CAAC;IAGvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAGhB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;IAGvB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAGlB,QAAQ,CAAC,EAAE,OAAO,CAAC;IAGnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AA2tBD;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAiT3D"}