@a2ui/web_core 0.8.0 → 0.9.0

package/src/v0_9/schemas/client_capabilities.json

@@ -0,0 +1,97 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://a2ui.org/specification/v0_9/client_capabilities.json",
+    "title": "A2UI Client Capabilities Schema",
+    "description": "A schema for the a2uiClientCapabilities object, which is sent from the client to the server as part of the A2A metadata to describe the client's UI rendering capabilities.",
+    "type": "object",
+    "properties": {
+        "v0.9": {
+            "type": "object",
+            "description": "The capabilities structure for version 0.9 of the A2UI protocol.",
+            "properties": {
+                "supportedCatalogIds": {
+                    "type": "array",
+                    "description": "The URI of each of the component and function catalogs that is supported by the client.",
+                    "items": { "type": "string" }
+                },
+                "inlineCatalogs": {
+                    "type": "array",
+                    "description": "An array of inline catalog definitions, which can contain both components and functions. This should only be provided if the agent declares 'acceptsInlineCatalogs: true' in its capabilities.",
+                    "items": { "$ref": "#/$defs/Catalog" }
+                }
+            },
+            "required": ["supportedCatalogIds"]
+        }
+    },
+    "required": ["v0.9"],
+    "$defs": {
+        "FunctionDefinition": {
+            "type": "object",
+            "description": "Describes a function's interface.",
+            "properties": {
+                "name": {
+                    "type": "string",
+                    "description": "The unique name of the function."
+                },
+                "description": {
+                    "type": "string",
+                    "description": "A human-readable description of what the function does and how to use it."
+                },
+                "parameters": {
+                    "type": "object",
+                    "description": "A JSON Schema describing the expected arguments (args) for this function.",
+                    "$ref": "https://json-schema.org/draft/2020-12/schema"
+                },
+                "returnType": {
+                    "type": "string",
+                    "enum": [
+                        "string",
+                        "number",
+                        "boolean",
+                        "array",
+                        "object",
+                        "any",
+                        "void"
+                    ],
+                    "description": "The type of value this function returns."
+                }
+            },
+            "required": ["name", "parameters", "returnType"],
+            "additionalProperties": false
+        },
+        "Catalog": {
+            "type": "object",
+            "description": "A collection of component and function definitions.",
+            "properties": {
+                "catalogId": {
+                    "type": "string",
+                    "description": "Unique identifier for this catalog."
+                },
+                "components": {
+                    "type": "object",
+                    "description": "Definitions for UI components supported by this catalog.",
+                    "additionalProperties": {
+                        "$ref": "https://json-schema.org/draft/2020-12/schema"
+                    }
+                },
+                "functions": {
+                    "type": "array",
+                    "description": "Definitions for functions supported by this catalog.",
+                    "items": {
+                        "$ref": "#/$defs/FunctionDefinition"
+                    }
+                },
+                "theme": {
+                    "title": "A2UI Theme",
+                    "description": "A schema that defines a catalog of A2UI theme properties. Each key is a theme property name (e.g. 'primaryColor'), and each value is the JSON schema for that property.",
+                    "type": "object",
+                    "additionalProperties": {
+                        "$ref": "https://json-schema.org/draft/2020-12/schema"
+                    }
+                }
+            },
+            "required": ["catalogId"],
+            "additionalProperties": false
+        }
+    }
+}

package/src/v0_9/schemas/client_data_model.json

@@ -0,0 +1,22 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://a2ui.org/specification/v0_9/client_data_model.json",
+    "title": "A2UI Client Data Model Schema",
+    "description": "Schema for attaching the client data model to A2A message metadata. This object should be placed in the `a2uiClientDataModel` field of the metadata.",
+    "type": "object",
+    "properties": {
+        "version": {
+            "const": "v0.9"
+        },
+        "surfaces": {
+            "type": "object",
+            "description": "A map of surface IDs to their current data models.",
+            "additionalProperties": {
+                "type": "object",
+                "description": "The current data model for the surface, as a standard JSON object."
+            }
+        }
+    },
+    "required": ["version", "surfaces"],
+    "additionalProperties": false
+}

package/src/v0_9/schemas/client_to_server.json

@@ -0,0 +1,104 @@
+{
+    "title": "A2UI (Agent to UI) Client-to-Server Event Schema",
+    "description": "Describes a JSON payload for a client-to-server event message.",
+    "type": "object",
+    "minProperties": 2,
+    "maxProperties": 2,
+    "properties": {
+        "version": {
+            "const": "v0.9"
+        },
+        "action": {
+            "type": "object",
+            "description": "Reports a user-initiated action from a component.",
+            "properties": {
+                "name": {
+                    "type": "string",
+                    "description": "The name of the action, taken from the component's action.event.name property."
+                },
+                "surfaceId": {
+                    "type": "string",
+                    "description": "The id of the surface where the event originated."
+                },
+                "sourceComponentId": {
+                    "type": "string",
+                    "description": "The id of the component that triggered the event."
+                },
+                "timestamp": {
+                    "type": "string",
+                    "format": "date-time",
+                    "description": "An ISO 8601 timestamp of when the event occurred."
+                },
+                "context": {
+                    "type": "object",
+                    "description": "A JSON object containing the key-value pairs from the component's action.event.context, after resolving all data bindings.",
+                    "additionalProperties": true
+                }
+            },
+            "required": [
+                "name",
+                "surfaceId",
+                "sourceComponentId",
+                "timestamp",
+                "context"
+            ]
+        },
+        "error": {
+            "description": "Reports a client-side error.",
+            "oneOf": [
+                {
+                    "type": "object",
+                    "title": "Validation Failed Error",
+                    "properties": {
+                        "code": {
+                            "const": "VALIDATION_FAILED"
+                        },
+                        "surfaceId": {
+                            "type": "string",
+                            "description": "The id of the surface where the error occurred."
+                        },
+                        "path": {
+                            "type": "string",
+                            "description": "The JSON pointer to the field that failed validation (e.g. '/components/0/text')."
+                        },
+                        "message": {
+                            "type": "string",
+                            "description": "A short one or two sentence description of why validation failed."
+                        }
+                    },
+                    "required": ["code", "path", "message", "surfaceId"],
+                    "additionalProperties": false
+                },
+                {
+                    "type": "object",
+                    "title": "Generic Error",
+                    "properties": {
+                        "code": {
+                            "not": {
+                                "const": "VALIDATION_FAILED"
+                            }
+                        },
+                        "message": {
+                            "type": "string",
+                            "description": "A short one or two sentence description of why the error occurred."
+                        },
+                        "surfaceId": {
+                            "type": "string",
+                            "description": "The id of the surface where the error occurred."
+                        }
+                    },
+                    "required": ["code", "surfaceId", "message"],
+                    "additionalProperties": true
+                }
+            ]
+        }
+    },
+    "oneOf": [
+        {
+            "required": ["action", "version"]
+        },
+        {
+            "required": ["error", "version"]
+        }
+    ]
+}

package/src/v0_9/schemas/client_to_server_list.json

@@ -0,0 +1,10 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://a2ui.org/specification/v0_9/client_to_server_list.json",
+    "title": "A2UI Client-to-Server Message List",
+    "description": "A list of A2UI Client-to-Server messages.",
+    "type": "array",
+    "items": {
+        "$ref": "client_to_server.json"
+    }
+}

package/src/v0_9/schemas/common_types.json

@@ -0,0 +1,315 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://a2ui.org/specification/v0_9/common_types.json",
+    "title": "A2UI Common Types",
+    "description": "Common type definitions used across A2UI schemas.",
+    "$defs": {
+        "ComponentId": {
+            "type": "string",
+            "description": "The unique identifier for a component, used for both definitions and references within the same surface."
+        },
+        "AccessibilityAttributes": {
+            "type": "object",
+            "description": "Attributes to enhance accessibility when using assistive technologies like screen readers.",
+            "properties": {
+                "label": {
+                    "$ref": "#/$defs/DynamicString",
+                    "description": "A short string, typically 1 to 3 words, used by assistive technologies to convey the purpose or intent of an element. For example, an input field might have an accessible label of 'User ID' or a button might be labeled 'Submit'."
+                },
+                "description": {
+                    "$ref": "#/$defs/DynamicString",
+                    "description": "Additional information provided by assistive technologies about an element such as instructions, format requirements, or result of an action. For example, a mute button might have a label of 'Mute' and a description of 'Silences notifications about this conversation'."
+                }
+            }
+        },
+        "ComponentCommon": {
+            "type": "object",
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/ComponentId"
+                },
+                "accessibility": {
+                    "$ref": "#/$defs/AccessibilityAttributes"
+                }
+            },
+            "required": ["id"]
+        },
+        "ChildList": {
+            "oneOf": [
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/ComponentId"
+                    },
+                    "description": "A static list of child component IDs."
+                },
+                {
+                    "type": "object",
+                    "description": "A template for generating a dynamic list of children from a data model list. The `componentId` is the component to use as a template.",
+                    "properties": {
+                        "componentId": {
+                            "$ref": "#/$defs/ComponentId"
+                        },
+                        "path": {
+                            "type": "string",
+                            "description": "The path to the list of component property objects in the data model."
+                        }
+                    },
+                    "required": ["componentId", "path"],
+                    "additionalProperties": false
+                }
+            ]
+        },
+        "DataBinding": {
+            "type": "object",
+            "properties": {
+                "path": {
+                    "type": "string",
+                    "description": "A JSON Pointer path to a value in the data model."
+                }
+            },
+            "required": ["path"],
+            "additionalProperties": false
+        },
+        "DynamicValue": {
+            "description": "A value that can be a literal, a path, or a function call returning any type.",
+            "oneOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "number"
+                },
+                {
+                    "type": "boolean"
+                },
+                {
+                    "type": "array"
+                },
+                {
+                    "$ref": "#/$defs/DataBinding"
+                },
+                {
+                    "$ref": "#/$defs/FunctionCall"
+                }
+            ]
+        },
+        "DynamicString": {
+            "description": "Represents a string",
+            "oneOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "$ref": "#/$defs/DataBinding"
+                },
+                {
+                    "allOf": [
+                        {
+                            "$ref": "#/$defs/FunctionCall"
+                        },
+                        {
+                            "properties": {
+                                "returnType": {
+                                    "const": "string"
+                                }
+                            }
+                        }
+                    ]
+                }
+            ]
+        },
+        "DynamicNumber": {
+            "description": "Represents a value that can be either a literal number, a path to a number in the data model, or a function call returning a number.",
+            "oneOf": [
+                {
+                    "type": "number"
+                },
+                {
+                    "$ref": "#/$defs/DataBinding"
+                },
+                {
+                    "allOf": [
+                        {
+                            "$ref": "#/$defs/FunctionCall"
+                        },
+                        {
+                            "properties": {
+                                "returnType": {
+                                    "const": "number"
+                                }
+                            }
+                        }
+                    ]
+                }
+            ]
+        },
+        "DynamicBoolean": {
+            "description": "A boolean value that can be a literal, a path, or a function call returning a boolean.",
+            "oneOf": [
+                {
+                    "type": "boolean"
+                },
+                {
+                    "$ref": "#/$defs/DataBinding"
+                },
+                {
+                    "allOf": [
+                        {
+                            "$ref": "#/$defs/FunctionCall"
+                        },
+                        {
+                            "properties": {
+                                "returnType": {
+                                    "const": "boolean"
+                                }
+                            }
+                        }
+                    ]
+                }
+            ]
+        },
+        "DynamicStringList": {
+            "description": "Represents a value that can be either a literal array of strings, a path to a string array in the data model, or a function call returning a string array.",
+            "oneOf": [
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                {
+                    "$ref": "#/$defs/DataBinding"
+                },
+                {
+                    "allOf": [
+                        {
+                            "$ref": "#/$defs/FunctionCall"
+                        },
+                        {
+                            "properties": {
+                                "returnType": {
+                                    "const": "array"
+                                }
+                            }
+                        }
+                    ]
+                }
+            ]
+        },
+        "FunctionCall": {
+            "type": "object",
+            "description": "Invokes a named function on the client.",
+            "properties": {
+                "call": {
+                    "type": "string",
+                    "description": "The name of the function to call."
+                },
+                "args": {
+                    "type": "object",
+                    "description": "Arguments passed to the function.",
+                    "additionalProperties": {
+                        "anyOf": [
+                            {
+                                "$ref": "#/$defs/DynamicValue"
+                            },
+                            {
+                                "type": "object",
+                                "description": "A literal object argument (e.g. configuration)."
+                            }
+                        ]
+                    }
+                },
+                "returnType": {
+                    "type": "string",
+                    "description": "The expected return type of the function call.",
+                    "enum": [
+                        "string",
+                        "number",
+                        "boolean",
+                        "array",
+                        "object",
+                        "any",
+                        "void"
+                    ],
+                    "default": "boolean"
+                }
+            },
+            "required": ["call"],
+            "oneOf": [
+                { "$ref": "catalog.json#/$defs/anyFunction" }
+            ]
+        },
+        "CheckRule": {
+            "type": "object",
+            "description": "A single validation rule applied to an input component.",
+            "properties": {
+                "condition": {
+                    "$ref": "#/$defs/DynamicBoolean"
+                },
+                "message": {
+                    "type": "string",
+                    "description": "The error message to display if the check fails."
+                }
+            },
+            "required": ["condition", "message"],
+            "additionalProperties": false
+        },
+        "Checkable": {
+            "description": "Properties for components that support client-side checks.",
+            "type": "object",
+            "properties": {
+                "checks": {
+                    "type": "array",
+                    "description": "A list of checks to perform. These are function calls that must return a boolean indicating validity.",
+                    "items": {
+                        "$ref": "#/$defs/CheckRule"
+                    }
+                }
+            }
+        },
+        "Action": {
+            "description": "Defines an interaction handler that can either trigger a server-side event or execute a local client-side function.",
+            "oneOf": [
+                {
+                    "type": "object",
+                    "description": "Triggers a server-side event.",
+                    "properties": {
+                        "event": {
+                            "type": "object",
+                            "description": "The event to dispatch to the server.",
+                            "properties": {
+                                "name": {
+                                    "type": "string",
+                                    "description": "The name of the action to be dispatched to the server."
+                                },
+                                "context": {
+                                    "type": "object",
+                                    "description": "A JSON object containing the key-value pairs for the action context. Values can be literals or paths. Use literal values unless the value must be dynamically bound to the data model. Do NOT use paths for static IDs.",
+                                    "additionalProperties": {
+                                        "$ref": "#/$defs/DynamicValue"
+                                    }
+                                }
+                            },
+                            "required": ["name"],
+                            "additionalProperties": false
+                        }
+                    },
+                    "required": ["event"],
+                    "additionalProperties": false
+                },
+                {
+                    "type": "object",
+                    "description": "Executes a local client-side function.",
+                    "properties": {
+                        "functionCall": {
+                            "$ref": "#/$defs/FunctionCall"
+                        }
+                    },
+                    "required": ["functionCall"],
+                    "additionalProperties": false
+                }
+            ]
+        }
+    }
+}

package/src/v0_9/schemas/sample.json

@@ -0,0 +1,22 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://a2ui.org/specification/v0_9/sample.json",
+    "title": "A2UI Catalog Sample",
+    "description": "A sample demonstrating A2UI components and messages.",
+    "type": "object",
+    "required": ["name", "description", "messages"],
+    "properties": {
+        "name": {
+            "type": "string",
+            "description": "The display name of the sample."
+        },
+        "description": {
+            "type": "string",
+            "description": "A short description of what the sample demonstrates."
+        },
+        "messages": {
+            "$ref": "server_to_client_list.json",
+            "description": "The ordered list of A2UI messages to be processed by the client."
+        }
+    }
+}

package/src/v0_9/schemas/server_capabilities.json

@@ -0,0 +1,26 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://a2ui.org/specification/v0_9/server_capabilities.json",
+    "title": "A2UI Server Capabilities Schema",
+    "description": "A schema for the server capabilities object, which is used by an A2UI server (or Agent) to advertise its supported UI features to clients. This can be embedded in an Agent Card for A2A or used in other transport protocols like MCP.",
+    "type": "object",
+    "properties": {
+        "v0.9": {
+            "type": "object",
+            "description": "The server capabilities structure for version 0.9 of the A2UI protocol.",
+            "properties": {
+                "supportedCatalogIds": {
+                    "type": "array",
+                    "description": "An array of strings, where each string is an ID identifying a Catalog Definition Schema that the server can generate. This is not necessarily a resolvable URI.",
+                    "items": { "type": "string" }
+                },
+                "acceptsInlineCatalogs": {
+                    "type": "boolean",
+                    "description": "A boolean indicating if the server can accept an 'inlineCatalogs' array in the client's a2uiClientCapabilities. If omitted, this defaults to false.",
+                    "default": false
+                }
+            }
+        }
+    },
+    "required": ["v0.9"]
+}