[types] Fix variant props callback type to spread ownerState

[siriwatknp]

Root cause

The pattern below is logically correct based on the implementation but failed on type check.

const DateTimePickerToolbarTimeContainer = styled('div', {
  name: 'MuiDateTimePickerToolbar',
  slot: 'TimeContainer',
  shouldForwardProp: (prop) => shouldForwardProp(prop) && prop !== 'toolbarVariant',
})<{ ownerState: { pickerOrientation: 'landscape' | 'portrait'; toolbarVariant: PickerVariant }>({
  display: 'flex',
  flexDirection: 'row',
  variants: [
    {
      // ❌ error
      props: ({ pickerOrientation, toolbarVariant }) =>
        pickerOrientation === 'landscape' && toolbarVariant !== 'desktop',
      style: {
        flexDirection: 'column',
      },
    },
  ],
});

This PR fixes the issue above. A test (using MUI X pickers code) is added to ensure that it fixes the issue.

• I have followed (at least) the PR section of the contributing guide.

[mui-bot]

Netlify deploy preview

https://deploy-preview-46187--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 57b2f58

[LukasTy]

I've tried using the packages from this PR, and here are a couple of issues that are still present:

1. The inferred prop type is wrapped in Partial, even though in the defined ownerState it is specified as non-nullable.
   I.e.
2. We have a similar effect on https://github.com/mui/mui-x/blob/4da49621a437a98e9e6433dfd3ba3be50f7d252e/docs/data/date-pickers/date-range-calendar/CustomDateRangePickerDay.tsx#L13-L18 where props are defined, but the inferred variants props become type | undefined, which causes TS issues. 🙈

Is there a reason for props being Partial instead of as defined in types? 🤔

[siriwatknp]

Is there a reason for props being Partial instead of as defined in types? 🤔

Good catch. It should not be a Partial for callback signature. I have removed it in 1301df1.

A test added to ensure it works for the PickerPopperPaper.

[LukasTy]

I've tested the changes on mui/mui-x#17802.
Thanks for the improvements! 💙 💯
They helped us uncover some suboptimal ownerState type definitions as well as one actual bug! 🎉 🙏

[LukasTy]

Looks like there might be RTL issues in the new release.
Are they known? 🤔
https://app.circleci.com/pipelines/github/mui/mui-x/92274/workflows/89704c76-f3ce-4cdc-a098-4ffc8aac12d7/jobs/539355?invite=true#step-107-130635_68