Skip to content

10.0 Upgrade Guide

This guide describes the changes to account for when upgrading @orchestrator-ui/orchestrator-ui-components from 9.x to 10.0.

Compatibility with Orchestrator Core

Version 10.0 does not introduce a new minimum Orchestrator Core version. The requirement from 9.0.1 (Core 5.5.0) still applies. See the Frontend / Backend Compatibility guide for the full table.

Summary

Next.js 15 to 16

The peer dependency on next now requires ^16.0.0. Update your application and follow the Next.js 16 upgrade guide for changes that affect your own pages, configuration and build. The UI Library itself needed no code changes for Next.js 16.

Pydantic forms 3.x to 4.x

Pydantic forms 4 changes the shape of the form payload that is submitted to the backend. All properties in a form definition are now submitted, including properties with no default or null as a default. Previously these properties were silently dropped from the payload.

Check your backend forms for fields that relied on being absent from the payload. A field that was previously missing now arrives as null.

Restoring the previous behaviour

If you cannot update your backend forms yet, set the new optional pydanticFormsLegacyNullHandling property on OrchestratorConfig to true. It defaults to false and is passed to pydantic forms as its legacyNullHandling toggle, which restores the 3.x payload.

export const getInitialOrchestratorConfig = (): OrchestratorConfig => {
    // ...
    return {
        // ...existing config
        pydanticFormsLegacyNullHandling: true,
    };
};

If your application imports pydantic-forms directly, update it to 4.x and check its changelog for other changes that affect custom form integrations.

What you need to do

  1. Update @elastic/eui to ^122.1.0 and next to ^16.0.0 in your application.
  2. Update pydantic-forms to ^4.4.0 if your application depends on it directly.
  3. Decide whether your backend forms can handle the new payload shape, or set pydanticFormsLegacyNullHandling until they can.

References