osn-selenium 1.0.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

osn_selenium/trio_bidi/mapping/response_functions/_alert.py

@@ -0,0 +1,81 @@
+from typing import Any, Dict
+from selenium.webdriver.remote.command import Command
+from osn_selenium.trio_bidi._typehints import (
+	MAP_RESPONSE_FUNCTION_TYPEHINT,
+	REQUEST_PARAMS_TYPEHINT
+)
+from osn_selenium.trio_bidi.mapping.response_functions._args_helpers import (
+	map_js_primitive_response,
+	map_void_response
+)
+
+
+__all__ = ["MAPPED_RESPONSE_ALERT_COMMANDS"]
+
+
+def _map_w3c_set_alert_value_response(bidi_result: Dict[str, Any], request_params: REQUEST_PARAMS_TYPEHINT) -> Dict[str, Any]:
+	"""
+	Maps BiDi response for setting alert value to W3C void response.
+
+	Args:
+		bidi_result (Dict[str, Any]): BiDi response result.
+		request_params (REQUEST_PARAMS_TYPEHINT): Original request parameters.
+
+	Returns:
+		Dict[str, Any]: W3C void response.
+	"""
+	
+	return map_void_response(bidi_result=bidi_result, request_params=request_params)
+
+
+def _map_w3c_get_alert_text_response(bidi_result: Dict[str, Any], request_params: REQUEST_PARAMS_TYPEHINT) -> Dict[str, Any]:
+	"""
+	Maps BiDi response for alert text to W3C primitive response.
+
+	Args:
+		bidi_result (Dict[str, Any]): BiDi response result.
+		request_params (REQUEST_PARAMS_TYPEHINT): Original request parameters.
+
+	Returns:
+		Dict[str, Any]: W3C response with the alert text.
+	"""
+	
+	return map_js_primitive_response(bidi_result=bidi_result, request_params=request_params)
+
+
+def _map_w3c_dismiss_alert_response(bidi_result: Dict[str, Any], request_params: REQUEST_PARAMS_TYPEHINT) -> Dict[str, Any]:
+	"""
+	Maps BiDi response for dismissing alert to W3C void response.
+
+	Args:
+		bidi_result (Dict[str, Any]): BiDi response result.
+		request_params (REQUEST_PARAMS_TYPEHINT): Original request parameters.
+
+	Returns:
+		Dict[str, Any]: W3C void response.
+	"""
+	
+	return map_void_response(bidi_result=bidi_result, request_params=request_params)
+
+
+def _map_w3c_accept_alert_response(bidi_result: Dict[str, Any], request_params: REQUEST_PARAMS_TYPEHINT) -> Dict[str, Any]:
+	"""
+	Maps BiDi response for accepting alert to W3C void response.
+
+	Args:
+		bidi_result (Dict[str, Any]): BiDi response result.
+		request_params (REQUEST_PARAMS_TYPEHINT): Original request parameters.
+
+	Returns:
+		Dict[str, Any]: W3C void response.
+	"""
+	
+	return map_void_response(bidi_result=bidi_result, request_params=request_params)
+
+
+MAPPED_RESPONSE_ALERT_COMMANDS: Dict[str, MAP_RESPONSE_FUNCTION_TYPEHINT] = {
+	Command.W3C_GET_ALERT_TEXT: _map_w3c_get_alert_text_response,
+	Command.W3C_ACCEPT_ALERT: _map_w3c_accept_alert_response,
+	Command.W3C_DISMISS_ALERT: _map_w3c_dismiss_alert_response,
+	Command.W3C_SET_ALERT_VALUE: _map_w3c_set_alert_value_response,
+}

osn_selenium/trio_bidi/mapping/response_functions/_args_helpers.py

@@ -0,0 +1,183 @@
+from typing import Any, Dict
+from osn_selenium.trio_bidi._internal_mappings import (
+	OSN_SWITCH_CONTEXT_KEY
+)
+from osn_selenium.trio_bidi._typehints import (
+	CURRENT_BROWSING_CONTEXT_TYPEHINT
+)
+from osn_selenium.trio_bidi.mapping._utils import (
+	ELEMENT_KEY,
+	SHADOW_ROOT_KEY
+)
+
+
+__all__ = [
+	"build_w3c_element",
+	"build_w3c_shadow_root",
+	"convert_bidi_to_w3c_js",
+	"inject_osn_switch_context_to_response",
+	"map_js_primitive_response",
+	"map_js_response",
+	"map_rect_response",
+	"map_void_response"
+]
+
+
+def map_void_response(bidi_result: Dict[str, Any], request_params: Any) -> Dict[str, Any]:
+	"""
+	Returns a standard W3C void response (value: null).
+
+	Args:
+		bidi_result (Dict[str, Any]): BiDi result dictionary.
+		request_params (Any): Original request parameters.
+
+	Returns:
+		Dict[str, Any]: W3C response with null value.
+	"""
+	
+	return {"value": None}
+
+
+def map_rect_response(bidi_result: Dict[str, Any], request_params: Any) -> Dict[str, Any]:
+	"""
+	Maps BiDi geometric result to W3C rect format.
+
+	Args:
+		bidi_result (Dict[str, Any]): BiDi result containing geometry data.
+		request_params (Any): Original request parameters.
+
+	Returns:
+		Dict[str, Any]: W3C response with x, y, width, height.
+	"""
+	
+	return {
+		"value": {
+			"x": bidi_result.get("x", 0),
+			"y": bidi_result.get("y", 0),
+			"width": bidi_result.get("width", 0),
+			"height": bidi_result.get("height", 0)
+		}
+	}
+
+
+def convert_bidi_to_w3c_js(bidi_value: Dict[str, Any]) -> Any:
+	"""
+	Recursively converts a BiDi RemoteValue/LocalValue into a Python representation compatible with W3C.
+
+	Args:
+		bidi_value (Dict[str, Any]): The BiDi value dictionary to convert.
+
+	Returns:
+		Any: The converted value (dict, list, primitive, or element reference).
+	"""
+	
+	if not isinstance(bidi_value, dict):
+		return bidi_value
+	
+	rv_type = bidi_value.get("type")
+	
+	if rv_type in ("string", "number", "boolean"):
+		return bidi_value.get("value")
+	
+	if rv_type == "null":
+		return None
+	
+	if rv_type == "window":
+		return bidi_value.get("value", {}).get("context")
+	
+	if rv_type == "node":
+		shared_id = bidi_value.get("sharedId") or bidi_value.get("value", {}).get("sharedId")
+		return {ELEMENT_KEY: shared_id}
+	
+	if rv_type == "array":
+		return [convert_bidi_to_w3c_js(item) for item in bidi_value.get("value", [])]
+	
+	if rv_type == "object":
+		result = {}
+	
+		for pair in bidi_value.get("value", []):
+			k = convert_bidi_to_w3c_js(pair[0])
+			v = convert_bidi_to_w3c_js(pair[1])
+	
+			result[k] = v
+	
+		return result
+	
+	return None
+
+
+def map_js_response(bidi_result: Dict[str, Any], request_params: Any) -> Dict[str, Any]:
+	"""
+	Maps any BiDi RemoteValue to a W3C compatible Python object.
+
+	Args:
+		bidi_result (Dict[str, Any]): BiDi result containing 'result'.
+		request_params (Any): Original request parameters.
+
+	Returns:
+		Dict[str, Any]: W3C response with converted value.
+	"""
+	
+	remote_value = bidi_result.get("result", {})
+	
+	return {"value": convert_bidi_to_w3c_js(bidi_value=remote_value)}
+
+
+def map_js_primitive_response(bidi_result: Dict[str, Any], request_params: Any) -> Dict[str, Any]:
+	"""
+	Maps a BiDi script result containing a simple value to W3C format.
+
+	Args:
+		bidi_result (Dict[str, Any]): BiDi result containing 'result.value'.
+		request_params (Any): Original request parameters.
+
+	Returns:
+		Dict[str, Any]: W3C response with the primitive value.
+	"""
+	
+	return {"value": bidi_result.get("result", {}).get("value")}
+
+
+def inject_osn_switch_context_to_response(response: Dict[str, Any], context_id: CURRENT_BROWSING_CONTEXT_TYPEHINT) -> Dict[str, Any]:
+	"""
+	Injects a special key into the response to notify the driver of a context switch.
+
+	Args:
+		response (Dict[str, Any]): The W3C response dictionary.
+		context_id (CURRENT_BROWSING_CONTEXT_TYPEHINT): The target browsing context ID.
+
+	Returns:
+		Dict[str, Any]: Modified response dictionary.
+	"""
+	
+	response[OSN_SWITCH_CONTEXT_KEY] = context_id
+	
+	return response
+
+
+def build_w3c_shadow_root(id_: str) -> Dict[str, Any]:
+	"""
+	Wraps a shared ID into a W3C shadow root reference.
+
+	Args:
+		id_ (str): The shadow root shared ID.
+
+	Returns:
+		Dict[str, Any]: W3C shadow root dictionary.
+	"""
+	
+	return {SHADOW_ROOT_KEY: id_}
+
+
+def build_w3c_element(id_: str) -> Dict[str, Any]:
+	"""
+	Wraps a shared ID into a W3C element reference.
+
+	Args:
+		id_ (str): The element shared ID.
+
+	Returns:
+		Dict[str, Any]: W3C element dictionary.
+	"""
+	
+	return {ELEMENT_KEY: id_}

osn_selenium/trio_bidi/mapping/response_functions/_args_validators.py

@@ -0,0 +1,153 @@
+from typing import (
+	Any,
+	Dict,
+	Optional,
+	Tuple
+)
+from selenium.webdriver.remote.errorhandler import ErrorCode
+from osn_selenium.trio_bidi._typehints import (
+	REQUEST_PARAMS_TYPEHINT
+)
+from osn_selenium.trio_bidi._error_mappings import (
+	create_w3c_error_response
+)
+
+
+__all__ = [
+	"validate_element_exceptions",
+	"validate_javascript_error",
+	"validate_no_such_element"
+]
+
+
+def validate_no_such_element(nodes: Any, request_params: REQUEST_PARAMS_TYPEHINT) -> Optional[Dict[str, Any]]:
+	"""
+	Checks if nodes list is empty and returns a NO_SUCH_ELEMENT error if so.
+
+	Args:
+		nodes (Any): The collection of nodes found.
+		request_params (Optional[Dict[str, Any]]): Original request parameters for message details.
+
+	Returns:
+		Optional[Dict[str, Any]]: W3C error response if empty, else None.
+	"""
+	
+	if not nodes:
+		using = request_params.get("using", "unknown")
+		value = request_params.get("value", "unknown")
+	
+		message = f"no such element: Unable to locate element: {{\"method\":\"{using}\",\"selector\":\"{value}\"}}"
+		status_code, error_string = ErrorCode.NO_SUCH_ELEMENT
+	
+		return create_w3c_error_response(status_code=status_code, error_string=error_string, message=message)
+	
+	return None
+
+
+def _get_js_exception_details(bidi_result: Dict[str, Any]) -> Tuple[Optional[str], str]:
+	"""
+	Extracts text and stacktrace from a BiDi exception result.
+
+	Args:
+		bidi_result (Dict[str, Any]): The BiDi response object.
+
+	Returns:
+		Tuple[Optional[str], str]: Lowercased error message and formatted stacktrace string.
+	"""
+	
+	if bidi_result.get("type") != "exception":
+		return None, ""
+	
+	details = bidi_result.get("exceptionDetails", {})
+	text = details.get("text", "")
+	
+	stack_frames = details.get("stackTrace", {}).get("callFrames", [])
+	stack_lines = []
+	
+	for frame in stack_frames:
+		func = frame.get("functionName") or "anonymous"
+		url = frame.get("url") or "unknown"
+		line = frame.get("lineNumber", 0)
+		col = frame.get("columnNumber", 0)
+	
+		stack_lines.append(f"    at {func} ({url}:{line}:{col})")
+	
+	return text.lower(), "\n".join(stack_lines)
+
+
+def validate_javascript_error(bidi_result: Dict[str, Any], request_params: REQUEST_PARAMS_TYPEHINT) -> Optional[Dict[str, Any]]:
+	"""
+	Checks for script exceptions in BiDi result and converts them to JAVASCRIPT_ERROR.
+
+	Args:
+		bidi_result (Dict[str, Any]): Result from script evaluation.
+		request_params (Optional[Dict[str, Any]]): Original request parameters.
+
+	Returns:
+		Optional[Dict[str, Any]]: W3C error response if exception occurred, else None.
+	"""
+	
+	error_text, stack = _get_js_exception_details(bidi_result=bidi_result)
+	
+	if error_text:
+		status_code, error_string = ErrorCode.JAVASCRIPT_ERROR
+		message = f"javascript error: {error_text}"
+	
+		return create_w3c_error_response(
+				status_code=status_code,
+				error_string=error_string,
+				message=message,
+				stacktrace=stack
+		)
+	
+	return None
+
+
+def validate_element_exceptions(bidi_result: Dict[str, Any], request_params: REQUEST_PARAMS_TYPEHINT) -> Optional[Dict[str, Any]]:
+	"""
+	Validates script execution results for element-specific exceptions (stale, not interactable, etc.).
+
+	Args:
+		bidi_result (Dict[str, Any]): Result from script evaluation.
+		request_params (Optional[Dict[str, Any]]): Original request parameters.
+
+	Returns:
+		Optional[Dict[str, Any]]: W3C error response if an element-related error occurred, else None.
+	"""
+	
+	error_text, stack = _get_js_exception_details(bidi_result=bidi_result)
+	
+	if not error_text:
+		return None
+	
+	mapping = {
+		"stale element reference": ErrorCode.STALE_ELEMENT_REFERENCE,
+		"no such shadow root": ErrorCode.NO_SUCH_SHADOW_ROOT,
+		"element not interactable": ErrorCode.ELEMENT_NOT_INTERACTABLE,
+		"invalid element state": ErrorCode.INVALID_ELEMENT_STATE,
+		"element not selectable": ErrorCode.ELEMENT_IS_NOT_SELECTABLE,
+		"element click intercepted": ErrorCode.ELEMENT_CLICK_INTERCEPTED,
+		"invalid element coordinates": ErrorCode.INVALID_ELEMENT_COORDINATES,
+	}
+	
+	for key, code_info in mapping.items():
+		if key in error_text:
+			raw_msg = bidi_result["result"]["exceptionDetails"]["text"]
+	
+			if key == "stale element reference":
+				message = "stale element reference: element is not attached to the page document"
+			else:
+				message = raw_msg
+	
+			return create_w3c_error_response(
+					status_code=code_info[0]
+					if isinstance(code_info, list)
+					else 13,
+					error_string=code_info[1]
+					if isinstance(code_info, list)
+					else code_info[0],
+					message=message,
+					stacktrace=stack,
+			)
+	
+	return validate_javascript_error(bidi_result, request_params)

osn_selenium/trio_bidi/mapping/response_functions/_capture.py

@@ -0,0 +1,71 @@
+from typing import Any, Dict
+from selenium.webdriver.remote.command import Command
+from osn_selenium.trio_bidi.mapping.response_functions._args_helpers import (
+	map_js_primitive_response
+)
+from osn_selenium.trio_bidi._typehints import (
+	MAP_RESPONSE_FUNCTION_TYPEHINT,
+	REQUEST_PARAMS_TYPEHINT
+)
+from osn_selenium.trio_bidi.mapping.response_functions._args_validators import (
+	validate_javascript_error
+)
+
+
+__all__ = ["MAPPED_RESPONSE_CAPTURE_COMMANDS"]
+
+
+def _map_screenshot_response(bidi_result: Dict[str, Any], request_params: REQUEST_PARAMS_TYPEHINT) -> Dict[str, Any]:
+	"""
+	Extracts base64 screenshot data from BiDi result.
+
+	Args:
+		bidi_result (Dict[str, Any]): BiDi response containing 'data'.
+		request_params (REQUEST_PARAMS_TYPEHINT): Original request parameters.
+
+	Returns:
+		Dict[str, Any]: W3C response with base64 data.
+	"""
+	
+	return {"value": bidi_result.get("data")}
+
+
+def _map_print_page_response(bidi_result: Dict[str, Any], request_params: REQUEST_PARAMS_TYPEHINT) -> Dict[str, Any]:
+	"""
+	Extracts base64 PDF data from BiDi print result.
+
+	Args:
+		bidi_result (Dict[str, Any]): BiDi response containing 'data'.
+		request_params (REQUEST_PARAMS_TYPEHINT): Original request parameters.
+
+	Returns:
+		Dict[str, Any]: W3C response with base64 data.
+	"""
+	
+	return {"value": bidi_result.get("data")}
+
+
+def _map_get_page_source_response(bidi_result: Dict[str, Any], request_params: REQUEST_PARAMS_TYPEHINT) -> Dict[str, Any]:
+	"""
+	Maps BiDi script evaluation result to page source string.
+
+	Args:
+		bidi_result (Dict[str, Any]): BiDi response with JS evaluation result.
+		request_params (REQUEST_PARAMS_TYPEHINT): Original request parameters.
+
+	Returns:
+		Dict[str, Any]: W3C response with HTML string.
+	"""
+	
+	javascript_error_validation = validate_javascript_error(bidi_result=bidi_result, request_params=request_params)
+	if javascript_error_validation is not None:
+		return javascript_error_validation
+	
+	return map_js_primitive_response(bidi_result, request_params)
+
+
+MAPPED_RESPONSE_CAPTURE_COMMANDS: Dict[str, MAP_RESPONSE_FUNCTION_TYPEHINT] = {
+	Command.SCREENSHOT: _map_screenshot_response,
+	Command.GET_PAGE_SOURCE: _map_get_page_source_response,
+	Command.PRINT_PAGE: _map_print_page_response,
+}

osn_selenium/trio_bidi/mapping/response_functions/_cdp.py

@@ -0,0 +1,26 @@
+from typing import Any, Dict
+from osn_selenium.trio_bidi._typehints import (
+	MAP_RESPONSE_FUNCTION_TYPEHINT,
+	REQUEST_PARAMS_TYPEHINT
+)
+
+
+__all__ = ["MAPPED_RESPONSE_CDP_COMMANDS"]
+
+
+def _execute_cdp_command(bidi_result: Dict[str, Any], request_params: REQUEST_PARAMS_TYPEHINT) -> Dict[str, Any]:
+	"""
+	Maps the result of a CDP command back to the W3C response format.
+
+	Args:
+		bidi_result (Dict[str, Any]): The result received from BiDi.
+		request_params (Optional[Dict[str, Any]]): The original request parameters.
+
+	Returns:
+		Dict[str, Any]: The W3C-compatible result wrapper.
+	"""
+	
+	return {"value": bidi_result.get("result")}
+
+
+MAPPED_RESPONSE_CDP_COMMANDS: Dict[str, MAP_RESPONSE_FUNCTION_TYPEHINT] = {"executeCdpCommand": _execute_cdp_command}

osn_selenium/trio_bidi/mapping/response_functions/_element.py

@@ -0,0 +1,58 @@
+from typing import Any, Dict
+from selenium.webdriver.remote.command import Command
+from osn_selenium.trio_bidi.mapping.response_functions._args_helpers import build_w3c_element
+from osn_selenium.trio_bidi._typehints import (
+	MAP_RESPONSE_FUNCTION_TYPEHINT,
+	REQUEST_PARAMS_TYPEHINT
+)
+from osn_selenium.trio_bidi.mapping.response_functions._args_validators import (
+	validate_no_such_element
+)
+
+
+__all__ = ["MAPPED_RESPONSE_ELEMENT_COMMANDS"]
+
+
+def _map_find_elements_response(bidi_result: Dict[str, Any], request_params: REQUEST_PARAMS_TYPEHINT) -> Dict[str, Any]:
+	"""
+	Converts BiDi nodes into a list of W3C element references.
+
+	Args:
+		bidi_result (Dict[str, Any]): BiDi result containing 'nodes'.
+		request_params (REQUEST_PARAMS_TYPEHINT): Original request parameters.
+
+	Returns:
+		Dict[str, Any]: W3C response containing a list of element dicts.
+	"""
+	
+	nodes = bidi_result.get("nodes", [])
+	value = [build_w3c_element(node["sharedId"]) for node in nodes]
+	
+	return {"value": value}
+
+
+def _map_find_element_response(bidi_result: Dict[str, Any], request_params: REQUEST_PARAMS_TYPEHINT) -> Dict[str, Any]:
+	"""
+	Converts BiDi first node into a single W3C element reference, validating existence.
+
+	Args:
+		bidi_result (Dict[str, Any]): BiDi result containing 'nodes'.
+		request_params (REQUEST_PARAMS_TYPEHINT): Original request parameters.
+
+	Returns:
+		Dict[str, Any]: W3C response containing an element dict or error.
+	"""
+	
+	nodes = bidi_result.get("nodes", [])
+	
+	no_such_element_validation = validate_no_such_element(nodes=nodes, request_params=request_params)
+	if no_such_element_validation is not None:
+		return no_such_element_validation
+	
+	return {"value": build_w3c_element(nodes[0]["sharedId"])}
+
+
+MAPPED_RESPONSE_ELEMENT_COMMANDS: Dict[str, MAP_RESPONSE_FUNCTION_TYPEHINT] = {
+	Command.FIND_ELEMENT: _map_find_element_response,
+	Command.FIND_ELEMENTS: _map_find_elements_response
+}

osn_selenium/trio_bidi/mapping/response_functions/_file.py

@@ -0,0 +1,30 @@
+from typing import Any, Dict
+from selenium.webdriver.remote.command import Command
+from osn_selenium.trio_bidi.mapping.response_functions._args_helpers import (
+	map_js_primitive_response
+)
+from osn_selenium.trio_bidi._typehints import (
+	MAP_RESPONSE_FUNCTION_TYPEHINT,
+	REQUEST_PARAMS_TYPEHINT
+)
+
+
+__all__ = ["MAPPED_RESPONSE_FILE_COMMANDS"]
+
+
+def _map_upload_file_response(bidi_result: Dict[str, Any], request_params: REQUEST_PARAMS_TYPEHINT) -> Dict[str, Any]:
+	"""
+	Maps BiDi file upload result to W3C response format.
+
+	Args:
+		bidi_result (Dict[str, Any]): BiDi internal response.
+		request_params (REQUEST_PARAMS_TYPEHINT): Original request parameters.
+
+	Returns:
+		Dict[str, Any]: W3C response with the file path.
+	"""
+	
+	return map_js_primitive_response(bidi_result=bidi_result, request_params=request_params)
+
+
+MAPPED_RESPONSE_FILE_COMMANDS: Dict[str, MAP_RESPONSE_FUNCTION_TYPEHINT] = {Command.UPLOAD_FILE: _map_upload_file_response}