@a11yst/core 1.0.0

package/dist/execute-audit.d.ts

@@ -0,0 +1,96 @@
+import { type ArtifactWriter } from "@a11yst/artifacts";
+import { type EvidenceSink } from "@a11yst/browser";
+import type { FlowEvidenceSink } from "@a11yst/flows";
+import type { AccessibilityProfile, AuditExecutionResult, ProgressReporter, ResolvedCiPolicyConfig, ResolvedConfig } from "@a11yst/types";
+import type { ResolvedSarifReportOptions } from "./resolve-sarif-report-options.js";
+import type { ResolvedJunitReportOptions } from "./resolve-junit-report-options.js";
+import type { ResolvedMarkdownReportOptions } from "./resolve-markdown-report-options.js";
+import type { ResolvedGitHubAnnotationsOptions } from "./resolve-github-report-options.js";
+export interface ExecuteAuditOptions {
+    /** Run with a visible browser window instead of headless. */
+    headed?: boolean;
+    /** Per-navigation timeout in milliseconds. Forwarded to `@a11yst/browser`. */
+    navigationTimeoutMs?: number;
+    /** Never start a dev server; fail fast if nothing is already listening. */
+    noStartServer?: boolean;
+    /** Restrict execution to these project names (validated against the plan). */
+    projectNames?: string[];
+    /** Abort the whole audit (in-flight browser work included) when triggered. */
+    signal?: AbortSignal;
+    /** Artifact root override. Relative paths are resolved from `config.configDir`. */
+    outputDir?: string;
+    /** Generate the static HTML report. Defaults to `true`. */
+    html?: boolean;
+    /** Capture screenshot evidence. Defaults to `config.evidence.screenshots`. */
+    screenshots?: boolean;
+    /** Capture full-page screenshots. Defaults to `config.evidence.fullPage`. */
+    fullPageScreenshots?: boolean;
+    /** Persist the audit bundle. Defaults to `true`; intended as an internal/test opt-out. */
+    writeArtifacts?: boolean;
+    /** Deterministic artifact id injection for tests. */
+    artifactAuditId?: string;
+    /** Deterministic artifact timestamp injection for tests. */
+    artifactNow?: Date;
+    /** Restrict execution to these profile names (validated against configured profiles). */
+    profileNames?: AccessibilityProfile[];
+    /** Restrict execution to these flow ids (validated against configured flows). */
+    flowNames?: string[];
+    /** Audit only static route runs. */
+    routesOnly?: boolean;
+    /** Audit only flow checkpoint runs. */
+    flowsOnly?: boolean;
+    /** Per-step timeout in milliseconds for flow execution. */
+    stepTimeoutMs?: number;
+    /** Skip baseline comparison even when a baseline file exists. */
+    noBaseline?: boolean;
+    /** Compare against this baseline file instead of the configured default. */
+    baselinePath?: string;
+    /** Fail when `baselinePath` does not exist. */
+    explicitBaselineRequired?: boolean;
+    /** Resolved CI policy override; defaults to `config.ci`. */
+    ciPolicy?: ResolvedCiPolicyConfig;
+    /** Resolved SARIF report options from config and CLI. */
+    sarif?: ResolvedSarifReportOptions;
+    /** Absolute path for an additional SARIF copy resolved by the CLI. */
+    sarifExternalOutputPath?: string;
+    /** Resolved JUnit report options from config and CLI. */
+    junit?: ResolvedJunitReportOptions;
+    /** Absolute path for an additional JUnit copy resolved by the CLI. */
+    junitExternalOutputPath?: string;
+    /** Resolved Markdown report options from config and CLI. */
+    markdown?: ResolvedMarkdownReportOptions;
+    /** Absolute path for an additional Markdown copy resolved by the CLI. */
+    markdownExternalOutputPath?: string;
+    /** Resolved GitHub annotations options from config and CLI. */
+    githubAnnotations?: ResolvedGitHubAnnotationsOptions;
+    /** Absolute path for an additional GitHub annotations copy resolved by the CLI. */
+    githubAnnotationsExternalOutputPath?: string;
+    /** Write Markdown to GITHUB_STEP_SUMMARY when enabled and path is provided. */
+    githubStepSummary?: boolean;
+    /** Absolute path from GITHUB_STEP_SUMMARY resolved by the CLI. */
+    githubStepSummaryPath?: string;
+    /** Optional CLI progress reporter for long-running phases. */
+    progress?: ProgressReporter;
+}
+/** Resolve the artifact root without depending on the process working directory. */
+export declare function resolveAuditOutputDirectory(config: ResolvedConfig, outputDir?: string): string;
+export declare function createFlowEvidenceSink(writer: ArtifactWriter, projectName: string): FlowEvidenceSink;
+/**
+ * Adapt an artifact writer to the browser's immediate evidence persistence API.
+ * Filenames use finding identities only and never include target selectors.
+ */
+export declare function createArtifactEvidenceSink(writer: ArtifactWriter): EvidenceSink;
+/**
+ * Execute a full audit for a resolved configuration: build the plan, select
+ * which planned runs are actually executable in this phase, run web audits
+ * through `@a11yst/browser`, and aggregate everything into a single
+ * serialisable `AuditExecutionResult`.
+ *
+ * Never throws for per-run failures (navigation errors, dev server issues,
+ * a missing browser, ...) — those are captured as `"failed"` runs and
+ * reflected in `summary.status`. It only returns early with a `"failed"`
+ * result (no runs attempted) for a global configuration/selection error,
+ * e.g. an unknown `--project` name.
+ */
+export declare function executeAudit(config: ResolvedConfig, options?: ExecuteAuditOptions): Promise<AuditExecutionResult>;
+//# sourceMappingURL=execute-audit.d.ts.map

package/dist/execute-audit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execute-audit.d.ts","sourceRoot":"","sources":["../src/execute-audit.ts"],"names":[],"mappings":"AACA,OAAO,EAAwB,KAAK,cAAc,EAA2B,MAAM,mBAAmB,CAAC;AACvG,OAAO,EAIL,KAAK,YAAY,EAClB,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,KAAK,EACV,oBAAoB,EACpB,oBAAoB,EAWpB,gBAAgB,EAChB,sBAAsB,EACtB,cAAc,EAEf,MAAM,eAAe,CAAC;AA+BvB,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AACpF,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AACpF,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,sCAAsC,CAAC;AAC1F,OAAO,KAAK,EACV,gCAAgC,EACjC,MAAM,oCAAoC,CAAC;AAG5C,MAAM,WAAW,mBAAmB;IAClC,6DAA6D;IAC7D,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,8EAA8E;IAC9E,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,2EAA2E;IAC3E,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,8EAA8E;IAC9E,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,8EAA8E;IAC9E,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,mFAAmF;IACnF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2DAA2D;IAC3D,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,8EAA8E;IAC9E,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,6EAA6E;IAC7E,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,0FAA0F;IAC1F,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,qDAAqD;IACrD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4DAA4D;IAC5D,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,yFAAyF;IACzF,YAAY,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACtC,iFAAiF;IACjF,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,oCAAoC;IACpC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,uCAAuC;IACvC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,2DAA2D;IAC3D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iEAAiE;IACjE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,4EAA4E;IAC5E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAClC,yDAAyD;IACzD,KAAK,CAAC,EAAE,0BAA0B,CAAC;IACnC,sEAAsE;IACtE,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,yDAAyD;IACzD,KAAK,CAAC,EAAE,0BAA0B,CAAC;IACnC,sEAAsE;IACtE,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,6BAA6B,CAAC;IACzC,yEAAyE;IACzE,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,+DAA+D;IAC/D,iBAAiB,CAAC,EAAE,gCAAgC,CAAC;IACrD,mFAAmF;IACnF,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAC7C,+EAA+E;IAC/E,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,kEAAkE;IAClE,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AA8DD,oFAAoF;AACpF,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,cAAc,EACtB,SAAS,CAAC,EAAE,MAAM,GACjB,MAAM,CAGR;AAUD,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,cAAc,EACtB,WAAW,EAAE,MAAM,GAClB,gBAAgB,CA8ClB;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,cAAc,GAAG,YAAY,CAqB/E;AAmID;;;;;;;;;;;GAWG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,cAAc,EACtB,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,oBAAoB,CAAC,CAqe/B"}