Metadata-Version: 2.3
Name: robotframework-jsonrpcremote-protocol
Version: 0.2.0
Summary: The protocol definition for Robot Framework JSON-RPC remote interface.
Keywords: Test,Testing,RobotFramework,Keyword Driven,Robotic Process Automation,RPA,JSON-RPC,JSON-RPC Remote Protocol,Protocol,Schema
Author: Daniel Biehl
Author-email: Daniel Biehl <dbiehl@live.de>
License: Apache License
         Version 2.0, January 2004
         http://www.apache.org/licenses/
         
         TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
         
         1. Definitions.
         
         "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
         
         "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
         
         "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
         
         "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
         
         "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
         
         "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
         
         "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
         
         "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
         
         "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
         
         "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
         
         2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
         
         3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
         
         4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
         
              (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
         
              (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
         
              (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
         
              (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
         
              You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
         
         5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
         
         6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
         
         7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
         
         8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
         
         9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
         
         END OF TERMS AND CONDITIONS
         
         APPENDIX: How to apply the Apache License to your work.
         
         To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
         
         Copyright [yyyy] [name of copyright owner]
         
         Licensed 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.
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Typing :: Typed
Classifier: Intended Audience :: Developers
Classifier: Framework :: Robot Framework
Classifier: Framework :: Robot Framework :: Library
Requires-Python: >=3.10
Project-URL: Homepage, https://github.com/imbus/robotframework-jsonrpcremote
Project-URL: Repository, https://github.com/imbus/robotframework-jsonrpcremote
Project-URL: Issues, https://github.com/imbus/robotframework-jsonrpcremote/issues
Project-URL: Documentation, https://github.com/imbus/robotframework-jsonrpcremote/tree/main/packages/protocol#readme
Description-Content-Type: text/markdown

# robotframework-jsonrpcremote-protocol

This package defines the **communication contract** for the `robotframework-jsonrpcremote` ecosystem. It provides the formal specification of data structures, message types, and interaction flows used to execute Robot Framework keywords remotely via **JSON-RPC 2.0**.

## Purpose

The primary goal of this protocol is to decouple the Robot Framework execution environment (Client) from the keyword implementation (Server). This allows:
*   **Remote Execution**: Running keywords on different machines or containers.
*   **Language Independence**: While this package provides Python type definitions, the underlying JSON-RPC protocol allows servers to be implemented in any language (e.g., Node.js, Java, C#).
*   **Process Isolation**: Running libraries in separate processes to avoid dependency conflicts (e.g., conflicting Python dependencies).

This package serves as the **source of truth** for both the client (`robotframework-jsonrpcremote`) and the server (`robotframework-jsonrpcremote-server`) implementations, ensuring strict type compatibility and a consistent behavior.

## Key Differences from Standard Remote Server

While Robot Framework has a built-in Remote Library interface based on XML-RPC, this protocol introduces several modern enhancements:

*   **JSON-RPC 2.0**: Uses a lightweight, widely supported format instead of XML-RPC.
*   **Bidirectional Communication**: Allows the server to send notifications (like log messages) to the client *during* keyword execution, enabling real-time logging and progress reporting.
*   **Transport Agnostic**: Designed to work over any stream-based transport (TCP, Stdio, WebSockets), making it suitable for local process isolation (via Stdio) as well as distributed testing.
*   **Dynamic Initialization**: Supports passing arguments during the library initialization phase, allowing for flexible configuration of remote libraries.
*   **Argument Conversion & Custom Converters**: Fully supports Robot Framework's argument conversion system, including custom argument converters. Type information is preserved and transmitted, allowing the server to perform precise data validation and conversion even for custom types.
*   **Rich Error Handling**: Distinguishes between protocol errors and application errors, with support for rich traceback information and failure modes (Fatal, Continuable, Skip).

## Protocol Overview

The protocol is based on JSON-RPC 2.0.

It is important to note that this package **only describes the protocol** (data structures, message types, and flow). The underlying transport mechanism used to establish the connection and transmit messages is irrelevant to these definitions. The protocol can be implemented over **TCP, Named Pipes, WebSockets, Standard I/O (STDIO)**, or any other stream-based transport.

It defines a set of requests and notifications for:

1.  **Initialization**: Handshaking and exchanging capabilities.
2.  **Library Discovery**: The server sends the library definition (keywords, arguments) to the client.
3.  **Execution**: The client requests the server to run keywords.
4.  **Logging**: The server sends log messages back to the client during execution.
5.  **Shutdown**: Graceful termination.

## Data Types (Draft)

> **Note:** This section is currently a draft and subject to change as the implementation evolves.

Since JSON-RPC is based on JSON, all data types must be JSON-serializable.

*   **Simple Types**: `str`, `int`, `float`, `bool`, `null` (mapped to `None` in Python).
*   **Complex Types**: `list` (JSON Array), `dict` (JSON Object).

### Extended Type Serialization

To ensure consistent handling of types not natively supported by JSON, the following serialization conventions **must** be used by both client and server:

*   **Date/Time (`datetime`, `date`, `time`)**: Serialize as **ISO 8601** strings (e.g., `"2025-12-18T14:30:00+00:00"`).
*   **Binary Data (`bytes`, `bytearray`)**: Serialize as **Base64** encoded strings.
*   **Decimal (`decimal.Decimal`)**: Serialize as **strings** to preserve precision (e.g., `"123.45"` instead of `123.45`).
*   **UUID (`uuid.UUID`)**: Serialize as **strings** (e.g., `"123e4567-e89b-12d3-a456-426614174000"`).
*   **Path (`pathlib.Path`)**: Serialize as **strings** (using forward slashes `/` is recommended for cross-platform compatibility).
*   **Custom Objects**: Serialize as a `dict` (JSON Object).
    *   If the receiver needs to reconstruct the specific object type, the dictionary **should** include a special discriminator field, such as `__type__` or `_type`, containing the type name.
    *   Example: `{"__type__": "MyCustomObject", "id": 1, "name": "foo"}`.

### Type Resolution Strategy

Since type names are transmitted as strings (e.g., in `ArgumentDefinition.type`), implementations must map these strings back to actual language-specific types.

*   **Standard Types**: Implementations should automatically map common type names (e.g., `"str"`, `"int"`, `"bool"`, `"datetime"`, `"UUID"`) to their corresponding language types.
*   **Custom Types**: For custom objects, the type name should be the **Fully Qualified Name (FQN)** of the type (e.g., `package.module.ClassName`).
    *   **Server**: The server sends the FQN of the argument types.
    *   **Client**: The client uses standard language mechanisms (e.g., `importlib` in Python) to resolve the FQN back to the actual type class.

In the data structure definitions below, `AnyType` refers to any valid JSON type (simple or complex), including these serialized representations.

## Data Structures

The following data classes define the payload for requests and responses.

### Initialization

*   **`InitializeParams`**
    *   `capabilities`: `ClientCapabilities` (optional) - Capabilities provided by the client.
    *   `client_info`: `ClientInfo` (optional) - Information about the client (name, version).
    *   `initialization_options`: `AnyType` (optional) - User-provided options for the server.
    *   `trace`: `str` (optional) - The initial trace setting (e.g., "off", "messages", "verbose").

*   **`InitializeResult`**
    *   `capabilities`: `ServerCapabilities` (optional) - Capabilities provided by the server.
    *   `server_info`: `ServerInfo` (optional) - Information about the server (name, version).

*   **`ClientInfo` / `ServerInfo`**
    *   `name`: `str` - The name of the client or server.
    *   `version`: `str` - The version of the client or server.

*   **`ClientCapabilities`**
    *   `supports_log`: `bool` (optional) - Whether the client supports log notifications.
    *   `supports_trace`: `bool` (optional) - Whether the client supports trace notifications.

*   **`ServerCapabilities`**
    *   `support_exit`: `bool` (optional) - Whether the server supports the exit notification.
    *   `libraries`: `list[str]` (optional) - A list of available libraries on the server.

### Library Management

*   **`ImportLibraryParams`**
    *   `name`: `str` - The name of the library to import.
    *   `args`: `list` (optional) - Positional arguments to pass to the library constructor.
    *   `kw_args`: `dict` (optional) - Keyword arguments to pass to the library constructor.

*   **`ImportLibraryResult`**
    *   `token`: `str` - A unique token representing the imported library instance.
    *   `definition`: `LibraryDefinition` - The definition of the imported library.

*   **`FinalizeLibraryParams`**
    *   `token`: `str` - The token of the library to finalize.

*   **`FinalizeLibraryResult`**
    *   (Empty object)

### Library Definition

*   **`LibraryDefinition`**
    *   `name`: `str` - The name of the library.
    *   `keywords`: `list[KeywordDefinition]` - A list of keywords provided by the library.
    *   `doc`: `str` (optional) - Documentation for the library.
    *   `source`: `str` (optional) - Path to the library source file (if available).

*   **`KeywordDefinition`**
    *   `name`: `str` - The name of the keyword.
    *   `args`: `list[ArgumentDefinition]` - A list of arguments accepted by the keyword.
    *   `doc`: `str` (optional) - Documentation for the keyword.
    *   `tags`: `list[str]` (optional) - Tags associated with the keyword.
    *   `source`: `str` (optional) - Path to the keyword source file (if available).
    *   `lineno`: `int` (optional) - Line number where the keyword is defined.

*   **`ArgumentDefinition`**
    *   `name`: `str` - The name of the argument.
    *   `type`: `str` (optional) - The type of the argument (e.g., type hint).
    *   `default`: `AnyType` (optional) - The default value of the argument, if any.
    *   `required`: `bool` (optional) - Whether the argument is required (default: `true`). If `false`, `default` contains the default value (which may be `null`).
    *   `kind`: `str` (optional) - The kind of the argument. Can be one of:
        *   `"POSITIONAL_ONLY"`
        *   `"POSITIONAL_OR_NAMED"`
        *   `"VAR_POSITIONAL"` (`*args`)
        *   `"NAMED_ONLY"`
        *   `"VAR_NAMED"` (`**kwargs`)
    *   `doc`: `str` (optional) - Documentation for the argument.

### Execution

*   **`RunKeywordParams`**
    *   `library_token`: `str` - The token of the library instance to execute the keyword on.
    *   `name`: `str` - The name of the keyword to execute.
    *   `args`: `list` (optional) - A list of positional arguments to pass to the keyword.
    *   `kwargs`: `dict` (optional) - A dictionary of keyword arguments to pass to the keyword.

*   **`RunKeywordResult`**
    *   `result`: `AnyType` (optional) - The return value of the keyword execution.
    *   `error`: `RunKeywordError` (optional) - Error details if execution failed.

*   **`RunKeywordError`**
    *   `message`: `str` - The error message.
    *   `type`: `str` (optional) - The type/name of the exception (e.g., "ValueError", "AssertionError").
    *   `traceback`: `str` (optional) - The stack trace of the error.
    *   `mode`: `str` (optional) - The failure mode. Can be one of:
        *   `"CONTINUABLE"`
        *   `"FATAL"`
        *   `"SKIP"`

### Logging

*   **`LogParams`**
    *   `message`: `str` - The log message content.
    *   `level`: `str` (optional) - The log level (e.g., "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "CONSOLE", "HTML").
    *   `html`: `bool` (optional) - Whether the message should be treated as HTML.
    *   `console`: `bool` (optional) - Whether the message should be printed to the console.
    *   `timestamp`: `str` (optional) - The timestamp of the log message.

### Termination

*   **`ShutdownParams` / `ShutdownResult`**
    *   (Empty objects) - Request the server to prepare for connection shutdown.

*   **`ExitParams`**
    *   (Empty object) - Sent with the `robot/exit` notification to close the connection.

## Methods

The following constants define the JSON-RPC method names:

| Constant | Method Name | Type | Params | Result |
| :--- | :--- | :--- | :--- | :--- |
| `INITIALIZE_REQUEST` | `robot/initialize` | Request | `InitializeParams` | `InitializeResult` |
| `INITIALIZED_NOTIFICATION` | `robot/initialized` | Notification | `InitializedParams` | - |
| `IMPORT_LIBRARY_REQUEST` | `robot/import_library` | Request | `ImportLibraryParams` | `ImportLibraryResult` |
| `FINALIZE_LIBRARY_REQUEST` | `robot/finalize_library` | Request | `FinalizeLibraryParams` | `FinalizeLibraryResult` |
| `RUN_KEYWORD_REQUEST` | `robot/run_keyword` | Request | `RunKeywordParams` | `RunKeywordResult` |
| `LOG_NOTIFICATION` | `robot/log` | Notification | `LogParams` | - |
| `TRACE_NOTIFICATION` | `robot/trace` | Notification | `LogParams` | - |
| `SHUTDOWN_REQUEST` | `robot/shutdown` | Request | `ShutdownParams` | `ShutdownResult` |
| `EXIT_NOTIFICATION` | `robot/exit` | Notification | `ExitParams` | - |

## Communication Flow

The typical communication lifecycle is as follows:

1.  **Connection**: The client establishes a connection to the server.
2.  **Initialization**:
    *   **Request**: The client sends a `robot/initialize` request.
    *   **Response**: The server responds with `InitializeResult`, exchanging capabilities.
    *   **Notification**: The client sends `robot/initialized` to confirm readiness.
3.  **Library Import**:
    *   **Request**: The client sends `robot/import_library` with the library name and arguments.
    *   **Response**: The server initializes the library and returns `ImportLibraryResult` containing a `token` and the `LibraryDefinition`.
4.  **Execution Loop**:
    *   **Request**: The client sends `robot/run_keyword` with the `library_token`, keyword name, and arguments.
    *   **Execution**: The server executes the keyword on the instance identified by the token.
    *   **Logging**: The server may send `robot/log` notifications during execution.
    *   **Response**: The server returns `RunKeywordResult` (success or error).
5.  **Library Finalization**:
    *   **Request**: The client sends `robot/finalize_library` with the `token` when the library is no longer needed.
    *   **Response**: The server cleans up the library instance.
6.  **Termination**:
    *   **Request**: The client sends `robot/shutdown`.
    *   **Notification**: The client sends `robot/exit` to close the connection.

## Usage

This package is typically not used directly by end users, but serves as a dependency for:

*   `robotframework-jsonrpcremote` (Client)
*   `robotframework-jsonrpcremote-server` (Server)
