[PAG-2505] Update generatePreviewTypes to add translate function

[MendixBart]

Checklist

• Contains unit tests ✅
• Contains breaking changes ❌
• Compatible with: MX 9️⃣
• Did you update version and changelog? ✅ ❌
• PR title properly formatted ([XX-000]: description)? ✅

This PR contains

• [ x ] Bug fix
• [ x ] Feature
• Refactor
• Documentation
• Other (describe)

What is the purpose of this PR?

PAG added the translate function to the preview props, this adds the appropriate typing. We also noticed that the type for the mode (design, structure, x-ray) was made nullable on accident.

Relevant changes

Generated types for the preview props.

What should be covered while testing?

The updated unit tests should be sufficient.

[weirdwater]

Hi @MendixBart, you mention that the optionality of renderMode was a mistake. Do I understand correctly that it was always passed to the widget preview component? If not, as of what version of Studio Pro does this happen?

We just merged a feature that conflicts with your change in the Changelog. Can you rebase your branch?

[MendixBart]

Hey @weirdwater, I've resolved the conflict in the readme. But let me know if this way around isn't ideal.

And you're correct, since the introduction of the renderMode, we always passed a valid string value (not null, undefined or an empty string.)

[weirdwater]

Hi,

The changelog change looks good to me 👍🏻

Do I understand correctly that the renderMode prop was passed to preview widgets prior to 10.11? This commit states that making it optional makes the widget backwards compatible. Wouldn't we be breaking the preview for widgets that expect the prop to be present that are then used in older versions of SP (realistically 9.24 and 10.6)?

[MendixBart]

Ah, no the prop wasn't passed before that, so you're correct. Although the same will be true for the translate function that we're introducing in 10.18. Would it make sense to make sure both of them are optional?

[weirdwater]

We discussed it in the team and came to the consensus that if you are using the pluggable-widgets-tools at version 10.18 the expectation should be that resulting widgets are compatible with SP 10.18+

So we approve the properties being non-optional.