feat(richtext-*): allow omitting the root editor property (#6660)

No need to add lexical/slate to the bundle if someone decides not to
make use of richText fields within payload at all

Author: AlessioGr

packages/graphql/src/schema/buildObjectType.ts

@@ -41,6 +41,7 @@ import {
   GraphQLUnionType,
 } from 'graphql'
 import { DateTimeResolver, EmailAddressResolver } from 'graphql-scalars'
+import { MissingEditorProp } from 'payload/errors'
 import { tabHasName } from 'payload/types'
 import { createDataloaderCacheKey, toWords } from 'payload/utilities'
 
@@ -476,6 +477,10 @@ function buildObjectType({
         async resolve(parent, args, context: Context) {
           let depth = config.defaultDepth
           if (typeof args.depth !== 'undefined') depth = args.depth
+          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.')
           }

packages/payload/src/config/schema.ts

@@ -101,7 +101,7 @@ export default joi.object({
   defaultMaxTextLength: joi.number(),
   editor: joi
     .object()
-    .required()
+    .optional()
     .keys({
       CellComponent: componentSchema.optional(),
       FieldComponent: componentSchema.optional(),

packages/payload/src/config/types.ts

@@ -615,7 +615,7 @@ export type Config = {
    */
   defaultMaxTextLength?: number
   /** Default richtext editor to use for richText fields */
-  editor: RichTextAdapterProvider<any, any, any>
+  editor?: RichTextAdapterProvider<any, any, any>
   /**
    * Email Adapter
    *
@@ -747,7 +747,7 @@ export type SanitizedConfig = Omit<
 > & {
   collections: SanitizedCollectionConfig[]
   /** Default richtext editor to use for richText fields */
-  editor: RichTextAdapter<any, any, any>
+  editor?: RichTextAdapter<any, any, any>
   endpoints: Endpoint[]
   globals: SanitizedGlobalConfig[]
   i18n: Required<I18nOptions>

packages/payload/src/errors/index.ts

@@ -12,6 +12,7 @@ export { InvalidFieldName } from './InvalidFieldName.js'
 export { InvalidFieldRelationship } from './InvalidFieldRelationship.js'
 export { LockedAuth } from './LockedAuth.js'
 export { MissingCollectionLabel } from './MissingCollectionLabel.js'
+export { MissingEditorProp } from './MissingEditorProp.js'
 export { MissingFieldInputOptions } from './MissingFieldInputOptions.js'
 export { MissingFieldType } from './MissingFieldType.js'
 export { MissingFile } from './MissingFile.js'

packages/payload/src/exports/errors.ts

@@ -2,15 +2,18 @@ export {
   APIError,
   AuthenticationError,
   DuplicateCollection,
+  DuplicateFieldName,
   DuplicateGlobal,
   ErrorDeletingFile,
+  FileRetrievalError,
   FileUploadError,
   Forbidden,
   InvalidConfiguration,
   InvalidFieldName,
   InvalidFieldRelationship,
   LockedAuth,
   MissingCollectionLabel,
+  MissingEditorProp,
   MissingFieldInputOptions,
   MissingFieldType,
   MissingFile,

packages/payload/src/fields/config/sanitize.ts

@@ -158,7 +158,7 @@ export const sanitizeFields = async ({
             // config.editor should be sanitized at this point
             field.editor = _config.editor
           } else {
-            throw new MissingEditorProp(field)
+            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
           }
         }
 

packages/payload/src/fields/hooks/afterRead/promise.ts

@@ -5,6 +5,7 @@ import type { SanitizedGlobalConfig } from '../../../globals/config/types.js'
 import type { PayloadRequestWithData, RequestContext } from '../../../types/index.js'
 import type { Field, TabAsField } from '../../config/types.js'
 
+import { MissingEditorProp } from '../../../errors/index.js'
 import { fieldAffectsData, tabHasName } from '../../config/types.js'
 import getValueWithDefault from '../../getDefaultValue.js'
 import { relationshipPopulationPromise } from './relationshipPopulationPromise.js'
@@ -143,6 +144,9 @@ export const promise = async ({
     }
 
     case 'richText': {
+      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.')
       }

packages/payload/src/fields/validations.ts

@@ -268,6 +268,9 @@ export const richText: Validate<object, unknown, unknown, RichTextField> = async
   value,
   options,
 ) => {
+  if (!options?.editor) {
+    throw new Error('richText field has no editor property.')
+  }
   if (typeof options?.editor === 'function') {
     throw new Error('Attempted to access unsanitized rich text editor.')
   }

packages/payload/src/utilities/configToJSONSchema.ts

@@ -8,6 +8,7 @@ import type { SanitizedConfig } from '../config/types.js'
 import type { Field, FieldAffectingData, Option } from '../fields/config/types.js'
 import type { SanitizedGlobalConfig } from '../globals/config/types.js'
 
+import { MissingEditorProp } from '../errors/MissingEditorProp.js'
 import { fieldAffectsData, tabHasName } from '../fields/config/types.js'
 import { deepCopyObject } from './deepCopyObject.js'
 import { toWords } from './formatLabels.js'
@@ -195,6 +196,9 @@ export function fieldsToJSONSchema(
           }
 
           case 'richText': {
+            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.')
             }

packages/ui/src/providers/ComponentMap/buildComponentMap/fields.tsx

@@ -10,6 +10,7 @@ import type {
   SanitizedConfig,
 } from 'payload/types'
 
+import { MissingEditorProp } from 'payload/errors'
 import { fieldAffectsData, fieldIsPresentationalOnly } from 'payload/types'
 import React, { Fragment } from 'react'
 
@@ -566,6 +567,9 @@ 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.')
             }