Types of PlaceholderProps['fields'] incorrect

[st3phan]

Describe the Bug

When using the withPlaceholder HOC I'm extending the props type of the wrapped component with PlaceholderComponentProps.

type ComponentProps = PlaceholderComponentProps & {
  fields: ComponentRendering["fields"];
  items: ReactNode;
};

const Component = () => {
  // ...
};

export default withPlaceholder("items")(Component);

But then TypeScript complains about the fields type being incompatible.

The current type for the fields property in the PlaceholderComponentProps interface:

export interface PlaceholderProps {
  ...
  fields?: {
    [name: string]: Field | Item[];
  };
 ...
}

The type does not match the ComponentFields interface:

export interface ComponentFields {
    [name: string]: Field | Item | Item[];
}

To Reproduce

Extend rendering component props type with PlaceholderComponentProps.

Expected Behavior

I believe the type for the fields property in the PlaceholderProps should be:

export interface PlaceholderProps {
  ...
  fields?: {
    [name: string]: Field | Item | Item[];
  };
}

This way they match the ComponentFields interface.

Possible Fix

No response

Provide environment information

• JSS Version: 22.5