Property 'options' does not exist on <SelectField /> (uniforms-semantic)

[kestarumper]

Type '{ name: string; options: { label: string; value: string; }[]; onChange: (repositoryId: string) => void; }' is not assignable to type 'IntrinsicAttributes & { label?: ReactNode; name: string; placeholder?: string | boolean | null | undefined; } & Pick<Partial<GuaranteedProps<string | string[] | undefined>>, "id" | ... 9 more ... | "showInlineError"> & Pick<...> & { ...; }'.
  Property 'options' does not exist on type 'IntrinsicAttributes & { label?: ReactNode; name: string; placeholder?: string | boolean | null | undefined; } & Pick<Partial<GuaranteedProps<string | string[] | undefined>>, "id" | ... 9 more ... | "showInlineError"> & Pick<...> & { ...; }'.

Versions:

• uniforms 3.0.0-rc3
• uniforms-semantic 3.0.0-rc3

Description:
Property options do not exist but are used to calculate allowedValues. The only problem is that they're missing in the typescript definitions.

[radekmie]

As this topic arose once again (internally), I thought it'd be great to describe the problem (I'm sure I already did that but there's no comment here).

All props received by a field created with connectField (or directly using useField) are extended with the ones from a bridge method called getProps. All of the standard bridges understand the options prop (e.g., JSONSchemaBridge#getProps code), but a new or custom bridge may not. Technically speaking, we'd need to have a way, to extend props (their types) from the bridge.

[radekmie]

We'll leave it for now, as there's no easy way of handling it.

[radekmie]

Instead of using allowedValues as defined in #862, we'll use options prop instead. And it won't be resolved on the bridge level, but on the field instead.

[kestarumper]

We've discussed this, and there will be changes on the bridge level, as @radekmie mentioned above.

Breaking changes

We'll be removing allowedValues and transform properties. Fields will only use options property.

The common API

Bridges will use

type Option = {
    disabled?: boolean;
    key?: string
    label?: string;
    value: unknown;
}

(similar as described in #862)

Fields

Fields should also follow this format but can also extend it for custom use cases.
For example, the field can assume that the value: unknown is of type value: string in SemanticUI but will be different value: string | number in AntD. One might also extend the type and add other properties as well (field level).

Migrating

• Usage of allowedValues and transform should be replaced with options
• SimpleSchema allowed you to provide a function for the options property - you will be able to retain this by converting that function to a getter using get keyword.

[kestarumper]

Closes #1120