Skip to content

feat: types custom component props #11894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions packages/payload/src/admin/fields/Array.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,11 @@ export type ArrayFieldServerComponent = FieldServerComponent<
ArrayFieldBaseServerProps
>

export type ArrayFieldClientComponent = FieldClientComponent<
ArrayFieldClientWithoutType,
ArrayFieldBaseClientProps
>
export type ArrayFieldClientComponent<T extends Record<string, unknown> = {}> =
FieldClientComponent<ArrayFieldClientWithoutType, ArrayFieldBaseClientProps>

export type ArrayFieldLabelServerComponent = FieldLabelServerComponent<
ArrayField,
ArrayFieldClientWithoutType
>
export type ArrayFieldLabelServerComponent<T extends Record<string, unknown> = {}> =
FieldLabelServerComponent<ArrayField, ArrayFieldClientWithoutType>

export type ArrayFieldLabelClientComponent = FieldLabelClientComponent<ArrayFieldClientWithoutType>

Expand Down
13 changes: 4 additions & 9 deletions packages/payload/src/admin/fields/Blocks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,11 @@ export type BlocksFieldClientProps = BlocksFieldBaseClientProps &
export type BlocksFieldServerProps = BlocksFieldBaseServerProps &
ServerFieldBase<BlocksField, BlocksFieldClientWithoutType>

export type BlocksFieldServerComponent = FieldServerComponent<
BlocksField,
BlocksFieldClientWithoutType,
BlocksFieldBaseServerProps
>
export type BlocksFieldServerComponent<T extends Record<string, unknown> = {}> =
FieldServerComponent<BlocksField, BlocksFieldClientWithoutType, BlocksFieldBaseServerProps & T>

export type BlocksFieldClientComponent = FieldClientComponent<
BlocksFieldClientWithoutType,
BlocksFieldBaseClientProps
>
export type BlocksFieldClientComponent<T extends Record<string, unknown> = {}> =
FieldClientComponent<BlocksFieldClientWithoutType, BlocksFieldBaseClientProps & T>

export type BlocksFieldLabelServerComponent = FieldLabelServerComponent<
BlocksField,
Expand Down
19 changes: 9 additions & 10 deletions packages/payload/src/admin/fields/Checkbox.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,15 @@ export type CheckboxFieldClientProps = CheckboxFieldBaseClientProps &
export type CheckboxFieldServerProps = CheckboxFieldBaseServerProps &
ServerFieldBase<CheckboxField, CheckboxFieldClientWithoutType>

export type CheckboxFieldServerComponent = FieldServerComponent<
CheckboxField,
CheckboxFieldClientWithoutType,
CheckboxFieldBaseServerProps
>

export type CheckboxFieldClientComponent = FieldClientComponent<
CheckboxFieldClientWithoutType,
CheckboxFieldBaseClientProps
>
export type CheckboxFieldServerComponent<T extends Record<string, unknown> = {}> =
FieldServerComponent<
CheckboxField,
CheckboxFieldClientWithoutType,
CheckboxFieldBaseServerProps & T
>

export type CheckboxFieldClientComponent<T extends Record<string, unknown> = {}> =
FieldClientComponent<CheckboxFieldClientWithoutType, CheckboxFieldBaseClientProps & T>

export type CheckboxFieldLabelServerComponent = FieldLabelServerComponent<
CheckboxField,
Expand Down
8 changes: 4 additions & 4 deletions packages/payload/src/admin/fields/Code.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@ export type CodeFieldClientProps = ClientFieldBase<CodeFieldClientWithoutType> &
export type CodeFieldServerProps = CodeFieldBaseServerProps &
ServerFieldBase<CodeField, CodeFieldClientWithoutType>

export type CodeFieldServerComponent = FieldServerComponent<
export type CodeFieldServerComponent<T extends Record<string, unknown> = {}> = FieldServerComponent<
CodeField,
CodeFieldClientWithoutType,
CodeFieldBaseServerProps
CodeFieldBaseServerProps & T
>

export type CodeFieldClientComponent = FieldClientComponent<
export type CodeFieldClientComponent<T extends Record<string, unknown> = {}> = FieldClientComponent<
CodeFieldClientWithoutType,
CodeFieldBaseClientProps
CodeFieldBaseClientProps & T
>

export type CodeFieldLabelServerComponent = FieldLabelServerComponent<
Expand Down
12 changes: 4 additions & 8 deletions packages/payload/src/admin/fields/Collapsible.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,11 @@ export type CollapsibleFieldServerProps = ServerFieldBase<
CollapsibleFieldClientWithoutType
>

export type CollapsibleFieldServerComponent = FieldServerComponent<
CollapsibleField,
CollapsibleFieldClientWithoutType
>
export type CollapsibleFieldServerComponent<T extends Record<string, unknown> = {}> =
FieldServerComponent<CollapsibleField, CollapsibleFieldClientWithoutType & T>

export type CollapsibleFieldClientComponent = FieldClientComponent<
CollapsibleFieldClientWithoutType,
CollapsibleFieldBaseClientProps
>
export type CollapsibleFieldClientComponent<T extends Record<string, unknown> = {}> =
FieldClientComponent<CollapsibleFieldClientWithoutType, CollapsibleFieldBaseClientProps & T>

export type CollapsibleFieldLabelServerComponent = FieldLabelServerComponent<
CollapsibleField,
Expand Down
8 changes: 4 additions & 4 deletions packages/payload/src/admin/fields/Date.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ export type DateFieldClientProps = ClientFieldBase<DateFieldClientWithoutType> &
export type DateFieldServerProps = DateFieldBaseServerProps &
ServerFieldBase<DateField, DateFieldClientWithoutType>

export type DateFieldServerComponent = FieldServerComponent<
export type DateFieldServerComponent<T extends Record<string, unknown> = {}> = FieldServerComponent<
DateField,
DateFieldClientWithoutType,
DateFieldBaseServerProps
DateFieldBaseServerProps & T
>

export type DateFieldClientComponent = FieldClientComponent<
export type DateFieldClientComponent<T extends Record<string, unknown> = {}> = FieldClientComponent<
DateFieldClientWithoutType,
DateFieldBaseClientProps
DateFieldBaseClientProps & T
>

export type DateFieldLabelServerComponent = FieldLabelServerComponent<
Expand Down
13 changes: 4 additions & 9 deletions packages/payload/src/admin/fields/Email.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,11 @@ export type EmailFieldClientProps = ClientFieldBase<EmailFieldClientWithoutType>
export type EmailFieldServerProps = EmailFieldBaseServerProps &
ServerFieldBase<EmailField, EmailFieldClientWithoutType>

export type EmailFieldServerComponent = FieldServerComponent<
EmailField,
EmailFieldClientWithoutType,
EmailFieldBaseServerProps
>
export type EmailFieldServerComponent<T extends Record<string, unknown> = {}> =
FieldServerComponent<EmailField, EmailFieldClientWithoutType, EmailFieldBaseServerProps & T>

export type EmailFieldClientComponent = FieldClientComponent<
EmailFieldClientWithoutType,
EmailFieldBaseClientProps
>
export type EmailFieldClientComponent<T extends Record<string, unknown> = {}> =
FieldClientComponent<EmailFieldClientWithoutType, EmailFieldBaseClientProps & T>

export type EmailFieldLabelServerComponent = FieldLabelServerComponent<
EmailField,
Expand Down
13 changes: 4 additions & 9 deletions packages/payload/src/admin/fields/Group.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,11 @@ export type GroupFieldClientProps = ClientFieldBase<GroupFieldClientWithoutType>
export type GroupFieldServerProps = GroupFieldBaseServerProps &
ServerFieldBase<GroupField, GroupFieldClientWithoutType>

export type GroupFieldServerComponent = FieldServerComponent<
GroupField,
GroupFieldClientWithoutType,
GroupFieldBaseServerProps
>
export type GroupFieldServerComponent<T extends Record<string, unknown> = {}> =
FieldServerComponent<GroupField, GroupFieldClientWithoutType, GroupFieldBaseServerProps & T>

export type GroupFieldClientComponent = FieldClientComponent<
GroupFieldClientWithoutType,
GroupFieldBaseClientProps
>
export type GroupFieldClientComponent<T extends Record<string, unknown> = {}> =
FieldClientComponent<GroupFieldClientWithoutType, GroupFieldBaseClientProps & T>

export type GroupFieldLabelServerComponent = FieldLabelServerComponent<
GroupField,
Expand Down
8 changes: 4 additions & 4 deletions packages/payload/src/admin/fields/JSON.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ export type JSONFieldClientProps = ClientFieldBase<JSONFieldClientWithoutType> &
export type JSONFieldServerProps = JSONFieldBaseServerProps &
ServerFieldBase<JSONField, JSONFieldClientWithoutType>

export type JSONFieldServerComponent = FieldServerComponent<
export type JSONFieldServerComponent<T extends Record<string, unknown> = {}> = FieldServerComponent<
JSONField,
JSONFieldClientWithoutType,
JSONFieldBaseServerProps
JSONFieldBaseServerProps & T
>

export type JSONFieldClientComponent = FieldClientComponent<
export type JSONFieldClientComponent<T extends Record<string, unknown> = {}> = FieldClientComponent<
JSONFieldClientWithoutType,
JSONFieldBaseClientProps
JSONFieldBaseClientProps & T
>

export type JSONFieldLabelServerComponent = FieldLabelServerComponent<
Expand Down
8 changes: 4 additions & 4 deletions packages/payload/src/admin/fields/Join.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ export type JoinFieldClientProps = ClientFieldBase<JoinFieldClientWithoutType> &

export type JoinFieldServerProps = JoinFieldBaseServerProps & ServerFieldBase<JoinField>

export type JoinFieldServerComponent = FieldServerComponent<
export type JoinFieldServerComponent<T extends Record<string, unknown> = {}> = FieldServerComponent<
JoinField,
JoinFieldClientWithoutType,
JoinFieldBaseServerProps
JoinFieldBaseServerProps & T
>

export type JoinFieldClientComponent = FieldClientComponent<
export type JoinFieldClientComponent<T extends Record<string, unknown> = {}> = FieldClientComponent<
JoinFieldClientWithoutType,
JoinFieldBaseClientProps
JoinFieldBaseClientProps & T
>

export type JoinFieldLabelServerComponent = FieldLabelServerComponent<JoinField>
Expand Down
13 changes: 4 additions & 9 deletions packages/payload/src/admin/fields/Number.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,11 @@ export type NumberFieldClientProps = ClientFieldBase<NumberFieldClientWithoutTyp
export type NumberFieldServerProps = NumberFieldBaseServerProps &
ServerFieldBase<NumberField, NumberFieldClientWithoutType>

export type NumberFieldServerComponent = FieldServerComponent<
NumberField,
NumberFieldClientWithoutType,
NumberFieldBaseServerProps
>
export type NumberFieldServerComponent<T extends Record<string, unknown> = {}> =
FieldServerComponent<NumberField, NumberFieldClientWithoutType, NumberFieldBaseServerProps & T>

export type NumberFieldClientComponent = FieldClientComponent<
NumberFieldClientWithoutType,
NumberFieldBaseClientProps
>
export type NumberFieldClientComponent<T extends Record<string, unknown> = {}> =
FieldClientComponent<NumberFieldClientWithoutType, NumberFieldBaseClientProps & T>

export type NumberFieldLabelServerComponent = FieldLabelServerComponent<
NumberField,
Expand Down
13 changes: 4 additions & 9 deletions packages/payload/src/admin/fields/Point.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,11 @@ export type PointFieldClientProps = ClientFieldBase<PointFieldClientWithoutType>
export type PointFieldServerProps = PointFieldBaseServerProps &
ServerFieldBase<PointField, PointFieldClientWithoutType>

export type PointFieldServerComponent = FieldServerComponent<
PointField,
PointFieldClientWithoutType,
PointFieldBaseServerProps
>
export type PointFieldServerComponent<T extends Record<string, unknown> = {}> =
FieldServerComponent<PointField, PointFieldClientWithoutType, PointFieldBaseServerProps & T>

export type PointFieldClientComponent = FieldClientComponent<
PointFieldClientWithoutType,
PointFieldBaseClientProps
>
export type PointFieldClientComponent<T extends Record<string, unknown> = {}> =
FieldClientComponent<PointFieldClientWithoutType, PointFieldBaseClientProps & T>

export type PointFieldLabelServerComponent = FieldLabelServerComponent<
PointField,
Expand Down
13 changes: 4 additions & 9 deletions packages/payload/src/admin/fields/Radio.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,11 @@ export type RadioFieldClientProps = ClientFieldBase<RadioFieldClientWithoutType>
export type RadioFieldServerProps = RadioFieldBaseServerProps &
ServerFieldBase<RadioField, RadioFieldClientWithoutType>

export type RadioFieldServerComponent = FieldServerComponent<
RadioField,
RadioFieldClientWithoutType,
RadioFieldBaseServerProps
>
export type RadioFieldServerComponent<T extends Record<string, unknown> = {}> =
FieldServerComponent<RadioField, RadioFieldClientWithoutType, RadioFieldBaseServerProps & T>

export type RadioFieldClientComponent = FieldClientComponent<
RadioFieldClientWithoutType,
RadioFieldBaseClientProps
>
export type RadioFieldClientComponent<T extends Record<string, unknown> = {}> =
FieldClientComponent<RadioFieldClientWithoutType, RadioFieldBaseClientProps & T>

type OnChange<T = string> = (value: T) => void

Expand Down
19 changes: 9 additions & 10 deletions packages/payload/src/admin/fields/Relationship.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,15 @@ export type RelationshipFieldClientProps = ClientFieldBase<RelationshipFieldClie
export type RelationshipFieldServerProps = RelationshipFieldBaseServerProps &
ServerFieldBase<RelationshipField, RelationshipFieldClientWithoutType>

export type RelationshipFieldServerComponent = FieldServerComponent<
RelationshipField,
RelationshipFieldClientWithoutType,
RelationshipFieldBaseServerProps
>

export type RelationshipFieldClientComponent = FieldClientComponent<
RelationshipFieldClientWithoutType,
RelationshipFieldBaseClientProps
>
export type RelationshipFieldServerComponent<T extends Record<string, unknown> = {}> =
FieldServerComponent<
RelationshipField,
RelationshipFieldClientWithoutType,
RelationshipFieldBaseServerProps & T
>

export type RelationshipFieldClientComponent<T extends Record<string, unknown> = {}> =
FieldClientComponent<RelationshipFieldClientWithoutType, RelationshipFieldBaseClientProps & T>

export type RelationshipFieldLabelServerComponent = FieldLabelServerComponent<
RelationshipField,
Expand Down
19 changes: 9 additions & 10 deletions packages/payload/src/admin/fields/RichText.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,15 @@ export type RichTextFieldClientProps<
export type RichTextFieldServerProps = RichTextFieldBaseServerProps &
ServerFieldBase<RichTextField, RichTextFieldClientWithoutType>

export type RichTextFieldServerComponent = FieldServerComponent<
RichTextField,
RichTextFieldClientWithoutType,
RichTextFieldBaseServerProps
>

export type RichTextFieldClientComponent = FieldClientComponent<
RichTextFieldClientWithoutType,
RichTextFieldBaseClientProps
>
export type RichTextFieldServerComponent<T extends Record<string, unknown> = {}> =
FieldServerComponent<
RichTextField,
RichTextFieldClientWithoutType,
RichTextFieldBaseServerProps & T
>

export type RichTextFieldClientComponent<T extends Record<string, unknown> = {}> =
FieldClientComponent<RichTextFieldClientWithoutType, RichTextFieldBaseClientProps & T>

export type RichTextFieldLabelServerComponent = FieldLabelServerComponent<
RichTextField,
Expand Down
9 changes: 6 additions & 3 deletions packages/payload/src/admin/fields/Row.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,14 @@ export type RowFieldClientProps = Omit<ClientFieldBase<RowFieldClientWithoutType

export type RowFieldServerProps = ServerFieldBase<RowField, RowFieldClientWithoutType>

export type RowFieldServerComponent = FieldServerComponent<RowField, RowFieldClientWithoutType>
export type RowFieldServerComponent<T extends Record<string, unknown> = {}> = FieldServerComponent<
RowField,
RowFieldClientWithoutType & T
>

export type RowFieldClientComponent = FieldClientComponent<
export type RowFieldClientComponent<T extends Record<string, unknown> = {}> = FieldClientComponent<
RowFieldClientWithoutType,
RowFieldBaseClientProps
RowFieldBaseClientProps & T
>

export type RowFieldLabelServerComponent = FieldLabelServerComponent<
Expand Down
13 changes: 4 additions & 9 deletions packages/payload/src/admin/fields/Select.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,11 @@ export type SelectFieldClientProps = ClientFieldBase<SelectFieldClientWithoutTyp
export type SelectFieldServerProps = SelectFieldBaseServerProps &
ServerFieldBase<SelectField, SelectFieldClientWithoutType>

export type SelectFieldServerComponent = FieldServerComponent<
SelectField,
SelectFieldClientWithoutType,
SelectFieldBaseServerProps
>
export type SelectFieldServerComponent<T extends Record<string, unknown> = {}> =
FieldServerComponent<SelectField, SelectFieldClientWithoutType, SelectFieldBaseServerProps & T>

export type SelectFieldClientComponent = FieldClientComponent<
SelectFieldClientWithoutType,
SelectFieldBaseClientProps
>
export type SelectFieldClientComponent<T extends Record<string, unknown> = {}> =
FieldClientComponent<SelectFieldClientWithoutType, SelectFieldBaseClientProps & T>

export type SelectFieldLabelServerComponent = FieldLabelServerComponent<
SelectField,
Expand Down
9 changes: 6 additions & 3 deletions packages/payload/src/admin/fields/Tabs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,14 @@ export type TabsFieldClientProps = ClientFieldBase<TabsFieldClientWithoutType> &

export type TabsFieldServerProps = ServerFieldBase<TabsField, TabsFieldClientWithoutType>

export type TabsFieldServerComponent = FieldServerComponent<TabsField, TabsFieldClientWithoutType>
export type TabsFieldServerComponent<T extends Record<string, unknown> = {}> = FieldServerComponent<
TabsField,
T & TabsFieldClientWithoutType
>

export type TabsFieldClientComponent = FieldClientComponent<
export type TabsFieldClientComponent<T extends Record<string, unknown> = {}> = FieldClientComponent<
TabsFieldClientWithoutType,
TabsFieldBaseClientProps
T & TabsFieldBaseClientProps
>

export type TabsFieldLabelServerComponent = FieldLabelServerComponent<
Expand Down
Loading
Loading