core

type ClickArgs struct {
	// Permit multiple elements to be clicked.
	Multiple bool `json:"value"`

	// If Multiple clicks are permitted, what is the delay between each click.
	Delay time.Duration `json:"delay" default:"20ms"`
}

type ClickAtArgs struct {
	// The X-coordinate to click at
	X int `json:"x"`

	// The Y-coordinate to click at
	Y int `json:"y"`
}

type Commands struct {
	*core.Commands
	// contains filtered or unexported fields
}

type ConfigureArgs struct {
	// Override the default User-Agent header sent with all requests
	UserAgent string `json:"user_agent"`

	// Specify the Geographic latitude to emulate [-90.0, 90.0]
	Latitude float64 `json:"latitude"`

	// Specify the Geographic longitude to emulate [-180.0, 180.0]
	Longitude float64 `json:"longitude"`

	// Specify a Geolocation error margin (accurate to within n meters)
	Accuracy float64 `json:"accuracy" default:"1"`

	// Disable JavaScript execution in the browser.
	DisableScripts bool `json:"disable_scripts"`

	// Emulate a touch-capable device.
	EmulateTouch bool `json:"emulate_touch"`

	// Set the default background color of the underlying window in the following formats: `#RRGGBB`, `#RRGGBBAA`, `rgb()`, `rgba()`, `hsv()`, `hsva()`, `hsl()`, `hsla()`.
	BackgroundColor string `json:"background_color"`

	// Set whether scrollbars should be hidden all the time.
	HideScrollbars bool `json:"hide_scrollbars"`
}

type FieldArgs struct {
	// The value to enter into the field.
	Value interface{} `json:"value"`

	// Whether to clear the existing contents of the field before entering new data.
	Autoclear bool `json:"autoclear" default:"true"`

	// Whether to automatically send an "Enter" keystroke after typing in the given value
	Enter bool `json:"enter"`

	// An element to click after the field value is changed.
	Click dom.Selector `json:"click"`
}

type GoArgs struct {
	// If a URL is specified, it will be used as the HTTP Referer [sic] header
	// field when going to the given page. If the URL of the currently-loaded
	// page and the referrer are the same, the page will no change.
	//
	// For this reason, you may specify the special value 'random', which will
	// generate a URL with a randomly generated path component to ensure that
	// it is always different from the current page. Specifying None will omit
	// the field from the request.
	Referrer string `json:"referrer"`

	// Whether to block until the page has finished loading.
	WaitForLoad bool `json:"wait_for_load" default:"true"`

	// The amount of time to wait for the page to load.
	Timeout time.Duration `json:"timeout" default:"30s"`

	// The amount of time to poll for the originating network request.
	RequestPollTimeout time.Duration `json:"request_poll_timeout" default:"5s"`

	// Whether the resources stack that is queried in page::resources and
	// page::resource is cleared before navigating. Set this to false to
	// preserve the ability to retrieve data that was loaded on previous pages.
	ClearRequests bool `json:"clear_requests" default:"false"`

	// Whether the originating network request is required in the return value.  If this is
	// false, the response may be missing status, headers, and timing details.
	RequireOriginatingRequest bool `json:"require_originating_request" default:"true"`

	// Whether to continue execution if an error is encountered during page
	// load (e.g.: HTTP 4xx/5xx, SSL, TCP connection errors).
	ContinueOnError bool `json:"continue_on_error"`

	// These HTTP status codes are not considered errors.
	ContinueStatuses []int `json:"continue_statuses"`

	// Whether to continue execution if load_event_name is not seen before
	// timeout elapses.
	ContinueOnTimeout bool `json:"continue_on_timeout" default:"false"`

	// The RPC event to wait for before proceeding to the next command.
	LoadEventName string `json:"load_event_name" default:"Page.loadEventFired"`

	// Provide a username if one is requested via HTTP Basic authentication.
	Username string `json:"username"`

	// Provide a password if one is requested via HTTP Basic authentication.
	Password string `json:"password"`

	// Only provide credentials if the HTTP Basic Authentication Realm matches this one.
	Realm string `json:"realm"`
}

type GoResponse struct {
	// The final URL of the page that was loaded.
	URL string `json:"url"`

	// The HTTP status code of the loaded page.
	Status int `json:"status"`

	// A map of durations (in milliseconds) that various phases of the page load took.
	TimingDetails map[string]float64 `json:"timing"`

	// Map of HTTP response headers.
	Headers map[string]string `json:"headers"`

	// The MIME type of the response content.
	MimeType string `json:"mimetype"`

	// The remote address of the loaded page.
	RemoteAddress string `json:"remoteAddress"`

	// The protocol that was negotiated and used to load the page.
	Protocol string `json:"protocol"`
}

type HighlightArgs struct {
	// The red component of the highlight color (0 <= r < 256)
	R int `json:"r" default:"0"`

	// The green component of the highlight color (0 <= g < 256)
	G int `json:"g" default:"128"`

	// The blue component of the highlight color (0 <= b < 256)
	B int `json:"b" default:"128"`

	// The alpha component of the highlight color (0.0 <= a <= 1.0)
	A float64 `json:"a" default:"0.5"`
}

type InspectArgs struct {
	// The X-coordinate to inspect.
	X float64 `json:"x"`

	// The Y-coordinate to inspect.
	Y float64 `json:"y"`

	// Whether to highlight the inspected DOM element or not.
	Highlight bool `json:"highlight" default:"true"`

	// The red component of the highlight color (0 <= r < 256)
	R int `json:"r" default:"0"`

	// The green component of the highlight color (0 <= g < 256)
	G int `json:"g" default:"128"`

	// The blue component of the highlight color (0 <= b < 256)
	B int `json:"b" default:"128"`

	// The alpha component of the highlight color (0.0 <= a <= 1.0)
	A float64 `json:"a" default:"0.5"`
}

type KeyArgs struct {
	// The keyboard action to take; either "press" or "release"
	Action  string `json:"action" default:"press"`
	Alt     bool   `json:"alt,omitempty"`
	Control bool   `json:"control,omitempty"`
	Meta    bool   `json:"meta,omitempty"`
	Shift   bool   `json:"shift,omitempty"`

	// The numeric decimal keycode to send.
	KeyCode int `json:"keycode,omitempty"`
}

type MouseArgs struct {
	// The X-coordinate to perform the mouse action at.
	X float64 `json:"x"`

	// The Y-coordinate to perform the mouse action at.
	Y float64 `json:"y"`

	// The action that should be performed; one of "move", "press", "release", or "scroll".
	Action string `json:"action" default:"move"`

	// Which mouse button to depress when performing the action; one of "left", "middle", or "right".
	Button string `json:"button,omitempty"`

	// Whether the Alt-key should be held down when emitting the event.
	Alt bool `json:"alt,omitempty"`

	// Whether the Control-key should be held down when emitting the event.
	Control bool `json:"control,omitempty"`

	// Whether the Meta/Command-key should be held down when emitting the event.
	Meta bool `json:"meta,omitempty"`

	// Whether the Shift-key should be held down when emitting the event.
	Shift bool `json:"shift,omitempty"`

	// For "scroll" actions, this indicates how much to scroll horizontally (positive for right, negative for left).
	WheelX float64 `json:"wheelX,omitempty"`

	// For "scroll" actions, this indicates how much to scroll vertically (positive for up, negative for down)
	WheelY float64 `json:"wheelY,omitempty"`

	// How many clicks to issue if action is "press"
	Count int `json:"count,omitempty"`
}

type NetrcArgs struct {
	// The path to the .netrc file to load values from.
	Filename string `json:"filename" default:"~/.netrc"`

	// A list of additional, non-standard fields to retrieve from the .netrc entry
	ExtraFields []string `json:"extra_fields"`
}

type NetrcResponse struct {
	// Whether there was a match or not.
	OK bool `json:"ok"`

	// The machine name that matched.
	Machine string `json:"machine"`

	// The login name.
	Login string `json:"login"`

	// The password.
	Password string `json:"password"`

	// Any additional values retrieved from the entry
	Fields map[string]string
}

type NewTabArgs struct {
	// The width and height (in pixels) that the tab should be created with.
	Width int `json:"width"`

	// The height and height (in pixels) that the tab should be created with.
	Height int `json:"height"`

	// Whether to automatically switch to the newly-created tab as the active
	// tab for subsequent commands.
	Autoswitch bool `json:"autoswitch" default:"true"`
}

type Orientation string

type ResizeArgs struct {
	// The width of the screen.
	Width int `json:"width"`

	// The height of the screen.
	Height int `json:"height"`

	// The scaling factor of the content.
	Scale float64 `json:"scale"`

	// Whether to emulate a mobile device or not. If a map is provided, mobile
	// emulation will be enabled and configured using the following keys:
	//
	// <br>
	//
	// Value    | Data Type     | Description
	// ---------|---------------|-------------
	// *width*  | int, optional | The width of the mobile screen to emulate.
	// *height* | int, optional | The height of the mobile screen to emulate.
	// *x*      | int, optional | The horizontal position of the currently viewable portion of the mobile screen.
	// *y*      | int, optional | The vertical position of the currently viewable portion of the mobile screen.
	//
	Mobile interface{} `json:"mobile"`

	// Whether to fit the viewport contents to the available area or not.
	FitWindow bool `json:"fit_window"`

	// Which screen orientation to emulate, if any.
	Orientation string `json:"orientation" default:"landscapePrimary"`

	// The angle of the screen to emulate (in degrees; 0-360).
	Angle int `json:"angle"`
}

type ResizeResponse struct {
	// The final width of the page after resize.
	Width int `json:"width"`

	// The final height of the page after resize.
	Height int `json:"height"`
}

type SelectArgs struct {
	// The timeout before we stop waiting for the element to appear.
	Timeout time.Duration `json:"timeout" default:"5s"`

	// The minimum number of matches necessary to be considered a successful match.
	MinMatches int `json:"min_matches" default:"1"`

	// The polling interval between element re-checks.
	Interval time.Duration `json:"interval" default:"125ms"`
}

type TypeArgs struct {
	Alt     bool `json:"alt"`
	Control bool `json:"control"`
	Shift   bool `json:"shift"`
	Meta    bool `json:"meta"`

	// Whether the text being input is issued via the numeric keypad or not.
	IsKeypad bool `json:"is_keypad"`

	// How long that each individual keystroke will remain down for.
	KeyDownTime time.Duration `json:"key_down_time" default:"30ms"`

	// An amount of time to randomly vary the `key_down_time` duration from within each keystroke.
	KeyDownJitter time.Duration `json:"key_down_jitter"`

	// How long to wait between issuing individual keystrokes.
	Delay time.Duration `json:"delay" default:"30ms"`

	// An amount of time to randomly vary the delay duration from between keystrokes.
	DelayJitter time.Duration `json:"delay_jitter"`
}

type WaitForArgs struct {
	// The timeout before we stop waiting for the event.
	Timeout time.Duration `json:"timeout" default:"30s"`
}