Class VisualRegressionModule

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.

Index

Constructors

constructor

Methods

listReferenceScreenshots getReferenceScreenshot createReferenceScreenshot updateReferenceScreenshot deleteReferenceScreenshot resolveReview

Constructors

constructor

new VisualRegressionModule(client: BugBugApiClient): VisualRegressionModule
Parameters
- client: BugBugApiClient
Returns VisualRegressionModule
- Defined in sdk/src/modules/visualRegression/visualRegression.ts:25

Methods

listReferenceScreenshots

listReferenceScreenshots(
options: { stepId: string; cursor?: string; pageSize?: number } & RequestOptions,
): Promise<VisualRegressionRefScreenshotsListResponse>
List reference screenshots for a given step.
Parameters
- options: { stepId: string; cursor?: string; pageSize?: number } & RequestOptions
  - stepId: string
    UUID of the visual-regression step (required).
  - Optionalcursor?: string
    Opaque cursor returned as nextToken by the previous page.
  - OptionalpageSize?: number
    Items per page.
Returns Promise<VisualRegressionRefScreenshotsListResponse>
- Defined in sdk/src/modules/visualRegression/visualRegression.ts:36

getReferenceScreenshot

getReferenceScreenshot(
    id: string,
    options?: RequestOptions,
): Promise<
    {
        id: string;
        stepId: string;
        projectArtifactId: string
        | null;
        screenshotUrl: string | null;
        browserName: string | null;
        osName: string | null;
        screenSizeType: string | null;
        runProfileId: string | null;
        runProfileName: string;
        runMode: "recording" | "server" | "local" | null;
        created: string;
        modified: string;
    },
>
Fetch a single reference screenshot.
Parameters
- id: string
- options: RequestOptions = {}
Returns Promise<
    {
        id: string;
        stepId: string;
        projectArtifactId: string
        | null;
        screenshotUrl: string | null;
        browserName: string | null;
        osName: string | null;
        screenSizeType: string | null;
        runProfileId: string | null;
        runProfileName: string;
        runMode: "recording" | "server" | "local" | null;
        created: string;
        modified: string;
    },
>
Throws
When no reference screenshot matches id.
- Defined in sdk/src/modules/visualRegression/visualRegression.ts:58

createReferenceScreenshot

createReferenceScreenshot(
    data: {
        stepId: string;
        screenshot: string;
        browserName?: string | null;
        osName?: string | null;
        screenSizeType?: "" | "desktop" | "mobile" | "custom" | null;
        runProfileId?: string | null;
        runMode?: "" | "recording" | "server" | "local" | null;
    },
    options?: RequestOptions,
): Promise<
    {
        id: string;
        stepId: string;
        projectArtifactId: string
        | null;
        screenshotUrl: string | null;
        browserName: string | null;
        osName: string | null;
        screenSizeType: string | null;
        runProfileId: string | null;
        runProfileName: string;
        runMode: "recording" | "server" | "local" | null;
        created: string;
        modified: string;
    },
>
Create a new reference screenshot for a visual-regression step.
Parameters
- data: {
      stepId: string;
      screenshot: string;
      browserName?: string | null;
      osName?: string | null;
      screenSizeType?: "" | "desktop" | "mobile" | "custom" | null;
      runProfileId?: string | null;
      runMode?: "" | "recording" | "server" | "local" | null;
  }
  - stepId: string
    Format: uuid
  - screenshot: string
    Format: uri
  - OptionalbrowserName?: string | null
  - OptionalosName?: string | null
  - OptionalscreenSizeType?: "" | "desktop" | "mobile" | "custom" | null
    Description
    
    desktop - Desktop
    
    mobile - Mobile
    
    custom - Custom
  - OptionalrunProfileId?: string | null
    Format: uuid
  - OptionalrunMode?: "" | "recording" | "server" | "local" | null
    Description
    
    server - cloud
    
    local - local
    
    recording - recording
- options: RequestOptions = {}
Returns Promise<
    {
        id: string;
        stepId: string;
        projectArtifactId: string
        | null;
        screenshotUrl: string | null;
        browserName: string | null;
        osName: string | null;
        screenSizeType: string | null;
        runProfileId: string | null;
        runProfileName: string;
        runMode: "recording" | "server" | "local" | null;
        created: string;
        modified: string;
    },
>
Throws
On invalid payload.
- Defined in sdk/src/modules/visualRegression/visualRegression.ts:72

updateReferenceScreenshot

updateReferenceScreenshot(
    id: string,
    data: { screenshot?: string },
    options?: RequestOptions,
): Promise<
    {
        id: string;
        stepId: string;
        projectArtifactId: string
        | null;
        screenshotUrl: string | null;
        browserName: string | null;
        osName: string | null;
        screenSizeType: string | null;
        runProfileId: string | null;
        runProfileName: string;
        runMode: "recording" | "server" | "local" | null;
        created: string;
        modified: string;
    },
>
Patch a reference screenshot.
Parameters
- id: string
- data: { screenshot?: string }
  - Optionalscreenshot?: string
    Format: uri
- options: RequestOptions = {}
Returns Promise<
    {
        id: string;
        stepId: string;
        projectArtifactId: string
        | null;
        screenshotUrl: string | null;
        browserName: string | null;
        osName: string | null;
        screenSizeType: string | null;
        runProfileId: string | null;
        runProfileName: string;
        runMode: "recording" | "server" | "local" | null;
        created: string;
        modified: string;
    },
>
Throws
When the reference screenshot does not exist.

Throws
On invalid payload.
- Defined in sdk/src/modules/visualRegression/visualRegression.ts:87

deleteReferenceScreenshot

deleteReferenceScreenshot(id: string, options?: RequestOptions): Promise<void>
Delete a reference screenshot.
Parameters
- id: string
- options: RequestOptions = {}
Returns Promise<void>
Throws
When the reference screenshot does not exist.
- Defined in sdk/src/modules/visualRegression/visualRegression.ts:102

resolveReview

resolveReview(
    options: {
        type: VisualRegressionResolutionType;
        testRunId?: string;
        stepRunId?: string;
    } & RequestOptions,
): Promise<VisualRegressionResolveResponse>
Resolve failed visual-regression checks.
Parameters
- options: { type: VisualRegressionResolutionType; testRunId?: string; stepRunId?: string } & RequestOptions
  - type: VisualRegressionResolutionType
    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.
  - OptionaltestRunId?: string
    Resolve every failed visual-regression step in a test run.
    
    Provide exactly one of stepRunId or testRunId.
  - OptionalstepRunId?: string
    Resolve a single step run.
Returns Promise<VisualRegressionResolveResponse>
- Defined in sdk/src/modules/visualRegression/visualRegression.ts:119

Class VisualRegressionModule

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns VisualRegressionModule

Methods

listReferenceScreenshots

Parameters

stepId: string

Optionalcursor?: string

OptionalpageSize?: number

Returns Promise<VisualRegressionRefScreenshotsListResponse>

getReferenceScreenshot

Parameters

Throws

createReferenceScreenshot

Parameters

stepId: string

screenshot: string

OptionalbrowserName?: string | null

OptionalosName?: string | null

OptionalscreenSizeType?: "" | "desktop" | "mobile" | "custom" | null

Description

OptionalrunProfileId?: string | null

OptionalrunMode?: "" | "recording" | "server" | "local" | null

Description

Throws

updateReferenceScreenshot

Parameters

Optionalscreenshot?: string

Throws

Throws

deleteReferenceScreenshot

Parameters

Returns Promise<void>

Throws

resolveReview

Parameters

type: VisualRegressionResolutionType

OptionaltestRunId?: string

OptionalstepRunId?: string

Returns Promise<VisualRegressionResolveResponse>

Settings

On This Page

`Optional`cursor?: string

`Optional`pageSize?: number

`Optional`browserName?: string | null

`Optional`osName?: string | null

`Optional`screenSizeType?: "" | "desktop" | "mobile" | "custom" | null

`Optional`runProfileId?: string | null

`Optional`runMode?: "" | "recording" | "server" | "local" | null

`Optional`screenshot?: string

`Optional`testRunId?: string

`Optional`stepRunId?: string