domdebugger.go 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
  1. // Package domdebugger provides the Chrome DevTools Protocol
  2. // commands, types, and events for the DOMDebugger domain.
  3. //
  4. // DOM debugging allows setting breakpoints on particular DOM operations and
  5. // events. JavaScript execution will stop on these operations as if there was a
  6. // regular breakpoint set.
  7. //
  8. // Generated by the cdproto-gen command.
  9. package domdebugger
  10. // Code generated by cdproto-gen. DO NOT EDIT.
  11. import (
  12. "context"
  13. "github.com/chromedp/cdproto/cdp"
  14. "github.com/chromedp/cdproto/runtime"
  15. )
  16. // GetEventListenersParams returns event listeners of the given object.
  17. type GetEventListenersParams struct {
  18. ObjectID runtime.RemoteObjectID `json:"objectId"` // Identifier of the object to return listeners for.
  19. Depth int64 `json:"depth,omitempty,omitzero"` // The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the entire subtree or provide an integer larger than 0.
  20. Pierce bool `json:"pierce"` // Whether or not iframes and shadow roots should be traversed when returning the subtree (default is false). Reports listeners for all contexts if pierce is enabled.
  21. }
  22. // GetEventListeners returns event listeners of the given object.
  23. //
  24. // See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-getEventListeners
  25. //
  26. // parameters:
  27. //
  28. // objectID - Identifier of the object to return listeners for.
  29. func GetEventListeners(objectID runtime.RemoteObjectID) *GetEventListenersParams {
  30. return &GetEventListenersParams{
  31. ObjectID: objectID,
  32. Pierce: false,
  33. }
  34. }
  35. // WithDepth the maximum depth at which Node children should be retrieved,
  36. // defaults to 1. Use -1 for the entire subtree or provide an integer larger
  37. // than 0.
  38. func (p GetEventListenersParams) WithDepth(depth int64) *GetEventListenersParams {
  39. p.Depth = depth
  40. return &p
  41. }
  42. // WithPierce whether or not iframes and shadow roots should be traversed
  43. // when returning the subtree (default is false). Reports listeners for all
  44. // contexts if pierce is enabled.
  45. func (p GetEventListenersParams) WithPierce(pierce bool) *GetEventListenersParams {
  46. p.Pierce = pierce
  47. return &p
  48. }
  49. // GetEventListenersReturns return values.
  50. type GetEventListenersReturns struct {
  51. Listeners []*EventListener `json:"listeners,omitempty,omitzero"` // Array of relevant listeners.
  52. }
  53. // Do executes DOMDebugger.getEventListeners against the provided context.
  54. //
  55. // returns:
  56. //
  57. // listeners - Array of relevant listeners.
  58. func (p *GetEventListenersParams) Do(ctx context.Context) (listeners []*EventListener, err error) {
  59. // execute
  60. var res GetEventListenersReturns
  61. err = cdp.Execute(ctx, CommandGetEventListeners, p, &res)
  62. if err != nil {
  63. return nil, err
  64. }
  65. return res.Listeners, nil
  66. }
  67. // RemoveDOMBreakpointParams removes DOM breakpoint that was set using
  68. // setDOMBreakpoint.
  69. type RemoveDOMBreakpointParams struct {
  70. NodeID cdp.NodeID `json:"nodeId"` // Identifier of the node to remove breakpoint from.
  71. Type DOMBreakpointType `json:"type"` // Type of the breakpoint to remove.
  72. }
  73. // RemoveDOMBreakpoint removes DOM breakpoint that was set using
  74. // setDOMBreakpoint.
  75. //
  76. // See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-removeDOMBreakpoint
  77. //
  78. // parameters:
  79. //
  80. // nodeID - Identifier of the node to remove breakpoint from.
  81. // type - Type of the breakpoint to remove.
  82. func RemoveDOMBreakpoint(nodeID cdp.NodeID, typeVal DOMBreakpointType) *RemoveDOMBreakpointParams {
  83. return &RemoveDOMBreakpointParams{
  84. NodeID: nodeID,
  85. Type: typeVal,
  86. }
  87. }
  88. // Do executes DOMDebugger.removeDOMBreakpoint against the provided context.
  89. func (p *RemoveDOMBreakpointParams) Do(ctx context.Context) (err error) {
  90. return cdp.Execute(ctx, CommandRemoveDOMBreakpoint, p, nil)
  91. }
  92. // RemoveEventListenerBreakpointParams removes breakpoint on particular DOM
  93. // event.
  94. type RemoveEventListenerBreakpointParams struct {
  95. EventName string `json:"eventName"` // Event name.
  96. TargetName string `json:"targetName,omitempty,omitzero"` // EventTarget interface name.
  97. }
  98. // RemoveEventListenerBreakpoint removes breakpoint on particular DOM event.
  99. //
  100. // See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-removeEventListenerBreakpoint
  101. //
  102. // parameters:
  103. //
  104. // eventName - Event name.
  105. func RemoveEventListenerBreakpoint(eventName string) *RemoveEventListenerBreakpointParams {
  106. return &RemoveEventListenerBreakpointParams{
  107. EventName: eventName,
  108. }
  109. }
  110. // WithTargetName eventTarget interface name.
  111. func (p RemoveEventListenerBreakpointParams) WithTargetName(targetName string) *RemoveEventListenerBreakpointParams {
  112. p.TargetName = targetName
  113. return &p
  114. }
  115. // Do executes DOMDebugger.removeEventListenerBreakpoint against the provided context.
  116. func (p *RemoveEventListenerBreakpointParams) Do(ctx context.Context) (err error) {
  117. return cdp.Execute(ctx, CommandRemoveEventListenerBreakpoint, p, nil)
  118. }
  119. // RemoveXHRBreakpointParams removes breakpoint from XMLHttpRequest.
  120. type RemoveXHRBreakpointParams struct {
  121. URL string `json:"url"` // Resource URL substring.
  122. }
  123. // RemoveXHRBreakpoint removes breakpoint from XMLHttpRequest.
  124. //
  125. // See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-removeXHRBreakpoint
  126. //
  127. // parameters:
  128. //
  129. // url - Resource URL substring.
  130. func RemoveXHRBreakpoint(url string) *RemoveXHRBreakpointParams {
  131. return &RemoveXHRBreakpointParams{
  132. URL: url,
  133. }
  134. }
  135. // Do executes DOMDebugger.removeXHRBreakpoint against the provided context.
  136. func (p *RemoveXHRBreakpointParams) Do(ctx context.Context) (err error) {
  137. return cdp.Execute(ctx, CommandRemoveXHRBreakpoint, p, nil)
  138. }
  139. // SetBreakOnCSPViolationParams sets breakpoint on particular CSP violations.
  140. type SetBreakOnCSPViolationParams struct {
  141. ViolationTypes []CSPViolationType `json:"violationTypes"` // CSP Violations to stop upon.
  142. }
  143. // SetBreakOnCSPViolation sets breakpoint on particular CSP violations.
  144. //
  145. // See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-setBreakOnCSPViolation
  146. //
  147. // parameters:
  148. //
  149. // violationTypes - CSP Violations to stop upon.
  150. func SetBreakOnCSPViolation(violationTypes []CSPViolationType) *SetBreakOnCSPViolationParams {
  151. return &SetBreakOnCSPViolationParams{
  152. ViolationTypes: violationTypes,
  153. }
  154. }
  155. // Do executes DOMDebugger.setBreakOnCSPViolation against the provided context.
  156. func (p *SetBreakOnCSPViolationParams) Do(ctx context.Context) (err error) {
  157. return cdp.Execute(ctx, CommandSetBreakOnCSPViolation, p, nil)
  158. }
  159. // SetDOMBreakpointParams sets breakpoint on particular operation with DOM.
  160. type SetDOMBreakpointParams struct {
  161. NodeID cdp.NodeID `json:"nodeId"` // Identifier of the node to set breakpoint on.
  162. Type DOMBreakpointType `json:"type"` // Type of the operation to stop upon.
  163. }
  164. // SetDOMBreakpoint sets breakpoint on particular operation with DOM.
  165. //
  166. // See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-setDOMBreakpoint
  167. //
  168. // parameters:
  169. //
  170. // nodeID - Identifier of the node to set breakpoint on.
  171. // type - Type of the operation to stop upon.
  172. func SetDOMBreakpoint(nodeID cdp.NodeID, typeVal DOMBreakpointType) *SetDOMBreakpointParams {
  173. return &SetDOMBreakpointParams{
  174. NodeID: nodeID,
  175. Type: typeVal,
  176. }
  177. }
  178. // Do executes DOMDebugger.setDOMBreakpoint against the provided context.
  179. func (p *SetDOMBreakpointParams) Do(ctx context.Context) (err error) {
  180. return cdp.Execute(ctx, CommandSetDOMBreakpoint, p, nil)
  181. }
  182. // SetEventListenerBreakpointParams sets breakpoint on particular DOM event.
  183. type SetEventListenerBreakpointParams struct {
  184. EventName string `json:"eventName"` // DOM Event name to stop on (any DOM event will do).
  185. TargetName string `json:"targetName,omitempty,omitzero"` // EventTarget interface name to stop on. If equal to "*" or not provided, will stop on any EventTarget.
  186. }
  187. // SetEventListenerBreakpoint sets breakpoint on particular DOM event.
  188. //
  189. // See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-setEventListenerBreakpoint
  190. //
  191. // parameters:
  192. //
  193. // eventName - DOM Event name to stop on (any DOM event will do).
  194. func SetEventListenerBreakpoint(eventName string) *SetEventListenerBreakpointParams {
  195. return &SetEventListenerBreakpointParams{
  196. EventName: eventName,
  197. }
  198. }
  199. // WithTargetName eventTarget interface name to stop on. If equal to "*" or
  200. // not provided, will stop on any EventTarget.
  201. func (p SetEventListenerBreakpointParams) WithTargetName(targetName string) *SetEventListenerBreakpointParams {
  202. p.TargetName = targetName
  203. return &p
  204. }
  205. // Do executes DOMDebugger.setEventListenerBreakpoint against the provided context.
  206. func (p *SetEventListenerBreakpointParams) Do(ctx context.Context) (err error) {
  207. return cdp.Execute(ctx, CommandSetEventListenerBreakpoint, p, nil)
  208. }
  209. // SetXHRBreakpointParams sets breakpoint on XMLHttpRequest.
  210. type SetXHRBreakpointParams struct {
  211. URL string `json:"url"` // Resource URL substring. All XHRs having this substring in the URL will get stopped upon.
  212. }
  213. // SetXHRBreakpoint sets breakpoint on XMLHttpRequest.
  214. //
  215. // See: https://chromedevtools.github.io/devtools-protocol/tot/DOMDebugger#method-setXHRBreakpoint
  216. //
  217. // parameters:
  218. //
  219. // url - Resource URL substring. All XHRs having this substring in the URL will get stopped upon.
  220. func SetXHRBreakpoint(url string) *SetXHRBreakpointParams {
  221. return &SetXHRBreakpointParams{
  222. URL: url,
  223. }
  224. }
  225. // Do executes DOMDebugger.setXHRBreakpoint against the provided context.
  226. func (p *SetXHRBreakpointParams) Do(ctx context.Context) (err error) {
  227. return cdp.Execute(ctx, CommandSetXHRBreakpoint, p, nil)
  228. }
  229. // Command names.
  230. const (
  231. CommandGetEventListeners = "DOMDebugger.getEventListeners"
  232. CommandRemoveDOMBreakpoint = "DOMDebugger.removeDOMBreakpoint"
  233. CommandRemoveEventListenerBreakpoint = "DOMDebugger.removeEventListenerBreakpoint"
  234. CommandRemoveXHRBreakpoint = "DOMDebugger.removeXHRBreakpoint"
  235. CommandSetBreakOnCSPViolation = "DOMDebugger.setBreakOnCSPViolation"
  236. CommandSetDOMBreakpoint = "DOMDebugger.setDOMBreakpoint"
  237. CommandSetEventListenerBreakpoint = "DOMDebugger.setEventListenerBreakpoint"
  238. CommandSetXHRBreakpoint = "DOMDebugger.setXHRBreakpoint"
  239. )