2 Commits

Author	SHA1	Message	Date
Alessio Gravili	90b7b20699	feat!: beta-next (#7620) ... This PR makes three major changes to the codebase: 1. [Component Paths](#component-paths) Instead of importing custom components into your config directly, they are now defined as file paths and rendered only when needed. That way the Payload config will be significantly more lightweight, and ensures that the Payload config is 100% server-only and Node-safe. Related discussion: https://github.com/payloadcms/payload/discussions/6938 2. [Client Config](#client-config) Deprecates the component map by merging its logic into the client config. The main goal of this change is for performance and simplification. There was no need to deeply iterate over the Payload config twice, once for the component map, and another for the client config. Instead, we can do everything in the client config one time. This has also dramatically simplified the client side prop drilling through the UI library. Now, all components can share the same client config which matches the exact shape of their Payload config (with the exception of non-serializable props and mapped custom components). 3. [Custom client component are no longer server-rendered](#custom-client-components-are-no-longer-server-rendered) Previously, custom components would be server-rendered, no matter if they are server or client components. Now, only server components are rendered on the server. Client components are automatically detected, and simply get passed through as `MappedComponent` to be rendered fully client-side. ## Component Paths Instead of importing custom components into your config directly, they are now defined as file paths and rendered only when needed. That way the Payload config will be significantly more lightweight, and ensures that the Payload config is 100% server-only and Node-safe. Related discussion: https://github.com/payloadcms/payload/discussions/6938 In order to reference any custom components in the Payload config, you now have to specify a string path to the component instead of importing it. Old: ```ts import { MyComponent2} from './MyComponent2.js' admin: { components: { Label: MyComponent2 }, }, ``` New: ```ts admin: { components: { Label: '/collections/Posts/MyComponent2.js#MyComponent2', // <= has to be a relative path based on a baseDir configured in the Payload config - NOT relative based on the importing file }, }, ``` ### Local API within Next.js routes Previously, if you used the Payload Local API within Next.js pages, all the client-side modules are being added to the bundle for that specific page, even if you only need server-side functionality. This `/test` route, which uses the Payload local API, was previously 460 kb. It is now down to 91 kb and does not bundle the Payload client-side admin panel anymore. All tests done [here](https://github.com/payloadcms/payload-3.0-demo/tree/feat/path-test) with beta.67/PR, db-mongodb and default richtext-lexical: **dev /admin before:**  **dev /admin after:**  --- **dev /test before:**  **dev /test after:**  --- **build before:**  **build after::**  ### Usage of the Payload Local API / config outside of Next.js This will make it a lot easier to use the Payload config / local API in other, server-side contexts. Previously, you might encounter errors due to client files (like .scss files) not being allowed to be imported. ## Client Config Deprecates the component map by merging its logic into the client config. The main goal of this change is for performance and simplification. There was no need to deeply iterate over the Payload config twice, once for the component map, and another for the client config. Instead, we can do everything in the client config one time. This has also dramatically simplified the client side prop drilling through the UI library. Now, all components can share the same client config which matches the exact shape of their Payload config (with the exception of non-serializable props and mapped custom components). This is breaking change. The `useComponentMap` hook no longer exists, and most component props have changed (for the better): ```ts const { componentMap } = useComponentMap() // old const { config } = useConfig() // new ``` The `useConfig` hook has also changed in shape, `config` is now a property _within_ the context obj: ```ts const config = useConfig() // old const { config } = useConfig() // new ``` ## Custom Client Components are no longer server rendered Previously, custom components would be server-rendered, no matter if they are server or client components. Now, only server components are rendered on the server. Client components are automatically detected, and simply get passed through as `MappedComponent` to be rendered fully client-side. The benefit of this change: Custom client components can now receive props. Previously, the only way for them to receive dynamic props from a parent client component was to use hooks, e.g. `useFieldProps()`. Now, we do have the option of passing in props to the custom components directly, if they are client components. This will be simpler than having to look for the correct hook. This makes rendering them on the client a little bit more complex, as you now have to check if that component is a server component (=> already has been rendered) or a client component (=> not rendered yet, has to be rendered here). However, this added complexity has been alleviated through the easy-to-use `<RenderMappedComponent />` helper. This helper now also handles rendering arrays of custom components (e.g. beforeList, beforeLogin ...), which actually makes rendering custom components easier in some cases. ## Misc improvements This PR includes misc, breaking changes. For example, we previously allowed unions between components and config object for the same property. E.g. for the custom view property, you were allowed to pass in a custom component or an object with other properties, alongside a custom component. Those union types are now gone. You can now either pass an object, or a component. The previous `{ View: MyViewComponent}` is now `{ View: { Component: MyViewComponent} }` or `{ View: { Default: { Component: MyViewComponent} } }`. This dramatically simplifies the way we read & process those properties, especially in buildComponentMap. We can now simply check for the existence of one specific property, which always has to be a component, instead of running cursed runtime checks on a shared union property which could contain a component, but could also contain functions or objects.   - [x] I have read and understand the [CONTRIBUTING.md](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md) document in this repository. --------- Co-authored-by: PatrikKozak <patrik@payloadcms.com> Co-authored-by: Paul <paul@payloadcms.com> Co-authored-by: Paul Popus <paul@nouance.io> Co-authored-by: Jacob Fletcher <jacobsfletch@gmail.com> Co-authored-by: James <james@trbl.design>	2024-08-13 12:54:33 -04:00
Jacob Fletcher	97837f0708	feat(ui)!: passes field props to custom components (#7360) ... ## Description Currently, there is no way to read field props from within a custom field component, i.e. `admin.components.Description`. For example, if you set `maxLength: 100` on your field, your custom description component cannot read it from `props.maxLength` or any other methods. Because these components are rendered on the server, there is also no way of using `admin.component.Field` to inject custom props yourself, either. To support this, we can simply pass the base component props into these components on the server, as expected. This has also led to custom field component props becoming more strictly typed within the config. This change is considered breaking only because the types have changed. This only affects you if you were previously importing the following types into your own custom components. To migrate, simply change the import paths for that type. Old: ```ts import type { ArrayFieldProps, ReducedBlock, BlocksFieldProps, CheckboxFieldProps, CodeFieldProps, CollapsibleFieldProps, DateFieldProps, EmailFieldProps, GroupFieldProps, HiddenFieldProps, JSONFieldProps, NumberFieldProps, PointFieldProps, RadioFieldProps, RelationshipFieldProps, RichTextComponentProps, RowFieldProps, SelectFieldProps, TabsFieldProps, TextFieldProps, TextareaFieldProps, UploadFieldProps, ErrorProps, FormFieldBase, FieldComponentProps, FieldMap, MappedField, MappedTab, ReducedBlock, } from '@payloadcms/ui' ``` New: ```ts import type { FormFieldBase, // etc. } from 'payload' ``` Custom field components are now much more strongly typed. To make this happen, an explicit type for every custom component has been generated for every field type. The convention is to append `DescriptionComponent`, `LabelComponent`, and `ErrorComponent` onto the end of the field name, i.e. `TextFieldDescriptionComponent`. Here's an example: ```ts import type { TextFieldDescriptionComponent } from 'payload' import React from 'react' export const CustomDescription: TextFieldDescriptionComponent = (props) => { return ( <div id="custom-field-description">{`The max length of this field is: ${props?.maxLength}`}</div> ) } ``` Here's the full list of all new types: Label Components: ```ts import type { ArrayFieldLabelComponent, BlocksFieldLabelComponent, CheckboxFieldLabelComponent, CodeFieldLabelComponent, CollapsibleFieldLabelComponent, DateFieldLabelComponent, EmailFieldLabelComponent, GroupFieldLabelComponent, HiddenFieldLabelComponent, JSONFieldLabelComponent, NumberFieldLabelComponent, PointFieldLabelComponent, RadioFieldLabelComponent, RelationshipFieldLabelComponent, RichTextFieldLabelComponent, RowFieldLabelComponent, SelectFieldLabelComponent, TabsFieldLabelComponent, TextFieldLabelComponent, TextareaFieldLabelComponent, UploadFieldLabelComponent } from 'payload' ``` Error Components: ```tsx import type { ArrayFieldErrorComponent, BlocksFieldErrorComponent, CheckboxFieldErrorComponent, CodeFieldErrorComponent, CollapsibleFieldErrorComponent, DateFieldErrorComponent, EmailFieldErrorComponent, GroupFieldErrorComponent, HiddenFieldErrorComponent, JSONFieldErrorComponent, NumberFieldErrorComponent, PointFieldErrorComponent, RadioFieldErrorComponent, RelationshipFieldErrorComponent, RichTextFieldErrorComponent, RowFieldErrorComponent, SelectFieldErrorComponent, TabsFieldErrorComponent, TextFieldErrorComponent, TextareaFieldErrorComponent, UploadFieldErrorComponent } from 'payload' ``` Description Components: ```tsx import type { ArrayFieldDescriptionComponent, BlocksFieldDescriptionComponent, CheckboxFieldDescriptionComponent, CodeFieldDescriptionComponent, CollapsibleFieldDescriptionComponent, DateFieldDescriptionComponent, EmailFieldDescriptionComponent, GroupFieldDescriptionComponent, HiddenFieldDescriptionComponent, JSONFieldDescriptionComponent, NumberFieldDescriptionComponent, PointFieldDescriptionComponent, RadioFieldDescriptionComponent, RelationshipFieldDescriptionComponent, RichTextFieldDescriptionComponent, RowFieldDescriptionComponent, SelectFieldDescriptionComponent, TabsFieldDescriptionComponent, TextFieldDescriptionComponent, TextareaFieldDescriptionComponent, UploadFieldDescriptionComponent } from 'payload' ``` This PR also: - Standardizes the `FieldBase['label']` type with a new `LabelStatic` type. This makes type usage much more consistent across components. - Simplifies some of the typings in the field component map, removes unneeded `<Omit>`, etc. - Fixes misc. linting issues around voiding promises - [x] I have read and understand the [CONTRIBUTING.md](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md) document in this repository. ## Type of change - [x] New feature (non-breaking change which adds functionality) ## Checklist: - [x] I have added tests that prove my fix is effective or that my feature works - [x] Existing test suite passes locally with my changes - [x] I have made corresponding changes to the documentation	2024-07-26 14:03:25 -04:00