Supported public APIs#
Import supported package entries, never private implementation paths. The generated API inventory reflects exports at the site's tested revision; the source links below identify those entry files. Curated guides explain how to use the contracts.
Portable reporting#
| Entry | Main public operations | Source |
|---|---|---|
@snagbadger/reporting | createBugReport, parseBugReport, reviseBugReport, removeReportEvidence; shared evidence/expectation/timestamp validation and verification invalidation | Entry |
@snagbadger/reporting/bundle | createReportBundle, prepareReportExport, importReportBundle, submitBugReport, redactReportSecrets, IncompleteDeliveryError | Entry |
@snagbadger/capture | Portable Evidence, RecordedInteraction, JsonValue types | Entry |
The report model includes stable identity/revision, expected/actual behavior, hypotheses, authored steps, actual interactions, evidence, reproduction data and source snapshots. Functions-only reporting loads no React/CSS. Bundle/rendering behavior is an optional entry.
Start with first portable report; canonical portable guidance explains mutation, sanitization and delivery semantics. Capture types do not collect browser evidence.
Catalog and execution#
| Entry | Main public operations | Source |
|---|---|---|
@snagbadger/agent-catalog | discoverCatalog, selectCatalogTests, resolveCatalogTest, testContext, parseCatalog, selectTests; catalog/source/test/section/settings and hook types | Entry |
@snagbadger/agent-execution | executeCatalog; runtime, session, task packet, hook and execution option types | Entry |
The catalog consumes source paths/content; filesystem discovery belongs to tooling. Execution consumes a supplied Runtime; it does not secretly install tools or operate an MCP. Runner commands provide the filesystem bridge's supported CLI.
Results and HTML view#
| Entry | Main public operations | Source |
|---|---|---|
@snagbadger/agent-reporting | parseTestRun, defaultRunPolicy, summarizeResult, appendAttempt, addResultComment, requestedScreenshots, assessRegressionCandidate, createBugFromResult | Entry |
@snagbadger/agent-reporting/html | createTestRunReport, parseRunReportView; run-view/options types | Entry |
Result and bug-report models remain distinct, sharing evidence/validation semantics. Read runs and attempts and review/promotion before interpreting summary results.
Reporter composition and session lifecycle#
| Entry | Main public operations | Source |
|---|---|---|
@snagbadger/configuration | composeConfiguration, pipeConfiguration, removeAdapter, replaceAdapters, selectConfiguration, resolveConfiguration, resolveSettings | Entry |
@snagbadger/reporting/session | createReportingRuntime; reporting adapter, session, selection and failure types | Entry |
@snagbadger/embedding | LauncherAdapter type for host-owned mounting and disposal | Entry |
Capture also supplies portable CaptureAdapter, ActiveCapture, CaptureOutput and cancellation/context types. These interfaces support developer-owned integrations; they do not install a browser collector or launcher. See configure reporting for a runnable empty session and the implemented contracts for lifecycle and settings behavior.
Experimental and reserved entries#
@snagbadger/reporting/theming-prototype supplies the maintained experimental React component with separately imported layout/default/host styles. Sample site identifies simulated behavior. The empty reporting/browser entry is reserved; embedding supplies a launcher interface rather than a built-in working launcher.
All packages share one repository version. formatVersion: 1 identifies serialized data formats independently of package version. No multi-version documentation or published release availability is implied.