webcap

package module

Go to main page

Versions in this module

v0

v0.9.2

Sep 13, 2026

v0.9.1

Jun 1, 2026

v0.9.0

Jun 1, 2026

Changes in this version

+ const DefaultAuthLoginPath

+ var DefaultDebugCookieNames = []string

+ func RedactAuthSecrets(text string, secrets ...string) string

+ type AuthCookieDiagnostic struct

+ Applicable *bool

+ CaptureImportOK bool

+ CheckedAt *time.Time

+ Domain string

+ Expired bool

+ Expires int64

+ HTTPOnly bool

+ HostOnly bool

+ Name string

+ NotApplicable []string

+ Path string

+ SameSite string

+ Secure bool

+ Skipped bool

+ SourceLine int

+ StorageState bool

+ type AuthDiagnosticWarning struct

+ Code string

+ Cookie string

+ Message string

+ type AuthExpectedCookieStatus struct

+ Applicable *bool

+ MatchedName string

+ Name string

+ Reasons []string

+ Status string

+ type AuthInspectRequest struct

+ CookieJar string

+ ExpectCookies []string

+ StorageState string

+ TargetURL string

+ WarnDebugCookies []string

+ type AuthInspectResult struct

+ Command string

+ Cookies []AuthCookieDiagnostic

+ ExpectedCookies []AuthExpectedCookieStatus

+ HasOriginStorage bool

+ InspectedAt time.Time

+ Source AuthStateSource

+ TargetURL string

+ Warnings []AuthDiagnosticWarning

+ func InspectAuthState(req AuthInspectRequest, now time.Time) (AuthInspectResult, error)

+ type AuthLoginRequest struct

+ BaseURL string

+ CookieJar string

+ ExpectCookies []string

+ Identifier string

+ LoginPath string

+ PasswordEnv string

+ ScriptPath string

+ TargetURL string

+ Timeout string

+ type AuthLoginResult struct

+ BaseURL string

+ Command string

+ CookieJar string

+ ExpectedCookies []string

+ Inspection AuthInspectResult

+ LoginPath string

+ Script AuthScriptResult

+ TargetURL string

+ func LoginAuthState(ctx context.Context, req AuthLoginRequest, now time.Time) (AuthLoginResult, error)

+ type AuthScriptResult struct

+ Cancelled bool

+ ExitCode int

+ Mode string

+ Path string

+ Stderr string

+ Stdout string

+ TimedOut bool

+ type AuthStateSource struct

+ Path string

+ Type string

v0.8.0

May 29, 2026

v0.7.0

May 29, 2026

Changes in this version

+ func LoadPlaywrightStorageState(path string) (playwrightStorageState, error)

+ type CaptureAuth struct

+ CookieJar string

+ Cookies []CaptureCookie

+ Headers []CaptureHeader

+ StorageState string

+ func (a CaptureAuth) IsZero() bool

+ func (a CaptureAuth) Redacted() CaptureAuth

+ type CaptureCookie struct

+ Domain string

+ Expires int64

+ HTTPOnly bool

+ HostOnly bool

+ Name string

+ Path string

+ SameSite string

+ Secure bool

+ Value string

+ func ParseCookieJarFile(path string, now time.Time) ([]CaptureCookie, error)

+ type CaptureGuards struct

+ ExpectURL string

+ FailOnSelector []string

+ FailOnURL []string

+ func (g CaptureGuards) IsZero() bool

+ type CaptureHeader struct

+ Name string

+ Value string

type CaptureRequest

+ Auth CaptureAuth

+ Guards CaptureGuards

+ func (req CaptureRequest) Redacted() CaptureRequest

type CaptureResult

+ Guards []GuardOutcome

type EngineResult

+ Guards []GuardOutcome

+ type GuardOutcome struct

+ FinalURL string

+ Kind string

+ Matched bool

+ Status string

+ Value string

type Manifest

+ Auth CaptureAuth

+ Guards CaptureGuards

+ SourceDir string

+ SourcePath string

type ManifestShot

+ Auth CaptureAuth

+ Guards CaptureGuards

type WorkflowDefaults

+ Auth CaptureAuth

+ Guards CaptureGuards

v0.6.1

May 24, 2026

Changes in this version

type CaptureWarning

+ Metadata map[string]any

type ErrorCode

+ const CodeProviderAuth

+ const CodeProviderExecutionFailed

+ const CodeProviderInvalidRequest

+ const CodeProviderPayloadTooLarge

+ const CodeProviderQuota

+ const CodeProviderRateLimited

+ const CodeProviderTimeout

+ const CodeProviderUnavailable

type SemanticDiffOptions

+ MaxCombinedEncodedImageBytes int64

+ MaxEncodedImageBytes int64

+ MaxImageLongEdge int

+ MaxImagePixels int64

+ MaxProviderImageBytes int64

+ MaxRequestBodyBytes int64

+ ResizeImages bool

type SemanticDiffResult

+ ImageMetadata []SemanticImageMetadata

+ type SemanticImageMetadata struct

+ Limits map[string]any

+ MIMEType string

+ OriginalByteSize int64

+ OriginalHeight int

+ OriginalPath string

+ OriginalWidth int

+ ProviderByteSize int64

+ ProviderHeight int

+ ProviderPath string

+ ProviderWidth int

+ ResizeReason string

+ Role string

type SemanticImagePayload

+ Height int

+ Metadata SemanticImageMetadata

+ Width int

type SemanticProviderRequest

+ MaxRequestBodyBytes int64

v0.6.0

May 18, 2026

Changes in this version

type CaptureRequest

+ WaitForFunction string

type Manifest

+ WaitForFunction string

type ManifestShot

+ WaitForFunction string

type WorkflowDefaults

+ WaitForFunction string

v0.5.0

May 11, 2026

Changes in this version

+ const DefaultOversizePolicy

+ const DefaultTileMaxHeight

+ const DefaultTileMaxPixels

+ const DefaultTileMaxStitchPixels

+ const DefaultTileMaxTargetPixels

+ const DefaultTileMaxWidth

+ const DefaultTileOverlap

type CaptureRequest

+ OversizePolicy OversizePolicy

+ Tile CaptureTileOptions

type CaptureResult

+ Tiling *CaptureTiling

+ type CaptureTile struct

+ ByteSize int

+ Bytes []byte

+ Column int

+ DestinationBounds *Bounds

+ Error string

+ Index int

+ OutputPath string

+ Row int

+ SourceBounds Bounds

+ Status CaptureTileStatus

+ type CaptureTileLimits struct

+ MaxHeight int

+ MaxPixels int64

+ MaxStitchedPixels int64

+ MaxTargetPixels int64

+ MaxWidth int

+ Overlap int

+ ScaleFactor float64

+ type CaptureTileOptions struct

+ CleanupTiles bool

+ MaxHeight int

+ MaxPixels int64

+ MaxStitchedPixels int64

+ MaxTargetPixels int64

+ MaxWidth int

+ Overlap int

+ Stitch bool

+ func (o *CaptureTileOptions) UnmarshalJSON(payload []byte) error

+ func (o *CaptureTileOptions) UnmarshalYAML(value *yaml.Node) error

+ func (o CaptureTileOptions) IsZero() bool

+ type CaptureTileStatus string

+ const CaptureTileCompleted

+ const CaptureTileFailed

+ const CaptureTilePending

+ type CaptureTiling struct

+ CompletedCount int

+ FailedCount int

+ Limits CaptureTileLimits

+ MetadataPath string

+ Status CaptureTilingStatus

+ StitchedPath string

+ TargetBounds Bounds

+ TileCount int

+ Tiles []CaptureTile

+ Warnings []CaptureWarning

+ type CaptureTilingStatus string

+ const CaptureTilingComplete

+ const CaptureTilingFailed

+ const CaptureTilingPartial

type EngineResult

+ Tiling *CaptureTiling

type ErrorCode

+ const CodeOversize

+ const CodePartialCapture

+ const CodeUnsupported

type Manifest

+ OversizePolicy OversizePolicy

+ Tile CaptureTileOptions

type ManifestShot

+ OversizePolicy OversizePolicy

+ Tile CaptureTileOptions

+ type OversizePolicy string

+ const OversizePolicyFail

+ const OversizePolicyTile

+ type PartialCaptureError struct

+ CompletedCount int

+ Err error

+ FailedTileIndex int

+ Operation string

+ Result *CaptureResult

+ TotalCount int

+ func (e *PartialCaptureError) Error() string

+ func (e *PartialCaptureError) Unwrap() error

+ func (e *PartialCaptureError) WithResult(result CaptureResult) *PartialCaptureError

type WorkflowDefaults

+ OversizePolicy OversizePolicy

+ Tile CaptureTileOptions

v0.4.0

May 11, 2026

v0.3.0

May 11, 2026

v0.2.0

May 11, 2026

Changes in this version

+ const WorkflowComparisonModeContentOnly

+ const WorkflowComparisonModeFull

+ const WorkflowComparisonResizeCurrent

+ const WorkflowComparisonResizeReference

+ const WorkflowHookModeAppend

+ const WorkflowHookModeReplace

+ const WorkflowReportFormatHTML

+ func DefaultArtifactBaseName(req CaptureRequest) string

+ func DefaultDiffDirectoryName(req DiffRequest) string

+ func DefaultDiffImageName(req DiffRequest) string

+ func DefaultPlaywrightRuntimeDir() string

+ func DefaultWorkflowHandoff(scenario WorkflowScenario) (string, error)

+ func ParseDurationOrDefault(raw string, fallback time.Duration) (time.Duration, error)

+ func SemanticEnvironmentCredentialResolver(_ context.Context, provider string) (string, error)

+ type AnthropicSemanticProviderOptions struct

+ BaseURL string

+ CredentialResolver SemanticCredentialResolver

+ HTTPClient *http.Client

+ type BatchResult struct

+ Results []CaptureResult

+ type Bounds struct

+ Height float64

+ Width float64

+ X float64

+ Y float64

+ type BrowserInfo struct

+ BrowserPath string

+ Engine string

+ Headless bool

+ JSVersion string

+ Product string

+ ProtocolVersion string

+ Revision string

+ UserAgent string

+ type CaptureArtifact struct

+ Bounds *Bounds

+ Bytes []byte

+ ImageFormat string

+ MatchCount int

+ Mode CaptureMode

+ Selectors []string

+ URL string

+ Viewport Viewport

+ type CaptureMode string

+ const CaptureModeFullPage

+ const CaptureModeSelector

+ const CaptureModeSelectorAll

+ const CaptureModeSelectors

+ const CaptureModeSelectorsAll

+ const CaptureModeViewport

+ type CaptureNormalization struct

+ DevicePreset string

+ DisableAnimations bool

+ OutputBaseName string

+ OutputDirectory string

+ OutputGenerated bool

+ Readiness ReadinessMode

+ ReadinessIdle string

+ ReducedMotion bool

+ ViewportPreset string

+ WaitForFonts bool

+ type CaptureRequest struct

+ AfterNavigateJS string

+ BeforeCaptureJS string

+ BeforeNavigateJS string

+ DevicePreset string

+ DisableAnimations bool

+ FullPage bool

+ JavaScript string

+ MetadataPath string

+ OutputPath string

+ Padding int

+ Readiness ReadinessMode

+ ReadinessIdle string

+ ReducedMotion bool

+ Selector string

+ SelectorAll string

+ Selectors []string

+ SelectorsAll []string

+ Timeout string

+ URL string

+ UserAgent string

+ Viewport Viewport

+ ViewportPreset string

+ Wait string

+ WaitFor string

+ WaitForFonts bool

+ func NormalizeCaptureRequest(req CaptureRequest) (CaptureRequest, error)

+ func ResolvePersistedPaths(req CaptureRequest, outputDir string) (CaptureRequest, string, bool, error)

+ func (req CaptureRequest) Mode() CaptureMode

+ func (req CaptureRequest) Normalization(outputGenerated bool, outputBaseName, outputDirectory string) CaptureNormalization

+ func (req CaptureRequest) ReadinessIdleDuration() time.Duration

+ func (req CaptureRequest) TargetSelectors() ([]string, bool)

+ func (req CaptureRequest) TimeoutDuration() time.Duration

+ func (req CaptureRequest) WaitDuration() time.Duration

+ type CaptureResult struct

+ Artifact CaptureArtifact

+ Browser BrowserInfo

+ ByteSize int

+ CapturedAt time.Time

+ Engine string

+ MetadataPath string

+ Normalization CaptureNormalization

+ OutputPath string

+ ResolvedConfig CaptureRequest

+ Timing CaptureTiming

+ Warnings []CaptureWarning

+ type CaptureService interface

+ Capture func(ctx context.Context, req CaptureRequest) (CaptureResult, error)

+ CaptureArtifact func(ctx context.Context, req CaptureRequest) (CaptureArtifact, error)

+ CaptureBatch func(ctx context.Context, manifest Manifest, outputDir string) (BatchResult, error)

+ type CaptureTiming struct

+ CapturedAt time.Time

+ NavigationCompletedAt time.Time

+ NavigationStartedAt time.Time

+ ReadyAt time.Time

+ TotalDuration string

+ type CaptureWarning struct

+ Code string

+ Message string

+ type ChromiumEngine struct

+ func NewChromiumEngine(opts ChromiumOptions) *ChromiumEngine

+ func (e *ChromiumEngine) Capture(ctx context.Context, req CaptureRequest) (EngineResult, error)

+ func (e *ChromiumEngine) Name() string

+ type ChromiumOptions struct

+ BrowserPath string

+ Headless bool

+ Now func() time.Time

+ type DeviceProfile struct

+ Name string

+ UserAgent string

+ Viewport Viewport

+ func LookupDevicePreset(name string) (DeviceProfile, bool)

+ type DiffEntry struct

+ BasePath string

+ ByteSize int

+ Changed bool

+ ChangedPercent float64

+ ChangedPixels int

+ ComparePath string

+ Height int

+ MetadataPath string

+ MissingBase bool

+ MissingCompare bool

+ OutputPath string

+ RelativePath string

+ Threshold float64

+ TotalPixels int

+ Warnings []CaptureWarning

+ Width int

+ type DiffMode string

+ const DiffModeDirectory

+ const DiffModeImage

+ func InferDiffMode(basePath, comparePath string) (DiffMode, error)

+ type DiffRequest struct

+ BasePath string

+ ComparePath string

+ MetadataPath string

+ OutputPath string

+ Threshold float64

+ func NormalizeDiffRequest(req DiffRequest) (DiffRequest, error)

+ func ResolveDiffPaths(req DiffRequest, mode DiffMode) (DiffRequest, error)

+ type DiffResult struct

+ BasePath string

+ ComparePath string

+ CreatedAt time.Time

+ Entries []DiffEntry

+ Entry *DiffEntry

+ MetadataPath string

+ Mode DiffMode

+ OutputPath string

+ Summary DiffSummary

+ Threshold float64

+ type DiffService interface

+ Diff func(ctx context.Context, req DiffRequest) (DiffResult, error)

+ type DiffSummary struct

+ ChangedFiles int

+ ComparedFiles int

+ MissingBaseFiles int

+ MissingCompareFiles int

+ TotalChangedPixels int

+ Warnings []CaptureWarning

+ type Engine interface

+ Capture func(ctx context.Context, req CaptureRequest) (EngineResult, error)

+ Name func() string

+ func NewEngine(config EngineConfig) (Engine, error)

+ type EngineConfig struct

+ BrowserPath string

+ EngineName EngineName

+ Headless bool

+ PlaywrightBrowser string

+ PlaywrightNodeBinary string

+ PlaywrightRuntimeDir string

+ PlaywrightScriptPath string

+ type EngineName string

+ const EngineChromium

+ const EnginePlaywright

+ func NormalizeEngineName(value string) EngineName

+ type EngineResult struct

+ Artifact CaptureArtifact

+ Browser BrowserInfo

+ Timing CaptureTiming

+ Warnings []CaptureWarning

+ type Error struct

+ Code ErrorCode

+ Err error

+ Message string

+ Metadata map[string]any

+ Operation string

+ func (e *Error) Error() string

+ func (e *Error) Unwrap() error

+ func (e *Error) WithMetadata(key string, value any) *Error

+ type ErrorCode string

+ const CodeBrowserStartup

+ const CodeCapture

+ const CodeManifest

+ const CodeNavigation

+ const CodeNoVisibleMatches

+ const CodeSelectorNotFound

+ const CodeTimeout

+ const CodeValidation

+ const CodeWrite

+ type Manifest struct

+ DevicePreset string

+ DisableAnimations bool

+ OutputDir string

+ Readiness ReadinessMode

+ ReadinessIdle string

+ ReducedMotion bool

+ Shots []ManifestShot

+ Timeout string

+ Viewport *Viewport

+ ViewportPreset string

+ Wait string

+ WaitFor string

+ WaitForFonts bool

+ func LoadManifest(path string) (Manifest, error)

+ func (m Manifest) Requests(outputDirOverride string) ([]CaptureRequest, error)

+ type ManifestShot struct

+ DevicePreset string

+ DisableAnimations bool

+ FullPage bool

+ ID string

+ JavaScript string

+ Metadata string

+ Output string

+ Padding int

+ Readiness ReadinessMode

+ ReadinessIdle string

+ ReducedMotion bool

+ Selector string

+ SelectorAll string

+ Selectors []string

+ SelectorsAll []string

+ Timeout string

+ URL string

+ Viewport *Viewport

+ ViewportPreset string

+ Wait string

+ WaitFor string

+ WaitForFonts bool

+ type OpenAISemanticProviderOptions struct

+ BaseURL string

+ CredentialResolver SemanticCredentialResolver

+ HTTPClient *http.Client

+ type Options struct

+ Now func() time.Time

+ SemanticDiff SemanticDiffOptions

+ Workflow WorkflowOptions

+ type PlaywrightEngine struct

+ func NewPlaywrightEngine(opts PlaywrightOptions) (*PlaywrightEngine, error)

+ func (e *PlaywrightEngine) Capture(ctx context.Context, req CaptureRequest) (EngineResult, error)

+ func (e *PlaywrightEngine) Name() string

+ type PlaywrightOptions struct

+ BrowserName string

+ BrowserPath string

+ Headless bool

+ NodeBinary string

+ RuntimeDir string

+ ScriptPath string

+ type ReadinessMode string

+ const ReadinessComplete

+ const ReadinessInteractive

+ const ReadinessNetworkIdle

+ const ReadinessNone

+ type SemanticCredentialResolver func(ctx context.Context, provider string) (string, error)

+ type SemanticDiffAdvisoryPolicy string

+ const SemanticDiffAdvisoryEnforce

+ const SemanticDiffAdvisoryOnly

+ type SemanticDiffMode string

+ const SemanticDiffModeAccessibility

+ const SemanticDiffModeCopy

+ const SemanticDiffModeCustom

+ const SemanticDiffModeFocused

+ const SemanticDiffModeGeneral

+ const SemanticDiffModeLayout

+ type SemanticDiffOptions struct

+ AnthropicBaseURL string

+ CredentialResolver SemanticCredentialResolver

+ DefaultModels map[string]string

+ DefaultProvider string

+ DefaultTimeout time.Duration

+ HTTPClient *http.Client

+ LLMs llms.Options

+ MaxImageBytes int64

+ MaxOutputTokens int

+ OpenAIBaseURL string

+ PersistRawResponses bool

+ Providers map[string]SemanticDiffProvider

+ RedactImage SemanticImageRedactor

+ type SemanticDiffProvider interface

+ CompareImages func(ctx context.Context, req SemanticProviderRequest) (SemanticProviderResponse, error)

+ Name func() string

+ func NewAnthropicSemanticDiffProvider(options AnthropicSemanticProviderOptions) SemanticDiffProvider

+ func NewLLMSSemanticDiffProvider(provider llms.Provider) SemanticDiffProvider

+ func NewOpenAISemanticDiffProvider(options OpenAISemanticProviderOptions) SemanticDiffProvider

+ type SemanticDiffRequest struct

+ CurrentPath string

+ Focus []string

+ MaxOutputTokens int

+ MetadataPath string

+ Mode SemanticDiffMode

+ Model string

+ PersistRawResponse bool

+ PixelContext SemanticPixelContext

+ Prompt string

+ PromptPath string

+ Provider string

+ RawResponsePath string

+ ReferencePath string

+ Timeout string

+ func NormalizeSemanticDiffRequest(req SemanticDiffRequest) (SemanticDiffRequest, error)

+ type SemanticDiffResult struct

+ CompletedAt time.Time

+ CurrentPath string

+ Differences []SemanticDifference

+ Duration string

+ MetadataPath string

+ Model string

+ PixelContext SemanticPixelContext

+ Prompt SemanticPromptMetadata

+ Provider string

+ ProviderMetadata map[string]string

+ RawResponse string

+ RawResponsePath string

+ ReferencePath string

+ Severity SemanticDiffSeverity

+ StartedAt time.Time

+ Summary string

+ Usage SemanticProviderUsage

+ Verdict SemanticDiffVerdict

+ Warnings []CaptureWarning

+ type SemanticDiffRunPolicy string

+ const SemanticDiffRunAlways

+ const SemanticDiffRunChangedOnly

+ const SemanticDiffRunNever

+ type SemanticDiffService interface

+ SemanticDiff func(ctx context.Context, req SemanticDiffRequest) (SemanticDiffResult, error)

+ type SemanticDiffSeverity string

+ const SemanticDiffSeverityBlocking

+ const SemanticDiffSeverityInfo

+ const SemanticDiffSeverityMajor

+ const SemanticDiffSeverityMinor

+ type SemanticDiffVerdict string

+ const SemanticDiffVerdictImprovement

+ const SemanticDiffVerdictInconclusive

+ const SemanticDiffVerdictNeedsReview

+ const SemanticDiffVerdictNoMeaningfulChange

+ const SemanticDiffVerdictRegression

+ type SemanticDifference struct

+ Area string

+ Description string

+ Evidence string

+ Recommendation string

+ Severity SemanticDiffSeverity

+ type SemanticImagePayload struct

+ Base64Data string

+ ByteSize int64

+ MIMEType string

+ Path string

+ Role string

+ type SemanticImageRedactionInput struct

+ Path string

+ Role string

+ type SemanticImageRedactor func(ctx context.Context, input SemanticImageRedactionInput) (string, error)

+ type SemanticPixelContext struct

+ ChangedPercent float64

+ ChangedPixels int

+ PixelDiffImagePath string

+ Threshold float64

+ TotalPixels int

+ Warnings []CaptureWarning

+ type SemanticPromptMetadata struct

+ Focus []string

+ Mode SemanticDiffMode

+ PixelContextIncluded bool

+ PromptSource string

+ StructuredOutput bool

+ type SemanticProviderRequest struct

+ Images []SemanticImagePayload

+ MaxOutputTokens int

+ Model string

+ Prompt string

+ Provider string

+ StructuredJSON bool

+ Timeout time.Duration

+ type SemanticProviderResponse struct

+ Metadata map[string]string

+ Model string

+ Provider string

+ RawText string

+ Usage SemanticProviderUsage

+ Warnings []CaptureWarning

+ type SemanticProviderUsage struct

+ InputTokens int

+ OutputTokens int

+ TotalTokens int

+ type Service struct

+ func NewService(engine Engine) *Service

+ func NewServiceWithOptions(engine Engine, opts Options) *Service

+ func (s *Service) Capture(ctx context.Context, req CaptureRequest) (CaptureResult, error)

+ func (s *Service) CaptureArtifact(ctx context.Context, req CaptureRequest) (CaptureArtifact, error)

+ func (s *Service) CaptureBatch(ctx context.Context, manifest Manifest, outputDir string) (BatchResult, error)

+ func (s *Service) CaptureScenario(ctx context.Context, scenario WorkflowScenario) (WorkflowCaptureResult, error)

+ func (s *Service) Diff(ctx context.Context, req DiffRequest) (DiffResult, error)

+ func (s *Service) GenerateWorkflowReport(ctx context.Context, req WorkflowReportRequest) (WorkflowReportResult, error)

+ func (s *Service) SemanticDiff(ctx context.Context, req SemanticDiffRequest) (SemanticDiffResult, error)

+ type Viewport struct

+ Height int

+ Mobile bool

+ ScaleFactor float64

+ Width int

+ func LookupViewportPreset(name string) (Viewport, bool)

+ type WorkflowArtifactLayout struct

+ CurrentDir string

+ DiffDir string

+ ReferenceDir string

+ ReportDir string

+ Root string

+ type WorkflowCaptureResult struct

+ CapturedAt time.Time

+ CurrentDir string

+ Results []WorkflowScreenCaptureResult

+ ScenarioID string

+ ScenarioPath string

+ type WorkflowCompareRect struct

+ Height int

+ Width int

+ X int

+ Y int

+ type WorkflowComparison struct

+ CurrentCrop *WorkflowCompareRect

+ Mode string

+ ReferenceCrop *WorkflowCompareRect

+ ResizeTo string

+ type WorkflowDefaults struct

+ Comparison WorkflowComparison

+ DevicePreset string

+ DisableAnimations bool

+ FullPage *bool

+ Readiness ReadinessMode

+ ReadinessIdle string

+ ReducedMotion bool

+ SemanticDiff WorkflowSemanticDiff

+ Timeout string

+ Viewport Viewport

+ ViewportPreset string

+ Wait string

+ WaitFor string

+ WaitForFonts bool

+ type WorkflowEnvironment struct

+ BaseURL string

+ BrowserPath string

+ Engine string

+ FixtureMode string

+ Headless *bool

+ PlaywrightBrowser string

+ PlaywrightNodeBinary string

+ PlaywrightRuntimeDir string

+ PresentationMode string

+ Query map[string]string

+ ReportFormat string

+ RuntimeOverrides map[string]string

+ SelectedScenario string

+ type WorkflowEvidenceItem struct

+ ExpectedSelectors []string

+ ID string

+ Notes []string

+ Stories []string

+ Text string

+ type WorkflowHandoff struct

+ PresentationMode string

+ RuntimeOverrides map[string]string

+ SelectedScenario string

+ type WorkflowHookSet struct

+ AfterNavigate string

+ BeforeCapture string

+ BeforeNavigate string

+ Context map[string]any

+ Mode string

+ type WorkflowHooks struct

+ AuthSetup WorkflowHookSet

+ Navigation WorkflowHookSet

+ StateSetup WorkflowHookSet

+ type WorkflowOptions struct

+ BuildHandoff func(WorkflowScenario) (string, error)

+ DefaultPresentationMode string

+ DefaultSelectedScenario string

+ HandoffQueryParam string

+ func DefaultWorkflowOptions() WorkflowOptions

+ type WorkflowReportEntry struct

+ Annotations []string

+ ComparedCurrentImagePath string

+ ComparedReferenceImagePath string

+ ComparisonMode string

+ CurrentCapture *CaptureResult

+ CurrentImagePath string

+ CurrentMetadata string

+ DiffEntry *DiffEntry

+ DiffImagePath string

+ DiffMetadataPath string

+ DiffSummary *DiffSummary

+ Evidence []WorkflowEvidenceItem

+ ExpectedElements []string

+ Label string

+ MissingCurrent bool

+ MissingReference bool

+ Notes []string

+ PrimaryStories []WorkflowStory

+ ReferenceImage string

+ Route string

+ ScreenID string

+ SemanticDiff *SemanticDiffResult

+ SemanticFailure bool

+ SemanticMetadataPath string

+ Status WorkflowReviewStatus

+ SupportingStories []WorkflowStory

+ TargetURL string

+ Warnings []CaptureWarning

+ type WorkflowReportRequest struct

+ Scenario WorkflowScenario

+ type WorkflowReportResult struct

+ CreatedAt time.Time

+ CurrentDir string

+ DiffDir string

+ Entries []WorkflowReportEntry

+ MetadataPath string

+ ReportFormat string

+ ReportPath string

+ ScenarioID string

+ ScenarioPath string

+ Status WorkflowReviewStatus

+ Stories []WorkflowStoryReport

+ type WorkflowReviewStatus struct

+ Label string

+ Level string

+ Summary string

+ type WorkflowScenario struct

+ Artifacts WorkflowArtifactLayout

+ Context map[string]any

+ Defaults WorkflowDefaults

+ Description string

+ Environment WorkflowEnvironment

+ Hooks WorkflowHooks

+ ID string

+ Label string

+ Screens []WorkflowScreen

+ SourceDir string

+ SourcePath string

+ Stories map[string]WorkflowStory

+ StorySource string

+ func LoadWorkflowScenario(path string) (WorkflowScenario, error)

+ func LoadWorkflowScenarioWithOptions(path string, opts WorkflowOptions) (WorkflowScenario, error)

+ type WorkflowScreen struct

+ Annotations []string

+ Capture CaptureRequest

+ Comparison WorkflowComparison

+ Evidence []WorkflowEvidenceItem

+ ExpectedElements []string

+ Hooks WorkflowHooks

+ ID string

+ Label string

+ Notes []string

+ OutputName string

+ PrimaryStories []string

+ Query map[string]string

+ ReferenceImage string

+ Route string

+ SemanticDiff WorkflowSemanticDiff

+ SupportingStories []string

+ type WorkflowScreenCaptureResult struct

+ Capture CaptureResult

+ ExpectedElements []string

+ Label string

+ MetadataPath string

+ OutputPath string

+ ReferenceImage string

+ Route string

+ ScreenID string

+ TargetURL string

+ type WorkflowSemanticDiff struct

+ APIKey string

+ AdvisoryPolicy SemanticDiffAdvisoryPolicy

+ AnthropicAPIKey string

+ Enabled *bool

+ FailureSeverity SemanticDiffSeverity

+ FailureVerdicts []SemanticDiffVerdict

+ Focus []string

+ MaxOutputTokens int

+ Mode SemanticDiffMode

+ Model string

+ OpenAIAPIKey string

+ PersistRawResponse bool

+ Prompt string

+ PromptPath string

+ Provider string

+ RawResponsePath string

+ Run SemanticDiffRunPolicy

+ Timeout string

+ type WorkflowService interface

+ CaptureScenario func(ctx context.Context, scenario WorkflowScenario) (WorkflowCaptureResult, error)

+ GenerateWorkflowReport func(ctx context.Context, req WorkflowReportRequest) (WorkflowReportResult, error)

+ type WorkflowStory struct

+ AcceptanceCriteria []string

+ ID string

+ Notes []string

+ Priority string

+ Title string

+ type WorkflowStoryReport struct

+ Evidence []WorkflowEvidenceItem

+ MissingPaths []string

+ ScreenIDs []string

+ Status WorkflowReviewStatus

+ Story WorkflowStory

+ StoryID string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL