Skip to content

feat(swift): add A2UICore error types, JSONValue path extensions, and message models#1999

Open
pinieb wants to merge 19 commits into
a2ui-project:mainfrom
pinieb:swift-3
Open

feat(swift): add A2UICore error types, JSONValue path extensions, and message models#1999
pinieb wants to merge 19 commits into
a2ui-project:mainfrom
pinieb:swift-3

Conversation

@pinieb

@pinieb pinieb commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator

Description

Ports the foundational A2UICore types from the prototype: error types,
JSONValue path-based subscripting, and all server/client message models.

Changes

  • Add 4 error types: ClientServerError, GenericError,
    ValidationFailedError, LocalFunctionError (now Sendable)
  • Add JSONValue+Path extensions with type-safe accessors and JSON
    Pointer get/set subscripting, adapted for the fork's
    OrderedDictionary-based JSONValue (including .integer case handling)
  • Add Resolved protocol and ResolvedAction model with identity-based
    equality
  • Add 6 message types: EnvelopeMessage, CreateSurfaceMessage,
    DeleteSurfaceMessage, UpdateComponentsMessage, UpdateDataModelMessage,
    ClientToServerMessage (with v0.9/v0.9.1 version validation)
  • Add OrderedJSON and JSONSchema product dependencies to A2UICore target
  • Add 50 tests covering type accessors, path operations, message
    decoding/encoding round-trips, and error cases
  • Remove placeholder A2UICore.swift stub and placeholder test

Verification

  • swift build passes (all targets)
  • swift test passes (84 tests in 5 suites)

pinieb and others added 11 commits July 8, 2026 11:37
…ma dependency

Replaces the custom JSONSchema target with a multi-target Swift package
structure that uses the swift-json-schema fork (v0.13.1) as an external
dependency. This is the foundation for porting the A2UI v0.9.1 protocol
implementation from prototype to production quality.

Changes:
- Remove custom JSONSchema target (JSONValue.swift + tests)
- Add swift-json-schema dependency (from: "0.13.1") to Package.swift
- Bump swift-tools-version to 6.1 and add macOS 13 to platforms
- Define 4 production targets: A2UIJSON, A2UICore, A2UISwiftUI, A2UISampleClient
- Define 3 test targets with placeholder tests
- Create stub source files for each target
- Update AGENTS.md to document new target architecture
- Update .gitignore for Swift Package Manager artifacts

Verification:
- `swift package resolve` resolves swift-json-schema at 0.13.1
- `swift build` compiles all 7 targets
- `swift test --enable-swift-testing` passes (3 placeholder tests)
…chema

Implements all 14 A2UI v0.9.1 common type JSON Schema definitions using
the swift-json-schema fork. Schemas are defined as a raw JSON document
matching the specification's common_types.json exactly, and registered
into Context via the remoteSchema parameter for $ref resolution.

Changes:
- Define complete common types document in A2UICommonSchema (all 14
  defs: ComponentId, AccessibilityAttributes, ComponentCommon, ChildList,
  DataBinding, DynamicValue, DynamicString, DynamicNumber, DynamicBoolean,
  DynamicStringList, FunctionCall, CheckRule, Checkable, Action)
- Add A2UISchemaRegistry helper to create a Context pre-populated with
  A2UI schemas
- Add 31 tests covering URI helpers, document structure, schema registry,
  validation of all schema types (positive and negative cases), and
  cross-reference resolution (including recursive Action → FunctionCall
  → DynamicValue chains)
- Remove placeholder A2UIJSONTests (superseded by comprehensive tests)

Design notes:
- Raw JSON string approach used instead of JSONValue dictionary literals
  to avoid Swift type-checker issues with deeply nested expressions
- FunctionCall's catalog.json oneOf reference omitted; catalog-level
  validation handled at runtime by ComponentCatalog
- Context.remoteSchemaStorage is internal in the fork, so schemas are
  registered via the Context(remoteSchema:) initializer

Verification:
- swift build passes (all targets)
- swift test passes (34 tests in 3 suites, 0.017s)
… message models

Ports the foundational A2UICore types from the prototype: error types,
JSONValue path-based subscripting, and all server/client message models.

Changes:
- Add 4 error types: ClientServerError, GenericError,
  ValidationFailedError, LocalFunctionError (now Sendable)
- Add JSONValue+Path extensions with type-safe accessors and JSON
  Pointer get/set subscripting, adapted for the fork's
  OrderedDictionary-based JSONValue (including .integer case handling)
- Add Resolved protocol and ResolvedAction model with identity-based
  equality
- Add 6 message types: EnvelopeMessage, CreateSurfaceMessage,
  DeleteSurfaceMessage, UpdateComponentsMessage, UpdateDataModelMessage,
  ClientToServerMessage (with v0.9/v0.9.1 version validation)
- Add OrderedJSON and JSONSchema product dependencies to A2UICore target
- Add 50 tests covering type accessors, path operations, message
  decoding/encoding round-trips, and error cases
- Remove placeholder A2UICore.swift stub and placeholder test

Verification:
- swift build passes (all targets)
- swift test passes (84 tests in 5 suites)
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Pete Biencourt <piebie@google.com>

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request implements core A2UI models, messages, error types, and schema definitions in Swift, along with path-based JSON utility extensions and comprehensive unit tests. The feedback highlights a potential runtime crash in JSONValue+Path.swift when converting large Double values to Int without bounds checking, and notes that parsePath is not fully RFC 6901 (JSON Pointer) compliant. Additionally, it is recommended to avoid using try? inside ClientServerError's decoding initializer to prevent swallowing decoding errors.

Comment thread swift/core/Sources/A2UICore/Extensions/JSONValue+Path.swift
Comment thread swift/core/Sources/A2UICore/Extensions/JSONValue+Path.swift
Comment thread swift/core/Sources/A2UICore/Errors/ClientServerError.swift
pinieb and others added 4 commits July 15, 2026 10:53
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Pete Biencourt <piebie@google.com>
@pinieb
pinieb marked this pull request as ready for review July 15, 2026 15:35
@pinieb
pinieb requested a review from jacobsimionato July 16, 2026 20:38

@jacobsimionato jacobsimionato left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feedback on Swift Core implementation inconsistencies compared to the blueprint and web_core reference implementation.

Comment thread swift/core/Sources/A2UICore/Messages/ClientToServerMessage.swift Outdated
Comment thread swift/core/Sources/A2UICore/Messages/EnvelopeMessage.swift Outdated
Comment thread swift/core/Sources/A2UICore/Extensions/JSONValue+Path.swift Outdated
Comment thread swift/core/Sources/A2UICore/Extensions/JSONValue+Path.swift Outdated
Comment thread swift/core/Sources/A2UICore/Extensions/JSONValue+Path.swift Outdated
Comment thread swift/core/Sources/A2UICore/Messages/ServerToClientMessage.swift
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants