Skip to content

8.4 Upgrade Guide

This guide describes the breaking change to account for when upgrading @orchestrator-ui/orchestrator-ui-components from 8.3 to 8.4.

Agent feature removed

UI Library 8.4 removes the experimental Agent page feature which is being moved to a different client.

The following exported Agent components were removed:

  • WfoAgent
  • WfoAgentTable
  • WfoAgentLineChart and WfoAgentPieChart
  • WfoAgentVisualization
  • WfoPlanProgress
  • WfoQueryArtifact

The supporting Agent integrations were also removed, including:

  • useAgentPlanEvents and useAgentAvailability;
  • useGetAgentQueryResultsQuery and the internal useLazyGetAgentExportQuery query hook;
  • the Agent availability request to /agent/;
  • the agent feature type in WfoAvailabilityCheck and WfoBackendUnavailable.

The UI Library no longer depends on @ag-ui/client, @copilotkit/react-core, @copilotkit/react-ui, @copilotkit/runtime, or @elastic/charts. Do not rely on these packages being installed transitively by the UI Library after upgrading.

What you need to do

If your application follows example-orchestrator-ui or has its own Agent integration:

  1. Remove the Agent page and its navigation item.
  2. Remove the CopilotKit API route that proxies requests to the Agent backend.
  3. Remove WfoAgent usage.
  4. Remove @copilotkit namespaced dependencies that are no longer used elsewhere in your application.
  5. Remove imports of the components, hooks, and query hooks listed above.
  6. If you use WfoAvailabilityCheck or WfoBackendUnavailable, stop passing featureType="agent"; these components now support only featureType="search".

See example-orchestrator-ui PR #102 for a reference migration that removes pages/agent.tsx, pages/api/copilotkit.ts, the Agent navigation entry, and the unused CopilotKit packages.

References