[Feature]: Move form.properties.buttons.default to meta.customButtons

[Georgi2704]

Contact Details

No response

What should we build?

The meta property should be better suited for the buttons properties as currently fields such as hasNext and hasPrevious sit there.

Relevant pseudo code

[Mark90]

@Georgi2704
Could you elaborate what the resulting schema should look like, and what the purpose of this ticket is?

The properties next and previous in form.properties.buttons.default are not the same as hasNext and hasPrevious.

[Georgi2704]

        "meta": {
            "hasNext": true,
            "next": { "color": "accent", "text": "Translate to English"}
        }

Currently I use hardcoded pydantic field in pydantic-forms to retrieve the buttons:

ReactHookForm.tsx:
const buttons = defaultValues?.buttons ?? {};

It means that buttons field is part of the actual form fields but its not. I also filter out the buttons field in the surfPydanticFormComponentMatcherExtender

[Mark90]

We also discussed this in person and I see the point now.

I agree it's better to change it, but we'll need to consider backwards compatibility.

We will do it in 3 phases:

1. In the API add meta.customButtons with same content (minus the .default?) as form.properties.buttons. We'll consider form.properties.buttons a "deprecated" property but we will not remove it yet. -> in this ticket
2. Change the UI to start using meta.customButtons and remove any usage of form.properties.buttons -> in Change all usages of form.properties.buttons to meta.customButtons orchestrator-ui-library#2420
3. Remove form.properties.buttons from the API -> in [Maintenance]: Remove form.properties.buttons #52