@payloadcms/ui 3.0.0-beta.7 → 3.0.0-canary.03427d3

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

@@ -1,14 +1,26 @@
-import { FieldDescription } from '@payloadcms/ui/forms/FieldDescription';
-import { fieldAffectsData, fieldIsPresentationalOnly } from 'payload/types';
-import { isPlainFunction, isReactComponent } from 'payload/utilities';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { MissingEditorProp } from 'payload';
+import { fieldAffectsData, fieldIsPresentationalOnly } from 'payload/shared';
 import React, { Fragment } from 'react';
-import { HiddenInput } from '../../../fields/HiddenInput/index.js';
+// eslint-disable-next-line payload/no-imports-from-exports-dir
+import { FieldDescription } from '../../../exports/client/index.js';
+// eslint-disable-next-line payload/no-imports-from-exports-dir
+import { HiddenInput } 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;
+}
 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) {
@@ -18,31 +30,58 @@ export const mapFields = (args)=>{
                     }
                 }
                 const isFieldAffectingData = fieldAffectsData(field);
-                const path = `${parentPath ? `${parentPath}.` : ''}${field.path || (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__*/ React.createElement(Fragment, null, field.admin.components.afterInput.map((Component, i)=>/*#__PURE__*/ React.createElement(WithServerSideProps, {
-                        Component: Component,
-                        key: i
-                    }))) || null;
-                const BeforeInput = 'admin' in field && field.admin?.components && 'beforeInput' in field.admin.components && Array.isArray(field.admin.components.beforeInput) && /*#__PURE__*/ React.createElement(Fragment, null, field.admin.components.beforeInput.map((Component, i)=>/*#__PURE__*/ React.createElement(WithServerSideProps, {
-                        Component: Component,
-                        key: i
-                    }))) || null;
+                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
+                        }, i))
+                }) || null;
+                const BeforeInput = 'admin' in field && field.admin?.components && 'beforeInput' in field.admin.components && Array.isArray(field.admin.components.beforeInput) && /*#__PURE__*/ _jsx(Fragment, {
+                    children: field.admin.components.beforeInput.map((Component, i)=>/*#__PURE__*/ _jsx(WithServerSideProps, {
+                            Component: Component
+                        }, i))
+                }) || null;
+                let label = undefined;
+                if ('label' in field) {
+                    if (typeof field.label === 'string' || typeof field.label === 'object') {
+                        label = field.label;
+                    } else if (typeof field.label === 'function') {
+                        label = field.label({
+                            t
+                        });
+                    }
+                }
                 const labelProps = {
-                    label: 'label' in field && !isPlainFunction(field.label) && !isReactComponent(field.label) ? field.label : undefined,
-                    required: 'required' in field ? field.required : undefined
+                    label,
+                    required: 'required' in field ? field.required : undefined,
+                    schemaPath: path
                 };
                 const CustomLabelComponent = 'admin' in field && field.admin?.components && 'Label' in field.admin.components && field.admin.components?.Label || undefined;
-                const CustomLabel = CustomLabelComponent !== undefined ? /*#__PURE__*/ React.createElement(WithServerSideProps, {
+                // 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: field.admin && 'description' in field.admin && ((typeof field.admin?.description === 'string' || typeof field.admin?.description === 'object') && field.admin.description || typeof field.admin?.description === 'function' && isPlainFunction(field.admin?.description) && field.admin?.description({
-                        t
-                    })) || undefined
+                    description
                 };
-                const CustomDescriptionComponent = field.admin && 'description' in field.admin && (isReactComponent(field.admin.description) && field.admin.description || field.admin.description && FieldDescription) || undefined;
-                const CustomDescription = CustomDescriptionComponent !== undefined ? /*#__PURE__*/ React.createElement(WithServerSideProps, {
+                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;
@@ -50,20 +89,22 @@ export const mapFields = (args)=>{
                     path
                 };
                 const CustomErrorComponent = 'admin' in field && field.admin?.components && 'Error' in field.admin.components && field.admin?.components?.Error || undefined;
-                const CustomError = CustomErrorComponent !== undefined ? /*#__PURE__*/ React.createElement(WithServerSideProps, {
+                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,
-                    labelProps,
+                    label: labelProps?.label,
                     path,
                     required: 'required' in field ? field.required : undefined
                 };
@@ -74,7 +115,7 @@ export const mapFields = (args)=>{
                         if (typeof option === 'object' && typeof option.label === 'function') {
                             return {
                                 label: option.label({
-                                    t: i18n.t
+                                    t
                                 }),
                                 value: option.value
                             };
@@ -86,19 +127,21 @@ export const mapFields = (args)=>{
                     name: 'name' in field ? field.name : undefined,
                     fieldType: field.type,
                     isFieldAffectingData,
-                    label: 'label' in field && field.label && typeof field.label !== 'function' ? field.label : undefined,
+                    label: labelProps?.label || undefined,
                     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 && isReactComponent(field.admin.components.RowLabel)) {
+                            if ('admin' in field && field.admin.components && 'RowLabel' in field.admin.components && field.admin.components.RowLabel) {
                                 const CustomRowLabelComponent = field.admin.components.RowLabel;
-                                CustomRowLabel = /*#__PURE__*/ React.createElement(WithServerSideProps, {
-                                    Component: CustomRowLabelComponent
+                                CustomRowLabel = /*#__PURE__*/ _jsx(WithServerSideProps, {
+                                    Component: CustomRowLabelComponent,
+                                    ...labelProps || {}
                                 });
                             }
                             const arrayFieldProps = {
@@ -116,7 +159,7 @@ export const mapFields = (args)=>{
                                     parentPath: path,
                                     readOnly: readOnlyOverride
                                 }),
-                                label: field?.label,
+                                isSortable: field.admin?.isSortable,
                                 labels: field.labels,
                                 maxRows: field.maxRows,
                                 minRows: field.minRows,
@@ -142,6 +185,7 @@ export const mapFields = (args)=>{
                                 });
                                 const reducedBlock = {
                                     slug: block.slug,
+                                    custom: block.admin?.custom,
                                     fieldMap: blockFieldMap,
                                     imageAltText: block.imageAltText,
                                     imageURL: block.imageURL,
@@ -155,7 +199,7 @@ export const mapFields = (args)=>{
                                 blocks,
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
-                                label: field?.label,
+                                isSortable: field.admin?.isSortable,
                                 labels: field.labels,
                                 maxRows: field.maxRows,
                                 minRows: field.minRows,
@@ -178,7 +222,6 @@ export const mapFields = (args)=>{
                                 name: field.name,
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
-                                label: field.label,
                                 readOnly: field.admin?.readOnly,
                                 required: field.required,
                                 style: field.admin?.style,
@@ -195,7 +238,6 @@ export const mapFields = (args)=>{
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
                                 editorOptions: field.admin?.editorOptions,
-                                label: field.label,
                                 language: field.admin?.language,
                                 readOnly: field.admin?.readOnly,
                                 required: field.required,
@@ -208,10 +250,11 @@ export const mapFields = (args)=>{
                     case 'collapsible':
                         {
                             let CustomCollapsibleLabel;
-                            if (isReactComponent(field.label) || isPlainFunction(field.label)) {
-                                const CustomCollapsibleLabelComponent = field.label;
-                                CustomCollapsibleLabel = /*#__PURE__*/ React.createElement(WithServerSideProps, {
-                                    Component: CustomCollapsibleLabelComponent
+                            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 = {
@@ -230,7 +273,6 @@ export const mapFields = (args)=>{
                                     readOnly: readOnlyOverride
                                 }),
                                 initCollapsed: field.admin?.initCollapsed,
-                                label: !CustomCollapsibleLabel ? field.label : undefined,
                                 readOnly: field.admin?.readOnly,
                                 required: field.required,
                                 style: field.admin?.style,
@@ -248,7 +290,6 @@ export const mapFields = (args)=>{
                                 className: field.admin?.className,
                                 date: field.admin?.date,
                                 disabled: field.admin?.disabled,
-                                label: field.label,
                                 placeholder: field.admin?.placeholder,
                                 readOnly: field.admin?.readOnly,
                                 required: field.required,
@@ -266,7 +307,6 @@ export const mapFields = (args)=>{
                                 name: field.name,
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
-                                label: field.label,
                                 placeholder: field.admin?.placeholder,
                                 readOnly: field.admin?.readOnly,
                                 required: field.required,
@@ -293,7 +333,7 @@ export const mapFields = (args)=>{
                                     parentPath: path,
                                     readOnly: readOnlyOverride
                                 }),
-                                label: field.label,
+                                hideGutter: field.admin?.hideGutter,
                                 readOnly: field.admin?.readOnly,
                                 style: field.admin?.style,
                                 width: field.admin?.width
@@ -309,7 +349,7 @@ export const mapFields = (args)=>{
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
                                 editorOptions: field.admin?.editorOptions,
-                                label: field.label,
+                                jsonSchema: field.jsonSchema,
                                 readOnly: field.admin?.readOnly,
                                 required: field.required,
                                 style: field.admin?.style,
@@ -326,7 +366,6 @@ export const mapFields = (args)=>{
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
                                 hasMany: field.hasMany,
-                                label: field.label,
                                 max: field.max,
                                 maxRows: field.maxRows,
                                 min: field.min,
@@ -346,7 +385,6 @@ export const mapFields = (args)=>{
                                 name: field.name,
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
-                                label: field.label,
                                 readOnly: field.admin?.readOnly,
                                 required: field.required,
                                 style: field.admin?.style,
@@ -364,7 +402,7 @@ export const mapFields = (args)=>{
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
                                 hasMany: field.hasMany,
-                                label: field.label,
+                                isSortable: field.admin?.isSortable,
                                 readOnly: field.admin?.readOnly,
                                 relationTo: field.relationTo,
                                 required: field.required,
@@ -383,7 +421,6 @@ export const mapFields = (args)=>{
                                 name: field.name,
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
-                                label: field.label,
                                 options: fieldOptions,
                                 readOnly: field.admin?.readOnly,
                                 required: field.required,
@@ -401,12 +438,18 @@ export const mapFields = (args)=>{
                                 name: field.name,
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
-                                label: field.label,
                                 readOnly: field.admin?.readOnly,
                                 required: field.required,
                                 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.');
+                            }
                             const RichTextFieldComponent = field.editor.FieldComponent;
                             const RichTextCellComponent = field.editor.CellComponent;
                             if (typeof field.editor.generateComponentMap === 'function') {
@@ -423,9 +466,7 @@ export const mapFields = (args)=>{
                                 CustomFieldComponent = RichTextFieldComponent;
                             }
                             if (RichTextCellComponent) {
-                                cellComponentProps.CellComponentOverride = /*#__PURE__*/ React.createElement(WithServerSideProps, {
-                                    Component: RichTextCellComponent
-                                });
+                                CustomCellComponent = RichTextCellComponent;
                             }
                             fieldComponentProps = richTextField;
                             break;
@@ -497,7 +538,6 @@ export const mapFields = (args)=>{
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
                                 hasMany: field.hasMany,
-                                label: field.label,
                                 maxLength: field.maxLength,
                                 minLength: field.minLength,
                                 placeholder: field.admin?.placeholder,
@@ -516,7 +556,6 @@ export const mapFields = (args)=>{
                                 name: field.name,
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
-                                label: field.label,
                                 maxLength: field.maxLength,
                                 minLength: field.minLength,
                                 placeholder: field.admin?.placeholder,
@@ -542,7 +581,6 @@ export const mapFields = (args)=>{
                                 className: field.admin?.className,
                                 disabled: field.admin?.disabled,
                                 filterOptions: field.filterOptions,
-                                label: field.label,
                                 readOnly: field.admin?.readOnly,
                                 relationTo: field.relationTo,
                                 required: field.required,
@@ -562,7 +600,6 @@ export const mapFields = (args)=>{
                                 disabled: field.admin?.disabled,
                                 hasMany: field.hasMany,
                                 isClearable: field.admin?.isClearable,
-                                label: field.label,
                                 options: fieldOptions,
                                 readOnly: field.admin?.readOnly,
                                 required: field.required,
@@ -581,16 +618,19 @@ export const mapFields = (args)=>{
                 const reducedField = {
                     name: 'name' in field ? field.name : undefined,
                     type: field.type,
-                    CustomCell: CustomCellComponent ? /*#__PURE__*/ React.createElement(WithServerSideProps, {
+                    CustomCell: CustomCellComponent ? /*#__PURE__*/ _jsx(WithServerSideProps, {
                         Component: CustomCellComponent,
                         ...cellComponentProps
                     }) : undefined,
-                    CustomField: CustomFieldComponent ? /*#__PURE__*/ React.createElement(WithServerSideProps, {
+                    CustomField: CustomFieldComponent ? /*#__PURE__*/ _jsx(WithServerSideProps, {
                         Component: CustomFieldComponent,
                         ...fieldComponentProps
                     }) : undefined,
                     cellComponentProps,
+                    custom: field?.admin?.custom,
                     disableBulkEdit: 'admin' in field && 'disableBulkEdit' in field.admin && field.admin.disableBulkEdit,
+                    disableListColumn: 'admin' in field && 'disableListColumn' in field.admin && field.admin.disableListColumn,
+                    disableListFilter: 'admin' in field && 'disableListFilter' in field.admin && field.admin.disableListFilter,
                     fieldComponentProps,
                     fieldIsPresentational,
                     isFieldAffectingData,
@@ -612,15 +652,13 @@ export const mapFields = (args)=>{
             type: 'text',
             CustomField: null,
             cellComponentProps: {
-                name: 'id'
+                name: 'id',
+                schemaPath: 'id'
             },
             disableBulkEdit: true,
             fieldComponentProps: {
                 name: 'id',
-                label: 'ID',
-                labelProps: {
-                    label: 'ID'
-                }
+                label: 'ID'
             },
             fieldIsPresentational: false,
             isFieldAffectingData: true,