selenium-devtools 0.99.1 → 0.100.0

data/lib/selenium/devtools/v100/network.rb

@@ -0,0 +1,264 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# This file is automatically generated. Any changes will be lost!
+module Selenium
+  module DevTools
+    module V100
+      class Network
+        EVENTS = {
+          data_received: 'dataReceived',
+          event_source_message_received: 'eventSourceMessageReceived',
+          loading_failed: 'loadingFailed',
+          loading_finished: 'loadingFinished',
+          request_intercepted: 'requestIntercepted',
+          request_served_from_cache: 'requestServedFromCache',
+          request_will_be_sent: 'requestWillBeSent',
+          resource_changed_priority: 'resourceChangedPriority',
+          signed_exchange_received: 'signedExchangeReceived',
+          response_received: 'responseReceived',
+          web_socket_closed: 'webSocketClosed',
+          web_socket_created: 'webSocketCreated',
+          web_socket_frame_error: 'webSocketFrameError',
+          web_socket_frame_received: 'webSocketFrameReceived',
+          web_socket_frame_sent: 'webSocketFrameSent',
+          web_socket_handshake_response_received: 'webSocketHandshakeResponseReceived',
+          web_socket_will_send_handshake_request: 'webSocketWillSendHandshakeRequest',
+          web_transport_created: 'webTransportCreated',
+          web_transport_connection_established: 'webTransportConnectionEstablished',
+          web_transport_closed: 'webTransportClosed',
+          request_will_be_sent_extra_info: 'requestWillBeSentExtraInfo',
+          response_received_extra_info: 'responseReceivedExtraInfo',
+          trust_token_operation_done: 'trustTokenOperationDone',
+          subresource_web_bundle_metadata_received: 'subresourceWebBundleMetadataReceived',
+          subresource_web_bundle_metadata_error: 'subresourceWebBundleMetadataError',
+          subresource_web_bundle_inner_response_parsed: 'subresourceWebBundleInnerResponseParsed',
+          subresource_web_bundle_inner_response_error: 'subresourceWebBundleInnerResponseError',
+          reporting_api_report_added: 'reportingApiReportAdded',
+          reporting_api_report_updated: 'reportingApiReportUpdated',
+          reporting_api_endpoints_changed_for_origin: 'reportingApiEndpointsChangedForOrigin',
+        }.freeze
+
+        def initialize(devtools)
+          @devtools = devtools
+        end
+
+        def on(event, &block)
+          event = EVENTS[event] if event.is_a?(Symbol)
+          @devtools.callbacks["Network.#{event}"] << block
+        end
+
+        def set_accepted_encodings(encodings:)
+          @devtools.send_cmd('Network.setAcceptedEncodings',
+                             encodings: encodings)
+        end
+
+        def clear_accepted_encodings_override
+          @devtools.send_cmd('Network.clearAcceptedEncodingsOverride')
+        end
+
+        def can_clear_browser_cache
+          @devtools.send_cmd('Network.canClearBrowserCache')
+        end
+
+        def can_clear_browser_cookies
+          @devtools.send_cmd('Network.canClearBrowserCookies')
+        end
+
+        def can_emulate_network_conditions
+          @devtools.send_cmd('Network.canEmulateNetworkConditions')
+        end
+
+        def clear_browser_cache
+          @devtools.send_cmd('Network.clearBrowserCache')
+        end
+
+        def clear_browser_cookies
+          @devtools.send_cmd('Network.clearBrowserCookies')
+        end
+
+        def continue_intercepted_request(interception_id:, error_reason: nil, raw_response: nil, url: nil, method: nil, post_data: nil, headers: nil, auth_challenge_response: nil)
+          @devtools.send_cmd('Network.continueInterceptedRequest',
+                             interceptionId: interception_id,
+                             errorReason: error_reason,
+                             rawResponse: raw_response,
+                             url: url,
+                             method: method,
+                             postData: post_data,
+                             headers: headers,
+                             authChallengeResponse: auth_challenge_response)
+        end
+
+        def delete_cookies(name:, url: nil, domain: nil, path: nil)
+          @devtools.send_cmd('Network.deleteCookies',
+                             name: name,
+                             url: url,
+                             domain: domain,
+                             path: path)
+        end
+
+        def disable
+          @devtools.send_cmd('Network.disable')
+        end
+
+        def emulate_network_conditions(offline:, latency:, download_throughput:, upload_throughput:, connection_type: nil)
+          @devtools.send_cmd('Network.emulateNetworkConditions',
+                             offline: offline,
+                             latency: latency,
+                             downloadThroughput: download_throughput,
+                             uploadThroughput: upload_throughput,
+                             connectionType: connection_type)
+        end
+
+        def enable(max_total_buffer_size: nil, max_resource_buffer_size: nil, max_post_data_size: nil)
+          @devtools.send_cmd('Network.enable',
+                             maxTotalBufferSize: max_total_buffer_size,
+                             maxResourceBufferSize: max_resource_buffer_size,
+                             maxPostDataSize: max_post_data_size)
+        end
+
+        def get_all_cookies
+          @devtools.send_cmd('Network.getAllCookies')
+        end
+
+        def get_certificate(origin:)
+          @devtools.send_cmd('Network.getCertificate',
+                             origin: origin)
+        end
+
+        def get_cookies(urls: nil)
+          @devtools.send_cmd('Network.getCookies',
+                             urls: urls)
+        end
+
+        def get_response_body(request_id:)
+          @devtools.send_cmd('Network.getResponseBody',
+                             requestId: request_id)
+        end
+
+        def get_request_post_data(request_id:)
+          @devtools.send_cmd('Network.getRequestPostData',
+                             requestId: request_id)
+        end
+
+        def get_response_body_for_interception(interception_id:)
+          @devtools.send_cmd('Network.getResponseBodyForInterception',
+                             interceptionId: interception_id)
+        end
+
+        def take_response_body_for_interception_as_stream(interception_id:)
+          @devtools.send_cmd('Network.takeResponseBodyForInterceptionAsStream',
+                             interceptionId: interception_id)
+        end
+
+        def replay_xhr(request_id:)
+          @devtools.send_cmd('Network.replayXHR',
+                             requestId: request_id)
+        end
+
+        def search_in_response_body(request_id:, query:, case_sensitive: nil, is_regex: nil)
+          @devtools.send_cmd('Network.searchInResponseBody',
+                             requestId: request_id,
+                             query: query,
+                             caseSensitive: case_sensitive,
+                             isRegex: is_regex)
+        end
+
+        def set_blocked_urls(urls:)
+          @devtools.send_cmd('Network.setBlockedURLs',
+                             urls: urls)
+        end
+
+        def set_bypass_service_worker(bypass:)
+          @devtools.send_cmd('Network.setBypassServiceWorker',
+                             bypass: bypass)
+        end
+
+        def set_cache_disabled(cache_disabled:)
+          @devtools.send_cmd('Network.setCacheDisabled',
+                             cacheDisabled: cache_disabled)
+        end
+
+        def set_cookie(name:, value:, url: nil, domain: nil, path: nil, secure: nil, http_only: nil, same_site: nil, expires: nil, priority: nil, same_party: nil, source_scheme: nil, source_port: nil, partition_key: nil)
+          @devtools.send_cmd('Network.setCookie',
+                             name: name,
+                             value: value,
+                             url: url,
+                             domain: domain,
+                             path: path,
+                             secure: secure,
+                             httpOnly: http_only,
+                             sameSite: same_site,
+                             expires: expires,
+                             priority: priority,
+                             sameParty: same_party,
+                             sourceScheme: source_scheme,
+                             sourcePort: source_port,
+                             partitionKey: partition_key)
+        end
+
+        def set_cookies(cookies:)
+          @devtools.send_cmd('Network.setCookies',
+                             cookies: cookies)
+        end
+
+        def set_extra_http_headers(headers:)
+          @devtools.send_cmd('Network.setExtraHTTPHeaders',
+                             headers: headers)
+        end
+
+        def set_attach_debug_stack(enabled:)
+          @devtools.send_cmd('Network.setAttachDebugStack',
+                             enabled: enabled)
+        end
+
+        def set_request_interception(patterns:)
+          @devtools.send_cmd('Network.setRequestInterception',
+                             patterns: patterns)
+        end
+
+        def set_user_agent_override(user_agent:, accept_language: nil, platform: nil, user_agent_metadata: nil)
+          @devtools.send_cmd('Network.setUserAgentOverride',
+                             userAgent: user_agent,
+                             acceptLanguage: accept_language,
+                             platform: platform,
+                             userAgentMetadata: user_agent_metadata)
+        end
+
+        def get_security_isolation_status(frame_id: nil)
+          @devtools.send_cmd('Network.getSecurityIsolationStatus',
+                             frameId: frame_id)
+        end
+
+        def enable_reporting_api(enable:)
+          @devtools.send_cmd('Network.enableReportingApi',
+                             enable: enable)
+        end
+
+        def load_network_resource(frame_id: nil, url:, options:)
+          @devtools.send_cmd('Network.loadNetworkResource',
+                             frameId: frame_id,
+                             url: url,
+                             options: options)
+        end
+
+      end # Network
+    end # V100
+  end # DevTools
+end # Selenium

data/lib/selenium/devtools/v100/overlay.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# This file is automatically generated. Any changes will be lost!
+module Selenium
+  module DevTools
+    module V100
+      class Overlay
+        EVENTS = {
+          inspect_node_requested: 'inspectNodeRequested',
+          node_highlight_requested: 'nodeHighlightRequested',
+          screenshot_requested: 'screenshotRequested',
+          inspect_mode_canceled: 'inspectModeCanceled',
+        }.freeze
+
+        def initialize(devtools)
+          @devtools = devtools
+        end
+
+        def on(event, &block)
+          event = EVENTS[event] if event.is_a?(Symbol)
+          @devtools.callbacks["Overlay.#{event}"] << block
+        end
+
+        def disable
+          @devtools.send_cmd('Overlay.disable')
+        end
+
+        def enable
+          @devtools.send_cmd('Overlay.enable')
+        end
+
+        def get_highlight_object_for_test(node_id:, include_distance: nil, include_style: nil, color_format: nil, show_accessibility_info: nil)
+          @devtools.send_cmd('Overlay.getHighlightObjectForTest',
+                             nodeId: node_id,
+                             includeDistance: include_distance,
+                             includeStyle: include_style,
+                             colorFormat: color_format,
+                             showAccessibilityInfo: show_accessibility_info)
+        end
+
+        def get_grid_highlight_objects_for_test(node_ids:)
+          @devtools.send_cmd('Overlay.getGridHighlightObjectsForTest',
+                             nodeIds: node_ids)
+        end
+
+        def get_source_order_highlight_object_for_test(node_id:)
+          @devtools.send_cmd('Overlay.getSourceOrderHighlightObjectForTest',
+                             nodeId: node_id)
+        end
+
+        def hide_highlight
+          @devtools.send_cmd('Overlay.hideHighlight')
+        end
+
+        def highlight_frame(frame_id:, content_color: nil, content_outline_color: nil)
+          @devtools.send_cmd('Overlay.highlightFrame',
+                             frameId: frame_id,
+                             contentColor: content_color,
+                             contentOutlineColor: content_outline_color)
+        end
+
+        def highlight_node(highlight_config:, node_id: nil, backend_node_id: nil, object_id: nil, selector: nil)
+          @devtools.send_cmd('Overlay.highlightNode',
+                             highlightConfig: highlight_config,
+                             nodeId: node_id,
+                             backendNodeId: backend_node_id,
+                             objectId: object_id,
+                             selector: selector)
+        end
+
+        def highlight_quad(quad:, color: nil, outline_color: nil)
+          @devtools.send_cmd('Overlay.highlightQuad',
+                             quad: quad,
+                             color: color,
+                             outlineColor: outline_color)
+        end
+
+        def highlight_rect(x:, y:, width:, height:, color: nil, outline_color: nil)
+          @devtools.send_cmd('Overlay.highlightRect',
+                             x: x,
+                             y: y,
+                             width: width,
+                             height: height,
+                             color: color,
+                             outlineColor: outline_color)
+        end
+
+        def highlight_source_order(source_order_config:, node_id: nil, backend_node_id: nil, object_id: nil)
+          @devtools.send_cmd('Overlay.highlightSourceOrder',
+                             sourceOrderConfig: source_order_config,
+                             nodeId: node_id,
+                             backendNodeId: backend_node_id,
+                             objectId: object_id)
+        end
+
+        def set_inspect_mode(mode:, highlight_config: nil)
+          @devtools.send_cmd('Overlay.setInspectMode',
+                             mode: mode,
+                             highlightConfig: highlight_config)
+        end
+
+        def set_show_ad_highlights(show:)
+          @devtools.send_cmd('Overlay.setShowAdHighlights',
+                             show: show)
+        end
+
+        def set_paused_in_debugger_message(message: nil)
+          @devtools.send_cmd('Overlay.setPausedInDebuggerMessage',
+                             message: message)
+        end
+
+        def set_show_debug_borders(show:)
+          @devtools.send_cmd('Overlay.setShowDebugBorders',
+                             show: show)
+        end
+
+        def set_show_fps_counter(show:)
+          @devtools.send_cmd('Overlay.setShowFPSCounter',
+                             show: show)
+        end
+
+        def set_show_grid_overlays(grid_node_highlight_configs:)
+          @devtools.send_cmd('Overlay.setShowGridOverlays',
+                             gridNodeHighlightConfigs: grid_node_highlight_configs)
+        end
+
+        def set_show_flex_overlays(flex_node_highlight_configs:)
+          @devtools.send_cmd('Overlay.setShowFlexOverlays',
+                             flexNodeHighlightConfigs: flex_node_highlight_configs)
+        end
+
+        def set_show_scroll_snap_overlays(scroll_snap_highlight_configs:)
+          @devtools.send_cmd('Overlay.setShowScrollSnapOverlays',
+                             scrollSnapHighlightConfigs: scroll_snap_highlight_configs)
+        end
+
+        def set_show_container_query_overlays(container_query_highlight_configs:)
+          @devtools.send_cmd('Overlay.setShowContainerQueryOverlays',
+                             containerQueryHighlightConfigs: container_query_highlight_configs)
+        end
+
+        def set_show_paint_rects(result:)
+          @devtools.send_cmd('Overlay.setShowPaintRects',
+                             result: result)
+        end
+
+        def set_show_layout_shift_regions(result:)
+          @devtools.send_cmd('Overlay.setShowLayoutShiftRegions',
+                             result: result)
+        end
+
+        def set_show_scroll_bottleneck_rects(show:)
+          @devtools.send_cmd('Overlay.setShowScrollBottleneckRects',
+                             show: show)
+        end
+
+        def set_show_hit_test_borders(show:)
+          @devtools.send_cmd('Overlay.setShowHitTestBorders',
+                             show: show)
+        end
+
+        def set_show_web_vitals(show:)
+          @devtools.send_cmd('Overlay.setShowWebVitals',
+                             show: show)
+        end
+
+        def set_show_viewport_size_on_resize(show:)
+          @devtools.send_cmd('Overlay.setShowViewportSizeOnResize',
+                             show: show)
+        end
+
+        def set_show_hinge(hinge_config: nil)
+          @devtools.send_cmd('Overlay.setShowHinge',
+                             hingeConfig: hinge_config)
+        end
+
+        def set_show_isolated_elements(isolated_element_highlight_configs:)
+          @devtools.send_cmd('Overlay.setShowIsolatedElements',
+                             isolatedElementHighlightConfigs: isolated_element_highlight_configs)
+        end
+
+      end # Overlay
+    end # V100
+  end # DevTools
+end # Selenium