@bugbug-io/sdk 13.39.1

package/dist/modules/suites/suites.d.ts

@@ -0,0 +1,153 @@
+import type { BugBugApiClient } from '../../services/apiClient/apiClient';
+import type { RequestOptions } from '../../types/config';
+import type { ListSuiteRunsOptions, ListSuitesOptions, RunSuiteNoWatchProgressOptions, RunSuiteWatchProgressOptions } from './suites.types';
+import type { DebugArtifactsListResponse, SuitesListResponse, Suite, SuiteSummary, SuiteRun, SuiteRunState, SuiteRunsListResponse, SuiteRunScreenshotsResponse, SuiteCreateRequest, SuiteUpdateRequest, SuitePartialUpdateRequest } from '@bugbug-io/api-schema';
+/**
+ * Suites module — manage BugBug test suites and their runs.
+ *
+ * Mirrors the shape of {@link TestsModule}: CRUD over `/suites/` + run
+ * lifecycle over `/suiteruns/`. Use {@link startRun} for the recommended
+ * high-level entry point with optional progress watching.
+ */
+export declare class SuitesModule {
+    #private;
+    constructor(client: BugBugApiClient);
+    /**
+     * List suites with pagination, search, and ordering.
+     *
+     * @param options.cursor - Opaque cursor returned as `nextToken` by the previous page.
+     * @param options.pageSize - Items per page.
+     * @param options.query - Search query matched against suite name.
+     * @param options.ordering - Sort key; prefix with `-` for descending.
+     * @returns Paginated `SuitesListResponse` envelope (validated via Zod).
+     * @throws {UnexpectedResponseError} On Zod validation failure.
+     */
+    list: (options?: ListSuitesOptions) => Promise<SuitesListResponse>;
+    /**
+     * Fetch every suite across all pages.
+     */
+    getAll: (options?: Omit<ListSuitesOptions, "cursor">) => Promise<SuiteSummary[]>;
+    /**
+     * Fetch a single suite by ID.
+     *
+     * @throws {NotFoundError} When no suite matches `suiteId`.
+     */
+    get: (suiteId: string, options?: RequestOptions) => Promise<Suite>;
+    /**
+     * Create a new suite.
+     *
+     * @throws {ValidationError} On invalid payload.
+     */
+    create: (data: SuiteCreateRequest, options?: RequestOptions) => Promise<Suite>;
+    /**
+     * Fully replace a suite via PUT (all fields required).
+     * Use {@link partialUpdate} for sparse PATCH semantics.
+     *
+     * @throws {NotFoundError} When the suite does not exist.
+     * @throws {ValidationError} On invalid payload.
+     */
+    update: (suiteId: string, data: SuiteUpdateRequest, options?: RequestOptions) => Promise<Suite>;
+    /**
+     * Patch selected fields on a suite (PATCH semantics).
+     *
+     * @throws {NotFoundError} When the suite does not exist.
+     * @throws {ValidationError} On invalid payload.
+     */
+    partialUpdate: (suiteId: string, data: SuitePartialUpdateRequest, options?: RequestOptions) => Promise<Suite>;
+    /**
+     * Delete a suite by ID.
+     *
+     * @throws {NotFoundError} When the suite does not exist.
+     */
+    delete: (suiteId: string, options?: RequestOptions) => Promise<void>;
+    /**
+     * Start a suite run, optionally watching progress until completion.
+     *
+     * @param suiteId - UUID of the suite to run.
+     * @param options.profileName - Run profile name or UUID; resolved via {@link ProfilesModule.resolveId}.
+     * @param options.variables - Per-run variable overrides.
+     * @param options.watchProgress - When `true`, block until all child runs finish.
+     * @param options.pollInterval - Poll interval in ms when watching progress (default 2000).
+     * @param options.timeout - Progress watching timeout in ms (default 10 minutes for suites).
+     * @param options.onProgress - Callback invoked on each poll with the latest `SuiteRunState`.
+     * @throws {NotFoundError} When `profileName` does not resolve.
+     * @throws {TimeoutError} When `watchProgress` is true and the run does not finish in time.
+     *
+     * @example
+     * ```typescript
+     * const run = await sdk.suites.startRun(suiteId, {
+     *   watchProgress: true,
+     *   profileName: 'Production',
+     *   onProgress: (s) => console.log(`${s.status} ${s.finishedTests}/${s.totalTests}`),
+     * });
+     * ```
+     */
+    startRun(suiteId: string, options: RunSuiteWatchProgressOptions): Promise<SuiteRun>;
+    startRun(suiteId: string, options?: RunSuiteNoWatchProgressOptions): Promise<SuiteRunState>;
+    /**
+     * Fetch full suite-run details including child test runs.
+     *
+     * @throws {NotFoundError} When the run does not exist.
+     */
+    getRun: (runId: string, options?: RequestOptions) => Promise<SuiteRun>;
+    /**
+     * Get list of suite runs.
+     *
+     */
+    listRuns: (options?: ListSuiteRunsOptions) => Promise<SuiteRunsListResponse>;
+    /**
+     * Get recent suite runs within a time window
+     */
+    getRecentRuns: (options?: {
+        hours?: number;
+        pageSize?: ListSuiteRunsOptions["pageSize"];
+        ordering?: ListSuiteRunsOptions["ordering"];
+        suiteId?: ListSuiteRunsOptions["suiteId"];
+    } & RequestOptions) => Promise<SuiteRunsListResponse>;
+    /**
+     * Fetch only the lightweight status of a suite run. Prefer this over
+     * {@link getRun} when polling.
+     */
+    getRunProgress: (runId: string, options?: RequestOptions) => Promise<SuiteRunState>;
+    /**
+     * Request cancellation of an in-progress suite run.
+     *
+     * @returns The updated status; the run may still take a moment to settle.
+     */
+    stopRun: (runId: string, options?: RequestOptions) => Promise<SuiteRunState>;
+    /**
+     * Fetch screenshots captured across all child test runs of a suite run.
+     */
+    getRunScreenshots: (runId: string, options?: RequestOptions) => Promise<SuiteRunScreenshotsResponse["testsRuns"]>;
+    /**
+     * Download the combined JUnit XML report for a suite run, aggregating all
+     * child test runs.
+     *
+     * @returns The JUnit report body as a string.
+     */
+    downloadRunJunitReport: (runId: string, options?: RequestOptions) => Promise<string>;
+    /**
+     * List artifacts attached to a suite run. The current public API exposes the
+     * combined JUnit report artifact here.
+     */
+    listRunDebugArtifacts: (runId: string, options?: RequestOptions) => Promise<DebugArtifactsListResponse>;
+    /**
+     * Poll a suite run's lightweight `/status/` endpoint until it reaches a
+     * terminal status, then return the full `SuiteRun` once.
+     *
+     * Transient network errors are retried; non-network errors propagate.
+     *
+     * @param runId - UUID of the suite run.
+     * @param onProgress - Invoked on every successful poll with the latest `SuiteRunState`
+     *   (including the terminal one). Receives `finishedTests`/`totalTests`/`webappUrl`
+     *   for in-flight progress UI.
+     * @param options.pollInterval - Poll interval in ms (default 2000).
+     * @param options.timeout - Wait timeout in ms (default 600_000 = 10 minutes; suites typically take longer than single tests).
+     * @throws {TimeoutError} When the run does not complete in time.
+     */
+    watchRunProgress: (runId: string, onProgress: (status: SuiteRunState) => void | Promise<void>, options?: {
+        pollInterval?: number;
+        timeout?: number;
+    } & RequestOptions) => Promise<SuiteRun>;
+}
+//# sourceMappingURL=suites.d.ts.map

package/dist/modules/suites/suites.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suites.d.ts","sourceRoot":"","sources":["../../../src/modules/suites/suites.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EACV,oBAAoB,EACpB,iBAAiB,EACjB,8BAA8B,EAC9B,4BAA4B,EAC7B,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EACV,0BAA0B,EAC1B,kBAAkB,EAClB,KAAK,EACL,YAAY,EACZ,QAAQ,EACR,aAAa,EACb,qBAAqB,EAErB,2BAA2B,EAC3B,kBAAkB,EAClB,kBAAkB,EAClB,yBAAyB,EAC1B,MAAM,uBAAuB,CAAC;AAO/B;;;;;;GAMG;AACH,qBAAa,YAAY;;gBAIX,MAAM,EAAE,eAAe;IAKnC;;;;;;;;;OASG;IACH,IAAI,GAAU,UAAS,iBAAsB,KAAG,OAAO,CAAC,kBAAkB,CAAC,CAYzE;IAEF;;OAEG;IACH,MAAM,GAAU,UAAS,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAM,KAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CACQ;IAEjG;;;;OAIG;IACH,GAAG,GAAU,SAAS,MAAM,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,KAAK,CAAC,CAItE;IAEL;;;;OAIG;IACH,MAAM,GAAU,MAAM,kBAAkB,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,KAAK,CAAC,CAIlF;IAEL;;;;;;OAMG;IACH,MAAM,GACJ,SAAS,MAAM,EACf,MAAM,kBAAkB,EACxB,UAAS,cAAmB,KAC3B,OAAO,CAAC,KAAK,CAAC,CAKZ;IAEL;;;;;OAKG;IACH,aAAa,GACX,SAAS,MAAM,EACf,MAAM,yBAAyB,EAC/B,UAAS,cAAmB,KAC3B,OAAO,CAAC,KAAK,CAAC,CAKZ;IAEL;;;;OAIG;IACH,MAAM,GAAU,SAAS,MAAM,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,IAAI,CAAC,CAIxE;IAEL;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,QAAQ,CAAC;IACnF,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,8BAA8B,GAAG,OAAO,CAAC,aAAa,CAAC;IAsC3F;;;;OAIG;IACH,MAAM,GAAU,OAAO,MAAM,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,QAAQ,CAAC,CAI1E;IAEL;;;OAGG;IACH,QAAQ,GAAU,UAAS,oBAAyB,KAAG,OAAO,CAAC,qBAAqB,CAAC,CAwBnF;IAEF;;OAEG;IACH,aAAa,GACX,UAAS;QACP,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAC5C,QAAQ,CAAC,EAAE,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,CAAC,EAAE,oBAAoB,CAAC,SAAS,CAAC,CAAC;KAC3C,GAAG,cAAmB,KACtB,OAAO,CAAC,qBAAqB,CAAC,CAsB/B;IAEF;;;OAGG;IACH,cAAc,GAAU,OAAO,MAAM,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,aAAa,CAAC,CAIvF;IAEL;;;;OAIG;IACH,OAAO,GAAU,OAAO,MAAM,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,aAAa,CAAC,CAIhF;IAEL;;OAEG;IACH,iBAAiB,GACf,OAAO,MAAM,EACb,UAAS,cAAmB,KAC3B,OAAO,CAAC,2BAA2B,CAAC,WAAW,CAAC,CAAC,CASlD;IAEF;;;;;OAKG;IACH,sBAAsB,GAAU,OAAO,MAAM,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,MAAM,CAAC,CAIxF;IAEL;;;OAGG;IACH,qBAAqB,GACnB,OAAO,MAAM,EACb,UAAS,cAAmB,KAC3B,OAAO,CAAC,0BAA0B,CAAC,CASpC;IAEF;;;;;;;;;;;;;OAaG;IACH,gBAAgB,GACd,OAAO,MAAM,EACb,YAAY,CAAC,MAAM,EAAE,aAAa,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,EAC3D,UAAS;QAAE,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,cAAmB,KACzE,OAAO,CAAC,QAAQ,CAAC,CAclB;CACH"}

package/dist/modules/suites/suites.types.d.ts

@@ -0,0 +1,31 @@
+import type { RequestOptions } from '../../types/config';
+import type { RunSuiteRequest, SuiteRunsListQuery, SuitesListQuery, SuiteRunState } from '@bugbug-io/api-schema';
+export interface ListSuitesOptions extends RequestOptions {
+    cursor?: SuitesListQuery['cursor'];
+    pageSize?: SuitesListQuery['page_size'];
+    query?: SuitesListQuery['query'];
+    ordering?: SuitesListQuery['ordering'];
+}
+export interface ListSuiteRunsOptions extends RequestOptions {
+    cursor?: SuiteRunsListQuery['cursor'];
+    pageSize?: SuiteRunsListQuery['page_size'];
+    ordering?: SuiteRunsListQuery['ordering'];
+    startedAfter?: SuiteRunsListQuery['started_after'];
+    startedBefore?: SuiteRunsListQuery['started_before'];
+    status?: SuiteRunsListQuery['status'];
+    suiteId?: SuiteRunsListQuery['suiteId'];
+}
+export interface RunSuiteBaseOptions extends RequestOptions {
+    profileName?: string;
+    variables?: NonNullable<RunSuiteRequest['variables']>;
+}
+export interface RunSuiteWatchProgressOptions extends RunSuiteBaseOptions {
+    watchProgress: true;
+    pollInterval?: number;
+    timeout?: number;
+    onProgress?: (status: SuiteRunState) => void | Promise<void>;
+}
+export interface RunSuiteNoWatchProgressOptions extends RunSuiteBaseOptions {
+    watchProgress?: false;
+}
+//# sourceMappingURL=suites.types.d.ts.map

package/dist/modules/suites/suites.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suites.types.d.ts","sourceRoot":"","sources":["../../../src/modules/suites/suites.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EACV,eAAe,EACf,kBAAkB,EAClB,eAAe,EACf,aAAa,EACd,MAAM,uBAAuB,CAAC;AAE/B,MAAM,WAAW,iBAAkB,SAAQ,cAAc;IACvD,MAAM,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;IACnC,QAAQ,CAAC,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC;IACxC,KAAK,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;IACjC,QAAQ,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;CACxC;AAED,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D,MAAM,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACtC,QAAQ,CAAC,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC;IAC3C,QAAQ,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAC1C,YAAY,CAAC,EAAE,kBAAkB,CAAC,eAAe,CAAC,CAAC;IACnD,aAAa,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;IACrD,MAAM,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACtC,OAAO,CAAC,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,mBAAoB,SAAQ,cAAc;IACzD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,4BAA6B,SAAQ,mBAAmB;IACvE,aAAa,EAAE,IAAI,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D;AAED,MAAM,WAAW,8BAA+B,SAAQ,mBAAmB;IACzE,aAAa,CAAC,EAAE,KAAK,CAAC;CACvB"}

package/dist/modules/tests/tests.d.ts

@@ -0,0 +1,253 @@
+import type { BugBugApiClient } from '../../services/apiClient/apiClient';
+import type { RequestOptions } from '../../types/config';
+import type { ImportTestOptions, ListTestRunsOptions, ListTestsOptions, RunTestNoWatchProgressOptions, RunTestWatchProgressOptions } from './tests.types';
+import type { ImportFormat, TestsListResponse, TestSummary, Test, TestRun, TestRunState, TestRunsListResponse, TestRunScreenshotsResponse, TestCreateRequest, TestUpdateRequest, InsertGroup, InsertGroupResponse, UnlinkComponentRequest, UnlinkComponentResponse, UpdateStepPositionRequest, UpdateStepPositionResponse, DebugArtifact, DebugArtifactByType, DebugArtifactsListResponse } from '@bugbug-io/api-schema';
+/**
+ * Tests module — manage BugBug tests and their runs.
+ *
+ * Exposes CRUD over `/tests/`, run lifecycle over `/testruns/`, component
+ * linking, debug artifacts, and YAML/ZIP export/import. Use {@link startRun}
+ * for the recommended high-level entry point with optional progress watching.
+ */
+export declare class TestsModule {
+    #private;
+    constructor(client: BugBugApiClient);
+    /**
+     * List tests with pagination, search, and ordering.
+     *
+     * @param options.cursor - Opaque cursor returned as `nextToken` by the previous page.
+     * @param options.pageSize - Number of items per page.
+     * @param options.query - Search query matched against test name.
+     * @param options.ordering - Sort key; prefix with `-` for descending.
+     * @returns Paginated `TestsListResponse` envelope (validated via Zod).
+     * @throws {UnexpectedResponseError} When the server response fails Zod validation.
+     */
+    list: (options?: ListTestsOptions) => Promise<TestsListResponse>;
+    /**
+     * Fetch every test across all pages.
+     */
+    getAll: (options?: Omit<ListTestsOptions, "cursor">) => Promise<TestSummary[]>;
+    /**
+     * Fetch a single test by ID.
+     *
+     * @param testId - UUID of the test.
+     * @returns The full `Test` resource.
+     * @throws {NotFoundError} When no test matches `testId`.
+     */
+    get: (testId: string, options?: RequestOptions) => Promise<Test>;
+    /**
+     * Create a new empty test.
+     *
+     * @param data - Test creation payload (at minimum, `name` and `screenSizeType`).
+     * @returns The newly-created `Test`.
+     * @throws {ValidationError} On invalid payload (DRF field errors on `error.fields`).
+     */
+    create: (data: TestCreateRequest, options?: RequestOptions) => Promise<Test>;
+    /**
+     * Update a test. The tests endpoint accepts partial payloads via PATCH, so
+     * this and {@link partialUpdate} share the same semantics.
+     *
+     * @param testId - UUID of the test to update.
+     * @param data - Fields to patch.
+     * @throws {NotFoundError} When the test does not exist.
+     * @throws {ValidationError} When the payload fails server-side validation.
+     */
+    update: (testId: string, data: TestUpdateRequest, options?: RequestOptions) => Promise<Test>;
+    /** Alias for {@link update}. The tests endpoint already uses PATCH semantics. */
+    partialUpdate: (testId: string, data: TestUpdateRequest, options?: RequestOptions) => Promise<Test>;
+    /**
+     * Delete a test by ID.
+     *
+     * @throws {NotFoundError} When the test does not exist.
+     */
+    delete: (testId: string, options?: RequestOptions) => Promise<void>;
+    /**
+     * Link an existing component/group into a test at an optional position.
+     *
+     * @param testId - UUID of the test to insert into.
+     * @param data - `{ groupId, atIndex? }` insertion descriptor.
+     * @returns Insert response with the resulting step layout.
+     */
+    linkComponent: (testId: string, data: InsertGroup, options?: RequestOptions) => Promise<InsertGroupResponse>;
+    /**
+     * Unlink a component/group from a test.
+     *
+     * @param testId - UUID of the test to unlink from.
+     * @param data - Unlink descriptor identifying which component to remove.
+     */
+    unlinkComponent: (testId: string, data: UnlinkComponentRequest, options?: RequestOptions) => Promise<UnlinkComponentResponse>;
+    /**
+     * Start a test run by name or ID, optionally watching progress until completion.
+     *
+     * When `testNameOrId` is a UUID the test is run directly. Otherwise it is
+     * looked up by name first ({@link NotFoundError} on miss). When
+     * `watchProgress` is `true`, the call polls until the run reaches a
+     * terminal status and returns the full `TestRun`; otherwise it returns the
+     * initial `TestRunState` synchronously after enqueueing the run.
+     *
+     * @param testNameOrId - Test UUID or human-readable test name.
+     * @param options.profileName - Run profile name or UUID; resolved via {@link ProfilesModule.resolveId}.
+     * @param options.variables - Per-run variable overrides (`{ key, value? }[]`).
+     * @param options.watchProgress - When `true`, block until the run completes.
+     * @param options.pollInterval - Poll interval in ms when watching progress (default 2000).
+     * @param options.timeout - Progress watching timeout in ms (default 5 minutes for tests).
+     * @param options.onProgress - Callback invoked on each poll with the latest `TestRunState`.
+     * @throws {NotFoundError} When `testNameOrId` is not a UUID and no test matches that name.
+     * @throws {TimeoutError} When `watchProgress` is true and the run does not finish in time.
+     *
+     * @example
+     * ```typescript
+     * // Fire-and-forget run by name
+     * const status = await sdk.tests.startRun('Smoke / login');
+     *
+     * // Run by ID, watch progress for up to 10 minutes
+     * const run = await sdk.tests.startRun('11111111-1111-4111-8111-111111111111', {
+     *   watchProgress: true,
+     *   timeout: 600_000,
+     *   profileName: 'Production',
+     *   onProgress: (s) => console.log(`${s.id}: ${s.status} (${s.finishedSteps}/${s.totalSteps})`),
+     * });
+     * ```
+     */
+    startRun(testNameOrId: string, options: RunTestWatchProgressOptions): Promise<TestRun>;
+    startRun(testNameOrId: string, options?: RunTestNoWatchProgressOptions): Promise<TestRunState>;
+    /**
+     * Fetch full test-run details including step runs.
+     *
+     * @param runId - UUID of the test run.
+     * @throws {NotFoundError} When the run does not exist.
+     */
+    getRun: (runId: string, options?: RequestOptions) => Promise<TestRun>;
+    /**
+     * Fetch only the lightweight status of a test run (no step detail).
+     * Prefer this over {@link getRun} when polling.
+     */
+    getRunProgress: (runId: string, options?: RequestOptions) => Promise<TestRunState>;
+    /**
+     * Request cancellation of an in-progress test run.
+     *
+     * @param runId - UUID of the run to stop.
+     * @returns The updated status; the run may still take a moment to settle.
+     */
+    stopRun: (runId: string, options?: RequestOptions) => Promise<TestRunState>;
+    /**
+     * Fetch step-level screenshots captured during a run.
+     *
+     * @returns Per-step-run screenshot entries; empty array when none available.
+     */
+    getRunScreenshots: (runId: string, options?: RequestOptions) => Promise<TestRunScreenshotsResponse["stepsRuns"]>;
+    /**
+     * List test runs filtered by status, time window, and optional test ID.
+     *
+     * @param options.testId - When set, restricts to runs of that test (UUID).
+     * @param options.startedAfter - ISO timestamp; only runs started after this point.
+     * @param options.startedBefore - ISO timestamp; only runs started before this point.
+     * @param options.status - Filter by `TestRunState['status']`.
+     * @returns Paginated `TestRunsListResponse`.
+     */
+    listRuns: (options?: ListTestRunsOptions) => Promise<TestRunsListResponse>;
+    /**
+     * Move a step to a new position within a test's step list.
+     *
+     * @param testId - UUID of the test to reorder.
+     * @param data - `{ stepId, atIndex }` move descriptor.
+     * @returns The updated `Test` with the new step ordering.
+     */
+    updateStepPosition: (testId: string, data: UpdateStepPositionRequest, options?: RequestOptions) => Promise<UpdateStepPositionResponse>;
+    /**
+     * Convenience wrapper around {@link listRuns} that returns runs started in
+     * the last N hours, newest first by default.
+     *
+     * @param options.hours - Look-back window in hours (default 24).
+     * @param options.pageSize - Max runs per page (default 50).
+     * @param options.ordering - Sort order; defaults to most-recent first.
+     */
+    getRecentRuns: (options?: {
+        hours?: number;
+        pageSize?: number;
+        ordering?: "-started" | "started";
+    } & RequestOptions) => Promise<TestRunsListResponse>;
+    /**
+     * Download the JUnit XML report for a test run. Useful for CI integrations
+     * that consume JUnit (e.g. Jenkins, GitLab CI, GitHub Actions test reporters).
+     *
+     * @returns The JUnit report body as a string.
+     */
+    downloadRunJunitReport: (runId: string, options?: RequestOptions) => Promise<string>;
+    /**
+     * Fetch test-run log output. The server may return either log content
+     * inline or a redirect/URL string — both are returned verbatim as text.
+     */
+    getRunLogs: (runId: string, options?: RequestOptions) => Promise<string>;
+    /**
+     * Poll a test run's lightweight `/status/` endpoint until it reaches a
+     * terminal status.
+     *
+     * Transient network errors are retried; non-network errors propagate.
+     *
+     * @param runId - UUID of the test run to watch.
+     * @param onProgress - Invoked on every successful poll with the latest `TestRunState`
+     *   (including the terminal one). Receives `finishedSteps`/`totalSteps`/`webappUrl`
+     *   for in-flight progress UI.
+     * @param options.pollInterval - Poll interval in ms (default 2000).
+     * @param options.timeout - Wait timeout in ms (default 300_000 = 5 minutes).
+     * @throws {TimeoutError} When the run does not complete within the timeout.
+     *
+     * @example
+     * ```typescript
+     * const run = await sdk.tests.watchRunProgress(
+     *   runId,
+     *   (s) => console.log(`${s.status} ${s.finishedSteps}/${s.totalSteps}`),
+     *   { pollInterval: 3000, timeout: 600_000 },
+     * );
+     * ```
+     */
+    watchRunProgress: (runId: string, onProgress: (status: TestRunState) => void | Promise<void>, options?: {
+        pollInterval?: number;
+        timeout?: number;
+    } & RequestOptions) => Promise<TestRun>;
+    /**
+     * List debug artifacts (HARs, traces, etc.) produced by a test run.
+     */
+    listRunDebugArtifacts: (runId: string, options?: RequestOptions) => Promise<DebugArtifactsListResponse>;
+    /**
+     * Fetch a single debug artifact (e.g. HAR, network trace) for a run.
+     *
+     * @param runId - UUID of the run.
+     * @param artifactType - Artifact discriminator (e.g. `'har'`).
+     */
+    getRunDebugArtifact: (runId: string, artifactType: DebugArtifactByType, options?: RequestOptions) => Promise<DebugArtifact>;
+    /**
+     * Export a test as YAML (string) or ZIP (Uint8Array).
+     *
+     * @param testId - UUID of the test to export.
+     * @param fmt - `'yaml'` returns a string body; `'zip'` returns binary bytes.
+     * @returns YAML text or raw ZIP bytes, matching `fmt`.
+     *
+     * @example
+     * ```typescript
+     * const yaml = await sdk.tests.export(testId, 'yaml');
+     * const zipBytes = await sdk.tests.export(testId, 'zip');
+     * ```
+     */
+    export(testId: string, fmt: 'yaml', options?: RequestOptions): Promise<string>;
+    export(testId: string, fmt: 'zip', options?: RequestOptions): Promise<Uint8Array>;
+    /**
+     * Import a single test from YAML (string) or ZIP (Uint8Array). Returns the
+     * created test summary.
+     *
+     * @param payload - YAML text or raw ZIP bytes.
+     * @param fmt - Format matching `payload` (`'yaml'` or `'zip'`).
+     * @param options.conflictMode - How to resolve naming collisions on the server
+     *   (e.g. `'rename'`). Forwarded as a query string parameter.
+     * @throws {ValidationError} When the server rejects the payload.
+     *
+     * @example
+     * ```typescript
+     * const yaml = await readFile('test.yaml', 'utf8');
+     * const test = await sdk.tests.import(yaml, 'yaml', { conflictMode: 'rename' });
+     * ```
+     */
+    import: (payload: string | Uint8Array, fmt: ImportFormat, options?: ImportTestOptions) => Promise<TestSummary>;
+}
+//# sourceMappingURL=tests.d.ts.map

package/dist/modules/tests/tests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tests.d.ts","sourceRoot":"","sources":["../../../src/modules/tests/tests.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EACV,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAEhB,6BAA6B,EAC7B,2BAA2B,EAC5B,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EACV,YAAY,EACZ,iBAAiB,EACjB,WAAW,EACX,IAAI,EACJ,OAAO,EACP,YAAY,EACZ,oBAAoB,EAEpB,0BAA0B,EAC1B,iBAAiB,EACjB,iBAAiB,EACjB,WAAW,EACX,mBAAmB,EACnB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC1B,aAAa,EACb,mBAAmB,EACnB,0BAA0B,EAC3B,MAAM,uBAAuB,CAAC;AAU/B;;;;;;GAMG;AACH,qBAAa,WAAW;;gBAIV,MAAM,EAAE,eAAe;IAKnC;;;;;;;;;OASG;IACH,IAAI,GAAU,UAAS,gBAAqB,KAAG,OAAO,CAAC,iBAAiB,CAAC,CAYvE;IAEF;;OAEG;IACH,MAAM,GAAU,UAAS,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAM,KAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CACQ;IAE/F;;;;;;OAMG;IACH,GAAG,GAAU,QAAQ,MAAM,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,IAAI,CAAC,CAIpE;IAEL;;;;;;OAMG;IACH,MAAM,GAAU,MAAM,iBAAiB,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,IAAI,CAAC,CAIhF;IAEL;;;;;;;;OAQG;IACH,MAAM,GACJ,QAAQ,MAAM,EACd,MAAM,iBAAiB,EACvB,UAAS,cAAmB,KAC3B,OAAO,CAAC,IAAI,CAAC,CAKX;IAEL,iFAAiF;IACjF,aAAa,GACX,QAAQ,MAAM,EACd,MAAM,iBAAiB,EACvB,UAAS,cAAmB,KAC3B,OAAO,CAAC,IAAI,CAAC,CAAuC;IAEvD;;;;OAIG;IACH,MAAM,GAAU,QAAQ,MAAM,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,IAAI,CAAC,CAIvE;IAEL;;;;;;OAMG;IACH,aAAa,GACX,QAAQ,MAAM,EACd,MAAM,WAAW,EACjB,UAAS,cAAmB,KAC3B,OAAO,CAAC,mBAAmB,CAAC,CAK1B;IAEL;;;;;OAKG;IACH,eAAe,GACb,QAAQ,MAAM,EACd,MAAM,sBAAsB,EAC5B,UAAS,cAAmB,KAC3B,OAAO,CAAC,uBAAuB,CAAC,CAK9B;IAyDL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,OAAO,CAAC;IACtF,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,6BAA6B,GAAG,OAAO,CAAC,YAAY,CAAC;IAiB9F;;;;;OAKG;IACH,MAAM,GAAU,OAAO,MAAM,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,OAAO,CAAC,CAIzE;IAEL;;;OAGG;IACH,cAAc,GAAU,OAAO,MAAM,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,YAAY,CAAC,CAItF;IAEL;;;;;OAKG;IACH,OAAO,GAAU,OAAO,MAAM,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,YAAY,CAAC,CAI/E;IAEL;;;;OAIG;IACH,iBAAiB,GACf,OAAO,MAAM,EACb,UAAS,cAAmB,KAC3B,OAAO,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC,CASjD;IAEF;;;;;;;;OAQG;IACH,QAAQ,GAAU,UAAS,mBAAwB,KAAG,OAAO,CAAC,oBAAoB,CAAC,CAwBjF;IAEF;;;;;;OAMG;IACH,kBAAkB,GAChB,QAAQ,MAAM,EACd,MAAM,yBAAyB,EAC/B,UAAS,cAAmB,KAC3B,OAAO,CAAC,0BAA0B,CAAC,CAKjC;IAEL;;;;;;;OAOG;IACH,aAAa,GACX,UAAS;QACP,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;KACnC,GAAG,cAAmB,KACtB,OAAO,CAAC,oBAAoB,CAAC,CAW9B;IAEF;;;;;OAKG;IACH,sBAAsB,GAAU,OAAO,MAAM,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,MAAM,CAAC,CAIxF;IAEL;;;OAGG;IACH,UAAU,GAAU,OAAO,MAAM,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,MAAM,CAAC,CAI5E;IAEL;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,gBAAgB,GACd,OAAO,MAAM,EACb,YAAY,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,EAC1D,UAAS;QAAE,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,cAAmB,KACzE,OAAO,CAAC,OAAO,CAAC,CAcjB;IAEF;;OAEG;IACH,qBAAqB,GACnB,OAAO,MAAM,EACb,UAAS,cAAmB,KAC3B,OAAO,CAAC,0BAA0B,CAAC,CASpC;IAEF;;;;;OAKG;IACH,mBAAmB,GACjB,OAAO,MAAM,EACb,cAAc,mBAAmB,EACjC,UAAS,cAAmB,KAC3B,OAAO,CAAC,aAAa,CAAC,CAIpB;IAEL;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAC9E,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;IAkBjF;;;;;;;;;;;;;;;OAeG;IACH,MAAM,GACJ,SAAS,MAAM,GAAG,UAAU,EAC5B,KAAK,YAAY,EACjB,UAAS,iBAAsB,KAC9B,OAAO,CAAC,WAAW,CAAC,CASrB;CACH"}

package/dist/modules/tests/tests.types.d.ts

@@ -0,0 +1,34 @@
+import type { RequestOptions } from '../../types/config';
+import type { RunTestRequest, TestRunState, TestRunsListQuery, TestsListQuery } from '@bugbug-io/api-schema';
+export interface ImportTestOptions extends RequestOptions {
+    conflictMode?: string;
+}
+export interface ListTestsOptions extends RequestOptions {
+    cursor?: TestsListQuery['cursor'];
+    pageSize?: TestsListQuery['page_size'];
+    query?: TestsListQuery['query'];
+    ordering?: TestsListQuery['ordering'];
+}
+export interface ListTestRunsOptions extends RequestOptions {
+    cursor?: TestRunsListQuery['cursor'];
+    pageSize?: TestRunsListQuery['page_size'];
+    ordering?: TestRunsListQuery['ordering'];
+    startedAfter?: TestRunsListQuery['started_after'];
+    startedBefore?: TestRunsListQuery['started_before'];
+    status?: TestRunsListQuery['status'];
+    testId?: TestRunsListQuery['testId'];
+}
+export interface RunTestBaseOptions extends RequestOptions {
+    profileName?: string;
+    variables?: NonNullable<RunTestRequest['variables']>;
+}
+export interface RunTestWatchProgressOptions extends RunTestBaseOptions {
+    watchProgress: true;
+    pollInterval?: number;
+    timeout?: number;
+    onProgress?: (status: TestRunState) => void | Promise<void>;
+}
+export interface RunTestNoWatchProgressOptions extends RunTestBaseOptions {
+    watchProgress?: false;
+}
+//# sourceMappingURL=tests.types.d.ts.map

package/dist/modules/tests/tests.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tests.types.d.ts","sourceRoot":"","sources":["../../../src/modules/tests/tests.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EACV,cAAc,EACd,YAAY,EACZ,iBAAiB,EACjB,cAAc,EACf,MAAM,uBAAuB,CAAC;AAE/B,MAAM,WAAW,iBAAkB,SAAQ,cAAc;IACvD,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACtD,MAAM,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;IAClC,QAAQ,CAAC,EAAE,cAAc,CAAC,WAAW,CAAC,CAAC;IACvC,KAAK,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;IAChC,QAAQ,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,mBAAoB,SAAQ,cAAc;IACzD,MAAM,CAAC,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACrC,QAAQ,CAAC,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAC;IAC1C,QAAQ,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACzC,YAAY,CAAC,EAAE,iBAAiB,CAAC,eAAe,CAAC,CAAC;IAClD,aAAa,CAAC,EAAE,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;IACpD,MAAM,CAAC,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACrC,MAAM,CAAC,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC;CACtD;AAED,MAAM,WAAW,2BAA4B,SAAQ,kBAAkB;IACrE,aAAa,EAAE,IAAI,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7D;AAED,MAAM,WAAW,6BAA8B,SAAQ,kBAAkB;IACvE,aAAa,CAAC,EAAE,KAAK,CAAC;CACvB"}

package/dist/modules/tests/tests.utils.d.ts

@@ -0,0 +1,11 @@
+import type { ImportFormat } from '@bugbug-io/api-schema';
+/**
+ * Build a multipart form payload for `POST /tests/import/`.
+ *
+ * The endpoint expects a single `file` part. YAML payloads are sent as
+ * `application/x-yaml`; ZIP payloads as `application/zip`. The filename is
+ * cosmetic but required so the server's content-disposition parser accepts
+ * the upload.
+ */
+export declare function buildTestImportFormData(payload: string | Uint8Array, fmt: ImportFormat): FormData;
+//# sourceMappingURL=tests.utils.d.ts.map

package/dist/modules/tests/tests.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tests.utils.d.ts","sourceRoot":"","sources":["../../../src/modules/tests/tests.utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE1D;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,EAAE,GAAG,EAAE,YAAY,GAAG,QAAQ,CAUjG"}

package/dist/modules/variables/variables.d.ts

@@ -0,0 +1,14 @@
+import type { BugBugApiClient } from '../../services/apiClient/apiClient';
+import type { RequestOptions } from '../../types/config';
+import type { CreateVariableOptions, UpdateVariableOptions } from './variables.types';
+import type { CreatedVariable, Variable, VariablesListResponse } from '@bugbug-io/api-schema';
+export declare class VariablesModule {
+    #private;
+    constructor(client: BugBugApiClient);
+    list: (options?: RequestOptions) => Promise<VariablesListResponse>;
+    get: (key: string, options?: RequestOptions) => Promise<Variable>;
+    create: (options: CreateVariableOptions) => Promise<CreatedVariable>;
+    update: (key: string, options: UpdateVariableOptions) => Promise<Variable>;
+}
+export type { CreatedVariable, Variable, VariablesListResponse };
+//# sourceMappingURL=variables.d.ts.map

package/dist/modules/variables/variables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"variables.d.ts","sourceRoot":"","sources":["../../../src/modules/variables/variables.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AACtF,OAAO,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAE9F,qBAAa,eAAe;;gBAGd,MAAM,EAAE,eAAe;IAInC,IAAI,GAAU,UAAS,cAAmB,KAAG,OAAO,CAAC,qBAAqB,CAAC,CACT;IAElE,GAAG,GAAU,KAAK,MAAM,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,QAAQ,CAAC,CAIrE;IAEL,MAAM,GAAU,SAAS,qBAAqB,KAAG,OAAO,CAAC,eAAe,CAAC,CAavE;IAEF,MAAM,GAAU,KAAK,MAAM,EAAE,SAAS,qBAAqB,KAAG,OAAO,CAAC,QAAQ,CAAC,CAa7E;CACH;AAED,YAAY,EAAE,eAAe,EAAE,QAAQ,EAAE,qBAAqB,EAAE,CAAC"}

package/dist/modules/variables/variables.types.d.ts

@@ -0,0 +1,7 @@
+import type { RequestOptions } from '../../types/config';
+import type { CreateVariableRequest, UpdateVariableRequest } from '@bugbug-io/api-schema';
+export interface CreateVariableOptions extends CreateVariableRequest, RequestOptions {
+}
+export interface UpdateVariableOptions extends UpdateVariableRequest, RequestOptions {
+}
+//# sourceMappingURL=variables.types.d.ts.map

package/dist/modules/variables/variables.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"variables.types.d.ts","sourceRoot":"","sources":["../../../src/modules/variables/variables.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAE1F,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB,EAAE,cAAc;CAAG;AAEvF,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB,EAAE,cAAc;CAAG"}

package/dist/modules/visualRegression/visualRegression.constants.d.ts

@@ -0,0 +1,7 @@
+export declare const VISUAL_REGRESSION_RESOLUTION_ACTIONS: readonly ["acceptBaseline", "increaseMaxDifference"];
+export type VisualRegressionResolutionAction = (typeof VISUAL_REGRESSION_RESOLUTION_ACTIONS)[number];
+export declare const VISUAL_REGRESSION_RESOLUTION_TYPE_BY_ACTION: {
+    readonly acceptBaseline: "set_new_reference";
+    readonly increaseMaxDifference: "set_new_max_difference";
+};
+//# sourceMappingURL=visualRegression.constants.d.ts.map

package/dist/modules/visualRegression/visualRegression.constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"visualRegression.constants.d.ts","sourceRoot":"","sources":["../../../src/modules/visualRegression/visualRegression.constants.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,oCAAoC,sDAGvC,CAAC;AAEX,MAAM,MAAM,gCAAgC,GAC1C,CAAC,OAAO,oCAAoC,CAAC,CAAC,MAAM,CAAC,CAAC;AAExD,eAAO,MAAM,2CAA2C;;;CAGqC,CAAC"}

package/dist/modules/visualRegression/visualRegression.d.ts

@@ -0,0 +1,69 @@
+import type { BugBugApiClient } from '../../services/apiClient/apiClient';
+import type { RequestOptions } from '../../types/config';
+import type { VisualRegressionResolutionType, VisualRegressionResolveResponse } from './visualRegression.types';
+import type { VisualRegressionRefScreenshot, VisualRegressionRefScreenshotCreate, VisualRegressionRefScreenshotPatch, VisualRegressionRefScreenshotsListQuery, VisualRegressionRefScreenshotsListResponse } from '@bugbug-io/api-schema';
+/**
+ * Visual regression module — manage reference screenshots that anchor
+ * element/page visual-regression steps.
+ *
+ * A reference screenshot represents the "expected" pixels for a step; the
+ * runner compares each run's screenshot against the active reference.
+ */
+export declare class VisualRegressionModule {
+    #private;
+    constructor(client: BugBugApiClient);
+    /**
+     * List reference screenshots for a given step.
+     *
+     * @param options.stepId - UUID of the visual-regression step (required).
+     * @param options.cursor - Opaque cursor returned as `nextToken` by the previous page.
+     * @param options.pageSize - Items per page.
+     */
+    listReferenceScreenshots: (options: {
+        stepId: VisualRegressionRefScreenshotsListQuery["step_id"];
+        cursor?: VisualRegressionRefScreenshotsListQuery["cursor"];
+        pageSize?: VisualRegressionRefScreenshotsListQuery["page_size"];
+    } & RequestOptions) => Promise<VisualRegressionRefScreenshotsListResponse>;
+    /**
+     * Fetch a single reference screenshot.
+     *
+     * @throws {NotFoundError} When no reference screenshot matches `id`.
+     */
+    getReferenceScreenshot: (id: string, options?: RequestOptions) => Promise<VisualRegressionRefScreenshot>;
+    /**
+     * Create a new reference screenshot for a visual-regression step.
+     *
+     * @throws {ValidationError} On invalid payload.
+     */
+    createReferenceScreenshot: (data: VisualRegressionRefScreenshotCreate, options?: RequestOptions) => Promise<VisualRegressionRefScreenshot>;
+    /**
+     * Patch a reference screenshot.
+     *
+     * @throws {NotFoundError} When the reference screenshot does not exist.
+     * @throws {ValidationError} On invalid payload.
+     */
+    updateReferenceScreenshot: (id: string, data: VisualRegressionRefScreenshotPatch, options?: RequestOptions) => Promise<VisualRegressionRefScreenshot>;
+    /**
+     * Delete a reference screenshot.
+     *
+     * @throws {NotFoundError} When the reference screenshot does not exist.
+     */
+    deleteReferenceScreenshot: (id: string, options?: RequestOptions) => Promise<void>;
+    /**
+     * Resolve failed visual-regression checks.
+     *
+     * @param options.type - `set_new_reference` accepts the observed screenshot as the new
+     *   baseline; `set_new_max_difference` raises the step's allowed difference to just above
+     *   the observed value. The value is computed server-side and cannot be supplied.
+     * @param options.stepRunId - Resolve a single step run.
+     * @param options.testRunId - Resolve every failed visual-regression step in a test run.
+     *
+     * Provide exactly one of `stepRunId` or `testRunId`.
+     */
+    resolveReview: (options: {
+        type: VisualRegressionResolutionType;
+        testRunId?: string;
+        stepRunId?: string;
+    } & RequestOptions) => Promise<VisualRegressionResolveResponse>;
+}
+//# sourceMappingURL=visualRegression.d.ts.map

package/dist/modules/visualRegression/visualRegression.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"visualRegression.d.ts","sourceRoot":"","sources":["../../../src/modules/visualRegression/visualRegression.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EACV,8BAA8B,EAC9B,+BAA+B,EAChC,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EACV,6BAA6B,EAC7B,mCAAmC,EACnC,kCAAkC,EAClC,uCAAuC,EACvC,0CAA0C,EAC3C,MAAM,uBAAuB,CAAC;AAE/B;;;;;;GAMG;AACH,qBAAa,sBAAsB;;gBAGrB,MAAM,EAAE,eAAe;IAInC;;;;;;OAMG;IACH,wBAAwB,GACtB,SAAS;QACP,MAAM,EAAE,uCAAuC,CAAC,SAAS,CAAC,CAAC;QAC3D,MAAM,CAAC,EAAE,uCAAuC,CAAC,QAAQ,CAAC,CAAC;QAC3D,QAAQ,CAAC,EAAE,uCAAuC,CAAC,WAAW,CAAC,CAAC;KACjE,GAAG,cAAc,KACjB,OAAO,CAAC,0CAA0C,CAAC,CASpD;IAEF;;;;OAIG;IACH,sBAAsB,GACpB,IAAI,MAAM,EACV,UAAS,cAAmB,KAC3B,OAAO,CAAC,6BAA6B,CAAC,CAIrC;IAEJ;;;;OAIG;IACH,yBAAyB,GACvB,MAAM,mCAAmC,EACzC,UAAS,cAAmB,KAC3B,OAAO,CAAC,6BAA6B,CAAC,CAIpC;IAEL;;;;;OAKG;IACH,yBAAyB,GACvB,IAAI,MAAM,EACV,MAAM,kCAAkC,EACxC,UAAS,cAAmB,KAC3B,OAAO,CAAC,6BAA6B,CAAC,CAIrC;IAEJ;;;;OAIG;IACH,yBAAyB,GAAU,IAAI,MAAM,EAAE,UAAS,cAAmB,KAAG,OAAO,CAAC,IAAI,CAAC,CAItF;IAEL;;;;;;;;;;OAUG;IACH,aAAa,GACX,SAAS;QACP,IAAI,EAAE,8BAA8B,CAAC;QACrC,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,cAAc,KACjB,OAAO,CAAC,+BAA+B,CAAC,CAUzC;CACH"}

package/dist/modules/visualRegression/visualRegression.types.d.ts

@@ -0,0 +1,12 @@
+export type VisualRegressionResolutionType = 'set_new_reference' | 'set_new_max_difference';
+export interface VisualRegressionResolveResult {
+    stepId: string;
+    stepRunId: string;
+    message?: string;
+    referenceUrl?: string;
+    visualRegressionMaxDiff?: number;
+}
+export interface VisualRegressionResolveResponse {
+    results: VisualRegressionResolveResult[];
+}
+//# sourceMappingURL=visualRegression.types.d.ts.map