@payloadcms/ui 3.0.0-canary.f1db24e → 3.0.0-canary.f1f97ff

package/dist/providers/ComponentMap/buildComponentMap/fields.js

@@ -1,24 +1,43 @@
 import { jsx as _jsx } from "react/jsx-runtime";
-import { fieldAffectsData, fieldIsPresentationalOnly } from 'payload/types';
+import { MissingEditorProp } from 'payload';
+import { deepCopyObject, fieldAffectsData, fieldIsPresentationalOnly } from 'payload/shared';
 import React, { Fragment } from 'react';
-import { HiddenInput } from '../../../fields/HiddenInput/index.js';
-import { FieldDescription } from '../../../forms/FieldDescription/index.js';
+// eslint-disable-next-line payload/no-imports-from-exports-dir
+import { FieldDescription, HiddenField } from '../../../exports/client/index.js';
+function generateFieldPath(parentPath, name) {
+    let tabPath = parentPath || '';
+    if (parentPath && name) {
+        tabPath = `${parentPath}.${name}`;
+    } else if (!parentPath && name) {
+        tabPath = name;
+    }
+    return tabPath;
+}
+function prepareCustomComponentProps(props) {
+    return deepCopyObject({
+        ...props,
+        fieldMap: undefined,
+        richTextComponentMap: undefined,
+        rows: undefined,
+        tabs: undefined
+    });
+}
 export const mapFields = (args)=>{
     const { WithServerSideProps, config, disableAddingID, fieldSchema, filter, i18n, i18n: { t }, parentPath, readOnly: readOnlyOverride } = args;
     const result = fieldSchema.reduce((acc, field)=>{
         const fieldIsPresentational = fieldIsPresentationalOnly(field);
         let CustomFieldComponent = field.admin?.components?.Field;
-        const CustomCellComponent = field.admin?.components?.Cell;
+        let CustomCellComponent = field.admin?.components?.Cell;
         const isHidden = field?.admin && 'hidden' in field.admin && field.admin.hidden;
         if (fieldIsPresentational || !field?.hidden && field?.admin?.disabled !== true) {
             if (filter && typeof filter === 'function' && filter(field) || !filter) {
                 if (isHidden) {
                     if (CustomFieldComponent) {
-                        CustomFieldComponent = HiddenInput;
+                        CustomFieldComponent = HiddenField;
                     }
                 }
                 const isFieldAffectingData = fieldAffectsData(field);
-                const path = `${parentPath ? `${parentPath}.` : ''}${field.path || (isFieldAffectingData && 'name' in field ? field.name : '')}`;
+                const path = generateFieldPath(parentPath, isFieldAffectingData && 'name' in field ? field.name : '');
                 const AfterInput = 'admin' in field && 'components' in field.admin && 'afterInput' in field.admin.components && Array.isArray(field.admin?.components?.afterInput) && /*#__PURE__*/ _jsx(Fragment, {
                     children: field.admin.components.afterInput.map((Component, i)=>/*#__PURE__*/ _jsx(WithServerSideProps, {
                             Component: Component
@@ -39,63 +58,17 @@ export const mapFields = (args)=>{
                         });
                     }
                 }
-                const labelProps = {
-                    label,
-                    required: 'required' in field ? field.required : undefined
-                };
-                const CustomLabelComponent = 'admin' in field && field.admin?.components && 'Label' in field.admin.components && field.admin.components?.Label || undefined;
-                // If we return undefined here (so if no CUSTOM label component is set), the field client component is responsible for falling back to the default label
-                const CustomLabel = CustomLabelComponent !== undefined ? /*#__PURE__*/ _jsx(WithServerSideProps, {
-                    Component: CustomLabelComponent,
-                    ...labelProps || {}
-                }) : undefined;
-                let description = undefined;
-                if (field.admin && 'description' in field.admin) {
-                    if (typeof field.admin?.description === 'string' || typeof field.admin?.description === 'object') {
-                        description = field.admin.description;
-                    } else if (typeof field.admin?.description === 'function') {
-                        description = field.admin?.description({
-                            t
-                        });
-                    }
-                }
-                const descriptionProps = {
-                    description
-                };
-                let CustomDescriptionComponent = undefined;
-                if (field.admin?.components && 'Description' in field.admin.components && field.admin.components?.Description) {
-                    CustomDescriptionComponent = field.admin.components.Description;
-                } else if (description) {
-                    CustomDescriptionComponent = FieldDescription;
-                }
-                const CustomDescription = CustomDescriptionComponent !== undefined ? /*#__PURE__*/ _jsx(WithServerSideProps, {
-                    Component: CustomDescriptionComponent,
-                    ...descriptionProps || {}
-                }) : undefined;
-                const errorProps = {
-                    path
-                };
-                const CustomErrorComponent = 'admin' in field && field.admin?.components && 'Error' in field.admin.components && field.admin?.components?.Error || undefined;
-                const CustomError = CustomErrorComponent !== undefined ? /*#__PURE__*/ _jsx(WithServerSideProps, {
-                    Component: CustomErrorComponent,
-                    ...errorProps || {}
-                }) : undefined;
                 // These fields are shared across all field types even if they are not used in the default field, as the custom field component can use them
                 const baseFieldProps = {
                     AfterInput,
                     BeforeInput,
-                    CustomDescription,
-                    CustomError,
-                    CustomLabel,
                     custom: 'admin' in field && 'custom' in field.admin ? field.admin?.custom : undefined,
-                    descriptionProps,
                     disabled: 'admin' in field && 'disabled' in field.admin ? field.admin?.disabled : false,
-                    errorProps,
-                    label: labelProps?.label,
+                    label,
                     path,
                     required: 'required' in field ? field.required : undefined
                 };
-                let fieldComponentProps;
+                let fieldComponentPropsBase;
                 let fieldOptions;
                 if ('options' in field) {
                     fieldOptions = field.options.map((option)=>{
@@ -114,26 +87,18 @@ export const mapFields = (args)=>{
                     name: 'name' in field ? field.name : undefined,
                     fieldType: field.type,
                     isFieldAffectingData,
-                    label: labelProps?.label || undefined,
+                    label,
                     labels: 'labels' in field ? field.labels : undefined,
                     options: 'options' in field ? fieldOptions : undefined,
-                    relationTo: 'relationTo' in field ? field.relationTo : undefined
+                    relationTo: 'relationTo' in field ? field.relationTo : undefined,
+                    schemaPath: path
                 };
                 switch(field.type){
                     case 'array':
                         {
-                            let CustomRowLabel;
-                            if ('admin' in field && field.admin.components && 'RowLabel' in field.admin.components && field.admin.components.RowLabel) {
-                                const CustomRowLabelComponent = field.admin.components.RowLabel;
-                                CustomRowLabel = /*#__PURE__*/ _jsx(WithServerSideProps, {
-                                    Component: CustomRowLabelComponent,
-                                    ...labelProps || {}
-                                });
-                            }
                             const arrayFieldProps = {
                                 ...baseFieldProps,
                                 name: field.name,
-                                CustomRowLabel,
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
                                 fieldMap: mapFields({
@@ -154,7 +119,7 @@ export const mapFields = (args)=>{
                                 style: field.admin?.style,
                                 width: field.admin?.width
                             };
-                            fieldComponentProps = arrayFieldProps;
+                            fieldComponentPropsBase = arrayFieldProps;
                             break;
                         }
                     case 'blocks':
@@ -171,6 +136,7 @@ export const mapFields = (args)=>{
                                 });
                                 const reducedBlock = {
                                     slug: block.slug,
+                                    LabelComponent: block.admin?.components?.Label,
                                     custom: block.admin?.custom,
                                     fieldMap: blockFieldMap,
                                     imageAltText: block.imageAltText,
@@ -194,7 +160,7 @@ export const mapFields = (args)=>{
                                 style: field.admin?.style,
                                 width: field.admin?.width
                             };
-                            fieldComponentProps = blocksField;
+                            fieldComponentPropsBase = blocksField;
                             cellComponentProps.blocks = field.blocks.map((b)=>({
                                     slug: b.slug,
                                     labels: b.labels
@@ -213,7 +179,7 @@ export const mapFields = (args)=>{
                                 style: field.admin?.style,
                                 width: field.admin?.width
                             };
-                            fieldComponentProps = checkboxField;
+                            fieldComponentPropsBase = checkboxField;
                             break;
                         }
                     case 'code':
@@ -230,22 +196,13 @@ export const mapFields = (args)=>{
                                 style: field.admin?.style,
                                 width: field.admin?.width
                             };
-                            fieldComponentProps = codeField;
+                            fieldComponentPropsBase = codeField;
                             break;
                         }
                     case 'collapsible':
                         {
-                            let CustomCollapsibleLabel;
-                            if (field?.admin?.components && 'RowLabel' in field.admin.components && field?.admin?.components?.RowLabel) {
-                                const CustomCollapsibleLabelComponent = field.admin.components.RowLabel;
-                                CustomCollapsibleLabel = /*#__PURE__*/ _jsx(WithServerSideProps, {
-                                    Component: CustomCollapsibleLabelComponent,
-                                    ...labelProps || {}
-                                });
-                            }
                             const collapsibleField = {
                                 ...baseFieldProps,
-                                CustomLabel: CustomCollapsibleLabel,
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
                                 fieldMap: mapFields({
@@ -264,7 +221,7 @@ export const mapFields = (args)=>{
                                 style: field.admin?.style,
                                 width: field.admin?.width
                             };
-                            fieldComponentProps = collapsibleField // TODO: dunno why this is needed
+                            fieldComponentPropsBase = collapsibleField // TODO: dunno why this is needed
                             ;
                             break;
                         }
@@ -282,7 +239,7 @@ export const mapFields = (args)=>{
                                 style: field.admin?.style,
                                 width: field.admin?.width
                             };
-                            fieldComponentProps = dateField;
+                            fieldComponentPropsBase = dateField;
                             cellComponentProps.dateDisplayFormat = field.admin?.date?.displayFormat;
                             break;
                         }
@@ -291,6 +248,7 @@ export const mapFields = (args)=>{
                             const emailField = {
                                 ...baseFieldProps,
                                 name: field.name,
+                                autoComplete: field.admin?.autoComplete,
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
                                 placeholder: field.admin?.placeholder,
@@ -299,7 +257,7 @@ export const mapFields = (args)=>{
                                 style: field.admin?.style,
                                 width: field.admin?.width
                             };
-                            fieldComponentProps = emailField;
+                            fieldComponentPropsBase = emailField;
                             break;
                         }
                     case 'group':
@@ -319,11 +277,12 @@ export const mapFields = (args)=>{
                                     parentPath: path,
                                     readOnly: readOnlyOverride
                                 }),
+                                hideGutter: field.admin?.hideGutter,
                                 readOnly: field.admin?.readOnly,
                                 style: field.admin?.style,
                                 width: field.admin?.width
                             };
-                            fieldComponentProps = groupField;
+                            fieldComponentPropsBase = groupField;
                             break;
                         }
                     case 'json':
@@ -340,7 +299,7 @@ export const mapFields = (args)=>{
                                 style: field.admin?.style,
                                 width: field.admin?.width
                             };
-                            fieldComponentProps = jsonField;
+                            fieldComponentPropsBase = jsonField;
                             break;
                         }
                     case 'number':
@@ -360,7 +319,7 @@ export const mapFields = (args)=>{
                                 style: field.admin?.style,
                                 width: field.admin?.width
                             };
-                            fieldComponentProps = numberField;
+                            fieldComponentPropsBase = numberField;
                             break;
                         }
                     case 'point':
@@ -375,7 +334,7 @@ export const mapFields = (args)=>{
                                 style: field.admin?.style,
                                 width: field.admin?.width
                             };
-                            fieldComponentProps = pointField;
+                            fieldComponentPropsBase = pointField;
                             break;
                         }
                     case 'relationship':
@@ -396,7 +355,7 @@ export const mapFields = (args)=>{
                                 width: field.admin?.width
                             };
                             cellComponentProps.relationTo = field.relationTo;
-                            fieldComponentProps = relationshipField;
+                            fieldComponentPropsBase = relationshipField;
                             break;
                         }
                     case 'radio':
@@ -406,6 +365,7 @@ export const mapFields = (args)=>{
                                 name: field.name,
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
+                                layout: field.admin?.layout,
                                 options: fieldOptions,
                                 readOnly: field.admin?.readOnly,
                                 required: field.required,
@@ -413,7 +373,7 @@ export const mapFields = (args)=>{
                                 width: field.admin?.width
                             };
                             cellComponentProps.options = fieldOptions;
-                            fieldComponentProps = radioField;
+                            fieldComponentPropsBase = radioField;
                             break;
                         }
                     case 'richText':
@@ -428,6 +388,10 @@ export const mapFields = (args)=>{
                                 style: field.admin?.style,
                                 width: field.admin?.width
                             };
+                            if (!field?.editor) {
+                                throw new MissingEditorProp(field) // while we allow disabling editor functionality, you should not have any richText fields defined if you do not have an editor
+                                ;
+                            }
                             if (typeof field?.editor === 'function') {
                                 throw new Error('Attempted to access unsanitized rich text editor.');
                             }
@@ -447,11 +411,9 @@ export const mapFields = (args)=>{
                                 CustomFieldComponent = RichTextFieldComponent;
                             }
                             if (RichTextCellComponent) {
-                                cellComponentProps.CellComponentOverride = /*#__PURE__*/ _jsx(WithServerSideProps, {
-                                    Component: RichTextCellComponent
-                                });
+                                CustomCellComponent = RichTextCellComponent;
                             }
-                            fieldComponentProps = richTextField;
+                            fieldComponentPropsBase = richTextField;
                             break;
                         }
                     case 'row':
@@ -475,7 +437,7 @@ export const mapFields = (args)=>{
                                 style: field.admin?.style,
                                 width: field.admin?.width
                             };
-                            fieldComponentProps = rowField;
+                            fieldComponentPropsBase = rowField;
                             break;
                         }
                     case 'tabs':
@@ -510,7 +472,7 @@ export const mapFields = (args)=>{
                                 tabs,
                                 width: field.admin?.width
                             };
-                            fieldComponentProps = tabsField;
+                            fieldComponentPropsBase = tabsField;
                             break;
                         }
                     case 'text':
@@ -529,7 +491,7 @@ export const mapFields = (args)=>{
                                 style: field.admin?.style,
                                 width: field.admin?.width
                             };
-                            fieldComponentProps = textField;
+                            fieldComponentPropsBase = textField;
                             break;
                         }
                     case 'textarea':
@@ -548,12 +510,12 @@ export const mapFields = (args)=>{
                                 style: field.admin?.style,
                                 width: field.admin?.width
                             };
-                            fieldComponentProps = textareaField;
+                            fieldComponentPropsBase = textareaField;
                             break;
                         }
                     case 'ui':
                         {
-                            fieldComponentProps = baseFieldProps;
+                            fieldComponentPropsBase = baseFieldProps;
                             break;
                         }
                     case 'upload':
@@ -571,7 +533,7 @@ export const mapFields = (args)=>{
                                 width: field.admin?.width
                             };
                             cellComponentProps.relationTo = field.relationTo;
-                            fieldComponentProps = uploadField;
+                            fieldComponentPropsBase = uploadField;
                             break;
                         }
                     case 'select':
@@ -590,7 +552,7 @@ export const mapFields = (args)=>{
                                 width: field.admin?.width
                             };
                             cellComponentProps.options = fieldOptions;
-                            fieldComponentProps = selectField;
+                            fieldComponentPropsBase = selectField;
                             break;
                         }
                     default:
@@ -598,6 +560,94 @@ export const mapFields = (args)=>{
                             break;
                         }
                 }
+                const labelProps = prepareCustomComponentProps({
+                    ...fieldComponentPropsBase,
+                    type: undefined,
+                    schemaPath: path
+                });
+                const CustomLabelComponent = 'admin' in field && field.admin?.components && 'Label' in field.admin.components && field.admin.components?.Label || undefined;
+                // If we return undefined here (so if no CUSTOM label component is set),
+                // the field client component is responsible for falling back to the default label
+                let CustomLabel = CustomLabelComponent !== undefined ? /*#__PURE__*/ _jsx(WithServerSideProps, {
+                    Component: CustomLabelComponent,
+                    ...labelProps || {}
+                }) : undefined;
+                switch(field.type){
+                    case 'array':
+                        {
+                            let CustomRowLabel;
+                            if ('admin' in field && field.admin.components && 'RowLabel' in field.admin.components && field.admin.components.RowLabel) {
+                                const CustomRowLabelComponent = field.admin.components.RowLabel;
+                                CustomRowLabel = /*#__PURE__*/ _jsx(WithServerSideProps, {
+                                    Component: CustomRowLabelComponent,
+                                    ...labelProps || {}
+                                });
+                            }
+                            // @ts-expect-error
+                            fieldComponentPropsBase.CustomRowLabel = CustomRowLabel;
+                            break;
+                        }
+                    case 'collapsible':
+                        {
+                            let CustomCollapsibleLabel;
+                            if (field?.admin?.components && 'RowLabel' in field.admin.components && field?.admin?.components?.RowLabel) {
+                                const CustomCollapsibleLabelComponent = field.admin.components.RowLabel;
+                                CustomCollapsibleLabel = /*#__PURE__*/ _jsx(WithServerSideProps, {
+                                    Component: CustomCollapsibleLabelComponent,
+                                    ...labelProps || {}
+                                });
+                            }
+                            CustomLabel = CustomCollapsibleLabel;
+                            break;
+                        }
+                    default:
+                        break;
+                }
+                let description = undefined;
+                if (field.admin && 'description' in field.admin) {
+                    if (typeof field.admin?.description === 'string' || typeof field.admin?.description === 'object') {
+                        description = field.admin.description;
+                    } else if (typeof field.admin?.description === 'function') {
+                        description = field.admin?.description({
+                            t
+                        });
+                    }
+                }
+                const descriptionProps = prepareCustomComponentProps({
+                    ...fieldComponentPropsBase,
+                    type: undefined,
+                    description
+                });
+                let CustomDescriptionComponent = undefined;
+                if (field.admin?.components && 'Description' in field.admin.components && field.admin.components?.Description) {
+                    CustomDescriptionComponent = field.admin.components.Description;
+                } else if (description) {
+                    CustomDescriptionComponent = FieldDescription;
+                }
+                const CustomDescription = CustomDescriptionComponent !== undefined ? /*#__PURE__*/ _jsx(WithServerSideProps, {
+                    Component: CustomDescriptionComponent,
+                    ...descriptionProps || {}
+                }) : undefined;
+                const errorProps = prepareCustomComponentProps({
+                    ...fieldComponentPropsBase,
+                    type: undefined,
+                    path
+                });
+                const CustomErrorComponent = 'admin' in field && field.admin?.components && 'Error' in field.admin.components && field.admin?.components?.Error || undefined;
+                const CustomError = CustomErrorComponent !== undefined ? /*#__PURE__*/ _jsx(WithServerSideProps, {
+                    Component: CustomErrorComponent,
+                    ...errorProps || {}
+                }) : undefined;
+                const fieldComponentProps = {
+                    ...fieldComponentPropsBase,
+                    type: undefined,
+                    CustomDescription,
+                    CustomError,
+                    CustomLabel,
+                    descriptionProps,
+                    errorProps,
+                    labelProps
+                };
                 const reducedField = {
                     name: 'name' in field ? field.name : undefined,
                     type: field.type,
@@ -607,7 +657,7 @@ export const mapFields = (args)=>{
                     }) : undefined,
                     CustomField: CustomFieldComponent ? /*#__PURE__*/ _jsx(WithServerSideProps, {
                         Component: CustomFieldComponent,
-                        ...fieldComponentProps
+                        ...fieldComponentPropsBase
                     }) : undefined,
                     cellComponentProps,
                     custom: field?.admin?.custom,
@@ -629,17 +679,19 @@ export const mapFields = (args)=>{
     }, []);
     const hasID = result.findIndex((f)=>'name' in f && f.isFieldAffectingData && f.name === 'id') > -1;
     if (!disableAddingID && !hasID) {
-        // TODO: For all fields (not just this one) we need to add the name to both .fieldComponentProps.name AND .name. This can probably be improved
+        // TODO: For all fields (not just this one) we need to add the name to both .fieldComponentPropsBase.name AND .name. This can probably be improved
         result.push({
             name: 'id',
             type: 'text',
             CustomField: null,
             cellComponentProps: {
-                name: 'id'
+                name: 'id',
+                schemaPath: 'id'
             },
             disableBulkEdit: true,
             fieldComponentProps: {
                 name: 'id',
+                type: undefined,
                 label: 'ID'
             },
             fieldIsPresentational: false,