engine

package

Go to main page

Versions in this module

v1

v1.0.0

May 13, 2026

v0

v0.9.0

May 5, 2026

v0.8.0

Apr 29, 2026

v0.7.1

Apr 29, 2026

v0.7.0

Apr 29, 2026

v0.6.1

Apr 20, 2026

v0.6.0

Apr 20, 2026

v0.5.0

Apr 20, 2026

v0.4.0

Apr 20, 2026

v0.3.0

Apr 20, 2026

v0.2.0

Apr 20, 2026

v0.1.1

Jun 11, 2026

Changes in this version

+ const ContentBoundaryClose

+ const ContentBoundaryOpen

+ const CookiesJSONFilename

+ var ActivePolicy *policy.Policy

+ var AntiBotPatterns = []string

+ var DefaultDiscoverPorts = []int

+ var DefaultExtensionNames = []string

+ var ErrStaleRef = errors.New("stale ref: snapshot is missing or no longer matches the page")

+ func AcquireContext(b *rod.Browser, name string) (*rod.Browser, error)

+ func AcquireSession(name string, opts SessionSpawnOpts) (string, error)

+ func AddInitScript(srcPath string) (string, error)

+ func AnnotateScreenshot(page *rod.Page, snapshot *PageSnapshot, screenshotPNG []byte) ([]byte, error)

+ func ApplyColorScheme(page *rod.Page, scheme string) error

+ func ApplyDefaultPageProfile(page *rod.Page) error

+ func ApplyDevice(page *rod.Page, d Device) error

+ func ApplyInitScripts(page *rod.Page) error

+ func ApplyProxyAuth(page *rod.Page, proxyURL string) error

+ func ApplyTimezone(page *rod.Page, tz string) error

+ func ApplyUserAgent(page *rod.Page, ua string) error

+ func BuildHTTPClient(opts HTTPClientOpts) (*http.Client, error)

+ func ClickElement(page *rod.Page, el *rod.Element) error

+ func ClipboardRead(page *rod.Page) (string, error)

+ func ClipboardWrite(page *rod.Page, text string) error

+ func CloseContext(b *rod.Browser, name string) error

+ func CountSelector(page *rod.Page, selector string) int

+ func DblClickRef(page *rod.Page, ref string, snapshot *PageSnapshot) error

+ func DecryptCookiesInPlace(cookiesPath string) (total, decrypted, failed int, err error)

+ func DefaultExtensionPaths() ([]string, error)

+ func DefaultExtensionsDir() (string, error)

+ func DetectAgent() bool

+ func DiscoverCDP(ports []int, timeout time.Duration) (string, error)

+ func DragDrop(page *rod.Page, fromRef, toRef string, snapshot *PageSnapshot, steps int) error

+ func DragDropCoords(page *rod.Page, sx, sy, dx, dy float64, steps int) error

+ func EvalJSTimeout(page *rod.Page, expr string, elementRef string, snapshot *PageSnapshot, ...) (string, error)

+ func ExtractNextData(html string) []byte

+ func FindSystemChromeBinary() string

+ func FormatCollect(r *CollectResult) string

+ func FormatDiff(d SnapshotDiff) string

+ func FormatMultiCollect(r *MultiCollectResult) string

+ func FormatPreviewProfile(r *PreviewResult, p RenderProfile) string

+ func FormatTextProfile(result *ExtractionResult, p RenderProfile) string

+ func HasSelector(page *rod.Page, selector string) bool

+ func HoverElement(page *rod.Page, el *rod.Element) error

+ func HumanMode() bool

+ func InitScriptsDir() (string, error)

+ func InjectCookies(page *rod.Page, cookies []CookieRecord) (int, error)

+ func KillAllSessions() (int, error)

+ func ListInitScripts() ([]string, error)

+ func LoadFulfillBody(value string) ([]byte, error)

+ func LoadRules(rulesPath, baseDir string) ([]compiledRule, error)

+ func LoadStorageState(browser *rod.Browser, page *rod.Page, state *StorageState) error

+ func MatchRule(rules []compiledRule, url, method string) (*compiledRule, bool)

+ func MustReadResponseBody(resp *http.Response) ([]byte, error)

+ func NewLauncher(opts LauncherOpts) *launcher.Launcher

+ func NewTab(browser *rod.Browser, url string) (*rod.Page, error)

+ func ParseBlockList(s string) []string

+ func PrewarmDomains(page *rod.Page)

+ func ProfileUsesSystemChrome(userDataDir string) bool

+ func PruneSessions() (int, error)

+ func ReactSuspense(page *rod.Page) ([]map[string]any, error)

+ func RecoverBotChallenge(ctx RecoveryContext) (bool, error)

+ func RecoverDialogAccept(ctx RecoveryContext) (bool, error)

+ func RecoverNetworkSettle(ctx RecoveryContext) (bool, error)

+ func RecoverStaleRef(ctx RecoveryContext) (bool, error)

+ func RecoveryChain(ctx RecoveryContext, hooks []RecoveryHook) (retry bool, err error)

+ func RemoveInitScript(name string) error

+ func RenderTraceHTML(entries []TraceEntry, sourcePath string) string

+ func ResolveByLocator(page *rod.Page, loc Locator) (*rod.Element, error)

+ func ResolveProfileDir(name string) (string, error)

+ func SaveCookiesJSON(profileDir string, cookies []CookieRecord) error

+ func ScrollBy(page *rod.Page, dy int) (int, error)

+ func ScrollToRef(page *rod.Page, ref string, snapshot *PageSnapshot) error

+ func ScrollToY(page *rod.Page, y int, bottomSentinel bool) (int, error)

+ func SetCheckedRef(page *rod.Page, ref string, checked bool, snapshot *PageSnapshot) error

+ func SetHumanMode(enabled bool)

+ func StopSession(name string) error

+ func SubmitOnElement(page *rod.Page, el *rod.Element) error

+ func TakeScreenshotFormat(page *rod.Page, fullPage bool, elementRef string, format string, quality int, ...) ([]byte, error)

+ func TruncateURL(u string, maxLen int) string

+ func TypeElement(page *rod.Page, el *rod.Element, text string) error

+ func UploadRef(page *rod.Page, ref string, selector string, files []string, ...) error

+ func ValidateExtractLevel(level ExtractLevel) error

+ func WaitForBotChallenge(page *rod.Page, timeout time.Duration) bool

+ func WaitForLocator(page *rod.Page, loc Locator, state ElementState, timeout time.Duration) (*rod.Element, error)

+ func WaitForPage(page *rod.Page, waitStrategy string) error

+ func WaitForRef(page *rod.Page, ref string, snapshot *PageSnapshot, state ElementState, ...) (*rod.Element, error)

+ func WriteHAR(h *HAR, path string) error

+ type APIRequest struct

+ Body []byte

+ Headers map[string]string

+ Method string

+ Proxy string

+ Timeout time.Duration

+ URL string

+ type APIResponse struct

+ Body []byte

+ BodyText string

+ ContentLength int64

+ Elapsed time.Duration

+ ElapsedMs int64

+ Headers http.Header

+ IsJSON bool

+ JSON json.RawMessage

+ Status int

+ URL string

+ func AlgoliaQuery(ctx context.Context, opts AlgoliaOpts) (*APIResponse, error)

+ func FastFetchAPI(ctx context.Context, req APIRequest) (*APIResponse, error)

+ type AlgoliaOpts struct

+ APIKey string

+ AppID string

+ Endpoint string

+ ExtraHeaders map[string]string

+ Index string

+ Params map[string]string

+ ParamsForm string

+ Proxy string

+ Timeout time.Duration

type Browser

+ func NewBrowserWith(opts BrowserOpts) (*Browser, error)

+ func (b *Browser) CurrentTargetID() string

+ func (b *Browser) DeleteSnapshot(targetID proto.TargetTargetID) error

+ func (b *Browser) RodBrowser() *rod.Browser

+ func (b *Browser) SaveSnapshot(page *rod.Page, result *ExtractionResult) error

+ func (b *Browser) SetCurrentPage(page *rod.Page) error

+ func (b *Browser) Snapshot(page *rod.Page) *PageSnapshot

+ type BrowserOpts struct

+ ApplyProfile bool

+ AttachFresh bool

+ ConnectURL string

+ ContextName string

+ Extensions []string

+ Headless bool

+ Invisible bool

+ ProviderFunc func(ctx context.Context) (wsURL string, cleanup func(), err error)

+ Proxy string

+ SystemChrome bool

+ TargetTabIndex *int

+ TimeoutSec int

+ UserDataDir string

+ type CaptureSession struct

+ func StartCapture(page *rod.Page, spec CaptureSpec) (*CaptureSession, error)

+ func (s *CaptureSession) Entries() []*CapturedEntry

+ func (s *CaptureSession) ReachedMax() <-chan struct{}

+ func (s *CaptureSession) Stop() ([]*CapturedEntry, error)

+ type CaptureSpec struct

+ IncludeBody bool

+ Max int

+ MimeMatch string

+ OutputPath string

+ URLMatch string

+ type CapturedEntry struct

+ Body string

+ BodyBase64 bool

+ BodyError string

+ Method string

+ MimeType string

+ PostData string

+ ReqHeaders map[string]string

+ RequestID string

+ ResHeaders map[string]string

+ ResourceType string

+ StartedAt string

+ Status int

+ StatusText string

+ URL string

+ type CollectResult struct

+ ItemCount int

+ Items []CollectedItem

+ PageURL string

+ func Collect(page *rod.Page, limit int) (*CollectResult, error)

+ type CollectedItem struct

+ Fields map[string]string

+ Price string

+ Title string

+ URL string

+ type ContextEntry struct

+ ID string

+ type ContextRegistryEntry struct

+ Alive bool

+ ID string

+ Name string

+ Unknown bool

+ func ListContexts(b *rod.Browser) ([]ContextRegistryEntry, error)

+ func (e ContextRegistryEntry) AliveStr() string

+ type CookieRecord struct

+ Domain string

+ Expires float64

+ HTTPOnly bool

+ Name string

+ Path string

+ SameSite string

+ Secure bool

+ Value string

+ func ExportDecryptedCookies(cookiesPath string) ([]CookieRecord, error)

+ func LoadCookiesJSON(profileDir string) ([]CookieRecord, error)

+ type Device struct

+ DPR float64

+ Height int

+ Mobile bool

+ Name string

+ Touch bool

+ UserAgent string

+ Width int

+ func DeviceByName(name string) (Device, bool)

+ func ListDevices() []Device

+ type DialogResult struct

+ Action string

+ DefaultPrompt string

+ Handled bool

+ Message string

+ TimedOut bool

+ Type string

+ URL string

+ type DiffEntry struct

+ After DiffNode

+ Before DiffNode

+ type DiffNode struct

+ Href string

+ Name string

+ Ref string

+ Role string

+ Value string

+ type DiffStats struct

+ AddedCount int

+ ChangedCount int

+ KeptCount int

+ RemovedCount int

+ type ElementState string

+ const StateAttached

+ const StateEnabled

+ const StateHidden

+ const StateStable

+ const StateVisible

+ func ParseElementState(s string) (ElementState, error)

type ErrorCollector

+ func (c *ErrorCollector) Close()

type ErrorEntry

+ func CollectErrors(page *rod.Page, url string, waitStrategy string, ...) ([]ErrorEntry, error)

type ExtractedNode

+ BackendNodeID proto.DOMBackendNodeID

+ type FastFetchOpts struct

+ AcceptLanguage string

+ ExtraHeaders map[string]string

+ Proxy string

+ Timeout time.Duration

+ UserAgent string

+ type FastResult struct

+ Blocked bool

+ Elapsed time.Duration

+ HTML string

+ NextData []byte

+ Reason string

+ SSRPayloads []SSRPayload

+ Status int

+ URL string

+ func FastFetch(ctx context.Context, url string, opts FastFetchOpts) (*FastResult, error)

+ type HAR struct

+ Log HARLog

+ func BuildHAR(entries []NetworkEntry, pageURL, pageTitle, creatorVersion string) *HAR

+ type HARContent struct

+ MimeType string

+ Size int

+ type HARCreator struct

+ Name string

+ Version string

+ type HAREntry struct

+ Cache struct{}

+ PageRef string

+ Request HARRequest

+ Response HARResponse

+ StartedDateTime string

+ Time int64

+ Timings HARTimings

+ type HARLog struct

+ Creator HARCreator

+ Entries []HAREntry

+ Pages []HARPage

+ Version string

+ type HARPage struct

+ ID string

+ StartedDateTime string

+ Title string

+ type HARRequest struct

+ BodySize int

+ HTTPVersion string

+ Headers []string

+ HeadersSize int

+ Method string

+ QueryString []string

+ URL string

+ type HARResponse struct

+ BodySize int

+ Content HARContent

+ Cookies []string

+ HTTPVersion string

+ Headers []string

+ HeadersSize int

+ RedirectURL string

+ Status int

+ StatusText string

+ type HARTimings struct

+ Receive int

+ Send int

+ Wait int64

+ type HTTPClientOpts struct

+ Proxy string

+ Timeout time.Duration

+ type ImageDiffResult struct

+ DiffPath string

+ DiffRatio float64

+ Height int

+ PixelsChanged int

+ PixelsTotal int

+ SkipReason string

+ Skipped bool

+ Width int

+ func DiffImages(baselinePNG, currentPNG []byte, tolerance int, diffPath string) (*ImageDiffResult, error)

+ type InterceptSession struct

+ func StartAntiBotBlocker(browser *rod.Browser, extraPatterns ...string) (*InterceptSession, error)

+ func StartIntercept(browser *rod.Browser, spec InterceptSpec) (*InterceptSession, error)

+ func (s *InterceptSession) Stats() *InterceptStats

+ func (s *InterceptSession) Stop() error

+ type InterceptSpec struct

+ BlockPatterns []string

+ FulfillBody []byte

+ FulfillContentType string

+ FulfillPattern string

+ FulfillStatus int

+ Rules []compiledRule

+ type InterceptStats struct

+ Blocked int

+ Fulfilled int

+ Passed int

+ func (s *InterceptStats) Snapshot() (blocked, fulfilled, passed int)

+ type LauncherOpts struct

+ Extensions []string

+ Headless bool

+ Invisible bool

+ Proxy string

+ RemotePort int

+ SystemChrome bool

+ UserDataDir string

+ type Locator struct

+ Label string

+ Name string

+ Role string

+ Text string

+ func (l Locator) IsEmpty() bool

+ type MultiCollectResult struct

+ Sites []SiteResult

+ TotalItems int

+ TotalTimeMs int64

+ func MultiCollect(browser *rod.Browser, urls []string, limit int, stealth bool, maxParallel int) *MultiCollectResult

type NetworkEntry

+ Error string

+ type Observation struct

+ A11yDiff string

+ CaptchaHint string

+ ConsoleErrors []ObserverEvent

+ Dialog string

+ NetworkFailed []ObserverEvent

+ URL string

+ func BuildObservation(page *rod.Page, before, after *PageSnapshot, events []ObserverEvent) Observation

+ type Observer struct

+ func NewObserver(page *rod.Page, opts ObserverOpts) *Observer

+ func (o *Observer) Drain(afterMs int64) []ObserverEvent

+ func (o *Observer) Events() <-chan ObserverEvent

+ func (o *Observer) Start(ctx context.Context) error

+ func (o *Observer) Stats() ObserverStats

+ func (o *Observer) Stop() error

+ func (o *Observer) WriteNDJSON(ctx context.Context, w io.Writer) error

+ type ObserverEvent struct

+ DurationMs int64

+ Event string

+ Failed string

+ Frame string

+ Kind ObserverKind

+ Level string

+ Method string

+ MimeType string

+ Size int64

+ Source string

+ Status int

+ TS int64

+ Text string

+ Type string

+ URL string

+ type ObserverFilters struct

+ ConsoleLevels []string

+ Kinds []ObserverKind

+ NetTypes []string

+ NetURLRegex *regexp.Regexp

+ type ObserverKind string

+ const KindConsole

+ const KindError

+ const KindNet

+ const KindPage

+ type ObserverOpts struct

+ BufferSize int

+ Duration time.Duration

+ Filters ObserverFilters

+ MaxEvents int

+ type ObserverStats struct

+ Console int

+ Dropped int

+ Error int

+ Net int

+ Page int

+ Total int

+ type PageSnapshot struct

+ Refs map[string]RefSnapshot

+ TargetID string

+ Title string

+ URL string

+ func BuildSnapshot(page *rod.Page, result *ExtractionResult) (*PageSnapshot, error)

+ type ReactComponent struct

+ Children []ReactComponent

+ Key string

+ Name string

+ Props json.RawMessage

+ State json.RawMessage

+ Type string

+ func ReactTree(page *rod.Page, maxDepth int) ([]ReactComponent, error)

+ type Recorder struct

+ func NewRecorder(page *rod.Page, w io.Writer, opts RecorderOpts) *Recorder

+ func (r *Recorder) Done() <-chan struct{}

+ func (r *Recorder) Start() error

+ func (r *Recorder) Stop()

+ type RecorderOp struct

+ Args map[string]any

+ Op string

+ type RecorderOpts struct

+ IncludeHovers bool

+ IncludeScrolls bool

+ StopOnNavigate bool

+ type RecoveryContext struct

+ Err error

+ OpName string

+ Page *rod.Page

+ type RecoveryHook func(ctx RecoveryContext) (retry bool, err error)

+ func DefaultRecoveryHooks() []RecoveryHook

+ type RefSnapshot struct

+ BackendNodeID proto.DOMBackendNodeID

+ Name string

+ Role string

+ type RenderProfile struct

+ AbbrevRoles bool

+ Agent bool

+ ContentBoundary bool

+ DropEmptyStats bool

+ Format string

+ MaxLabelLen int

+ func ProfileAgent(format string) RenderProfile

+ func ProfileHuman(format string) RenderProfile

+ func ResolveProfile(explicit, format string) RenderProfile

+ type RuleMatchType string

+ const RuleMatchExact

+ const RuleMatchGlob

+ const RuleMatchRegex

+ type RuleSpec struct

+ Body string

+ BodyFile string

+ ContentType string

+ Headers map[string]string

+ Match string

+ MatchType RuleMatchType

+ Method string

+ Status int

+ type RulesFile struct

+ Rules []RuleSpec

+ type SSRPayload struct

+ Data json.RawMessage

+ IsJSON bool

+ Source SSRSource

+ Type string

+ func ExtractRSCPayloads(html string) []SSRPayload

+ func ExtractSSRPayloads(html string) []SSRPayload

+ type SSRSource string

+ const SourceApolloState

+ const SourceInitialState

+ const SourceJSONLD

+ const SourceNextData

+ const SourceNuxtData

+ const SourceNuxtJS

+ const SourcePreloaded

+ const SourceRSC

+ const SourceReduxState

+ type SessionEntry struct

+ LaunchedAt string

+ Name string

+ PID int

+ Port int

+ Profile string

+ WSURL string

+ type SessionRegistryEntry struct

+ Alive bool

+ LaunchedAt string

+ Name string

+ PID int

+ Port int

+ Profile string

+ WSURL string

+ func ListSessions() ([]SessionRegistryEntry, error)

+ func (e SessionRegistryEntry) AliveStr() string

+ type SessionSpawnOpts struct

+ Headless bool

+ Proxy string

+ Stealth bool

+ type SiteResult struct

+ Count int

+ Error string

+ Items []CollectedItem

+ TimeMs int64

+ URL string

+ type SnapshotDiff struct

+ Added []DiffNode

+ Changed map[string]DiffEntry

+ Removed []string

+ Stats DiffStats

+ Unchanged bool

+ func DiffRefs(prev, curr map[string]RefSnapshot) SnapshotDiff

+ type StorageCookie struct

+ Domain string

+ Expires float64

+ HTTPOnly bool

+ Name string

+ Path string

+ SameSite string

+ Secure bool

+ Value string

+ type StorageKeyValue struct

+ Name string

+ Value string

+ type StorageOrigin struct

+ LocalStorage []StorageKeyValue

+ Origin string

+ type StorageState struct

+ Cookies []StorageCookie

+ Origins []StorageOrigin

+ func SaveStorageState(browser *rod.Browser, page *rod.Page) (*StorageState, error)

type TabInfo

+ Active bool

+ TargetID string

+ type TraceEntry struct

+ Args map[string]any

+ DurationMs int64

+ Error string

+ OK bool

+ Op string

+ Shot string

+ Summary string

+ TS int64

+ func ReadTrace(path string, limit int) ([]TraceEntry, error)

v0.1.0

Apr 3, 2026

Changes in this version

+ func ApplyStealth(page *rod.Page) error

+ func ClickRef(page *rod.Page, ref string) error

+ func CloseTab(browser *rod.Browser, index int) error

+ func DismissCookieBanner(page *rod.Page) bool

+ func EvalJS(page *rod.Page, expr string, elementRef string) (string, error)

+ func FormatErrors(errors []ErrorEntry) string

+ func FormatPreview(r *PreviewResult) string

+ func FormatText(result *ExtractionResult) string

+ func HandleNextDialog(page *rod.Page, accept bool, promptText string)

+ func HoverRef(page *rod.Page, ref string) error

+ func PressKey(page *rod.Page, key string, ref string) error

+ func ResolveRef(page *rod.Page, ref string) (*rod.Element, error)

+ func SelectOption(page *rod.Page, ref string, values []string) error

+ func SetViewport(page *rod.Page, width, height int) error

+ func SwitchTab(browser *rod.Browser, index int) (*rod.Page, error)

+ func TakeScreenshot(page *rod.Page, fullPage bool, elementRef string, quality int) ([]byte, error)

+ func TypeRef(page *rod.Page, ref string, text string) error

+ func WaitForSelector(page *rod.Page, selector string, timeoutSec int) error

+ type Browser struct

+ func NewBrowser(connectURL string, headless bool, timeoutSec int) (*Browser, error)

+ func (b *Browser) Close()

+ func (b *Browser) Connected() bool

+ func (b *Browser) Page() (*rod.Page, error)

+ func (b *Browser) RawBrowser() *rod.Browser

+ type ErrorCollector struct

+ func NewErrorCollector(page *rod.Page) *ErrorCollector

+ func (c *ErrorCollector) Errors() []ErrorEntry

+ type ErrorEntry struct

+ Level string

+ Message string

+ Method string

+ Source string

+ Status int

+ TimeMs int64

+ Type string

+ type ExtractLevel string

+ const LevelContent

+ const LevelFull

+ const LevelSkeleton

+ type ExtractedNode struct

+ Checked *bool

+ Children []ExtractedNode

+ Disabled bool

+ Href string

+ Level int

+ Name string

+ Ref string

+ Role string

+ Type string

+ Value string

+ type ExtractionResult struct

+ Nodes []ExtractedNode

+ Refs map[string]ExtractedNode

+ Stats ExtractionStats

+ func Extract(page *rod.Page, level ExtractLevel, selector string) (*ExtractionResult, error)

+ type ExtractionStats struct

+ FilteredNodes int

+ InteractiveCount int

+ TotalNodes int

+ type NetworkEntry struct

+ Method string

+ MimeType string

+ Size int

+ Status int

+ TimeMs int64

+ URL string

+ type PageInfo struct

+ Status int

+ TimeMs int64

+ Title string

+ URL string

+ func Navigate(page *rod.Page, rawURL string, waitStrategy string) (*PageInfo, error)

+ type PreviewResult struct

+ DOM *ExtractionResult

+ Errors []ErrorEntry

+ Network []NetworkEntry

+ PageInfo *PageInfo

+ Summary PreviewSummary

+ func Preview(page *rod.Page, url string, waitStrategy string, extractLevel ExtractLevel) (*PreviewResult, error)

+ type PreviewSummary struct

+ ErrorCount int

+ FailedRequests int

+ InteractiveCount int

+ TotalRequests int

+ WarningCount int

+ type TabInfo struct

+ Index int

+ Title string

+ URL string

+ func ListTabs(browser *rod.Browser) ([]TabInfo, error)

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